chef-licensing 0.7.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bc6490da547bbded96f9eae129f488d1be7178feae66dc02dad8acba71fff0b
-  data.tar.gz: 16f191bd6102f08be159bb73c88f1e992657e829248b54ecdd0c5743982f65d2
+  metadata.gz: 5e5b5b44e654ed1893f1301c716881eb494bcfe486284269523e45e648f6efd9
+  data.tar.gz: bce944cdc127668e1b89ab4dde0aa1d11574a37c7958d5b3af6a33101b806ec1
 SHA512:
-  metadata.gz: 873ad985ccfc6cf42478d5e0deceb001d85f6ed74d6b62b0bb9355db66da9ad7f707f5a3d1f2aa2cece612f688321757d8c406c331c8e8ab543d1c12fbe4b794
-  data.tar.gz: 155632f6ced920a84a6700c58bad75534e34c85fbf10b4f262b5cea030fecb291de9e429e41b4108b17e97e6f3ba744bc8cefbb1b15729a43bf89e75a0e8656f
+  metadata.gz: 777458fc88ca4e0349697ca50c6da364dd966d15e72c1e5122b504ff8446437827665bd7e0390801e39b6b0d0e826a0c385d434597805459caf26df2f833eba2
+  data.tar.gz: cc705ff5a9d5a8f626e74169bb683fd16db9928782226be465669521d2d0a688d644947625cd6ad931ab1fc53a386799aa4e0033296beefa53832361a2956443

data/chef-licensing.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Chef License storage, generation, and entitlement}
   spec.description   = %q{Ruby library to support CLI tools that use Progress Chef license storage, generation, and entitlement.}
   spec.homepage      = "https://github.com/chef/chef-licensing"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/chef/chef-licensing"

data/lib/chef-licensing/config.rb

@@ -13,7 +13,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
+      attr_writer :license_server_url, :logger, :output, :license_server_url_check_in_file, :license_add_command, :license_list_command
 
       # is_local_license_service is used by context class
       attr_accessor :is_local_license_service, :chef_entitlement_id, :chef_product_name, :chef_executable_name
@@ -39,6 +39,14 @@ module ChefLicensing
       def output
         @output ||= STDOUT
       end
+
+      def license_add_command
+        @license_add_command ||= "license add"
+      end
+
+      def license_list_command
+        @license_list_command ||= "license list"
+      end
     end
   end
 end

data/lib/chef-licensing/context.rb

@@ -25,9 +25,20 @@ module ChefLicensing
         current_context(options).license_keys
       end
 
+      # Return license context object via current context
+      def license(options = {})
+        current_context(options).license
+      end
+
+      # Set license context object via current context
+      # Example: ChefLicensing::Context.license = license_context_object
+      def license=(license)
+        current_context.license = license
+      end
+
       private
 
-      def current_context(options)
+      def current_context(options = {})
         return @current_context if @current_context
 
         @current_context = context_based_on_state(options)
@@ -63,6 +74,16 @@ module ChefLicensing
       @state.license_keys
     end
 
+    # Get license context from local or global state
+    def license
+      @state.license
+    end
+
+    # Set license context from local or global state
+    def license=(license)
+      @state.license = license
+    end
+
     class State
       attr_accessor :context, :options
 
@@ -70,6 +91,20 @@ module ChefLicensing
       def license_keys
         raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
       end
+
+      # Get license context in local or global state
+      def license
+        if license_keys.empty?
+          @license ||= nil
+        else
+          @license ||= ChefLicensing.client(license_keys: license_keys)
+        end
+      end
+
+      # Set license context in local or global state
+      def license=(license)
+        @license ||= license
+      end
     end
 
     # Implement various behaviors, associated with a state of the Context.

data/lib/chef-licensing/exceptions/unsupported_content_type.rb

@@ -0,0 +1,9 @@
+require_relative "error"
+
+module ChefLicensing
+  class UnsupportedContentType < Error
+    def message
+      super || "Unsupported content type"
+    end
+  end
+end

data/lib/chef-licensing/license.rb

@@ -133,6 +133,10 @@ module ChefLicensing
       status.eql?("Expired")
     end
 
+    def exhausted?
+      status.eql?("Exhausted")
+    end
+
     def active?
       status.eql?("Active")
     end
@@ -148,4 +152,4 @@ module ChefLicensing
       status.eql?("Active") && expiration_status.eql?("Expired") && ((1..7).include? number_of_days_in_expiration)
     end
   end
-end
+end

data/lib/chef-licensing/license_key_fetcher/chef_licensing_interactions.yaml

@@ -69,20 +69,20 @@ interactions:
 
   trial_restriction_message:
     prompt_type: "say"
-    messages:
-      Please generate a Free Tier or Commercial License by running <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} license add")%>.
+    messages: |
+      Please generate a Free Tier or Commercial License by running <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} #{ChefLicensing::Config.license_add_command}")%>.
     paths: [exit_with_message]
 
   free_restriction_message:
     prompt_type: "say"
-    messages:
-      Please generate a Trial or Commercial License by running <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} license add")%>.
+    messages: |
+      Please generate a Trial or Commercial License by running <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} #{ChefLicensing::Config.license_add_command}")%>.
     paths: [exit_with_message]
 
   only_commercial_allowed_message:
     prompt_type: "say"
-    messages:
-      Please generate a Commercial License by running <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} license add")%>.
+    messages: |
+      Please generate a Commercial License by running <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} #{ChefLicensing::Config.license_add_command}")%>.
     paths: [exit_with_message]
 
   prompt_license_expired:
@@ -90,11 +90,13 @@ interactions:
       ------------------------------------------------------------
         <%= input[:pastel].yellow("! [WARNING]")%> <%= input[:license_type] %> License Expired
 
-        Get a Commercial License to receive bug fixes, updates
-        and new features.
-        Get a Free Tier License to scan limited <%= input[:unit_measure] %>.
+        We hope you've been enjoying Chef <%= input[:chef_product_name] %>!
+        However, it seems like your license has expired.
 
-        To get a new license, run <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} license add")%>
+        Reach out to our sales team at <%= input[:pastel].underline.green("chef-sales@progress.com")%>
+        to move to commercial tier.
+
+        To get a new license, run <%= input[:pastel].bold("#{ChefLicensing::Config.chef_executable_name} #{ChefLicensing::Config.license_add_command}") %>
         and select a license type.
       ------------------------------------------------------------
     prompt_type: "say"
@@ -105,9 +107,11 @@ interactions:
       ------------------------------------------------------------
         <%= input[:pastel].yellow("! [WARNING]")%> <%= input[:license_type] %> License Expired
 
-        Get a Commercial License to receive bug fixes, updates
-        and new features.
-        Get a Free Tier License to scan limited <%= input[:unit_measure] %>.
+        We hope you've been enjoying Chef <%= input[:chef_product_name] %>!
+        However, it seems like your license has expired.
+
+        Reach out to our sales team at <%= input[:pastel].underline.green("chef-sales@progress.com")%>
+        to move to commercial tier.
       ------------------------------------------------------------
     prompt_type: "say"
     paths: [fetch_license_id]
@@ -195,12 +199,13 @@ interactions:
 
   validate_license_expiration:
     action: license_expiration_status?
-    paths: [validation_success, prompt_license_about_to_expire, prompt_license_expired, prompt_license_expired_local_mode]
+    paths: [validation_success, prompt_license_about_to_expire, prompt_license_expired, prompt_license_expired_local_mode, prompt_license_exhausted]
     response_path_map:
       "active": validation_success
       "about_to_expire": prompt_license_about_to_expire
       "expired": prompt_license_expired
       "expired_in_local_mode": prompt_license_expired_local_mode
+      "exhausted_license": prompt_license_exhausted
 
   validation_success:
     messages: "✔ [Success] License validated successfully."
@@ -332,8 +337,50 @@ interactions:
 
   fetch_license_id:
     action: fetch_license_id
