@zohodesk/testinglibrary 0.0.3-n20-experimental → 0.0.4-n20-experimental

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

@@ -0,0 +1,54 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.executeDefaultLoginSteps = executeDefaultLoginSteps;
+exports.loginSteps = loginSteps;
+exports.performDefaultPageSteps = performDefaultPageSteps;
+exports.verifyPageIsLoaded = verifyPageIsLoaded;
+var _auth = require("../auth");
+var _readConfigFile = require("../../readConfigFile");
+var _logger = require("../../../../utils/logger");
+let {
+  testSetup,
+  isAuthMode
+} = (0, _readConfigFile.generateConfigFromFile)();
+async function loginSteps(pageDetail) {
+  const {
+    page
+  } = pageDetail;
+  if (testSetup.loginSteps && typeof testSetup.loginSteps === 'function') {
+    return await testSetup.loginSteps(pageDetail);
+  } else {
+    await page.goto(process.env.domain);
+  }
+}
+async function performDefaultPageSteps(testInfo) {
+  if (testSetup.page && typeof testSetup.page === 'function') {
+    await testSetup.page(testInfo);
+  }
+}
+async function verifyPageIsLoaded(testInfo) {
+  if (testSetup.validateLogin && typeof testSetup.validateLogin === 'function') {
+    return await testSetup.validateLogin(testInfo);
+  }
+  return true;
+}
+async function executeDefaultLoginSteps(context, testInfo, testDetails, testPortalDetails) {
+  if (!isAuthMode) {
+    return;
+  }
+  try {
+    const projectName = testInfo.project.name;
+    if (testPortalDetails && projectName !== 'setup' && projectName !== 'cleanup') {
+      await context.clearCookies();
+      await (0, _auth.performLoginSteps)(testDetails, async testInfo => {
+        return await verifyPageIsLoaded(testInfo);
+      }, loginSteps);
+      process.env.actorInfo = JSON.stringify(testPortalDetails);
+    }
+  } catch (error) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error while executing the default login steps:', error);
+  }
+}

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

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extractTagInfo = extractTagInfo;
+exports.getCustomAccountDetails = getCustomAccountDetails;
+var _auth = require("../helpers/auth");
+var _logger = require("../../../utils/logger");
+/* eslint-disable global-require */
+
+function getTagInputFromSelectedTags(tags, inputString) {
+  const selectedTag = [...tags].reverse().find(tag => tag.startsWith(inputString));
+  let tagInput = null;
+  if (selectedTag) {
+    tagInput = selectedTag.split(`${inputString}_`).pop().toLowerCase();
+  }
+  return tagInput;
+}
+function extractTagInfo(tags) {
+  const tagsTobeFiltered = ['@profile', '@edition', '@beta', '@portal'];
+  const filteredTags = tags.filter(tag => tagsTobeFiltered.some(prefix => tag.startsWith(prefix)));
+  if (!filteredTags.length) {
+    return {
+      portalInfo: null,
+      betaFeature: null,
+      profileInfo: null,
+      editionInfo: null
+    };
+  }
+  const portalInfo = getTagInputFromSelectedTags(filteredTags, '@portal');
+  const betaFeature = getTagInputFromSelectedTags(filteredTags, '@beta');
+  const profileInfo = getTagInputFromSelectedTags(filteredTags, '@profile');
+  const editionInfo = getTagInputFromSelectedTags(filteredTags, '@edition');
+  return {
+    portalInfo,
+    betaFeature,
+    profileInfo,
+    editionInfo
+  };
+}
+function getCustomAccountDetails(tags) {
+  try {
+    const {
+      portalInfo,
+      betaFeature,
+      profileInfo,
+      editionInfo
+    } = extractTagInfo(tags);
+    if (portalInfo || betaFeature || profileInfo || editionInfo) {
+      const user = (0, _auth.getUserForSelectedEditionAndProfile)(editionInfo, profileInfo, betaFeature, portalInfo);
+      return user;
+    }
+    return (0, _auth.getDefaultActor)();
+  } catch (err) {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Error while getting accounts details:', err);
+  }
+}

