onceover 3.21.0 → 4.0.0

data/features/support/controlrepo_helper.rb

@@ -1,5 +1,4 @@
 class ControlRepo_Helper
-
   attr_reader :tmp_folder
 
   def initialize( name )
@@ -34,5 +33,4 @@ class ControlRepo_Helper
   def add_line_to_puppetfile( line )
     open(puppetfile, 'a') { |f| f.puts line }
   end
-
 end

data/features/zzz_run.feature

@@ -38,14 +38,7 @@ Feature: Run rspec and acceptance test suites
     When I run onceover command "run spec"
     Then I should see error with message pattern "The module acme-not_exists does not exist"
 
-  # TODO: Work out why this is fialing on windows
-  # Scenario: Run with local modifications
-  #   Given initialized control repo "basic"
-  #   When I run onceover command "run spec"
-  #   And I make local modifications
-  #   And I run onceover command "run spec"
-  #   Then I should see message pattern "local modifications"
-
+  @skip_on_windows
   Scenario: Force overwrite local modifications
     Given initialized control repo "basic"
     When I run onceover command "run spec"

data/lib/onceover/beaker/spec_helper.rb

@@ -35,18 +35,18 @@ RSpec.configure do |c|
 
   #default option values
   defaults = {
-    :nodeset     => 'onceover-nodes',
+    :nodeset => 'onceover-nodes',
   }
   #read env vars
   env_vars = {
-    :color       => ENV['BEAKER_color'] || ENV['RS_COLOR'],
-    :nodeset     => ENV['BEAKER_set'] || ENV['RS_SET'],
-    :nodesetfile => ENV['BEAKER_setfile'] || ENV['RS_SETFILE'],
-    :provision   => ENV['BEAKER_provision'] || ENV['RS_PROVISION'],
-    :keyfile     => ENV['BEAKER_keyfile'] || ENV['RS_KEYFILE'],
-    :debug       => ENV['BEAKER_debug'] || ENV['RS_DEBUG'],
-    :destroy     => ENV['BEAKER_destroy'] || ENV['RS_DESTROY'],
-  }.delete_if {|key, value| value.nil?}
+    :color => ENV['BEAKER_color'] || ENV.fetch('RS_COLOR', nil),
+    :nodeset => ENV['BEAKER_set'] || ENV.fetch('RS_SET', nil),
+    :nodesetfile => ENV['BEAKER_setfile'] || ENV.fetch('RS_SETFILE', nil),
+    :provision => ENV['BEAKER_provision'] || ENV.fetch('RS_PROVISION', nil),
+    :keyfile => ENV['BEAKER_keyfile'] || ENV.fetch('RS_KEYFILE', nil),
+    :debug => ENV['BEAKER_debug'] || ENV.fetch('RS_DEBUG', nil),
+    :destroy => ENV['BEAKER_destroy'] || ENV.fetch('RS_DESTROY', nil),
+  }.compact
   #combine defaults and env_vars to determine overall options
   options = defaults.merge(env_vars)
 

data/lib/onceover/beaker.rb

@@ -11,9 +11,8 @@ class Onceover
       # se or an array
 
       if facts.is_a?(Array)
-        returnval = []
-        facts.each do |fact|
-          returnval << self.facts_to_vagrant_box(fact)
+        returnval = facts.map do |fact|
+          self.facts_to_vagrant_box(fact)
         end
         return returnval
       end
@@ -64,9 +63,8 @@ class Onceover
       warn "[DEPRECATION] #{__method__} is deprecated due to the removal of Beaker"
 
       if facts.is_a?(Array)
-        returnval = []
-        facts.each do |fact|
-          returnval << self.facts_to_platform(fact)
+        returnval = facts.map do |fact|
+          self.facts_to_platform(fact)
         end
         return returnval
       end
@@ -131,9 +129,9 @@ class Onceover
 
       # Do an r10k deploy
       r10k_deploy(host, {
-        :puppetfile => true,
-        :configfile => '/tmp/r10k.yaml',
-        })
+                    :puppetfile => true,
+                    :configfile => '/tmp/r10k.yaml',
+                  })
     end
 
     # This actually provisions a node and checks that puppet will be able to run and
@@ -153,7 +151,6 @@ class Onceover
       opts = {:check_idempotency => true}.merge(opts)
       opts = {:deploy_controlrepo => true}.merge(opts)
 
