beaker 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a779fedc9b7695d5a76a9731765e8ed5c5b8f9f1945563c2108cd0d0e01f564a
-  data.tar.gz: d5613d1aa5a289aff25f948229f5d8c89bec28fa25ec6ae310f446e95dd44363
+  metadata.gz: d16043faca3a48ef9dd5a7171bf0241dd30fd801029eba8e881fe9d3d8afbef1
+  data.tar.gz: 64bec8b91441d824ad87a112914a5f41b5fe2b48131b9f6d99599b201279b4a3
 SHA512:
-  metadata.gz: 33dae1fd1af4921f1fd3f00e18413a1a823749444fbed1c1fae0ed967cf055988a31692ceba29d5535bba8b1283f0b6ec0535cf21b589ecfc9f55c0d6498f51b
-  data.tar.gz: 8ccefb72d40022e47506fdd6ab8307318fbcd3eb736f89f965368de923e65b52e14a3faac8ea4afcb7aad3d3c80e059a9ce665578d18f32c01ff073675b75387
+  metadata.gz: 17f0baf5a669e5ffa2e9f4214dbeb84f0e5fbf4ff80e048243215006aa8e5fc91be5df24e1714f71962a7a1d2e3d4f83c74c987f98a9a8ceff2b9397762b5167
+  data.tar.gz: 2826c21940af588185545f7a4f987600a789a9c646b9fe0d31d9e6d6f4f5eae0573d51591de0943d0dc9077cb0e0f3114291881fc10c6dcd3b54af24ec2425e2

data/.rubocop.yml

@@ -1,32 +1,9 @@
 ---
-inherit_from: .rubocop_todo.yml
+inherit_from:
+  - .rubocop_todo.yml
 
-require:
-  - rubocop-performance
-  - rubocop-rake
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 2.7
-  NewCops: enable
-
-Gemspec/RequireMFA:
-  Enabled: false
-
-Gemspec/DevelopmentDependencies:
-  Enabled: false
-
-Style/TrailingCommaInHashLiteral:
-  Enabled: True
-  EnforcedStyleForMultiline: consistent_comma
-
-Style/TrailingCommaInArrayLiteral:
-  Enabled: True
-  EnforcedStyleForMultiline: consistent_comma
-
-Style/TrailingCommaInArguments:
-  Enabled: True
-  EnforcedStyleForMultiline: comma
+inherit_gem:
+  voxpupuli-rubocop: rubocop.yml
 
 Layout/LineLength:
   Exclude:
@@ -65,11 +42,11 @@ RSpec/StubbedMock:
 RSpec/MultipleExpectations:
   Enabled: false
 
+RSpec/IndexedLet:
+  Enabled: false
+
 RSpec/NestedGroups:
   Max: 4
 
