Add support for chef-client 19 license requirement and habitat install location to chef provisioner

.github/workflows/lint.yml

@@ -12,15 +12,15 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  chefstyle:
+  cookstyle:
     env:
       BUNDLE_WITH: ${{ inputs.bundle_with }}
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         ruby: ["3.3"]
-    name: Chefstyle on Ruby
+    name: Cookstyle/Chefstyle on Ruby
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -40,9 +40,9 @@ jobs:
           bundler-cache: true
       - uses: r7kamura/rubocop-problem-matchers-action@v1
         if: steps.check.outputs.gemfile == 'true'
-      - name: Chef Style
+      - name: Cookstyle
         if: steps.check.outputs.gemfile == 'true'
-        run: bundle exec chefstyle
+        run: bundle exec cookstyle --chefstyle
 
   yamllint:
     runs-on: ubuntu-latest

.github/workflows/unit.yml

@@ -0,0 +1,28 @@
+---
+name: unit
+
+"on":
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: unit-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  unit-linux:
+    name: Linux unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.1", "3.3"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

.markdownlint-cli2.yaml

@@ -0,0 +1,10 @@
+---
+config:
+  heading-increment: false  # MD001
+  line-length: false  # MD013
+  blanks-around-headings: false  # MD022
+  no-duplicate-heading: false  # MD024
+  blanks-around-lists: false  # MD032
+  no-inline-html: false  # MD033
+ignores:
+  - .github/copilot-instructions.md

.rubocop.yml

@@ -1,7 +1,4 @@
 ---
-require:
-  - chefstyle
-
 AllCops:
   TargetRubyVersion: 3.1
   Include:

CHANGELOG.md

