Merge branch 'main' into pr/digital88/926

Author: cristianrgreco

.eslintignore

@@ -1,6 +1,5 @@
 {
-    "printWidth": 120,
-    "plugins": [
-        "prettier-plugin-organize-imports"
-    ]
-}
+  "printWidth": 120,
+  "trailingComma": "es5",
+  "plugins": ["prettier-plugin-organize-imports"]
+}

.eslintrc.js

@@ -32,15 +32,15 @@ Configuration of the Docker daemon:
 
 Configuration of Testcontainers and its behaviours:
 
-| Variable                              | Example                   | Description                              |
-| ------------------------------------- | ------------------------- | ---------------------------------------- |
-| TESTCONTAINERS_HOST_OVERRIDE          | tcp://docker:2375         | Docker's host on which ports are exposed |
-| TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE | /var/run/docker.sock      | Path to Docker's socket used by ryuk     |
-| TESTCONTAINERS_RYUK_PRIVILEGED        | true                      | Run ryuk as a privileged container       |
-| TESTCONTAINERS_RYUK_DISABLED          | true                      | Disable ryuk                             |
-| TESTCONTAINERS_RYUK_PORT              | 65515                     | Set ryuk host port (not recommended)     |
-| TESTCONTAINERS_SSHD_PORT              | 65515                     | Set SSHd host port (not recommended)     |
-| TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX  | mycompany.com/registry    | Set default image registry               |
-| RYUK_CONTAINER_IMAGE                  | testcontainers/ryuk:0.5.1 | Custom image for ryuk                    |
-| SSHD_CONTAINER_IMAGE                  | testcontainers/sshd:1.1.0 | Custom image for SSHd                    |
-| TESTCONTAINERS_REUSE_ENABLE           | true                      | Enable reusable containers               |
+| Variable                              | Example                    | Description                              |
+| ------------------------------------- | -------------------------- | ---------------------------------------- |
+| TESTCONTAINERS_HOST_OVERRIDE          | tcp://docker:2375          | Docker's host on which ports are exposed |
+| TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE | /var/run/docker.sock       | Path to Docker's socket used by ryuk     |
+| TESTCONTAINERS_RYUK_PRIVILEGED        | true                       | Run ryuk as a privileged container       |
+| TESTCONTAINERS_RYUK_DISABLED          | true                       | Disable ryuk                             |
+| TESTCONTAINERS_RYUK_PORT              | 65515                      | Set ryuk host port (not recommended)     |
+| TESTCONTAINERS_SSHD_PORT              | 65515                      | Set SSHd host port (not recommended)     |
+| TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX  | mycompany.com/registry     | Set default image registry               |
+| RYUK_CONTAINER_IMAGE                  | testcontainers/ryuk:0.11.0 | Custom image for ryuk                    |
+| SSHD_CONTAINER_IMAGE                  | testcontainers/sshd:1.1.0  | Custom image for SSHd                    |
+| TESTCONTAINERS_REUSE_ENABLE           | true                       | Enable reusable containers               |

.prettierrc

@@ -133,6 +133,10 @@ const container = await new GenericContainer("alpine")
     content: "hello world",
     target: "/remote/file2.txt"
   }])
+  .withCopyArchivesToContainer([{
+    tar: nodeReadable,
+    target: "/some/nested/remotedir"
+  }])
   .start();
 ```
 
@@ -153,6 +157,7 @@ container.copyContentToContainer([{
   content: "hello world",
   target: "/remote/file2.txt"
 }])
+container.copyArchiveToContainer(nodeReadable, "/some/nested/remotedir");
 ```
 
 An optional `mode` can be specified in octal for setting file permissions:
@@ -357,6 +362,29 @@ const container = await new GenericContainer("alpine").start();
 await container.restart();
 ```
 
+## Committing a container to an image
+
+```javascript
+const container = await new GenericContainer("alpine").start();
+// Do something with the container
+await container.exec(["sh", "-c", `echo 'hello world' > /hello-world.txt`]);
+// Commit the container to an image
+const newImageId = await container.commit({ repo: "my-repo", tag: "my-tag" });
+// Use this image in a new container
+const containerFromCommit = await new GenericContainer(newImageId).start();
+```
+
+By default, the image inherits the behavior of being marked for cleanup on exit. You can override this behavior using
+the `deleteOnExit` option:
+
+```javascript
+const container = await new GenericContainer("alpine").start();
+// Do something with the container
+await container.exec(["sh", "-c", `echo 'hello world' > /hello-world.txt`]);
+// Commit the container to an image; committed image will not be cleaned up on exit
+const newImageId = await container.commit({ repo: "my-repo", tag: "my-tag", deleteOnExit: false });
+```
+
 ## Reusing a container
 
 Enabling container re-use means that Testcontainers will not start a new container if a Testcontainers managed container with the same configuration is already running.

docs/configuration.md

@@ -0,0 +1,32 @@
+# Cosmos DB Emulator Module (Linux-based)
+
+[Azure Cosmos DB](https://azure.microsoft.com/en-GB/products/cosmos-db) is a globally distributed, multi-model database service provided by Microsoft.
+
+## Install
+
+```bash
+npm install @testcontainers/azurecosmosdb --save-dev
+```
+
+## Examples
+<!--codeinclude-->
+[Connect to emulator and create a database:](../../packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.test.ts) inside_block:httpCreateDB
+<!--/codeinclude-->
+
+<!--codeinclude-->
+[Using HTTPS:](../../packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.test.ts) inside_block:httpsCreateDB
+<!--/codeinclude-->
+
+<!--codeinclude-->
+[Create and read items:](../../packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.test.ts) inside_block:createAndRead
+<!--/codeinclude-->
+
+## Caveats
+### Compatibility
+This testcontainer uses the [linux-based](https://learn.microsoft.com/en-us/azure/cosmos-db/emulator-linux) version. In general, it:
+
+- Provides better compatibility on a variety of systems
+- Consumes significantly less resources
+- Comes with much faster startup times
+
+However, not all features of a full CosmosDB are implemented yet - please refer to [this overview](https://learn.microsoft.com/en-us/azure/cosmos-db/emulator-linux#feature-support) for a detailed list.

docs/features/containers.md

@@ -0,0 +1,40 @@
+import eslint from "@eslint/js";
+import json from "@eslint/json";
+import eslintConfigPrettier from "eslint-config-prettier/flat";
+import eslintPluginPrettier from "eslint-plugin-prettier/recommended";
+import tseslint from "typescript-eslint";
+
+/** @type {import("typescript-eslint").ConfigArray} */
+export default [
+  {
+    ignores: ["**/build/"],
+  },
+  {
+    ignores: ["package-lock.json"],
+    files: ["**/*.json"],
+    language: "json/json",
+    ...json.configs.recommended,
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  eslintConfigPrettier,
+  eslintPluginPrettier,
+  {
+    rules: {
+      "prettier/prettier": [
+        "error",
+        {
+          trailingComma: "es5",
+        },
+      ],
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          caughtErrors: "none",
+        },
+      ],
+      "no-irregular-whitespace": "off",
+    },
+  },
+];

docs/modules/cosmosdb.md

@@ -46,6 +46,7 @@ nav:
       - Azurite: modules/azurite.md
       - Cassandra: modules/cassandra.md
       - ChromaDB: modules/chromadb.md
+      - CosmosDB: modules/cosmosdb.md
       - Couchbase: modules/couchbase.md
       - CockroachDB: modules/cockroachdb.md
       - Elasticsearch: modules/elasticsearch.md