beaker-rspec 6.2.2 → 7.0.0

data/Gemfile

@@ -18,5 +18,15 @@ else
   gem 'beaker'
 end
 
+# For running the spec/acceptance/example_spec.rb
+gem 'beaker-vagrant'
+
+# Dependencies for CI acceptance testing; TODO: fix CI so this can be removed
+gem 'beaker-hostgenerator'
+gem 'beaker-vmpooler', '~> 1.3'
+
+group :release do
+  gem 'github_changelog_generator', '>= 1.16.4', require: false if RUBY_VERSION >= '2.5'
+end
 
 gemspec

data/HISTORY.md

@@ -1,32 +1,4 @@
-# worker - History
-## Tags
-* [LATEST - 29 Mar, 2017 (0197f39f)](#LATEST)
-* [6.0.0 - 24 Oct, 2016 (77470480)](#6.0.0)
-* [5.6.0 - 24 Jun, 2016 (bc70fe5a)](#5.6.0)
-* [5.5.0 - 23 Jun, 2016 (a289ce27)](#5.5.0)
-* [5.4.0 - 9 Jun, 2016 (f030a8b5)](#5.4.0)
-* [5.3.0 - 13 Oct, 2015 (2efeb932)](#5.3.0)
-* [5.2.2 - 3 Sep, 2015 (69980e14)](#5.2.2)
-* [5.2.1 - 27 Aug, 2015 (49c45f61)](#5.2.1)
-* [5.2.0 - 15 Jul, 2015 (261dacdb)](#5.2.0)
-* [5.1.0 - 5 Jun, 2015 (3a72d131)](#5.1.0)
-* [beaker-rspec5.0.2 - 30 Mar, 2015 (b9831088)](#beaker-rspec5.0.2)
-* [beaker-rspec5.0.1 - 27 Jan, 2015 (7a64f285)](#beaker-rspec5.0.1)
-* [beaker-rspec5.0.0 - 8 Jan, 2015 (bbf806a4)](#beaker-rspec5.0.0)
-* [beaker-rspec4.0.0 - 5 Dec, 2014 (a4fe104a)](#beaker-rspec4.0.0)
-* [beaker-rspec2.2.6 - 23 Jun, 2014 (c899b70b)](#beaker-rspec2.2.6)
-* [beaker-rspec2.2.5 - 19 Jun, 2014 (4b9253e3)](#beaker-rspec2.2.5)
-* [beaker-rspec2.2.4 - 8 May, 2014 (8fdb93a9)](#beaker-rspec2.2.4)
-* [beaker-rspec2.2.3 - 23 Apr, 2014 (81241746)](#beaker-rspec2.2.3)
-* [beaker-rspec2.2.2 - 27 Mar, 2014 (bd5717e6)](#beaker-rspec2.2.2)
-* [beaker-rspec2.2.1 - 24 Mar, 2014 (5ec50c57)](#beaker-rspec2.2.1)
-* [beaker-rspec2.2.0 - 13 Mar, 2014 (3f2cd006)](#beaker-rspec2.2.0)
-* [beaker-rspec2.1.1 - 30 Jan, 2014 (94e2423a)](#beaker-rspec2.1.1)
-* [beaker-rspec2.1.0 - 29 Jan, 2014 (3ffb18f1)](#beaker-rspec2.1.0)
-* [beaker-rspec2.0.1 - 22 Jan, 2014 (0ece0e8d)](#beaker-rspec2.0.1)
-* [beaker-rspec2.0.0 - 6 Dec, 2013 (d836ebac)](#beaker-rspec2.0.0)
-* [beaker-rspec1.0.0 - 3 Dec, 2013 (65e89ec9)](#beaker-rspec1.0.0)
-
+## [6.1.0](https://github.com/voxpupuli/beaker-rspec/tree/6.1.0) (2017-03-29)
 ## Details
 ### <a name = "LATEST">LATEST - 29 Mar, 2017 (0197f39f)
 

data/README.md

@@ -1,19 +1,30 @@
 # beaker-rspec
 
-beaker-rspec is a bridge between the puppet acceptance test harness ([beaker](https://github.com/puppetlabs/beaker)) and [rspec](https://github.com/rspec/rspec). It also integrates [serverspec](http://serverspec.org/).
+[![License](https://img.shields.io/github/license/voxpupuli/beaker.svg)](https://github.com/voxpupuli/beaker/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/beaker/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/beaker/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/beaker/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/beaker/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/beaker.svg)](https://rubygems.org/gems/beaker)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/beaker.svg)](https://rubygems.org/gems/beaker)
+[![Donated by Puppet Inc](https://img.shields.io/badge/donated%20by-Puppet%20Inc-fb7047.svg)](#transfer-notice)
 
-# Upgrading from beaker-rspec 5 to 6
+beaker-rspec is a bridge between the puppet acceptance test harness ([beaker](https://github.com/voxpupuli/beaker)) and [rspec](https://github.com/rspec/rspec). It also integrates [serverspec](http://serverspec.org/).
+
+## Upgrading from beaker-rspec 5 to 6
 
 In beaker-rspec 6, we've picked up the newest beaker, 3.y. In this release, we've
-given up support for Ruby 1.9 and moved to 2.2.5 as our lowest tested version,
+given up support for EoL Ruby and moved to 2.4 as our lowest tested version,
 as well as a number of other changes underneath.
 
 To learn more about those changes, please checkout our
-[how-to upgrade](https://github.com/puppetlabs/beaker/blob/master/docs/how_to/upgrade_from_2_to_3.md)
+[how-to upgrade](https://github.com/voxpupuli/beaker/blob/master/docs/how_to/upgrade_from_2_to_3.md)
 doc. Note that besides the Ruby version & beaker dependency change, nothing else
 was changed in beaker-rspec itself.
 
-# Typical Workflow
+To figure out our current lowest supported Ruby version, check for the
+`required_ruby_version` key in `beaker-rspec.gemspec`. To see all Ruby versions
+we test on, check the list in `.github/workflows/test.yml`.
+
+## Typical Workflow
 
 Beaker does setup and provision all nodes from your nodeset on each test run, and cleans up the VMs after use. During development on a module it can be very handy to keep the VMs available for inspection or reuse. Set `BEAKER_destroy=no` do skip the cleanup and `BEAKER_provision=no` once the VMs are created.
 
@@ -34,30 +45,30 @@ Beaker does setup and provision all nodes from your nodeset on each test run, an
 cd .vagrant/beaker_vagrant_files/default.yml ; vagrant destroy --force
 ```
 
-## Supported ENV variables
+### Supported ENV variables
 
 * `BEAKER_color`: set to `no` to disable color output
 * `BEAKER_debug`: set to any value to enable beaker debug logging
 * `BEAKER_destroy`: set to `no` to keep the VMs after the test run. Set to `onpass` to keep the VMs around only after a test failure.
 * `BEAKER_keyfile`: specify alternate SSH key to access the test VMs
-* `BEAKER_options_file`: set to the file path of the options file to be used as the default options for beaker.  Equivalent to the `--options-file` parameter.  
+* `BEAKER_options_file`: set to the file path of the options file to be used as the default options for beaker.  Equivalent to the `--options-file` parameter.
 * `BEAKER_provision`: set to `no` to skip provisioning boxes before testing, beaker will then assume that boxes are already provisioned and reachable
 * `BEAKER_setdir`: change the directory with nodesets. Defaults to the module's `spec/acceptance/nodesets` directory.
 * `BEAKER_set`: set to the name of the node file to be used during testing (exclude .yml file extension, it will be added by beaker-rspec). The file is assumed to be in the `setdir` (see `BEAKER_setdir`).
 * `BEAKER_setfile` - set to the full path to a node file be used during testing (be sure to include full path and file extensions, beaker-rspec will use this path without editing/altering it in any way)
 
-For details on the specific mappings, the [setup code](https://github.com/puppetlabs/beaker-rspec/blob/2771b4b1864692690254a969680a57ff22ac0516/lib/beaker-rspec/spec_helper.rb#L26-L32) and the [beaker docs](https://github.com/puppetlabs/beaker/blob/master/docs/tutorials/the_command_line.md).
+For details on the specific mappings, the [setup code](https://github.com/voxpupuli/beaker-rspec/blob/2771b4b1864692690254a969680a57ff22ac0516/lib/beaker-rspec/spec_helper.rb#L26-L32) and the [beaker docs](https://github.com/voxpupuli/beaker/blob/master/docs/tutorials/the_command_line.md).
 
-# Building your Module Testing Environment
+## Building your Module Testing Environment
 
 Using puppetlabs-mysql as an example module.
 
-## Clone the module repository of the module where you want to add tests
+### Clone the module repository of the module where you want to add tests
 
     git clone https://github.com/puppetlabs/puppetlabs-mysql
     cd puppetlabs-mysql
 
-## Install beaker-rspec
+### Install beaker-rspec
 
 In module's top level directory edit the Gemfile. You should see a `:system_tests`
 or `:acceptance` group there, but if not, add beaker-rspec there:
@@ -72,7 +83,7 @@ Then run
 
     bundle install
 
-## Create node files
+### Create node files
 
 These files indicate the nodes (or hosts) that the tests will be run on.  By default, any node file called `default.yml` will be used.  You can override this using the `BEAKER_set` environment variable to indicate an alternate file.  Do not provide full path or the '.yml' file extension to `BEAKER_set`, beaker-rspec expands the filename to '${DIR}/${NAME}.yml'.  The directory defaults to `spec/acceptance/nodesets` but can be overridden with the `BEAKER_setdir` variable.  `BEAKER_setdir` gives full control over the path (including file extension).
 
@@ -80,7 +91,7 @@ Nodes are pulled from [Puppet Labs Vagrant Boxes](https://vagrantcloud.com/puppe
 
 Example node files can be found here:
 
-* [Puppet Labs example Vagrant node files](https://github.com/puppetlabs/beaker/blob/master/docs/how_to/hypervisors/vagrant_hosts_file_examples.md)
+* [Puppet Labs example Vagrant node files](https://github.com/voxpupuli/beaker-vagrant/blob/master/docs/vagrant_hosts_file_examples.md)
 
 Create the nodesets directory.  From module's top level directory:
 
@@ -88,7 +99,7 @@ Create the nodesets directory.  From module's top level directory:
 
 Copy any nodesets that you wish to use into the nodesets directory.
 
-## Create the spec_helper_acceptance.rb
+### Create the spec_helper_acceptance.rb
 
 In the `spec` folder, you should see the project's `spec_helper_acceptance.rb`.
 This file contains all of the setup logic needed to get your Systems Under Test
@@ -138,7 +149,7 @@ This method will install the latest puppet-agent from the specified
 
 Update spec_helper_acceptance.rb to reflect the module under test.  You will need to set the correct module name and add any module dependencies.  Place the file in the `spec` directory (in this case `puppetlabs-mysql/spec`)
 
-## Create spec tests for your module
+### Create spec tests for your module
 
 Spec tests are written in [RSpec](http://rspec.info). You can also use [serverspec](http://serverspec.org/) matchers to test [resources](http://serverspec.org/resource_types.html).
 
@@ -183,10 +194,32 @@ describe 'mysql::server::account_security class' do
 end
 ```
 
-## Run your spec tests
+### Run your spec tests
 
 From module's top level directory
 
 ```
 bundle exec rspec spec/acceptance
 ```
+
+## Transfer Notice
+
+This plugin was originally authored by [Puppet Inc](http://puppet.com).
+The maintainer preferred that [Vox Pupuli](https://voxpupuli.org) 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
+
+## License
+
+This gem is licensed under the Apache-2 license.
+
+## Release information
+
+To make a new release, please do:
+* update the version in lib/beaker-rspec/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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+task default: [:changelog]
+
+begin
+  require 'rubygems'
+  require 'github_changelog_generator/task'
+rescue LoadError
+  # github_changelog_generator isn't available, so we won't define a rake task with it
+else
+  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-rspec'
+    config.future_release = Gem::Specification.load("#{config.project}.gemspec").version
+  end
+end

data/beaker-rspec.gemspec

@@ -5,14 +5,14 @@ require 'beaker-rspec/version'
 Gem::Specification.new do |s|
   s.name        = "beaker-rspec"
   s.version     = BeakerRSpec::Version::STRING
-  s.authors     = ["Puppetlabs"]
-  s.email       = ["sqa@puppetlabs.com"]
-  s.homepage    = "https://github.com/puppetlabs/beaker-rspec"
+  s.authors     = ["Vox Pupuli"]
+  s.email       = ["voxpupuli@groups.io"]
+  s.homepage    = "https://github.com/voxpupuli/beaker-rspec"
   s.summary     = %q{RSpec bindings for beaker}
-  s.description = %q{RSpec bindings for beaker, see https://github.com/puppetlabs/beaker}
+  s.description = %q{RSpec bindings for beaker, see https://github.com/voxpupuli/beaker}
   s.license     = 'Apache-2.0'
 
-  s.required_ruby_version = Gem::Requirement.new('>= 2.1.8', '<3.0.0')
+  s.required_ruby_version = '>= 2.4.0', '<4.0.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -21,19 +21,18 @@ Gem::Specification.new do |s|
 
   # Testing dependencies
   s.add_development_dependency 'minitest', '~> 5.4'
-  s.add_development_dependency 'fakefs', '~> 0.6'
-  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'fakefs', '>= 0.6', '< 2'
+  s.add_development_dependency 'rake', '~> 13.0'
 
   # Documentation dependencies
   s.add_development_dependency 'yard'
   s.add_development_dependency 'thin'
 
-  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2')
-    s.add_development_dependency 'rack', '~> 1.6'
-  end
+  # Dependency for example spec/acceptance tests
+  s.add_runtime_dependency 'beaker-pe'
 
   # Run time dependencies
-  s.add_runtime_dependency 'beaker', '~> 3.0'
+  s.add_runtime_dependency 'beaker', '> 3.0'
   s.add_runtime_dependency 'rspec', '~> 3.0'
   s.add_runtime_dependency 'serverspec', '~> 2'
   s.add_runtime_dependency 'specinfra', '~> 2'

data/lib/beaker-rspec/spec_helper.rb

@@ -37,7 +37,7 @@ RSpec.configure do |c|
    options = defaults.merge(env_vars)
 
   # process options to construct beaker command string
-  nodesetdir = options[:nodesetdir] || dir.join('spec', 'acceptance', 'nodesets')
+  nodesetdir = options[:nodesetdir] || File.join('spec', 'acceptance', 'nodesets')
   nodesetfile = options[:nodesetfile] || File.join(nodesetdir, "#{options[:nodeset]}.yml")
   fresh_nodes = options[:provision] == 'no' ? '--no-provision' : nil
   keyfile = options[:keyfile] ? ['--keyfile', options[:keyfile]] : nil
@@ -47,15 +47,24 @@ RSpec.configure do |c|
 
   # Configure all nodes in nodeset
   c.setup([fresh_nodes, '--hosts', nodesetfile, keyfile, debug, color, options_file].flatten.compact)
-  c.provision
-  c.validate
-  c.configure
 
   trap "SIGINT" do
     c.cleanup
     exit!(1)
   end
 
+  begin
+    c.provision
+  rescue StandardError => e
+    logger.error(e)
+    logger.info(e.backtrace)
+    c.cleanup
+    exit!(1)
+  end
+
+  c.validate
+  c.configure
+
   # Destroy nodes if no preserve hosts
   c.after :suite do
     case options[:destroy]

data/lib/beaker-rspec/version.rb

@@ -1,5 +1,5 @@
 module BeakerRSpec
   module Version
-    STRING = '6.2.2'
+    STRING = '7.0.0'
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+# if you need DSL extension libraries, it appears that they have to be loaded before the RSpec shim
+require "beaker-pe"
+
 ENV['RS_SETFILE'] ||= 'sample.cfg'
 
 require "beaker-rspec"

metadata

@@ -1,168 +1,178 @@
 --- !ruby/object:Gem::Specification
 name: beaker-rspec
 version: !ruby/object:Gem::Version
-  version: 6.2.2
+  version: 7.0.0
 platform: ruby
 authors:
-- Puppetlabs
+- Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.4'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: beaker-pe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: beaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: serverspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: specinfra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-description: RSpec bindings for beaker, see https://github.com/puppetlabs/beaker
+description: RSpec bindings for beaker, see https://github.com/voxpupuli/beaker
 email:
-- sqa@puppetlabs.com
+- voxpupuli@groups.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - HISTORY.md
 - LICENSE
 - README.md
+- Rakefile
 - beaker-rspec.gemspec
 - lib/beaker-rspec.rb
 - lib/beaker-rspec/beaker_shim.rb
@@ -173,7 +183,7 @@ files:
 - sample.cfg
 - spec/acceptance/example_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/puppetlabs/beaker-rspec
+homepage: https://github.com/voxpupuli/beaker-rspec
 licenses:
 - Apache-2.0
 metadata: {}
@@ -183,20 +193,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.8
-  - - <
+      version: 2.4.0
+  - - "<"
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 4.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: RSpec bindings for beaker

data/.travis.yml

@@ -1,9 +0,0 @@
-before_install:
-  - gem --version
-language: ruby
-script: 'bundle exec gem build beaker-rspec.gemspec'
-notifications:
-  email: false
-rvm:
-  - 2.1.9
-  - 2.2.4