Compare commits

...

72 Commits

Author SHA1 Message Date
dc0f859fad 1.2.0 2025-05-15 16:39:46 +00:00
78ffad2f7d feat(logging): Improve logging output, CLI option parsing, and test report formatting. 2025-05-15 16:39:46 +00:00
3fc4cee2b1 1.1.0 2025-05-15 14:37:55 +00:00
a57edeef64 feat(cli): Enhance test discovery with support for single file and glob pattern execution using improved CLI argument detection 2025-05-15 14:37:55 +00:00
1f73751a8c 1.0.96 2025-01-23 20:03:53 +01:00
90741ed917 fix(TsTest): Fixed improper type-check for promise-like testModule defaults 2025-01-23 20:03:52 +01:00
962fa2cd4d 1.0.95 2025-01-23 19:56:56 +01:00
c085a20a4f fix(core): Fix delay handling in Chrome test execution 2025-01-23 19:56:56 +01:00
1f355a10a1 1.0.94 2025-01-23 19:25:14 +01:00
a73ce99564 fix(TsTest): Fix test module execution by ensuring promise resolution delay 2025-01-23 19:25:13 +01:00
64f825091d 1.0.93 2025-01-23 19:20:12 +01:00
5ddc2d2de0 fix(tstest): Handle globalThis.tapPromise in browser runtime evaluation 2025-01-23 19:20:11 +01:00
85fec03878 1.0.92 2025-01-23 19:13:40 +01:00
61c3226156 fix(core): Improve error logging for test modules without default promise 2025-01-23 19:13:40 +01:00
f0bf778810 1.0.91 2025-01-23 19:02:11 +01:00
a8e9f67810 fix(core): Refactored tstest class to enhance promise handling for test modules. 2025-01-23 19:02:11 +01:00
4cce132472 1.0.90 2024-04-18 20:50:46 +02:00
dc250804f5 fix(core): update 2024-04-18 20:50:45 +02:00
9669445646 1.0.89 2024-04-18 20:47:26 +02:00
928d9d0616 fix(core): update 2024-04-18 20:47:25 +02:00
3655b2f734 1.0.88 2024-03-07 13:17:29 +01:00
6712ff6b07 fix(core): update 2024-03-07 13:17:28 +01:00
ef5efc0a93 1.0.87 2024-03-07 13:10:58 +01:00
f305547116 fix(core): update 2024-03-07 13:10:57 +01:00
033a0a806c 1.0.86 2024-01-19 20:59:02 +01:00
7f87c24ad8 fix(core): update 2024-01-19 20:59:01 +01:00
ac08bdffe5 1.0.85 2023-11-10 12:44:08 +01:00
eb64cb4f71 fix(core): update 2023-11-10 12:44:08 +01:00
3b56c6ce9f 1.0.84 2023-11-09 21:06:07 +01:00
722d777f80 fix(core): update 2023-11-09 21:06:06 +01:00
f1a0455662 1.0.83 2023-11-09 19:00:54 +01:00
3c62129e02 fix(core): update 2023-11-09 19:00:53 +01:00
ac5e036967 1.0.82 2023-11-09 17:55:27 +01:00
6ccd0281b9 fix(core): update 2023-11-09 17:55:26 +01:00
d0f85b026f 1.0.81 2023-09-09 23:22:07 +02:00
4376cafabb fix(core): update 2023-09-09 23:22:06 +02:00
1a6e449b8d 1.0.80 2023-08-26 15:42:19 +02:00
6ec99e7276 fix(core): update 2023-08-26 15:42:18 +02:00
e958417d47 1.0.79 2023-08-26 14:54:44 +02:00
24416c1b5c fix(core): update 2023-08-26 14:54:44 +02:00
d6c8fcc1cf 1.0.78 2023-08-26 14:39:48 +02:00
53bb97c6db fix(core): update 2023-08-26 14:39:47 +02:00
4f35b101ec 1.0.77 2023-07-13 09:42:18 +02:00
549ae53a00 fix(core): update 2023-07-13 09:42:18 +02:00
d9aa2984ef 1.0.76 2023-07-13 03:19:12 +02:00
37e6d94c9f fix(core): update 2023-07-13 03:19:11 +02:00
74e1df6824 1.0.75 2022-11-08 08:04:46 +01:00
6eb86c63c3 fix(core): update 2022-11-08 08:04:46 +01:00
e919a4a2e9 1.0.74 2022-11-08 08:03:17 +01:00
85f6703696 fix(core): update 2022-11-08 08:03:17 +01:00
4c2812f671 1.0.73 2022-08-03 19:48:20 +02:00
bab93448e8 fix(core): update 2022-08-03 19:48:19 +02:00
3db913eb59 1.0.72 2022-07-24 14:11:18 +02:00
28e0c32944 fix(core): update 2022-07-24 14:11:17 +02:00
0be6b3400a 1.0.71 2022-05-04 18:58:36 +02:00
eeba113e09 fix(core): update 2022-05-04 18:58:35 +02:00
19e45b305c 1.0.70 2022-03-25 01:30:34 +01:00
f9f4150cff fix(core): update 2022-03-25 01:30:33 +01:00
710548911e 1.0.69 2022-03-17 12:24:40 +01:00
23f9a28fa0 fix(core): update 2022-03-17 12:24:40 +01:00
e1d2f1fd68 1.0.68 2022-03-16 12:28:50 +01:00
3116c5a818 fix(core): update 2022-03-16 12:28:50 +01:00
568772734b 1.0.67 2022-03-14 11:49:39 +01:00
30525e7e55 fix(core): update 2022-03-14 11:49:38 +01:00
f7483ef995 1.0.66 2022-03-13 00:40:22 +01:00
1460f97c52 fix(core): update 2022-03-13 00:40:21 +01:00
dfac554303 1.0.65 2022-03-13 00:30:33 +01:00
1d751bdcdf fix(core): update 2022-03-13 00:30:32 +01:00
bd6713eee8 1.0.64 2022-02-15 11:28:34 +01:00
440b41611b fix(core): update 2022-02-15 11:28:34 +01:00
78a40de700 1.0.63 2022-02-15 00:27:21 +01:00
e0eb00d755 fix(core): update 2022-02-15 00:27:20 +01:00
29 changed files with 10998 additions and 25137 deletions

View File

@ -1,141 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
before_script:
- npm install -g @shipzone/npmci
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
allow_failure: true
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

171
changelog.md Normal file
View File

