Summary

Consolidate base CI support into a new base class.

Review Request #12831 — Created Feb. 13, 2023 and submitted March 1, 2023, 10:06 p.m.

Information

Owner

chipx86

Repository

rbintegrations

Branch

release-3.x

Bugs

Depends On

~~12831~~

Blocks

12831

Reviewers

Groups

rbintegrations

People

Description

This introduces a new rbintegrations.baseci module, containing a
BaseCIIntegration class. This class is responsible for listening to
publish and manual run requests, handling configuration queries, and
providing standard management of status updates.

There are new helpers for updating status updates with arbitrary fields,
or putting them into specific (standardized) modes. These are smart in
that they'll only make changes to status updates for fields that are
given new values.

Subclasses no longer need to implement separate code paths for publish
and manual run. Instead, they just implement an optional
prepare_build() method to filter configurations or supply state for
builds, and start_build() for actually performing the build.

Build state generation and validation is taken care of in the base
class, and errors on status updates are automatically set based on
whether start_build() raises a CIBuildError or a plain exception.

This will soon be followed up by a change to make use of new
StatusUpdate methods for status changes, and to correctly handle
manual run requests for the right configuration. Both of those will
be available in Review Board 5.0.3.

Testing Done

Unit tests pass on all supported versions of Python.

This will be pending a test in production by a customer.

Commits

Summary	ID
Consolidate base CI support into a new base class. This introduces a new `rbintegrations.baseci` module, containing a `BaseCIIntegration` class. This class is responsible for listening to publish and manual run requests, handling configuration queries, and providing standard management of status updates. There are new helpers for updating status updates with arbitrary fields, or putting them into specific (standardized) modes. These are smart in that they'll only make changes to status updates for fields that are given new values. Subclasses no longer need to implement separate code paths for publish and manual run. Instead, they just implement an optional `prepare_build()` method to filter configurations or supply state for builds, and `start_build()` for actually performing the build. Build state generation and validation is taken care of in the base class, and errors on status updates are automatically set based on whether `start_build()` raises a `CIBuildError` or a plain exception. This will soon be followed up by a change to make use of new `StatusUpdate` methods for status changes, and to correctly handle manual run requests for the right configuration. Both of those will be available in Review Board 5.0.3.	fcf1a5fa6c1a73f1dd40fbedff138245e3b0eaff

Summary

Consolidate base CI support into a new base class.

This introduces a new `rbintegrations.baseci` module, containing a `BaseCIIntegration` class. This class is responsible for listening to publish and manual run requests, handling configuration queries, and providing standard management of status updates. There are new helpers for updating status updates with arbitrary fields, or putting them into specific (standardized) modes. These are smart in that they'll only make changes to status updates for fields that are given new values. Subclasses no longer need to implement separate code paths for publish and manual run. Instead, they just implement an optional `prepare_build()` method to filter configurations or supply state for builds, and `start_build()` for actually performing the build. Build state generation and validation is taken care of in the base class, and errors on status updates are automatically set based on whether `start_build()` raises a `CIBuildError` or a plain exception. This will soon be followed up by a change to make use of new `StatusUpdate` methods for status changes, and to correctly handle manual run requests for the right configuration. Both of those will be available in Review Board 5.0.3.

fcf1a5fa6c1a73f1dd40fbedff138245e3b0eaff

Issues

Description	From	Last Updated
In your description, 3rd paragraph, "Status Updates" should be "status updates"	david	Feb. 27, 2023, 2 p.m.
Should add a docstring to rbintegrations/baseci/__init__.py.	maubin	Feb. 28, 2023, 4:42 p.m.
Should be either "StatusUpdate" (probably with a link), or "status update"	david	Feb. 27, 2023, 1:35 p.m.
Should be either "StatusUpdate" (with a link) or "status updates". Same throughout the rest of the change.	david	Feb. 27, 2023, 1:35 p.m.
Let's change "They" to "It" here just to be a bit more clear.	david	Feb. 27, 2023, 1:39 p.m.
Small nitpick: can use StatusUpdate here	maubin	Feb. 28, 2023, 4:42 p.m.
Looks like the end of the sentence got cut off.	maubin	Feb. 28, 2023, 4:55 p.m.
Could add a Returns section to the docstring while you're here.	maubin	Feb. 28, 2023, 5 p.m.

flake8 passed.

JSHint passed.

Show all issues

In your description, 3rd paragraph, "Status Updates" should be "status updates"

chipx86 Feb. 27, 2023, 1:35 p.m.

I kept having to mentally make this correction. I feel we should brand more of these things. A simple "status update" can be read as a more general concept whereas "Status Update" is a feature we can refer to.

Changing these though.

rbintegrations/baseci/errors.py (Diff revision 1)

Show all issues

