voxpupuli-test 9.2.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71c6e08123426c8d07b50efe5c35be89b9f1416177be3bec4ae4609ec0d30b32
-  data.tar.gz: f9c3b2f225a0702629f16ad8e8e9b5e54e9d83ac347cb6c79e7c0c07a9870268
+  metadata.gz: 02002dd2ba7b57301e64676e32c5572bee0f89f46a3d7c27b76905b02453dad6
+  data.tar.gz: 62cec2d5d5612c861d3201a85105c787ec4f6420343501650677c9a663be76f3
 SHA512:
-  metadata.gz: 7c0797dc532f84a4889d5f281f34247ea471d32315930e4c517dbf33538d0963c2d424f3e2e07ebc591dd5f4dbd34f7180982756fb779c6b75d48de050c926a5
-  data.tar.gz: 7ff8d8b75a3e8b76b512436d36639c87042553c0da85acf70da1cedc109daf12202cc339fd7f7e3e91b3be1448988caaed57c53238c551a53a8ab3c4c382e8f5
+  metadata.gz: f3c49ce2f32bbb670b926a621c575c1a3a3929fcdeff7cd02261ad0865b9e169042d5dc44c12bd486831ba6ae8e5cf6a019152d1fdccaadb02efa4f8bb5a5e2b
+  data.tar.gz: 71374a7b1c7ff4e99dc6f397eac88aa166ec29f3e035d5e998c92c003b74b242095f3240464a917aa3f20b811cc1eec2640de531587df527602c453e530c9e35

data/README.md

