Compare commits
30 Commits
Author | SHA1 | Date | |
---|---|---|---|
4714d5e8ad | |||
ff6aae7159 | |||
d05ec21b73 | |||
956a880a4a | |||
ee11b1ac17 | |||
054cbb6b3c | |||
ecf11efb4c | |||
1de674e91d | |||
9fa2c23ab2 | |||
36715c9139 | |||
ee0aca9ff7 | |||
aaebe75326 | |||
265ed702ee | |||
efbaded1f3 | |||
799a60188f | |||
3c38a53d9d | |||
cca01b51ec | |||
84843ad359 | |||
7a8ae95be2 | |||
133e0eda8b | |||
14e32b06de | |||
48aebb1eac | |||
733b2249d0 | |||
008844a9e2 | |||
e4fc6623ea | |||
70435cce45 | |||
c26145205f | |||
82fc22653b | |||
3d85f54be0 | |||
9464c17c15 |
1
.serena/.gitignore
vendored
Normal file
1
.serena/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
/cache
|
68
.serena/project.yml
Normal file
68
.serena/project.yml
Normal file
@@ -0,0 +1,68 @@
|
||||
# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
|
||||
# * For C, use cpp
|
||||
# * For JavaScript, use typescript
|
||||
# Special requirements:
|
||||
# * csharp: Requires the presence of a .sln file in the project folder.
|
||||
language: typescript
|
||||
|
||||
# whether to use the project's gitignore file to ignore files
|
||||
# Added on 2025-04-07
|
||||
ignore_all_files_in_gitignore: true
|
||||
# list of additional paths to ignore
|
||||
# same syntax as gitignore, so you can use * and **
|
||||
# Was previously called `ignored_dirs`, please update your config if you are using that.
|
||||
# Added (renamed) on 2025-04-07
|
||||
ignored_paths: []
|
||||
|
||||
# whether the project is in read-only mode
|
||||
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
|
||||
# Added on 2025-04-18
|
||||
read_only: false
|
||||
|
||||
|
||||
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
|
||||
# Below is the complete list of tools for convenience.
|
||||
# To make sure you have the latest list of tools, and to view their descriptions,
|
||||
# execute `uv run scripts/print_tool_overview.py`.
|
||||
#
|
||||
# * `activate_project`: Activates a project by name.
|
||||
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
|
||||
# * `create_text_file`: Creates/overwrites a file in the project directory.
|
||||
# * `delete_lines`: Deletes a range of lines within a file.
|
||||
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
|
||||
# * `execute_shell_command`: Executes a shell command.
|
||||
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
|
||||
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
|
||||
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
|
||||
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
|
||||
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
|
||||
# * `initial_instructions`: Gets the initial instructions for the current project.
|
||||
# Should only be used in settings where the system prompt cannot be set,
|
||||
# e.g. in clients you have no control over, like Claude Desktop.
|
||||
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
|
||||
# * `insert_at_line`: Inserts content at a given line in a file.
|
||||
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
|
||||
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
|
||||
# * `list_memories`: Lists memories in Serena's project-specific memory store.
|
||||
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
|
||||
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
|
||||
# * `read_file`: Reads a file within the project directory.
|
||||
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
|
||||
# * `remove_project`: Removes a project from the Serena configuration.
|
||||
# * `replace_lines`: Replaces a range of lines within a file with new content.
|
||||
# * `replace_symbol_body`: Replaces the full definition of a symbol.
|
||||
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
|
||||
# * `search_for_pattern`: Performs a search for a pattern in the project.
|
||||
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
|
||||
# * `switch_modes`: Activates modes by providing a list of their names
|
||||
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
|
||||
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
|
||||
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
|
||||
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
|
||||
excluded_tools: []
|
||||
|
||||
# initial prompt for the project. It will always be given to the LLM upon activating the project
|
||||
# (contrary to the memories, which are loaded on demand).
|
||||
initial_prompt: ""
|
||||
|
||||
project_name: "tstest"
|
129
changelog.md
129
changelog.md
@@ -1,5 +1,134 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-10-12 - 2.5.0 - feat(tstest.classes.runtime.parser)
|
||||
Add support for "all" runtime token and update docs/tests; regenerate lockfile and add local settings
|
||||
|
||||
- Add support for the `all` runtime token (expands to node, chromium, deno, bun) in tstest filename parser (tstest.classes.runtime.parser)
|
||||
- Handle `all` with modifiers (e.g. `*.all.nonci.ts`) and mixed tokens (e.g. `node+all`) so it expands to the full runtime set
|
||||
- Add unit tests covering `all` cases in test/test.runtime.parser.node.ts
|
||||
- Update README (examples and tables) to document `.all.ts` and `.all.nonci.ts` usage and include a universal example
|
||||
- Update ts files' parser comments and constants to include ALL_RUNTIMES
|
||||
- Add deno.lock (dependency lockfile) and a local .claude/settings.local.json for project permissions / local settings
|
||||
|
||||
## 2025-10-11 - 2.4.3 - fix(docs)
|
||||
Update documentation: expand README with multi-runtime architecture, add module READMEs, and add local dev settings
|
||||
|
||||
- Expanded project README: fixed typos, clarified availability header, and added a detailed Multi-Runtime Architecture section (runtimes, naming conventions, migration tool, examples, and runtime-specific notes).
|
||||
- Inserted additional example output and adjusted JSON/example sections to reflect multi-runtime flows and updated totals/durations in examples.
|
||||
- Added dedicated README files for ts_tapbundle, ts_tapbundle_node, and ts_tapbundle_protocol modules with API overviews and usage guides.
|
||||
- Added .claude/settings.local.json to provide local development permissions/settings used by the project tooling.
|
||||
- Minor formatting and documentation cleanup (whitespace, headings, and changelog entries).
|
||||
|
||||
## 2025-10-10 - 2.4.2 - fix(deno)
|
||||
Enable additional Deno permissions for runtime adapters and add local dev settings
|
||||
|
||||
- Add --allow-sys, --allow-import and --node-modules-dir to the default Deno permission set used by the Deno runtime adapter
|
||||
- Include the new permission flags in the fallback permissions array when constructing Deno command args
|
||||
- Add .claude/settings.local.json to capture local development permissions and helper commands
|
||||
|
||||
## 2025-10-10 - 2.4.1 - fix(runtime/deno)
|
||||
Enable Deno runtime tests by adding required permissions and local settings
|
||||
|
||||
- ts/tstest.classes.runtime.deno.ts: expanded default Deno permissions to include --allow-net, --allow-write and --sloppy-imports to allow network access, file writes and permissive JS/TS imports
|
||||
- ts/tstest.classes.runtime.deno.ts: updated fallback permissions used when building the Deno command to match the new default set
|
||||
- Added .claude/settings.local.json with a set of allowed local commands/permissions used for local development/CI tooling
|
||||
|
||||
## 2025-10-10 - 2.4.0 - feat(runtime)
|
||||
Add runtime adapters, filename runtime parser and migration tool; integrate runtime selection into TsTest and add tests
|
||||
|
||||
- Introduce RuntimeAdapter abstraction and RuntimeAdapterRegistry to manage multiple runtimes
|
||||
- Add runtime adapters: NodeRuntimeAdapter, ChromiumRuntimeAdapter, DenoRuntimeAdapter and BunRuntimeAdapter
|
||||
- Add filename runtime parser utilities: parseTestFilename, isLegacyFilename and getLegacyMigrationTarget
|
||||
- Add Migration class to detect and (dry-run) migrate legacy test filenames to the new naming convention
|
||||
- Integrate runtime registry into TsTest and choose execution adapters based on parsed runtimes; show deprecation warnings for legacy naming
|
||||
- Add tests covering runtime parsing and migration: test/test.runtime.parser.node.ts and test/test.migration.node.ts
|
||||
|
||||
## 2025-09-12 - 2.3.8 - fix(tstest)
|
||||
Improve free port selection for Chrome runner and bump smartnetwork dependency
|
||||
|
||||
- Use randomized port selection when finding free HTTP and WebSocket ports to reduce collision probability in concurrent runs
|
||||
- Ensure WebSocket port search excludes the chosen HTTP port so the two ports will not conflict
|
||||
- Simplify failure handling: throw early if a free WebSocket port cannot be found instead of retrying with a less robust fallback
|
||||
- Bump @push.rocks/smartnetwork dependency from ^4.2.0 to ^4.4.0 to pick up new findFreePort options
|
||||
|
||||
## 2025-09-12 - 2.3.7 - fix(tests)
|
||||
Remove flaky dynamic-ports browser test and add local dev tool settings
|
||||
|
||||
- Removed test/tapbundle/test.dynamicports.ts — deletes a browser test that relied on injected dynamic WebSocket ports (reduces flaky CI/browser runs).
|
||||
- Added .claude/settings.local.json — local development settings for the CLAUDE helper (grants allowed dev/automation commands and webfetch permissions).
|
||||
|
||||
## 2025-09-03 - 2.3.6 - fix(tstest)
|
||||
Update deps, fix chrome server route for static bundles, add local tool settings and CI ignore
|
||||
|
||||
- Bump devDependency @git.zone/tsbuild to ^2.6.8
|
||||
- Bump dependencies: @api.global/typedserver to ^3.0.78, @push.rocks/smartlog to ^3.1.9, @push.rocks/smartrequest to ^4.3.1
|
||||
- Fix test server static route in ts/tstest.classes.tstest.ts: replace '(.*)' with '/*splat' so bundled test files are served correctly in Chromium runs
|
||||
- Add .claude/settings.local.json with local permissions for development tasks
|
||||
- Add .serena/.gitignore to ignore /cache
|
||||
|
||||
## 2025-08-18 - 2.3.5 - fix(core)
|
||||
Use SmartRequest with Buffer for binary downloads, tighten static route handling, bump dependencies and add workspace/config files
|
||||
|
||||
- ts_tapbundle_node/classes.testfileprovider.ts: switch to SmartRequest.create().url(...).get() and convert response to a Buffer before writing to disk to fix binary download handling for the Docker Alpine image.
|
||||
- ts/tstest.classes.tstest.ts: change server.addRoute from '*' to '(.*)' so the typedserver static handler uses a proper regex route.
|
||||
- package.json: bump several dependencies (e.g. @api.global/typedserver, @git.zone/tsbuild, @push.rocks/smartfile, @push.rocks/smartpath, @push.rocks/smartrequest, @push.rocks/smartshell) to newer patch/minor versions.
|
||||
- pnpm-workspace.yaml: add onlyBuiltDependencies list (esbuild, mongodb-memory-server, puppeteer).
|
||||
- Remove registry setting from .npmrc (cleanup).
|
||||
- Add project/agent config files: .serena/project.yml and .claude/settings.local.json for local tooling/agent configuration.
|
||||
|
||||
## 2025-08-16 - 2.3.4 - fix(ci)
|
||||
Add local Claude settings to allow required WebFetch and Bash permissions for local tooling and tests
|
||||
|
||||
- Add .claude/settings.local.json to configure allowed permissions for local assistant/automation
|
||||
- Grants WebFetch access for code.foss.global and www.npmjs.com
|
||||
- Allows various Bash commands used by local tasks and test runs (mkdir, tsbuild, pnpm, node, tsx, tstest, ls, rm, grep, cat)
|
||||
- No runtime/library code changes — configuration only
|
||||
|
||||
## 2025-08-16 - 2.3.3 - fix(dependencies)
|
||||
Bump dependency versions and add local Claude settings
|
||||
|
||||
- Bumped devDependency @git.zone/tsbuild ^2.6.3 → ^2.6.4
|
||||
- Updated @git.zone/tsbundle ^2.2.5 → ^2.5.1
|
||||
- Updated @push.rocks/consolecolor ^2.0.2 → ^2.0.3
|
||||
- Updated @push.rocks/qenv ^6.1.0 → ^6.1.3
|
||||
- Updated @push.rocks/smartchok ^1.0.34 → ^1.1.1
|
||||
- Updated @push.rocks/smartenv ^5.0.12 → ^5.0.13
|
||||
- Updated @push.rocks/smartfile ^11.2.3 → ^11.2.5
|
||||
- Updated @push.rocks/smarts3 ^2.2.5 → ^2.2.6
|
||||
- Updated @push.rocks/smartshell ^3.2.3 → ^3.2.4
|
||||
- Updated ws ^8.18.2 → ^8.18.3
|
||||
- Added .claude/settings.local.json for local Claude permissions and tooling (local-only configuration)
|
||||
|
||||
## 2025-07-24 - 2.3.2 - fix(tapbundle)
|
||||
Fix TypeScript IDE warning about tapTools parameter possibly being undefined
|
||||
|
||||
- Changed ITestFunction from interface with optional parameter to union type
|
||||
- Updated test runner to handle both function signatures (with and without tapTools)
|
||||
- Resolves IDE warnings while maintaining backward compatibility
|
||||
|
||||
## 2025-05-26 - 2.3.1 - fix(tapParser/logger)
|
||||
Fix test duration reporting and summary formatting in TAP parser and logger
|
||||
|
||||
- Introduce startTime in TapParser to capture the overall test duration
|
||||
- Pass computed duration to logger methods in evaluateFinalResult for accurate timing
|
||||
- Update summary output to format duration in a human-readable way (ms vs. s)
|
||||
- Add local permission settings configuration to .claude/settings.local.json
|
||||
|
||||
## 2025-05-26 - 2.3.0 - feat(cli)
|
||||
Add '--version' option and warn against global tstest usage in the tstest project
|
||||
|
||||
- Introduced a new '--version' CLI flag that prints the version from package.json
|
||||
- Added logic in ts/index.ts to detect if tstest is run globally within its own project and issue a warning
|
||||
- Added .claude/settings.local.json to configure allowed permissions for various commands
|
||||
|
||||
## 2025-05-26 - 2.2.6 - fix(tstest)
|
||||
Improve timeout warning timer management and summary output formatting in the test runner.
|
||||
|
||||
- Removed the global timeoutWarningTimer and replaced it with local warning timers in runInNode and runInChrome methods.
|
||||
- Added warnings when test files run for over one minute if no timeout is specified.
|
||||
- Ensured proper clearing of warning timers on successful completion or timeout.
|
||||
- Enhanced quiet mode summary output to clearly display passed and failed test counts.
|
||||
|
||||
## 2025-05-26 - 2.2.5 - fix(protocol)
|
||||
Fix inline timing metadata parsing and enhance test coverage for performance metrics and timing edge cases
|
||||
|
||||
|
31
package.json
31
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@git.zone/tstest",
|
||||
"version": "2.2.5",
|
||||
"version": "2.5.0",
|
||||
"private": false,
|
||||
"description": "a test utility to run tests that match test/**/*.ts",
|
||||
"exports": {
|
||||
@@ -24,34 +24,35 @@
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.6.3",
|
||||
"@git.zone/tsbuild": "^2.6.8",
|
||||
"@types/node": "^22.15.21"
|
||||
},
|
||||
"dependencies": {
|
||||
"@api.global/typedserver": "^3.0.74",
|
||||
"@git.zone/tsbundle": "^2.2.5",
|
||||
"@api.global/typedserver": "^3.0.78",
|
||||
"@git.zone/tsbundle": "^2.5.1",
|
||||
"@git.zone/tsrun": "^1.3.3",
|
||||
"@push.rocks/consolecolor": "^2.0.2",
|
||||
"@push.rocks/qenv": "^6.1.0",
|
||||
"@push.rocks/consolecolor": "^2.0.3",
|
||||
"@push.rocks/qenv": "^6.1.3",
|
||||
"@push.rocks/smartbrowser": "^2.0.8",
|
||||
"@push.rocks/smartchok": "^1.0.34",
|
||||
"@push.rocks/smartchok": "^1.1.1",
|
||||
"@push.rocks/smartcrypto": "^2.0.4",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartenv": "^5.0.12",
|
||||
"@push.rocks/smartenv": "^5.0.13",
|
||||
"@push.rocks/smartexpect": "^2.5.0",
|
||||
"@push.rocks/smartfile": "^11.2.3",
|
||||
"@push.rocks/smartfile": "^11.2.7",
|
||||
"@push.rocks/smartjson": "^5.0.20",
|
||||
"@push.rocks/smartlog": "^3.1.8",
|
||||
"@push.rocks/smartlog": "^3.1.9",
|
||||
"@push.rocks/smartmongo": "^2.0.12",
|
||||
"@push.rocks/smartpath": "^5.0.18",
|
||||
"@push.rocks/smartnetwork": "^4.4.0",
|
||||
"@push.rocks/smartpath": "^6.0.0",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartrequest": "^2.1.0",
|
||||
"@push.rocks/smarts3": "^2.2.5",
|
||||
"@push.rocks/smartshell": "^3.2.3",
|
||||
"@push.rocks/smartrequest": "^4.3.1",
|
||||
"@push.rocks/smarts3": "^2.2.6",
|
||||
"@push.rocks/smartshell": "^3.3.0",
|
||||
"@push.rocks/smarttime": "^4.1.1",
|
||||
"@types/ws": "^8.18.1",
|
||||
"figures": "^6.1.0",
|
||||
"ws": "^8.18.2"
|
||||
"ws": "^8.18.3"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
|
5947
pnpm-lock.yaml
generated
5947
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
4
pnpm-workspace.yaml
Normal file
4
pnpm-workspace.yaml
Normal file
@@ -0,0 +1,4 @@
|
||||
onlyBuiltDependencies:
|
||||
- esbuild
|
||||
- mongodb-memory-server
|
||||
- puppeteer
|
333
readme.md
333
readme.md
@@ -1,7 +1,7 @@
|
||||
# @git.zone/tstest
|
||||
🧪 **A powerful, modern test runner for TypeScript** - making your test runs beautiful and informative!
|
||||
🧪 **A powerful, modern test runner for TypeScript** - making your test runs beautiful and informative across multiple runtimes!
|
||||
|
||||
## Availabililty and Links
|
||||
## Availability and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@git.zone/tstest)
|
||||
* [code.foss.global (source)](https://code.foss.global/git.zone/tstest)
|
||||
|
||||
@@ -12,10 +12,10 @@
|
||||
### ✨ Key Features
|
||||
|
||||
- 🎯 **Smart Test Execution** - Run all tests, single files, or use glob patterns
|
||||
- 🚀 **Multi-Runtime Support** - Run tests in Node.js, Deno, Bun, and Chromium
|
||||
- 🎨 **Beautiful Output** - Color-coded results with emojis and clean formatting
|
||||
- 📊 **Multiple Output Modes** - Choose from normal, quiet, verbose, or JSON output
|
||||
- 🔍 **Automatic Discovery** - Finds all your test files automatically
|
||||
- 🌐 **Cross-Environment** - Supports Node.js and browser testing
|
||||
- 📝 **Detailed Logging** - Optional file logging for debugging
|
||||
- ⚡ **Performance Metrics** - See which tests are slow
|
||||
- 🤖 **CI/CD Ready** - JSON output mode for automation
|
||||
@@ -26,13 +26,10 @@
|
||||
- ⏳ **Timeout Control** - Set custom timeouts for tests
|
||||
- 🔁 **Retry Logic** - Automatically retry failing tests
|
||||
- 🛠️ **Test Fixtures** - Create reusable test data
|
||||
- 📦 **Browser-Compatible** - Full browser support with embedded tapbundle
|
||||
- 👀 **Watch Mode** - Automatically re-run tests on file changes
|
||||
- 📊 **Real-time Progress** - Live test execution progress updates
|
||||
- 🎨 **Visual Diffs** - Beautiful side-by-side diffs for failed assertions
|
||||
- 🔄 **Event-based Reporting** - Real-time test lifecycle events
|
||||
- ⚙️ **Test Configuration** - Flexible test settings with .tstest.json files
|
||||
- 🚀 **Protocol V2** - Enhanced TAP protocol with Unicode delimiters
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -42,6 +39,154 @@ npm install --save-dev @git.zone/tstest
|
||||
pnpm add -D @git.zone/tstest
|
||||
```
|
||||
|
||||
## Multi-Runtime Architecture
|
||||
|
||||
tstest supports running your tests across multiple JavaScript runtimes, allowing you to verify cross-platform compatibility easily.
|
||||
|
||||
### Supported Runtimes
|
||||
|
||||
- **Node.js** - Default runtime, uses tsrun for TypeScript execution
|
||||
- **Chromium** - Browser environment testing with full DOM support
|
||||
- **Deno** - Secure TypeScript/JavaScript runtime with modern features
|
||||
- **Bun** - Ultra-fast all-in-one JavaScript runtime
|
||||
|
||||
### Test File Naming Convention
|
||||
|
||||
Name your test files with runtime specifiers to control where they run:
|
||||
|
||||
| Pattern | Runtimes | Example |
|
||||
|---------|----------|---------|
|
||||
| `*.ts` | Node.js only (default) | `test.api.ts` |
|
||||
| `*.node.ts` | Node.js only | `test.server.node.ts` |
|
||||
| `*.chromium.ts` | Chromium browser | `test.dom.chromium.ts` |
|
||||
| `*.deno.ts` | Deno runtime | `test.http.deno.ts` |
|
||||
| `*.bun.ts` | Bun runtime | `test.fast.bun.ts` |
|
||||
| `*.all.ts` | All runtimes (Node, Chromium, Deno, Bun) | `test.universal.all.ts` |
|
||||
| `*.node+chromium.ts` | Both Node.js and Chromium | `test.isomorphic.node+chromium.ts` |
|
||||
| `*.node+deno.ts` | Both Node.js and Deno | `test.cross.node+deno.ts` |
|
||||
| `*.deno+bun.ts` | Both Deno and Bun | `test.modern.deno+bun.ts` |
|
||||
| `*.chromium.nonci.ts` | Chromium, skip in CI | `test.visual.chromium.nonci.ts` |
|
||||
| `*.all.nonci.ts` | All runtimes, skip in CI | `test.comprehensive.all.nonci.ts` |
|
||||
|
||||
**Multi-Runtime Examples:**
|
||||
|
||||
```typescript
|
||||
// test.api.all.ts - runs in all runtimes (Node, Chromium, Deno, Bun)
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
tap.test('universal HTTP test', async () => {
|
||||
const response = await fetch('https://api.example.com/test');
|
||||
expect(response.status).toEqual(200);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
```typescript
|
||||
// test.api.node+deno+bun.ts - runs in specific runtimes
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
tap.test('cross-runtime HTTP test', async () => {
|
||||
const response = await fetch('https://api.example.com/test');
|
||||
expect(response.status).toEqual(200);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
### Runtime Execution Order
|
||||
|
||||
When multiple runtimes are specified, tests execute in this order:
|
||||
1. Node.js
|
||||
2. Bun
|
||||
3. Deno
|
||||
4. Chromium
|
||||
|
||||
### Legacy Naming (Deprecated)
|
||||
|
||||
The following patterns are still supported but deprecated. Use the migration tool to update:
|
||||
|
||||
| Legacy Pattern | Modern Equivalent | Migration Command |
|
||||
|----------------|-------------------|-------------------|
|
||||
| `*.browser.ts` | `*.chromium.ts` | `tstest migrate` |
|
||||
| `*.both.ts` | `*.node+chromium.ts` | `tstest migrate` |
|
||||
|
||||
When running legacy files, tstest shows a deprecation warning with the suggested new name.
|
||||
|
||||
### Migration Tool
|
||||
|
||||
Migrate your test files from legacy naming to the new convention:
|
||||
|
||||
```bash
|
||||
# Dry run - see what would change
|
||||
tstest migrate --dry-run
|
||||
|
||||
# Apply migrations (uses git mv to preserve history)
|
||||
tstest migrate --write
|
||||
```
|
||||
|
||||
**Migration Features:**
|
||||
- ✅ Uses `git mv` to preserve file history
|
||||
- ✅ Idempotent - safe to run multiple times
|
||||
- ✅ Dry-run by default for safety
|
||||
- ✅ Colored output showing all changes
|
||||
- ✅ Handles modifiers like `.nonci` correctly
|
||||
|
||||
Example output:
|
||||
```
|
||||
============================================================
|
||||
Test File Migration Tool
|
||||
============================================================
|
||||
|
||||
🔍 DRY RUN MODE - No files will be modified
|
||||
|
||||
Found 3 legacy test file(s)
|
||||
|
||||
Would migrate:
|
||||
test.browser.ts
|
||||
→ test.chromium.ts
|
||||
|
||||
Would migrate:
|
||||
test.both.ts
|
||||
→ test.node+chromium.ts
|
||||
|
||||
Would migrate:
|
||||
test.auth.browser.nonci.ts
|
||||
→ test.auth.chromium.nonci.ts
|
||||
|
||||
============================================================
|
||||
Summary:
|
||||
Total legacy files: 3
|
||||
Successfully migrated: 3
|
||||
Errors: 0
|
||||
============================================================
|
||||
|
||||
To apply these changes, run:
|
||||
tstest migrate --write
|
||||
```
|
||||
|
||||
### Runtime-Specific Permissions
|
||||
|
||||
#### Deno Runtime
|
||||
|
||||
Tests run with these permissions by default:
|
||||
```bash
|
||||
--allow-read
|
||||
--allow-env
|
||||
--allow-net
|
||||
--allow-write
|
||||
--allow-sys
|
||||
--allow-import # Enables npm packages and Node.js built-ins
|
||||
--node-modules-dir # Node.js compatibility mode
|
||||
--sloppy-imports # Allows .js imports to resolve to .ts files
|
||||
```
|
||||
|
||||
Configure custom permissions in your test file or via environment variables.
|
||||
|
||||
#### Bun Runtime
|
||||
|
||||
Bun runs with its native TypeScript support and full access to Node.js APIs.
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Test Execution
|
||||
@@ -92,18 +237,29 @@ tstest "test/unit/*.ts"
|
||||
Pattern: test
|
||||
Found: 4 test file(s)
|
||||
|
||||
▶️ test/test.ts (1/4)
|
||||
Runtime: node.js
|
||||
✅ prepare test (1ms)
|
||||
Summary: 1/1 PASSED
|
||||
━━━ Part 1: Node.js ━━━
|
||||
|
||||
▶️ test/test.node+deno.ts (1/4)
|
||||
Runtime: Node.js
|
||||
✅ HTTP request works (12ms)
|
||||
✅ JSON parsing works (3ms)
|
||||
Summary: 2/2 PASSED in 1.2s
|
||||
|
||||
━━━ Part 2: Deno ━━━
|
||||
|
||||
▶️ test/test.node+deno.ts (1/4)
|
||||
Runtime: Deno
|
||||
✅ HTTP request works (15ms)
|
||||
✅ JSON parsing works (2ms)
|
||||
Summary: 2/2 PASSED in 1.1s
|
||||
|
||||
📊 Test Summary
|
||||
┌────────────────────────────────┐
|
||||
│ Total Files: 4 │
|
||||
│ Total Tests: 4 │
|
||||
│ Passed: 4 │
|
||||
│ Total Tests: 8 │
|
||||
│ Passed: 8 │
|
||||
│ Failed: 0 │
|
||||
│ Duration: 542ms │
|
||||
│ Duration: 2.4s │
|
||||
└────────────────────────────────┘
|
||||
|
||||
ALL TESTS PASSED! 🎉
|
||||
@@ -141,19 +297,7 @@ Perfect for CI/CD pipelines:
|
||||
{"event":"summary","summary":{"totalFiles":4,"totalTests":4,"totalPassed":4,"totalFailed":0,"totalDuration":542}}
|
||||
```
|
||||
|
||||
## Test File Naming Conventions
|
||||
|
||||
tstest supports different test environments through file naming:
|
||||
|
||||
| Pattern | Environment | Example |
|
||||
|---------|-------------|---------|
|
||||
| `*.ts` | Node.js (default) | `test.basic.ts` |
|
||||
| `*.node.ts` | Node.js only | `test.api.node.ts` |
|
||||
| `*.chrome.ts` | Chrome browser | `test.dom.chrome.ts` |
|
||||
| `*.browser.ts` | Browser environment | `test.ui.browser.ts` |
|
||||
| `*.both.ts` | Both Node.js and browser | `test.isomorphic.both.ts` |
|
||||
|
||||
### Writing Tests with tapbundle
|
||||
## Writing Tests with tapbundle
|
||||
|
||||
tstest includes tapbundle, a powerful TAP-based test framework. Import it from the embedded tapbundle:
|
||||
|
||||
@@ -165,7 +309,7 @@ tap.test('my awesome test', async () => {
|
||||
expect(result).toEqual('expected value');
|
||||
});
|
||||
|
||||
tap.start();
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
**Module Exports**
|
||||
@@ -196,7 +340,7 @@ tap.test('async operations', async (tools) => {
|
||||
});
|
||||
|
||||
// Start test execution
|
||||
tap.start();
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
### Test Modifiers and Chaining
|
||||
@@ -231,20 +375,20 @@ tap.timeout(5000)
|
||||
```typescript
|
||||
tap.describe('User Management', () => {
|
||||
let testDatabase;
|
||||
|
||||
|
||||
tap.beforeEach(async () => {
|
||||
testDatabase = await createTestDB();
|
||||
});
|
||||
|
||||
|
||||
tap.afterEach(async () => {
|
||||
await testDatabase.cleanup();
|
||||
});
|
||||
|
||||
|
||||
tap.test('should create user', async () => {
|
||||
const user = await testDatabase.createUser({ name: 'John' });
|
||||
expect(user.id).toBeDefined();
|
||||
});
|
||||
|
||||
|
||||
tap.describe('User Permissions', () => {
|
||||
tap.test('should set admin role', async () => {
|
||||
// Nested describe blocks
|
||||
@@ -262,37 +406,37 @@ tap.test('using test tools', async (tools) => {
|
||||
// Delay utilities
|
||||
await tools.delayFor(1000); // delay for 1000ms
|
||||
await tools.delayForRandom(100, 500); // random delay between 100-500ms
|
||||
|
||||
|
||||
// Skip test conditionally
|
||||
tools.skipIf(process.env.CI === 'true', 'Skipping in CI');
|
||||
|
||||
|
||||
// Skip test unconditionally
|
||||
if (!apiKeyAvailable) {
|
||||
tools.skip('API key not available');
|
||||
}
|
||||
|
||||
|
||||
// Mark as todo
|
||||
tools.todo('Needs implementation');
|
||||
|
||||
|
||||
// Retry configuration
|
||||
tools.retry(3); // Set retry count
|
||||
|
||||
|
||||
// Timeout configuration
|
||||
tools.timeout(10000); // Set timeout to 10s
|
||||
|
||||
|
||||
// Context sharing between tests
|
||||
tools.context.set('userId', 12345);
|
||||
const userId = tools.context.get('userId');
|
||||
|
||||
|
||||
// Deferred promises
|
||||
const deferred = tools.defer();
|
||||
setTimeout(() => deferred.resolve('done'), 100);
|
||||
await deferred.promise;
|
||||
|
||||
|
||||
// Colored console output
|
||||
const coloredString = await tools.coloredString('Success!', 'green');
|
||||
console.log(coloredString);
|
||||
|
||||
|
||||
// Error handling helper
|
||||
const error = await tools.returnError(async () => {
|
||||
throw new Error('Expected error');
|
||||
@@ -306,10 +450,10 @@ tap.test('using test tools', async (tools) => {
|
||||
```typescript
|
||||
tap.test('snapshot test', async (tools) => {
|
||||
const output = generateComplexOutput();
|
||||
|
||||
|
||||
// Compare with saved snapshot
|
||||
await tools.matchSnapshot(output);
|
||||
|
||||
|
||||
// Named snapshots for multiple checks in one test
|
||||
await tools.matchSnapshot(output.header, 'header');
|
||||
await tools.matchSnapshot(output.body, 'body');
|
||||
@@ -339,9 +483,9 @@ tap.defineFixture('testPost', async (data) => ({
|
||||
tap.test('fixture test', async (tools) => {
|
||||
const user = await tools.fixture('testUser', { name: 'John' });
|
||||
const post = await tools.fixture('testPost', { authorId: user.id });
|
||||
|
||||
|
||||
expect(post.authorId).toEqual(user.id);
|
||||
|
||||
|
||||
// Factory pattern for multiple instances
|
||||
const users = await tools.factory('testUser').createMany(5);
|
||||
expect(users).toHaveLength(5);
|
||||
@@ -485,7 +629,7 @@ tap.test('first test', async (tools) => {
|
||||
tap.test('second test', async (tools) => {
|
||||
const sessionId = tools.context.get('sessionId');
|
||||
expect(sessionId).toBeDefined();
|
||||
|
||||
|
||||
// Cleanup
|
||||
tools.context.delete('sessionId');
|
||||
});
|
||||
@@ -506,9 +650,9 @@ tap.test('DOM manipulation', async () => {
|
||||
<button id="test-btn">Click Me</button>
|
||||
</div>
|
||||
`);
|
||||
|
||||
|
||||
expect(element.querySelector('h1').textContent).toEqual('Test Title');
|
||||
|
||||
|
||||
// Simulate interactions
|
||||
const button = element.querySelector('#test-btn');
|
||||
button.click();
|
||||
@@ -521,7 +665,7 @@ tap.test('CSS testing', async () => {
|
||||
font-size: 16px;
|
||||
}
|
||||
`;
|
||||
|
||||
|
||||
// styles is a string that can be injected into the page
|
||||
expect(styles).toInclude('color: red');
|
||||
});
|
||||
@@ -535,7 +679,7 @@ tap.test('error handling', async (tools) => {
|
||||
const error = await tools.returnError(async () => {
|
||||
await functionThatThrows();
|
||||
});
|
||||
|
||||
|
||||
expect(error).toBeInstanceOf(Error);
|
||||
expect(error.message).toEqual('Expected error message');
|
||||
});
|
||||
@@ -612,7 +756,7 @@ When assertions fail, tstest shows beautiful side-by-side diffs:
|
||||
String Diff:
|
||||
- Expected
|
||||
+ Received
|
||||
|
||||
|
||||
- Hello World
|
||||
+ Hello Universe
|
||||
|
||||
@@ -625,73 +769,6 @@ When assertions fail, tstest shows beautiful side-by-side diffs:
|
||||
}
|
||||
```
|
||||
|
||||
### Test Configuration (.tstest.json)
|
||||
|
||||
Configure test behavior with `.tstest.json` files:
|
||||
|
||||
```json
|
||||
{
|
||||
"timeout": 30000,
|
||||
"retries": 2,
|
||||
"bail": false,
|
||||
"parallel": true,
|
||||
"tags": ["unit", "fast"],
|
||||
"env": {
|
||||
"NODE_ENV": "test"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Configuration files are discovered in:
|
||||
1. Test file directory
|
||||
2. Parent directories (up to project root)
|
||||
3. Project root
|
||||
4. Home directory (`~/.tstest.json`)
|
||||
|
||||
Settings cascade and merge, with closer files taking precedence.
|
||||
|
||||
### Event-based Test Reporting
|
||||
|
||||
tstest emits detailed events during test execution for integration with CI/CD tools:
|
||||
|
||||
```json
|
||||
{"event":"suite:started","file":"test/api.test.ts","timestamp":"2025-05-26T10:30:00.000Z"}
|
||||
{"event":"test:started","name":"api endpoint validation","timestamp":"2025-05-26T10:30:00.100Z"}
|
||||
{"event":"test:progress","name":"api endpoint validation","message":"Validating response schema"}
|
||||
{"event":"test:completed","name":"api endpoint validation","passed":true,"duration":145}
|
||||
{"event":"suite:completed","file":"test/api.test.ts","passed":true,"total":2,"failed":0}
|
||||
```
|
||||
|
||||
### Enhanced TAP Protocol (Protocol V2)
|
||||
|
||||
tstest uses an enhanced TAP protocol with Unicode delimiters for better parsing:
|
||||
|
||||
```
|
||||
⟦TSTEST:EVENT:test:started⟧{"name":"my test","timestamp":"2025-05-26T10:30:00.000Z"}
|
||||
ok 1 my test
|
||||
⟦TSTEST:EVENT:test:completed⟧{"name":"my test","passed":true,"duration":145}
|
||||
```
|
||||
|
||||
This prevents conflicts with test output that might contain TAP-like formatting.
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Glob Pattern Support
|
||||
|
||||
Run specific test patterns:
|
||||
```bash
|
||||
# Run all unit tests
|
||||
tstest "test/unit/**/*.ts"
|
||||
|
||||
# Run all integration tests
|
||||
tstest "test/integration/*.test.ts"
|
||||
|
||||
# Run multiple patterns
|
||||
tstest "test/**/*.spec.ts" "test/**/*.test.ts"
|
||||
```
|
||||
|
||||
**Important**: Always quote glob patterns to prevent shell expansion. Without quotes, the shell will expand the pattern and only pass the first matching file to tstest.
|
||||
|
||||
### Enhanced Test Logging
|
||||
|
||||
The `--logfile` option provides intelligent test logging with automatic organization:
|
||||
@@ -849,6 +926,18 @@ tstest test/api/endpoints.test.ts --verbose --timeout 60
|
||||
|
||||
## Changelog
|
||||
|
||||
### Version 2.4.0
|
||||
- 🚀 **Multi-Runtime Architecture** - Support for Deno, Bun, Node.js, and Chromium
|
||||
- 🔀 **New Naming Convention** - Flexible `.runtime1+runtime2.ts` pattern
|
||||
- 🌐 **Universal Testing** - `.all.ts` pattern runs tests on all supported runtimes
|
||||
- 🔄 **Migration Tool** - Easy migration from legacy naming (`.browser.ts`, `.both.ts`)
|
||||
- 🦕 **Deno Support** - Full Deno runtime with Node.js compatibility
|
||||
- 🐰 **Bun Support** - Ultra-fast Bun runtime integration
|
||||
- ⚡ **Dynamic Port Selection** - Random port allocation (30000-40000) prevents conflicts
|
||||
- 🏗️ **Runtime Adapter Pattern** - Extensible architecture for adding new runtimes
|
||||
- 📝 **Deprecation Warnings** - Helpful migration suggestions for legacy naming
|
||||
- ✅ **Comprehensive Tests** - Full test coverage for parser and migration tool
|
||||
|
||||
### Version 1.11.0
|
||||
- 👀 Added Watch Mode with `--watch`/`-w` flag for automatic test re-runs
|
||||
- 📊 Implemented real-time test progress updates with event streaming
|
||||
@@ -878,7 +967,7 @@ tstest test/api/endpoints.test.ts --verbose --timeout 60
|
||||
- 📝 Improved internal protocol design documentation
|
||||
- 🔧 Added protocol v2 utilities for future improvements
|
||||
|
||||
### Version 1.9.1
|
||||
### Version 1.9.1
|
||||
- 🐛 Fixed log file naming to preserve directory structure
|
||||
- 📁 Log files now prevent collisions: `test__dir__file.log`
|
||||
|
||||
@@ -901,7 +990,7 @@ tstest test/api/endpoints.test.ts --verbose --timeout 60
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license.md) file within this repository.
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
@@ -911,9 +1000,9 @@ This project is owned and maintained by Task Venture Capital GmbH. The names and
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
111
test/test.migration.node.ts
Normal file
111
test/test.migration.node.ts
Normal file
@@ -0,0 +1,111 @@
|
||||
import { expect, tap } from '../ts_tapbundle/index.js';
|
||||
import { Migration } from '../ts/tstest.classes.migration.js';
|
||||
import * as plugins from '../ts/tstest.plugins.js';
|
||||
import * as paths from '../ts/tstest.paths.js';
|
||||
|
||||
tap.test('Migration - can initialize', async () => {
|
||||
const migration = new Migration({
|
||||
baseDir: process.cwd(),
|
||||
dryRun: true,
|
||||
});
|
||||
|
||||
expect(migration).toBeInstanceOf(Migration);
|
||||
});
|
||||
|
||||
tap.test('Migration - findLegacyFiles returns empty for no legacy files', async () => {
|
||||
const migration = new Migration({
|
||||
baseDir: process.cwd(),
|
||||
pattern: 'test/test.migration.node.ts', // This file itself, not legacy
|
||||
dryRun: true,
|
||||
});
|
||||
|
||||
const legacyFiles = await migration.findLegacyFiles();
|
||||
expect(legacyFiles).toEqual([]);
|
||||
});
|
||||
|
||||
tap.test('Migration - generateReport works', async () => {
|
||||
const migration = new Migration({
|
||||
baseDir: process.cwd(),
|
||||
dryRun: true,
|
||||
});
|
||||
|
||||
const report = await migration.generateReport();
|
||||
expect(report).toBeTypeOf('string');
|
||||
expect(report).toContain('Test File Migration Report');
|
||||
});
|
||||
|
||||
tap.test('Migration - detects legacy files when they exist', async () => {
|
||||
// Create a temporary legacy test file
|
||||
const tempDir = plugins.path.join(process.cwd(), '.nogit', 'test_migration');
|
||||
await plugins.smartfile.fs.ensureEmptyDir(tempDir);
|
||||
|
||||
const legacyFile = plugins.path.join(tempDir, 'test.browser.ts');
|
||||
await plugins.smartfile.memory.toFs('// Legacy test file\nexport default Promise.resolve();', legacyFile);
|
||||
|
||||
const migration = new Migration({
|
||||
baseDir: tempDir,
|
||||
pattern: '**/*.ts',
|
||||
dryRun: true,
|
||||
});
|
||||
|
||||
const legacyFiles = await migration.findLegacyFiles();
|
||||
expect(legacyFiles.length).toEqual(1);
|
||||
expect(legacyFiles[0]).toContain('test.browser.ts');
|
||||
|
||||
// Clean up
|
||||
await plugins.smartfile.fs.removeSync(tempDir);
|
||||
});
|
||||
|
||||
tap.test('Migration - detects both legacy pattern', async () => {
|
||||
// Create temporary legacy files
|
||||
const tempDir = plugins.path.join(process.cwd(), '.nogit', 'test_migration_both');
|
||||
await plugins.smartfile.fs.ensureEmptyDir(tempDir);
|
||||
|
||||
const browserFile = plugins.path.join(tempDir, 'test.browser.ts');
|
||||
const bothFile = plugins.path.join(tempDir, 'test.both.ts');
|
||||
await plugins.smartfile.memory.toFs('// Browser test\nexport default Promise.resolve();', browserFile);
|
||||
await plugins.smartfile.memory.toFs('// Both test\nexport default Promise.resolve();', bothFile);
|
||||
|
||||
const migration = new Migration({
|
||||
baseDir: tempDir,
|
||||
pattern: '**/*.ts',
|
||||
dryRun: true,
|
||||
});
|
||||
|
||||
const legacyFiles = await migration.findLegacyFiles();
|
||||
expect(legacyFiles.length).toEqual(2);
|
||||
|
||||
// Clean up
|
||||
await plugins.smartfile.fs.removeSync(tempDir);
|
||||
});
|
||||
|
||||
tap.test('Migration - dry run does not modify files', async () => {
|
||||
// Create a temporary legacy test file
|
||||
const tempDir = plugins.path.join(process.cwd(), '.nogit', 'test_migration_dryrun');
|
||||
await plugins.smartfile.fs.ensureEmptyDir(tempDir);
|
||||
|
||||
const legacyFile = plugins.path.join(tempDir, 'test.browser.ts');
|
||||
await plugins.smartfile.memory.toFs('// Legacy test file\nexport default Promise.resolve();', legacyFile);
|
||||
|
||||
const migration = new Migration({
|
||||
baseDir: tempDir,
|
||||
pattern: '**/*.ts',
|
||||
dryRun: true,
|
||||
verbose: false,
|
||||
});
|
||||
|
||||
const summary = await migration.run();
|
||||
|
||||
expect(summary.dryRun).toEqual(true);
|
||||
expect(summary.totalLegacyFiles).toEqual(1);
|
||||
expect(summary.migratedCount).toEqual(1); // Dry run still counts as "would migrate"
|
||||
|
||||
// Verify original file still exists
|
||||
const fileExists = await plugins.smartfile.fs.fileExists(legacyFile);
|
||||
expect(fileExists).toEqual(true);
|
||||
|
||||
// Clean up
|
||||
await plugins.smartfile.fs.removeSync(tempDir);
|
||||
});
|
||||
|
||||
export default tap.start();
|
203
test/test.runtime.parser.node.ts
Normal file
203
test/test.runtime.parser.node.ts
Normal file
@@ -0,0 +1,203 @@
|
||||
import { expect, tap } from '../ts_tapbundle/index.js';
|
||||
import { parseTestFilename, isLegacyFilename, getLegacyMigrationTarget } from '../ts/tstest.classes.runtime.parser.js';
|
||||
|
||||
tap.test('parseTestFilename - single runtime', async () => {
|
||||
const parsed = parseTestFilename('test.node.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - chromium runtime', async () => {
|
||||
const parsed = parseTestFilename('test.chromium.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['chromium']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - multiple runtimes', async () => {
|
||||
const parsed = parseTestFilename('test.node+chromium.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node', 'chromium']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - deno+bun runtime', async () => {
|
||||
const parsed = parseTestFilename('test.deno+bun.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['deno', 'bun']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - with nonci modifier', async () => {
|
||||
const parsed = parseTestFilename('test.chromium.nonci.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['chromium']);
|
||||
expect(parsed.modifiers).toEqual(['nonci']);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - multi-runtime with nonci', async () => {
|
||||
const parsed = parseTestFilename('test.node+chromium.nonci.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node', 'chromium']);
|
||||
expect(parsed.modifiers).toEqual(['nonci']);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - legacy browser', async () => {
|
||||
const parsed = parseTestFilename('test.browser.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['chromium']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(true);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - legacy both', async () => {
|
||||
const parsed = parseTestFilename('test.both.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node', 'chromium']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(true);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - legacy browser with nonci', async () => {
|
||||
const parsed = parseTestFilename('test.browser.nonci.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['chromium']);
|
||||
expect(parsed.modifiers).toEqual(['nonci']);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(true);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - complex basename', async () => {
|
||||
const parsed = parseTestFilename('test.some.feature.node.ts');
|
||||
expect(parsed.baseName).toEqual('test.some.feature');
|
||||
expect(parsed.runtimes).toEqual(['node']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - default to node when no runtime', async () => {
|
||||
const parsed = parseTestFilename('test.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - tsx extension', async () => {
|
||||
const parsed = parseTestFilename('test.chromium.tsx');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['chromium']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('tsx');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - deduplicates runtime tokens', async () => {
|
||||
const parsed = parseTestFilename('test.node+node.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('isLegacyFilename - detects browser', async () => {
|
||||
expect(isLegacyFilename('test.browser.ts')).toEqual(true);
|
||||
});
|
||||
|
||||
tap.test('isLegacyFilename - detects both', async () => {
|
||||
expect(isLegacyFilename('test.both.ts')).toEqual(true);
|
||||
});
|
||||
|
||||
tap.test('isLegacyFilename - rejects new naming', async () => {
|
||||
expect(isLegacyFilename('test.node.ts')).toEqual(false);
|
||||
expect(isLegacyFilename('test.chromium.ts')).toEqual(false);
|
||||
expect(isLegacyFilename('test.node+chromium.ts')).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('getLegacyMigrationTarget - browser to chromium', async () => {
|
||||
const target = getLegacyMigrationTarget('test.browser.ts');
|
||||
expect(target).toEqual('test.chromium.ts');
|
||||
});
|
||||
|
||||
tap.test('getLegacyMigrationTarget - both to node+chromium', async () => {
|
||||
const target = getLegacyMigrationTarget('test.both.ts');
|
||||
expect(target).toEqual('test.node+chromium.ts');
|
||||
});
|
||||
|
||||
tap.test('getLegacyMigrationTarget - browser with nonci', async () => {
|
||||
const target = getLegacyMigrationTarget('test.browser.nonci.ts');
|
||||
expect(target).toEqual('test.chromium.nonci.ts');
|
||||
});
|
||||
|
||||
tap.test('getLegacyMigrationTarget - both with nonci', async () => {
|
||||
const target = getLegacyMigrationTarget('test.both.nonci.ts');
|
||||
expect(target).toEqual('test.node+chromium.nonci.ts');
|
||||
});
|
||||
|
||||
tap.test('getLegacyMigrationTarget - returns null for non-legacy', async () => {
|
||||
const target = getLegacyMigrationTarget('test.node.ts');
|
||||
expect(target).toEqual(null);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - handles full paths', async () => {
|
||||
const parsed = parseTestFilename('/path/to/test.node+chromium.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node', 'chromium']);
|
||||
expect(parsed.original).toEqual('test.node+chromium.ts');
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - all keyword expands to all runtimes', async () => {
|
||||
const parsed = parseTestFilename('test.all.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node', 'chromium', 'deno', 'bun']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - all keyword with nonci modifier', async () => {
|
||||
const parsed = parseTestFilename('test.all.nonci.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node', 'chromium', 'deno', 'bun']);
|
||||
expect(parsed.modifiers).toEqual(['nonci']);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - all keyword with complex basename', async () => {
|
||||
const parsed = parseTestFilename('test.some.feature.all.ts');
|
||||
expect(parsed.baseName).toEqual('test.some.feature');
|
||||
expect(parsed.runtimes).toEqual(['node', 'chromium', 'deno', 'bun']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
tap.test('parseTestFilename - all keyword in chain expands to all runtimes', async () => {
|
||||
const parsed = parseTestFilename('test.node+all.ts');
|
||||
expect(parsed.baseName).toEqual('test');
|
||||
expect(parsed.runtimes).toEqual(['node', 'chromium', 'deno', 'bun']);
|
||||
expect(parsed.modifiers).toEqual([]);
|
||||
expect(parsed.extension).toEqual('ts');
|
||||
expect(parsed.isLegacy).toEqual(false);
|
||||
});
|
||||
|
||||
export default tap.start();
|
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@git.zone/tstest',
|
||||
version: '2.2.5',
|
||||
version: '2.5.0',
|
||||
description: 'a test utility to run tests that match test/**/*.ts'
|
||||
}
|
||||
|
47
ts/index.ts
47
ts/index.ts
@@ -8,6 +8,40 @@ export enum TestExecutionMode {
|
||||
}
|
||||
|
||||
export const runCli = async () => {
|
||||
// Check if we're using global tstest in the tstest project itself
|
||||
try {
|
||||
const packageJsonPath = `${process.cwd()}/package.json`;
|
||||
const fs = await import('fs');
|
||||
if (fs.existsSync(packageJsonPath)) {
|
||||
const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
|
||||
if (packageJson.name === '@git.zone/tstest') {
|
||||
// Check if we're running from a global installation
|
||||
const execPath = process.argv[1];
|
||||
// Debug: log the paths (uncomment for debugging)
|
||||
// console.log('DEBUG: Checking global tstest usage...');
|
||||
// console.log('execPath:', execPath);
|
||||
// console.log('cwd:', process.cwd());
|
||||
// console.log('process.argv:', process.argv);
|
||||
|
||||
// Check if this is running from global installation
|
||||
const isLocalCli = execPath.includes(process.cwd());
|
||||
const isGlobalPnpm = process.argv.some(arg => arg.includes('.pnpm') && !arg.includes(process.cwd()));
|
||||
const isGlobalNpm = process.argv.some(arg => arg.includes('npm/node_modules') && !arg.includes(process.cwd()));
|
||||
|
||||
if (!isLocalCli && (isGlobalPnpm || isGlobalNpm || !execPath.includes('node_modules'))) {
|
||||
console.error('\n⚠️ WARNING: You are using a globally installed tstest in the tstest project itself!');
|
||||
console.error(' This means you are NOT testing your local changes.');
|
||||
console.error(' Please use one of these commands instead:');
|
||||
console.error(' • node cli.js <test-path>');
|
||||
console.error(' • pnpm test <test-path>');
|
||||
console.error(' • ./cli.js <test-path> (if executable)\n');
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
// Silently ignore any errors in this check
|
||||
}
|
||||
|
||||
// Parse command line arguments
|
||||
const args = process.argv.slice(2);
|
||||
const logOptions: LogOptions = {};
|
||||
@@ -24,6 +58,18 @@ export const runCli = async () => {
|
||||
const arg = args[i];
|
||||
|
||||
switch (arg) {
|
||||
case '--version':
|
||||
// Get version from package.json
|
||||
try {
|
||||
const fs = await import('fs');
|
||||
const packagePath = new URL('../package.json', import.meta.url).pathname;
|
||||
const packageData = JSON.parse(await fs.promises.readFile(packagePath, 'utf8'));
|
||||
console.log(`tstest version ${packageData.version}`);
|
||||
} catch (error) {
|
||||
console.log('tstest version unknown');
|
||||
}
|
||||
process.exit(0);
|
||||
break;
|
||||
case '--quiet':
|
||||
case '-q':
|
||||
logOptions.quiet = true;
|
||||
@@ -115,6 +161,7 @@ export const runCli = async () => {
|
||||
console.error('You must specify a test directory/file/pattern as argument. Please try again.');
|
||||
console.error('\nUsage: tstest <path> [options]');
|
||||
console.error('\nOptions:');
|
||||
console.error(' --version Show version information');
|
||||
console.error(' --quiet, -q Minimal output');
|
||||
console.error(' --verbose, -v Verbose output');
|
||||
console.error(' --no-color Disable colored output');
|
||||
|
316
ts/tstest.classes.migration.ts
Normal file
316
ts/tstest.classes.migration.ts
Normal file
@@ -0,0 +1,316 @@
|
||||
import * as plugins from './tstest.plugins.js';
|
||||
import { coloredString as cs } from '@push.rocks/consolecolor';
|
||||
import { parseTestFilename, getLegacyMigrationTarget, isLegacyFilename } from './tstest.classes.runtime.parser.js';
|
||||
|
||||
/**
|
||||
* Migration result for a single file
|
||||
*/
|
||||
export interface MigrationResult {
|
||||
/**
|
||||
* Original file path
|
||||
*/
|
||||
oldPath: string;
|
||||
|
||||
/**
|
||||
* New file path after migration
|
||||
*/
|
||||
newPath: string;
|
||||
|
||||
/**
|
||||
* Whether the migration was performed
|
||||
*/
|
||||
migrated: boolean;
|
||||
|
||||
/**
|
||||
* Error message if migration failed
|
||||
*/
|
||||
error?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Migration summary
|
||||
*/
|
||||
export interface MigrationSummary {
|
||||
/**
|
||||
* Total number of legacy files found
|
||||
*/
|
||||
totalLegacyFiles: number;
|
||||
|
||||
/**
|
||||
* Number of files successfully migrated
|
||||
*/
|
||||
migratedCount: number;
|
||||
|
||||
/**
|
||||
* Number of files that failed to migrate
|
||||
*/
|
||||
errorCount: number;
|
||||
|
||||
/**
|
||||
* Individual migration results
|
||||
*/
|
||||
results: MigrationResult[];
|
||||
|
||||
/**
|
||||
* Whether this was a dry run
|
||||
*/
|
||||
dryRun: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Migration options
|
||||
*/
|
||||
export interface MigrationOptions {
|
||||
/**
|
||||
* Base directory to search for test files
|
||||
* Default: process.cwd()
|
||||
*/
|
||||
baseDir?: string;
|
||||
|
||||
/**
|
||||
* Glob pattern for finding test files
|
||||
* Default: '** /*test*.ts' (without space)
|
||||
*/
|
||||
pattern?: string;
|
||||
|
||||
/**
|
||||
* Dry run mode - don't actually rename files
|
||||
* Default: true
|
||||
*/
|
||||
dryRun?: boolean;
|
||||
|
||||
/**
|
||||
* Verbose output
|
||||
* Default: false
|
||||
*/
|
||||
verbose?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Migration class for renaming legacy test files to new naming convention
|
||||
*
|
||||
* Migrations:
|
||||
* - .browser.ts → .chromium.ts
|
||||
* - .both.ts → .node+chromium.ts
|
||||
* - .both.nonci.ts → .node+chromium.nonci.ts
|
||||
* - .browser.nonci.ts → .chromium.nonci.ts
|
||||
*/
|
||||
export class Migration {
|
||||
private options: Required<MigrationOptions>;
|
||||
|
||||
constructor(options: MigrationOptions = {}) {
|
||||
this.options = {
|
||||
baseDir: options.baseDir || process.cwd(),
|
||||
pattern: options.pattern || '**/test*.ts',
|
||||
dryRun: options.dryRun !== undefined ? options.dryRun : true,
|
||||
verbose: options.verbose || false,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Find all legacy test files in the base directory
|
||||
*/
|
||||
async findLegacyFiles(): Promise<string[]> {
|
||||
const files = await plugins.smartfile.fs.listFileTree(
|
||||
this.options.baseDir,
|
||||
this.options.pattern
|
||||
);
|
||||
|
||||
const legacyFiles: string[] = [];
|
||||
|
||||
for (const file of files) {
|
||||
const fileName = plugins.path.basename(file);
|
||||
if (isLegacyFilename(fileName)) {
|
||||
const absolutePath = plugins.path.isAbsolute(file)
|
||||
? file
|
||||
: plugins.path.join(this.options.baseDir, file);
|
||||
legacyFiles.push(absolutePath);
|
||||
}
|
||||
}
|
||||
|
||||
return legacyFiles;
|
||||
}
|
||||
|
||||
/**
|
||||
* Migrate a single file
|
||||
*/
|
||||
private async migrateFile(filePath: string): Promise<MigrationResult> {
|
||||
const fileName = plugins.path.basename(filePath);
|
||||
const dirName = plugins.path.dirname(filePath);
|
||||
|
||||
try {
|
||||
// Get the new filename
|
||||
const newFileName = getLegacyMigrationTarget(fileName);
|
||||
|
||||
if (!newFileName) {
|
||||
return {
|
||||
oldPath: filePath,
|
||||
newPath: filePath,
|
||||
migrated: false,
|
||||
error: 'File is not a legacy file',
|
||||
};
|
||||
}
|
||||
|
||||
const newPath = plugins.path.join(dirName, newFileName);
|
||||
|
||||
// Check if target file already exists
|
||||
if (await plugins.smartfile.fs.fileExists(newPath)) {
|
||||
return {
|
||||
oldPath: filePath,
|
||||
newPath,
|
||||
migrated: false,
|
||||
error: `Target file already exists: ${newPath}`,
|
||||
};
|
||||
}
|
||||
|
||||
if (!this.options.dryRun) {
|
||||
// Check if we're in a git repository
|
||||
const isGitRepo = await this.isGitRepository(this.options.baseDir);
|
||||
|
||||
if (isGitRepo) {
|
||||
// Use git mv to preserve history
|
||||
const smartshell = new plugins.smartshell.Smartshell({
|
||||
executor: 'bash',
|
||||
pathDirectories: [],
|
||||
});
|
||||
const gitCommand = `cd "${this.options.baseDir}" && git mv "${filePath}" "${newPath}"`;
|
||||
const result = await smartshell.exec(gitCommand);
|
||||
|
||||
if (result.exitCode !== 0) {
|
||||
throw new Error(`git mv failed: ${result.stderr}`);
|
||||
}
|
||||
} else {
|
||||
// Not a git repository - cannot migrate without git
|
||||
throw new Error('Migration requires a git repository. We have git!');
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
oldPath: filePath,
|
||||
newPath,
|
||||
migrated: true,
|
||||
};
|
||||
} catch (error) {
|
||||
return {
|
||||
oldPath: filePath,
|
||||
newPath: filePath,
|
||||
migrated: false,
|
||||
error: error.message,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a directory is a git repository
|
||||
*/
|
||||
private async isGitRepository(dir: string): Promise<boolean> {
|
||||
try {
|
||||
const gitDir = plugins.path.join(dir, '.git');
|
||||
return await plugins.smartfile.fs.isDirectory(gitDir);
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Run the migration
|
||||
*/
|
||||
async run(): Promise<MigrationSummary> {
|
||||
const legacyFiles = await this.findLegacyFiles();
|
||||
|
||||
console.log('');
|
||||
console.log(cs('='.repeat(60), 'blue'));
|
||||
console.log(cs('Test File Migration Tool', 'blue'));
|
||||
console.log(cs('='.repeat(60), 'blue'));
|
||||
console.log('');
|
||||
|
||||
if (this.options.dryRun) {
|
||||
console.log(cs('🔍 DRY RUN MODE - No files will be modified', 'orange'));
|
||||
console.log('');
|
||||
}
|
||||
|
||||
console.log(`Found ${legacyFiles.length} legacy test file(s)`);
|
||||
console.log('');
|
||||
|
||||
const results: MigrationResult[] = [];
|
||||
let migratedCount = 0;
|
||||
let errorCount = 0;
|
||||
|
||||
for (const file of legacyFiles) {
|
||||
const result = await this.migrateFile(file);
|
||||
results.push(result);
|
||||
|
||||
if (result.migrated) {
|
||||
migratedCount++;
|
||||
const oldName = plugins.path.basename(result.oldPath);
|
||||
const newName = plugins.path.basename(result.newPath);
|
||||
|
||||
if (this.options.dryRun) {
|
||||
console.log(cs(` Would migrate:`, 'cyan'));
|
||||
} else {
|
||||
console.log(cs(` ✓ Migrated:`, 'green'));
|
||||
}
|
||||
console.log(` ${oldName}`);
|
||||
console.log(cs(` → ${newName}`, 'green'));
|
||||
console.log('');
|
||||
} else if (result.error) {
|
||||
errorCount++;
|
||||
console.log(cs(` ✗ Failed: ${plugins.path.basename(result.oldPath)}`, 'red'));
|
||||
console.log(cs(` ${result.error}`, 'red'));
|
||||
console.log('');
|
||||
}
|
||||
}
|
||||
|
||||
console.log(cs('='.repeat(60), 'blue'));
|
||||
console.log(`Summary:`);
|
||||
console.log(` Total legacy files: ${legacyFiles.length}`);
|
||||
console.log(` Successfully migrated: ${migratedCount}`);
|
||||
console.log(` Errors: ${errorCount}`);
|
||||
console.log(cs('='.repeat(60), 'blue'));
|
||||
|
||||
if (this.options.dryRun && legacyFiles.length > 0) {
|
||||
console.log('');
|
||||
console.log(cs('To apply these changes, run:', 'orange'));
|
||||
console.log(cs(' tstest migrate --write', 'orange'));
|
||||
}
|
||||
|
||||
console.log('');
|
||||
|
||||
return {
|
||||
totalLegacyFiles: legacyFiles.length,
|
||||
migratedCount,
|
||||
errorCount,
|
||||
results,
|
||||
dryRun: this.options.dryRun,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a migration report without performing the migration
|
||||
*/
|
||||
async generateReport(): Promise<string> {
|
||||
const legacyFiles = await this.findLegacyFiles();
|
||||
|
||||
let report = '';
|
||||
report += 'Test File Migration Report\n';
|
||||
report += '='.repeat(60) + '\n';
|
||||
report += '\n';
|
||||
report += `Found ${legacyFiles.length} legacy test file(s)\n`;
|
||||
report += '\n';
|
||||
|
||||
for (const file of legacyFiles) {
|
||||
const fileName = plugins.path.basename(file);
|
||||
const newFileName = getLegacyMigrationTarget(fileName);
|
||||
|
||||
if (newFileName) {
|
||||
report += `${fileName}\n`;
|
||||
report += ` → ${newFileName}\n`;
|
||||
report += '\n';
|
||||
}
|
||||
}
|
||||
|
||||
report += '='.repeat(60) + '\n';
|
||||
|
||||
return report;
|
||||
}
|
||||
}
|
245
ts/tstest.classes.runtime.adapter.ts
Normal file
245
ts/tstest.classes.runtime.adapter.ts
Normal file
@@ -0,0 +1,245 @@
|
||||
import * as plugins from './tstest.plugins.js';
|
||||
import type { Runtime } from './tstest.classes.runtime.parser.js';
|
||||
import { TapParser } from './tstest.classes.tap.parser.js';
|
||||
|
||||
/**
|
||||
* Runtime-specific configuration options
|
||||
*/
|
||||
export interface RuntimeOptions {
|
||||
/**
|
||||
* Environment variables to pass to the runtime
|
||||
*/
|
||||
env?: Record<string, string>;
|
||||
|
||||
/**
|
||||
* Additional command-line arguments
|
||||
*/
|
||||
extraArgs?: string[];
|
||||
|
||||
/**
|
||||
* Working directory for test execution
|
||||
*/
|
||||
cwd?: string;
|
||||
|
||||
/**
|
||||
* Timeout in milliseconds (0 = no timeout)
|
||||
*/
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deno-specific configuration options
|
||||
*/
|
||||
export interface DenoOptions extends RuntimeOptions {
|
||||
/**
|
||||
* Permissions to grant to Deno
|
||||
* Default: ['--allow-read', '--allow-env']
|
||||
*/
|
||||
permissions?: string[];
|
||||
|
||||
/**
|
||||
* Path to deno.json config file
|
||||
*/
|
||||
configPath?: string;
|
||||
|
||||
/**
|
||||
* Path to import map file
|
||||
*/
|
||||
importMap?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Chromium-specific configuration options
|
||||
*/
|
||||
export interface ChromiumOptions extends RuntimeOptions {
|
||||
/**
|
||||
* Chromium launch arguments
|
||||
*/
|
||||
launchArgs?: string[];
|
||||
|
||||
/**
|
||||
* Headless mode (default: true)
|
||||
*/
|
||||
headless?: boolean;
|
||||
|
||||
/**
|
||||
* Port range for HTTP server
|
||||
*/
|
||||
portRange?: { min: number; max: number };
|
||||
}
|
||||
|
||||
/**
|
||||
* Command configuration returned by createCommand()
|
||||
*/
|
||||
export interface RuntimeCommand {
|
||||
/**
|
||||
* The main command executable (e.g., 'node', 'deno', 'bun')
|
||||
*/
|
||||
command: string;
|
||||
|
||||
/**
|
||||
* Command-line arguments
|
||||
*/
|
||||
args: string[];
|
||||
|
||||
/**
|
||||
* Environment variables
|
||||
*/
|
||||
env?: Record<string, string>;
|
||||
|
||||
/**
|
||||
* Working directory
|
||||
*/
|
||||
cwd?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runtime availability check result
|
||||
*/
|
||||
export interface RuntimeAvailability {
|
||||
/**
|
||||
* Whether the runtime is available
|
||||
*/
|
||||
available: boolean;
|
||||
|
||||
/**
|
||||
* Version string if available
|
||||
*/
|
||||
version?: string;
|
||||
|
||||
/**
|
||||
* Error message if not available
|
||||
*/
|
||||
error?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Abstract base class for runtime adapters
|
||||
* Each runtime (Node, Chromium, Deno, Bun) implements this interface
|
||||
*/
|
||||
export abstract class RuntimeAdapter {
|
||||
/**
|
||||
* Runtime identifier
|
||||
*/
|
||||
abstract readonly id: Runtime;
|
||||
|
||||
/**
|
||||
* Human-readable display name
|
||||
*/
|
||||
abstract readonly displayName: string;
|
||||
|
||||
/**
|
||||
* Check if this runtime is available on the system
|
||||
* @returns Availability information including version
|
||||
*/
|
||||
abstract checkAvailable(): Promise<RuntimeAvailability>;
|
||||
|
||||
/**
|
||||
* Create the command configuration for executing a test
|
||||
* @param testFile - Absolute path to the test file
|
||||
* @param options - Runtime-specific options
|
||||
* @returns Command configuration
|
||||
*/
|
||||
abstract createCommand(testFile: string, options?: RuntimeOptions): RuntimeCommand;
|
||||
|
||||
/**
|
||||
* Execute a test file and return a TAP parser
|
||||
* @param testFile - Absolute path to the test file
|
||||
* @param index - Test index (for display)
|
||||
* @param total - Total number of tests (for display)
|
||||
* @param options - Runtime-specific options
|
||||
* @returns TAP parser with test results
|
||||
*/
|
||||
abstract run(
|
||||
testFile: string,
|
||||
index: number,
|
||||
total: number,
|
||||
options?: RuntimeOptions
|
||||
): Promise<TapParser>;
|
||||
|
||||
/**
|
||||
* Get the default options for this runtime
|
||||
* Can be overridden by subclasses
|
||||
*/
|
||||
protected getDefaultOptions(): RuntimeOptions {
|
||||
return {
|
||||
timeout: 0,
|
||||
extraArgs: [],
|
||||
env: {},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge user options with defaults
|
||||
*/
|
||||
protected mergeOptions<T extends RuntimeOptions>(userOptions?: T): T {
|
||||
const defaults = this.getDefaultOptions();
|
||||
return {
|
||||
...defaults,
|
||||
...userOptions,
|
||||
env: { ...defaults.env, ...userOptions?.env },
|
||||
extraArgs: [...(defaults.extraArgs || []), ...(userOptions?.extraArgs || [])],
|
||||
} as T;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Registry for runtime adapters
|
||||
* Manages all available runtime implementations
|
||||
*/
|
||||
export class RuntimeAdapterRegistry {
|
||||
private adapters: Map<Runtime, RuntimeAdapter> = new Map();
|
||||
|
||||
/**
|
||||
* Register a runtime adapter
|
||||
*/
|
||||
register(adapter: RuntimeAdapter): void {
|
||||
this.adapters.set(adapter.id, adapter);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an adapter by runtime ID
|
||||
*/
|
||||
get(runtime: Runtime): RuntimeAdapter | undefined {
|
||||
return this.adapters.get(runtime);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all registered adapters
|
||||
*/
|
||||
getAll(): RuntimeAdapter[] {
|
||||
return Array.from(this.adapters.values());
|
||||
}
|
||||
|
||||
/**
|
||||
* Check which runtimes are available on the system
|
||||
*/
|
||||
async checkAvailability(): Promise<Map<Runtime, RuntimeAvailability>> {
|
||||
const results = new Map<Runtime, RuntimeAvailability>();
|
||||
|
||||
for (const [runtime, adapter] of this.adapters) {
|
||||
const availability = await adapter.checkAvailable();
|
||||
results.set(runtime, availability);
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get adapters for a list of runtimes, in order
|
||||
* @param runtimes - Ordered list of runtimes
|
||||
* @returns Adapters in the same order, skipping any that aren't registered
|
||||
*/
|
||||
getAdaptersForRuntimes(runtimes: Runtime[]): RuntimeAdapter[] {
|
||||
const adapters: RuntimeAdapter[] = [];
|
||||
|
||||
for (const runtime of runtimes) {
|
||||
const adapter = this.get(runtime);
|
||||
if (adapter) {
|
||||
adapters.push(adapter);
|
||||
}
|
||||
}
|
||||
|
||||
return adapters;
|
||||
}
|
||||
}
|
219
ts/tstest.classes.runtime.bun.ts
Normal file
219
ts/tstest.classes.runtime.bun.ts
Normal file
@@ -0,0 +1,219 @@
|
||||
import * as plugins from './tstest.plugins.js';
|
||||
import { coloredString as cs } from '@push.rocks/consolecolor';
|
||||
import {
|
||||
RuntimeAdapter,
|
||||
type RuntimeOptions,
|
||||
type RuntimeCommand,
|
||||
type RuntimeAvailability,
|
||||
} from './tstest.classes.runtime.adapter.js';
|
||||
import { TapParser } from './tstest.classes.tap.parser.js';
|
||||
import { TsTestLogger } from './tstest.logging.js';
|
||||
import type { Runtime } from './tstest.classes.runtime.parser.js';
|
||||
|
||||
/**
|
||||
* Bun runtime adapter
|
||||
* Executes tests using the Bun runtime with native TypeScript support
|
||||
*/
|
||||
export class BunRuntimeAdapter extends RuntimeAdapter {
|
||||
readonly id: Runtime = 'bun';
|
||||
readonly displayName: string = 'Bun';
|
||||
|
||||
constructor(
|
||||
private logger: TsTestLogger,
|
||||
private smartshellInstance: any, // SmartShell instance from @push.rocks/smartshell
|
||||
private timeoutSeconds: number | null,
|
||||
private filterTags: string[]
|
||||
) {
|
||||
super();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if Bun is available
|
||||
*/
|
||||
async checkAvailable(): Promise<RuntimeAvailability> {
|
||||
try {
|
||||
const result = await this.smartshellInstance.exec('bun --version', {
|
||||
cwd: process.cwd(),
|
||||
onError: () => {
|
||||
// Ignore error
|
||||
}
|
||||
});
|
||||
|
||||
if (result.exitCode !== 0) {
|
||||
return {
|
||||
available: false,
|
||||
error: 'Bun not found. Install from: https://bun.sh/',
|
||||
};
|
||||
}
|
||||
|
||||
// Bun version is just the version number
|
||||
const version = result.stdout.trim();
|
||||
|
||||
return {
|
||||
available: true,
|
||||
version: `Bun ${version}`,
|
||||
};
|
||||
} catch (error) {
|
||||
return {
|
||||
available: false,
|
||||
error: error.message,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create command configuration for Bun test execution
|
||||
*/
|
||||
createCommand(testFile: string, options?: RuntimeOptions): RuntimeCommand {
|
||||
const mergedOptions = this.mergeOptions(options);
|
||||
|
||||
const args: string[] = ['run'];
|
||||
|
||||
// Add extra args
|
||||
if (mergedOptions.extraArgs && mergedOptions.extraArgs.length > 0) {
|
||||
args.push(...mergedOptions.extraArgs);
|
||||
}
|
||||
|
||||
// Add test file
|
||||
args.push(testFile);
|
||||
|
||||
// Set environment variables
|
||||
const env = { ...mergedOptions.env };
|
||||
|
||||
if (this.filterTags.length > 0) {
|
||||
env.TSTEST_FILTER_TAGS = this.filterTags.join(',');
|
||||
}
|
||||
|
||||
return {
|
||||
command: 'bun',
|
||||
args,
|
||||
env,
|
||||
cwd: mergedOptions.cwd,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a test file in Bun
|
||||
*/
|
||||
async run(
|
||||
testFile: string,
|
||||
index: number,
|
||||
total: number,
|
||||
options?: RuntimeOptions
|
||||
): Promise<TapParser> {
|
||||
this.logger.testFileStart(testFile, this.displayName, index, total);
|
||||
const tapParser = new TapParser(testFile + ':bun', this.logger);
|
||||
|
||||
const mergedOptions = this.mergeOptions(options);
|
||||
|
||||
// Build Bun command
|
||||
const command = this.createCommand(testFile, mergedOptions);
|
||||
const fullCommand = `${command.command} ${command.args.join(' ')}`;
|
||||
|
||||
// Set filter tags as environment variable
|
||||
if (this.filterTags.length > 0) {
|
||||
process.env.TSTEST_FILTER_TAGS = this.filterTags.join(',');
|
||||
}
|
||||
|
||||
// Check for 00init.ts file in test directory
|
||||
const testDir = plugins.path.dirname(testFile);
|
||||
const initFile = plugins.path.join(testDir, '00init.ts');
|
||||
const initFileExists = await plugins.smartfile.fs.fileExists(initFile);
|
||||
|
||||
let runCommand = fullCommand;
|
||||
let loaderPath: string | null = null;
|
||||
|
||||
// If 00init.ts exists, create a loader file
|
||||
if (initFileExists) {
|
||||
const absoluteInitFile = plugins.path.resolve(initFile);
|
||||
const absoluteTestFile = plugins.path.resolve(testFile);
|
||||
const loaderContent = `
|
||||
import '${absoluteInitFile.replace(/\\/g, '/')}';
|
||||
import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
`;
|
||||
loaderPath = plugins.path.join(testDir, `.loader_${plugins.path.basename(testFile)}`);
|
||||
await plugins.smartfile.memory.toFs(loaderContent, loaderPath);
|
||||
|
||||
// Rebuild command with loader file
|
||||
const loaderCommand = this.createCommand(loaderPath, mergedOptions);
|
||||
runCommand = `${loaderCommand.command} ${loaderCommand.args.join(' ')}`;
|
||||
}
|
||||
|
||||
const execResultStreaming = await this.smartshellInstance.execStreamingSilent(runCommand);
|
||||
|
||||
// If we created a loader file, clean it up after test execution
|
||||
if (loaderPath) {
|
||||
const cleanup = () => {
|
||||
try {
|
||||
if (plugins.smartfile.fs.fileExistsSync(loaderPath)) {
|
||||
plugins.smartfile.fs.removeSync(loaderPath);
|
||||
}
|
||||
} catch (e) {
|
||||
// Ignore cleanup errors
|
||||
}
|
||||
};
|
||||
|
||||
execResultStreaming.childProcess.on('exit', cleanup);
|
||||
execResultStreaming.childProcess.on('error', cleanup);
|
||||
}
|
||||
|
||||
// Start warning timer if no timeout was specified
|
||||
let warningTimer: NodeJS.Timeout | null = null;
|
||||
if (this.timeoutSeconds === null) {
|
||||
warningTimer = setTimeout(() => {
|
||||
console.error('');
|
||||
console.error(cs('⚠️ WARNING: Test file is running for more than 1 minute', 'orange'));
|
||||
console.error(cs(` File: ${testFile}`, 'orange'));
|
||||
console.error(cs(' Consider using --timeout option to set a timeout for test files.', 'orange'));
|
||||
console.error(cs(' Example: tstest test --timeout=300 (for 5 minutes)', 'orange'));
|
||||
console.error('');
|
||||
}, 60000); // 1 minute
|
||||
}
|
||||
|
||||
// Handle timeout if specified
|
||||
if (this.timeoutSeconds !== null) {
|
||||
const timeoutMs = this.timeoutSeconds * 1000;
|
||||
let timeoutId: NodeJS.Timeout;
|
||||
|
||||
const timeoutPromise = new Promise<void>((_resolve, reject) => {
|
||||
timeoutId = setTimeout(async () => {
|
||||
// Use smartshell's terminate() to kill entire process tree
|
||||
await execResultStreaming.terminate();
|
||||
reject(new Error(`Test file timed out after ${this.timeoutSeconds} seconds`));
|
||||
}, timeoutMs);
|
||||
});
|
||||
|
||||
try {
|
||||
await Promise.race([
|
||||
tapParser.handleTapProcess(execResultStreaming.childProcess),
|
||||
timeoutPromise
|
||||
]);
|
||||
// Clear timeout if test completed successfully
|
||||
clearTimeout(timeoutId);
|
||||
} catch (error) {
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
// Handle timeout error
|
||||
tapParser.handleTimeout(this.timeoutSeconds);
|
||||
// Ensure entire process tree is killed if still running
|
||||
try {
|
||||
await execResultStreaming.kill(); // This kills the entire process tree with SIGKILL
|
||||
} catch (killError) {
|
||||
// Process tree might already be dead
|
||||
}
|
||||
await tapParser.evaluateFinalResult();
|
||||
}
|
||||
} else {
|
||||
await tapParser.handleTapProcess(execResultStreaming.childProcess);
|
||||
}
|
||||
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
|
||||
return tapParser;
|
||||
}
|
||||
}
|
293
ts/tstest.classes.runtime.chromium.ts
Normal file
293
ts/tstest.classes.runtime.chromium.ts
Normal file
@@ -0,0 +1,293 @@
|
||||
import * as plugins from './tstest.plugins.js';
|
||||
import * as paths from './tstest.paths.js';
|
||||
import { coloredString as cs } from '@push.rocks/consolecolor';
|
||||
import {
|
||||
RuntimeAdapter,
|
||||
type ChromiumOptions,
|
||||
type RuntimeCommand,
|
||||
type RuntimeAvailability,
|
||||
} from './tstest.classes.runtime.adapter.js';
|
||||
import { TapParser } from './tstest.classes.tap.parser.js';
|
||||
import { TsTestLogger } from './tstest.logging.js';
|
||||
import type { Runtime } from './tstest.classes.runtime.parser.js';
|
||||
|
||||
/**
|
||||
* Chromium runtime adapter
|
||||
* Executes tests in a headless Chromium browser
|
||||
*/
|
||||
export class ChromiumRuntimeAdapter extends RuntimeAdapter {
|
||||
readonly id: Runtime = 'chromium';
|
||||
readonly displayName: string = 'Chromium';
|
||||
|
||||
constructor(
|
||||
private logger: TsTestLogger,
|
||||
private tsbundleInstance: any, // TsBundle instance from @push.rocks/tsbundle
|
||||
private smartbrowserInstance: any, // SmartBrowser instance from @push.rocks/smartbrowser
|
||||
private timeoutSeconds: number | null
|
||||
) {
|
||||
super();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if Chromium is available
|
||||
*/
|
||||
async checkAvailable(): Promise<RuntimeAvailability> {
|
||||
try {
|
||||
// Check if smartbrowser is available and can start
|
||||
// The browser binary is usually handled by @push.rocks/smartbrowser
|
||||
return {
|
||||
available: true,
|
||||
version: 'Chromium (via smartbrowser)',
|
||||
};
|
||||
} catch (error) {
|
||||
return {
|
||||
available: false,
|
||||
error: error.message || 'Chromium not available',
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create command configuration for Chromium test execution
|
||||
* Note: Chromium tests don't use a traditional command, but this satisfies the interface
|
||||
*/
|
||||
createCommand(testFile: string, options?: ChromiumOptions): RuntimeCommand {
|
||||
const mergedOptions = this.mergeOptions(options);
|
||||
|
||||
return {
|
||||
command: 'chromium',
|
||||
args: [],
|
||||
env: mergedOptions.env,
|
||||
cwd: mergedOptions.cwd,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Find free ports for HTTP server and WebSocket
|
||||
*/
|
||||
private async findFreePorts(): Promise<{ httpPort: number; wsPort: number }> {
|
||||
const smartnetwork = new plugins.smartnetwork.SmartNetwork();
|
||||
|
||||
// Find random free HTTP port in range 30000-40000 to minimize collision chance
|
||||
const httpPort = await smartnetwork.findFreePort(30000, 40000, { randomize: true });
|
||||
if (!httpPort) {
|
||||
throw new Error('Could not find a free HTTP port in range 30000-40000');
|
||||
}
|
||||
|
||||
// Find random free WebSocket port, excluding the HTTP port to ensure they're different
|
||||
const wsPort = await smartnetwork.findFreePort(30000, 40000, {
|
||||
randomize: true,
|
||||
exclude: [httpPort]
|
||||
});
|
||||
if (!wsPort) {
|
||||
throw new Error('Could not find a free WebSocket port in range 30000-40000');
|
||||
}
|
||||
|
||||
// Log selected ports for debugging
|
||||
if (!this.logger.options.quiet) {
|
||||
console.log(`Selected ports - HTTP: ${httpPort}, WebSocket: ${wsPort}`);
|
||||
}
|
||||
return { httpPort, wsPort };
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a test file in Chromium browser
|
||||
*/
|
||||
async run(
|
||||
testFile: string,
|
||||
index: number,
|
||||
total: number,
|
||||
options?: ChromiumOptions
|
||||
): Promise<TapParser> {
|
||||
this.logger.testFileStart(testFile, this.displayName, index, total);
|
||||
|
||||
// lets get all our paths sorted
|
||||
const tsbundleCacheDirPath = plugins.path.join(paths.cwd, './.nogit/tstest_cache');
|
||||
const bundleFileName = testFile.replace('/', '__') + '.js';
|
||||
const bundleFilePath = plugins.path.join(tsbundleCacheDirPath, bundleFileName);
|
||||
|
||||
// lets bundle the test
|
||||
await plugins.smartfile.fs.ensureEmptyDir(tsbundleCacheDirPath);
|
||||
await this.tsbundleInstance.build(process.cwd(), testFile, bundleFilePath, {
|
||||
bundler: 'esbuild',
|
||||
});
|
||||
|
||||
// Find free ports for HTTP and WebSocket
|
||||
const { httpPort, wsPort } = await this.findFreePorts();
|
||||
|
||||
// lets create a server
|
||||
const server = new plugins.typedserver.servertools.Server({
|
||||
cors: true,
|
||||
port: httpPort,
|
||||
});
|
||||
server.addRoute(
|
||||
'/test',
|
||||
new plugins.typedserver.servertools.Handler('GET', async (_req, res) => {
|
||||
res.type('.html');
|
||||
res.write(`
|
||||
<html>
|
||||
<head>
|
||||
<script>
|
||||
globalThis.testdom = true;
|
||||
globalThis.wsPort = ${wsPort};
|
||||
</script>
|
||||
</head>
|
||||
<body></body>
|
||||
</html>
|
||||
`);
|
||||
res.end();
|
||||
})
|
||||
);
|
||||
server.addRoute('/*splat', new plugins.typedserver.servertools.HandlerStatic(tsbundleCacheDirPath));
|
||||
await server.start();
|
||||
|
||||
// lets handle realtime comms
|
||||
const tapParser = new TapParser(testFile + ':chrome', this.logger);
|
||||
const wss = new plugins.ws.WebSocketServer({ port: wsPort });
|
||||
wss.on('connection', (ws) => {
|
||||
ws.on('message', (message) => {
|
||||
const messageStr = message.toString();
|
||||
if (messageStr.startsWith('console:')) {
|
||||
const [, level, ...messageParts] = messageStr.split(':');
|
||||
this.logger.browserConsole(messageParts.join(':'), level);
|
||||
} else {
|
||||
tapParser.handleTapLog(messageStr);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// lets do the browser bit with timeout handling
|
||||
await this.smartbrowserInstance.start();
|
||||
|
||||
const evaluatePromise = this.smartbrowserInstance.evaluateOnPage(
|
||||
`http://localhost:${httpPort}/test?bundleName=${bundleFileName}`,
|
||||
async () => {
|
||||
// lets enable real time comms
|
||||
const ws = new WebSocket(`ws://localhost:${globalThis.wsPort}`);
|
||||
await new Promise((resolve) => (ws.onopen = resolve));
|
||||
|
||||
// Ensure this function is declared with 'async'
|
||||
const logStore = [];
|
||||
const originalLog = console.log;
|
||||
const originalError = console.error;
|
||||
|
||||
// Override console methods to capture the logs
|
||||
console.log = (...args: any[]) => {
|
||||
logStore.push(args.join(' '));
|
||||
ws.send(args.join(' '));
|
||||
originalLog(...args);
|
||||
};
|
||||
console.error = (...args: any[]) => {
|
||||
logStore.push(args.join(' '));
|
||||
ws.send(args.join(' '));
|
||||
originalError(...args);
|
||||
};
|
||||
|
||||
const bundleName = new URLSearchParams(window.location.search).get('bundleName');
|
||||
originalLog(`::TSTEST IN CHROMIUM:: Relevant Script name is: ${bundleName}`);
|
||||
|
||||
try {
|
||||
// Dynamically import the test module
|
||||
const testModule = await import(`/${bundleName}`);
|
||||
if (testModule && testModule.default && testModule.default instanceof Promise) {
|
||||
// Execute the exported test function
|
||||
await testModule.default;
|
||||
} else if (testModule && testModule.default && typeof testModule.default.then === 'function') {
|
||||
console.log('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
|
||||
console.log('Test module default export is just promiselike: Something might be messing with your Promise implementation.');
|
||||
console.log('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
|
||||
await testModule.default;
|
||||
} else if (globalThis.tapPromise && typeof globalThis.tapPromise.then === 'function') {
|
||||
console.log('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
|
||||
console.log('Using globalThis.tapPromise');
|
||||
console.log('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
|
||||
await testModule.default;
|
||||
} else {
|
||||
console.error('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
|
||||
console.error('Test module does not export a default promise.');
|
||||
console.error('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
|
||||
console.log(`We got: ${JSON.stringify(testModule)}`);
|
||||
}
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
}
|
||||
|
||||
return logStore.join('\n');
|
||||
}
|
||||
);
|
||||
|
||||
// Start warning timer if no timeout was specified
|
||||
let warningTimer: NodeJS.Timeout | null = null;
|
||||
if (this.timeoutSeconds === null) {
|
||||
warningTimer = setTimeout(() => {
|
||||
console.error('');
|
||||
console.error(cs('⚠️ WARNING: Test file is running for more than 1 minute', 'orange'));
|
||||
console.error(cs(` File: ${testFile}`, 'orange'));
|
||||
console.error(cs(' Consider using --timeout option to set a timeout for test files.', 'orange'));
|
||||
console.error(cs(' Example: tstest test --timeout=300 (for 5 minutes)', 'orange'));
|
||||
console.error('');
|
||||
}, 60000); // 1 minute
|
||||
}
|
||||
|
||||
// Handle timeout if specified
|
||||
if (this.timeoutSeconds !== null) {
|
||||
const timeoutMs = this.timeoutSeconds * 1000;
|
||||
let timeoutId: NodeJS.Timeout;
|
||||
|
||||
const timeoutPromise = new Promise<void>((_resolve, reject) => {
|
||||
timeoutId = setTimeout(() => {
|
||||
reject(new Error(`Test file timed out after ${this.timeoutSeconds} seconds`));
|
||||
}, timeoutMs);
|
||||
});
|
||||
|
||||
try {
|
||||
await Promise.race([
|
||||
evaluatePromise,
|
||||
timeoutPromise
|
||||
]);
|
||||
// Clear timeout if test completed successfully
|
||||
clearTimeout(timeoutId);
|
||||
} catch (error) {
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
// Handle timeout error
|
||||
tapParser.handleTimeout(this.timeoutSeconds);
|
||||
}
|
||||
} else {
|
||||
await evaluatePromise;
|
||||
}
|
||||
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
|
||||
// Always clean up resources, even on timeout
|
||||
try {
|
||||
await this.smartbrowserInstance.stop();
|
||||
} catch (error) {
|
||||
// Browser might already be stopped
|
||||
}
|
||||
|
||||
try {
|
||||
await server.stop();
|
||||
} catch (error) {
|
||||
// Server might already be stopped
|
||||
}
|
||||
|
||||
try {
|
||||
wss.close();
|
||||
} catch (error) {
|
||||
// WebSocket server might already be closed
|
||||
}
|
||||
|
||||
console.log(
|
||||
`${cs('=> ', 'blue')} Stopped ${cs(testFile, 'orange')} chromium instance and server.`
|
||||
);
|
||||
// Always evaluate final result (handleTimeout just sets up the test state)
|
||||
await tapParser.evaluateFinalResult();
|
||||
return tapParser;
|
||||
}
|
||||
}
|
262
ts/tstest.classes.runtime.deno.ts
Normal file
262
ts/tstest.classes.runtime.deno.ts
Normal file
@@ -0,0 +1,262 @@
|
||||
import * as plugins from './tstest.plugins.js';
|
||||
import { coloredString as cs } from '@push.rocks/consolecolor';
|
||||
import {
|
||||
RuntimeAdapter,
|
||||
type DenoOptions,
|
||||
type RuntimeCommand,
|
||||
type RuntimeAvailability,
|
||||
} from './tstest.classes.runtime.adapter.js';
|
||||
import { TapParser } from './tstest.classes.tap.parser.js';
|
||||
import { TsTestLogger } from './tstest.logging.js';
|
||||
import type { Runtime } from './tstest.classes.runtime.parser.js';
|
||||
|
||||
/**
|
||||
* Deno runtime adapter
|
||||
* Executes tests using the Deno runtime
|
||||
*/
|
||||
export class DenoRuntimeAdapter extends RuntimeAdapter {
|
||||
readonly id: Runtime = 'deno';
|
||||
readonly displayName: string = 'Deno';
|
||||
|
||||
constructor(
|
||||
private logger: TsTestLogger,
|
||||
private smartshellInstance: any, // SmartShell instance from @push.rocks/smartshell
|
||||
private timeoutSeconds: number | null,
|
||||
private filterTags: string[]
|
||||
) {
|
||||
super();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get default Deno options
|
||||
*/
|
||||
protected getDefaultOptions(): DenoOptions {
|
||||
return {
|
||||
...super.getDefaultOptions(),
|
||||
permissions: [
|
||||
'--allow-read',
|
||||
'--allow-env',
|
||||
'--allow-net',
|
||||
'--allow-write',
|
||||
'--allow-sys', // Allow system info access
|
||||
'--allow-import', // Allow npm/node imports
|
||||
'--node-modules-dir', // Enable Node.js compatibility mode
|
||||
'--sloppy-imports', // Allow .js imports to resolve to .ts files
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if Deno is available
|
||||
*/
|
||||
async checkAvailable(): Promise<RuntimeAvailability> {
|
||||
try {
|
||||
const result = await this.smartshellInstance.exec('deno --version', {
|
||||
cwd: process.cwd(),
|
||||
onError: () => {
|
||||
// Ignore error
|
||||
}
|
||||
});
|
||||
|
||||
if (result.exitCode !== 0) {
|
||||
return {
|
||||
available: false,
|
||||
error: 'Deno not found. Install from: https://deno.land/',
|
||||
};
|
||||
}
|
||||
|
||||
// Parse Deno version from output (first line is "deno X.Y.Z")
|
||||
const versionMatch = result.stdout.match(/deno (\d+\.\d+\.\d+)/);
|
||||
const version = versionMatch ? versionMatch[1] : 'unknown';
|
||||
|
||||
return {
|
||||
available: true,
|
||||
version: `Deno ${version}`,
|
||||
};
|
||||
} catch (error) {
|
||||
return {
|
||||
available: false,
|
||||
error: error.message,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create command configuration for Deno test execution
|
||||
*/
|
||||
createCommand(testFile: string, options?: DenoOptions): RuntimeCommand {
|
||||
const mergedOptions = this.mergeOptions(options) as DenoOptions;
|
||||
|
||||
const args: string[] = ['run'];
|
||||
|
||||
// Add permissions
|
||||
const permissions = mergedOptions.permissions || [
|
||||
'--allow-read',
|
||||
'--allow-env',
|
||||
'--allow-net',
|
||||
'--allow-write',
|
||||
'--allow-sys',
|
||||
'--allow-import',
|
||||
'--node-modules-dir',
|
||||
'--sloppy-imports',
|
||||
];
|
||||
args.push(...permissions);
|
||||
|
||||
// Add config file if specified
|
||||
if (mergedOptions.configPath) {
|
||||
args.push('--config', mergedOptions.configPath);
|
||||
}
|
||||
|
||||
// Add import map if specified
|
||||
if (mergedOptions.importMap) {
|
||||
args.push('--import-map', mergedOptions.importMap);
|
||||
}
|
||||
|
||||
// Add extra args
|
||||
if (mergedOptions.extraArgs && mergedOptions.extraArgs.length > 0) {
|
||||
args.push(...mergedOptions.extraArgs);
|
||||
}
|
||||
|
||||
// Add test file
|
||||
args.push(testFile);
|
||||
|
||||
// Set environment variables
|
||||
const env = { ...mergedOptions.env };
|
||||
|
||||
if (this.filterTags.length > 0) {
|
||||
env.TSTEST_FILTER_TAGS = this.filterTags.join(',');
|
||||
}
|
||||
|
||||
return {
|
||||
command: 'deno',
|
||||
args,
|
||||
env,
|
||||
cwd: mergedOptions.cwd,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a test file in Deno
|
||||
*/
|
||||
async run(
|
||||
testFile: string,
|
||||
index: number,
|
||||
total: number,
|
||||
options?: DenoOptions
|
||||
): Promise<TapParser> {
|
||||
this.logger.testFileStart(testFile, this.displayName, index, total);
|
||||
const tapParser = new TapParser(testFile + ':deno', this.logger);
|
||||
|
||||
const mergedOptions = this.mergeOptions(options) as DenoOptions;
|
||||
|
||||
// Build Deno command
|
||||
const command = this.createCommand(testFile, mergedOptions);
|
||||
const fullCommand = `${command.command} ${command.args.join(' ')}`;
|
||||
|
||||
// Set filter tags as environment variable
|
||||
if (this.filterTags.length > 0) {
|
||||
process.env.TSTEST_FILTER_TAGS = this.filterTags.join(',');
|
||||
}
|
||||
|
||||
// Check for 00init.ts file in test directory
|
||||
const testDir = plugins.path.dirname(testFile);
|
||||
const initFile = plugins.path.join(testDir, '00init.ts');
|
||||
const initFileExists = await plugins.smartfile.fs.fileExists(initFile);
|
||||
|
||||
let runCommand = fullCommand;
|
||||
let loaderPath: string | null = null;
|
||||
|
||||
// If 00init.ts exists, create a loader file
|
||||
if (initFileExists) {
|
||||
const absoluteInitFile = plugins.path.resolve(initFile);
|
||||
const absoluteTestFile = plugins.path.resolve(testFile);
|
||||
const loaderContent = `
|
||||
import '${absoluteInitFile.replace(/\\/g, '/')}';
|
||||
import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
`;
|
||||
loaderPath = plugins.path.join(testDir, `.loader_${plugins.path.basename(testFile)}`);
|
||||
await plugins.smartfile.memory.toFs(loaderContent, loaderPath);
|
||||
|
||||
// Rebuild command with loader file
|
||||
const loaderCommand = this.createCommand(loaderPath, mergedOptions);
|
||||
runCommand = `${loaderCommand.command} ${loaderCommand.args.join(' ')}`;
|
||||
}
|
||||
|
||||
const execResultStreaming = await this.smartshellInstance.execStreamingSilent(runCommand);
|
||||
|
||||
// If we created a loader file, clean it up after test execution
|
||||
if (loaderPath) {
|
||||
const cleanup = () => {
|
||||
try {
|
||||
if (plugins.smartfile.fs.fileExistsSync(loaderPath)) {
|
||||
plugins.smartfile.fs.removeSync(loaderPath);
|
||||
}
|
||||
} catch (e) {
|
||||
// Ignore cleanup errors
|
||||
}
|
||||
};
|
||||
|
||||
execResultStreaming.childProcess.on('exit', cleanup);
|
||||
execResultStreaming.childProcess.on('error', cleanup);
|
||||
}
|
||||
|
||||
// Start warning timer if no timeout was specified
|
||||
let warningTimer: NodeJS.Timeout | null = null;
|
||||
if (this.timeoutSeconds === null) {
|
||||
warningTimer = setTimeout(() => {
|
||||
console.error('');
|
||||
console.error(cs('⚠️ WARNING: Test file is running for more than 1 minute', 'orange'));
|
||||
console.error(cs(` File: ${testFile}`, 'orange'));
|
||||
console.error(cs(' Consider using --timeout option to set a timeout for test files.', 'orange'));
|
||||
console.error(cs(' Example: tstest test --timeout=300 (for 5 minutes)', 'orange'));
|
||||
console.error('');
|
||||
}, 60000); // 1 minute
|
||||
}
|
||||
|
||||
// Handle timeout if specified
|
||||
if (this.timeoutSeconds !== null) {
|
||||
const timeoutMs = this.timeoutSeconds * 1000;
|
||||
let timeoutId: NodeJS.Timeout;
|
||||
|
||||
const timeoutPromise = new Promise<void>((_resolve, reject) => {
|
||||
timeoutId = setTimeout(async () => {
|
||||
// Use smartshell's terminate() to kill entire process tree
|
||||
await execResultStreaming.terminate();
|
||||
reject(new Error(`Test file timed out after ${this.timeoutSeconds} seconds`));
|
||||
}, timeoutMs);
|
||||
});
|
||||
|
||||
try {
|
||||
await Promise.race([
|
||||
tapParser.handleTapProcess(execResultStreaming.childProcess),
|
||||
timeoutPromise
|
||||
]);
|
||||
// Clear timeout if test completed successfully
|
||||
clearTimeout(timeoutId);
|
||||
} catch (error) {
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
// Handle timeout error
|
||||
tapParser.handleTimeout(this.timeoutSeconds);
|
||||
// Ensure entire process tree is killed if still running
|
||||
try {
|
||||
await execResultStreaming.kill(); // This kills the entire process tree with SIGKILL
|
||||
} catch (killError) {
|
||||
// Process tree might already be dead
|
||||
}
|
||||
await tapParser.evaluateFinalResult();
|
||||
}
|
||||
} else {
|
||||
await tapParser.handleTapProcess(execResultStreaming.childProcess);
|
||||
}
|
||||
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
|
||||
return tapParser;
|
||||
}
|
||||
}
|
222
ts/tstest.classes.runtime.node.ts
Normal file
222
ts/tstest.classes.runtime.node.ts
Normal file
@@ -0,0 +1,222 @@
|
||||
import * as plugins from './tstest.plugins.js';
|
||||
import { coloredString as cs } from '@push.rocks/consolecolor';
|
||||
import {
|
||||
RuntimeAdapter,
|
||||
type RuntimeOptions,
|
||||
type RuntimeCommand,
|
||||
type RuntimeAvailability,
|
||||
} from './tstest.classes.runtime.adapter.js';
|
||||
import { TapParser } from './tstest.classes.tap.parser.js';
|
||||
import { TsTestLogger } from './tstest.logging.js';
|
||||
import type { Runtime } from './tstest.classes.runtime.parser.js';
|
||||
|
||||
/**
|
||||
* Node.js runtime adapter
|
||||
* Executes tests using tsrun (TypeScript runner for Node.js)
|
||||
*/
|
||||
export class NodeRuntimeAdapter extends RuntimeAdapter {
|
||||
readonly id: Runtime = 'node';
|
||||
readonly displayName: string = 'Node.js';
|
||||
|
||||
constructor(
|
||||
private logger: TsTestLogger,
|
||||
private smartshellInstance: any, // SmartShell instance from @push.rocks/smartshell
|
||||
private timeoutSeconds: number | null,
|
||||
private filterTags: string[]
|
||||
) {
|
||||
super();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if Node.js and tsrun are available
|
||||
*/
|
||||
async checkAvailable(): Promise<RuntimeAvailability> {
|
||||
try {
|
||||
// Check Node.js version
|
||||
const nodeVersion = process.version;
|
||||
|
||||
// Check if tsrun is available
|
||||
const result = await this.smartshellInstance.exec('tsrun --version', {
|
||||
cwd: process.cwd(),
|
||||
onError: () => {
|
||||
// Ignore error
|
||||
}
|
||||
});
|
||||
|
||||
if (result.exitCode !== 0) {
|
||||
return {
|
||||
available: false,
|
||||
error: 'tsrun not found. Install with: pnpm install --save-dev @git.zone/tsrun',
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
available: true,
|
||||
version: nodeVersion,
|
||||
};
|
||||
} catch (error) {
|
||||
return {
|
||||
available: false,
|
||||
error: error.message,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create command configuration for Node.js test execution
|
||||
*/
|
||||
createCommand(testFile: string, options?: RuntimeOptions): RuntimeCommand {
|
||||
const mergedOptions = this.mergeOptions(options);
|
||||
|
||||
// Build tsrun options
|
||||
const args: string[] = [];
|
||||
|
||||
if (process.argv.includes('--web')) {
|
||||
args.push('--web');
|
||||
}
|
||||
|
||||
// Add any extra args
|
||||
if (mergedOptions.extraArgs) {
|
||||
args.push(...mergedOptions.extraArgs);
|
||||
}
|
||||
|
||||
// Set environment variables
|
||||
const env = { ...mergedOptions.env };
|
||||
|
||||
if (this.filterTags.length > 0) {
|
||||
env.TSTEST_FILTER_TAGS = this.filterTags.join(',');
|
||||
}
|
||||
|
||||
return {
|
||||
command: 'tsrun',
|
||||
args: [testFile, ...args],
|
||||
env,
|
||||
cwd: mergedOptions.cwd,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a test file in Node.js
|
||||
*/
|
||||
async run(
|
||||
testFile: string,
|
||||
index: number,
|
||||
total: number,
|
||||
options?: RuntimeOptions
|
||||
): Promise<TapParser> {
|
||||
this.logger.testFileStart(testFile, this.displayName, index, total);
|
||||
const tapParser = new TapParser(testFile + ':node', this.logger);
|
||||
|
||||
const mergedOptions = this.mergeOptions(options);
|
||||
|
||||
// Build tsrun command
|
||||
let tsrunOptions = '';
|
||||
if (process.argv.includes('--web')) {
|
||||
tsrunOptions += ' --web';
|
||||
}
|
||||
|
||||
// Set filter tags as environment variable
|
||||
if (this.filterTags.length > 0) {
|
||||
process.env.TSTEST_FILTER_TAGS = this.filterTags.join(',');
|
||||
}
|
||||
|
||||
// Check for 00init.ts file in test directory
|
||||
const testDir = plugins.path.dirname(testFile);
|
||||
const initFile = plugins.path.join(testDir, '00init.ts');
|
||||
let runCommand = `tsrun ${testFile}${tsrunOptions}`;
|
||||
|
||||
const initFileExists = await plugins.smartfile.fs.fileExists(initFile);
|
||||
|
||||
// If 00init.ts exists, run it first
|
||||
let loaderPath: string | null = null;
|
||||
if (initFileExists) {
|
||||
// Create a temporary loader file that imports both 00init.ts and the test file
|
||||
const absoluteInitFile = plugins.path.resolve(initFile);
|
||||
const absoluteTestFile = plugins.path.resolve(testFile);
|
||||
const loaderContent = `
|
||||
import '${absoluteInitFile.replace(/\\/g, '/')}';
|
||||
import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
`;
|
||||
loaderPath = plugins.path.join(testDir, `.loader_${plugins.path.basename(testFile)}`);
|
||||
await plugins.smartfile.memory.toFs(loaderContent, loaderPath);
|
||||
runCommand = `tsrun ${loaderPath}${tsrunOptions}`;
|
||||
}
|
||||
|
||||
const execResultStreaming = await this.smartshellInstance.execStreamingSilent(runCommand);
|
||||
|
||||
// If we created a loader file, clean it up after test execution
|
||||
if (loaderPath) {
|
||||
const cleanup = () => {
|
||||
try {
|
||||
if (plugins.smartfile.fs.fileExistsSync(loaderPath)) {
|
||||
plugins.smartfile.fs.removeSync(loaderPath);
|
||||
}
|
||||
} catch (e) {
|
||||
// Ignore cleanup errors
|
||||
}
|
||||
};
|
||||
|
||||
execResultStreaming.childProcess.on('exit', cleanup);
|
||||
execResultStreaming.childProcess.on('error', cleanup);
|
||||
}
|
||||
|
||||
// Start warning timer if no timeout was specified
|
||||
let warningTimer: NodeJS.Timeout | null = null;
|
||||
if (this.timeoutSeconds === null) {
|
||||
warningTimer = setTimeout(() => {
|
||||
console.error('');
|
||||
console.error(cs('⚠️ WARNING: Test file is running for more than 1 minute', 'orange'));
|
||||
console.error(cs(` File: ${testFile}`, 'orange'));
|
||||
console.error(cs(' Consider using --timeout option to set a timeout for test files.', 'orange'));
|
||||
console.error(cs(' Example: tstest test --timeout=300 (for 5 minutes)', 'orange'));
|
||||
console.error('');
|
||||
}, 60000); // 1 minute
|
||||
}
|
||||
|
||||
// Handle timeout if specified
|
||||
if (this.timeoutSeconds !== null) {
|
||||
const timeoutMs = this.timeoutSeconds * 1000;
|
||||
let timeoutId: NodeJS.Timeout;
|
||||
|
||||
const timeoutPromise = new Promise<void>((_resolve, reject) => {
|
||||
timeoutId = setTimeout(async () => {
|
||||
// Use smartshell's terminate() to kill entire process tree
|
||||
await execResultStreaming.terminate();
|
||||
reject(new Error(`Test file timed out after ${this.timeoutSeconds} seconds`));
|
||||
}, timeoutMs);
|
||||
});
|
||||
|
||||
try {
|
||||
await Promise.race([
|
||||
tapParser.handleTapProcess(execResultStreaming.childProcess),
|
||||
timeoutPromise
|
||||
]);
|
||||
// Clear timeout if test completed successfully
|
||||
clearTimeout(timeoutId);
|
||||
} catch (error) {
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
// Handle timeout error
|
||||
tapParser.handleTimeout(this.timeoutSeconds);
|
||||
// Ensure entire process tree is killed if still running
|
||||
try {
|
||||
await execResultStreaming.kill(); // This kills the entire process tree with SIGKILL
|
||||
} catch (killError) {
|
||||
// Process tree might already be dead
|
||||
}
|
||||
await tapParser.evaluateFinalResult();
|
||||
}
|
||||
} else {
|
||||
await tapParser.handleTapProcess(execResultStreaming.childProcess);
|
||||
}
|
||||
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
|
||||
return tapParser;
|
||||
}
|
||||
}
|
230
ts/tstest.classes.runtime.parser.ts
Normal file
230
ts/tstest.classes.runtime.parser.ts
Normal file
@@ -0,0 +1,230 @@
|
||||
/**
|
||||
* Runtime parser for test file naming convention
|
||||
* Supports: test.runtime1+runtime2.modifier.ts
|
||||
* Examples:
|
||||
* - test.node.ts
|
||||
* - test.chromium.ts
|
||||
* - test.node+chromium.ts
|
||||
* - test.deno+bun.ts
|
||||
* - test.all.ts (runs on all runtimes)
|
||||
* - test.chromium.nonci.ts
|
||||
*/
|
||||
|
||||
export type Runtime = 'node' | 'chromium' | 'deno' | 'bun';
|
||||
export type Modifier = 'nonci';
|
||||
|
||||
export interface ParsedFilename {
|
||||
baseName: string;
|
||||
runtimes: Runtime[];
|
||||
modifiers: Modifier[];
|
||||
extension: string;
|
||||
isLegacy: boolean;
|
||||
original: string;
|
||||
}
|
||||
|
||||
export interface ParserConfig {
|
||||
strictUnknownRuntime?: boolean; // default: true
|
||||
defaultRuntimes?: Runtime[]; // default: ['node']
|
||||
}
|
||||
|
||||
const KNOWN_RUNTIMES: Set<string> = new Set(['node', 'chromium', 'deno', 'bun']);
|
||||
const KNOWN_MODIFIERS: Set<string> = new Set(['nonci']);
|
||||
const VALID_EXTENSIONS: Set<string> = new Set(['ts', 'tsx', 'mts', 'cts']);
|
||||
const ALL_RUNTIMES: Runtime[] = ['node', 'chromium', 'deno', 'bun'];
|
||||
|
||||
// Legacy mappings for backwards compatibility
|
||||
const LEGACY_RUNTIME_MAP: Record<string, Runtime[]> = {
|
||||
browser: ['chromium'],
|
||||
both: ['node', 'chromium'],
|
||||
};
|
||||
|
||||
/**
|
||||
* Parse a test filename to extract runtimes, modifiers, and detect legacy patterns
|
||||
* Algorithm: Right-to-left token analysis from the extension
|
||||
*/
|
||||
export function parseTestFilename(
|
||||
filePath: string,
|
||||
config: ParserConfig = {}
|
||||
): ParsedFilename {
|
||||
const strictUnknownRuntime = config.strictUnknownRuntime ?? true;
|
||||
const defaultRuntimes = config.defaultRuntimes ?? ['node'];
|
||||
|
||||
// Extract just the filename from the path
|
||||
const fileName = filePath.split('/').pop() || filePath;
|
||||
const original = fileName;
|
||||
|
||||
// Step 1: Extract and validate extension
|
||||
const lastDot = fileName.lastIndexOf('.');
|
||||
if (lastDot === -1) {
|
||||
throw new Error(`Invalid test file: no extension found in "${fileName}"`);
|
||||
}
|
||||
|
||||
const extension = fileName.substring(lastDot + 1);
|
||||
if (!VALID_EXTENSIONS.has(extension)) {
|
||||
throw new Error(
|
||||
`Invalid test file extension ".${extension}" in "${fileName}". ` +
|
||||
`Valid extensions: ${Array.from(VALID_EXTENSIONS).join(', ')}`
|
||||
);
|
||||
}
|
||||
|
||||
// Step 2: Split remaining basename by dots
|
||||
const withoutExtension = fileName.substring(0, lastDot);
|
||||
const tokens = withoutExtension.split('.');
|
||||
|
||||
if (tokens.length === 0) {
|
||||
throw new Error(`Invalid test file: empty basename in "${fileName}"`);
|
||||
}
|
||||
|
||||
// Step 3: Parse from right to left
|
||||
let isLegacy = false;
|
||||
const modifiers: Modifier[] = [];
|
||||
let runtimes: Runtime[] = [];
|
||||
let runtimeTokenIndex = -1;
|
||||
|
||||
// Scan from right to left
|
||||
for (let i = tokens.length - 1; i >= 0; i--) {
|
||||
const token = tokens[i];
|
||||
|
||||
// Check if this is a known modifier
|
||||
if (KNOWN_MODIFIERS.has(token)) {
|
||||
modifiers.unshift(token as Modifier);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Check if this is a legacy runtime token
|
||||
if (LEGACY_RUNTIME_MAP[token]) {
|
||||
isLegacy = true;
|
||||
runtimes = LEGACY_RUNTIME_MAP[token];
|
||||
runtimeTokenIndex = i;
|
||||
break;
|
||||
}
|
||||
|
||||
// Check if this is a runtime chain (may contain + separators)
|
||||
if (token.includes('+')) {
|
||||
const runtimeCandidates = token.split('+').map(r => r.trim()).filter(Boolean);
|
||||
const validRuntimes: Runtime[] = [];
|
||||
const invalidRuntimes: string[] = [];
|
||||
let hasAllKeyword = false;
|
||||
|
||||
for (const candidate of runtimeCandidates) {
|
||||
if (candidate === 'all') {
|
||||
hasAllKeyword = true;
|
||||
} else if (KNOWN_RUNTIMES.has(candidate)) {
|
||||
// Dedupe: only add if not already in list
|
||||
if (!validRuntimes.includes(candidate as Runtime)) {
|
||||
validRuntimes.push(candidate as Runtime);
|
||||
}
|
||||
} else {
|
||||
invalidRuntimes.push(candidate);
|
||||
}
|
||||
}
|
||||
|
||||
// If 'all' keyword is present, expand to all runtimes
|
||||
if (hasAllKeyword) {
|
||||
runtimes = [...ALL_RUNTIMES];
|
||||
runtimeTokenIndex = i;
|
||||
break;
|
||||
}
|
||||
|
||||
if (invalidRuntimes.length > 0) {
|
||||
if (strictUnknownRuntime) {
|
||||
throw new Error(
|
||||
`Unknown runtime(s) in "${fileName}": ${invalidRuntimes.join(', ')}. ` +
|
||||
`Valid runtimes: ${Array.from(KNOWN_RUNTIMES).join(', ')}, all`
|
||||
);
|
||||
} else {
|
||||
console.warn(
|
||||
`⚠️ Warning: Unknown runtime(s) in "${fileName}": ${invalidRuntimes.join(', ')}. ` +
|
||||
`Defaulting to: ${defaultRuntimes.join('+')}`
|
||||
);
|
||||
runtimes = [...defaultRuntimes];
|
||||
runtimeTokenIndex = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (validRuntimes.length > 0) {
|
||||
runtimes = validRuntimes;
|
||||
runtimeTokenIndex = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Check if this is the 'all' keyword (expands to all runtimes)
|
||||
if (token === 'all') {
|
||||
runtimes = [...ALL_RUNTIMES];
|
||||
runtimeTokenIndex = i;
|
||||
break;
|
||||
}
|
||||
|
||||
// Check if this is a single runtime token
|
||||
if (KNOWN_RUNTIMES.has(token)) {
|
||||
runtimes = [token as Runtime];
|
||||
runtimeTokenIndex = i;
|
||||
break;
|
||||
}
|
||||
|
||||
// If we've scanned past modifiers and haven't found a runtime, stop looking
|
||||
if (modifiers.length > 0) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Step 4: Determine base name
|
||||
// Everything before the runtime token (if found) is the base name
|
||||
const baseNameTokens = runtimeTokenIndex >= 0 ? tokens.slice(0, runtimeTokenIndex) : tokens;
|
||||
const baseName = baseNameTokens.join('.');
|
||||
|
||||
// Step 5: Apply defaults if no runtime was detected
|
||||
if (runtimes.length === 0) {
|
||||
runtimes = [...defaultRuntimes];
|
||||
}
|
||||
|
||||
return {
|
||||
baseName: baseName || 'test',
|
||||
runtimes,
|
||||
modifiers,
|
||||
extension,
|
||||
isLegacy,
|
||||
original,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a filename uses legacy naming convention
|
||||
*/
|
||||
export function isLegacyFilename(fileName: string): boolean {
|
||||
const tokens = fileName.split('.');
|
||||
for (const token of tokens) {
|
||||
if (LEGACY_RUNTIME_MAP[token]) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the suggested new filename for a legacy filename
|
||||
*/
|
||||
export function getLegacyMigrationTarget(fileName: string): string | null {
|
||||
const parsed = parseTestFilename(fileName, { strictUnknownRuntime: false });
|
||||
|
||||
if (!parsed.isLegacy) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Reconstruct filename with new naming
|
||||
const parts = [parsed.baseName];
|
||||
|
||||
if (parsed.runtimes.length > 0) {
|
||||
parts.push(parsed.runtimes.join('+'));
|
||||
}
|
||||
|
||||
if (parsed.modifiers.length > 0) {
|
||||
parts.push(...parsed.modifiers);
|
||||
}
|
||||
|
||||
parts.push(parsed.extension);
|
||||
|
||||
return parts.join('.');
|
||||
}
|
@@ -22,6 +22,7 @@ export class TapParser {
|
||||
private logger: TsTestLogger;
|
||||
private protocolParser: ProtocolParser;
|
||||
private protocolVersion: string | null = null;
|
||||
private startTime: number;
|
||||
|
||||
/**
|
||||
* the constructor for TapParser
|
||||
@@ -29,6 +30,7 @@ export class TapParser {
|
||||
constructor(public fileName: string, logger?: TsTestLogger) {
|
||||
this.logger = logger;
|
||||
this.protocolParser = new ProtocolParser();
|
||||
this.startTime = Date.now();
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -480,6 +482,7 @@ export class TapParser {
|
||||
|
||||
public async evaluateFinalResult() {
|
||||
this.receivedTests = this.testStore.length;
|
||||
const duration = Date.now() - this.startTime;
|
||||
|
||||
// check wether all tests ran
|
||||
if (this.expectedTests === this.receivedTests) {
|
||||
@@ -494,23 +497,23 @@ export class TapParser {
|
||||
if (!this.expectedTests && this.receivedTests === 0) {
|
||||
if (this.logger) {
|
||||
this.logger.error('No tests were defined. Therefore the testfile failed!');
|
||||
this.logger.testFileEnd(0, 1, 0); // Count as 1 failure
|
||||
this.logger.testFileEnd(0, 1, duration); // Count as 1 failure
|
||||
}
|
||||
} else if (this.expectedTests !== this.receivedTests) {
|
||||
if (this.logger) {
|
||||
this.logger.error('The amount of received tests and expectedTests is unequal! Therefore the testfile failed');
|
||||
const errorCount = this.getErrorTests().length || 1; // At least 1 error
|
||||
this.logger.testFileEnd(this.receivedTests - errorCount, errorCount, 0);
|
||||
this.logger.testFileEnd(this.receivedTests - errorCount, errorCount, duration);
|
||||
}
|
||||
} else if (this.getErrorTests().length === 0) {
|
||||
if (this.logger) {
|
||||
this.logger.tapOutput('All tests are successfull!!!');
|
||||
this.logger.testFileEnd(this.receivedTests, 0, 0);
|
||||
this.logger.testFileEnd(this.receivedTests, 0, duration);
|
||||
}
|
||||
} else {
|
||||
if (this.logger) {
|
||||
this.logger.tapOutput(`${this.getErrorTests().length} tests threw an error!!!`, true);
|
||||
this.logger.testFileEnd(this.receivedTests - this.getErrorTests().length, this.getErrorTests().length, 0);
|
||||
this.logger.testFileEnd(this.receivedTests - this.getErrorTests().length, this.getErrorTests().length, duration);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@@ -10,6 +10,14 @@ import { TestExecutionMode } from './index.js';
|
||||
import { TsTestLogger } from './tstest.logging.js';
|
||||
import type { LogOptions } from './tstest.logging.js';
|
||||
|
||||
// Runtime adapters
|
||||
import { parseTestFilename } from './tstest.classes.runtime.parser.js';
|
||||
import { RuntimeAdapterRegistry } from './tstest.classes.runtime.adapter.js';
|
||||
import { NodeRuntimeAdapter } from './tstest.classes.runtime.node.js';
|
||||
import { ChromiumRuntimeAdapter } from './tstest.classes.runtime.chromium.js';
|
||||
import { DenoRuntimeAdapter } from './tstest.classes.runtime.deno.js';
|
||||
import { BunRuntimeAdapter } from './tstest.classes.runtime.bun.js';
|
||||
|
||||
export class TsTest {
|
||||
public testDir: TestDirectory;
|
||||
public executionMode: TestExecutionMode;
|
||||
@@ -18,7 +26,6 @@ export class TsTest {
|
||||
public startFromFile: number | null;
|
||||
public stopAtFile: number | null;
|
||||
public timeoutSeconds: number | null;
|
||||
private timeoutWarningTimer: NodeJS.Timeout | null = null;
|
||||
|
||||
public smartshellInstance = new plugins.smartshell.Smartshell({
|
||||
executor: 'bash',
|
||||
@@ -29,6 +36,8 @@ export class TsTest {
|
||||
|
||||
public tsbundleInstance = new plugins.tsbundle.TsBundle();
|
||||
|
||||
public runtimeRegistry = new RuntimeAdapterRegistry();
|
||||
|
||||
constructor(cwdArg: string, testPathArg: string, executionModeArg: TestExecutionMode, logOptions: LogOptions = {}, tags: string[] = [], startFromFile: number | null = null, stopAtFile: number | null = null, timeoutSeconds: number | null = null) {
|
||||
this.executionMode = executionModeArg;
|
||||
this.testDir = new TestDirectory(cwdArg, testPathArg, executionModeArg);
|
||||
@@ -37,6 +46,20 @@ export class TsTest {
|
||||
this.startFromFile = startFromFile;
|
||||
this.stopAtFile = stopAtFile;
|
||||
this.timeoutSeconds = timeoutSeconds;
|
||||
|
||||
// Register runtime adapters
|
||||
this.runtimeRegistry.register(
|
||||
new NodeRuntimeAdapter(this.logger, this.smartshellInstance, this.timeoutSeconds, this.filterTags)
|
||||
);
|
||||
this.runtimeRegistry.register(
|
||||
new ChromiumRuntimeAdapter(this.logger, this.tsbundleInstance, this.smartbrowserInstance, this.timeoutSeconds)
|
||||
);
|
||||
this.runtimeRegistry.register(
|
||||
new DenoRuntimeAdapter(this.logger, this.smartshellInstance, this.timeoutSeconds, this.filterTags)
|
||||
);
|
||||
this.runtimeRegistry.register(
|
||||
new BunRuntimeAdapter(this.logger, this.smartshellInstance, this.timeoutSeconds, this.filterTags)
|
||||
);
|
||||
}
|
||||
|
||||
async run() {
|
||||
@@ -45,15 +68,6 @@ export class TsTest {
|
||||
await this.movePreviousLogFiles();
|
||||
}
|
||||
|
||||
// Start timeout warning timer if no timeout was specified
|
||||
if (this.timeoutSeconds === null) {
|
||||
this.timeoutWarningTimer = setTimeout(() => {
|
||||
this.logger.warning('Test is running for more than 1 minute.');
|
||||
this.logger.warning('Consider using --timeout option to set a timeout for test files.');
|
||||
this.logger.warning('Example: tstest test --timeout=300 (for 5 minutes)');
|
||||
}, 60000); // 1 minute
|
||||
}
|
||||
|
||||
const testGroups = await this.testDir.getTestFileGroups();
|
||||
const allFiles = [...testGroups.serial, ...Object.values(testGroups.parallelGroups).flat()];
|
||||
|
||||
@@ -92,12 +106,6 @@ export class TsTest {
|
||||
}
|
||||
}
|
||||
|
||||
// Clear the timeout warning timer if it was set
|
||||
if (this.timeoutWarningTimer) {
|
||||
clearTimeout(this.timeoutWarningTimer);
|
||||
this.timeoutWarningTimer = null;
|
||||
}
|
||||
|
||||
tapCombinator.evaluate();
|
||||
}
|
||||
|
||||
@@ -191,29 +199,50 @@ export class TsTest {
|
||||
}
|
||||
|
||||
private async runSingleTest(fileNameArg: string, fileIndex: number, totalFiles: number, tapCombinator: TapCombinator) {
|
||||
switch (true) {
|
||||
case process.env.CI && fileNameArg.includes('.nonci.'):
|
||||
this.logger.tapOutput(`Skipping ${fileNameArg} - marked as non-CI`);
|
||||
break;
|
||||
case fileNameArg.endsWith('.browser.ts') || fileNameArg.endsWith('.browser.nonci.ts'):
|
||||
const tapParserBrowser = await this.runInChrome(fileNameArg, fileIndex, totalFiles);
|
||||
tapCombinator.addTapParser(tapParserBrowser);
|
||||
break;
|
||||
case fileNameArg.endsWith('.both.ts') || fileNameArg.endsWith('.both.nonci.ts'):
|
||||
this.logger.sectionStart('Part 1: Chrome');
|
||||
const tapParserBothBrowser = await this.runInChrome(fileNameArg, fileIndex, totalFiles);
|
||||
tapCombinator.addTapParser(tapParserBothBrowser);
|
||||
// Parse the filename to determine runtimes and modifiers
|
||||
const fileName = plugins.path.basename(fileNameArg);
|
||||
const parsed = parseTestFilename(fileName, { strictUnknownRuntime: false });
|
||||
|
||||
// Check for nonci modifier in CI environment
|
||||
if (process.env.CI && parsed.modifiers.includes('nonci')) {
|
||||
this.logger.tapOutput(`Skipping ${fileNameArg} - marked as non-CI`);
|
||||
return;
|
||||
}
|
||||
|
||||
// Show deprecation warning for legacy naming
|
||||
if (parsed.isLegacy) {
|
||||
console.warn('');
|
||||
console.warn(cs('⚠️ DEPRECATION WARNING', 'orange'));
|
||||
console.warn(cs(` File: ${fileName}`, 'orange'));
|
||||
console.warn(cs(` Legacy naming detected. Please migrate to new naming convention.`, 'orange'));
|
||||
console.warn(cs(` Suggested: ${fileName.replace('.browser.', '.chromium.').replace('.both.', '.node+chromium.')}`, 'green'));
|
||||
console.warn(cs(` Run: tstest migrate --dry-run`, 'cyan'));
|
||||
console.warn('');
|
||||
}
|
||||
|
||||
// Get adapters for the specified runtimes
|
||||
const adapters = this.runtimeRegistry.getAdaptersForRuntimes(parsed.runtimes);
|
||||
|
||||
if (adapters.length === 0) {
|
||||
this.logger.tapOutput(`Skipping ${fileNameArg} - no runtime adapters available`);
|
||||
return;
|
||||
}
|
||||
|
||||
// Execute tests for each runtime
|
||||
if (adapters.length === 1) {
|
||||
// Single runtime - no sections needed
|
||||
const adapter = adapters[0];
|
||||
const tapParser = await adapter.run(fileNameArg, fileIndex, totalFiles);
|
||||
tapCombinator.addTapParser(tapParser);
|
||||
} else {
|
||||
// Multiple runtimes - use sections
|
||||
for (let i = 0; i < adapters.length; i++) {
|
||||
const adapter = adapters[i];
|
||||
this.logger.sectionStart(`Part ${i + 1}: ${adapter.displayName}`);
|
||||
const tapParser = await adapter.run(fileNameArg, fileIndex, totalFiles);
|
||||
tapCombinator.addTapParser(tapParser);
|
||||
this.logger.sectionEnd();
|
||||
|
||||
this.logger.sectionStart('Part 2: Node');
|
||||
const tapParserBothNode = await this.runInNode(fileNameArg, fileIndex, totalFiles);
|
||||
tapCombinator.addTapParser(tapParserBothNode);
|
||||
this.logger.sectionEnd();
|
||||
break;
|
||||
default:
|
||||
const tapParserNode = await this.runInNode(fileNameArg, fileIndex, totalFiles);
|
||||
tapCombinator.addTapParser(tapParserNode);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -272,6 +301,19 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
execResultStreaming.childProcess.on('error', cleanup);
|
||||
}
|
||||
|
||||
// Start warning timer if no timeout was specified
|
||||
let warningTimer: NodeJS.Timeout | null = null;
|
||||
if (this.timeoutSeconds === null) {
|
||||
warningTimer = setTimeout(() => {
|
||||
console.error('');
|
||||
console.error(cs('⚠️ WARNING: Test file is running for more than 1 minute', 'orange'));
|
||||
console.error(cs(` File: ${fileNameArg}`, 'orange'));
|
||||
console.error(cs(' Consider using --timeout option to set a timeout for test files.', 'orange'));
|
||||
console.error(cs(' Example: tstest test --timeout=300 (for 5 minutes)', 'orange'));
|
||||
console.error('');
|
||||
}, 60000); // 1 minute
|
||||
}
|
||||
|
||||
// Handle timeout if specified
|
||||
if (this.timeoutSeconds !== null) {
|
||||
const timeoutMs = this.timeoutSeconds * 1000;
|
||||
@@ -293,6 +335,10 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
// Clear timeout if test completed successfully
|
||||
clearTimeout(timeoutId);
|
||||
} catch (error) {
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
// Handle timeout error
|
||||
tapParser.handleTimeout(this.timeoutSeconds);
|
||||
// Ensure entire process tree is killed if still running
|
||||
@@ -307,9 +353,39 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
await tapParser.handleTapProcess(execResultStreaming.childProcess);
|
||||
}
|
||||
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
|
||||
return tapParser;
|
||||
}
|
||||
|
||||
private async findFreePorts(): Promise<{ httpPort: number; wsPort: number }> {
|
||||
const smartnetwork = new plugins.smartnetwork.SmartNetwork();
|
||||
|
||||
// Find random free HTTP port in range 30000-40000 to minimize collision chance
|
||||
const httpPort = await smartnetwork.findFreePort(30000, 40000, { randomize: true });
|
||||
if (!httpPort) {
|
||||
throw new Error('Could not find a free HTTP port in range 30000-40000');
|
||||
}
|
||||
|
||||
// Find random free WebSocket port, excluding the HTTP port to ensure they're different
|
||||
const wsPort = await smartnetwork.findFreePort(30000, 40000, {
|
||||
randomize: true,
|
||||
exclude: [httpPort]
|
||||
});
|
||||
if (!wsPort) {
|
||||
throw new Error('Could not find a free WebSocket port in range 30000-40000');
|
||||
}
|
||||
|
||||
// Log selected ports for debugging
|
||||
if (!this.logger.options.quiet) {
|
||||
console.log(`Selected ports - HTTP: ${httpPort}, WebSocket: ${wsPort}`);
|
||||
}
|
||||
return { httpPort, wsPort };
|
||||
}
|
||||
|
||||
public async runInChrome(fileNameArg: string, index: number, total: number): Promise<TapParser> {
|
||||
this.logger.testFileStart(fileNameArg, 'chromium', index, total);
|
||||
|
||||
@@ -324,10 +400,13 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
bundler: 'esbuild',
|
||||
});
|
||||
|
||||
// Find free ports for HTTP and WebSocket
|
||||
const { httpPort, wsPort } = await this.findFreePorts();
|
||||
|
||||
// lets create a server
|
||||
const server = new plugins.typedserver.servertools.Server({
|
||||
cors: true,
|
||||
port: 3007,
|
||||
port: httpPort,
|
||||
});
|
||||
server.addRoute(
|
||||
'/test',
|
||||
@@ -338,6 +417,7 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
<head>
|
||||
<script>
|
||||
globalThis.testdom = true;
|
||||
globalThis.wsPort = ${wsPort};
|
||||
</script>
|
||||
</head>
|
||||
<body></body>
|
||||
@@ -346,12 +426,12 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
res.end();
|
||||
})
|
||||
);
|
||||
server.addRoute('*', new plugins.typedserver.servertools.HandlerStatic(tsbundleCacheDirPath));
|
||||
server.addRoute('/*splat', new plugins.typedserver.servertools.HandlerStatic(tsbundleCacheDirPath));
|
||||
await server.start();
|
||||
|
||||
// lets handle realtime comms
|
||||
const tapParser = new TapParser(fileNameArg + ':chrome', this.logger);
|
||||
const wss = new plugins.ws.WebSocketServer({ port: 8080 });
|
||||
const wss = new plugins.ws.WebSocketServer({ port: wsPort });
|
||||
wss.on('connection', (ws) => {
|
||||
ws.on('message', (message) => {
|
||||
const messageStr = message.toString();
|
||||
@@ -368,10 +448,10 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
await this.smartbrowserInstance.start();
|
||||
|
||||
const evaluatePromise = this.smartbrowserInstance.evaluateOnPage(
|
||||
`http://localhost:3007/test?bundleName=${bundleFileName}`,
|
||||
`http://localhost:${httpPort}/test?bundleName=${bundleFileName}`,
|
||||
async () => {
|
||||
// lets enable real time comms
|
||||
const ws = new WebSocket('ws://localhost:8080');
|
||||
const ws = new WebSocket(`ws://localhost:${globalThis.wsPort}`);
|
||||
await new Promise((resolve) => (ws.onopen = resolve));
|
||||
|
||||
// Ensure this function is declared with 'async'
|
||||
@@ -425,6 +505,19 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
}
|
||||
);
|
||||
|
||||
// Start warning timer if no timeout was specified
|
||||
let warningTimer: NodeJS.Timeout | null = null;
|
||||
if (this.timeoutSeconds === null) {
|
||||
warningTimer = setTimeout(() => {
|
||||
console.error('');
|
||||
console.error(cs('⚠️ WARNING: Test file is running for more than 1 minute', 'orange'));
|
||||
console.error(cs(` File: ${fileNameArg}`, 'orange'));
|
||||
console.error(cs(' Consider using --timeout option to set a timeout for test files.', 'orange'));
|
||||
console.error(cs(' Example: tstest test --timeout=300 (for 5 minutes)', 'orange'));
|
||||
console.error('');
|
||||
}, 60000); // 1 minute
|
||||
}
|
||||
|
||||
// Handle timeout if specified
|
||||
if (this.timeoutSeconds !== null) {
|
||||
const timeoutMs = this.timeoutSeconds * 1000;
|
||||
@@ -444,6 +537,10 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
// Clear timeout if test completed successfully
|
||||
clearTimeout(timeoutId);
|
||||
} catch (error) {
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
// Handle timeout error
|
||||
tapParser.handleTimeout(this.timeoutSeconds);
|
||||
}
|
||||
@@ -451,6 +548,11 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
await evaluatePromise;
|
||||
}
|
||||
|
||||
// Clear warning timer if it was set
|
||||
if (warningTimer) {
|
||||
clearTimeout(warningTimer);
|
||||
}
|
||||
|
||||
// Always clean up resources, even on timeout
|
||||
try {
|
||||
await this.smartbrowserInstance.stop();
|
||||
@@ -488,10 +590,10 @@ import '${absoluteTestFile.replace(/\\/g, '/')}';
|
||||
|
||||
try {
|
||||
// Delete 00err and 00diff directories if they exist
|
||||
if (await plugins.smartfile.fs.isDirectory(errDir)) {
|
||||
if (plugins.smartfile.fs.isDirectorySync(errDir)) {
|
||||
plugins.smartfile.fs.removeSync(errDir);
|
||||
}
|
||||
if (await plugins.smartfile.fs.isDirectory(diffDir)) {
|
||||
if (plugins.smartfile.fs.isDirectorySync(diffDir)) {
|
||||
plugins.smartfile.fs.removeSync(diffDir);
|
||||
}
|
||||
|
||||
|
@@ -242,9 +242,13 @@ export class TsTestLogger {
|
||||
|
||||
if (!this.options.quiet) {
|
||||
const total = passed + failed;
|
||||
const status = failed === 0 ? 'PASSED' : 'FAILED';
|
||||
const color = failed === 0 ? 'green' : 'red';
|
||||
this.log(this.format(` Summary: ${passed}/${total} ${status}`, color));
|
||||
const durationStr = duration >= 1000 ? `${(duration / 1000).toFixed(1)}s` : `${duration}ms`;
|
||||
|
||||
if (failed === 0) {
|
||||
this.log(this.format(` Summary: ${passed}/${total} PASSED in ${durationStr}`, 'green'));
|
||||
} else {
|
||||
this.log(this.format(` Summary: ${passed} passed, ${failed} failed of ${total} tests in ${durationStr}`, 'red'));
|
||||
}
|
||||
}
|
||||
|
||||
// If using --logfile, handle error copy and diff detection
|
||||
@@ -390,7 +394,13 @@ export class TsTestLogger {
|
||||
|
||||
if (this.options.quiet) {
|
||||
const status = summary.totalFailed === 0 ? 'PASSED' : 'FAILED';
|
||||
this.log(`\nSummary: ${summary.totalPassed}/${summary.totalTests} | ${totalDuration}ms | ${status}`);
|
||||
const durationStr = totalDuration >= 1000 ? `${(totalDuration / 1000).toFixed(1)}s` : `${totalDuration}ms`;
|
||||
|
||||
if (summary.totalFailed === 0) {
|
||||
this.log(`\nSummary: ${summary.totalPassed}/${summary.totalTests} | ${durationStr} | ${status}`);
|
||||
} else {
|
||||
this.log(`\nSummary: ${summary.totalPassed} passed, ${summary.totalFailed} failed of ${summary.totalTests} tests | ${durationStr} | ${status}`);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -404,7 +414,8 @@ export class TsTestLogger {
|
||||
if (summary.totalSkipped > 0) {
|
||||
this.log(this.format(`│ Skipped: ${summary.totalSkipped.toString().padStart(14)} │`, 'yellow'));
|
||||
}
|
||||
this.log(this.format(`│ Duration: ${totalDuration.toString().padStart(14)}ms │`, 'white'));
|
||||
const durationStrFormatted = totalDuration >= 1000 ? `${(totalDuration / 1000).toFixed(1)}s` : `${totalDuration}ms`;
|
||||
this.log(this.format(`│ Duration: ${durationStrFormatted.padStart(14)} │`, 'white'));
|
||||
this.log(this.format('└────────────────────────────────┘', 'dim'));
|
||||
|
||||
// File results
|
||||
|
@@ -17,6 +17,7 @@ import * as smartchok from '@push.rocks/smartchok';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
import * as smartlog from '@push.rocks/smartlog';
|
||||
import * as smartnetwork from '@push.rocks/smartnetwork';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartshell from '@push.rocks/smartshell';
|
||||
import * as tapbundle from '../dist_ts_tapbundle/index.js';
|
||||
@@ -28,6 +29,7 @@ export {
|
||||
smartdelay,
|
||||
smartfile,
|
||||
smartlog,
|
||||
smartnetwork,
|
||||
smartpromise,
|
||||
smartshell,
|
||||
tapbundle,
|
||||
|
389
ts_tapbundle/readme.md
Normal file
389
ts_tapbundle/readme.md
Normal file
@@ -0,0 +1,389 @@
|
||||
# @git.zone/tstest/tapbundle
|
||||
|
||||
> 🧪 Core TAP testing framework with enhanced assertions and lifecycle hooks
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# tapbundle is typically included as part of @git.zone/tstest
|
||||
pnpm install --save-dev @git.zone/tstest
|
||||
```
|
||||
|
||||
## Overview
|
||||
|
||||
`@git.zone/tstest/tapbundle` is the core testing framework module that provides the TAP (Test Anything Protocol) implementation for tstest. It offers a comprehensive API for writing and organizing tests with support for lifecycle hooks, test suites, enhanced assertions with diff generation, and flexible test configuration.
|
||||
|
||||
## Key Features
|
||||
|
||||
- 🎯 **TAP Protocol Compliant** - Full TAP version 13 support
|
||||
- 🔍 **Enhanced Assertions** - Built on smartexpect with automatic diff generation
|
||||
- 🏗️ **Test Suites** - Organize tests with `describe()` blocks
|
||||
- 🔄 **Lifecycle Hooks** - beforeEach/afterEach at suite and global levels
|
||||
- 🏷️ **Test Tagging** - Filter tests by tags for selective execution
|
||||
- ⚡ **Parallel Testing** - Run tests concurrently with `testParallel()`
|
||||
- 🔁 **Automatic Retries** - Configure retry logic for flaky tests
|
||||
- ⏱️ **Timeout Control** - Set timeouts at global, file, or test level
|
||||
- 🎨 **Fluent API** - Chain test configurations with builder pattern
|
||||
- 📊 **Protocol Events** - Real-time test execution events
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Simple Test File
|
||||
|
||||
```typescript
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
tap.test('should add numbers correctly', async () => {
|
||||
const result = 2 + 2;
|
||||
expect(result).toEqual(4);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
### Using Test Suites
|
||||
|
||||
```typescript
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
tap.describe('Calculator', () => {
|
||||
tap.beforeEach(async (tapTools) => {
|
||||
// Setup before each test in this suite
|
||||
});
|
||||
|
||||
tap.test('should add', async () => {
|
||||
expect(2 + 2).toEqual(4);
|
||||
});
|
||||
|
||||
tap.test('should subtract', async () => {
|
||||
expect(5 - 3).toEqual(2);
|
||||
});
|
||||
|
||||
tap.afterEach(async (tapTools) => {
|
||||
// Cleanup after each test in this suite
|
||||
});
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
### Main Test Methods
|
||||
|
||||
#### `tap.test(description, testFunction)`
|
||||
|
||||
Define a standard test that runs sequentially.
|
||||
|
||||
```typescript
|
||||
tap.test('should validate user input', async () => {
|
||||
// test code
|
||||
});
|
||||
```
|
||||
|
||||
#### `tap.testParallel(description, testFunction)`
|
||||
|
||||
Define a test that runs in parallel with other parallel tests.
|
||||
|
||||
```typescript
|
||||
tap.testParallel('should fetch user data', async () => {
|
||||
// test code
|
||||
});
|
||||
```
|
||||
|
||||
#### `tap.describe(description, suiteFunction)`
|
||||
|
||||
Create a test suite to group related tests.
|
||||
|
||||
```typescript
|
||||
tap.describe('User Authentication', () => {
|
||||
tap.test('should login', async () => { });
|
||||
tap.test('should logout', async () => { });
|
||||
});
|
||||
```
|
||||
|
||||
### Test Modes
|
||||
|
||||
#### Skip Tests
|
||||
|
||||
```typescript
|
||||
tap.skip.test('not ready yet', async () => {
|
||||
// This test will be skipped
|
||||
});
|
||||
```
|
||||
|
||||
#### Only Mode
|
||||
|
||||
```typescript
|
||||
tap.only.test('focus on this test', async () => {
|
||||
// Only tests marked with 'only' will run
|
||||
});
|
||||
```
|
||||
|
||||
#### Todo Tests
|
||||
|
||||
```typescript
|
||||
tap.todo.test('implement feature X');
|
||||
```
|
||||
|
||||
### Fluent Test Builder
|
||||
|
||||
Chain test configurations for expressive test definitions:
|
||||
|
||||
```typescript
|
||||
tap
|
||||
.tags('integration', 'database')
|
||||
.priority('high')
|
||||
.retry(3)
|
||||
.timeout(5000)
|
||||
.test('should handle database connection', async () => {
|
||||
// test with configured settings
|
||||
});
|
||||
```
|
||||
|
||||
### Lifecycle Hooks
|
||||
|
||||
#### Suite-Level Hooks
|
||||
|
||||
```typescript
|
||||
tap.describe('Database Tests', () => {
|
||||
tap.beforeEach(async (tapTools) => {
|
||||
// Runs before each test in this suite
|
||||
});
|
||||
|
||||
tap.afterEach(async (tapTools) => {
|
||||
// Runs after each test in this suite
|
||||
});
|
||||
|
||||
tap.test('test 1', async () => { });
|
||||
tap.test('test 2', async () => { });
|
||||
});
|
||||
```
|
||||
|
||||
#### Global Hooks
|
||||
|
||||
```typescript
|
||||
tap.settings({
|
||||
beforeAll: async () => {
|
||||
// Runs once before all tests
|
||||
},
|
||||
afterAll: async () => {
|
||||
// Runs once after all tests
|
||||
},
|
||||
beforeEach: async (testName) => {
|
||||
// Runs before every test
|
||||
},
|
||||
afterEach: async (testName, passed) => {
|
||||
// Runs after every test
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Global Settings
|
||||
|
||||
Configure test behavior at the file level:
|
||||
|
||||
```typescript
|
||||
tap.settings({
|
||||
timeout: 10000, // Default timeout for all tests
|
||||
retries: 2, // Retry failed tests
|
||||
retryDelay: 1000, // Delay between retries
|
||||
bail: false, // Stop on first failure
|
||||
suppressConsole: false, // Hide console output
|
||||
verboseErrors: true, // Show full stack traces
|
||||
showTestDuration: true, // Display test durations
|
||||
maxConcurrency: 4, // Max parallel tests
|
||||
});
|
||||
```
|
||||
|
||||
### Enhanced Assertions
|
||||
|
||||
The `expect` function is an enhanced wrapper around [@push.rocks/smartexpect](https://code.foss.global/push.rocks/smartexpect) that automatically generates diffs for failed assertions.
|
||||
|
||||
```typescript
|
||||
import { expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
tap.test('should compare objects', async () => {
|
||||
const actual = { name: 'John', age: 30 };
|
||||
const expected = { name: 'John', age: 31 };
|
||||
|
||||
// Will show a detailed diff of the differences
|
||||
expect(actual).toEqual(expected);
|
||||
});
|
||||
```
|
||||
|
||||
#### Available Assertions
|
||||
|
||||
```typescript
|
||||
// Equality
|
||||
expect(value).toEqual(expected);
|
||||
expect(value).toBe(expected);
|
||||
|
||||
// Truthiness
|
||||
expect(value).toBeTruthy();
|
||||
expect(value).toBeFalsy();
|
||||
|
||||
// Type checks
|
||||
expect(value).toBeType('string');
|
||||
|
||||
// Strings
|
||||
expect(string).toMatch(/pattern/);
|
||||
expect(string).toContain('substring');
|
||||
|
||||
// Arrays
|
||||
expect(array).toContain(item);
|
||||
|
||||
// Exceptions
|
||||
expect(fn).toThrow();
|
||||
expect(fn).toThrow('error message');
|
||||
|
||||
// Async
|
||||
await expect(promise).toResolve();
|
||||
await expect(promise).toReject();
|
||||
```
|
||||
|
||||
### Test Tagging and Filtering
|
||||
|
||||
Tag tests for selective execution:
|
||||
|
||||
```typescript
|
||||
// Define tests with tags
|
||||
tap.tags('integration', 'slow').test('complex test', async () => {
|
||||
// test code
|
||||
});
|
||||
|
||||
tap.tags('unit').test('fast test', async () => {
|
||||
// test code
|
||||
});
|
||||
```
|
||||
|
||||
Filter tests by setting the environment variable:
|
||||
|
||||
```bash
|
||||
TSTEST_FILTER_TAGS=unit tstest test/mytest.node.ts
|
||||
```
|
||||
|
||||
### TapTools
|
||||
|
||||
Each test receives a `tapTools` instance with utilities:
|
||||
|
||||
```typescript
|
||||
tap.test('should have utilities', async (tapTools) => {
|
||||
// Mark test as skipped
|
||||
tapTools.markAsSkipped('reason');
|
||||
|
||||
// Mark as todo
|
||||
tapTools.todo('not implemented');
|
||||
|
||||
// Configure retries
|
||||
tapTools.retry(3);
|
||||
|
||||
// Log test output
|
||||
tapTools.log('debug message');
|
||||
});
|
||||
```
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Pre-Tasks
|
||||
|
||||
Run setup tasks before any tests execute:
|
||||
|
||||
```typescript
|
||||
tap.preTask('setup database', async () => {
|
||||
// Runs before any tests
|
||||
});
|
||||
|
||||
tap.test('first test', async () => {
|
||||
// Database is ready
|
||||
});
|
||||
```
|
||||
|
||||
### Test Priority
|
||||
|
||||
Organize tests by priority level:
|
||||
|
||||
```typescript
|
||||
tap.priority('high').test('critical test', async () => { });
|
||||
tap.priority('medium').test('normal test', async () => { });
|
||||
tap.priority('low').test('optional test', async () => { });
|
||||
```
|
||||
|
||||
### Nested Suites
|
||||
|
||||
Create deeply nested test organization:
|
||||
|
||||
```typescript
|
||||
tap.describe('API', () => {
|
||||
tap.describe('Users', () => {
|
||||
tap.describe('GET /users', () => {
|
||||
tap.test('should return all users', async () => { });
|
||||
});
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
### Protocol Events
|
||||
|
||||
Access real-time test events for custom tooling:
|
||||
|
||||
```typescript
|
||||
import { setProtocolEmitter } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
// Get access to protocol emitter for custom event handling
|
||||
// Events: test:started, test:completed, assertion:failed, suite:started, suite:completed
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Always export `tap.start()`** at the end of test files:
|
||||
```typescript
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
2. **Use descriptive test names** that explain what is being tested:
|
||||
```typescript
|
||||
tap.test('should return 404 when user does not exist', async () => { });
|
||||
```
|
||||
|
||||
3. **Group related tests** with `describe()` blocks:
|
||||
```typescript
|
||||
tap.describe('User validation', () => {
|
||||
// All user validation tests
|
||||
});
|
||||
```
|
||||
|
||||
4. **Leverage lifecycle hooks** to reduce duplication:
|
||||
```typescript
|
||||
tap.beforeEach(async () => {
|
||||
// Common setup
|
||||
});
|
||||
```
|
||||
|
||||
5. **Tag tests appropriately** for flexible test execution:
|
||||
```typescript
|
||||
tap.tags('integration', 'database').test('...', async () => { });
|
||||
```
|
||||
|
||||
## TypeScript Support
|
||||
|
||||
tapbundle is written in TypeScript and provides full type definitions. The `Tap` class accepts a generic type for shared context:
|
||||
|
||||
```typescript
|
||||
interface MyTestContext {
|
||||
db: DatabaseConnection;
|
||||
user: User;
|
||||
}
|
||||
|
||||
const tap = new Tap<MyTestContext>();
|
||||
|
||||
tap.test('should use context', async (tapTools) => {
|
||||
// tapTools is typed with MyTestContext
|
||||
});
|
||||
```
|
||||
|
||||
## Legal
|
||||
|
||||
This project is licensed under MIT.
|
||||
|
||||
© 2025 Task Venture Capital GmbH. All rights reserved.
|
@@ -11,9 +11,9 @@ import { HrtMeasurement } from '@push.rocks/smarttime';
|
||||
// interfaces
|
||||
export type TTestStatus = 'success' | 'error' | 'pending' | 'errorAfterSuccess' | 'timeout' | 'skipped';
|
||||
|
||||
export interface ITestFunction<T> {
|
||||
(tapTools?: TapTools): Promise<T>;
|
||||
}
|
||||
export type ITestFunction<T> =
|
||||
| ((tapTools: TapTools) => Promise<T>)
|
||||
| (() => Promise<T>);
|
||||
|
||||
export class TapTest<T = unknown> {
|
||||
public description: string;
|
||||
@@ -173,7 +173,9 @@ export class TapTest<T = unknown> {
|
||||
}
|
||||
|
||||
// Run the test function with potential timeout
|
||||
const testPromise = this.testFunction(this.tapTools);
|
||||
const testPromise = this.testFunction.length === 0
|
||||
? (this.testFunction as () => Promise<T>)()
|
||||
: (this.testFunction as (tapTools: TapTools) => Promise<T>)(this.tapTools);
|
||||
const testReturnValue = timeoutPromise
|
||||
? await Promise.race([testPromise, timeoutPromise])
|
||||
: await testPromise;
|
||||
|
@@ -9,9 +9,12 @@ export class TestFileProvider {
|
||||
public async getDockerAlpineImageAsLocalTarball(): Promise<string> {
|
||||
const filePath = plugins.path.join(paths.testFilesDir, 'alpine.tar')
|
||||
// fetch the docker alpine image
|
||||
const response = await plugins.smartrequest.getBinary(fileUrls.dockerAlpineImage);
|
||||
const response = await plugins.smartrequest.SmartRequest.create()
|
||||
.url(fileUrls.dockerAlpineImage)
|
||||
.get();
|
||||
await plugins.smartfile.fs.ensureDir(paths.testFilesDir);
|
||||
await plugins.smartfile.memory.toFs(response.body, filePath);
|
||||
const buffer = Buffer.from(await response.arrayBuffer());
|
||||
await plugins.smartfile.memory.toFs(buffer, filePath);
|
||||
return filePath;
|
||||
}
|
||||
}
|
367
ts_tapbundle_node/readme.md
Normal file
367
ts_tapbundle_node/readme.md
Normal file
@@ -0,0 +1,367 @@
|
||||
# @git.zone/tstest/tapbundle_node
|
||||
|
||||
> 🔧 Node.js-specific testing utilities for enhanced test capabilities
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# tapbundle_node is included as part of @git.zone/tstest
|
||||
pnpm install --save-dev @git.zone/tstest
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
## Key Features
|
||||
|
||||
- 🔐 **Environment Variables** - On-demand environment variable loading with qenv
|
||||
- 💻 **Shell Commands** - Execute bash commands during tests
|
||||
- 🔒 **HTTPS Certificates** - Generate self-signed certificates for testing
|
||||
- 🗄️ **MongoDB Testing** - Create ephemeral MongoDB instances
|
||||
- 📦 **S3 Storage Testing** - Create local S3-compatible storage for tests
|
||||
- 📁 **Test File Management** - Download and manage test assets
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```typescript
|
||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
||||
import { tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
tap.test('should use node-specific tools', async () => {
|
||||
// Use Node.js-specific utilities
|
||||
const result = await tapNodeTools.runCommand('echo "hello"');
|
||||
console.log(result);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
### tapNodeTools
|
||||
|
||||
The main singleton instance providing all Node.js-specific utilities.
|
||||
|
||||
#### Environment Variables
|
||||
|
||||
##### `getQenv()`
|
||||
|
||||
Get the qenv instance for managing environment variables from `.nogit/` directory.
|
||||
|
||||
```typescript
|
||||
const qenv = await tapNodeTools.getQenv();
|
||||
// qenv will load from .env files in .nogit/ directory
|
||||
```
|
||||
|
||||
##### `getEnvVarOnDemand(envVarName)`
|
||||
|
||||
Request an environment variable. If not available, qenv will prompt for it and store it securely.
|
||||
|
||||
```typescript
|
||||
tap.test('should get API key', async () => {
|
||||
const apiKey = await tapNodeTools.getEnvVarOnDemand('GITHUB_API_KEY');
|
||||
// If GITHUB_API_KEY is not set, qenv will prompt for it
|
||||
// The value is stored in .nogit/.env for future use
|
||||
});
|
||||
```
|
||||
|
||||
**Use Cases:**
|
||||
- API keys for integration tests
|
||||
- Database credentials
|
||||
- Service endpoints
|
||||
- Any sensitive configuration needed for testing
|
||||
|
||||
#### Shell Commands
|
||||
|
||||
##### `runCommand(command)`
|
||||
|
||||
Execute a bash command and return the result.
|
||||
|
||||
```typescript
|
||||
tap.test('should execute shell commands', async () => {
|
||||
const result = await tapNodeTools.runCommand('ls -la');
|
||||
console.log(result.stdout);
|
||||
});
|
||||
```
|
||||
|
||||
**Use Cases:**
|
||||
- Setup test environment
|
||||
- Execute CLI tools
|
||||
- File system operations
|
||||
- Process management
|
||||
|
||||
#### HTTPS Certificates
|
||||
|
||||
##### `createHttpsCert(commonName?, allowSelfSigned?)`
|
||||
|
||||
Generate a self-signed HTTPS certificate for testing secure connections.
|
||||
|
||||
```typescript
|
||||
tap.test('should create HTTPS server', async () => {
|
||||
const { key, cert } = await tapNodeTools.createHttpsCert('localhost', true);
|
||||
|
||||
// Use with Node.js https module
|
||||
const server = https.createServer({ key, cert }, (req, res) => {
|
||||
res.end('Hello Secure World');
|
||||
});
|
||||
|
||||
server.listen(3000);
|
||||
});
|
||||
```
|
||||
|
||||
**Parameters:**
|
||||
- `commonName` (optional): Certificate common name, default: 'localhost'
|
||||
- `allowSelfSigned` (optional): Allow self-signed certificates by setting `NODE_TLS_REJECT_UNAUTHORIZED=0`, default: true
|
||||
|
||||
**Returns:**
|
||||
- `key`: PEM-encoded private key
|
||||
- `cert`: PEM-encoded certificate
|
||||
|
||||
**Use Cases:**
|
||||
- Testing HTTPS servers
|
||||
- Testing secure WebSocket connections
|
||||
- Testing certificate validation logic
|
||||
- Mocking secure external services
|
||||
|
||||
#### Database Testing
|
||||
|
||||
##### `createSmartmongo()`
|
||||
|
||||
Create an ephemeral MongoDB instance for testing. Automatically started and ready to use.
|
||||
|
||||
```typescript
|
||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
||||
|
||||
tap.test('should use MongoDB', async () => {
|
||||
const mongoInstance = await tapNodeTools.createSmartmongo();
|
||||
|
||||
// Use the MongoDB instance
|
||||
const db = await mongoInstance.getDatabase('testdb');
|
||||
const collection = await db.getCollection('users');
|
||||
|
||||
await collection.insertOne({ name: 'Alice', age: 30 });
|
||||
const user = await collection.findOne({ name: 'Alice' });
|
||||
|
||||
expect(user.age).toEqual(30);
|
||||
|
||||
// Cleanup (optional - instance will be cleaned up automatically)
|
||||
await mongoInstance.stop();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
**Features:**
|
||||
- Ephemeral instance (starts fresh)
|
||||
- Automatic cleanup
|
||||
- Full MongoDB API via [@push.rocks/smartmongo](https://code.foss.global/push.rocks/smartmongo)
|
||||
|
||||
**Use Cases:**
|
||||
- Testing database operations
|
||||
- Integration tests with MongoDB
|
||||
- Testing data models
|
||||
- Schema validation tests
|
||||
|
||||
#### Storage Testing
|
||||
|
||||
##### `createSmarts3()`
|
||||
|
||||
Create a local S3-compatible storage instance for testing object storage operations.
|
||||
|
||||
```typescript
|
||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
||||
|
||||
tap.test('should use S3 storage', async () => {
|
||||
const s3Instance = await tapNodeTools.createSmarts3();
|
||||
|
||||
// Use the S3 instance (MinIO-compatible API)
|
||||
const bucket = await s3Instance.createBucket('test-bucket');
|
||||
await bucket.putObject('file.txt', Buffer.from('Hello S3'));
|
||||
const file = await bucket.getObject('file.txt');
|
||||
|
||||
expect(file.toString()).toEqual('Hello S3');
|
||||
|
||||
// Cleanup
|
||||
await s3Instance.stop();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
**Configuration:**
|
||||
- Port: 3003 (default)
|
||||
- Clean slate: true (starts fresh each time)
|
||||
- Full S3-compatible API via [@push.rocks/smarts3](https://code.foss.global/push.rocks/smarts3)
|
||||
|
||||
**Use Cases:**
|
||||
- Testing file uploads/downloads
|
||||
- Testing object storage operations
|
||||
- Testing backup/restore logic
|
||||
- Mocking cloud storage
|
||||
|
||||
### TestFileProvider
|
||||
|
||||
Utility for downloading and managing test assets.
|
||||
|
||||
#### `getDockerAlpineImageAsLocalTarball()`
|
||||
|
||||
Download the Alpine Linux Docker image as a tarball for testing.
|
||||
|
||||
```typescript
|
||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
||||
|
||||
tap.test('should provide docker image', async () => {
|
||||
const tarballPath = await tapNodeTools.testFileProvider.getDockerAlpineImageAsLocalTarball();
|
||||
|
||||
// Use the tarball path
|
||||
// Path: ./.nogit/testfiles/alpine.tar
|
||||
|
||||
expect(tarballPath).toMatch(/alpine\.tar$/);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
**Features:**
|
||||
- Downloads from https://code.foss.global/testassets/docker
|
||||
- Caches in `.nogit/testfiles/` directory
|
||||
- Returns local file path
|
||||
|
||||
**Use Cases:**
|
||||
- Testing Docker operations
|
||||
- Testing container deployment
|
||||
- Testing image handling logic
|
||||
|
||||
### Path Utilities
|
||||
|
||||
The module exports useful path constants:
|
||||
|
||||
```typescript
|
||||
import * as paths from '@git.zone/tstest/tapbundle_node/paths';
|
||||
|
||||
console.log(paths.cwd); // Current working directory
|
||||
console.log(paths.testFilesDir); // ./.nogit/testfiles/
|
||||
```
|
||||
|
||||
## Patterns and Best Practices
|
||||
|
||||
### Testing with External Services
|
||||
|
||||
```typescript
|
||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
tap.describe('User Service Integration', () => {
|
||||
let mongoInstance;
|
||||
let db;
|
||||
|
||||
tap.beforeEach(async () => {
|
||||
mongoInstance = await tapNodeTools.createSmartmongo();
|
||||
db = await mongoInstance.getDatabase('testdb');
|
||||
});
|
||||
|
||||
tap.test('should create user', async () => {
|
||||
const users = await db.getCollection('users');
|
||||
await users.insertOne({ name: 'Bob', email: 'bob@example.com' });
|
||||
|
||||
const user = await users.findOne({ name: 'Bob' });
|
||||
expect(user.email).toEqual('bob@example.com');
|
||||
});
|
||||
|
||||
tap.afterEach(async () => {
|
||||
await mongoInstance.stop();
|
||||
});
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
### Testing HTTPS Servers
|
||||
|
||||
```typescript
|
||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
import * as https from 'https';
|
||||
|
||||
tap.test('should serve over HTTPS', async () => {
|
||||
const { key, cert } = await tapNodeTools.createHttpsCert();
|
||||
|
||||
const server = https.createServer({ key, cert }, (req, res) => {
|
||||
res.writeHead(200, { 'Content-Type': 'text/plain' });
|
||||
res.end('Secure Response');
|
||||
});
|
||||
|
||||
await new Promise((resolve) => {
|
||||
server.listen(8443, () => resolve(undefined));
|
||||
});
|
||||
|
||||
// Test the server
|
||||
const response = await fetch('https://localhost:8443');
|
||||
const text = await response.text();
|
||||
expect(text).toEqual('Secure Response');
|
||||
|
||||
// Cleanup
|
||||
server.close();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
### Environment-Dependent Tests
|
||||
|
||||
```typescript
|
||||
import { tapNodeTools } from '@git.zone/tstest/tapbundle_node';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
tap.test('should authenticate with GitHub', async () => {
|
||||
const githubToken = await tapNodeTools.getEnvVarOnDemand('GITHUB_TOKEN');
|
||||
|
||||
// Use the token for API calls
|
||||
const response = await fetch('https://api.github.com/user', {
|
||||
headers: {
|
||||
Authorization: `Bearer ${githubToken}`
|
||||
}
|
||||
});
|
||||
|
||||
expect(response.ok).toBeTruthy();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
```
|
||||
|
||||
## Runtime Requirements
|
||||
|
||||
⚠️ **Node.js Only**: All utilities in this module require Node.js runtime. They will not work in:
|
||||
- Browser environments
|
||||
- Deno runtime
|
||||
- Bun runtime
|
||||
|
||||
For multi-runtime tests, use these utilities only in `.node.ts` test files.
|
||||
|
||||
## File Naming
|
||||
|
||||
Use Node.js-specific file naming when using these utilities:
|
||||
|
||||
```
|
||||
test/mytest.node.ts ✅ Node.js only
|
||||
test/mytest.node+deno.ts ❌ Will fail in Deno
|
||||
test/mytest.browser+node.ts ⚠️ Browser won't have access to these tools
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
This module uses the following packages:
|
||||
- [@push.rocks/qenv](https://code.foss.global/push.rocks/qenv) - Environment variable management
|
||||
- [@push.rocks/smartshell](https://code.foss.global/push.rocks/smartshell) - Shell command execution
|
||||
- [@push.rocks/smartcrypto](https://code.foss.global/push.rocks/smartcrypto) - Certificate generation
|
||||
- [@push.rocks/smartmongo](https://code.foss.global/push.rocks/smartmongo) - MongoDB testing
|
||||
- [@push.rocks/smarts3](https://code.foss.global/push.rocks/smarts3) - S3 storage testing
|
||||
- [@push.rocks/smartfile](https://code.foss.global/push.rocks/smartfile) - File operations
|
||||
- [@push.rocks/smartrequest](https://code.foss.global/push.rocks/smartrequest) - HTTP requests
|
||||
|
||||
## Legal
|
||||
|
||||
This project is licensed under MIT.
|
||||
|
||||
© 2025 Task Venture Capital GmbH. All rights reserved.
|
587
ts_tapbundle_protocol/readme.md
Normal file
587
ts_tapbundle_protocol/readme.md
Normal file
@@ -0,0 +1,587 @@
|
||||
# @git.zone/tstest/tapbundle_protocol
|
||||
|
||||
> 📡 Enhanced TAP Protocol V2 implementation for structured test communication
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# tapbundle_protocol is included as part of @git.zone/tstest
|
||||
pnpm install --save-dev @git.zone/tstest
|
||||
```
|
||||
|
||||
## Overview
|
||||
|
||||
`@git.zone/tstest/tapbundle_protocol` implements Protocol V2, an enhanced version of the Test Anything Protocol (TAP) with support for structured metadata, real-time events, error diffs, and isomorphic operation. This protocol enables rich communication between test runners and test consumers while maintaining backward compatibility with standard TAP parsers.
|
||||
|
||||
## Key Features
|
||||
|
||||
- 📋 **TAP v13 Compliant** - Fully compatible with standard TAP consumers
|
||||
- 🎯 **Enhanced Metadata** - Timing, tags, errors, diffs, and custom data
|
||||
- 🔄 **Real-time Events** - Live test execution updates
|
||||
- 🔍 **Structured Errors** - JSON error blocks with stack traces and diffs
|
||||
- 📸 **Snapshot Support** - Built-in snapshot testing protocol
|
||||
- 🌐 **Isomorphic** - Works in Node.js, browsers, Deno, and Bun
|
||||
- 🏷️ **Protocol Markers** - Structured data using Unicode delimiters
|
||||
|
||||
## Protocol V2 Format
|
||||
|
||||
### Protocol Markers
|
||||
|
||||
Protocol V2 uses special Unicode markers to embed structured data within TAP output:
|
||||
|
||||
- `⟦TSTEST:` - Start marker
|
||||
- `⟧` - End marker
|
||||
|
||||
These markers allow structured data to coexist with standard TAP without breaking compatibility.
|
||||
|
||||
### Example Output
|
||||
|
||||
```tap
|
||||
⟦TSTEST:PROTOCOL:2.0.0⟧
|
||||
TAP version 13
|
||||
1..3
|
||||
ok 1 - should add numbers ⟦TSTEST:time:42⟧
|
||||
not ok 2 - should validate input
|
||||
⟦TSTEST:META:{"time":156,"file":"test.ts","line":42}⟧
|
||||
⟦TSTEST:ERROR⟧
|
||||
{
|
||||
"error": {
|
||||
"message": "Expected 5 to equal 6",
|
||||
"diff": {...}
|
||||
}
|
||||
}
|
||||
⟦TSTEST:/ERROR⟧
|
||||
ok 3 - should handle edge cases # SKIP not implemented ⟦TSTEST:SKIP:not implemented⟧
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
### ProtocolEmitter
|
||||
|
||||
Generates Protocol V2 messages. Used by tapbundle to emit test results.
|
||||
|
||||
#### `emitProtocolHeader()`
|
||||
|
||||
Emit the protocol version header.
|
||||
|
||||
```typescript
|
||||
import { ProtocolEmitter } from '@git.zone/tstest/tapbundle_protocol';
|
||||
|
||||
const emitter = new ProtocolEmitter();
|
||||
console.log(emitter.emitProtocolHeader());
|
||||
// Output: ⟦TSTEST:PROTOCOL:2.0.0⟧
|
||||
```
|
||||
|
||||
#### `emitTapVersion(version?)`
|
||||
|
||||
Emit TAP version line.
|
||||
|
||||
```typescript
|
||||
console.log(emitter.emitTapVersion(13));
|
||||
// Output: TAP version 13
|
||||
```
|
||||
|
||||
#### `emitPlan(plan)`
|
||||
|
||||
Emit test plan.
|
||||
|
||||
```typescript
|
||||
console.log(emitter.emitPlan({ start: 1, end: 5 }));
|
||||
// Output: 1..5
|
||||
|
||||
console.log(emitter.emitPlan({ start: 1, end: 0, skipAll: 'Not ready' }));
|
||||
// Output: 1..0 # Skipped: Not ready
|
||||
```
|
||||
|
||||
#### `emitTest(result)`
|
||||
|
||||
Emit a test result with optional metadata.
|
||||
|
||||
```typescript
|
||||
const lines = emitter.emitTest({
|
||||
ok: true,
|
||||
testNumber: 1,
|
||||
description: 'should work correctly',
|
||||
metadata: {
|
||||
time: 45,
|
||||
tags: ['unit', 'fast']
|
||||
}
|
||||
});
|
||||
|
||||
lines.forEach(line => console.log(line));
|
||||
// Output:
|
||||
// ok 1 - should work correctly ⟦TSTEST:time:45⟧
|
||||
// ⟦TSTEST:META:{"tags":["unit","fast"]}⟧
|
||||
```
|
||||
|
||||
#### `emitComment(comment)`
|
||||
|
||||
Emit a comment line.
|
||||
|
||||
```typescript
|
||||
console.log(emitter.emitComment('Setup complete'));
|
||||
// Output: # Setup complete
|
||||
```
|
||||
|
||||
#### `emitBailout(reason)`
|
||||
|
||||
Emit a bailout (abort all tests).
|
||||
|
||||
```typescript
|
||||
console.log(emitter.emitBailout('Database connection failed'));
|
||||
// Output: Bail out! Database connection failed
|
||||
```
|
||||
|
||||
#### `emitError(error)`
|
||||
|
||||
Emit a structured error block.
|
||||
|
||||
```typescript
|
||||
const lines = emitter.emitError({
|
||||
testNumber: 2,
|
||||
error: {
|
||||
message: 'Expected 5 to equal 6',
|
||||
stack: 'Error: ...',
|
||||
actual: 5,
|
||||
expected: 6,
|
||||
diff: '...'
|
||||
}
|
||||
});
|
||||
|
||||
lines.forEach(line => console.log(line));
|
||||
// Output:
|
||||
// ⟦TSTEST:ERROR⟧
|
||||
// {
|
||||
// "testNumber": 2,
|
||||
// "error": { ... }
|
||||
// }
|
||||
// ⟦TSTEST:/ERROR⟧
|
||||
```
|
||||
|
||||
#### `emitEvent(event)`
|
||||
|
||||
Emit a real-time test event.
|
||||
|
||||
```typescript
|
||||
console.log(emitter.emitEvent({
|
||||
eventType: 'test:started',
|
||||
timestamp: Date.now(),
|
||||
data: {
|
||||
testNumber: 1,
|
||||
description: 'should work'
|
||||
}
|
||||
}));
|
||||
// Output: ⟦TSTEST:EVENT:{"eventType":"test:started",...}⟧
|
||||
```
|
||||
|
||||
#### `emitSnapshot(snapshot)`
|
||||
|
||||
Emit snapshot data.
|
||||
|
||||
```typescript
|
||||
const lines = emitter.emitSnapshot({
|
||||
name: 'user-data',
|
||||
content: { name: 'Alice', age: 30 },
|
||||
format: 'json'
|
||||
});
|
||||
|
||||
lines.forEach(line => console.log(line));
|
||||
// Output:
|
||||
// ⟦TSTEST:SNAPSHOT:user-data⟧
|
||||
// {
|
||||
// "name": "Alice",
|
||||
// "age": 30
|
||||
// }
|
||||
// ⟦TSTEST:/SNAPSHOT⟧
|
||||
```
|
||||
|
||||
### ProtocolParser
|
||||
|
||||
Parses Protocol V2 messages. Used by tstest to consume test results.
|
||||
|
||||
#### `parseLine(line)`
|
||||
|
||||
Parse a single line and return protocol messages.
|
||||
|
||||
```typescript
|
||||
import { ProtocolParser } from '@git.zone/tstest/tapbundle_protocol';
|
||||
|
||||
const parser = new ProtocolParser();
|
||||
|
||||
const messages = parser.parseLine('ok 1 - test passed ⟦TSTEST:time:42⟧');
|
||||
console.log(messages);
|
||||
// Output:
|
||||
// [{
|
||||
// type: 'test',
|
||||
// content: {
|
||||
// ok: true,
|
||||
// testNumber: 1,
|
||||
// description: 'test passed',
|
||||
// metadata: { time: 42 }
|
||||
// }
|
||||
// }]
|
||||
```
|
||||
|
||||
#### Message Types
|
||||
|
||||
The parser returns different message types:
|
||||
|
||||
```typescript
|
||||
interface IProtocolMessage {
|
||||
type: 'test' | 'plan' | 'comment' | 'version' | 'bailout' | 'protocol' | 'snapshot' | 'error' | 'event';
|
||||
content: any;
|
||||
}
|
||||
```
|
||||
|
||||
**Examples:**
|
||||
|
||||
```typescript
|
||||
// Test result
|
||||
{
|
||||
type: 'test',
|
||||
content: {
|
||||
ok: true,
|
||||
testNumber: 1,
|
||||
description: 'test name',
|
||||
metadata: { ... }
|
||||
}
|
||||
}
|
||||
|
||||
// Plan
|
||||
{
|
||||
type: 'plan',
|
||||
content: {
|
||||
start: 1,
|
||||
end: 5
|
||||
}
|
||||
}
|
||||
|
||||
// Event
|
||||
{
|
||||
type: 'event',
|
||||
content: {
|
||||
eventType: 'test:started',
|
||||
timestamp: 1234567890,
|
||||
data: { ... }
|
||||
}
|
||||
}
|
||||
|
||||
// Error
|
||||
{
|
||||
type: 'error',
|
||||
content: {
|
||||
testNumber: 2,
|
||||
error: {
|
||||
message: '...',
|
||||
stack: '...',
|
||||
diff: '...'
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### `getProtocolVersion()`
|
||||
|
||||
Get the detected protocol version.
|
||||
|
||||
```typescript
|
||||
const version = parser.getProtocolVersion();
|
||||
console.log(version); // "2.0.0" or null
|
||||
```
|
||||
|
||||
## TypeScript Types
|
||||
|
||||
### ITestResult
|
||||
|
||||
```typescript
|
||||
interface ITestResult {
|
||||
ok: boolean;
|
||||
testNumber: number;
|
||||
description: string;
|
||||
directive?: {
|
||||
type: 'skip' | 'todo';
|
||||
reason?: string;
|
||||
};
|
||||
metadata?: ITestMetadata;
|
||||
}
|
||||
```
|
||||
|
||||
### ITestMetadata
|
||||
|
||||
```typescript
|
||||
interface ITestMetadata {
|
||||
// Timing
|
||||
time?: number; // Test duration in milliseconds
|
||||
startTime?: number; // Unix timestamp
|
||||
endTime?: number; // Unix timestamp
|
||||
|
||||
// Status
|
||||
skip?: string; // Skip reason
|
||||
todo?: string; // Todo reason
|
||||
retry?: number; // Current retry attempt
|
||||
maxRetries?: number; // Max retries allowed
|
||||
|
||||
// Error details
|
||||
error?: {
|
||||
message: string;
|
||||
stack?: string;
|
||||
diff?: string;
|
||||
actual?: any;
|
||||
expected?: any;
|
||||
code?: string;
|
||||
};
|
||||
|
||||
// Test context
|
||||
file?: string; // Source file path
|
||||
line?: number; // Line number
|
||||
column?: number; // Column number
|
||||
|
||||
// Custom data
|
||||
tags?: string[]; // Test tags
|
||||
custom?: Record<string, any>;
|
||||
}
|
||||
```
|
||||
|
||||
### ITestEvent
|
||||
|
||||
```typescript
|
||||
interface ITestEvent {
|
||||
eventType: EventType;
|
||||
timestamp: number;
|
||||
data: {
|
||||
testNumber?: number;
|
||||
description?: string;
|
||||
suiteName?: string;
|
||||
hookName?: string;
|
||||
progress?: number; // 0-100
|
||||
duration?: number;
|
||||
error?: IEnhancedError;
|
||||
[key: string]: any;
|
||||
};
|
||||
}
|
||||
|
||||
type EventType =
|
||||
| 'test:queued'
|
||||
| 'test:started'
|
||||
| 'test:progress'
|
||||
| 'test:completed'
|
||||
| 'suite:started'
|
||||
| 'suite:completed'
|
||||
| 'hook:started'
|
||||
| 'hook:completed'
|
||||
| 'assertion:failed';
|
||||
```
|
||||
|
||||
### IEnhancedError
|
||||
|
||||
```typescript
|
||||
interface IEnhancedError {
|
||||
message: string;
|
||||
stack?: string;
|
||||
diff?: IDiffResult;
|
||||
actual?: any;
|
||||
expected?: any;
|
||||
code?: string;
|
||||
type?: 'assertion' | 'timeout' | 'uncaught' | 'syntax' | 'runtime';
|
||||
}
|
||||
```
|
||||
|
||||
### IDiffResult
|
||||
|
||||
```typescript
|
||||
interface IDiffResult {
|
||||
type: 'string' | 'object' | 'array' | 'primitive';
|
||||
changes: IDiffChange[];
|
||||
context?: number; // Lines of context
|
||||
}
|
||||
|
||||
interface IDiffChange {
|
||||
type: 'add' | 'remove' | 'modify';
|
||||
path?: string[]; // For object/array diffs
|
||||
oldValue?: any;
|
||||
newValue?: any;
|
||||
line?: number; // For string diffs
|
||||
content?: string;
|
||||
}
|
||||
```
|
||||
|
||||
## Protocol Constants
|
||||
|
||||
```typescript
|
||||
import { PROTOCOL_MARKERS, PROTOCOL_VERSION } from '@git.zone/tstest/tapbundle_protocol';
|
||||
|
||||
console.log(PROTOCOL_VERSION); // "2.0.0"
|
||||
console.log(PROTOCOL_MARKERS.START); // "⟦TSTEST:"
|
||||
console.log(PROTOCOL_MARKERS.END); // "⟧"
|
||||
```
|
||||
|
||||
### Available Markers
|
||||
|
||||
```typescript
|
||||
const PROTOCOL_MARKERS = {
|
||||
START: '⟦TSTEST:',
|
||||
END: '⟧',
|
||||
META_PREFIX: 'META:',
|
||||
ERROR_PREFIX: 'ERROR',
|
||||
ERROR_END: '/ERROR',
|
||||
SNAPSHOT_PREFIX: 'SNAPSHOT:',
|
||||
SNAPSHOT_END: '/SNAPSHOT',
|
||||
PROTOCOL_PREFIX: 'PROTOCOL:',
|
||||
SKIP_PREFIX: 'SKIP:',
|
||||
TODO_PREFIX: 'TODO:',
|
||||
EVENT_PREFIX: 'EVENT:',
|
||||
};
|
||||
```
|
||||
|
||||
## Usage Patterns
|
||||
|
||||
### Creating a Custom Test Runner
|
||||
|
||||
```typescript
|
||||
import { ProtocolEmitter } from '@git.zone/tstest/tapbundle_protocol';
|
||||
|
||||
const emitter = new ProtocolEmitter();
|
||||
|
||||
// Emit protocol header
|
||||
console.log(emitter.emitProtocolHeader());
|
||||
console.log(emitter.emitTapVersion(13));
|
||||
|
||||
// Emit plan
|
||||
console.log(emitter.emitPlan({ start: 1, end: 2 }));
|
||||
|
||||
// Run test 1
|
||||
emitter.emitEvent({
|
||||
eventType: 'test:started',
|
||||
timestamp: Date.now(),
|
||||
data: { testNumber: 1 }
|
||||
}).split('\n').forEach(line => console.log(line));
|
||||
|
||||
const result1 = emitter.emitTest({
|
||||
ok: true,
|
||||
testNumber: 1,
|
||||
description: 'first test',
|
||||
metadata: { time: 45 }
|
||||
});
|
||||
result1.forEach(line => console.log(line));
|
||||
|
||||
// Run test 2
|
||||
const result2 = emitter.emitTest({
|
||||
ok: false,
|
||||
testNumber: 2,
|
||||
description: 'second test',
|
||||
metadata: {
|
||||
time: 120,
|
||||
error: {
|
||||
message: 'Assertion failed',
|
||||
actual: 5,
|
||||
expected: 6
|
||||
}
|
||||
}
|
||||
});
|
||||
result2.forEach(line => console.log(line));
|
||||
```
|
||||
|
||||
### Parsing Test Output
|
||||
|
||||
```typescript
|
||||
import { ProtocolParser } from '@git.zone/tstest/tapbundle_protocol';
|
||||
import * as readline from 'readline';
|
||||
|
||||
const parser = new ProtocolParser();
|
||||
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: process.stdout
|
||||
});
|
||||
|
||||
rl.on('line', (line) => {
|
||||
const messages = parser.parseLine(line);
|
||||
|
||||
messages.forEach(message => {
|
||||
switch (message.type) {
|
||||
case 'test':
|
||||
console.log(`Test ${message.content.testNumber}: ${message.content.ok ? 'PASS' : 'FAIL'}`);
|
||||
break;
|
||||
case 'event':
|
||||
console.log(`Event: ${message.content.eventType}`);
|
||||
break;
|
||||
case 'error':
|
||||
console.error(`Error: ${message.content.error.message}`);
|
||||
break;
|
||||
}
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
### Building Test Dashboards
|
||||
|
||||
Real-time events enable building live test dashboards:
|
||||
|
||||
```typescript
|
||||
const parser = new ProtocolParser();
|
||||
|
||||
parser.parseLine(line).forEach(message => {
|
||||
if (message.type === 'event') {
|
||||
const event = message.content;
|
||||
|
||||
switch (event.eventType) {
|
||||
case 'test:started':
|
||||
updateUI({ status: 'running', test: event.data.description });
|
||||
break;
|
||||
case 'test:completed':
|
||||
updateUI({ status: 'done', duration: event.data.duration });
|
||||
break;
|
||||
case 'suite:started':
|
||||
createSuiteCard(event.data.suiteName);
|
||||
break;
|
||||
}
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
## Backward Compatibility
|
||||
|
||||
Protocol V2 is fully backward compatible with standard TAP parsers:
|
||||
|
||||
- Protocol markers use Unicode characters that TAP parsers ignore
|
||||
- Standard TAP output (ok/not ok, plan, comments) works everywhere
|
||||
- Enhanced features gracefully degrade in standard TAP consumers
|
||||
|
||||
**Standard TAP View:**
|
||||
```tap
|
||||
TAP version 13
|
||||
1..3
|
||||
ok 1 - should add numbers
|
||||
not ok 2 - should validate input
|
||||
ok 3 - should handle edge cases # SKIP not implemented
|
||||
```
|
||||
|
||||
**Protocol V2 View (same output):**
|
||||
```tap
|
||||
⟦TSTEST:PROTOCOL:2.0.0⟧
|
||||
TAP version 13
|
||||
1..3
|
||||
ok 1 - should add numbers ⟦TSTEST:time:42⟧
|
||||
not ok 2 - should validate input
|
||||
⟦TSTEST:META:{"time":156}⟧
|
||||
ok 3 - should handle edge cases # SKIP not implemented ⟦TSTEST:SKIP:not implemented⟧
|
||||
```
|
||||
|
||||
## Isomorphic Design
|
||||
|
||||
This module works in all JavaScript environments:
|
||||
|
||||
- ✅ Node.js
|
||||
- ✅ Browsers (via tapbundle)
|
||||
- ✅ Deno
|
||||
- ✅ Bun
|
||||
- ✅ Web Workers
|
||||
- ✅ Service Workers
|
||||
|
||||
No runtime-specific APIs are used, making it truly portable.
|
||||
|
||||
## Legal
|
||||
|
||||
This project is licensed under MIT.
|
||||
|
||||
© 2025 Task Venture Capital GmbH. All rights reserved.
|
Reference in New Issue
Block a user