From 272f32c12632125e6dd79d1aa4eb74041a0b3f87 Mon Sep 17 00:00:00 2001 From: David Byron <82477955+dbyron-sf@users.noreply.github.com> Date: Mon, 6 May 2024 19:35:57 -0700 Subject: [PATCH] feat(build): add orca-integration module to exercise the just-built docker image (#4721) * feat(docker): add HEALTHCHECK to facilitate testing container startup * feat(build): add orca-integration module to exercise the just-built docker image * 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 (cherry picked from commit b360ad58820b1021fc982ed7443729e4c5e0d6ee) --- .github/workflows/build.yml | 15 +- .github/workflows/pr.yml | 15 +- Dockerfile.java11.slim | 3 +- Dockerfile.java11.ubuntu | 3 +- Dockerfile.slim | 3 +- Dockerfile.ubuntu | 3 +- orca-integration/orca-integration.gradle | 25 ++++ .../orca/StandaloneContainerTest.java | 133 ++++++++++++++++++ .../src/test/resources/logback.xml | 36 +++++ settings.gradle | 1 + 10 files changed, 231 insertions(+), 6 deletions(-) create mode 100644 orca-integration/orca-integration.gradle create mode 100644 orca-integration/src/test/java/com/netflix/spinnaker/orca/StandaloneContainerTest.java create mode 100644 orca-integration/src/test/resources/logback.xml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0fbb1ca850..f77598c899 100644 --- a/.github/workflows/build.yml +++ b/.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/') @@ -98,4 +111,4 @@ jobs: push: true tags: | "${{ env.CONTAINER_REGISTRY }}/${{ steps.build_variables.outputs.REPO }}:${{ github.ref_name }}-latest-java11-unvalidated-ubuntu" - "${{ env.CONTAINER_REGISTRY }}/${{ steps.build_variables.outputs.REPO }}:${{ steps.build_variables.outputs.VERSION }}-java11-unvalidated-ubuntu" \ No newline at end of file + "${{ env.CONTAINER_REGISTRY }}/${{ steps.build_variables.outputs.REPO }}:${{ steps.build_variables.outputs.VERSION }}-java11-unvalidated-ubuntu" diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 9a606799a1..6574b215e8 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -72,4 +72,17 @@ jobs: platforms: linux/amd64,linux/arm64 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" \ No newline at end of file + "${{ 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 diff --git a/Dockerfile.java11.slim b/Dockerfile.java11.slim index 7a051d9f2e..390f2b9173 100644 --- a/Dockerfile.java11.slim +++ b/Dockerfile.java11.slim @@ -1,9 +1,10 @@ FROM alpine:3.16 LABEL maintainer="sig-platform@spinnaker.io" -RUN apk --no-cache add --update bash openjdk11-jre +RUN apk --no-cache add --update bash curl openjdk11-jre RUN addgroup -S -g 10111 spinnaker RUN adduser -S -G spinnaker -u 10111 spinnaker COPY orca-web/build/install/orca /opt/orca RUN mkdir -p /opt/orca/plugins && chown -R spinnaker:nogroup /opt/orca/plugins USER spinnaker +HEALTHCHECK CMD curl --fail http://localhost:8083/health CMD ["/opt/orca/bin/orca"] diff --git a/Dockerfile.java11.ubuntu b/Dockerfile.java11.ubuntu index 16dfa49198..c17a412426 100644 --- a/Dockerfile.java11.ubuntu +++ b/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 orca-web/build/install/orca /opt/orca RUN mkdir -p /opt/orca/plugins && chown -R spinnaker:nogroup /opt/orca/plugins USER spinnaker +HEALTHCHECK CMD curl --fail http://localhost:8083/health CMD ["/opt/orca/bin/orca"] diff --git a/Dockerfile.slim b/Dockerfile.slim index 436123ad6c..b632e67a61 100644 --- a/Dockerfile.slim +++ b/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 orca-web/build/install/orca /opt/orca RUN mkdir -p /opt/orca/plugins && chown -R spinnaker:nogroup /opt/orca/plugins USER spinnaker +HEALTHCHECK CMD curl --fail http://localhost:8083/health CMD ["/opt/orca/bin/orca"] diff --git a/Dockerfile.ubuntu b/Dockerfile.ubuntu index 9adaa1c143..25985268ad 100644 --- a/Dockerfile.ubuntu +++ b/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 orca-web/build/install/orca /opt/orca RUN mkdir -p /opt/orca/plugins && chown -R spinnaker:nogroup /opt/orca/plugins USER spinnaker +HEALTHCHECK CMD curl --fail http://localhost:8083/health CMD ["/opt/orca/bin/orca"] diff --git a/orca-integration/orca-integration.gradle b/orca-integration/orca-integration.gradle new file mode 100644 index 0000000000..ed33fbbcdf --- /dev/null +++ b/orca-integration/orca-integration.gradle @@ -0,0 +1,25 @@ +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" + testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine" +} + +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') +} diff --git a/orca-integration/src/test/java/com/netflix/spinnaker/orca/StandaloneContainerTest.java b/orca-integration/src/test/java/com/netflix/spinnaker/orca/StandaloneContainerTest.java new file mode 100644 index 0000000000..7127d44ad7 --- /dev/null +++ b/orca-integration/src/test/java/com/netflix/spinnaker/orca/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.orca; + +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 orcaContainer; + + @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); + + orcaContainer = + new GenericContainer(dockerImageName) + .withNetwork(network) + .withExposedPorts(8083) + .dependsOn(redis) + .waitingFor(Wait.forHealthcheck().withStartupTimeout(Duration.ofSeconds(90))) + .withEnv("SPRING_APPLICATION_JSON", getSpringApplicationJson()); + + Slf4jLogConsumer logConsumer = new Slf4jLogConsumer(logger); + orcaContainer.start(); + orcaContainer.followOutput(logConsumer); + } + + private static String getSpringApplicationJson() throws JsonProcessingException { + String redisUrl = "redis://" + REDIS_NETWORK_ALIAS + ":" + REDIS_PORT; + logger.info("redisUrl: '{}'", redisUrl); + Map properties = + Map.of("redis.connection", redisUrl, "services.fiat.baseUrl", "http://nowhere"); + ObjectMapper mapper = new ObjectMapper(); + return mapper.writeValueAsString(properties); + } + + @AfterAll + static void cleanupOnce() { + if (orcaContainer != null) { + orcaContainer.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://" + + orcaContainer.getHost() + + ":" + + orcaContainer.getFirstMappedPort() + + "/health")) + .GET() + .build(); + + HttpClient client = HttpClient.newHttpClient(); + + HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); + assertThat(response).isNotNull(); + logger.info("response: {}, {}", response.statusCode(), response.body()); + assertThat(response.statusCode()).isEqualTo(200); + } +} diff --git a/orca-integration/src/test/resources/logback.xml b/orca-integration/src/test/resources/logback.xml new file mode 100644 index 0000000000..6145d38780 --- /dev/null +++ b/orca-integration/src/test/resources/logback.xml @@ -0,0 +1,36 @@ + + + + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + + + + + + + diff --git a/settings.gradle b/settings.gradle index 850bc66900..360c6ffe58 100644 --- a/settings.gradle +++ b/settings.gradle @@ -42,6 +42,7 @@ include "orca-api", "orca-flex", "orca-front50", "orca-igor", + "orca-integration", "orca-integrations-cloudfoundry", "orca-integrations-gremlin", "orca-interlink",