chef-dk 0.11.2 → 0.12.0

data/lib/chef-dk/builtin_commands.rb

@@ -1,60 +1,60 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-
-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"
-
-  c.builtin "gem", :GemForwarder, require_path: "chef-dk/command/gem",
-    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 "shell-init", :ShellInit, desc: "Initialize your shell to use ChefDK 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-archive", :PushArchive, desc: "Push a policy archive to a policy group on the server"
-
-  c.builtin "show-policy", :ShowPolicy, desc: "Show policyfile objects on your Chef Server"
-
-  c.builtin "diff", :Diff, desc: "Generate an itemized diff of two Policyfile lock documents"
-
-  c.builtin "provision", :Provision, desc: "Provision VMs and clusters via cookbook"
-
-  c.builtin "export", :Export, desc: "Export a policy lock as a Chef Zero code repo"
-
-  c.builtin "clean-policy-revisions", :CleanPolicyRevisions, desc: "Delete unused policy revisions on the server"
-
-  c.builtin "clean-policy-cookbooks", :CleanPolicyCookbooks, desc: "Delete unused policyfile cookbooks on the server"
-
-  c.builtin "delete-policy-group", :DeletePolicyGroup, desc: "Delete a policy group on the server"
-
-  c.builtin "delete-policy", :DeletePolicy, desc: "Delete all revisions of a policy on the server"
-
-  c.builtin "undelete", :Undelete, desc: "Undo a delete command"
-
-  c.builtin "verify", :Verify, desc: "Test the embedded ChefDK applications"
-end
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+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"
+
+  c.builtin "gem", :GemForwarder, require_path: "chef-dk/command/gem",
+    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 "shell-init", :ShellInit, desc: "Initialize your shell to use ChefDK 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-archive", :PushArchive, desc: "Push a policy archive to a policy group on the server"
+
+  c.builtin "show-policy", :ShowPolicy, desc: "Show policyfile objects on your Chef Server"
+
+  c.builtin "diff", :Diff, desc: "Generate an itemized diff of two Policyfile lock documents"
+
+  c.builtin "provision", :Provision, desc: "Provision VMs and clusters via cookbook"
+
+  c.builtin "export", :Export, desc: "Export a policy lock as a Chef Zero code repo"
+
+  c.builtin "clean-policy-revisions", :CleanPolicyRevisions, desc: "Delete unused policy revisions on the server"
+
+  c.builtin "clean-policy-cookbooks", :CleanPolicyCookbooks, desc: "Delete unused policyfile cookbooks on the server"
+
+  c.builtin "delete-policy-group", :DeletePolicyGroup, desc: "Delete a policy group on the server"
+
+  c.builtin "delete-policy", :DeletePolicy, desc: "Delete all revisions of a policy on the server"
+
+  c.builtin "undelete", :Undelete, desc: "Undo a delete command"
+
+  c.builtin "verify", :Verify, desc: "Test the embedded ChefDK applications"
+end

data/lib/chef-dk/chef_runner.rb

