onceover 3.19.2 → 3.21.0

data/lib/onceover/cli/show.rb

@@ -56,7 +56,7 @@ Useful for debugging.
             summary 'Shows the current state of the puppetfile'
             description <<-DESCRIPTION
 Shows the state of the puppetfile including current versions and
-laetst versions of each module. Great for checking for updates.
+latest versions of each module. Great for checking for updates.
 To update all modules run `onceover update puppetfile`. (Hint: once
 you have done the update, run the tests to make sure nothing breaks.)
             DESCRIPTION

data/lib/onceover/controlrepo.rb

@@ -76,6 +76,10 @@ class Onceover
       @@existing_controlrepo.facts(filter, 'trusted')
     end
 
+    def self.trusted_external_facts(filter = nil)
+      @@existing_controlrepo.facts(filter, 'trusted_external')
+    end
+
     def self.hiera_config_file
       @@existing_controlrepo.hiera_config_file
     end
@@ -228,46 +232,74 @@ class Onceover
 
       output_array = []
       threads      = []
+      error_array  = []
       puppetfile.modules.each do |mod|
         threads << Thread.new do
-          row = []
-          logger.debug "Loading data for #{mod.full_name}"
-          row << mod.full_name
-          if mod.is_a?(R10K::Module::Forge)
-            row << mod.expected_version
-            row << mod.v3_module.current_release.version
-
-            current = Versionomy.parse(mod.expected_version)
-            latest = Versionomy.parse(mod.v3_module.current_release.version)
-            row << if current.major < latest.major
-                     "Major".red
-                   elsif current.minor < latest.minor
-                     "Minor".yellow
-                   elsif current.tiny < latest.tiny
-                     "Tiny".green
-                   else
-                     "No".green
-                   end
-
-            row << mod.v3_module.endorsement
-            superseded_by = mod.v3_module.superseded_by
-            row << (superseded_by.nil? ? '' : superseded_by[:slug])
-          else
-            row << "N/A"
-            row << "N/A"
-            row << "N/A"
-            row << "N/A"
-            row << "N/A"
+          begin
+            row = []
+            logger.debug "Loading data for #{mod.full_name}"
+            row << mod.full_name
+            if mod.is_a?(R10K::Module::Forge)
+              row << mod.expected_version
+              row << mod.v3_module.current_release.version
+
+              # Configure a custom version format to support modern Puppet Forge versions.
+              # (major.minor.tiny-patchlevel-patchlevel_minor)
+              # e.g. 8.5.0-0-2
+              puppetforge_format = Versionomy.default_format.modified_copy do
+                field(:patchlevel_minor) do
+                  recognize_number(:default_value_optional => true,
+                                   :delimiter_regexp => '-',
+                                   :default_delimiter => '-')
+                end
+              end
+
+              current = puppetforge_format.parse(mod.expected_version)
+              latest = puppetforge_format.parse(mod.v3_module.current_release.version)
+              row << if current.major < latest.major
+                        "Major".red
+                      elsif current.minor < latest.minor
+                        "Minor".yellow
+                      elsif current.tiny < latest.tiny
+                        "Tiny".green
+                      elsif current.patchlevel < latest.patchlevel
+                        "PatchLevel".green
+                      elsif current.patchlevel_minor < latest.patchlevel_minor
+                        "PatchLevel_minor".green
+                      else
+                        "No".green
+                      end
+
+              row << mod.v3_module.endorsement
+              superseded_by = mod.v3_module.superseded_by
+              row << (superseded_by.nil? ? '' : superseded_by[:slug])
+            else
+              row << "N/A"
+              row << "N/A"
+              row << "N/A"
+              row << "N/A"
+              row << "N/A"
+            end
+            output_array << row
+          rescue RuntimeError => e
+            error = []
+            error << mod.full_name
+            error << mod.expected_version
+            error << mod.v3_module.current_release.version
+            error << e.message
+            error_array << error
+            logger.debug "Error loading module #{mod.full_name} - #{e.inspect}"
+          end
           end
-          output_array << row
         end
-      end
 
       threads.map(&:join)
 
       output_array.sort_by! { |line| line[0] }
+      error_array.sort_by! { |line| line[0] } unless error_array.empty?
 
       puts Terminal::Table.new(headings: ["Full Name", "Current Version", "Latest Version", "Out of Date?", "Endorsement", "Superseded by"], rows: output_array)
+      puts Terminal::Table.new(headings: ["Issue assessing module", "Current", "Latest", "Error"], rows: error_array) unless error_array.empty?
     end
 
     def update_puppetfile
@@ -571,7 +603,7 @@ class Onceover
       else
         template = File.read(File.expand_path("./#{template_name}", template_dir))
       end
