rspec-puppet 2.2.0 → 2.3.0

data/lib/rspec-puppet/errors.rb

@@ -11,10 +11,18 @@ module RSpec::Puppet
       end
 
       def message
-        if negative == true
-          "#{param} not set to #{expected.inspect} but it is set to #{actual.inspect}"
+        if @param.to_s == 'content' and expected.is_a?( String )
+          if negative == true
+            "#{param} not set to supplied string"
+          else
+            "#{param} set to supplied string"
+          end
         else
-          "#{param} set to #{expected.inspect} but it is set to #{actual.inspect}"
+          if negative == true
+            "#{param} not set to #{expected.inspect} but it is set to #{actual.inspect}"
+          else
+            "#{param} set to #{expected.inspect} but it is set to #{actual.inspect}"
+          end
         end
       end
 

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

@@ -6,5 +6,9 @@ module RSpec::Puppet
     def catalogue
       @catalogue ||= load_catalogue(:class)
     end
+
+    def rspec_puppet_cleanup
+      @catalogue = nil
+    end
   end
 end

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

@@ -6,5 +6,9 @@ module RSpec::Puppet
     def catalogue
       @catalogue ||= load_catalogue(:define)
     end
+
+    def rspec_puppet_cleanup
+      @catalogue = nil
+    end
   end
 end

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

@@ -10,7 +10,7 @@ module RSpec::Puppet
       vardir = setup_puppet
 
       if Puppet.version.to_f >= 4.0
-        env = Puppet::Node::Environment.create(environment, [File.join(Puppet[:environmentpath],'fixtures','modules')], File.join(Puppet[:environmentpath],'fixtures','manifests'))
+        env = build_4x_environment(environment)
         loader = Puppet::Pops::Loaders.new(env)
         func = loader.private_environment_loader.load(:function,function_name)
         return func if func
@@ -35,6 +35,12 @@ module RSpec::Puppet
       @catalogue ||= compiler.catalog
     end
 
+    def rspec_puppet_cleanup
+      @catalogue = nil
+      @compiler = nil
+      @scope = nil
+    end
+
     private
 
     def compiler
@@ -63,5 +69,31 @@ module RSpec::Puppet
       compiler.compile
       compiler
     end
+
+    def build_scope(compiler, node_name)
+      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
+        scope = Puppet::Parser::Scope.new(:compiler => compiler)
+      else
+        scope = Puppet::Parser::Scope.new(compiler)
+      end
+
+      scope.source = Puppet::Resource::Type.new(:node, node_name)
+      scope.parent = compiler.topscope
+      scope
+    end
+
+    def build_node(name, opts = {})
+      if Puppet.version.to_f >= 4.0
+        node_environment = build_4x_environment(environment)
+      else
+        node_environment = Puppet::Node::Environment.new(environment)
+      end
+      opts.merge!({:environment => node_environment})
+      Puppet::Node.new(name, opts)
+    end
   end
 end

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

@@ -6,5 +6,9 @@ module RSpec::Puppet
     def catalogue
       @catalogue ||= load_catalogue(:host)
     end
+
+    def rspec_puppet_cleanup
+      @catalogue = nil
+    end
   end
 end

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

@@ -0,0 +1,4 @@
+module RSpec::Puppet
+  module ProviderExampleGroup
+  end
+end

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

@@ -0,0 +1,26 @@
+module RSpec::Puppet
+  module TypeExampleGroup
+    include RSpec::Puppet::TypeMatchers
+    include RSpec::Puppet::Support
+
+    def subject
+      @type_and_resource ||= begin
+        setup_puppet
+        type_name = self.class.top_level_description.downcase
+        my_params = self.respond_to?(:params) ? params : {}
+        [
+          Puppet::Type.type(type_name),
+          # I don't want to create the resource here, so I have
+          # to pass all of the bits form the current scope
+          # required to create it
+          title,
+          my_params
+        ]
+      end
+    end
+
+    def rspec_puppet_cleanup
+      @type_and_resource = nil
+    end
+  end
+end

