Commit Graph
575 Commits
Author SHA1 Message Date
Lars Wirzenius 2ef02467f8 feat: add predicate DefaultBranch
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-02-04 16:59:22 +02:00
Lars Wirzenius 14ad23cc83 feat: refuse configuration files with unknown fields
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-02-04 14:45:05 +02:00
Lars Wirzenius a3dbd8f8be feat: log event filter evaluation in more detail
This is a step towards making filters more transparent.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-31 11:52:02 +02:00
Lars Wirzenius f97b3da6de feat: log filter decision more clearly, at info level
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-31 11:24:58 +02:00
Lars Wirzenius 9e84afecbf feat! change the "Not" event filter to take a list of filters
Change the logical negation operator `Not` to take a list of filters
as operands. The operator returns true, if and only if all of the
operands are false. The syntax is now consistent with logical `And`
and `Or`, which simplifies code, and is expected to simplify use.

In YAML syntax, `Not` now works like this:

~~~
!Not
  - !Allow
~~~

Previously, `!Not` only had one operand, so that above would have been
expressed as `!Not Allow`.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-30 15:36:57 +02:00
Fintan Halpenny 3edb0ed017 chore: rountrip property test for EventFilter
Introduce the use of the `qcheck` crate to generate examples of `EventFilter`,
so that a YAML roundtrip test can be added.
2025-01-30 15:00:54 +02:00
Fintan Halpenny d31347d179 fix: fix (de)serialization of EventFilter
The `EventFilter::Not` variant would not correctly deserialize, resulting in the
following error:

    deserializing nested enum in EventFilter::Not from YAML is not supported yet

This can be fixed by using `#[serde(with = "serde_yml::with::singleton_map")]`
on that variant.

A test case is provided to show that a `Not` case can be deserialized correctly.

The change also includes some improvements to `EventFilter`:
- Add `PartialEq` and `Eq` for testing equality in testing
- The `And` and `Or` variants do not need the `Box`, since the `Vec` acts as a
  size pointer for the recursive `Self` – unlike the `Not` variant.
2025-01-30 15:00:54 +02:00
Lars Wirzenius d0c6a8c8c1 test(ci-broker.md): verify event filter Not
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 18:00:01 +02:00
Lars Wirzenius d97f1c6720 test(ci-broker.md): verify event filter Or
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 18:00:01 +02:00
Lars Wirzenius 42bded3825 test(ci-broker.md): verify event filter And
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 18:00:01 +02:00
Lars Wirzenius 28ee4580e0 test(ci-broker.md): verify event filter Deny
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:42:49 +02:00
Lars Wirzenius 568592aabc test(ci-broker.md): verify event filter Allow
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:42:49 +02:00
Lars Wirzenius e0a967af68 test(ci-broker.md): verify event filter BranchDeleted
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:42:49 +02:00
Lars Wirzenius 791b7cad6d test(ci-broker.md): verify event filter BranchUpdated
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:42:49 +02:00
Lars Wirzenius bb5cf1273a test(ci-broker.md): verify event filter BranchCreated
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:42:47 +02:00
Lars Wirzenius d1e9b5e159 test(ci-broker.md): verify event filter Branch
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:42:37 +02:00
Lars Wirzenius 59deeed8c1 test(ci-broker.md): verify event filter Node
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:41:37 +02:00
Lars Wirzenius 2ea38588ad test(ci-broker.md): verify event filter Repository
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:41:16 +02:00
Lars Wirzenius c4bae7b09b test(ci-broker.md): use cibtool trigger option defaults
"cibtool trigger" option "--ref" defaults to "main" and "--commit" to
"HEAD", and there's no need to say those explicitly.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:41:06 +02:00
Lars Wirzenius c045335b69 feat: make log message about patch COB not found clearer
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:41:06 +02:00
Lars Wirzenius d491111726 feat(src/config.rs): make the "env" field for an adapter optional
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:41:06 +02:00
Lars Wirzenius 88e7d75a59 refactor: make Config fields env, sensitive_env private
We already have getters so no other change.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 17:39:54 +02:00
Lars Wirzenius f65a5b83b3 tests: trim releases for upgrade testing
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 11:27:58 +02:00
Lars Wirzenius 64e76a97a8 chore: prepare release 0.12.0
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 11:08:29 +02:00
Lars Wirzenius 030a390159 fix(src/config.rs): use dedicated constant for default interval
The default doesn't change, but it's now called
`DEFAULT_QUEUE_LEN_INTERVAL` instead of `DEFAULT_MAX_RUN_TIME`.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 10:50:59 +02:00
Lars Wirzenius f736bdf8e6 tests(ci-broker.md): document what to upgrade test, use commits
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-29 10:23:33 +02:00
Lars Wirzenius ba9b4365f9 fix(ci-broker.md): drop bashism: set -o pipefail.
On a machine where /bin/sh it not Bash, the pipefail setting will
fail.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-27 18:01:24 +02:00
Lars Wirzenius 3da72805e9 feat! drop Db::queued_events
For several releases already, `cib` has refused to start if the
database has any "broker events". Broker events were a predecessor for
CI events, and they haven't been supported by the CI broker since
0.7.0, from October 2024.

Drop the Db method to query the database for queued broker events.
Also drop the creation of a table for that queue.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-27 17:41:02 +02:00
Fintan Halpenny da7971ada3 chore: add cargo audit
Add a check for auditing the project via `cargo audit`.

Note that a RUSTSEC is ignored due to it not affecting the project – this is
recoreded in `.cargo/audit.toml`.
2025-01-24 10:24:44 +00:00
Fintan Halpenny 8d67442766 chore: add cargo deny
Adds `deny.toml` for running `cargo deny` on the project.

