chef-dk 4.0.60 → 4.1.7

data/lib/chef-dk/builtin_commands.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2016 Chef Software Inc.
+# Copyright:: Copyright (c) 2016-2019 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,46 +15,48 @@
 # limitations under the License.
 #
 
+require_relative "dist"
+
 ChefDK.commands do |c|
   c.builtin "exec", :Exec, require_path: "chef-dk/command/exec",
                            desc: "Runs the command in context of the embedded ruby"
 
   c.builtin "env", :Env, require_path: "chef-dk/command/env",
-                         desc: "Prints environment variables used by ChefDK"
+                         desc: "Prints environment variables used by #{ChefDK::Dist::PRODUCT}"
 
   c.builtin "gem", :GemForwarder, require_path: "chef-dk/command/gem",
-                                  desc: "Runs the `gem` command in context of the embedded ruby"
+                                  desc: "Runs the `gem` command in context of the embedded Ruby"
 
-  c.builtin "generate", :Generate, desc: "Generate a new app, cookbook, or component"
+  c.builtin "generate", :Generate, desc: "Generate a new repository, cookbook, or other component"
 
-  c.builtin "shell-init", :ShellInit, desc: "Initialize your shell to use ChefDK as your primary ruby"
+  c.builtin "shell-init", :ShellInit, desc: "Initialize your shell to use #{ChefDK::Dist::PRODUCT} as your primary Ruby"
 
   c.builtin "install", :Install, desc: "Install cookbooks from a Policyfile and generate a locked cookbook set"
 
   c.builtin "update", :Update, desc: "Updates a Policyfile.lock.json with latest run_list and cookbooks"
 
-  c.builtin "push", :Push, desc: "Push a local policy lock to a policy group on the server"
+  c.builtin "push", :Push, desc: "Push a local policy lock to a policy group on the #{ChefDK::Dist::SERVER_PRODUCT}"
 
-  c.builtin "push-archive", :PushArchive, desc: "Push a policy archive to a policy group on the server"
+  c.builtin "push-archive", :PushArchive, desc: "Push a policy archive to a policy group on the #{ChefDK::Dist::SERVER_PRODUCT}"
 
-  c.builtin "show-policy", :ShowPolicy, desc: "Show policyfile objects on your Chef Infra Server"
+  c.builtin "show-policy", :ShowPolicy, desc: "Show policyfile objects on the #{ChefDK::Dist::SERVER_PRODUCT}"
 
   c.builtin "diff", :Diff, desc: "Generate an itemized diff of two Policyfile lock documents"
 
-  c.builtin "export", :Export, desc: "Export a policy lock as a Chef Zero code repo"
+  c.builtin "export", :Export, desc: "Export a policy lock as a #{ChefDK::Dist::ZERO_PRODUCT} code repo"
 
-  c.builtin "clean-policy-revisions", :CleanPolicyRevisions, desc: "Delete unused policy revisions on the server"
+  c.builtin "clean-policy-revisions", :CleanPolicyRevisions, desc: "Delete unused policy revisions on the #{ChefDK::Dist::SERVER_PRODUCT}"
 
-  c.builtin "clean-policy-cookbooks", :CleanPolicyCookbooks, desc: "Delete unused policyfile cookbooks on the server"
+  c.builtin "clean-policy-cookbooks", :CleanPolicyCookbooks, desc: "Delete unused policyfile cookbooks on the #{ChefDK::Dist::SERVER_PRODUCT}"
 
-  c.builtin "delete-policy-group", :DeletePolicyGroup, desc: "Delete a policy group on the server"
+  c.builtin "delete-policy-group", :DeletePolicyGroup, desc: "Delete a policy group on the #{ChefDK::Dist::SERVER_PRODUCT}"
 
-  c.builtin "delete-policy", :DeletePolicy, desc: "Delete all revisions of a policy on the server"
+  c.builtin "delete-policy", :DeletePolicy, desc: "Delete all revisions of a policy on the #{ChefDK::Dist::SERVER_PRODUCT}"
 
   c.builtin "undelete", :Undelete, desc: "Undo a delete command"
 
   c.builtin "describe-cookbook", :DescribeCookbook, require_path: "chef-dk/command/describe_cookbook",
                                                     desc: "Prints cookbook checksum information used for cookbook identifier"
 
-  c.builtin "verify", :Verify, desc: "Test the embedded ChefDK applications", hidden: true
+  c.builtin "verify", :Verify, desc: "Test the embedded #{ChefDK::Dist::PRODUCT} applications", hidden: true
 end

data/lib/chef-dk/chef_runner.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018 Chef Software Inc.
+# Copyright:: Copyright (c) 2014-2019 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,13 +15,13 @@
 # limitations under the License.
 #
 
-require "chef-dk/exceptions"
-require "chef-dk/service_exceptions"
+require_relative "exceptions"
+require_relative "service_exceptions"
 require "chef/policy_builder/dynamic"
 require "chef"
 
-require "chef-dk/command/generator_commands/chef_exts/quieter_doc_formatter"
-require "chef-dk/command/generator_commands/chef_exts/recipe_dsl_ext"
+require_relative "command/generator_commands/chef_exts/quieter_doc_formatter"
+require_relative "command/generator_commands/chef_exts/recipe_dsl_ext"
 
 module ChefDK
 
@@ -45,7 +45,7 @@ module ChefDK
       message = "Could not find cookbook(s) to satisfy run list #{run_list.inspect} in #{cookbook_path}"
       raise CookbookNotFound.new(message, e)
     rescue => e
-      raise ChefConvergeError.new("Chef failed to converge: #{e} from file #{e.backtrace.first}", e)
+      raise ChefConvergeError.new("#{ChefDK::Dist::INFRA_PRODUCT} failed to converge: #{e} from file #{e.backtrace.first}", e)
     end
 
     def run_context

data/lib/chef-dk/cli.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018 Chef Software Inc.
+# Copyright:: Copyright (c) 2014-2019 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,12 +15,13 @@
 # limitations under the License.
 #
 
-require "mixlib/cli"
-require "chef-dk/version"
-require "chef-dk/commands_map"
-require "chef-dk/builtin_commands"
-require "chef-dk/helpers"
-require "chef-dk/ui"
+require "mixlib/cli" unless defined?(Mixlib::CLI)
+require_relative "version"
+require_relative "commands_map"
+require_relative "builtin_commands"
+require_relative "helpers"
+require_relative "ui"
+require_relative "dist"
 require "chef/util/path_helper"
 require "chef/mixin/shell_out"
 require "bundler"
@@ -41,7 +42,7 @@ module ChefDK
     option :version,
       short: "-v",
       long: "--version",
-      description: "Show chef version",
+      description: "Show #{ChefDK::Dist::PRODUCT} version",
       boolean: true
 
     option :help,
@@ -95,15 +96,19 @@ module ChefDK
     end
 
     def show_version
-      msg("Chef Development Kit Version: #{ChefDK::VERSION}")
-
-      ["chef-client", "delivery", "berks", "kitchen", "inspec"].each do |component|
-        result = Bundler.with_clean_env { shell_out("#{component} --version") }
+      msg("#{ChefDK::Dist::PRODUCT} version: #{ChefDK::VERSION}")
+      { "#{ChefDK::Dist::INFRA_CLIENT_PRODUCT}": "#{ChefDK::Dist::INFRA_CLIENT_CLI}",
+        "#{ChefDK::Dist::INSPEC_PRODUCT}": "#{ChefDK::Dist::INSPEC_CLI}",
+        "Test Kitchen": "kitchen",
+        "Foodcritic": "foodcritic",
+        "Cookstyle": "cookstyle",
+      }.each do |name, cli|
+        result = Bundler.with_clean_env { shell_out("#{cli} --version") }
         if result.exitstatus != 0
-          msg("#{component} version: ERROR")
+          msg("#{name} version: ERROR")
         else
           version = result.stdout.lines.first.scan(/(?:master\s)?[\d+\.\(\)]+\S+/).join("\s")
-          msg("#{component} version: #{version}")
+          msg("#{name} version: #{version}")
         end
       end
     end
@@ -189,11 +194,11 @@ module ChefDK
         if bin_index
           if embed_index < bin_index
             err("WARN: #{omnibus_embedded_bin_dir} is before #{omnibus_bin_dir} in your #{path_key}, please reverse that order.")
-            err("WARN: consider using the correct `chef shell-init <shell>` command to setup your environment correctly.")
+            err("WARN: consider using the correct `#{ChefDK::Dist::EXEC} shell-init <shell>` command to setup your environment correctly.")
           end
         else
           err("WARN: only #{omnibus_embedded_bin_dir} is present in your path, you must add #{omnibus_bin_dir} before that directory.")
-          err("WARN: consider using the correct `chef shell-init <shell>` command to setup your environment correctly.")
+          err("WARN: consider using the correct `#{ChefDK::Dist::EXEC} shell-init <shell>` command to setup your environment correctly.")
         end
       end
     end

data/lib/chef-dk/command/base.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018 Chef Software Inc.
+# Copyright:: Copyright (c) 2014-2019 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,12 +15,13 @@
 # limitations under the License.
 #
 
-require "mixlib/cli"
-require "chef-dk/helpers"
-require "chef-dk/version"
+require "mixlib/cli" unless defined?(Mixlib::CLI)
+require_relative "../helpers"
+require_relative "../version"
 require "chef/exceptions"
 require "license_acceptance/acceptor"
 require "license_acceptance/cli_flags/mixlib_cli"
+require_relative "../dist"
 
 module ChefDK
   module Command
@@ -38,7 +39,7 @@ module ChefDK
       option :version,
         short: "-v",
         long: "--version",
-        description: "Show chef version",
+        description: "Show #{ChefDK::Dist::PRODUCT} version",
         boolean: true
 
       def initialize
@@ -55,7 +56,7 @@ module ChefDK
           msg(opt_parser.to_s)
           0
         elsif needs_version?(params)
-          msg("Chef Development Kit Version: #{ChefDK::VERSION}")
+          msg("#{ChefDK::Dist::PRODUCT} version: #{ChefDK::VERSION}")
           0
         else
           check_license_acceptance if enforce_license

data/lib/chef-dk/command/clean_policy_cookbooks.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef Software Inc.
+# Copyright:: Copyright (c) 2015-2019 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,10 +15,11 @@
 # limitations under the License.
 #
 
-require "chef-dk/command/base"
-require "chef-dk/ui"
-require "chef-dk/configurable"
-require "chef-dk/policyfile_services/clean_policy_cookbooks"
+require_relative "base"
+require_relative "../ui"
+require_relative "../configurable"
+require_relative "../policyfile_services/clean_policy_cookbooks"
+require_relative "../dist"
 
 module ChefDK
   module Command
@@ -26,11 +27,11 @@ module ChefDK
     class CleanPolicyCookbooks < Base
 
       banner(<<~BANNER)
-        Usage: chef clean-policy-cookbooks [options]
+        Usage: #{ChefDK::Dist::EXEC} clean-policy-cookbooks [options]
 
-        `chef clean-policy-cookbooks` deletes unused policyfile cookbooks. Cookbooks
-        are considered unused when they are not referenced by any policyfile revision
-        on the server. Note that cookbooks which are referenced by "orphaned" policy
+        `#{ChefDK::Dist::EXEC} clean-policy-cookbooks` deletes unused Policyfile cookbooks. Cookbooks
+        are considered unused when they are not referenced by any Policyfile revision
+        on the #{ChefDK::Dist::SERVER_PRODUCT}. Note that cookbooks which are referenced by "orphaned" policy
         revisions are not removed, so you may wish to run `chef clean-policy-revisions`
         to remove orphaned policies before running this command.
 

data/lib/chef-dk/command/clean_policy_revisions.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef Software Inc.
+# Copyright:: Copyright (c) 2015-2019 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,10 +15,11 @@
 # limitations under the License.
 #
 
-require "chef-dk/command/base"
-require "chef-dk/ui"
-require "chef-dk/configurable"
-require "chef-dk/policyfile_services/clean_policies"
+require_relative "base"
+require_relative "../ui"
+require_relative "../configurable"
+require_relative "../policyfile_services/clean_policies"
+require_relative "../dist"
 
 module ChefDK
   module Command
@@ -26,12 +27,12 @@ module ChefDK
     class CleanPolicyRevisions < Base
 
       banner(<<~BANNER)
-        Usage: chef clean-policy-revisions [options]
+        Usage: #{ChefDK::Dist::EXEC} clean-policy-revisions [options]
 
-        `chef clean-policy-revisions` deletes orphaned policyfile revisions from the Chef
-        Server. Orphaned policyfile revisions are not associated to any group, and
-        therefore not in active use by any nodes. To list orphaned policyfile revisions
-        before deleting them, use `chef show-policy --orphans`.
+        `#{ChefDK::Dist::EXEC} clean-policy-revisions` deletes orphaned Policyfile revisions from the
+        #{ChefDK::Dist::SERVER_PRODUCT}. Orphaned Policyfile revisions are not associated to any group, and
+        therefore not in active use by any nodes. To list orphaned Policyfile revisions before deleting
+        them, use `#{ChefDK::Dist::EXEC} show-policy --orphans`.
 
         See our detailed README for more information:
 

data/lib/chef-dk/command/delete_policy.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef Software Inc.
+# Copyright:: Copyright (c) 2015-2019 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,10 +15,11 @@
 # limitations under the License.
 #
 
-require "chef-dk/command/base"
-require "chef-dk/ui"
-require "chef-dk/configurable"
-require "chef-dk/policyfile_services/rm_policy"
+require_relative "base"
+require_relative "../ui"
+require_relative "../configurable"
+require_relative "../policyfile_services/rm_policy"
+require_relative "../dist"
 
 module ChefDK
   module Command
