chef-dk 3.11.3 → 3.12.0

data/lib/chef-dk/chef_server_api_multi.rb

@@ -22,8 +22,8 @@ module ChefDK
   # A wrapper for `Chef::ServerAPI` that supports multi-threading by creating a
   # `Chef::ServerAPI` object per-thread.
   #
-  # This is intended to be used for downloading cookbooks from the Chef Server,
-  # where the API of the Chef Server requires each file to be downloaded
+  # This is intended to be used for downloading cookbooks from the Chef Infa Server,
+  # where the API of the Chef Infra Server requires each file to be downloaded
   # individually.
   #
   # It also configures `Chef::ServerAPI` to enable keepalives by default. To

data/lib/chef-dk/cli.rb

@@ -181,6 +181,7 @@ module ChefDK
     def sanity_check!
       # When installed outside of omnibus, trust the user to configure their PATH
       return true unless omnibus_install?
+
       paths = env[path_key].split(File::PATH_SEPARATOR)
       paths.map! { |p| drive_upcase(Chef::Util::PathHelper.cleanpath(p)) }
       embed_index = paths.index(drive_upcase(Chef::Util::PathHelper.cleanpath(omnibus_embedded_bin_dir)))

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

@@ -28,8 +28,8 @@ module ChefDK
       banner(<<~BANNER)
         Usage: chef 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
+        `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
         revisions are not removed, so you may wish to run `chef clean-policy-revisions`
         to remove orphaned policies before running this command.
@@ -70,6 +70,7 @@ module ChefDK
 
       def run(params)
         return 1 unless apply_params!(params)
+
         clean_policy_cookbooks_service.run
         0
       rescue PolicyfileServiceError => e

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

@@ -28,9 +28,9 @@ module ChefDK
       banner(<<~BANNER)
         Usage: chef 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
+        `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`.
 
         See our detailed README for more information:
@@ -67,6 +67,7 @@ module ChefDK
 
       def run(params)
         return 1 unless apply_params!(params)
+
         clean_policies_service.run
         0
       rescue PolicyfileServiceError => e

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

@@ -67,6 +67,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`.")
         0

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

@@ -62,6 +62,7 @@ module ChefDK
       def run(params = [])
         return 1 unless apply_params!(params)
         return 1 unless check_cookbook_path
+
         IdDumper.new(ui, cookbook_path).run
       end
 

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

@@ -72,28 +72,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
@@ -124,6 +124,7 @@ module ChefDK
 
       def run(params = [])
         return 1 unless apply_params!(params)
+
         print_diff
         0
       rescue PolicyfileServiceError => e
@@ -152,7 +153,7 @@ module ChefDK
         end
       end
 
