chef-apply 0.4.12 → 0.5.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6838824639553486d507ce912e1346c743de3dc13d93c75930ba87392bd3750b
-  data.tar.gz: 1866addf7d4356516b5afd94a21e59de43c32c2fef117a71bec883950ded266f
+  metadata.gz: 40e1ef3f302762a273ab6fcdf15f0102bf0de5199d20cd22df2125a237551ab5
+  data.tar.gz: f65616505eed1c2afd0393b45709ad683c8372903790408a6c1020003122487a
 SHA512:
-  metadata.gz: 36712f4c00946b09a9d20b1c859c02041213453baf7d6404f3b3dc064eb8f40267fce2267f614477016535fc4de88a1f4ca882cec8b365a91e932719a888438e
-  data.tar.gz: 30b001fcf8643a2bd8aaed14798162721f26c0a9b1959f74ac56bdbe4035b4c6017244a6750397a6bb1f232938ab4947e408567d4a3a58fb2209ba9c9939704c
+  metadata.gz: 72f59e61c72e8f8f470b392344e382193a2e51d977d9f9a8687ff9fa86563e2fdfe512bbd2d12d8fb418f5734b229a92b6947fc9a587e10df7630456d0229a47
+  data.tar.gz: ed03fd5cb7b9cbf2af42cf987a55e2821d8098989ee067f105a6af28413ab50d782c1824e8a5f2e79f43f54063b46a80b20a8b9597a081acded5a13044010317

data/Gemfile

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2018 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,7 +19,7 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "chefstyle"
+  gem "chefstyle", "1.7.2"
   gem "rake", ">= 10.1.0"
   gem "rspec", "~> 3.0"
   gem "simplecov"

data/bin/chef-run

@@ -20,4 +20,4 @@ require "chef_apply/startup"
 
 # Perform initialization tasks then hand off control to
 # CLI to run the command.
-ChefApply::Startup.new(ARGV).run
+ChefApply::Startup.new(ARGV).run(enforce_license: true)

data/chef-apply.gemspec

@@ -15,7 +15,7 @@
 # limitations under the License.
 #
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "chef_apply/version"
 
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Ad-hoc management of individual nodes and devices."
   spec.homepage      = "https://github.com/chef/chef-apply"
   spec.license       = "Apache-2.0"
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.6"
 
   spec.files = %w{Rakefile LICENSE warning.txt} +
     Dir.glob("Gemfile*") + # Includes Gemfile and locks
@@ -40,24 +40,19 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "mixlib-cli" # Provides argument handling DSL for CLI applications
-  spec.add_dependency "mixlib-config", ">= 3.0.5"  # shared chef configuration library that
-                                                   # simplifies managing a configuration file
+  spec.add_dependency "mixlib-config", ">= 3.0.5" # shared chef configuration library that simplifies managing a configuration file
   spec.add_dependency "mixlib-log" # Basis for our traditional logger
   spec.add_dependency "mixlib-install" # URL resolver + install tool for chef products
-  spec.add_dependency "r18n-desktop" # easy path to message text management via
-                                     # localization gem...
-  spec.add_dependency "toml-rb" # This isn't ideal because mixlib-config uses 'tomlrb'
-                                # but that library does not support a dumper
+  spec.add_dependency "r18n-desktop" # easy path to message text management via localization gem...
+  spec.add_dependency "toml-rb" # This isn't ideal because mixlib-config uses 'tomlrb' but that library does not support a dumper
   spec.add_dependency "train-core", "~> 3.0" # remote connection management over ssh, winrm
   spec.add_dependency "train-winrm" # winrm transports were pulled out into this plugin
   spec.add_dependency "pastel" # A color library
   spec.add_dependency "tty-spinner" # Pretty output for status updates in the CLI
-  spec.add_dependency "chef", ">= 15.0" # Needed to load cookbooks
-  spec.add_dependency "chef-cli", ">= 1.0.3 " # Policyfile
-  spec.add_dependency "chef-telemetry", "<= 0.1.10" # telemetry, updates required to pull in later versions
-  spec.add_dependency "license-acceptance", "~> 1.0", ">= 1.0.11"
+  spec.add_dependency "chef", ">= 16.0" # Needed to load cookbooks
+  spec.add_dependency "chef-cli", ">= 2.0.10 " # Policyfile
+  spec.add_dependency "chef-telemetry", ">= 1.0.2"
+  spec.add_dependency "license-acceptance", ">= 1.0.11", "< 3"
 
