Add Qdrant module (#725)

Author: Anush008

docs/modules/qdrant.md

@@ -0,0 +1,24 @@
+# Qdrant Module
+
+[Qdrant](https://qdrant.tech/) is an open-source, high-performance vector search engine/database. It provides a production-ready service with a convenient API to store, search, and manage points (i.e. vectors) with an additional payload.
+
+## Install
+
+```bash
+npm install @testcontainers/qdrant --save-dev
+```
+
+## Examples
+
+<!--codeinclude-->
+[Connect to Qdrant:](../../packages/modules/qdrant/src/qdrant-container.test.ts)
+inside_block:connectQdrantSimple
+<!--/codeinclude-->
+
+<!--codeinclude-->
+[Connect to Qdrant with an API key:](../../packages/modules/qdrant/src/qdrant-container.test.ts) inside_block:connectQdrantWithApiKey
+<!--/codeinclude-->
+
+<!--codeinclude-->
+[Customize Qdrant instance with a config file:](../../packages/modules/qdrant/src/qdrant-container.test.ts) inside_block:connectQdrantWithConfig
+<!--/codeinclude-->

mkdocs.yml

@@ -54,6 +54,7 @@ nav:
       - Nats: modules/nats.md
       - Neo4J: modules/neo4j.md
       - PostgreSQL: modules/postgresql.md
+      - Qdrant: modules/qdrant.md
       - Redis: modules/redis.md
       - Selenium: modules/selenium.md
   - Configuration: configuration.md

package-lock.json

@@ -0,0 +1,11 @@
+import type { Config } from "jest";
+import * as path from "path";
+
+const config: Config = {
+  preset: "ts-jest",
+  moduleNameMapper: {
+    "^testcontainers$": path.resolve(__dirname, "../../testcontainers/src"),
+  },
+};
+
+export default config;

packages/modules/qdrant/jest.config.ts

@@ -0,0 +1,38 @@
+{
+  "name": "@testcontainers/qdrant",
+  "version": "10.7.2",
+  "license": "MIT",
+  "keywords": [
+    "qdrant",
+    "testing",
+    "docker",
+    "testcontainers"
+  ],
+  "description": "Qdrant module for Testcontainers",
+  "homepage": "https://github.com/testcontainers/testcontainers-node#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/testcontainers/testcontainers-node"
+  },
+  "bugs": {
+    "url": "https://github.com/testcontainers/testcontainers-node/issues"
+  },
+  "main": "build/index.js",
+  "files": [
+    "build"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepack": "shx cp ../../../README.md . && shx cp ../../../LICENSE .",
+    "build": "tsc --project tsconfig.build.json"
+  },
+  
+  "devDependencies": {
+    "@qdrant/js-client-rest": "^1.8.0"
+  },
+  "dependencies": {
+    "testcontainers": "^10.7.2"
+  }
+}

packages/modules/qdrant/package.json

@@ -0,0 +1 @@
+export { QdrantContainer, StartedQdrantContainer } from "./qdrant-container";

packages/modules/qdrant/src/index.ts

@@ -0,0 +1,74 @@
+import { QdrantContainer } from "./qdrant-container";
+import { QdrantClient } from "@qdrant/js-client-rest";
+import crypto from "crypto";
+import path from "path";
+
+describe("QdrantContainer", () => {
+  jest.setTimeout(100_000);
+
+  // connectQdrantSimple {
+  it("should connect to the client", async () => {
+    const container = await new QdrantContainer().start();
+
+    const client = new QdrantClient({ url: `http://${container.getRestHostAddress()}` });
+
+    expect((await client.getCollections()).collections.length).toBe(0);
+
+    await container.stop();
+  });
+  // }
+
+  // connectQdrantWithApiKey {
+  it("should work with valid API keys", async () => {
+    const apiKey = crypto.randomUUID();
+
+    const container = await new QdrantContainer().withApiKey(apiKey).start();
+
+    const client = new QdrantClient({ url: `http://${container.getRestHostAddress()}`, apiKey });
+
+    expect((await client.getCollections()).collections.length).toBe(0);
+
+    await container.stop();
+  });
+  // }
+
+  it("should fail for invalid API keys", async () => {
+    const apiKey = crypto.randomUUID();
+
+    const container = await new QdrantContainer().withApiKey(apiKey).start();
+
+    const client = new QdrantClient({
+      url: `http://${container.getRestHostAddress()}`,
+      apiKey: "INVALID_KEY_" + crypto.randomUUID(),
+    });
+
+    expect(client.getCollections()).rejects.toThrow("Forbidden");
+
+    await container.stop();
+  });
+
+  // connectQdrantWithConfig {
+  it("should work with config files - valid API key", async () => {
+    const container = await new QdrantContainer().withConfigFile(path.resolve(__dirname, "test_config.yaml")).start();
+
+    const client = new QdrantClient({ url: `http://${container.getRestHostAddress()}`, apiKey: "SOME_TEST_KEY" });
+
+    expect((await client.getCollections()).collections.length).toBe(0);
+
+    await container.stop();
+  });
+  // }
+
+  it("should work with config files - invalid API key", async () => {
+    const container = await new QdrantContainer().withConfigFile(path.resolve(__dirname, "test_config.yaml")).start();
+
+    const client = new QdrantClient({
+      url: `http://${container.getRestHostAddress()}`,
+      apiKey: "INVALID_KEY_" + crypto.randomUUID(),
+    });
+
+    expect(client.getCollections()).rejects.toThrow("Forbidden");
+
+    await container.stop();
+  });
+});

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

@@ -0,0 +1,77 @@
+import { AbstractStartedContainer, GenericContainer, StartedTestContainer, Wait } from "testcontainers";
+
+const QDRANT_REST_PORT = 6333;
+const QDRANT_GRPC_PORT = 6334;
+const QDRANT_CONFIG_FILE_PATH = "/qdrant/config/config.yaml";
+
+export class QdrantContainer extends GenericContainer {
+  private apiKey: string | undefined;
+  private configFilePath: string | undefined;
+
+  constructor(image = "qdrant/qdrant:v1.8.1") {
+    super(image);
+    this.withExposedPorts(QDRANT_REST_PORT, QDRANT_GRPC_PORT);
+    this.withWaitStrategy(
+      Wait.forAll([
+        Wait.forLogMessage(/Actix runtime found; starting in Actix runtime/),
+        Wait.forHttp("/readyz", QDRANT_REST_PORT),
+      ])
+    );
+  }
+
+  public withApiKey(apiKey: string): this {
+    this.apiKey = apiKey;
+    return this;
+  }
+
+  public withConfigFile(configFile: string): this {
+    this.configFilePath = configFile;
+    return this;
+  }
+
+  public override async start(): Promise<StartedQdrantContainer> {
+    if (this.apiKey) {
+      this.withEnvironment({
+        QDRANT__SERVICE__API_KEY: this.apiKey,
+      });
+    }
+
+    if (this.configFilePath) {
+      this.withBindMounts([
+        {
+          target: QDRANT_CONFIG_FILE_PATH,
+          source: this.configFilePath,
+        },
+      ]);
+    }
+    return new StartedQdrantContainer(await super.start());
+  }
+}
+
+export class StartedQdrantContainer extends AbstractStartedContainer {
+  private readonly _restPort: number;
+
+  public get restPort(): number {
+    return this._restPort;
+  }
+
+  private readonly _grpcPort: number;
+
+  public get grpcPort(): number {
+    return this._grpcPort;
+  }
+
+  constructor(override readonly startedTestContainer: StartedTestContainer) {
+    super(startedTestContainer);
+    this._restPort = this.getMappedPort(QDRANT_REST_PORT);
+    this._grpcPort = this.getMappedPort(QDRANT_GRPC_PORT);
+  }
+
+  public getRestHostAddress(): string {
+    return `${this.getHost()}:${this.restPort}`;
+  }
+
+  public getGrpcHostAddress(): string {
+    return `${this.getHost()}:${this.grpcPort}`;
+  }
+}

packages/modules/qdrant/src/qdrant-container.ts

@@ -0,0 +1,6 @@
+# Qdrant image configuration file for testing
+# Reference: https://qdrant.tech/documentation/guides/configuration/#configuration-file-example
+log_level: INFO
+
+service:
+  api_key: "SOME_TEST_KEY"

packages/modules/qdrant/src/test_config.yaml

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "build",
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/test_config.yaml"
+  ],
+  "references": [
+    {
+      "path": "../../testcontainers"
+    }
+  ]
+}