使用 PyHamcrest 執行健壯的單元測試 | Linux 中國

在測試金字塔[1]的底部是單元測試。單元測試每次只測試一個程式碼單元，通常是一個函式或方法。

通常，設計單個單元測試是為了測試透過一個函式或特定分支的特定執行流程，這使得將失敗的單元測試和導致失敗的 bug 對應起來變得容易。

理想情況下，單元測試很少使用或不使用外部資源，從而隔離它們並使它們更快。

單元測試套件透過在開發過程的早期發現問題來幫助維護高質量的產品。有效的單元測試可以在程式碼離開開發人員機器之前捕獲 bug，或者至少可以在特定分支上的持續整合環境中捕獲 bug。這標志著好的和壞的單元測試之間的區別：好的測試透過儘早捕獲 bug 並使測試更快來提高開發人員的生產力。壞的測試降低了開發人員的工作效率。

當測試附帶的特性時，生產率通常會降低。當程式碼更改時測試會失敗，即使它仍然是正確的。發生這種情況是因為輸出的不同，但在某種程度上是因為它不是函式契約function’s contract的一部分。

因此，一個好的單元測試可以幫助執行函式所提交的契約。

如果單元測試中斷，那意味著該契約被違反了，應該（透過更改檔案和測試）明確修改，或者（透過修複程式碼並保持測試不變）來修複。

雖然將測試限製為只執行公共契約是一項需要學習的複雜技能，但有一些工具可以提供幫助。

其中一個工具是 Hamcrest[2]，這是一個用於編寫斷言的框架。最初是為基於 Java 的單元測試而發明的，但它現在支援多種語言，包括 Python[3]。

Hamcrest 旨在使測試斷言更容易編寫和更精確。

1. def add(a, b):
2.     return a + b
4. from hamcrest import assert_that, equal_to
6. def test_add():
7.     assert_that(add(2, 2), equal_to(4))  

這是一個用於簡單函式的斷言。如果我們想要斷言更複雜的函式怎麼辦？

1. def test_set_removal():
2.     my_set = {1, 2, 3, 4}
3.     my_set.remove(3)
4.     assert_that(my_set, contains_inanyorder([1, 2, 4]))
5.     assert_that(my_set, is_not(has_item(3)))

註意，我們可以簡單地斷言其結果是任何順序的 1、2 和 4，因為集合不保證順序。

我們也可以很容易用 is_not 來否定斷言。這有助於我們編寫精確的斷言，使我們能夠把自己限制在執行函式的公共契約方面。

然而，有時候，內建的功能都不是我們真正需要的。在這些情況下，Hamcrest 允許我們編寫自己的匹配器matchers。

想象一下以下功能：

1. def scale_one(a, b):
2.     scale = random.randint(0, 5)
3.     pick = random.choice([a,b])
4.     return scale * pick

我們可以自信地斷言其結果均勻地分配到至少一個輸入。

匹配器繼承自 hamcrest.core.base_matcher.BaseMatcher，重寫兩個方法：

1. class DivisibleBy(hamcrest.core.base_matcher.BaseMatcher):
2.     def __init__(self, factor):
3.         self.factor = factor
5.     def _matches(self, item):
6.         return (item % self.factor) == 0
8.     def describe_to(self, description):
9.         description.append_text('number divisible by')
10.         description.append_text(repr(self.factor))

編寫高質量的 describe_to 方法很重要，因為這是測試失敗時顯示的訊息的一部分。

1. def divisible_by(num):
2.     return DivisibleBy(num)

按照慣例，我們將匹配器包裝在一個函式中。有時這給了我們進一步處理輸入的機會，但在這種情況下，我們不需要進一步處理。

1. def test_scale():
2.     result = scale_one(3, 7)
3.     assert_that(result,
4.                 any_of(divisible_by(3),
5.                 divisible_by(7)))

請註意，我們將 divisible_by 匹配器與內建的 any_of 匹配器結合起來，以確保我們只測試函式提交的內容。

在編輯這篇文章時，我聽到一個傳言，取 “Hamcrest” 這個名字是因為它是 “matches” 字母組成的字謎。嗯…

1. >>> assert_that("matches", contains_inanyorder(*"hamcrest")
2. Traceback (most recent call last):
3.   File "", line 1, in <module>
4.   File "/home/moshez/src/devops-python/build/devops/lib/python3.6/site-packages/hamcrest/core/assert_that.py", line 43, in assert_that
5.     _assert_match(actual=arg1, matcher=arg2, reason=arg3)
6.   File "/home/moshez/src/devops-python/build/devops/lib/python3.6/site-packages/hamcrest/core/assert_that.py", line 57, in _assert_match
7.     raise AssertionError(description)
8. AssertionError:
9. Expected: a sequence over ['h', 'a', 'm', 'c', 'r', 'e', 's', 't'] in any order
10.       but: no item matches: 'r' in ['m', 'a', 't', 'c', 'h', 'e', 's']

經過進一步的研究，我找到了傳言的來源：它是 “matchers” 字母組成的字謎。

1. >>> assert_that("matchers", contains_inanyorder(*"hamcrest"))
2. >>>

如果你還沒有為你的 Python 程式碼編寫單元測試，那麼現在是開始的好時機。如果你正在為你的 Python 程式碼編寫單元測試，那麼使用 Hamcrest 將允許你使你的斷言更加精確，既不會比你想要測試的多也不會少。這將在修改程式碼時減少誤報，並減少修改工作程式碼的測試所花費的時間。

via: https://opensource.com/article/18/8/robust-unit-tests-hamcrest

作者：Moshe Zadka[5] 選題：lujun9972 譯者：MjSeven 校對：wxy