Skip to content
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.

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

Implement QuestDB Test container module #5995

Merged
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Expand Up @@ -41,6 +41,7 @@ body:
- PostgreSQL
- Presto
- Pulsar
- QuestDB
- RabbitMQ
- Redpanda
- Selenium
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yaml
Expand Up @@ -41,6 +41,7 @@ body:
- PostgreSQL
- Presto
- Pulsar
- QuestDB
- RabbitMQ
- Redpanda
- Selenium
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/feature.yaml
Expand Up @@ -39,6 +39,7 @@ body:
- Oracle-XE
- OrientDB
- PostgreSQL
- QuestDB
- Presto
- Pulsar
- RabbitMQ
Expand Down
5 changes: 5 additions & 0 deletions .github/dependabot.yml
Expand Up @@ -195,6 +195,11 @@ updates:
schedule:
interval: "monthly"
open-pull-requests-limit: 10
- package-ecosystem: "gradle"
directory: "/modules/questdb"
schedule:
interval: "monthly"
open-pull-requests-limit: 10
- package-ecosystem: "gradle"
directory: "/modules/r2dbc"
schedule:
Expand Down
2 changes: 2 additions & 0 deletions .github/labeler.yml
Expand Up @@ -65,6 +65,8 @@
- modules/presto/*
"modules/pulsar":
- modules/pulsar/*
"modules/questdb":
- modules/questdb/*
"modules/r2dbc":
- modules/r2dbc/*
"modules/rabbitmq":
Expand Down
9 changes: 9 additions & 0 deletions docs/modules/databases/questdb.md
@@ -0,0 +1,9 @@
# Dynalite Module
Vangreen marked this conversation as resolved.
Show resolved Hide resolved

Testcontainers module for [QuestDB](https://github.com/questdb/questdb). QuestDB is a high-performance, open-source SQL database for applications in financial services, IoT, machine learning, DevOps and observability.

See [Database containers](./index.md) for documentation and usage that is common to all relational database container types.

## Adding this module to your project dependencies

[//]: # (placeholder)
1 change: 1 addition & 0 deletions mkdocs.yml
Expand Up @@ -63,6 +63,7 @@ nav:
- modules/databases/orientdb.md
- modules/databases/postgres.md
- modules/databases/presto.md
- modules/databases/questdb.md
- modules/databases/tidb.md
- modules/databases/trino.md
- modules/azure.md
Expand Down
10 changes: 10 additions & 0 deletions modules/questdb/build.gradle
@@ -0,0 +1,10 @@
description = "Testcontainers :: QuestDB"

dependencies {
api project(':testcontainers')
api project(':jdbc')

testImplementation 'org.postgresql:postgresql:42.5.0'
testImplementation project(':jdbc-test')
testImplementation 'org.assertj:assertj-core:3.23.1'
}
@@ -0,0 +1,88 @@
package org.testcontainers.containers;

import lombok.NonNull;
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.utility.DockerImageName;

public class QuestDBContainer extends JdbcDatabaseContainer<QuestDBContainer> {
Vangreen marked this conversation as resolved.
Show resolved Hide resolved

public static final String DATABASE_PROVIDER = "postgresql";
Vangreen marked this conversation as resolved.
Show resolved Hide resolved

private static final String DEFAULT_TAG = "6.5.3";

private static final String DEFAULT_DATABASE_NAME = "qdb";

private static final String DEFAULT_USERNAME = "admin";

private static final String DEFAULT_PASSWORD = "quest";

public static final Integer POSTGRES_PORT = 8812;

public static final Integer REST_PORT = 9000;

public static final Integer ILP_PORT = 9009;

public static final String TEST_QUERY = "SELECT 1";
Vangreen marked this conversation as resolved.
Show resolved Hide resolved

private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("questdb/questdb");

@Deprecated
public static final String IMAGE = DEFAULT_IMAGE_NAME.getUnversionedPart();

@Deprecated
public QuestDBContainer() {
this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
}
Vangreen marked this conversation as resolved.
Show resolved Hide resolved

public QuestDBContainer(@NonNull String dockerImageName) {
super(dockerImageName);
Vangreen marked this conversation as resolved.
Show resolved Hide resolved
}

public QuestDBContainer(DockerImageName dockerImageName) {
super(dockerImageName);
dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME);
this.withExposedPorts(POSTGRES_PORT, REST_PORT, ILP_PORT);
this.waitingFor(Wait.forLogMessage("(?i).*A server-main enjoy.*", 1));
}

@Override
public String getDriverClassName() {
return "org.postgresql.Driver";
}

@Override
public String getJdbcUrl() {
return this.getPostgresUrl(DEFAULT_DATABASE_NAME);
Vangreen marked this conversation as resolved.
Show resolved Hide resolved
}

@Override
public String getUsername() {
return DEFAULT_USERNAME;
}

@Override
public String getPassword() {
return DEFAULT_PASSWORD;
}

@Override
public String getTestQueryString() {
return TEST_QUERY;
}
kiview marked this conversation as resolved.
Show resolved Hide resolved

public Integer getIlpPort() {
return getMappedPort(ILP_PORT);
}
Vangreen marked this conversation as resolved.
Show resolved Hide resolved

public String getPostgresUrl(String databaseName) {
if (!this.isRunning()) {
throw new IllegalStateException("QuestDBContainer should be started first");
} else {
return this.getPostgresConnectionString() + "/" + databaseName;
}
}

public String getPostgresConnectionString() {
return String.format("jdbc:postgresql://%s:%d", this.getHost(), this.getMappedPort(8812));
}
Vangreen marked this conversation as resolved.
Show resolved Hide resolved
}
@@ -0,0 +1,16 @@
package org.testcontainers.containers;

import org.testcontainers.utility.DockerImageName;

public class QuestDBProvider extends JdbcDatabaseContainerProvider {

@Override
public boolean supports(String databaseType) {
return databaseType.equals(QuestDBContainer.DATABASE_PROVIDER);
}

@Override
public JdbcDatabaseContainer newInstance(String tag) {
return new QuestDBContainer(DockerImageName.parse(QuestDBContainer.IMAGE).withTag(tag));
}
}
@@ -0,0 +1 @@
org.testcontainers.containers.QuestDBProvider
@@ -0,0 +1,7 @@
package org.testcontainers;

import org.testcontainers.utility.DockerImageName;

public interface QuestDBTestImages {
DockerImageName QUESTDB_IMAGE = DockerImageName.parse("questdb/questdb:6.5.3");
}
@@ -0,0 +1,19 @@
package org.testcontainers.jdbc.questdb;

import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.testcontainers.jdbc.AbstractJDBCDriverTest;

import java.util.Arrays;
import java.util.EnumSet;

@RunWith(Parameterized.class)
public class QuestDBJDBCDriverTest extends AbstractJDBCDriverTest {

@Parameterized.Parameters(name = "{index} - {0}")
public static Iterable<Object[]> data() {
return Arrays.asList(
new Object[][] { { "jdbc:tc:postgresql://hostname/databasename", EnumSet.of(Options.PmdKnownBroken) } }
);
}
}
@@ -0,0 +1,26 @@
package org.testcontainers.junit.questdb;

import org.junit.Test;
import org.testcontainers.QuestDBTestImages;
import org.testcontainers.containers.QuestDBContainer;
import org.testcontainers.db.AbstractContainerDatabaseTest;

import java.sql.ResultSet;
import java.sql.SQLException;

import static org.assertj.core.api.Assertions.assertThat;

public class SimpleQuestDBTest extends AbstractContainerDatabaseTest {

@Test
public void testSimple() throws SQLException {
try (QuestDBContainer questDB = new QuestDBContainer(QuestDBTestImages.QUESTDB_IMAGE)) {
questDB.start();

ResultSet resultSet = performQuery(questDB, QuestDBContainer.TEST_QUERY);

int resultSetInt = resultSet.getInt(1);
assertThat(resultSetInt).as("A basic SELECT query succeeds").isEqualTo(1);
}
}
}