Handle TestContext class to interface conversion from Spring 3 to Spring 4

chrisjs · mminella · commit 3eb7511322e8 · 2014-05-22T11:19:36.000-05:00
Use reflection to make calls to the provided TestContext in StepScopeTestExecutionListener
Enables usage of Spring 4 w/ Batch 2.2 (in this case)
diff --git a/spring-batch-test/src/main/java/org/springframework/batch/test/StepScopeTestExecutionListener.java b/spring-batch-test/src/main/java/org/springframework/batch/test/StepScopeTestExecutionListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2010 the original author or authors.
+ * Copyright 2006-2014 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.
@@ -61,11 +61,14 @@
  * </pre>
  * 
  * @author Dave Syer
- * 
+ * @author Chris Schaefer
  */
 public class StepScopeTestExecutionListener implements TestExecutionListener {
-
 	private static final String STEP_EXECUTION = StepScopeTestExecutionListener.class.getName() + ".STEP_EXECUTION";
+	private static final String SET_ATTRIBUTE_METHOD_NAME = "setAttribute";
+	private static final String HAS_ATTRIBUTE_METHOD_NAME = "hasAttribute";
+	private static final String GET_ATTRIBUTE_METHOD_NAME = "getAttribute";
+	private static final String GET_TEST_INSTANCE_METHOD = "getTestInstance";
 
 	/**
 	 * Set up a {@link StepExecution} as a test context attribute.
@@ -74,11 +77,13 @@ public class StepScopeTestExecutionListener implements TestExecutionListener {
 	 * @throws Exception if there is a problem
 	 * @see TestExecutionListener#prepareTestInstance(TestContext)
 	 */
-    @Override
+	@Override
 	public void prepareTestInstance(TestContext testContext) throws Exception {
 		StepExecution stepExecution = getStepExecution(testContext);
+
 		if (stepExecution != null) {
-			testContext.setAttribute(STEP_EXECUTION, stepExecution);
+			Method method = TestContext.class.getMethod(SET_ATTRIBUTE_METHOD_NAME, String.class, Object.class);
+			ReflectionUtils.invokeMethod(method, testContext, STEP_EXECUTION, stepExecution);
 		}
 	}
 
@@ -87,38 +92,45 @@ public void prepareTestInstance(TestContext testContext) throws Exception {
 	 * @throws Exception if there is a problem
 	 * @see TestExecutionListener#beforeTestMethod(TestContext)
 	 */
-    @Override
-	public void beforeTestMethod(org.springframework.test.context.TestContext testContext) throws Exception {
-		if (testContext.hasAttribute(STEP_EXECUTION)) {
-			StepExecution stepExecution = (StepExecution) testContext.getAttribute(STEP_EXECUTION);
+	@Override
+	public void beforeTestMethod(TestContext testContext) throws Exception {
+		Method hasAttributeMethod = TestContext.class.getMethod(HAS_ATTRIBUTE_METHOD_NAME, String.class);
+		Boolean hasAttribute = (Boolean) ReflectionUtils.invokeMethod(hasAttributeMethod, testContext, STEP_EXECUTION);
+
+		if (hasAttribute) {
+			Method method = TestContext.class.getMethod(GET_ATTRIBUTE_METHOD_NAME, String.class);
+			StepExecution stepExecution = (StepExecution) ReflectionUtils.invokeMethod(method, testContext, STEP_EXECUTION);
+
 			StepSynchronizationManager.register(stepExecution);
 		}
-
 	}
 
 	/**
 	 * @param testContext the current test context
 	 * @throws Exception if there is a problem
 	 * @see TestExecutionListener#afterTestMethod(TestContext)
 	 */
-    @Override
+	@Override
 	public void afterTestMethod(TestContext testContext) throws Exception {
-		if (testContext.hasAttribute(STEP_EXECUTION)) {
+		Method method = TestContext.class.getMethod(HAS_ATTRIBUTE_METHOD_NAME, String.class);
+		Boolean hasAttribute = (Boolean) ReflectionUtils.invokeMethod(method, testContext, STEP_EXECUTION);
+
+		if (hasAttribute) {
 			StepSynchronizationManager.close();
 		}
 	}
 
 	/*
 	 * Support for Spring 3.0 (empty).
 	 */
-    @Override
+	@Override
 	public void afterTestClass(TestContext testContext) throws Exception {
 	}
 
 	/*
 	 * Support for Spring 3.0 (empty).
 	 */
-    @Override
+	@Override
 	public void beforeTestClass(TestContext testContext) throws Exception {
 	}
 	
@@ -130,8 +142,14 @@ public void beforeTestClass(TestContext testContext) throws Exception {
 	 * @return a {@link StepExecution}
 	 */
 	protected StepExecution getStepExecution(TestContext testContext) {
+		Object target;
 
-		Object target = testContext.getTestInstance();
+		try {
+			Method method = TestContext.class.getMethod(GET_TEST_INSTANCE_METHOD);
+			target = ReflectionUtils.invokeMethod(method, testContext);
+		} catch (NoSuchMethodException e) {
+			throw new IllegalStateException("No such method " + GET_TEST_INSTANCE_METHOD + " on provided TestContext", e);
+		}
 
 		ExtractorMethodCallback method = new ExtractorMethodCallback(StepExecution.class, "getStepExecution");
 		ReflectionUtils.doWithMethods(target.getClass(), method);
@@ -173,7 +191,7 @@ public String getName() {
 			return result == null ? null : result.getName();
 		}
 
-        @Override
+		@Override
 		public void doWith(Method method) throws IllegalArgumentException, IllegalAccessException {
 			Class<?> type = method.getReturnType();
 			if (preferredType.isAssignableFrom(type)) {
@@ -183,5 +201,4 @@ public void doWith(Method method) throws IllegalArgumentException, IllegalAccess
 			}
 		}
 	}
-
 }
