opendev/gerrit
Code Issues Proposed changes

Merge "Add an 'unresolved_comments_count' prolog fact for each change"

Browse Source
This commit is contained in:
David Pursehouse
2017-03-03 06:36:36 +00:00
committed by Gerrit Code Review
parent aa4ae6f66f a5d01788a9
commit 01ae252d93
4 changed files with 167 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/prolog-change-facts.txt
View File

@@ -60,6 +60,9 @@ of them we must use a qualified name like `gerrit:change_branch(X)`.
|`uploader/1` |`uploader(user(1000000)).`
|Uploader as `user(ID)` term. ID is the numeric account ID
|`unresolved_comments_count/1` |`unresolved_comments_count(0).`
|The number of unresolved comments as an integer atom
|=============================================================================
In addition Gerrit provides a set of built-in helper predicates that can be used

50
Documentation/prolog-cookbook.txt
View File

@@ -998,6 +998,56 @@ only_allow_author_to_submit(S, S) :-
only_allow_author_to_submit(S1, [label('Only-Author-Can-Submit', need(_)) | S1]).
----
=== Example 16: Make change submittable if all comments have been resolved
In this example we will use the `unresolved_comments_count` fact about a
change. Our goal is to block the submission of any change with some
unresolved comments. Basically, it can be achieved by the following rules:
`rules.pl`
[source,prolog]
----
submit_rule(submit(R)) :-
gerrit:unresolved_comments_count(0),
!,
gerrit:commit_author(A),
R = label('All-Comments-Resolved', ok(A)).
submit_rule(submit(R)) :-
gerrit:unresolved_comments_count(U),
U > 0,
R = label('All-Comments-Resolved', need(_)).
----
Suppose currently a change is submittable if it gets `+2` for `Code-Review`
and `+1` for `Verified`. It can be extended to support the above rules as
follows:
`rules.pl`
[source,prolog]
----
submit_rule(submit(CR, V, R)) :-
base(CR, V),
gerrit:unresolved_comments_count(0),
!,
gerrit:commit_author(A),
R = label('All-Comments-Resolved', ok(A)).
submit_rule(submit(CR, V, R)) :-
base(CR, V),
gerrit:unresolved_comments_count(U),
U > 0,
R = label('All-Comments-Resolved', need(_)).
base(CR, V) :-
gerrit:max_with_block(-2, 2, 'Code-Review', CR),
gerrit:max_with_block(-1, 1, 'Verified', V).
----
Note that a new label as `All-Comments-Resolved` should not be configured.
It's only used to show `'Needs All-Comments-Resolved'` in the UI to clearly
indicate to the user that all the comments have to be resolved for the
change to become submittable.
== Examples - Submit Type
The following examples show how to implement own submit type rules.