@celerity-sdk/testing 0.8.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,376 @@
+# @celerity-sdk/testing
+
+Testing utilities for Celerity applications. Provides a test app factory, mock resource factories, JWT generation, HTTP/WebSocket test clients, and integration test helpers.
+
+## Install
+
+```bash
+npm install -D @celerity-sdk/testing
+# or
+pnpm add -D @celerity-sdk/testing
+# or
+yarn add -D @celerity-sdk/testing
+```
+
+## Running Tests
+
+API and integration tests are designed to run with the `celerity dev test` commands, which start your application in the Celerity runtime with local infrastructure and set the environment variables that the test helpers read. This means `createTestClient`, `createTestWsClient`, `generateTestToken`, and `createTestApp` with `integration: true` all work out of the box with zero configuration.
+
+```bash
+# Run API tests against the local runtime
+celerity dev test --suite api
+
+# Run integration tests with local infrastructure
+celerity dev test --suite integration
+```
+
+You can override the defaults with environment variables (`CELERITY_TEST_BASE_URL`, `CELERITY_DEV_AUTH_BASE_URL`, etc.) if you need to point at a different endpoint.
+
+## Quick Start
+
+### Unit Testing
+
+```typescript
+import { createTestApp, TestApp } from "@celerity-sdk/testing";
+import { AppModule } from "../src/app.module";
+
+describe("OrderController", () => {
+  let app: TestApp;
+
+  beforeAll(async () => {
+    app = await createTestApp({ module: AppModule });
+  });
+
+  afterAll(() => app.close());
+
+  it("should create an order", async () => {
+    const datastore = app.getDatastoreMock("ordersDatastore");
+    datastore.putItem.mockResolvedValue(undefined);
+
+    const res = await app.injectHttp({
+      method: "POST",
+      path: "/orders",
+      body: { item: "widget", qty: 3 },
+    });
+
+    expect(res.statusCode).toBe(201);
+    expect(datastore.putItem).toHaveBeenCalled();
+  });
+});
+```
+
+### Integration Testing
+
+When `integration: true`, the test app auto-discovers resource tokens from the module graph and creates real resource clients using local endpoints. Resolve services from the DI container and test against real infrastructure:
+
+```typescript
+import { createTestApp, type TestApp } from "@celerity-sdk/testing";
+import { TasksModule } from "../../src/tasks/tasks-module.js";
+import { TasksService } from "../../src/tasks/tasks-service.js";
+
+describe("TasksService (integration)", () => {
+  let app: TestApp;
+  let service: TasksService;
+
+  beforeAll(async () => {
+    app = await createTestApp({ module: TasksModule, integration: true });
+    service = await app.getContainer().resolve(TasksService);
+  });
+
+  afterAll(() => app.close());
+
+  it("creates a task with status pending", async () => {
+    const task = await service.create({
+      title: "Integration test task",
+      assigneeId: "user-001",
+    });
+
+    expect(task.taskId).toBeDefined();
+    expect(task.status).toBe("pending");
+    expect(task.assigneeId).toBe("user-001");
+  });
+
+  it("finds task by ID", async () => {
+    const task = await service.create({ title: "Find by ID task" });
+    const found = await service.findById(task.taskId);
+
+    expect(found).not.toBeNull();
+    expect(found!.title).toBe("Find by ID task");
+  });
+});
+```
+
+### API Testing
+
+`createTestClient` automatically connects to the application endpoint managed by `celerity dev test --suite api`, no URL configuration needed. Pair it with `generateTestToken` to test authenticated endpoints:
+
+```typescript
+import {
+  createTestClient,
+  generateTestToken,
+  type TestHttpClient,
+} from "@celerity-sdk/testing";
+
+describe("Users API", () => {
+  let client: TestHttpClient;
+  let adminToken: string;
+  let userToken: string;
+
+  beforeAll(async () => {
+    client = createTestClient();
+    adminToken = await generateTestToken({ sub: "admin-1", claims: { roles: ["admin"] } });
+    userToken = await generateTestToken({ sub: "user-1", claims: { roles: ["viewer"] } });
+  });
+
+  it("GET /users requires auth (401)", async () => {
+    await client.get("/users").expect(401);
+  });
+
+  it("GET /users returns list with valid token", async () => {
+    const resp = await client.get("/users").auth(adminToken).expect(200);
+    expect(Array.isArray(resp.body)).toBe(true);
+  });
+
+  it("POST /users requires admin (403 with viewer token)", async () => {
+    await client
+      .post("/users")
+      .auth(userToken)
+      .send({ name: "Forbidden User", email: "forbidden@example.com" })
+      .expect(403);
+  });
+
+  it("POST /users creates user with admin token", async () => {
+    const resp = await client
+      .post<{ userId: string; name: string }>("/users")
+      .auth(adminToken)
+      .send({ name: "New User", email: "new@example.com" })
+      .expect(200);
+
+    expect(resp.body.userId).toBeDefined();
+    expect(resp.body.name).toBe("New User");
+  });
+});
+```
+
+### WebSocket Testing
+
+`createTestWsClient` automatically derives the WebSocket endpoint and route configuration from your application blueprint, no manual URL or path setup required:
+
+```typescript
+import { createTestWsClient, type TestWsClient } from "@celerity-sdk/testing";
+
+describe("WebSocket API", () => {
+  let ws: TestWsClient;
+
+  afterEach(() => ws?.destroy());
+
+  it("connects and authenticates", async () => {
+    ws = await createTestWsClient();
+    await ws.connect();
+    expect(ws.state).toBe("ready");
+  });
+
+  it("subscribes to channels", async () => {
+    ws = await createTestWsClient();
+    await ws.connect();
+
+    ws.send("notifications", {
+      action: "subscribe",
+      channels: ["alerts", "updates"],
+    });
+
+    const msg = await ws.nextMessage(10_000);
+    expect(msg.route).toBe("notifications");
+  });
+
+  it("rejects unauthenticated connections", async () => {
+    ws = await createTestWsClient({ token: null });
+    try {
+      await ws.connect();
+    } catch {
+      // Connection rejected, expected for connect-strategy auth
+    }
+  });
+});
+```
+
+## API
+
+### `createTestApp(options)`
+
+Creates a test application for unit or integration testing.
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `module` | `Type` | *(required)* | Root module to bootstrap |
+| `integration` | `boolean` | `false` | Use real resource clients instead of mocks |
+| `providers` | `Provider[]` | `[]` | Additional providers to register |
+| `controllers` | `Type[]` | `[]` | Additional controllers |
+| `guards` | `Type[]` | `[]` | Additional guards |
+| `overrides` | `Provider[]` | `[]` | Override providers (registered last, highest priority) |
+| `blueprintPath` | `string` | auto-detected | Path to `app.blueprint.yaml` |
+
+Returns a `TestApp` with these methods:
+
+| Method | Description |
+|---|---|
+| `injectHttp(request)` | Inject an HTTP request |
+| `injectWebSocket(route, message)` | Inject a WebSocket message |
+| `injectConsumer(handlerTag, event)` | Inject a consumer event |
+| `injectSchedule(handlerTag, event)` | Inject a schedule event |
+| `injectCustom(name, payload?)` | Inject a custom event |
+| `getContainer()` | Access the DI container |
+| `getRegistry()` | Access the handler registry |
+| `getMock<T>(token)` | Get mock by token symbol |
+| `getDatastoreMock(name)` | Get mock datastore by resource name |
+| `getTopicMock(name)` | Get mock topic by resource name |
+| `getQueueMock(name)` | Get mock queue by resource name |
+| `getCacheMock(name)` | Get mock cache by resource name |
+| `getBucketMock(name)` | Get mock bucket by resource name |
+| `getConfigMock(name)` | Get mock config namespace by resource name |
+| `close()` | Close all real clients (integration mode) |
+
+### `createTestClient(options?)`
+
+HTTP test client with chainable assertions, similar to supertest.
+
+```typescript
+import { createTestClient } from "@celerity-sdk/testing";
+
+const client = createTestClient(); // reads CELERITY_TEST_BASE_URL
+
+const res = await client
+  .get("/orders/123")
+  .auth(token)
+  .expect(200)
+  .expect("content-type", /json/)
+  .end();
+
+expect(res.body.id).toBe("123");
+```
+
+| Method | Description |
+|---|---|
+| `get(path)`, `post(path)`, `put(path)`, `patch(path)`, `delete(path)` | Start a request |
+| `.auth(token)` | Set `Authorization: Bearer <token>` |
+| `.set(header, value)` | Set a request header |
+| `.send(body)` | Set JSON request body |
+| `.expect(status)` | Assert status code |
+| `.expect(header, value)` | Assert response header (string or RegExp) |
+| `.expect(body)` | Assert response body equality |
+| `.expect(fn)` | Assert with custom function |
+| `.end()` | Execute request and run assertions |
+
+Requests are also `thenable` so you can `await` them directly without calling `.end()`.
+
+### `createTestWsClient(options?)`
+
+WebSocket test client for sequential message flow testing.
+
+```typescript
+import { createTestWsClient, generateTestToken } from "@celerity-sdk/testing";
+
+const ws = await createTestWsClient({ token: { sub: "user-1" } });
+await ws.connect();
+
+ws.send("placeOrder", { item: "widget" });
+const reply = await ws.nextMessage();
+
+expect(reply.route).toBe("orderConfirmed");
+await ws.disconnect();
+```
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `url` | `string` | auto-derived from blueprint | WebSocket endpoint URL |
+| `token` | `string \| GenerateTestTokenOptions \| null` | `{}` | Auth token. Pass `null` to skip auth. |
+| `blueprintPath` | `string` | auto-detected | Path to blueprint file |
+| `clientConfig` | `object` | `{}` | Additional config for the underlying WS client |
+
+### `generateTestToken(options?)`
+
+Generates an RS256-signed JWT via the local dev auth server.
+
+```typescript
+import { generateTestToken } from "@celerity-sdk/testing";
+
+const token = await generateTestToken({
+  sub: "user-42",
+  claims: { role: "admin", org_id: "org-1" },
+  expiresIn: "2h",
+});
+```
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `sub` | `string` | `"test-user"` | Subject claim |
+| `claims` | `Record<string, unknown>` | `{}` | Additional JWT claims |
+| `expiresIn` | `string` | `"1h"` | Token lifetime (Go-style duration) |
+
+Reads `CELERITY_DEV_AUTH_BASE_URL` (default: `http://localhost:9099`).
+
+### `waitFor(predicate, options?)`
+
+Polls a predicate until it returns `true` or the timeout expires.
+
+```typescript
+import { waitFor } from "@celerity-sdk/testing";
+
+await waitFor(async () => {
+  const item = await datastore.getItem({ id: "order-1" });
+  return item !== null;
+}, { timeout: 10_000, interval: 200 });
+```
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `timeout` | `number` | `5000` | Timeout in milliseconds |
+| `interval` | `number` | `100` | Poll interval in milliseconds |
+
+### `discoverResourceTokens(rootModule)`
+
+Statically walks the module graph and extracts all resource DI tokens from constructor parameters without instantiating anything.
+
+### `createRealClients(tokens, blueprintResources)`
+
+Creates real resource client handles for integration testing. Dynamically imports only the SDK packages actually needed.
+
+### Mock Factories
+
+`createResourceMock(resourceType)` creates a mock object with all interface methods stubbed. Used internally by `createTestApp`, but available for standalone use:
+
+```typescript
+import { createResourceMock } from "@celerity-sdk/testing";
+
+const mock = createResourceMock("datastore");
+// mock.getItem, mock.putItem, mock.query, ...
+```
+
+### Re-exports
+
+The following are re-exported from `@celerity-sdk/core` for convenience:
+
+- `mockRequest` creates a mock `HttpRequest`
+- `mockWebSocketMessage` creates a mock `WebSocketMessage`
+- `mockConsumerEvent` creates a mock `ConsumerEventInput`
+- `mockScheduleEvent` creates a mock `ScheduleEventInput`
+
+## Optional Peer Dependencies
+
+Install only the SDK packages your module actually uses:
+
+```bash
+# Example: app uses datastore + topic
+pnpm add -D @celerity-sdk/datastore @celerity-sdk/topic
+```
+
+| Package | Required for |
+|---|---|
+| `@celerity-sdk/datastore` | Datastore mocks / integration clients |
+| `@celerity-sdk/bucket` | Bucket mocks / integration clients |
+| `@celerity-sdk/cache` | Cache mocks / integration clients |
+| `@celerity-sdk/queue` | Queue mocks / integration clients |
+| `@celerity-sdk/topic` | Topic mocks / integration clients |
+| `@celerity-sdk/sql-database` | SQL database integration clients |
+| `@celerity-sdk/ws-client` | WebSocket test client |
+| `reflect-metadata` | Decorator metadata resolution |