-
Notifications
You must be signed in to change notification settings - Fork 273
/
GerritProject.java
347 lines (315 loc) · 11.3 KB
/
GerritProject.java
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
/*
* The MIT License
*
* Copyright 2010 Sony Ericsson Mobile Communications. All rights reserved.
* Copyright 2013 Sony Mobile Communications AB. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.sonyericsson.hudson.plugins.gerrit.trigger.hudsontrigger.data;
import static com.sonyericsson.hudson.plugins.gerrit.trigger.GerritServer.ANY_SERVER;
import hudson.Extension;
import hudson.RelativePath;
import hudson.model.Describable;
import hudson.model.Descriptor;
import hudson.model.Hudson;
import hudson.util.ComboBoxModel;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.QueryParameter;
import com.sonyericsson.hudson.plugins.gerrit.trigger.GerritServer;
import com.sonyericsson.hudson.plugins.gerrit.trigger.PluginImpl;
/**
* Base settings for one matcher rule of a Gerrit project.
* @author Robert Sandell <robert.sandell@sonyericsson.com>
*/
public class GerritProject implements Describable<GerritProject> {
private CompareType compareType;
private String pattern;
private List<Branch> branches;
private List<FilePath> filePaths;
private List<Topic> topics;
private List<FilePath> forbiddenFilePaths;
private boolean disableStrictForbiddenFileVerification;
/**
* Default empty constructor.
*/
public GerritProject() {
}
/**
* DataBound Constructor.
* @param compareType the compareType
* @param pattern the project-name pattern
* @param branches the branch-rules
* @param topics the topic-rules
* @param filePaths the file-path rules.
* @param forbiddenFilePaths the forbidden file-path rules.
* @param disableStrictForbiddenFileVerification whether to be strict or not.
*/
@DataBoundConstructor
public GerritProject(
CompareType compareType,
String pattern,
List<Branch> branches,
List<Topic> topics,
List<FilePath> filePaths,
List<FilePath> forbiddenFilePaths,
boolean disableStrictForbiddenFileVerification) {
this.compareType = compareType;
this.pattern = pattern;
this.branches = branches;
this.topics = topics;
this.filePaths = filePaths;
this.forbiddenFilePaths = forbiddenFilePaths;
this.disableStrictForbiddenFileVerification = disableStrictForbiddenFileVerification;
}
/**
* Whether to disable strict verification of forbidden files.
* @return true if disabled.
*/
public boolean isDisableStrictForbiddenFileVerification() {
return disableStrictForbiddenFileVerification;
}
/**
* Set whether to disable strict verification of forbidden files.
* @param disableStrictForbiddenFileVerification true to disable.
*/
public void setDisableStrictForbiddenFileVerification(boolean disableStrictForbiddenFileVerification) {
this.disableStrictForbiddenFileVerification = disableStrictForbiddenFileVerification;
}
/**
* Which algorithm-type to use with the pattern.
* @return the compareType
*/
public CompareType getCompareType() {
return compareType;
}
/**
* Which algorithm-type to use with the pattern.
* @param compareType the compareType
*/
public void setCompareType(CompareType compareType) {
this.compareType = compareType;
}
/**
* The pattern for the project-name to match on.
* @return the pattern
*/
public String getPattern() {
return pattern;
}
/**
* The pattern for the project-name to match on.
* @param pattern the pattern
*/
public void setPattern(String pattern) {
this.pattern = pattern;
}
/**
* The list of branch-rules.
* @return the branch-rules
*/
public List<Branch> getBranches() {
return branches;
}
/**
* The list of branch-rules.
* @param branches the branch-rules
*/
public void setBranches(List<Branch> branches) {
this.branches = branches;
}
/**
* The list of filepath-rules.
* @return the filepath-rules
*/
public List<FilePath> getFilePaths() {
return filePaths;
}
/**
* The list of filepath-rules.
* @param filePaths the filepath-rules
*/
public void setFilePaths(List<FilePath> filePaths) {
this.filePaths = filePaths;
}
/**
* The list of topic-rules.
* @return the topic-rules
*/
public List<Topic> getTopics() {
return topics;
}
/**
* The list of topic-rules.
* @param topics the topic-rules
*/
public void setTopics(List<Topic> topics) {
this.topics = topics;
}
/**
* The list of the forbidden file-path rules.
* @return the forbidden file-path rules.
*/
public List<FilePath> getForbiddenFilePaths() {
return forbiddenFilePaths;
}
/**
* The list of the forbidden file-path rules.
* @param forbiddenFilePaths the forbidden file-path rules.
*/
public void setForbiddenFilePaths(List<FilePath> forbiddenFilePaths) {
this.forbiddenFilePaths = forbiddenFilePaths;
}
/**
* Compares the project, branch and files to see if the rules specified is a match.
* @param project the Gerrit project
* @param branch the branch.
* @param topic the topic.
* @param files the files.
* @return true is the rules match.
*/
public boolean isInteresting(String project, String branch, String topic, List<String> files) {
if (compareType.matches(pattern, project)) {
for (Branch b : branches) {
boolean foundInterestingForbidden = false;
boolean foundInterestingTopicOrFile = false;
if (b.isInteresting(branch)) {
if (forbiddenFilePaths != null) {
for (FilePath ffp : forbiddenFilePaths) {
if (ffp.isInteresting(files)) {
foundInterestingForbidden = true;
break;
}
}
}
if (isInterestingTopic(topic) && isInterestingFile(files)) {
foundInterestingTopicOrFile = true;
}
if (disableStrictForbiddenFileVerification) {
// Here we want to be able to trigger a build if the event contains
// wanted topics or file paths even though there may be a forbidden file
return foundInterestingTopicOrFile;
} else {
if (foundInterestingForbidden) {
// we have a forbidden file and a wanted file path.
return false;
} else if (foundInterestingTopicOrFile) {
// we DO not have a forbidden file and but we have a wanted file path.
return true;
}
}
}
}
}
return false;
}
/**
* Compares the project and branch to see if the rules specified is a match.
* @param project the Gerrit project
* @param branch the branch.
* @param topic the topic.
* @return true is the rules match.
*/
public boolean isInteresting(String project, String branch, String topic) {
if (compareType.matches(pattern, project)) {
for (Branch b : branches) {
if (b.isInteresting(branch)) {
return isInterestingTopic(topic);
}
}
}
return false;
}
/**
* Compare topics to see if the rules specified is a match.
*
* @param topic the topic.
* @return true if the rules match or no rules.
*/
private boolean isInterestingTopic(String topic) {
if (topics != null && topics.size() > 0) {
for (Topic t : topics) {
if (t.isInteresting(topic)) {
return true;
}
}
return false;
}
return true;
}
/**
* Compare files to see if the rules specified is a match.
*
* @param files the files.
* @return true if the rules match or no rules.
*/
private boolean isInterestingFile(List<String> files) {
if (filePaths != null && filePaths.size() > 0) {
for (FilePath f : filePaths) {
if (f.isInteresting(files)) {
return true;
}
}
return false;
}
return true;
}
@Override
public Descriptor<GerritProject> getDescriptor() {
return Hudson.getInstance().getDescriptor(getClass());
}
/**
* Descriptor allowing for communication within the Repeatable.
* Necessary for editable combobox.
*/
@Extension
public static final class DescriptorImpl extends Descriptor<GerritProject> {
/**
* Used to fill the project pattern combobox with AJAX.
* The filled values will depend on the server that the user has chosen from the dropdown.
*
* @param serverName the name of the server that the user has chosen.
* @return ComboBoxModels containing a list of all Gerrit Projects found on that server.
*/
public ComboBoxModel doFillPatternItems(@QueryParameter("serverName")
@RelativePath("..") final String serverName) {
Collection<String> projects = new HashSet<String>();
if (serverName != null && !serverName.isEmpty()) {
if (ANY_SERVER.equals(serverName)) {
for (GerritServer server : PluginImpl.getServers_()) {
projects.addAll(server.getGerritProjects());
}
} else {
GerritServer server = PluginImpl.getServer_(serverName);
if (server != null) {
projects.addAll(server.getGerritProjects());
}
}
}
return new ComboBoxModel(projects);
}
@Override
public String getDisplayName() {
return null;
}
}
}