feat(build): add clouddriver-integration module to exercise the just-built docker imageTest docker image

.github/workflows/build.yml

@@ -41,6 +41,19 @@ jobs:
         env:
           ORG_GRADLE_PROJECT_version: ${{ steps.build_variables.outputs.VERSION }}
         run: ./gradlew build --stacktrace ${{ steps.build_variables.outputs.REPO }}-web:installDist
+      - name: Build local slim container image for testing
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: Dockerfile.slim
+          load: true
+          platforms: local
+          tags: |
+            "${{ steps.build_variables.outputs.REPO }}:${{ steps.build_variables.outputs.VERSION }}-unvalidated"
+      - name: Test local slim container image
+        env:
+          FULL_DOCKER_IMAGE_NAME: "${{ steps.build_variables.outputs.REPO }}:${{ steps.build_variables.outputs.VERSION }}-unvalidated"
+        run: ./gradlew ${{ steps.build_variables.outputs.REPO }}-integration:test
       - name: Login to GAR
         # Only run this on repositories in the 'spinnaker' org, not on forks.
         if: startsWith(github.repository, 'spinnaker/')

.github/workflows/pr.yml

@@ -75,3 +75,16 @@ jobs:
           tags: |
             "${{ env.CONTAINER_REGISTRY }}/${{ steps.build_variables.outputs.REPO }}:latest-java11-ubuntu"
             "${{ env.CONTAINER_REGISTRY }}/${{ steps.build_variables.outputs.REPO }}:${{ steps.build_variables.outputs.VERSION }}-java11-ubuntu"
+      - name: Build local slim container image for testing
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: Dockerfile.slim
+          load: true
+          platforms: local
+          tags: |
+            "${{ steps.build_variables.outputs.REPO }}:${{ steps.build_variables.outputs.VERSION }}"
+      - name: Test local slim container image
+        env:
+          FULL_DOCKER_IMAGE_NAME: "${{ steps.build_variables.outputs.REPO }}:${{ steps.build_variables.outputs.VERSION }}"
+        run: ./gradlew ${{ steps.build_variables.outputs.REPO }}-integration:test

Dockerfile.java11.slim

@@ -16,6 +16,7 @@ RUN apk update \
   && apk --no-cache add --update \
     bash \
     ca-certificates \
+    curl \
     wget \
     openjdk11 \
     git \
@@ -64,5 +65,5 @@ COPY clouddriver-web/build/install/clouddriver /opt/clouddriver
 RUN mkdir -p /opt/clouddriver/plugins && chown -R spinnaker:nogroup /opt/clouddriver/plugins
 
 USER spinnaker
-
+HEALTHCHECK CMD curl http://localhost:7002/health | grep UP || exit 1
 CMD ["/opt/clouddriver/bin/clouddriver"]

Dockerfile.java11.ubuntu

@@ -14,6 +14,7 @@ RUN apt-get update && apt-get install -y curl gnupg && \
   apt-get update && \
   apt-get upgrade -y && \
   apt-get install -y \
+  curl \
   openjdk-11-jre-headless \
   wget \
   python3-pip \
@@ -61,4 +62,5 @@ RUN adduser --system --uid 10111 --group spinnaker
 COPY clouddriver-web/build/install/clouddriver /opt/clouddriver
 RUN mkdir -p /opt/clouddriver/plugins && chown -R spinnaker:nogroup /opt/clouddriver/plugins
 USER spinnaker
+HEALTHCHECK CMD curl http://localhost:7002/health | grep UP || exit 1
 CMD ["/opt/clouddriver/bin/clouddriver"]

Dockerfile.slim

@@ -16,6 +16,7 @@ RUN apk update \
   && apk --no-cache add --update \
     bash \
     ca-certificates \
+    curl \
     wget \
     openjdk17 \
     git \
@@ -64,5 +65,5 @@ COPY clouddriver-web/build/install/clouddriver /opt/clouddriver
 RUN mkdir -p /opt/clouddriver/plugins && chown -R spinnaker:nogroup /opt/clouddriver/plugins
 
 USER spinnaker
-
+HEALTHCHECK CMD curl http://localhost:7002/health | grep UP || exit 1
 CMD ["/opt/clouddriver/bin/clouddriver"]

