Python之自動單元測試之一（unittest使用實例）

軟件的測試是一件非常乏味的事情，在測試別人編寫的軟件時尤其如此，程序員通常都只對編寫代碼感興趣，而不喜歡文檔編寫和軟件測試這類"沒有創新"的工作。既然如此，爲什麼不讓程序員在編寫軟件時自己加入一些用於測試的代碼，使測試過程自動化呢？在軟件工程中，這一技術稱爲自動單元測試，本文介紹在用Python開發軟件時如何實現這一目標。

一、軟件測試

大型軟件系統的開發是一個很複雜的過程，其中因爲人的因素而所產生的錯誤非常多，因此軟件在開發過程必須要有相應的質量保證活動，而軟件測試則是保證質量的關鍵措施。正像軟件熵（software entropy）所描述的那樣：一個程序從設計很好的狀態開始，隨着新的功能不斷地加入，程序逐漸地失去了原有的結構，最終變成了一團亂麻（其實最初的"很好的狀態"得加個問號）。測試的目的說起來其實很簡單也極具吸引力，那就是寫出高質量的軟件並解決軟件熵這一問題。

可惜的是，軟件開發人員很少能在編碼的過程中就進行軟件測試，大部分軟件項目都只在最終驗收時才進行測試，有些項目甚至根本沒有測試計劃！隨着軟件質量意識的增強，許多軟件開發組織開始轉向UML、CMM、RUP、XP等軟件工程方法，以期提高軟件質量，並使軟件開發過程更加可控，好在這些方法對測試都提出了很嚴格的要求，從而使得測試在軟件開發過程的作用開始真正體現出來。

軟件測試作爲一種系統工程，涉及到整個軟件開發過程的各個方面，需要管理人員、設計人員、開發人員和測試人員的共同努力。作爲軟件開發過程中的主要力量，現今的程序員除了要編寫實現代碼外，還承擔着單元測試這一艱鉅任務，因此必須採用新的工作模式：

• 編寫和維護一套詳盡的單元測試用例；
• 先構造單元測試和驗收測試用例，然後再編寫代碼；
• 根據構造的測試用例來編寫代碼。

單元測試負責對最小的軟件設計單元（模塊）進行驗證，它使用軟件設計文檔中對模塊的描述作爲指南，對重要的程序分支進行測試以發現模塊中的錯誤。由於軟件模塊並不是一個單獨的程序，爲了進行單元測試還必須編寫大量額外的代碼，從而無形中增加了開發人員的工作量，目前解決這一問題比較好的方法是使用測試框架。測試框架是在用XP方法進行單元測試時的關鍵，尤其是在需要構造大量測試用例時更是如此，因爲如果完全依靠手工的方式來構造和執行這些測試，肯定會變成一個花費大量時間並且單調無味的工作，而測試框架則可以很好地解決這些問題。

使用Python語言的開發人員可以使用Steve Purcell編寫的PyUnit作爲單元測試框架，通過將單元測試融合到PyUnit這一測試框架裏，Python程序員可以更容易地增加、管理、執行測試用例，並對測試結果進行分析。此外，使用PyUnit還可以實現自動單元測試（迴歸測試）。

二、規範Python單元測試

測試是一個貫穿於整個開發過程的連續過程，從某個意義上說，軟件開發的過程實際上就是測試過程。正如Martin Fowler所說的"在你不知道如何測試代碼之前，就不該編寫程序。而一旦你完成了程序，測試代碼也應該完成。除非測試成功，你不能認爲你編寫出了可以工作的程序。"

測試最基本的原理就是比較預期結果是否與實際執行結果相同，如果相同則測試成功，否則測試失敗。爲了更好地理解PyUnit這一自動測試框架的作用，先來看一個簡單的例子，假設我們要對例1中的Widget類進行測試：

例1. widget.py
# 將要被測試的類
class Widget:
    def __init__(self, size = (40, 40)):
        self._size = size
    def getSize(self):
        return self._size
    def resize(self, width, height):
        if width  0  or height < 0:
            raise ValueError, "illegal size"
        self._size = (width, height)
    def dispose(self):
        pass

採用手工方式進行單元測試的Python程序員很可能會寫出類似例2的測試代碼來，

