beaker_puppet_helpers 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb12f94905d8996a9533136b2ba29bd4c70956f2b7914357c943ca111e39869
-  data.tar.gz: 36cfcfa787c4e2ff2b9e20bad58e535c062d88682143a8cc1985f4aa53219bde
+  metadata.gz: 43c0fc876e6e5ec072e587d7637ec6c9cfbed07934d2dea55732383cda9e24ee
+  data.tar.gz: 63fed535614ee30e2e1e01ee5dda0786d55f8681b5dd66b531eabebe52498104
 SHA512:
-  metadata.gz: ce9c0050e80fe4db7d2bfc9fad822456c0740cde672473531c9934b1e6b6bc205cab5305cdf32c2cc842c8b460bd0052bb9d18bad139fd95c3a09a0efb41ceba
-  data.tar.gz: 23b5c9cf10e4aed595a91d017ecf2928b2a2c92be2a1339597fd33edcb02c331527d249cd3d119c33ad1d8bb30d4462af85f2e65ce47377e583351785a204172
+  metadata.gz: 8b78e838186e5cdf9343ee4ad309910845076c3d57cd1ff3fcc6b1b04d3f1d0f8237d2278735ac47e1d33cb4eedfc0ae8318eba30380a87962c0ee8fbee8050b
+  data.tar.gz: f9a3fda821c51b22486d2c8a752051976c8d235ed20e0ab294544fd13f5f8fcc321aaf3945c6da6a0508a7123d5ab3d4bb071559327650a460238fde5e62c310

data/.github/dependabot.yml

@@ -1,17 +1,17 @@
 version: 2
 updates:
-# raise PRs for gem updates
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "13:00"
-  open-pull-requests-limit: 10
+  # raise PRs for gem updates
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "13:00"
+    open-pull-requests-limit: 10
 
-# Maintain dependencies for GitHub Actions
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "13:00"
-  open-pull-requests-limit: 10
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "13:00"
+    open-pull-requests-limit: 10

data/.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
     name: Build the gem
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/test.yml

@@ -7,6 +7,9 @@ on:
     branches:
       - master
 
+permissions:
+  contents: read
+
 env:
   BEAKER_HYPERVISOR: docker
 
