-
Notifications
You must be signed in to change notification settings - Fork 174
/
S3MockExtension.java
153 lines (133 loc) · 4.19 KB
/
S3MockExtension.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
/*
* Copyright 2017-2023 Adobe.
*
* 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.adobe.testing.s3mock.junit5;
import com.adobe.testing.s3mock.S3MockApplication;
import com.adobe.testing.s3mock.testsupport.common.S3MockStarter;
import com.amazonaws.services.s3.AmazonS3;
import java.util.Map;
import org.junit.jupiter.api.extension.AfterAllCallback;
import org.junit.jupiter.api.extension.BeforeAllCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.ParameterContext;
import org.junit.jupiter.api.extension.ParameterResolutionException;
import org.junit.jupiter.api.extension.ParameterResolver;
import software.amazon.awssdk.services.s3.S3Client;
/**
* JUnit extension to start and stop the S3Mock Application. After the tests, the S3Mock is
* stopped.
*
* <p>The following modes are supported:</p>
*
* <h2>1. Programmatic registration</h2>
* <pre>
* public class MyS3Test {
* @RegisterExtension
* public static S3MockExtension S3_MOCK = S3MockExtension.builder().build();
*
* private final AmazonS3 s3Client = S3_MOCK.createS3Client();
*
* @Test
* public void doSomethingWithS3() {
* s3Client.createBucket("myBucket");
* }
* }
* </pre>
*
* <h2>2. Declarative registration</h2>
* <pre>
* @ExtendWith(S3MockExtension.class)
* public class MyS3Test {
*
* @Test
* public void doSomethingWithS3(final AmazonS3 s3Client) {
* s3Client.createBucket("myBucket");
* }
* }
* </pre>
*/
public class S3MockExtension extends S3MockStarter implements BeforeAllCallback, AfterAllCallback,
ParameterResolver {
private int mockAccess;
/**
* Builder instance.
*
* @return builder instance.
*/
public static Builder builder() {
return new Builder();
}
/**
* Creates an instance with the default configuration.
*/
public S3MockExtension() {
super(null);
}
private S3MockExtension(final Map<String, Object> properties) {
super(properties);
}
@Override
public void beforeAll(final ExtensionContext context) {
startOnlySingleInstance();
}
@Override
public void afterAll(final ExtensionContext context) {
stopWhenLastConsumerFinished();
}
@Override
public boolean supportsParameter(final ParameterContext parameterContext,
final ExtensionContext extensionContext) throws ParameterResolutionException {
return paramHasType(parameterContext, S3MockApplication.class)
|| paramHasType(parameterContext, AmazonS3.class)
|| paramHasType(parameterContext, S3Client.class);
}
@Override
public Object resolveParameter(final ParameterContext parameterContext,
final ExtensionContext extensionContext) throws ParameterResolutionException {
if (paramHasType(parameterContext, S3MockApplication.class)) {
return s3MockFileStore;
}
if (paramHasType(parameterContext, AmazonS3.class)) {
return createS3Client();
}
if (paramHasType(parameterContext, S3Client.class)) {
return createS3ClientV2();
}
return null;
}
private boolean paramHasType(final ParameterContext parameterContext, final Class<?> cls) {
var requiredType = parameterContext.getParameter().getType();
return requiredType.isAssignableFrom(cls);
}
private synchronized void stopWhenLastConsumerFinished() {
if (--mockAccess == 0) {
stop();
}
}
private synchronized void startOnlySingleInstance() {
if (mockAccess++ == 0) {
start();
}
}
/**
* Builder for S3MockExtension.
*/
public static class Builder extends S3MockStarter.BaseBuilder<S3MockExtension> {
@Override
public S3MockExtension build() {
return new S3MockExtension(arguments);
}
}
}