Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.trino.tests.product.launcher.cli.TestRun Maven / Gradle / Ivy
/*
* 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 io.trino.tests.product.launcher.cli;
import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.io.Files;
import com.google.inject.Inject;
import com.google.inject.Module;
import dev.failsafe.Failsafe;
import dev.failsafe.Timeout;
import dev.failsafe.TimeoutExceededException;
import io.airlift.log.Logger;
import io.airlift.units.Duration;
import io.trino.tests.product.launcher.Extensions;
import io.trino.tests.product.launcher.env.DockerContainer;
import io.trino.tests.product.launcher.env.Environment;
import io.trino.tests.product.launcher.env.EnvironmentConfig;
import io.trino.tests.product.launcher.env.EnvironmentFactory;
import io.trino.tests.product.launcher.env.EnvironmentModule;
import io.trino.tests.product.launcher.env.EnvironmentOptions;
import io.trino.tests.product.launcher.env.jdk.JdkProvider;
import io.trino.tests.product.launcher.testcontainers.ExistingNetwork;
import picocli.CommandLine.ExitCode;
import picocli.CommandLine.Mixin;
import picocli.CommandLine.Parameters;
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.Callable;
import static com.google.common.base.Strings.isNullOrEmpty;
import static com.google.common.collect.ImmutableList.toImmutableList;
import static io.trino.tests.product.launcher.env.DockerContainer.cleanOrCreateHostPath;
import static io.trino.tests.product.launcher.env.EnvironmentContainers.TESTS;
import static io.trino.tests.product.launcher.env.EnvironmentListener.getStandardListeners;
import static io.trino.tests.product.launcher.env.common.Standard.CONTAINER_TEMPTO_PROFILE_CONFIG;
import static io.trino.tests.product.launcher.testcontainers.PortBinder.unsafelyExposePort;
import static java.lang.StrictMath.toIntExact;
import static java.lang.String.format;
import static java.util.Objects.requireNonNull;
import static java.util.stream.Collectors.groupingBy;
import static java.util.stream.Collectors.mapping;
import static java.util.stream.Collectors.toList;
import static org.testcontainers.containers.BindMode.READ_ONLY;
import static org.testcontainers.containers.BindMode.READ_WRITE;
import static org.testcontainers.utility.MountableFile.forClasspathResource;
import static picocli.CommandLine.Command;
import static picocli.CommandLine.Option;
@Command(
name = "run",
description = "Run a Trino product test",
usageHelpAutoWidth = true)
public final class TestRun
extends LauncherCommand
{
private static final Logger log = Logger.get(TestRun.class);
@Option(names = {"-h", "--help"}, usageHelp = true, description = "Show this help message and exit")
@SuppressWarnings("unused")
public boolean usageHelpRequested;
@Mixin
public EnvironmentOptions environmentOptions = new EnvironmentOptions();
@Mixin
public TestRunOptions testRunOptions = new TestRunOptions();
public TestRun(OutputStream outputStream, Extensions extensions)
{
super(TestRun.Execution.class, outputStream, extensions);
}
@Override
List getCommandModules()
{
return ImmutableList.of(
new EnvironmentModule(environmentOptions, extensions.getAdditionalEnvironments()),
testRunOptions.toModule());
}
public static class TestRunOptions
{
private static final String DEFAULT_VALUE = "(default: ${DEFAULT-VALUE})";
@Option(names = "--test-jar", paramLabel = "", description = "Path to test JAR " + DEFAULT_VALUE, defaultValue = "${product-tests.module}/target/${product-tests.name}-${project.version}-executable.jar")
public File testJar;
@Option(names = "--cli-executable", paramLabel = "", description = "Path to CLI executable " + DEFAULT_VALUE, defaultValue = "${cli.bin}")
public File cliJar;
@Option(names = "--environment", paramLabel = "", description = "Name of the environment to start", required = true)
public String environment;
@Option(names = "--option", paramLabel = "", description = "Extra options to provide to environment (property can be used multiple times; format is key=value)")
public Map extraOptions = new HashMap<>();
@Option(names = "--impacted-features", paramLabel = "", description = "Skip tests not using these features " + DEFAULT_VALUE)
public Optional impactedFeatures;
@Option(names = "--attach", description = "attach to an existing environment")
public boolean attach;
@Option(names = "--debug-suspend-tests", description = "Wait for client to connect in debug mode. Product Tests process only.")
public boolean debugSuspend;
@Option(names = "--reports-dir", paramLabel = "", description = "Location of the reports directory " + DEFAULT_VALUE, defaultValue = "${product-tests.module}/target/reports")
public Path reportsDir;
@Option(names = "--logs-dir", paramLabel = "", description = "Location of the exported logs directory " + DEFAULT_VALUE)
public Optional logsDirBase;
@Option(names = "--startup-retries", paramLabel = "", description = "Environment startup retries " + DEFAULT_VALUE, defaultValue = "5")
public Integer startupRetries = 5;
@Option(names = "--timeout", paramLabel = "", description = "Maximum duration of tests execution " + DEFAULT_VALUE, defaultValue = "999d")
public Duration timeout;
@Parameters(paramLabel = "", description = "Test arguments")
public List testArguments = List.of();
public Module toModule()
{
return binder -> binder.bind(TestRunOptions.class).toInstance(this);
}
}
public static class Execution
implements Callable
{
private static final String CONTAINER_REPORTS_DIR = "/docker/test-reports";
private final EnvironmentFactory environmentFactory;
private final boolean debug;
private final boolean debugSuspend;
private final JdkProvider jdkProvider;
private final File testJar;
private final File cliJar;
private final List testArguments;
private final String environment;
private final boolean attach;
private final Duration timeout;
private final DockerContainer.OutputMode outputMode;
private final int startupRetries;
private final Path reportsDirBase;
private final Optional logsDirBase;
private final EnvironmentConfig environmentConfig;
private final Map extraOptions;
private final PrintStream printStream;
private final Optional> impactedFeatures;
public static final Integer ENVIRONMENT_SKIPPED_EXIT_CODE = 98;
@Inject
public Execution(
EnvironmentFactory environmentFactory,
JdkProvider jdkProvider,
EnvironmentOptions environmentOptions,
EnvironmentConfig environmentConfig,
TestRunOptions testRunOptions,
PrintStream printStream)
{
this.environmentFactory = requireNonNull(environmentFactory, "environmentFactory is null");
requireNonNull(environmentOptions, "environmentOptions is null");
this.debug = environmentOptions.debug;
this.debugSuspend = testRunOptions.debugSuspend;
this.jdkProvider = requireNonNull(jdkProvider, "jdkProvider is null");
this.testJar = requireNonNull(testRunOptions.testJar, "testRunOptions.testJar is null");
this.cliJar = requireNonNull(testRunOptions.cliJar, "testRunOptions.cliJar is null");
this.testArguments = ImmutableList.copyOf(requireNonNull(testRunOptions.testArguments, "testRunOptions.testArguments is null"));
this.environment = requireNonNull(testRunOptions.environment, "testRunOptions.environment is null");
this.attach = testRunOptions.attach;
this.timeout = requireNonNull(testRunOptions.timeout, "testRunOptions.timeout is null");
this.outputMode = requireNonNull(environmentOptions.output, "environmentOptions.output is null");
this.startupRetries = testRunOptions.startupRetries;
this.reportsDirBase = requireNonNull(testRunOptions.reportsDir, "testRunOptions.reportsDirBase is empty");
this.logsDirBase = requireNonNull(testRunOptions.logsDirBase, "testRunOptions.logsDirBase is empty");
this.environmentConfig = requireNonNull(environmentConfig, "environmentConfig is null");
this.extraOptions = ImmutableMap.copyOf(requireNonNull(testRunOptions.extraOptions, "testRunOptions.extraOptions is null"));
this.printStream = requireNonNull(printStream, "printStream is null");
Optional impactedFeaturesFile = requireNonNull(testRunOptions.impactedFeatures, "testRunOptions.impactedFeatures is null");
if (impactedFeaturesFile.isPresent()) {
try {
this.impactedFeatures = Optional.of(Files.asCharSource(impactedFeaturesFile.get(), StandardCharsets.UTF_8).readLines());
log.info("Impacted features: %s", this.impactedFeatures);
}
catch (IOException e) {
throw new RuntimeException(e);
}
}
else {
this.impactedFeatures = Optional.empty();
}
}
@Override
public Integer call()
{
long timeoutMillis = timeout.toMillis();
if (timeoutMillis == 0) {
log.error("Timeout %s exhausted", timeout);
return ExitCode.SOFTWARE;
}
try {
int exitCode = Failsafe
.with(Timeout.builder(java.time.Duration.ofMillis(timeoutMillis))
.withInterrupt()
.build())
.get(this::tryExecuteTests);
log.info("Tests execution completed with code %d", exitCode);
return exitCode;
}
catch (TimeoutExceededException _) {
log.error("Test execution exceeded timeout of %s", timeout);
}
catch (Throwable e) {
log.error(e, "Failure");
}
return ExitCode.SOFTWARE;
}
private Integer tryExecuteTests()
{
Environment environment = getEnvironment();
if (!hasImpactedFeatures(environment)) {
log.warn("Skipping test due to impacted features not overlapping with any features configured in environment");
return toIntExact(ENVIRONMENT_SKIPPED_EXIT_CODE);
}
try (Environment runningEnvironment = startEnvironment(environment)) {
return toIntExact(runningEnvironment.awaitTestsCompletion());
}
catch (RuntimeException e) {
log.warn(e, "Failed to execute tests");
return ExitCode.SOFTWARE;
}
}
private boolean hasImpactedFeatures(Environment environment)
{
if (impactedFeatures.isEmpty()) {
return true;
}
if (impactedFeatures.get().isEmpty()) {
return false;
}
Map> featuresByName = impactedFeatures.get().stream().collect(groupingBy(feature -> {
String[] parts = feature.split(":", 2);
return parts.length < 1 ? "" : parts[0];
}, mapping(feature -> {
String[] parts = feature.split(":", 2);
return parts.length < 2 ? "" : parts[1];
}, toList())));
// see PluginReader. printPluginFeatures() for all possible feature prefixes
Map> environmentFeaturesByName = environment.getConfiguredFeatures();
for (Map.Entry> entry : featuresByName.entrySet()) {
String name = entry.getKey();
List features = entry.getValue();
if (!environmentFeaturesByName.containsKey(name)) {
return true;
}
List environmentFeatures = environmentFeaturesByName.get(name);
log.info("Checking if impacted %s %s are overlapping with %s configured in the environment",
name, features, environmentFeatures);
if (environmentFeatures.stream().anyMatch(features::contains)) {
return true;
}
}
return false;
}
private Environment startEnvironment(Environment environment)
{
Collection allContainers = environment.getContainers();
DockerContainer testsContainer = environment.getContainer(TESTS);
if (!attach) {
// Reestablish dependency on every startEnvironment attempt
Collection environmentContainers = allContainers.stream()
.filter(container -> !container.equals(testsContainer))
.collect(toImmutableList());
testsContainer.dependsOn(environmentContainers);
log.info("Starting environment '%s' with config '%s' and options '%s'. Trino will be started using JAVA_HOME: %s.", this.environment, environmentConfig.getConfigName(), extraOptions, jdkProvider.getJavaHome());
environment.start();
}
else {
testsContainer.setNetwork(new ExistingNetwork(Environment.PRODUCT_TEST_LAUNCHER_NETWORK));
// TODO prune previous ptl-tests container
testsContainer.start();
}
return environment;
}
private Environment getEnvironment()
{
Environment.Builder builder = environmentFactory.get(environment, printStream, environmentConfig, extraOptions)
.setContainerOutputMode(outputMode)
.setStartupRetries(startupRetries)
.setLogsBaseDir(logsDirBase);
builder.configureContainer(TESTS, this::mountReportsDir);
builder.configureContainer(TESTS, container -> {
List temptoJavaOptions = Splitter.on(" ").omitEmptyStrings().splitToList(
container.getEnvMap().getOrDefault("TEMPTO_JAVA_OPTS", ""));
if (debug) {
temptoJavaOptions = new ArrayList<>(temptoJavaOptions);
temptoJavaOptions.add(format("-agentlib:jdwp=transport=dt_socket,server=y,suspend=%s,address=0.0.0.0:5007", debugSuspend ? "y" : "n"));
unsafelyExposePort(container, 5007); // debug port
}
if (System.getenv("CONTINUOUS_INTEGRATION") != null) {
container.withEnv("CONTINUOUS_INTEGRATION", "true");
}
// Install Java distribution if necessary
jdkProvider.applyTo(container)
// the test jar is hundreds MB and file system bind is much more efficient
.withFileSystemBind(testJar.getPath(), "/docker/test.jar", READ_ONLY)
.withFileSystemBind(cliJar.getPath(), "/docker/trino-cli", READ_ONLY)
.withCopyFileToContainer(forClasspathResource("docker/presto-product-tests/common/standard/set-trino-cli.sh"), "/etc/profile.d/set-trino-cli.sh")
.withEnv("JAVA_HOME", jdkProvider.getJavaHome())
.withCommand(ImmutableList.builder()
.add(
jdkProvider.getJavaCommand(),
"-Xmx1g",
"-Djava.util.logging.config.file=/docker/presto-product-tests/conf/tempto/logging.properties",
"-Duser.timezone=Asia/Kathmandu",
// Tempto has progress logging built in
"-DProgressLoggingListener.enabled=false")
.addAll(temptoJavaOptions)
.add(
"-jar", "/docker/test.jar",
"--config", String.join(",", ImmutableList.builder()
.add("tempto-configuration.yaml") // this comes from classpath
.add("/docker/presto-product-tests/conf/tempto/tempto-configuration-for-docker-default.yaml")
.add(CONTAINER_TEMPTO_PROFILE_CONFIG)
.add(environmentConfig.getTemptoEnvironmentConfigFile())
.add(container.getEnvMap().getOrDefault("TEMPTO_CONFIG_FILES", "/dev/null"))
.build()))
.addAll(testArguments)
.addAll(reportsDirOptions(reportsDirBase))
.build().toArray(new String[0]));
});
builder.setAttached(attach);
return builder.build(getStandardListeners(logsDirBase));
}
private static Iterable reportsDirOptions(Path path)
{
if (isNullOrEmpty(path.toString())) {
return ImmutableList.of();
}
return ImmutableList.of("--report-dir", CONTAINER_REPORTS_DIR);
}
private void mountReportsDir(DockerContainer container)
{
if (isNullOrEmpty(reportsDirBase.toString())) {
return;
}
cleanOrCreateHostPath(reportsDirBase);
container.withFileSystemBind(reportsDirBase.toString(), CONTAINER_REPORTS_DIR, READ_WRITE);
log.info("Exposing tests report dir in host directory '%s'", reportsDirBase);
}
}
}
