Merge pull request #5 from puppetlabs/cat-2788-namespace-rename

Rename namespace/CLI hook to PuppetlabsOnceover::CodeQuality (Gate 3) + coupled dependency swaps (CAT-2788, CAT-2789, CAT-2791)

Author: gavindidrichsen

.rubocop_todo.yml

@@ -18,22 +18,22 @@ Gemspec/RequireMFA:
 # This cop supports safe autocorrection (--autocorrect).
 Lint/AmbiguousRegexpLiteral:
   Exclude:
-    - 'spec/onceover/environment_spec.rb'
-    - 'spec/onceover/lint_spec.rb'
-    - 'spec/onceover/puppetfile_spec.rb'
-    - 'spec/onceover/syntax_spec.rb'
+    - 'spec/puppetlabs-onceover/environment_spec.rb'
+    - 'spec/puppetlabs-onceover/lint_spec.rb'
+    - 'spec/puppetlabs-onceover/puppetfile_spec.rb'
+    - 'spec/puppetlabs-onceover/syntax_spec.rb'
 
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
 Lint/UnusedBlockArgument:
   Exclude:
-    - 'lib/onceover/codequality/cli.rb'
+    - 'lib/puppetlabs-onceover/codequality/cli.rb'
 
 # Offense count: 1
 Lint/UselessAssignment:
   Exclude:
-    - 'lib/onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
@@ -64,26 +64,26 @@ Metrics/PerceivedComplexity:
 # Offense count: 1
 Naming/AccessorMethodName:
   Exclude:
-    - 'lib/onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
 
 # Offense count: 1
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
 # SupportedStylesForLeadingUnderscores: disallowed, required, optional
 Naming/MemoizedInstanceVariableName:
   Exclude:
-    - 'lib/onceover/codequality/cli.rb'
+    - 'lib/puppetlabs-onceover/codequality/cli.rb'
 
 # Offense count: 1
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
 # AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
 Naming/MethodParameterName:
   Exclude:
-    - 'lib/onceover/codequality/formatter.rb'
+    - 'lib/puppetlabs-onceover/codequality/formatter.rb'
 
 # Offense count: 1
 Security/Open:
   Exclude:
-    - 'lib/onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
 
 # Offense count: 7
 # This cop supports safe autocorrection (--autocorrect).
@@ -94,39 +94,39 @@ Security/Open:
 # AllowedMethods: lambda, proc, it
 Style/BlockDelimiters:
   Exclude:
-    - 'lib/onceover/codequality/docs.rb'
-    - 'lib/onceover/codequality/environment.rb'
-    - 'lib/onceover/codequality/lint.rb'
+    - 'lib/puppetlabs-onceover/codequality/docs.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/lint.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
 # SupportedStyles: assign_to_condition, assign_inside_condition
 Style/ConditionalAssignment:
   Exclude:
-    - 'lib/onceover/codequality/lint.rb'
+    - 'lib/puppetlabs-onceover/codequality/lint.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 Style/DefWithParentheses:
   Exclude:
-    - 'lib/onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
 
 # Offense count: 9
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
-    - 'lib/onceover/codequality.rb'
-    - 'lib/onceover/codequality/cli.rb'
-    - 'lib/onceover/codequality/docs.rb'
-    - 'lib/onceover/codequality/environment.rb'
-    - 'lib/onceover/codequality/executor.rb'
-    - 'lib/onceover/codequality/formatter.rb'
-    - 'lib/onceover/codequality/lint.rb'
-    - 'lib/onceover/codequality/puppetfile.rb'
-    - 'lib/onceover/codequality/syntax.rb'
+    - 'lib/puppetlabs-onceover/codequality.rb'
+    - 'lib/puppetlabs-onceover/codequality/cli.rb'
+    - 'lib/puppetlabs-onceover/codequality/docs.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/executor.rb'
+    - 'lib/puppetlabs-onceover/codequality/formatter.rb'
+    - 'lib/puppetlabs-onceover/codequality/lint.rb'
+    - 'lib/puppetlabs-onceover/codequality/puppetfile.rb'
+    - 'lib/puppetlabs-onceover/codequality/syntax.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
@@ -151,16 +151,16 @@ Style/FrozenStringLiteralComment:
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Exclude:
-    - 'spec/onceover/lint_spec.rb'
-    - 'spec/onceover/puppetfile_spec.rb'
-    - 'spec/onceover/syntax_spec.rb'
+    - 'spec/puppetlabs-onceover/lint_spec.rb'
+    - 'spec/puppetlabs-onceover/puppetfile_spec.rb'
+    - 'spec/puppetlabs-onceover/syntax_spec.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
 Style/GuardClause:
   Exclude:
-    - 'lib/onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
 
 # Offense count: 11
 # This cop supports safe autocorrection (--autocorrect).
