Add --no-sandbox argument to Puppeteer when metal-a11y is called with --ci-mode

src/axe-driver.js

@@ -91,24 +91,32 @@ function sadPath(axeReport) {
  * Returns the first available port starting from the given number
  * @async
  * @param {number} port
- * @return {number} available port
+ * @return {Promise.<number>} available port
  */
 async function getAvailablePort(port) {
   const availablePort = await detect(port);
   if (availablePort === port) return port;
   return getAvailablePort(availablePort);
 }
 
+/**
+ * @typedef ExecOptions
+ * @prop {string} indexHtml - used to specifiy the demo page of the component
+ * @prop {string} serverPath - document root
+ * @prop {boolean} [verbose]
+ * @prop {boolean} ciMode
+ */
+
 /**
  * Executes the test against the given url that is hosted at the
  * specified document root.
  * @async
- * @param {string} indexHtml - used to specifiy the demo page of the component
- * @param {string} serverPath - document root
- * @param {boolean} verbose
+ * @param {ExecOptions} options
  * @return {Promise}
  */
-async function exec({indexHtml, serverPath, verbose}) {
+async function exec(options) {
+  const {indexHtml, serverPath, verbose, ciMode} = options;
+
   if (!verbose) console.log = () => {};
 
   const port = await getAvailablePort(SERVER_PORT);
@@ -120,7 +128,7 @@ async function exec({indexHtml, serverPath, verbose}) {
   driver.on('exit', server.stop);
 
   const url = `http://localhost:${serverConfig.port}/${indexHtml}`;
-  const page = await driver.connect(url);
+  const page = await driver.connect(url, {ciMode});
   const report = await executeAxe(page);
 
   await driver.exit();

src/axe-runner.js

@@ -102,6 +102,8 @@ function traverseObj(obj, callback) {
   Object.keys(obj).forEach(key => callback(obj[key], key));
 }
 
+const ciMode = Boolean(argv['ci-mode']);
+
 if (argv['packages']) {
   const packagesDir = argv['packages'] || 'packages';
   const packagesPath = path.join(path.resolve(appDirectory), packagesDir);
@@ -110,9 +112,10 @@ if (argv['packages']) {
   dl.list(`${packagesPath}/`, true, list => {
     const loop = list.reduce((promise, dir) => {
       return promise
-        .then(() =>
-          exec({indexHtml, serverPath: path.join(packagesPath, dir)})
-        )
+        .then(() => {
+          const serverPath = path.join(packagesPath, dir);
+          exec({indexHtml, serverPath, ciMode});
+        })
         .then(report => (reports[dir] = report));
     }, Promise.resolve());
 
@@ -122,7 +125,7 @@ if (argv['packages']) {
       .catch(ex => processException(ex));
   });
 } else {
-  exec({indexHtml, serverPath})
+  exec({indexHtml, serverPath, ciMode})
     .then(report => (decorate(report), processReport(report)))
     .catch(ex => processException(ex));
 }

src/helpers/Driver.js

@@ -14,16 +14,30 @@ class Driver {
     this.browser = null;
   }
 
+  /**
+   * @typedef ConnectOptions
+   * @prop {boolean} ciMode
+   */
+
   /**
    * Creates a Puppeteer instance and connects to the given address
    * @param {string} address
+   * @param {ConnectOptions} options
    * @return {Promise}
    */
-  async connect(address) {
-    this.browser = await puppeteer.launch();
+  async connect(address, options) {
+    const {ciMode} = options;
+    const launchOptions = ciMode
+      ? {
+          args: ['--no-sandbox'],
+        }
+      : {};
+    this.browser = await puppeteer.launch(launchOptions);
     const page = await this.browser.newPage();
     await page.goto(address, {waitUntil: 'load'});
-    console.log(`Connected to ${address}`);
+    console.log(
+      `Connected to ${address}${ciMode ? ', using --no-sandbox' : ''}`
+    );
     this.emitter.emit('connect');
     return page;
   }

src/helpers/Server.js

@@ -1,17 +1,17 @@
 import {Promise} from 'es6-promise';
 import express from 'express';
 
-/** 
+/**
  * Wrapper around setting up an express server with static middleware
  */
 class Server {
   /**
-	 * Starts the express server
-	 * @param {number} port
-	 * @param {string} dir
-	 * @return {Promise}
-	 * @throw {Error}
-	 */
+   * Starts the express server
+   * @param {number} port
+   * @param {string} dir
+   * @return {Promise}
+   * @throw {Error}
+   */
   start(port, dir) {
     if (this.app) throw new Error('Server is already running!');
 
@@ -30,9 +30,9 @@ class Server {
   }
 
   /**
-	 * Stops the server
-	 * @return {Promise}
-	 */
+   * Stops the server
+   * @return {Promise}
+   */
   stop() {
     return Promise.resolve().then(() => this.server.close());
   }