Python自动化

关键词：接口、python、requests、unittest
引言：一般对于自动化的理解，有两种方式的自动化。
第一，不需要写代码，完全由工具实现，这种方式的工具一般是公司自己研发的，方便黑盒测试人员使用。这种工具的特点是学习成本低，方便使用，但是通用性不强，也就是换了一家公司，就很有可能无法使用之前的工具。
第二，需要自己写代码，在别人的框架下编写代码测试，或者是需要自己搭建自动化测试框架。这种方式对测试人员的代码要求高，学习成本高，但是通用性很强，去任何一家都可以用这套东西。鉴于以上介绍，本文当然是介绍第二种方式了。
我们的课题是接口自动化，我们的目的是使用python进行接口测试，并完成输出测试报告。我们需要用到的东西有如下：python3，unittest，requests。

一：接口项目
我们使用的项目是发布会签到系统。总共有5个接口，虽然不多，但足够学习使用。
 

二、接口用例
软件测试都需要写测试用例，不管你做的性能，自动化还是其它任何的测试工作。
真实的工作写接口的测试用例，可能考虑很多场景，如接口的功能（正常场景），接口的边界等价，接口的异常场景，接口参数组合，接口的性能等等。本文采用输出法分析，根据出参的不同设计出测试用例。详细用例参考如下：（用例太小看不清楚，可以查看原图，然后放大）

三、代码阶段
3.1 框架的设计
我们使用unittest框架，case目录存放所有的测试用例，lib目录存放自己封装的一些代码，result目录存放测试结果和测试日志，runner.py是主程序。

3.2 主程序 runner.py
这个主程序跟之前的《selenium unittest实战》文章类似，不再详细介绍，不太一样的地方是使用一个logging模块。不知道大家有没有感受，测试接口的时候，想看完整的请求和响应，以便分析定位问题。

  

   

    

     

    
    

     

      import  unittest
     
    
   

    

     

    
    

     

      import  time
     
    
   

    

     

    
    

     

      import os
     
    
   

    

     

    
    

     

      import logging
     
    
   

    

     

    
    

     

      from HTMLTestRunner 
      import  HTMLTestRunner
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

      #获取项目的根目录
     
    
   

    

     

    
    

     

      test_dir = os.path.join(os.getcwd())
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

      # 自动搜索项目根目录下的所有case，构造测试集；返回TestSuite对象
     
    
   

    

     

    
    

     

      discover = unittest.defaultTestLoader.discover(test_dir, pattern=
      'test_*.py')
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

      # 实例化TextTestRunner类
     
    
   

    

     

    
    

     

      # runner = unittest.TextTestRunner(verbosity=2)
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

      now = time.strftime(
      '%Y-%m-%d %H_%M_%S')  
      # 获取当前日期
     
    
   

    

     

    
    

     

      result = test_dir+ 
      '\\result\\'+now + 
      '_result.html'  
      # 测试报告的完整路径
     
    
   

    

     

    
    

     

      log = test_dir+
      '\\result\\'+now+
      '_log.txt'  
      #日志的完整路径
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

      logging.basicConfig(filename=log,level=logging.INFO,format = 
      '%(asctime)s - %(name)s - %(levelname)s - %(message)s') 
      #filename 日志文件路径 level 日志的级别 format 格式
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

      fp = open(result, 
      'wb')  
      # wb方式写入
     
    
   

    

     

    
    

     

      runner = HTMLTestRunner(stream=fp, title=
      '测试报告', description=
      'aguest_master项目用例执行情况',verbosity=
      2)  
      #构造runner
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

      # 使用run()方法运行测试套件（即运行测试套件中的所有用例）
     
    
   

    

     

    
    

     

      runner.run(discover)
     
    
  

3.3 测试用例和lib库
1） 由于总共只有5个接口，所以设计为5个代码文件，分别为：test_add_event,py，test_add_guest.py，test_get_event_list.py，test_get_guest_list.py，test_user_sign.py。

2）我们使用python的requests测试接口，这个库大名鼎鼎，而且官网还有中文。
官网网址：http://docs.python-requests.org/zh_CN/latest/

3）每个代码文件都是一个接口，接口的url地址是固定的，所以设计成类属性，方便后续测试用例使用。

4）每个测试用例都写明代码逻辑，方便以后调试。
5）如果遇到经常调用的东西，如获取最新发布会ID，获取添加发布会body数据，都封装成库。
6）最后根据出参的状态码断言是否成功
7）使用logging.info 记录每个测试用例的日志情况

