puppetlabs_spec_helper 6.0.1 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9697b23b7652cc4dd9158675666a7f64ea3a902a4ec8367977712b9549e94951
-  data.tar.gz: e1913dfc25f36d2067d4f9003810e5d0602a105b2442aaca1bba8a09dff484bb
+  metadata.gz: 6188f4bcefb0c6466202ed84d9a4a13b0ebdace7885c8d78da307d135ab7eca6
+  data.tar.gz: 46b8356e53ec07eb3073e1ddb1a08eeb5423f6efee7d40ae12fd904de05d7614
 SHA512:
-  metadata.gz: e3ee3dbfac1577f1933f00e9b2cb6ac5fb2b4162054b9e9dcedd5921c7cbdcd279dce6294db6ec9cf29919c572ab0087ff62b3175ad1b3ddb24c8d261553587b
-  data.tar.gz: a0c034d5006429965a0a86a96de2011f708f9ce32893d2518dc6e062c73644560d6651f071c58a7c3d20c91e8013af46c45f14ea1cec7d61ff77beb52f05a0d3
+  metadata.gz: abe28cf72356674ee59c2d759e4def9b3bd424f2d8ea3034109834985bc9d3cecde412a6186eb1690a110f1b1b56b9f3159ae8f2387ef88bb1e328942ed6ee19
+  data.tar.gz: cba65825d5c9be5b64bf1898396ab949f6b2426c714d5113a12672727d405a89239f5825d7dde208bfeb6a4fdbac20e45fd2e7f1687574c55688bbe9e04a731a

data/.rubocop.yml

@@ -17,3 +17,6 @@ AllCops:
 # Disabled
 Style/ClassAndModuleChildren:
   Enabled: false
+
+Layout/LineLength:
+  Max: 200

data/README.md

@@ -1,6 +1,10 @@
 Puppet Labs Spec Helper
 =======================
 
