Re: [RFC 1/1] docs/deve/ci-plan: define a high-level plan for the QEMU GitLab CI

[Daniel P . Berrangé]

On Tue, Sep 14, 2021 at 03:48:30PM -0300, Willian Rampazzo wrote:
> This adds a high-level plan for the QEMU GitLab CI based on use cases.
> The idea is to have a base for evolving the QEMU CI. It sets high-level
> characteristics for the QEMU CI use cases, which helps guide its
> development.
> 
> Signed-off-by: Willian Rampazzo <willianr@redhat.com>
> ---
>  docs/devel/ci-plan.rst | 77 ++++++++++++++++++++++++++++++++++++++++++
>  docs/devel/ci.rst      |  1 +
>  2 files changed, 78 insertions(+)
>  create mode 100644 docs/devel/ci-plan.rst
> 
> diff --git a/docs/devel/ci-plan.rst b/docs/devel/ci-plan.rst
> new file mode 100644
> index 0000000000..5e95b6bcea
> --- /dev/null
> +++ b/docs/devel/ci-plan.rst
> @@ -0,0 +1,77 @@
> +The GitLab CI structure
> +=======================
> +
> +This section describes the current state of the QEMU GitLab CI and the
> +high-level plan for its future.
> +
> +Current state
> +-------------
> +
> +The mainstream QEMU project considers the GitLab CI its primary CI system.
> +Currently, it runs 120+ jobs, where ~36 are container build jobs, 69 are QEMU
> +build jobs, ~22 are test jobs, 1  is a web page deploy job, and 1 is an
> +external job covering Travis jobs execution.
> +
> +In the current state, every push a user does to its fork runs most of the 
> jobs
> +compared to the jobs running on the main repository. The exceptions are the
> +acceptance tests jobs, which run automatically on the main repository only.
> +Running most of the jobs in the user's fork or the main repository is not
> +viable. The job number tends to increase, becoming impractical to run all of
> +them on every single push.
> +
> +Future of QEMU GitLab CI
> +------------------------
> +
> +Following is a proposal to establish a high-level plan and set the
> +characteristics for the QEMU GitLab CI. The idea is to organize the CI by use
> +cases, avoid wasting resources and CI minutes, anticipating the time GitLab
> +starts to enforce minutes limits soon.
> +
> +Use cases
> +^^^^^^^^^
> +
> +Below is a list of the most common use cases for the QEMU GitLab CI.
> +
> +Gating
> +""""""
> +
> +The gating set of jobs runs on the maintainer's pull requests when the 
> project
> +leader pushes them to the staging branch of the project. The gating CI 
> pipeline
> +has the following characteristics:
> +
> + * Jobs tagged as gating run as part of the gating CI pipeline;
> + * The gating CI pipeline consists of stable jobs;
> + * The execution duration of the gating CI pipeline should, as much as 
> possible,
> +   have an upper bound limit of 2 hours.
> +
> +Developers
> +""""""""""
> +
> +A developer working on a new feature or fixing an issue may want to 
> run/propose
> +a specific set of tests. Those tests may, eventually, benefit other 
> developers.
> +A developer CI pipeline has the following characteristics:
> +
> + * It is easy to run current tests available in the project;
> + * It is easy to add new tests or remove unneeded tests;
> + * It is flexible enough to allow changes in the current jobs.
> +
> +Maintainers
> +"""""""""""
> +
> +When accepting developers' patches, a maintainer may want to run a specific
> +test set. A maintainer CI pipeline has the following characteristics:
> +
> + * It consists of tests that are valuable for the subsystem;
> + * It is easy to run a set of specific tests available in the project;
> + * It is easy to add new tests or remove unneeded tests.


Neither of these describe why I use CI as a developer and/or subsys 
maintainer.

My desire with using CI is to (as close as possible) be able to 
execute the exact same  set of tests that will be run by gating CI
on pull requests.

My goal is to minimize (ideally eliminate) the risk that a patch 
series or pull request gets rejected with a need to re-spin due 
to CI failures. Each such rejection causes a round trip delaying 
merge, and this wastes my time & the maintainer/gate keepers' time. 
It is also hard to debug failures if I can't replicate the gating 
CI myself.

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|