@amqp-contract/testing 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Benoit Travers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,100 @@
+# @amqp-contract/testing
+
+Testing utilities for AMQP contracts using testcontainers.
+
+## Features
+
+- 🐳 Automatically starts RabbitMQ container for tests
+- ✅ Works with Vitest globalSetup
+- 🚀 Fast and reliable integration testing
+- 📊 Includes RabbitMQ management console
+
+## Installation
+
+```bash
+pnpm add -D @amqp-contract/testing
+```
+
+## Usage
+
+### 1. Configure Vitest
+
+Add to your `vitest.config.ts`:
+
+```typescript
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    globalSetup: ["@amqp-contract/testing/global-setup"],
+  },
+});
+```
+
+### 2. TypeScript Support
+
+For TypeScript projects, reference the type definitions in your `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["@amqp-contract/testing/types/vitest"]
+  }
+}
+```
+
+Or add a triple-slash reference in your test files:
+
+```typescript
+/// <reference types="@amqp-contract/testing/types/vitest" />
+```
+
+This provides type-safe access to the test container context variables.
+
+### 3. Use Vitest Extension in Tests
+
+The package provides a Vitest extension that automatically manages RabbitMQ connections:
+
+```typescript
+import { describe, expect } from "vitest";
+import { it } from "@amqp-contract/testing/extension";
+
+describe("Order Processing", () => {
+  it("should publish and consume messages", async ({ amqpConnection }) => {
+    // amqpConnection is automatically provided and cleaned up
+    // Your test code here using amqpConnection
+  });
+});
+```
+
+The extension provides:
+
+- `amqpConnection`: An established connection to the RabbitMQ testcontainer
+- Automatic connection cleanup after each test
+
+## What It Does
+
+The global setup:
+
+1. Starts a RabbitMQ container with management plugin
+2. Waits for RabbitMQ to be healthy
+3. Provides connection details to your tests
+4. Cleans up the container after tests complete
+
+## Container Details
+
+- **Image**: `rabbitmq:3-management-alpine`
+- **Ports**:
+  - 5672 (AMQP)
+  - 15672 (Management console)
+- **Credentials**:
+  - User: `guest`
+  - Password: `guest`
+
+## Environment Variables
+
+The following variables are provided to tests:
+
+- `__TESTCONTAINERS_RABBITMQ_IP__` - Container host IP
+- `__TESTCONTAINERS_RABBITMQ_PORT_5672__` - Mapped AMQP port
+- `__TESTCONTAINERS_RABBITMQ_PORT_15672__` - Mapped management port

package/dist/extension.d.mts

@@ -0,0 +1,10 @@
+import { ChannelModel } from "amqplib";
+import * as vitest0 from "vitest";
+
+//#region src/extension.d.ts
+declare const it: vitest0.TestAPI<{
+  amqpConnection: ChannelModel;
+}>;
+//#endregion
+export { it };
+//# sourceMappingURL=extension.d.mts.map

package/dist/extension.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension.d.mts","names":[],"sources":["../src/extension.ts"],"sourcesContent":[],"mappings":";;;;cAGa,IAWX,OAAA,CAXa;kBAWb"}