package/build/core/playwright/runner/SpawnRunner.js

@@ -8,6 +8,7 @@ var _logger = require("../../../utils/logger");
 var _child_process = require("child_process");
 var _RunnerHelper = _interopRequireDefault(require("./RunnerHelper"));
 var _Runner = _interopRequireDefault(require("./Runner"));
+var _commonUtils = require("../../../utils/commonUtils");
 class SpawnRunner extends _Runner.default {
   constructor(runnerObj) {
     super(runnerObj);
@@ -30,6 +31,8 @@ class SpawnRunner extends _Runner.default {
     });
   }
   runPreprocessing() {
+    //This below functoin is called to copy the data generator spec files to the current project
+    (0, _commonUtils.copyCommonSpecs)();
     const {
       tagArgs
     } = this.runnerObj;

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

@@ -44,12 +44,6 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, {
   outputDir: _path.default.join(process.cwd(), 'uat', '.features-gen'),
   uatPath: _path.default.join(process.cwd(), 'uat')
 });
-const smokeTestDir = (0, _configUtils.getTestDir)(bddMode, {
-  featureFilesFolder: _path.default.join(process.cwd(), 'uat', 'smokeTest', '**', '*.feature'),
-  stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', 'smokeTest', '**', '*smokeTest.spec.js'),
-  outputDir: _path.default.join(process.cwd(), 'uat', '.features-smoke-gen'),
-  uatPath: _path.default.join(process.cwd(), 'uat')
-});
 const use = {
   trace,
   video,
@@ -77,14 +71,24 @@ function getPlaywrightConfig() {
     storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
   };
   const dependencies = isAuthMode ? ['setup'] : [];
-  const smokeTestProject = {
-    name: 'smokeTest',
-    testDir: smokeTestDir,
-    use: {
-      ...commonConfig
-    },
-    dependencies: dependencies
-  };
+  const smokeTestProject = isSmokeTest ? smokeTestConfig() : [];
+  function smokeTestConfig() {
+    const smokeTestDir = (0, _configUtils.getTestDir)(bddMode, {
+      featureFilesFolder: _path.default.join(process.cwd(), 'uat', 'smokeTest', '**', '*.feature'),
+      stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
+      outputDir: _path.default.join(process.cwd(), 'uat', '.features-smoke-gen'),
+      uatPath: _path.default.join(process.cwd(), 'uat', 'smokeTest')
+    });
+    return [{
+      name: 'smokeTest',
+      testDir: smokeTestDir,
+      use: {
+        ...commonConfig
+      },
+      dependencies: dependencies,
+      retries: 0
+    }];
+  }
   const playwrightConfig = {
     testDir,
     globalTimeout: globalTimeout || 3600000,
@@ -101,11 +105,11 @@ function getPlaywrightConfig() {
       testMatch: /.*\.setup\.js/,
       testDir: _path.default.join(process.cwd(), 'uat'),
       teardown: 'cleanup'
-    }, ...(isSmokeTest ? [smokeTestProject] : []), {
+    }, ...smokeTestProject, {
       name: 'cleanup',
       testMatch: /.*\.teardown\.js/,
       testDir: _path.default.join(process.cwd(), 'uat')
-    }, ...projects] : [...projects, ...(isSmokeTest ? [smokeTestProject] : [])],
+    }, ...projects] : [...projects, ...smokeTestProject],
     ...uatConfig
   };
   return playwrightConfig;

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

@@ -153,7 +153,7 @@ function getPathsForFeatureFiles(cwd) {
     let moduleList = modules.split(',');
     return getModulePathForFeatureFiles(moduleList);
   }
