java-module-workshop

Workshop about making your own Testcontainers module and learning important things

Step 1: Getting Started

Before getting started, let's make sure you have everything you need for this workshop.

Prerequisites

Install Java 17 or newer

You'll need Java 17 or newer for this workshop. Testcontainers libraries are compatible with Java 8+, but this workshop uses a Spring Boot 3.x application which requires Java 17 or newer.

We would recommend using SDKMAN to install Java on your machine if you are using MacOS, Linux or Windows WSL.

Install Docker

You need to have a Docker environment to use Testcontainers.

• You can use Docker Desktop on your machine.

• You can use Testcontainers Cloud. If you are going to use Testcontainers Cloud, then you need to install Testcontainers Desktop app.

• If you are using MacOS, you can use Testcontainers Desktop Embedded Runtime.

• If you are using a local Docker, check by running:

$ docker version

Client:
 Version:           24.0.6-rd
 API version:       1.43
 Go version:        go1.20.7
 Git commit:        da4c87c
 Built:             Wed Sep  6 16:40:13 2023
 OS/Arch:           darwin/arm64
 Context:           desktop-linux
Server: Docker Desktop 4.24.2 (124339)
 Engine:
  Version:          24.0.6
  API version:      1.43 (minimum version 1.12)
  Go version:       go1.20.7
  Git commit:       1a79695
  Built:            Mon Sep  4 12:31:36 2023
  OS/Arch:          linux/arm64
  Experimental:     false
  ...

Install Testcontainers Desktop

Testcontainers Desktop is a companion app for the open-source Testcontainers libraries that makes local development and testing with real dependencies simple.

Download the latest version of Testcontainers Desktop app from https://testcontainers.com/desktop/ and install it on your machine.

Once you start the Testcontainers Desktop application, it will automatically detect the container runtimes installed on your system (Docker Desktop, OrbStack, etc) and allows you to choose which container runtime you want to use by Testcontainers.

Download the project

Clone the java-module-workshop repository from GitHub to your computer:

git clone https://github.com/testcontainers/java-module-workshop.git