chef 16.0.257 → 16.2.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1825ecbde1edecfa8a8bfbebe425f053bf176e06553f2c74bbf7d98a2d213967
-  data.tar.gz: 2f661249cfa4551fe980d52810b4e14bb12c776486dce1687a7ccc378e55e8d5
+  metadata.gz: 6996ed71a2c95519f3ec64ba83fec62bacb6944505504bb8fdd126e4a2f312a5
+  data.tar.gz: ecee3228486fa1cd0618eee10c7e77eac2f1a787e8f601f15391e5dca152e70c
 SHA512:
-  metadata.gz: 34558ba429fea801f67e4296253e7f42cced441fe6304c7529ab8489740494f10f58ef21993508618fa3f67098f3bab2d552ef1dde984b32dbda1f652264e488
-  data.tar.gz: 33acd0f1f9d3707862505e4273f18525657487e9185586d54196c5d3cff9916f5ec37540c2737eabc439a9128ec99ebc759ce21470ed1c6874b4d0741d17f99b
+  metadata.gz: 5f622f40caea4d2fc817252c71918a5bdbc3bb66fb6afd18225c2a65cf29fd12b9449422ea7932f32b56dd66937a8b48d52f4fa37cdb80c831a5305005df50cd
+  data.tar.gz: 58de487e3f809781ea7ce1a9abebaf101f96598aaf1ad6175e28d10a7ca351bccf279fba12b943a232410565e2b36719c34c9bed3055f2b7e39ccc9efd4815a4

data/Gemfile

@@ -22,6 +22,8 @@ end
 
 gem "cheffish", ">= 14"
 
+gem "chef-telemetry", ">=1.0.8" # 1.0.8 removes the http dep
+
 group(:omnibus_package) do
   gem "appbundler"
   gem "rb-readline"
@@ -82,7 +84,7 @@ eval_gemfile("./Gemfile.local") if File.exist?("./Gemfile.local")
 #
 # We copy (and overwrite) these files every time "bundle <exec|install>" is
 # executed, just in case they have changed.
-if RUBY_PLATFORM =~ /mswin|mingw|windows/
+if RUBY_PLATFORM.match?(/mswin|mingw|windows/)
   instance_eval do
     ruby_exe_dir = RbConfig::CONFIG["bindir"]
     assemblies = Dir.glob(File.expand_path("distro/ruby_bin_folder", Dir.pwd) + "/*.dll")

data/README.md

@@ -18,7 +18,7 @@ Chef Infra is a configuration management tool designed to bring automation to yo
 
 ### Want to try Chef Infra?
 
