license-acceptance 1.0.5 → 2.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e892e857adb140ddab6c76d173116f248180ced44a2e2ceeeecd9919b1a91b09
-  data.tar.gz: ce171bdadb89755fa39e0bd9ce5c5c63901d7949958a0de9a4883a823a35ae9f
+  metadata.gz: 19afa6b91e05cf1154cfff732b5f3087c3596a82ed06396519479e3dc1382013
+  data.tar.gz: 5ce668d4c66b2760304b5a29fba485a71be8c9001666e8df1d822b768adfcdc5
 SHA512:
-  metadata.gz: 0a6c4bb643dc44b5ca0ca0e0f48f6ac22ef590bc7645eea104aa584259d29a911054030749689d2be4424daed5d5a6fd2ace9554a2c7ee9989502d7f63e69d79
-  data.tar.gz: c5508cb4655eb0a02ba5c1067b9c58a8c03a08d9ff9eeed7bf0c864df31749ab649901db64c5fc3db6da1fee22f66c81e0bc27d32b02a0fc4899648033c2f408
+  metadata.gz: b021343e3b27845e52f9e747919441bf6770bcc118f215b0dbbe34db1b59e7a42bef47da0202db8b4eec0fe237415a0426d343d395d9691f72fdf1dd3949742a
+  data.tar.gz: 597052f9ac8275ffd6d33cf80a2ae14aa1db7d1a6976800ee330e02d343a9df6b27df7f033cc566e64a13921f9dcbc73d36dc2bc21b7880532565d09446391eb

data/Gemfile

@@ -1,6 +1,22 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in license-acceptance.gemspec
 gemspec
+
+group :development do
+  gem "chefstyle", "1.5.7"
+  gem "climate_control", "~> 0.2"
+  gem "mixlib-cli", "~> 2.1"
+  gem "rake", ">= 10.1.0"
+  gem "rspec", "~> 3.0"
+  gem "thor", ">= 0.20", "< 2.0" # validate 2.0 when it ships
+end
+
+group :debug do
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer", "~> 0.4.0" # pin until we drop ruby < 2.6
+  gem "rb-readline"
+end

data/config/product_info.toml

@@ -31,7 +31,29 @@ id = "push-jobs-server"
 pretty_name = "Chef Push Jobs Server"
 filename = "push_jobs_server"
 
+[[products]]
+id = "push-jobs-client"
+pretty_name = "Chef Push Jobs Client"
+filename = "push_jobs_client"
+
+[[products]]
+id = "chef-dk"
+pretty_name = "Chef Development Kit"
+filename = "chef_dk"
+mixlib_name = "chefdk"
+license_required_version = "4"
+
+[[products]]
+id = "chef-workstation"
+pretty_name = "Chef Workstation"
+filename = "chef_workstation"
+mixlib_name = "chef-workstation"
+license_required_version = "0.4"
+
 [relationships]
 "infra-client" = ["inspec"]
-"infra-server" = ["infra-client"]
+"infra-server" = ["infra-client", "inspec"]
 "push-jobs-server" = ["infra-client", "infra-server"]
+"push-jobs-client" = ["infra-client"]
+"chef-dk" = ["infra-client", "inspec"]
+"chef-workstation" = ["infra-client", "inspec"]

data/lib/license_acceptance/acceptor.rb

@@ -1,19 +1,19 @@
-require "forwardable"
-require "license_acceptance/config"
-require "license_acceptance/logger"
-require "license_acceptance/product_reader"
-require "license_acceptance/product_relationship"
-require "license_acceptance/strategy/environment"
-require "license_acceptance/strategy/file"
-require "license_acceptance/strategy/argument"
-require "license_acceptance/strategy/prompt"
-require "license_acceptance/strategy/provided_value"
+require "forwardable" unless defined?(Forwardable)
+require_relative "config"
+require_relative "logger"
+require_relative "product_reader"
+require_relative "product_relationship"
+require_relative "strategy/environment"
+require_relative "strategy/file"
+require_relative "strategy/argument"
+require_relative "strategy/prompt"
+require_relative "strategy/provided_value"
 
 module LicenseAcceptance
 
