fizzgig 0.1.0 → 0.1.1

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
 
 .ruby-version
+fizzgig-0.1.0.gem

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 0.1.1
+
+  * fixed bug to allow multiple conditions on a matcher, eg:
+```ruby
+  it {should contain_file('foo').with_content(/asdf/).with_content(/jkl;/)}
+```
+
+
+# 0.1.0
+
+  * Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2013 Philip Potter
+
+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.asciidoc

@@ -0,0 +1,151 @@
+Fizzgig
+-------
+
+Fizzgig is a library to help write fast unit tests.
+
+[source,ruby]
+-------------------------------------------
+describe 'ganglia::cronjob' do
+  include Fizzgig::CatalogMatchers
+
+  it 'should create ganglia script and cron job' do
+    catalog = Fizzgig.instantiate <<END
+      ganglia::cronjob {'tiger':
+        content => 'tiger content',
+      }
+END
+    catalog.should contain_file('/etc/ganglia/scripts/tiger')
+      .with_content('tiger content')
+      .with_mode('0755')
+
+    catalog.should contain_cron('ganglia-tiger')
+      .with_command('/etc/ganglia/scripts/tiger')
+      .with_minute('*')
+      .with_user('root')
+  end
+end
+-------------------------------------------
+
+Basic Functionality
+~~~~~~~~~~~~~~~~~~~
+
+Fizzgig is based around two functions: +instantiate+ and +include+,
+which will instantiate a defined type and include a class
+respectively:
+
+[source,ruby]
+catalog = Fizzgig.instantiate %q[ nginx::site {'foo.com': max_age => 300 } ]
+
+[source,ruby]
+catalog = Fizzgig.include 'nginx'
+
+Each of these functions returns a Puppet::Resource::Catalog
+object. You can use the matchers in Fizzgig::CatalogMatchers to make
+assertions against the contents of this catalog:
+
+[source,ruby]
+catalog.should contain_file('/etc/nginx.conf').with_content(/ssl/)
+
+Just like in rspec-puppet, you can assert the existence of defined
+types within your own modules by replacing +::+ with +__+ in the name:
+
+[source,ruby]
+catalog.should contain_nginx__site('foo.com')
+
+Stubbing facts
+~~~~~~~~~~~~~~
+
+Facts can be stubbed by passing a hash of fact values to instantiate
+or include:
+
+[source,ruby]
+Fizzgig.include('nginx',:facts => {'lsbdistcodename' => 'precise'})
+
+Stubbing functions
+~~~~~~~~~~~~~~~~~~
+
+Custom functions can also be stubbed. This is very handy for stubbing
+out extdata or hieradata in tests:
+
+[source,ruby]
+-------------
+Fizzgig.include('nginx',:stubs => {:extlookup => {'site_root' => 'www.foo.com'}})
+  .should contain_file('/etc/nginx/sites-enabled/www.foo.com')
+-------------
+
+Rationale
+~~~~~~~~~
+
+Fizzgig is designed to be fast, and to test individual units of code,
+as good unit tests do. However, existing puppet testing libraries such
+as https://github.com/rodjek/rspec-puppet[rspec-puppet] will compute a
+complete catalog, expanding out all classes and defined types until it
+reaches the individual base puppet types. This means that it can spend
+time computing resources which are wholly unrelated to the test you're
+writing.
+
+Fizzgig, by contrast, treats defined types as black box abstractions:
+it only adds the defined types you declare within the class or define
+under test to the catalog. Types which are pulled in transitively by
+other types will not be added to the catalog.
+
+Defined types
+~~~~~~~~~~~~~
+
+To achieve its isolation, fizzgig does not transitively evaluate
+defined types. Suppose I have these puppet defines:
+
+[source,puppet]
+---------------
+define nginx::ssl_site () {
+  nginx::site {$title:
+  }
+  nginx::ssl_cert {$title:
+  }
+}
+
+define nginx::site () {
+  file {"/etc/nginx/sites-enabled/$title":
+    # ...
+  }
+}
+---------------
+
+And I write this test:
+
+[source,ruby]
+-------------
+catalog Fizzgig.instantiate %q[ nginx::ssl_site{'foo': } ]
+catalog.should contain_nginx__site('foo') # ok, will pass
+catalog.should contain_file('/etc/nginx/sites-enabled/foo') # ERROR, will fail
+-------------
+
+Because the file resource is not directly referenced by
++nginx::ssl_site+ but only transitively by +nginx::site+, Fizzgig will
+not add it to the catalog. This means that Fizzgig will only test the
+direct effects of the type under test, not of its collaborators.
+
+
+WARNING: Fizzgig makes use of non-public methods in the puppet
+codebase to enable it to perform this isolation. This means that even
+a patch release of puppet may, in principle, cause fizzgig to
+break. Fizzgig is not currently supported in any way by
+puppetlabs. Use at your own risk.
+
+Installation
+~~~~~~~~~~~~
+
+Add the following to your Gemfile:
+
+[source,ruby]
+gem "fizzgig"
+
+Or just run:
+
+[source]
+gem install fizzgig
+
+Licence
+~~~~~~~
+
+MIT. See LICENSE for details.

