chef-licensing 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40ddbe461d4e43fca7603989dbd66f6624558e733eef96d0fdf72b681a870e58
-  data.tar.gz: 34fb380e627d5e4a5fac88cb50afa968c3deb22d7bd0cf51cd0d846d8f8aab3a
+  metadata.gz: a915fc02b070fed2b74e6051992251979b2a0707655126745ad41de2be112b83
+  data.tar.gz: f8ee3a481539d4b1d16fc82cd6c21c82a8162241ea80846015a1e253f1b86069
 SHA512:
-  metadata.gz: 19e61c49f036e5d074c17469cda52d3695add42a143528ec4420aebaef9d1d053c4efb7049a9d864610369ac3e9e19a649ee97f1c12b833a22370ff081884af6
-  data.tar.gz: dcd537c41f2928bb92bbaf8a0eb6f5a4731bd79f182b2bad128d789158ebf774c87e9e46f846eedaedb29f18b36830e92dacc2af5a6a6bc3aed96daf87b65c66
+  metadata.gz: 84a9d317eb6e0369306179b2eb2de88940264d8c4734d02b40cf4b9cfa1be596ffc807f3e2446fe008c8b5c8e16f59ef1aa716e171390c7ee826498ffaf4f111
+  data.tar.gz: 3a23a0987a2889f95cee60d9a1eff1d2385f586d18f9a64b116e1c33d8529b749054186b0ba28558dcf7b57e1abf8e8429bfe79257a3bad2516721fc0265a4da

data/lib/chef-licensing/config.rb

@@ -17,13 +17,15 @@ module ChefLicensing
       attr_writer :license_server_url, :logger, :output, :license_server_url_check_in_file, :license_add_command, :license_list_command, :make_licensing_optional
 
       # is_local_license_service is used by context class
-      attr_accessor :is_local_license_service, :chef_entitlement_id, :chef_product_name, :chef_executable_name
+      attr_accessor :is_local_license_service, :chef_entitlement_id, :chef_product_name, :chef_executable_name, :persist_license_data
 
       def license_server_url(opts = {})
         return @license_server_url if @license_server_url && @license_server_url_check_in_file
 
         license_server_url_from_system = ChefLicensing::ArgFetcher.fetch_value("--chef-license-server", :string) || ChefLicensing::EnvFetcher.fetch_value("CHEF_LICENSE_SERVER", :string)
-        @license_server_url = ChefLicensing::LicenseKeyFetcher::File.fetch_or_persist_url(@license_server_url, license_server_url_from_system, opts)
+        # Default persist to true for backward compatibility, but respect the config setting if set
+        persist = @persist_license_data.nil? || @persist_license_data
+        @license_server_url = ChefLicensing::LicenseKeyFetcher::File.fetch_or_persist_url(@license_server_url, license_server_url_from_system, opts.merge(persist: persist))
         @license_server_url_check_in_file = true
         @license_server_url
       end

data/lib/chef-licensing/license_key_fetcher/file.rb

@@ -129,24 +129,30 @@ module ChefLicensing
         !!seek
       end
 
-      def fetch_or_persist_url(license_server_url_from_config, license_server_url_from_system = nil)
+      def fetch_or_persist_url(license_server_url_from_config, license_server_url_from_system = nil, persist: true)
         dir = @opts[:dir]
         license_key_file_path = "#{dir}/#{LICENSE_KEY_FILE}"
-        create_license_directory_if_not_exist(dir, license_key_file_path)
+        create_license_directory_if_not_exist(dir, license_key_file_path) if persist
 
         @contents = load_license_file(license_key_file_path)
 
         # Three possible cases:
         # 1. If contents is nil or an error occurred while loading, load basic license data with the latest structure.
         # 2. If contents is not nil and valid, but the license server URL in contents is different from the system's,
-        #    update the license server URL in contents and licenses.yaml file.
+        #    update the license server URL in contents and licenses.yaml file if persist is true.
         # 3. If contents is valid and no update is needed, return the existing license server URL.
         # Handle error cases first - when file loading failed or contents is nil
         if @contents.is_a?(StandardError) || @contents.nil?
           url = license_server_url_from_system || license_server_url_from_config
           load_basic_license_data_to_contents(url, [])
         elsif @contents && license_server_url_from_system && license_server_url_from_system != @contents[:license_server_url]
-          @contents[:license_server_url] = license_server_url_from_system
+          if persist
+            @contents[:license_server_url] = license_server_url_from_system
+          else
+            # When not persisting, just return the new URL without modifying the file or in-memory contents
+            @license_server_url = license_server_url_from_system
+            return @license_server_url
+          end
         else
           # Nothing to change in the file
           @license_server_url = @contents[:license_server_url]
@@ -156,7 +162,7 @@ module ChefLicensing
         # Ensure the license server URL is returned to the caller in all cases
         # (even if it's not persisted to the licenses.yaml file on the disk)
         begin
-          write_license_file(license_key_file_path)
+          write_license_file(license_key_file_path) if persist
         rescue StandardError => e
           handle_error(e)
         ensure
@@ -178,7 +184,8 @@ module ChefLicensing
       end
 
       def self.fetch_or_persist_url(license_server_url_from_config, license_server_url_from_system = nil, opts = {})
