@zohodesk/testinglibrary 0.1.2 → 0.1.4-exp.1

package/.eslintrc.js

@@ -22,6 +22,6 @@ module.exports = {
     "sourceType": "module"
   },
   "rules": {
-    "indent": ["error", 2]
+    "indent": ["error", 2, { "SwitchCase": 1 }]
   }
 }

package/build/core/playwright/clear-caches.js

@@ -0,0 +1,30 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _fileUtils = require("../../utils/fileUtils");
+var _logger = require("../../utils/logger");
+var _readConfigFile = require("./readConfigFile");
+function clearCaches() {
+  try {
+    const {
+      authFilePath,
+      reportPath
+    } = (0, _readConfigFile.generateConfigFromFile)();
+    authFilePath.split('/').pop();
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting auth files present in ${authFilePath}`);
+    (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), authFilePath));
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `Deleting Playwright report ${reportPath}`);
+    (0, _fileUtils.deleteFolder)(reportPath);
+    (0, _fileUtils.deleteFolder)(_path.default.resolve(process.cwd(), 'uat', '.features-gen'));
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Caches Cleared');
+  } catch (err) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error While clearing cookies');
+  }
+}
+var _default = clearCaches;
+exports.default = _default;

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,
@@ -42,21 +60,12 @@ function getPlaywrightConfig() {
     reporter: [['html', {
       outputFolder: reportPath,
       open: openReportOn
-    }]],
+    }], ['list'], ['./src/reporter.js']],
     timeout: testTimeout,
     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/core/playwright/setup/custom-reporter.js

@@ -0,0 +1,84 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _fileUtils = require("../../../utils/fileUtils");
+var _readConfigFile = require("../readConfigFile");
+class JSONSummaryReporter {
+  constructor() {
+    this.durationInMS = -1;
+    this.passed = [];
+    this.skipped = [];
+    this.failed = [];
+    this.warned = [];
+    this.interrupted = [];
+    this.timedOut = [];
+    this.flakey = [];
+    this.status = 'unknown';
+    this.startedAt = 0;
+  }
+  onBegin() {
+    this.startedAt = Date.now();
+  }
+  onTestEnd(test, result) {
+    const title = [];
+    const fileName = [];
+    let clean = true;
+    for (const s of test.titlePath()) {
+      if (s === '' && clean) continue;
+      clean = false;
+      title.push(s);
+      if (s.includes('.ts') || s.includes('.js')) {
+        fileName.push(s);
+      }
+    }
+    // This will publish the file name + line number test begins on
+    const z = `${fileName[0]}:${test.location.line}:${test.location.column}`;
+    // Using the t variable in the push will push a full test name + test description
+    const t = title.join(' > ');
+    // Set the status
+    const status = !['passed', 'skipped'].includes(result.status) && t.includes('@warn') ? 'warned' : result.status;
+    // Logic to push the results into the correct array
+    if (result.status === 'passed' && result.retry >= 1) {
+      this.flakey.push(z);
+    } else {
+      this[status].push(z);
+    }
+    this[status].push(z);
+  }
+  onEnd(result) {
+    this.durationInMS = Date.now() - this.startedAt;
+    this.status = result.status;
+    // removing duplicate tests from passed array
+    this.passed = this.passed.filter((element, index) => {
+      return this.passed.indexOf(element) === index;
+    });
+    // removing duplicate tests from the failed array
+    this.failed = this.failed.filter((element, index) => {
+      if (!this.passed.includes(element)) return this.failed.indexOf(element) === index;
+    });
+    // removing duplicate tests from the skipped array
+    this.skipped = this.skipped.filter((element, index) => {
+      return this.skipped.indexOf(element) === index;
+    });
+    // removing duplicate tests from the timedOut array
+    this.timedOut = this.timedOut.filter((element, index) => {
+      return this.timedOut.indexOf(element) === index;
+    });
+    // removing duplicate tests from the interrupted array
+    this.interrupted = this.interrupted.filter((element, index) => {
+      return this.interrupted.indexOf(element) === index;
+    });
+    // fs.writeFileSync('./summary.json', JSON.stringify(this, null, '  '));
+    let {
+      reportPath
+    } = (0, _readConfigFile.generateConfigFromFile)();
+    (0, _fileUtils.writeFileContents)(_path.default.join(reportPath, './', 'test-summary.json'), JSON.stringify(this, null, '  '));
+  }
+}
+var _default = JSONSummaryReporter;
+exports.default = _default;

package/build/lib/cli.js

@@ -7,6 +7,7 @@ var _codegen = _interopRequireDefault(require("../core/playwright/codegen"));
 var _logger = require("../utils/logger");
 var _setupProject = _interopRequireDefault(require("../setup-folder-structure/setupProject"));
 var _parser = require("../parser/parser");
+var _clearCaches = _interopRequireDefault(require("../core/playwright/clear-caches"));
 // import createJestRunner from '../core/jest/runner/jest-runner';
 
 const [,, option, ...otherOptions] = process.argv;
@@ -46,6 +47,12 @@ switch (option) {
       (0, _parser.generateSpecCodeForFeatureFile)(otherOptions);
       break;
     }
+  case 'clearCaches':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Clearing caches...');
+      (0, _clearCaches.default)();
+      break;
+    }
   default:
     {
       _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Supported Commands test and report');

package/build/setup-folder-structure/samples/git-ignore.sample.js

@@ -2,15 +2,19 @@ import { existsSync, readFileSync, writeFileSync } from 'fs';
 import path from 'path';
 import { Logger } from '../utils/logger';
 import { generateConfigFromFile } from '../core/playwright/readConfigFile';
-
+const gitIgnoreAbsolutePath = path.resolve(process.cwd(), '../', '../')
 
 const { reportPath = path.resolve(process.cwd(), 'uat', 'playwright-reports') } = generateConfigFromFile();
 const testResultsPath = path.resolve(process.cwd(), 'uat', 'test-results');
 
-const testResultsRelativepath = path.relative(path.resolve(process.cwd(), '../', '../'), testResultsPath)
-const reportRelativepath = path.relative(path.resolve(process.cwd(), '../', '../'), reportPath)
+const testResultsRelativepath = path.relative(gitIgnoreAbsolutePath, testResultsPath)
+const reportRelativepath = path.relative(gitIgnoreAbsolutePath, reportPath)
+
+
+const absolutePathfeaturegen = path.resolve(process.cwd(), 'uat', '.features-gen');
+const featuregenRelativePath = path.relative(gitIgnoreAbsolutePath,absolutePathfeaturegen)
 
-const dirpathtoIgnore = `${testResultsRelativepath}\n${reportRelativepath}`
+const dirpathtoIgnore = `${testResultsRelativepath}\n${reportRelativepath}\n${featuregenRelativePath}`
 
 function updateGitIgnore() {
   if (existsSync(path.resolve(process.cwd(), '../', '../', '.gitignore'))) {

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/build/setup-folder-structure/setupProject.js

@@ -61,14 +61,18 @@ function createUatConfig() {
 function createAuthenticationFile() {
   const isUATexist = _path.default.resolve(process.cwd(), 'uat');
   if ((0, _fs.existsSync)(isUATexist)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
     try {
-      (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures'));
-      (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth'), {
-        recursive: true
-      });
+      if (!(0, _fs.existsSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures'))) {
+        (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures'));
+      }
+      if (!(0, _fs.existsSync)(_path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth'))) {
+        (0, _fs.mkdirSync)(_path.default.resolve(process.cwd(), 'uat', 'playwright', '.auth'), {
+          recursive: true
+        });
+      }
       (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'auth.setup.js'), getSetupFileAsString('auth-setup-sample.js'), null, 2);
       (0, _fs.writeFileSync)(_path.default.resolve(process.cwd(), 'uat', 'fixtures', 'authUsers.json'), getSetupFileAsString('authUsers-sample.json'), null, 2);
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Creating Authentication File ....');
     } catch (err) {
       _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Something went wrong ! Folder not Created. Please re-initialize npm init-uat');
     }
@@ -91,6 +95,7 @@ function setupProject() {
   createFolderForUAT();
   createConfigJson();
   createAuthenticationFile();
+  //updateGitIgnore()
   // Create folder for playwright . Inside .auth folder needs to be created. user.json
   // Add playwright and test-results to .gitignore
   setTimeout(() => {

package/build/utils/fileUtils.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.checkIfFileExists = checkIfFileExists;
 exports.deleteFile = deleteFile;
+exports.deleteFolder = deleteFolder;
 exports.readFileContents = readFileContents;
 exports.writeFileContents = writeFileContents;
 var _fs = _interopRequireDefault(require("fs"));
@@ -50,4 +51,15 @@ function deleteFile(filePath) {
       throw new Error(`Error while deleting the test data file: ${filePath}`);
     }
   }
+}
+function deleteFolder(folderPath) {
+  if (_fs.default.existsSync(folderPath)) {
+    try {
+      _fs.default.rmdirSync(folderPath, {
+        recursive: true
+      });
+    } catch (err) {
+      throw new Error(`Error while deleting the test data file: ${folderPath}`);
+    }
+  }
 }

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/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.1-exp.1",
+  "version": "0.1.4",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

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