1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
# Copyright 2009 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""CodeReviewVoteReference interface."""
__metaclass__ = type
__all__ = [
'ICodeReviewVoteReference',
]
from lazr.restful.declarations import (
call_with,
export_as_webservice_entry,
export_destructor_operation,
export_write_operation,
exported,
operation_parameters,
REQUEST_USER,
)
from lazr.restful.fields import Reference
from zope.interface import Interface
from zope.schema import (
Bool,
Datetime,
Int,
TextLine,
)
from canonical.launchpad import _
from lp.code.interfaces.branchmergeproposal import IBranchMergeProposal
from lp.code.interfaces.codereviewcomment import ICodeReviewComment
from lp.registry.interfaces.person import IPerson
from lp.services.fields import (
PersonChoice,
PublicPersonChoice,
)
class ICodeReviewVoteReferencePublic(Interface):
"""The public attributes for code review vote references."""
id = Int(
title=_("The ID of the vote reference"))
branch_merge_proposal = exported(
Reference(
title=_("The merge proposal that is the subject of this vote"),
required=True, schema=IBranchMergeProposal))
date_created = exported(
Datetime(
title=_('Date Created'), required=True, readonly=True))
registrant = exported(
PublicPersonChoice(
title=_("The person who originally registered this vote"),
required=True,
vocabulary='ValidPersonOrTeam'))
reviewer = exported(
PersonChoice(
title=_('Reviewer'), required=True,
description=_('A person who you want to review this.'),
vocabulary='ValidPersonOrTeam'))
review_type = exported(
TextLine(
title=_('Review type'), required=False,
description=_(
"Lowercase keywords describing the type of review.")))
comment = exported(
Reference(
title=_(
"The code review comment that contains the most recent vote."
),
required=True, schema=ICodeReviewComment))
is_pending = exported(
Bool(title=_("Is the pending?"), required=True, readonly=True))
class ICodeReviewVoteReferenceEdit(Interface):
"""Method that require edit permissions."""
def validateClaimReview(claimant):
"""Implements the validation for claiming a review.
:raises ClaimReviewFailed: If the claimant already has a
personal review, if the reviewer is not a team, if the
claimant is not in the reviewer team, or if the review is
not pending.
"""
@call_with(claimant=REQUEST_USER)
@export_write_operation()
def claimReview(claimant):
"""Change a pending review into a review for claimant.
Pending team reviews can be claimed by members of that team. This
allows reviews to be moved of the general team todo list, and onto a
personal todo list.
:param claimant: The person claiming the team review.
:raises ClaimReviewFailed: If the claimant already has a
personal review, if the reviewer is not a team, if the
claimant is not in the reviewer team, or if the review is
not pending.
"""
def validateReasignReview(reviewer):
"""Implements the validation for reassignment.
:raises ReviewNotPending: If the review is not pending.
:raises ReassignReviewFailed: If the reviewer is an individual and
already has a personal review.
"""
@operation_parameters(
reviewer=Reference(
title=_("The person or team to assign to do the review."),
schema=IPerson))
@export_write_operation()
def reassignReview(reviewer):
"""Reassign a pending review to someone else.
Pending reviews can be reassigned to someone else.
:param reviewer: The person to assign the pending review to.
:raises ReviewNotPending: If the review is not pending.
:raises ReassignReviewFailed: If the reviewer is an individual and
already has a personal review.
"""
@export_destructor_operation()
def delete():
"""Delete the pending review.
:raises ReviewNotPending: If the review is not pending.
"""
class ICodeReviewVoteReference(ICodeReviewVoteReferencePublic,
ICodeReviewVoteReferenceEdit):
"""A reference to a vote on a IBranchMergeProposal.
There is at most one reference to a vote for each reviewer on a given
branch merge proposal.
"""
export_as_webservice_entry()
|