chef-cli 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08825f8c8c80fbf8119e1108de938d1dbe3c108309dfefb4f3454ac9fee3397d'
-  data.tar.gz: b3327078e2ee12265d9aabbeab42c9b510adfb1dad6a17cef3b9b8951239030f
+  metadata.gz: a13b7fe5a79e96a77dbe15637e0c7049ba7a2b1497c9b51ae1a8512dde66173e
+  data.tar.gz: cfa51c708cf8c115755dc5e243f6ac08b658bb71cb9dd4b015d8738de229ae26
 SHA512:
-  metadata.gz: 2b579beed9b27e92883fd1990a8de48c36a04d947ff6eed0a01df1bd49c38b3d325cad36dcf1eb8801e6107f6fd3dbaa8b2d8afb29bd51618a9dab5861883d58
-  data.tar.gz: 14a6e42f8b8b24d731639ba48eb16b3dae8de21d35adce5f9bda99d59b1ad47accdd4686c883183328573ee04e14fddf114960705f930d110e490beaa017080a
+  metadata.gz: 974da449a8873d332523b92a0a263f675d80bd8b378317e645f80ea2bc5bdcff5fb476a038e7ce41268e1c88222d2625695aef90bf7311ddf2c7972b001c99f2
+  data.tar.gz: 6a3504dc2d8f14b4a1ad63085fb74661c18e89d78551c0d2fd65efdb392c588277fd9202bbada3c09471290743c1eee389268008b6d132d926a958b035024ffe

data/Gemfile

@@ -10,6 +10,21 @@ group :test do
   gem "cookstyle", "=7.7.2" # this forces dependabot PRs to open which triggers cookstyle CI on the chef generate command
   gem "chefstyle", "=1.6.2"
   gem "test-kitchen", ">= 2.11.1"
+
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.6")
+    gem "chef-zero", "~> 14"
+    gem "chef", "~> 15"
+    gem "chef-utils", "=16.6.14"
+  end
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.7")
+    gem "ohai", "~> 16"
+  end
+end
+
+group :development do
+  gem "pry"
+  gem "pry-byebug"
+  gem "rb-readline"
 end
 
 group :profile do

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

@@ -29,7 +29,6 @@ require_relative "generator_commands/template"
 require_relative "generator_commands/repo"
 require_relative "generator_commands/policyfile"
 require_relative "generator_commands/generator_generator"
-require_relative "generator_commands/build_cookbook"
 require_relative "../dist"
 
 module ChefCLI
@@ -56,7 +55,7 @@ module ChefCLI
       generator(:repo, :Repo, "Generate a #{ChefCLI::Dist::INFRA_PRODUCT} code repository")
       generator(:policyfile, :Policyfile, "Generate a Policyfile for use with the install/push commands")
       generator(:generator, :GeneratorGenerator, "Copy #{ChefCLI::Dist::PRODUCT}'s generator cookbook so you can customize it")
-      generator(:'build-cookbook', :BuildCookbook, "Generate a build cookbook for use with #{ChefCLI::Dist::WORKFLOW}")
+      generator(:'build-cookbook', :BuildCookbook, "DEPRECATED: Generate a build cookbook for use with #{ChefCLI::Dist::WORKFLOW}")
 
       def self.banner_headline
         <<~E
@@ -83,6 +82,10 @@ module ChefCLI
       end
 
       def run(params)
+        if params[0] == "build-cookbook"
+          warn "[DEPRECATION] Chef Workflow (Delivery) is end of life (EOL) as of December 31, 2020 and this generator subcommand has been removed".freeze
+          return 1
+        end
         if ( generator_spec = generator_for(params[0]) )
           params.shift
           generator = GeneratorCommands.build(generator_spec.class_name, params)
@@ -118,7 +121,6 @@ module ChefCLI
       def have_generator?(name)
         self.class.generators.map { |g| g.name.to_s }.include?(name)
       end
-
     end
   end
 end

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

@@ -76,6 +76,13 @@ module ChefCLI
           boolean:      true,
           default:      false
 
+        option :yaml,
+          short:        "-y",
+          long:         "--yaml",
+          description:  "Generate a cookbook with YAML Recipe configuration file as the default.",
+          boolean:      true,
+          default:      nil
+
         option :pipeline,
           long:         "--pipeline PIPELINE",
           description:  "Use PIPELINE to set target branch to something other than master for the #{ChefCLI::Dist::WORKFLOW} build_cookbook",
