/
AbstractBucketLifecycleManagerTest.java
327 lines (270 loc) · 10.3 KB
/
AbstractBucketLifecycleManagerTest.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
/*
* Copyright 2013 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.jenkins.plugins.storage;
import java.io.IOException;
import javax.annotation.Nullable;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.mockito.Matchers.isA;
import static org.mockito.Mockito.when;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.Verifier;
import org.jvnet.hudson.test.JenkinsRule;
import org.jvnet.hudson.test.WithoutJenkins;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import static com.google.common.base.Preconditions.checkNotNull;
import com.cloudbees.plugins.credentials.SystemCredentialsProvider;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.services.storage.Storage;
import com.google.api.services.storage.model.Bucket;
import com.google.common.base.Predicate;
import com.google.jenkins.plugins.credentials.oauth.GoogleOAuth2ScopeRequirement;
import com.google.jenkins.plugins.credentials.oauth.GoogleRobotCredentials;
import com.google.jenkins.plugins.storage.ClassicUpload.DescriptorImpl;
import com.google.jenkins.plugins.util.ConflictException;
import com.google.jenkins.plugins.util.ForbiddenException;
import com.google.jenkins.plugins.util.MockExecutor;
import com.google.jenkins.plugins.util.NotFoundException;
import hudson.Extension;
import hudson.model.FreeStyleBuild;
import hudson.model.FreeStyleProject;
import hudson.model.TaskListener;
import hudson.util.FormValidation;
/**
* Tests for {@link AbstractBucketLifecycleManager}.
*/
public class AbstractBucketLifecycleManagerTest {
@Rule
public JenkinsRule jenkins = new JenkinsRule();
@Mock
private GoogleRobotCredentials credentials;
private GoogleCredential credential;
private final MockExecutor executor = new MockExecutor();
private ConflictException conflictException;
private ForbiddenException forbiddenException;
private NotFoundException notFoundException;
private Predicate<Storage.Buckets.Insert> checkBucketName(
final String bucketName) {
return new Predicate<Storage.Buckets.Insert>() {
@Override
public boolean apply(Storage.Buckets.Insert operation) {
Bucket bucket = (Bucket) operation.getJsonContent();
assertEquals(bucketName, bucket.getName());
return true;
}
};
}
private Predicate<Storage.Buckets.Update> checkSameBucket(
final Bucket theBucket) {
return new Predicate<Storage.Buckets.Update>() {
@Override
public boolean apply(Storage.Buckets.Update operation) {
Bucket bucket = (Bucket) operation.getJsonContent();
assertSame(bucket, theBucket);
return true;
}
};
}
private static class MockUploadModule extends UploadModule {
public MockUploadModule(MockExecutor executor) {
this(executor, 1 /* retries */);
}
public MockUploadModule(MockExecutor executor, int retries) {
this.executor = executor;
this.retryCount = retries;
}
@Override
public int getInsertRetryCount() {
return retryCount;
}
@Override
public MockExecutor newExecutor() {
return executor;
}
private final MockExecutor executor;
private final int retryCount;
}
@Rule
public Verifier verifySawAll = new Verifier() {
@Override
public void verify() {
assertTrue(executor.sawAll());
assertFalse(executor.sawUnexpected());
}
};
private static class FakeUpload extends AbstractBucketLifecycleManager {
public FakeUpload(String bucketName, MockUploadModule module,
String details, @Nullable Bucket bucket) {
super(bucketName, module);
this.details = details;
this.bucket = bucket;
}
@Override
public String getDetails() {
return details;
}
private final String details;
@Override
public Bucket checkBucket(Bucket bucket) throws InvalidAnnotationException {
if (this.bucket == null) {
return bucket;
}
throw new InvalidAnnotationException(bucket);
}
@Override
public Bucket decorateBucket(Bucket bucket) {
return checkNotNull(this.bucket);
}
@Nullable private final Bucket bucket;
/**
* We need this because it is used to retrieve the module when
* it is null.
*/
@Extension
public static class DescriptorImpl
extends AbstractBucketLifecycleManagerDescriptor {
public DescriptorImpl() {
super(FakeUpload.class);
}
public String getDisplayName() {
return "asdf";
}
}
}
private FreeStyleProject project;
private FreeStyleBuild build;
@Before
public void setUp() throws Exception {
MockitoAnnotations.initMocks(this);
when(credentials.getId()).thenReturn(CREDENTIALS_ID);
when(credentials.getProjectId()).thenReturn(PROJECT_ID);
if (jenkins.jenkins != null) {
SystemCredentialsProvider.getInstance().getCredentials().add(credentials);
project = jenkins.createFreeStyleProject("test");
project.getPublishersList().add(
// Create a storage plugin with no uploaders to fake things out.
new GoogleCloudStorageUploader(CREDENTIALS_ID, null));
build = project.scheduleBuild2(0).get();
}
credential = new GoogleCredential();
when(credentials.getGoogleCredential(isA(
GoogleOAuth2ScopeRequirement.class)))
.thenReturn(credential);
// Return ourselves as remotable
when(credentials.forRemote(isA(GoogleOAuth2ScopeRequirement.class)))
.thenReturn(credentials);
notFoundException = new NotFoundException();
conflictException = new ConflictException();
forbiddenException = new ForbiddenException();
}
@Test
@WithoutJenkins
public void testGetters() {
FakeUpload underTest = new FakeUpload(BUCKET_URI,
new MockUploadModule(executor),
FAKE_DETAILS, null /* bucket */);
assertEquals(BUCKET_URI, underTest.getBucket());
assertEquals(FAKE_DETAILS, underTest.getDetails());
}
@Test
public void testFailingBucketCheck() throws Exception {
final Bucket bucket = new Bucket().setName(BUCKET_NAME);
FakeUpload underTest = new FakeUpload(BUCKET_URI,
new MockUploadModule(executor),
FAKE_DETAILS,
bucket);
// A get that returns a bucket should trigger a check/decorate/update
executor.when(Storage.Buckets.Get.class, new Bucket());
executor.passThruWhen(Storage.Buckets.Update.class,
checkSameBucket(bucket));
underTest.perform(credentials, build, TaskListener.NULL);
}
@Test
public void testPassingBucketCheck() throws Exception {
final Bucket bucket = new Bucket().setName(BUCKET_NAME);
FakeUpload underTest = new FakeUpload(BUCKET_URI,
new MockUploadModule(executor),
FAKE_DETAILS,
null /* pass the bucket check */);
// A get that passes our check should incur no further RPC
executor.when(Storage.Buckets.Get.class, bucket);
underTest.perform(credentials, build, TaskListener.NULL);
}
@Test
public void testPassingBucketCheckAfterNotFoundThenConflict()
throws Exception {
final Bucket bucket = new Bucket().setName(BUCKET_NAME);
FakeUpload underTest = new FakeUpload(BUCKET_URI,
new MockUploadModule(executor),
FAKE_DETAILS,
bucket);
executor.throwWhen(Storage.Buckets.Get.class, notFoundException);
executor.throwWhen(Storage.Buckets.Insert.class, conflictException);
// Verify that our final "get" handles updating the bucket as well
executor.when(Storage.Buckets.Get.class, new Bucket());
executor.passThruWhen(Storage.Buckets.Update.class,
checkSameBucket(bucket));
underTest.perform(credentials, build, TaskListener.NULL);
}
@Test(expected = UploadException.class)
public void testRandomErrorExecutor() throws Exception {
FakeUpload underTest = new FakeUpload(BUCKET_URI,
new MockUploadModule(executor),
FAKE_DETAILS,
null /* pass the bucket check */);
executor.throwWhen(Storage.Buckets.Get.class, conflictException);
underTest.perform(credentials, build, TaskListener.NULL);
}
@Test(expected = UploadException.class)
public void testRandomErrorIOException() throws Exception {
FakeUpload underTest = new FakeUpload(BUCKET_URI,
new MockUploadModule(executor),
FAKE_DETAILS,
null /* pass the bucket check */);
executor.throwWhen(Storage.Buckets.Get.class, new IOException("test"));
underTest.perform(credentials, build, TaskListener.NULL);
}
@Test
public void testCustomBucketNameValidation() throws Exception {
FakeUpload underTest = new FakeUpload(BUCKET_URI,
new MockUploadModule(executor),
FAKE_DETAILS,
null /* pass the bucket check */);
AbstractBucketLifecycleManagerDescriptor descriptor =
underTest.getDescriptor();
assertEquals(FormValidation.Kind.OK,
descriptor.doCheckBucketNameWithVars("gs://asdf").kind);
// Successfully resolved
assertEquals(FormValidation.Kind.OK,
descriptor.doCheckBucketNameWithVars("gs://asdf$BUILD_NUMBER").kind);
// Not a gs:// URI
assertEquals(FormValidation.Kind.ERROR,
descriptor.doCheckBucketNameWithVars("foo").kind);
// Multi-part not allowed for bucket lifecycle plugins
assertEquals(FormValidation.Kind.ERROR,
descriptor.doCheckBucketNameWithVars("gs://foo/bar").kind);
}
private static final String PROJECT_ID = "foo.com:bar-baz";
private static final String CREDENTIALS_ID = "bazinga";
private static final String BUCKET_NAME = "ma-bucket";
private static final String BUCKET_URI = "gs://" + BUCKET_NAME;
private static final String FAKE_DETAILS = "These are my fake details";
}