-      def differ(ui = self.ui())
+      def differ(ui = self.ui)
         Policyfile::Differ.new(old_name: old_base.name,
                                old_lock: old_lock,
                                new_name: new_base.name,
@@ -289,6 +290,7 @@ module ChefDK
       def policy_group_comparison?(args)
         return false if args.empty?
         return true if args.size > 1
+
         !(args.first =~ /\.rb\Z/)
       end
 

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

@@ -83,6 +83,7 @@ module ChefDK
 
       def run(params = [])
         return 1 unless apply_params!(params)
+
         export_service.run
         ui.msg("Exported policy '#{export_service.policyfile_lock.name}' to #{export_target}")
         unless archive?

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

@@ -58,7 +58,7 @@ module ChefDK
       generator(:repo, :Repo, "Generate a Chef code repository")
       generator(:policyfile, :Policyfile, "Generate a Policyfile for use with the install/push commands")
       generator(:generator, :GeneratorGenerator, "Copy ChefDK's generator cookbook so you can customize it")
-      generator(:'build-cookbook', :BuildCookbook, "Generate a build cookbook for use with Delivery")
+      generator(:'build-cookbook', :BuildCookbook, "Generate a build cookbook for use with Workflow")
 
       def self.banner_headline
         <<~E
@@ -114,6 +114,7 @@ module ChefDK
       # we delegate the request to the specified generator.
       def needs_help?(params)
         return false if have_generator?(params[0])
+
         super
       end
 

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

@@ -108,8 +108,8 @@ module ChefDK
           else
             msg("Your cookbook is ready. Type `cd #{cookbook_name_or_path}` to enter it.")
             msg("\nThere are several commands you can run to get started locally developing and testing your cookbook.")
-            msg("Type `delivery local --help` to see a full list.")
-            msg("\nWhy not start by writing a test? Tests for the default recipe are stored at:\n")
+            msg("Type `delivery local --help` to see a full list of local testing commands.")
+            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")

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

@@ -70,6 +70,7 @@ module ChefDK
 
       def run(params = [])
         return 1 unless apply_params!(params)
+
         # Force config file to be loaded. We don't use the configuration
         # directly, but the user may have SSL configuration options that they
         # need to talk to a private supermarket (e.g., trusted_certs or

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

@@ -71,6 +71,7 @@ module ChefDK
 
       def run(params = [])
         return 1 unless apply_params!(params)
+
         push.run
         0
       rescue PolicyfileServiceError => e

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

@@ -97,7 +97,7 @@ module ChefDK
             policy_group: policy_group,
             ui: ui,
             config: chef_config
-        )
+          )
       end
 
       def archive_file

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

@@ -95,7 +95,7 @@ module ChefDK
           return 1
         elsif !SUPPORTED_SHELLS.include?(shell_name)
           err("Shell `#{shell_name}' is not currently supported")
-          err("Supported shells are: #{SUPPORTED_SHELLS.join(' ')}")
+          err("Supported shells are: #{SUPPORTED_SHELLS.join(" ")}")
           return 1
         end
 
@@ -116,6 +116,7 @@ module ChefDK
 
       def completion_for(shell)
         return "" unless (completion_template_basename = completion_template_for(shell))
+
         completion_template_path = expand_completion_template_path(completion_template_basename)
         erb = ERB.new(File.read(completion_template_path), nil, "-")
         context_binding = shell_completion_template_context.get_binding
@@ -165,7 +166,7 @@ module ChefDK
         # /dev/null to avoid Fish's helpful warnings about nonexistent
         # PATH elements.
         if var == "PATH"
