puppetlabs_spec_helper 7.4.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36cef853b9fb2b00ccda0994669722f01209bca6341ed3bfe07acae8475e08c
-  data.tar.gz: 155d86fa1f146094e975dbe60f3f4696b5eab2df34f9d4b4c7dfade4d5708e43
+  metadata.gz: f6e4f387a2e5ca2ffdaf54834dba59bddbc793d099a32844e406d6bcf1906345
+  data.tar.gz: a5d37de14da8a64547e4dd3a40a649b0eac66d7c73d7d2aff561dafc569c3299
 SHA512:
-  metadata.gz: 3c330c348badae2b51fd81aebc3a9f9143a1e8c82ffc0273a9cb7e95ce71c9702f5d8cde33d0af014fedcf27dd62b38fb1c0edd9063b0f3998da9f3786a32b1a
-  data.tar.gz: 6852485e9517b2984072af1171f252619d07455756fb694e999c78f23272c17e9cb17bb598f8aa8c0799fec8d6d2998679b11aa820c98e365dc67ea72a3e8f30
+  metadata.gz: 0c5d1c7bc0f185b696570c75bccab95349681e09bc213e91f5ffeb855d462a4e98c30cc3049ccb44cb083936438ccc386bcee6096a92f2ff8e8eb48c1fc8478e
+  data.tar.gz: 7da07d5ea2f8c277944bb803765fe2a39695c38ee3342bf0da34fdefce301e20edce6d9a201337db7cbbb14536ac2f9894cb50925f439a6214f9aa1a35669b97

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/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

data/lib/puppetlabs_spec_helper/tasks/fixtures.rb

@@ -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

data/lib/puppetlabs_spec_helper/version.rb

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

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

@@ -165,6 +165,29 @@ describe PuppetlabsSpecHelper::Tasks::FixtureHelpers do
       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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppetlabs_spec_helper
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Puppet, Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-06 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha