feat: enhance image handling and add tests for getShortImage method (#9)

* feat: enhance image handling and add tests for getShortImage method

* chore: update changelog for version 0.10.0 and adjust README and gradle.properties for new version

* fix: update test

Author: next-govejero

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.10.0
+
+- Enhanced image display to show full paths after registry domain (e.g., ECR URLs).
+- Improved test coverage for image URL parsing functionality.
+
 ## 0.9.0
 
 - Added support for multiple namespaces.
@@ -19,7 +24,7 @@
 ## 0.5.0
 
 - Added application cache.
-- Upgraded Quarkus to 3.2.x. 
+- Upgraded Quarkus to 3.2.x.
 
 ## 0.4.0
 

README.md

@@ -13,14 +13,14 @@ Note: currently, Heimdall only supports Flink jobs deployed with [Flink Kubernet
 
 ```bash
 kubectl apply -f https://raw.githubusercontent.com/sap1ens/heimdall/main/tools/k8s-operator/service-account.yaml
-kubectl run heimdall --image=ghcr.io/sap1ens/heimdall:0.9.0 --port=8080 --overrides='{ "spec": { "serviceAccount": "heimdall-service-account" }  }'
+kubectl run heimdall --image=ghcr.io/sap1ens/heimdall:0.10.0 --port=8080 --overrides='{ "spec": { "serviceAccount": "heimdall-service-account" }  }'
 kubectl port-forward heimdall 8080:8080
 open http://localhost:8080
 ```
 
 ## Installation
 
-Heimdall is available as a Docker container [here](https://github.com/sap1ens/heimdall/pkgs/container/heimdall). Since only 
+Heimdall is available as a Docker container [here](https://github.com/sap1ens/heimdall/pkgs/container/heimdall). Since only
 Flink Kubernetes Operator as available at the moment you'd typically deploy Heimdall as a pod or deployment in the same cluster.
 
 Heimdall uses port 8080 and exposes liveness and readiness endpoints at `/q/health/live` and `/q/health/ready`.
@@ -31,7 +31,7 @@ Job locator (implements `FlinkJobLocator` interface) is a mechanism for discover
 
 ### K8sOperatorFlinkJobLocator
 
-Can be enabled with `heimdall.joblocator.k8s-operator.enabled` config. Currently, enabled by default. It loads 
+Can be enabled with `heimdall.joblocator.k8s-operator.enabled` config. Currently, enabled by default. It loads
 `flinkdeployment` custom resource (CR) created by the Flink Kubernetes Operator.
 
 A service account with read-only access to `flinkdeployment` CR is required. See [tools/k8s-operator/service-account.yaml](tools/k8s-operator/service-account.yaml) for an example.

gradle.properties

@@ -5,4 +5,4 @@ quarkusPlatformArtifactId=quarkus-bom
 quarkusPluginId=io.quarkus
 quarkusPlatformGroupId=io.quarkus.platform
 quarkusPlatformVersion=3.2.11.Final
-version=0.9.0-SNAPSHOT
+version=0.10.0-SNAPSHOT

src/main/java/com/sap1ens/heimdall/service/K8sOperatorFlinkJobLocator.java

@@ -82,7 +82,7 @@ protected FlinkJobType getJobType(FlinkDeployment flinkDeployment) {
 
   protected String getShortImage(FlinkDeployment flinkDeployment) {
     var image = flinkDeployment.getSpec().getImage();
-    return image.contains("/") ? flinkDeployment.getSpec().getImage().split("/")[1] : image;
+    return image.contains("/") ? image.substring(image.indexOf("/") + 1) : image;
   }
 
   protected int getParallelism(FlinkDeployment flinkDeployment) {

src/main/webui/src/lib/FlinkJobs.svelte

@@ -80,6 +80,11 @@
     }
 
     function displayName(flinkJob) {
+        // Fallback to just the job name if displayNamePattern is not loaded yet
+        if (!displayNamePattern) {
+            return flinkJob.name;
+        }
+
         let name = displayNamePattern.replace('$jobName', flinkJob.name);
         if (Object.keys(flinkJob.metadata).length > 0) {
             for (const [key, value] of Object.entries(flinkJob.metadata)) {

src/test/java/com/sap1ens/heimdall/service/K8sOperatorFlinkJobLocatorTest.java

@@ -91,6 +91,29 @@ public void testFindAllMultipleNamespaces() {
     assertEquals(3, flinkJobs.size());
   }
 
+  @Test
+  public void testGetShortImage() {
+    // Test ECR-style image URL
+    var ecrDeployment = generateFlinkDeploymentWithImage("000333555999.dkr.ecr.eu-west-1.amazonaws.com/servicing/team/test:0.1.4");
+    assertEquals("servicing/team/test:0.1.4", flinkJobLocator.getShortImage(ecrDeployment));
+
+    // Test Docker Hub style
+    var dockerHubDeployment = generateFlinkDeploymentWithImage("docker.io/flink:1.15");
+    assertEquals("flink:1.15", flinkJobLocator.getShortImage(dockerHubDeployment));
+
+    // Test simple registry
+    var simpleRegistryDeployment = generateFlinkDeploymentWithImage("registry.com/image:tag");
+    assertEquals("image:tag", flinkJobLocator.getShortImage(simpleRegistryDeployment));
+
+    // Test image without slash
+    var simpleImageDeployment = generateFlinkDeploymentWithImage("flink:latest");
+    assertEquals("flink:latest", flinkJobLocator.getShortImage(simpleImageDeployment));
+
+    // Test complex multi-level paths
+    var complexDeployment = generateFlinkDeploymentWithImage("gcr.io/project/namespace/app:v1");
+    assertEquals("project/namespace/app:v1", flinkJobLocator.getShortImage(complexDeployment));
+  }
+
   private List<FlinkDeployment> generateFlinkDeployments(int num) {
     var flinkDeployments = new ArrayList<FlinkDeployment>();
     for (int i = 0; i < num; i++) {
@@ -100,6 +123,10 @@ private List<FlinkDeployment> generateFlinkDeployments(int num) {
   }
 
   private FlinkDeployment generateFlinkDeployment() {
+    return generateFlinkDeploymentWithImage("test-image");
+  }
+
+  private FlinkDeployment generateFlinkDeploymentWithImage(String image) {
     var flinkDeployment = new FlinkDeployment();
     flinkDeployment.setMetadata(
         new ObjectMetaBuilder()
@@ -111,7 +138,7 @@ private FlinkDeployment generateFlinkDeployment() {
     var jobSpec = new JobSpec();
     jobSpec.setParallelism(4);
     var spec = new FlinkDeploymentSpec();
-    spec.setImage("test-image");
+    spec.setImage(image);
     spec.setFlinkVersion(FlinkVersion.v1_15);
     spec.setJob(jobSpec);
     var resource = new Resource();