@@ -1,107 +1,107 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require 'chef-dk/exceptions'
-require 'chef-dk/service_exceptions'
-require 'chef/policy_builder/dynamic'
-require 'chef'
-
-module ChefDK
-  # An adapter to chef's APIs to kick off a chef-client run.
-  class ChefRunner
-
-    attr_reader :cookbook_path
-    attr_reader :run_list
-
-    def initialize(cookbook_path, run_list)
-      @cookbook_path = File.expand_path(cookbook_path)
-      @run_list = run_list
-      @formatter = nil
-      @ohai = nil
-    end
-
-    def converge
-      configure
-      Chef::Runner.new(run_context).converge
-    rescue Chef::Exceptions::CookbookNotFound => e
-      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}", e)
-    end
-
-    def run_context
-      @run_context ||= policy.setup_run_context
-    end
-
-    def policy
-      return @policy_builder if @policy_builder
-
-      @policy_builder = Chef::PolicyBuilder::Dynamic.new("chef-dk", ohai.data, {}, nil, formatter)
-      @policy_builder.load_node
-      @policy_builder.build_node
-      @policy_builder.node.run_list(*run_list)
-      @policy_builder.expand_run_list
-      @policy_builder
-    end
-
-    def formatter
-      @formatter ||=
-        Chef::EventDispatch::Dispatcher.new.tap do |d|
-          d.register(Chef::Formatters.new(:doc, stdout, stderr))
-        end
-    end
-
-    def configure
-      Chef::Config.solo = true
-      Chef::Config.cookbook_path = cookbook_path
-      Chef::Config.color = true
-      Chef::Config.diff_disabled = true
-
-      # If the user has set policyfile configuration in the workstation config
-      # file, the underlying chef-client code may enable policyfile mode and
-      # then fail because chef-solo doesn't support policyfiles.
-      Chef::Config.use_policyfile = false
-      Chef::Config.policy_name = nil
-      Chef::Config.policy_group = nil
-      Chef::Config.deployment_group = nil
-
-      # atomic file operations on Windows require Administrator privileges to be able to read the SACL from a file
-      # Using file_staging_uses_destdir(true) will get us inherited permissions indirectly on tempfile creation
-      Chef::Config.file_atomic_update = false if Chef::Platform.windows?
-      Chef::Config.file_staging_uses_destdir = true # Default in Chef 12+
-    end
-
-    def ohai
-      return @ohai if @ohai
-
-      @ohai = Ohai::System.new
-      @ohai.all_plugins(["platform", "platform_version"])
-      @ohai
-    end
-
-    def stdout
-      $stdout
-    end
-
-    def stderr
-      $stderr
-    end
-
-  end
-end
-
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef-dk/exceptions'
+require 'chef-dk/service_exceptions'
+require 'chef/policy_builder/dynamic'
+require 'chef'
+
+module ChefDK
+  # An adapter to chef's APIs to kick off a chef-client run.
+  class ChefRunner
+
+    attr_reader :cookbook_path
+    attr_reader :run_list
+
+    def initialize(cookbook_path, run_list)
+      @cookbook_path = File.expand_path(cookbook_path)
+      @run_list = run_list
+      @formatter = nil
+      @ohai = nil
+    end
+
+    def converge
+      configure
+      Chef::Runner.new(run_context).converge
+    rescue Chef::Exceptions::CookbookNotFound => e
+      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}", e)
+    end
+
+    def run_context
+      @run_context ||= policy.setup_run_context
+    end
+
+    def policy
+      return @policy_builder if @policy_builder
+
+      @policy_builder = Chef::PolicyBuilder::Dynamic.new("chef-dk", ohai.data, {}, nil, formatter)
+      @policy_builder.load_node
+      @policy_builder.build_node
+      @policy_builder.node.run_list(*run_list)
+      @policy_builder.expand_run_list
+      @policy_builder
+    end
+
+    def formatter
+      @formatter ||=
+        Chef::EventDispatch::Dispatcher.new.tap do |d|
+          d.register(Chef::Formatters.new(:doc, stdout, stderr))
+        end
+    end
+
+    def configure
+      Chef::Config.solo = true
+      Chef::Config.cookbook_path = cookbook_path
+      Chef::Config.color = true
+      Chef::Config.diff_disabled = true
+
+      # If the user has set policyfile configuration in the workstation config
+      # file, the underlying chef-client code may enable policyfile mode and
+      # then fail because chef-solo doesn't support policyfiles.
+      Chef::Config.use_policyfile = false
+      Chef::Config.policy_name = nil
+      Chef::Config.policy_group = nil
+      Chef::Config.deployment_group = nil
+
+      # atomic file operations on Windows require Administrator privileges to be able to read the SACL from a file
+      # Using file_staging_uses_destdir(true) will get us inherited permissions indirectly on tempfile creation
+      Chef::Config.file_atomic_update = false if Chef::Platform.windows?
+      Chef::Config.file_staging_uses_destdir = true # Default in Chef 12+
+    end
+
+    def ohai
+      return @ohai if @ohai
+
+      @ohai = Ohai::System.new
+      @ohai.all_plugins(["platform", "platform_version"])
+      @ohai
+    end
+
+    def stdout
+      $stdout
+    end
+
+    def stderr
+      $stderr
+    end
+
+  end
+end
+

data/lib/chef-dk/cli.rb

