license-acceptance 0.2.10 → 2.1.13

data/lib/license_acceptance/strategy/file.rb

@@ -0,0 +1,101 @@
+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
+
+    # Read and write marker files that show acceptance.
+    class File < Base
+      include Logger
+
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      INVOCATION_TIME = DateTime.now.freeze
+
+      # For all the given products in the product set, search all possible locations for the
+      # license acceptance files.
+      def accepted?(product_relationship)
+        searching = [product_relationship.parent] + product_relationship.children
+        missing_licenses = searching.clone
+        logger.debug("Searching for the following licenses: #{missing_licenses.map(&:id)}")
+
+        searching.each do |product|
+          config.license_locations.each do |loc|
+            f = ::File.join(loc, product.filename)
+            if ::File.exist?(f)
+              logger.debug("Found license #{product.filename} at #{f}")
+              missing_licenses.delete(product)
+              break
+            end
+          end
+          break if missing_licenses.empty?
+        end
+        logger.debug("Missing licenses remaining: #{missing_licenses.map(&:id)}")
+        missing_licenses
+      end
+
+      def persist(product_relationship, missing_licenses)
+        parent = product_relationship.parent
+        parent_version = product_relationship.parent_version
+        root_dir = config.persist_location
+
+        unless Dir.exist?(root_dir)
+          begin
+            FileUtils.mkdir_p(root_dir)
+          rescue StandardError => e
+            msg = "Could not create license directory #{root_dir}"
+            logger.info "#{msg}\n\t#{e.message}\n\t#{e.backtrace.join("\n\t")}"
+            return [e]
+          end
+        end
+
+        errs = []
+        if missing_licenses.include?(parent)
+          err = persist_license(root_dir, parent, parent, parent_version)
+          errs << err unless err.nil?
+        end
+        product_relationship.children.each do |child|
+          if missing_licenses.include?(child)
+            err = persist_license(root_dir, child, parent, parent_version)
+            errs << err unless err.nil?
+          end
+        end
+        errs
+      end
+
+      private
+
+      def persist_license(folder_path, product, parent, parent_version)
+        path = ::File.join(folder_path, product.filename)
+        logger.info("Persisting a license for #{product.pretty_name} at path #{path}")
+        ::File.open(path, ::File::WRONLY | ::File::CREAT | ::File::EXCL) do |license_file|
+          contents = {
+            id: product.id,
+            name: product.pretty_name,
+            date_accepted: INVOCATION_TIME.iso8601,
+            accepting_product: parent.id,
+            accepting_product_version: parent_version,
+            user: Etc.getlogin,
+            file_format: 1,
+          }
+          contents = Hash[contents.map { |k, v| [k.to_s, v] }]
+          license_file << YAML.dump(contents)
+        end
+        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")}"
+        e
+      end
+
+    end
+  end
+end

data/lib/license_acceptance/strategy/prompt.rb

@@ -0,0 +1,111 @@
+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 persistence license acceptance, or failing with custom exit code
+    class Prompt < Base
+      include Logger
+
+      attr_reader :output
+
+      def initialize(config)
+        @output = config.output
+      end
+
+      WIDTH = 50
+      PASTEL = Pastel.new
+      BORDER = "+---------------------------------------------+".freeze
+      YES = PASTEL.green.bold("yes")
+      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" : ""
+
+        acceptance_question = "Do you accept the #{c} product license#{s} (#{YES}/no)?"
+        output.puts <<~EOM
+          #{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/
+
+          License#{s} that need accepting:
+            * #{missing_licenses.map(&:pretty_name).join("\n  * ")}
+
+          #{acceptance_question}
+
+        EOM
+
+        if ask(output, c, s, persist_callback)
+          output.puts BORDER
+          return true
+        end
+
+        output.puts <<~EOM
+
+          If you do not accept this license you will
+          not be able to use Chef products.
+
+          #{acceptance_question}
+
+        EOM
+
+        answer = ask(output, c, s, persist_callback)
+        if answer != "yes"
+          output.puts BORDER
+        end
+        answer
+      end
+
+      private
+
+      def ask(output, c, s, persist_callback)
+        logger.debug("Attempting to request interactive prompt on TTY")
+        prompt = TTY::Prompt.new(track_history: false, active_color: :bold, interrupt: :exit, output: output)
+
+        answer = "no"
+        begin
+          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.messages[:valid?] = "You must enter 'yes' or 'no'"
+            end
+          end
+        rescue PromptTimeout
+          prompt.unsubscribe(prompt.reader)
+          output.puts "Prompt timed out. Use non-interactive flags or enter an answer within 60 seconds."
+        end
+
+        if answer == "yes"
+          output.puts
+          output.puts "Persisting #{c} product license#{s}..."
+          errs = persist_callback.call
+          if errs.empty?
+            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* ")}
+            EOM
+          end
+          return true
+        end
+        false
+      end
+    end
+
+    class PromptTimeout < StandardError; end
+
+  end
+end

data/lib/license_acceptance/strategy/provided_value.rb

@@ -0,0 +1,31 @@
+require_relative "base"
+
+module LicenseAcceptance
+  module Strategy
+
+    # Used for library consumers to parse their own form of acceptance (knife config, omnibus config, etc.) and pass it in
+    class ProvidedValue < Base
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def accepted?
+        String(value).downcase == ACCEPT
+      end
+
+      def silent?
+        String(value).downcase == ACCEPT_SILENT
+      end
+
+      def no_persist?
+        String(value).downcase == ACCEPT_NO_PERSIST
+      end
+
+      def value?
+        !!value
+      end
+    end
+  end
+end

data/lib/license_acceptance/version.rb

@@ -1,3 +1,3 @@
 module LicenseAcceptance
