chef-cli 3.1.6 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db59602ecc8f8eccfed56173f71092e36e1cc55ad6ece88e311d26896d7a1e0b
-  data.tar.gz: a584cf195ad81b8e3ddae995aa5c275545e795782439990ceb11e7dc2450eba6
+  metadata.gz: 60e2fef23b0a30ce5f7dcc08bb3a72a2166c7944e2edf80b79a01975f4721029
+  data.tar.gz: 1270d7ff326fb8460a31b71b2fde6ec940a3700627a62aec10c14926c01b258e
 SHA512:
-  metadata.gz: d1d34379eda31b8391fd142cc60ad71c0ac8bcd9e8a0fc9734da1a25cbfebdae1b2dda323ef6937ba2a05d11a86cc429f8a6d4692067d073b240dd5da3fdc5a2
-  data.tar.gz: 27b7a7342e77162a34a7c6e3dcabfc9ba73d3081fb2b1bc6d144c5d01a8fa673bc2c60f6fc87ee2cc3841a970274f407b6cf9ab2c099d4cd6e7fdd845066c10c
+  metadata.gz: 0130ff765efec8876f369244a8b77ded247fe8a58a24b60561d361a0f9577a72a61db8d8ec34f8cd9e5e4b3f95eb9c0d1618211cf2dcce1a8be5b402be8a2028
+  data.tar.gz: b7ee1e7672559a167b511afe308642eb13d28eaa89aaff9f0ac44bf3968aa049c8978df63b6e3d4ee66a17ab66539ef7337afa452194055773b7bb76110c5e9f

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

@@ -55,6 +55,13 @@ module ChefCLI
           boolean:      true,
           default:      nil
 
+        option :specs,
+          short:        "-s",
+          long:         "--specs",
+          description:  "Generate a cookbook with sample ChefSpec specs",
+          boolean:      true,
+          default:      nil
+
         option :workflow,
           short:        "-w",
           long:         "--workflow",
@@ -81,6 +88,7 @@ module ChefCLI
           @cookbook_name = nil
           @policy_mode = true
           @verbose = false
+          @specs = false
           super
         end
 
@@ -133,6 +141,7 @@ module ChefCLI
           Generator.add_attr_to_context(:workflow_project_git_initialized, have_git? && !cookbook_path_in_git_repo?)
 
           Generator.add_attr_to_context(:verbose, verbose?)
+          Generator.add_attr_to_context(:specs, specs?)
 
           Generator.add_attr_to_context(:use_policyfile, policy_mode?)
           Generator.add_attr_to_context(:pipeline, pipeline)
@@ -188,6 +197,10 @@ module ChefCLI
           @verbose
         end
 
+        def specs?
+          @specs
+        end
+
         #
         # Is there a .delivery/cli.toml in the current dir or any of the parent dirs
         #
@@ -223,6 +236,10 @@ module ChefCLI
             @verbose = true
           end
 
+          if config[:specs]
+            @specs = true
+          end
+
           true
         end
 

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

@@ -92,24 +92,26 @@ template "#{cookbook_dir}/test/integration/default/default_test.rb" do
 end
 
 # ChefSpec
-directory "#{cookbook_dir}/spec/unit/recipes" do
-  recursive true
-end
-
-cookbook_file "#{cookbook_dir}/spec/spec_helper.rb" do
-  if context.use_policyfile
-    source 'spec_helper_policyfile.rb'
-  else
-    source 'spec_helper.rb'
+if context.specs
+  directory "#{cookbook_dir}/spec/unit/recipes" do
+    recursive true
   end
 
-  action :create_if_missing
-end
+  cookbook_file "#{cookbook_dir}/spec/spec_helper.rb" do
+    if context.use_policyfile
+      source 'spec_helper_policyfile.rb'
+    else
+      source 'spec_helper.rb'
+    end
 
-template "#{cookbook_dir}/spec/unit/recipes/default_spec.rb" do
-  source 'recipe_spec.rb.erb'
-  helpers(ChefCLI::Generator::TemplateHelper)
-  action :create_if_missing
+    action :create_if_missing
+  end
+
+  template "#{cookbook_dir}/spec/unit/recipes/default_spec.rb" do
+    source 'recipe_spec.rb.erb'
+    helpers(ChefCLI::Generator::TemplateHelper)
+    action :create_if_missing
+  end
 end
 
 # Recipes
@@ -125,10 +127,13 @@ end
 unless context.enable_workflow
   directory "#{cookbook_dir}/.delivery"
 
-  # Adding the delivery local-mode config
-  cookbook_file "#{cookbook_dir}/.delivery/project.toml" do
-    source 'delivery-project.toml'
-    not_if { ::File.exist?("#{cookbook_dir}/.delivery/project.toml") }
+  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
 

data/lib/chef-cli/skeletons/code_generator/templates/default/delivery-project.toml.erb

