python unittest自动化测试，生成测试报告，自动发邮件

项目进行自动化测试，采用python 的unittest架构进行。

架构代码如下：

lib

data

config

Report

.pyt

lib 为封装好的公共lib库，比如发送邮件、测试报告模板、访问数据库、hbase等

cofig为生成的公共配置

data 为测试数据集

Report 为生产报告结果目录

all_test.py 为执行用例入库

Test*.py为测试的具体用例

all_test.py 详解

通过discover 生成测试用例集合，调用报告，发送邮件

# coding=utf-8
import unittest
from lib import HTMLTestRunner
from lib import SendEmail
import time
from unittest import TestLoader

#用例目录
test_suite_dir=r'C:\Users\Administrator\PycharmProjects\OpenAPI_new\\'
#test_suite_dir=r'/opt/openapi/'  #145部署环境
#报告目录
Report_dir= r'C:\Users\Administrator\PycharmProjects\OpenAPI_new\Report\\'
#Report_dir=r'/opt/openapi/Report/'  #145部署环境
def creatsuite():
    testunit = unittest.TestSuite()
    # 定义测试文件查找的目录
    test_dir =test_suite_dir
    # 定义 discover 方法的参数
    package_tests = unittest.defaultTestLoader.discover(test_dir,
                                                   pattern='Test*.py',
                                                   top_level_dir=None)
    # package_tests=TestLoader.discover(start_dir=test_dir, pattern='Test*.py')
    # discover 方法筛选出来的用例，循环添加到测试套件中
    for test_suite in package_tests:
        for test_case in test_suite:
            testunit.addTests(test_case)
            print(testunit)
    return testunit

alltestnames = creatsuite()

if __name__ == "__main__":
    now = time.strftime("%Y-%m-%d %H_%M_%S")
    test_report =Report_dir
    filename = test_report + now + 'result.html'
    print filename
    fp = open(filename, 'wb')
    runner = HTMLTestRunner.HTMLTestRunner(
        stream=fp,
        title=u'OpenAPI测试报告',
        description=u'测试用例执行结果'
    )

    runner.run(alltestnames)
    fp.close()
    new_report = SendEmail.new_report(test_report)
    SendEmail.send_file(new_report)  # 发送测试报告

SendEmail.py 为发送邮件模板

# encoding=utf-8

from HTMLTestRunner import HTMLTestRunner
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart
from email.header import Header
from email.utils import parseaddr, formataddr
import smtplib
import unittest
import time
import os


def _format_addr(s):
    name, addr = parseaddr(s)
    return formataddr(( \
        Header(name, 'utf-8').encode(), \
        addr.encode('utf-8') if isinstance(addr, unicode) else addr))

## ==============定义发送附件邮件==========
def send_file(file_new):
    smtpserver='smtp.exmail.qq.com'
    user='***@***.com'
    password='***'
    sender='***'
    receiver=['[email protected]','[email protected]']
    # subject='**自动化测试报告'
    file=open(file_new,'r').read()

    now = time.strftime("%Y-%m-%d %H_%M_%S")
    subject = 'OpenAPI自动化测试报告--'+now
    # att=MIMEText(sendfile,"base64","utf-8")
    att =MIMEText(file, "html", "utf-8")
    att["Content-Type"]="application/octet-stream"
    att["ContenT-Disposition"]="attachment;filename = 'OpenAPI自动化测试报告.html '"

    msgRoot=MIMEMultipart('related')
    msgRoot['Subject']=subject
    msgRoot['From'] = _format_addr(u'**测试组 <%s>' % sender)
    msgRoot['To'] = _format_addr(u'OpenAPI项目组 <%s>' % receiver)
    # msgRoot.attach(att)
    msgRoot.attach(att)

    smtp=smtplib.SMTP()
    smtp.connect(smtpserver)
    smtp.login(user,password)
    smtp.sendmail(sender,receiver,msgRoot.as_string())
    smtp.quit()


