CosmosDB

Author: cristianrgreco

docs/modules/arangodb.md

@@ -18,6 +18,8 @@ This example uses the following libraries:
 
 Choose an image from [Docker Hub](https://hub.docker.com/_/arangodb) and substitute `IMAGE`.
 
+### Execute a query
+
 <!--codeinclude-->
-[Creating an ArangoDB container](../../packages/modules/arangodb/src/arangodb-container.test.ts) inside_block:example
+[](../../packages/modules/arangodb/src/arangodb-container.test.ts) inside_block:example
 <!--/codeinclude-->

docs/modules/chromadb.md

@@ -1,4 +1,4 @@
-_# ChromaDB
+# ChromaDB
 
 ## Install
 

docs/modules/cosmosdb.md

@@ -1,6 +1,13 @@
-# Cosmos DB Emulator Module (Linux-based)
+# CosmosDB
 
-[Azure Cosmos DB](https://azure.microsoft.com/en-GB/products/cosmos-db) is a globally distributed, multi-model database service provided by Microsoft.
+!!!info
+    This module uses the **Linux-based** version of the CosmosDB emulator. 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. Refer to [this overview](https://learn.microsoft.com/en-us/azure/cosmos-db/emulator-linux#feature-support) for a detailed list.
 
 ## Install
 
@@ -9,24 +16,25 @@ 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-->
+These examples use the following libraries:
+
+- [@azure/cosmos](https://www.npmjs.com/package/@azure/cosmos)
+
+        npm install @azure/cosmos
+
+---
+
+Choose an image from [Microsoft Artifact Registry](https://mcr.microsoft.com/) and substitute `IMAGE`. For example, `mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-preview`.
+
+### Execute a query
 
 <!--codeinclude-->
-[Create and read items:](../../packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.test.ts) inside_block:createAndRead
+[](../../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:
+### With HTTPS
 
-- 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.
+<!--codeinclude-->
+[](../../packages/modules/azurecosmosdb/src/azure-cosmosdb-emulator-container.test.ts) inside_block:httpsCreateDB
+<!--/codeinclude-->

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

@@ -37,16 +37,18 @@ describe("AzureCosmosDbEmulatorContainer", { timeout: 180_000 }, async () => {
   });
   // }
 
-  // httpsCreateDB {
   it("should be able to create a database using https", async () => {
+    // httpsCreateDB {
     await using container = await new AzureCosmosDbEmulatorContainer(IMAGE).withProtocol("https").start();
+
     const cosmosClient = new CosmosClient({
       endpoint: container.getEndpoint(),
       key: container.getKey(),
       agent: new https.Agent({
-        rejectUnauthorized: false, //allows insecure TLS; import * as https from "node:https";
+        rejectUnauthorized: false,
       }),
     });
+    // }
 
     const dbName = "testdb";
     const createResponse = await cosmosClient.databases.createIfNotExists({
@@ -57,23 +59,22 @@ describe("AzureCosmosDbEmulatorContainer", { timeout: 180_000 }, async () => {
     const db = await cosmosClient.database(dbName).read();
     expect(db.database.id).toBe(dbName);
   });
-  // }
 
-  // createAndRead {
   it("should be able to create a container and store and retrieve items", async () => {
+    // createAndRead {
+    const dbName = "testdb";
+    const containerName = "testcontainer";
+
     await using container = await new AzureCosmosDbEmulatorContainer(IMAGE).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);
+    await cosmosClient.databases.createIfNotExists({ id: dbName });
 
-    const containerName = "testcontainer";
+    const dbClient = cosmosClient.database(dbName);
     await dbClient.containers.createIfNotExists({
       id: containerName,
       partitionKey: {
@@ -83,12 +84,10 @@ describe("AzureCosmosDbEmulatorContainer", { timeout: 180_000 }, async () => {
     });
 
     const containerClient = dbClient.container(containerName);
-    const createResponse = await containerClient.items.create({
-      foo: "bar",
-    });
+    const createResponse = await containerClient.items.create({ foo: "bar" });
 
     const readItem = await containerClient.item(createResponse.item.id, "bar").read();
     expect(readItem.resource.foo).toEqual("bar");
+    // }
   });
-  // }
 });