puppet-spec 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0345031ab1c4f7933dc095e0c18df8013024955b
-  data.tar.gz: 6793e3f07d6e388b31ff7d52298e9cc233a6cd93
+  metadata.gz: e1b2a6f102ca870df851cd6b7e8b3fe181466d71
+  data.tar.gz: fbf64c3b18cda7e63ffd17261dae625ecd7dab38
 SHA512:
-  metadata.gz: 3c2297d9f5306ca4808b5b7e06eee0183998901f11d4b5216364fe9f77aea2d5b492ceca5455f160145cb4bb6a70dc2916909a56bf18aab724da25570f8c7ab3
-  data.tar.gz: 7381fa58926e80438f6f75d41625a862b187dac73332b3604e540e78c5d6c6425e176f73acbeb613a3a7bd16d833239ec579eb6d9d851525ceb50c514b767859
+  metadata.gz: f14eb73db5ebfe8cf67ff076159ef9ba3dc1bd9fe6ff0082a0780be50475316e799a7c9108db91e51ee0130cd2bf23193894550f4a658b882045a4eab61ff6ff
+  data.tar.gz: 656f782afe6f0ce5b44b57a5cc77e0a7a60dbd0565885a884bf10c7012fa218e5389a3832497f7a77af1e3710541dccd9794c5545266d86f84d93a56264e4c27

data/lib/puppet/application/spec.rb

@@ -1,48 +1,52 @@
 require 'puppet'
 require 'puppet/test/test_helper'
-require 'puppet/util/colors'
+require 'puppet/util/assertion/reporter'
 require 'fileutils'
 
 class Puppet::Application::Spec < Puppet::Application
-  include Puppet::Util::Colors
+
+  option("--manifest manifest",  "-m manifest")
+
+  attr_reader :reporter
 
   def run_command
-    output = Hash.new
+    @reporter = Puppet::Util::Assertion::Reporter.new
 
     begin
       Puppet::Test::TestHelper.initialize
-      output = process_spec_directory(specdir)
+      evaluate_assertions
+      reporter.print_footer
     rescue Exception => e
-      print colorize(:red, "#{e.message}\n")
-      exit 1
+      reporter.print_error(e)
     end
 
-    if output[:failed] == 0
-      exit 0
+    exit 1 unless reporter.failed == 0
+    exit 0
+  end
+
+  def evaluate_assertions
+    if options[:manifest]
+      process_spec(options[:manifest])
     else
-      exit 1
+      process_spec_directory(specdir)
     end
   end
 
   def process_spec_directory(specdir)
-    results = Dir.glob("#{specdir}/**/*_spec.pp").map { |spec| process_spec(spec) }.flatten
-    output = visit_assertions(results)
-    print_results(output)
-    output
+    Dir.glob("#{specdir}/**/*_spec.pp").map { |spec| process_spec(spec) }
   end
 
   def process_spec(path)
     catalog = catalog(path)
-    notify_compiled
-
     assertions = catalog.resources.select {|res| res.type == 'Assertion' }
 
-    # Get the subject resource from the catalog rather than the
-    # reference provided from the parser. The reference's resource
-    # object does not contain any parameters for whatever reason.
-    assertions.map do |res|
+    assertions.each do |res|
+      # Get the subject resource from the catalog rather than the
+      # reference provided from the parser. The reference's resource
+      # object does not contain any parameters for whatever reason.
       res[:subject] = catalog.resource(res[:subject].to_s)
-      res
+
+      reporter << res.to_ral
     end
   end
 
@@ -60,68 +64,6 @@ class Puppet::Application::Spec < Puppet::Application
     catalog
   end
 
-  # Return a hash that contains
-  # data to be displayed to the
-  # user which represents the results
-  # of the assertions.
-  def visit_assertions(assertions)
-    count = 0
-    failed_count = 0
-
-    msg = assertions.map do |assertion|
-      count += 1
-      validate_assertion(assertion)
-
-      unless assertion[:expectation] == assertion[:subject][assertion[:attribute]]
-        failed_count += 1
-        file = assertion[:subject].file.split('manifests/').last
-
-        msg = colorize(:red, "#{failed_count}) Assertion #{assertion[:name]} failed on #{assertion[:subject].to_s}\n")
-        msg += colorize(:yellow, "  On line #{assertion[:subject].line} of #{file}\n")
-        msg += colorize(:blue, "  Wanted: ")
-        msg += "#{assertion[:attribute]} => '#{assertion[:expectation]}'\n"
-        msg += colorize(:blue, "  Got:    ")
-        msg += "#{assertion[:attribute]} => '#{assertion[:subject][assertion[:attribute]]}'\n\n"
-      end
-    end
-
-    {
-      :msg    => msg.join,
-      :count  => count,
-      :failed => failed_count,
-    }
-  end
-
-  # Given the resulting hash
-  # from .visit_assertions,
-  # present the output to the
-  # user.
-  def print_results(results)
-    print "\n\n"
-    print results[:msg] if results[:msg]
-
-    if results[:count] == 1
-      print colorize(:yellow, "Evaluated #{results[:count]} assertion\n")
-    else
-      print colorize(:yellow, "Evaluated #{results[:count]} assertions\n")
-    end
-  end
-
-  # Validate assertion raises an error
-  # if the assertion does not contain
-  # a subject, or if it contains a
-  # expectation without attribute.
-  def validate_assertion(assertion)
-    raise Puppet::Error, "#{assertion} requires a subject" unless assertion[:subject]
-    raise Puppet::Error, "#{assertion} requires an attribute when an expectation is given" if assertion[:expectation] and not assertion[:attribute]
-  end
-
-  # Print an rspec style dot
-  # to signify spec compilation
-  def notify_compiled
-    print colorize(:green, '.')
-  end
-
   # Given a node object, return
   # the first modulepath
   def get_modulepath(node)
@@ -152,7 +94,7 @@ class Puppet::Application::Spec < Puppet::Application
     pwd = Dir.pwd
     specdir = File.join(pwd, 'spec')
     unless Dir.exist?(specdir)
-      raise 'No spec directory was found under the CWD. You can optionally specifiy one with --specdir'
+      raise 'No spec directory was found under the CWD. A spec manifest can be specified with the --manifest flag'
     end
     specdir
   end

data/lib/puppet/parser/functions/stub_class.rb

@@ -1,7 +1,9 @@
+require 'puppet/util/assertion/stubs'
+
 Puppet::Parser::Functions.newfunction(:stub_class, :arity => 1) do |values|
 
   raise Puppet::Error, "stub_class accepts a class name in the form of a string" unless values[0].is_a?(String)
 
-  compiler.environment.known_resource_types << Puppet::Resource::Type.new(:hostclass, values[0])
+  compiler.environment.known_resource_types << Puppet::Util::Assertion::Stubs::Type.new(:hostclass, values[0])
 
 end

data/lib/puppet/parser/functions/stub_type.rb

@@ -1,15 +1,9 @@
-class Puppet::Resource::Type::Stub < Puppet::Resource::Type
-  # Allow the stub type to receive
-  # assignments on any parameter key.
-  def valid_parameter?(name)
-    true
-  end
-end
+require 'puppet/util/assertion/stubs'
 
 Puppet::Parser::Functions.newfunction(:stub_type, :arity => 1) do |values|
 
   raise Puppet::Error, "stub_type accepts a type name in the form of a string" unless values[0].is_a?(String)
 
-  compiler.environment.known_resource_types << Puppet::Resource::Type::Stub.new(:definition, values[0])
+  compiler.environment.known_resource_types << Puppet::Util::Assertion::Stubs::Type.new(:definition, values[0])
 
 end

data/lib/puppet/provider/assertion/evaluator.rb

@@ -0,0 +1,31 @@
+Puppet::Type.type(:assertion).provide(:evaluator) do
+
+  # Returns the complete path to the
+  # subject's manifest after /manifests
+  def relative_path
+    @resource[:subject].file.split('manifests/').last
+  end
+
+  # Returns a hash containing the assertion's
+  # attribute as the single key, with the value
+  # of the expectation. Used for rendering the
+  # results to the console.
+  def wanted
+    { @resource[:attribute] => @resource[:expectation] }
+  end
+
+  # Returns a hash containing the assertion's
+  # attribute as the single key, with the value
+  # of the subject's attribute. Used for rendering the
+  # results to the console.
+  def got
+    { @resource[:attribute] => @resource[:subject][@resource[:attribute]] }
+  end
+
+  # Return false if the subject's attribute is
+  # equal to the expectation, true otherwise.
+  def failed?
+    @resource[:expectation] != @resource[:subject][@resource[:attribute]]
+  end
+
+end

data/lib/puppet/type/assertion.rb

@@ -6,6 +6,12 @@ Puppet::Type.newtype(:assertion) do
   spec application.
   "
 
+  validate do
+    fail Puppet::Error, "a subject is required" unless @parameters[:subject]
+    fail Puppet::Error, "an attribute is required when an expectation is given" if @parameters[:expectation] and not @parameters[:attribute]
+    fail Puppet::Error, "an expectation is required when an attribute is given" if @parameters[:attribute] and not @parameters[:expectation]
+  end
+
   newparam(:name) do
     desc "A plain text message describing what the assertion is intended to prove.
 
@@ -21,17 +27,12 @@ Puppet::Type.newtype(:assertion) do
     "
 
     validate do |value|