# ======查找测试目录，找到最新生成的测试报告文件======
def new_report(test_report):
    lists = os.listdir(test_report)  # 列出目录的下所有文件和文件夹保存到lists
    # lists.sort(key=lambda fn: os.path.getmtime(test_report + "\\" + fn))  # 按时间排序 win
    lists.sort(key=lambda fn: os.path.getmtime(test_report + "/" + fn)) #linux
    file_new = os.path.join(test_report, lists[-1])  # 获取最新的文件保存到file_new
    print(file_new)
    return file_new

# if __name__ == "__main__":
#
#     send_file( r'C:\Users\Administrator\PycharmProjects\OpenAPI_new\Report\2017-10-26 20_08_07result.html')

Test001_Authenticate.py 具体用例

# encoding=utf-8
import time
import unittest
import urllib, urllib2, httplib
import requests
from lib import HTMLTestRunner
import json
from poster.streaminghttp import register_openers

'''authenticate'''

# 鉴权认证模块
class Test001_Authenticate(unittest.TestCase):
    def setUp(self):
        # 预设环境信息
        self.app_key = '**'
        self.scope = 'scope'
        self.redirect_uri = 'redirect_uri'
        self.app_secret = "**"
        self.grant_type = 'authorization_code'
        self.access_token_url = 'http://**/oauth2/access_token'
        self.refresh_token_url = "http://**/oauth2/refresh_token"
        self.url= "http:/***/oauth2/authorize"

    def tearDown(self):
        # 清理环境信息
        pass

    # GET方法获取令牌access_token
    # @unittest.skip('')
    def test_001_get_access_token(self):
        url = self.access_token_url
        params = urllib.urlencode(
            {'app_key': self.app_key, 'app_secret': self.app_secret, 'grant_type': self.grant_type})
        response = requests.get(url, params=params)
        print response.status_code, response.text
        data=response.json()
        access_token = data["access_token"]
        self.assertIsNotNone(data["access_token"],"get access_token ok ")
        self.assertEqual(response.status_code, 200, 'status_code is not 200,error')


        # POST方法获取令牌access_token
    # @unittest.skip('')
    def test_002_post_access_token(self):
        url = self.access_token_url
        params = urllib.urlencode(
            {'app_key': self.app_key, 'app_secret': self.app_secret, 'grant_type': self.grant_type})
        response = requests.post(url, params=params)
        print response.status_code, response.text
        data=response.json()
        access_token = data["access_token"]
        self.assertIsNotNone(data["access_token"],"get access_token ok ")
        self.assertEqual(response.status_code, 200, 'status_code is not 200,error')


    # POST方法access_token写入config目录下面的access_token.txt供后续程序调用
    def test_005_post_access_token(self):
        url = self.access_token_url
        params = urllib.urlencode(
            {'app_key': self.app_key, 'app_secret': self.app_secret, 'grant_type': self.grant_type})
        response = requests.post(url, params=params)
        print response.status_code, response.text
        data = response.json()
        access_token= data["access_token"]
        access_token_file_path='./config/access_token.txt'
        f=open(access_token_file_path,'r+')
        f.write(access_token)
        f.close()

Test002_Nudityfilter.py 具体用例2

# encoding=utf-8
import unittest, os
import requests
from poster.streaminghttp import register_openers

'''nudityfilter'''


# 色情识别模块

class Test002_Nudityfilter(unittest.TestCase):
    def setUp(self):
        # 预设环境信息
        self.url = "http:/**/nudityRecog"
        self.mark = 'room-201'
        self.timestamp = 1846123456
        self.random = 123
        self.app_key = '**'
        # self.access_token = '**'

        access_token_file_path = './config/access_token.txt'
        f=open(access_token_file_path,'r+')
        self.access_token=f.read()
        # print self.access_token
        f.close()

    def tearDown(self):
        # 清理环境信息
        pass
