Compare commits
51 Commits
Author | SHA1 | Date | |
---|---|---|---|
570422ae61 | |||
4ba34a4b88 | |||
ae2aabaa86 | |||
269a8c974e | |||
10ab777e7f | |||
898eed4584 | |||
7a1eae2bfb | |||
8f7167f201 | |||
6fa151f933 | |||
f846b91378 | |||
a0840ee9f4 | |||
041534f363 | |||
c89362ba8a | |||
f07879d2c1 | |||
eba3a19488 | |||
f83479a407 | |||
da711c119f | |||
6690238251 | |||
27a794b83c | |||
b3c4a58491 | |||
50c34f89ee | |||
b813453c5f | |||
9a6dc33b6b | |||
8bf99ae7ec | |||
cc708b29ae | |||
5798d3e808 | |||
37fe299a45 | |||
e24cdd9f0f | |||
ae7aaab456 | |||
bab360cc59 | |||
36dcd228fd | |||
c7d6451758 | |||
aeedf14336 | |||
14b95cfbc3 | |||
0884da7941 | |||
22df58b8bc | |||
33399126f7 | |||
d1e46fd2a7 | |||
9304e6d736 | |||
588c532d6d | |||
e3a756c775 | |||
05defe6031 | |||
f4bb17dea1 | |||
1023a94ff2 | |||
8ee456da5f | |||
45ee6eca31 | |||
1eaf1e9a77 | |||
715108b11b | |||
7b1e8f47b1 | |||
2b71ffe8c2 | |||
29ec99e63e |
@ -19,23 +19,35 @@ mirror:
|
|||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci git mirror
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
audit:
|
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
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci command npm install --ignore-scripts
|
- npmci command npm install --ignore-scripts
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command npm audit --audit-level=high
|
- npmci command npm audit --audit-level=high --only=dev
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
allow_failure: true
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# test stage
|
# test stage
|
||||||
@ -50,9 +62,7 @@ testStable:
|
|||||||
- npmci npm test
|
- npmci npm test
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
- priv
|
|
||||||
|
|
||||||
testBuild:
|
testBuild:
|
||||||
stage: test
|
stage: test
|
||||||
@ -63,9 +73,7 @@ testBuild:
|
|||||||
- npmci command npm run build
|
- npmci command npm run build
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
@ -85,6 +93,8 @@ release:
|
|||||||
codequality:
|
codequality:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g tslint typescript
|
- npmci command npm install -g tslint typescript
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
|
15
.snyk
15
.snyk
@ -1,15 +0,0 @@
|
|||||||
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
|
||||||
version: v1.12.0
|
|
||||||
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
|
|
||||||
ignore:
|
|
||||||
'npm:shelljs:20140723':
|
|
||||||
- smartdelay > typings-global > smartshell > shelljs:
|
|
||||||
reason: None given
|
|
||||||
expires: '2018-07-28T21:47:33.536Z'
|
|
||||||
- early > typings-global > smartshell > shelljs:
|
|
||||||
reason: None given
|
|
||||||
expires: '2018-07-28T21:47:33.537Z'
|
|
||||||
- early > beautycolor > typings-global > smartshell > shelljs:
|
|
||||||
reason: None given
|
|
||||||
expires: '2018-07-28T21:47:33.537Z'
|
|
||||||
patch: {}
|
|
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
@ -15,7 +15,7 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"projectType": {
|
"projectType": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["website", "element", "service", "npm"]
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
10978
package-lock.json
generated
10978
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
32
package.json
32
package.json
@ -1,13 +1,14 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/tapbundle",
|
"name": "@pushrocks/tapbundle",
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "3.2.7",
|
"version": "5.0.7",
|
||||||
"description": "tap bundled for tapbuffer",
|
"description": "tap bundled for tapbuffer",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(tstest test/)",
|
||||||
"build": "(tsbuild --web)"
|
"build": "(tsbuild --web --allowimplicitany)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -20,20 +21,20 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/tapbundle#README",
|
"homepage": "https://gitlab.com/pushrocks/tapbundle#README",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smartdelay": "^2.0.9",
|
"@open-wc/testing": "^3.2.0",
|
||||||
"@pushrocks/smartenv": "^4.0.10",
|
"@open-wc/testing-helpers": "^2.3.0",
|
||||||
"@pushrocks/smartpromise": "^3.0.2",
|
"@pushrocks/smartdelay": "^3.0.1",
|
||||||
"@pushrocks/smarttime": "^3.0.19",
|
"@pushrocks/smartenv": "^5.0.2",
|
||||||
"smartchai": "^2.0.1"
|
"@pushrocks/smartexpect": "^1.0.15",
|
||||||
|
"@pushrocks/smartpromise": "^4.0.2",
|
||||||
|
"@pushrocks/smarttime": "^4.0.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.24",
|
"@gitzone/tsbuild": "^2.1.66",
|
||||||
"@gitzone/tsrun": "^1.2.12",
|
"@gitzone/tsrun": "^1.2.42",
|
||||||
"@gitzone/tstest": "^1.0.36",
|
"@gitzone/tstest": "^1.0.72",
|
||||||
"@types/node": "^14.0.19",
|
"@types/node": "^20.3.1",
|
||||||
"randomstring": "^1.1.5",
|
"randomstring": "^1.3.0"
|
||||||
"tslint": "^6.1.2",
|
|
||||||
"tslint-config-prettier": "^1.18.0"
|
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
@ -46,5 +47,8 @@
|
|||||||
"cli.js",
|
"cli.js",
|
||||||
"npmextra.json",
|
"npmextra.json",
|
||||||
"readme.md"
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
4279
pnpm-lock.yaml
generated
Normal file
4279
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
54
readme.md
54
readme.md
@ -1,5 +1,5 @@
|
|||||||
# @pushrocks/tapbundle
|
# @pushrocks/tapbundle
|
||||||
tap bundled for tapbuffer
|
tap based testing framework for use with @gitzone/tstest
|
||||||
|
|
||||||
## Availabililty and Links
|
## Availabililty and Links
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/tapbundle)
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/tapbundle)
|
||||||
@ -8,13 +8,20 @@ tap bundled for tapbuffer
|
|||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/tapbundle/)
|
* [docs (typedoc)](https://pushrocks.gitlab.io/tapbundle/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
[](https://gitlab.com/pushrocks/tapbundle/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/tapbundle/commits/master)
|
Status Category | Status Badge
|
||||||
[](https://www.npmjs.com/package/@pushrocks/tapbundle)
|
-- | --
|
||||||
[](https://snyk.io/test/npm/@pushrocks/tapbundle)
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
npm | [](https://lossless.cloud)
|
||||||
[](https://prettier.io/)
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -24,41 +31,46 @@ A few words on TypeScript
|
|||||||
|
|
||||||
### Included in this package
|
### Included in this package
|
||||||
|
|
||||||
- tap compatible testing framework written in TypeScript
|
* tap compatible testing framework written in TypeScript
|
||||||
- a collection of test tools
|
* `expect` and `expectAsync` from the package `@pushrocks/smartexpect`
|
||||||
- **code** testing framework with typings
|
|
||||||
|
### 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
|
### Write your first tests
|
||||||
|
|
||||||
```javascript
|
```typescript
|
||||||
import { tap, expect } from 'tapbundle'; // has typings in place
|
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
|
import * as myAwesomeModuleToTest from '../dist/index'; // '../dist/index' is the standard path for npmts modules
|
||||||
|
|
||||||
tap.test('my awesome description', async tools => {
|
tap.test('my awesome description', async (tools) => {
|
||||||
// tools are optional parameter
|
// tools are optional parameter
|
||||||
tools.timeout(2000); // test will fail if it takes longer than 2000 millisenconds
|
tools.timeout(2000); // test will fail if it takes longer than 2000 millisenconds
|
||||||
});
|
});
|
||||||
|
|
||||||
let myTest2 = tap.test('my awesome test 2', async tools => {
|
const myTest2 = tap.test('my awesome test 2', async (tools) => {
|
||||||
myAwsomeModuleToTest.doSomethingAsync(); // we don't wait here
|
myAwsomeModuleToTest.doSomethingAsync(); // we don't wait here
|
||||||
await tools.delayFor(3000); // yay! :) promise based timeouts :)
|
await tools.delayFor(3000); // yay! :) promise based timeouts :)
|
||||||
console.log('This gets logged 3000 ms into the test');
|
console.log('This gets logged 3000 ms into the test');
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('my awesome test 3', async tools => {
|
tap.test('my awesome test 3', async (tools) => {
|
||||||
expect(true).to.be.true; // will not throw
|
expect(true).toBeTrue(); // will not throw
|
||||||
await expect(tools.delayFor(2000)).to.eventually.be.fulfilled; // yay expect promises :)
|
await expectAsync(tools.delayFor(2000)).toBeUndefined(); // yay expect promises :)
|
||||||
expect((await myTest2.promise).hrtMeasurement.milliSeconds > 1000).to.be.true; // access other tests metadata :)
|
expectAsync(myTest2.promise) // access other tests metadata :)
|
||||||
|
.property('hrtMeasurement') // and drill down into properties
|
||||||
|
.property('milliSeconds').toBeGreaterThan(1000);
|
||||||
});
|
});
|
||||||
|
|
||||||
let myTest4 = tap.testParallel('my awesome test 4', async tools => {
|
const myTest4 = tap.testParallel('my awesome test 4', async (tools) => {
|
||||||
await tools.delayFor(4000);
|
await tools.delayFor(4000);
|
||||||
console.log('logs to console after 4 seconds into this test');
|
console.log('logs to console after 4 seconds into this test');
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('my awesome test 5', async () => {
|
tap.test('my awesome test 5', async () => {
|
||||||
expect(myTest4.status).to.equal('pending'); // since this test will likely finish before myTest4.
|
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)
|
tap.start(); // start the test, will automtically plan tests for you (so the tap parser knows when tests exit bofore they are finished)
|
||||||
|
@ -1,11 +1,17 @@
|
|||||||
import { tap, expect } from '../ts/index';
|
import { tap, expect, webhelpers } from '../ts/index.js';
|
||||||
|
|
||||||
tap.preTask('hi there', async () => {
|
tap.preTask('custompretask', async () => {
|
||||||
console.log('this is a pretask');
|
console.log('this is a pretask');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
tap.test('should have access to webhelpers', async () => {
|
||||||
|
const myElement = await webhelpers.fixture(webhelpers.html`<div></div>`);
|
||||||
|
expect(myElement).toBeInstanceOf(HTMLElement);
|
||||||
|
console.log(myElement);
|
||||||
|
});
|
||||||
|
|
||||||
const test1 = tap.test('my first test -> expect true to be true', async () => {
|
const test1 = tap.test('my first test -> expect true to be true', async () => {
|
||||||
return expect(true).to.be.true;
|
return expect(true).toBeTrue();
|
||||||
});
|
});
|
||||||
|
|
||||||
const test2 = tap.test('my second test', async (tools) => {
|
const test2 = tap.test('my second test', async (tools) => {
|
||||||
@ -15,15 +21,14 @@ const test2 = tap.test('my second test', async (tools) => {
|
|||||||
const test3 = tap.test(
|
const test3 = tap.test(
|
||||||
'my third test -> test2 should take longer than test1 and endure at least 1000ms',
|
'my third test -> test2 should take longer than test1 and endure at least 1000ms',
|
||||||
async () => {
|
async () => {
|
||||||
expect((await test1).hrtMeasurement.milliSeconds < (await test2).hrtMeasurement.milliSeconds).to
|
expect((await test1.testPromise).hrtMeasurement.milliSeconds < (await test2).hrtMeasurement.milliSeconds).toBeTrue();
|
||||||
.be.true;
|
expect((await test2.testPromise).hrtMeasurement.milliSeconds > 10).toBeTrue();
|
||||||
expect((await test2).hrtMeasurement.milliSeconds > 10).to.be.true;
|
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
const test4 = tap.skip.test('my 4th test -> should fail', async (tools) => {
|
const test4 = tap.skip.test('my 4th test -> should fail', async (tools) => {
|
||||||
tools.allowFailure();
|
tools.allowFailure();
|
||||||
expect(false).to.be.true;
|
expect(false).toBeTrue();
|
||||||
});
|
});
|
||||||
|
|
||||||
const test5 = tap.test('my 5th test -> should pass in about 500ms', async (tools) => {
|
const test5 = tap.test('my 5th test -> should pass in about 500ms', async (tools) => {
|
@ -1,21 +0,0 @@
|
|||||||
import { tap, expect } from '../ts/index';
|
|
||||||
import * as randomstring from 'randomstring';
|
|
||||||
|
|
||||||
const test1 = tap.test('my first test -> expect true to be true', async (tools) => {
|
|
||||||
await tools.checkIterationLeak(async () => {
|
|
||||||
const domain = randomstring.generate(1000);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
const outsideArray = [];
|
|
||||||
|
|
||||||
const test2 = tap.test('should throw', async (tools) => {
|
|
||||||
const err = await tools.returnError(async () => {
|
|
||||||
await tools.checkIterationLeak(async () => {
|
|
||||||
outsideArray.push(randomstring.generate(1000));
|
|
||||||
});
|
|
||||||
});
|
|
||||||
expect(err).to.be.undefined;
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.start();
|
|
@ -1,10 +1,5 @@
|
|||||||
import { tap, expect } from '../ts/index';
|
import { tap, expect, TapWrap } from '../ts/index.js';
|
||||||
|
|
||||||
const tapwrap = tap.wrap(async () => {
|
tap.test('should run a test', async () => {});
|
||||||
tap.test('should do something', async () => {
|
|
||||||
console.log('test1');
|
|
||||||
});
|
|
||||||
tap.start();
|
|
||||||
});
|
|
||||||
|
|
||||||
tapwrap.run();
|
tap.start();
|
||||||
|
18
test/test.ts
18
test/test.ts
@ -1,11 +1,11 @@
|
|||||||
import { tap, expect } from '../ts/index';
|
import { tap, expect } from '../ts/index.js';
|
||||||
|
|
||||||
tap.preTask('hi there', async () => {
|
tap.preTask('hi there', async () => {
|
||||||
console.log('this is a pretask');
|
console.log('this is a pretask');
|
||||||
});
|
});
|
||||||
|
|
||||||
const test1 = tap.test('my first test -> expect true to be true', async () => {
|
const test1 = tap.test('my first test -> expect true to be true', async () => {
|
||||||
return expect(true).to.be.true;
|
return expect(true).toBeTrue();
|
||||||
});
|
});
|
||||||
|
|
||||||
const test2 = tap.test('my second test', async (tools) => {
|
const test2 = tap.test('my second test', async (tools) => {
|
||||||
@ -15,18 +15,22 @@ const test2 = tap.test('my second test', async (tools) => {
|
|||||||
const test3 = tap.test(
|
const test3 = tap.test(
|
||||||
'my third test -> test2 should take longer than test1 and endure at least 1000ms',
|
'my third test -> test2 should take longer than test1 and endure at least 1000ms',
|
||||||
async () => {
|
async () => {
|
||||||
expect((await test1).hrtMeasurement.milliSeconds < (await test2).hrtMeasurement.milliSeconds).to
|
expect(
|
||||||
.be.true;
|
(await test1.testPromise).hrtMeasurement.milliSeconds <
|
||||||
expect((await test2).hrtMeasurement.milliSeconds > 1000).to.be.true;
|
(await test2).hrtMeasurement.milliSeconds
|
||||||
|
).toBeTrue();
|
||||||
|
expect((await test2.testPromise).hrtMeasurement.milliSeconds > 1000).toBeTrue();
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
const test4 = tap.skip.test('my 4th test -> should fail', async (tools) => {
|
const test4 = tap.test('my 4th test -> should fail', async (tools) => {
|
||||||
tools.allowFailure();
|
tools.allowFailure();
|
||||||
expect(false).to.be.true;
|
expect(false).toBeFalse();
|
||||||
|
return 'hello';
|
||||||
});
|
});
|
||||||
|
|
||||||
const test5 = tap.test('my 5th test -> should pass in about 500ms', async (tools) => {
|
const test5 = tap.test('my 5th test -> should pass in about 500ms', async (tools) => {
|
||||||
|
const test4Result = await test4.testResultPromise;
|
||||||
tools.timeout(1000);
|
tools.timeout(1000);
|
||||||
await tools.delayFor(500);
|
await tools.delayFor(500);
|
||||||
});
|
});
|
||||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@pushrocks/tapbundle',
|
||||||
|
version: '5.0.7',
|
||||||
|
description: 'tap bundled for tapbuffer'
|
||||||
|
}
|
12
ts/index.ts
12
ts/index.ts
@ -1,2 +1,10 @@
|
|||||||
export { expect } from 'smartchai';
|
export { tap } from './tapbundle.classes.tap.js';
|
||||||
export { tap } from './tapbundle.classes.tap';
|
export { TapWrap } from './tapbundle.classes.tapwrap.js';
|
||||||
|
export { webhelpers } from './webhelpers.js';
|
||||||
|
|
||||||
|
import { expect, expectAsync } from '@pushrocks/smartexpect';
|
||||||
|
|
||||||
|
export {
|
||||||
|
expect,
|
||||||
|
expectAsync
|
||||||
|
}
|
@ -1,5 +1,5 @@
|
|||||||
import * as plugins from './tapbundle.plugins';
|
import * as plugins from './tapbundle.plugins.js';
|
||||||
import { TapTools } from './tapbundle.classes.taptools';
|
import { TapTools } from './tapbundle.classes.taptools.js';
|
||||||
|
|
||||||
export interface IPreTaskFunction {
|
export interface IPreTaskFunction {
|
||||||
(tapTools?: TapTools): Promise<any>;
|
(tapTools?: TapTools): Promise<any>;
|
||||||
|
@ -1,18 +1,17 @@
|
|||||||
import * as plugins from './tapbundle.plugins';
|
import * as plugins from './tapbundle.plugins.js';
|
||||||
|
|
||||||
import { IPreTaskFunction, PreTask } from './tapbundle.classes.pretask';
|
import { type IPreTaskFunction, PreTask } from './tapbundle.classes.pretask.js';
|
||||||
import { TapTest, ITestFunction } from './tapbundle.classes.taptest';
|
import { TapTest, type ITestFunction } from './tapbundle.classes.taptest.js';
|
||||||
import { TapWrap, ITapWrapFunction } from './tapbundle.classes.tapwrap';
|
export class Tap<T> {
|
||||||
export class Tap {
|
|
||||||
/**
|
/**
|
||||||
* skips a test
|
* skips a test
|
||||||
* tests marked with tap.skip.test() are never executed
|
* tests marked with tap.skip.test() are never executed
|
||||||
*/
|
*/
|
||||||
public skip = {
|
public skip = {
|
||||||
test: (descriptionArg: string, functionArg: ITestFunction) => {
|
test: (descriptionArg: string, functionArg: ITestFunction<T>) => {
|
||||||
console.log(`skipped test: ${descriptionArg}`);
|
console.log(`skipped test: ${descriptionArg}`);
|
||||||
},
|
},
|
||||||
testParallel: (descriptionArg: string, functionArg: ITestFunction) => {
|
testParallel: (descriptionArg: string, functionArg: ITestFunction<T>) => {
|
||||||
console.log(`skipped test: ${descriptionArg}`);
|
console.log(`skipped test: ${descriptionArg}`);
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
@ -21,26 +20,26 @@ export class Tap {
|
|||||||
* only executes tests marked as ONLY
|
* only executes tests marked as ONLY
|
||||||
*/
|
*/
|
||||||
public only = {
|
public only = {
|
||||||
test: (descriptionArg: string, testFunctionArg: ITestFunction) => {
|
test: (descriptionArg: string, testFunctionArg: ITestFunction<T>) => {
|
||||||
this.test(descriptionArg, testFunctionArg, 'only');
|
this.test(descriptionArg, testFunctionArg, 'only');
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
private _tapPreTasks: PreTask[] = [];
|
private _tapPreTasks: PreTask[] = [];
|
||||||
private _tapTests: TapTest[] = [];
|
private _tapTests: TapTest<any>[] = [];
|
||||||
private _tapTestsOnly: TapTest[] = [];
|
private _tapTestsOnly: TapTest<any>[] = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normal test function, will run one by one
|
* Normal test function, will run one by one
|
||||||
* @param testDescription - A description of what the test does
|
* @param testDescription - A description of what the test does
|
||||||
* @param testFunction - A Function that returns a Promise and resolves or rejects
|
* @param testFunction - A Function that returns a Promise and resolves or rejects
|
||||||
*/
|
*/
|
||||||
public async test(
|
public test(
|
||||||
testDescription: string,
|
testDescription: string,
|
||||||
testFunction: ITestFunction,
|
testFunction: ITestFunction<T>,
|
||||||
modeArg: 'normal' | 'only' | 'skip' = 'normal'
|
modeArg: 'normal' | 'only' | 'skip' = 'normal'
|
||||||
) {
|
): TapTest<T> {
|
||||||
const localTest = new TapTest({
|
const localTest = new TapTest<T>({
|
||||||
description: testDescription,
|
description: testDescription,
|
||||||
testFunction,
|
testFunction,
|
||||||
parallel: false,
|
parallel: false,
|
||||||
@ -57,19 +56,12 @@ export class Tap {
|
|||||||
this._tapPreTasks.push(new PreTask(descriptionArg, functionArg));
|
this._tapPreTasks.push(new PreTask(descriptionArg, functionArg));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* wraps function
|
|
||||||
*/
|
|
||||||
public wrap(functionArg: ITapWrapFunction) {
|
|
||||||
return new TapWrap(functionArg);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A parallel test that will not be waited for before the next starts.
|
* A parallel test that will not be waited for before the next starts.
|
||||||
* @param testDescription - A description of what the test does
|
* @param testDescription - A description of what the test does
|
||||||
* @param testFunction - A Function that returns a Promise and resolves or rejects
|
* @param testFunction - A Function that returns a Promise and resolves or rejects
|
||||||
*/
|
*/
|
||||||
public testParallel(testDescription: string, testFunction: ITestFunction) {
|
public testParallel(testDescription: string, testFunction: ITestFunction<T>) {
|
||||||
this._tapTests.push(
|
this._tapTests.push(
|
||||||
new TapTest({
|
new TapTest({
|
||||||
description: testDescription,
|
description: testDescription,
|
||||||
@ -86,7 +78,7 @@ export class Tap {
|
|||||||
// lets set the tapbundle promise
|
// lets set the tapbundle promise
|
||||||
const smartenvInstance = new plugins.smartenv.Smartenv();
|
const smartenvInstance = new plugins.smartenv.Smartenv();
|
||||||
smartenvInstance.isBrowser
|
smartenvInstance.isBrowser
|
||||||
? (globalThis.tapbundleDeferred = plugins.smartpromise.defer())
|
? ((globalThis as any).tapbundleDeferred = plugins.smartpromise.defer())
|
||||||
: null;
|
: null;
|
||||||
|
|
||||||
// lets continue with running the tests
|
// lets continue with running the tests
|
||||||
@ -147,14 +139,14 @@ export class Tap {
|
|||||||
if (!smartenvInstance.isBrowser) process.exit(1);
|
if (!smartenvInstance.isBrowser) process.exit(1);
|
||||||
}
|
}
|
||||||
if (smartenvInstance.isBrowser) {
|
if (smartenvInstance.isBrowser) {
|
||||||
globalThis.tapbundleDeferred.resolve();
|
(globalThis as any).tapbundleDeferred.resolve();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* handle errors
|
* handle errors
|
||||||
*/
|
*/
|
||||||
public threw(err) {
|
public threw(err: Error) {
|
||||||
console.log(err);
|
console.log(err);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
import * as plugins from './tapbundle.plugins';
|
import * as plugins from './tapbundle.plugins.js';
|
||||||
import { tapCreator } from './tapbundle.tapcreator';
|
import { tapCreator } from './tapbundle.tapcreator.js';
|
||||||
import { TapTools } from './tapbundle.classes.taptools';
|
import { TapTools } from './tapbundle.classes.taptools.js';
|
||||||
|
|
||||||
// imported interfaces
|
// imported interfaces
|
||||||
import { Deferred } from '@pushrocks/smartpromise';
|
import { Deferred } from '@pushrocks/smartpromise';
|
||||||
@ -9,23 +9,25 @@ import { HrtMeasurement } from '@pushrocks/smarttime';
|
|||||||
// interfaces
|
// interfaces
|
||||||
export type TTestStatus = 'success' | 'error' | 'pending' | 'errorAfterSuccess' | 'timeout';
|
export type TTestStatus = 'success' | 'error' | 'pending' | 'errorAfterSuccess' | 'timeout';
|
||||||
|
|
||||||
export type ITestFunction = (tapTools?: TapTools) => Promise<any>;
|
export interface ITestFunction <T> { (tapTools?: TapTools): Promise<T> };
|
||||||
|
|
||||||
export class TapTest {
|
export class TapTest <T = unknown> {
|
||||||
public description: string;
|
public description: string;
|
||||||
public failureAllowed: boolean;
|
public failureAllowed: boolean;
|
||||||
public hrtMeasurement: HrtMeasurement;
|
public hrtMeasurement: HrtMeasurement;
|
||||||
public parallel: boolean;
|
public parallel: boolean;
|
||||||
public status: TTestStatus;
|
public status: TTestStatus;
|
||||||
public tapTools: TapTools;
|
public tapTools: TapTools;
|
||||||
public testFunction: ITestFunction;
|
public testFunction: ITestFunction<T>;
|
||||||
public testKey: number; // the testKey the position in the test qeue. Set upon calling .run()
|
public testKey: number; // the testKey the position in the test qeue. Set upon calling .run()
|
||||||
public testDeferred: Deferred<TapTest> = plugins.smartpromise.defer();
|
private testDeferred: Deferred<TapTest<T>> = plugins.smartpromise.defer();
|
||||||
public testPromise: Promise<TapTest> = this.testDeferred.promise;
|
public testPromise: Promise<TapTest<T>> = this.testDeferred.promise;
|
||||||
|
private testResultDeferred: Deferred<T> = plugins.smartpromise.defer();
|
||||||
|
public testResultPromise: Promise<T> = this.testResultDeferred.promise;
|
||||||
/**
|
/**
|
||||||
* constructor
|
* constructor
|
||||||
*/
|
*/
|
||||||
constructor(optionsArg: { description: string; testFunction: ITestFunction; parallel: boolean }) {
|
constructor(optionsArg: { description: string; testFunction: ITestFunction<T>; parallel: boolean }) {
|
||||||
this.description = optionsArg.description;
|
this.description = optionsArg.description;
|
||||||
this.hrtMeasurement = new HrtMeasurement();
|
this.hrtMeasurement = new HrtMeasurement();
|
||||||
this.parallel = optionsArg.parallel;
|
this.parallel = optionsArg.parallel;
|
||||||
@ -42,7 +44,7 @@ export class TapTest {
|
|||||||
this.testKey = testKeyArg;
|
this.testKey = testKeyArg;
|
||||||
const testNumber = testKeyArg + 1;
|
const testNumber = testKeyArg + 1;
|
||||||
try {
|
try {
|
||||||
await this.testFunction(this.tapTools);
|
const testReturnValue = await this.testFunction(this.tapTools);
|
||||||
if (this.status === 'timeout') {
|
if (this.status === 'timeout') {
|
||||||
throw new Error('Test succeeded, but timed out...');
|
throw new Error('Test succeeded, but timed out...');
|
||||||
}
|
}
|
||||||
@ -52,12 +54,14 @@ export class TapTest {
|
|||||||
);
|
);
|
||||||
this.status = 'success';
|
this.status = 'success';
|
||||||
this.testDeferred.resolve(this);
|
this.testDeferred.resolve(this);
|
||||||
} catch (err) {
|
this.testResultDeferred.resolve(testReturnValue);
|
||||||
|
} catch (err: any) {
|
||||||
this.hrtMeasurement.stop();
|
this.hrtMeasurement.stop();
|
||||||
console.log(
|
console.log(
|
||||||
`not ok ${testNumber} - ${this.description} # time=${this.hrtMeasurement.milliSeconds}ms`
|
`not ok ${testNumber} - ${this.description} # time=${this.hrtMeasurement.milliSeconds}ms`
|
||||||
);
|
);
|
||||||
this.testDeferred.resolve(this);
|
this.testDeferred.resolve(this);
|
||||||
|
this.testResultDeferred.resolve(err);
|
||||||
|
|
||||||
// if the test has already succeeded before
|
// if the test has already succeeded before
|
||||||
if (this.status === 'success') {
|
if (this.status === 'success') {
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
import * as plugins from './tapbundle.plugins';
|
import * as plugins from './tapbundle.plugins.js';
|
||||||
import { TapTest } from './tapbundle.classes.taptest';
|
import { TapTest } from './tapbundle.classes.taptest.js';
|
||||||
|
|
||||||
export interface IPromiseFunc {
|
export interface IPromiseFunc {
|
||||||
(): Promise<any>;
|
(): Promise<any>;
|
||||||
@ -11,7 +11,7 @@ export class TapTools {
|
|||||||
*/
|
*/
|
||||||
private _tapTest: TapTest;
|
private _tapTest: TapTest;
|
||||||
|
|
||||||
constructor(TapTestArg) {
|
constructor(TapTestArg: TapTest<any>) {
|
||||||
this._tapTest = TapTestArg;
|
this._tapTest = TapTestArg;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -25,11 +25,11 @@ export class TapTools {
|
|||||||
/**
|
/**
|
||||||
* async/await delay method
|
* async/await delay method
|
||||||
*/
|
*/
|
||||||
public async delayFor(timeMilliArg) {
|
public async delayFor(timeMilliArg: number) {
|
||||||
await plugins.smartdelay.delayFor(timeMilliArg);
|
await plugins.smartdelay.delayFor(timeMilliArg);
|
||||||
}
|
}
|
||||||
|
|
||||||
public async delayForRandom(timeMilliMinArg, timeMilliMaxArg) {
|
public async delayForRandom(timeMilliMinArg: number, timeMilliMaxArg: number) {
|
||||||
await plugins.smartdelay.delayForRandom(timeMilliMinArg, timeMilliMaxArg);
|
await plugins.smartdelay.delayForRandom(timeMilliMinArg, timeMilliMaxArg);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -42,15 +42,11 @@ export class TapTools {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public async checkIterationLeak(iterationfuncArg: IPromiseFunc) {
|
|
||||||
console.log('iteration leakage checks disabled for now due to incompatibilities with node v12');
|
|
||||||
}
|
|
||||||
|
|
||||||
public async returnError(throwingFuncArg: IPromiseFunc) {
|
public async returnError(throwingFuncArg: IPromiseFunc) {
|
||||||
let funcErr: Error;
|
let funcErr: Error;
|
||||||
try {
|
try {
|
||||||
await throwingFuncArg();
|
await throwingFuncArg();
|
||||||
} catch (err) {
|
} catch (err: any) {
|
||||||
funcErr = err;
|
funcErr = err;
|
||||||
}
|
}
|
||||||
return funcErr;
|
return funcErr;
|
||||||
|
@ -1,25 +1,13 @@
|
|||||||
import * as plugins from './tapbundle.plugins';
|
import * as plugins from './tapbundle.plugins.js';
|
||||||
|
|
||||||
export interface ITapWrapFunction {
|
export interface ITapWrapOptions {
|
||||||
(): Promise<any>;
|
before: () => Promise<any>;
|
||||||
|
after: () => {};
|
||||||
}
|
}
|
||||||
|
|
||||||
export class TapWrap {
|
export class TapWrap {
|
||||||
wrapFunction: ITapWrapFunction;
|
public options: ITapWrapOptions;
|
||||||
|
constructor(optionsArg: ITapWrapOptions) {
|
||||||
/**
|
this.options = optionsArg;
|
||||||
* the constructor
|
|
||||||
*/
|
|
||||||
constructor(wrapFunctionArg: ITapWrapFunction) {
|
|
||||||
// nothing here
|
|
||||||
this.wrapFunction = wrapFunctionArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* run the wrapFunction
|
|
||||||
*/
|
|
||||||
async run() {
|
|
||||||
// TODO: make sure it makes sense what we do here.
|
|
||||||
await this.wrapFunction();
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,11 +1,7 @@
|
|||||||
// pushrocks
|
// pushrocks
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartdelay from '@pushrocks/smartdelay';
|
||||||
import * as smartenv from '@pushrocks/smartenv';
|
import * as smartenv from '@pushrocks/smartenv';
|
||||||
|
import * as smartexpect from '@pushrocks/smartexpect';
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
|
|
||||||
export { smartdelay, smartenv, smartpromise };
|
export { smartdelay, smartenv, smartexpect, smartpromise };
|
||||||
|
|
||||||
// third party
|
|
||||||
/* import * as leakage from 'leakage';
|
|
||||||
|
|
||||||
export { leakage }; */
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
import * as plugins from './tapbundle.plugins';
|
import * as plugins from './tapbundle.plugins.js';
|
||||||
|
|
||||||
export class TapCreator {
|
export class TapCreator {
|
||||||
// TODO:
|
// TODO:
|
||||||
|
25
ts/webhelpers.ts
Normal file
25
ts/webhelpers.ts
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
import * as plugins from './tapbundle.plugins.js';
|
||||||
|
import type { fixture, html } from '@open-wc/testing-helpers';
|
||||||
|
import { tap } from './tapbundle.classes.tap.js';
|
||||||
|
|
||||||
|
class WebHelpers {
|
||||||
|
html: typeof html;
|
||||||
|
fixture: typeof fixture;
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
const smartenv = new plugins.smartenv.Smartenv();
|
||||||
|
if(smartenv.isBrowser) {
|
||||||
|
this.enable();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public enable() {
|
||||||
|
tap.preTask('enable webhelpers', async () => {
|
||||||
|
const webhelpers = await import('@open-wc/testing');
|
||||||
|
this.html = webhelpers.html;
|
||||||
|
this.fixture = webhelpers.fixture;
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const webhelpers = new WebHelpers();
|
11
tsconfig.json
Normal file
11
tsconfig.json
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "ES2022",
|
||||||
|
"moduleResolution": "nodenext",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"verbatimModuleSyntax": true,
|
||||||
|
}
|
||||||
|
}
|
17
tslint.json
17
tslint.json
@ -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"
|
|
||||||
}
|
|
Reference in New Issue
Block a user