@@ -26,10 +27,10 @@ module ChefDK
     class DeletePolicy < Base
 
       banner(<<~BANNER)
-        Usage: chef delete-policy POLICY_NAME [options]
+        Usage: #{ChefDK::Dist::EXEC} delete-policy POLICY_NAME [options]
 
-        `chef delete-policy POLICY_NAME` deletes all revisions of the policy
-        `POLICY_NAME` on the configured Chef Infra Server. All policy revisions will be
+        `#{ChefDK::Dist::EXEC} delete-policy POLICY_NAME` deletes all revisions of the policy
+        `POLICY_NAME` on the configured #{ChefDK::Dist::SERVER_PRODUCT}. All policy revisions will be
         backed up locally, allowing you to undo this operation via the `chef undelete`
         command.
 
@@ -68,7 +69,7 @@ module ChefDK
       def run(params)
         return 1 unless apply_params!(params)
         rm_policy_service.run
-        ui.msg("This operation can be reversed by running `chef undelete --last`.")
+        ui.msg("This operation can be reversed by running `#{ChefDK::Dist::EXEC} undelete --last`.")
         0
       rescue PolicyfileServiceError => e
         handle_error(e)

data/lib/chef-dk/command/delete_policy_group.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef Software Inc.
+# Copyright:: Copyright (c) 2015-2019 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,10 +15,11 @@
 # limitations under the License.
 #
 
-require "chef-dk/command/base"
-require "chef-dk/ui"
-require "chef-dk/configurable"
-require "chef-dk/policyfile_services/rm_policy_group"
+require_relative "base"
+require_relative "../ui"
+require_relative "../configurable"
+require_relative "../policyfile_services/rm_policy_group"
+require_relative "../dist"
 
 module ChefDK
   module Command
@@ -26,10 +27,10 @@ module ChefDK
     class DeletePolicyGroup < Base
 
       banner(<<~BANNER)
-        Usage: chef delete-policy-group POLICY_GROUP [options]
+        Usage: #{ChefDK::Dist::EXEC} delete-policy-group POLICY_GROUP [options]
 
-        `chef delete-policy-group POLICY_GROUP` deletes the policy group POLICY_GROUP on
-        the configured Chef Infra Server. Policy Revisions associated to the policy group are
+        `#{ChefDK::Dist::EXEC} delete-policy-group POLICY_GROUP` deletes the policy group POLICY_GROUP on
+        the configured #{ChefDK::Dist::SERVER_PRODUCT}. Policy Revisions associated to the policy group are
         not deleted. The state of the policy group will be backed up locally, allowing
         you to undo this operation via the `chef undelete` command.
 
@@ -68,7 +69,7 @@ module ChefDK
       def run(params)
         return 1 unless apply_params!(params)
         rm_policy_group_service.run
-        ui.msg("This operation can be reversed by running `chef undelete --last`.")
+        ui.msg("This operation can be reversed by running `#{ChefDK::Dist::EXEC} undelete --last`.")
         0
       rescue PolicyfileServiceError => e
         handle_error(e)

data/lib/chef-dk/command/describe_cookbook.rb

@@ -1,6 +1,7 @@
-require "chef-dk/command/base"
-require "chef-dk/ui"
-require "chef-dk/cookbook_profiler/identifiers"
+require_relative "base"
+require_relative "../ui"
+require_relative "../cookbook_profiler/identifiers"
+require_relative "../dist"
 
 module ChefDK
   class IdDumper
@@ -48,7 +49,7 @@ module ChefDK
 
     class DescribeCookbook < ChefDK::Command::Base
 
-      banner "Usage: chef describe-cookbook <path/to/cookbook>"
+      banner "Usage: #{ChefDK::Dist::EXEC} describe-cookbook <path/to/cookbook>"
 
       attr_reader :cookbook_path
       attr_reader :ui

data/lib/chef-dk/command/diff.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef Software Inc.
+# Copyright:: Copyright (c) 2015-2019 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,13 +15,14 @@
 # limitations under the License.
 #
 
-require "chef-dk/command/base"
-require "chef-dk/ui"
-require "chef-dk/pager"
-require "chef-dk/policyfile/differ"
-require "chef-dk/policyfile/comparison_base"
-require "chef-dk/policyfile/storage_config"
-require "chef-dk/configurable"
+require_relative "base"
+require_relative "../ui"
+require_relative "../pager"
+require_relative "../policyfile/differ"
+require_relative "../policyfile/comparison_base"
+require_relative "../policyfile/storage_config"
+require_relative "../configurable"
+require_relative "../dist"
 require "chef/server_api"
 
 module ChefDK
