puppetlabs_spec_helper 7.3.1 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139276e5721239e25b613a18b8c96ea93235f9717dfea2522f3c597ca4f98996
-  data.tar.gz: 8c8c252953c527d1da8add48267246261c27bbe30c7186e7ab4d960e0840665e
+  metadata.gz: f6e4f387a2e5ca2ffdaf54834dba59bddbc793d099a32844e406d6bcf1906345
+  data.tar.gz: a5d37de14da8a64547e4dd3a40a649b0eac66d7c73d7d2aff561dafc569c3299
 SHA512:
-  metadata.gz: 2fd1740c635a65b214e9fa83f639d519ba4569b45862ab0a6f7cd5b60fa3de9c1fb0f099ad45b2fe91b85eee1116359e02cb6dbc5ce4e8477fc6f1e3c280a3df
-  data.tar.gz: cc1162520fb1db194506d43502f7b6cd395577c4312bc5c737c2272ac8aefbaf5767cfd7eb414d465036be79eb2ac2bd30a49e108f677aee254bbcdac30dd161
+  metadata.gz: 0c5d1c7bc0f185b696570c75bccab95349681e09bc213e91f5ffeb855d462a4e98c30cc3049ccb44cb083936438ccc386bcee6096a92f2ff8e8eb48c1fc8478e
+  data.tar.gz: 7da07d5ea2f8c277944bb803765fe2a39695c38ee3342bf0da34fdefce301e20edce6d9a201337db7cbbb14536ac2f9894cb50925f439a6214f9aa1a35669b97

data/.rubocop.yml

@@ -1,18 +1,8 @@
+---
 inherit_from: .rubocop_todo.yml
 
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-AllCops:
-  Exclude:
-    - Gemfile
-    - Rakefile
-    - spec/fixtures/**/*
-    - vendor/bundle/**/*
-  NewCops: enable
-  SuggestExtensions: false
-  TargetRubyVersion: '2.7'
+inherit_gem:
+  voxpupuli-rubocop: rubocop.yml
 
 # Disabled
 Style/ClassAndModuleChildren:

data/README.md

@@ -216,6 +216,17 @@ When specifying the repo source of the fixture you have a few options as to whic
  * `ref` and `branch` can be used together to get a specific revision on a specific branch
  * Top level `defaults` option could be used to set global options
 
+Using Forge Authorization
+-----------------
+
+In order to perform forge operations which require authorization, such as installing premium modules, you can export your forge api key as an environment variable in your terminal.
+
+```bash
+FORGE_API_KEY='your_api_key'
+```
+
+puppetlabs_spec_helper will then automatically append this key to all `puppet module install` requests when running `rake spec_prep`.
+
 Fixtures Examples
 -----------------
 Basic fixtures that will symlink `spec/fixtures/modules/my_modules` to the

data/lib/puppetlabs_spec_helper/module_spec_helper.rb

@@ -31,7 +31,7 @@ if ENV['SIMPLECOV'] == 'yes'
 
   SimpleCov.formatters = [
     SimpleCov::Formatter::HTMLFormatter,
-    SimpleCov::Formatter::Console
+    SimpleCov::Formatter::Console,
   ]
 
   begin

data/lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb

@@ -39,7 +39,7 @@ module PuppetlabsSpec
       # exposed hack.
       return nil unless Puppet::Parser::Functions.function(name)
 
-      scope.method("function_#{name}".to_sym)
+      scope.method(:"function_#{name}")
     end
     module_function :function_method
   end

data/lib/puppetlabs_spec_helper/rake_tasks.rb

@@ -121,35 +121,6 @@ task :parallel_spec_standalone do |_t, args|
   end
 end
 
