chef-licensing 1.0.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c948fd9a7a8f207619bd565dd36ac08080d36eba49603c44375c38aa9a07625
-  data.tar.gz: c6580bde930ae2e8baa93000cd12b9de11aeff60f5dc53296da96dd8fbefd32d
+  metadata.gz: 3261fe05e89d3f85b80af5270597a662ebe84eaca761e43744afbc858582baeb
+  data.tar.gz: 7234e048b9f4ab4b303381282786a0c14aef229cb6dc73d00afb00cddc00a884
 SHA512:
-  metadata.gz: 934b42b57560e797c58d0dbafd84306a48e5f6edca46b4c32bf64d066fbfcc380d716765297771baae920f18138a6d183476a37125dbd3f636273fb47a941e60
-  data.tar.gz: 36ca4df33d88d079ed8c23b0a91e9f8a78b2d478fc1185f77053c56cd94ab941457b55184839d91df0e3416e0792a19b1f1eff70e183fd6745ced46e0825528c
+  metadata.gz: 18077438f71d4f67c706721df441df2403d6b2e257a6da1966e38dfa52cf975f69356c8b2421b947c74625a1c5c8f026b1848da6b1759a11f502835c51733021
+  data.tar.gz: 649ac4de8a6df4ef59aaf7c32c8731ea0200f4b3c22e32abfb329bfb5ba7ba1a5e3f79c7e19fdad27556772ce5ef9e22016cda5354a8709f6a99c5d21445523c

data/chef-licensing.gemspec

@@ -28,11 +28,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "chef-config", ">= 15"
   spec.add_dependency "tty-prompt", "~> 0.23"
-  spec.add_dependency "faraday", ">= 1", "< 3"
+  spec.add_dependency "faraday", ">= 1", "< 2"
   spec.add_dependency "faraday-http-cache"
-  # Note: 7.1.0 does not defaults its cache_format_version to 7.1 but 6.1 instead which gives deprecation warnings
-  # Remove the version constraint when we can upgrade to 7.1.1 post stable release of Activesupport 7.1
-  # Similar issue with 7.0 existed: https://github.com/rails/rails/pull/45293
-  spec.add_dependency "activesupport", "~> 7.0", "< 7.1"
+  spec.add_dependency "activesupport", "~> 7.2", ">= 7.2.2.1"
   spec.add_dependency "tty-spinner", "~> 0.9.3"
+  spec.add_dependency "mixlib-log", "~> 3.0"
+
+  # Gem dependency needed with Ruby 3.4 upgrade
+  spec.add_dependency "ostruct", "~> 0.1.0"
 end

data/lib/chef-licensing/config.rb

@@ -3,6 +3,7 @@ require "logger"
 require_relative "config_fetcher/arg_fetcher"
 require_relative "config_fetcher/env_fetcher"
 require_relative "license_key_fetcher/file"
+require_relative "log"
 
 # Config class handles all configuration related to chef-licensing
 # Values can be set via block, environment variable or command line argument
@@ -13,7 +14,7 @@ require_relative "licensing_service/local"
 module ChefLicensing
   class Config
     class << self
-      attr_writer :license_server_url, :logger, :output, :license_server_url_check_in_file, :license_add_command, :license_list_command
+      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
@@ -22,20 +23,35 @@ module ChefLicensing
         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)
         @license_server_url_check_in_file = true
         @license_server_url
       end
 
       def logger
-        return @logger if @logger
+        # If no log level flags are set and we have a cached logger (like Inspec::Log), use it as-is
+        return @logger if @logger && !log_level_flags_present?
 
-        @logger = Logger.new(STDERR)
-        @logger.level = Logger::INFO
+        # If log level flags are present, configure the logger with determined level
+        @logger = ChefLicensing::Log
+        @logger.level = determine_log_level
         @logger
       end
 
+      def determine_log_level
+        log_level_string = get_log_level_from_flags
+
+        valid = %w{trace debug info warn error fatal}
+
+        if valid.include?(log_level_string)
+          log_level = log_level_string
+        else
+          log_level = "info"
+        end
+
+        Mixlib::Log.const_get(log_level.upcase)
+      end
+
       def output
         @output ||= STDOUT
       end
@@ -47,6 +63,45 @@ module ChefLicensing
       def license_list_command
         @license_list_command ||= "license list"
       end
