Compare commits

...

63 Commits

Author SHA1 Message Date
953957cae3 5.2.0 2024-09-18 18:43:46 +02:00
c712a9a09c feat(TapNodeTools): Add ability to create HTTPS certificates with self-signed option 2024-09-18 18:43:46 +02:00
5a94f116e1 5.1.4 2024-09-18 17:56:54 +02:00
0e80700481 fix(ts_node): Fixed issues in HTTPS certificate generation for TapNodeTools 2024-09-18 17:56:53 +02:00
22ec504b0f 5.1.3 2024-09-18 15:30:47 +02:00
3d39f65ed0 fix(ts_node/classes.tapnodetools.ts): Refactored methods and improved type annotations in TapNodeTools class. 2024-09-18 15:30:47 +02:00
7c450876f2 5.1.2 2024-09-18 00:46:53 +02:00
d7c3752dfa fix(TapNodeTools): Default parameter added to createHttpsCert method 2024-09-18 00:46:52 +02:00
f53e5bcc83 5.1.1 2024-09-18 00:45:51 +02:00
d8301314a7 fix(ts_node): Fixed createHttpsCert interface 2024-09-18 00:45:50 +02:00
155b0b9f91 5.1.0 2024-09-18 00:41:14 +02:00
61c493ce72 feat(ts_node): Add support for HTTPS certificate creation 2024-09-18 00:41:14 +02:00
4358e1d64d 5.0.25 2024-09-17 19:40:01 +02:00
1e6296f980 fix(core): Fix typos in package.json, update dependencies and update workflow. 2024-09-17 19:40:00 +02:00
0be2243ced 5.0.24 2024-08-17 07:30:12 +02:00
b6c0d8013b fix(dependencies): Update dependencies 2024-08-17 07:30:11 +02:00
54815c49d6 update description 2024-05-29 14:17:23 +02:00
104413c37f 5.0.23 2024-04-15 18:51:23 +02:00
68afa0bbdf fix(core): update 2024-04-15 18:51:22 +02:00
90f618eeff update tsconfig 2024-04-14 18:36:42 +02:00
4c6fb95ec9 update tsconfig 2024-04-01 21:42:25 +02:00
38ddb7be1f update npmextra.json: githost 2024-04-01 20:00:09 +02:00
4489be479e update npmextra.json: githost 2024-03-30 21:49:10 +01:00
7cd2993be0 5.0.22 2024-03-19 19:39:55 +01:00
36d4462504 fix(core): update 2024-03-19 19:39:54 +01:00
16c7ce2394 5.0.21 2024-03-19 13:51:10 +01:00
fd1a14524f fix(core): update 2024-03-19 13:51:10 +01:00
c97215ed2d 5.0.20 2024-03-19 13:43:34 +01:00
6dbe5098de fix(core): update 2024-03-19 13:43:34 +01:00
3e9a288333 5.0.19 2024-03-19 13:34:57 +01:00
07b876ea2c fix(core): update 2024-03-19 13:34:56 +01:00
28fec7a488 5.0.18 2024-03-19 13:13:57 +01:00
b99ac03942 fix(core): update 2024-03-19 13:13:56 +01:00
ba6519adb5 5.0.17 2024-03-13 22:13:31 +01:00
2de0e63b3c fix(core): update 2024-03-13 22:13:30 +01:00
2359841a15 5.0.16 2024-03-13 22:07:58 +01:00
0ef865ea9f fix(core): update 2024-03-13 22:07:58 +01:00
a8beda7597 5.0.15 2023-08-12 11:40:29 +02:00
e029c8601f fix(core): update 2023-08-12 11:40:29 +02:00
1b9f414e82 5.0.14 2023-08-12 11:39:09 +02:00
1aa4152de2 fix(core): update 2023-08-12 11:39:09 +02:00
b93e962bdf 5.0.13 2023-07-13 03:18:09 +02:00
0faf2ce3df fix(core): update 2023-07-13 03:18:08 +02:00
831f67053e 5.0.12 2023-07-13 02:41:11 +02:00
26e63372f8 fix(core): update 2023-07-13 02:41:10 +02:00
929a67585f 5.0.11 2023-07-13 02:40:10 +02:00
fb8d291441 fix(core): update 2023-07-13 02:40:09 +02:00
5657b49a51 5.0.10 2023-07-13 02:39:42 +02:00
db39da1faf fix(core): update 2023-07-13 02:39:42 +02:00
e9d6e9f9dd 5.0.9 2023-07-13 02:09:54 +02:00
d8e638a07f fix(core): update 2023-07-13 02:09:53 +02:00
85eb222bd9 5.0.8 2023-06-22 13:35:35 +02:00
189c0bae30 fix(core): update 2023-06-22 13:35:35 +02:00
570422ae61 5.0.7 2023-06-22 13:32:44 +02:00
4ba34a4b88 fix(core): update 2023-06-22 13:32:43 +02:00
ae2aabaa86 5.0.6 2022-07-24 15:22:10 +02:00
269a8c974e fix(core): update 2022-07-24 15:22:10 +02:00
10ab777e7f 5.0.5 2022-07-24 14:03:45 +02:00
898eed4584 fix(core): update 2022-07-24 14:03:44 +02:00
7a1eae2bfb 5.0.4 2022-07-24 14:03:30 +02:00
8f7167f201 fix(core): update 2022-07-24 14:03:29 +02:00
6fa151f933 5.0.3 2022-03-24 13:17:20 +01:00
f846b91378 fix(core): update 2022-03-24 13:17:20 +01:00
26 changed files with 7443 additions and 19369 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@ -1,137 +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
# ====================
# 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
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

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0",
"configurations": [
{
"name": "current file",
"type": "node",
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"args": [
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
"type": "node-terminal"
}
]
}

