onceover 3.15.0 → 3.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4262b6cc1cabc3a26101c7617d4c697fd149b0d1b03ecb93576fa6044b32497e
-  data.tar.gz: df7f1e1010b33a82b68edb5b7e4f44eee3452077a9d84e4cec0433b8d702a6ee
+  metadata.gz: e6886259693e386c10aaebdd590be798363b38e823e4d7eb266d4f32f303cf2a
+  data.tar.gz: afdcc34051329c3a584803af4164f42aef9d2ac22e37bf14a35546f5ed8f45e3
 SHA512:
-  metadata.gz: 2eed34c2baadc64f072db8659d16b0eed8ae6029411f6e7e6e97977dce4ce7ae8977f758e233814a20aaeee1e1083c26971ea61f984a9d204f7f2ce14d707ba5
-  data.tar.gz: 8c68f464f140b1be9a257593f48cf92540c4c87545761b626f65e635de5e88d901957cb5ea1be4a6bcb228125c1756af3f111e287181eb5278208dff7e98455a
+  metadata.gz: 6f5b35dfa27bf5b8e6477ffcd3ea985935698d0562cc55ab679e80c501ce15ecb17deb47c81dc276e4bc8634662be7354b0578a122f3258f6f5cb8f00a43dcb5
+  data.tar.gz: 68c7771cfadc3ef7d9e43569e06e4ce40288a07db464eeaffc4c67b95558dab7b3c76f4e88dcb62ef82f02baf3e8ac13bc17cb988ead6164d96a05e43ef25ebd

data/.gitignore

@@ -8,6 +8,7 @@ Gemfile.local
 /.bin
 /.ruby-version
 tmp
+vendor
 
 # Vim
 /.projections.json

data/.rubocop.yml

@@ -1,16 +1,16 @@
 AllCops:
   Include:
-    - 'lib/**/*.rb'
-    - 'ext/**/*.rb'
+    - "lib/**/*.rb"
+    - "ext/**/*.rb"
   Exclude:
-    - '**/*.erb'
-    - 'acceptance/**/*'
-    - 'autotest/**/*'
-    - 'spec/**/*'
-    - 'tasks/**/*'
-    - 'vendor/**/*'
-
-Lint/ConditionPosition:
+    - "**/*.erb"
+    - "acceptance/**/*"
+    - "autotest/**/*"
+    - "spec/**/*"
+    - "tasks/**/*"
+    - "vendor/**/*"
+
+Layout/ConditionPosition:
   Enabled: true
 
 Lint/ElseLayout:
@@ -27,11 +27,7 @@ Lint/EnsureReturn:
   Enabled: false
 
 # MAYBE useful - errors when rescue {} happens.
-Lint/HandleExceptions:
-  Enabled: false
-
-# MAYBE useful - catches while 1
-Lint/LiteralInCondition:
+Lint/SuppressedException:
   Enabled: false
 
 Lint/ShadowingOuterLocalVariable:
@@ -41,7 +37,6 @@ Lint/ShadowingOuterLocalVariable:
 Lint/LiteralInInterpolation:
   Enabled: true
 
-
 # DISABLED really useless. Detects return as last statement.
 Style/RedundantReturn:
   Enabled: false
@@ -97,15 +92,15 @@ Security/Eval:
   Enabled: false
 
 # DISABLED
-Lint/BlockAlignment:
+Layout/BlockAlignment:
   Enabled: false
 
 # DISABLED
-Lint/DefEndAlignment:
+Layout/DefEndAlignment:
   Enabled: false
 
 # DISABLED
-Lint/EndAlignment:
+Layout/EndAlignment:
   Enabled: false
 
 # DISABLED
@@ -123,7 +118,7 @@ Lint/ParenthesesAsGroupedExpression:
 Lint/RescueException:
   Enabled: false
 
-Lint/StringConversionInInterpolation:
+Lint/RedundantStringCoercion:
   Enabled: false
 
 Lint/UnusedBlockArgument:
@@ -147,22 +142,22 @@ Lint/Void:
 Layout/AccessModifierIndentation:
   Enabled: false
 
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Enabled: false
 
 Style/Alias:
   Enabled: false
 
