protractor.conf.ci.js

/*
* Copyright 2018 herd-ui contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const conf = require('./e2e/config/conf.e2e.json');
const { SpecReporter } = require('jasmine-spec-reporter');
const jasmineReporters = require('jasmine-reporters');
const fs = require('fs');
const path = require('path');

const buildTime = Date.now();
const sauceBuild = process.env.JENKINS_BUILD_NUMBER || ('localTestBuildNumber__' + buildTime);
const shardTestFiles = false;
const maxInstances = 1;
const seleniumVersion = '3.4.0';
const tunnelIdentifier = process.env.SCP_TUNNEL;
const screenResolution = '1024x768';
const idleTimeout = 180;

let browsers = [
  {
  idleTimeout,
  screenResolution,
  tunnelIdentifier,
  seleniumVersion: "3.5.0",
  name: "Windows 10 chrome Latest-1",
  platform: "Windows 10",
  browserName: "chrome",
  chromeOptions: {
    prefs: {
      'credentials_enable_service': false,
      'profile': {
        'password_manager_enabled': false
      }
    },
    args: [
      '--disable-cache',
      '--disable-application-cache',
      '--disable-offline-load-stale-cache',
      '--disk-cache-size=0',
      '--v8-cache-options=off'
    ]
  },
  version: "latest-1",
  maxInstances,
  shardTestFiles
}
];
const otherBrowsers = [
  {
    idleTimeout,
    screenResolution,
    tunnelIdentifier,
    seleniumVersion,
    name: "Windows 10 Firefox latest-1",
    platform: "Windows 10",
    browserName: "firefox",
    maxInstances,
    shardTestFiles,
    version: 'latest-1'
  },
  /*
  {
    idleTimeout,
    seleniumVersion,
    screenResolution,
    "name": "macOS 10.12 safari 10.1",
  tunnelIdentifier,
    "platform": "macOS 10.12",
    "browserName": "safari",
    "version": "10.1",
    maxInstances,
    shardTestFiles
  },
  {
    idleTimeout,
    screenResolution,
    tunnelIdentifier,
    iedriverVersion: seleniumVersion,
    'ie.ensureCleanSession': true,
    'ie.enableElementCacheCleanup': true,
    name: "Windows 10 IE 11",
    platform: "Windows 10",
    browserName: "internet explorer",
    version: "11",
    unexpectedAlertBehaviour: "ignore",
    maxInstances,
    shardTestFiles
  }
  */
  {
    idleTimeout,
    screenResolution,
    tunnelIdentifier,
    seleniumVersion: "3.5.0",
    name: "Windows 10 Edge latest",
    platform: "Windows 10",
    version: 'latest',
    browserName: "microsoftedge",
    maxInstances,
    shardTestFiles
  }
];

if ( !process.env.RUN_CHROME_ONLY || process.env.RUN_CHROME_ONLY === 'false' ) {
  browsers = browsers.concat(otherBrowsers);
}

