beaker-puppet 1.19.1 → 1.22.0

data/CODEOWNERS

@@ -1,3 +0,0 @@
-#This Repository is maintained by both the beaker and Night's Watch teams, depending on the location of the changes
-* @puppetlabs/beaker
-* @puppetlabs/night-s-watch

data/Gemfile

@@ -2,8 +2,6 @@ source ENV['GEM_SOURCE'] || "https://rubygems.org"
 
 gemspec
 
-
-
 def location_for(place, fake_version = nil)
   if place =~ /^(git:[^#]*)#(.*)/
     [fake_version, { :git => $1, :branch => $2, :require => false }].compact
@@ -16,11 +14,15 @@ end
 
 
 group :test do
-  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || ['>= 4.16.0', '< 5.0.0'])
+  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || ['>= 4.30.0', '< 5.0.0'])
   gem "beaker-abs", *location_for(ENV['ABS_VERSION'] || '~> 0.4.0')
 end
 
+group :release do
+  gem 'github_changelog_generator', require: false
+end
 
-if File.exists? "#{__FILE__}.local"
-  eval(File.read("#{__FILE__}.local"), binding)
+group :coverage, optional: ENV['COVERAGE']!='yes' do
+  gem 'simplecov-console', :require => false
+  gem 'codecov', :require => false
 end

data/README.md

@@ -1,51 +1,39 @@
 # beaker-puppet: The Puppet-Specific Beaker Library
 