-  return [_path.default.join(cwd, 'uat', '**', '*.feature')];
+  return [_path.default.join(cwd, 'uat', 'modules', '**', '*.feature')];
 }
 function getModulePathForFeatureFiles(moduleList) {
   let validModuleList = [];
@@ -162,9 +162,8 @@ function getModulePathForFeatureFiles(moduleList) {
     if ((0, _fileUtils.checkIfFolderExistsWithPattern)(modulePath)) {
       validModuleList.push(_path.default.join(modulePath, '**', '*.feature'));
     } else {
-      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Module ${moduleName} does not exist, Please check the module name`);
       validModuleList = [];
-      return validModuleList;
+      throw new Error(`Module ${moduleName} does not exist. We have not triggered the execution for this module`);
     }
   });
   return validModuleList;

package/build/core/playwright/setup/qc-custom-reporter.js

@@ -102,6 +102,7 @@ const createSpecEntry = (rootDir, test, testResultsById) => ({
   ...(test.location && {
     snippet: formSnippet(test.location)
   }),
+  tags: test.tags,
   tests: [extractTestDetails(test, testResultsById)]
 });
 const extractTestDetails = (test, testResultsById) => {
@@ -112,7 +113,6 @@ const extractTestDetails = (test, testResultsById) => {
     expectedStatus: test.expectedStatus,
     timeout: test.timeout,
     retries: test.retries,
-    tags: test.tags,
     results: testResultsById.get(key) ?? [],
     status: test.outcome()
   };

package/build/core/playwright/test-runner.js

@@ -105,7 +105,7 @@ function main() {
   //This is only used for pass the user arguments to need places in legacy code. We need to rewamp that also.
   const userArgsObject = userArgConfig.getAll();
   const tagProcessor = new _tagProcessor.default(editionOrder);
-  const tagArgs = tagProcessor.processTags(userArgsObject);
+  const tagArgs = tagProcessor.processTags(uatConfig.getAll());
   const runnerObj = new _Runner.default();
   runnerObj.setTagArgs(tagArgs);
   runnerObj.setUserArgs(userArgsObject);

package/build/setup-folder-structure/samples/settings.json

@@ -2,6 +2,6 @@
   "environment": "dev",
   "edition": "enterprise",
   "profile": "admin",
-  "domain": "https://zdesk-devops16.csez.zohocorpin.com:31025/agent",
+  "domain": "https://zdesk-devops25.csez.zohocorpin.com:31037/agent",
   "devUrl" : "" 
 }

package/build/test/core/playwright/buildInFixtures/__tests__/executionContext.test.js

@@ -1,27 +1,27 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _page = require("../../../../../core/playwright/builtInFixtures/page");
+var _customFixturesHelper = require("../../../../../core/playwright/helpers/customFixturesHelper");
 var _executionContext = _interopRequireDefault(require("../../../../../core/playwright/builtInFixtures/executionContext"));
-jest.mock('../../../../../core/playwright/builtInFixtures/page');
+jest.mock('../../../../../core/playwright/helpers/customFixturesHelper');
 describe('executionContext', () => {
   test('should pass actorInfo with details from getCustomAccountDetails to use', async () => {
     const mockTags = ['tag1', 'tag2'];
-    const mockActorInfo = {
+    const mockMainActorInfo = {
       id: '1',
       edition: 'enterprise',
       orgName: 'orgName',
       profile: 'admin',
       email: 'xxx.x+uat@zohotest.com'
     };
-    _page.getCustomAccountDetails.mockReturnValue(mockActorInfo);
+    _customFixturesHelper.getCustomAccountDetails.mockReturnValue(mockMainActorInfo);
     const use = jest.fn();
     await _executionContext.default.executionContext({
       $tags: mockTags
     }, use);
-    expect(_page.getCustomAccountDetails).toHaveBeenCalledWith(mockTags);
+    expect(_customFixturesHelper.getCustomAccountDetails).toHaveBeenCalledWith(mockTags);
     expect(use).toHaveBeenCalledWith({
-      actorInfo: mockActorInfo
+      actorInfo: mockMainActorInfo
     });
   });
 });

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

@@ -0,0 +1,45 @@
+"use strict";
+
+var _additionalProfiles = require("../../../../../core/playwright/helpers/additionalProfiles");
+jest.mock('../../../../../core/playwright/helpers/auth/getUsers', () => ({
+  getUserForSelectedEditionAndProfile: jest.fn((edition, profile, betaFeature, portalInfo) => {
+    return {
+      email: 'manager.m@zohotest.com',
+      id: '1',
+      edition: edition || 'enterprise',
+      orgName: 'orgName',
+      profile: profile || 'admin',
+      betaFeature: betaFeature || null,
+      portalInfo: portalInfo || null
+    };
+  })
+}));
+const defaultTags = ['@profile_admin', '@edition_enterprise'];
+const editionTags = ['@profile_admin', '@edition_enterprise', '@additional_profile_manager', '@additional_profile_agent'];
+const editionAndPortalTags = ['@profile_admin', '@edition_enterprise', '@beta_parentchild', '@portal_clientuat2', '@additional_profile_manager'];
+describe('additionalProfiles', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  test('should return empty object when no additional profile tags are present', () => {
+    const result = (0, _additionalProfiles.additionProfiles)(defaultTags);
+    expect(result).toEqual({});
+  });
+  test('should return additional profile actors when additional profile tags and editionInfo are present', () => {
+    const result = (0, _additionalProfiles.additionProfiles)(editionTags);
+    expect(Object.keys(result)).toEqual(['manager', 'agent']);
+    expect(result.manager).toHaveProperty('email');
+    expect(result.agent).toHaveProperty('email');
+    expect(result.manager.profile).toBe('manager');
+    expect(result.manager.betaFeature).toBe(null);
+    expect(result.agent.portalInfo).toBe(null);
+  });
+  test('should return additional profile actors when all actor details are present', () => {
+    const result = (0, _additionalProfiles.additionProfiles)(editionAndPortalTags);
+    expect(Object.keys(result)).toEqual(['manager']);
+    expect(result.manager).toHaveProperty('email');
+    expect(result.manager.profile).toBe('manager');
+    expect(result.manager.betaFeature).toBe("parentchild");
+    expect(result.manager.portalInfo).toBe("clientuat2");
+  });
+});

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

@@ -0,0 +1,51 @@
+"use strict";
+
+var _customFixturesHelper = require("../../../../../core/playwright/helpers/customFixturesHelper");
+var _logger = require("../../../../../utils/logger");
+var _getUsers = require("../../../../../core/playwright/helpers/auth/getUsers");
+jest.mock('../../../../../core/playwright/helpers/auth/getUsers', () => ({
+  getUserForSelectedEditionAndProfile: jest.fn((edition, profile, betaFeature, portalInfo) => ({
+    email: 'manager.m@zohotest.com',
+    id: '1',
+    edition: edition || 'enterprise',
+    orgName: 'orgName',
+    profile: profile || 'admin',
+    betaFeature: betaFeature || null,
+    portalInfo: portalInfo || null
+  })),
+  getDefaultActor: jest.fn(() => ({
+    edition: 'enterprise',
+    profile: 'admin'
+  }))
+}));
+jest.mock('../../../../../utils/logger', () => ({
+  Logger: {
+    log: jest.fn(),
+    FAILURE_TYPE: 'FAILURE'
+  }
+}));
+const mockTags = ['@profile_admin', '@edition_enterprise', '@beta_feature', '@portal_clientuat'];
+describe('getCustomAccountDetails', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  test('returns selected user when any tag info is present', () => {
+    const result = (0, _customFixturesHelper.getCustomAccountDetails)(mockTags);
+    expect(_getUsers.getUserForSelectedEditionAndProfile).toHaveBeenCalledWith('enterprise', 'admin', 'feature', 'clientuat');
+    expect(result).toHaveProperty('email', 'manager.m@zohotest.com');
+  });
+  test('logs and returns undefined if getCustomAccountDetails function throws', () => {
+    const error = new Error('failed to get user');
+    _getUsers.getUserForSelectedEditionAndProfile.mockImplementation(() => {
+      throw error;
+    });
+    const result = (0, _customFixturesHelper.getCustomAccountDetails)(mockTags);
+    expect(_logger.Logger.log).toHaveBeenCalledWith(_logger.Logger.FAILURE_TYPE, 'Error while getting accounts details:', error);
+    expect(result).toBeUndefined();
+  });
+  test('returns default actor when no tag info is not provided', () => {
+    const result = (0, _customFixturesHelper.getCustomAccountDetails)([]);
+    expect(_getUsers.getDefaultActor).toHaveBeenCalledTimes(1);
+    expect(result).toEqual((0, _getUsers.getDefaultActor)());
+  });
+});

package/build/utils/commonUtils.js

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.copyCommonSpecs = copyCommonSpecs;
+var _fileUtils = require("./fileUtils");
+var _path = _interopRequireDefault(require("path"));
+function copyCommonSpecs() {
+  const libraryPath = require.resolve("@zohodesk/testinglibrary");
+  // libraryPath will be build/index.js to go to the common specs we need to go one level up
+  const commonSpecPath = _path.default.resolve(libraryPath, '../', 'common');
+  const destDirectory = _path.default.resolve(process.cwd(), 'uat', 'modules', '.testingLib-common');
+  (0, _fileUtils.deleteFolder)(destDirectory);
+  (0, _fileUtils.copyDirectory)(commonSpecPath, destDirectory);
+}

package/build/utils/fileUtils.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.checkIfFileExists = checkIfFileExists;
 exports.checkIfFolderExistsWithPattern = checkIfFolderExistsWithPattern;
+exports.copyDirectory = copyDirectory;
 exports.deleteFile = deleteFile;
 exports.deleteFolder = deleteFolder;
 exports.readFileContents = readFileContents;
@@ -86,4 +87,23 @@ function checkIfFolderExistsWithPattern(folderPath) {
     _logger.Logger.error(err);
     return false;
   }
+}
+function copyDirectory(src, dest) {
+  if (!_fs.default.existsSync(dest)) {
+    _fs.default.mkdirSync(dest, {
+      recursive: true
+    });
+  }
+  const entries = _fs.default.readdirSync(src, {
+    withFileTypes: true
+  });
+  for (const entry of entries) {
+    const srcPath = _path.default.join(src, entry.name);
+    const destPath = _path.default.join(dest, entry.name);
+    if (entry.isDirectory()) {
+      copyDirectory(srcPath, destPath);
+    } else {
+      _fs.default.copyFileSync(srcPath, destPath);
+    }
+  }
 }

package/build/utils/logger.js

@@ -4,35 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.Logger = void 0;
-// const SUCCESS_TYPE = 'success';
-// const FAILURE_TYPE = 'failure';
-// const INFO_TYPE = 'info';
-
-// function logger() {
-//   this.colors = {
-//     'success': ['\x1b[36m', '\x1b[0m'],
-//     'failure': ['\x1b[31m', '\x1b[0m'],
-//     'info': ['\x1b[33m', '\x1b[0m']
-//   }
-//   this.consoleLogger = console;
-//   return {
-//     SUCCESS_TYPE,
-//     FAILURE_TYPE,
-//     INFO_TYPE,
-//     error: () => { },
-//     info: () => { },
-//     log: (type, message) => {
-//       const color = this.colors[type];
-//       console.log(type, color)
-//       this.consoleLogger.log(`${color[0]}${message}${color[1]}`)
-//     }
-//   }
-// }
-
-// module.exports = {
-//   Logger: logger()
-// }
-
 class LoggerImpl {
   constructor() {
     this.SUCCESS_TYPE = 'success';