chef-dk 0.7.0 → 0.8.0

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

@@ -40,8 +40,7 @@ to the target machine, you can apply the policy to the machine with
     versioned_cookbooks true
     policy_document_native_api false
 
-The Policyfile feature is incomplete and beta quality. See our detailed README
-for more information.
+See our detailed README for more information:
 
 https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
 
@@ -140,7 +139,8 @@ E
         when 2
           @policyfile_relative_path, @export_dir = remaining_args
         else
-          ui.err(banner)
+          ui.err(opt_parser)
+          ui.err("\n")
           return false
         end
         true

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

@@ -86,6 +86,14 @@ E
           msg(banner)
           1
         end
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        # ChefDK::Command::Base also handles this error in the same way, but it
+        # does not have access to the correct option parser, so it cannot print
+        # the usage correctly. Therefore, invalid CLI usage needs to be handled
+        # here.
+        err("ERROR: #{e.message}\n")
+        msg(generator.opt_parser)
+        1
       end
 
       def generator_for(arg)

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

@@ -46,7 +46,7 @@ module ChefDK
             setup_context
             chef_runner.converge
           else
-            msg(banner)
+            err(opt_parser)
             1
           end
         rescue ChefDK::ChefRunnerError => e

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

@@ -49,7 +49,7 @@ module ChefDK
             setup_context
             chef_runner.converge
           else
-            msg(banner)
+            err(opt_parser)
             1
           end
         rescue ChefDK::ChefRunnerError => e

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

@@ -52,7 +52,7 @@ module ChefDK
             chef_runner.converge
             0
           else
-            msg(banner)
+            err(opt_parser)
             1
           end
         end

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

@@ -52,7 +52,7 @@ module ChefDK
             setup_context
             chef_runner.converge
           else
-            msg(banner)
+            err(opt_parser)
             1
           end
         end

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

@@ -18,12 +18,15 @@
 require 'chef-dk/command/base'
 require 'chef-dk/ui'
 require 'chef-dk/policyfile_services/install'
+require 'chef-dk/configurable'
 
 module ChefDK
   module Command
 
     class Install < Base
 
+      include Configurable
+
       banner(<<-E)
 Usage: chef install [ POLICY_FILE ] [options]
 
@@ -34,8 +37,7 @@ lockfile to install the locked cookbooks on another machine. You can also push
 the lockfile to a "policy group" on a Chef Server and apply that exact set of
 cookbooks to nodes in your infrastructure.
 
-The Policyfile feature is incomplete and beta quality. See our detailed README
-for more information.
+See our detailed README for more information:
 
 https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
 
@@ -43,6 +45,11 @@ Options:
 
 E
 
+      option :config_file,
+        short:       "-c CONFIG_FILE",
+        long:        "--config CONFIG_FILE",
+        description: "Path to configuration file"
+
       option :debug,
         short:       "-D",
         long:        "--debug",
@@ -62,7 +69,12 @@ E
       end
 
       def run(params = [])
