core/tests/protractor-browserstack.conf.js - develop - githubmirror/oppia

core/tests/protractor-browserstack.conf.js
230 строк8 KB
Nikita Vorobev
Apply prettier 2 (#19862)
12 мар 2024, 19:39
12 мар 2024, 19:392ae9b98
// Copyright 2018 The Oppia Authors. All Rights Reserved.
//
// 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.

/**
 * @fileoverview Protractor configuration to run tests on Browserstack.
 */

var browserstack = require('browserstack-local');

// A reference configuration file.
exports.config = {
  // ----- How to setup Selenium -----
  //
  // There are three ways to specify how to use Selenium. Specify one of the
  // following:
  //
  // 1. seleniumServerJar - to start Selenium Standalone locally.
  // 2. seleniumAddress - to connect to a Selenium server which is already
  //    running.
  // 3. sauceUser/sauceKey - to use remote Selenium servers via SauceLabs.
  //
  // If the chromeOnly option is specified, no Selenium server will be started,
  // and chromeDriver will be used directly (from the location specified in
  // chromeDriver).

  // The location of the selenium standalone server .jar file, relative
  // to the location of this config. If no other method of starting selenium
  // is found, this will default to
  // node_modules/protractor/selenium/selenium-server...
  seleniumServerJar: null,
  // The port to start the selenium server on, or null if the server should
  // find its own unused port.
  seleniumPort: null,
  // Chromedriver location is used to help the selenium standalone server
  // find chromedriver. This will be passed to the selenium jar as
  // the system property webdriver.chrome.driver. If null, selenium will
  // attempt to find chromedriver using PATH.
  chromeDriver: './selenium/chromedriver',
  // If true, only chromedriver will be started, not a standalone selenium.
  // Tests for browsers other than chrome will not run.
  chromeOnly: false,
  // Additional command line options to pass to selenium. For example,
  // if you need to change the browser timeout, use
  // seleniumArgs: ['-browserTimeout=60'],
  seleniumArgs: [],

  // If sauceUser and sauceKey are specified, seleniumServerJar will be ignored.
  // The tests will be run remotely using SauceLabs.
  sauceUser: null,
  sauceKey: null,

  // The address of a running selenium server. If specified, Protractor will
  // connect to an already running instance of selenium. This usually looks like
  // seleniumAddress: 'http://localhost:4444/wd/hub'
  seleniumAddress: 'http://hub-cloud.browserstack.com/wd/hub',

  // The timeout for each script run on the browser. This should be longer
  // than the maximum time your application needs to stabilize between tasks.
  // (Note that the hint tooltip has a 60-second timeout.).
  allScriptsTimeout: 180000,

  // ----- What tests to run -----
  //
  // When run without a command line parameter, all suites will run. If run
  // with --suite=smoke, only the patterns matched by that suite will run.
  suites: {
    // When running the tests on browserstack, all suites should be added
    // in 'full' individually. This is to parallelize the suites on
    // browserstack.
    full: [
      'protractor/accessibility.js',
      'protractor/learnerFlow.js',
      'protractor/libraryFlow.js',
      'protractor_mobile/navigation.js',
      'protractor/profileMenuFlow.js',
      'protractor/subscriptionsFlow.js',
    ],

    accessibility: ['protractor/accessibility.js'],

    learner: ['protractor/learnerFlow.js'],

    library: ['protractor/libraryFlow.js'],

    navigation: ['protractor_mobile/navigation.js'],

    profileMenu: ['protractor/profileMenuFlow.js'],

    subscriptions: ['protractor/subscriptionsFlow.js'],
  },

  // ----- Capabilities to be passed to the webdriver instance ----
  //
  // For a full list of available capabilities, see
  // https://code.google.com/p/selenium/wiki/DesiredCapabilities
  // and
  // https://code.google.com/p/selenium/source/browse/javascript/webdriver/capabilities.js
  capabilities: {
    'browserstack.user': process.env.USERNAME,
    'browserstack.key': process.env.ACCESS_KEY,
    'browserstack.local': true,
    'browserstack.localIdentifier': process.env.BROWSERSTACK_LOCAL_IDENTIFIER,
    'browserstack.debug': true,
    'browserstack.networkLogs': true,
    'browserstack.appium_version': '1.7.2',
    device: process.env.DEVICE,
    os_version: process.env.OS_VERSION,
    real_mobile: 'true',
    browserName: '',
  },

  // Code to start browserstack local before start of test.
  beforeLaunch: function () {
    var checkSuites = function () {
      // eslint-disable-next-line no-console
      console.log(
        'Checking whether the suites in "full" match the actual suites...'
      );
      var suitesInFull = exports.config.suites.full;
      var allSuiteGroups = Object.keys(exports.config.suites);
      for (var suiteIndex in allSuiteGroups) {
        if (allSuiteGroups[suiteIndex] === 'full') {
          continue;
        }
        var suiteGroup = allSuiteGroups[suiteIndex];
        // The suiteFile is the first element of each suiteGroup array.
        var suiteFile = exports.config.suites[suiteGroup][0];
        if (!suitesInFull.includes(suiteFile)) {
          // eslint-disable-next-line no-console
          console.log(
            'Expected test file ' +
              suiteFile +
              ' to be in "full" ' +
              'but it was not present.'
          );
          process.exit(1);
        }
      }
    };
    checkSuites();
    // eslint-disable-next-line no-console
    console.log('Connecting browserstack local');
    return new Promise(function (resolve, reject) {
      exports.bs_local = new browserstack.Local();
      exports.bs_local.start(
        {
          key: exports.config.capabilities['browserstack.key'],
          forceLocal: true,
        },
        function (error) {
          if (error) {
            return reject(error);
          }
          // eslint-disable-next-line no-console
          console.log('Connected. Now testing...');

          resolve();
        }
      );
    });
  },

  // Code to stop browserstack local after end of test.
  afterLaunch: function () {
    return new Promise(function (resolve, reject) {
      exports.bs_local.stop(resolve);
    });
  },

  // If you would like to run more than one instance of webdriver on the same
  // tests, use multiCapabilities, which takes an array of capabilities.
  // If this is specified, capabilities will be ignored.
  multiCapabilities: [],

  // ----- More information for your tests ----
  //
  // A base URL for your application under test. Calls to protractor.get()
  // with relative paths will be prepended with this.
  baseUrl: 'http://localhost:8181',

  // Selector for the element housing the angular app - this defaults to
  // body, but is necessary if ng-app is on a descendant of <body>.
  rootElement: 'body',

  onPrepare: function () {
    browser.isMobile = true;

    var SpecReporter = require('jasmine-spec-reporter').SpecReporter;
    jasmine.getEnv().addReporter(
      new SpecReporter({
        displayStacktrace: 'pretty',
        displaySpecDuration: true,
      })
    );
  },

  // ----- The test framework -----
  //
  // Jasmine and Cucumber are fully supported as a test and assertion framework.
  // Mocha has limited beta support. You will need to include your own
  // assertion framework if working with mocha.
  framework: 'jasmine2',

  // ----- Options to be passed to minijasminenode -----
  //
  // See the full list at https://github.com/juliemr/minijasminenode
  jasmineNodeOpts: {
    // The onComplete method will be called just before the driver quits.
    onComplete: null,
    // If true, display spec names.
    isVerbose: false,
    // If true, print colors to the terminal.
    showColors: true,
    // If true, include stack traces in failures.
    includeStackTrace: true,
    // Default time to wait in ms before a test fails.
    defaultTimeoutInterval: 1200000,
  },
};