+    paths: [is_commercial_license]
+
+  is_commercial_license:
+    action: is_commercial_license?
+    response_path_map:
+      "true": exit
+      "false": warn_non_commercial_license
+    paths: [warn_non_commercial_license, exit]
+
+  warn_non_commercial_license:
+    messages: |
+      ------------------------------------------------------------
+        <%= input[:pastel].yellow("! [WARNING]")%> Non-Commercial License
+
+        You are using a <%= input[:license_type].downcase == "free" ? "free tier" : "trial" %> version - not meant for commercial usage.
+
+        If you are using it for commercial purposes, please reach
+        out to our sales team at <%= input[:pastel].underline.green("chef-sales@progress.com")%> to get
+        commercial license to be compliant with Progress Chef MLSA.
+      ------------------------------------------------------------
+    prompt_type: "say"
     paths: [exit]
 
+  prompt_license_exhausted:
+    messages: |
+      ------------------------------------------------------------
+        <%= input[:pastel].yellow("! [WARNING]")%> <%= input[:license_type].capitalize %> License Exhausted
+
+        We hope you've been enjoying Chef <%= input[:chef_product_name] %>!
+        However, it seems like you have exceeded your entitled usage limit on <%= input[:unit_measure] %>.
+
+        Reach out to our sales team at <%= input[:pastel].underline.green("chef-sales@progress.com")%>
+        to move to commercial-tier.
+      ------------------------------------------------------------
+    prompt_type: "say"
+    paths: [is_run_allowed_on_license_exhausted]
+
+  is_run_allowed_on_license_exhausted:
+    action: is_run_allowed_on_license_exhausted?
+    response_path_map:
+      "true": fetch_license_id
+      "false": exit
+    paths: [fetch_license_id, exit]
+
   exit:
     messages: ""
 

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

@@ -67,6 +67,15 @@ module ChefLicensing
         @active_trial_status
       end
 
+      def user_has_active_trial_or_free_license?
+        read_license_key_file
+        return false unless contents&.key?(:licenses)
+
+        all_license_keys = contents[:licenses].collect { |license| license[:license_key] }
+        license_obj = ChefLicensing.client(license_keys: all_license_keys)
+        (%w{trial free}.include? license_obj.license_type&.downcase) && license_obj.active?
+      end
+
       def fetch_allowed_license_types_for_addition
         license_types = %i{free trial commercial}
         existing_license_types = fetch_license_types

data/lib/chef-licensing/license_key_fetcher.rb

@@ -85,9 +85,9 @@ module ChefLicensing
         end
       end
 
-      # Scenario: When a user is prompted for license expiry and license is not yet renewed
-      if %i{prompt_license_about_to_expire prompt_license_expired_local_mode}.include?(config[:start_interaction])
-        # Not blocking any license type in case of expiry
+      # Expired trial licenses and exhausted free licenses will be blocked
+      # Not blocking commercial licenses
+      if license && ((!license.expired? && !license.exhausted?) || (license.license_type.downcase == "commercial"))
         return @license_keys
       end
 
@@ -119,7 +119,7 @@ module ChefLicensing
       # Return keys if there is any error in /client API call, and do not block the flow.
       # Client API possible errors will be handled in software entitlement check call (made after this)
       # client_api_call_error is set to true when there is an error in licenses_active? call
-      return @license_keys if (!@license_keys.empty? && licenses_active?) || client_api_call_error
+      return @license_keys if (!@license_keys.empty? && licenses_active? && ChefLicensing::Context.license.license_type.downcase == "commercial") || client_api_call_error
 
       # Lowest priority is to interactively prompt if we have a TTY
       if config[:output].isatty
@@ -131,13 +131,19 @@ module ChefLicensing
           # 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)
-          return license_keys
+          license ||= ChefLicensing::Context.license
+          # Expired trial licenses and exhausted free licenses will be blocked
+          # Not blocking commercial licenses
+          if (!license&.expired? && !license&.exhausted?) || (license&.license_type&.downcase == "commercial")
+            return license_keys
+          end
         end
       end
 
-      # Scenario: When a user is prompted for license expiry and license is not yet renewed
-      if new_keys.empty? && %i{prompt_license_about_to_expire prompt_license_expired}.include?(config[:start_interaction])
-        # Not blocking any license type in case of expiry
+      # Expired trial licenses and exhausted free licenses will be blocked
+      # Not blocking commercial licenses
+      license ||= ChefLicensing::Context.license
+      if new_keys.empty? && license && ((!license.expired? && !license.exhausted?) || (license.license_type.downcase == "commercial"))
         return @license_keys
       end
 
