DEV Community

loading...
Cover image for Generate jooq classes using docker containers

Generate jooq classes using docker containers

Rohith Menon
#startups #techenthusiast #java #js #tech #linux #datastructures #patternlover #arsenal #gooner #arsenalmyfirstlove
・1 min read

Tech stack - #java, #maven, #liquibase, #docker

Why?

I will talk about what we did to achieve below things,

  1. Generate jooq-classes from an in-memory or Adhoc database instead of connecting to prelive/live environments.

  2. How to apply all the migrations using liquibase before generating jooq-classes.

  3. Generate jooq-classes based on Postgres driver. Jooq supports generating classes connecting to h2 (in-memory database) but not Postgres. We use Postgres mostly and h2 mostly does not support many features Postgres has.

  4. Avoid using multiple maven plugins and 100 lines of code instead use one maven plugin.

What we did

  1. Start "Test-containers" during maven pre-compile stage. (https://www.testcontainers.org/#about)

  2. Apply liquibase migrations over the test-container.

  3. Generate jooq-classes based for the schema provided.

Where can I find

GitHub logo jango89 / jooqgen-liquibase-postgres

Maven plugin with jooq, liquibase and postgres

What is this

Maven plugin which can be integrated to any maven project Sample :

<plugin>  
    <groupId>com.mytaxi</groupId>  
     <artifactId>jooqgen-liquibase-postgres</artifactId>
    <configuration>
        <schema>bookingoptionsservice</schema> <-- schema name -->
        <packageName>com.mytaxi.bookingoptionsservice</packageName> <-- package to be created for generated classes -->
        <liquibaseChangeLogFile>${liquibase.changeLogFile}</liquibaseChangeLogFile> 
    </configuration>
    <executions>
         <execution>
             <phase>generate-sources</phase>
            <goals>
                 <goal>jooqOverPostgresContainer</goal>
            </goals>
        </execution>
    </executions>
 </plugin>      

What it does

  1. Starts a postgress docker container.
  2. Applies liquibase changes over the container.
  3. Generates JOOQ classes for the source project connecting to postgres container.

Problems and solutions

If generated classes fail to compile,

  1. include /target/generated-sources/jooq/ folder to corresponding compiler plugin.
  2. If kotlin-maven-plugin compilation failes, add
    <configuration>
        <sourceDirs>
            <source>src/main/java</source>
            <source>target/generated-sources/jooq</source>
        </sourceDirs>
    </configuration>
    
  3. If the NoClassDefError happens, this means the class files are missing. Add the following plugin
 <plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>build-helper-maven-plugin</artifactId>
    <executions>
        <execution>
            <phase>generate-sources</phase>
            <goals>
                <goal>add-source</goal>
            </goals>
            <configuration>
                <sources>
                    <source>${project.build.directory}/generated-sources/jooq</source>
                </sources>
            </configuration>
        </execution>
    </executions>
 </plugin>



Discussion (1)

Collapse
snaketl profile image
Luiz Henrique Feltes

Nice work!!!