voxpupuli-test 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346b627b7545574730d917660e968df59460018ce2334d2301be061d1b1aabca
-  data.tar.gz: 7cd65cb60f03e97283bd7ed532b4255720df4f74ab0294309c2667707d35a94a
+  metadata.gz: 2f069b7c77b1b12a06412e4e12c2ecada41007a174301a6af4d96e556018709c
+  data.tar.gz: e92c583e9d321d6de5fd99d6ab7d5491b0399a0b8dddeb800c48e6bcc1c9ff29
 SHA512:
-  metadata.gz: 343acd06af0a11767fda3ddce8a4fd247545b2f04b1c85a6238c9c4d135ebe9f1079174abc135a9f33c2345fa9036fec831fbe58a4a971489322e5eec23c808e
-  data.tar.gz: ed0d6b115b358c3d5a8b8ef6596428e633b7ae971d2fba7dd5f621787293c92adc1d9781f7c0f654d27bcf38399b0a3cb0b28da80a674e152e96b078d5c56349
+  metadata.gz: d9e326670942388f36b61164dc06dd83328d2fd1fe8a1f9d4db084a081e1c341b125658bbbf83d9ac2fc22263917333b6c2aa10bd87c4daa66f09eedae05ae0a
+  data.tar.gz: c1557d2bf6d4df55cccbee2d75c647fb1328fb919b3dbf504d514419979c89987eaf351a643920d4b1d84d02b9fbf3b5b691d6c329b81c33d5855646d28a3f22

data/README.md

@@ -9,7 +9,8 @@
 
 This is a helper Gem to test the various Vox Pupuli Puppet modules. This Gem provides common functionality for rspec-puppet based testing. The aim is to reduce the boiler plate and need for modulesync.
 
-# Usage
+## Usage
+
 Add the `voxpupuli-test` Gem to your `Gemfile`:
 
 ```ruby
@@ -35,7 +36,17 @@ inherit_gem:
   voxpupuli-test: rubocop.yml
 ```
 
-# Fact handling
+## Rake tasks
+
+### `check:trailing_whitespace`
+
+The rake task `check:trailing_whitespace` checks for trailing whitespace in all markdown files in the repository.
+It has an exclude pattern for: `%r{^((modules|acceptance|\.?vendor|spec/fixtures|pkg)/|REFERENCE.md)}`
+
+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)
+
+## 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/facts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec-puppet-facts'
 include RspecPuppetFacts
 
@@ -51,7 +53,11 @@ def add_facts_for_metadata(metadata)
   metadata['dependencies'].each do |dependency|
     case normalize_module_name(dependency['name'])
     when 'camptocamp/systemd', 'puppet/systemd'
-      add_custom_fact :systemd, ->(_os, facts) { facts[:service_provider] == 'systemd' }
+      if RSpec.configuration.facterdb_string_keys
+        add_custom_fact 'systemd', ->(_os, facts) { facts['service_provider'] == 'systemd' }
+      else
+        add_custom_fact :systemd, ->(_os, facts) { facts[:service_provider] == 'systemd' }
+      end
     when 'puppetlabs/stdlib'
       add_stdlib_facts
     end
@@ -60,39 +66,43 @@ end
 
 def normalize_module_name(name)
   return unless name
+
   name.sub('-', '/')
 end
 
 def add_stdlib_facts
-  add_custom_fact :puppet_environmentpath, '/etc/puppetlabs/code/environments'
-  add_custom_fact :puppet_vardir, '/opt/puppetlabs/puppet/cache'
-  add_custom_fact :root_home, '/root'
+  if RSpec.configuration.facterdb_string_keys
+    add_custom_fact 'puppet_environmentpath', '/etc/puppetlabs/code/environments'
+    add_custom_fact 'puppet_vardir', '/opt/puppetlabs/puppet/cache'
+    add_custom_fact 'root_home', '/root'
+  else
+    add_custom_fact :puppet_environmentpath, '/etc/puppetlabs/code/environments'
+    add_custom_fact :puppet_vardir, '/opt/puppetlabs/puppet/cache'
+    add_custom_fact :root_home, '/root'
+  end
 
   # Rough conversion of grepping in the puppet source:
   # grep defaultfor lib/puppet/provider/service/*.rb
-  add_custom_fact :service_provider, ->(_os, facts) do
+  service_provider = RSpec.configuration.facterdb_string_keys ? 'service_provider' : :service_provider
+  add_custom_fact service_provider, lambda { |_os, facts|
     os = RSpec.configuration.facterdb_string_keys ? facts['os'] : facts[:os]
     case os['family'].downcase
-    when 'archlinux'
+    when 'archlinux', 'debian', 'redhat'
       'systemd'
     when 'darwin'
       'launchd'
-    when 'debian'
-      'systemd'
     when 'freebsd'
       'freebsd'
     when 'gentoo'
       'openrc'
     when 'openbsd'
       'openbsd'
-    when 'redhat'
-      'systemd'
     when 'suse'
-      os['release']['major'].to_i >= 12 ? 'systemd' : 'redhat'
+      (os['release']['major'].to_i >= 12) ? 'systemd' : 'redhat'
     when 'windows'
       'windows'
     else
       'init'
     end
-  end
+  }
 end

data/lib/voxpupuli/test/rake.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'puppetlabs_spec_helper/rake_tasks'
 
-PuppetLint.configuration.log_format = '%{path}:%{line}:%{check}:%{KIND}:%{message}'
+PuppetLint.configuration.log_format = '%<path>s:%<line>s:%<check>s:%<KIND>s:%<message>s'
 # without this, puppet-lint always gives an exit code of 0
 PuppetLint.configuration.fail_on_warnings = true
 
@@ -12,15 +14,23 @@ task default: [:release_checks]
 namespace :check do
   desc 'Check for trailing whitespace'
   task :trailing_whitespace do
+    errors = []
+
     Dir.glob('**/*.md', File::FNM_DOTMATCH).sort.each do |filename|
       next if filename =~ %r{^((modules|acceptance|\.?vendor|spec/fixtures|pkg)/|REFERENCE.md)}
+
       File.foreach(filename).each_with_index do |line, index|
-        if line =~ %r{\s\n$}
-          puts "#{filename} has trailing whitespace on line #{index + 1}"
-          exit 1
+        if line =~ /\s\n$/
+          errors << "#{filename} has trailing whitespace on line #{index + 1}"
         end
       end
     end
+
+    if errors.any?
+      errors.each { |error| puts error }
+      exit 1
+    end
   end
 end
+
 Rake::Task[:check].enhance ['check:trailing_whitespace']

data/lib/voxpupuli/test/spec_helper.rb

@@ -1,11 +1,4 @@
-RSpec.configure do |config|
-  # puppetlabs_spec_helper defaults to mocha but emits a deprecation warning
-  # Vox Pupuli prefers rspec to avoid the deprecation warning unless explicitly
-  # set
-  if config.instance_variable_get(:@mock_framework).nil?
-    config.mock_with :rspec
-  end
-end
+# frozen_string_literal: true
 
 require 'voxpupuli/test/facts'
 require 'puppetlabs_spec_helper/module_spec_helper'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voxpupuli-test
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: metadata-json-lint
   requirement: !ruby/object:Gem::Requirement
@@ -120,14 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec-puppet-utils
   requirement: !ruby/object:Gem::Requirement
@@ -157,33 +157,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.50.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 2.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 2.20.0
 - !ruby/object:Gem::Dependency
   name: voxpupuli-puppet-lint-plugins
   requirement: !ruby/object:Gem::Requirement
@@ -222,7 +222,6 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/voxpupuli/test.rb
 - lib/voxpupuli/test/facts.rb
 - lib/voxpupuli/test/rake.rb
 - lib/voxpupuli/test/spec_helper.rb