-  ACCEPT = "accept"
-  ACCEPT_SILENT = "accept-silent"
-  ACCEPT_NO_PERSIST = "accept-no-persist"
+  ACCEPT = "accept".freeze
+  ACCEPT_SILENT = "accept-silent".freeze
+  ACCEPT_NO_PERSIST = "accept-no-persist".freeze
 
   class Acceptor
     extend Forwardable
@@ -21,7 +21,7 @@ module LicenseAcceptance
 
     attr_reader :config, :product_reader, :env_strategy, :file_strategy, :arg_strategy, :prompt_strategy, :provided_strategy
 
-    def initialize(opts={})
+    def initialize(opts = {})
       @config = Config.new(opts)
       Logger.initialize(config.logger)
       @product_reader = ProductReader.new
@@ -75,36 +75,48 @@ module LicenseAcceptance
         end
         @acceptance_value = accepted_silent? ? ACCEPT_SILENT : ACCEPT
         return true
-      elsif config.output.isatty && prompt_strategy.request(missing_licenses) do
-          # We have to infer the acceptance value if they use the prompt to accept
-          if config.persist
-            @acceptance_value = ACCEPT
-            file_strategy.persist(product_relationship, missing_licenses)
-          else
-            @acceptance_value = ACCEPT_NO_PERSIST
-            []
-          end
-        end
-        return true
-      else
+      end
+
+      if acceptance_value_provided?
+        value = provided_strategy.value || env_strategy.value || arg_strategy.value
+        output.puts("Unrecognized license acceptance value '#{value}', expected one of: '#{ACCEPT}', '#{ACCEPT_SILENT}', '#{ACCEPT_NO_PERSIST}'")
         raise LicenseNotAcceptedError.new(product_relationship.parent, missing_licenses)
       end
+
+      return true if output.isatty && accepted_license_prompt?(product_relationship, missing_licenses)
+
+      raise LicenseNotAcceptedError.new(product_relationship.parent, missing_licenses)
     end
 
-    def self.check_and_persist!(product_id, version, opts={})
+    def self.check_and_persist!(product_id, version, opts = {})
       new(opts).check_and_persist!(product_id, version)
     end
 
-    def self.check_and_persist(product_id, version, opts={})
+    def self.check_and_persist(product_id, version, opts = {})
       new(opts).check_and_persist(product_id, version)
     end
 
+    def accepted_license_prompt?(product_relationship, missing_licenses)
+      prompt_strategy.request(missing_licenses) do
+        # We have to infer the acceptance value if they use the prompt to accept
+        if config.persist
+          @acceptance_value = ACCEPT
+          file_strategy.persist(product_relationship, missing_licenses)
+        else
+          @acceptance_value = ACCEPT_NO_PERSIST
+          []
+        end
+      end
+    end
+
     # Check whether the specified product requires license acceptance for the given version.
     def license_required?(mixlib_name, version)
       product = product_reader.lookup_by_mixlib(mixlib_name)
       return false if product.nil?
       # If they don't pass a version we assume they want latest
-      return true if version == :latest || version.nil?
+      # All versions in all channels require license acceptance
+      return true if %w{latest unstable current stable}.include?(version.to_s) || version.nil?
+
       Gem::Version.new(version) >= Gem::Version.new(product.license_required_version)
     end
 
@@ -113,6 +125,7 @@ module LicenseAcceptance
     def id_from_mixlib(mixlib_name)
       product = product_reader.lookup_by_mixlib(mixlib_name)
       return nil if product.nil?
+
       product.id
     end
 
@@ -137,23 +150,27 @@ module LicenseAcceptance
       provided_strategy.silent? || env_strategy.silent? || arg_strategy.silent?
     end
 
+    def acceptance_value_provided?
+      provided_strategy.value? || env_strategy.value? || arg_strategy.value?
+    end
+
     # In the case where users accept with a command line argument or environment variable
     # we still want to output the fact that the filesystem was changed.
     def output_num_persisted(count)
