add docs

Author: mrtnsch

docs/modules/cosmosdb.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.

mkdocs.yml

@@ -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

packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.test.ts

@@ -1,4 +1,4 @@
-import { CosmosClient } from "@azure/cosmos";
+import { CosmosClient, PartitionKeyKind } from "@azure/cosmos";
 import * as https from "node:https";
 import { expect } from "vitest";
 import { AzureCosmosDbEmulatorContainer } from "./azure-cosmosdb-emulator-container";
@@ -17,6 +17,7 @@ describe("AzureCosmosDbEmulatorContainer", { timeout: 180_000 }, async () => {
     await container.stop();
   });
 
+  // httpCreateDB {
   it("should be able to create a database using http", async () => {
     const container = await new AzureCosmosDbEmulatorContainer().withProtocol("http").start();
     const cosmosClient = new CosmosClient({
@@ -35,13 +36,16 @@ describe("AzureCosmosDbEmulatorContainer", { timeout: 180_000 }, async () => {
 
     await container.stop();
   });
+  // }
+
+  // httpsCreateDB {
   it("should be able to create a database using https", async () => {
     const container = await new AzureCosmosDbEmulatorContainer().withProtocol("https").start();
     const cosmosClient = new CosmosClient({
       endpoint: container.getEndpoint(),
       key: container.getKey(),
       agent: new https.Agent({
-        rejectUnauthorized: false,
+        rejectUnauthorized: false, //allows insecure TLS; import * as https from "node:https";
       }),
     });
 
@@ -56,4 +60,40 @@ describe("AzureCosmosDbEmulatorContainer", { timeout: 180_000 }, async () => {
 
     await container.stop();
   });
+  // }
+
+  // createAndRead {
+  it("should be able to create a container and store and retrieve items", async () => {
+    const container = await new AzureCosmosDbEmulatorContainer().withProtocol("http").start();
+    const cosmosClient = new CosmosClient({
+      endpoint: container.getEndpoint(),
+      key: container.getKey(),
+    });
+
+    const dbName = "testdb";
+    await cosmosClient.databases.createIfNotExists({
+      id: dbName,
+    });
+    const dbClient = cosmosClient.database(dbName);
+
+    const containerName = "testcontainer";
+    await dbClient.containers.createIfNotExists({
+      id: containerName,
+      partitionKey: {
+        kind: PartitionKeyKind.Hash,
+        paths: ["/foo"],
+      },
+    });
+
+    const containerClient = dbClient.container(containerName);
+    const createResponse = await containerClient.items.create({
+      foo: "bar",
+    });
+
+    const readItem = await containerClient.item(createResponse.item.id, "bar").read();
+    expect(readItem.resource.foo).toEqual("bar");
+
+    await container.stop();
+  });
+  // }
 });

packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.ts

@@ -47,7 +47,7 @@ export class AzureCosmosDbEmulatorContainer extends GenericContainer {
   }
 
   /**
-   * The mapped port has to be passed to CosmosDB as an environment variable for HTTPS to work.
+   * The mapped port has to be passed to CosmosDB as an environment variable.
    * Since the mapped port would only be known after container creation, we need to find an available port ourselves
    * before starting the container.
    * @private