beaker_puppet_helpers 3.1.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43c0fc876e6e5ec072e587d7637ec6c9cfbed07934d2dea55732383cda9e24ee
-  data.tar.gz: 63fed535614ee30e2e1e01ee5dda0786d55f8681b5dd66b531eabebe52498104
+  metadata.gz: d75c6f419e157614121b5a9de767c2de8c3e2140dab6abf0930c681e9beadf4c
+  data.tar.gz: c4c8e080500c1857e20639e498f256f6219b7b654d35012fb8152dd5af1d7cb7
 SHA512:
-  metadata.gz: 8b78e838186e5cdf9343ee4ad309910845076c3d57cd1ff3fcc6b1b04d3f1d0f8237d2278735ac47e1d33cb4eedfc0ae8318eba30380a87962c0ee8fbee8050b
-  data.tar.gz: f9a3fda821c51b22486d2c8a752051976c8d235ed20e0ab294544fd13f5f8fcc321aaf3945c6da6a0508a7123d5ab3d4bb071559327650a460238fde5e62c310
+  metadata.gz: f76bd5da6ebf7799d713b6ce1f608445ad5bb4d048b67a327af81cfb7b6e5babcf1669372801804a6500c112467496e9d788d5e4c9cb9ed1ebb434979e16ca5e
+  data.tar.gz: 0d36eb4df0b6f9cadec39e5eabe04ac93ae574e4371ca9b8f486e60b5eab61b79e13906524262cd27036c0390db4fbfa75332b52a6bfb770b4383aa410d48448

data/.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
     name: Build the gem
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -24,7 +24,7 @@ jobs:
         shell: bash
         run: gem build --verbose *.gemspec
       - name: Upload gem to GitHub cache
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: gem-artifact
           path: '*.gem'
@@ -39,7 +39,7 @@ jobs:
       contents: write # clone repo and create release
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v7
         with:
           name: gem-artifact
       - name: Create Release
@@ -56,7 +56,7 @@ jobs:
       packages: write # publish to rubygems.pkg.github.com
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v7
         with:
           name: gem-artifact
       - name: Publish gem to GitHub packages
@@ -73,7 +73,7 @@ jobs:
       id-token: write # rubygems.org authentication
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v7
         with:
           name: gem-artifact
       - uses: rubygems/configure-rubygems-credentials@v1.0.0
@@ -92,7 +92,7 @@ jobs:
       - release-to-rubygems
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v7
         with:
           name: gem-artifact
       - name: Install Ruby

data/.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
     outputs:
       ruby: ${{ steps.ruby.outputs.versions }}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
@@ -28,7 +28,7 @@ jobs:
       - name: Rubocop
         run: bundle exec rake rubocop
       - id: ruby
-        uses: voxpupuli/ruby-version@v1
+        uses: voxpupuli/ruby-version@v2
 
   build:
     runs-on: ubuntu-latest
@@ -39,7 +39,7 @@ jobs:
         ruby: ${{ fromJSON(needs.rubocop_and_matrix.outputs.ruby) }}
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:

data/.rubocop.yml

@@ -12,6 +12,3 @@ RSpec/SubjectStub:
 
 RSpec/StubbedMock:
   Enabled: false
-
-AllCops:
-  TargetRubyVersion: 3.2

data/.rubocop_todo.yml

