fix: parsing docker image when the full image name contains registry port (#13990)

Co-authored-by: Oleg Gusak <[email protected]>
Co-authored-by: Jonathan Pearlin <[email protected]>

Author: 3 people

airbyte-commons-with-dependencies/src/main/java/io/airbyte/commons/helper/DockerImageNameHelper.java

@@ -26,7 +26,8 @@ public class DockerImageNameHelper {
   /**
    * Docker image names are by convention separated by slashes. The last portion is the image's name.
    * This is followed by a colon and a version number. e.g. airbyte/scheduler:v1 or
-   * gcr.io/my-project/my-project:v2.
+   * gcr.io/my-project/image-name:v2. Registry name may also include port number, e.g.
+   * registry.internal:1234/my-project/image-name:v2
    *
    * @param fullImagePath the image name with repository and version ex
    *        gcr.io/my-project/image-name:v2
@@ -43,7 +44,7 @@ public static String extractShortImageName(final String fullImagePath) {
    * Extracts the image name without the version tag.
    *
    * @param fullImagePath the docker image name
-   * @return anything before ":"
+   * @return anything before last ":"
    */
   public static String extractImageNameWithoutVersion(final String fullImagePath) {
     return extractPartFromFullPath(fullImagePath, NAME_PARTS_INDEX);
@@ -53,7 +54,7 @@ public static String extractImageNameWithoutVersion(final String fullImagePath)
    * Extracts the image version label as a string.
    *
    * @param fullImagePath the docker image name
-   * @return anything after ":"
+   * @return anything after last ":"
    */
   public static String extractImageVersionString(final String fullImagePath) {
     return extractPartFromFullPath(fullImagePath, VERSION_PART_INDEX);
@@ -78,8 +79,15 @@ public static Optional<Version> extractImageVersion(final String fullImagePath)
   }
 
   private static String extractPartFromFullPath(final String fullImagePath, final int partIndex) {
-    final String[] parts = fullImagePath.split(VERSION_DELIMITER);
-    return parts.length > partIndex ? parts[partIndex] : null;
+    final int delimeterIndex = fullImagePath.lastIndexOf(VERSION_DELIMITER);
+    if (partIndex == NAME_PARTS_INDEX) {
+      return delimeterIndex >= 0 ? fullImagePath.substring(0, delimeterIndex) : fullImagePath;
+    } else if (partIndex == VERSION_PART_INDEX) {
+      return delimeterIndex >= 0 ? fullImagePath.substring(delimeterIndex + 1) : null;
+    } else {
+      LOGGER.warn("Invalid part index: {}", partIndex);
+      return null;
+    }
   }
 
 }

airbyte-commons-with-dependencies/src/test/java/io/airbyte/commons/helper/DockerImageNameHelperTest.java

@@ -20,21 +20,22 @@
 class DockerImageNameHelperTest {
 
   @ParameterizedTest
-  @CsvSource({"hello:1,hello", "hello/world:2,world", "foo/bar/fizz/buzz:3,buzz", "hello,hello"})
+  @CsvSource({"hello:1,hello", "hello/world:2,world", "foo/bar/fizz/buzz:3,buzz", "hello,hello", "registry.internal:1234/foo/bar:1,bar"})
   void testExtractShortImageName(final String fullName, final String expected) {
     final var actual = DockerImageNameHelper.extractShortImageName(fullName);
     Assertions.assertEquals(expected, actual);
   }
 
   @ParameterizedTest
-  @CsvSource({"hello:1,hello", "hello/world:2,hello/world", "foo/bar/fizz/buzz:3,foo/bar/fizz/buzz", "hello,hello", "hello:1.1-foo,hello"})
+  @CsvSource({"hello:1,hello", "hello/world:2,hello/world", "foo/bar/fizz/buzz:3,foo/bar/fizz/buzz", "hello,hello", "hello:1.1-foo,hello",
+    "registry.internal:1234/foo/bar:1,registry.internal:1234/foo/bar"})
   void testExtractImageNameWithoutVersion(final String fullName, final String expected) {
     final var actual = DockerImageNameHelper.extractImageNameWithoutVersion(fullName);
     Assertions.assertEquals(expected, actual);
   }
 
   @ParameterizedTest
-  @CsvSource({"hello:1,1", "hello/world:2,2", "foo/bar/fizz/buzz:3,3", "hello,", "hello:1.1-foo,1.1-foo"})
+  @CsvSource({"hello:1,1", "hello/world:2,2", "foo/bar/fizz/buzz:3,3", "hello,", "hello:1.1-foo,1.1-foo", "registry.internal:1234/foo/bar:1,1"})
   void testExtractImageVersionString(final String fullName, final String expected) {
     final var actual = DockerImageNameHelper.extractImageVersionString(fullName);
     Assertions.assertEquals(expected, actual);
@@ -49,7 +50,8 @@ public Stream<? extends Arguments> provideArguments(final ExtensionContext conte
           Arguments.of("hello:1", null),
           Arguments.of("hello:dev", new Version("dev")),
           Arguments.of("hello", null),
-          Arguments.of("hello/foo/bar:1.2.3", new Version("1.2.3")));
+          Arguments.of("hello/foo/bar:1.2.3", new Version("1.2.3")),
+          Arguments.of("registry.internal:1234/foo/bar:1.0.0", new Version("1.0.0")));
     }
 
   }

airbyte-commons-worker/src/main/java/io/airbyte/workers/helper/ConnectorApmSupportHelper.java

@@ -67,31 +67,39 @@ Map<String, String> getEnv() {
 
   /**
    * Extracts the image name from the provided image string, if the image string uses the following
-   * format: {@code <image name>:<image version>}.
+   * format: {@code <image name>:<image version>}. Image name may include registry and port number,
+   * which is also delimited by ":"
    *
    * @param image The image.
    * @return The name extracted from the image, or the originally provided string if blank.
    */
   public static String getImageName(final String image) {
     if (StringUtils.isNotEmpty(image)) {
-      return image.split(IMAGE_DELIMITER)[0];
+      final int delimeterIndex = image.lastIndexOf(IMAGE_DELIMITER);
+      if (delimeterIndex >= 0) {
+        return image.substring(0, delimeterIndex);
+      }
     }
-
+    // If image is null, empty, or does not contain a delimiter, return the original string.
     return image;
   }
 
   /**
    * Extracts the image version from the provided image string, if the image string uses the following
-   * format: {@code <image name>:<image version>}.
+   * format: {@code <image name>:<image version>}. Image name may include registry and port number,
+   * which is also delimited by ":"
    *
    * @param image The image.
    * @return The version extracted from the image, or the originally provided string if blank.
    */
   public static String getImageVersion(final String image) {
     if (StringUtils.isNotEmpty(image)) {
-      return image.split(IMAGE_DELIMITER)[1];
+      final int delimeterIndex = image.lastIndexOf(IMAGE_DELIMITER);
+      if (delimeterIndex >= 0 && image.length() > delimeterIndex + 1) {
+        return image.substring(delimeterIndex + 1);
+      }
     }
-
+    // If image is null, empty, or does not contain a delimiter, return the original string.
     return image;
   }
 

airbyte-commons-worker/src/main/java/io/airbyte/workers/pod/PodUtils.java

@@ -61,7 +61,7 @@ static String createProcessName(final String fullImagePath, final String jobType
    * Extract the shortname of the image from the full path.
    */
   static String getShortImageName(final String fullImagePath) {
-    if (fullImagePath == null || fullImagePath.length() < 1) {
+    if (fullImagePath == null || fullImagePath.isEmpty()) {
       return null;
     }
     return DockerImageNameHelper.extractShortImageName(fullImagePath);
@@ -70,15 +70,17 @@ static String getShortImageName(final String fullImagePath) {
   /**
    * Docker image names are by convention separated by slashes. The last portion is the image's name.
    * This is followed by a colon and a version number. e.g. airbyte/scheduler:v1 or
-   * gcr.io/my-project/image-name:v2.
-   * <p>
+   * gcr.io/my-project/image-name:v2. Registry name may also include port number, e.g.
+   * registry.internal:1234/my-project/image-name:v2
+   * <p />
    * Get the image version by returning the substring following a colon.
    */
   static String getImageVersion(final String fullImagePath) {
-    if (fullImagePath == null || fullImagePath.length() < 1) {
+    if (fullImagePath == null || fullImagePath.isEmpty()) {
       return null;
     }
-    int colonIndex = fullImagePath.indexOf(":");
+    // Use the last colon to find the image tag
+    int colonIndex = fullImagePath.lastIndexOf(":");
     if (colonIndex != -1 && fullImagePath.length() > colonIndex + 1) {
       return fullImagePath.substring(colonIndex + 1);
     }

airbyte-commons-worker/src/test/java/io/airbyte/workers/helper/ConnectorApmSupportHelperTest.java

@@ -23,6 +23,9 @@ class ConnectorApmSupportHelperTest {
   private static final String CONNECTOR_NAME = "postgres";
   private static final String CONNECTOR_VERSION = "2.0.5";
   private static final String IMAGE = "postgres:2.0.5";
+  private static final String REGISTRY_NAME = "registry.internal:1234";
+  private static final String REPOSITORY_ORG = "airbyte";
+  private static final String IMAGE_WITH_PORT = String.join("/", REGISTRY_NAME, REPOSITORY_ORG, IMAGE);
   private ConnectorApmSupportHelper supportHelper;
 
   @BeforeEach
@@ -39,6 +42,15 @@ void testExtractAirbyteVersionFromImageName() {
     assertEquals(CONNECTOR_VERSION, imageVersion);
   }
 
+  @Test
+  void testExtractAirbyteVersionFromImageNameWithRegistryPort() {
+    final String imageName = ConnectorApmSupportHelper.getImageName(IMAGE_WITH_PORT);
+    final String imageVersion = ConnectorApmSupportHelper.getImageVersion(IMAGE_WITH_PORT);
+
+    assertEquals(String.join("/", REGISTRY_NAME, REPOSITORY_ORG, CONNECTOR_NAME), imageName);
+    assertEquals(CONNECTOR_VERSION, imageVersion);
+  }
+
   @Test
   void testExtractAirbyteVersionFromBlankImageName() {
     final String blankString = "";