Skip to content

Commit

Permalink
Fix disposable bean lifecycle in JobScope test utilities
Browse files Browse the repository at this point in the history
Before this commit, the destroy method of a job-scoped
bean was not called after a test method.

This commit changes the listener to respect the
DisposableBean contract for job-scoped beans (and make it
consistent with the calls to the JobSynchronizationManager
in AbstractJob, ie calling register/release).

FTR, I did not find a clean way to test this with an
assertion (which should be made after the test method),
but a log message in the destroy method shows that the
method is now called as expected.

Resolves #1288

(cherry picked from commit ad50599)
  • Loading branch information
fmbenhassine committed Nov 21, 2023
1 parent 9f42b40 commit 783144f
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 68 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2006-2010 the original author or authors.
* Copyright 2006-2023 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.
Expand Down Expand Up @@ -104,7 +104,7 @@ public void beforeTestMethod(org.springframework.test.context.TestContext testCo
@Override
public void afterTestMethod(TestContext testContext) throws Exception {
if (testContext.hasAttribute(JOB_EXECUTION)) {
JobSynchronizationManager.close();
JobSynchronizationManager.release();
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2006-2010 the original author or authors.
* Copyright 2006-2023 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.
Expand Down Expand Up @@ -29,6 +29,7 @@
*
* @author Dave Syer
* @author Jimmy Praet
* @author Mahmoud Ben Hassine
*/
public class JobScopeTestUtils {

Expand All @@ -38,7 +39,7 @@ public static <T> T doInJobScope(JobExecution jobExecution, Callable<T> callable
return callable.call();
}
finally {
JobSynchronizationManager.close();
JobSynchronizationManager.release();
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,64 +1,67 @@
/*
* Copyright 2013-2018 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.test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.item.ExecutionContext;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.ItemStream;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.TestExecutionListeners;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.support.DependencyInjectionTestExecutionListener;

/**
* @author Dave Syer
* @author Mahmoud Ben Hassine
* @since 2.1
*/
@ContextConfiguration
@TestExecutionListeners({ DependencyInjectionTestExecutionListener.class, JobScopeTestExecutionListener.class })
@RunWith(SpringJUnit4ClassRunner.class)
public class JobScopeTestExecutionListenerIntegrationTests {

@Autowired
private ItemReader<String> reader;

@Autowired
private ItemStream stream;

public JobExecution getJobExecution() {
// Assert that dependencies are already injected...
assertNotNull(reader);
// Then create the execution for the job scope...
JobExecution execution = MetaDataInstanceFactory.createJobExecution();
execution.getExecutionContext().putString("input.file", "classpath:/org/springframework/batch/test/simple.txt");
return execution;
}

@Test
public void testJob() throws Exception {
stream.open(new ExecutionContext());
assertEquals("foo", reader.read());
}

}
/*
* Copyright 2013-2023 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.test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.batch.core.JobExecution;
import org.springframework.batch.item.ExecutionContext;
import org.springframework.batch.item.ItemReader;
import org.springframework.batch.item.ItemStream;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.TestExecutionListeners;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.support.DependencyInjectionTestExecutionListener;

/**
* @author Dave Syer
* @author Mahmoud Ben Hassine
* @since 2.1
*/
@ContextConfiguration
@TestExecutionListeners({ DependencyInjectionTestExecutionListener.class, JobScopeTestExecutionListener.class })
@RunWith(SpringJUnit4ClassRunner.class)
public class JobScopeTestExecutionListenerIntegrationTests {

@Autowired
private ItemReader<String> reader;

@Autowired
private ItemStream stream;

public JobExecution getJobExecution() {
// Assert that dependencies are already injected...
assertNotNull(reader);
// Then create the execution for the job scope...
JobExecution execution = MetaDataInstanceFactory.createJobExecution();
execution.getExecutionContext().putString("input.file", "classpath:/org/springframework/batch/test/simple.txt");
return execution;
}

@Test
public void testJob() throws Exception {
stream.open(new ExecutionContext());
assertEquals("foo", reader.read());
assertEquals("bar", reader.read());
assertNull(reader.read());
}

}

0 comments on commit 783144f

Please sign in to comment.