接口测试用例编写举例

最新推荐文章于 2024-08-08 14:45:27 发布

lychbeyond

最新推荐文章于 2024-08-08 14:45:27 发布

阅读量4w

点赞数

经过前三章的学习，我们准备好了对接口进行自动化测试的相关知识。现在我们开始讲解接口自动化测试用例的编写。在本章编写的测试用例中，我们只针对具体的接口，编写自动化测试用例，而不对代码架构进行规划，那些儿进阶性的知识点，我们将在后面的章节讲解。先学习如何砌砖，然后我们再去建自己的高楼大厦。

4.1 Get方式接口自动化用例

Get方式的接口自动化相对来说比较简单，直接调用接口地址，把参数放到接口地址后面即可。下面我们以众筹网的接口实例来讲解：

（1）接口文档

按关键字搜索项目（GET）：

URL：http://api.zhongchou.cn/deal/list

参数：

keyword，搜索关键字

offset，拉取偏移，非必需，默认为0

count，拉取个数，非必需，默认为10

返回：项目Feed基础数据结构的数组

上面是一个搜索项目的接口文档，从文档中我们得知，这个接口是Get方式的，而且有三个参数，第一个参数是必需的，后两个参数是非必需的。返回值是Feed基础数据结构的数据（暂不要理会）。

（2）Curl命令调用

为了安全期间，我们调用测试环境下的数据，先绑定host:xx.xx.xx.xx api.zhongchou.cn。然后在终端下执行下面的命令：

[root@n028 api]# curlhttp://api.zhongchou.cn/deal/list?v=1&keyword='测试'

执行结果如图4.1.1所示：

图4.1.1 Curl调用接口返回值

当然，上面在终端下的接口返回的结果是加密后的json字符串，不太容易看明白。

（3）浏览器访问接口

为了使用接口返回值更加清晰明了，我们要借助于一个浏览器插件JsonView。此插件可以直接解析接口返回的json字符串，方便明了，不过有个缺点：只能查看Get方式的接口。

针对上面的例子，我们直接在浏览器的地址栏中输入http://api.zhongchou.cn/deal/list?v=1&keyword='测试'，然后回车，就可以看到如图4.1.2所示：

图4.1.2浏览器访问接口

这样访问接口，返回值是不是更加清晰了。对应返回值中包含的汉字也作了对应的解码。

（4）PHP调用Get方式接口

PHP对接口的调用有完整的一套函数，对于Get方式的接口，只需要调用函数file_get_contents（）就能得到返回值。

示例代码如下：

[php]view plain copy 
   
 class Demoextends PHPUnit_Framework_TestCase{  
   
     public function testSearch()  
   
     {  
   
        $url="http://api.zhongchou.cn/deal/list?keyword=测试&v=1";  
   
         $ret=file_get_contents($url);  
   
         echo $ret;  
   
     }  
   
 }

在JetBrains PhpStorm执行结果如图4.1.3所示：

图4.1.3 PHP调用Get接口执行结果

这个结果和在终端下调用Curl命令结果是一样的，那有没有和浏览器下结果那样的呢？当然有了，因为这个接口返回值是json编码过的，我们调用函数json_decode（）解码一下即可。解码后的结果见图4.1.4所示：

图4.1.4 对接口返回值进行解码输出

（5）PHP编写Get接口自动化测试用例

经过上面的四步分析，我们已经可以用php来调用接口了，可是这还不是完整的自动化测试用例。我们需要添加对返回结果的验证，如果和预期的一样，就成功，如果不一样就失败。

完整的测试用例：

[php]view plain copy 
   
 class Demo extendsPHPUnit_Framework_TestCase{  
   
    public function testSearch()  
   
 {  
   
   /** 
  
 *测试搜索接口 
  
 **/  
   
        $url="http://api.zhongchou.cn/deal/list?keyword=测试&v=1";  
   
        $ch = curl_init();  
   
        curl_setopt($ch, CURLOPT_URL, $url);  
   
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);  
   
        curl_setopt($ch, CURLOPT_HEADER, 0);  
   
        $ret=curl_exec($ch);  
   
        curl_close($ch);  
   
        $data=json_decode($ret,true);  
   
        //print_r($data);  
   
        if(is_null($data)==false)  
   
        {  
   
            if($data['errno']=='0')  
   
            {  
   
                 $this->assertEquals('0',$data['errno']);//判断errno是否为0，此步为抛出执行通过  
   
                 $index=strpos($data['data'][0]['name'],'测试');  
   
                $this->assertnotEquals(-1,$index);//判断结果是否包含关键字  
   
                 print('接口/deal/list：搜索接口------------------OK'.'\n');  
   
             }  
   
            else  
   
            {  
   
                $this->assertEquals('0',$data['errno']);//抛出执行失败  
   
                 print("接口/deal/list：搜索接口---------------Failure!"."\n".$ret."\n");  
   
            }  
   
        }  
   
     }  
   
 }

我们为了判断结果，没有调用file_get_contents（）函数，而改用了PHP调用接口的通用方法，如果不理解可以去网上查找相关讲解。而后我们加入了对接口返回值$data的判断：判断errno是否为0，查询结果中有没有包含关键字等。对于检测点的设置技巧，我们将在后面进阶篇中讲解。