Should be either "StatusUpdate" (probably with a link), or "status update"

rbintegrations/baseci/integration.py (Diff revision 1)

Show all issues

Should be either "StatusUpdate" (with a link) or "status updates". Same throughout the rest of the change.

rbintegrations/baseci/integration.py (Diff revision 1)

Show all issues

Let's change "They" to "It" here just to be a bit more clear.

Change Summary:

Switched terminology to StatusUpdate (with a link) or status update (often with :term:) where appropriate.

Description:

		This introduces a new `rbintegrations.baseci` module, containing a
		`BaseCIIntegration` class. This class is responsible for listening to
		publish and manual run requests, handling configuration queries, and
		providing standard management of status updates.

		There are new helpers for updating status updates with arbitrary fields,
		or putting them into specific (standardized) modes. These are smart in
		that they'll only make changes to status updates for fields that are
		given new values.

		Subclasses no longer need to implement separate code paths for publish
		and manual run. Instead, they just implement an optional
		`prepare_build()` method to filter configurations or supply state for
		builds, and `start_build()` for actually performing the build.

		Build state generation and validation is taken care of in the base
~		class, and errors on Status Updates are automatically set based on
	~	class, and errors on status updates are automatically set based on
		whether `start_build()` raises a `CIBuildError` or a plain exception.

		This will soon be followed up by a change to make use of new
		`StatusUpdate` methods for status changes, and to correctly handle
		manual run requests for the right configuration. Both of those will
		be available in Review Board 5.0.3.

Commits:

	Summary	ID
	Consolidate base CI support into a new base class. This introduces a new `rbintegrations.baseci` module, containing a `BaseCIIntegration` class. This class is responsible for listening to publish and manual run requests, handling configuration queries, and providing standard management of status updates. There are new helpers for updating status updates with arbitrary fields, or putting them into specific (standardized) modes. These are smart in that they'll only make changes to status updates for fields that are given new values. Subclasses no longer need to implement separate code paths for publish and manual run. Instead, they just implement an optional `prepare_build()` method to filter configurations or supply state for builds, and `start_build()` for actually performing the build. Build state generation and validation is taken care of in the base class, and errors on Status Updates are automatically set based on whether `start_build()` raises a `CIBuildError` or a plain exception. This will soon be followed up by a change to make use of new `StatusUpdate` methods for status changes, and to correctly handle manual run requests for the right configuration. Both of those will be available in Review Board 5.0.3.	de0e3e5ffbc3f7fa351059de20b66c7932b290b9
	Consolidate base CI support into a new base class. This introduces a new `rbintegrations.baseci` module, containing a `BaseCIIntegration` class. This class is responsible for listening to publish and manual run requests, handling configuration queries, and providing standard management of status updates. There are new helpers for updating status updates with arbitrary fields, or putting them into specific (standardized) modes. These are smart in that they'll only make changes to status updates for fields that are given new values. Subclasses no longer need to implement separate code paths for publish and manual run. Instead, they just implement an optional `prepare_build()` method to filter configurations or supply state for builds, and `start_build()` for actually performing the build. Build state generation and validation is taken care of in the base class, and errors on status updates are automatically set based on whether `start_build()` raises a `CIBuildError` or a plain exception. This will soon be followed up by a change to make use of new `StatusUpdate` methods for status changes, and to correctly handle manual run requests for the right configuration. Both of those will be available in Review Board 5.0.3.	cab607aa3445cf366d930c9b50050f8ff94c74b2

Diff:

Revision 2 (+5110 -1632)

Show changes

	rbintegrations/__init__.py
	rbintegrations/baseci/__init__.py
	rbintegrations/baseci/errors.py
	rbintegrations/baseci/integration.py
	rbintegrations/baseci/tests/__init__.py
	rbintegrations/baseci/tests/test_base_ci_integration.py
	rbintegrations/circleci/integration.py
	rbintegrations/jenkinsci/common.py
	3 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Posted the right revision of the update for review feedback.

