Python+Selenium 自动化测试 6. Unittest模块学习

unittest单元测试框架不仅可以适用于单元测试，还可以适用WEB自动化测试用例的开发与执行，该测试框架可组织执行测试用例，并且提供了丰富的断言方法，判断测试用例是否通过，最终生成测试结果。

源码例子：

import unittest

class IntegerArithmeticTestCase(unittest.TestCase):
    def testAdd(self):  # test method names begin with 'test'
        self.assertEqual((1 + 2), 3)
        self.assertEqual(0 + 1, 1)
    def testMultiply(self):
        self.assertEqual((0 * 10), 0)
        self.assertEqual((5 * 8), 40)

if __name__ == '__main__':
    unittest.main()

解析下这个源码：

1. 引入unittest包

3. class定义一个测试类，并继承unittest.TestCase这个类

4 - 9. 定义两个测试case的名称，分别是testAdd和testMultiply， 然后增加了断言。assertEqual()

Note: 第四行中 “test method names begin with 'test'” 我们定义测试case的名称必须以test开头

11 - 12. 这个程序的主函数

运行的结果：

..
----------------------------------------------------------------------
Ran 2 tests in 0.001s

OK

 

unittest中一些重要的概念

静态框架图如下：

 

__all__ = ['TestResult', 'TestCase', 'TestSuite',
           'TextTestRunner', 'TestLoader', 'FunctionTestCase', 'main',
           'defaultTestLoader', 'SkipTest', 'skip', 'skipIf', 'skipUnless',
           'expectedFailure', 'TextTestResult', 'installHandler',
           'registerResult', 'removeResult', 'removeHandler']

 

TestCase（测试用例）: 所有测试用例的基类，它是软件 测试中最基本的组成单元。TestCase类，所有测试用例类继承的基本类。

class BaiduTest(unittest.TestCase):

一个test case就是一个测试用例，是一个完整的测试流程，包括测试前环境的搭建setUp，执行测试代码(run)，以及测试后环境的还原(tearDown)。测试用例是一个完整的测试单元，可以对某一问题进行验证。

TestSuite（测试套件）:多个测试用例test case集合就是TestSuite（创建测试套件），TestSuite可以嵌套TestSuite

TestLoder：是用来加载 TestCase到TestSuite中，其中有几个loadTestsFrom_()方法，就是从各个地方寻找TestCase，创建他们的实例，然后add到TestSuite中，再返回一个TestSuite实例

TextTestRunner：是来执行测试用例的，其中的run（test）会执行TestSuite/TestCase中的run(result)方法，入参为suite测试套件

TextTestResult：测试结果会保存到TextTestResult实例中，包括运行了多少用例，成功与失败多少等信息

TestFixture:又叫测试脚手，测试代码的运行环境，指测试准备前和执行后要做的工作，包括setUp和tearDown方法。总结就是：对一个测试用例环境的搭建和销毁。如何销毁呢？就是通过覆盖TestCase的setUp()和tearDown()方法来实现，tearDown()的过程很重要，为后面的case保证了一个干净的测试环境。

unittest.main():使用她可以方便的将一个单元测试模块变为可直接运行的测试脚本，main()方法使用TestLoader类来搜索所有包含在该模块中以“test”命名开头的测试方法，并自动执行他们。执行方法的默认顺序是：根据ASCII码的顺序加载测试用例，数字与字母的顺序为：0-9，A-Z，a-z。所以以A开头的测试用例方法会优先执行，以a开头会后执行。

unittest.defaultTestLoader(): defaultTestLoader()类，通过该类下面的discover()方法可自动更具测试目录start_dir匹配查找测试用例文件（test*.py），并将查找到的测试用例组装到测试套件，因此可以直接通过run()方法执行discover。用法如下：

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

unittest.skip():装饰器，当运行用例时，有些用例可能不想执行等，可用装饰器暂时屏蔽该条测试用例。一种常见的用法就是比如说想调试某一个测试用例，想先屏蔽其他用例就可以用装饰器屏蔽。

@unittest.skip(reason): skip(reason)装饰器：无条件跳过装饰的测试，并说明跳过测试的原因。

@unittest.skipIf(reason): skipIf(condition,reason)装饰器：条件为真时，跳过装饰的测试，并说明跳过测试的原因。

@unittest.skipUnless(reason): skipUnless(condition,reason)装饰器：条件为假时，跳过装饰的测试，并说明跳过测试的原因。

@unittest.expectedFailure(): expectedFailure()测试标记为失败。

 

