Pytest

pytest

pytest 可以用来做 系统测试 的自动化， 它的特点有

• 用 Python 编写测试用例，简便易用
• 可以用 文件系统目录层次 对应 手工测试用例 层次结构
• 灵活的 初始化清除 机制
• 可以灵活挑选测试用例执行
• 利用第三方插件，可以生成不错的报表

pytest 的功能非常 多， 我们这里主要介绍 常用的功能。

安装

安装pytest
pip install pytest
我们还需要产生测试报表，所以要安装一个第三方插件 pytest-html ，执行如下命令安装
pip install pytest-html

快速上手

pytest 如何知道你哪些代码是自动化的测试用例？
官方文档 给出了 pytest 寻找 测试项 的 具体规则

• 如果未指定命令行参数，则从 testpath（如果已配置）或当前目录开始收集。
• 如果命令行参数， 指定了 目录、文件名 或 node id 的任何组合，则按参数来找
• 寻找过程会递归到目录中，除非它们匹配上 norecursedirs。
• 在这些目录中，搜索由其测试包名称导入的 test_*.py 或 *_test.py 文件。
• 从这些文件中，收集如下测试项：
  • test为前缀 的 函数
  • Test为前缀的 类 里面的 test为前缀的方法

演示代码:
编写的测试用例代码文件， 必须以 test_ 开头，或者以 _test 结尾

class Test_错误密码:
    def test_C001001(self):
        print('\n用例C001001')
        assert 1 == 1
        
    def test_C001002(self):
        print('\n用例C001002')
        assert 2 == 2
        
    def test_C001003(self):
        print('\n用例C001003')
        assert 3 == 2

类名必须以 Test 为前缀的 类 ，用例对应的方法必须以 test 为前缀的方法。
pytest 中用例的检查点 直接用 Python 的 assert 断言。
assert 后面的表达式结果 为 True ，就是 检查点 通过，结果为False ，就是检查点 不通过.

运行演示代码

要先在CMD中进入该项目的跟目录,然后输入pytest即可,建议测试文件放在一个文件夹中,然后执行pytest 测试文件夹名,执行会更加准确;
执行上述结果最终会展示:显示找到3个测试项，2个执行通过，1个不通过。
通过的用例 是用一个绿色小点表示， 不通过的用例用一个红色的F表示
并且会在后面显示具体不通过的用例 和不通过的检查点 代码细节。
这样执行不会打印test函数的打印方法,如果想打印则需要在命令行上添加-s参数
如:
pytest -s
如果我们希望得到更详细的执行信息，包括每个测试类、测试函数的名字，可以加上参数 -v，这个参数可以和 -s 合并为 -sv
pytest -sv

产生报告

安装pytest，我们也安装了 pytest-html 插件，这个插件就是用来产生测试报告的
要产生报告，在命令行加上 参数 --html=report.html --self-contained-html ，如下

pytest cases --html=report.html --self-contained-html

这样就会产生名为 report.html 的测试报告文件，可以在浏览器中打开

报告中文乱码处理

如果你的方法名或者类名存在中文在报告中会显示成乱码,如何处理?
打开该插件对应的代码文件，通常在解释器目录下：site-packages\pytest_html\plugin.py 如果上述方式你找不到可以使用from pytest_html import plugin,
找到如下代码

 class TestResult:
      def __init__(self, outcome, report, logfile, config):
          self.test_id = report.nodeid.encode("utf-8").decode("unicode_escape")

改为

class TestResult:
      def __init__(self, outcome, report, logfile, config):
        self.test_id = report.nodeid

再次运行，就可以发现中文乱码问题已经解决了。

初始化清除

自动化测试框架来说，初始化清除功能 至关重要

模块级别

模块级别 的初始化、清除 分别 在整个模块的测试用例 执行前后执行，并且 只会执行1次 。
如下定义 setup_module 和 teardown_module 全局函数

def setup_module():
    print(123)
def teardown_module():
    print(456)

class Test_login(object):
    def test_登录(self):
        print('用例test_ca001')
        assert 1==1

    def test_ca002(self):
        print('用例test_ca002')
        assert 1 == 1

    def test_ca003(self):
        print('用例test_ca003')
        assert 1 != 1

可以发现，模块级别的初始化、清除 在 整个模块所有用例 执行前后 分别 执行1次
它主要是用来为该 模块(单个.py) 中 所有的测试用例做 公共的 初始化 和 清除

类级别

