feat(build): add echo-integration module to exercise the just-built d…

…ocker image (#1405)

* chore(build): give local gradle builds more memory

to match what github actions uses

* feat(docker): add HEALTHCHECK

to facilitate testing container startup

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

@W-15161670

* fix(web): remove circular dependency in configuration of services.fiat.enabled

to fix:

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2024-03-29 03:19:26.437 ERROR 1 --- [           main] o.s.b.d.LoggingFailureAnalysisReporter   :

***************************
APPLICATION FAILED TO START
***************************

Description:

Failed to bind properties under 'services.fiat.enabled' to boolean:

    Property: services.fiat.enabled
    Value: "${services.fiat.enabled:false}"
    Origin: "services.fiat.enabled" from property source "Config resource 'class path resource [echo.yml]' via location 'optional:classpath:/' (document #0)"
    Reason: java.lang.IllegalArgumentException: Circular placeholder reference 'services.fiat.enabled:false' in property definitions

Action:

Update your application's configuration

* fix(web): remove circular dependency in configuration of services.fiat.baseUrl

to fix:

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2024-03-29 15:14:51.086 ERROR 1 --- [           main] o.s.b.d.LoggingFailureAnalysisReporter   :

***************************
APPLICATION FAILED TO START
***************************

Description:

Failed to bind properties under 'services.fiat.base-url' to java.lang.String:

    Property: services.fiat.base-url
    Value: "${services.fiat.baseUrl:http://localhost:8089}"
    Origin: "services.fiat.baseUrl" from property source "Config resource 'class path resource [echo.yml]' via location 'optional:classpath:/' (document #0)"
    Reason: java.lang.IllegalArgumentException: Circular placeholder reference 'services.fiat.baseUrl:http://localhost:8089' in property definitions

Action:

Update your application's configuration

Use port 7003 since that's the default port for fiat from https://spinnaker.io/docs/reference/architecture/microservices-overview/#port-mappings.

* fix(web): replace deprecated spring.profiles in configuration

with spring.config.activate.on-profile to remove these warnings:

2024-03-29 03:19:11.785  WARN 1 --- [           main] o.s.b.c.config.ConfigDataEnvironment     : Property 'spring.profiles' imported from location 'class path resource [echo.yml]' is invalid and should be replaced with 'spring.config.activate.on-profile' [origin: class path resource [echo.yml] - 74:13]
2024-03-29 03:19:11.785  WARN 1 --- [           main] o.s.b.c.config.ConfigDataEnvironment     : Property 'spring.profiles' imported from location 'class path resource [echo.yml]' is invalid and should be replaced with 'spring.config.activate.on-profile' [origin: class path resource [echo.yml] - 65:13]

See https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-Config-Data-Migration-Guide#profile-specific-documents.

* feat(gha): run integration test in pr builds

multi-arch with --load doesn't work, so add a separate step using the local platform to
make an image available for testing.

see docker/buildx#59

* feat(gha): run integration test in branch builds

.github/workflows/build.yml

@@ -39,6 +39,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

@@ -73,3 +73,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

@@ -5,4 +5,5 @@ RUN adduser --system --uid 10111 --group spinnaker
 COPY echo-web/build/install/echo /opt/echo
 RUN mkdir -p /opt/echo/plugins && chown -R spinnaker:nogroup /opt/echo/plugins
 USER spinnaker
+HEALTHCHECK CMD curl http://localhost:8089/health | grep UP || exit 1
 CMD ["/opt/echo/bin/echo"]

Dockerfile.java11.ubuntu

@@ -1,8 +1,9 @@
 FROM ubuntu:bionic
 LABEL maintainer="sig-platform@spinnaker.io"
-RUN apt-get update && apt-get -y install openjdk-11-jre-headless wget
+RUN apt-get update && apt-get -y install curl openjdk-11-jre-headless wget
 RUN adduser --system --uid 10111 --group spinnaker
 COPY echo-web/build/install/echo /opt/echo
 RUN mkdir -p /opt/echo/plugins && chown -R spinnaker:nogroup /opt/echo/plugins
 USER spinnaker
+HEALTHCHECK CMD curl http://localhost:8089/health | grep UP || exit 1
 CMD ["/opt/echo/bin/echo"]

Dockerfile.slim

@@ -1,9 +1,10 @@
 FROM alpine:3.16
 LABEL maintainer="sig-platform@spinnaker.io"
-RUN apk --no-cache add --update bash openjdk17-jre
+RUN apk --no-cache add --update bash curl openjdk17-jre
 RUN addgroup -S -g 10111 spinnaker
 RUN adduser -S -G spinnaker -u 10111 spinnaker
 COPY echo-web/build/install/echo /opt/echo
 RUN mkdir -p /opt/echo/plugins && chown -R spinnaker:nogroup /opt/echo/plugins
 USER spinnaker
+HEALTHCHECK CMD curl http://localhost:8089/health | grep UP || exit 1
 CMD ["/opt/echo/bin/echo"]

Dockerfile.ubuntu

@@ -1,8 +1,9 @@
 FROM ubuntu:bionic
 LABEL maintainer="sig-platform@spinnaker.io"
-RUN apt-get update && apt-get -y install openjdk-17-jre-headless wget
+RUN apt-get update && apt-get -y install curl openjdk-17-jre-headless wget
 RUN adduser --system --uid 10111 --group spinnaker
 COPY echo-web/build/install/echo /opt/echo
 RUN mkdir -p /opt/echo/plugins && chown -R spinnaker:nogroup /opt/echo/plugins
 USER spinnaker
+HEALTHCHECK CMD curl http://localhost:8089/health | grep UP || exit 1
 CMD ["/opt/echo/bin/echo"]

echo-integration/echo-integration.gradle

@@ -0,0 +1,25 @@
+dependencies {
+  testImplementation "com.fasterxml.jackson.core:jackson-databind"
+  testImplementation "com.github.tomakehurst:wiremock-jre8-standalone"
+  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')
+}

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

@@ -0,0 +1,168 @@
+/*
+ * 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.echo;
+
+import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
+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 com.github.tomakehurst.wiremock.client.WireMock;
+import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
+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.junit.jupiter.api.extension.RegisterExtension;
+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();
+
+  // echo caches pipeline configurations from front50, and echo's health depends
+  // on it succeeding.
+  @RegisterExtension
+  static final WireMockExtension wmFront50 =
+      WireMockExtension.newInstance().options(wireMockConfig().dynamicPort()).build();
+
+  static int front50Port;
+
+  // redis isn't required for echo to start, but redis starts quickly enough
+  // that we may as well wire it up to facilitate future testing.
+  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 echoContainer;
+
+  @BeforeAll
+  static void setupOnce() throws Exception {
+    front50Port = wmFront50.getRuntimeInfo().getHttpPort();
+    logger.info("wiremock front50 http port: {} ", front50Port);
+
+    // set up front50 stub for /pipelines...return an empty json list
+    wmFront50.stubFor(
+        WireMock.get(urlPathEqualTo("/pipelines"))
+            .willReturn(aResponse().withStatus(200).withBody("[]")));
+
+    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);
+
+    // expose front50 to echo
+    org.testcontainers.Testcontainers.exposeHostPorts(front50Port);
+
+    redis.start();
+
+    DockerImageName dockerImageName = DockerImageName.parse(fullDockerImageName);
+
+    // Include the file system bind for /tmp since echo uses spring cloud config
+    // which writes to it.
+    echoContainer =
+        new GenericContainer(dockerImageName)
+            .withNetwork(network)
+            .withExposedPorts(8089)
+            .dependsOn(redis)
+            .waitingFor(Wait.forHealthcheck().withStartupTimeout(Duration.ofSeconds(90)))
+            .withEnv("SPRING_APPLICATION_JSON", getSpringApplicationJson());
+
+    Slf4jLogConsumer logConsumer = new Slf4jLogConsumer(logger);
+    echoContainer.start();
+    echoContainer.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,
+            "redis.enabled",
+            "true",
+            "services.front50.baseUrl",
+            "http://" + GenericContainer.INTERNAL_HOST_HOSTNAME + ":" + front50Port);
+    ObjectMapper mapper = new ObjectMapper();
+    return mapper.writeValueAsString(properties);
+  }
+
+  @AfterAll
+  static void cleanupOnce() {
+    if (echoContainer != null) {
+      echoContainer.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://"
+                        + echoContainer.getHost()
+                        + ":"
+                        + echoContainer.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);
+  }
+}

echo-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>

echo-web/config/echo.yml

@@ -12,8 +12,8 @@ front50:
 
 services:
   fiat:
-    enabled: ${services.fiat.enabled:false}
-    baseUrl: ${services.fiat.baseUrl:http://localhost:8089}
+    enabled: false
+    baseUrl: http://localhost:7003
 
 igor:
   enabled: ${services.igor.enabled:false}
@@ -62,7 +62,9 @@ resilience4j.circuitbreaker:
 # This profile is used in sharded deployments for an Echo that handles only
 # scheduled tasks.
 spring:
-  profiles: scheduler
+  config:
+    activate:
+      on-profile: scheduler
 
 scheduler:
   enabled: true
@@ -71,7 +73,9 @@ scheduler:
 # This profile is used in sharded deployments for an Echo that handles all
 # operations other than scheduled tasks.
 spring:
-  profiles: worker
+  config:
+    activate:
+      on-profile: worker
 
 scheduler:
   enabled: false

gradle.properties

@@ -19,3 +19,5 @@ targetJava11=true
 #
 #fiatComposite=true
 #korkComposite=true
+
+org.gradle.jvmargs=-Xmx2g -Xms2g

settings.gradle

@@ -27,6 +27,7 @@ include 'echo-api',
         'echo-artifacts',
         'echo-bom',
         'echo-core',
+        'echo-integration',
         'echo-model',
         'echo-web',
         'echo-notifications',