關(guān)于MATLAB單元測(cè)試的過(guò)程以及結(jié)果分析

在inputParser章節(jié)中，我們通過(guò)不斷改進(jìn)getArea函數(shù)對(duì)輸入參數(shù)的處理方法，引入這樣一個(gè)觀點(diǎn)：一個(gè)可靠的科學(xué)工程計(jì)算項(xiàng)目必須有一套測(cè)試系統(tǒng)，才能防止開(kāi)發(fā)的過(guò)程中算法退化，工程項(xiàng)目的推進(jìn)必須在算法開(kāi)發(fā)和算法測(cè)試之間不斷迭代完。在inputParser章節(jié)的最后,還根據(jù)直覺(jué)提出了一個(gè)測(cè)試系統(tǒng)所應(yīng)該有的基本功能。在本章中，我們將學(xué)習(xí)MATLAB提供的測(cè)試解決方案：MATLAB單元測(cè)試（MATLAB Unit Test）。

基于函數(shù)的（Function-Based）單元測(cè)試的構(gòu)造

MATLAB基于函數(shù)的單元測(cè)試構(gòu)造很簡(jiǎn)單，如圖1所示：用戶通過(guò)一個(gè)主測(cè)試函數(shù)和若干局部測(cè)試函數(shù)（也叫做測(cè)試點(diǎn)，Local Function）來(lái)組織各個(gè)測(cè)試。而測(cè)試的運(yùn)行則交給MATLAB的單元測(cè)試架構(gòu)（以下簡(jiǎn)稱Framework）去完成。

圖1 單元測(cè)試Framework和測(cè)試函數(shù)

主測(cè)試函數(shù)和局部測(cè)試函數(shù)看上去和普通的MATLAB函數(shù)沒(méi)有區(qū)別，其結(jié)構(gòu)如圖2所示，只是命名上有一些規(guī)定而已，這些特殊的規(guī)定是為了Framework可以和測(cè)試函數(shù)契合而規(guī)定的。

圖2 簡(jiǎn)單的主測(cè)試函數(shù)和若干局部的測(cè)試函數(shù)構(gòu)成的一個(gè)單元測(cè)試

命名規(guī)則如下：

主函數(shù)的名稱由用戶任意指定，和其他的MATLAB函數(shù)文件一樣，該文件的名稱需要和函數(shù)的名稱的相同（如果主函數(shù)的名稱是testmainfunc，該文件名稱則是testmainfunc.m）

在主函數(shù)中，必須調(diào)用一個(gè)叫做functiontests的函數(shù)，搜集該函數(shù)中的所有局部函數(shù)，產(chǎn)生一個(gè)包含這些局部函數(shù)的函數(shù)局部的測(cè)試矩陣并返回給Framework

如下所示：

其中l(wèi)ocalfunctions是一個(gè)MATLAB函數(shù)，用來(lái)返回所有局部函數(shù)的函數(shù)句柄。局部函數(shù)的命名必須以test開(kāi)頭，局部函數(shù)只接受一個(gè)輸入?yún)?shù)，即測(cè)試對(duì)象,即下面例子中的形參testCase：

其中testCase由單元測(cè)試Framework提供,即Framework將自動(dòng)的調(diào)用該函數(shù)，并且提供testCase參數(shù)。按照規(guī)定，要運(yùn)行單元測(cè)試中的所有測(cè)試，必須調(diào)用runtests函數(shù)：

下面用我們用基于函數(shù)的單元測(cè)試來(lái)給getArea函數(shù)的構(gòu)造其單元測(cè)試。

getArea函數(shù)的單元測(cè)試：版本 I

首先給主測(cè)試文件起個(gè)名字叫做testGetArea，該名字是任意的，為了便于理解名字里面通常包含test,并包含要測(cè)試的主要函數(shù)的名字：

在該主函數(shù)中，localfunctions將搜集所有的局部函數(shù)，構(gòu)造函數(shù)句柄數(shù)組并返回測(cè)試矩陣。這里自然會(huì)有一個(gè)問(wèn)題，這個(gè)tests句柄數(shù)組將返回給誰(shuí)，這就要了解Framework是如何和測(cè)試相互作用的。如圖3所示，整個(gè)測(cè)試從runtests('testmainfunc.m')命令開(kāi)始， 命令函數(shù)，F(xiàn)ramework將首先調(diào)用testGetArea的主函數(shù)，得到所有的局部函數(shù)的函數(shù)句柄，如空心箭頭線段所示，然后Framework再負(fù)責(zé)調(diào)用每一個(gè)測(cè)試局部函數(shù)，并且把testCase當(dāng)做參數(shù)提供給每個(gè)局部函數(shù)，如虛線線段所示。我們可以把Framework想象成一個(gè)流水線，用戶只需要通過(guò)runtests('testmainfunc.m')把“testmainfunc.m”放到流水線上并且“打開(kāi)開(kāi)關(guān)”就可以了。它是MATLAB的類matlab.unittest.FunctionTestCase的對(duì)象。