添加发布会接口代码文件：test_add_event.py

  

   

    

     

    
    

     

      import requests
     
    
   

    

     

    
    

     

      import unittest
     
    
   

    

     

    
    

     

      import logging
     
    
   

    

     

    
    

     

      import addEventDataTemplate
     
    
   

    

     

    
    

     

      import getNewID
     
    
   

    

     

    
    

     

      from urllib 
      import  parse  
      #使用requests发送post请求，body的汉字会进行url编码，即%xx形式。想看到原始body，需要使用parse.unquote进入url解码
     
    
   

    

     

    
    

     

      class Test_addEvent(unittest.TestCase):
     
    
   

    

     

    
    

     
    
      '''添加发布会接口'''
     
    
   

    

     

    
    

     

       @classmethod
     
    
   

    

     

    
    

     
    
      def setUpClass(cls):
     
    
   

    

     

    
    

     

              cls.url=
      "http://127.0.0.1:8000/api/add_event/"
     
    
   

    

     

    
    

     

       @classmethod
     
    
   

    

     

    
    

     
    
      def tearDownClass(cls):
     
    
   

    

     

    
    

     
        
      pass
     
    
   

    

     

    
    

     
    
      def setUp(self):
     
    
   

    

     

    
    

     
        
      pass
     
    
   

    

     

    
    

     
    
      def tearDown(self):
     
    
   

    

     

    
    

     
        
      pass
     
    
   

    

     

    
    

     
    
      def test_00(self):   
      #代码逻辑::获取当前最新发布会ID，设置入参，eid置空，发送post请求
     
    
   

    

     

    
    

     
        
      '''添加发布会-eid为空'''
     
    
   

    

     

    
    

     

              id=getNewID.getNewID()   
      #获取当前最新发布会ID
     
    
   

    

     

    
    

     

              data=addEventDataTemplate.getEventData(id)  
      #获取添加发布会的数据模板
     
    
   

    

     

    
    

     

              data[
      'eid']=
      ''  
      #eid为空，即参数错误
     
    
   

    

     

    
    

     

              r=requests.post(self.url,data=data)
     
    
   

    

     

    
    

     

              status=r.json()[
      'status']
     
    
   

    

     

    
    

     

              self.assertEqual(
      10021,status)
     
    
   

    

     

    
    

     

              logging.info(
      f"case:添加发布会，eid为空\n请求地址：{r.url}\t请求方式:{r.request.method}\n请求头：{r.request.headers}\n请求正文：{parse.unquote(r.request.body)}\n响应头：{r.headers}\n响应正文：{r.text}\n")
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     
    
      def test_01(self):    
      #代码逻辑::获取当前最新发布会ID，设置入参，发送post请求
     
    
   

    

     

    
    

     
        
      '''添加发布会-成功'''
     
    
   

    

     

    
    

     

              id = getNewID.getNewID()  
      # 获取当前最新发布会ID
     
    
   

    

     

    
    

     

              data = addEventDataTemplate.getEventData(id)
      #获取添加最新发布会的数据模板
     
    
   

    

     

    
    

     

              r=requests.post(self.url,data=data)
     
    
   

    

     

    
    

     

              status=r.json()[
      'status']
     
    
   

    

     

    
    

     

              self.assertEqual(
      10000,status)
     
    
   

    

     

    
    

     

              logging.info(
      f"case:添加发布会，成功\n请求地址：{r.url}\t请求方式:{r.request.method}\n请求头：{r.request.headers}\n请求正文：{parse.unquote(r.request.body)}\n响应头：{r.headers}\n响应正文：{r.text}\n")
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     
    
      def test_02(self):   
      #代码逻辑::获取当前最新发布会ID，ID-1即为发布会已经存在的ID（发布会ID是递增加1）
     
    
   

    

     

    
    

     
        
      '''添加发布会-发布会ID已存在'''
     
    
   

    

     

    
    

     

              id = getNewID.getNewID()  
      # 获取当前最新发布会ID
     
    
   

    

     

    
    

     

              data=addEventDataTemplate.getEventData(id)
      #获取添加最新发布会的数据模板
     
    
   

    

     

    
    

     

              data[
      'eid']=data[
      'eid']
      -1  
      #最新模板ID减一即为重复ID
     
    
   

    

     

    
    

     

              r=requests.post(self.url,data=data)
     
    
   

    

     

    
    

     

              status = r.json()[
      'status']
     
    
   

    

     

    
    

     

              self.assertEqual(
      10022, status)
     
    
   

    

     

    
    

     

              logging.info(
      f"case:添加发布会，发布会ID已存在\n请求地址：{r.url}\t请求方式:{r.request.method}\n请求头：{r.request.headers}\n请求正文：{parse.unquote(r.request.body)}\n响应头：{r.headers}\n响应正文：{r.text}\n")
     
    
   

    

     

    
    

     
    
      def test_03(self):   
      #代码逻辑::先新增发布会，再获取最新发布会ID，设置入参的name为重复。
     
    
   

    

     

    
    

     
        
      '''添加发布会-发布会标题已存在'''
     
    
   

    

     

    
    

     
        
      #新增发布会
     
    
   

    

     

    
    

     

              id = getNewID.getNewID()  
      # 获取当前最新发布会ID
     
    
   

    

     

    
    

     

              r=requests.post(self.url,data=addEventDataTemplate.getEventData(id))  
      #先新增一个发布会
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

              id = getNewID.getNewID()  
      # 获取当前最新发布会ID
     
    
   

    

     

    
    

     

              data = addEventDataTemplate.getEventData(id)
      #获取添加最新发布会的数据模板
     
    
   

    

     

    
    

     

              data[
      'name']=
      f'发布会测试标题{id}' 
      #最新模板ID减一，标题即为重复
     
    
   

    

     

    
    

     

              r=requests.post(self.url,data=data)
     
    
   

    

     

    
    

     

              status = r.json()[
      'status']
     
    
   

    

     

    
    

     

              self.assertEqual(
      10023,status)
     
    
   

    

     

    
    

     

              logging.info(
      f"case:添加发布会，发布会标题已存在\n请求地址：{r.url}\t请求方式:{r.request.method}\n请求头：{r.request.headers}\n请求正文：{parse.unquote(r.request.body)}\n响应头：{r.headers}\n响应正文：{r.text}\n")
     
    
   

    

     

    
    

     
    
      def test_04(self):   
      #代码逻辑::获取最新发布会ID，设置入参，开始时间:改为-,再提交请求
     
    
   

    

     

    
    

     
        
      '''添加发布会-发布会时间错误'''
     
    
   

    

     

    
    

     

              id = getNewID.getNewID()  
      # 获取当前最新发布会ID
     
    
   

    

     

    
    

     

              data = addEventDataTemplate.getEventData(id)
      #获取添加最新发布会的数据模板
     
    
   

    

     

    
    

     

              data[
      'start_time']=data[
      'start_time'].replace(
      ':',
      '-')  
      #时间 : 改为 - ,即为时间错误
     
    
   

    

     

    
    

     

              r = requests.post(self.url, data=data)
     
    
   

    

     

    
    

     

              status = r.json()[
      'status']
     
    
   

    

     

    
    

     

              self.assertEqual(
      10024,status)
     
    
   

    

     

    
    

     

              logging.info(
      f"case:添加发布会，发布会时间错误\n请求地址：{r.url}\t请求方式:{r.request.method}\n请求头：{r.request.headers}\n请求正文：{parse.unquote(r.request.body)}\n响应头：{r.headers}\n响应正文：{r.text}\n")
     
    
   

    

     

    
    

     

      if __name__ == 
      '__main__':
     
    
   

    

     

    
    

     

          unittest.main(verbosity=
      2)
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     
 
     
    
  

