fizzgig 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+
+.ruby-version

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/TODO.org

@@ -0,0 +1,72 @@
+
+* Config options used by rspec-puppet:
+Puppet[:certname]
+Puppet[:code]
+Puppet[:config]
+Puppet[:libdir]
+Puppet[:manifest]
+Puppet[:manifestdir]
+Puppet[:modulepath]
+Puppet[:templatedir]
+** rspec config added by rspec-puppet
+RSpec.configure do |c|
+  c.add_setting :module_path, :default => '/etc/puppet/modules'
+  c.add_setting :manifest_dir, :default => nil
+  c.add_setting :manifest, :default => nil
+  c.add_setting :template_dir, :default => nil
+  c.add_setting :config, :default => nil
+end
+* Feature ideas
+** DONE Test defined types
+** DONE Test templates
+** DONE test for creation of namespaced types
+** DONE test that created types actually exist
+** DONE play nicely with rspec-puppet
+** DONE Stub puppet functions (inc extlookup and hiera)
+** DONE Test classes
+** DONE Stub facts
+
+from rspec-puppet?
+
+node_obj = Puppet::Node.new(nodename) # default to Puppet[:certname]?
+node_obj.merge(facts_val) # but what is this?
+
+** TODO Document it!
+** TODO Ensure that modulepath can take multiple directories
+   - in govuk/puppet, we had trouble having multiple directories on
+     the module path, so we ended up doing this:
+
+#+BEGIN_SRC ruby
+  RSpec.configure do |c|
+    c.module_path = File.join(HERE, 'modules')
+  # ...
+  end
+  
+  # note monkey-patch here because the modulepath isn't working
+  module RSpec::Puppet
+    module Support
+      alias_method :real_build_catalog, :build_catalog
+      def build_catalog (nodename, fact_val, code)
+        Puppet[:modulepath] = File.join(HERE, 'modules') + ':' + File.join(HERE, 'vendor', 'modules')
+        real_build_catalog(nodename,fact_val,code)
+      end
+    end
+  end
+#+END_SRC
+
+That's not so cool :(
+
+** TODO Rename
+** TODO Release it!
+** TODO implementation-independent dependency assertions
+** TODO Test standalone puppet modules
+** TODO better test output for files with large content
+** TODO Test puppet types (ie from lib/puppet/parser/types)
+** TODO Test templates in isolation
+** TODO Test custom facts
+** TODO Virtual/exported resources
+** TODO Parameterized classes
+** TODO Preconditions (do I actually want this?)
+** TODO nodes
+See govuk_nodes_spec_optional for examples of this.
+the rspec-puppet equivalent is :type => :host

data/fizzgig.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = 'fizzgig'
+  s.version = '0.1.0'
+  s.homepage = 'https://github.com/philandstuff/fizzgig'
+  s.summary = 'Tools for writing fast unit tests for Puppet'
+  s.description = 'Tools for writing fast unit tests for Puppet'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_dependency 'puppet'
+  s.add_dependency 'lspace'
+  s.add_development_dependency 'rspec'
+
+  s.authors = ['Philip Potter']
+  s.email = 'philip.g.potter@gmail.com'
+end

data/lib/fizzgig.rb

@@ -0,0 +1,66 @@
+require 'puppet'
+require 'fizzgig/matchers'
+require 'fizzgig/function_stubs'
+require 'lspace'
+
+module Fizzgig
+  def self.instantiate(code,options = {})
+    LSpace.with(:function_stubs => options[:stubs]) do
+      setup_puppet
+      compiler = make_compiler(options[:facts])
+      resources = compile(code,compiler)
+      resources[0].evaluate
+      compiler.catalog
+    end
+  end
+
+  def self.include(klass,options = {})
+    LSpace.with(:function_stubs => options[:stubs]) do
+      setup_puppet
+      compiler = make_compiler(options[:facts])
+      compile("include #{klass}",compiler)
+      compiler.catalog
+    end
+  end
+
+  def self.make_compiler(facts)
+    node = Puppet::Node.new('localhost')
+    node.merge(facts) if facts
+    compiler = Puppet::Parser::Compiler.new(node)
+    compiler.send :set_node_parameters
+    compiler.send :evaluate_main
+    compiler
+  end
+
+  def self.compile(code,compiler)
+    resources_for(ast_for(code,compiler),compiler)
+  end
+
+  def self.resources_for(ast,compiler)
+    scope = compiler.newscope(nil)
+    scope.source = Puppet::Resource::Type.new(:node,'localhost')
+    ast.code[0].evaluate(scope)
+  end
+
+  def self.ast_for(code,compiler)
+    parser = Puppet::Parser::Parser.new compiler.environment.name
+    parser.parse(code)
+  end
+
+  def self.setup_puppet
+    Puppet[:manifestdir] = ''
+    Puppet[:modulepath] = RSpec.configuration.modulepath
+    # stop template() fn from complaining about missing vardir config
+    Puppet[:templatedir] = ""
+  end
+end
+
+RSpec.configure do |c|
+  c.add_setting :modulepath, :default => '/etc/puppet/modules'
+
+  # FIXME: decide if these are needed
+  #c.add_setting :manifestdir, :default => nil
+  #c.add_setting :manifest, :default => nil
+  #c.add_setting :template_dir, :default => nil
+  #c.add_setting :config, :default => nil
+end