As well as adding a `deny` check in the Nix flake.
2025-01-24 10:24:33 +00:00
Fintan Halpenny ddac7386c9 chore: add Nix Flake
Adds a `flake.nix` for building and testing the radicle-ci-broker using Nix.

Auditing and license denial configurations are also added as part of the `nix
flake check`s.

Note that one of the tests is ignore as part of the nextest check, since it
relies on using the Git repository itself. This is discouraged, since the check
runs in a sandboxed environment.
2025-01-24 10:24:17 +00:00
Fintan Halpenny 8cbc1fe313 refactor: change test shell commands
While setting up a Nix flake, a series of tests were failing due to shell
invocations. The falling were the changes required:

- Use `!#/bin/sh` instead of `!#/bin/bash`
- Use `$$` instead of `$BASHPID`
- Use `true` and `false` instead of `/bin/true` and `/bin/false`

It was also noted that the `git-remote-helper` is needed alongside the `rad`
binary for some of the acceptance tests to work.
2025-01-24 10:23:49 +00:00
Lars Wirzenius 25a8d24d30 docs(doc/userguide.md): document "triggers" feature
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-23 18:20:22 +02:00
Lars Wirzenius 1336037b91 fix(.radicle/ambient.yaml): clean up for deb building
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-22 10:15:35 +02:00
Lars Wirzenius 501bb8ca3d fix(.radicle/ambient.yaml): skip upgrade tests
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-22 10:09:21 +02:00
Lars Wirzenius 7141c3261a fix(.radicle/ambient.yaml): set missing env vars
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-22 09:55:13 +02:00
Lars Wirzenius c5bcb6e918 build: add .radicle/ambient.yaml to allow Radicle CI use Ambient
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-22 09:50:20 +02:00
Lars Wirzenius c239dfb0a9 fix(ci-broker.md): drop unused embedded file
Unused files make `subplot docgen` fail unless it's given the
`--merciful` option.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-22 09:46:51 +02:00
Lars Wirzenius aaf687376c tests: add scenarios to verify new "triggers" functionality
Also add a useful extra step.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-21 19:11:39 +02:00
Lars Wirzenius 9af108485d feat: add optional "triggers" to config
A trigger is a condition (filter) when to run CI using a specific
adapter. Change the configuration to allow them, and make the old list
of filters and default adapter be optional. This way, the user can use
either or both.

CI is run for each of:

- top level filter matches, using default adapter
- trigger filter matches, using the adapter specified in the trigger

To be clear, this can mean that CI is run many times for one CI event.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-21 19:07:07 +02:00
Lars Wirzenius ee34af59f1 feat: construct a collection of all adapters that knows the default
Construct the collection, and give it to the queue processor, which is
the only part that needs to know what adapters there are.

For now, only the default adapter is used, but this makes a space from
which to pick a different for each CI run.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-21 17:01:34 +02:00
Lars Wirzenius 7ebe081334 refactor: allow picking many adapters
This is preparation for allowing many triggers: we will want to allow
any number of triggers allow a single change, resulting in a different
CI run for each. Change the code that picks an adapter to be able to
pick any number of them, and then run all of them. Even if one fails,
run the rest.

This will potentially mean run the same adapter many times, although
it's meant to allow running a different adapter for each trigger.
Running the same adapter many times may be pointless, but we can't
reliably know that, only the user can. It depends on the adapter, the
change, and what the user is trying to achieve. So for now we don't
worry about that. If it turns out to be important, we can later add a
way to say each adapter will only be run once.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-21 17:00:19 +02:00
Lars Wirzenius ba644e14d6 feat: filter queued events when they are processed
Move CI event filtering from the queue adder to the queue processor.
This is ground work for supporting different adapters for different
runs.

Later, each "trigger" will have a separate filter, and if the filter
allows an event, the adapter for that trigger is run. However, we have
no way to communicate the chosen adapter via the event queue in the
database, without making a breaking database schema, which I would
prefer to avoid.

Instead, we add all events into the queue, and filter when we remove
them from the queue. This may be a little wasteful in terms of disk
space and I/O, if there are very large numbers of events. If this
turns out to be too expensive, we'll revert this change and do a
breaking schema change.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-21 17:00:19 +02:00
Lars Wirzenius 73c533580a refactor: Broker::execute_ci is given adapter to use
Remove the default adapter from Broker, and make callers give the
adapter to use to the Broker::execute_ci method each time. This is
ground work for allowing different adapters for different CI runs.

There's no need for Broker to know about any adapters, except the one
it is currently running.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-21 17:00:16 +02:00
Lars Wirzenius 2e37eb04f4 refactor: drop custom Debug implementation of AdapterConfig
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-20 18:00:18 +02:00
Lars Wirzenius e55a7de242 refactor: Config::default_adapter returns an adapter, not its config
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-20 17:57:19 +02:00
Lars Wirzenius 9418e98863 refactor: make Broker::default_adapter() method private
It's only used in `src/broker.rs` after all.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-20 17:41:19 +02:00
Lars Wirzenius 2a7ddc303a refactor: can't create a Broker without setting default adapter
There's no point in making it optional at this stage.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-20 17:34:40 +02:00
Lars Wirzenius 6e52f1da50 refactor(src/broker.rs): drop unnecessary adapter method
The default_adapter method can be used in every case.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-20 17:26:48 +02:00
Lars Wirzenius 346b871938 refactor(src/broker.rs): drop list of adapters
The broker overall only supports the default adapter. When we add
support for using an adapter other than the default one, it'll not be
per repository.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-20 17:23:37 +02:00