-Layout/AlignArray:
+Layout/ArrayAlignment:
   Enabled: false
 
-Layout/AlignHash:
+Layout/HashAlignment:
   Enabled: false
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   Enabled: false
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 Metrics/BlockNesting:
@@ -174,9 +169,6 @@ Style/AsciiComments:
 Style/Attr:
   Enabled: false
 
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Style/CaseEquality:
   Enabled: false
 
@@ -195,7 +187,7 @@ Layout/MultilineMethodCallBraceLayout:
 Style/CharacterLiteral:
   Enabled: false
 
-Style/ClassAndModuleCamelCase:
+Naming/ClassAndModuleCamelCase:
   Enabled: false
 
 Style/ClassAndModuleChildren:
@@ -216,29 +208,25 @@ Style/ClassVars:
 Style/WhenThen:
   Enabled: false
 
-
 # DISABLED - not useful
 Style/WordArray:
   Enabled: false
 
-Style/UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: false
 
-Layout/Tab:
+Layout/IndentationStyle:
   Enabled: false
 
 Layout/SpaceBeforeSemicolon:
   Enabled: false
 
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: false
 
 Layout/SpaceInsideBlockBraces:
   Enabled: false
 
-Layout/SpaceInsideBrackets:
-  Enabled: false
-
 Layout/SpaceInsideHashLiteralBraces:
   Enabled: false
 
@@ -278,7 +266,6 @@ Layout/SpaceBeforeBlockBraces:
 Layout/SpaceBeforeComma:
   Enabled: false
 
-
 Style/CollectionMethods:
   Enabled: false
 
@@ -294,7 +281,7 @@ Style/CommentAnnotation:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-Style/ConstantName:
+Naming/ConstantName:
   Enabled: false
 
 Style/Documentation:
@@ -319,10 +306,10 @@ Style/EachWithObject:
 Layout/EmptyLineBetweenDefs:
   Enabled: false
 
-Layout/IndentArray:
+Layout/FirstArrayElementIndentation:
   Enabled: false
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   Enabled: false
 
 Layout/IndentationConsistency:
@@ -340,7 +327,7 @@ Layout/EmptyLinesAroundAccessModifier:
 Style/EmptyLiteral:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 
 Style/MethodCallWithoutArgsParentheses:
@@ -358,7 +345,10 @@ Layout/TrailingWhitespace:
 Style/StringLiterals:
   Enabled: false
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
   Enabled: false
 
 Style/TrailingCommaInArguments:
@@ -394,7 +384,6 @@ Style/SingleLineMethods:
 Style/SpecialGlobalVars:
   Enabled: false
 
-
 Style/TrivialAccessors:
   Enabled: false
 
@@ -404,7 +393,7 @@ Style/UnlessElse:
 Style/VariableInterpolation:
   Enabled: false
 
-Style/VariableName:
+Naming/VariableName:
   Enabled: false
 
 Style/WhileUntilDo:
@@ -413,7 +402,7 @@ Style/WhileUntilDo:
 Style/EvenOdd:
   Enabled: false
 
-Style/FileName:
+Naming/FileName:
   Enabled: false
 
 Style/For:
@@ -422,7 +411,7 @@ Style/For:
 Style/Lambda:
   Enabled: false
 
-Style/MethodName:
+Naming/MethodName:
   Enabled: false
 
 Style/MultilineTernaryOperator:
@@ -458,7 +447,7 @@ Style/NumericLiterals:
 Style/OneLineConditional:
   Enabled: false
 
-Style/OpMethod:
+Naming/BinaryOperatorParameterName:
   Enabled: false
 
 Style/ParenthesesAroundCondition:
@@ -470,7 +459,7 @@ Style/PercentLiteralDelimiters:
 Style/PerlBackrefs:
   Enabled: false
 
-Style/PredicateName:
+Naming/PredicateName:
   Enabled: false
 
 Style/RedundantException:
@@ -584,13 +573,10 @@ Layout/EmptyLinesAroundMethodBody:
 Lint/IneffectiveAccessModifier:
   Enabled: false
 
