chef-cli 1.0.14 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86cf14e43550aba70dc825275b3a3a6b86513da7d550a0bc610175a769d53d56
-  data.tar.gz: 3fc61ee5fcd4aaa816d370840383e078a5597d8d7cb71fdcf57390758ba380d1
+  metadata.gz: d8ef75d64aed76476f1ca99d5e36ebba9d39f408dd2a7dfc842929e0b74e6b44
+  data.tar.gz: 246b506ff8bae1577ffdeac5888f26d94fa45223fe02c0236d82d2ab0cfed326
 SHA512:
-  metadata.gz: 87b2f14824b5c4e2f75a2e570434d5b52db36e8bd49b074857fec624240cf099c16cb8ea57ce8bffc81aca9843e3fe2647662d99d52438964008fc4e05b0b6b4
-  data.tar.gz: 7022751ac3061e3823180c51b2e3288970e0666d6a11dbf9c0d28e5b472860637fe44e7f3cb67d0453146c280fcfb369d0b87be7a0c48bf8fb57014c9c54c76b
+  metadata.gz: a2105386dd0b2fd89e09e9ba027c3da1b2557cb3cb5ff1a655215d936e5224034ded81d07e08f65c5971228b7391277e9ecf7ebaafd46933de16fe105882c68a
+  data.tar.gz: 9ba7a7cd5f85f3e577710621f701f266750e25ac24383ef688f821599642fa7b61e25bb3ff6f0fc7ef88a75a981269449e5c6b675852aca91b936210c51f05bf

data/Gemfile

@@ -9,17 +9,12 @@ group :docs do
 end
 
 group :test do
-  # For ruby 2.4 testing we need to use ohai 14
-  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5")
-    gem "ohai", "~> 14"
-  end
   gem "rake"
   gem "rspec", "~> 3.8"
   gem "rspec-expectations", "~> 3.8"
   gem "rspec-mocks", "~> 3.8"
   gem "cookstyle"
   gem "chefstyle"
-  gem "foodcritic"
 end
 
 group :development do
@@ -28,9 +23,3 @@ group :development do
   gem "pry-stack_explorer"
   gem "rb-readline"
 end
-
-instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
-
-# If you want to load debugging tools into the bundle exec sandbox,
-# add these additional dependencies into Gemfile.local
-eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/Rakefile

@@ -51,20 +51,4 @@ namespace :style do
   rescue LoadError => e
     puts ">>> Gem load error: #{e}, omitting #{task.name}" unless ENV["CI"]
   end
-
-  begin
-    require "foodcritic"
-
-    desc "Run Chef Cookbook (Foodcritic) style checks"
-    FoodCritic::Rake::LintTask.new(:foodcritic) do |t|
-      t.options = {
-        fail_tags: ["any"],
-        tags: ["~FC071", "~supermarket", "~FC031"],
-        cookbook_paths: ["lib/chef-cli/skeletons/code_generator"],
-        progress: true,
-      }
-    end
-  rescue LoadError => e
-    puts ">>> Gem load error: #{e}, omitting #{task.name}" unless ENV["CI"]
-  end
 end

data/chef-cli.gemspec

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2019, 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");
@@ -29,13 +29,13 @@ Gem::Specification.new do |gem|
   gem.license       = "Apache-2.0"
   gem.homepage      = "https://www.chef.io/"
 
-  gem.required_ruby_version = ">= 2.4"
+  gem.required_ruby_version = ">= 2.7"
 
   gem.files = %w{Rakefile LICENSE} +
     Dir.glob("Gemfile*") + # Includes Gemfile and locks
     Dir.glob("*.gemspec") +
     Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
-  gem.executables   = %w{ chef }
+  gem.executables   = %w{ chef-cli }
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ["lib"]
 
@@ -43,11 +43,12 @@ Gem::Specification.new do |gem|
   gem.add_dependency "mixlib-shellout", ">= 2.0", "< 4.0"
   gem.add_dependency "ffi-yajl", ">= 1.0", "< 3.0"
   gem.add_dependency "minitar", "~> 0.6"
-  gem.add_dependency "chef", ">= 14.0"
+  gem.add_dependency "chef", ">= 15.0"
   gem.add_dependency "solve", "< 5.0", "> 2.0"
-  gem.add_dependency "addressable", ">= 2.3.5", "< 2.6"
+  gem.add_dependency "addressable", ">= 2.3.5", "< 2.8"
   gem.add_dependency "cookbook-omnifetch", "~> 0.5"
   gem.add_dependency "diff-lcs", "~> 1.0"
