Add k8s-operator unit tests to PR CI (#27387)

pmbrull · claude · web-flow · commit 1dedc0cf15b1 · 2026-04-15T15:48:18.000+02:00
* Add k8s-operator unit tests to PR CI pipeline

The k8s operator tests only ran during manual release builds.
Add a path-filtered job so they run on PRs touching
openmetadata-k8s-operator/**, following the same Detect Changes
pattern used by the service unit tests.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* Remove -DfailIfNoTests=false — we want to catch missing tests

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* Fix k8s-operator tests: add surefire includes and remove unnecessary stub

Parent POM surefire includes only match org.openmetadata.service.*,
so operator tests under org.openmetadata.operator.* were silently
skipped. Override with **/*Test.java in the operator pom.xml.

Also remove unused KubernetesClient mock stub from
CronOMJobReconcilerTest.setUp — no test reaches the code path
that calls context.getClient(), causing UnnecessaryStubbingException.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* Rename k8s-operator to k8s_operator in workflow outputs

Hyphens in output names are parsed as subtraction in GitHub Actions
expressions dot notation, so the job condition would never trigger.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* Fix filesystem paths — underscore rename only applies to output keys

The replace_all incorrectly changed directory names from
openmetadata-k8s-operator to openmetadata-k8s_operator. Only the
GitHub Actions output key needs the underscore; all file paths must
use the actual hyphenated directory name.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* Drop -am flag from k8s-operator test command

openmetadata-service is a provided-scope dependency, so -am tries
to compile it including shaded ES/OS jars that aren't available in
a clean CI environment. The operator module compiles fine on its own.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* Fix invalid YAML in conf/openmetadata.yaml

The CSP policy line has unescaped colons inside the value which the
YAML parser interprets as mapping indicators. Use a folded block
scalar (&gt;-) so the value is parsed as a plain string.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* Build k8s-operator deps before running tests

The operator depends on openmetadata-service (provided scope) which
won't be in the Maven cache on a cold CI runner. Build with -am
-DskipTests first, then run operator tests separately — same pattern
as docker-k8s-operator.yml.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* Reintroduce lenient client mock to prevent flaky NPE

The reconcile flow is time-dependent — tests using "0 * * * *" can
reach context.getClient() near the top of the hour. Stub the full
client.resources().inNamespace().resource().create() chain as lenient
so early-return tests aren't penalized but happy-path tests won't NPE.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

* Revert conf/openmetadata.yaml — fix belongs in a separate PR

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

---------

Co-authored-by: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/.github/workflows/openmetadata-service-unit-tests.yml b/.github/workflows/openmetadata-service-unit-tests.yml
@@ -39,6 +39,7 @@ jobs:
     if: ${{ github.event_name != 'pull_request' || !github.event.pull_request.draft }}
     outputs:
       java: ${{ github.event_name == 'workflow_dispatch' && 'true' || steps.filter.outputs.java }}
+      k8s_operator: ${{ github.event_name == 'workflow_dispatch' && 'true' || steps.filter.outputs.k8s_operator }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -59,6 +60,8 @@ jobs:
               - 'pom.xml'
               - 'Makefile'
               - 'bootstrap/**'
+            k8s_operator:
+              - 'openmetadata-k8s-operator/**'
 
   openmetadata-service-unit-tests:
     runs-on: ubuntu-latest
@@ -121,13 +124,62 @@ jobs:
           report_paths: "openmetadata-service/target/surefire-reports/TEST-*.xml"
           check_name: "Test Report (${{ matrix.database }})"
 
+  k8s_operator-unit-tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs: changes
+    if: ${{ needs.changes.outputs.k8s_operator == 'true' }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
+
+      - name: Cache Maven dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: "21"
+          distribution: "temurin"
+
+      - name: Build k8s-operator dependencies
+        run: |
+          mvn -B clean install -pl openmetadata-k8s-operator -am -DskipTests
+
+      - name: Run k8s-operator unit tests
+        run: |
+          mvn -B test -pl openmetadata-k8s-operator
+
+      - name: Upload surefire reports
+        if: ${{ failure() && hashFiles('openmetadata-k8s-operator/target/surefire-reports/TEST-*.xml') != '' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: k8s-operator-surefire-reports
+          path: openmetadata-k8s-operator/target/surefire-reports/
+
+      - name: Publish Test Report
+        if: ${{ always() && (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository) && hashFiles('openmetadata-k8s-operator/target/surefire-reports/TEST-*.xml') != '' }}
+        uses: scacap/action-surefire-report@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          fail_on_test_failures: true
+          report_paths: "openmetadata-k8s-operator/target/surefire-reports/TEST-*.xml"
+          check_name: "K8s Operator Test Report"
+
   # Single required-check gate for branch protection.
   # Skipped (= "Success") when all test jobs pass or are legitimately skipped.
   # Runs and exits 1 only when a test job fails or is cancelled.
   # Set "OpenMetadata Service Unit Tests / openmetadata-service-unit-tests-status" as the sole required check for this workflow.
   openmetadata-service-unit-tests-status:
     name: openmetadata-service-unit-tests-status
-    needs: [changes, openmetadata-service-unit-tests]
+    needs: [changes, openmetadata-service-unit-tests, k8s_operator-unit-tests]
     if: ${{ failure() || cancelled() }}
     runs-on: ubuntu-latest
     steps:
diff --git a/openmetadata-k8s-operator/pom.xml b/openmetadata-k8s-operator/pom.xml
@@ -187,6 +187,11 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>3.2.5</version>
+                <configuration>
+                    <includes>
+                        <include>**/*Test.java</include>
+                    </includes>
+                </configuration>
             </plugin>
             
             <!-- Failsafe plugin for integration tests -->
diff --git a/openmetadata-k8s-operator/src/test/java/org/openmetadata/operator/unit/CronOMJobReconcilerTest.java b/openmetadata-k8s-operator/src/test/java/org/openmetadata/operator/unit/CronOMJobReconcilerTest.java
@@ -18,6 +18,9 @@
 
 import io.fabric8.kubernetes.api.model.ObjectMeta;
 import io.fabric8.kubernetes.client.KubernetesClient;
+import io.fabric8.kubernetes.client.dsl.MixedOperation;
+import io.fabric8.kubernetes.client.dsl.NamespaceableResource;
+import io.fabric8.kubernetes.client.dsl.Resource;
 import io.javaoperatorsdk.operator.api.reconciler.Context;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 import java.time.Instant;
@@ -38,15 +41,27 @@ class CronOMJobReconcilerTest {
 
   @Mock private Context<CronOMJobResource> context;
   @Mock private KubernetesClient client;
+  @Mock private MixedOperation mixedOp;
+  @Mock private NamespaceableResource namespaceable;
+  @Mock private Resource resource;
 
   private CronOMJobReconciler reconciler;
   private CronOMJobResource cronOMJob;
 
+  @SuppressWarnings("unchecked")
   @BeforeEach
   void setUp() {
     reconciler = new CronOMJobReconciler();
     cronOMJob = createTestCronOMJob("test-cronjob", "0 * * * *");
-    when(context.getClient()).thenReturn(client);
+
+    // Stub the client chain so tests that reach the happy path
+    // (time-dependent) don't NPE. Lenient because most tests
+    // return early before calling context.getClient().
+    lenient().when(context.getClient()).thenReturn(client);
+    lenient().when(client.resources(any(Class.class))).thenReturn(mixedOp);
+    lenient().when(mixedOp.inNamespace(any())).thenReturn(mixedOp);
+    lenient().when(mixedOp.resource(any())).thenReturn(namespaceable);
+    lenient().when(namespaceable.create()).thenReturn(null);
   }
 
   @Test