类级别 的初始化、清除 分别 在整个类的测试用例 执行前后执行，并且 只会执行1次
如下定义 setup_class 和 teardown_class 类方法

def setup_module():
    print("\n","开始")
def teardown_module():
    print("结束")

class Test_login(object):
    @classmethod
    def setup_class(cls):
        print("开始-类")
    @classmethod
    def teardown_class(cls):
        print("结束-类")
    def test_登录(self):
        print('用例test_ca001')
        assert 1==1

    def test_ca002(self):
        print('用例test_ca002')
        assert 1 == 1

    def test_ca003(self):
        print('用例test_ca003')
        assert 1 != 1
class Test_login2(object):
    @classmethod
    def setup_class(cls):
        print("开始-类")
    @classmethod
    def teardown_class(cls):
        print("结束-类")
    def test_登录(self):
        print('用例test_ca001')
        assert 1==1

    def test_ca002(self):
        print('用例test_ca002')
        assert 1 == 1

    def test_ca003(self):
        print('用例test_ca003')
        assert 1 != 1

它主要是用来为该 类 中的所有测试用例做 公共的 初始化 和 清除

方法级别

方法级别 的初始化、清除 分别 在类的 每个测试方法 执行前后执行，并且 每个用例分别执行1次
如下定义 setup_method 和 teardown_method 实例方法

class TestLogin2(object):

    def test_登录(self):
        print('用例test_ca001')
        assert 1 == 1
    def setup_method(self):
        print("开始--方法")
    def teardown_method(self):
        print("清除-方法")
    def test_ca002(self):
        print('用例test_ca002')
        assert 1 == 1

    def test_ca003(self):
        print('用例test_ca003')
        assert 1 != 1

方法级别的初始化、清除 在 整个模块所有用例 执行前后 分别 执行一次
pytest类的继承是否影响执行命令顺序-兼容unittest集成过来的方法级别夹具执行；
main.py

class Car():
    def setup_method(self):
        print("开始--方法")

    def teardown_method(self):
        print("清除-方法")

test.py

from main import Car


class TestCarTSL(Car):
    def test_run(self):
        print("小汽车跑起来啦")

执行结果：

============================= test session starts =============================
collecting ... collected 1 item

test.py::TestCarTSL::test_run PASSED                                     [100%]开始--方法
小汽车跑起来啦
清除-方法


============================== 1 passed in 0.02s ==============================

当然也可以兼容uniitest：
继承后重写夹具方法，这个夹具类父类需要继承unittest.TestCase然后就可以调用setUp，tearDown的方法；

目录级别()

目标级别的 初始化清除，就是针对整个目录执行的初始化、清除。
我们在需要初始化的目录下面创建 一个名为 conftest.py 的文件，里面内容如下所示

import pytest


@pytest.fixture(scope='package', autouse=True)
def st_emptyEnv():
    print(f'\n#### 初始化-目录')
    yield

    print(f'\n#### 清除-目录')

这里清除环境的代码就是 yield 之后的代码。 这是一个生成器
我们可以在多个目录下面放置这样的文件，定义该目录的初始化清除。
pytest 在执行测试时，会层层调用。
但是目前现在存在一个BUG就是A-a,b目录,A目录下有conftest,a,b目录下也各有conftest.py执行之后结果a目录下的conftest是最后结束的解释器!(不会根据目录层级来结束)

挑选用例执行

pytest有灵活的挑选用例

指定一个模块

pytest case\dd\test_login.py

指定一个目录

pytest case

指定多个目录

pytest case case2\dd

指定一个函数或者类

pytest .\case\test_d.py::TestLogin1
pytest .\case\test_d.py::TestLogin1::test_ca003

根据名字

可以使用 命令行参数 -k 后面加名字来挑选要执行的测试项
比如像这样后面跟测试函数名字的一部分：
pytest -k c001001 -s
注意，-k 后面的名字

• 可以是测试函数的名字，可以是类的名字，可以是模块文件名，可以是目录的名字
• 是大小写敏感的
• 不一定要完整，只要能有部分匹配上就行
• 可以用 not 表示选择名字中不包含，比如
  pytest -k "not C001001" -s
• 可以用 and 表示选择名字同时包含多个关键字，比如
  pytest -k "错 and 密码2" -s
• 可以用 or 表示选择名字 包含指定关键字之一即可，比如
  pytest -k "错 or 密码2" -s

根据标签

可以这样给 某个方法加上标签 webtest

import pytest

