rspec-puppet-maestrodev 0.1.5.1

data/lib/rspec-puppet/example/define_example_group.rb

@@ -0,0 +1,62 @@
+module RSpec::Puppet
+  module DefineExampleGroup
+    include RSpec::Puppet::ManifestMatchers
+    include RSpec::Puppet::Support
+
+    def subject
+      @catalogue ||= catalogue
+    end
+
+    def catalogue
+      define_name = self.class.top_level_description.downcase
+
+      vardir = Dir.mktmpdir
+      Puppet[:vardir] = vardir
+      Puppet[:hiera_config] = File.join(vardir, "hiera.yaml") if Puppet[:hiera_config] == File.expand_path("/dev/null")
+      Puppet[:modulepath] = self.respond_to?(:module_path) ? module_path : RSpec.configuration.module_path
+      Puppet[:manifestdir] = self.respond_to?(:manifest_dir) ? manifest_dir : RSpec.configuration.manifest_dir
+      Puppet[:manifest] = self.respond_to?(:manifest) ? manifest : RSpec.configuration.manifest
+      Puppet[:templatedir] = self.respond_to?(:template_dir) ? template_dir : RSpec.configuration.template_dir
+      Puppet[:config] = self.respond_to?(:config) ? config : RSpec.configuration.config
+
+      # If we're testing a standalone module (i.e. one that's outside of a
+      # puppet tree), the autoloader won't work, so we need to fudge it a bit.
+      if File.exists?(File.join(Puppet[:modulepath], 'manifests', 'init.pp'))
+        path_to_manifest = File.join([Puppet[:modulepath], 'manifests', define_name.split('::')[1..-1]].flatten)
+        import_str = "import '#{Puppet[:modulepath]}/manifests/init.pp'\nimport '#{path_to_manifest}.pp'\n"
+      elsif File.exists?(Puppet[:modulepath])
+        import_str = "import '#{Puppet[:manifest]}'\n"
+      else
+        import_str = ""
+      end
+
+      if self.respond_to? :params
+        param_str = params.keys.map { |r|
+          "#{r.to_s} => #{params[r].inspect}"
+        }.join(', ')
+      else
+        param_str = ""
+      end
+
+      if self.respond_to? :pre_condition
+        pre_cond = pre_condition
+      else
+        pre_cond = ""
+      end
+
+      code = pre_cond + "\n" + import_str + define_name + " { \"" + title + "\": " + param_str + " }"
+
+      nodename = self.respond_to?(:node) ? node : Puppet[:certname]
+      facts_val = {
+        'hostname' => nodename.split('.').first,
+        'fqdn' => nodename,
+        'domain' => nodename.split('.', 2).last,
+      }
+      facts_val.merge!(munge_facts(facts)) if self.respond_to?(:facts)
+
+      catalogue = build_catalog(nodename, facts_val, code)
+      FileUtils.rm_rf(vardir) if File.directory?(vardir)
+      catalogue
+    end
+  end
+end

data/lib/rspec-puppet/example/function_example_group.rb

@@ -0,0 +1,54 @@
+require 'puppetlabs_spec_helper/puppetlabs_spec/puppet_internals'
+
+module RSpec::Puppet
+  module FunctionExampleGroup
+    include RSpec::Puppet::FunctionMatchers
+    PuppetInternals = PuppetlabsSpec::PuppetInternals
+
+    def subject
+      function_name = self.class.top_level_description.downcase
+
+      Puppet[:modulepath] = self.respond_to?(:module_path) ? module_path : RSpec.configuration.module_path
+      Puppet[:libdir] = Dir["#{Puppet[:modulepath]}/*/lib"].entries.join(File::PATH_SEPARATOR)
+
+      # if we specify a pre_condition, we should ensure that we compile that code
+      # into a catalog that is accessible from the scope where the function is called
+      if self.respond_to? :pre_condition
+        Puppet[:code] = pre_condition
+        nodename = self.respond_to?(:node) ? node : Puppet[:certname]
+        facts_val = {
+          'hostname' => nodename.split('.').first,
+          'fqdn' => nodename,
+          'domain' => nodename.split('.').last,
+        }
+        facts_val.merge!(munge_facts(facts)) if self.respond_to?(:facts)
+        # we need to get a compiler, b/c we can attach that to a scope
+        @compiler = build_compiler(nodename, facts_val)
+      else
+        @compiler = PuppetInternals.compiler
+      end
+
+      scope = PuppetInternals.scope(:compiler => @compiler)
+
+      # Return the method instance for the function.  This can be used with
+      # method.call
+      method = PuppetInternals.function_method(function_name, :scope => scope)
+    end
+
+    def compiler
+      @compiler
+    end
+
+    # get a compiler with an attached compiled catalog
+    def build_compiler(node_name, fact_values)
+      node_options = {
+        :name    => node_name,
+        :options => { :parameters => fact_values },
+      }
+      node = PuppetInternals.node(node_options)
+      compiler = PuppetInternals.compiler(:node => node)
+      compiler.compile
+      compiler
+    end
+  end
+end

data/lib/rspec-puppet/example/host_example_group.rb

@@ -0,0 +1,35 @@
+module RSpec::Puppet
+  module HostExampleGroup
+    include RSpec::Puppet::ManifestMatchers
+    include RSpec::Puppet::Support
+
+    def subject
+      @catalogue ||= catalogue
+    end
+
+    def catalogue
+      vardir = Dir.mktmpdir
+      Puppet[:vardir] = vardir
+      Puppet[:hiera_config] = File.join(vardir, "hiera.yaml") if Puppet[:hiera_config] == File.expand_path("/dev/null")
+      Puppet[:modulepath] = self.respond_to?(:module_path) ? module_path : RSpec.configuration.module_path
+      Puppet[:manifestdir] = self.respond_to?(:manifest_dir) ? manifest_dir : RSpec.configuration.manifest_dir
+      Puppet[:manifest] = self.respond_to?(:manifest) ? manifest : RSpec.configuration.manifest
+      Puppet[:templatedir] = self.respond_to?(:template_dir) ? template_dir : RSpec.configuration.template_dir
+      Puppet[:config] = self.respond_to?(:config) ? config : RSpec.configuration.config
+      code = ""
+
+      nodename = self.class.top_level_description.downcase
+
+      facts_val = {
+        'hostname' => nodename.split('.').first,
+        'fqdn' => nodename,
+        'domain' => nodename.split('.').last,
+      }
+      facts_val.merge!(munge_facts(facts)) if self.respond_to?(:facts)
+
+      catalogue = build_catalog(nodename, facts_val, code)
+      FileUtils.rm_rf(vardir) if File.directory?(vardir)
+      catalogue
+    end
+  end
+end

data/lib/rspec-puppet/matchers.rb

@@ -0,0 +1,4 @@
+require 'rspec-puppet/matchers/create_generic'
+require 'rspec-puppet/matchers/create_resource'
+require 'rspec-puppet/matchers/include_class'
+require 'rspec-puppet/matchers/run'

data/lib/rspec-puppet/matchers/create_generic.rb

