Executing Tasks

Gradle uses the concept of build tasks (equivalent to Ant targets or Maven phases/goals). You can get a list ofavailable tasks via

To execute a task across all modules, simply perform that task from the root directory. Gradle will visit eachsub-project and execute that task if the sub-project defines it. To execute a task in a specific module you caneither:

1. cd into that module directory and execute the task

2. name the "task path". For example, to run the tests for thehibernate-core module from the root directoryyou could saygradle hibernate-core:test

Common tasks

The common tasks you might use in building Hibernate include:

• build - Assembles (jars) and tests this project

• compile - Performs all compilation tasks including staging resources from both main and test

• jar - Generates a jar archive with all the compiled classes

• test - Runs the tests

• publishToMavenLocal - Installs the project jar to your local maven cache (aka ~/.m2/repository). Note that Gradlenever uses this, but it can be useful for testing your build with other local Maven-based builds.

• clean - Cleans the build directory

Using the "Matrix Testing Plugin" for Gradle.

Coming later…

Using "profiles"

The Hibernate build defines several database testing "profiles" indatabases.gradle. Theseprofiles can be activated by name using thedb build property which can be passed either asa JVM system prop (-D) or as a Gradle project property (-P). Examples below use the Gradleproject property approach.

To run a test from your IDE, you need to ensure the property expansions happen.Use the following command:

NOTE: If you are running tests against a JDBC driver that is not available via Maven central be sure toadd these drivers to your local Maven repo cache (~/.m2/repository) or (better) add it to a personal Maven repo server

Running database-specific tests from the IDE using "profiles"

You can run any test on any particular database that is configured in adatabases.gradle profile.

All you have to do is run the following command:

or you can use the shortcut version:

You can do this from the module which you are interested in testing or from thehibernate-orm root folder.

Afterward, just pick any test from the IDE and run it as usual. Hibernate will pick the database configuration from thehibernate.propertiesfile that was set up by thesetDataBase Gradle task.

Starting test databases locally as docker containers

You don’t have to install all databases locally to be able to test against them in case you have docker available.The scriptdocker_db.sh allows you to start a pre-configured database which can be used for testing.

All you have to do is run the following command:

omitting the argument will print a list of possible options.

When the database is properly started, you can run tests with special profiles that are suffixed with_cie.g.pgsql_ci for PostgreSQL. By using the system propertydbHost you can configure the IP address of your docker host.

The command for running tests could look like the following:

The following table illustrates a list of commands for various databases that can be tested locally.

To stop a container started bydocker, use the command

NOTE

Substitutepodman command fordocker if usingpodman

E.g., to stop the mariadb container