This file is indexed.

/usr/share/doc/php-guzzlehttp-ringphp/html/testing.html is in php-guzzlehttp-ringphp-doc 1.1.0-2ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Testing &mdash; RingPHP</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="RingPHP" href="index.html"/>
        <link rel="prev" title="Client Handlers" href="client_handlers.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> RingPHP
          

          
          </a>

          
            
            
              <div class="version">
                1.0.0-alpha
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
                <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="spec.html">Specification</a></li>
<li class="toctree-l1"><a class="reference internal" href="futures.html">Futures</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_middleware.html">Client Middleware</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_handlers.html">Client Handlers</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Testing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#running-tests">Running Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="#test-server">Test Server</a></li>
</ul>
</li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">RingPHP</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          

 



<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
      
    <li>Testing</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/testing.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="testing">
<h1>Testing<a class="headerlink" href="#testing" title="Permalink to this headline"></a></h1>
<p>RingPHP tests client handlers using <a class="reference external" href="https://phpunit.de/">PHPUnit</a> and a
built-in node.js web server.</p>
<div class="section" id="running-tests">
<h2>Running Tests<a class="headerlink" href="#running-tests" title="Permalink to this headline"></a></h2>
<p>First, install the dependencies using <a class="reference external" href="https://getcomposer.org">Composer</a>.</p>
<blockquote>
<div>composer.phar install</div></blockquote>
<p>Next, run the unit tests using <code class="docutils literal"><span class="pre">Make</span></code>.</p>
<blockquote>
<div>make test</div></blockquote>
<p>The tests are also run on Travis-CI on each commit: <a class="reference external" href="https://travis-ci.org/guzzle/guzzle-ring">https://travis-ci.org/guzzle/guzzle-ring</a></p>
</div>
<div class="section" id="test-server">
<h2>Test Server<a class="headerlink" href="#test-server" title="Permalink to this headline"></a></h2>
<p>Testing client handlers usually involves actually sending HTTP requests.
RingPHP provides a node.js web server that returns canned responses and
keep a list of the requests that have been received. The server can then
be queried to get a list of the requests that were sent by the client so that
you can ensure that the client serialized and transferred requests as intended.</p>
<p>The server keeps a list of queued responses and returns responses that are
popped off of the queue as HTTP requests are received. When there are not
more responses to serve, the server returns a 500 error response.</p>
<p>The test server uses the <code class="docutils literal"><span class="pre">GuzzleHttp\Tests\Ring\Client\Server</span></code> class to
control the server.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Client\StreamHandler</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">GuzzleHttp\Tests\Ring\Client\Server</span><span class="p">;</span>

<span class="c1">// First return a 200 followed by a 404 response.</span>
<span class="nx">Server</span><span class="o">::</span><span class="na">enqueue</span><span class="p">([</span>
    <span class="p">[</span><span class="s1">&#39;status&#39;</span> <span class="o">=&gt;</span> <span class="mi">200</span><span class="p">],</span>
    <span class="p">[</span><span class="s1">&#39;status&#39;</span> <span class="o">=&gt;</span> <span class="mi">404</span><span class="p">]</span>
<span class="p">]);</span>

<span class="nv">$handler</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">StreamHandler</span><span class="p">();</span>

<span class="nv">$response</span> <span class="o">=</span> <span class="nv">$handler</span><span class="p">([</span>
    <span class="s1">&#39;http_method&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;GET&#39;</span><span class="p">,</span>
    <span class="s1">&#39;headers&#39;</span>     <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;host&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="nx">Server</span><span class="o">::</span><span class="nv">$host</span><span class="p">]],</span>
    <span class="s1">&#39;uri&#39;</span>         <span class="o">=&gt;</span> <span class="s1">&#39;/&#39;</span>
<span class="p">]);</span>

<span class="nb">assert</span><span class="p">(</span><span class="mi">200</span> <span class="o">==</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]);</span>

<span class="nv">$response</span> <span class="o">=</span> <span class="nv">$handler</span><span class="p">([</span>
    <span class="s1">&#39;http_method&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;HEAD&#39;</span><span class="p">,</span>
    <span class="s1">&#39;headers&#39;</span>     <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;host&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="nx">Server</span><span class="o">::</span><span class="nv">$host</span><span class="p">]],</span>
    <span class="s1">&#39;uri&#39;</span>         <span class="o">=&gt;</span> <span class="s1">&#39;/&#39;</span>
<span class="p">]);</span>

<span class="nb">assert</span><span class="p">(</span><span class="mi">404</span> <span class="o">==</span> <span class="nv">$response</span><span class="p">[</span><span class="s1">&#39;status&#39;</span><span class="p">]);</span>
</pre></div>
</div>
<p>After requests have been sent, you can get a list of the requests as they
were sent over the wire to ensure they were sent correctly.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$received</span> <span class="o">=</span> <span class="nx">Server</span><span class="o">::</span><span class="na">received</span><span class="p">();</span>

<span class="nb">assert</span><span class="p">(</span><span class="s1">&#39;GET&#39;</span> <span class="o">==</span> <span class="nv">$received</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s1">&#39;http_method&#39;</span><span class="p">]);</span>
<span class="nb">assert</span><span class="p">(</span><span class="s1">&#39;HEAD&#39;</span> <span class="o">==</span> <span class="nv">$received</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="s1">&#39;http_method&#39;</span><span class="p">]);</span>
</pre></div>
</div>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
      
        <a href="client_handlers.html" class="btn btn-neutral" title="Client Handlers" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2014, Michael Dowling.

    </p>
  </div>
  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>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>