Skip to content

Commit 0a5296f

Browse files
committed
Add docs and fix comments
1 parent fe09508 commit 0a5296f

File tree

5 files changed

+44
-26
lines changed

5 files changed

+44
-26
lines changed

docs/modules/databases/influxdb.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,43 @@ Testcontainers module for InfluxData [InfluxDB](https://www.influxdata.com/produ
44

55
## Important note
66

7-
There are breaking changes in InfluxDB 2.x.
8-
For more information refer to the main [documentation](https://docs.influxdata.com/influxdb/v2.0/upgrade/v1-to-v2/).
7+
There are breaking changes in InfluxDB 2.x. and InfluxDB 3.x. for more information refer to the main documentations:
8+
9+
InfluxDB 3.x. [documentation](https://www.influxdata.com/blog/influxdb3-open-source-public-alpha/#heading2).
10+
11+
InfluxDB 2.x. [documentation](https://docs.influxdata.com/influxdb/v2.0/upgrade/v1-to-v2/).
12+
913
You can find more information about the official InfluxDB image on [Docker Hub](https://hub.docker.com/_/influxdb).
1014

15+
## InfluxDB 3.x usage example
16+
17+
Running a `InfluxDBContainer` as a stand-in for InfluxDB in a test with default env variables:
18+
19+
<!--codeinclude-->
20+
[Create an InfluxDB container](../../../modules/influxdb/src/test/java/org/testcontainers/influxdb/InfluxDBV3ContainerTest.java) inside_block:createInfluxDBContainerV3WithAuthTokenTest
21+
<!--/codeinclude-->
22+
23+
24+
The InfluxDB instance will be setup with the following data:<br/>
25+
26+
| Property | Default Value |
27+
|-------------|:-------------:|
28+
| authDisable | false |
29+
30+
For more details about the InfluxDB setup, please visit the official
31+
32+
[InfluxDB documentation](https://docs.influxdata.com/influxdb3/core/get-started/)
33+
34+
[InfluxDB config options](https://docs.influxdata.com/influxdb3/core/reference/config-options/)
35+
36+
It is possible to overwrite the default property values. Create a container with disabled auth token:
37+
<!--codeinclude-->
38+
[Create an InfluxDB container with admin token](../../../modules/influxdb/src/test/java/org/testcontainers/influxdb/InfluxDBV3ContainerTest.java) inside_block:createInfluxDBContainerV3WithDisableAuthTokenTest
39+
<!--/codeinclude-->
40+
41+
!!! hint
42+
You can find the latest documentation about the InfluxDB 3.x Java client [here](https://github.com/InfluxCommunity/influxdb3-java).
43+
1144
## InfluxDB 2.x usage example
1245

1346
Running a `InfluxDBContainer` as a stand-in for InfluxDB in a test:

modules/influxdb/build.gradle

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ dependencies {
1313

1414
test {
1515
jvmArgs = [
16-
"--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED",
17-
"--add-opens=java.base/sun.nio.ch=ALL-UNNAMED"
16+
"--add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED"
1817
]
1918
}
2019

modules/influxdb/src/main/java/org/testcontainers/influxdb/InfluxDBContainer.java

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
import com.github.dockerjava.zerodep.shaded.org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
88
import com.github.dockerjava.zerodep.shaded.org.apache.hc.client5.http.impl.classic.HttpClients;
99
import com.github.dockerjava.zerodep.shaded.org.apache.hc.core5.http.HttpStatus;
10-
import lombok.Getter;
1110
import org.testcontainers.containers.GenericContainer;
1211
import org.testcontainers.containers.wait.strategy.HttpWaitStrategy;
1312
import org.testcontainers.utility.DockerImageName;
@@ -23,22 +22,6 @@
2322
* Supported image: {@code influxdb}
2423
* <p>
2524
* Exposed ports: 8181
26-
* <p>
27-
* This container provides a instance of InfluxDB 3.x for integration testing.
28-
* It supports both authenticated and non-authenticated modes.
29-
* </p>
30-
*
31-
* <p>
32-
* <strong>Example usage:</strong>
33-
* <pre>{@code
34-
* try (InfluxDBContainer influxDB = new InfluxDBContainer("influxdb:3-core")) {
35-
* influxDB.start();
36-
* String url = influxDB.getUrl();
37-
* String token = influxDB.getToken();
38-
* // Use InfluxDB client with the obtained URL and token
39-
* }
40-
* }</pre>
41-
* </p>
4225
*/
4326
public class InfluxDBContainer extends GenericContainer<InfluxDBContainer> {
4427

@@ -52,7 +35,6 @@ public class InfluxDBContainer extends GenericContainer<InfluxDBContainer> {
5235
/**
5336
* The authentication token for InfluxDB 3.
5437
*/
55-
@Getter
5638
private String token;
5739

5840
private boolean isAuthDisable;
@@ -148,4 +130,8 @@ protected void containerIsStarted(InspectContainerResponse containerInfo) {
148130
this.token = createToken();
149131
}
150132
}
133+
134+
public String getToken() {
135+
return token;
136+
}
151137
}

modules/influxdb/src/test/java/org/testcontainers/containers/InfluxDBTestUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ public final class InfluxDBTestUtils {
88

99
static final DockerImageName INFLUXDB_V2_TEST_IMAGE = DockerImageName.parse("influxdb:2.0.7");
1010

11-
static final DockerImageName INFLUXDB_V3_TEST_IMAGE = DockerImageName.parse("influxdb:3-core");
11+
public static final DockerImageName INFLUXDB_V3_TEST_IMAGE = DockerImageName.parse("influxdb:3-core");
1212
}

modules/influxdb/src/test/java/org/testcontainers/containers/InfluxDBContainerV3Test.java renamed to modules/influxdb/src/test/java/org/testcontainers/influxdb/InfluxDBV3ContainerTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
package org.testcontainers.containers;
1+
package org.testcontainers.influxdb;
22

33
import com.influxdb.v3.client.InfluxDBClient;
44
import com.influxdb.v3.client.Point;
55
import org.junit.Test;
6-
import org.testcontainers.influxdb.InfluxDBContainer;
6+
import org.testcontainers.containers.InfluxDBTestUtils;
77

88
import java.math.BigInteger;
99
import java.time.Instant;
@@ -14,7 +14,7 @@
1414
import static org.assertj.core.api.Assertions.assertThat;
1515
import static org.assertj.core.api.Assertions.fail;
1616

17-
public class InfluxDBContainerV3Test {
17+
public class InfluxDBV3ContainerTest {
1818

1919
@Test
2020
public void createInfluxDBContainerV3WithAuthTokenTest() {

0 commit comments

Comments
 (0)