使用NDBUnit来帮助单元测试进行数据还原

每次在做单元测试的时候，数据还原一直是一个很头痛的问题，在跑每个单元测试之前，每次都需要将数据库恢复到特定的状态，来确保单元测试的数据有效性。

笔者在写单元测试时，曾经用过下面两种方法：

(1) 在跑单元测试前，重建数据库，使用sql脚本导入测试数据

 优点：干净彻底，简单明了

 缺点：每次都要重建数据库，在数据量比较大的情况下，性能会比较低下；数据导入的脚本也由原生的SQL写成，在数据库切换时（例如sql server切换到oracle），需要一定程度的rework，无法做到无缝切换。

(2) 在跑单元测试时，开始trans，在单元测试跑完后，再rollback 。这种方式曾经用了很久，有一点要提一下，这个rollback的时机很重要，若是功能代码中也出现了rollback，那就比较的不愉快了。

用了NDBUnit之后，可以有效地弥补以上两种方法的不足。



使用NDBUnit的优势在于，不必写特定的sql语句来完成数据库的复原工作，只需要通过两个配置文件（schema和Datasets），即可完成数据的还原工作，而且不需要自己写SQL语句，在更换数据库类型时，可以做到无缝切换(不需要修改SQL语法)。

(1) 下载NDBUnit的库: http://code.google.com/p/ndbunit/，然后导入的工程中，这个就不再赘述了。

(2) 创建表：

CREATE TABLE [dbo].[TOPIC](
[ID] [int] IDENTITY(1,1) NOT NULL,
[TITLE] [varchar](255) NOT NULL,
[DESCRIPTION] [varchar](500) NULL,
[CREATE_DT] [datetime] NULL,
CONSTRAINT [PK_TOPIC] PRIMARY KEY CLUSTERED
(
[ID] ASC
)WITH (PAD_INDEX  = OFF, STATISTICS_NORECOMPUTE  = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS  = ON, ALLOW_PAGE_LOCKS  = ON) ON [PRIMARY]
) ON [PRIMARY]

(3) 创建文件Database.xsd(这一步可以考虑使用工具从数据库中导出或使用可视化工具来创建):

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="Database" targetNamespace="http://tempuri.org/Database.xsd" xmlns:mstns="http://tempuri.org/Database.xsd" xmlns="http://tempuri.org/Database.xsd" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:msprop="urn:schemas-microsoft-com:xml-msprop" attributeFormDefault="qualified" elementFormDefault="qualified">
<xs:element name="Database" msdata:IsDataSet="true" msdata:UseCurrentLocale="true" msprop:EnableTableAdapterManager="true" msprop:Generator_DataSetName="Database" msprop:Generator_UserDSName="Database">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="TOPIC" msprop:Generator_TableClassName="TOPICDataTable" msprop:Generator_TableVarName="tableTOPIC" msprop:Generator_TablePropName="TOPIC" msprop:Generator_RowDeletingName="TOPICRowDeleting" msprop:Generator_UserTableName="TOPIC" msprop:Generator_RowChangingName="TOPICRowChanging" msprop:Generator_RowEvHandlerName="TOPICRowChangeEventHandler" msprop:Generator_RowDeletedName="TOPICRowDeleted" msprop:Generator_RowEvArgName="TOPICRowChangeEvent" msprop:Generator_RowChangedName="TOPICRowChanged" msprop:Generator_RowClassName="TOPICRow">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" msprop:Generator_ColumnVarNameInTable="columnID" msprop:Generator_ColumnPropNameInRow="ID" msprop:Generator_ColumnPropNameInTable="IDColumn" msprop:Generator_UserColumnName="ID" type="xs:string" minOccurs="0" />
<xs:element name="TITLE" msprop:Generator_ColumnVarNameInTable="columnTITLE" msprop:Generator_ColumnPropNameInRow="TITLE" msprop:Generator_ColumnPropNameInTable="TITLEColumn" msprop:Generator_UserColumnName="TITLE" type="xs:string" minOccurs="0" />
<xs:element name="DESCRIPTION" msprop:Generator_ColumnVarNameInTable="columnDESCRIPTION" msprop:Generator_ColumnPropNameInRow="DESCRIPTION" msprop:Generator_ColumnPropNameInTable="DESCRIPTIONColumn" msprop:Generator_UserColumnName="DESCRIPTION" type="xs:string" minOccurs="0" />
<xs:element name="CREATE_DT" msprop:Generator_ColumnVarNameInTable="columnCREATE_DT" msprop:Generator_ColumnPropNameInRow="CREATE_DT" msprop:Generator_ColumnPropNameInTable="CREATE_DTColumn" msprop:Generator_UserColumnName="CREATE_DT" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>

(4) 准备测试数据 (Datasets.xml):

<TOPIC>
<ID>1</ID>
<TITLE>Topic Title</TITLE>
<DESCRIPTION>Topic Description</DESCRIPTION>
</TOPIC>

(5) 初始化NDBUnit:

using System;
using System.Collections.Generic;
using System.Configuration;
using System.Linq;
using System.Text;
using NDbUnit.Core;
using System.Diagnostics;

namespace Demo.Test
{
public class DatabaseHelper
{
private static INDbUnitTest Database;

private static void InitSqlServer()
{
Database = new NDbUnit.Core.SqlClient.SqlDbUnitTest(
ConfigurationManager.ConnectionStrings["DBConnStr"].ConnectionString);

}

static DatabaseHelper()
{
InitSqlServer();

Database.ReadXmlSchema(@"Schemas\Demo_schema.xsd");
Database.ReadXml(@"Datasets\Demo_Datasets.xml");
}

public static void DatabaseInitial()
{
ImportDataToDatabase();
}

public static void ImportDataToDatabase()
{
Database.PerformDbOperation(DbOperationFlag.CleanInsertIdentity);
}

public static void ExportDataFromDatabase()
{
Database.GetDataSetFromDb().WriteXml(@"Datasets\Demo_Datasets_export.xml");
}
}
}

(6) 单元测试前，只需要调用DatabaseHelper.DatabaseInitial()就可以很方便地初始化数据库环境了。