testplane 8.13.0 → 8.14.1
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/README.md +2 -2
- package/build/package.json +1 -1
- package/build/src/error-snippets/index.js +3 -3
- package/build/src/error-snippets/index.js.map +1 -1
- package/build/src/error-snippets/utils.d.ts +1 -0
- package/build/src/error-snippets/utils.js +11 -1
- package/build/src/error-snippets/utils.js.map +1 -1
- package/build/src/index.d.ts +1 -1
- package/build/src/test-reader/test-object/test.d.ts +1 -0
- package/build/src/test-reader/test-object/test.js.map +1 -1
- package/build/src/types/index.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -52,7 +52,7 @@ Testplane (ex-Hermione) is a battle-hardened framework for testing web apps at a
|
|
|
52
52
|
|
|
53
53
|
const description = await browser.$("p");
|
|
54
54
|
|
|
55
|
-
expect(description).toHaveTextContaining("for use in illustrative examples in documents");
|
|
55
|
+
await expect(description).toHaveTextContaining("for use in illustrative examples in documents");
|
|
56
56
|
});
|
|
57
57
|
});
|
|
58
58
|
```
|
|
@@ -66,7 +66,7 @@ Testplane (ex-Hermione) is a battle-hardened framework for testing web apps at a
|
|
|
66
66
|
4. Try running the test and watch it pass. Now, let's replace description text check with a visual assertion. Use the `assertView` command to carry out visual checks:
|
|
67
67
|
|
|
68
68
|
```diff
|
|
69
|
-
- expect(description).toHaveTextContaining("for use in illustrative examples in documents");
|
|
69
|
+
- await expect(description).toHaveTextContaining("for use in illustrative examples in documents");
|
|
70
70
|
+ await description.assertView("description"); // "description" is just a name of the assertion
|
|
71
71
|
```
|
|
72
72
|
|
package/build/package.json
CHANGED
|
@@ -16,10 +16,10 @@ const stackFrameLocationResolver = async (stackFrame) => {
|
|
|
16
16
|
: (0, frames_1.resolveLocationWithStackFrame)(stackFrame, fileContents);
|
|
17
17
|
};
|
|
18
18
|
const extendWithCodeSnippet = async (err) => {
|
|
19
|
-
if (!err) {
|
|
20
|
-
return err;
|
|
21
|
-
}
|
|
22
19
|
try {
|
|
20
|
+
if ((0, utils_1.shouldNotAddCodeSnippet)(err)) {
|
|
21
|
+
return err;
|
|
22
|
+
}
|
|
23
23
|
const relevantStackFrame = (0, frames_1.findRelevantStackFrame)(err);
|
|
24
24
|
if (!relevantStackFrame) {
|
|
25
25
|
return err;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/error-snippets/index.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAiF;AACjF,+CAAgF;AAChF,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/error-snippets/index.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAiF;AACjF,+CAAgF;AAChF,mCAAyF;AACzF,6DAAqC;AAGrC,MAAM,0BAA0B,GAAG,KAAK,EAAE,UAAgC,EAA0B,EAAE;IAClG,MAAM,YAAY,GAAG,MAAM,IAAA,yBAAiB,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAClE,MAAM,UAAU,GAAG,MAAM,IAAA,+BAAiB,EAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;IAE9E,OAAO,UAAU;QACb,CAAC,CAAC,IAAA,0CAA4B,EAAC,UAAU,EAAE,UAAU,CAAC;QACtD,CAAC,CAAC,IAAA,sCAA6B,EAAC,UAAU,EAAE,YAAY,CAAC,CAAC;AAClE,CAAC,CAAC;AAEK,MAAM,qBAAqB,GAAG,KAAK,EAAE,GAAqB,EAA6B,EAAE;IAC5F,IAAI,CAAC;QACD,IAAI,IAAA,+BAAuB,EAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,OAAO,GAAG,CAAC;QACf,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAA,+BAAsB,EAAC,GAAG,CAAC,CAAC;QAEvD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACtB,OAAO,GAAG,CAAC;QACf,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,0BAA0B,CAAC,kBAAkB,CAAC,CAAC;QAExF,GAAG,CAAC,OAAO,GAAG,IAAA,0BAAkB,EAAC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;QAElE,OAAO,GAAG,CAAC;IACf,CAAC;IAAC,OAAO,YAAY,EAAE,CAAC;QACpB,gBAAM,CAAC,IAAI,CAAC,+BAA+B,EAAE,YAAY,CAAC,CAAC;QAE3D,OAAO,GAAG,CAAC;IACf,CAAC;AACL,CAAC,CAAC;AAtBW,QAAA,qBAAqB,yBAsBhC"}
|
|
@@ -11,6 +11,7 @@ interface FormatErrorSnippetOpts {
|
|
|
11
11
|
column: number;
|
|
12
12
|
};
|
|
13
13
|
}
|
|
14
|
+
export declare const shouldNotAddCodeSnippet: (err: Error) => boolean;
|
|
14
15
|
export declare const softFileURLToPath: (fileName: string) => string;
|
|
15
16
|
export declare const formatFileNameHeader: (fileName: string, opts: FormatFileNameHeaderOpts) => string;
|
|
16
17
|
export declare const formatErrorSnippet: (error: Error, { file, source, location }: FormatErrorSnippetOpts) => string;
|
|
@@ -3,13 +3,23 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.getSourceCodeFile = exports.formatErrorSnippet = exports.formatFileNameHeader = exports.softFileURLToPath = void 0;
|
|
6
|
+
exports.getSourceCodeFile = exports.formatErrorSnippet = exports.formatFileNameHeader = exports.softFileURLToPath = exports.shouldNotAddCodeSnippet = void 0;
|
|
7
7
|
const path_1 = __importDefault(require("path"));
|
|
8
8
|
const url_1 = require("url");
|
|
9
9
|
const fs_extra_1 = __importDefault(require("fs-extra"));
|
|
10
10
|
const code_frame_1 = require("@babel/code-frame");
|
|
11
11
|
const utils_1 = require("../browser/stacktrace/utils");
|
|
12
12
|
const constants_1 = require("./constants");
|
|
13
|
+
const assert_view_error_1 = require("../browser/commands/assert-view/errors/assert-view-error");
|
|
14
|
+
const base_state_error_1 = require("../browser/commands/assert-view/errors/base-state-error");
|
|
15
|
+
const shouldNotAddCodeSnippet = (err) => {
|
|
16
|
+
if (!err) {
|
|
17
|
+
return true;
|
|
18
|
+
}
|
|
19
|
+
const isScreenshotError = [assert_view_error_1.AssertViewError, base_state_error_1.BaseStateError].some(errorClass => err instanceof errorClass);
|
|
20
|
+
return isScreenshotError;
|
|
21
|
+
};
|
|
22
|
+
exports.shouldNotAddCodeSnippet = shouldNotAddCodeSnippet;
|
|
13
23
|
const softFileURLToPath = (fileName) => {
|
|
14
24
|
if (!fileName.startsWith("file://")) {
|
|
15
25
|
return fileName;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/error-snippets/utils.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,6BAAoC;AACpC,wDAA0B;AAC1B,kDAAqD;AACrD,uDAA4D;AAC5D,2CAA+F;
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/error-snippets/utils.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,6BAAoC;AACpC,wDAA0B;AAC1B,kDAAqD;AACrD,uDAA4D;AAC5D,2CAA+F;AAC/F,gGAA2F;AAC3F,8FAAyF;AAclF,MAAM,uBAAuB,GAAG,CAAC,GAAU,EAAW,EAAE;IAC3D,IAAI,CAAC,GAAG,EAAE,CAAC;QACP,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,iBAAiB,GAAG,CAAC,mCAAe,EAAE,iCAAc,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,YAAY,UAAU,CAAC,CAAC;IAE1G,OAAO,iBAAiB,CAAC;AAC7B,CAAC,CAAC;AARW,QAAA,uBAAuB,2BAQlC;AAEK,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAU,EAAE;IAC1D,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,IAAI,CAAC;QACD,OAAO,IAAA,mBAAa,EAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,QAAQ,CAAC;IACpB,CAAC;AACL,CAAC,CAAC;AAVW,QAAA,iBAAiB,qBAU5B;AAEK,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAE,IAA8B,EAAU,EAAE;IAC7F,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;IACnE,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;IAE/D,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,gBAAgB,GAAG,cAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IACvG,MAAM,gBAAgB,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC3E,MAAM,MAAM,GAAG,KAAK,gBAAgB,IAAI,CAAC;IACzC,MAAM,SAAS,GAAG,UAAU,CAAC;IAC7B,MAAM,OAAO,GAAG,UAAU,CAAC;IAE3B,OAAO,CAAC,MAAM,GAAG,OAAO,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAChH,CAAC,CAAC;AAZW,QAAA,oBAAoB,wBAY/B;AAEK,MAAM,kBAAkB,GAAG,CAAC,KAAY,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAA0B,EAAU,EAAE;IAC3G,MAAM,UAAU,GAAG,+BAAmB,CAAC;IACvC,MAAM,UAAU,GAAG,+BAAmB,CAAC;IACvC,MAAM,uBAAuB,GAAG,IAAA,4BAAoB,EAAC,IAAI,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAE5G,MAAM,OAAO,GACT,uBAAuB;QACvB,IAAA,6BAAgB,EACZ,MAAM,EACN,EAAE,KAAK,EAAE,QAAQ,EAAE,EACnB;YACI,UAAU;YACV,UAAU;YACV,OAAO,EAAE,IAAA,qBAAa,EAAC,KAAK,CAAC;YAC7B,aAAa,EAAE,IAAI;YACnB,UAAU,EAAE,IAAI;SACnB,CACJ,CAAC;IAEN,OAAO,KAAK,OAAO,IAAI,CAAC;AAC5B,CAAC,CAAC;AApBW,QAAA,kBAAkB,sBAoB7B;AAEK,MAAM,iBAAiB,GAAG,KAAK,EAAE,QAAgB,EAAmB,EAAE;IACzE,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,QAAQ,CAAC,CAAC;IAE7C,IAAI,cAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,kBAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE3C,IAAI,YAAY,CAAC,QAAQ,CAAC,kCAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QACtF,OAAO,YAAY,CAAC;IACxB,CAAC;IAED,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAEvD,OAAO,YAAY,GAAG,IAAI,GAAG,kCAAsB,GAAG,YAAY,CAAC;AACvE,CAAC,CAAC;AAjBW,QAAA,iBAAiB,qBAiB5B"}
|
package/build/src/index.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ import "expect-webdriverio";
|
|
|
5
5
|
import { GlobalHelper } from "./types";
|
|
6
6
|
export { Testplane as default } from "./testplane";
|
|
7
7
|
export { Key } from "webdriverio";
|
|
8
|
-
export type { WdioBrowser, TestResult, Test, Suite, TestError, AssertViewOpts, HermioneCtx, GlobalHelper, TestplaneCtx, } from "./types";
|
|
8
|
+
export type { WdioBrowser, TestResult, Test, Suite, TestError, AssertViewOpts, HermioneCtx, GlobalHelper, TestplaneCtx, TestFunctionCtx, } from "./types";
|
|
9
9
|
export type { Config } from "./config";
|
|
10
10
|
export type { ConfigInput } from "./config/types";
|
|
11
11
|
export type { TestCollection } from "./test-collection";
|
|
@@ -5,6 +5,7 @@ type TestOpts = TestObjectData & Pick<ConfigurableTestObject, "file" | "id"> & {
|
|
|
5
5
|
};
|
|
6
6
|
export declare class Test extends ConfigurableTestObject {
|
|
7
7
|
fn: TestFunction<TestFunctionCtx>;
|
|
8
|
+
err?: Error;
|
|
8
9
|
static create<T extends Test>(this: new (opts: TestOpts) => T, opts: TestOpts): T;
|
|
9
10
|
constructor({ title, file, id, fn }: TestOpts);
|
|
10
11
|
clone(): Test;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"test.js","sourceRoot":"","sources":["../../../../src/test-reader/test-object/test.ts"],"names":[],"mappings":";;;AAAA,yEAAoE;AAQpE,MAAa,IAAK,SAAQ,iDAAsB;
|
|
1
|
+
{"version":3,"file":"test.js","sourceRoot":"","sources":["../../../../src/test-reader/test-object/test.ts"],"names":[],"mappings":";;;AAAA,yEAAoE;AAQpE,MAAa,IAAK,SAAQ,iDAAsB;IAI5C,MAAM,CAAC,MAAM,CAAkD,IAAc;QACzE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAY;QACzC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAE3B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACjB,CAAC;IAED,KAAK;QACD,OAAO,IAAI,IAAI,CAAC;YACZ,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,EAAE,EAAE,IAAI,CAAC,EAAE;SACd,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;CACJ;AAtBD,oBAsBC"}
|
|
@@ -17,6 +17,7 @@ import { CoordBounds, LooksSameOptions } from "looks-same";
|
|
|
17
17
|
export type { Browser as WdioBrowser } from "webdriverio";
|
|
18
18
|
export type { Test } from "../test-reader/test-object/test";
|
|
19
19
|
export type { Suite } from "../test-reader/test-object/suite";
|
|
20
|
+
export type { TestFunctionCtx } from "../test-reader/test-object/types";
|
|
20
21
|
export type { AssertViewOpts } from "../browser/commands/types";
|
|
21
22
|
export interface RootSuite extends Suite {
|
|
22
23
|
root: true;
|