Fix error messages when can't find firefox & chrome (closes #3534)

package.json

@@ -177,6 +177,7 @@
     "npm-auditor": "^1.1.1",
     "openssl-self-signed-certificate": "^1.1.6",
     "opn": "^4.0.2",
+    "proxyquire": "^2.1.0",
     "publish-please": "^5.4.3",
     "recursive-copy": "^2.0.5",
     "request": "^2.58.0",

src/browser/provider/built-in/dedicated/base.js

@@ -0,0 +1,37 @@
+import { getBrowserInfo } from 'testcafe-browser-tools';
+import getMaximizedHeadlessWindowSize from '../../utils/get-maximized-headless-window-size';
+
+export default {
+    openedBrowsers: {},
+
+    isMultiBrowser: false,
+
+    _getConfig () {
+        throw new Error('Not implemented');
+    },
+
+    _getBrowserName () {
+        return this.providerName.replace(':', '');
+    },
+
+    async isValidBrowserName (browserName) {
+        const config      = await this._getConfig(browserName);
+        const browserInfo = await getBrowserInfo(config.path || this._getBrowserName());
+
+        return !!browserInfo;
+    },
+
+    async isLocalBrowser () {
+        return true;
+    },
+
+    isHeadlessBrowser (browserId) {
+        return this.openedBrowsers[browserId].config.headless;
+    },
+
+    async maximizeWindow (browserId) {
+        const maximumSize = getMaximizedHeadlessWindowSize();
+
+        await this.resizeWindow(browserId, maximumSize.width, maximumSize.height, maximumSize.width, maximumSize.height);
+    }
+};

src/browser/provider/built-in/chrome/cdp.js → src/browser/provider/built-in/dedicated/chrome/cdp.js

@@ -1,5 +1,5 @@
 import remoteChrome from 'chrome-remote-interface';
-import { GET_WINDOW_DIMENSIONS_INFO_SCRIPT } from '../../utils/client-functions';
+import { GET_WINDOW_DIMENSIONS_INFO_SCRIPT } from '../../../utils/client-functions';
 
 
 async function getActiveTab (cdpPort, browserId) {

src/browser/provider/built-in/chrome/config.js → src/browser/provider/built-in/dedicated/chrome/config.js

@@ -2,7 +2,7 @@ import emulatedDevices from 'chrome-emulated-devices-list';
 import { pickBy as filterProperties } from 'lodash';
 import {
     hasMatch, findMatch, isMatchTrue, getModes, splitEscaped, getPathFromParsedModes, parseConfig
-} from '../../utils/argument-parsing';
+} from '../../../utils/argument-parsing';
 
 
 const HEADLESS_DEFAULT_WIDTH  = 1280;

src/browser/provider/built-in/chrome/create-temp-profile.js → src/browser/provider/built-in/dedicated/chrome/create-temp-profile.js

@@ -1,7 +1,7 @@
 import path from 'path';
 import makeDir from 'make-dir';
