@spscommerce/e2e-core 2.2.16 → 2.3.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/README.md +1 -3
- package/lib/globalSetup.js +13 -5
- package/lib/globalSetup.js.map +1 -1
- package/package.json +1 -1
- package/playwright.config.js +5 -1
- package/src/globalSetup.ts +15 -5
package/README.md
CHANGED
|
@@ -77,9 +77,7 @@ If CI is set to true, the forbidOnly and maxFailures options are applied.
|
|
|
77
77
|
- maxFailures: Stop test suite execution after reaching 5 failed tests and skip any tests that were not executed yet.
|
|
78
78
|
|
|
79
79
|
### Authentication
|
|
80
|
-
Authentication flow was implemented in the e2e-core library. When tests are
|
|
81
|
-
> Attention:
|
|
82
|
-
> While local debugging, the storageState might get expired. User will be redirected to the login page. If it happens, please delete an auth folder in order to invoke an auth state again.
|
|
80
|
+
Authentication flow was implemented in the e2e-core library. When tests are launnhed for the first time, it takes some time for the authentication state to be invoked. If ENV variable is not set, the storageState is created for the test environment, otherwise set URL to 'prod'. After auth state is invoked, it appears in the results-e2e/auth folder. All the next test runs will use an already created storageState.json file.
|
|
83
81
|
|
|
84
82
|
### Global setup
|
|
85
83
|
To set something up once before running all tests, create a JS file and link it via SETUP_PATH variable in the `package.json`. Global setup file must export a single function that runs once before all the tests.
|
package/lib/globalSetup.js
CHANGED
|
@@ -30,7 +30,14 @@ const fs_1 = __importDefault(require("fs"));
|
|
|
30
30
|
const path_1 = __importDefault(require("path"));
|
|
31
31
|
const test_1 = require("@playwright/test");
|
|
32
32
|
const domain = 'commerce.spscommerce.com';
|
|
33
|
-
|
|
33
|
+
let baseUrl = 'https://test.' + domain;
|
|
34
|
+
let storageFile = path_1.default.join(process.cwd(), `results-e2e/auth/storageStateTest.json`);
|
|
35
|
+
let traceFile = path_1.default.join(process.cwd(), 'results-e2e/auth/globalSetupTest.zip');
|
|
36
|
+
if (process.env.ENV && process.env.ENV.includes('prod')) {
|
|
37
|
+
baseUrl = 'https://' + domain;
|
|
38
|
+
storageFile = path_1.default.join(process.cwd(), `results-e2e/auth/storageStateProd.json`);
|
|
39
|
+
traceFile = path_1.default.join(process.cwd(), 'results-e2e/auth/globalSetupProd.zip');
|
|
40
|
+
}
|
|
34
41
|
async function globalSetup() {
|
|
35
42
|
// Remove custom sub-folders for test artifacts
|
|
36
43
|
const resultsFolder = path_1.default.join(process.cwd(), 'results-e2e/');
|
|
@@ -41,10 +48,11 @@ async function globalSetup() {
|
|
|
41
48
|
}
|
|
42
49
|
}
|
|
43
50
|
}
|
|
44
|
-
// Launch browser and log in if storageState.json does not exist
|
|
45
|
-
const
|
|
46
|
-
|
|
47
|
-
|
|
51
|
+
// Launch browser and log in if storageState.json does not exist OR auth expires soon
|
|
52
|
+
const currentTS = new Date().getTime();
|
|
53
|
+
if (!fs_1.default.existsSync(storageFile) ||
|
|
54
|
+
(fs_1.default.existsSync(storageFile) &&
|
|
55
|
+
((JSON.parse(fs_1.default.readFileSync(storageFile, 'utf8')).origins[0].localStorage.find(o => o.name === 'expires_at').value - currentTS) / 60000) < 30)) {
|
|
48
56
|
const browser = await test_1.chromium.launch({ headless: false }); // { headless: false }
|
|
49
57
|
const context = await browser.newContext();
|
|
50
58
|
await context.tracing.start({ screenshots: true, snapshots: true });
|
package/lib/globalSetup.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"globalSetup.js","sourceRoot":"","sources":["../src/globalSetup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,2CAA4C;AAE5C,MAAM,MAAM,GAAG,0BAA0B,CAAC;AAC1C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,
|
|
1
|
+
{"version":3,"file":"globalSetup.js","sourceRoot":"","sources":["../src/globalSetup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,2CAA4C;AAE5C,MAAM,MAAM,GAAG,0BAA0B,CAAC;AAC1C,IAAI,OAAO,GAAG,eAAe,GAAG,MAAM,CAAC;AACvC,IAAI,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,wCAAwC,CAAC,CAAC;AACrF,IAAI,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,sCAAsC,CAAC,CAAC;AAEjF,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;IACrD,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;IAC9B,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,wCAAwC,CAAC,CAAC;IACjF,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,sCAAsC,CAAC,CAAC;CAChF;AAEc,KAAK,UAAU,WAAW;IACrC,+CAA+C;IAC/C,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;IAC/D,IAAI,YAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;QAC9B,KAAK,MAAM,SAAS,IAAI,YAAE,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE;YACnD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAAE,YAAE,CAAC,MAAM,CAAC,aAAa,GAAG,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;aAAE;SAC/G;KACJ;IACD,qFAAqF;IACrF,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IACvC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,WAAW,CAAC;QAC3B,CAAC,YAAE,CAAC,UAAU,CAAC,WAAW,CAAC;YACvB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,KAAK,GAAG,SAAS,CAAC,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,EACrJ;QACE,MAAM,OAAO,GAAG,MAAM,eAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,sBAAsB;QAClF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3C,MAAM,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI;YACA,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzB,MAAM,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;YAC1C,MAAM,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAC/D,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACpC,MAAM,IAAI,CAAC,IAAI,CAAC,wBAAwB,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YACrE,MAAM,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACrC,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;YACzC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;gBACnC,MAAM,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;aAC7C;YACD,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YACnC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;SAC5D;QAAC,OAAO,CAAC,EAAE;YACR,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACf,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;SACxE;QACD,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;KACzB;IACD,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;QACxB,IAAI,YAAE,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YACvC,wDAAa,OAAO,CAAC,GAAG,CAAC,UAAU,GAAC,CAAC;SACxC;aAAM;YACH,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,aAAa,CAAC,CAAC;SAC3D;KACJ;IACD,OAAO;AACX,CAAC;AA9CD,8BA8CC"}
|
package/package.json
CHANGED
package/playwright.config.js
CHANGED
|
@@ -55,6 +55,10 @@ switch (process.env.BROWSER) {
|
|
|
55
55
|
break;
|
|
56
56
|
}
|
|
57
57
|
|
|
58
|
+
const storageStatePath = process.env.ENV && process.env.ENV.includes('prod')
|
|
59
|
+
? path.join(process.cwd(), 'results-e2e/auth/storageStateProd.json')
|
|
60
|
+
: path.join(process.cwd(), 'results-e2e/auth/storageStateTest.json');
|
|
61
|
+
|
|
58
62
|
/**
|
|
59
63
|
* See https://playwright.dev/docs/test-configuration.
|
|
60
64
|
*/
|
|
@@ -89,7 +93,7 @@ const config = {
|
|
|
89
93
|
globalTeardown: require.resolve('./lib/globalTeardown'),
|
|
90
94
|
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
|
|
91
95
|
use: {
|
|
92
|
-
storageState: path.join(process.cwd(), 'results-e2e/auth/storageState.json'),
|
|
96
|
+
storageState: storageStatePath,//path.join(process.cwd(), 'results-e2e/auth/storageState.json'),
|
|
93
97
|
/* Maximum time each action such as `click()` can take. Defaults to 0 (no limit). */
|
|
94
98
|
actionTimeout: +process.env.ACTION_TIMEOUT || 30000,
|
|
95
99
|
/* Collect screenshot after each test failure. See https://playwright.dev/docs/test-configuration#automatic-screenshots */
|
package/src/globalSetup.ts
CHANGED
|
@@ -3,7 +3,15 @@ import path from 'path';
|
|
|
3
3
|
import { chromium } from '@playwright/test';
|
|
4
4
|
|
|
5
5
|
const domain = 'commerce.spscommerce.com';
|
|
6
|
-
|
|
6
|
+
let baseUrl = 'https://test.' + domain;
|
|
7
|
+
let storageFile = path.join(process.cwd(), `results-e2e/auth/storageStateTest.json`);
|
|
8
|
+
let traceFile = path.join(process.cwd(), 'results-e2e/auth/globalSetupTest.zip');
|
|
9
|
+
|
|
10
|
+
if (process.env.ENV && process.env.ENV.includes('prod')) {
|
|
11
|
+
baseUrl = 'https://' + domain;
|
|
12
|
+
storageFile = path.join(process.cwd(), `results-e2e/auth/storageStateProd.json`);
|
|
13
|
+
traceFile = path.join(process.cwd(), 'results-e2e/auth/globalSetupProd.zip');
|
|
14
|
+
}
|
|
7
15
|
|
|
8
16
|
export default async function globalSetup(): Promise<void> {
|
|
9
17
|
// Remove custom sub-folders for test artifacts
|
|
@@ -13,10 +21,12 @@ export default async function globalSetup(): Promise<void> {
|
|
|
13
21
|
if (!subFolder.includes('auth')) { fs.rmSync(resultsFolder + subFolder, { recursive: true, force: true }); }
|
|
14
22
|
}
|
|
15
23
|
}
|
|
16
|
-
// Launch browser and log in if storageState.json does not exist
|
|
17
|
-
const
|
|
18
|
-
|
|
19
|
-
|
|
24
|
+
// Launch browser and log in if storageState.json does not exist OR auth expires soon
|
|
25
|
+
const currentTS = new Date().getTime();
|
|
26
|
+
if (!fs.existsSync(storageFile) ||
|
|
27
|
+
(fs.existsSync(storageFile) &&
|
|
28
|
+
((JSON.parse(fs.readFileSync(storageFile, 'utf8')).origins[0].localStorage.find(o => o.name === 'expires_at').value - currentTS) / 60000) < 30)
|
|
29
|
+
) {
|
|
20
30
|
const browser = await chromium.launch({ headless: false }); // { headless: false }
|
|
21
31
|
const context = await browser.newContext();
|
|
22
32
|
await context.tracing.start({ screenshots: true, snapshots: true });
|