@@ -462,7 +462,6 @@
 - Include the Chef-cli as gem with the test-kitchen hab package [#14](https://github.com/chef/chef-test-kitchen-enterprise/pull/14) ([ashiqueps](https://github.com/ashiqueps)) <!-- 1.0.2 -->
 - Kitchen init change [#13](https://github.com/chef/chef-test-kitchen-enterprise/pull/13) ([sanghinitin](https://github.com/sanghinitin)) <!-- 1.0.1 -->
 
-
 ### Merged Pull Requests
 
 #### Merged Pull Requests
@@ -697,4 +696,4 @@
 <!-- release_rollup -->
 
 <!-- latest_stable_release -->
-<!-- latest_stable_release -->
+<!-- latest_stable_release -->

Rakefile

@@ -29,13 +29,13 @@ task :stats do
 end
 
 begin
-  require "chefstyle"
+  require "cookstyle"
   require "rubocop/rake_task"
   RuboCop::RakeTask.new(:style) do |task|
-    task.options += ["--display-cop-names", "--no-color"]
+    task.options += ["--chefstyle", "--display-cop-names", "--no-color"]
   end
 rescue LoadError
-  puts "chefstyle is not available. (sudo) gem install chefstyle to do style checking."
+  puts "cookstyle is not available. (sudo) gem install chefstyle to do style checking."
 end
 
 desc "Run all quality tasks"

docs/content/docs/drivers/vra.md

@@ -132,7 +132,6 @@ Defaults to `nil`.  Set to your domain suffix, for example 'mydomain.com'.  This
 
 a hash of other data to set on a catalog request, most notably custom properties. Allows updates to existing properties on the blueprint as well as the addition of new properties. Each key in the hash is the property name, and the value is a another hash containing the value data type and the value itself. It is possible to use a `~` to add nested parameters.
 
-
 Example **kitchen.yml**:
 
 ```yaml

docs/content/docs/provisioners/chef.md

@@ -31,6 +31,9 @@ provisioner:
     - recipes/install.rb:22 # specific line in a file
   product_name: chef # which package to install chef || chef-workstation
   chef_license: nil # to accept the Chef Infra license automatically in Test Kitchen. Valid values: `accept`, `accept-no-persist`, or `accept-silent`
+  chef_license_key: nil # License key for chef-client 19+
+  chef_license_server: [] # Array of license servers for chef-client 19+ to verify license key with
+  hab_binary: /hab/bin/hab # Path to the Habitat binary for habitat package installed chef-clients
   product_version: latest # 'latest', partial, or full version number
   root_path: /tmp # Directory to create and execute the chef installer from
   channel: stable # stable, current or unstable
@@ -74,6 +77,6 @@ Where `$KEY` corresponds to a folder named `data, data_bags, environments, nodes
 
 Additional Components for `chef_target`:
 
-* locally installed `chef-client` of version >= 19.0
-* [kitchen-transport-train >= 0.2](https://github.com/tecracer-chef/kitchen-transport-train)
-* [train >= 3.9](https://github.com/inspec/train)
+- locally installed `chef-client` of version >= 19.0
+- [kitchen-transport-train >= 0.2](https://github.com/tecracer-chef/kitchen-transport-train)
+- [train >= 3.9](https://github.com/inspec/train)

lib/kitchen/licensing/base.rb

@@ -50,4 +50,4 @@ def install_sh_url(type, keys, ext = "sh")
       end
     end
   end
-end
+end

lib/kitchen/provisioner/chef_apply.rb

@@ -57,9 +57,7 @@ class ChefApply < ChefBase
       plugin_version Kitchen::VERSION
 
       default_config :chef_apply_path do |provisioner|
-        provisioner
-          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-apply})
-          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
+        provisioner.remote_path_join(%W{#{chef_bin_path} chef-apply}).tap { |path| path.concat(".bat") if provisioner.windows_os? }
       end
 
       default_config :apply_path do |provisioner|
@@ -107,6 +105,9 @@ def run_command
           ]
           args << "--logfile #{config[:log_file]}" if config[:log_file]
           args << "--chef-license #{config[:chef_license]}" if config[:chef_license]
+          # Added for Chef-Client 19+
+          args << "--chef-license-key=#{config[:chef_license_key]}" if config[:chef_license_key]
+          args << "--chef-license-server=#{config[:chef_license_server]}" unless config[:chef_license_server].empty?
 
           lines << wrap_shell_code(
             [cmd, *args].join(" ")

lib/kitchen/provisioner/chef_base.rb

@@ -45,6 +45,11 @@ class ChefBase < Base
       default_config :chef_omnibus_url, "https://omnitruck.chef.io/install.sh"
       default_config :chef_omnibus_install_options, nil
       default_config :chef_license, nil
+      default_config :chef_license_key, nil
+      default_config :chef_license_server, []
+      default_config :hab_binary do
+        windows_os? ? "C:\\hab\\bin\\hab" : "/hab/bin/hab"
+      end
       default_config :run_list, []
       default_config :policy_group, nil
       default_config :attributes, {}
@@ -729,6 +734,29 @@ def wrapped_chef_cmd(base_cmd, configfile, append: "")
 
         prefix_command(wrap_shell_code(shell_cmd))
       end
+
+      # Determine chef binaries location
+      def chef_bin_path
+        require_relative "../which"
+        require_relative "../shell_out"
+        include ShellOut
+        include Which
+
+        # Check for binlinked chef-client binary and use that first
+        # If no binlinked chef-client binary is found then check for habiatat installed chef-client
+        # If no habitat installed chef-client is found then check for omnibus installed chef-client
+        # all fails raise an error
+        hab_pkg_cmd = "HAB_LICENSE='accept-no-persist' #{config[:hab_binary]} pkg"
+        if which("chef-client")
+          windows_os? ? File.dirname(which("chef-client")) : File.dirname(File.readlink(which("chef-client")))
+        elsif File.exist?(config[:hab_binary]) && ShellOut.run_command("#{hab_pkg_cmd} list chef/chef-infra-client").include?("chef/chef-infra-client")
+          remote_path_join(%W{#{ShellOut.run_command("#{hab_pkg_cmd} path chef/chef-infra-client").split("\n").first} bin})
+        elsif Dir.exist?(config[:chef_omnibus_root])
+          remote_path_join(%W{#{config[:chef_omnibus_root]} bin})
+        else
+          raise "Unable to determine chef binaries path"
+        end
+      end
     end
   end
 end

lib/kitchen/provisioner/chef_infra.rb

@@ -35,18 +35,13 @@ class ChefInfra < ChefBase
       default_config :json_attributes, true
       default_config :chef_zero_host, nil
       default_config :chef_zero_port, 8889
-      default_config :chef_license_key, nil
-      default_config :chef_license_server, []
 
       default_config :chef_client_path do |provisioner|
-        provisioner
-          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-client})
-          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
+        provisioner.remote_path_join(%W{#{chef_bin_path} chef-client}).tap { |path| path.concat(".bat") if provisioner.windows_os? }
       end
 
       default_config :ruby_bindir do |provisioner|
-        provisioner
-          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} embedded bin})
+        provisioner.remote_path_join(%W{#{provisioner[:chef_omnibus_root]} embedded bin})
       end
 
       # (see Base#create_sandbox)
@@ -108,6 +103,9 @@ def add_optional_chef_client_args!(args)
         end
 
         args << "--logfile #{config[:log_file]}" if config[:log_file]
+        # Added for Chef-Client 19+
+        args << "--chef-license-key=#{config[:chef_license_key]}" if config[:chef_license_key]
+        args << "--chef-license-server=#{config[:chef_license_server]}" unless config[:chef_license_server].empty?
 
         # these flags are chef-client local mode only and will not work
         # on older versions of chef-client

lib/kitchen/provisioner/chef_solo.rb

@@ -34,9 +34,7 @@ class ChefSolo < ChefBase
       default_config :solo_rb, {}
 
       default_config :chef_solo_path do |provisioner|
-        provisioner
-          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-solo})
-          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
+        provisioner.remote_path_join(%W{#{chef_bin_path} chef-solo}).tap { |path| path.concat(".bat") if provisioner.windows_os? }
       end
 
       # (see Base#config_filename)
@@ -75,6 +73,9 @@ def chef_args(solo_rb_filename)
         args << "--logfile #{config[:log_file]}" if config[:log_file]
         args << "--profile-ruby" if config[:profile_ruby]
         args << "--legacy-mode" if config[:legacy_mode]
+        # Added for Chef-Client 19+
+        args << "--chef-license-key=#{config[:chef_license_key]}" if config[:chef_license_key]
+        args << "--chef-license-server=#{config[:chef_license_server]}" unless config[:chef_license_server].empty?
         args
       end
     end

spec/kitchen/provisioner/chef_base_spec.rb

@@ -1827,6 +1827,51 @@ def debug_line(msg)
     end
   end
 
+  describe "#chef_bin_path" do
+    let(:provisioner) do
+      Class.new(Kitchen::Provisioner::ChefBase) do
+        def config
+          { chef_omnibus_root: "/opt/chef" }
+        end
+      end.new(config).finalize_config!(instance)
+    end
+
+    context "when chef-client is a symlink" do
+      before do
+        provisioner.stubs(:which).with("chef-client").returns("/usr/bin/chef-client")
+        File.stubs(:readlink).with("/usr/bin/chef-client").returns("/opt/chef/bin/chef-client")
+      end
+
+      it "returns the directory of the actual chef-client binary" do
+        expect(provisioner.chef_bin_path).to eq("/opt/chef/bin")
+      end
+    end
+    context "when chef-client is installed as a habitat package" do
+      before do
+        config[:hab_binary] = "/hab/bin/hab"
+        provisioner.stubs(:run_command).with("#{config[:hab_binary]} pkg list chef/chef-infra-client").returns("chef/chef-infra-client")
+        provisioner.stubs(:run_command).with("#{config[:hab_binary]} pkg path chef/chef-infra-client").returns("/hab/pkg/chef/chef-infra-client/19.0.54/20241121145703")
+      end
+
+      it "returns the correct path to the chef-client binary" do
+        expected_path = "/hab/pkg/chef/chef-infra-client/19.0.54/20241121145703/bin"
+        _(provisioner.chef_bin_path).must_equal expected_path
+      end
+    end
+
+    context "when it can't find the bin path" do
+      before do
+        provisioner.stubs(:which).with("chef-client").returns(nil)
+        File.stubs(:exist?).with("/hab/bin/hab").returns(false)
+        Dir.stubs(:exist?).with("/opt/chef").returns(false)
+      end
+
+      it "raises an error" do
+        expect { provisioner.chef_bin_path }.to raise_error(RuntimeError, "Unable to determine chef binaries path")
+      end
+    end
+  end
+
   def regexify(str, line = :whole_line)
     r = Regexp.escape(str)
     r = "^\s*#{r}$" if line == :whole_line