#   四种类型图片测试 -- normal
    def test_001_normal_img(self):
        post_data = {'mark': self.mark,'timestamp': self.timestamp,'random': self.random}
        headers = {'app_key': self.app_key, 'access_token': self.access_token}
        file_path = './data/test/normal'
        path_list = os.listdir(file_path)
        for image in path_list:
            image_path = file_path + '/' + image
            register_openers()
            file = {'file': (image, open(image_path, 'rb'))}
            request = requests.post(self.url, files=file, data=post_data, headers=headers)
            data = request.json()
            print data
            #  判断是否成功调用
            self.assertEqual(data['result_code'], 0)
            #   fileType 是否等于 1
            self.assertEqual(data['result'][-1]['fileType'], 1)
            #   recogType 是否等于 normal
            self.assertEqual(data['result'][-1]['recogType'], 'normal')

HTMLTestRunner.py python 2.7版本测试报告模板

"""
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.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 

%(heading)s
%(report)s
%(ending)s



"""
    # variables: (title, generator, stylesheet, heading, report, ending)


    # ------------------------------------------------------------------------
    # Stylesheet
    #
    # alternatively use a  for external style sheet, e.g.
    #   

    STYLESHEET_TMPL = """

"""



    # ------------------------------------------------------------------------
    # Heading
    #

    HEADING_TMPL = """

%(title)s
%(parameters)s
%(description)s


""" # variables: (title, parameters, description)

    HEADING_ATTRIBUTE_TMPL = """
%(name)s: %(value)s
""" # variables: (name, value)



    # ------------------------------------------------------------------------
    # Report
    #

    REPORT_TMPL = """
Show
Summary
Failed
All


%(test_list)s










    
Test Group/Test case
    
Count
    
Pass
    
Fail
    
Error
    
View

    
Total
    
%(count)s
    
%(Pass)s
    
%(fail)s
    
%(error)s
    
 


""" # variables: (test_list, count, Pass, fail, error)

    REPORT_CLASS_TMPL = r"""

    %(desc)s
    %(count)s
    %(Pass)s
    %(fail)s
    %(error)s
    Detail

""" # variables: (style, desc, count, Pass, fail, error, cid)


    REPORT_TEST_WITH_OUTPUT_TMPL = r"""

    
%(desc)s
    

    
    
        %(status)s

    

        

        
           [x]
        
        
        %(script)s
        
    
    

    

""" # variables: (tid, Class, style, desc, status)


    REPORT_TEST_NO_OUTPUT_TMPL = r"""

    
%(desc)s
    %(status)s

""" # variables: (tid, Class, style, desc, status)


    REPORT_TEST_OUTPUT_TMPL = r"""
%(id)s: %(output)s
""" # variables: (id, output)



    # ------------------------------------------------------------------------
    # ENDING
    #

    ENDING_TMPL = """
 
"""

# -------------------- The end of the Template class -------------------


TestResult = unittest.TestResult

class _TestResult(TestResult):
    # note: _TestResult is a pure representation of results.
    # It lacks the output and reporting ability compares to unittest._TextTestResult.

    def __init__(self, verbosity=1):
        TestResult.__init__(self)
        self.stdout0 = None
        self.stderr0 = None
        self.success_count = 0
        self.failure_count = 0
        self.error_count = 0
        self.verbosity = verbosity

        # result is a list of result in 4 tuple
        # (
        #   result code (0: success; 1: fail; 2: error),
        #   TestCase object,
        #   Test output (byte string),
        #   stack trace,
        # )
        self.result = []


    def startTest(self, test):
        TestResult.startTest(self, test)
        # just one buffer for both stdout and stderr
        self.outputBuffer = StringIO.StringIO()
        stdout_redirector.fp = self.outputBuffer
        stderr_redirector.fp = self.outputBuffer
        self.stdout0 = sys.stdout
        self.stderr0 = sys.stderr
        sys.stdout = stdout_redirector
        sys.stderr = stderr_redirector


    def complete_output(self):
        """
        Disconnect output redirection and return buffer.
        Safe to call multiple times.
        """
        if self.stdout0:
            sys.stdout = self.stdout0
            sys.stderr = self.stderr0
            self.stdout0 = None
            self.stderr0 = None
        return self.outputBuffer.getvalue()


    def stopTest(self, test):
        # Usually one of addSuccess, addError or addFailure would have been called.
        # But there are some path in unittest that would bypass this.
        # We must disconnect stdout in stopTest(), which is guaranteed to be called.
        self.complete_output()


    def addSuccess(self, test):
        self.success_count += 1
        TestResult.addSuccess(self, test)
        output = self.complete_output()
        self.result.append((0, test, output, ''))
        if self.verbosity > 1:
            sys.stderr.write('ok ')
            sys.stderr.write(str(test))
            sys.stderr.write('\n')
        else:
            sys.stderr.write('.')

    def addError(self, test, err):
        self.error_count += 1
        TestResult.addError(self, test, err)
        _, _exc_str = self.errors[-1]
        output = self.complete_output()
        self.result.append((2, test, output, _exc_str))
        if self.verbosity > 1:
            sys.stderr.write('E  ')
            sys.stderr.write(str(test))
            sys.stderr.write('\n')
        else:
            sys.stderr.write('E')

    def addFailure(self, test, err):
        self.failure_count += 1
        TestResult.addFailure(self, test, err)
        _, _exc_str = self.failures[-1]
        output = self.complete_output()
        self.result.append((1, test, output, _exc_str))
        if self.verbosity > 1:
            sys.stderr.write('F  ')
            sys.stderr.write(str(test))
            sys.stderr.write('\n')
        else:
            sys.stderr.write('F')