+
+      def make_licensing_optional
+        @make_licensing_optional ||= false
+      end
+
+      def require_license_mutex
+        @require_license_mutex ||= Mutex.new
+      end
+
+      def require_license_for
+        return unless block_given?
+
+        require_license_mutex.synchronize do
+          # Store the original value by calling the method, not accessing the instance variable
+          original_value = make_licensing_optional
+
+          begin
+            # Temporarily set licensing as required (not optional)
+            @make_licensing_optional = false
+            yield
+          ensure
+            # Always restore the original value, even if an exception occurs
+            @make_licensing_optional = original_value
+          end
+        end
+      end
+
+      private
+
+      def log_level_flags_present?
+        !get_log_level_from_flags.nil?
+      end
+
+      def get_log_level_from_flags
+        ChefLicensing::ArgFetcher.fetch_value("--log-level", :string) ||
+          ChefLicensing::ArgFetcher.fetch_value("--chef-log-level", :string) ||
+          ChefLicensing::EnvFetcher.fetch_value("LOG_LEVEL", :string) ||
+          ChefLicensing::EnvFetcher.fetch_value("CHEF_LOG_LEVEL", :string)
+      end
     end
   end
 end

data/lib/chef-licensing/context.rb

@@ -63,7 +63,6 @@ module ChefLicensing
 
     # The Context allows changing the State object
     def transition_to(state)
-      logger.debug "Chef Licensing Context: Transition to #{state.class}"
       @state = state
       @state.context = self
       @state.options = options

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

@@ -40,7 +40,8 @@ module ChefLicensing
 
       def fetch
         read_license_key_file
-        contents&.key?(:licenses) ? fetch_license_keys(contents[:licenses]) : []
+        # Check if contents is valid and not an error before accessing license data
+        (contents && !contents.is_a?(StandardError) && contents.key?(:licenses)) ? fetch_license_keys(contents[:licenses]) : []
       end
 
       def fetch_license_keys(licenses)
@@ -50,7 +51,8 @@ module ChefLicensing
       def fetch_license_types
         read_license_key_file
 
-        if contents.nil? || contents[:licenses].nil?
+        # Return empty array if contents failed to load, is nil, or has no licenses
+        if contents.is_a?(StandardError) || contents.nil? || contents[:licenses].nil?
           []
         else
           contents[:licenses].collect { |x| x[:license_type] }
@@ -61,7 +63,8 @@ module ChefLicensing
         @active_trial_status = false
         read_license_key_file
 
-        if contents&.key?(:licenses)
+        # Only proceed if contents loaded successfully and contains license data
+        if contents && !contents.is_a?(StandardError) && contents.key?(:licenses)
           @active_trial_status = contents[:licenses].any? { |license| license[:license_type] == :trial && ChefLicensing.client(license_keys: [license[:license_key]]).active? }
         end
         @active_trial_status
@@ -69,7 +72,8 @@ module ChefLicensing
 
       def user_has_active_trial_or_free_license?
         read_license_key_file
-        return false unless contents&.key?(:licenses)
+        # Early return if contents failed to load or doesn't contain license data
+        return false unless contents && !contents.is_a?(StandardError) && contents.key?(:licenses)
 
         all_license_keys = contents[:licenses].collect { |license| license[:license_key] }
         license_obj = ChefLicensing.client(license_keys: all_license_keys)
@@ -87,7 +91,8 @@ module ChefLicensing
 
       def fetch_license_keys_based_on_type(license_type)
         read_license_key_file
-        if contents.nil?
+        # Return empty array if contents failed to load or is nil
+        if contents.is_a?(StandardError) || contents.nil?
           []
         else
           contents[:licenses].collect do |x|
@@ -131,15 +136,21 @@ module ChefLicensing
 
         @contents = load_license_file(license_key_file_path)
 
-        # Two possible cases:
-        # 1. If contents is nil, load basic license data with the latest structure.
-        # 2. If contents is not nil, but the license server URL in contents is different from the system's,
+        # 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.
-        if @contents.nil?
+        # 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
+        else
+          # Nothing to change in the file
+          @license_server_url = @contents[:license_server_url]
+          return @license_server_url
         end
 
         # Ensure the license server URL is returned to the caller in all cases
@@ -151,7 +162,6 @@ module ChefLicensing
         ensure
           @license_server_url = @contents[:license_server_url]
         end
-        logger.debug "License server URL: #{@license_server_url}"
         @license_server_url
       end
 
@@ -214,7 +224,6 @@ module ChefLicensing
       def read_license_key_file
         return contents if contents
 
-        logger.debug "Reading license file from #{seek}"
         path = seek
         return nil unless path
 
@@ -239,7 +248,6 @@ module ChefLicensing
           write_license_file(path) # update the license file contents to the latest version
           @contents
         else
-          logger.debug "License File version #{@contents[:file_format_version]} not supported."
           raise ChefLicensing::InvalidFileFormatVersion.new("Unable to read licenses. License File version #{@contents[:file_format_version]} not supported.")
         end
       end
@@ -261,7 +269,6 @@ module ChefLicensing
       def load_license_file(license_key_file_path)
         return unless ::File.exist?(license_key_file_path)
 