-      s = count > 1 ? "s": ""
+      s = count > 1 ? "s" : ""
       output.puts <<~EOM
-      #{Strategy::Prompt::BORDER}
-      #{Strategy::Prompt::CHECK} #{count} product license#{s} accepted.
-      #{Strategy::Prompt::BORDER}
+        #{Strategy::Prompt::BORDER}
+        #{Strategy::Prompt::CHECK} #{count} product license#{s} accepted.
+        #{Strategy::Prompt::BORDER}
       EOM
     end
 
     def output_persist_failed(errs)
       output.puts <<~EOM
-      #{Strategy::Prompt::BORDER}
-      #{Strategy::Prompt::CHECK} Product license accepted.
-      Could not persist acceptance:\n\t* #{errs.map(&:message).join("\n\t* ")}
-      #{Strategy::Prompt::BORDER}
+        #{Strategy::Prompt::BORDER}
+        #{Strategy::Prompt::CHECK} Product license accepted.
+        Could not persist acceptance:\n\t* #{errs.map(&:message).join("\n\t* ")}
+        #{Strategy::Prompt::BORDER}
       EOM
     end
 

data/lib/license_acceptance/cli_flags/mixlib_cli.rb

@@ -1,6 +1,6 @@
 begin
-  require 'mixlib/cli'
-rescue => exception
+  require "mixlib/cli" unless defined?(Mixlib::CLI)
+rescue
   raise "Must have mixlib-cli gem installed to use this mixin"
 end
 

data/lib/license_acceptance/cli_flags/thor.rb

@@ -1,6 +1,6 @@
 begin
-  require 'thor'
-rescue => exception
+  require "thor" unless defined?(Thor)
+rescue
   raise "Must have thor gem installed to use this mixin"
 end
 
@@ -12,7 +12,7 @@ module LicenseAcceptance
       def self.included(klass)
         klass.class_option :chef_license,
           type: :string,
-          desc: 'Accept the license for this product and any contained products: accept, accept-no-persist, accept-silent'
+          desc: "Accept the license for this product and any contained products: accept, accept-no-persist, accept-silent"
       end
 
     end

data/lib/license_acceptance/config.rb

@@ -1,10 +1,10 @@
-require 'logger'
+require "logger"
 
 module LicenseAcceptance
   class Config
     attr_accessor :output, :logger, :license_locations, :persist_location, :persist
 
-    def initialize(opts={})
+    def initialize(opts = {})
       @output = opts.fetch(:output, $stdout)
       @logger = opts.fetch(:logger, ::Logger.new(IO::NULL))
       @license_locations = opts.fetch(:license_locations, default_license_locations)
@@ -21,7 +21,8 @@ module LicenseAcceptance
 
     def default_license_locations
       if windows?
-        l = [ File.join(ENV["HOMEDRIVE"], "chef/accepted_licenses/") ]
+        root = ENV.fetch("SYSTEMDRIVE", "C:")
+        l = [ File.join(root, "chef/accepted_licenses/") ]
         unless is_root?
           # Look through a list of possible user locations and pick the first one that exists
           # copied from path_helper.rb in chef-config gem
@@ -31,6 +32,7 @@ module LicenseAcceptance
           possible_dirs << ENV["HOMESHARE"] + ENV["HOMEPATH"] if ENV["HOMESHARE"] && ENV["HOMEPATH"]
           possible_dirs << ENV["USERPROFILE"] if ENV["USERPROFILE"]
           raise NoValidEnvironmentVar if possible_dirs.empty?
+
           possible_dirs.each do |possible_dir|
             if Dir.exist?(possible_dir)
               full_possible_dir = File.join(possible_dir, ".chef/accepted_licenses/")
@@ -41,7 +43,7 @@ module LicenseAcceptance
         end
       else
         l = [ "/etc/chef/accepted_licenses/" ]
