puppet-catalog-test 0.1.0 → 0.2.0

data/README.md

@@ -1,16 +1,22 @@
-# Test all your puppet catalogs for compiler errors
+# Test all your puppet catalogs for compiler warnings and errors
+
+puppet-catalog-test is a tool for capturing and testing warnings and errors the puppet-compiler is emitting during the compilation process.
+
+For a more detailed insight into the puppet-compiler, you can take a look at <http://www.masterzen.fr/2012/03/17/puppet-internals-the-compiler/>.
 
 ## Installation
 
-    gem install puppet-catalog-tests
+    gem install puppet-catalog-test
 
 ## Usage
 ```bash
 $ puppet-catalog-test -h
+
 USAGE: puppet-catalog-test [options]
     -m, --module-paths PATHS         Location of puppet modules, separated by collon
     -M, --manifest-path PATH         Location of the puppet manifests (site.pp)
-    -f, --filter PATTERN             Filter test cases by pattern
+    -i, --include-pattern PATTERN    Include only test cases that match pattern
+    -e, --exclude-pattern PATTERN    Exclude test cases that match pattern
     -s, --scenario FILE              Scenario definition to use
     -h, --help                       Show this message
 ```
@@ -61,7 +67,8 @@ namespace :catalog do
     t.module_paths = ["modules"]
     t.manifest_path = File.join("scripts", "site.pp")
 
-    t.filter = ENV["filter"] if ENV["filter"]
+    t.include_pattern = ENV["include"]
+    t.exclude_pattern = ENV["exclude"]
   end
 end
 ```
@@ -96,7 +103,8 @@ namespace :catalog do
       "operatingsystem" => "RedHat"
     }
 
-    t.filter = ENV["filter"] if ENV["filter"]
+    t.include_pattern = ENV["include"]
+    t.exclude_pattern = ENV["exclude"]
   end
 end
 ```
@@ -115,7 +123,8 @@ namespace :catalog do
 
     t.scenario_yaml = "scenarios.yml"
 
