knife 18.4.2 → 18.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdf20084b258549d98683a30f13e82c8c05ef96454c04108db37f1a2a5a71182
-  data.tar.gz: 0cae6131e1d8c5b05547b1f221942e84f501b0ce9685f162e308af8b868c16df
+  metadata.gz: e9b1053a729f2359d5714a6cbdbdbb1ff4aea8f8927e838b510e249d741489e3
+  data.tar.gz: 9776202dc87c3c7dc76a7a0e1335fcab453301a738133ea292965cb380bf1a05
 SHA512:
-  metadata.gz: 5c1ff58d3324c77d44cd1168bad50e7fa94abf3be2eda9bdd8a39708b41e89f054a3b1113889c38f118adf8d85c75289f9443d3dba0675e2121ff530a645ba84
-  data.tar.gz: e3d0a3749aa738b7e1cb69793af8bff04a3d209442f58d0f4bdbacbcd4484b1222ce240eae440f45dbd537c73768d86bdcc0d22e4a4e0c36824382ee0b00000b
+  metadata.gz: 96f3ff8dff0498644dfb8c534be6fabcd2992e620299ab66d240ea6f20c0188e9bac7d20f9be80ba3aba468f669f8f5af1fa7beca8b84647e90e0cfbb97022e1
+  data.tar.gz: 823775c2c0c2bd7f7153c06f49efffe4a0fc98ee698456d1530c6969e3ad2a7c7cec71e578314dd893ff94a909bada414477ae565dfac2336a9a72161bf3ed9a

data/Gemfile

@@ -4,8 +4,9 @@ gem "knife", path: "."
 
 group(:development, :test) do
   gem "cheffish", ">= 14" # testing only , but why didn't this need to explicit in chef?
-  gem "webmock" # testing only
-  gem "rake"
+  gem "webmock"
+  gem "crack", "< 0.4.6" # due to https://github.com/jnunemaker/crack/pull/75
+  gem "rake", ">= 12.3.3"
   gem "rspec"
   gem "chef-bin", path: "../chef-bin"
 end
@@ -20,7 +21,7 @@ group(:chefstyle) do
   gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "main"
 end
 
-gem "ohai", git: "https://github.com/chef/ohai.git", branch: "main"
+gem "ohai", git: "https://github.com/chef/ohai.git", branch: "18-stable"
 gem "chef", path: ".."
 gem "chef-utils", path: File.expand_path("../chef-utils", __dir__) if File.exist?(File.expand_path("../chef-utils", __dir__))
 gem "chef-config", path: File.expand_path("../chef-config", __dir__) if File.exist?(File.expand_path("../chef-config", __dir__))

data/knife.gemspec

@@ -44,6 +44,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency "proxifier2", "~> 1.1"
 
+  s.add_dependency "chef-licensing", "~> 1.0"
+
   s.bindir       = "bin"
   s.executables  = %w{ knife }
 

data/lib/chef/application/knife.rb

@@ -19,6 +19,9 @@ require "chef/application"
 require_relative "../knife"
 require "mixlib/log"
 require "ohai/config"
+require "chef-licensing"
+require "chef/utils/licensing_handler"
+require "chef/knife/core/ui"
 module Net
   autoload :HTTP, "net/http"
 end

data/lib/chef/chef_fs/knife.rb

@@ -112,7 +112,7 @@ class Chef
           end
           # Use the original path because we can't be sure.
           inferred_path = arg
-        elsif arg[0, 1] == "~"
+        elsif arg.start_with?("~")
           # Let's be nice and fix it if possible - but warn the user.
           ui.warn("A path relative to a user home directory has been provided: #{arg}")
           ui.warn("Paths provided need to be rooted at the chef-repo being considered or be relative paths.")

data/lib/chef/knife/bootstrap/templates/chef-full.erb

