@zohodesk/testinglibrary 2.9.1 → 3.0.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/.gitlab-ci.yml +16 -23
- package/README.md +32 -1
- package/build/core/playwright/constants/fileMutexConfig.js +11 -0
- package/build/core/playwright/fixtures.js +24 -0
- package/build/core/playwright/helpers/auth/checkAuthCookies.js +2 -8
- package/build/core/playwright/helpers/auth/loginSteps.js +25 -18
- package/build/core/playwright/helpers/checkAuthDirectory.js +17 -0
- package/build/core/playwright/helpers/fileMutex.js +56 -0
- package/build/core/playwright/index.js +10 -23
- package/build/core/playwright/setup/config-creator.js +3 -3
- package/build/core/playwright/setup/config-utils.js +8 -25
- package/build/core/playwright/tagProcessor.js +18 -28
- package/build/core/playwright/test-runner.js +1 -1
- package/build/decorators.d.ts +1 -1
- package/build/decorators.js +1 -1
- package/build/setup-folder-structure/samples/actors-index.js +2 -0
- package/build/setup-folder-structure/samples/auth-setup-sample.js +14 -66
- package/build/setup-folder-structure/samples/editions-index.js +3 -0
- package/build/setup-folder-structure/samples/free-sample.json +25 -0
- package/build/setup-folder-structure/samples/settings.json +7 -0
- package/build/setup-folder-structure/setupProject.js +18 -5
- package/build/test/core/playwright/helpers/__tests__/fileMutex.test.js +94 -0
- package/nobdd/uat/conf/default/actors/index.js +1 -4
- package/nobdd/uat/conf/default/settings.json +1 -1
- package/nobdd/uat/conf/nobdd/uat.config.js +11 -4
- package/nobdd/uat/env-config.json +3 -3
- package/nobdd/uat/fixtures/setup.teardown.js +2 -1
- package/nobdd/uat/modules/nobdd/steps/VerifyNoBDD.feature.spec.js +3 -3
- package/nobdd/uat.config.js +8 -3
- package/package.json +8 -7
- package/build/bdd-framework/cli/commands/env.js +0 -42
- package/build/bdd-framework/cli/commands/export.js +0 -62
- package/build/bdd-framework/cli/commands/test.js +0 -64
- package/build/bdd-framework/cli/index.js +0 -11
- package/build/bdd-framework/cli/options.js +0 -19
- package/build/bdd-framework/cli/worker.js +0 -13
- package/build/bdd-framework/config/configDir.js +0 -35
- package/build/bdd-framework/config/enrichReporterData.js +0 -23
- package/build/bdd-framework/config/env.js +0 -50
- package/build/bdd-framework/config/index.js +0 -94
- package/build/bdd-framework/config/lang.js +0 -14
- package/build/bdd-framework/cucumber/buildStepDefinition.js +0 -43
- package/build/bdd-framework/cucumber/createTestStep.js +0 -43
- package/build/bdd-framework/cucumber/formatter/EventDataCollector.js +0 -126
- package/build/bdd-framework/cucumber/formatter/GherkinDocumentParser.js +0 -72
- package/build/bdd-framework/cucumber/formatter/PickleParser.js +0 -25
- package/build/bdd-framework/cucumber/formatter/durationHelpers.js +0 -13
- package/build/bdd-framework/cucumber/formatter/getColorFns.js +0 -57
- package/build/bdd-framework/cucumber/formatter/index.js +0 -16
- package/build/bdd-framework/cucumber/formatter/locationHelpers.js +0 -16
- package/build/bdd-framework/cucumber/loadConfig.js +0 -17
- package/build/bdd-framework/cucumber/loadFeatures.js +0 -70
- package/build/bdd-framework/cucumber/loadSnippetBuilder.js +0 -20
- package/build/bdd-framework/cucumber/loadSteps.js +0 -47
- package/build/bdd-framework/cucumber/resolveFeaturePaths.js +0 -62
- package/build/bdd-framework/cucumber/stepArguments.js +0 -21
- package/build/bdd-framework/cucumber/types.js +0 -5
- package/build/bdd-framework/cucumber/valueChecker.js +0 -23
- package/build/bdd-framework/decorators.js +0 -18
- package/build/bdd-framework/gen/fixtures.js +0 -48
- package/build/bdd-framework/gen/formatter.js +0 -167
- package/build/bdd-framework/gen/i18n.js +0 -39
- package/build/bdd-framework/gen/index.js +0 -197
- package/build/bdd-framework/gen/specialTags.js +0 -70
- package/build/bdd-framework/gen/testFile.js +0 -470
- package/build/bdd-framework/gen/testMeta.js +0 -60
- package/build/bdd-framework/gen/testNode.js +0 -35
- package/build/bdd-framework/gen/testPoms.js +0 -133
- package/build/bdd-framework/hooks/scenario.js +0 -130
- package/build/bdd-framework/hooks/worker.js +0 -89
- package/build/bdd-framework/index.js +0 -52
- package/build/bdd-framework/playwright/fixtureParameterNames.js +0 -93
- package/build/bdd-framework/playwright/getLocationInFile.js +0 -79
- package/build/bdd-framework/playwright/loadConfig.js +0 -42
- package/build/bdd-framework/playwright/loadUtils.js +0 -33
- package/build/bdd-framework/playwright/testTypeImpl.js +0 -79
- package/build/bdd-framework/playwright/transform.js +0 -88
- package/build/bdd-framework/playwright/types.js +0 -12
- package/build/bdd-framework/playwright/utils.js +0 -56
- package/build/bdd-framework/reporter/cucumber/base.js +0 -52
- package/build/bdd-framework/reporter/cucumber/custom.js +0 -73
- package/build/bdd-framework/reporter/cucumber/helper.js +0 -12
- package/build/bdd-framework/reporter/cucumber/html.js +0 -40
- package/build/bdd-framework/reporter/cucumber/index.js +0 -74
- package/build/bdd-framework/reporter/cucumber/json.js +0 -312
- package/build/bdd-framework/reporter/cucumber/junit.js +0 -205
- package/build/bdd-framework/reporter/cucumber/message.js +0 -20
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/AttachmentMapper.js +0 -82
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/Builder.js +0 -197
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocument.js +0 -43
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocumentClone.js +0 -52
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/GherkinDocuments.js +0 -105
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/Hook.js +0 -70
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/Meta.js +0 -45
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/Pickles.js +0 -27
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/Projects.js +0 -38
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCase.js +0 -128
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRun.js +0 -154
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestCaseRunHooks.js +0 -123
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepAttachments.js +0 -67
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/TestStepRun.js +0 -114
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/index.js +0 -30
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/pwStepUtils.js +0 -70
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/timing.js +0 -35
- package/build/bdd-framework/reporter/cucumber/messagesBuilder/types.js +0 -5
- package/build/bdd-framework/run/StepInvoker.js +0 -69
- package/build/bdd-framework/run/bddData/index.js +0 -59
- package/build/bdd-framework/run/bddData/types.js +0 -5
- package/build/bdd-framework/run/bddFixtures.js +0 -192
- package/build/bdd-framework/run/bddWorld.js +0 -79
- package/build/bdd-framework/run/bddWorldInternal.js +0 -11
- package/build/bdd-framework/snippets/index.js +0 -132
- package/build/bdd-framework/snippets/snippetSyntax.js +0 -43
- package/build/bdd-framework/snippets/snippetSyntaxDecorators.js +0 -26
- package/build/bdd-framework/snippets/snippetSyntaxTs.js +0 -18
- package/build/bdd-framework/stepDefinitions/createBdd.js +0 -66
- package/build/bdd-framework/stepDefinitions/decorators/class.js +0 -68
- package/build/bdd-framework/stepDefinitions/decorators/steps.js +0 -99
- package/build/bdd-framework/stepDefinitions/defineStep.js +0 -62
- package/build/bdd-framework/stepDefinitions/stepConfig.js +0 -24
- package/build/bdd-framework/steps/createBdd.js +0 -78
- package/build/bdd-framework/steps/decorators/class.js +0 -68
- package/build/bdd-framework/steps/decorators/steps.js +0 -98
- package/build/bdd-framework/steps/defineStep.js +0 -62
- package/build/bdd-framework/steps/stepConfig.js +0 -24
- package/build/bdd-framework/utils/AutofillMap.js +0 -20
- package/build/bdd-framework/utils/exit.js +0 -62
- package/build/bdd-framework/utils/index.js +0 -93
- package/build/bdd-framework/utils/jsStringWrap.js +0 -44
- package/build/bdd-framework/utils/logger.js +0 -30
- package/build/bdd-framework/utils/stripAnsiEscapes.js +0 -20
- package/build/setup-folder-structure/samples/authUsers-sample.json +0 -9
- package/build/setup-folder-structure/samples/env-config-sample.json +0 -21
- package/nobdd/src/App.js +0 -7
- package/nobdd/uat/conf/default/actors/beta/custom-module.json +0 -24
- package/nobdd/uat/conf/default/actors/beta/index.js +0 -6
- package/nobdd/uat/conf/default/actors/beta/parent-child.json +0 -24
- package/npm-shrinkwrap.json +0 -6475
|
@@ -1,73 +1,21 @@
|
|
|
1
1
|
/* eslint-disable no-console */
|
|
2
2
|
import { test as setup, expect } from '@zohodesk/testinglibrary';
|
|
3
|
-
import
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
3
|
+
import {
|
|
4
|
+
performLoginSteps,
|
|
5
|
+
getDefaultActor
|
|
6
|
+
} from '@zohodesk/testinglibrary/helpers';
|
|
7
7
|
|
|
8
|
-
const
|
|
8
|
+
const user = getDefaultActor();
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
function convertCookiesToParse(cookies, authFilePath) {
|
|
16
|
-
try {
|
|
17
|
-
return JSON.parse(cookies);
|
|
18
|
-
} catch (err) {
|
|
19
|
-
Logger.error(err);
|
|
20
|
-
throw new Error(
|
|
21
|
-
` Error while parsing cookies ${err} \n${path.resolve(
|
|
22
|
-
process.cwd(),
|
|
23
|
-
authFilePath
|
|
24
|
-
)} File is Empty`
|
|
25
|
-
);
|
|
26
|
-
// process.exit()
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
const authDirectory = getAuthFileDirectory(); //path.resolve(process.cwd(), 'uat', 'playwright', '.auth');
|
|
30
|
-
if (!existsSync(authDirectory)) {
|
|
31
|
-
console.log('Creating auth directory for the first time setup...');
|
|
32
|
-
mkdirSync(authDirectory, { recursive: true });
|
|
10
|
+
async function verifyPageIsLoaded(page) {
|
|
11
|
+
//Implement your validation steps here
|
|
12
|
+
//Refer desk_client_app auth.setup.js
|
|
13
|
+
return true;
|
|
33
14
|
}
|
|
34
15
|
|
|
35
|
-
|
|
36
|
-
const authFile = path.resolve(path.join(authDirectory, `${data.filename}`));
|
|
37
|
-
if (!existsSync(authFile)) {
|
|
38
|
-
console.log('creating auth file..');
|
|
39
|
-
writeFileSync(authFile, JSON.stringify(authContent, null, 2));
|
|
40
|
-
}
|
|
41
|
-
setup(data.description, async ({ page }) => {
|
|
42
|
-
try {
|
|
43
|
-
const cookies = readFileSync(authFile);
|
|
44
|
-
const parsedCookies = convertCookiesToParse(cookies, authFile);
|
|
45
|
-
await page
|
|
46
|
-
.context()
|
|
47
|
-
.addCookies(
|
|
48
|
-
parsedCookies.cookies === undefined ? [] : parsedCookies.cookies
|
|
49
|
-
);
|
|
50
|
-
await page.goto(page.getBaseUrl());
|
|
51
|
-
await page.waitForLoadState();
|
|
52
|
-
if (await page.url().includes(process.env.domain)) {
|
|
53
|
-
await page.waitForSelector(data.locator);
|
|
54
|
-
} else {
|
|
55
|
-
throw new Error(LOGIN_ERR_MESSAGE);
|
|
56
|
-
}
|
|
57
|
-
} catch (err) {
|
|
58
|
-
if (err.message === LOGIN_ERR_MESSAGE) {
|
|
59
|
-
await expect(page.locator('.load-bg')).toBeHidden();
|
|
60
|
-
await page.locator('#login_id').type(data.useremail);
|
|
61
|
-
await page.locator('#nextbtn').click();
|
|
62
|
-
await page.locator('#password').type(data.password);
|
|
63
|
-
await page.locator('#nextbtn').click();
|
|
64
|
-
|
|
65
|
-
await page.waitForLoadState('networkidle');
|
|
66
|
-
|
|
67
|
-
await page.waitForSelector(data.locator);
|
|
16
|
+
setup(`${user.edition} - Authentication`, async ({ page }) => {
|
|
68
17
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
});
|
|
18
|
+
//Implement performLoginSteps here
|
|
19
|
+
const { email, password } = user;
|
|
20
|
+
await performLoginSteps({ },verifyPageIsLoaded );
|
|
21
|
+
});
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"id": "1",
|
|
4
|
+
"edition": "free",
|
|
5
|
+
"orgName": "orgFree",
|
|
6
|
+
"profiles": [
|
|
7
|
+
{
|
|
8
|
+
"profile": "admin",
|
|
9
|
+
"email": "admin+free@zohotest.com",
|
|
10
|
+
"password": "password@0987"
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
"profile": "agent",
|
|
14
|
+
"email": "agent@zohotest.com",
|
|
15
|
+
"password": "password@12345"
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"profile": "lightagent",
|
|
19
|
+
"email": "lightagent@zohotest.com",
|
|
20
|
+
"password": "password@12345"
|
|
21
|
+
}
|
|
22
|
+
]
|
|
23
|
+
}
|
|
24
|
+
]
|
|
25
|
+
|
|
@@ -10,8 +10,9 @@ var _path = _interopRequireDefault(require("path"));
|
|
|
10
10
|
var _logger = require("../utils/logger");
|
|
11
11
|
function getScriptsToBeAdded() {
|
|
12
12
|
return {
|
|
13
|
-
"uat": "ZDTestingFramework test --mode=
|
|
14
|
-
"uat-debug": "ZDTestingFramework test --mode=
|
|
13
|
+
"uat": "ZDTestingFramework test --mode=dev --headed",
|
|
14
|
+
"uat-debug": "ZDTestingFramework test --mode=dev --debug",
|
|
15
|
+
"uat-validate": "ZDTestingFramework validate",
|
|
15
16
|
"uat-report": "ZDTestingFramework report --port=9009",
|
|
16
17
|
"codegen": "ZDTestingFramework codegen deskclientapp.localzoho.com/agent"
|
|
17
18
|
};
|
|
@@ -71,7 +72,6 @@ function createAuthenticationFile() {
|
|
|
71
72
|
});
|
|
72
73
|
}
|
|
73
74
|
(0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'auth.setup.js'), getSetupFileAsString('auth-setup-sample.js'), null, 2);
|
|
74
|
-
(0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'authUsers.json'), getSetupFileAsString('authUsers-sample.json'), null, 2);
|
|
75
75
|
_logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
|
|
76
76
|
} catch (err) {
|
|
77
77
|
_logger.Logger.error(err);
|
|
@@ -84,8 +84,21 @@ function createAuthenticationFile() {
|
|
|
84
84
|
function createConfigJson() {
|
|
85
85
|
const uatFolder = _path.default.resolve(process.cwd(), 'uat');
|
|
86
86
|
if ((0, _fs.existsSync)(uatFolder)) {
|
|
87
|
-
_logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating
|
|
88
|
-
(0, _fs.
|
|
87
|
+
_logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating settings.json file inside UAT Folder');
|
|
88
|
+
if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default'))) {
|
|
89
|
+
(0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default'), {
|
|
90
|
+
recursive: true
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
(0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', './settings.json'), getSetupFileAsString('settings.json'), null, 2);
|
|
94
|
+
if (!(0, _fs.existsSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'))) {
|
|
95
|
+
(0, _fs.mkdirSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions'), {
|
|
96
|
+
recursive: true
|
|
97
|
+
});
|
|
98
|
+
}
|
|
99
|
+
(0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'free.json'), getSetupFileAsString('free-sample.json'), null, 2);
|
|
100
|
+
(0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'editions', 'index.js'), getSetupFileAsString('editions-index.js'), null, 2);
|
|
101
|
+
(0, _fs.writeFileSync)(_path.default.resolve(uatFolder, 'conf', 'default', 'actors', 'index.js'), getSetupFileAsString('actors-index.js'), null, 2);
|
|
89
102
|
} else {
|
|
90
103
|
_logger.Logger.log(_logger.Logger.INFO_TYPE, 'Something went wrong. Please re-initialize the @zohodesk/testinglibrary');
|
|
91
104
|
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
+
var _fileMutex = _interopRequireDefault(require("../../../../../core/playwright/helpers/fileMutex"));
|
|
5
|
+
var _lockfile = _interopRequireDefault(require("lockfile"));
|
|
6
|
+
var _path = _interopRequireDefault(require("path"));
|
|
7
|
+
var _fs = _interopRequireDefault(require("fs"));
|
|
8
|
+
jest.mock('lockfile');
|
|
9
|
+
jest.mock('fs');
|
|
10
|
+
describe('FileMutex', () => {
|
|
11
|
+
const mockDirectory = '/tmp';
|
|
12
|
+
const mockFileName = 'test_user';
|
|
13
|
+
const mockTimeout = {
|
|
14
|
+
wait: 5000,
|
|
15
|
+
retries: 5,
|
|
16
|
+
stale: 60000
|
|
17
|
+
};
|
|
18
|
+
let fileMutex;
|
|
19
|
+
beforeEach(() => {
|
|
20
|
+
fileMutex = new _fileMutex.default(mockDirectory, mockFileName, mockTimeout);
|
|
21
|
+
});
|
|
22
|
+
afterEach(() => {
|
|
23
|
+
jest.clearAllMocks();
|
|
24
|
+
});
|
|
25
|
+
describe('acquire', () => {
|
|
26
|
+
it('should resolve when lockfile.lock succeeds and call getLockFilePath correctly', async () => {
|
|
27
|
+
const expectedPath = _path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`));
|
|
28
|
+
_lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
|
|
29
|
+
expect(lockPath).toBe(expectedPath);
|
|
30
|
+
expect(options).toEqual(mockTimeout);
|
|
31
|
+
callback(null);
|
|
32
|
+
});
|
|
33
|
+
await expect(fileMutex.acquire()).resolves.toBeUndefined();
|
|
34
|
+
expect(_lockfile.default.lock).toHaveBeenCalledWith(expectedPath, mockTimeout, expect.any(Function));
|
|
35
|
+
});
|
|
36
|
+
it('should reject when lockfile.lock fails', async () => {
|
|
37
|
+
const mockError = new Error('Lock failed');
|
|
38
|
+
_lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
|
|
39
|
+
expect(lockPath).toBe(_path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`)));
|
|
40
|
+
expect(options).toEqual(mockTimeout);
|
|
41
|
+
callback(mockError);
|
|
42
|
+
});
|
|
43
|
+
await expect(fileMutex.acquire()).rejects.toThrow('Lock failed');
|
|
44
|
+
expect(_lockfile.default.lock).toHaveBeenCalled();
|
|
45
|
+
});
|
|
46
|
+
it('should create the directory if it does not exist and acquire the lock', async () => {
|
|
47
|
+
_fs.default.existsSync.mockReturnValue(false);
|
|
48
|
+
_fs.default.mkdirSync.mockImplementation((dir, options) => {
|
|
49
|
+
expect(dir).toBe(mockDirectory);
|
|
50
|
+
expect(options).toEqual({
|
|
51
|
+
recursive: true
|
|
52
|
+
});
|
|
53
|
+
});
|
|
54
|
+
_lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
|
|
55
|
+
expect(lockPath).toBe(_path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`)));
|
|
56
|
+
expect(options).toEqual(mockTimeout);
|
|
57
|
+
callback(null);
|
|
58
|
+
});
|
|
59
|
+
await expect(fileMutex.acquire()).resolves.toBeUndefined();
|
|
60
|
+
expect(_fs.default.existsSync).toHaveBeenCalledWith(mockDirectory);
|
|
61
|
+
expect(_fs.default.mkdirSync).toHaveBeenCalledWith(mockDirectory, {
|
|
62
|
+
recursive: true
|
|
63
|
+
});
|
|
64
|
+
expect(_lockfile.default.lock).toHaveBeenCalled();
|
|
65
|
+
});
|
|
66
|
+
it('should not create the directory if it already exists', async () => {
|
|
67
|
+
_fs.default.existsSync.mockReturnValue(true);
|
|
68
|
+
_lockfile.default.lock.mockImplementation((lockPath, options, callback) => {
|
|
69
|
+
callback(null);
|
|
70
|
+
});
|
|
71
|
+
await expect(fileMutex.acquire()).resolves.toBeUndefined();
|
|
72
|
+
expect(_fs.default.mkdirSync).not.toHaveBeenCalled();
|
|
73
|
+
expect(_lockfile.default.lock).toHaveBeenCalled();
|
|
74
|
+
});
|
|
75
|
+
});
|
|
76
|
+
describe('release', () => {
|
|
77
|
+
it('should resolve when lockfile.unlock succeeds and call getLockFilePath correctly', async () => {
|
|
78
|
+
const expectedPath = _path.default.resolve(_path.default.join(mockDirectory, `./${mockFileName}.lock`));
|
|
79
|
+
_lockfile.default.unlock.mockImplementation((path, callback) => {
|
|
80
|
+
callback(null);
|
|
81
|
+
});
|
|
82
|
+
await expect(fileMutex.release()).resolves.toBeUndefined();
|
|
83
|
+
expect(_lockfile.default.unlock).toHaveBeenCalledWith(expectedPath, expect.any(Function));
|
|
84
|
+
});
|
|
85
|
+
it('should reject when lockfile.unlock fails', async () => {
|
|
86
|
+
const mockError = new Error('Unlock failed');
|
|
87
|
+
_lockfile.default.unlock.mockImplementation((path, callback) => {
|
|
88
|
+
callback(mockError);
|
|
89
|
+
});
|
|
90
|
+
await expect(fileMutex.release()).rejects.toThrow('Unlock failed');
|
|
91
|
+
expect(_lockfile.default.unlock).toHaveBeenCalled();
|
|
92
|
+
});
|
|
93
|
+
});
|
|
94
|
+
});
|
|
@@ -12,16 +12,23 @@ function getPrimaryCookiePath() {
|
|
|
12
12
|
* @typedef {import('@zohodesk/testinglibrary').UserConfig} UserConfig
|
|
13
13
|
*/
|
|
14
14
|
module.exports = {
|
|
15
|
-
headless:
|
|
15
|
+
headless: false,
|
|
16
16
|
openReportOn: 'never',
|
|
17
17
|
browsers: ['Chrome'],
|
|
18
|
-
isAuthMode:
|
|
18
|
+
isAuthMode: true,
|
|
19
19
|
authFilePath: getPrimaryCookiePath(),
|
|
20
|
-
trace:
|
|
21
|
-
video:
|
|
20
|
+
trace: 'retain-on-failure',
|
|
21
|
+
video: 'retain-on-failure',
|
|
22
|
+
retries:2,
|
|
22
23
|
bddMode: false,
|
|
24
|
+
expectTimeout: 10 * 1000,
|
|
25
|
+
testTimeout: 60 * 1000,
|
|
26
|
+
globalTimeout: 2 * 60 * 60 * 1000,
|
|
27
|
+
featureFilesFolder: 'feature-files',
|
|
28
|
+
stepDefinitionsFolder: 'steps',
|
|
23
29
|
viewport: { width: 1280, height: 720 },
|
|
24
30
|
testIdAttribute: 'data-id',
|
|
31
|
+
editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
|
|
25
32
|
additionalPages: {
|
|
26
33
|
...customFixtures
|
|
27
34
|
}
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"dev": {
|
|
3
|
-
"domain": "https://
|
|
3
|
+
"domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
|
|
4
4
|
"orgName": "org-name",
|
|
5
5
|
"deptName": "dept-name",
|
|
6
6
|
"moduleName": "module-name"
|
|
7
7
|
},
|
|
8
8
|
"prod": {
|
|
9
|
-
"domain": "https://
|
|
9
|
+
"domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
|
|
10
10
|
"orgName": "sangeetha.t@zohocorp.com",
|
|
11
11
|
"deptName": "sangeethat",
|
|
12
12
|
"moduleName": "sangeethat"
|
|
13
13
|
},
|
|
14
14
|
"ci": {
|
|
15
|
-
"domain": "https://zdesk-
|
|
15
|
+
"domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
|
|
16
16
|
"orgName": "clientcicdk8",
|
|
17
17
|
"deptName": "clientcicdk8",
|
|
18
18
|
"moduleName": "tickets"
|
|
@@ -21,7 +21,8 @@ if (!isDevelopmentSetup()) {
|
|
|
21
21
|
const authFilePath = path.join(authDirectory, file);
|
|
22
22
|
await loadCookiesIfPresent(page, authFilePath);
|
|
23
23
|
const domainOrigin = getUrlOrigin(process.env.domain);
|
|
24
|
-
|
|
24
|
+
const logoutURL = `${domainOrigin}/support/logout.sas`;
|
|
25
|
+
await page.goto(logoutURL);
|
|
25
26
|
await page.waitForNavigation();
|
|
26
27
|
await expect(page.locator('[id="signin_flow"]')).toBeVisible();
|
|
27
28
|
await fs.rmSync(authFilePath);
|
|
@@ -4,11 +4,11 @@ test.describe("Verify no authentication required @nobdd", () => {
|
|
|
4
4
|
|
|
5
5
|
test("Verify the page is not logged in", async ({ page }) => {
|
|
6
6
|
|
|
7
|
-
await page.goto(
|
|
7
|
+
await page.goto(process.env.domain);
|
|
8
8
|
|
|
9
|
-
await page.waitForSelector('
|
|
9
|
+
await page.waitForSelector('#login');
|
|
10
10
|
|
|
11
|
-
const isLoggedIn = await page.isVisible('
|
|
11
|
+
const isLoggedIn = await page.isVisible('#login');
|
|
12
12
|
expect(isLoggedIn).toBe(true);
|
|
13
13
|
|
|
14
14
|
});
|
package/nobdd/uat.config.js
CHANGED
|
@@ -17,13 +17,18 @@ module.exports = {
|
|
|
17
17
|
browsers: ['Chrome'],
|
|
18
18
|
isAuthMode: true,
|
|
19
19
|
authFilePath: getPrimaryCookiePath(),
|
|
20
|
-
trace:
|
|
21
|
-
video:
|
|
22
|
-
|
|
20
|
+
trace: 'retain-on-failure',
|
|
21
|
+
video: 'retain-on-failure',
|
|
22
|
+
retries:2,
|
|
23
|
+
bddMode: false,
|
|
24
|
+
expectTimeout: 10 * 1000,
|
|
25
|
+
testTimeout: 60 * 1000,
|
|
26
|
+
globalTimeout: 2 * 60 * 60 * 1000,
|
|
23
27
|
featureFilesFolder: 'feature-files',
|
|
24
28
|
stepDefinitionsFolder: 'steps',
|
|
25
29
|
viewport: { width: 1280, height: 720 },
|
|
26
30
|
testIdAttribute: 'data-id',
|
|
31
|
+
editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
|
|
27
32
|
additionalPages: {
|
|
28
33
|
...customFixtures
|
|
29
34
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zohodesk/testinglibrary",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.1",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "./build/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -22,8 +22,8 @@
|
|
|
22
22
|
"license": "ISC",
|
|
23
23
|
"dependencies": {
|
|
24
24
|
"@babel/preset-react": "7.22.5",
|
|
25
|
-
"@cucumber/cucumber": "
|
|
26
|
-
"@playwright/test": "1.
|
|
25
|
+
"@cucumber/cucumber": "11.0.1",
|
|
26
|
+
"@playwright/test": "1.48.0",
|
|
27
27
|
"@testing-library/jest-dom": "5.11.9",
|
|
28
28
|
"@testing-library/react": "11.2.7",
|
|
29
29
|
"@testing-library/react-hooks": "7.0.2",
|
|
@@ -32,9 +32,11 @@
|
|
|
32
32
|
"fast-glob": "3.3.1",
|
|
33
33
|
"jest": "29.6.2",
|
|
34
34
|
"jest-environment-jsdom": "29.6.2",
|
|
35
|
+
"lockfile": "^1.0.4",
|
|
35
36
|
"msw": "1.2.3",
|
|
36
|
-
"playwright": "1.
|
|
37
|
-
"supports-color": "8.1.1"
|
|
37
|
+
"playwright": "1.48.0",
|
|
38
|
+
"supports-color": "8.1.1",
|
|
39
|
+
"playwright-bdd": "7.5.0"
|
|
38
40
|
},
|
|
39
41
|
"bin": {
|
|
40
42
|
"ZDTestingFramework": "./bin/cli.js"
|
|
@@ -53,7 +55,6 @@
|
|
|
53
55
|
"@babel/preset-env": "7.22.15",
|
|
54
56
|
"@babel/runtime": "7.22.15",
|
|
55
57
|
"commander": "^11.0.0",
|
|
56
|
-
"jest-html-reporter": "^3.10.2"
|
|
57
|
-
"typescript": "^5.4.2"
|
|
58
|
+
"jest-html-reporter": "^3.10.2"
|
|
58
59
|
}
|
|
59
60
|
}
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
-
Object.defineProperty(exports, "__esModule", {
|
|
5
|
-
value: true
|
|
6
|
-
});
|
|
7
|
-
exports.envCommand = void 0;
|
|
8
|
-
exports.getOwnVersion = getOwnVersion;
|
|
9
|
-
var _commander = require("commander");
|
|
10
|
-
var _options = require("../options");
|
|
11
|
-
var _path = _interopRequireDefault(require("path"));
|
|
12
|
-
var _logger = require("../../utils/logger");
|
|
13
|
-
var _utils = require("../../utils");
|
|
14
|
-
var _loadConfig = require("../../playwright/loadConfig");
|
|
15
|
-
const logger = new _logger.Logger({
|
|
16
|
-
verbose: true
|
|
17
|
-
});
|
|
18
|
-
const envCommand = exports.envCommand = new _commander.Command('env').description('Prints environment info').addOption(_options.configOption).action(opts => {
|
|
19
|
-
logger.log(`Playwright-bdd environment info:\n`);
|
|
20
|
-
logger.log(`platform: ${process.platform}`);
|
|
21
|
-
logger.log(`node: ${process.version}`);
|
|
22
|
-
showPackageVersion('playwright-bdd');
|
|
23
|
-
showPackageVersion('@playwright/test');
|
|
24
|
-
showPackageVersion('@cucumber/cucumber');
|
|
25
|
-
showPlaywrightConfigPath(opts.config);
|
|
26
|
-
});
|
|
27
|
-
function showPackageVersion(packageName) {
|
|
28
|
-
const version = packageName === 'playwright-bdd' ? getOwnVersion() : (0, _utils.getPackageVersion)(packageName);
|
|
29
|
-
logger.log(`${packageName}: v${version}`);
|
|
30
|
-
}
|
|
31
|
-
/**
|
|
32
|
-
* Getting own version by relative path instead of using getPackageVersion(),
|
|
33
|
-
* to aneble using directly from /dist in tests.
|
|
34
|
-
*/
|
|
35
|
-
function getOwnVersion() {
|
|
36
|
-
return '6.1.1';
|
|
37
|
-
}
|
|
38
|
-
function showPlaywrightConfigPath(cliConfigPath) {
|
|
39
|
-
const resolvedConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);
|
|
40
|
-
const relPath = _path.default.relative(process.cwd(), resolvedConfigFile);
|
|
41
|
-
logger.log(`Playwright config file: ${relPath}`);
|
|
42
|
-
}
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
-
Object.defineProperty(exports, "__esModule", {
|
|
5
|
-
value: true
|
|
6
|
-
});
|
|
7
|
-
exports.exportCommand = void 0;
|
|
8
|
-
var _path = _interopRequireDefault(require("path"));
|
|
9
|
-
var _commander = require("commander");
|
|
10
|
-
var _options = require("../options");
|
|
11
|
-
var _loadConfig = require("../../playwright/loadConfig");
|
|
12
|
-
var _logger = require("../../utils/logger");
|
|
13
|
-
var _env = require("../../config/env");
|
|
14
|
-
var _test = require("./test");
|
|
15
|
-
var _gen = require("../../gen");
|
|
16
|
-
const logger = new _logger.Logger({
|
|
17
|
-
verbose: true
|
|
18
|
-
});
|
|
19
|
-
const exportCommand = exports.exportCommand = new _commander.Command('export').description('Prints step definitions').addOption(_options.configOption).option('--unused-steps', 'Output only unused steps').action(async opts => {
|
|
20
|
-
const {
|
|
21
|
-
resolvedConfigFile
|
|
22
|
-
} = await (0, _loadConfig.loadConfig)(opts.config);
|
|
23
|
-
logger.log(`Using config: ${_path.default.relative(process.cwd(), resolvedConfigFile)}`);
|
|
24
|
-
const configs = Object.values((0, _env.getEnvConfigs)());
|
|
25
|
-
(0, _test.assertConfigsCount)(configs);
|
|
26
|
-
if (opts.unusedSteps) {
|
|
27
|
-
await showUnusedStepsForConfigs(configs);
|
|
28
|
-
} else {
|
|
29
|
-
await showStepsForConfigs(configs);
|
|
30
|
-
}
|
|
31
|
-
});
|
|
32
|
-
async function showStepsForConfigs(configs) {
|
|
33
|
-
// here we don't need workers (as in test command) because if some step files
|
|
34
|
-
// are already in node cache, we collected them.
|
|
35
|
-
const steps = new Set();
|
|
36
|
-
const tasks = configs.map(async config => {
|
|
37
|
-
const stepDefinitions = await new _gen.TestFilesGenerator(config).extractSteps();
|
|
38
|
-
stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
|
|
39
|
-
});
|
|
40
|
-
await Promise.all(tasks);
|
|
41
|
-
logger.log(`List of all steps (${steps.size}):`);
|
|
42
|
-
steps.forEach(stepText => logger.log(stepText));
|
|
43
|
-
}
|
|
44
|
-
async function showUnusedStepsForConfigs(configs) {
|
|
45
|
-
const steps = new Set();
|
|
46
|
-
const tasks = configs.map(async config => {
|
|
47
|
-
const stepDefinitions = await new _gen.TestFilesGenerator(config).extractUnusedSteps();
|
|
48
|
-
stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
|
|
49
|
-
});
|
|
50
|
-
await Promise.all(tasks);
|
|
51
|
-
logger.log(`List of unused steps (${steps.size}):`);
|
|
52
|
-
steps.forEach(stepText => logger.log(stepText));
|
|
53
|
-
}
|
|
54
|
-
function getStepText({
|
|
55
|
-
pattern,
|
|
56
|
-
keyword
|
|
57
|
-
}) {
|
|
58
|
-
// for Unknown return When as it looks the most suitable
|
|
59
|
-
const keywordText = keyword === 'Unknown' ? 'When' : keyword;
|
|
60
|
-
const patternText = typeof pattern === 'string' ? pattern : pattern.source;
|
|
61
|
-
return `${keywordText} ${patternText}`;
|
|
62
|
-
}
|
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
4
|
-
Object.defineProperty(exports, "__esModule", {
|
|
5
|
-
value: true
|
|
6
|
-
});
|
|
7
|
-
exports.assertConfigsCount = assertConfigsCount;
|
|
8
|
-
exports.testCommand = void 0;
|
|
9
|
-
var _worker_threads = require("worker_threads");
|
|
10
|
-
var _events = require("events");
|
|
11
|
-
var _path = _interopRequireDefault(require("path"));
|
|
12
|
-
var _commander = require("commander");
|
|
13
|
-
var _gen = require("../../gen");
|
|
14
|
-
var _loadConfig = require("../../playwright/loadConfig");
|
|
15
|
-
var _env = require("../../config/env");
|
|
16
|
-
var _config = require("../../config");
|
|
17
|
-
var _options = require("../options");
|
|
18
|
-
var _exit = require("../../utils/exit");
|
|
19
|
-
const GEN_WORKER_PATH = _path.default.resolve(__dirname, '..', 'worker.js');
|
|
20
|
-
const testCommand = exports.testCommand = new _commander.Command('test').description('Generate Playwright test files from Gherkin documents').addOption(_options.configOption).option('--tags <expression>', `Tags expression to filter scenarios for generation`).option('--verbose', `Verbose mode (default: ${Boolean(_config.defaults.verbose)})`).action(async opts => {
|
|
21
|
-
await (0, _loadConfig.loadConfig)(opts.config);
|
|
22
|
-
const configs = readConfigsFromEnv();
|
|
23
|
-
mergeCliOptions(configs, opts);
|
|
24
|
-
await generateFilesForConfigs(configs);
|
|
25
|
-
});
|
|
26
|
-
function readConfigsFromEnv() {
|
|
27
|
-
const configs = Object.values((0, _env.getEnvConfigs)());
|
|
28
|
-
assertConfigsCount(configs);
|
|
29
|
-
return configs;
|
|
30
|
-
}
|
|
31
|
-
function mergeCliOptions(configs, opts) {
|
|
32
|
-
configs.forEach(config => {
|
|
33
|
-
if ('tags' in opts) {
|
|
34
|
-
config.tags = opts.tags;
|
|
35
|
-
}
|
|
36
|
-
if ('verbose' in opts) {
|
|
37
|
-
config.verbose = Boolean(opts.verbose);
|
|
38
|
-
}
|
|
39
|
-
});
|
|
40
|
-
}
|
|
41
|
-
function assertConfigsCount(configs) {
|
|
42
|
-
if (configs.length === 0) {
|
|
43
|
-
(0, _exit.exit)(`No BDD configs found. Did you use defineBddConfig() in playwright.config.ts?`);
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
async function generateFilesForConfigs(configs) {
|
|
47
|
-
// run first config in main thread and other in workers (to have fresh require cache)
|
|
48
|
-
// See: https://github.com/vitalets/playwright-bdd/issues/32
|
|
49
|
-
const tasks = configs.map((config, index) => {
|
|
50
|
-
return index === 0 ? new _gen.TestFilesGenerator(config).generate() : runInWorker(config);
|
|
51
|
-
});
|
|
52
|
-
return Promise.all(tasks);
|
|
53
|
-
}
|
|
54
|
-
async function runInWorker(config) {
|
|
55
|
-
const worker = new _worker_threads.Worker(GEN_WORKER_PATH, {
|
|
56
|
-
workerData: {
|
|
57
|
-
config
|
|
58
|
-
}
|
|
59
|
-
});
|
|
60
|
-
const [exitCode] = await (0, _events.once)(worker, 'exit');
|
|
61
|
-
if (exitCode) {
|
|
62
|
-
(0, _exit.exit)();
|
|
63
|
-
}
|
|
64
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
"use strict";
|
|
3
|
-
|
|
4
|
-
var _commander = require("commander");
|
|
5
|
-
var _test = require("./commands/test");
|
|
6
|
-
var _env = require("./commands/env");
|
|
7
|
-
var _export = require("./commands/export");
|
|
8
|
-
const program = new _commander.Command();
|
|
9
|
-
program.name('bddgen').description(`Playwright-bdd CLI v${(0, _env.getOwnVersion)()}`).addCommand(_test.testCommand, {
|
|
10
|
-
isDefault: true
|
|
11
|
-
}).addCommand(_export.exportCommand).addCommand(_env.envCommand).addHelpCommand(false).parse();
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.configOption = void 0;
|
|
7
|
-
exports.getCliConfigPath = getCliConfigPath;
|
|
8
|
-
var _commander = require("commander");
|
|
9
|
-
/**
|
|
10
|
-
* Config option moved to separate file as it used in test run.
|
|
11
|
-
*/
|
|
12
|
-
|
|
13
|
-
const configOption = exports.configOption = new _commander.Option(`-c, --config <file>`, `Path to Playwright configuration file (default: playwright.config.(js|ts))`);
|
|
14
|
-
/**
|
|
15
|
-
* Helper used in test run to detect config location.
|
|
16
|
-
*/
|
|
17
|
-
function getCliConfigPath() {
|
|
18
|
-
return new _commander.Command().allowUnknownOption().addOption(configOption).parse().getOptionValue('config');
|
|
19
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
var _worker_threads = require("worker_threads");
|
|
4
|
-
var _gen = require("../gen");
|
|
5
|
-
/**
|
|
6
|
-
* Worker to generate test files with fresh require/import cache
|
|
7
|
-
* See: https://github.com/nodejs/modules/issues/307#issuecomment-858729422
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
async function main() {
|
|
11
|
-
await new _gen.TestFilesGenerator(_worker_threads.workerData.config).generate();
|
|
12
|
-
}
|
|
13
|
-
main();
|