qape/lib/shared/config/template.js

Monkey testing library

"use strict";

module.exports = {
  parallelInstances: {
    value: 1,
    description: 'Number of parallel chrome instances initialized',
    type: 'number'
  },
  stopNewScenariosAfterTime: {
    value: 10000,
    description: 'Time in ms, after which no more scenarios will be initialized, set to 0 to run forever',
    type: 'number'
  },
  actionsPerScenario: {
    value: 100,
    description: 'Maximal number of actions performed in a random scenario (if error occures, the scenario is ended)',
    type: 'number'
  },
  afterActionWaitTime: {
    value: 500,
    description: 'Wait time after each action, there should be some delay so the javascript at your website is executed and an error is displayed before performing another action. ',
    type: 'number'
  },
  numberOfActionFailuresToAbortRandomScenario: {
    value: 20,
    description: 'Number of execution errors of actions to abort the random scenario. This prevents from infinity loops, when qape is not able to perform any action on the page and keeps retrying.',
    type: 'number'
  },
  url: {
    value: 'http://localhost:4444',
    description: 'Starting url for all random scenarios',
    type: 'string'
  },
  urlPaths: {
    value: ['/'],
    description: 'List of start url paths for random scenarios',
    type: 'string[]'
  },
  numberOfAllowedActionsToReproduceErrorFromPreviousRun: {
    value: 20,
    description: 'After an error occured, qape will try to reproduce the error again and will retry up to this number of actions before giving up.',
    type: 'number'
  },
  randomScenariosDisabled: {
    value: false,
    description: 'Disables random scenarios, only user defined scenarios will be executed',
    type: 'boolean'
  },
  minifyUserDefinedScenarios: {
    value: true,
    description: 'When user defined scenario recieves an error, it will try to minify the steps to reproduce this error.',
    type: 'boolean'
  },
  headlessModeDisabled: {
    value: false,
    description: 'Disables chromium headless mode and will display browser GUI.',
    type: 'boolean'
  },
  previewMode: {
    value: false,
    description: 'Preview mode will overwrite other config values to display the scenario on the local computer in non-headless mode. It will also run only user defined scenarios and will not try to minify them.',
    type: 'boolean'
  },
  previewModePauseTime: {
    value: 1500,
    description: 'Wait time (in ms) between actions in preview mode.',
    type: 'number'
  },
  defaultBrowserSettings: {
    value: {
      ignoreHTTPSErrors: true,
      defaultViewport: {
        width: 1280,
        height: 720
      },
      args: ['--start-maximized', '--user-agent=Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36']
    },
    description: 'Default browser settings passed to puppeteer.launch()',
    type: 'Object'
  },
  debug: {
    value: false,
    description: 'Enables debug mode with extra logging',
    type: 'boolean'
  },
  defaultNavigationTimeout: {
    value: 60000,
    description: 'Default navigation timeout set via page.setDefaultNavigationTimeout()',
    type: 'number'
  },
  pageErrorHandler: {
    value: () => {
      window.addEventListener('error', event => {
        qapeError(event.error.stack); // eslint-disable-line no-undef
      });
    },
    description: 'Page error handler, which should tell what is actually an error. Function is evaluated in the browser context via page.evaluateOnNewDocument() and has method "qapeError(error)" available.',
    type: 'Function'
  },
  shouldRequestCauseError: {
    value: (response
    /* , config */
    ) => response.status() >= 500,
    description: 'This method is called whenever any page request recieves a response. It recieves a puppeteer.Response and QApe config as arguments and should return a boolean value. If it returns true, then the recieved request response is considered a page error.',
    type: 'Function'
  },
  beforeScenarioScript: {
    value: () => {},
    description: 'Script executed before each scenario',
    type: 'Function'
  },
  beforeActionScript: {
    value: () => {},
    description: 'Script executed before each action',
    type: 'Function'
  },
  afterActionScript: {
    value: () => {},
    description: 'Script executed after each action',
    type: 'Function'
  },
  afterScenarioScript: {
    value: () => {},
    description: 'Script executed after each scenario',
    type: 'Function'
  },
  getElementSelector: {
    value: input => {
      function getTagSelector(tagName) {
        const tag = tagName.toLowerCase(); // Some tag names cannot be simply selected by xpath

        if (['svg', 'path'].includes(tag)) {
          return `*[local-name() = '${tag}']`;
        }

        return tag;
      }

      function getPathTo(element) {
        if (element === document.body) {
          return '//' + element.tagName.toLowerCase();
        }

        if (!element.parentNode) {
          return '/';
        }

        var siblings = element.parentNode.childNodes;
        var index = 0;

        for (var i = 0; i < siblings.length; i++) {
          var sibling = siblings[i];

          if (sibling === element) {
            return getPathTo(element.parentNode) + '/' + getTagSelector(element.tagName) + '[' + (index + 1) + ']';
          }

          if (sibling.nodeType === 1 && sibling.tagName === element.tagName) {
            index++;
          }
        }
      }

      return getPathTo(input);
    },
    description: 'Script executed in browser context, which should generate unique element selector',
    type: 'Function'
  },
  elementSelector: {
    value: (() => {
      const disables = 'self::script or self::noscript or self::path or self::style';
      return `//body//*[not(${disables}) and not(ancestor::*[${disables}])]`;
    })(),
    description: 'XPath selector to gather all visible elements. There are also some extra filters, which remove elements with children (only elements without children are considered interactable), or zero size elements.',
    type: 'string'
  },
  browserWebSocketEndpoint: {
    value: null,
    description: 'A browser websocket endpoint to connect to (i.e. ws://5.5.5.5:3505)',
    type: 'string'
  },
  reporters: {
    value: ['console', 'file', 'spinner'],
    description: "Define your reporters for the QApe run. You can pass a string for reporters in npm registry, i.e. if you pass 'super', QApe will look for reporter 'qape-reporter-super'. You can also pass Class.",
    type: 'string[]|Class[]'
  },
  reportPath: {
    value: './report',
    description: 'Relative path for the report output',
    type: 'string'
  },
  files: {
    value: [],
    description: 'File paths to regression tests generated by QApe file reporter. Glob patterns are allowed.',
    type: 'string[]'
  },
  testerTimeout: {
    value: 300000,
    description: 'If a tester did not send any message for this period of time, it will be killed and replaced with a new one.',
    type: 'number'
  },
  typeActionTextTypes: {
    value: ['name.firstName', 'name.lastName', 'name.findName', 'name.prefix', 'name.suffix', 'address.zipCode', 'address.city', 'address.cityPrefix', 'address.citySuffix', 'address.streetName', 'address.streetAddress', 'address.streetSuffix', 'address.secondaryAddress', 'address.county', 'address.country', 'address.state', 'address.stateAbbr', 'address.latitude', 'address.longitude', 'phone.phoneNumber', 'phone.phoneNumberFormat', 'phone.phoneFormats', 'internet.avatar', 'internet.email', 'internet.userName', 'internet.domainName', 'internet.domainSuffix', 'internet.domainWord', 'internet.ip', 'internet.userAgent', 'internet.color', 'internet.password', 'company.suffixes', 'company.companyName', 'company.companySuffix', 'company.catchPhrase', 'company.bs', 'company.catchPhraseAdjective', 'company.catchPhraseDescriptor', 'company.catchPhraseNoun', 'company.bsAdjective', 'company.bsBuzz', 'company.bsNoun', 'image.image', 'image.avatar', 'image.imageUrl', 'image.abstract', 'image.animals', 'image.business', 'image.cats', 'image.city', 'image.food', 'image.nightlife', 'image.fashion', 'image.people', 'image.nature', 'image.sports', 'image.technics', 'image.transport', 'lorem.words', 'lorem.sentence', 'lorem.sentences', 'lorem.paragraph', 'lorem.paragraphs', 'helpers.randomNumber', 'helpers.randomize', 'helpers.slugify', 'helpers.replaceSymbolWithNumber', 'helpers.shuffle', 'helpers.mustache', 'helpers.createCard', 'helpers.contextualCard', 'helpers.userCard', 'helpers.createTransaction', 'date.past', 'date.future', 'date.between', 'date.recent', 'random.number', 'random.array_element', 'random.object_element', 'random.uuid', 'finance.account', 'finance.accountName', 'finance.mask', 'finance.amount', 'finance.transactionType', 'finance.currencyCode', 'finance.currencyName', 'finance.currencySymbol', 'hacker.abbreviation', 'hacker.adjective', 'hacker.noun', 'hacker.verb', 'hacker.ingverb', 'hacker.phrase'],
    description: 'Available text types from npm package "faker", which will generate string of the random type from this list.',
    type: 'string[]'
  },
  typeActionDelay: {
    value: 20,
    description: 'Delay between key strokes for type action so it would seem more user-like.',
    type: 'number'
  },
  customActions: {
    value: [],
    description: 'List of paths to your custom actions, you can use glob patterns.',
    type: 'string[]'
  }
};