voxpupuli-test 13.0.0 → 13.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 690ead9092069cf8aa0bb374a801ee321b72b835f867a52dfe1858fdb3d52390
-  data.tar.gz: 35f237f3fb512ebf63fdfc6823dec401665e302c5ffc54016764e28848be3455
+  metadata.gz: faeae0f342ac61d23fe3ce32cf98619b893412832ac3092a02d3f02b09a4a0dd
+  data.tar.gz: d269e93057980c6f8de427184af40f2b644553fc671126951b48b860d65696f7
 SHA512:
-  metadata.gz: be6ed41f5d3c8c4e533acb0b5d22f738e23aa5f9567ae58c6575546355f7b2d26381aa2c7cea65f1d08c0a060c13596de823f4ecbf5b28006b795f3f8a2b4d50
-  data.tar.gz: b1d39e2e4c0777b3be6175124317cc2ca5149eb2f51dd7c2aa116c65344ffafe977cf33a82225f0eed6cb1f577abb6649ecd1a4ac245ed46ba83ce8d24f3a415
+  metadata.gz: aa94ef8506d9acdff6039fc6bc0106a094fea9b3508bd62089bd66b3463273597fb8057526fc747bf3d0522e0fb22ba1e10c666f560ac5fed8f2c17532bf4fb2
+  data.tar.gz: 4bf3580b0456dbb59b98a8cb7c0ecf7154efe83b13ac725bbf44a7c88efd06603ae0d1382536db6a52cd92e4aae4add7cd05354fd3c1fdde875621b8be73e726

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voxpupuli-test
 version: !ruby/object:Gem::Version
-  version: 13.0.0
+  version: 13.2.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -118,7 +118,7 @@ dependencies:
         version: '0.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -128,7 +128,7 @@ dependencies:
         version: '0.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: puppet-syntax
   requirement: !ruby/object:Gem::Requirement
@@ -311,6 +311,7 @@ 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