-
       raise "Hosts must be a single host object, not an array" if host.is_a?(Array)
       raise "Class must be a single Class [String], not an array" unless puppet_class.is_a?(String)
 
@@ -216,8 +213,8 @@ class Onceover
       # to refer to each key as either a string or an object
       current_opts.default_proc = proc do |h, k|
         case k
-          when String then sym = k.to_sym; h[sym] if h.key?(sym)
-          when Symbol then str = k.to_s; h[str] if h.key?(str)
+        when String then sym = k.to_sym; h[sym] if h.key?(sym)
+        when Symbol then str = k.to_s; h[str] if h.key?(str)
         end
       end
 

data/lib/onceover/cli/run.rb

@@ -44,6 +44,7 @@ This includes deploying using r10k and running all custom tests.
             optional nil, :format, 'Which RSpec formatter to use, valid options are: documentation, progress, FailureCollector, OnceoverFormatter. You also specify this multiple times', multiple: true, default: :defaults
             optional nil, :no_workarounds, 'Disables workarounds that have been added for convenience to get around common RSPec issues such as https://github.com/rodjek/rspec-puppet/issues/665'
             optional :ff, :fail_fast, 'Abort the run after the first failure'
+            optional nil, :auto_vendored, 'Attempt to resolve vendored puppet modules. Ex: puppetlabs/cron_core', default: false
 
             run do |opts, args, cmd|
               repo = Onceover::Controlrepo.new(opts)

data/lib/onceover/controlrepo.rb

@@ -119,7 +119,7 @@ class Onceover
       @spec_dir         = opts[:spec_dir]         || File.expand_path('./spec', @root)
       @facts_dir        = opts[:facts_dir]        || File.expand_path('factsets', @spec_dir)
       _facts_dirs       = [@facts_dir, File.expand_path('../../factsets', __dir__)]
-      _facts_files      = opts[:facts_files]      || _facts_dirs.map{|d| File.join(d, '*.json')}
+      _facts_files      = opts[:facts_files] || _facts_dirs.map{|d| File.join(d, '*.json')}
       @facts_files      = _facts_files.map{|_path| Dir[_path]}.flatten
 
       @nodeset_file     = opts[:nodeset_file]     || File.expand_path('./spec/acceptance/nodesets/onceover-nodes.yml', @root)
@@ -139,7 +139,6 @@ class Onceover
       end
     end
 
-
     def to_s
       require 'colored'
 
@@ -182,9 +181,8 @@ class Onceover
       end
 
       # Get all the classes from all of the manifests
-      classes = []
-      code_dirs.each do |dir|
-        classes << get_classes(dir)
+      classes = code_dirs.map do |dir|
+        get_classes(dir)
       end
       classes.flatten
     end
@@ -208,9 +206,8 @@ class Onceover
         raise "Filter param must be a hash" unless filter.is_a?(Hash)
 
         all_facts.keep_if do |hash|
-          matches = []
-          filter.each do |filter_fact,value|
-            matches << keypair_is_in_hash(hash,filter_fact,value)
+          matches = filter.map do |filter_fact,value|
+            keypair_is_in_hash(hash,filter_fact,value)
           end
           !matches.include? false
         end
@@ -231,10 +228,9 @@ class Onceover
       puppetfile.load!
 
       output_array = []
-      threads      = []
       error_array  = []
-      puppetfile.modules.each do |mod|
-        threads << Thread.new do
+      threads = puppetfile.modules.map do |mod|
+        Thread.new do
           begin
             row = []
             logger.debug "Loading data for #{mod.full_name}"
@@ -268,7 +264,7 @@ class Onceover
                         "PatchLevel_minor".green
                       else
                         "No".green
-                      end
+                     end
 
               row << mod.v3_module.endorsement
               superseded_by = mod.v3_module.superseded_by
@@ -290,8 +286,8 @@ class Onceover
             error_array << error
             logger.debug "Error loading module #{mod.full_name} - #{e.inspect}"
           end
-          end
         end
+      end
 
       threads.map(&:join)
 
@@ -313,13 +309,12 @@ class Onceover
       # TODO: Make sure we can deal with :latest
 
       # Create threading resources