-  gem.add_dependency "paint", "~> 1.0"
+  gem.add_dependency "paint", ">= 1", "< 3"
   gem.add_dependency "license-acceptance", "~> 1.0", ">= 1.0.11"
+  gem.add_development_dependency "test-kitchen", "> 2.5"
 end

data/lib/chef-cli/cli.rb

@@ -34,9 +34,9 @@ module ChefCLI
 
     banner(<<~BANNER)
       Usage:
-          chef -h/--help
-          chef -v/--version
-          chef command [arguments...] [options...]
+          #{ChefCLI::Dist::EXEC} -h/--help
+          #{ChefCLI::Dist::EXEC} -v/--version
+          #{ChefCLI::Dist::EXEC} command [arguments...] [options...]
     BANNER
 
     option :version,
@@ -105,9 +105,9 @@ module ChefCLI
 
     def show_version_via_version_manifest
       msg("#{ChefCLI::Dist::PRODUCT} version: #{manifest_field("build_version")}")
-      { "#{ChefCLI::Dist::INFRA_CLIENT_PRODUCT}": "chef",
+      { "#{ChefCLI::Dist::INFRA_CLIENT_PRODUCT}": "#{ChefCLI::Dist::INFRA_CLIENT_GEM}",
         "#{ChefCLI::Dist::INSPEC_PRODUCT}": "#{ChefCLI::Dist::INSPEC_CLI}",
-        "Chef CLI": "chef-cli",
+        "#{ChefCLI::Dist::CLI_PRODUCT}": "#{ChefCLI::Dist::CLI_GEM}",
         "Test Kitchen": "test-kitchen",
         "Cookstyle": "cookstyle",
       }.each do |name, gem|
@@ -122,7 +122,7 @@ module ChefCLI
         "Test Kitchen": "kitchen",
         "Cookstyle": "cookstyle",
       }.each do |name, cli|
-        result = Bundler.with_clean_env { shell_out("#{cli} --version") }
+        result = Bundler.with_unbundled_env { shell_out("#{cli} --version") }
         if result.exitstatus != 0
           msg("#{name} version: ERROR")
         else

data/lib/chef-cli/command/clean_policy_cookbooks.rb

@@ -37,7 +37,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 

data/lib/chef-cli/command/clean_policy_revisions.rb

@@ -36,7 +36,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 

data/lib/chef-cli/command/delete_policy.rb

@@ -36,7 +36,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 

data/lib/chef-cli/command/delete_policy_group.rb

@@ -36,7 +36,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 

data/lib/chef-cli/command/describe_cookbook.rb

@@ -87,7 +87,7 @@ module ChefCLI
         remaining_args = parse_options(params)
         if remaining_args.size != 1
           ui.err(opt_parser)
-          return false
+          false
         else
           @cookbook_path = File.expand_path(remaining_args.first)
           true

data/lib/chef-cli/command/export.rb

@@ -41,7 +41,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 

data/lib/chef-cli/command/generator_commands/cookbook.rb

@@ -216,7 +216,7 @@ module ChefCLI
           if !@cookbook_name_or_path
             @params_valid = false
           elsif /-/ =~ File.basename(@cookbook_name_or_path)
-            msg("Hyphens are discouraged in cookbook names as they may cause problems with custom resources. See https://docs.chef.io/ctl_chef.html#chef-generate-cookbook for more information.")
+            msg("Hyphens are discouraged in cookbook names as they may cause problems with custom resources. See https://docs.chef.io/ctl_chef/#chef-generate-cookbook for more information.")
           end
 
           if config[:berks] && config[:policy]

data/lib/chef-cli/command/generator_commands/generator_generator.rb

@@ -111,7 +111,6 @@ module ChefCLI
           <<~METADATA
             name             '#{cookbook_name}'
             description      'Custom code generator cookbook for use with #{ChefCLI::Dist::PRODUCT}'
-            long_description 'Custom code generator cookbook for use with #{ChefCLI::Dist::PRODUCT}'
             version          '0.1.0'
 
           METADATA

data/lib/chef-cli/command/generator_commands/policyfile.rb

@@ -76,7 +76,7 @@ module ChefCLI
             if chef_repo_mode?
               err("ERROR: You must give a policy name when generating a policy in a chef-repo.")
               @params_valid = false
-              return false
+              false
             else
               use_default_policy_settings
             end