@@ -171,7 +171,14 @@ do_download() {
 <% if @config[:bootstrap_install_command] %>
   <%= @config[:bootstrap_install_command] %>
 <% else %>
-  install_sh="<%= @config[:bootstrap_url] ? @config[:bootstrap_url] : "https://omnitruck.chef.io/chef/install.sh" %>"
+  <% if @config[:bootstrap_url] %>
+  install_sh="<%= @config[:bootstrap_url] %>"
+  <% elsif license_available? %>
+  install_sh="<%= config[:license_url] %>"
+  <% else %>
+  install_sh="https://omnitruck.chef.io/chef/install.sh"
+  <% end %>
+
   if test -f /usr/bin/<%= ChefUtils::Dist::Infra::CLIENT %>; then
     echo "-----> Existing <%= ChefUtils::Dist::Infra::PRODUCT %> installation detected"
   else

data/lib/chef/knife/bootstrap.rb

@@ -21,6 +21,8 @@ require_relative "data_bag_secret_options"
 require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 require "license_acceptance/cli_flags/mixlib_cli"
 require "chef/json_compat" unless defined?(Chef::JSONCompat) # can't be lazy loaded since it's used in options
+require "chef/utils/licensing_config"
+require "chef/utils/licensing_handler"
 
 module LicenseAcceptance
   autoload :Acceptor, "license_acceptance/acceptor"
@@ -442,7 +444,7 @@ class Chef
 
       # Determine if we need to accept the Chef Infra license locally in order to successfully bootstrap
       # the remote node. Remote 'chef-client' run will fail if it is >= 15 and the license is not accepted locally.
-      def check_license
+      def check_eula_license
         Chef::Log.debug("Checking if we need to accept Chef license to bootstrap node")
         version = config[:bootstrap_version] || Chef::VERSION.split(".").first
         acceptor = LicenseAcceptance::Acceptor.new(logger: Chef::Log, provided: Chef::Config[:chef_license])
@@ -550,7 +552,8 @@ class Chef
       end
 
       def run
-        check_license if ChefUtils::Dist::Org::ENFORCE_LICENSE
+        check_eula_license if ChefUtils::Dist::Org::ENFORCE_LICENSE
+        fetch_license
 
         plugin_setup!
         validate_name_args!
@@ -572,6 +575,7 @@ class Chef
         bootstrap_path = upload_bootstrap(content)
         perform_bootstrap(bootstrap_path)
         plugin_finalize
+        warn_license_usage
       ensure
         connection.del_file!(bootstrap_path) if connection && bootstrap_path
       end
@@ -1188,6 +1192,28 @@ class Chef
 
         connection&.connection&.transport_options&.merge! opts
       end
+
+      # Fetch the workstation license stored in the system
+      def fetch_license
+        license = Chef::Utils::LicensingHandler.validate!
+        config[:license_url] = license.install_sh_url
+        config[:license_id] = license.license_key
+        config[:license_type] = license.license_type
+      end
+
+      def warn_license_usage
+        return if config[:license_type].present?
+
+        ui.warn(<<~MSG
+          +-------------------------------------------------------------------------------------------------------+
+          Knife bootstrap now needs a license key to allow uninterrupted download of Infra Client.
+          It is easy to add a license by following the command <knife license>.
+          If you are a commercial customer, you may get a license from the customer portal else you can generate
+          from https://www.chef.io/license-generation-free-trial
+          +-------------------------------------------------------------------------------------------------------+
+        MSG
+               )
+      end
     end
   end
 end

data/lib/chef/knife/core/bootstrap_context.rb

@@ -203,7 +203,13 @@ class Chef
         def version_to_install
           return config[:bootstrap_version] if config[:bootstrap_version]
 
-          if config[:channel] == "stable"
+          if config[:license_url]
+            if config[:channel] == "stable" && config[:license_type] == "commercial"
+              Chef::VERSION.split(".").first
+            else
+              "latest"
+            end
+          elsif config[:channel] == "stable"
             Chef::VERSION.split(".").first
           else
             "latest"
@@ -223,6 +229,10 @@ class Chef
           end
         end
 
+        def license_available?
+          config[:license_id] && config[:license_type]
+        end
+
         private
 
         # Returns a string for copying the trusted certificates on the workstation to the system being bootstrapped

data/lib/chef/knife/core/subcommand_loader.rb

@@ -160,7 +160,7 @@ class Chef
 
       #
       # Utility function for finding an element in a hash given an array
-      # of words and a separator.  We find the the longest key in the
+      # of words and a separator.  We find the longest key in the
       # hash composed of the given words joined by the separator.
       #
       def find_longest_key(hash, words, sep = "_")

data/lib/chef/knife/core/windows_bootstrap_context.rb

@@ -242,6 +242,18 @@ class Chef
             objADOStream.SaveToFile path
             objADOStream.Close
             Set objADOStream = Nothing
+            ElseIf objXMLHTTP.Status = 400 Then
+            errorBody = objXMLHTTP.ResponseText
+            WScript.Echo "Error: 400 BadRequest"
+            WScript.Echo "Error Body:"
+            WScript.Echo errorBody
+            Else
+            WScript.Echo "An error occurred while downloading the file:"
+            errorBody = objXMLHTTP.ResponseText
+            WScript.Echo "Status: "
+            WScript.Echo objXMLHTTP.Status
+            WScript.Echo "Status Text: "
+            WScript.Echo errorBody
             End If
             Set objXMLHTTP = Nothing
             End If
@@ -266,7 +278,28 @@ class Chef
               $WebClient.Proxy = $WebProxy
             }
 
