Use Harbor Proxy service on CI.

When run on CI servers, leverage an internal proxy service using Testcontainers ability to plugin a custom ImageNameSubstitor.

See #1518
Original Pull Request: #1516

Author: gregturn

.gitignore

@@ -11,3 +11,5 @@ target/
 
 #prevent license accepting file to get accidentially commited to git
 container-license-acceptance.txt
+spring-data-jdbc/src/test/java/org/springframework/data/ProxyImageNameSubstitutor.java
+spring-data-r2dbc/src/test/java/org/springframework/data/ProxyImageNameSubstitutor.java

Jenkinsfile

@@ -34,6 +34,7 @@ pipeline {
 			environment {
 				DOCKER_HUB = credentials("${p['docker.credentials']}")
 				ARTIFACTORY = credentials("${p['artifactory.credentials']}")
+				TESTCONTAINERS_IMAGE_SUBSTITUTOR = 'org.springframework.data.ProxyImageNameSubstitutor'
 			}
 
 			steps {
@@ -65,6 +66,7 @@ pipeline {
 					environment {
 						DOCKER_HUB = credentials("${p['docker.credentials']}")
 						ARTIFACTORY = credentials("${p['artifactory.credentials']}")
+						TESTCONTAINERS_IMAGE_SUBSTITUTOR = 'org.springframework.data.ProxyImageNameSubstitutor'
 					}
 
 					steps {

ci/accept-third-party-license.sh

@@ -3,4 +3,5 @@
 {
   echo "mcr.microsoft.com/mssql/server:2017-CU12"
   echo "ibmcom/db2:11.5.0.0a"
-} > spring-data-jdbc/src/test/resources/container-license-acceptance.txt
+  echo "harbor-repo.vmware.com/dockerhub-proxy-cache/ibmcom/db2:11.5.0.0a"
+} > spring-data-jdbc/src/test/resources/container-license-acceptance.txt

ci/test.sh

@@ -3,6 +3,11 @@
 set -euo pipefail
 
 ci/accept-third-party-license.sh
+
+echo "Copying ProxyImageNameSubstitutor into JDBC and R2DBC..."
+cp spring-data-relational/src/test/java/org/springframework/data/ProxyImageNameSubstitutor.java spring-data-jdbc/src/test/java/org/springframework/data
+cp spring-data-relational/src/test/java/org/springframework/data/ProxyImageNameSubstitutor.java spring-data-r2dbc/src/test/java/org/springframework/data
+
 mkdir -p /tmp/jenkins-home
 chown -R 1001:1001 .
 MAVEN_OPTS="-Duser.name=jenkins -Duser.home=/tmp/jenkins-home" \

spring-data-relational/pom.xml

@@ -84,6 +84,13 @@
 			<scope>test</scope>
 		</dependency>
 
+		<dependency>
+			<groupId>org.testcontainers</groupId>
+			<artifactId>testcontainers</artifactId>
+			<version>${testcontainers}</version>
+			<scope>test</scope>
+		</dependency>
+
 	</dependencies>
 
 </project>

spring-data-relational/src/test/java/org/springframework/data/ProxyImageNameSubstitutor.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data;
+
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.testcontainers.utility.DockerImageName;
+import org.testcontainers.utility.ImageNameSubstitutor;
+
+/**
+ * An {@link ImageNameSubstitutor} only used on CI servers to leverage internal proxy solution, that needs to vary the
+ * prefix based on which container image is needed.
+ * 
+ * @author Greg Turnquist
+ */
+public class ProxyImageNameSubstitutor extends ImageNameSubstitutor {
+
+	private static final Logger LOG = LoggerFactory.getLogger(ProxyImageNameSubstitutor.class);
+
+	private static final List<String> NAMES_TO_PROXY_PREFIX = List.of("ryuk", "arm64v8/mariadb", "ibmcom/db2",
+			"gvenzl/oracle-xe");
+
+	private static final List<String> NAMES_TO_LIBRARY_PROXY_PREFIX = List.of("mariadb", "mysql", "postgres");
+
+	private static final String PROXY_PREFIX = "harbor-repo.vmware.com/dockerhub-proxy-cache/";
+
+	private static final String LIBRARY_PROXY_PREFIX = PROXY_PREFIX + "library/";
+
+	@Override
+	public DockerImageName apply(DockerImageName dockerImageName) {
+
+		if (NAMES_TO_PROXY_PREFIX.stream().anyMatch(s -> dockerImageName.asCanonicalNameString().contains(s))) {
+
+			String transformedName = applyProxyPrefix(dockerImageName.asCanonicalNameString());
+			LOG.info("Converting " + dockerImageName.asCanonicalNameString() + " to " + transformedName);
+			return DockerImageName.parse(transformedName);
+		}
+
+		if (NAMES_TO_LIBRARY_PROXY_PREFIX.stream().anyMatch(s -> dockerImageName.asCanonicalNameString().contains(s))) {
+
+			String transformedName = applyProxyAndLibraryPrefix(dockerImageName.asCanonicalNameString());
+			LOG.info("Converting " + dockerImageName.asCanonicalNameString() + " to " + transformedName);
+			return DockerImageName.parse(transformedName);
+		}
+
+		LOG.info("Not changing " + dockerImageName.asCanonicalNameString() + "...");
+		return dockerImageName;
+	}
+
+	@Override
+	protected String getDescription() {
+		return "Spring Data Proxy Image Name Substitutor";
+	}
+
+	/**
+	 * Apply a non-library-based prefix.
+	 */
+	private static String applyProxyPrefix(String imageName) {
+		return PROXY_PREFIX + imageName;
+	}
+
+	/**
+	 * Apply a library based prefix.
+	 */
+	private static String applyProxyAndLibraryPrefix(String imageName) {
+		return LIBRARY_PROXY_PREFIX + imageName;
+	}
+}