Google Git
Sign in
gerrit / plugins / owners / 0cfde2a290c3775b485cdee8188cb26168aa04e6
commit0cfde2a290c3775b485cdee8188cb26168aa04e6[log] [tgz]
authorJacek Centkowski <geminica.programs@gmail.com>Sun Nov 03 15:55:02 2024 +0100
committerJacek Centkowski <geminica.programs@gmail.com>Wed Nov 06 08:40:43 2024 +0100
treecf8edcea9893d7475ba2e0b5380f9b88b8b43d5d
parent3fe69f5f39aabd0d03ffff4fd48f292b3e037c46 [diff]
Introduce `Owned Files` tab to the change screen

This is the initial change that introduced the `Owned Files` tab to the
change screen. At the moment tab is shown only when user owns any file
(both `ownedFiles` and `shouldHide` functions are covered in units) and
change is not in the `EDIT` mode.

All files are displayed in the tab content (TODO provide links to diffs
and style it appropriately).

Changes:
* `change-view-tab=[header|content]` were used to register new plugin
  components - note that Gerrit doesn't highlight tab without content
  but one can still hover over its place and select it :/
  TODO: investigate if it can be improved with CSS and made no
  selectable
* `getLoggedInUserRole` service's function was modified to
  `getLoggedInUser` so that user account and role are returned (existing
  functionality and tests were adjusted)
* `getRandom` function was moved to `test-utils.ts` so that it gets
  reused (note that function is available only in tests)

Bug: Issue 376837413
Change-Id: Ica25f84596d0d7d2dfe268e97a4e3477ce605a5f
11 files changed
tree: cf8edcea9893d7475ba2e0b5380f9b88b8b43d5d
  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