-  spec.add_development_dependency "bundler"
-
-  spec.post_install_message = File.read(File.expand_path("../warning.txt", __FILE__))
+  spec.post_install_message = File.read(File.expand_path("warning.txt", __dir__))
 end

data/i18n/en.yml

@@ -25,10 +25,10 @@ cli:
     %1:
 
     [telemetry]
-    enable=false
+    enabled=false
 
     For more information about what we data gather and additional opt-out
-    options, visit https://chef.sh/docs/chef-workstation/privacy/
+    options, visit https://docs.chef.io/workstation/privacy/
 
   description: |
     Chef Run is a tool to execute ad-hoc tasks using Chef.
@@ -113,6 +113,7 @@ cli:
                            cookbook is found we run the default recipe.
                         3. This behaves similarly to 'cookbook name' above, but it also allows
                            you to specify which recipe to use from the cookbook.
+                           Usage: cookbookname::recipename
   error:
     bad_config_file: |
 

data/i18n/errors/en.yml

@@ -146,7 +146,7 @@ errors:
       For more information, please consult the documentation
       for this resource:
 
-        https://docs.chef.io/resource_reference.html
+        https://docs.chef.io/resources/
 
   CHEFCCR004:
     text: |
@@ -157,7 +157,7 @@ errors:
       Please consult the documentation for properties
       supported by your resource and their valid values:
 
-        https://docs.chef.io/resource_reference.html
+        https://docs.chef.io/resources/
 
   CHEFCCR005:
     text: |
@@ -165,7 +165,7 @@ errors:
 
       Please consult the documentation for a list of valid resources:
 
-        https://docs.chef.io/resource_reference.html
+        https://docs.chef.io/resources/
 
   CHEFCCR006:
     text: |
@@ -174,7 +174,7 @@ errors:
       Please consult the documentation for %2 for a list of
       valid properties:
 
-        https://docs.chef.io/resource_reference.html
+        https://docs.chef.io/resources/
 
   CHEFCCR099:
     text: |
@@ -246,7 +246,7 @@ errors:
 
       Additional instructions can be found in the troubleshooting documentation:
 
-      https://www.chef.sh/docs/chef-workstation/troubleshooting/#error-code-cheftrn007
+      https://docs.chef.io/workstation/troubleshooting/#cheftrn007
 
   CHEFTRN999:
     text: |
@@ -257,6 +257,14 @@ errors:
       %1
 
   # CLI argument validation errors
+  #
+  CHEFVAL001:
+    display: { decorations: false }
+    text: |
+      The key file you specified does not exist or can't be read.
+
+      You provided '%1'.
+
   CHEFVAL002:
     display: { decorations: false }
     text: |
@@ -311,7 +319,7 @@ errors:
   CHEFVAL009:
     display: { decorations: false }
     text: |
-      File extension '%1' is unsupported. Currently recipes must be specified with a `.rb` extension.
+      File extension '%1' is unsupported. Currently recipes must be specified with a `.rb` or `.yml` extension.
 
   CHEFVAL010:
     display: { decorations: false }

data/lib/chef_apply/action/base.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require "chef_apply/telemeter"
-require "chef_apply/error"
+require "chef/telemeter"
+require_relative "../error"
 
 module ChefApply
   module Action

data/lib/chef_apply/action/converge_target.rb

@@ -15,9 +15,9 @@
 # limitations under the License.
 #
 
-require "chef_apply/action/base"
-require "pathname"
-require "tempfile"
+require_relative "base"
+require "pathname" unless defined?(Pathname)
+require "tempfile" unless defined?(Tempfile)
 # FLAG: require "chef/util/path_helper"
 require "chef/util/path_helper"
 
@@ -159,7 +159,7 @@ module ChefApply::Action
     end
 
     def handle_ccr_error
-      require "chef_apply/action/converge_target/ccr_failure_mapper"
+      require_relative "converge_target/ccr_failure_mapper"
       mapper_opts = {}
       content = target_host.fetch_file_contents(chef_report_path)
       if content.nil?

data/lib/chef_apply/action/converge_target/ccr_failure_mapper.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 #
 
-require "chef_apply/error"
+require_relative "../../error"
 
 module ChefApply
   module Action

data/lib/chef_apply/action/generate_local_policy.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require "chef_apply/action/base"
-require "chef_apply/error"
+require_relative "base"
+require_relative "../error"
 module ChefApply::Action
   class GenerateLocalPolicy < Base
     attr_reader :archive_file_location
@@ -53,6 +53,7 @@ module ChefApply::Action
     end
 
   end
+
   class PolicyfileInstallError < ChefApply::Error
     def initialize(cause_err); super("CHEFPOLICY001", cause_err.message); end
   end