-          emit_shell_cmd(%Q{set -gx #{var} "#{val.split(':').join('" "')}" 2>/dev/null;})
+          emit_shell_cmd(%Q{set -gx #{var} "#{val.split(":").join('" "')}" 2>/dev/null;})
         else
           emit_shell_cmd(%Q{set -gx #{var} "#{val}";})
         end

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

@@ -86,6 +86,7 @@ module ChefDK
 
       def run(params)
         return 1 unless apply_params!(params)
+
         show_policy_service.run
         0
       rescue PolicyfileServiceError => e

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

@@ -88,6 +88,7 @@ module ChefDK
 
       def run(params)
         return 1 unless apply_params!(params)
+
         if list_undo_records?
           undelete_service.list
         else

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

@@ -89,6 +89,7 @@ module ChefDK
 
       def run(params = [])
         return 1 unless apply_params!(params)
+
         attributes_updater.run
         installer.run(@cookbooks_to_update, config[:exclude_deps]) unless update_attributes_only?
         0

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

@@ -70,7 +70,7 @@ module ChefDK
       bundle_install_mutex = Mutex.new
 
       #
-      # Components included in Chef Development kit:
+      # Components included in ChefDK:
       # :base_dir => Relative path of the component w.r.t. omnibus_apps_dir
       # :gem_base_dir => Takes a gem name instead and uses first gem found
       # :test_cmd => Test command to be launched for the component
@@ -123,7 +123,7 @@ module ChefDK
 
         c.smoke_test do
           tmpdir do |cwd|
-            File.open(File.join(cwd, ".kitchen.yml"), "w+") do |f|
+            File.open(File.join(cwd, "kitchen.yml"), "w+") do |f|
               f.print(<<~KITCHEN_YML)
                 ---
                 driver:
@@ -321,21 +321,26 @@ module ChefDK
         end
       end
 
-      add_component "generated-cookbooks-pass-chefspec" do |c|
-
+      add_component "generated-cookbooks-pass-chefspec-and-foodcritic" do |c|
         c.gem_base_dir = "chef-dk"
         c.smoke_test do
           tmpdir do |cwd|
             sh("#{bin("chef")} generate cookbook example", cwd: cwd)
             cb_cwd = File.join(cwd, "example")
             sh(embedded_bin("rspec"), cwd: cb_cwd)
+            sh(embedded_bin("foodcritic --tags ~supermarket ."), cwd: cb_cwd)
           end
         end
       end
 
+      add_component "chef-vault" do |c|
+        c.gem_base_dir = "chef-vault"
+        c.smoke_test { sh("#{embedded_bin("chef-vault -h")}") }
+      end
+
       add_component "fauxhai" do |c|
         c.gem_base_dir = "fauxhai"
-        c.smoke_test { sh("#{embedded_bin("gem")} list fauxhai") }
+        c.smoke_test { sh(embedded_bin("fauxhai")) }
       end
 
       add_component "knife-spork" do |c|
@@ -343,12 +348,6 @@ module ChefDK
         c.smoke_test { sh("#{bin("knife")} spork info") }
       end
 
-      add_component "kitchen-vagrant" do |c|
-        c.gem_base_dir = "kitchen-vagrant"
-        # The build is not passing in travis, so no tests
-        c.smoke_test { sh("#{embedded_bin("gem")} list kitchen-vagrant") }
-      end
-
       add_component "package installation" do |c|
 
         c.gem_base_dir = "chef-dk"
@@ -380,6 +379,7 @@ module ChefDK
             sh!("#{usr_bin_path("ohai")} -v")
             sh!("#{usr_bin_path("foodcritic")} -V")
             sh!("#{usr_bin_path("inspec")} version")
+            sh!("#{usr_bin_path("dco")} -h")
           end
 
           # Test blocks are expected to return a Mixlib::ShellOut compatible
@@ -520,7 +520,7 @@ module ChefDK
                 end
               EOF
             end
-            sh("chef-apply foo.rb", cwd: cwd)
+            sh("#{bin("chef-apply")} foo.rb", cwd: cwd)
           end
         end
       end

data/lib/chef-dk/component_test.rb

@@ -144,9 +144,7 @@ module ChefDK
     end
 
     def nix_platform_native_bin_dir
-      if /sunos|solaris/ =~ RUBY_PLATFORM
-        "/opt/local/bin"
-      elsif /darwin/ =~ RUBY_PLATFORM
+      if /darwin/ =~ RUBY_PLATFORM
         "/usr/local/bin"
       else
         "/usr/bin"
@@ -198,6 +196,7 @@ module ChefDK
 
     def gem_base_dir
       return nil if @gem_name_for_base_dir.nil?
+
       # There is no way to say "give me the latest prerelease OR normal version of this gem.
       # So we first ask if there is a normal version, and if there is not, we ask if there
       # is a prerelease version.  ">= 0.a" is how we ask for a prerelease version, because a

data/lib/chef-dk/configurable.rb

@@ -49,6 +49,7 @@ module ChefDK
 
     def chef_config
       return @chef_config if @chef_config
+
       config_loader.load
       @chef_config = Chef::Config
       CookbookOmnifetch.integration.default_chef_server_http_client = default_chef_server_http_client

data/lib/chef-dk/exceptions.rb

@@ -66,7 +66,7 @@ module ChefDK
     def initialize(url, reason = nil)
       @url    = url
       @reason = reason
-      msg     = "'#{@url}' is not a valid Policy File Source URI"
+      msg     = "'#{@url}' is not a valid Policyfile Source URI"
       msg << " #{@reason}." unless @reason.nil?
       super(msg)
     end