chef-cli 3.0.1 → 3.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adb138942d756bfa17638b7ba9308e77730ba9b77bb505821d68ee9b7cdc3d2c
-  data.tar.gz: 4b9d246fe278ec0d4f230d6694e30c64dae2a6b426e4b5020639dc01d0401e98
+  metadata.gz: b8a428266246dc22388ebf2714824965912bf1b17fa657bc9ffab99fef6f0a88
+  data.tar.gz: aed196c6c1cae0d61a877e6916d5514313c0b186faae75598402fcacfee0c756
 SHA512:
-  metadata.gz: 32d8f2e150ff38eefdb26b17fa2b5eda415c697df4324aa3e63ef9545646a346388e4c985cee379773d4311b0421228fbfcb5a8adf3750bbc40a64882a6aacd7
-  data.tar.gz: 3a455461956da321300c610c56d78d594b789474017807d0c986dabdd45541e1260b123f838d52e179247f2e6ab4ec911dc7e09ba611c3855dd2b9b4a4cbc4fb
+  metadata.gz: 343ec04d69d8133e65d887f5e71ab53416ba2a09013df8f530ba70cb2d2f6dcc9b60c8b9ea4c3e445e9a223175681c5d61babc9339ef381483707219d0f5cf71
+  data.tar.gz: b1fe61b9c04025de73c654d0c7bd65033a34935198ba53a68a921eb1bf1f2c1d4c7c30e55ee45eb4168e304402f3412fc30e47f8230af22d9c4f802b424a280e

data/Gemfile

@@ -15,11 +15,16 @@ group :test do
   gem "rspec-mocks", "~> 3.8"
   gem "cookstyle"
   gem "chefstyle"
+  gem "test-kitchen", "> 2.5"
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.6")
+    gem "chef-zero", "~> 14"
+    gem "chef", "~> 15"
+  end
 end
 
 group :development do
   gem "pry"
   gem "pry-byebug"
-  gem "pry-stack_explorer"
+  gem "pry-stack_explorer", "~> 0.4.0"
   gem "rb-readline"
 end

data/chef-cli.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |gem|
   gem.license       = "Apache-2.0"
   gem.homepage      = "https://www.chef.io/"
 
-  gem.required_ruby_version = ">= 2.6"
+  gem.required_ruby_version = ">= 2.5"
 
   gem.files = %w{Rakefile LICENSE} +
     Dir.glob("Gemfile*") + # Includes Gemfile and locks
@@ -47,7 +47,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "solve", "< 5.0", "> 2.0"
   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 "diff-lcs", ">= 1.0", "< 1.4" # 1.4 changes the output
   gem.add_dependency "paint", ">= 1", "< 3"
   gem.add_dependency "license-acceptance", "~> 1.0", ">= 1.0.11"
 end

data/lib/chef-cli/cli.rb

@@ -122,7 +122,13 @@ module ChefCLI
         "Test Kitchen": "kitchen",
         "Cookstyle": "cookstyle",
       }.each do |name, cli|
-        result = Bundler.with_clean_env { shell_out("#{cli} --version") }
+        # @todo when Ruby 2.5/2.6 support goes away this if statement can go away
+        if Gem::Version.new(Bundler::VERSION) >= Gem::Version.new("2")
+          result = Bundler.with_unbundled_env { shell_out("#{cli} --version") }
+        else
+          result = Bundler.with_clean_env { shell_out("#{cli} --version") }
+        end
+
         if result.exitstatus != 0
           msg("#{name} version: ERROR")
         else

data/lib/chef-cli/command/generator_commands/chef_exts/generator_desc_resource.rb

@@ -28,6 +28,7 @@ module ChefCLI
     # takes to create a cookbook.
     class GeneratorDesc < Chef::Resource
       resource_name :generator_desc
+      provides :generator_desc
 
       property :message, String, name_property: true
 

data/lib/chef-cli/skeletons/code_generator/files/default/chefignore

@@ -9,10 +9,7 @@ ehthumbs.db
 Icon?
 nohup.out
 Thumbs.db
-
-# SASS #
-########
-.sass-cache
+.envrc
 
 # EDITORS #
 ###########
@@ -26,11 +23,11 @@ Thumbs.db
 *.tmproj
 *~
 \#*
-mkmf.log
 REVISION
 TAGS*
 tmtags
 .vscode
+.editorconfig
 
 ## COMPILED ##
 ##############
@@ -43,27 +40,32 @@ tmtags
 *.so
 */rdoc/
 a.out
