Provide spring-boot-starter-liquibase-starter starter module (feature request)

[marceloverdijk]

It would be nice to to have auto-configured support for running liquibase migrations.

[marceloverdijk]

See also http://stackoverflow.com/questions/23033964/spring-boot-liquibase-integration

[marceloverdijk]

What we can do is create a Liquibase auto configuration creating a SpringLiquibase bean which automatically runs migrations from e.g. classpath:/migrations/

I can work this further out via pull request if you are interested?

[marceloverdijk]

What I did for now was adding the SpringLiquibase bean to my Application.java class like:

@Bean
public SpringLiquibase liquibase() {
    SpringLiquibase liquibase = new SpringLiquibase();
    liquibase.setChangeLog("classpath:/db/changelog/db.changelog-master.yaml");
    liquibase.setDataSource(dataSource);
    return liquibase;
}

Note that also the compile("org.liquibase:liquibase-core") dependency is needed.

This way during startup the database migrations (changelog) are executed automatically.

[marceloverdijk]

@dsyer I have this almost implemented.

I'm only stuck at the unit tests related to the LiquibaseServiceLocatorApplicationListener which sets the Spring Boot specific SpringPackageScanClassResolver.

@Test
public void testDefaultSpringLiquibase() throws Exception {
    this.context.register(EmbeddedDataSourceConfiguration.class,
            LiquibaseAutoConfiguration.class,
            PropertyPlaceholderAutoConfiguration.class);
    this.context.addApplicationListener(new LiquibaseServiceLocatorApplicationListener());
//          I'm adding the LiquibaseServiceLocatorApplicationListener above but the listener does not seem to be executed
//          The assertThat below on SpringPackageScanClassResolver fails
    this.context.refresh();
    SpringLiquibase liquibase = this.context.getBean(SpringLiquibase.class);

//      ServiceLocator.setInstance(new CustomResolverServiceLocator(
//              new SpringPackageScanClassResolver(logger)));
//          When I uncomment above lines then unit test runs succesfully

    ServiceLocator instance = ServiceLocator.getInstance();
    Field field = ReflectionUtils.findField(ServiceLocator.class, "classResolver");
    field.setAccessible(true);
    Object resolver = field.get(instance);
    assertThat(resolver, instanceOf(SpringPackageScanClassResolver.class));

    assertEquals("classpath:/db/changelog/db.changelog-master.yaml", liquibase.getChangeLog());
}

See the inline code comments. Basically I'm unable to execute the LiquibaseServiceLocatorApplicationListener in the test case.

Any idea?

[dsyer]

The LiquibaseServiceLocatorApplicationListener is a listener for a Spring Boot event (ApplicationStartedEvent) and you aren't using Spring Boot (i.e. SpringApplication to start your app, so that even is never fired). Should be easy to fix?

[dsyer]

Duplicates #687