chef-cli 5.5.5 → 5.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1716bb7f053b4836d2e2a2fc6e309ca583a059d537606361dabf0c8b40e7cc98
-  data.tar.gz: 75e3112b7e47f3bd96aa84727e76ec65d80c3ef977321c5132f0bebef962e201
+  metadata.gz: 38c929fa9c8587e5030c03d78715e5b483326e958a104ac4403f68779a8cdfd3
+  data.tar.gz: '07841d7b155b98b52cdb483c0e041ee8e59c34353295aa393c114db19af321b5'
 SHA512:
-  metadata.gz: c10e74154812fc6db2b0b81f8bfa48d4e0e284824b8c3beb24e19518be85d909d5ca4f6f1c8263e09b019f6469479a071b78a09ee15b1e15566c7234d580708e
-  data.tar.gz: f2684d4b818592bbd2c1575aa46105292a3903c2f93d3b68b60f260001474ae52b26b593fdaf9fa73113cf9e3db9397732dccbb724b605f9b50e21f6f744044b
+  metadata.gz: f7a6a2dfdbe694ed6897733c16af217c344a1d9163354325163172b21a9c8f5e00e26586774bd1f864b4b226a7fad72901aad776035a4d023f6432aae128242a
+  data.tar.gz: 659dbe818405db54685e7356156b6db39b671e7de86bf40fd3282ef497d68173a7042f3091cf7c60306d30639c7260349bcdab6e8ae1d5c28cd5ddadf9b5dc54

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

@@ -86,7 +86,7 @@ module ChefCLI
         option :pipeline,
           long:         "--pipeline PIPELINE",
           description:  "REMOVED: #{ChefCLI::Dist::WORKFLOW} is EOL. This option has been removed.",
-          default:      "master"
+          default:      nil
 
         options.merge!(SharedGeneratorOptions.options)
 

data/lib/chef-cli/skeletons/code_generator/recipes/cookbook.rb

@@ -131,20 +131,6 @@ else
   end
 end
 
-# the same will be done below if workflow was enabled so avoid double work and skip this
-unless context.enable_workflow
-  directory "#{cookbook_dir}/.delivery"
-
-  template "#{cookbook_dir}/.delivery/project.toml" do
-    variables(
-      specs: context.specs
-    )
-    source 'delivery-project.toml.erb'
-    helpers(ChefCLI::Generator::TemplateHelper)
-    action :create_if_missing
-  end
-end
-
 # git
 if context.have_git
   unless context.skip_git_init

data/lib/chef-cli/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefCLI
-  VERSION = "5.5.5".freeze
+  VERSION = "5.5.6".freeze
 end

data/spec/shared/custom_generator_cookbook.rb

@@ -66,6 +66,23 @@ shared_examples_for "custom generator cookbook" do
       end
     end
 
