puppet-catalog-test 0.3.2 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f53f78fc8023e2f26117a42efe335a2a28d7001
+  data.tar.gz: e7e7f8458131b14e1ce871a678d5c599a56e6edd
+SHA512:
+  metadata.gz: bb3d70830479daf9a712bb61587bd31ff264e4931777ecbfa95341932d63622abcf0dc216e0564ba31ea88f78a10078f6c78b60d1d186f532ebf86b7bc2867a3
+  data.tar.gz: 06c3830c8c6711c7602b80b069f4d866c1e9e8539635142d2b0754d40468733b18517a5043d2c32194c0d375af08bab3f1c804224cb050082619e09b389e89af

data/README.md

@@ -8,6 +8,10 @@ puppet-catalog-test is a tool for capturing and testing warnings and errors the
 
 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/>.
 
+## Supported Ruby + Puppet Versions
+
+Supported versions of Ruby <> Puppet combinations are listed in the [support matrix](SUPPORTED_VERSIONS.md). Combinations not listed might work, but aren't tested yet.
+
 ## Installation
 
     gem install puppet-catalog-test
@@ -22,6 +26,7 @@ USAGE: puppet-catalog-test [options]
     -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
+    -f, --fact KEY=VALUE             Add custom fact
     -v, --verbose                    Verbose
     -x, --xml                        Use xml report
     -h, --help                       Show this message
@@ -75,6 +80,8 @@ namespace :catalog do
 
     t.include_pattern = ENV["include"]
     t.exclude_pattern = ENV["exclude"]
+
+    t.verbose = true
   end
 end
 ```
@@ -91,6 +98,8 @@ In the case above no facts weren't defined so puppet-catalog-test falls back to
 }
 ```
 
+**NOTE:** Working examples are bundled within [test/cases](test/cases).
+
 ### Testing all catalogs with custom facts
 
 It is also possible to define a custom set of facts. In this case the fallback facts listed in previous example won't be used.
@@ -198,6 +207,8 @@ namespace :catalog do
   PuppetCatalogTest::RakeTask.new(:all) do |t|
     t.module_paths = [File.join("modules")]
     t.manifest_path = File.join("scripts", "site.pp")
+
+    # crucial option for hiera integration
     t.config_dir = File.join("data") # expects hiera.yaml to be included in directory
 
     t.reporter = PuppetCatalogTest::JunitXmlReporter.new("puppet-vagrant-playground", "reports/puppet_catalog.xml")

data/Rakefile

@@ -14,4 +14,56 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task :default => :test
+task :test_integration do
+  base_dir = Dir.pwd
+  all_tests_green = true
+
+  Dir["test/**/Rakefile"].each do |rf|
+    supposed_to_fail = rf.include?("failing")
+    Dir.chdir rf.split("/")[0..-2].join("/")
+
+    ["catalog:scenarios", "catalog:all"].each do |tc|
+      tc_name = "#{rf} / #{tc}"
+      puts " * Running scenario: #{tc_name} ]"
+
+      exit_code = -1
+      captured_output = ""
+
+      if FileTest.exist?("hiera.yaml.erb")
+        template = ERB.new(File.read("hiera.yaml.erb"))
+        working_directory = File.join(File.dirname(__FILE__), File.dirname(rf))
+
+        File.open("hiera.yaml", "w") do |fp|
+          fp.puts template.result(binding)
+        end
+      end
+
+      IO.popen("bundle exec rake #{tc}") do |io|
+        while (line = io.gets)
+          captured_output << line
+        end
+
+        io.close
+        exit_code = $?
+      end
+
+      if (supposed_to_fail && exit_code != 0) || (!supposed_to_fail && exit_code == 0)
+        puts "    WORKED (supposed_to_fail = #{supposed_to_fail})"
+      else
+        all_tests_green = false
+        puts "\tScenario: #{tc_name} FAILED (supposed_to_fail = #{supposed_to_fail})"
+        puts ">>>>>>>>>>>>>"
+        puts captured_output
+        puts "<<<<<<<<<<<<<"
+      end
+    end
+
+    Dir.chdir base_dir
+  end
+
+  if !all_tests_green
+    fail
+  end
+end
+
+task :default => [:test, :test_integration]

data/bin/puppet-catalog-test

