selenium-webdriver 2.43.5 → 2.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/CHANGES.md +20 -0
  2. package/README.md +8 -13
  3. package/builder.js +4 -3
  4. package/docs/class_webdriver_Alert.html +6 -6
  5. package/docs/class_webdriver_AlertPromise.html +6 -6
  6. package/docs/class_webdriver_UnhandledAlertError.html +4 -4
  7. package/docs/class_webdriver_WebDriver.html +39 -37
  8. package/docs/class_webdriver_WebDriver_Logs.html +3 -3
  9. package/docs/class_webdriver_WebDriver_Navigation.html +5 -5
  10. package/docs/class_webdriver_WebDriver_Options.html +9 -9
  11. package/docs/class_webdriver_WebDriver_TargetLocator.html +6 -6
  12. package/docs/class_webdriver_WebDriver_Timeouts.html +4 -4
  13. package/docs/class_webdriver_WebDriver_Window.html +6 -6
  14. package/docs/class_webdriver_WebElement.html +23 -23
  15. package/docs/class_webdriver_WebElementPromise.html +22 -22
  16. package/docs/class_webdriver_promise_CancellationError.html +3 -0
  17. package/docs/class_webdriver_promise_ControlFlow.html +32 -32
  18. package/docs/class_webdriver_promise_Deferred.html +7 -8
  19. package/docs/class_webdriver_promise_Frame_.html +14 -30
  20. package/docs/class_webdriver_promise_Promise.html +2 -2
  21. package/docs/class_webdriver_promise_Task_.html +12 -12
  22. package/docs/class_webdriver_until_Condition.html +3 -0
  23. package/docs/enum_webdriver_Key.html +1 -1
  24. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +1 -1
  25. package/docs/enum_webdriver_promise_Deferred_State_.html +1 -1
  26. package/docs/index.html +8 -13
  27. package/docs/interface_webdriver_promise_Thenable.html +8 -10
  28. package/docs/license.html +1 -1
  29. package/docs/module_selenium-webdriver.html +2 -2
  30. package/docs/module_selenium-webdriver__base.html +1 -1
  31. package/docs/module_selenium-webdriver__base_class_Context.html +1 -1
  32. package/docs/module_selenium-webdriver_builder.html +1 -1
  33. package/docs/module_selenium-webdriver_builder_class_Builder.html +1 -1
  34. package/docs/module_selenium-webdriver_chrome.html +1 -1
  35. package/docs/module_selenium-webdriver_chrome_class_Driver.html +2 -2
  36. package/docs/module_selenium-webdriver_chrome_class_Options.html +2 -2
  37. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +1 -1
  38. package/docs/module_selenium-webdriver_error.html +1 -1
  39. package/docs/module_selenium-webdriver_executors.html +1 -1
  40. package/docs/module_selenium-webdriver_firefox.html +1 -1
  41. package/docs/module_selenium-webdriver_firefox_binary.html +1 -1
  42. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +1 -1
  43. package/docs/module_selenium-webdriver_firefox_class_Driver.html +2 -2
  44. package/docs/module_selenium-webdriver_firefox_class_Options.html +1 -1
  45. package/docs/module_selenium-webdriver_firefox_extension.html +1 -1
  46. package/docs/module_selenium-webdriver_firefox_profile.html +1 -1
  47. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +1 -1
  48. package/docs/module_selenium-webdriver_http.html +1 -1
  49. package/docs/module_selenium-webdriver_http_class_HttpClient.html +1 -1
  50. package/docs/module_selenium-webdriver_http_util.html +1 -1
  51. package/docs/module_selenium-webdriver_io.html +1 -1
  52. package/docs/module_selenium-webdriver_io_exec.html +1 -1
  53. package/docs/module_selenium-webdriver_net.html +1 -1
  54. package/docs/module_selenium-webdriver_net_portprober.html +1 -1
  55. package/docs/module_selenium-webdriver_phantomjs.html +1 -1
  56. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +2 -2
  57. package/docs/module_selenium-webdriver_proxy.html +1 -1
  58. package/docs/module_selenium-webdriver_remote.html +1 -1
  59. package/docs/module_selenium-webdriver_remote_class_DriverService.html +2 -2
  60. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +2 -2
  61. package/docs/module_selenium-webdriver_testing.html +16 -29
  62. package/docs/module_selenium-webdriver_testing_assert.html +1 -1
  63. package/docs/namespace_webdriver_promise.html +18 -20
  64. package/docs/namespace_webdriver_stacktrace.html +15 -15
  65. package/docs/namespace_webdriver_until.html +32 -0
  66. package/docs/source/_base.js.src.html +1 -1
  67. package/docs/source/builder.js.src.html +1 -1
  68. package/docs/source/chrome.js.src.html +1 -1
  69. package/docs/source/error.js.src.html +1 -1
  70. package/docs/source/executors.js.src.html +1 -1
  71. package/docs/source/firefox/binary.js.src.html +1 -1
  72. package/docs/source/firefox/extension.js.src.html +1 -1
  73. package/docs/source/firefox/index.js.src.html +1 -1
  74. package/docs/source/firefox/profile.js.src.html +1 -1
  75. package/docs/source/http/index.js.src.html +1 -1
  76. package/docs/source/http/util.js.src.html +1 -1
  77. package/docs/source/index.js.src.html +1 -1
  78. package/docs/source/io/exec.js.src.html +1 -1
  79. package/docs/source/io/index.js.src.html +1 -1
  80. package/docs/source/lib/atoms/error.js.src.html +1 -1
  81. package/docs/source/lib/atoms/json.js.src.html +1 -1
  82. package/docs/source/lib/atoms/response.js.src.html +1 -1
  83. package/docs/source/lib/atoms/userAgent.js.src.html +1 -1
  84. package/docs/source/lib/goog/array/array.js.src.html +1 -1
  85. package/docs/source/lib/goog/asserts/asserts.js.src.html +1 -1
  86. package/docs/source/lib/goog/async/nexttick.js.src.html +1 -1
  87. package/docs/source/lib/goog/async/run.js.src.html +1 -1
  88. package/docs/source/lib/goog/base.js.src.html +1 -1
  89. package/docs/source/lib/goog/debug/debug.js.src.html +1 -1
  90. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +1 -1
  91. package/docs/source/lib/goog/debug/error.js.src.html +1 -1
  92. package/docs/source/lib/goog/debug/logbuffer.js.src.html +1 -1
  93. package/docs/source/lib/goog/debug/logger.js.src.html +1 -1
  94. package/docs/source/lib/goog/debug/logrecord.js.src.html +1 -1
  95. package/docs/source/lib/goog/deps.js.src.html +1 -1
  96. package/docs/source/lib/goog/disposable/disposable.js.src.html +1 -1
  97. package/docs/source/lib/goog/disposable/idisposable.js.src.html +1 -1
  98. package/docs/source/lib/goog/dom/browserfeature.js.src.html +1 -1
  99. package/docs/source/lib/goog/dom/dom.js.src.html +1 -1
  100. package/docs/source/lib/goog/dom/nodetype.js.src.html +1 -1
  101. package/docs/source/lib/goog/dom/tagname.js.src.html +1 -1
  102. package/docs/source/lib/goog/dom/vendor.js.src.html +1 -1
  103. package/docs/source/lib/goog/events/browserevent.js.src.html +1 -1
  104. package/docs/source/lib/goog/events/browserfeature.js.src.html +1 -1
  105. package/docs/source/lib/goog/events/event.js.src.html +1 -1
  106. package/docs/source/lib/goog/events/eventid.js.src.html +1 -1
  107. package/docs/source/lib/goog/events/events.js.src.html +1 -1
  108. package/docs/source/lib/goog/events/eventtarget.js.src.html +1 -1
  109. package/docs/source/lib/goog/events/eventtype.js.src.html +1 -1
  110. package/docs/source/lib/goog/events/keycodes.js.src.html +1 -1
  111. package/docs/source/lib/goog/events/listenable.js.src.html +1 -1
  112. package/docs/source/lib/goog/events/listener.js.src.html +1 -1
  113. package/docs/source/lib/goog/events/listenermap.js.src.html +1 -1
  114. package/docs/source/lib/goog/functions/functions.js.src.html +1 -1
  115. package/docs/source/lib/goog/iter/iter.js.src.html +1 -1
  116. package/docs/source/lib/goog/json/json.js.src.html +1 -1
  117. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +1 -1
  118. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +1 -1
  119. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +1 -1
  120. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +1 -1
  121. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +1 -1
  122. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +1 -1
  123. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +1 -1
  124. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +1 -1
  125. package/docs/source/lib/goog/labs/useragent/util.js.src.html +1 -1
  126. package/docs/source/lib/goog/math/box.js.src.html +1 -1
  127. package/docs/source/lib/goog/math/coordinate.js.src.html +1 -1
  128. package/docs/source/lib/goog/math/math.js.src.html +1 -1
  129. package/docs/source/lib/goog/math/rect.js.src.html +1 -1
  130. package/docs/source/lib/goog/math/size.js.src.html +1 -1
  131. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +1 -1
  132. package/docs/source/lib/goog/net/xhrlike.js.src.html +1 -1
  133. package/docs/source/lib/goog/net/xmlhttp.js.src.html +1 -1
  134. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +1 -1
  135. package/docs/source/lib/goog/object/object.js.src.html +1 -1
  136. package/docs/source/lib/goog/reflect/reflect.js.src.html +1 -1
  137. package/docs/source/lib/goog/string/string.js.src.html +1 -1
  138. package/docs/source/lib/goog/structs/collection.js.src.html +1 -1
  139. package/docs/source/lib/goog/structs/map.js.src.html +1 -1
  140. package/docs/source/lib/goog/structs/set.js.src.html +1 -1
  141. package/docs/source/lib/goog/structs/structs.js.src.html +1 -1
  142. package/docs/source/lib/goog/style/style.js.src.html +1 -1
  143. package/docs/source/lib/goog/testing/asserts.js.src.html +1 -1
  144. package/docs/source/lib/goog/testing/asynctestcase.js.src.html +1 -1
  145. package/docs/source/lib/goog/testing/events/events.js.src.html +1 -1
  146. package/docs/source/lib/goog/testing/functionmock.js.src.html +1 -1
  147. package/docs/source/lib/goog/testing/jsunit.js.src.html +1 -1
  148. package/docs/source/lib/goog/testing/loosemock.js.src.html +1 -1
  149. package/docs/source/lib/goog/testing/mock.js.src.html +1 -1
  150. package/docs/source/lib/goog/testing/mockclock.js.src.html +1 -1
  151. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +1 -1
  152. package/docs/source/lib/goog/testing/mockinterface.js.src.html +1 -1
  153. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +1 -1
  154. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +1 -1
  155. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +1 -1
  156. package/docs/source/lib/goog/testing/recordfunction.js.src.html +1 -1
  157. package/docs/source/lib/goog/testing/stacktrace.js.src.html +1 -1
  158. package/docs/source/lib/goog/testing/strictmock.js.src.html +1 -1
  159. package/docs/source/lib/goog/testing/testcase.js.src.html +1 -1
  160. package/docs/source/lib/goog/testing/testrunner.js.src.html +1 -1
  161. package/docs/source/lib/goog/testing/watchers.js.src.html +1 -1
  162. package/docs/source/lib/goog/uri/uri.js.src.html +1 -1
  163. package/docs/source/lib/goog/uri/utils.js.src.html +1 -1
  164. package/docs/source/lib/goog/useragent/product.js.src.html +1 -1
  165. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +1 -1
  166. package/docs/source/lib/goog/useragent/useragent.js.src.html +1 -1
  167. package/docs/source/lib/webdriver/abstractbuilder.js.src.html +1 -1
  168. package/docs/source/lib/webdriver/actionsequence.js.src.html +1 -1
  169. package/docs/source/lib/webdriver/builder.js.src.html +1 -1
  170. package/docs/source/lib/webdriver/button.js.src.html +1 -1
  171. package/docs/source/lib/webdriver/capabilities.js.src.html +1 -1
  172. package/docs/source/lib/webdriver/command.js.src.html +1 -1
  173. package/docs/source/lib/webdriver/events.js.src.html +1 -1
  174. package/docs/source/lib/webdriver/firefoxdomexecutor.js.src.html +1 -1
  175. package/docs/source/lib/webdriver/http/corsclient.js.src.html +1 -1
  176. package/docs/source/lib/webdriver/http/http.js.src.html +1 -1
  177. package/docs/source/lib/webdriver/http/xhrclient.js.src.html +1 -1
  178. package/docs/source/lib/webdriver/key.js.src.html +1 -1
  179. package/docs/source/lib/webdriver/locators.js.src.html +1 -1
  180. package/docs/source/lib/webdriver/logging.js.src.html +1 -1
  181. package/docs/source/lib/webdriver/process.js.src.html +1 -1
  182. package/docs/source/lib/webdriver/promise.js.src.html +1 -1
  183. package/docs/source/lib/webdriver/session.js.src.html +1 -1
  184. package/docs/source/lib/webdriver/stacktrace.js.src.html +1 -1
  185. package/docs/source/lib/webdriver/testing/asserts.js.src.html +1 -1
  186. package/docs/source/lib/webdriver/testing/testcase.js.src.html +1 -1
  187. package/docs/source/lib/webdriver/until.js.src.html +1 -0
  188. package/docs/source/lib/webdriver/webdriver.js.src.html +1 -1
  189. package/docs/source/net/index.js.src.html +1 -1
  190. package/docs/source/net/portprober.js.src.html +1 -1
  191. package/docs/source/phantomjs.js.src.html +1 -1
  192. package/docs/source/proxy.js.src.html +1 -1
  193. package/docs/source/remote/index.js.src.html +1 -1
  194. package/docs/source/testing/assert.js.src.html +1 -1
  195. package/docs/source/testing/index.js.src.html +1 -1
  196. package/docs/types.js +1 -1
  197. package/example/google_search.js +9 -17
  198. package/example/google_search_generator.js +6 -7
  199. package/example/google_search_test.js +10 -18
  200. package/example/parallel_flows.js +4 -7
  201. package/index.js +6 -0
  202. package/lib/firefox/webdriver.xpi +0 -0
  203. package/lib/goog/deps.js +7 -5
  204. package/lib/test/index.js +0 -8
  205. package/lib/webdriver/promise.js +263 -251
  206. package/lib/webdriver/stacktrace.js +15 -1
  207. package/lib/webdriver/test/promise_flow_test.js +82 -76
  208. package/lib/webdriver/test/promise_test.js +22 -62
  209. package/lib/webdriver/test/stacktrace_test.js +18 -0
  210. package/lib/webdriver/test/until_test.js +388 -0
  211. package/lib/webdriver/test/webdriver_test.js +41 -0
  212. package/lib/webdriver/until.js +408 -0
  213. package/lib/webdriver/webdriver.js +91 -29
  214. package/package.json +2 -2
  215. package/test/element_finding_test.js +6 -6
  216. package/test/http/util_test.js +4 -5
  217. package/test/page_loading_test.js +7 -7
  218. package/test/stale_element_test.js +2 -10
  219. package/testing/index.js +9 -22