@@ -0,0 +1,133 @@
+module RSpec::Puppet
+  module ManifestMatchers
+    class CreateGeneric
+      def initialize(*args, &block)
+        @exp_resource_type = args.shift.to_s.gsub(/^(create|contain)_/, '')
+        @args = args
+        @block = block
+        @referenced_type = referenced_type(@exp_resource_type)
+        @title = args[0]
+      end
+
+      def with(*args, &block)
+        params = args.shift
+        @expected_params = (@expected_params || []) | params.to_a
+        self
+      end
+
+      def without(*args, &block)
+        params = args.shift
+        @expected_undef_params = (@expected_undef_params || []) | Array(params)
+        self
+      end
+
+      def method_missing(method, *args, &block)
+        if method.to_s =~ /^with_/
+          param = method.to_s.gsub(/^with_/, '')
+          (@expected_params ||= []) << [param, args[0]]
+          self
+        elsif method.to_s =~ /^without_/
+          param = method.to_s.gsub(/^without_/, '')
+          (@expected_undef_params ||= []) << param
+          self
+        else
+          super
+        end
+      end
+
+      def matches?(catalogue)
+        ret = true
+        resource = catalogue.resource(@referenced_type, @title)
+
+        if resource.nil?
+          ret = false
+        else
+          rsrc_hsh = resource.to_hash
+          if @expected_params
+            @expected_params.each do |name, value|
+              if value.kind_of?(Regexp) then
+                unless rsrc_hsh[name.to_sym].to_s =~ value
+                  ret = false
+                  (@errors ||= []) << "#{name.to_s} matching `#{value.inspect}` but its value of `#{rsrc_hsh[name.to_sym].inspect}` does not"
+                end
+              elsif value.kind_of?(Array) then
+                unless Array(rsrc_hsh[name.to_sym]).flatten.join == value.flatten.join
+                  ret = false
+                  (@errors ||= []) << "#{name.to_s} set to `#{value.inspect}` but it is set to `#{rsrc_hsh[name.to_sym].inspect}` in the catalogue"
+                end
+              else
+                unless rsrc_hsh[name.to_sym].to_s == value.to_s
+                  ret = false
+                  (@errors ||= []) << "#{name.to_s} set to `#{value.inspect}` but it is set to `#{rsrc_hsh[name.to_sym].inspect}` in the catalogue"
+                end
+              end
+            end
+          end
+
+          if @expected_undef_params
+            @expected_undef_params.each do |name|
+              unless resource.send(:parameters)[name.to_sym].nil?
+                ret = false
+                (@errors ||= []) << "#{name.to_s} undefined"
+              end
+            end
+          end
+        end
+
+        ret
+      end
+
+      def failure_message_for_should
+        "expected that the catalogue would contain #{@referenced_type}[#{@title}]#{errors}"
+      end
+
+      def failure_message_for_should_not
+        "expected that the catalogue would not contain #{@referenced_type}[#{@title}]#{errors}"
+      end
+
+      def description
+        values = []
+        if @expected_params
+          @expected_params.each do |name, value|
+            if value.kind_of?(Regexp)
+              values << "#{name.to_s} matching #{value.inspect}"
+            else
+              values << "#{name.to_s} => #{value.inspect}"
+            end
+          end
+        end
+
+        if @expected_undef_params
+          @expected_undef_params.each do |name, value|
+            values << "#{name.to_s} undefined"
+          end
+        end
+
+        unless values.empty?
+          if values.length == 1
+            value_str = " with #{values.first}"
+          else
+            value_str = " with #{values[0..-2].join(", ")} and #{values[-1]}"
+          end
+        end
+
+        "contain #{@referenced_type}[#{@title}]#{value_str}"
+      end
+
+    private
+
+      def referenced_type(type)
+        type.split('__').map { |r| r.capitalize }.join('::')
+      end
+
+      def errors
+        @errors.nil? ? "" : " with #{@errors.join(', and parameter ')}"
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      return RSpec::Puppet::ManifestMatchers::CreateGeneric.new(method, *args, &block) if method.to_s =~ /^(create|contain)_/
+      super
+    end
+  end
+end

data/lib/rspec-puppet/matchers/create_resource.rb