@@ -7,6 +7,7 @@ require "puppet-catalog-test"
 require "optparse"
 
 options = {}
+options[:custom_facts] = {}
 
 opt_parser = OptionParser.new do |opts|
   opts.banner = "USAGE: #{File.basename($0)} [options]"
@@ -35,8 +36,14 @@ opt_parser = OptionParser.new do |opts|
     options[:scenario] = arg
   end
 
+  opts.on("-f", "--fact KEY=VALUE", "Add custom fact") do |arg|
+    k = arg.split("=").first
+    v = arg.split("=").last
+    options[:custom_facts][k] = v
+  end
+
   opts.on("-v", "--verbose", "Verbose") do |arg|
-    options[:verbose] = 1
+    options[:verbose] = true
   end
 
   opts.on("-x", "--xml", "Use xml report") do |arg|
@@ -70,7 +77,7 @@ filter.exclude_pattern = options[:exclude_pattern] if options.has_key?(:exclude_
 if options[:scenario]
   pct.load_scenario_yaml(options[:scenario], filter)
 else
-  pct.load_all(filter)
+  pct.load_all(filter, options[:custom_facts])
 end
 
 pct.run_tests!

data/lib/puppet-catalog-test/puppet_adapter/base_puppet_adapter.rb

@@ -0,0 +1,49 @@
+require "puppet"
+
+module PuppetCatalogTest
+  class BasePuppetAdapter
+    def initialize(config)
+      manifest_path = config[:manifest_path]
+      module_paths = config[:module_paths]
+      config_dir = config[:config_dir]
+      hiera_config = config[:hiera_config]
+      verbose = config[:verbose]
+
+      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)
+
+      raise ArgumentError, "[ERROR] module_path must be specified" if !module_paths
+      module_paths.each do |mp|
+        raise ArgumentError, "[ERROR] module_path (#{mp}) does not exist" if !FileTest.directory?(mp)
+      end
+
+      if config_dir
+        Puppet.settings.handlearg("--confdir", config_dir)
+      end
+
+      if verbose
+        Puppet::Util::Log.newdestination(:console)
+        Puppet::Util::Log.level = :debug
+      end
+
+      Puppet.settings.handlearg("--config", ".")
+      Puppet.settings.handlearg("--manifest", manifest_path)
+
+      module_path = module_paths.join(":")
+
+      Puppet.settings.handlearg("--modulepath", module_path)
+
+      if hiera_config
+        raise ArgumentError, "[ERROR] hiera_config  (#{hiera_config}) does not exist" if !FileTest.exist?(hiera_config)
+        Puppet.settings[:hiera_config] = hiera_config
+      end
+    end
+
+    def parser; end
+    def compile(node); end
+    def create_node(hostname, facts); end
+    def version; end
+    def prepare; end
+    def cleanup; end
+  end
+end

data/lib/puppet-catalog-test/puppet_adapter/puppet_3x_adapter.rb

@@ -0,0 +1,51 @@
+require "puppet"
+
+module PuppetCatalogTest
+  class Puppet3xAdapter < BasePuppetAdapter
+    def initialize(config)
+      super(config)
+
+      require 'puppet/test/test_helper'
+
+      # works 3.7.x
+      if version.start_with?("3.7.")
+        Puppet::Test::TestHelper.initialize
+      end
+
+      Puppet::Node::Environment.new.modules_by_path.each do |_, mod|
+        mod.entries.each do |entry|
+          ldir = entry.plugin_directory
+          $LOAD_PATH << ldir unless $LOAD_PATH.include?(ldir)
+        end
+      end
+
+      Puppet.parse_config
+    end
+
+    def nodes
+      parser = Puppet::Parser::Parser.new(Puppet::Node::Environment.new)
+      parser.known_resource_types.nodes.keys
+    end
+
+    def compile(node)
+      begin
+        Puppet::Test::TestHelper.before_each_test
+        Puppet::Parser::Compiler.compile(node)
+      rescue => e
+        raise e
+      ensure
+        Puppet::Test::TestHelper.after_each_test
+      end
+    end
+
+    def create_node(hostname, facts)
+      node = Puppet::Node.new(hostname)
+      node.merge(facts)
+      node
+    end
+
+    def version
+      Puppet::PUPPETVERSION
+    end
+  end
+end