+    context "with an invalid generator-cookbook path" do
+
+      it "fails with an informative error" do
+        Dir.chdir(tempdir) do
+          allow(code_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          allow(code_generator).to receive(:stderr).and_return(stderr_io)
+          expect(code_generator.run).to eq(1)
+        end
+
+        cookbook_path = File.dirname(generator_cookbook_path)
+        expected_msg = %Q{ERROR: Could not find cookbook(s) to satisfy run list ["recipe[a_generator_cookbook::#{generator_name}]"] in #{cookbook_path}}
+
+        expect(stderr_io.string).to include(expected_msg)
+      end
+
+    end
+
     context "with a generator-cookbook path to a specific cookbook" do
 
       let(:metadata_file) { File.join(generator_cookbook_path, "metadata.rb") }
@@ -88,5 +105,32 @@ shared_examples_for "custom generator cookbook" do
       end
 
     end
+
+    context "with a generator-cookbook path to a directory containing a 'code_generator' cookbook" do
+
+      before do
+        FileUtils.mkdir_p(generator_cookbook_path)
+        FileUtils.cp_r(default_generator_cookbook_path, generator_cookbook_path)
+
+        allow(code_generator).to receive(:stderr).and_return(stderr_io)
+      end
+
+      it "creates the new_files (and warns about deprecated usage)" do
+        allow(code_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+
+        Dir.chdir(tempdir) do
+          code_generator.run
+        end
+        generated_files = Dir.glob("#{tempdir}/#{generator_arg}/**/*", File::FNM_DOTMATCH)
+        expected_cookbook_files.each do |expected_file|
+          expect(generated_files).to include(expected_file)
+        end
+
+        code_generator_path = File.join(generator_cookbook_path, "code_generator")
+        warning_message = "WARN: Please configure the generator cookbook by giving the full path to the desired cookbook (like '#{code_generator_path}')"
+
+        expect(stderr_io.string).to include(warning_message)
+      end
+    end
   end
 end

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

@@ -151,7 +151,7 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
     end
 
     it "warns if a hyphenated cookbook name is passed" do
-      expect(with_argv(%w{my-cookbook}).run).to eq(1)
+      expect(with_argv(%w{my-cookbook}).run).to eq(0)
       message = "Hyphens are discouraged in cookbook names as they may cause problems with custom resources. See https://docs.chef.io/workstation/ctl_chef/#chef-generate-cookbook for more information."
       expect(stdout_io.string).to include(message)
     end
@@ -176,6 +176,18 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
       expect(generator_context.specs).to be(false)
     end
 
+    it "creates a new cookbook" do
+
+      Dir.chdir(tempdir) do
+        allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+        expect(cookbook_generator.run).to eq(0)
+      end
+      generated_files = Dir.glob("#{tempdir}/new_cookbook/**/*", File::FNM_DOTMATCH)
+      expected_cookbook_files.each do |expected_file|
+        expect(generated_files).to include(expected_file)
+      end
+    end
+
     context "when given the specs flag" do
 
       let(:argv) { %w{ new_cookbook --specs } }
@@ -185,6 +197,17 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
         cookbook_generator.setup_context
         expect(generator_context.specs).to be(true)
       end
+
+      it "creates a new cookbook" do
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          expect(cookbook_generator.run).to eq(0)
+        end
+        generated_files = Dir.glob("#{tempdir}/new_cookbook/**/*", File::FNM_DOTMATCH)
+        expected_cookbook_files_specs.each do |expected_file|
+          expect(generated_files).to include(expected_file)
+        end
+      end
     end
 
     context "when given the verbose flag" do
@@ -196,19 +219,34 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
         cookbook_generator.setup_context
         expect(generator_context.verbose).to be(true)
       end
+
+      it "emits verbose output" do
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          expect(cookbook_generator.run).to eq(0)
+        end
+
+        # The normal chef formatter puts a heading for each recipe like this.
+        # Full output is large and subject to change with minor changes in the
+        # generator cookbook, so we just look for this line
+        expected_line = "Recipe: code_generator::cookbook"
+
+        actual = stdout_io.string
+
+        expect(actual).to include(expected_line)
+      end
     end
 
     shared_examples_for "a generated file" do |context_var|
       before do
         Dir.chdir(tempdir) do
           allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
-          expect(cookbook_generator.run).to eq(1)
+          expect(cookbook_generator.run).to eq(0)
         end
       end
 
-      it "should not generate a file" do
-        expect(File.directory?(file)).to be false
-        expect(File).not_to exist(file)
+      it "should contain #{context_var} from the generator context" do
+        expect(File.read(file)).to match line
       end
     end
 
@@ -228,6 +266,297 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
       end
     end
 
+    # This shared example group requires a let binding for
+    # `expected_kitchen_yml_content`
+    shared_examples_for "kitchen_yml_and_integration_tests" do
+
+      describe "Generating Test Kitchen and integration testing files" do
+
+        describe "generating kitchen config" do
+
+          before do
+            Dir.chdir(tempdir) do
+              allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+              expect(cookbook_generator.run).to eq(0)
+            end
+          end
+
+          let(:file) { File.join(tempdir, "new_cookbook", "kitchen.yml") }
+
+          it "creates a kitchen.yml with the expected content" do
+            expect(IO.read(file)).to eq(expected_kitchen_yml_content)
+          end
+
+        end
+
+        describe "test/integration/default/default_test.rb" do
+          let(:file) { File.join(tempdir, "new_cookbook", "test", "integration", "default", "default_test.rb") }
+
+          include_examples "a generated file", :cookbook_name do
+            let(:line) { "describe port" }
+          end
+        end
+      end
+    end
+
+    # This shared example group requires you to define a let binding for
+    # `expected_chefspec_spec_helper_content`
+    shared_examples_for "chefspec_spec_helper_file" do
+
+      describe "Generating ChefSpec files" do
+
+        before do
+          Dir.chdir(tempdir) do
+            allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+            expect(cookbook_generator.run).to eq(0)
+          end
+        end
+
+        let(:file) { File.join(tempdir, "new_cookbook", "spec", "spec_helper.rb") }
+
+        it "creates a spec/spec_helper.rb for ChefSpec with the expected content" do
+          expect(IO.read(file)).to eq(expected_chefspec_spec_helper_content)
+        end
+
+      end
+
+    end
+
+    context "when configured for Policyfiles" do
+
+      let(:argv) { %w{new_cookbook --policy} }
+
+      describe "Policyfile.rb" do
+
+        let(:file) { File.join(tempdir, "new_cookbook", "Policyfile.rb") }
+
+        let(:expected_content) do
+          <<~POLICYFILE_RB
+            # Policyfile.rb - Describe how you want Chef Infra Client to build your system.
+            #
+            # For more information on the Policyfile feature, visit
+            # https://docs.chef.io/policyfile/
+
+            # A name that describes what the system you're building with Chef does.
+            name 'new_cookbook'
+
+            # Where to find external cookbooks:
+            default_source :supermarket
+
+            # run_list: chef-client will run these recipes in the order specified.
+            run_list 'new_cookbook::default'
+
+            # Specify a custom source for a single cookbook:
+            cookbook 'new_cookbook', path: '.'
+          POLICYFILE_RB
+        end
+
+        before do
+          Dir.chdir(tempdir) do
+            allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+            expect(cookbook_generator.run).to eq(0)
+          end
+        end
+
+        it "has a run_list and cookbook path that will work out of the box" do
+          expect(IO.read(file)).to eq(expected_content)
+        end
+
+      end
+
+      include_examples "kitchen_yml_and_integration_tests" do
+
+        let(:expected_kitchen_yml_content) do
+          <<~KITCHEN_YML
+            ---
+            driver:
+              name: vagrant
+
+            ## The forwarded_port port feature lets you connect to ports on the VM guest
+            ## via localhost on the host.
+            ## see also: https://www.vagrantup.com/docs/networking/forwarded_ports
+
+            #  network:
+            #    - ["forwarded_port", {guest: 80, host: 8080}]
+
+            provisioner:
+              name: chef_zero
+
+              ## product_name and product_version specifies a specific Chef product and version to install.
+              ## see the Chef documentation for more details: https://docs.chef.io/workstation/config_yml_kitchen/
+              #  product_name: chef
+              #  product_version: 17
+
+            verifier:
+              name: inspec
+
+            platforms:
+              - name: ubuntu-20.04
+              - name: centos-8
+
+            suites:
+              - name: default
+                verifier:
+                  inspec_tests:
+                    - test/integration/default
+          KITCHEN_YML
+        end
+
+      end
+
+      include_examples "chefspec_spec_helper_file" do
+        let(:argv) { %w{ new_cookbook --policy --specs } }
+
+        let(:expected_chefspec_spec_helper_content) do
+          <<~SPEC_HELPER
+            require 'chefspec'
+            require 'chefspec/policyfile'
+          SPEC_HELPER
+        end
+
+      end
+
+    end
+
+    context "when YAML recipe flag is passed" do
+
+      let(:argv) { %w{new_cookbook --yaml} }
+
+      describe "recipes/default.yml" do
+        let(:file) { File.join(tempdir, "new_cookbook", "recipes", "default.yml") }
+
+        let(:expected_content_header) do
+          <<~DEFAULT_YML_HEADER
+          #
+          # Cookbook:: new_cookbook
+          # Recipe:: default
+          #
+          DEFAULT_YML_HEADER
+        end
+
+        let(:expected_content) do
+          <<~DEFAULT_YML_CONTENT
+          ---
+          resources:
+          # Example Syntax
+          # Additional snippets are available using the Chef Infra Extension for Visual Studio Code
+          # - type: file
+          #   name: '/path/to/file'
+          #   content: 'content'
+          #   owner: 'root'
+          #   group: 'root'
+          #   mode: '0755'
+          #   action:
+          #     - create
+          DEFAULT_YML_CONTENT
+        end
+
+        before do
+          Dir.chdir(tempdir) do
+            allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+            expect(cookbook_generator.run).to eq(0)
+          end
+        end
+
+        it "has a default.yml file with template contents" do
+          expect(IO.read(file)).to match(expected_content_header)
+          expect(IO.read(file)).to match(expected_content)
+        end
+
+      end
+
+    end
+
+    context "when configured for Berkshelf" do
+
+      let(:argv) { %w{new_cookbook --berks} }
+
+      describe "Berksfile" do
+
+        let(:file) { File.join(tempdir, "new_cookbook", "Berksfile") }
+
+        let(:expected_content) do
+          <<~POLICYFILE_RB
+            source 'https://supermarket.chef.io'
+
+            metadata
+          POLICYFILE_RB
+        end
+
+        before do
+          Dir.chdir(tempdir) do
+            allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+            expect(cookbook_generator.run).to eq(0)
+          end
+        end
+
+        it "pulls deps from metadata" do
+          expect(IO.read(file)).to eq(expected_content)
+        end
+
+      end
+
+      include_examples "kitchen_yml_and_integration_tests" do
+
+        let(:expected_kitchen_yml_content) do
+          <<~KITCHEN_YML
+            ---
+            driver:
+              name: vagrant
+
+            ## The forwarded_port port feature lets you connect to ports on the VM guest via
+            ## localhost on the host.
+            ## see also: https://www.vagrantup.com/docs/networking/forwarded_ports
+
+            #  network:
+            #    - ["forwarded_port", {guest: 80, host: 8080}]
+
+            provisioner:
+              name: chef_zero
+              # You may wish to disable always updating cookbooks in CI or other testing environments.
+              # For example:
+              #   always_update_cookbooks: <%= !ENV['CI'] %>
+              always_update_cookbooks: true
+
+              ## product_name and product_version specifies a specific Chef product and version to install.
+              ## see the Chef documentation for more details: https://docs.chef.io/workstation/config_yml_kitchen/
+              #  product_name: chef
+              #  product_version: 17
+
+            verifier:
+              name: inspec
+
+            platforms:
+              - name: ubuntu-20.04
+              - name: centos-8
+
+            suites:
+              - name: default
+                run_list:
+                  - recipe[new_cookbook::default]
+                verifier:
+                  inspec_tests:
+                    - test/integration/default
+                attributes:
+          KITCHEN_YML
+        end
+
+      end
+
+      include_examples "chefspec_spec_helper_file" do
+        let(:argv) { %w{ new_cookbook --berks --specs } }
+
+        let(:expected_chefspec_spec_helper_content) do
+          <<~SPEC_HELPER
+            require 'chefspec'
+            require 'chefspec/berkshelf'
+          SPEC_HELPER
+        end
+
+      end
+
+    end
+
     describe "metadata.rb" do
       let(:file) { File.join(tempdir, "new_cookbook", "metadata.rb") }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-cli
 version: !ruby/object:Gem::Version
-  version: 5.5.5
+  version: 5.5.6
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli