test_cases.html 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>grpc.framework.interfaces.links.test_cases &mdash; grpcio 0.10.0a0 documentation</title>
  8. <link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
  9. <link rel="top" title="grpcio 0.10.0a0 documentation" href="../../../../../index.html"/>
  10. <link rel="up" title="Module code" href="../../../../index.html"/>
  11. <script src="_static/js/modernizr.min.js"></script>
  12. </head>
  13. <body class="wy-body-for-nav" role="document">
  14. <div class="wy-grid-for-nav">
  15. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  16. <div class="wy-side-nav-search">
  17. <a href="../../../../../index.html" class="icon icon-home"> grpcio
  18. </a>
  19. <div role="search">
  20. <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
  21. <input type="text" name="q" placeholder="Search docs" />
  22. <input type="hidden" name="check_keywords" value="yes" />
  23. <input type="hidden" name="area" value="default" />
  24. </form>
  25. </div>
  26. </div>
  27. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  28. <ul>
  29. <li class="toctree-l1"><a class="reference internal" href="../../../../../grpc.html">grpc package</a><ul>
  30. <li class="toctree-l2"><a class="reference internal" href="../../../../../grpc.html#subpackages">Subpackages</a><ul>
  31. <li class="toctree-l3"><a class="reference internal" href="../../../../../grpc.early_adopter.html">grpc.early_adopter package</a><ul>
  32. <li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.early_adopter.html#submodules">Submodules</a></li>
  33. <li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.early_adopter.html#module-grpc.early_adopter.implementations">grpc.early_adopter.implementations module</a></li>
  34. <li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.early_adopter.html#module-grpc.early_adopter.implementations_test">grpc.early_adopter.implementations_test module</a></li>
  35. <li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.early_adopter.html#module-grpc.early_adopter">Module contents</a></li>
  36. </ul>
  37. </li>
  38. <li class="toctree-l3"><a class="reference internal" href="../../../../../grpc.framework.html">grpc.framework package</a><ul>
  39. <li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.framework.html#subpackages">Subpackages</a></li>
  40. <li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.framework.html#module-grpc.framework">Module contents</a></li>
  41. </ul>
  42. </li>
  43. </ul>
  44. </li>
  45. <li class="toctree-l2"><a class="reference internal" href="../../../../../grpc.html#module-grpc">Module contents</a></li>
  46. </ul>
  47. </li>
  48. </ul>
  49. </div>
  50. &nbsp;
  51. </nav>
  52. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  53. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  54. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  55. <a href="../../../../../index.html">grpcio</a>
  56. </nav>
  57. <div class="wy-nav-content">
  58. <div class="rst-content">
  59. <div role="navigation" aria-label="breadcrumbs navigation">
  60. <ul class="wy-breadcrumbs">
  61. <li><a href="../../../../../index.html">Docs</a> &raquo;</li>
  62. <li><a href="../../../../index.html">Module code</a> &raquo;</li>
  63. <li>grpc.framework.interfaces.links.test_cases</li>
  64. <li class="wy-breadcrumbs-aside">
  65. </li>
  66. </ul>
  67. <hr/>
  68. </div>
  69. <div role="main" class="document">
  70. <h1>Source code for grpc.framework.interfaces.links.test_cases</h1><div class="highlight"><pre>
  71. <span class="c"># Copyright 2015, Google Inc.</span>
  72. <span class="c"># All rights reserved.</span>
  73. <span class="c">#</span>
  74. <span class="c"># Redistribution and use in source and binary forms, with or without</span>
  75. <span class="c"># modification, are permitted provided that the following conditions are</span>
  76. <span class="c"># met:</span>
  77. <span class="c">#</span>
  78. <span class="c"># * Redistributions of source code must retain the above copyright</span>
  79. <span class="c"># notice, this list of conditions and the following disclaimer.</span>
  80. <span class="c"># * Redistributions in binary form must reproduce the above</span>
  81. <span class="c"># copyright notice, this list of conditions and the following disclaimer</span>
  82. <span class="c"># in the documentation and/or other materials provided with the</span>
  83. <span class="c"># distribution.</span>
  84. <span class="c"># * Neither the name of Google Inc. nor the names of its</span>
  85. <span class="c"># contributors may be used to endorse or promote products derived from</span>
  86. <span class="c"># this software without specific prior written permission.</span>
  87. <span class="c">#</span>
  88. <span class="c"># THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
  89. <span class="c"># &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
  90. <span class="c"># LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
  91. <span class="c"># A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
  92. <span class="c"># OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
  93. <span class="c"># SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
  94. <span class="c"># LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span>
  95. <span class="c"># DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span>
  96. <span class="c"># THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
  97. <span class="c"># (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
  98. <span class="c"># OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
  99. <span class="sd">&quot;&quot;&quot;Tests of the links interface of RPC Framework.&quot;&quot;&quot;</span>
  100. <span class="c"># unittest is referenced from specification in this module.</span>
  101. <span class="kn">import</span> <span class="nn">abc</span>
  102. <span class="kn">import</span> <span class="nn">unittest</span> <span class="c"># pylint: disable=unused-import</span>
  103. <span class="kn">from</span> <span class="nn">grpc.framework.common</span> <span class="kn">import</span> <span class="n">test_constants</span>
  104. <span class="kn">from</span> <span class="nn">grpc.framework.interfaces.links</span> <span class="kn">import</span> <span class="n">links</span>
  105. <span class="kn">from</span> <span class="nn">grpc.framework.interfaces.links</span> <span class="kn">import</span> <span class="n">test_utilities</span>
  106. <div class="viewcode-block" id="at_least_n_payloads_received_predicate"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.at_least_n_payloads_received_predicate">[docs]</a><span class="k">def</span> <span class="nf">at_least_n_payloads_received_predicate</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
  107. <span class="k">def</span> <span class="nf">predicate</span><span class="p">(</span><span class="n">ticket_sequence</span><span class="p">):</span>
  108. <span class="n">payload_count</span> <span class="o">=</span> <span class="mi">0</span>
  109. <span class="k">for</span> <span class="n">ticket</span> <span class="ow">in</span> <span class="n">ticket_sequence</span><span class="p">:</span>
  110. <span class="k">if</span> <span class="n">ticket</span><span class="o">.</span><span class="n">payload</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
  111. <span class="n">payload_count</span> <span class="o">+=</span> <span class="mi">1</span>
  112. <span class="k">if</span> <span class="n">n</span> <span class="o">&lt;=</span> <span class="n">payload_count</span><span class="p">:</span>
  113. <span class="k">return</span> <span class="bp">True</span>
  114. <span class="k">else</span><span class="p">:</span>
  115. <span class="k">return</span> <span class="bp">False</span>
  116. <span class="k">return</span> <span class="n">predicate</span>
  117. </div>
  118. <div class="viewcode-block" id="terminated"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.terminated">[docs]</a><span class="k">def</span> <span class="nf">terminated</span><span class="p">(</span><span class="n">ticket_sequence</span><span class="p">):</span>
  119. <span class="k">return</span> <span class="n">ticket_sequence</span> <span class="ow">and</span> <span class="n">ticket_sequence</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">termination</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
  120. </div>
  121. <span class="n">_TRANSMISSION_GROUP</span> <span class="o">=</span> <span class="s">&#39;test.Group&#39;</span>
  122. <span class="n">_TRANSMISSION_METHOD</span> <span class="o">=</span> <span class="s">&#39;TestMethod&#39;</span>
  123. <div class="viewcode-block" id="TransmissionTest"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest">[docs]</a><span class="k">class</span> <span class="nc">TransmissionTest</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  124. <span class="sd">&quot;&quot;&quot;Tests ticket transmission between two connected links.</span>
  125. <span class="sd"> This class must be mixed into a unittest.TestCase that implements the abstract</span>
  126. <span class="sd"> methods it provides.</span>
  127. <span class="sd"> &quot;&quot;&quot;</span>
  128. <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
  129. <span class="c"># This is a unittest.TestCase mix-in.</span>
  130. <span class="c"># pylint: disable=invalid-name</span>
  131. <span class="nd">@abc.abstractmethod</span>
  132. <div class="viewcode-block" id="TransmissionTest.create_transmitting_links"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.create_transmitting_links">[docs]</a> <span class="k">def</span> <span class="nf">create_transmitting_links</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  133. <span class="sd">&quot;&quot;&quot;Creates two connected links for use in this test.</span>
  134. <span class="sd"> Returns:</span>
  135. <span class="sd"> Two links.Links, the first of which will be used on the invocation side</span>
  136. <span class="sd"> of RPCs and the second of which will be used on the service side of</span>
  137. <span class="sd"> RPCs.</span>
  138. <span class="sd"> &quot;&quot;&quot;</span>
  139. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  140. </div>
  141. <span class="nd">@abc.abstractmethod</span>
  142. <div class="viewcode-block" id="TransmissionTest.destroy_transmitting_links"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.destroy_transmitting_links">[docs]</a> <span class="k">def</span> <span class="nf">destroy_transmitting_links</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">invocation_side_link</span><span class="p">,</span> <span class="n">service_side_link</span><span class="p">):</span>
  143. <span class="sd">&quot;&quot;&quot;Destroys the two connected links created for this test.</span>
  144. <span class="sd"> Args:</span>
  145. <span class="sd"> invocation_side_link: The link used on the invocation side of RPCs in</span>
  146. <span class="sd"> this test.</span>
  147. <span class="sd"> service_side_link: The link used on the service side of RPCs in this</span>
  148. <span class="sd"> test.</span>
  149. <span class="sd"> &quot;&quot;&quot;</span>
  150. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  151. </div>
  152. <span class="nd">@abc.abstractmethod</span>
  153. <div class="viewcode-block" id="TransmissionTest.create_invocation_initial_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.create_invocation_initial_metadata">[docs]</a> <span class="k">def</span> <span class="nf">create_invocation_initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  154. <span class="sd">&quot;&quot;&quot;Creates a value for use as invocation-side initial metadata.</span>
  155. <span class="sd"> Returns:</span>
  156. <span class="sd"> A metadata value appropriate for use as invocation-side initial metadata</span>
  157. <span class="sd"> or None if invocation-side initial metadata transmission is not</span>
  158. <span class="sd"> supported by the links under test.</span>
  159. <span class="sd"> &quot;&quot;&quot;</span>
  160. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  161. </div>
  162. <span class="nd">@abc.abstractmethod</span>
  163. <div class="viewcode-block" id="TransmissionTest.create_invocation_terminal_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.create_invocation_terminal_metadata">[docs]</a> <span class="k">def</span> <span class="nf">create_invocation_terminal_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  164. <span class="sd">&quot;&quot;&quot;Creates a value for use as invocation-side terminal metadata.</span>
  165. <span class="sd"> Returns:</span>
  166. <span class="sd"> A metadata value appropriate for use as invocation-side terminal</span>
  167. <span class="sd"> metadata or None if invocation-side terminal metadata transmission is</span>
  168. <span class="sd"> not supported by the links under test.</span>
  169. <span class="sd"> &quot;&quot;&quot;</span>
  170. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  171. </div>
  172. <span class="nd">@abc.abstractmethod</span>
  173. <div class="viewcode-block" id="TransmissionTest.create_service_initial_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.create_service_initial_metadata">[docs]</a> <span class="k">def</span> <span class="nf">create_service_initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  174. <span class="sd">&quot;&quot;&quot;Creates a value for use as service-side initial metadata.</span>
  175. <span class="sd"> Returns:</span>
  176. <span class="sd"> A metadata value appropriate for use as service-side initial metadata or</span>
  177. <span class="sd"> None if service-side initial metadata transmission is not supported by</span>
  178. <span class="sd"> the links under test.</span>
  179. <span class="sd"> &quot;&quot;&quot;</span>
  180. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  181. </div>
  182. <span class="nd">@abc.abstractmethod</span>
  183. <div class="viewcode-block" id="TransmissionTest.create_service_terminal_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.create_service_terminal_metadata">[docs]</a> <span class="k">def</span> <span class="nf">create_service_terminal_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  184. <span class="sd">&quot;&quot;&quot;Creates a value for use as service-side terminal metadata.</span>
  185. <span class="sd"> Returns:</span>
  186. <span class="sd"> A metadata value appropriate for use as service-side terminal metadata or</span>
  187. <span class="sd"> None if service-side terminal metadata transmission is not supported by</span>
  188. <span class="sd"> the links under test.</span>
  189. <span class="sd"> &quot;&quot;&quot;</span>
  190. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  191. </div>
  192. <span class="nd">@abc.abstractmethod</span>
  193. <div class="viewcode-block" id="TransmissionTest.create_invocation_completion"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.create_invocation_completion">[docs]</a> <span class="k">def</span> <span class="nf">create_invocation_completion</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  194. <span class="sd">&quot;&quot;&quot;Creates values for use as invocation-side code and message.</span>
  195. <span class="sd"> Returns:</span>
  196. <span class="sd"> An invocation-side code value and an invocation-side message value.</span>
  197. <span class="sd"> Either or both may be None if invocation-side code and/or</span>
  198. <span class="sd"> invocation-side message transmission is not supported by the links</span>
  199. <span class="sd"> under test.</span>
  200. <span class="sd"> &quot;&quot;&quot;</span>
  201. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  202. </div>
  203. <span class="nd">@abc.abstractmethod</span>
  204. <div class="viewcode-block" id="TransmissionTest.create_service_completion"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.create_service_completion">[docs]</a> <span class="k">def</span> <span class="nf">create_service_completion</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  205. <span class="sd">&quot;&quot;&quot;Creates values for use as service-side code and message.</span>
  206. <span class="sd"> Returns:</span>
  207. <span class="sd"> A service-side code value and a service-side message value. Either or</span>
  208. <span class="sd"> both may be None if service-side code and/or service-side message</span>
  209. <span class="sd"> transmission is not supported by the links under test.</span>
  210. <span class="sd"> &quot;&quot;&quot;</span>
  211. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  212. </div>
  213. <span class="nd">@abc.abstractmethod</span>
  214. <div class="viewcode-block" id="TransmissionTest.assertMetadataTransmitted"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.assertMetadataTransmitted">[docs]</a> <span class="k">def</span> <span class="nf">assertMetadataTransmitted</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">original_metadata</span><span class="p">,</span> <span class="n">transmitted_metadata</span><span class="p">):</span>
  215. <span class="sd">&quot;&quot;&quot;Asserts that transmitted_metadata contains original_metadata.</span>
  216. <span class="sd"> Args:</span>
  217. <span class="sd"> original_metadata: A metadata object used in this test.</span>
  218. <span class="sd"> transmitted_metadata: A metadata object obtained after transmission</span>
  219. <span class="sd"> through the system under test.</span>
  220. <span class="sd"> Raises:</span>
  221. <span class="sd"> AssertionError: if the transmitted_metadata object does not contain</span>
  222. <span class="sd"> original_metadata.</span>
  223. <span class="sd"> &quot;&quot;&quot;</span>
  224. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  225. </div>
  226. <div class="viewcode-block" id="TransmissionTest.group_and_method"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.group_and_method">[docs]</a> <span class="k">def</span> <span class="nf">group_and_method</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  227. <span class="sd">&quot;&quot;&quot;Returns the group and method used in this test case.</span>
  228. <span class="sd"> Returns:</span>
  229. <span class="sd"> A pair of the group and method used in this test case.</span>
  230. <span class="sd"> &quot;&quot;&quot;</span>
  231. <span class="k">return</span> <span class="n">_TRANSMISSION_GROUP</span><span class="p">,</span> <span class="n">_TRANSMISSION_METHOD</span>
  232. </div>
  233. <div class="viewcode-block" id="TransmissionTest.serialize_request"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.serialize_request">[docs]</a> <span class="k">def</span> <span class="nf">serialize_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
  234. <span class="sd">&quot;&quot;&quot;Serializes a request value used in this test case.</span>
  235. <span class="sd"> Args:</span>
  236. <span class="sd"> request: A request value created by this test case.</span>
  237. <span class="sd"> Returns:</span>
  238. <span class="sd"> A bytestring that is the serialization of the given request.</span>
  239. <span class="sd"> &quot;&quot;&quot;</span>
  240. <span class="k">return</span> <span class="n">request</span>
  241. </div>
  242. <div class="viewcode-block" id="TransmissionTest.deserialize_request"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.deserialize_request">[docs]</a> <span class="k">def</span> <span class="nf">deserialize_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">serialized_request</span><span class="p">):</span>
  243. <span class="sd">&quot;&quot;&quot;Deserializes a request value used in this test case.</span>
  244. <span class="sd"> Args:</span>
  245. <span class="sd"> serialized_request: A bytestring that is the serialization of some request</span>
  246. <span class="sd"> used in this test case.</span>
  247. <span class="sd"> Returns:</span>
  248. <span class="sd"> The request value encoded by the given bytestring.</span>
  249. <span class="sd"> &quot;&quot;&quot;</span>
  250. <span class="k">return</span> <span class="n">serialized_request</span>
  251. </div>
  252. <div class="viewcode-block" id="TransmissionTest.serialize_response"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.serialize_response">[docs]</a> <span class="k">def</span> <span class="nf">serialize_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
  253. <span class="sd">&quot;&quot;&quot;Serializes a response value used in this test case.</span>
  254. <span class="sd"> Args:</span>
  255. <span class="sd"> response: A response value created by this test case.</span>
  256. <span class="sd"> Returns:</span>
  257. <span class="sd"> A bytestring that is the serialization of the given response.</span>
  258. <span class="sd"> &quot;&quot;&quot;</span>
  259. <span class="k">return</span> <span class="n">response</span>
  260. </div>
  261. <div class="viewcode-block" id="TransmissionTest.deserialize_response"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.deserialize_response">[docs]</a> <span class="k">def</span> <span class="nf">deserialize_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">serialized_response</span><span class="p">):</span>
  262. <span class="sd">&quot;&quot;&quot;Deserializes a response value used in this test case.</span>
  263. <span class="sd"> Args:</span>
  264. <span class="sd"> serialized_response: A bytestring that is the serialization of some</span>
  265. <span class="sd"> response used in this test case.</span>
  266. <span class="sd"> Returns:</span>
  267. <span class="sd"> The response value encoded by the given bytestring.</span>
  268. <span class="sd"> &quot;&quot;&quot;</span>
  269. <span class="k">return</span> <span class="n">serialized_response</span>
  270. </div>
  271. <span class="k">def</span> <span class="nf">_assert_is_valid_metadata_payload_sequence</span><span class="p">(</span>
  272. <span class="bp">self</span><span class="p">,</span> <span class="n">ticket_sequence</span><span class="p">,</span> <span class="n">payloads</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">,</span> <span class="n">terminal_metadata</span><span class="p">):</span>
  273. <span class="n">initial_metadata_seen</span> <span class="o">=</span> <span class="bp">False</span>
  274. <span class="n">seen_payloads</span> <span class="o">=</span> <span class="p">[]</span>
  275. <span class="n">terminal_metadata_seen</span> <span class="o">=</span> <span class="bp">False</span>
  276. <span class="k">for</span> <span class="n">ticket</span> <span class="ow">in</span> <span class="n">ticket_sequence</span><span class="p">:</span>
  277. <span class="k">if</span> <span class="n">ticket</span><span class="o">.</span><span class="n">initial_metadata</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
  278. <span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">initial_metadata_seen</span><span class="p">)</span>
  279. <span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">seen_payloads</span><span class="p">)</span>
  280. <span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">terminal_metadata_seen</span><span class="p">)</span>
  281. <span class="bp">self</span><span class="o">.</span><span class="n">assertMetadataTransmitted</span><span class="p">(</span><span class="n">initial_metadata</span><span class="p">,</span> <span class="n">ticket</span><span class="o">.</span><span class="n">initial_metadata</span><span class="p">)</span>
  282. <span class="n">initial_metadata_seen</span> <span class="o">=</span> <span class="bp">True</span>
  283. <span class="k">if</span> <span class="n">ticket</span><span class="o">.</span><span class="n">payload</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
  284. <span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">terminal_metadata_seen</span><span class="p">)</span>
  285. <span class="n">seen_payloads</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ticket</span><span class="o">.</span><span class="n">payload</span><span class="p">)</span>
  286. <span class="k">if</span> <span class="n">ticket</span><span class="o">.</span><span class="n">terminal_metadata</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
  287. <span class="bp">self</span><span class="o">.</span><span class="n">assertFalse</span><span class="p">(</span><span class="n">terminal_metadata_seen</span><span class="p">)</span>
  288. <span class="bp">self</span><span class="o">.</span><span class="n">assertMetadataTransmitted</span><span class="p">(</span><span class="n">terminal_metadata</span><span class="p">,</span> <span class="n">ticket</span><span class="o">.</span><span class="n">terminal_metadata</span><span class="p">)</span>
  289. <span class="n">terminal_metadata_seen</span> <span class="o">=</span> <span class="bp">True</span>
  290. <span class="bp">self</span><span class="o">.</span><span class="n">assertSequenceEqual</span><span class="p">(</span><span class="n">payloads</span><span class="p">,</span> <span class="n">seen_payloads</span><span class="p">)</span>
  291. <span class="k">def</span> <span class="nf">_assert_is_valid_invocation_sequence</span><span class="p">(</span>
  292. <span class="bp">self</span><span class="p">,</span> <span class="n">ticket_sequence</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">payloads</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">,</span>
  293. <span class="n">terminal_metadata</span><span class="p">,</span> <span class="n">termination</span><span class="p">):</span>
  294. <span class="bp">self</span><span class="o">.</span><span class="n">assertLess</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">ticket_sequence</span><span class="p">))</span>
  295. <span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="n">group</span><span class="p">,</span> <span class="n">ticket_sequence</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">group</span><span class="p">)</span>
  296. <span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="n">method</span><span class="p">,</span> <span class="n">ticket_sequence</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">method</span><span class="p">)</span>
  297. <span class="bp">self</span><span class="o">.</span><span class="n">_assert_is_valid_metadata_payload_sequence</span><span class="p">(</span>
  298. <span class="n">ticket_sequence</span><span class="p">,</span> <span class="n">payloads</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">,</span> <span class="n">terminal_metadata</span><span class="p">)</span>
  299. <span class="bp">self</span><span class="o">.</span><span class="n">assertIs</span><span class="p">(</span><span class="n">termination</span><span class="p">,</span> <span class="n">ticket_sequence</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">termination</span><span class="p">)</span>
  300. <span class="k">def</span> <span class="nf">_assert_is_valid_service_sequence</span><span class="p">(</span>
  301. <span class="bp">self</span><span class="p">,</span> <span class="n">ticket_sequence</span><span class="p">,</span> <span class="n">payloads</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">,</span> <span class="n">terminal_metadata</span><span class="p">,</span>
  302. <span class="n">code</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">termination</span><span class="p">):</span>
  303. <span class="bp">self</span><span class="o">.</span><span class="n">assertLess</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">ticket_sequence</span><span class="p">))</span>
  304. <span class="bp">self</span><span class="o">.</span><span class="n">_assert_is_valid_metadata_payload_sequence</span><span class="p">(</span>
  305. <span class="n">ticket_sequence</span><span class="p">,</span> <span class="n">payloads</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">,</span> <span class="n">terminal_metadata</span><span class="p">)</span>
  306. <span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">ticket_sequence</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">code</span><span class="p">)</span>
  307. <span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">ticket_sequence</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
  308. <span class="bp">self</span><span class="o">.</span><span class="n">assertIs</span><span class="p">(</span><span class="n">termination</span><span class="p">,</span> <span class="n">ticket_sequence</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">termination</span><span class="p">)</span>
  309. <div class="viewcode-block" id="TransmissionTest.setUp"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.setUp">[docs]</a> <span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  310. <span class="bp">self</span><span class="o">.</span><span class="n">_invocation_link</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_service_link</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_transmitting_links</span><span class="p">()</span>
  311. <span class="bp">self</span><span class="o">.</span><span class="n">_invocation_mate</span> <span class="o">=</span> <span class="n">test_utilities</span><span class="o">.</span><span class="n">RecordingLink</span><span class="p">()</span>
  312. <span class="bp">self</span><span class="o">.</span><span class="n">_service_mate</span> <span class="o">=</span> <span class="n">test_utilities</span><span class="o">.</span><span class="n">RecordingLink</span><span class="p">()</span>
  313. <span class="bp">self</span><span class="o">.</span><span class="n">_invocation_link</span><span class="o">.</span><span class="n">join_link</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_invocation_mate</span><span class="p">)</span>
  314. <span class="bp">self</span><span class="o">.</span><span class="n">_service_link</span><span class="o">.</span><span class="n">join_link</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_service_mate</span><span class="p">)</span>
  315. </div>
  316. <div class="viewcode-block" id="TransmissionTest.tearDown"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.tearDown">[docs]</a> <span class="k">def</span> <span class="nf">tearDown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  317. <span class="bp">self</span><span class="o">.</span><span class="n">destroy_transmitting_links</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_invocation_link</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_service_link</span><span class="p">)</span>
  318. </div>
  319. <div class="viewcode-block" id="TransmissionTest.testSimplestRoundTrip"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.links.html#grpc.framework.interfaces.links.test_cases.TransmissionTest.testSimplestRoundTrip">[docs]</a> <span class="k">def</span> <span class="nf">testSimplestRoundTrip</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  320. <span class="sd">&quot;&quot;&quot;Tests transmission of one ticket in each direction.&quot;&quot;&quot;</span>
  321. <span class="n">invocation_operation_id</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
  322. <span class="n">invocation_payload</span> <span class="o">=</span> <span class="n">b</span><span class="s">&#39;</span><span class="se">\x07</span><span class="s">&#39;</span> <span class="o">*</span> <span class="mi">1023</span>
  323. <span class="n">timeout</span> <span class="o">=</span> <span class="n">test_constants</span><span class="o">.</span><span class="n">LONG_TIMEOUT</span>
  324. <span class="n">invocation_initial_metadata</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_invocation_initial_metadata</span><span class="p">()</span>
  325. <span class="n">invocation_terminal_metadata</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_invocation_terminal_metadata</span><span class="p">()</span>
  326. <span class="n">invocation_code</span><span class="p">,</span> <span class="n">invocation_message</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_invocation_completion</span><span class="p">()</span>
  327. <span class="n">service_payload</span> <span class="o">=</span> <span class="n">b</span><span class="s">&#39;</span><span class="se">\x08</span><span class="s">&#39;</span> <span class="o">*</span> <span class="mi">1025</span>
  328. <span class="n">service_initial_metadata</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_service_initial_metadata</span><span class="p">()</span>
  329. <span class="n">service_terminal_metadata</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_service_terminal_metadata</span><span class="p">()</span>
  330. <span class="n">service_code</span><span class="p">,</span> <span class="n">service_message</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">create_service_completion</span><span class="p">()</span>
  331. <span class="n">original_invocation_ticket</span> <span class="o">=</span> <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="p">(</span>
  332. <span class="n">invocation_operation_id</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">_TRANSMISSION_GROUP</span><span class="p">,</span> <span class="n">_TRANSMISSION_METHOD</span><span class="p">,</span>
  333. <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="o">.</span><span class="n">Subscription</span><span class="o">.</span><span class="n">FULL</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">invocation_initial_metadata</span><span class="p">,</span>
  334. <span class="n">invocation_payload</span><span class="p">,</span> <span class="n">invocation_terminal_metadata</span><span class="p">,</span> <span class="n">invocation_code</span><span class="p">,</span>
  335. <span class="n">invocation_message</span><span class="p">,</span> <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="o">.</span><span class="n">Termination</span><span class="o">.</span><span class="n">COMPLETION</span><span class="p">)</span>
  336. <span class="bp">self</span><span class="o">.</span><span class="n">_invocation_link</span><span class="o">.</span><span class="n">accept_ticket</span><span class="p">(</span><span class="n">original_invocation_ticket</span><span class="p">)</span>
  337. <span class="c"># TODO(nathaniel): This shouldn&#39;t be necessary. Detecting the end of the</span>
  338. <span class="c"># invocation-side ticket sequence shouldn&#39;t require granting allowance for</span>
  339. <span class="c"># another payload.</span>
  340. <span class="bp">self</span><span class="o">.</span><span class="n">_service_mate</span><span class="o">.</span><span class="n">block_until_tickets_satisfy</span><span class="p">(</span>
  341. <span class="n">at_least_n_payloads_received_predicate</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
  342. <span class="n">service_operation_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_service_mate</span><span class="o">.</span><span class="n">tickets</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">operation_id</span>
  343. <span class="bp">self</span><span class="o">.</span><span class="n">_service_link</span><span class="o">.</span><span class="n">accept_ticket</span><span class="p">(</span>
  344. <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="p">(</span>
  345. <span class="n">service_operation_id</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="o">.</span><span class="n">Subscription</span><span class="o">.</span><span class="n">FULL</span><span class="p">,</span>
  346. <span class="bp">None</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">))</span>
  347. <span class="bp">self</span><span class="o">.</span><span class="n">_service_mate</span><span class="o">.</span><span class="n">block_until_tickets_satisfy</span><span class="p">(</span><span class="n">terminated</span><span class="p">)</span>
  348. <span class="bp">self</span><span class="o">.</span><span class="n">_assert_is_valid_invocation_sequence</span><span class="p">(</span>
  349. <span class="bp">self</span><span class="o">.</span><span class="n">_service_mate</span><span class="o">.</span><span class="n">tickets</span><span class="p">(),</span> <span class="n">_TRANSMISSION_GROUP</span><span class="p">,</span> <span class="n">_TRANSMISSION_METHOD</span><span class="p">,</span>
  350. <span class="p">(</span><span class="n">invocation_payload</span><span class="p">,),</span> <span class="n">invocation_initial_metadata</span><span class="p">,</span>
  351. <span class="n">invocation_terminal_metadata</span><span class="p">,</span> <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="o">.</span><span class="n">Termination</span><span class="o">.</span><span class="n">COMPLETION</span><span class="p">)</span>
  352. <span class="n">original_service_ticket</span> <span class="o">=</span> <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="p">(</span>
  353. <span class="n">service_operation_id</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="o">.</span><span class="n">Subscription</span><span class="o">.</span><span class="n">FULL</span><span class="p">,</span>
  354. <span class="n">timeout</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">service_initial_metadata</span><span class="p">,</span> <span class="n">service_payload</span><span class="p">,</span>
  355. <span class="n">service_terminal_metadata</span><span class="p">,</span> <span class="n">service_code</span><span class="p">,</span> <span class="n">service_message</span><span class="p">,</span>
  356. <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="o">.</span><span class="n">Termination</span><span class="o">.</span><span class="n">COMPLETION</span><span class="p">)</span>
  357. <span class="bp">self</span><span class="o">.</span><span class="n">_service_link</span><span class="o">.</span><span class="n">accept_ticket</span><span class="p">(</span><span class="n">original_service_ticket</span><span class="p">)</span>
  358. <span class="bp">self</span><span class="o">.</span><span class="n">_invocation_mate</span><span class="o">.</span><span class="n">block_until_tickets_satisfy</span><span class="p">(</span><span class="n">terminated</span><span class="p">)</span>
  359. <span class="bp">self</span><span class="o">.</span><span class="n">_assert_is_valid_service_sequence</span><span class="p">(</span>
  360. <span class="bp">self</span><span class="o">.</span><span class="n">_invocation_mate</span><span class="o">.</span><span class="n">tickets</span><span class="p">(),</span> <span class="p">(</span><span class="n">service_payload</span><span class="p">,),</span>
  361. <span class="n">service_initial_metadata</span><span class="p">,</span> <span class="n">service_terminal_metadata</span><span class="p">,</span> <span class="n">service_code</span><span class="p">,</span>
  362. <span class="n">service_message</span><span class="p">,</span> <span class="n">links</span><span class="o">.</span><span class="n">Ticket</span><span class="o">.</span><span class="n">Termination</span><span class="o">.</span><span class="n">COMPLETION</span><span class="p">)</span></div></div>
  363. </pre></div>
  364. </div>
  365. <footer>
  366. <hr/>
  367. <div role="contentinfo">
  368. <p>
  369. &copy; Copyright 2015, Author.
  370. </p>
  371. </div>
  372. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  373. </footer>
  374. </div>
  375. </div>
  376. </section>
  377. </div>
  378. <script type="text/javascript">
  379. var DOCUMENTATION_OPTIONS = {
  380. URL_ROOT:'../../../../../',
  381. VERSION:'0.10.0a0',
  382. COLLAPSE_INDEX:false,
  383. FILE_SUFFIX:'.html',
  384. HAS_SOURCE: true
  385. };
  386. </script>
  387. <script type="text/javascript" src="../../../../../_static/jquery.js"></script>
  388. <script type="text/javascript" src="../../../../../_static/underscore.js"></script>
  389. <script type="text/javascript" src="../../../../../_static/doctools.js"></script>
  390. <script type="text/javascript" src="../../../../../_static/js/theme.js"></script>
  391. <script type="text/javascript">
  392. jQuery(function () {
  393. SphinxRtdTheme.StickyNav.enable();
  394. });
  395. </script>
  396. </body>
  397. </html>