chef 10.34.6 → 11.0.0.beta.0

data/lib/chef/knife/download.rb

@@ -0,0 +1,50 @@
+require 'chef/chef_fs/knife'
+require 'chef/chef_fs/command_line'
+
+class Chef
+  class Knife
+    class Download < Chef::ChefFS::Knife
+      banner "knife download PATTERNS"
+
+      common_options
+
+      option :recurse,
+        :long => '--[no-]recurse',
+        :boolean => true,
+        :default => true,
+        :description => "List directories recursively."
+
+      option :purge,
+        :long => '--[no-]purge',
+        :boolean => true,
+        :default => false,
+        :description => "Delete matching local files and directories that do not exist remotely."
+
+      option :force,
+        :long => '--[no-]force',
+        :boolean => true,
+        :default => false,
+        :description => "Force upload of files even if they match (quicker and harmless, but doesn't print out what it changed)"
+
+      option :dry_run,
+        :long => '--dry-run',
+        :short => '-n',
+        :boolean => true,
+        :default => false,
+        :description => "Don't take action, only print what would happen"
+
+      def run
+        if name_args.length == 0
+          show_usage
+          ui.fatal("Must specify at least one argument.  If you want to download everything in this directory, type \"knife download .\"")
+          exit 1
+        end
+
+        pattern_args.each do |pattern|
+          Chef::ChefFS::FileSystem.copy_to(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, config)
+        end
+      end
+    end
+  end
+end
+

data/lib/chef/knife/environment_show.rb

@@ -27,6 +27,13 @@ class Chef
         require 'chef/json_compat'
       end
 
+      @attrs_to_show = []
+      option :attribute,
+        :short => "-a [ATTR]",
+        :long => "--attribute [ATTR]",
+        :proc => lambda {|val| @attrs_to_show << val},
+        :description => "Show one or more attributes"
+
       banner "knife environment show ENVIRONMENT (options)"
 
       def run

data/lib/chef/knife/exec.rb

@@ -6,9 +6,9 @@
 # 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.
@@ -34,7 +34,7 @@ class Chef::Knife::Exec < Chef::Knife
     :proc => lambda { |o| o.split(":") }
 
   deps do
-    require 'chef/shef/ext'
+    require 'chef/shell/ext'
   end
 
   def run
@@ -46,7 +46,7 @@ class Chef::Knife::Exec < Chef::Knife
 
     scripts = Array(name_args)
     context = Object.new
-    Shef::Extensions.extend_context_object(context)
+    Shell::Extensions.extend_context_object(context)
     if config[:exec]
       context.instance_eval(config[:exec], "-E Argument", 0)
     elsif !scripts.empty?
@@ -82,5 +82,5 @@ class Chef::Knife::Exec < Chef::Knife
     ui.error("\"#{x}\" not found in current directory or script_path, giving up.")
     exit(1)
   end
- 
+
 end

data/lib/chef/knife/help_topics.rb

@@ -1,4 +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 = ["knife-bootstrap", "knife-client", "knife-configure", "knife-cookbook-site", "knife-cookbook", "knife-data-bag", "knife-environment", "knife-exec", "knife-index", "knife-node", "knife-role", "knife-search", "knife-ssh", "knife-status", "knife-tag", "knife", "shef"]
+HELP_TOPICS = ["chef-shell", "knife-bootstrap", "knife-client", "knife-configure", "knife-cookbook-site", "knife-cookbook", "knife-data-bag", "knife-environment", "knife-exec", "knife-index", "knife-node", "knife-role", "knife-search", "knife-ssh", "knife-status", "knife-tag", "knife", "shef"]

data/lib/chef/knife/index_rebuild.rb

@@ -30,20 +30,104 @@ class Chef
         :description  => "don't bother to ask if I'm sure"
 
       def run
-        nag
-        output rest.post_rest("/search/reindex", {})
+        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
-        unless config[:yes]
-          yea_or_nay = ask_question("This operation is destructive. Rebuilding the index may take some time. You sure? (yes/no): ")
-          unless yea_or_nay =~ /^y/i
-            puts "aborting"
-            exit 7
+        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

data/lib/chef/knife/list.rb

