系統(tǒng)單元測(cè)試規(guī)范4JAVA單元測(cè)試指引

1、JAVA單元測(cè)試指引1. 背景系統(tǒng)的規(guī)模及復(fù)雜度與時(shí)間及業(yè)務(wù)的拓展成正比。隨著系統(tǒng)的規(guī)模不斷變大，各子系統(tǒng)內(nèi)的業(yè)務(wù)邏輯的新增，系統(tǒng)的代碼總數(shù)也在不斷的增加。部分業(yè)務(wù)在時(shí)間的推移上會(huì)發(fā)生變化引起系統(tǒng)在代碼層面上的重構(gòu)，系統(tǒng)代碼在軟件工程的生命周期中不斷的迭代和變化。代碼的新增以及重構(gòu)都需要通過(guò)嚴(yán)格測(cè)試才能部署上線，公司目前對(duì)于上線功能采取的多數(shù)是黑盒測(cè)試，并未使用白盒測(cè)試對(duì)研發(fā)人員編寫(xiě)的代碼進(jìn)行更高的覆蓋測(cè)試。而研發(fā)人員平時(shí)在功能開(kāi)發(fā)完成后進(jìn)行自測(cè)的時(shí)候使用的方式也因?yàn)閭€(gè)人喜好或各種原因沒(méi)有形成統(tǒng)一。因此，系統(tǒng)若能在編譯、部署、上線的時(shí)候能夠?qū)λ泄δ芏歼M(jìn)行盡可能全面的白盒測(cè)試將會(huì)有助于降低系統(tǒng)

2、在升級(jí)過(guò)程中的故障率，提高系統(tǒng)升級(jí)的速度。若能夠通過(guò)更全面的測(cè)試發(fā)現(xiàn)代碼中的隱藏缺陷，便能提升代碼的健壯性，使系統(tǒng)在長(zhǎng)期運(yùn)行中發(fā)生更少的問(wèn)題。2. 需求研發(fā)人員在功能開(kāi)發(fā)結(jié)束之后應(yīng)當(dāng)同時(shí)提交該功能的單元測(cè)試用例代碼，并且該單元測(cè)試用例代碼需要滿足以下幾點(diǎn)需求：2.1. 功能覆蓋1) 每個(gè)單元測(cè)試代碼中需要覆蓋該功能的所有輸入和輸出，并對(duì)輸出進(jìn)行校驗(yàn)。2) 最終目標(biāo)每個(gè)系統(tǒng)的所有測(cè)試用例代碼需要覆蓋系統(tǒng)的所有功能。（存量系統(tǒng)在后續(xù)分階段補(bǔ)充）2.2. 測(cè)試顆?；?) 單元測(cè)試用例只測(cè)試小顆粒的功能。2) 一個(gè)單元測(cè)試用例只涉及到一個(gè)被測(cè)模塊，避免牽扯到太多的模塊。2.3. 測(cè)試自動(dòng)化1) 單元測(cè)

3、試的輸入，輸出以及校驗(yàn)全部自動(dòng)化，不需要人工干預(yù)。2) 系統(tǒng)編譯的時(shí)候需要自動(dòng)將所有單元測(cè)試執(zhí)行一次，任意單元測(cè)試不通過(guò)不允予通過(guò)發(fā)布。2.4. 持續(xù)維護(hù)1) 新添加的功能和模塊需要添加相對(duì)應(yīng)的單元測(cè)試用例。2) 重構(gòu)或業(yè)務(wù)邏輯變更涉及到的功能和模塊代碼變化需要更新相對(duì)應(yīng)的單元測(cè)試用例。3. 方案基于公司在JAVA語(yǔ)言方面多數(shù)系統(tǒng)是采用Maven進(jìn)行構(gòu)建的現(xiàn)狀以及Maven在系統(tǒng)構(gòu)建的優(yōu)勢(shì)，故采用Maven進(jìn)行系統(tǒng)構(gòu)建+Junit進(jìn)行用例測(cè)試的方案實(shí)現(xiàn)。研發(fā)人員可以借助Cobertura對(duì)自己編寫(xiě)的測(cè)試用例進(jìn)行代碼覆蓋分析，以便對(duì)測(cè)試代碼進(jìn)行調(diào)整和優(yōu)化。3.1. Maven1) Maven不僅

