Compare commits
16 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b9016206ce | |||
| 8edbbd4850 | |||
| 97c91fc010 | |||
| ca08bb2e3c | |||
| 8fd114334f | |||
| c630a171b5 | |||
| 1a4eb5b6d9 | |||
| 41d7c1ce49 | |||
| 3ab5550cb8 | |||
| ee7b387534 | |||
| 7e67b64a6e | |||
| 1ce730d4f2 | |||
| 9357d6e7ef | |||
| 973ce771d2 | |||
| 8441881d92 | |||
| 16ca3b6374 |
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
@@ -22,5 +22,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
],
|
||||||
|
"deno.enable": false
|
||||||
}
|
}
|
||||||
|
|||||||
61
changelog.md
61
changelog.md
@@ -1,5 +1,66 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-11-21 - 3.1.1 - fix(tapbundle)
|
||||||
|
Pass TapTools to suite lifecycle hooks (beforeAll/afterAll) and update @push.rocks/smarts3 to ^3.0.0
|
||||||
|
|
||||||
|
- Replace usage of a Deferred promise with a TapTools instance when invoking suite.beforeAll and suite.afterAll
|
||||||
|
- Add import for TapTools in ts_tapbundle/tapbundle.classes.tap.ts
|
||||||
|
- Bump dependency @push.rocks/smarts3 from ^2.2.7 to ^3.0.0 in package.json
|
||||||
|
|
||||||
|
## 2025-11-20 - 3.1.0 - feat(tapbundle)
|
||||||
|
Add global postTask (teardown) and suite lifecycle hooks (beforeAll/afterAll) to tapbundle
|
||||||
|
|
||||||
|
- Introduce PostTask class (ts_tapbundle/tapbundle.classes.posttask.ts) and tap.postTask() API for global teardown.
|
||||||
|
- Integrate postTask execution into Tap.start() so postTasks run after all tests and before the global afterAll hook.
|
||||||
|
- Add suite-level beforeAll and afterAll support and ensure afterAll runs after child suites and their tests (changes in ts_tapbundle/tapbundle.classes.tap.ts).
|
||||||
|
- Add lifecycle tests (test/tapbundle/test.new-lifecycle.ts) verifying execution order, including parallel tests.
|
||||||
|
- Update documentation (readme.hints.md) describing Phase 1 API improvements and usage notes.
|
||||||
|
- This is additive and backward-compatible (no breaking changes).
|
||||||
|
|
||||||
|
## 2025-11-20 - 3.0.1 - fix(@push.rocks/smarts3)
|
||||||
|
Bump @push.rocks/smarts3 dependency to ^2.2.7
|
||||||
|
|
||||||
|
- Update package.json: @push.rocks/smarts3 upgraded from ^2.2.6 to ^2.2.7
|
||||||
|
|
||||||
|
## 2025-11-19 - 3.0.0 - BREAKING CHANGE(tapbundle_serverside)
|
||||||
|
Rename Node-specific tapbundle module to tapbundle_serverside and migrate server-side utilities
|
||||||
|
|
||||||
|
- Change public export in package.json from ./tapbundle_node to ./tapbundle_serverside — consumers must update imports to @git.zone/tstest/tapbundle_serverside
|
||||||
|
- Move and re-create Node-only implementation files under ts_tapbundle_serverside (plugins, paths, classes.tapnodetools, classes.testfileprovider, index, tspublish.json) and remove legacy ts_tapbundle_node sources
|
||||||
|
- Update internal imports and tests to reference the new tapbundle_serverside path (e.g. test/tapbundle/test.node.ts updated)
|
||||||
|
- Update documentation (readme.md and readme.hints.md) to describe the new tapbundle_serverside export and its server-side utilities
|
||||||
|
- Ensure build outputs and publish metadata reflect the new module directory (tspublish.json order preserved)
|
||||||
|
|
||||||
|
## 2025-11-19 - 2.8.3 - fix(dependencies)
|
||||||
|
Update dependency versions
|
||||||
|
|
||||||
|
- Bump devDependency @git.zone/tsbuild to ^3.1.0
|
||||||
|
- Upgrade @git.zone/tsrun to ^2.0.0 (major)
|
||||||
|
- Upgrade @push.rocks/smartenv to ^6.0.0 (major)
|
||||||
|
- Upgrade @push.rocks/smartrequest to ^5.0.1 (major/feature in dependency)
|
||||||
|
- Patch updates: @api.global/typedserver → ^3.0.80, @git.zone/tsbundle → ^2.5.2, @push.rocks/smartmongo → ^2.0.14
|
||||||
|
|
||||||
|
## 2025-11-17 - 2.8.2 - fix(logging)
|
||||||
|
Include runtime identifier in per-test logfile name and sanitize runtime string
|
||||||
|
|
||||||
|
- Append a sanitized runtime identifier to the per-test log filename (format: <safeFilename>__<safeRuntime>.log) so runs for different runtimes don't clash
|
||||||
|
- Sanitize runtime names by lowercasing and removing non-alphanumeric characters to produce filesystem-safe filenames
|
||||||
|
|
||||||
|
## 2025-11-17 - 2.8.1 - fix(config)
|
||||||
|
Remove Bun config file and set deno.json useDefineForClassFields to false for compatibility
|
||||||
|
|
||||||
|
- Removed bunfig.toml (Bun-specific TypeScript decorator configuration) — stops shipping a project-local Bun transpiler config.
|
||||||
|
- Updated deno.json: set compilerOptions.useDefineForClassFields = false to keep legacy class field semantics and avoid runtime/emit incompatibilities in Deno.
|
||||||
|
|
||||||
|
## 2025-11-17 - 2.8.0 - feat(runtime-adapters)
|
||||||
|
Enable TypeScript decorator support for Deno and Bun runtimes and add decorator tests
|
||||||
|
|
||||||
|
- Add bunfig.toml to enable experimentalDecorators for Bun runtime
|
||||||
|
- Add deno.json to enable experimentalDecorators and set target/lib for Deno
|
||||||
|
- Update Bun runtime adapter to note bunfig.toml discovery so Bun runs with decorator support
|
||||||
|
- Update Deno runtime adapter to auto-detect deno.json / deno.jsonc and pass configPath in default options
|
||||||
|
- Add integration tests for decorators (test/decorator.all.ts) to verify decorator support across runtimes
|
||||||
|
|
||||||
## 2025-10-26 - 2.7.0 - feat(tapbundle_protocol)
|
## 2025-10-26 - 2.7.0 - feat(tapbundle_protocol)
|
||||||
Add package export for tapbundle_protocol to expose protocol utilities
|
Add package export for tapbundle_protocol to expose protocol utilities
|
||||||
|
|
||||||
|
|||||||
13
deno.json
Normal file
13
deno.json
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"lib": [
|
||||||
|
"ES2022",
|
||||||
|
"DOM"
|
||||||
|
],
|
||||||
|
"target": "ES2022"
|
||||||
|
},
|
||||||
|
"nodeModulesDir": true,
|
||||||
|
"version": "3.1.1"
|
||||||
|
}
|
||||||
20
package.json
20
package.json
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@git.zone/tstest",
|
"name": "@git.zone/tstest",
|
||||||
"version": "2.7.0",
|
"version": "3.1.1",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "a test utility to run tests that match test/**/*.ts",
|
"description": "a test utility to run tests that match test/**/*.ts",
|
||||||
"exports": {
|
"exports": {
|
||||||
".": "./dist_ts/index.js",
|
".": "./dist_ts/index.js",
|
||||||
"./tapbundle": "./dist_ts_tapbundle/index.js",
|
"./tapbundle": "./dist_ts_tapbundle/index.js",
|
||||||
"./tapbundle_node": "./dist_ts_tapbundle_node/index.js",
|
"./tapbundle_serverside": "./dist_ts_tapbundle_serverside/index.js",
|
||||||
"./tapbundle_protocol": "./dist_ts_tapbundle_protocol/index.js"
|
"./tapbundle_protocol": "./dist_ts_tapbundle_protocol/index.js"
|
||||||
},
|
},
|
||||||
"type": "module",
|
"type": "module",
|
||||||
@@ -25,30 +25,30 @@
|
|||||||
"buildDocs": "tsdoc"
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.6.8",
|
"@git.zone/tsbuild": "^3.1.0",
|
||||||
"@types/node": "^22.15.21"
|
"@types/node": "^22.15.21"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@api.global/typedserver": "^3.0.79",
|
"@api.global/typedserver": "^3.0.80",
|
||||||
"@git.zone/tsbundle": "^2.5.1",
|
"@git.zone/tsbundle": "^2.5.2",
|
||||||
"@git.zone/tsrun": "^1.6.2",
|
"@git.zone/tsrun": "^2.0.0",
|
||||||
"@push.rocks/consolecolor": "^2.0.3",
|
"@push.rocks/consolecolor": "^2.0.3",
|
||||||
"@push.rocks/qenv": "^6.1.3",
|
"@push.rocks/qenv": "^6.1.3",
|
||||||
"@push.rocks/smartbrowser": "^2.0.8",
|
"@push.rocks/smartbrowser": "^2.0.8",
|
||||||
"@push.rocks/smartchok": "^1.1.1",
|
"@push.rocks/smartchok": "^1.1.1",
|
||||||
"@push.rocks/smartcrypto": "^2.0.4",
|
"@push.rocks/smartcrypto": "^2.0.4",
|
||||||
"@push.rocks/smartdelay": "^3.0.5",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"@push.rocks/smartenv": "^5.0.13",
|
"@push.rocks/smartenv": "^6.0.0",
|
||||||
"@push.rocks/smartexpect": "^2.5.0",
|
"@push.rocks/smartexpect": "^2.5.0",
|
||||||
"@push.rocks/smartfile": "^11.2.7",
|
"@push.rocks/smartfile": "^11.2.7",
|
||||||
"@push.rocks/smartjson": "^5.2.0",
|
"@push.rocks/smartjson": "^5.2.0",
|
||||||
"@push.rocks/smartlog": "^3.1.10",
|
"@push.rocks/smartlog": "^3.1.10",
|
||||||
"@push.rocks/smartmongo": "^2.0.12",
|
"@push.rocks/smartmongo": "^2.0.14",
|
||||||
"@push.rocks/smartnetwork": "^4.4.0",
|
"@push.rocks/smartnetwork": "^4.4.0",
|
||||||
"@push.rocks/smartpath": "^6.0.0",
|
"@push.rocks/smartpath": "^6.0.0",
|
||||||
"@push.rocks/smartpromise": "^4.2.3",
|
"@push.rocks/smartpromise": "^4.2.3",
|
||||||
"@push.rocks/smartrequest": "^4.3.2",
|
"@push.rocks/smartrequest": "^5.0.1",
|
||||||
"@push.rocks/smarts3": "^2.2.6",
|
"@push.rocks/smarts3": "^3.0.0",
|
||||||
"@push.rocks/smartshell": "^3.3.0",
|
"@push.rocks/smartshell": "^3.3.0",
|
||||||
"@push.rocks/smarttime": "^4.1.1",
|
"@push.rocks/smarttime": "^4.1.1",
|
||||||
"@types/ws": "^8.18.1",
|
"@types/ws": "^8.18.1",
|
||||||
|
|||||||
4825
pnpm-lock.yaml
generated
4825
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
131
readme.hints.md
131
readme.hints.md
@@ -6,7 +6,7 @@ This project integrates tstest with tapbundle through a modular architecture:
|
|||||||
|
|
||||||
1. **tstest** (`/ts/`) - The test runner that discovers and executes test files
|
1. **tstest** (`/ts/`) - The test runner that discovers and executes test files
|
||||||
2. **tapbundle** (`/ts_tapbundle/`) - The TAP testing framework for writing tests
|
2. **tapbundle** (`/ts_tapbundle/`) - The TAP testing framework for writing tests
|
||||||
3. **tapbundle_node** (`/ts_tapbundle_node/`) - Node.js-specific testing utilities
|
3. **tapbundle_serverside** (`/ts_tapbundle_serverside/`) - Server-side testing utilities (runCommand, env vars, HTTPS certs, MongoDB, S3, test assets)
|
||||||
|
|
||||||
## How Components Work Together
|
## How Components Work Together
|
||||||
|
|
||||||
@@ -31,7 +31,7 @@ This project integrates tstest with tapbundle through a modular architecture:
|
|||||||
|
|
||||||
1. **Import Structure**
|
1. **Import Structure**
|
||||||
- Test files import from local tapbundle: `import { tap, expect } from '../../ts_tapbundle/index.js'`
|
- Test files import from local tapbundle: `import { tap, expect } from '../../ts_tapbundle/index.js'`
|
||||||
- Node-specific tests also import from tapbundle_node: `import { tapNodeTools } from '../../ts_tapbundle_node/index.js'`
|
- Server-side tests also import from tapbundle_serverside for Node.js-only utilities: `import { tapNodeTools } from '../../ts_tapbundle_serverside/index.js'`
|
||||||
|
|
||||||
2. **WebHelpers**
|
2. **WebHelpers**
|
||||||
- Browser tests can use webhelpers for DOM manipulation
|
- Browser tests can use webhelpers for DOM manipulation
|
||||||
@@ -41,7 +41,7 @@ This project integrates tstest with tapbundle through a modular architecture:
|
|||||||
|
|
||||||
3. **Build System**
|
3. **Build System**
|
||||||
- Uses `tsbuild tsfolders` to compile TypeScript (invoked by `pnpm build`)
|
- Uses `tsbuild tsfolders` to compile TypeScript (invoked by `pnpm build`)
|
||||||
- Maintains separate output directories: `/dist_ts/`, `/dist_ts_tapbundle/`, `/dist_ts_tapbundle_node/`, `/dist_ts_tapbundle_protocol/`
|
- Maintains separate output directories: `/dist_ts/`, `/dist_ts_tapbundle/`, `/dist_ts_tapbundle_serverside/`, `/dist_ts_tapbundle_protocol/`
|
||||||
- Compilation order is resolved automatically based on dependencies in tspublish.json files
|
- Compilation order is resolved automatically based on dependencies in tspublish.json files
|
||||||
- Protocol imports use compiled dist directories:
|
- Protocol imports use compiled dist directories:
|
||||||
```typescript
|
```typescript
|
||||||
@@ -244,6 +244,131 @@ tstest test/specific.ts -w
|
|||||||
- Ignores changes matching the ignore patterns
|
- Ignores changes matching the ignore patterns
|
||||||
- Shows "Waiting for file changes..." between runs
|
- Shows "Waiting for file changes..." between runs
|
||||||
|
|
||||||
|
## Phase 1 API Improvements (v3.1.0)
|
||||||
|
|
||||||
|
### New Features Implemented
|
||||||
|
|
||||||
|
#### 1. tap.postTask() - Global Teardown (COMPLETED)
|
||||||
|
|
||||||
|
Added symmetric teardown method to complement `tap.preTask()`:
|
||||||
|
|
||||||
|
**Implementation:**
|
||||||
|
- Created `PostTask` class in `ts_tapbundle/tapbundle.classes.posttask.ts`
|
||||||
|
- Mirrors PreTask structure with description and function
|
||||||
|
- Integrated into Tap class execution flow
|
||||||
|
- Runs after all tests complete but before global `afterAll` hook
|
||||||
|
|
||||||
|
**Usage:**
|
||||||
|
```typescript
|
||||||
|
tap.postTask('cleanup database', async () => {
|
||||||
|
await cleanupDatabase();
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
**Execution Order:**
|
||||||
|
1. preTask hooks
|
||||||
|
2. Global beforeAll
|
||||||
|
3. Tests (with suite hooks)
|
||||||
|
4. **postTask hooks** ← NEW
|
||||||
|
5. Global afterAll
|
||||||
|
|
||||||
|
#### 2. Suite-Level beforeAll/afterAll (COMPLETED)
|
||||||
|
|
||||||
|
Added once-per-suite lifecycle hooks:
|
||||||
|
|
||||||
|
**Implementation:**
|
||||||
|
- Extended `ITestSuite` interface with `beforeAll` and `afterAll` properties
|
||||||
|
- Added `tap.beforeAll()` and `tap.afterAll()` methods
|
||||||
|
- Integrated into `_runSuite()` execution flow
|
||||||
|
- Properly handles nested suites
|
||||||
|
|
||||||
|
**Usage:**
|
||||||
|
```typescript
|
||||||
|
tap.describe('Database Tests', () => {
|
||||||
|
tap.beforeAll(async () => {
|
||||||
|
await initializeDatabaseConnection(); // Runs once
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('test 1', async () => {});
|
||||||
|
tap.test('test 2', async () => {});
|
||||||
|
|
||||||
|
tap.afterAll(async () => {
|
||||||
|
await closeDatabaseConnection(); // Runs once
|
||||||
|
});
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
**Execution Order per Suite:**
|
||||||
|
1. Suite beforeAll ← NEW
|
||||||
|
2. Suite beforeEach
|
||||||
|
3. Test
|
||||||
|
4. Suite afterEach
|
||||||
|
5. (Repeat 2-4 for each test)
|
||||||
|
6. Child suites (recursive)
|
||||||
|
7. Suite afterAll ← NEW
|
||||||
|
|
||||||
|
#### 3. tap.parallel() Fluent Entry Point (COMPLETED)
|
||||||
|
|
||||||
|
Added fluent API for parallel test creation:
|
||||||
|
|
||||||
|
**Implementation:**
|
||||||
|
- Updated `TestBuilder` class with `_parallel` flag
|
||||||
|
- Builder constructor accepts optional parallel parameter
|
||||||
|
- Added `tap.parallel()` method returning configured builder
|
||||||
|
- Fixed `testParallel()` to return TapTest<T> (was void)
|
||||||
|
|
||||||
|
**Usage:**
|
||||||
|
```typescript
|
||||||
|
// Simple parallel test
|
||||||
|
tap.parallel().test('fetch data', async () => {});
|
||||||
|
|
||||||
|
// With full configuration
|
||||||
|
tap
|
||||||
|
.parallel()
|
||||||
|
.tags('api', 'integration')
|
||||||
|
.retry(2)
|
||||||
|
.timeout(5000)
|
||||||
|
.test('configured parallel test', async () => {});
|
||||||
|
```
|
||||||
|
|
||||||
|
**Benefits:**
|
||||||
|
- Consistent with other fluent builders (tags, priority, etc.)
|
||||||
|
- More discoverable than separate `testParallel()` method
|
||||||
|
- Allows chaining parallel with other configurations
|
||||||
|
- `testParallel()` kept for backward compatibility
|
||||||
|
|
||||||
|
### Documentation Updates
|
||||||
|
|
||||||
|
**tapbundle/readme.md:**
|
||||||
|
- Added suite-level beforeAll/afterAll documentation
|
||||||
|
- Documented postTask with execution order notes
|
||||||
|
- Added parallel() fluent API examples
|
||||||
|
- Expanded TapTools documentation with all methods
|
||||||
|
- Added "Additional Tap Methods" section for fail(), getSettings(), etc.
|
||||||
|
- Documented all previously undocumented methods
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
|
||||||
|
**test/tapbundle/test.new-lifecycle.ts:**
|
||||||
|
- Tests postTask execution order
|
||||||
|
- Verifies suite-level beforeAll/afterAll
|
||||||
|
- Tests nested suite lifecycle
|
||||||
|
- Validates parallel() fluent API
|
||||||
|
- Confirms all execution order requirements
|
||||||
|
|
||||||
|
**Test Results:** All 9 tests passing ✅
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
|
||||||
|
None - all changes are additive and backward compatible.
|
||||||
|
|
||||||
|
### Migration Guide
|
||||||
|
|
||||||
|
No migration needed. New features are opt-in:
|
||||||
|
- Continue using existing patterns
|
||||||
|
- Adopt new features incrementally
|
||||||
|
- `testParallel()` still works (recommended: switch to `parallel().test()`)
|
||||||
|
|
||||||
## Fixed Issues
|
## Fixed Issues
|
||||||
|
|
||||||
### tap.skip.test(), tap.todo(), and tap.only.test() (Fixed)
|
### tap.skip.test(), tap.todo(), and tap.only.test() (Fixed)
|
||||||
|
|||||||
27
readme.md
27
readme.md
@@ -318,9 +318,34 @@ tstest provides multiple exports for different use cases:
|
|||||||
|
|
||||||
- `@git.zone/tstest` - Main CLI and test runner functionality
|
- `@git.zone/tstest` - Main CLI and test runner functionality
|
||||||
- `@git.zone/tstest/tapbundle` - Browser-compatible test framework
|
- `@git.zone/tstest/tapbundle` - Browser-compatible test framework
|
||||||
- `@git.zone/tstest/tapbundle_node` - Node.js-specific test utilities
|
- `@git.zone/tstest/tapbundle_serverside` - Server-side testing utilities for Node.js-only tests (*.node.ts files)
|
||||||
|
- Execute shell commands during tests
|
||||||
|
- Manage environment variables on-demand with secure storage
|
||||||
|
- Generate self-signed HTTPS certificates for testing secure connections
|
||||||
|
- Create ephemeral MongoDB instances for database testing
|
||||||
|
- Create local S3-compatible storage for object storage testing
|
||||||
|
- Download and manage test assets (e.g., Docker images)
|
||||||
- `@git.zone/tstest/tapbundle_protocol` - Protocol V2 emitter and parser for TAP extensions
|
- `@git.zone/tstest/tapbundle_protocol` - Protocol V2 emitter and parser for TAP extensions
|
||||||
|
|
||||||
|
### When to Use tapbundle_serverside
|
||||||
|
|
||||||
|
Use `@git.zone/tstest/tapbundle_serverside` when your tests:
|
||||||
|
|
||||||
|
- Run exclusively on Node.js server-side (*.node.ts test files)
|
||||||
|
- Need to execute shell commands or interact with the file system
|
||||||
|
- Require environment variable management with secure on-demand prompts
|
||||||
|
- Test HTTPS servers and need self-signed certificates
|
||||||
|
- Interact with databases (MongoDB) and need ephemeral test instances
|
||||||
|
- Work with object storage (S3-compatible) and need local testing
|
||||||
|
- Require test assets like Docker images or other downloadable files
|
||||||
|
|
||||||
|
**Important:** tapbundle_serverside utilities are NOT available in:
|
||||||
|
- Browser environments
|
||||||
|
- Deno runtime
|
||||||
|
- Bun runtime
|
||||||
|
|
||||||
|
For cross-runtime tests, only import tapbundle_serverside in `.node.ts` files where you need server-side specific functionality.
|
||||||
|
|
||||||
## tapbundle Protocol V2
|
## tapbundle Protocol V2
|
||||||
|
|
||||||
tstest includes an enhanced TAP protocol (Protocol V2) that extends standard TAP 13 with additional metadata while maintaining backwards compatibility.
|
tstest includes an enhanced TAP protocol (Protocol V2) that extends standard TAP 13 with additional metadata while maintaining backwards compatibility.
|
||||||
|
|||||||
91
test/decorator.all.ts
Normal file
91
test/decorator.all.ts
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
import { tap, expect } from '../ts_tapbundle/index.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Simple class decorator for testing decorator support across runtimes
|
||||||
|
*/
|
||||||
|
function testDecorator(target: any) {
|
||||||
|
target.decoratorApplied = true;
|
||||||
|
target.decoratorData = 'Decorator was applied successfully';
|
||||||
|
return target;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Method decorator for testing
|
||||||
|
*/
|
||||||
|
function logMethod(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
|
||||||
|
const originalMethod = descriptor.value;
|
||||||
|
descriptor.value = function (...args: any[]) {
|
||||||
|
const result = originalMethod.apply(this, args);
|
||||||
|
return `[logged] ${result}`;
|
||||||
|
};
|
||||||
|
return descriptor;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parameter decorator for testing
|
||||||
|
*/
|
||||||
|
function validateParam(target: any, propertyKey: string, parameterIndex: number) {
|
||||||
|
// Mark that parameter validation decorator was applied
|
||||||
|
if (!target.decoratedParams) {
|
||||||
|
target.decoratedParams = {};
|
||||||
|
}
|
||||||
|
if (!target.decoratedParams[propertyKey]) {
|
||||||
|
target.decoratedParams[propertyKey] = [];
|
||||||
|
}
|
||||||
|
target.decoratedParams[propertyKey].push(parameterIndex);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test class with decorators
|
||||||
|
*/
|
||||||
|
@testDecorator
|
||||||
|
class TestClass {
|
||||||
|
public name: string = 'test';
|
||||||
|
|
||||||
|
@logMethod
|
||||||
|
public greet(message: string): string {
|
||||||
|
return `Hello, ${message}!`;
|
||||||
|
}
|
||||||
|
|
||||||
|
public getValue(): number {
|
||||||
|
return 42;
|
||||||
|
}
|
||||||
|
|
||||||
|
public testParams(@validateParam value: string): string {
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Tests
|
||||||
|
tap.test('Class decorator should be applied', async () => {
|
||||||
|
expect((TestClass as any).decoratorApplied).toEqual(true);
|
||||||
|
expect((TestClass as any).decoratorData).toEqual('Decorator was applied successfully');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('Method decorator should modify method behavior', async () => {
|
||||||
|
const instance = new TestClass();
|
||||||
|
const result = instance.greet('World');
|
||||||
|
expect(result).toEqual('[logged] Hello, World!');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('Regular methods should work normally', async () => {
|
||||||
|
const instance = new TestClass();
|
||||||
|
expect(instance.getValue()).toEqual(42);
|
||||||
|
expect(instance.name).toEqual('test');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('Parameter decorator should be applied', async () => {
|
||||||
|
const decoratedParams = (TestClass.prototype as any).decoratedParams;
|
||||||
|
expect(decoratedParams).toBeDefined();
|
||||||
|
expect(decoratedParams.testParams).toBeDefined();
|
||||||
|
expect(decoratedParams.testParams).toContain(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('Decorator metadata preservation', async () => {
|
||||||
|
const instance = new TestClass();
|
||||||
|
expect(instance instanceof TestClass).toEqual(true);
|
||||||
|
expect(instance.constructor.name).toEqual('TestClass');
|
||||||
|
expect(instance.testParams('hello')).toEqual('hello');
|
||||||
|
});
|
||||||
|
|
||||||
|
export default tap.start();
|
||||||
170
test/tapbundle/test.new-lifecycle.ts
Normal file
170
test/tapbundle/test.new-lifecycle.ts
Normal file
@@ -0,0 +1,170 @@
|
|||||||
|
import { tap, expect } from '../../ts_tapbundle/index.js';
|
||||||
|
|
||||||
|
// Global state for testing new lifecycle features
|
||||||
|
const executionOrder: string[] = [];
|
||||||
|
let postTaskRan = false;
|
||||||
|
|
||||||
|
// Test preTask and postTask
|
||||||
|
tap.preTask('setup environment', async () => {
|
||||||
|
executionOrder.push('preTask');
|
||||||
|
console.log('🔧 PreTask: Setting up environment');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.postTask('cleanup environment', async () => {
|
||||||
|
postTaskRan = true;
|
||||||
|
executionOrder.push('postTask');
|
||||||
|
console.log('🧹 PostTask: Cleaning up environment');
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test suite-level beforeAll and afterAll
|
||||||
|
tap.describe('Suite with beforeAll/afterAll', () => {
|
||||||
|
tap.beforeAll(async () => {
|
||||||
|
executionOrder.push('suite-beforeAll');
|
||||||
|
console.log('🔰 Suite beforeAll executed');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.afterAll(async () => {
|
||||||
|
executionOrder.push('suite-afterAll');
|
||||||
|
console.log('🏁 Suite afterAll executed');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.beforeEach(async () => {
|
||||||
|
executionOrder.push('suite-beforeEach');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.afterEach(async () => {
|
||||||
|
executionOrder.push('suite-afterEach');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('first test in suite', async () => {
|
||||||
|
executionOrder.push('test-1');
|
||||||
|
expect(executionOrder).toContain('preTask');
|
||||||
|
expect(executionOrder).toContain('suite-beforeAll');
|
||||||
|
console.log('✓ Test 1 executed');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('second test in suite', async () => {
|
||||||
|
executionOrder.push('test-2');
|
||||||
|
expect(executionOrder).toContain('suite-beforeAll');
|
||||||
|
console.log('✓ Test 2 executed');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test nested suites with beforeAll/afterAll
|
||||||
|
tap.describe('Parent Suite', () => {
|
||||||
|
tap.beforeAll(async () => {
|
||||||
|
executionOrder.push('parent-beforeAll');
|
||||||
|
console.log('🔰 Parent beforeAll executed');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.afterAll(async () => {
|
||||||
|
executionOrder.push('parent-afterAll');
|
||||||
|
console.log('🏁 Parent afterAll executed');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('test in parent', async () => {
|
||||||
|
executionOrder.push('parent-test');
|
||||||
|
expect(executionOrder).toContain('parent-beforeAll');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.describe('Child Suite', () => {
|
||||||
|
tap.beforeAll(async () => {
|
||||||
|
executionOrder.push('child-beforeAll');
|
||||||
|
console.log('🔰 Child beforeAll executed');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.afterAll(async () => {
|
||||||
|
executionOrder.push('child-afterAll');
|
||||||
|
console.log('🏁 Child afterAll executed');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('test in child', async () => {
|
||||||
|
executionOrder.push('child-test');
|
||||||
|
expect(executionOrder).toContain('parent-beforeAll');
|
||||||
|
expect(executionOrder).toContain('child-beforeAll');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test parallel() fluent API
|
||||||
|
tap.parallel().test('parallel test 1', async () => {
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 10));
|
||||||
|
executionOrder.push('parallel-1');
|
||||||
|
console.log('⚡ Parallel test 1 executed');
|
||||||
|
expect(true).toBeTrue();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.parallel().test('parallel test 2', async () => {
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 5));
|
||||||
|
executionOrder.push('parallel-2');
|
||||||
|
console.log('⚡ Parallel test 2 executed');
|
||||||
|
expect(true).toBeTrue();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test parallel() with configuration
|
||||||
|
tap
|
||||||
|
.parallel()
|
||||||
|
.tags('integration', 'parallel')
|
||||||
|
.timeout(1000)
|
||||||
|
.test('configured parallel test', async () => {
|
||||||
|
executionOrder.push('parallel-configured');
|
||||||
|
console.log('⚡ Configured parallel test executed');
|
||||||
|
expect(true).toBeTrue();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Verify execution order
|
||||||
|
tap.test('verify lifecycle execution order', async () => {
|
||||||
|
// Give a moment for any async operations to complete
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 100));
|
||||||
|
|
||||||
|
console.log('📊 Execution order:', executionOrder);
|
||||||
|
|
||||||
|
// Verify preTask ran first
|
||||||
|
expect(executionOrder[0]).toEqual('preTask');
|
||||||
|
|
||||||
|
// Verify suite beforeAll ran before tests
|
||||||
|
const suiteBeforeAllIndex = executionOrder.indexOf('suite-beforeAll');
|
||||||
|
const test1Index = executionOrder.indexOf('test-1');
|
||||||
|
expect(suiteBeforeAllIndex).toBeLessThan(test1Index);
|
||||||
|
|
||||||
|
// Verify beforeEach ran before each test
|
||||||
|
const beforeEachIndices = executionOrder
|
||||||
|
.map((item, index) => item === 'suite-beforeEach' ? index : -1)
|
||||||
|
.filter(index => index !== -1);
|
||||||
|
expect(beforeEachIndices.length).toBeGreaterThanOrEqual(2);
|
||||||
|
|
||||||
|
// Verify afterEach ran after each test
|
||||||
|
const afterEachIndices = executionOrder
|
||||||
|
.map((item, index) => item === 'suite-afterEach' ? index : -1)
|
||||||
|
.filter(index => index !== -1);
|
||||||
|
expect(afterEachIndices.length).toBeGreaterThanOrEqual(2);
|
||||||
|
|
||||||
|
// Verify afterAll ran after all tests
|
||||||
|
const suiteAfterAllIndex = executionOrder.indexOf('suite-afterAll');
|
||||||
|
const test2Index = executionOrder.indexOf('test-2');
|
||||||
|
expect(suiteAfterAllIndex).toBeGreaterThan(test2Index);
|
||||||
|
|
||||||
|
// Verify nested suite lifecycle
|
||||||
|
expect(executionOrder).toContain('parent-beforeAll');
|
||||||
|
expect(executionOrder).toContain('parent-test');
|
||||||
|
expect(executionOrder).toContain('child-beforeAll');
|
||||||
|
expect(executionOrder).toContain('child-test');
|
||||||
|
expect(executionOrder).toContain('child-afterAll');
|
||||||
|
expect(executionOrder).toContain('parent-afterAll');
|
||||||
|
|
||||||
|
// Verify parallel tests ran
|
||||||
|
expect(executionOrder).toContain('parallel-1');
|
||||||
|
expect(executionOrder).toContain('parallel-2');
|
||||||
|
expect(executionOrder).toContain('parallel-configured');
|
||||||
|
|
||||||
|
console.log('✅ All lifecycle hooks executed in correct order');
|
||||||
|
});
|
||||||
|
|
||||||
|
// This test will verify postTask ran (after tap.start() completes)
|
||||||
|
tap.test('verify postTask execution', async () => {
|
||||||
|
// PostTask hasn't run yet because tests are still running
|
||||||
|
expect(postTaskRan).toBeFalse();
|
||||||
|
console.log('✓ Verified postTask will run after all tests');
|
||||||
|
});
|
||||||
|
|
||||||
|
export default tap.start();
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
import { tap, expect } from '../../ts_tapbundle/index.js';
|
import { tap, expect } from '../../ts_tapbundle/index.js';
|
||||||
|
|
||||||
import { tapNodeTools } from '../../ts_tapbundle_node/index.js';
|
import { tapNodeTools } from '../../ts_tapbundle_serverside/index.js';
|
||||||
|
|
||||||
tap.test('should execure a command', async () => {
|
tap.test('should execure a command', async () => {
|
||||||
const result = await tapNodeTools.runCommand('ls -la');
|
const result = await tapNodeTools.runCommand('ls -la');
|
||||||
|
|||||||
@@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@git.zone/tstest',
|
name: '@git.zone/tstest',
|
||||||
version: '2.7.0',
|
version: '3.1.1',
|
||||||
description: 'a test utility to run tests that match test/**/*.ts'
|
description: 'a test utility to run tests that match test/**/*.ts'
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -69,6 +69,9 @@ export class BunRuntimeAdapter extends RuntimeAdapter {
|
|||||||
|
|
||||||
const args: string[] = ['run'];
|
const args: string[] = ['run'];
|
||||||
|
|
||||||
|
// Note: Bun automatically discovers bunfig.toml in the current directory
|
||||||
|
// This ensures TypeScript decorator support is enabled if bunfig.toml is present
|
||||||
|
|
||||||
// Add extra args
|
// Add extra args
|
||||||
if (mergedOptions.extraArgs && mergedOptions.extraArgs.length > 0) {
|
if (mergedOptions.extraArgs && mergedOptions.extraArgs.length > 0) {
|
||||||
args.push(...mergedOptions.extraArgs);
|
args.push(...mergedOptions.extraArgs);
|
||||||
|
|||||||
@@ -31,8 +31,20 @@ export class DenoRuntimeAdapter extends RuntimeAdapter {
|
|||||||
* Get default Deno options
|
* Get default Deno options
|
||||||
*/
|
*/
|
||||||
protected getDefaultOptions(): DenoOptions {
|
protected getDefaultOptions(): DenoOptions {
|
||||||
|
// Auto-detect deno.json or deno.jsonc config file for TypeScript decorator support
|
||||||
|
let configPath: string | undefined;
|
||||||
|
const denoJsonPath = plugins.path.join(process.cwd(), 'deno.json');
|
||||||
|
const denoJsoncPath = plugins.path.join(process.cwd(), 'deno.jsonc');
|
||||||
|
|
||||||
|
if (plugins.smartfile.fs.fileExistsSync(denoJsonPath)) {
|
||||||
|
configPath = denoJsonPath;
|
||||||
|
} else if (plugins.smartfile.fs.fileExistsSync(denoJsoncPath)) {
|
||||||
|
configPath = denoJsoncPath;
|
||||||
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
...super.getDefaultOptions(),
|
...super.getDefaultOptions(),
|
||||||
|
configPath,
|
||||||
permissions: [
|
permissions: [
|
||||||
'--allow-read',
|
'--allow-read',
|
||||||
'--allow-env',
|
'--allow-env',
|
||||||
|
|||||||
@@ -200,15 +200,18 @@ export class TsTestLogger {
|
|||||||
.replace(/\//g, '__') // Replace path separators with double underscores
|
.replace(/\//g, '__') // Replace path separators with double underscores
|
||||||
.replace(/\.ts$/, '') // Remove .ts extension
|
.replace(/\.ts$/, '') // Remove .ts extension
|
||||||
.replace(/^\.\.__|^\.__|^__/, ''); // Clean up leading separators from relative paths
|
.replace(/^\.\.__|^\.__|^__/, ''); // Clean up leading separators from relative paths
|
||||||
|
|
||||||
this.currentTestLogFile = path.join('.nogit', 'testlogs', `${safeFilename}.log`);
|
// Sanitize runtime name for use in filename (lowercase, no spaces/dots/special chars)
|
||||||
|
const safeRuntime = runtime.toLowerCase().replace(/[^a-z0-9]/g, '');
|
||||||
|
|
||||||
|
this.currentTestLogFile = path.join('.nogit', 'testlogs', `${safeFilename}__${safeRuntime}.log`);
|
||||||
|
|
||||||
// Ensure the directory exists
|
// Ensure the directory exists
|
||||||
const logDir = path.dirname(this.currentTestLogFile);
|
const logDir = path.dirname(this.currentTestLogFile);
|
||||||
if (!fs.existsSync(logDir)) {
|
if (!fs.existsSync(logDir)) {
|
||||||
fs.mkdirSync(logDir, { recursive: true });
|
fs.mkdirSync(logDir, { recursive: true });
|
||||||
}
|
}
|
||||||
|
|
||||||
// Clear the log file for this test
|
// Clear the log file for this test
|
||||||
fs.writeFileSync(this.currentTestLogFile, '');
|
fs.writeFileSync(this.currentTestLogFile, '');
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -91,6 +91,24 @@ tap.testParallel('should fetch user data', async () => {
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Note:** The `tap.parallel().test()` fluent API is now the recommended way to define parallel tests (see Fluent API section below).
|
||||||
|
|
||||||
|
#### `tap.parallel()`
|
||||||
|
|
||||||
|
Returns a fluent test builder configured for parallel execution.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
tap.parallel().test('should fetch data', async () => {
|
||||||
|
// Parallel test
|
||||||
|
});
|
||||||
|
|
||||||
|
// With full configuration
|
||||||
|
tap.parallel()
|
||||||
|
.tags('api')
|
||||||
|
.retry(2)
|
||||||
|
.test('configured parallel test', async () => {});
|
||||||
|
```
|
||||||
|
|
||||||
#### `tap.describe(description, suiteFunction)`
|
#### `tap.describe(description, suiteFunction)`
|
||||||
|
|
||||||
Create a test suite to group related tests.
|
Create a test suite to group related tests.
|
||||||
@@ -141,22 +159,56 @@ tap
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Parallel Tests with Fluent API
|
||||||
|
|
||||||
|
Use `tap.parallel()` to create parallel tests with fluent configuration:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Simple parallel test
|
||||||
|
tap.parallel().test('fetches user data', async () => {
|
||||||
|
// Runs in parallel with other parallel tests
|
||||||
|
});
|
||||||
|
|
||||||
|
// Parallel test with full configuration
|
||||||
|
tap
|
||||||
|
.parallel()
|
||||||
|
.tags('api', 'integration')
|
||||||
|
.retry(2)
|
||||||
|
.timeout(5000)
|
||||||
|
.test('should fetch data concurrently', async () => {
|
||||||
|
// Configured parallel test
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** `tap.parallel().test()` is the recommended way to define parallel tests. The older `tap.testParallel()` method is still supported for backward compatibility.
|
||||||
|
|
||||||
### Lifecycle Hooks
|
### Lifecycle Hooks
|
||||||
|
|
||||||
#### Suite-Level Hooks
|
#### Suite-Level Hooks
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
tap.describe('Database Tests', () => {
|
tap.describe('Database Tests', () => {
|
||||||
|
tap.beforeAll(async (tapTools) => {
|
||||||
|
// Runs once before all tests in this suite
|
||||||
|
await initializeDatabaseConnection();
|
||||||
|
});
|
||||||
|
|
||||||
tap.beforeEach(async (tapTools) => {
|
tap.beforeEach(async (tapTools) => {
|
||||||
// Runs before each test in this suite
|
// Runs before each test in this suite
|
||||||
|
await clearTestData();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
tap.test('test 1', async () => { });
|
||||||
|
tap.test('test 2', async () => { });
|
||||||
|
|
||||||
tap.afterEach(async (tapTools) => {
|
tap.afterEach(async (tapTools) => {
|
||||||
// Runs after each test in this suite
|
// Runs after each test in this suite
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('test 1', async () => { });
|
tap.afterAll(async (tapTools) => {
|
||||||
tap.test('test 2', async () => { });
|
// Runs once after all tests in this suite
|
||||||
|
await closeDatabaseConnection();
|
||||||
|
});
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -267,38 +319,169 @@ TSTEST_FILTER_TAGS=unit tstest test/mytest.node.ts
|
|||||||
|
|
||||||
Each test receives a `tapTools` instance with utilities:
|
Each test receives a `tapTools` instance with utilities:
|
||||||
|
|
||||||
|
#### Test Control Methods
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
tap.test('should have utilities', async (tapTools) => {
|
tap.test('test control examples', async (tapTools) => {
|
||||||
// Mark test as skipped
|
// Skip this test
|
||||||
|
tapTools.skip('reason');
|
||||||
|
|
||||||
|
// Conditionally skip
|
||||||
|
tapTools.skipIf(condition, 'reason');
|
||||||
|
|
||||||
|
// Mark test as skipped before execution
|
||||||
tapTools.markAsSkipped('reason');
|
tapTools.markAsSkipped('reason');
|
||||||
|
|
||||||
// Mark as todo
|
// Mark as todo
|
||||||
tapTools.todo('not implemented');
|
tapTools.todo('not implemented');
|
||||||
|
|
||||||
|
// Allow test to fail without marking suite as failed
|
||||||
|
tapTools.allowFailure();
|
||||||
|
|
||||||
// Configure retries
|
// Configure retries
|
||||||
tapTools.retry(3);
|
tapTools.retry(3);
|
||||||
|
|
||||||
// Log test output
|
// Set timeout
|
||||||
tapTools.log('debug message');
|
tapTools.timeout(5000);
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Utility Methods
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
tap.test('utility examples', async (tapTools) => {
|
||||||
|
// Delay execution
|
||||||
|
await tapTools.delayFor(1000); // Wait 1 second
|
||||||
|
await tapTools.delayForRandom(500, 1500); // Random delay
|
||||||
|
|
||||||
|
// Colored console output
|
||||||
|
tapTools.coloredString('✓ Success', 'green');
|
||||||
|
tapTools.coloredString('✗ Error', 'red');
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Context and Data Sharing
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
tap.test('first test', async (tapTools) => {
|
||||||
|
// Store data in context
|
||||||
|
tapTools.context.set('userId', '12345');
|
||||||
|
|
||||||
|
// Store in testData property
|
||||||
|
tapTools.testData = { username: 'alice' };
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('second test', async (tapTools) => {
|
||||||
|
// Retrieve from context
|
||||||
|
const userId = tapTools.context.get('userId');
|
||||||
|
|
||||||
|
// Check existence
|
||||||
|
if (tapTools.context.has('userId')) {
|
||||||
|
// Use data
|
||||||
|
}
|
||||||
|
|
||||||
|
// Clear context
|
||||||
|
tapTools.context.clear();
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Fixtures
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Define a fixture globally (outside tests)
|
||||||
|
import { TapTools } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
TapTools.defineFixture('database', async () => {
|
||||||
|
const db = await createTestDatabase();
|
||||||
|
return {
|
||||||
|
value: db,
|
||||||
|
cleanup: async () => await db.close()
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
// Use fixtures in tests
|
||||||
|
tap.test('database test', async (tapTools) => {
|
||||||
|
const db = await tapTools.fixture('database');
|
||||||
|
// Use db...
|
||||||
|
// Cleanup happens automatically
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Factory Pattern
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Define a factory
|
||||||
|
TapTools.defineFixture('user', async () => {
|
||||||
|
return {
|
||||||
|
value: null, // Not used for factories
|
||||||
|
factory: async (data) => {
|
||||||
|
return await createUser(data);
|
||||||
|
},
|
||||||
|
cleanup: async (user) => await user.delete()
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
// Use factory in tests
|
||||||
|
tap.test('user test', async (tapTools) => {
|
||||||
|
const user = await tapTools.factory('user').create({ name: 'Alice' });
|
||||||
|
|
||||||
|
// Create multiple
|
||||||
|
const users = await tapTools.factory('user').createMany([
|
||||||
|
{ name: 'Alice' },
|
||||||
|
{ name: 'Bob' }
|
||||||
|
]);
|
||||||
|
|
||||||
|
// Cleanup happens automatically
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Snapshot Testing
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
tap.test('snapshot test', async (tapTools) => {
|
||||||
|
const result = { name: 'Alice', age: 30 };
|
||||||
|
|
||||||
|
// Compare with stored snapshot
|
||||||
|
await tapTools.matchSnapshot(result);
|
||||||
|
|
||||||
|
// Named snapshots
|
||||||
|
await tapTools.matchSnapshot(result, 'user-data');
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
To update snapshots, run with:
|
||||||
|
```bash
|
||||||
|
UPDATE_SNAPSHOTS=true tstest test/mytest.ts
|
||||||
|
```
|
||||||
|
|
||||||
## Advanced Features
|
## Advanced Features
|
||||||
|
|
||||||
### Pre-Tasks
|
### Pre-Tasks and Post-Tasks
|
||||||
|
|
||||||
Run setup tasks before any tests execute:
|
Run setup and teardown tasks before/after all tests:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
tap.preTask('setup database', async () => {
|
tap.preTask('setup database', async () => {
|
||||||
// Runs before any tests
|
// Runs before any tests
|
||||||
|
await initializeDatabase();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('first test', async () => {
|
tap.test('first test', async () => {
|
||||||
// Database is ready
|
// Database is ready
|
||||||
});
|
});
|
||||||
|
|
||||||
|
tap.test('second test', async () => {
|
||||||
|
// Tests run...
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.postTask('cleanup database', async () => {
|
||||||
|
// Runs after all tests complete
|
||||||
|
await cleanupDatabase();
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Note:** Post tasks run after all tests but before the global `afterAll` hook.
|
||||||
|
|
||||||
### Test Priority
|
### Test Priority
|
||||||
|
|
||||||
Organize tests by priority level:
|
Organize tests by priority level:
|
||||||
@@ -334,6 +517,50 @@ import { setProtocolEmitter } from '@git.zone/tstest/tapbundle';
|
|||||||
// Events: test:started, test:completed, assertion:failed, suite:started, suite:completed
|
// Events: test:started, test:completed, assertion:failed, suite:started, suite:completed
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Additional Tap Methods
|
||||||
|
|
||||||
|
#### Configuration and Inspection
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Get current test settings
|
||||||
|
const settings = tap.getSettings();
|
||||||
|
console.log(settings.timeout, settings.retries);
|
||||||
|
|
||||||
|
// Explicitly fail a test
|
||||||
|
tap.test('validation test', async () => {
|
||||||
|
if (invalidCondition) {
|
||||||
|
tap.fail('Custom failure message');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Advanced Control
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Force stop test execution
|
||||||
|
tap.stopForcefully(exitCode, immediate);
|
||||||
|
|
||||||
|
// Handle thrown errors (internal use)
|
||||||
|
tap.threw(error);
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parallel Test Variants
|
||||||
|
|
||||||
|
In addition to `tap.parallel().test()`, skip/only/todo modes also support parallel execution:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Skip parallel test
|
||||||
|
tap.skip.testParallel('not ready', async () => {});
|
||||||
|
|
||||||
|
// Only run this parallel test
|
||||||
|
tap.only.testParallel('focus here', async () => {});
|
||||||
|
|
||||||
|
// Todo parallel test
|
||||||
|
tap.todo.testParallel('implement later');
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** Using `tap.parallel()` fluent API is recommended over these direct methods.
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
1. **Always export `tap.start()`** at the end of test files:
|
1. **Always export `tap.start()`** at the end of test files:
|
||||||
|
|||||||
21
ts_tapbundle/tapbundle.classes.posttask.ts
Normal file
21
ts_tapbundle/tapbundle.classes.posttask.ts
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
import * as plugins from './tapbundle.plugins.js';
|
||||||
|
import { TapTools } from './tapbundle.classes.taptools.js';
|
||||||
|
|
||||||
|
export interface IPostTaskFunction {
|
||||||
|
(tapTools?: TapTools): Promise<any>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class PostTask {
|
||||||
|
public description: string;
|
||||||
|
public postTaskFunction: IPostTaskFunction;
|
||||||
|
|
||||||
|
constructor(descriptionArg: string, postTaskFunctionArg: IPostTaskFunction) {
|
||||||
|
this.description = descriptionArg;
|
||||||
|
this.postTaskFunction = postTaskFunctionArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
public async run() {
|
||||||
|
console.log(`::__POSTTASK: ${this.description}`);
|
||||||
|
await this.postTaskFunction(new TapTools(null));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,7 +1,9 @@
|
|||||||
import * as plugins from './tapbundle.plugins.js';
|
import * as plugins from './tapbundle.plugins.js';
|
||||||
|
|
||||||
import { type IPreTaskFunction, PreTask } from './tapbundle.classes.pretask.js';
|
import { type IPreTaskFunction, PreTask } from './tapbundle.classes.pretask.js';
|
||||||
|
import { type IPostTaskFunction, PostTask } from './tapbundle.classes.posttask.js';
|
||||||
import { TapTest, type ITestFunction } from './tapbundle.classes.taptest.js';
|
import { TapTest, type ITestFunction } from './tapbundle.classes.taptest.js';
|
||||||
|
import { TapTools } from './tapbundle.classes.taptools.js';
|
||||||
import { ProtocolEmitter, type ITestEvent } from '../dist_ts_tapbundle_protocol/index.js';
|
import { ProtocolEmitter, type ITestEvent } from '../dist_ts_tapbundle_protocol/index.js';
|
||||||
import type { ITapSettings } from './tapbundle.interfaces.js';
|
import type { ITapSettings } from './tapbundle.interfaces.js';
|
||||||
import { SettingsManager } from './tapbundle.classes.settingsmanager.js';
|
import { SettingsManager } from './tapbundle.classes.settingsmanager.js';
|
||||||
@@ -9,6 +11,8 @@ import { SettingsManager } from './tapbundle.classes.settingsmanager.js';
|
|||||||
export interface ITestSuite {
|
export interface ITestSuite {
|
||||||
description: string;
|
description: string;
|
||||||
tests: TapTest<any>[];
|
tests: TapTest<any>[];
|
||||||
|
beforeAll?: ITestFunction<any>;
|
||||||
|
afterAll?: ITestFunction<any>;
|
||||||
beforeEach?: ITestFunction<any>;
|
beforeEach?: ITestFunction<any>;
|
||||||
afterEach?: ITestFunction<any>;
|
afterEach?: ITestFunction<any>;
|
||||||
parent?: ITestSuite;
|
parent?: ITestSuite;
|
||||||
@@ -21,85 +25,89 @@ class TestBuilder<T> {
|
|||||||
private _priority: 'high' | 'medium' | 'low' = 'medium';
|
private _priority: 'high' | 'medium' | 'low' = 'medium';
|
||||||
private _retryCount?: number;
|
private _retryCount?: number;
|
||||||
private _timeoutMs?: number;
|
private _timeoutMs?: number;
|
||||||
|
private _parallel: boolean = false;
|
||||||
constructor(tap: Tap<T>) {
|
|
||||||
|
constructor(tap: Tap<T>, parallel: boolean = false) {
|
||||||
this._tap = tap;
|
this._tap = tap;
|
||||||
|
this._parallel = parallel;
|
||||||
}
|
}
|
||||||
|
|
||||||
tags(...tags: string[]) {
|
tags(...tags: string[]) {
|
||||||
this._tags = tags;
|
this._tags = tags;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
priority(level: 'high' | 'medium' | 'low') {
|
priority(level: 'high' | 'medium' | 'low') {
|
||||||
this._priority = level;
|
this._priority = level;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
retry(count: number) {
|
retry(count: number) {
|
||||||
this._retryCount = count;
|
this._retryCount = count;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
timeout(ms: number) {
|
timeout(ms: number) {
|
||||||
this._timeoutMs = ms;
|
this._timeoutMs = ms;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
test(description: string, testFunction: ITestFunction<T>) {
|
test(description: string, testFunction: ITestFunction<T>) {
|
||||||
const test = this._tap.test(description, testFunction, 'normal');
|
const test = this._parallel
|
||||||
|
? this._tap.testParallel(description, testFunction)
|
||||||
|
: this._tap.test(description, testFunction, 'normal');
|
||||||
|
|
||||||
// Apply settings to the test
|
// Apply settings to the test
|
||||||
if (this._tags.length > 0) {
|
if (this._tags.length > 0) {
|
||||||
test.tags = this._tags;
|
test.tags = this._tags;
|
||||||
}
|
}
|
||||||
test.priority = this._priority;
|
test.priority = this._priority;
|
||||||
|
|
||||||
if (this._retryCount !== undefined) {
|
if (this._retryCount !== undefined) {
|
||||||
test.tapTools.retry(this._retryCount);
|
test.tapTools.retry(this._retryCount);
|
||||||
}
|
}
|
||||||
if (this._timeoutMs !== undefined) {
|
if (this._timeoutMs !== undefined) {
|
||||||
test.timeoutMs = this._timeoutMs;
|
test.timeoutMs = this._timeoutMs;
|
||||||
}
|
}
|
||||||
|
|
||||||
return test;
|
return test;
|
||||||
}
|
}
|
||||||
|
|
||||||
testOnly(description: string, testFunction: ITestFunction<T>) {
|
testOnly(description: string, testFunction: ITestFunction<T>) {
|
||||||
const test = this._tap.test(description, testFunction, 'only');
|
const test = this._tap.test(description, testFunction, 'only');
|
||||||
|
|
||||||
// Apply settings to the test
|
// Apply settings to the test
|
||||||
if (this._tags.length > 0) {
|
if (this._tags.length > 0) {
|
||||||
test.tags = this._tags;
|
test.tags = this._tags;
|
||||||
}
|
}
|
||||||
test.priority = this._priority;
|
test.priority = this._priority;
|
||||||
|
|
||||||
if (this._retryCount !== undefined) {
|
if (this._retryCount !== undefined) {
|
||||||
test.tapTools.retry(this._retryCount);
|
test.tapTools.retry(this._retryCount);
|
||||||
}
|
}
|
||||||
if (this._timeoutMs !== undefined) {
|
if (this._timeoutMs !== undefined) {
|
||||||
test.timeoutMs = this._timeoutMs;
|
test.timeoutMs = this._timeoutMs;
|
||||||
}
|
}
|
||||||
|
|
||||||
return test;
|
return test;
|
||||||
}
|
}
|
||||||
|
|
||||||
testSkip(description: string, testFunction: ITestFunction<T>) {
|
testSkip(description: string, testFunction: ITestFunction<T>) {
|
||||||
const test = this._tap.test(description, testFunction, 'skip');
|
const test = this._tap.test(description, testFunction, 'skip');
|
||||||
|
|
||||||
// Apply settings to the test
|
// Apply settings to the test
|
||||||
if (this._tags.length > 0) {
|
if (this._tags.length > 0) {
|
||||||
test.tags = this._tags;
|
test.tags = this._tags;
|
||||||
}
|
}
|
||||||
test.priority = this._priority;
|
test.priority = this._priority;
|
||||||
|
|
||||||
if (this._retryCount !== undefined) {
|
if (this._retryCount !== undefined) {
|
||||||
test.tapTools.retry(this._retryCount);
|
test.tapTools.retry(this._retryCount);
|
||||||
}
|
}
|
||||||
if (this._timeoutMs !== undefined) {
|
if (this._timeoutMs !== undefined) {
|
||||||
test.timeoutMs = this._timeoutMs;
|
test.timeoutMs = this._timeoutMs;
|
||||||
}
|
}
|
||||||
|
|
||||||
return test;
|
return test;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -122,21 +130,25 @@ export class Tap<T> {
|
|||||||
const builder = new TestBuilder<T>(this);
|
const builder = new TestBuilder<T>(this);
|
||||||
return builder.tags(...tags);
|
return builder.tags(...tags);
|
||||||
}
|
}
|
||||||
|
|
||||||
public priority(level: 'high' | 'medium' | 'low') {
|
public priority(level: 'high' | 'medium' | 'low') {
|
||||||
const builder = new TestBuilder<T>(this);
|
const builder = new TestBuilder<T>(this);
|
||||||
return builder.priority(level);
|
return builder.priority(level);
|
||||||
}
|
}
|
||||||
|
|
||||||
public retry(count: number) {
|
public retry(count: number) {
|
||||||
const builder = new TestBuilder<T>(this);
|
const builder = new TestBuilder<T>(this);
|
||||||
return builder.retry(count);
|
return builder.retry(count);
|
||||||
}
|
}
|
||||||
|
|
||||||
public timeout(ms: number) {
|
public timeout(ms: number) {
|
||||||
const builder = new TestBuilder<T>(this);
|
const builder = new TestBuilder<T>(this);
|
||||||
return builder.timeout(ms);
|
return builder.timeout(ms);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public parallel() {
|
||||||
|
return new TestBuilder<T>(this, true);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* skips a test
|
* skips a test
|
||||||
@@ -236,6 +248,7 @@ export class Tap<T> {
|
|||||||
};
|
};
|
||||||
|
|
||||||
private _tapPreTasks: PreTask[] = [];
|
private _tapPreTasks: PreTask[] = [];
|
||||||
|
private _tapPostTasks: PostTask[] = [];
|
||||||
private _tapTests: TapTest<any>[] = [];
|
private _tapTests: TapTest<any>[] = [];
|
||||||
private _tapTestsOnly: TapTest<any>[] = [];
|
private _tapTestsOnly: TapTest<any>[] = [];
|
||||||
private _currentSuite: ITestSuite | null = null;
|
private _currentSuite: ITestSuite | null = null;
|
||||||
@@ -304,18 +317,22 @@ export class Tap<T> {
|
|||||||
this._tapPreTasks.push(new PreTask(descriptionArg, functionArg));
|
this._tapPreTasks.push(new PreTask(descriptionArg, functionArg));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public postTask(descriptionArg: string, functionArg: IPostTaskFunction) {
|
||||||
|
this._tapPostTasks.push(new PostTask(descriptionArg, functionArg));
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A parallel test that will not be waited for before the next starts.
|
* A parallel test that will not be waited for before the next starts.
|
||||||
* @param testDescription - A description of what the test does
|
* @param testDescription - A description of what the test does
|
||||||
* @param testFunction - A Function that returns a Promise and resolves or rejects
|
* @param testFunction - A Function that returns a Promise and resolves or rejects
|
||||||
*/
|
*/
|
||||||
public testParallel(testDescription: string, testFunction: ITestFunction<T>) {
|
public testParallel(testDescription: string, testFunction: ITestFunction<T>): TapTest<T> {
|
||||||
const localTest = new TapTest({
|
const localTest = new TapTest({
|
||||||
description: testDescription,
|
description: testDescription,
|
||||||
testFunction,
|
testFunction,
|
||||||
parallel: true,
|
parallel: true,
|
||||||
});
|
});
|
||||||
|
|
||||||
// Apply default settings from settings manager
|
// Apply default settings from settings manager
|
||||||
const settings = this.settingsManager.getSettings();
|
const settings = this.settingsManager.getSettings();
|
||||||
if (settings.timeout !== undefined) {
|
if (settings.timeout !== undefined) {
|
||||||
@@ -324,12 +341,14 @@ export class Tap<T> {
|
|||||||
if (settings.retries !== undefined) {
|
if (settings.retries !== undefined) {
|
||||||
localTest.tapTools.retry(settings.retries);
|
localTest.tapTools.retry(settings.retries);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (this._currentSuite) {
|
if (this._currentSuite) {
|
||||||
this._currentSuite.tests.push(localTest);
|
this._currentSuite.tests.push(localTest);
|
||||||
} else {
|
} else {
|
||||||
this._tapTests.push(localTest);
|
this._tapTests.push(localTest);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return localTest;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -360,6 +379,28 @@ export class Tap<T> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set up a function to run once before all tests in the current suite
|
||||||
|
*/
|
||||||
|
public beforeAll(setupFunction: ITestFunction<any>) {
|
||||||
|
if (this._currentSuite) {
|
||||||
|
this._currentSuite.beforeAll = setupFunction;
|
||||||
|
} else {
|
||||||
|
throw new Error('beforeAll can only be used inside a describe block');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set up a function to run once after all tests in the current suite
|
||||||
|
*/
|
||||||
|
public afterAll(teardownFunction: ITestFunction<any>) {
|
||||||
|
if (this._currentSuite) {
|
||||||
|
this._currentSuite.afterAll = teardownFunction;
|
||||||
|
} else {
|
||||||
|
throw new Error('afterAll can only be used inside a describe block');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up a function to run before each test in the current suite
|
* Set up a function to run before each test in the current suite
|
||||||
*/
|
*/
|
||||||
@@ -370,7 +411,7 @@ export class Tap<T> {
|
|||||||
throw new Error('beforeEach can only be used inside a describe block');
|
throw new Error('beforeEach can only be used inside a describe block');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set up a function to run after each test in the current suite
|
* Set up a function to run after each test in the current suite
|
||||||
*/
|
*/
|
||||||
@@ -554,6 +595,11 @@ export class Tap<T> {
|
|||||||
console.log(failReason);
|
console.log(failReason);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Run post tasks
|
||||||
|
for (const postTask of this._tapPostTasks) {
|
||||||
|
await postTask.run();
|
||||||
|
}
|
||||||
|
|
||||||
// Run global afterAll hook if configured
|
// Run global afterAll hook if configured
|
||||||
if (settings.afterAll) {
|
if (settings.afterAll) {
|
||||||
try {
|
try {
|
||||||
@@ -597,6 +643,12 @@ export class Tap<T> {
|
|||||||
suiteName: suite.description
|
suiteName: suite.description
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Run beforeAll hook for this suite
|
||||||
|
if (suite.beforeAll) {
|
||||||
|
await suite.beforeAll(new TapTools(null as any));
|
||||||
|
}
|
||||||
|
|
||||||
// Run beforeEach from parent suites
|
// Run beforeEach from parent suites
|
||||||
const beforeEachFunctions: ITestFunction<any>[] = [];
|
const beforeEachFunctions: ITestFunction<any>[] = [];
|
||||||
let currentSuite: ITestSuite | null = suite;
|
let currentSuite: ITestSuite | null = suite;
|
||||||
@@ -666,7 +718,12 @@ export class Tap<T> {
|
|||||||
|
|
||||||
// Recursively run child suites
|
// Recursively run child suites
|
||||||
await this._runSuite(suite, suite.children, promiseArray, context);
|
await this._runSuite(suite, suite.children, promiseArray, context);
|
||||||
|
|
||||||
|
// Run afterAll hook for this suite
|
||||||
|
if (suite.afterAll) {
|
||||||
|
await suite.afterAll(new TapTools(null as any));
|
||||||
|
}
|
||||||
|
|
||||||
// Emit suite:completed event
|
// Emit suite:completed event
|
||||||
this.emitEvent({
|
this.emitEvent({
|
||||||
eventType: 'suite:completed',
|
eventType: 'suite:completed',
|
||||||
|
|||||||
@@ -1,17 +1,17 @@
|
|||||||
# @git.zone/tstest/tapbundle_node
|
# @git.zone/tstest/tapbundle_serverside
|
||||||
|
|
||||||
> 🔧 Node.js-specific testing utilities for enhanced test capabilities
|
> 🔧 Server-side testing utilities for Node.js runtime tests
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# tapbundle_node is included as part of @git.zone/tstest
|
# tapbundle_serverside is included as part of @git.zone/tstest
|
||||||
pnpm install --save-dev @git.zone/tstest
|
pnpm install --save-dev @git.zone/tstest
|
||||||
```
|
```
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
`@git.zone/tstest/tapbundle_node` provides Node.js-specific utilities for testing. These tools are only available when running tests in Node.js runtime and provide functionality for working with environment variables, shell commands, test databases, storage systems, and HTTPS certificates.
|
`@git.zone/tstest/tapbundle_serverside` provides server-side testing utilities exclusively for Node.js runtime. These tools enable shell command execution, environment variable management, HTTPS certificate generation, database testing, object storage testing, and test asset management - all functionality that only makes sense on the server-side.
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
@@ -25,11 +25,11 @@ pnpm install --save-dev @git.zone/tstest
|
|||||||
## Basic Usage
|
## Basic Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
import { tapNodeTools } from '@git.zone/tstest/tapbundle_serverside';
|
||||||
import { tap } from '@git.zone/tstest/tapbundle';
|
import { tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
tap.test('should use node-specific tools', async () => {
|
tap.test('should use server-side tools', async () => {
|
||||||
// Use Node.js-specific utilities
|
// Execute shell commands on the server-side
|
||||||
const result = await tapNodeTools.runCommand('echo "hello"');
|
const result = await tapNodeTools.runCommand('echo "hello"');
|
||||||
console.log(result);
|
console.log(result);
|
||||||
});
|
});
|
||||||
@@ -131,7 +131,7 @@ tap.test('should create HTTPS server', async () => {
|
|||||||
Create an ephemeral MongoDB instance for testing. Automatically started and ready to use.
|
Create an ephemeral MongoDB instance for testing. Automatically started and ready to use.
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
import { tapNodeTools } from '@git.zone/tstest/tapbundle_serverside';
|
||||||
|
|
||||||
tap.test('should use MongoDB', async () => {
|
tap.test('should use MongoDB', async () => {
|
||||||
const mongoInstance = await tapNodeTools.createSmartmongo();
|
const mongoInstance = await tapNodeTools.createSmartmongo();
|
||||||
@@ -170,7 +170,7 @@ export default tap.start();
|
|||||||
Create a local S3-compatible storage instance for testing object storage operations.
|
Create a local S3-compatible storage instance for testing object storage operations.
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
import { tapNodeTools } from '@git.zone/tstest/tapbundle_serverside';
|
||||||
|
|
||||||
tap.test('should use S3 storage', async () => {
|
tap.test('should use S3 storage', async () => {
|
||||||
const s3Instance = await tapNodeTools.createSmarts3();
|
const s3Instance = await tapNodeTools.createSmarts3();
|
||||||
@@ -209,7 +209,7 @@ Utility for downloading and managing test assets.
|
|||||||
Download the Alpine Linux Docker image as a tarball for testing.
|
Download the Alpine Linux Docker image as a tarball for testing.
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
import { tapNodeTools } from '@git.zone/tstest/tapbundle_serverside';
|
||||||
|
|
||||||
tap.test('should provide docker image', async () => {
|
tap.test('should provide docker image', async () => {
|
||||||
const tarballPath = await tapNodeTools.testFileProvider.getDockerAlpineImageAsLocalTarball();
|
const tarballPath = await tapNodeTools.testFileProvider.getDockerAlpineImageAsLocalTarball();
|
||||||
@@ -238,7 +238,7 @@ export default tap.start();
|
|||||||
The module exports useful path constants:
|
The module exports useful path constants:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import * as paths from '@git.zone/tstest/tapbundle_node/paths';
|
import * as paths from '@git.zone/tstest/tapbundle_serverside/paths';
|
||||||
|
|
||||||
console.log(paths.cwd); // Current working directory
|
console.log(paths.cwd); // Current working directory
|
||||||
console.log(paths.testFilesDir); // ./.nogit/testfiles/
|
console.log(paths.testFilesDir); // ./.nogit/testfiles/
|
||||||
@@ -249,7 +249,7 @@ console.log(paths.testFilesDir); // ./.nogit/testfiles/
|
|||||||
### Testing with External Services
|
### Testing with External Services
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
import { tapNodeTools } from '@git.zone/tstest/tapbundle_serverside';
|
||||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
tap.describe('User Service Integration', () => {
|
tap.describe('User Service Integration', () => {
|
||||||
@@ -280,7 +280,7 @@ export default tap.start();
|
|||||||
### Testing HTTPS Servers
|
### Testing HTTPS Servers
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
import { tapNodeTools } from '@git.zone/tstest/tapbundle_serverside';
|
||||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
import * as https from 'https';
|
import * as https from 'https';
|
||||||
|
|
||||||
@@ -311,7 +311,7 @@ export default tap.start();
|
|||||||
### Environment-Dependent Tests
|
### Environment-Dependent Tests
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
import { tapNodeTools } from '@git.zone/tstest/tapbundle_serverside';
|
||||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
tap.test('should authenticate with GitHub', async () => {
|
tap.test('should authenticate with GitHub', async () => {
|
||||||
@@ -332,12 +332,14 @@ export default tap.start();
|
|||||||
|
|
||||||
## Runtime Requirements
|
## Runtime Requirements
|
||||||
|
|
||||||
⚠️ **Node.js Only**: All utilities in this module require Node.js runtime. They will not work in:
|
⚠️ **Server-Side Only (Node.js)**: All utilities in this module are designed exclusively for server-side testing in Node.js runtime. They provide functionality like shell command execution, file system operations, and process management that only make sense on the server.
|
||||||
|
|
||||||
|
**NOT available in:**
|
||||||
- Browser environments
|
- Browser environments
|
||||||
- Deno runtime
|
- Deno runtime
|
||||||
- Bun runtime
|
- Bun runtime
|
||||||
|
|
||||||
For multi-runtime tests, use these utilities only in `.node.ts` test files.
|
**Important:** Import tapbundle_serverside only in tests that run exclusively on the server-side (`.node.ts` test files). For cross-runtime tests, these utilities will fail in non-Node environments.
|
||||||
|
|
||||||
## File Naming
|
## File Naming
|
||||||
|
|
||||||
Reference in New Issue
Block a user