data/lib/fizzgig/function_stubs.rb

@@ -0,0 +1,29 @@
+
+module Fizzgig::FunctionStubs
+  def self.has_stub?(fname,args)
+    stubs = LSpace[:function_stubs] || {}
+    stubs.has_key?(fname.to_sym) &&
+      stubs[fname.to_sym].has_key?(args[0])
+  end
+
+  def self.get_stub(fname,args)
+    LSpace[:function_stubs][fname.to_sym][args[0]]
+  end
+end
+
+class Puppet::Parser::AST
+  class Function < AST::Branch
+    alias_method :orig_evaluate, :evaluate
+
+    def evaluate(scope)
+      #FIXME: are there implications around potential
+      #double-evaluation here?
+      args = @arguments.safeevaluate(scope).map { |x| x == :undef ? '' : x }
+      if Fizzgig::FunctionStubs.has_stub?(@name,args)
+        Fizzgig::FunctionStubs.get_stub(@name,args)
+      else
+        orig_evaluate(scope)
+      end
+    end
+  end
+end

data/lib/fizzgig/matchers.rb

@@ -0,0 +1,67 @@
+require 'rspec'
+module Fizzgig
+  module CatalogMatchers
+    extend RSpec::Matchers::DSL
+
+    class CatalogMatcher
+      #    matcher :contain_file do |expected_title|
+      def initialize(expected_type,expected_title)
+        @expected_type = expected_type
+        @expected_title = expected_title
+        @referenced_type = referenced_type(expected_type)
+      end
+
+      def matches?(catalog)
+        @catalog = catalog
+        resource = catalog.resource(@referenced_type,@expected_title)
+        if resource then
+          (@expected_params || {}).all? do |name,expected_val|
+            if expected_val.kind_of?(Regexp)
+              resource[name] =~ expected_val
+            else
+              resource[name] == expected_val
+            end
+          end
+        else
+          false
+        end
+      end
+
+      def failure_message_for_should
+        param_string = ""
+        if @expected_params
+          param_string = " with parameters #{@expected_params.inspect}"
+        end
+        possible_resource = @catalog.resource(@referenced_type,@expected_title)
+        actual = possible_resource ? possible_resource.inspect : "the catalog"
+        "expected #{actual} to contain #{@referenced_type}[#{@expected_title}]#{param_string}"
+      end
+
+      def method_missing(method, *args, &block)
+        if method.to_s =~ /^with_/
+          param = method.to_s.gsub(/^with_/,'')
+          @expected_params ||= {}
+          @expected_params[param] = args[0]
+          self
+        else
+          super
+        end
+      end
+
+      private
+
+      def referenced_type(type)
+        type.split('__').map { |r| r.capitalize }.join('::')
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /^contain_/
+        resource_type = method.to_s.gsub(/^contain_/,'')
+        CatalogMatcher.new(resource_type,args[0])
+      else
+        super
+      end
+    end
+  end
+end

