beaker_puppet_helpers 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8306e4b6e6e28049e3f096d179dc4330846463c447abcfe8ce764a528fee6e96
-  data.tar.gz: ae6a8e1f75ac9e9793ff3f9c4dc3b8dd7f21f9fe83bf6a1078ed6af6bfd2400d
+  metadata.gz: d4b1b71e5893964ebe48c19fe00f8e656e022dd93d8cad2e7d2985a3f78ad66e
+  data.tar.gz: b989521ef3c8995e68e2b31e2bce8c118d960a488c66d697f909a0a9306d0b04
 SHA512:
-  metadata.gz: 69aa2ec43f5e4008509b1e9dc497851887ffed12b58be8c861ee51b432a3edf0e2fd8aa1c78e68a6c6142e56e9fa59f8b4b98a300fd66526daea6ef2d3c99815
-  data.tar.gz: 5242dfc352d988a3e1c9f400b9887e0e4e59982d4512c2ccd6b42826bc2fc53342fdf4d2356c11f8cdd3d258f5260df6e42b5ed6df12b6dcd576b478c193be32
+  metadata.gz: ce739711219f116c09a38c3f6d7ac16374b7402426625415a87556e1fe6420da5095283ae122f001e03274c501db55428c59c570fcdb521b7854ff90c3a776ea
+  data.tar.gz: 2e87a338eaa2c86afccb6495fb4b717512b085808b9c35a8c5a53042f6eb3d0a5d841219b76efcd10f54040b3010b0105569ab66c16cbd7d72b158aea24d4d85

data/.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
         shell: bash
         run: gem build --verbose *.gemspec
       - name: Upload gem to GitHub cache
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@v7
         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@v7
+        uses: actions/download-artifact@v8
         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@v7
+        uses: actions/download-artifact@v8
         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@v7
+        uses: actions/download-artifact@v8
         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@v7
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Install Ruby

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
+## [3.3.0](https://github.com/voxpupuli/beaker_puppet_helpers/tree/3.3.0) (2026-04-02)
+
+[Full Changelog](https://github.com/voxpupuli/beaker_puppet_helpers/compare/3.2.1...3.3.0)
+
+**Implemented enhancements:**
+
+- Implement support for installing staging packages [\#102](https://github.com/voxpupuli/beaker_puppet_helpers/pull/102) ([bastelfreak](https://github.com/bastelfreak))
+
+## [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)
+
+**Fixed bugs:**
+
+- apply\_manifest\_on no longer returns the output of the command [\#99](https://github.com/voxpupuli/beaker_puppet_helpers/issues/99)
+- 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)

data/beaker_puppet_helpers.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'beaker_puppet_helpers'
-  s.version     = '3.2.0'
+  s.version     = '3.3.0'
   s.authors     = ['Vox Pupuli']
   s.email       = ['voxpupuli@groups.io']
   s.homepage    = 'https://github.com/voxpupuli/beaker_puppet_helpers'
@@ -15,6 +15,14 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ['lib']
 
+  s.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'source_code_uri' => 'https://github.com/voxpupuli/beaker_puppet_helpers',
+    'changelog_uri' => 'https://github.com/voxpupuli/beaker_puppet_helpers/blob/main/CHANGELOG.md',
+    'bug_tracker_uri' => 'https://github.com/voxpupuli/beaker_puppet_helpers/issues',
+    'rubygems_mfa_required' => 'true',
+  }
+
   # Run time dependencies
   s.add_dependency 'beaker', '>= 5.8.1', '< 8'
   s.add_dependency 'nokogiri', '~> 1.18', '>= 1.18.10'

data/lib/beaker_puppet_helpers/dsl.rb

@@ -175,13 +175,12 @@ 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)
-          success = true
-        rescue StandardError
-          success = false
-          raise
+          result = on(host, Beaker::PuppetCommand.new('apply', file_path, puppet_apply_opts), **on_options, &block)
+          cleanup = true
+          result
         ensure
           # Respect BEAKER_destroy environment variable for file cleanup
           beaker_destroy = ENV.fetch('BEAKER_destroy', 'always').downcase
@@ -189,9 +188,9 @@ module BeakerPuppetHelpers
                           when 'no', 'never'
                             false
                           when 'onpass'
-                            success
+                            cleanup
                           when 'onfail'
-                            !success
+                            !cleanup
                           else
                             true
                           end

