1558

pending completion

Build # 1558

Build Type

cron

travis-ci

Committed by

web-flow

Commit Message

Safari 13.1 fix (#129)

* Fix Safari 13 builder

* Bump to 6.1.0

* Test suite requires node 10

* Remove duplicate node version

Run Details

166 of 238 branches covered (69.75%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

2 existing lines in 1 file now uncovered.

492 of 622 relevant lines covered (79.1%)

17.39 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.71

/src/local-browsers/safari.js

/*
  Copyright 2016 Google Inc. 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.
*/

'use strict';

const fs = require('fs');
const webdriver = require('selenium-webdriver');
const safari = require('selenium-webdriver/safari');

const LocalBrowser = require('../browser-models/local-browser.js');
const SafariConfig = require('../webdriver-config/safari.js');

/**
 * <p>Handles the prettyName and executable path for Chrome browser.</p>
 *
 * @private
 * @extends WebDriverBrowser
 */
class LocalSafariBrowser extends LocalBrowser {
  /**
   * Create a Chrome representation of a {@link WebDriverBrowser}
   * instance on a specific channel.
   * @param {String} release The release name for this browser instance.
   */
  constructor(release) {
    super(new SafariConfig(), release);
  }

  /**
   * <p>This method returns the preconfigured builder used by
   * getSeleniumDriver().</p>
   *
   * <p>This is useful if you wish to customise the builder with additional
   * options (i.e. customise the proxy of the driver.)</p>
   *
   * <p>For more info, see:
   * {@link https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/index_exports_Builder.html | WebDriverBuilder Docs}</p>
   *
   * @return {WebDriverBuilder} Builder that resolves to a webdriver instance.
   */
  getSeleniumDriverBuilder() {
    const seleniumOptions = this.getSeleniumOptions();
    seleniumOptions.setTechnologyPreview((this._release === 'beta'));

    let builder = new webdriver
        .Builder()
        .withCapabilities(this._capabilities)
        .forBrowser(this.getId())
        .setSafariOptions(seleniumOptions);

    // Run Safari 12 in legacy mode due to
    // https://github.com/SeleniumHQ/selenium/issues/6026
    // This is not needed in Safari 13+.
    if (this.getVersionNumber() === 12) {
      builder = builder.usingServer(
          new safari.ServiceBuilder().addArguments('--legacy').build().start());
    }

    return builder;
  }

  /**
   * @return {string|null} The install directory with selenium-assistant's
   * reserved directory for installing browsers and operating files.
   */
  _findInInstallDir() {
    return null;
  }

  /**
   * Returns the executable for the browser
   * @return {String} Path of executable
   */
  getExecutablePath() {
    const installDirExecutable = this._findInInstallDir();
    if (installDirExecutable) {
      // We have a path for the browser
      return installDirExecutable;
    }

    try {
      if (this._release === 'stable') {
        if (process.platform === 'darwin') {
          return '/Applications/Safari.app/' +
            'Contents/MacOS/Safari';
        }
      } else if (this._release === 'beta') {
        if (process.platform === 'darwin') {
          return '/Applications/Safari Technology Preview.app/' +
            'Contents/MacOS/Safari Technology Preview';
        }
      }
    } catch (err) {
      // NOOP
    }

    return null;
  }

  /**
   * Get the version string from the browser itself. From Safari this is from
   * `version.plist` file.
   * @return {String} The version string for this Safari release.
   */
  getRawVersionString() {
    if (this._rawVerstionString) {
      return this._rawVerstionString;
    }

    const executablePath = this.getExecutablePath();
    if (!executablePath) {
      return null;
    }

    this._rawVerstionString = null;

    let versionListPath;
    if (this._release === 'stable') {
      versionListPath = '/Applications/Safari.app/Contents/version.plist';
    } else if (this._release === 'beta') {
      versionListPath = '/Applications/Safari Technology Preview.app/' +
        'Contents/version.plist';
    }
    try {
      const versionDoc = fs.readFileSync(versionListPath).toString();
      /* eslint-disable no-useless-escape */
      const results = new RegExp(
          '<key>CFBundleShortVersionString</key>' +
        '[\\s]+<string>([\\d]+.[\\d]+(?:.[\\d]+)?)</string>', 'g')
          .exec(versionDoc);
      /* eslint-enable no-useless-escape */
      if (results) {
        this._rawVerstionString = results[1];
      }
    } catch (err) {
      // NOOP
    }

    return this._rawVerstionString;
  }

  /**
   * A version number for the browser. This is the major version number
   * (i.e. for 48.0.1293, this would return 18)
   * @return {Integer} The major version number of this browser
   */
  getVersionNumber() {
    const safariVersion = this.getRawVersionString();
    if (!safariVersion) {
      return -1;
    }

    const regexMatch = safariVersion.match(/(\d+)\.\d+(?:\.\d+)?/);
    if (regexMatch === null) {
      return -1;
    }

    return parseInt(regexMatch[1], 10);
  }

  /**
   * Get the minimum support version of Safari with selenium-assistant.
   * @return {number} Minimum supported Safari version.
   */
  _getMinSupportedVersion() {
    // Latest SafariDriver only works on Safari 10+
    return 10;
  }

  /**
   * This method returns the pretty names for each browser release.
   * @return {Object} An object containing on or move of 'stable', 'beta' or
   * 'unstable' keys with a matching name for that release.
   */
  static getPrettyReleaseNames() {
    return {
      stable: 'Stable',
      beta: 'Technology Preview',
    };
  }
}

module.exports = LocalSafariBrowser;

1	/*
2	Copyright 2016 Google Inc. All Rights Reserved.
3
4	Licensed under the Apache License, Version 2.0 (the "License");
5	you may not use this file except in compliance with the License.
6	You may obtain a copy of the License at
7
8	http://www.apache.org/licenses/LICENSE-2.0
9
10	Unless required by applicable law or agreed to in writing, software
11	distributed under the License is distributed on an "AS IS" BASIS,
12	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	See the License for the specific language governing permissions and
14	limitations under the License.
15	*/
16
17	'use strict';
18
19	const fs = require('fs');	2✔
20	const webdriver = require('selenium-webdriver');	2✔
21	const safari = require('selenium-webdriver/safari');	2✔
22
23	const LocalBrowser = require('../browser-models/local-browser.js');	2✔
24	const SafariConfig = require('../webdriver-config/safari.js');	2✔
25
26	/**
27	* <p>Handles the prettyName and executable path for Chrome browser.</p>
28	*
29	* @private
30	* @extends WebDriverBrowser
31	*/
32	class LocalSafariBrowser extends LocalBrowser {
33	/**
34	* Create a Chrome representation of a {@link WebDriverBrowser}
35	* instance on a specific channel.
36	* @param {String} release The release name for this browser instance.
37	*/
38	constructor(release) {
39	super(new SafariConfig(), release);	20✔
40	}
41
42	/**
43	* <p>This method returns the preconfigured builder used by
44	* getSeleniumDriver().</p>
45	*
46	* <p>This is useful if you wish to customise the builder with additional
47	* options (i.e. customise the proxy of the driver.)</p>
48	*
49	* <p>For more info, see:
50	* {@link https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/index_exports_Builder.html \| WebDriverBuilder Docs}</p>
51	*
52	* @return {WebDriverBuilder} Builder that resolves to a webdriver instance.
53	*/
54	getSeleniumDriverBuilder() {
55	const seleniumOptions = this.getSeleniumOptions();	4✔
56	seleniumOptions.setTechnologyPreview((this._release === 'beta'));	4✔
57
58	let builder = new webdriver	4✔
59	.Builder()
60	.withCapabilities(this._capabilities)
61	.forBrowser(this.getId())
62	.setSafariOptions(seleniumOptions);
63
64	// Run Safari 12 in legacy mode due to
65	// https://github.com/SeleniumHQ/selenium/issues/6026
66	// This is not needed in Safari 13+.
67	if (this.getVersionNumber() === 12) {	4!
68	builder = builder.usingServer(	×
69	new safari.ServiceBuilder().addArguments('--legacy').build().start());
70	}
71
72	return builder;	4✔
73	}
74
75	/**
76	* @return {string\|null} The install directory with selenium-assistant's
77	* reserved directory for installing browsers and operating files.
78	*/
79	_findInInstallDir() {
80	return null;	26✔
81	}
82
83	/**
84	* Returns the executable for the browser
85	* @return {String} Path of executable
86	*/
87	getExecutablePath() {
88	const installDirExecutable = this._findInInstallDir();	26✔
89	if (installDirExecutable) {	26!
90	// We have a path for the browser
UNCOV 91	return installDirExecutable;	×
92	}
93
94	try {	26✔
95	if (this._release === 'stable') {	26✔
96	if (process.platform === 'darwin') {	18✔
97	return '/Applications/Safari.app/' +	14✔
98	'Contents/MacOS/Safari';
99	}
100	} else if (this._release === 'beta') {	8!
101	if (process.platform === 'darwin') {	8✔
102	return '/Applications/Safari Technology Preview.app/' +	4✔
103	'Contents/MacOS/Safari Technology Preview';
104	}
105	}
106	} catch (err) {
107	// NOOP
108	}
109
110	return null;	8✔
111	}
112
113	/**
114	* Get the version string from the browser itself. From Safari this is from
115	* `version.plist` file.
116	* @return {String} The version string for this Safari release.
117	*/
118	getRawVersionString() {
119	if (this._rawVerstionString) {	24✔
120	return this._rawVerstionString;	12✔
121	}
122
123	const executablePath = this.getExecutablePath();	12✔
124	if (!executablePath) {	12✔
125	return null;	8✔
126	}
127
128	this._rawVerstionString = null;	4✔
129
130	let versionListPath;	4✔
131	if (this._release === 'stable') {	4!
132	versionListPath = '/Applications/Safari.app/Contents/version.plist';	4✔
UNCOV 133	} else if (this._release === 'beta') {	×
134	versionListPath = '/Applications/Safari Technology Preview.app/' +	×
135	'Contents/version.plist';
136	}
137	try {	4✔
138	const versionDoc = fs.readFileSync(versionListPath).toString();	4✔
139	/* eslint-disable no-useless-escape */
140	const results = new RegExp(	4✔
141	'<key>CFBundleShortVersionString</key>' +
142	'[\\s]+<string>([\\d]+.[\\d]+(?:.[\\d]+)?)</string>', 'g')
143	.exec(versionDoc);
144	/* eslint-enable no-useless-escape */
145	if (results) {	4!
146	this._rawVerstionString = results[1];	4✔
147	}
148	} catch (err) {
149	// NOOP
150	}
151
152	return this._rawVerstionString;	4✔
153	}
154
155	/**
156	* A version number for the browser. This is the major version number
157	* (i.e. for 48.0.1293, this would return 18)
158	* @return {Integer} The major version number of this browser
159	*/
160	getVersionNumber() {
161	const safariVersion = this.getRawVersionString();	22✔
162	if (!safariVersion) {	22✔
163	return -1;	4✔
164	}
165
166	const regexMatch = safariVersion.match(/(\d+)\.\d+(?:\.\d+)?/);	18✔
167	if (regexMatch === null) {	18✔
168	return -1;	4✔
169	}
170
171	return parseInt(regexMatch[1], 10);	14✔
172	}
173
174	/**
175	* Get the minimum support version of Safari with selenium-assistant.
176	* @return {number} Minimum supported Safari version.
177	*/
178	_getMinSupportedVersion() {
179	// Latest SafariDriver only works on Safari 10+
180	return 10;	6✔
181	}
182
183	/**
184	* This method returns the pretty names for each browser release.
185	* @return {Object} An object containing on or move of 'stable', 'beta' or
186	* 'unstable' keys with a matching name for that release.
187	*/
188	static getPrettyReleaseNames() {
189	return {	22✔
190	stable: 'Stable',
191	beta: 'Technology Preview',
192	};
193	}
194	}
195
196	module.exports = LocalSafariBrowser;	2✔

GoogleChromeLabs / selenium-assistant / 1558

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous