selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
1 lines • 21.2 kB
HTML
<meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>binary.js</title><link href="../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>firefox/binary.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2014 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2014 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the "License");<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an "AS IS" BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>'use strict';<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>var child = require('child_process'),<tr><td><a name="l19" href="#l19">19</a><td> fs = require('fs'),<tr><td><a name="l20" href="#l20">20</a><td> path = require('path'),<tr><td><a name="l21" href="#l21">21</a><td> util = require('util');<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>var promise = require('..').promise,<tr><td><a name="l24" href="#l24">24</a><td> _base = require('../_base'),<tr><td><a name="l25" href="#l25">25</a><td> io = require('../io'),<tr><td><a name="l26" href="#l26">26</a><td> exec = require('../io/exec');<tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td><tr><td><a name="l29" href="#l29">29</a><td><tr><td><a name="l30" href="#l30">30</a><td>/** @const */<tr><td><a name="l31" href="#l31">31</a><td>var NO_FOCUS_LIB_X86 = _base.isDevMode() ?<tr><td><a name="l32" href="#l32">32</a><td> path.join(__dirname, '../../../../cpp/prebuilt/i386/libnoblur.so') :<tr><td><a name="l33" href="#l33">33</a><td> path.join(__dirname, '../lib/firefox/i386/libnoblur.so') ;<tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td>/** @const */<tr><td><a name="l36" href="#l36">36</a><td>var NO_FOCUS_LIB_AMD64 = _base.isDevMode() ?<tr><td><a name="l37" href="#l37">37</a><td> path.join(__dirname, '../../../../cpp/prebuilt/amd64/libnoblur64.so') :<tr><td><a name="l38" href="#l38">38</a><td> path.join(__dirname, '../lib/firefox/amd64/libnoblur64.so') ;<tr><td><a name="l39" href="#l39">39</a><td><tr><td><a name="l40" href="#l40">40</a><td>var X_IGNORE_NO_FOCUS_LIB = 'x_ignore_nofocus.so';<tr><td><a name="l41" href="#l41">41</a><td><tr><td><a name="l42" href="#l42">42</a><td>var foundBinary = null;<tr><td><a name="l43" href="#l43">43</a><td><tr><td><a name="l44" href="#l44">44</a><td><tr><td><a name="l45" href="#l45">45</a><td>/**<tr><td><a name="l46" href="#l46">46</a><td> * Checks the default Windows Firefox locations in Program Files.<tr><td><a name="l47" href="#l47">47</a><td> * @return {!promise.Promise.<?string>} A promise for the located executable.<tr><td><a name="l48" href="#l48">48</a><td> * The promise will resolve to {@code null} if Fireox was not found.<tr><td><a name="l49" href="#l49">49</a><td> */<tr><td><a name="l50" href="#l50">50</a><td>function defaultWindowsLocation() {<tr><td><a name="l51" href="#l51">51</a><td> var files = [<tr><td><a name="l52" href="#l52">52</a><td> process.env['PROGRAMFILES'] || 'C:\\Program Files',<tr><td><a name="l53" href="#l53">53</a><td> process.env['PROGRAMFILES(X86)'] || 'C:\\Program Files (x86)'<tr><td><a name="l54" href="#l54">54</a><td> ].map(function(prefix) {<tr><td><a name="l55" href="#l55">55</a><td> return path.join(prefix, 'Mozilla Firefox\\firefox.exe');<tr><td><a name="l56" href="#l56">56</a><td> });<tr><td><a name="l57" href="#l57">57</a><td> return io.exists(files[0]).then(function(exists) {<tr><td><a name="l58" href="#l58">58</a><td> return exists ? files[0] : io.exists(files[1]).then(function(exists) {<tr><td><a name="l59" href="#l59">59</a><td> return exists ? files[1] : null;<tr><td><a name="l60" href="#l60">60</a><td> });<tr><td><a name="l61" href="#l61">61</a><td> });<tr><td><a name="l62" href="#l62">62</a><td>}<tr><td><a name="l63" href="#l63">63</a><td><tr><td><a name="l64" href="#l64">64</a><td><tr><td><a name="l65" href="#l65">65</a><td>/**<tr><td><a name="l66" href="#l66">66</a><td> * Locates the Firefox binary for the current system.<tr><td><a name="l67" href="#l67">67</a><td> * @return {!promise.Promise.<string>} A promise for the located binary. The<tr><td><a name="l68" href="#l68">68</a><td> * promise will be rejected if Firefox cannot be located.<tr><td><a name="l69" href="#l69">69</a><td> */<tr><td><a name="l70" href="#l70">70</a><td>function findFirefox() {<tr><td><a name="l71" href="#l71">71</a><td> if (foundBinary) {<tr><td><a name="l72" href="#l72">72</a><td> return foundBinary;<tr><td><a name="l73" href="#l73">73</a><td> }<tr><td><a name="l74" href="#l74">74</a><td><tr><td><a name="l75" href="#l75">75</a><td> if (process.platform === 'darwin') {<tr><td><a name="l76" href="#l76">76</a><td> var osxExe = '/Applications/Firefox.app/Contents/MacOS/firefox-bin';<tr><td><a name="l77" href="#l77">77</a><td> foundBinary = io.exists(osxExe).then(function(exists) {<tr><td><a name="l78" href="#l78">78</a><td> return exists ? osxExe : null;<tr><td><a name="l79" href="#l79">79</a><td> });<tr><td><a name="l80" href="#l80">80</a><td> } else if (process.platform === 'win32') {<tr><td><a name="l81" href="#l81">81</a><td> foundBinary = defaultWindowsLocation();<tr><td><a name="l82" href="#l82">82</a><td> } else {<tr><td><a name="l83" href="#l83">83</a><td> foundBinary = promise.fulfilled(io.findInPath('firefox'));<tr><td><a name="l84" href="#l84">84</a><td> }<tr><td><a name="l85" href="#l85">85</a><td><tr><td><a name="l86" href="#l86">86</a><td> return foundBinary = foundBinary.then(function(found) {<tr><td><a name="l87" href="#l87">87</a><td> if (found) {<tr><td><a name="l88" href="#l88">88</a><td> return found;<tr><td><a name="l89" href="#l89">89</a><td> }<tr><td><a name="l90" href="#l90">90</a><td> throw Error('Could not locate Firefox on the current system');<tr><td><a name="l91" href="#l91">91</a><td> });<tr><td><a name="l92" href="#l92">92</a><td>}<tr><td><a name="l93" href="#l93">93</a><td><tr><td><a name="l94" href="#l94">94</a><td><tr><td><a name="l95" href="#l95">95</a><td>/**<tr><td><a name="l96" href="#l96">96</a><td> * Copies the no focus libs into the given profile directory.<tr><td><a name="l97" href="#l97">97</a><td> * @param {string} profileDir Path to the profile directory to install into.<tr><td><a name="l98" href="#l98">98</a><td> * @return {!promise.Promise.<string>} The LD_LIBRARY_PATH prefix string to use<tr><td><a name="l99" href="#l99">99</a><td> * for the installed libs.<tr><td><a name="l100" href="#l100">100</a><td> */<tr><td><a name="l101" href="#l101">101</a><td>function installNoFocusLibs(profileDir) {<tr><td><a name="l102" href="#l102">102</a><td> var x86 = path.join(profileDir, 'x86');<tr><td><a name="l103" href="#l103">103</a><td> var amd64 = path.join(profileDir, 'amd64');<tr><td><a name="l104" href="#l104">104</a><td><tr><td><a name="l105" href="#l105">105</a><td> return mkdir(x86)<tr><td><a name="l106" href="#l106">106</a><td> .then(copyLib.bind(null, NO_FOCUS_LIB_X86, x86))<tr><td><a name="l107" href="#l107">107</a><td> .then(mkdir.bind(null, amd64))<tr><td><a name="l108" href="#l108">108</a><td> .then(copyLib.bind(null, NO_FOCUS_LIB_AMD64, amd64))<tr><td><a name="l109" href="#l109">109</a><td> .then(function() {<tr><td><a name="l110" href="#l110">110</a><td> return x86 + ':' + amd64;<tr><td><a name="l111" href="#l111">111</a><td> });<tr><td><a name="l112" href="#l112">112</a><td><tr><td><a name="l113" href="#l113">113</a><td> function mkdir(dir) {<tr><td><a name="l114" href="#l114">114</a><td> return io.exists(dir).then(function(exists) {<tr><td><a name="l115" href="#l115">115</a><td> if (!exists) {<tr><td><a name="l116" href="#l116">116</a><td> return promise.checkedNodeCall(fs.mkdir, dir);<tr><td><a name="l117" href="#l117">117</a><td> }<tr><td><a name="l118" href="#l118">118</a><td> });<tr><td><a name="l119" href="#l119">119</a><td> }<tr><td><a name="l120" href="#l120">120</a><td><tr><td><a name="l121" href="#l121">121</a><td> function copyLib(src, dir) {<tr><td><a name="l122" href="#l122">122</a><td> return io.copy(src, path.join(dir, X_IGNORE_NO_FOCUS_LIB));<tr><td><a name="l123" href="#l123">123</a><td> }<tr><td><a name="l124" href="#l124">124</a><td>}<tr><td><a name="l125" href="#l125">125</a><td><tr><td><a name="l126" href="#l126">126</a><td><tr><td><a name="l127" href="#l127">127</a><td>/**<tr><td><a name="l128" href="#l128">128</a><td> * Silently runs Firefox to install a profile directory (which is assumed to be<tr><td><a name="l129" href="#l129">129</a><td> * defined in the given environment variables).<tr><td><a name="l130" href="#l130">130</a><td> * @param {string} firefox Path to the Firefox executable.<tr><td><a name="l131" href="#l131">131</a><td> * @param {!Object.<string, string>} env The environment variables to use.<tr><td><a name="l132" href="#l132">132</a><td> * @return {!promise.Promise} A promise for when the profile has been installed.<tr><td><a name="l133" href="#l133">133</a><td> */<tr><td><a name="l134" href="#l134">134</a><td>function installProfile(firefox, env) {<tr><td><a name="l135" href="#l135">135</a><td> var installed = promise.defer();<tr><td><a name="l136" href="#l136">136</a><td> child.exec(firefox + ' -silent', {env: env, timeout: 180 * 1000},<tr><td><a name="l137" href="#l137">137</a><td> function(err) {<tr><td><a name="l138" href="#l138">138</a><td> if (err) {<tr><td><a name="l139" href="#l139">139</a><td> installed.reject(new Error(<tr><td><a name="l140" href="#l140">140</a><td> 'Failed to install Firefox profile: ' + err));<tr><td><a name="l141" href="#l141">141</a><td> return;<tr><td><a name="l142" href="#l142">142</a><td> }<tr><td><a name="l143" href="#l143">143</a><td> installed.fulfill();<tr><td><a name="l144" href="#l144">144</a><td> });<tr><td><a name="l145" href="#l145">145</a><td> return installed.promise;<tr><td><a name="l146" href="#l146">146</a><td>}<tr><td><a name="l147" href="#l147">147</a><td><tr><td><a name="l148" href="#l148">148</a><td><tr><td><a name="l149" href="#l149">149</a><td>/**<tr><td><a name="l150" href="#l150">150</a><td> * Manages a Firefox subprocess configured for use with WebDriver.<tr><td><a name="l151" href="#l151">151</a><td> * @param {string=} opt_exe Path to the Firefox binary to use. If not<tr><td><a name="l152" href="#l152">152</a><td> * specified, will attempt to locate Firefox on the current system.<tr><td><a name="l153" href="#l153">153</a><td> * @constructor<tr><td><a name="l154" href="#l154">154</a><td> */<tr><td><a name="l155" href="#l155">155</a><td>var Binary = function(opt_exe) {<tr><td><a name="l156" href="#l156">156</a><td> /** @private {(string|undefined)} */<tr><td><a name="l157" href="#l157">157</a><td> this.exe_ = opt_exe;<tr><td><a name="l158" href="#l158">158</a><td><tr><td><a name="l159" href="#l159">159</a><td> /** @private {!Array.<string>} */<tr><td><a name="l160" href="#l160">160</a><td> this.args_ = [];<tr><td><a name="l161" href="#l161">161</a><td><tr><td><a name="l162" href="#l162">162</a><td> /** @private {!Object.<string, string>} */<tr><td><a name="l163" href="#l163">163</a><td> this.env_ = {};<tr><td><a name="l164" href="#l164">164</a><td> Object.keys(process.env).forEach(function(key) {<tr><td><a name="l165" href="#l165">165</a><td> this.env_[key] = process.env[key];<tr><td><a name="l166" href="#l166">166</a><td> }.bind(this));<tr><td><a name="l167" href="#l167">167</a><td> this.env_['MOZ_CRASHREPORTER_DISABLE'] = '1';<tr><td><a name="l168" href="#l168">168</a><td> this.env_['MOZ_NO_REMOTE'] = '1';<tr><td><a name="l169" href="#l169">169</a><td> this.env_['NO_EM_RESTART'] = '1';<tr><td><a name="l170" href="#l170">170</a><td><tr><td><a name="l171" href="#l171">171</a><td> /** @private {promise.Promise.<!exec.Command>} */<tr><td><a name="l172" href="#l172">172</a><td> this.command_ = null;<tr><td><a name="l173" href="#l173">173</a><td>};<tr><td><a name="l174" href="#l174">174</a><td><tr><td><a name="l175" href="#l175">175</a><td><tr><td><a name="l176" href="#l176">176</a><td>/**<tr><td><a name="l177" href="#l177">177</a><td> * Add arguments to the command line used to start Firefox.<tr><td><a name="l178" href="#l178">178</a><td> * @param {...(string|!Array.<string>)} var_args Either the arguments to add as<tr><td><a name="l179" href="#l179">179</a><td> * varargs, or the arguments as an array.<tr><td><a name="l180" href="#l180">180</a><td> */<tr><td><a name="l181" href="#l181">181</a><td>Binary.prototype.addArguments = function(var_args) {<tr><td><a name="l182" href="#l182">182</a><td> for (var i = 0; i < arguments.length; i++) {<tr><td><a name="l183" href="#l183">183</a><td> if (util.isArray(arguments[i])) {<tr><td><a name="l184" href="#l184">184</a><td> this.args_ = this.args_.concat(arguments[i]);<tr><td><a name="l185" href="#l185">185</a><td> } else {<tr><td><a name="l186" href="#l186">186</a><td> this.args_.push(arguments[i]);<tr><td><a name="l187" href="#l187">187</a><td> }<tr><td><a name="l188" href="#l188">188</a><td> }<tr><td><a name="l189" href="#l189">189</a><td>};<tr><td><a name="l190" href="#l190">190</a><td><tr><td><a name="l191" href="#l191">191</a><td><tr><td><a name="l192" href="#l192">192</a><td>/**<tr><td><a name="l193" href="#l193">193</a><td> * Launches Firefox and eturns a promise that will be fulfilled when the process<tr><td><a name="l194" href="#l194">194</a><td> * terminates.<tr><td><a name="l195" href="#l195">195</a><td> * @param {string} profile Path to the profile directory to use.<tr><td><a name="l196" href="#l196">196</a><td> * @return {!promise.Promise.<!exec.Result>} A promise for the process result.<tr><td><a name="l197" href="#l197">197</a><td> * @throws {Error} If this instance has already been started.<tr><td><a name="l198" href="#l198">198</a><td> */<tr><td><a name="l199" href="#l199">199</a><td>Binary.prototype.launch = function(profile) {<tr><td><a name="l200" href="#l200">200</a><td> if (this.command_) {<tr><td><a name="l201" href="#l201">201</a><td> throw Error('Firefox is already running');<tr><td><a name="l202" href="#l202">202</a><td> }<tr><td><a name="l203" href="#l203">203</a><td><tr><td><a name="l204" href="#l204">204</a><td> var env = {};<tr><td><a name="l205" href="#l205">205</a><td> Object.keys(this.env_).forEach(function(key) {<tr><td><a name="l206" href="#l206">206</a><td> env[key] = this.env_[key];<tr><td><a name="l207" href="#l207">207</a><td> }.bind(this));<tr><td><a name="l208" href="#l208">208</a><td> env['XRE_PROFILE_PATH'] = profile;<tr><td><a name="l209" href="#l209">209</a><td><tr><td><a name="l210" href="#l210">210</a><td> var args = ['-foreground'].concat(this.args_);<tr><td><a name="l211" href="#l211">211</a><td><tr><td><a name="l212" href="#l212">212</a><td> var self = this;<tr><td><a name="l213" href="#l213">213</a><td><tr><td><a name="l214" href="#l214">214</a><td> this.command_ = promise.when(this.exe_ || findFirefox(), function(firefox) {<tr><td><a name="l215" href="#l215">215</a><td> if (process.platform === 'win32' || process.platform === 'darwin') {<tr><td><a name="l216" href="#l216">216</a><td> return firefox;<tr><td><a name="l217" href="#l217">217</a><td> }<tr><td><a name="l218" href="#l218">218</a><td> return installNoFocusLibs(profile).then(function(ldLibraryPath) {<tr><td><a name="l219" href="#l219">219</a><td> env['LD_LIBRARY_PATH'] = ldLibraryPath + ':' + env['LD_LIBRARY_PATH'];<tr><td><a name="l220" href="#l220">220</a><td> env['LD_PRELOAD'] = X_IGNORE_NO_FOCUS_LIB;<tr><td><a name="l221" href="#l221">221</a><td> return firefox;<tr><td><a name="l222" href="#l222">222</a><td> });<tr><td><a name="l223" href="#l223">223</a><td> }).then(function(firefox) {<tr><td><a name="l224" href="#l224">224</a><td> var install = exec(firefox, {args: ['-silent'], env: env});<tr><td><a name="l225" href="#l225">225</a><td> return install.result().then(function(result) {<tr><td><a name="l226" href="#l226">226</a><td> if (result.code !== 0) {<tr><td><a name="l227" href="#l227">227</a><td> throw Error(<tr><td><a name="l228" href="#l228">228</a><td> 'Failed to install profile; firefox terminated with ' + result);<tr><td><a name="l229" href="#l229">229</a><td> }<tr><td><a name="l230" href="#l230">230</a><td><tr><td><a name="l231" href="#l231">231</a><td> return exec(firefox, {args: args, env: env});<tr><td><a name="l232" href="#l232">232</a><td> });<tr><td><a name="l233" href="#l233">233</a><td> });<tr><td><a name="l234" href="#l234">234</a><td><tr><td><a name="l235" href="#l235">235</a><td> return this.command_.then(function() {<tr><td><a name="l236" href="#l236">236</a><td> // Don't return the actual command handle, just a promise to signal it has<tr><td><a name="l237" href="#l237">237</a><td> // been started.<tr><td><a name="l238" href="#l238">238</a><td> });<tr><td><a name="l239" href="#l239">239</a><td>};<tr><td><a name="l240" href="#l240">240</a><td><tr><td><a name="l241" href="#l241">241</a><td><tr><td><a name="l242" href="#l242">242</a><td>/**<tr><td><a name="l243" href="#l243">243</a><td> * Kills the managed Firefox process.<tr><td><a name="l244" href="#l244">244</a><td> * @return {!promise.Promise} A promise for when the process has terminated.<tr><td><a name="l245" href="#l245">245</a><td> */<tr><td><a name="l246" href="#l246">246</a><td>Binary.prototype.kill = function() {<tr><td><a name="l247" href="#l247">247</a><td> if (!this.command_) {<tr><td><a name="l248" href="#l248">248</a><td> return promise.defer(); // Not running.<tr><td><a name="l249" href="#l249">249</a><td> }<tr><td><a name="l250" href="#l250">250</a><td> return this.command_.then(function(command) {<tr><td><a name="l251" href="#l251">251</a><td> command.kill();<tr><td><a name="l252" href="#l252">252</a><td> return command.result();<tr><td><a name="l253" href="#l253">253</a><td> });<tr><td><a name="l254" href="#l254">254</a><td>};<tr><td><a name="l255" href="#l255">255</a><td><tr><td><a name="l256" href="#l256">256</a><td><tr><td><a name="l257" href="#l257">257</a><td>// PUBLIC API<tr><td><a name="l258" href="#l258">258</a><td><tr><td><a name="l259" href="#l259">259</a><td><tr><td><a name="l260" href="#l260">260</a><td>exports.Binary = Binary;<tr><td><a name="l261" href="#l261">261</a><td></table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../types.js"></script><script src="../../dossier.js"></script>