package/docs/source/lib/webdriver/testing/asserts.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>asserts.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/asserts.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 &quot;License&quot;);<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 &quot;AS IS&quot; 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 Assertions and expectation utilities for use in WebDriver test<tr><td><a name="l17" href="#l17">17</a><td> * cases.<tr><td><a name="l18" href="#l18">18</a><td> */<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;webdriver.testing.Assertion&#39;);<tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;webdriver.testing.ContainsMatcher&#39;);<tr><td><a name="l22" href="#l22">22</a><td>goog.provide(&#39;webdriver.testing.NegatedAssertion&#39;);<tr><td><a name="l23" href="#l23">23</a><td>goog.provide(&#39;webdriver.testing.assert&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.provide(&#39;webdriver.testing.asserts&#39;);<tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td>goog.require(&#39;goog.array&#39;);<tr><td><a name="l27" href="#l27">27</a><td>goog.require(&#39;goog.labs.testing.CloseToMatcher&#39;);<tr><td><a name="l28" href="#l28">28</a><td>goog.require(&#39;goog.labs.testing.EndsWithMatcher&#39;);<tr><td><a name="l29" href="#l29">29</a><td>goog.require(&#39;goog.labs.testing.EqualToMatcher&#39;);<tr><td><a name="l30" href="#l30">30</a><td>goog.require(&#39;goog.labs.testing.EqualsMatcher&#39;);<tr><td><a name="l31" href="#l31">31</a><td>goog.require(&#39;goog.labs.testing.GreaterThanEqualToMatcher&#39;);<tr><td><a name="l32" href="#l32">32</a><td>goog.require(&#39;goog.labs.testing.GreaterThanMatcher&#39;);<tr><td><a name="l33" href="#l33">33</a><td>goog.require(&#39;goog.labs.testing.LessThanEqualToMatcher&#39;);<tr><td><a name="l34" href="#l34">34</a><td>goog.require(&#39;goog.labs.testing.LessThanMatcher&#39;);<tr><td><a name="l35" href="#l35">35</a><td>goog.require(&#39;goog.labs.testing.InstanceOfMatcher&#39;);<tr><td><a name="l36" href="#l36">36</a><td>goog.require(&#39;goog.labs.testing.IsNotMatcher&#39;);<tr><td><a name="l37" href="#l37">37</a><td>goog.require(&#39;goog.labs.testing.IsNullMatcher&#39;);<tr><td><a name="l38" href="#l38">38</a><td>goog.require(&#39;goog.labs.testing.IsNullOrUndefinedMatcher&#39;);<tr><td><a name="l39" href="#l39">39</a><td>goog.require(&#39;goog.labs.testing.IsUndefinedMatcher&#39;);<tr><td><a name="l40" href="#l40">40</a><td>goog.require(&#39;goog.labs.testing.Matcher&#39;);<tr><td><a name="l41" href="#l41">41</a><td>goog.require(&#39;goog.labs.testing.ObjectEqualsMatcher&#39;);<tr><td><a name="l42" href="#l42">42</a><td>goog.require(&#39;goog.labs.testing.RegexMatcher&#39;);<tr><td><a name="l43" href="#l43">43</a><td>goog.require(&#39;goog.labs.testing.StartsWithMatcher&#39;);<tr><td><a name="l44" href="#l44">44</a><td>goog.require(&#39;goog.labs.testing.assertThat&#39;);<tr><td><a name="l45" href="#l45">45</a><td>goog.require(&#39;goog.string&#39;);<tr><td><a name="l46" href="#l46">46</a><td>goog.require(&#39;webdriver.promise&#39;);<tr><td><a name="l47" href="#l47">47</a><td><tr><td><a name="l48" href="#l48">48</a><td><tr><td><a name="l49" href="#l49">49</a><td>/**<tr><td><a name="l50" href="#l50">50</a><td> * Accepts strins or array-like structures that contain {@code value}.<tr><td><a name="l51" href="#l51">51</a><td> * @param {*} value The value to check for.<tr><td><a name="l52" href="#l52">52</a><td> * @constructor<tr><td><a name="l53" href="#l53">53</a><td> * @implements {goog.labs.testing.Matcher}<tr><td><a name="l54" href="#l54">54</a><td> */<tr><td><a name="l55" href="#l55">55</a><td>webdriver.testing.ContainsMatcher = function(value) {<tr><td><a name="l56" href="#l56">56</a><td> /** @private {*} */<tr><td><a name="l57" href="#l57">57</a><td> this.value_ = value;<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>webdriver.testing.ContainsMatcher.prototype.matches = function(actualValue) {<tr><td><a name="l63" href="#l63">63</a><td> if (goog.isString(actualValue)) {<tr><td><a name="l64" href="#l64">64</a><td> return goog.string.contains(<tr><td><a name="l65" href="#l65">65</a><td> actualValue, /** @type {string} */(this.value_));<tr><td><a name="l66" href="#l66">66</a><td> } else {<tr><td><a name="l67" href="#l67">67</a><td> return goog.array.contains(<tr><td><a name="l68" href="#l68">68</a><td> /** @type {goog.array.ArrayLike} */(actualValue), this.value_);<tr><td><a name="l69" href="#l69">69</a><td> }<tr><td><a name="l70" href="#l70">70</a><td>};<tr><td><a name="l71" href="#l71">71</a><td><tr><td><a name="l72" href="#l72">72</a><td><tr><td><a name="l73" href="#l73">73</a><td>/** @override */<tr><td><a name="l74" href="#l74">74</a><td>webdriver.testing.ContainsMatcher.prototype.describe = function(actualValue) {<tr><td><a name="l75" href="#l75">75</a><td> return actualValue + &#39; does not contain &#39; + this.value_;<tr><td><a name="l76" href="#l76">76</a><td>};<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>/**<tr><td><a name="l81" href="#l81">81</a><td> * Utility for performing assertions against a given {@code value}. If the<tr><td><a name="l82" href="#l82">82</a><td> * value is a {@link webdriver.promise.Promise}, this assertion will wait<tr><td><a name="l83" href="#l83">83</a><td> * for it to resolve before applying any matchers.<tr><td><a name="l84" href="#l84">84</a><td> * @param {*} value The value to wrap and apply matchers to.<tr><td><a name="l85" href="#l85">85</a><td> * @constructor<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>webdriver.testing.Assertion = function(value) {<tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td> /** @private {*} */<tr><td><a name="l90" href="#l90">90</a><td> this.value_ = value;<tr><td><a name="l91" href="#l91">91</a><td><tr><td><a name="l92" href="#l92">92</a><td> if (!(this instanceof webdriver.testing.NegatedAssertion)) {<tr><td><a name="l93" href="#l93">93</a><td> /**<tr><td><a name="l94" href="#l94">94</a><td> * A self reference provided for writing fluent assertions:<tr><td><a name="l95" href="#l95">95</a><td> * webdriver.testing.assert(x).is.equalTo(y);<tr><td><a name="l96" href="#l96">96</a><td> * @type {!webdriver.testing.Assertion}<tr><td><a name="l97" href="#l97">97</a><td> */<tr><td><a name="l98" href="#l98">98</a><td> this.is = this;<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> * Negates any matchers applied to this instance&#39;s value:<tr><td><a name="l102" href="#l102">102</a><td> * webdriver.testing.assert(x).not.equalTo(y);<tr><td><a name="l103" href="#l103">103</a><td> * @type {!webdriver.testing.NegatedAssertion}<tr><td><a name="l104" href="#l104">104</a><td> */<tr><td><a name="l105" href="#l105">105</a><td> this.not = new webdriver.testing.NegatedAssertion(value);<tr><td><a name="l106" href="#l106">106</a><td> }<tr><td><a name="l107" href="#l107">107</a><td>};<tr><td><a name="l108" href="#l108">108</a><td><tr><td><a name="l109" href="#l109">109</a><td><tr><td><a name="l110" href="#l110">110</a><td>/**<tr><td><a name="l111" href="#l111">111</a><td> * Wraps an object literal implementing the Matcher interface. This is used<tr><td><a name="l112" href="#l112">112</a><td> * to appease the Closure compiler, which will not treat an object literal as<tr><td><a name="l113" href="#l113">113</a><td> * implementing an interface.<tr><td><a name="l114" href="#l114">114</a><td> * @param {{matches: function(*): boolean, describe: function(): string}} obj<tr><td><a name="l115" href="#l115">115</a><td> * The object literal to delegate to.<tr><td><a name="l116" href="#l116">116</a><td> * @constructor<tr><td><a name="l117" href="#l117">117</a><td> * @implements {goog.labs.testing.Matcher}<tr><td><a name="l118" href="#l118">118</a><td> * @private<tr><td><a name="l119" href="#l119">119</a><td> */<tr><td><a name="l120" href="#l120">120</a><td>webdriver.testing.Assertion.DelegatingMatcher_ = function(obj) {<tr><td><a name="l121" href="#l121">121</a><td><tr><td><a name="l122" href="#l122">122</a><td> /** @override */<tr><td><a name="l123" href="#l123">123</a><td> this.matches = function(value) {<tr><td><a name="l124" href="#l124">124</a><td> return obj.matches(value);<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> /** @override */<tr><td><a name="l128" href="#l128">128</a><td> this.describe = function() {<tr><td><a name="l129" href="#l129">129</a><td> return obj.describe();<tr><td><a name="l130" href="#l130">130</a><td> };<tr><td><a name="l131" href="#l131">131</a><td>};<tr><td><a name="l132" href="#l132">132</a><td><tr><td><a name="l133" href="#l133">133</a><td><tr><td><a name="l134" href="#l134">134</a><td>/**<tr><td><a name="l135" href="#l135">135</a><td> * Asserts that the given {@code matcher} accepts the value wrapped by this<tr><td><a name="l136" href="#l136">136</a><td> * instance. If the wrapped value is a promise, this function will defer<tr><td><a name="l137" href="#l137">137</a><td> * applying the assertion until the value has been resolved. Otherwise, it<tr><td><a name="l138" href="#l138">138</a><td> * will be applied immediately.<tr><td><a name="l139" href="#l139">139</a><td> * @param {!goog.labs.testing.Matcher} matcher The matcher to apply<tr><td><a name="l140" href="#l140">140</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l141" href="#l141">141</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l142" href="#l142">142</a><td> * @return {webdriver.promise.Promise} The deferred assertion result, or<tr><td><a name="l143" href="#l143">143</a><td> * {@code null} if the assertion was immediately applied.<tr><td><a name="l144" href="#l144">144</a><td> * @protected<tr><td><a name="l145" href="#l145">145</a><td> */<tr><td><a name="l146" href="#l146">146</a><td>webdriver.testing.Assertion.prototype.apply = function(matcher, opt_message) {<tr><td><a name="l147" href="#l147">147</a><td> var result = null;<tr><td><a name="l148" href="#l148">148</a><td> if (webdriver.promise.isPromise(this.value_)) {<tr><td><a name="l149" href="#l149">149</a><td> result = webdriver.promise.when(this.value_, function(value) {<tr><td><a name="l150" href="#l150">150</a><td> goog.labs.testing.assertThat(value, matcher, opt_message);<tr><td><a name="l151" href="#l151">151</a><td> });<tr><td><a name="l152" href="#l152">152</a><td> } else {<tr><td><a name="l153" href="#l153">153</a><td> goog.labs.testing.assertThat(this.value_, matcher, opt_message);<tr><td><a name="l154" href="#l154">154</a><td> }<tr><td><a name="l155" href="#l155">155</a><td> return result;<tr><td><a name="l156" href="#l156">156</a><td>};<tr><td><a name="l157" href="#l157">157</a><td><tr><td><a name="l158" href="#l158">158</a><td><tr><td><a name="l159" href="#l159">159</a><td>/**<tr><td><a name="l160" href="#l160">160</a><td> * Asserts that the value managed by this assertion is a number strictly<tr><td><a name="l161" href="#l161">161</a><td> * greater than {@code value}.<tr><td><a name="l162" href="#l162">162</a><td> * @param {number} value The minimum value.<tr><td><a name="l163" href="#l163">163</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l164" href="#l164">164</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l165" href="#l165">165</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l166" href="#l166">166</a><td> */<tr><td><a name="l167" href="#l167">167</a><td>webdriver.testing.Assertion.prototype.greaterThan = function(<tr><td><a name="l168" href="#l168">168</a><td> value, opt_message) {<tr><td><a name="l169" href="#l169">169</a><td> return this.apply(<tr><td><a name="l170" href="#l170">170</a><td> new goog.labs.testing.GreaterThanMatcher(value), opt_message);<tr><td><a name="l171" href="#l171">171</a><td>};<tr><td><a name="l172" href="#l172">172</a><td><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> * Asserts that the value managed by this assertion is a number &gt;= the given<tr><td><a name="l176" href="#l176">176</a><td> * value.<tr><td><a name="l177" href="#l177">177</a><td> * @param {number} value The minimum value.<tr><td><a name="l178" href="#l178">178</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l179" href="#l179">179</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l180" href="#l180">180</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l181" href="#l181">181</a><td> */<tr><td><a name="l182" href="#l182">182</a><td>webdriver.testing.Assertion.prototype.greaterThanEqualTo = function(<tr><td><a name="l183" href="#l183">183</a><td> value, opt_message) {<tr><td><a name="l184" href="#l184">184</a><td> return this.apply(<tr><td><a name="l185" href="#l185">185</a><td> new goog.labs.testing.GreaterThanEqualToMatcher(value), opt_message);<tr><td><a name="l186" href="#l186">186</a><td>};<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> * Asserts that the value managed by this assertion is a number strictly less<tr><td><a name="l191" href="#l191">191</a><td> * than the given value.<tr><td><a name="l192" href="#l192">192</a><td> * @param {number} value The maximum value.<tr><td><a name="l193" href="#l193">193</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l194" href="#l194">194</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l195" href="#l195">195</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l196" href="#l196">196</a><td> */<tr><td><a name="l197" href="#l197">197</a><td>webdriver.testing.Assertion.prototype.lessThan = function(value, opt_message) {<tr><td><a name="l198" href="#l198">198</a><td> return this.apply(<tr><td><a name="l199" href="#l199">199</a><td> new goog.labs.testing.LessThanMatcher(value), opt_message);<tr><td><a name="l200" href="#l200">200</a><td>};<tr><td><a name="l201" href="#l201">201</a><td><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> * Asserts that the value managed by this assertion is a number &lt;= the given<tr><td><a name="l205" href="#l205">205</a><td> * value.<tr><td><a name="l206" href="#l206">206</a><td> * @param {number} value The maximum value.<tr><td><a name="l207" href="#l207">207</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l208" href="#l208">208</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l209" href="#l209">209</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l210" href="#l210">210</a><td> */<tr><td><a name="l211" href="#l211">211</a><td>webdriver.testing.Assertion.prototype.lessThanEqualTo = function(<tr><td><a name="l212" href="#l212">212</a><td> value, opt_message) {<tr><td><a name="l213" href="#l213">213</a><td> return this.apply(<tr><td><a name="l214" href="#l214">214</a><td> new goog.labs.testing.LessThanEqualToMatcher(value), opt_message);<tr><td><a name="l215" href="#l215">215</a><td>};<tr><td><a name="l216" href="#l216">216</a><td><tr><td><a name="l217" href="#l217">217</a><td><tr><td><a name="l218" href="#l218">218</a><td>/**<tr><td><a name="l219" href="#l219">219</a><td> * Asserts that the wrapped value is a number within a given distance of an<tr><td><a name="l220" href="#l220">220</a><td> * expected value.<tr><td><a name="l221" href="#l221">221</a><td> * @param {number} value The expected value.<tr><td><a name="l222" href="#l222">222</a><td> * @param {number} range The maximum amount the actual value is permitted to<tr><td><a name="l223" href="#l223">223</a><td> * differ from the expected value.<tr><td><a name="l224" href="#l224">224</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l225" href="#l225">225</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l226" href="#l226">226</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l227" href="#l227">227</a><td> */<tr><td><a name="l228" href="#l228">228</a><td>webdriver.testing.Assertion.prototype.closeTo = function(<tr><td><a name="l229" href="#l229">229</a><td> value, range, opt_message) {<tr><td><a name="l230" href="#l230">230</a><td> return this.apply(<tr><td><a name="l231" href="#l231">231</a><td> new goog.labs.testing.CloseToMatcher(value, range), opt_message);<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>/**<tr><td><a name="l236" href="#l236">236</a><td> * Asserts that the wrapped value is an instance of the given class.<tr><td><a name="l237" href="#l237">237</a><td> * @param {!Function} ctor The expected class constructor.<tr><td><a name="l238" href="#l238">238</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l239" href="#l239">239</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l240" href="#l240">240</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l241" href="#l241">241</a><td> */<tr><td><a name="l242" href="#l242">242</a><td>webdriver.testing.Assertion.prototype.instanceOf = function(ctor, opt_message) {<tr><td><a name="l243" href="#l243">243</a><td> return this.apply(<tr><td><a name="l244" href="#l244">244</a><td> new goog.labs.testing.InstanceOfMatcher(ctor), opt_message);<tr><td><a name="l245" href="#l245">245</a><td>};<tr><td><a name="l246" href="#l246">246</a><td><tr><td><a name="l247" href="#l247">247</a><td><tr><td><a name="l248" href="#l248">248</a><td>/**<tr><td><a name="l249" href="#l249">249</a><td> * Asserts that the wrapped value is null.<tr><td><a name="l250" href="#l250">250</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l251" href="#l251">251</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l252" href="#l252">252</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l253" href="#l253">253</a><td> */<tr><td><a name="l254" href="#l254">254</a><td>webdriver.testing.Assertion.prototype.isNull = function(opt_message) {<tr><td><a name="l255" href="#l255">255</a><td> return this.apply(new goog.labs.testing.IsNullMatcher(), opt_message);<tr><td><a name="l256" href="#l256">256</a><td>};<tr><td><a name="l257" href="#l257">257</a><td><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> * Asserts that the wrapped value is undefined.<tr><td><a name="l261" href="#l261">261</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l262" href="#l262">262</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l263" href="#l263">263</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l264" href="#l264">264</a><td> */<tr><td><a name="l265" href="#l265">265</a><td>webdriver.testing.Assertion.prototype.isUndefined = function(opt_message) {<tr><td><a name="l266" href="#l266">266</a><td> return this.apply(new goog.labs.testing.IsUndefinedMatcher(), opt_message);<tr><td><a name="l267" href="#l267">267</a><td>};<tr><td><a name="l268" href="#l268">268</a><td><tr><td><a name="l269" href="#l269">269</a><td><tr><td><a name="l270" href="#l270">270</a><td>/**<tr><td><a name="l271" href="#l271">271</a><td> * Asserts that the wrapped value is null or undefined.<tr><td><a name="l272" href="#l272">272</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l273" href="#l273">273</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l274" href="#l274">274</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l275" href="#l275">275</a><td> */<tr><td><a name="l276" href="#l276">276</a><td>webdriver.testing.Assertion.prototype.isNullOrUndefined = function(<tr><td><a name="l277" href="#l277">277</a><td> opt_message) {<tr><td><a name="l278" href="#l278">278</a><td> return this.apply(<tr><td><a name="l279" href="#l279">279</a><td> new goog.labs.testing.IsNullOrUndefinedMatcher(), opt_message);<tr><td><a name="l280" href="#l280">280</a><td>};<tr><td><a name="l281" href="#l281">281</a><td><tr><td><a name="l282" href="#l282">282</a><td><tr><td><a name="l283" href="#l283">283</a><td>/**<tr><td><a name="l284" href="#l284">284</a><td> * Asserts that the wrapped value is a string or array-like structure<tr><td><a name="l285" href="#l285">285</a><td> * containing the given value.<tr><td><a name="l286" href="#l286">286</a><td> * @param {*} value The expected value.<tr><td><a name="l287" href="#l287">287</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l288" href="#l288">288</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l289" href="#l289">289</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l290" href="#l290">290</a><td> */<tr><td><a name="l291" href="#l291">291</a><td>webdriver.testing.Assertion.prototype.contains = function(value, opt_message) {<tr><td><a name="l292" href="#l292">292</a><td> return this.apply(<tr><td><a name="l293" href="#l293">293</a><td> new webdriver.testing.ContainsMatcher(value), opt_message);<tr><td><a name="l294" href="#l294">294</a><td>};<tr><td><a name="l295" href="#l295">295</a><td><tr><td><a name="l296" href="#l296">296</a><td><tr><td><a name="l297" href="#l297">297</a><td>/**<tr><td><a name="l298" href="#l298">298</a><td> * Asserts that the wrapped value is a string ending with the given suffix.<tr><td><a name="l299" href="#l299">299</a><td> * @param {string} suffix The expected suffix.<tr><td><a name="l300" href="#l300">300</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l301" href="#l301">301</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l302" href="#l302">302</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l303" href="#l303">303</a><td> */<tr><td><a name="l304" href="#l304">304</a><td>webdriver.testing.Assertion.prototype.endsWith = function(<tr><td><a name="l305" href="#l305">305</a><td> suffix, opt_message) {<tr><td><a name="l306" href="#l306">306</a><td> return this.apply(<tr><td><a name="l307" href="#l307">307</a><td> new goog.labs.testing.EndsWithMatcher(suffix), opt_message);<tr><td><a name="l308" href="#l308">308</a><td>};<tr><td><a name="l309" href="#l309">309</a><td><tr><td><a name="l310" href="#l310">310</a><td><tr><td><a name="l311" href="#l311">311</a><td>/**<tr><td><a name="l312" href="#l312">312</a><td> * Asserts that the wrapped value is a string starting with the given prefix.<tr><td><a name="l313" href="#l313">313</a><td> * @param {string} prefix The expected prefix.<tr><td><a name="l314" href="#l314">314</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l315" href="#l315">315</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l316" href="#l316">316</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l317" href="#l317">317</a><td> */<tr><td><a name="l318" href="#l318">318</a><td>webdriver.testing.Assertion.prototype.startsWith = function(<tr><td><a name="l319" href="#l319">319</a><td> prefix, opt_message) {<tr><td><a name="l320" href="#l320">320</a><td> return this.apply(<tr><td><a name="l321" href="#l321">321</a><td> new goog.labs.testing.StartsWithMatcher(prefix), opt_message);<tr><td><a name="l322" href="#l322">322</a><td>};<tr><td><a name="l323" href="#l323">323</a><td><tr><td><a name="l324" href="#l324">324</a><td><tr><td><a name="l325" href="#l325">325</a><td>/**<tr><td><a name="l326" href="#l326">326</a><td> * Asserts that the wrapped value is a string that matches the given RegExp.<tr><td><a name="l327" href="#l327">327</a><td> * @param {!RegExp} regex The regex to test.<tr><td><a name="l328" href="#l328">328</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l329" href="#l329">329</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l330" href="#l330">330</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l331" href="#l331">331</a><td> */<tr><td><a name="l332" href="#l332">332</a><td>webdriver.testing.Assertion.prototype.matches = function(regex, opt_message) {<tr><td><a name="l333" href="#l333">333</a><td> return this.apply(new goog.labs.testing.RegexMatcher(regex), opt_message);<tr><td><a name="l334" href="#l334">334</a><td>};<tr><td><a name="l335" href="#l335">335</a><td><tr><td><a name="l336" href="#l336">336</a><td><tr><td><a name="l337" href="#l337">337</a><td>/**<tr><td><a name="l338" href="#l338">338</a><td> * Asserts that the value managed by this assertion is strictly equal to the<tr><td><a name="l339" href="#l339">339</a><td> * given {@code value}.<tr><td><a name="l340" href="#l340">340</a><td> * @param {*} value The expected value.<tr><td><a name="l341" href="#l341">341</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l342" href="#l342">342</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l343" href="#l343">343</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l344" href="#l344">344</a><td> */<tr><td><a name="l345" href="#l345">345</a><td>webdriver.testing.Assertion.prototype.equalTo = function(value, opt_message) {<tr><td><a name="l346" href="#l346">346</a><td> return this.apply(webdriver.testing.asserts.equalTo(value), opt_message);<tr><td><a name="l347" href="#l347">347</a><td>};<tr><td><a name="l348" href="#l348">348</a><td><tr><td><a name="l349" href="#l349">349</a><td><tr><td><a name="l350" href="#l350">350</a><td>/**<tr><td><a name="l351" href="#l351">351</a><td> * Asserts that the value managed by this assertion is strictly true.<tr><td><a name="l352" href="#l352">352</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l353" href="#l353">353</a><td> */<tr><td><a name="l354" href="#l354">354</a><td>webdriver.testing.Assertion.prototype.isTrue = function() {<tr><td><a name="l355" href="#l355">355</a><td> return this.equalTo(true);<tr><td><a name="l356" href="#l356">356</a><td>};<tr><td><a name="l357" href="#l357">357</a><td><tr><td><a name="l358" href="#l358">358</a><td><tr><td><a name="l359" href="#l359">359</a><td>/**<tr><td><a name="l360" href="#l360">360</a><td> * Asserts that the value managed by this assertion is strictly false.<tr><td><a name="l361" href="#l361">361</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l362" href="#l362">362</a><td> */<tr><td><a name="l363" href="#l363">363</a><td>webdriver.testing.Assertion.prototype.isFalse = function() {<tr><td><a name="l364" href="#l364">364</a><td> return this.equalTo(false);<tr><td><a name="l365" href="#l365">365</a><td>};<tr><td><a name="l366" href="#l366">366</a><td><tr><td><a name="l367" href="#l367">367</a><td><tr><td><a name="l368" href="#l368">368</a><td><tr><td><a name="l369" href="#l369">369</a><td>/**<tr><td><a name="l370" href="#l370">370</a><td> * An assertion that negates any applied matchers.<tr><td><a name="l371" href="#l371">371</a><td> * @param {*} value The value to perform assertions on.<tr><td><a name="l372" href="#l372">372</a><td> * @constructor<tr><td><a name="l373" href="#l373">373</a><td> * @extends {webdriver.testing.Assertion}<tr><td><a name="l374" href="#l374">374</a><td> */<tr><td><a name="l375" href="#l375">375</a><td>webdriver.testing.NegatedAssertion = function(value) {<tr><td><a name="l376" href="#l376">376</a><td> goog.base(this, value);<tr><td><a name="l377" href="#l377">377</a><td> this.value = value;<tr><td><a name="l378" href="#l378">378</a><td>};<tr><td><a name="l379" href="#l379">379</a><td>goog.inherits(<tr><td><a name="l380" href="#l380">380</a><td> webdriver.testing.NegatedAssertion, webdriver.testing.Assertion);<tr><td><a name="l381" href="#l381">381</a><td><tr><td><a name="l382" href="#l382">382</a><td><tr><td><a name="l383" href="#l383">383</a><td>/** @override */<tr><td><a name="l384" href="#l384">384</a><td>webdriver.testing.NegatedAssertion.prototype.apply = function(<tr><td><a name="l385" href="#l385">385</a><td> matcher, opt_message) {<tr><td><a name="l386" href="#l386">386</a><td> matcher = new goog.labs.testing.IsNotMatcher(matcher);<tr><td><a name="l387" href="#l387">387</a><td> return goog.base(this, &#39;apply&#39;, matcher, opt_message);<tr><td><a name="l388" href="#l388">388</a><td>};<tr><td><a name="l389" href="#l389">389</a><td><tr><td><a name="l390" href="#l390">390</a><td><tr><td><a name="l391" href="#l391">391</a><td><tr><td><a name="l392" href="#l392">392</a><td>/**<tr><td><a name="l393" href="#l393">393</a><td> * Creates a new assertion.<tr><td><a name="l394" href="#l394">394</a><td> * @param {*} value The value to perform an assertion on.<tr><td><a name="l395" href="#l395">395</a><td> * @return {!webdriver.testing.Assertion} The new assertion.<tr><td><a name="l396" href="#l396">396</a><td> */<tr><td><a name="l397" href="#l397">397</a><td>webdriver.testing.assert = function(value) {<tr><td><a name="l398" href="#l398">398</a><td> return new webdriver.testing.Assertion(value);<tr><td><a name="l399" href="#l399">399</a><td>};<tr><td><a name="l400" href="#l400">400</a><td><tr><td><a name="l401" href="#l401">401</a><td><tr><td><a name="l402" href="#l402">402</a><td>/**<tr><td><a name="l403" href="#l403">403</a><td> * Registers a new assertion to expose from the<tr><td><a name="l404" href="#l404">404</a><td> * {@link webdriver.testing.Assertion} prototype.<tr><td><a name="l405" href="#l405">405</a><td> * @param {string} name The assertion name.<tr><td><a name="l406" href="#l406">406</a><td> * @param {(function(new: goog.labs.testing.Matcher, *)|<tr><td><a name="l407" href="#l407">407</a><td> * {matches: function(*): boolean,<tr><td><a name="l408" href="#l408">408</a><td> * describe: function(): string})} matcherTemplate Either the<tr><td><a name="l409" href="#l409">409</a><td> * matcher constructor to use, or an object literal defining a matcher.<tr><td><a name="l410" href="#l410">410</a><td> */<tr><td><a name="l411" href="#l411">411</a><td>webdriver.testing.assert.register = function(name, matcherTemplate) {<tr><td><a name="l412" href="#l412">412</a><td> webdriver.testing.Assertion.prototype[name] = function(value, opt_message) {<tr><td><a name="l413" href="#l413">413</a><td> var matcher;<tr><td><a name="l414" href="#l414">414</a><td> if (goog.isFunction(matcherTemplate)) {<tr><td><a name="l415" href="#l415">415</a><td> var ctor = /** @type {function(new: goog.labs.testing.Matcher, *)} */ (<tr><td><a name="l416" href="#l416">416</a><td> matcherTemplate);<tr><td><a name="l417" href="#l417">417</a><td> matcher = new ctor(value);<tr><td><a name="l418" href="#l418">418</a><td> } else {<tr><td><a name="l419" href="#l419">419</a><td> matcher = new webdriver.testing.Assertion.DelegatingMatcher_(value);<tr><td><a name="l420" href="#l420">420</a><td> }<tr><td><a name="l421" href="#l421">421</a><td> return this.apply(matcher, opt_message);<tr><td><a name="l422" href="#l422">422</a><td> };<tr><td><a name="l423" href="#l423">423</a><td>};<tr><td><a name="l424" href="#l424">424</a><td><tr><td><a name="l425" href="#l425">425</a><td><tr><td><a name="l426" href="#l426">426</a><td>/**<tr><td><a name="l427" href="#l427">427</a><td> * Asserts that a matcher accepts a given value. This function has two<tr><td><a name="l428" href="#l428">428</a><td> * signatures based on the number of arguments:<tr><td><a name="l429" href="#l429">429</a><td> *<tr><td><a name="l430" href="#l430">430</a><td> * Two arguments:<tr><td><a name="l431" href="#l431">431</a><td> * assertThat(actualValue, matcher)<tr><td><a name="l432" href="#l432">432</a><td> * Three arguments:<tr><td><a name="l433" href="#l433">433</a><td> * assertThat(failureMessage, actualValue, matcher)<tr><td><a name="l434" href="#l434">434</a><td> *<tr><td><a name="l435" href="#l435">435</a><td> * @param {*} failureMessageOrActualValue Either a failure message or the value<tr><td><a name="l436" href="#l436">436</a><td> * to apply to the given matcher.<tr><td><a name="l437" href="#l437">437</a><td> * @param {*} actualValueOrMatcher Either the value to apply to the given<tr><td><a name="l438" href="#l438">438</a><td> * matcher, or the matcher itself.<tr><td><a name="l439" href="#l439">439</a><td> * @param {goog.labs.testing.Matcher=} opt_matcher The matcher to use;<tr><td><a name="l440" href="#l440">440</a><td> * ignored unless this function is invoked with three arguments.<tr><td><a name="l441" href="#l441">441</a><td> * @return {!webdriver.promise.Promise} The assertion result.<tr><td><a name="l442" href="#l442">442</a><td> * @deprecated Use webdriver.testing.asserts.assert instead.<tr><td><a name="l443" href="#l443">443</a><td> */<tr><td><a name="l444" href="#l444">444</a><td>webdriver.testing.asserts.assertThat = function(<tr><td><a name="l445" href="#l445">445</a><td> failureMessageOrActualValue, actualValueOrMatcher, opt_matcher) {<tr><td><a name="l446" href="#l446">446</a><td> var args = goog.array.slice(arguments, 0);<tr><td><a name="l447" href="#l447">447</a><td><tr><td><a name="l448" href="#l448">448</a><td> var message = args.length &gt; 2 ? args.shift() : &#39;&#39;;<tr><td><a name="l449" href="#l449">449</a><td> if (message) message += &#39;\n&#39;;<tr><td><a name="l450" href="#l450">450</a><td><tr><td><a name="l451" href="#l451">451</a><td> var actualValue = args.shift();<tr><td><a name="l452" href="#l452">452</a><td> var matcher = args.shift();<tr><td><a name="l453" href="#l453">453</a><td><tr><td><a name="l454" href="#l454">454</a><td> return webdriver.promise.when(actualValue, function(value) {<tr><td><a name="l455" href="#l455">455</a><td> goog.labs.testing.assertThat(value, matcher, message);<tr><td><a name="l456" href="#l456">456</a><td> });<tr><td><a name="l457" href="#l457">457</a><td>};<tr><td><a name="l458" href="#l458">458</a><td><tr><td><a name="l459" href="#l459">459</a><td><tr><td><a name="l460" href="#l460">460</a><td>/**<tr><td><a name="l461" href="#l461">461</a><td> * Creates an equality matcher.<tr><td><a name="l462" href="#l462">462</a><td> * @param {*} expected The expected value.<tr><td><a name="l463" href="#l463">463</a><td> * @return {!goog.labs.testing.Matcher} The new matcher.<tr><td><a name="l464" href="#l464">464</a><td> */<tr><td><a name="l465" href="#l465">465</a><td>webdriver.testing.asserts.equalTo = function(expected) {<tr><td><a name="l466" href="#l466">466</a><td> if (goog.isString(expected)) {<tr><td><a name="l467" href="#l467">467</a><td> return new goog.labs.testing.EqualsMatcher(expected);<tr><td><a name="l468" href="#l468">468</a><td> } else if (goog.isNumber(expected)) {<tr><td><a name="l469" href="#l469">469</a><td> return new goog.labs.testing.EqualToMatcher(expected);<tr><td><a name="l470" href="#l470">470</a><td> } else {<tr><td><a name="l471" href="#l471">471</a><td> return new goog.labs.testing.ObjectEqualsMatcher(<tr><td><a name="l472" href="#l472">472</a><td> /** @type {!Object} */ (expected));<tr><td><a name="l473" href="#l473">473</a><td> }<tr><td><a name="l474" href="#l474">474</a><td>};<tr><td><a name="l475" href="#l475">475</a><td><tr><td><a name="l476" href="#l476">476</a><td><tr><td><a name="l477" href="#l477">477</a><td>goog.exportSymbol(&#39;assertThat&#39;, webdriver.testing.asserts.assertThat);<tr><td><a name="l478" href="#l478">478</a><td>// Mappings for goog.labs.testing matcher functions to the legacy<tr><td><a name="l479" href="#l479">479</a><td>// webdriver.testing.asserts matchers.<tr><td><a name="l480" href="#l480">480</a><td>goog.exportSymbol(&#39;contains&#39;, containsString);<tr><td><a name="l481" href="#l481">481</a><td>goog.exportSymbol(&#39;equalTo&#39;, webdriver.testing.asserts.equalTo);<tr><td><a name="l482" href="#l482">482</a><td>goog.exportSymbol(&#39;equals&#39;, webdriver.testing.asserts.equalTo);<tr><td><a name="l483" href="#l483">483</a><td>goog.exportSymbol(&#39;is&#39;, webdriver.testing.asserts.equalTo);<tr><td><a name="l484" href="#l484">484</a><td>goog.exportSymbol(&#39;not&#39;, isNot);<tr><td><a name="l485" href="#l485">485</a><td>goog.exportSymbol(&#39;or&#39;, anyOf);</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>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>asserts.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/asserts.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 &quot;License&quot;);<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 &quot;AS IS&quot; 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 Assertions and expectation utilities for use in WebDriver test<tr><td><a name="l17" href="#l17">17</a><td> * cases.<tr><td><a name="l18" href="#l18">18</a><td> */<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;webdriver.testing.Assertion&#39;);<tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;webdriver.testing.ContainsMatcher&#39;);<tr><td><a name="l22" href="#l22">22</a><td>goog.provide(&#39;webdriver.testing.NegatedAssertion&#39;);<tr><td><a name="l23" href="#l23">23</a><td>goog.provide(&#39;webdriver.testing.assert&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.provide(&#39;webdriver.testing.asserts&#39;);<tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td>goog.require(&#39;goog.array&#39;);<tr><td><a name="l27" href="#l27">27</a><td>goog.require(&#39;goog.labs.testing.CloseToMatcher&#39;);<tr><td><a name="l28" href="#l28">28</a><td>goog.require(&#39;goog.labs.testing.EndsWithMatcher&#39;);<tr><td><a name="l29" href="#l29">29</a><td>goog.require(&#39;goog.labs.testing.EqualToMatcher&#39;);<tr><td><a name="l30" href="#l30">30</a><td>goog.require(&#39;goog.labs.testing.EqualsMatcher&#39;);<tr><td><a name="l31" href="#l31">31</a><td>goog.require(&#39;goog.labs.testing.GreaterThanEqualToMatcher&#39;);<tr><td><a name="l32" href="#l32">32</a><td>goog.require(&#39;goog.labs.testing.GreaterThanMatcher&#39;);<tr><td><a name="l33" href="#l33">33</a><td>goog.require(&#39;goog.labs.testing.LessThanEqualToMatcher&#39;);<tr><td><a name="l34" href="#l34">34</a><td>goog.require(&#39;goog.labs.testing.LessThanMatcher&#39;);<tr><td><a name="l35" href="#l35">35</a><td>goog.require(&#39;goog.labs.testing.InstanceOfMatcher&#39;);<tr><td><a name="l36" href="#l36">36</a><td>goog.require(&#39;goog.labs.testing.IsNotMatcher&#39;);<tr><td><a name="l37" href="#l37">37</a><td>goog.require(&#39;goog.labs.testing.IsNullMatcher&#39;);<tr><td><a name="l38" href="#l38">38</a><td>goog.require(&#39;goog.labs.testing.IsNullOrUndefinedMatcher&#39;);<tr><td><a name="l39" href="#l39">39</a><td>goog.require(&#39;goog.labs.testing.IsUndefinedMatcher&#39;);<tr><td><a name="l40" href="#l40">40</a><td>goog.require(&#39;goog.labs.testing.Matcher&#39;);<tr><td><a name="l41" href="#l41">41</a><td>goog.require(&#39;goog.labs.testing.ObjectEqualsMatcher&#39;);<tr><td><a name="l42" href="#l42">42</a><td>goog.require(&#39;goog.labs.testing.RegexMatcher&#39;);<tr><td><a name="l43" href="#l43">43</a><td>goog.require(&#39;goog.labs.testing.StartsWithMatcher&#39;);<tr><td><a name="l44" href="#l44">44</a><td>goog.require(&#39;goog.labs.testing.assertThat&#39;);<tr><td><a name="l45" href="#l45">45</a><td>goog.require(&#39;goog.string&#39;);<tr><td><a name="l46" href="#l46">46</a><td>goog.require(&#39;webdriver.promise&#39;);<tr><td><a name="l47" href="#l47">47</a><td><tr><td><a name="l48" href="#l48">48</a><td><tr><td><a name="l49" href="#l49">49</a><td>/**<tr><td><a name="l50" href="#l50">50</a><td> * Accepts strins or array-like structures that contain {@code value}.<tr><td><a name="l51" href="#l51">51</a><td> * @param {*} value The value to check for.<tr><td><a name="l52" href="#l52">52</a><td> * @constructor<tr><td><a name="l53" href="#l53">53</a><td> * @implements {goog.labs.testing.Matcher}<tr><td><a name="l54" href="#l54">54</a><td> */<tr><td><a name="l55" href="#l55">55</a><td>webdriver.testing.ContainsMatcher = function(value) {<tr><td><a name="l56" href="#l56">56</a><td> /** @private {*} */<tr><td><a name="l57" href="#l57">57</a><td> this.value_ = value;<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>webdriver.testing.ContainsMatcher.prototype.matches = function(actualValue) {<tr><td><a name="l63" href="#l63">63</a><td> if (goog.isString(actualValue)) {<tr><td><a name="l64" href="#l64">64</a><td> return goog.string.contains(<tr><td><a name="l65" href="#l65">65</a><td> actualValue, /** @type {string} */(this.value_));<tr><td><a name="l66" href="#l66">66</a><td> } else {<tr><td><a name="l67" href="#l67">67</a><td> return goog.array.contains(<tr><td><a name="l68" href="#l68">68</a><td> /** @type {goog.array.ArrayLike} */(actualValue), this.value_);<tr><td><a name="l69" href="#l69">69</a><td> }<tr><td><a name="l70" href="#l70">70</a><td>};<tr><td><a name="l71" href="#l71">71</a><td><tr><td><a name="l72" href="#l72">72</a><td><tr><td><a name="l73" href="#l73">73</a><td>/** @override */<tr><td><a name="l74" href="#l74">74</a><td>webdriver.testing.ContainsMatcher.prototype.describe = function(actualValue) {<tr><td><a name="l75" href="#l75">75</a><td> return actualValue + &#39; does not contain &#39; + this.value_;<tr><td><a name="l76" href="#l76">76</a><td>};<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>/**<tr><td><a name="l81" href="#l81">81</a><td> * Utility for performing assertions against a given {@code value}. If the<tr><td><a name="l82" href="#l82">82</a><td> * value is a {@link webdriver.promise.Promise}, this assertion will wait<tr><td><a name="l83" href="#l83">83</a><td> * for it to resolve before applying any matchers.<tr><td><a name="l84" href="#l84">84</a><td> * @param {*} value The value to wrap and apply matchers to.<tr><td><a name="l85" href="#l85">85</a><td> * @constructor<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>webdriver.testing.Assertion = function(value) {<tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td> /** @private {*} */<tr><td><a name="l90" href="#l90">90</a><td> this.value_ = value;<tr><td><a name="l91" href="#l91">91</a><td><tr><td><a name="l92" href="#l92">92</a><td> if (!(this instanceof webdriver.testing.NegatedAssertion)) {<tr><td><a name="l93" href="#l93">93</a><td> /**<tr><td><a name="l94" href="#l94">94</a><td> * A self reference provided for writing fluent assertions:<tr><td><a name="l95" href="#l95">95</a><td> * webdriver.testing.assert(x).is.equalTo(y);<tr><td><a name="l96" href="#l96">96</a><td> * @type {!webdriver.testing.Assertion}<tr><td><a name="l97" href="#l97">97</a><td> */<tr><td><a name="l98" href="#l98">98</a><td> this.is = this;<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> * Negates any matchers applied to this instance&#39;s value:<tr><td><a name="l102" href="#l102">102</a><td> * webdriver.testing.assert(x).not.equalTo(y);<tr><td><a name="l103" href="#l103">103</a><td> * @type {!webdriver.testing.NegatedAssertion}<tr><td><a name="l104" href="#l104">104</a><td> */<tr><td><a name="l105" href="#l105">105</a><td> this.not = new webdriver.testing.NegatedAssertion(value);<tr><td><a name="l106" href="#l106">106</a><td> }<tr><td><a name="l107" href="#l107">107</a><td>};<tr><td><a name="l108" href="#l108">108</a><td><tr><td><a name="l109" href="#l109">109</a><td><tr><td><a name="l110" href="#l110">110</a><td>/**<tr><td><a name="l111" href="#l111">111</a><td> * Wraps an object literal implementing the Matcher interface. This is used<tr><td><a name="l112" href="#l112">112</a><td> * to appease the Closure compiler, which will not treat an object literal as<tr><td><a name="l113" href="#l113">113</a><td> * implementing an interface.<tr><td><a name="l114" href="#l114">114</a><td> * @param {{matches: function(*): boolean, describe: function(): string}} obj<tr><td><a name="l115" href="#l115">115</a><td> * The object literal to delegate to.<tr><td><a name="l116" href="#l116">116</a><td> * @constructor<tr><td><a name="l117" href="#l117">117</a><td> * @implements {goog.labs.testing.Matcher}<tr><td><a name="l118" href="#l118">118</a><td> * @private<tr><td><a name="l119" href="#l119">119</a><td> */<tr><td><a name="l120" href="#l120">120</a><td>webdriver.testing.Assertion.DelegatingMatcher_ = function(obj) {<tr><td><a name="l121" href="#l121">121</a><td><tr><td><a name="l122" href="#l122">122</a><td> /** @override */<tr><td><a name="l123" href="#l123">123</a><td> this.matches = function(value) {<tr><td><a name="l124" href="#l124">124</a><td> return obj.matches(value);<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> /** @override */<tr><td><a name="l128" href="#l128">128</a><td> this.describe = function() {<tr><td><a name="l129" href="#l129">129</a><td> return obj.describe();<tr><td><a name="l130" href="#l130">130</a><td> };<tr><td><a name="l131" href="#l131">131</a><td>};<tr><td><a name="l132" href="#l132">132</a><td><tr><td><a name="l133" href="#l133">133</a><td><tr><td><a name="l134" href="#l134">134</a><td>/**<tr><td><a name="l135" href="#l135">135</a><td> * Asserts that the given {@code matcher} accepts the value wrapped by this<tr><td><a name="l136" href="#l136">136</a><td> * instance. If the wrapped value is a promise, this function will defer<tr><td><a name="l137" href="#l137">137</a><td> * applying the assertion until the value has been resolved. Otherwise, it<tr><td><a name="l138" href="#l138">138</a><td> * will be applied immediately.<tr><td><a name="l139" href="#l139">139</a><td> * @param {!goog.labs.testing.Matcher} matcher The matcher to apply<tr><td><a name="l140" href="#l140">140</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l141" href="#l141">141</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l142" href="#l142">142</a><td> * @return {webdriver.promise.Promise} The deferred assertion result, or<tr><td><a name="l143" href="#l143">143</a><td> * {@code null} if the assertion was immediately applied.<tr><td><a name="l144" href="#l144">144</a><td> * @protected<tr><td><a name="l145" href="#l145">145</a><td> */<tr><td><a name="l146" href="#l146">146</a><td>webdriver.testing.Assertion.prototype.apply = function(matcher, opt_message) {<tr><td><a name="l147" href="#l147">147</a><td> var result = null;<tr><td><a name="l148" href="#l148">148</a><td> if (webdriver.promise.isPromise(this.value_)) {<tr><td><a name="l149" href="#l149">149</a><td> result = webdriver.promise.when(this.value_, function(value) {<tr><td><a name="l150" href="#l150">150</a><td> goog.labs.testing.assertThat(value, matcher, opt_message);<tr><td><a name="l151" href="#l151">151</a><td> });<tr><td><a name="l152" href="#l152">152</a><td> } else {<tr><td><a name="l153" href="#l153">153</a><td> goog.labs.testing.assertThat(this.value_, matcher, opt_message);<tr><td><a name="l154" href="#l154">154</a><td> }<tr><td><a name="l155" href="#l155">155</a><td> return result;<tr><td><a name="l156" href="#l156">156</a><td>};<tr><td><a name="l157" href="#l157">157</a><td><tr><td><a name="l158" href="#l158">158</a><td><tr><td><a name="l159" href="#l159">159</a><td>/**<tr><td><a name="l160" href="#l160">160</a><td> * Asserts that the value managed by this assertion is a number strictly<tr><td><a name="l161" href="#l161">161</a><td> * greater than {@code value}.<tr><td><a name="l162" href="#l162">162</a><td> * @param {number} value The minimum value.<tr><td><a name="l163" href="#l163">163</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l164" href="#l164">164</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l165" href="#l165">165</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l166" href="#l166">166</a><td> */<tr><td><a name="l167" href="#l167">167</a><td>webdriver.testing.Assertion.prototype.greaterThan = function(<tr><td><a name="l168" href="#l168">168</a><td> value, opt_message) {<tr><td><a name="l169" href="#l169">169</a><td> return this.apply(<tr><td><a name="l170" href="#l170">170</a><td> new goog.labs.testing.GreaterThanMatcher(value), opt_message);<tr><td><a name="l171" href="#l171">171</a><td>};<tr><td><a name="l172" href="#l172">172</a><td><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> * Asserts that the value managed by this assertion is a number &gt;= the given<tr><td><a name="l176" href="#l176">176</a><td> * value.<tr><td><a name="l177" href="#l177">177</a><td> * @param {number} value The minimum value.<tr><td><a name="l178" href="#l178">178</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l179" href="#l179">179</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l180" href="#l180">180</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l181" href="#l181">181</a><td> */<tr><td><a name="l182" href="#l182">182</a><td>webdriver.testing.Assertion.prototype.greaterThanEqualTo = function(<tr><td><a name="l183" href="#l183">183</a><td> value, opt_message) {<tr><td><a name="l184" href="#l184">184</a><td> return this.apply(<tr><td><a name="l185" href="#l185">185</a><td> new goog.labs.testing.GreaterThanEqualToMatcher(value), opt_message);<tr><td><a name="l186" href="#l186">186</a><td>};<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> * Asserts that the value managed by this assertion is a number strictly less<tr><td><a name="l191" href="#l191">191</a><td> * than the given value.<tr><td><a name="l192" href="#l192">192</a><td> * @param {number} value The maximum value.<tr><td><a name="l193" href="#l193">193</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l194" href="#l194">194</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l195" href="#l195">195</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l196" href="#l196">196</a><td> */<tr><td><a name="l197" href="#l197">197</a><td>webdriver.testing.Assertion.prototype.lessThan = function(value, opt_message) {<tr><td><a name="l198" href="#l198">198</a><td> return this.apply(<tr><td><a name="l199" href="#l199">199</a><td> new goog.labs.testing.LessThanMatcher(value), opt_message);<tr><td><a name="l200" href="#l200">200</a><td>};<tr><td><a name="l201" href="#l201">201</a><td><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> * Asserts that the value managed by this assertion is a number &lt;= the given<tr><td><a name="l205" href="#l205">205</a><td> * value.<tr><td><a name="l206" href="#l206">206</a><td> * @param {number} value The maximum value.<tr><td><a name="l207" href="#l207">207</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l208" href="#l208">208</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l209" href="#l209">209</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l210" href="#l210">210</a><td> */<tr><td><a name="l211" href="#l211">211</a><td>webdriver.testing.Assertion.prototype.lessThanEqualTo = function(<tr><td><a name="l212" href="#l212">212</a><td> value, opt_message) {<tr><td><a name="l213" href="#l213">213</a><td> return this.apply(<tr><td><a name="l214" href="#l214">214</a><td> new goog.labs.testing.LessThanEqualToMatcher(value), opt_message);<tr><td><a name="l215" href="#l215">215</a><td>};<tr><td><a name="l216" href="#l216">216</a><td><tr><td><a name="l217" href="#l217">217</a><td><tr><td><a name="l218" href="#l218">218</a><td>/**<tr><td><a name="l219" href="#l219">219</a><td> * Asserts that the wrapped value is a number within a given distance of an<tr><td><a name="l220" href="#l220">220</a><td> * expected value.<tr><td><a name="l221" href="#l221">221</a><td> * @param {number} value The expected value.<tr><td><a name="l222" href="#l222">222</a><td> * @param {number} range The maximum amount the actual value is permitted to<tr><td><a name="l223" href="#l223">223</a><td> * differ from the expected value.<tr><td><a name="l224" href="#l224">224</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l225" href="#l225">225</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l226" href="#l226">226</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l227" href="#l227">227</a><td> */<tr><td><a name="l228" href="#l228">228</a><td>webdriver.testing.Assertion.prototype.closeTo = function(<tr><td><a name="l229" href="#l229">229</a><td> value, range, opt_message) {<tr><td><a name="l230" href="#l230">230</a><td> return this.apply(<tr><td><a name="l231" href="#l231">231</a><td> new goog.labs.testing.CloseToMatcher(value, range), opt_message);<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>/**<tr><td><a name="l236" href="#l236">236</a><td> * Asserts that the wrapped value is an instance of the given class.<tr><td><a name="l237" href="#l237">237</a><td> * @param {!Function} ctor The expected class constructor.<tr><td><a name="l238" href="#l238">238</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l239" href="#l239">239</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l240" href="#l240">240</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l241" href="#l241">241</a><td> */<tr><td><a name="l242" href="#l242">242</a><td>webdriver.testing.Assertion.prototype.instanceOf = function(ctor, opt_message) {<tr><td><a name="l243" href="#l243">243</a><td> return this.apply(<tr><td><a name="l244" href="#l244">244</a><td> new goog.labs.testing.InstanceOfMatcher(ctor), opt_message);<tr><td><a name="l245" href="#l245">245</a><td>};<tr><td><a name="l246" href="#l246">246</a><td><tr><td><a name="l247" href="#l247">247</a><td><tr><td><a name="l248" href="#l248">248</a><td>/**<tr><td><a name="l249" href="#l249">249</a><td> * Asserts that the wrapped value is null.<tr><td><a name="l250" href="#l250">250</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l251" href="#l251">251</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l252" href="#l252">252</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l253" href="#l253">253</a><td> */<tr><td><a name="l254" href="#l254">254</a><td>webdriver.testing.Assertion.prototype.isNull = function(opt_message) {<tr><td><a name="l255" href="#l255">255</a><td> return this.apply(new goog.labs.testing.IsNullMatcher(), opt_message);<tr><td><a name="l256" href="#l256">256</a><td>};<tr><td><a name="l257" href="#l257">257</a><td><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> * Asserts that the wrapped value is undefined.<tr><td><a name="l261" href="#l261">261</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l262" href="#l262">262</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l263" href="#l263">263</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l264" href="#l264">264</a><td> */<tr><td><a name="l265" href="#l265">265</a><td>webdriver.testing.Assertion.prototype.isUndefined = function(opt_message) {<tr><td><a name="l266" href="#l266">266</a><td> return this.apply(new goog.labs.testing.IsUndefinedMatcher(), opt_message);<tr><td><a name="l267" href="#l267">267</a><td>};<tr><td><a name="l268" href="#l268">268</a><td><tr><td><a name="l269" href="#l269">269</a><td><tr><td><a name="l270" href="#l270">270</a><td>/**<tr><td><a name="l271" href="#l271">271</a><td> * Asserts that the wrapped value is null or undefined.<tr><td><a name="l272" href="#l272">272</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l273" href="#l273">273</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l274" href="#l274">274</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l275" href="#l275">275</a><td> */<tr><td><a name="l276" href="#l276">276</a><td>webdriver.testing.Assertion.prototype.isNullOrUndefined = function(<tr><td><a name="l277" href="#l277">277</a><td> opt_message) {<tr><td><a name="l278" href="#l278">278</a><td> return this.apply(<tr><td><a name="l279" href="#l279">279</a><td> new goog.labs.testing.IsNullOrUndefinedMatcher(), opt_message);<tr><td><a name="l280" href="#l280">280</a><td>};<tr><td><a name="l281" href="#l281">281</a><td><tr><td><a name="l282" href="#l282">282</a><td><tr><td><a name="l283" href="#l283">283</a><td>/**<tr><td><a name="l284" href="#l284">284</a><td> * Asserts that the wrapped value is a string or array-like structure<tr><td><a name="l285" href="#l285">285</a><td> * containing the given value.<tr><td><a name="l286" href="#l286">286</a><td> * @param {*} value The expected value.<tr><td><a name="l287" href="#l287">287</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l288" href="#l288">288</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l289" href="#l289">289</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l290" href="#l290">290</a><td> */<tr><td><a name="l291" href="#l291">291</a><td>webdriver.testing.Assertion.prototype.contains = function(value, opt_message) {<tr><td><a name="l292" href="#l292">292</a><td> return this.apply(<tr><td><a name="l293" href="#l293">293</a><td> new webdriver.testing.ContainsMatcher(value), opt_message);<tr><td><a name="l294" href="#l294">294</a><td>};<tr><td><a name="l295" href="#l295">295</a><td><tr><td><a name="l296" href="#l296">296</a><td><tr><td><a name="l297" href="#l297">297</a><td>/**<tr><td><a name="l298" href="#l298">298</a><td> * Asserts that the wrapped value is a string ending with the given suffix.<tr><td><a name="l299" href="#l299">299</a><td> * @param {string} suffix The expected suffix.<tr><td><a name="l300" href="#l300">300</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l301" href="#l301">301</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l302" href="#l302">302</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l303" href="#l303">303</a><td> */<tr><td><a name="l304" href="#l304">304</a><td>webdriver.testing.Assertion.prototype.endsWith = function(<tr><td><a name="l305" href="#l305">305</a><td> suffix, opt_message) {<tr><td><a name="l306" href="#l306">306</a><td> return this.apply(<tr><td><a name="l307" href="#l307">307</a><td> new goog.labs.testing.EndsWithMatcher(suffix), opt_message);<tr><td><a name="l308" href="#l308">308</a><td>};<tr><td><a name="l309" href="#l309">309</a><td><tr><td><a name="l310" href="#l310">310</a><td><tr><td><a name="l311" href="#l311">311</a><td>/**<tr><td><a name="l312" href="#l312">312</a><td> * Asserts that the wrapped value is a string starting with the given prefix.<tr><td><a name="l313" href="#l313">313</a><td> * @param {string} prefix The expected prefix.<tr><td><a name="l314" href="#l314">314</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l315" href="#l315">315</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l316" href="#l316">316</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l317" href="#l317">317</a><td> */<tr><td><a name="l318" href="#l318">318</a><td>webdriver.testing.Assertion.prototype.startsWith = function(<tr><td><a name="l319" href="#l319">319</a><td> prefix, opt_message) {<tr><td><a name="l320" href="#l320">320</a><td> return this.apply(<tr><td><a name="l321" href="#l321">321</a><td> new goog.labs.testing.StartsWithMatcher(prefix), opt_message);<tr><td><a name="l322" href="#l322">322</a><td>};<tr><td><a name="l323" href="#l323">323</a><td><tr><td><a name="l324" href="#l324">324</a><td><tr><td><a name="l325" href="#l325">325</a><td>/**<tr><td><a name="l326" href="#l326">326</a><td> * Asserts that the wrapped value is a string that matches the given RegExp.<tr><td><a name="l327" href="#l327">327</a><td> * @param {!RegExp} regex The regex to test.<tr><td><a name="l328" href="#l328">328</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l329" href="#l329">329</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l330" href="#l330">330</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l331" href="#l331">331</a><td> */<tr><td><a name="l332" href="#l332">332</a><td>webdriver.testing.Assertion.prototype.matches = function(regex, opt_message) {<tr><td><a name="l333" href="#l333">333</a><td> return this.apply(new goog.labs.testing.RegexMatcher(regex), opt_message);<tr><td><a name="l334" href="#l334">334</a><td>};<tr><td><a name="l335" href="#l335">335</a><td><tr><td><a name="l336" href="#l336">336</a><td><tr><td><a name="l337" href="#l337">337</a><td>/**<tr><td><a name="l338" href="#l338">338</a><td> * Asserts that the value managed by this assertion is strictly equal to the<tr><td><a name="l339" href="#l339">339</a><td> * given {@code value}.<tr><td><a name="l340" href="#l340">340</a><td> * @param {*} value The expected value.<tr><td><a name="l341" href="#l341">341</a><td> * @param {string=} opt_message A message to include if the matcher does not<tr><td><a name="l342" href="#l342">342</a><td> * accept the value wrapped by this assertion.<tr><td><a name="l343" href="#l343">343</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l344" href="#l344">344</a><td> */<tr><td><a name="l345" href="#l345">345</a><td>webdriver.testing.Assertion.prototype.equalTo = function(value, opt_message) {<tr><td><a name="l346" href="#l346">346</a><td> return this.apply(webdriver.testing.asserts.equalTo(value), opt_message);<tr><td><a name="l347" href="#l347">347</a><td>};<tr><td><a name="l348" href="#l348">348</a><td><tr><td><a name="l349" href="#l349">349</a><td><tr><td><a name="l350" href="#l350">350</a><td>/**<tr><td><a name="l351" href="#l351">351</a><td> * Asserts that the value managed by this assertion is strictly true.<tr><td><a name="l352" href="#l352">352</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l353" href="#l353">353</a><td> */<tr><td><a name="l354" href="#l354">354</a><td>webdriver.testing.Assertion.prototype.isTrue = function() {<tr><td><a name="l355" href="#l355">355</a><td> return this.equalTo(true);<tr><td><a name="l356" href="#l356">356</a><td>};<tr><td><a name="l357" href="#l357">357</a><td><tr><td><a name="l358" href="#l358">358</a><td><tr><td><a name="l359" href="#l359">359</a><td>/**<tr><td><a name="l360" href="#l360">360</a><td> * Asserts that the value managed by this assertion is strictly false.<tr><td><a name="l361" href="#l361">361</a><td> * @return {webdriver.promise.Promise} The assertion result.<tr><td><a name="l362" href="#l362">362</a><td> */<tr><td><a name="l363" href="#l363">363</a><td>webdriver.testing.Assertion.prototype.isFalse = function() {<tr><td><a name="l364" href="#l364">364</a><td> return this.equalTo(false);<tr><td><a name="l365" href="#l365">365</a><td>};<tr><td><a name="l366" href="#l366">366</a><td><tr><td><a name="l367" href="#l367">367</a><td><tr><td><a name="l368" href="#l368">368</a><td><tr><td><a name="l369" href="#l369">369</a><td>/**<tr><td><a name="l370" href="#l370">370</a><td> * An assertion that negates any applied matchers.<tr><td><a name="l371" href="#l371">371</a><td> * @param {*} value The value to perform assertions on.<tr><td><a name="l372" href="#l372">372</a><td> * @constructor<tr><td><a name="l373" href="#l373">373</a><td> * @extends {webdriver.testing.Assertion}<tr><td><a name="l374" href="#l374">374</a><td> */<tr><td><a name="l375" href="#l375">375</a><td>webdriver.testing.NegatedAssertion = function(value) {<tr><td><a name="l376" href="#l376">376</a><td> goog.base(this, value);<tr><td><a name="l377" href="#l377">377</a><td> this.value = value;<tr><td><a name="l378" href="#l378">378</a><td>};<tr><td><a name="l379" href="#l379">379</a><td>goog.inherits(<tr><td><a name="l380" href="#l380">380</a><td> webdriver.testing.NegatedAssertion, webdriver.testing.Assertion);<tr><td><a name="l381" href="#l381">381</a><td><tr><td><a name="l382" href="#l382">382</a><td><tr><td><a name="l383" href="#l383">383</a><td>/** @override */<tr><td><a name="l384" href="#l384">384</a><td>webdriver.testing.NegatedAssertion.prototype.apply = function(<tr><td><a name="l385" href="#l385">385</a><td> matcher, opt_message) {<tr><td><a name="l386" href="#l386">386</a><td> matcher = new goog.labs.testing.IsNotMatcher(matcher);<tr><td><a name="l387" href="#l387">387</a><td> return goog.base(this, &#39;apply&#39;, matcher, opt_message);<tr><td><a name="l388" href="#l388">388</a><td>};<tr><td><a name="l389" href="#l389">389</a><td><tr><td><a name="l390" href="#l390">390</a><td><tr><td><a name="l391" href="#l391">391</a><td><tr><td><a name="l392" href="#l392">392</a><td>/**<tr><td><a name="l393" href="#l393">393</a><td> * Creates a new assertion.<tr><td><a name="l394" href="#l394">394</a><td> * @param {*} value The value to perform an assertion on.<tr><td><a name="l395" href="#l395">395</a><td> * @return {!webdriver.testing.Assertion} The new assertion.<tr><td><a name="l396" href="#l396">396</a><td> */<tr><td><a name="l397" href="#l397">397</a><td>webdriver.testing.assert = function(value) {<tr><td><a name="l398" href="#l398">398</a><td> return new webdriver.testing.Assertion(value);<tr><td><a name="l399" href="#l399">399</a><td>};<tr><td><a name="l400" href="#l400">400</a><td><tr><td><a name="l401" href="#l401">401</a><td><tr><td><a name="l402" href="#l402">402</a><td>/**<tr><td><a name="l403" href="#l403">403</a><td> * Registers a new assertion to expose from the<tr><td><a name="l404" href="#l404">404</a><td> * {@link webdriver.testing.Assertion} prototype.<tr><td><a name="l405" href="#l405">405</a><td> * @param {string} name The assertion name.<tr><td><a name="l406" href="#l406">406</a><td> * @param {(function(new: goog.labs.testing.Matcher, *)|<tr><td><a name="l407" href="#l407">407</a><td> * {matches: function(*): boolean,<tr><td><a name="l408" href="#l408">408</a><td> * describe: function(): string})} matcherTemplate Either the<tr><td><a name="l409" href="#l409">409</a><td> * matcher constructor to use, or an object literal defining a matcher.<tr><td><a name="l410" href="#l410">410</a><td> */<tr><td><a name="l411" href="#l411">411</a><td>webdriver.testing.assert.register = function(name, matcherTemplate) {<tr><td><a name="l412" href="#l412">412</a><td> webdriver.testing.Assertion.prototype[name] = function(value, opt_message) {<tr><td><a name="l413" href="#l413">413</a><td> var matcher;<tr><td><a name="l414" href="#l414">414</a><td> if (goog.isFunction(matcherTemplate)) {<tr><td><a name="l415" href="#l415">415</a><td> var ctor = /** @type {function(new: goog.labs.testing.Matcher, *)} */ (<tr><td><a name="l416" href="#l416">416</a><td> matcherTemplate);<tr><td><a name="l417" href="#l417">417</a><td> matcher = new ctor(value);<tr><td><a name="l418" href="#l418">418</a><td> } else {<tr><td><a name="l419" href="#l419">419</a><td> matcher = new webdriver.testing.Assertion.DelegatingMatcher_(value);<tr><td><a name="l420" href="#l420">420</a><td> }<tr><td><a name="l421" href="#l421">421</a><td> return this.apply(matcher, opt_message);<tr><td><a name="l422" href="#l422">422</a><td> };<tr><td><a name="l423" href="#l423">423</a><td>};<tr><td><a name="l424" href="#l424">424</a><td><tr><td><a name="l425" href="#l425">425</a><td><tr><td><a name="l426" href="#l426">426</a><td>/**<tr><td><a name="l427" href="#l427">427</a><td> * Asserts that a matcher accepts a given value. This function has two<tr><td><a name="l428" href="#l428">428</a><td> * signatures based on the number of arguments:<tr><td><a name="l429" href="#l429">429</a><td> *<tr><td><a name="l430" href="#l430">430</a><td> * Two arguments:<tr><td><a name="l431" href="#l431">431</a><td> * assertThat(actualValue, matcher)<tr><td><a name="l432" href="#l432">432</a><td> * Three arguments:<tr><td><a name="l433" href="#l433">433</a><td> * assertThat(failureMessage, actualValue, matcher)<tr><td><a name="l434" href="#l434">434</a><td> *<tr><td><a name="l435" href="#l435">435</a><td> * @param {*} failureMessageOrActualValue Either a failure message or the value<tr><td><a name="l436" href="#l436">436</a><td> * to apply to the given matcher.<tr><td><a name="l437" href="#l437">437</a><td> * @param {*} actualValueOrMatcher Either the value to apply to the given<tr><td><a name="l438" href="#l438">438</a><td> * matcher, or the matcher itself.<tr><td><a name="l439" href="#l439">439</a><td> * @param {goog.labs.testing.Matcher=} opt_matcher The matcher to use;<tr><td><a name="l440" href="#l440">440</a><td> * ignored unless this function is invoked with three arguments.<tr><td><a name="l441" href="#l441">441</a><td> * @return {!webdriver.promise.Promise} The assertion result.<tr><td><a name="l442" href="#l442">442</a><td> * @deprecated Use webdriver.testing.asserts.assert instead.<tr><td><a name="l443" href="#l443">443</a><td> */<tr><td><a name="l444" href="#l444">444</a><td>webdriver.testing.asserts.assertThat = function(<tr><td><a name="l445" href="#l445">445</a><td> failureMessageOrActualValue, actualValueOrMatcher, opt_matcher) {<tr><td><a name="l446" href="#l446">446</a><td> var args = goog.array.slice(arguments, 0);<tr><td><a name="l447" href="#l447">447</a><td><tr><td><a name="l448" href="#l448">448</a><td> var message = args.length &gt; 2 ? args.shift() : &#39;&#39;;<tr><td><a name="l449" href="#l449">449</a><td> if (message) message += &#39;\n&#39;;<tr><td><a name="l450" href="#l450">450</a><td><tr><td><a name="l451" href="#l451">451</a><td> var actualValue = args.shift();<tr><td><a name="l452" href="#l452">452</a><td> var matcher = args.shift();<tr><td><a name="l453" href="#l453">453</a><td><tr><td><a name="l454" href="#l454">454</a><td> return webdriver.promise.when(actualValue, function(value) {<tr><td><a name="l455" href="#l455">455</a><td> goog.labs.testing.assertThat(value, matcher, message);<tr><td><a name="l456" href="#l456">456</a><td> });<tr><td><a name="l457" href="#l457">457</a><td>};<tr><td><a name="l458" href="#l458">458</a><td><tr><td><a name="l459" href="#l459">459</a><td><tr><td><a name="l460" href="#l460">460</a><td>/**<tr><td><a name="l461" href="#l461">461</a><td> * Creates an equality matcher.<tr><td><a name="l462" href="#l462">462</a><td> * @param {*} expected The expected value.<tr><td><a name="l463" href="#l463">463</a><td> * @return {!goog.labs.testing.Matcher} The new matcher.<tr><td><a name="l464" href="#l464">464</a><td> */<tr><td><a name="l465" href="#l465">465</a><td>webdriver.testing.asserts.equalTo = function(expected) {<tr><td><a name="l466" href="#l466">466</a><td> if (goog.isString(expected)) {<tr><td><a name="l467" href="#l467">467</a><td> return new goog.labs.testing.EqualsMatcher(expected);<tr><td><a name="l468" href="#l468">468</a><td> } else if (goog.isNumber(expected)) {<tr><td><a name="l469" href="#l469">469</a><td> return new goog.labs.testing.EqualToMatcher(expected);<tr><td><a name="l470" href="#l470">470</a><td> } else {<tr><td><a name="l471" href="#l471">471</a><td> return new goog.labs.testing.ObjectEqualsMatcher(<tr><td><a name="l472" href="#l472">472</a><td> /** @type {!Object} */ (expected));<tr><td><a name="l473" href="#l473">473</a><td> }<tr><td><a name="l474" href="#l474">474</a><td>};<tr><td><a name="l475" href="#l475">475</a><td><tr><td><a name="l476" href="#l476">476</a><td><tr><td><a name="l477" href="#l477">477</a><td>goog.exportSymbol(&#39;assertThat&#39;, webdriver.testing.asserts.assertThat);<tr><td><a name="l478" href="#l478">478</a><td>// Mappings for goog.labs.testing matcher functions to the legacy<tr><td><a name="l479" href="#l479">479</a><td>// webdriver.testing.asserts matchers.<tr><td><a name="l480" href="#l480">480</a><td>goog.exportSymbol(&#39;contains&#39;, containsString);<tr><td><a name="l481" href="#l481">481</a><td>goog.exportSymbol(&#39;equalTo&#39;, webdriver.testing.asserts.equalTo);<tr><td><a name="l482" href="#l482">482</a><td>goog.exportSymbol(&#39;equals&#39;, webdriver.testing.asserts.equalTo);<tr><td><a name="l483" href="#l483">483</a><td>goog.exportSymbol(&#39;is&#39;, webdriver.testing.asserts.equalTo);<tr><td><a name="l484" href="#l484">484</a><td>goog.exportSymbol(&#39;not&#39;, isNot);<tr><td><a name="l485" href="#l485">485</a><td>goog.exportSymbol(&#39;or&#39;, anyOf);</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>
package/docs/source/lib/webdriver/testing/testcase.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE 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 &quot;License&quot;);<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 &quot;AS IS&quot; 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(&#39;webdriver.testing.TestCase&#39;);<tr><td><a name="l29" href="#l29">29</a><td><tr><td><a name="l30" href="#l30">30</a><td>goog.require(&#39;goog.testing.TestCase&#39;);<tr><td><a name="l31" href="#l31">31</a><td>goog.require(&#39;webdriver.promise.ControlFlow&#39;);<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(&#39;webdriver.testing.asserts&#39;);<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> * &#39;Untitled Test Case&#39;.<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(&#39;Running test: &#39; + 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 = &#39;An unknown error occurred&#39;;<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[&#39;isJsUnitException&#39;] ||<tr><td><a name="l117" href="#l117">117</a><td> !opt_e[&#39;loggedJsUnitException&#39;]) {<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 &amp;&amp; opt_e[&#39;isJsUnitException&#39;]) {<tr><td><a name="l122" href="#l122">122</a><td> opt_e[&#39;loggedJsUnitException&#39;] = 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 + &#39;.setUp()&#39;, this.setUp)().<tr><td><a name="l159" href="#l159">159</a><td> then(execute(test.name + &#39;()&#39;, 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 + &#39;.tearDown()&#39;, 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>
1
+ <!DOCTYPE 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 &quot;License&quot;);<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 &quot;AS IS&quot; 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(&#39;webdriver.testing.TestCase&#39;);<tr><td><a name="l29" href="#l29">29</a><td><tr><td><a name="l30" href="#l30">30</a><td>goog.require(&#39;goog.testing.TestCase&#39;);<tr><td><a name="l31" href="#l31">31</a><td>goog.require(&#39;webdriver.promise.ControlFlow&#39;);<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(&#39;webdriver.testing.asserts&#39;);<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> * &#39;Untitled Test Case&#39;.<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(&#39;Running test: &#39; + 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 = &#39;An unknown error occurred&#39;;<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[&#39;isJsUnitException&#39;] ||<tr><td><a name="l117" href="#l117">117</a><td> !opt_e[&#39;loggedJsUnitException&#39;]) {<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 &amp;&amp; opt_e[&#39;isJsUnitException&#39;]) {<tr><td><a name="l122" href="#l122">122</a><td> opt_e[&#39;loggedJsUnitException&#39;] = 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 + &#39;.setUp()&#39;, this.setUp)().<tr><td><a name="l159" href="#l159">159</a><td> then(execute(test.name + &#39;()&#39;, 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 + &#39;.tearDown()&#39;, 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>
package/docs/source/lib/webdriver/until.js.src.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>until.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/until.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2014 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 &quot;License&quot;);<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 &quot;AS IS&quot; 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 common conditions for use with<tr><td><a name="l17" href="#l17">17</a><td> * {@link webdriver.WebDriver#wait WebDriver wait}.<tr><td><a name="l18" href="#l18">18</a><td> *<tr><td><a name="l19" href="#l19">19</a><td> * &lt;p&gt;Sample usage:<tr><td><a name="l20" href="#l20">20</a><td> * &lt;code&gt;&lt;pre&gt;<tr><td><a name="l21" href="#l21">21</a><td> * driver.get(&#39;http://www.google.com/ncr&#39;);<tr><td><a name="l22" href="#l22">22</a><td> *<tr><td><a name="l23" href="#l23">23</a><td> * var query = driver.wait(until.elementLocated(By.name(&#39;q&#39;)));<tr><td><a name="l24" href="#l24">24</a><td> * query.sendKeys(&#39;webdriver\n&#39;);<tr><td><a name="l25" href="#l25">25</a><td> *<tr><td><a name="l26" href="#l26">26</a><td> * driver.wait(until.titleIs(&#39;webdriver - Google Search&#39;));<tr><td><a name="l27" href="#l27">27</a><td> * &lt;/pre&gt;&lt;/code&gt;<tr><td><a name="l28" href="#l28">28</a><td> *<tr><td><a name="l29" href="#l29">29</a><td> * &lt;p&gt;To define a custom condition, simply call WebDriver.wait with a function<tr><td><a name="l30" href="#l30">30</a><td> * that will eventually return a truthy-value (neither null, undefined, false,<tr><td><a name="l31" href="#l31">31</a><td> * 0, or the empty string):<tr><td><a name="l32" href="#l32">32</a><td> * &lt;code&gt;&lt;pre&gt;<tr><td><a name="l33" href="#l33">33</a><td> * driver.wait(function() {<tr><td><a name="l34" href="#l34">34</a><td> * return driver.getTitle().then(function(title) {<tr><td><a name="l35" href="#l35">35</a><td> * return title === &#39;webdriver - Google Search&#39;;<tr><td><a name="l36" href="#l36">36</a><td> * });<tr><td><a name="l37" href="#l37">37</a><td> * }, 1000);<tr><td><a name="l38" href="#l38">38</a><td> * &lt;/pre&gt;&lt;/code&gt;<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>goog.provide(&#39;webdriver.until&#39;);<tr><td><a name="l42" href="#l42">42</a><td><tr><td><a name="l43" href="#l43">43</a><td>goog.require(&#39;bot.ErrorCode&#39;);<tr><td><a name="l44" href="#l44">44</a><td>goog.require(&#39;goog.array&#39;);<tr><td><a name="l45" href="#l45">45</a><td>goog.require(&#39;goog.string&#39;);<tr><td><a name="l46" href="#l46">46</a><td><tr><td><a name="l47" href="#l47">47</a><td><tr><td><a name="l48" href="#l48">48</a><td><tr><td><a name="l49" href="#l49">49</a><td>goog.scope(function() {<tr><td><a name="l50" href="#l50">50</a><td><tr><td><a name="l51" href="#l51">51</a><td>var until = webdriver.until;<tr><td><a name="l52" href="#l52">52</a><td><tr><td><a name="l53" href="#l53">53</a><td><tr><td><a name="l54" href="#l54">54</a><td>/**<tr><td><a name="l55" href="#l55">55</a><td> * Defines a condition to <tr><td><a name="l56" href="#l56">56</a><td> * @param {string} message A descriptive error message. Should complete the<tr><td><a name="l57" href="#l57">57</a><td> * sentence &quot;Waiting [...]&quot;<tr><td><a name="l58" href="#l58">58</a><td> * @param {function(!webdriver.WebDriver): OUT} fn The condition function to<tr><td><a name="l59" href="#l59">59</a><td> * evaluate on each iteration of the wait loop.<tr><td><a name="l60" href="#l60">60</a><td> * @constructor<tr><td><a name="l61" href="#l61">61</a><td> * @struct<tr><td><a name="l62" href="#l62">62</a><td> * @final<tr><td><a name="l63" href="#l63">63</a><td> * @template OUT<tr><td><a name="l64" href="#l64">64</a><td> */<tr><td><a name="l65" href="#l65">65</a><td>until.Condition = function(message, fn) {<tr><td><a name="l66" href="#l66">66</a><td> /** @private {string} */<tr><td><a name="l67" href="#l67">67</a><td> this.description_ = &#39;Waiting &#39; + message;<tr><td><a name="l68" href="#l68">68</a><td><tr><td><a name="l69" href="#l69">69</a><td> /** @type {function(!webdriver.WebDriver): OUT} */<tr><td><a name="l70" href="#l70">70</a><td> this.fn = fn;<tr><td><a name="l71" href="#l71">71</a><td>};<tr><td><a name="l72" href="#l72">72</a><td><tr><td><a name="l73" href="#l73">73</a><td><tr><td><a name="l74" href="#l74">74</a><td>/** @return {string} A description of this condition. */<tr><td><a name="l75" href="#l75">75</a><td>until.Condition.prototype.description = function() {<tr><td><a name="l76" href="#l76">76</a><td> return this.description_;<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>/**<tr><td><a name="l81" href="#l81">81</a><td> * Creates a condition that will wait until the input driver is able to switch<tr><td><a name="l82" href="#l82">82</a><td> * to the designated frame. The target frame may be specified as:<tr><td><a name="l83" href="#l83">83</a><td> * &lt;ol&gt;<tr><td><a name="l84" href="#l84">84</a><td> * &lt;li&gt;A numeric index into {@code window.frames} for the currently selected<tr><td><a name="l85" href="#l85">85</a><td> * frame.<tr><td><a name="l86" href="#l86">86</a><td> * &lt;li&gt;A {@link webdriver.WebElement}, which must reference a FRAME or IFRAME<tr><td><a name="l87" href="#l87">87</a><td> * element on the current page.<tr><td><a name="l88" href="#l88">88</a><td> * &lt;li&gt;A locator which may be used to first locate a FRAME or IFRAME on the<tr><td><a name="l89" href="#l89">89</a><td> * current page before attempting to switch to it.<tr><td><a name="l90" href="#l90">90</a><td> * &lt;/ol&gt;<tr><td><a name="l91" href="#l91">91</a><td> *<tr><td><a name="l92" href="#l92">92</a><td> * &lt;p&gt;Upon successful resolution of this condition, the driver will be left<tr><td><a name="l93" href="#l93">93</a><td> * focused on the new frame.<tr><td><a name="l94" href="#l94">94</a><td> *<tr><td><a name="l95" href="#l95">95</a><td> * @param {!(number|webdriver.WebElement|<tr><td><a name="l96" href="#l96">96</a><td> * webdriver.Locator|webdriver.By.Hash|<tr><td><a name="l97" href="#l97">97</a><td> * function(!webdriver.WebDriver): !webdriver.WebElement)} frame<tr><td><a name="l98" href="#l98">98</a><td> * The frame identifier.<tr><td><a name="l99" href="#l99">99</a><td> * @return {!until.Condition.&lt;boolean&gt;} A new condition.<tr><td><a name="l100" href="#l100">100</a><td> */<tr><td><a name="l101" href="#l101">101</a><td>until.ableToSwitchToFrame = function(frame) {<tr><td><a name="l102" href="#l102">102</a><td> var condition;<tr><td><a name="l103" href="#l103">103</a><td> if (goog.isNumber(frame) || frame instanceof webdriver.WebElement) {<tr><td><a name="l104" href="#l104">104</a><td> condition = attemptToSwitchFrames;<tr><td><a name="l105" href="#l105">105</a><td> } else {<tr><td><a name="l106" href="#l106">106</a><td> condition = function(driver) {<tr><td><a name="l107" href="#l107">107</a><td> var locator =<tr><td><a name="l108" href="#l108">108</a><td> /** @type {!(webdriver.Locator|webdriver.By.Hash|Function)} */(frame);<tr><td><a name="l109" href="#l109">109</a><td> return driver.findElements(locator).then(function(els) {<tr><td><a name="l110" href="#l110">110</a><td> if (els.length) {<tr><td><a name="l111" href="#l111">111</a><td> return attemptToSwitchFrames(driver, els[0]);<tr><td><a name="l112" href="#l112">112</a><td> }<tr><td><a name="l113" href="#l113">113</a><td> });<tr><td><a name="l114" href="#l114">114</a><td> };<tr><td><a name="l115" href="#l115">115</a><td> }<tr><td><a name="l116" href="#l116">116</a><td><tr><td><a name="l117" href="#l117">117</a><td> return new until.Condition(&#39;to be able to switch to frame&#39;, condition);<tr><td><a name="l118" href="#l118">118</a><td><tr><td><a name="l119" href="#l119">119</a><td> function attemptToSwitchFrames(driver, frame) {<tr><td><a name="l120" href="#l120">120</a><td> return driver.switchTo().frame(frame).then(<tr><td><a name="l121" href="#l121">121</a><td> function() { return true; },<tr><td><a name="l122" href="#l122">122</a><td> function(e) {<tr><td><a name="l123" href="#l123">123</a><td> if (e &amp;&amp; e.code !== bot.ErrorCode.NO_SUCH_FRAME) {<tr><td><a name="l124" href="#l124">124</a><td> throw e;<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>};<tr><td><a name="l129" href="#l129">129</a><td><tr><td><a name="l130" href="#l130">130</a><td><tr><td><a name="l131" href="#l131">131</a><td>/**<tr><td><a name="l132" href="#l132">132</a><td> * Creates a condition that waits for an alert to be opened. Upon success, the<tr><td><a name="l133" href="#l133">133</a><td> * returned promise will be fulfilled with the handle for the opened alert.<tr><td><a name="l134" href="#l134">134</a><td> *<tr><td><a name="l135" href="#l135">135</a><td> * @return {!until.Condition.&lt;!webdriver.Alert&gt;} The new condition.<tr><td><a name="l136" href="#l136">136</a><td> */<tr><td><a name="l137" href="#l137">137</a><td>until.alertIsPresent = function() {<tr><td><a name="l138" href="#l138">138</a><td> return new until.Condition(&#39;for alert to be present&#39;, function(driver) {<tr><td><a name="l139" href="#l139">139</a><td> return driver.switchTo().alert().thenCatch(function(e) {<tr><td><a name="l140" href="#l140">140</a><td> if (e &amp;&amp; e.code !== bot.ErrorCode.NO_SUCH_ALERT) {<tr><td><a name="l141" href="#l141">141</a><td> throw e;<tr><td><a name="l142" href="#l142">142</a><td> }<tr><td><a name="l143" href="#l143">143</a><td> });<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><tr><td><a name="l148" href="#l148">148</a><td>/**<tr><td><a name="l149" href="#l149">149</a><td> * Creates a condition that will wait for the current page&#39;s title to match the<tr><td><a name="l150" href="#l150">150</a><td> * given value.<tr><td><a name="l151" href="#l151">151</a><td> *<tr><td><a name="l152" href="#l152">152</a><td> * @param {string} title The expected page title.<tr><td><a name="l153" href="#l153">153</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l154" href="#l154">154</a><td> */<tr><td><a name="l155" href="#l155">155</a><td>until.titleIs = function(title) {<tr><td><a name="l156" href="#l156">156</a><td> return new until.Condition(<tr><td><a name="l157" href="#l157">157</a><td> &#39;for title to be &#39; + goog.string.quote(title),<tr><td><a name="l158" href="#l158">158</a><td> function(driver) {<tr><td><a name="l159" href="#l159">159</a><td> return driver.getTitle().then(function(t) {<tr><td><a name="l160" href="#l160">160</a><td> return t === title;<tr><td><a name="l161" href="#l161">161</a><td> });<tr><td><a name="l162" href="#l162">162</a><td> });<tr><td><a name="l163" href="#l163">163</a><td>};<tr><td><a name="l164" href="#l164">164</a><td><tr><td><a name="l165" href="#l165">165</a><td><tr><td><a name="l166" href="#l166">166</a><td>/**<tr><td><a name="l167" href="#l167">167</a><td> * Creates a condition that will wait for the current page&#39;s title to contain<tr><td><a name="l168" href="#l168">168</a><td> * the given substring.<tr><td><a name="l169" href="#l169">169</a><td> *<tr><td><a name="l170" href="#l170">170</a><td> * @param {string} substr The substring that should be present in the page<tr><td><a name="l171" href="#l171">171</a><td> * title.<tr><td><a name="l172" href="#l172">172</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l173" href="#l173">173</a><td> */<tr><td><a name="l174" href="#l174">174</a><td>until.titleContains = function(substr) {<tr><td><a name="l175" href="#l175">175</a><td> return new until.Condition(<tr><td><a name="l176" href="#l176">176</a><td> &#39;for title to contain &#39; + goog.string.quote(substr),<tr><td><a name="l177" href="#l177">177</a><td> function(driver) {<tr><td><a name="l178" href="#l178">178</a><td> return driver.getTitle().then(function(title) {<tr><td><a name="l179" href="#l179">179</a><td> return title.indexOf(substr) !== -1;<tr><td><a name="l180" href="#l180">180</a><td> });<tr><td><a name="l181" href="#l181">181</a><td> });<tr><td><a name="l182" href="#l182">182</a><td>};<tr><td><a name="l183" href="#l183">183</a><td><tr><td><a name="l184" href="#l184">184</a><td><tr><td><a name="l185" href="#l185">185</a><td>/**<tr><td><a name="l186" href="#l186">186</a><td> * Creates a condition that will wait for the current page&#39;s title to match the<tr><td><a name="l187" href="#l187">187</a><td> * given regular expression.<tr><td><a name="l188" href="#l188">188</a><td> *<tr><td><a name="l189" href="#l189">189</a><td> * @param {!RegExp} regex The regular expression to test against.<tr><td><a name="l190" href="#l190">190</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l191" href="#l191">191</a><td> */<tr><td><a name="l192" href="#l192">192</a><td>until.titleMatches = function(regex) {<tr><td><a name="l193" href="#l193">193</a><td> return new until.Condition(&#39;for title to match &#39; + regex, function(driver) {<tr><td><a name="l194" href="#l194">194</a><td> return driver.getTitle().then(function(title) {<tr><td><a name="l195" href="#l195">195</a><td> return regex.test(title);<tr><td><a name="l196" href="#l196">196</a><td> });<tr><td><a name="l197" href="#l197">197</a><td> });<tr><td><a name="l198" href="#l198">198</a><td>};<tr><td><a name="l199" href="#l199">199</a><td><tr><td><a name="l200" href="#l200">200</a><td><tr><td><a name="l201" href="#l201">201</a><td>/**<tr><td><a name="l202" href="#l202">202</a><td> * Creates a condition that will loop until an element is<tr><td><a name="l203" href="#l203">203</a><td> * {@link webdriver.WebDriver#findElement found} with the given locator.<tr><td><a name="l204" href="#l204">204</a><td> *<tr><td><a name="l205" href="#l205">205</a><td> * @param {!(webdriver.Locator|webdriver.By.Hash|Function)} locator The locator<tr><td><a name="l206" href="#l206">206</a><td> * to use.<tr><td><a name="l207" href="#l207">207</a><td> * @return {!until.Condition.&lt;!webdriver.WebElement&gt;} The new condition.<tr><td><a name="l208" href="#l208">208</a><td> */<tr><td><a name="l209" href="#l209">209</a><td>until.elementLocated = function(locator) {<tr><td><a name="l210" href="#l210">210</a><td> var locatorStr = goog.isFunction(locator) ? &#39;function()&#39; : locator + &#39;&#39;;<tr><td><a name="l211" href="#l211">211</a><td> return new until.Condition(&#39;element to be located by &#39; + locatorStr,<tr><td><a name="l212" href="#l212">212</a><td> function(driver) {<tr><td><a name="l213" href="#l213">213</a><td> return driver.findElements(locator).then(function(elements) {<tr><td><a name="l214" href="#l214">214</a><td> return elements[0];<tr><td><a name="l215" href="#l215">215</a><td> });<tr><td><a name="l216" href="#l216">216</a><td> });<tr><td><a name="l217" href="#l217">217</a><td>};<tr><td><a name="l218" href="#l218">218</a><td><tr><td><a name="l219" href="#l219">219</a><td><tr><td><a name="l220" href="#l220">220</a><td>/**<tr><td><a name="l221" href="#l221">221</a><td> * Creates a condition that will loop until at least one element is<tr><td><a name="l222" href="#l222">222</a><td> * {@link webdriver.WebDriver#findElement found} with the given locator.<tr><td><a name="l223" href="#l223">223</a><td> *<tr><td><a name="l224" href="#l224">224</a><td> * @param {!(webdriver.Locator|webdriver.By.Hash|Function)} locator The locator<tr><td><a name="l225" href="#l225">225</a><td> * to use.<tr><td><a name="l226" href="#l226">226</a><td> * @return {!until.Condition.&lt;!Array.&lt;!webdriver.WebElement&gt;&gt;} The new<tr><td><a name="l227" href="#l227">227</a><td> * condition.<tr><td><a name="l228" href="#l228">228</a><td> */<tr><td><a name="l229" href="#l229">229</a><td>until.elementsLocated = function(locator) {<tr><td><a name="l230" href="#l230">230</a><td> var locatorStr = goog.isFunction(locator) ? &#39;function()&#39; : locator + &#39;&#39;;<tr><td><a name="l231" href="#l231">231</a><td> return new until.Condition(<tr><td><a name="l232" href="#l232">232</a><td> &#39;at least one element to be located by &#39; + locatorStr,<tr><td><a name="l233" href="#l233">233</a><td> function(driver) {<tr><td><a name="l234" href="#l234">234</a><td> return driver.findElements(locator).then(function(elements) {<tr><td><a name="l235" href="#l235">235</a><td> return elements.length &gt; 0 ? elements : null;<tr><td><a name="l236" href="#l236">236</a><td> });<tr><td><a name="l237" href="#l237">237</a><td> });<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> * Creates a condition that will wait for the given element to become stale. An<tr><td><a name="l243" href="#l243">243</a><td> * element is considered stale once it is removed from the DOM, or a new page<tr><td><a name="l244" href="#l244">244</a><td> * has loaded.<tr><td><a name="l245" href="#l245">245</a><td> *<tr><td><a name="l246" href="#l246">246</a><td> * @param {!webdriver.WebElement} element The element that should become stale.<tr><td><a name="l247" href="#l247">247</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l248" href="#l248">248</a><td> */<tr><td><a name="l249" href="#l249">249</a><td>until.stalenessOf = function(element) {<tr><td><a name="l250" href="#l250">250</a><td> return new until.Condition(&#39;element to become stale&#39;, function() {<tr><td><a name="l251" href="#l251">251</a><td> return element.getTagName().then(<tr><td><a name="l252" href="#l252">252</a><td> function() { return false; },<tr><td><a name="l253" href="#l253">253</a><td> function(e) {<tr><td><a name="l254" href="#l254">254</a><td> if (e.code === bot.ErrorCode.STALE_ELEMENT_REFERENCE) {<tr><td><a name="l255" href="#l255">255</a><td> return true;<tr><td><a name="l256" href="#l256">256</a><td> }<tr><td><a name="l257" href="#l257">257</a><td> throw e;<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>};<tr><td><a name="l261" href="#l261">261</a><td><tr><td><a name="l262" href="#l262">262</a><td><tr><td><a name="l263" href="#l263">263</a><td>/**<tr><td><a name="l264" href="#l264">264</a><td> * Creates a condition that will wait for the given element to become visible.<tr><td><a name="l265" href="#l265">265</a><td> *<tr><td><a name="l266" href="#l266">266</a><td> * @param {!webdriver.WebElement} element The element to test.<tr><td><a name="l267" href="#l267">267</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l268" href="#l268">268</a><td> * @see webdriver.WebDriver#isDisplayed<tr><td><a name="l269" href="#l269">269</a><td> */<tr><td><a name="l270" href="#l270">270</a><td>until.elementIsVisible = function(element) {<tr><td><a name="l271" href="#l271">271</a><td> return new until.Condition(&#39;until element is visible&#39;, function() {<tr><td><a name="l272" href="#l272">272</a><td> return element.isDisplayed();<tr><td><a name="l273" href="#l273">273</a><td> });<tr><td><a name="l274" href="#l274">274</a><td>};<tr><td><a name="l275" href="#l275">275</a><td><tr><td><a name="l276" href="#l276">276</a><td><tr><td><a name="l277" href="#l277">277</a><td>/**<tr><td><a name="l278" href="#l278">278</a><td> * Creates a condition that will wait for the given element to be in the DOM,<tr><td><a name="l279" href="#l279">279</a><td> * yet not visible to the user.<tr><td><a name="l280" href="#l280">280</a><td> *<tr><td><a name="l281" href="#l281">281</a><td> * @param {!webdriver.WebElement} element The element to test.<tr><td><a name="l282" href="#l282">282</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l283" href="#l283">283</a><td> * @see webdriver.WebDriver#isDisplayed<tr><td><a name="l284" href="#l284">284</a><td> */<tr><td><a name="l285" href="#l285">285</a><td>until.elementIsNotVisible = function(element) {<tr><td><a name="l286" href="#l286">286</a><td> return new until.Condition(&#39;until element is not visible&#39;, function() {<tr><td><a name="l287" href="#l287">287</a><td> return element.isDisplayed().then(function(v) {<tr><td><a name="l288" href="#l288">288</a><td> return !v;<tr><td><a name="l289" href="#l289">289</a><td> });<tr><td><a name="l290" href="#l290">290</a><td> });<tr><td><a name="l291" href="#l291">291</a><td>};<tr><td><a name="l292" href="#l292">292</a><td><tr><td><a name="l293" href="#l293">293</a><td><tr><td><a name="l294" href="#l294">294</a><td>/**<tr><td><a name="l295" href="#l295">295</a><td> * Creates a condition that will wait for the given element to be enabled.<tr><td><a name="l296" href="#l296">296</a><td> *<tr><td><a name="l297" href="#l297">297</a><td> * @param {!webdriver.WebElement} element The element to test.<tr><td><a name="l298" href="#l298">298</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l299" href="#l299">299</a><td> * @see webdriver.WebDriver#isEnabled<tr><td><a name="l300" href="#l300">300</a><td> */<tr><td><a name="l301" href="#l301">301</a><td>until.elementIsEnabled = function(element) {<tr><td><a name="l302" href="#l302">302</a><td> return new until.Condition(&#39;until element is enabled&#39;, function() {<tr><td><a name="l303" href="#l303">303</a><td> return element.isEnabled();<tr><td><a name="l304" href="#l304">304</a><td> });<tr><td><a name="l305" href="#l305">305</a><td>};<tr><td><a name="l306" href="#l306">306</a><td><tr><td><a name="l307" href="#l307">307</a><td><tr><td><a name="l308" href="#l308">308</a><td>/**<tr><td><a name="l309" href="#l309">309</a><td> * Creates a condition that will wait for the given element to be disabled.<tr><td><a name="l310" href="#l310">310</a><td> *<tr><td><a name="l311" href="#l311">311</a><td> * @param {!webdriver.WebElement} element The element to test.<tr><td><a name="l312" href="#l312">312</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l313" href="#l313">313</a><td> * @see webdriver.WebDriver#isEnabled<tr><td><a name="l314" href="#l314">314</a><td> */<tr><td><a name="l315" href="#l315">315</a><td>until.elementIsDisabled = function(element) {<tr><td><a name="l316" href="#l316">316</a><td> return new until.Condition(&#39;until element is disabled&#39;, function() {<tr><td><a name="l317" href="#l317">317</a><td> return element.isEnabled().then(function(v) {<tr><td><a name="l318" href="#l318">318</a><td> return !v;<tr><td><a name="l319" href="#l319">319</a><td> });<tr><td><a name="l320" href="#l320">320</a><td> });<tr><td><a name="l321" href="#l321">321</a><td>};<tr><td><a name="l322" href="#l322">322</a><td><tr><td><a name="l323" href="#l323">323</a><td><tr><td><a name="l324" href="#l324">324</a><td>/**<tr><td><a name="l325" href="#l325">325</a><td> * Creates a condition that will wait for the given element to be selected.<tr><td><a name="l326" href="#l326">326</a><td> * @param {!webdriver.WebElement} element The element to test.<tr><td><a name="l327" href="#l327">327</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l328" href="#l328">328</a><td> * @see webdriver.WebDriver#isSelected<tr><td><a name="l329" href="#l329">329</a><td> */<tr><td><a name="l330" href="#l330">330</a><td>until.elementIsSelected = function(element) {<tr><td><a name="l331" href="#l331">331</a><td> return new until.Condition(&#39;until element is selected&#39;, function() {<tr><td><a name="l332" href="#l332">332</a><td> return element.isSelected();<tr><td><a name="l333" href="#l333">333</a><td> });<tr><td><a name="l334" href="#l334">334</a><td>};<tr><td><a name="l335" href="#l335">335</a><td><tr><td><a name="l336" href="#l336">336</a><td><tr><td><a name="l337" href="#l337">337</a><td>/**<tr><td><a name="l338" href="#l338">338</a><td> * Creates a condition that will wait for the given element to be deselected.<tr><td><a name="l339" href="#l339">339</a><td> *<tr><td><a name="l340" href="#l340">340</a><td> * @param {!webdriver.WebElement} element The element to test.<tr><td><a name="l341" href="#l341">341</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l342" href="#l342">342</a><td> * @see webdriver.WebDriver#isSelected<tr><td><a name="l343" href="#l343">343</a><td> */<tr><td><a name="l344" href="#l344">344</a><td>until.elementIsNotSelected = function(element) {<tr><td><a name="l345" href="#l345">345</a><td> return new until.Condition(&#39;until element is not selected&#39;, function() {<tr><td><a name="l346" href="#l346">346</a><td> return element.isSelected().then(function(v) {<tr><td><a name="l347" href="#l347">347</a><td> return !v;<tr><td><a name="l348" href="#l348">348</a><td> });<tr><td><a name="l349" href="#l349">349</a><td> });<tr><td><a name="l350" href="#l350">350</a><td>};<tr><td><a name="l351" href="#l351">351</a><td><tr><td><a name="l352" href="#l352">352</a><td><tr><td><a name="l353" href="#l353">353</a><td>/**<tr><td><a name="l354" href="#l354">354</a><td> * Creates a condition that will wait for the given element&#39;s<tr><td><a name="l355" href="#l355">355</a><td> * {@link webdriver.WebDriver#getText visible text} to match the given<tr><td><a name="l356" href="#l356">356</a><td> * {@code text} exactly.<tr><td><a name="l357" href="#l357">357</a><td> *<tr><td><a name="l358" href="#l358">358</a><td> * @param {!webdriver.WebElement} element The element to test.<tr><td><a name="l359" href="#l359">359</a><td> * @param {string} text The expected text.<tr><td><a name="l360" href="#l360">360</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l361" href="#l361">361</a><td> * @see webdriver.WebDriver#getText<tr><td><a name="l362" href="#l362">362</a><td> */<tr><td><a name="l363" href="#l363">363</a><td>until.elementTextIs = function(element, text) {<tr><td><a name="l364" href="#l364">364</a><td> return new until.Condition(&#39;until element text is&#39;, function() {<tr><td><a name="l365" href="#l365">365</a><td> return element.getText().then(function(t) {<tr><td><a name="l366" href="#l366">366</a><td> return t === text;<tr><td><a name="l367" href="#l367">367</a><td> });<tr><td><a name="l368" href="#l368">368</a><td> });<tr><td><a name="l369" href="#l369">369</a><td>};<tr><td><a name="l370" href="#l370">370</a><td><tr><td><a name="l371" href="#l371">371</a><td><tr><td><a name="l372" href="#l372">372</a><td>/**<tr><td><a name="l373" href="#l373">373</a><td> * Creates a condition that will wait for the given element&#39;s<tr><td><a name="l374" href="#l374">374</a><td> * {@link webdriver.WebDriver#getText visible text} to contain the given<tr><td><a name="l375" href="#l375">375</a><td> * substring.<tr><td><a name="l376" href="#l376">376</a><td> *<tr><td><a name="l377" href="#l377">377</a><td> * @param {!webdriver.WebElement} element The element to test.<tr><td><a name="l378" href="#l378">378</a><td> * @param {string} substr The substring to search for.<tr><td><a name="l379" href="#l379">379</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l380" href="#l380">380</a><td> * @see webdriver.WebDriver#getText<tr><td><a name="l381" href="#l381">381</a><td> */<tr><td><a name="l382" href="#l382">382</a><td>until.elementTextContains = function(element, substr) {<tr><td><a name="l383" href="#l383">383</a><td> return new until.Condition(&#39;until element text contains&#39;, function() {<tr><td><a name="l384" href="#l384">384</a><td> return element.getText().then(function(t) {<tr><td><a name="l385" href="#l385">385</a><td> return t.indexOf(substr) != -1;<tr><td><a name="l386" href="#l386">386</a><td> });<tr><td><a name="l387" href="#l387">387</a><td> });<tr><td><a name="l388" href="#l388">388</a><td>};<tr><td><a name="l389" href="#l389">389</a><td><tr><td><a name="l390" href="#l390">390</a><td><tr><td><a name="l391" href="#l391">391</a><td>/**<tr><td><a name="l392" href="#l392">392</a><td> * Creates a condition that will wait for the given element&#39;s<tr><td><a name="l393" href="#l393">393</a><td> * {@link webdriver.WebDriver#getText visible text} to match a regular<tr><td><a name="l394" href="#l394">394</a><td> * expression.<tr><td><a name="l395" href="#l395">395</a><td> *<tr><td><a name="l396" href="#l396">396</a><td> * @param {!webdriver.WebElement} element The element to test.<tr><td><a name="l397" href="#l397">397</a><td> * @param {!RegExp} regex The regular expression to test against.<tr><td><a name="l398" href="#l398">398</a><td> * @return {!until.Condition.&lt;boolean&gt;} The new condition.<tr><td><a name="l399" href="#l399">399</a><td> * @see webdriver.WebDriver#getText<tr><td><a name="l400" href="#l400">400</a><td> */<tr><td><a name="l401" href="#l401">401</a><td>until.elementTextMatches = function(element, regex) {<tr><td><a name="l402" href="#l402">402</a><td> return new until.Condition(&#39;until element text matches&#39;, function() {<tr><td><a name="l403" href="#l403">403</a><td> return element.getText().then(function(t) {<tr><td><a name="l404" href="#l404">404</a><td> return regex.test(t);<tr><td><a name="l405" href="#l405">405</a><td> });<tr><td><a name="l406" href="#l406">406</a><td> });<tr><td><a name="l407" href="#l407">407</a><td>};<tr><td><a name="l408" href="#l408">408</a><td>}); // goog.scope</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>