puppet-graph-petems 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83060c133e25d36eb2892012c5e369eb1d8ce6bb
+  data.tar.gz: a76f94e88dc3d9ca823e8a4bcdd417f1305ffbd0
+SHA512:
+  metadata.gz: ba24225d5539ab9053c87f52841bc8a0062009644e6c42f0dab6c1881662b02c1e547181df343804f48e64a09a73fbd912b689868aab9a8196f3f03cd76476f4
+  data.tar.gz: 1354174c09cd9a9ecd3cb8b608ee4d4fc9c7d6e7b3bacdd059f5c71ab1121df7e367d127799d9753d14c480866fcd9631885899574783659a2ce0ce79c5ec86b

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/vendor/gems/
+/Gemfile.lock
+/test.dot
+/test.png
+/test.foo
+/coverage/

data/.travis.yml

@@ -0,0 +1,20 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+script: "bundle exec rspec"
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -qq graphviz
+env:
+  - PUPPET_VERSION=2.6.18
+  - PUPPET_VERSION=2.7.21
+  - PUPPET_VERSION=3.0.2
+  - PUPPET_VERSION=3.1.1
+  - PUPPET_VERSION=3.2.2
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      env: PUPPET_VERSION=2.6.18
+    - rvm: 1.9.3
+      env: PUPPET_VERSION=2.6.18

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+puppet_version = ENV.key?('PUPPET_VERSION') ? "= #{ENV['PUPPET_VERSION']}" : '>= 3'
+
+gem 'puppet', puppet_version
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Tim Sharpe
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Puppet-graph
+[![Build
+Status](https://secure.travis-ci.org/rodjek/puppet-graph.png)](http://travis-ci.org/rodjek/puppet-graph)
+
+Trivially generate dependency graphs for any arbitrary bit of Puppet code (like
+classes or defined types).
+
+## Requirements
+
+ * Graphviz for PNG generation (if `which dot` returns a path, you're good).
+
+## Installation
+
+Install it as a standalone gem
+
+    gem install puppet-graph
+
+Or as part of a bundler managed repo
+
+    group :development do
+      gem 'puppet-graph'
+    end
+
+## Usage
+
+```
+Usage: puppet-graph [options]
+    -c, --code CODE                  Code to generate a graph of
+    -f, --fact FACT=VALUE            Override a Facter fact
+    -m, --modulepath PATH            The path to your Puppet modules. Defaults to modules/
+    -o, --output FILE                The file to save the graph to
+    -r, --format FORMAT              Output format (png or dot). Optional if your output file ends in .dot or .png
+    -h, --help                       Show this help output
+    -v, --version                    Show the version
+```
+
+### Building a graph of a class
+
+```
+$ puppet-graph -c 'include foo' -o foo.png
+```
+
+### Building a graph of a defined type
+
+```
+$ puppet-graph -c "foo { 'bar': baz => 'gronk' }" -o foo.png
+```
+
+### Overriding the value of a fact
+
+```
+$ puppet-graph -c 'include foo' -f 'operatingsystem=Solaris' -o foo.png
+```

data/bin/puppet-graph

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w{.. lib})
+
+require 'puppet-graph'
+require 'puppet-graph/cli'
+
+PuppetGraph::CLI.new.run(ARGV)

data/lib/puppet-graph.rb

@@ -0,0 +1,7 @@
+require 'puppet-graph/grapher'
+require 'puppet-graph/version'
+
+require 'puppet'
+
+module PuppetGraph
+end

data/lib/puppet-graph/cli.rb

@@ -0,0 +1,80 @@
+require 'tempfile'
+require 'optparse'
+
+module PuppetGraph
+  class CLI
+    def run(args)
+      parser.parse!(args)
+
+      validate_options
+
+      g = PuppetGraph::Grapher.new
+      g.fact_overrides = options[:fact]
+      g.modulepath = options[:modulepath]
+      g.code = options[:code]
+      g.draw(options[:format], options[:output_file])
+    end
+
+    private
+
+    def options
+      @options ||= {
+        :modulepath => 'modules',
+      }
+    end
+
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = 'Usage: puppet-graph [options]'
+
+        opts.on '-c', '--code CODE', 'Code to generate a graph of' do |val|
+          options[:code] = val
+        end
+
+        opts.on '-f', '--fact FACT=VALUE', 'Override a Facter fact' do |val|
+          key, value = val.split('=')
+          (options[:fact] ||= {})[key] = value
+        end
+
+        opts.on '-m', '--modulepath PATH', 'The path to your Puppet modules. Defaults to modules/' do |val|
+          options[:modulepath] = val
+        end
+
+        opts.on '-o', '--output FILE', 'The file to save the graph to' do |val|
+          options[:output_file] = val
+          if options[:format].nil?
+            options[:format] = File.extname(options[:output_file])[1..-1].to_sym
+          end
+        end
+
+        opts.on '-r', '--format FORMAT', 'Output format (png or dot). Optional if your output file ends in .dot or .png' do |val|
+          options[:format] = val.to_sym
+        end
+
+        opts.on_tail '-h', '--help', 'Show this help output' do
+          puts parser
+          exit 0
+        end
+
+        opts.on_tail '-v', '--version', 'Show the version' do
+          puts "puppet-graph v#{PuppetGraph::VERSION}"
+          exit 0
+        end
+      end
+    end
+
+    def validate_options
+      if options[:code].nil?
+        $stderr.puts "Error: No Puppet code provided to be graphed."
+        $stderr.puts parser
+        exit 1
+      end
+
+      unless [:dot, :png].include?(options[:format])
+        $stderr.puts "Error: Invalid format specified. Valid formats are: dot, png"
+        $stderr.puts parser
+        exit 1
+      end
+    end
+  end
+end

data/lib/puppet-graph/grapher.rb

@@ -0,0 +1,93 @@
+module PuppetGraph
+  class Grapher
+    attr_accessor :fact_overrides
+    attr_accessor :modulepath
+    attr_accessor :code
+
+    def draw(format, output_file)
+      self.send("draw_#{format}_graph", output_file)
+    end
+
+    def draw_png_graph(output_file)
+      dot_graph = relationship_graph.to_dot('label' => code)
+
+      tmp_dot_file = Tempfile.new('puppet-graph')
+      begin
+        tmp_dot_file.write dot_graph
+        tmp_dot_file.flush
+        `dot -o#{output_file} -Tpng #{tmp_dot_file.path}`
+      ensure
+        tmp_dot_file.close
+        tmp_dot_file.unlink
+      end
+    end
+
+    def draw_dot_graph(output_file)
+      dot_graph = relationship_graph.to_dot('label' => code)
+
+      File.open(output_file, 'wb') do |f|
+        f.puts dot_graph
+      end
+    end
+
+    def relationship_graph
+      @relationship_graph ||= lambda {
+        graph = catalogue.to_ral.relationship_graph
+        graph.vertices.select { |r| r.to_s == 'Class[Settings]' }.each do |vertex|
+          graph.remove_vertex! vertex
+        end
+        graph
+      }.call
+    end
+
+    def catalogue
+      with_tmpdir do |dir|
+        Puppet[:modulepath] = modulepath
+        Puppet[:vardir] = dir
+        Puppet[:confdir] = dir
+        Puppet[:logdir] = dir
+        Puppet[:rundir] = dir
+        Puppet[:code] = code
+
+        stub_facts
+
+        Puppet::Resource::Catalog.indirection.find(node.name, :use_node => node)
+      end
+    end
+
+    def stub_facts
+      if fact_overrides.nil?
+        facts = default_facts
+      else
+        facts = default_facts.merge(fact_overrides)
+      end
+
+      facts.each do |key, value|
+        Facter.add(key) { setcode { value } }
+      end
+
+      node.merge(facts)
+    end
+
+    def default_facts
+      @default_facts ||= {
+        'hostname' => node.name.split('p').first,
+        'fqdn'     => node.name,
+        'domain'   => node.name.split('.').last,
+      }
+    end
+
+    def with_tmpdir
+      dir = Dir.mktmpdir
+      begin
+        yield dir
+      ensure
+        FileUtils.remove_entry_secure dir
+      end
+    end
+
+    def node
+      @node ||= Puppet::Node.new('testnode')
+    end
+  end
+end

data/lib/puppet-graph/version.rb

@@ -0,0 +1,3 @@
+module PuppetGraph
+  VERSION = "0.0.0"
+end

data/puppet-graph.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'puppet-graph/version'
+
+Gem::Specification.new do |s|
+  s.name = 'puppet-graph-petems'
+  s.version = PuppetGraph::VERSION
+  s.homepage = 'https://github.com/rodjek/puppet-graph/'
+  s.summary = ''
+  s.description = ''
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.files = `git ls-files`.split($/)
+  s.executables = s.files.grep(/^bin\//).map { |f| File.basename(f) }
+  s.test_files = s.files.grep(/^(test|spec|features)\//)
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+
+  s.authors = ['Tim Sharpe']
+  s.email = 'tim@sharpe.id.au'
+end

data/spec/fixtures/modules/test/manifests/facter.pp

@@ -0,0 +1,7 @@
+class test::facter {
+  if $::operatingsystem == 'foo' {
+    notify { 'foo': }
+  } else {
+    notify { 'other': }
+  }
+}

data/spec/fixtures/modules/test/manifests/init.pp

@@ -0,0 +1,7 @@
+class test {
+  notify { 'foo': }
+  notify { 'bar': }
+  notify { 'baz': }
+
+  Notify['foo'] -> Notify['bar'] -> Notify['baz']
+}

data/spec/puppet-graph/bin_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+require 'puppet-graph/cli'
+require 'fileutils'
+
+class CommandRun
+  attr_reader :stdout, :stderr, :exitstatus
+
+  def initialize(args)
+    out = StringIO.new
+    err = StringIO.new
+
+    $stdout = out
+    $stderr = err
+
+    @exitstatus = 0
+    begin
+      PuppetGraph::CLI.new.run(args)
+    rescue SystemExit => e
+      @exitstatus = e.status
+    end
+    @stdout = out.string.strip
+    @stderr = err.string.strip
+
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+
+describe PuppetGraph::CLI do
+  subject do
+    if args.is_a? Array
+      sane_args = args
+    else
+      sane_args = [args]
+    end
+
+    CommandRun.new(sane_args)
+  end
+
+  context 'when passed --version' do
+    let(:args) { '--version' }
+
+    its(:exitstatus) { should eq(0) }
+    its(:stdout) { should eq("puppet-graph v#{PuppetGraph::VERSION}") }
+    its(:stderr) { should eq('') }
+  end
+
+  context 'when passed --help' do
+    let(:args) { '--help' }
+
+    its(:exitstatus) { should eq(0) }
+    its(:stderr) { should eq('') }
+    its(:stdout) { should include('Usage: puppet-graph [options]') }
+  end
+
+  context 'when generating PNG graphs' do
+    let(:args) { [
+      '--modulepath', 'spec/fixtures/modules',
+      '--code', 'include test',
+      '--output', 'test.png'
+    ] }
+
+    its(:exitstatus) { should eq(0) }
+
+    it 'should create a PNG image' do
+      subject
+      expect(`file test.png`).to include('PNG image data')
+    end
+  end
+
+  context 'when generating DOT graphs' do
+    let(:args) { [
+      '--modulepath', 'spec/fixtures/modules',
+      '--code', 'include test',
+      '--output', 'test.dot',
+    ] }
+
+    its(:exitstatus) { should eq(0) }
+
+    it 'should create an ASCII file' do
+      subject
+      expect(`file test.dot`).to include('ASCII text')
+    end
+  end
+
+  context 'when overriding output format' do
+    let(:args) { [
+      '--modulepath', 'spec/fixtures/modules',
+      '--code', 'include test',
+      '--format', 'dot',
+      '--output', 'test.png',
+    ] }
+
+    its(:exitstatus) { should eq(0) }
+
+    it 'should create an ASCII file' do
+      subject
+      expect(`file test.png`).to include('ASCII text')
+    end
+  end
+
+  context 'when specifying a fact' do
+    let(:args) { [
+      '--modulepath', 'spec/fixtures/modules',
+      '--code', 'include test::facter',
+      '--fact', 'operatingsystem=foo',
+      '--output', 'test.dot',
+    ] }
+
+    its(:exitstatus) { should eq(0) }
+
+    it 'should contain Notify[foo]' do
+      subject
+      contents = File.read('test.dot')
+      expect(contents).to include('Notify[foo]')
+      expect(contents).to_not include('Notify[other]')
+    end
+  end
+
+  context 'when you dont provide --code' do
+    let(:args) { [
+      '--modulepath', 'spec/fixtures/modules',
+      '--output', 'test.png',
+    ] }
+
+    its(:exitstatus) { should eq(1) }
+    its(:stdout) { should eq('') }
+    its(:stderr) { should include('Error: No Puppet code') }
+    its(:stderr) { should include('Usage: puppet-graph') }
+  end
+
+  context 'when you specify an invalid output format' do
+    let(:args) { [
+      '--modulepath', 'spec/fixtures/modules',
+      '--code', 'include test',
+      '--output', 'test.foo',
+    ] }
+
+    its(:exitstatus) { should eq(1) }
+    its(:stdout) { should eq('') }
+    its(:stderr) { should include('Error: Invalid format') }
+    its(:stderr) { should include('Usage: puppet-graph') }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec/autorun'
+require 'puppet-graph'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/vendor/gems/'
+end
+
+RSpec.configure do |c|
+  c.mock_framework = :rspec
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: puppet-graph-petems
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Tim Sharpe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: tim@sharpe.id.au
+executables:
+- puppet-graph
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- bin/puppet-graph
+- lib/puppet-graph.rb
+- lib/puppet-graph/cli.rb
+- lib/puppet-graph/grapher.rb
+- lib/puppet-graph/version.rb
+- puppet-graph.gemspec
+- spec/fixtures/modules/test/manifests/facter.pp
+- spec/fixtures/modules/test/manifests/init.pp
+- spec/puppet-graph/bin_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rodjek/puppet-graph/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/fixtures/modules/test/manifests/facter.pp
+- spec/fixtures/modules/test/manifests/init.pp
+- spec/puppet-graph/bin_spec.rb
+- spec/spec_helper.rb
+has_rdoc: