Skip to content

build: run chrome and firefox headless tests in circleci #13603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2018
Merged

build: run chrome and firefox headless tests in circleci #13603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Configuration file for https://circleci.com/gh/angular/material2

#
# Note: YAML anchors allow an object to be re-used, reducing duplication.
# The ampersand declares an alias for an object, then later the `<<: *name`
# syntax dereferences it.
Expand Down Expand Up @@ -81,6 +80,30 @@ jobs:

- *save_cache

# ------------------------------------------------------------------------------------------
# Job that runs the unit tests on locally installed browsers (Chrome and Firefox headless).
# The available browsers are installed through the angular/ngcontainer Docker image.
# ------------------------------------------------------------------------------------------
tests_local_browsers:
docker:
# TODO(devversion): Temporarily use a image that includes Firefox 62 because the
# ngcontainer image does include an old Firefox version that does not support headless.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you / can you file an issue for this and reference it here?

Copy link
Member Author

@devversion devversion Oct 15, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually filed a PR and chatted with Alex about it. Added the URL of the PR to the comment

# See the PR that fixes this: https://github.com/angular/angular/pull/26435
- image: circleci/node:10.12-browsers
resource_class: xlarge
environment:
TEST_PLATFORM: local
steps:
- *checkout_code
- *restore_cache
- *yarn_install

# Launches the unit tests. The platform is determined by the "TEST_PLATFORM" environment
# variable which has been configured above
- run: yarn gulp ci:test

- *save_cache

# ----------------------------------
# Lint job. Runs the gulp lint task.
# ----------------------------------
Expand All @@ -91,7 +114,7 @@ jobs:
- *restore_cache
- *yarn_install

- run: yarn ci:lint
- run: yarn gulp ci:lint

- *save_cache

Expand All @@ -108,6 +131,10 @@ workflows:
jobs:
- bazel_build_test

unit_tests:
jobs:
- tests_local_browsers

# Lint workflow. As we want to lint in one job, this is a workflow with just one job.
lint:
jobs:
Expand Down
1 change: 0 additions & 1 deletion .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ jobs:
- env: "MODE=e2e"
- env: "MODE=saucelabs_required"
- env: "MODE=browserstack_required"
- env: "MODE=travis_required"
- env: "DEPLOY_MODE=build-artifacts"
if: type = push
- env: "DEPLOY_MODE=docs-content"
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"docs": "gulp docs",
"api": "gulp api-docs",
"breaking-changes": "gulp breaking-changes",
"ci:lint": "gulp ci:lint"
"gulp": "gulp"
},
"version": "7.0.0-rc.1",
"requiredAngularVersion": ">=7.0.0-rc.0",
Expand Down
85 changes: 41 additions & 44 deletions test/browser-providers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,67 +2,64 @@

/*
* Browser Configuration for the different jobs in the CI.
* Target can be either: BS (Browserstack) | SL (Saucelabs) | TC (Travis CI) | null (To not run)
*
* - local: Launches the browser locally on the current operating system.
* - BS: Launches the browser within BrowserStack
* - SL: Launches the browser within Saucelabs
*
* TODO(devversion): rename this to "browserstack" and "saucelabs".
*/
const browserConfig = {
'ChromeHeadlessCI': { unitTest: {target: 'TC', required: true }},
'FirefoxHeadless': { unitTest: {target: 'TC', required: true }},
'ChromeBeta': { unitTest: {target: null, required: false }},
'FirefoxBeta': { unitTest: {target: null, required: false }},
'ChromeDev': { unitTest: {target: null, required: false }},
'FirefoxDev': { unitTest: {target: null, required: false }},
'IE9': { unitTest: {target: null, required: false }},
'IE10': { unitTest: {target: null, required: false }},
'IE11': { unitTest: {target: null, required: false }},
'Edge': { unitTest: {target: 'BS', required: true }},
'Android4.1': { unitTest: {target: null, required: false }},
'Android4.2': { unitTest: {target: null, required: false }},
'Android4.3': { unitTest: {target: null, required: false }},
'Android4.4': { unitTest: {target: null, required: false }},
'Android5': { unitTest: {target: null, required: false }},
'Safari7': { unitTest: {target: null, required: false }},
'Safari8': { unitTest: {target: null, required: false }},
'Safari9': { unitTest: {target: null, required: false }},
'Safari10': { unitTest: {target: 'BS', required: true }},
'iOS7': { unitTest: {target: null, required: false }},
'iOS8': { unitTest: {target: null, required: false }},
'iOS9': { unitTest: {target: null, required: false }},
'iOS10': { unitTest: {target: null, required: false }},
'ChromeHeadlessCI': { unitTest: {target: 'local', }},
'FirefoxHeadless': { unitTest: {target: 'local', }},
'ChromeBeta': { unitTest: {target: null, }},
'FirefoxBeta': { unitTest: {target: null, }},
'ChromeDev': { unitTest: {target: null, }},
'FirefoxDev': { unitTest: {target: null, }},
'IE9': { unitTest: {target: null, }},
'IE10': { unitTest: {target: null, }},
'IE11': { unitTest: {target: null, }},
'Edge': { unitTest: {target: 'BS', }},
'Android4.1': { unitTest: {target: null, }},
'Android4.2': { unitTest: {target: null, }},
'Android4.3': { unitTest: {target: null, }},
'Android4.4': { unitTest: {target: null, }},
'Android5': { unitTest: {target: null, }},
'Safari7': { unitTest: {target: null, }},
'Safari8': { unitTest: {target: null, }},
'Safari9': { unitTest: {target: null, }},
'Safari10': { unitTest: {target: 'BS', }},
'iOS7': { unitTest: {target: null, }},
'iOS8': { unitTest: {target: null, }},
'iOS9': { unitTest: {target: null, }},
'iOS10': { unitTest: {target: null, }},
// Don't use Browserstack until our open-source license includes automate testing on
// mobile devices. For now, we need to use Saucelabs to keep our coverage.
'iOS11': { unitTest: {target: 'SL', required: true }},
'WindowsPhone': { unitTest: {target: null, required: false }}
'iOS11': { unitTest: {target: 'SL', }},
'WindowsPhone': { unitTest: {target: null, }}
};