-  VERSION = "0.2.10"
+  VERSION = "2.1.13".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: license-acceptance
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 2.1.13
 platform: ruby
 authors:
 - tyler-ball
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -28,156 +28,50 @@ dependencies:
   name: tomlrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: tty-box
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: mixlib-cli
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
-- !ruby/object:Gem::Dependency
-  name: climate_control
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 description: Chef End User License Agreement Acceptance for Ruby products
 email:
 - tball@chef.io
@@ -186,34 +80,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
 - LICENSE
-- Rakefile
 - config/product_info.toml
 - lib/license_acceptance/acceptor.rb
-- lib/license_acceptance/arg_acceptance.rb
 - lib/license_acceptance/cli_flags/mixlib_cli.rb
 - lib/license_acceptance/cli_flags/thor.rb
 - lib/license_acceptance/config.rb
-- lib/license_acceptance/env_acceptance.rb
-- lib/license_acceptance/file_acceptance.rb
 - lib/license_acceptance/logger.rb
 - lib/license_acceptance/product.rb
 - lib/license_acceptance/product_reader.rb
 - lib/license_acceptance/product_relationship.rb
-- lib/license_acceptance/prompt_acceptance.rb
+- lib/license_acceptance/strategy/argument.rb
+- lib/license_acceptance/strategy/base.rb
+- lib/license_acceptance/strategy/environment.rb
+- lib/license_acceptance/strategy/file.rb
+- lib/license_acceptance/strategy/prompt.rb
+- lib/license_acceptance/strategy/provided_value.rb
 - lib/license_acceptance/version.rb
-- spec/license_acceptance/acceptor_spec.rb
-- spec/license_acceptance/arg_acceptance_spec.rb
-- spec/license_acceptance/cli_flags/mixlib_cli_spec.rb
-- spec/license_acceptance/cli_flags/thor_spec.rb
-- spec/license_acceptance/config_spec.rb
-- spec/license_acceptance/env_acceptance_spec.rb
-- spec/license_acceptance/file_acceptance_spec.rb
-- spec/license_acceptance/product_reader_spec.rb
-- spec/license_acceptance/product_spec.rb
-- spec/license_acceptance/prompt_acceptance_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/chef/license-acceptance/
 licenses:
 - Apache-2.0
@@ -226,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,94 +0,0 @@
-PATH
-  remote: .
-  specs:
-    license-acceptance (0.2.10)
-      pastel (~> 0.7)
-      tomlrb (~> 1.2)
-      tty-box (~> 0.3)
-      tty-prompt (~> 0.18)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    binding_of_caller (0.8.0)
-      debug_inspector (>= 0.0.1)
-    byebug (11.0.1)
-    climate_control (0.2.0)
-    coderay (1.1.2)
-    debug_inspector (0.0.3)
-    diff-lcs (1.3)
-    equatable (0.5.0)
-    method_source (0.9.2)
-    mixlib-cli (1.7.0)
-    necromancer (0.4.0)
-    pastel (0.7.2)
-      equatable (~> 0.5.0)
-      tty-color (~> 0.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
-      byebug (~> 11.0)
-      pry (~> 0.10)
-    pry-stack_explorer (0.4.9.3)
-      binding_of_caller (>= 0.7)
-      pry (>= 0.9.11)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    strings (0.1.5)
-      strings-ansi (~> 0.1)
-      unicode-display_width (~> 1.5)
-      unicode_utils (~> 1.4)
-    strings-ansi (0.1.0)
-    thor (0.20.3)
-    timers (4.3.0)
-    tomlrb (1.2.8)
-    tty-box (0.3.0)
-      pastel (~> 0.7.2)
-      strings (~> 0.1.4)
-      tty-cursor (~> 0.6.0)
-    tty-color (0.4.3)
-    tty-cursor (0.6.1)
-    tty-prompt (0.18.1)
-      necromancer (~> 0.4.0)
-      pastel (~> 0.7.0)
-      timers (~> 4.0)
-      tty-cursor (~> 0.6.0)
-      tty-reader (~> 0.5.0)
-    tty-reader (0.5.0)
-      tty-cursor (~> 0.6.0)
-      tty-screen (~> 0.6.4)
-      wisper (~> 2.0.0)
-    tty-screen (0.6.5)
-    unicode-display_width (1.5.0)
-    unicode_utils (1.4.0)
-    wisper (2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  climate_control (~> 0.2)
-  license-acceptance!
-  mixlib-cli (~> 1.7)
-  pry (~> 0.12)
-  pry-byebug (~> 3.6)
-  pry-stack_explorer (~> 0.4)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  thor (~> 0.20)
-
-BUNDLED WITH
-   1.17.3

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/lib/license_acceptance/arg_acceptance.rb

@@ -1,32 +0,0 @@
-module LicenseAcceptance
-  class ArgAcceptance
-
-    def accepted?(argv)
-      look_for_value(argv, "accept")
-    end
-
-    def silent?(argv)
-      look_for_value(argv, "accept-silent")
-    end
-
-    def no_persist?(argv)
-      look_for_value(argv, "accept-no-persist")
-    end
-
-    private
-
-    def look_for_value(argv, 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
-      end
-      return false
-    end
-  end
-end

data/lib/license_acceptance/env_acceptance.rb

@@ -1,26 +0,0 @@
-module LicenseAcceptance
-  class EnvAcceptance
-
-    def accepted?(env)
-      look_for_value(env, "accept")
-    end
-
-    def silent?(env)
-      look_for_value(env, "accept-silent")
-    end
-
-    def no_persist?(env)
-      look_for_value(env, "accept-no-persist")
-    end
-
-    private
-
-    def look_for_value(env, sought)
-      if env['CHEF_LICENSE'] && env['CHEF_LICENSE'].downcase == sought
-        return true
-      end
-      return false
-    end
-
-  end
-end