HTML自动化测试报告框架XTestRunner 详细介绍和各种使用实例,Python代码实现

HTML自动化测试报告框架XTestRunner 详细介绍和各种使用实例,Python代码实现

XTestRunner是一个测试框架,可以帮助开发者进行单元测试、集成测试等各种测试,提高代码的可靠性和质量。这个框架支持同时运行多个测试,每个测试都可以独立运行,测试结果会自动统计和输出。


以下是XTestRunner的详细介绍和使用实例:


安装XTestRunner:


在Python的pip安装器中输入以下命令即可完成安装:


pip install xtestrunner

XTestRunner的基本使用:

编写测试用例:


在编写测试用例时需要继承XTestCase类,并实现测试方法。测试方法的命名必须以“test_”开头,例如:test_add(),test_subtract()。


from xtestrunner import XTestCase

class TestCalculator(XTestCase):
    def test_add(self):
        result = Calculator().add(1, 2)
        self.assertEqual(result, 3)

    def test_subtract(self):
        result = Calculator().subtract(5, 3)
        self.assertEqual(result, 2)


运行测试用例:


在main.py文件中,调用XTestRunner的run()方法,传入测试类的名称或对象。


from xtestrunner import XTestRunner
from tests import TestCalculator

XTestRunner.run(TestCalculator)


运行结果输出:


测试结果会输出在控制台中,如下所示:


  TestCalculator:
    test_add: pass
    test_subtract: pass

Ran 2 tests in 0.001s

OK

支持使用装饰器@XTestRunner内部的方法:


from xtestrunner import XTestCase, XTestRunner

class TestCalculator(XTestCase):

    @XTestRunner.test
    def test_add(self):
        result = Calculator().add(1, 2)
        self.assertEqual(result, 3)

    @XTestRunner.test
    def test_subtract(self):
        result = Calculator().subtract(5, 3)
        self.assertEqual(result, 2)

XTestRunner.run(TestCalculator)

使用命令行进行测试:


在命令行中,输入以下命令即可运行测试用例:


python main.py tests.TestCalculator

其中,“main.py”是测试运行器的Python文件,“tests.TestCalculator”是测试类的完整名称,即“模块名.类名”。


运行结果输出:


  TestCalculator:
    test_add: pass
    test_subtract: pass

Ran 2 tests in 0.001s

OK

XTestRunner的高级用法:

测试套件:


测试套件可以将多个测试组织在一起,统一运行和输出结果。在编写测试套件时需要继承XTestSuite类,并将测试用例作为参数传入。


from xtestrunner import XTestSuite

from tests.test_calculator import TestCalculator
from tests.test_converter import TestConverter

test_suite = XTestSuite(TestCalculator, TestConverter)

if __name__ == "__main__":
    test_suite.run()


测试用例装饰器:


在测试用例装饰器中可以添加setUp、tearDown方法,分别用于初始化和清理测试环境。


from xtestrunner import XTestCase, XTestRunner

class TestCalculator(XTestCase):

    def setUp(self):
        self.calculator = Calculator()
        self.calculator.clear()
    
    def tearDown(self):
        self.calculator.clear()
        self.calculator = None

    @XTestRunner.test
    def test_add(self):
        result = self.calculator.add(1, 2)
        self.assertEqual(result, 3)

    @XTestRunner.test
    def test_subtract(self):
        result = self.calculator.subtract(5, 3)
        self.assertEqual(result, 2)

XTestRunner.run(TestCalculator)


测试报告:


测试报告可以将测试结果输出为HTML或者XML格式,方便进行查看和分析。在运行测试时需要指定输出路径和格式。


from xtestrunner import XTestRunner

if __name__ == "__main__":
    report_path = "test_report.html"
    report_format = "html"
    XTestRunner.run(TestCalculator, report_path=report_path, report_format=report_format)

总结:


XTestRunner是一个简单易用的测试框架,可以帮助开发者快速编写和运行测试用例,提高代码的可靠性和质量。通过使用测试套件、测试用例装饰器和测试报告等高级功能,可以更好地组织和管理测试过程,提高测试效率和准确性。


XTestRunner深度封装成一个类文件,以及各种实例调用


以下是一个示例代码,展示了XTestRunner深度封装成一个类文件,并且展示了各种实例调用的例子:


import unittest
from typing import List
from xtestrunner import XTestRunner

class MyTestRunner(XTestRunner):
    def __init__(self, test_modules: List[str]):
        super().__init__(test_modules)
    
    def before_test(self, test):
        print(f'Running test: {test._testMethodName}')
    
    def after_test(self, test):
        if test.resultClass.errors:
            print(f'Test {test._testMethodName} failed: {test.resultClass.errors[-1][1]}')
        else:
            print(f'Test {test._testMethodName} passed!')
    
    def run_tests(self):
        self.run()

if __name__ == '__main__':
    test_runner = MyTestRunner(['test_module1', 'test_module2'])
    test_runner.run_tests()

在这个示例中,我们创建了一个名为 MyTestRunner 的类,继承自XTestRunner类。我们重写了before_test和after_test方法,以便在测试运行之前和运行之后打印一些有用的信息。我们还添加了一个名为run_tests的方法,以便在需要时轻松地调用测试运行器。


在最后几行中,我们实例化了MyTestRunner类,并将要运行的测试模块列表传递给其构造函数。然后我们调用run_tests方法来运行所有的测试。

XTestRunner更多使用实例

XTestRunner是一个用于测试Python代码的工具,具有丰富的功能,以下是一些使用示例:

  1. 运行单个测试文件
python -m xtestrunner test_sample.py

这将运行名为test_sample.py的单个测试文件,并输出其结果。

  1. 运行单个测试类
python -m xtestrunner test_sample.TestSample

这将运行名为TestSample的单个测试类,并输出其结果。

  1. 运行单个测试方法
python -m xtestrunner test_sample.TestSample.test_method

这将运行名为test_method的单个测试方法,并输出其结果。

  1. 运行匹配特定模式的测试
python -m xtestrunner -k "pattern" test_sample.py

这将运行名称包含"pattern"的所有测试,并输出其结果。

  1. 运行多个测试文件
python -m xtestrunner test_file1.py test_file2.py

这将运行多个测试文件,并输出所有的结果。

  1. 运行所有测试
python -m xtestrunner

这将运行当前目录下所有的测试,并输出所有的结果。

  1. 将测试结果输出到文件
python -m xtestrunner test_sample.py > results.txt

这将运行名为test_sample.py的测试,并将结果输出到名为results.txt的文件中。

  1. 输出覆盖率报告
python -m xtestrunner --coverage test_sample.py

这将运行名为test_sample.py的测试,并输出覆盖率报告。

  1. 输出HTML格式的覆盖率报告
python -m xtestrunner --coverage-html cov_html test_sample.py

这将运行名为test_sample.py的测试,并将HTML格式的覆盖率报告输出到cov_html目录中。

以上是XTestRunner的一些使用示例,你可以根据自己的需要进行调整和组合。

猜你喜欢

转载自blog.csdn.net/zh6526157/article/details/129887419