Merge pull request #1 from codenamephp/main

Initial release

Author: bastianschwarz

.github/workflows/ci.yml

@@ -38,4 +38,4 @@ jobs:
       - name: IntegrationTests
         env:
           KITCHEN_LOCAL_YAML: kitchen.dokken.yml
-        run: chef exec kitchen test
+        run: chef exec kitchen test -c 5

README.md

@@ -1,2 +1,142 @@
 # Chef Cookbook
 [![CI](https://github.com/codenamephp/chef.cookbook.gitClient/actions/workflows/ci.yml/badge.svg)](https://github.com/codenamephp/chef.cookbook.gitClient/actions/workflows/ci.yml)
+
+## Usage
+
+Just include this cookbook in a wrapper cookbook and use the resources as you see fit. Just make sure you install git before you use any of the resources that use it
+since they assume it is installed. You can of course use the `codenamephp_git_client_package` resource for this.
+
+## Resources
+### package
+The `codenamephp_git_client_package` resource installs the package using a package manager.
+
+#### Actions
+- `:install`: Installs the git client using a package manager.
+
+#### Properties
+- `package_name`: The name of the package to install, defaults to `'git'`
+
+#### Examples
+```ruby
+# Minimal properties
+codenamephp_git_client_package 'Install git'
+
+# With custom package name
+codenamephp_git_client_package 'Install git' do
+  package_name 'some package'
+end
+```
+
+### config
+The `codenamephp_git_client_config` resource is used to set configurations through `git config`. It supports system wide, user global and per-repo configurations.
+
+#### Actions
+- `set`: Sets the given config
+
+#### Properties
+- `key`: The key of config to set, e.g. user.full_name, defaults to the resource name
+- `value`: The config value to set
+- `user`: The user to run the command as
+- `scope`: The scope to set the config for, one of `local global system`, defaults to global
+- `path`: The path to run the command in, needed when setting per-repo settings, defaults to empty string
+- `options`: Additional options that will be appended to the command, defaults to empty string
+
+#### Exmaples
+```ruby
+# Minimal properties
+codenamephp_git_client_config 'user.full_name' do
+  value 'Some User'
+  user 'someuser'
+end
+
+# All properties
+codenamephp_git_client_config 'Set some config' do
+  key 'some config'
+  value 'some value'
+  user 'someuser'
+  scope 'local'
+  path '/some/path'
+  options '--some-options'
+end
+```
+
+### config_user
+The `codenamephp_git_client_config_user` is used to configure multiple values for a single user using a hash where the keys are the config keys and values the configs to be set for their keys.
+The configs are all set in the --global scope.
+Uses `codenamephp_git_client_config` internally.
+
+#### Actions
+- `:set`: Sets the given configs for the given user
+
+#### Properties
+- `user`: The user to execute the command as and to set the configs for
+- `configs`: A hash with the config keys and their values
+
+#### Examples
+```ruby
+# Minimal properties
+codenamephp_git_client_config_user 'Set configs for user' do
+  user 'some user'
+  configs lazy { { 'user.full_name' => 'Test User', 'user.email' => 'test@test.de' } }
+end
+```
+
+### config_users
+The `codenamephp_git_client_config_users` is used to configure multiple configs for multiple users at once. The configs are passed as a Hash with the username as key and another Hash with config name => config value pairs.
+Uses `codenamephp_git_client_config_user` internally.
+
+#### Actions
+- `:set`: Sets the given configs for the given users
+
+#### Properties
+- `users_configs`: A Hash with the username as key and another Hash with config name => config value pairs.
+
+#### Examples
+```ruby
+# Minimal properties
+codenamephp_git_client_config_users 'Config user' do
+  users_configs lazy {
+    {
+      'user1' => { :config1_user1 => 'value1_user1', 'config2_user1' => 'value2_user1' },
+      'user2' => { :config1_user2 => 'value1_user2', 'config2_user2' => 'value2_user2' },
+    }
+  }
+end
+```
+
+### config_users_from_data_bag
+The `config_users_from_data_bag` resource can be used to set git configurations from data bags. The configs have to be set in the user item. Example:
+
+```json
+{
+  "id": "user",
+  "codenamephp": {
+    "git_client": {
+      "config": {
+        "user.full_name": "Test User",
+        "user.email": "test@test.de"
+      }
+    }
+  }
+}
+```
+
+Only users that have a non-empty config set are used.
+
+#### Actions
+- `manage`: Manages the configs from the data bag
+
+#### Properties
+- `data_bag_name`: The name of the data bag to search for users, defaults to `users`
+
+#### Examples
+
+```ruby
+# Minimal properties
+codenamephp_git_client_config_users_from_data_bag 'Manage git users'
+
+# With custom data_bag_name
+codenamephp_git_client_config_users_from_data_bag 'Manage git users' do
+  data_bag_name 'some_data_bag'
+end
+```

kitchen.yml

@@ -19,3 +19,40 @@ suites:
       inspec_tests:
         - test/smoke/default
     attributes:
+  - name: config
+    run_list:
+      - recipe[test::default]
+      - recipe[test::config]
+    verifier:
+      inspec_tests:
+        - test/smoke/default
+        - test/smoke/config
+    attributes:
+  - name: config_user
+    run_list:
+      - recipe[test::default]
+      - recipe[test::config_user]
+    verifier:
+      inspec_tests:
+        - test/smoke/default
+        - test/smoke/config
+    attributes:
+  - name: config_users
+    run_list:
+      - recipe[test::default]
+      - recipe[test::config_users]
+    verifier:
+      inspec_tests:
+        - test/smoke/default
+        - test/smoke/config
+    attributes:
+  - name: config_users_from_data_bag
+    data_bags_path: "test/fixtures/data_bags"
+    run_list:
+      - recipe[test::default]
+      - recipe[test::config_users_from_data_bag]
+    verifier:
+      inspec_tests:
+        - test/smoke/default
+        - test/smoke/config
+    attributes:

metadata.rb

@@ -11,5 +11,3 @@
 source_url 'https://github.com/codenamephp/chef.cookbook.gitClient'
 
 supports 'debian'
-
-depends 'git', '~> 11.0'

resources/config.rb

@@ -0,0 +1,22 @@
+unified_mode true
+
+property :key, String, name_property: true, description: 'The key of config to set, e.g. user.full_name'
+property :value, String, description: 'The value to set for the key'
+property :user, String, description: 'The user to run the command as'
+property :scope, String, equal_to: %w(local global system), default: 'global', description: 'If the value should be set system wide, global for the user or the local repo'
+property :path, [String, nil], description: 'The path to exectue the config command in when setting values for a repo'
+property :options, String, default: '', description: 'Additional options to add to the command, e.g. --add'
+
+action :set do
+  execute config_command do
+    cwd new_resource.path
+    user new_resource.user
+    environment lazy { { 'USER' => new_resource.user, 'HOME' => ::Dir.home(new_resource.user) } }
+  end
+end
+
+action_class do
+  def config_command
+    format('git config --%<scope>s %<key>s "%<value>s" %<options>s', scope: new_resource.scope, key: new_resource.key, value: new_resource.value, options: new_resource.options).rstrip
+  end
+end

resources/config_user.rb

@@ -0,0 +1,15 @@
+unified_mode true
+
+property :user, String, description: 'The user to set the configs for'
+property :configs, Hash, description: 'Hash of config_key => config_value entries that will be set'
+
+action :set do
+  new_resource.configs.each do |config_name, config_value|
+    codenamephp_git_client_config "Setting config #{config_name.to_s} for #{new_resource.user}" do
+      key config_name.to_s
+      value config_value.to_s
+      scope 'global'
+      user new_resource.user
+    end
+  end
+end

resources/config_users.rb

@@ -0,0 +1,12 @@
+unified_mode true
+
+property :users_configs, Hash, description: 'Hash of all users and configs with the user as key and the configs as Hash'
+
+action :set do
+  new_resource.users_configs.each do |user, configs|
+    codenamephp_git_client_config_user "Set configs for #{user}" do
+      user user
+      configs configs
+    end
+  end
+end

resources/config_users_from_data_bag.rb

@@ -0,0 +1,19 @@
+unified_mode true
+
+property :data_bag_name, String, default: 'users', description: 'The databag to query for the users to manage'
+
+action :manage do
+  begin
+    users_configs = search(new_resource.data_bag_name, 'codenamephp_git_client_config*:*')
+                    .to_h { |user| [user[:id], user.dig(:codenamephp, :git_client, :config) || {}] }
+                    .select { |_, configs| !configs.nil? && !configs.empty? }
+
+    codenamephp_git_client_config_users 'Config users from databag' do
+      users_configs users_configs
+    end
+  rescue Net::HTTPServerException, Chef::Exceptions::InvalidDataBagPath
+    log "Databag '#{new_resource.data_bag_name}' with query 'codenamephp_git_client_config:*' was not found" do
+      level :debug
+    end
+  end
+end

resources/package.rb

@@ -0,0 +1,7 @@
+unified_mode true
+
+property :package_name, String, default: 'git', description: 'The name of the package to install'
+
+action :install do
+  package new_resource.package_name
+end

spec/resources/config_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe 'codenamephp_git_client_config' do
+  platform 'debian' # https://github.com/chefspec/chefspec/issues/953
+
+  step_into :codenamephp_git_client_config
+
+  before(:example) do
+    allow(Dir).to receive(:home).with('someuser').and_return('/home/someuser')
+  end
+
+  context 'Install with minimal properties' do
+    recipe do
+      codenamephp_git_client_config 'user.full_name' do
+        value 'Some User'
+        user 'someuser'
+      end
+    end
+
+    it 'converges successfully' do
+      expect { chef_run }.to_not raise_error
+    end
+
+    it 'sets the config' do
+      expect(chef_run).to run_execute('git config --global user.full_name "Some User"').with(
+        cwd: nil,
+        user: 'someuser',
+        environment: { 'USER' => 'someuser', 'HOME' => '/home/someuser' }
+      )
+    end
+  end
+
+  context 'Install with all properties' do
+    recipe do
+      codenamephp_git_client_config 'Set some config' do
+        key 'some config'
+        value 'some value'
+        user 'someuser'
+        scope 'local'
+        path '/some/path'
+        options '--some-options'
+      end
+    end
+
+    it 'converges successfully' do
+      expect { chef_run }.to_not raise_error
+    end
+
+    it 'sets the config' do
+      expect(chef_run).to run_execute('git config --local some config "some value" --some-options').with(
+        cwd: '/some/path',
+        user: 'someuser',
+        environment: { 'USER' => 'someuser', 'HOME' => '/home/someuser' }
+      )
+    end
+  end
+end

spec/resources/config_user_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'codenamephp_git_client_config_user' do
+  platform 'debian' # https://github.com/chefspec/chefspec/issues/953
+
+  step_into :codenamephp_git_client_config_user
+
+  context 'Install with minimal properties' do
+    recipe do
+      codenamephp_git_client_config_user 'Config user' do
+        user 'some user'
+        configs lazy { { :config1 => 'value1', 'config2' => 'value2' } }
+      end
+    end
+
+    it 'converges successfully' do
+      expect { chef_run }.to_not raise_error
+    end
+
+    it 'Will install git from package' do
+      expect(chef_run).to set_codenamephp_git_client_config('Setting config config1 for some user').with(
+        key: 'config1',
+        value: 'value1',
+        scope: 'global',
+        user: 'some user'
+      )
+      expect(chef_run).to set_codenamephp_git_client_config('Setting config config2 for some user').with(
+        key: 'config2',
+        value: 'value2',
+        scope: 'global',
+        user: 'some user'
+      )
+    end
+  end
+end