-Metrics:
-  Enabled: false
-
 Style:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --no-offense-counts --no-auto-gen-timestamp`
-# using RuboCop version 1.48.0.
+# using RuboCop version 1.50.1.
 # 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
@@ -236,4 +236,4 @@ Security/Open:
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 226
+  Max: 225

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [5.2.0](https://github.com/voxpupuli/beaker/tree/5.2.0) (2023-04-28)
+
+**Implemented enhancements:**
+
+- Enhance documentation about roles [\#1800](https://github.com/voxpupuli/beaker/pull/1800) ([rwaffen](https://github.com/rwaffen))
+- Declare API interface on Beaker::Host [\#1806](https://github.com/voxpupuli/beaker/pull/1806) ([ekohl](https://github.com/ekohl))
+- Support an extension to tmpfile [\#1735](https://github.com/voxpupuli/beaker/pull/1735) ([ekohl](https://github.com/ekohl))
+
+**Fixed bugs:**
+
+- Use systemctl to restat SSH on EL9 [\#1808](https://github.com/voxpupuli/beaker/pull/1808) ([ekohl](https://github.com/ekohl))
+
+**Merged changes:**
+
+- Drop legacy yard tasks [\#1805](https://github.com/voxpupuli/beaker/pull/1805) ([bastelfreak](https://github.com/bastelfreak))
+- Switch to voxpupuli-rubocop [\#1804](https://github.com/voxpupuli/beaker/pull/1804) ([bastelfreak](https://github.com/bastelfreak))
+- Disable RSpec/IndexedLet [\#1807](https://github.com/voxpupuli/beaker/pull/1807) ([ekohl](https://github.com/ekohl))
+
+## [5.1.0](https://github.com/voxpupuli/beaker/tree/5.1.0) (2023-03-27)
+
+**Implemented enhancements:**
+
+- Introduce shareable rubocop config [\#1795](https://github.com/voxpupuli/beaker/pull/1795) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [5.0.0](https://github.com/voxpupuli/beaker/tree/5.0.0) (2023-03-24)
 
 **Breaking changes:**

data/Gemfile

@@ -25,13 +25,6 @@ if ENV['BEAKER_HYPERVISOR']
   gem "beaker-#{ENV['BEAKER_HYPERVISOR'].split('_').first}"
 end
 
-group :rubocop do
-  gem 'rubocop', '~> 1.48.0'
-  gem 'rubocop-performance', '~> 1.16.0'
-  gem 'rubocop-rake', '~> 0.6.0'
-  gem 'rubocop-rspec', '~> 2.19.0'
-end
-
 group :release do
   gem 'github_changelog_generator', require: false
 end

data/Rakefile

@@ -16,14 +16,6 @@ end
 
 task :acceptance => ['test:base', 'test:hypervisor']
 
-task :yard do
-  Rake::Task['docs:gen'].invoke
-end
-
-task :history do
-  Rake::Task['history:gen'].invoke
-end
-
 module HarnessOptions
   defaults = {
     :tests => ['tests'],
@@ -189,120 +181,6 @@ namespace :test do
   end
 end
 
-###########################################################
-#
-#   History Tasks
-#
-###########################################################
-namespace :history do
-  desc 'Generate HISTORY.md'
-  task :gen do
-    Dir.chdir(__dir__) do
-      output = `bundle exec ruby history.rb .`
-      puts output
-      raise "History generation failed" if !output.include?('success')
-    end
-  end
-end
-
-###########################################################
-#
-#   Documentation Tasks
-#
-###########################################################
-DOCS_DIR = 'yard_docs'
-DOCS_DAEMON = "yard server --reload --daemon --docroot #{DOCS_DIR}"
-FOREGROUND_SERVER = "bundle exec yard server --reload --verbose lib/beaker --docroot #{DOCS_DIR}"
-
-def running?(cmdline)
-  ps = `ps -ef`
-  found = ps.lines.grep(/#{Regexp.quote(cmdline)}/)
-  raise StandardError, "Found multiple YARD Servers. Don't know what to do." if found.length > 1
-
-  yes = found.empty? ? false : true
-  return yes, found.first
-end
-
-def pid_from(output)
-  output.squeeze(' ').strip.split(' ')[1]
-end
-
-desc 'Start the documentation server in the foreground'
-task :docs => 'docs:clear' do
-  Dir.chdir(__dir__) do
-    sh FOREGROUND_SERVER
-  end
-end
-
-namespace :docs do
-  desc 'Clear the generated documentation cache'
-  task :clear do
-    Dir.chdir(__dir__) do
-      sh "rm -rf #{DOCS_DIR}"
-    end
-  end
-
-  desc 'Generate static documentation'
-  task :gen => 'docs:clear' do
-    Dir.chdir(__dir__) do
-      output = `bundle exec yard doc -o #{DOCS_DIR}`
-      puts output
-      fail "Errors/Warnings during yard documentation generation" if /\[warn\]|\[error\]/.match?(output)
-    end
-  end
-
-  desc 'Run the documentation server in the background, alias `bg`'
-  task :background => 'docs:clear' do
-    yes, output = running?(DOCS_DAEMON)
-    if yes
-      puts "Not starting a new YARD Server..."
-      puts "Found one running with pid #{pid_from(output)}."
-    else
-      Dir.chdir(__dir__) do
-        sh "bundle exec #{DOCS_DAEMON}"
-      end
-    end
-  end
-
-  task(:bg) { Rake::Task['docs:background'].invoke }
-
-  desc 'Check the status of the documentation server'
-  task :status do
-    yes, output = running?(DOCS_DAEMON)
-    if yes
-      pid = pid_from(output)
-      puts "Found a YARD Server running with pid #{pid}"
-    else
-      puts "Could not find a running YARD Server."
-    end
-  end
-
-  desc "Stop a running YARD Server"
-  task :stop do
-    yes, output = running?(DOCS_DAEMON)
-    if yes
-      pid = pid_from(output)
-      puts "Found a YARD Server running with pid #{pid}"
-      `kill #{pid}`
-      puts "Stopping..."
-      yes, _output = running?(DOCS_DAEMON)
-      if yes
-        `kill -9 #{pid}`
-        yes, _output = running?(DOCS_DAEMON)
-        if yes
-          puts "Could not Stop Server!"
-        else
-          puts "Server stopped."
-        end
-      else
-        puts "Server stopped."
-      end
-    else
-      puts "Could not find a running YARD Server"
-    end
-  end
-end
-
 begin
   require 'rubygems'
   require 'github_changelog_generator/task'