-      ERB.new(template, nil, '-').result(bind)
+      ERB.new(template, trim_mode: '-').result(bind)
     end
 
     def self.init_write_file(contents, out_file)
@@ -596,7 +628,7 @@ class Onceover
 
       # Loop over each test, executing the user's block on each
       tests.each do |tst|
-        block.call(tst.classes[0].name, tst.nodes[0].name, tst.nodes[0].fact_set, testconfig.pre_condition)
+        block.call(tst.classes[0].name, tst.nodes[0].name, tst.nodes[0].fact_set, tst.nodes[0].trusted_set, tst.nodes[0].trusted_external_set, testconfig.pre_condition)
       end
     end
 

data/lib/onceover/deploy.rb

@@ -86,9 +86,12 @@ class Onceover
         FileUtils.copy repo.puppetfile, "#{temp_controlrepo}/Puppetfile"
         puppetfile_contents = File.read("#{temp_controlrepo}/Puppetfile")
 
-        logger.debug "replacing :control_branch mentions in the Puppetfile with #{git_branch}"
-        new_puppetfile_contents = puppetfile_contents.gsub(/:control_branch/, "'#{git_branch}'")
-        File.write("#{temp_controlrepo}/Puppetfile", new_puppetfile_contents)
+        # Avoid touching thing if we don't need to
+        if /:control_branch/.match(puppetfile_contents)
+          logger.debug "replacing :control_branch mentions in the Puppetfile with #{git_branch}"
+          new_puppetfile_contents = puppetfile_contents.gsub(/:control_branch/, "'#{git_branch}'")
+          File.write("#{temp_controlrepo}/Puppetfile", new_puppetfile_contents)  
+        end
       end
 
       # Remove all files written by the last onceover run, but not the ones

data/lib/onceover/node.rb

@@ -9,6 +9,7 @@ class Onceover
     attr_accessor :beaker_node
     attr_accessor :fact_set
     attr_accessor :trusted_set
+    attr_accessor :trusted_external_set
 
     def initialize(name)
       @name = name
@@ -20,10 +21,26 @@ class Onceover
           File.basename(facts_file, '.json') == name
         }  
         @fact_set = Onceover::Node.clean_facts(Onceover::Controlrepo.facts[facts_file_index])
+
+        # First see if we can find a 'trusted' hash at the top level of our factset 
         @trusted_set = Onceover::Controlrepo.trusted_facts[facts_file_index]
+        # If we don't find it, attempt to find a 'trusted.extensions' hash nested in our fact_set
+        @trusted_set = @fact_set.dig('trusted', 'extensions') if @trusted_set.nil?
+        # If we still can't find any, return an empty hash so the following doesn't blow up user written tests:
+        #   let(:trusted_facts) { trusted_facts }
+        @trusted_set = {} if @trusted_set.nil?
+
+        # First see if we can find a 'trusted_external' hash at the top level of our factset 
+        @trusted_external_set = Onceover::Controlrepo.trusted_external_facts[facts_file_index]
+        # If we don't find it, attempt to find a 'trusted.external' hash nested in our fact_set
+        @trusted_external_set = @fact_set.dig('trusted', 'external') if @trusted_external_set.nil?
+        # If we still can't find any, return an empty hash so the following doesn't blow up user written tests:
+        #   let(:trusted_external_data) { trusted_external_data }
+        @trusted_external_set = {} if @trusted_external_set.nil?
       rescue TypeError
-        @fact_set = nil
-        @trusted_set = nil
+        @fact_set = {}
+        @trusted_set = {}
+        @trusted_external_set = {}
       end
 
       @@all << self

data/lib/onceover/runner.rb

@@ -85,6 +85,7 @@ class Onceover
         # NOTE: This is the way to provide options to rspec according to:
         # https://github.com/puppetlabs/puppetlabs_spec_helper/blob/master/lib/puppetlabs_spec_helper/rake_tasks.rb#L51
         ENV['CI_SPEC_OPTIONS'] = ENV['CI_SPEC_OPTIONS'].to_s + @config.filter_tags.map { |tag| " --tag #{tag}" }.join unless @config.filter_tags.nil?
+        ENV['CI_SPEC_OPTIONS'] = ENV['CI_SPEC_OPTIONS'].to_s + ' --fail-fast' if @config.fail_fast
 
         if @config.opts[:parallel]
           logger.debug "Running #{@command_prefix}rake parallel_spec from #{@repo.tempdir}"

data/lib/onceover/testconfig.rb

@@ -27,12 +27,13 @@ class Onceover
     attr_accessor :after_conditions
     attr_accessor :skip_r10k
     attr_accessor :force
+    attr_accessor :fail_fast
     attr_accessor :strict_variables
     attr_accessor :formatters
 
     def initialize(file, opts = {})
       begin