data/TODO.org

@@ -31,7 +31,19 @@ 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!
+** DONE Release it!
+** DONE Fix bug where multiple with_foo() conditions would be overridden by the last
+=should contain_file('foo').with_content(/bar/).with_content(/baz/)=
+would not check =/bar/=, only =/baz/=, for example
+** DONE Document it!
+   - [X] gem install or gemfile line
+** DONE Issue with global Puppet settings config & running rspec-puppet simultaneously with puppet...
+See the fizzgig branch of puppet for an example
+
+Can we isolate the compiler from the settings?
+
+Answer seems to be yes -- use puppetlabs_spec_helper or directly
+Puppet::Test::TestHelper to tear down Puppet.settings after each test.
 ** 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:
@@ -56,8 +68,7 @@ node_obj.merge(facts_val) # but what is this?
 
 That's not so cool :(
 
-** TODO Rename
-** TODO Release it!
+** DONE Rename
 ** TODO implementation-independent dependency assertions
 ** TODO Test standalone puppet modules
 ** TODO better test output for files with large content

data/fizzgig.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'fizzgig'
-  s.version = '0.1.0'
+  s.version = '0.1.1'
   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'

data/lib/fizzgig.rb

@@ -48,10 +48,10 @@ module Fizzgig
   end
 
   def self.setup_puppet
-    Puppet[:manifestdir] = ''
+    Puppet[:code] = ' ' # hack to suppress puppet from looking at Puppet[:manifest]
     Puppet[:modulepath] = RSpec.configuration.modulepath
     # stop template() fn from complaining about missing vardir config
-    Puppet[:templatedir] = ""
+    Puppet[:vardir] ||= ""
   end
 end
 

data/lib/fizzgig/matchers.rb

@@ -15,11 +15,13 @@ module Fizzgig
         @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
+          (@expected_params || {}).all? do |name,expected_vals|
+            expected_vals.all? do |expected_val|
+              if expected_val.kind_of?(Regexp)
+                resource[name] =~ expected_val
+              else
+                resource[name] == expected_val
+              end
             end
           end
         else
@@ -28,20 +30,19 @@ module Fizzgig
       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}"
+        "expected #{actual_string} to contain #{expected_string}"
+      end
+
+      def failure_message_for_should_not
+        "expected #{actual_string} not to contain #{expected_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]
+          @expected_params[param] ||= []
+          @expected_params[param] << args[0]
           self
         else
           super
@@ -50,6 +51,19 @@ module Fizzgig
 
       private
 
+      def actual_string
+        possible_resource = @catalog.resource(@referenced_type,@expected_title)
+        possible_resource ? possible_resource.inspect : "the catalog"
+      end
+
+      def expected_string
+        param_string = ""
+        if @expected_params
+          param_string = " with parameters #{@expected_params.inspect}"
+        end
+        "#{@referenced_type}[#{@expected_title}]#{param_string}"
+      end
+
       def referenced_type(type)
         type.split('__').map { |r| r.capitalize }.join('::')
       end

data/spec/fizzgig_spec.rb

@@ -2,110 +2,113 @@ 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
+  describe '#include' do
+    subject { Fizzgig.include(classname, :stubs => stubs, :facts => facts) }
+    let(:stubs) { {} }
+    let(:facts) { {} }
 
-    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
+    describe 'webapp' do
+      let(:classname) {'webapp'}
 
-    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')
+      it { should contain_nginx__site('webapp') }
     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
+    describe 'functions::class_test' do
+      let(:classname) {'functions::class_test'}
+      context 'with extlookup stubbed out' do
+        let(:stubs) { {:extlookup => {'ssh-key-barry' => 'the key of S'}} }
+        it { should contain_ssh_authorized_key('barry').with_key('the key of S') }
+      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')
+      context 'with extlookup stubbed with wrong key' do
+        let(:stubs) { {:extlookup => {'bananas' => 'potassium'}} }
+        it 'should throw an exception' do
+          expect { subject }.to raise_error Puppet::Error
+        end
+      end
     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')
+    describe 'functions::recursive_extlookup_test' do
+      let(:classname) {'functions::recursive_extlookup_test'}
+      let(:stubs) {
+        {:extlookup =>
+          { 'ssh-key-barry' => 'rsa-key-barry',
+            'rsa-key-barry' => 'the key of S'}}
+      }
+      it { 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
+    describe 'facts::class_test' do
+      let(:classname) {'facts::class_test'}
+      let(:facts) {
+        { 'unqualified_fact'      => 'F',
+          'qualified_fact'        => 'B+',
+          'template_visible_fact' => 'wibble' }}
+      it { should contain_notify('unqualified-fact-test').with_message('F') }
+      it { should contain_notify('qualified-fact-test').with_message('B+') }
+      it { should contain_file('template-test').with_content(/instance_fact:wibble/) }
+      it { should contain_file('template-test').with_content(/accessor_fact:wibble/) }
+      it { should contain_file('template-test').with_content(/scope_lookup_fact:wibble/) }
     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
+  describe '#instantiate' do
+    subject { Fizzgig.instantiate(code, :stubs => stubs, :facts => facts) }
+    let(:stubs) { {} }
+    let(:facts) { {} }
 
-  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')
+    describe 'params' do
+      context 'when specifying one parameter' do
+        let(:code) { %q[params_test {'foo': param => 'bar'}] }
+        it { should contain_file('foo-param').with_source('bar') }
+        it { should contain_notify('foo-default').with_message('default_val') }
       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')
+      context 'when specifying both paramaters' do
+        let(:code) { %q[params_test {'foo': param => 'bar', param_with_default => 'baz'}] }
+        it { should contain_file('foo-param').with_source('bar') }
+        it { should contain_notify('foo-default').with_message('baz') }
       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')
+    describe 'nginx::site' do
+      context 'basic functionality' do
+        let(:code) { %q[nginx::site {'foo': content => 'dontcare'}] }
+        it { should contain_file('/etc/nginx/sites-enabled/foo').
+          with_ensure('present').
+          with_mode('0440')
+        }
+        it { should_not contain_file('/etc/nginx/sites-enabled/foo').
+          with_ensure(/text not present/). # test that this doesn't get ignored
+          with_ensure(/present/)
+        }
+        it { should contain_user('www-data') }
       end
+    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/)
+    describe 'nginx::simple_server' do
+      context 'basic functionality' do
+        let(:code) { %q[nginx::simple_server {'foo':}] }
+        it { should contain_nginx__site('foo').
+          with_content(/server_name foo;/)
+        }
       end
+    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
+    context 'functions::define_test with function stubs' do
+      let(:stubs) { {:extlookup => {'ssh-key-barry' => 'the key of S'}} }
+      let(:code) { %[functions::define_test{'foo': }] }
+      it { should contain_ssh_authorized_key('barry').with_key('the key of S') }
+    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
+    describe 'facts::define_test' do
+      let(:classname) {'facts::define_test'}
+      let(:code) {%q[facts::define_test{'test':}]}
+      let(:facts) {
+        { 'unqualified_fact' => 'no qualifications',
+          'qualified_fact'   => 'cse ungraded in metalwork'}
+      }
+      it { should contain_notify('unqualified-fact-test').with_message('no qualifications') }
+      it { should contain_notify('qualified-fact-test').with_message('cse ungraded in metalwork') }
     end
   end
 end

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

@@ -5,4 +5,7 @@ class facts::class_test {
     'qualified-fact-test':
       message => $::qualified_fact;
   }
+  file {'template-test':
+    content => template('facts/template-test.erb'),
+  }
 }

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

@@ -0,0 +1,8 @@
+define params_test ($param, $param_with_default = 'default_val') {
+  file {"${title}-param":
+    source => $param,
+  }
+  notify {"${title}-default":
+    message => $param_with_default,
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fizzgig
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-16 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -66,7 +66,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
+- LICENSE
+- README.asciidoc
 - TODO.org
 - fizzgig.gemspec
 - lib/fizzgig.rb
@@ -75,7 +78,6 @@ 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
@@ -83,6 +85,7 @@ files:
 - spec/modules/nginx/manifests/simple_server.pp
 - spec/modules/nginx/manifests/site.pp
 - spec/modules/nginx/templates/vhost.erb
+- spec/modules/params_test/manifests/init.pp
 - spec/modules/webapp/manifests/init.pp
 - spec/spec_helper.rb
 homepage: https://github.com/philandstuff/fizzgig
@@ -113,7 +116,6 @@ 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
@@ -121,5 +123,6 @@ test_files:
 - spec/modules/nginx/manifests/simple_server.pp
 - spec/modules/nginx/manifests/site.pp
 - spec/modules/nginx/templates/vhost.erb
+- spec/modules/params_test/manifests/init.pp
 - spec/modules/webapp/manifests/init.pp
 - spec/spec_helper.rb

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

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