-desc 'Build puppet module package'
-task :build do
-  Rake::Task['build:pdk'].invoke
-end
-
-namespace :build do
-  desc 'Build Puppet module with PDK'
-  task :pdk do
-    require 'pdk/util'
-    require 'pdk/module/build'
-
-    path = PDK::Module::Build.invoke(force: true, 'target-dir': File.join(Dir.pwd, 'pkg'))
-    puts "Module built: #{path}"
-  rescue LoadError
-    _ = `pdk --version`
-    unless $CHILD_STATUS.success?
-      warn 'Unable to build module. Please install PDK or add the `pdk` gem to your Gemfile.'
-      abort
-    end
-
-    system('pdk build --force')
-  end
-end
-
-desc 'Clean a built module package'
-task :clean do
-  FileUtils.rm_rf('pkg/')
-end
-
 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
@@ -170,7 +141,6 @@ puppet_lint_disable_checks = %w[
   80chars
   140chars
   class_inherits_from_params_class
-  class_parameter_defaults
   disable_autoloader_layout
   documentation
   single_quote_string_with_variables
@@ -381,16 +351,16 @@ def create_gch_task(changelog_user = nil, changelog_project = nil, changelog_sin
       config.configure_sections = {
         'Changed' => {
           'prefix' => '### Changed',
-          'labels' => ['backwards-incompatible']
+          'labels' => ['backwards-incompatible'],
         },
         'Added' => {
           'prefix' => '### Added',
-          'labels' => %w[feature enhancement]
+          'labels' => %w[feature enhancement],
         },
         'Fixed' => {
           'prefix' => '### Fixed',
-          'labels' => ['bugfix']
-        }
+          'labels' => ['bugfix'],
+        },
       }
     end
   else

data/lib/puppetlabs_spec_helper/tasks/check_symlinks.rb

@@ -9,12 +9,12 @@ module PuppetlabsSpecHelper
       DEFAULT_IGNORED = [
         '/.git/',
         '/.bundle/',
-        '/vendor/'
+        '/vendor/',
       ].freeze
 
       IGNORE_LIST_FILES = [
         '.pdkignore',
-        '.gitignore'
+        '.gitignore',
       ].freeze
 
       def check(dir = Dir.pwd)

data/lib/puppetlabs_spec_helper/tasks/fixtures.rb

@@ -106,7 +106,7 @@ module PuppetlabsSpecHelper
                            end
 
         fixtures = fixtures['fixtures']
-        fixtures['symlinks'] = fixtures['symlinks'].nil? || fixtures['symlinks'].empty? ? auto_symlink : auto_symlink.merge!(fixtures['symlinks'])
+        fixtures['symlinks'] = (fixtures['symlinks'].nil? || fixtures['symlinks'].empty?) ? auto_symlink : auto_symlink.merge!(fixtures['symlinks'])
 
         result = {}
         if fixtures.include?(category) && !fixtures[category].nil?
@@ -317,7 +317,7 @@ module PuppetlabsSpecHelper
           end
         end
         # wait for all the threads to finish
-        items.each { |_remote, opts| opts[:thread].join }
+        items.each_value { |opts| opts[:thread].join }
       end
 
       # @param target [String] - the target directory
@@ -379,6 +379,9 @@ module PuppetlabsSpecHelper
           flags = " #{opts['flags']}" if opts['flags']
         end
 
+        forge_token = ENV.fetch('FORGE_API_KEY', nil)
+        flags += " --forge_authorization \"Bearer #{forge_token}\"" if forge_token
+
         return false if File.directory?(target) && (ref.empty? || opts['ref'] == module_version(target))
 
         # The PMT cannot handle multi threaded runs due to cache directory collisons
@@ -427,12 +430,12 @@ end
 
 desc 'Clean up the fixtures directory'
 task :spec_clean do
-  repositories.each do |_remote, opts|
+  repositories.each_value do |opts|
     target = opts['target']
     FileUtils.rm_rf(target)
   end
 
-  forge_modules.each do |_remote, opts|
+  forge_modules.each_value do |opts|
     target = opts['target']
     FileUtils.rm_rf(target)
   end
@@ -446,7 +449,7 @@ end
 
 desc 'Clean up any fixture symlinks'
 task :spec_clean_symlinks do
-  fixtures('symlinks').each do |_source, opts|
+  fixtures('symlinks').each_value do |opts|
     target = opts['target']
     FileUtils.rm_f(target)
   end

data/lib/puppetlabs_spec_helper/version.rb

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

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ if ENV['COVERAGE'] == 'yes'
 
   SimpleCov.formatters = [
     SimpleCov::Formatter::HTMLFormatter,
-    SimpleCov::Formatter::Console
+    SimpleCov::Formatter::Console,
   ]
 
   SimpleCov.start do

data/spec/unit/puppetlabs_spec_helper/tasks/check_symlinks_spec.rb

@@ -31,7 +31,7 @@ describe 'rake check:symlinks', type: :task do
     let(:test_files) do
       [
         File.join(Dir.pwd, 'files', 'a_file.pp'),
-        File.join(Dir.pwd, 'files', 'another_file.pp')
+        File.join(Dir.pwd, 'files', 'another_file.pp'),
       ]
     end
 
@@ -43,13 +43,13 @@ describe 'rake check:symlinks', type: :task do
   context 'when there is a symlink present' do
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, 'files', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -63,13 +63,13 @@ describe 'rake check:symlinks', type: :task do
   context 'when there are symlinks under .git/' do
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, '.git', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, '.git', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -81,13 +81,13 @@ describe 'rake check:symlinks', type: :task do
   context 'when there are symlinks under .bundle/' do
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, '.bundle', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, '.bundle', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -99,13 +99,13 @@ describe 'rake check:symlinks', type: :task do
   context 'when there are symlinks under vendor/' do
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, 'vendor', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'vendor', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -121,13 +121,13 @@ describe 'rake check:symlinks', type: :task do
 
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, 'a_directory', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'a_directory', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -145,13 +145,13 @@ describe 'rake check:symlinks', type: :task do
 
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, 'another_directory', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'another_directory', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 

data/spec/unit/puppetlabs_spec_helper/tasks/check_test_file_spec.rb

@@ -14,7 +14,7 @@ describe 'rake check:test_file', type: :task do
     let(:test_files) do
       [
         File.join(Dir.pwd, 'tests', 'an_example.pp'),
-        File.join(Dir.pwd, 'tests', 'deep', 'directory', 'structure', 'another_example.pp')
+        File.join(Dir.pwd, 'tests', 'deep', 'directory', 'structure', 'another_example.pp'),
       ]
     end
 

data/spec/unit/puppetlabs_spec_helper/tasks/fixture_helpers_spec.rb

@@ -141,7 +141,7 @@ describe PuppetlabsSpecHelper::Tasks::FixtureHelpers do
             'branch' => nil,
             'scm' => nil,
             'flags' => nil,
-            'subdir' => nil
+            'subdir' => nil,
           },
         )
       end
