juriad / jooq-mcve

A simple example project that can be used to create MCVE's to report jOOQ issues

Thank you very much for taking the time to report a bug to us, we greatly appreciate it. Even more so, since you are about to take the time to create an MCVE (Minimal Complete Verifiable Example). Thanks to you, we can make jOOQ an even better product!

How to use this project to prepare your MCVE

Create a fork from this project and then

git clone https://github.com/<your-user-name>/jOOQ-mcve
cd jOOQ-mcve
mvn verify

It will, for each supported language (java, kotlin, scala):

• Use Flyway to install a sample schema located in src/main/resources/db/migration into an H2 database
• Run jOOQ's code generator on it
• Run a simple integration test

This should work without any additional setup on your side, other than having a JDK and Maven available.

How to prepare your MCVE

For your MCVE, you will have to adapt a few things, probably. All likely locations that may need adaptation are marked with "TODO". This includes:

• The Java / kotlin / scala version:
  • Go to the relevant pom.xml file, search for java.version, kotlin.version, scala.version, and adapt the version there.
• The jOOQ edition and version:
  • Go to the relevant pom.xml file, search for org.jooq.groupId and org.jooq.version, and adapt the version there.
• The JDBC driver:
  • Go to the relevant pom.xml file, replace the H2 driver <dependency> by yours, and adapt ${db.url}, ${db.username}, and ${db.password}
  • Go to the relevant test class (org.jooq.mcve.test.java.JavaTest, org.jooq.mcve.test.kotlin.KotlinTest, or org.jooq.mcve.test.scala.ScalaTest) and replace URL, username, and password there as well

In addition to the above, you probably need to adapt also:

• The SQL script
• The code generator configuration in the pom.xml
• The actual test that is being run in any of (depending on what you're using):
  • org.jooq.mcve.test.java.JavaTest
  • org.jooq.mcve.test.kotlin.KotlinTest
  • org.jooq.mcve.test.scala.ScalaTest

When you've set up your MCVE, run these statements again:

mvn clean verify

Notice that if you're using the same H2 database that was used initially, you may need to run

mvn -pl jooq-mcve-java,jooq-mcve-kotlin,jooq-mcve-scala flyway:clean

... in order to reset your database (Beware: As it says. This resets your database).

How to submit your MCVE

Found a way to reproduce the issue using the above procedure? Excellent! Now:

git add .
git commit -m "MCVE for issue #1234"
git push

And include a link to your repository https://github.com/<your-user-name>/jOOQ-mcve in your issue report. Done!

Thanks again for taking the time to do this. Looking forward to your MCVE