-        l << File.join(ENV['HOME'], ".chef/accepted_licenses/") unless is_root?
+        l << File.join(ENV["HOME"], ".chef/accepted_licenses/") unless is_root?
       end
       l
     end

data/lib/license_acceptance/logger.rb

@@ -1,4 +1,4 @@
-require "license_acceptance/config"
+require_relative "config"
 
 module LicenseAcceptance
   module Logger

data/lib/license_acceptance/product.rb

@@ -14,14 +14,16 @@ module LicenseAcceptance
 
     def ==(other)
       return false if other.class != Product
+
       if other.id == id &&
-         other.pretty_name == pretty_name &&
-         other.filename == filename &&
-         other.mixlib_name == mixlib_name
-         other.license_required_version == license_required_version
-         return true
+          other.pretty_name == pretty_name &&
+          other.filename == filename &&
+          other.mixlib_name == mixlib_name &&
+          other.license_required_version == license_required_version
+        return true
       end
-      return false
+
+      false
     end
 
   end

data/lib/license_acceptance/product_reader.rb

@@ -1,7 +1,7 @@
-require "tomlrb"
-require "license_acceptance/logger"
-require "license_acceptance/product"
-require "license_acceptance/product_relationship"
+autoload :Tomlrb, "tomlrb"
+require_relative "logger"
+require_relative "product"
+require_relative "product_relationship"
 
 module LicenseAcceptance
   class ProductReader
@@ -18,7 +18,7 @@ module LicenseAcceptance
       toml = Tomlrb.load_file(location, symbolize_keys: false)
       raise InvalidProductInfo.new(location) if toml.empty? || toml["products"].nil? || toml["relationships"].nil?
 
-      for product in toml["products"]
+      toml["products"].each do |product|
         products[product["id"]] = Product.new(
           product["id"], product["pretty_name"],
           product["filename"], product["mixlib_name"],
@@ -26,7 +26,7 @@ module LicenseAcceptance
         )
       end
 
-      for parent_id, children in toml["relationships"]
+      toml["relationships"].each do |parent_id, children|
         parent = products[parent_id]
         raise UnknownParent.new(parent_id) if parent.nil?
         # Its fine to not have a relationship entry, but not fine to have
@@ -34,9 +34,11 @@ module LicenseAcceptance
         if children.nil? || children.empty? || !children.is_a?(Array)
           raise NoChildRelationships.new(parent)
         end
+
         children.map! do |child_id|
           child = products[child_id]
           raise UnknownChild.new(child_id) if child.nil?
+
           child
         end
         relationships[parent] = children
@@ -52,6 +54,7 @@ module LicenseAcceptance
       if ENV["CHEF_LICENSE_PRODUCT_INFO"]
         return ENV["CHEF_LICENSE_PRODUCT_INFO"]
       end
+
       File.absolute_path(File.join(__FILE__, "../../../config/product_info.toml"))
     end
 
@@ -60,9 +63,10 @@ module LicenseAcceptance
         raise UnknownProduct.new(parent_id)
       end
       children = relationships.fetch(parent_product, [])
-      if !parent_version.is_a? String
+      unless parent_version.is_a? String
         raise ProductVersionTypeError.new(parent_version)
       end
+
       ProductRelationship.new(parent_product, children, parent_version)
     end
 

data/lib/license_acceptance/strategy/argument.rb

@@ -1,4 +1,4 @@
-require "license_acceptance/strategy/base"
+require_relative "base"
 
 module LicenseAcceptance
   module Strategy
@@ -6,6 +6,8 @@ module LicenseAcceptance
     # Look for acceptance values in the ARGV
     class Argument < Base
 
+      FLAG = "--chef-license".freeze
+
       attr_reader :argv
 
       def initialize(argv)
@@ -13,31 +15,30 @@ module LicenseAcceptance
       end
 
       def accepted?
-        look_for_value(ACCEPT)
+        String(value).downcase == ACCEPT
       end
 
       def silent?