例2. manual.py
from widget import Widget
# 執行測試的類
class TestWidget:
    def testSize(self):
        expectedSize = (40, 40);
        widget = Widget()
        if widget.getSize() == expectedSize:
            print "test [Widget]: getSize works perfected!"
        else:
            print "test [Widget]: getSize doesn't work!"
# 測試
if __name__ == '__main__':
    myTest = TestWidget()
    myTest.testSize()

稍一留心你不難發現這種手工測試方法存在許多問題。首先，測試程序的寫法沒有一定的規範可以遵循，十個程序員完全可能寫出十種不同的測試程序來，如果每個Python程序員都有自己不同的設計測試類的方法，光維護被測試的類就夠麻煩了，誰還顧得上維護測試類。其次，需要編寫大量的輔助代碼才能進行單元測試，例1中用於測試的代碼甚至比被測試的代碼還要多，而這毫無疑問將增大Python程序員的工作量。

爲了讓單元測試代碼能夠被測試和維護人員更容易地理解，最好的解決辦法是讓開發人員遵循一定的規範來編寫用於測試的代碼，具體到Python程序員來講，則是要採用PyUnit這一自動測試框架來構造單元測試用例。目前PyUnit已經得到了大多數Python開發人員的認可，成了事實上的單元測試標準。如果採用PyUnit來進行同樣的測試，則測試代碼將如例3所示：

例3. auto.py
from widget import Widget
import unittest
# 執行測試的類
class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget()
    def tearDown(self):
        self.widget = None
    def testSize(self):
        self.assertEqual(self.widget.getSize(), (40, 40))
# 構造測試集
def suite():
    suite = unittest.TestSuite()
    suite.addTest(WidgetTestCase("testSize"))
    return suite
# 測試
if __name__ == "__main__":
    unittest.main(defaultTest = 'suite')

在採用PyUnit這一單元測試框架後，用於測試的代碼做了相應的改動：

• 用import語句引入unittest模塊。
• 讓所有執行測試的類都繼承於TestCase類，可以將TestCase看成是對特定類進行測試的方法的集合。
• 在setUp()方法中進行測試前的初始化工作，並在tearDown()方法中執行測試後的清除工作，setUp()和tearDown()都是TestCase類中定義的方法。
• 在testSize()中調用assertEqual()方法，對Widget類中getSize()方法的返回值和預期值進行比較，確保兩者是相等的，assertEqual()也是TestCase類中定義的方法。
• 提供名爲suite()的全局方法，PyUnit在執行測試的過程調用suit()方法來確定有多少個測試用例需要被執行，可以將TestSuite看成是包含所有測試用例的一個容器。

雖然看起來有點複雜，但PyUnit使得所有的Python程序員都可以使用同樣的單元測試方法，測試過程不再是雜亂無章的了，而是在同一規範指導下進行的有序行爲，這就是使用PyUnit這一自動單元測試框架所帶來的最大好處。

好了，現在進入我們的學習重點，PyUnit模塊的使用！

三、自動測試框架PyUnit

在對軟件測試理論和PyUnit有了一個大致瞭解之後，下面輔以具體的實例介紹Python程序員如何藉助PyUnit來進行單元測試。在Python中進行單元測試時需要用到PyUnit模塊，Python 2.1及其以後的版本都將PyUnit作爲一個標準模塊，可以導入相應模塊，使用即可。

3.1 測試用例TestCase

軟件測試中最基本的組成單元是測試用例（test case），PyUnit使用TestCase類來表示測試用例，並要求所有用於執行測試的類都必須從該類繼承。TestCase子類實現的測試代碼應該是自包含（self contained）的，也就是說測試用例既可以單獨運行，也可以和其它測試用例構成集合共同運行。

TestCase在PyUnit測試框架中被視爲測試單元的運行實體，Python程序員可以通過它派生自定義的測試過程與方法（測試單元），利用Command和Composite設計模式，多個TestCase還可以組合成測試用例集合。PyUnit測試框架在運行一個測試用例時，TestCase子類定義的setUp()、runTest()和tearDown()方法被依次執行，最簡單的測試用例只需覆蓋runTest()方法來執行特定的測試代碼就可以了，如例4所示：

例4. static_single.py
import unittest
# 執行測試的類
class WidgetTestCase(unittest.TestCase):
    def runTest(self):
        widget = Widget()
        self.assertEqual(widget.getSize(), (40, 40))

