Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Terminates the job if a flag is set on afterStep #4455

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Terminates the job if a flag is set on afterStep #4455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions spring-batch-core/src/main/java/org/springframework/batch/core/step/AbstractStep.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
* @author Michael Minella
* @author Chris Schaefer
* @author Mahmoud Ben Hassine
* @author SungBeom Um
*/
public abstract class AbstractStep implements Step, InitializingBean, BeanNameAware {

Expand Down Expand Up @@ -268,6 +269,11 @@ public final void execute(StepExecution stepExecution)
exitStatus = exitStatus.and(stepExecution.getExitStatus());
stepExecution.setExitStatus(exitStatus);
exitStatus = exitStatus.and(getCompositeListener().afterStep(stepExecution));

// Check if someone is trying to stop us
if (stepExecution.isTerminateOnly()) {
stepExecution.upgradeStatus(BatchStatus.STOPPED);
}
}
catch (Exception e) {
logger.error(String.format("Exception in afterStep callback in step %s in job %s", name,
Expand Down
36 changes: 36 additions & 0 deletions ...ng-batch-core/src/test/java/org/springframework/batch/core/step/NonAbstractStepTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,42 @@ public void updateExecutionContext(StepExecution stepExecution) {
assertEquals(ExitStatus.UNKNOWN, execution.getExitStatus());
}

@Test
void testStoppedOnAfterStep() throws Exception {
tested = new EventTrackingStep();
tested.setJobRepository(repository);
StepExecutionListener listener3 = new EventTrackingListener("listener3") {
@Override
public ExitStatus afterStep(StepExecution stepExecution) {
super.afterStep(stepExecution);
stepExecution.setTerminateOnly();
stepExecution.setExitStatus(ExitStatus.STOPPED);
return stepExecution.getExitStatus();
}
};
tested.setStepExecutionListeners(new StepExecutionListener[] { listener1, listener2, listener3 });

tested.execute(execution);
assertEquals(BatchStatus.STOPPED, execution.getStatus());

int i = 0;
assertEquals("listener1#beforeStep", events.get(i++));
assertEquals("listener2#beforeStep", events.get(i++));
assertEquals("listener3#beforeStep", events.get(i++));
assertEquals("open", events.get(i++));
assertEquals("doExecute", events.get(i++));
assertEquals("listener3#afterStep(COMPLETED)", events.get(i++));
assertEquals("listener2#afterStep(STOPPED)", events.get(i++));
assertEquals("listener1#afterStep(STOPPED)", events.get(i++));
assertEquals("close", events.get(i++));
assertEquals(9, events.size());

assertEquals("STOPPED", execution.getExitStatus().getExitCode());

assertTrue(repository.saved.containsKey("afterStep"),
"Execution context modifications made by listener should be persisted");
}

/**
* JobRepository is a required property.
*/
Expand Down