data/lib/chef_apply/action/generate_temp_cookbook.rb

@@ -14,8 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "chef_apply/action/base"
-require "chef_apply/error"
+require_relative "base"
+require_relative "../error"
 module ChefApply
   module Action
     class GenerateTempCookbook < Base
@@ -35,7 +35,7 @@ module ChefApply
 
       def initialize(options)
         super(options)
-        require "chef_apply/action/generate_temp_cookbook/temp_cookbook"
+        require_relative "generate_temp_cookbook/temp_cookbook"
         @generated_cookbook ||= TempCookbook.new
       end
 
@@ -59,7 +59,7 @@ module ChefApply
           ChefApply::Log.debug("#{recipe_specifier} is a valid path to a recipe")
           recipe_path = recipe_specifier
         else
-          require "chef_apply/action/generate_temp_cookbook/recipe_lookup"
+          require_relative "generate_temp_cookbook/recipe_lookup"
           rl = RecipeLookup.new(repo_paths)
           cookbook_path_or_name, optional_recipe_name = rl.split(recipe_specifier)
           cookbook = rl.load_cookbook(cookbook_path_or_name)

data/lib/chef_apply/action/generate_temp_cookbook/recipe_lookup.rb

@@ -16,10 +16,10 @@
 #
 
 require "chef-config/config"
-require "chef_apply/config"
-require "chef_apply/error"
-require "chef_apply/log"
-require "chef_apply/action/base"
+require_relative "../../config"
+require_relative "../../error"
+require_relative "../../log"
+require_relative "../base"
 
 module ChefApply
   module Action
@@ -81,7 +81,7 @@ module ChefApply
         # Find the specified recipe or default recipe if none is specified.
         # Raise an error if recipe cannot be found.
         def find_recipe(cookbook, recipe_name = nil)
-          recipes = cookbook.recipe_filenames_by_name
+          recipes = cookbook.recipe_filenames_by_name.merge(cookbook.recipe_yml_filenames_by_name)
           if recipe_name.nil?
             default_recipe = recipes["default"]
             raise NoDefaultRecipe.new(cookbook.root_dir, cookbook.name) if default_recipe.nil?

data/lib/chef_apply/action/generate_temp_cookbook/temp_cookbook.rb

@@ -15,11 +15,11 @@
 # limitations under the License.
 #
 
-require "tmpdir"
-require "fileutils"
-require "chef_apply/log"
-require "chef_apply/error"
-require "chef_apply/action/generate_temp_cookbook"
+require "tmpdir" unless defined?(Dir.mktmpdir)
+require "fileutils" unless defined?(FileUtils)
+require_relative "../../log"
+require_relative "../../error"
+require_relative "../generate_temp_cookbook"
 module ChefApply
   module Action
     class GenerateTempCookbook
@@ -34,7 +34,7 @@ module ChefApply
 
         def from_existing_recipe(existing_recipe_path)
           ext_name = File.extname(existing_recipe_path)
-          raise UnsupportedExtension.new(ext_name) unless ext_name == ".rb"
+          raise UnsupportedExtension.new(ext_name) unless ext_name == ".rb" || ext_name == ".yml"
 
           cb = cookbook_for_recipe(existing_recipe_path)
           if cb

data/lib/chef_apply/action/install_chef.rb

@@ -15,9 +15,9 @@
 # limitations under the License.
 #
 
-require "chef_apply/action/base"
-require "chef_apply/action/install_chef/minimum_chef_version"
-require "fileutils"
+require_relative "base"
+require_relative "install_chef/minimum_chef_version"
+require "fileutils" unless defined?(FileUtils)
 
 module ChefApply
   module Action
@@ -104,7 +104,7 @@ module ChefApply
       end
 
       def download_to_workstation(url_path)
-        require "chef_apply/file_fetcher"
+        require_relative "../file_fetcher"
         ChefApply::FileFetcher.fetch(url_path)
       end
 

data/lib/chef_apply/action/install_chef/minimum_chef_version.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require "chef_apply/error"
-require "chef_apply/action/install_chef/minimum_chef_version"
+require_relative "../../error"
+require_relative "minimum_chef_version"
 
 module ChefApply
   module Action

data/lib/chef_apply/cli.rb

@@ -15,29 +15,29 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "mixlib/cli"
+require "mixlib/cli" unless defined?(Mixlib::CLI)
 
-require "chef_apply/config"
+require_relative "config"
 require "chef-config/config"
 require "chef-config/logger"
 
-require "chef_apply/cli/validation"
-require "chef_apply/cli/options"
-require "chef_apply/cli/help"
-require "chef_apply/error"
-require "chef_apply/log"
-require "chef_apply/target_host"
-require "chef_apply/target_resolver"
-require "chef_apply/telemeter"
-require "chef_apply/ui/error_printer"
-require "chef_apply/ui/terminal"
-require "chef_apply/ui/terminal/job"
+require_relative "cli/validation"
+require_relative "cli/options"
+require_relative "cli/help"
+require_relative "error"
+require_relative "log"
+require_relative "target_host"
+require_relative "target_resolver"
+require_relative "telemeter"
+require_relative "ui/error_printer"
+require_relative "ui/terminal"
+require_relative "ui/terminal/job"
 require "license_acceptance/cli_flags/mixlib_cli"
 require "license_acceptance/acceptor"
 
-require "chef_apply/action/generate_temp_cookbook"
-require "chef_apply/action/generate_local_policy"
-require "chef_apply/action/converge_target"
+require_relative "action/generate_temp_cookbook"
+require_relative "action/generate_local_policy"
+require_relative "action/converge_target"
 
 module ChefApply
   class CLI
@@ -63,24 +63,22 @@ module ChefApply
       super()
     end
 
-    def run
+    def run(enforce_license: false)
       # Perform a timing and capture of the run. Individual methods and actions may perform
-      # nested Telemeter.timed_*_capture or Telemeter.capture calls in their operation, and
+      # nested Chef::Telemeter.timed_*_capture or Chef::Telemeter.capture calls in their operation, and
       # they will be captured in the same telemetry session.
-      # NOTE: We're not currently sending arguments to telemetry because we have not implemented
-      #       pre-parsing of arguments to eliminate potentially sensitive data such as
-      #       passwords in host name, or in ad-hoc converge properties.
-      Telemeter.timed_run_capture([:redacted]) do
+
+      Chef::Telemeter.timed_run_capture([:redacted]) do
         begin
-          perform_run
+          perform_run(enforce_license: enforce_license)
         rescue Exception => e
           @rc = handle_run_error(e)
         end
       end
-    rescue => e
+    rescue => e # can occur if exception thrown in error handling
       @rc = handle_run_error(e)
     ensure
-      Telemeter.commit
+      Chef::Telemeter.commit
       exit @rc
     end
 
@@ -102,14 +100,14 @@ module ChefApply
       end
     end
 
-    def perform_run
+    def perform_run(enforce_license: false)
       parse_options(@argv)
       if @argv.empty? || parsed_options[:help]
         show_help
       elsif parsed_options[:version]
         show_version
       else
-        check_license_acceptance
+        check_license_acceptance if enforce_license
         validate_params(cli_arguments)
         target_hosts = resolve_targets(cli_arguments.shift, parsed_options)
         render_cookbook_setup(cli_arguments)
@@ -181,7 +179,7 @@ module ChefApply
     end
 
     def install(target_host, reporter)
-      require "chef_apply/action/install_chef"
+      require_relative "action/install_chef"
       context = TS.install_chef
       reporter.update(context.verifying)
       installer = Action::InstallChef.new(target_host: target_host, check_only: !parsed_options[:install])
@@ -284,7 +282,7 @@ module ChefApply
     end
 
     def handle_perform_error(e)
-      require "chef_apply/errors/standard_error_resolver"
+      require_relative "errors/standard_error_resolver"
       id = e.respond_to?(:id) ? e.id : e.class.to_s
       # TODO: This is currently sending host information for certain ssh errors
       #       post release we need to scrub this data. For now I'm redacting the

data/lib/chef_apply/cli/help.rb

@@ -61,7 +61,7 @@ module ChefApply
       end
 
       def show_version
-        require "chef_apply/version"
+        require_relative "../version"
         UI::Terminal.output T.version.show(ChefApply::VERSION)
       end
     end

data/lib/chef_apply/cli/options.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 #
 
-require "chef_apply/text"
+require_relative "../text"
 
 # Moving the options into here so the cli.rb file is smaller and easier to read
 # For options that need to be merged back into the global ChefApply::Config object
@@ -64,8 +64,8 @@ module ChefApply
           description: T.identity_file,
           proc: (Proc.new do |paths|
             path = paths
-            unless File.exist?(path)
-              raise OptionValidationError.new("CHEFVAL001", self, path)
+            unless File.readable?(path)
+              raise OptionValidationError.new("CHEFVAL001", nil, path)
             end
 
             path

data/lib/chef_apply/cli/validation.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 #
 
-require "chef_apply/error"
+require_relative "../error"
 
 module ChefApply
   class CLI
@@ -76,6 +76,8 @@ module ChefApply
           value.to_i
         when /^\d+\.\d*$/, /^\d*\.\d+$/
           value.to_f
+        when /^[:].+$/
+          value.split(":").last.to_sym
         when /true/i
           true
         when /false/i

data/lib/chef_apply/config.rb

@@ -15,10 +15,10 @@
 # limitations under the License.
 #
 
-require "chef_apply/log"
-require "mixlib/config"
-require "fileutils"
-require "pathname"
+require_relative "log"
+require "mixlib/config" unless defined?(Mixlib::Config)
+require "fileutils" unless defined?(FileUtils)
+require "pathname" unless defined?(Pathname)
 require "chef-config/config"
 require "chef-config/workstation_config_loader"
 
@@ -109,8 +109,8 @@ module ChefApply
     # in their local configuration to ensure that dev usage
     # doesn't skew customer telemetry.
     config_context :telemetry do
-      default(:dev, false)
-      default(:enable, true)
+      default(:dev_mode, false)
+      default(:enabled, true)
     end
 
     config_context :log do

data/lib/chef_apply/errors/standard_error_resolver.rb

@@ -37,8 +37,8 @@ module ChefApply
 
       def self.deps
         # Avoid loading additional includes until they're needed
-        require "socket"
-        require "openssl"
+        require "socket" unless defined?(Socket)
+        require "openssl" unless defined?(OpenSSL)
       end
     end
   end

data/lib/chef_apply/file_fetcher.rb

@@ -15,10 +15,10 @@
 # limitations under the License.
 #
 
-require "net/http"
-require "uri"
-require "chef_apply/config"
-require "chef_apply/log"
+require "net/http" unless defined?(Net::HTTP)
+require "uri" unless defined?(URI)
+require_relative "config"
+require_relative "log"
 
 module ChefApply
   class FileFetcher

data/lib/chef_apply/startup.rb

@@ -14,10 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "chef_apply/config"
-require "chef_apply/text"
-require "chef_apply/ui/terminal"
-require "chef_apply/telemeter/sender"
+require_relative "config"
+require_relative "text"
+require_relative "ui/terminal"
+require_relative "telemeter"
 require "chef/log"
 require "chef/config"
 module ChefApply
@@ -33,7 +33,7 @@ module ChefApply
       init_terminal
     end
 
-    def run
+    def run(enforce_license: false)
       # This component is not supported in ChefDK; an exception will be raised
       # if running in that context.
       verify_not_in_chefdk
@@ -62,7 +62,7 @@ module ChefApply
       start_telemeter_upload
 
       # Launch the actual Chef Apply behavior
-      start_chef_apply
+      start_chef_apply(enforce_license: enforce_license)
 
     # NOTE: Because these exceptions occur outside of the
     #       CLI handling, they won't be tracked in telemtry.
@@ -119,7 +119,7 @@ module ChefApply
     end
 
     def setup_telemetry
-      require "securerandom"
+      require "securerandom" unless defined?(SecureRandom)
       installation_id = SecureRandom.uuid
       File.write(Config.telemetry_installation_identifier_file, installation_id)
 
@@ -130,7 +130,14 @@ module ChefApply
     end
 
     def start_telemeter_upload
-      ChefApply::Telemeter::Sender.start_upload_thread
+      cfg = {
+        enabled: Config.telemetry[:enabled],
+        dev_mode: Config.telemetry[:dev_mode],
+        payload_dir: Config.telemetry_path,
+        installation_identifier_file: Config.telemetry_installation_identifier_file,
+        session_file: Config.telemetry_session_file,
+      }
+      Chef::Telemeter.setup(cfg)
     end
 
     def setup_workstation_user_directories
@@ -187,24 +194,26 @@ module ChefApply
       Chef::Log.level = ChefApply::Log.level
     end
 
-    def start_chef_apply
-      require "chef_apply/cli"
-      ChefApply::CLI.new(@argv).run
+    def start_chef_apply(enforce_license: false)
+      require_relative "cli"
+      ChefApply::CLI.new(@argv).run(enforce_license: enforce_license)
     end
 
     private
 
     def script_path
-      File.expand_path File.dirname(__FILE__)
+      __dir__
     end
 
     class ConfigPathNotProvided < StandardError; end
+
     class ConfigPathInvalid < StandardError
       attr_reader :path
       def initialize(path)
         @path = path
       end
     end
+
     class UnsupportedInstallation < StandardError; end
   end
 end

data/lib/chef_apply/target_host.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require "chef_apply/log"
-require "chef_apply/error"
+require_relative "log"
+require_relative "error"
 require "train"
 
 module ChefApply
@@ -134,10 +134,10 @@ module ChefApply
     def mix_in_target_platform!
       case base_os
       when :linux
-        require "chef_apply/target_host/linux"
+        require_relative "target_host/linux"
         class << self; include ChefApply::TargetHost::Linux; end
       when :windows
-        require "chef_apply/target_host/windows"
+        require_relative "target_host/windows"
         class << self; include ChefApply::TargetHost::Windows; end
       when :other
         raise ChefApply::TargetHost::UnsupportedTargetOS.new(platform.name)
@@ -280,7 +280,7 @@ module ChefApply
     end
 
     def ssh_config_for_host(host)
-      require "net/ssh"
+      require "net/ssh" unless defined?(Net::SSH)
       Net::SSH::Config.for(host)
     end
 
@@ -323,7 +323,9 @@ module ChefApply
         super(*(Array(init_params).flatten))
       end
     end
+
     class ChefNotInstalled < StandardError; end
+
     class UnsupportedTargetOS < ChefApply::ErrorNoLogs
       def initialize(os_name); super("CHEFTARG001", os_name); end
     end

data/lib/chef_apply/target_resolver.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require "chef_apply/target_host"
-require "chef_apply/error"
+require_relative "target_host"
+require_relative "error"
 
 module ChefApply
   class TargetResolver

data/lib/chef_apply/telemeter.rb

@@ -1,5 +1,6 @@
 #
-# Copyright:: Copyright (c) 2018 Chef Software Inc.
+# Copyright:: Copyright (c) 2018-2019 Chef Software Inc.
+# Author:: Marc A. Paradise <marc.paradise@gmail.com>
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,48 +14,14 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-#
-
-require "benchmark"
-require "forwardable"
-require "singleton"
-require "json"
-require "digest/sha1"
-require "securerandom"
-require "chef_apply/version"
-require "chef_apply/config"
-require "yaml"
 
+require "chef/telemeter"
+# Monkey patch the telemetry lib to respect our config.toml
+# entry for telemetry.
+require_relative "telemeter/patch"
 module ChefApply
-
-  # This definites the Telemeter interface. Implementation thoughts for
-  # when we unstub it:
-  # - let's track the call sequence; most of our calls will be nested inside
-  # a main 'timed_capture', and it would be good to see ordering within nested calls.
   class Telemeter
-    include Singleton
-    DEFAULT_INSTALLATION_GUID = "00000000-0000-0000-0000-000000000000".freeze
-
-    class << self
-      extend Forwardable
-      def_delegators :instance, :timed_capture, :capture, :commit, :timed_action_capture, :timed_run_capture
-      def_delegators :instance, :pending_event_count, :last_event, :enabled?
-      def_delegators :instance, :make_event_payload
-    end
-
-    attr_reader :events_to_send, :run_timestamp
-
-    def enabled?
-      require "telemetry/decision"
-      ChefApply::Config.telemetry.enable && !Telemetry::Decision.env_opt_out?
-    end
-
-    def initialize
-      @events_to_send = []
-      @run_timestamp =  Time.now.utc.strftime("%FT%TZ")
-    end
-
-    def timed_action_capture(action, &block)
+    def self.timed_action_capture(action, &block)
       # Note: we do not directly capture hostname for privacy concerns, but
       # using a sha1 digest will allow us to anonymously see
       # unique hosts to derive number of hosts affected by a command
@@ -67,96 +34,11 @@ module ChefApply
         target_data[:hostname_sha1] = Digest::SHA1.hexdigest(target.hostname.downcase)
         target_data[:transport_type] = target.transport_type
       end
-      timed_capture(:action, { action: action.name, target: target_data }, &block)
-    end
-
-    def timed_run_capture(arguments, &block)
-      timed_capture(:run, arguments: arguments, &block)
-    end
-
-    def capture(name, data = {})
-      # Adding it to the head of the list will ensure that the
-      # sequence of events is preserved when we send the final payload
-      payload = make_event_payload(name, data)
-      @events_to_send.unshift payload
+      Chef::Telemeter.timed_capture(:action, { action: action.name, target: target_data }, &block)
     end
 
-    def timed_capture(name, data = {})
-      time = Benchmark.measure { yield }
-      data[:duration] = time.real
-      capture(name, data)
+    def self.capture(name, data = {}, options = {})
+      Chef::Telemeter.capture(name, data, options)
     end
-
-    def commit
-      if enabled?
-        session = convert_events_to_session
-        write_session(session)
-      end
-      @events_to_send = []
-    end
-
-    def make_event_payload(name, data)
-      {
-        event: name,
-        properties: {
-          installation_id: installation_id,
-          run_timestamp: run_timestamp,
-          host_platform: host_platform,
-          event_data: data,
-        },
-      }
-    end
-
-    def installation_id
-      @installation_id ||=
-        begin
-          File.read(ChefApply::Config.telemetry_installation_identifier_file).chomp
-        rescue
-          ChefApply::Log.info "could not read #{ChefApply::Config.telemetry_installation_identifier_file} - using default id"
-          DEFAULT_INSTALLATION_GUID
-        end
-    end
-
-    # For testing.
-    def pending_event_count
-      @events_to_send.length
-    end
-
-    def last_event
-      @events_to_send.last
-    end
-
-    private
-
-    def host_platform
-      @host_platform ||= case RUBY_PLATFORM
-                         when /mswin|mingw|windows/
-                           "windows"
-                         else
-                           RUBY_PLATFORM.split("-")[1]
-                         end
-    end
-
-    def convert_events_to_session
-      YAML.dump({ "version" => ChefApply::VERSION,
-                  "entries" => @events_to_send })
-    end
-
-    def write_session(session)
-      File.write(next_filename, convert_events_to_session)
-    end
-
-    def next_filename
-      id = 0
-      filename = ""
-      loop do
-        id += 1
-        filename = File.join(ChefApply::Config.telemetry_path,
-          "telemetry-payload-#{id}.yml")
-        break unless File.exist?(filename)
-      end
-      filename
-    end
-
   end
 end

data/lib/chef_apply/telemeter/patch.rb

@@ -24,7 +24,7 @@ class Telemetry
   end
 
   def deliver(data = {})
-    if ChefApply::Telemeter.instance.enabled?
+    if Chef::Telemeter.instance.enabled?
       payload = event.prepare(data)
       client.await.fire(payload)
     end

data/lib/chef_apply/text.rb

@@ -16,8 +16,8 @@
 #
 
 require "r18n-desktop"
-require "chef_apply/text/text_wrapper"
-require "chef_apply/text/error_translation"
+require_relative "text/text_wrapper"
+require_relative "text/error_translation"
 
 # A very thin wrapper around R18n, the idea being that we're likely to replace r18n
 # down the road and don't want to have to change all of our commands.

data/lib/chef_apply/ui/error_printer.rb

@@ -16,12 +16,12 @@
 #
 
 require "train/errors"
-require "pastel"
-require "chef_apply/error"
-require "chef_apply/config"
-require "chef_apply/text"
-require "chef_apply/ui/terminal"
-require "chef_apply/errors/standard_error_resolver"
+require "pastel" unless defined?(Pastel)
+require_relative "../error"
+require_relative "../config"
+require_relative "../text"
+require_relative "terminal"
+require_relative "../errors/standard_error_resolver"
 
 module ChefApply::UI
   class ErrorPrinter

data/lib/chef_apply/ui/plain_text_header.rb

@@ -14,8 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require "thread"
-require "chef_apply/ui/plain_text_element"
+require_relative "plain_text_element"
 
 module ChefApply
   module UI

data/lib/chef_apply/ui/terminal.rb

@@ -17,11 +17,11 @@
 
 require "tty-spinner"
 require "tty-cursor"
-require "chef_apply/status_reporter"
-require "chef_apply/config"
-require "chef_apply/log"
-require "chef_apply/ui/plain_text_element"
-require "chef_apply/ui/plain_text_header"
+require_relative "../status_reporter"
+require_relative "../config"
+require_relative "../log"
+require_relative "plain_text_element"
+require_relative "plain_text_header"
 
 module ChefApply
   module UI

data/lib/chef_apply/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefApply
-  VERSION = "0.4.12".freeze
+  VERSION = "0.5.16".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-apply
 version: !ruby/object:Gem::Version
-  version: 0.4.12
+  version: 0.5.16
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -156,76 +156,62 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '16.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '16.0'
 - !ruby/object:Gem::Dependency
   name: chef-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 2.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 2.0.10
 - !ruby/object:Gem::Dependency
   name: chef-telemetry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: license-acceptance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.11
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: Ad-hoc management of individual nodes and devices.
 email:
 - workstation@chef.io
@@ -269,7 +255,6 @@ files:
 - lib/chef_apply/target_resolver.rb
 - lib/chef_apply/telemeter.rb
 - lib/chef_apply/telemeter/patch.rb
-- lib/chef_apply/telemeter/sender.rb
 - lib/chef_apply/text.rb
 - lib/chef_apply/text/error_translation.rb
 - lib/chef_apply/text/text_wrapper.rb
@@ -295,14 +280,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: The ad-hoc execution tool for the Chef ecosystem.

data/lib/chef_apply/telemeter/sender.rb

@@ -1,121 +0,0 @@
-#
-# Copyright:: Copyright (c) 2018 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require "telemetry"
-require "chef_apply/telemeter"
-require "chef_apply/telemeter/patch"
-require "chef_apply/log"
-require "chef_apply/version"
-
-module ChefApply
-  class Telemeter
-    class Sender
-      attr_reader :session_files
-
-      def self.start_upload_thread
-        # Find the files before we spawn the thread - otherwise
-        # we may accidentally pick up the current run's session file if it
-        # finishes before the thread scans for new files
-        session_files = Sender.find_session_files
-        sender = Sender.new(session_files)
-        Thread.new { sender.run }
-      end
-
-      def self.find_session_files
-        ChefApply::Log.info("Looking for telemetry data to submit")
-        session_search = File.join(ChefApply::Config.telemetry_path, "telemetry-payload-*.yml")
-        session_files = Dir.glob(session_search)
-        ChefApply::Log.info("Found #{session_files.length} sessions to submit")
-        session_files
-      end
-
-      def initialize(session_files)
-        @session_files = session_files
-      end
-
-      def run
-        if ChefApply::Telemeter.enabled?
-          ChefApply::Log.info("Telemetry enabled, beginning upload of previous session(s)")
-          # dev mode telemetry gets sent to a different location
-          if ChefApply::Config.telemetry.dev
-            ENV["CHEF_TELEMETRY_ENDPOINT"] ||= "https://telemetry-acceptance.chef.io"
-          end
-          session_files.each { |path| process_session(path) }
-        else
-          # If telemetry is not enabled, just clean up and return. Even though
-          # the telemetry gem will not send if disabled, log output saying that we're submitting
-          # it when it has been disabled can be alarming.
-          ChefApply::Log.info("Telemetry disabled, clearing any existing session captures without sending them.")
-          session_files.each { |path| FileUtils.rm_rf(path) }
-        end
-        FileUtils.rm_rf(ChefApply::Config.telemetry_session_file)
-        ChefApply::Log.info("Terminating, nothing more to do.")
-      rescue => e
-        ChefApply::Log.fatal "Sender thread aborted: '#{e}' failed at  #{e.backtrace[0]}"
-      end
-
-      def process_session(path)
-        ChefApply::Log.info("Processing telemetry entries from #{path}")
-        content = load_and_clear_session(path)
-        submit_session(content)
-      end
-
-      def submit_session(content)
-        # Each file contains the actions taken within a single run of the chef tool.
-        # Each run is one session, so we'll first remove remove the session file
-        # to force creating a new one.
-        FileUtils.rm_rf(ChefApply::Config.telemetry_session_file)
-        # We'll use the version captured in the sesion file
-        entries = content["entries"]
-        cli_version = content["version"]
-        total = entries.length
-        telemetry = Telemetry.new(product: "chef-workstation",
-                                  origin: "command-line",
-                                  product_version: cli_version,
-                                  install_context: "omnibus")
-        total = entries.length
-        entries.each_with_index do |entry, x|
-          submit_entry(telemetry, entry, x + 1, total)
-        end
-      end
-
-      def submit_entry(telemetry, entry, sequence, total)
-        ChefApply::Log.info("Submitting telemetry entry #{sequence}/#{total}: #{entry} ")
-        telemetry.deliver(entry)
-        ChefApply::Log.info("Entry #{sequence}/#{total} submitted.")
-      rescue => e
-        # No error handling in telemetry lib, so at least track the failrue
-        ChefApply::Log.error("Failed to send entry #{sequence}/#{total}: #{e}")
-        ChefApply::Log.error("Backtrace: #{e.backtrace} ")
-      end
-
-      private
-
-      def load_and_clear_session(path)
-        content = File.read(path)
-        # We'll remove it now instead of after we parse or submit it -
-        # if we fail to deliver, we don't want to be stuck resubmitting it if the problem
-        # was due to payload. This is a trade-off - if we get a transient error, the
-        # payload will be lost.
-        # TODO: Improve error handling so we can intelligently decide whether to
-        #       retry a failed load or failed submit.
-        FileUtils.rm_rf(path)
-        YAML.load(content)
-      end
-    end
-  end
-end