-      threads = []
-      queue   = Queue.new
+      queue = Queue.new
       queue.push(puppetfile_string)
 
       puppetfile.modules.keep_if {|m| m.is_a?(R10K::Module::Forge)}
-      puppetfile.modules.each do |mod|
-        threads << Thread.new do
+      threads = puppetfile.modules.map do |mod|
+        Thread.new do
           logger.debug "Getting latest version of #{mod.full_name}"
           latest_version = mod.v3_module.current_release.version
 
@@ -360,14 +355,14 @@ class Onceover
             # Set it up as a symlink, because we are using local files in the Puppetfile
             symlinks << {
               'name' => mod.name,
-              'dir'  => mod.expected_version[:path]
+              'dir' => mod.expected_version[:path]
             }
           elsif mod.expected_version.is_a?(String)
             # Set it up as a normal forge module
             forge_modules << {
               'name' => mod.name,
               'repo' => mod.title,
-              'ref'  => mod.expected_version
+              'ref' => mod.expected_version
             }
           end
         elsif mod.is_a? R10K::Module::Git
@@ -377,7 +372,7 @@ class Onceover
               # I know I shouldn't be doing this, but trust me, there are no methods
               # anywhere that expose this value, I looked.
               'repo' => mod.instance_variable_get(:@remote),
-              'ref'  => mod.version
+              'ref' => mod.version
             }
         end
       end
@@ -392,7 +387,7 @@ class Onceover
         Dir["#{dir}/*"].each do |mod|
           symlinks << {
             'name' => File.basename(mod),
-            'dir'  => Pathname.new(File.expand_path(mod)).relative_path_from(Pathname.new(@root))#File.expand_path(mod)
+            'dir' => Pathname.new(File.expand_path(mod)).relative_path_from(Pathname.new(@root))#File.expand_path(mod)
           }
         end
       end
@@ -517,7 +512,7 @@ class Onceover
       # Add .onceover to Gitignore
       gitignore_path = File.expand_path('.gitignore', repo.root)
       if File.exist? gitignore_path
-        gitignore_content = (File.open(gitignore_path, 'r') {|f| f.read }).split("\n")
+        gitignore_content = (File.read(gitignore_path)).split("\n")
         message = "#{'changed'.green}"
       else
         message = "#{'created'.green}"
@@ -526,7 +521,7 @@ class Onceover
 
       unless gitignore_content.include?(".onceover")
         gitignore_content << ".onceover\n"
-        File.open(gitignore_path, 'w') {|f| f.write(gitignore_content.join("\n")) }
+        File.write(gitignore_path, gitignore_content.join("\n"))
         puts "#{message} #{Pathname.new(gitignore_path).relative_path_from(Pathname.new(Dir.pwd)).to_s}"
       end
     end
@@ -574,9 +569,9 @@ class Onceover
         # Add the resulting info to the hosts hash. This is what the
         # template will output
         hosts_hash[node_name] = {
-          :platform    => platform,
-          :boxname     => boxname,
-          :url         => url,
+          :platform => platform,
+          :boxname => boxname,
+          :url => url,
           :comment_out => comment_out
         }
       end
@@ -611,7 +606,7 @@ class Onceover
       if File.exist?(out_file)
         puts "#{'skipped'.yellow} #{Pathname.new(out_file).relative_path_from(Pathname.new(Dir.pwd)).to_s} #{'(exists)'.yellow}"
       else
-        File.open(out_file,'w') {|f| f.write(contents)}
+        File.write(out_file, contents)
         puts "#{'created'.green} #{Pathname.new(out_file).relative_path_from(Pathname.new(Dir.pwd)).to_s}"
       end
     end

data/lib/onceover/deploy.rb

@@ -13,6 +13,10 @@ class Onceover
       skip_r10k_default = !(File.file?(repo.puppetfile))
       skip_r10k = opts[:skip_r10k] || skip_r10k_default
       force     = opts[:force] || false
+      # Only attempt to resolve vendored modules if configured to do so
+      auto_vendored = opts[:auto_vendored] || false
+
+      require 'onceover/vendored_modules' if auto_vendored
 
       if repo.tempdir == nil
         repo.tempdir = Dir.mktmpdir('r10k')
@@ -63,7 +67,11 @@ class Onceover
           # add to list of files copied to cache by onceover
           onceover_manifest << relative_source
 