@@ -159,18 +159,41 @@ describe PuppetlabsSpecHelper::Tasks::FixtureHelpers do
             'branch' => nil,
             'scm' => nil,
             'flags' => '--module_repository=https://myforge.example.com/',
-            'subdir' => nil
+            'subdir' => nil,
           },
         )
       end
     end
 
+    context 'when forge_api_key env variable is set' do
+      before do
+        # required to prevent unwanted output on stub of $CHILD_STATUS
+        RSpec::Mocks.configuration.allow_message_expectations_on_nil = true
+      end
+
+      after do
+        RSpec::Mocks.configuration.allow_message_expectations_on_nil = false
+      end
+
+      it 'correctly sets --forge_authorization' do
+        allow(ENV).to receive(:fetch).with('FORGE_API_KEY', nil).and_return('myforgeapikey')
+        # Mock the system call to prevent actual execution
+        allow_any_instance_of(Kernel).to receive(:system) do |command| # rubocop:disable RSpec/AnyInstance
+          expect(command).to include('--forge_authorization "Bearer myforgeapikey"')
+          # Simulate setting $CHILD_STATUS to a successful status
+          allow($CHILD_STATUS).to receive(:success?).and_return(true)
+          true
+        end
+        helper.download_module('puppetlabs-stdlib', 'target' => 'spec/fixtures/modules/stdlib')
+      end
+    end
+
     context 'when file specifies repository fixtures' do
       before do
         allow(File).to receive(:exist?).with('.fixtures.yml').and_return true
         allow(YAML).to receive(:load_file).with('.fixtures.yml').and_return(
           'fixtures' => {
-            'repositories' => { 'stdlib' => 'https://github.com/puppetlabs/puppetlabs-stdlib.git' }
+            'repositories' => { 'stdlib' => 'https://github.com/puppetlabs/puppetlabs-stdlib.git' },
           },
         )
       end
