自动化测试中如何判断测试是否通过？详解 Pytest 测试框架的断言用法

# content of my_assertion.py
def assertion():
    assert [1, 2, 3] == [1, 2, 4], "left is [1,2,3], right is [1,2,4]"

if __name__ == '__main__':
    assertion()

执行一下上面的代码看看结果：

$ python my_assertion.py 
Traceback (most recent call last):
  File "my_assertion.py", line 5, in <module>
    assertion()
  File "my_assertion.py", line 2, in assertion
    assert [1, 2, 3] == [1, 2, 4], "left is [1,2,3], right is [1,2,4]"
AssertionError: left is [1,2,3], right is [1,2,4]

可见，assert 后面的条件表达式为 False，抛出了 AssertionError，并显示了错误信息 left is [1, 2, 3], right is [1, 2, 4]。

不过，这里还有一点小小的缺憾。并没有明确告诉开发人员，条件判断失败的具体位置。需要开发人员自己对比才发现，==左边的第三个元素和右边的第三个元素不一样。

02 — Pytest 的 assert 优点

软件测试工作，经常会遇到断言失败的情况。如果每次失败，都需要测试工程师人眼去观察失败的具体原因和出错的位置，那将是非常耗时的。强大的 Pytest 也考虑到了广大测试工程师面临的问题，因此对 Python 原生的 assert 语句进行了优化和改进，主要在是当断言失败时，将错误的具体信息和位置显示出来，让测试工程师对失败原因一目了然。

还是上面的例子，将其放入到测试用例（test_开头的函数）中：

# content of test_assertion.py
def test_assertion():
    assert [1, 2, 3] == [1, 2, 4], "left is [1,2,3], right is [1,2,4]"
执行测试用例后的信息输出如下：

    def test_assertion():
>       assert [1, 2, 3] == [1, 2, 4], "left is [1,2,3], right is [1,2,4]"
E       AssertionError: left is [1,2,3], right is [1,2,4]
E       assert [1, 2, 3] == [1, 2, 4]
E         At index 2 diff: 3 != 4
E         Full diff:
E         - [1, 2, 4]
E         ?        ^
E         + [1, 2, 3]
E         ?

是不是有种很爽的感觉？pytest 明确显示出了错误的位置是 index 为 2 的元素左右不相等。这一点点小小的改进大大提高了测试失败时定位出错原因的效率。

在测试用例中执行 assert 语句，才有上面的效果，这是因为 Pytest 对 assert 语句进行了重写。在非测试用例中的 assert 语句，比如测试项目中的一些 utils 函数中，使用 assert 还是 Python 原生的效果。

03 — Pytest 断言的用法

在自动化测试用例中，最常用的断言是相等断言，就是断言预期结果和实际结果是一致的。通常我们断言的预期结果和实际结果的数据类型是字符串、元组、字典、列表和对象。Pytest 通过 assert 和==能够完美支持对这些数据类型的相等断言。下面来介绍几种常见的数据类型的断言操作。

4.1 断言字符串

断言字符串非常简单，只需要将预期和实际的字符串，分别写在==两边，当发生断言失败时，将会列出第一个不相等元素的下标。下面是几个在实际测试工作中经常用到的几种字符串断言方式。

# content of test_assertions.py
class TestAssertions(object):
    def test_string_1(self):
        assert "spam" == "eggs"

    def test_string_2(self):
        assert "foo 1 bar" == "foo 2 bar"

    def test_string_3(self):
        assert "foo\nspam\nbar" == "foo\neggs\nbar"

    def test_string_4(self):
        def f():
            return "streaming"
        assert f().startswith('S')

执行一下这些测试用例，看下输出效果，核心部分如下：

========================================================