artes 1.2.16 → 1.2.18

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.
Files changed (38) hide show
  1. package/README.md +629 -533
  2. package/cucumber.config.js +171 -171
  3. package/docs/functionDefinitions.md +2401 -2401
  4. package/docs/stepDefinitions.md +391 -352
  5. package/executer.js +161 -161
  6. package/index.js +48 -48
  7. package/package.json +52 -51
  8. package/src/helper/contextManager/browserManager.js +63 -63
  9. package/src/helper/contextManager/requestManager.js +23 -23
  10. package/src/helper/controller/elementController.js +182 -182
  11. package/src/helper/controller/pomCollector.js +25 -25
  12. package/src/helper/executers/cleaner.js +19 -19
  13. package/src/helper/executers/exporter.js +15 -15
  14. package/src/helper/executers/helper.js +95 -95
  15. package/src/helper/executers/projectCreator.js +198 -198
  16. package/src/helper/executers/reportGenerator.js +58 -58
  17. package/src/helper/executers/testRunner.js +30 -30
  18. package/src/helper/executers/versionChecker.js +31 -31
  19. package/src/helper/imports/commons.js +56 -56
  20. package/src/helper/stepFunctions/APIActions.js +362 -362
  21. package/src/helper/stepFunctions/assertions.js +523 -523
  22. package/src/helper/stepFunctions/browserActions.js +22 -22
  23. package/src/helper/stepFunctions/elementInteractions.js +38 -38
  24. package/src/helper/stepFunctions/exporter.js +19 -19
  25. package/src/helper/stepFunctions/frameActions.js +50 -50
  26. package/src/helper/stepFunctions/keyboardActions.js +41 -41
  27. package/src/helper/stepFunctions/mouseActions.js +145 -145
  28. package/src/helper/stepFunctions/pageActions.js +27 -27
  29. package/src/hooks/context.js +15 -15
  30. package/src/hooks/hooks.js +257 -257
  31. package/src/stepDefinitions/API.steps.js +299 -299
  32. package/src/stepDefinitions/assertions.steps.js +861 -861
  33. package/src/stepDefinitions/browser.steps.js +7 -7
  34. package/src/stepDefinitions/frameActions.steps.js +76 -76
  35. package/src/stepDefinitions/keyboardActions.steps.js +226 -226
  36. package/src/stepDefinitions/mouseActions.steps.js +275 -275
  37. package/src/stepDefinitions/page.steps.js +71 -71
  38. package/src/stepDefinitions/random.steps.js +158 -158