@@ -2,7 +2,6 @@
 
 [![License](https://img.shields.io/github/license/voxpupuli/voxpupuli-test.svg)](https://github.com/voxpupuli/voxpupuli-test/blob/master/LICENSE)
 [![Test](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/test.yml)
-[![codecov](https://codecov.io/gh/voxpupuli/voxpupuli-test/branch/master/graph/badge.svg?token=Mypkl78hvK)](https://codecov.io/gh/voxpupuli/voxpupuli-test)
 [![Release](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/voxpupuli-test/actions/workflows/release.yml)
 [![RubyGem Version](https://img.shields.io/gem/v/voxpupuli-test.svg)](https://rubygems.org/gems/voxpupuli-test)
 [![RubyGem Downloads](https://img.shields.io/gem/dt/voxpupuli-test.svg)](https://rubygems.org/gems/voxpupuli-test)

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+namespace :check do
+  desc 'Fails if .pp files present in tests folder'
+  task :test_file do
+    ppfiles = Dir[File.join('tests', '**', '*.pp')]
+    unless ppfiles.empty?
+      puts ppfiles
+      raise '.pp files present in tests folder; Move them to an examples folder following the new convention'
+    end
+  end
+
+  desc 'Fails if any ._ files are present in directory'
+  task :dot_underscore do
+    dirs = Dir['._*']
+    unless dirs.empty?
+      puts dirs
+      raise '._ files are present in the directory'
+    end
+  end
+
+  desc 'Fails if directories contain the files specified in .gitignore'
+  task :git_ignore do
+    matched = `git ls-files --ignored --exclude-standard --cached`
+    raise 'git ls-files failed' unless $CHILD_STATUS.success?
+
+    unless matched == ''
+      puts matched
+      raise 'File specified in .gitignore has been committed'
+    end
+  end
+
+  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 =~ /\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
+
+desc 'Run static pre release checks'
+task check: ['check:test_file', 'check:dot_underscore', 'check:git_ignore', 'check:trailing_whitespace']

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'puppet-lint/tasks/puppet-lint'
+# Must clear as it will not override the existing puppet-lint rake task since we require to import for
+# the PuppetLint::RakeTask
+Rake::Task[:lint].clear
+# without this, puppet-lint always gives an exit code of 0
+PuppetLint.configuration.fail_on_warnings = true
+# Utilize PuppetLint global configuration so that these settings can be tweaked by
+# spec_helper.rb in an individual module
+PuppetLint.configuration.relative = true
+PuppetLint.configuration.ignore_paths << '.vendor/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'bundle/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'pkg/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'spec/**/*.pp'
+PuppetLint.configuration.ignore_paths << 'tests/**/*.pp'
+PuppetLint.configuration.disable_140chars
+PuppetLint.configuration.disable_documentation
+PuppetLint.configuration.disable_single_quote_string_with_variables
+PuppetLint::RakeTask.new(:lint)
+
+desc 'Run puppet-lint and fix issues automatically'
+PuppetLint::RakeTask.new(:lint_fix) do |config|
+  config.fix = true
+end
+
+PuppetLint.configuration.log_format = '%<path>s:%<line>s:%<check>s:%<KIND>s:%<message>s'

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'puppet-syntax/tasks/puppet-syntax'

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  # These make the rubocop experience maybe slightly less terrible
+  task.options = ['--debug', '--display-style-guide', '--extra-details']
+
+  # Use Rubocop's Github Actions formatter if possible
+  if ENV['GITHUB_ACTIONS'] == 'true'
+    task.formatters << 'github'
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'puppet_fixtures/tasks'
+require 'parallel_tests'
+require 'rspec/core/rake_task'
+
+pattern = 'spec/{aliases,classes,defines,functions,hosts,integration,plans,tasks,type_aliases,types,unit}/**/*_spec.rb'
+
+desc 'Run spec tests and clean the fixtures directory if successful'
+task spec: :'fixtures:prep' do |_t, args|
+  Rake::Task['spec:standalone'].invoke(*args.extras)
+  Rake::Task['fixtures:clean'].invoke
+end
+
+desc 'Run spec tests in parallel and clean the fixtures directory if successful'
+task parallel_spec: :'fixtures:prep' do |_t, args|
+  Rake::Task['parallel_spec:standalone'].invoke(*args.extras)
+  Rake::Task['fixtures:clean'].invoke
+end
+
+desc 'Parallel spec tests'
+task 'parallel_spec:standalone' do |_t, args|
+  file_list = Rake::FileList[pattern].to_a
+  if file_list.empty?
+    warn 'No files for parallel_spec to run against'
+  else
+    ci_opts = ENV['CI_SPEC_OPTIONS'].to_s.strip.split
+    args = ['--type', 'rspec', '--', '--format', 'progress'] + ci_opts + ['--'] + file_list
+
+    ParallelTests::CLI.new.run(args)
+  end
+end
+
+RSpec::Core::RakeTask.new('spec:standalone') do |t, _args|
+  t.rspec_opts = []
+  unless ENV['CI_SPEC_OPTIONS'].nil?
+    t.rspec_opts << ENV['CI_SPEC_OPTIONS']
+  end
+  t.pattern = pattern
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'metadata-json-lint/rake_task'
+require 'puppet-strings/tasks'
+
+namespace :validate do
+  desc 'Validate all .rb files'
+  task :ruby do
+    Dir['lib/**/*.rb'].each do |lib_file|
+      sh ['ruby', '-c', lib_file]
+    end
+  end
+
+  desc 'validate REFERENCE.md if it exists'
+  task :strings do
+    if File.exist?('REFERENCE.md')
+      Rake::Task['strings:validate:reference'].invoke
+    end
+  end
+end
+
+# `syntax` will validate pp, hiera, erb, epp files
+desc 'Check syntax of Ruby files and call :syntax and :metadata_lint'
+task validate: ['validate:ruby', 'syntax', 'metadata_lint', 'validate:strings']

data/lib/voxpupuli/test/rake.rb

@@ -1,36 +1,22 @@
 # frozen_string_literal: true
 
-require 'puppetlabs_spec_helper/rake_tasks'
+# load and configure puppet-lint
+require_relative 'rake/puppetlint'
 
-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
+# load and configure puppet-syntax
+require_relative 'rake/puppetsyntax'
 
-desc 'Run tests'
-task test: [:release_checks]
+# define various helper tasks
+require_relative 'rake/check'
 
-task default: [:release_checks]
+# define the various spec tasks
+require_relative 'rake/spec'
 
-namespace :check do
-  desc 'Check for trailing whitespace'
-  task :trailing_whitespace do
-    errors = []
+# static code analysis
+require_relative 'rake/validate'
+require_relative 'rake/rubocop'
 
-    Dir.glob('**/*.md', File::FNM_DOTMATCH).sort.each do |filename|
-      next if filename =~ %r{^((modules|acceptance|\.?vendor|spec/fixtures|pkg)/|REFERENCE.md)}
+desc 'Runs all necessary checks on a module'
+task test: %i[lint validate parallel_spec check]
 
-      File.foreach(filename).each_with_index do |line, index|
-        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']
+task default: [:test]

data/lib/voxpupuli/test/spec_helper.rb

@@ -1,9 +1,26 @@
 # frozen_string_literal: true
 
 require 'voxpupuli/test/facts'
-require 'puppetlabs_spec_helper/module_spec_helper'
+require 'rspec-puppet'
+
+spec_path = File.expand_path(File.join(Dir.pwd, 'spec'))
+module_path = File.join(spec_path, 'fixtures', 'modules')
+
+# Add all spec lib dirs to LOAD_PATH
+Dir.glob(File.join(module_path, '*', 'spec', 'lib')).each do |d|
+  $LOAD_PATH << d if FileTest.directory?(d) && !$LOAD_PATH.include?(d)
+end
 
 RSpec.configure do |config|
+  if ENV['GITHUB_ACTIONS'] == 'true'
+    config.formatter = 'RSpec::Github::Formatter'
+  end
+
+  config.environmentpath = spec_path
+
+  config.module_path = module_path
+  config.strict_variables = true
+
   # This completely disables Facter and uses a stubbed implementation. This is
   # fine since we use use rspec-puppet-facts to set all facts. It gives
   # complete isolation from the host system. It only works with Puppet 6.25+
@@ -13,6 +30,14 @@ RSpec.configure do |config|
   # In the next major release we will flip this to true
   config.facterdb_string_keys = false
 
+  config.before :each do
+    if config.mock_framework.framework_name == :rspec
+      allow(Puppet.features).to receive(:root?).and_return(true)
+    else
+      Puppet.features.stubs(:root?).returns(true)
+    end
+  end
+
   config.after(:suite) do
     RSpec::Puppet::Coverage.report!
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voxpupuli-test
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 10.0.0
 platform: ruby
 authors:
 - Vox Pupuli
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-08 00:00:00.000000000 Z
+date: 2025-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -62,30 +62,42 @@ dependencies:
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: puppetlabs_spec_helper
+  name: puppet_fixtures
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: puppet-strings
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +112,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: puppet-syntax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rspec-puppet
   requirement: !ruby/object:Gem::Requirement
@@ -129,19 +175,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-puppet-utils
+  name: syslog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -224,13 +270,19 @@ files:
 - README.md
 - lib/voxpupuli/test/facts.rb
 - lib/voxpupuli/test/rake.rb
+- lib/voxpupuli/test/rake/check.rb
+- lib/voxpupuli/test/rake/puppetlint.rb
+- lib/voxpupuli/test/rake/puppetsyntax.rb
+- lib/voxpupuli/test/rake/rubocop.rb
+- lib/voxpupuli/test/rake/spec.rb
+- lib/voxpupuli/test/rake/validate.rb
 - lib/voxpupuli/test/spec_helper.rb
 - rubocop.yml
 homepage: http://github.com/voxpupuli/voxpupuli-test
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -246,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Helpers for testing Vox Pupuli modules
 test_files: []