-      fail Puppet::Error, "You must provide an assertion subject" unless value
-      fail Puppet::Error, "Attributes must be a resource reference" unless value.is_a? Puppet::Resource
+      fail Puppet::Error, "Subject must be a resource reference" unless value.is_a? Puppet::Resource
     end
   end
 
   newparam(:attribute) do
     desc "An attribute of the subject resource to assert against"
-
-    validate do |value|
-      fail Puppet::Error, "You must provide attribute to be asserted" unless value
-    end
   end
 
   newparam(:expectation) do

data/lib/puppet/util/assertion/printer.rb

@@ -0,0 +1,52 @@
+require 'puppet/util/colors'
+
+module Puppet::Util
+  module Assertion
+    class Printer
+      include Puppet::Util::Colors
+
+      attr_reader :stack
+
+      def initialize
+        @stack = []
+      end
+
+      def red(msg)
+        stack << colorize(:red, msg)
+      end
+
+      def blue(msg)
+        stack << colorize(:blue, msg)
+      end
+
+      def yellow(msg)
+        stack << colorize(:yellow, msg)
+      end
+
+      def white(msg)
+        stack << msg
+      end
+
+      def newline
+        stack << "\n"
+      end
+
+      def to_s
+        stack.join
+      end
+
+      # Styler is a mixin that provides a helper
+      # method that parses a styled string by
+      # evaluating the given proc on an instance
+      # of Printer.
+      module Styler
+        def style(&proc)
+          printer = Puppet::Util::Assertion::Printer.new
+          printer.instance_eval(&proc)
+          print printer.to_s
+        end
+      end
+
+    end
+  end
+end

data/lib/puppet/util/assertion/reporter.rb

@@ -0,0 +1,82 @@
+require 'puppet/util/assertion/printer'
+
+module Puppet::Util
+  module Assertion
+    class Reporter
+      include Puppet::Util::Assertion::Printer::Styler
+
+      attr_reader :evaluated, :failed
+
+      def initialize
+        @evaluated = 0
+        @failed = 0
+      end
+
+      # Given an assertion resource, evaluate it for success
+      # and send it to .report on failure. Increment the counter
+      # for each resource, and the failed counter for failed resources.
+      def <<(assertion)
+        count
+        if assertion.provider.failed?
+          fail
+          report(assertion)
+        end
+      end
+
+      # Print the summary of evaluated assertions
+      def print_footer
+        # Shim the reporter into the local scope
+        reporter = self
+
+        style do
+          if reporter.evaluated == 1
+            yellow "Evaluated 1 assertion\n"
+          else
+            yellow "Evaluated #{reporter.evaluated} assertions\n"
+          end
+        end
+      end
+
+      def print_error(err)
+        fail #Mark an assertion so the application exits 1
+        style do
+          red err.message
+        end
+      end
+
+      # Pretty print the results of an assertion to the console
+      def report(assertion)
+        # Shim the value of failed into the
+        # local scope in order to access it
+        # from the style proc.
+        failed = @failed
+
+        style do
+          red      "#{failed}) Assertion #{assertion[:name]} failed on #{assertion[:subject].to_s}"
+          newline
+
+          yellow   "  On line #{assertion[:subject].line} of #{assertion.provider.relative_path}"
+          newline
+
+          blue     "  Wanted: "
+          white    assertion.provider.wanted.to_s
+          newline
+
+          blue     "  Got:    "
+          white    assertion.provider.got.to_s
+          newline
+          newline
+        end
+      end
+
+      def count
+        @evaluated += 1
+      end
+
+      def fail
+        @failed += 1
+      end
+
+    end
+  end
+end

data/lib/puppet/util/assertion/stubs.rb

@@ -0,0 +1,16 @@
+require 'puppet/resource/type'
+
+module Puppet::Util::Assertion
+  class Stubs
+
+    # This type reimplements the Puppet::Resource::Type class
+    # and overwrites the parameter validation in order to
+    # allow any param to be assigned a value.
+    class Type < Puppet::Resource::Type
+      def valid_parameter?(name)
+        true
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-spec
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jordan Olshevski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -50,7 +50,11 @@ files:
 - lib/puppet/parser/functions/stub_class.rb
 - lib/puppet/parser/functions/stub_facts.rb
 - lib/puppet/parser/functions/stub_type.rb
+- lib/puppet/provider/assertion/evaluator.rb
 - lib/puppet/type/assertion.rb
+- lib/puppet/util/assertion/printer.rb
+- lib/puppet/util/assertion/reporter.rb
+- lib/puppet/util/assertion/stubs.rb
 homepage: http://github.com/jolshevski/puppet-spec
 licenses:
 - Apache-2.0