@@ -85,7 +85,7 @@ module ChefCLI
           else
             @params_valid = false
             err("ERROR: too many arguments")
-            return false
+            false
           end
         end
 

data/lib/chef-cli/command/install.rb

@@ -40,7 +40,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 
@@ -110,7 +110,7 @@ module ChefCLI
         remaining_args = parse_options(params)
         if remaining_args.size > 1
           ui.err(opt_parser)
-          return false
+          false
         else
           @policyfile_relative_path = remaining_args.first
           true

data/lib/chef-cli/command/push.rb

@@ -38,7 +38,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 

data/lib/chef-cli/command/push_archive.rb

@@ -38,7 +38,7 @@ module ChefCLI
 
         For more information about Policyfiles, see our detailed README:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
       E

data/lib/chef-cli/command/show_policy.rb

@@ -40,7 +40,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 

data/lib/chef-cli/command/undelete.rb

@@ -47,7 +47,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 

data/lib/chef-cli/command/update.rb

@@ -43,7 +43,7 @@ module ChefCLI
 
         See our detailed README for more information:
 
-        https://docs.chef.io/policyfile.html
+        https://docs.chef.io/policyfile/
 
         Options:
 

data/lib/chef-cli/dist.rb

@@ -4,6 +4,11 @@ module ChefCLI
 
     # The full marketing name of the product
     PRODUCT = "Chef Workstation".freeze
+    PRODUCT_PKG_HOME = "chef-workstation".freeze
+
+    # the name of the chef-cli gem
+    CLI_PRODUCT = "Chef CLI".freeze
+    CLI_GEM = "chef-cli".freeze
 
     # the name of the overall infra product
     INFRA_PRODUCT = "Chef Infra".freeze
@@ -14,6 +19,9 @@ module ChefCLI
     # The client's alias (chef-client)
     INFRA_CLIENT_CLI = "chef-client".freeze
 
+    # The client's gem
+    INFRA_CLIENT_GEM = "chef".freeze
+
     INSPEC_PRODUCT = "Chef InSpec".freeze
     INSPEC_CLI = "inspec".freeze
 

data/lib/chef-cli/generator.rb

@@ -150,7 +150,7 @@ module ChefCLI
             along with this program.  If not, see <http://www.gnu.org/licenses/>.
           EOH
         else
-          raise ArgumentError, "Invalid generator.license setting: #{license}.  See available licenses at https://docs.chef.io/ctl_chef.html#chef-generate-cookbook"
+          raise ArgumentError, "Invalid generator.license setting: #{license}. See available licenses at https://docs.chef.io/ctl_chef/#chef-generate-cookbook"
         end
         if comment
           # Ensure there's no trailing whitespace

data/lib/chef-cli/helpers.rb

@@ -141,9 +141,9 @@ module ChefCLI
 
     def default_package_home
       if Chef::Platform.windows?
-        File.join(ENV["LOCALAPPDATA"], "chef-workstation")
+        File.join(ENV["LOCALAPPDATA"], "#{ChefCLI::Dist::PRODUCT_PKG_HOME}")
       else
-        File.expand_path("~/.chef-workstation")
+        File.expand_path("~/.#{ChefCLI::Dist::PRODUCT_PKG_HOME}")
       end
     end
 

data/lib/chef-cli/policyfile/cookbook_location_specification.rb

@@ -125,7 +125,8 @@ module ChefCLI
 
       def cookbook_has_recipe?(recipe_name)
         expected_path = cookbook_path.join("recipes/#{recipe_name}.rb")
-        expected_path.exist?
+        expected_path_yml = cookbook_path.join("recipes/#{recipe_name}.yml")
+        expected_path.exist? || expected_path_yml.exist?
       end
 
       def cached_cookbook

data/lib/chef-cli/policyfile/lock_fetcher_mixin.rb

@@ -24,9 +24,9 @@ module ChefCLI
         expected_id = source_options[:policy_revision_id]
         if expected_id
           if included_id.eql?(expected_id) # are they the same?
-            return
+            nil
           elsif included_id[0, 10].eql?(expected_id) # did they use the 10 char substring
-            return
+            nil
           else
             raise ChefCLI::InvalidLockfile, "Expected policy_revision_id '#{expected_id}' does not match included_policy '#{included_id}'."
           end

data/lib/chef-cli/policyfile/uploader.rb