@@ -0,0 +1,53 @@
+module RSpec::Puppet
+  module ManifestMatchers
+    extend RSpec::Matchers::DSL
+
+    matcher :create_resource do |expected_type, expected_title|
+      match do |catalogue|
+        ret = true
+        resources = catalogue.resources.select { |r|
+          r.type == referenced_type(expected_type)
+        }.select { |r|
+          r.title == expected_title if r.respond_to? :title
+        }
+
+        unless resources.length == 1
+          ret = false
+        end
+
+        if @expected_params and resources.length != 0
+          @expected_params.each do |name, value|
+            unless resources.first.send(:parameters)[name.to_sym] == value
+              ret = false
+              (@errors ||= []) << "the parameter #{name.to_s} set to `#{value}`"
+            end
+          end
+        end
+
+        ret
+      end
+
+      def errors
+        @errors.nil? ? "" : " with #{@errors.join(', ')}"
+      end
+
+      def referenced_type(type)
+        type.split('::').map { |r| r.capitalize }.join('::')
+      end
+
+      chain :with_param do |param_name,param_value|
+        (@expected_params ||= []) << [param_name, param_value]
+      end
+
+      description do
+        type = referenced_type(expected_type)
+        "create #{type}['#{expected_title}']"
+      end
+
+      failure_message_for_should do |actual|
+        type = referenced_type(expected_type)
+        "expected that the catalogue would contain #{type}['#{expected_title}']#{errors}"
+      end
+    end
+  end
+end

data/lib/rspec-puppet/matchers/include_class.rb

@@ -0,0 +1,19 @@
+module RSpec::Puppet
+  module ManifestMatchers
+    extend RSpec::Matchers::DSL
+
+    matcher :include_class do |expected_class|
+      match do |catalogue|
+        catalogue.classes.include? expected_class
+      end
+
+      description do
+        "include Class[#{expected_class}]"
+      end
+
+      failure_message_for_should do |actual|
+        "expected that the catalogue would include Class[#{expected_class}]"
+      end
+    end
+  end
+end

data/lib/rspec-puppet/matchers/run.rb

@@ -0,0 +1,76 @@
+module RSpec::Puppet
+  module FunctionMatchers
+    extend RSpec::Matchers::DSL
+
+    matcher :run do
+      match do |func_obj|
+        if @params
+          @func = lambda { func_obj.call(@params) }
+        else
+          @func = lambda { func_obj.call }
+        end
+
+        if @expected_error
+          begin
+            @func.call
+          rescue @expected_error
+            #XXX check error string here
+            true
+          rescue
+            false
+          end
+        else
+          if @expected_return
+            @func.call == @expected_return
+          else
+            begin
+              @func.call
+            rescue
+              false
+            end
+            true
+          end
+        end
+      end
+
+      chain :with_params do |*params|
+        @params = params
+      end
+
+      chain :and_return do |value|
+        @expected_return = value
+      end
+
+      # XXX support error string and regexp
+      chain :and_raise_error do |value|
+        @expected_error = value
+      end
+
+      failure_message_for_should do |func_obj|
+        func_name = func_obj.name.gsub(/^function_/, '')
+        func_params = @params.inspect[1..-2]
+
+        if @expected_return
+          "expected #{func_name}(#{func_params}) to have returned #{@expected_return.inspect} instead of #{@func.call.inspect}"
+        elsif @expected_error
+          "expected #{func_name}(#{func_params}) to have raised #{@expected_error.inspect}"
+        else
+          "expected #{func_name}(#{func_params}) to have run successfully"
+        end
+      end
+
+      failure_message_for_should_not do |func_obj|
+        func_name = func_obj.name.gsub(/^function_/, '')
+        func_params = @params.inspect[1..-2]
+
+        if @expected_return
+          "expected #{func_name}(#{func_params}) to not have returned #{@expected_return.inspect}"
+        elsif @expected_error
+          "expected #{func_name}(#{func_params}) to not have raised #{@expected_error.inspect}"
+        else
+          "expected #{func_name}(#{func_params}) to not have run successfully"
+        end
+      end
+    end
+  end
+end

data/lib/rspec-puppet/setup.rb

