knife-crawl 0.0.1

data/README.md

@@ -0,0 +1,22 @@
+# knife-crawl
+
+A plugin for Chef::Knife which displays the roles that are included recursively within a role and optionally displays all the roles that include it.
+
+## Usage 
+
+Supply a role name to get a dump of its hierarchy, pass -i for the roles that also include it
+
+```
+% knife crawl VMDevStack -i                                                                                                                         ✹
+
+VMDevStack child hierarchy:
+ * VMDevStack
+   * SharedDevStack
+
+VMDevStack is included in the following roles:
+   * VMBase
+```
+
+## Installation
+
+Drop into your ~/.chef/plugins/knife/ dir

data/lib/chef/knife/crawl.rb

@@ -0,0 +1,127 @@
+#
+# Author:: John Goulah (<jgoulah@gmail.com>)
+# Copyright:: Copyright (c) 2011 John Goulah
+#
+## 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.
+##
+#
+
+module GoulahKnifePlugins
+  class Crawl < Chef::Knife
+
+    banner "knife crawl ROLE"
+
+    def initialize(*args)
+      @level = 0
+      super
+    end
+
+    deps do
+      require 'chef/role'
+      require 'chef/search/query'
+    end
+
+    option :included,
+      :short => '-i',
+      :long => '--included',
+      :boolean => true,
+      :default => false,
+      :description => "Find the roles this role is included in"
+
+    def run
+      unless name_args.size == 1
+        puts "You need to supply a role"
+        show_usage
+        exit 1
+      end
+
+      if config[:verbosity] == 1
+        @verbose = true
+      end
+
+      role_name = name_args.first
+
+      output "\n#{role_name} child hierarchy:"
+      output " * " + role_name
+      crawl_role(role_name)
+
+      if config[:included]
+        output "\n#{role_name} is included in the following roles:"
+        included_from(role_name)
+      end
+    end
+
+    def included_from(role_name)
+        @level += 1
+        q_roles = Chef::Search::Query.new
+        query = "run_list:role\\[#{role_name}\\]"
+
+        begin
+          rows, start, total = q_roles.search('role', query, nil, 0, 1000)
+
+          if total == 0
+            output "none"
+          end
+
+          rows.each do |role|
+            output " * " + role.name
+          end
+        rescue Net::HTTPServerException => e
+          msg = Chef::JSONCompat.from_json(e.response.body)["error"].first
+          ui.error("knife crawl failed: #{msg}")
+          exit 1
+        end
+    end
+
+    def crawl_role(role_name)
+      @level += 1
+      role = Chef::Role.load(role_name)
+
+      if !has_roles? role and @verbose
+        output " - no further roles found under " + role_name
+      end
+
+      loop_run_list role do |item|
+        output " * " + item.name
+        crawl_role(item.name)
+      end
+
+      @level -= 1
+    end
+
+    def loop_run_list(role, &blk)
+      role.run_list.each do |item|
+        if item.role?
+          yield item
+        end
+      end
+    end
+
+    def output(msg)
+      ui.msg(indent_str + msg)
+    end
+
+    def indent_str
+        str = ""
+        @level.times { str << "  " }
+        return str
+    end
+
+    # search the run_list for roles (since it has roles and recipes)
+    def has_roles?(role)
+      loop_run_list(role) { return true }
+      return false
+    end
+
+  end
+end

data/lib/knife-crawl/version.rb

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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: knife-crawl
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- John Goulah
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-02 00:00:00 Z
+dependencies: []
+
+description: A plugin for Chef::Knife which displays the roles that are included recursively within a role and optionally displays all the roles that include it.
+email: 
+- jgoulah@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/chef/knife/crawl.rb
+- lib/knife-crawl/version.rb
+homepage: https://github.com/jgoulah/knife-crawl
+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: 
+rubygems_version: 1.8.13
+signing_key: 
+specification_version: 3
+summary: A plugin for Chef::Knife which displays the roles that are included recursively within a role and optionally displays all the roles that include it.
+test_files: []
+