Skip to content

Commit 7cb8ef5

Browse files
Roberto Franchinirnorthbsideup
authored
adds OrientDB 3.0.x module (#1414)
 Co-authored-by: Richard North <[email protected]> Co-authored-by: Sergei Egorov <[email protected]>
1 parent d4d9bea commit 7cb8ef5

File tree

6 files changed

+339
-0
lines changed

6 files changed

+339
-0
lines changed

‎docs/modules/databases/orientdb.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# OrientDB Module
2+
3+
!!! note
4+
This module is INCUBATING. While it is ready for use and operational in the current version of Testcontainers, it is possible that it may receive breaking changes in the future. See [our contributing guidelines](/contributing/#incubating-modules) for more information on our incubating modules policy.
5+
6+
7+
This module helps running [OrientDB](https://orientdb.org/download) using Testcontainers.
8+
9+
Note that it's based on the [official Docker image](https://hub.docker.com/_/orientdb/) provided by OrientDB.
10+
11+
## Usage example
12+
13+
Declare your Testcontainer as a `@ClassRule` or `@Rule` in a JUnit 4 test or as static or member attribute of a JUnit 5 test annotated with `@Container` as you would with other Testcontainers.
14+
You can call `getDbUrl()` OrientDB container and build the `ODatabaseSession` by your own, but a more useful `getSession()` method is provided.
15+
On the JVM you would most likely use the [Java driver](https://github.com/).
16+
17+
The following example uses the JUnit 5 extension `@Testcontainers` and demonstrates both the usage of the Java Client:
18+
19+
```java tab="JUnit 5 example"
20+
@Testcontainers
21+
public class ExampleTest {
22+
23+
@Container
24+
private static OrientDBContainer container = new OrientDBContainer();
25+
26+
@Test
27+
void testDbCreation() {
28+
29+
final ODatabaseSession session = container.getSession();
30+
31+
session.command("CREATE CLASS Person EXTENDS V");
32+
session.command("INSERT INTO Person set name='john'");
33+
session.command("INSERT INTO Person set name='jane'");
34+
35+
assertThat(session.query("SELECT FROM Person").stream()).hasSize(2);
36+
}
37+
38+
}
39+
```
40+
41+
You are not limited to Unit tests and can of course use an instance of the OrientDB Testcontainer in vanilla Java code as well.
42+
43+
44+
## Adding this module to your project dependencies
45+
46+
Add the following dependency to your `pom.xml`/`build.gradle` file:
47+
48+
```groovy tab='Gradle'
49+
testCompile "org.testcontainers:orientdb:{{latest_version}}"
50+
```
51+
52+
```xml tab='Maven'
53+
<dependency>
54+
<groupId>org.testcontainers</groupId>
55+
<artifactId>orientdb</artifactId>
56+
<version>{{latest_version}}</version>
57+
<scope>test</scope>
58+
</dependency>
59+
```
60+
61+
!!! hint
62+
Add the OrientDB Java client if you plan to access the Testcontainer:
63+
64+
```groovy tab='Gradle'
65+
compile "com.orientechnologies:orientdb-client:3.0.24"
66+
```
67+
68+
```xml tab='Maven'
69+
<dependency>
70+
<groupId>com.orientechnologies</groupId>
71+
<artifactId>orientdb-client</artifactId>
72+
<version>3.0.24</version>
73+
</dependency>
74+
```
75+
76+
77+
78+

‎modules/orientdb/build.gradle

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
description = "TestContainers :: Orientdb"
2+
3+
dependencies {
4+
compile project(":testcontainers")
5+
6+
compile "com.orientechnologies:orientdb-client:3.0.24"
7+
8+
testCompile 'org.assertj:assertj-core:3.12.0'
9+
testCompile 'org.apache.tinkerpop:gremlin-driver:3.3.4'
10+
testCompile "com.orientechnologies:orientdb-gremlin:3.0.18"
11+
}

‎modules/orientdb/src/main/java/org/testcontainers/containers/OrientDBContainer.java

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
package org.testcontainers.containers;
2+
3+
import com.github.dockerjava.api.command.InspectContainerResponse;
4+
import com.orientechnologies.orient.core.db.ODatabaseSession;
5+
import com.orientechnologies.orient.core.db.ODatabaseType;
6+
import com.orientechnologies.orient.core.db.OrientDB;
7+
import com.orientechnologies.orient.core.db.OrientDBConfig;
8+
import lombok.NonNull;
9+
import org.apache.commons.io.IOUtils;
10+
import org.slf4j.Logger;
11+
import org.slf4j.LoggerFactory;
12+
import org.testcontainers.containers.wait.strategy.HttpWaitStrategy;
13+
import org.testcontainers.containers.wait.strategy.Wait;
14+
import org.testcontainers.containers.wait.strategy.WaitAllStrategy;
15+
import org.testcontainers.containers.wait.strategy.WaitStrategy;
16+
17+
import java.io.IOException;
18+
import java.net.URL;
19+
import java.nio.charset.StandardCharsets;
20+
import java.time.Duration;
21+
import java.util.Optional;
22+
23+
import static java.net.HttpURLConnection.HTTP_OK;
24+
25+
/**
26+
* @author robfrank
27+
*/
28+
public class OrientDBContainer extends GenericContainer<OrientDBContainer> {
29+
private static final Logger LOGGER = LoggerFactory.getLogger(OrientDBContainer.class);
30+
31+
private static final String DEFAULT_IMAGE_NAME = "orientdb";
32+
private static final String DEFAULT_TAG = "3.0.24-tp3";
33+
private static final String DOCKER_IMAGE_NAME = DEFAULT_IMAGE_NAME + ":" + DEFAULT_TAG;
34+
35+
private static final String DEFAULT_USERNAME = "admin";
36+
private static final String DEFAULT_PASSWORD = "admin";
37+
private static final String DEFAULT_SERVER_PASSWORD = "root";
38+
39+
private static final String DEFAULT_DATABASE_NAME = "testcontainers";
40+
41+
private static final int DEFAULT_BINARY_PORT = 2424;
42+
private static final int DEFAULT_HTTP_PORT = 2480;
43+
44+
private String databaseName;
45+
private String serverPassword;
46+
private Optional<String> scriptPath = Optional.empty();
47+
48+
private OrientDB orientDB;
49+
private ODatabaseSession session;
50+
51+
public OrientDBContainer() {
52+
this(DOCKER_IMAGE_NAME);
53+
}
54+
55+
public OrientDBContainer(@NonNull String dockerImageName) {
56+
super(dockerImageName);
57+
58+
serverPassword = DEFAULT_SERVER_PASSWORD;
59+
databaseName = DEFAULT_DATABASE_NAME;
60+
61+
WaitStrategy waitForHttp = new HttpWaitStrategy()
62+
.forPort(DEFAULT_HTTP_PORT)
63+
.forStatusCodeMatching(response -> response == HTTP_OK);
64+
65+
waitStrategy = new WaitAllStrategy()
66+
.withStrategy(Wait.forListeningPort())
67+
.withStrategy(waitForHttp)
68+
.withStartupTimeout(Duration.ofMinutes(2));
69+
}
70+
71+
@Override
72+
protected void configure() {
73+
addExposedPorts(DEFAULT_BINARY_PORT, DEFAULT_HTTP_PORT);
74+
addEnv("ORIENTDB_ROOT_PASSWORD", serverPassword);
75+
}
76+
77+
public String getDatabaseName() {
78+
return databaseName;
79+
}
80+
81+
public String getTestQueryString() {
82+
return "SELECT FROM V";
83+
}
84+
85+
public OrientDBContainer withDatabaseName(final String databaseName) {
86+
this.databaseName = databaseName;
87+
return self();
88+
}
89+
90+
public OrientDBContainer withServerPassword(final String serverPassword) {
91+
this.serverPassword = serverPassword;
92+
return self();
93+
}
94+
95+
public OrientDBContainer withScriptPath(String scriptPath) {
96+
this.scriptPath = Optional.of(scriptPath);
97+
return self();
98+
}
99+
100+
@Override
101+
protected void containerIsStarted(InspectContainerResponse containerInfo) {
102+
orientDB = new OrientDB(getServerUrl(), "root", serverPassword, OrientDBConfig.defaultConfig());
103+
}
104+
105+
public OrientDB getOrientDB() {
106+
return orientDB;
107+
}
108+
109+
public String getServerUrl() {
110+
return "remote:" + getContainerIpAddress() + ":" + getMappedPort(2424);
111+
}
112+
113+
public String getDbUrl() {
114+
return getServerUrl() + "/" + databaseName;
115+
}
116+
117+
public ODatabaseSession getSession() {
118+
return getSession(DEFAULT_USERNAME, DEFAULT_PASSWORD);
119+
}
120+
121+
public synchronized ODatabaseSession getSession(String username, String password) {
122+
orientDB.createIfNotExists(databaseName, ODatabaseType.PLOCAL);
123+
124+
if (session == null) {
125+
session = orientDB.open(databaseName, username, password);
126+
127+
scriptPath.ifPresent(path -> loadScript(path, session));
128+
}
129+
return session;
130+
}
131+
132+
private void loadScript(String path, ODatabaseSession session) {
133+
try {
134+
URL resource = getClass().getClassLoader().getResource(path);
135+
136+
if (resource == null) {
137+
LOGGER.warn("Could not load classpath init script: {}", scriptPath);
138+
throw new RuntimeException("Could not load classpath init script: " + scriptPath + ". Resource not found.");
139+
}
140+
141+
String script = IOUtils.toString(resource, StandardCharsets.UTF_8);
142+
143+
session.execute("sql", script);
144+
} catch (IOException e) {
145+
LOGGER.warn("Could not load classpath init script: {}", scriptPath);
146+
throw new RuntimeException("Could not load classpath init script: " + scriptPath, e);
147+
} catch (UnsupportedOperationException e) {
148+
LOGGER.error("Error while executing init script: {}", scriptPath, e);
149+
throw new RuntimeException("Error while executing init script: " + scriptPath, e);
150+
}
151+
}
152+
153+
}

‎modules/orientdb/src/test/java/org/testcontainers/containers/OrientDBContainerTest.java

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
package org.testcontainers.containers;
2+
3+
import com.orientechnologies.orient.core.db.ODatabaseSession;
4+
import org.junit.Test;
5+
6+
import static org.assertj.core.api.Assertions.*;
7+
8+
/**
9+
* @author robfrank
10+
*/
11+
public class OrientDBContainerTest {
12+
13+
@Test
14+
public void shouldReturnTheSameSession() {
15+
try (OrientDBContainer container = new OrientDBContainer()) {
16+
container.start();
17+
18+
final ODatabaseSession session = container.getSession();
19+
final ODatabaseSession session2 = container.getSession();
20+
21+
assertThat(session).isSameAs(session2);
22+
}
23+
}
24+
25+
@Test
26+
public void shouldInitializeWithCommands() {
27+
try (OrientDBContainer container = new OrientDBContainer()) {
28+
container.start();
29+
30+
final ODatabaseSession session = container.getSession();
31+
32+
session.command("CREATE CLASS Person EXTENDS V");
33+
session.command("INSERT INTO Person set name='john'");
34+
session.command("INSERT INTO Person set name='jane'");
35+
36+
assertThat(session.query("SELECT FROM Person").stream()).hasSize(2);
37+
}
38+
}
39+
40+
@Test
41+
public void shouldQueryWithGremlin() {
42+
43+
try (OrientDBContainer container = new OrientDBContainer()) {
44+
container.start();
45+
46+
final ODatabaseSession session = container.getSession("admin", "admin");
47+
48+
session.command("CREATE CLASS Person EXTENDS V");
49+
session.command("INSERT INTO Person set name='john'");
50+
session.command("INSERT INTO Person set name='jane'");
51+
52+
assertThat(session.execute("gremlin",
53+
"g.V().hasLabel('Person')").stream()).hasSize(2);
54+
}
55+
}
56+
57+
@Test
58+
public void shouldInitializeDatabaseFromScript() {
59+
try (OrientDBContainer container = new OrientDBContainer()
60+
.withScriptPath("initscript.osql")
61+
.withDatabaseName("persons")) {
62+
63+
container.start();
64+
65+
assertThat(container.getDbUrl())
66+
.isEqualTo("remote:" + container.getContainerIpAddress() + ":" + container.getMappedPort(2424) + "/persons");
67+
68+
final ODatabaseSession session = container.getSession();
69+
70+
assertThat(session.query("SELECT FROM Person").stream()).hasSize(4);
71+
}
72+
}
73+
}

‎modules/orientdb/src/test/resources/initscript.osql

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
CREATE CLASS Person EXTENDS V;
2+
3+
INSERT INTO Person set name="john";
4+
INSERT INTO Person set name="paul";
5+
INSERT INTO Person set name="luke";
6+
INSERT INTO Person set name="albert";

‎modules/orientdb/src/test/resources/logback-test.xml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<configuration>
2+
3+
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
4+
<!-- encoders are assigned the type
5+
ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
6+
<encoder>
7+
<pattern>%d{HH:mm:ss.SSS} %-5level %logger - %msg%n</pattern>
8+
</encoder>
9+
</appender>
10+
11+
<root level="INFO">
12+
<appender-ref ref="STDOUT"/>
13+
</root>
14+
15+
<logger name="org.testcontainers" level="DEBUG"/>
16+
<logger name="org.testcontainers.shaded" level="WARN"/>
17+
18+
</configuration>

0 commit comments

Comments
 (0)