lib库 getNewID.py：

  

   

    

     

    
    

     

      def getNewID():
     
    
   

    

     

    
    

     
    
      '''获取最新的（最大的）发布会编号id'''
     
    
   

    

     

    
    

     
    
      import sqlite3
     
    
   

    

     

    
    

     

          con=sqlite3.connect(
      r'D:\backup\guest2-master\db.sqlite3')
     
    
   

    

     

    
    

     

          cur=con.cursor()
     
    
   

    

     

    
    

     

          cur.execute(
      "select max(id) from sign_event")
     
    
   

    

     

    
    

     

          new_id=cur.fetchone()
     
    
   

    

     

    
    

     

          new_id=new_id[
      0]
     
    
   

    

     

    
    

     

          cur.close()
     
    
   

    

     

    
    

     

          con.close()
     
    
   

    

     

    
    

     
    
      return new_id
     
    
  

lib库 addEventDataTemplate.py：

  

   

    

     

    
    

     

      import datetime
     
    
   

    

     

    
    

     

      def getEventData(id):
     
    
   

    

     

    
    

     
    
      '''添加发布会 body模板'''
     
    
   

    

     

    
    

     

          startTime=(datetime.datetime.now()+datetime.timedelta(days=
      30)).strftime(
      "%Y-%m-%d %H:%M:00")  
      #获得当前时间，并往后30天为发布会时间
     
    
   

    

     

    
    

     
 
     
    
   

    

     

    
    

     

          data={
     
    
   

    

     

    
    

     
          
      'eid':id+
      1,
     
    
   

    

     

    
    

     
          
      'name':
      f"发布会测试标题{id+1}",  
      #当前发布会编号加1
     
    
   

    

     

    
    

     
          
      'limit':
      100,    
      #默认值
     
    
   

    

     

    
    

     
          
      'status':
      1,    
      #默认值
     
    
   

    

     

    
    

     
          
      'address':
      '新街口金鹰',    
      #默认值
     
    
   

    

     

    
    

     
          
      'start_time':startTime  
      #%格式 Y-%m-%d %H:%M:00
     
    
   

    

     

    
    

     

              }
     
    
   

    

     

    
    

     
    
      return data
     
    
  

由于篇幅的原因，其它的代码省略。

总结：在写代码的过程中，每个测试用例的代码逻辑非常重要，不管是什么逻辑，得保证每个测试用例代码都可以独立运行，不会产生耦合。还有在测试接口的时候，经常与数据库打交道，比如获取数据，判断测试结果等。