198
changelog.md Normal file
View File

@ -0,0 +1,198 @@
# Changelog
## 2024-09-18 - 5.2.0 - feat(TapNodeTools)
Add ability to create HTTPS certificates with self-signed option
- Introduced a new parameter `allowSelfSigned` to the `createHttpsCert` function.
## 2024-09-18 - 5.1.4 - fix(ts_node)
Fixed issues in HTTPS certificate generation for TapNodeTools
- Updated 'createHttpsCert' method in 'TapNodeTools' to use 'smartcrypto' for generating RSA key pair and self-signed certificate.
- Corrected certificate and private key PEM encoding.
## 2024-09-18 - 5.1.3 - fix(ts_node/classes.tapnodetools.ts)
Refactored methods and improved type annotations in TapNodeTools class.
- Refactored `runCommand` method to include proper type annotations.
- Enhanced `createHttpsCert` method with proper type annotations and key generation logic.
- Introduced `generateSelfSignedCert` method for better code organization and readability.
## 2024-09-18 - 5.1.2 - fix(TapNodeTools)
Default parameter added to createHttpsCert method
- Updated createHttpsCert method to provide a default value for the parameter commonName.
## 2024-09-18 - 5.1.1 - fix(ts_node)
Fixed createHttpsCert interface
- Removed unnecessary keyFile and certFile parameters from createHttpsCert method.
## 2024-09-18 - 5.1.0 - feat(ts_node)
Add support for HTTPS certificate creation
- Added TapNodeTools class with methods to run commands and create HTTPS certificates
- Exported necessary plugins including crypto and fs for node
- Updated test cases to include tests for HTTPS certificate creation
## 2024-09-17 - 5.0.25 - fix(core)
Fix typos in package.json, update dependencies and update workflow.
- Fixed references to deprecated package names in workflows and package.json.
- Updated versions of @push.rocks dependencies to latest stable.
- Corrected scripts in package.json to reflect new build and documentation commands.
- Fixed async startup in browser tests.
## 2024-08-17 - 5.0.24 - fix(dependencies)
Update dependencies
- Updated @push.rocks/smartexpect from ^1.0.21 to ^1.1.0
- Updated @push.rocks/smartjson from ^5.0.16 to ^5.0.20
- Updated @push.rocks/smartpromise from ^4.0.2 to ^4.0.4
- Updated @push.rocks/smarttime from ^4.0.6 to ^4.0.8
- Updated @types/node from ^20.11.30 to ^22.4.0
## 2024-05-29 - 5.0.23 - General Update
update description
## 2024-04-14 to 2024-04-15 - 5.0.22 - Configuration Updates and Bug Fixes
Multiple updates in tsconfig and npmextra.json
- fix(core): update
- update tsconfig
- update npmextra.json: githost
## 2024-03-19 - 5.0.21 to 5.0.17 - Bug Fix Release
Multiple core fixes and updates without specific feature changes
- fix(core): update
## 2024-03-13 - 5.0.16 - Bug Fix Release
- fix(core): update
## 2023-08-12 - 5.0.15 to 5.0.13 - Bug Fix Release
Multiple core fixes and updates without specific feature changes
- fix(core): update
## 2023-07-13 - 5.0.12 to 5.0.10 - Bug Fix Release
Multiple core fixes and updates without specific feature changes
- fix(core): update
## 2023-06-22 - 5.0.9 to 5.0.7 - Bug Fix Release
Multiple core fixes and updates without specific feature changes
- fix(core): update
## 2022-07-24 - 5.0.6 to 5.0.3 - Bug Fix Release
Multiple core fixes and updates without specific feature changes
- fix(core): update
## 2022-03-14 - 5.0.2 to 5.0.0 - Initial Release of Version 5.x.x
Multiple bug fixes and updates.
- fix(core): update
## 2022-03-14 - 4.0.9 to 4.0.8 - Bug Fix Release
- fix(core): update
## 2022-02-28 - 4.0.7 to 4.0.4 - Bug Fix Release
Multiple core fixes and updates without specific feature changes
- fix(core): update
## 2022-02-02 - 4.0.3 to 4.0.1 - Bug Fix Release
- fix(core): update
## 2022-01-21 - 4.0.0 - Major Release
Version 4.x.x Major improvements and core fixes
## 2021-12-10 - 3.2.15 - Breaking Change
BREAKING CHANGE(core): switch to @pushrocks/smartexpect
## 2021-12-10 - 3.2.14 - Bug Fix Release
- fix(core): update
## 2021-02-13 - 3.2.13 - Bug Fix Release
- fix(core): update
## 2021-01-26 - 3.2.12 to 3.2.11 - Bug Fix Release
- fix(core): update
## 2020-07-11 - 3.2.10 to 3.2.8 - Bug Fix Release
- fix(core): update
## 2020-07-08 - 3.2.7 to 3.2.4 - Bug Fix Release
Multiple core fixes and updates without specific feature changes
- fix(core): update
## 2020-07-08 - 3.2.5 - Documentation Update
- update readme
## 2019-11-16 - 3.1.0 - New Feature
- feat(pretask): introduce new pretask functionality for setting up testing environment
## 2019-11-16 - 3.0.14 - New Feature
- feat(tools): can now ensure certain directories
## 2019-08-23 - 3.0.13 - Bug Fix Release
- fix(core): update
## 2019-08-22 - 3.0.12 - Bug Fix Release
- fix(core): update
## 2019-06-19 - 3.0.11 - Bug Fix Release
- fix(core): update
## 2019-04-10 - 3.0.9 to 3.0.8 - Bug Fix Release
- fix(core): update
## 2018-09-03 - 3.0.7 - Bug Fix Release
- fix(core): update
## 2018-09-02 - 3.0.6 - Dependency Update
- fix(dependencies): update to latest versions
## 2018-08-08 - 3.0.5 - New Feature
- fix(core): add tap.only option
## 2018-08-08 - 3.0.4 - Dependency Update
- fix(dependencies): update
## 2018-08-08 - 3.0.3 - Dependency Update
- fix(dependencies): use @git.zone/tsbuild instead of npmts
## 2018-07-18 - 3.0.2 - Dependency Update
- fix(dependencies): now typings-global free
## 2018-07-13 - 3.0.1 - Dependency Update
- fix(dependencies): update
## 2018-07-13 - 3.0.0 - Package Update
- fix(package): npm access level
## 2018-06-28 - 2.0.2 - Breaking Change
BREAKING CHANGE(package): change scope
## 2018-06-28 - 2.0.1 - Security Update
- fix(security): add snyk file
## 2018-02-27 - 2.0.0 - Compatibility Update
- fix(core): fix node 10.x.x compatibility
## 2017-10-11 - 1.1.8 - Update
- update to use latest smartchai
## 2017-10-11 - 1.1.7 - Update
- update ci
## 2017-10-10 - 1.1.6 - Documentation Update
- add new docs
## 2017-10-09 - 1.1.5 - Feature Update
- now has working leak detection
## 2017-03-26 - 1.0.9 - Standards Update
- update to latest standards

