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

feat: add testcontainers-oss quickstart guides #22120

Merged
merged 6 commits into from
Mar 3, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
review edits
  • Loading branch information
aevesdocker committed Mar 3, 2025
commit dff54937d5c69dd1f1acd25efab769901d62f08e
54 changes: 41 additions & 13 deletions content/manuals/testcontainers/_index.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,58 @@
---
title: Testcontainers OSS
weight: 30
description: Learn how to use Testcontainers OSS to run containers programmatically in your preferred programming language.
keywords: docker APIs, docker, testcontainers documentation, testcontainers, testcontainers oss, testcontainers oss documentation,
docker compose, docker-compose, java, golang, go
params:
sidebar:
group: Open source
grid:
- title: Why use Testcontainers?
description: Understand Testcontainers' key benefits
intro:
- title: What is Testcontainers?
description: Learn about what Testcontainers does and its key benefits
icon: feature_search
link: /testcontainers/benefits/
- title: Quickstart
description: Learn the key concepts of Testcontainers OSS
link: https://testcontainers.com/getting-started/#what-is-testcontainers
- title: The Testcontainers workflow
description: Understand the Testcontainers workflow
icon: explore
link: /testcontainers/getting-started
aliases:
- /testcontainers/
link: https://testcontainers.com/getting-started/#testcontainers-workflow
quickstart:
- title: Testcontainers for Go
description: A Go package that makes it simple to create and clean up container-based dependencies for automated integration/smoke tests.
icon: /assets/icons/go.svg
link: https://golang.testcontainers.org/quickstart/
- title: Testcontainers for Java
description: A Java library that supports JUnit tests, providing lightweight, throwaway instances of anything that can run in a Docker container.
icon: /assets/icons/java.svg
link: https://java.testcontainers.org/
---

Testcontainers is set libraries that provides easy and lightweight APIs for bootstrapping local development and test dependencies with real services wrapped in Docker containers.
Using Testcontainers, you can write tests that depend on the same services you use in production without mocks or in-memory services.

{{< grid >}}
{{< grid items=intro >}}

## Want to know more?
## Quickstart

- Visit the [Testcontainers website](https://testcontainers.com/getting-started/)
### Supported languages

Testcontainers provide support for the most popular languages, and Docker sponsors the development of the following Testcontainers implementations:

- [Go](https://golang.testcontainers.org/quickstart/)
- [Java](https://java.testcontainers.org/quickstart/)

The rest are community-driven and maintained by independent contributors.

### Prerequisites

Testcontainers requires a Docker-API compatible container runtime.
During development, Testcontainers is actively tested against recent versions of Docker on Linux, as well as against Docker Desktop on Mac and Windows.
These Docker environments are automatically detected and used by Testcontainers without any additional configuration being necessary.

It is possible to configure Testcontainers to work for other Docker setups, such as a remote Docker host or Docker alternatives.
However, these are not actively tested in the main development workflow, so not all Testcontainers features might be available
and additional manual configuration might be necessary.

If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests,
contact the Testcontainers team and other users from the Testcontainers community on [Slack](https://slack.testcontainers.org/).

{{< grid items=quickstart >}}
41 changes: 0 additions & 41 deletions content/manuals/testcontainers/benefits.md

This file was deleted.

35 changes: 0 additions & 35 deletions content/manuals/testcontainers/getting-started/_index.md

This file was deleted.

131 changes: 0 additions & 131 deletions content/manuals/testcontainers/getting-started/go.md

This file was deleted.

Loading
Oops, something went wrong.