@@ -198,6 +204,7 @@ module ChefLicensing
         extra_info[:license_type] = license.license_type.capitalize
         extra_info[:number_of_days_in_expiration] = license.number_of_days_in_expiration
         extra_info[:license_expiration_date] = Date.parse(license.expiration_date).strftime("%a, %d %b %Y")
+        extra_info[:is_commercial] = license.license_type.downcase == "commercial"
       end
 
       unless info.empty? # ability to add info hash through arguments
@@ -215,6 +222,9 @@ module ChefLicensing
       # This call returns a license based on client logic
       # This API call is only made when multiple license keys are present or if client call was never done
       self.license = ChefLicensing.client(license_keys: @license_keys) if !license || @license_keys.count > 1
+
+      # Cache license context
+      ChefLicensing::Context.license = license
       # Intentional lag of 2 seconds when license is expiring or expired
       sleep 2 if license.expiring_or_expired?
       spinner.success # Stop the spinner
@@ -230,7 +240,13 @@ module ChefLicensing
         config[:start_interaction] = :prompt_license_about_to_expire
         prompt_fetcher.config = config
         false
+      elsif license.exhausted? && (license.license_type.downcase == "commercial" || license.license_type.downcase == "free")
+        config[:start_interaction] = :prompt_license_exhausted
+        prompt_fetcher.config = config
+        false
       else
+        # If license is not expired or expiring, return true. But if the license is not commercial, warn the user.
+        config[:start_interaction] = :warn_non_commercial_license unless license.license_type.downcase == "commercial"
         true
       end
     rescue ChefLicensing::ClientError => e
@@ -274,8 +290,8 @@ module ChefLicensing
     end
 
     def get_license_type(license_key)
-      self.license = ChefLicensing.client(license_keys: [license_key])
-      license.license_type.downcase.to_sym
+      license_obj = ChefLicensing.client(license_keys: [license_key])
+      license_obj.license_type.downcase.to_sym
     end
 
     def license_restricted?(license_type)
@@ -300,16 +316,22 @@ module ChefLicensing
         # However, if user is trying to add Free Tier License, and user has active trial license, we fetch the trial license key
         if license_type == :free && file_fetcher.user_has_active_trial_license?
           existing_license_keys_in_file = file_fetcher.fetch_license_keys_based_on_type(:trial)
-        else
+        elsif file_fetcher.user_has_active_trial_or_free_license?
+          # Handling license addition restriction scenarios only if the current license is an active license
           existing_license_keys_in_file = file_fetcher.fetch_license_keys_based_on_type(license_type)
         end
+
         # Only prompt when a new trial license is added
-        unless existing_license_keys_in_file.last == new_keys.first
-          # prompt the message that this addition of license is restricted.
-          prompt_license_addition_restricted(license_type, existing_license_keys_in_file)
-          return false
+        if existing_license_keys_in_file
+          unless existing_license_keys_in_file.last == new_keys.first
+            # prompt the message that this addition of license is restricted.
+            prompt_license_addition_restricted(license_type, existing_license_keys_in_file)
+            return false
+          end
         end
-        true # license type is restricted but not the key since it is the same key hence returning true
+        # license addition should be restricted but it is not because the key is same as that of one user is trying to add
+        # 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)
         true

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

@@ -7,6 +7,7 @@ require_relative "../exceptions/restful_client_connection_error"
 require_relative "../exceptions/missing_api_credentials_error"
 require_relative "../config"
 require_relative "middleware/exceptions_handler"
+require_relative "middleware/content_type_validator"
 
 module ChefLicensing
   module RestfulClient
@@ -137,6 +138,7 @@ module ChefLicensing
           config.response :json, parser_options: { object_class: OpenStruct }
           config.use Faraday::HttpCache, shared_cache: false, logger: logger, store: store
           config.use Middleware::ExceptionsHandler