@@ -0,0 +1,109 @@
+require 'chef/chef_fs/knife'
+require 'chef/chef_fs/file_system'
+
+class Chef
+  class Knife
+    class List < Chef::ChefFS::Knife
+      banner "knife list [-dR] [PATTERN1 ... PATTERNn]"
+
+      common_options
+
+      option :recursive,
+        :short => '-R',
+        :boolean => true,
+        :description => "List directories recursively."
+      option :bare_directories,
+        :short => '-d',
+        :boolean => true,
+        :description => "When directories match the pattern, do not show the directories' children."
+
+      def run
+        patterns = name_args.length == 0 ? [""] : name_args
+
+        # Get the matches (recursively)
+        results = []
+        dir_results = []
+        pattern_args_from(patterns).each do |pattern|
+          Chef::ChefFS::FileSystem.list(chef_fs, pattern) do |result|
+            if result.dir? && !config[:bare_directories]
+              dir_results += add_dir_result(result)
+            elsif result.exists?
+              results << result
+            elsif pattern.exact_path
+              STDERR.puts "#{format_path(result.path)}: No such file or directory"
+            end
+          end
+        end
+
+        results = results.sort_by { |result| result.path }
+        dir_results = dir_results.sort_by { |result| result[0].path }
+
+        if results.length == 0 && dir_results.length == 1
+          results = dir_results[0][1]
+          dir_results = []
+        end
+
+        print_result_paths results
+        dir_results.each do |result, children|
+          puts ""
+          puts "#{format_path(result.path)}:"
+          print_results(children.map { |result| result.name }.sort, "")
+        end
+      end
+
+      def add_dir_result(result)
+        begin
+          children = result.children.sort_by { |child| child.name }
+        rescue Chef::ChefFS::FileSystem::NotFoundError
+          STDERR.puts "#{format_path(result.path)}: No such file or directory"
+          return []
+        end
+
+        result = [ [ result, children ] ]
+        if config[:recursive]
+          children.each do |child|
+            if child.dir?
+              result += add_dir_result(child)
+            end
+          end
+        end
+        result
+      end
+
+      def list_dirs_recursive(children)
+        results = children.select { |child| child.dir? }.to_a
+        results.each do |child|
+          results += list_dirs_recursive(child.children)
+        end
+        results
+      end
+
+      def print_result_paths(results, indent = "")
+        print_results(results.map { |result| format_path(result.path) }, indent)
+      end
+
+      def print_results(results, indent)
+        return if results.length == 0
+
+        print_space = results.map { |result| result.length }.max + 2
+        # TODO: tput cols is not cross platform
+        columns = $stdout.isatty ? Integer(`tput cols`) : 0
+        current_column = 0
+        results.each do |result|
+          if current_column != 0 && current_column + print_space > columns
+            puts ""
+            current_column = 0
+          end
+          if current_column == 0
+            print indent
+            current_column += indent.length
+          end
+          print result + (' ' * (print_space - result.length))
+          current_column += print_space
+        end
+        puts ""
+      end
+    end
+  end
+end
+

data/lib/chef/knife/raw.rb

@@ -0,0 +1,108 @@
+require 'json'
+
+class Chef
+  class Knife
+    class Raw < Chef::Knife
+      banner "knife raw REQUEST_PATH"
+
+      option :method,
+        :long => '--method METHOD',
+        :short => '-m METHOD',
+        :default => "GET",
+        :description => "Request method (GET, POST, PUT or DELETE)"
+
+      option :pretty,
+        :long => '--[no-]pretty',
+        :boolean => true,
+        :default => true,
+        :description => "Pretty-print JSON output"
+
+      option :input,
+        :long => '--input FILE',
+        :short => '-i FILE',
+        :description => "Name of file to use for PUT or POST"
+
+      def run
+        if name_args.length == 0
+          show_usage
+          ui.fatal("You must provide the path you want to hit on the server")
+          exit(1)
+        elsif name_args.length > 1
+          show_usage
+          ui.fatal("Only one path accepted for knife raw")
+          exit(1)
+        end
+
+        path = name_args[0]
+        data = false
+        if config[:input]
+          data = IO.read(config[:input])
+        end
+        chef_rest = Chef::REST.new(Chef::Config[:chef_server_url])
+        puts api_request(chef_rest, config[:method].to_sym, chef_rest.create_url(name_args[0]), {}, data)
+      end
+
+      ACCEPT_ENCODING = "Accept-Encoding".freeze
+      ENCODING_GZIP_DEFLATE = "gzip;q=1.0,deflate;q=0.6,identity;q=0.3".freeze
+
+      def redirected_to(response)
+        return nil  unless response.kind_of?(Net::HTTPRedirection)
+        # Net::HTTPNotModified is undesired subclass of Net::HTTPRedirection so test for this
+        return nil  if response.kind_of?(Net::HTTPNotModified)
+        response['location']
+      end
+
+      def api_request(chef_rest, method, url, headers={}, data=false)
+        json_body = data
+#        json_body = data ? Chef::JSONCompat.to_json(data) : nil
+        # Force encoding to binary to fix SSL related EOFErrors
+        # cf. http://tickets.opscode.com/browse/CHEF-2363
+        # http://redmine.ruby-lang.org/issues/5233
+#        json_body.force_encoding(Encoding::BINARY) if json_body.respond_to?(:force_encoding)
+        headers = build_headers(chef_rest, method, url, headers, json_body)
+
+        chef_rest.retriable_rest_request(method, url, json_body, headers) do |rest_request|
+          response = rest_request.call {|r| r.read_body}
+
+          response_body = chef_rest.decompress_body(response)
+
+          if response.kind_of?(Net::HTTPSuccess)
+            if config[:pretty] && response['content-type'] =~ /json/
+              JSON.pretty_generate(JSON.parse(response_body, :create_additions => false))
+            else
+              response_body
+            end
+          elsif redirect_location = redirected_to(response)
+            raise "Redirected to #{create_url(redirect_location)}"
+            follow_redirect {api_request(:GET, create_url(redirect_location))}
+          else
+            # have to decompress the body before making an exception for it. But the body could be nil.
+            response.body.replace(chef_rest.decompress_body(response)) if response.body.respond_to?(:replace)
+
+            if response['content-type'] =~ /json/
+              exception = response_body
+              msg = "HTTP Request Returned #{response.code} #{response.message}: "
+              msg << (exception["error"].respond_to?(:join) ? exception["error"].join(", ") : exception["error"].to_s)
+              Chef::Log.info(msg)
+            end
+            puts response.body
+            response.error!
+          end
+        end
+      end
+
+      def build_headers(chef_rest, method, url, headers={}, json_body=false, raw=false)
+#        headers                 = @default_headers.merge(headers)
+        #headers['Accept']       = "application/json" unless raw
+        headers['Accept']       = "application/json" unless raw
+        headers["Content-Type"] = 'application/json' if json_body
+        headers['Content-Length'] = json_body.bytesize.to_s if json_body
+        headers[Chef::REST::RESTRequest::ACCEPT_ENCODING] = Chef::REST::RESTRequest::ENCODING_GZIP_DEFLATE
+        headers.merge!(chef_rest.authentication_headers(method, url, json_body)) if chef_rest.sign_requests?
+        headers.merge!(Chef::Config[:custom_http_headers]) if Chef::Config[:custom_http_headers]
+        headers
+      end
+    end
+  end
+end
+