@@ -79,7 +79,7 @@ module ChefCLI
 
       def data_bag_create
         http_client.post("data", { "name" => COMPAT_MODE_DATA_BAG_NAME })
-      rescue Net::HTTPServerException => e
+      rescue Net::HTTPClientException => e
         raise e unless e.response.code == "409"
       end
 
@@ -214,7 +214,7 @@ module ChefCLI
 
       def upload_lockfile_as_data_bag_item(policy_id, data_item)
         http_client.put("data/#{COMPAT_MODE_DATA_BAG_NAME}/#{policy_id}", data_item)
-      rescue Net::HTTPServerException => e
+      rescue Net::HTTPClientException => e
         raise e unless e.response.code == "404"
 
         http_client.post("data/#{COMPAT_MODE_DATA_BAG_NAME}", data_item)

data/lib/chef-cli/policyfile_services/export_repo.rb

@@ -44,12 +44,14 @@ module ChefCLI
       attr_reader :storage_config
       attr_reader :root_dir
       attr_reader :export_dir
+      attr_reader :ui
 
       def initialize(policyfile: nil, export_dir: nil, root_dir: nil, archive: false, force: false)
         @root_dir = root_dir
         @export_dir = File.expand_path(export_dir)
         @archive = archive
         @force_export = force
+        @ui = UI.new
 
         @policy_data = nil
         @policyfile_lock = nil
@@ -162,6 +164,9 @@ module ChefCLI
         FileUtils.mkdir(export_path) unless File.directory?(export_path)
         copy_unignored_cookbook_files(lock, export_path)
         FileUtils.rm_f(metadata_rb_path)
+        if lock.cookbook_version.nil?
+          ui.msg "Unable to get the cookbook version/metadata for #{lock}"
+        end
         metadata = lock.cookbook_version.metadata
 
         metadata_json_path = File.join(export_path, "metadata.json")

data/lib/chef-cli/policyfile_services/install.rb

@@ -147,8 +147,10 @@ module ChefCLI
       end
 
       def prepare_constraints_for_policies
+        # Ensure we recompute policies from their (possibly updated) source
         Policyfile::LockApplier
           .new(policyfile_lock, policyfile_compiler)
+          .with_unlocked_policies(:all)
           .apply!
       end
 

data/lib/chef-cli/policyfile_services/rm_policy.rb

@@ -134,7 +134,7 @@ module ChefCLI
       def fetch_policy_revision_data
         @policy_revision_data = http_client.get("/policies/#{policy_name}")
         @policy_exists = true
-      rescue Net::HTTPServerException => e
+      rescue Net::HTTPClientException => e
         raise unless e.response.code == "404"
 
         @policy_exists = false

data/lib/chef-cli/policyfile_services/update_attributes.rb

@@ -102,7 +102,9 @@ module ChefCLI
       end
 
       def prepare_constraints
+        # Ensure we recompute policies from their (possibly updated) source
         Policyfile::LockApplier.new(policyfile_lock, policyfile_compiler)
+          .with_unlocked_policies(:all)
           .apply!
       end
     end

data/lib/chef-cli/skeletons/code_generator/files/default/build_cookbook/README.md

@@ -101,7 +101,7 @@ cd .delivery/build_cookbook
 kitchen converge
 ```
 
-This will take awhile because it will now pass on the first VM, and then create the second VM. We should have warned you this was a good time for a coffee break.
+This will take a while because it will now pass on the first VM and then create the second VM. We should have warned you this was a good time for a coffee break.
 
 ```
 Recipe: test::default
@@ -115,7 +115,7 @@ Recipe: test::default
 Running handlers:
 Running handlers complete
 Chef Infra Client finished, 3/32 resources updated in 54.665445968 seconds
-Finished converging <default-centos-71> (1m26.83s).
+Finished converging <default-centos-8> (1m26.83s).
 ```
 
 Victory is ours! Our verify phase passed on the build nodes.
@@ -129,7 +129,7 @@ delivery review
 
 ## FAQ
 
-### Why don't I just run rspec and foodcritic/rubocop on my local system?
+### Why don't I just run rspec and cookstyle on my local system?
 
 An objection to the Test Kitchen approach is that it is much faster to run the unit, lint, and syntax commands for the project on the local system. That is totally true, and also totally valid. Do that for the really fast feedback loop. However, the dance we do with Test Kitchen brings a much higher degree of confidence in the changes we're making, that everything will run on the build nodes in Chef Workflow. We strongly encourage this approach before actually pushing the changes to Workflow.