结过这样的测试用例代码，我们就可以执行测试用例了，并且测试用例会自己判断接口调用的结果。执行结果如图4.1.5所示，如果想查看接口的具体返回值，只需要取消//print_r($data);此句的注释即可。

图4.1.5 Get接口的执行结果

4.2 Post接口自动化测试用例

Post方式的接口是上传接口，需要对接口头部进行封装，所以没有办法在浏览器下直接调用，但是可以用Curl命令的-d参数传递接口需要的参数。当然我们还以众筹网的登录接口为例，讲解post方式接口的自动化测试用例。

（1）接口文档

.登录(POST)

URL：http://api.zhongchou.cn/user/login

参数：

· identity，用户名、用户手机、用户邮箱，三者之一

· password，用户密码

· errno，0：表示成功，非0：表示失败

· User基础数据结构

· token，成功会返回32位token字符串，失败会返回空字符串

这个接口文档很清楚，就是传递用户名和密码进行登录，登录后会返回user基本数据结构和Token。

（2）Curl命令执行

分析了接口文档，我们需要在终端下执行接口，然后才能根据接口的返回值来编写对应的接口测试用例。

在终端下执行命令：

[root@n028 api]# curl -d 'identity=183****8905&password=a******0'http://api.zhongchou.cn/user/login?v=1

其中的identity为众筹网的用户名，password为密码，V=1是因为这个接口是第一版本的。执行结果如图4.2.1所示：

图4.2.1 post接口Curl执行结果

（3）Curl返回值查看

由于post方式无法用浏览器直接调用，返回结果是编码后的json字符串，不方便我们查看结果。所以我们要借助于chrome的插件。

打开chrome浏览器->右击浏览器，选择“审查元素”->在浏览器下部选择“Console”选项卡。在打开的栏目下的“>”后输入dir().然后将刚刚终端Curl返回的结果拷贝到这个函数中，回车即可解析结果。如图4.2.2所示：

图4.2.2 Chrome查看出post返回结果

(4) PHP调用Post方式接口

PHP调用Post接口和Get方式有所不同，一般用以下方式调用，而且是固定的：

[php]view plain copy 
   
 public function testlogin()  
   
     {  
   
         $url='http://api.zhongchou.cn/user/login?v=1';  
   
         $post_params=array('identity'=>'183****8905','password'=>'a0****0');  
   
         $ch = curl_init();//初始化curl  
   
         curl_setopt($ch, CURLOPT_URL,$url);//抓取指定网页  
   
         curl_setopt($ch, CURLOPT_HEADER, 0);//设置header  
   
         curl_setopt($ch,CURLOPT_RETURNTRANSFER, 1);//要求结果为字符串且输出到屏幕上  
   
         curl_setopt($ch, CURLOPT_POST,1);//post提交方式  
   
         curl_setopt($ch,CURLOPT_POSTFIELDS,$post_params);  
   
         $data = curl_exec($ch);//运行curl  
   
         curl_close($ch);  
   
         echo $data;  
   
     }

然后执行代码，就可以看到如图4.2.3所示的输出结果：

图4.2.3 PHP调用post方式接口

如到Get方式，这个输出结果同样是经过编码后的json字符串，我们也需要对其进行json_decode（）解码一下，然后再输出结果。所以增加以下两行代码：

$res=json_decode($data);

print_r($res);

此时的输出结果图4.2.4所示，简单清晰了许多。

图4.2.4 PHP解码后的输出结果

（5）PHP编写Post接口自动化测试用例

现在PHP能调用post方式的接口了，可是没有添加自动判断执行结果的脚本，不算是一个真正的测试用例。接下来我们添加上对返回值的assert语句，使之成为一个完整的自动化测试用例。

完整的测试用例如下：

[php]view plain copy 
   
 public function testlogin()  
   
     {  
   
        $url='http://api.zhongchou.cn/user/login?v=1';  
   
        $post_params=array('identity'=>'183****8905','password'=>'a0******0');  
   
         $ch =curl_init();//初始化curl  
   
         curl_setopt($ch,CURLOPT_URL,$url);//抓取指定网页  
   
         curl_setopt($ch,CURLOPT_HEADER, 0);//设置header  
   
         curl_setopt($ch,CURLOPT_RETURNTRANSFER, 1);//要求结果为字符串且输出到屏幕上  
   
         curl_setopt($ch, CURLOPT_POST, 1);//post提交方式  
   
         curl_setopt($ch,CURLOPT_POSTFIELDS,$post_params);  
   
         $res =curl_exec($ch);//运行curl  
   
         curl_close($ch);  
   
        $data=json_decode($res,true);  
   
         //print_r($data);  
   
         if(is_null($data)==false)  
   
         {  
   
            if($data['errno']=='0')  
   
             {  
   
                $this->assertEquals('0',$data['errno']);//判断errno是否为0，此步为抛出执行通过  
   
                 $index=strpos($data['data']['name'],'8905');  
   
                $this->assertnotEquals(-1,$index);//判断结果是否包含关键字  
   
                 print('接口/user/login：登录接口------------------OK'."\n");  
   
             }  
   
             else  
   
             {  
   
                $this->assertEquals('0',$data['errno']);//抛出执行失败  
   
                print("接口/user/login：登录接口---------------Failure!"."\n".$res."\n");  
   
             }  
   
         }  
   
 }