-            $webClient.DownloadFile($remoteUrl, $localPath);
+            try {
+              $webClient.DownloadFile($remoteUrl, $localPath);
+
+              Write-Host "Download complete. The file has been saved to $localPath."
+            } catch [System.Net.WebException] {
+              $response = $_.Exception.Response
+
+              if ($response.StatusCode -eq [System.Net.HttpStatusCode]::BadRequest) {
+                $streamReader = New-Object System.IO.StreamReader($response.GetResponseStream())
+                $errorBody = $streamReader.ReadToEnd()
+                $streamReader.Dispose()
+
+                Write-Host "Error: 400 BadRequest"
+                Write-Host "Error Body:"
+                Write-Host $errorBody
+              }
+              else {
+                Write-Host "An error occurred while downloading the file:"
+                Write-Host $_.Exception.Message
+              }
+              Exit 1
+            }
           WGET_PS
 
           escape_and_echo(win_wget_ps)
@@ -297,11 +330,16 @@ class Chef
         # Build a URL that will redirect to the correct Chef Infra msi download.
         def msi_url(machine_os = nil, machine_arch = nil, download_context = nil)
           if config[:msi_url].nil? || config[:msi_url].empty?
-            url = "https://omnitruck.chef.io/chef/download?p=windows"
+            url = if config[:license_url]
+                    format(config[:license_url], config[:channel]) + "/chef/download?p=windows"
+                  else
+                    "https://omnitruck.chef.io/chef/download?p=windows"
+                  end
             url += "&pv=#{machine_os}" unless machine_os.nil?
             url += "&m=#{machine_arch}" unless machine_arch.nil?
             url += "&DownloadContext=#{download_context}" unless download_context.nil?
-            url += "&channel=#{config[:channel]}"
+            url += "&channel=#{config[:channel]}" if config[:license_url].blank?
+            url += "&license_id=#{config[:license_id]}" unless config[:license_id].blank?
             url += "&v=#{version_to_install}"
           else
             config[:msi_url]

data/lib/chef/knife/license.rb

@@ -0,0 +1,52 @@
+#
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative "../knife"
+
+class Chef
+  class Knife
+    class License < Chef::Knife
+      category "license"
+      banner <<~BANNER
+        knife license [--chef-license-key <LICENSE_KEY>]
+        knife license list
+        knife license add [--chef-license-key <LICENSE_KEY>]
+      BANNER
+
+      deps do
+        require "chef/utils/licensing_handler" unless defined?(ChefLicensing)
+      end
+
+      option :chef_license_key,
+        long: "--chef-license-key <KEY>",
+        description: "Free/Trial/Commercial License key to activate the Chef product"
+
+      def run
+        case ARGV[1]
+        when "list"
+          ChefLicensing.list_license_keys_info
+        when "add"
+          ChefLicensing.add_license
+        else
+          ChefLicensing.fetch_and_persist.each do |key|
+            ui.msg("License_key: #{key}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/version.rb

@@ -17,7 +17,7 @@
 class Chef
   class Knife
     KNIFE_ROOT = File.expand_path("../..", __dir__)
-    VERSION = "18.4.2".freeze
+    VERSION = "18.6.2".freeze
   end
 end
 

data/lib/chef/knife.rb

@@ -414,16 +414,20 @@ class Chef
     def apply_computed_config
       Chef::Config[:color] = config[:color]
 
-      case Chef::Config[:verbosity]
-      when 0, nil
-        Chef::Config[:log_level] = :warn
-      when 1
-        Chef::Config[:log_level] = :info
-      when 2
-        Chef::Config[:log_level] = :debug
-      else
-        Chef::Config[:log_level] = :trace
-      end
+      # If the verbosity is not set, use what is already present on the log_level config.
+      Chef::Config[:log_level] = case Chef::Config[:verbosity]
+                                 when 0
+                                   :warn
+                                 when 1
+                                   :info
+                                 when 2
+                                   :debug
+                                 when nil
+                                   # The default log_level is auto and that is not a valid log_level.
+                                   Chef::Config[:log_level] == :auto ? :warn : Chef::Config[:log_level]
+                                 else
+                                   :trace
+                                 end
 
       Chef::Config[:log_level] = :trace if ENV["KNIFE_DEBUG"]
 

data/lib/chef/utils/licensing_config.rb

@@ -0,0 +1,9 @@
+require "chef-licensing"
+
+ChefLicensing.configure do |config|
+  config.chef_product_name    = "Knife"
+  config.chef_entitlement_id  = "x6f3bc76-a94f-4b6c-bc97-4b7ed2b045c0"
+  config.chef_executable_name = "knife"
+  config.license_server_url   = "https://services.chef.io/licensing"
+end
+

data/lib/chef/utils/licensing_handler.rb

@@ -0,0 +1,46 @@
+require_relative "licensing_config"
+
+class Chef
+  class Utils
+    class LicensingHandler
+      LEGACY_OMNITRUCK_URL = "https://omnitruck.chef.io".freeze
+
+      OMNITRUCK_URLS = {
+        "free"       => "https://chefdownload-trial.chef.io",
+        "trial"      => "https://chefdownload-trial.chef.io",
+        "commercial" => "https://chefdownload-commerical.chef.io",
+      }.freeze
+
+      attr_reader :license_key, :license_type
+
+      def initialize(key, type)
+        @license_key = key
+        @license_type = type
+      end
+
+      def omnitruck_url
+        url = OMNITRUCK_URLS[license_type] || LEGACY_OMNITRUCK_URL
+
+        "#{url}/%s#{license_key ? "?license_id=#{license_key}" : ""}"
+      end
+
+      def install_sh_url
+        format(omnitruck_url, "install.sh")
+      end
+
+      class << self
+        def validate!
+          license_keys = ChefLicensing::LicenseKeyFetcher.fetch
+
+          return new(nil, nil) if license_keys.blank?
+
+          licenses_metadata = ChefLicensing::Api::Describe.list({
+            license_keys: license_keys,
+          })
+
+          new(licenses_metadata.last.id, licenses_metadata.last.license_type)
+        end
+      end
+    end
+  end
+end

data/spec/unit/knife/bootstrap_spec.rb

@@ -50,7 +50,7 @@ describe Chef::Knife::Bootstrap do
     k
   end
 
-  context "#check_license" do
+  context "#check_eula_license" do
     let(:acceptor) { instance_double(LicenseAcceptance::Acceptor) }
 
     before do
@@ -60,7 +60,7 @@ describe Chef::Knife::Bootstrap do
     describe "when a license is not required" do
       it "does not set the chef_license" do
         expect(acceptor).to receive(:license_required?).and_return(false)
-        knife.check_license
+        knife.check_eula_license
         expect(Chef::Config[:chef_license]).to eq(nil)
       end
     end
@@ -71,7 +71,7 @@ describe Chef::Knife::Bootstrap do
         expect(acceptor).to receive(:id_from_mixlib).and_return("id")
         expect(acceptor).to receive(:check_and_persist)
         expect(acceptor).to receive(:acceptance_value).and_return("accept-no-persist")
-        knife.check_license
+        knife.check_eula_license
         expect(Chef::Config[:chef_license]).to eq("accept-no-persist")
       end
     end
@@ -347,7 +347,7 @@ describe Chef::Knife::Bootstrap do
         knife.parse_options(["--json-attribute-file", jsonfile.path])
         knife.merge_configs
         allow(knife).to receive(:validate_name_args!)
-        expect(knife).to receive(:check_license)
+        expect(knife).to receive(:check_eula_license)
 
         expect { knife.run }.to raise_error(Chef::Exceptions::BootstrapCommandInputError)
         jsonfile.close
@@ -1686,7 +1686,7 @@ describe Chef::Knife::Bootstrap do
   end
   describe "#run" do
     it "performs the steps we expect to run a bootstrap" do
-      expect(knife).to receive(:check_license)
+      expect(knife).to receive(:check_eula_license)
       expect(knife).to receive(:validate_name_args!).ordered
       expect(knife).to receive(:validate_protocol!).ordered
       expect(knife).to receive(:validate_first_boot_attributes!).ordered
@@ -1956,7 +1956,7 @@ describe Chef::Knife::Bootstrap do
 
   it "verifies that a server to bootstrap was given as a command line arg" do
     knife.name_args = nil
-    expect(knife).to receive(:check_license)
+    expect(knife).to receive(:check_eula_license)
     expect { knife.run }.to raise_error(SystemExit)
     expect(stderr.string).to match(/ERROR:.+FQDN or ip/)
   end

data/spec/unit/knife/core/hashed_command_loader_spec.rb

@@ -105,7 +105,7 @@ describe Chef::Knife::SubcommandLoader::HashedCommandLoader do
       expect(loader.subcommand_for_args(%w{cooler b})).to eq("cooler_b")
     end
 
-    it "returns nil if the the subcommand isn't in our manifest" do
+    it "returns nil if the subcommand isn't in our manifest" do
       expect(loader.subcommand_for_args(["cooler c"])).to eq(nil)
     end
   end

data/spec/unit/knife/license_spec.rb

@@ -0,0 +1,90 @@
+#
+# Copyright:: Copyright (c) Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "knife_spec_helper"
+require "chef-licensing"
+
+describe Chef::Knife::License do
+  include SpecHelpers::Knife
+
+  let(:knife) { described_class.new }
+
+  context "arguments" do
+    it "should have the chef-license-key as an option" do
+      expect(knife.options).to include(:chef_license_key)
+    end
+  end
+
+  context "license command" do
+    it "should invoke the fetch and persist" do
+      expect(ChefLicensing).to receive(:fetch_and_persist).and_return([])
+
+      knife.run
+    end
+
+    it "should print the key returned from the chef-licensing" do
+      allow(ChefLicensing).to receive(:fetch_and_persist).and_return(["key-123"])
+
+      expect(knife.run).to eq(["key-123"])
+      expect(knife.ui).to receive(:msg).and_return("License Key: key-123")
+      knife.run
+    end
+
+    it "should fail if no license provided" do
+      allow(STDOUT).to receive(:isatty).and_return(false)
+      ChefLicensing.configure do |c|
+        c.output = STDOUT
+      end
+
+      expect { knife.run }.to raise_error(ChefLicensing::LicenseKeyFetcher::LicenseKeyNotFetchedError, "Unable to obtain a License Key.")
+    end
+  end
+
+  context "license list command" do
+    before do
+      allow(STDOUT).to receive(:isatty).and_return(false)
+      ChefLicensing.configure do |c|
+        c.output = STDOUT
+      end
+    end
+
+    it "should invoke list command method" do
+      with_argv(%w{license list}) do
+        expect(ChefLicensing).to receive(:list_license_keys_info).and_return(["key-123"])
+
+        knife.run
+      end
+    end
+  end
+
+  context "license add command" do
+    before do
+      allow(STDOUT).to receive(:isatty).and_return(false)
+      ChefLicensing.configure do |c|
+        c.output = STDOUT
+      end
+    end
+
+    it "should invoke license add method" do
+      with_argv(%w{license add --chef-license-key key-123}) do
+        expect(ChefLicensing).to receive(:add_license).and_return(true)
+
+        knife.run
+      end
+    end
+  end
+end

data/spec/unit/knife_spec.rb

@@ -320,6 +320,9 @@ describe Chef::Knife do
       end
 
       it "sets the default log_level to warn so we can issue Chef::Log.warn" do
+        # Reset the log level to the default value
+        Chef::Config[:log_level] = :auto
+
         knife_command = KnifeSpecs::TestYourself.new([])
         knife_command.configure_chef
         expect(Chef::Config[:log_level]).to eql(:warn)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife
 version: !ruby/object:Gem::Version
-  version: 18.4.2
+  version: 18.6.2
 platform: ruby
 authors:
 - Adam Jacob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-config
@@ -368,6 +368,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: chef-licensing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: The knife CLI for Chef Infra.
 email: adam@chef.io
 executables:
@@ -475,6 +489,7 @@ files:
 - lib/chef/knife/key_list.rb
 - lib/chef/knife/key_list_base.rb
 - lib/chef/knife/key_show.rb
+- lib/chef/knife/license.rb
 - lib/chef/knife/list.rb
 - lib/chef/knife/node_bulk_delete.rb
 - lib/chef/knife/node_create.rb
@@ -553,6 +568,8 @@ files:
 - lib/chef/knife/version.rb
 - lib/chef/knife/xargs.rb
 - lib/chef/knife/yaml_convert.rb
+- lib/chef/utils/licensing_config.rb
+- lib/chef/utils/licensing_handler.rb
 - spec/data/apt/chef-integration-test-1.0/debian/changelog
 - spec/data/apt/chef-integration-test-1.0/debian/compat
 - spec/data/apt/chef-integration-test-1.0/debian/control
@@ -1063,6 +1080,7 @@ files:
 - spec/unit/knife/key_helper.rb
 - spec/unit/knife/key_list_spec.rb
 - spec/unit/knife/key_show_spec.rb
+- spec/unit/knife/license_spec.rb
 - spec/unit/knife/node_bulk_delete_spec.rb
 - spec/unit/knife/node_delete_spec.rb
 - spec/unit/knife/node_edit_spec.rb
@@ -1145,7 +1163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: The knife CLI for Chef Infra.