data/beaker.gemspec

@@ -22,9 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'fakefs', '~> 2.4'
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.0'
-
-  # Documentation dependencies
-  s.add_development_dependency 'yard', '~> 0.9.11'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 1.1'
 
   # Run time dependencies
   s.add_runtime_dependency 'minitar', '~> 0.6'

data/docs/tutorials/creating_a_test_environment.md

@@ -45,6 +45,7 @@ To properly define a host you must provide:
 
 * name: The string identifying this host.
 * platform: One of the Beaker supported platforms.
+* roles: In a multi-host setup roles are mandatory. One host needs the role of `default`. Roles describe the 'job' of a host, an array of `master`, `agent`, `frictionless`, `dashboard`, `database`, `default` or any user-defined string.
 
 ## Optional Host Settings
 
@@ -54,7 +55,7 @@ Additionally, Beaker supports the following host options:
 * hypervisor: One of `docker`, `solaris`, `ec2`, `vsphere`, `fusion`, `aix`, `vcloud` or `vagrant`.
   * Additional settings may be required depending on the selected hypervisor (ie, template, box, box_url, etc).  Check the documentation below for your hypervisor for details.
 * snapshot: The name of the snapshot to revert to before testing.
-* roles: The 'job' of this host, an array of `master`, `agent`, `frictionless`, `dashboard`, `database`, `default` or any user-defined string.
+* roles: In a single-host setup roles are optional. Roles describe the 'job' of a host, an array of `master`, `agent`, `frictionless`, `dashboard`, `database`, `default` or any user-defined string.
 * pe_dir: The directory where PE builds are located, may be local directory or a URL.
 * pe_ver: The version number of PE to install.
 * vagrant_memsize: The memory size (in MB) for this host

data/lib/beaker/host/aix/file.rb

@@ -1,8 +1,8 @@
 module Aix::File
   include Beaker::CommandFactory
 
-  def tmpfile(name = '')
-    execute("rndnum=${RANDOM} && touch /tmp/#{name}.${rndnum} && echo /tmp/#{name}.${rndnum}")
+  def tmpfile(name = '', extension = nil)
+    execute("rndnum=${RANDOM} && touch /tmp/#{name}.${rndnum}#{extension} && echo /tmp/#{name}.${rndnum}#{extension}")
   end
 
   def tmpdir(name = '')

data/lib/beaker/host/freebsd/pkg.rb

@@ -16,7 +16,7 @@ module FreeBSD::Pkg
     execute("/bin/sh -c '#{check_pkgng_sh}'", opts) { |r| r }.exit_code == 0
   end
 
-  def install_package(package, cmdline_args = nil, opts = {})
+  def install_package(package, cmdline_args = nil, _version = nil, opts = {})
     cmd = if pkgng_active?
             "pkg install #{cmdline_args || '-y'} #{package}"
           else

data/lib/beaker/host/pswindows/file.rb

@@ -1,7 +1,13 @@
 module PSWindows::File
   include Beaker::CommandFactory
 