@@ -170,67 +170,67 @@ Style/GuardClause:
 Style/HashSyntax:
   Exclude:
     - 'Rakefile'
-    - 'lib/onceover/codequality/cli.rb'
-    - 'lib/onceover/codequality/syntax.rb'
+    - 'lib/puppetlabs-onceover/codequality/cli.rb'
+    - 'lib/puppetlabs-onceover/codequality/syntax.rb'
     - 'spec/testcase/bad_puppetfile/Puppetfile'
     - 'spec/testcase/good_puppetfile/Puppetfile'
 
 # Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 Style/IfUnlessModifier:
   Exclude:
-    - 'lib/onceover/codequality/cli.rb'
+    - 'lib/puppetlabs-onceover/codequality/cli.rb'
 
 # Offense count: 6
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Style/MethodCallWithoutArgsParentheses:
   Exclude:
-    - 'spec/onceover/environment_spec.rb'
+    - 'spec/puppetlabs-onceover/environment_spec.rb'
 
 # Offense count: 1
 Style/MultilineBlockChain:
   Exclude:
-    - 'lib/onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
 
 # Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: literals, strict
 Style/MutableConstant:
   Exclude:
-    - 'lib/onceover/codequality/environment.rb'
-    - 'lib/onceover/codequality/lint.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/lint.rb'
 
 # Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: both, prefix, postfix
 Style/NegatedIf:
   Exclude:
-    - 'lib/onceover/codequality/cli.rb'
+    - 'lib/puppetlabs-onceover/codequality/cli.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 Style/NegatedIfElseCondition:
   Exclude:
-    - 'lib/onceover/codequality/lint.rb'
+    - 'lib/puppetlabs-onceover/codequality/lint.rb'
 
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, MinBodyLength.
 # SupportedStyles: skip_modifier_ifs, always
 Style/Next:
   Exclude:
-    - 'lib/onceover/codequality/docs.rb'
-    - 'lib/onceover/codequality/lint.rb'
+    - 'lib/puppetlabs-onceover/codequality/docs.rb'
+    - 'lib/puppetlabs-onceover/codequality/lint.rb'
 
 # Offense count: 1
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?
 Style/OptionalBooleanParameter:
   Exclude:
-    - 'lib/onceover/codequality/formatter.rb'
+    - 'lib/puppetlabs-onceover/codequality/formatter.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
@@ -250,15 +250,15 @@ Style/RedundantPercentQ:
 # Configuration parameters: AllowMultipleReturnValues.
 Style/RedundantReturn:
   Exclude:
-    - 'lib/onceover/codequality/executor.rb'
+    - 'lib/puppetlabs-onceover/codequality/executor.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, AllowInnerSlashes.
 # SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
   Exclude:
-    - 'lib/onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
 
 # Offense count: 119
 # This cop supports safe autocorrection (--autocorrect).
@@ -273,12 +273,12 @@ Style/StringLiterals:
 # AllowedMethods: define_method
 Style/SymbolProc:
   Exclude:
-    - 'lib/onceover/codequality/environment.rb'
+    - 'lib/puppetlabs-onceover/codequality/environment.rb'
 
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleForMultiline.
 # SupportedStylesForMultiline: comma, consistent_comma, no_comma
 Style/TrailingCommaInArrayLiteral:
   Exclude:
-    - 'lib/onceover/codequality/lint.rb'
+    - 'lib/puppetlabs-onceover/codequality/lint.rb'

Gemfile

@@ -1,10 +1,29 @@
-source "https://rubygems.org"
+# For puppetcore, set GEM_SOURCE_PUPPETCORE = 'https://rubygems-puppetcore.puppet.com'
+gemsource_default = ENV['GEM_SOURCE'] || 'https://rubygems.org'
+gemsource_puppetcore = if ENV['GEM_SOURCE']
+                         gemsource_default
+                       elsif ENV['PUPPET_FORGE_TOKEN']
+                         'https://rubygems-puppetcore.puppet.com'
+                       else
+                         ENV['GEM_SOURCE_PUPPETCORE'] || gemsource_default
+                       end
+source gemsource_default
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in onceover-helloworld.gemspec
 gemspec
 
+# Route through gemsource_puppetcore so CI can resolve puppet ~> 9.0 from the
+# private Puppetcore registry (public rubygems.org tops out at puppet 8.10.0).
+# When PUPPET_FORGE_TOKEN is unset (e.g. fork PRs, local dev without a token),
+# gemsource_puppetcore falls through to gemsource_default (public rubygems.org)
+# and no auth is attempted against Puppetcore. Without this, bundler was free
+# to resolve the lowest puppet version satisfying all constraints (8.10.0),
+# which doesn't even boot on Ruby 3.4 ("Cannot determine basic system
+# flavour") -- and CI's per-matrix-job PUPPET_GEM_VERSION env var had nothing
+# in the Gemfile to actually consume it.
+gem 'puppet', ENV['PUPPET_GEM_VERSION'] || '~> 8', source: gemsource_puppetcore
+
 # Windows platform runtime deps. The published puppet/onceover rubygems.org
 # artefacts are built on Linux and guard `ffi` / `win32ole` with build-host
 # platform checks, so those deps never make it into the Linux-published
