@genesislcap/foundation-testing 13.6.0 → 13.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dts/suite/suite.d.ts +6 -5
- package/dist/dts/suite/suite.d.ts.map +1 -1
- package/dist/esm/suite/suite.js +6 -5
- package/dist/foundation-testing.api.json +20 -4
- package/dist/foundation-testing.d.ts +6 -5
- package/docs/api/foundation-testing.md +1 -1
- package/docs/api/foundation-testing.runcases.md +1 -1
- package/docs/api-report.md +2 -2
- package/package.json +3 -3
|
@@ -5,16 +5,17 @@ import { assert, uvu } from '../uvu';
|
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
8
|
-
export type RunCases = (fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][]) => void;
|
|
8
|
+
export type RunCases = (fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][], assertion?: (...args: unknown[]) => void) => void;
|
|
9
9
|
/**
|
|
10
10
|
* Assert a set of test cases.
|
|
11
|
-
*
|
|
11
|
+
* @param fn - The function to test.
|
|
12
|
+
* @param cases - An array of test cases to run against the function.
|
|
13
|
+
* @param assertion - Optional uvu assertion method, defaults to assert.equal.
|
|
14
|
+
* @public
|
|
12
15
|
* @remarks
|
|
13
16
|
* This is available as part of the suite context, but can also be run standalone.
|
|
14
|
-
*
|
|
15
|
-
* @public
|
|
16
17
|
*/
|
|
17
|
-
export declare function runCases(fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][]): void;
|
|
18
|
+
export declare function runCases(fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][], assertion?: (...args: unknown[]) => void): void;
|
|
18
19
|
/**
|
|
19
20
|
* @public
|
|
20
21
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"suite.d.ts","sourceRoot":"","sources":["../../../src/suite/suite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,2BAA2B,EAC3B,yBAAyB,EACzB,YAAY,EACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAM,MAAM,4BAA4B,CAAC;AACzE,OAAO,EAAE,OAAO,EAA0C,MAAM,cAAc,CAAC;AAE/E,OAAO,EAAE,MAAM,EAAS,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CACrB,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,EACnC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"suite.d.ts","sourceRoot":"","sources":["../../../src/suite/suite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,2BAA2B,EAC3B,yBAAyB,EACzB,YAAY,EACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAM,MAAM,4BAA4B,CAAC;AACzE,OAAO,EAAE,OAAO,EAA0C,MAAM,cAAc,CAAC;AAE/E,OAAO,EAAE,MAAM,EAAS,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CACrB,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,EACnC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,EAAE,EACtC,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,KACrC,IAAI,CAAC;AAEV;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,EACnC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,EAAE,EACtC,SAAS,GAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAmB,QAMvD;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,yBAAyB,CACzD,2BAA2B,EAC3B,iBAAiB,CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,QAAQ,GAAG,WAAW,CACtD,SAAQ,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IACzD,YAAY,EAAE,YAAY,CAAC;IAC3B,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;CAChF;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,GAAG,WAAW,EACzD,KAAK,EAAE,MAAM,EACb,mBAAmB,EAAE,MAAM,GAAG,aAAa,EAC3C,OAAO,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EACpC,aAAa,GAAE,YAAY,CAAC,GAAG,CAAC,EAAO,GACtC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAyDtC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,GAAG,YAAY,EACtD,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,QAAQ,GACjB,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CASpB"}
|
package/dist/esm/suite/suite.js
CHANGED
|
@@ -5,15 +5,16 @@ import { logger } from '../utils';
|
|
|
5
5
|
import { assert, suite } from '../uvu';
|
|
6
6
|
/**
|
|
7
7
|
* Assert a set of test cases.
|
|
8
|
-
*
|
|
8
|
+
* @param fn - The function to test.
|
|
9
|
+
* @param cases - An array of test cases to run against the function.
|
|
10
|
+
* @param assertion - Optional uvu assertion method, defaults to assert.equal.
|
|
11
|
+
* @public
|
|
9
12
|
* @remarks
|
|
10
13
|
* This is available as part of the suite context, but can also be run standalone.
|
|
11
|
-
*
|
|
12
|
-
* @public
|
|
13
14
|
*/
|
|
14
|
-
export function runCases(fn, cases) {
|
|
15
|
+
export function runCases(fn, cases, assertion = assert.equal) {
|
|
15
16
|
assert.type(fn, 'function');
|
|
16
|
-
cases.forEach(([actual, expects, msg], index) =>
|
|
17
|
+
cases.forEach(([actual, expects, msg], index) => assertion(fn(...actual), expects, msg !== null && msg !== void 0 ? msg : JSON.stringify(actual, null, 2)));
|
|
17
18
|
}
|
|
18
19
|
/**
|
|
19
20
|
* Create component test suite.
|
|
@@ -1528,7 +1528,7 @@
|
|
|
1528
1528
|
{
|
|
1529
1529
|
"kind": "Function",
|
|
1530
1530
|
"canonicalReference": "@genesislcap/foundation-testing!runCases:function(1)",
|
|
1531
|
-
"docComment": "/**\n * Assert a set of test cases.\n *\n * @remarks\n *\n * This is available as part of the suite context, but can also be run standalone.\n *\n * @public\n */\n",
|
|
1531
|
+
"docComment": "/**\n * Assert a set of test cases.\n *\n * @remarks\n *\n * This is available as part of the suite context, but can also be run standalone.\n *\n * @param fn - The function to test.\n *\n * @param cases - An array of test cases to run against the function.\n *\n * @param assertion - Optional uvu assertion method, defaults to assert.equal.\n *\n * @public\n */\n",
|
|
1532
1532
|
"excerptTokens": [
|
|
1533
1533
|
{
|
|
1534
1534
|
"kind": "Content",
|
|
@@ -1546,6 +1546,14 @@
|
|
|
1546
1546
|
"kind": "Content",
|
|
1547
1547
|
"text": "[unknown[], unknown, string?][]"
|
|
1548
1548
|
},
|
|
1549
|
+
{
|
|
1550
|
+
"kind": "Content",
|
|
1551
|
+
"text": ", assertion?: "
|
|
1552
|
+
},
|
|
1553
|
+
{
|
|
1554
|
+
"kind": "Content",
|
|
1555
|
+
"text": "(...args: unknown[]) => void"
|
|
1556
|
+
},
|
|
1549
1557
|
{
|
|
1550
1558
|
"kind": "Content",
|
|
1551
1559
|
"text": "): "
|
|
@@ -1561,8 +1569,8 @@
|
|
|
1561
1569
|
],
|
|
1562
1570
|
"fileUrlPath": "src/suite/suite.ts",
|
|
1563
1571
|
"returnTypeTokenRange": {
|
|
1564
|
-
"startIndex":
|
|
1565
|
-
"endIndex":
|
|
1572
|
+
"startIndex": 7,
|
|
1573
|
+
"endIndex": 8
|
|
1566
1574
|
},
|
|
1567
1575
|
"releaseTag": "Public",
|
|
1568
1576
|
"overloadIndex": 1,
|
|
@@ -1582,6 +1590,14 @@
|
|
|
1582
1590
|
"endIndex": 4
|
|
1583
1591
|
},
|
|
1584
1592
|
"isOptional": false
|
|
1593
|
+
},
|
|
1594
|
+
{
|
|
1595
|
+
"parameterName": "assertion",
|
|
1596
|
+
"parameterTypeTokenRange": {
|
|
1597
|
+
"startIndex": 5,
|
|
1598
|
+
"endIndex": 6
|
|
1599
|
+
},
|
|
1600
|
+
"isOptional": true
|
|
1585
1601
|
}
|
|
1586
1602
|
],
|
|
1587
1603
|
"name": "runCases"
|
|
@@ -1597,7 +1613,7 @@
|
|
|
1597
1613
|
},
|
|
1598
1614
|
{
|
|
1599
1615
|
"kind": "Content",
|
|
1600
|
-
"text": "(fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][]) => void"
|
|
1616
|
+
"text": "(fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][], assertion?: (...args: unknown[]) => void) => void"
|
|
1601
1617
|
},
|
|
1602
1618
|
{
|
|
1603
1619
|
"kind": "Content",
|
|
@@ -283,17 +283,18 @@ export declare function resetTestHarness<T>(wrapper: WithTestHarness<T>): void;
|
|
|
283
283
|
/**
|
|
284
284
|
* @public
|
|
285
285
|
*/
|
|
286
|
-
export declare type RunCases = (fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][]) => void;
|
|
286
|
+
export declare type RunCases = (fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][], assertion?: (...args: unknown[]) => void) => void;
|
|
287
287
|
|
|
288
288
|
/**
|
|
289
289
|
* Assert a set of test cases.
|
|
290
|
-
*
|
|
290
|
+
* @param fn - The function to test.
|
|
291
|
+
* @param cases - An array of test cases to run against the function.
|
|
292
|
+
* @param assertion - Optional uvu assertion method, defaults to assert.equal.
|
|
293
|
+
* @public
|
|
291
294
|
* @remarks
|
|
292
295
|
* This is available as part of the suite context, but can also be run standalone.
|
|
293
|
-
*
|
|
294
|
-
* @public
|
|
295
296
|
*/
|
|
296
|
-
export declare function runCases(fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][]): void;
|
|
297
|
+
export declare function runCases(fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][], assertion?: (...args: unknown[]) => void): void;
|
|
297
298
|
|
|
298
299
|
/**
|
|
299
300
|
* Crates an object with a key value pair for each spied function
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
| [createLogicSuite(title, context)](./foundation-testing.createlogicsuite.md) | Create logic test suite. |
|
|
13
13
|
| [fixture(templateNameOrRegistry, options)](./foundation-testing.fixture.md) | Creates a test fixture suitable for testing custom elements, templates, and bindings. |
|
|
14
14
|
| [resetTestHarness(wrapper)](./foundation-testing.resettestharness.md) | Resets items tracked during testing such as calls to spied functions. Must be called at the end of every test even if not asserting on the spies. |
|
|
15
|
-
| [runCases(fn, cases)](./foundation-testing.runcases.md) | Assert a set of test cases. |
|
|
15
|
+
| [runCases(fn, cases, assertion)](./foundation-testing.runcases.md) | Assert a set of test cases. |
|
|
16
16
|
| [testSpy(constructor)](./foundation-testing.testspy.md) | Decorator: Used on a test harness class based on a <code>FoundationElement</code> to give it extra functionality which can be used during testing. \*Important\* this is to be used on a parent element compared to the element under test. |
|
|
17
17
|
|
|
18
18
|
## Interfaces
|
|
@@ -8,5 +8,5 @@
|
|
|
8
8
|
**Signature:**
|
|
9
9
|
|
|
10
10
|
```typescript
|
|
11
|
-
export type RunCases = (fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][]) => void;
|
|
11
|
+
export type RunCases = (fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][], assertion?: (...args: unknown[]) => void) => void;
|
|
12
12
|
```
|
package/docs/api-report.md
CHANGED
|
@@ -94,10 +94,10 @@ export { Registration }
|
|
|
94
94
|
export function resetTestHarness<T>(wrapper: WithTestHarness<T>): void;
|
|
95
95
|
|
|
96
96
|
// @public (undocumented)
|
|
97
|
-
export type RunCases = (fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][]) => void;
|
|
97
|
+
export type RunCases = (fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][], assertion?: (...args: unknown[]) => void) => void;
|
|
98
98
|
|
|
99
99
|
// @public
|
|
100
|
-
export function runCases(fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][]): void;
|
|
100
|
+
export function runCases(fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][], assertion?: (...args: unknown[]) => void): void;
|
|
101
101
|
|
|
102
102
|
// @public
|
|
103
103
|
export type SinonWrapper<T extends {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-testing",
|
|
3
3
|
"description": "Genesis Foundation Testing",
|
|
4
|
-
"version": "13.
|
|
4
|
+
"version": "13.8.0",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -104,7 +104,7 @@
|
|
|
104
104
|
"webpack-merge": "^5.7.3"
|
|
105
105
|
},
|
|
106
106
|
"dependencies": {
|
|
107
|
-
"@genesislcap/foundation-utils": "^13.
|
|
107
|
+
"@genesislcap/foundation-utils": "^13.8.0",
|
|
108
108
|
"@microsoft/fast-element": "^1.7.0",
|
|
109
109
|
"@microsoft/fast-foundation": "^2.33.2",
|
|
110
110
|
"sinon": "15.0.1",
|
|
@@ -114,5 +114,5 @@
|
|
|
114
114
|
"publishConfig": {
|
|
115
115
|
"access": "public"
|
|
116
116
|
},
|
|
117
|
-
"gitHead": "
|
|
117
|
+
"gitHead": "f4a6a702c9b7f181eb9eaecc9a928026cfaa573d"
|
|
118
118
|
}
|