Add Clickhouse module

docs/modules/clickhouse.md

@@ -0,0 +1,13 @@
+# Clickhouse Module
+
+[Clickhouse](https://clickhouse.com/) is an open source OLAP columnar database. You can checkout the official [Clickhouse JavaScript](https://clickhouse.com/docs/en/integrations/language-clients/javascript) driver here.
+
+## Install
+
+```bash
+npm install @testcontainers/clickhouse --save-dev
+```
+
+## Example
+
+[Test suite](../../packages/modules/clickhouse/src/clickhouse-container.test.ts)

mkdocs.yml

@@ -43,6 +43,7 @@ nav:
       - Advanced: features/advanced.md
   - Modules:
       - ArangoDB: modules/arangodb.md
+      - Clickhouse: modules/clickhouse.md
       - Couchbase: modules/couchbase.md
       - Elasticsearch: modules/elasticsearch.md
       - HiveMQ: modules/hivemq.md

packages/modules/clickhouse/jest.config.ts

@@ -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/clickhouse/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@testcontainers/clickhouse",
+  "version": "10.2.1",
+  "license": "MIT",
+  "keywords": [
+    "clickhouse",
+    "testing",
+    "docker",
+    "testcontainers"
+  ],
+  "description": "Clickhouse 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": {
+    "@clickhouse/client": "^0.2.2"
+  },
+  "dependencies": {
+    "testcontainers": "^10.2.1"
+  }
+}

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

@@ -0,0 +1,99 @@
+import { ClickhouseContainer, StartedClickhouseContainer } from "./clickhouse-container";
+import { ClickHouseClient, createClient } from "@clickhouse/client";
+import path from "path";
+import { RandomUuid } from "testcontainers";
+
+const CONFIG_FILE_MODE = parseInt("0644", 8);
+
+describe("ClickhouseContainer", () => {
+  jest.setTimeout(240_000);
+
+  it("should work with defaults", async () => {
+    const container = await new ClickhouseContainer().start();
+    const client = createClickhouseContainerHttpClient(container);
+    await testExample(client, container.getDatabase());
+    await client.close();
+    await container.stop();
+  });
+
+  it("should work with custom credentials", async () => {
+    const uuid = new RandomUuid();
+    const container = await new ClickhouseContainer()
+      .withUsername(`un-${uuid.nextUuid()}`)
+      .withPassword(`pass-${uuid.nextUuid()}`)
+      .start();
+    const client = createClickhouseContainerHttpClient(container);
+    await testExample(client, container.getDatabase());
+    await client.close();
+    await container.stop();
+  });
+
+  it("should work with custom database and custom yaml config", async () => {
+    const uuid = new RandomUuid();
+    const CONFIG_PATH_YAML = "/etc/clickhouse-server/config.d/config.yaml";
+    const container = await new ClickhouseContainer()
+      .withDatabase(`db-${uuid.nextUuid()}`)
+      .withPassword("")
+      .withCopyFilesToContainer([
+        { source: path.join("testdata", "config.yaml"), target: CONFIG_PATH_YAML, mode: CONFIG_FILE_MODE },
+      ])
+      .start();
+    const client = createClickhouseContainerHttpClient(container);
+    await testExample(client, container.getDatabase());
+    await client.close();
+    await container.stop();
+  });
+
+  it("should work with custom image and custom xml config example", async () => {
+    const CONFIG_PATH_XML = "/etc/clickhouse-server/config.d/config.xml";
+    const container = await new ClickhouseContainer("23.8-alpine")
+      .withPassword("")
+      .withCopyFilesToContainer([
+        { source: path.join("testdata", "config.xml"), target: CONFIG_PATH_XML, mode: CONFIG_FILE_MODE },
+      ])
+      .start();
+    const client = createClickhouseContainerHttpClient(container);
+    await testExample(client, container.getDatabase());
+    await client.close();
+    await container.stop();
+  });
+
+  function createClickhouseContainerHttpClient(container: StartedClickhouseContainer) {
+    return createClient({
+      host: container.getHttpUrl(),
+      username: container.getUsername(),
+      password: container.getPassword(),
+    });
+  }
+
+  async function testExample(client: ClickHouseClient, db: string) {
+    const tableName = "array_json_each_row";
+    await client.command({
+      query: `DROP TABLE IF EXISTS ${db}.${tableName}`,
+    });
+    await client.command({
+      query: `
+        CREATE TABLE ${db}.${tableName}
+        (id UInt64, name String)
+        ENGINE MergeTree()
+        ORDER BY (id)
+      `,
+    });
+    await client.insert({
+      table: `${db}.${tableName}`,
+      values: [
+        { id: 42, name: "foo" },
+        { id: 42, name: "bar" },
+      ],
+      format: "JSONEachRow",
+    });
+    const rows = await client.query({
+      query: `SELECT * FROM ${db}.${tableName}`,
+      format: "JSONEachRow",
+    });
+    expect(await rows.json()).toEqual([
+      { id: "42", name: "foo" },
+      { id: "42", name: "bar" },
+    ]);
+  }
+});

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