-          if File.directory? source
+          if File.symlink?(source)
+            # Handle symlinks
+            link_target = File.readlink(source) # Get the target of the symlink
+            FileUtils.ln_s link_target, target, force: true # Create symlink at target
+          elsif File.directory? source
             Find.prune if excluded_dirs.include? source
             FileUtils.mkdir target
           else
@@ -89,8 +97,27 @@ class Onceover
         # 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)  
+          new_puppetfile_contents = puppetfile_contents.gsub(":control_branch", "'#{git_branch}'")
+          File.write("#{temp_controlrepo}/Puppetfile", new_puppetfile_contents)
+        end
+
+        if auto_vendored
+          tmp_puppetfile = File.join(temp_controlrepo, 'Puppetfile')
+          tmp_puppetfile_contents = File.read(tmp_puppetfile)
+          vm = Onceover::VendoredModules.new({ repo: repo })
+          puppetfile = R10K::ModuleLoader::Puppetfile.new(basedir: temp_controlrepo)
+          vm.puppetfile_missing_vendored(puppetfile)
+          unless vm.missing_vendored.empty?
+            missing_slugs = vm.missing_vendored.map do |missing_mod|
+              missing_mod.keys[0]
+            end
+            logger.debug "Adding #{missing_slugs} to #{tmp_puppetfile}"
+            modlines = vm.missing_vendored.map do |missing_mod|
+              mod_slug = missing_mod.keys[0]
+              "mod '#{mod_slug}',\n  git: '#{missing_mod[mod_slug][:git]}',\n  ref: '#{missing_mod[mod_slug][:ref]}'"
+            end.join("\n")
+            File.write(tmp_puppetfile, "#{tmp_puppetfile_contents}\n# Onceover Managed Vendored Modules\n#{modlines}")
+          end
         end
       end
 

data/lib/onceover/group.rb

@@ -28,10 +28,8 @@ class Onceover
         @members = []
       else
         # Turn it into a full list
-        member_objects = []
-
         # This should also handle lists that include groups
-        members.each { |member| member_objects << Onceover::TestConfig.find_list(member) }
+        member_objects = members.map { |member| Onceover::TestConfig.find_list(member) }
         member_objects.flatten!
 
         # Check that they are all the same type

data/lib/onceover/logger.rb

@@ -8,8 +8,8 @@ module Onceover::Logger
         'bright',
         :levels => {
           :debug => :cyan,
-          :info  => :green,
-          :warn  => :yellow,
+          :info => :green,
+          :warn => :yellow,
           :error => :red,
           :fatal => [:white, :on_red]
         }
@@ -18,7 +18,7 @@ module Onceover::Logger
       Logging.appenders.stdout(
         'stdout',
         :layout => Logging.layouts.pattern(
-          :pattern      => '%l\t -> %m\n',
+          :pattern => '%l\t -> %m\n',
           :color_scheme => 'bright'
         )
       )

data/lib/onceover/node.rb

@@ -4,7 +4,6 @@ class Onceover
   class Node
     @@all = []
 
-
     attr_accessor :name
     attr_accessor :beaker_node
     attr_accessor :fact_set
@@ -44,7 +43,6 @@ class Onceover
       end
 
       @@all << self
-
     end
 
     def self.find(node_name)

data/lib/onceover/rake_tasks.rb

@@ -4,7 +4,6 @@ require 'pathname'
 @repo   = nil
 @config = nil
 
-
 desc 'Writes a `fixtures.yml` file based on the Puppetfile'
 task :generate_fixtures do
   repo = Onceover::Controlrepo.new
@@ -15,7 +14,6 @@ task :generate_fixtures do
   File.write(File.expand_path('./.fixtures.yml', repo.root), repo.fixtures)
 end
 
-
 desc "Modifies your `hiera.yaml` to point at the hieradata relative to its position."
 task :hiera_setup do
   repo = Onceover::Controlrepo.new
@@ -45,7 +43,6 @@ task :generate_onceover_yaml do
   puts ERB.new(onceover_yaml_template, nil, '-').result(binding)
 end
 
-
 task :generate_nodesets do
   warn "[DEPRECATION] #{__method__} is deprecated due to the removal of Beaker"
 
@@ -75,7 +72,7 @@ task :generate_nodesets do
       comment_out = false
       box_info = MultiJson.load(response.body)
       box_info['current_version']['providers'].each do |provider|