圖3 單元測(cè)試Framework和測(cè)試函數(shù)的相互作用

返回的testCase是類matlab.unittest.FunctionTestCase的對(duì)象，有很多成員驗(yàn)證方法可以提供給用戶調(diào)用，我們的第一版的getArea函數(shù)如下, 要求函數(shù)接受兩個(gè)參數(shù)，并且都是數(shù)值類型：

我們先給這個(gè)getArea寫(xiě)第一個(gè)測(cè)試點(diǎn)，確保測(cè)試getArea函數(shù)在接受兩個(gè)參數(shù)的時(shí)候，能給出正確的答案：

我們給testGetArea.m添加一個(gè)局部函數(shù)叫做testTwoInputs，按照規(guī)定，該局部函數(shù)的名字要以test開(kāi)頭，后面的名字要能夠盡量反應(yīng)該測(cè)試點(diǎn)的實(shí)際測(cè)試的內(nèi)容。verifyTrue是一個(gè)testCase對(duì)象所支持的方法，它用來(lái)驗(yàn)證其第一個(gè)參數(shù)，作為一個(gè)表達(dá)式，是否為真。verifyTrue的第二個(gè)參數(shù)接受字符串，在測(cè)試失敗時(shí)提供診斷提示。一個(gè)很常見(jiàn)的問(wèn)題是：getArea是一個(gè)極其簡(jiǎn)單的函數(shù)，內(nèi)部的工作就是把兩個(gè)輸入相乘，在這里驗(yàn)證getArea(10,22) == 220真的有必要嗎？請(qǐng)讀者記住這個(gè)問(wèn)題，它是理解單元測(cè)試的精要之一。下面我們來(lái)運(yùn)行這個(gè)測(cè)試:

測(cè)試返回一個(gè)matlab.unittest.TestResult對(duì)象，其中包括運(yùn)行測(cè)試的結(jié)果，不出意料我們的函數(shù)通過(guò)了這輪簡(jiǎn)單的測(cè)試。如果函數(shù)沒(méi)有通過(guò)測(cè)試，比如我們故意要驗(yàn)證一個(gè)錯(cuò)誤的結(jié)果：getArea(10,22) ==0。

Framework將給出詳盡的錯(cuò)誤報(bào)告, 其中Test Diagnostic欄目中報(bào)告的就是verifyTrue函數(shù)中的第二個(gè)參數(shù)所提供的診斷信息。

我們?cè)偬砑右粋€(gè)負(fù)面測(cè)試，回憶第一版的函數(shù)getArea不支持單個(gè)參數(shù)，如下：

我們可以利用lasterr函數(shù)得到了這個(gè)錯(cuò)誤的Error ID,這個(gè)Error ID將在負(fù)面測(cè)試中用到。下面是這個(gè)負(fù)面測(cè)試，驗(yàn)證在只有一個(gè)輸入的情況下，getArea函數(shù)能夠如預(yù)期報(bào)錯(cuò)。我們給測(cè)試添加一個(gè)新的測(cè)試點(diǎn)，叫做testTwoInputsInvalid。

在testTwoInputsInvalid中，我們使用了測(cè)試對(duì)象的verifyError成員函數(shù)，它的第一個(gè)參數(shù)是函數(shù)句柄，即要執(zhí)行的語(yǔ)言（會(huì)出錯(cuò)的語(yǔ)句），第二個(gè)參數(shù)是要驗(yàn)證的MATLAB錯(cuò)誤的Error ID, 就是我們前面用lasterr函數(shù)得到的信息。verifyError內(nèi)部還有try和catch,可以運(yùn)行函數(shù)句柄，捕捉到錯(cuò)誤，并且把Error ID和第二個(gè)參數(shù)做比較。再舉一個(gè)例子，我們先在getArea函數(shù)中規(guī)定所有的輸入必須是數(shù)值類型，所以如果輸入的是字符串，getArea將報(bào)錯(cuò)，先再命令行中實(shí)驗(yàn)一下，以便得到Error ID：

然后再把這個(gè)負(fù)面測(cè)試添加到testGetArea中去：

運(yùn)行一遍，一個(gè)正面測(cè)試，一個(gè)負(fù)面測(cè)試都全部通過(guò)。

getArea函數(shù)的單元測(cè)試: 版本II & III

測(cè)試的準(zhǔn)備和清理工作: Tests Fixtures

驗(yàn)證方法: Types of Qualification

測(cè)試方法論和以測(cè)試驅(qū)動(dòng)開(kāi)發(fā)(Test-Driven Development)