data/lib/beaker_puppet_helpers/install_utils.rb

@@ -172,5 +172,83 @@ module BeakerPuppetHelpers
         host.rm_rf(target)
       end
     end
+
+    # Build the openvox-agent package filename for a given host and version.
+    #
+    # The host's +packaging_platform+ attribute must follow the Beaker
+    # convention: "<variant>-<release>-<arch>", e.g.:
+    #   "el-8-x86_64", "el-9-aarch64", "el-10-x86_64"
+    #   "fedora-42-x86_64"
+    #   "sles-15-x86_64", "sles-16-aarch64"
+    #   "amazon-2-aarch64", "amazon-2023-x86_64"
+    #   "ubuntu-22.04-amd64", "ubuntu-24.04-arm64"
+    #   "debian-11-amd64", "debian-12-arm64"
+    #
+    # @param [Beaker::Host] host     The target host
+    # @param [String]       version  The openvox-agent version, e.g. '8.25.0'
+    # @return [String] the package filename (not a full URL)
+    # @raise [ArgumentError] if the variant is unsupported
+    # @api private
+    def self.openvox_agent_staging_package_filename(host, version)
+      variant, release, arch = host['packaging_platform'].split('-', 3)
+
+      case variant
+      when 'el'
+        "openvox-agent-#{version}-1.el#{release}.#{arch}.rpm"
+      when 'fedora'
+        "openvox-agent-#{version}-1.fc#{release}.#{arch}.rpm"
+      when 'sles'
+        "openvox-agent-#{version}-1.sles#{release}.#{arch}.rpm"
+      when 'amazon'
+        "openvox-agent-#{version}-1.amazon#{release}.#{arch}.rpm"
+      when 'debian', 'ubuntu'
+        "openvox-agent_#{version}-1+#{variant}#{release}_#{arch}.deb"
+      else
+        raise ArgumentError,
+              "No openvox-agent package filename known for variant '#{variant}' " \
+              "(packaging_platform: '#{host['packaging_platform']}'). " \
+              'Supported variants: el, fedora, sles, amazon, debian, ubuntu'
+      end
+    end
+
+    # Install the openvox-agent package on a host by downloading it directly
+    # from an artifact server.
+    #
+    # The correct package filename is derived from the host's +packaging_platform+
+    # attribute (see {.openvox_agent_staging_package_filename} for the expected format).
+    #
+    # @example
+    #   InstallUtils.install_openvox_agent_from_url_on(
+    #     host,
+    #     'https://artifacts.voxpupuli.org/openvox-agent',
+    #     '8.25.0'
+    #   )
+    #
+    # @param [Beaker::Host] host     The host on which to install the package
+    # @param [String] base_url       Base URL of the artifact server, without
+    #                                trailing slash, e.g.
+    #                                'https://artifacts.voxpupuli.org/openvox-agent'
+    # @param [String] version        The agent version to install, e.g. '8.25.0'
+    # @raise [ArgumentError] if the host's packaging_platform variant is unsupported
+    def self.install_openvox_agent_from_url_on(host, base_url, version)
+      filename = openvox_agent_staging_package_filename(host, version)
+      url = "#{base_url}/#{version}/#{filename}"
+      variant = host['packaging_platform'].split('-', 3).first
+
+      case variant
+      when 'el', 'fedora', 'sles', 'amazon'
+        # RPM: install_package accepts a URL directly (calls rpm/yum/zypper)
+        host.install_package(url)
+      when 'debian', 'ubuntu'
+        # Deb: must be downloaded to a local path first, then installed
+        wget_on(host, url) do |filename|
+          host.install_package(filename)
+        end
+      else
+        raise ArgumentError,
+              "No install strategy for variant '#{variant}' " \
+              "(packaging_platform: '#{host['packaging_platform']}')"
+      end
+    end
   end
 end

data/spec/beaker_puppet_helpers/dsl_spec.rb

@@ -175,6 +175,25 @@ 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')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaker_puppet_helpers
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Vox Pupuli
@@ -135,7 +135,12 @@ files:
 homepage: https://github.com/voxpupuli/beaker_puppet_helpers
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/voxpupuli/beaker_puppet_helpers
+  changelog_uri: https://github.com/voxpupuli/beaker_puppet_helpers/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/voxpupuli/beaker_puppet_helpers/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -150,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Beaker's Puppet DSL Extension Helpers
 test_files: []