-        new(opts).fetch_or_persist_url(license_server_url_from_config, license_server_url_from_system)
+        persist = opts.delete(:persist) { true }
+        new(opts).fetch_or_persist_url(license_server_url_from_config, license_server_url_from_system, persist: persist)
       end
 
       private

data/lib/chef-licensing/license_key_fetcher.rb

@@ -55,6 +55,7 @@ module ChefLicensing
     # Methods for obtaining consent from the user.
     #
     def fetch_and_persist
+      ChefLicensing::Config.persist_license_data = true
       if ChefLicensing::Context.local_licensing_service?
         perform_on_prem_operations
       else
@@ -62,6 +63,16 @@ module ChefLicensing
       end
     end
 
+    # Method for validating license key without writing to disk
+    def fetch_and_validate
+      ChefLicensing::Config.persist_license_data = false
+      if ChefLicensing::Context.local_licensing_service?
+        perform_on_prem_operations
+      else
+        perform_global_operations(false)
+      end
+    end
+
     def perform_on_prem_operations
       # While using on-prem licensing service no option to add/generate license is enabled
 
@@ -94,10 +105,10 @@ module ChefLicensing
       raise LicenseKeyNotFetchedError.new("Unable to obtain a License Key.")
     end
 
-    def perform_global_operations
+    def perform_global_operations(persist = true)
       new_keys = fetch_license_key_from_arg
       license_type = validate_and_fetch_license_type(new_keys)
-      if license_type && !unrestricted_license_added?(new_keys, license_type)
+      if license_type && !unrestricted_license_added?(new_keys, license_type, persist)
         # break the flow after the prompt if there is a restriction in adding license
         # and return the license keys persisted in the file or @license_keys if any
         return license_keys
@@ -105,7 +116,7 @@ module ChefLicensing
 
       new_keys = fetch_license_key_from_env
       license_type = validate_and_fetch_license_type(new_keys)
-      if license_type && !unrestricted_license_added?(new_keys, license_type)
+      if license_type && !unrestricted_license_added?(new_keys, license_type, persist)
         # break the flow after the prompt if there is a restriction in adding license
         # and return the license keys persisted in the file or @license_keys if any
         return license_keys
@@ -125,7 +136,11 @@ module ChefLicensing
         unless new_keys.empty?
           # If license type is not selected using TUI, assign it using API call to fetch type.
           prompt_fetcher.license_type ||= get_license_type(new_keys.first)
-          persist_and_concat(new_keys, prompt_fetcher.license_type)
+          if persist
+            persist_and_concat(new_keys, prompt_fetcher.license_type)
+          else
+            validate_and_concat(new_keys, prompt_fetcher.license_type)
+          end
           license ||= ChefLicensing::Context.license
           # Expired trial licenses and exhausted free licenses will be blocked
           # Not blocking commercial licenses
@@ -176,6 +191,10 @@ module ChefLicensing
       new(opts).fetch_and_persist
     end
 
+    def self.fetch_and_validate(opts = {})
+      new(opts).fetch_and_validate
+    end
+
     def self.fetch(opts = {})
       new(opts).fetch
     end
@@ -263,6 +282,11 @@ module ChefLicensing
       @license_keys.concat(new_keys)
     end
 
+    def validate_and_concat(new_keys, license_type)
+      # Only update in-memory license keys without persisting to disk
+      @license_keys.concat(new_keys)
+    end
+
     def fetch_license_key_from_arg
       new_key = @arg_fetcher.fetch_value("--chef-license-key")
       validate_license_key_format(new_key)
@@ -304,7 +328,7 @@ module ChefLicensing
       prompt_fetcher.fetch
     end
 
-    def unrestricted_license_added?(new_keys, license_type)
+    def unrestricted_license_added?(new_keys, license_type, persist = true)
       if license_restricted?(license_type)
         # Existing license keys of same license type are fetched to compare if old license key or a new one is added.
         # However, if user is trying to add Free Tier License, and user has active trial license, we fetch the trial license key
@@ -327,7 +351,11 @@ module ChefLicensing
         # license addition should be restricted but it is not because the license is expired and warning wont be handled by this restriction
         true
       else
-        persist_and_concat(new_keys, license_type)
+        if persist
+          persist_and_concat(new_keys, license_type)
+        else
+          validate_and_concat(new_keys, license_type)
+        end
         true
       end
     end

data/lib/chef-licensing/version.rb

@@ -1,3 +1,3 @@
 module ChefLicensing
-  VERSION = "1.3.4".freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/chef-licensing.rb

@@ -77,6 +77,21 @@ module ChefLicensing
       end
     end
 
+    # @note fetch_only is invoked to fetch license keys without persisting them to a config file
+    def fetch_only
+      # Return early if make_licensing_optional is enabled
+      return true if ChefLicensing::Config.make_licensing_optional
+
+      ChefLicensing::LicenseKeyFetcher.fetch_and_validate
+    rescue ChefLicensing::ClientError => e
+      # Checking specific text phrase for entitlement error
+      if e.message.match?(/not entitled/)
+        raise(ChefLicensing::SoftwareNotEntitled, "Software is not entitled.")
+      else
+        raise
+      end
+    end
+
     def list_license_keys_info(opts = {})
       ChefLicensing::ListLicenseKeys.display(opts)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-licensing
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Inspec Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-12-16 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-config