@zohodesk/testinglibrary 0.3.6-experimental → 0.3.8-experimental

package/build/core/playwright/helpers/auth/getUsers.js

@@ -33,12 +33,17 @@ function getDefaultActorConf() {
   const {
     uatDirectory
   } = (0, _readConfigFile.generateConfigFromFile)();
-  const defaultSettingFile = `conf/${getRunMode()}/settings.json`;
-  const filePath = _path.default.join(uatDirectory, defaultSettingFile);
-  if (!(0, _fs.existsSync)(filePath)) {
-    throw new Error(`${defaultSettingFile} is missing.`);
+  const modeSettingsFile = `conf/${getRunMode()}/settings.json`;
+  const filePath = _path.default.join(uatDirectory, modeSettingsFile);
+  try {
+    if (!(0, _fs.existsSync)(filePath)) {
+      const defaultSettingsFile = _path.default.join(uatDirectory, `conf/default/settings.json`);
+      return require(defaultSettingsFile);
+    }
+    return require(filePath);
+  } catch (error) {
+    throw new Error(`${defaultSettingFile} ${filePath} both files are missing.`);
   }
-  return require(filePath);
 }
 function getDefaultActor() {
   const {
@@ -52,18 +57,25 @@ function getListOfActors() {
     uatDirectory
   } = (0, _readConfigFile.generateConfigFromFile)();
   const mode = getRunMode();
-  const configFile = `conf/${mode}/actors/index`;
-  const filePath = _path.default.join(uatDirectory, configFile);
-  if (!(0, _fs.existsSync)(filePath + '.js')) {
-    throw new Error(`${configFile}.js is missing.`);
+  let configFile = _path.default.join(uatDirectory, `conf/${mode}/actors/index.js`);
+  if (!(0, _fs.existsSync)(configFile)) {
+    configFile = _path.default.join(uatDirectory, `conf/default/actors/index.js`);
+  }
+  try {
+    return require(configFile);
+  } catch (error) {
+    throw new Error(`Error loading actor configuration from ${configFile}`);
   }
-  return require(filePath);
 }
 function getUserForSelectedEditionAndProfile(preferedEdition, preferredProfile, betaFeature, testDataPortal = null) {
+  const actorsData = getListOfActors();
+  if (!actorsData || !actorsData.editions) {
+    throw new Error("The actors data is missing.");
+  }
   const {
     editions: userdata,
     beta: betaPortals
-  } = getListOfActors();
+  } = actorsData;
   const defaultConf = getDefaultActorConf();
   const edition = preferedEdition || defaultConf.edition;
   const profile = preferredProfile || defaultConf.profile;

package/build/core/playwright/helpers/configFileNameProvider.js

@@ -9,8 +9,14 @@ exports.getReportFileName = getReportFileName;
 exports.getUATFileName = getUATFileName;
 var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
-function getUATFileName() {
-  return 'uat.config.js';
+var _auth = require("./auth");
+function getUATFileName(mode) {
+  mode = mode || (0, _auth.getRunMode)();
+  const uatConfFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/uat.config.js`);
+  if (_fs.default.existsSync(uatConfFilePath)) {
+    return uatConfFilePath;
+  }
+  return _path.default.resolve(process.cwd(), `uat.config.js`);
 }
 function getEnvConfigFilePath(mode) {
   const confFilePath = _path.default.resolve(process.cwd(), `uat/conf/${mode}/settings.json`);
@@ -18,7 +24,7 @@ function getEnvConfigFilePath(mode) {
   if (_fs.default.existsSync(confFilePath)) {
     return `uat/conf/${mode}/settings.json`;
   }
-  return `uat/env-config.json`;
+  return `uat/conf/default/settings.json`;
 }
 function getReportFileName() {
   return `test-summary.json`;

package/build/core/playwright/index.js

@@ -1,24 +1,37 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createBdd = void 0;
-Object.defineProperty(exports, "expect", {
+Object.defineProperty(exports, "createBdd", {
   enumerable: true,
   get: function () {
-    return _test.expect;
+    return _bddFramework.createBdd;
   }
 });
-Object.defineProperty(exports, "test", {
+Object.defineProperty(exports, "expect", {
   enumerable: true,
   get: function () {
-    return _playwrightBdd.test;
+    return _test.expect;
   }
 });
-var _playwrightBdd = require("playwright-bdd");
+exports.test = void 0;
+var _bddFramework = require("../../bdd-framework");
 var _test = require("@playwright/test");
-let createBdd = function () {
-  return (0, _playwrightBdd.createBdd)(_playwrightBdd.test);
-};
-exports.createBdd = createBdd;
+var _readConfigFile = require("./readConfigFile");
+var _builtInFixtures = _interopRequireDefault(require("./builtInFixtures"));
+var _getUserFixtures = _interopRequireDefault(require("./helpers/getUserFixtures"));
+const {
+  bddMode
+} = (0, _readConfigFile.generateConfigFromFile)();
+let base = bddMode ? _bddFramework.test : _test.test;
+const buildInFixtures = (0, _builtInFixtures.default)(bddMode);
+const buildInFixturesTest = base.extend({
+  ...buildInFixtures
+});
+const userFixtures = (0, _getUserFixtures.default)();
+const userFixturesTest = base.extend({
+  ...userFixtures
+});
+const test = exports.test = (0, _test.mergeTests)(buildInFixturesTest, userFixturesTest);

package/build/core/playwright/readConfigFile.js

@@ -13,7 +13,6 @@ var _path = _interopRequireDefault(require("path"));
 var _logger = require("../../utils/logger");
 var _configFileNameProvider = require("./helpers/configFileNameProvider");
 var _mergeObjects = require("./helpers/mergeObjects");
-var _Configuration = require("./configuration/Configuration");
 let cachedConfig = null;
 function getDefaultConfig() {
   return {
@@ -34,26 +33,18 @@ function getDefaultConfig() {
       height: 720
     },
     debug: false,
-    mode: process.env.mode || 'dev',
+    testIdAttribute: 'data-testid',
     additionalPages: {},
     featureFilesFolder: 'feature-files',
     stepDefinitionsFolder: 'steps',
-    testIdAttribute: 'data-testid',
     testSetup: {},
     editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
   };
 }
-function checkForDeprecatedKeys(configKey) {
-  let deprecatedConfigInUatConfigFile = ['mode'];
-  if (deprecatedConfigInUatConfigFile.includes(configKey)) {
-    _logger.Logger.log(_logger.Logger.INFO_TYPE, `key ${configKey} is deprecated. Please use other options`);
-  }
-}
 function combineDefaultConfigWithUserConfig(userConfiguration) {
   let defaultConfig = getDefaultConfig();
   let configurationObj = {};
   Object.keys(userConfiguration).forEach(configKey => {
-    checkForDeprecatedKeys(configKey);
     let configValue = userConfiguration[configKey];
     if (configValue !== null && configValue !== undefined) {
       configurationObj[configKey] = configValue;
@@ -112,11 +103,15 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  *
  * @returns {UserConfig}
  */
+
+function getConfigFilePath() {
+  return _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+}
 function generateConfigFromFile() {
   if (cachedConfig !== null) {
     return cachedConfig; // If cached, return the cached configuration
   }
-  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+  const filePath = getConfigFilePath();
   if ((0, _fs.existsSync)(filePath)) {
     /** @type {UserConfig} */
     const config = require(filePath);
@@ -127,7 +122,7 @@ function generateConfigFromFile() {
   return {};
 }
 function isUserConfigFileAvailable() {
-  const filePath = _path.default.resolve(process.cwd(), (0, _configFileNameProvider.getUATFileName)());
+  const filePath = getConfigFilePath();
   if ((0, _fs.existsSync)(filePath)) {
     return true;
   }

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

@@ -38,12 +38,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
   featureFilesFolder,
   stepDefinitionsFolder
 });
-const use = {
+const testOptions = (0, _configUtils.getTestUseOptions)({
   trace,
   video,
   viewport,
   testIdAttribute
-};
+});
 
 /**
  * Playwright configuration object
@@ -56,7 +56,6 @@ function getPlaywrightConfig() {
     globalTimeout: globalTimeout || 3600000,
     outputDir: _path.default.join(process.cwd(), 'uat', 'test-results'),
     fullyParallel: true,
-    forbidOnly: !!process.env.CI,
     retries: process.env.CI ? 2 : 0,
     reporter: [['html', {
       outputFolder: reportPath,
@@ -66,7 +65,7 @@ function getPlaywrightConfig() {
     expect: {
       timeout: expectTimeout
     },
-    use,
+    use: testOptions,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,

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

@@ -7,12 +7,14 @@ Object.defineProperty(exports, "__esModule", {
 exports.getBrowsersList = getBrowsersList;
 exports.getProjects = getProjects;
 exports.getTestDir = getTestDir;
+exports.getTestUseOptions = getTestUseOptions;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
-var _playwrightBdd = require("playwright-bdd");
+var _bddFramework = require("../../../bdd-framework");
 var _logger = require("../../../utils/logger");
 var _browserTypes = require("../constants/browserTypes");
+var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _fileUtils = require("../../../utils/fileUtils");
 /**
  ** Playwright project configuration
@@ -146,15 +148,30 @@ function getPathsForFeatureFiles(cwd) {
 function getTestDir(bddMode, cwd, {
   stepDefinitionsFolder
 }) {
-  return bddMode ? (0, _playwrightBdd.defineBddConfig)({
-    features: getPathsForFeatureFiles(cwd),
-    steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), require.resolve('../fixtures.js')],
-    importTestFrom: require.resolve('../fixtures.js'),
+  return bddMode ? (0, _bddFramework.defineBddConfig)({
+    paths: getPathsForFeatureFiles(cwd),
+    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
     featuresRoot: _path.default.join(cwd, 'uat'),
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
-    disableWarnings: {
-      importTestFrom: true
-    },
     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/test-runner.js

@@ -42,7 +42,7 @@ function getPlaywrightArgs(userArgsObject, debug, bddMode, tagArgs, headless) {
 }
 function runPreprocessing(tagArgs, configPath) {
   const beforeCommand = 'node';
-  const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
+  const bddGenPath = _path.default.resolve(__dirname, '../', '../', 'bdd-framework', 'cli', 'index.js');
   const beforeArgs = [bddGenPath, '-c', configPath];
   if (tagArgs) {
     beforeArgs.push('--tags');
@@ -103,15 +103,16 @@ function main() {
   const uatConfig = new _Configuration.default((0, _readConfigFile.getDefaultConfig)());
 
   // overriding the application config's from project
-  uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)()));
 
-  // overriding the user config's from CLI
   const userArgConfig = new _Configuration.default(_UserArgs.default.parseToObject(process.argv.slice(2)));
+  const mode = userArgConfig.get("mode");
+  uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)(mode)));
+
+  // overriding the user config's from CLI
   uatConfig.addAll(userArgConfig);
   const {
     isAuthMode,
     editionOrder,
-    mode,
     debug,
     bddMode = false,
     headless = false

package/build/decorators.d.ts

@@ -1 +1 @@
-export * from 'playwright-bdd/decorators';
+export * from './bdd-framework/decorators';

package/build/decorators.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _decorators = require("playwright-bdd/decorators");
+var _decorators = require("./bdd-framework/decorators");
 Object.keys(_decorators).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _decorators[key]) return;

package/build/test/core/playwright/helpers/__tests__/configFileNameProvider.test.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _fs = require("fs");
+var _path = _interopRequireDefault(require("path"));
+var _configFileNameProvider = require("../../../../../core/playwright/helpers/configFileNameProvider");
+jest.mock('fs');
+jest.mock('path');
+const mockCwd = '/mock/current/directory';
+_path.default.resolve = jest.fn();
+process.cwd = jest.fn(() => mockCwd);
+describe('getUATFileName', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  test('return the pipeline matched config files for pipeline matched files exists', () => {
+    const mode = 'cd';
+    const mockPath = `${mockCwd}/uat/conf/${mode}/uat.config.js`;
+    _fs.existsSync.mockReturnValue(true);
+    _path.default.resolve.mockImplementation((...args) => args.join('/'));
+    const result = (0, _configFileNameProvider.getUATFileName)(mode);
+    expect(_fs.existsSync).toHaveBeenCalledWith(mockPath);
+    expect(result).toBe(mockPath);
+  });
+  test('return the default config files for pipeline matched files not exists', () => {
+    const mode = 'ci';
+    const defaultPath = `${mockCwd}/uat.config.js`;
+    _fs.existsSync.mockReturnValue(false);
+    _path.default.resolve.mockImplementation((...args) => args.join('/'));
+    const result = (0, _configFileNameProvider.getUATFileName)(mode);
+    expect(_fs.existsSync).toHaveBeenCalledWith(`${mockCwd}/uat/conf/${mode}/uat.config.js`);
+    expect(result).toBe(defaultPath);
+  });
+});