-        config = YAML.safe_load(File.read(file), [Symbol])
+        config = YAML.safe_load(File.read(file), permitted_classes: [Symbol])
       rescue Errno::ENOENT
         raise "Could not find #{file}"
       rescue Psych::SyntaxError
@@ -79,6 +80,7 @@ class Onceover
       @filter_nodes   = opts[:nodes]     ? [opts[:nodes].split(',')].flatten.map {|x| Onceover::Node.find(x)} : nil
       @skip_r10k      = opts[:skip_r10k] ? true : false
       @force          = opts[:force] || false
+      @fail_fast      = opts[:fail_fast] || false
 
       # Validate the mock_functions
       if @mock_functions && @mock_functions.any? { |name, details| details.has_key? 'type' }
@@ -242,7 +244,7 @@ class Onceover
       source_files.each do |source_file|
         target_file = File.join(repo.tempdir, 'spec', source_file.sub(/^#{repo.spec_dir}/, ''))
         if File.directory?(source_file)
-          FileUtils.cp_r source_file, target_file unless File.exists? target_file
+          FileUtils.cp_r source_file, target_file unless File.exist? target_file
         else
           FileUtils.mkdir_p File.dirname target_file
           FileUtils.cp source_file, target_file

data/onceover.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "onceover"
-  s.version     = "3.19.2"
+  s.version     = "3.21.0"
   s.authors     = ["Dylan Ratcliffe"]
   s.email       = ["dylan.ratcliffe@puppet.com"]
   s.homepage    = "https://github.com/dylanratcliffe/onceover"
@@ -38,6 +38,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'cucumber', '~> 4.1'
   s.add_development_dependency 'pry', '~> 0.13.1'
-  s.add_development_dependency 'rubocop', '~> 1.6', '>= 1.6.1'
+  # We need to depend on rubocop <= 1.12 in order to support Ruby 2.4 (Puppet
+  # 5). Once we drop support for Puppet 5 we can re-open this
+  s.add_development_dependency 'rubocop', '>= 1.6.1', '<= 1.12'
   s.add_development_dependency 'rubygems-tasks', '~> 0.2.5'
 end

data/spec/fixtures/controlrepos/caching/Puppetfile

@@ -1,17 +1,17 @@
-forge "http://forge.puppetlabs.com"
-#
-# I want to download some modules to check if r10k feature in Onceover works correctly.
-#
-
-# Versions should be updated to be the latest at the time you start
-mod "puppetlabs/stdlib",      '4.11.0'
-
-# Modules from Git
-# Examples: https://github.com/puppetlabs/r10k/blob/master/doc/puppetfile.mkd#examples
-mod 'apache',
- :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
- :commit => '83401079053dca11d61945bd9beef9ecf7576cbf'
-
-#mod 'apache',
-#  :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
-#  :branch => 'docs_experiment'
+forge "http://forge.puppetlabs.com"
+#
+# I want to download some modules to check if r10k feature in Onceover works correctly.
+#
+
+# Versions should be updated to be the latest at the time you start
+mod "puppetlabs/stdlib",      '4.11.0'
+
+# Modules from Git
+# Examples: https://github.com/puppetlabs/r10k/blob/master/doc/puppetfile.mkd#examples
+mod 'apache',
+ :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
+ :commit => '83401079053dca11d61945bd9beef9ecf7576cbf'
+
+#mod 'apache',
+#  :git    => 'https://github.com/puppetlabs/puppetlabs-apache',
+#  :branch => 'docs_experiment'

data/spec/fixtures/controlrepos/factsets/site/role/manifests/trusted_extensions.pp

@@ -0,0 +1,6 @@
+# Role that fails compilation if $trusted['extensions']['pp_datacenter'] is not set to 'PDX'
+class role::trusted_extensions {
+  unless $trusted['extensions']['pp_datacenter'] == 'PDX' {
+    fail ( 'pp_datacenter is not set to PDX' )
+  }
+}

data/spec/fixtures/controlrepos/factsets/site/role/manifests/trusted_external.pp

@@ -0,0 +1,6 @@
+# Role that fails compilation if $trusted['external']['example']['foo'] is not set to 'bar'
+class role::trusted_external {
+  unless $trusted['external']['example']['foo'] == 'bar' {
+    fail ( "example forager didn't return foo" )
+  }
+}

data/spec/fixtures/controlrepos/factsets/spec/factsets/README.md

@@ -0,0 +1,7 @@
+# Factsets
+
+This directory is where we put any custom factsets that we want to use. They can be generated by running `puppet facts` on the target system.
+
+**Hot tip:** If you already have factsets in here when you run `onceover init` they will be picked up and added to the config file Automatically
+
+More info: https://github.com/dylanratcliffe/onceover#factsets