一个class继承了unittest.TestCase，便是一个测试用例，但如果其中有多个以 test 开头的方法，那么每有一个这样的方法，在load的时候便会生成一个TestCase实例，如：一个class中有四个test_xxx方法，最后在load到suite中时也有四个测试用例。

 

unittest工作原理

我们可以简化一下就是：

先写好TestCase然后由TestLoader加载TestCase到TestSuite，然后由TextTestRunner来运行TestSuite，运行的结果保存在TextTestResult中，整个过程集成在unittest.main模块中，main会调用TextTestRunner中的run来执行，或者我们可以直接通过TextTestRunner来执行用例。在Runner运行的时候，我们的测试结果会被输出到控制台，可以清晰的看到，我们还可以输出到文件，运用HTMLTestRunner生成一个漂亮的报告。

 

unittest case调用顺序

其中我们一个TestCase调用的顺序如下图所示“

 

 

 

TestCase类的属性如下：

['__call__', '__class__', '__delattr__', '__dict__', '__doc__', '__eq__', '__format__', '__getattribute__', '__hash__', '__init__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_addSkip', '_baseAssertEqual', '_classSetupFailed', '_deprecate', '_diffThreshold', '_formatMessage', '_getAssertEqualityFunc', '_truncateMessage', 'addCleanup', 'addTypeEqualityFunc', 'assertAlmostEqual', 'assertAlmostEquals', 'assertDictContainsSubset', 'assertDictEqual', 'assertEqual', 'assertEquals', 'assertFalse', 'assertGreater', 'assertGreaterEqual', 'assertIn', 'assertIs', 'assertIsInstance', 'assertIsNone', 'assertIsNot', 'assertIsNotNone', 'assertItemsEqual', 'assertLess', 'assertLessEqual', 'assertListEqual', 'assertMultiLineEqual', 'assertNotAlmostEqual', 'assertNotAlmostEquals', 'assertNotEqual', 'assertNotEquals', 'assertNotIn', 'assertNotIsInstance', 'assertNotRegexpMatches', 'assertRaises', 'assertRaisesRegexp', 'assertRegexpMatches', 'assertSequenceEqual', 'assertSetEqual', 'assertTrue', 'assertTupleEqual', 'assert_', 'countTestCases', 'debug', 'defaultTestResult', 'doCleanups', 'fail', 'failIf', 'failIfAlmostEqual', 'failIfEqual', 'failUnless', 'failUnlessAlmostEqual', 'failUnlessEqual', 'failUnlessRaises', 'failureException', 'id', 'longMessage', 'maxDiff', 'run', 'setUp', 'setUpClass', 'shortDescription', 'skipTest', 'tearDown', 'tearDownClass']

 

说明：

setUp()

setUp()方法用于测试用例执行前的初始化工作。如测试用例中需要访问数据库，可以在setUp中建立数据库连接并进行初始化。如测试用例需要登录web，可以先实例化浏览器。

 

tearDown()

tearDown()方法用于测试用例执行之后的善后工作。如关闭数据库连接。关闭浏览器。

 

assert*()

一些断言方法：在执行测试用例的过程中，最终用例是否执行通过，是通过判断测试得到的实际结果和预期结果是否相等决定的。

assertEqual(a,b，[msg='测试失败时打印的信息']):断言a和b是否相等，相等则测试用例通过。

assertNotEqual(a,b，[msg='测试失败时打印的信息']):断言a和b是否相等，不相等则测试用例通过。

assertTrue(x，[msg='测试失败时打印的信息'])：断言x是否True，是True则测试用例通过。

assertFalse(x，[msg='测试失败时打印的信息'])：断言x是否False，是False则测试用例通过。

assertIs(a,b，[msg='测试失败时打印的信息']):断言a是否是b，是则测试用例通过。

assertNotIs(a,b，[msg='测试失败时打印的信息']):断言a是否是b，不是则测试用例通过。

assertIsNone(x，[msg='测试失败时打印的信息'])：断言x是否None，是None则测试用例通过。

assertIsNotNone(x，[msg='测试失败时打印的信息'])：断言x是否None，不是None则测试用例通过。

assertIn(a,b，[msg='测试失败时打印的信息'])：断言a是否在b中，在b中则测试用例通过。

assertNotIn(a,b，[msg='测试失败时打印的信息'])：断言a是否在b中，不在b中则测试用例通过。

assertIsInstance(a,b，[msg='测试失败时打印的信息'])：断言a是是b的一个实例，是则测试用例通过。

assertNotIsInstance(a,b，[msg='测试失败时打印的信息'])：断言a是是b的一个实例，不是则测试用例通过。

 

TestSuite类的属性如下：（组织用例时需要用到）

 

['__call__', '__class__', '__delattr__', '__dict__', '__doc__', '__eq__', '__format__', '__getattribute__', '__hash__', '__init__', '__iter__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_addClassOrModuleLevelException', '_get_previous_module', '_handleClassSetUp', '_handleModuleFixture', '_handleModuleTearDown', '_tearDownPreviousClass', '_tests', 'addTest', 'addTests', 'countTestCases', 'debug', 'run']

 

说明：

addTest()

addTest()方法是将测试用例添加到测试套件中，如下方，是将test_baidu模块下的BaiduTest类下的test_baidu测试用例添加到测试套件。

suite =unittest.TestSuite()suite.addTest(test_baidu.BaiduTest('test_baidu'))

TextTextRunner的属性如下：（组织用例时需要用到）

 

['__class__', '__delattr__', '__dict__', '__doc__', '__format__', '__getattribute__', '__hash__', '__init__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_makeResult', 'buffer', 'descriptions', 'failfast', 'resultclass', 'run', 'stream', 'verbosity']

 

说明：

run()

run()方法是运行测试套件的测试用例，入参为suite测试套件。

runner =unittest.TextTestRunner()runner.run(suite)

设计思路：

# coding=utf-8
#1.先设置编码，utf-8可支持中英文，如上，一般放在第一行

#2.注释：包括记录创建时间，创建人，项目名称。

#3.导入unittest模块
import unittest

#4.定义测试类，父类为unittest.TestCase。
#可继承unittest.TestCase的方法，如setUp和tearDown方法，不过此方法可以在子类重写，覆盖父类方法。
#可继承unittest.TestCase的各种断言方法。
class Test(unittest.TestCase): 
    
#5.定义setUp()方法用于测试用例执行前的初始化工作。
#注意，所有类中方法的入参为self，定义方法的变量也要“self.变量”
#注意，输入的值为字符型的需要转为int型
    def setUp(self):
        self.number=raw_input('Enter a number:')
        self.number=int(self.number)

#6.定义测试用例，以“test_”开头命名的方法
#注意，方法的入参为self
#可使用unittest.TestCase类下面的各种断言方法用于对测试结果的判断
#可定义多个测试用例
#最重要的就是该部分
    def test_case1(self):
        print self.number
        self.assertEqual(self.number,10,msg='Your input is not 10')
        
    def test_case2(self):
        print self.number
        self.assertEqual(self.number,20,msg='Your input is not 20')

    @unittest.skip('暂时跳过用例3的测试')
    def test_case3(self):
        print self.number
        self.assertEqual(self.number,30,msg='Your input is not 30')

#7.定义tearDown()方法用于测试用例执行之后的善后工作。
#注意，方法的入参为self
    def tearDown(self):
        print 'Test over'
        
#8如果直接运行该文件(__name__值为__main__),则执行以下语句，常用于测试脚本是否能够正常运行
if __name__=='__main__':
#8.1执行测试用例方案一如下：
#unittest.main()方法会搜索该模块下所有以test开头的测试用例方法，并自动执行它们。
#执行顺序是命名顺序：先执行test_case1，再执行test_case2
    unittest.main()

'''
#8.2执行测试用例方案二如下：
#8.2.1先构造测试集
#8.2.1.1实例化测试套件
    suite=unittest.TestSuite()
#8.2.1.2将测试用例加载到测试套件中。
#执行顺序是安装加载顺序：先执行test_case2，再执行test_case1
    suite.addTest(Test('test_case2'))
    suite.addTest(Test('test_case1'))
#8.2.2执行测试用例
#8.2.2.1实例化TextTestRunner类
    runner=unittest.TextTestRunner()
#8.2.2.2使用run()方法运行测试套件（即运行测试套件中的所有用例）
    runner.run(suite)
'''
    
'''
#8.3执行测试用例方案三如下：
#8.3.1构造测试集（简化了方案二中先要创建测试套件然后再依次加载测试用例）
#执行顺序同方案一：执行顺序是命名顺序：先执行test_case1，再执行test_case2
    test_dir = './'
    discover = unittest.defaultTestLoader.discover(test_dir, pattern='test_*.py')
#8.3.2执行测试用例
#8.3.2.1实例化TextTestRunner类
    runner=unittest.TextTestRunner()
#8.3.2.2使用run()方法运行测试套件（即运行测试套件中的所有用例）
    runner.run(discover)   
'''

例子：

import time
import unittest
import uiautomator2 as u2

from NormativeExamination import common

