Beaker

What’s New in Beaker 22?

Beaker 22 adds support for extra job XML elements, JUnit XML results output, inverted groups, and many other improvements.

Extra elements preserved in job XML

When a job is submitted Beaker will now accept and preserve any extra XML elements which appear at the top level under the root <job/> node. The extra elements must be in an XML namespace in order to distinguish them from Beaker job XML elements. The elements and their contents will be stored and included in the job results XML and when the job is cloned. The position and order of the top-level elements is not preserved.

This is useful for jobs generated with third party tools where extra metadata or processing instructions need to be stored with the job and preserved when cloning.

For example, the <b:option/> and <f:test/> elements in the following XML snippet are now legal and will be preserved when cloning the job:

<job>
    <b:option xmlns:b="http://example.com/bar">--foobar arbitrary</b:option>
    <f:test xmlns:f="http://example.com/foo"><child attribute="" /></f:test>
    <whiteboard>my job</whiteboard>
    [...]

(Contributed by Róman Joost in #1112131.)

Job results in JUnit XML format

The bkr job-results command can now export job results in “JUnit XML” format (sometimes called “XUnit” format). This results format was originally established by the Ant JUnit test runner, and is also understood by Jenkins and many other tools. To use the new format, pass --format=junit-xml.

If you are running Beaker jobs from within Jenkins, you can use the JUnit XML results format with the Jenkins JUnit plugin in order to report your Beaker test results in Jenkins.

(Contributed by Dan Callaghan in #1123244, #1291112, and #1291107.)

User interface improvements

The web UI for managing groups has been revamped in order to improve performance, simplify interactions, and improve code maintainability. The improved groups grid also includes more powerful search functionality.

The web UI for administrators to manage lab controllers and power types has also been revamped. This also fixes an issue where deleting a power type which was still in use would result in a server error.

These enhancements are another small step on the road towards modernizing Beaker’s web UI using Flask and Backbone.

(Contributed by Matt Jia, Róman Joost, and Dan Callaghan in #1251356, #1275999, #1251355, and #1022461.)

Inverted groups

This release introduces a new type of user group, called “inverted groups”. An inverted group contains all Beaker users by default. The group owner can exclude specific users from the group.

For example, a Beaker administrator might create an inverted group named all-humans and then add service accounts for scripts and bots to the list of excluded users. System owners could then set up their access policies to grant permissions to the all-humans group. This would grant the permissions to all Beaker users except the excluded service accounts.

Inverted groups are needed in this case because Beaker’s system access policies are strictly additive: it is not possible to grant permission to a group while also denying it to some members of the group, because the access policies can only grant permissions and not deny them.

(Contributed by Matt Jia in #1220610.)

Other new features and enhancements

Beaker’s web UI can now automatically create user accounts for authenticated users based on the values of the REMOTE_USER, REMOTE_USER_EMAIL, and REMOTE_USER_FULLNAME WSGI environment variables. This is useful for Beaker sites which are using centralized authentication but cannot use Beaker’s existing support for looking up user information in an LDAP directory. For example, the Apache modules mod_auth_mellon (for SAML authentication) and mod_lookup_identity (for user lookups using sssd infopipe) can both be configured to set the necessary environment variables. (Contributed by Dan Callaghan in #1112925.)

Beaker now provides stable URLs for all job log files, which will redirect to the current storage location. This URL is now used when linking to logs in the web UI and in JUnit XML results. This avoids a problem where Beaker would link to the logs stored on the lab controller, but by the time a user clicks the link the logs have been moved to an archive server and the link is invalid. (Contributed by Dan Callaghan in #1291130.)

The JSON API for system details now includes detailed CPU and disk information. (Contributed by Róman Joost in #1206033 and #1206034.)

The bkr job-submit and bkr job-clone commands now accept a new --job-owner option, for submission delegates to submit jobs on behalf of other users. (Contributed by Hao Chang Yu in #1215138.)

The bkr job-modify command now accepts a new --priority option, for changing the priority of a queued job or recipe set. (Contributed by Matt Jia in #1149977.)

The Reserve report, which shows how long Beaker systems have been reserved for, now has a fully-featured search with the same capabilities as other systems grid pages. (Contributed by Róman Joost in #623562.)

Notable changes

Implicit job sharing is disabled

Beaker 0.13 introduced the group jobs feature, which allows group members full access to modify, cancel, and delete jobs submitted for their group. This was designed to replace the previous “implicit” job sharing model where any group member could modify or delete jobs submitted by any other member of any group.

Up until this release, the implicit job sharing behaviour was deprecated but was still enabled by default unless the Beaker administrator disabled it in the configuration. Starting from this release, implicit job sharing is disabled by default.

If you were relying on the implicit job sharing permissions, ensure that you and your group members submit group jobs. See Access control for jobs.

Beaker administrators can temporarily re-enable the implicit job sharing permissions by setting:

beaker.deprecated_job_group_permissions.on = True

in /etc/beaker/server.cfg, but this is not recommended because the new “inverted groups” feature in this release makes it trivial for any user to create a group containing all Beaker users, which would give them access to modify and delete every Beaker job under the deprecated implicit sharing model.

The implicit job sharing permissions will be deleted entirely in a future release.

(Contibuted by Dan Callaghan in #1280178.)

Workflow commands no longer force NFS installation by default

Previously, when running the bkr workflow commands without explicitly specifying an installation method using --method, by default method=nfs would be added to the recipe kickstart metadata, forcing the installation to use NFS.

The workflow commands no longer supply method=nfs by default. The Beaker scheduler will pick the best available installation method. Beaker will still prefer NFS when it is available, but if a distro tree is only available over HTTP that will be used instead.

(Contributed by Dan Callaghan in #1220652.)

Old Cancelled and Aborted jobs will be deleted

Previously the server-side command for deleting expired jobs, beaker-log-delete, would skip jobs which had no finish time. Typically this happens when the job was cancelled or aborted before it was scheduled. Such jobs will no longer be skipped and will be deleted according to the established job deletion policy.

(Contributed by Dan Callaghan in #1273302.)

Bug fixes

A number of bug fixes are also included in this release:

  • #1257020: When a user account is removed (closed), Beaker now also removes the account from all groups and system access policies. Previously the removed user could still appear in groups or policies, even though they had no access to Beaker. (Contributed by Dan Callaghan)
  • #970921, #647563: Fixed an error when adding, removing, or changing the numeric flag on key types. (Contributed by Róman Joost)
  • #979270: Adding duplicate key types is now correctly reported as an error. (Contributed by Róman Joost)
  • #1244996: Beaker versions prior to 0.15 could incorrectly store duplicate rows in the osmajor_install_options table. If such rows still existed in the database it would cause an error when saving OS major install options. This release includes a database migration to correct duplicate rows left behind from old Beaker versions. (Contributed by Dan Callaghan)

Maintenance updates

The following fixes have been included in Beaker 22 maintenance updates.

Beaker 22.1

  • #1295998: Closing </script> tags from the search value are now properly escaped in the search bar JSON. This fixes a “reflected XSS” (cross-site scripting) vulnerability. (Contributed by Dan Callaghan)
  • #1303023: Restored the result="" attribute on <result/> elements in the job results XML output. This attribute was dropped due to a regression in 22.0. (Contributed by Dan Callaghan)
  • #1302950: Fixed the logic for injecting <system_type/> into recipe host requirements. Due to a regression in 22.0, Beaker would incorrectly inject a contradictory <system_type/> filter when the host requirements already contained <system_type/> nested inside some other element. Beaker now correctly injects <system_type/> only when it is not already present anywhere in the host requirements. (Contributed by Dan Callaghan)
  • #1293010: The beaker-transfer daemon now skips logs for deleted jobs, instead of trying to move them unnecessarily. (Contributed by Matt Jia)
  • #1240809: The recipes.files XML-RPC method, which is used by beaker-transfer for finding logs to move, has been made more efficient and can now respond much faster for recipes with a large number of results. This allows beaker-transfer to cope better with large recipes. (Contributed by Matt Jia)

Version 3.4-8 of the /distribution/reservesys task has also been released:

  • #1205989: The task can now be used with the restraint harness. (Contributed by Bill Peck)

Beaker 22.2

  • #1302857: When a job is submitted, Beaker now strips surrounding whitespace from the <whiteboard/> XML element. This restores the behaviour from Beaker releases prior to 22.0, which many job XML generating tools are relying on. The job matrix whiteboard filtering now also correctly handles whiteboard values with embedded newlines, which may occur in jobs submitted to Beaker while this whitespace stripping behaviour was not in effect. (Contributed by Dan Callaghan)
  • #923637: The beaker-wizard tool supports a new skeleton type, parametrized, for generating tasks which use the $PACKAGES and $REQUIRES convention from beakerlib. (Contributed by Iveta Wiedermann)
  • #1309059: The Essentials tab on the system page no longer offers lab controllers which have been removed, when picking a lab controller to associate the system with. (Contributed by Matt Jia)
  • #1301410: The beaker-init command no longer attempts to populate the database with pre-defined values when downgrading, since that is always unnecessary and in many circumstances will fail. (Contributed by Dan Callaghan)
  • #1304927: Fixed a regression in Beaker 22.0 which caused all search queries on the Reserve Report to be ignored. (Contributed by Dan Callaghan)
  • #1308625: Fixed an error which prevented adding owners to inverted groups. (Contributed by Matt Jia)
  • #1311904: Fixed unintentional usage of ECMAScript 6 features on the group page, which caused errors when using the page in Google Chrome 44. (Contributed by Matt Jia)

Version 4.69 of the rhts test development and execution library has also been released:

  • #1277575: The internal rhts-db-submit-result command no longer uses any hashing algorithms. Previously, when run outside of the beah execution evironment (for example, by a user invoking extendtesttime.sh), the command would unnecessarily use MD5, which fails in FIPS mode. (Contributed by Dan Callaghan)
  • #1298934: The rhts-reboot command no longer attempts to inform beah about the upcoming reboot when it is run outside of the beah execution environment. This avoids a confusing traceback in the output. (Contributed by Dan Callaghan)

Beaker 22.3

  • #1296552: Beaker now considers an aborted reciped to be “suspicious” for the purposes of broken system detection if all tasks in the recipe are Aborted – regardless of whether the installation started or not. This restores the original behaviour prior to Beaker 21.2. (Contributed by Róman Joost)
  • #1313580: When the bkr client is configured to use a Kerberos keytab for authentication, it will now use a unique temporary filename for the Kerberos credentials cache. This is to workaround a race condition in libkrb5 when multiple processes are initializing a shared credentials cache file. (Contributed by Dan Callaghan)
  • #1316045: Fixed an error in the JUnit XML results output, when a recipe was cancelled or aborted before it started. (Contributed by Matt Jia)
  • #883020: The bkr workflow commands now show a more descriptive error message in case a malformed value is passed to the --hostrequire or --keyvalue options. (Contributed by Dan Callaghan)