voxpupuli-test 13.1.0 → 14.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 133fa00b9b889741f61d7d19539038e268ad7e61a66d2e27b51c6b5d620cdfa0
-  data.tar.gz: 35f237f3fb512ebf63fdfc6823dec401665e302c5ffc54016764e28848be3455
+  metadata.gz: 2dcdc2312c0db968dcddca73a0eaf60ad5539c0379b2b2eefb002be318d0cb30
+  data.tar.gz: beb9801b4df1e885457200039cc349e57051daa338a650017c34fb749e8bc2e0
 SHA512:
-  metadata.gz: 3df2fa1d334cff98325c0d78051050b8c292d850579bb25ed518df96ee01e47d2b8f8d99e1ee23f9918430659063fc7901cf3cc192c21ca696a24aa87b505d22
-  data.tar.gz: b1d39e2e4c0777b3be6175124317cc2ca5149eb2f51dd7c2aa116c65344ffafe977cf33a82225f0eed6cb1f577abb6649ecd1a4ac245ed46ba83ce8d24f3a415
+  metadata.gz: '029d81551fb4428b08a9d0c82e17a04b95e14770e34fc1893a245a2cb7f77f2dd7497cada13203d172ad09fd2dbaf7538b9e701c40c08804ec408e07c989f45f'
+  data.tar.gz: 59542f5c3ea5340aeb0202591aed64738672a5e72d5052320054b1e01ce8a1df790f3386e1f3f287c887dbf2e283d5d39ae605f47b0ce79d6be738dd343f85c9

data/README.md

@@ -84,6 +84,29 @@ It has an exclude pattern for: `%r{^((modules|acceptance|\.?vendor|spec/fixtures
 We recommend using the GitHub style guide for markdown files, which includes no trailing whitespace.
 See [GitHub Markdown Style Guide](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
 
+### `check:misplaced_files`
+
+The rake task `check:misplaced_files` checks for misplaced files in the repository.
+
+Files are considered misplaced if they don't belong in the directory tree they are under.
+I.e. `functions/`, `manifests/`, and `types/` may only contain `.pp` files, `templates/` may only contain `.erb` and `.epp`, `data/` may only contain `.yml` and `.yaml`, and `lib/` may only contain `.rb`.
+
+### `check:utf8`
+
+The rake task `check:utf8` checks that all files that will be parsed by Puppet are encoded in valid UTF-8 without a BOM.
+
+The task validates all files under `data/`, `functions/`, `lib/`, `manifests/`, `templates/`, and `types/`.
+
+## Environment variables
+
+### `CODECLIMATE_REPORT_FILE`
+
+Setting `CODECLIMATE_REPORT_FILE` to a file path will configure tasks that support it to output CodeClimate-style JSON reports into the given file.
+
+The tasks that currently support this feature include `lint` and `rubocop`.
+
+Note that if multiple tasks all attempt to output CodeClimate reports in a single rake call, then only the final task will be able store its report.
+
 ## Fact handling
 
 The recommended method is using [rspec-puppet-facts](https://github.com/mcanevet/rspec-puppet-facts) and is set up by default. This means the tests are writting as follows:

data/lib/voxpupuli/test/rake/check.rb

@@ -49,6 +49,50 @@ namespace :check do
       exit 1
     end
   end
+
+  desc 'Check that no misplaced files exist in module code/data'
+  task :misplaced_files do
+    misplaced = []
+    misplaced += Dir['data/**/*'].reject { |fn| !File.file?(fn) || fn.end_with?('.yaml') || fn.end_with?('.yml') }
+    misplaced += Dir['lib/**/*'].reject { |fn| !File.file?(fn) || fn.end_with?('.rb') }
+    misplaced += Dir['{functions,manifests,types}/**/*'].reject { |fn| !File.file?(fn) || fn.end_with?('.pp') }
+    misplaced += Dir['templates/**/*'].reject { |fn| !File.file?(fn) || fn.end_with?('.epp') || fn.end_with?('.erb') }
+
+    if misplaced.any?
+      misplaced.each { |filename| puts "#{filename} is misplaced" }
+      exit 1
+    end
+  end
+
+  desc 'Check that all module code and data are valid UTF-8 without BOM'
+  task :utf8 do
+    errors = []
+
+    Dir['{data,functions,lib,manifests,templates,types}/**/*'].each do |filename|
+      next unless File.file? filename
+
+      File.open(filename, 'r:utf-8') do |file|
+        data = file.readline
+
+        if !data.valid_encoding?
+          errors << "#{filename} can't be parsed as UTF-8"
+        elsif data.bytes[0..2] == [0xef, 0xbb, 0xbf]
+          errors << "#{filename} contains BOM"
+        elsif data.include? "\x00" # UTF-16 without BOM is technically valid UTF-8, but contains null-bytes
+          errors << "#{filename} contains null bytes"
+        elsif !file.eof?
+          redo
+        end
+      end
+    rescue StandardError => e
+      errors << "#{filename} failed to parse, #{e.class}: #{e}"
+    end
+
+    if errors.any?
+      errors.each { |error| puts error }
+      exit 1
+    end
+  end
 end
 
 desc 'Run static pre release checks'

data/lib/voxpupuli/test/rake/rubocop.rb

@@ -9,4 +9,13 @@ RuboCop::RakeTask.new(:rubocop) do |task|
   if ENV['GITHUB_ACTIONS'] == 'true'
     task.formatters << 'github'
   end
+
+  if ENV['CODECLIMATE_REPORT_FILE']
+    # Ensure the default rubocop formatter still runs even when producing codeclimate report
+    require 'rubocop'
+    task.formatters << (RuboCop::ConfigStore.new.for_pwd.for_all_cops['DefaultFormatter'] || 'progress') if task.formatters.empty?
+
+    task.requires << File.join(__dir__, '../rubocop_formatters/codeclimate.rb')
+    task.options += ['--format', 'CodeclimateFormatter', '--out', ENV['CODECLIMATE_REPORT_FILE']]
+  end
 end

data/lib/voxpupuli/test/rubocop_formatters/codeclimate.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+# Simple codeclimate-style JSON formatter for RuboCop
+class CodeclimateFormatter < RuboCop::Formatter::BaseFormatter
+  include RuboCop::PathUtil
+
+  SEVERITY_MAP = {
+    info: 'info',
+    refactor: 'minor',
+    convention: 'minor',
+    warning: 'major',
+    error: 'critical',
+    fatal: 'blocker',
+  }.freeze
+
+  attr_reader :output_array
+
+  def initialize(output, options = {})
+    super
+    @output_array = []
+  end
+
+  def file_finished(file, offenses)
+    @output_array += hashes_for_file(file, offenses)
+  end
+
+  def finished(_inspected_files)
+    output.write output_array.to_json
+  end
+
+  private
+
+  def hashes_for_file(file, offenses)
+    offenses.map do |offense|
+      category, name = offense.cop_name.split('/')
+      name, category = category, name if name.nil?
+
+      message = offense.message.dup
+      message.delete_prefix! offense.cop_name
+      message.delete_prefix! ':'
+      message.strip!
+
+      hash = {
+        type: :issue,
+        check_name: name,
+        description: message,
+        categories: [category || 'General'],
+        location: hash_for_location(file, offense),
+        severity: SEVERITY_MAP[offense.severity.name],
+      }
+      hash[:fingerprint] = Digest::SHA2.hexdigest([file, offense.cop_name, offense.line, offense.column].to_json)
+      hash
+    end
+  end
+
+  def hash_for_location(file, offense)
+    {
+      path: smart_path(file),
+      positions: {
+        begin: {
+          line: offense.line,
+          column: offense.real_column,
+        },
+        end: {
+          line: offense.last_line,
+          column: offense.last_column.zero? ? 1 : offense.last_column,
+        },
+      },
+    }
+  end
+end

data/rubocop.yml

@@ -1,6 +1,6 @@
 # This is a shared config for easy consumption in other modules, without having
 # to sync over a large file
-require:
+plugins:
   - rubocop-rspec
   - rubocop-rake
 
@@ -280,7 +280,7 @@ Style/PreferredHashMethods:
   Enabled: True
 
 Layout/DotPosition:
-  EnforcedStyle: trailing
+  EnforcedStyle: leading
 
 Style/DoubleNegation:
   Enabled: True
@@ -333,12 +333,14 @@ Style/StringLiterals:
 
 Style/TrailingCommaInArguments:
   Enabled: True
+  EnforcedStyleForMultiline: comma
 
 Style/TrailingCommaInArrayLiteral:
-  Enabled: False
+  Enabled: True
+  EnforcedStyleForMultiline: consistent_comma
 
 Style/TrailingCommaInHashLiteral:
-  Enabled: False
+  EnforcedStyleForMultiline: consistent_comma
 
 Style/GlobalVars:
   Enabled: True
@@ -445,10 +447,13 @@ Style/PercentLiteralDelimiters:
 Style/PerlBackrefs:
   Enabled: True
 
-Naming/PredicateName:
+Naming/PredicatePrefix:
   Enabled: True
   AllowedMethods: ['is_a?', 'is_to_s']
 
+Naming/PredicateMethod:
+  Enabled: false
+
 Style/RedundantException:
   Enabled: True
 
@@ -496,6 +501,9 @@ Style/Encoding:
 Style/BlockDelimiters:
   Enabled: True
 
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
 Layout/MultilineBlockLayout:
   Enabled: True
 
@@ -557,9 +565,13 @@ Style/FormatStringToken:
 
 # This is useful, but sometimes a little too picky about where unit tests files
 # are located.
-RSpec/FilePath:
+# old cop: RSpec/FilePath
+RSpec/SpecFilePathFormat:
   Enabled: false
 
+RSpec/SpecFilePathSuffix:
+  Enabled: true
+
 # Leaving these enabled creates too much busy work
 RSpec/ContextWording:
   Enabled: false
@@ -662,8 +674,6 @@ RSpec/IdenticalEqualityAssertion: # new in 2.4
   Enabled: true
 RSpec/SubjectDeclaration: # new in 2.5
   Enabled: true
-RSpec/Rails/AvoidSetupHook: # new in 2.4
-  Enabled: true
 RSpec/ImplicitSubject:
   Enabled: false
 # new configurations since rubocop 1.50.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voxpupuli-test
 version: !ruby/object:Gem::Version
-  version: 13.1.0
+  version: 14.0.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -78,7 +78,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -88,7 +88,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
@@ -207,58 +207,64 @@ dependencies:
   name: syslog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.0
+        version: 1.85.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.0
+        version: 1.85.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 3.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: voxpupuli-puppet-lint-plugins
   requirement: !ruby/object:Gem::Requirement
@@ -311,9 +317,10 @@ files:
 - lib/voxpupuli/test/rake/rubocop.rb
 - lib/voxpupuli/test/rake/spec.rb
 - lib/voxpupuli/test/rake/validate.rb
+- lib/voxpupuli/test/rubocop_formatters/codeclimate.rb
 - lib/voxpupuli/test/spec_helper.rb
 - rubocop.yml
-homepage: http://github.com/voxpupuli/voxpupuli-test
+homepage: https://github.com/voxpupuli/voxpupuli-test
 licenses:
 - Apache-2.0
 metadata: {}
@@ -331,7 +338,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Helpers for testing Vox Pupuli modules
 test_files: []