Skip to content

Commit

Permalink
feat(build): add igor-integration module to exercise the just-built d…
Browse files Browse the repository at this point in the history
…ocker image
  • Loading branch information
dbyron-sf committed Mar 26, 2024
1 parent df83b11 commit b44eca5
Show file tree
Hide file tree
Showing 4 changed files with 194 additions and 0 deletions.
24 changes: 24 additions & 0 deletions igor-integration/igor-integration.gradle
Original file line number Diff line number Diff line change
@@ -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')
}
Original file line number Diff line number Diff line change
@@ -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.igor;

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.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();

// redis isn't required for igor to start, but redis starts quickly enough
// that we may as well wire it up to facilitate future testing.
private static GenericContainer redis =
new GenericContainer(DockerImageName.parse("library/redis:5-alpine"))
.withNetwork(network)
.withNetworkAliases(REDIS_NETWORK_ALIAS)
.withExposedPorts(REDIS_PORT);

private static GenericContainer igorContainer;

@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);

igorContainer =
new GenericContainer(dockerImageName)
.withNetwork(network)
.withExposedPorts(8088)
.dependsOn(redis)
.waitingFor(Wait.forHealthcheck())
.withEnv("SPRING_APPLICATION_JSON", getSpringApplicationJson());

Slf4jLogConsumer logConsumer = new Slf4jLogConsumer(logger);
igorContainer.start();
igorContainer.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);
ObjectMapper mapper = new ObjectMapper();
return mapper.writeValueAsString(properties);
}

@AfterAll
static void cleanupOnce() {
if (igorContainer != null) {
igorContainer.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://"
+ igorContainer.getHost()
+ ":"
+ igorContainer.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);
}
}
36 changes: 36 additions & 0 deletions igor-integration/src/test/resources/logback.xml
Original file line number Diff line number Diff line change
@@ -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"/>

</configuration>
1 change: 1 addition & 0 deletions settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ rootProject.name='igor'

include 'igor-bom',
'igor-core',
'igor-integration',
'igor-monitor-artifactory',
'igor-monitor-plugins',
'igor-monitor-travis',
Expand Down

0 comments on commit b44eca5

Please sign in to comment.