4、僅能構(gòu)建項(xiàng)目，同時(shí)還是一個(gè)依賴管理工具，一個(gè)項(xiàng)目管理工具，提供中央倉(cāng)庫(kù)幫助我們自動(dòng)下載構(gòu)件，也允許我們上傳自己開(kāi)發(fā)的jar包供各系統(tǒng)使用，這些都是自動(dòng)化的非常方便。2) Maven提供的免費(fèi)中央倉(cāng)庫(kù)涵蓋了非常非常多的開(kāi)源庫(kù)，能滿足絕大多數(shù)系統(tǒng)的使用需求。3) Maven對(duì)于目錄結(jié)構(gòu)有要求，約定優(yōu)于配置，項(xiàng)目間切換就省去了學(xué)習(xí)成本。4) Maven項(xiàng)目對(duì)單元測(cè)試支持很友好，約定的test目錄用來(lái)編寫(xiě)單元測(cè)試代碼，maven在進(jìn)行系統(tǒng)編譯的時(shí)候自動(dòng)執(zhí)行test目錄里測(cè)試用例，一旦出現(xiàn)用例不通過(guò)maven自動(dòng)打包發(fā)布。5) Maven構(gòu)建的系統(tǒng)默認(rèn)集成了Junit單元測(cè)試工具。3.2. Junit1

5、) 簡(jiǎn)單易用的單元測(cè)試工具，通過(guò)斷言校驗(yàn)期望值與實(shí)際值的差異。2) 支持圖形交互，測(cè)試結(jié)果簡(jiǎn)潔明了。3) 提供異常堆棧方便跟蹤錯(cuò)誤代碼。3.3. JaCoCo1) 簡(jiǎn)介JaCoCo是一個(gè)開(kāi)源的覆蓋率工具(官網(wǎng)地址： /JaCoCo/ )，它針對(duì)的開(kāi)發(fā)語(yǔ)言是java，其使用方法很靈活，可以嵌入到Ant、Maven中；可以作為Eclipse插件，可以使用其JavaAgent技術(shù)監(jiān)控Java程序等等。2) 覆蓋率概況標(biāo)示綠色的為行覆蓋充分，標(biāo)紅色的為未覆蓋的行，黃色菱形的為分支部分覆蓋，綠色菱形為分支完全覆蓋。3) JaCoCo的使用方式：Ø Ap

6、ache Ant方式Task coverage、Task agent、Task dump、Task merge、Task report、Task instrumentØ 命令行方式使用方式說(shuō)明：主要放在JAVA_OPTS中，比如：由AgentOptions的getVMArgument方法加載，各參數(shù)入AgentOptions的對(duì)應(yīng)參數(shù)，為后續(xù)操作做為輸入。系統(tǒng)在jvm停止的時(shí)候會(huì)dump覆蓋率信息。Ø Apache Maven方式（1）項(xiàng)目已jar包方式打包，引入junit和jacoco。（2）Build時(shí)執(zhí)行instrument、report、check。（3）覆蓋率生成

7、到target/jacoco.exec4. 測(cè)試覆蓋4.1. 代碼覆蓋度單元測(cè)試中對(duì)每個(gè)被測(cè)邏輯體內(nèi)的代碼覆蓋有以下幾種方法，其覆蓋的程度按照順序遞增。這里借助一個(gè)示例對(duì)覆蓋方法做一個(gè)簡(jiǎn)單的說(shuō)明，供各位進(jìn)行參考。假定被測(cè)邏輯入下圖（長(zhǎng)方形內(nèi)為代碼語(yǔ)句）：4.1.1. 語(yǔ)句覆蓋語(yǔ)句覆蓋是最起碼的結(jié)構(gòu)覆蓋要求，語(yǔ)句覆蓋要求設(shè)計(jì)足夠多的測(cè)試用例，使得程序中每條語(yǔ)句至少被執(zhí)行一次。對(duì)應(yīng)的用例如下：4.1.2. 分支（判定）覆蓋它要求設(shè)計(jì)足夠多的測(cè)試用例，使得程序中每個(gè)判定至少有一次為真值，有一次為假值，即：程序中的每個(gè)分支至少執(zhí)行一次。每個(gè)判斷的取真、取假至少執(zhí)行一次。對(duì)應(yīng)的用例如下：4.1.3. 條