-        if  provider['name'] == 'virtualbox'
+        if provider['name'] == 'virtualbox'
           url = provider['original_url']
         end
       end
@@ -86,5 +83,13 @@ task :generate_nodesets do
     fixtures_template = File.read(File.expand_path('./nodeset.yaml.erb', template_dir))
     puts ERB.new(fixtures_template, nil, '-').result(binding)
   end
+end
+
+desc 'Create cache for vendored modules'
+task :generate_vendor_cache do
+  require 'onceover/controlrepo'
+  require 'onceover/vendored_modules'
 
+  repo = Onceover::Controlrepo.new(debug: true)
+  Onceover::VendoredModules.new({ repo: repo, cachedir: File.join(repo.spec_dir, 'vendored_modules'), force_update: true })
 end

data/lib/onceover/rspec/formatters.rb

@@ -127,9 +127,9 @@ class OnceoverFormatter
 
         scanned_errors.map do |error_matches|
           {
-            text:   error_matches[0],
-            file:   calculate_relative_source(error_matches[1]),
-            line:   error_matches[2],
+            text: error_matches[0],
+            file: calculate_relative_source(error_matches[1]),
+            line: error_matches[2],
             column: error_matches[3],
           }
         end
@@ -223,7 +223,6 @@ class OnceoverFormatter
   def longest_group
     RSpec.configuration.world.example_groups.max { |a,b| a.description.length <=> b.description.length}.description.length
   end
-
 end
 
 class OnceoverFormatterParallel < OnceoverFormatter
@@ -266,9 +265,7 @@ class OnceoverFormatterParallel < OnceoverFormatter
     FileUtils.mkdir_p "#{RSpec.configuration.onceover_tempdir}/parallel"
 
     # Dump the notification to a unique file
-    File.open("#{RSpec.configuration.onceover_tempdir}/parallel/results-#{random_string}.yaml", "w") do |file|
-      file.write(extract_failures(notification).to_yaml)
-    end
+    File.write("#{RSpec.configuration.onceover_tempdir}/parallel/results-#{random_string}.yaml", extract_failures(notification).to_yaml)
   end
 
   def output_results(directory)
@@ -280,7 +277,7 @@ class OnceoverFormatterParallel < OnceoverFormatter
     # Merge data
     roles = files.reduce({}) do |errs, file|
       # Read all files and merge them
-      errs.merge(YAML.load(File.read(file))) {|key, oldval, newval| [oldval, newval].flatten }# rubocop:disable Security/YAMLLoad
+      errs.merge(YAML.load_file(file)) {|key, oldval, newval| [oldval, newval].flatten }
     end
   
     # Delete files from the disk

data/lib/onceover/runner.rb

@@ -78,7 +78,7 @@ class Onceover
       Dir.chdir(@repo.tempdir) do
         # Disable warnings unless we are running in debug mode
         unless logger.level.zero?
-          previous_rubyopt = ENV['RUBYOPT']
+          previous_rubyopt = ENV.fetch('RUBYOPT', nil)
           ENV['RUBYOPT']   = ENV['RUBYOPT'].to_s + ' -W0'
         end
 

data/lib/onceover/test.rb

@@ -12,9 +12,8 @@ class Onceover
     # it will then detect them and expand them out into their respective objects so that
     # we just end up with a list of nodes and classes
     def initialize(on_this, test_this, test_config)
-
       @default_test_config = {
-        'check_idempotency'       => true,
+        'check_idempotency' => true,
         'runs_before_idempotency' => 1
       }
 
@@ -72,7 +71,7 @@ class Onceover
       if classes.count > 1
         class_msg = "#{classes.count}_classes"
       else
-        class_msg = classes[0].name.gsub(/::/,'__')
+        class_msg = classes[0].name.gsub("::",'__')
       end
 
       if nodes.count > 1

data/lib/onceover/testconfig.rb

@@ -282,9 +282,9 @@ class Onceover
     def run_filters(tests)
       # All of this needs to be applied AFTER deduplication but BEFORE writing
       filters = {
-        'tags'    => @filter_tags,
+        'tags' => @filter_tags,
         'classes' => @filter_classes,
-        'nodes'   => @filter_nodes
+        'nodes' => @filter_nodes
       }
       filters.each do |method, filter_list|
         if filter_list