@ -0,0 +1,171 @@
# Changelog
## 2025-05-15 - 1.2.0 - feat(logging)
Improve logging output, CLI option parsing, and test report formatting.
- Added a centralized TsTestLogger with support for multiple verbosity levels, JSON output, and file logging (TODO).
- Integrated new logger into CLI parsing, TapParser, TapCombinator, and TsTest classes to ensure consistent and structured output.
- Introduced new CLI options (--quiet, --verbose, --no-color, --json, --log-file) for enhanced user control.
- Enhanced visual design with progress indicators, detailed error aggregation, and performance summaries.
- Updated documentation and logging code to align with improved CI/CD behavior, including skipping non-CI tests.
## 2025-05-15 - 1.1.0 - feat(cli)
Enhance test discovery with support for single file and glob pattern execution using improved CLI argument detection
- Detect execution mode (file, glob, directory) based on CLI input in ts/index.ts
- Refactor TestDirectory to load test files using SmartFile for single file and glob patterns
- Update TsTest to pass execution mode and adjust test discovery accordingly
- Bump dependency versions for typedserver, tsbundle, tapbundle, and others
- Add .claude/settings.local.json for updated permissions configuration
## 2025-01-23 - 1.0.96 - fix(TsTest)
Fixed improper type-check for promise-like testModule defaults
- Corrected the type-check for promise-like default exports in test modules
- Removed unnecessary setTimeout used for async execution
## 2025-01-23 - 1.0.95 - fix(core)
Fix delay handling in Chrome test execution
- Replaced smartdelay.delayFor with native Promise-based delay mechanism in runInChrome method.
## 2025-01-23 - 1.0.94 - fix(TsTest)
Fix test module execution by ensuring promise resolution delay
- Added a delay to ensure promise resolution when dynamically importing test modules in the runInChrome method.
## 2025-01-23 - 1.0.93 - fix(tstest)
Handle globalThis.tapPromise in browser runtime evaluation
- Added support for using globalThis.tapPromise in the browser evaluation logic.
- Added log messages to indicate the usage of globalThis.tapPromise.
## 2025-01-23 - 1.0.92 - fix(core)
Improve error logging for test modules without default promise
- Added logging to display the exported test module content when it does not export a default promise.
## 2025-01-23 - 1.0.91 - fix(core)
Refactored tstest class to enhance promise handling for test modules.
- Removed .gitlab-ci.yml configuration file.
- Updated package.json dependency versions.
- Added a condition to handle promiselike objects in tests.
## 2024-04-18 - 1.0.89 to 1.0.90 - Enhancements and Bug Fixes
Multiple updates and fixes have been made.
- Updated core components to enhance stability and performance.
## 2024-03-07 - 1.0.86 to 1.0.88 - Core Updates
Continued improvements and updates in the core module.
- Applied critical fixes to enhance core stability.
## 2024-01-19 - 1.0.85 to 1.0.89 - Bug Fixes
Series of core updates have been implemented.
- Addressed known bugs and improved overall system functionality.
## 2023-11-09 - 1.0.81 to 1.0.84 - Maintenance Updates
Maintenance updates focusing on core reliability.
- Improved core module through systematic updates.
- Strengthened system robustness.
## 2023-08-26 - 1.0.77 to 1.0.80 - Critical Fixes
Critical fixes implemented in core functionality.
- Enhanced core processing to fix existing issues.
## 2023-07-13 - 1.0.75 to 1.0.76 - Stability Improvements
Stability enhancements and minor improvements.
- Focused on ensuring a stable operational core.
## 2022-11-08 - 1.0.73 to 1.0.74 - Routine Fixes
Routine core fixes to address reported issues.
- Addressed minor issues in the core module.
## 2022-08-03 - 1.0.71 to 1.0.72 - Core Enhancements
Enhancements applied to core systems.
- Tweaked core components for enhanced reliability.
## 2022-05-04 - 1.0.69 to 1.0.70 - System Reliability Fixes
Fixes targeting the reliability of the core systems.
- Improved system reliability through targeted core updates.
## 2022-03-17 - 1.0.65 to 1.0.68 - Major Core Updates
Major updates and bug fixes delivered for core components.
- Enhanced central operations through key updates.
## 2022-02-15 - 1.0.60 to 1.0.64 - Core Stability Improvements
Focused updates on core stability and performance.
- Reinforced stability through systematic core changes.
## 2021-11-07 - 1.0.54 to 1.0.59 - Core Fixes and Improvements
Multiple core updates aimed at fixing and improving the system.
- Addressed outstanding bugs and improved performance in the core.
## 2021-08-20 - 1.0.50 to 1.0.53 - Core Functionality Updates
Continued updates to improve core functionality and user experience.
- Implemented essential core fixes to enhance user experience.
## 2020-10-01 - 1.0.44 to 1.0.49 - Core System Enhancements
Critical enhancements to core systems.
- Improved core operations and tackled existing issues.
## 2020-09-29 - 1.0.40 to 1.0.43 - Essential Fixes
Series of essential fixes for the core system.
- Rectified known issues and bolstered core functionalities.
## 2020-07-10 - 1.0.35 to 1.0.39 - Core Function Fixes
Focused improvements and fixes for critical components.
- Addressed critical core functions to boost system performance.
## 2020-06-01 - 1.0.31 to 1.0.34 - Core Updates
Updates to maintain core functionality efficacy.
- Fixed inefficiencies and updated essential components.
## 2019-10-02 - 1.0.26 to 1.0.29 - Core Maintenance
Regular maintenance and updates for core reliability.
- Addressed multiple core issues and enhanced system stability.
## 2019-05-28 - 1.0.20 to 1.0.25 - Core Improvements
General improvements targeting core functionalities.
- Made systematic improvements to core processes.
## 2019-04-08 - 1.0.16 to 1.0.19 - Bug Squashing
Resolved numerous issues within core operations.
- Fixed and optimized core functionalities for better performance.
## 2018-12-06 - 1.0.15 - Dependency Updates
Updates aimed at improving dependency management.
- Ensured dependencies are up-to-date for optimal performance.
## 2018-08-14 - 1.0.14 - Test Improvement
Major improvements in testing mechanisms and logging.
- Improved test results handling for accuracy and reliability.
- Enhanced logging features for increased clarity.
## 2018-08-04 - 1.0.1 to 1.0.13 - Initial Implementation and Fixes
Initial release and critical updates focusing on core stability and functionality.
- Implemented core components and established initial system structure.
- Addressed key bugs and enhanced initial functionality.

4
cli.child.ts Normal file
View File

@ -0,0 +1,4 @@
#!/usr/bin/env node
process.env.CLI_CALL = 'true';
import * as cliTool from './ts/index.js';
cliTool.runCli();

2
cli.js
View File

@ -1,4 +1,4 @@
#!/usr/bin/env node
process.env.CLI_CALL = 'true';
const cliTool = require('./dist_ts/index');
const cliTool = await import('./dist_ts/index.js');
cliTool.runCli();

View File

@ -1,5 +1,5 @@
#!/usr/bin/env node
process.env.CLI_CALL = 'true';
require('@gitzone/tsrun');
const cliTool = require('./ts/index');
cliTool.runCli();
import * as tsrun from '@git.zone/tsrun';
tsrun.runPath('./cli.child.js', import.meta.url);

View File

@ -1,3 +0,0 @@
# How to contribute
Start with `tstest.classes.tstest.ts` to understand whats happening

24695
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,10 +1,11 @@
{
"name": "@gitzone/tstest",
"version": "1.0.62",
"name": "@git.zone/tstest",
"version": "1.2.0",
"private": false,
"description": "a test utility to run tests that match test/**/*.ts",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"author": "Lossless GmbH",
"license": "MIT",
"bin": {
@ -15,27 +16,28 @@
"prepareTest": "git clone https://gitlab.com/sandboxzone/sandbox-npmts.git .nogit/sandbox-npmts && cd .nogit/sandbox-npmts && npm install",
"tstest": "cd .nogit/sandbox-npmts && node ../../cli.ts.js test/ --web",
"cleanUp": "rm -rf .nogit/sandbox-npmts",
"build": "(tsbuild --web)"
"build": "(tsbuild --web --allowimplicitany --skiplibcheck)",
"buildDocs": "tsdoc"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.29",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0"
"@git.zone/tsbuild": "^2.5.1",
"@types/node": "^22.15.18"
},
"dependencies": {
"@gitzone/tsbundle": "^1.0.89",
"@gitzone/tsrun": "^1.2.18",
"@pushrocks/consolecolor": "^2.0.1",
"@pushrocks/smartbrowser": "^1.0.22",
"@pushrocks/smartdelay": "^2.0.13",
"@pushrocks/smartexpress": "^3.0.108",
"@pushrocks/smartfile": "^9.0.5",
"@pushrocks/smartlog": "^2.0.44",
"@pushrocks/smartpromise": "^3.1.6",
"@pushrocks/smartshell": "^2.0.30",
"@pushrocks/tapbundle": "^4.0.3",
"@types/figures": "^3.0.1",
"figures": "^4.0.0"
"@api.global/typedserver": "^3.0.74",
"@git.zone/tsbundle": "^2.2.5",
"@git.zone/tsrun": "^1.3.3",
"@push.rocks/consolecolor": "^2.0.2",
"@push.rocks/smartbrowser": "^2.0.8",
"@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartfile": "^11.2.0",
"@push.rocks/smartlog": "^3.0.9",
"@push.rocks/smartpromise": "^4.2.3",
"@push.rocks/smartshell": "^3.2.3",
"@push.rocks/tapbundle": "^6.0.3",
"@types/ws": "^8.18.1",
"figures": "^6.1.0",
"ws": "^8.18.2"
},
"files": [
"ts/**/*",
@ -51,5 +53,6 @@
],
"browserslist": [
"last 1 chrome versions"
]
],
"packageManager": "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39"
}

9901
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

0
readme.hints.md Normal file
View File

199
readme.plan.md Normal file
View File

@ -0,0 +1,199 @@
# Plan for improving logging and output in tstest
!! FIRST: Reread /home/philkunz/.claude/CLAUDE.md to ensure following all guidelines !!
## Goal - ✅ MOSTLY COMPLETED
- ✅ Make test output cleaner and more visually appealing
- ✅ Add structured logging capabilities
- ✅ Support different verbosity levels
- ✅ Improve CI/CD compatibility
- ✅ Add progress indicators and timing summaries
## Current State - UPDATED
- ✅ Clean, modern visual design with Unicode characters
- ✅ Structured output format (JSON support)
- ✅ Multiple verbosity levels (quiet, normal, verbose)
- ✅ Real-time output with cleaner formatting
- ✅ Better error aggregation and display
- ✅ TAP protocol support integrated with new logger
## Completed Improvements
### 1. ✅ Created new TsTestLogger class
- ✅ Centralized logging with consistent formatting
- ✅ Support for different output modes (normal, quiet, verbose)
- ✅ Better visual hierarchy with modern Unicode characters
- ✅ Progress indicators for multiple test files
- ✅ Structured error collection and display
### 2. ✅ Updated visual design
- ✅ Replaced heavy separators with cleaner alternatives
- ✅ Used better emoji and Unicode characters
- ✅ Added indentation for hierarchical display
- ✅ Grouped related information visually
- ✅ Added color coding consistently
### 3. ✅ Added command-line options
-`--quiet` for minimal CI-friendly output
-`--verbose` for detailed debugging information
-`--no-color` for environments without color support
-`--json` for structured JSON output
-`--log-file <path>` for persistent logging (TODO)
### 4. ✅ Improved progress feedback
- ⏳ Show progress bar for multiple files (TODO)
- ✅ Display current file being executed
- ✅ Show real-time test counts
- ⏳ Add ETA for long test suites (TODO)
### 5. ✅ Better error and summary display
- ✅ Collect all errors and display at end
- ✅ Show timing metrics and performance summary (in verbose mode)
- ✅ Highlight slowest tests (in verbose mode)
- ✅ Add test failure context
### 6. ✅ Browser console integration
- ✅ Clearly separate browser logs from test output
- ⏳ Add browser log filtering options (TODO)
- ✅ Format browser errors specially
## Implementation Steps - COMPLETED
### Phase 1: ✅ Core Logger Implementation
1. ✅ Created `tstest.logging.ts` with TsTestLogger class
2. ✅ Added LogOptions interface for configuration
3. ✅ Implemented basic formatting methods
4. ✅ Added progress and summary methods
### Phase 2: ✅ Integration
1. ✅ Updated CLI to accept new command-line options
2. ✅ Modified TsTest class to use new logger
3. ✅ Updated TapParser to use structured logging
4. ✅ Updated TapCombinator for better summaries
### Phase 3: ✅ Visual Improvements
1. ✅ Replaced all existing separators
2. ✅ Updated color scheme
3. ✅ Added emoji and Unicode characters
4. ✅ Implemented hierarchical output
### Phase 4: ✅ Advanced Features
1. ✅ Add JSON output format
2. ⏳ Implement file-based logging (TODO)
3. ✅ Add performance metrics collection
4. ✅ Create error aggregation system
### Phase 5: ✅ Browser Integration
1. ✅ Update browser console forwarding
2. ✅ Add browser log formatting
3. ✅ Implement browser-specific indicators
## Files modified
-`ts/tstest.logging.ts` - New logger implementation (created)
-`ts/index.ts` - Added CLI options parsing
-`ts/tstest.classes.tstest.ts` - Integrated new logger
-`ts/tstest.classes.tap.parser.ts` - Updated output formatting
-`ts/tstest.classes.tap.combinator.ts` - Improved summary display
-`ts/tstest.logprefixes.ts` - Still in use, can be deprecated later
-`package.json` - No new dependencies needed
## Success Criteria - ACHIEVED
- ✅ Cleaner, more readable test output
- ✅ Configurable verbosity levels
- ✅ Better CI/CD integration
- ✅ Improved error visibility
- ✅ Performance metrics available
- ✅ Consistent visual design
- ✅ Maintained backward compatibility
## Example Output Comparison
### Current Output
```
☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰☰
**TSTEST** FOUND 4 TESTFILE(S):
**TSTEST** test/test.ts
------------------------------------------------
=> Running test/test.ts in node.js runtime.
= = = = = = = = = = = = = = = = = = = = = = = =
```
### Actual Output (IMPLEMENTED)
```
🔍 Test Discovery
Mode: directory
Pattern: test
Found: 4 test file(s)
▶️ test/test.ts (1/4)
Runtime: node.js
✅ prepare test (0ms)
Summary: 1/1 PASSED
▶️ test/test.single.ts (2/4)
Runtime: node.js
✅ single file test execution (1ms)
Summary: 1/1 PASSED
📊 Test Summary
┌────────────────────────────────┐
│ Total Files: 4 │
│ Total Tests: 4 │
│ Passed: 4 │
│ Failed: 0 │
│ Duration: 5739ms │
└────────────────────────────────┘
ALL TESTS PASSED! 🎉
```
### Additional Features Implemented
1. **Quiet Mode**:
```
Found 1 tests
✅ single file test execution
Summary: 1/1 | 1210ms | PASSED
```
2. **JSON Mode**:
```json
{"event":"discovery","count":1,"pattern":"test/test.single.ts","executionMode":"file"}
{"event":"fileStart","filename":"test/test.single.ts","runtime":"node.js","index":1,"total":1}
{"event":"testResult","testName":"single file test execution","passed":true,"duration":0}
{"event":"summary","summary":{"totalFiles":1,"totalTests":1,"totalPassed":1,"totalFailed":0,"totalDuration":1223,"fileResults":[...]}}
```
3. **Error Display**:
```
❌ Failed Tests:
test/test.fail.ts
❌ This test should fail
SOME TESTS FAILED! ❌
```
## Summary of Implementation
The logging improvement plan has been successfully implemented with the following achievements:
1. **Created a new centralized TsTestLogger class** that handles all output formatting
2. **Added multiple output modes**: quiet, normal, verbose, and JSON
3. **Improved visual design** with modern Unicode characters and emojis
4. **Added CLI argument parsing** for all new options
5. **Integrated the logger throughout the codebase** (TsTest, TapParser, TapCombinator)
6. **Better error aggregation and display** with failed tests shown at the end
7. **Performance metrics** available in verbose mode
8. **Clean, hierarchical output** that's much more readable
### Remaining TODOs
Only a few minor features remain unimplemented:
- File-based logging (--log-file option)
- Progress bar visualization
- ETA for long test suites
- Browser log filtering options
The core logging improvements are complete and provide a much better user experience!

8
test/subdir/test.sub.ts Normal file
View File