data/spec/fizzgig_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'fizzgig'
+
+describe Fizzgig do
+  context 'when instantiating defined types' do
+    it 'should test existence of file with parameters' do
+      instance_code = %q[nginx::site {'foo': content => 'dontcare'}]
+      instance = Fizzgig.instantiate(instance_code)
+      instance.should contain_file('/etc/nginx/sites-enabled/foo').
+        with_ensure('present').
+        with_mode('0440')
+    end
+
+    it 'should test resources other than files' do
+      instance_code = %q[nginx::site {'foo': content => 'dontcare'}]
+      instance = Fizzgig.instantiate(instance_code)
+      instance.should contain_user('www-data')
+    end
+
+    it 'should test presence of namespaced type' do
+      instance_code = %q[nginx::simple_server {'foo':}]
+      instance = Fizzgig.instantiate(instance_code)
+      instance.should contain_nginx__site('foo')
+    end
+
+    it 'should test content from a template' do
+      instance_code = %q[nginx::simple_server {'foo':}]
+      instance = Fizzgig.instantiate(instance_code)
+      instance.should contain_nginx__site('foo').
+        with_content(/server_name foo;/)
+    end
+  end
+
+  it 'should test classes' do
+    catalog = Fizzgig.include 'webapp'
+    catalog.should contain_nginx__site('webapp')
+  end
+
+  context 'when stubbing function calls' do
+    it 'should return the value given' do
+      stubs = {:extlookup => {'ssh-key-barry' => 'the key of S'}}
+      catalog = Fizzgig.include('functions::class_test', :stubs => stubs)
+      catalog.should contain_ssh_authorized_key('barry').with_key('the key of S')
+    end
+
+    it 'should return the value given when instantiating a defined type' do
+      stubs = {:extlookup => {'ssh-key-barry' => 'the key of S'}}
+      catalog = Fizzgig.instantiate(%[functions::define_test{'foo': }], :stubs => stubs)
+      catalog.should contain_ssh_authorized_key('barry').with_key('the key of S')
+    end
+
+    context 'when stubbing data different to that provided' do
+      it 'should throw an exception' do
+        stubs = {:extlookup => {'bananas' => 'potassium'}}
+        expect { catalog = Fizzgig.include('functions::class_test',:stubs=>stubs) }.
+          to raise_error Puppet::Error
+      end
+    end
+  end
+
+  context 'when providing recursive stubs' do
+    it 'should return the value given' do
+      stubs = {:extlookup =>
+        { 'ssh-key-barry' => 'rsa-key-barry',
+          'rsa-key-barry' => 'the key of S'}}
+      Fizzgig.include('functions::recursive_extlookup_test', :stubs => stubs).
+        should contain_ssh_authorized_key('barry').with_key('the key of S')
+    end
+  end
+
+  context 'when stubbing facts' do
+    context 'while instantiating defined types' do
+      it 'should lookup unqualified fact from stub' do
+        catalog = Fizzgig.instantiate(%q[facts::define_test{'test':}], :facts => {'unqualified_fact' => 'hello world'})
+        catalog.should contain_notify('unqualified-fact-test').with_message('hello world')
+      end
+
+      it 'should lookup qualified fact from stub' do
+        catalog = Fizzgig.instantiate(%q[facts::define_test{'test':}], :facts => {'qualified_fact' => 'hello world'})
+        catalog.should contain_notify('qualified-fact-test').with_message('hello world')
+      end
+    end
+
+    context 'while including classes' do
+      it 'should lookup unqualified fact from stub' do
+        catalog = Fizzgig.include('facts::class_test', :facts => {'unqualified_fact' => 'hello world'})
+        catalog.should contain_notify('unqualified-fact-test').with_message('hello world')
+      end
+
+      it 'should lookup qualified fact from stub' do
+        catalog = Fizzgig.include('facts::class_test', :facts => {'qualified_fact' => 'hello world'})
+        catalog.should contain_notify('qualified-fact-test').with_message('hello world')
+      end
+
+      it 'should lookup fact by instance variable from within template' do
+        catalog = Fizzgig.include('facts::template_test', :facts => {'template_visible_fact' => 'hello world'})
+        catalog.should contain_file('template-test').with_content(/instance_fact:hello world/)
+      end
+
+      it 'should lookup fact by accessor method from within template' do
+        catalog = Fizzgig.include('facts::template_test', :facts => {'template_visible_fact' => 'hello world'})
+        catalog.should contain_file('template-test').with_content(/accessor_fact:hello world/)
+      end
+
+      it 'should lookup fact by scope.lookupvar from within template' do
+        catalog = Fizzgig.include('facts::template_test', :facts => {'template_visible_fact' => 'hello world'})
+        catalog.should contain_file('template-test').with_content(/scope_lookup_fact:hello world/)
+      end
+    end
+  end
+end

data/spec/modules/facts/manifests/class_test.pp

@@ -0,0 +1,8 @@
+class facts::class_test {
+  notify {
+    'unqualified-fact-test':
+      message => $unqualified_fact;
+    'qualified-fact-test':
+      message => $::qualified_fact;
+  }
+}

data/spec/modules/facts/manifests/define_test.pp