@@ -183,7 +206,7 @@ describe PuppetlabsSpecHelper::Tasks::FixtureHelpers do
             'branch' => nil,
             'scm' => nil,
             'flags' => nil,
-            'subdir' => nil
+            'subdir' => nil,
           },
         )
       end
@@ -198,9 +221,9 @@ describe PuppetlabsSpecHelper::Tasks::FixtureHelpers do
               'stdlib' => {
                 'scm' => 'git',
                 'repo' => 'https://github.com/puppetlabs/puppetlabs-stdlib.git',
-                'ref' => 'this/is/a/branch'
-              }
-            }
+                'ref' => 'this/is/a/branch',
+              },
+            },
           },
         )
       end
@@ -222,9 +245,9 @@ describe PuppetlabsSpecHelper::Tasks::FixtureHelpers do
             'forge_modules' => {
               'stdlib' => {
                 'repo' => 'puppetlabs-stdlib',
-                'puppet_version' => Puppet::PUPPETVERSION
-              }
-            }
+                'puppet_version' => Puppet::PUPPETVERSION,
+              },
+            },
           },
         )
         expect(helper.fixtures('forge_modules')).to include('puppetlabs-stdlib')
@@ -236,9 +259,9 @@ describe PuppetlabsSpecHelper::Tasks::FixtureHelpers do
             'forge_modules' => {
               'stdlib' => {
                 'repo' => 'puppetlabs-stdlib',
-                'puppet_version' => '>= 999.9.9'
-              }
-            }
+                'puppet_version' => '>= 999.9.9',
+              },
+            },
           },
         )
         expect(helper.fixtures('forge_modules')).to eq({})
@@ -250,9 +273,9 @@ describe PuppetlabsSpecHelper::Tasks::FixtureHelpers do
             'forge_modules' => {
               'stdlib' => {
                 'repo' => 'puppetlabs-stdlib',
-                'puppet_version' => Puppet::PUPPETVERSION
-              }
-            }
+                'puppet_version' => Puppet::PUPPETVERSION,
+              },
+            },
           },
         )
         expect(helper.fixtures('forge_modules')).to include('puppetlabs-stdlib')

data/spec/watchr.rb

@@ -11,7 +11,7 @@ def growl(message)
   title = 'Watchr Test Results'
   image = case message
           when /(\d+)\s+?(failure|error)/i
-            Regexp.last_match(1).to_i == 0 ? '~/.watchr_images/passed.png' : '~/.watchr_images/failed.png'
+            (Regexp.last_match(1).to_i == 0) ? '~/.watchr_images/passed.png' : '~/.watchr_images/failed.png'
           else
             '~/.watchr_images/unknown.png'
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetlabs_spec_helper
 version: !ruby/object:Gem::Version
-  version: 7.3.1
+  version: 8.0.0
 platform: ruby
 authors:
 - Puppet, Inc.
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-06 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: pathspec
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +40,7 @@ dependencies:
         version: '0.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +50,7 @@ dependencies:
         version: '0.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
@@ -99,14 +105,28 @@ 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: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 description: Contains rake tasks and a standard spec_helper for running spec tests
   on puppet modules.
 email: