Project Scaffolding: Clean Architecture with Spring Boot, MariaDB, Liquibase, Gradle, Docker.

Author: tonylook

.gitignore

@@ -0,0 +1,31 @@
+.gradle
+build/
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store

Dockerfile

@@ -0,0 +1,9 @@
+FROM eclipse-temurin:21-jdk AS build
+WORKDIR /home/gradle/src
+COPY . /home/gradle/src
+RUN ./gradlew :application:bootJar --no-daemon
+
+FROM eclipse-temurin:21-jre
+COPY --from=build /home/gradle/src/application/build/libs/application.jar /application.jar
+EXPOSE 8090
+ENTRYPOINT ["java","-jar","/application.jar"]

application/build.gradle.kts

@@ -0,0 +1,35 @@
+apply {
+    plugin("org.springframework.boot")
+}
+
+val cucumberVersion = ""
+val jakartaVersion = ""
+dependencies {
+    implementation(project(":core"))
+    implementation(project(":mariadb"))
+    implementation(project(":spring-web"))
+
+    implementation("org.liquibase:liquibase-core")
+    implementation("org.springframework.boot:spring-boot-starter-data-jpa")
+    implementation("org.springframework.boot:spring-boot-configuration-processor")
+    implementation("jakarta.validation:jakarta.validation-api:3.0.2")
+    implementation("org.springframework.boot:spring-boot-starter-web")
+    implementation("org.springframework.boot:spring-boot-starter-actuator")
+    implementation("org.springframework.boot:spring-boot-starter-logging")
+    implementation("io.swagger.core.v3:swagger-annotations:2.2.16")
+    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0")
+
+    runtimeOnly("org.mariadb.jdbc:mariadb-java-client")
+    runtimeOnly("io.micrometer:micrometer-registry-prometheus")
+
+    testImplementation("io.reactivex.rxjava2:rxjava:2.1.14")
+    testImplementation("org.junit.platform:junit-platform-suite-engine")
+    testImplementation("io.cucumber:cucumber-java:7.15.0")
+    testImplementation("io.cucumber:cucumber-spring:7.15.0")
+    testImplementation("io.cucumber:cucumber-junit-platform-engine:7.15.0")
+    testImplementation("org.springframework.boot:spring-boot-testcontainers")
+    testImplementation("org.testcontainers:junit-jupiter")
+    testImplementation("org.testcontainers:mariadb")
+    testImplementation("org.springframework.boot:spring-boot-starter-webflux")
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+}

application/src/main/java/com/qa/blog/application/ApplicationConfig.java

@@ -0,0 +1,16 @@
+package com.qa.blog.application;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import java.time.Clock;
+import java.time.ZoneId;
+
+@Configuration
+public class ApplicationConfig {
+
+    @Bean
+    public Clock clock() {
+        return Clock.system(ZoneId.of("CET"));
+    }
+}

application/src/main/java/com/qa/blog/application/BlogApplication.java

@@ -0,0 +1,19 @@
+package com.qa.blog.application;
+
+import com.qa.blog.mariadb.MariaConfig;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Import;
+import org.springframework.scheduling.annotation.EnableScheduling;
+
+@Import({MariaConfig.class})
+@ComponentScan(basePackages = "com.qa.blog")
+@SpringBootApplication
+@EnableScheduling
+public class BlogApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(BlogApplication.class, args);
+    }
+}

application/src/main/resources/application-local.yml

@@ -0,0 +1,9 @@
+server:
+  port: 8090
+spring:
+  datasource:
+    url: jdbc:mariadb://mariadb:3306/blog?useSSL=false&serverTimezone=Europe/Zurich&autoReconnect=true&maxReconnects=10&allowPublicKeyRetrieval=true
+    username: root
+    password: root
+  liquibase:
+    contexts: seed-blog

application/src/main/resources/application.yml

@@ -0,0 +1,12 @@
+spring:
+  application:
+    name: blog
+  datasource:
+    driverClassName: org.mariadb.jdbc.Driver
+  jpa:
+    hibernate:
+      ddl-auto: validate
+  liquibase:
+    contexts: no-seed-blog
+server:
+  port: 8090

build.gradle.kts

@@ -0,0 +1,94 @@
+plugins {
+    jacoco
+    id("application")
+    java
+    id("org.springframework.boot") version "3.2.3" apply false
+    id("io.spring.dependency-management") version "1.1.4"
+    id("org.sonarqube") version "5.0.0.4638"
+}
+
+group = "com.qa.blog"
+version = "1.0.0"
+description = "Kata"
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_21
+}
+
+repositories {
+    mavenCentral()
+}
+
+tasks.register<JacocoReport>("codeCoverageReport") {
+    group = "Coverage"
+    description = "Coverage report aggregation"
+    // If a subproject applies the 'jacoco' plugin, add the result it to the report
+    subprojects {
+        val subproject = this
+        subproject.plugins.withType<JacocoPlugin>().configureEach {
+            subproject.tasks.matching({ it.extensions.findByType<JacocoTaskExtension>() != null }).configureEach {
+                val testTask = this
+                sourceSets(subproject.sourceSets.main.get())
+                executionData(testTask)
+            }
+
+            // To automatically run `test` every time `./gradlew codeCoverageReport` is called,
+            // you may want to set up a task dependency between them as shown below.
+            // Note that this requires the `test` tasks to be resolved eagerly (see `forEach`) which
+            // may have a negative effect on the configuration time of your build.
+            subproject.tasks.matching({ it.extensions.findByType<JacocoTaskExtension>() != null }).forEach {
+                rootProject.tasks["codeCoverageReport"].dependsOn(it)
+            }
+        }
+    }
+
+    // enable the different report types (html, xml, csv)
+    reports {
+        // xml is usually used to integrate code coverage with
+        // other tools like SonarQube, Coveralls or Codecov
+        xml.required = true
+
+        // HTML reports can be used to see code coverage
+        // without any external tools
+        html.required = true
+    }
+}
+
+subprojects {
+    repositories {
+        mavenCentral()
+    }
+
+    apply {
+        plugin("jacoco")
+        plugin("application")
+        plugin("java")
+
+        plugin("io.spring.dependency-management")
+    }
+
+    dependencyManagement {
+        imports {
+            mavenBom("org.springframework.boot:spring-boot-dependencies:3.2.3")
+        }
+    }
+
+    tasks.withType<Test> {
+        useJUnitPlatform()
+    }
+}
+
+tasks.check {
+    dependsOn(tasks.named<JacocoReport>("codeCoverageReport"))
+}
+
+sonar {
+    properties {
+        property("sonar.projectKey", "blog")
+        property("sonar.projectName", "Blog")
+        property("sonar.exclusions", "**/BlogApplication.java,**/ApplicationConfig.java,**/build.gradle.kts")
+        property("sonar.coverage.exclusions", "**/ApplicationConfig.java,**/BlogApplication.java,**/build.gradle.kts")
+        property("sonar.coverage.jacoco.xmlReportPaths", "${project.projectDir}/build/reports/jacoco/codeCoverageReport/codeCoverageReport.xml")
+        property ("sonar.gradle.skipCompile", "true")
+    }
+}

core/build.gradle.kts

@@ -0,0 +1,5 @@
+dependencies {
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.10.2")
+    testImplementation("org.junit.jupiter:junit-jupiter-engine:5.10.2")
+    testImplementation("org.mockito:mockito-junit-jupiter:5.11.0")
+}

gradle/libs.versions.toml

@@ -0,0 +1,2 @@
+# This file was generated by the Gradle 'init' task.
+# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format

gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists