chef 12.4.0.rc.0-universal-mingw32

data/lib/chef/knife/exec.rb

@@ -0,0 +1,87 @@
+#--
+# Author:: Daniel DeLeo (<dan@opscode.com)
+# Copyright:: Copyright (c) 2010 Opscode, 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/knife'
+require 'chef/util/path_helper'
+
+class Chef::Knife::Exec < Chef::Knife
+
+  banner "knife exec [SCRIPT] (options)"
+
+  option :exec,
+    :short => "-E CODE",
+    :long => "--exec CODE",
+    :description => "a string of Chef code to execute"
+
+  option :script_path,
+    :short => "-p PATH:PATH",
+    :long => "--script-path PATH:PATH",
+    :description => "A colon-separated path to look for scripts in",
+    :proc => lambda { |o| o.split(":") }
+
+  deps do
+    require 'chef/shell/ext'
+  end
+
+  def run
+    config[:script_path] ||= Array(Chef::Config[:script_path])
+
+    # Default script paths are chef-repo/.chef/scripts and ~/.chef/scripts
+    config[:script_path] << File.join(Chef::Knife.chef_config_dir, 'scripts') if Chef::Knife.chef_config_dir
+    Chef::Util::PathHelper.home('.chef', 'scripts') { |p| config[:script_path] << p }
+
+    scripts = Array(name_args)
+    context = Object.new
+    Shell::Extensions.extend_context_object(context)
+    if config[:exec]
+      context.instance_eval(config[:exec], "-E Argument", 0)
+    elsif !scripts.empty?
+      scripts.each do |script|
+        file = find_script(script)
+        context.instance_eval(IO.read(file), file, 0)
+      end
+    else
+      script = STDIN.read
+      context.instance_eval(script, "STDIN", 0)
+    end
+  end
+
+  def find_script(x)
+    # Try to find a script. First try expanding the path given.
+    script = File.expand_path(x)
+    return script if File.exists?(script)
+
+    # Failing that, try searching the script path. If we can't find
+    # anything, fail gracefully.
+    Chef::Log.debug("Searching script_path: #{config[:script_path].inspect}")
+
+    config[:script_path].each do |path|
+      path = File.expand_path(path)
+      test = File.join(path, x)
+      Chef::Log.debug("Testing: #{test}")
+      if File.exists?(test)
+        script = test
+        Chef::Log.debug("Found: #{test}")
+        return script
+      end
+    end
+    ui.error("\"#{x}\" not found in current directory or script_path, giving up.")
+    exit(1)
+  end
+
+end

data/lib/chef/knife/help.rb

@@ -0,0 +1,103 @@
+#
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2011 Opscode, 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
+    class Help < Chef::Knife
+
+      banner "knife help [list|TOPIC]"
+
+      def run
+        if name_args.empty?
+          ui.info "Usage: knife SUBCOMMAND (options)"
+          ui.msg ""
+          # This command is atypical, the user is likely not interested in usage of
+          # this command, but knife in general. So hack the banner.
+          opt_parser.banner = "General Knife Options:"
+          ui.msg opt_parser.to_s
+          ui.msg ""
+          ui.info "For further help:"
+          ui.info(<<-MOAR_HELP)
+  knife help list             list help topics
+  knife help knife            show general knife help
+  knife help TOPIC            display the manual for TOPIC
+  knife SUBCOMMAND --help     show the options for a command
+MOAR_HELP
+          exit 1
+        else
+          @query = name_args.join('-')
+        end
+
+
+
+        case @query
+        when 'topics', 'list'
+          print_help_topics
+          exit 1
+        when 'intro', 'knife'
+          @topic = 'knife'
+        else
+          @topic = find_manpages_for_query(@query)
+        end
+
+        manpage_path = find_manpage_path(@topic)
+        exec "man #{manpage_path}"
+      end
+
+      def help_topics
+        # The list of help topics is generated by a rake task from the available man pages
+        # This constant is provided in help_topics.rb which is automatically required/loaded by the knife subcommand loader.
+        HELP_TOPICS
+      end
+
+      def print_help_topics
+        ui.info "Available help topics are: "
+        help_topics.collect {|t| t.gsub(/knife-/, '') }.sort.each do |topic|
+          ui.msg "  #{topic}"
+        end
+      end
+
+      def find_manpages_for_query(query)
+        possibilities = help_topics.select do |manpage|
+          ::File.fnmatch("knife-#{query}*", manpage) || ::File.fnmatch("#{query}*", manpage)
+        end
+        if possibilities.empty?
+          ui.error "No help found for '#{query}'"
+          ui.msg ""
+          print_help_topics
+          exit 1
+        elsif possibilities.size == 1
+          possibilities.first
+        else
+          ui.info "Multiple help topics match your query. Pick one:"
+          ui.highline.choose(*possibilities)
+        end
+      end
+
+      def find_manpage_path(topic)
+        if ::File.exists?(::File.expand_path("../distro/common/man/man1/#{topic}.1", CHEF_ROOT))
+          # If we've provided the man page in the gem, give that
+          return ::File.expand_path("../distro/common/man/man1/#{topic}.1", CHEF_ROOT)
+        else
+          # Otherwise, we'll just be using MANPATH
+          topic
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/help_topics.rb