而要在PyUnit測試框架中構造上述WidgetTestCase類的一個實例，應該不帶任何參數調用其構造函數:

testCase = WidgetTestCase()

一個測試用例通常只對軟件模塊中的一個方法進行測試，採用覆蓋runTest()方法來構造測試用例在PyUnit中稱爲靜態方法，如果要對同一個軟件模塊中的多個方法進行測試，通常需要構造多個執行測試的類，如例5所示：

例5. static_multi.py
import unittest
# 測試getSize()方法的測試用例
class WidgetSizeTestCase(unittest.TestCase):
    def runTest(self):
        widget = Widget()
        self.assertEqual(widget.getSize(), (40, 40))
# 測試resize()方法的測試用例
class WidgetResizeTestCase(unittest.TestCase):
    def runTest(self):
        widget = Widget()
        widget.resize(100, 100)
        self.assertEqual(widget.getSize(), (100, 100))

採用靜態方法，Python程序員不得不爲每個要測試的方法編寫一個測試類（該類通過覆蓋runTest()方法來執行測試），並在每一個測試類中生成一個待測試的對象。在爲同一個軟件模塊編寫測試用例時，很多時候待測對象有着相同的初始狀態，因此採用上述方法的Python程序員不得不在每個測試類中爲待測對象進行同樣的初始化工作，而這往往是一項費時且枯燥的工作。

一種更好的解決辦法是採用PyUnit提供的動態方法，只編寫一個測試類來完成對整個軟件模塊的測試，這樣對象的初始化工作可以在setUp()方法中完成，而資源的釋放則可以在tearDown()方法中完成，如例6所示：

例6. dynamic.py
import unittest
# 執行測試的類
class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget()
    def tearDown(self):
        self.widget.dispose()
        self.widget = None
    def testSize(self):
        self.assertEqual(self.widget.getSize(), (40, 40))
    def testResize(self):
        self.widget.resize(100, 100)
        self.assertEqual(self.widget.getSize(), (100, 100))

採用動態方法最大的好處是測試類的結構非常好，用於測試一個軟件模塊的所有代碼都可以在同一個類中實現。動態方法不再覆蓋runTest()方法，而是爲測試類編寫多個測試方法（按習慣這些方法通常以test開頭），在創建TestCase子類的實例時必須給出測試方法的名稱，來爲PyUnit測試框架指明運行該測試用例時究竟應該調用測試類中的哪個方法：

sizeTestCase = WidgetTestCase("testSize")
resizeTestCase = WidgetTestCase("testResize")

3.2 測試用例集TestSuite

完整的單元測試很少只執行一個測試用例，開發人員通常都需要編寫多個測試用例才能對某一軟件功能進行比較完整的測試，這些相關的測試用例稱爲一個測試用例集，在PyUnit中是用TestSuite類來表示的。

在創建了一些TestCase子類的實例作爲測試用例之後，下一步要做的工作就是用TestSuit類來組織它們。PyUnit測試框架允許Python程序員在單元測試代碼中定義一個名爲suite()的全局函數，並將其作爲整個單元測試的入口，PyUnit通過調用它來完成整個測試過程。

def suite():
    suite = unittest.TestSuite()
    suite.addTest(WidgetTestCase("testSize"))
    suite.addTest(WidgetTestCase("testResize"))
    return suite

也可以直接定義一個TestSuite的子類，並在其初始化方法（__init__）中完成所有測試用例的添加：

class WidgetTestSuite(unittest.TestSuite):
    def __init__(self):
        unittest.TestSuite.__init__(self, map(WidgetTestCase,
                                              ("testSize",
                                               "testResize")))

這樣只需要在suite()方法中返回該類的一個實例就可以了：

def suite():
    return WidgetTestSuite()

如果用於測試的類中所有的測試方法都以test開，Python程序員甚至可以用PyUnit模塊提供的makeSuite()方法來構造一個TestSuite：

def suite():
    return unittest.makeSuite(WidgetTestCase, "test")

在PyUnit測試框架中，TestSuite類可以看成是TestCase類的一個容器，用來對多個測試用例進行組織，這樣多個測試用例可以自動在一次測試中全部完成。事實上，TestSuite除了可以包含TestCase外，也可以包含TestSuite，從而可以構成一個更加龐大的測試用例集：

