onceover 3.15.2 → 3.16.0

data/README.md

@@ -13,6 +13,7 @@ Onceover is a tool to automatically run basic tests on an entire Puppet controlr
     - [onceover.yaml](#onceoveryaml)
     - [factsets](#factsets)
     - [Hiera Data](#hiera-data)
+    - [r10k](#r10k)
   - [Spec testing](#spec-testing)
     - [Adding your own spec tests](#adding-your-own-spec-tests)
   - [Using Workarounds](#using-workarounds)
@@ -272,6 +273,21 @@ If you have hiera data inside your controlrepo (or somewhere else) Onceover can
 
 It is also worth noting that any hiera hierarchies that are based on custom facts will not work unless those facts are part of your factsets. Trusted facts will also not work at all as the catalogs are being compiled without the node's certificate. In these instances it may be worth creating a hierarchy level that simply includes dummy data for testing purposes in order to avoid hiera lookup errors.
 
+### r10k
+
+If you have custom r10k config that you want to use, place the `r10k.yaml` file in one of the following locations:
+
+- `{repo root}/r10k.yaml`
+- `{repo root}/spec/r10k.yaml`
+
+A good use of this is [enabling multi threading](https://github.com/puppetlabs/r10k/blob/master/doc/dynamic-environments/configuration.mkd#pool_size) by creating the following in `r10k.yaml`:
+
+```yaml
+# spec/r10k.yaml
+---
+pool_size: 20
+```
+
 #### Creating the config file
 
 If your `hiera.yaml` is version 4 or 5 and lives in the root of the controlrepo (as it should), Onceover will pick this up automatically. If you would like to make changes to this file for testing purposes, create a copy under `spec/hiera.yaml`. Onceover will use this version of the hiera config file first if it exists.

data/bin/onceover

@@ -6,12 +6,12 @@ require 'colored'
 begin
   Onceover::CLI.command.run(ARGV)
 rescue Interrupt
-  $stderr.puts "Aborted!".red
+  warn "Aborted!".red
   exit(1)
 rescue SystemExit => e
   exit(e.status)
 rescue Exception => e
-  $stderr.puts "\nError while running: #{e.inspect}".red
-  $stderr.puts e.backtrace.join("\n").red if ARGV.include? '--trace'
+  warn "\nError while running: #{e.inspect}".red
+  warn e.backtrace.join("\n").red if ARGV.include? '--trace'
   exit(1)
 end

data/features/run.feature

@@ -27,6 +27,11 @@ Feature: Run rspec and acceptance test suites
     When I run onceover command "run spec"
     Then I should see message pattern "apache::params"
 
+  Scenario: Checking that r10k config works
+    Given initialized control repo "caching"
+    When I run onceover command "run spec --debug"
+    Then I should see message pattern "r10k.yaml"
+
   Scenario: Run spec tests with misspelled module in Puppetfile
     Given initialized control repo "basic"
     And in Puppetfile is misspelled module's name

data/features/step_definitions/common.rb

@@ -26,7 +26,7 @@ Given(/^control repo "([^"]*)" without "([^"]*)"$/) do |controlrepo_name, filena
 end
 
 When(/^I run onceover command "([^"]*)"$/)  do |command|
-  @cmd.command = command
+  @cmd.command = "#{command} --debug"
   puts @cmd
   @cmd.run
 end

data/lib/onceover/beaker.rb

@@ -1,3 +1,6 @@
+# rubocop:disable Style/RescueStandardError
+# ^^ I canlt be bothered fixing this because all of this code is deprecated
+
 class Onceover
   class Beaker
     # WARNING: All of this functionality is deprecated. It will be left around
@@ -232,7 +235,10 @@ class Onceover
       end
 
       raise "The networkmanager created too many machines! Only expecting one" if hosts.count > 1
+
       @nwm.instance_variable_get(:@hosts)[0]
     end
   end
 end
+
+# rubocop:enable Style/RescueStandardError

data/lib/onceover/cli.rb

@@ -3,7 +3,7 @@ require 'cri'
 class Onceover
   class CLI
     def self.command
-      @cmd ||= Cri::Command.define do
+      @command ||= Cri::Command.define do
         name 'onceover'
         usage 'onceover <subcommand> [options]'
         summary 'Tool for testing Puppet controlrepos'

data/lib/onceover/cli/init.rb

@@ -9,7 +9,7 @@ class Onceover
   class CLI
     class Init
       def self.command
-        @cmd ||= Cri::Command.define do
+        @command ||= Cri::Command.define do
           name 'init'
           usage 'init'
           summary 'Sets up a controlrepo for testing from scratch'

data/lib/onceover/cli/run.rb

@@ -10,7 +10,7 @@ class Onceover
   class CLI
     class Run
       def self.command
-        @cmd ||= Cri::Command.define do
+        @command ||= Cri::Command.define do
           name 'run'
           usage 'run [spec|acceptance]'
           summary 'Runs either the spec or acceptance tests'
@@ -35,7 +35,7 @@ This includes deploying using r10k and running all custom tests.
 
       class Spec
         def self.command
-          @cmd ||= Cri::Command.define do
+          @command ||= Cri::Command.define do
             name 'spec'
             usage 'spec'
             summary 'Runs spec tests'
@@ -56,7 +56,7 @@ This includes deploying using r10k and running all custom tests.
 
       class Acceptance
         def self.command
-          @cmd ||= Cri::Command.define do
+          @command ||= Cri::Command.define do
             name 'acceptance'
             usage 'acceptance'
             summary 'Runs acceptance tests'

data/lib/onceover/cli/show.rb

@@ -7,7 +7,7 @@ class Onceover
   class CLI
     class Show
       def self.command
-        @cmd ||= Cri::Command.define do
+        @command ||= Cri::Command.define do
           name 'show'
           usage 'show [controlrepo|puppetfile]'
           summary 'Shows the current state of things'
@@ -25,7 +25,7 @@ Shows the state of either the controlrepo or the Puppetfile
 
       class Repo
         def self.command
-          @cmd ||= Cri::Command.define do
+          @command ||= Cri::Command.define do
             name 'repo'
             usage 'repo [options]'
             summary 'Shows the current state of the Controlrepo'
@@ -50,7 +50,7 @@ Useful for debugging.
 
       class Puppetfile
         def self.command
-          @cmd ||= Cri::Command.define do
+          @command ||= Cri::Command.define do
             name 'puppetfile'
             usage 'puppetfile [options]'
             summary 'Shows the current state of the puppetfile'

data/lib/onceover/cli/update.rb

@@ -7,7 +7,7 @@ class Onceover
   class CLI
     class Update
       def self.command
-        @cmd ||= Cri::Command.define do
+        @command ||= Cri::Command.define do
           name 'update'
           usage 'update puppetfile'
           summary 'Updates stuff, currently only the Puppetfile'
@@ -22,7 +22,7 @@ class Onceover
 
       class Puppetfile
         def self.command
-          @cmd ||= Cri::Command.define do
+          @command ||= Cri::Command.define do
             name 'puppetfile'
             usage 'puppetfile'
             summary 'Update all modules in the Puppetfile'

data/lib/onceover/controlrepo.rb

@@ -3,7 +3,6 @@ require 'erb'
 require 'yaml'
 require 'find'
 require 'pathname'
-require 'thread'
 require 'multi_json'
 require 'onceover/beaker'
 require 'onceover/logger'
@@ -115,7 +114,7 @@ class Onceover
       @environment_conf = opts[:environment_conf] || File.expand_path('./environment.conf', @root)
       @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', __FILE__)]
+      _facts_dirs       = [@facts_dir, File.expand_path('../../factsets', __dir__)]
       _facts_files      = opts[:facts_files]      || _facts_dirs.map{|d| File.join(d, '*.json')}
       @facts_files      = _facts_files.map{|_path| Dir[_path]}.flatten
 
@@ -134,7 +133,7 @@ class Onceover
     def to_s
       require 'colored'
 
-      <<-END.gsub(/^\s{4}/,'')
+      <<-REPO.gsub(/^\s{4}/,'')
       #{'puppetfile'.green}       #{@puppetfile}
       #{'environment_conf'.green} #{@environment_conf}
       #{'facts_dir'.green}        #{@facts_dir}
@@ -144,7 +143,7 @@ class Onceover
       #{'roles'.green}            #{roles}
       #{'profiles'.green}         #{profiles}
       #{'onceover.yaml'.green}    #{@onceover_yaml}
-      END
+      REPO
     end
 
     def roles
@@ -190,6 +189,7 @@ class Onceover
       if filter
         # Allow us to pass a hash of facts to filter by
         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|
@@ -254,13 +254,15 @@ class Onceover
 
       threads.map(&:join)
 
-      tp output_array,
+      tp(
+        output_array,
         {:full_name       => {:display_name => "Full Name"}},
         {:current_version => {:display_name => "Current Version"}},
         {:latest_version  => {:display_name => "Latest Version"}},
         {:out_of_date     => {:display_name => "Out of Date?"}},
         {:endorsement     => {:display_name => "Endorsement"}},
         {:superseded_by   => {:display_name => "Superseded by"}}
+      )
     end
 
     def update_puppetfile
@@ -305,6 +307,7 @@ class Onceover
       # Load up the Puppetfile using R10k
       puppetfile = R10K::Puppetfile.new(@root)
       fail 'Could not load Puppetfile' unless puppetfile.load
+
       modules = puppetfile.modules
 
       # Iterate over everything and seperate it out for the sake of readability
@@ -395,6 +398,7 @@ class Onceover
       possibe_datadirs = Dir["#{@root}/*/"]
       possibe_datadirs.keep_if { |dir| dir =~ /hiera(?:.*data)?/i }
       raise "There were too many directories that looked like hiera data: #{possibe_datadirs}" if possibe_datadirs.count > 1
+
       File.expand_path(possibe_datadirs[0])
     end
 
@@ -417,7 +421,7 @@ class Onceover
       # Finally, split the modulepath values and return
       begin
         environment_config['modulepath'] = environment_config['modulepath'].split(':')
-      rescue
+      rescue StandardError
         raise "modulepath was not found in environment.conf, don't know where to look for roles & profiles"
       end
       

data/lib/onceover/deploy.rb

@@ -118,8 +118,10 @@ class Onceover
           prod_dir = "#{repo.tempdir}/#{repo.environmentpath}/production"
           Dir.chdir(prod_dir) do
             install_cmd = []
-            install_cmd << "r10k puppetfile install --verbose --color --puppetfile #{repo.puppetfile}"
+            install_cmd << "r10k puppetfile install --color --puppetfile #{repo.puppetfile}"
             install_cmd << "--force" if force
+            install_cmd << "--config #{repo.r10k_config_file}" if repo.r10k_config_file
+            install_cmd << (logger.level > 0 ? "--verbose" : "--verbose debug") # Enable debugging if we're debugging
             install_cmd = install_cmd.join(' ')
             logger.debug "Running #{install_cmd} from #{prod_dir}"
             system(install_cmd)

data/lib/onceover/group.rb

@@ -71,7 +71,7 @@ class Onceover
         else
           return false
         end
-      rescue
+      rescue StandardErroor
         return false
       end
     end

data/lib/onceover/logger.rb

@@ -4,7 +4,8 @@ module Onceover::Logger
   def logger
     unless $logger
       # here we setup a color scheme called 'bright'
-      Logging.color_scheme('bright',
+      Logging.color_scheme(
+        'bright',
         :levels => {
           :debug => :cyan,
           :info  => :green,

data/lib/onceover/rake_tasks.rb

@@ -8,9 +8,10 @@ require 'pathname'
 desc 'Writes a `fixtures.yml` file based on the Puppetfile'
 task :generate_fixtures do
   repo = Onceover::Controlrepo.new
-  if File.exists?(File.expand_path('./.fixtures.yml', repo.root))
+  if File.exist?(File.expand_path('./.fixtures.yml', repo.root))
     raise ".fixtures.yml already exits, we won't overwrite because we are scared"
   end
+
   File.write(File.expand_path('./.fixtures.yml', repo.root), repo.fixtures)
 end
 

data/lib/onceover/rspec/formatters.rb

@@ -2,8 +2,14 @@ require 'rspec'
 require 'pathname'
 
 class OnceoverFormatter
-  RSpec::Core::Formatters.register self, :example_group_started,
-    :example_passed, :example_failed, :example_pending, :dump_failures#, :dump_summary
+  RSpec::Core::Formatters.register(
+    self,
+    :example_group_started,
+    :example_passed,
+    :example_failed,
+    :example_pending,
+    :dump_failures,
+  )
 
   COMPILATION_ERROR      = %r{error during compilation: (?<error>.*)}
   ERROR_WITH_LOCATION    = %r{(?<error>.*?)\s(at )?(\((file: (?<file>.*?), )?line: (?<line>\d+)(, column: (?<column>\d+))?\))(; )?}
@@ -218,8 +224,14 @@ end
 class OnceoverFormatterParallel < OnceoverFormatter
   require 'yaml'
 
-  RSpec::Core::Formatters.register self, :example_group_started,
-  :example_passed, :example_failed, :example_pending, :dump_failures
+  RSpec::Core::Formatters.register(
+    self,
+    :example_group_started,
+    :example_passed,
+    :example_failed,
+    :example_pending,
+    :dump_failures,
+  )
 
   def example_group_started notification
     # Do nothing
@@ -287,7 +299,7 @@ class FailureCollector
   end
 
   def dump_failures(failures)
-    open(File.expand_path("#{RSpec.configuration.onceover_tempdir}/failures.out"), 'a') { |f|
+    File.open(File.expand_path("#{RSpec.configuration.onceover_tempdir}/failures.out"), 'a') { |f|
       failures.failed_examples.each do |fe|
         f.puts
         f.puts "#{fe.metadata[:description]}"

data/lib/onceover/runner.rb

@@ -53,8 +53,10 @@ class Onceover
         @config.acceptance_tests.each { |test| @config.verify_acceptance_test(@repo, test) }
 
         # Write them out
-        @config.write_acceptance_tests("#{@repo.tempdir}/spec/acceptance",
-          @config.run_filters(Onceover::Test.deduplicate(@config.acceptance_tests)))
+        @config.write_acceptance_tests(
+          "#{@repo.tempdir}/spec/acceptance",
+          @config.run_filters(Onceover::Test.deduplicate(@config.acceptance_tests))
+        )
       end
 
       # Parse the current hiera config, modify, and write it to the temp dir

data/lib/onceover/testconfig.rb

@@ -104,12 +104,12 @@ class Onceover
     def to_s
       require 'colored'
 
-      <<-END.gsub(/^\s{4}/,'')
+      <<-TESTCONF.gsub(/^\s{4}/,'')
       #{'classes'.green}      #{@classes.map{|c|c.name}}
       #{'nodes'.green}        #{@nodes.map{|n|n.name}}
       #{'class_groups'.green} #{@class_groups}
       #{'node_groups'.green}  #{@node_groups.map{|g|g.name}}
-      END
+      TESTCONF
     end
 
     def self.find_list(thing)
@@ -177,30 +177,38 @@ class Onceover
         puppetcode << File.read(condition_file)
       end
       return nil if puppetcode.count.zero?
+
       puppetcode.join("\n")
     end
 
     def write_spec_test(location, test)
       # Use an ERB template to write a spec test
-      File.write("#{location}/#{test.to_s}_spec.rb",
-        Onceover::Controlrepo.evaluate_template('test_spec.rb.erb', binding))
+      File.write(
+        "#{location}/#{test.to_s}_spec.rb",
+        Onceover::Controlrepo.evaluate_template('test_spec.rb.erb', binding)
+      )
     end
 
     def write_acceptance_tests(location, tests)
       warn "[DEPRECATION] #{__method__} is deprecated due to the removal of Beaker"
 
-      File.write("#{location}/acceptance_spec.rb",
+      File.write(
+        "#{location}/acceptance_spec.rb",
         Onceover::Controlrepo.evaluate_template('acceptance_test_spec.rb.erb', binding))
     end
 
     def write_spec_helper_acceptance(location, repo)
-      File.write("#{location}/spec_helper_acceptance.rb",
-        Onceover::Controlrepo.evaluate_template('spec_helper_acceptance.rb.erb', binding))
+      File.write(
+        "#{location}/spec_helper_acceptance.rb",
+        Onceover::Controlrepo.evaluate_template('spec_helper_acceptance.rb.erb', binding)
+      )
     end
 
     def write_rakefile(location, pattern)
-      File.write("#{location}/Rakefile",
-        Onceover::Controlrepo.evaluate_template('testconfig_Rakefile.erb', binding))
+      File.write(
+        "#{location}/Rakefile",
+        Onceover::Controlrepo.evaluate_template('testconfig_Rakefile.erb', binding)
+      )
     end
 
     def write_spec_helper(location, repo)
@@ -222,8 +230,10 @@ class Onceover
       repo.temp_modulepath = modulepath
 
       # Use an ERB template to write a spec test
-      File.write("#{location}/spec_helper.rb",
-        Onceover::Controlrepo.evaluate_template('spec_helper.rb.erb', binding))
+      File.write(
+        "#{location}/spec_helper.rb",
+        Onceover::Controlrepo.evaluate_template('spec_helper.rb.erb', binding)
+      )
     end
 
     def create_fixtures_symlinks(repo)

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.15.2"
+  s.version     = "3.16.0"
   s.authors     = ["Dylan Ratcliffe"]
   s.email       = ["dylan.ratcliffe@puppet.com"]
   s.homepage    = "https://github.com/dylanratcliffe/onceover"
@@ -18,28 +18,23 @@ Gem::Specification.new do |s|
   s.executables  = 'onceover'
 
   # Runtime dependencies, but also probably dependencies of requiring projects
-  s.add_runtime_dependency 'rake', '>= 10.0.0'
-  s.add_runtime_dependency 'multi_json', '~> 1.10'
   s.add_runtime_dependency 'backticks', '>= 1.0.2'
-  s.add_runtime_dependency 'rspec-puppet', ">= 2.4.0"
-  s.add_runtime_dependency 'parallel_tests', ">= 2.0.0"
-  s.add_runtime_dependency 'puppetlabs_spec_helper', ">= 0.4.0"
-  s.add_runtime_dependency 'rspec', '>= 3.0.0'
-  s.add_runtime_dependency 'r10k', '>=2.1.0'
-  s.add_runtime_dependency 'puppet', '>=3.4.0'
+  s.add_runtime_dependency 'colored', '~> 1.2'
+  s.add_runtime_dependency 'cri', '>= 2.6'
+  s.add_runtime_dependency 'deep_merge', '>= 1.0.0'
   s.add_runtime_dependency 'facter', '< 4.0.0'
   s.add_runtime_dependency 'git'
-  s.add_runtime_dependency 'cri', '>= 2.6'
-  s.add_runtime_dependency 'colored', '~> 1.2'
   s.add_runtime_dependency 'logging', '>= 2.0.0'
-  s.add_runtime_dependency 'deep_merge', '>= 1.0.0'
+  s.add_runtime_dependency 'multi_json', '~> 1.10'
+  s.add_runtime_dependency 'parallel_tests', ">= 2.0.0"
+  s.add_runtime_dependency 'puppet', '>=4.0'
+  s.add_runtime_dependency 'puppetlabs_spec_helper', ">= 0.4.0"
+  s.add_runtime_dependency 'r10k', '>=2.1.0'
+  s.add_runtime_dependency 'rake', '>= 10.0.0'
+  s.add_runtime_dependency 'rspec', '>= 3.0.0'
+  s.add_runtime_dependency 'rspec-puppet', ">= 2.4.0"
+  s.add_runtime_dependency 'rspec_junit_formatter', '>= 0.2.0'
   s.add_runtime_dependency 'table_print', '>= 1.0.0'
   s.add_runtime_dependency 'versionomy', '>= 0.5.0'
-  s.add_runtime_dependency 'rspec_junit_formatter', '>= 0.2.0'
 
-  # Development
-  s.add_development_dependency 'rubocop', '~> 0.49.0'
-  s.add_development_dependency 'rubygems-tasks', '~> 0.2.0'
-  s.add_development_dependency 'pry', '~> 0.10.0'
-  s.add_development_dependency 'cucumber', '~> 2.0'
 end