@@ -0,0 +1,94 @@
+import { AbstractStartedContainer, GenericContainer, StartedTestContainer, Wait } from "testcontainers";
+
+const IMAGE_NAME = "clickhouse/clickhouse-server";
+const DEFAULT_IMAGE_VER = "23.3.8.21-alpine";
+
+// The official clickhouse-js client doesn't support the native protocol for now. See https://github.com/ClickHouse/clickhouse-js
+const HTTP_PORT = 8123;
+const HTTPS_PORT = 8443;
+
+export class ClickhouseContainer extends GenericContainer {
+  private database = "test";
+  private username = "test";
+  private password = "test";
+
+  constructor(imageVer = DEFAULT_IMAGE_VER) {
+    super(`${IMAGE_NAME}:${imageVer}`);
+  }
+
+  public withDatabase(database: string): this {
+    this.database = database;
+    return this;
+  }
+
+  public withUsername(username: string): this {
+    this.username = username;
+    return this;
+  }
+
+  public withPassword(password: string): this {
+    this.password = password;
+    return this;
+  }
+
+  public override async start(): Promise<StartedClickhouseContainer> {
+    this.withExposedPorts(...(this.hasExposedPorts ? this.exposedPorts : [HTTP_PORT, HTTPS_PORT]))
+      .withEnvironment({
+        CLICKHOUSE_DB: this.database,
+        CLICKHOUSE_USER: this.username,
+        CLICKHOUSE_PASSWORD: this.password,
+      })
+      .withWaitStrategy(Wait.forHttp("/ping", HTTP_PORT).forStatusCode(200))
+      .withStartupTimeout(120_000);
+    return new StartedClickhouseContainer(
+      await super.start(),
+      HTTP_PORT,
+      HTTPS_PORT,
+      this.database,
+      this.username,
+      this.password
+    );
+  }
+}
+
+export class StartedClickhouseContainer extends AbstractStartedContainer {
+  private readonly hostHttpPort: number;
+  private readonly hostHttpsPort: number;
+
+  constructor(
+    startedTestContainer: StartedTestContainer,
+    httpPort: number,
+    httpsPort: number,
+    private readonly database: string,
+    private readonly username: string,
+    private readonly password: string
+  ) {
+    super(startedTestContainer);
+    this.hostHttpPort = startedTestContainer.getMappedPort(httpPort);
+    this.hostHttpsPort = startedTestContainer.getMappedPort(httpsPort);
+  }
+
+  public getHttpUrl(): string {
+    return this.toUrl("http", this.hostHttpPort);
+  }
+
+  public getHttpsUrl(): string {
+    return this.toUrl("https", this.hostHttpsPort);
+  }
+
+  private toUrl(schema: string, port: number): string {
+    return `${schema}://${this.startedTestContainer.getHost()}:${port}`;
+  }
+
+  public getDatabase(): string {
+    return this.database;
+  }
+
+  public getUsername(): string {
+    return this.username;
+  }
+
+  public getPassword(): string {
+    return this.password;
+  }
+}

packages/modules/clickhouse/src/index.ts

@@ -0,0 +1 @@
+export { ClickhouseContainer, StartedClickhouseContainer } from "./clickhouse-container";

packages/modules/clickhouse/testdata/config.xml

@@ -0,0 +1,3 @@
+<clickhouse>
+  <allow_no_password>1</allow_no_password>
+</clickhouse>

packages/modules/clickhouse/testdata/config.yaml

@@ -0,0 +1 @@
+allow_no_password: true

packages/modules/clickhouse/tsconfig.build.json

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

packages/modules/clickhouse/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "build",
+    "paths": {
+      "testcontainers": [
+        "../../testcontainers/src"
+      ]
+    }
+  },
+  "exclude": [
+    "build",
+    "jest.config.ts"
+  ],
+  "references": [
+    {
+      "path": "../../testcontainers"
+    }
+  ]
+}