Commits:

	Summary	ID
	Consolidate base CI support into a new base class. This introduces a new `rbintegrations.baseci` module, containing a `BaseCIIntegration` class. This class is responsible for listening to publish and manual run requests, handling configuration queries, and providing standard management of status updates. There are new helpers for updating status updates with arbitrary fields, or putting them into specific (standardized) modes. These are smart in that they'll only make changes to status updates for fields that are given new values. Subclasses no longer need to implement separate code paths for publish and manual run. Instead, they just implement an optional `prepare_build()` method to filter configurations or supply state for builds, and `start_build()` for actually performing the build. Build state generation and validation is taken care of in the base class, and errors on status updates are automatically set based on whether `start_build()` raises a `CIBuildError` or a plain exception. This will soon be followed up by a change to make use of new `StatusUpdate` methods for status changes, and to correctly handle manual run requests for the right configuration. Both of those will be available in Review Board 5.0.3.	cab607aa3445cf366d930c9b50050f8ff94c74b2
	Consolidate base CI support into a new base class. This introduces a new `rbintegrations.baseci` module, containing a `BaseCIIntegration` class. This class is responsible for listening to publish and manual run requests, handling configuration queries, and providing standard management of status updates. There are new helpers for updating status updates with arbitrary fields, or putting them into specific (standardized) modes. These are smart in that they'll only make changes to status updates for fields that are given new values. Subclasses no longer need to implement separate code paths for publish and manual run. Instead, they just implement an optional `prepare_build()` method to filter configurations or supply state for builds, and `start_build()` for actually performing the build. Build state generation and validation is taken care of in the base class, and errors on status updates are automatically set based on whether `start_build()` raises a `CIBuildError` or a plain exception. This will soon be followed up by a change to make use of new `StatusUpdate` methods for status changes, and to correctly handle manual run requests for the right configuration. Both of those will be available in Review Board 5.0.3.	604074cf38b3eb742967e11757b5e906cc3360b3

Diff:

Revision 3 (+5136 -1632)

Show changes

	rbintegrations/__init__.py
	rbintegrations/baseci/__init__.py
	rbintegrations/baseci/errors.py
	rbintegrations/baseci/integration.py
	rbintegrations/baseci/tests/__init__.py
	rbintegrations/baseci/tests/test_base_ci_integration.py
	rbintegrations/circleci/integration.py
	rbintegrations/jenkinsci/common.py
	3 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Show all issues

Should add a docstring to rbintegrations/baseci/__init__.py.

rbintegrations/baseci/integration.py (Diff revision 3)
Show all issues
```
Small nitpick: can use StatusUpdate here
```

rbintegrations/baseci/tests/test_base_ci_integration.py (Diff revision 3)

Show all issues

Looks like the end of the sentence got cut off.

chipx86 Feb. 28, 2023, 4:43 p.m.

Sometimes you can see the points at which I had to context-switch to deal with something else :)

maubin Feb. 28, 2023, 9:13 p.m.
```
Heh
```

rbintegrations/jenkinsci/integration.py (Diff revision 3)

Show all issues

Could add a Returns section to the docstring while you're here.

Change Summary:


Added missing documentation.
Fleshed out and improved other docs.

Commits:

	Summary	ID
	Consolidate base CI support into a new base class. This introduces a new `rbintegrations.baseci` module, containing a `BaseCIIntegration` class. This class is responsible for listening to publish and manual run requests, handling configuration queries, and providing standard management of status updates. There are new helpers for updating status updates with arbitrary fields, or putting them into specific (standardized) modes. These are smart in that they'll only make changes to status updates for fields that are given new values. Subclasses no longer need to implement separate code paths for publish and manual run. Instead, they just implement an optional `prepare_build()` method to filter configurations or supply state for builds, and `start_build()` for actually performing the build. Build state generation and validation is taken care of in the base class, and errors on status updates are automatically set based on whether `start_build()` raises a `CIBuildError` or a plain exception. This will soon be followed up by a change to make use of new `StatusUpdate` methods for status changes, and to correctly handle manual run requests for the right configuration. Both of those will be available in Review Board 5.0.3.	604074cf38b3eb742967e11757b5e906cc3360b3
	Consolidate base CI support into a new base class. This introduces a new `rbintegrations.baseci` module, containing a `BaseCIIntegration` class. This class is responsible for listening to publish and manual run requests, handling configuration queries, and providing standard management of status updates. There are new helpers for updating status updates with arbitrary fields, or putting them into specific (standardized) modes. These are smart in that they'll only make changes to status updates for fields that are given new values. Subclasses no longer need to implement separate code paths for publish and manual run. Instead, they just implement an optional `prepare_build()` method to filter configurations or supply state for builds, and `start_build()` for actually performing the build. Build state generation and validation is taken care of in the base class, and errors on status updates are automatically set based on whether `start_build()` raises a `CIBuildError` or a plain exception. This will soon be followed up by a change to make use of new `StatusUpdate` methods for status changes, and to correctly handle manual run requests for the right configuration. Both of those will be available in Review Board 5.0.3.	fcf1a5fa6c1a73f1dd40fbedff138245e3b0eaff

Diff:

Revision 4 (+5166 -1630)

Show changes

	rbintegrations/__init__.py
	rbintegrations/baseci/__init__.py
	rbintegrations/baseci/errors.py
	rbintegrations/baseci/integration.py
	rbintegrations/baseci/tests/__init__.py
	rbintegrations/baseci/tests/test_base_ci_integration.py
	rbintegrations/circleci/integration.py
	rbintegrations/jenkinsci/common.py
	3 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.x (2013b92)