/** Exports all available remote browsers. */
exports.customLaunchers = require('./remote_browsers.json');

/** Exports a map of configured browsers, which should run on the CI. */
/** Exports a map of configured browsers, which should run in the given platform. */
exports.platformMap = {
'saucelabs': {
required: buildConfiguration('unitTest', 'SL', true),
optional: buildConfiguration('unitTest', 'SL', false)
},
'browserstack': {
required: buildConfiguration('unitTest', 'BS', true),
optional: buildConfiguration('unitTest', 'BS', false)
},
'travis': {
required: buildConfiguration('unitTest', 'TC', true),
optional: buildConfiguration('unitTest', 'TC', false)
}
'saucelabs': buildConfiguration('unitTest', 'SL'),
'browserstack': buildConfiguration('unitTest', 'BS'),
'local': buildConfiguration('unitTest', 'local'),
};

/** Build a list of configuration (custom launcher names). */
function buildConfiguration(type, target, required) {
function buildConfiguration(type, target) {
const targetBrowsers = Object.keys(browserConfig)
.map(browserName => [browserName, browserConfig[browserName][type]])
.filter(([, config]) => config.required === required && config.target === target)
.filter(([, config]) => config.target === target)
.map(([browserName]) => browserName);

// For browsers that run on Travis CI the browser name shouldn't be prefixed with the shortcut
// of Travis. The different Karma launchers only work with the plain browser name (e.g Firefox)
if (target === 'TC') {
// For browsers that run locally, the browser name shouldn't be prefixed with the target
// platform. We only prefix the external platforms in order to distinguish between
// local and remote browsers in our "customLaunchers" for Karma.
if (target === 'local') {
return targetBrowsers;
}

Expand Down
9 changes: 7 additions & 2 deletions test/karma.conf.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@ module.exports = (config) => {
},
});

if (process.env['CIRCLECI']) {
config.browsers = platformMap[process.env['TEST_PLATFORM']];
}

if (process.env['TRAVIS']) {
const buildId = `TRAVIS #${process.env.TRAVIS_BUILD_NUMBER} (${process.env.TRAVIS_BUILD_ID})`;

Expand All @@ -114,7 +118,8 @@ module.exports = (config) => {
// It will look like <platform>_<target>, where platform is one of 'saucelabs', 'browserstack'
// or 'travis'. The target is a reference to different collections of browsers that can run
// in the previously specified platform.
const [platform, target] = process.env.MODE.split('_');
// TODO(devversion): when moving Saucelabs and Browserstack to Circle, remove the target part.
const [platform] = process.env.MODE.split('_');

if (platform === 'saucelabs') {
config.sauceLabs.build = buildId;
Expand All @@ -132,6 +137,6 @@ module.exports = (config) => {
config.concurrency = 1;
}

config.browsers = platformMap[platform][target.toLowerCase()];
config.browsers = platformMap[platform];
}
};