@@ -111,6 +118,7 @@ module ChefCLI
         end
 
         def emit_post_create_message
+          default_recipe_file = yaml ? "default.yml" : "default.rb"
           if have_delivery_config?
             msg("Your cookbook is ready. To setup the pipeline, type `cd #{cookbook_name_or_path}`, then run `delivery init`")
           else
@@ -120,7 +128,7 @@ module ChefCLI
             msg("\nWhy not start by writing an InSpec test? Tests for the default recipe are stored at:\n")
             msg("test/integration/default/default_test.rb")
             msg("\nIf you'd prefer to dive right in, the default recipe can be found at:")
-            msg("\nrecipes/default.rb\n")
+            msg("\nrecipes/#{default_recipe_file}\n")
           end
         end
 
@@ -147,6 +155,7 @@ module ChefCLI
           Generator.add_attr_to_context(:pipeline, pipeline)
           Generator.add_attr_to_context(:kitchen, kitchen)
           Generator.add_attr_to_context(:vscode_dir, create_vscode_dir?)
+          Generator.add_attr_to_context(:yaml, yaml)
         end
 
         def kitchen
@@ -157,6 +166,10 @@ module ChefCLI
           config[:pipeline]
         end
 
+        def yaml
+          config[:yaml]
+        end
+
         def policy_name
           cookbook_name
         end

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

@@ -26,6 +26,13 @@ module ChefCLI
 
         banner "Usage: #{ChefCLI::Dist::EXEC} generate recipe [path/to/cookbook] NAME [options]"
 
+        option :yaml,
+          short:        "-y",
+          long:         "--yaml",
+          description:  "Generate recipe using YAML configuration format.",
+          boolean:      true,
+          default:      nil
+
         options.merge!(SharedGeneratorOptions.options)
 
         def recipe

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

@@ -117,10 +117,18 @@ end
 # Recipes
 directory "#{cookbook_dir}/recipes"
 
-template "#{cookbook_dir}/recipes/default.rb" do
-  source 'recipe.rb.erb'
-  helpers(ChefCLI::Generator::TemplateHelper)
-  action :create_if_missing
+if context.yaml
+  template "#{cookbook_dir}/recipes/default.yml" do
+    source 'recipe.yml.erb'
+    helpers(ChefCLI::Generator::TemplateHelper)
+    action :create_if_missing
+  end
+else
+  template "#{cookbook_dir}/recipes/default.rb" do
+    source 'recipe.rb.erb'
+    helpers(ChefCLI::Generator::TemplateHelper)
+    action :create_if_missing
+  end
 end
 
 # the same will be done below if workflow was enabled so avoid double work and skip this

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

@@ -1,6 +1,7 @@
 context = ChefCLI::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
 recipe_path = File.join(cookbook_dir, 'recipes', "#{context.new_file_basename}.rb")
+recipe_path_yml = File.join(cookbook_dir, 'recipes', "#{context.new_file_basename}.yml")
 spec_helper_path = File.join(cookbook_dir, 'spec', 'spec_helper.rb')
 spec_dir = File.join(cookbook_dir, 'spec', 'unit', 'recipes')
 spec_path = File.join(spec_dir, "#{context.new_file_basename}_spec.rb")
@@ -44,7 +45,14 @@ template inspec_path do
 end
 
 # Recipe
-template recipe_path do
-  source 'recipe.rb.erb'
-  helpers(ChefCLI::Generator::TemplateHelper)
+if context.yaml
+  template recipe_path_yml do
+    source 'recipe.yml.erb'
+    helpers(ChefCLI::Generator::TemplateHelper)
+  end
+else
+  template recipe_path do
+    source 'recipe.rb.erb'
+    helpers(ChefCLI::Generator::TemplateHelper)
+  end
 end

data/lib/chef-cli/skeletons/code_generator/templates/default/recipe.yml.erb

@@ -0,0 +1,18 @@
+#
+# Cookbook:: <%= cookbook_name %>
+# Recipe:: <%= recipe_name %>
+#
+<%= license_description('#') %>
+
+---
+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

data/lib/chef-cli/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefCLI
-  VERSION = "5.0.1".freeze
+  VERSION = "5.1.0".freeze
 end

data/spec/unit/command/generate_spec.rb