+[![Code Owners](https://img.shields.io/badge/owners-DevX--team-blue)](https://github.com/puppetlabs/puppetlabs_spec_helper/blob/main/CODEOWNERS)
+![ci](https://github.com/puppetlabs/puppetlabs_spec_helper/actions/workflows/ci.yml/badge.svg)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/puppetlabs/puppetlabs_spec_helper)
+
 The Short Version
 -----------------
 
@@ -230,8 +234,8 @@ Add `firewall` and `stdlib` as required module fixtures:
 ```yaml
 fixtures:
   repositories:
-    firewall: "git://github.com/puppetlabs/puppetlabs-firewall"
-    stdlib: "git://github.com/puppetlabs/puppetlabs-stdlib"
+    firewall: "https://github.com/puppetlabs/puppetlabs-firewall.git"
+    stdlib: "https://github.com/puppetlabs/puppetlabs-stdlib.git"
 ```
 
 Put a supplementary repository at a different location
@@ -239,8 +243,8 @@ Put a supplementary repository at a different location
 ```yaml
 fixtures:
   repositories:
-    firewall: "git://github.com/puppetlabs/puppetlabs-firewall"
-    stdlib: "git://github.com/puppetlabs/puppetlabs-stdlib"
+    firewall: "https://github.com/puppetlabs/puppetlabs-firewall.git"
+    stdlib: "https://github.com/puppetlabs/puppetlabs-stdlib.git"
     control_repo:
       repo: "https://github.com/puppetlabs/control-repo"
       target: "spec/fixtures/control_repos"
@@ -251,9 +255,9 @@ Specify that the git tag `2.4.2` of `stdlib` should be checked out:
 ```yaml
 fixtures:
   repositories:
-    firewall: "git://github.com/puppetlabs/puppetlabs-firewall"
+    firewall: "https://github.com/puppetlabs/puppetlabs-firewall.git"
     stdlib:
-      repo: "git://github.com/puppetlabs/puppetlabs-stdlib"
+      repo: "https://github.com/puppetlabs/puppetlabs-stdlib.git"
       ref: "2.6.0"
 ```
 
@@ -263,7 +267,7 @@ Only install the `yumrepo_core` module when testing against Puppet 7 or greater:
 fixtures:
   repositories:
     yumrepo_core:
-      repo: "git://github.com/puppetlabs/puppetlabs-yumrepo_core"
+      repo: "https://github.com/puppetlabs/puppetlabs-yumrepo_core.git"
       puppet_version: ">= 6.0.0"
 ```
 
@@ -273,7 +277,7 @@ Move manifests and siblings to root directory when they are inside a `code` dire
 fixtures:
   repositories:
     stdlib:
-      repo: "git://github.com/puppetlabs/puppetlabs-extradirectory"
+      repo: "https://github.com/puppetlabs/puppetlabs-extradirectory.git"
       subdir: "code"
 ```
 
@@ -299,7 +303,7 @@ fixtures:
       flags: "--module_repository https://my_repo.com"
     repositories:
       firewall:
-        repo: "git://github.com/puppetlabs/puppetlabs-firewall"
+        repo: "https://github.com/puppetlabs/puppetlabs-firewall.git"
         ref: "2.6.0"
         flags: "--verbose"
 ```
@@ -317,7 +321,7 @@ fixtures:
       ref: "2.6.0"
     repositories:
       firewall:
-        repo: "git://github.com/puppetlabs/puppetlabs-firewall"
+        repo: "https://github.com/puppetlabs/puppetlabs-firewall.git"
         ref: "2.6.0"
 ```
 
@@ -406,7 +410,7 @@ You can enable it, set the following environment variable:s
 
 ``SIMPLECOV=yes``
 
-Remember to add the simplecov-console and codecov gems to your `Gemfile`. If you run `spec:simplecov` on Travis-CI or any of the other supported CI services, reports gets automatically uploaded to https://codecov.io/ .
+Remember to add the simplecov-console gem to your `Gemfile`. If you run `spec:simplecov` on Travis-CI or any of the other supported CI services, reports get generated which can then be uploaded to [codecov.io](https://codecov.io) with the recommended [codecov uploader](https://docs.codecov.com/docs/codecov-uploader).
 
 Some Notes for Windows Users
 ============================
@@ -481,3 +485,7 @@ Rationale
 * mocha is an additional dependency to carry.
 
 EOF
+
+## License
+
+This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.

data/lib/puppetlabs_spec_helper/module_spec_helper.rb

@@ -20,35 +20,42 @@ env_module_path = ENV.fetch('MODULEPATH', nil)
 module_path = File.join(fixture_path, 'modules')
 
 module_path = [module_path, env_module_path].join(File::PATH_SEPARATOR) if env_module_path
+
 if ENV['SIMPLECOV'] == 'yes'
   begin
     require 'simplecov'
     require 'simplecov-console'
+  rescue LoadError
+    raise 'Add the simplecov and simplecov-console gems to Gemfile to enable this task'
+  end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Console
+  ]
+
+  begin
     require 'codecov'
+    SimpleCov.formatters << SimpleCov::Formatter::Codecov
+  rescue LoadError
+    # continue without codecov, we could warn here but we want to avoid its use if possible
+  end
+
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+    add_filter '/spec'
 
-    SimpleCov.formatters = [
-      SimpleCov::Formatter::HTMLFormatter,
-      SimpleCov::Formatter::Console,
-      SimpleCov::Formatter::Codecov
-    ]
-    SimpleCov.start do
-      track_files 'lib/**/*.rb'
-      add_filter '/spec'
-
-      # do not track vendored files
-      add_filter '/vendor'
-      add_filter '/.vendor'
-
-      # do not track gitignored files
-      # this adds about 4 seconds to the coverage check
-      # this could definitely be optimized
-      add_filter do |f|
-        # system returns true if exit status is 0, which with git-check-ignore means file is ignored
-        system("git check-ignore --quiet #{f.filename}")
-      end
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
+
+    # do not track gitignored files
+    # this adds about 4 seconds to the coverage check
+    # this could definitely be optimized
+    add_filter do |f|
+      # system returns true if exit status is 0, which with git-check-ignore means file is ignored
+      system("git check-ignore --quiet #{f.filename}")
     end
-  rescue LoadError
-    raise 'Add the simplecov, simplecov-console, codecov gems to Gemfile to enable this task'
   end
 end
 
@@ -58,7 +65,7 @@ components = module_path.split(File::PATH_SEPARATOR).map do |dir|
 
   Dir.entries(dir).grep_v(/^\./).map { |f| File.join(dir, f, 'spec', 'lib') }
 end
-components.flatten.each do |d|
+components.compact.flatten.each do |d|
   $LOAD_PATH << d if FileTest.directory?(d) && !$LOAD_PATH.include?(d)
 end
 
@@ -67,7 +74,6 @@ RSpec.configure do |c|
 
   c.environmentpath = spec_path
   c.module_path = module_path
-  c.manifest_dir = File.join(fixture_path, 'manifests')
 
   # https://github.com/puppetlabs/rspec-puppet#strict_variables
   c.strict_variables = ENV['STRICT_VARIABLES'] != 'no'

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -46,9 +46,8 @@ end
 task default: [:help]
 
 pattern = 'spec/{aliases,classes,defines,functions,hosts,integration,plans,tasks,type_aliases,types,unit}/**/*_spec.rb'
-
 RSpec::Core::RakeTask.new(:spec_standalone) do |t, args|
-  t.rspec_opts = []
+  t.rspec_opts = ['--format', 'documentation', '--color']
   t.rspec_opts << ENV['CI_SPEC_OPTIONS'] unless ENV['CI_SPEC_OPTIONS'].nil?
   if ENV['CI_NODE_TOTAL'] && ENV['CI_NODE_INDEX']
     ci_total = ENV['CI_NODE_TOTAL'].to_i
@@ -111,8 +110,9 @@ task :parallel_spec_standalone do |_t, args|
     warn 'No files for parallel_spec to run against'
   else
 
-    args = ['-t', 'rspec']
-    args.push('--').concat(ENV['CI_SPEC_OPTIONS'].strip.split).push('--') unless ENV['CI_SPEC_OPTIONS'].nil? || ENV['CI_SPEC_OPTIONS'].strip.empty?
+    args = ['--type', 'rspec']
+    additional_options = ['--format', 'progress'] + ENV['CI_SPEC_OPTIONS'].to_s.strip.split
+    args.push('--').concat(additional_options).push('--')
     args.concat(Rake::FileList[pattern].to_a)
 
     ParallelTests::CLI.new.run(args)
@@ -176,7 +176,7 @@ puppet_lint_disable_checks = %w[
 ]
 
 puppet_lint_disable_checks.each do |check|
-  PuppetLint.configuration.send("disable_#{check}")
+  PuppetLint.configuration.send(:"disable_#{check}")
 end
 PuppetLint::RakeTask.new(:lint)
 
@@ -191,7 +191,8 @@ PuppetSyntax.exclude_paths << 'spec/fixtures/**/*'
 PuppetSyntax.exclude_paths << 'pkg/**/*'
 PuppetSyntax.exclude_paths << 'vendor/**/*'
 PuppetSyntax.exclude_paths << '.vendor/**/*'
-PuppetSyntax.exclude_paths << 'plans/**/*'
+PuppetSyntax.check_hiera_keys = true
+PuppetSyntax.check_hiera_data = true
 
 desc 'Check syntax of Ruby files and call :syntax and :metadata_lint'
 task :validate do

data/lib/puppetlabs_spec_helper/tasks/fixtures.rb

@@ -106,8 +106,7 @@ module PuppetlabsSpecHelper
                            end
 
         fixtures = fixtures['fixtures']
-
-        fixtures['symlinks'] = auto_symlink if fixtures['symlinks'].nil?
+        fixtures['symlinks'] = fixtures['symlinks'].nil? || fixtures['symlinks'].empty? ? auto_symlink : auto_symlink.merge!(fixtures['symlinks'])
 
         result = {}
         if fixtures.include?(category) && !fixtures[category].nil?
@@ -151,7 +150,7 @@ module PuppetlabsSpecHelper
         return hash unless hash['scm'] == 'git'
 
         # Forward slashes in the ref aren't allowed. And is probably a branch name.
-        raise ArgumentError, "The ref for #{hash['target']} is invalid (Contains a forward slash). If this is a branch name, please use the 'branch' setting instead." if hash['ref'].include?('/')
+        raise ArgumentError, "The ref for #{hash['target']} is invalid (Contains a forward slash). If this is a branch name, please use the 'branch' setting instead." if hash['ref']&.include?('/')
 
         hash
       end

data/lib/puppetlabs_spec_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PuppetlabsSpecHelper
-  VERSION = '6.0.1'
+  VERSION = '7.3.0'
 end

data/spec/spec_helper.rb

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
 if ENV['COVERAGE'] == 'yes'
-  require 'simplecov'
-  require 'simplecov-console'
-  require 'codecov'
+  begin
+    require 'simplecov'
+    require 'simplecov-console'
+  rescue LoadError
+    raise 'Add the simplecov and simplecov-console gems to Gemfile to enable this task'
+  end
 
   SimpleCov.formatters = [
     SimpleCov::Formatter::HTMLFormatter,
-    SimpleCov::Formatter::Console,
-    SimpleCov::Formatter::Codecov
+    SimpleCov::Formatter::Console
   ]
+
   SimpleCov.start do
     track_files 'lib/**/*.rb'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetlabs_spec_helper
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 7.3.0
 platform: ruby
 authors:
 - Puppet, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -49,30 +49,36 @@ dependencies:
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: puppet-syntax
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
 - !ruby/object:Gem::Dependency
   name: rspec-github
   requirement: !ruby/object:Gem::Requirement
@@ -91,16 +97,16 @@ dependencies:
   name: rspec-puppet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
 description: Contains rake tasks and a standard spec_helper for running spec tests
   on puppet modules.
 email: