| commit | bf9bff08be00805d188752c58210827d4fa7ff9e | [log] [tgz] |
|---|---|---|
| author | Jacek Centkowski <geminica.programs@gmail.com> | Mon Jun 17 10:13:36 2024 +0200 |
| committer | Jacek Centkowski <geminica.programs@gmail.com> | Tue Jun 18 07:44:47 2024 +0200 |
| tree | 3fe1143a92115df484228570529df3d1d75f8d4d | |
| parent | 09cf417207fc8f06ccd4c2b8d53a3142eddd0569 [diff] |
Always expose `has:approval_owners` submit requirement predicate The `owners.enableSubmitRequirement = true` is a global switch that allows for quick site switch from `prolog` submit rule to plugin's provided submit rule. However in case when such migration is not feasible (e.g. when `prolog` rules need to be slowly phased out or when more control is needed over rule's applicability) one can now turn submit requirement in `project.config` for a certain project (or hierarchy of projects), without turning it on globally. Changes: * the `approval_owners` submit requirement operand is always registered * operand propagates rule error through the `SubmitRequirementEvaluationException` so that it can be properly handled in the UI * all existing integration tests were adjusted to verify that plugin works correctly also in new mode * the configuration was updated to highlight such possibility Bug: Issue 345837787 Change-Id: Iaca45dd47e23d5f2d40a2732b52abdaeba170e8d
This plugin provides some Prolog predicates that can be used to add customized validation checks based on the approval of ‘path owners’ of a particular folder in the project.
That allows creating a single big project including multiple components and users have different roles depending on the particular path where changes are being proposed. A user can be “owner” in a specific directory, and thus influencing the approvals of changes there, but cannot do the same in others paths, so assuring a kind of dynamic subproject access rights.
There are currently two main prolog public verbs:
add_owner_approval/3 (UserList, InList, OutList) appends label('Owner-Approval', need(_)) to InList building OutList if UserList has no users contained in the defined owners of this path change.
In other words, the predicate just copies InList to OutList if at least one of the elements in UserList is an owner.
add_owner_approval/2 (InList, OutList) appends label('Owner-Approval', need(_)) to InList building OutList if no owners has given a Code-Review +2 to this path change.
This predicate is similar to the first one but generates a UserList with an hardcoded policy.
Since add_owner_approval/3 is not using hard coded policies, it can be suitable for complex customizations.
There is a second plugin, gerrit-owners-autoassign which depends on gerrit-owners. It will automatically assign all of the owners to review a change when it's created or updated.
This plugin is built with Bazel and two build modes are supported:
To build the plugin, issue the following command:
bazel build :all
The output is created in
bazel-bin/owners/owners.jar bazel-bin/owners-autoassign/owners-autoassign.jar bazel-bin/owners-api/owners-api.jar
To execute the tests run:
bazel test //...
This project can be imported into the Eclipse IDE:
./tools/eclipse/project.sh
Create symbolic links of the owners and owners-autoassign folders and of the external_plugin_deps.bzl file to the Gerrit source code /plugins directory.
Create a symbolic link of the owners-common plugin to the Gerrit source code directory.
Then build the owners and owners-autoassign plugins with the usual Gerrit plugin compile command.
Example:
$ git clone https://gerrit.googlesource.com/plugins/owners $ git clone https://gerrit.googlesource.com/gerrit $ cd gerrit/plugins $ ln -s ../../owners/owners . $ ln -s ../../owners/owners-autoassign . $ ln -s ../../owners/owners-api . $ ln -sf ../../owners/external_plugin_deps.bzl . $ cd .. $ ln -s ../owners/owners-common . $ bazel build plugins/owners plugins/owners-autoassign
NOTE: the owners-common folder is producing shared artifacts for the two plugins and does not need to be built separately being a direct dependency of the build process. Its resulting .jar must not be installed in gerrit plugins directory.
The output is created in
bazel-bin/plugins/owners/owners.jar bazel-bin/plugins/owners-autoassign/owners-autoassign.jar
To execute the tests run:
bazel test owners-common:test
This project can be imported into the Eclipse IDE:
Add the plugin name to the CUSTOM_PLUGINS (and in case when you want to run tests from the IDE to CUSTOM_PLUGINS_TEST_DEPS) in Gerrit core in tools/bzl/plugins.bzl file and run:
./tools/eclipse/project.py