suite1 = mysuite1.TheTestSuite()
suite2 = mysuite2.TheTestSuite()
alltests = unittest.TestSuite((suite1, suite2))

3.3 實施測試

編寫測試用例（TestCase）並將它們組織成測試用例集（TestSuite）的最終目的只有一個：實施測試並獲得最終結果。PyUnit使用TestRunner類作爲測試用例的基本執行環境，來驅動整個單元測試過程。Python開發人員在進行單元測試時一般不直接使用TestRunner類，而是使用其子類TextTestRunner來完成測試，並將測試結果以文本方式顯示出來：

runner = unittest.TextTestRunner()
runner.run(suite)

使用TestRunner來實施測試的例子如例7所示，

例7. text_runner.py
from widget import Widget
import unittest
# 執行測試的類
class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget()
    def tearDown(self):
        self.widget.dispose()
        self.widget = None
    def testSize(self):
        self.assertEqual(self.widget.getSize(), (40, 40))
    def testResize(self):
        self.widget.resize(100, 100)        
        self.assertEqual(self.widget.getSize(), (100, 100))        
# 測試
if __name__ == "__main__":
    # 構造測試集
    suite = unittest.TestSuite()
    suite.addTest(WidgetTestCase("testSize"))
    suite.addTest(WidgetTestCase("testResize"))
    
    # 執行測試
    runner = unittest.TextTestRunner()
    runner.run(suite)

運行結果應該如下所示，表明執行了2個測試用例，並且兩者都通過了測試：

..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK

如果對數據進行修改，模擬出錯的情形，將會得到如下結果：

.F
==========================================
FAIL: testResize (__main__.WidgetTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "text_runner.py", line 15, in testResize
    self.assertEqual(self.widget.getSize(), (200, 100))
  File "/usr/lib/python2.2/unittest.py", line 286, in failUnlessEqual
    raise self.failureException, \
AssertionError: (100, 100) != (200, 100)
----------------------------------------------------------------------
Ran 2 tests in 0.001s
FAILED (failures=1)

默認情況下，TextTestRunner將結果輸出到sys.stderr上，但如果在創建TextTestRunner類實例時將一個文件對象傳遞給了構造函數，則輸出結果將被重定向到該文件中。在Python的交互環境中驅動單元測試時，使用TextTestRunner類是一個不錯的選擇。

PyUnit模塊中定義了一個名爲main的全局方法，使用它可以很方便地將一個單元測試模塊變成可以直接運行的測試腳本，main()方法使用TestLoader類來搜索所有包含在該模塊中的測試方法，並自動執行它們。如果Python程序員能夠按照約定（以test開頭）來命名所有的測試方法，那就只需要在測試模塊的最後加入如下幾行代碼即可：

if __name__ == "__main__":
    unittest.main()

使用main()方法來實施測試的例子如例8所示:

例8. main_runner.py
from widget import Widget
import unittest
# 執行測試的類
class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget()
    def tearDown(self):
        self.widget.dispose()
        self.widget = None
    def testSize(self):
        self.assertEqual(self.widget.getSize(), (40, 40))
    def testResize(self):
        self.widget.resize(100, 100)
        self.assertEqual(self.widget.getSize(), (100, 100))   
# 測試
if __name__ == "__main__":
    unittest.main()

爲了使單元測試更具親合力，PyUnit軟件包中還提供了一個圖形界面測試腳本unittestgui.py，將其複製到當前目錄後，可以執行下面的命令來啓動該測試工具，對main_runner.py腳本中的所有測試用例進行測試：

python unittestgui.py main_runner

四、小結

測試是保證軟件質量的關鍵，新的軟件開發方法要求程序員在編寫代碼前先編寫測試用例，並在軟件開發過程中不斷地進行單元測試，從而最大限度地減少缺陷(Bug)的產生。軟件單元測試是XP方法的基石，測試框架爲程序員進行單元測試提供了統一的規範，Python程序員可以使用PyUnit作爲軟件開發過程中的自動單元測試框架。

Ref：http://www.ibm.com/developerworks/cn/linux/l-pyunit/

感謝閱讀，下一篇博客將帶給大家我在工作中使用unittest的實例，希望能夠幫到大家。