class Test_错误密码2:

    @pytest.mark.webtest
    def test_C001021(self):
        print('\n用例C001021')
        assert 1 == 1

然后，可以这样运行指定标签的用例
pytest cases -m webtest -s
该标签也支持中文如:@pytest.mark.网页测试
执行:pytest cases -m 网页测试 -s
可以这样同时添加多个标签

@pytest.mark.网页测试
@pytest.mark.登录测试
class Test_错误密码2:

    def test_C001021(self):
        print('\n用例C001021')
        assert 1 == 1

可以这样定义一个全局变量 pytestmark 为 整个模块文件 设定标签

import pytest
pytestmark = pytest.mark.网页测试

如果你需要定义多个标签，可以定义一个列表

import pytest
pytestmark = [pytest.mark.网页测试, pytest.mark.登录测试]

执行pytest case -m maoyan -sv

实战案例

被测系统
遇到的问题导报,使用命令
在自动化项目中，我们的测试用例经常需要导入项目目录的库文件，我们需要这样执行命令
python -m pytest cases -sv
才能避免Python解释器 搜索不到 库文件的问题 ModuleNotFoundError: No module named 'xxxx'
但结果我是用了还是报错,使用运行按钮即可;
cases/test_login.py

from Test1.lib.webui import loginAndCheck

class TestLoginError():
    def test001(self):
        print("\n用例UI-001")
        altest=loginAndCheck('','88888888')
        assert altest=="请输入用户名"
    def test002(self):
        print("\n用例 UI-002")
        altest = loginAndCheck('byhy', '')
        assert altest == '请输入密码'

lib.webui.py

from selenium import webdriver
from selenium.webdriver.common.by import By
import time

def loginAndCheck(username,password):
    print("\n用例 UI-001")
    driver = webdriver.Edge(r'C:\Users\sj176\Downloads\edgedriver_win64\msedgedriver.exe')
    driver.implicitly_wait(10)
    driver.get("http://127.0.0.1/mgr/sign.html")
    if username is not None:
        driver.find_element(By.ID, "username").send_keys(username)
    if password is not None:
        driver.find_element(By.ID, "password").send_keys(password)
    driver.find_element(By.CSS_SELECTOR, "button[type='submit']").click()
    time.sleep(2)
    # 获取页面浏览器原生提示框
    alterText = driver.switch_to.alert.text
    print(alterText)
    driver.quit()
    return alterText

数据驱动

用例 UI-0001 到 UI-0005 这5个登录的测试用例，共同的特点是，它们测试步骤是一模一样的，只是输入的数据（用户名、密码）不同，要检查的输出数据（错误提示）不同。
这批测试用例，就是典型的 可以用 数据驱动 方式进行自动化的用例。
如果有一批测试用例，具有 相同的测试步骤 ，只是 测试参数数据不同 。
自动化测试时，把测试数据从用例代码中 分离 开来，以后增加新的测试用例，只需要修改数据。
这就是数据驱动。
这种情况可以使用 pytest 用例 的 数据驱动格式，只需如下定义即可

class Test_错误登录:
    @pytest.mark.parametrize('username, password, expectedalert', [
        (None, '88888888', '请输入用户名'),
        ('byhy', None, '请输入密码'),
        ('byh', '88888888', '登录失败 : 用户名或者密码错误'),
        ('byhy', '8888888', '登录失败 : 用户名或者密码错误'),
        ('byhy', '888888888', '登录失败 : 用户名或者密码错误'),
    ]
                             )
    def test_UI_0001_0005(self, username, password, expectedalert):
        alertText = loginAndCheck(username, password)
        assert alertText == expectedalert

具体细节参考:https://docs.pytest.org/en/latest/how-to/parametrize.html
我们需要调试代码时，可以添加断点，然后按照下图所示

1. 点击打开运行配置
2. 点击+号， 添加一个运行配置，在右边的输入框输入配置名，比如 pytest
3. 点击箭头选择 module name，并且输入 pytest 作为运行模块名
4. 参数输入相应的命令行参数，比如 cases -sv
5. 工作目录选择项目根目录
6. 点击 OK

使用py代码执行pytest

用例除了常用的命令行运行方式外，还有另外一种运行方式，即为代码方式，通过pytest.main()来执行，即可抓取此main文件所在的目录和同级下所有目录里的用例；

import pytest

if __name__ == '__main__':
    pytest.main(args=["-v","test_case.py::Test_case::test_ddd","--html=report/report.html","--self-contained-html"])

pytest.main(["-v"])
pytest.main()