selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

1 lines • 12.1 kB

HTML

<!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>exec.js</title><link href="../../dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article class="srcfile"><h1>io/exec.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Licensed to the Software Freedom Conservancy (SFC) under one<tr><td><a id="l2"></a><a href="#l2">2</a><td>// or more contributor license agreements. See the NOTICE file<tr><td><a id="l3"></a><a href="#l3">3</a><td>// distributed with this work for additional information<tr><td><a id="l4"></a><a href="#l4">4</a><td>// regarding copyright ownership. The SFC licenses this file<tr><td><a id="l5"></a><a href="#l5">5</a><td>// to you under the Apache License, Version 2.0 (the<tr><td><a id="l6"></a><a href="#l6">6</a><td>// "License"); you may not use this file except in compliance<tr><td><a id="l7"></a><a href="#l7">7</a><td>// with the License. You may obtain a copy of the License at<tr><td><a id="l8"></a><a href="#l8">8</a><td>//<tr><td><a id="l9"></a><a href="#l9">9</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a id="l10"></a><a href="#l10">10</a><td>//<tr><td><a id="l11"></a><a href="#l11">11</a><td>// Unless required by applicable law or agreed to in writing,<tr><td><a id="l12"></a><a href="#l12">12</a><td>// software distributed under the License is distributed on an<tr><td><a id="l13"></a><a href="#l13">13</a><td>// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<tr><td><a id="l14"></a><a href="#l14">14</a><td>// KIND, either express or implied. See the License for the<tr><td><a id="l15"></a><a href="#l15">15</a><td>// specific language governing permissions and limitations<tr><td><a id="l16"></a><a href="#l16">16</a><td>// under the License.<tr><td><a id="l17"></a><a href="#l17">17</a><td><tr><td><a id="l18"></a><a href="#l18">18</a><td>'use strict';<tr><td><a id="l19"></a><a href="#l19">19</a><td><tr><td><a id="l20"></a><a href="#l20">20</a><td>var childProcess = require('child_process');<tr><td><a id="l21"></a><a href="#l21">21</a><td><tr><td><a id="l22"></a><a href="#l22">22</a><td>var promise = require('..').promise;<tr><td><a id="l23"></a><a href="#l23">23</a><td><tr><td><a id="l24"></a><a href="#l24">24</a><td><tr><td><a id="l25"></a><a href="#l25">25</a><td>/**<tr><td><a id="l26"></a><a href="#l26">26</a><td> * A hash with configuration options for an executed command.<tr><td><a id="l27"></a><a href="#l27">27</a><td> *<tr><td><a id="l28"></a><a href="#l28">28</a><td> * - `args` - Command line arguments.<tr><td><a id="l29"></a><a href="#l29">29</a><td> * - `env` - Command environment; will inherit from the current process if<tr><td><a id="l30"></a><a href="#l30">30</a><td> * missing.<tr><td><a id="l31"></a><a href="#l31">31</a><td> * - `stdio` - IO configuration for the spawned server process. For more<tr><td><a id="l32"></a><a href="#l32">32</a><td> * information, refer to the documentation of `child_process.spawn`.<tr><td><a id="l33"></a><a href="#l33">33</a><td> *<tr><td><a id="l34"></a><a href="#l34">34</a><td> * @typedef {{<tr><td><a id="l35"></a><a href="#l35">35</a><td> * args: (!Array.<string>|undefined),<tr><td><a id="l36"></a><a href="#l36">36</a><td> * env: (!Object.<string, string>|undefined),<tr><td><a id="l37"></a><a href="#l37">37</a><td> * stdio: (string|!Array.<string|number|!Stream|null|undefined>|undefined)<tr><td><a id="l38"></a><a href="#l38">38</a><td> * }}<tr><td><a id="l39"></a><a href="#l39">39</a><td> */<tr><td><a id="l40"></a><a href="#l40">40</a><td>var Options;<tr><td><a id="l41"></a><a href="#l41">41</a><td><tr><td><a id="l42"></a><a href="#l42">42</a><td><tr><td><a id="l43"></a><a href="#l43">43</a><td>/**<tr><td><a id="l44"></a><a href="#l44">44</a><td> * Describes a command's termination conditions.<tr><td><a id="l45"></a><a href="#l45">45</a><td> * @param {?number} code The exit code, or {@code null} if the command did not<tr><td><a id="l46"></a><a href="#l46">46</a><td> * exit normally.<tr><td><a id="l47"></a><a href="#l47">47</a><td> * @param {?string} signal The signal used to kill the command, or<tr><td><a id="l48"></a><a href="#l48">48</a><td> * {@code null}.<tr><td><a id="l49"></a><a href="#l49">49</a><td> * @constructor<tr><td><a id="l50"></a><a href="#l50">50</a><td> */<tr><td><a id="l51"></a><a href="#l51">51</a><td>var Result = function(code, signal) {<tr><td><a id="l52"></a><a href="#l52">52</a><td> /** @type {?number} */<tr><td><a id="l53"></a><a href="#l53">53</a><td> this.code = code;<tr><td><a id="l54"></a><a href="#l54">54</a><td><tr><td><a id="l55"></a><a href="#l55">55</a><td> /** @type {?string} */<tr><td><a id="l56"></a><a href="#l56">56</a><td> this.signal = signal;<tr><td><a id="l57"></a><a href="#l57">57</a><td>};<tr><td><a id="l58"></a><a href="#l58">58</a><td><tr><td><a id="l59"></a><a href="#l59">59</a><td><tr><td><a id="l60"></a><a href="#l60">60</a><td>/** @override */<tr><td><a id="l61"></a><a href="#l61">61</a><td>Result.prototype.toString = function() {<tr><td><a id="l62"></a><a href="#l62">62</a><td> return 'Result(code=' + this.code + ', signal=' + this.signal + ')';<tr><td><a id="l63"></a><a href="#l63">63</a><td>};<tr><td><a id="l64"></a><a href="#l64">64</a><td><tr><td><a id="l65"></a><a href="#l65">65</a><td><tr><td><a id="l66"></a><a href="#l66">66</a><td><tr><td><a id="l67"></a><a href="#l67">67</a><td>/**<tr><td><a id="l68"></a><a href="#l68">68</a><td> * Represents a command running in a sub-process.<tr><td><a id="l69"></a><a href="#l69">69</a><td> * @param {!promise.Promise.<!Result>} result The command result.<tr><td><a id="l70"></a><a href="#l70">70</a><td> * @constructor<tr><td><a id="l71"></a><a href="#l71">71</a><td> */<tr><td><a id="l72"></a><a href="#l72">72</a><td>var Command = function(result, onKill) {<tr><td><a id="l73"></a><a href="#l73">73</a><td> /** @return {boolean} Whether this command is still running. */<tr><td><a id="l74"></a><a href="#l74">74</a><td> this.isRunning = function() {<tr><td><a id="l75"></a><a href="#l75">75</a><td> return result.isPending();<tr><td><a id="l76"></a><a href="#l76">76</a><td> };<tr><td><a id="l77"></a><a href="#l77">77</a><td><tr><td><a id="l78"></a><a href="#l78">78</a><td> /**<tr><td><a id="l79"></a><a href="#l79">79</a><td> * @return {!promise.Promise.<!Result>} A promise for the result of this<tr><td><a id="l80"></a><a href="#l80">80</a><td> * command.<tr><td><a id="l81"></a><a href="#l81">81</a><td> */<tr><td><a id="l82"></a><a href="#l82">82</a><td> this.result = function() {<tr><td><a id="l83"></a><a href="#l83">83</a><td> return result;<tr><td><a id="l84"></a><a href="#l84">84</a><td> };<tr><td><a id="l85"></a><a href="#l85">85</a><td><tr><td><a id="l86"></a><a href="#l86">86</a><td> /**<tr><td><a id="l87"></a><a href="#l87">87</a><td> * Sends a signal to the underlying process.<tr><td><a id="l88"></a><a href="#l88">88</a><td> * @param {string=} opt_signal The signal to send; defaults to<tr><td><a id="l89"></a><a href="#l89">89</a><td> * {@code SIGTERM}.<tr><td><a id="l90"></a><a href="#l90">90</a><td> */<tr><td><a id="l91"></a><a href="#l91">91</a><td> this.kill = function(opt_signal) {<tr><td><a id="l92"></a><a href="#l92">92</a><td> onKill(opt_signal || 'SIGTERM');<tr><td><a id="l93"></a><a href="#l93">93</a><td> };<tr><td><a id="l94"></a><a href="#l94">94</a><td>};<tr><td><a id="l95"></a><a href="#l95">95</a><td><tr><td><a id="l96"></a><a href="#l96">96</a><td><tr><td><a id="l97"></a><a href="#l97">97</a><td>// PUBLIC API<tr><td><a id="l98"></a><a href="#l98">98</a><td><tr><td><a id="l99"></a><a href="#l99">99</a><td><tr><td><a id="l100"></a><a href="#l100">100</a><td>/**<tr><td><a id="l101"></a><a href="#l101">101</a><td> * Spawns a child process. The returned {@link Command} may be used to wait<tr><td><a id="l102"></a><a href="#l102">102</a><td> * for the process result or to send signals to the process.<tr><td><a id="l103"></a><a href="#l103">103</a><td> *<tr><td><a id="l104"></a><a href="#l104">104</a><td> * @param {string} command The executable to spawn.<tr><td><a id="l105"></a><a href="#l105">105</a><td> * @param {Options=} opt_options The command options.<tr><td><a id="l106"></a><a href="#l106">106</a><td> * @return {!Command} The launched command.<tr><td><a id="l107"></a><a href="#l107">107</a><td> */<tr><td><a id="l108"></a><a href="#l108">108</a><td>module.exports = function(command, opt_options) {<tr><td><a id="l109"></a><a href="#l109">109</a><td> var options = opt_options || {};<tr><td><a id="l110"></a><a href="#l110">110</a><td><tr><td><a id="l111"></a><a href="#l111">111</a><td> var proc = childProcess.spawn(command, options.args || [], {<tr><td><a id="l112"></a><a href="#l112">112</a><td> env: options.env || process.env,<tr><td><a id="l113"></a><a href="#l113">113</a><td> stdio: options.stdio || 'ignore'<tr><td><a id="l114"></a><a href="#l114">114</a><td> }).once('exit', onExit);<tr><td><a id="l115"></a><a href="#l115">115</a><td><tr><td><a id="l116"></a><a href="#l116">116</a><td> // This process should not wait on the spawned child, however, we do<tr><td><a id="l117"></a><a href="#l117">117</a><td> // want to ensure the child is killed when this process exits.<tr><td><a id="l118"></a><a href="#l118">118</a><td> proc.unref();<tr><td><a id="l119"></a><a href="#l119">119</a><td> process.once('exit', killCommand);<tr><td><a id="l120"></a><a href="#l120">120</a><td><tr><td><a id="l121"></a><a href="#l121">121</a><td> var result = promise.defer();<tr><td><a id="l122"></a><a href="#l122">122</a><td> var cmd = new Command(result.promise, function(signal) {<tr><td><a id="l123"></a><a href="#l123">123</a><td> if (!result.isPending() || !proc) {<tr><td><a id="l124"></a><a href="#l124">124</a><td> return; // No longer running.<tr><td><a id="l125"></a><a href="#l125">125</a><td> }<tr><td><a id="l126"></a><a href="#l126">126</a><td> proc.kill(signal);<tr><td><a id="l127"></a><a href="#l127">127</a><td> });<tr><td><a id="l128"></a><a href="#l128">128</a><td> return cmd;<tr><td><a id="l129"></a><a href="#l129">129</a><td><tr><td><a id="l130"></a><a href="#l130">130</a><td> function onExit(code, signal) {<tr><td><a id="l131"></a><a href="#l131">131</a><td> proc = null;<tr><td><a id="l132"></a><a href="#l132">132</a><td> process.removeListener('exit', killCommand);<tr><td><a id="l133"></a><a href="#l133">133</a><td> result.fulfill(new Result(code, signal));<tr><td><a id="l134"></a><a href="#l134">134</a><td> }<tr><td><a id="l135"></a><a href="#l135">135</a><td><tr><td><a id="l136"></a><a href="#l136">136</a><td> function killCommand() {<tr><td><a id="l137"></a><a href="#l137">137</a><td> process.removeListener('exit', killCommand);<tr><td><a id="l138"></a><a href="#l138">138</a><td> proc && proc.kill('SIGTERM');<tr><td><a id="l139"></a><a href="#l139">139</a><td> }<tr><td><a id="l140"></a><a href="#l140">140</a><td>};</table></div></article><nav><h3><a href="../../index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="../../Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="../../types.js"></script><script src="../../dossier.js"></script>