-For Chef Infra usage, please refer to our [Learn Chef Rally](https://learn.chef.io/) website, which includes module-based training for Chef Infra, as well as Automate, Habitat, and InSpec.
+For Chef Infra usage, please refer to [Learn Chef](https://learn.chef.io/), our self-paced, entirely free learning platform. Learn Chef also includes module-based training for Chef Infra, as well as Chef Automate, Chef Habitat, and Chef InSpec.
 
 Other useful resources for Chef Infra users:
 
@@ -26,7 +26,7 @@ Other useful resources for Chef Infra users:
 - Source: <https://github.com/chef/chef/tree/master>
 - Tickets/Issues: <https://github.com/chef/chef/issues>
 - Slack: [Chef Community Slack](https://community-slack.chef.io/)
-- Mailing list: <https://discourse.chef.io>
+- Mailing list/Forum: <https://discourse.chef.io>
 
 ## Reporting Issues
 
@@ -46,7 +46,7 @@ We'd love to have your help developing Chef Infra. See our [Contributing Documen
 
 ## License and Copyright
 
-Copyright 2008-2019, Chef Software, Inc.
+Copyright 2008-2020, Chef Software, Inc.
 
 ```
 Licensed under the Apache License, Version 2.0 (the "License");

data/Rakefile

@@ -17,6 +17,9 @@
 # limitations under the License.
 #
 
+# we need this to resolve files required by lib/chef/dist
+$LOAD_PATH.unshift(File.expand_path("../chef-config/lib", __FILE__))
+
 begin
   require_relative "tasks/rspec"
   require_relative "tasks/dependencies"
@@ -27,26 +30,36 @@ rescue LoadError => e
   puts "Skipping missing rake dep: #{e}"
 end
 
+require "bundler/gem_helper"
+
 ENV["CHEF_LICENSE"] = "accept-no-persist"
 
-# hack the chef-config install to run before the traditional install task
-task :super_install do
-  %w{chef-utils chef-config}.each do |gem|
-    path = ::File.join(::File.dirname(__FILE__), gem)
-    Dir.chdir(path)
-    sh("rake install")
+namespace :pre_install do
+  desc "Runs 'rake install' for the gems that live in subdirectories in this repo"
+  task :install_gems_from_dirs do
+    %w{chef-utils chef-config}.each do |gem|
+      path = ::File.join(::File.dirname(__FILE__), gem)
+      Dir.chdir(path) do
+        sh("rake install")
+      end
+    end
+  end
+
+  desc "Renders the powershell extensions with distro flavoring"
+  task :render_powershell_extension do
+    template_file = ::File.join(::File.dirname(__FILE__), "distro", "templates", "powershell", "chef", "chef.psm1.erb")
+    psm1_path = ::File.join(::File.dirname(__FILE__), "distro", "powershell", "chef")
+    FileUtils.mkdir_p psm1_path
+    template = ERB.new(IO.read(template_file))
+    chef_psm1 = template.result
+    File.open(::File.join(psm1_path, "chef.psm1"), "w") { |f| f.write(chef_psm1) }
   end
 
-# Templating the powershell extensions so we can inject distro constants
-  template_file = ::File.join(::File.dirname(__FILE__), "distro", "templates", "powershell", "chef", "chef.psm1.erb")
-  psm1_path = ::File.join(::File.dirname(__FILE__), "distro", "powershell", "chef")
-  FileUtils.mkdir_p psm1_path
-  template = ERB.new(IO.read(template_file))
-  chef_psm1 = template.result
-  File.open(::File.join(psm1_path, "chef.psm1"), "w") { |f| f.write(chef_psm1) }
+  task all: ["pre_install:install_gems_from_dirs", "pre_install:render_powershell_extension"]
 end
 
-task install: :super_install
+# hack in all the preinstall tasks to occur before the traditional install task
+task install: "pre_install:all"
 
 # make sure we build the correct gemspec on windows
 gemspec = Gem.win_platform? ? "chef-universal-mingw32" : "chef"
@@ -55,8 +68,9 @@ Bundler::GemHelper.install_tasks name: gemspec
 # this gets appended to the normal bundler install helper
 task :install do
   chef_bin_path = ::File.join(::File.dirname(__FILE__), "chef-bin")
-  Dir.chdir(chef_bin_path)
-  sh("rake install:force")
+  Dir.chdir(chef_bin_path) do
+    sh("rake install:force")
+  end
 end
 
 task :pedant, :chef_zero_spec
@@ -94,3 +108,17 @@ begin
 rescue LoadError
   puts "yard is not available. bundle install first to make sure all dependencies are installed."
 end
+
+namespace :spellcheck do
+  task :run do
+    sh 'cspell "**/*"'
+  end
+
+  desc "List the unique unrecognized words in the project."
+  task :unknown_words do
+    sh 'cspell "**/*" --wordsOnly --no-summary | sort | uniq'
+  end
+end
+
+desc "Run spellcheck on the project."
+task spellcheck: "spellcheck:run"

data/chef.gemspec

@@ -28,13 +28,13 @@ Gem::Specification.new do |s|
   s.add_dependency "mixlib-archive", ">= 0.4", "< 2.0"
   s.add_dependency "ohai", "~> 16.0"
 
-  s.add_dependency "ffi", "~> 1.9", ">= 1.9.25"
+  s.add_dependency "ffi", ">= 1.9.25"
   s.add_dependency "ffi-yajl", "~> 2.2"
-  s.add_dependency "net-ssh", ">= 4.2", "< 6"
+  s.add_dependency "net-ssh", ">= 4.2", "< 7"
   s.add_dependency "net-ssh-multi", "~> 1.2", ">= 1.2.1"
-  s.add_dependency "net-sftp", "~> 2.1", ">= 2.1.2"
+  s.add_dependency "net-sftp", ">= 2.1.2", "< 4.0"
   s.add_dependency "ed25519", "~> 1.2" # ed25519 ssh key support
-  s.add_dependency "bcrypt_pbkdf", "~> 1.0" # ed25519 ssh key support
+  s.add_dependency "bcrypt_pbkdf", "= 1.1.0.rc1" # ed25519 ssh key support
   s.add_dependency "highline", ">= 1.6.9", "< 3"
   s.add_dependency "tty-screen", "~> 0.6" # knife list
   s.add_dependency "pastel" # knife ui.color

data/lib/chef/application/apply.rb

@@ -232,8 +232,8 @@ class Chef::Application::Apply < Chef::Application
     Chef::Application.fatal!("#{e.class}: #{e.message}", e)
   end
 
-    # Get this party started
-  def run(enforce_license = false)
+  # Get this party started
+  def run(enforce_license: false)
     reconfigure
     check_license_acceptance if enforce_license
     run_application

data/lib/chef/application/base.rb

@@ -363,7 +363,7 @@ class Chef::Application::Base < Chef::Application
     Chef::Log.trace("Download recipes tarball from #{url} to #{path}")
     if File.exist?(url)
       FileUtils.cp(url, path)
-    elsif url =~ URI.regexp
+    elsif URI.regexp.match?(url)
       File.open(path, "wb") do |f|
         open(url) do |r|
           f.write(r.read)

data/lib/chef/application/client.rb

@@ -39,7 +39,7 @@ class Chef::Application::Client < Chef::Application::Base
       long: "--daemonize [WAIT]",
       description: "Daemonize the process. Accepts an optional integer which is the " \
         "number of seconds to wait before the first daemonized run.",
-      proc: lambda { |wait| wait =~ /^\d+$/ ? wait.to_i : true }
+      proc: lambda { |wait| /^\d+$/.match?(wait) ? wait.to_i : true }
   end
 
   option :pid_file,

data/lib/chef/application/exit_code.rb

@@ -139,8 +139,8 @@ class Chef
         def notify_on_deprecation(message)
           Chef.deprecated(:exit_code, message)
         rescue Chef::Exceptions::DeprecatedFeatureError
-            # Have to rescue this, otherwise this unhandled error preempts
-            # the current exit code assignment.
+          # Have to rescue this, otherwise this unhandled error preempts
+          # the current exit code assignment.
         end
 
         def non_standard_exit_code_warning(exit_code)

data/lib/chef/application/windows_service_manager.rb

@@ -16,7 +16,7 @@
 # limitations under the License.
 #
 
-if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+if RUBY_PLATFORM.match?(/mswin|mingw32|windows/)
   require "win32/service"
 end
 require_relative "../config"

data/lib/chef/chef_fs/chef_fs_data_store.rb

@@ -204,7 +204,7 @@ class Chef
           @memory_store.create(path, name, data, *options)
 
         elsif path[0] == "cookbooks" && path.length == 2
-          # Do nothing.  The entry gets created when the cookbook is created.
+        # Do nothing.  The entry gets created when the cookbook is created.
 
         # /policy_groups/GROUP/policies/NAME
         elsif path[0] == "policy_groups" && path[2] == "policies"
@@ -724,8 +724,8 @@ class Chef
             path[-1] = "#{path[-1]}.json"
           end
 
-          # /acls/containers|nodes|... do NOT drop into the next elsif, and do
-          # not get .json appended
+        # /acls/containers|nodes|... do NOT drop into the next elsif, and do
+        # not get .json appended
 
         # /nodes|clients|.../x.json
         elsif path.length == 2

data/lib/chef/chef_fs/data_handler/data_bag_item_data_handler.rb

@@ -55,7 +55,7 @@ class Chef
           base_name = remove_dot_json(entry.name)
           if object["raw_data"]["id"] != base_name
             yield("ID in #{entry.path_for_printing} must be '#{base_name}' (is '#{object["raw_data"]["id"]}')")
-          elsif entry.parent.name =~ RESERVED_NAMES
+          elsif RESERVED_NAMES.match?(entry.parent.name)
             yield("Data bag name ('#{entry.parent.name}') must not match #{RESERVED_NAMES.inspect}")
           end
         end

data/lib/chef/chef_fs/file_system/chef_server/acls_dir.rb

@@ -60,7 +60,7 @@ class Chef
                   AclDir.new(entity_type, self)
                 end
               end
-              @children << AclEntry.new("organization.json", self, true) # the org acl is retrieved as GET /organizations/ORGNAME/ANYTHINGATALL/_acl
+              @children << AclEntry.new("organization.json", self, true) # the org acl is retrieved as GET /organizations/ORGNAME/ANYTHING/_acl
             end
             @children
           end

data/lib/chef/chef_fs/file_system/chef_server/cookbook_file.rb

@@ -69,7 +69,7 @@ class Chef
           private
 
           def calc_checksum(value)
-            OpenSSL::Digest::MD5.hexdigest(value)
+            OpenSSL::Digest.hexdigest("MD5", value)
           end
         end
       end

data/lib/chef/chef_fs/file_system/chef_server/policies_dir.rb

@@ -66,7 +66,7 @@ class Chef
           #   }
           # }
           def children
-              # Grab the names of the children, append json, and make child entries
+            # Grab the names of the children, append json, and make child entries
             @children ||= begin
               result = []
               data = root.get_json(api_path)

data/lib/chef/chef_fs/file_system/chef_server/rest_list_dir.rb

@@ -71,7 +71,7 @@ class Chef
           # Children are foo.json and bar.json in this case.
           #
           def children
-              # Grab the names of the children, append json, and make child entries
+            # Grab the names of the children, append json, and make child entries
             @children ||= root.get_json(api_path).keys.sort.map do |key|
               make_child_entry(key, true)
             end

data/lib/chef/chef_fs/file_system/multiplexed_dir.rb

@@ -19,7 +19,7 @@ class Chef
         def children
           result = []
           seen = {}
-            # If multiple things have the same name, the first one wins.
+          # If multiple things have the same name, the first one wins.
           multiplexed_dirs.each do |dir|
             dir.children.each do |child|
               if seen[child.name]

data/lib/chef/chef_fs/file_system/repository/directory.rb

@@ -104,7 +104,7 @@ class Chef
             children.empty?
           end
 
-          # Public API callied by chef_fs/file_system
+          # Public API called by chef_fs/file_system
           def child(name)
             possible_child = make_child_entry(name)
             if possible_child.name_valid?

data/lib/chef/chef_fs/parallelizer/parallel_enumerable.rb

@@ -235,7 +235,7 @@ class Chef
         # The order of these checks is important, as well, to be thread safe.
         # 1. If @unconsumed_input.empty? is true, then we will never have any more
         # work legitimately picked up.
-        # 2. If @in_process == 0, then there is no work in process, and because ofwhen unconsumed_input is empty, it will never go back up, because
+        # 2. If @in_process == 0, then there is no work in process, and because of when unconsumed_input is empty, it will never go back up, because
         # this is called after the input enumerator is finished.  Note that switching #2 and #1
         # could cause a race, because in_process is incremented *before* consuming input.
         # 3. If @unconsumed_output.empty? is true, then we are done with outputs.

data/lib/chef/chef_fs/path_utils.rb

@@ -71,9 +71,9 @@ class Chef
       # part that actually exists.  The paths operated on here are not Chef-FS paths.
       # These are OS paths that may contain symlinks but may not also fully exist.
       #
-      # If /x is a symlink to /blarghle, and has no subdirectories, then:
-      # PathUtils.realest_path('/x/y/z') == '/blarghle/y/z'
-      # PathUtils.realest_path('/x/*/z') == '/blarghle/*/z'
+      # If /x is a symlink to /foo_bar, and has no subdirectories, then:
+      # PathUtils.realest_path('/x/y/z') == '/foo_bar/y/z'
+      # PathUtils.realest_path('/x/*/z') == '/foo_bar/*/z'
       # PathUtils.realest_path('/*/y/z') == '/*/y/z'
       #
       # TODO: Move this to wherever util/path_helper is these days.
@@ -118,7 +118,7 @@ class Chef
 
         if ancestor.length == path.length
           ""
-        elsif path[ancestor.length, 1] =~ /#{PathUtils.regexp_path_separator}/
+        elsif /#{PathUtils.regexp_path_separator}/.match?(path[ancestor.length, 1])
           path[ancestor.length + 1..-1]
         else
           nil

data/lib/chef/cookbook/chefignore.rb

@@ -50,7 +50,7 @@ class Chef
         ignore_globs = []
         if @ignore_file && readable_file_or_symlink?(@ignore_file)
           File.foreach(@ignore_file) do |line|
-            ignore_globs << line.strip unless line =~ COMMENTS_AND_WHITESPACE
+            ignore_globs << line.strip unless COMMENTS_AND_WHITESPACE.match?(line)
           end
         else
           Chef::Log.debug("No chefignore file found. No files will be ignored!")

data/lib/chef/cookbook/file_system_file_vendor.rb

@@ -27,7 +27,7 @@ class Chef
     # and throws the rest away then re-builds the list of files on the
     # disk. This is due to the manifest not having the on-disk file
     # locations, since in the chef-client case, that information is
-    # non-sensical.
+    # nonsensical.
     class FileSystemFileVendor < FileVendor
 
       attr_reader :cookbook_name

data/lib/chef/cookbook/metadata.rb

@@ -357,7 +357,7 @@ class Chef
       # Array<String> - array of files or globs to eagerly load, otherwise it is treated like `false`
       #
       # @params arg [Array,String,TrueClass,FalseClass]
-      # @params [Array,TrueClass,FalseCalss]
+      # @params [Array,TrueClass,FalseClass]
       def eager_load_libraries(arg = nil)
         set_or_return(
           :eager_load_libraries,
@@ -391,7 +391,7 @@ class Chef
       def recipes_from_cookbook_version(cookbook)
         cookbook.fully_qualified_recipe_names.map do |recipe_name|
           unqualified_name =
-            if recipe_name =~ /::default$/
+            if /::default$/.match?(recipe_name)
               name.to_s
             else
               recipe_name

data/lib/chef/cookbook_loader.rb

@@ -138,7 +138,7 @@ class Chef
       cookbooks_by_name.values
     end
 
-    # This method creates tmp directory and copies all cookbooks into it and creates cookbook loder object which points to tmp directory
+    # This method creates tmp directory and copies all cookbooks into it and creates cookbook loader object which points to tmp directory
     def self.copy_to_tmp_dir_from_array(cookbooks)
       tmp_cookbook_file = Tempfile.new("tmp_working_dir_path")
       tmp_cookbook_file.close

data/lib/chef/cookbook_manifest.rb

@@ -44,7 +44,7 @@ class Chef
     # cookbook_version in the "manifest" format, or #to_json to get a JSON
     # representation of the cookbook_version.
     #
-    # The inferface for this behavior is expected to change as we implement new
+    # The interface for this behavior is expected to change as we implement new
     # manifest formats. The entire class should be considered a private API for
     # now.
     #

data/lib/chef/cookbook_site_streaming_uploader.rb

@@ -147,7 +147,7 @@ class Chef
         class << res
           alias :to_s :body
 
-          # BUGBUG this makes the response compatible with what respsonse_steps expects to test headers (response.headers[] -> response[])
+          # BUG this makes the response compatible with what response_steps expects to test headers (response.headers[] -> response[])
           def headers # rubocop:disable Lint/NestedMethodDefinition
             self
           end

data/lib/chef/cookbook_version.rb

@@ -358,10 +358,10 @@ class Chef
 
         # extract the preference part from the path.
         if manifest_record_path =~ %r{(#{Regexp.escape(segment.to_s)}/[^/]+/#{Regexp.escape(dirname)})/.+$}
-            # Note the specificy_dirname includes the segment and
-            # dirname argument as above, which is what
-            # preferences_for_path returns. It could be
-            # "files/ubuntu-9.10/dirname", for example.
+          # Note the specificity_dirname includes the segment and
+          # dirname argument as above, which is what
+          # preferences_for_path returns. It could be
+          # "files/ubuntu-9.10/dirname", for example.
           specificity_dirname = $1
 
           # Record the specificity_dirname only if it's in the list of
@@ -392,7 +392,7 @@ class Chef
                                    platform, version = Chef::Platform.find_platform_and_version(node)
                                  rescue ArgumentError => e
                                    # Skip platform/version if they were not found by find_platform_and_version
-                                   if e.message =~ /Cannot find a (?:platform|version)/
+                                   if /Cannot find a (?:platform|version)/.match?(e.message)
                                      platform = "/unknown_platform/"
                                      version = "/unknown_platform_version/"
                                    else
@@ -527,7 +527,7 @@ class Chef
         cb["version"]
       end
     rescue Net::HTTPClientException => e
-      if e.to_s =~ /^404/
+      if /^404/.match?(e.to_s)
         Chef::Log.error("Cannot find a cookbook named #{cookbook_name}")
         nil
       else
@@ -566,7 +566,7 @@ class Chef
     def find_preferred_manifest_record(node, segment, filename)
       preferences = preferences_for_path(node, segment, filename)
 
-      # in order of prefernce, look for the filename in the manifest
+      # in order of preference, look for the filename in the manifest
       preferences.find { |preferred_filename| manifest_records_by_path[preferred_filename] }
     end