@@ -1,26 +1,22 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --no-auto-gen-timestamp`
-# using RuboCop version 1.75.8.
+# using RuboCop version 1.81.7.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 9
+# Offense count: 27
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 9
 
-# Offense count: 77
+# Offense count: 125
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 26
-RSpec/MultipleExpectations:
-  Max: 7
-
 # Offense count: 4
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file.
 
+## [3.2.1](https://github.com/voxpupuli/beaker_puppet_helpers/tree/3.2.1) (2026-01-21)
+
+[Full Changelog](https://github.com/voxpupuli/beaker_puppet_helpers/compare/3.2.0...3.2.1)
+
+**Closed issues:**
+
+- apply\_manifest\_on no longer returns the output of the command [\#99](https://github.com/voxpupuli/beaker_puppet_helpers/issues/99)
+
+**Merged pull requests:**
+
+- Restore behavior of apply\_manifest\_on [\#100](https://github.com/voxpupuli/beaker_puppet_helpers/pull/100) ([jaevans](https://github.com/jaevans))
+
+## [3.2.0](https://github.com/voxpupuli/beaker_puppet_helpers/tree/3.2.0) (2026-01-06)
+
+[Full Changelog](https://github.com/voxpupuli/beaker_puppet_helpers/compare/3.1.1...3.2.0)
+
+**Implemented enhancements:**
+
+- Add Ruby 4.0 support [\#96](https://github.com/voxpupuli/beaker_puppet_helpers/pull/96) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Respect `BEAKER_destroy` for manifest cleanup [\#93](https://github.com/voxpupuli/beaker_puppet_helpers/pull/93) ([bwitt](https://github.com/bwitt))
+
 ## [3.1.1](https://github.com/voxpupuli/beaker_puppet_helpers/tree/3.1.1) (2025-09-22)
 
 [Full Changelog](https://github.com/voxpupuli/beaker_puppet_helpers/compare/3.1.0...3.1.1)

data/README.md

@@ -55,6 +55,12 @@ environment, you can use `BEAKER_HOSTS`, passing a file path to a beaker hosts
 file or a beaker-hostgenerator value. You can also specify the tests that get
 executed with the `TESTS` environment variable.
 
+Use the `BEAKER_destroy` environment variable to control whether to cleanup
+temporary manifest files created during `apply_manifest_on` calls. Set it to
+`never` to preserve files for debugging, `onpass` to keep files only when tests
+fail, or `onfail` to keep files only when tests pass. The default (`always`)
+deletes files after every run.
+
 ## License
 
 This gem is licensed under the Apache-2 license.
@@ -62,6 +68,7 @@ This gem is licensed under the Apache-2 license.
 ## Release information
 
 To make a new release, please do:
+
 * update the version in `beaker_puppet_helpers.gemspec`
 * Install gems with `bundle install --with release --path .vendor`
 * generate the changelog with `bundle exec rake changelog`

data/beaker_puppet_helpers.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'beaker_puppet_helpers'
-  s.version     = '3.1.1'
+  s.version     = '3.2.1'
   s.authors     = ['Vox Pupuli']
   s.email       = ['voxpupuli@groups.io']
   s.homepage    = 'https://github.com/voxpupuli/beaker_puppet_helpers'
@@ -21,5 +21,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'open-uri', '< 0.6'
   s.add_dependency 'puppet-modulebuilder', '>= 0.3', '< 3'
 
-  s.add_development_dependency 'voxpupuli-rubocop', '~> 4.1.0'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 5.1.0'
 end

data/lib/beaker_puppet_helpers/dsl.rb

@@ -175,11 +175,27 @@ module BeakerPuppetHelpers
 
         file_path = host.tmpfile(%(apply_manifest_#{Time.now.strftime('%H%M%S%L')}), '.pp')
         begin
+          cleanup = false
           create_remote_file(host, file_path, "#{manifest}\n")
 
-          on(host, Beaker::PuppetCommand.new('apply', file_path, puppet_apply_opts), **on_options, &block)
+          result = on(host, Beaker::PuppetCommand.new('apply', file_path, puppet_apply_opts), **on_options, &block)
+          cleanup = true
+          result
         ensure
-          host.rm_rf(file_path)
+          # Respect BEAKER_destroy environment variable for file cleanup
+          beaker_destroy = ENV.fetch('BEAKER_destroy', 'always').downcase
+          should_delete = case beaker_destroy
+                          when 'no', 'never'
+                            false
+                          when 'onpass'
+                            cleanup
+                          when 'onfail'
+                            !cleanup
+                          else
+                            true
+                          end
+
+          host.rm_rf(file_path) if should_delete
         end
       end
     end

data/spec/beaker_puppet_helpers/dsl_spec.rb

@@ -174,6 +174,100 @@ describe BeakerPuppetHelpers::DSL do
 
       dsl.apply_manifest_on(agent, 'class { "boo": }', show_diff: true)
     end
+
+    it 'returns the result of the on call on success' do
+      expected_result = instance_double(Beaker::Result)
+      expect(dsl).to receive(:create_remote_file).and_return(true)
+      expect(Beaker::PuppetCommand).to receive(:new).and_return('puppet_command')
+      expect(dsl).to receive(:on).with(agent, 'puppet_command', acceptable_exit_codes: [0]).and_return(expected_result)
+
+      result = dsl.apply_manifest_on(agent, 'class { "boo": }')
+      expect(result).to eq(expected_result)
+    end
+
+    it 'returns the result of the on call even when exceptions are raised' do
+      expect(dsl).to receive(:create_remote_file).and_return(true)
+      expect(Beaker::PuppetCommand).to receive(:new).and_return('puppet_command')
+      expect(dsl).to receive(:on).with(agent, 'puppet_command', acceptable_exit_codes: [0]).and_raise(StandardError, 'apply failed')
+      expect(agent).to receive(:rm_rf)
+
+      expect { dsl.apply_manifest_on(agent, 'class { "boo": }') }.to raise_error(StandardError, 'apply failed')
+    end
+
+    context 'with BEAKER_destroy environment variable' do
+      after do
+        ENV.delete('BEAKER_destroy')
+      end
+
+      it 'always deletes manifest file by default (always)' do
+        expect(dsl).to receive(:create_remote_file).and_return(true)
+        expect(Beaker::PuppetCommand).to receive(:new).and_return('puppet_command')
+        expect(dsl).to receive(:on).with(agent, 'puppet_command', acceptable_exit_codes: [0])
+        expect(agent).to receive(:rm_rf)
+
+        dsl.apply_manifest_on(agent, 'class { "boo": }')
+      end
+
+      it 'never deletes manifest file when BEAKER_destroy=never' do
+        ENV['BEAKER_destroy'] = 'never'
+        expect(dsl).to receive(:create_remote_file).and_return(true)
+        expect(Beaker::PuppetCommand).to receive(:new).and_return('puppet_command')
+        expect(dsl).to receive(:on).with(agent, 'puppet_command', acceptable_exit_codes: [0])
+        expect(agent).not_to receive(:rm_rf)
+
+        dsl.apply_manifest_on(agent, 'class { "boo": }')
+      end
+
+      it 'always deletes manifest file when BEAKER_destroy=always' do
+        ENV['BEAKER_destroy'] = 'always'
+        expect(dsl).to receive(:create_remote_file).and_return(true)
+        expect(Beaker::PuppetCommand).to receive(:new).and_return('puppet_command')
+        expect(dsl).to receive(:on).with(agent, 'puppet_command', acceptable_exit_codes: [0])
+        expect(agent).to receive(:rm_rf)
+
+        dsl.apply_manifest_on(agent, 'class { "boo": }')
+      end
+
+      it 'deletes manifest file on success when BEAKER_destroy=onpass' do
+        ENV['BEAKER_destroy'] = 'onpass'
+        expect(dsl).to receive(:create_remote_file).and_return(true)
+        expect(Beaker::PuppetCommand).to receive(:new).and_return('puppet_command')
+        expect(dsl).to receive(:on).with(agent, 'puppet_command', acceptable_exit_codes: [0])
+        expect(agent).to receive(:rm_rf)
+
+        dsl.apply_manifest_on(agent, 'class { "boo": }')
+      end
+
+      it 'preserves manifest file on failure when BEAKER_destroy=onpass' do
+        ENV['BEAKER_destroy'] = 'onpass'
+        expect(dsl).to receive(:create_remote_file).and_return(true)
+        expect(Beaker::PuppetCommand).to receive(:new).and_return('puppet_command')
+        expect(dsl).to receive(:on).with(agent, 'puppet_command', acceptable_exit_codes: [0]).and_raise(StandardError, 'test failure')
+        expect(agent).not_to receive(:rm_rf)
+
+        expect { dsl.apply_manifest_on(agent, 'class { "boo": }') }.to raise_error(StandardError, 'test failure')
+      end
+
+      it 'deletes manifest file on failure when BEAKER_destroy=onfail' do
+        ENV['BEAKER_destroy'] = 'onfail'
+        expect(dsl).to receive(:create_remote_file).and_return(true)
+        expect(Beaker::PuppetCommand).to receive(:new).and_return('puppet_command')
+        expect(dsl).to receive(:on).with(agent, 'puppet_command', acceptable_exit_codes: [0]).and_raise(StandardError, 'test failure')
+        expect(agent).to receive(:rm_rf)
+
+        expect { dsl.apply_manifest_on(agent, 'class { "boo": }') }.to raise_error(StandardError, 'test failure')
+      end
+
+      it 'preserves manifest file on success when BEAKER_destroy=onfail' do
+        ENV['BEAKER_destroy'] = 'onfail'
+        expect(dsl).to receive(:create_remote_file).and_return(true)
+        expect(Beaker::PuppetCommand).to receive(:new).and_return('puppet_command')
+        expect(dsl).to receive(:on).with(agent, 'puppet_command', acceptable_exit_codes: [0])
+        expect(agent).not_to receive(:rm_rf)
+
+        dsl.apply_manifest_on(agent, 'class { "boo": }')
+      end
+    end
   end
 
   describe '#apply_manifest' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaker_puppet_helpers
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.1
 platform: ruby
 authors:
 - Vox Pupuli
@@ -89,14 +89,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.1.0
 description: For use for the Beaker acceptance testing tool
 email:
 - voxpupuli@groups.io
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Beaker's Puppet DSL Extension Helpers
 test_files: []