@@ -0,0 +1,8 @@
+define facts::define_test() {
+  notify {
+    'unqualified-fact-test':
+      message => $unqualified_fact;
+    'qualified-fact-test':
+      message => $::qualified_fact;
+  }
+}

data/spec/modules/facts/manifests/template_test.pp

@@ -0,0 +1,5 @@
+class facts::template_test {
+  file {'template-test':
+    content => template('facts/template-test.erb'),
+  }
+}

data/spec/modules/facts/templates/template-test.erb

@@ -0,0 +1,3 @@
+instance_fact:<%= @template_visible_fact %>
+accessor_fact:<%= template_visible_fact %>
+scope_lookup_fact:<%= scope.lookupvar('template_visible_fact') %>

data/spec/modules/functions/manifests/class_test.pp

@@ -0,0 +1,5 @@
+class functions::class_test {
+  ssh_authorized_key{'barry':
+    key => extlookup('ssh-key-barry'),
+  }
+}

data/spec/modules/functions/manifests/define_test.pp

@@ -0,0 +1,5 @@
+define functions::define_test () {
+  ssh_authorized_key{'barry':
+    key => extlookup('ssh-key-barry'),
+  }
+}

data/spec/modules/functions/manifests/recursive_extlookup_test.pp

@@ -0,0 +1,5 @@
+class functions::recursive_extlookup_test {
+  ssh_authorized_key{'barry':
+    key => extlookup(extlookup('ssh-key-barry')),
+  }
+}

data/spec/modules/nginx/manifests/simple_server.pp

@@ -0,0 +1,5 @@
+define nginx::simple_server () {
+  nginx::site{$title:
+    content => template('nginx/vhost.erb'),
+  }
+}

data/spec/modules/nginx/manifests/site.pp

@@ -0,0 +1,9 @@
+define nginx::site ($content) {
+  file {"/etc/nginx/sites-enabled/$title":
+    ensure  => present,
+    mode    => 0440,
+    content => template('nginx/vhost.erb'),
+  }
+  user {'www-data':
+  }
+}

data/spec/modules/nginx/templates/vhost.erb

@@ -0,0 +1,5 @@
+server {
+  listen 80;
+  server_name <%= @title %>;
+  root /var/cache/www;
+}

data/spec/modules/webapp/manifests/init.pp

@@ -0,0 +1,4 @@
+class webapp {
+  nginx::site {'webapp':
+  }
+}

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec/autorun'
+require 'fizzgig'
+
+HERE = File.expand_path(File.dirname(__FILE__))
+
+RSpec.configure do |c|
+  c.modulepath  = File.join(HERE, 'modules')
+
+  c.include Fizzgig::CatalogMatchers
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: fizzgig
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Philip Potter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet
+  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: lspace
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tools for writing fast unit tests for Puppet
+email: philip.g.potter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- TODO.org
+- fizzgig.gemspec
+- lib/fizzgig.rb
+- lib/fizzgig/function_stubs.rb
+- lib/fizzgig/matchers.rb
+- spec/fizzgig_spec.rb
+- spec/modules/facts/manifests/class_test.pp
+- spec/modules/facts/manifests/define_test.pp
+- spec/modules/facts/manifests/template_test.pp
+- spec/modules/facts/templates/template-test.erb
+- spec/modules/functions/manifests/class_test.pp
+- spec/modules/functions/manifests/define_test.pp
+- spec/modules/functions/manifests/recursive_extlookup_test.pp
+- spec/modules/nginx/manifests/simple_server.pp
+- spec/modules/nginx/manifests/site.pp
+- spec/modules/nginx/templates/vhost.erb
+- spec/modules/webapp/manifests/init.pp
+- spec/spec_helper.rb
+homepage: https://github.com/philandstuff/fizzgig
+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.23
+signing_key: 
+specification_version: 3
+summary: Tools for writing fast unit tests for Puppet
+test_files:
+- spec/fizzgig_spec.rb
+- spec/modules/facts/manifests/class_test.pp
+- spec/modules/facts/manifests/define_test.pp
+- spec/modules/facts/manifests/template_test.pp
+- spec/modules/facts/templates/template-test.erb
+- spec/modules/functions/manifests/class_test.pp
+- spec/modules/functions/manifests/define_test.pp
+- spec/modules/functions/manifests/recursive_extlookup_test.pp
+- spec/modules/nginx/manifests/simple_server.pp
+- spec/modules/nginx/manifests/site.pp
+- spec/modules/nginx/templates/vhost.erb
+- spec/modules/webapp/manifests/init.pp
+- spec/spec_helper.rb