Google Git
Sign in
gerrit / plugins / owners / 703d90daea92de66a9dc1bcc63637b335a7f8909
commit703d90daea92de66a9dc1bcc63637b335a7f8909[log] [tgz]
authorJacek Centkowski <geminica.programs@gmail.com>Sat Nov 09 08:48:08 2024 +0100
committerJacek Centkowski <geminica.programs@gmail.com>Mon Nov 18 18:30:10 2024 +0100
tree0665e198bc098d66ad8074b31d74a4d5f3a314d9
parent4517211df6739e2a631056080cec6ec9b10cb9c1 [diff]
Introduce OwnersApiCache

When Gerrit UI loads files owners status it treats each file as
an independent UI component therefore as a result plugin's REST API
endpoint is called for each one of them. The `Owned Files` tab adds an
extra call on the top of that. The same applies for getting the
currently logged in user account details.

Reduce it to a single call per REST API endpoint by OwnersApiCache
introduction (the idea is again transplanted from `code-owners` plugin).

It is a safe bet as in the event of change modification (for instance
when one votes) Gerrit doesn't modify the existing change object. It
creates new change object instead and existing
`OwnersService.getOwnersService` function (that is used to obtain the
service) ensures that new service instance gets created (together with
new instance of `OwnersApiCache`).

Caching abilities are also verified with unit tests.

Bug: Issue 377723880
Change-Id: I4b7312b644a0d2a608e4f19e23eda4d5a87f0b51
2 files changed
tree: 0665e198bc098d66ad8074b31d74a4d5f3a314d9
  1. .settings/
  2. lib/
  3. owners/
  4. owners-api/
  5. owners-autoassign/
  6. owners-common/
  7. plugins/
  8. tools/
  9. .bazelignore
  10. .bazelrc
  11. .gitignore
  12. bazlets.bzl
  13. BUILD
  14. CHANGELOG
  15. config.md
  16. external_plugin_deps.bzl
  17. external_plugin_deps_standalone.bzl
  18. LICENSE
  19. README.md
  20. WORKSPACE
README.md

Gerrit OWNERS Plugin

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.

How it works

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.

Auto assigner

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.

How to build

This plugin is built with Bazel and two build modes are supported:

  • Standalone
  • In Gerrit tree

Build standalone

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

Build in Gerrit tree

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