+[![License](https://img.shields.io/github/license/voxpupuli/beaker-puppet.svg)](https://github.com/voxpupuli/beaker-puppet/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/beaker-puppet/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/beaker-puppet/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/voxpupuli/beaker-puppet/branch/master/graph/badge.svg?token=Mypkl78hvK)](https://codecov.io/gh/voxpupuli/beaker-puppet)
+[![Release](https://github.com/voxpupuli/beaker-puppet/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/beaker-puppet/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/beaker-puppet.svg)](https://rubygems.org/gems/beaker-puppet)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/beaker-puppet.svg)](https://rubygems.org/gems/beaker-puppet)
+[![Donated by Puppet Inc](https://img.shields.io/badge/donated%20by-Puppet%20Inc-fb7047.svg)](#transfer-notice)
+
 The purpose of this library is to hold all puppet-specific info & DSL methods.
 This includes all helper & installer methods.
 
 It might not be up to that state yet, but that's the goal for this library. If
 you see anything puppet-specific that you'd like to pull into this library out
-of beaker, please do, we would love any help that you'd like to provide. 
+of beaker, please do, we would love any help that you'd like to provide.
 
 # How Do I Use This?
 
-## With Beaker 3.x
-
-This library is included as a dependency of Beaker 3.x versions and is automatically included, so there's nothing to do.
-
-## With Beaker 4.x
-
-As of Version 1.0 of `beaker-puppet`, the minimum supported version of beaker is Version 4.0. If you use `ENV['BEAKER_VERSION']`, you will have to ensure that this is compatible, and that if you are using a local Git repository it is up to date.
+You will need to include beaker-puppet alongside Beaker in your Gemfile or project.gemspec. E.g.
 
-As of beaker 4.0, all hypervisor and DSL extension libraries have been removed and are no longer dependencies. In order to use a specific hypervisor or DSL extension library in your project, you will need to include them alongside Beaker in your Gemfile or project.gemspec. E.g.
-
-~~~ruby
+```ruby
 # Gemfile
 gem 'beaker', '~>4.0'
 gem 'beaker-puppet', '~>1.0'
 # project.gemspec
 s.add_runtime_dependency 'beaker', '~>4.0'
 s.add_runtime_dependency 'beaker-puppet', '~>1.0'
-~~~
-
-For DSL Extension Libraries, you must also ensure that you `require` the library in your test files. You can do this manually in individual test files or in a test helper (if you have one). You can [use `Bundler.require()`](https://bundler.io/v1.16/guides/groups.html) to require the library automatically.
-
-### Right Now? (beaker 3.x)
-
-At this point, beaker-puppet is included in beaker, so you don't have to _do_
-anything to get the methods in this library.
-
-You can use these methods in a test by referencing them by name without
-qualifications, as they're included in the beaker DSL by default.
-
-### In beaker's Next Major Version? (beaker 4.x)
+```
 
-In beaker's next major version, the requirement for beaker-puppet will be pulled
-from that repo. When that happens, then the usage pattern will change. In order
-to use this then, you'll need to include beaker-puppet as a dependency right
-next to beaker itself.
+For DSL Extension Libraries, you must also ensure that you `require` the
+library in your test files. You can do this manually in individual test files
+or in a test helper (if you have one). You can [use
+`Bundler.require()`](https://bundler.io/v1.16/guides/groups.html) to require
+the library automatically. To explicitly require it:
 
-Once you've done that & installed the gems, in your test, you'll have to
 ```ruby
 require 'beaker-puppet'
 ```
@@ -74,16 +62,24 @@ file, or you can provide a beaker-hostgenerator value to the `TEST_TARGET`
 environment variable. You can also specify the tests that get executed with the
 `TESTS` environment variable.
 
-# Contributing
+## Transfer Notice
+
+This plugin was originally authored by [Puppet Inc](http://puppet.com).
+The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred over, please fork and continue to contribute here.
+
+Previously: https://github.com/puppetlabs/beaker
 
-Please refer to puppetlabs/beaker's [contributing](https://github.com/puppetlabs/beaker/blob/master/CONTRIBUTING.md) guide.
+## License
 
-# Releasing
+This gem is licensed under the Apache-2 license.
 
-To release new versions of beaker-puppet, please use the [jenkins job](https://cinext-jenkinsmaster-sre-prod-1.delivery.puppetlabs.net/job/qe_beaker-puppet_init-multijob_master/). This job
-lives on internal infrastructure.
+## Release information
 
-To run the job, click on `Build with Parameters` in the menu on the left. Make
-sure you check the box next to `PUBLIC` and enter the appropriate version. The
-version should adhere to semantic version standards. When in doubt, consult the
-maintainers of Beaker for guidance.
+To make a new release, please do:
+* update the version in `lib/beaker-puppet/version.rb`
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Check if the new version matches the closed issues/PRs in the changelog
+* Create a PR with it
+* After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages

data/Rakefile

@@ -297,3 +297,16 @@ namespace :docs do
     end
   end
 end
+
+begin
+  require 'github_changelog_generator/task'
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
+    config.exclude_labels = %w{duplicate question invalid wontfix wont-fix skip-changelog}
+    config.user = 'voxpupuli'
+    config.project = 'beaker-puppet'
+    config.future_release = "v#{Gem::Specification.load("#{config.project}.gemspec").version}"
+  end
+rescue LoadError
+end

data/beaker-puppet.gemspec

@@ -5,9 +5,9 @@ require 'beaker-puppet/version'
 Gem::Specification.new do |s|
   s.name        = "beaker-puppet"
   s.version     = BeakerPuppet::VERSION
-  s.authors     = ["Puppet"]
-  s.email       = ["delivery@puppet.com"]
-  s.homepage    = "https://github.com/puppetlabs/beaker-puppet"
+  s.authors     = ["Vox Pupuli"]
+  s.email       = ["voxpupuli@groups.io"]
+  s.homepage    = "https://github.com/voxpupuli/beaker-puppet"
   s.summary     = %q{Beaker's Puppet DSL Extension Helpers!}
   s.description = %q{For use for the Beaker acceptance testing tool}
   s.license     = 'Apache2'
@@ -20,10 +20,8 @@ Gem::Specification.new do |s|
   # Testing dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
-  s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14.0'
+  s.add_development_dependency 'fakefs', '>= 0.6', '< 2.0'
   s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'pry', '~> 0.10'
 
   # Acceptance Testing Dependencies
   s.add_development_dependency 'beaker-vmpooler'
@@ -34,7 +32,6 @@ Gem::Specification.new do |s|
 
   # Run time dependencies
   s.add_runtime_dependency 'beaker', '~> 4.1'
-  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
   s.add_runtime_dependency 'in-parallel', '~> 0.1'
   s.add_runtime_dependency 'oga'
 

data/lib/beaker-puppet.rb

@@ -1,6 +1,5 @@
 require 'beaker'
 
-require 'stringify-hash'
 require 'in_parallel'
 require 'beaker-puppet/version'
 require 'beaker-puppet/wrappers'

data/lib/beaker-puppet/helpers/host_helpers.rb

@@ -7,7 +7,11 @@ module Beaker
       module HostHelpers
 
         def ruby_command(host)
-          "env PATH=\"#{host['privatebindir']}:${PATH}\" ruby"
+          if host['platform'] =~ /windows/ && !host.is_cygwin?
+            "cmd /V /C \"set PATH=#{host['privatebindir']};!PATH! && ruby\""
+          else
+            "env PATH=\"#{host['privatebindir']}:${PATH}\" ruby"
+          end
         end
 
         # Returns an array containing the owner, group and mode of

data/lib/beaker-puppet/helpers/puppet_helpers.rb

@@ -12,7 +12,7 @@ module Beaker
 
         # Return the regular expression pattern for an IPv4 address
         def ipv4_regex
-          return /(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/
+          Resolv::IPv4::Regex
         end
 
         # Return the IP address that given hostname returns when resolved on
@@ -519,7 +519,7 @@ module Beaker
               puppet_apply_opts['ENV'] = opts[:environment]
             end
 
-            file_path = host.tmpfile('apply_manifest.pp')
+            file_path = host.tmpfile(%(apply_manifest_#{Time.now.strftime("%H%M%S%L")}.pp))
             create_remote_file(host, file_path, manifest + "\n")
 
             if host[:default_apply_opts].respond_to? :merge

data/lib/beaker-puppet/install_utils/foss_utils.rb

@@ -72,6 +72,9 @@ module Beaker
         def dev_builds_accessible_on?(host, url = FOSS_DEFAULT_DOWNLOAD_URLS[:dev_builds_url])
           return true if host.host_hash[:template] =~ /^amazon-*/ && host.hostname =~ /.puppet.net$/
 
+          # redhat-8-arm64 is provided from amazon
+          return true if host.host_hash[:template] == 'redhat-8-arm64' && host.hostname =~ /.puppet.net$/
+
           result = on(host, %(curl -fI "#{url}"), accept_all_exit_codes: true)
           return result.exit_code.zero?
         end
@@ -416,6 +419,8 @@ module Beaker
                 install_puppet_agent_from_msi_on(host, opts)
               when /osx/
                 install_puppet_agent_from_dmg_on(host, opts)
+              when /archlinux/
+                install_puppet_from_pacman_on(host, opts)
               else
                 if opts[:default_action] == 'gem_install'
                   opts[:version] = opts[:puppet_gem_version]
@@ -949,7 +954,7 @@ module Beaker
               on host, "echo '#{path_with_gem}' >> ~/.bashrc"
             end
 
-            gemflags = '--no-ri --no-rdoc --no-format-executable'
+            gemflags = '--no-document --no-format-executable'
 
             if opts[:facter_version]
               on host, "gem install facter -v'#{opts[:facter_version]}' #{gemflags}"
@@ -1031,8 +1036,11 @@ module Beaker
               # package. We'll have to remember to update this block when
               # we update the signing keys
               if variant == 'sles' && version >= '11'
-                on host, "wget -O /tmp/puppet-gpg-key http://yum.puppetlabs.com/RPM-GPG-KEY-puppet"
-                on host, "rpm --import /tmp/puppet-gpg-key"
+                %w[puppet puppet-20250406].each do |gpg_key|
+                  on host, "wget -O /tmp/#{gpg_key} https://yum.puppet.com/RPM-GPG-KEY-#{gpg_key}"
+                  on host, "rpm --import /tmp/#{gpg_key}"
+                  on host, "rm -f /tmp/#{gpg_key}"
+                end
               end
 
               if variant == 'cisco_nexus'
@@ -1355,7 +1363,7 @@ module Beaker
             opts[:download_url] = "#{opts[:pe_promoted_builds_url]}/puppet-agent/#{ pe_ver }/#{ opts[:puppet_agent_version] }/repos"
             opts[:copy_base_local]    ||= File.join('tmp', 'repo_configs')
             opts[:copy_dir_external]  ||= host.external_copy_base
-            opts[:puppet_collection] ||= get_puppet_collection(opts[:puppet_agent_version])
+            opts[:puppet_collection] ||= puppet_collection_for(:puppet_agent, opts[:puppet_agent_version])
             add_role(host, 'aio') #we are installing agent, so we want aio role
             release_path = opts[:download_url]
             variant, version, arch, codename = host['platform'].to_array
@@ -1432,7 +1440,7 @@ module Beaker
         def install_puppetserver_on(host, opts = {})
           opts = sanitize_opts(opts)
 
-          # Default to installing latest from nightlies
+          # Default to installing latest
           opts[:version] ||= 'latest'
 
           # If inside the Puppet VPN, install from development builds.
@@ -1453,8 +1461,10 @@ module Beaker
           # here would be incorrect - that refers to FOSS puppet 3 only).
           host[:type] = :aio
 
-          if opts[:version] == 'latest' || opts[:nightlies]
-            release_stream += '-nightly' unless release_stream.end_with? "-nightly"
+          if opts[:version] == 'latest'
+            if opts[:nightlies]
+              release_stream += '-nightly' unless release_stream.end_with? "-nightly"
+            end
 
             # Since we have modified the collection, we don't want to pass `latest`
             # in to `install_package` as the version. That'll fail. Instead, if

data/lib/beaker-puppet/install_utils/puppet_utils.rb

@@ -56,7 +56,6 @@ module Beaker
           block_on hosts do | host |
             puppet_path = construct_puppet_path(host)
             host.add_env_var('PATH', puppet_path)
-            host.add_env_var('PATH', 'PATH') # don't destroy the path!
           end
         end
 
@@ -68,7 +67,6 @@ module Beaker
           block_on hosts do | host |
             puppet_path = construct_puppet_path(host)
             host.delete_env_var('PATH', puppet_path)
-            host.add_env_var('PATH', 'PATH') # don't destroy the path!
           end
         end
 
@@ -152,7 +150,7 @@ module Beaker
           result = on(host, 'puppetserver --version', accept_all_exit_codes: true)
           if result.exit_code.zero?
             matched = result.stdout.strip.scan(%r{\d+\.\d+\.\d+})
-            return matched.last
+            return matched.first
           end
           nil
         end

data/lib/beaker-puppet/install_utils/windows_utils.rb

@@ -177,8 +177,8 @@ module Beaker
             # 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'
+              '"${env:ProgramFiles}/Puppet Labs/puppet/misc/versions.txt"',
+              '"${env:ProgramFiles(x86)}/Puppet Labs/puppet/misc/versions.txt"'
             ].each do |path|
               if file_exists_on(host, path)
                 logger.info(file_contents_on(host, path)) && break

data/lib/beaker-puppet/version.rb

@@ -1,3 +1,3 @@
 module BeakerPuppet
-  VERSION = '1.19.1'
+  VERSION = '1.22.0'
 end

data/setup/git/000_EnvSetup.rb

@@ -145,6 +145,6 @@ step "Install bundler" do
   configure_gem_mirror(agents)
 
   agents.each do |host|
-    on host, "#{gem_command(host)} install bundler --no-ri --no-rdoc"
+    on host, "#{gem_command(host)} install bundler --no-document"
   end
 end

data/spec/beaker-puppet/helpers/host_helpers_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+class ClassMixedWithDSLHelpers
+  include Beaker::DSL::Helpers::HostHelpers
+end
+
+describe ClassMixedWithDSLHelpers do
+  let(:privatebindir) { 'C:\\Program Files\\Puppet Labs\\Puppet\\bin' }
+
+  context 'when platform is windows and non cygwin' do
+    let(:winhost) { make_host('winhost_non_cygwin', { :platform => 'windows',
+                                                      :privatebindir => privatebindir,
+                                                      :is_cygwin => 'false' }) }
+
+    it 'run the correct ruby_command' do
+      expect(subject.ruby_command(winhost)).to eq("cmd /V /C \"set PATH=#{privatebindir};!PATH! && ruby\"")
+    end
+  end
+
+  context 'when platform is windows and cygwin' do
+    let(:winhost) { make_host('winhost', { :platform => Beaker::Platform.new('windows-2016-a64'),
+                                           :privatebindir => privatebindir,
+                                           :is_cygwin => true }) }
+
+    it 'run the correct ruby_command' do
+      expect(subject.ruby_command(winhost)).to eq("env PATH=\"#{privatebindir}:${PATH}\" ruby")
+    end
+  end
+end

data/spec/beaker-puppet/helpers/puppet_helpers_spec.rb

@@ -1229,10 +1229,6 @@ describe ClassMixedWithDSLHelpers do
   end
 
   describe '#bounce_service' do
-    # let( :options ) {
-    #   opts = StringifyHash.new
-    #   opts
-    # }
     let( :options ) { Beaker::Options::Presets.new.presets }
     let( :result ) { double.as_null_object }
     before :each do
@@ -1285,12 +1281,13 @@ describe ClassMixedWithDSLHelpers do
   end
 
   describe '#sleep_until_puppetdb_started' do
-    let( :options ) {
-      opts = StringifyHash.new # defaults from presets.rb
-      opts[:puppetdb_port_nonssl] = 8080
-      opts[:puppetdb_port_ssl] = 8081
-      opts
-    }
+    let( :options ) do # defaults from presets.rb
+      {
+        :puppetdb_port_nonssl => 8080,
+        :puppetdb_port_ssl => 8081
+      }
+    end
+
     before :each do
       allow( subject ).to receive( :options ) { options }
       allow( hosts[0] ).to receive( :node_name ).and_return( '' )
@@ -1347,11 +1344,10 @@ describe ClassMixedWithDSLHelpers do
   end
 
   describe '#sleep_until_puppetserver_started' do
-    let( :options ) {
-      opts = StringifyHash.new
-      opts[:puppetserver_port] = 8140
-      opts
-    }
+    let( :options ) do
+      { :puppetserver_port => 8140 }
+    end
+
     before :each do
       allow( subject ).to receive( :options ) { options }
       allow( hosts[0] ).to receive( :node_name )
@@ -1371,11 +1367,10 @@ describe ClassMixedWithDSLHelpers do
   end
 
   describe '#sleep_until_nc_started' do
-    let( :options ) { # defaults from presets.rb
-      opts = StringifyHash.new
-      opts[:nodeclassifier_port] = 4433
-      opts
-    }
+    let( :options ) do # defaults from presets.rb
+      { :nodeclassifier_port => 4433 }
+    end
+
     before :each do
       allow( subject ).to receive( :options ) { options }
       allow( hosts[0] ).to receive( :node_name )

data/spec/beaker-puppet/install_utils/foss_utils_spec.rb

@@ -1406,7 +1406,7 @@ describe ClassMixedWithDSLInstallUtils do
       it 'sets correct file paths when agent version is set to latest' do
         host['platform'] = platform
         agentversion = 'latest'
-        collection = 'PC1'
+        collection = 'puppet'
         opts = { :puppet_agent_version => "#{agentversion}" , :pe_promoted_builds_url => "#{downloadurl}" }
 
         expect(subject).to receive(:fetch_http_file).once.with(
@@ -1424,10 +1424,10 @@ describe ClassMixedWithDSLInstallUtils do
         subject.install_puppet_agent_pe_promoted_repo_on( host, opts )
       end
 
-      it 'sets correct file paths for agent version < 5.5.4' do
+      it 'sets correct file paths for agent version 1.x.x' do
         host['platform'] = platform
-        agentversion = '5.3.3'
-        collection = 'PC1'
+        agentversion = '1.x.x'
+        collection = 'pc1'
         opts = { :puppet_agent_version => "#{agentversion}" , :pe_promoted_builds_url => "#{downloadurl}"}
 
         expect(subject).to receive(:fetch_http_file).once.with(
@@ -1467,7 +1467,7 @@ describe ClassMixedWithDSLInstallUtils do
 
       it 'sets correct file paths for agent version > 5.99' do
         host['platform'] = platform
-        agentversion = '6.0'
+        agentversion = '6.0.0'
         collection = 'puppet6'
         opts = { :puppet_agent_version => "#{agentversion}" , :pe_promoted_builds_url => "#{downloadurl}"}
 
@@ -1492,8 +1492,8 @@ describe ClassMixedWithDSLInstallUtils do
     let(:host) { make_host('master', platform: 'el-7-x86_64') }
 
     context 'with default arguments' do
-      it "installs the latest puppetserver from the default 'puppet-nightly' release stream" do
-        expect(subject).to receive(:install_puppetlabs_release_repo_on).with(host, 'puppet-nightly', include(nightly_yum_repo_url: "http://nightlies.puppet.com/yum"))
+      it "installs the latest puppetserver from the default 'puppet' release stream" do
+        expect(subject).to receive(:install_puppetlabs_release_repo_on).with(host, 'puppet', include(release_yum_repo_url: "http://yum.puppet.com"))
         expect(subject).to receive(:install_package).with(host, 'puppetserver', nil)
         subject.install_puppetserver_on(host)
       end
@@ -1632,19 +1632,4 @@ describe ClassMixedWithDSLInstallUtils do
     end
 
   end
-
-  describe '#get_latest_puppet_agent_build_from_url' do
-    let(:urls) {['https://downloads.puppet.com/mac/10.9/PC1/x86_64',
-            'https://downloads.puppet.com/mac/10.10/PC1/x86_64',
-            'https://downloads.puppet.com/mac/10.11/PC1/x86_64',
-            'https://downloads.puppet.com/mac/10.12/PC1/x86_64',
-            'https://downloads.puppet.com/windows']}
-
-    it "gets the right version" do
-      urls.each do |url|
-        expect(subject.get_latest_puppet_agent_build_from_url(url)).to match(/\d*.\d*.\d*/)
-      end
-    end
-  end
-
 end