-import TempDirectory from '../../../../utils/temp-directory';
-import { writeFile } from '../../../../utils/promisified-functions';
+import TempDirectory from '../../../../../utils/temp-directory';
+import { writeFile } from '../../../../../utils/promisified-functions';
 
 
 export default async function (proxyHostName) {

src/browser/provider/built-in/chrome/index.js → src/browser/provider/built-in/dedicated/chrome/index.js

@@ -1,26 +1,28 @@
 import OS from 'os-family';
 import { parse as parseUrl } from 'url';
+import dedicatedProviderBase from '../base';
 import getRuntimeInfo from './runtime-info';
+import getConfig from './config';
 import { start as startLocalChrome, stop as stopLocalChrome } from './local-chrome';
 import * as cdp from './cdp';
-import getMaximizedHeadlessWindowSize from '../../utils/get-maximized-headless-window-size';
-import { GET_WINDOW_DIMENSIONS_INFO_SCRIPT } from '../../utils/client-functions';
-import { cropScreenshot } from '../../../../screenshots/crop';
-import { writePng } from '../../../../screenshots/utils';
+import { GET_WINDOW_DIMENSIONS_INFO_SCRIPT } from '../../../utils/client-functions';
+import { cropScreenshot } from '../../../../../screenshots/crop';
+import { writePng } from '../../../../../screenshots/utils';
 
 const MIN_AVAILABLE_DIMENSION = 50;
 
 export default {
-    openedBrowsers: {},
+    ...dedicatedProviderBase,
 
-    isMultiBrowser: false,
+    _getConfig (name) {
+        return getConfig(name);
+    },
 
     async openBrowser (browserId, pageUrl, configString) {
         const runtimeInfo = await getRuntimeInfo(parseUrl(pageUrl).hostname, configString);
-        const browserName = this.providerName.replace(':', '');
 
+        runtimeInfo.browserName = this._getBrowserName();
         runtimeInfo.browserId   = browserId;
-        runtimeInfo.browserName = browserName;
 
         runtimeInfo.providerMethods = {
             resizeLocalBrowserWindow: (...args) => this.resizeLocalBrowserWindow(...args)
@@ -56,14 +58,6 @@ export default {
         delete this.openedBrowsers[browserId];
     },
 
-    async isLocalBrowser () {
-        return true;
-    },
-
-    isHeadlessBrowser (browserId) {
-        return this.openedBrowsers[browserId].config.headless;
-    },
-
     async takeScreenshot (browserId, path) {
         const runtimeInfo = this.openedBrowsers[browserId];
         const viewport    = await cdp.getPageViewport(runtimeInfo);
@@ -95,12 +89,6 @@ export default {
         await cdp.resizeWindow({ width, height }, runtimeInfo);
     },
 
-    async maximizeWindow (browserId) {
-        const maximumSize = getMaximizedHeadlessWindowSize();
-
-        await this.resizeWindow(browserId, maximumSize.width, maximumSize.height, maximumSize.width, maximumSize.height);
-    },
-
     async getVideoFrameData (browserId) {
         return await cdp.getScreenshotData(this.openedBrowsers[browserId]);
     },

src/browser/provider/built-in/chrome/local-chrome.js → src/browser/provider/built-in/dedicated/chrome/local-chrome.js

@@ -1,6 +1,6 @@
 import browserTools from 'testcafe-browser-tools';
-import { killBrowserProcess } from '../../../../utils/process';
-import BrowserStarter from '../../utils/browser-starter';
+import { killBrowserProcess } from '../../../../../utils/process';
+import BrowserStarter from '../../../utils/browser-starter';
 import { buildChromeArgs } from './build-chrome-args';
 
 const browserStarter = new BrowserStarter();

src/browser/provider/built-in/firefox/config.js → src/browser/provider/built-in/dedicated/firefox/config.js

@@ -1,4 +1,4 @@
-import { findMatch, isMatchTrue, splitEscaped, parseConfig, getModes, getPathFromParsedModes } from '../../utils/argument-parsing';
+import { findMatch, isMatchTrue, splitEscaped, parseConfig, getModes, getPathFromParsedModes } from '../../../utils/argument-parsing';
 
 
 const AVAILABLE_MODES = ['userProfile', 'headless'];

src/browser/provider/built-in/firefox/create-temp-profile.js → src/browser/provider/built-in/dedicated/firefox/create-temp-profile.js

@@ -1,6 +1,6 @@
 import path from 'path';
-import TempDirectory from '../../../../utils/temp-directory';
-import { writeFile } from '../../../../utils/promisified-functions';
+import TempDirectory from '../../../../../utils/temp-directory';
+import { writeFile } from '../../../../../utils/promisified-functions';
 
 
 async function generatePreferences (profileDir, { marionettePort, config }) {

src/browser/provider/built-in/firefox/index.js → src/browser/provider/built-in/dedicated/firefox/index.js

@@ -1,14 +1,17 @@
 import OS from 'os-family';
+import dedicatedProviderBase from '../base';
 import getRuntimeInfo from './runtime-info';
+import getConfig from './config';
 import { start as startLocalFirefox, stop as stopLocalFirefox } from './local-firefox';
 import MarionetteClient from './marionette-client';
-import getMaximizedHeadlessWindowSize from '../../utils/get-maximized-headless-window-size';
 
 
 export default {
-    openedBrowsers: {},
+    ...dedicatedProviderBase,
 
-    isMultiBrowser: false,
+    _getConfig (name) {
+        return getConfig(name);
+    },
 
     async _createMarionetteClient (runtimeInfo) {
         try {
@@ -25,10 +28,9 @@ export default {
 
     async openBrowser (browserId, pageUrl, configString) {
         const runtimeInfo = await getRuntimeInfo(configString);
-        const browserName = this.providerName.replace(':', '');
 
+        runtimeInfo.browserName = this._getBrowserName();
         runtimeInfo.browserId   = browserId;
-        runtimeInfo.browserName = browserName;
 
         await startLocalFirefox(pageUrl, runtimeInfo);
 
@@ -58,14 +60,6 @@ export default {
         delete this.openedBrowsers[browserId];
     },
 
-    async isLocalBrowser () {
-        return true;
-    },
-
-    isHeadlessBrowser (browserId) {
-        return this.openedBrowsers[browserId].config.headless;
-    },
-
     async takeScreenshot (browserId, path) {
         const { marionetteClient } = this.openedBrowsers[browserId];
 
@@ -78,12 +72,6 @@ export default {
         await marionetteClient.setWindowSize(width, height);
     },
 
-    async maximizeWindow (browserId) {
-        const maximumSize = getMaximizedHeadlessWindowSize();
-
-        await this.resizeWindow(browserId, maximumSize.width, maximumSize.height);
-    },
-
     async getVideoFrameData (browserId) {
         const { marionetteClient } = this.openedBrowsers[browserId];
 

src/browser/provider/built-in/firefox/local-firefox.js → src/browser/provider/built-in/dedicated/firefox/local-firefox.js

@@ -1,7 +1,7 @@
 import OS from 'os-family';
 import browserTools from 'testcafe-browser-tools';
-import { killBrowserProcess } from '../../../../utils/process';
-import BrowserStarter from '../../utils/browser-starter';
+import { killBrowserProcess } from '../../../../../utils/process';
+import BrowserStarter from '../../../utils/browser-starter';
 
 
 const browserStarter = new BrowserStarter();

src/browser/provider/built-in/firefox/marionette-client/index.js → src/browser/provider/built-in/dedicated/firefox/marionette-client/index.js

@@ -2,9 +2,9 @@ import Promise from 'pinkie';
 import { Socket } from 'net';
 import promisifyEvent from 'promisify-event';
 import EventEmitter from 'events';
-import { writeFile } from '../../../../../utils/promisified-functions';
-import delay from '../../../../../utils/delay';
-import { GET_WINDOW_DIMENSIONS_INFO_SCRIPT } from '../../../utils/client-functions';
+import { writeFile } from '../../../../../../utils/promisified-functions';
+import delay from '../../../../../../utils/delay';
+import { GET_WINDOW_DIMENSIONS_INFO_SCRIPT } from '../../../../utils/client-functions';
 import COMMANDS from './commands';
 
 

src/browser/provider/built-in/index.js

@@ -1,8 +1,8 @@
 import pathBrowserProvider from './path';
 import locallyInstalledBrowserProvider from './locally-installed';
 import remoteBrowserProvider from './remote';
-import firefoxProvider from './firefox';
-import chromeProvider from './chrome';
+import firefoxProvider from './dedicated/firefox';
+import chromeProvider from './dedicated/chrome';
 
 export default Object.assign(
     {

test/functional/fixtures/browser-provider/custom-profile/test.js

@@ -3,8 +3,8 @@ const { expect }           = require('chai');
 const Promise              = require('pinkie');
 const config               = require('../../../config');
 const { createNullStream } = require('../../../utils/stream');
-const createChromeProfile  = require('../../../../../lib/browser/provider/built-in/chrome/create-temp-profile');
-const createFirefoxProfile = require('../../../../../lib/browser/provider/built-in/firefox/create-temp-profile');
+const createChromeProfile  = require('../../../../../lib/browser/provider/built-in/dedicated/chrome/create-temp-profile');
+const createFirefoxProfile = require('../../../../../lib/browser/provider/built-in/dedicated/firefox/create-temp-profile');
 
 
 if (config.useLocalBrowsers && !config.isTravisEnvironment) {

test/functional/fixtures/browser-provider/job-reporting/test.js

@@ -1,7 +1,8 @@
 const path                  = require('path');
+const Promise               = require('pinkie');
 const expect                = require('chai').expect;
 const config                = require('../../../config');
-const chromeBrowserProvider = require('../../../../../lib/browser/provider/built-in/chrome');
+const chromeBrowserProvider = require('../../../../../lib/browser/provider/built-in/dedicated/chrome');
 const browserProviderPool   = require('../../../../../lib/browser/provider/pool');
 const BrowserConnection     = require('../../../../../lib/browser/connection');
 
@@ -16,7 +17,7 @@ if (config.useLocalBrowsers) {
             state:     {},
             idNameMap: {},
 
-            openBrowser: function (browserId, pageUrl, name) {
+            openBrowser (browserId, pageUrl, name) {
                 const self = this;
 
                 this.idNameMap[browserId] = name;
@@ -31,11 +32,15 @@ if (config.useLocalBrowsers) {
                 return chromeBrowserProvider.openBrowser.call(this, browserId, pageUrl, 'headless --no-sandbox');
             },
 
-            closeBrowser: function (browserId) {
+            closeBrowser (browserId) {
                 return chromeBrowserProvider.closeBrowser.call(this, browserId);
             },
 
-            reportJobResult: function (browserId, result, data) {
+            isValidBrowserName () {
+                return Promise.resolve(true);
+            },
+
+            reportJobResult (browserId, result, data) {
                 const name = this.idNameMap[browserId];
 
                 this.state[name].result = result;
@@ -44,7 +49,7 @@ if (config.useLocalBrowsers) {
                 return Promise.resolve();
             },
 
-            simulateError: function (browserId) {
+            simulateError (browserId) {
                 const bc = BrowserConnection.getById(browserId);
 
                 bc.emit('error', new Error('Connection error'));

test/server/browser-provider-test.js

@@ -1,5 +1,6 @@
 const expect                = require('chai').expect;
 const Promise               = require('pinkie');
+const proxyquire            = require('proxyquire');
 const testcafeBrowserTools  = require('testcafe-browser-tools');
 const browserProviderPool   = require('../../lib/browser/provider/pool');
 const parseProviderName     = require('../../lib/browser/provider/parse-provider-name');
@@ -197,5 +198,57 @@ describe('Browser provider', function () {
             });
         });
     });
+
+    describe('Dedicated providers base', () => {
+        describe('isValidBrowserName', function () {
+            it('Should return false if a browser is not found', () => {
+                const dedicatedBrowserProviderBase = proxyquire('../../lib/browser/provider/built-in/dedicated/base', {
+                    'testcafe-browser-tools': {
+                        getBrowserInfo () {
+                            return null;
+                        }
+                    }
+                });
+
+                const testProvider = Object.assign({}, dedicatedBrowserProviderBase, {
+                    providerName: 'browser',
+
+                    _getConfig () {
+                        return {};
+                    }
+                });
+
+                return testProvider
+                    .isValidBrowserName('browser')
+                    .then(result => {
+                        expect(result).to.be.false;
+                    });
+            });
+
+            it('Should return true if a browser is found', () => {
+                const dedicatedBrowserProviderBase = proxyquire('../../lib/browser/provider/built-in/dedicated/base', {
+                    'testcafe-browser-tools': {
+                        getBrowserInfo () {
+                            return { alias: 'browser' };
+                        }
+                    }
+                });
+
+                const testProvider = Object.assign({}, dedicatedBrowserProviderBase, {
+                    providerName: 'browser',
+
+                    _getConfig () {
+                        return {};
+                    }
+                });
+
+                return testProvider
+                    .isValidBrowserName('browser')
+                    .then(result => {
+                        expect(result).to.be.true;
+                    });
+            });
+        });
+    });
 });
 

test/server/chrome-provider-config-test.js

@@ -1,6 +1,6 @@
 const expect          = require('chai').expect;
 const OS              = require('os-family');
-const getChromeConfig = require('../../lib/browser/provider/built-in/chrome/config.js');
+const getChromeConfig = require('../../lib/browser/provider/built-in/dedicated/chrome/config.js');
 
 
 describe('Chrome provider config parser', function () {

test/server/firefox-provider-config-test.js

@@ -1,6 +1,6 @@
 const expect          = require('chai').expect;
 const OS              = require('os-family');
-const getFirefoxConfig = require('../../lib/browser/provider/built-in/firefox/config.js');
+const getFirefoxConfig = require('../../lib/browser/provider/built-in/dedicated/firefox/config.js');
 
 
 describe('Firefox provider config parser', function () {