-        look_for_value(ACCEPT_SILENT)
+        String(value).downcase == ACCEPT_SILENT
       end
 
       def no_persist?
-        look_for_value(ACCEPT_NO_PERSIST)
+        String(value).downcase == ACCEPT_NO_PERSIST
       end
 
-      private
+      def value?
+        argv.any? { |s| s == FLAG || s.start_with?("#{FLAG}=") }
+      end
 
-      def look_for_value(sought)
-        if argv.include?("--chef-license=#{sought}")
-          return true
-        end
-        i = argv.index("--chef-license")
-        unless i.nil?
-          val = argv[i+1]
-          if val != nil && val.downcase == sought
-            return true
-          end
+      def value
+        match = argv.detect { |s| s.start_with?("#{FLAG}=") }
+        return match.split("=").last if match
+
+        argv.each_cons(2) do |arg, value|
+          return value if arg == FLAG
         end
-        return false
+
+        nil
       end
     end
   end

data/lib/license_acceptance/strategy/environment.rb

@@ -1,4 +1,4 @@
-require "license_acceptance/strategy/base"
+require_relative "base"
 
 module LicenseAcceptance
   module Strategy
@@ -6,6 +6,8 @@ module LicenseAcceptance
     # Look for acceptance values in the environment
     class Environment < Base
 
+      ENV_KEY = "CHEF_LICENSE".freeze
+
       attr_reader :env
 
       def initialize(env)
@@ -13,24 +15,23 @@ module LicenseAcceptance
       end
 
       def accepted?
-        look_for_value(ACCEPT)
+        String(value).downcase == ACCEPT
       end
 
       def silent?
-        look_for_value(ACCEPT_SILENT)
+        String(value).downcase == ACCEPT_SILENT
       end
 
       def no_persist?
-        look_for_value(ACCEPT_NO_PERSIST)
+        String(value).downcase == ACCEPT_NO_PERSIST
       end
 
-      private
+      def value?
+        env.key?(ENV_KEY)
+      end
 
-      def look_for_value(sought)
-        if env['CHEF_LICENSE'] && env['CHEF_LICENSE'].downcase == sought
-          return true
-        end
-        return false
+      def value
+        env[ENV_KEY]
       end
 
     end

data/lib/license_acceptance/strategy/file.rb

@@ -1,9 +1,9 @@
-require 'date'
-require 'yaml'
-require 'fileutils'
-require 'etc'
-require "license_acceptance/logger"
-require "license_acceptance/strategy/base"
+require "date"
+autoload :YAML, "yaml"
+require "fileutils" unless defined?(FileUtils)
+require "etc" unless defined?(Etc)
+require_relative "../logger"
+require_relative "base"
 
 module LicenseAcceptance
   module Strategy
@@ -28,11 +28,9 @@ module LicenseAcceptance
         logger.debug("Searching for the following licenses: #{missing_licenses.map(&:id)}")
 
         searching.each do |product|
-          found = false
           config.license_locations.each do |loc|
             f = ::File.join(loc, product.filename)
             if ::File.exist?(f)
-              found = true
               logger.debug("Found license #{product.filename} at #{f}")
               missing_licenses.delete(product)
               break
@@ -49,7 +47,7 @@ module LicenseAcceptance
         parent_version = product_relationship.parent_version
         root_dir = config.persist_location
 
-        if !Dir.exist?(root_dir)
+        unless Dir.exist?(root_dir)
           begin
             FileUtils.mkdir_p(root_dir)
           rescue StandardError => e
@@ -70,7 +68,7 @@ module LicenseAcceptance
             errs << err unless err.nil?
           end
         end
-        return errs
+        errs
       end
 
       private
@@ -91,11 +89,11 @@ module LicenseAcceptance
           contents = Hash[contents.map { |k, v| [k.to_s, v] }]
           license_file << YAML.dump(contents)
         end
-        return nil
+        nil
       rescue StandardError => e
         msg = "Could not persist license to #{path}"
         logger.info "#{msg}\n\t#{e.message}\n\t#{e.backtrace.join("\n\t")}"
-        return e
+        e
       end
 
     end

data/lib/license_acceptance/strategy/prompt.rb

@@ -1,13 +1,13 @@
-require 'tty-prompt'
-require 'pastel'
-require "license_acceptance/logger"
-require "license_acceptance/strategy/base"
-require "timeout"
+autoload :TTY, "tty-prompt"
+require "pastel" unless defined?(Pastel)
+require_relative "../logger"
+require_relative "base"
+require "timeout" unless defined?(Timeout)
 
 module LicenseAcceptance
   module Strategy
 
-    # Interactive prompt for accepting and persistnce license acceptance, or failing with custom exit code
+    # Interactive prompt for accepting and persistence license acceptance, or failing with custom exit code
     class Prompt < Base
       include Logger
 
@@ -17,30 +17,30 @@ module LicenseAcceptance
         @output = config.output
       end
 
-      WIDTH = 50.freeze
+      WIDTH = 50
       PASTEL = Pastel.new
       BORDER = "+---------------------------------------------+".freeze
       YES = PASTEL.green.bold("yes")
-      CHECK  = PASTEL.green("✔")
+      CHECK = PASTEL.green("✔")
 
       def request(missing_licenses, &persist_callback)
         logger.debug("Requesting a license for #{missing_licenses.map(&:id)}")
         c = missing_licenses.size
-        s = c > 1 ? "s": ""
+        s = c > 1 ? "s" : ""
 
         acceptance_question = "Do you accept the #{c} product license#{s} (#{YES}/no)?"
         output.puts <<~EOM
-        #{BORDER}
-                    Chef License Acceptance
+          #{BORDER}
+                      Chef License Acceptance
 
-        Before you can continue, #{c} product license#{s}
-        must be accepted. View the license at
-        https://www.chef.io/end-user-license-agreement/
+          Before you can continue, #{c} product license#{s}
+          must be accepted. View the license at
+          https://www.chef.io/end-user-license-agreement/
 
-        License#{s} that need accepting:
-          * #{missing_licenses.map(&:pretty_name).join("\n  * ")}
+          License#{s} that need accepting:
+            * #{missing_licenses.map(&:pretty_name).join("\n  * ")}
 
-        #{acceptance_question}
+          #{acceptance_question}
 
         EOM
 
@@ -51,10 +51,10 @@ module LicenseAcceptance
 
         output.puts <<~EOM
 
-        If you do not accept this license you will
-        not be able to use Chef products.
+          If you do not accept this license you will
+          not be able to use Chef products.
 
-        #{acceptance_question}
+          #{acceptance_question}
 
         EOM
 
@@ -62,7 +62,7 @@ module LicenseAcceptance
         if answer != "yes"
           output.puts BORDER
         end
-        return answer
+        answer
       end
 
       private
@@ -73,12 +73,12 @@ module LicenseAcceptance
 
         answer = "no"
         begin
-          Timeout::timeout(60, PromptTimeout) do
+          Timeout.timeout(60, PromptTimeout) do
             answer = prompt.ask(">") do |q|
               q.modify :down, :trim
               q.required true
               q.messages[:required?] = "You must enter 'yes' or 'no'"
-              q.validate /^\s*(yes|no)\s*$/i
+              q.validate(/^\s*(yes|no)\s*$/i)
               q.messages[:valid?] = "You must enter 'yes' or 'no'"
             end
           end
@@ -95,13 +95,13 @@ module LicenseAcceptance
             output.puts "#{CHECK} #{c} product license#{s} persisted.\n\n"
           else
             output.puts <<~EOM
-            #{CHECK} #{c} product license#{s} accepted.
-            Could not persist acceptance:\n\t* #{errs.map(&:message).join("\n\t* ")}
+              #{CHECK} #{c} product license#{s} accepted.
+              Could not persist acceptance:\n\t* #{errs.map(&:message).join("\n\t* ")}
             EOM
           end
           return true
         end
-        return false
+        false
       end
     end