chef-cli 3.1.3 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aef40ff73580003cb8253f756a4da57c36c0fa7266e9df50fa5b3ff877b2c2b
-  data.tar.gz: a041fb63c6b24c45ddc3f90e40f8abf1f876cdeb3655ce1c2be09d87f17eb42a
+  metadata.gz: a13b7fe5a79e96a77dbe15637e0c7049ba7a2b1497c9b51ae1a8512dde66173e
+  data.tar.gz: cfa51c708cf8c115755dc5e243f6ac08b658bb71cb9dd4b015d8738de229ae26
 SHA512:
-  metadata.gz: 0361a3d6fe8f08665baebc4b69e931f6ed1546288d705c5cb2e09ce208712674afbb2ff07e4c6a45a1e9db1e5cb05b5788d2171af6280b594ed50f3a940335cb
-  data.tar.gz: d731fea15f7a1996687719a7f804e475020cef4d52f2da38b852ddd2e43c06f0493571cdb373ec23e3220d2fa1ac1e51aed7edf95cecf539a0c39a747f23b92b
+  metadata.gz: 974da449a8873d332523b92a0a263f675d80bd8b378317e645f80ea2bc5bdcff5fb476a038e7ce41268e1c88222d2625695aef90bf7311ddf2c7972b001c99f2
+  data.tar.gz: 6a3504dc2d8f14b4a1ad63085fb74661c18e89d78551c0d2fd65efdb392c588277fd9202bbada3c09471290743c1eee389268008b6d132d926a958b035024ffe

data/Gemfile

@@ -10,11 +10,15 @@ 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

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.5"
+  gem.required_ruby_version = ">= 2.6"
 
   gem.files = %w{Rakefile LICENSE} +
     Dir.glob("Gemfile*") + # Includes Gemfile and locks

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

@@ -55,10 +55,17 @@ 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",
-          description:  "Generate a cookbook with a full #{ChefCLI::Dist::WORKFLOW} build cookbook.",
+          description:  "DEPRECATED: Generate a cookbook with a full #{ChefCLI::Dist::WORKFLOW} build cookbook.",
           boolean:      true,
           default:      false
 
@@ -69,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",
@@ -81,6 +95,7 @@ module ChefCLI
           @cookbook_name = nil
           @policy_mode = true
           @verbose = false
+          @specs = false
           super
         end
 
@@ -103,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
@@ -112,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
 
@@ -133,11 +149,13 @@ 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)
           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
@@ -148,6 +166,10 @@ module ChefCLI
           config[:pipeline]
         end
 
+        def yaml
+          config[:yaml]
+        end
+
         def policy_name
           cookbook_name
         end
@@ -188,6 +210,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 +249,10 @@ module ChefCLI
             @verbose = true
           end
 
+          if config[:specs]
+            @specs = true
+          end
+
           true
         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/completions/chef.fish.erb

@@ -1,10 +1,9 @@
+
 # 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 <%= commands.keys.join(' ') %>;
 
 <% commands.each do |command, desc| -%>
-complete -c chef -f -n '__fish_chef_no_command' -a <%= command %> -d "<%= desc %>"
+complete -c chef -f -n "not __fish_seen_subcommand_from $chef_commands" -a <%= command %> -d "<%= desc %>";
 <% end -%>

data/lib/chef-cli/helpers.rb

@@ -87,7 +87,7 @@ module ChefCLI
     # On Mac we place all of our symlinks under /usr/local/bin on other
     # platforms they are under /usr/bin
     def usr_bin_prefix
-      @usr_bin_prefix ||= os_x? ? "/usr/local/bin" : "/usr/bin"
+      @usr_bin_prefix ||= macos? ? "/usr/local/bin" : "/usr/bin"
     end
 
     # Returns the full path to the given command under usr_bin_prefix
@@ -117,11 +117,11 @@ module ChefCLI
       @omnibus_env ||=
         begin
           user_bin_dir = File.expand_path(File.join(Gem.user_dir, "bin"))
-          path = [ omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV["PATH"] ]
+          path = [ omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV["PATH"].split(File::PATH_SEPARATOR) ]
           path << git_bin_dir if Dir.exist?(git_bin_dir)
           path << git_windows_bin_dir if Dir.exist?(git_windows_bin_dir)
           {
-            "PATH" => path.join(File::PATH_SEPARATOR),
+            "PATH" => path.flatten.uniq.join(File::PATH_SEPARATOR),
             "GEM_ROOT" => Gem.default_dir,
             "GEM_HOME" => Gem.user_dir,
             "GEM_PATH" => Gem.path.join(File::PATH_SEPARATOR),
@@ -129,8 +129,6 @@ module ChefCLI
         end
     end
 
-    private
-
     def omnibus_expand_path(*paths)
       dir = File.expand_path(File.join(paths))
       raise OmnibusInstallNotFound.new unless dir && File.directory?(dir)
@@ -138,6 +136,8 @@ module ChefCLI
       dir
     end
 
+    private
+
     def expected_omnibus_root
       File.expand_path(File.join(Gem.ruby, "..", "..", ".."))
     end
@@ -166,8 +166,11 @@ module ChefCLI
       end
     end
 
-    # Returns true if we are on Mac OS X. Otherwise false
-    def os_x?
+    # @return [Boolean] Returns true if we are on macOS. Otherwise false
+    #
+    # @api private
+    #
+    def macos?
       !!(RUBY_PLATFORM =~ /darwin/)
     end
   end

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

@@ -92,43 +92,56 @@ 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
 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
 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
 
@@ -177,4 +190,17 @@ if context.vscode_dir
   end
 end
 
-include_recipe '::build_cookbook' if context.enable_workflow
+if context.enable_workflow
+  warn "\n---------WARNING---------\nThe --workflow flag is deprecated as #{ChefCLI::Dist::WORKFLOW} is EOL as of December 2020.\n\nThis flag will be ignored and will be removed in a future release.\n-------------------------\n\n"
+  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

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/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/skeletons/code_generator/templates/default/kitchen_dokken.yml.erb

@@ -1,6 +1,7 @@
 ---
 driver:
   name: dokken
+  privileged: true  # allows systemd services to start
 
 provisioner:
   name: dokken

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