-    t.filter = ENV["filter"] if ENV["filter"]
+    t.include_pattern = ENV["include"]
+    t.exclude_pattern = ENV["exclude"]
   end
 end
 ```
@@ -153,7 +162,7 @@ REDHAT_db-dev:
 
 ## Reporters (output plugins)
 
-Per default puppet-catalog-test will use the StdoutReporter which will represent the result like in the examples above. Besides this you can use in your own Reporter.
+Per default puppet-catalog-test uses the StdoutReporter which prints the result like in the examples above. Besides this you can use in your own Reporter.
 
 Puppet-Catalog-Test also ships a JunitXmlReporter which creates a junit compatible xml report.
 

data/bin/puppet-catalog-test

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
 
+# allow loading library from workspace
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
 require "puppet-catalog-test"
 require "optparse"
 
-options = {
-  :filter => PuppetCatalogTest::DEFAULT_FILTER
-}
+options = {}
 
 opt_parser = OptionParser.new do |opts|
   opts.banner = "USAGE: #{File.basename($0)} [options]"
@@ -18,8 +19,12 @@ opt_parser = OptionParser.new do |opts|
     options[:manifest_path] = arg
   end
 
-  opts.on("-f", "--filter PATTERN", "Filter test cases by pattern") do |arg|
-    options[:filter] = arg
+  opts.on("-i", "--include-pattern PATTERN", "Include only test cases that match pattern") do |arg|
+    options[:include_pattern] = arg
+  end
+
+  opts.on("-e", "--exclude-pattern PATTERN", "Exclude test cases that match pattern") do |arg|
+    options[:exclude_pattern] = arg
   end
 
   opts.on("-s", "--scenario FILE", "Scenario definition to use") do |arg|
@@ -39,12 +44,18 @@ if options.empty?
   exit
 end
 
-pct = PuppetCatalogTest::TestRunner.new(options[:manifest_path], options[:module_paths])
+pct = PuppetCatalogTest::TestRunner.new(
+  :manifest_path => options[:manifest_path],
+  :module_paths => options[:module_paths])
+
+filter = PuppetCatalogTest::Filter.new
+filter.include_pattern = options[:include_pattern] if options.has_key?(:include_pattern)
+filter.exclude_pattern = options[:exclude_pattern] if options.has_key?(:exclude_pattern)
 
 if options[:scenario]
-  pct.load_scenario_yaml(options[:scenario], options[:filter])
+  pct.load_scenario_yaml(options[:scenario], filter)
 else
-  pct.load_all(options[:filter])
+  pct.load_all(filter)
 end
 
 pct.run_tests!

data/lib/puppet-catalog-test.rb

@@ -1,8 +1,9 @@
 module PuppetCatalogTest
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 
   DEFAULT_FILTER = /.*/
 
+  require "puppet-catalog-test/filter"
   require "puppet-catalog-test/test_runner"
   require "puppet-catalog-test/rake_task"
 end

data/lib/puppet-catalog-test/filter.rb

@@ -0,0 +1,10 @@
+module PuppetCatalogTest
+  class Filter
+    attr_accessor :include_pattern, :exclude_pattern
+
+    def initialize(include_pattern = DEFAULT_FILTER, exclude_pattern = nil)
+      @include_pattern = include_pattern
+      @exclude_pattern = exclude_pattern
+    end
+  end
+end

data/lib/puppet-catalog-test/rake_task.rb

@@ -8,15 +8,14 @@ module PuppetCatalogTest
     attr_accessor :module_paths
     attr_accessor :manifest_path
     attr_accessor :scenario_yaml
-    attr_accessor :filter
+    attr_accessor :include_pattern
+    attr_accessor :exclude_pattern
     attr_accessor :facts
     attr_accessor :reporter
 
     def initialize(name, &task_block)
       desc "Compile all puppet catalogs" unless ::Rake.application.last_comment
 
-      @filter = PuppetCatalogTest::DEFAULT_FILTER
-
       task name do
         task_block.call(self) if task_block
         setup
@@ -24,7 +23,17 @@ module PuppetCatalogTest
     end
 
     def setup
-      pct = TestRunner.new(@manifest_path, @module_paths)
+      puppet_config = {
+        :manifest_path => @manifest_path,
+        :module_paths => @module_paths
+      }
+
+      pct = TestRunner.new(puppet_config)
+
+      @filter = Filter.new
+
+      @filter.include_pattern = @include_pattern if @include_pattern
+      @filter.exclude_pattern = @exclude_pattern if @exclude_pattern
 
       if @scenario_yaml
         pct.load_scenario_yaml(@scenario_yaml, @filter)

data/lib/puppet-catalog-test/test_runner.rb

@@ -12,7 +12,11 @@ module PuppetCatalogTest
     attr_reader :test_cases
     attr_reader :total_duration
 
-    def initialize(manifest_path, module_paths, stdout_target = $stdout)
+    def initialize(puppet_config, stdout_target = $stdout)
+      if !puppet_config
+        raise ArgumentError, "No puppet_config hash supplied"
+      end
+
       @test_cases = []
       @exit_on_fail = true
       @out = stdout_target
@@ -21,6 +25,10 @@ module PuppetCatalogTest
 
       @total_duration = nil
 
+      manifest_path = puppet_config[:manifest_path]
+      module_paths = puppet_config[:module_paths]
+      config_dir = puppet_config[:config_dir]
+
       raise ArgumentError, "[ERROR] manifest_path must be specified" if !manifest_path
       raise ArgumentError, "[ERROR] manifest_path (#{manifest_path}) does not exist" if !FileTest.exist?(manifest_path)
 
@@ -29,6 +37,10 @@ module PuppetCatalogTest
         raise ArgumentError, "[ERROR] module_path (#{mp}) does not exist" if !FileTest.directory?(mp)
       end
 
+      if config_dir
+        Puppet.settings.handlearg("--confdir", config_dir)
+      end
+
       Puppet.settings.handlearg("--config", ".")
       Puppet.settings.handlearg("--manifest", manifest_path)
 
@@ -44,13 +56,17 @@ module PuppetCatalogTest
 
       scenarios.each do |tc_name, facts|
         next if tc_name =~ /^__/
-        next if filter && !tc_name.match(filter)
+
+        if filter
+          next if filter.exclude_pattern && tc_name.match(filter.exclude_pattern)
+          next if filter.include_pattern && !tc_name.match(filter.include_pattern)
+        end
 
         add_test_case(tc_name, facts)
       end
     end
 
-    def load_all(filter = PuppetCatalogTest::DEFAULT_FILTER, facts = {})
+    def load_all(filter = Filter.new, facts = {})
       nodes = collect_puppet_nodes(filter)
 
       nodes.each do |n|
@@ -85,7 +101,16 @@ module PuppetCatalogTest
     def collect_puppet_nodes(filter)
       parser = Puppet::Parser::Parser.new("environment")
       nodes = parser.environment.known_resource_types.nodes.keys
-      nodes.select { |node| node.match(filter) }
+
+      if filter.exclude_pattern
+        nodes.delete_if { |node| node.match(filter.exclude_pattern) }
+      end
+
+      if filter.include_pattern
+        nodes.delete_if { |node| !node.match(filter.include_pattern) }
+      end
+
+      nodes
     end
 
     def run_tests!
@@ -108,6 +133,7 @@ module PuppetCatalogTest
             @reporter.report_passed_test_case(tc)
           end
         rescue => error
+          p error if $DEBUG
           tc.duration = Time.now - tc_start_time
           tc.error = error.message
           tc.passed = false

data/puppet-catalog-test.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name = 'puppet-catalog-test'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.homepage = 'https://github.com/invadersmustdie/puppet-catalog-test/'
-  s.summary = 'Tests all your puppet catalogs for compiler errors'
-  s.description = 'Tests all your puppet catalogs for compiler errors.'
+  s.summary = 'Test all your puppet catalogs for compiler warnings and errors'
+  s.description = 'Test all your puppet catalogs for compiler warnings and errors.'
 
   s.executables = ['puppet-catalog-test']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-catalog-test
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000 Z
+date: 2013-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -27,7 +27,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Tests all your puppet catalogs for compiler errors.
+description: Test all your puppet catalogs for compiler warnings and errors.
 email: rene.lengwinat@googlemail.com
 executables:
 - puppet-catalog-test
@@ -39,6 +39,7 @@ files:
 - Rakefile
 - README.md
 - puppet-catalog-test.gemspec
+- lib/puppet-catalog-test/filter.rb
 - lib/puppet-catalog-test/junit_xml_reporter.rb
 - lib/puppet-catalog-test/rake_task.rb
 - lib/puppet-catalog-test/stdout_reporter.rb
@@ -68,5 +69,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Tests all your puppet catalogs for compiler errors
+summary: Test all your puppet catalogs for compiler warnings and errors
 test_files: []
+has_rdoc: