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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.commons.lang3.concurrent;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.time.Duration;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import org.apache.commons.lang3.AbstractLangTest;
import org.apache.commons.lang3.ThreadUtils;
import org.junit.jupiter.api.Test;
public class BackgroundInitializerTest extends AbstractLangTest {
/**
* Helper method for checking whether the initialize() method was correctly
* called. start() must already have been invoked.
*
* @param init the initializer to test
*/
private void checkInitialize(final BackgroundInitializerTestImpl init) throws ConcurrentException {
final Integer result = init.get();
assertEquals(1, result.intValue(), "Wrong result");
assertEquals(1, init.initializeCalls, "Wrong number of invocations");
assertNotNull(init.getFuture(), "No future");
}
/**
* Tests whether initialize() is invoked.
*/
@Test
public void testInitialize() throws ConcurrentException {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
init.start();
checkInitialize(init);
}
/**
* Tries to obtain the executor before start(). It should not have been
* initialized yet.
*/
@Test
public void testGetActiveExecutorBeforeStart() {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
assertNull(init.getActiveExecutor(), "Got an executor");
}
/**
* Tests whether an external executor is correctly detected.
*/
@Test
public void testGetActiveExecutorExternal() throws InterruptedException, ConcurrentException {
final ExecutorService exec = Executors.newSingleThreadExecutor();
try {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl(
exec);
init.start();
assertSame(exec, init.getActiveExecutor(), "Wrong executor");
checkInitialize(init);
} finally {
exec.shutdown();
exec.awaitTermination(1, TimeUnit.SECONDS);
}
}
/**
* Tests getActiveExecutor() for a temporary executor.
*/
@Test
public void testGetActiveExecutorTemp() throws ConcurrentException {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
init.start();
assertNotNull(init.getActiveExecutor(), "No active executor");
checkInitialize(init);
}
/**
* Tests the execution of the background task if a temporary executor has to
* be created.
*/
@Test
public void testInitializeTempExecutor() throws ConcurrentException {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
assertTrue(init.start(), "Wrong result of start()");
checkInitialize(init);
assertTrue(init.getActiveExecutor().isShutdown(), "Executor not shutdown");
}
/**
* Tests whether an external executor can be set using the
* setExternalExecutor() method.
*/
@Test
public void testSetExternalExecutor() throws ConcurrentException {
final ExecutorService exec = Executors.newCachedThreadPool();
try {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
init.setExternalExecutor(exec);
assertEquals(exec, init.getExternalExecutor(), "Wrong executor service");
assertTrue(init.start(), "Wrong result of start()");
assertSame(exec, init.getActiveExecutor(), "Wrong active executor");
checkInitialize(init);
assertFalse(exec.isShutdown(), "Executor was shutdown");
} finally {
exec.shutdown();
}
}
/**
* Tests that setting an executor after start() causes an exception.
*
* @throws org.apache.commons.lang3.concurrent.ConcurrentException because the test implementation may throw it
*/
@Test
public void testSetExternalExecutorAfterStart() throws ConcurrentException, InterruptedException {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
init.start();
final ExecutorService exec = Executors.newSingleThreadExecutor();
try {
assertThrows(IllegalStateException.class, () -> init.setExternalExecutor(exec));
init.get();
} finally {
exec.shutdown();
exec.awaitTermination(1, TimeUnit.SECONDS);
}
}
/**
* Tests invoking start() multiple times. Only the first invocation should
* have an effect.
*/
@Test
public void testStartMultipleTimes() throws ConcurrentException {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
assertTrue(init.start(), "Wrong result for start()");
for (int i = 0; i < 10; i++) {
assertFalse(init.start(), "Could start again");
}
checkInitialize(init);
}
/**
* Tests calling get() before start(). This should cause an exception.
*/
@Test
public void testGetBeforeStart() {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
assertThrows(IllegalStateException.class, init::get);
}
/**
* Tests the get() method if background processing causes a runtime
* exception.
*/
@Test
public void testGetRuntimeException() {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
final RuntimeException rex = new RuntimeException();
init.ex = rex;
init.start();
final Exception ex = assertThrows(Exception.class, init::get);
assertEquals(rex, ex, "Runtime exception not thrown");
}
/**
* Tests the get() method if background processing causes a checked
* exception.
*/
@Test
public void testGetCheckedException() {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
final Exception ex = new Exception();
init.ex = ex;
init.start();
final ConcurrentException cex = assertThrows(ConcurrentException.class, init::get);
assertEquals(ex, cex.getCause(), "Exception not thrown");
}
/**
* Tests the get() method if waiting for the initialization is interrupted.
*
* @throws InterruptedException because we're making use of Java's concurrent API
*/
@Test
public void testGetInterruptedException() throws InterruptedException {
final ExecutorService exec = Executors.newSingleThreadExecutor();
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl(
exec);
final CountDownLatch latch1 = new CountDownLatch(1);
init.shouldSleep = true;
init.start();
final AtomicReference<InterruptedException> iex = new AtomicReference<>();
final Thread getThread = new Thread() {
@Override
public void run() {
try {
init.get();
} catch (final ConcurrentException cex) {
if (cex.getCause() instanceof InterruptedException) {
iex.set((InterruptedException) cex.getCause());
}
} finally {
assertTrue(isInterrupted(), "Thread not interrupted");
latch1.countDown();
}
}
};
getThread.start();
getThread.interrupt();
latch1.await();
exec.shutdownNow();
exec.awaitTermination(1, TimeUnit.SECONDS);
assertNotNull(iex.get(), "No interrupted exception");
}
/**
* Tests isStarted() before start() was called.
*/
@Test
public void testIsStartedFalse() {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
assertFalse(init.isStarted(), "Already started");
}
/**
* Tests isStarted() after start().
*/
@Test
public void testIsStartedTrue() {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
init.start();
assertTrue(init.isStarted(), "Not started");
}
/**
* Tests isStarted() after the background task has finished.
*/
@Test
public void testIsStartedAfterGet() throws ConcurrentException {
final BackgroundInitializerTestImpl init = new BackgroundInitializerTestImpl();
init.start();
checkInitialize(init);
assertTrue(init.isStarted(), "Not started");
}
/**
* A concrete implementation of BackgroundInitializer. It also overloads
* some methods that simplify testing.
*/
private static class BackgroundInitializerTestImpl extends
BackgroundInitializer<Integer> {
/** An exception to be thrown by initialize(). */
Exception ex;
/** A flag whether the background task should sleep a while. */
boolean shouldSleep;
/** The number of invocations of initialize(). */
volatile int initializeCalls;
BackgroundInitializerTestImpl() {
}
BackgroundInitializerTestImpl(final ExecutorService exec) {
super(exec);
}
/**
* Records this invocation. Optionally throws an exception or sleeps a
* while.
*
* @throws Exception in case of an error
*/
@Override
protected Integer initialize() throws Exception {
if (ex != null) {
throw ex;
}
if (shouldSleep) {
ThreadUtils.sleep(Duration.ofMinutes(1));
}
return Integer.valueOf(++initializeCalls);
}
}
}
|