python+requests实现的接口自动化测试

点击文末小卡片免费获取软件测试全套资料资料在手涨薪更快框架详细教程前段时间由于公司测试方向的转型由原来的web页面功能测试转变成接口测试之前大多都是手工进行利用postman和jmeter进行的接口测试后来组内有人讲原先web自动化的测试框架移驾成接口的自动化框架使用的是java语言但对于一个学java却在学python的我来说觉得python比起java更简单些所以我决定自己写python的接口自动化测试框架由于本人也是刚学习python这套自动化框架目前已经基本完成了于是进行一些总结便于以后回顾温习有许多不完善的地方也遇到了许多的问题希望大神们多多指教。下面我就进行今天的主要内容吧。初学者的成功之路哈哈哈~~1、首先我们先来理一下思路。正常的接口测试流程是什么脑海里的反应是不是这样的确定测试接口的工具 — 配置需要的接口参数 — 进行测试 — 检查测试结果有的需要数据库辅助 — 生成测试报告html报告那么我们就根据这样的过程来一步步搭建我们的框架。在这个过程中我们需要做到业务和数据的分离这样才能灵活达到我们写框架的目的。只要好好做一定可以成功。这也是我当初对自己说的。接下来我们来进行结构的划分。我的结构是这样的大家可以参考下​​​​​​ common存放一些共通的方法result执行过程中生成的文件夹里面存放每次测试的结果testCase用于存放具体的测试casetestFile存放测试过程中用到的文件包括上传的文件测试用例以及 数据库的sql语句caselisttxt文件配置每次执行的case名称config配置一些常量例如数据库的相关信息接口的相关信息等readConfig 用于读取config配置文件中的内容runAll用于执行case既然整体结构有了划分接下来就该一步步的填充整个框架了首先我们先来看看config.ini和readConfig.py两个文件从他们入手个人觉得比较容易走下去哒。我们来看下文件的内容是什么样子的[DATABASE] host 50.23.190.57 username xxxxxx password ****** port 3306 database databasename [HTTP] # 接口的url baseurl http://xx.xxxx.xx port 8080 timeout 1.0 [EMAIL] mail_host smtp.163.com mail_user xxx163.com mail_pass ********* mail_port 25 sender xxx163.com receiver xxxxqq.com/xxxxqq.com subject python content All interface test has been complited\nplease read the report file about the detile of result in the attachment. testuser Someone on_off 1相信大家都知道这样的配置文件没错所有一成不变的东西我们都可以放到这里来。哈哈怎么样不错吧。现在我们已经做好了固定的“仓库”。来保存我们平时不动的东西那么我们要怎么把它拿出来为我所用呢这时候readConfig.py文件出世了它成功的帮我们解决了这个问题下面就让我们来一睹它的庐山真面目吧。import os import codecs import configparser proDir os.path.split(os.path.realpath(__file__))[0] configPath os.path.join(proDir, config.ini) class ReadConfig: def __init__(self): fd open(configPath) data fd.read() # remove BOM if data[:3] codecs.BOM_UTF8: data data[3:] file codecs.open(configPath, w) file.write(data) file.close() fd.close() self.cf configparser.ConfigParser() self.cf.read(configPath) def get_email(self, name): value self.cf.get(EMAIL, name) return value def get_http(self, name): value self.cf.get(HTTP, name) return value def get_db(self, name): value self.cf.get(DATABASE, name) return value怎么样是不是看着很简单啊我们定义的方法根据名称取对应的值是不是so easy当然了这里我们只用到了get方法还有其他的例如set方法有兴趣的同学可以自己去探索下。话不多说我们先来看下common到底有哪些东西。既然配置文件和读取配置文件我们都已经完成了也看到了common里的内容接下来就可以写common里的共通方法了从哪个下手呢今天我们就来翻“Log.py”的牌吧因为它是比较独立的我们单独跟他打交道也为了以后它能为我们服务打下良好基础。这里呢我想跟大家多说两句对于这个log文件呢我给它单独启用了一个线程这样在整个运行过程中我们在写log的时候也会比较方便看名字大家也知道了这里就是我们对输出的日志的所有操作了主要是对输出格式的规定输出等级的定义以及其他一些输出的定义等等。总之你想对log做的任何事情都可以放到这里来。我们来看下代码没有比这个更直接有效的了。import logging from datetime import datetime import threading首先我们要像上面那样引入需要的模块才能进行接下来的操作。class Log: def __init__(self): global logPath, resultPath, proDir proDir readConfig.proDir resultPath os.path.join(proDir, result) # create result file if it doesnt exist if not os.path.exists(resultPath): os.mkdir(resultPath) # defined test result file name by localtime logPath os.path.join(resultPath, str(datetime.now().strftime(%Y%m%d%H%M%S))) # create test result file if it doesnt exist if not os.path.exists(logPath): os.mkdir(logPath) # defined logger self.logger logging.getLogger() # defined log level self.logger.setLevel(logging.INFO) # defined handler handler logging.FileHandler(os.path.join(logPath, output.log)) # defined formatter formatter logging.Formatter(%(asctime)s - %(name)s - %(levelname)s - %(message)s) # defined formatter handler.setFormatter(formatter) # add handler self.logger.addHandler(handler)现在我们创建了上面的Log类在__init__初始化方法中我们进行了log的相关初始化操作。具体的操作内容注释已经写得很清楚了英文有点儿差大家看得懂就行嘿嘿……这样log的基本格式已经定义完成了至于其他的方法就靠大家自己发挥了毕竟每个人的需求也不同我们就只写普遍的共用方法啦。接下来就是把它放进一个线程内了请看下面的代码class MyLog: log None mutex threading.Lock() def __init__(self): pass staticmethod def get_log(): if MyLog.log is None: MyLog.mutex.acquire() MyLog.log Log() MyLog.mutex.release() return MyLog.log看起来是不是没有想象中的那样复杂啊哈哈哈就是这样简单python比java简单了许多这也是我为什么选择它的原因虽然小编我也是刚刚学习还有很多不懂的地方。下面我们继续搭建这次要做的是configHttp.py的内容。没错我们开始配置接口文件啦终于写到接口了是不是很开心啊~下面是接口文件中主要部分的内容让我们一起来看看吧。import requests import readConfig as readConfig from common.Log import MyLog as Log localReadConfig readConfig.ReadConfig() class ConfigHttp: def __init__(self): global host, port, timeout host localReadConfig.get_http(baseurl) port localReadConfig.get_http(port) timeout localReadConfig.get_http(timeout) self.log Log.get_log() self.logger self.log.get_logger() self.headers {} self.params {} self.data {} self.url None self.files {} def set_url(self, url): self.url host url def set_headers(self, header): self.headers header def set_params(self, param): self.params param def set_data(self, data): self.data data def set_files(self, file): self.files file # defined http get method def get(self): try: response requests.get(self.url, paramsself.params, headersself.headers, timeoutfloat(timeout)) # response.raise_for_status() return response except TimeoutError: self.logger.error(Time out!) return None # defined http post method def post(self): try: response requests.post(self.url, headersself.headers, dataself.data, filesself.files, timeoutfloat(timeout)) # response.raise_for_status() return response except TimeoutError: self.logger.error(Time out!) return None这里我们就挑重点来说吧。首先可以看到小编这次是用python自带的requests来进行接口测试的相信有心的朋友已经看出来了pythonrequests这个模式是很好用的它已经帮我们封装好了测试接口的方法用起来很方便。这里呢我就拿get和post两个方法来说吧。平时用的最多的就是这两个方法了其他方法大家可以仿照着自行扩展get方法接口测试中见到最多的就是get方法和post方法其中get方法用于获取接口的测试说白了就是说使用get的接口都不会对后台数据进行更改而且get方法在传递参数后url的格式是这样的http://接口地址?key1value1key2value2是不是看起来很眼熟啊~反正我看着它很眼熟~\(≧▽≦)/~啦啦啦那我们要怎么使用它呢请继续往下看。对于requests提供的get方法有几个常用的参数url显而易见就是接口的地址url啦headers定制请求头headers例如content-type application/x-www-form-urlencodedparams用于传递测试接口所要用的参数这里我们用python中的字典形式keyvalue进行参数的传递。timeout设置接口连接的最大时间超过该时间会抛出超时错误现在各个参数我们已经知道是什么意思了剩下的就是往里面填值啦是不是机械式的应用啊哈哈小编我就是这样机械般的学习的啦~举个栗子url‘http://api.shein.com/v2/member/logout’ header{‘content-type’ application/x-www-form-urlencoded} param{‘user_id’ 123456,‘email’ 123456163.com} timeout0.5 requests.geturl, headersheader, paramsparam, timeouttimeoutpost方法与get方法类似只要设置好对应的参数就可以了。下面就直接举个栗子直接上代码吧url‘http://api.shein.com/v2/member/login’ header{‘content-type’ application/x-www-form-urlencoded} data{‘email’ 123456163.com,‘password’ 123456} timeout0.5 requests.posturl, headersheader, datadata, timeouttimeout怎么样是不是也很简单啊。这里我们需要说明一下post方法中的参数我们不在使用params进行传递而是改用data进行传递了。哈哈哈终于说完啦下面我们来探了讨解下接口的返回值。依然只说常用的返回值的操作。text获取接口返回值的文本格式json()获取接口返回值的json()格式status_code返回状态码成功为200headers返回完整的请求头信息headers[name]返回指定的headers内容encoding返回字符编码格式url返回接口的完整url地址以上这些就是常用的方法啦大家可自行取之。关于失败请求抛出异常我们可以使用“raise_for_status()”来完成那么当我们的请求发生错误时就会抛出异常。在这里提醒下各位朋友如果你的接口在地址不正确的时候会有相应的错误提示有时也需要进行测试这时千万不能使用这个方法来抛出错误因为python自己在链接接口时就已经把错误抛出那么后面你将无法测试期望的内容。而且程序会直接在这里当掉以错误来计。别问我怎么知道的因为我就是测试的时候发现的好了。接口文件也讲完了是不是感觉离成功不远了呢嗯如果各位已经看到了这里那么恭喜大家下面还有很长的路要走~哈哈哈就是这么任性。毕竟小编我为了让各位和我差不多的小白能够更容易理解也是使出了体内的洪荒之力啦慢慢地长叹一口气继续下面的内容。。。快我想学看习看common.py里的内容。import os from xlrd import open_workbook from xml.etree import ElementTree as ElementTree from common.Log import MyLog as Log localConfigHttp configHttp.ConfigHttp() log Log.get_log() logger log.get_logger() # 从excel文件中读取测试用例 def get_xls(xls_name, sheet_name): cls [] # get xls files path xlsPath os.path.join(proDir, testFile, xls_name) # open xls file file open_workbook(xlsPath) # get sheet by name sheet file.sheet_by_name(sheet_name) # get one sheets rows nrows sheet.nrows for i in range(nrows): if sheet.row_values(i)[0] ! ucase_name: cls.append(sheet.row_values(i)) return cls # 从xml文件中读取sql语句 database {} def set_xml(): if len(database) 0: sql_path os.path.join(proDir, testFile, SQL.xml) tree ElementTree.parse(sql_path) for db in tree.findall(database): db_name db.get(name) # print(db_name) table {} for tb in db.getchildren(): table_name tb.get(name) # print(table_name) sql {} for data in tb.getchildren(): sql_id data.get(id) # print(sql_id) sql[sql_id] data.text table[table_name] sql database[db_name] table def get_xml_dict(database_name, table_name): set_xml() database_dict database.get(database_name).get(table_name) return database_dict def get_sql(database_name, table_name, sql_id): db get_xml_dict(database_name, table_name) sql db.get(sql_id) return sql上面就是我们common的两大主要内容了什么还不知道是什么吗让我告诉你吧。我们利用xml.etree.Element来对xml文件进行操作然后通过我们自定义的方法根据传递不同的参数取得不想同要的值。利用xlrd来操作excel文件注意啦我们是用excel文件来管理测试用例的。听起来会不会有点儿懵小编刚学时也很懵看文件就好理解了。excel文件xml文件至于具体的方法我就不再一点点讲解了总觉得大家都懂小编刚学望谅解只是我个人需要详细记录以后容易温习。接下来我们看看数据库和发送邮件吧也可根据需要不写该部分内容先看老朋友“数据库”吧。小编这次使用的是MySQL数据库所以我们就以它为例吧。import pymysql import readConfig as readConfig from common.Log import MyLog as Log localReadConfig readConfig.ReadConfig() class MyDB: global host, username, password, port, database, config host localReadConfig.get_db(host) username localReadConfig.get_db(username) password localReadConfig.get_db(password) port localReadConfig.get_db(port) database localReadConfig.get_db(database) config { host: str(host), user: username, passwd: password, port: int(port), db: database } def __init__(self): self.log Log.get_log() self.logger self.log.get_logger() self.db None self.cursor None def connectDB(self): try: # connect to DB self.db pymysql.connect(**config) # create cursor self.cursor self.db.cursor() print(Connect DB successfully!) except ConnectionError as ex: self.logger.error(str(ex)) def executeSQL(self, sql, params): self.connectDB() # executing sql self.cursor.execute(sql, params) # executing by committing to DB self.db.commit() return self.cursor def get_all(self, cursor): value cursor.fetchall() return value def get_one(self, cursor): value cursor.fetchone() return value def closeDB(self): self.db.close() print(Database closed!)这就是完整的数据库的文件啦。因为小编的需求对数据库的操作不是很复杂所以这些已基本满足要求啦。注意下啦在此之前请朋友们先把pymysql装起来pymysql装起来pymysql装起来重要的事情说三遍安装的方法很简单由于小编是使用pip来管理python包安装的所以只要进入python安装路径下的pip文件夹下执行以下命令即可pip install pymysql哈哈哈这样我们就可以利用python链接数据库啦~鼓个掌庆祝下小伙伴们发现没在整个文件中我们并没有出现具体的变量值哦为什么呢没错因为前面我们写了config.ini文件所有的数据库配置信息都在这个文件内哦是不是感觉很方便呢以后就算变更数据库了也只要修改config.ini文件的内容就可以了结合前面测试用例的管理excel文件sql语句的存放xml文件还有接下来我们要说的businessCommon.py和存放具体case的文件夹那么我们就已经将数据和业务分开啦哈哈哈想想以后修改测试用例内容sql语句神马的工作再也不用每个case都修改只要改几个固定的文件是不是顿时开心了呢嗯想笑就大声的笑吧回归上面的configDB.py文件内容很简单相信大家都能看得懂就是连接数据库执行sql获取结果最后关闭数据库没有什么不一样的地方。该谈谈邮件啦你是不是也遇到过这样的问题每次测试完之后都需要给开发一份测试报告。那么对于我这样的懒人是不愿意老是找人家开发的所以我就想每次测试完我们可以让程序自己给开发人员发一封email告诉他们测试已经结束了并且把测试报告以附件的形式通过email发送给开发者的邮箱这样岂不是爽哉所以configEmail.py应运而生。当当当当……请看import os import smtplib from email.mime.multipart import MIMEMultipart from email.mime.text import MIMEText from datetime import datetime import threading import readConfig as readConfig from common.Log import MyLog import zipfile import glob localReadConfig readConfig.ReadConfig() class Email: def __init__(self): global host, user, password, port, sender, title, content host localReadConfig.get_email(mail_host) user localReadConfig.get_email(mail_user) password localReadConfig.get_email(mail_pass) port localReadConfig.get_email(mail_port) sender localReadConfig.get_email(sender) title localReadConfig.get_email(subject) content localReadConfig.get_email(content) self.value localReadConfig.get_email(receiver) self.receiver [] # get receiver list for n in str(self.value).split(/): self.receiver.append(n) # defined email subject date datetime.now().strftime(%Y-%m-%d %H:%M:%S) self.subject title date self.log MyLog.get_log() self.logger self.log.get_logger() self.msg MIMEMultipart(mixed) def config_header(self): self.msg[subject] self.subject self.msg[from] sender self.msg[to] ;.join(self.receiver) def config_content(self): content_plain MIMEText(content, plain, utf-8) self.msg.attach(content_plain) def config_file(self): # if the file content is not null, then config the email file if self.check_file(): reportpath self.log.get_result_path() zippath os.path.join(readConfig.proDir, result, test.zip) # zip file files glob.glob(reportpath \*) f zipfile.ZipFile(zippath, w, zipfile.ZIP_DEFLATED) for file in files: f.write(file) f.close() reportfile open(zippath, rb).read() filehtml MIMEText(reportfile, base64, utf-8) filehtml[Content-Type] application/octet-stream filehtml[Content-Disposition] attachment; filenametest.zip self.msg.attach(filehtml) def check_file(self): reportpath self.log.get_report_path() if os.path.isfile(reportpath) and not os.stat(reportpath) 0: return True else: return False def send_email(self): self.config_header() self.config_content() self.config_file() try: smtp smtplib.SMTP() smtp.connect(host) smtp.login(user, password) smtp.sendmail(sender, self.receiver, self.msg.as_string()) smtp.quit() self.logger.info(The test report has send to developer by email.) except Exception as ex: self.logger.error(str(ex)) class MyEmail: email None mutex threading.Lock() def __init__(self): pass staticmethod def get_email(): if MyEmail.email is None: MyEmail.mutex.acquire() MyEmail.email Email() MyEmail.mutex.release() return MyEmail.email if __name__ __main__: email MyEmail.get_email()这里就是完整的文件内容了不过可惜的是小编我遇到一个问题至今未解在这里提出希望大神给出解决办法跪求啦问题使用163免费邮箱服务器进行邮件的发送但是每次发送邮件都会被163邮件服务器退信抛出的错误码是554官方说明如下但是howeverbut……小编在整合email进本框架之前写的发送email的小demo是可以正常发送邮件的。这个问题困扰着我目前仍没有解决望大神赐教。离成功不远了简单说明下HTMLTestRunner.py文件这个文件呢也不是小编写的小编只是它的搬运工哈哈哈这个文件是从网上下载的大神写好的用于生成html格式的测试报告什么想知道生成测试报告的样子好这就满足好奇的你看上去不错吧嗯聪明的你们也可以自己去探索下这个文件修改修改变成你自己的style好了重头戏来了就是我们的runAll.py啦。请看主角登场。这是我们整个框架运行的入口上面内容完成后这是最后一步啦写完它我们的框架就算是完成了。鼓掌撒花~import unittest import HTMLTestRunner def set_case_list(self): fb open(self.caseListFile) for value in fb.readlines(): data str(value) if data ! and not data.startswith(#): self.caseList.append(data.replace(\n, )) fb.close() def set_case_suite(self): self.set_case_list() test_suite unittest.TestSuite() suite_model [] for case in self.caseList: case_file os.path.join(readConfig.proDir, testCase) print(case_file) case_name case.split(/)[-1] print(case_name.py) discover unittest.defaultTestLoader.discover(case_file, patterncase_name .py, top_level_dirNone) suite_model.append(discover) if len(suite_model) 0: for suite in suite_model: for test_name in suite: test_suite.addTest(test_name) else: return None return test_suite def run(self): try: suit self.set_case_suite() if suit is not None: logger.info(********TEST START********) fp open(resultPath, wb) runner HTMLTestRunner.HTMLTestRunner(streamfp, titleTest Report, descriptionTest Description) runner.run(suit) else: logger.info(Have no case to test.) except Exception as ex: logger.error(str(ex)) finally: logger.info(*********TEST END*********) # send test report by email if int(on_off) 0: self.email.send_email() elif int(on_off) 1: logger.info(Doesnt send report email to developer.) else: logger.info(Unknow state.)上面我贴出了runAll里面的主要部分首先我们要从caselist.txt文件中读取需要执行的case名称然后将他们添加到python自带的unittest测试集中最后执行run()函数执行测试集。关于python的unittest需要学的内容还是很多的所以这里小编就不细讲了。终于呢整个接口自动化框架已经讲完了大家是不是看明白了呢什么之前的之前贴出的目录结构中的文件还有没说到的嘿嘿相信不用小编多说大家也大概知道了剩下文件夹的作用了。嗯~思索万千还是决定简单谈谈吧。直接上图简单明了result文件夹会在首次执行case时生成并且以后的测试结果都会被保存在该文件夹下同时每次测试的文件夹都是用系统时间命名里面包含了两个文件log文件和测试报告。testCase文件夹下存放我们写的具体的测试case啦上面这些就是小编写的一些。注意喽所有的case名称都要以test开头来命名哦这是因为unittest在进行测试时会自动匹配testCase文件夹下面所有test开头的.py文件testFile文件夹下放置我们测试时用来管理测试用例的excel文件和用于数据库查询的sql语句的xml文件哦。最后就是caselist.txt文件了就让你们瞄一眼吧凡是没有被注释掉的都是要被执行的case名称啦。在这里写上你要执行的case名称就可以啦。最后感谢每一个认真阅读我文章的人礼尚往来总是要有的虽然不是什么很值钱的东西如果你用得到的话可以直接拿走这些资料对于做【软件测试】的朋友来说应该是最全面最完整的备战仓库这个仓库也陪伴我走过了最艰难的路程希望也能帮助到你凡事要趁早特别是技术行业一定要提升技术功底。