Dockerfile.ubuntu

@@ -14,6 +14,7 @@ RUN apt-get update && apt-get install -y curl gnupg && \
   apt-get update && \
   apt-get upgrade -y && \
   apt-get install -y \
+  curl \
   openjdk-17-jre-headless \
   wget \
   python3-pip \
@@ -61,4 +62,5 @@ RUN adduser --system --uid 10111 --group spinnaker
 COPY clouddriver-web/build/install/clouddriver /opt/clouddriver
 RUN mkdir -p /opt/clouddriver/plugins && chown -R spinnaker:nogroup /opt/clouddriver/plugins
 USER spinnaker
+HEALTHCHECK CMD curl http://localhost:7002/health | grep UP || exit 1
 CMD ["/opt/clouddriver/bin/clouddriver"]

clouddriver-integration/clouddriver-integration.gradle

@@ -0,0 +1,24 @@
+dependencies {
+  testImplementation "com.fasterxml.jackson.core:jackson-databind"
+  testImplementation "org.assertj:assertj-core"
+  testImplementation "org.junit.jupiter:junit-jupiter-api"
+  testImplementation "org.slf4j:slf4j-api"
+  testImplementation "org.testcontainers:testcontainers"
+  testImplementation "org.testcontainers:junit-jupiter"
+  testRuntimeOnly "ch.qos.logback:logback-classic"
+}
+
+test.configure {
+  def fullDockerImageName = System.getenv('FULL_DOCKER_IMAGE_NAME')
+  onlyIf("there is a docker image to test") {
+    fullDockerImageName != null && fullDockerImageName.trim() != ''
+  }
+}
+
+test {
+  // So stdout and stderr from the just-built container are available in CI
+  testLogging.showStandardStreams = true
+
+  // Run the tests when the docker image changes
+  inputs.property 'fullDockerImageName', System.getenv('FULL_DOCKER_IMAGE_NAME')
+}

clouddriver-integration/src/test/java/com/netflix/spinnaker/clouddriver/StandaloneContainerTest.java

@@ -0,0 +1,133 @@
+/*
+ * Copyright 2024 Salesforce, Inc.
+ *
+ * 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
+ *
+ *    http://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 com.netflix.spinnaker.clouddriver;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assumptions.assumeTrue;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+import java.time.Duration;
+import java.util.Map;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInfo;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.Network;
+import org.testcontainers.containers.output.Slf4jLogConsumer;
+import org.testcontainers.containers.wait.strategy.Wait;
+import org.testcontainers.junit.jupiter.Testcontainers;
+import org.testcontainers.utility.DockerImageName;
+
+@Testcontainers
+class StandaloneContainerTest {
+
+  private static final String REDIS_NETWORK_ALIAS = "redisHost";
+
+  private static final int REDIS_PORT = 6379;
+
+  private static final Logger logger = LoggerFactory.getLogger(StandaloneContainerTest.class);
+
+  private static final Network network = Network.newNetwork();
+
+  private static final GenericContainer redis =
+      new GenericContainer(DockerImageName.parse("library/redis:5-alpine"))
+          .withNetwork(network)
+          .withNetworkAliases(REDIS_NETWORK_ALIAS)
+          .withExposedPorts(REDIS_PORT);
+
+  private static GenericContainer clouddriverContainer;
+
+  @BeforeAll
+  static void setupOnce() throws Exception {
+    String fullDockerImageName = System.getenv("FULL_DOCKER_IMAGE_NAME");
+
+    // Skip the tests if there's no docker image.  This allows gradlew build to work.
+    assumeTrue(fullDockerImageName != null);
+
+    redis.start();
+
+    DockerImageName dockerImageName = DockerImageName.parse(fullDockerImageName);
+
+    clouddriverContainer =
+        new GenericContainer(dockerImageName)
+            .withNetwork(network)
+            .withExposedPorts(7002)
+            .dependsOn(redis)
+            .waitingFor(Wait.forHealthcheck().withStartupTimeout(Duration.ofSeconds(90)))
+            .withEnv("SPRING_APPLICATION_JSON", getSpringApplicationJson());
+
+    Slf4jLogConsumer logConsumer = new Slf4jLogConsumer(logger);
+    clouddriverContainer.start();
+    clouddriverContainer.followOutput(logConsumer);
+  }
+
+  private static String getSpringApplicationJson() throws JsonProcessingException {
+    String redisUrl = "redis://" + REDIS_NETWORK_ALIAS + ":" + REDIS_PORT;
+    logger.info("redisUrl: '{}'", redisUrl);
+    Map<String, String> properties =
+        Map.of("redis.connection", redisUrl, "services.fiat.baseUrl", "http://nowhere");
+    ObjectMapper mapper = new ObjectMapper();
+    return mapper.writeValueAsString(properties);
+  }
+
+  @AfterAll
+  static void cleanupOnce() {
+    if (clouddriverContainer != null) {
+      clouddriverContainer.stop();
+    }
+
+    if (redis != null) {
+      redis.stop();
+    }
+  }
+
+  @BeforeEach
+  void init(TestInfo testInfo) {
+    System.out.println("--------------- Test " + testInfo.getDisplayName());
+  }
+
+  @Test
+  void testHealthCheck() throws Exception {
+    // hit an arbitrary endpoint
+    HttpRequest request =
+        HttpRequest.newBuilder()
+            .uri(
+                new URI(
+                    "http://"
+                        + clouddriverContainer.getHost()
+                        + ":"
+                        + clouddriverContainer.getFirstMappedPort()
+                        + "/health"))
+            .GET()
+            .build();
+
+    HttpClient client = HttpClient.newHttpClient();
+
+    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
+    assertThat(response).isNotNull();
+    logger.info("response: {}, {}", response.statusCode(), response.body());
+    assertThat(response.statusCode()).isEqualTo(200);
+  }
+}

clouddriver-integration/src/test/resources/logback.xml

@@ -0,0 +1,36 @@
+<!--
+
+    Copyright 2024 Salesforce, Inc.
+
+    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
+
+    http://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.
+
+-->
+<configuration>
+
+    <!-- see https://java.testcontainers.org/supported_docker_environment/logging_config/ -->
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="DEBUG">
+        <appender-ref ref="STDOUT" />
+    </root>
+
+    <logger name="org.testcontainers" level="INFO"/>
+    <logger name="tc" level="INFO"/>
+    <logger name="com.github.dockerjava" level="WARN"/>
+    <logger name="com.github.dockerjava.zerodep.shaded.org.apache.hc.client5.http.wire" level="OFF"/>
+    <logger name="wiremock.org.eclipse.jetty" level="INFO"/>
+</configuration>

clouddriver-web/config/clouddriver.yml

@@ -309,7 +309,9 @@ resilience4j.retry:
 ---
 
 spring:
-  profiles: prod
+  config:
+    activate:
+      on-profile: prod
 
 # example https configuration for client auth to services:
 #default:
@@ -347,7 +349,9 @@ spring:
 # local profile is activated by default when running the application - override values here for local development
 #  for production, set spring.profiles.active to select the appropriate profile for your environment
 spring:
-  profiles: local
+  config:
+    activate:
+      on-profile: local
 
 # an AWSCredentialsProvider that obtains session credentials via SSH through a bastion instance (useful for local development):
 #bastion:
@@ -360,7 +364,9 @@ spring:
 # This profile is used in HA deployments for a clouddriver that handles read-only requests from
 # other services
 spring:
-  profiles: ro
+  config:
+    activate:
+      on-profile: ro
 
 redis:
   connection: ${services.redisRo.baseUrl:${services.redis.baseUrl}}
@@ -372,7 +378,9 @@ caching:
 # This profile is used in HA deployments for a clouddriver that handles mutating requests from
 # other services, but does not run caching agents
 spring:
-  profiles: rw
+  config:
+    activate:
+      on-profile: rw
 
 caching:
   writeEnabled: false

settings.gradle

@@ -65,6 +65,7 @@ include 'cats:cats-core',
   'clouddriver-core-tck',
   'clouddriver-elasticsearch',
   'clouddriver-event',
+  'clouddriver-integration',
   'clouddriver-saga',
   'clouddriver-saga-test',
   'clouddriver-security',