data/lib/rspec-puppet/example.rb

@@ -3,8 +3,11 @@ require 'rspec-puppet/example/define_example_group'
 require 'rspec-puppet/example/class_example_group'
 require 'rspec-puppet/example/function_example_group'
 require 'rspec-puppet/example/host_example_group'
+require 'rspec-puppet/example/type_example_group'
+require 'rspec-puppet/example/provider_example_group'
 
 RSpec::configure do |c|
+
   def c.escaped_path(*parts)
     Regexp.compile(parts.join('[\\\/]'))
   end
@@ -21,11 +24,23 @@ RSpec::configure do |c|
     }
     c.include RSpec::Puppet::HostExampleGroup, :type => :host, :example_group => {
       :file_path => c.escaped_path(%w[spec hosts])
-   }
+    }
+    c.include RSpec::Puppet::TypeExampleGroup, :type => :type, :example_group => {
+      :file_path => c.escaped_path(%w[spec types])
+    }
+    c.include RSpec::Puppet::ProviderExampleGroup, :type => :provider, :example_group => {
+      :file_path => c.escaped_path(%w[spec providers])
+    }
   else
     c.include RSpec::Puppet::DefineExampleGroup, :type => :define, :file_path => c.escaped_path(%w[spec defines])
     c.include RSpec::Puppet::ClassExampleGroup, :type => :class, :file_path => c.escaped_path(%w[spec classes])
     c.include RSpec::Puppet::FunctionExampleGroup, :type => :puppet_function, :file_path => c.escaped_path(%w[spec functions])
     c.include RSpec::Puppet::HostExampleGroup, :type => :host, :file_path => c.escaped_path(%w[spec hosts])
+    c.include RSpec::Puppet::TypeExampleGroup, :type => :type, :file_path => c.escaped_path(%w[spec types])
+    c.include RSpec::Puppet::ProviderExampleGroup, :type => :provider, :file_path => c.escaped_path(%w[spec providers])
   end
+
+  # Hook for each example group type to remove any caches or instance variables, since they will remain
+  # and cause a memory leak.  Can't be assigned per type by :file_path, so check for its presence.
+  c.after(:each) { rspec_puppet_cleanup if respond_to?(:rspec_puppet_cleanup) }
 end

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

@@ -27,7 +27,7 @@ module RSpec::Puppet
           elsif @check_deps == true && missing_dependencies?
             false
           else
-            true
+            @expected_error.nil?
           end
         rescue Puppet::Error => e
           @error_msg = e.message
@@ -58,13 +58,24 @@ module RSpec::Puppet
           unless @error_msg.empty?
             "error during compilation: #{@error_msg}"
           else
-            "expected that the catalogue would include #{@failed_resource}"
+            case @expected_error
+            when nil
+              "expected that the catalogue would include #{@failed_resource}"
+            when Regexp
+              "expected that the catalogue would fail to compile and raise an error matching #{@expected_error.inspect}"
+            else
+              "expected that the catalogue would fail to compile and raise the error #{@expected_error.inspect}"
+            end
           end
         end
       end
 
       def failure_message_when_negated
-        "expected that the catalogue would not compile but it does"
+        if @expected_error.nil?
+          "expected that the catalogue would not compile but it does"
+        else
+          "expected that the catalogue would compile but it does not"
+        end
       end
 
       private

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

@@ -189,7 +189,11 @@ module RSpec::Puppet
           else
             a = type == :not ? '!' : '='
             b = value.is_a?(Regexp) ? '~' : '>'
-            output << "#{param.to_s} #{a}#{b} #{value.inspect}"
+            if param.to_s == 'content' and value.is_a?( String )
+              output << "#{param.to_s} #{type == :not ? 'not ' : ''} supplied string"
+            else
+              output << "#{param.to_s} #{a}#{b} #{value.inspect}"
+            end
           end
         end
         output
@@ -227,32 +231,84 @@ module RSpec::Puppet
         end
       end
 
-      def relationship_refs(array)
-        Array[array].flatten.map do |resource|
-          resource.respond_to?(:to_ref) ? resource.to_ref : resource
+      def resource_ref(resource)
+        resource.respond_to?(:to_ref) ? resource.to_ref : resource
+      end
+
+      def resource_from_ref(ref)
+        ref.is_a?(Puppet::Resource) ? ref : @catalogue.resource(ref)
+      end
+
+      def canonicalize_resource(resource)
+        resource_from_ref(resource_ref(resource))
+      end
+
+      def canonicalize_resource_ref(ref)
+        resource_ref(resource_from_ref(ref))
+      end
+
+      def relationship_refs(resource, type)
+        resource = canonicalize_resource(resource)
+        results = []
+        return results unless resource
+        Array[resource[type]].flatten.compact.each do |r|
+          results << canonicalize_resource_ref(r)
+          results << relationship_refs(r, type)
         end
+
+        # Add autorequires if any
+        if type == :require and resource.resource_type.respond_to? :eachautorequire
+          resource.resource_type.eachautorequire do |t, b|
+            Array(resource.to_ral.instance_eval(&b)).each do |dep|
+              res = "#{t.to_s.capitalize}[#{dep}]"
+              if r = relationship_refs(res, type)
+                results << res
+                results << r
+              end
+            end
+          end
+        end
+        results.flatten
+      end
+
+      def self_or_upstream(vertex)
+        [vertex] + @catalogue.upstream_from_vertex(vertex).keys
       end
 
       def precedes?(first, second)
-        if first.nil? || second.nil?
-          false
-        else
-          before_refs = relationship_refs(first[:before])
-          require_refs = relationship_refs(second[:require])
+        return false if first.nil? || second.nil?
+
+        self_or_upstream(first).each do |u|
+          self_or_upstream(second).each do |v|
+            before_refs = relationship_refs(u, :before)
+            require_refs = relationship_refs(v, :require)
 
-          before_refs.include?(second.to_ref) || require_refs.include?(first.to_ref)
+            if before_refs.include?(v.to_ref) || require_refs.include?(u.to_ref) || (before_refs & require_refs).any?
+              return true
+            end
+          end
         end
+
+        # Nothing found
+        return false
       end
 
       def notifies?(first, second)
-        if first.nil? || second.nil?
-          false
-        else
-          notify_refs = relationship_refs(first[:notify])
-          subscribe_refs = relationship_refs(second[:subscribe])
+        return false if first.nil? || second.nil?
+
+        self_or_upstream(first).each do |u|
+          self_or_upstream(second).each do |v|
+            notify_refs = relationship_refs(u, :notify)
+            subscribe_refs = relationship_refs(v, :subscribe)
 
-          notify_refs.include?(second.to_ref) || subscribe_refs.include?(first.to_ref)
+            if notify_refs.include?(v.to_ref) || subscribe_refs.include?(u.to_ref)
+              return true
+            end
+          end
         end
+
+        # Nothing found
+        return false
       end
 
       # @param resource [Hash<Symbol, Object>] The resource in the catalog

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

@@ -14,4 +14,11 @@ module RSpec::Puppet
       super
     end
   end
+
+  module TypeMatchers
+    def method_missing(method, *args, &block)
+      return RSpec::Puppet::TypeMatchers::CreateGeneric.new(method, *args, &block) if method == :be_valid_type
+      super
+    end
+  end
 end

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

@@ -4,7 +4,7 @@ module RSpec::Puppet
 
     matcher :include_class do |expected_class|
       match do |catalogue|
-        RSpec.deprecate(:include_class, :contain_class)
+        RSpec.deprecate(:include_class, :replacement => :contain_class)
         catalogue.call.classes.include?(expected_class)
       end
 

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

@@ -17,6 +17,7 @@ module RSpec::Puppet
           end
         end
 
+        @has_returned = false
         begin
           @actual_return = @func.call
           @has_returned = true
@@ -32,7 +33,7 @@ module RSpec::Puppet
             when nil
               return true
             when Regexp
-              return @actual_error.message =~ @expected_error_message
+              return !!(@actual_error.message =~ @expected_error_message)
             else
               return @actual_error.message == @expected_error_message
             end
@@ -45,7 +46,7 @@ module RSpec::Puppet
           else
             case @expected_return
             when Regexp
-              return @actual_return =~ @expected_return
+              return !!(@actual_return =~ @expected_return)
             else
               return @actual_return == @expected_return
             end

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

@@ -0,0 +1,161 @@
+module RSpec::Puppet
+  module TypeMatchers
+
+    class CreateGeneric
+
+      def initialize(*args, &block)
+
+        @exp_provider = nil
+        @exp_parameters       = []
+        @exp_properties       = []
+        @exp_features         = []
+        @exp_defaults         = {}
+        @params_with_values   = {}
+        @errors               = []
+      end
+
+      # specifies a provider to validate
+      def with_provider(name)
+        @exp_provider = name
+        self
+      end
+
+      # ensures the listed properties are valid
+      def with_properties(props)
+        @exp_properties = @exp_properties | Array(props)
+        self
+      end
+
+      # ensures the listed parameters are valid
+      def with_parameters(params)
+        @exp_parameters = @exp_parameters | Array(params)
+        self
+      end
+
+      # ensure the type has the list of features
+      def with_features(features)
+        @exp_features = @exp_features | Array(features)
+        self
+      end
+
+      #
+      # ensures that the specified parameters with their values
+      # results in a valid resource
+      #
+      def with_set_attributes(params)
+        @params_with_values.merge!(params)
+        self
+      end
+
+      def with_defaults(defaults_hash)
+        @exp_defaults.merge!(defaults_hash)
+        self
+      end
+
+      #def with_autorequires(autorequires))
+      #end
+
+      #
+      # this is the method that drives all of the validation
+      #
+      def matches?(type_title_and_params)
+        type   = type_title_and_params[0]
+        title  = type_title_and_params[1]
+        params = type_title_and_params[2]
+        unless match_params(type) && match_props(type) && match_features(type)
+         return false
+        end
+        if @params_with_values != {} || @exp_provider
+          # only build a resource if we are validating provider or setting
+          # additional parameters
+          resource = be_valid_resource(type, title, params.merge(@params_with_values))
+          match_default_provider(resource) and match_default_values(resource)
+        else
+          true
+        end
+      end
+
+      # checks that the specified params exist
+      def match_params(type)
+        match_attrs(type, @exp_parameters, :parameter)
+      end
+
+      # checks that the specified properties exist
+      def match_props(type)
+        match_attrs(type, @exp_properties, :property)
+      end
+
+      # checks that the specified features exist
+      def match_features(type)
+        match_attrs(type, @exp_features, :feature)
+      end
+
+      # builds the resource with the specified param values
+      def be_valid_resource(type, title, params)
+        params[:name] ||= title
+        type.new(params)
+      end
+
+      #
+      # checks that the expected provider is set
+      #
+      def match_default_provider(resource)
+        if @exp_provider
+          if resource[:provider] == @exp_provider
+            return true
+          else
+            @errors.push("Expected provider: #{@exp_provider} does not match: #{resource[:provider]}")
+            return false
+          end
+        else
+          return true
+        end
+      end
+
+      def match_default_values(resource)
+        # TODO FINISH
+        true
+      end
+
+      def description
+        "be a valid type"
+      end
+
+      def failure_message
+        "Not a valid type #{@errors.inspect}"
+      end
+
+      private
+
+        def match_attrs(type, attrs, attr_type)
+          baddies = []
+          attrs.each do |param|
+            param = param.to_sym
+            if attr_type == :feature
+              unless type.provider_feature(param)
+                baddies.push(param)
+              end
+            elsif ! type.send("valid#{attr_type}?".to_sym, param)
+              baddies.push(param)
+            end
+          end
+          if baddies.size > 0
+            @errors.push("Invalid #{pluralize(attr_type)}: #{baddies.join(',')}")
+            false
+          else
+            true
+          end
+        end
+
+        def pluralize(name)
+          if name == :property
+            "properties"
+          else
+            "#{name}s"
+          end
+        end
+
+    end
+
+  end
+end

