Skip to content

Testcontainers Java sample: fix test assertions and wait loop, modernize JDBC/JUnit, and clean up POM #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Testcontainers Java sample: fix test assertions and wait loop, modernize JDBC/JUnit, and clean up POM #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 4 additions & 15 deletions testcontainers-java-sample/LocalStackTestcontainers/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>bom</artifactId>
<version>2.17.224</version>
<version>2.25.62</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand All @@ -27,7 +27,7 @@
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<version>4.13.2</version>
<scope>test</scope>
</dependency>
<dependency>
Expand All @@ -38,10 +38,6 @@
<groupId>software.amazon.awssdk</groupId>
<artifactId>rds</artifactId>
</dependency>
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>s3</artifactId>
</dependency>
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>cognitoidentity</artifactId>
Expand All @@ -53,20 +49,13 @@
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>localstack</artifactId>
<version>1.19.2</version>
<scope>test</scope>

</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-s3</artifactId>
<version>1.11.914</version>
<version>1.20.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>9.3-1100-jdbc4</version>
<version>42.7.4</version>
</dependency>
</dependencies>
<build>
Expand Down
35 changes: 17 additions & 18 deletions testcontainers-java-sample/LocalStackTestcontainers/src/main/java/RDS.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,28 +24,27 @@ protected static String test_connection(String hostname, Integer port, String db
String url = String.format("jdbc:postgresql://%s:%d/%s", hostname, port, dbname);
c = DriverManager.getConnection(url, DEFAULT_USER, DEFAULT_PW);
c.setAutoCommit(true);
Statement stmt = c.createStatement();
String sql = "CREATE TABLE HELLO " +
"(ID INT PRIMARY KEY NOT NULL," +
" NAME TEXT NOT NULL) ";
stmt.executeUpdate(sql);
try (Statement stmt = c.createStatement()) {
String sql = "CREATE TABLE HELLO " +
"(ID INT PRIMARY KEY NOT NULL," +
" NAME TEXT NOT NULL) ";
stmt.executeUpdate(sql);

sql = "INSERT INTO HELLO (ID,NAME) "
+ "VALUES (1, 'world');";
stmt.executeUpdate(sql);
ResultSet rs = stmt.executeQuery( "SELECT * FROM HELLO;" );
String response = "";
while( rs.next()) {
int id = rs.getInt("id");
String name = rs.getString("name");
response += String.format("ID = %d\nNAME = %s", id, name);
sql = "INSERT INTO HELLO (ID,NAME) VALUES (1, 'world');";
stmt.executeUpdate(sql);
String response = "";
try (ResultSet rs = stmt.executeQuery("SELECT * FROM HELLO;")) {
while (rs.next()) {
int id = rs.getInt("id");
String name = rs.getString("name");
response += String.format("ID = %d\nNAME = %s", id, name);
}
}
return response;
}
rs.close();
stmt.close();
return response;
} finally {
try {
c.close();
if (c != null) c.close();
} catch (SQLException e) {
// we can ignore error here
}
Expand Down
24 changes: 18 additions & 6 deletions testcontainers-java-sample/LocalStackTestcontainers/src/test/java/TestRDS.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ public class TestRDS {
*/
@Rule
public LocalStackContainer localstack = new LocalStackContainer(localstackImage)
.withExposedPorts(4510, 4511, 4512, 4513, 4514) // TODO the port can have any value between 4510-4559, but LS starts from 4510
.withEnv("LOCALSTACK_AUTH_TOKEN", api_key) // TODO add your Auth Token here
.withServices(LocalStackContainer.EnabledService.named("rds"));
.withExposedPorts(4510, 4511, 4512, 4513, 4514) // TODO the port can have any value between 4510-4559, but LS starts from 4510
.withEnv("LOCALSTACK_AUTH_TOKEN", api_key) // TODO add your Auth Token here
.withServices(LocalStackContainer.EnabledService.named("rds"));


@Test
Expand All @@ -51,8 +51,19 @@ public void testRds() throws UnknownHostException, URISyntaxException {
DescribeDbInstancesRequest request = DescribeDbInstancesRequest.builder().dbInstanceIdentifier(identifier).build();
DescribeDbInstancesResponse describedb = rds.describeDBInstances(request);

// wait for db to be ready
while(! describedb.dbInstances().get(0).dbInstanceStatus().equalsIgnoreCase("available")) {
// wait for db to be ready with a small backoff and a timeout to avoid busy-waiting
long start = System.currentTimeMillis();
long timeoutMs = 30_000; // 30s
while (!describedb.dbInstances().get(0).dbInstanceStatus().equalsIgnoreCase("available")) {
if (System.currentTimeMillis() - start > timeoutMs) {
fail("Timed out waiting for RDS instance to become available");
}
try {
Thread.sleep(200);
} catch (InterruptedException ie) {
Thread.currentThread().interrupt();
fail("Interrupted while waiting for RDS instance to become available");
}
describedb = rds.describeDBInstances(request);
}

Expand All @@ -65,7 +76,8 @@ public void testRds() throws UnknownHostException, URISyntaxException {
// try to connect to database in our example we simply insert some dummy data
String actual = RDS.test_connection(localstack.getHost(), mapped_port, "hello");
String expected = "ID = 1\nNAME = world";
assertEquals(actual, expected);
// JUnit expects (expected, actual)
assertEquals(expected, actual);
} catch (Exception e) {
fail("testing connection with database failed");
}
Expand Down
22 changes: 15 additions & 7 deletions testcontainers-java-sample/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
# Example using RDS with Localstack Testcontainers

Testcontainers need a special setup to use services like RDS, which may use any port to expose the database.
The sample explains how the mapping works, and how you need to configure Testcontainers in order to connect to the RDS instance from your test.
Testcontainers need a special setup to use services like RDS, which may use any port to expose the database. The sample explains how the mapping works, and how you need to configure Testcontainers in order to connect to the RDS instance from your test.

## Prerequisites
- Docker running
- JDK 11+
- Maven 3.8+
- LocalStack Pro Auth Token in `LOCALSTACK_AUTH_TOKEN`

## Run Example
* Import the project (e.g. in IntelliJ),
* configure your LOCALSTACK_AUTH_TOKEN as environment variable,
* and then run the test `TestRDS`.
You can run the JUnit test either in your IDE or from the command line:

```
cd testcontainers-java-sample/LocalStackTestcontainers
export LOCALSTACK_AUTH_TOKEN=... # required for RDS (Pro feature)
mvn -q -Dtest=TestRDS test
```

It will create a LocalStack Testcontainer and a postgres database instance using RDSClient.
The database will then be filled with some data, and queried afterwards.
This will start a LocalStack Testcontainers instance, create a Postgres database via the RDS client, insert a row, and query it.