+          config.use Middleware::ContentTypeValidator
           config.adapter Faraday.default_adapter
         end
       end

data/lib/chef-licensing/restful_client/middleware/content_type_validator.rb

@@ -0,0 +1,24 @@
+require "faraday/middleware"
+require_relative "../../../chef-licensing/exceptions/unsupported_content_type"
+
+module Middleware
+  class ContentTypeValidator < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response_env|
+        content_type = response_env[:response_headers]["content-type"]
+        body = response_env[:body]
+        # trim the body to 1000 characters to avoid printing a huge string in the error message
+        body = body[0..1000] if body.is_a?(String)
+        raise ChefLicensing::UnsupportedContentType, error_message(content_type, body) unless content_type == "application/json"
+      end
+    end
+
+    def error_message(content_type, body = nil)
+      <<~EOM
+        Expected 'application/json' content-type, but received '#{content_type}' from the licensing server.
+        Snippet of body: `#{body}`
+        Possible causes: Check for firewall restrictions, ensure proper server response, or seek support assistance.
+      EOM
+    end
+  end
+end

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

@@ -43,6 +43,9 @@ module ChefLicensing
       def is_license_allowed?(input)
         client_api_call(license_id)
         self.license_type = get_license_type
+        # When user enters the license via TUI, we need to check if the license type is commercial to display warnings.
+        input[:is_commercial] = license_type == :commercial ? true : false
+        input[:license_type] = license_type
         if license_restricted?(license_type)
           # Existing license keys needs to be fetcher to show details of existing license of license type which is restricted.
           # However, if user is trying to add Free Tier License, and user has active trial license, we fetch the trial license key
@@ -66,15 +69,26 @@ module ChefLicensing
           input[:license_expiration_date] = Date.parse(license.expiration_date).strftime("%a, %d %b %Y")
           input[:number_of_days_in_expiration] = license.number_of_days_in_expiration
           "about_to_expire"
+        elsif license.exhausted? && (license.license_type.downcase == "commercial" || license.license_type.downcase == "free")
+          input[:license_type] = license.license_type
+          "exhausted_license"
         else
           "active"
         end
       end
 
+      def is_run_allowed_on_license_exhausted?(input)
+        input[:license_type].downcase == "commercial"
+      end
+
       def fetch_license_id(input)
         license_id
       end
 
+      def is_commercial_license?(input)
+        input[:is_commercial]
+      end
+
       def fetch_invalid_license_msg(input)
         invalid_license_msg
       end

data/lib/chef-licensing/version.rb

@@ -1,3 +1,3 @@
 module ChefLicensing
-  VERSION = "0.7.5".freeze
+  VERSION = "1.0.0".freeze
 end

data/lib/chef-licensing.rb

@@ -8,6 +8,7 @@ require "chef-licensing/exceptions/software_not_entitled"
 require "chef-licensing/exceptions/client_error"
 require "chef-licensing/api/client"
 require "chef-licensing/license_key_fetcher/prompt"
+require "chef-licensing/context"
 
 module ChefLicensing
   class << self
@@ -66,5 +67,9 @@ module ChefLicensing
     def add_license
       ChefLicensing::LicenseKeyFetcher.add_license
     end
+
+    def license_context
+      ChefLicensing::Context.license
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-licensing
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Inspec Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-config
@@ -141,6 +141,7 @@ files:
 - lib/chef-licensing/exceptions/restful_client_connection_error.rb
 - lib/chef-licensing/exceptions/restful_client_error.rb
 - lib/chef-licensing/exceptions/software_not_entitled.rb
+- lib/chef-licensing/exceptions/unsupported_content_type.rb
 - lib/chef-licensing/license.rb
 - lib/chef-licensing/license_key_fetcher.rb
 - lib/chef-licensing/license_key_fetcher/base.rb
@@ -154,6 +155,7 @@ files:
 - lib/chef-licensing/licensing_service/local.rb
 - lib/chef-licensing/list_license_keys.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
 - lib/chef-licensing/restful_client/v1.rb
 - lib/chef-licensing/tui_engine.rb
@@ -178,14 +180,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Chef License storage, generation, and entitlement