knife-preflight 0.1.0

data/README.md

@@ -0,0 +1,16 @@
+# knife-preflight
+
+A preflight plugin for Chef::Knife which lets you see which nodes and roles use a particular cookbook before you upload it.
+
+## Preface
+
+Searches the expanded run_lists of all nodes along with the run_list of all roles for the specified cookbook
+
+## What it does
+
+knife preflight apache2::default
+will return a list of all nodes containing this cookbook in their expanded run_list followed by all nodes with the cookbook in their expanded run_list
+
+## Notes
+This will currently only search for cookbooks. It won't work if you specify a role on the command line because I've tried to avoid duplication of functionality which knife makes obvious. 
+

data/lib/chef/knife/preflight.rb

@@ -0,0 +1,147 @@
+#
+# Author:: Jon Cowie (<jonlives@gmail.com>)
+# Copyright:: Copyright (c) 2011 Jon Cowie
+# License:: GPL
+
+# Based on the knife chef plugin by:
+# Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2009 Opscode, Inc.
+
+require 'chef/knife'
+require 'chef/knife/core/node_presenter'
+
+module KnifePreflight
+  class Preflight < Chef::Knife
+
+      deps do
+        require 'chef/node'
+        require 'chef/environment'
+        require 'chef/api_client'
+        require 'chef/search/query'
+      end
+
+      include Chef::Knife::Core::NodeFormattingOptions
+
+      banner "knife preflight QUERY (options)"
+
+      option :sort,
+        :short => "-o SORT",
+        :long => "--sort SORT",
+        :description => "The order to sort the results in",
+        :default => nil
+
+      option :start,
+        :short => "-b ROW",
+        :long => "--start ROW",
+        :description => "The row to start returning results at",
+        :default => 0,
+        :proc => lambda { |i| i.to_i }
+
+      option :rows,
+        :short => "-R INT",
+        :long => "--rows INT",
+        :description => "The number of rows to return",
+        :default => 1000,
+        :proc => lambda { |i| i.to_i }
+
+
+      def run
+        if config[:query] && @name_args[0]
+          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[0]
+        if !raw_query || raw_query.empty?
+          ui.error "no query specified"
+          ui.msg opt_parser
+          exit 1
+        end
+
+        q_nodes = Chef::Search::Query.new
+
+
+        escaped_query = raw_query.sub( "::", "\\:\\:")
+        node_query = "recipes:*#{escaped_query}"
+        query_nodes = URI.escape(node_query,
+                           Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+
+        result_items_nodes = []
+        result_count_nodes = 0
+
+        ui.msg("Searching for nodes containing #{raw_query} in their expanded run_list...\n")
+
+        rows = config[:rows]
+        start = config[:start]
+        begin
+          q_nodes.search('node', query_nodes, config[:sort], start, rows) do |node_item|
+            formatted_item_node = format_for_display(node_item)
+            if formatted_item_node.respond_to?(:has_key?) && !formatted_item_node.has_key?('id')
+              formatted_item_node['id'] = node_item.has_key?('id') ? node_item['id'] : node_item.name
+            end
+            result_items_nodes << formatted_item_node
+            result_count_nodes += 1
+          end
+        rescue Net::HTTPServerException => e
+          msg = Chef::JSONCompat.from_json(e.response.body)["error"].first
+          ui.error("knife preflight failed: #{msg}")
+          exit 1
+        end
+
+        if ui.interchange?
+          output({:results => result_count_nodes, :rows => result_items_nodes})
+        else
+          ui.msg "#{result_count_nodes} Nodes found"
+          ui.msg("\n")
+          result_items_nodes.each do |item|
+            output(item.name)
+          end
+        end
+
+        ui.msg("\n")
+        ui.msg("\n")
+
+
+        q_roles = Chef::Search::Query.new
+        role_query = "run_list:recipe\\[#{escaped_query}\\]"
+        query_roles = URI.escape(role_query,
+                           Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+
+        result_items_roles = []
+        result_count_roles = 0
+
+        ui.msg("Searching for roles containing #{raw_query} in their run_list...\n")
+
+        rows = config[:rows]
+        start = config[:start]
+        begin
+          q_roles.search('role', query_roles, config[:sort], start, rows) do |role_item|
+            formatted_item_role = format_for_display(role_item)
+            if formatted_item_role.respond_to?(:has_key?) && !formatted_item_role.has_key?('id')
+              formatted_item_role['id'] = role_item.has_key?('id') ? role_item['id'] : role_item.name
+            end
+            result_items_roles << formatted_item_role
+            result_count_roles += 1
+          end
+        rescue Net::HTTPServerException => e
+          msg = Chef::JSONCompat.from_json(e.response.body)["error"].first
+          ui.error("knife preflight failed: #{msg}")
+          exit 1
+        end
+
+        if ui.interchange?
+          output({:results => result_count_roles, :rows => result_items_roles})
+        else
+          ui.msg "#{result_count_roles} Roles found"
+          ui.msg("\n")
+          result_items_roles.each do |role_item|
+            output(role_item.name)
+          end
+        end
+
+        ui.msg("\n")
+        ui.msg("\n")
+        ui.msg("Found #{result_count_nodes} nodes and #{result_count_roles} roles using the specified search criteria")
+      end
+    end
+  end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: knife-preflight
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jon Cowie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-31 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: chef
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 4
+        version: 0.10.4
+  type: :runtime
+  version_requirements: *id001
+description: Knife plugin for checking what your cookbook changes will affect
+email: jonlives@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- lib/chef/knife/preflight.rb
+has_rdoc: true
+homepage: https://github.com/jonlives/knife-preflight
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: knife-preflight
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: Knife plugin for checking what your cookbook changes will affect
+test_files: []
+