-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
SimpleJobTests.java
591 lines (497 loc) · 18.8 KB
/
SimpleJobTests.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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
/*
* Copyright 2006-2022 the original author or authors.
*
* 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
*
* https://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.springframework.batch.core.job;
import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.observation.DefaultMeterObservationHandler;
import io.micrometer.core.tck.MeterRegistryAssert;
import io.micrometer.observation.ObservationRegistry;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.batch.core.BatchStatus;
import org.springframework.batch.core.ExitStatus;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.core.JobExecutionListener;
import org.springframework.batch.core.JobInstance;
import org.springframework.batch.core.JobInterruptedException;
import org.springframework.batch.core.JobParameters;
import org.springframework.batch.core.Step;
import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.UnexpectedJobExecutionException;
import org.springframework.batch.core.explore.JobExplorer;
import org.springframework.batch.core.explore.support.JobExplorerFactoryBean;
import org.springframework.batch.core.observability.BatchJobObservation;
import org.springframework.batch.core.repository.JobRepository;
import org.springframework.batch.core.repository.support.JobRepositoryFactoryBean;
import org.springframework.batch.core.step.StepSupport;
import org.springframework.batch.item.ExecutionContext;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabase;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
import org.springframework.jdbc.support.JdbcTransactionManager;
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.assertTrue;
import static org.mockito.Mockito.mock;
/**
* Tests for DefaultJobLifecycle.
*
* @author Lucas Ward
* @author Will Schipp
* @author Mahmoud Ben Hassine
*/
class SimpleJobTests {
private JobRepository jobRepository;
private JobExplorer jobExplorer;
private final List<Serializable> list = new ArrayList<>();
private JobInstance jobInstance;
private JobExecution jobExecution;
private StepExecution stepExecution1;
private StepExecution stepExecution2;
private StubStep step1;
private StubStep step2;
private final JobParameters jobParameters = new JobParameters();
private SimpleJob job;
@BeforeEach
void setUp() throws Exception {
EmbeddedDatabase embeddedDatabase = new EmbeddedDatabaseBuilder()
.addScript("/org/springframework/batch/core/schema-drop-hsqldb.sql")
.addScript("/org/springframework/batch/core/schema-hsqldb.sql").generateUniqueName(true).build();
JdbcTransactionManager transactionManager = new JdbcTransactionManager(embeddedDatabase);
JobRepositoryFactoryBean repositoryFactoryBean = new JobRepositoryFactoryBean();
repositoryFactoryBean.setDataSource(embeddedDatabase);
repositoryFactoryBean.setTransactionManager(transactionManager);
repositoryFactoryBean.afterPropertiesSet();
this.jobRepository = repositoryFactoryBean.getObject();
JobExplorerFactoryBean explorerFactoryBean = new JobExplorerFactoryBean();
explorerFactoryBean.setDataSource(embeddedDatabase);
explorerFactoryBean.setTransactionManager(transactionManager);
explorerFactoryBean.afterPropertiesSet();
this.jobExplorer = explorerFactoryBean.getObject();
job = new SimpleJob();
job.setJobRepository(jobRepository);
ObservationRegistry observationRegistry = ObservationRegistry.create();
observationRegistry.observationConfig()
.observationHandler(new DefaultMeterObservationHandler(Metrics.globalRegistry));
job.setObservationRegistry(observationRegistry);
step1 = new StubStep("TestStep1", jobRepository);
step1.setCallback(new Runnable() {
@Override
public void run() {
list.add("default");
}
});
step2 = new StubStep("TestStep2", jobRepository);
step2.setCallback(new Runnable() {
@Override
public void run() {
list.add("default");
}
});
List<Step> steps = new ArrayList<>();
steps.add(step1);
steps.add(step2);
job.setName("testJob");
job.setSteps(steps);
jobExecution = jobRepository.createJobExecution(job.getName(), jobParameters);
jobInstance = jobExecution.getJobInstance();
stepExecution1 = new StepExecution(step1.getName(), jobExecution);
stepExecution2 = new StepExecution(step2.getName(), jobExecution);
}
/**
* Test method for {@link SimpleJob#setSteps(java.util.List)}.
*/
@Test
void testSetSteps() {
job.setSteps(Collections.singletonList((Step) new StepSupport("step")));
job.execute(jobExecution);
assertEquals(1, jobExecution.getStepExecutions().size());
}
/**
* Test method for {@link SimpleJob#setSteps(java.util.List)}.
*/
@Test
void testGetSteps() {
assertEquals(2, job.getStepNames().size());
}
/**
* Test method for {@link SimpleJob#addStep(org.springframework.batch.core.Step)}.
*/
@Test
void testAddStep() {
job.setSteps(Collections.<Step>emptyList());
job.addStep(new StepSupport("step"));
job.execute(jobExecution);
assertEquals(1, jobExecution.getStepExecutions().size());
}
// Test to ensure the exit status returned by the last step is returned
@Test
void testExitStatusReturned() {
final ExitStatus customStatus = new ExitStatus("test");
Step testStep = new Step() {
@Override
public void execute(StepExecution stepExecution) throws JobInterruptedException {
stepExecution.setExitStatus(customStatus);
}
@Override
public String getName() {
return "test";
}
@Override
public int getStartLimit() {
return 1;
}
@Override
public boolean isAllowStartIfComplete() {
return false;
}
};
List<Step> steps = new ArrayList<>();
steps.add(testStep);
job.setSteps(steps);
job.execute(jobExecution);
assertEquals(customStatus, jobExecution.getExitStatus());
}
@Test
void testRunNormally() {
step1.setStartLimit(5);
step2.setStartLimit(5);
job.execute(jobExecution);
assertEquals(2, list.size());
checkRepository(BatchStatus.COMPLETED);
assertNotNull(jobExecution.getEndTime());
assertNotNull(jobExecution.getStartTime());
assertEquals(1, step1.passedInJobContext.size());
assertFalse(step2.passedInJobContext.isEmpty());
// Observability
MeterRegistryAssert.assertThat(Metrics.globalRegistry).hasTimerWithNameAndTags(
BatchJobObservation.BATCH_JOB_OBSERVATION.getName(), Tags.of(Tag.of("error", "none"),
Tag.of("spring.batch.job.name", "testJob"), Tag.of("spring.batch.job.status", "COMPLETED")));
}
@AfterEach
void cleanup() {
Metrics.globalRegistry.clear();
}
@Test
void testRunNormallyWithListener() {
job.setJobExecutionListeners(new JobExecutionListener[] { new JobExecutionListener() {
@Override
public void beforeJob(JobExecution jobExecution) {
list.add("before");
}
@Override
public void afterJob(JobExecution jobExecution) {
list.add("after");
}
} });
job.execute(jobExecution);
assertEquals(4, list.size());
}
@Test
void testRunWithSimpleStepExecutor() {
job.setJobRepository(jobRepository);
// do not set StepExecutorFactory...
step1.setStartLimit(5);
step2.setStartLimit(5);
job.execute(jobExecution);
assertEquals(2, list.size());
checkRepository(BatchStatus.COMPLETED, ExitStatus.COMPLETED);
}
@Test
void testExecutionContextIsSet() {
testRunNormally();
assertEquals(jobInstance, jobExecution.getJobInstance());
assertEquals(2, jobExecution.getStepExecutions().size());
assertEquals(step1.getName(), stepExecution1.getStepName());
assertEquals(step2.getName(), stepExecution2.getStepName());
}
@Test
void testInterrupted() {
step1.setStartLimit(5);
step2.setStartLimit(5);
final JobInterruptedException exception = new JobInterruptedException("Interrupt!");
step1.setProcessException(exception);
job.execute(jobExecution);
assertEquals(1, jobExecution.getAllFailureExceptions().size());
assertEquals(exception, jobExecution.getStepExecutions().iterator().next().getFailureExceptions().get(0));
assertEquals(0, list.size());
checkRepository(BatchStatus.STOPPED, ExitStatus.STOPPED);
}
@Test
void testInterruptedAfterUnknownStatus() {
step1.setStartLimit(5);
step2.setStartLimit(5);
final JobInterruptedException exception = new JobInterruptedException("Interrupt!", BatchStatus.UNKNOWN);
step1.setProcessException(exception);
job.execute(jobExecution);
assertEquals(1, jobExecution.getAllFailureExceptions().size());
assertEquals(exception, jobExecution.getStepExecutions().iterator().next().getFailureExceptions().get(0));
assertEquals(0, list.size());
checkRepository(BatchStatus.UNKNOWN, ExitStatus.STOPPED);
}
@Test
void testFailed() {
step1.setStartLimit(5);
step2.setStartLimit(5);
final RuntimeException exception = new RuntimeException("Foo!");
step1.setProcessException(exception);
job.execute(jobExecution);
assertEquals(1, jobExecution.getAllFailureExceptions().size());
assertEquals(exception, jobExecution.getAllFailureExceptions().get(0));
assertEquals(0, list.size());
assertEquals(BatchStatus.FAILED, jobExecution.getStatus());
checkRepository(BatchStatus.FAILED, ExitStatus.FAILED);
}
@Test
void testFailedWithListener() {
job.setJobExecutionListeners(new JobExecutionListener[] { new JobExecutionListener() {
@Override
public void afterJob(JobExecution jobExecution) {
list.add("afterJob");
}
} });
final RuntimeException exception = new RuntimeException("Foo!");
step1.setProcessException(exception);
job.execute(jobExecution);
assertEquals(1, jobExecution.getAllFailureExceptions().size());
assertEquals(exception, jobExecution.getAllFailureExceptions().get(0));
assertEquals(1, list.size());
checkRepository(BatchStatus.FAILED, ExitStatus.FAILED);
}
@Test
void testFailedWithError() {
step1.setStartLimit(5);
step2.setStartLimit(5);
final Error exception = new Error("Foo!");
step1.setProcessException(exception);
job.execute(jobExecution);
assertEquals(1, jobExecution.getAllFailureExceptions().size());
assertEquals(exception, jobExecution.getAllFailureExceptions().get(0));
assertEquals(0, list.size());
checkRepository(BatchStatus.FAILED, ExitStatus.FAILED);
}
@Test
void testStepShouldNotStart() {
// Start policy will return false, keeping the step from being started.
step1.setStartLimit(0);
job.execute(jobExecution);
assertEquals(1, jobExecution.getFailureExceptions().size());
Throwable ex = jobExecution.getFailureExceptions().get(0);
assertTrue(ex.getMessage().contains("start limit exceeded"), "Wrong message in exception: " + ex.getMessage());
}
@Test
void testStepAlreadyComplete() throws Exception {
stepExecution1.setStatus(BatchStatus.COMPLETED);
jobRepository.add(stepExecution1);
jobExecution.setEndTime(LocalDateTime.now());
jobExecution.setStatus(BatchStatus.COMPLETED);
jobRepository.update(jobExecution);
jobExecution = jobRepository.createJobExecution(job.getName(), jobParameters);
job.execute(jobExecution);
assertEquals(0, jobExecution.getFailureExceptions().size());
assertEquals(1, jobExecution.getStepExecutions().size());
assertEquals(stepExecution2.getStepName(), jobExecution.getStepExecutions().iterator().next().getStepName());
}
@Test
void testStepAlreadyCompleteInSameExecution() throws Exception {
List<Step> steps = new ArrayList<>();
steps.add(step1);
steps.add(step2);
// Two steps with the same name should both be executed, since
// the user might actually want it to happen twice. On a restart
// it would be executed twice again, even if it failed on the
// second execution. This seems reasonable.
steps.add(step2);
job.setSteps(steps);
job.execute(jobExecution);
assertEquals(0, jobExecution.getFailureExceptions().size());
assertEquals(3, jobExecution.getStepExecutions().size());
assertEquals(stepExecution1.getStepName(), jobExecution.getStepExecutions().iterator().next().getStepName());
}
@Test
void testNoSteps() {
job.setSteps(new ArrayList<>());
job.execute(jobExecution);
ExitStatus exitStatus = jobExecution.getExitStatus();
assertTrue(exitStatus.getExitDescription().contains("no steps configured"),
"Wrong message in execution: " + exitStatus);
}
@Test
void testRestart() throws Exception {
step1.setAllowStartIfComplete(true);
final RuntimeException exception = new RuntimeException("Foo!");
step2.setProcessException(exception);
job.execute(jobExecution);
Throwable e = jobExecution.getAllFailureExceptions().get(0);
assertSame(exception, e);
jobExecution = jobRepository.createJobExecution(job.getName(), jobParameters);
job.execute(jobExecution);
e = jobExecution.getAllFailureExceptions().get(0);
assertSame(exception, e);
assertTrue(step1.passedInStepContext.isEmpty());
assertFalse(step2.passedInStepContext.isEmpty());
}
@Test
void testInterruptWithListener() {
step1.setProcessException(new JobInterruptedException("job interrupted!"));
JobExecutionListener listener = mock(JobExecutionListener.class);
listener.beforeJob(jobExecution);
listener.afterJob(jobExecution);
job.setJobExecutionListeners(new JobExecutionListener[] { listener });
job.execute(jobExecution);
assertEquals(BatchStatus.STOPPED, jobExecution.getStatus());
}
/**
* Execution context should be restored on restart.
*/
@Test
void testRestartAndExecutionContextRestored() throws Exception {
job.setRestartable(true);
step1.setAllowStartIfComplete(true);
final RuntimeException exception = new RuntimeException("Foo!");
step2.setProcessException(exception);
job.execute(jobExecution);
assertEquals(1, jobExecution.getAllFailureExceptions().size());
Throwable e = jobExecution.getAllFailureExceptions().get(0);
assertSame(exception, e);
assertEquals(1, step1.passedInJobContext.size());
assertFalse(step2.passedInJobContext.isEmpty());
assertFalse(jobExecution.getExecutionContext().isEmpty());
jobExecution = jobRepository.createJobExecution(job.getName(), jobParameters);
job.execute(jobExecution);
assertEquals(1, jobExecution.getAllFailureExceptions().size());
e = jobExecution.getAllFailureExceptions().get(0);
assertSame(exception, e);
assertFalse(step1.passedInJobContext.isEmpty());
assertFalse(step2.passedInJobContext.isEmpty());
}
@Test
void testGetStepExists() {
step1 = new StubStep("step1", jobRepository);
step2 = new StubStep("step2", jobRepository);
job.setSteps(Arrays.asList(new Step[] { step1, step2 }));
Step step = job.getStep("step2");
assertNotNull(step);
assertEquals("step2", step.getName());
}
@Test
void testGetStepNotExists() {
step1 = new StubStep("step1", jobRepository);
step2 = new StubStep("step2", jobRepository);
job.setSteps(Arrays.asList(new Step[] { step1, step2 }));
Step step = job.getStep("foo");
assertNull(step);
}
/*
* Check JobRepository to ensure status is being saved.
*/
private void checkRepository(BatchStatus status, ExitStatus exitStatus) {
assertEquals(jobInstance,
this.jobRepository.getLastJobExecution(job.getName(), jobParameters).getJobInstance());
JobExecution jobExecution = this.jobExplorer.getJobExecutions(jobInstance).get(0);
assertEquals(jobInstance.getId(), jobExecution.getJobId());
assertEquals(status, jobExecution.getStatus());
if (exitStatus != null) {
assertEquals(exitStatus.getExitCode(), jobExecution.getExitStatus().getExitCode());
}
}
private void checkRepository(BatchStatus status) {
checkRepository(status, null);
}
private static class StubStep extends StepSupport {
private Runnable runnable;
private Throwable exception;
private JobRepository jobRepository;
private ExecutionContext passedInStepContext;
private ExecutionContext passedInJobContext;
/**
* @param string
*/
public StubStep(String string, JobRepository jobRepository) {
super(string);
this.jobRepository = jobRepository;
}
/**
* @param exception
*/
public void setProcessException(Throwable exception) {
this.exception = exception;
}
/**
* @param runnable
*/
public void setCallback(Runnable runnable) {
this.runnable = runnable;
}
/*
* (non-Javadoc)
*
* @see org.springframework.batch.core.step.StepSupport#execute(org.
* springframework.batch.core.StepExecution)
*/
@Override
public void execute(StepExecution stepExecution)
throws JobInterruptedException, UnexpectedJobExecutionException {
passedInJobContext = new ExecutionContext(stepExecution.getJobExecution().getExecutionContext());
passedInStepContext = new ExecutionContext(stepExecution.getExecutionContext());
stepExecution.getExecutionContext().putString("stepKey", "stepValue");
stepExecution.getJobExecution().getExecutionContext().putString("jobKey", "jobValue");
jobRepository.update(stepExecution);
jobRepository.updateExecutionContext(stepExecution);
if (exception instanceof JobInterruptedException) {
stepExecution.setExitStatus(ExitStatus.FAILED);
stepExecution.setStatus(((JobInterruptedException) exception).getStatus());
stepExecution.addFailureException(exception);
throw (JobInterruptedException) exception;
}
if (exception instanceof RuntimeException) {
stepExecution.setExitStatus(ExitStatus.FAILED);
stepExecution.setStatus(BatchStatus.FAILED);
stepExecution.addFailureException(exception);
return;
}
if (exception instanceof Error) {
stepExecution.setExitStatus(ExitStatus.FAILED);
stepExecution.setStatus(BatchStatus.FAILED);
stepExecution.addFailureException(exception);
return;
}
if (exception instanceof JobInterruptedException) {
stepExecution.setExitStatus(ExitStatus.FAILED);
stepExecution.setStatus(BatchStatus.FAILED);
stepExecution.addFailureException(exception);
return;
}
if (runnable != null) {
runnable.run();
}
stepExecution.setExitStatus(ExitStatus.COMPLETED);
stepExecution.setStatus(BatchStatus.COMPLETED);
jobRepository.update(stepExecution);
jobRepository.updateExecutionContext(stepExecution);
}
}
}