Python+unittest+requests接口自动化测试框架搭建教程

import flask
import json
from flask import request

'''
flask： web框架，通过flask提供的装饰器@server.route()将普通函数转换为服
'''
# 创建一个服务，把当前这个python文件当做一个服务
server = flask.Flask(__name__)
# @server.route()可以将普通函数转变为服务 登录接口的路径、请求方式
@server.route('/login', methods=['get', 'post'])
def login():
 # 获取通过url请求传参的数据
 username = request.values.get('name')
 # 获取url请求传的密码，明文
 pwd = request.values.get('pwd')
 # 判断用户名、密码都不为空
 if username and pwd:
  if username == 'xiaoming' and pwd == '111':
   resu = {'code': 200, 'message': '登录成功'}
   return json.dumps(resu, ensure_ascii=False) # 将字典转换字符串
  else:
   resu = {'code': -1, 'message': '账号密码错误'}
   return json.dumps(resu, ensure_ascii=False)
 else:
  resu = {'code': 10001, 'message': '参数不能为空！'}
  return json.dumps(resu, ensure_ascii=False)

if __name__ == '__main__':
 server.run(debug=True, port=8888, host='127.0.0.1')

# -*- coding: utf-8 -*-
[HTTP]
scheme = http
baseurl = 127.0.0.1
port = 8888
timeout = 10.0



[EMAIL]
on_off = on;
subject = 接口自动化测试报告
app = Outlook
addressee = songxiaobao@qq.com
cc = zhaobenshan@qq.com

import os

def get_Path():
 path = os.path.split(os.path.realpath(__file__))[0]
 return path

if __name__ == '__main__':# 执行该文件，测试下是否OK
 print('测试路径是否OK,路径为：', get_Path())

import os
import configparser
import getpathInfo#引入我们自己的写的获取路径的类

path = getpathInfo.get_Path()#调用实例化，还记得这个类返回的路径为C:\Users\songlihui\PycharmProjects\dkxinterfaceTest
config_path = os.path.join(path, 'config.ini')#这句话是在path路径下再加一级，最后变成C:\Users\songlihui\PycharmProjects\dkxinterfaceTest\config.ini
cOnfig= configparser.ConfigParser()#调用外部的读取配置文件的方法
config.read(config_path, encoding='utf-8')

class ReadConfig():

 def get_http(self, name):
  value = config.get('HTTP', name)
  return value
 def get_email(self, name):
  value = config.get('EMAIL', name)
  return value
 def get_mysql(self, name):#写好，留以后备用。但是因为我们没有对数据库的操作，所以这个可以屏蔽掉
  value = config.get('DATABASE', name)
  return value


if __name__ == '__main__':#测试一下，我们读取配置文件的方法是否可用
 print('HTTP中的baseurl值为：', ReadConfig().get_http('baseurl'))
 print('EMAIL中的开关on_off值为：', ReadConfig().get_email('on_off'))

import os
import getpathInfo# 自己定义的内部类，该类返回项目的绝对路径
#调用读Excel的第三方库xlrd
from xlrd import open_workbook
# 拿到该项目所在的绝对路径
path = getpathInfo.get_Path()

class readExcel():
 def get_xls(self, xls_name, sheet_name):# xls_name填写用例的Excel名称 sheet_name该Excel的sheet名称
  cls = []
  # 获取用例文件路径
  xlsPath = os.path.join(path, "testFile", 'case', xls_name)
  file = open_workbook(xlsPath)# 打开用例Excel
  sheet = file.sheet_by_name(sheet_name)#获得打开Excel的sheet
  # 获取这个sheet内容行数
  nrows = sheet.nrows
  for i in range(nrows):#根据行数做循环
   if sheet.row_values(i)[0] != u'case_name':#如果这个Excel的这个sheet的第i行的第一列不等于case_name那么我们把这行的数据添加到cls[]
    cls.append(sheet.row_values(i))
  return cls
if __name__ == '__main__':#我们执行该文件测试一下是否可以正确获取Excel中的值
 print(readExcel().get_xls('userCase.xlsx', 'login'))
 print(readExcel().get_xls('userCase.xlsx', 'login')[0][1])
 print(readExcel().get_xls('userCase.xlsx', 'login')[1][2])

import requests
import json


class RunMain():

 def send_post(self, url, data): # 定义一个方法，传入需要的参数url和data
  # 参数必须按照url、data顺序传入
  result = requests.post(url=url, data=data).json() # 因为这里要封装post方法，所以这里的url和data值不能写死
  res = json.dumps(result, ensure_ascii=False, sort_keys=True, indent=2)
  return res

 def send_get(self, url, data):
  result = requests.get(url=url, params=data).json()
  res = json.dumps(result, ensure_ascii=False, sort_keys=True, indent=2)
  return res

 def run_main(self, method, url=None, data=None): # 定义一个run_main函数，通过传过来的method来进行不同的get或post请求
  result = None
  if method == 'post':
   result = self.send_post(url, data)
  elif method == 'get':
   result = self.send_get(url, data)
  else:
   print("method值错误！！！")
  return result


if __name__ == '__main__': # 通过写死参数，来验证我们写的请求是否正确
 result1 = RunMain().run_main('post', 'http://127.0.0.1:8888/login', {'name': 'xiaoming','pwd':'111'})
 result2 = RunMain().run_main('get', 'http://127.0.0.1:8888/login', 'name=xiaoming&pwd=111')
 print(result1)
 print(result2)

import readConfig as readConfig

readcOnfig= readConfig.ReadConfig()

class geturlParams():# 定义一个方法，将从配置文件中读取的进行拼接
 def get_Url(self):
  new_url = readconfig.get_http('scheme') + '://' + readconfig.get_http('baseurl') + ':8888' + '/login' + '&＃63;'
  #logger.info('new_url'+new_url)
  return new_url

if __name__ == '__main__':# 验证拼接后的正确性
 print(geturlParams().get_Url())

import json
import unittest
from common.configHttp import RunMain
import paramunittest
import geturlParams
import urllib.parse
# import pythoncom
import readExcel
# pythoncom.CoInitialize()

url = geturlParams.geturlParams().get_Url()# 调用我们的geturlParams获取我们拼接的URL
login_xls = readExcel.readExcel().get_xls('userCase.xlsx', 'login')

@paramunittest.parametrized(*login_xls)
class testUserLogin(unittest.TestCase):
 def setParameters(self, case_name, path, query, method):
  """
  set params
  :param case_name:
  :param path
  :param query
  :param method
  :return:
  """
  self.case_name = str(case_name)
  self.path = str(path)
  self.query = str(query)
  self.method = str(method)

 def description(self):
  """
  test report description
  :return:
  """
  self.case_name

 def setUp(self):
  """

  :return:
  """
  print(self.case_name+"测试开始前准备")

 def test01case(self):
  self.checkResult()

 def tearDown(self):
  print("测试结束，输出log完结\n\n")

 def checkResult(self):# 断言
  """
  check test result
  :return:
  """
  url1 = "http://www.xxx.com/login&＃63;"
  new_url = url1 + self.query
  data1 = dict(urllib.parse.parse_qsl(urllib.parse.urlsplit(new_url).query))# 将一个完整的URL中的name=&pwd=转换为{'name':'xxx','pwd':'bbb'}
  info = RunMain().run_main(self.method, url, data1)# 根据Excel中的method调用run_main来进行requests请求，并拿到响应
  ss = json.loads(info)# 将响应转换为字典格式
  if self.case_name == 'login':# 如果case_name是login，说明合法，返回的code应该为200
   self.assertEqual(ss['code'], 200)
  if self.case_name == 'login_error':# 同上
   self.assertEqual(ss['code'], -1)
  if self.case_name == 'login_null':# 同上
   self.assertEqual(ss['code'], 10001)

