Package: relvalconsumer
# relvalconsumerrelvalconsumeris a fedora-messaging consumer for creating Fedora release
validation test events. Each time a compose appears, it runs various checks
to decide whether it should create an event for the compose. It creates events
for both nightly composes and ‘candidate’ composes.It should create a first nightly for the next release shortly after a release
goes out. From then until the release, it will create new nightly events
periodically. It will never create a nightly event fewer than three days after
the current event. Between three and fourteen days after the current event,
it will create a new event if certain packages have changed (these are defined
in the code). After fourteen days it will create an event as soon as a nightly
compose appears. It will create events for all candidate composes as soon as
they appear.It should never create an event for a given release from a Rawhide compose
after that release branches, because at that point wikitcms will decide that
any notional event for a Rawhide compose would be for the releasetwoafter
the current stable release, and this script will create events only for the
releaseoneafter the current stable release.Note that in production mode the consumer is configured to create events in
the production wiki and send announcement emails to the test@ mailing list.
So, really, only one person should ever have it running in production mode,
and that’s probably me. Please don’t run it in production mode unless you’re
taking over my job or something.As long as relval is also installed, relvalconsumer will also run the image
size check on the newly-created event, whenever it creates an event.The project also includes another consumer, RelvalAMIConsumer, which updates
a wiki page containing information on available EC2 AMIs for a validation
event whenever a relevant ‘AMI published’ message is received from fedimg
(the tool that publishes Fedora AMI images to EC2).## RequirementsPython libraries:[fedora-messaging](https://github.com/fedora-infra/fedora-messaging)[fedfind](https://pagure.io/fedora-qa/fedfind)[wikitcms](https://pagure.io/fedora-qa/python-wikitcms)[mwclient](https://github.com/mwclient/mwclient)Thehawkeylibrary is also required. This is only available on Fedora and
RHEL and is only available from official package repositories, it is not
available from Pypi.Optionally also [relval](https://pagure.io/fedora-qa/relval) itself, to run
image size check tests on the created events.## InstallationInstall the required external Python libraries, then use setuptools to
install, e.g.:python3 setup.py installYou will also typically need to do:dnf install fedora-messaging python3-hawkey## ConfigurationA sample configuration file which is set up to listen for real compose events
on the production fedora-messaging bus is provided asrelvalconsumer.toml.
A sample file for the AMI consumer is provided asrelvalamiconsumer.toml.
To use these, you must at least change the queue name from00000000-0000-0000-0000-000000000000to a unique and private string; the
official recommendation is to use a UUID generated by uuidgen. Then place the
file in/etc/fedora-messaging.You can then enable and start the consumer as a systemd service:sudo systemctl enablefm-consumer@relvalconsumersudo systemctl startfm-consumer@relvalconsumerFor the AMI consumer:sudo systemctl enablefm-consumer@relvalamiconsumersudo systemctl startfm-consumer@relvalamiconsumer## Test and production modesA configuration setting,relval_prod, decides whether the consumer operates
in ‘production’ or ‘test’ mode. This is set in the consumer configuration
file’sconsumer_configsection. The corresponding setting for the AMI
consumer isrelvalami_prod. In test mode:The consumer creates events on the staging wiki (not production wiki)The announcement email is logged rather than being mailed outIn this mode it is fairly safe to play around with the consumer. You will need
a local fedora-messaging broker instance to be able to trigger the consumer at
will, though. Depending on how you set that up, you may also need to change
therouting_keysfrom.prod.to.dev.or similar.For ‘production’:The consumer creates events on the production wikiThe consumer sends email notifications to public mailing listsPLEASEdo not enable the production consumer unless you’re absolutely sure
it’s your job to create the official events.## Licenserelvalconsumeris released under the [GPL](https://www.gnu.org/licenses/gpl.txt), version 3 or later. SeeCOPYINGand the header ofrelvalconsumer.pyitself.## ContributingIssues and pull requests can be filed in [Pagure](https://pagure.io/fedora-qa/relvalconsumer).
Pull requests must be signed off (use the-sgit argument). By signing off
your pull request you are agreeing to the
[Developer’s Certificate of Origin](http://developercertificate.org/):Developer’s Certificate of Origin 1.1By making a contribution to this project, I certify that:The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; orThe contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; orThe contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.