~jugmac00/lpci:add-more-hooks

Branch merges

Propose for merging

Merged into lpci:main at revision f16ec90b5a97b9e324992884824b5b2edf00d0cf

Colin Watson (community): Approve on 2021-12-17

Diff: 398 lines (+151/-37)

8 files modified

docs/plugins.rst (+5/-0)
lpcraft/commands/run.py (+39/-16)
lpcraft/commands/tests/test_run.py (+14/-14)
lpcraft/config.py (+4/-0)
lpcraft/plugin/hookspecs.py (+21/-0)
lpcraft/plugin/lib.py (+6/-0)
lpcraft/plugin/tests/test_plugins.py (+51/-7)
lpcraft/plugins/tox.py (+11/-0)

api

Related source package recipes

No recipes using this branch. (?)

Create packaging recipe

Related snap packages

Related charm recipes

f16ec90... by Jürgen Gmach on 2021-12-17

Generalize test outcome

f7024ff... by Jürgen Gmach on 2021-12-17

`run` command from configuration file takes precedence

Please note: when both a plugin and the configuration file are
providing a `run` command, the one from the configuration file will be
used

Previously, defining the `run` command twice errored.

abeecae... by Jürgen Gmach on 2021-12-17

Add todo comment

73986b7... by Jürgen Gmach on 2021-12-17

Add hook for environment variables

Please note: when there is the same environment variable provided by
the plugin and the configuration file, the one in the configuration
file will be taken into account.

f9ed3ad... by Jürgen Gmach on 2021-12-17

Add hook for the run command

Please note that it is not allowed to have more than one run command
specified, e.g. from configuration and from a plugin.

d5994ff... by Jürgen Gmach on 2021-12-17

Add hook for the snaps to be installed

dfd240b... by Jürgen Gmach on 2021-12-14

Introduce pluggy to manage plugins

pluggy ( https://pluggy.readthedocs.io/en/stable/ ) let's you define
hooks which then plugins can implement.

Example:
Using the new hook `lpcraft_install_packages` one can add additional
system packages to be installed with `apt`.

Please refer to the documentation on how to create your own plugin.

0e98f96... by Colin Watson on 2021-12-16

Note that run-one is subject to change

83c29b8... by Colin Watson on 2021-12-16

Simplify assertion

8825d44... by Colin Watson on 2021-12-13

Add a "run-one" command

We need a way to run only a single job from a pipeline, both because we
want an easy way to record log output for separate jobs separately, and
because we want to be able to retry individual jobs.

Matrix expansion makes this somewhat complicated, because as a result
there can be multiple expanded job definitions with the same name that
differ only in (for example) series or environment. The simplest
approach I can think of turns out to be to just take an index as well as
the job name; this is safe since matrix expansion has a stable order,
and in Launchpad the dispatcher end is going to need to do its own
matrix expansion anyway.

I went for a separate "run-one" command rather than options to "run"
since the command-line syntax is sufficiently different that it makes
sense to validate it separately.