Latest build conventions (#458)

creek-service · Jun 23, 2024 · 5b1a04c · 5b1a04c
1 parent ad7ed2b
commit 5b1a04c
Show file tree

Hide file tree

Showing 10 changed files with 41 additions and 19 deletions.
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -37,7 +37,11 @@ jobs:
         with:
           java-version: '17'
           distribution: 'adopt'
-          cache: gradle
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@a4cf152f482c7ca97ef56ead29bf08bcd953284c # v2.7.0
+        with:
+          gradle-home-cache-cleanup: true
 
       - name: Build
         run: ./gradlew test

diff --git a/.github/workflows/dependabot-auto-merge.yml b/.github/workflows/dependabot-auto-merge.yml
@@ -3,8 +3,7 @@
 name: Dependabot
 on:
   pull_request:
-    branches:
-      - main
+    branches: [ main ]
 
 permissions:
   contents: read

diff --git a/.github/workflows/test-scripts.yml b/.github/workflows/test-scripts.yml
@@ -23,7 +23,11 @@ jobs:
         with:
           java-version: '17'
           distribution: 'adopt'
-          cache: gradle
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@a4cf152f482c7ca97ef56ead29bf08bcd953284c # v2.7.0
+        with:
+          gradle-home-cache-cleanup: true
       - name: Run boostrap script
         shell: zsh {0}
         run: ./.creek/bootstrap.sh "some-User-name/a_Nother-REpo_name" "some-User-name"

diff --git a/.github/workflows/version.yml b/.github/workflows/version.yml
@@ -30,7 +30,11 @@ jobs:
         with:
           java-version: '17'
           distribution: 'adopt'
-          cache: gradle
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@a4cf152f482c7ca97ef56ead29bf08bcd953284c # v2.7.0
+        with:
+          gradle-home-cache-cleanup: true
       - name: Increment version
         if: contains(fromJson('["Major", "Minor", "Patch"]'), github.event.inputs.part)
         run: |

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -58,7 +58,6 @@ subprojects {
         set("junitVersion", "5.10.2")            // https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-api
         set("junitPioneerVersion", "2.2.0")     // https://mvnrepository.com/artifact/org.junit-pioneer/junit-pioneer
         set("mockitoVersion", "5.12.0")          // https://mvnrepository.com/artifact/org.mockito/mockito-junit-jupiter
-        set("hamcrestVersion", "2.2")           // https://mvnrepository.com/artifact/org.hamcrest/hamcrest-core
     }
 
     val creekVersion : String by extra
@@ -68,7 +67,6 @@ subprojects {
     val junitVersion: String by extra
     val junitPioneerVersion: String by extra
     val mockitoVersion: String by extra
-    val hamcrestVersion : String by extra
 
     dependencies {
         testImplementation("org.creekservice:creek-test-hamcrest:$creekVersion")
@@ -77,10 +75,8 @@ subprojects {
         testImplementation("org.junit.jupiter:junit-jupiter-params:$junitVersion")
         testImplementation("org.junit-pioneer:junit-pioneer:$junitPioneerVersion")
         testImplementation("org.mockito:mockito-junit-jupiter:$mockitoVersion")
-        testImplementation("org.hamcrest:hamcrest-core:$hamcrestVersion")
         testImplementation("com.google.guava:guava-testlib:$guavaVersion")
-        testImplementation("org.apache.logging.log4j:log4j-core:$log4jVersion")
-        testImplementation("org.apache.logging.log4j:log4j-slf4j2-impl:$log4jVersion")
+        testRuntimeOnly("org.apache.logging.log4j:log4j-slf4j2-impl:$log4jVersion")
         testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
     }
 

diff --git a/buildSrc/settings.gradle.kts b/buildSrc/settings.gradle.kts
@@ -14,3 +14,6 @@
  * limitations under the License.
  */
 
+plugins {
+    id("org.gradle.toolchains.foojay-resolver-convention") version "0.4.0"
+}
diff --git a/buildSrc/src/main/kotlin/common-convention.gradle.kts b/buildSrc/src/main/kotlin/common-convention.gradle.kts
@@ -48,6 +48,7 @@ repositories {
 
 dependencies {
     spotbugsPlugins("com.h3xstream.findsecbugs:findsecbugs-plugin:1.12.0")
+    checkstyle("com.puppycrawl.tools:checkstyle:10.17.0")
 }
 
 configurations.all {
@@ -61,9 +62,13 @@ tasks.withType<JavaCompile> {
 }
 
 tasks.test {
-    useJUnitPlatform()
-    setForkEvery(1)
-    maxParallelForks = 4
+    useJUnitPlatform() {
+        if (project.hasProperty("excludeContainerised")) {
+            excludeTags("ContainerisedTest")
+        }
+    }
+    setForkEvery(5)
+    maxParallelForks = Runtime.getRuntime().availableProcessors()
     testLogging {
         showStandardStreams = true
         exceptionFormat = org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL

diff --git a/buildSrc/src/main/kotlin/coverage-convention.gradle.kts b/buildSrc/src/main/kotlin/coverage-convention.gradle.kts
@@ -73,7 +73,7 @@ val coverage = tasks.register<JacocoReport>("coverage") {
 
 coveralls {
     sourceDirs = allprojects.flatMap{it.sourceSets.main.get().allSource.srcDirs}.map{it.toString()}
-    jacocoReportPath = "$buildDir/reports/jacoco/coverage/coverage.xml"
+    jacocoReportPath = layout.buildDirectory.file("reports/jacoco/coverage/coverage.xml")
 }
 
 tasks.coveralls {

diff --git a/example-service/Dockerfile b/example-service/Dockerfile
@@ -5,17 +5,14 @@ ENV VERSION=$APP_VERSION
 
 LABEL org.opencontainers.image.source=https://github.com/creek-service/aggregate-template/tree/main/example-service
 
-RUN yum update -y
-RUN yum install -y tar lsof
 
 RUN mkdir -p /opt/creek
 
 COPY bin /bin
 COPY log4j /log
 
-COPY ${APP_NAME}-${APP_VERSION}.tar /opt/creek
+COPY ${APP_NAME}-${APP_VERSION} /opt/creek/${APP_NAME}-${APP_VERSION}
 WORKDIR /opt/creek
-RUN tar xf ${APP_NAME}-${APP_VERSION}.tar
 RUN ln -s ${APP_NAME}-${APP_VERSION} service
 
 ENTRYPOINT ["/bin/run.sh"]
diff --git a/example-service/build.gradle.kts b/example-service/build.gradle.kts
@@ -49,6 +49,11 @@ val buildAppImage = tasks.register<DockerBuildImage>("buildAppImage") {
     buildArgs.put("APP_NAME", project.name)
     buildArgs.put("APP_VERSION", "${project.version}")
     images.add("ghcr.io/creek-service/${rootProject.name}-${project.name}:latest")
+
+    onlyIf {
+        // Exclude the task if running on Windows (as images don't build on Windows)
+        !System.getProperty("os.name").lowercase().contains("win")
+    }
     images.add("ghcr.io/creek-service/${rootProject.name}-${project.name}:${project.version}")
 }
 
@@ -57,7 +62,7 @@ tasks.register<Copy>("prepareDocker") {
 
     from(
         layout.projectDirectory.file("Dockerfile"),
-        layout.buildDirectory.file("distributions/${project.name}-${project.version}.tar"),
+        tarTree(layout.buildDirectory.file("distributions/${project.name}-${project.version}.tar")),
         layout.projectDirectory.dir("include"),
     )
 
@@ -67,6 +72,11 @@ tasks.register<Copy>("prepareDocker") {
 tasks.register<DockerPushImage>("pushAppImage") {
     dependsOn("buildAppImage")
     images.add("ghcr.io/creek-service/${rootProject.name}-${project.name}:latest")
+
+    onlyIf {
+        // Exclude the task if running on Windows (as images don't build on Windows)
+        !System.getProperty("os.name").lowercase().contains("win")
+    }
     images.add("ghcr.io/creek-service/${rootProject.name}-${project.name}:${project.version}")
 }