data/lib/rspec-puppet/matchers.rb

@@ -4,3 +4,4 @@ require 'rspec-puppet/matchers/compile'
 require 'rspec-puppet/matchers/run'
 require 'rspec-puppet/matchers/count_generic'
 require 'rspec-puppet/matchers/dynamic_matchers'
+require 'rspec-puppet/matchers/type_matchers'

data/lib/rspec-puppet/rake_task.rb

@@ -0,0 +1,20 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all RSpec code examples"
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  File.exist?('spec/spec.opts') ? opts = File.read("spec/spec.opts").chomp : opts = ""
+  t.rspec_opts = opts
+end
+
+SPEC_SUITES = (Dir.entries('spec') - ['.', '..','fixtures']).select {|e| File.directory? "spec/#{e}" }
+namespace :rspec do
+  SPEC_SUITES.each do |suite|
+    desc "Run #{suite} RSpec code examples"
+    RSpec::Core::RakeTask.new(suite) do |t|
+      t.pattern = "spec/#{suite}/**/*_spec.rb"
+      File.exist?('spec/spec.opts') ? opts = File.read("spec/spec.opts").chomp : opts = ""
+      t.rspec_opts = opts
+    end
+  end
+end

data/lib/rspec-puppet/setup.rb

@@ -55,6 +55,8 @@ module RSpec::Puppet
     end
 
     def self.get_module_name_from_file(file)
+      # FIXME: see discussion at
+      # https://github.com/rodjek/rspec-puppet/issues/290
       if Puppet.version.to_f >= 4.0
         p = Puppet::Pops::Parser::Lexer2.new
       else
@@ -113,18 +115,8 @@ module RSpec::Puppet
     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')
-  c.environmentpath = File.join(Dir.pwd, 'spec')
-end
-EOF
-    safe_create_file('spec/spec_helper.rb', content)
+      content = "require 'rspec-puppet/spec_helper'\n"
+      safe_create_file('spec/spec_helper.rb', content)
     end
 
     def self.safe_make_symlink(source, target)
@@ -140,27 +132,7 @@ EOF
 
     def self.safe_create_rakefile
       content = <<-'EOF'
-require 'rake'
-require 'rspec/core/rake_task'
-
-desc "Run all RSpec code examples"
-RSpec::Core::RakeTask.new(:rspec) do |t|
-  File.exist?('spec/spec.opts') ? opts = File.read("spec/spec.opts").chomp : opts = ""
-  t.rspec_opts = opts
-end
-
-SPEC_SUITES = (Dir.entries('spec') - ['.', '..','fixtures']).select {|e| File.directory? "spec/#{e}" }
-namespace :rspec do
-  SPEC_SUITES.each do |suite|
-    desc "Run #{suite} RSpec code examples"
-    RSpec::Core::RakeTask.new(suite) do |t|
-      t.pattern = "spec/#{suite}/**/*_spec.rb"
-      File.exist?('spec/spec.opts') ? opts = File.read("spec/spec.opts").chomp : opts = ""
-      t.rspec_opts = opts
-    end
-  end
-end
-task :default => :rspec
+require 'rspec-puppet/rake_task'
 
 begin
   if Gem::Specification::find_by_name('puppet-lint')
@@ -169,9 +141,10 @@ begin
     task :default => [:rspec, :lint]
   end
 rescue Gem::LoadError
+  task :default => :rspec
 end
 EOF
-    safe_create_file('Rakefile', content)
+      safe_create_file('Rakefile', content)
     end
   end
 end

data/lib/rspec-puppet/spec_helper.rb

@@ -0,0 +1,9 @@
+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')
+  c.environmentpath = File.join(Dir.pwd, 'spec')
+end