How to unit test an Spring @Bean CommandLineRunner?

Question

I'm using Spring Boot in a little PoC, and I'm trying to test a @Bean implementation. I have this code:

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    CommandLineRunner init(@Value("${db.resetAndLoadOnStartup:true}") boolean resetAndLoadOnStartup,
                           SequenceIdRepository sequenceRepository,
                           UserAccountRepository userAccountRepository,
                           BookRepository bookRepository) {
        return args -> {
            log.info("Init Application...");
            if (resetAndLoadOnStartup) {
                fillDBData(sequenceRepository, userAccountRepository, bookRepository);
            }
            log.info("Aplication initiated!");
        };
    }

    private void fillDBData(SequenceIdRepository sequenceRepository,
                            UserAccountRepository userAccountRepository,
                            BookRepository bookRepository) {
        // Some code...
    }
...
}

How can I unit test this @Bean commandLineRunner? Yeah, maybe I could unit test the 'fillDBData' method (putting protected or with powermock), but I would like to learn if there's a way to test the Spring @Bean "completely".

I think you're going to have to resort to an integration test here. — gyoder, Apr 10 '15 at 14:41
Yeah, I guessed that, but I don't know how to "call" the bean in a test :S — edwise, Apr 13 '15 at 09:30

score 5 · Answer 1 · answered Apr 13 '15 at 14:16

Here's how you could test with an integration test.

@RunWith(SpringJUnit4ClassRunner.class)
// Or create a test version of Application.class that stubs out services used by the CommandLineRunner
@SpringApplicationConfiguration(classes = Application.class)
public class CommandLineRunnerIntegrationTest {

    @Autowired
    private CommandLineRunner clr;

    @Test
    public void thatCommandLineRunnerDoesStuff() throws Exception {
        this.clr.run();
        // verify changes...
    }

}

That being said, my preference would be to create a named service that implements command line runner and then unit test it with all of its dependencies mocked out. In my opinion, it's not critical to test that Spring is going to call the CommandLineRunner bean when the application loads, but that the CommandLineRunner implementation calls other services appropriately.

Thanks, i'll try it. Yeah, I prefer to mock the rest of dependencies. — edwise, Apr 14 '15 at 06:58

score 4 · Answer 2 · answered Apr 10 '15 at 15:05

4

You can use OutputCapture to see what you print in the console

@Rule
public OutputCapture outputCapture = new OutputCapture();

in your test method:

String output = this.outputCapture.toString();
    assertTrue(output, output.contains("Aplication initiated!"));

answered Apr 10 '15 at 15:05

Eddú Meléndez

6,107
1
26
35

I'm not talking about test the logs... :) I'm talking about test a @Bean – edwise Apr 13 '15 at 09:28

score 1 · Answer 3 · answered Apr 19 '20 at 19:05

Create MyApplication class

package com.company.project;
//imports
@SpringBootApplication(scanBasePackages = "com.company.project")
public class FileToDbApplication {
  public static void main(String[] args) {
    SpringApplication.run(FileToDbApplication.class, args);
  }
}

Create MyCommandLineRunner class

package com.company.project;
//imports
@Component
public class MyCommandLineRunner implements CommandLineRunner {
  @Autowired
  private SurValueService surValueService;

  @Override
  public void run(String... args) {
    System.out.println("App started with " + args.length + " parameters.");
  }
}

Create MyConfiguration class (you may not need @EntityScan and @EnableJpaRepositories)

package com.company.project;
//imports
@SpringBootConfiguration
@ComponentScan("com.company.project")
@EnableAutoConfiguration
@EntityScan(basePackages = "com.company.project.model")
@EnableJpaRepositories(basePackages = "com.company.project.service")
public class MyConfiguration {

}

Create MyCommandLineRunnerTest in src.test.java

package com.company.project;
//imports
@ExtendWith(SpringExtension.class)
@SpringBootTest
class MyCommandLineRunnerTest {

  @Autowired
  MyCommandLineRunner commandLineRunner;

  @Test
  public void testMain() {
    commandLineRunner.run("input.txt", "input2.txt");
  }
}

How to unit test an Spring @Bean CommandLineRunner?

3 Answers3

Linked