# api_auto_test_frame

**Repository Path**: xcma/api_auto_test_frame

## Basic Information

- **Project Name**: api_auto_test_frame
- **Description**: No description available
- **Primary Language**: Python
- **License**: MulanPSL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-18
- **Last Updated**: 2021-01-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


> 支持Python3.6及以上版本

## 功能列表


- 用例排序，只需要导入utx库，用例的执行顺序就会和编写顺序一致

- 用例自定义标签，在 tag.py 里边添加标签，可以对测试用例指定多个标签。全部用例默认带有`ALL`标签。

```python
@unique
class Tag(Enum):
    ALL = NewTag("完整")  # 完整测试标记，可以重命名，不要删除
    SMOKE = NewTag("冒烟")  # 冒烟测试标记

    # 以下开始为扩展标签，自行调整
    V1_0_0 = NewTag("V1.0.0版本")
    V2_0_0 = NewTag("V2.0.0版本")
```

```python
class TestLegion(unittest.TestCase):

    @tag(Tag.SMOKE)
    def test_create_legion(self):
        pass

    @tag(Tag.V1_0_0, Tag.ALL)
    def test_quit_legion(self):
        """测试退出军团

        :return:
        """
        print("测试退出军团")
        assert 1 == 2
```

- 运行指定标签的测试用例

```python
from utx import *

if __name__ == '__main__':
    setting.run_case = {Tag.ALL}  # 运行全部测试用例
    # setting.run_case = {Tag.SMOKE}  # 只运行SMOKE标记的测试用例
    # setting.run_case = {Tag.SMOKE, Tag.V1_0_0}   # 只运行SMOKE和V1_0_0标记的测试用例

    runner = TestRunner()
    runner.add_case_dir(r"testcase")
    runner.run_test(report_title='接口自动化测试报告')
```

- 数据驱动
```python
class TestLegion(unittest.TestCase):

    @data(["gold", 100], ["diamond", 500])
    def test_bless(self, bless_type, cost):
        """测试公会祈福

        :param bless_type: 祈福类型
        :param cost: 消耗数量
        :return:
        """
        print(bless_type)
        print(cost)
        
    @data(10001, 10002, 10003)
    def test_receive_bless_box(self, box_id):
        """ 测试领取祈福宝箱

        :return:
        """
        print(box_id)

# 默认会解包测试数据来一一对应函数参数，可以使用unpack=False，不进行解包

class TestBattle(unittest.TestCase):
    @data({"gold": 1000, "diamond": 100}, {"gold": 2000, "diamond": 200}, unpack=False)
    def test_get_battle_reward(self, reward):
        """ 测试领取战斗奖励

        :return:
        """
        print(reward)
        print("获得的钻石数量是：{}".format(reward['diamond']))
 ```

- 检测用例是否编写了用例描述
```python
2017-11-13 12:00:19,334 WARNING legion.test_legion.test_bless没有用例描述
```

- 采集测试用例的print打印的信息到测试报告里边
```python
@data({"gold": 1000, "diamond": 100}, {"gold": 2000, "diamond": 200}, unpack=False)
def test_get_battle_reward(self, reward):
    """ 领取战斗奖励

    :return:
    """
    print(reward)
    print("获得的钻石数量是：{}".format(reward['diamond']))
```

![](https://github.com/jianbing/utx/raw/master/img/print_info.png)


- 执行测试时，显示测试进度
```
2019-03-13 18:46:13,810 INFO 开始测试，用例数量总共15个，跳过5个，实际运行10个
2019-03-13 18:46:13,910 INFO start to test battle.test_tattle.test_start_battle (1/10)
2019-03-13 18:46:14,010 INFO start to test battle.test_tattle.test_skill_buff (2/10)
2019-03-13 18:46:14,111 INFO start to test battle.test_tattle.test_normal_attack (3/10)
2019-03-13 18:46:14,211 INFO start to test battle.test_tattle.test_get_battle_reward (4/10)
2019-03-13 18:46:14,211 DEBUG 测试领取战斗奖励，获得的钻石数量是：100
2019-03-13 18:46:14,311 INFO start to test battle.test_tattle.test_get_battle_reward (5/10)
```

- setting类提供多个设置选项进行配置
```python
class setting:

    # 只运行的用例类型
    run_case = {Tag.SMOKE}

    # 开启用例排序
    sort_case = True

    # 每个用例的执行间隔，单位是秒
    execute_interval = 0.1

    # 开启检测用例描述
    check_case_doc = True

    # 显示完整用例名字（函数名字+参数信息）
    full_case_name = False

    # 测试报告显示的用例名字最大程度
    max_case_name_len = 80

    # 执行用例的时候，显示报错信息
    show_error_traceback = True

    # 测试报告样式1
    create_report_by_style_1 = True

    # 测试报告样式2
    create_report_by_style_2 = True
    
    # 在控制台显示print打印的内容
    show_print_in_console = False
```


- 集成两种测试报告样式，感谢两位作者的测试报告模版  
    
[测试报告1](https://github.com/findyou/HTMLTestRunnerCN)

![](https://github.com/jianbing/utx/raw/master/img/style1.png)

[测试报告2](https://github.com/zhangfei19841004/ztest)

![](https://github.com/jianbing/utx/raw/master/img/style2.png)

- 无缝接入unittest项目，导入utx包即可开始使用扩展功能，无需修改之前的代码


## 例子

demo目录下，有几个例子：

- ```run.py```  一个完整使用功能的

- ```use_report.py``` 单独使用测试报告组件，不需要其他扩展功能

- ```debug_case.py``` 使用，单独调试某个用例的例子