首頁  >  文章  >  後端開發  >  Python自動化測試框架之unittest如何使用?

Python自動化測試框架之unittest如何使用?

PHPz
PHPz轉載
2023-05-08 15:13:171281瀏覽

    1 unittest框架

    unittest 是python 的單元測試框架,它主要有以下作用:

    提供用例組織與執行:當你的測試用例只有幾條時,可以不必考慮用例的組織,但是,當測試用例達到成百上千條時,大量的測試用例堆砌在一起,就產生了擴展性與維護性等問題,此時需要考慮用例的規格與組織問題了。單元測試框架就是來解決這個問題的。

    提供豐富的比較方法:在使用案例執行後都需要將實際結果與預期結果進行比較(斷言),從而斷定用例是否可以順利通過。單元測試一般會提供豐富的斷言方法。例如,判斷相等/不相等、包含/不包含、True/False等斷言方法。

    提供豐富的日誌:當測試案例執行失敗時能拋出清晰的失敗原因,當所有用例執行完成後能提供豐富的執行結果。例如,總的執行時間,失敗用例數,成功用例數等。

    unittest裡面有四個很重要的概念,test fixture,test case,test suite,test runner。

    Test Fixture

    對一個測試案例環境的建構與銷毀,就是一個fixture,透過覆寫setUp()和tearDown()方法來實現。

    setUp()方法可以進行測試環境的搭建,例如取得待測試瀏覽器的驅動,或者如果測試中需要存取資料庫,那麼可以在setUp()中透過建立資料庫連線來進行初始化。

    tearDown()方法進行環境的銷毀,可以進行關閉瀏覽器,關閉資料庫連接,清除資料庫中產生的資料等操作;Test Case

    一個TestCase的實例就是一個測試案例。測試案例就是一個完整的測試流程,包括測試前準備環境的建置(setUp)、實作測試過程的程式碼,以及測試後環境的還原(tearDown)。單元測試(unit test)的本質就在這裡,一個測試案例就是一個完整的測試單元,可以對某一個功能進行驗證。 Test Suite

    一個功能的驗證往往需要多個測試案例,可以把多個測試案例集合在一起執行,這就產生了測試套件TestSuite的概念。 Test Suit用來將多個測試案例組裝在一起;

    Test Runner測試的執行也是非常重要的一個概念,在unittest框架中,透過TextTestRunner類別提供的run()方法來執行test suite/ test case。

    from selenium import webdriver
    import unittest
    import time
    import os
    from selenium.common.exceptions import NoAlertPresentException
    from selenium.common.exceptions import NoSuchElementException
    from selenium.webdriver.common.by import By
    class Baidu1(unittest.TestCase):
        def setUp(self):
            print("-----setUp-----")
            self.driver = webdriver.Chrome()
            self.url = "https://www.baidu.com/"
            self.driver.maximize_window()
            time.sleep(3)
        def tearDown(self):
            print("-----tearDown-----")
            self.driver.quit()
        def test_hao(self):
            print("111111111")
            driver = self.driver
            url = self.url
            driver.get(url)
            driver.find_element(By.LINK_TEXT,"hao123").click()
            time.sleep(6)
        def test_hbaidu(self):
            print("22222222")
            driver = self.driver
            url = self.url
            driver.get(url)
            driver.find_element(By.ID,"kw").send_keys("unittest")
            driver.find_element(By.ID,"su").submit()
            time.sleep(5)
            print(driver.title)
            # self.assertNotEqual(driver.title, "百度一下_百度搜索", msg="不相等")
            # self.assertTrue("beautiful"=="beauty", msg="Not Equal!")
            time.sleep(6)
        def saveScreenAsPhoto(self, driver, file_name):
            if not os.path.exists("./image"):
                os.makedirs("./image")
            now = time.strftime("%Y%m%d-%H%M%S", time.localtime(time.time()))
            driver.get_screenshot_as_file("./image/" + now + "-" + file_name)
            time.sleep(3)
            print("3333333")
    if __name__ == "__main__":
        unittest.main()

    這個腳本中的類別 Baidu1 繼承了unittest.TestCase類,所以它使用了unittest框架來組織測試案例(TestCase)。

    setUp() 和 setDown() 是unittest框架中的測試韌體。

    以test_開頭命名的方法,是測試方法,在運行整個類別的時候會預設執行。

    unittest提供了全域的main()方法,使用它可以方便地將一個單元測試模組變成可以直接運行的測試腳

    #本。 main()方法搜尋所有包含在該模組中以”test"命名的測試方法,並自動執行他們。

    2 批次執行腳本

    2.1 建置測試套件

    當我們增加了被測試功能和對應的測試案例之後,我們就需要把多個測試案例組織在一起執行,這就需要用到上文中提到的測試套件Test Suite

    假設我們已經寫了testbaidu1.py,testbaidu2.py兩個檔案

    testbaidu2.py

    from selenium import webdriver
    import unittest
    import time
    from selenium.common.exceptions import NoAlertPresentException
    from selenium.common.exceptions import NoSuchElementException
    from selenium.webdriver.common.by import By
    class Baidu2 (unittest.TestCase) :
        def setUp(self):
            self.driver = webdriver.Chrome()
            self.driver.implicitly_wait(30)
            self.base_url = "http://www.baidu.com/"
            self.driver.maximize_window()
            self.verificationErrors=[]
            self.accept_next_alert = True
        def tearDown(self):
            self.driver.quit()
            self.assertEqual([], self.verificationErrors)
        def test_hao(self):
            driver = self.driver
            driver.get(self.base_url)
            driver.find_element(By.LINK_TEXT,"新闻").click()
            time.sleep(6)
            self.assertTrue("123" == "1234", msg="not true")
            time.sleep(3)
        def test_baidusearch(self):
            driver = self.driver
            driver.get(self.base_url)
            driver.find_element(By.ID,"kw").clear()
            driver.find_element(By.ID,"kw").send_keys(u"unittest")
            driver.find_element(By.ID,"su").click()
        time.sleep(6)
        def is_element_present(self, how, what):
            try:
                self.driver.find_element(by=how, value=what)
            except NoSuchElementException as e:
                return False
            return True
        def is_alert_present(self):
            try:
                self.driver.switch_to.alert
            except NoAlertPresentException as e:
                return False
            return True
        def close_alert_and_get_its_text(self):
            try:
                alert = self.driver.switch_to.alert
                alert_text = alert.text
                if self.accept_next_alert:
                    alert.accept()
                else:
                    alert.dismiss()
                return alert_text
            finally: self.accept_next_alert = True
    if __name__ == "__main__":
        unittest.main(verbosity=2)

    addTest()

    TestSuite類別的addTest()方法可以把不同的測試類別中的測試方法組裝到測試套件中,但是addTest()一次只能把一個類別裡面的一個測試方法組裝到測試套件中。方式如下:

    將testbaidu1.py、testbaidu2.py中的測試方法放到一個測試套件中,在testsuite.py中實作。

    testsuite.py

    import unittest
    from testUnittest import testbaidu1
    from testUnittest import testbaidu2
    def createsuite():
        #addTest
        suite = unittest.TestSuite()
        suite.addTest(testbaidu1.Baidu1("test_hao"))
        suite.addTest(testbaidu1.Baidu1("test_hbaidu"))
        suite.addTest(testbaidu2.Baidu2("test_hao"))
        suite.addTest(testbaidu2.Baidu2("test_baidusearch"))
        return suite
    if __name__=="__main__":
        suite = createsuite()
        runner = unittest.TextTestRunner(verbosity=2)
        runner.run(suite)

    但是上述做法有兩個不方便的地方,阻礙腳本的快速執行,必須每次修改testsuite.py:

    需要導入所有的相關的py文件,例如import testbaidu1,每新增一個腳本就需要導入一個

    addTest一次只能增加一個測試方法,如果一個py文件中有10個測試方式,如果都要組裝到測試套件中,就需要增加10次

    makeSuite()和TestLoader()的應用

    在unittest 框架中提供了makeSuite() 的方法,makeSuite可以實作把測試案例類別內所有的測試case組成的測試套件TestSuite ,unittest 呼叫makeSuite的時候,只需要把測試類別名稱傳入即可。

    TestLoader 用來建立類別和模組的測試套件,一般的情況下,使TestLoader().loadTestsFromTestCase(TestClass) 來載入測試類別。

    runall.py

    import unittest,csv
    import os,sys
    import time
    import testbaidu1
    import testbaidu2
    #手工添加案例到套件,
    def createsuite():
        suite = unittest.TestSuite()
        #将测试用例加入到测试容器(套件)中
        suite.addTest(unittest.makeSuite(testbaidu1.Baidu1))
        suite.addTest(unittest.makeSuite(testbaidu2.Baidu2))
        return suite
    '''
    suite1 = unittest.TestLoader().loadTestsFromTestCase(testbaidu1.Baidu1)
    suite2 = unittest.TestLoader().loadTestsFromTestCase(testbaidu2.Baidu2)
    suite = unittest.TestSuite([suite1, suite2])
    return suite
    '''
    if __name__=="__main__":
        suite=createsuite()
        runner = unittest.TextTestRunner(verbosity=2)
        runner.run(suite)

    經過makeSuite()和TestLoader()的引入,我們不用一個py檔案測試類,只需要導入一次。

    discover()的應用

    discover 是通过递归的方式到其子目录中从指定的目录开始, 找到所有测试模块并返回一个包含它们对象的TestSuite ,然后进行加载与模式匹配唯一的测试文件,discover 参数分别为discover(dir,pattern,top_level_dir=None)

    runall.py—注意路径

    import unittest,csv
    import os,sys
    import time
    #手工添加案例到套件,
    def createsuite():
        discover=unittest.defaultTestLoader.discover("../testUnittest",pattern='test*.py',top_level_dir=None)
        print (discover)
        return discover
    if __name__=="__main__":
        suite=createsuite()
        runner = unittest.TextTestRunner(verbosity=2)
        runner.run(suite)

    2.2 用例的执行顺序

    unittest 框架默认加载测试用例的顺序是根据ASCII 码的顺序,数字与字母的顺序为: 0 ~ 9,A ~ Z,a ~ z 。

    对于测试目录与测试文件来说, unittest 框架同样是按照这个规则来加载测试用例

    2.3 忽略用例执行

    语法:

    @unittest.skip(u'The function was canceled, neglects to perform thecase')
    from selenium import webdriver
    from selenium.webdriver.common.by import By
    from selenium.webdriver.common.keys import Keys
    from selenium.webdriver.support.ui import Select
    from selenium.common.exceptions import NoSuchElementException
    from selenium.common.exceptions import NoAlertPresentException
    import unittest, time, re
    class Baidu1(unittest.TestCase):
    #test fixture,初始化环境
        def setUp(self):
            self.driver = webdriver.Chrome()
            self.driver.implicitly_wait(30)
            self.base_url = "http://www.baidu.com/"
            self.verificationErrors = []
            self.accept_next_alert = True
        @unittest.skip("skipping")
        def test_baidusearch(self):
            driver = self.driver
            driver.get(self.base_url + "/")
            driver.find_element(By.ID,"kw").click()
            driver.find_element(By.ID,"kw").clear()
            driver.find_element(By.ID,"kw").send_keys(u"测试")
            driver.find_element(By.ID,"su").click()
            driver.find_element(By.ID,"su").click()
        def test_hao(self):
            driver = self.driver
            driver.get(self.base_url + "/")
            driver.find_element(By.LINK_TEXT,"hao123").click()
            self.assertEqual(u"hao123_上网从这里开始", driver.title)
    #判断element是否存在,可删除
        def is_element_present(self, how, what):
            try: self.driver.find_element(by=how, value=what)
            except NoSuchElementException as e: return False
            return True
    #判断alert是否存在,可删除
        def is_alert_present(self):
            try: self.driver.switch_to_alert()
            except NoAlertPresentException as e: return False
            return True
    #关闭alert,可删除
        def close_alert_and_get_its_text(self):
            try:
                alert = self.driver.switch_to_alert()
                alert_text = alert.text
                if self.accept_next_alert:
                    alert.accept()
                else:
                    alert.dismiss()
                return alert_text
            finally: self.accept_next_alert = True
    #test fixture,清除环境
        def tearDown(self):
            self.driver.quit()
            self.assertEqual([], self.verificationErrors)
    if __name__ == "__main__":
        #执行用例
        unittest.main()

    3 unittest断言

    自动化的测试中, 对于每个单独的case来说,一个case的执行结果中, 必然会有期望结果与实际结果, 来判断该case是通过还是失败, 在unittest 的库中提供了大量的实用方法来检查预期值与实际值, 来验证case的结果, 一般来说, 检查条件大体分为等价性, 逻辑比较以及其他, 如果给定的断言通过, 测试会继续执行到下一行的代码, 如果断言失败, 对应的case测试会立即停止或者生成错误信息( 一般打印错误信息即可) ,但是不要影响其他的case执行。

    unittest 的单元测试库提供了标准的xUnit 断言方法。下面是一些常用的断言

    断言方法 断言描述
    assertEqual(arg1, arg2, msg=None) 验证arg1=arg2,不等则fail
    assertNotEqual(arg1, arg2, msg=None) 验证arg1 != arg2, 相等则fail
    assertTrue(expr, msg=None) 验证expr是true,如果为false,则fail
    assertFalse(expr,msg=None) 验证expr是false,如果为true,则fail
    assertIs(arg1, arg2, msg=None) 验证arg1、arg2是同一个对象,不是则fail
    assertIsNot(arg1, arg2, msg=None) 验证arg1、arg2不是同一个对象,是则fail
    assertIsNone(expr, msg=None) 验证expr是None,不是则fail
    assertIsNotNone(expr, msg=None) 验证expr不是None,是则fail
    assertIn(arg1, arg2, msg=None) 验证arg1是arg2的子串,不是则fail
    assertNotIn(arg1, arg2, msg=None) 验证arg1不是arg2的子串,是则fail
    assertIsInstance(obj, cls, msg=None) 验证obj是cls的实例,不是则fail
    assertNotIsInstance(obj, cls,msg=None) 验证obj不是cls的实例,是则fail

    4 HTML报告生成

    脚本执行完毕之后,还需要看到HTML报告,下面我们就通过HTMLTestRunner.py 来生成测试报告。

    修改runall.py

    import unittest,csv
    import os,sys
    import time
    import HTMLTestRunner
    #手工添加案例到套件,
    def createsuite():
        discover=unittest.defaultTestLoader.discover('../testUnittest',pattern='test*.py',top_level_dir=None)
        print (discover)
        return discover
    if __name__=="__main__":
        curpath=sys.path[0]
        #取当前时间
        now=time.strftime("%Y-%m-%d-%H %M %S",time.localtime(time.time()))
        if not os.path.exists(curpath+'/resultreport'):
            os.makedirs(curpath+'/resultreport')
        filename=curpath+'/resultreport/'+now+'resultreport.html'
        with open(filename,'wb') as fp:
        #出html报告
            runner=HTMLTestRunner.HTMLTestRunner(stream=fp,title=u'测试报告',description=u'用例执行情况',verbosity=2)
            suite=createsuite()
            runner.run(suite)

    5 异常捕捉与错误截图

    用例不可能每一次运行都成功,肯定运行时候有不成功的时候。如果可以捕捉到错误,并且把错误截图保存,这将是一个非常棒的功能,也会给我们错误定位带来方便。

    例如编写一个函数,关键语句为driver.get_screenshot_as_file:

    def savescreenshot(self,driver,file_name):
    if not os.path.exists('./image'):
    	os.makedirs('./image')
    now=time.strftime("%Y%m%d-%H%M%S",time.localtime(time.time()))
    #截图保存
    driver.get_screenshot_as_file('./image/'+now+'-'+file_name)
    time.sleep(1)

    示例:testscreenshot.py

    from selenium import webdriver
    from selenium.webdriver.common.by import By
    from selenium.webdriver.common.keys import Keys
    from selenium.webdriver.support.ui import Select
    from selenium.common.exceptions import NoSuchElementException
    from selenium.common.exceptions import NoAlertPresentException
    import unittest, time, re
    import os
    class Baidu1(unittest.TestCase):
        #test fixture,初始化环境
        def setUp(self):
            self.driver = webdriver.Chrome()
            self.driver.implicitly_wait(30)
            self.base_url = "http://www.baidu.com/"
            self.verificationErrors = []
            self.accept_next_alert = True
        #测试用例,必须以test开头
        def test_hao(self):
            driver = self.driver
            driver.get(self.base_url + "/")
            driver.find_element(By.LINK_TEXT,"hao123").click()
            time.sleep(2)
            try:
                self.assertEqual(u'hao_上网从这里开始', driver.title)
            except:
                self.savescreenshot(driver,'hao.png')
        #判断element是否存在,可删除
        def is_element_present(self, how, what):
            try: self.driver.find_element(by=how, value=what)
            except NoSuchElementException as e: return False
            return True
        #判断alert是否存在,可删除
        def is_alert_present(self):
            try: self.driver.switch_to_alert()
            except NoAlertPresentException as e: return False
            return True
        #关闭alert,可删除
        def close_alert_and_get_its_text(self):
            try:
                alert = self.driver.switch_to_alert()
                alert_text = alert.text
                if self.accept_next_alert:
                    alert.accept()
                else:
                    alert.dismiss()
                return alert_text
            finally: self.accept_next_alert = True
        #test fixture,清除环境
        def tearDown(self):
            self.driver.quit()
            self.assertEqual([], self.verificationErrors)
        def savescreenshot(self,driver,file_name):
            if not os.path.exists('./image'):
                os.makedirs('./image')
                now=time.strftime("%Y%m%d-%H%M%S",time.localtime(time.time()))
                #截图保存
                driver.get_screenshot_as_file('./image/'+now+'-'+file_name)
                time.sleep(1)
    if __name__ == "__main__":
        #执行用例
        unittest.main()
    '''
    可以增加verbosity参数,例如unittest.main(verbosity=2)
    在主函数中,直接调用main() ,在main中加入verbosity=2 ,这样测试的结果就会显示的更加详细。
    这里的verbosity 是一个选项, 表示测试结果的信息复杂度,有三个值:
    0 ( 静默模式): 你只能获得总的测试用例数和总的结果比如总共100个失败,20 成功80
    1 ( 默认模式): 非常类似静默模式只是在每个成功的用例前面有个“ . ” 每个失败的用例前面有个“F”
    2 ( 详细模式): 测试结果会显示每个测试用例的所有相关的信息
    '''

    6 数据驱动

    之前我们的case都是数据和代码在一起编写。考虑如下场景:

    需要多次执行一个案例,比如baidu搜索,分别输入中文、英文、数字等进行搜索,这时候需要编写3个案例吗?有没有版本一次运行?

    python 的unittest 没有自带数据驱动功能。所以如果使用unittest,同时又想使用数据驱动,那么就可以使用DDT来完成。

    ddt的安装:

    pip install ddt
    python setup.py install

    dd.ddt:

    装饰类,也就是继承自TestCase的类。

    ddt.data:

    装饰测试方法。参数是一系列的值。

    data(value) 一次性传入一个参数data(value1,value2,…) 一次性传入多个参数,需要用@unpack映射data(*解析数据的方法(txt/csv文件))

    ddt.file_data:

    装饰测试方法。参数是文件名。文件可以是json 或者 yaml类型。

    注意,如果文件以”.yml”或者”.yaml”结尾,ddt会作为yaml类型处理,其他所有文件都会作为json文件处理。

    如果文件中是列表,每个列表的值会作为测试用例参数,同时作为测试用例方法名后缀显示。

    如果文件中是字典,字典的key会作为测试用例方法的后缀显示,字典的值会作为测试用例参数。

    ddt.unpack:

    传递的是复杂的数据结构时使用。比如使用元组或者列表,添加unpack之后,ddt会自动把元组或者列表对应到多个参数上。字典也可以这样处理。

    Testddt.py:

    from selenium import webdriver
    from selenium.webdriver.common.by import By
    from selenium.webdriver.common.keys import Keys
    from selenium.webdriver.support.ui import Select
    from selenium.common.exceptions import NoSuchElementException
    from selenium.common.exceptions import NoAlertPresentException
    import unittest, time, re
    import os,sys,csv
    from ddt import ddt, data, unpack ,file_data
    def getCsv(file_name):
        rows=[]
        path=sys.path[0].replace('\testddt','')
        print (path)
        with open(path+'/data/'+file_name,'r+b') as f:
            readers=csv.reader(f,delimiter=',',quotechar='|')
            next(readers,None)
            for row in readers:
                temprows=[]
                for i in row:
                    temprows.append(i.decode('gbk'))
                rows.append(temprows)
                return rows
    #引入ddt
    @ddt
    class Testddt(unittest.TestCase):
        def setUp(self):
            self.driver = webdriver.Chrome()
            self.driver.implicitly_wait(30)
            self.base_url = "http://www.baidu.com"
            self.verificationErrors = []
            self.accept_next_alert = True
        #测试用例,必须以test开头
        #增加ddt数据
        @data('selenium','unittest','Junit')
        #@data(2,3,4)
        #单变更时不使用unpack
        #@data([3, 2], [4, 3], [5, 3])
        # @data(*getCsv('test_baidu_data.csv'))
        #使用file_data需要在cmd窗口下运行,否则找不到文件
        #@file_data('test_data_list.json')
        # @unpack
        def test_hao(self,value,expected_value):
        # def test_hao(self,value):
            driver = self.driver
            driver.get(self.base_url + "/")
            driver.find_element(By.ID,"kw").clear()
            driver.find_element(By.ID,"kw").send_keys(value)
            driver.find_element(By.ID,"su").click()
            time.sleep(2)
            self.assertEqual(expected_value, driver.title)
            print (expected_value)
            print (driver.title)
        #判断element是否存在,可删除
        def is_element_present(self, how, what):
            try: self.driver.find_element(by=how, value=what)
            except NoSuchElementException as e: return False
            return True
        #判断alert是否存在,可删除
        def is_alert_present(self):
            try: self.driver.switch_to_alert()
            except NoAlertPresentException as e: return False
            return True
        #关闭alert,可删除
        def close_alert_and_get_its_text(self):
            try:
                alert = self.driver.switch_to_alert()
                alert_text = alert.text
                if self.accept_next_alert:
                    alert.accept()
                else:
                    alert.dismiss()
                return alert_text
            finally: self.accept_next_alert = True
        #test fixture,清除环境
        def tearDown(self):
            self.driver.quit()
            self.assertEqual([], self.verificationErrors)
        def savescreenshot(self,driver,file_name):
            if not os.path.exists('./image'):
                os.makedirs('./image')
            now=time.strftime("%Y%m%d-%H%M%S",time.localtime(time.time()))
            #截图保存
            driver.get_screenshot_as_file('./image/'+now+'-'+file_name)
            time.sleep(1)
    if __name__ == "__main__":
        #执行用例
        unittest.main()

    以上是Python自動化測試框架之unittest如何使用?的詳細內容。更多資訊請關注PHP中文網其他相關文章!

    陳述:
    本文轉載於:yisu.com。如有侵權,請聯絡admin@php.cn刪除