Beaker uses arguments and settings from a variety of sources to determine how your test run is executed.
- Environment Variables
- Host/Config File Options
- ARGV
- Options File Values
- Default Values
- Priority of Settings
BEAKER VARIABLE NAME => ENVIRONMENT VARIABLE NAME
:home => 'HOME',
:project => ['BEAKER_PROJECT', 'BEAKER_project', 'JOB_NAME'],
:department => ['BEAKER_DEPARTMENT', 'BEAKER_department'],
:jenkins_build_url => ['BEAKER_BUILD_URL', 'BUILD_URL'],
:created_by => ['BEAKER_CREATED_BY'],
:consoleport => ['BEAKER_CONSOLEPORT', 'consoleport'],
:is_pe => ['BEAKER_IS_PE', 'IS_PE'],
:pe_dir => ['BEAKER_PE_DIR', 'pe_dist_dir'],
:puppet_agent_version => ['BEAKER_PUPPET_AGENT_VERSION'],
:puppet_agent_sha => ['BEAKER_PUPPET_AGENT_SHA'],
:puppet_collection => ['BEAKER_PUPPET_COLLECTION'],
:pe_version_file => ['BEAKER_PE_VERSION_FILE', 'pe_version_file'],
:pe_ver => ['BEAKER_PE_VER', 'pe_ver'],
:forge_host => ['BEAKER_FORGE_HOST', 'forge_host'],
:package_proxy => ['BEAKER_PACKAGE_PROXY'],
:release_apt_repo_url => ['BEAKER_RELEASE_APT_REPO', 'RELEASE_APT_REPO'],
:release_yum_repo_url => ['BEAKER_RELEASE_YUM_REPO', 'RELEASE_YUM_REPO'],
:dev_builds_url => ['BEAKER_DEV_BUILDS_URL', 'DEV_BUILDS_URL'],
:vbguest_plugin => ['BEAKER_VB_GUEST_PLUGIN', 'BEAKER_vb_guest_plugin'],
:tag_includes => ['BEAKER_TAG'],
:tag_excludes => ['BEAKER_EXCLUDE_TAG'],
:run_in_parallel => ['BEAKER_RUN_IN_PARALLEL'],
Any values included for an individual host in a host file.
HOSTS:
pe-ubuntu-lucid:
roles:
- agent
- dashboard
- database
- master
vmname : pe-ubuntu-lucid
platform: ubuntu-10.04-i386
snapshot : clean-w-keys
hypervisor : fusion
roles, vmname, platform, snapshot and hypervisor are all options set for the host pe-ubuntu-lucid. Any additional values can be included on a per-host basis by adding arbitrary key-value pairs.
HOSTS:
pe-ubuntu-lucid:
roles:
- agent
- dashboard
- database
- master
vmname : pe-ubuntu-lucid
platform: ubuntu-10.04-i386
snapshot : clean-w-keys
hypervisor : fusion
CONFIG:
nfs_server: none
consoleport: 443
pe_dir: http://path/to/pe/builds
nfs_server, consoleport, pe_dir are examples of CONFIG section arguments. The values of these will be rolled up into each host defined, thus host[pe_dir] is valid.
$ beaker --debug --tests acceptance/tests/base/host.rb --hosts configs/fusion/winfusion.cfg
--debug, --tests acceptance/tests/base/host.rb and --hosts configs/fusion/winfusion.cfg are the provided command line values for this test run.
$ beaker --help
Usage: beaker [options...]
-h, --hosts FILE Use host configuration FILE
(default sample.cfg)
-o, --options-file FILE Read options from FILE
This should evaluate to a ruby hash.
CLI options are given precedence.
--type TYPE one of git, foss, or pe
used to determine underlying path structure of puppet install
(default pe)
--helper PATH/TO/SCRIPT Ruby file evaluated prior to tests
(a la spec_helper)
--load-path /PATH/TO/DIR,/ADDITIONAL/DIR/PATHS
Add paths to LOAD_PATH
-t /PATH/TO/DIR,/ADDITIONA/DIR/PATHS,/PATH/TO/FILE.rb,
--tests Execute tests from paths and files
--pre-suite /PRE-SUITE/DIR/PATH,/ADDITIONAL/DIR/PATHS,/PATH/TO/FILE.rb
Path to project specific steps to be run BEFORE testing
--post-suite /POST-SUITE/DIR/PATH,/OPTIONAL/ADDITONAL/DIR/PATHS,/PATH/TO/FILE.rb
Path to project specific steps to be run AFTER testing
--[no-]provision Do not provision vm images before testing
(default: true)
--[no-]configure Do not configure vm images before testing
(default: true)
--preserve-hosts [MODE] How should SUTs be treated post test
Possible values:
always (keep SUTs alive)
onfail (keep SUTs alive if failures occur during testing)
onpass (keep SUTs alive if no failures occur during testing)
never (cleanup SUTs - shutdown and destroy any changes made during testing)
(default: never)
--root-keys Install puppetlabs pubkeys for superuser
(default: false)
--keyfile /PATH/TO/SSH/KEY Specify alternate SSH key
(default: ~/.ssh/id_rsa)
--timeout TIMEOUT (vCloud only) Specify a provisioning timeout (in seconds)
(default: 300)
-i, --install URI Install a project repo/app on the SUTs
Provide full git URI or use short form KEYWORD/name
supported keywords: PUPPET, FACTER, HIERA, HIERA-PUPPET
-m, --modules URI Select puppet module git install URI
-q, --[no-]quiet Do not log output to STDOUT
(default: false)
--[no-]color Do not display color in log output
(default: true)
--log-level LEVEL Log level
Supported LEVEL keywords:
trace : all messages, full stack trace of errors, file copy details
debug : all messages, plus full stack trace of errors
verbose : all messages
info : info messages, notifications and warnings
notify : notifications and warnings
warn : warnings only
(default: info)
-d, --[no-]dry-run Report what would happen on targets
(default: false)
--fail-mode [MODE] How should the harness react to errors/failures
Possible values:
fast (skip all subsequent tests)
slow (attempt to continue run post test failure)
stop (DEPRECATED, please use fast)
(default: slow)
--[no-]ntp Sync time on SUTs before testing
(default: false)
--repo-proxy Proxy packaging repositories on ubuntu, debian and solaris-11
(default: false)
--package-proxy URL Set proxy url for package managers (yum and apt)
--[no-]validate Validate that SUTs are correctly provisioned before running tests
(default: true)
--version Report currently running version of beaker
--parse-only Display beaker parsed options and exit
--help Display this screen
-c, --config FILE DEPRECATED, use --hosts
--[no-]debug DEPRECATED, use --log-level
-x, --[no-]xml DEPRECATED - JUnit XML now generated by default
--collect-perf-data Use sysstat on linux hosts to collect performance and load data
$ beaker --options-file additional_options.rb
The additional options file is provided with --options-file /path/to/file.rb. The file itself must contain a properly formatted Ruby hash. You can override any beaker internal option variable in the options file hash, but you have to associate the new value with the correct, internal key name.
{
:hosts_file => 'hosts.cfg',
:ssh => {
:keys => ["/Users/anode/.ssh/id_rsa-acceptance"],
},
:timeout => 1200,
:log_level => 'debug',
:fail_mode => 'slow',
:tests => [
'tests/agent/agent_disable_lockfile.rb',
'tests/agent/fallback_to_cached_catalog.rb',
],
:forge_host => 'api-forge-aio01-petest.puppetlabs.com',
'service-wait' => true,
'xml' => true,
}
Values already included in Beaker as defaults for required arguments.
{
:project => 'Beaker',
:department => 'unknown',
:created_by => ENV['USER'] || ENV['USERNAME'] || 'unknown',
:host_tags => {},
:openstack_api_key => ENV['OS_PASSWORD'],
:openstack_username => ENV['OS_USERNAME'],
:openstack_auth_url => "#{ENV['OS_AUTH_URL']}/tokens",
:openstack_tenant => ENV['OS_TENANT_NAME'],
:openstack_keyname => ENV['OS_KEYNAME'],
:openstack_network => ENV['OS_NETWORK'],
:openstack_region => ENV['OS_REGION'],
:jenkins_build_url => nil,
:validate => true,
:configure => true,
:log_level => 'info',
:trace_limit => 10,
:"master-start-curl-retries" => 120,
:masterless => false,
:options_file => nil,
:type => 'pe',
:provision => true,
:preserve_hosts => 'never',
:root_keys => false,
:quiet => false,
:project_root => File.expand_path(File.join(__dir__, "../")),
:xml_dir => 'junit',
:xml_file => 'beaker_junit.xml',
:xml_time => 'beaker_times.xml',
:xml_time_enabled => false,
:xml_stylesheet => 'junit.xsl',
:default_log_prefix => 'beaker_logs',
:log_dir => 'log',
:log_sut_event => 'sut.log',
:color => true,
:dry_run => false,
:tag_includes => '',
:tag_excludes => '',
:timeout => 900, # 15 minutes
:fail_mode => 'slow',
:accept_all_exit_codes => false,
:timesync => false,
:set_env => true,
:disable_updates => true,
:repo_proxy => false,
:package_proxy => false,
:consoleport => 443,
:pe_dir => '/opt/enterprise/dists',
:pe_version_file => 'LATEST',
:pe_version_file_win => 'LATEST-win',
:host_env => {},
:host_name_prefix => nil,
:ssh_env_file => '~/.ssh/environment',
:profile_d_env_file => '/etc/profile.d/beaker_env.sh',
:dot_fog => File.join(ENV['HOME'], '.fog'),
:ec2_yaml => 'config/image_templates/ec2.yaml',
:help => false,
:collect_perf_data => 'none',
:puppetdb_port_ssl => 8081,
:puppetdb_port_nonssl => 8080,
:puppetserver_port => 8140,
:nodeclassifier_port => 4433,
:cache_files_locally => true,
:aws_keyname_modifier => rand(10 ** 10).to_s.rjust(10,'0'), # 10 digit random number string
:run_in_parallel => [],
:ssh => {
:config => false,
:verify_host_key => false,
:auth_methods => ["publickey"],
:port => 22,
:forward_agent => true,
:keys => ["#{ENV['HOME']}/.ssh/id_rsa"],
:user_known_hosts_file => "#{ENV['HOME']}/.ssh/known_hosts",
:keepalive => true
}
}
Order of priority is as follows (from highest to lowest):
- Environment variables are given top priority
- Host/Config file options
CONFIGsection of the hosts file- ARGV or Provided Arguments Array
- Options file values
- Default or Preset values are given the lowest priority
- If
BEAKER_PE_DIRenvironment variable then any and allpe_dirsettings in the host file, options file and beaker defaults are ignored - In this case, the
pe_dirforpe-ubuntu-lucidwill behttp://ubuntu/path, while thepe_dirforpe-centos6will behttps://CONFIG/path.
HOSTS:
pe-ubuntu-lucid:
roles:
- agent
- dashboard
- database
- master
vmname : pe-ubuntu-lucid
platform: ubuntu-10.04-i386
snapshot : clean-w-keys
hypervisor : fusion
pe_dir : http://ubuntu/path
pe-centos6:
roles:
- agent
vmname : pe-centos6
platform: el-6-i386
hypervisor : fusion
snapshot: clean-w-keys
CONFIG:
nfs_server: none
consoleport: 443
pe_dir: https://CONFIG/path