Merge pull request #18 from jeffmccune/maint/master/add_puppet_internals_module

(Maint) Rename PuppetlabsSpec::Puppet{Seams,Internals}

Author: Jeff McCune

README.markdown

@@ -130,9 +130,9 @@ This will not work beyond Puppet 2.7 as we have changed the behavior of the
 scope initializer in Puppet 3.0.  Modules should instead initialize scope
 instances in a manner decoupled from the internal behavior of Puppet:
 
-    require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_seams'
+    require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_internals'
     describe "split()" do
-      let(:scope) { PuppetlabsSpec::PuppetSeams.parser_scope }
+      let(:scope) { PuppetlabsSpec::PuppetInternals.scope }
       it "should split 'one;two' on ';' into [ 'one', 'two' ]" do
         scope.function_split(['one;two', ';']).should == [ 'one', 'two' ]
       end

lib/puppetlabs_spec_helper/module_spec_helper.rb

@@ -1,11 +1,6 @@
 require 'rspec-puppet'
 require 'puppetlabs_spec_helper/puppet_spec_helper'
-
-# We need to require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_seams' so
-# that all Puppet modules have easy access to
-# PuppetlabsSpec::PuppetSeams.new.scope_for_test_harness  The expectation is
-# that all Puppet modules require puppetlabs_spec_helper/module_spec_helper
-require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_seams'
+require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_internals'
 
 def param_value(subject, type, title, param)
   subject.resource(type, title).send(:parameters)[param.to_sym]

lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb

@@ -0,0 +1,54 @@
+# Initialize puppet for testing by loading the
+# 'puppetlabs_spec_helper/puppet_spec_helper' library
+require 'puppetlabs_spec_helper/puppet_spec_helper'
+
+module PuppetlabsSpec
+  module PuppetInternals
+    # parser_scope is intended to return a Puppet::Parser::Scope
+    # instance suitable for placing in a test harness with the intent of
+    # testing parser functions from modules.
+    def scope(parts = {})
+      if Puppet.version =~ /^2\.[67]/
+        # loadall should only be necessary prior to 3.x
+        # Please note, loadall needs to happen first when creating a scope, otherwise
+        # you might receive undefined method `function_*' errors
+        Puppet::Parser::Functions.autoloader.loadall
+      end
+
+      scope_compiler = parts[:compiler] || compiler
+      scope_parent = parts[:parent] || scope_compiler.topscope
+      scope_resource = parts[:resource] || resource(:type => :node, :title => scope_compiler.node.name)
+
+      if Puppet.version =~ /^2\.[67]/
+        scope = Puppet::Parser::Scope.new(:compiler => scope_compiler)
+      else
+        scope = Puppet::Parser::Scope.new(scope_compiler)
+      end
+
+      scope.source = Puppet::Resource::Type.new(:node, "foo")
+      scope.parent = scope_parent
+      scope
+    end
+    module_function :scope
+
+    def resource(parts = {})
+      resource_type = parts[:type] || :hostclass
+      resource_name = parts[:name] || "testing"
+      Puppet::Resource::Type.new(resource_type, resource_name)
+    end
+    module_function :resource
+
+    def compiler(parts = {})
+      compiler_node = parts[:node] || node()
+      Puppet::Parser::Compiler.new(compiler_node)
+    end
+    module_function :compiler
+
+    def node(parts = {})
+      node_name = parts[:name] || 'testinghost'
+      node_environment = Puppet::Node::Environment.new(parts[:environment] || 'test')
+      Puppet::Node.new(node_name) #, :environment => node_environment)
+    end
+    module_function :node
+  end
+end

lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_seams.rb

@@ -9,7 +9,7 @@ module PuppetlabsSpec
 # Require all necessary helper libraries so they can be used later
 require 'puppetlabs_spec_helper/puppetlabs_spec/files'
 require 'puppetlabs_spec_helper/puppetlabs_spec/fixtures'
-require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_seams'
+require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_internals'
 require 'puppetlabs_spec_helper/puppetlabs_spec/matchers'
 
 RSpec.configure do |config|

lib/puppetlabs_spec_helper/puppetlabs_spec_helper.rb

@@ -0,0 +1,72 @@
+#! /usr/bin/env ruby -S rspec
+
+require 'puppetlabs_spec_helper/puppet_spec_helper'
+require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_internals'
+
+describe PuppetlabsSpec::PuppetInternals do
+  describe ".scope" do
+    it "should return a Puppet::Parser::Scope instance" do
+      subject.scope.should be_a_kind_of Puppet::Parser::Scope
+    end
+
+    it "should be suitable for function testing" do
+      scope = subject.scope
+      scope.function_split(["one;two", ";"]).should == [ 'one', 'two' ]
+    end
+
+    it "should accept a compiler" do
+      compiler = subject.compiler
+
+      scope = subject.scope(:compiler => compiler)
+
+      scope.compiler.should == compiler
+    end
+
+    it "should have a source set" do
+      scope = subject.scope
+
+      scope.source.should_not be_nil
+      scope.source.should_not be_false
+    end
+  end
+
+  describe ".resource" do
+    it "can have a defined type" do
+      subject.resource(:type => :node).type.should == :node
+    end
+
+    it "defaults to a type of hostclass" do
+      subject.resource.type.should == :hostclass
+    end
+
+    it "can have a defined name" do
+      subject.resource(:name => "testingrsrc").name.should == "testingrsrc"
+    end
+
+    it "defaults to a name of testing" do
+      subject.resource.name.should == "testing"
+    end
+  end
+
+  describe ".compiler" do
+    let(:node) { subject.node }
+
+    it "can have a defined node" do
+      subject.compiler(:node => node).node.should be node
+    end
+  end
+
+  describe ".node" do
+    it "can have a defined name" do
+      subject.node(:name => "mine").name.should == "mine"
+    end
+
+    it "can have a defined environment" do
+      subject.node(:environment => "mine").environment.name.should == :mine
+    end
+
+    it "defaults to a name of testinghost" do
+      subject.node.name.should == "testinghost"
+    end
+  end
+end