@@ -16,7 +19,7 @@ jobs:
     outputs:
       ruby: ${{ steps.ruby.outputs.versions }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
@@ -36,7 +39,7 @@ jobs:
         ruby: ${{ fromJSON(needs.rubocop_and_matrix.outputs.ruby) }}
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file.
 
+## [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)
+
+**Fixed bugs:**
+
+- open-uri: Move from development to runtime dependency [\#83](https://github.com/voxpupuli/beaker_puppet_helpers/pull/83) ([bastelfreak](https://github.com/bastelfreak))
+- nokogiri: Move from dev to runtime dependency [\#82](https://github.com/voxpupuli/beaker_puppet_helpers/pull/82) ([bastelfreak](https://github.com/bastelfreak))
+
+## [3.1.0](https://github.com/voxpupuli/beaker_puppet_helpers/tree/3.1.0) (2025-09-22)
+
+[Full Changelog](https://github.com/voxpupuli/beaker_puppet_helpers/compare/3.0.0...3.1.0)
+
+**Implemented enhancements:**
+
+- \(\#77\) Add support for installing openvox on windows [\#78](https://github.com/voxpupuli/beaker_puppet_helpers/pull/78) ([michael-riddle](https://github.com/michael-riddle))
+
+**Fixed bugs:**
+
+- gemspec: Dont set upper limit for ruby version [\#80](https://github.com/voxpupuli/beaker_puppet_helpers/pull/80) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [3.0.0](https://github.com/voxpupuli/beaker_puppet_helpers/tree/3.0.0) (2025-08-07)
 
 [Full Changelog](https://github.com/voxpupuli/beaker_puppet_helpers/compare/2.3.0...3.0.0)

data/Gemfile

@@ -13,6 +13,8 @@ group :development do
 end
 
 group :test do
+  gem 'fakefs', require: false
+  gem 'irb', require: false
   gem 'rspec', '~> 3.0'
 end
 

data/beaker_puppet_helpers.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'beaker_puppet_helpers'
-  s.version     = '3.0.0'
+  s.version     = '3.1.1'
   s.authors     = ['Vox Pupuli']
   s.email       = ['voxpupuli@groups.io']
   s.homepage    = 'https://github.com/voxpupuli/beaker_puppet_helpers'
@@ -10,13 +10,15 @@ Gem::Specification.new do |s|
   s.description = 'For use for the Beaker acceptance testing tool'
   s.license     = 'Apache-2.0'
 
-  s.required_ruby_version = '>= 3.2', '< 4'
+  s.required_ruby_version = '>= 3.2'
 
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ['lib']
 
   # Run time dependencies
   s.add_dependency 'beaker', '>= 5.8.1', '< 8'
+  s.add_dependency 'nokogiri', '~> 1.18', '>= 1.18.10'
+  s.add_dependency 'open-uri', '< 0.6'
   s.add_dependency 'puppet-modulebuilder', '>= 0.3', '< 3'
 
   s.add_development_dependency 'voxpupuli-rubocop', '~> 4.1.0'

data/lib/beaker_puppet_helpers/windows_utils.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'nokogiri'
+require 'open-uri'
+
+module BeakerPuppetHelpers
+  #
+  # This module contains methods useful for Windows installs
+  #
+  module WindowsUtils
+    # Given a host, returns it's system TEMP path
+    #
+    # @param [Host] host An object implementing {Beaker::Hosts}'s interface.
+    #
+    # @return [String] system temp path
+    def get_system_temp_path(host)
+      host.system_temp_path
+    end
+    alias get_temp_path get_system_temp_path
+
+    # Given the puppet collection, returns the url of the newest msi available in the appropriate repo
+    #
+    # @param [String]
+    #   The collection to install. The default (openvox) is the latest
+    #   available version. Can also be openvox8, puppet8 and others.
+    #
+    # @return [String] url of the newest msi available in the package repo
+    def get_agent_package_url(collection = 'openvox')
+      windows_package_base_url =
+        if collection.start_with?('puppet')
+          'https://downloads.puppetlabs.com/windows/'
+        elsif collection.start_with?('openvox')
+          'https://downloads.voxpupuli.org/windows/'
+        else
+          raise "Unsupported collection: #{collection}"
+        end
+      # If the collection ends in a number, we can infer the package url directly
+      if /\d+$/.match?(collection)
+        windows_package_url = "#{windows_package_base_url}#{collection}/"
+      else
+        # Obtain the list of collections from the appropriate base url and pick the latest
+        base_url = URI.parse(windows_package_base_url)
+        base_response = Net::HTTP.get_response(base_url)
+        raise "Failed to fetch URL: #{base_response.code} #{base_response.message}" unless base_response.is_a?(Net::HTTPSuccess)
+
+        base_doc = Nokogiri::HTML(base_response.body)
+        collection_dirs = base_doc.css('a').filter_map { |a| a['href'] }.grep(/^#{collection}\d+/)
+        raise "No collections found at #{base_url} for colleciton #{collection}" if collection_dirs.empty?
+
+        latest_collection = collection_dirs.max_by do |collection_version|
+          # Grab the digits before the slash and convert to integer
+          collection_version[/\d+/].to_i
+        end
+        windows_package_url = "#{windows_package_base_url}#{latest_collection}"
+      end
+      url = URI.parse(windows_package_url)
+      response = Net::HTTP.get_response(url)
+
+      # Fetch and parse the page
+      raise "Failed to fetch URL: #{response.code} #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+
+      doc = Nokogiri::HTML(response.body)
+
+      # Create the regex for the agent package
+      base_collection_name = collection.gsub(/\d+$/, '')
+      agent_regex = /#{base_collection_name}-agent-(\d+\.\d+\.\d+)-.*\.msi$/i
+      # Extract all hrefs that look like the appropriate MSI files
+      files = doc.css('a').filter_map { |a| a['href'] }.grep(agent_regex)
+
+      raise "No MSI files found at #{windows_package_url}" if files.empty?
+
+      latest_msi = files.max_by do |file|
+        version_str = file.match(agent_regex)[1]
+        Gem::Version.new(version_str)
+      end
+
+      # Remove index.html if it exists in the windows_package_url
+      windows_package_repo = windows_package_url.sub(/index\.html$/, '')
+      # Return the full url to the latest msi
+      "#{windows_package_repo}#{latest_msi}"
+    end
+
+    # Generates commands to be inserted into a Windows batch file to launch an MSI install
+    # @param [String] msi_path The path of the MSI - can be a local Windows style file path like
+    #                   C:\Windows\Temp\puppet-agent.msi OR a url like https://download.com/puppet.msi or file://C:\Windows\Temp\puppet-agent.msi
+    # @param  [Hash{String=>String}] msi_opts MSI installer options
+    # @param [String] log_path The path to write the MSI log - must be a local Windows style file path
+    #
+    # @api private
+    def msi_install_script(msi_path, msi_opts, log_path)
+      # msiexec requires backslashes in file paths launched under cmd.exe start /w
+      url_pattern = %r{^(https?|file)://}
+      msi_path = msi_path.tr('/', '\\') unless msi_path&.match?(url_pattern)
+
+      msi_params = msi_opts.map { |k, v| "#{k}=#{v}" }.join(' ')
+
+      # msiexec requires quotes around paths with backslashes - c:\ or file://c:\
+      # not strictly needed for http:// but it simplifies this code
+      <<~BATCH
+        start /w msiexec.exe /i "#{msi_path}" /qn /L*V #{log_path} #{msi_params}
+        exit /B %errorlevel%
+      BATCH
+    end
+
+    # Given a host, path to MSI and MSI options, will create a batch file
+    #   on the host, returning the path to the randomized batch file and
+    #   the randomized log file
+    #
+    # @param [Host] host An object implementing {Beaker::Hosts}'s interface.
+    # @param [String] msi_path The path of the MSI - can be a local Windows
+    #   style file path like c:\temp\puppet.msi OR a url like
+    #   https://download.com/puppet.msi or file://c:\temp\puppet.msi
+    # @param  [Hash{String=>String}] msi_opts MSI installer options
+    #
+    # @api private
+    # @return [String, String] path to the batch file, patch to the log file
+    def create_install_msi_batch_on(host, msi_path, msi_opts)
+      timestamp = Time.new.strftime('%Y-%m-%d_%H.%M.%S')
+      tmp_path = host.system_temp_path.tr('/', '\\')
+
+      batch_name = "install-puppet-msi-#{timestamp}.bat"
+      batch_path = "#{tmp_path}#{host.scp_separator}#{batch_name}"
+      log_path = "#{tmp_path}\\install-puppet-#{timestamp}.log"
+
+      Tempfile.open(batch_name) do |tmp_file|
+        batch_contents = msi_install_script(msi_path, msi_opts, log_path)
+
+        File.open(tmp_file.path, 'w') { |file| file.puts(batch_contents) }
+        host.do_scp_to(tmp_file.path, batch_path, {})
+      end
+
+      [batch_path, log_path]
+    end
+
+    # Installs a specified MSI package on given hosts.
+    # @param [Host, Array<Host>, String, Symbol] hosts    One or more hosts to act upon,
+    #                            or a role (String or Symbol) that identifies one or more hosts.
+    # @param [String] msi_path
+    #                   The path of the MSI - can be a local Windows style file path like
+    #                   c:\temp\puppet.msi OR a url like https://download.com/puppet.msi or file://c:\temp\puppet.msi
+    #                   can also be a collection like 'puppet', 'puppet8', 'openvox', or 'openvox8'
+    # @param  [Hash{String=>String}] msi_opts MSI installer options
+    # @option msi_opts [String] INSTALLDIR Where Puppet and its dependencies should be installed.
+    #                  (Defaults vary based on operating system and installer architecture)
+    #                  Requires Puppet 2.7.12 / PE 2.5.0
+    # @option msi_opts [String] PUPPET_MASTER_SERVER The hostname where the puppet master server can be reached.
+    #                  (Defaults to puppet)
+    #                  Requires Puppet 2.7.12 / PE 2.5.0
+    # @option msi_opts [String] PUPPET_CA_SERVER The hostname where the CA puppet master server can be reached, if you are using multiple masters and only one of them is acting as the CA.
+    #                  (Defaults the value of PUPPET_MASTER_SERVER)
+    #                  Requires Puppet 2.7.12 / PE 2.5.0
+    # @option msi_opts [String] PUPPET_AGENT_CERTNAME The node’s certificate name, and the name it uses when requesting catalogs. This will set a value for
+    #                  (Defaults to the node's fqdn as discovered by facter fqdn)
+    #                  Requires Puppet 2.7.12 / PE 2.5.0
+    # @option msi_opts [String] PUPPET_AGENT_ENVIRONMENT The node’s environment.
+    #                  (Defaults to production)
+    #                  Requires Puppet 3.3.1 / PE 3.1.0
+    # @option msi_opts [String] PUPPET_AGENT_STARTUP_MODE Whether the puppet agent service should run (or be allowed to run)
+    #                  (Defaults to Manual - valid values are Automatic, Manual or Disabled)
+    #                  Requires Puppet 3.4.0 / PE 3.2.0
+    # @option msi_opts [String] PUPPET_AGENT_ACCOUNT_USER Whether the puppet agent service should run (or be allowed to run)
+    #                  (Defaults to LocalSystem)
+    #                  Requires Puppet 3.4.0 / PE 3.2.0
+    # @option msi_opts [String] PUPPET_AGENT_ACCOUNT_PASSWORD The password to use for puppet agent’s user account
+    #                  (No default)
+    #                  Requires Puppet 3.4.0 / PE 3.2.0
+    # @option msi_opts [String] PUPPET_AGENT_ACCOUNT_DOMAIN The domain of puppet agent’s user account.
+    #                  (Defaults to .)
+    #                  Requires Puppet 3.4.0 / PE 3.2.0
+    # @param  [Hash] opts Options hash to control installation behavior.
+    #
+    # @example
+    #  install_msi_on(hosts, 'c:\\puppet.msi', msi_opts: {'PUPPET_AGENT_STARTUP_MODE' => 'Manual'}, opts: {:debug => true})
+    #
+    # @api private
+    def install_msi_on(hosts, msi_path, msi_opts: {}, opts: {})
+      # If the msi patch matches a collection, get the url for the latest msi available for that collection
+      expanded_msi_path = /^(puppet|openvox)\d*$/.match?(msi_path) ? get_agent_package_url(msi_path) : msi_path
+      block_on hosts do |host|
+        msi_opts['PUPPET_AGENT_STARTUP_MODE'] ||= 'Manual'
+        batch_path, log_file = create_install_msi_batch_on(host, expanded_msi_path, msi_opts)
+        # Powershell command looses an escaped slash resulting in cygwin relative path
+        # See https://github.com/puppetlabs/beaker/pull/1626#issuecomment-621341555
+        log_file_escaped = log_file.gsub('\\', '\\\\\\')
+        # begin / rescue here so that we can reuse existing error msg propagation
+        begin
+          # 1641 = ERROR_SUCCESS_REBOOT_INITIATED
+          # 3010 = ERROR_SUCCESS_REBOOT_REQUIRED
+          on host, Beaker::Command.new("\"#{batch_path}\"", [], { cmdexe: true }), acceptable_exit_codes: [0, 1641, 3010]
+        rescue StandardError
+          logger.info(file_contents_on(host, log_file_escaped))
+          raise
+        end
+
+        logger.info(file_contents_on(host, log_file_escaped)) if opts[:debug]
+
+        unless host.is_cygwin?
+          # Enable the PATH updates
+          host.close
+
+          # Some systems require a full reboot to trigger the enabled path
+          host.reboot unless on(host, Beaker::Command.new('puppet -h', [], { cmdexe: true }),
+                                accept_all_exit_codes: true).exit_code.zero?
+        end
+
+        # verify service status post install
+        # if puppet service exists, then pe-puppet is not queried
+        # if puppet service does not exist, pe-puppet is queried and that exit code is used
+        # therefore, this command will always exit 0 if either service is installed
+        #
+        # We also take advantage of this output to verify the startup
+        # settings are honored as supplied to the MSI
+        on host, Beaker::Command.new('sc qc puppet || sc qc pe-puppet', [], { cmdexe: true }) do |result|
+          output = result.stdout
+          startup_mode = msi_opts['PUPPET_AGENT_STARTUP_MODE'].upcase
+
+          search = case startup_mode # rubocop:disable Style/HashLikeCase
+                   when 'AUTOMATIC'
+                     { code: 2, name: 'AUTO_START' }
+                   when 'MANUAL'
+                     { code: 3, name: 'DEMAND_START' }
+                   when 'DISABLED'
+                     { code: 4, name: 'DISABLED' }
+                   end
+
+          raise "puppet service startup mode did not match supplied MSI option '#{startup_mode}'" unless /^\s+START_TYPE\s+:\s+#{search[:code]}\s+#{search[:name]}/.match?(output)
+        end
+
+        # (PA-514) value for PUPPET_AGENT_STARTUP_MODE should be present in
+        # registry and honored after install/upgrade.
+        reg_key = if host.is_x86_64?
+                    'HKLM\\SOFTWARE\\Wow6432Node\\Puppet Labs\\PuppetInstaller'
+                  else
+                    'HKLM\\SOFTWARE\\Puppet Labs\\PuppetInstaller'
+                  end
+        reg_query_command = %(reg query "#{reg_key}" /v "RememberedPuppetAgentStartupMode" | findstr #{msi_opts['PUPPET_AGENT_STARTUP_MODE']})
+        on host, Beaker::Command.new(reg_query_command, [], { cmdexe: true })
+
+        # emit the misc/versions.txt file which contains component versions for
+        # puppet, facter, hiera, pxp-agent, packaging and vendored Ruby
+        [
+          "'%PROGRAMFILES%\\Puppet Labs\\puppet\\misc\\versions.txt'",
+          "'%PROGRAMFILES(X86)%\\Puppet Labs\\puppet\\misc\\versions.txt'",
+        ].each do |path|
+          result = on(host, "cmd /c type #{path}", accept_all_exit_codes: true)
+          if result.exit_code.zero?
+            logger.info(result.stdout)
+            break
+          end
+        end
+      end
+    end
+
+    # Installs a specified msi path on given hosts
+    # @param [Host, Array<Host>, String, Symbol] hosts    One or more hosts to act upon,
+    #                            or a role (String or Symbol) that identifies one or more hosts.
+    # @param [String] msi_path
+    #                   The path of the MSI - can be a local Windows style file path like
+    #                   c:\temp\foo.msi OR a url like https://download.com/foo.msi or file://c:\temp\foo.msi
+    #                   can also be a collection like 'puppet', 'puppet8', 'openvox', or 'openvox8'
+    # @param  [Hash{String=>String}] msi_opts MSI installer options
+    # @param  [Hash] opts Options hash to control installation behavior.
+    #
+    # @example
+    #  generic_install_msi_on(hosts, 'https://releases.hashicorp.com/vagrant/1.8.4/vagrant_1.8.4.msi', msi_opts: {}, opts: {:debug => true})
+    #
+    # @api private
+    def generic_install_msi_on(hosts, msi_path, msi_opts: {}, opts: {})
+      # If the msi patch matches a collection, get the url for the latest msi available for that collection
+      expanded_msi_path = /^(puppet|openvox)\d*$/.match?(msi_path) ? get_agent_package_url(msi_path) : msi_path
+
+      block_on hosts do |host|
+        batch_path, log_file = create_install_msi_batch_on(host, expanded_msi_path, msi_opts)
+        # Powershell command looses an escaped slash resulting in cygwin relative path
+        # See https://github.com/puppetlabs/beaker/pull/1626#issuecomment-621341555
+        log_file_escaped = log_file.gsub('\\', '\\\\\\')
+        # begin / rescue here so that we can reuse existing error msg propagation
+        begin
+          # 1641 = ERROR_SUCCESS_REBOOT_INITIATED
+          # 3010 = ERROR_SUCCESS_REBOOT_REQUIRED
+          on host, Beaker::Command.new("\"#{batch_path}\"", [], { cmdexe: true }), acceptable_exit_codes: [0, 1641, 3010]
+        rescue StandardError
+          logger.info(file_contents_on(host, log_file_escaped))
+
+          raise
+        end
+
+        logger.info(file_contents_on(host, log_file_escaped)) if opts[:debug]
+
+        host.close unless host.is_cygwin?
+      end
+    end
+  end
+end

data/lib/beaker_puppet_helpers.rb

@@ -5,8 +5,10 @@ module BeakerPuppetHelpers
   autoload :DSL, File.join(__dir__, 'beaker_puppet_helpers', 'dsl.rb')
   autoload :InstallUtils, File.join(__dir__, 'beaker_puppet_helpers', 'install_utils.rb')
   autoload :ModuleUtils, File.join(__dir__, 'beaker_puppet_helpers', 'module_utils.rb')
+  autoload :WindowsUtils, File.join(__dir__, 'beaker_puppet_helpers', 'windows_utils.rb')
 end
 
 require 'beaker'
 Beaker::DSL.register(BeakerPuppetHelpers::DSL)
 Beaker::DSL.register(BeakerPuppetHelpers::ModuleUtils)
+Beaker::DSL.register(BeakerPuppetHelpers::WindowsUtils)

data/spec/beaker_puppet_helpers/windows_utils_spec.rb

@@ -0,0 +1,403 @@
+# frozen_string_literal: true
+
+# rubocop:disable RSpec/MultipleMemoizedHelpers
+require 'spec_helper'
+
+class ClassMixedWithDSLInstallUtils
+  include Beaker::DSL::Patterns
+  include BeakerPuppetHelpers::WindowsUtils
+
+  def logger
+    @logger ||= RSpec::Mocks::Double.new('Beaker::Logger').as_null_object
+  end
+end
+
+describe BeakerPuppetHelpers::WindowsUtils do
+  subject(:dsl) { ClassMixedWithDSLInstallUtils.new }
+
+  let(:windows_temp) { 'C:\\Windows\\Temp' }
+  let(:batch_path) { '/fake/batch/path' }
+  let(:msi_path)            { 'c:\\foo\\puppet.msi' }
+  let(:winhost)             do
+    make_host('winhost',
+              { platform: Beaker::Platform.new('windows-2008r2-64'),
+                pe_ver: '3.0',
+                working_dir: '/tmp',
+                is_cygwin: true, })
+  end
+  let(:winhost_non_cygwin) do
+    make_host('winhost_non_cygwin',
+              { platform: 'windows',
+                pe_ver: '3.0',
+                working_dir: '/tmp',
+                is_cygwin: 'false', })
+  end
+  let(:hosts) { [winhost, winhost_non_cygwin] }
+
+  def expect_install_called
+    result = Beaker::Result.new(nil, 'temp')
+    result.exit_code = 0
+
+    hosts.each do |host|
+      expectation = expect(subject).to receive(:on).with(host, having_attributes(command: "\"#{batch_path}\""),
+                                                         anything).and_return(result)
+      if block_given?
+        should_break = yield expectation
+        break if should_break
+      end
+    end
+  end
+
+  def expect_status_called(start_type = 'DEMAND_START')
+    result = Beaker::Result.new(nil, 'temp')
+    result.exit_code = 0
+    result.stdout = case start_type
+                    when 'DISABLED'
+                      '        START_TYPE         : 4   DISABLED'
+                    when 'AUTOMATIC'
+                      '        START_TYPE         : 2   AUTO_START'
+                    else # 'DEMAND_START'
+                      '        START_TYPE         : 3   DEMAND_START'
+                    end
+
+    hosts.each do |host|
+      expect(subject).to receive(:on).with(host,
+                                           having_attributes(command: 'sc qc puppet || sc qc pe-puppet')).and_yield(result)
+    end
+  end
+
+  def expect_version_log_called(_times = hosts.length)
+    path = "'%PROGRAMFILES%\\Puppet Labs\\puppet\\misc\\versions.txt'"
+
+    result = Beaker::Result.new(nil, 'temp')
+    result.exit_code = 0
+
+    hosts.each do |host|
+      expect(subject).to receive(:on).with(host, "cmd /c type #{path}", anything).and_return(result)
+    end
+  end
+
+  def expect_reg_query_called(_times = hosts.length)
+    expect(hosts).to all(receive(:is_x86_64?).and_return(true))
+
+    hosts.each do |host|
+      expect(subject).to receive(:on)
+        .with(host, having_attributes(command: /reg query "HKLM\\SOFTWARE\\Wow6432Node\\Puppet Labs\\PuppetInstaller/))
+    end
+  end
+
+  def expect_puppet_path_called
+    hosts.each do |host|
+      next if host.is_cygwin?
+
+      result = Beaker::Result.new(nil, 'temp')
+      result.exit_code = 0
+
+      expect(subject).to receive(:on)
+        .with(host, having_attributes(command: 'puppet -h'), anything)
+        .and_return(result)
+    end
+  end
+
+  describe '#get_agent_package_url' do
+    let(:base_package_repo_html) do
+      <<-HTML
+        <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+        <html>
+          <head>
+            <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+            <title>Index of /windows/</title>
+          </head>
+          <body>
+            <h1>Index of /windows/</h1>
+            <hr>
+              <pre>
+                <a href="../">../</a>
+                <a href="openvox7/">openvox7/</a>
+                <a href="openvox8/">openvox8/</a>
+              </pre>
+            <hr>
+          </body>
+        </html>
+      HTML
+    end
+    let(:package_repo_html) do
+      <<-HTML
+        <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+        <html>
+          <head>
+            <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+            <title>Index of /windows/openvox8/</title>
+          </head>
+          <body>
+            <h1>Index of /windows/openvox8/</h1>
+            <hr>
+              <pre>
+                <a href="../">../</a>
+                <a href="unsigned/">unsigned/</a>
+                <a href="openvox-agent-8.19.2-x64.msi">openvox-agent-8.19.2-x64.msi</a>
+                <a href="openvox-agent-8.21.2-rc1-x64.msi">openvox-agent-8.21.2-rc1-x64.msi</a>
+                <a href="openvox-agent-8.22.0-x64.msi">openvox-agent-8.22.0-x64.msi</a>
+                <a href="openvox-agent-8.22.1-x64.msi">openvox-agent-8.22.1-x64.msi</a>
+                <a href="openvox-agent-8.23.0-x64.msi">openvox-agent-8.23.0-x64.msi</a>
+                <a href="openvox-agent-8.23.1-x64.msi">openvox-agent-8.23.1-x64.msi</a>
+              </pre>
+            <hr>
+          </body>
+        </html>
+      HTML
+    end
+
+    before do
+      # Stub Net::HTTP.get_response for base url and final url
+      allow(Net::HTTP).to receive(:get_response) do |uri|
+        case uri.to_s
+        when 'https://downloads.voxpupuli.org/windows/'
+          instance_double(Net::HTTPOK, is_a?: true, body: base_package_repo_html)
+        when 'https://downloads.voxpupuli.org/windows/openvox8/'
+          instance_double(Net::HTTPOK, is_a?: true, body: package_repo_html)
+        else
+          raise "Unexpected URL: #{uri}"
+        end
+      end
+    end
+
+    it 'returns the latest MSI URL for the openvox collection' do
+      result = dsl.get_agent_package_url('openvox')
+      expect(result).to eq('https://downloads.voxpupuli.org/windows/openvox8/openvox-agent-8.23.1-x64.msi')
+    end
+
+    it 'returns the latest MSI URL for the openvox8 collection' do
+      result = dsl.get_agent_package_url('openvox8')
+      expect(result).to eq('https://downloads.voxpupuli.org/windows/openvox8/openvox-agent-8.23.1-x64.msi')
+    end
+
+    it 'raises for unsupported collection prefix' do
+      expect { dsl.get_agent_package_url('foo') }.to raise_error('Unsupported collection: foo')
+    end
+
+    it 'raises when no MSI files found' do
+      empty_html = '<html><body></body></html>'
+      allow(Net::HTTP).to receive(:get_response).and_return(
+        instance_double(Net::HTTPOK, is_a?: true, body: empty_html),
+      )
+      expect { dsl.get_agent_package_url('openvox8') }.to raise_error('No MSI files found at https://downloads.voxpupuli.org/windows/openvox8/')
+    end
+  end
+
+  describe '#install_msi_on' do
+    let(:log_file) { '/fake/log/file.log' }
+
+    before do
+      result = Beaker::Result.new(nil, 'temp')
+      result.exit_code = 0
+
+      hosts.each do |host|
+        allow(dsl).to receive(:on)
+          .with(host, having_attributes(command: "\"#{batch_path}\""))
+          .and_return(result)
+      end
+
+      allow(dsl).to receive(:create_install_msi_batch_on).and_return([batch_path, log_file])
+    end
+
+    it 'specifies a PUPPET_AGENT_STARTUP_MODE of Manual by default' do
+      expect_install_called
+      expect_puppet_path_called
+      expect_status_called
+      expect_reg_query_called
+      expect_version_log_called
+      expect(dsl).to receive(:create_install_msi_batch_on).with(anything, anything, { 'PUPPET_AGENT_STARTUP_MODE' => 'Manual' })
+      dsl.install_msi_on(hosts, msi_path, msi_opts: {})
+    end
+
+    it 'allows configuration of PUPPET_AGENT_STARTUP_MODE to Automatic' do
+      expect_install_called
+      expect_puppet_path_called
+      expect_status_called('AUTOMATIC')
+      expect_reg_query_called
+      expect_version_log_called
+      value = 'Automatic'
+      expect(dsl).to receive(:create_install_msi_batch_on).with(anything, anything, { 'PUPPET_AGENT_STARTUP_MODE' => value })
+      dsl.install_msi_on(hosts, msi_path, msi_opts: { 'PUPPET_AGENT_STARTUP_MODE' => value })
+    end
+
+    it 'allows configuration of PUPPET_AGENT_STARTUP_MODE to Disabled' do
+      expect_install_called
+      expect_puppet_path_called
+      expect_status_called('DISABLED')
+      expect_reg_query_called
+      expect_version_log_called
+      value = 'Disabled'
+      expect(dsl).to receive(:create_install_msi_batch_on).with(anything, anything, { 'PUPPET_AGENT_STARTUP_MODE' => value })
+      dsl.install_msi_on(hosts, msi_path, msi_opts: { 'PUPPET_AGENT_STARTUP_MODE' => value })
+    end
+
+    it 'does not generate a command to emit a log file without the :debug option set' do
+      expect_install_called
+      expect_puppet_path_called
+      expect_status_called
+      expect_reg_query_called
+      expect_version_log_called
+
+      expect(dsl).not_to receive(:file_contents_on).with(anything, log_file)
+
+      dsl.install_msi_on(hosts, msi_path)
+    end
+
+    it 'generates a command to emit a log file when the install script fails' do
+      # NOTE: a single failure aborts executing against remaining hosts
+      expect_install_called do |e|
+        e.and_raise
+        true # break
+      end
+
+      expect(dsl).to receive(:file_contents_on).with(anything, log_file)
+      expect do
+        dsl.install_msi_on(hosts, msi_path)
+      end.to raise_error(RuntimeError)
+    end
+
+    it 'generates a command to emit a log file with the :debug option set' do
+      expect_install_called
+      expect_reg_query_called
+      expect_puppet_path_called
+      expect_status_called
+      expect_version_log_called
+
+      expect(dsl).to receive(:file_contents_on).with(anything, log_file).exactly(hosts.length).times
+
+      dsl.install_msi_on(hosts, msi_path, msi_opts: {}, opts: { debug: true })
+    end
+
+    it 'passes msi_path to #create_install_msi_batch_on as-is' do
+      expect_install_called
+      expect_reg_query_called
+      expect_puppet_path_called
+      expect_status_called
+      expect_version_log_called
+      test_path = 'test/path'
+      expect(dsl).to receive(:create_install_msi_batch_on).with(anything, test_path, anything)
+      dsl.install_msi_on(hosts, test_path)
+    end
+
+    it 'searches in Wow6432Node for the remembered startup setting on 64-bit hosts' do
+      expect_install_called
+      expect_puppet_path_called
+      expect_status_called
+      expect_version_log_called
+
+      hosts.each do |host|
+        expect(host).to receive(:is_x86_64?).and_return(true)
+
+        expect(dsl).to receive(:on).with(host, having_attributes(command: 'reg query "HKLM\\SOFTWARE\\Wow6432Node\\Puppet Labs\\PuppetInstaller" /v "RememberedPuppetAgentStartupMode" | findstr Manual'))
+      end
+
+      dsl.install_msi_on(hosts, msi_path, msi_opts: { 'PUPPET_AGENT_STARTUP_MODE' => 'Manual' })
+    end
+
+    it 'omits Wow6432Node in the registry search for remembered startup setting on 32-bit hosts' do
+      expect_install_called
+      expect_puppet_path_called
+      expect_status_called
+      expect_version_log_called
+
+      hosts.each do |host|
+        expect(host).to receive(:is_x86_64?).and_return(false)
+
+        expect(dsl).to receive(:on).with(host, having_attributes(command: 'reg query "HKLM\\SOFTWARE\\Puppet Labs\\PuppetInstaller" /v "RememberedPuppetAgentStartupMode" | findstr Manual'))
+      end
+
+      dsl.install_msi_on(hosts, msi_path, msi_opts: { 'PUPPET_AGENT_STARTUP_MODE' => 'Manual' })
+    end
+  end
+
+  describe '#create_install_msi_batch_on' do
+    let(:tmp) { '/tmp/create_install_msi_batch_on' }
+    let(:tmp_slashes) { tmp.tr('/', '\\') }
+
+    before do
+      FakeFS::FileSystem.add(File.expand_path(tmp))
+      hosts.each do |host|
+        allow(host).to receive(:system_temp_path).and_return(tmp)
+      end
+    end
+
+    it 'passes msi_path & msi_opts down to #msi_install_script' do
+      allow(winhost).to receive(:do_scp_to)
+      test_path = '/path/to/test/with/13540'
+      test_opts = { 'key1' => 'val1', 'key2' => 'val2' }
+      expect(dsl).to receive(:msi_install_script).with(
+        test_path, test_opts, anything
+      )
+      dsl.create_install_msi_batch_on(winhost, test_path, test_opts)
+    end
+
+    it 'SCPs to & returns the same batch file path, corrected for slashes' do
+      test_time = Time.now
+      allow(Time).to receive(:new).and_return(test_time)
+      timestamp = test_time.strftime('%Y-%m-%d_%H.%M.%S')
+
+      correct_path = "#{tmp_slashes}\\install-puppet-msi-#{timestamp}.bat"
+      expect(winhost).to receive(:do_scp_to).with(anything, correct_path, {})
+      test_path, = dsl.create_install_msi_batch_on(winhost, msi_path, {})
+      expect(test_path).to eq(correct_path)
+    end
+
+    it 'returns & sends log_path to #msi_install_scripts, corrected for slashes' do
+      allow(winhost).to receive(:do_scp_to)
+      test_time = Time.now
+      allow(Time).to receive(:new).and_return(test_time)
+      timestamp = test_time.strftime('%Y-%m-%d_%H.%M.%S')
+
+      correct_path = "#{tmp_slashes}\\install-puppet-#{timestamp}.log"
+      expect(dsl).to receive(:msi_install_script).with(anything, anything, correct_path)
+      _, log_path = dsl.create_install_msi_batch_on(winhost, msi_path, {})
+      expect(log_path).to eq(correct_path)
+    end
+  end
+
+  describe '#msi_install_script' do
+    let(:log_path) { '/log/msi_install_script' }
+
+    context 'with msi_params parameter' do
+      it 'can take an empty hash' do
+        expected_cmd = %r{^start /w msiexec\.exe /i ".*" /qn /L\*V #{log_path}\ .exit}m
+        expect(dsl.msi_install_script(msi_path, {}, log_path)).to match(expected_cmd)
+      end
+
+      it 'uses a key-value pair correctly' do
+        params = { 'tk1' => 'tv1' }
+        expected_cmd = %r{^start /w msiexec\.exe /i ".*" /qn /L\*V #{log_path}\ tk1=tv1}
+        expect(dsl.msi_install_script(msi_path, params, log_path)).to match(expected_cmd)
+      end
+
+      it 'uses multiple key-value pairs correctly' do
+        params = { 'tk1' => 'tv1', 'tk2' => 'tv2' }
+        expected_cmd = %r{^start /w msiexec\.exe /i ".*" /qn /L\*V #{log_path}\ tk1=tv1\ tk2=tv2}
+        expect(dsl.msi_install_script(msi_path, params, log_path)).to match(expected_cmd)
+      end
+    end
+
+    context 'with msi_path parameter' do
+      it 'generates an appropriate command with a MSI file path using non-Windows slashes' do
+        msi_path = 'c:/foo/puppet.msi'
+        expected_cmd = %r{^start /w msiexec\.exe /i "c:\\foo\\puppet.msi" /qn /L\*V #{log_path}}
+        expect(dsl.msi_install_script(msi_path, {}, log_path)).to match(expected_cmd)
+      end
+
+      it 'generates an appropriate command with a MSI http(s) url' do
+        msi_url = 'https://downloads.puppetlabs.com/puppet.msi'
+        expected_cmd = %r{^start /w msiexec\.exe /i "https://downloads\.puppetlabs\.com/puppet\.msi" /qn /L\*V #{log_path}}
+        expect(dsl.msi_install_script(msi_url, {}, log_path)).to match(expected_cmd)
+      end
+
+      it 'generates an appropriate command with a MSI file url' do
+        msi_url = 'file://c:\\foo\\puppet.msi'
+        expected_cmd = %r{^start /w msiexec\.exe /i "file://c:\\foo\\puppet\.msi" /qn /L\*V #{log_path}}
+        expect(dsl.msi_install_script(msi_url, {}, log_path)).to match(expected_cmd)
+      end
+    end
+  end
+end
+# rubocop:enable RSpec/MultipleMemoizedHelpers

data/spec/helpers.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module HostHelpers
+  HOST_DEFAULTS = { platform: 'unix',
+                    roles: ['agent'],
+                    snapshot: 'snap',
+                    ip: 'default.ip.address',
+                    private_ip: 'private.ip.address',
+                    dns_name: 'default.box.tld',
+                    box: 'default_box_name',
+                    box_url: 'http://default.box.url',
+                    image: 'default_image',
+                    flavor: 'm1.large',
+                    user_data: '#cloud-config\nmanage_etc_hosts: true\nfinal_message: "The host is finally up!"', }.freeze
+
+  HOST_NAME     = 'vm%d'
+  HOST_SNAPSHOT = 'snapshot%d'
+  HOST_IP       = 'ip.address.for.%s'
+  HOST_BOX      = 'vm2%s_of_my_box'
+  HOST_BOX_URL  = 'http://address.for.my.box.%s'
+  HOST_DNS_NAME = '%s.box.tld'
+  HOST_TEMPLATE = '%s_has_a_template'
+  HOST_PRIVATE_IP = 'private.ip.for.%s'
+
+  def logger
+    instance_double(Logger).as_null_object
+  end
+
+  def make_opts
+    opts = Beaker::Options::Presets.new
+    opts.presets.merge(opts.env_vars).merge({ logger: logger,
+                                              host_config: 'sample.config',
+                                              type: nil,
+                                              pooling_api: 'http://vcloud.delivery.puppetlabs.net/',
+                                              datastore: 'instance0',
+                                              folder: 'Delivery/Quality Assurance/Staging/Dynamic',
+                                              resourcepool: 'delivery/Quality Assurance/Staging/Dynamic',
+                                              gce_project: 'beaker-compute',
+                                              gce_keyfile: '/path/to/keyfile.p12',
+                                              gce_password: 'notasecret',
+                                              gce_email: '12345678910@developer.gserviceaccount.com',
+                                              openstack_api_key: 'P1as$w0rd',
+                                              openstack_username: 'user',
+                                              openstack_auth_url: 'http://openstack_hypervisor.labs.net:5000/v2.0/tokens',
+                                              openstack_tenant: 'testing',
+                                              openstack_network: 'testing',
+                                              openstack_keyname: 'nopass',
+                                              floating_ip_pool: 'my_pool',
+                                              security_group: %w[my_sg default], })
+  end
+
+  def generate_result(name, opts)
+    stdout = opts.key?(:stdout) ? opts[:stdout] : name
+    stderr = opts.key?(:stderr) ? opts[:stderr] : name
+    exit_code = opts.key?(:exit_code) ? opts[:exit_code] : 0
+    exit_code = [exit_code].flatten
+    result = instance_double(Beaker::Result, stdout: stdout, stderr: stderr)
+    allow(result).to receive_messages(stdout: stdout, stderr: stderr)
+    allow(result).to receive(:exit_code).and_return(*exit_code)
+    result
+  end
+
+  def make_host_opts(name, opts)
+    make_opts.merge({ 'HOSTS' => { name => opts } }).merge(opts)
+  end
+
+  def make_host(name, host_hash)
+    host_hash = Beaker::Options::OptionsHash.new.merge(HOST_DEFAULTS.merge(host_hash))
+
+    host = Beaker::Host.create(name, host_hash, make_opts)
+
+    allow(host).to receive(:exec).and_return(generate_result(name, host_hash))
+    allow(host).to receive(:close)
+    host
+  end
+
+  def make_hosts(preset_opts = {}, amt = 3)
+    hosts = []
+    (1..amt).each do |num|
+      name = HOST_NAME % num
+      opts = { snapshot: HOST_SNAPSHOT % num,
+               ip: HOST_IP % name,
+               private_ip: HOST_PRIVATE_IP % name,
+               dns_name: HOST_DNS_NAME % name,
+               template: HOST_TEMPLATE % name,
+               box: HOST_BOX % name,
+               box_url: HOST_BOX_URL % name, }.merge(preset_opts)
+      hosts << make_host(name, opts)
+    end
+    hosts
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,14 @@
 # frozen_string_literal: true
 
 require 'beaker_puppet_helpers'
+
+# require 'pp' statement needed before fakefs, otherwise they can collide. Ref:
+#   https://github.com/fakefs/fakefs#fakefs-----typeerror-superclass-mismatch-for-class-file
+require 'pp'
+require 'fakefs/spec_helpers'
+require 'helpers'
+
+RSpec.configure do |config|
+  config.include FakeFS::SpecHelpers
+  config.include HostHelpers
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaker_puppet_helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Vox Pupuli
@@ -29,6 +29,40 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.18.10
+- !ruby/object:Gem::Dependency
+  name: open-uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: puppet-modulebuilder
   requirement: !ruby/object:Gem::Requirement
@@ -91,9 +125,12 @@ files:
 - lib/beaker_puppet_helpers/dsl.rb
 - lib/beaker_puppet_helpers/install_utils.rb
 - lib/beaker_puppet_helpers/module_utils.rb
+- lib/beaker_puppet_helpers/windows_utils.rb
 - spec/beaker_puppet_helpers/dsl_spec.rb
 - spec/beaker_puppet_helpers/install_utils_spec.rb
 - spec/beaker_puppet_helpers/module_utils_spec.rb
+- spec/beaker_puppet_helpers/windows_utils_spec.rb
+- spec/helpers.rb
 - spec/spec_helper.rb
 homepage: https://github.com/voxpupuli/beaker_puppet_helpers
 licenses:
@@ -107,9 +144,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '3.2'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="