data/lib/chef/knife/search.rb

@@ -75,30 +75,16 @@ class Chef
         :description => "The search query; useful to protect queries starting with -"
 
       def run
-        if config[:query] && @name_args[1]
-          ui.error "please specify query as an argument or an option via -q, not both"
-          ui.msg opt_parser
-          exit 1
-        end
-        raw_query = config[:query] || @name_args[1]
-        if !raw_query || raw_query.empty?
-          ui.error "no query specified"
-          ui.msg opt_parser
-          exit 1
-        end
+        read_cli_args
+        fuzzify_query
 
-        if name_args[0].nil?
-          ui.error "you must specify an item type to search for"
-          exit 1
-        end
-
-        if name_args[0] == 'node'
+        if @type == 'node'
           ui.use_presenter Knife::Core::NodePresenter
         end
 
 
         q = Chef::Search::Query.new
-        query = URI.escape(raw_query,
+        escaped_query = URI.escape(@query,
                            Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
 
         result_items = []
@@ -107,11 +93,11 @@ class Chef
         rows = config[:rows]
         start = config[:start]
         begin
-          q.search(@name_args[0], query, config[:sort], start, rows) do |item|
+          q.search(@type, escaped_query, config[:sort], start, rows) do |item|
             formatted_item = format_for_display(item)
-            if formatted_item.respond_to?(:has_key?) && !formatted_item.has_key?('id')
-              formatted_item['id'] = item.has_key?('id') ? item['id'] : item.name
-            end
+            # if formatted_item.respond_to?(:has_key?) && !formatted_item.has_key?('id')
+            #   formatted_item['id'] = item.has_key?('id') ? item['id'] : item.name
+            # end
             result_items << formatted_item
             result_count += 1
           end
@@ -132,6 +118,38 @@ class Chef
           end
         end
       end
+
+      def read_cli_args
+        if config[:query]
+          if @name_args[1]
+            ui.error "please specify query as an argument or an option via -q, not both"
+            ui.msg opt_parser
+            exit 1
+          end
+          @type = name_args[0]
+          @query = config[:query]
+        else
+          case name_args.size
+          when 0
+            ui.error "no query specified"
+            ui.msg opt_parser
+            exit 1
+          when 1
+            @type = "node"
+            @query = name_args[0]
+          when 2
+            @type = name_args[0]
+            @query = name_args[1]
+          end
+        end
+      end
+
+      def fuzzify_query
+        if @query !~ /:/
+          @query = "tags:*#{@query}* OR roles:*#{@query}* OR fqdn:*#{@query}* OR addresses:*#{@query}*"
+        end
+      end
+
     end
   end
 end