This file is indexed.

/usr/share/doc/php-mockery/html/cookbook/mocking_hard_dependencies.html is in php-mockery-doc 0.9.4-1build1.

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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
<!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>Mocking Hard Dependencies (new Keyword) &mdash; Mockery Docs 0.9 documentation</title>
  

  
  

  

  
  
    

  

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

  

  
    <link rel="top" title="Mockery Docs 0.9 documentation" href="../index.html"/>
        <link rel="up" title="Cookbook" href="index.html"/>
        <link rel="prev" title="Detecting Mock Objects" href="detecting_mock_objects.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"> Mockery Docs
          

          
          </a>

          
            
            
              <div class="version">
                0.9
              </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>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cookbook</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="default_expectations.html">Default Mock Expectations</a></li>
<li class="toctree-l2"><a class="reference internal" href="detecting_mock_objects.html">Detecting Mock Objects</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="">Mocking Hard Dependencies (new Keyword)</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">Mockery Docs</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><a href="index.html">Cookbook</a> &raquo;</li>
      
    <li>Mocking Hard Dependencies (new Keyword)</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/cookbook/mocking_hard_dependencies.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="mocking-hard-dependencies-new-keyword">
<span id="index-0"></span><h1>Mocking Hard Dependencies (new Keyword)<a class="headerlink" href="#mocking-hard-dependencies-new-keyword" title="Permalink to this headline"></a></h1>
<p>One prerequisite to mock hard dependencies is that the code we are trying to test uses autoloading.</p>
<p>Let&#8217;s take the following code for an example:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp">&lt;?php</span>
<span class="k">namespace</span> <span class="nx">App</span><span class="p">;</span>
<span class="k">class</span> <span class="nc">Service</span>
<span class="p">{</span>
    <span class="k">function</span> <span class="nf">callExternalService</span><span class="p">(</span><span class="nv">$param</span><span class="p">)</span>
    <span class="p">{</span>
        <span class="nv">$externalService</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Service\External</span><span class="p">();</span>
        <span class="nv">$externalService</span><span class="o">-&gt;</span><span class="na">sendSomething</span><span class="p">(</span><span class="nv">$param</span><span class="p">);</span>
        <span class="k">return</span> <span class="nv">$externalService</span><span class="o">-&gt;</span><span class="na">getSomething</span><span class="p">();</span>
    <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The way we can test this without doing any changes to the code itself is by creating <a class="reference internal" href="../reference/instance_mocking.html"><em>instance mocks</em></a> by using the <code class="docutils literal"><span class="pre">overload</span></code> prefix.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp">&lt;?php</span>
<span class="k">namespace</span> <span class="nx">AppTest</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">Mockery</span> <span class="k">as</span> <span class="nx">m</span><span class="p">;</span>
<span class="k">class</span> <span class="nc">ServiceTest</span> <span class="k">extends</span> <span class="nx">\PHPUnit_Framework_TestCase</span>
<span class="p">{</span>
    <span class="k">public</span> <span class="k">function</span> <span class="nf">testCallingExternalService</span><span class="p">()</span>
    <span class="p">{</span>
        <span class="nv">$param</span> <span class="o">=</span> <span class="s1">&#39;Testing&#39;</span><span class="p">;</span>

        <span class="nv">$externalMock</span> <span class="o">=</span> <span class="nx">m</span><span class="o">::</span><span class="na">mock</span><span class="p">(</span><span class="s1">&#39;overload:App\Service\External&#39;</span><span class="p">);</span>
        <span class="nv">$externalMock</span><span class="o">-&gt;</span><span class="na">shouldReceive</span><span class="p">(</span><span class="s1">&#39;sendSomething&#39;</span><span class="p">)</span>
            <span class="o">-&gt;</span><span class="na">once</span><span class="p">()</span>
            <span class="o">-&gt;</span><span class="na">with</span><span class="p">(</span><span class="nv">$param</span><span class="p">);</span>
        <span class="nv">$externalMock</span><span class="o">-&gt;</span><span class="na">shouldReceive</span><span class="p">(</span><span class="s1">&#39;getSomething&#39;</span><span class="p">)</span>
            <span class="o">-&gt;</span><span class="na">once</span><span class="p">()</span>
            <span class="o">-&gt;</span><span class="na">andReturn</span><span class="p">(</span><span class="s1">&#39;Tested!&#39;</span><span class="p">);</span>

        <span class="nv">$service</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\App\Service</span><span class="p">();</span>

        <span class="nv">$result</span> <span class="o">=</span> <span class="nv">$service</span><span class="o">-&gt;</span><span class="na">callExternalService</span><span class="p">(</span><span class="nv">$param</span><span class="p">);</span>

        <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">assertSame</span><span class="p">(</span><span class="s1">&#39;Tested!&#39;</span><span class="p">,</span> <span class="nv">$result</span><span class="p">);</span>
    <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>If we run this test now, it should pass. Mockery does its job and our <code class="docutils literal"><span class="pre">App\Service</span></code> will use the mocked external service instead of the real one.</p>
<p>The problem with this is when we want to, for example, test the <code class="docutils literal"><span class="pre">App\Service\External</span></code> itself, or if we use that class somewhere else in our tests.</p>
<p>When Mockery overloads a class, because of how PHP works with files, that overloaded class file must not be included otherwise Mockery will throw a &#8220;class already exists&#8221; exception. This is where autoloading kicks in and makes our job a lot easier.</p>
<p>To make this possible, we&#8217;ll tell PHPUnit to run the tests that have overloaded classes in separate processes and to not preserve global state. That way we&#8217;ll avoid having the overloaded class included more than once. Of course this has its downsides as these tests will run slower.</p>
<p>Our test example from above now becomes:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="cp">&lt;?php</span>
<span class="k">namespace</span> <span class="nx">AppTest</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">Mockery</span> <span class="k">as</span> <span class="nx">m</span><span class="p">;</span>
<span class="sd">/**</span>
<span class="sd"> * @runTestsInSeparateProcesses</span>
<span class="sd"> * @preserveGlobalState disabled</span>
<span class="sd"> */</span>
<span class="k">class</span> <span class="nc">ServiceTest</span> <span class="k">extends</span> <span class="nx">\PHPUnit_Framework_TestCase</span>
<span class="p">{</span>
    <span class="k">public</span> <span class="k">function</span> <span class="nf">testCallingExternalService</span><span class="p">()</span>
    <span class="p">{</span>
        <span class="nv">$param</span> <span class="o">=</span> <span class="s1">&#39;Testing&#39;</span><span class="p">;</span>

        <span class="nv">$externalMock</span> <span class="o">=</span> <span class="nx">m</span><span class="o">::</span><span class="na">mock</span><span class="p">(</span><span class="s1">&#39;overload:App\Service\External&#39;</span><span class="p">);</span>
        <span class="nv">$externalMock</span><span class="o">-&gt;</span><span class="na">shouldReceive</span><span class="p">(</span><span class="s1">&#39;sendSomething&#39;</span><span class="p">)</span>
            <span class="o">-&gt;</span><span class="na">once</span><span class="p">()</span>
            <span class="o">-&gt;</span><span class="na">with</span><span class="p">(</span><span class="nv">$param</span><span class="p">);</span>
        <span class="nv">$externalMock</span><span class="o">-&gt;</span><span class="na">shouldReceive</span><span class="p">(</span><span class="s1">&#39;getSomething&#39;</span><span class="p">)</span>
            <span class="o">-&gt;</span><span class="na">once</span><span class="p">()</span>
            <span class="o">-&gt;</span><span class="na">andReturn</span><span class="p">(</span><span class="s1">&#39;Tested!&#39;</span><span class="p">);</span>

        <span class="nv">$service</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\App\Service</span><span class="p">();</span>

        <span class="nv">$result</span> <span class="o">=</span> <span class="nv">$service</span><span class="o">-&gt;</span><span class="na">callExternalService</span><span class="p">(</span><span class="nv">$param</span><span class="p">);</span>

        <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">assertSame</span><span class="p">(</span><span class="s1">&#39;Tested!&#39;</span><span class="p">,</span> <span class="nv">$result</span><span class="p">);</span>
    <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>


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

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2014, Pádraic Brady, Dave Marshall, Wouter, Graham Campbell.

    </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:'0.9',
            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>