Extension for Flyway

[Sanne]

As suggested by @cristhiank on:

• https://stackoverflow.com/questions/55233662/how-add-flyway-dependency-and-build-native-image-quarkus-java-lang-classnotfound
• https://github.com/cristhiank/quarkus-flyway-bug

[kenfinnigan]

We had one for Thorntail, so should be easy enough

[Sanne]

This is now assigned to @cristhiank , assigning to myself as mentor.

[Sanne]

I haven't tested this, but I suspect that all you need is to have a class similar to this one:

@TargetClass(className="org.flywaydb.core.internal.util.FeatureDetector")
@Substitute
public final class FlywayFeatureDetectionSubstitutions {

    @Substitute
    public boolean isApacheCommonsLoggingAvailable() {
        return false;
    }

    @Substitute
    public boolean isSlf4jAvailable() {
        return false;
    }

    @Substitute
    public boolean isSpringJdbcAvailable() {
        return false;
    }

    @Substitute
    public boolean isJBossVFSv2Available() {
        return false;
    }

    @Substitute
    public boolean isJBossVFSv3Available() {
        return false;
    }

    @Substitute
    public boolean isOsgiFrameworkAvailable() {
        return false;
    }

    @Substitute
    public boolean isAndroidAvailable() {
        return false;
    }

}

This should be packaged in the "runtime" module of a Flyway Quarkus extension.

[cristhiank]

Ok, got it, let me work on it and I will let you know.
thanks @Sanne

[cristhiank]

@Sanne please take a look to the first approach to implement this on my repo:

cristhiank@e87f3f3

I ended up doing some more substitutions but it is working now.

[cristhiank]

I also updated the test repo I made to use it and it is working now cristhiank/quarkus-bugs@ce3d2d9

[Sanne]

thanks @cristhiank ! it's looking great.

I haven't tried it out yet, I'll trust you on that for now.. I had some minor comments.
Also, could you remove the @authors tags? apparently we're going to remove them all.

Looks like the main thing missing is some basic integration tests.

Please send a pull request when you're happy with it?

[cristhiank]

Thanks @Sanne I will remove the tags, these are the defaults from my IDE 😣 . I will implement the integration tests. What am I suppose to test in this case ? I don’t know how to test the Substitutions but I will find the way, help is appreciate it as always 🙂

[Sanne]

To test things what we usually do is create a new module under /integration-tests/.

Since we can't use JUnit to test the native code, what we normally do is have an application which exposes a REST endpoint, and uses the to-be-tested component to return an "OK". This can be trivially done as we provide several helpers to do this easily.

Since you're creating a new extension, you could add a new module - even if you're going to have just one or two trivial tests that's ok, it helps to test extensions in isolation.

Have a look at, for example, integration tests for the pgsql jdbc driver:

• https://github.com/quarkusio/quarkus/tree/master/integration-tests/jpa-postgresql

some points of interest:

1. relatively easy to start a postgresql database via the maven plugin at https://github.com/quarkusio/quarkus/blob/master/integration-tests/jpa-postgresql/pom.xml#L178
2. most slow tests - like the ones requiring docker or building native-images are disabled by default
3. there's an easy to use @SubstrateTest annotation to test the binaries: https://github.com/quarkusio/quarkus/blob/master/integration-tests/jpa-postgresql/src/test/java/io/quarkus/example/test/JPAFunctionalityInGraalITCase.java
4. and an easy QuarkusTest annotation to test the same thing, but in JVM: https://github.com/quarkusio/quarkus/blob/master/integration-tests/jpa-postgresql/src/test/java/io/quarkus/example/test/JPAFunctionalityTest.java
5. the REST endpoint is very easy to define: https://github.com/quarkusio/quarkus/blob/master/integration-tests/jpa-postgresql/src/main/java/io/quarkus/example/jpa/JPAFunctionalityTestEndpoint.java#L40
6. remember that the endpoint implementation needs to be in /src/main/java, not in tests.. as we'll have to build it as an application ;)

[Sanne]

P.S. forgot to say: of course this makes sure you can test the full compilation of an "application" using Flyway, and so verify indirectly that all substitutions are doing the intended job. You'll have to find a way to assert that Flyway did something - maybe import something on the database, then assert for that?

[cristhiank]

Great, I got it, I will work in it and will be back with the results. Thanks for all your help.