chef-dk 3.9.0 → 3.10.1

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

@@ -1,179 +1,179 @@
-#
-# Copyright:: Copyright (c) 2014-2018 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 "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
-
-      SUPPORTED_SHELLS = %w{ bash fish zsh sh powershell posh}.map(&:freeze).freeze
-
-      banner(<<~HELP)
-        Usage: chef shell-init
-
-        `chef shell-init` modifies your shell environment to make ChefDK your default
-        ruby.
-
-          To enable for just the current shell session:
-
-            In sh, bash, and zsh:
-              eval "$(chef shell-init SHELL_NAME)"
-            In fish:
-              eval (chef shell-init fish)
-            In Powershell:
-              chef shell-init powershell | Invoke-Expression
-
-          To permanently enable:
-
-            In sh, bash, and zsh:
-              echo 'eval "$(chef shell-init SHELL_NAME)"' >> ~/.YOUR_SHELL_RC_FILE
-            In fish:
-              echo 'eval (chef shell-init SHELL_NAME)' >> ~/.config/fish/config.fish
-            In Powershell
-              "chef shell-init powershell | Invoke-Expression" >> $PROFILE
-
-        OPTIONS:
-
-      HELP
-
-      option :omnibus_dir,
-        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
-
-      def run(argv)
-        # Currently we don't have any shell-specific features, so we ignore the
-        # shell name. We'll need it if we add completion.
-        remaining_args = parse_options(argv)
-        shell_name = remaining_args.first
-        if shell_name.nil?
-          err("Please specify what shell you are using\n")
-          err(opt_parser.to_s)
-          return 1
-        elsif !SUPPORTED_SHELLS.include?(shell_name)
-          err("Shell `#{shell_name}' is not currently supported")
-          err("Supported shells are: #{SUPPORTED_SHELLS.join(' ')}")
-          return 1
-        end
-
-        env = omnibus_env.dup
-        path = env.delete("PATH")
-        export(shell_name, "PATH", path)
-        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"
-          posix_shell_export(var, val)
-        when "fish"
-          fish_shell_export(var, val)
-        when "powershell", "posh"
-          powershell_export(var, val)
-        end
-      end
-
-      def posix_shell_export(var, val)
-        emit_shell_cmd(%Q{export #{var}="#{val}"})
-      end
-
-      def fish_shell_export(var, val)
-        # Fish's syntax for setting PATH is special. Path elements are
-        # divided by spaces (instead of colons). We also send STDERR to
-        # /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;})
-        else
-          emit_shell_cmd(%Q{set -gx #{var} "#{val}";})
-        end
-      end
-
-      def powershell_export(var, val)
-        emit_shell_cmd(%Q{$env:#{var}="#{val}"})
-      end
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2014-2018 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 "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
+
+      SUPPORTED_SHELLS = %w{ bash fish zsh sh powershell posh}.map(&:freeze).freeze
+
+      banner(<<~HELP)
+        Usage: chef shell-init
+
+        `chef shell-init` modifies your shell environment to make ChefDK your default
+        ruby.
+
+          To enable for just the current shell session:
+
+            In sh, bash, and zsh:
+              eval "$(chef shell-init SHELL_NAME)"
+            In fish:
+              eval (chef shell-init fish)
+            In Powershell:
+              chef shell-init powershell | Invoke-Expression
+
+          To permanently enable:
+
+            In sh, bash, and zsh:
+              echo 'eval "$(chef shell-init SHELL_NAME)"' >> ~/.YOUR_SHELL_RC_FILE
+            In fish:
+              echo 'eval (chef shell-init SHELL_NAME)' >> ~/.config/fish/config.fish
+            In Powershell
+              "chef shell-init powershell | Invoke-Expression" >> $PROFILE
+
+        OPTIONS:
+
+      HELP
+
+      option :omnibus_dir,
+        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
+
+      def run(argv)
+        # Currently we don't have any shell-specific features, so we ignore the
+        # shell name. We'll need it if we add completion.
+        remaining_args = parse_options(argv)
+        shell_name = remaining_args.first
+        if shell_name.nil?
+          err("Please specify what shell you are using\n")
+          err(opt_parser.to_s)
+          return 1
+        elsif !SUPPORTED_SHELLS.include?(shell_name)
+          err("Shell `#{shell_name}' is not currently supported")
+          err("Supported shells are: #{SUPPORTED_SHELLS.join(' ')}")
+          return 1
+        end
+
+        env = omnibus_env.dup
+        path = env.delete("PATH")
+        export(shell_name, "PATH", path)
+        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"
+          posix_shell_export(var, val)
+        when "fish"
+          fish_shell_export(var, val)
+        when "powershell", "posh"
+          powershell_export(var, val)
+        end
+      end
+
+      def posix_shell_export(var, val)
+        emit_shell_cmd(%Q{export #{var}="#{val}"})
+      end
+
+      def fish_shell_export(var, val)
+        # Fish's syntax for setting PATH is special. Path elements are
+        # divided by spaces (instead of colons). We also send STDERR to
+        # /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;})
+        else
+          emit_shell_cmd(%Q{set -gx #{var} "#{val}";})
+        end
+      end
+
+      def powershell_export(var, val)
+        emit_shell_cmd(%Q{$env:#{var}="#{val}"})
+      end
+    end
+  end
+end

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

@@ -1,163 +1,163 @@
-#
-# 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/lister"
-require "chef-dk/policyfile_services/show_policy"
-
-module ChefDK
-  module Command
-
-    class ShowPolicy < Base
-
-      banner(<<~BANNER)
-        Usage: chef show-policy [POLICY_NAME [POLICY_GROUP]] [options]
-
-        `chef show-policy` Displays the revisions of policyfiles on the server. By
-        default, only active policy revisions are shown. Use the `--orphans` options to
-        show policy revisions that are not assigned to any policy group.
-
-        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.
-
-        See our detailed README for more information:
-
-        https://docs.chef.io/policyfile.html
-
-        Options:
-
-      BANNER
-
-      option :show_orphans,
-        short:        "-o",
-        long:         "--orphans",
-        description:  "Show policy revisions that are unassigned",
-        default:      false
-
-      option :pager,
-        long:        "--[no-]pager",
-        description: "Enable/disable paged policyfile lock ouput (default: enabled)",
-        default:     true,
-        boolean:     true
-
-      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 :policy_name
-
-      attr_reader :policy_group
-
-      def initialize(*args)
-        super
-        @show_all_policies = nil
-        @policy_name = nil
-        @policy_group = nil
-        @ui = UI.new
-      end
-
-      def run(params)
-        return 1 unless apply_params!(params)
-        show_policy_service.run
-        0
-      rescue PolicyfileServiceError => e
-        handle_error(e)
-        1
-      end
-
-      def show_policy_service
-        @policy_list_service ||=
-          PolicyfileServices::ShowPolicy.new(config: chef_config,
-                                             ui: ui,
-                                             policy_name: policy_name,
-                                             policy_group: policy_group,
-                                             show_orphans: show_orphans?,
-                                             summary_diff: show_summary_diff?,
-                                             pager: enable_pager?)
-      end
-
-      def debug?
-        !!config[:debug]
-      end
-
-      def show_summary_diff?
-        false
-      end
-
-      def show_orphans?
-        config[:show_orphans]
-      end
-
-      def enable_pager?
-        config[:pager]
-      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? && show_summary_diff?
-          ui.err("The --summary-diff option can only be used when showing a single policy")
-          ui.err("")
-          ui.err(opt_parser)
-          false
-        elsif remaining_args.empty?
-          @show_all_policies = true
-          true
-        elsif remaining_args.size == 1
-          @policy_name = remaining_args.first
-          @show_all_policies = false
-          true
-        elsif remaining_args.size == 2
-          @policy_name = remaining_args[0]
-          @policy_group = remaining_args[1]
-          @show_all_policies = false
-          true
-        else
-          ui.err("Too many arguments")
-          ui.err("")
-          ui.err(opt_parser)
-          false
-        end
-      end
-
-    end
-  end
-end
+#
+# 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/lister"
+require "chef-dk/policyfile_services/show_policy"
+
+module ChefDK
+  module Command
+
+    class ShowPolicy < Base
+
+      banner(<<~BANNER)
+        Usage: chef show-policy [POLICY_NAME [POLICY_GROUP]] [options]
+
+        `chef show-policy` Displays the revisions of policyfiles on the server. By
+        default, only active policy revisions are shown. Use the `--orphans` options to
+        show policy revisions that are not assigned to any policy group.
+
+        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.
+
+        See our detailed README for more information:
+
+        https://docs.chef.io/policyfile.html
+
+        Options:
+
+      BANNER
+
+      option :show_orphans,
+        short:        "-o",
+        long:         "--orphans",
+        description:  "Show policy revisions that are unassigned",
+        default:      false
+
+      option :pager,
+        long:        "--[no-]pager",
+        description: "Enable/disable paged policyfile lock ouput (default: enabled)",
+        default:     true,
+        boolean:     true
+
+      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 :policy_name
+
+      attr_reader :policy_group
+
+      def initialize(*args)
+        super
+        @show_all_policies = nil
+        @policy_name = nil
+        @policy_group = nil
+        @ui = UI.new
+      end
+
+      def run(params)
+        return 1 unless apply_params!(params)
+        show_policy_service.run
+        0
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def show_policy_service
+        @policy_list_service ||=
+          PolicyfileServices::ShowPolicy.new(config: chef_config,
+                                             ui: ui,
+                                             policy_name: policy_name,
+                                             policy_group: policy_group,
+                                             show_orphans: show_orphans?,
+                                             summary_diff: show_summary_diff?,
+                                             pager: enable_pager?)
+      end
+
+      def debug?
+        !!config[:debug]
+      end
+
+      def show_summary_diff?
+        false
+      end
+
+      def show_orphans?
+        config[:show_orphans]
+      end
+
+      def enable_pager?
+        config[:pager]
+      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? && show_summary_diff?
+          ui.err("The --summary-diff option can only be used when showing a single policy")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        elsif remaining_args.empty?
+          @show_all_policies = true
+          true
+        elsif remaining_args.size == 1
+          @policy_name = remaining_args.first
+          @show_all_policies = false
+          true
+        elsif remaining_args.size == 2
+          @policy_name = remaining_args[0]
+          @policy_group = remaining_args[1]
+          @show_all_policies = false
+          true
+        else
+          ui.err("Too many arguments")
+          ui.err("")
+          ui.err(opt_parser)
+          false
+        end
+      end
+
+    end
+  end
+end