View File

@ -11,12 +11,29 @@
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "pushrocks",
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "tapbundle",
"shortDescription": "tap bundled for tapbuffer",
"npmPackagename": "@pushrocks/tapbundle",
"license": "MIT"
"description": "A test automation library bundling utilities and tools for TAP (Test Anything Protocol) based testing, specifically tailored for tapbuffer.",
"npmPackagename": "@push.rocks/tapbundle",
"license": "MIT",
"keywords": [
"testing",
"automation",
"TAP",
"test anything protocol",
"unit testing",
"integration testing",
"JavaScript",
"TypeScript",
"test runner",
"test framework",
"web helpers",
"test utilities"
]
}
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis 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. \n\n**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.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy 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.\n"
}
}

19064
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,41 +1,46 @@
{
"name": "@pushrocks/tapbundle",
"name": "@push.rocks/tapbundle",
"private": false,
"version": "5.0.2",
"description": "tap bundled for tapbuffer",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"version": "5.2.0",
"description": "A test automation library bundling utilities and tools for TAP (Test Anything Protocol) based testing, specifically tailored for tapbuffer.",
"exports": {
".": "./dist_ts/index.js",
"./node": "./dist_ts_node/index.js"
},
"type": "module",
"scripts": {
"test": "(tstest test/)",
"build": "(tsbuild --web)"
"build": "(tsbuild tsfolders --web --allowimplicitany --skiplibcheck)",
"buildDocs": "tsdoc"
},
"repository": {
"type": "git",
"url": "git+ssh://git@gitlab.com/pushrocks/tapbundle.git"
"url": "https://code.foss.global/push.rocks/tapbundle.git"
},
"author": "Lossless GmbH",
"license": "MIT",
"bugs": {
"url": "https://gitlab.com/pushrocks/tapbundle/issues"
},
"homepage": "https://gitlab.com/pushrocks/tapbundle#README",
"homepage": "https://code.foss.global/push.rocks/tapbundle",
"dependencies": {
"@open-wc/testing-helpers": "^2.1.2",
"@pushrocks/smartdelay": "^2.0.13",
"@pushrocks/smartenv": "^4.0.16",
"@pushrocks/smartexpect": "^1.0.13",
"@pushrocks/smartpromise": "^3.1.7",
"@pushrocks/smarttime": "^3.0.45"
"@open-wc/testing": "^4.0.0",
"@push.rocks/consolecolor": "^2.0.2",
"@push.rocks/smartcrypto": "^2.0.4",
"@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartenv": "^5.0.12",
"@push.rocks/smartexpect": "^1.2.1",
"@push.rocks/smartjson": "^5.0.20",
"@push.rocks/smartpromise": "^4.0.4",
"@push.rocks/smartshell": "^3.0.6",
"@push.rocks/smarttime": "^4.0.8"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.48",
"@gitzone/tsrun": "^1.2.31",
"@gitzone/tstest": "^1.0.67",
"@types/node": "^17.0.18",
"randomstring": "^1.2.2",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0"
"@git.zone/tsbuild": "^2.1.66",
"@git.zone/tsrun": "^1.2.43",
"@git.zone/tstest": "^1.0.77",
"@types/node": "^22.5.5",
"randomstring": "^1.3.0"
},
"files": [
"ts/**/*",
@ -51,5 +56,19 @@
],
"browserslist": [
"last 1 chrome versions"
],
"keywords": [
"testing",
"automation",
"TAP",
"test anything protocol",
"unit testing",
"integration testing",
"JavaScript",
"TypeScript",
"test runner",
"test framework",
"web helpers",
"test utilities"
]
}

6690
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

210
readme.md
View File

@ -1,88 +1,138 @@
# @pushrocks/tapbundle
tap based testing framework for use with @gitzone/tstest
# @push.rocks/tapbundle
tap bundled for tapbuffer
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/tapbundle)
* [gitlab.com (source)](https://gitlab.com/pushrocks/tapbundle)
* [github.com (source mirror)](https://github.com/pushrocks/tapbundle)
* [docs (typedoc)](https://pushrocks.gitlab.io/tapbundle/)
## Install
Install the package by running the following command in your terminal:
## Status for master
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/tapbundle/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/tapbundle/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/tapbundle)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/tapbundle)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/tapbundle)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/tapbundle)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/tapbundle)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage
Use TypeScript for best in class instellisense.
A few words on TypeScript
### Included in this package
* tap compatible testing framework written in TypeScript
* `expect` and `expectAsync` from the package `@pushrocks/smartexpect`
### A few words on tap
**"tap"** stands for **"test anything protocol"**. Its programming language agnostic as long as the test interpreter can read the tap console output. This package is optimized to work with @gitzone/tstest as interpreter, which offers different V8 based runtime environments like nodejs, chrome, and deno.
### Write your first tests
```typescript
import { tap, expect, expectAsync } from 'tapbundle'; // has typings in place
import * as myAwesomeModuleToTest from '../dist/index'; // '../dist/index' is the standard path for npmts modules
tap.test('my awesome description', async (tools) => {
// tools are optional parameter
tools.timeout(2000); // test will fail if it takes longer than 2000 millisenconds
});
const myTest2 = tap.test('my awesome test 2', async (tools) => {
myAwsomeModuleToTest.doSomethingAsync(); // we don't wait here
await tools.delayFor(3000); // yay! :) promise based timeouts :)
console.log('This gets logged 3000 ms into the test');
});
tap.test('my awesome test 3', async (tools) => {
expect(true).toBeTrue(); // will not throw
await expectAsync(tools.delayFor(2000)).toBeUndefined(); // yay expect promises :)
expectAsync(myTest2.promise) // access other tests metadata :)
.property('hrtMeasurement') // and drill down into properties
.property('milliSeconds').toBeGreaterThan(1000);
});
const myTest4 = tap.testParallel('my awesome test 4', async (tools) => {
await tools.delayFor(4000);
console.log('logs to console after 4 seconds into this test');
});
tap.test('my awesome test 5', async () => {
expect(myTest4.status).toEqual('pending'); // since this test will likely finish before myTest4.
});
tap.start(); // start the test, will automtically plan tests for you (so the tap parser knows when tests exit bofore they are finished)
```bash
npm install @push.rocks/tapbundle --save-dev
```
## Contribution
This will add `@push.rocks/tapbundle` to your project's `devDependencies`.
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
## Usage
The `@push.rocks/tapbundle` package is a tap-compatible testing framework written in TypeScript, intended for use with tapbuffer. It includes a range of useful features enabling easy setup and execution of tests, assertion handling through `expect` and `expectAsync`, as well as auxiliary tools for delay and colored console output.
For further information read the linked docs at the top of this readme.
### Getting Started
First, ensure your project is set up with Typescript and supports ESM syntax. You can then import `tap`, `expect`, and `expectAsync` from `@push.rocks/tapbundle` to start defining your tests.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
```typescript
import { tap, expect, expectAsync } from '@push.rocks/tapbundle';
```
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
Here is a simple test example:
```typescript
import { tap, expect } from '@push.rocks/tapbundle';
tap.test('should succeed on true assertion', async () => {
return expect(true).toBeTrue();
});
tap.start();
```
### Defining Tests
You can define tests with descriptions and async functions. The `tap` instance manages test execution, supports test skipping, and managing exclusive tests with the `.only` modifier.
```typescript
const myTest = tap.test('expect true to be true', async () => {
expect(true).toBeTrue();
});
const skippedTest = tap.skip.test('this test is skipped', async () => {
// This will not be executed
});
tap.only.test('only this test will run', async () => {
expect('TapBundle').toContainString('Tap');
});
tap.start();
```
### Using `expect` and `expectAsync`
The package provides `expect` and `expectAsync` for assertions:
```typescript
await expectAsync(Promise.resolve(true)).toBeResolved();
expect(5).toBeGreaterThan(2);
```
### Handling Asynchronous Operations
`tapbundle` facilitates working with async operations in tests. You can introduce delays or set timeouts:
```typescript
tap.test('async operation with delay', async (tools) => {
await tools.delayFor(2000); // Wait for 2000 milliseconds
expect(true).toBeTrue();
});
tap.start();
```
### Advanced Usage
#### Pre Tasks
You can define tasks to run before test execution begins:
```typescript
tap.preTask('setup database', async () => {
// Perform setup here
});
tap.test('test database connection', async () => {
// Test the setup
});
tap.start();
```
#### Accessing Test Metadata
Each test returns a `TapTest` instance, from which you can access metadata and manipulate test behavior:
```typescript
const test = tap.test('metadata example', async (tools) => {
tools.allowFailure();
expect(true).toBeTrue();
});
tap.start().then(() => {
console.log(`Test duration: ${test.hrtMeasurement.milliSeconds}ms`);
});
```
### Running Tests
Tests are executed by calling `tap.start()`. This method runs all defined tests in sequence and respects `.skip` and `.only` modifiers.
### Debugging and Output
`@push.rocks/tapbundle` supports colored console output via `consolecolor` to help with debugging and test result readability:
```typescript
tap.test('colored output', async (tools) => {
const coloredString = await tools.coloredString('Hello, world!', 'green');
console.log(coloredString);
});
tap.start();
```
This detailed guide covers the most important aspects of using `@push.rocks/tapbundle` for testing in your TypeScript projects. Explore the included functions and tools to fully leverage this comprehensive testing framework.
## 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) 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.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
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.

View File

@ -21,7 +21,10 @@ const test2 = tap.test('my second test', async (tools) => {
const test3 = tap.test(
'my third test -> test2 should take longer than test1 and endure at least 1000ms',
async () => {
expect((await test1.testPromise).hrtMeasurement.milliSeconds < (await test2).hrtMeasurement.milliSeconds).toBeTrue();
expect(
(await test1.testPromise).hrtMeasurement.milliSeconds <
(await test2).hrtMeasurement.milliSeconds
).toBeTrue();
expect((await test2.testPromise).hrtMeasurement.milliSeconds > 10).toBeTrue();
}
);
@ -42,4 +45,4 @@ const test6 = tap.skip.test('my 6th test -> should fail after 1000ms', async (to
await tools.delayFor(100);
});
tap.start();
await tap.start();

18
test/test.node.ts Normal file
View File

@ -0,0 +1,18 @@
import { tap, expect } from '../ts/index.js';
import { tapNodeTools } from '../ts_node/index.js';
tap.test('should execure a command', async () => {
const result = await tapNodeTools.runCommand('ls -la');
expect(result.exitCode).toEqual(0);
});
tap.test('should create a https cert', async () => {
const { key, cert } = await tapNodeTools.createHttpsCert('localhost');
console.log(key);
console.log(cert);
expect(key).toInclude('-----BEGIN RSA PRIVATE KEY-----');
expect(cert).toInclude('-----BEGIN CERTIFICATE-----');
});
tap.start();

View File

@ -41,4 +41,9 @@ const test6 = tap.skip.test('my 6th test -> should fail after 1000ms', async (to
await tools.delayFor(2000);
});
const test7 = tap.test('my 7th test -> should print a colored string', async (tools) => {
const cs = await tools.coloredString('hello', 'red', 'cyan');
console.log(cs);
});
tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/tapbundle',
version: '5.2.0',
description: 'A test automation library bundling utilities and tools for TAP (Test Anything Protocol) based testing, specifically tailored for tapbuffer.'
}

View File

@ -2,9 +2,6 @@ export { tap } from './tapbundle.classes.tap.js';
export { TapWrap } from './tapbundle.classes.tapwrap.js';
export { webhelpers } from './webhelpers.js';
import { expect, expectAsync } from '@pushrocks/smartexpect';
import { expect, expectAsync } from '@push.rocks/smartexpect';
export {
expect,
expectAsync
}
export { expect, expectAsync };

View File

@ -1,8 +1,8 @@
import * as plugins from './tapbundle.plugins.js';
import { IPreTaskFunction, PreTask } from './tapbundle.classes.pretask.js';
import { TapTest, ITestFunction } from './tapbundle.classes.taptest.js';
export class Tap <T> {
import { type IPreTaskFunction, PreTask } from './tapbundle.classes.pretask.js';
import { TapTest, type ITestFunction } from './tapbundle.classes.taptest.js';
export class Tap<T> {
/**
* skips a test
* tests marked with tap.skip.test() are never executed
@ -143,6 +143,17 @@ export class Tap <T> {
}
}
public async stopForcefully(codeArg = 0, directArg = false) {
console.log(`tap stopping forcefully! Code: ${codeArg} / Direct: ${directArg}`);
if (directArg) {
process.exit(codeArg);
} else {
setTimeout(() => {
process.exit(codeArg);
}, 10)
}
}
/**
* handle errors
*/

View File

@ -3,15 +3,17 @@ import { tapCreator } from './tapbundle.tapcreator.js';
import { TapTools } from './tapbundle.classes.taptools.js';
// imported interfaces
import { Deferred } from '@pushrocks/smartpromise';
import { HrtMeasurement } from '@pushrocks/smarttime';
import { Deferred } from '@push.rocks/smartpromise';
import { HrtMeasurement } from '@push.rocks/smarttime';
// interfaces
export type TTestStatus = 'success' | 'error' | 'pending' | 'errorAfterSuccess' | 'timeout';
export interface ITestFunction <T> { (tapTools?: TapTools): Promise<T> };
export interface ITestFunction<T> {
(tapTools?: TapTools): Promise<T>;
}
export class TapTest <T = unknown> {
export class TapTest<T = unknown> {
public description: string;
public failureAllowed: boolean;
public hrtMeasurement: HrtMeasurement;
@ -27,7 +29,11 @@ export class TapTest <T = unknown> {
/**
* constructor
*/
constructor(optionsArg: { description: string; testFunction: ITestFunction<T>; parallel: boolean }) {
constructor(optionsArg: {
description: string;
testFunction: ITestFunction<T>;
parallel: boolean;
}) {
this.description = optionsArg.description;
this.hrtMeasurement = new HrtMeasurement();
this.parallel = optionsArg.parallel;

View File

@ -33,6 +33,10 @@ export class TapTools {
await plugins.smartdelay.delayForRandom(timeMilliMinArg, timeMilliMaxArg);
}
public async coloredString(...args: Parameters<typeof plugins.consolecolor.coloredString>) {
return plugins.consolecolor.coloredString(...args);
}
public async timeout(timeMilliArg: number) {
const timeout = new plugins.smartdelay.Timeout(timeMilliArg);
timeout.makeUnrefed();
@ -55,4 +59,6 @@ export class TapTools {
public defer() {
return plugins.smartpromise.defer();
}
public smartjson = plugins.smartjson;
}

View File

@ -1,7 +1,9 @@
// pushrocks
import * as smartdelay from '@pushrocks/smartdelay';
import * as smartenv from '@pushrocks/smartenv';
import * as smartexpect from '@pushrocks/smartexpect';
import * as smartpromise from '@pushrocks/smartpromise';
import * as consolecolor from '@push.rocks/consolecolor';
import * as smartdelay from '@push.rocks/smartdelay';
import * as smartenv from '@push.rocks/smartenv';
import * as smartexpect from '@push.rocks/smartexpect';
import * as smartjson from '@push.rocks/smartjson';
import * as smartpromise from '@push.rocks/smartpromise';
export { smartdelay, smartenv, smartexpect, smartpromise };
export { consolecolor, smartdelay, smartenv, smartexpect, smartjson, smartpromise };

View File

@ -1,5 +1,5 @@
import * as plugins from './tapbundle.plugins.js';
import type { fixture, html } from '@open-wc/testing-helpers';
import type { fixture, html } from '@open-wc/testing';
import { tap } from './tapbundle.classes.tap.js';
class WebHelpers {
@ -8,17 +8,17 @@ class WebHelpers {
constructor() {
const smartenv = new plugins.smartenv.Smartenv();
if(smartenv.isBrowser) {
if (smartenv.isBrowser) {
this.enable();
}
}
public enable() {
tap.preTask('enable webhelpers', async () => {
const webhelpers = await import('@open-wc/testing-helpers')
const webhelpers = await import('@open-wc/testing');
this.html = webhelpers.html;
this.fixture = webhelpers.fixture;
})
});
}
}

View File

@ -0,0 +1,63 @@
import * as plugins from './plugins.js';
class TapNodeTools {
private smartshellInstance: plugins.smartshell.Smartshell;
constructor() {}
public async runCommand(commandArg: string): Promise<any> {
if (!this.smartshellInstance) {
this.smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash',
});
}
const result = await this.smartshellInstance.exec(commandArg);
return result;
}
public async createHttpsCert(
commonName: string = 'localhost',
allowSelfSigned: boolean = true
): Promise<{ key: string; cert: string }> {
if (allowSelfSigned) {
// set node to allow self-signed certificates
process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
}
// Generate a key pair
const keys = plugins.smartcrypto.nodeForge.pki.rsa.generateKeyPair(2048);
// Create a self-signed certificate
const cert = plugins.smartcrypto.nodeForge.pki.createCertificate();
cert.publicKey = keys.publicKey;
cert.serialNumber = '01';
cert.validity.notBefore = new Date();
cert.validity.notAfter = new Date();
cert.validity.notAfter.setFullYear(cert.validity.notBefore.getFullYear() + 1);
const attrs = [
{ name: 'commonName', value: commonName },
{ name: 'countryName', value: 'US' },
{ shortName: 'ST', value: 'California' },
{ name: 'localityName', value: 'San Francisco' },
{ name: 'organizationName', value: 'My Company' },
{ shortName: 'OU', value: 'Dev' },
];
cert.setSubject(attrs);
cert.setIssuer(attrs);
// Sign the certificate with its own private key (self-signed)
cert.sign(keys.privateKey, plugins.smartcrypto.nodeForge.md.sha256.create());
// PEM encode the private key and certificate
const pemKey = plugins.smartcrypto.nodeForge.pki.privateKeyToPem(keys.privateKey);
const pemCert = plugins.smartcrypto.nodeForge.pki.certificateToPem(cert);
return {
key: pemKey,
cert: pemCert,
};
}
}
export const tapNodeTools = new TapNodeTools();

1
ts_node/index.ts Normal file
View File

@ -0,0 +1 @@
export * from './classes.tapnodetools.js';

11
ts_node/plugins.ts Normal file
View File

@ -0,0 +1,11 @@
// node native
import * as crypto from 'crypto';
import * as fs from 'fs';
export { crypto,fs };
// @push.rocks scope
import * as smartcrypto from '@push.rocks/smartcrypto';
import * as smartshell from '@push.rocks/smartshell';
export { smartcrypto, smartshell };

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"
}