Spring Boot Java Template

To ensure test code runs smoothly out of the box, configure IntelliJ IDEA to use its own runner for Gradle tests:

1. Open Settings/Preferences.
2. Navigate to Build, Execution, Deployment > Build Tools > Gradle.
3. Set Run tests using to IntelliJ IDEA.

Build, Execution, Deployment > Build Tools > Gradle > Run tests using > IntelliJ IDEA

The template provides several predefined runtime profiles for different environments:

• local: Configures an environment for offline development (disconnected from network).
• local-dev: Configures the local machine to connect to the DEV environment.
• dev: Used for deploying to Development environments.
• staging: Used for deploying to Staging environments.
• live: Used for deploying to Live (Production) environments.

The db-core module uses HikariCP for connection pooling. You can configure the core datasource properties using the storage.datasource.core prefix in your application configuration (e.g., application.yml or application.properties). These properties are mapped directly to a HikariConfig object.

storage:
  datasource:
    core:
      jdbc-url: jdbc:postgresql://localhost:5432/mydb
      username: user
      password: password
      maximum-pool-size: 10

To enable Spring Cloud OpenFeign client scanning in your Spring Boot application, use the @EnableFeignClients annotation on a @Configuration class. This allows the application to detect and instantiate interfaces annotated with @FeignClient.

@EnableFeignClients
@Configuration
class ExampleConfig {

}

The CoreJpaConfig class provides the foundational Spring configuration for JPA and transaction management within the db-core module. It automatically enables transaction management and configures scanning for JPA entities and repositories within the io.dodn.springboot.storage.db.core package hierarchy.

When using this module, ensure your entities and repositories are located within or under the io.dodn.springboot.storage.db.core package to be automatically detected by this configuration.

The project defines several test tasks and groupings. You can run these via Gradle:

• test: A collection of test tasks intended for CI (Continuous Integration) environments. Settings are managed in build.gradle.
• unitTest: Fast-running tests with no dependencies that target single features.
• contextTest: Integration tests that run within a SpringContext.
• restDocsTest: Generates asciidoc documentation using spring-rest-docs.
• developTest: Tests that should not be run in CI. This is a recommended tag for tests that are not yet stable or reliable.