@zohodesk/testinglibrary 0.1.2 → 0.1.4

package/build/core/playwright/readConfigFile.js

@@ -15,6 +15,7 @@ const fileName = 'uat.config.js';
 exports.fileName = fileName;
 function getDefaultConfig() {
   return {
+    headless: false,
     browsers: ['Chrome'],
     trace: false,
     video: false,
@@ -31,14 +32,28 @@ function getDefaultConfig() {
     },
     debug: false,
     mode: 'dev',
-    additionalPages: {}
+    additionalPages: {},
+    featureFilesFolder: 'feature-files',
+    stepDefinitionsFolder: 'steps',
+    testIdAttribute: 'data-testid'
   };
 }
 function combineDefaultConfigWithUserConfig(userConfiguration) {
   let defaultConfig = getDefaultConfig();
+  let configurationObj = {};
+  Object.keys(userConfiguration).forEach(configKey => {
+    let configValue = userConfiguration[configKey];
+    if (configValue !== null && configValue !== undefined) {
+      configurationObj[configKey] = configValue;
+    } else if (defaultConfig[configKey]) {
+      configurationObj[configKey] = defaultConfig[configKey];
+    } else {
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, `key - ${configKey} is not yet supported in uat configuration. This will not be used while creating playwright configuration`);
+    }
+  });
   return {
     ...defaultConfig,
-    ...userConfiguration
+    ...configurationObj
   };
 }
 
@@ -56,7 +71,7 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @property {boolean} video - video for test cases,
  * @property {boolean} debug - debug mode
  * @property {string} mode: mode in which the test cases needs to run
- * @property {boolean} isAuthMode -  Auth Mode
+ * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
  * @property {string} authFilePath - File Path where the cookies stored
  * @property {any} browsers: List of browsers
  * @property {string} openReportOn: default Option value (never, on-failure and always) 
@@ -67,7 +82,8 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @property {Object} additionalPages: custom pages configuration
  * @property {string} featureFilesFolder: folder name under which feature-files will be placed. Default is feature-files
  * @property {string} stepDefinitionsFolder: folder name under which step implementations will be placed. Default is steps
- * @property {viewportConfig} viewport: viewport configuration
+ * @property {viewportConfig} viewport: viewport configuration for the browser. Default is { width: 1280, height: 720 }
+ * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
  */
 
 /**

package/build/core/playwright/setup/config-creator.js

@@ -20,7 +20,10 @@ const {
   expectTimeout,
   testTimeout,
   authFilePath,
-  viewport
+  viewport,
+  featureFilesFolder,
+  stepDefinitionsFolder,
+  testIdAttribute
 } = (0, _readConfigFile.generateConfigFromFile)();
 const projects = (0, _configUtils.getProjects)({
   browsers,
@@ -30,7 +33,22 @@ const projects = (0, _configUtils.getProjects)({
   testTimeout,
   viewport
 });
-const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd());
+const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
+  featureFilesFolder,
+  stepDefinitionsFolder
+});
+const testOptions = (0, _configUtils.getTestUseOptions)({
+  trace,
+  video,
+  viewport,
+  testIdAttribute
+});
+
+/**
+ * Playwright configuration object
+ *
+ * @returns {import('@playwright/test').PlaywrightTestConfig}
+*/
 function getPlaywrightConfig() {
   return {
     testDir,
@@ -47,16 +65,7 @@ function getPlaywrightConfig() {
     expect: {
       timeout: expectTimeout
     },
-    use: {
-      viewport,
-      trace: trace ? 'on' : 'off',
-      video: video ? {
-        mode: 'on',
-        size: {
-          ...viewport
-        }
-      } : 'off'
-    },
+    use: testOptions,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,

package/build/core/playwright/setup/config-utils.js

@@ -6,10 +6,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getProjects = getProjects;
 exports.getTestDir = getTestDir;
+exports.getTestUseOptions = getTestUseOptions;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
 var _bddFramework = require("../../../bdd-framework");
+/**
+ ** Playwright project configuration
+ * @returns {import('@playwright/test').Project}
+ */
 function getBrowserConfig({
   browserName,
   isAuthMode,
@@ -81,6 +86,12 @@ function getBrowserConfig({
     return false;
   }
 }
+
+/**
+ * 
+ * @param {*} param0 
+ * @returns {import('@playwright/test').Project[]}
+ */
 function getProjects({
   browsers,
   isAuthMode,
@@ -98,12 +109,33 @@ function getProjects({
     viewport
   })).filter(Boolean);
 }
-function getTestDir(bddMode, cwd) {
+function getTestDir(bddMode, cwd, {
+  stepDefinitionsFolder
+}) {
   return bddMode ? (0, _bddFramework.defineBddConfig)({
     paths: [_path.default.join(cwd, 'uat', '**', '*.feature')],
-    import: [_path.default.join(cwd, 'uat', '**', 'steps', '*.spec.js')],
+    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
     featuresRoot: _path.default.join(cwd, 'uat'),
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
     publish: true
   }) : _path.default.join(cwd, 'uat');
+}
+function getTestUseOptions({
+  viewport,
+  trace,
+  video,
+  testIdAttribute
+}) {
+  let defaultTestuseOptions = {
+    viewport,
+    testIdAttribute,
+    trace: trace ? 'on' : 'off',
+    video: video ? {
+      mode: 'on',
+      size: {
+        ...viewport
+      }
+    } : 'off'
+  };
+  return defaultTestuseOptions;
 }

package/build/setup-folder-structure/samples/uat-config-sample.js

@@ -11,7 +11,7 @@
  * @property {boolean} video - video for test cases,
  * @property {boolean} debug - debug mode
  * @property {string} mode: mode in which the test cases needs to run
- * @property {boolean} isAuthMode -  Auth Mode
+ * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
  * @property {string} authFilePath - File Path where the cookies stored
  * @property {any} browsers: List of browsers
  * @property {string} openReportOn: default Option value (never, on-failure and always) 
@@ -22,7 +22,8 @@
  * @property {Object} additionalPages: custom pages configuration
  * @property {string} featureFilesFolder: folder name under which feature-files will be placed. Default is feature-files
  * @property {string} stepDefinitionsFolder: folder name under which step implementations will be placed. Default is steps
- * @property {viewportConfig} viewport: viewport configuration for the browser. Default is {width: 1280, height: 720 }
+ * @property {viewportConfig} viewport: viewport configuration for the browser. Default is { width: 1280, height: 720 }
+ * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
  */
 
 /**
@@ -36,7 +37,8 @@ module.exports = {
   authFilePath: 'uat/playwright/.auth/user.json',
   trace: true,
   video: true,
+  bddMode: true,
   featureFilesFolder: 'feature-files',
   stepDefinitionsFolder: 'steps',
-  viewport: null
+  viewport: { width: 1280, height: 720 }
 }

package/changelog.md

@@ -2,6 +2,16 @@
 
 ## Framework that abstracts the configuration for playwright and Jest
 
+# 0.1.4
+
+- `testIdAttribute` config added
+- Fixed issue while reading boolean configuration values
+
+# 0.1.3
+
+- uat config sample file updated with `bddMode` and `viewport` values
+- user configuration issue fix when the value is undefined
+
 # 0.1.2
 
 - Bdd version updated to `5.4.0`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "",
   "main": "./build/index.js",
   "scripts": {