Skip to content

Commit 231f97c

Browse files
feat: add testcontainers-oss quickstart guides (#22120)
- **chore: add testcontainers entry in the OSS section of Manuals** - **chore: adds quickstarts for tc-go and tc-java** <!--Delete sections as needed --> ## Description This PR adds the Testcontainers OSS section in the Manuals > OSS section of the docs. It's adding the following pages: - index page with a basic description of the project, with two cards: - why use testcontainers, linking to a benefits page - quicktart, linking to a folder with two pages: Go and Java Below the cards grid, it links to the testcontainers.com/getting-started page. The benefits page includes some of the content of the above getting-started page, and the Go and Java quickstart pages are copying the quickstart pages from Go (https://golang.testcontainers.org/quickstart/) and Java (https://java.testcontainers.org/quickstart/) in its 3 flavours (junit4, junit5 and spock) <!-- Tell us what you did and why --> ## Related issues or tickets <!-- Related issues, pull requests, or Jira tickets --> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [x] Technical review - [ ] Editorial review - [x] Product review --------- Co-authored-by: aevesdocker <allie.sadler@docker.com>
1 parent 1278c5b commit 231f97c

File tree

6 files changed

+97
-0
lines changed

6 files changed

+97
-0
lines changed

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Intune
5555
JFrog
5656
Jamf
5757
JetBrains
58+
JUnit
5859
Kerberos
5960
Kitematic
6061
Kubeadm
@@ -80,6 +81,7 @@ Paketo
8081
Postgres
8182
PowerShell
8283
Python
84+
Ryuk
8385
S3
8486
SQLite
8587
Slack

content/manuals/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ params:
2626
description: Define and run multi-container applications.
2727
icon: /assets/icons/Compose.svg
2828
link: /compose/
29+
- title: Testcontainers OSS
30+
description: Run containers programmatically in your preferred programming language.
31+
icon: /assets/icons/Testcontainers.svg
32+
link: /testcontainers/
2933
products:
3034
- title: Docker Desktop
3135
description: Your command center for container development.
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Testcontainers OSS
3+
description: Learn how to use Testcontainers OSS to run containers programmatically in your preferred programming language.
4+
keywords: docker APIs, docker, testcontainers documentation, testcontainers, testcontainers oss, testcontainers oss documentation,
5+
docker compose, docker-compose, java, golang, go
6+
params:
7+
sidebar:
8+
group: Open source
9+
intro:
10+
- title: What is Testcontainers?
11+
description: Learn about what Testcontainers does and its key benefits
12+
icon: feature_search
13+
link: https://testcontainers.com/getting-started/#what-is-testcontainers
14+
- title: The Testcontainers workflow
15+
description: Understand the Testcontainers workflow
16+
icon: explore
17+
link: https://testcontainers.com/getting-started/#testcontainers-workflow
18+
quickstart:
19+
- title: Testcontainers for Go
20+
description: A Go package that makes it simple to create and clean up container-based dependencies for automated integration/smoke tests.
21+
icon: /assets/icons/go.svg
22+
link: https://golang.testcontainers.org/quickstart/
23+
- title: Testcontainers for Java
24+
description: A Java library that supports JUnit tests, providing lightweight, throwaway instances of anything that can run in a Docker container.
25+
icon: /assets/icons/java.svg
26+
link: https://java.testcontainers.org/
27+
---
28+
29+
Testcontainers is set libraries that provides easy and lightweight APIs for bootstrapping local development and test dependencies with real services wrapped in Docker containers.
30+
Using Testcontainers, you can write tests that depend on the same services you use in production without mocks or in-memory services.
31+
32+
{{< grid items=intro >}}
33+
34+
## Quickstart
35+
36+
### Supported languages
37+
38+
Testcontainers provide support for the most popular languages, and Docker sponsors the development of the following Testcontainers implementations:
39+
40+
- [Go](https://golang.testcontainers.org/quickstart/)
41+
- [Java](https://java.testcontainers.org/quickstart/)
42+
43+
The rest are community-driven and maintained by independent contributors.
44+
45+
### Prerequisites
46+
47+
Testcontainers requires a Docker-API compatible container runtime.
48+
During development, Testcontainers is actively tested against recent versions of Docker on Linux, as well as against Docker Desktop on Mac and Windows.
49+
These Docker environments are automatically detected and used by Testcontainers without any additional configuration being necessary.
50+
51+
It is possible to configure Testcontainers to work for other Docker setups, such as a remote Docker host or Docker alternatives.
52+
However, these are not actively tested in the main development workflow, so not all Testcontainers features might be available
53+
and additional manual configuration might be necessary.
54+
55+
If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests,
56+
contact the Testcontainers team and other users from the Testcontainers community on [Slack](https://slack.testcontainers.org/).
57+
58+
{{< grid items=quickstart >}}
Lines changed: 6 additions & 0 deletions
Loading

static/assets/icons/go.svg

Lines changed: 10 additions & 0 deletions
Loading

static/assets/icons/java.svg

Lines changed: 17 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)