-Performance/StringReplacement:
-  Enabled: false
-
 Layout/ClosingParenthesisIndentation:
   Enabled: false
 
-Style/UnneededInterpolation:
+Style/RedundantInterpolation:
   Enabled: false
 
 Layout/ElseAlignment:
@@ -605,7 +591,7 @@ Layout/FirstParameterIndentation:
 Style/IfInsideElse:
   Enabled: false
 
-Layout/IndentAssignment:
+Layout/AssignmentIndentation:
   Enabled: false
 
 Layout/SpaceAroundBlockParameters:
@@ -614,42 +600,24 @@ Layout/SpaceAroundBlockParameters:
 Style/ParallelAssignment:
   Enabled: false
 
-Performance/RedundantBlockCall:
-  Enabled: false
-
 Style/IdenticalConditionalBranches:
   Enabled: false
 
-Performance/RedundantMatch:
-  Enabled: false
-
 Style/CommandLiteral:
   Enabled: false
 
-Performance/Casecmp:
-  Enabled: false
-
 Lint/NestedMethodDefinition:
   Enabled: false
 
 Layout/SpaceInsideStringInterpolation:
   Enabled: false
 
-Performance/RedundantMerge:
-  Enabled: false
-
-Performance/ReverseEach:
-  Enabled: false
-
 Style/NestedModifier:
   Enabled: false
 
 Lint/NonLocalExitFromIterator:
   Enabled: false
 
-Performance/Count:
-  Enabled: false
-
 Style/NestedParenthesizedCalls:
   Enabled: false
 
@@ -659,19 +627,10 @@ Layout/RescueEnsureAlignment:
 Lint/DuplicateMethods:
   Enabled: false
 
-Performance/RangeInclude:
-  Enabled: false
-
 Style/TrailingUnderscoreVariable:
   Enabled: false
 
-Performance/DoubleStartEndWith:
-  Enabled: false
-
-Performance/RedundantSortBy:
-  Enabled: false
-
-Performance/TimesMap:
+Style/RedundantSortBy:
   Enabled: false
 
 Layout/InitialIndentation:
@@ -691,7 +650,38 @@ Style/ZeroLengthPredicate:
 
 Bundler/OrderedGems:
   Enabled: false
-
   # Enforce LF line endings, even when on Windows
 Layout/EndOfLine:
   EnforcedStyle: lf
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+# Not used becuase too new for support matrix
+Style/NumericPredicate:
+  Enabled: false
+
+# Not used becuase too new for support matrix
+Style/SafeNavigation:
+  Enabled: false
+
+Style/MixinUsage:
+  Enabled: false

data/.travis.yml

@@ -3,22 +3,17 @@ language: ruby
 cache:
   bundler: true
   directories:
-    - 'spec/fixtures/puppet_controlrepo/.onceover' # Onceover cache
+    - "spec/fixtures/puppet_controlrepo/.onceover" # Onceover cache
 
 script: bundle exec rake full_tests
 bundler_args: --path vendor/bundle
 
 matrix:
   include:
-    # 2016.x -> 2017.2
-    - rvm: 2.1.9
-      env: PUPPET_VERSION="~>4.0"
-    
     # 2017.3 -> 2018.1
     - rvm: 2.4.4
       env: PUPPET_VERSION="~>5.0"
-    
+
     # 2019.0 -> now
-    - rvm: 2.5.1
+    - rvm: 2.5.7
       env: PUPPET_VERSION="~>6.0"
-    

data/Gemfile

@@ -9,12 +9,12 @@ if ENV['PUPPET_VERSION']
 end
 
 # Evaluate Gemfile.local if it exists
-if File.exists? "#{__FILE__}.local"
+if File.exist? "#{__FILE__}.local"
   eval(File.read("#{__FILE__}.local"), binding)
 end
 
 # Evaluate ~/.gemfile if it exists
-if File.exists?(File.join(Dir.home, '.gemfile'))
+if File.exist?(File.join(Dir.home, '.gemfile'))
   eval(File.read(File.join(Dir.home, '.gemfile')), binding)
 end
 
@@ -23,3 +23,10 @@ if ENV['APPVEYOR'] == 'True'
   # in order to not have symlinks and therefor work on windows
   gem 'r10k', git: 'https://github.com/puppetlabs/r10k.git'
 end
+
+group :development do
+  gem 'cucumber', '~> 2.0'
+  gem 'pry', '~> 0.10.0'
+  gem 'rubocop', '~> 0.82.0'
+  gem 'rubygems-tasks', '~> 0.2.0'
+end

data/README.md

@@ -2,7 +2,9 @@
 
 *The gateway drug to automated infrastructure testing with Puppet*
 
-Onceover is a tool to automatically run basic tests on an entire Puppet controlrepo. It includes automatic parsing of the `Puppetfile`, `environment.conf` and others in order to run stop silly mistakes ever reaching your Puppet Master!
+Onceover is a tool to automatically run basic tests on an entire Puppet controlrepo. It includes automatic parsing of the `Puppetfile`, `environment.conf` and others in order to stop silly mistakes ever reaching your Puppet Master!
+
+**🍺🥳 New in v3.17.1: Heaps more Windows fixes! Windows code is now more likely to compile on Non-Windows.**
 
 ## Table of Contents
 
@@ -13,6 +15,8 @@ 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)
+      - [r10k Config](#r10k-config)
   - [Spec testing](#spec-testing)
     - [Adding your own spec tests](#adding-your-own-spec-tests)
   - [Using Workarounds](#using-workarounds)
@@ -233,7 +237,7 @@ This gem comes with a few pre-canned factsets. These are listed under the `nodes
 
 `spec/factsets/*.json`
 
-Factsets are used by the controlrepo gem to generate spec tests, which compile a given class against a certain set of facts. To create these factsets all we need to do is log onto a real machine that has puppet installed and run:
+Factsets are used by the onceover gem to generate spec tests, which compile a given class against a certain set of facts. To create these factsets all we need to do is log onto a real machine that has puppet installed and run:
 
 `puppet facts`
 
@@ -272,6 +276,66 @@ 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
+
+Organisations often reference modules from their own git servers in the `Puppetfile`, like this:
+
+```
+mod "puppetlabs-apache",
+  :git => "https://git.megacorp.com/pup/puppetlabs-apache.git",
+  :tag => "v5.4.0"
+```
+
+Under the hood, Onceover uses r10k to download the modules in your `Puppetfile`. If you get errors downloading modules from Git, its because `r10k`'s call to your underlying `git` command has failed. Onceover tells you the command that `r10k` tried to run, so if you get an error like this:
+
+```
+INFO     -> Updating module /Users/dylan/control-repo/.onceover/etc/puppetlabs/code/environments
+/production/modules/apache
+ERROR    -> Command exited with non-zero exit code:
+Command: git --git-dir /Users/dylan/.r10k/git/ssh---git.megacorp.com-pup-puppetlabs_apache.git fetch origin --prune
+Stderr:
+ssh_askpass: exec(/usr/bin/ssh-askpass): No such file or directory
+Host key verification failed.
+
+fatal: Could not read from remote repository.
+
+Please make sure you have the correct access rights
+and the repository exists.
+Exit code: 128
+```
+
+Then the approach to debug it would be to run the command that Onceover suggested:
+
+```
+git --git-dir /Users/dylan/.r10k/git/ssh---git.megacorp.com-pup-puppetlabs_apache.git fetch origin --prune
+```
+
+In this case, running the command interactively gives us a prompt to add the server to our `~/.ssh/known_hosts` file, which fixes the problem permanently:
+
+```
+$ git --git-dir /Users/dylan/.r10k/git/ssh---git.megacorp.com-pup-puppetlabs_apache.git fetch origin --prune
+The authenticity of host 'git.megacorp.com (123.456.789.101)' can't be established.
+...
+Warning: Permanently added 'git.megacorp.com,123.456.789.101' (RSA) to the list of known hosts.
+```
+
+The other way to resolve this would have been to install the `ssh_askpass` program, but this can spam the screen with modal dialogs on some platforms.
+
+#### r10k Config
+
+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.
@@ -636,4 +700,3 @@ Cheers to all of those who helped out:
   - @raphink
   - @tequeter
   - @alexjfisher
-