Search code examples
javajunitspring-junit

JUnit Rule using a spring bean


I have a test class which loads a test spring application context, now I want to create a junit rule which will setup some test data in mongo db. For this I created a rule class.

public class MongoRule<T> extends ExternalResource {

    private MongoOperations mongoOperations;
    private final String collectionName;
    private final String file;

    public MongoRule(MongoOperations mongoOperations, String file, String collectionName) {
        this.mongoOperations = mongoOperations;
        this.file = file;
        this.collectionName = collectionName;
    }

    @Override
    protected void before() throws Throwable {
        String entitiesStr = FileUtils.getFileAsString(file);
        List<T> entities = new ObjectMapper().readValue(entitiesStr, new TypeReference<List<T>>() {
        });
        entities.forEach((t) -> {            
            mongoOperations.save(t, collectionName);
        });
    }
}

Now I am using this rule inside my test class and passing the mongoOperations bean.

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringTestConfiguration.class)
public class TransactionResourceTest {

    @Autowired
    private ITransactionResource transactionResource;

    @Autowired
    private MongoOperations mongoOperations;

    @Rule
    public MongoRule<PaymentInstrument> paymentInstrumentMongoRule 
        = new MongoRule(mongoOperations, "paymentInstrument.js", "paymentInstrument");    
....
}

The problem is that Rule is getting executed before application context gets loaded, so mongoOperations reference is passed as null. Is there a way to make rules run after the context is loaded?


Solution

  • Here's a solution, using some abstract super class:

    @RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(classes = SpringTestConfiguration.class)
    public abstract class AbstractTransactionResourceTest<T> {
    
        @Autowired
        private ITransactionResource transactionResource;
    
        @Autowired
        private MongoOperations mongoOperations;
    
        @Before
        public void setUpDb() {
            String entitiesStr = FileUtils.getFileAsString(entityName() + ".js");
            List<T> entities = new ObjectMapper().readValue(entitiesStr, new TypeReference<List<T>>() {});
            entities.forEach((t) -> {            
                mongoOperations.save(t, entityName());
            }); 
        }    
    
        protected abstract String entityName();
    }
    

    then

    public class TransactionResourceTest extends AbstractTransactionResourceTest<PaymentInstrument> {
        @Override
        protected String entityName() {
            return "paymentInstrument";
        };
    
        // ...
    }