@@ -33,36 +34,36 @@ module ChefDK
       include Policyfile::StorageConfigDelegation
 
       banner(<<~BANNER)
-        Usage: chef diff [POLICYFILE] [--head | --git GIT_REF | POLICY_GROUP | POLICY_GROUP...POLICY_GROUP ]
+        Usage: #{ChefDK::Dist::EXEC} diff [POLICYFILE] [--head | --git GIT_REF | POLICY_GROUP | POLICY_GROUP...POLICY_GROUP ]
 
-        `chef diff` displays an itemized diff comparing two revisions of a
+        `#{ChefDK::Dist::EXEC} diff` displays an itemized diff comparing two revisions of a
         Policyfile lock.
 
-        When the `--git` option is given, `chef diff` either compares a given
+        When the `--git` option is given, `#{ChefDK::Dist::EXEC} diff` either compares a given
         git reference against the current lockfile revision on disk or compares
         between two git references. Examples:
 
-        * `chef diff --git HEAD`: compares the current lock with the latest
+        * `#{ChefDK::Dist::EXEC} diff --git HEAD`: compares the current lock with the latest
           commit on the current branch.
-        * `chef diff --git master` compares the current lock with the latest
+        * `#{ChefDK::Dist::EXEC} diff --git master`: compares the current lock with the latest
           commit to master.
-        * `chef diff --git v1.0.0`: compares the current lock with the revision
+        * `#{ChefDK::Dist::EXEC} diff --git v1.0.0`: compares the current lock with the revision
           as of the `v1.0.0` tag.
-        * `chef diff --git master...dev-branch` compares the Policyfile lock on
+        * `#{ChefDK::Dist::EXEC} diff --git master...dev-branch`: compares the Policyfile lock on
           master with the revision on the `dev-branch` branch.
-        * `chef diff --git v1.0.0...master` compares the Policyfile lock at the
+        * `#{ChefDK::Dist::EXEC} diff --git v1.0.0...master`: compares the Policyfile lock at the
           `v1.0.0` tag with the lastest revision on the master branch.
 
-        `chef diff --head` is a shortcut for `chef diff --git HEAD`.
+        `#{ChefDK::Dist::EXEC} diff --head` is a shortcut for `#{ChefDK::Dist::EXEC} diff --git HEAD`.
 
-        When no git-specific flag is given, `chef diff` either compares the
-        current lockfile revision on disk to one on the server or compares two
-        lockfiles on the server. Lockfiles on the Chef Infra Server are specified by
-        Policy Group. Examples:
+        When no git-specific flag is given, `#{ChefDK::Dist::EXEC} diff` either compares the
+        current lockfile revision on disk to one on the #{ChefDK::Dist::SERVER_PRODUCT} or compares
+        two lockfiles on the #{ChefDK::Dist::SERVER_PRODUCT}. Lockfiles on the #{ChefDK::Dist::SERVER_PRODUCT}
+        are specified by Policy Group. Examples:
 
-        * `chef diff staging`: compares the current lock with the one currently
+        * `#{ChefDK::Dist::EXEC} diff staging`: compares the current lock with the one currently
           assigned to the `staging` Policy Group.
-        * `chef diff production...staging` compares the lock currently assigned
+        * `#{ChefDK::Dist::EXEC} diff production...staging`: compares the lock currently assigned
           to the `production` Policy Group to the lock currently assigned to the
           `staging` Policy Group.
 
@@ -72,28 +73,28 @@ module ChefDK
       option :git,
         short:       "-g GIT_REF",
         long:        "--git GIT_REF",
-        description: "Compare local lock against GIT_REF, or between two git commits"
+        description: "Compare local lock against GIT_REF, or between two git commits."
 
       option :head,
         long:        "--head",
-        description: "Compare local lock against last git commit",
+        description: "Compare local lock against last git commit.",
         boolean:     true
 
       option :pager,
         long:        "--[no-]pager",
-        description: "Enable/disable paged diff ouput (default: enabled)",
+        description: "Enable/disable paged diff ouput (default: enabled).",
         default:     true,
         boolean:     true
 
       option :config_file,
         short:       "-c CONFIG_FILE",
         long:        "--config CONFIG_FILE",
-        description: "Path to configuration file"
+        description: "Path to configuration file."
 
       option :debug,
         short:       "-D",
         long:        "--debug",
-        description: "Enable stacktraces and other debug output",
+        description: "Enable stacktraces and other debug output.",
         default:     false
 
       attr_accessor :ui