chef-cli 5.0.1 → 5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08825f8c8c80fbf8119e1108de938d1dbe3c108309dfefb4f3454ac9fee3397d'
-  data.tar.gz: b3327078e2ee12265d9aabbeab42c9b510adfb1dad6a17cef3b9b8951239030f
+  metadata.gz: 05bd8553c544e5314b22e44e6a6790b16cf2bc6705945cbd590bc78a5b234f72
+  data.tar.gz: ee861a1b0aa6504b3be69bbb2496dc8892a313122516f76efe6f0c3ef5adc8dd
 SHA512:
-  metadata.gz: 2b579beed9b27e92883fd1990a8de48c36a04d947ff6eed0a01df1bd49c38b3d325cad36dcf1eb8801e6107f6fd3dbaa8b2d8afb29bd51618a9dab5861883d58
-  data.tar.gz: 14a6e42f8b8b24d731639ba48eb16b3dae8de21d35adce5f9bda99d59b1ad47accdd4686c883183328573ee04e14fddf114960705f930d110e490beaa017080a
+  metadata.gz: aed359d7ff0e72ca0fd3d62a83a4ec4e17af40ddfdb40083b0e115f5fe232e596c8b68286f3d7b2a904516ed88f4b885814aba531b987aa53f3dd185dbba3688
+  data.tar.gz: 95185fa6d2557b24a07169d7f36dd0755cd655dbb99245615a428ccfbd4b670ebdeaaf0319690b85ac62da14ed5a0859d28d4dfbe1c5f07b8ba499a7b4ab2438

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/chef-cli.gemspec

@@ -45,7 +45,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "minitar", "~> 0.6"
   gem.add_dependency "chef", ">= 15.0"
   gem.add_dependency "solve", "< 5.0", "> 2.0"
-  gem.add_dependency "addressable", ">= 2.3.5", "< 2.8"
+  gem.add_dependency "addressable", ">= 2.3.5", "< 2.9"
   gem.add_dependency "cookbook-omnifetch", "~> 0.5"
   gem.add_dependency "diff-lcs", ">= 1.0", "< 1.4" # 1.4 changes the output
   gem.add_dependency "pastel", "~> 0.7" # used for policyfile differ

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2019 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -67,6 +67,11 @@ module ChefCLI
         description: "Enable stacktraces and other debug output",
         default:     false
 
+      option :policy_group,
+        long:        "--policy-group POLICY_GROUP",
+        description: "The policy_group to include in the export (default: 'local')",
+        default:     nil
+
       attr_reader :policyfile_relative_path
       attr_reader :export_dir
 
@@ -120,11 +125,14 @@ module ChefCLI
       end
 
       def export_service
-        @export_service ||= PolicyfileServices::ExportRepo.new(policyfile: policyfile_relative_path,
-                                                               export_dir: export_dir,
-                                                               root_dir: Dir.pwd,
-                                                               archive: archive?,
-                                                               force: config[:force])
+        @export_service ||= PolicyfileServices::ExportRepo.new(
+          policyfile: policyfile_relative_path,
+          export_dir: export_dir,
+          root_dir: Dir.pwd,
+          archive: archive?,
+          force: config[:force],
+          policy_group: config[:policy_group]
+        )
       end
 
       def handle_error(error)

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/cookbook_metadata.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef-cli/exceptions.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2019 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -71,6 +71,18 @@ module ChefCLI
   class MissingCookbookLockData < StandardError
   end
 
+  class PolicyfileMissingCookbookMetadata < StandardError
+    def initialize(cookbook_root)
+      super("Policyfile specified to use cookbook metadata, but neither #{cookbook_root}/metadata.rb or #{cookbook_root}/metadata.json was found.")
+    end
+  end
+
+  class PolicyfileBadCookbookMetadata < StandardError
+    def initialize(cookbook_root, e)
+      super("Cookbook metadata for cookbook at #{cookbook_root} could not be parsed:\n    Original Exception: #{e}")
+    end
+  end
+
   class InvalidLockfile < StandardError
   end
 

data/lib/chef-cli/policyfile/dsl.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2019, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -138,6 +138,21 @@ module ChefCLI
         end
       end
 