# -*- coding: utf-8 -*-
"""
A TestRunner for use with the Python unit testing framework. It
generates a HTML report to show the result at a glance.
The simplest way to use this is to invoke its main method. E.g.
 import unittest
 import HTMLTestRunner
 ... define your tests ...
 if __name__ == '__main__':
  HTMLTestRunner.main()
For more customization options, instantiates a HTMLTestRunner object.
HTMLTestRunner is a counterpart to unittest's TextTestRunner. E.g.
 # output to a file
 fp = file('my_report.html', 'wb')
 runner = HTMLTestRunner.HTMLTestRunner(
    stream=fp,
    title='My unit test',
    description='This demonstrates the report output by HTMLTestRunner.'
    )
 # Use an external stylesheet.
 # See the Template_mixin class for more customizable options
 runner.STYLESHEET_TMPL = ''
 # run the test
 runner.run(my_test_suite)
------------------------------------------------------------------------
Copyright (c) 2004-2007, Wai Yip Tung
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
* Neither the name Wai Yip Tung nor the names of its contributors may be
 used to endorse or promote products derived from this software without
 specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""

# URL: http://tungwaiyip.info/software/HTMLTestRunner.html

__author__ = "Wai Yip Tung"
__version__ = "0.9.1"

"""
Change History
Version 0.9.1
* 用Echarts添加执行情况统计图 (灰蓝)
Version 0.9.0
* 改成Python 3.x (灰蓝)
Version 0.8.3
* 使用 Bootstrap稍加美化 (灰蓝)
* 改为中文 (灰蓝)
Version 0.8.2
* Show output inline instead of popup window (Viorel Lupu).
Version in 0.8.1
* Validated XHTML (Wolfgang Borgert).
* Added description of test classes and test cases.
Version in 0.8.0
* Define Template_mixin class for customization.
* Workaround a IE 6 bug that it does not treat  block as CDATA.
Version in 0.7.1
* Back port to Python 2.3 (Frank Horowitz).
* Fix missing scroll bars in detail log (Podi).
"""

# TODO: color stderr
# TODO: simplify Javascript using ,ore than 1 class in the class attribute&＃63;

import datetime
import sys
import io
import time
import unittest
from xml.sax import saxutils


# ------------------------------------------------------------------------
# The redirectors below are used to capture output during testing. Output
# sent to sys.stdout and sys.stderr are automatically captured. However
# in some cases sys.stdout is already cached before HTMLTestRunner is
# invoked (e.g. calling logging.basicConfig). In order to capture those
# output, use the redirectors for the cached stream.
#
# e.g.
# >>> logging.basicConfig(stream=HTMLTestRunner.stdout_redirector)
# >>>

class OutputRedirector(object):
 """ Wrapper to redirect stdout or stderr """

 def __init__(self, fp):
  self.fp = fp

 def write(self, s):
  self.fp.write(s)

 def writelines(self, lines):
  self.fp.writelines(lines)

 def flush(self):
  self.fp.flush()


stdout_redirector = OutputRedirector(sys.stdout)
stderr_redirector = OutputRedirector(sys.stderr)


# ----------------------------------------------------------------------
# Template


class Template_mixin(object):
 """
 Define a HTML template for report customerization and generation.
 Overall structure of an HTML report
 HTML
 +------------------------+
 |     |
 |     |
 |      |
 | STYLESHEET   |
 | +----------------+ |
 | |    | |
 | +----------------+ |
 |      |
 |     |
 |      |
 |     |
 |      |
 | HEADING    |
 | +----------------+ |
 | |    | |
 | +----------------+ |
 |      |
 | REPORT    |
 | +----------------+ |
 | |    | |
 | +----------------+ |
 |      |
 | ENDING    |
 | +----------------+ |
 | |    | |
 | +----------------+ |
 |      |
 |     |
 |     |
 +------------------------+
 """

 STATUS = {
  0: u'通过',
  1: u'失败',
  2: u'错误',
 }

 DEFAULT_TITLE = 'Unit Test Report'
 DEFAULT_DESCRIPTION = ''

 # ------------------------------------------------------------------------
 # HTML Template

 HTML_TMPL = r"""<&＃63;xml version="1.0" encoding="UTF-8"&＃63;>



 
 
 

 
 

import os
import common.HTMLTestRunner as HTMLTestRunner
import getpathInfo
import unittest
import readConfig
from common.configEmail import SendEmail
from apscheduler.schedulers.blocking import BlockingScheduler
import pythoncom
# import common.Log

send_mail = SendEmail(
  username='@163.com',
  passwd='',
  recv=[''],
  title='',
  cOntent='测试发送邮件',
  file=r'E:\test_record\v2.3.3\测试截图\调整样式.png',
  ssl=True,
 )
path = getpathInfo.get_Path()
report_path = os.path.join(path, 'result')
on_off = readConfig.ReadConfig().get_email('on_off')
# log = common.Log.logger

