license-acceptance 1.0.11 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a7e8b93f7e80e8221f025bc46d0f264ffcfdfadf1111cbe73289697ba4e68c7
-  data.tar.gz: ff921f3831649e8981727a5d1d4afeb341be6a08b0760b239748b56273578e40
+  metadata.gz: eee8ab3bdb6b370c3b0c2dddb7a86f22cea5240eae5df17e58e4c367fc08a0fe
+  data.tar.gz: 7f25c5f59f833808115dead1157b33f09c9fe4e4000c3c4e70dee586466d74a9
 SHA512:
-  metadata.gz: 948d8f90071888f6c2dcea6538308ca10bc8561c005ef4df2e217742cb4a4161c06dd6f2a001b7024f172cfdfbaf464a0dee5a7eefe697992f8e8a8794c700b9
-  data.tar.gz: 549aa9fe92c8524403cfb8bde8d4a3fd205eb09a23f0df637d7ad1453316dcc72cc2ff8c4e40d6f8900105d54a1755830aa7c4a29b89883f578cf4f72e9fc8eb
+  metadata.gz: ef3af6247b87811c3796838e707d47b153c7828160a4dee699b3e95f2bef534c055fa34e828548a7e0dc9830b146014c2a8a7a4ac2cca4d94388e180d4fa5581
+  data.tar.gz: aa6d132e77ecfb95a8c4e263d29d7731a44f2c8d40d4cd7eeb48fbf8964c5a9e807c6cde3fec5f757af3cb9de2e5fbfc1e8d60c5729598f204fa2829d6e1c42c

data/Gemfile

@@ -1,6 +1,28 @@
 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.2.1"
+  gem "climate_control", "~> 0.2"
+  gem "mixlib-cli", "~> 1.7"
+  gem "rake", ">= 10.1.0"
+  gem "rspec", "~> 3.0"
+  gem "thor", ">= 0.20", "< 2.0" # validate 2.0 when it ships
+end
+
+group :docs do
+  gem "yard"
+  gem "redcarpet"
+  gem "github-markup"
+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

@@ -52,7 +52,7 @@ 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"]

data/lib/license_acceptance/acceptor.rb

@@ -11,9 +11,9 @@ require "license_acceptance/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
@@ -74,28 +74,28 @@ module LicenseAcceptance
           end
         end
         @acceptance_value = accepted_silent? ? ACCEPT_SILENT : ACCEPT
-        return true
+        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
+        # We have to infer the acceptance value if they use the prompt to accept
+        if config.persist
+          @acceptance_value = ACCEPT # rubocop: disable Lint/AssignmentInCondition
+          file_strategy.persist(product_relationship, missing_licenses)
+        else
+          @acceptance_value = ACCEPT_NO_PERSIST # rubocop: disable Lint/AssignmentInCondition
+          []
         end
-        return true
+      end
+        true
       else
         raise LicenseNotAcceptedError.new(product_relationship.parent, missing_licenses)
       end
     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
 
@@ -104,7 +104,9 @@ module LicenseAcceptance
       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.to_s == "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 +115,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
 
@@ -140,20 +143,20 @@ module LicenseAcceptance
     # 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"
+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"
+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,7 @@ module LicenseAcceptance
 
     def default_license_locations
       if windows?
-        root = ENV.fetch("SYSTEMDRIVE","C:")
+        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
@@ -32,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/")
@@ -42,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/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

@@ -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

@@ -30,14 +30,15 @@ module LicenseAcceptance
         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
+          val = argv[i + 1]
+          if !val.nil? && val.downcase == sought
             return true
           end
         end
-        return false
+        false
       end
     end
   end

data/lib/license_acceptance/strategy/environment.rb

@@ -27,10 +27,11 @@ module LicenseAcceptance
       private
 
       def look_for_value(sought)
-        if env['CHEF_LICENSE'] && env['CHEF_LICENSE'].downcase == sought
+        if env["CHEF_LICENSE"] && env["CHEF_LICENSE"].downcase == sought
           return true
         end
-        return false
+
+        false
       end
 
     end

data/lib/license_acceptance/strategy/file.rb

@@ -1,7 +1,7 @@
-require 'date'
-require 'yaml'
-require 'fileutils'
-require 'etc'
+require "date"
+require "yaml"
+require "fileutils"
+require "etc"
 require "license_acceptance/logger"
 require "license_acceptance/strategy/base"
 
@@ -49,7 +49,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 +70,7 @@ module LicenseAcceptance
             errs << err unless err.nil?
           end
         end
-        return errs
+        errs
       end
 
       private
@@ -91,11 +91,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,5 +1,5 @@
-require 'tty-prompt'
-require 'pastel'
+require "tty-prompt"
+require "pastel"
 require "license_acceptance/logger"
 require "license_acceptance/strategy/base"
 require "timeout"
@@ -7,7 +7,7 @@ require "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