Puppet Enterprise (PE) Beaker Library
APACHE-2.0 License
The Puppet Enterprise (PE) Beaker Library
The PE Beaker library contains all PE-specific
that help someone acceptance test PE easier with Beaker.
If you've used beaker-pe previously (during the 0.y versions), you'll have to change the way that you include beaker-pe for 1.y versions & beyond.
Before, you could just include beaker itself and you'd get beaker-pe because beaker required beaker-pe. With beaker 3.0, this dependency has been taken out of beaker. Now to use beaker-pe, you'll have to do two things:
require 'beaker-pe'
statement in your tests/code that needSpec tests require a version of scooter that is private. Execute
export GEM_SOURCE=https://artifactory.delivery.puppetlabs.net/artifactory/api/gems/rubygems/
prior to running
bundle install --path .bundle/gems/
.
Spec tests all live under the spec
folder. These are the default rake task, &
so can be run with a simple bundle exec rake
, as well as being fully specified
by running bundle exec rake test:spec:run
or using the test:spec
task.
There are also code coverage tests built into the template, which can be run
with spec testing by running the test:spec:coverage
rake task.
Acceptance tests live in the acceptance/tests
folder. These are Beaker tests,
& are dependent on having Beaker installed. Note that this will happen with a
bundle install
execution, but can be avoided if you're not looking to run
acceptance tests by ignoring the acceptance_testing
gem group.
You can run the acceptance testing suite by invoking the test:acceptance
rake
task. It should be noted that this is a shortcut for the test:acceptance:quick
task, which is named as such because it uses no pre-suite. This uses a default
provided hosts file for acceptance under the acceptance/config
directory. If
you'd like to provide your own hosts file, set the CONFIG
environment variable.
Prerequisites (without these steps you will almost certainly hit API rate limits):
CHANGELOG_GITHUB_TOKEN
Open a release prep PR and run the release action:
lib/beaker-pe/version.rb
appropriately based merged pull requests since the last release../release-prep
to update Gemfile.lock
and CHANGELOG.md
.main
and be sure to add the "maintenance" label.If you have questions, please reach out to our MAINTAINERS.