class AllTest:#定义一个类AllTest
 def __init__(self):#初始化一些参数和数据
  global resultPath
  resultPath = os.path.join(report_path, "report.html")#result/report.html
  self.caseListFile = os.path.join(path, "caselist.txt")#配置执行哪些测试文件的配置文件路径
  self.caseFile = os.path.join(path, "testCase")#真正的测试断言文件路径
  self.caseList = []

 def set_case_list(self):
  """
  读取caselist.txt文件中的用例名称，并添加到caselist元素组
  :return:
  """
  fb = open(self.caseListFile)
  for value in fb.readlines():
   data = str(value)
   if data != '' and not data.startswith("#"):# 如果data非空且不以#开头
    self.caseList.append(data.replace("\n", ""))#读取每行数据会将换行转换为\n，去掉每行数据中的\n
  fb.close()

 def set_case_suite(self):
  """

  :return:
  """
  self.set_case_list()#通过set_case_list()拿到caselist元素组
  test_suite = unittest.TestSuite()
  suite_module = []
  for case in self.caseList:#从caselist元素组中循环取出case
   case_name = case.split("/")[-1]#通过split函数来将aaa/bbb分割字符串，-1取后面，0取前面
   print(case_name+".py")#打印出取出来的名称
   #批量加载用例，第一个参数为用例存放路径，第一个参数为路径文件名
   discover = unittest.defaultTestLoader.discover(self.caseFile, pattern=case_name + '.py', top_level_dir=None)
   suite_module.append(discover)#将discover存入suite_module元素组
   print('suite_module:'+str(suite_module))
  if len(suite_module) > 0:#判断suite_module元素组是否存在元素
   for suite in suite_module:#如果存在，循环取出元素组内容，命名为suite
    for test_name in suite:#从discover中取出test_name，使用addTest添加到测试集
     test_suite.addTest(test_name)
  else:
   print('else:')
   return None
  return test_suite#返回测试集

 def run(self):
  """
  run test
  :return:
  """
  try:
   suit = self.set_case_suite()#调用set_case_suite获取test_suite
   print('try')
   print(str(suit))
   if suit is not None:#判断test_suite是否为空
    print('if-suit')
    fp = open(resultPath, 'wb')#打开result/20181108/report.html测试报告文件，如果不存在就创建
    #调用HTMLTestRunner
    runner = HTMLTestRunner.HTMLTestRunner(stream=fp, title='Test Report', description='Test Description')
    runner.run(suit)
   else:
    print("Have no case to test.")
  except Exception as ex:
   print(str(ex))
   #log.info(str(ex))

  finally:
   print("*********TEST END*********")
   #log.info("*********TEST END*********")
   fp.close()
  #判断邮件发送的开关
  if on_off == 'on':
   send_mail.send_email()
  else:
   print("邮件发送开关配置关闭，请打开开关后可正常自动发送测试报告")
# pythoncom.CoInitialize()
# scheduler = BlockingScheduler()
# scheduler.add_job(AllTest().run, 'cron', day_of_week='1-5', hour=14, minute=59)
# scheduler.start()

if __name__ == '__main__':
 AllTest().run()

import os
import logging
from logging.handlers import TimedRotatingFileHandler
import getpathInfo

path = getpathInfo.get_Path()
log_path = os.path.join(path, 'result') # 存放log文件的路径


class Logger(object):
 def __init__(self, logger_name='logs…'):
  self.logger = logging.getLogger(logger_name)
  logging.root.setLevel(logging.NOTSET)
  self.log_file_name = 'logs' # 日志文件的名称
  self.backup_count = 5 # 最多存放日志的数量
  # 日志输出级别
  self.console_output_level = 'WARNING'
  self.file_output_level = 'DEBUG'
  # 日志输出格式
  self.formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

 def get_logger(self):
  """在logger中添加日志句柄并返回，如果logger已有句柄，则直接返回"""
  if not self.logger.handlers: # 避免重复日志
   console_handler = logging.StreamHandler()
   console_handler.setFormatter(self.formatter)
   console_handler.setLevel(self.console_output_level)
   self.logger.addHandler(console_handler)

   # 每天重新创建一个日志文件，最多保留backup_count份
   file_handler = TimedRotatingFileHandler(filename=os.path.join(log_path, self.log_file_name), when='D',
             interval=1, backupCount=self.backup_count, delay=True,
             encoding='utf-8')
   file_handler.setFormatter(self.formatter)
   file_handler.setLevel(self.file_output_level)
   self.logger.addHandler(file_handler)
  return self.logger


logger = Logger().get_logger()