CSDN最新最全python+pytest接口自动化(12)-自动化用例编写思路 (使用pytest编写一个测试脚本)

梦里梦外; 2024-02-17 09:28 47阅读 0赞

经过之前的学习铺垫，我们尝试着利用pytest框架编写一条接口自动化测试用例，来厘清接口自动化用例编写的思路。

我们在百度搜索`天气查询`，会出现如下图所示结果：

![a88f6a4fe2284b78bebac54842319717.png][]

接下来，我们以该天气查询接口为例，编写接口测试用例脚本。

### 一，明确测试对象 ###

针对某个功能做接口测试，首先我们需要确定实现这个功能调用的是哪个接口，这个接口的具体信息（如功能、协议、URL、请求方法、请求参数说明、响应参数说明等等）可以通过查看开发提供的接口文档获取，也可以通过抓包（在没有接口文档的情况下）获取。找到对应的接口也就是测试对象之后，才能有目的的进行下一步。

1，这里显然是没有接口文档提供接口相关的信息的，我们甚至都不知道请求url，那么先Fiddler抓包获取接口信息。

![54a458a42d1375ecf226fb7b13b1d124.png][]

通过抓包我们抓取到了该接口的信息如下：

> 请求url：[https://weathernew.pae.baidu.com/weathernew/pc][https_weathernew.pae.baidu.com_weathernew_pc]
> 
> 请求方式：GET
> 
> 请求参数：

2，抓取到以上这些接口信息后，我们先编写简单的脚本请求该接口，如下：

url = "https://weathernew.pae.baidu.com/weathernew/pc"
    params = {
    	"query": "浙江杭州天气",
    	"srcid": 4982
    }
    res = requests.get(url=url, params=params)
    print(res.status_code)
    print(res.text)

运行代码，接口调试通过，能获取到结果，如下：

![a8ac3c6d601be6c28da32c73b43d3f09.png][]

3，明确需求，确定用例。

我们在针对某个接口做自动化测试时，需要先明确用例需要验证的测试点。有些接口既要进行正向的校验，也要进行异常的校验，而有些接口可能在自动化时只需要进行正向校验就够了，无需做异常校验。

我们来分析一下示例的这个天气查询接口，主要有两个测试点：

*  正向请求：输入存在的城市，能查找对应城市的天气
 *  异常请求：输入不存在的城市，提示错误

### 二，编写测试用例 ###

编写测试用例时，我们需要将代码进行封装，可以封装成测试类/方法、测试函数。pytest中对用例封装的命名方式有要求，详细请参考我之前的文章[pytest测试命名规则][pytest]。

至于封装成类还是函数，其实没什么特定的要求，一般`同一个场景`或`同一个测试点相关的接口`可以定义成一个类。

同时用例还需要设置断言，用于校验返回内容是否为期望的内容。**测试用例一定要进行断言，否则毫无意义**。

#### 构造请求数据 ####

正向请求，数据如下：

params = {
    	"query": "浙江杭州天气",
        "srcid": 4982
    }

异常请求，数据如下：

params = {
    	"query": "微信公众号：测试上分之路",
        "srcid": 4982
    }

正向请求的结果我们在上面调试请求该接口的时候已经拿到了，如上面的截图。

我们来看下异常请求的结果，为后续设置断言做准备，结果如下：

![f91882c15d5b85271f424f9bd869f2d0.png][]

发送异常请求后，返回的code也是200，结果中会出现`暂未开通此城市查询`，且没有出现正向请求中的`window.tplData`内容。

> ### 自动化测试相关教程推荐： ###
> 
> ### [2023最新自动化测试自学教程新手小白26天入门最详细教程,目前已有300多人通过学习这套教程入职大厂！！\_哔哩哔哩\_bilibili][2023_26_300_bilibili] ###
> 
> ### [2023最新合集Python自动化测试开发框架【全栈/实战/教程】合集精华，学完年薪40W+\_哔哩哔哩\_bilibili][2023_Python_40W_bilibili] ###
> 
> ### 测试开发相关教程推荐 ###
> 
> ### [2023全网最牛，字节测试开发大佬现场教学，从零开始教你成为年薪百万的测试开发工程师\_哔哩哔哩\_bilibili][2023_bilibili] ###
> 
> ### postman/jmeter/fiddler测试工具类教程推荐 ###
> 
> ### [讲的最详细JMeter接口测试/接口自动化测试项目实战合集教程，学jmeter接口测试一套教程就够了！！\_哔哩哔哩\_bilibili][JMeter_jmeter_bilibili] ###
> 
> ### [2023自学fiddler抓包，请一定要看完【如何1天学会fiddler抓包】的全网最详细视频教程！！\_哔哩哔哩\_bilibili][2023_fiddler_1_fiddler_bilibili] ###
> 
> ### [2023全网封神，B站讲的最详细的Postman接口测试实战教学，小白都能学会\_哔哩哔哩\_bilibili][2023_B_Postman_bilibili] ###

#### 封装测试代码 ####

这里是针对同一个接口的两条不同的测试用例，我们直接封装一个测试类，专门用于测试该接口。示例代码如下：

class TestWeather:
        '''
        校验百度天气查询接口：https://weathernew.pae.baidu.com/weathernew/pc
        '''
    
        def test_get_weather_normal(self):
            '''正向校验-查询存在的城市的天气'''
            url = "https://weathernew.pae.baidu.com/weathernew/pc"
            params = {
                "query": "浙江杭州天气",
                "srcid": 4982
            }
            res = requests.get(url=url, params=params)
    
    
        def test_get_weather_error(self):
            '''异常校验-查询不存在的城市的天气'''
            url = "https://weathernew.pae.baidu.com/weathernew/pc"
            params = {
                "query": "微信公众号：测试上分之路",
                "srcid": 4982
            }
            res = requests.get(url=url, params=params)

注意，代码里还没有进行断言，不能算是完整的用例。这里我只是为了说明流程而把断言放到下一步，分析后再写断言。

#### 断言设置 ####

断言，即校验结果是否是我们期望的内容。pytest怎么进行断言请参考文章[pytest-断言][pytest-]。

设置断言时，我们需要先明确校验哪些字段。一般而言，接口响应的code都需要断言，`status_code == 200`则说明接口请求通了。然后再去断言其他必要字段，从而校验接口功能是否实现。

由上面的结果可知，**正向请求**可以进行如下断言：

# 断言code是否等于200，存在则该断言通过
    assert res.status_code == 200
    
    # 断言结果中是否存在"window.tplData"，存在则该断言通过
    assert "window.tplData" in res.text

由上面的结果可知，**异常请求**可以进行如下断言：

# 断言code是否等于200，存在则该断言通过
    assert res.status_code == 200
    
    # 断言结果中是否存在"window.tplData"，注意这里是不存在则该断言通过
    assert "window.tplData" not in res.text
    
    # 断言结果中是否存在"暂未开通此城市查询"，存在则该断言通过
    assert "暂未开通此城市查询" in res.text

### 三，执行脚本获取测试结果 ###

使用pytest框架管理执行用例时，需要先安装pytest，并在模块中import，不清楚的同学可以查看我的[pytest系列文章][pytest 1]，这里不做过多说明。

完整示例代码如下：

# @time: 2022-03-20
    # @author: 给你一页白纸
    # 微信公众号：测试上分之路
    
    import requests
    import pytest
    
    
    class TestWeather:
        '''
        校验百度天气查询接口：https://weathernew.pae.baidu.com/weathernew/pc
        '''
    
        def test_get_weather_normal(self):
            '''正向校验-查询存在的城市的天气'''
            url = "https://weathernew.pae.baidu.com/weathernew/pc"
            params = {
                "query": "浙江杭州天气",
                "srcid": 4982
            }
            res = requests.get(url=url, params=params)
            # print(res.status_code)
            # print(res.text)
            assert res.status_code == 200
            assert "window.tplData" in res.text
    
    
        def test_get_weather_error(self):
            '''异常校验-查询不存在的城市的天气'''
            url = "https://weathernew.pae.baidu.com/weathernew/pc"
            params = {
                "query": "微信公众号：测试上分之路",
                "srcid": 4982
            }
            res = requests.get(url=url, params=params)
            print(res.status_code)
            print(res.text)
            assert res.status_code == 200
            assert "window.tplData" not in res.text
            assert "暂未开通此城市查询" in res.text
    
            
    if __name__ == '__main__':
        # 使用pytest执行用例
        pytest.main()

当然，这里因为url是共用的，我们最好是将它提取出来，而不是每个测试方法都去定义一次这个变量，如下图所示：

![f4819a31094aaa60194bd8c47bccd82c.png][]

执行结果如下：

![4919ac41f3ae70b25ef79cc4a1b4d4c2.png][]

### 四，总结 ###

单个接口自动化测试用例，我们可以按照上面的步骤来进行，即 明确测试对象-->编写测试用例-->编写测试脚本-->执行脚本、获取测试结果。通过这些步骤，我们便对自动化用例的编写有了基本的思路（这一点对于我们自动化测试思维的形成很重要），为我们后续的学习实践打下基础。

事实上使用编程语言对项目进行自动化测试时，几乎不可能只存在一条测试用例，那么在有多条测试用例的情况下，需要怎样管理用例、执行用例、获取测试结果？这就是单元测试框架需要解决的问题。

## 总结： ##

## 光学理论是没用的，要学会跟着一起敲，要动手实操，才能将自己的所学运用到实际当中去，这时候可以搞点实战案例来学习。 ##

![b9be6789bcc94f18bc150950a3835330.jpeg][]

![12dd047d61854689ac9b4836fc4f7f5a.jpeg][]

**如果对你有帮助的话，点个赞收个藏，给作者一个鼓励。也方便你下次能够快速查找。**

**如有不懂还要咨询下方小卡片，博主也希望和志同道合的测试人员一起学习进步**

**在适当的年龄，选择适当的岗位，尽量去发挥好自己的优势。**

**我的自动化测试开发之路，一路走来都离不每个阶段的计划，因为自己喜欢规划和总结，**

**测试开发视频教程、学习笔记领取传送门！！**

![514150b5607a48979666fa391dc76077.gif][]

[a88f6a4fe2284b78bebac54842319717.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/b267aed7580b47db8d926e1e51a49233.png
[54a458a42d1375ecf226fb7b13b1d124.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/d69c70367ae54a86846c63fe6acfbdd7.png
[https_weathernew.pae.baidu.com_weathernew_pc]: https://weathernew.pae.baidu.com/weathernew/pc
[a8ac3c6d601be6c28da32c73b43d3f09.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/b84c8b6e4f1e4e468d8f9fe1a0ce5803.png
[pytest]: https://www.cnblogs.com/lfr0123/p/15888563.html
[f91882c15d5b85271f424f9bd869f2d0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/5ed2326c58ce4e2289c594aa7002c853.png
[2023_26_300_bilibili]: https://www.bilibili.com/video/BV17G4y1Z74z/?spm_id_from=333.999.0.0&vd_source=f7b265e48f8139faff684d5069fdfad7
[2023_Python_40W_bilibili]: https://www.bilibili.com/video/BV1AF411T7qJ/?spm_id_from=333.999.0.0
[2023_bilibili]: https://www.bilibili.com/video/BV1hX4y187wi/?spm_id_from=333.999.0.0&vd_source=f7b265e48f8139faff684d5069fdfad7
[JMeter_jmeter_bilibili]: https://www.bilibili.com/video/BV1e44y1X78S/?spm_id_from=333.999.0.0&vd_source=f7b265e48f8139faff684d5069fdfad7
[2023_fiddler_1_fiddler_bilibili]: https://www.bilibili.com/video/BV1o54y1u7UU/?spm_id_from=333.999.0.0
[2023_B_Postman_bilibili]: https://www.bilibili.com/video/BV16L41117wB/?spm_id_from=333.999.0.0
[pytest-]: https://www.cnblogs.com/lfr0123/p/15891226.html
[pytest 1]: https://www.cnblogs.com/lfr0123/tag/pytest/
[f4819a31094aaa60194bd8c47bccd82c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/56334d0444204de1b92feb46069d6595.png
[4919ac41f3ae70b25ef79cc4a1b4d4c2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/0cf5bbe633ee49309bfc97eaf11e8931.png
[b9be6789bcc94f18bc150950a3835330.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/64c50e1e917344eb8d38984020770ce0.png
[12dd047d61854689ac9b4836fc4f7f5a.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/431227636887405bac6d10a58ba42cac.png
[514150b5607a48979666fa391dc76077.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/5aba256ae7974e4399d597969a2040e9.png