You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,18 @@ To update the docs for your new module, you'll have to:
23
23
24
24
#### Using Docker
25
25
26
-
The root of the project contains a `docker-compose.yml` file. Simply run `docker-compose up` and then access the docs at [http://localhost:8000](http://localhost:8000).
26
+
```shell
27
+
npm run docs:serve
28
+
```
29
+
30
+
Then access the docs at [http://localhost:8000](http://localhost:8000).
27
31
28
32
#### Using Python
29
33
30
34
* Ensure that you have Python 3.8.0 or higher.
31
35
* Set up a virtualenv and run `pip install -r requirements.txt` in the `testcontainers-node` root directory.
32
36
* Once Python dependencies have been installed, run `mkdocs serve` to start a local auto-updating MkDocs server.
33
37
34
-
#### PR Preview deployments
35
-
36
-
Documentation for pull requests will automatically be published by Netlify as 'deploy previews'. These deployment previews can be accessed via the `deploy/netlify` check that appears for each pull request.
38
+
#### PR preview deployments
37
39
40
+
Documentation for pull requests will automatically be published by Netlify as "deploy previews". These deployment previews can be accessed via the `deploy/netlify` check that appears for each pull request.
The Cloud Storage container doesn't rely on a built-in emulator created by Google but instead depends on a fake Cloud Storage server implemented by [Francisco Souza](https://github.com/fsouza). The project is open-source, and the repository can be found at [fsouza/fake-gcs-server](https://github.com/fsouza/fake-gcs-server).
52
+
The Cloud Storage container uses a fake Cloud Storage server by [Francisco Souza](https://github.com/fsouza).
53
+
53
54
<!--codeinclude-->
54
55
[Starting a Cloud Storage Emulator container with the default image](../../packages/modules/gcloud/src/cloudstorage-emulator-container.test.ts) inside_block:cloud-storage
55
56
<!--/codeinclude-->
56
57
57
58
### BigQuery
58
59
59
-
The BigQuery container doesn't rely on a built-in emulator created by Google, but instead depends on an implementation written in Go by [Masaaki Goshima](https://github.com/goccy). The project is open-source, and the repository can be found at [goccy/bigquery-emulator](https://github.com/goccy/bigquery-emulator).
60
+
The BigQuery emulator is by [Masaaki Goshima](https://github.com/goccy)and uses [go-zetasqlite](https://github.com/goccy/go-zetasqlite).
60
61
61
-
BigQuery emulator uses [go-zetasqlite](https://github.com/goccy/go-zetasqlite) to interpret ZetaSQL (the language used in BigQuery) and runs it in SQLite. The [README](https://github.com/goccy/go-zetasqlite?tab=readme-ov-file#status) lists BigQuery features currently supported.
62
62
<!--codeinclude-->
63
63
[Starting a BigQuery Emulator container with the default image](../../packages/modules/gcloud/src/bigquery-emulator-container.test.ts)
64
64
<!--/codeinclude-->
65
+
66
+
### Cloud Spanner
67
+
68
+
The Cloud Spanner emulator container wraps Google's official emulator image.
69
+
70
+
<!--codeinclude-->
71
+
[Starting a Spanner Emulator container and exposing endpoints using explicitly configured client](../../packages/modules/gcloud/src/spanner-emulator-container.test.ts) inside_block:startupWithExplicitClient
72
+
<!--/codeinclude-->
73
+
74
+
<!--codeinclude-->
75
+
[Starting a Spanner Emulator container and exposing endpoints using projectId and SPANNER_EMULATOR_HOST](../../packages/modules/gcloud/src/spanner-emulator-container.test.ts) inside_block:startupWithEnvironmentVariable
76
+
<!--/codeinclude-->
77
+
78
+
<!--codeinclude-->
79
+
[Creating and deleting instance and database via helper](../../packages/modules/gcloud/src/spanner-emulator-helper.test.ts) inside_block:createAndDelete
MockServer includes built-in TLS support. To obtain an HTTPS URL, use the `getSecureUrl` method. Keep in mind that MockServer uses a self-signed certificate.
[OpenSearch](https://opensearch.org/) is a community-driven, open source search and analytics suite derived from Elasticsearch. It provides a distributed, multitenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents.
4
+
5
+
## Install
6
+
7
+
```bash
8
+
npm install @testcontainers/opensearch --save-dev
9
+
```
10
+
11
+
## Examples
12
+
13
+
<!--codeinclude-->
14
+
[Create an index:](../../packages/modules/opensearch/src/opensearch-container.test.ts) inside_block:createIndex
15
+
<!--/codeinclude-->
16
+
17
+
<!--codeinclude-->
18
+
[Index a document:](../../packages/modules/opensearch/src/opensearch-container.test.ts) inside_block:indexDocument
19
+
<!--/codeinclude-->
20
+
21
+
<!--codeinclude-->
22
+
[Set a custom password:](../../packages/modules/opensearch/src/opensearch-container.test.ts) inside_block:customPassword
[Vault](https://www.vaultproject.io/) by HashiCorp is a tool for securely accessing secrets such as API keys, passwords, or certificates. This module allows you to run and initialize a Vault container for integration tests.
4
+
5
+
## Install
6
+
7
+
```bash
8
+
npm install @testcontainers/vault --save-dev
9
+
```
10
+
11
+
## Examples
12
+
13
+
<!--codeinclude-->
14
+
[Start and perform read/write with node-vault:](../../packages/modules/vault/src/vault-container.test.ts) inside_block:readWrite
15
+
<!--/codeinclude-->
16
+
17
+
<!--codeinclude-->
18
+
[Run Vault CLI init commands at startup:](../../packages/modules/vault/src/vault-container.test.ts) inside_block:initCommands
19
+
<!--/codeinclude-->
20
+
21
+
## Why use Vault in integration tests?
22
+
23
+
With the growing adoption of Vault in modern infrastructure, testing components that depend on Vault for secret resolution or encryption can be complex. This module allows:
24
+
25
+
- Starting a local Vault instance during test runs
26
+
- Seeding secrets or enabling engines with Vault CLI
27
+
- Validating app behavior with secured data access
28
+
29
+
Use this module to test Vault-backed workflows without the need for pre-provisioned Vault infrastructure.
0 commit comments