fizzgig 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.4.0
+  * Changed configuration style:
+    * Removed RSpec.configure interface
+    * Added OO interface to Fizzgig to allow storing configuration in
+      the Fizzgig instance
+  * Removed RSpec matchers; you can use the matchers from rspec-puppet
+    instead:
+
+```ruby
+  require 'rspec-puppet/matchers'
+  RSpec.configure do |c|
+    c.include RSpec::Puppet::ManifestMatchers
+  end
+```
+
 # 0.3.0
 
   * Changed API for #instantiate to take ruby Hash of params rather

data/README.asciidoc

@@ -5,8 +5,12 @@ Fizzgig is a library to help write fast unit tests.
 
 [source,ruby]
 -------------------------------------------
+require 'spec_helper'
+require 'fizzgig'
+
 describe 'nginx::site' do
-  subject { Fizzgig.instantiate %q[nginx::site{'www.foo.com':}] }
+  let(:fizzgig) { Fizzgig.new({modulepath:MODULEPATH,manifestdir:MANIFESTDIR}) }
+  subject { fizzgig.instantiate 'nginx::site','www.foo.com',{} }
   it { should contain_file('/etc/nginx/sites-available/www.foo.com').
          with_content(/server_name\s+www.foo.com;/) }
   it { should contain_file('/etc/nginx/sites-enabled/www.foo.com').
@@ -23,7 +27,7 @@ which will instantiate a defined type and include a class
 respectively:
 
 [source,ruby]
-catalog = Fizzgig.instantiate %q[ nginx::site {'foo.com': max_age => 300 } ]
+catalog = Fizzgig.instantiate 'nginx::site', 'foo.com', { max_age => 300 }
 
 [source,ruby]
 catalog = Fizzgig.include 'nginx'
@@ -104,7 +108,7 @@ And I write this test:
 
 [source,ruby]
 -------------
-catalog Fizzgig.instantiate %q[ nginx::ssl_site{'foo': } ]
+catalog Fizzgig.instantiate '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
 -------------

data/TODO.org

@@ -74,6 +74,7 @@ That's not so cool :(
 See govuk_nodes_spec_optional for examples of this.
 the rspec-puppet equivalent is :type => :host
 ** DONE implement defined types from ruby hashes
+** DONE update README to reflect defined type API change
 ** 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.3.0'
+  s.version = '0.4.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'
@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'puppet'
   s.add_dependency 'lspace'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-puppet'
 
   s.authors = ['Philip Potter']
   s.email = 'philip.g.potter@gmail.com'

data/lib/fizzgig.rb

@@ -1,20 +1,11 @@
 require 'puppet'
-require 'fizzgig/matchers'
 require 'fizzgig/function_stubs'
 require 'lspace'
 
-class Puppet::Resource::TypeCollection
-  alias_method :find_or_load_real, :find_or_load
-  def find_or_laod(namespaces, name, type)
-    $stderr.puts "Resourcing #{name} #{type} in #{namespaces}"
-    find_or_load_real(namespaces,name,type)
-  end
-end
-
-module Fizzgig
-  def self.instantiate(type,title,params={},options = {})
+class Fizzgig
+  def self.instantiate(type,title,params,options = {})
     LSpace.with(:function_stubs => options[:stubs]) do
-      setup_puppet
+      setup_fizzgig({modulepath: options[:modulepath],manifestdir: options[:manifestdir]})
       compiler = make_compiler(options[:facts])
       scope = compiler.newscope(nil)
       scope.source = Puppet::Resource::Type.new(:node,'localhost')
@@ -35,7 +26,7 @@ module Fizzgig
 
   def self.include(klass,options = {})
     LSpace.with(:function_stubs => options[:stubs]) do
-      setup_puppet
+      setup_fizzgig({modulepath: options[:modulepath],manifestdir: options[:manifestdir]})
       compiler = make_compiler(options[:facts])
       compile("include #{klass}",compiler)
       compiler.catalog
@@ -44,7 +35,7 @@ module Fizzgig
 
   def self.node(hostname,options = {})
     LSpace.with(:function_stubs => options[:stubs]) do
-      setup_puppet
+      setup_fizzgig({modulepath: options[:modulepath],manifestdir: options[:manifestdir]})
       Puppet[:code] = '' # we want puppet to import the Puppet[:manifest] file
       compiler = make_compiler(options[:facts], hostname)
       compiler.send :evaluate_ast_node
@@ -80,21 +71,34 @@ module Fizzgig
     parser.parse(code)
   end
 
-  def self.setup_puppet
+  def self.setup_fizzgig(settings={})
     Puppet[:code] = ' ' # hack to suppress puppet from looking at Puppet[:manifest]
-    Puppet[:modulepath] = RSpec.configuration.modulepath
-    Puppet[:manifestdir] = RSpec.configuration.manifestdir
+    Puppet[:modulepath] = settings[:modulepath] || '/etc/puppet/modules'
+    Puppet[:manifestdir] = settings[:manifestdir] || nil
     # stop template() fn from complaining about missing vardir config
     Puppet[:vardir] ||= ""
+    # FIXME: decide if these are needed
+    #c.add_setting :manifest, :default => nil
+    #c.add_setting :template_dir, :default => nil
+    #c.add_setting :config, :default => nil
   end
-end
 
-RSpec.configure do |c|
-  c.add_setting :modulepath, :default => '/etc/puppet/modules'
-  c.add_setting :manifestdir, :default => nil
+  # ===== OO interface ======
+  # basically a glorified curried function to store the configuration
+
+  def initialize(settings={})
+    @modulepath  = settings[:modulepath]
+    @manifestdir = settings[:manifestdir]
+  end
+
+  def instantiate(type,title,params,options={})
+    Fizzgig.instantiate(type,title,params,options.merge({modulepath: @modulepath, manifestdir: @manifestdir}))
+  end
 
-  # FIXME: decide if these are needed
-  #c.add_setting :manifest, :default => nil
-  #c.add_setting :template_dir, :default => nil
-  #c.add_setting :config, :default => nil
+  def include(classname,options={})
+    Fizzgig.include(classname,options.merge({modulepath: @modulepath, manifestdir: @manifestdir}))
+  end
+  def node(hostname,options={})
+    Fizzgig.node(hostname,options.merge({modulepath: @modulepath, manifestdir: @manifestdir}))
+  end
 end

data/lib/fizzgig/function_stubs.rb

@@ -1,28 +1,29 @@
+class Fizzgig
+  module FunctionStubs
+    def self.has_stub?(fname,args)
+      stubs = LSpace[:function_stubs] || {}
+      stubs.has_key?(fname.to_sym) &&
+        stubs[fname.to_sym].has_key?(args)
+    end
 
-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)
-  end
-
-  def self.get_stub(fname,args)
-    LSpace[:function_stubs][fname.to_sym][args]
+    def self.get_stub(fname,args)
+      LSpace[:function_stubs][fname.to_sym][args]
+    end
   end
-end
 
-class Puppet::Parser::AST
-  class Function < AST::Branch
-    alias_method :orig_evaluate, :evaluate
+  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)
+      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/spec/example_spec.rb

@@ -2,7 +2,8 @@ require 'spec_helper'
 require 'fizzgig'
 
 describe 'nginx::site' do
-  subject { Fizzgig.instantiate 'nginx::site','www.foo.com' }
+  let(:fizzgig) { Fizzgig.new({modulepath:MODULEPATH,manifestdir:MANIFESTDIR}) }
+  subject { fizzgig.instantiate 'nginx::site','www.foo.com',{} }
   it { should contain_file('/etc/nginx/sites-available/www.foo.com').
          with_content(/server_name\s+www.foo.com;/) }
   it { should contain_file('/etc/nginx/sites-enabled/www.foo.com').

data/spec/fizzgig_spec.rb

@@ -2,8 +2,9 @@ require 'spec_helper'
 require 'fizzgig'
 
 describe Fizzgig do
+  let(:fizzgig) { Fizzgig.new({modulepath: MODULEPATH, manifestdir: MANIFESTDIR}) }
   describe '#include' do
-    subject { Fizzgig.include(classname, :stubs => stubs, :facts => facts) }
+    subject { fizzgig.include(classname, :stubs => stubs, :facts => facts) }
     let(:stubs) { {} }
     let(:facts) { {} }
 
@@ -69,7 +70,7 @@ describe Fizzgig do
   end
 
   describe '#instantiate' do
-    subject { Fizzgig.instantiate(type, title, params, :stubs => stubs, :facts => facts) }
+    subject { fizzgig.instantiate(type, title, params, :stubs => stubs, :facts => facts) }
     let(:stubs) { {} }
     let(:facts) { {} }
     let(:params) { {} }
@@ -119,7 +120,7 @@ describe Fizzgig do
   end
 
   describe '#node' do
-    subject { Fizzgig.node(hostname, :facts => facts) }
+    subject { fizzgig.node(hostname, :facts => facts) }
     let(:facts) { {} }
     context 'simple node' do
       let(:hostname) {'foo.com'}

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 require 'rspec/autorun'
 require 'fizzgig'
+require 'rspec-puppet/matchers'
 
 HERE = File.expand_path(File.dirname(__FILE__))
+MODULEPATH  = "#{File.join(HERE, 'modules')}:#{File.join(HERE, 'extra_modules')}"
+MANIFESTDIR = File.join(HERE,'manifests')
 
 RSpec.configure do |c|
-  c.modulepath  = "#{File.join(HERE, 'modules')}:#{File.join(HERE, 'extra_modules')}"
-  c.manifestdir = File.join(HERE,'manifests')
-
-  c.include Fizzgig::CatalogMatchers
+  c.include RSpec::Puppet::ManifestMatchers
 end

data/test/example_test.rb

@@ -0,0 +1,19 @@
+require 'minitest/autorun'
+require 'fizzgig'
+
+HERE = File.expand_path(File.dirname(__FILE__))
+
+MODULEPATH  = "#{File.join(HERE, '../spec/modules')}:#{File.join(HERE, '../spec/extra_modules')}"
+MANIFESTDIR = File.join(HERE,'../spec/manifests')
+
+class TestNginxSite < MiniTest::Unit::TestCase
+  def setup
+    @fizzgig = Fizzgig.new({modulepath: MODULEPATH, manifestdir: MANIFESTDIR})
+    @catalog = @fizzgig.instantiate 'nginx::site','www.foo.com',{}
+  end
+
+  def test_has_sites_available_file
+    assert @catalog.resource('file',
+               '/etc/nginx/sites-available/www.foo.com')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fizzgig
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-puppet
+  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: []
@@ -74,7 +90,6 @@ files:
 - fizzgig.gemspec
 - lib/fizzgig.rb
 - lib/fizzgig/function_stubs.rb
-- lib/fizzgig/matchers.rb
 - spec/example_spec.rb
 - spec/extra_modules/webapp/manifests/init.pp
 - spec/fizzgig/function_stubs_spec.rb
@@ -92,6 +107,7 @@ files:
 - spec/modules/nginx/templates/vhost.erb
 - spec/modules/params_test/manifests/init.pp
 - spec/spec_helper.rb
+- test/example_test.rb
 homepage: https://github.com/philandstuff/fizzgig
 licenses: []
 post_install_message: 
@@ -134,3 +150,4 @@ test_files:
 - spec/modules/nginx/templates/vhost.erb
 - spec/modules/params_test/manifests/init.pp
 - spec/spec_helper.rb
+- test/example_test.rb

data/lib/fizzgig/matchers.rb

@@ -1,81 +0,0 @@
-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_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
-          false
-        end
-      end
-
-      def failure_message_for_should
-        "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] ||= []
-          @expected_params[param] << args[0]
-          self
-        else
-          super
-        end
-      end
-
-      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
-    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