python/mock-1.0.0/html/compare.html@b8a032363ba2 (annotated)
python/mock-1.0.0/html/compare.html
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | |
| michael@0 | 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| michael@0 | 3 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| michael@0 | 4 | |
| michael@0 | 5 | |
| michael@0 | 6 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| michael@0 | 7 | <head> |
| michael@0 | 8 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| michael@0 | 9 | |
| michael@0 | 10 | <title>Mock Library Comparison — Mock 1.0.0 documentation</title> |
| michael@0 | 11 | |
| michael@0 | 12 | <link rel="stylesheet" href="_static/nature.css" type="text/css" /> |
| michael@0 | 13 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| michael@0 | 14 | |
| michael@0 | 15 | <script type="text/javascript"> |
| michael@0 | 16 | var DOCUMENTATION_OPTIONS = { |
| michael@0 | 17 | URL_ROOT: '', |
| michael@0 | 18 | VERSION: '1.0.0', |
| michael@0 | 19 | COLLAPSE_INDEX: false, |
| michael@0 | 20 | FILE_SUFFIX: '.html', |
| michael@0 | 21 | HAS_SOURCE: true |
| michael@0 | 22 | }; |
| michael@0 | 23 | </script> |
| michael@0 | 24 | <script type="text/javascript" src="_static/jquery.js"></script> |
| michael@0 | 25 | <script type="text/javascript" src="_static/underscore.js"></script> |
| michael@0 | 26 | <script type="text/javascript" src="_static/doctools.js"></script> |
| michael@0 | 27 | <link rel="top" title="Mock 1.0.0 documentation" href="index.html" /> |
| michael@0 | 28 | <link rel="next" title="CHANGELOG" href="changelog.html" /> |
| michael@0 | 29 | <link rel="prev" title="Further Examples" href="examples.html" /> |
| michael@0 | 30 | </head> |
| michael@0 | 31 | <body> |
| michael@0 | 32 | <div class="related"> |
| michael@0 | 33 | <h3>Navigation</h3> |
| michael@0 | 34 | <ul> |
| michael@0 | 35 | <li class="right" style="margin-right: 10px"> |
| michael@0 | 36 | <a href="genindex.html" title="General Index" |
| michael@0 | 37 | accesskey="I">index</a></li> |
| michael@0 | 38 | <li class="right" > |
| michael@0 | 39 | <a href="changelog.html" title="CHANGELOG" |
| michael@0 | 40 | accesskey="N">next</a> |</li> |
| michael@0 | 41 | <li class="right" > |
| michael@0 | 42 | <a href="examples.html" title="Further Examples" |
| michael@0 | 43 | accesskey="P">previous</a> |</li> |
| michael@0 | 44 | <li><a href="index.html">Mock 1.0.0 documentation</a> »</li> |
| michael@0 | 45 | </ul> |
| michael@0 | 46 | </div> |
| michael@0 | 47 | |
| michael@0 | 48 | <div class="document"> |
| michael@0 | 49 | <div class="documentwrapper"> |
| michael@0 | 50 | <div class="bodywrapper"> |
| michael@0 | 51 | <div class="body"> |
| michael@0 | 52 | |
| michael@0 | 53 | <div class="section" id="mock-library-comparison"> |
| michael@0 | 54 | <h1>Mock Library Comparison<a class="headerlink" href="#mock-library-comparison" title="Permalink to this headline">¶</a></h1> |
| michael@0 | 55 | <p>A side-by-side comparison of how to accomplish some basic tasks with mock and |
| michael@0 | 56 | some other popular Python mocking libraries and frameworks.</p> |
| michael@0 | 57 | <p>These are:</p> |
| michael@0 | 58 | <ul class="simple"> |
| michael@0 | 59 | <li><a class="reference external" href="http://pypi.python.org/pypi/flexmock">flexmock</a></li> |
| michael@0 | 60 | <li><a class="reference external" href="http://pypi.python.org/pypi/mox">mox</a></li> |
| michael@0 | 61 | <li><a class="reference external" href="http://niemeyer.net/mocker">Mocker</a></li> |
| michael@0 | 62 | <li><a class="reference external" href="http://pypi.python.org/pypi/dingus">dingus</a></li> |
| michael@0 | 63 | <li><a class="reference external" href="http://pypi.python.org/pypi/fudge">fudge</a></li> |
| michael@0 | 64 | </ul> |
| michael@0 | 65 | <p>Popular python mocking frameworks not yet represented here include |
| michael@0 | 66 | <a class="reference external" href="http://pypi.python.org/pypi/MiniMock">MiniMock</a>.</p> |
| michael@0 | 67 | <p><a class="reference external" href="http://pmock.sourceforge.net/">pMock</a> (last release 2004 and doesn’t import |
| michael@0 | 68 | in recent versions of Python) and |
| michael@0 | 69 | <a class="reference external" href="http://python-mock.sourceforge.net/">python-mock</a> (last release 2005) are |
| michael@0 | 70 | intentionally omitted.</p> |
| michael@0 | 71 | <div class="admonition note"> |
| michael@0 | 72 | <p class="first admonition-title">Note</p> |
| michael@0 | 73 | <p>A more up to date, and tested for all mock libraries (only the mock |
| michael@0 | 74 | examples on this page can be executed as doctests) version of this |
| michael@0 | 75 | comparison is maintained by Gary Bernhardt:</p> |
| michael@0 | 76 | <ul class="last simple"> |
| michael@0 | 77 | <li><a class="reference external" href="http://garybernhardt.github.com/python-mock-comparison/">Python Mock Library Comparison</a></li> |
| michael@0 | 78 | </ul> |
| michael@0 | 79 | </div> |
| michael@0 | 80 | <p>This comparison is by no means complete, and also may not be fully idiomatic |
| michael@0 | 81 | for all the libraries represented. <em>Please</em> contribute corrections, missing |
| michael@0 | 82 | comparisons, or comparisons for additional libraries to the <a class="reference external" href="https://code.google.com/p/mock/issues/list">mock issue |
| michael@0 | 83 | tracker</a>.</p> |
| michael@0 | 84 | <p>This comparison page was originally created by the <a class="reference external" href="https://code.google.com/p/pymox/wiki/MoxComparison">Mox project</a> and then extended for |
| michael@0 | 85 | <a class="reference external" href="http://has207.github.com/flexmock/compare.html">flexmock and mock</a> by |
| michael@0 | 86 | Herman Sheremetyev. Dingus examples written by <a class="reference external" href="http://garybernhardt.github.com/python-mock-comparison/">Gary Bernhadt</a>. fudge examples |
| michael@0 | 87 | provided by <a class="reference external" href="http://farmdev.com/">Kumar McMillan</a>.</p> |
| michael@0 | 88 | <div class="admonition note"> |
| michael@0 | 89 | <p class="first admonition-title">Note</p> |
| michael@0 | 90 | <p>The examples tasks here were originally created by Mox which is a mocking |
| michael@0 | 91 | <em>framework</em> rather than a library like mock. The tasks shown naturally |
| michael@0 | 92 | exemplify tasks that frameworks are good at and not the ones they make |
| michael@0 | 93 | harder. In particular you can take a <cite>Mock</cite> or <cite>MagicMock</cite> object and use |
| michael@0 | 94 | it in any way you want with no up-front configuration. The same is also |
| michael@0 | 95 | true for Dingus.</p> |
| michael@0 | 96 | <p class="last">The examples for mock here assume version 0.7.0.</p> |
| michael@0 | 97 | </div> |
| michael@0 | 98 | <div class="section" id="simple-fake-object"> |
| michael@0 | 99 | <h2>Simple fake object<a class="headerlink" href="#simple-fake-object" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 100 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 101 | <span class="gp">>>> </span><span class="n">my_mock</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">Mock</span><span class="p">()</span> |
| michael@0 | 102 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">"calculated value"</span> |
| michael@0 | 103 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">some_attribute</span> <span class="o">=</span> <span class="s">"value"</span> |
| michael@0 | 104 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"calculated value"</span><span class="p">,</span> <span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 105 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">my_mock</span><span class="o">.</span><span class="n">some_attribute</span><span class="p">)</span> |
| michael@0 | 106 | </pre></div> |
| michael@0 | 107 | </div> |
| michael@0 | 108 | <div class="highlight-python"><div class="highlight"><pre><span class="c"># Flexmock</span> |
| michael@0 | 109 | <span class="n">mock</span> <span class="o">=</span> <span class="n">flexmock</span><span class="p">(</span><span class="n">some_method</span><span class="o">=</span><span class="k">lambda</span><span class="p">:</span> <span class="s">"calculated value"</span><span class="p">,</span> <span class="n">some_attribute</span><span class="o">=</span><span class="s">"value"</span><span class="p">)</span> |
| michael@0 | 110 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"calculated value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 111 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_attribute</span><span class="p">)</span> |
| michael@0 | 112 | |
| michael@0 | 113 | <span class="c"># Mox</span> |
| michael@0 | 114 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mox</span><span class="o">.</span><span class="n">MockAnything</span><span class="p">()</span> |
| michael@0 | 115 | <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span><span class="o">.</span><span class="n">AndReturn</span><span class="p">(</span><span class="s">"calculated value"</span><span class="p">)</span> |
| michael@0 | 116 | <span class="n">mock</span><span class="o">.</span><span class="n">some_attribute</span> <span class="o">=</span> <span class="s">"value"</span> |
| michael@0 | 117 | <span class="n">mox</span><span class="o">.</span><span class="n">Replay</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 118 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"calculated value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 119 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_attribute</span><span class="p">)</span> |
| michael@0 | 120 | |
| michael@0 | 121 | <span class="c"># Mocker</span> |
| michael@0 | 122 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mocker</span><span class="o">.</span><span class="n">mock</span><span class="p">()</span> |
| michael@0 | 123 | <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span> |
| michael@0 | 124 | <span class="n">mocker</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="s">"calculated value"</span><span class="p">)</span> |
| michael@0 | 125 | <span class="n">mocker</span><span class="o">.</span><span class="n">replay</span><span class="p">()</span> |
| michael@0 | 126 | <span class="n">mock</span><span class="o">.</span><span class="n">some_attribute</span> <span class="o">=</span> <span class="s">"value"</span> |
| michael@0 | 127 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"calculated value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 128 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_attribute</span><span class="p">)</span> |
| michael@0 | 129 | </pre></div> |
| michael@0 | 130 | </div> |
| michael@0 | 131 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus</span> |
| michael@0 | 132 | <span class="gp">>>> </span><span class="n">my_dingus</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">(</span><span class="n">some_attribute</span><span class="o">=</span><span class="s">"value"</span><span class="p">,</span> |
| michael@0 | 133 | <span class="gp">... </span> <span class="n">some_method__returns</span><span class="o">=</span><span class="s">"calculated value"</span><span class="p">)</span> |
| michael@0 | 134 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"calculated value"</span><span class="p">,</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 135 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">some_attribute</span><span class="p">)</span> |
| michael@0 | 136 | </pre></div> |
| michael@0 | 137 | </div> |
| michael@0 | 138 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 139 | <span class="gp">>>> </span><span class="n">my_fake</span> <span class="o">=</span> <span class="p">(</span><span class="n">fudge</span><span class="o">.</span><span class="n">Fake</span><span class="p">()</span> |
| michael@0 | 140 | <span class="gp">... </span> <span class="o">.</span><span class="n">provides</span><span class="p">(</span><span class="s">'some_method'</span><span class="p">)</span> |
| michael@0 | 141 | <span class="gp">... </span> <span class="o">.</span><span class="n">returns</span><span class="p">(</span><span class="s">"calculated value"</span><span class="p">)</span> |
| michael@0 | 142 | <span class="gp">... </span> <span class="o">.</span><span class="n">has_attr</span><span class="p">(</span><span class="n">some_attribute</span><span class="o">=</span><span class="s">"value"</span><span class="p">))</span> |
| michael@0 | 143 | <span class="gp">...</span> |
| michael@0 | 144 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"calculated value"</span><span class="p">,</span> <span class="n">my_fake</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 145 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">my_fake</span><span class="o">.</span><span class="n">some_attribute</span><span class="p">)</span> |
| michael@0 | 146 | </pre></div> |
| michael@0 | 147 | </div> |
| michael@0 | 148 | </div> |
| michael@0 | 149 | <div class="section" id="simple-mock"> |
| michael@0 | 150 | <h2>Simple mock<a class="headerlink" href="#simple-mock" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 151 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 152 | <span class="gp">>>> </span><span class="n">my_mock</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">Mock</span><span class="p">()</span> |
| michael@0 | 153 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">"value"</span> |
| michael@0 | 154 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 155 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="o">.</span><span class="n">assert_called_once_with</span><span class="p">()</span> |
| michael@0 | 156 | </pre></div> |
| michael@0 | 157 | </div> |
| michael@0 | 158 | <div class="highlight-python"><div class="highlight"><pre><span class="c"># Flexmock</span> |
| michael@0 | 159 | <span class="n">mock</span> <span class="o">=</span> <span class="n">flexmock</span><span class="p">()</span> |
| michael@0 | 160 | <span class="n">mock</span><span class="o">.</span><span class="n">should_receive</span><span class="p">(</span><span class="s">"some_method"</span><span class="p">)</span><span class="o">.</span><span class="n">and_return</span><span class="p">(</span><span class="s">"value"</span><span class="p">)</span><span class="o">.</span><span class="n">once</span> |
| michael@0 | 161 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 162 | |
| michael@0 | 163 | <span class="c"># Mox</span> |
| michael@0 | 164 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mox</span><span class="o">.</span><span class="n">MockAnything</span><span class="p">()</span> |
| michael@0 | 165 | <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span><span class="o">.</span><span class="n">AndReturn</span><span class="p">(</span><span class="s">"value"</span><span class="p">)</span> |
| michael@0 | 166 | <span class="n">mox</span><span class="o">.</span><span class="n">Replay</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 167 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 168 | <span class="n">mox</span><span class="o">.</span><span class="n">Verify</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 169 | |
| michael@0 | 170 | <span class="c"># Mocker</span> |
| michael@0 | 171 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mocker</span><span class="o">.</span><span class="n">mock</span><span class="p">()</span> |
| michael@0 | 172 | <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span> |
| michael@0 | 173 | <span class="n">mocker</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="s">"value"</span><span class="p">)</span> |
| michael@0 | 174 | <span class="n">mocker</span><span class="o">.</span><span class="n">replay</span><span class="p">()</span> |
| michael@0 | 175 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 176 | <span class="n">mocker</span><span class="o">.</span><span class="n">verify</span><span class="p">()</span> |
| michael@0 | 177 | </pre></div> |
| michael@0 | 178 | </div> |
| michael@0 | 179 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus</span> |
| michael@0 | 180 | <span class="gp">>>> </span><span class="n">my_dingus</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">(</span><span class="n">some_method__returns</span><span class="o">=</span><span class="s">"value"</span><span class="p">)</span> |
| michael@0 | 181 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 182 | <span class="gp">>>> </span><span class="k">assert</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">some_method</span><span class="o">.</span><span class="n">calls</span><span class="p">()</span><span class="o">.</span><span class="n">once</span><span class="p">()</span> |
| michael@0 | 183 | </pre></div> |
| michael@0 | 184 | </div> |
| michael@0 | 185 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 186 | <span class="gp">>>> </span><span class="nd">@fudge.test</span> |
| michael@0 | 187 | <span class="gp">... </span><span class="k">def</span> <span class="nf">test</span><span class="p">():</span> |
| michael@0 | 188 | <span class="gp">... </span> <span class="n">my_fake</span> <span class="o">=</span> <span class="p">(</span><span class="n">fudge</span><span class="o">.</span><span class="n">Fake</span><span class="p">()</span> |
| michael@0 | 189 | <span class="gp">... </span> <span class="o">.</span><span class="n">expects</span><span class="p">(</span><span class="s">'some_method'</span><span class="p">)</span> |
| michael@0 | 190 | <span class="gp">... </span> <span class="o">.</span><span class="n">returns</span><span class="p">(</span><span class="s">"value"</span><span class="p">)</span> |
| michael@0 | 191 | <span class="gp">... </span> <span class="o">.</span><span class="n">times_called</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span> |
| michael@0 | 192 | <span class="gp">...</span> |
| michael@0 | 193 | <span class="gp">>>> </span><span class="n">test</span><span class="p">()</span> |
| michael@0 | 194 | <span class="gt">Traceback (most recent call last):</span> |
| michael@0 | 195 | <span class="c">...</span> |
| michael@0 | 196 | <span class="gr">AssertionError</span>: <span class="n">fake:my_fake.some_method() was not called</span> |
| michael@0 | 197 | </pre></div> |
| michael@0 | 198 | </div> |
| michael@0 | 199 | </div> |
| michael@0 | 200 | <div class="section" id="creating-partial-mocks"> |
| michael@0 | 201 | <h2>Creating partial mocks<a class="headerlink" href="#creating-partial-mocks" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 202 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 203 | <span class="gp">>>> </span><span class="n">SomeObject</span><span class="o">.</span><span class="n">some_method</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">Mock</span><span class="p">(</span><span class="n">return_value</span><span class="o">=</span><span class="s">'value'</span><span class="p">)</span> |
| michael@0 | 204 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">SomeObject</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 205 | </pre></div> |
| michael@0 | 206 | </div> |
| michael@0 | 207 | <div class="highlight-python"><div class="highlight"><pre><span class="c"># Flexmock</span> |
| michael@0 | 208 | <span class="n">flexmock</span><span class="p">(</span><span class="n">SomeObject</span><span class="p">)</span><span class="o">.</span><span class="n">should_receive</span><span class="p">(</span><span class="s">"some_method"</span><span class="p">)</span><span class="o">.</span><span class="n">and_return</span><span class="p">(</span><span class="s">'value'</span><span class="p">)</span> |
| michael@0 | 209 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 210 | |
| michael@0 | 211 | <span class="c"># Mox</span> |
| michael@0 | 212 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mox</span><span class="o">.</span><span class="n">MockObject</span><span class="p">(</span><span class="n">SomeObject</span><span class="p">)</span> |
| michael@0 | 213 | <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span><span class="o">.</span><span class="n">AndReturn</span><span class="p">(</span><span class="s">"value"</span><span class="p">)</span> |
| michael@0 | 214 | <span class="n">mox</span><span class="o">.</span><span class="n">Replay</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 215 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 216 | <span class="n">mox</span><span class="o">.</span><span class="n">Verify</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 217 | |
| michael@0 | 218 | <span class="c"># Mocker</span> |
| michael@0 | 219 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mocker</span><span class="o">.</span><span class="n">mock</span><span class="p">(</span><span class="n">SomeObject</span><span class="p">)</span> |
| michael@0 | 220 | <span class="n">mock</span><span class="o">.</span><span class="n">Get</span><span class="p">()</span> |
| michael@0 | 221 | <span class="n">mocker</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="s">"value"</span><span class="p">)</span> |
| michael@0 | 222 | <span class="n">mocker</span><span class="o">.</span><span class="n">replay</span><span class="p">()</span> |
| michael@0 | 223 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 224 | <span class="n">mocker</span><span class="o">.</span><span class="n">verify</span><span class="p">()</span> |
| michael@0 | 225 | </pre></div> |
| michael@0 | 226 | </div> |
| michael@0 | 227 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus</span> |
| michael@0 | 228 | <span class="gp">>>> </span><span class="nb">object</span> <span class="o">=</span> <span class="n">SomeObject</span> |
| michael@0 | 229 | <span class="gp">>>> </span><span class="nb">object</span><span class="o">.</span><span class="n">some_method</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">(</span><span class="n">return_value</span><span class="o">=</span><span class="s">"value"</span><span class="p">)</span> |
| michael@0 | 230 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">"value"</span><span class="p">,</span> <span class="nb">object</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 231 | </pre></div> |
| michael@0 | 232 | </div> |
| michael@0 | 233 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 234 | <span class="gp">>>> </span><span class="n">fake</span> <span class="o">=</span> <span class="n">fudge</span><span class="o">.</span><span class="n">Fake</span><span class="p">()</span><span class="o">.</span><span class="n">is_callable</span><span class="p">()</span><span class="o">.</span><span class="n">returns</span><span class="p">(</span><span class="s">"<fudge-value>"</span><span class="p">)</span> |
| michael@0 | 235 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">fudge</span><span class="o">.</span><span class="n">patched_context</span><span class="p">(</span><span class="n">SomeObject</span><span class="p">,</span> <span class="s">'some_method'</span><span class="p">,</span> <span class="n">fake</span><span class="p">):</span> |
| michael@0 | 236 | <span class="gp">... </span> <span class="n">s</span> <span class="o">=</span> <span class="n">SomeObject</span><span class="p">()</span> |
| michael@0 | 237 | <span class="gp">... </span> <span class="n">assertEqual</span><span class="p">(</span><span class="s">"<fudge-value>"</span><span class="p">,</span> <span class="n">s</span><span class="o">.</span><span class="n">some_method</span><span class="p">())</span> |
| michael@0 | 238 | <span class="gp">...</span> |
| michael@0 | 239 | </pre></div> |
| michael@0 | 240 | </div> |
| michael@0 | 241 | </div> |
| michael@0 | 242 | <div class="section" id="ensure-calls-are-made-in-specific-order"> |
| michael@0 | 243 | <h2>Ensure calls are made in specific order<a class="headerlink" href="#ensure-calls-are-made-in-specific-order" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 244 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 245 | <span class="gp">>>> </span><span class="n">my_mock</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">Mock</span><span class="p">(</span><span class="n">spec</span><span class="o">=</span><span class="n">SomeObject</span><span class="p">)</span> |
| michael@0 | 246 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span> |
| michael@0 | 247 | <span class="go"><Mock name='mock.method1()' id='...'></span> |
| michael@0 | 248 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span> |
| michael@0 | 249 | <span class="go"><Mock name='mock.method2()' id='...'></span> |
| michael@0 | 250 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="n">my_mock</span><span class="o">.</span><span class="n">mock_calls</span><span class="p">,</span> <span class="p">[</span><span class="n">call</span><span class="o">.</span><span class="n">method1</span><span class="p">(),</span> <span class="n">call</span><span class="o">.</span><span class="n">method2</span><span class="p">()])</span> |
| michael@0 | 251 | </pre></div> |
| michael@0 | 252 | </div> |
| michael@0 | 253 | <div class="highlight-python"><div class="highlight"><pre><span class="c"># Flexmock</span> |
| michael@0 | 254 | <span class="n">mock</span> <span class="o">=</span> <span class="n">flexmock</span><span class="p">(</span><span class="n">SomeObject</span><span class="p">)</span> |
| michael@0 | 255 | <span class="n">mock</span><span class="o">.</span><span class="n">should_receive</span><span class="p">(</span><span class="s">'method1'</span><span class="p">)</span><span class="o">.</span><span class="n">once</span><span class="o">.</span><span class="n">ordered</span><span class="o">.</span><span class="n">and_return</span><span class="p">(</span><span class="s">'first thing'</span><span class="p">)</span> |
| michael@0 | 256 | <span class="n">mock</span><span class="o">.</span><span class="n">should_receive</span><span class="p">(</span><span class="s">'method2'</span><span class="p">)</span><span class="o">.</span><span class="n">once</span><span class="o">.</span><span class="n">ordered</span><span class="o">.</span><span class="n">and_return</span><span class="p">(</span><span class="s">'second thing'</span><span class="p">)</span> |
| michael@0 | 257 | |
| michael@0 | 258 | <span class="c"># Mox</span> |
| michael@0 | 259 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mox</span><span class="o">.</span><span class="n">MockObject</span><span class="p">(</span><span class="n">SomeObject</span><span class="p">)</span> |
| michael@0 | 260 | <span class="n">mock</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span><span class="o">.</span><span class="n">AndReturn</span><span class="p">(</span><span class="s">'first thing'</span><span class="p">)</span> |
| michael@0 | 261 | <span class="n">mock</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span><span class="o">.</span><span class="n">AndReturn</span><span class="p">(</span><span class="s">'second thing'</span><span class="p">)</span> |
| michael@0 | 262 | <span class="n">mox</span><span class="o">.</span><span class="n">Replay</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 263 | <span class="n">mox</span><span class="o">.</span><span class="n">Verify</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 264 | |
| michael@0 | 265 | <span class="c"># Mocker</span> |
| michael@0 | 266 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mocker</span><span class="o">.</span><span class="n">mock</span><span class="p">()</span> |
| michael@0 | 267 | <span class="k">with</span> <span class="n">mocker</span><span class="o">.</span><span class="n">order</span><span class="p">():</span> |
| michael@0 | 268 | <span class="n">mock</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span> |
| michael@0 | 269 | <span class="n">mocker</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="s">'first thing'</span><span class="p">)</span> |
| michael@0 | 270 | <span class="n">mock</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span> |
| michael@0 | 271 | <span class="n">mocker</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="s">'second thing'</span><span class="p">)</span> |
| michael@0 | 272 | <span class="n">mocker</span><span class="o">.</span><span class="n">replay</span><span class="p">()</span> |
| michael@0 | 273 | <span class="n">mocker</span><span class="o">.</span><span class="n">verify</span><span class="p">()</span> |
| michael@0 | 274 | </pre></div> |
| michael@0 | 275 | </div> |
| michael@0 | 276 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus</span> |
| michael@0 | 277 | <span class="gp">>>> </span><span class="n">my_dingus</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">()</span> |
| michael@0 | 278 | <span class="gp">>>> </span><span class="n">my_dingus</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span> |
| michael@0 | 279 | <span class="go"><Dingus ...></span> |
| michael@0 | 280 | <span class="gp">>>> </span><span class="n">my_dingus</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span> |
| michael@0 | 281 | <span class="go"><Dingus ...></span> |
| michael@0 | 282 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">([</span><span class="s">'method1'</span><span class="p">,</span> <span class="s">'method2'</span><span class="p">],</span> <span class="p">[</span><span class="n">call</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">call</span> <span class="ow">in</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">calls</span><span class="p">])</span> |
| michael@0 | 283 | </pre></div> |
| michael@0 | 284 | </div> |
| michael@0 | 285 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 286 | <span class="gp">>>> </span><span class="nd">@fudge.test</span> |
| michael@0 | 287 | <span class="gp">... </span><span class="k">def</span> <span class="nf">test</span><span class="p">():</span> |
| michael@0 | 288 | <span class="gp">... </span> <span class="n">my_fake</span> <span class="o">=</span> <span class="p">(</span><span class="n">fudge</span><span class="o">.</span><span class="n">Fake</span><span class="p">()</span> |
| michael@0 | 289 | <span class="gp">... </span> <span class="o">.</span><span class="n">remember_order</span><span class="p">()</span> |
| michael@0 | 290 | <span class="gp">... </span> <span class="o">.</span><span class="n">expects</span><span class="p">(</span><span class="s">'method1'</span><span class="p">)</span> |
| michael@0 | 291 | <span class="gp">... </span> <span class="o">.</span><span class="n">expects</span><span class="p">(</span><span class="s">'method2'</span><span class="p">))</span> |
| michael@0 | 292 | <span class="gp">... </span> <span class="n">my_fake</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span> |
| michael@0 | 293 | <span class="gp">... </span> <span class="n">my_fake</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span> |
| michael@0 | 294 | <span class="gp">...</span> |
| michael@0 | 295 | <span class="gp">>>> </span><span class="n">test</span><span class="p">()</span> |
| michael@0 | 296 | <span class="gt">Traceback (most recent call last):</span> |
| michael@0 | 297 | <span class="c">...</span> |
| michael@0 | 298 | <span class="gr">AssertionError: Call #1 was fake:my_fake.method2(); Expected</span>: <span class="n">#1 fake:my_fake.method1(), #2 fake:my_fake.method2(), end</span> |
| michael@0 | 299 | </pre></div> |
| michael@0 | 300 | </div> |
| michael@0 | 301 | </div> |
| michael@0 | 302 | <div class="section" id="raising-exceptions"> |
| michael@0 | 303 | <h2>Raising exceptions<a class="headerlink" href="#raising-exceptions" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 304 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 305 | <span class="gp">>>> </span><span class="n">my_mock</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">Mock</span><span class="p">()</span> |
| michael@0 | 306 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="o">.</span><span class="n">side_effect</span> <span class="o">=</span> <span class="n">SomeException</span><span class="p">(</span><span class="s">"message"</span><span class="p">)</span> |
| michael@0 | 307 | <span class="gp">>>> </span><span class="n">assertRaises</span><span class="p">(</span><span class="n">SomeException</span><span class="p">,</span> <span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">)</span> |
| michael@0 | 308 | </pre></div> |
| michael@0 | 309 | </div> |
| michael@0 | 310 | <div class="highlight-python"><div class="highlight"><pre><span class="c"># Flexmock</span> |
| michael@0 | 311 | <span class="n">mock</span> <span class="o">=</span> <span class="n">flexmock</span><span class="p">()</span> |
| michael@0 | 312 | <span class="n">mock</span><span class="o">.</span><span class="n">should_receive</span><span class="p">(</span><span class="s">"some_method"</span><span class="p">)</span><span class="o">.</span><span class="n">and_raise</span><span class="p">(</span><span class="n">SomeException</span><span class="p">(</span><span class="s">"message"</span><span class="p">))</span> |
| michael@0 | 313 | <span class="n">assertRaises</span><span class="p">(</span><span class="n">SomeException</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">)</span> |
| michael@0 | 314 | |
| michael@0 | 315 | <span class="c"># Mox</span> |
| michael@0 | 316 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mox</span><span class="o">.</span><span class="n">MockAnything</span><span class="p">()</span> |
| michael@0 | 317 | <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span><span class="o">.</span><span class="n">AndRaise</span><span class="p">(</span><span class="n">SomeException</span><span class="p">(</span><span class="s">"message"</span><span class="p">))</span> |
| michael@0 | 318 | <span class="n">mox</span><span class="o">.</span><span class="n">Replay</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 319 | <span class="n">assertRaises</span><span class="p">(</span><span class="n">SomeException</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">)</span> |
| michael@0 | 320 | <span class="n">mox</span><span class="o">.</span><span class="n">Verify</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 321 | |
| michael@0 | 322 | <span class="c"># Mocker</span> |
| michael@0 | 323 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mocker</span><span class="o">.</span><span class="n">mock</span><span class="p">()</span> |
| michael@0 | 324 | <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span> |
| michael@0 | 325 | <span class="n">mocker</span><span class="o">.</span><span class="n">throw</span><span class="p">(</span><span class="n">SomeException</span><span class="p">(</span><span class="s">"message"</span><span class="p">))</span> |
| michael@0 | 326 | <span class="n">mocker</span><span class="o">.</span><span class="n">replay</span><span class="p">()</span> |
| michael@0 | 327 | <span class="n">assertRaises</span><span class="p">(</span><span class="n">SomeException</span><span class="p">,</span> <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">)</span> |
| michael@0 | 328 | <span class="n">mocker</span><span class="o">.</span><span class="n">verify</span><span class="p">()</span> |
| michael@0 | 329 | </pre></div> |
| michael@0 | 330 | </div> |
| michael@0 | 331 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus</span> |
| michael@0 | 332 | <span class="gp">>>> </span><span class="n">my_dingus</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">()</span> |
| michael@0 | 333 | <span class="gp">>>> </span><span class="n">my_dingus</span><span class="o">.</span><span class="n">some_method</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">exception_raiser</span><span class="p">(</span><span class="n">SomeException</span><span class="p">)</span> |
| michael@0 | 334 | <span class="gp">>>> </span><span class="n">assertRaises</span><span class="p">(</span><span class="n">SomeException</span><span class="p">,</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">some_method</span><span class="p">)</span> |
| michael@0 | 335 | </pre></div> |
| michael@0 | 336 | </div> |
| michael@0 | 337 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 338 | <span class="gp">>>> </span><span class="n">my_fake</span> <span class="o">=</span> <span class="p">(</span><span class="n">fudge</span><span class="o">.</span><span class="n">Fake</span><span class="p">()</span> |
| michael@0 | 339 | <span class="gp">... </span> <span class="o">.</span><span class="n">is_callable</span><span class="p">()</span> |
| michael@0 | 340 | <span class="gp">... </span> <span class="o">.</span><span class="n">raises</span><span class="p">(</span><span class="n">SomeException</span><span class="p">(</span><span class="s">"message"</span><span class="p">)))</span> |
| michael@0 | 341 | <span class="gp">...</span> |
| michael@0 | 342 | <span class="gp">>>> </span><span class="n">my_fake</span><span class="p">()</span> |
| michael@0 | 343 | <span class="gt">Traceback (most recent call last):</span> |
| michael@0 | 344 | <span class="c">...</span> |
| michael@0 | 345 | <span class="gr">SomeException</span>: <span class="n">message</span> |
| michael@0 | 346 | </pre></div> |
| michael@0 | 347 | </div> |
| michael@0 | 348 | </div> |
| michael@0 | 349 | <div class="section" id="override-new-instances-of-a-class"> |
| michael@0 | 350 | <h2>Override new instances of a class<a class="headerlink" href="#override-new-instances-of-a-class" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 351 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 352 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">mock</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="s">'somemodule.Someclass'</span><span class="p">)</span> <span class="k">as</span> <span class="n">MockClass</span><span class="p">:</span> |
| michael@0 | 353 | <span class="gp">... </span> <span class="n">MockClass</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="n">some_other_object</span> |
| michael@0 | 354 | <span class="gp">... </span> <span class="n">assertEqual</span><span class="p">(</span><span class="n">some_other_object</span><span class="p">,</span> <span class="n">somemodule</span><span class="o">.</span><span class="n">Someclass</span><span class="p">())</span> |
| michael@0 | 355 | <span class="gp">...</span> |
| michael@0 | 356 | </pre></div> |
| michael@0 | 357 | </div> |
| michael@0 | 358 | <div class="highlight-python"><div class="highlight"><pre><span class="c"># Flexmock</span> |
| michael@0 | 359 | <span class="n">flexmock</span><span class="p">(</span><span class="n">some_module</span><span class="o">.</span><span class="n">SomeClass</span><span class="p">,</span> <span class="n">new_instances</span><span class="o">=</span><span class="n">some_other_object</span><span class="p">)</span> |
| michael@0 | 360 | <span class="n">assertEqual</span><span class="p">(</span><span class="n">some_other_object</span><span class="p">,</span> <span class="n">some_module</span><span class="o">.</span><span class="n">SomeClass</span><span class="p">())</span> |
| michael@0 | 361 | |
| michael@0 | 362 | <span class="c"># Mox</span> |
| michael@0 | 363 | <span class="c"># (you will probably have mox.Mox() available as self.mox in a real test)</span> |
| michael@0 | 364 | <span class="n">mox</span><span class="o">.</span><span class="n">Mox</span><span class="p">()</span><span class="o">.</span><span class="n">StubOutWithMock</span><span class="p">(</span><span class="n">some_module</span><span class="p">,</span> <span class="s">'SomeClass'</span><span class="p">,</span> <span class="n">use_mock_anything</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> |
| michael@0 | 365 | <span class="n">some_module</span><span class="o">.</span><span class="n">SomeClass</span><span class="p">()</span><span class="o">.</span><span class="n">AndReturn</span><span class="p">(</span><span class="n">some_other_object</span><span class="p">)</span> |
| michael@0 | 366 | <span class="n">mox</span><span class="o">.</span><span class="n">ReplayAll</span><span class="p">()</span> |
| michael@0 | 367 | <span class="n">assertEqual</span><span class="p">(</span><span class="n">some_other_object</span><span class="p">,</span> <span class="n">some_module</span><span class="o">.</span><span class="n">SomeClass</span><span class="p">())</span> |
| michael@0 | 368 | |
| michael@0 | 369 | <span class="c"># Mocker</span> |
| michael@0 | 370 | <span class="n">instance</span> <span class="o">=</span> <span class="n">mocker</span><span class="o">.</span><span class="n">mock</span><span class="p">()</span> |
| michael@0 | 371 | <span class="n">klass</span> <span class="o">=</span> <span class="n">mocker</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">SomeClass</span><span class="p">,</span> <span class="n">spec</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span> |
| michael@0 | 372 | <span class="n">klass</span><span class="p">(</span><span class="s">'expected'</span><span class="p">,</span> <span class="s">'args'</span><span class="p">)</span> |
| michael@0 | 373 | <span class="n">mocker</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="n">instance</span><span class="p">)</span> |
| michael@0 | 374 | </pre></div> |
| michael@0 | 375 | </div> |
| michael@0 | 376 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus</span> |
| michael@0 | 377 | <span class="gp">>>> </span><span class="n">MockClass</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">(</span><span class="n">return_value</span><span class="o">=</span><span class="n">some_other_object</span><span class="p">)</span> |
| michael@0 | 378 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">dingus</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="s">'somemodule.SomeClass'</span><span class="p">,</span> <span class="n">MockClass</span><span class="p">):</span> |
| michael@0 | 379 | <span class="gp">... </span> <span class="n">assertEqual</span><span class="p">(</span><span class="n">some_other_object</span><span class="p">,</span> <span class="n">somemodule</span><span class="o">.</span><span class="n">SomeClass</span><span class="p">())</span> |
| michael@0 | 380 | <span class="gp">...</span> |
| michael@0 | 381 | </pre></div> |
| michael@0 | 382 | </div> |
| michael@0 | 383 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 384 | <span class="gp">>>> </span><span class="nd">@fudge.patch</span><span class="p">(</span><span class="s">'somemodule.SomeClass'</span><span class="p">)</span> |
| michael@0 | 385 | <span class="gp">... </span><span class="k">def</span> <span class="nf">test</span><span class="p">(</span><span class="n">FakeClass</span><span class="p">):</span> |
| michael@0 | 386 | <span class="gp">... </span> <span class="n">FakeClass</span><span class="o">.</span><span class="n">is_callable</span><span class="p">()</span><span class="o">.</span><span class="n">returns</span><span class="p">(</span><span class="n">some_other_object</span><span class="p">)</span> |
| michael@0 | 387 | <span class="gp">... </span> <span class="n">assertEqual</span><span class="p">(</span><span class="n">some_other_object</span><span class="p">,</span> <span class="n">somemodule</span><span class="o">.</span><span class="n">SomeClass</span><span class="p">())</span> |
| michael@0 | 388 | <span class="gp">...</span> |
| michael@0 | 389 | <span class="gp">>>> </span><span class="n">test</span><span class="p">()</span> |
| michael@0 | 390 | </pre></div> |
| michael@0 | 391 | </div> |
| michael@0 | 392 | </div> |
| michael@0 | 393 | <div class="section" id="call-the-same-method-multiple-times"> |
| michael@0 | 394 | <h2>Call the same method multiple times<a class="headerlink" href="#call-the-same-method-multiple-times" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 395 | <div class="admonition note"> |
| michael@0 | 396 | <p class="first admonition-title">Note</p> |
| michael@0 | 397 | <p class="last">You don’t need to do <em>any</em> configuration to call <cite>mock.Mock()</cite> methods |
| michael@0 | 398 | multiple times. Attributes like <cite>call_count</cite>, <cite>call_args_list</cite> and |
| michael@0 | 399 | <cite>method_calls</cite> provide various different ways of making assertions about |
| michael@0 | 400 | how the mock was used.</p> |
| michael@0 | 401 | </div> |
| michael@0 | 402 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 403 | <span class="gp">>>> </span><span class="n">my_mock</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">Mock</span><span class="p">()</span> |
| michael@0 | 404 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span> |
| michael@0 | 405 | <span class="go"><Mock name='mock.some_method()' id='...'></span> |
| michael@0 | 406 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span> |
| michael@0 | 407 | <span class="go"><Mock name='mock.some_method()' id='...'></span> |
| michael@0 | 408 | <span class="gp">>>> </span><span class="k">assert</span> <span class="n">my_mock</span><span class="o">.</span><span class="n">some_method</span><span class="o">.</span><span class="n">call_count</span> <span class="o">>=</span> <span class="mi">2</span> |
| michael@0 | 409 | </pre></div> |
| michael@0 | 410 | </div> |
| michael@0 | 411 | <div class="highlight-python"><div class="highlight"><pre><span class="c"># Flexmock # (verifies that the method gets called at least twice)</span> |
| michael@0 | 412 | <span class="n">flexmock</span><span class="p">(</span><span class="n">some_object</span><span class="p">)</span><span class="o">.</span><span class="n">should_receive</span><span class="p">(</span><span class="s">'some_method'</span><span class="p">)</span><span class="o">.</span><span class="n">at_least</span><span class="o">.</span><span class="n">twice</span> |
| michael@0 | 413 | |
| michael@0 | 414 | <span class="c"># Mox</span> |
| michael@0 | 415 | <span class="c"># (does not support variable number of calls, so you need to create a new entry for each explicit call)</span> |
| michael@0 | 416 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mox</span><span class="o">.</span><span class="n">MockObject</span><span class="p">(</span><span class="n">some_object</span><span class="p">)</span> |
| michael@0 | 417 | <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">(</span><span class="n">mox</span><span class="o">.</span><span class="n">IgnoreArg</span><span class="p">(),</span> <span class="n">mox</span><span class="o">.</span><span class="n">IgnoreArg</span><span class="p">())</span> |
| michael@0 | 418 | <span class="n">mock</span><span class="o">.</span><span class="n">some_method</span><span class="p">(</span><span class="n">mox</span><span class="o">.</span><span class="n">IgnoreArg</span><span class="p">(),</span> <span class="n">mox</span><span class="o">.</span><span class="n">IgnoreArg</span><span class="p">())</span> |
| michael@0 | 419 | <span class="n">mox</span><span class="o">.</span><span class="n">Replay</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 420 | <span class="n">mox</span><span class="o">.</span><span class="n">Verify</span><span class="p">(</span><span class="n">mock</span><span class="p">)</span> |
| michael@0 | 421 | |
| michael@0 | 422 | <span class="c"># Mocker</span> |
| michael@0 | 423 | <span class="c"># (TODO)</span> |
| michael@0 | 424 | </pre></div> |
| michael@0 | 425 | </div> |
| michael@0 | 426 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus</span> |
| michael@0 | 427 | <span class="gp">>>> </span><span class="n">my_dingus</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">()</span> |
| michael@0 | 428 | <span class="gp">>>> </span><span class="n">my_dingus</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span> |
| michael@0 | 429 | <span class="go"><Dingus ...></span> |
| michael@0 | 430 | <span class="gp">>>> </span><span class="n">my_dingus</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span> |
| michael@0 | 431 | <span class="go"><Dingus ...></span> |
| michael@0 | 432 | <span class="gp">>>> </span><span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">my_dingus</span><span class="o">.</span><span class="n">calls</span><span class="p">(</span><span class="s">'some_method'</span><span class="p">))</span> <span class="o">==</span> <span class="mi">2</span> |
| michael@0 | 433 | </pre></div> |
| michael@0 | 434 | </div> |
| michael@0 | 435 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 436 | <span class="gp">>>> </span><span class="nd">@fudge.test</span> |
| michael@0 | 437 | <span class="gp">... </span><span class="k">def</span> <span class="nf">test</span><span class="p">():</span> |
| michael@0 | 438 | <span class="gp">... </span> <span class="n">my_fake</span> <span class="o">=</span> <span class="n">fudge</span><span class="o">.</span><span class="n">Fake</span><span class="p">()</span><span class="o">.</span><span class="n">expects</span><span class="p">(</span><span class="s">'some_method'</span><span class="p">)</span><span class="o">.</span><span class="n">times_called</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> |
| michael@0 | 439 | <span class="gp">... </span> <span class="n">my_fake</span><span class="o">.</span><span class="n">some_method</span><span class="p">()</span> |
| michael@0 | 440 | <span class="gp">...</span> |
| michael@0 | 441 | <span class="gp">>>> </span><span class="n">test</span><span class="p">()</span> |
| michael@0 | 442 | <span class="gt">Traceback (most recent call last):</span> |
| michael@0 | 443 | <span class="c">...</span> |
| michael@0 | 444 | <span class="gr">AssertionError</span>: <span class="n">fake:my_fake.some_method() was called 1 time(s). Expected 2.</span> |
| michael@0 | 445 | </pre></div> |
| michael@0 | 446 | </div> |
| michael@0 | 447 | </div> |
| michael@0 | 448 | <div class="section" id="mock-chained-methods"> |
| michael@0 | 449 | <h2>Mock chained methods<a class="headerlink" href="#mock-chained-methods" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 450 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 451 | <span class="gp">>>> </span><span class="n">my_mock</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">Mock</span><span class="p">()</span> |
| michael@0 | 452 | <span class="gp">>>> </span><span class="n">method3</span> <span class="o">=</span> <span class="n">my_mock</span><span class="o">.</span><span class="n">method1</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">method2</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">method3</span> |
| michael@0 | 453 | <span class="gp">>>> </span><span class="n">method3</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">'some value'</span> |
| michael@0 | 454 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">'some value'</span><span class="p">,</span> <span class="n">my_mock</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span><span class="o">.</span><span class="n">method3</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">))</span> |
| michael@0 | 455 | <span class="gp">>>> </span><span class="n">method3</span><span class="o">.</span><span class="n">assert_called_once_with</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> |
| michael@0 | 456 | </pre></div> |
| michael@0 | 457 | </div> |
| michael@0 | 458 | <div class="highlight-python"><div class="highlight"><pre><span class="c"># Flexmock</span> |
| michael@0 | 459 | <span class="c"># (intermediate method calls are automatically assigned to temporary fake objects</span> |
| michael@0 | 460 | <span class="c"># and can be called with any arguments)</span> |
| michael@0 | 461 | <span class="n">flexmock</span><span class="p">(</span><span class="n">some_object</span><span class="p">)</span><span class="o">.</span><span class="n">should_receive</span><span class="p">(</span> |
| michael@0 | 462 | <span class="s">'method1.method2.method3'</span> |
| michael@0 | 463 | <span class="p">)</span><span class="o">.</span><span class="n">with_args</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">)</span><span class="o">.</span><span class="n">and_return</span><span class="p">(</span><span class="s">'some value'</span><span class="p">)</span> |
| michael@0 | 464 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">'some_value'</span><span class="p">,</span> <span class="n">some_object</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span><span class="o">.</span><span class="n">method3</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">))</span> |
| michael@0 | 465 | </pre></div> |
| michael@0 | 466 | </div> |
| michael@0 | 467 | <div class="highlight-python"><div class="highlight"><pre><span class="c"># Mox</span> |
| michael@0 | 468 | <span class="n">mock</span> <span class="o">=</span> <span class="n">mox</span><span class="o">.</span><span class="n">MockObject</span><span class="p">(</span><span class="n">some_object</span><span class="p">)</span> |
| michael@0 | 469 | <span class="n">mock2</span> <span class="o">=</span> <span class="n">mox</span><span class="o">.</span><span class="n">MockAnything</span><span class="p">()</span> |
| michael@0 | 470 | <span class="n">mock3</span> <span class="o">=</span> <span class="n">mox</span><span class="o">.</span><span class="n">MockAnything</span><span class="p">()</span> |
| michael@0 | 471 | <span class="n">mock</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span><span class="o">.</span><span class="n">AndReturn</span><span class="p">(</span><span class="n">mock1</span><span class="p">)</span> |
| michael@0 | 472 | <span class="n">mock2</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span><span class="o">.</span><span class="n">AndReturn</span><span class="p">(</span><span class="n">mock2</span><span class="p">)</span> |
| michael@0 | 473 | <span class="n">mock3</span><span class="o">.</span><span class="n">method3</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">)</span><span class="o">.</span><span class="n">AndReturn</span><span class="p">(</span><span class="s">'some_value'</span><span class="p">)</span> |
| michael@0 | 474 | <span class="bp">self</span><span class="o">.</span><span class="n">mox</span><span class="o">.</span><span class="n">ReplayAll</span><span class="p">()</span> |
| michael@0 | 475 | <span class="n">assertEqual</span><span class="p">(</span><span class="s">"some_value"</span><span class="p">,</span> <span class="n">some_object</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span><span class="o">.</span><span class="n">method3</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">))</span> |
| michael@0 | 476 | <span class="bp">self</span><span class="o">.</span><span class="n">mox</span><span class="o">.</span><span class="n">VerifyAll</span><span class="p">()</span> |
| michael@0 | 477 | |
| michael@0 | 478 | <span class="c"># Mocker</span> |
| michael@0 | 479 | <span class="c"># (TODO)</span> |
| michael@0 | 480 | </pre></div> |
| michael@0 | 481 | </div> |
| michael@0 | 482 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus</span> |
| michael@0 | 483 | <span class="gp">>>> </span><span class="n">my_dingus</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">()</span> |
| michael@0 | 484 | <span class="gp">>>> </span><span class="n">method3</span> <span class="o">=</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">method1</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">method2</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">method3</span> |
| michael@0 | 485 | <span class="gp">>>> </span><span class="n">method3</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">'some value'</span> |
| michael@0 | 486 | <span class="gp">>>> </span><span class="n">assertEqual</span><span class="p">(</span><span class="s">'some value'</span><span class="p">,</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span><span class="o">.</span><span class="n">method3</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">))</span> |
| michael@0 | 487 | <span class="gp">>>> </span><span class="k">assert</span> <span class="n">method3</span><span class="o">.</span><span class="n">calls</span><span class="p">(</span><span class="s">'()'</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">once</span><span class="p">()</span> |
| michael@0 | 488 | </pre></div> |
| michael@0 | 489 | </div> |
| michael@0 | 490 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 491 | <span class="gp">>>> </span><span class="nd">@fudge.test</span> |
| michael@0 | 492 | <span class="gp">... </span><span class="k">def</span> <span class="nf">test</span><span class="p">():</span> |
| michael@0 | 493 | <span class="gp">... </span> <span class="n">my_fake</span> <span class="o">=</span> <span class="n">fudge</span><span class="o">.</span><span class="n">Fake</span><span class="p">()</span> |
| michael@0 | 494 | <span class="gp">... </span> <span class="p">(</span><span class="n">my_fake</span> |
| michael@0 | 495 | <span class="gp">... </span> <span class="o">.</span><span class="n">expects</span><span class="p">(</span><span class="s">'method1'</span><span class="p">)</span> |
| michael@0 | 496 | <span class="gp">... </span> <span class="o">.</span><span class="n">returns_fake</span><span class="p">()</span> |
| michael@0 | 497 | <span class="gp">... </span> <span class="o">.</span><span class="n">expects</span><span class="p">(</span><span class="s">'method2'</span><span class="p">)</span> |
| michael@0 | 498 | <span class="gp">... </span> <span class="o">.</span><span class="n">returns_fake</span><span class="p">()</span> |
| michael@0 | 499 | <span class="gp">... </span> <span class="o">.</span><span class="n">expects</span><span class="p">(</span><span class="s">'method3'</span><span class="p">)</span> |
| michael@0 | 500 | <span class="gp">... </span> <span class="o">.</span><span class="n">with_args</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> |
| michael@0 | 501 | <span class="gp">... </span> <span class="o">.</span><span class="n">returns</span><span class="p">(</span><span class="s">'some value'</span><span class="p">))</span> |
| michael@0 | 502 | <span class="gp">... </span> <span class="n">assertEqual</span><span class="p">(</span><span class="s">'some value'</span><span class="p">,</span> <span class="n">my_fake</span><span class="o">.</span><span class="n">method1</span><span class="p">()</span><span class="o">.</span><span class="n">method2</span><span class="p">()</span><span class="o">.</span><span class="n">method3</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">))</span> |
| michael@0 | 503 | <span class="gp">...</span> |
| michael@0 | 504 | <span class="gp">>>> </span><span class="n">test</span><span class="p">()</span> |
| michael@0 | 505 | </pre></div> |
| michael@0 | 506 | </div> |
| michael@0 | 507 | </div> |
| michael@0 | 508 | <div class="section" id="mocking-a-context-manager"> |
| michael@0 | 509 | <h2>Mocking a context manager<a class="headerlink" href="#mocking-a-context-manager" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 510 | <p>Examples for mock, Dingus and fudge only (so far):</p> |
| michael@0 | 511 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 512 | <span class="gp">>>> </span><span class="n">my_mock</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">MagicMock</span><span class="p">()</span> |
| michael@0 | 513 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">my_mock</span><span class="p">:</span> |
| michael@0 | 514 | <span class="gp">... </span> <span class="k">pass</span> |
| michael@0 | 515 | <span class="gp">...</span> |
| michael@0 | 516 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">__enter__</span><span class="o">.</span><span class="n">assert_called_with</span><span class="p">()</span> |
| michael@0 | 517 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">__exit__</span><span class="o">.</span><span class="n">assert_called_with</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> |
| michael@0 | 518 | </pre></div> |
| michael@0 | 519 | </div> |
| michael@0 | 520 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus (nothing special here; all dinguses are "magic mocks")</span> |
| michael@0 | 521 | <span class="gp">>>> </span><span class="n">my_dingus</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">()</span> |
| michael@0 | 522 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">my_dingus</span><span class="p">:</span> |
| michael@0 | 523 | <span class="gp">... </span> <span class="k">pass</span> |
| michael@0 | 524 | <span class="gp">...</span> |
| michael@0 | 525 | <span class="gp">>>> </span><span class="k">assert</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">__enter__</span><span class="o">.</span><span class="n">calls</span><span class="p">()</span> |
| michael@0 | 526 | <span class="gp">>>> </span><span class="k">assert</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">__exit__</span><span class="o">.</span><span class="n">calls</span><span class="p">(</span><span class="s">'()'</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> |
| michael@0 | 527 | </pre></div> |
| michael@0 | 528 | </div> |
| michael@0 | 529 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 530 | <span class="gp">>>> </span><span class="n">my_fake</span> <span class="o">=</span> <span class="n">fudge</span><span class="o">.</span><span class="n">Fake</span><span class="p">()</span><span class="o">.</span><span class="n">provides</span><span class="p">(</span><span class="s">'__enter__'</span><span class="p">)</span><span class="o">.</span><span class="n">provides</span><span class="p">(</span><span class="s">'__exit__'</span><span class="p">)</span> |
| michael@0 | 531 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">my_fake</span><span class="p">:</span> |
| michael@0 | 532 | <span class="gp">... </span> <span class="k">pass</span> |
| michael@0 | 533 | <span class="gp">...</span> |
| michael@0 | 534 | </pre></div> |
| michael@0 | 535 | </div> |
| michael@0 | 536 | </div> |
| michael@0 | 537 | <div class="section" id="mocking-the-builtin-open-used-as-a-context-manager"> |
| michael@0 | 538 | <h2>Mocking the builtin open used as a context manager<a class="headerlink" href="#mocking-the-builtin-open-used-as-a-context-manager" title="Permalink to this headline">¶</a></h2> |
| michael@0 | 539 | <p>Example for mock only (so far):</p> |
| michael@0 | 540 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 541 | <span class="gp">>>> </span><span class="n">my_mock</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">MagicMock</span><span class="p">()</span> |
| michael@0 | 542 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">mock</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="s">'__builtin__.open'</span><span class="p">,</span> <span class="n">my_mock</span><span class="p">):</span> |
| michael@0 | 543 | <span class="gp">... </span> <span class="n">manager</span> <span class="o">=</span> <span class="n">my_mock</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">__enter__</span><span class="o">.</span><span class="n">return_value</span> |
| michael@0 | 544 | <span class="gp">... </span> <span class="n">manager</span><span class="o">.</span><span class="n">read</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">'some data'</span> |
| michael@0 | 545 | <span class="gp">... </span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">'foo'</span><span class="p">)</span> <span class="k">as</span> <span class="n">h</span><span class="p">:</span> |
| michael@0 | 546 | <span class="gp">... </span> <span class="n">data</span> <span class="o">=</span> <span class="n">h</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> |
| michael@0 | 547 | <span class="gp">...</span> |
| michael@0 | 548 | <span class="gp">>>> </span><span class="n">data</span> |
| michael@0 | 549 | <span class="go">'some data'</span> |
| michael@0 | 550 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">assert_called_once_with</span><span class="p">(</span><span class="s">'foo'</span><span class="p">)</span> |
| michael@0 | 551 | </pre></div> |
| michael@0 | 552 | </div> |
| michael@0 | 553 | <p><em>or</em>:</p> |
| michael@0 | 554 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># mock</span> |
| michael@0 | 555 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">mock</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="s">'__builtin__.open'</span><span class="p">)</span> <span class="k">as</span> <span class="n">my_mock</span><span class="p">:</span> |
| michael@0 | 556 | <span class="gp">... </span> <span class="n">my_mock</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">__enter__</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span> |
| michael@0 | 557 | <span class="gp">... </span> <span class="n">my_mock</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">__exit__</span> <span class="o">=</span> <span class="n">mock</span><span class="o">.</span><span class="n">Mock</span><span class="p">()</span> |
| michael@0 | 558 | <span class="gp">... </span> <span class="n">my_mock</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">read</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">'some data'</span> |
| michael@0 | 559 | <span class="gp">... </span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">'foo'</span><span class="p">)</span> <span class="k">as</span> <span class="n">h</span><span class="p">:</span> |
| michael@0 | 560 | <span class="gp">... </span> <span class="n">data</span> <span class="o">=</span> <span class="n">h</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> |
| michael@0 | 561 | <span class="gp">...</span> |
| michael@0 | 562 | <span class="gp">>>> </span><span class="n">data</span> |
| michael@0 | 563 | <span class="go">'some data'</span> |
| michael@0 | 564 | <span class="gp">>>> </span><span class="n">my_mock</span><span class="o">.</span><span class="n">assert_called_once_with</span><span class="p">(</span><span class="s">'foo'</span><span class="p">)</span> |
| michael@0 | 565 | </pre></div> |
| michael@0 | 566 | </div> |
| michael@0 | 567 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># Dingus</span> |
| michael@0 | 568 | <span class="gp">>>> </span><span class="n">my_dingus</span> <span class="o">=</span> <span class="n">dingus</span><span class="o">.</span><span class="n">Dingus</span><span class="p">()</span> |
| michael@0 | 569 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">dingus</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="s">'__builtin__.open'</span><span class="p">,</span> <span class="n">my_dingus</span><span class="p">):</span> |
| michael@0 | 570 | <span class="gp">... </span> <span class="n">file_</span> <span class="o">=</span> <span class="nb">open</span><span class="o">.</span><span class="n">return_value</span><span class="o">.</span><span class="n">__enter__</span><span class="o">.</span><span class="n">return_value</span> |
| michael@0 | 571 | <span class="gp">... </span> <span class="n">file_</span><span class="o">.</span><span class="n">read</span><span class="o">.</span><span class="n">return_value</span> <span class="o">=</span> <span class="s">'some data'</span> |
| michael@0 | 572 | <span class="gp">... </span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">'foo'</span><span class="p">)</span> <span class="k">as</span> <span class="n">h</span><span class="p">:</span> |
| michael@0 | 573 | <span class="gp">... </span> <span class="n">data</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> |
| michael@0 | 574 | <span class="gp">...</span> |
| michael@0 | 575 | <span class="gp">>>> </span><span class="n">data</span> |
| michael@0 | 576 | <span class="go">'some data'</span> |
| michael@0 | 577 | <span class="gp">>>> </span><span class="k">assert</span> <span class="n">my_dingus</span><span class="o">.</span><span class="n">calls</span><span class="p">(</span><span class="s">'()'</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">)</span><span class="o">.</span><span class="n">once</span><span class="p">()</span> |
| michael@0 | 578 | </pre></div> |
| michael@0 | 579 | </div> |
| michael@0 | 580 | <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c"># fudge</span> |
| michael@0 | 581 | <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">contextlib</span> <span class="kn">import</span> <span class="n">contextmanager</span> |
| michael@0 | 582 | <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">StringIO</span> <span class="kn">import</span> <span class="n">StringIO</span> |
| michael@0 | 583 | <span class="gp">>>> </span><span class="nd">@contextmanager</span> |
| michael@0 | 584 | <span class="gp">... </span><span class="k">def</span> <span class="nf">fake_file</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span> |
| michael@0 | 585 | <span class="gp">... </span> <span class="k">yield</span> <span class="n">StringIO</span><span class="p">(</span><span class="s">'sekrets'</span><span class="p">)</span> |
| michael@0 | 586 | <span class="gp">...</span> |
| michael@0 | 587 | <span class="gp">>>> </span><span class="k">with</span> <span class="n">fudge</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="s">'__builtin__.open'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fake_open</span><span class="p">:</span> |
| michael@0 | 588 | <span class="gp">... </span> <span class="n">fake_open</span><span class="o">.</span><span class="n">is_callable</span><span class="p">()</span><span class="o">.</span><span class="n">calls</span><span class="p">(</span><span class="n">fake_file</span><span class="p">)</span> |
| michael@0 | 589 | <span class="gp">... </span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">'/etc/password'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> |
| michael@0 | 590 | <span class="gp">... </span> <span class="n">data</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> |
| michael@0 | 591 | <span class="gp">...</span> |
| michael@0 | 592 | <span class="go">fake:__builtin__.open</span> |
| michael@0 | 593 | <span class="gp">>>> </span><span class="n">data</span> |
| michael@0 | 594 | <span class="go">'sekrets'</span> |
| michael@0 | 595 | </pre></div> |
| michael@0 | 596 | </div> |
| michael@0 | 597 | </div> |
| michael@0 | 598 | </div> |
| michael@0 | 599 | |
| michael@0 | 600 | |
| michael@0 | 601 | </div> |
| michael@0 | 602 | </div> |
| michael@0 | 603 | </div> |
| michael@0 | 604 | <div class="sphinxsidebar"> |
| michael@0 | 605 | <div class="sphinxsidebarwrapper"> |
| michael@0 | 606 | <h3><a href="index.html">Table Of Contents</a></h3> |
| michael@0 | 607 | <ul> |
| michael@0 | 608 | <li><a class="reference internal" href="#">Mock Library Comparison</a><ul> |
| michael@0 | 609 | <li><a class="reference internal" href="#simple-fake-object">Simple fake object</a></li> |
| michael@0 | 610 | <li><a class="reference internal" href="#simple-mock">Simple mock</a></li> |
| michael@0 | 611 | <li><a class="reference internal" href="#creating-partial-mocks">Creating partial mocks</a></li> |
| michael@0 | 612 | <li><a class="reference internal" href="#ensure-calls-are-made-in-specific-order">Ensure calls are made in specific order</a></li> |
| michael@0 | 613 | <li><a class="reference internal" href="#raising-exceptions">Raising exceptions</a></li> |
| michael@0 | 614 | <li><a class="reference internal" href="#override-new-instances-of-a-class">Override new instances of a class</a></li> |
| michael@0 | 615 | <li><a class="reference internal" href="#call-the-same-method-multiple-times">Call the same method multiple times</a></li> |
| michael@0 | 616 | <li><a class="reference internal" href="#mock-chained-methods">Mock chained methods</a></li> |
| michael@0 | 617 | <li><a class="reference internal" href="#mocking-a-context-manager">Mocking a context manager</a></li> |
| michael@0 | 618 | <li><a class="reference internal" href="#mocking-the-builtin-open-used-as-a-context-manager">Mocking the builtin open used as a context manager</a></li> |
| michael@0 | 619 | </ul> |
| michael@0 | 620 | </li> |
| michael@0 | 621 | </ul> |
| michael@0 | 622 | |
| michael@0 | 623 | <h4>Previous topic</h4> |
| michael@0 | 624 | <p class="topless"><a href="examples.html" |
| michael@0 | 625 | title="previous chapter">Further Examples</a></p> |
| michael@0 | 626 | <h4>Next topic</h4> |
| michael@0 | 627 | <p class="topless"><a href="changelog.html" |
| michael@0 | 628 | title="next chapter">CHANGELOG</a></p> |
| michael@0 | 629 | <h3>This Page</h3> |
| michael@0 | 630 | <ul class="this-page-menu"> |
| michael@0 | 631 | <li><a href="_sources/compare.txt" |
| michael@0 | 632 | rel="nofollow">Show Source</a></li> |
| michael@0 | 633 | </ul> |
| michael@0 | 634 | <div id="searchbox" style="display: none"> |
| michael@0 | 635 | <h3>Quick search</h3> |
| michael@0 | 636 | <form class="search" action="search.html" method="get"> |
| michael@0 | 637 | <input type="text" name="q" /> |
| michael@0 | 638 | <input type="submit" value="Go" /> |
| michael@0 | 639 | <input type="hidden" name="check_keywords" value="yes" /> |
| michael@0 | 640 | <input type="hidden" name="area" value="default" /> |
| michael@0 | 641 | </form> |
| michael@0 | 642 | <p class="searchtip" style="font-size: 90%"> |
| michael@0 | 643 | Enter search terms or a module, class or function name. |
| michael@0 | 644 | </p> |
| michael@0 | 645 | </div> |
| michael@0 | 646 | <script type="text/javascript">$('#searchbox').show(0);</script> |
| michael@0 | 647 | </div> |
| michael@0 | 648 | </div> |
| michael@0 | 649 | <div class="clearer"></div> |
| michael@0 | 650 | </div> |
| michael@0 | 651 | <div class="related"> |
| michael@0 | 652 | <h3>Navigation</h3> |
| michael@0 | 653 | <ul> |
| michael@0 | 654 | <li class="right" style="margin-right: 10px"> |
| michael@0 | 655 | <a href="genindex.html" title="General Index" |
| michael@0 | 656 | >index</a></li> |
| michael@0 | 657 | <li class="right" > |
| michael@0 | 658 | <a href="changelog.html" title="CHANGELOG" |
| michael@0 | 659 | >next</a> |</li> |
| michael@0 | 660 | <li class="right" > |
| michael@0 | 661 | <a href="examples.html" title="Further Examples" |
| michael@0 | 662 | >previous</a> |</li> |
| michael@0 | 663 | <li><a href="index.html">Mock 1.0.0 documentation</a> »</li> |
| michael@0 | 664 | </ul> |
| michael@0 | 665 | </div> |
| michael@0 | 666 | <div class="footer"> |
| michael@0 | 667 | © Copyright 2007-2012, Michael Foord & the mock team. |
| michael@0 | 668 | Last updated on Oct 07, 2012. |
| michael@0 | 669 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. |
| michael@0 | 670 | </div> |
| michael@0 | 671 | </body> |
| michael@0 | 672 | </html> |