+mkmf.log
 
 # Testing #
 ###########
 .circleci/*
 .codeclimate.yml
+.delivery/*
 .foodcritic
 .kitchen*
+.mdlrc
+.overcommit.yml
 .rspec
 .rubocop.yml
 .travis.yml
 .watchr
+.yamllint
 azure-pipelines.yml
+Dangerfile
 examples/*
 features/*
 Guardfile
 kitchen.yml*
+mlc_config.json
 Procfile
 Rakefile
 spec/*
-spec/*
-spec/fixtures/*
 test/*
 
 # SCM #
@@ -73,6 +75,7 @@ test/*
 .gitconfig
 .github/*
 .gitignore
+.gitkeep
 .gitmodules
 .svn
 */.bzr/*
@@ -100,10 +103,11 @@ Policyfile.lock.json
 
 # Documentation #
 #############
-CHANGELOG*
+CODE_OF_CONDUCT*
 CONTRIBUTING*
+documentation/*
 TESTING*
-CODE_OF_CONDUCT*
+UPGRADING*
 
 # Vagrant #
 ###########

data/lib/chef-cli/skeletons/code_generator/metadata.rb

@@ -4,4 +4,4 @@ maintainer_email 'dev@chef.io'
 license          'Apache-2.0'
 description      'Generates Chef code for Chef CLI'
 version          '0.1.0'
-chef_version     '>= 14.0'
+chef_version     '>= 15.0'

data/lib/chef-cli/skeletons/code_generator/templates/default/build_cookbook/metadata.rb.erb

@@ -3,7 +3,7 @@ maintainer '<%= copyright_holder %>'
 maintainer_email '<%= email %>'
 license '<%= license %>'
 version '0.1.0'
-chef_version '>= 14.0'
+chef_version '>= 15.0'
 <% if build_cookbook_parent_is_cookbook -%>
 
 depends 'delivery-truck'

data/lib/chef-cli/skeletons/code_generator/templates/default/metadata.rb.erb

@@ -4,7 +4,7 @@ maintainer_email '<%= email %>'
 license '<%= @spdx_license %>'
 description 'Installs/Configures <%= cookbook_name %>'
 version '0.1.0'
-chef_version '>= 14.0'
+chef_version '>= 15.0'
 
 # The `issues_url` points to the location where issues for this cookbook are
 # tracked.  A `View Issues` link will be displayed on this cookbook's page when

data/lib/chef-cli/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefCLI
-  VERSION = "3.0.1".freeze
+  VERSION = "3.0.11".freeze
 end

data/lib/kitchen/provisioner/chef_zero_capture.rb

@@ -0,0 +1,90 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Marc Paradise <marc@chef.io>
+#
+# Copyright (C) 2020, Chef Software Inc
+#
+# 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 "json"
+require "kitchen"
+require "kitchen/provisioner/base"
+require "kitchen/provisioner/chef_zero"
+
+module Kitchen
+  module Provisioner
+    # For use in a provisioner that does not do any run list evaluation or
+    # policy/berks file expansion.
+    class ChefZeroCaptureSandbox < Chef::CommonSandbox
+      def populate
+        super
+        prepare(:policies)
+        prepare(:policy_groups)
+        prepare(:cookbook_artifacts)
+      end
+
+      # Override #prepare_cookbooks because we don't want any cookbook resolving to occur
+      # via kitchen through berks, policy
+      def prepare_cookbooks
+        cp_cookbooks
+        filter_only_cookbook_files
+      end
+    end
+
+    # chef-zero provisioner intended for use with `chef capture`.
+    #
+    # This provisioner does not do any cookbook dependency
+    # resolution and will not pull in external cookbooks.  All cookbooks
+    # or cookbook artificats  + policy data as captured from the live node and are
+    # expected to be available for chef-zero to provide to the client.
+    class ChefZeroCapture < ChefZero
+      # Declaring these ensure that they're available to the sandbox - it's initialized
+      # the provider's configoptions.
+      default_config :policies_path, "policies"
+      default_config :policy_groups_path, "policy_groups"
+      default_config :cookbook_artifacts_path, "cookbook_artifacts"
+
+      # This will load policyfile/berkshelf.  We don't want either - the client resolves all
+      # dependencies from chef-zero, exactly as preppped in the captured repository.
+      def load_needed_dependencies!; end
+
+      def create_sandbox
+        # We have to invoke the the true Base create_sandbox because it does setup that
+        # we want. However, we do not want to invoke the create_sandbox inherited from
+        # ChefZero/ChefBase - those will create and populate a ChefCommonSandbox instead
+        # of a ChefZeroCaptureSandbox.
+        m = Base.instance_method(:create_sandbox).bind(self)
+        m.call
+
+        # These behaviors from super we _do_ want, so we need to copy them here.
+        prepare_validation_pem
+        prepare_config_rb
+        ChefZeroCaptureSandbox.new(config, sandbox_path, instance).populate
+      end
+
+      # Overriding the private ProviderChefZero#default_config_rb
+      # so that we can add additional configuratoin required for  chef-zeor
+      # to be able to locate our policies/, policy groups, and cookbook artifacts
+      # at run-time.
+      def default_config_rb
+        cfg = super
+        # Need to tell chef-zero about our additional config.
+        root = config[:root_path].gsub("$env:TEMP", "\#{ENV['TEMP']\}")
+        cfg[:policies_path] = remote_path_join(root, config[:policies_path])
+        cfg[:policy_groups_path] = remote_path_join(root, config[:policy_groups_path])
+        cfg[:cookbook_artifacts_path] = remote_path_join(root, config[:cookbook_artifacts_path])
+        cfg
+      end
+    end
+  end
+end

data/spec/unit/command/generator_commands/build_cookbook_spec.rb

@@ -198,7 +198,7 @@ describe ChefCLI::Command::GeneratorCommands::BuildCookbook do
               maintainer_email 'you@example.com'
               license 'all_rights'
               version '0.1.0'
-              chef_version '>= 14.0'
+              chef_version '>= 15.0'
 
               depends 'delivery-truck'
             METADATA

data/spec/unit/kitchen/provisioner/chef_zero_capture_spec.rb

@@ -0,0 +1,84 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Marc Paradsie <marc.paradise@gmail.com>
+#
+# Copyright (C) 2020 Chef Software Inc
+#
+# 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_relative "../../../spec_helper"
+
+require "kitchen"
+require "kitchen/provisioner/chef_zero_capture"
+
+describe Kitchen::Provisioner::ChefZeroCapture do
+  let(:logged_output)   { StringIO.new }
+  let(:logger)          { Logger.new(logged_output) }
+  let(:kitchen_root) { Dir.mktmpdir }
+
+  let(:config) do
+    { test_base_path: "/t", base_path: "/b", kitchen_root: kitchen_root, root_path: kitchen_root }
+  end
+  let(:platform)        { double("platform", os_type: nil) }
+  let(:suite)           { double("suite", name: "fried") }
+
+  let(:instance_config) do
+    double("config", name: "coolbeans", logger: logger, suite: suite, platform: platform)
+  end
+
+  subject do
+    p = Kitchen::Provisioner::ChefZeroCapture.new(config)
+    p.finalize_config!(instance_config)
+  end
+
+  after do
+    FileUtils.remove_entry(kitchen_root)
+  end
+
+  describe "#create_sandbox" do
+    let(:sandbox_mock) do
+      double("sandbox", populate: nil)
+    end
+    before do
+      allow(Kitchen::Provisioner::ChefZeroCaptureSandbox).to receive(:new).and_return sandbox_mock
+    end
+
+    it "initializes files and populates a ChefZeroCaptureSandbox" do
+      expect(subject).to receive(:prepare_validation_pem)
+      expect(subject).to receive(:prepare_config_rb)
+      expect(sandbox_mock).to receive(:populate)
+      subject.create_sandbox
+    end
+
+    after do
+      begin
+        subject.cleanup_sandbox
+      rescue # rubocop:disable Lint/HandleExceptions
+      end
+    end
+  end
+
+  describe "#default_config_rb" do
+    it "contains keys that suggest 'super' was invoked for full config_rb setup" do
+      cfg = subject.default_config_rb
+      expect(cfg[:node_path]).to eq File.join(kitchen_root, "nodes")
+    end
+
+    it "adds the expected correct config for captured nodes" do
+      cfg = subject.default_config_rb
+      expect(cfg[:policies_path]).to eq File.join(kitchen_root, "policies")
+      expect(cfg[:cookbook_artifacts_path]).to eq File.join(kitchen_root, "cookbook_artifacts")
+      expect(cfg[:policy_groups_path]).to eq File.join(kitchen_root, "policy_groups")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-cli
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.11
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -156,16 +156,22 @@ dependencies:
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: paint
   requirement: !ruby/object:Gem::Requirement
@@ -389,6 +395,7 @@ files:
 - lib/chef-cli/skeletons/code_generator/templates/default/template.erb
 - lib/chef-cli/ui.rb
 - lib/chef-cli/version.rb
+- lib/kitchen/provisioner/chef_zero_capture.rb
 - lib/kitchen/provisioner/policyfile_zero.rb
 - spec/shared/a_file_generator.rb
 - spec/shared/a_generated_file.rb
@@ -527,6 +534,7 @@ files:
 - spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb
 - spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb
 - spec/unit/generator_spec.rb
+- spec/unit/kitchen/provisioner/chef_zero_capture_spec.rb
 - spec/unit/pager_spec.rb
 - spec/unit/policyfile/artifactory_cookbook_source_spec.rb
 - spec/unit/policyfile/attribute_merge_checker_spec.rb
@@ -592,7 +600,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -741,6 +749,7 @@ test_files:
 - spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb
 - spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb
 - spec/unit/generator_spec.rb
+- spec/unit/kitchen/provisioner/chef_zero_capture_spec.rb
 - spec/unit/pager_spec.rb
 - spec/unit/policyfile/artifactory_cookbook_source_spec.rb
 - spec/unit/policyfile/attribute_merge_checker_spec.rb