Merge pull request #90 from Financial-Times/maintenance

Maintenance

README.md

@@ -1,5 +1,5 @@
 # n-test
-Runs smoke tests with Puppeteer (and optionally Saucelabs). Define a set of URLs and expected behaviour in JSON, without the toil of writing full blown tests.
+Runs smoke tests with Puppeteer (and optionally Browserstack). Define a set of URLs and expected behaviour in JSON, without the toil of writing full blown tests.
 
 [![CircleCI](https://circleci.com/gh/Financial-Times/n-test.svg?style=svg&circle-token=d042713e08cb5920c4c2b462e63867d4906a7a66)](https://circleci.com/gh/Financial-Times/n-test)
 [![Node.js version support][shield-node]](#)
@@ -228,10 +228,9 @@ smoke.run(['basic']);
 ```
 
 ### Cross Browser Testing [Experimental]
-You can also run your test suite against Browserstack (or Saucelabs).
+You can also run your test suite against Browserstack .
 
 Browserstack: you must have `BROWSERSTACK_USER` and `BROWSERSTACK_KEY` environment variables set, and enable cross browser tests on a suite/url basis.
-Saucelabs: you must have `SAUCE_USER` and `SAUCE_KEY` environment variables set, and enable cross browser tests on a suite/url basis.
 
 *Note* Browserstack supports running off a local host. If your host is local, it will spin up Browserstack Local and proxy through.
 *Caveat* sometimes browserstack local might not clean up properly after itself!

lib/smoke/get-selenium-grid.js → lib/smoke/get-browserstack-config.js

@@ -68,14 +68,6 @@ module.exports = async (browserName, isLocal) => {
 			user: process.env.BROWSERSTACK_USER,
 			key: process.env.BROWSERSTACK_KEY
 		};
-	} else if(process.env.SAUCE_USER && process.env.SAUCE_KEY) {
-		return {
-			desiredCapabilities: { browserName },
-			user: process.env.SAUCE_USER,
-			key: process.env.SAUCE_KEY,
-			host: 'ondemand.saucelabs.com',
-			services: ['sauce']
-		};
 	}
 
 };

lib/smoke/puppeteer-page.js

@@ -62,7 +62,7 @@ class PuppeteerPage {
 			await setSessionCookies(this.page, this.url.toString(), tokens);
 		}
 
-		this.page.setViewport(this.dimensions);
+		await this.page.setViewport(this.dimensions);
 
 
 		if(this.check.cssCoverage) {

lib/smoke/screenshot.js

@@ -8,7 +8,7 @@ const filterConfigs = require('./filter-configs');
 const setupPage = require('./setup-page');
 const PuppeteerPage = require('./puppeteer-page');
 const WebdriverPage = require('./webdriver-page');
-const getSeleniumGrid = require('./get-selenium-grid');
+const getBrowserstackConfig = require('./get-browserstack-config');
 
 const takeScreenshot = (pageOpts, browser, headlessBrowser, viewingBrowser) => async () => {
 	const pageInstance = browser === 'chrome' ? new PuppeteerPage(pageOpts) : new WebdriverPage(pageOpts, browser);
@@ -59,9 +59,9 @@ module.exports = async (globalOpts, sets) => {
 			Object.keys(suiteOpts.urls).forEach(async (path) => {
 				let urlOpts = suiteOpts.urls[path];
 				const pageOpts = setupPage(path, urlOpts, Object.assign({ browsers: true }, suiteOpts), globalOpts);
-				const canRunCrossBrowser = await getSeleniumGrid(this.enabledBrowsers);
+				const canRunCrossBrowser = await getBrowserstackConfig(this.enabledBrowsers);
 				if(pageOpts.browsersToRun.filter(browser => browser.toLowerCase() !== 'chrome').length && !canRunCrossBrowser) {
-					console.warn('Please set environment variables for Browserstack or Saucelabs to run cross browser tests.');
+					console.warn('Please set environment variables for Browserstack to run cross browser tests.');
 					return;
 				}
 
@@ -81,7 +81,7 @@ module.exports = async (globalOpts, sets) => {
 		const cleanup = async (code) => {
 			viewingBrowser && viewingBrowser.close();
 			headlessBrowser && headlessBrowser.close();
-			await getSeleniumGrid.cleanup();
+			await getBrowserstackConfig.cleanup();
 			process.exit(code);
 		};
 

lib/smoke/smoke-test.js

@@ -12,7 +12,7 @@ const setupPage = require('./setup-page');
 const verifyUrl =require('./verify-url');
 const PuppeteerPage = require('./puppeteer-page');
 const WebdriverPage = require('./webdriver-page');
-const getSeleniumGrid = require('./get-selenium-grid');
+const getBrowserstackConfig = require('./get-browserstack-config');
 
 const ERROR_THRESHOLD=2;
 
@@ -49,12 +49,12 @@ class SmokeTest {
 
 	async cleanup () {
 		this.browser && this.browser.close();
-		return await getSeleniumGrid.cleanup();
+		return await getBrowserstackConfig.cleanup();
 	}
 
 	async compileTests (sets) {
 		const configsToRun = await filterConfigs(this.configFile, sets, this.isInteractive);
-		const canRunCrossBrowser = await getSeleniumGrid(this.enabledBrowsers);
+		const canRunCrossBrowser = await getBrowserstackConfig(this.enabledBrowsers);
 		const globalOptions = {
 			headers: this.globalHeaders,
 			browsers: this.browsers,
@@ -80,7 +80,7 @@ class SmokeTest {
 				const pageOptions = setupPage(path, urlOptions, suiteOptions, globalOptions);
 
 				if (pageOptions.browsersToRun.length > 1 && !canRunCrossBrowser) {
-					console.warn('Please set environment variables for Browserstack or Saucelabs to run cross browser tests.');
+					console.warn('Please set BROWSERSTACK_KEY and BROWSERSTACK_USER environment variables to run cross browser tests.');
 				}
 
 				if (suiteOptions.user && !pageOptions.user) {

lib/smoke/webdriver-page.js

@@ -1,5 +1,5 @@
 const webdriverio = require('webdriverio');
-const getSeleniumGrid = require('./get-selenium-grid');
+const getBrowserstackConfig = require('./get-browserstack-config');
 
 
 const DIMENSIONS = require('../helpers/dimensions');
@@ -26,7 +26,7 @@ class WebdriverPage {
 
 	async init () {
 
-		this.browserOptions = await getSeleniumGrid(this.type, this.url.host.startsWith('local'));
+		this.browserOptions = await getBrowserstackConfig(this.type, this.url.host.startsWith('local'));
 		if(!this.browserOptions || //skip if no environment variables
 			this.isAutomatedTest && !(this.check.elements || this.check.screenshot)) {
 			return;

package.json

@@ -29,8 +29,7 @@
         "directly": "^2.0.6",
         "inquirer": "^5.0.1",
         "node-fetch": "^2.1.1",
-        "puppeteer": "1.5.0",
-        "wdio-sauce-service": "^0.4.8",
+        "puppeteer": "^1.8.0",
         "webdriverio": "^4.11.0"
     },
     "devDependencies": {