puppet-spec 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0345031ab1c4f7933dc095e0c18df8013024955b
+  data.tar.gz: 6793e3f07d6e388b31ff7d52298e9cc233a6cd93
+SHA512:
+  metadata.gz: 3c2297d9f5306ca4808b5b7e06eee0183998901f11d4b5216364fe9f77aea2d5b492ceca5455f160145cb4bb6a70dc2916909a56bf18aab724da25570f8c7ab3
+  data.tar.gz: 7381fa58926e80438f6f75d41625a862b187dac73332b3604e540e78c5d6c6425e176f73acbeb613a3a7bd16d833239ec579eb6d9d851525ceb50c514b767859

data/lib/puppet-spec/tasks.rb

@@ -0,0 +1,6 @@
+require 'puppet/application/spec'
+
+desc "Evaluate puppet-spec test cases and print the results"
+task(:puppetspec) do
+  Puppet::Application::Spec.new.run
+end

data/lib/puppet/application/spec.rb

@@ -0,0 +1,160 @@
+require 'puppet'
+require 'puppet/test/test_helper'
+require 'puppet/util/colors'
+require 'fileutils'
+
+class Puppet::Application::Spec < Puppet::Application
+  include Puppet::Util::Colors
+
+  def run_command
+    output = Hash.new
+
+    begin
+      Puppet::Test::TestHelper.initialize
+      output = process_spec_directory(specdir)
+    rescue Exception => e
+      print colorize(:red, "#{e.message}\n")
+      exit 1
+    end
+
+    if output[:failed] == 0
+      exit 0
+    else
+      exit 1
+    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
+  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|
+      res[:subject] = catalog.resource(res[:subject].to_s)
+      res
+    end
+  end
+
+  def catalog(path)
+    Puppet::Test::TestHelper.before_each_test
+    Puppet[:code] = File.read(path)
+
+    node = Puppet::Node.new("spec")
+    modulepath = get_modulepath(node)
+    link_module(modulepath)
+    catalog = Puppet::Resource::Catalog.indirection.find(node.name, :use_node => node)
+    catalog.to_ral
+
+    Puppet::Test::TestHelper.after_each_test
+    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)
+    node.environment.full_modulepath[0]
+  end
+
+  # Ensure that a symlink is present
+  # pointing from the node's env
+  # to the current directory
+  def link_module(modulepath)
+    pwd = Dir.pwd
+    name = File.basename(pwd)
+    symlink = File.join(modulepath, name)
+
+    # Ensure that the modulepath exists
+    # within the temp environment
+    FileUtils.mkdir_p(modulepath) unless Dir.exist?(modulepath)
+
+    # Ensure that a symlink to the
+    # cwd exists
+    FileUtils.ln_s(pwd, symlink) unless File.symlink?(symlink)
+  end
+
+  # Return the specdir under the
+  # CWD or raise an error if not
+  # found.
+  def specdir
+    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'
+    end
+    specdir
+  end
+
+end

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

@@ -0,0 +1,7 @@
+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])
+
+end

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

@@ -0,0 +1,9 @@
+Puppet::Parser::Functions.newfunction(:stub_facts, :arity => 1) do |values|
+
+  raise Puppet::Error, "stub_facts accepts a hash of fact/value pairs" unless values[0].is_a?(Hash)
+
+  values[0].each do |key, value|
+    compiler.topscope[key] = value
+  end
+
+end

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

@@ -0,0 +1,15 @@
+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
+
+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])
+
+end

data/lib/puppet/type/assertion.rb

@@ -0,0 +1,41 @@
+Puppet::Type.newtype(:assertion) do
+
+  @doc = "Makes assertions on the state of a resource in the catalog.
+
+  The assertion type defines an assertion that will be evaluated by the
+  spec application.
+  "
+
+  newparam(:name) do
+    desc "A plain text message describing what the assertion is intended to prove.
+
+    The given text should form a sentence using the type's name.
+    Example: assertion { 'that the configuration file has the correct contents': }
+    "
+  end
+
+  newparam(:subject) do
+    desc "A reference to the resource to be asserted upon.
+
+    The referenced resource will be the subject of any assertions made as a result of this resource declaration.
+    "
+
+    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
+    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
+    desc "The expected value of the subject's attribute"
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: puppet-spec
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Jordan Olshevski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puppetlabs_spec_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: A Puppet testing framework implemented in the native DSL
+email:
+- jordan@puppetlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/puppet-spec/tasks.rb
+- lib/puppet/application/spec.rb
+- lib/puppet/parser/functions/stub_class.rb
+- lib/puppet/parser/functions/stub_facts.rb
+- lib/puppet/parser/functions/stub_type.rb
+- lib/puppet/type/assertion.rb
+homepage: http://github.com/jolshevski/puppet-spec
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Test Puppet code with Puppet code
+test_files: []