-        logger.debug "Reading license_key file at #{license_key_file_path}"
         msg = "Could not read license key file #{license_key_file_path}"
         YAML.load_file(license_key_file_path)
       rescue StandardError => e
@@ -271,8 +278,8 @@ module ChefLicensing
       def load_license_data_to_contents(license_data)
         return unless license_data
 
-        logger.debug "Loading license data to contents"
-        if @contents.nil? || @contents.empty? # this case is likely to happen only during testing
+        # Handle cases where contents failed to load, is nil, or empty
+        if @contents.is_a?(StandardError) || @contents.nil? || @contents.empty? # this case is likely to happen only during testing or when file loading fails
           load_basic_license_data_to_contents(@license_server_url, [license_data])
         elsif @contents[:licenses].nil?
           @contents[:licenses] = [license_data]
@@ -292,7 +299,7 @@ module ChefLicensing
       end
 
       def handle_error(e, message = nil)
-        logger.debug "#{e.backtrace.join("\n\t")}"
+        logger.trace "#{e.backtrace.join("\n\t")}"
         e
       end
 

data/lib/chef-licensing/license_key_fetcher.rb

@@ -37,7 +37,6 @@ module ChefLicensing
       config[:dir] = opts[:dir]
 
       # While using on-prem licensing service, @license_keys are fetched from API
-      logger.debug "License Key fetcher - fetching license keys depending upon the context (either API or file)"
       # While using global licensing service, @license_keys are fetched from file
       @license_keys = ChefLicensing::Context.license_keys(opts) || []
 
@@ -92,12 +91,10 @@ module ChefLicensing
       end
 
       # Otherwise nothing was able to fetch a license. Throw an exception.
-      logger.debug "License Key fetcher - no license Key able to be fetched."
       raise LicenseKeyNotFetchedError.new("Unable to obtain a License Key.")
     end
 
     def perform_global_operations
-      logger.debug "License Key fetcher examining CLI arg checks"
       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)
@@ -106,7 +103,6 @@ module ChefLicensing
         return license_keys
       end
 
-      logger.debug "License Key fetcher examining ENV checks"
       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)
@@ -124,7 +120,6 @@ module ChefLicensing
       # Lowest priority is to interactively prompt if we have a TTY
       if config[:output].isatty
         append_extra_info_to_tui_engine # will add extra dynamic values in tui flows
-        logger.debug "License Key fetcher - detected TTY, prompting..."
         new_keys = prompt_fetcher.fetch
 
         unless new_keys.empty?
@@ -150,12 +145,10 @@ module ChefLicensing
       end
 
       # Otherwise nothing was able to fetch a license. Throw an exception.
-      logger.debug "License Key fetcher - no license Key able to be fetched."
       raise LicenseKeyNotFetchedError.new("Unable to obtain a License Key.")
     end
 
     def add_license
-      logger.debug "License Key fetcher - add license flow, starting..."
       if ChefLicensing::Context.local_licensing_service?
         raise LicenseKeyAddNotAllowed.new("'inspec license add' command is not supported with airgapped environment. You cannot generate license from airgapped environment.")
       else
@@ -302,7 +295,6 @@ module ChefLicensing
     end
 
     def prompt_license_addition_restricted(license_type, existing_license_keys_in_file)
-      logger.debug "License Key fetcher - prompting license addition restriction"
       # For trial license
       # TODO for Free Tier License
       config[:start_interaction] = :prompt_license_addition_restriction

data/lib/chef-licensing/list_license_keys.rb

@@ -117,11 +117,9 @@ module ChefLicensing
       license_keys = opts[:license_keys] || ChefLicensing::LicenseKeyFetcher.fetch({ dir: opts[:dir] })
 
       if license_keys.empty?
-        logger.debug "No license keys found on disk."
         output.puts "No license keys found on disk."
         exit
       end
-      logger.debug "License keys fetched from disk: #{license_keys}"
 
       license_keys
     rescue ChefLicensing::LicenseKeyFetcher::LicenseKeyNotFetchedError => e
@@ -135,7 +133,6 @@ module ChefLicensing
       licenses_metadata = ChefLicensing::Api::Describe.list({
         license_keys: license_keys,
       })
-      logger.debug "License metadata fetched from server: #{licenses_metadata}"
 
       licenses_metadata
     rescue ChefLicensing::DescribeError => e

data/lib/chef-licensing/log.rb

@@ -0,0 +1,10 @@
+require "mixlib/log"
+
+module ChefLicensing
+  class Log
+    extend Mixlib::Log
+
+    # Initialize with STDERR as the default output stream
+    init(STDERR)
+  end
+end

data/lib/chef-licensing/restful_client/base.rb

@@ -92,7 +92,7 @@ module ChefLicensing
           attempted_urls << url
           break if i == REQUEST_LIMIT - 1
 
-          logger.debug "Trying to connect to #{url}"
+          logger.debug "Trying to connect to #{url}" if urls.size > 1
           handle_connection.call(url) do |connection|
             response = connection.send(http_method, endpoint) do |request|
               request.body = payload.to_json if payload

data/lib/chef-licensing/tui_engine/tui_engine.rb

@@ -59,7 +59,6 @@ module ChefLicensing
       verify_interaction_data
       store_interaction_objects
       build_interaction_path
-      logger.debug "TUI Engine initialized."
     end
 
     def inflate_interaction_data(interaction_file)

data/lib/chef-licensing/tui_engine/tui_engine_state.rb

@@ -19,8 +19,6 @@ module ChefLicensing
       end
 
       def default_action(interaction)
-        logger.debug "Default action called for interaction id: #{interaction.id}"
-
         response = if interaction.messages
                      messages = render_messages(interaction.messages)
                      @prompt.send(interaction.prompt_type, messages, interaction.prompt_attributes)
@@ -29,8 +27,6 @@ module ChefLicensing
                    end
 
         @input.store(interaction.id, response)
-        logger.debug "Response for interaction #{interaction.id} is #{@input[interaction.id]}"
-
         @next_interaction_id = if interaction.paths.size > 1
                                  interaction.response_path_map[response.to_s]
                                elsif interaction.paths.size == 1

data/lib/chef-licensing/version.rb

@@ -1,3 +1,3 @@
 module ChefLicensing
-  VERSION = "1.0.4".freeze
+  VERSION = "1.2.0".freeze
 end

data/lib/chef-licensing.rb

@@ -23,6 +23,9 @@ module ChefLicensing
     end
 
     def check_feature_entitlement!(feature_name: nil, feature_id: nil)
+      # If licensing is optional, bypass entitlement checks
+      return true if ChefLicensing::Config.make_licensing_optional
+
       # Checking for feature presence in license feature entitlements
       license = client(license_keys: license_keys)
       feature_entitlements = license.feature_entitlements.select { |feature| feature.id == feature_id || feature.name == feature_name }
@@ -35,9 +38,14 @@ module ChefLicensing
 
     def check_software_entitlement!
       # If API call is not breaking that means license is entitled.
-      raise ChefLicensing::LicenseKeyFetcher::LicenseKeyNotFetchedError.new("Unable to obtain a License Key.") if license_keys.empty?
+      unless ChefLicensing::Config.make_licensing_optional
+        if license_keys.empty?
+          raise ChefLicensing::LicenseKeyFetcher::LicenseKeyNotFetchedError,
+                "Unable to obtain a License Key."
+        end
 
-      client(license_keys: license_keys)
+        client(license_keys: license_keys)
+      end
       true
     rescue ChefLicensing::ClientError => e
       # Checking specific text phrase for entitlement error
@@ -55,6 +63,9 @@ module ChefLicensing
 
     # @note fetch_and_persist is invoked by chef-products to fetch and persist the license keys
     def fetch_and_persist
+      # Return early if make_licensing_optional is enabled
+      return true if ChefLicensing::Config.make_licensing_optional
+
       ChefLicensing::LicenseKeyFetcher.fetch_and_persist
     rescue ChefLicensing::ClientError => e
       # Checking specific text phrase for entitlement error
@@ -82,3 +93,13 @@ module ChefLicensing
     end
   end
 end
+
+# Require the chef-official-distribution gem if available
+# chef-official-distribution gem has a dependency on ChefLicensing.configure which is only loaded after this file is loaded.
+# Hence this require is placed at the end of the file.
+begin
+  require "chef-official-distribution"
+rescue LoadError
+  # Todo: should we warn here?
+  # Running in an unofficial distribution mode.
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-licensing
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Inspec Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 2025-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-config
@@ -47,7 +47,7 @@ dependencies:
         version: '1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
         version: '1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
@@ -78,20 +78,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
-    - - "<"
+        version: '7.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 7.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
-    - - "<"
+        version: '7.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 7.2.2.1
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: mixlib-log
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: Ruby library to support CLI tools that use Progress Chef license storage,
   generation, and entitlement.
 email:
@@ -154,6 +182,7 @@ files:
 - lib/chef-licensing/license_key_validator.rb
 - lib/chef-licensing/licensing_service/local.rb
 - lib/chef-licensing/list_license_keys.rb
+- lib/chef-licensing/log.rb
 - lib/chef-licensing/restful_client/base.rb
 - lib/chef-licensing/restful_client/middleware/content_type_validator.rb
 - lib/chef-licensing/restful_client/middleware/exceptions_handler.rb
@@ -187,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Chef License storage, generation, and entitlement