apoc.util.TestContainerUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apoc-test-utils Show documentation
Show all versions of apoc-test-utils Show documentation
Test utils for Neo4j Procedures
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* 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 apoc.util;
import static apoc.util.TestUtil.printFullStackTrace;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import com.github.dockerjava.api.exception.NotFoundException;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.time.Duration;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.filefilter.IOFileFilter;
import org.apache.commons.io.filefilter.WildcardFileFilter;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.assertj.core.description.LazyTextDescription;
import org.gradle.tooling.BuildLauncher;
import org.gradle.tooling.GradleConnector;
import org.gradle.tooling.ProjectConnection;
import org.neo4j.driver.Record;
import org.neo4j.driver.Session;
import org.testcontainers.containers.ContainerFetchException;
import org.testcontainers.utility.MountableFile;
public class TestContainerUtil {
public enum Neo4jVersion {
ENTERPRISE,
COMMUNITY
}
public enum ApocPackage {
CORE,
EXTENDED
}
public static final String APOC_TEST_DOCKER_BUNDLE = "testDockerBundle";
// read neo4j version from build.gradle
public static final String neo4jEnterpriseDockerImageVersion = System.getProperty("neo4jDockerImage");
public static final String neo4jCommunityDockerImageVersion = System.getProperty("neo4jCommunityDockerImage");
public static final String password = "apoc12345";
private TestContainerUtil() {}
public static File baseDir = Paths.get("..").toFile();
public static File pluginsFolder = new File(baseDir, "build/plugins");
public static File importFolder = new File(baseDir, "build/import");
private static File coreDir = new File(baseDir, System.getProperty("coreDir"));
public static File extendedDir = new File(baseDir, "extended");
public static String dockerImageForNeo4j(Neo4jVersion version) {
if (version == Neo4jVersion.COMMUNITY) return neo4jCommunityDockerImageVersion;
else return neo4jEnterpriseDockerImageVersion;
}
public static TestcontainersCausalCluster createEnterpriseCluster(
List apocPackages,
int numOfCoreInstances,
int numberOfReadReplica,
Map neo4jConfig,
Map envSettings) {
return TestcontainersCausalCluster.create(
apocPackages, numOfCoreInstances, numberOfReadReplica, Duration.ofMinutes(4), neo4jConfig, envSettings);
}
public static Neo4jContainerExtension createDB(
Neo4jVersion version, List apocPackages, boolean withLogging) {
return switch (version) {
case ENTERPRISE -> createEnterpriseDB(apocPackages, withLogging);
case COMMUNITY -> createCommunityDB(apocPackages, withLogging);
};
}
public static Neo4jContainerExtension createEnterpriseDB(List apocPackages, boolean withLogging) {
return createNeo4jContainer(apocPackages, withLogging, Neo4jVersion.ENTERPRISE);
}
public static Neo4jContainerExtension createCommunityDB(List apocPackages, boolean withLogging) {
return createNeo4jContainer(apocPackages, withLogging, Neo4jVersion.COMMUNITY);
}
private static Neo4jContainerExtension createNeo4jContainer(
List apocPackages, boolean withLogging, Neo4jVersion version) {
String dockerImage;
if (version == Neo4jVersion.ENTERPRISE) {
dockerImage = neo4jEnterpriseDockerImageVersion;
} else {
dockerImage = neo4jCommunityDockerImageVersion;
}
try {
FileUtils.deleteDirectory(pluginsFolder);
} catch (IOException e) {
e.printStackTrace();
}
File projectDir;
// We define the container with external volumes
importFolder.mkdirs();
// use a separate folder for mounting plugins jar - build/libs might contain other jars as well.
pluginsFolder.mkdirs();
String canonicalPath = null;
final Path logsDir;
try {
logsDir = Files.createTempDirectory("neo4j-logs");
} catch (IOException e) {
throw new RuntimeException(e);
}
try {
canonicalPath = importFolder.getCanonicalPath();
} catch (IOException e) {
e.printStackTrace();
}
boolean testDockerBundle = System.getProperty(APOC_TEST_DOCKER_BUNDLE).equals("true");
if (!testDockerBundle) {
for (ApocPackage apocPackage : apocPackages) {
if (apocPackage == ApocPackage.CORE) {
projectDir = coreDir;
} else {
projectDir = extendedDir;
}
executeGradleTasks(projectDir, "shadowJar");
copyFilesToPlugin(
new File(projectDir, "build/libs"),
new WildcardFileFilter(Arrays.asList("*-extended.jar", "*-core.jar")),
pluginsFolder);
}
}
if (testDockerBundle && apocPackages.contains(ApocPackage.EXTENDED)) {
throw new IllegalArgumentException("You cannot run these tests with apoc extended bundled inside "
+ "the docker container because only apoc core comes bundled in those");
}
System.out.println("neo4jDockerImageVersion = " + dockerImage);
Neo4jContainerExtension neo4jContainer = new Neo4jContainerExtension(dockerImage, logsDir)
.withAdminPassword(password)
.withEnv("NEO4J_ACCEPT_LICENSE_AGREEMENT", "yes")
.withEnv("apoc.export.file.enabled", "true")
.withEnv("apoc.import.file.enabled", "true")
.withNeo4jConfig("server.memory.heap.max_size", "512M")
.withNeo4jConfig("server.memory.pagecache.size", "256M")
.withNeo4jConfig("dbms.security.procedures.unrestricted", "apoc.*")
.withNeo4jConfig("dbms.logs.http.enabled", "true")
.withNeo4jConfig("dbms.logs.debug.level", "DEBUG")
.withNeo4jConfig("dbms.routing.driver.logging.level", "DEBUG")
.withFileSystemBind(logsDir.toString(), "/logs")
.withFileSystemBind(
canonicalPath, "/var/lib/neo4j/import") // map the "target/import" dir as the Neo4j's import dir
.withCreateContainerCmdModifier(cmd -> cmd.withMemory(2024 * 1024 * 1024L)) // 2gb
.withExposedPorts(7687, 7473, 7474)
// .withDebugger() // attach debugger
.withStartupAttempts(1)
// set uid if possible - export tests do write to "/import"
.withCreateContainerCmdModifier(cmd -> {
try {
Process p = Runtime.getRuntime().exec("id -u");
BufferedReader br = new BufferedReader(new InputStreamReader(p.getInputStream()));
String s = br.readLine();
p.waitFor();
p.destroy();
cmd.withUser(s);
} catch (Exception e) {
System.out.println("Exception while assign cmd user to docker container:\n"
+ ExceptionUtils.getStackTrace(e));
// ignore since it may fail depending on operating system
}
});
if (withLogging) {
neo4jContainer.withLogging();
}
if (testDockerBundle) {
neo4jContainer.withEnv("NEO4J_PLUGINS", "[\"apoc\"]");
} else {
neo4jContainer.withPlugins(MountableFile.forHostPath(pluginsFolder.toPath()));
}
return neo4jContainer.withWaitForNeo4jDatabaseReady(password, version);
}
public static void copyFilesToPlugin(File directory, IOFileFilter instance, File pluginsFolder) {
Collection files = FileUtils.listFiles(directory, instance, null);
for (File file : files) {
try {
FileUtils.copyFileToDirectory(file, pluginsFolder);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
public static void executeGradleTasks(File baseDir, String... tasks) {
try (ProjectConnection connection = GradleConnector.newConnector()
.forProjectDirectory(baseDir)
.useBuildDistribution()
.connect()) {
BuildLauncher buildLauncher = connection.newBuild().forTasks(tasks);
String neo4jVersionOverride = System.getenv("NEO4JVERSION");
System.out.println("neo4jVersionOverride = " + neo4jVersionOverride);
if (neo4jVersionOverride != null) {
buildLauncher = buildLauncher.addArguments("-P", "neo4jVersionOverride=" + neo4jVersionOverride);
}
String localMaven = System.getenv("LOCAL_MAVEN");
System.out.println("localMaven = " + localMaven);
if (localMaven != null) {
buildLauncher = buildLauncher.addArguments("-D", "maven.repo.local=" + localMaven);
}
buildLauncher.run();
}
}
public static void testCall(
Session session, String call, Map params, Consumer> consumer) {
testResult(session, call, params, (res) -> {
try {
assertNotNull("result should be not null", res);
assertTrue("result should be not empty", res.hasNext());
Map row = res.next();
consumer.accept(row);
assertFalse("result should not have next", res.hasNext());
} catch (Throwable t) {
printFullStackTrace(t);
throw t;
}
});
}
public static void testCall(Session session, String call, Consumer> consumer) {
testCall(session, call, null, consumer);
}
public static void testResult(
Session session, String call, Consumer>> resultConsumer) {
testResult(session, call, null, resultConsumer);
}
public static void testResult(
Session session,
String call,
Map params,
Consumer>> resultConsumer) {
session.executeWrite(tx -> {
Map p = (params == null) ? Collections.emptyMap() : params;
final var result = tx.run(call, p).list();
assertThat(result)
.describedAs(describe(call, params, result))
.satisfies(r ->
resultConsumer.accept(r.stream().map(Record::asMap).iterator()));
return null;
});
}
private static LazyTextDescription describe(final String cypher, Map params, List result) {
return new LazyTextDescription(() -> {
final var resultString = result.stream().map(Record::toString).collect(Collectors.joining("\n"));
return """
Cypher: %s
Params: %s
Results (%s rows):
%s"""
.formatted(cypher, params, result.size(), resultString);
});
}
public static void testCallEmpty(Session session, String call, Map params) {
final var resultCount = session.run(call, params).stream().count();
assertEquals(0, resultCount);
}
public static void testCallInReadTransaction(
Session session, String call, Map params, Consumer> consumer) {
testResultInReadTransaction(session, call, params, (res) -> {
try {
assertNotNull("result should be not null", res);
assertTrue("result should be not empty", res.hasNext());
Map row = res.next();
consumer.accept(row);
assertFalse("result should not have next", res.hasNext());
} catch (Throwable t) {
printFullStackTrace(t);
throw t;
}
});
}
public static void testResultInReadTransaction(
Session session,
String call,
Map params,
Consumer>> resultConsumer) {
session.executeRead(tx -> {
Map p = (params == null) ? Collections.emptyMap() : params;
resultConsumer.accept(tx.run(call, p).list().stream()
.map(Record::asMap)
.collect(Collectors.toList())
.iterator());
return null;
});
}
public static boolean isDockerImageAvailable(Exception ex) {
final Throwable cause = ex.getCause();
final Throwable rootCause = ExceptionUtils.getRootCause(ex);
return !(cause instanceof ContainerFetchException && rootCause instanceof NotFoundException);
}
}