@ -0,0 +1,8 @@
import { expect, tap } from '@push.rocks/tapbundle';
tap.test('subdirectory test execution', async () => {
console.log('This test verifies subdirectory test discovery works');
expect(true).toBeTrue();
});
tap.start();

13
test/test.fail.ts Normal file
View File

@ -0,0 +1,13 @@
import { expect, tap } from '@push.rocks/tapbundle';
tap.test('This test should fail', async () => {
console.log('This test will fail on purpose');
expect(true).toBeFalse();
});
tap.test('This test should pass', async () => {
console.log('This test will pass');
expect(true).toBeTrue();
});
tap.start();

8
test/test.glob.ts Normal file
View File

@ -0,0 +1,8 @@
import { expect, tap } from '@push.rocks/tapbundle';
tap.test('glob pattern test execution', async () => {
console.log('This test verifies glob pattern execution works');
expect(true).toBeTrue();
});
tap.start();

8
test/test.single.ts Normal file
View File

@ -0,0 +1,8 @@
import { expect, tap } from '@push.rocks/tapbundle';
tap.test('single file test execution', async () => {
console.log('This test verifies single file execution works');
expect(true).toBeTrue();
});
tap.start();

View File

@ -1,5 +1,5 @@
import { expect, tap } from '@pushrocks/tapbundle';
import * as tstest from '../ts/index';
import { expect, tap } from '@push.rocks/tapbundle';
import * as tstest from '../ts/index.js';
tap.test('prepare test', async () => {});

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@git.zone/tstest',
version: '1.2.0',
description: 'a test utility to run tests that match test/**/*.ts'
}

View File

