用 NUnit 測試資料存取層(DAL)時,最惱人的問題是:測試跑完之後,資料庫裡留下一堆垃圾資料。網路上常見的解法是透過交易回滾處理。本文整理這個思路,並說明它為什麼比直覺做法更省事。
對資料存取元件做單元測試,會遇到三個彼此糾纏的困難:
最直觀的做法:測試結束後執行相反的操作。插入了就刪掉。但這帶來一堆新問題:
Insert() 方法插入的,那清理時該用同樣待驗證的 Delete() 方法嗎?那個方法可能還沒測過,甚至還沒寫出來——典型的「雞生蛋」困境。TestFixtureTearDown)統一清理,就需要維護大量資料與自訂程式碼,同樣複雜。James Newkirk 在《Test Driven Development with Microsoft.NET》一書中提出了另一個思路:把所有操作包在一個交易裡,每個測試結束後就回滾該交易。這個方案很漂亮,但有兩個實務難題:
讀到 Newkirk 書中討論交易實作的那一章時,有這麼一句話(節錄):
「我們想為每個受測元件達成與 COM+ 中
RequiresTransaction相同的效果。」
這句話點出一個關鍵:為什麼要自己寫交易協調器?讓 COM+(.NET 中的 Enterprise Services)去做這件事不就好了?
using System;
using NUnit.Framework;
using System.EnterpriseServices;
namespace TransactionTesting
{
[TestFixture]
[Transaction(TransactionOption.Required)]
public class DatabaseFixture : ServicedComponent
{
[TearDown]
public void TransactionTearDown()
{
if (ContextUtil.IsInTransaction)
{
ContextUtil.SetAbort();
}
}
}
}
這個類別的設計要點:
ServicedComponent,這是 COM+ 服務元件的要求。[Transaction(TransactionOption.Required)] 表示:每當這個類別被建立或呼叫,COM+ 會自動為它建立交易上下文,或把它加入既有的交易上下文。TearDown 中呼叫 ContextUtil.SetAbort(),於是流程變成:
TearDown 被呼叫,交易回滾這樣做的好處:
服務元件必須有強式名稱(strong name),這個類別也不例外:
sn.exe -k 產生金鑰檔,例如 test.snk。AssemblyInfo.cs 中加入(若沒有就補上):
[assembly: AssemblyKeyFile(@"..\..\..\test.snk")]這裡刻意使用相對路徑,讓同一個屬性可以在所有需要的專案間共用。
AssemblyInfo.cs 中找到:
[assembly: AssemblyVersion("1.0.*")]
改成固定值:
[assembly: AssemblyVersion("1.0.0")]
這步很重要。使用 1.0.* 時,Visual Studio 每次建置都會自動遞增版本,而每一個不同版本的測試組件都會在 COM+ 目錄中註冊成一個不同的元件。一天跑五十次測試,COM+ 目錄就會膨脹得面目全非。固定版本號可以省下這場災難。
以下是一個繼承 DatabaseFixture 的測試類別,測試一個對 Northwind 資料庫做分類新增與刪除的類別。注意其中完全沒有清理程式碼:
using System;
using NUnit.Framework;
using System.Data;
using System.Data.SqlClient;
using Microsoft.ApplicationBlocks.Data;
using NorthwindDAL;
namespace TransactionTesting
{
public class CategoryTests : DatabaseFixture
{
string CONN = @"Server=localhost;Database=Northwind;Trusted_Connection=True";
[Test]
public void Insert()
{
CategoryManager mgr = new CategoryManager();
int newID = mgr.Insert("Test category");
VerifyRowExists(CONN, newID, true);
}
[Test]
public void Delete()
{
CategoryManager mgr = new CategoryManager();
int newID = mgr.Insert("Test category");
bool result = mgr.Delete(newID);
Assert.IsTrue(result);
VerifyRowExists(CONN, newID, false);
}
private void VerifyRowExists(string connectionString, int existingRowID, bool shouldExist)
{
string SELECT = "Select * from Categories where categoryID=" + existingRowID.ToString();
SqlDataReader dr = SqlHelper.ExecuteReader(connectionString, CommandType.Text, SELECT);
Assert.AreEqual(shouldExist, dr.HasRows);
dr.Close();
}
}
}
被測試的類別本身寫得很平凡(這裡用 VB.NET 表示):
Public Class CategoryManager
Private CONN As String = "Server=localhost;Database=Northwind;Trusted_Connection=True"
Public Function Insert(ByVal CategoryName As String) As Integer
Dim sql As String = "Insert into Categories (categoryName) values('" + CategoryName + "');" &
"Select scope_identity()"
Return NorthwindDAL.Data.SqlHelper.ExecuteScalar(CONN, CommandType.Text, sql)
End Function
Public Function Delete(ByVal id As Integer) As Boolean
Dim sql As String = "delete from Categories where categoryID=" + id.ToString()
Dim result As Integer = NorthwindDAL.Data.SqlHelper.ExecuteNonQuery(CONN, CommandType.Text, sql)
Return (result = 1)
End Function
End Class
沒有任何戲法,也沒有藏起來的後手。資料庫確實被修改了,只是修改在測試結束後被回滾掉了。
這個技巧用 COM+ 強大的服務,換來了更簡單、更易維護的資料庫單元測試,讓「測試 DAL」這件事不再那麼痛苦。
不過要提醒的是,這個方案在今天已經有更好的替代做法:
DatabaseTransaction。在 EF6 中可以直接用 DbContext.Database.BeginTransaction(),測試結束後呼叫 Rollback(),不必依賴 COM+,跨平台也能用。DatabaseFixture/Respawn。用 Jimmy Bogard 的 Respawn 在每個測試前把資料庫重置成已知快照,比交易回滾更直觀,也能處理非交易型操作。Trusted_Connection=True 這類字串直接寫在程式碼裡。連線字串應放進設定檔或環境變數,且測試用的帳號權限應盡量最小化。另外要修正範例中的一個不良示範:"... values('" + CategoryName + "')" 這種字串拼接是典型的 SQL 注入寫法,即使只是測試程式碼也不該養成習慣,請改用參數化查詢。
核心觀念不變:讓每個測試從已知狀態開始,並在結束後自動恢復。交易回滾是實現這個原則最優雅的方式之一,而現代框架提供了更多選擇。