@amqp-contract/testing 0.13.0 → 0.15.0

package/dist/extension.d.mts

@@ -1,9 +1,8 @@
 import amqpLib from "amqplib";
-import * as vitest0 from "vitest";
+import * as vitest from "vitest";
 
 //#region src/extension.d.ts
-
-declare const it: vitest0.TestAPI<{
+declare const it: vitest.TestAPI<{
   vhost: string;
   amqpConnectionUrl: string;
   amqpConnection: amqpLib.ChannelModel;

package/dist/extension.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"extension.d.mts","names":[],"sources":["../src/extension.ts"],"sourcesContent":[],"mappings":";;;;;AAee,cAAF,EAAE,EASD,OAAA,CATC,OAAA,CAAA;;;;;;0DASR;;;QACoD,QAAQ,OAAA,CAAQ"}
+{"version":3,"file":"extension.d.mts","names":[],"sources":["../src/extension.ts"],"mappings":";;;;cAea,EAAA,EASC,MAAA,CATC,OAAA;;;;;qCAKoB,UAAA,UAAoB,OAAA;mCAEnC,UAAA,aAEb,OAAA,EACF,OAAA;IAAY,QAAA;IAAmB,OAAA;EAAA,MAAuB,OAAA,CAAQ,OAAA,CAAQ,cAAA;AAAA"}

package/dist/global-setup.d.mts

@@ -1,7 +1,6 @@
 import { TestProject } from "vitest/node";
 
 //#region src/global-setup.d.ts
-
 declare module "vitest" {
   interface ProvidedContext {
     __TESTCONTAINERS_RABBITMQ_IP__: string;
@@ -36,7 +35,7 @@ declare module "vitest" {
  */
 declare function setup({
   provide
-}: TestProject): Promise<void>;
+}: TestProject): Promise<() => Promise<void>>;
 //#endregion
 export { setup as default };
 //# sourceMappingURL=global-setup.d.mts.map

package/dist/global-setup.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"global-setup.d.mts","names":[],"sources":["../src/global-setup.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyD8B,KAAA;;GAAmB,cAAW"}
+{"version":3,"file":"global-setup.d.mts","names":[],"sources":["../src/global-setup.ts"],"mappings":";;;;YAyBmB,eAAA;IACf,8BAAA;IACA,qCAAA;IACA,sCAAA;IACA,oCAAA;IACA,oCAAA;EAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;iBA2B0B,KAAA,CAAA;EAAQ;AAAA,GAAW,WAAA,GAAW,OAAA,OAAA,OAAA"}

package/dist/global-setup.mjs

@@ -49,18 +49,7 @@ async function setup({ provide }) {
 	const rabbitmqContainer = await new GenericContainer(rabbitmqImage).withExposedPorts(5672, 15672).withEnvironment({
 		RABBITMQ_DEFAULT_USER: "guest",
 		RABBITMQ_DEFAULT_PASS: "guest"
-	}).withHealthCheck({
-		test: [
-			"CMD",
-			"rabbitmq-diagnostics",
-			"-q",
-			"check_running"
-		],
-		interval: 1e3,
-		retries: 30,
-		startPeriod: 3e3,
-		timeout: 5e3
-	}).withWaitStrategy(Wait.forHealthCheck()).withReuse().withAutoRemove(true).start();
+	}).withWaitStrategy(Wait.forAll([Wait.forLogMessage(/Server startup complete/), Wait.forListeningPorts()])).start();
 	console.log("✅ RabbitMQ container started");
 	const __TESTCONTAINERS_RABBITMQ_IP__ = rabbitmqContainer.getHost();
 	const __TESTCONTAINERS_RABBITMQ_PORT_5672__ = rabbitmqContainer.getMappedPort(5672);
@@ -74,6 +63,11 @@ async function setup({ provide }) {
 	provide("__TESTCONTAINERS_RABBITMQ_PASSWORD__", __TESTCONTAINERS_RABBITMQ_PASSWORD__);
 	console.log(`🚀 RabbitMQ test environment is ready at ${__TESTCONTAINERS_RABBITMQ_IP__}:${__TESTCONTAINERS_RABBITMQ_PORT_5672__}`);
 	console.log(`📊 RabbitMQ management console available at http://${__TESTCONTAINERS_RABBITMQ_IP__}:${__TESTCONTAINERS_RABBITMQ_PORT_15672__}`);
+	return async () => {
+		console.log("🧹 Stopping RabbitMQ test environment...");
+		await rabbitmqContainer.stop();
+		console.log("✅ RabbitMQ container stopped");
+	};
 }
 
 //#endregion

package/dist/global-setup.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"global-setup.mjs","names":[],"sources":["../src/global-setup.ts"],"sourcesContent":["/**\n * Global setup module for starting RabbitMQ test containers\n *\n * This module provides a Vitest globalSetup function that automatically starts\n * a RabbitMQ container with the management plugin before tests run, and stops\n * it after all tests complete.\n *\n * The RabbitMQ image can be configured via the `RABBITMQ_IMAGE` environment variable.\n * By default, it uses the public Docker Hub image (`rabbitmq:4.2.1-management-alpine`).\n *\n * @module global-setup\n * @packageDocumentation\n */\n\nimport { GenericContainer, Wait } from \"testcontainers\";\nimport type { TestProject } from \"vitest/node\";\n\n/**\n * Default RabbitMQ Docker image to use for testing.\n * Can be overridden via RABBITMQ_IMAGE environment variable.\n */\nconst DEFAULT_RABBITMQ_IMAGE = \"rabbitmq:4.2.1-management-alpine\";\n\ndeclare module \"vitest\" {\n  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- Module augmentation requires interface for declaration merging\n  export interface ProvidedContext {\n    __TESTCONTAINERS_RABBITMQ_IP__: string;\n    __TESTCONTAINERS_RABBITMQ_PORT_5672__: number;\n    __TESTCONTAINERS_RABBITMQ_PORT_15672__: number;\n    __TESTCONTAINERS_RABBITMQ_USERNAME__: string;\n    __TESTCONTAINERS_RABBITMQ_PASSWORD__: string;\n  }\n}\n\n/**\n * Setup function for Vitest globalSetup\n *\n * Starts a RabbitMQ container before all tests and provides connection details\n * to tests via Vitest's provide API. The container is automatically stopped\n * and cleaned up after all tests complete.\n *\n * This function should be configured in your `vitest.config.ts`:\n *\n * @example\n * ```typescript\n * import { defineConfig } from \"vitest/config\";\n *\n * export default defineConfig({\n *   test: {\n *     globalSetup: [\"@amqp-contract/testing/global-setup\"],\n *   },\n * });\n * ```\n *\n * @param provide - Function to provide context values to tests\n * @returns Cleanup function that stops the RabbitMQ container\n */\nexport default async function setup({ provide }: TestProject) {\n  const rabbitmqImage = process.env[\"RABBITMQ_IMAGE\"] ?? DEFAULT_RABBITMQ_IMAGE;\n\n  console.log(\"🐳 Starting RabbitMQ test environment...\");\n  console.log(`📦 Using RabbitMQ image: ${rabbitmqImage}`);\n\n  // Start RabbitMQ container with management plugin\n  const rabbitmqContainer = await new GenericContainer(rabbitmqImage)\n    .withExposedPorts(5672, 15672)\n    .withEnvironment({\n      RABBITMQ_DEFAULT_USER: \"guest\",\n      RABBITMQ_DEFAULT_PASS: \"guest\",\n    })\n    .withHealthCheck({\n      test: [\"CMD\", \"rabbitmq-diagnostics\", \"-q\", \"check_running\"],\n      interval: 1_000,\n      retries: 30,\n      startPeriod: 3_000,\n      timeout: 5_000,\n    })\n    .withWaitStrategy(Wait.forHealthCheck())\n    .withReuse()\n    .withAutoRemove(true)\n    .start();\n\n  console.log(\"✅ RabbitMQ container started\");\n\n  const __TESTCONTAINERS_RABBITMQ_IP__ = rabbitmqContainer.getHost();\n  const __TESTCONTAINERS_RABBITMQ_PORT_5672__ = rabbitmqContainer.getMappedPort(5672);\n  const __TESTCONTAINERS_RABBITMQ_PORT_15672__ = rabbitmqContainer.getMappedPort(15672);\n  const __TESTCONTAINERS_RABBITMQ_USERNAME__ = \"guest\";\n  const __TESTCONTAINERS_RABBITMQ_PASSWORD__ = \"guest\";\n\n  // Provide context values with type assertions to work around TypeScript limitations\n  provide(\"__TESTCONTAINERS_RABBITMQ_IP__\", __TESTCONTAINERS_RABBITMQ_IP__);\n  provide(\"__TESTCONTAINERS_RABBITMQ_PORT_5672__\", __TESTCONTAINERS_RABBITMQ_PORT_5672__);\n  provide(\"__TESTCONTAINERS_RABBITMQ_PORT_15672__\", __TESTCONTAINERS_RABBITMQ_PORT_15672__);\n  provide(\"__TESTCONTAINERS_RABBITMQ_USERNAME__\", __TESTCONTAINERS_RABBITMQ_USERNAME__);\n  provide(\"__TESTCONTAINERS_RABBITMQ_PASSWORD__\", __TESTCONTAINERS_RABBITMQ_PASSWORD__);\n\n  console.log(\n    `🚀 RabbitMQ test environment is ready at ${__TESTCONTAINERS_RABBITMQ_IP__}:${__TESTCONTAINERS_RABBITMQ_PORT_5672__}`,\n  );\n  console.log(\n    `📊 RabbitMQ management console available at http://${__TESTCONTAINERS_RABBITMQ_IP__}:${__TESTCONTAINERS_RABBITMQ_PORT_15672__}`,\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAqBA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;AAoC/B,eAA8B,MAAM,EAAE,WAAwB;CAC5D,MAAM,gBAAgB,QAAQ,IAAI,qBAAqB;AAEvD,SAAQ,IAAI,2CAA2C;AACvD,SAAQ,IAAI,4BAA4B,gBAAgB;CAGxD,MAAM,oBAAoB,MAAM,IAAI,iBAAiB,cAAc,CAChE,iBAAiB,MAAM,MAAM,CAC7B,gBAAgB;EACf,uBAAuB;EACvB,uBAAuB;EACxB,CAAC,CACD,gBAAgB;EACf,MAAM;GAAC;GAAO;GAAwB;GAAM;GAAgB;EAC5D,UAAU;EACV,SAAS;EACT,aAAa;EACb,SAAS;EACV,CAAC,CACD,iBAAiB,KAAK,gBAAgB,CAAC,CACvC,WAAW,CACX,eAAe,KAAK,CACpB,OAAO;AAEV,SAAQ,IAAI,+BAA+B;CAE3C,MAAM,iCAAiC,kBAAkB,SAAS;CAClE,MAAM,wCAAwC,kBAAkB,cAAc,KAAK;CACnF,MAAM,yCAAyC,kBAAkB,cAAc,MAAM;CACrF,MAAM,uCAAuC;CAC7C,MAAM,uCAAuC;AAG7C,SAAQ,kCAAkC,+BAA+B;AACzE,SAAQ,yCAAyC,sCAAsC;AACvF,SAAQ,0CAA0C,uCAAuC;AACzF,SAAQ,wCAAwC,qCAAqC;AACrF,SAAQ,wCAAwC,qCAAqC;AAErF,SAAQ,IACN,4CAA4C,+BAA+B,GAAG,wCAC/E;AACD,SAAQ,IACN,sDAAsD,+BAA+B,GAAG,yCACzF"}
+{"version":3,"file":"global-setup.mjs","names":[],"sources":["../src/global-setup.ts"],"sourcesContent":["/**\n * Global setup module for starting RabbitMQ test containers\n *\n * This module provides a Vitest globalSetup function that automatically starts\n * a RabbitMQ container with the management plugin before tests run, and stops\n * it after all tests complete.\n *\n * The RabbitMQ image can be configured via the `RABBITMQ_IMAGE` environment variable.\n * By default, it uses the public Docker Hub image (`rabbitmq:4.2.1-management-alpine`).\n *\n * @module global-setup\n * @packageDocumentation\n */\n\nimport { GenericContainer, Wait } from \"testcontainers\";\nimport type { TestProject } from \"vitest/node\";\n\n/**\n * Default RabbitMQ Docker image to use for testing.\n * Can be overridden via RABBITMQ_IMAGE environment variable.\n */\nconst DEFAULT_RABBITMQ_IMAGE = \"rabbitmq:4.2.1-management-alpine\";\n\ndeclare module \"vitest\" {\n  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- Module augmentation requires interface for declaration merging\n  export interface ProvidedContext {\n    __TESTCONTAINERS_RABBITMQ_IP__: string;\n    __TESTCONTAINERS_RABBITMQ_PORT_5672__: number;\n    __TESTCONTAINERS_RABBITMQ_PORT_15672__: number;\n    __TESTCONTAINERS_RABBITMQ_USERNAME__: string;\n    __TESTCONTAINERS_RABBITMQ_PASSWORD__: string;\n  }\n}\n\n/**\n * Setup function for Vitest globalSetup\n *\n * Starts a RabbitMQ container before all tests and provides connection details\n * to tests via Vitest's provide API. The container is automatically stopped\n * and cleaned up after all tests complete.\n *\n * This function should be configured in your `vitest.config.ts`:\n *\n * @example\n * ```typescript\n * import { defineConfig } from \"vitest/config\";\n *\n * export default defineConfig({\n *   test: {\n *     globalSetup: [\"@amqp-contract/testing/global-setup\"],\n *   },\n * });\n * ```\n *\n * @param provide - Function to provide context values to tests\n * @returns Cleanup function that stops the RabbitMQ container\n */\nexport default async function setup({ provide }: TestProject) {\n  const rabbitmqImage = process.env[\"RABBITMQ_IMAGE\"] ?? DEFAULT_RABBITMQ_IMAGE;\n\n  console.log(\"🐳 Starting RabbitMQ test environment...\");\n  console.log(`📦 Using RabbitMQ image: ${rabbitmqImage}`);\n\n  // Start RabbitMQ container with management plugin\n  const rabbitmqContainer = await new GenericContainer(rabbitmqImage)\n    .withExposedPorts(5672, 15672)\n    .withEnvironment({\n      RABBITMQ_DEFAULT_USER: \"guest\",\n      RABBITMQ_DEFAULT_PASS: \"guest\",\n    })\n    .withWaitStrategy(\n      Wait.forAll([Wait.forLogMessage(/Server startup complete/), Wait.forListeningPorts()]),\n    )\n    .start();\n\n  console.log(\"✅ RabbitMQ container started\");\n\n  const __TESTCONTAINERS_RABBITMQ_IP__ = rabbitmqContainer.getHost();\n  const __TESTCONTAINERS_RABBITMQ_PORT_5672__ = rabbitmqContainer.getMappedPort(5672);\n  const __TESTCONTAINERS_RABBITMQ_PORT_15672__ = rabbitmqContainer.getMappedPort(15672);\n  const __TESTCONTAINERS_RABBITMQ_USERNAME__ = \"guest\";\n  const __TESTCONTAINERS_RABBITMQ_PASSWORD__ = \"guest\";\n\n  // Provide context values with type assertions to work around TypeScript limitations\n  provide(\"__TESTCONTAINERS_RABBITMQ_IP__\", __TESTCONTAINERS_RABBITMQ_IP__);\n  provide(\"__TESTCONTAINERS_RABBITMQ_PORT_5672__\", __TESTCONTAINERS_RABBITMQ_PORT_5672__);\n  provide(\"__TESTCONTAINERS_RABBITMQ_PORT_15672__\", __TESTCONTAINERS_RABBITMQ_PORT_15672__);\n  provide(\"__TESTCONTAINERS_RABBITMQ_USERNAME__\", __TESTCONTAINERS_RABBITMQ_USERNAME__);\n  provide(\"__TESTCONTAINERS_RABBITMQ_PASSWORD__\", __TESTCONTAINERS_RABBITMQ_PASSWORD__);\n\n  console.log(\n    `🚀 RabbitMQ test environment is ready at ${__TESTCONTAINERS_RABBITMQ_IP__}:${__TESTCONTAINERS_RABBITMQ_PORT_5672__}`,\n  );\n  console.log(\n    `📊 RabbitMQ management console available at http://${__TESTCONTAINERS_RABBITMQ_IP__}:${__TESTCONTAINERS_RABBITMQ_PORT_15672__}`,\n  );\n\n  // Return cleanup function that stops the container\n  return async () => {\n    console.log(\"🧹 Stopping RabbitMQ test environment...\");\n    await rabbitmqContainer.stop();\n    console.log(\"✅ RabbitMQ container stopped\");\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAqBA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;AAoC/B,eAA8B,MAAM,EAAE,WAAwB;CAC5D,MAAM,gBAAgB,QAAQ,IAAI,qBAAqB;AAEvD,SAAQ,IAAI,2CAA2C;AACvD,SAAQ,IAAI,4BAA4B,gBAAgB;CAGxD,MAAM,oBAAoB,MAAM,IAAI,iBAAiB,cAAc,CAChE,iBAAiB,MAAM,MAAM,CAC7B,gBAAgB;EACf,uBAAuB;EACvB,uBAAuB;EACxB,CAAC,CACD,iBACC,KAAK,OAAO,CAAC,KAAK,cAAc,0BAA0B,EAAE,KAAK,mBAAmB,CAAC,CAAC,CACvF,CACA,OAAO;AAEV,SAAQ,IAAI,+BAA+B;CAE3C,MAAM,iCAAiC,kBAAkB,SAAS;CAClE,MAAM,wCAAwC,kBAAkB,cAAc,KAAK;CACnF,MAAM,yCAAyC,kBAAkB,cAAc,MAAM;CACrF,MAAM,uCAAuC;CAC7C,MAAM,uCAAuC;AAG7C,SAAQ,kCAAkC,+BAA+B;AACzE,SAAQ,yCAAyC,sCAAsC;AACvF,SAAQ,0CAA0C,uCAAuC;AACzF,SAAQ,wCAAwC,qCAAqC;AACrF,SAAQ,wCAAwC,qCAAqC;AAErF,SAAQ,IACN,4CAA4C,+BAA+B,GAAG,wCAC/E;AACD,SAAQ,IACN,sDAAsD,+BAA+B,GAAG,yCACzF;AAGD,QAAO,YAAY;AACjB,UAAQ,IAAI,2CAA2C;AACvD,QAAM,kBAAkB,MAAM;AAC9B,UAAQ,IAAI,+BAA+B"}

package/docs/extension.md

@@ -0,0 +1,30 @@
+[**@amqp-contract/testing**](index.md)
+
+***
+
+[@amqp-contract/testing](index.md) / extension
+
+# extension
+
+Vitest extension module for AMQP testing utilities
+
+This module provides a Vitest test extension that adds AMQP-specific fixtures
+to your tests. Each test gets an isolated virtual host (vhost) with pre-configured
+connections, channels, and helper functions for publishing and consuming messages.
+
+## Variables
+
+### it
+
+```ts
+const it: TestAPI<{
+  amqpChannel: Channel;
+  amqpConnection: ChannelModel;
+  amqpConnectionUrl: string;
+  initConsumer: (exchange, routingKey) => Promise<(options?) => Promise<ConsumeMessage[]>>;
+  publishMessage: (exchange, routingKey, content) => void;
+  vhost: string;
+}>;
+```
+
+Defined in: [extension.ts:16](https://github.com/btravers/amqp-contract/blob/a7c4b48f76ed6c3c5c7a9d457229c7ba475af3b1/packages/testing/src/extension.ts#L16)

package/docs/global-setup.md

@@ -0,0 +1,58 @@
+[**@amqp-contract/testing**](index.md)
+
+***
+
+[@amqp-contract/testing](index.md) / global-setup
+
+# global-setup
+
+Global setup module for starting RabbitMQ test containers
+
+This module provides a Vitest globalSetup function that automatically starts
+a RabbitMQ container with the management plugin before tests run, and stops
+it after all tests complete.
+
+The RabbitMQ image can be configured via the `RABBITMQ_IMAGE` environment variable.
+By default, it uses the public Docker Hub image (`rabbitmq:4.2.1-management-alpine`).
+
+## Functions
+
+### default()
+
+```ts
+function default(provide): Promise<() => Promise<void>>;
+```
+
+Defined in: [global-setup.ts:58](https://github.com/btravers/amqp-contract/blob/a7c4b48f76ed6c3c5c7a9d457229c7ba475af3b1/packages/testing/src/global-setup.ts#L58)
+
+Setup function for Vitest globalSetup
+
+Starts a RabbitMQ container before all tests and provides connection details
+to tests via Vitest's provide API. The container is automatically stopped
+and cleaned up after all tests complete.
+
+This function should be configured in your `vitest.config.ts`:
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `provide` | `TestProject` | Function to provide context values to tests |
+
+#### Returns
+
+`Promise`&lt;() => `Promise`&lt;`void`&gt;&gt;
+
+Cleanup function that stops the RabbitMQ container
+
+#### Example
+
+```typescript
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    globalSetup: ["@amqp-contract/testing/global-setup"],
+  },
+});
+```

package/docs/index.md

@@ -0,0 +1,10 @@
+**@amqp-contract/testing**
+
+***
+
+# @amqp-contract/testing
+
+## Modules
+
+- [extension](extension.md)
+- [global-setup](global-setup.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amqp-contract/testing",
-  "version": "0.13.0",
+  "version": "0.15.0",
   "description": "Testing utilities for AMQP contracts with testcontainers",
   "keywords": [
     "amqp",
@@ -30,7 +30,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "docs"
   ],
   "dependencies": {
     "amqplib": "0.10.9",
@@ -38,11 +39,11 @@
   },
   "devDependencies": {
     "@types/amqplib": "0.10.8",
-    "tsdown": "0.19.0",
+    "tsdown": "0.20.3",
     "typedoc": "0.28.16",
     "typedoc-plugin-markdown": "4.9.0",
     "typescript": "5.9.3",
-    "vitest": "4.0.17",
+    "vitest": "4.0.18",
     "@amqp-contract/tsconfig": "0.1.0",
     "@amqp-contract/typedoc": "0.1.0"
   },