Opensearch

Author: cristianrgreco

docs/modules/opensearch.md

@@ -1,6 +1,4 @@
-# OpenSearch Module
-
-[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.
+# OpenSearch
 
 ## Install
 
@@ -10,14 +8,28 @@ npm install @testcontainers/opensearch --save-dev
 
 ## Examples
 
+These examples use the following libraries:
+
+- [@opensearch-project/opensearch](https://www.npmjs.com/package/@opensearch-project/opensearch)
+
+        npm install @opensearch-project/opensearch
+
+Choose an image from the [container registry](https://hub.docker.com/r/opensearchproject/opensearch) and substitute `IMAGE`.
+
+### Create an index
+
 <!--codeinclude-->
-[Create an index:](../../packages/modules/opensearch/src/opensearch-container.test.ts) inside_block:createIndex
+[](../../packages/modules/opensearch/src/opensearch-container.test.ts) inside_block:opensearchCreateIndex
 <!--/codeinclude-->
 
+### Index a document
+
 <!--codeinclude-->
-[Index a document:](../../packages/modules/opensearch/src/opensearch-container.test.ts) inside_block:indexDocument
+[](../../packages/modules/opensearch/src/opensearch-container.test.ts) inside_block:opensearchIndexDocument
 <!--/codeinclude-->
 
+### With password
+
 <!--codeinclude-->
-[Set a custom password:](../../packages/modules/opensearch/src/opensearch-container.test.ts) inside_block:customPassword
+[](../../packages/modules/opensearch/src/opensearch-container.test.ts) inside_block:opensearchCustomPassword
 <!--/codeinclude-->

packages/modules/opensearch/src/opensearch-container.test.ts

@@ -6,30 +6,32 @@ const IMAGE = getImage(__dirname);
 const images = ["opensearchproject/opensearch:2.19.2", IMAGE];
 
 describe("OpenSearchContainer", { timeout: 180_000 }, () => {
-  // createIndex {
   it.each(images)("should create an index with %s", async (image) => {
+    // opensearchCreateIndex {
     await using container = await new OpenSearchContainer(image).start();
+
     const client = new Client({
       node: container.getHttpUrl(),
       auth: {
         username: container.getUsername(),
         password: container.getPassword(),
       },
       ssl: {
-        // trust the self-signed cert
         rejectUnauthorized: false,
       },
     });
 
     await client.indices.create({ index: "people" });
-    const existsResponse = await client.indices.exists({ index: "people" });
-    expect(existsResponse.body).toBe(true);
+
+    const { body } = await client.indices.exists({ index: "people" });
+    expect(body).toBe(true);
+    // }
   });
-  // }
 
-  // indexDocument {
   it("should index a document", async () => {
+    // opensearchIndexDocument {
     await using container = await new OpenSearchContainer(IMAGE).start();
+
     const client = new Client({
       node: container.getHttpUrl(),
       auth: {
@@ -49,10 +51,10 @@ describe("OpenSearchContainer", { timeout: 180_000 }, () => {
       body: document,
     });
 
-    const getResponse = await client.get({ index: "people", id: document.id });
-    expect(getResponse.body._source).toStrictEqual(document);
+    const { body } = await client.get({ index: "people", id: document.id });
+    expect(body._source).toEqual(document);
+    // }
   });
-  // }
 
   it("should work with restarted container", async () => {
     await using container = await new OpenSearchContainer(IMAGE).start();
@@ -70,6 +72,7 @@ describe("OpenSearchContainer", { timeout: 180_000 }, () => {
     });
 
     await client.indices.create({ index: "people" });
+
     const existsResponse = await client.indices.exists({ index: "people" });
     expect(existsResponse.body).toBe(true);
   });
@@ -78,9 +81,10 @@ describe("OpenSearchContainer", { timeout: 180_000 }, () => {
     expect(() => new OpenSearchContainer(IMAGE).withPassword("weakpwd")).toThrowError(/Password "weakpwd" is too weak/);
   });
 
-  // customPassword {
   it("should set custom password", async () => {
+    // opensearchCustomPassword {
     await using container = await new OpenSearchContainer(IMAGE).withPassword("Str0ng!Passw0rd2025").start();
+    // }
 
     const client = new Client({
       node: container.getHttpUrl(),
@@ -94,8 +98,8 @@ describe("OpenSearchContainer", { timeout: 180_000 }, () => {
     });
 
     await client.indices.create({ index: "people" });
-    const existsResponse = await client.indices.exists({ index: "people" });
-    expect(existsResponse.body).toBe(true);
+
+    const { body } = await client.indices.exists({ index: "people" });
+    expect(body).toBe(true);
   });
-  // }
 });