| commit | 0a5f182b4155d34322d06946bebd66667f368eb5 | [log] [tgz] |
|---|---|---|
| author | Jacek Centkowski <geminica.programs@gmail.com> | Sun Oct 20 09:16:12 2024 +0200 |
| committer | Jacek Centkowski <geminica.programs@gmail.com> | Sun Nov 03 15:54:41 2024 +0100 |
| tree | b85e29a42c4acc758c102ade44b64051f82c0c90 | |
| parent | 7473bb0aab8869b068b913749c946c82808578ba [diff] |
Introduce the skeleton of UI for file owners status display
This is the initial change that introduces the base building blocks for
UI that will be responsible for showing (to the change owner) which file
needs to be reviewed from whom. At present it:
* hooks into the change details screen's Files section (for table header
and each row)
* determines if user is logged (logs to console value of `hidden`,
`userRole`, `path` and `oldPath` properties)
* introduces base building blocks for UI components (heavily inspired by
the `code-owners` plugin UI) namely: common UI component that is
shared between column header and content controls, thin owners model
that is loaded reactively through the loader using a dedicated service
(that finally calls `RestPluginApi`)
* owners service and `shouldHide` function are covered with karma basic
unit tests
* integrates the UI part with an `owners` plugin build and resources
(offered as `static` resource by introduction of `HttpModule`)
Note that:
* UI tests can be called from gerrit in-tree build with
bazel test //plugins/owners/web:karma_test
* linter can be called from gerrit in-tree build with:
node_modules/eslint/bin/eslint.js --ext .html,.ts --fix plugins/owners/web
Bug: Issue 373151160
Change-Id: I529d1345528da0322bee2c360241935a8b4379e6
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