jdeppe-pivotal commented on a change in pull request #6385: URL: https://github.com/apache/geode/pull/6385#discussion_r623378021
########## File path: geode-assembly/src/acceptanceTest/java/org/apache/geode/rules/DockerComposeRule.java ########## @@ -0,0 +1,268 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for additional information regarding + * copyright ownership. The ASF licenses this file to You 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 org.apache.geode.rules; + +import java.io.File; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import com.github.dockerjava.api.DockerClient; +import com.github.dockerjava.api.command.ExecCreateCmdResponse; +import org.apache.logging.log4j.Logger; +import org.junit.rules.ExternalResource; +import org.junit.rules.RuleChain; +import org.junit.runner.Description; +import org.junit.runners.model.Statement; +import org.testcontainers.DockerClientFactory; +import org.testcontainers.containers.Container; +import org.testcontainers.containers.ContainerState; +import org.testcontainers.containers.DockerComposeContainer; +import org.testcontainers.containers.output.BaseConsumer; +import org.testcontainers.containers.output.FrameConsumerResultCallback; +import org.testcontainers.containers.output.OutputFrame; +import org.testcontainers.containers.output.ToStringConsumer; + +import org.apache.geode.logging.internal.log4j.api.LogService; +import org.apache.geode.test.junit.rules.IgnoreOnWindowsRule; + +/** + * This class assists in managing the lifecycle of a cluster, launched via a docker-compose + * configuration file, for testing. For example: + * + * <pre> + * + * @ClassRule + * public static DockerComposeRule cluster = new DockerComposeRule().Builder() + * .file("/home/bob/test/docker-compose.yml") + * .service("haproxy", 15223) + * .build(); + * + * // Get the exposed port for haproxy + * cluster.getExternalPortForService("haproxy", 15223); + * </pre> + * + * Some limitations are as follows: + * <ul> + * <li>{@code testcontainers} does not support using {@code container_name:} attributes. If you + * need your container to be named explicitly, use {@link DockerComposeRule#setContainerName}</li> + * <li>Do not use the {@code expose} directives in your yaml file. Instead use + * {@link DockerComposeRule.Builder#service} + * to expose the relevant service and port.</li> + * <li>For now, this rule only handles a single instance of a service.</li> + * </ul> + * + * @see <a href= + * "https://www.testcontainers.org/modules/docker_compose/";>https://www.testcontainers.org/modules/docker_compose/</a> + */ +public class DockerComposeRule extends ExternalResource { + + private static final Logger logger = LogService.getLogger(); + + private final RuleChain delegate; + private final String composeFile; + private final Map<String, List<Integer>> exposedServices; + private DockerComposeContainer<?> composeContainer; + + public DockerComposeRule(String composeFile, Map<String, List<Integer>> exposedServices) { + this.composeFile = composeFile; + this.exposedServices = exposedServices; + + // Docker compose does not work on windows in CI. Ignore this test on windows using a + // RuleChain to make sure we ignore the test before the rule comes into play. + delegate = RuleChain.outerRule(new IgnoreOnWindowsRule()); + } + + @Override + public Statement apply(Statement base, Description description) { + Statement containStatement = new Statement() { + @Override + public void evaluate() throws Throwable { + + composeContainer = new DockerComposeContainer<>("compose", new File(composeFile)); + exposedServices.forEach((service, ports) -> ports + .forEach(p -> composeContainer.withExposedService(service, p))); + + composeContainer.start(); + + try { + base.evaluate(); + } finally { + composeContainer.stop(); + } + } + }; + + return delegate.apply(containStatement, description); + } + + /** + * When used with compose, testcontainers does not allow one to have a 'container_name' + * attribute in the compose file. This means that container names end up looking something like: + * {@code project_service_index}. When a container performs a reverse IP lookup it will get a + * hostname that looks something like {@code projectjkh_db_1.my-network}. This can be a problem + * since this hostname is not RFC compliant as it contains underscores. This may cause problems + * in particular with SSL. + * + * @param serviceName the service who's container name to change + * @param newName the new container name + * + * @throws IllegalArgumentException if the service cannot be found + */ + public void setContainerName(String serviceName, String newName) { + ContainerState container = composeContainer.getContainerByServiceName(serviceName + "_1") + .orElseThrow(() -> new IllegalArgumentException("Unknown service name: " + serviceName)); + + String containerId = container.getContainerId(); + + DockerClient dockerClient = DockerClientFactory.instance().client(); + dockerClient.renameContainerCmd(containerId).withName(newName).exec(); + } + + /** + * Execute a command in a service container + * + * @return the stdout of the container if the command was successful, else the stderr + */ + public String execForService(String serviceName, String... args) { + ContainerState container = composeContainer.getContainerByServiceName(serviceName + "_1") + .orElseThrow(() -> new IllegalArgumentException("Unknown service name: " + serviceName)); + Container.ExecResult result; + try { + result = container.execInContainer(args); + } catch (Exception e) { + throw new RuntimeException(e); + } + + return result.getExitCode() == 0 ? result.getStdout() : result.getStderr(); + } + + /** + * Execute a commond in a service container, logging the output Review comment: Fixed. ########## File path: geode-assembly/src/acceptanceTest/java/org/apache/geode/rules/DockerComposeRule.java ########## @@ -0,0 +1,268 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for additional information regarding + * copyright ownership. The ASF licenses this file to You 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 org.apache.geode.rules; + +import java.io.File; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import com.github.dockerjava.api.DockerClient; +import com.github.dockerjava.api.command.ExecCreateCmdResponse; +import org.apache.logging.log4j.Logger; +import org.junit.rules.ExternalResource; +import org.junit.rules.RuleChain; +import org.junit.runner.Description; +import org.junit.runners.model.Statement; +import org.testcontainers.DockerClientFactory; +import org.testcontainers.containers.Container; +import org.testcontainers.containers.ContainerState; +import org.testcontainers.containers.DockerComposeContainer; +import org.testcontainers.containers.output.BaseConsumer; +import org.testcontainers.containers.output.FrameConsumerResultCallback; +import org.testcontainers.containers.output.OutputFrame; +import org.testcontainers.containers.output.ToStringConsumer; + +import org.apache.geode.logging.internal.log4j.api.LogService; +import org.apache.geode.test.junit.rules.IgnoreOnWindowsRule; + +/** + * This class assists in managing the lifecycle of a cluster, launched via a docker-compose + * configuration file, for testing. For example: + * + * <pre> + * + * @ClassRule + * public static DockerComposeRule cluster = new DockerComposeRule().Builder() + * .file("/home/bob/test/docker-compose.yml") + * .service("haproxy", 15223) + * .build(); + * + * // Get the exposed port for haproxy + * cluster.getExternalPortForService("haproxy", 15223); + * </pre> + * + * Some limitations are as follows: + * <ul> + * <li>{@code testcontainers} does not support using {@code container_name:} attributes. If you + * need your container to be named explicitly, use {@link DockerComposeRule#setContainerName}</li> + * <li>Do not use the {@code expose} directives in your yaml file. Instead use + * {@link DockerComposeRule.Builder#service} + * to expose the relevant service and port.</li> + * <li>For now, this rule only handles a single instance of a service.</li> + * </ul> + * + * @see <a href= + * "https://www.testcontainers.org/modules/docker_compose/";>https://www.testcontainers.org/modules/docker_compose/</a> + */ +public class DockerComposeRule extends ExternalResource { + + private static final Logger logger = LogService.getLogger(); + + private final RuleChain delegate; + private final String composeFile; + private final Map<String, List<Integer>> exposedServices; + private DockerComposeContainer<?> composeContainer; + + public DockerComposeRule(String composeFile, Map<String, List<Integer>> exposedServices) { + this.composeFile = composeFile; + this.exposedServices = exposedServices; + + // Docker compose does not work on windows in CI. Ignore this test on windows using a + // RuleChain to make sure we ignore the test before the rule comes into play. + delegate = RuleChain.outerRule(new IgnoreOnWindowsRule()); + } + + @Override + public Statement apply(Statement base, Description description) { + Statement containStatement = new Statement() { + @Override + public void evaluate() throws Throwable { + + composeContainer = new DockerComposeContainer<>("compose", new File(composeFile)); + exposedServices.forEach((service, ports) -> ports + .forEach(p -> composeContainer.withExposedService(service, p))); + + composeContainer.start(); + + try { + base.evaluate(); + } finally { + composeContainer.stop(); + } + } + }; + + return delegate.apply(containStatement, description); + } + + /** + * When used with compose, testcontainers does not allow one to have a 'container_name' + * attribute in the compose file. This means that container names end up looking something like: + * {@code project_service_index}. When a container performs a reverse IP lookup it will get a + * hostname that looks something like {@code projectjkh_db_1.my-network}. This can be a problem + * since this hostname is not RFC compliant as it contains underscores. This may cause problems + * in particular with SSL. + * + * @param serviceName the service who's container name to change + * @param newName the new container name + * + * @throws IllegalArgumentException if the service cannot be found + */ + public void setContainerName(String serviceName, String newName) { + ContainerState container = composeContainer.getContainerByServiceName(serviceName + "_1") + .orElseThrow(() -> new IllegalArgumentException("Unknown service name: " + serviceName)); + + String containerId = container.getContainerId(); + + DockerClient dockerClient = DockerClientFactory.instance().client(); + dockerClient.renameContainerCmd(containerId).withName(newName).exec(); + } + + /** + * Execute a command in a service container + * + * @return the stdout of the container if the command was successful, else the stderr + */ + public String execForService(String serviceName, String... args) { Review comment: Done. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
