selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
1 lines • 11.5 kB
HTML
<meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>exec.js</title><link href="../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>io/exec.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 childProcess = require('child_process');<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td>var promise = require('..').promise;<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>/**<tr><td><a name="l24" href="#l24">24</a><td> * A hash with configuration options for an executed command.<tr><td><a name="l25" href="#l25">25</a><td> * <ul><tr><td><a name="l26" href="#l26">26</a><td> * <li><tr><td><a name="l27" href="#l27">27</a><td> * <li>{@code args} - Command line arguments.<tr><td><a name="l28" href="#l28">28</a><td> * <li>{@code env} - Command environment; will inherit from the current process<tr><td><a name="l29" href="#l29">29</a><td> * if missing.<tr><td><a name="l30" href="#l30">30</a><td> * <li>{@code stdio} - IO configuration for the spawned server process. For<tr><td><a name="l31" href="#l31">31</a><td> * more information, refer to the documentation of<tr><td><a name="l32" href="#l32">32</a><td> * {@code child_process.spawn}.<tr><td><a name="l33" href="#l33">33</a><td> * </ul><tr><td><a name="l34" href="#l34">34</a><td> *<tr><td><a name="l35" href="#l35">35</a><td> * @typedef {{<tr><td><a name="l36" href="#l36">36</a><td> * args: (!Array.<string>|undefined),<tr><td><a name="l37" href="#l37">37</a><td> * env: (!Object.<string, string>|undefined),<tr><td><a name="l38" href="#l38">38</a><td> * stdio: (string|!Array.<string|number|!Stream|null|undefined>|undefined)<tr><td><a name="l39" href="#l39">39</a><td> * }}<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td>var Options;<tr><td><a name="l42" href="#l42">42</a><td><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> * Describes a command's termination conditions.<tr><td><a name="l46" href="#l46">46</a><td> * @param {?number} code The exit code, or {@code null} if the command did not<tr><td><a name="l47" href="#l47">47</a><td> * exit normally.<tr><td><a name="l48" href="#l48">48</a><td> * @param {?string} signal The signal used to kill the command, or<tr><td><a name="l49" href="#l49">49</a><td> * {@code null}.<tr><td><a name="l50" href="#l50">50</a><td> * @constructor<tr><td><a name="l51" href="#l51">51</a><td> */<tr><td><a name="l52" href="#l52">52</a><td>var Result = function(code, signal) {<tr><td><a name="l53" href="#l53">53</a><td> /** @type {?number} */<tr><td><a name="l54" href="#l54">54</a><td> this.code = code;<tr><td><a name="l55" href="#l55">55</a><td><tr><td><a name="l56" href="#l56">56</a><td> /** @type {?string} */<tr><td><a name="l57" href="#l57">57</a><td> this.signal = signal;<tr><td><a name="l58" href="#l58">58</a><td>};<tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td><tr><td><a name="l61" href="#l61">61</a><td>/** @override */<tr><td><a name="l62" href="#l62">62</a><td>Result.prototype.toString = function() {<tr><td><a name="l63" href="#l63">63</a><td> return 'Result(code=' + this.code + ', signal=' + this.signal + ')';<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><tr><td><a name="l67" href="#l67">67</a><td><tr><td><a name="l68" href="#l68">68</a><td>/**<tr><td><a name="l69" href="#l69">69</a><td> * Represents a command running in a sub-process.<tr><td><a name="l70" href="#l70">70</a><td> * @param {!promise.Promise.<!Result>} result The command result.<tr><td><a name="l71" href="#l71">71</a><td> * @constructor<tr><td><a name="l72" href="#l72">72</a><td> */<tr><td><a name="l73" href="#l73">73</a><td>var Command = function(result, onKill) {<tr><td><a name="l74" href="#l74">74</a><td> /** @return {boolean} Whether this command is still running. */<tr><td><a name="l75" href="#l75">75</a><td> this.isRunning = function() {<tr><td><a name="l76" href="#l76">76</a><td> return result.isPending();<tr><td><a name="l77" href="#l77">77</a><td> };<tr><td><a name="l78" href="#l78">78</a><td><tr><td><a name="l79" href="#l79">79</a><td> /**<tr><td><a name="l80" href="#l80">80</a><td> * @return {!promise.Promise.<!Result>} A promise for the result of this<tr><td><a name="l81" href="#l81">81</a><td> * command.<tr><td><a name="l82" href="#l82">82</a><td> */<tr><td><a name="l83" href="#l83">83</a><td> this.result = function() {<tr><td><a name="l84" href="#l84">84</a><td> return result;<tr><td><a name="l85" href="#l85">85</a><td> };<tr><td><a name="l86" href="#l86">86</a><td><tr><td><a name="l87" href="#l87">87</a><td> /**<tr><td><a name="l88" href="#l88">88</a><td> * Sends a signal to the underlying process.<tr><td><a name="l89" href="#l89">89</a><td> * @param {string=} opt_signal The signal to send; defaults to<tr><td><a name="l90" href="#l90">90</a><td> * {@code SIGTERM}.<tr><td><a name="l91" href="#l91">91</a><td> */<tr><td><a name="l92" href="#l92">92</a><td> this.kill = function(opt_signal) {<tr><td><a name="l93" href="#l93">93</a><td> onKill(opt_signal || 'SIGTERM');<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><tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td>// PUBLIC API<tr><td><a name="l99" href="#l99">99</a><td><tr><td><a name="l100" href="#l100">100</a><td><tr><td><a name="l101" href="#l101">101</a><td>/**<tr><td><a name="l102" href="#l102">102</a><td> * Spawns a child process. The returned {@link Command} may be used to wait<tr><td><a name="l103" href="#l103">103</a><td> * for the process result or to send signals to the process.<tr><td><a name="l104" href="#l104">104</a><td> *<tr><td><a name="l105" href="#l105">105</a><td> * @param {string} command The executable to spawn.<tr><td><a name="l106" href="#l106">106</a><td> * @param {Options=} opt_options The command options.<tr><td><a name="l107" href="#l107">107</a><td> * @return {!Command} The launched command.<tr><td><a name="l108" href="#l108">108</a><td> */<tr><td><a name="l109" href="#l109">109</a><td>module.exports = function(command, opt_options) {<tr><td><a name="l110" href="#l110">110</a><td> var options = opt_options || {};<tr><td><a name="l111" href="#l111">111</a><td><tr><td><a name="l112" href="#l112">112</a><td> var proc = childProcess.spawn(command, options.args || [], {<tr><td><a name="l113" href="#l113">113</a><td> env: options.env || process.env,<tr><td><a name="l114" href="#l114">114</a><td> stdio: options.stdio || 'ignore'<tr><td><a name="l115" href="#l115">115</a><td> }).once('exit', onExit);<tr><td><a name="l116" href="#l116">116</a><td><tr><td><a name="l117" href="#l117">117</a><td> // This process should not wait on the spawned child, however, we do<tr><td><a name="l118" href="#l118">118</a><td> // want to ensure the child is killed when this process exits.<tr><td><a name="l119" href="#l119">119</a><td> proc.unref();<tr><td><a name="l120" href="#l120">120</a><td> process.once('exit', killCommand);<tr><td><a name="l121" href="#l121">121</a><td><tr><td><a name="l122" href="#l122">122</a><td> var result = promise.defer();<tr><td><a name="l123" href="#l123">123</a><td> var cmd = new Command(result.promise, function(signal) {<tr><td><a name="l124" href="#l124">124</a><td> if (!result.isPending() || !proc) {<tr><td><a name="l125" href="#l125">125</a><td> return; // No longer running.<tr><td><a name="l126" href="#l126">126</a><td> }<tr><td><a name="l127" href="#l127">127</a><td> proc.kill(signal);<tr><td><a name="l128" href="#l128">128</a><td> });<tr><td><a name="l129" href="#l129">129</a><td> return cmd;<tr><td><a name="l130" href="#l130">130</a><td><tr><td><a name="l131" href="#l131">131</a><td> function onExit(code, signal) {<tr><td><a name="l132" href="#l132">132</a><td> proc = null;<tr><td><a name="l133" href="#l133">133</a><td> process.removeListener('exit', killCommand);<tr><td><a name="l134" href="#l134">134</a><td> result.fulfill(new Result(code, signal));<tr><td><a name="l135" href="#l135">135</a><td> }<tr><td><a name="l136" href="#l136">136</a><td><tr><td><a name="l137" href="#l137">137</a><td> function killCommand() {<tr><td><a name="l138" href="#l138">138</a><td> process.removeListener('exit', killCommand);<tr><td><a name="l139" href="#l139">139</a><td> proc && proc.kill('SIGTERM');<tr><td><a name="l140" href="#l140">140</a><td> }<tr><td><a name="l141" href="#l141">141</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>