review

Author: adutra

.github/workflows/gradle.yml

@@ -215,7 +215,7 @@ jobs:
           ./gradlew \
             intTest \
             -x :polaris-runtime-service:intTest \
-            -x :polaris-helm:intTest \
+            -x :polaris-helm:check \
             --continue
         env:
           DEVELOCITY_ACCESS_KEY: ${{ secrets.DEVELOCITY_ACCESS_KEY }}

CONTRIBUTING.md

@@ -133,7 +133,11 @@ These tools are required for basic building and testing:
   * [SDKMAN!](https://sdkman.io/) - Run `sdk list java` to see available distributions, then `sdk install java <identifier>` to install.
   * [jEnv](https://www.jenv.be/) - You can also use jEnv to manage Java versions.
 
-* **Docker**: Required for integration tests and building container images.
+* **Container Runtime**: A container runtime like [Docker] or [Podman] is required for integration tests, regression tests 
+  and building container images.
+
+[Docker]: https://www.docker.com/
+[Podman]: https://podman.io/
 
 ### Helm Chart Testing Requirements
 

helm/polaris/README.md

@@ -28,7 +28,7 @@ weight: 675
   Do not modify the README.md file directly, please modify README.md.gotmpl instead.
   To re-generate the README.md file, install helm-docs then run from the repo root:
   helm-docs --chart-search-root=helm
-  Alternatively, run ./gradlew helmDocs from the repo root.
+  Alternatively, run `./gradlew helmDocs` or `make helm-doc-generate` from the repo root.
 -->
 
 ![Version: 1.2.0-incubating-SNAPSHOT](https://img.shields.io/badge/Version-1.2.0--incubating--SNAPSHOT-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.2.0-incubating-SNAPSHOT](https://img.shields.io/badge/AppVersion-1.2.0--incubating--SNAPSHOT-informational?style=flat-square)
@@ -142,7 +142,13 @@ The following tools are required to run the tests:
 * [Helm Unit Test](https://github.com/helm-unittest/helm-unittest)
 * [Chart Testing](https://github.com/helm/chart-testing)
 
-Quick installation of all required tools on macOS:
+Quick installation instructions for these tools:
+```bash
+helm plugin install https://github.com/helm-unittest/helm-unittest.git
+brew install chart-testing
+```
+
+Alternatively, on macOS, you can also run the following make targets:
 
 ```bash
 make install-dependencies-brew
@@ -183,7 +189,7 @@ Integration tests are run with the Chart Testing tool:
 ct install --namespace polaris --charts ./helm/polaris
 ```
 
-### Running tets with Gradle
+### Running tests with Gradle
 
 Both unit and integration tests can be run with Gradle. From the Polaris repo root:
 

helm/polaris/README.md.gotmpl

@@ -28,7 +28,7 @@ weight: 675
   Do not modify the README.md file directly, please modify README.md.gotmpl instead.
   To re-generate the README.md file, install helm-docs then run from the repo root:
   helm-docs --chart-search-root=helm
-  Alternatively, run ./gradlew helmDocs from the repo root.
+  Alternatively, run `./gradlew helmDocs` or `make helm-doc-generate` from the repo root.
 -->
 
 {{ template "chart.deprecationWarning" . }}
@@ -144,7 +144,13 @@ The following tools are required to run the tests:
 * [Helm Unit Test](https://github.com/helm-unittest/helm-unittest)
 * [Chart Testing](https://github.com/helm/chart-testing)
 
-Quick installation of all required tools on macOS:
+Quick installation instructions for these tools:
+```bash
+helm plugin install https://github.com/helm-unittest/helm-unittest.git
+brew install chart-testing
+```
+
+Alternatively, on macOS, you can also run the following make targets:
 
 ```bash
 make install-dependencies-brew
@@ -185,7 +191,7 @@ Integration tests are run with the Chart Testing tool:
 ct install --namespace polaris --charts ./helm/polaris
 ```
 
-### Running tets with Gradle
+### Running tests with Gradle
 
 Both unit and integration tests can be run with Gradle. From the Polaris repo root:
 

helm/polaris/build.gradle.kts

@@ -24,92 +24,114 @@ plugins {
 
 description = "Apache Polaris (incubating) Helm Chart"
 
+val runtimeServerDistribution by
+  configurations.creating {
+    isCanBeConsumed = false
+    isCanBeResolved = true
+  }
+
+dependencies { runtimeServerDistribution(project(":polaris-server", "distributionElements")) }
+
 val helmTestReportsDir = layout.buildDirectory.dir("reports")
 
 val helmTemplateValidation by
   tasks.registering(Exec::class) {
     group = "verification"
     description = "Run 'helm template' validation with all values files"
 
-    workingDir = projectDir
+    val outputFile = helmTestReportsDir.get().file("helm-template/validation.log").asFile
 
-    val outputFile = helmTestReportsDir.get().file("helm-template/validation.log")
+    doFirst {
+      outputFile.parentFile.mkdirs()
+      val outStream = outputFile.outputStream()
+      standardOutput = outStream
+      errorOutput = outStream
+    }
 
     commandLine =
       listOf(
         "sh",
         "-c",
         """
-    mkdir -p ${outputFile.asFile.parent}
-    for f in values.yaml ci/*.yaml; do
-      echo "Validating helm template with ${'$'}f"
-      helm template --debug --namespace polaris-ns --values ${'$'}f .
-    done > ${outputFile.asFile} 2>&1
-  """
+          for f in values.yaml ci/*.yaml; do
+            echo "Validating helm template with ${'$'}f"
+            helm template --debug --namespace polaris-ns --values ${'$'}f .
+          done
+        """
           .trimIndent(),
       )
 
     inputs.files(
       fileTree(projectDir) { include("Chart.yaml", "values.yaml", "ci/*.yaml", "templates/**/*") }
     )
 
-    outputs.file(outputFile)
+    outputs.cacheIf { true }
   }
 
 val helmUnitTest by
   tasks.registering(Exec::class) {
     group = "verification"
     description = "Run Helm unit tests"
 
-    workingDir = projectDir
+    val outputFile = helmTestReportsDir.get().file("helm-unit/test.log").asFile
 
-    val outputFile = helmTestReportsDir.get().file("helm-unit/test.log")
+    doFirst {
+      outputFile.parentFile.mkdirs()
+      val outStream = outputFile.outputStream()
+      standardOutput = outStream
+      errorOutput = outStream
+    }
 
-    // Install the plugin if not already installed, then run tests
     commandLine =
       listOf(
         "sh",
         "-c",
         """
-    mkdir -p ${outputFile.asFile.parent}
-    helm plugin install https://github.com/helm-unittest/helm-unittest.git 2>/dev/null || true
-    helm unittest . > ${outputFile.asFile} 2>&1
-  """
+          echo "====== Install helm-unittest plugin ======"
+          helm plugin install https://github.com/helm-unittest/helm-unittest.git || true
+
+          echo "====== Run helm unit tests ======"
+          helm unittest .
+        """
           .trimIndent(),
       )
 
     inputs.files(
       fileTree(projectDir) { include("Chart.yaml", "values.yaml", "templates/**/*", "tests/**/*") }
     )
 
-    outputs.file(outputFile)
+    outputs.cacheIf { true }
   }
 
 val chartTestingLint by
   tasks.registering(Exec::class) {
     group = "verification"
     description = "Run chart-testing (lint)"
 
-    workingDir = rootProject.projectDir
+    val outputFile = helmTestReportsDir.get().file("ct/lint.log").asFile
 
-    val outputFile = helmTestReportsDir.get().file("ct/lint.log")
+    doFirst {
+      outputFile.parentFile.mkdirs()
+      val outStream = outputFile.outputStream()
+      standardOutput = outStream
+      errorOutput = outStream
+    }
 
     commandLine =
       listOf(
         "sh",
         "-c",
         """
-    mkdir -p ${outputFile.asFile.parent}
-    ct lint --debug --charts ./helm/polaris > ${outputFile.asFile} 2>&1
-  """
+          ct lint --debug --charts .
+        """
           .trimIndent(),
       )
 
     inputs.files(
       fileTree(projectDir) { include("Chart.yaml", "values.yaml", "ci/*.yaml", "templates/**/*") }
     )
 
-    outputs.file(outputFile)
+    outputs.cacheIf { true }
   }
 
 // Task to build Docker images in minikube's Docker environment
@@ -120,43 +142,49 @@ val buildMinikubeImages by
 
     workingDir = rootProject.projectDir
 
-    // Output: file containing SHA digest of built image
-    val outputFile = helmTestReportsDir.get().file("minikube-images.sha256")
+    val outputFile = helmTestReportsDir.get().file("minikube-images/build.log").asFile
+    val digestFile = helmTestReportsDir.get().file("minikube-images/build.sha256").asFile
+
+    doFirst {
+      outputFile.parentFile.mkdirs()
+      digestFile.parentFile.mkdirs()
+      val outStream = outputFile.outputStream()
+      standardOutput = outStream
+      errorOutput = outStream
+    }
 
     commandLine =
       listOf(
         "sh",
         "-c",
         """
-    # Check if minikube is running
+    echo "====== Check if minikube is running ======"
     if ! minikube status >/dev/null 2>&1; then
       echo "Minikube is not running. Starting minikube..."
       minikube start
     fi
 
-    # Set up docker environment and build images
+    echo "====== Set up docker environment and build images ======"
     eval $(minikube -p minikube docker-env)
 
-    # Build server image
+    echo "====== Build server image ======"
     docker build -t apache/polaris:latest \
       -f runtime/server/src/main/docker/Dockerfile.jvm \
       runtime/server
 
-    # Capture image digest
-    mkdir -p ${outputFile.asFile.parent}
     {
       docker inspect --format='{{.Id}}' apache/polaris:latest
-    } > ${outputFile.asFile}
+    } > ${digestFile.relativeTo(workingDir)}
   """
           .trimIndent(),
       )
 
     dependsOn(":polaris-server:quarkusBuild")
 
-    inputs.dir(rootProject.file("runtime/server/build/quarkus-app"))
-    inputs.file(rootProject.file("runtime/server/src/main/docker/Dockerfile.jvm"))
+    inputs.files(runtimeServerDistribution)
+    inputs.file(project(":polaris-server").projectDir.resolve("src/main/docker/Dockerfile.jvm"))
 
-    outputs.file(outputFile)
+    outputs.cacheIf { true }
   }
 
 // Task to run chart-testing install on minikube
@@ -165,62 +193,74 @@ val chartTestingInstall by
     group = "verification"
     description = "Run chart-testing (install) on minikube"
 
-    workingDir = rootProject.projectDir
+    val outputFile = helmTestReportsDir.get().file("ct/install.log").asFile
 
-    val outputFile = helmTestReportsDir.get().file("ct/install.log")
+    doFirst {
+      outputFile.parentFile.mkdirs()
+      val outStream = outputFile.outputStream()
+      standardOutput = outStream
+      errorOutput = outStream
+    }
 
     commandLine =
       listOf(
         "sh",
         "-c",
         """
-    mkdir -p ${outputFile.asFile.parent}
+          echo "====== Check if minikube is running ======"
+          if ! minikube status >/dev/null 2>&1; then
+            echo "Minikube is not running. Starting minikube..."
+            minikube start
+          fi
 
-    # Create namespace if it doesn't exist
-    kubectl create namespace polaris-ns --dry-run=client -o yaml | kubectl apply -f -
+          echo "====== Create namespace if it doesn't exist ======"
+          kubectl create namespace polaris-ns --dry-run=client -o yaml | kubectl apply -f -
 
-    # Install fixtures
-    kubectl apply --namespace polaris-ns -f helm/polaris/ci/fixtures
+          echo "===== Install fixtures ======"
+          kubectl apply --namespace polaris-ns -f helm/polaris/ci/fixtures
 
-    # Run chart-testing install
-    ct install \
-      --namespace polaris-ns \
-      --debug --charts ./helm/polaris > ${outputFile.asFile} 2>&1
-  """
+          echo "===== Run chart-testing install ======"
+          ct install --namespace polaris-ns --debug --charts .
+        """
           .trimIndent(),
       )
 
+    dependsOn(buildMinikubeImages)
+
     inputs.files(
       fileTree(projectDir) { include("Chart.yaml", "values.yaml", "ci/**/*", "templates/**/*") }
     )
 
-    outputs.file(outputFile)
-
-    // Depend on the images being built in minikube
-    dependsOn(buildMinikubeImages)
+    outputs.cacheIf { true }
   }
 
-// Task to generate helm documentation
 val helmDocs by
   tasks.registering(Exec::class) {
     group = "documentation"
     description = "Generate Helm chart documentation using helm-docs"
 
-    workingDir = rootProject.projectDir
+    val outputFile = helmTestReportsDir.get().file("helm-docs/build.log").asFile
+
+    doFirst {
+      outputFile.parentFile.mkdirs()
+      val outStream = outputFile.outputStream()
+      standardOutput = outStream
+      errorOutput = outStream
+    }
 
     commandLine =
       listOf(
         "sh",
         "-c",
         """
-          helm-docs --chart-search-root=helm
+          helm-docs --chart-search-root=.
         """
           .trimIndent(),
       )
 
     inputs.files(fileTree(projectDir) { include("Chart.yaml", "values.yaml", "README.md.gotmpl") })
 
-    outputs.file(projectDir.resolve("README.md"))
+    outputs.cacheIf { true }
   }
 
 val test by
@@ -235,11 +275,9 @@ val intTest by
     group = "verification"
     description = "Run Helm chart integration tests on minikube"
     dependsOn(chartTestingInstall)
+    mustRunAfter(test)
   }
 
-tasks.named("check") { dependsOn(test) }
+tasks.named("check") { dependsOn(test, intTest) }
 
-tasks.named("build") {
-  dependsOn(intTest)
-  dependsOn(helmDocs)
-}
+tasks.named("assemble") { dependsOn(helmDocs) }