@@ -1,23 +1,23 @@
1
- const { request } = require("playwright");
2
- const cucumberConfig = require("../../../cucumber.config.js");
3
-
4
- let baseURL = "";
5
-
6
- if (typeof cucumberConfig.baseURL === "object") {
7
- const env = (cucumberConfig.env || "").trim();
8
- baseURL = cucumberConfig.baseURL[env];
9
- } else {
10
- baseURL = cucumberConfig.baseURL;
11
- }
12
-
13
- const requestContextOptions = {
14
- baseURL: baseURL,
15
- ignoreHTTPSErrors: true
16
- };
17
-
18
- async function invokeRequest() {
19
- const context = await request.newContext(requestContextOptions);
20
- return context;
21
- }
22
-
23
- module.exports = { invokeRequest };
1
+ const { request } = require("playwright");
2
+ const cucumberConfig = require("../../../cucumber.config.js");
3
+
4
+ let baseURL = "";
5
+
6
+ if (typeof cucumberConfig.baseURL === "object") {
7
+ const env = (cucumberConfig.env || "").trim();
8
+ baseURL = cucumberConfig.baseURL[env];
9
+ } else {
10
+ baseURL = cucumberConfig.baseURL;
11
+ }
12
+
13
+ const requestContextOptions = {
14
+ baseURL: baseURL,
15
+ ignoreHTTPSErrors: true
16
+ };
17
+
18
+ async function invokeRequest() {
19
+ const context = await request.newContext(requestContextOptions);
20
+ return context;
21
+ }
22
+
23
+ module.exports = { invokeRequest };
@@ -1,182 +1,182 @@
1
- const { context } = require("../../hooks/context");
2
-
3
- let elements = {};
4
-
5
- function addElements(newElements) {
6
- elements = { ...elements, ...newElements };
7
- }
8
-
9
- // async function locatorExistenceChecker(locator){
10
- // const locatorCount = await locator.count();
11
- // console.log(locator, locatorCount)
12
- // return locatorCount ==0 ? false : true;
13
- // }
14
-
15
- function selectorSeperator(element) {
16
- if (typeof element !== "string") return element;
17
-
18
- const selector = element?.split("=");
19
- const validTypes = [
20
- "xpath",
21
- "name",
22
- "placeholder",
23
- "text",
24
- "label",
25
- "role",
26
- "alt",
27
- "title",
28
- "testid",
29
- ];
30
-
31
- if (selector && validTypes.includes(selector[0]?.trim())) {
32
- return [
33
- selector[0].trim(),
34
- selector[1] !== undefined ? selector[1].trim() : "",
35
- ];
36
- } else {
37
- return selector.join("=");
38
- }
39
- }
40
-
41
- function getSelector(element) {
42
- const selector =
43
- elements?.[element]?.selector || elements?.[element] || element;
44
- return resolveVariable(selectorSeperator(selector));
45
- }
46
-
47
- function getElement(element) {
48
- if (!context.page) {
49
- throw new Error("Page context is not initialized.");
50
- }
51
-
52
- const selector = getSelector(element);
53
- const waitTime = elements[element]?.waitTime * 1000 || 0;
54
-
55
- let locator;
56
- switch (selector[0]) {
57
- case "xpath":
58
- locator = context.page.locator(`xpath=${selector[1]}`, { exact: true });
59
- break;
60
- case "name":
61
- locator = context.page.locator(`[name="${selector[1]}"]`, {
62
- exact: true,
63
- });
64
- break;
65
- case "placeholder":
66
- locator = context.page.getByPlaceholder(selector[1], { exact: true });
67
- break;
68
- case "text":
69
- locator = context.page.getByText(selector[1], { exact: true });
70
- break;
71
- case "label":
72
- locator = context.page.getByLabel(selector[1], { exact: true });
73
- break;
74
- case "role":
75
- locator = context.page.getByRole(selector[1], { exact: true });
76
- break;
77
- case "alt":
78
- locator = context.page.getByAltText(selector[1], { exact: true });
79
- break;
80
- case "title":
81
- locator = context.page.getByTitle(selector[1], { exact: true });
82
- break;
83
- case "testid":
84
- locator = context.page.getByTestId(selector[1], { exact: true });
85
- break;
86
- default:
87
- locator = context.page.locator(selector, { exact: true });
88
- break;
89
- }
90
-
91
- return locator;
92
- }
93
-
94
- function extractVarsFromResponse(responseBody, vars, customVarName) {
95
- function getValueByPath(obj, path) {
96
- const keys = path.split(".");
97
- let current = obj;
98
-
99
- if (typeof obj == "string") return obj;
100
-
101
- for (const key of keys) {
102
- if (current && typeof current === "object" && key in current) {
103
- current = current[key];
104
- } else {
105
- return undefined;
106
- }
107
- }
108
-
109
- return current;
110
- }
111
-
112
- vars.split(",").forEach((v) => {
113
- const path = v.trim();
114
- const value = getValueByPath(responseBody, path);
115
- if (value !== undefined) {
116
- saveVar(value, customVarName, path);
117
- }
118
- });
119
- }
120
-
121
- function saveVar(value, customName, path) {
122
- if (!customName) {
123
- const flatKey = path
124
- .split(".")
125
- .map((part, i) =>
126
- i === 0 ? part : part[0].toUpperCase() + part.slice(1),
127
- )
128
- .join("");
129
-
130
- context.vars[flatKey] = value;
131
- } else {
132
- context.vars[customName] = value;
133
- }
134
- }
135
-
136
- function resolveVariable(template) {
137
- if (typeof template === "string") {
138
- return template.replace(/{{\s*(\w+)\s*}}/g, (_, varName) => {
139
- let value = context.vars[varName];
140
-
141
- if (value !== undefined) {
142
- if (typeof value !== "string") {
143
- try {
144
- value = JSON.stringify(value);
145
- } catch {
146
- value = String(value);
147
- }
148
- }
149
-
150
- return value
151
- .replace(/\n/g, "\\n")
152
- .replace(/\r/g, "\\r")
153
- .replace(/\t/g, "\\t");
154
- }
155
-
156
- return `{{${varName}}}`;
157
- });
158
- }
159
-
160
- if (Array.isArray(template)) {
161
- return template.map((item) => resolveVariable(item));
162
- }
163
-
164
- if (template && typeof template === "object") {
165
- const result = {};
166
- for (const key in template) {
167
- result[key] = resolveVariable(template[key]);
168
- }
169
- return result;
170
- }
171
-
172
- return template;
173
- }
174
-
175
- module.exports = {
176
- getElement,
177
- addElements,
178
- getSelector,
179
- extractVarsFromResponse,
180
- saveVar,
181
- resolveVariable,
182
- };
1
+ const { context } = require("../../hooks/context");
2
+
3
+ let elements = {};
4
+
5
+ function addElements(newElements) {
6
+ elements = { ...elements, ...newElements };
7
+ }
8
+
9
+ // async function locatorExistenceChecker(locator){
10
+ // const locatorCount = await locator.count();
11
+ // console.log(locator, locatorCount)
12
+ // return locatorCount ==0 ? false : true;
13
+ // }
14
+
15
+ function selectorSeperator(element) {
16
+ if (typeof element !== "string") return element;
17
+
18
+ const selector = element?.split("=");
19
+ const validTypes = [
20
+ "xpath",
21
+ "name",
22
+ "placeholder",
23
+ "text",
24
+ "label",
25
+ "role",
26
+ "alt",
27
+ "title",
28
+ "testid",
29
+ ];
30
+
31
+ if (selector && validTypes.includes(selector[0]?.trim())) {
32
+ return [
33
+ selector[0].trim(),
34
+ selector[1] !== undefined ? selector[1].trim() : "",
35
+ ];
36
+ } else {
37
+ return selector.join("=");
38
+ }
39
+ }
40
+
41
+ function getSelector(element) {
42
+ const selector =
43
+ elements?.[element]?.selector || elements?.[element] || element;
44
+ return resolveVariable(selectorSeperator(selector));
45
+ }
46
+
47
+ function getElement(element) {
48
+ if (!context.page) {
49
+ throw new Error("Page context is not initialized.");
50
+ }
51
+
52
+ const selector = getSelector(element);
53
+ const waitTime = elements[element]?.waitTime * 1000 || 0;
54
+
55
+ let locator;
56
+ switch (selector[0]) {
57
+ case "xpath":
58
+ locator = context.page.locator(`xpath=${selector[1]}`, { exact: true });
59
+ break;
60
+ case "name":
61
+ locator = context.page.locator(`[name="${selector[1]}"]`, {
62
+ exact: true,
63
+ });
64
+ break;
65
+ case "placeholder":
66
+ locator = context.page.getByPlaceholder(selector[1], { exact: true });
67
+ break;
68
+ case "text":
69
+ locator = context.page.getByText(selector[1], { exact: true });
70
+ break;
71
+ case "label":
72
+ locator = context.page.getByLabel(selector[1], { exact: true });
73
+ break;
74
+ case "role":
75
+ locator = context.page.getByRole(selector[1], { exact: true });
76
+ break;
77
+ case "alt":
78
+ locator = context.page.getByAltText(selector[1], { exact: true });
79
+ break;
80
+ case "title":
81
+ locator = context.page.getByTitle(selector[1], { exact: true });
82
+ break;
83
+ case "testid":
84
+ locator = context.page.getByTestId(selector[1], { exact: true });
85
+ break;
86
+ default:
87
+ locator = context.page.locator(selector, { exact: true });
88
+ break;
89
+ }
90
+
91
+ return locator;
92
+ }
93
+
94
+ function extractVarsFromResponse(responseBody, vars, customVarName) {
95
+ function getValueByPath(obj, path) {
96
+ const keys = path.split(".");
97
+ let current = obj;
98
+
99
+ if (typeof obj == "string") return obj;
100
+
101
+ for (const key of keys) {
102
+ if (current && typeof current === "object" && key in current) {
103
+ current = current[key];
104
+ } else {
105
+ return undefined;
106
+ }
107
+ }
108
+
109
+ return current;
110
+ }
111
+
112
+ vars.split(",").forEach((v) => {
113
+ const path = v.trim();
114
+ const value = getValueByPath(responseBody, path);
115
+ if (value !== undefined) {
116
+ saveVar(value, customVarName, path);
117
+ }
118
+ });
119
+ }
120
+
121
+ function saveVar(value, customName, path) {
122
+ if (!customName) {
123
+ const flatKey = path
124
+ .split(".")
125
+ .map((part, i) =>
126
+ i === 0 ? part : part[0].toUpperCase() + part.slice(1),
127
+ )
128
+ .join("");
129
+
130
+ context.vars[flatKey] = value;
131
+ } else {
132
+ context.vars[customName] = value;
133
+ }
134
+ }
135
+
136
+ function resolveVariable(template) {
137
+ if (typeof template === "string") {
138
+ return template.replace(/{{\s*(\w+)\s*}}/g, (_, varName) => {
139
+ let value = context.vars[varName];
140
+
141
+ if (value !== undefined) {
142
+ if (typeof value !== "string") {
143
+ try {
144
+ value = JSON.stringify(value);
145
+ } catch {
146
+ value = String(value);
147
+ }
148
+ }
149
+
150
+ return value
151
+ .replace(/\n/g, "\\n")
152
+ .replace(/\r/g, "\\r")
153
+ .replace(/\t/g, "\\t");
154
+ }
155
+
156
+ return `{{${varName}}}`;
157
+ });
158
+ }
159
+
160
+ if (Array.isArray(template)) {
161
+ return template.map((item) => resolveVariable(item));
162
+ }
163
+
164
+ if (template && typeof template === "object") {
165
+ const result = {};
166
+ for (const key in template) {
167
+ result[key] = resolveVariable(template[key]);
168
+ }
169
+ return result;
170
+ }
171
+
172
+ return template;
173
+ }
174
+
175
+ module.exports = {
176
+ getElement,
177
+ addElements,
178
+ getSelector,
179
+ extractVarsFromResponse,
180
+ saveVar,
181
+ resolveVariable,
182
+ };
@@ -1,25 +1,25 @@
1
- const { addElements } = require("./elementController");
2
- const cucumberConfig = require("../../../cucumber.config");
3
- const fs = require("fs");
4
-
5
- function pomCollector() {
6
- if (fs.existsSync(cucumberConfig.default.pomPath)) {
7
- fs.readdir(`${cucumberConfig.default.pomPath}`, (err, files) => {
8
- files.forEach((file) => {
9
- fs.readFile(
10
- `${cucumberConfig.default.pomPath}/${file}`,
11
- "utf-8",
12
- (err, content) => {
13
- try {
14
- addElements(JSON.parse(content));
15
- } catch (error) {
16
- console.log(`Error parsing POM file ${file}:`, error.message);
17
- }
18
- },
19
- );
20
- });
21
- });
22
- }
23
- }
24
-
25
- module.exports = { pomCollector };
1
+ const { addElements } = require("./elementController");
2
+ const cucumberConfig = require("../../../cucumber.config");
3
+ const fs = require("fs");
4
+
5
+ function pomCollector() {
6
+ if (fs.existsSync(cucumberConfig.default.pomPath)) {
7
+ fs.readdir(`${cucumberConfig.default.pomPath}`, (err, files) => {
8
+ files.forEach((file) => {
9
+ fs.readFile(
10
+ `${cucumberConfig.default.pomPath}/${file}`,
11
+ "utf-8",
12
+ (err, content) => {
13
+ try {
14
+ addElements(JSON.parse(content));
15
+ } catch (error) {
16
+ console.log(`Error parsing POM file ${file}:`, error.message);
17
+ }
18
+ },
19
+ );
20
+ });
21
+ });
22
+ }
23
+ }
24
+
25
+ module.exports = { pomCollector };
@@ -1,19 +1,19 @@
1
- const { moduleConfig } = require("../imports/commons");
2
- const { spawnSync } = require("child_process");
3
-
4
- function cleanUp() {
5
- try {
6
- spawnSync("rimraf", [moduleConfig.cleanUpPaths], {
7
- cwd: moduleConfig.modulePath,
8
- stdio: "ignore",
9
- shell: true,
10
- });
11
- } catch (error) {
12
- console.error("❌ Error in cleanup:", error.message);
13
- process.env.EXIT_CODE = 1;
14
- }
15
- }
16
-
17
- module.exports = {
18
- cleanUp,
19
- };
1
+ const { moduleConfig } = require("../imports/commons");
2
+ const { spawnSync } = require("child_process");
3
+
4
+ function cleanUp() {
5
+ try {
6
+ spawnSync("rimraf", [moduleConfig.cleanUpPaths], {
7
+ cwd: moduleConfig.modulePath,
8
+ stdio: "ignore",
9
+ shell: true,
10
+ });
11
+ } catch (error) {
12
+ console.error("❌ Error in cleanup:", error.message);
13
+ process.env.EXIT_CODE = 1;
14
+ }
15
+ }
16
+
17
+ module.exports = {
18
+ cleanUp,
19
+ };
@@ -1,15 +1,15 @@
1
- const { showHelp } = require("./helper");
2
- const { createProject } = require("./projectCreator");
3
- const { generateReport } = require("./reportGenerator");
4
- const { runTests } = require("./testRunner");
5
- const { showVersion } = require("./versionChecker");
6
- const { cleanUp } = require("./cleaner");
7
-
8
- module.exports = {
9
- createProject,
10
- generateReport,
11
- runTests,
12
- showHelp,
13
- showVersion,
14
- cleanUp,
15
- };
1
+ const { showHelp } = require("./helper");
2
+ const { createProject } = require("./projectCreator");
3
+ const { generateReport } = require("./reportGenerator");
4
+ const { runTests } = require("./testRunner");
5
+ const { showVersion } = require("./versionChecker");
6
+ const { cleanUp } = require("./cleaner");
7
+
8
+ module.exports = {
9
+ createProject,
10
+ generateReport,
11
+ runTests,
12
+ showHelp,
13
+ showVersion,
14
+ cleanUp,
15
+ };