現在很多介面回傳的型別是 XML 字串。當回傳值很小的時候,把期望結果直接寫在程式碼裡還算可行;但當回傳結果相當龐大時,期望值該放哪裡就成了問題。
我也曾經把期望值硬寫進程式碼,結果造成單一測試案例的程式碼行數暴增,一個案例幾乎只看得見期望資料,可讀性完全崩壞。那存到檔案裡如何?新的疑問隨之而來:存成檔案之後要怎麼比?用純文字內容比對嗎?總覺得不踏實,起碼 XML 的特性完全沒被利用上——它甚至無法告訴你是哪個節點出了差錯。
後來才發現 XMLUnit 早就具備這個能力(有點後知後覺),搭配其他 XML 相關套件還能處理得很快,程式碼也相當精簡。
public void test() throws Exception
{
String actXmlText = "<?XML version=\"1.0\" encoding=\"utf-8\"?>" + "\r\n"+
"<error_response>" + "\r\n"+
" <args>" + "\r\n"+
" <arg></arg>" + "\r\n"+
" </args>" + "\r\n"+
" <code>16</code>" + "\r\n"+
" <msg>wang wang service return error</msg>" + "\r\n"+
" <sub_code>33000</sub_code>" + "\r\n"+
" <sub_msg>wang wang service error: param error.</sub_msg>" + "\r\n"+
"</error_response>";
System.out.println(actXmlText);
DocumentBuilderFactory domfac = DocumentBuilderFactory.newInstance();
DocumentBuilder dombuilder = domfac.newDocumentBuilder();
InputStream is = new FileInputStream("c:/11.XML");
Document doc = dombuilder.parse(is);
InputStream is1 = new FileInputStream("c:/12.XML");
Document doc1 = dombuilder.parse(is1);
Document doc2 = dombuilder.parse(new ByteArrayInputStream(actXmlText.getBytes()));
XMLAssert.assertXMLEqual(doc2, doc);
XMLAssert.assertXMLEqual(doc2, doc1);
}
這裡為了展示程式碼,actXmlText 寫成了字串常數。實際測試場景中,它代表的是呼叫介面的回傳值,程式碼會長得像這樣:
WebConversation conversation = new WebConversation(); WebRequest request = new PostMethodWebRequest(Url); WebResponse response = conversation.getResponse(request); System.out.println(response.getText()); String actXmlText = response.getText();
也就是說,把「實際回應」與「檔案中的期望結果」都解析成 DOM,再交給 XMLUnit 做結構層級的比對,中間不必自己寫任何解析或逐字比對的邏輯。
測試不通過時,它會明確告訴你哪個節點、哪個位置出了差錯:
junit.framework.AssertionFailedError: org.custommonkey.xmlunit.Diff [different] Expected text value '16' but was '15' – comparing 16 at /error_response[1]/code[1]/text()[1] to 15 at /error_response[1]/code[1]/text()[1]
這正是純文字比對做不到的事:它給出的是 XPath 路徑,你直接就能定位到 /error_response/code 這個節點,知道期望是 16 而實際是 15。對需要比對大量 XML 回應的介面測試來說,這一點差異往往就是「十分鐘找到問題」與「整個下午靠眼睛找不同」的差別。
另外提醒一個實務細節:如果你的 XML 中元素順序有意義,記得在比對時開啟嚴格模式;反之若順序不應影響結果,則應放寬設定。XMLUnit 預設對這類差異的判定偏嚴,剛開始使用時不少人會被「內容明明一樣卻報錯」困住一陣子,原因通常就在這裡。