knife-graph 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+.idea
+*.iml
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+# See knife-graph.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [2013] [Or Cohen]
+
+   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/README.md

@@ -0,0 +1,54 @@
+knife-graph plugin
+==================
+
+A knife plugin that creates a graph out of various Chef resources.
+
+Currently the only supported output is the mapping from roles to other roles and recipes (run_list).
+
+Requirements
+------------
+
+* graphviz
+
+SUBCOMMANDS
+===========
+
+Only one knife subcommand is supported. More will probably be added later, to support different resource mappings.
+
+knife graph
+-----------
+
+This plugin uses graphviz's dot to render the graph to jpg. Running the following command will create the file
+knife-graph.jpg with the exported data.
+
+    knife graph # => knife-graph.jpg
+
+A couple of options are available:
+
+### Environment
+
+If environment is set (-E|--environment), the plugin will use the environment specific run_list if exists. i.e. the
+same resolving Chef does when executing a run_list.
+
+### -O FILENAME, --output=FILENAME
+
+Sets the output filename (and type according to the extension, [supported types](http://www.graphviz.org/doc/info/output.html))
+If the .dot extension is used, no rendering is performed. With .dot you could use the file, to make custom manipulations
+or render it using your favorite tool. Use a dash (`-`) to set output to STDOUT.
+
+### -t TYPE, --type=TYPE
+
+If STDOUT output is used, this option sets the type. Otherwise, ignored. (Default is jpg)
+
+### Examples
+
+    knife graph -E production # => knife-graph.jpg using environment run_list of production if available
+    knife graph -O knife-graph.bmp # => knife-graph.bmp
+    knife graph -O knife-graph.dot # => knife-graph.dot
+    knife graph -O- -tjpg > my-chef-installation.jpg # => JPG output to STDOUT
+
+Build and Install
+-----------------
+
+    $ rake gem
+    $ gem install pkg/knife-graph-VERSION.gem

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rubygems/package_task'
+
+Dir[File.expand_path('../*gemspec', __FILE__)].reverse.each do |gemspec_path|
+  gemspec = eval(IO.read(gemspec_path))
+  Gem::PackageTask.new(gemspec).define
+end
+
+task :default, :gem

data/knife-graph.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'knife-graph/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'knife-graph'
+  s.version     = Knife::Graph::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Or Cohen']
+  s.email       = ['orc@fewbytes.com']
+  s.homepage    = 'https://github.com/fewbytes/knife-graph'
+  s.summary     = %q{Plugin that exports Chef installations structure in a graph}
+  s.description = s.summary
+
+  s.add_dependency 'graph'
+  s.add_dependency 'mixlib-shellout'
+
+  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/graph.rb

@@ -0,0 +1,84 @@
+require 'chef/knife'
+
+module KnifeGraph
+  class Graph < Chef::Knife
+    deps do
+      require 'graph'
+      require 'mixlib/shellout'
+    end
+
+    banner "knife graph (options)"
+
+    option :output,
+           :short => '-O',
+           :long => '--output VALUE',
+           :description => 'The output filename. See http://www.graphviz.org/doc/info/output.html for supported file types. \'-\' for STDOUT (Default is knife-graph.dot)',
+           :default => 'knife-graph.jpg'
+
+    option :type,
+           :short => '-t',
+           :long => '--type TYPE',
+           :description => 'If STDOUT is used as output, specify the output type. Ignored otherwise (Default is jpg)',
+           :default => 'jpg'
+
+    def run
+      if config[:environment] and not Chef::Environment.list.find { |e, url| e == config[:environment] }
+        raise "Environment '#{config[:environment]}' not found"
+      end
+
+      graph = ::Graph.new
+
+      Chef::Role.list.each do |r, url|
+        r_node = "role:#{r}"
+
+        graph.node(r_node, r)
+        graph.square << graph.node(r_node)
+
+        role = Chef::Role.load(r)
+
+        role.run_list_for(config[:environment]).recipe_names.each do |recipe|
+          graph.edge r_node, "recipe:#{recipe}"
+          graph.node("recipe:#{recipe}", recipe)
+        end
+
+        role.run_list_for(config[:environment]).role_names.each do |role_name|
+          role_node = "role:#{role_name}"
+          graph.node(role_node, role_name)
+          graph.square << graph.node(role_node)
+          graph.edge r_node, role_node
+        end
+      end
+
+      # Graph dot data
+      dot_str = graph.to_s
+
+      # Determine the requested output type
+      output_type = if config[:output] == '-'
+                      config[:type]
+                    else
+                      File.extname(config[:output]).split('.').last
+                    end
+
+      # Determine the right output
+      if output_type == 'dot'
+        graph_data = dot_str
+      else
+        dot = Mixlib::ShellOut.new("dot -T#{output_type}", :input => dot_str)
+        graph_data = dot.run_command.stdout
+      end
+
+      # Write the data to STDOUT or file
+      if config[:output] == '-'
+        print graph_data
+      else
+        File.open config[:output], 'w' do |f|
+          f.print graph_data
+        end
+      end
+
+      if config[:verbosity] > 0 and config[:output] != '-'
+        ui.info("Generated #{config[:output]} for environment #{config[:environment] ? config[:environment] : '_default'}")
+      end
+    end
+  end
+end

data/lib/knife-graph/version.rb

@@ -0,0 +1,6 @@
+module Knife
+  module Graph
+    VERSION = '0.0.2'
+    MAJOR, MINOR, TINY = VERSION.split('.')
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: knife-graph
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Or Cohen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graph
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Plugin that exports Chef installations structure in a graph
+email:
+- orc@fewbytes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- knife-graph.gemspec
+- lib/chef/knife/graph.rb
+- lib/knife-graph/version.rb
+homepage: https://github.com/fewbytes/knife-graph
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Plugin that exports Chef installations structure in a graph
+test_files: []