-
Notifications
You must be signed in to change notification settings - Fork 351
/
OriginPullRequestDiscoveryTrait.java
213 lines (197 loc) · 6.84 KB
/
OriginPullRequestDiscoveryTrait.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
/*
* The MIT License
*
* Copyright (c) 2017, CloudBees, Inc.
*
* 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.cloudbees.jenkins.plugins.bitbucket;
import edu.umd.cs.findbugs.annotations.NonNull;
import hudson.Extension;
import hudson.util.ListBoxModel;
import java.util.EnumSet;
import java.util.Set;
import jenkins.scm.api.SCMHeadCategory;
import jenkins.scm.api.SCMHeadOrigin;
import jenkins.scm.api.SCMRevision;
import jenkins.scm.api.SCMSource;
import jenkins.scm.api.mixin.ChangeRequestCheckoutStrategy;
import jenkins.scm.api.mixin.ChangeRequestSCMHead2;
import jenkins.scm.api.trait.SCMHeadAuthority;
import jenkins.scm.api.trait.SCMHeadAuthorityDescriptor;
import jenkins.scm.api.trait.SCMSourceContext;
import jenkins.scm.api.trait.SCMSourceRequest;
import jenkins.scm.api.trait.SCMSourceTrait;
import jenkins.scm.api.trait.SCMSourceTraitDescriptor;
import jenkins.scm.impl.ChangeRequestSCMHeadCategory;
import jenkins.scm.impl.trait.Discovery;
import org.jenkinsci.Symbol;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.DataBoundConstructor;
/**
* A {@link Discovery} trait for bitbucket that will discover pull requests originating from a branch in the repository
* itself.
*
* @since 2.2.0
*/
public class OriginPullRequestDiscoveryTrait extends SCMSourceTrait {
/**
* The strategy encoded as a bit-field.
*/
private final int strategyId;
/**
* Constructor for stapler.
*
* @param strategyId the strategy id.
*/
@DataBoundConstructor
public OriginPullRequestDiscoveryTrait(int strategyId) {
this.strategyId = strategyId;
}
/**
* Constructor for programmatic instantiation.
*
* @param strategies the {@link ChangeRequestCheckoutStrategy} instances.
*/
public OriginPullRequestDiscoveryTrait(Set<ChangeRequestCheckoutStrategy> strategies) {
this((strategies.contains(ChangeRequestCheckoutStrategy.MERGE) ? 1 : 0)
+ (strategies.contains(ChangeRequestCheckoutStrategy.HEAD) ? 2 : 0));
}
/**
* Gets the strategy id.
*
* @return the strategy id.
*/
public int getStrategyId() {
return strategyId;
}
/**
* Returns the strategies.
*
* @return the strategies.
*/
@NonNull
public Set<ChangeRequestCheckoutStrategy> getStrategies() {
switch (strategyId) {
case 1:
return EnumSet.of(ChangeRequestCheckoutStrategy.MERGE);
case 2:
return EnumSet.of(ChangeRequestCheckoutStrategy.HEAD);
case 3:
return EnumSet.of(ChangeRequestCheckoutStrategy.HEAD, ChangeRequestCheckoutStrategy.MERGE);
default:
return EnumSet.noneOf(ChangeRequestCheckoutStrategy.class);
}
}
/**
* {@inheritDoc}
*/
@Override
protected void decorateContext(SCMSourceContext<?, ?> context) {
BitbucketSCMSourceContext ctx = (BitbucketSCMSourceContext) context;
ctx.wantOriginPRs(true);
ctx.withAuthority(new OriginChangeRequestSCMHeadAuthority());
ctx.withOriginPRStrategies(getStrategies());
}
/**
* {@inheritDoc}
*/
@Override
public boolean includeCategory(@NonNull SCMHeadCategory category) {
return category instanceof ChangeRequestSCMHeadCategory;
}
/**
* Our descriptor.
*/
@Symbol("bitbucketPullRequestDiscovery")
@Extension
@Discovery
public static class DescriptorImpl extends SCMSourceTraitDescriptor {
/**
* {@inheritDoc}
*/
@Override
public String getDisplayName() {
return "Discover pull requests from origin";
}
/**
* {@inheritDoc}
*/
@Override
public Class<? extends SCMSourceContext> getContextClass() {
return BitbucketSCMSourceContext.class;
}
/**
* {@inheritDoc}
*/
@Override
public Class<? extends SCMSource> getSourceClass() {
return BitbucketSCMSource.class;
}
/**
* Populates the strategy options.
*
* @return the strategy options.
*/
@NonNull
@Restricted(NoExternalUse.class)
@SuppressWarnings("unused") // stapler
public ListBoxModel doFillStrategyIdItems() {
ListBoxModel result = new ListBoxModel();
result.add(Messages.ForkPullRequestDiscoveryTrait_mergeOnly(), "1");
result.add(Messages.ForkPullRequestDiscoveryTrait_headOnly(), "2");
result.add(Messages.ForkPullRequestDiscoveryTrait_headAndMerge(), "3");
return result;
}
}
/**
* A {@link SCMHeadAuthority} that trusts origin pull requests
*/
public static class OriginChangeRequestSCMHeadAuthority
extends SCMHeadAuthority<SCMSourceRequest, ChangeRequestSCMHead2, SCMRevision> {
/**
* {@inheritDoc}
*/
@Override
protected boolean checkTrusted(@NonNull SCMSourceRequest request, @NonNull ChangeRequestSCMHead2 head) {
return SCMHeadOrigin.DEFAULT.equals(head.getOrigin());
}
/**
* Our descriptor.
*/
@Extension
public static class DescriptorImpl extends SCMHeadAuthorityDescriptor {
/**
* {@inheritDoc}
*/
@Override
public String getDisplayName() {
return Messages.OriginPullRequestDiscoveryTrait_authorityDisplayName();
}
/**
* {@inheritDoc}
*/
@Override
public boolean isApplicableToOrigin(@NonNull Class<? extends SCMHeadOrigin> originClass) {
return SCMHeadOrigin.Default.class.isAssignableFrom(originClass);
}
}
}
}