+      def metadata
+        cookbook_root = storage_config.relative_paths_root
+        unless File.exist?(File.join(cookbook_root, "metadata.rb")) || File.exist?(File.join(cookbook_root, "metadata.json"))
+          raise PolicyfileMissingCookbookMetadata.new(cookbook_root)
+        end
+
+        begin
+          cookbook_name = CookbookMetadata.from_path(cookbook_root).cookbook_name
+        rescue Exception => e
+          raise PolicyfileBadCookbookMetadata.new(cookbook_root, e)
+        end
+        name cookbook_name if name.nil?
+        cookbook(cookbook_name, path: ".")
+      end
+
       def default
         @node_attributes.default
       end

data/lib/chef-cli/policyfile_services/export_repo.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2019 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -33,20 +33,15 @@ module ChefCLI
 
     class ExportRepo
 
-      # Policy groups provide namespaces for policies so that a Chef Infra Server can
-      # have multiple active iterations of a policy at once, but we don't need
-      # this when serving a single exported policy via Chef Zero, so hardcode
-      # it to a "well known" value:
-      POLICY_GROUP = "local".freeze
-
       include Policyfile::StorageConfigDelegation
 
       attr_reader :storage_config
       attr_reader :root_dir
       attr_reader :export_dir
       attr_reader :ui
+      attr_reader :policy_group
 
-      def initialize(policyfile: nil, export_dir: nil, root_dir: nil, archive: false, force: false)
+      def initialize(policyfile: nil, export_dir: nil, root_dir: nil, archive: false, force: false, policy_group: nil)
         @root_dir = root_dir
         @export_dir = File.expand_path(export_dir)
         @archive = archive
@@ -55,6 +50,8 @@ module ChefCLI
 
         @policy_data = nil
         @policyfile_lock = nil
+        @policy_group = policy_group
+        @policy_group ||= "local".freeze
 
         policyfile_rel_path = policyfile || "Policyfile.rb"
         policyfile_full_path = File.expand_path(policyfile_rel_path, root_dir)
@@ -243,7 +240,7 @@ module ChefCLI
             #
 
             policy_name '#{policy_name}'
-            policy_group 'local'
+            policy_group '#{policy_group}'
 
             use_policyfile true
             policy_document_native_api true
@@ -301,9 +298,8 @@ module ChefCLI
             ### policy_groups/
 
             Policy groups are used by Chef Infra Server to manage multiple revisions of the same
-            policy. However, exported policies contain only a single policy revision, so
-            this policy group name is hardcoded to "local" and should not be changed.
-
+            policy. The default "local" policy is recommended for export use since there can be
+            no different revisions when not utilizing a server.
           README
         end
       end
@@ -389,7 +385,7 @@ module ChefCLI
       end
 
       def policy_group_repo_item_path
-        File.join(staging_dir, "policy_groups", "local.json")
+        File.join(staging_dir, "policy_groups", "#{policy_group}.json")
       end
 
       def dot_chef_staging_dir

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.3.1".freeze
 end

data/spec/unit/command/export_spec.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -84,6 +84,10 @@ describe ChefCLI::Command::Export do
         expect(command.export_service.policyfile_filename).to eq(File.expand_path("Policyfile.rb"))
       end
 
+      it "uses the default policy_group name" do
+        expect(command.export_service.policy_group).to eq("local")
+      end
+
     end
 
     context "when a Policyfile relative path and export path are given" do
@@ -98,6 +102,19 @@ describe ChefCLI::Command::Export do
         expect(command.export_service.policyfile_filename).to eq(File.expand_path("CustomNamedPolicy.rb"))
       end
     end
+
+    context "when a policy_group is given" do
+
+      let(:params) { [ "path/to/export", "--policy_group", "production" ] }
+
+      it "configures the export service with the export path" do
+        expect(command.export_service.export_dir).to eq(File.expand_path("path/to/export"))
+      end
+
+      it "configures the export service with the policyfile relative path" do
+        expect(command.export_service.policy_group).to eq("production")
+      end
+    end
   end
 
   describe "running the export" do

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