knife-audit 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in knife-audit.gemspec
+gemspec

data/README.md

@@ -0,0 +1,55 @@
+knife-audit
+========
+A knife plugin for determining which cookbooks are in use on which nodes of your Chef server or Opscode organization.
+Allows you to safely maintain a chef cookbook set by determining which cookbooks are currently in use by nodes (included in node runlists).
+
+
+Installing knife-audit
+-------------------
+
+#### Script install
+
+Copy the knife-audit script from https://github.com/jbz/knife-audit/blob/master/lib/chef/knife/audit.rb to your .chef/plugins/knife directory.
+
+
+Usage
+---------------
+
+    knife audit <COOKBOOK COOKBOOK ...>
+
+If no cookbooks are specified, knife-audit will return a list of *all* cookbooks available on the currently configured Chef server or Opscode Platform organization, along with a count for each of how many nodes in the current Chef server or Opscode Platform organization explicitly reference that cookbook in their expanded runlist. 
+
+Note that this does *not* include nodes that call the cookbook via 'include' and/or 'depends' statements.  The 'complete runlist' for nodes, which includes all cookbooks pulled in due to includes, is kept in Node.run_state.seen_recipes], but this is an ephemeral attribute and is only populated locally on the node during a client run.  It is not saved to the Chef server, therefore knife-audit cannot 'see' it.
+
+If one or more cookbook names are specified on the command line, knife-audit will return a list of only those cookbooks and their counts.  Specifying a cookbook which is not available on the Chef server will result in an error.
+
+The '-s' or '--show-nodelist' option will cause knife-audit to include in its output a list of all nodes which reference each cookbook.
+
+**NOTE** knife-audit retrieves an array of *all* nodes present on your chef server for each run.  As a result, it is relatively slow; if you have many ( >= 16) nodes, it will take noticeable wallclock time to complete its run.  In addition. it may use lots of memory to hold those node objects.
+
+
+Disclaimer
+----------
+
+This is my first knife plugin, and I haven't been using Ruby that long.  Plus, I'm an op, not a software engineer. :-)  If you run into problems with knife-audit, by all means let me know; you can find me via the github page or on irc at freenode #chef, usually.  Thanks.
+
+
+License terms
+-------------
+Authors:: J.B. Zimmerman 
+Copyright:: Copyright (c) 2009-2011 J.B. Zimmerman
+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.
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/knife-audit.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "knife-audit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "knife-audit"
+  s.version     = Knife::Audit::VERSION
+  s.authors     = ["Jacob Zimmerman"]
+  s.email       = ["jzimmerman@mdsol.com"]
+  s.homepage    = "https://github.com/jbz/knife-audit"
+  s.summary     = %q{A Chef plugin for determining which cookbooks are in use on which nodes of your Chef server or Opscode organization.}
+  s.description = %q{Allows you to safely maintain a chef cookbook set by determining which cookbooks are currently in use by nodes (included in node runlists).}
+
+  s.rubyforge_project = "knife-audit"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/chef/knife/audit.rb

@@ -0,0 +1,136 @@
+#
+## Author:: Jacob Zimmermann (<jzimmerman@mdsol.com>)
+##
+## 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'
+ 
+module KnifeAudit
+  class Audit < Chef::Knife
+ 
+    deps do
+      require 'chef/cookbook_loader'
+      require 'chef/environment'
+      require 'chef/node'
+      require 'chef/run_list'
+      require 'chef/json_compat' 
+      require 'chef/shef/ext'
+    end
+ 
+    banner "knife audit <COOKBOOK COOKBOOK ...>"
+ 
+    option :show_nodelist,
+      :short => "-s",
+      :long => "--show-nodelist",
+      :description => "Show all nodes running each cookbook"
+
+    def run
+
+      if @name_args.empty? 
+        display_cookbooks = {}
+      else
+        display_cookbooks = @name_args 
+      end
+
+      self.config = Chef::Config.merge!(config)
+   
+      # 1) Get a list (hash, actually, with key of 'name') of cookbooks available on the current server/org
+      #    unless we've been given a cookbook/cookbooks on the command line
+      env		= config[:environment]
+      num_versions 	= config[:all_versions] ? "num_versions=all" : "num_versions=1"
+      
+      if display_cookbooks.empty?
+        api_endpoint	= env ? "/environments/#{env}/cookbooks?#{num_versions}" : "/cookbooks?#{num_versions}"
+        cookbook_list	= rest.get_rest(api_endpoint)
+      else
+        cookbook_list	= {}
+        display_cookbooks.each do |cookbook_name|
+          api_endpoint	= env ? "/environments/#{env}/cookbooks/#{cookbook_name}" : "cookbooks/#{cookbook_name}"
+          begin
+            cookbook_list.merge!(rest.get_rest(api_endpoint))
+          rescue
+            ui.error("Cookbook #{cookbook_name} could not be found on the server!")
+            exit 1
+          end 
+        end 
+
+      end
+
+
+      # add count => 0 to each cookbook hash
+      cookbook_list.each do |name,book|
+        book["count"] = 0 
+        book["nodes"] = []
+      end
+
+
+      # 2) Get an array of Chef::Nodes known to the current server/org
+
+      query = "*:*"  # find all nodes
+
+      Shef::Extensions.extend_context_object(self)
+      node_list = nodes.find(query) 
+
+      # 3) Iterate over each node
+
+      node_list.each do |node|
+
+        # 3a) Get node's runlist
+
+        # using expand!.recipes catches multi-level roles (roles with roles with recipes, etc.)
+        recipes = node.expand!.recipes.to_a
+        node_cookbook_list = recipes.map{ |x| x.match(/[^\:]+/)[0] }.uniq
+
+        # 3b) For each cookbook in the node runlist, if it's in our cookbook array increment its count and
+        #     add the node to its running node array
+
+        node_cookbook_list.each do |cookbook|
+	  if cookbook_list.has_key?(cookbook)
+            # Up the cookbook count
+            cookbook_list[cookbook]["count"] += 1
+            # Add the node to the cookbook's nodes array 
+            cookbook_list[cookbook]["nodes"] << node.name
+          end
+        end
+
+      end # step 3 iterate end
+
+      # 4) Output
+
+      format_cookbook_audit_list_for_display(cookbook_list).each do |line|
+        ui.msg(line)
+      end
+
+    end # 'run' def end
+
+
+    def format_cookbook_audit_list_for_display(item)
+      key_length = item.empty? ? 0 : item.keys.map {|name| name.size }.max + 2
+      if config[:show_nodelist]
+        item.sort.map do |name, cookbook|
+          "#{name.ljust(key_length)} #{cookbook["count"]}   [ #{cookbook["nodes"].join('  ')} ]"
+        end
+      else
+        item.sort.map do |name, cookbook|
+          "#{name.ljust(key_length)} #{cookbook["count"]}"
+        end
+      end
+         
+    end # format_cokbook_audit... def end
+
+
+  end #class end
+
+end #module end

data/lib/knife-audit/version.rb

@@ -0,0 +1,5 @@
+module Knife
+  module Audit
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: knife-audit
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jacob Zimmerman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-31 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Allows you to safely maintain a chef cookbook set by determining which cookbooks are currently in use by nodes (included in node runlists).
+email: 
+- jzimmerman@mdsol.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.md
+- Rakefile
+- knife-audit.gemspec
+- lib/chef/knife/audit.rb
+- lib/knife-audit/version.rb
+has_rdoc: true
+homepage: https://github.com/jbz/knife-audit
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: knife-audit
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A Chef plugin for determining which cookbooks are in use on which nodes of your Chef server or Opscode organization.
+test_files: []
+