桃缶食べたい。

Python nose でユニットテストを書く

nose のインストール

# yum install -y python-setuptools

# easy_install nose

テストケースの命名規則

テストケースを書く

# -*- coding: utf-8 -*-

def add(num1, num2):
    if (num1 is None):
        raise RuntimeError('num1 is None')

    return num1 + num2

# -*- coding: utf-8 -*-

from nose.tools import with_setup, raises
from myfunc import add 

# assert 文で評価する
def test_add_nums():
    actual = add(1, 10) 
    assert actual == 11


# テストケース実行前に実行する関数
def setup_func():
    # 好きなことをする
    pass

# テストケース実行後に実行する関数
def teardown_func():
    # 好きなことをする
    pass

# @with_setup でテストケース実行前/後に実行する関数を指定する
@with_setup(setup_func, teardown_func)
def test_addNumbers():
    actual = add(-1, 1)
    assert actual == 0


# @raises で例外が投げられるかをテストする
@raises(RuntimeError)
def test_invalid_arg1():
    actual = add(None, 1)

# 未実装の機能へのテストケース
# エラーになるはず。
@raises(RuntimeError)
def test_invalid_args2():
    # 入力値チェックで RuntimeError を投げることを機能仕様としたいが、
    # まだ未実装なので + 演算で TypeError が発生する
    actual = add(1, None)

# -*- coding: utf-8 -*-

from myfunc import add 

class TestAdd:

    # このクラスのテストケースを実行する前に１度だけ実行する
    @classmethod
    def setup_class(clazz):
        # 好きなことをする
        pass

    # このクラスのテストケースをすべて実行した後に１度だけ実行する
    @classmethod
    def teardown_class(clazz):
        # 好きなことをする
        pass

    # このクラスの各テストケースを実行する前に実行する
    def setup(self):
        # 好きなことをする
        pass

    # このクラスの各テストケースを実行した後に実行する
    def teardown(self):
        # 好きなことをする
        pass

    # assert 文で評価する
    def test_add_nums(self):
        actual = add(1, 10) 
        assert actual == 11

ユニットテストを実行する

$ nosetests -v
test_by_classes.TestAdd.test_add_nums ... ok
test_by_funcs.test_add_nums ... ok
test_by_funcs.test_addNumbers ... ok
test_by_funcs.test_invalid_arg1 ... ok
test_by_funcs.test_invalid_args2 ... ERROR

======================================================================
ERROR: test_by_funcs.test_invalid_args2
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python2.7/site-packages/nose-1.3.3-py2.7.egg/nose/case.py", line 197, in runTest
    self.test(*self.arg)
  File "/usr/lib/python2.7/site-packages/nose-1.3.3-py2.7.egg/nose/tools/nontrivial.py", line 60, in newfunc
    func(*arg, **kw)
  File "/home/momokan/test/test_myfunc/test_by_funcs.py", line 40, in test_invalid_args2
    actual = add(1, None)
  File "/home/momokan/myfunc.py", line 7, in add
    return num1 + num2
TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'

----------------------------------------------------------------------
Ran 5 tests in 0.004s

FAILED (errors=1)

エラー発生時にデバッグを行う

$ nosetests --pdb
....> /home/momokan/myfunc.py(7)add()
-> return num1 + num2
(Pdb) 

l : 指定のステップ周辺のソースコードを表示する

w : スタックトレースを表示する

p : 変数の値を表示する

n : 現在の行を実行し、次の行へ進む

r : 現在の行がある関数を実行する

c : 現在の行から処理を続行する

コードカバレッジを測定する

# easy_install coverage

$ nosetests --with-coverage --cover-branches --cover-html
...
Name     Stmts   Miss Branch BrMiss  Cover   Missing
----------------------------------------------------
myfunc       4      0      2      0   100%   
----------------------------------------------------------------------
Ran 5 tests in 0.006s

FAILED (errors=1)