data/lib/puppet-catalog-test/puppet_adapter/puppet_4x_adapter.rb

@@ -0,0 +1,45 @@
+require "puppet"
+
+module PuppetCatalogTest
+  class Puppet4xAdapter < BasePuppetAdapter
+    def initialize(config)
+      super(config)
+
+      @env = Puppet.lookup(:current_environment).
+        override_with(:manifest => config[:manifest_path]).
+        override_with(:modulepath => config[:module_paths])
+
+      @env.each_plugin_directory do |dir|
+        $LOAD_PATH << dir unless $LOAD_PATH.include?(dir)
+      end
+
+      require 'puppet/test/test_helper'
+
+      Puppet::Test::TestHelper.initialize
+      Puppet::Test::TestHelper.before_all_tests
+    end
+
+    def version
+      Puppet.version
+    end
+
+    def nodes
+      @env.known_resource_types.nodes.keys
+    end
+
+    def create_node(hostname, facts)
+      Puppet::Node.new(hostname, :facts => Puppet::Node::Facts.new("facts", facts))
+    end
+
+    def compile(node)
+      begin
+        Puppet::Test::TestHelper.before_each_test
+        Puppet::Parser::Compiler.compile(node)
+      rescue => e
+        raise e
+      ensure
+        Puppet::Test::TestHelper.after_each_test
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "puppet/version"
+require "puppet-catalog-test/puppet_adapter/base_puppet_adapter"
+
+require "puppet-catalog-test/puppet_adapter/puppet_3x_adapter"
+require "puppet-catalog-test/puppet_adapter/puppet_4x_adapter"
+
+module PuppetCatalogTest
+  class PuppetAdapterFactory
+    def self.create_adapter(config)
+      if Puppet.version.start_with?("3.")
+        return Puppet3xAdapter.new(config)
+      elsif Puppet.version.start_with?("4.")
+        return Puppet4xAdapter.new(config)
+      end
+
+      raise RuntimeException, "Unsupported Puppet version detected (#{Puppet.version})"
+    end
+  end
+end

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

@@ -13,6 +13,7 @@ module PuppetCatalogTest
     attr_accessor :exclude_pattern
     attr_accessor :facts
     attr_accessor :reporter
+    attr_accessor :verbose
 
     def initialize(name, &task_block)
       desc "Compile all puppet catalogs" unless ::Rake.application.last_comment
@@ -27,9 +28,14 @@ module PuppetCatalogTest
       puppet_config = {
         :manifest_path => @manifest_path,
         :module_paths => @module_paths,
-        :config_dir => @config_dir
+        :config_dir => @config_dir,
+        :verbose => @verbose
       }
 
+      if @config_dir
+        puppet_config[:hiera_config] = File.join(@config_dir, "hiera.yaml")
+      end
+
       pct = TestRunner.new(puppet_config)
 
       @filter = Filter.new

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

@@ -1,9 +1,9 @@
 require "yaml"
-require "puppet"
 require "parallel"
 
 require "puppet-catalog-test/test_case"
 require "puppet-catalog-test/stdout_reporter"
+require "puppet-catalog-test/puppet_adapter_factory"
 
 module PuppetCatalogTest
   class TestRunner
@@ -21,6 +21,7 @@ module PuppetCatalogTest
       @test_cases = []
       @exit_on_fail = true
       @out = stdout_target
+      @puppet_adapter = PuppetAdapterFactory.create_adapter(puppet_config)
 
       if puppet_config[:xml]
         require 'puppet-catalog-test/junit_xml_reporter'
@@ -30,44 +31,6 @@ module PuppetCatalogTest
       end
 
       @total_duration = nil