-        apply_params!(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
+        # ssl_verify_mode)
+        chef_config
         installer.run
         0
       rescue PolicyfileServiceError => e
@@ -78,6 +90,10 @@ E
         !!config[:debug]
       end
 
+      def config_path
+        config[:config_file]
+      end
+
       def handle_error(error)
         ui.err("Error: #{error.message}")
         if error.respond_to?(:reason)
@@ -91,10 +107,11 @@ E
       def apply_params!(params)
         remaining_args = parse_options(params)
         if remaining_args.size > 1
-          ui.err(banner)
-          return 1
+          ui.err(opt_parser)
+          return false
         else
           @policyfile_relative_path = remaining_args.first
+          true
         end
       end
 

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

@@ -130,10 +130,6 @@ before converging the machine(s) defined in the provision cookbook.
 In the third form of the command, `chef provision` expects to create machines
 that will not operate in policyfile mode.
 
-Note that this command is considered beta. Behavior, the APIs that pass CLI
-data to chef-client, and argument names may change as more experience is gained
-from real-world usage.
-
 Chef Provisioning is documented at https://docs.chef.io/provisioning.html
 
 Options:

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

@@ -35,8 +35,7 @@ with all the cookbooks contained in the policy lock. The policy lock is applied
 to a specific POLICY_GROUP, which is a set of nodes that share the same
 run_list and cookbooks.
 
-The Policyfile feature is incomplete and beta quality. See our detailed README
-for more information.
+See our detailed README for more information:
 
 https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
 

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

@@ -15,10 +15,29 @@
 # limitations under the License.
 #
 
+require 'erb'
+
+require 'chef-dk/commands_map'
+require 'chef-dk/builtin_commands'
 require 'chef-dk/command/base'
 require 'mixlib/shellout'
 
 module ChefDK
+
+  class ShellCompletionTemplateContext
+
+    def commands
+      ChefDK.commands_map.command_specs.inject({}) do |cmd_info, (_key, cmd_spec)|
+        cmd_info[cmd_spec.name] = cmd_spec.description
+        cmd_info
+      end
+    end
+
+    def get_binding
+      binding
+    end
+  end
+
   module Command
     class ShellInit < ChefDK::Command::Base
 
@@ -56,6 +75,11 @@ HELP
         :long         => "--omnibus-dir OMNIBUS_DIR",
         :description  => "Alternate path to omnibus install (used for testing)"
 
+      def initialize
+        super
+        @shell_completion_template_context = nil
+      end
+
       def omnibus_root
         config[:omnibus_dir] || super
       end
@@ -81,9 +105,46 @@ HELP
         env.each do |var_name, value|
           export(shell_name, var_name, value)
         end
+
+        emit_shell_cmd(completion_for(shell_name))
         0
       end
 
+      def emit_shell_cmd(cmd)
+        msg(cmd) unless cmd.empty?
+      end
+
+      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
+        erb.result(context_binding)
+      end
+
+      def completion_template_for(shell)
+        case shell
+        when "bash"
+          "bash.sh.erb"
+        when "fish"
+          "chef.fish.erb"
+        when "zsh"
+          "zsh.zsh.erb"
+        else
+          # Pull requests accepted!
+          nil
+        end
+
+      end
+
+      def expand_completion_template_path(basename)
+        File.join(File.expand_path("../../completions", __FILE__), basename)
+      end
+
+      def shell_completion_template_context
+        @shell_completion_template_context ||= ShellCompletionTemplateContext.new
+      end
+
       def export(shell, var, val)
         case shell
         when 'sh', 'bash', 'zsh'
@@ -96,7 +157,7 @@ HELP
       end
 
       def posix_shell_export(var, val)
-        msg(%Q(export #{var}="#{val}"))
+        emit_shell_cmd(%Q(export #{var}="#{val}"))
       end
 
       def fish_shell_export(var, val)
@@ -105,17 +166,15 @@ HELP
         # /dev/null to avoid Fish's helpful warnings about nonexistent
         # PATH elements.
         if var == 'PATH'
-          msg(%Q(set -gx #{var} "#{val.split(':').join('" "')}" 2>/dev/null;))
+          emit_shell_cmd(%Q(set -gx #{var} "#{val.split(':').join('" "')}" 2>/dev/null;))
         else
-          msg(%Q(set -gx #{var} "#{val}";))
+          emit_shell_cmd(%Q(set -gx #{var} "#{val}";))
         end
       end
 
       def powershell_export(var, val)
-        msg(%Q($env:#{var}="#{val}"))
+        emit_shell_cmd(%Q($env:#{var}="#{val}"))
       end
     end
   end
 end
-
-

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

@@ -38,8 +38,7 @@ When both POLICY_NAME and POLICY_GROUP are given, the command shows the content
 of a the active policyfile lock for the given POLICY_GROUP. See also the `diff`
 command.
 
-The Policyfile feature is incomplete and beta quality. See our detailed README
-for more information.
+See our detailed README for more information:
 
 https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
 

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

@@ -0,0 +1,155 @@
+#
+# Copyright:: Copyright (c) 2015 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/command/base'
+require 'chef-dk/ui'
+require 'chef-dk/configurable'
+require 'chef-dk/policyfile_services/undelete'
+
+module ChefDK
+  module Command
+
+    class Undelete < Base
+
+      banner(<<-BANNER)
+Usage: chef undelete [--list | --id ID] [options]
+
+`chef undelete` helps you recover quickly if you've deleted a policy or policy
+group in error. When run with no arguements, it lists the available undo
+operations. To undo the last delete operation, use `chef undelete --last`.
+
+CAVEATS:
+`chef undelete` doesn't detect conflicts. If a deleted item has been recreated,
+running `chef undelete` will overwrite it.
+
+Undo information does not include cookbooks that might be referenced by
+policies. If you have cleaned the policy cookbooks after the delete operation
+you want to reverse, `chef undelete` may not be able to fully restore the
+previous state.
+
+The delete commands also do not store access control data, so you may have to
+manually reapply any ACL customizations you have made.
+
+See our detailed README for more information:
+
+https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
+
+Options:
+
+BANNER
+
+      option :undo_last,
+        short:        "-l",
+        long:         "--last",
+        description:  "Undo the most recent delete operation"
+
+      option :undo_record_id,
+        short:        "-i ID",
+        long:         "--id ID",
+        description:  "Undo the delete operation with the given ID"
+
+      option :config_file,
+        short:        "-c CONFIG_FILE",
+        long:         "--config CONFIG_FILE",
+        description:  "Path to configuration file"
+
+      option :debug,
+        short:        "-D",
+        long:         "--debug",
+        description:  "Enable stacktraces and other debug output",
+        default:      false
+
+      include Configurable
+
+      attr_accessor :ui
+
+      attr_reader :undo_record_id
+
+      def initialize(*args)
+        super
+        @list_undo_records = false
+        @undo_record_id = nil
+        @ui = UI.new
+      end
+
+      def run(params)
+        return 1 unless apply_params!(params)
+        if list_undo_records?
+          undelete_service.list
+        else
+          undelete_service.run
+        end
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def undelete_service
+        @undelete_service ||=
+          PolicyfileServices::Undelete.new(config: chef_config,
+                                             ui: ui,
+                                             undo_record_id: undo_record_id)
+      end
+
+      def debug?
+        !!config[:debug]
+      end
+
+      def list_undo_records?
+        @list_undo_records
+      end
+
+      def handle_error(error)
+        ui.err("Error: #{error.message}")
+        if error.respond_to?(:reason)
+          ui.err("Reason: #{error.reason}")
+          ui.err("")
+          ui.err(error.extended_error_info) if debug?
+          ui.err(error.cause.backtrace.join("\n")) if debug?
+        end
+      end
+
+      def apply_params!(params)
+        remaining_args = parse_options(params)
+
+        if !remaining_args.empty?
+          ui.err("Too many arguments")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        elsif config[:undo_record_id].nil? && config[:undo_last].nil?
+          @list_undo_records = true
+          true
+        elsif config[:undo_record_id] && config[:undo_last]
+          ui.err("Error: options --last and --id cannot both be given.")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        elsif config[:undo_record_id]
+          @undo_record_id = config[:undo_record_id]
+          true
+        elsif config[:undo_last]
+          @undo_record_id = nil
+          true
+        end
+      end
+
+    end
+  end
+end
+