@@ -138,5 +138,12 @@ describe ChefCLI::Command::Generate do
 
     end
 
+    describe "When build-cookbookis given as subcommand" do
+      it "shows deprecation warning when" do
+        result = generate.run(%w{build-cookbook example})
+        expect(result).to eq(1)
+      end
+    end
+
   end
 end

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

@@ -189,201 +189,6 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
       end
     end
 
-    context "when passed workflow option" do
-
-      context "generates a workflow (delivery) cookbook" do
-
-        let(:argv) { %w{new_cookbook --workflow} }
-
-        let(:dot_delivery) { File.join(tempdir, "new_cookbook", ".delivery") }
-
-        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
-
-        describe "when passed without --specs subcommand .delivery/project.toml" do
-
-          let(:file) { File.join(tempdir, "new_cookbook", ".delivery", "project.toml") }
-
-          let(:expected_content) do
-            <<~PROJECT_DOT_TOML
-              # 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]
-              unit = "echo skipping unit phase."
-              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"
-            PROJECT_DOT_TOML
-          end
-
-          it "exists with default config for Cookbook Workflow" do
-            expect(IO.read(file)).to eq(expected_content)
-          end
-
-        end
-
-        describe "when passed with --specs subcommand .delivery/project.toml" do
-
-          let(:argv) { %w{new_cookbook --workflow --specs} }
-
-          let(:file) { File.join(tempdir, "new_cookbook", ".delivery", "project.toml") }
-
-          let(:expected_content) do
-            <<~PROJECT_DOT_TOML
-              # 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]
-              unit = "chef exec rspec spec/"
-              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"
-            PROJECT_DOT_TOML
-          end
-
-          it "exists with default config for Cookbook Workflow" do
-            expect(IO.read(file)).to eq(expected_content)
-          end
-
-        end
-
-      end
-
-      context "when no delivery CLI configuration is present" do
-
-        let(:argv) { %w{new_cookbook --workflow} }
-
-        it "detects no delivery config" do
-          Dir.chdir(tempdir) do
-            expect(cookbook_generator.have_delivery_config?).to be(false)
-          end
-        end
-
-        it "emits concise 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
-
-          expected = <<~OUTPUT
-            Generating cookbook new_cookbook
-            - Ensuring correct cookbook content
-            - Committing cookbook files to git
-
-            #{non_delivery_breadcrumb}
-          OUTPUT
-
-          actual = stdout_io.string
-
-          # the formatter will add escape sequences to turn off any colors
-          actual.gsub!("\e[0m", "")
-          expect(actual).to eq(expected)
-        end
-      end
-
-      context "when a delivery CLI config is present" do
-
-        # Setup a situation like this:
-        # there is a dir for the delivery organization with the
-        # `.delivery/cli.toml` in it. Inside that is another dir (maybe IRL this
-        # would be "cookbooks"), then we create the cookbook inside that.
-
-        let(:argv) { %w{new_cookbook --workflow} }
-
-        let(:tempdir_subdir) { File.join(tempdir, "subdirectory") }
-
-        let(:dot_delivery_dir) { File.join(tempdir, ".delivery") }
-
-        let(:dot_delivery_cli_toml) { File.join(dot_delivery_dir, "cli.toml") }
-
-        before do
-          Dir.mkdir(tempdir_subdir)
-          Dir.mkdir(dot_delivery_dir)
-          FileUtils.touch(dot_delivery_cli_toml)
-        end
-
-        it "detects the delivery config" do
-          Dir.chdir(tempdir_subdir) do
-            expect(cookbook_generator.have_delivery_config?).to be(true)
-          end
-        end
-
-        it "emits concise 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
-
-          expected = <<~OUTPUT
-            Generating cookbook new_cookbook
-            - Ensuring correct cookbook content
-            - Committing cookbook files to git
-
-            Your cookbook is ready. To setup the pipeline, type `cd new_cookbook`, then run `delivery init`
-          OUTPUT
-
-          actual = stdout_io.string
-
-          # the formatter will add escape sequences to turn off any colors
-          actual.gsub!("\e[0m", "")
-          expect(actual).to eq(expected)
-        end
-      end
-    end
-
     context "when given the specs flag" do
 
       let(:argv) { %w{ new_cookbook --specs } }
@@ -615,6 +420,55 @@ describe ChefCLI::Command::GeneratorCommands::Cookbook do
 
     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} }