class GoogleSecurityCheck(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        cls.d = u2.connect('04030148AO000175')
        cls.d.make_toast('测试开始', 3)

    @classmethod
    def tearDownClass(cls):
        cls.d.make_toast('测试结束', 3)

    def setUp(self):
        self.d.info.get("screenOn")
        self.d.screen_on()

    def tearDown(self):
        self.d.press('Home')
        time.sleep(1)
        
    def test_persistent(self):
        u'''persistent进程内存占用'''
        persistent, code = self.d.shell("dumpsys meminfo | grep persistent")
        result = persistent.split("K:")[0].replace(",", "")
        self.assertLessEqual(int(result), 92160, 'persistent小于90M')

    def test_bluetooth(self):
        u'''测试蓝牙状态, 蓝牙必须默认关闭'''
        common.open_settings_menu(self.d, "Bluetooth")
        bluetooth_off = self.d(resourceId="com.android.settings:id/switch_widget", text=u"OFF")
        self.assertTrue(bluetooth_off, "蓝牙默认是关闭的")  

if __name__ == '__main__':
    unittest.main()   

例子解析

上面这个栗子中，还有几个额外的知识：

setup就是前置条件，tearDown就是后置条件，在我们执行完case之后，tearDown必须要写，做数据的还原，清理测试环境，比如退出浏览器、返回到手机的Home页面，保证后面的case不会执行失败。

 

这里有个坑，就是比如我们做测试打开百度页面的操作，每次执行用例就重新打开一次，这样就非常的浪费时间，我的本意是打开了百度的页面，我想做完所有的操作，然后再去关闭百度页面，这个时候就用到了装饰器（@classmethod）

• 装饰器

用setUp与setUpClass区别

setup():每个测试case运行前运行

teardown():每个测试case运行完后执行

setUpClass():必须使用@classmethod 装饰器,所有case运行前只运行一次

tearDownClass():必须使用@classmethod装饰器,所有case运行完后只运行一次

• @是修饰符，classmethod是python里的类方法

 

Note： 在写测试用例的时候，一定要用test开头，假如不用test开头，你会发现程序识别不了

def test_persistent(self):
    pass

 

小课堂：如何控制unittest执行的顺序呢？

答案：TestSuite(测试套件)的addTest()方法

unittest的main()方法执行用例的顺序是按照测试类、测试方法的名字的ASCII顺序来执行测试方法。假如不控制unittest执行顺序，有的有依赖测试的case就会运行失败，比如：下单 -> 付款， case的执行顺序必须要先执行下单才能付款，不能反过来。

 

假如我们要控制它，有2个办法：

1、 通过TestSuite按照顺序添加想要执行的方法

 

if __name__ == "__main__":
    suite = unittest.TestSuite()
    # 第一种方法：
    suite.addTest(TestBddClass("test_persistent_c"))
    suite.addTest(TestBddClass("test_bluetooth_a"))

这样方法的执行顺序就是先执行test_persistent_c，再执行test_bluetooth_a

这种方式可以实现，但是你必须要一个个手动去添加，用例一多就会你就会添加的爆炸，不适用。

2、 控制方法名字来实现

直接用 test_a_xxx , test_b_xxx， test_c_xxx来控制。abc换成123也行等等~

例子：

def test_a_persistent(self):
    u'''persistent进程内存占用'''
    persistent, code = self.d.shell("dumpsys meminfo | grep persistent")
    result = persistent.split("K:")[0].replace(",", "")
    self.assertLessEqual(int(result), 92160, 'persistent小于90M')

def test_b_bluetooth(self):
    u'''测试蓝牙状态, 蓝牙必须默认关闭'''
    common.open_settings_menu(self.d, "Bluetooth")
    bluetooth_off = self.d(resourceId="com.android.settings:id/switch_widget", text=u"OFF")
    self.assertTrue(bluetooth_off, "蓝牙默认是关闭的")

如何跳过某个Case？

如果我们临时想要跳过某个case不执行怎么办？unittest也提供了几种方法：

 

# 第一种写法
class GoogleSecurityCheck(unittest.TestCase):
    
    # 跳过测试类
    @unittest.skip("I don't want to run this case.")
    def test_AFW(self):
        u'''AFW功能支持检查'''
        max_user, code = self.d.shell("pm get-max-users")
        result = max_user.split(':')[-1]
        self.assertTrue(result, 'get-max-ulser must be greater than 1')


class GoogleSecurityCheck(unittest.TestCase):
    # 跳过测试case
    def test_AFW(self):
        u'''AFW功能支持检查'''
        self.skipTest('Do not run this case')
        max_user, code = self.d.shell("pm get-max-users")
        result = max_user.split(':')[-1]
        self.assertTrue(result, 'get-max-ulser must be greater than 1') 

两种方法得到的结果是一样的。        

运行程序，你就会发现 test_AFW就不会被执行，跳过了。

 

skip装饰器有三个：

unittest.skip(reason)
unittest.skipIf(condition, reason)
unittest.skipUnless(condition, reason)
skip无条件跳过
skipIf当condition为True时跳过
skipUnless当condition为False时跳过。

 

一个完整的小栗子：

import unittest
import time

class Test(unittest.TestCase):
    def setUp(self):
        print ("start!")

    def tearDown(self):
        time.sleep(1)
        print ("end!")

    def test01(self):
        print ("执行测试用例01")

    def test03(self):
        print ("执行测试用例03")

if __name__ == '__main__':
    # 构造测试集
    suite = unittest.TestSuite()
    suite.addTest(Test("test01"))
    suite.addTest(Test("test03"))

    # 执行测试
    runner = unittest.TextTestRunner()
    runner.run(suite)

运行结果：

start!
执行测试用例01
end!
start!
执行测试用例03
end!
----------------------------------------------------------------------
Ran 2 tests in 2.000s

OK

将结果输出到文件中：

如上我们的结果就是输出到控制台，运行一次得到一次的结果，要查看之前的历史记录就没办法，我们可以把结果输出到文件。

 

修改一下代码：

if __name__ == '__main__':
    # 构造测试集
    suite = unittest.TestSuite()
    suite.addTest(Test("test03"))
    suite.addTest(Test("test01"))

    # 执行测试
    # runner = unittest.TextTestRunner()
    # runner.run(suite)

    with open('UnittestTextReport.txt', 'a') as f:
        runner = unittest.TextTestRunner(stream=f, verbosity=2)
        runner.run(suite)

运行结果：

我猜你嫌弃报告不够漂亮，早有人想到了，我们可以用HTMLTestRunner来生成一个漂亮的测试报告

 

HTMLTestRunner测试报告

 

Note：这种方法适用于python2

from HTMLTestRunner import HTMLTestRunner

with open('HTMLReport.html', 'w') as f:
    runner = HTMLTestRunner(stream=f,
                            title='测试报告',
                            description='规范性检查测试报告.',
                            verbosity=2
                            )
    runner.run(suite)

python 3中：

import HTMLTestRunner

if __name__ == '__main__':
    # 构造测试集
    suite = unittest.TestSuite()
    suite.addTest(Test("test03"))
    suite.addTest(Test("test01"))

    now = time.strftime("%Y-%m-%d_%H-%M-%S", time.localtime())
    fp = open(now + 'result.html', 'wb')

    # 定义报告格式
    runner = HTMLTestRunner.HTMLTestRunner(
        stream=fp,
        title='规范性检查测试报告',
        description=u'用例执行情况:')

    # 运行测试用例
    runner.run(suite)
    # 关闭报告文件
    fp.close()

让我们看看漂亮的报告：

代码中为什么加了如下两行呢？

now = time.strftime("%Y-%m-%d_%H-%M-%S", time.localtime())
fp = open(now + 'result.html', 'wb')

因为为了区分报告，报告的名称用当前的时间来表示，不会造成重复。效果如下：

 

unittest 参数化

我们在写case的时候，如果用例的操作是一样的，就是参数不同，比如说要测一个登陆的接口，要测正常登陆的、黑名单用户登陆的、账号密码错误的等等，在unittest里面就要写多个case来测试。

这样的情况只是调用接口的时候参数不一样而已，再写多个case的话就有点多余了，那怎么办呢，就得把这些参数都写到一个list里面， 然后循环去执行这个case。这样就可以省去写多个case了。

当然有个第三方模块就直接有这样的功能，不需要咱们再自己写循环了。那就是nose-parameterized，直接pip安装即可。

pip install nose-parameterized

代码：

import unittest
from nose_parameterized import parameterized
#导入这个模块
class My(unittest.TestCase):
 
    @parameterized.expand(
        [
            (1,2,3),
            (1,2,3),
            (1,2,3),
            (1,2,4)
         ]
    )#使用它提供的装饰器装饰这个函数，把咱们写的这4个数据放到这个list里面
    def test1(self,a,b,c):
        self.assertEqual(a+b,c)
 
if __name__=='__main__':
    unittest.main()

下面是运行结果，咱们上面只运行了一次，可以发现，它自动帮咱们运行了4次。

 

运行例子结果：

说明：.代表用例执行通过，两个点表示两个用例执行通过。F表示用例执行不通过。