Provide first class support for Groovy context loading in tests [SPR-11631]

[spring-projects-issues]

Abhijit Sarkar opened SPR-11631 and commented

There is no support for reading Groovy config files in tests without writing a custom ContextLoader. The default @ContextConfiguration tries to interpret Groovy files as XMLs.
I have created a bare bone ContextLoader for supporting Groovy config. I'm interested in submitting a pull request but see that the CONTRIBUTING.md asks that I create a JIRA first.

GroovyContextConfiguration.java

/**
 * Class-level annotation that is used to determine how to load and configure an
 * ApplicationContext for integration tests. Similar to the standard
 * {@link org.springframework.test.context.ContextConfiguration} but uses
 * {@link GenericGroovyContextLoader}.
 *
 * @author Abhijit Sarkar
 * @see GenericGroovyContextLoader
 */
@ContextConfiguration(loader = GenericGroovyContextLoader.class)
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface GroovyContextConfiguration {

    /**
     * @see ContextConfiguration#locations()
     */
    String[] locations() default {};

    /**
     * @see ContextConfiguration#classes()
     */
    Class<?>[] classes() default {};

    /**
     * @see ContextConfiguration#initializers()
     */
    Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>[] initializers() default {};

    /**
     * @see ContextConfiguration#inheritLocations()
     */
    boolean inheritLocations() default true;

    /**
     * @see ContextConfiguration#inheritInitializers()
     */
    boolean inheritInitializers() default true;

    /**
     * @see ContextConfiguration#name()
     */
    String name() default "";

}

GenericGroovyContextLoader.java

public class GenericGroovyContextLoader extends AbstractGenericContextLoader {
    @Override
    protected BeanDefinitionReader createBeanDefinitionReader(final GenericApplicationContext context) {
        final GroovyBeanDefinitionReader reader = new GroovyBeanDefinitionReader(context);

        final Binding binding = getBinding(reader);

        reader.setBinding(binding);

        return reader;
    }

    protected Binding getBinding(final GroovyBeanDefinitionReader reader) {
        return new Binding();
    }

    @Override
    protected String getResourceSuffix() {
        return ".groovy";
    }
}

Usage

@RunWith(SpringJUnit4ClassRunner)
@GroovyContextConfiguration(locations = ['classpath:service-config.groovy', 'classpath:integ-test-config.groovy',
        'classpath:service-config-scan.groovy'])
abstract class AbstractSpringIntegrationTest {
}

---

Affects: 4.0.3

Issue Links:

• Support Groovy scripts for bean definitions in the TestContext framework [SPR-11233] #15858 Support Groovy scripts for bean definitions in the TestContext framework ("duplicates")

[spring-projects-issues]

Sam Brannen commented

This is a duplicate of #15858.