-  def tmpfile(_name = '')
+  def tmpfile(_name = '', extension = nil)
+    if extension
+      # TODO: I do not have access to Windows, but the internet suggests this
+      # $newname = [System.IO.Path]::ChangeExtension($filename, "#{extension}") ; MoveItem $filename $newname
+      raise NotImplementedError, 'Passing an extension is not implemented'
+    end
+
     result = exec(powershell('[System.IO.Path]::GetTempFileName()'))
     result.stdout.chomp
   end

data/lib/beaker/host/unix/exec.rb

@@ -280,7 +280,7 @@ module Unix::Exec
     case self['platform']
     when /debian|ubuntu|cumulus|huaweios/
       exec(Beaker::Command.new("service ssh restart"))
-    when /el-7|centos-7|redhat-7|oracle-7|scientific-7|eos-7|el-8|centos-8|redhat-8|oracle-8|fedora-(1[4-9]|2[0-9]|3[0-9])|archlinux-/
+    when /(el|centos|redhat|oracle|scientific)-[7-9]|eos-7|fedora-(1[4-9]|2[0-9]|3[0-9])|archlinux-/
       exec(Beaker::Command.new("systemctl restart sshd.service"))
     when /el-|centos|fedora|redhat|oracle|scientific|eos/
       exec(Beaker::Command.new("/sbin/service sshd restart"))

data/lib/beaker/host/unix/file.rb

@@ -1,8 +1,8 @@
 module Unix::File
   include Beaker::CommandFactory
 
-  def tmpfile(name = '')
-    execute("mktemp -t #{name}.XXXXXX")
+  def tmpfile(name = '', extension = nil)
+    execute("mktemp -t #{name}.XXXXXX#{extension}")
   end
 
   def tmpdir(name = '')

data/lib/beaker/host/windows/file.rb

@@ -1,8 +1,8 @@
 module Windows::File
   include Beaker::CommandFactory
 
-  def tmpfile(name = '')
-    execute("cygpath -m $(mktemp -t #{name}.XXXXXX)")
+  def tmpfile(name = '', extension = nil)
+    execute("cygpath -m $(mktemp -t #{name}.XXXXXX#{extension})")
   end
 
   def tmpdir(name = '')

data/lib/beaker/host.rb

@@ -547,6 +547,30 @@ module Beaker
 
       raise Beaker::Host::CommandFailure, result.error
     end
+
+    def tmpfile(name = '')
+      raise NotImplementedError
+    end
+
+    def tmpdir(name = '')
+      raise NotImplementedError
+    end
+
+    def path_split(paths)
+      raise NotImplementedError
+    end
+
+    def rm_rf(path)
+      raise NotImplementedError
+    end
+
+    def install_package(package, cmdline_args = nil, _version = nil, opts = {})
+      raise NotImplementedError
+    end
+
+    def add_env_var(key, val)
+      raise NotImplementedError
+    end
   end
 
   %w[

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '5.0.0'
+    STRING = '5.2.0'
   end
 end

data/rubocop.yml

@@ -0,0 +1,39 @@
+---
+# this file is the base rubocop config for beaker + all beaker plugins
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  DisplayCopNames: true
+  ExtraDetails: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: '2.7'
+  Exclude:
+  - vendor/**/*
+  - .vendor/**/*
+
+# this currently doesn't work with the way we handle our secrets
+Gemspec/RequireMFA:
+  Enabled: false
+
+# current Vox Pupuli default is to use `add_development_dependency` in the gemspec
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: True
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: True
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArguments:
+  Enabled: True
+  EnforcedStyleForMultiline: comma
+
+Metrics:
+  Enabled: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
+date: 2023-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakefs
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: voxpupuli-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: minitar
   requirement: !ruby/object:Gem::Requirement
@@ -535,6 +535,7 @@ files:
 - lib/beaker/test_suite.rb
 - lib/beaker/test_suite_result.rb
 - lib/beaker/version.rb
+- rubocop.yml
 - spec/beaker/cli_spec.rb
 - spec/beaker/command_spec.rb
 - spec/beaker/dsl/assertions_spec.rb