exports.config = {
  SELENIUM_PROMISE_MANAGER: 0,
  sauceProxy: process.env.HTTP_PROXY || process.env.http_proxy || process.env.SAUCE_PROXY,
  sauceUser: conf.sauceUser,
  sauceKey: conf.sauceKey,
  sauceSeleniumUseHttp: true,
  sauceSeleniumAddress: 'localhost:4445/wd/hub',
  sauceBuild,
  multiCapabilities: browsers,
  maxSessions: 10,
  getPageTimeout: 240000,
  allScriptsTimeout: 240000,
  suites: {
    home: './e2e/**/home/**/*.e2e-spec.ts',
    search: './e2e/**/search/**/*.e2e-spec.ts',
    category: './e2e/**/category/**/*.e2e-spec.ts',
    format: './e2e/**/format/**/*.e2e-spec.ts',
    dataEntityOverview: './e2e/**/data-entity/overview/**/*.e2e-spec.ts',
    dataEntitySme: './e2e/**/data-entity/sme/**/*.e2e-spec.ts',
    dataEntitySampleData: './e2e/**/data-entity/sampledata/**/*.e2e-spec.ts',
    dataEntityList: './e2e/**/data-entity/list/**/*.e2e-spec.ts',
    dataEntityColumns: './e2e/**/data-entity/columns/**/*.e2e-spec.ts',
    dataObjectList: './e2e/**/data-objects/list/**/*.e2e-spec.ts',
    dataObjectDetail: './e2e/**/data-objects/detail/*.e2e-spec.ts',
    dataObjectDetailLineage: './e2e/**/data-objects/detail/lineage/**/*.e2e-spec.ts',
    dataObjectDetailStorageUnits: './e2e/**/data-objects/detail/storage-units/**/*.e2e-spec.ts'
  },
  baseUrl: conf.baseUrl8443,
  framework: 'jasmine2',
  jasmineNodeOpts: {
    showColors: true,
    defaultTimeoutInterval: 240000,
    print: function () {
    }
  },
  beforeLaunch() {
    // a file that is watched to see what data needs cleaned up or not while running tests in parallel.
    // delete on every start before tests start so that data will be setup / toredown no matter what.
    if (fs.existsSync('processed.txt')) {
      fs.unlinkSync("processed.txt");
    }
  },
  afterLaunch() {
    require('ts-node').register({
      project: 'e2e/tsconfig.e2e.json'
    });

    // ending properties file with quotes for the proplery converted property of SAUCE_SLACK_URLS
    if (fs.existsSync('urls.txt')) {
      const urls = fs.readFileSync('urls.txt').toString();
      fs.appendFileSync('slack.properties', 'SAUCE_SLACK_URLS="' + urls + '"');
    }

    // tear down all data that was setup.
    const dataManager = require(path.resolve(__dirname + '/e2e/util/DataManager.ts')).DataManager;
    return dataManager.tearDownData();
  },
  onPrepare() {
    let capabilities;

    require('ts-node').register({
      project: 'e2e/tsconfig.e2e.json'
    });

    jasmine.getEnv().addReporter(new SpecReporter({
      spec: { displayStacktrace: true }
    }));

    return browser.getProcessedConfig().then((c) => {
      capabilities = c.capabilities;

      // used to change the namespace for the data.
      process.env.CURRENT_BROWSER = c.capabilities.browserName.replace(new RegExp(' ', 'g'), '-');
      // shorten the browser idetifier for herd requests.
      process.env.CURRENT_BROWSER = process.env.CURRENT_BROWSER.replace('internet-explorer', 'ie');
      process.env.CURRENT_BROWSER = process.env.CURRENT_BROWSER.replace('microsoftedge', 'edge');
      jasmine.getEnv().addReporter(
        new jasmineReporters.JUnitXmlReporter({
          filePrefix: c.capabilities.browserName,
          consolidateAll: true,
          modifySuiteName: function (generatedSuiteName, suite) {
            // this will produce distinct suite names for each capability,
            // e.g. 'firefox.login tests' and 'chrome.login tests'
            return c.capabilities.browserName + '.' + generatedSuiteName;
          }
        })
      );

      // for each browser run, ask that browser's process to try to initialize as much data a possible.
      const dataManager = require(path.resolve(__dirname + '/e2e/util/DataManager.ts')).DataManager;
      return dataManager.initializeData(c.specs);
    });
  },

  onComplete() {
    return browser.getProcessedConfig().then(function (c) {
      return browser.getSession().then(function (session) {
        const authInfo = Buffer(conf.sauceUser + ':' + conf.sauceKey).toString('base64');
        // File writes for reporting to slack with jenkins
        const separator = fs.existsSync('urls.txt') ? '  ' : '';
        const slackUrl = separator + '(' + process.env.CURRENT_BROWSER + ') http://saucelabs.com/tests/' + session.getId();
        fs.appendFileSync('urls.txt', slackUrl);

        // required to be here so saucelabs picks up reports to put in jenkins
        console.log('SauceOnDemandSessionID=' + session.getId() + ' job-name=' + c.capabilities.name);
      });
    });
  }
};