8、件覆蓋條件覆蓋要求設(shè)計(jì)足夠多的測(cè)試用例，使得判定中的每個(gè)條件獲得各種可能的結(jié)果，即每個(gè)條件至少有一次為真值，有一次為假值。對(duì)應(yīng)的測(cè)試用例如下：4.1.4. 分支（判定）-條件覆蓋判定-條件覆蓋就是設(shè)計(jì)足夠的測(cè)試用例，得使判斷中每個(gè)條件的所有可能取值至少執(zhí)行一次，同時(shí)每個(gè)判斷本身所有可能結(jié)果也至少執(zhí)行一次。對(duì)應(yīng)的測(cè)試用例如下：4.1.5. 條件組合覆蓋要求設(shè)計(jì)足夠多的測(cè)試用例，使得每個(gè)判定中條件結(jié)果的所有可能組合至少出現(xiàn)一次。滿足“條件組合覆蓋”的測(cè)試用例是一定滿足“判定覆蓋”、“條件覆蓋”和“判定/條件覆蓋”的。對(duì)應(yīng)的測(cè)試用例如下：4.1.6. 路徑覆蓋路徑覆蓋的含義是，選取足夠多的測(cè)試數(shù)據(jù)，

9、使程序的每條可能路徑都至少執(zhí)行一次（如果程序圖中有環(huán)，則要求每個(gè)環(huán)至少經(jīng)過(guò)一次）。對(duì)應(yīng)的測(cè)試用例如下：4.2. 原則由于根據(jù)程序的邏輯復(fù)雜程度以及程序設(shè)計(jì)上的差異性，某些代碼想要完成特定的測(cè)試覆蓋幾乎是無(wú)法完成的，所以原則上不要求所有測(cè)試用例都能完成最高的代碼覆蓋度。因此在條件允許的情況，盡量完成更高的測(cè)試覆蓋度，最低要求是語(yǔ)句覆蓋。5. 建議執(zhí)行規(guī)范考慮到規(guī)范的的復(fù)雜度與實(shí)施效果不成正比的關(guān)系，在單元測(cè)試方案的規(guī)范中只取最核心的幾項(xiàng)進(jìn)行規(guī)范化以便降低實(shí)施的難度的同時(shí)提高交付的系統(tǒng)的質(zhì)量。5.1. 提交test測(cè)試包Maven項(xiàng)目在main目錄同級(jí)下默認(rèn)了一個(gè)test包用于存放測(cè)試代碼以及測(cè)試

10、用配置文件，maven項(xiàng)目所編寫(xiě)的所有測(cè)試用代碼和配置文件必須提交到SVN。5.2. 每個(gè)模塊或類提交對(duì)應(yīng)的測(cè)試類每個(gè)模塊或服務(wù)類有對(duì)應(yīng)同名的測(cè)試類。測(cè)試類中每個(gè)方法只進(jìn)行一項(xiàng)最簡(jiǎn)單的單元測(cè)試，并且測(cè)試的方法必須有含義且與測(cè)試的邏輯相符合。5.3. 測(cè)試用例至少達(dá)到語(yǔ)句覆蓋編寫(xiě)測(cè)試代碼的研發(fā)人員需要使用Cobertura或其他工具自檢提交的單元測(cè)試代碼，最低要求測(cè)試的覆蓋率達(dá)到語(yǔ)句覆蓋級(jí)別。5.4. 系統(tǒng)編譯時(shí)需要執(zhí)行所有測(cè)試類編譯機(jī)進(jìn)行系統(tǒng)編譯打包的時(shí)候需要執(zhí)行test包底下的所有測(cè)試用例，必須所有測(cè)試用例都通過(guò)才允許打包部署。6. 實(shí)施6.1. 新項(xiàng)目新項(xiàng)目采用maven構(gòu)建，并且系統(tǒng)在生命周期內(nèi)按照規(guī)范持續(xù)交付產(chǎn)出