@@ -1,200 +1,200 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# 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 'chef/util/path_helper'
-require 'chef/mixin/shell_out'
-require 'bundler'
-
-module ChefDK
-  class CLI
-    include Mixlib::CLI
-    include ChefDK::Helpers
-    include Chef::Mixin::ShellOut
-
-    banner(<<-BANNER)
-Usage:
-    chef -h/--help
-    chef -v/--version
-    chef command [arguments...] [options...]
-BANNER
-
-    option :version,
-      :short        => "-v",
-      :long         => "--version",
-      :description  => "Show chef version",
-      :boolean      => true
-
-    option :help,
-      :short        => "-h",
-      :long         => "--help",
-      :description  => "Show this message",
-      :boolean      => true
-
-    attr_reader :argv
-
-    def initialize(argv)
-      @argv = argv
-      super() # mixlib-cli #initialize doesn't allow arguments
-    end
-
-    def run
-      sanity_check!
-
-      subcommand_name, *subcommand_params = argv
-
-      #
-      # Runs the appropriate subcommand if the given parameters contain any
-      # subcommands.
-      #
-      if subcommand_name.nil? || option?(subcommand_name)
-        handle_options
-      elsif have_command?(subcommand_name)
-        subcommand = instantiate_subcommand(subcommand_name)
-        exit_code = subcommand.run_with_default_options(subcommand_params)
-        exit normalized_exit_code(exit_code)
-      else
-        err "Unknown command `#{subcommand_name}'."
-        show_help
-        exit 1
-      end
-    rescue OptionParser::InvalidOption => e
-      err(e.message)
-      show_help
-      exit 1
-    end
-
-    # If no subcommand is given, then this class is handling the CLI request.
-    def handle_options
-      parse_options(argv)
-      if config[:version]
-        show_version
-      else
-        show_help
-      end
-      exit 0
-    end
-
-    def show_version
-      msg("Chef Development Kit Version: #{ChefDK::VERSION}")
-
-      ["chef-client", "berks", "kitchen"].each do |component|
-        result = Bundler.with_clean_env { shell_out("#{component} --version") }
-        if result.exitstatus != 0
-          msg("#{component} version: ERROR")
-        else
-          version = result.stdout.scan(/[\d+\.]+\S+/).join
-          msg("#{component} version: #{version}")
-        end
-      end
-    end
-
-    def show_help
-      msg(banner)
-      msg("\nAvailable Commands:")
-
-      justify_length = subcommands.map(&:length).max + 2
-      subcommand_specs.each do |name, spec|
-        msg("    #{"#{name}".ljust(justify_length)}#{spec.description}")
-      end
-    end
-
-    def exit(n)
-      Kernel.exit(n)
-    end
-
-    def commands_map
-      ChefDK.commands_map
-    end
-
-    def have_command?(name)
-      commands_map.have_command?(name)
-    end
-
-    def subcommands
-      commands_map.command_names
-    end
-
-    def subcommand_specs
-      commands_map.command_specs
-    end
-
-    def option?(param)
-      param =~ /^-/
-    end
-
-    def instantiate_subcommand(name)
-      commands_map.instantiate(name)
-    end
-
-    private
-
-    def normalized_exit_code(maybe_integer)
-      if maybe_integer.kind_of?(Integer) and (0..255).include?(maybe_integer)
-        maybe_integer
-      else
-        0
-      end
-    end
-
-    # Find PATH or Path correctly if we are on Windows
-    def path_key
-      env.keys.grep(/\Apath\Z/i).first
-    end
-
-    # upcase drive letters for comparison since ruby has a String#capitalize function
-    def drive_upcase(path)
-      if Chef::Platform.windows? && path[0] =~ /^[A-Za-z]$/ && path[1,2] == ":\\"
-        path.capitalize
-      else
-        path
-      end
-    end
-
-    def env
-      ENV
-    end
-
-    # catch the cases where users setup only the embedded_bin_dir in their path, or
-    # when they have the embedded_bin_dir before the omnibus_bin_dir -- both of which will
-    # defeat appbundler and interact very badly with our intent.
-    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)))
-      bin_index = paths.index(drive_upcase(Chef::Util::PathHelper.cleanpath(omnibus_bin_dir)))
-      if embed_index
-        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.")
-          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.")
-        end
-      end
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# 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 'chef/util/path_helper'
+require 'chef/mixin/shell_out'
+require 'bundler'
+
+module ChefDK
+  class CLI
+    include Mixlib::CLI
+    include ChefDK::Helpers
+    include Chef::Mixin::ShellOut
+
+    banner(<<-BANNER)
+Usage:
+    chef -h/--help
+    chef -v/--version
+    chef command [arguments...] [options...]
+BANNER
+
+    option :version,
+      :short        => "-v",
+      :long         => "--version",
+      :description  => "Show chef version",
+      :boolean      => true
+
+    option :help,
+      :short        => "-h",
+      :long         => "--help",
+      :description  => "Show this message",
+      :boolean      => true
+
+    attr_reader :argv
+
+    def initialize(argv)
+      @argv = argv
+      super() # mixlib-cli #initialize doesn't allow arguments
+    end
+
+    def run
+      sanity_check!
+
+      subcommand_name, *subcommand_params = argv
+
+      #
+      # Runs the appropriate subcommand if the given parameters contain any
+      # subcommands.
+      #
+      if subcommand_name.nil? || option?(subcommand_name)
+        handle_options
+      elsif have_command?(subcommand_name)
+        subcommand = instantiate_subcommand(subcommand_name)
+        exit_code = subcommand.run_with_default_options(subcommand_params)
+        exit normalized_exit_code(exit_code)
+      else
+        err "Unknown command `#{subcommand_name}'."
+        show_help
+        exit 1
+      end
+    rescue OptionParser::InvalidOption => e
+      err(e.message)
+      show_help
+      exit 1
+    end
+
+    # If no subcommand is given, then this class is handling the CLI request.
+    def handle_options
+      parse_options(argv)
+      if config[:version]
+        show_version
+      else
+        show_help
+      end
+      exit 0
+    end
+
+    def show_version
+      msg("Chef Development Kit Version: #{ChefDK::VERSION}")
+
+      ["chef-client", "berks", "kitchen"].each do |component|
+        result = Bundler.with_clean_env { shell_out("#{component} --version") }
+        if result.exitstatus != 0
+          msg("#{component} version: ERROR")
+        else
+          version = result.stdout.scan(/[\d+\.]+\S+/).join
+          msg("#{component} version: #{version}")
+        end
+      end
+    end
+
+    def show_help
+      msg(banner)
+      msg("\nAvailable Commands:")
+
+      justify_length = subcommands.map(&:length).max + 2
+      subcommand_specs.each do |name, spec|
+        msg("    #{"#{name}".ljust(justify_length)}#{spec.description}")
+      end
+    end
+
+    def exit(n)
+      Kernel.exit(n)
+    end
+
+    def commands_map
+      ChefDK.commands_map
+    end
+
+    def have_command?(name)
+      commands_map.have_command?(name)
+    end
+
+    def subcommands
+      commands_map.command_names
+    end
+
+    def subcommand_specs
+      commands_map.command_specs
+    end
+
+    def option?(param)
+      param =~ /^-/
+    end
+
+    def instantiate_subcommand(name)
+      commands_map.instantiate(name)
+    end
+
+    private
+
+    def normalized_exit_code(maybe_integer)
+      if maybe_integer.kind_of?(Integer) and (0..255).include?(maybe_integer)
+        maybe_integer
+      else
+        0
+      end
+    end
+
+    # Find PATH or Path correctly if we are on Windows
+    def path_key
+      env.keys.grep(/\Apath\Z/i).first
+    end
+
+    # upcase drive letters for comparison since ruby has a String#capitalize function
+    def drive_upcase(path)
+      if Chef::Platform.windows? && path[0] =~ /^[A-Za-z]$/ && path[1,2] == ":\\"
+        path.capitalize
+      else
+        path
+      end
+    end
+
+    def env
+      ENV
+    end
+
+    # catch the cases where users setup only the embedded_bin_dir in their path, or
+    # when they have the embedded_bin_dir before the omnibus_bin_dir -- both of which will
+    # defeat appbundler and interact very badly with our intent.
+    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)))
+      bin_index = paths.index(drive_upcase(Chef::Util::PathHelper.cleanpath(omnibus_bin_dir)))
+      if embed_index
+        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.")
+          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.")
+        end
+      end
+    end
+  end
+end