-
-      manifest_path = puppet_config[:manifest_path]
-      module_paths = puppet_config[:module_paths]
-      config_dir = puppet_config[:config_dir]
-      hiera_config = puppet_config[:hiera_config]
-      verbose = puppet_config[:verbose]
-
-      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)
-
-      raise ArgumentError, "[ERROR] module_path must be specified" if !module_paths
-      module_paths.each do |mp|
-        raise ArgumentError, "[ERROR] module_path (#{mp}) does not exist" if !FileTest.directory?(mp)
-      end
-
-      if config_dir
-        Puppet.settings.handlearg("--confdir", config_dir)
-      end
-
-      if verbose == 1
-        Puppet::Util::Log.newdestination(:console)
-        Puppet::Util::Log.level = :debug
-      end
-
-      Puppet.settings.handlearg("--config", ".")
-      Puppet.settings.handlearg("--config", ".")
-      Puppet.settings.handlearg("--manifest", manifest_path)
-
-      module_path = module_paths.join(":")
-
-      Puppet.settings.handlearg("--modulepath", module_path)
-
-      if hiera_config
-        raise ArgumentError, "[ERROR] hiera_config  (#{hiera_config}) does not exist" if !FileTest.exist?(hiera_config)
-        Puppet.settings[:hiera_config] = hiera_config
-      end
-
-      Puppet.parse_config
     end
 
     def load_scenario_yaml(yaml_file, filter = nil)
@@ -111,15 +74,13 @@ module PuppetCatalogTest
       hostname = node_fqdn.split('.').first
       facts['hostname'] = hostname
 
-      node = Puppet::Node.new(hostname)
-      node.merge(facts)
+      node = @puppet_adapter.create_node(hostname, facts)
 
-      Puppet::Parser::Compiler.compile(node)
+      @puppet_adapter.compile(node)
     end
 
     def collect_puppet_nodes(filter)
-      parser = Puppet::Parser::Parser.new(Puppet::Node::Environment.new)
-      nodes = parser.environment.known_resource_types.nodes.keys
+      nodes = @puppet_adapter.nodes
 
       if filter.exclude_pattern
         nodes.delete_if { |node| node.match(filter.exclude_pattern) }
@@ -133,7 +94,7 @@ module PuppetCatalogTest
     end
 
     def run_tests!
-      @out.puts "[INFO] Using puppet #{Puppet::PUPPETVERSION}"
+      @out.puts "[INFO] Using puppet #{@puppet_adapter.version}"
 
       run_start = Time.now
       proc_count = Parallel.processor_count
@@ -153,7 +114,11 @@ module PuppetCatalogTest
             @reporter.report_passed_test_case(tc)
           end
         rescue => error
-          p error if $DEBUG
+          if $DEBUG
+            p error
+            puts e.backtrace
+          end
+
           tc.duration = Time.now - tc_start_time
           tc.error = error.message
           tc.passed = false

data/puppet-catalog-test.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'puppet-catalog-test'
-  s.version = '0.3.2'
+  s.version = '0.4.0'
   s.homepage = 'https://github.com/invadersmustdie/puppet-catalog-test/'
   s.summary = 'Test all your puppet catalogs for compiler warnings and errors'
   s.description = 'Test all your puppet catalogs for compiler warnings and errors.'
@@ -23,4 +23,5 @@ Gem::Specification.new do |s|
 
   s.authors = ['Rene Lengwinat']
   s.email = 'rene.lengwinat@googlemail.com'
+  s.license = 'MIT'
 end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: puppet-catalog-test
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Rene Lengwinat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-27 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Test all your puppet catalogs for compiler warnings and errors.
@@ -66,40 +59,44 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/puppet-catalog-test
 - LICENSE
-- Rakefile
 - README.md
-- puppet-catalog-test.gemspec
+- Rakefile
+- bin/puppet-catalog-test
+- lib/puppet-catalog-test.rb
 - lib/puppet-catalog-test/filter.rb
 - lib/puppet-catalog-test/junit_xml_reporter.rb
+- lib/puppet-catalog-test/puppet_adapter/base_puppet_adapter.rb
+- lib/puppet-catalog-test/puppet_adapter/puppet_3x_adapter.rb
+- lib/puppet-catalog-test/puppet_adapter/puppet_4x_adapter.rb
+- lib/puppet-catalog-test/puppet_adapter_factory.rb
 - lib/puppet-catalog-test/rake_task.rb
 - lib/puppet-catalog-test/stdout_reporter.rb
 - lib/puppet-catalog-test/test_case.rb
 - lib/puppet-catalog-test/test_runner.rb
-- lib/puppet-catalog-test.rb
+- puppet-catalog-test.gemspec
 homepage: https://github.com/invadersmustdie/puppet-catalog-test/
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Test all your puppet catalogs for compiler warnings and errors
 test_files: []