@@ -0,0 +1,4 @@
+# Do not edit this file by hand
+# This file is autogenerated by the docs:list rake task from the available manpages
+
+HELP_TOPICS = ["chef-shell", "knife-bootstrap", "knife-client", "knife-configure", "knife-cookbook-site", "knife-cookbook", "knife-data-bag", "knife-delete", "knife-deps", "knife-diff", "knife-download", "knife-edit", "knife-environment", "knife-exec", "knife-index-rebuild", "knife-list", "knife-node", "knife-raw", "knife-recipe-list", "knife-role", "knife-search", "knife-show", "knife-ssh", "knife-status", "knife-tag", "knife-upload", "knife-user", "knife-xargs", "knife"]

data/lib/chef/knife/index_rebuild.rb

@@ -0,0 +1,134 @@
+#
+# Author:: Daniel DeLeo (<dan@kallistec.com>)
+# Copyright:: Copyright (c) 2009 Daniel DeLeo
+# 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/knife'
+
+class Chef
+  class Knife
+    class IndexRebuild < Knife
+
+      banner "knife index rebuild (options)"
+      option :yes,
+        :short        => "-y",
+        :long         => "--yes",
+        :boolean      => true,
+        :description  => "don't bother to ask if I'm sure"
+
+      def run
+        api_info = grab_api_info
+
+        if unsupported_version?(api_info)
+          unsupported_server_message(api_info)
+          exit 1
+        else
+          deprecated_server_message
+          nag
+          output rest.post_rest("/search/reindex", {})
+        end
+
+      end
+
+      def grab_api_info
+        # Since we don't yet have any endpoints that implement an
+        # OPTIONS handler, we need to get our version header
+        # information in a more roundabout way.  We'll try to query
+        # for a node we know won't exist; the 404 response that comes
+        # back will give us what we want
+        dummy_node = "knife_index_rebuild_test_#{rand(1000000)}"
+        rest.get_rest("/nodes/#{dummy_node}")
+      rescue Net::HTTPServerException => exception
+        r = exception.response
+        parse_api_info(r)
+      end
+
+      # Only Chef 11+ servers will have version information in their
+      # headers, and only those servers will lack an API endpoint for
+      # index rebuilding.
+      def unsupported_version?(api_info)
+        !!api_info["version"]
+      end
+
+      def unsupported_server_message(api_info)
+        ui.error("Rebuilding the index is not available via knife for #{server_type(api_info)}s version 11.0.0 and above.")
+        ui.info("Instead, run the '#{ctl_command(api_info)} reindex' command on the server itself.")
+      end
+
+      def deprecated_server_message
+        ui.warn("'knife index rebuild' has been removed for Chef 11+ servers.  It will continue to work for prior versions, however.")
+      end
+
+      def nag
+        ui.info("This operation is destructive.  Rebuilding the index may take some time.")
+        ui.confirm("Continue")
+      end
+
+      # Chef 11 (and above) servers return various pieces of
+      # information about the server in an +x-ops-api-info+ header.
+      # This is a +;+ delimited string of key / value pairs, separated
+      # by +=+.
+      #
+      # Given a Net::HTTPResponse object, this method extracts this
+      # information (if present), and returns it as a hash.  If no
+      # such header is found, an empty hash is returned.
+      def parse_api_info(response)
+        value = response["x-ops-api-info"]
+        if value
+          kv = value.split(";")
+          kv.inject({}) do |acc, pair|
+            k, v = pair.split("=")
+            acc[k] = v
+            acc
+          end
+        else
+          {}
+        end
+      end
+
+      # Given an API info hash (see +#parse_api_info(response)+),
+      # return a string describing the kind of server we're
+      # interacting with (based on the +flavor+ field)
+      def server_type(api_info)
+        case api_info["flavor"]
+        when "osc"
+          "Open Source Chef Server"
+        when "opc"
+          "Private Chef Server"
+        else
+          # Generic fallback
+          "Chef Server"
+        end
+      end
+
+      # Given an API info hash (see +#parse_api_info(response)+),
+      # return the name of the "server-ctl" command for the kind of
+      # server we're interacting with (based on the +flavor+ field)
+      def ctl_command(api_info)
+        case api_info["flavor"]
+        when "osc"
+          "chef-server-ctl"
+        when "opc"
+          "private-chef-ctl"
+        else
+          # Generic fallback
+          "chef-server-ctl"
+        end
+      end
+
+    end
+  end
+end

data/lib/chef/knife/key_create.rb

@@ -0,0 +1,108 @@
+#
+# Author:: Tyler Cloke (<tyler@chef.io>)
+# 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/key'
+require 'chef/json_compat'
+require 'chef/exceptions'
+
+class Chef
+  class Knife
+    # Service class for UserKeyCreate and ClientKeyCreate,
+    # Implements common functionality of knife [user | org client] key create.
+    #
+    # @author Tyler Cloke
+    #
+    # @attr_accessor [Hash] cli input, see UserKeyCreate and ClientKeyCreate for what could populate it
+    class KeyCreate
+
+      attr_accessor :config
+
+      def initialize(actor, actor_field_name, ui, config)
+        @actor = actor
+        @actor_field_name = actor_field_name
+        @ui = ui
+        @config = config
+      end
+
+      def public_key_or_key_name_error_msg
+<<EOS
+You must pass either --public-key or --key-name, or both.
+If you only pass --public-key, a key name will be generated from the fingerprint of your key.
+If you only pass --key-name, a key pair will be generated by the server.
+EOS
+      end
+
+      def edit_data(key)
+        @ui.edit_data(key)
+      end
+
+      def display_info(input)
+        @ui.info(input)
+      end
+
+      def display_private_key(private_key)
+        @ui.msg(private_key)
+      end
+
+      def output_private_key_to_file(private_key)
+        File.open(@config[:file], "w") do |f|
+          f.print(private_key)
+        end
+      end
+
+      def create_key_from_hash(output)
+        Chef::Key.from_hash(output).create
+      end
+
+      def run
+        key = Chef::Key.new(@actor, @actor_field_name)
+        if !@config[:public_key] && !@config[:key_name]
+          raise Chef::Exceptions::KeyCommandInputError, public_key_or_key_name_error_msg
+        elsif !@config[:public_key]
+          key.create_key(true)
+        end
+
+        if @config[:public_key]
+          key.public_key(File.read(File.expand_path(@config[:public_key])))
+        end
+
+        if @config[:key_name]
+          key.name(@config[:key_name])
+        end
+
+        if @config[:expiration_date]
+          key.expiration_date(@config[:expiration_date])
+        else
+          key.expiration_date("infinity")
+        end
+
+        output = edit_data(key)
+        key = create_key_from_hash(output)
+
+        display_info("Created key: #{key.name}")
+        if key.private_key
+          if @config[:file]
+            output_private_key_to_file(key.private_key)
+          else
+            display_private_key(key.private_key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/key_create_base.rb

@@ -0,0 +1,50 @@
+#
+# Author:: Tyler Cloke (<tyler@chef.io>)
+# 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.
+#
+
+class Chef
+  class Knife
+    # Extendable module that class_eval's common options into UserKeyCreate and ClientKeyCreate
+    #
+    # @author Tyler Cloke
+    module KeyCreateBase
+      def self.included(includer)
+        includer.class_eval do
+          option :public_key,
+                 :short => "-p FILENAME",
+                 :long => "--public-key FILENAME",
+                 :description => "Public key for newly created key. If not passed, the server will create a key pair for you, but you must pass --key-name NAME in that case."
+
+          option :file,
+                 :short => "-f FILE",
+                 :long  => "--file FILE",
+                 :description => "Write the private key to a file, if you requested the server to create one."
+
+          option :key_name,
+                 :short => "-k NAME",
+                 :long  => "--key-name NAME",
+                 :description => "The name for your key. If you do not pass a name, you must pass --public-key, and the name will default to the fingerprint of the public key passed."
+
+          option :expiration_date,
+                 :short => "-e DATE",
+                 :long  => "--expiration-date DATE",
+                 :description => "Optionally pass the expiration date for the key in ISO 8601 fomatted string: YYYY-MM-DDTHH:MM:SSZ e.g. 2013-12-24T21:00:00Z. Defaults to infinity if not passed. UTC timezone assumed."
+        end
+      end
+    end
+  end
+end