web-dev-qa-db-ja.com

モック/スタブをどのようにpython urllibのようなモジュール

Urllib.urlopenを使用して外部サーバー上のページを照会する必要がある関数をテストする必要があります（urllib.urlencodeも使用します）。サーバーがダウンし、ページが変更される可能性があります。テストに頼ることはできません。

Urllib.urlopenが返すものを制御する最良の方法は何ですか？

pythonunit-testingtestingmocking
65
Dinoboff

別の簡単なアプローチは、テストでurllibのurlopen()関数をオーバーライドすることです。たとえば、モジュールに

_import urllib

def some_function_that_uses_urllib():
    ...
    urllib.urlopen()
    ...
_

次のようにテストを定義できます。

_import mymodule

def dummy_urlopen(url):
    ...

mymodule.urllib.urlopen = dummy_urlopen
_

次に、テストがmymoduleの関数を呼び出すと、実際のdummy_urlopen()の代わりにurlopen()が呼び出されます。 Pythonなどの動的言語を使用すると、テスト用のメソッドとクラスを非常に簡単にスタブできます。

テストの依存関係のスタブアウトの詳細については、私のブログ投稿 http://softwarecorner.wordpress.com/ を参照してください。

94
Clint Miller

私は Mock's パッチデコレータを使用しています：

from mock import patch

[...]

@patch('urllib.urlopen')
def test_foo(self, urlopen_mock):
    urlopen_mock.return_value = MyUrlOpenMock()
68
Dinoboff

Mox を見てくれましたか？必要なことはすべて行う必要があります。必要なソリューションを示す簡単なインタラクティブセッションを次に示します。

>>> import urllib
>>> # check that it works
>>> urllib.urlopen('http://www.google.com/')
<addinfourl at 3082723820L ...>
>>> # check what happens when it doesn't
>>> urllib.urlopen('http://hopefully.doesnotexist.com/')
#-- snip --
IOError: [Errno socket error] (-2, 'Name or service not known')

>>> # OK, let's mock it up
>>> import mox
>>> m = mox.Mox()
>>> m.StubOutWithMock(urllib, 'urlopen')
>>> # We can be verbose if we want to :)
>>> urllib.urlopen(mox.IgnoreArg()).AndRaise(
...   IOError('socket error', (-2, 'Name or service not known')))

>>> # Let's check if it works
>>> m.ReplayAll()
>>> urllib.urlopen('http://www.google.com/')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/lib/python2.5/site-packages/mox.py", line 568, in __call__
    raise expected_method._exception
IOError: [Errno socket error] (-2, 'Name or service not known')

>>> # yay! now unset everything
>>> m.UnsetStubs()
>>> m.VerifyAll()
>>> # and check that it still works
>>> urllib.urlopen('http://www.google.com/')
<addinfourl at 3076773548L ...>
27
Damir Zekić

HTTPretty は、FakeWebとまったく同じように機能します。 HTTPrettyはソケットレイヤーで動作するため、python httpクライアントライブラリをインターセプトして動作する必要があります。urllib2、httplib2、および要求に対してテストされた戦いです。

import urllib2
from httpretty import HTTPretty, httprettified


@httprettified
def test_one():
    HTTPretty.register_uri(HTTPretty.GET, "http://yipit.com/",
                           body="Find the best daily deals")

    fd = urllib2.urlopen('http://yipit.com')
    got = fd.read()
    fd.close()

    assert got == "Find the best daily deals"
14
Gabriel Falcão

おそらくこれを処理する最善の方法は、コードを分割することです。そのため、ページのコンテンツを処理するロジックは、ページをフェッチするコードから分割されます。

次に、フェッチャーコードのインスタンスを処理ロジックに渡すと、ユニットテスト用の模擬フェッチャーに簡単に置き換えることができます。

例えば.

class Processor(oject):
    def __init__(self, fetcher):
        self.m_fetcher = fetcher

    def doProcessing(self):
        ## use self.m_fetcher to get page contents

class RealFetcher(object):
    def fetchPage(self, url):
        ## get real contents

class FakeFetcher(object):
    def fetchPage(self, url):
        ## Return whatever fake contents are required for this test
8
Douglas Leeder

モジュールをロードしたくない場合：

import sys,types
class MockCallable():
  """ Mocks a function, can be enquired on how many calls it received """
  def __init__(self, result):
    self.result  = result
    self._calls  = []

  def __call__(self, *arguments):
    """Mock callable"""
    self._calls.append(arguments)
    return self.result

  def called(self):
    """docstring for called"""
    return self._calls

class StubModule(types.ModuleType, object):
  """ Uses a stub instead of loading libraries """

  def __init__(self, moduleName):
    self.__= moduleName
    sys.modules[moduleName] = self

  def __repr__(self):
    name  = self.__name__
    mocks = ', '.join(set(dir(self)) - set(['__name__']))
    return "<StubModule: %(name)s; mocks: %(mocks)s>" % locals()

class StubObject(object):
  pass

その後：

>>> urllib = StubModule("urllib")
>>> import urllib # won't actually load urllib

>>> urls.urlopen = MockCallable(StubObject())

>>> example = urllib.urlopen('http://example.com')
>>> example.read = MockCallable('foo')

>>> print(example.read())
'foo'
8
ilpoldo

最も簡単な方法は、urllib.urlopenを必ずしも使用しないように関数を変更することです。これが元の関数であるとしましょう：

def my_grabber(arg1, arg2, arg3):
    # .. do some stuff ..
    url = make_url_somehow()
    data = urllib.urlopen(url)
    # .. do something with data ..
    return answer

URLを開くために使用する関数である引数を追加します。次に、必要なことを行うためのモック関数を提供できます。

def my_grabber(arg1, arg2, arg3, urlopen=urllib.urlopen):
    # .. do some stuff ..
    url = make_url_somehow()
    data = urlopen(url)
    # .. do something with data ..
    return answer

def test_my_grabber():
    my_grabber(arg1, arg2, arg3, urlopen=my_mock_open)
3
Ned Batchelder

Clint Millerの答えに加えて、これを行うには、次のような読み取りメソッドを実装する偽のクラスを作成する必要がありました。

class FakeURL:
    def read(foo):
        return '{"some":"json_text"}'

次に、urllib2.openをスタブするには：

# Stub out urllib2.open.
def dummy_urlopen(foo, bar, baz):
  return FakeURL()
urllib2.urlopen = dummy_urlopen
0
Alex Harvey