深度解析python自动化框架(unnitest+selenium+htmlreport)
- 高洛峰原创
- 2017-03-24 15:34:103101浏览
1.最基本的错误截图要能提供吧。
2.要是能提供出错页加载的接口信息该多好！（这个是我正在思考的问题）
3.如果可以的话，在自动化录制过程中，能全程录制，这样也利于跟踪bug（这个应该比较容易实现，毕业屏幕录制软件不少，可能需要一个脚本动态启动他们，结束关闭他们。）
在这里我顺便扯一句，可能有的公司认为自动化测试没什么价值，原因：自动化测试根本发现不了什么太多的bug。但是，我的想法是：
一、自动化测试核心不是发现多少bug，而是能确保你的项目主流程么有bug，能正常上线!如果自动化都能发现N个bug，手动人员都不需要测试的了！
二、.理论上讲自动化能覆盖所有手动测试的流程，但是你给自动化投入了多少，靠1到2个人？还更不上迭代的进度！
三、对于我们自动化人员自身而言，也要提高自己，你的价值一定不是只写写脚本，比如搭建环境的能力，搭建web框架的能力，开发桌面应用程序的能力，这些东西都能给手动测试提供便利，也是你的存在感最直接的体现！
回到正题吧，下面讲讲我的思路吧，我的想法如下：
1.因为测试的是流程，前面的test有问题后面的test我要跳过，执行也没有意思，但是报告中要体现！
2.如果出错我要能提供准确的截图。
3.我改写的unnitest要尽量方便，不要在写case上搞一堆的try....except,既不美观，也一直在写相同的代码。根据代码重构的思想，如果你一直在复制黏贴代码，你的代码一定是可以重构的！
我这里继承了unnitest.TestCase类，上篇随便我说过，unnitest就是TestCase的run方法与TestResult的游戏，那么我们就这样想，在执行run的时候如果判断为AssertError或者WebDriverException我们认为是fail，fail就自动截图(前提能拿到webdriver实例)；如果是其他的错误我们认为是error。注意fail和error是不同的 ，fail一般是bug(除非你不小心写错代码，导致控件找不到)，error是除了以上2中异常的错误，多半是运行错误不太可能是bug。多半是你自己的代码写法有问题。贴出代码如下：
#coding=utf-8
import unittest
import sys
from selenium.common import exceptions
from selenium import webdriver
class SkipTest(Exception):
"""
Raise this exception in a test to skip it.
Usually you can use TestCase.skipTest() or one of the skipping decorators
instead of raising this directly.
"""
pass
class _ExpectedFailure(Exception):
"""
Raise this when a test is expected to fail.
This is an implementation detail.
"""
def __init__(self, exc_info):
super(_ExpectedFailure, self).__init__()
self.exc_info = exc_info
class IqunxingTest(unittest.TestCase):
__screenshot_path ="C:\screenshot"#拿不到截图路径默认路径
def run(self, result=None):
orig_result = result
if result is None:
result = self.defaultTestResult()
startTestRun = getattr(result, 'startTestRun', None)
if startTestRun is not None:
startTestRun()
self._resultForDoCleanups = result
screenshot_path=getattr(result,"screenshot_path",False)#尝试从result哪里拿到截图目录
if not screenshot_path:
screenshot_path=self.__screenshot_path
result.startTest(self)
testMethod = getattr(self, self._testMethodName)
if (getattr(self.__class__, "__unittest_skip__", False) or
getattr(testMethod, "__unittest_skip__", False)):
# If the class or method was skipped.
try:
skip_why = (getattr(self.__class__, '__unittest_skip_why__', '')
or getattr(testMethod, '__unittest_skip_why__', ''))
self._addSkip(result, skip_why)
finally:
result.stopTest(self)
return
try:
success = False
try:
self.setUp()
except SkipTest as e:
self._addSkip(result, str(e))
except KeyboardInterrupt:
raise
except:
result.addError(self, sys.exc_info())#启动setUp失败直接判断出错
else:
try:
testMethod()
except KeyboardInterrupt:
raise
except (self.failureException,exceptions.WebDriverException):#如果是断言错误或WebDriverException,类型为fail,且增加截图
#增加截图
browser=self.getbrowser()#尝试拿浏览器实例
if browser:
filename=self.__class__.__name__+"_"+self._testMethodName+".png"#格式:类名+方面名称
browser.get_screenshot_as_file(screenshot_path+"\\"+filename)
reback_filename=filename
else:
reback_filename=None
result.addFailure(self, sys.exc_info(),reback_filename)#回传截图名称给report,以便能显示在报告中
except SkipTest as e:#如果为跳过的异常，类型为Skip异常
self._addSkip(result, str(e))
except:#其他类型错误全部为error
result.addError(self, sys.exc_info())
else:
success = True
try:
self.tearDown()
except KeyboardInterrupt:
raise
except:
result.addError(self, sys.exc_info())
success = False
cleanUpSuccess = self.doCleanups()
success = success and cleanUpSuccess
if success:
result.addSuccess(self)
finally:
result.stopTest(self)
if orig_result is None:
stopTestRun = getattr(result, 'stopTestRun', None)
if stopTestRun is not None:
stopTestRun()
def getbrowser(self):
#首先从类属性里面找webdriver实例
for value in self.__class__.__dict__.itervalues():
if isinstance(value,webdriver.Firefox):#如果value是webdriver.Firefox实例
return value
#再从实例属性里面找
for value in self.__dict__.itervalues():
if isinstance(value, webdriver.Firefox): # 如果value是webdriver.Firefox实例
return value
#实在找不到返回None
return None代码很简单，可能也有一些么有考虑到的bug，不过思路就是这样！下面贴出我的单元测试代码的demo:
#coding=utf-8
import IqunxingTest
import HTMLTestRunner
import sys,os
import unittest
from selenium import webdriver
class Mydemo(IqunxingTest.IqunxingTest):
u'''测试百度'''
@classmethod
def setUpClass(cls):
cls.browser=webdriver.Firefox()
@unittest.Myskip
def test1(self):
u'''打开百度'''
browser=self.browser
browser.get("http://www.baidu.com")
@unittest.Myskip
def test2(self):
u'''输入框输入selenium'''
browser = self.browser
browser.find_element_by_id("kw").send_keys("selenium")
@unittest.Myskip
def test3(self):
u'''点击百度一下'''
browser = self.browser
browser.find_element_by_id("su1").click()
if __name__ == '__main__':
module_name=os.path.basename(sys.argv[0]).split(".")[0]
module=__import__(module_name)
runner=HTMLTestRunner.HTMLTestRunner("new.html")
all_suite=unittest.defaultTestLoader.loadTestsFromModule(module)
runner.run(all_suite)注意：由于我们要在报告中显示文档属性，而我们的case使用了装饰器unittest.Myskip，所以我们修改上篇中使用到的Myskip(我的问题，以前没发现点)增加@wraps(func)即可完整代码如下：
from functools import wraps
def Myskip(func):
@wraps(func)
def RebackTest(self):
if self._resultForDoCleanups.failures or self._resultForDoCleanups.errors:
raise unittest.SkipTest("{} do not excute because {} is failed".format(func.__name__,self._resultForDoCleanups.failures[0][0]._testMethodName))
func(self)
return RebackTest
其实上面的testcase还是挺简洁的，我们把工作放在我们的IqunxingTest的run方法里面,当执行test时，AssertError与WebDriverException错误时，自动截图，当然是找到浏览器的实例对象，找不到就不截图了，回传给result也是None，与普通的单元测试无异。
HTMLTestRunner的完整代码如下：（这个代码太长了，实在不想写出该了什么完整贴出来吧！）
#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 = '<link rel="stylesheet" href="my_stylesheet.css" type="text/css">'
# 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.8.2"
"""
Change History
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 <script> 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?
#coding=utf-8
import datetime
import io
import sys
import os
reload(sys)
sys.setdefaultencoding('utf8')
import time
import unittest
import re
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)
# >>>
pattren=re.compile(r"(.*)reback_filename:(.*)",re.S)
screenshot_dir_name="screen_shot"
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
+------------------------+
|<html> |
| <head> |
| |
| STYLESHEET |
| +----------------+ |
| | | |
| +----------------+ |
| |
| </head> |
| |
| <body> |
| |
| HEADING |
| +----------------+ |
| | | |
| +----------------+ |
| |
| REPORT |
| +----------------+ |
| | | |
| +----------------+ |
| |
| ENDING |
| +----------------+ |
| | | |
| +----------------+ |
| |
| </body> |
|</html> |
+------------------------+
"""
STATUS = {
0: 'pass',
1: 'fail',
2: 'error',
3:'skip'
}
DEFAULT_TITLE = 'Unit Test Report'
DEFAULT_DESCRIPTION = ''
# ------------------------------------------------------------------------
# HTML Template
HTML_TMPL = r"""<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>%(title)s</title>
<meta name="generator" content="%(generator)s"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
%(stylesheet)s
</head>
<body>
<script language="javascript" type="text/javascript"><!--
output_list = Array();
/* level - 0:Summary; 1:Failed; 2:All */
function showCase(level) {
trs = document.getElementsByTagName("tr");
for (var i = 0; i < trs.length; i++) {
tr = trs[i];
id = tr.id;
if (id.substr(0,2) == 'ft') {
if (level < 1) {
tr.className = 'hiddenRow';
}
else {
tr.className = '';
}
}
if (id.substr(0,2) == 'pt') {
if (level > 1) {
tr.className = '';
}
else {
tr.className = 'hiddenRow';
}
}
if (id.substr(0,2) == 'st') {
if (level > 1) {
tr.className = '';
}
else {
tr.className = 'hiddenRow';
}
}
}
}
function showClassDetail(cid, count) {
var id_list = Array(count);
var toHide = 1;
for (var i = 0; i < count; i++) {
tid0 = 't' + cid.substr(1) + '.' + (i+1);
tid = 'f' + tid0;
tr = document.getElementById(tid);
if (!tr) {
tid = 'p' + tid0;
tr = document.getElementById(tid);
}
if (!tr) {
tid = 's' + tid0;
tr = document.getElementById(tid);
}
id_list[i] = tid;
if (tr.className) {
toHide = 0;
}
}
for (var i = 0; i < count; i++) {
tid = id_list[i];
if (toHide) {
document.getElementById('p_'+tid).style.display = 'none'
document.getElementById(tid).className = 'hiddenRow';
}
else {
document.getElementById(tid).className = '';
}
}
}
function showTestDetail(p_id){
var details_p = document.getElementById(p_id)
var displayState = details_p.style.display
// alert(displayState)
if (displayState != 'block' ) {
displayState = 'block'
details_p.style.display = 'block'
}
else {
details_p.style.display = 'none'
}
}
function html_escape(s) {
s = s.replace(/&/g,'&');
s = s.replace(/</g,'<');
s = s.replace(/>/g,'>');
return s;
}
/* obsoleted by detail in <p>
function showOutput(id, name) {
var w = window.open("", //url
name,
"resizable,scrollbars,status,width=800,height=450");
d = w.document;
d.write("<pre class="brush:php;toolbar:false">");
d.write(html_escape(output_list[id]));
d.write("\n");
d.write("<a href='javascript:window.close()'>close</a>\n");
d.write("\n");
d.close();
}
*/
-->
%(heading)s
%(report)s
%(ending)s