@ -1,10 +1,72 @@
import { TsTest } from './tstest.classes.tstest';
import { TsTest } from './tstest.classes.tstest.js';
import type { LogOptions } from './tstest.logging.js';
export enum TestExecutionMode {
DIRECTORY = 'directory',
FILE = 'file',
GLOB = 'glob'
}
export const runCli = async () => {
if (!process.argv[2]) {
console.error('You must specify a test directory as argument. Please try again.');
// Parse command line arguments
const args = process.argv.slice(2);
const logOptions: LogOptions = {};
let testPath: string | null = null;
// Parse options
for (let i = 0; i < args.length; i++) {
const arg = args[i];
switch (arg) {
case '--quiet':
case '-q':
logOptions.quiet = true;
break;
case '--verbose':
case '-v':
logOptions.verbose = true;
break;
case '--no-color':
logOptions.noColor = true;
break;
case '--json':
logOptions.json = true;
break;
case '--log-file':
if (i + 1 < args.length) {
logOptions.logFile = args[++i];
}
break;
default:
if (!arg.startsWith('-')) {
testPath = arg;
}
}
}
if (!testPath) {
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(' --quiet, -q Minimal output');
console.error(' --verbose, -v Verbose output');
console.error(' --no-color Disable colored output');
console.error(' --json Output results as JSON');
console.error(' --log-file Write logs to file');
process.exit(1);
}
const tsTestInstance = new TsTest(process.cwd(), process.argv[2]);
let executionMode: TestExecutionMode;
// Detect execution mode based on the argument
if (testPath.includes('*') || testPath.includes('?') || testPath.includes('[') || testPath.includes('{')) {
executionMode = TestExecutionMode.GLOB;
} else if (testPath.endsWith('.ts')) {
executionMode = TestExecutionMode.FILE;
} else {
executionMode = TestExecutionMode.DIRECTORY;
}
const tsTestInstance = new TsTest(process.cwd(), testPath, executionMode, logOptions);
await tsTestInstance.run();
};

View File

@ -1,64 +1,42 @@
// ============
// combines different tap test files to an overall result
// ============
import * as plugins from './tstest.plugins';
import { coloredString as cs } from '@pushrocks/consolecolor';
import * as plugins from './tstest.plugins.js';
import { coloredString as cs } from '@push.rocks/consolecolor';
import { TapParser } from './tstest.classes.tap.parser';
import * as logPrefixes from './tstest.logprefixes';
import { TapParser } from './tstest.classes.tap.parser.js';
import * as logPrefixes from './tstest.logprefixes.js';
import { TsTestLogger } from './tstest.logging.js';
export class TapCombinator {
tapParserStore: TapParser[] = [];
private logger: TsTestLogger;
constructor(logger: TsTestLogger) {
this.logger = logger;
}
addTapParser(tapParserArg: TapParser) {
this.tapParserStore.push(tapParserArg);
}
evaluate() {
console.log(
`${logPrefixes.TsTestPrefix} RESULTS FOR ${this.tapParserStore.length} TESTFILE(S):`
);
let failGlobal = false; // determine wether tstest should fail
// Call the logger's summary method
this.logger.summary();
// Check for failures
let failGlobal = false;
for (const tapParser of this.tapParserStore) {
if (!tapParser.expectedTests) {
if (!tapParser.expectedTests ||
tapParser.expectedTests !== tapParser.receivedTests ||
tapParser.getErrorTests().length > 0) {
failGlobal = true;
let overviewString =
logPrefixes.TsTestPrefix +
cs(` ${tapParser.fileName} ${plugins.figures.cross}`, 'red') +
` ${plugins.figures.pointer} ` +
`does not specify tests!`;
console.log(overviewString);
} else if (tapParser.expectedTests !== tapParser.receivedTests) {
failGlobal = true;
let overviewString =
logPrefixes.TsTestPrefix +
cs(` ${tapParser.fileName} ${plugins.figures.cross}`, 'red') +
` ${plugins.figures.pointer} ` +
tapParser.getTestOverviewAsString() +
`did not execute all specified tests!`;
console.log(overviewString);
} else if (tapParser.getErrorTests().length === 0) {
let overviewString =
logPrefixes.TsTestPrefix +
cs(` ${tapParser.fileName} ${plugins.figures.tick}`, 'green') +
` ${plugins.figures.pointer} ` +
tapParser.getTestOverviewAsString();
console.log(overviewString);
} else {
failGlobal = true;
let overviewString =
logPrefixes.TsTestPrefix +
cs(` ${tapParser.fileName} ${plugins.figures.cross}`, 'red') +
` ${plugins.figures.pointer} ` +
tapParser.getTestOverviewAsString();
console.log(overviewString);
break;
}
}
console.log(cs(plugins.figures.hamburger.repeat(48), 'cyan'));
if (!failGlobal) {
console.log(cs('FINAL RESULT: SUCCESS!', 'green'));
} else {
console.log(cs('FINAL RESULT: FAIL!', 'red'));
// Exit with error code if tests failed
if (failGlobal) {
process.exit(1);
}
}

View File

@ -1,12 +1,13 @@
import { ChildProcess } from 'child_process';
import { coloredString as cs } from '@pushrocks/consolecolor';
import { coloredString as cs } from '@push.rocks/consolecolor';
// ============
// combines different tap test files to an overall result
// ============
import * as plugins from './tstest.plugins';
import { TapTestResult } from './tstest.classes.tap.testresult';
import * as logPrefixes from './tstest.logprefixes';
import * as plugins from './tstest.plugins.js';
import { TapTestResult } from './tstest.classes.tap.testresult.js';
import * as logPrefixes from './tstest.logprefixes.js';
import { TsTestLogger } from './tstest.logging.js';
export class TapParser {
testStore: TapTestResult[] = [];
@ -18,10 +19,16 @@ export class TapParser {
testStatusRegex = /(ok|not\sok)\s([0-9]+)\s-\s(.*)\s#\stime=(.*)ms$/;
activeTapTestResult: TapTestResult;
pretaskRegex = /^::__PRETASK:(.*)$/;
private logger: TsTestLogger;
/**
* the constructor for TapParser
*/
constructor(public fileName: string) {}
constructor(public fileName: string, logger?: TsTestLogger) {
this.logger = logger;
}
private _getNewTapTestResult() {
this.activeTapTestResult = new TapTestResult(this.testStore.length + 1);
@ -43,12 +50,20 @@ export class TapParser {
logLineIsTapProtocol = true;
const regexResult = this.expectedTestsRegex.exec(logLine);
this.expectedTests = parseInt(regexResult[2]);
console.log(
`${logPrefixes.TapPrefix} ${cs(`Expecting ${this.expectedTests} tests!`, 'blue')}`
);
if (this.logger) {
this.logger.tapOutput(`Expecting ${this.expectedTests} tests!`);
}
// initiating first TapResult
this._getNewTapTestResult();
} else if (this.pretaskRegex.test(logLine)) {
logLineIsTapProtocol = true;
const pretaskContentMatch = this.pretaskRegex.exec(logLine);
if (pretaskContentMatch && pretaskContentMatch[1]) {
if (this.logger) {
this.logger.tapOutput(`Pretask -> ${pretaskContentMatch[1]}: Success.`);
}
}
} else if (this.testStatusRegex.test(logLine)) {
logLineIsTapProtocol = true;
const regexResult = this.testStatusRegex.exec(logLine);
@ -65,26 +80,20 @@ export class TapParser {
// test for protocol error
if (testId !== this.activeTapTestResult.id) {
console.log(
`${logPrefixes.TapErrorPrefix} Something is strange! Test Ids are not equal!`
);
if (this.logger) {
this.logger.error('Something is strange! Test Ids are not equal!');
}
}
this.activeTapTestResult.setTestResult(testOk);
if (testOk) {
console.log(
logPrefixes.TapPrefix,
`${cs(`T${testId} ${plugins.figures.tick}`, 'green')} ${plugins.figures.arrowRight} ` +
cs(testSubject, 'blue') +
` | ${cs(`${testDuration} ms`, 'orange')}`
);
if (this.logger) {
this.logger.testResult(testSubject, true, testDuration);
}
} else {
console.log(
logPrefixes.TapPrefix,
`${cs(`T${testId} ${plugins.figures.cross}`, 'red')} ${plugins.figures.arrowRight} ` +
cs(testSubject, 'blue') +
` | ${cs(`${testDuration} ms`, 'orange')}`
);
if (this.logger) {
this.logger.testResult(testSubject, false, testDuration);
}
}
}
@ -92,7 +101,9 @@ export class TapParser {
if (this.activeTapTestResult) {
this.activeTapTestResult.addLogLine(logLine);
}
console.log(logLine);
if (this.logger) {
this.logger.tapOutput(logLine);
}
}
if (this.activeTapTestResult && this.activeTapTestResult.testSettled) {
@ -149,7 +160,7 @@ export class TapParser {
this._processLog(data);
});
childProcessArg.on('exit', async () => {
await this._evaluateResult();
await this.evaluateFinalResult();
done.resolve();
});
await done.promise;
@ -157,46 +168,39 @@ export class TapParser {
public async handleTapLog(tapLog: string) {
this._processLog(tapLog);
await this._evaluateResult();
}
private async _evaluateResult() {
public async evaluateFinalResult() {
this.receivedTests = this.testStore.length;
// check wether all tests ran
if (this.expectedTests === this.receivedTests) {
console.log(
`${logPrefixes.TapPrefix} ${cs(
`${this.receivedTests} out of ${this.expectedTests} Tests completed!`,
'green'
)}`
);
if (this.logger) {
this.logger.tapOutput(`${this.receivedTests} out of ${this.expectedTests} Tests completed!`);
}
} else {
console.log(
`${logPrefixes.TapErrorPrefix} ${cs(
`Only ${this.receivedTests} out of ${this.expectedTests} completed!`,
'red'
)}`
);
if (this.logger) {
this.logger.error(`Only ${this.receivedTests} out of ${this.expectedTests} completed!`);
}
}
if (!this.expectedTests) {
console.log(cs('Error: No tests were defined. Therefore the testfile failed!', 'red'));
if (this.logger) {
this.logger.error('No tests were defined. Therefore the testfile failed!');
}
} else if (this.expectedTests !== this.receivedTests) {
console.log(
cs(
'Error: The amount of received tests and expectedTests is unequal! Therefore the testfile failed',
'red'
)
);
if (this.logger) {
this.logger.error('The amount of received tests and expectedTests is unequal! Therefore the testfile failed');
}
} else if (this.getErrorTests().length === 0) {
console.log(`${logPrefixes.TapPrefix} ${cs(`All tests are successfull!!!`, 'green')}`);
if (this.logger) {
this.logger.tapOutput('All tests are successfull!!!');
this.logger.testFileEnd(this.receivedTests, 0, 0);
}
} else {
console.log(
`${logPrefixes.TapPrefix} ${cs(
`${this.getErrorTests().length} tests threw an error!!!`,
'red'
)}`
);
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);
}
}
}
}

View File

@ -1,7 +1,7 @@
// ============
// combines different tap test files to an overall result
// ============
import * as plugins from './tstest.plugins';
import * as plugins from './tstest.plugins.js';
export class TapTestResult {
testLogBuffer = Buffer.from('');

View File

@ -1,11 +1,12 @@
import * as plugins from './tstest.plugins';
import * as paths from './tstest.paths';
import { Smartfile } from '@pushrocks/smartfile';
import * as plugins from './tstest.plugins.js';
import * as paths from './tstest.paths.js';
import { SmartFile } from '@push.rocks/smartfile';
import { TestExecutionMode } from './index.js';
// tap related stuff
import { TapCombinator } from './tstest.classes.tap.combinator';
import { TapParser } from './tstest.classes.tap.parser';
import { TapTestResult } from './tstest.classes.tap.testresult';
import { TapCombinator } from './tstest.classes.tap.combinator.js';
import { TapParser } from './tstest.classes.tap.parser.js';
import { TapTestResult } from './tstest.classes.tap.testresult.js';
export class TestDirectory {
/**
@ -14,43 +15,87 @@ export class TestDirectory {
cwd: string;
/**
* the relative location of the test dir
* the test path or pattern
*/
relativePath: string;
testPath: string;
/**
* the absolute path of the test dir
* the execution mode
*/
absolutePath: string;
executionMode: TestExecutionMode;
/**
* an array of Smartfiles
*/
testfileArray: Smartfile[] = [];
testfileArray: SmartFile[] = [];
/**
* the constructor for TestDirectory
* tell it the path
* @param pathToTestDirectory
* @param cwdArg - the current working directory
* @param testPathArg - the test path/pattern
* @param executionModeArg - the execution mode
*/
constructor(cwdArg: string, relativePathToTestDirectory: string) {
constructor(cwdArg: string, testPathArg: string, executionModeArg: TestExecutionMode) {
this.cwd = cwdArg;
this.relativePath = relativePathToTestDirectory;
this.testPath = testPathArg;
this.executionMode = executionModeArg;
}
private async _init() {
this.testfileArray = await plugins.smartfile.fs.fileTreeToObject(
plugins.path.join(this.cwd, this.relativePath),
'test*.ts'
);
switch (this.executionMode) {
case TestExecutionMode.FILE:
// Single file mode
const filePath = plugins.path.isAbsolute(this.testPath)
? this.testPath
: plugins.path.join(this.cwd, this.testPath);
if (await plugins.smartfile.fs.fileExists(filePath)) {
this.testfileArray = [await plugins.smartfile.SmartFile.fromFilePath(filePath)];
} else {
throw new Error(`Test file not found: ${filePath}`);
}
break;
case TestExecutionMode.GLOB:
// Glob pattern mode - use listFileTree which supports glob patterns
const globPattern = this.testPath;
const matchedFiles = await plugins.smartfile.fs.listFileTree(this.cwd, globPattern);
this.testfileArray = await Promise.all(
matchedFiles.map(async (filePath) => {
const absolutePath = plugins.path.isAbsolute(filePath)
? filePath
: plugins.path.join(this.cwd, filePath);
return await plugins.smartfile.SmartFile.fromFilePath(absolutePath);
})
);
break;
case TestExecutionMode.DIRECTORY:
// Directory mode - now recursive with ** pattern
const dirPath = plugins.path.join(this.cwd, this.testPath);
const testPattern = '**/test*.ts';
const testFiles = await plugins.smartfile.fs.listFileTree(dirPath, testPattern);
this.testfileArray = await Promise.all(
testFiles.map(async (filePath) => {
const absolutePath = plugins.path.isAbsolute(filePath)
? filePath
: plugins.path.join(dirPath, filePath);
return await plugins.smartfile.SmartFile.fromFilePath(absolutePath);
})
);
break;
}
}
async getTestFilePathArray() {
await this._init();
const testFilePaths: string[] = [];
for (const testFile of this.testfileArray) {
const filePath = plugins.path.join(this.relativePath, testFile.path);
testFilePaths.push(filePath);
// Use the path directly from the SmartFile
testFilePaths.push(testFile.path);
}
return testFilePaths;
}

View File

@ -1,15 +1,20 @@
import * as plugins from './tstest.plugins';
import * as paths from './tstest.paths';
import * as logPrefixes from './tstest.logprefixes';
import * as plugins from './tstest.plugins.js';
import * as paths from './tstest.paths.js';
import * as logPrefixes from './tstest.logprefixes.js';
import { coloredString as cs } from '@pushrocks/consolecolor';
import { coloredString as cs } from '@push.rocks/consolecolor';
import { TestDirectory } from './tstest.classes.testdirectory';
import { TapCombinator } from './tstest.classes.tap.combinator';
import { TapParser } from './tstest.classes.tap.parser';
import { TestDirectory } from './tstest.classes.testdirectory.js';
import { TapCombinator } from './tstest.classes.tap.combinator.js';
import { TapParser } from './tstest.classes.tap.parser.js';
import { TestExecutionMode } from './index.js';
import { TsTestLogger } from './tstest.logging.js';
import type { LogOptions } from './tstest.logging.js';
export class TsTest {
public testDir: TestDirectory;
public executionMode: TestExecutionMode;
public logger: TsTestLogger;
public smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash',
@ -20,61 +25,57 @@ export class TsTest {
public tsbundleInstance = new plugins.tsbundle.TsBundle();
constructor(cwdArg: string, relativePathToTestDirectory: string) {
this.testDir = new TestDirectory(cwdArg, relativePathToTestDirectory);
constructor(cwdArg: string, testPathArg: string, executionModeArg: TestExecutionMode, logOptions: LogOptions = {}) {
this.executionMode = executionModeArg;
this.testDir = new TestDirectory(cwdArg, testPathArg, executionModeArg);
this.logger = new TsTestLogger(logOptions);
}
async run() {
const fileNamesToRun: string[] = await this.testDir.getTestFilePathArray();
console.log(cs(plugins.figures.hamburger.repeat(80), 'cyan'));
console.log('');
console.log(`${logPrefixes.TsTestPrefix} FOUND ${fileNamesToRun.length} TESTFILE(S):`);
for (const fileName of fileNamesToRun) {
console.log(`${logPrefixes.TsTestPrefix} ${cs(fileName, 'orange')}`);
}
console.log('-'.repeat(48));
console.log(''); // force new line
// Log test discovery
this.logger.testDiscovery(
fileNamesToRun.length,
this.testDir.testPath,
this.executionMode
);
const tapCombinator = new TapCombinator(); // lets create the TapCombinator
const tapCombinator = new TapCombinator(this.logger); // lets create the TapCombinator
let fileIndex = 0;
for (const fileNameArg of fileNamesToRun) {
fileIndex++;
switch (true) {
case process.env.CI && fileNameArg.includes('.nonci.'):
console.log('!!!!!!!!!!!');
console.log(
`not running testfile ${fileNameArg}, sinc we are CI and file name includes '.nonci.' tag`
);
console.log('!!!!!!!!!!!');
this.logger.tapOutput(`Skipping ${fileNameArg} - marked as non-CI`);
break;
case fileNameArg.endsWith('.browser.ts'):
const tapParserBrowser = await this.runInChrome(fileNameArg);
case fileNameArg.endsWith('.browser.ts') || fileNameArg.endsWith('.browser.nonci.ts'):
const tapParserBrowser = await this.runInChrome(fileNameArg, fileIndex, fileNamesToRun.length);
tapCombinator.addTapParser(tapParserBrowser);
break;
case fileNameArg.endsWith('.both.ts'):
console.log('>>>>>>> TEST PART 1: chrome');
const tapParserBothBrowser = await this.runInChrome(fileNameArg);
case fileNameArg.endsWith('.both.ts') || fileNameArg.endsWith('.both.nonci.ts'):
this.logger.sectionStart('Part 1: Chrome');
const tapParserBothBrowser = await this.runInChrome(fileNameArg, fileIndex, fileNamesToRun.length);
tapCombinator.addTapParser(tapParserBothBrowser);
console.log(cs(`|`.repeat(16), 'cyan'));
console.log(''); // force new line
console.log('>>>>>>> TEST PART 2: node');
const tapParserBothNode = await this.runInNode(fileNameArg);
this.logger.sectionEnd();
this.logger.sectionStart('Part 2: Node');
const tapParserBothNode = await this.runInNode(fileNameArg, fileIndex, fileNamesToRun.length);
tapCombinator.addTapParser(tapParserBothNode);
this.logger.sectionEnd();
break;
default:
const tapParserNode = await this.runInNode(fileNameArg);
const tapParserNode = await this.runInNode(fileNameArg, fileIndex, fileNamesToRun.length);
tapCombinator.addTapParser(tapParserNode);
break;
}
console.log(cs(`^`.repeat(16), 'cyan'));
console.log(''); // force new line
}
tapCombinator.evaluate();
}
public async runInNode(fileNameArg: string): Promise<TapParser> {
console.log(`${cs('=> ', 'blue')} Running ${cs(fileNameArg, 'orange')} in node.js runtime.`);
console.log(`${cs(`= `.repeat(32), 'cyan')}`);
const tapParser = new TapParser(fileNameArg + ':node');
public async runInNode(fileNameArg: string, index: number, total: number): Promise<TapParser> {
this.logger.testFileStart(fileNameArg, 'node.js', index, total);
const tapParser = new TapParser(fileNameArg + ':node', this.logger);
// tsrun options
let tsrunOptions = '';
@ -89,9 +90,8 @@ export class TsTest {
return tapParser;
}
public async runInChrome(fileNameArg: string): Promise<TapParser> {
console.log(`${cs('=> ', 'blue')} Running ${cs(fileNameArg, 'orange')} in chromium runtime.`);
console.log(`${cs(`= `.repeat(32), 'cyan')}`);
public async runInChrome(fileNameArg: string, index: number, total: number): Promise<TapParser> {
this.logger.testFileStart(fileNameArg, 'chromium', index, total);
// lets get all our paths sorted
const tsbundleCacheDirPath = plugins.path.join(paths.cwd, './.nogit/tstest_cache');
@ -99,17 +99,19 @@ export class TsTest {
const bundleFilePath = plugins.path.join(tsbundleCacheDirPath, bundleFileName);
// lets bundle the test
await plugins.smartfile.fs.ensureDir(tsbundleCacheDirPath);
await this.tsbundleInstance.buildTest(process.cwd(), fileNameArg, bundleFilePath, 'parcel');
await plugins.smartfile.fs.ensureEmptyDir(tsbundleCacheDirPath);
await this.tsbundleInstance.build(process.cwd(), fileNameArg, bundleFilePath, {
bundler: 'esbuild',
});
// lets create a server
const server = new plugins.smartexpress.Server({
const server = new plugins.typedserver.servertools.Server({
cors: true,
port: 3007,
});
server.addRoute(
'/test',
new plugins.smartexpress.Handler('GET', async (req, res) => {
new plugins.typedserver.servertools.Handler('GET', async (req, res) => {
res.type('.html');
res.write(`
<html>
@ -124,100 +126,91 @@ export class TsTest {
res.end();
})
);
server.addRoute('*', new plugins.smartexpress.HandlerStatic(tsbundleCacheDirPath));
server.addRoute('*', 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 });
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
await this.smartbrowserInstance.start();
const evaluation = await this.smartbrowserInstance.evaluateOnPage(
`http://localhost:3007/test?bundleName=${bundleFileName}`,
async () => {
const convertToText = (obj: any): string => {
// create an array that will later be joined into a string.
const stringArray = [];
// lets enable real time comms
const ws = new WebSocket('ws://localhost:8080');
await new Promise((resolve) => (ws.onopen = resolve));
if (typeof obj === 'object' && typeof obj.toString === 'function') {
stringArray.push(obj.toString());
} else if (typeof obj === 'object' && obj.join === undefined) {
stringArray.push('{');
for (const prop of Object.keys(obj)) {
stringArray.push(prop, ': ', convertToText(obj[prop]), ',');
}
stringArray.push('}');
// Ensure this function is declared with 'async'
const logStore = [];
const originalLog = console.log;
const originalError = console.error;
// is array
} else if (typeof obj === 'object' && !(obj.join === undefined)) {
stringArray.push('[');
for (const prop of Object.keys(obj)) {
stringArray.push(convertToText(obj[prop]), ',');
}
stringArray.push(']');
// is function
} else if (typeof obj === 'function') {
stringArray.push(obj.toString());
// all other values can be done with JSON.stringify
} else {
stringArray.push(JSON.stringify(obj));
}
return stringArray.join('');
};
let logStore = '';
// tslint:disable-next-line: max-classes-per-file
const log = console.log.bind(console);
// Override console methods to capture the logs
console.log = (...args) => {
args = args.map((argument) => {
return typeof argument !== 'string' ? convertToText(argument) : argument;
});
logStore += `${args}\n`;
log(...args);
logStore.push(args.join(' '));
ws.send(args.join(' '));
originalLog(...args);
};
const error = console.error;
console.error = (...args) => {
args = args.map((argument) => {
return typeof argument !== 'string' ? convertToText(argument) : argument;
});
logStore += `${args}\n`;
error(...args);
logStore.push(args.join(' '));
ws.send(args.join(' '));
originalError(...args);
};
const bundleName = new URLSearchParams(window.location.search).get('bundleName');
console.log(`::TSTEST IN CHROMIUM:: Relevant Script name is: ${bundleName}`);
const bundleResponse = await fetch(`/${bundleName}`);
console.log(
`::TSTEST IN CHROMIUM:: Got ${bundleName} with STATUS ${bundleResponse.status}`
);
const bundle = await bundleResponse.text();
console.log(`::TSTEST IN CHROMIUM:: Executing ${bundleName}`);
originalLog(`::TSTEST IN CHROMIUM:: Relevant Script name is: ${bundleName}`);
try {
// tslint:disable-next-line: no-eval
eval(bundle);
// 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);
}
if (
(globalThis as any).tapbundleDeferred &&
(globalThis as any).tapbundleDeferred.promise
) {
await (globalThis as any).tapbundleDeferred.promise;
} else {
console.log('Error: Could not find tapbundle Deferred');
}
return logStore;
return logStore.join('\n');
}
);
await this.smartbrowserInstance.stop();
await server.stop();
wss.close();
console.log(
`${cs('=> ', 'blue')} Stopped ${cs(fileNameArg, 'orange')} chromium instance and server.`
);
console.log(`${cs('=> ', 'blue')} See the result captured from the chromium execution:`);
// lets create the tap parser
const tapParser = new TapParser(fileNameArg + ':chrome');
tapParser.handleTapLog(evaluation);
await tapParser.evaluateFinalResult();
return tapParser;
}

285
ts/tstest.logging.ts Normal file
View File

@ -0,0 +1,285 @@
import { coloredString as cs } from '@push.rocks/consolecolor';
import * as plugins from './tstest.plugins.js';
export interface LogOptions {
quiet?: boolean;
verbose?: boolean;
noColor?: boolean;
json?: boolean;
logFile?: string;
}
export interface TestFileResult {
file: string;
passed: number;
failed: number;
total: number;
duration: number;
tests: Array<{
name: string;
passed: boolean;
duration: number;
error?: string;
}>;
}
export interface TestSummary {
totalFiles: number;
totalTests: number;
totalPassed: number;
totalFailed: number;
totalDuration: number;
fileResults: TestFileResult[];
}
export class TsTestLogger {
private options: LogOptions;
private startTime: number;
private fileResults: TestFileResult[] = [];
private currentFileResult: TestFileResult | null = null;
constructor(options: LogOptions = {}) {
this.options = options;
this.startTime = Date.now();
}
private format(text: string, color?: string): string {
if (this.options.noColor || !color) {
return text;
}
return cs(text, color as any);
}
private log(message: string) {
if (this.options.json) return;
console.log(message);
if (this.options.logFile) {
// TODO: Implement file logging
}
}
// Section separators
sectionStart(title: string) {
if (this.options.quiet || this.options.json) return;
this.log(this.format(`\n━━━ ${title} ━━━`, 'cyan'));
}
sectionEnd() {
if (this.options.quiet || this.options.json) return;
this.log(this.format('─'.repeat(50), 'dim'));
}
// Progress indication
progress(current: number, total: number, message: string) {
if (this.options.quiet || this.options.json) return;
const percentage = Math.round((current / total) * 100);
const filled = Math.round((current / total) * 20);
const empty = 20 - filled;
this.log(this.format(`\n📊 Progress: ${current}/${total} (${percentage}%)`, 'cyan'));
this.log(this.format(`[${'█'.repeat(filled)}${'░'.repeat(empty)}] ${message}`, 'dim'));
}
// Test discovery
testDiscovery(count: number, pattern: string, executionMode: string) {
if (this.options.json) {
console.log(JSON.stringify({ event: 'discovery', count, pattern, executionMode }));
return;
}
if (this.options.quiet) {
this.log(`Found ${count} tests`);
} else {
this.log(this.format(`\n🔍 Test Discovery`, 'bold'));
this.log(this.format(` Mode: ${executionMode}`, 'dim'));
this.log(this.format(` Pattern: ${pattern}`, 'dim'));
this.log(this.format(` Found: ${count} test file(s)`, 'green'));
}
}
// Test execution
testFileStart(filename: string, runtime: string, index: number, total: number) {
this.currentFileResult = {
file: filename,
passed: 0,
failed: 0,
total: 0,
duration: 0,
tests: []
};
if (this.options.json) {
console.log(JSON.stringify({ event: 'fileStart', filename, runtime, index, total }));
return;
}
if (this.options.quiet) return;
this.log(this.format(`\n▶ ${filename} (${index}/${total})`, 'blue'));
this.log(this.format(` Runtime: ${runtime}`, 'dim'));
}
testResult(testName: string, passed: boolean, duration: number, error?: string) {
if (this.currentFileResult) {
this.currentFileResult.tests.push({ name: testName, passed, duration, error });
this.currentFileResult.total++;
if (passed) {
this.currentFileResult.passed++;
} else {
this.currentFileResult.failed++;
}
this.currentFileResult.duration += duration;
}
if (this.options.json) {
console.log(JSON.stringify({ event: 'testResult', testName, passed, duration, error }));
return;
}
const icon = passed ? '✅' : '❌';
const color = passed ? 'green' : 'red';
if (this.options.quiet) {
this.log(`${icon} ${testName}`);
} else {
this.log(this.format(` ${icon} ${testName} (${duration}ms)`, color));
if (error && !passed) {
this.log(this.format(` ${error}`, 'red'));
}
}
}
testFileEnd(passed: number, failed: number, duration: number) {
if (this.currentFileResult) {
this.fileResults.push(this.currentFileResult);
this.currentFileResult = null;
}
if (this.options.json) {
console.log(JSON.stringify({ event: 'fileEnd', passed, failed, duration }));
return;
}
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));
}
}
// TAP output forwarding
tapOutput(message: string, isError: boolean = false) {
if (this.options.json) return;
if (this.options.verbose || isError) {
const prefix = isError ? ' ⚠️ ' : ' ';
const color = isError ? 'red' : 'dim';
this.log(this.format(`${prefix}${message}`, color));
}
}
// Browser console
browserConsole(message: string, level: string = 'log') {
if (this.options.json) {
console.log(JSON.stringify({ event: 'browserConsole', message, level }));
return;
}
if (!this.options.quiet) {
const prefix = level === 'error' ? '🌐❌' : '🌐';
const color = level === 'error' ? 'red' : 'magenta';
this.log(this.format(` ${prefix} ${message}`, color));
}
}
// Final summary
summary() {
const totalDuration = Date.now() - this.startTime;
const summary: TestSummary = {
totalFiles: this.fileResults.length,
totalTests: this.fileResults.reduce((sum, r) => sum + r.total, 0),
totalPassed: this.fileResults.reduce((sum, r) => sum + r.passed, 0),
totalFailed: this.fileResults.reduce((sum, r) => sum + r.failed, 0),
totalDuration,
fileResults: this.fileResults
};
if (this.options.json) {
console.log(JSON.stringify({ event: 'summary', summary }));
return;
}
if (this.options.quiet) {
const status = summary.totalFailed === 0 ? 'PASSED' : 'FAILED';
this.log(`\nSummary: ${summary.totalPassed}/${summary.totalTests} | ${totalDuration}ms | ${status}`);
return;
}
// Detailed summary
this.log(this.format('\n📊 Test Summary', 'bold'));
this.log(this.format('┌────────────────────────────────┐', 'dim'));
this.log(this.format(`│ Total Files: ${summary.totalFiles.toString().padStart(14)}`, 'white'));
this.log(this.format(`│ Total Tests: ${summary.totalTests.toString().padStart(14)}`, 'white'));
this.log(this.format(`│ Passed: ${summary.totalPassed.toString().padStart(14)}`, 'green'));
this.log(this.format(`│ Failed: ${summary.totalFailed.toString().padStart(14)}`, summary.totalFailed > 0 ? 'red' : 'green'));
this.log(this.format(`│ Duration: ${totalDuration.toString().padStart(14)}ms │`, 'white'));
this.log(this.format('└────────────────────────────────┘', 'dim'));
// File results
if (summary.totalFailed > 0) {
this.log(this.format('\n❌ Failed Tests:', 'red'));
this.fileResults.forEach(fileResult => {
if (fileResult.failed > 0) {
this.log(this.format(`\n ${fileResult.file}`, 'yellow'));
fileResult.tests.filter(t => !t.passed).forEach(test => {
this.log(this.format(`${test.name}`, 'red'));
if (test.error) {
this.log(this.format(` ${test.error}`, 'dim'));
}
});
}
});
}
// Performance metrics
if (this.options.verbose) {
const avgDuration = Math.round(totalDuration / summary.totalTests);
const slowestTest = this.fileResults
.flatMap(r => r.tests)
.sort((a, b) => b.duration - a.duration)[0];
this.log(this.format('\n⏱ Performance Metrics:', 'cyan'));
this.log(this.format(` Average per test: ${avgDuration}ms`, 'white'));
if (slowestTest) {
this.log(this.format(` Slowest test: ${slowestTest.name} (${slowestTest.duration}ms)`, 'yellow'));
}
}
// Final status
const status = summary.totalFailed === 0 ? 'ALL TESTS PASSED! 🎉' : 'SOME TESTS FAILED! ❌';
const statusColor = summary.totalFailed === 0 ? 'green' : 'red';
this.log(this.format(`\n${status}`, statusColor));
}
// Error display
error(message: string, file?: string, stack?: string) {
if (this.options.json) {
console.log(JSON.stringify({ event: 'error', message, file, stack }));
return;
}
if (this.options.quiet) {
console.error(`ERROR: ${message}`);
} else {
this.log(this.format('\n⚠ Error', 'red'));
if (file) this.log(this.format(` File: ${file}`, 'yellow'));
this.log(this.format(` ${message}`, 'red'));
if (stack && this.options.verbose) {
this.log(this.format(` Stack:`, 'dim'));
this.log(this.format(stack.split('\n').map(line => ` ${line}`).join('\n'), 'dim'));
}
}
}
}

View File

@ -1,7 +1,8 @@
import * as plugins from './tstest.plugins';
import { coloredString as cs } from '@pushrocks/consolecolor';
import * as plugins from './tstest.plugins.js';
import { coloredString as cs } from '@push.rocks/consolecolor';
export const TapPrefix = cs(`::TAP::`, 'pink', 'black');
export const TapPretaskPrefix = cs(`::PRETASK::`, 'cyan', 'black');
export const TapErrorPrefix = cs(` !!!TAP PROTOCOL ERROR!!! `, 'red', 'black');
export const TsTestPrefix = cs(`**TSTEST**`, 'pink', 'black');

View File

@ -1,5 +1,5 @@
import * as plugins from './tstest.plugins';
import * as plugins from './tstest.plugins.js';
export const cwd = process.cwd();
export const testDir = plugins.path.join(cwd, './test/');
export const binDirectory = plugins.path.join(cwd, 'node_modules/.bin');
export const binDirectory = plugins.path.join(cwd, './node_modules/.bin');

View File

@ -3,21 +3,26 @@ import * as path from 'path';
export { path };
// @pushrocks scope
import * as consolecolor from '@pushrocks/consolecolor';
import * as smartbrowser from '@pushrocks/smartbrowser';
import * as smartexpress from '@pushrocks/smartexpress';
import * as smartdelay from '@pushrocks/smartdelay';
import * as smartfile from '@pushrocks/smartfile';
import * as smartlog from '@pushrocks/smartlog';
import * as smartpromise from '@pushrocks/smartpromise';
import * as smartshell from '@pushrocks/smartshell';
import * as tapbundle from '@pushrocks/tapbundle';
// @apiglobal scope
import * as typedserver from '@api.global/typedserver';
export {
typedserver
}
// @push.rocks scope
import * as consolecolor from '@push.rocks/consolecolor';
import * as smartbrowser from '@push.rocks/smartbrowser';
import * as smartdelay from '@push.rocks/smartdelay';
import * as smartfile from '@push.rocks/smartfile';
import * as smartlog from '@push.rocks/smartlog';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartshell from '@push.rocks/smartshell';
import * as tapbundle from '@push.rocks/tapbundle';
export {
consolecolor,
smartbrowser,
smartexpress,
smartdelay,
smartfile,
smartlog,
@ -27,11 +32,18 @@ export {
};
// @gitzone scope
import * as tsbundle from '@gitzone/tsbundle';
import * as tsbundle from '@git.zone/tsbundle';
export { tsbundle };
// sindresorhus
import * as figures from 'figures';
import figures from 'figures';
export { figures };
// third party
import * as ws from 'ws';
export {
ws
}

14
tsconfig.json Normal file
View File

@ -0,0 +1,14 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

View File

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}