@@ -17,6 +36,10 @@ platforms :mingw, :x64_mingw, :mswin do
   gem 'win32ole', '>= 1.8', '< 2.0'
 end
 
+group :development do
+  gem 'rubocop'
+end
+
 group :release, optional: true do
   gem 'faraday-retry', require: false
   gem 'github_changelog_generator', require: false

README.md

@@ -1,6 +1,6 @@
-# Onceover::CodeQuality
+# PuppetlabsOnceover::CodeQuality
 
-This is the Code Quality plugin for [Onceover](https://github.com/voxpupuli/onceover), _The gateway drug to automated infrastructure testing with Puppet_
+This is the Code Quality plugin for [puppetlabs-onceover](https://github.com/puppetlabs/puppetlabs-onceover), _The gateway drug to automated infrastructure testing with Puppet_
 
 ## What does it do?
 
@@ -15,61 +15,61 @@ For sure you can hack around with rake/make and hack something up each time but
 
 ## Installation
 
-Install the `onceover-codequality` gem by adding it to your `Gemfile` or by running the following command:
+Install the `puppetlabs-onceover-codequality` gem by adding it to your `Gemfile` or by running the following command:
 
 ```shell
-gem install onceover-codequality
+gem install puppetlabs-onceover-codequality
 ```
 
 ## Usage
 
-Installing the codequality gem creates a new item within onceover's `run` command: `codequality`.  See `onceover run codequality --help` for all available options.
+Installing the codequality gem creates a new item within puppetlabs-onceover's `run` command: `codequality`.  See `puppetlabs-onceover run codequality --help` for all available options.
 
 The command will return `1` to the system if any tests fail, otherwise `0`, which makes it perfect to include in build pipelines.
 
 ### Check all code in the control repository for Lint and Syntax errors
 
 ```shell
-onceover run codequality
+puppetlabs-onceover run codequality
 ```
 
 ### Skip Lint check
 
 ```shell
-onceover run codequality --no_lint
+puppetlabs-onceover run codequality --no_lint
 ```
 
 ### Skip Puppet syntax check
 
 ```shell
-onceover run codequality --no_syntax
+puppetlabs-onceover run codequality --no_syntax
 ```
 
 ### Skip Puppetfile syntax check
 
 ```shell
-onceover run codequality --no_puppetfile
+puppetlabs-onceover run codequality --no_puppetfile
 ```
 
 ### Skip documentation generation
 
 ```shell
-onceover run codequality --no_docs
+puppetlabs-onceover run codequality --no_docs
 ```
 
 ### Use custom lint setting
 
-Create a file `puppet-lint.rc` in the directory you run `onceover codequality`
+Create a file `puppet-lint.rc` in the directory you run `puppetlabs-onceover codequality`
 from and it will be automatically used by Puppet Lint. If missing, the built-in
-defaults from `lib/onceover/codequality/lint.rb` will be used.
+defaults from `lib/puppetlabs-onceover/codequality/lint.rb` will be used.
 
 
 ## Sample output
 
 ### All clear
 
 ```shell
-$ onceover run codequality
+$ puppetlabs-onceover run codequality
 INFO   -> Checking for lint...
 INFO   -> checking manifests
 INFO   -> checking site/role
@@ -83,7 +83,7 @@ INFO   -> Code Quality tests passed, have a nice day
 ### Lint and syntax errors
 
 ```shell
-$ onceover run codequality
+$ puppetlabs-onceover run codequality
 INFO   -> Checking for lint...
 INFO   -> checking manifests
 INFO   -> checking site/role
@@ -104,7 +104,7 @@ $ echo $?
 
 **`WARN: Unresolved specs during Gem::Specification.reset`?**
 
-I get these errors when I run `onceover run codequality` but everything seems to work, what gives?:
+I get these errors when I run `puppetlabs-onceover run codequality` but everything seems to work, what gives?:
 
 ```shell
 WARN: Unresolved specs during Gem::Specification.reset:
@@ -118,7 +118,7 @@ Please report a bug if this causes problems.
 Beats me - something to do with rubygems.  The best way to beat this message is to use [bundler](https://github.com/bundler/bundler) which basically you should already be doing anyway (for your own sanity):
 
 ```shell
-bundle exec onceover run codequality
+bundle exec puppetlabs-onceover run codequality
 ```
 
 **What are you using under-the-hood?**