chef 16.10.8-universal-mingw32 → 17.0.242-universal-mingw32

data/lib/chef/knife/core/subcommand_loader.rb

@@ -1,203 +0,0 @@
-# Author:: Christopher Brown (<cb@chef.io>)
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright (c) 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_relative "../../version"
-require_relative "../../util/path_helper"
-require_relative "gem_glob_loader"
-require_relative "hashed_command_loader"
-
-class Chef
-  class Knife
-    #
-    # Public Methods of a Subcommand Loader
-    #
-    # load_commands            - loads all available subcommands
-    # load_command(args)       - loads subcommands for the given args
-    # list_commands(args)      - lists all available subcommands,
-    #                            optionally filtering by category
-    # subcommand_files         - returns an array of all subcommand files
-    #                            that could be loaded
-    # command_class_from(args) - returns the subcommand class for the
-    #                            user-requested command
-    #
-    class SubcommandLoader
-      attr_reader :chef_config_dir
-
-      # A small factory method.  Eventually, this is the only place
-      # where SubcommandLoader should know about its subclasses, but
-      # to maintain backwards compatibility many of the instance
-      # methods in this base class contain default implementations
-      # of the functions sub classes should otherwise provide
-      # or directly instantiate the appropriate subclass
-      def self.for_config(chef_config_dir)
-        if autogenerated_manifest?
-          Chef::Log.trace("Using autogenerated hashed command manifest #{plugin_manifest_path}")
-          Knife::SubcommandLoader::HashedCommandLoader.new(chef_config_dir, plugin_manifest)
-        else
-          Knife::SubcommandLoader::GemGlobLoader.new(chef_config_dir)
-        end
-      end
-
-      # There are certain situations where we want to shortcut the loader selection
-      # in self.for_config and force using the GemGlobLoader
-      def self.gem_glob_loader(chef_config_dir)
-        Knife::SubcommandLoader::GemGlobLoader.new(chef_config_dir)
-      end
-
-      def self.plugin_manifest?
-        plugin_manifest_path && File.exist?(plugin_manifest_path)
-      end
-
-      def self.autogenerated_manifest?
-        plugin_manifest? && plugin_manifest.key?(HashedCommandLoader::KEY)
-      end
-
-      def self.plugin_manifest
-        Chef::JSONCompat.from_json(File.read(plugin_manifest_path))
-      end
-
-      def self.plugin_manifest_path
-        Chef::Util::PathHelper.home(".chef", "plugin_manifest.json")
-      end
-
-      def self.generate_hash
-        output = if plugin_manifest?
-                   plugin_manifest
-                 else
-                   { Chef::Knife::SubcommandLoader::HashedCommandLoader::KEY => {} }
-                 end
-        output[Chef::Knife::SubcommandLoader::HashedCommandLoader::KEY]["plugins_paths"] = Chef::Knife.subcommand_files
-        output[Chef::Knife::SubcommandLoader::HashedCommandLoader::KEY]["plugins_by_category"] = Chef::Knife.subcommands_by_category
-        output
-      end
-
-      def self.write_hash(data)
-        plugin_manifest_dir = File.expand_path("..", plugin_manifest_path)
-        FileUtils.mkdir_p(plugin_manifest_dir) unless File.directory?(plugin_manifest_dir)
-        File.open(plugin_manifest_path, "w") do |f|
-          f.write(Chef::JSONCompat.to_json_pretty(data))
-        end
-      end
-
-      def initialize(chef_config_dir)
-        @chef_config_dir = chef_config_dir
-      end
-
-      # Load all the sub-commands
-      def load_commands
-        return true if @loaded
-
-        subcommand_files.each { |subcommand| Kernel.load subcommand }
-        @loaded = true
-      end
-
-      def force_load
-        @loaded = false
-        load_commands
-      end
-
-      def load_command(_command_args)
-        load_commands
-      end
-
-      def list_commands(pref_cat = nil)
-        load_commands
-        if pref_cat && Chef::Knife.subcommands_by_category.key?(pref_cat)
-          { pref_cat => Chef::Knife.subcommands_by_category[pref_cat] }
-        else
-          Chef::Knife.subcommands_by_category
-        end
-      end
-
-      def command_class_from(args)
-        cmd_words = positional_arguments(args)
-        load_command(cmd_words)
-        result = Chef::Knife.subcommands[find_longest_key(Chef::Knife.subcommands,
-          cmd_words, "_")]
-        result || Chef::Knife.subcommands[args.first.tr("-", "_")]
-      end
-
-      def guess_category(args)
-        category_words = positional_arguments(args)
-        category_words.map! { |w| w.split("-") }.flatten!
-        find_longest_key(Chef::Knife.subcommands_by_category,
-          category_words, " ")
-      end
-
-      #
-      # This is shared between the custom_manifest_loader and the gem_glob_loader
-      #
-      def find_subcommands_via_dirglob
-        # The "require paths" of the core knife subcommands bundled with chef
-        files = Dir[File.join(Chef::Util::PathHelper.escape_glob_dir(File.expand_path("../../knife", __dir__)), "*.rb")]
-        subcommand_files = {}
-        files.each do |knife_file|
-          rel_path = knife_file[/#{CHEF_ROOT}#{Regexp.escape(File::SEPARATOR)}(.*)\.rb/, 1]
-          subcommand_files[rel_path] = knife_file
-        end
-        subcommand_files
-      end
-
-      #
-      # Utility function for finding an element in a hash given an array
-      # of words and a separator.  We find the the longest key in the
-      # hash composed of the given words joined by the separator.
-      #
-      def find_longest_key(hash, words, sep = "_")
-        words = words.dup
-        match = nil
-        until match || words.empty?
-          candidate = words.join(sep).tr("-", "_")
-          if hash.key?(candidate)
-            match = candidate
-          else
-            words.pop
-          end
-        end
-        match
-      end
-
-      #
-      # The positional arguments from the argument list provided by the
-      # users. Used to search for subcommands and categories.
-      #
-      # @return [Array<String>]
-      #
-      def positional_arguments(args)
-        args.select { |arg| arg =~ /^(([[:alnum:]])[[:alnum:]\_\-]+)$/ }
-      end
-
-      # Returns an Array of paths to knife commands located in
-      # chef_config_dir/plugins/knife/ and ~/.chef/plugins/knife/
-      def site_subcommands
-        user_specific_files = []
-
-        if chef_config_dir
-          user_specific_files.concat Dir.glob(File.expand_path("plugins/knife/*.rb", Chef::Util::PathHelper.escape_glob_dir(chef_config_dir)))
-        end
-
-        # finally search ~/.chef/plugins/knife/*.rb
-        Chef::Util::PathHelper.home(".chef", "plugins", "knife") do |p|
-          user_specific_files.concat Dir.glob(File.join(Chef::Util::PathHelper.escape_glob_dir(p), "*.rb"))
-        end
-
-        user_specific_files
-      end
-    end
-  end
-end

data/lib/chef/knife/core/text_formatter.rb

@@ -1,85 +0,0 @@
-#
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright (c) 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.
-#
-
-class Chef
-  class Knife
-    module Core
-      class TextFormatter
-
-        attr_reader :data
-        attr_reader :ui
-
-        def initialize(data, ui)
-          @ui = ui
-          @data = if data.respond_to?(:display_hash)
-                    data.display_hash
-                  elsif data.is_a?(Array)
-                    data
-                  elsif data.respond_to?(:to_hash)
-                    data.to_hash
-                  else
-                    data
-                  end
-        end
-
-        def formatted_data
-          @formatted_data ||= text_format(data)
-        end
-
-        def text_format(data)
-          buffer = ""
-
-          if data.respond_to?(:keys)
-            justify_width = data.keys.map { |k| k.to_s.size }.max.to_i + 1
-            data.sort.each do |key, value|
-              # key: ['value'] should be printed as key: value
-              if value.is_a?(Array) && value.size == 1 && is_singleton(value[0])
-                value = value[0]
-              end
-              if is_singleton(value)
-                # Strings are printed as key: value.
-                justified_key = ui.color("#{key}:".ljust(justify_width), :cyan)
-                buffer << "#{justified_key} #{value}\n"
-              else
-                # Arrays and hashes get indented on their own lines.
-                buffer << ui.color("#{key}:\n", :cyan)
-                lines = text_format(value).split("\n")
-                lines.each { |line| buffer << "  #{line}\n" }
-              end
-            end
-          elsif data.is_a?(Array)
-            data.each_index do |index|
-              item = data[index]
-              buffer << text_format(data[index])
-              # Separate items with newlines if it's an array of hashes or an
-              # array of arrays
-              buffer << "\n" if !is_singleton(data[index]) && index != data.size - 1
-            end
-          else
-            buffer << "#{data}\n"
-          end
-          buffer
-        end
-
-        def is_singleton(value)
-          !(value.is_a?(Array) || value.respond_to?(:keys))
-        end
-      end
-    end
-  end
-end

data/lib/chef/knife/core/ui.rb

@@ -1,338 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@chef.io>)
-# Author:: Christopher Brown (<cb@chef.io>)
-# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright (c) 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 "forwardable" unless defined?(Forwardable)
-require_relative "../../platform/query_helpers"
-require_relative "generic_presenter"
-require "tempfile" unless defined?(Tempfile)
-
-class Chef
-  class Knife
-
-    # The User Interaction class used by knife.
-    class UI
-
-      extend Forwardable
-
-      attr_reader :stdout
-      attr_reader :stderr
-      attr_reader :stdin
-      attr_reader :config
-
-      attr_reader :presenter
-
-      def_delegator :@presenter, :format_list_for_display
-      def_delegator :@presenter, :format_for_display
-      def_delegator :@presenter, :format_cookbook_list_for_display
-
-      def initialize(stdout, stderr, stdin, config)
-        @stdout, @stderr, @stdin, @config = stdout, stderr, stdin, config
-        @presenter = Chef::Knife::Core::GenericPresenter.new(self, config)
-      end
-
-      # Creates a new +presenter_class+ object and uses it to format structured
-      # data for display. By default, a Chef::Knife::Core::GenericPresenter
-      # object is used.
-      def use_presenter(presenter_class)
-        @presenter = presenter_class.new(self, config)
-      end
-
-      def highline
-        @highline ||= begin
-          require "highline"
-          HighLine.new
-        end
-      end
-
-      # Creates a new object of class TTY::Prompt
-      # with interrupt as exit so that it can be terminated with status code.
-      def prompt
-        @prompt ||= begin
-          require "tty-prompt"
-          TTY::Prompt.new(interrupt: :exit)
-        end
-      end
-
-      # pastel.decorate is a lightweight replacement for highline.color
-      def pastel
-        @pastel ||= begin
-          require "pastel" unless defined?(Pastel)
-          Pastel.new
-        end
-      end
-
-      # Prints a message to stdout. Aliased as +info+ for compatibility with
-      # the logger API.
-      #
-      # @param message [String] the text string
-      def msg(message)
-        stdout.puts message
-      rescue Errno::EPIPE => e
-        raise e if @config[:verbosity] >= 2
-
-        exit 0
-      end
-
-      # Prints a msg to stderr. Used for info, warn, error, and fatal.
-      #
-      # @param message [String] the text string
-      def log(message)
-        lines = message.split("\n")
-        first_line = lines.shift
-        stderr.puts first_line
-        # If the message is multiple lines,
-        # indent subsequent lines to align with the
-        # log type prefix ("ERROR: ", etc)
-        unless lines.empty?
-          prefix, = first_line.split(":", 2)
-          return if prefix.nil?
-
-          prefix_len = prefix.length
-          prefix_len -= 9 if color? # prefix includes 9 bytes of color escape sequences
-          prefix_len += 2 # include room to align to the ": " following PREFIX
-          padding = " " * prefix_len
-          lines.each do |line|
-            stderr.puts "#{padding}#{line}"
-          end
-        end
-      rescue Errno::EPIPE => e
-        raise e if @config[:verbosity] >= 2
-
-        exit 0
-      end
-
-      alias :info :log
-      alias :err :log
-
-      # Print a Debug
-      #
-      # @param message [String] the text string
-      def debug(message)
-        log("#{color("DEBUG:", :blue, :bold)} #{message}")
-      end
-
-      # Print a warning message
-      #
-      # @param message [String] the text string
-      def warn(message)
-        log("#{color("WARNING:", :yellow, :bold)} #{message}")
-      end
-
-      # Print an error message
-      #
-      # @param message [String] the text string
-      def error(message)
-        log("#{color("ERROR:", :red, :bold)} #{message}")
-      end
-
-      # Print a message describing a fatal error.
-      #
-      # @param message [String] the text string
-      def fatal(message)
-        log("#{color("FATAL:", :red, :bold)} #{message}")
-      end
-
-      # Print a message describing a fatal error and exit 1
-      #
-      # @param message [String] the text string
-      def fatal!(message)
-        fatal(message)
-        exit 1
-      end
-
-      def color(string, *colors)
-        if color?
-          pastel.decorate(string, *colors)
-        else
-          string
-        end
-      end
-
-      # Should colored output be used? For output to a terminal, this is
-      # determined by the value of `config[:color]`. When output is not to a
-      # terminal, colored output is never used
-      def color?
-        Chef::Config[:color] && stdout.tty?
-      end
-
-      def ask(*args, **options, &block)
-        prompt.ask(*args, **options, &block)
-      end
-
-      def list(*args)
-        highline.list(*args)
-      end
-
-      # Formats +data+ using the configured presenter and outputs the result
-      # via +msg+. Formatting can be customized by configuring a different
-      # presenter. See +use_presenter+
-      def output(data)
-        msg @presenter.format(data)
-      end
-
-      # Determines if the output format is a data interchange format, i.e.,
-      # JSON or YAML
-      def interchange?
-        @presenter.interchange?
-      end
-
-      def ask_question(question, opts = {})
-        question += "[#{opts[:default]}] " if opts[:default]
-
-        if opts[:default] && config[:defaults]
-          opts[:default]
-        else
-          stdout.print question
-          a = stdin.readline.strip
-
-          if opts[:default]
-            a.empty? ? opts[:default] : a
-          else
-            a
-          end
-        end
-      end
-
-      def pretty_print(data)
-        stdout.puts data
-      rescue Errno::EPIPE => e
-        raise e if @config[:verbosity] >= 2
-
-        exit 0
-      end
-
-      # Hash -> Hash
-      # Works the same as edit_data but
-      # returns a hash rather than a JSON string/Fully inflated object
-      def edit_hash(hash)
-        raw = edit_data(hash, false)
-        Chef::JSONCompat.parse(raw)
-      end
-
-      def edit_data(data, parse_output = true, object_class: nil)
-        output = Chef::JSONCompat.to_json_pretty(data)
-        unless config[:disable_editing]
-          Tempfile.open([ "knife-edit-", ".json" ]) do |tf|
-            tf.sync = true
-            tf.puts output
-            tf.close
-            raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup/ for details." unless system("#{config[:editor]} #{tf.path}")
-
-            output = IO.read(tf.path)
-          end
-        end
-
-        if parse_output
-          if object_class.nil?
-            raise ArgumentError, "Please pass in the object class to hydrate or use #edit_hash"
-          else
-            object_class.from_hash(Chef::JSONCompat.parse(output))
-          end
-        else
-          output
-        end
-      end
-
-      def edit_object(klass, name)
-        object = klass.load(name)
-
-        output = edit_data(object, object_class: klass)
-
-        # Only make the save if the user changed the object.
-        #
-        # Output JSON for the original (object) and edited (output), then parse
-        # them without reconstituting the objects into real classes
-        # (create_additions=false). Then, compare the resulting simple objects,
-        # which will be Array/Hash/String/etc.
-        #
-        # We wouldn't have to do these shenanigans if all the editable objects
-        # implemented to_hash, or if to_json against a hash returned a string
-        # with stable key order.
-        object_parsed_again = Chef::JSONCompat.parse(Chef::JSONCompat.to_json(object))
-        output_parsed_again = Chef::JSONCompat.parse(Chef::JSONCompat.to_json(output))
-        if object_parsed_again != output_parsed_again
-          output.save
-          msg("Saved #{output}")
-        else
-          msg("Object unchanged, not saving")
-        end
-        output(format_for_display(object)) if config[:print_after]
-      end
-
-      def confirmation_instructions(default_choice)
-        case default_choice
-        when true
-          "? (Y/n) "
-        when false
-          "? (y/N) "
-        else
-          "? (Y/N) "
-        end
-      end
-
-      # See confirm method for argument information
-      def confirm_without_exit(question, append_instructions = true, default_choice = nil)
-        return true if config[:yes]
-
-        stdout.print question
-        stdout.print confirmation_instructions(default_choice) if append_instructions
-
-        answer = stdin.readline
-        answer.chomp!
-
-        case answer
-        when "Y", "y"
-          true
-        when "N", "n"
-          msg("You said no, so I'm done here.")
-          false
-        when ""
-          unless default_choice.nil?
-            default_choice
-          else
-            msg("I have no idea what to do with '#{answer}'")
-            msg("Just say Y or N, please.")
-            confirm_without_exit(question, append_instructions, default_choice)
-          end
-        else
-          msg("I have no idea what to do with '#{answer}'")
-          msg("Just say Y or N, please.")
-          confirm_without_exit(question, append_instructions, default_choice)
-        end
-      end
-
-      #
-      # Not the ideal signature for a function but we need to stick with this
-      # for now until we get a chance to break our API in Chef 12.
-      #
-      # question => Question to print  before asking for confirmation
-      # append_instructions => Should print '? (Y/N)' as instructions
-      # default_choice => Set to true for 'Y', and false for 'N' as default answer
-      #
-      def confirm(question, append_instructions = true, default_choice = nil)
-        unless confirm_without_exit(question, append_instructions, default_choice)
-          exit 3
-        end
-        true
-      end
-
-    end
-  end
-end