selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
1 lines • 14.1 kB
HTML
<meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>testcase.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/webdriver/testing/testcase.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the "License");<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an "AS IS" BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Defines a special test case that runs each test inside of a<tr><td><a name="l17" href="#l17">17</a><td> * {@code webdriver.Application}. This allows each phase to schedule<tr><td><a name="l18" href="#l18">18</a><td> * asynchronous actions that run to completion before the next phase of the<tr><td><a name="l19" href="#l19">19</a><td> * test.<tr><td><a name="l20" href="#l20">20</a><td> *<tr><td><a name="l21" href="#l21">21</a><td> * This file requires the global {@code G_testRunner} to be initialized before<tr><td><a name="l22" href="#l22">22</a><td> * use. This can be accomplished by also importing<tr><td><a name="l23" href="#l23">23</a><td> * {@link webdriver.testing.jsunit}. This namespace is not required by default<tr><td><a name="l24" href="#l24">24</a><td> * to improve interoperability with other namespaces that may initialize<tr><td><a name="l25" href="#l25">25</a><td> * G_testRunner.<tr><td><a name="l26" href="#l26">26</a><td> */<tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>goog.provide('webdriver.testing.TestCase');<tr><td><a name="l29" href="#l29">29</a><td><tr><td><a name="l30" href="#l30">30</a><td>goog.require('goog.testing.TestCase');<tr><td><a name="l31" href="#l31">31</a><td>goog.require('webdriver.promise.ControlFlow');<tr><td><a name="l32" href="#l32">32</a><td>/** @suppress {extraRequire} Imported for user convenience. */<tr><td><a name="l33" href="#l33">33</a><td>goog.require('webdriver.testing.asserts');<tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td><tr><td><a name="l36" href="#l36">36</a><td><tr><td><a name="l37" href="#l37">37</a><td>/**<tr><td><a name="l38" href="#l38">38</a><td> * Constructs a test case that synchronizes each test case with the singleton<tr><td><a name="l39" href="#l39">39</a><td> * {@code webdriver.promise.ControlFlow}.<tr><td><a name="l40" href="#l40">40</a><td> *<tr><td><a name="l41" href="#l41">41</a><td> * @param {!webdriver.testing.Client} client The test client to use for<tr><td><a name="l42" href="#l42">42</a><td> * reporting test results.<tr><td><a name="l43" href="#l43">43</a><td> * @param {string=} opt_name The name of the test case, defaults to<tr><td><a name="l44" href="#l44">44</a><td> * 'Untitled Test Case'.<tr><td><a name="l45" href="#l45">45</a><td> * @constructor<tr><td><a name="l46" href="#l46">46</a><td> * @extends {goog.testing.TestCase}<tr><td><a name="l47" href="#l47">47</a><td> */<tr><td><a name="l48" href="#l48">48</a><td>webdriver.testing.TestCase = function(client, opt_name) {<tr><td><a name="l49" href="#l49">49</a><td> goog.base(this, opt_name);<tr><td><a name="l50" href="#l50">50</a><td><tr><td><a name="l51" href="#l51">51</a><td> /** @private {!webdriver.testing.Client} */<tr><td><a name="l52" href="#l52">52</a><td> this.client_ = client;<tr><td><a name="l53" href="#l53">53</a><td>};<tr><td><a name="l54" href="#l54">54</a><td>goog.inherits(webdriver.testing.TestCase, goog.testing.TestCase);<tr><td><a name="l55" href="#l55">55</a><td><tr><td><a name="l56" href="#l56">56</a><td><tr><td><a name="l57" href="#l57">57</a><td>/**<tr><td><a name="l58" href="#l58">58</a><td> * Executes the next test inside its own {@code webdriver.Application}.<tr><td><a name="l59" href="#l59">59</a><td> * @override<tr><td><a name="l60" href="#l60">60</a><td> */<tr><td><a name="l61" href="#l61">61</a><td>webdriver.testing.TestCase.prototype.cycleTests = function() {<tr><td><a name="l62" href="#l62">62</a><td> var test = this.next();<tr><td><a name="l63" href="#l63">63</a><td> if (!test) {<tr><td><a name="l64" href="#l64">64</a><td> this.finalize();<tr><td><a name="l65" href="#l65">65</a><td> return;<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> goog.testing.TestCase.currentTestName = test.name;<tr><td><a name="l69" href="#l69">69</a><td> this.result_.runCount++;<tr><td><a name="l70" href="#l70">70</a><td> this.log('Running test: ' + test.name);<tr><td><a name="l71" href="#l71">71</a><td> this.client_.sendTestStartedEvent(test.name);<tr><td><a name="l72" href="#l72">72</a><td><tr><td><a name="l73" href="#l73">73</a><td> var self = this;<tr><td><a name="l74" href="#l74">74</a><td> var hadError = false;<tr><td><a name="l75" href="#l75">75</a><td> var app = webdriver.promise.controlFlow();<tr><td><a name="l76" href="#l76">76</a><td><tr><td><a name="l77" href="#l77">77</a><td> this.runSingleTest_(test, onError).then(function() {<tr><td><a name="l78" href="#l78">78</a><td> hadError || self.doSuccess(test);<tr><td><a name="l79" href="#l79">79</a><td> self.timeout(function() {<tr><td><a name="l80" href="#l80">80</a><td> self.cycleTests();<tr><td><a name="l81" href="#l81">81</a><td> }, 100);<tr><td><a name="l82" href="#l82">82</a><td> });<tr><td><a name="l83" href="#l83">83</a><td><tr><td><a name="l84" href="#l84">84</a><td> function onError(e) {<tr><td><a name="l85" href="#l85">85</a><td> hadError = true;<tr><td><a name="l86" href="#l86">86</a><td> self.doError(test, app.annotateError(e));<tr><td><a name="l87" href="#l87">87</a><td> // Note: result_ is a @protected field but still uses the trailing<tr><td><a name="l88" href="#l88">88</a><td> // underscore.<tr><td><a name="l89" href="#l89">89</a><td> var err = self.result_.errors[self.result_.errors.length - 1];<tr><td><a name="l90" href="#l90">90</a><td> self.client_.sendErrorEvent(err.toString());<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>/** @override */<tr><td><a name="l96" href="#l96">96</a><td>webdriver.testing.TestCase.prototype.logError = function(name, opt_e) {<tr><td><a name="l97" href="#l97">97</a><td> var errMsg = null;<tr><td><a name="l98" href="#l98">98</a><td> var stack = null;<tr><td><a name="l99" href="#l99">99</a><td> if (opt_e) {<tr><td><a name="l100" href="#l100">100</a><td> this.log(opt_e);<tr><td><a name="l101" href="#l101">101</a><td> if (goog.isString(opt_e)) {<tr><td><a name="l102" href="#l102">102</a><td> errMsg = opt_e;<tr><td><a name="l103" href="#l103">103</a><td> } else {<tr><td><a name="l104" href="#l104">104</a><td> // In case someone calls this function directly, make sure we have a<tr><td><a name="l105" href="#l105">105</a><td> // properly annotated error.<tr><td><a name="l106" href="#l106">106</a><td> webdriver.promise.controlFlow().annotateError(opt_e);<tr><td><a name="l107" href="#l107">107</a><td> errMsg = opt_e.toString();<tr><td><a name="l108" href="#l108">108</a><td> stack = opt_e.stack.substring(errMsg.length + 1);<tr><td><a name="l109" href="#l109">109</a><td> }<tr><td><a name="l110" href="#l110">110</a><td> } else {<tr><td><a name="l111" href="#l111">111</a><td> errMsg = 'An unknown error occurred';<tr><td><a name="l112" href="#l112">112</a><td> }<tr><td><a name="l113" href="#l113">113</a><td> var err = new goog.testing.TestCase.Error(name, errMsg, stack);<tr><td><a name="l114" href="#l114">114</a><td><tr><td><a name="l115" href="#l115">115</a><td> // Avoid double logging.<tr><td><a name="l116" href="#l116">116</a><td> if (!opt_e || !opt_e['isJsUnitException'] ||<tr><td><a name="l117" href="#l117">117</a><td> !opt_e['loggedJsUnitException']) {<tr><td><a name="l118" href="#l118">118</a><td> this.saveMessage(err.toString());<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> if (opt_e && opt_e['isJsUnitException']) {<tr><td><a name="l122" href="#l122">122</a><td> opt_e['loggedJsUnitException'] = true;<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> return err;<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><tr><td><a name="l129" href="#l129">129</a><td>/**<tr><td><a name="l130" href="#l130">130</a><td> * Executes a single test, scheduling each phase with the global application.<tr><td><a name="l131" href="#l131">131</a><td> * Each phase will wait for the application to go idle before moving on to the<tr><td><a name="l132" href="#l132">132</a><td> * next test phase. This function models the follow basic test flow:<tr><td><a name="l133" href="#l133">133</a><td> *<tr><td><a name="l134" href="#l134">134</a><td> * try {<tr><td><a name="l135" href="#l135">135</a><td> * this.setUp.call(test.scope);<tr><td><a name="l136" href="#l136">136</a><td> * test.ref.call(test.scope);<tr><td><a name="l137" href="#l137">137</a><td> * } catch (ex) {<tr><td><a name="l138" href="#l138">138</a><td> * onError(ex);<tr><td><a name="l139" href="#l139">139</a><td> * } finally {<tr><td><a name="l140" href="#l140">140</a><td> * try {<tr><td><a name="l141" href="#l141">141</a><td> * this.tearDown.call(test.scope);<tr><td><a name="l142" href="#l142">142</a><td> * } catch (e) {<tr><td><a name="l143" href="#l143">143</a><td> * onError(e);<tr><td><a name="l144" href="#l144">144</a><td> * }<tr><td><a name="l145" href="#l145">145</a><td> * }<tr><td><a name="l146" href="#l146">146</a><td> *<tr><td><a name="l147" href="#l147">147</a><td> * @param {!goog.testing.TestCase.Test} test The test to run.<tr><td><a name="l148" href="#l148">148</a><td> * @param {function(*)} onError The function to call each time an error is<tr><td><a name="l149" href="#l149">149</a><td> * detected.<tr><td><a name="l150" href="#l150">150</a><td> * @return {!webdriver.promise.Promise} A promise that will be resolved when the<tr><td><a name="l151" href="#l151">151</a><td> * test has finished running.<tr><td><a name="l152" href="#l152">152</a><td> * @private<tr><td><a name="l153" href="#l153">153</a><td> */<tr><td><a name="l154" href="#l154">154</a><td>webdriver.testing.TestCase.prototype.runSingleTest_ = function(test, onError) {<tr><td><a name="l155" href="#l155">155</a><td> var flow = webdriver.promise.controlFlow();<tr><td><a name="l156" href="#l156">156</a><td> flow.clearHistory();<tr><td><a name="l157" href="#l157">157</a><td><tr><td><a name="l158" href="#l158">158</a><td> return execute(test.name + '.setUp()', this.setUp)().<tr><td><a name="l159" href="#l159">159</a><td> then(execute(test.name + '()', test.ref)).<tr><td><a name="l160" href="#l160">160</a><td> thenCatch(onError).<tr><td><a name="l161" href="#l161">161</a><td> then(execute(test.name + '.tearDown()', this.tearDown)).<tr><td><a name="l162" href="#l162">162</a><td> thenCatch(onError);<tr><td><a name="l163" href="#l163">163</a><td><tr><td><a name="l164" href="#l164">164</a><td> function execute(description, fn) {<tr><td><a name="l165" href="#l165">165</a><td> return function() {<tr><td><a name="l166" href="#l166">166</a><td> return flow.execute(goog.bind(fn, test.scope), description);<tr><td><a name="l167" href="#l167">167</a><td> }<tr><td><a name="l168" href="#l168">168</a><td> }<tr><td><a name="l169" href="#l169">169</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>