@@ -0,0 +1,36 @@
+# Delivery for Local Phases Execution
+#
+# This file allows you to execute test phases locally on a workstation or
+# in a CI pipeline. The delivery-cli will read this file and execute the
+# command(s) that are configured for each phase. You can customize them
+# by just modifying the phase key on this file.
+#
+# By default these phases are configured for Cookbook Workflow only
+#
+
+[local_phases]
+<% if @specs %>
+unit = "chef exec rspec spec/"
+<% else %>
+unit = "echo skipping unit phase."
+<% end %>
+lint = "chef exec cookstyle"
+# foodcritic has been deprecated in favor of cookstyle so we skip the syntax
+# phase now.
+syntax = "echo skipping syntax phase. Use lint phase instead."
+provision = "chef exec kitchen create"
+deploy = "chef exec kitchen converge"
+smoke = "chef exec kitchen verify"
+# The functional phase is optional, you can define it by uncommenting
+# the line below and running the command: `delivery local functional`
+# functional = ""
+cleanup = "chef exec kitchen destroy"
+
+# Remote project.toml file
+#
+# Instead of the local phases above, you may specify a remote URI location for
+# the `project.toml` file. This is useful for teams that wish to centrally
+# manage the behavior of the `delivery local` command across many different
+# projects.
+#
+# remote_file = "https://url/project.toml"

data/lib/chef-cli/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefCLI
-  VERSION = "3.1.6".freeze
+  VERSION = "4.0.0".freeze
 end

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

@@ -30,6 +30,24 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
   let(:stderr_io) { StringIO.new }
 
   let(:expected_cookbook_file_relpaths) do
+    %w{
+      .gitignore
+      kitchen.yml
+      test
+      test/integration
+      test/integration/default/default_test.rb
+      Policyfile.rb
+      chefignore
+      LICENSE
+      metadata.rb
+      README.md
+      CHANGELOG.md
+      recipes
+      recipes/default.rb
+    }
+  end
+
+  let(:expected_cookbook_file_relpaths_specs) do
     %w{
       .gitignore
       kitchen.yml
@@ -58,6 +76,12 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
     end
   end
 
+  let(:expected_cookbook_files_specs) do
+    expected_cookbook_file_relpaths_specs.map do |relpath|
+      File.join(tempdir, "new_cookbook", relpath)
+    end
+  end
+
   let(:non_delivery_breadcrumb) do
     <<~EOF
       Your cookbook is ready. Type `cd new_cookbook` to enter it.
@@ -150,9 +174,11 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
       expect(generator_context.cookbook_name).to eq("new_cookbook")
       expect(generator_context.recipe_name).to eq("default")
       expect(generator_context.verbose).to be(false)
+      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)
@@ -398,6 +424,28 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
       end
     end
 
+    context "when given the specs flag" do
+
+      let(:argv) { %w{ new_cookbook --specs } }
+
+      it "configures the generator context with specs mode enabled" do
+        cookbook_generator.read_and_validate_params
+        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
 
       let(:argv) { %w{ new_cookbook --verbose } }
@@ -594,6 +642,7 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
       end
 
       include_examples "chefspec_spec_helper_file" do
+        let(:argv) { %w{ new_cookbook --policy --specs } }
 
         let(:expected_chefspec_spec_helper_content) do
           <<~SPEC_HELPER
@@ -683,6 +732,7 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
       end
 
       include_examples "chefspec_spec_helper_file" do
+        let(:argv) { %w{ new_cookbook --berks --specs } }
 
         let(:expected_chefspec_spec_helper_content) do
           <<~SPEC_HELPER
@@ -712,6 +762,7 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
     end
 
     describe "spec/unit/recipes/default_spec.rb" do
+      let(:argv) { %w{ new_cookbook --specs } }
       let(:file) { File.join(tempdir, "new_cookbook", "spec", "unit", "recipes", "default_spec.rb") }
 
       include_examples "a generated file", :cookbook_name do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-cli
 version: !ruby/object:Gem::Version
-  version: 3.1.6
+  version: 4.0.0
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -376,6 +376,7 @@ files:
 - lib/chef-cli/skeletons/code_generator/templates/default/build_cookbook/metadata.rb.erb
 - lib/chef-cli/skeletons/code_generator/templates/default/build_cookbook/recipe.rb.erb
 - lib/chef-cli/skeletons/code_generator/templates/default/cookbook_file.erb
+- lib/chef-cli/skeletons/code_generator/templates/default/delivery-project.toml.erb
 - lib/chef-cli/skeletons/code_generator/templates/default/helpers.rb.erb
 - lib/chef-cli/skeletons/code_generator/templates/default/inspec_default_test.rb.erb
 - lib/chef-cli/skeletons/code_generator/templates/default/kitchen.yml.erb