@@ -0,0 +1,144 @@
+require 'puppet'
+require 'fileutils'
+
+module RSpec::Puppet
+  class Setup
+    def self.run(module_name=nil)
+      unless is_module_dir?
+        $stderr.puts "Does not appear to be a Puppet module.  Aborting"
+        return false
+      end
+
+      if module_name.nil?
+        module_name = get_module_name
+        if module_name.nil?
+          $stderr.puts "Unable to determine module name.  Aborting"
+          return false
+        end
+      end
+
+      [
+        'spec',
+        'spec/classes',
+        'spec/defines',
+        'spec/functions',
+        'spec/hosts',
+        'spec/fixtures',
+        'spec/fixtures/manifests',
+        'spec/fixtures/modules',
+        "spec/fixtures/modules/#{module_name}",
+      ].each { |dir| safe_mkdir(dir) }
+
+      safe_touch('spec/fixtures/manifests/site.pp')
+
+      ['manifests','lib','files','templates'].each do |dir|
+        if File.exist? dir
+          safe_make_symlink("../../../../#{dir}", "spec/fixtures/modules/#{module_name}/#{dir}")
+        end
+      end
+
+      safe_create_spec_helper
+      safe_create_rakefile
+    end
+
+  protected
+    def self.get_module_name
+      p = Puppet::Parser::Lexer.new
+      module_name = nil
+      Dir["manifests/*.pp"].entries.each do |manifest|
+        p.string = File.read(manifest)
+        tokens = p.fullscan
+        i = tokens.index { |token| [:CLASS, :DEFINE].include? token.first }
+        unless i.nil?
+          module_name = tokens[i + 1].last[:value].split('::').first
+          break
+        end
+      end
+      module_name
+    end
+
+    def self.is_module_dir?
+      Dir["*"].entries.include? "manifests"
+    end
+
+    def self.safe_mkdir(dir)
+      if File.exists? dir
+        unless File.directory? dir
+          $stderr.puts "!! #{dir} already exists and is not a directory"
+        end
+      else
+        FileUtils.mkdir dir
+        puts " + #{dir}/"
+      end
+    end
+
+    def self.safe_touch(file)
+      if File.exists? file
+        unless File.file? file
+          $stderr.puts "!! #{file} already exists and is not a regular file"
+        end
+      else
+        FileUtils.touch file
+        puts " + #{file}"
+      end
+    end
+
+    def self.safe_create_spec_helper
+      content = <<-EOF
+require 'rspec-puppet'
+
+fixture_path = File.expand_path(File.join(__FILE__, '..', 'fixtures'))
+
+RSpec.configure do |c|
+  c.module_path = File.join(fixture_path, 'modules')
+  c.manifest_dir = File.join(fixture_path, 'manifests')
+end
+EOF
+      if File.exists? 'spec/spec_helper.rb'
+        old_content = File.read('spec/spec_helper.rb')
+        if old_content != content
+          $stderr.puts "!! spec/spec_helper.rb already exists and differs from template"
+        end
+      else
+        File.open('spec/spec_helper.rb', 'w') do |f|
+          f.puts content
+        end
+        puts ' + spec/spec_helper.rb'
+      end
+    end
+
+    def self.safe_make_symlink(source, target)
+      if File.exists? target
+        unless File.symlink? target
+          $stderr.puts "!! #{file} already exists and is not a symlink"
+        end
+      else
+        FileUtils.ln_s(source, target)
+        puts " + #{target}"
+      end
+    end
+
+    def self.safe_create_rakefile
+      content = <<-EOF
+require 'rake'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/*/*_spec.rb'
+end
+EOF
+      if File.exists? 'Rakefile'
+        old_content = File.read('Rakefile')
+        if old_content != content
+          $stderr.puts "!! Rakefile already exists and differs from template"
+        end
+      else
+        File.open('Rakefile', 'w') do |f|
+          f.puts content
+        end
+        puts ' + Rakefile'
+      end
+    end
+  end
+end