class HTMLTestRunner(Template_mixin):
    """
    """
    def __init__(self, stream=sys.stdout, verbosity=1, title=None, description=None):
        self.stream = stream
        self.verbosity = verbosity
        if title is None:
            self.title = self.DEFAULT_TITLE
        else:
            self.title = title
        if description is None:
            self.description = self.DEFAULT_DESCRIPTION
        else:
            self.description = description

        self.startTime = datetime.datetime.now()


    def run(self, test):
        "Run the given test case or test suite."
        result = _TestResult(self.verbosity)
        test(result)
        self.stopTime = datetime.datetime.now()
        self.generateReport(test, result)
        print >>sys.stderr, '\nTime Elapsed: %s' % (self.stopTime-self.startTime)
        return result


    def sortResult(self, result_list):
        # unittest does not seems to run in any particular order.
        # Here at least we want to group them together by class.
        rmap = {}
        classes = []
        for n,t,o,e in result_list:
            cls = t.__class__
            if not rmap.has_key(cls):
                rmap[cls] = []
                classes.append(cls)
            rmap[cls].append((n,t,o,e))
        r = [(cls, rmap[cls]) for cls in classes]
        return r


    def getReportAttributes(self, result):
        """
        Return report attributes as a list of (name, value).
        Override this to add custom attributes.
        """
        startTime = str(self.startTime)[:19]
        duration = str(self.stopTime - self.startTime)
        status = []
        if result.success_count: status.append('Pass %s'    % result.success_count)
        if result.failure_count: status.append('Failure %s' % result.failure_count)
        if result.error_count:   status.append('Error %s'   % result.error_count  )
        if status:
            status = ' '.join(status)
        else:
            status = 'none'
        return [
            ('Start Time', startTime),
            ('Duration', duration),
            ('Status', status),
        ]


    def generateReport(self, test, result):
        report_attrs = self.getReportAttributes(result)
        generator = 'HTMLTestRunner %s' % __version__
        stylesheet = self._generate_stylesheet()
        heading = self._generate_heading(report_attrs)
        report = self._generate_report(result)
        ending = self._generate_ending()
        output = self.HTML_TMPL % dict(
            title = saxutils.escape(self.title),
            generator = generator,
            stylesheet = stylesheet,
            heading = heading,
            report = report,
            ending = ending,
        )
        self.stream.write(output.encode('utf8'))


    def _generate_stylesheet(self):
        return self.STYLESHEET_TMPL


    def _generate_heading(self, report_attrs):
        a_lines = []
        for name, value in report_attrs:
            line = self.HEADING_ATTRIBUTE_TMPL % dict(
                    name = saxutils.escape(name),
                    value = saxutils.escape(value),
                )
            a_lines.append(line)
        heading = self.HEADING_TMPL % dict(
            title = saxutils.escape(self.title),
            parameters = ''.join(a_lines),
            description = saxutils.escape(self.description),
        )
        return heading


    def _generate_report(self, result):
        rows = []
        sortedResult = self.sortResult(result.result)
        for cid, (cls, cls_results) in enumerate(sortedResult):
            # subtotal for a class
            np = nf = ne = 0
            for n,t,o,e in cls_results:
                if n == 0: np += 1
                elif n == 1: nf += 1
                else: ne += 1

            # format class description
            if cls.__module__ == "__main__":
                name = cls.__name__
            else:
                name = "%s.%s" % (cls.__module__, cls.__name__)
            doc = cls.__doc__ and cls.__doc__.split("\n")[0] or ""
            desc = doc and '%s: %s' % (name, doc) or name

            row = self.REPORT_CLASS_TMPL % dict(
                style = ne > 0 and 'errorClass' or nf > 0 and 'failClass' or 'passClass',
                desc = desc,
                count = np+nf+ne,
                Pass = np,
                fail = nf,
                error = ne,
                cid = 'c%s' % (cid+1),
            )
            rows.append(row)

            for tid, (n,t,o,e) in enumerate(cls_results):
                self._generate_report_test(rows, cid, tid, n, t, o, e)

        report = self.REPORT_TMPL % dict(
            test_list = ''.join(rows),
            count = str(result.success_count+result.failure_count+result.error_count),
            Pass = str(result.success_count),
            fail = str(result.failure_count),
            error = str(result.error_count),
        )
        return report


    def _generate_report_test(self, rows, cid, tid, n, t, o, e):
        # e.g. 'pt1.1', 'ft1.1', etc
        has_output = bool(o or e)
        tid = (n == 0 and 'p' or 'f') + 't%s.%s' % (cid+1,tid+1)
        name = t.id().split('.')[-1]
        doc = t.shortDescription() or ""
        desc = doc and ('%s: %s' % (name, doc)) or name
        tmpl = has_output and self.REPORT_TEST_WITH_OUTPUT_TMPL or self.REPORT_TEST_NO_OUTPUT_TMPL

        # o and e should be byte string because they are collected from stdout and stderr?
        if isinstance(o,str):
            # TODO: some problem with 'string_escape': it escape \n and mess up formating
            # uo = unicode(o.encode('string_escape'))
            uo = o.decode('latin-1')
        else:
            uo = o
        if isinstance(e,str):
            # TODO: some problem with 'string_escape': it escape \n and mess up formating
            # ue = unicode(e.encode('string_escape'))
            ue = e.decode('latin-1')
        else:
            ue = e

        script = self.REPORT_TEST_OUTPUT_TMPL % dict(
            id = tid,
            output = saxutils.escape(uo+ue),
        )

        row = tmpl % dict(
            tid = tid,
            Class = (n == 0 and 'hiddenRow' or 'none'),
            style = n == 2 and 'errorCase' or (n == 1 and 'failCase' or 'none'),
            desc = desc,
            script = script,
            status = self.STATUS[n],
        )
        rows.append(row)
        if not has_output:
            return

    def _generate_ending(self):
        return self.ENDING_TMPL


##############################################################################
# Facilities for running tests from the command line
##############################################################################

# Note: Reuse unittest.TestProgram to launch test. In the future we may
# build our own launcher to support more specific command line
# parameters like test title, CSS, etc.
class TestProgram(unittest.TestProgram):
    """
    A variation of the unittest.TestProgram. Please refer to the base
    class for command line parameters.
    """
    def runTests(self):
        # Pick HTMLTestRunner as the default test runner.
        # base class's testRunner parameter is not useful because it means
        # we have to instantiate HTMLTestRunner before we know self.verbosity.
        if self.testRunner is None:
            self.testRunner = HTMLTestRunner(verbosity=self.verbosity)
        unittest.TestProgram.runTests(self)

main = TestProgram

##############################################################################
# Executing this module from the command line
##############################################################################

if __name__ == "__main__":
    main(module=None)

项目在加上Jenkins 持续化集成，版本包自动构建、CI集成、部署、自动化测试。测试的工作也很简单。