@cdktn/vitest 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 cdktn-io
+
+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/NOTICE

@@ -0,0 +1,21 @@
+@cdktn/vitest
+Copyright (c) 2026 cdktn-io
+
+This product includes software designed by, and adapts the public API of, the
+following MIT-licensed projects:
+
+- cdktn-vitest (https://www.npmjs.com/package/cdktn-vitest)
+  Copyright (c) Aníbal Jorquera <ajorquera.cornejo@gmail.com>
+  The single-export `setupVitest()` API and the Vitest `passEvaluation`
+  predicate mirror this package's design. This is a clean reimplementation in
+  TypeScript; no compiled artifacts from the original are distributed here.
+
+- cdktf-vitest (https://www.npmjs.com/package/cdktf-vitest)
+  Copyright (c) Daniel Grefberg <hello@danielgrefberg.com>
+  The original (now deprecated) Vitest matchers adapter for HashiCorp's CDKTF,
+  from which the cdktn variant was derived.
+
+The matcher *logic* (resource/data-source/provider assertions, Terraform
+validation) is provided by CDK Terrain (cdktn) core via its exported
+`testingMatchers`. This package is a thin Vitest adapter over that logic,
+mirroring cdktn core's built-in Jest adapter (`setupJest()`).

package/README.md

@@ -0,0 +1,118 @@
+# @cdktn/vitest
+
+Vitest matchers for [CDK Terrain (cdktn)](https://cdktn.io).
+
+`cdktn` ships [Jest matchers](https://cdktn.io/docs/test/unit-tests#write-assertions)
+out of the box but no Vitest adapter. This package fills that gap: it registers
+the same assertion logic cdktn core exposes (`testingMatchers`) onto Vitest's
+`expect`, mirroring cdktn's built-in Jest adapter (`setupJest()`).
+
+It is the org-owned, provenance-signed successor to the third-party
+`cdktn-vitest` package — same public API (`setupVitest()`), published under the
+`@cdktn` scope.
+
+> **Long-term direction:** the goal is to fold a Vitest adapter directly into
+> cdktn core as `cdktn/lib/testing/adapters/vitest` (mirroring the Jest adapter)
+> and deprecate this standalone package. Tracking issue:
+> [open-constructs/cdk-terrain#289](https://github.com/open-constructs/cdk-terrain/issues/289).
+> Until core ships that, `@cdktn/vitest` is the supported path.
+
+## Installation
+
+```bash
+pnpm add -D @cdktn/vitest
+# or: npm install -D @cdktn/vitest
+```
+
+`cdktn` and `vitest` are peer dependencies:
+
+- `cdktn >= 0.23.0`
+- `vitest >= 2.1.0`
+
+## Setup
+
+### 1. Register the matchers
+
+Create a Vitest setup file that calls `setupVitest()`:
+
+```ts
+// vitest.setup.ts
+import { setupVitest } from "@cdktn/vitest";
+
+setupVitest();
+```
+
+### 2. Wire it into your Vitest config
+
+```ts
+// vitest.config.ts
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    setupFiles: ["./vitest.setup.ts"],
+  },
+});
+```
+
+### 3. Enable the matcher types
+
+Add the package to your `tsconfig.json` so the matchers are typed on `expect`:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["@cdktn/vitest"]
+  }
+}
+```
+
+## Available matchers
+
+| Matcher | Asserts that the synthesized stack… |
+| --- | --- |
+| `toHaveResource(resource)` | contains a resource of the given type |
+| `toHaveResourceWithProperties(resource, props)` | contains a matching resource with the given properties |
+| `toHaveDataSource(dataSource)` | contains a data source of the given type |
+| `toHaveDataSourceWithProperties(dataSource, props)` | contains a matching data source with the given properties |
+| `toHaveProvider(provider)` | configures the given provider |
+| `toHaveProviderWithProperties(provider, props)` | configures the given provider with the given properties |
+| `toBeValidTerraform()` | passes `terraform validate` (requires the `terraform` CLI) |
+| `toPlanSuccessfully()` | passes `terraform plan` (requires the `terraform` CLI) |
+
+Property matchers use subset (`objectContaining`) semantics — the resource may
+have additional properties beyond those asserted.
+
+## Example
+
+```ts
+import { describe, expect, it } from "vitest";
+import { Testing } from "cdktn";
+import { MyStack } from "./my-stack";
+
+describe("MyStack", () => {
+  it("creates the bucket with the right name", () => {
+    const synthesized = Testing.synth(new MyStack(Testing.app(), "test"));
+
+    expect(synthesized).toHaveResourceWithProperties(S3Bucket, {
+      bucket: "my-bucket",
+    });
+  });
+});
+```
+
+> `toBeValidTerraform()` / `toPlanSuccessfully()` operate on a synthesized
+> output **directory** (containing `manifest.json`) and shell out to the
+> `terraform` CLI, so they require Terraform to be installed.
+
+## Credits
+
+This is a clean-room TypeScript reimplementation that mirrors the public API of
+the MIT-licensed [`cdktn-vitest`](https://www.npmjs.com/package/cdktn-vitest) by
+Aníbal Jorquera, itself derived from
+[`cdktf-vitest`](https://www.npmjs.com/package/cdktf-vitest) by Daniel Grefberg.
+See [`NOTICE`](./NOTICE).
+
+## License
+
+[MIT](./LICENSE)

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from "./matcher/index.js";

package/lib/index.js

@@ -0,0 +1 @@
+export * from "./matcher/index.js";

package/lib/matcher/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./matcher.js";
+export * from "./matcher.types.js";

package/lib/matcher/index.js

@@ -0,0 +1,2 @@
+export * from "./matcher.js";
+export * from "./matcher.types.js";

package/lib/matcher/matcher.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Register the cdktn Vitest matchers on the global `expect`.
+ *
+ * Call this once from a Vitest setup file:
+ *
+ * ```ts
+ * // vitest.setup.ts
+ * import { setupVitest } from "@cdktn/vitest";
+ * setupVitest();
+ * ```
+ *
+ * The matchers delegate to cdktn core's `testingMatchers`, the same logic the
+ * built-in Jest adapter uses, wired to a Vitest `passEvaluation`.
+ */
+export declare const setupVitest: () => void;

package/lib/matcher/matcher.js

@@ -0,0 +1,50 @@
+import { testingMatchers } from "cdktn";
+import { expect } from "vitest";
+import { parseResult, passEvaluation } from "./matcher.utils.js";
+/**
+ * Register the cdktn Vitest matchers on the global `expect`.
+ *
+ * Call this once from a Vitest setup file:
+ *
+ * ```ts
+ * // vitest.setup.ts
+ * import { setupVitest } from "@cdktn/vitest";
+ * setupVitest();
+ * ```
+ *
+ * The matchers delegate to cdktn core's `testingMatchers`, the same logic the
+ * built-in Jest adapter uses, wired to a Vitest `passEvaluation`.
+ */
+export const setupVitest = () => {
+    // Build the property-aware matchers once with our Vitest predicate, then
+    // reuse them across every matcher invocation.
+    const toHaveResourceWithProperties = testingMatchers.getToHaveResourceWithProperties(passEvaluation);
+    const toHaveDataSourceWithProperties = testingMatchers.getToHaveDataSourceWithProperties(passEvaluation);
+    const toHaveProviderWithProperties = testingMatchers.getToHaveProviderWithProperties(passEvaluation);
+    expect.extend({
+        toHaveResource(received, resource) {
+            return parseResult(toHaveResourceWithProperties(received, resource, {}));
+        },
+        toHaveResourceWithProperties(received, resource, properties) {
+            return parseResult(toHaveResourceWithProperties(received, resource, properties));
+        },
+        toHaveDataSource(received, dataSourceConstructor) {
+            return parseResult(toHaveDataSourceWithProperties(received, dataSourceConstructor, {}));
+        },
+        toHaveDataSourceWithProperties(received, dataSourceConstructor, properties) {
+            return parseResult(toHaveDataSourceWithProperties(received, dataSourceConstructor, properties));
+        },
+        toHaveProvider(received, providerConstructor) {
+            return parseResult(toHaveProviderWithProperties(received, providerConstructor, {}));
+        },
+        toHaveProviderWithProperties(received, providerConstructor, properties) {
+            return parseResult(toHaveProviderWithProperties(received, providerConstructor, properties));
+        },
+        toBeValidTerraform(received) {
+            return parseResult(testingMatchers.toBeValidTerraform(received));
+        },
+        toPlanSuccessfully(received) {
+            return parseResult(testingMatchers.toPlanSuccessfully(received));
+        },
+    });
+};

package/lib/matcher/matcher.types.d.ts

@@ -0,0 +1,29 @@
+import "vitest";
+import type { testingMatchers } from "cdktn";
+type TerraformConstructor = testingMatchers.TerraformConstructor;
+/**
+ * Ambient typing for the cdktn matchers registered by {@link setupVitest}.
+ *
+ * Consumers opt in by adding this package to their tsconfig:
+ *
+ * ```json
+ * { "compilerOptions": { "types": ["@cdktn/vitest"] } }
+ * ```
+ */
+export interface CdktnVitestMatchers<R = unknown> {
+    toHaveResource(resource: TerraformConstructor): R;
+    toHaveResourceWithProperties(resource: TerraformConstructor, properties: Record<string, any>): R;
+    toHaveDataSource(dataSourceConstructor: TerraformConstructor): R;
+    toHaveDataSourceWithProperties(dataSourceConstructor: TerraformConstructor, properties: Record<string, any>): R;
+    toHaveProvider(providerConstructor: TerraformConstructor): R;
+    toHaveProviderWithProperties(providerConstructor: TerraformConstructor, properties: Record<string, any>): R;
+    toBeValidTerraform(): R;
+    toPlanSuccessfully(): R;
+}
+declare module "vitest" {
+    interface Assertion<T = any> extends CdktnVitestMatchers<T> {
+    }
+    interface AsymmetricMatchersContaining extends CdktnVitestMatchers {
+    }
+}
+export {};

package/lib/matcher/matcher.types.js

@@ -0,0 +1 @@
+import "vitest";

package/lib/matcher/matcher.utils.d.ts

@@ -0,0 +1,18 @@
+import type { testingMatchers } from "cdktn";
+/**
+ * Predicate handed to cdktn's core matchers to decide whether a collection of
+ * synthesized items contains one matching the asserted properties.
+ *
+ * This mirrors the role of the Jest adapter's predicate in cdktn core, but is
+ * built on Vitest's asymmetric matchers. An empty property set degrades to a
+ * pure existence check.
+ */
+export declare const passEvaluation: (items: any, assertedProperties: Record<string, any>) => boolean;
+/**
+ * Translate cdktn's `AssertionReturn` ({ message, pass }) into the shape Vitest
+ * expects a matcher to return (message as a thunk).
+ */
+export declare const parseResult: (result: testingMatchers.AssertionReturn) => {
+    message: () => string;
+    pass: boolean;
+};

package/lib/matcher/matcher.utils.js

@@ -0,0 +1,32 @@
+import { expect } from "vitest";
+/**
+ * Predicate handed to cdktn's core matchers to decide whether a collection of
+ * synthesized items contains one matching the asserted properties.
+ *
+ * This mirrors the role of the Jest adapter's predicate in cdktn core, but is
+ * built on Vitest's asymmetric matchers. An empty property set degrades to a
+ * pure existence check.
+ */
+export const passEvaluation = (items, assertedProperties) => {
+    if (Object.entries(assertedProperties).length === 0) {
+        return items.length > 0;
+    }
+    // `expect().toEqual()` throws on mismatch; we translate that into a boolean.
+    // This is more robust across Vitest versions than poking at the asymmetric
+    // matcher's semi-internal `asymmetricMatch()` method.
+    try {
+        expect(items).toEqual(expect.arrayContaining([expect.objectContaining(assertedProperties)]));
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
+/**
+ * Translate cdktn's `AssertionReturn` ({ message, pass }) into the shape Vitest
+ * expects a matcher to return (message as a thunk).
+ */
+export const parseResult = (result) => ({
+    message: () => result.message,
+    pass: result.pass,
+});

package/package.json

@@ -1,9 +1,59 @@
 {
   "name": "@cdktn/vitest",
-  "version": "0.0.0",
-  "description": "Placeholder reserving @cdktn/vitest — real release published via GitHub Actions OIDC trusted publishing.",
+  "version": "0.1.0",
+  "description": "Vitest matchers for CDK Terrain (cdktn)",
   "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    }
+  },
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib",
+    "NOTICE"
+  ],
+  "keywords": [
+    "cdktn",
+    "cdk-terrain",
+    "vitest",
+    "terraform",
+    "opentofu",
+    "testing",
+    "matchers"
+  ],
+  "homepage": "https://github.com/cdktn-io/cdktn-vitest#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cdktn-io/cdktn-vitest.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cdktn-io/cdktn-vitest/issues"
+  },
+  "packageManager": "pnpm@11.9.0",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "lint": "biome check .",
+    "format": "biome format --write .",
+    "prepublishOnly": "pnpm build"
+  },
+  "peerDependencies": {
+    "cdktn": ">= 0.23.0",
+    "vitest": ">= 2.1.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.4.2",
+    "cdktn": "^0.23.3",
+    "constructs": "^10.4.2",
+    "typescript": "^5.9.2",
+    "vitest": "^4.0.0"
+  },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   }
 }