https://github.com/testcontainers/tc-guide-getting-started-with-testcontainers-for-java
Getting started with Testcontainers for Java guide
https://github.com/testcontainers/tc-guide-getting-started-with-testcontainers-for-java
Last synced: 3 months ago
JSON representation
Getting started with Testcontainers for Java guide
- Host: GitHub
- URL: https://github.com/testcontainers/tc-guide-getting-started-with-testcontainers-for-java
- Owner: testcontainers
- License: mit
- Created: 2023-03-28T04:04:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T10:43:48.000Z (about 1 year ago)
- Last Synced: 2024-05-22T18:20:48.773Z (about 1 year ago)
- Language: Java
- Size: 154 KB
- Stars: 3
- Watchers: 4
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Getting started with Testcontainers for Java
This is sample code for [Getting started with Testcontainers for Java](https://testcontainers.com/guides/getting-started-with-testcontainers-for-java) guide.
## 1. Setup Environment
Make sure you have Java 8+ and a [compatible Docker environment](https://www.testcontainers.org/supported_docker_environment/) installed.
If you are going to use Maven build tool then make sure Java 17+ is installed.
For example:
```shell
$ java -version
openjdk version "17.0.4" 2022-07-19
OpenJDK Runtime Environment Temurin-17.0.4+8 (build 17.0.4+8)
OpenJDK 64-Bit Server VM Temurin-17.0.4+8 (build 17.0.4+8, mixed mode, sharing)
$ docker version
...
Server: Docker Desktop 4.12.0 (85629)
Engine:
Version: 20.10.17
API version: 1.41 (minimum version 1.12)
Go version: go1.17.11
...
```
## 2. Setup Project
* Clone the repository
```shell
git clone https://github.com/testcontainers/tc-guide-getting-started-with-testcontainers-for-java.git
cd tc-guide-getting-started-with-testcontainers-for-java
```
* Open the **tc-guide-getting-started-with-testcontainers-for-java** project in your favorite IDE.
## 3. Run Tests
Run the command to run the tests.
```shell
$ ./gradlew test //for Gradle
$ ./mvnw verify //for Maven
```
The tests should pass.
> [!NOTE]
> The project is configured to automate the code formatting with spotless plugin
> using prettier-plugin-java, which internally requires Node.js runtime.
> If you don't have Node.js installed and want to disable the code formatting,
> you can pass additional parameter to the build command as shown below:
```shell
./gradlew build -x spotlessCheck //for Gradle
./mvnw verify -Dspotless.check.skip=true //for Maven
```