chef-cli 3.1.3 → 5.1.0

data/lib/chef-cli/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefCLI
-  VERSION = "3.1.3".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

@@ -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)
@@ -163,237 +189,24 @@ 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} }
+    context "when given the specs flag" do
 
-        let(:dot_delivery) { File.join(tempdir, "new_cookbook", ".delivery") }
+      let(:argv) { %w{ new_cookbook --specs } }
 
-        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 ".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 = "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
-
-        describe ".delivery/config.json" do
-
-          let(:file) { File.join(tempdir, "new_cookbook", ".delivery", "config.json") }
-
-          let(:expected_content) do
-            <<~CONFIG_DOT_JSON
-              {
-                "version": "2",
-                "build_cookbook": {
-                  "name": "build_cookbook",
-                  "path": ".delivery/build_cookbook"
-                },
-                "delivery-truck": {
-                  "lint": {
-                    "enable_cookstyle": true
-                  }
-                },
-                "skip_phases": [],
-                "job_dispatch": {
-                  "version": "v2"
-                },
-                "dependencies": []
-              }
-            CONFIG_DOT_JSON
-          end
-
-          it "configures delivery to use a local build cookbook" do
-            expect(IO.read(file)).to eq(expected_content)
-          end
-
-        end
-
-        describe "build cookbook recipes" do
-
-          let(:file) do
-            File.join(dot_delivery, "build_cookbook", "recipes", "publish.rb")
-          end
-
-          let(:expected_content) do
-            <<~CONFIG_DOT_JSON
-              #
-              # Cookbook:: build_cookbook
-              # Recipe:: publish
-              #
-              # Copyright:: #{DateTime.now.year}, The Authors, All Rights Reserved.
-
-              include_recipe 'delivery-truck::publish'
-            CONFIG_DOT_JSON
-          end
-
-          it "delegates functionality to delivery-truck" do
-            expect(IO.read(file)).to include(expected_content)
-          end
-
-        end
-
-        describe "build cookbook Berksfile" do
-
-          let(:file) do
-            File.join(dot_delivery, "build_cookbook", "Berksfile")
-          end
-
-          let(:expected_content) do
-            <<~CONFIG_DOT_JSON
-              source 'https://supermarket.chef.io'
-
-              metadata
-
-              group :workflow do
-                cookbook 'test', path: './test/fixtures/cookbooks/test'
-              end
-            CONFIG_DOT_JSON
-          end
-
-          it "sets the sources for delivery library cookbooks to github" do
-            expect(IO.read(file)).to include(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
-            - Ensuring delivery CLI configuration
-            - Ensuring correct Workflow (Delivery) build cookbook content
-            - Adding delivery configuration to feature branch
-            - Adding build cookbook to feature branch
-            - Merging delivery content feature branch to master
-
-            #{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
+      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
 
-      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
+      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
-
-        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
-            - Ensuring delivery CLI configuration
-            - Ensuring correct Workflow (Delivery) build cookbook content
-            - Adding delivery configuration to feature branch
-            - Adding build cookbook to feature branch
-            - Merging delivery content feature branch to master
-
-            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)
+        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
@@ -594,6 +407,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
@@ -606,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} }
@@ -683,6 +546,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 +576,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

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

@@ -35,4 +35,38 @@ describe ChefCLI::Command::GeneratorCommands::Recipe do
 
   end
 
+  context "when YAML recipe flag is passed" do
+
+    let(:argv) { %w{some_recipe --yaml} }
+    let(:expected_cookbook_root) { tempdir }
+    let(:cookbook_name) { "example_cookbook" }
+    let(:cookbook_path) { File.join(tempdir, cookbook_name) }
+
+    let(:generator_name) { "recipe" }
+    let(:generated_files) do
+      [ "recipes/some_recipe.yml",
+                              "spec/spec_helper.rb",
+                              "spec/unit/recipes/some_recipe_spec.rb",
+                              "test/integration/default/some_recipe_test.rb",
+                            ]
+    end
+    let(:new_file_name) { "some_recipe" }
+
+    before do
+      FileUtils.cp_r(File.join(fixtures_path, "example_cookbook"), tempdir)
+    end
+
+    it "creates a new recipe" do
+      Dir.chdir(cookbook_path) do
+        allow(recipe_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+        recipe_generator.run
+      end
+
+      generated_files.each do |expected_file|
+        expect(File).to exist(File.join(cookbook_path, expected_file))
+      end
+    end
+
+  end
+
 end

data/spec/unit/command/shell_init_spec.rb

@@ -264,8 +264,8 @@ describe ChefCLI::Command::ShellInit do
         {
           "exec" => "Runs the command in context of the embedded ruby",
           "env" => "Prints environment variables used by #{ChefCLI::Dist::PRODUCT}",
-          "gem" => "Runs the `gem` command in context of the embedded ruby",
-          "generate" => "Generate a new app, cookbook, or component",
+          "gem" => "Runs the `gem` command in context of the embedded Ruby",
+          "generate" => "Generate a new repository, cookbook, or other component",
         }
       end
 
@@ -276,17 +276,17 @@ describe ChefCLI::Command::ShellInit do
 
       let(:expected_completion_function) do
         <<~END_COMPLETION
+
           # Fish Shell command-line completions for #{ChefCLI::Dist::PRODUCT}
 
-          function __fish_chef_no_command --description 'Test if chef has yet to be given the main command'
-            set -l cmd (commandline -opc)
-            test (count $cmd) -eq 1
-          end
+          # set a list of all the chef commands in the Ruby chef-cli
+          set -l chef_commands exec env gem generate;
+
+          complete -c chef -f -n "not __fish_seen_subcommand_from $chef_commands" -a exec -d "Runs the command in context of the embedded ruby";
+          complete -c chef -f -n "not __fish_seen_subcommand_from $chef_commands" -a env -d "Prints environment variables used by #{ChefCLI::Dist::PRODUCT}";
+          complete -c chef -f -n "not __fish_seen_subcommand_from $chef_commands" -a gem -d "Runs the `gem` command in context of the embedded Ruby";
+          complete -c chef -f -n "not __fish_seen_subcommand_from $chef_commands" -a generate -d "Generate a new repository, cookbook, or other component";
 
-          complete -c chef -f -n '__fish_chef_no_command' -a exec -d "Runs the command in context of the embedded ruby"
-          complete -c chef -f -n '__fish_chef_no_command' -a env -d "Prints environment variables used by Chef Workstation"
-          complete -c chef -f -n '__fish_chef_no_command' -a gem -d "Runs the `gem` command in context of the embedded ruby"
-          complete -c chef -f -n '__fish_chef_no_command' -a generate -d "Generate a new app, cookbook, or component"
         END_COMPLETION
       end