存储过程方法的 C# 单元测试

Question

我没有使用 Entity Framework，而是使用企业库来执行数据操作。

以下是我的示例 BL 方法，用于更新人员文化。我不知道如何为这些方法编写单元测试。

public static Culture UpdatePersonCulture(Guid userId, Culture culture)
{
    try
    {
        if (userId == Guid.Empty)
            throw new exception("User id should not be empty");

        DatabaseProviderFactory factory = new DatabaseProviderFactory();
        Database database = factory.CreateDefault();

        using (DbConnection dbConnection = database.CreateConnection())
        {
            if (dbConnection.State == ConnectionState.Closed)
                dbConnection.Open();

            DbCommand dbCommand = database.GetStoredProcCommand("usp_UpdatePersonCulture");
            database.DiscoverParameters(dbCommand);
            dbCommand.Parameters["@userId"].Value = userId;
            dbCommand.Parameters["@cultureId"].Value = culture.Id;

            DataSet dataSet = database.ExecuteDataSet(dbCommand);

            return BLDataPopulation.PopulateCultures(dataSet.Tables[0]).FirstOrDefault();
        }
    }
    catch (Exception exception)
    {
        throw BLLogger.Log(exception);
    }
}

Answer 1

Change your classes to be unit test-able

单元测试意味着给定输入，我的代码将以已知行为运行并产生预先已知的输出。它应该执行得很快，因为它经常执行(甚至可以在代码更改时执行，如 NCrunch )。单元测试范围应该是一个类。

Integration tests是您在更高范围内测试的测试。您测试多个类、程序的一部分，甚至不同的程序是否可以很好地协同工作。然而，这些测试的稳定性(因为它可能依赖于可能不时发生故障的外部组件)、充其量仍然模糊的“运行良好”的定义以及此类测试的维护成本，使得附加值集成测试真的很低。事实上，我经常看到没有任何测试甚至集成测试的项目因为维护成本而退役。

但是，您可以将不可测试的代码限制在最低限度:

• 将接口(interface)与实现分开:将外部资源(如文件 I/O 或数据库)访问隔离在接口(interface)后面，隐藏实现的复杂性。

• 避免静态代码，因为不可能对静态代码进行单元测试。实现是用静态类来操纵的。如果静态代码调用外部资源，则无法控制输入输出，无法测试结果。

• 学习重构:如果您具备相应的技能，遗留代码就可以轻松处理。隔离一小段代码，为其编写单元测试，并用更健壮的代码替换它。

• Test first or Test driven development, TDD可以让新写的代码从一开始就可以测试。这是一个涉及在编写类的实现之前编写您对给定类的期望的过程。

• Behavior driven development or BDD :有时，当您的篮子里只有客户要求时，您无法轻易达到单元测试所需的最低级别。您可以使用 Specflow 等工具构建需求语法并将其转换为测试。

为了成功编写单元测试并重构遗留的不可测试代码，您将需要 IOC 工具(因为构造函数签名倾向于随着这些技术而增长)和 Mock 框架，如 Moq为了模拟您将添加的接口(interface)，而不将它们绑定(bind)到任何实现。

例如，在您的情况下，我重构了包含要测试的方法的类:

public class ClassToTest : IInterfaceToTest
{
    private readonly IBLLogger _logger;
    private readonly IBLDataPopulation _blDataPopulation;
    private readonly IDatabase _database;

    public ClassToTest(IBLLogger logger, IBLDataPopulation blDataPopulation, IDatabase database)
    {
        _logger = logger;
        _blDataPopulation = blDataPopulation;
        _database = database;
    }

    // this cannot be static if you want
    // to unit test the classes depending on this one.
    public Culture UpdatePersonCulture(Guid userId, Culture culture)
    {
        try
        {
            if (userId == Guid.Empty)
                throw new Exception("User id should not be empty");

            var dataSet = _database.ProvideCultureMappings(userId, culture); 

            return _blDataPopulation.PopulateCultures(dataSet.Tables[0]).FirstOrDefault();

        }
        catch (Exception exception)
        {
            throw _logger.Log(exception);
        }
    }
}

我添加的接口(interface):

public interface IDatabase
{
    DataSet ProvideCultureMappings(Guid userId, Culture culture);
}

public interface IBLLogger
{
    Exception Log(Exception exception);
}

public interface IBLDataPopulation
{
    IEnumerable<Culture> PopulateCultures(DataTable dataTable);
}

结果:

[TestFixture]
public class DatabaseUnitTest
{
    [Test]
    public void Test()
    {
        var logger = new Mock<IBLLogger>(MockBehavior.Strict);
        var blDataPopulation = new Mock<IBLDataPopulation>(MockBehavior.Strict);
        var database = new Mock<IDatabase>(MockBehavior.Strict);
        var toTest = new ClassToTest(logger.Object, blDataPopulation.Object, database.Object);
        var userId = Guid.NewGuid();
        var culture = new Culture{Id = "MyId"};
        var dataSet = new DataSet();
        var table = new DataTable();
        dataSet.Tables.Add(table);
        database.Setup(x => x.ProvideCultureMappings(userId, culture)).Returns(dataSet);
        var cultureList = new List<Culture> {culture, new Culture {Id = "AnotherCulture"}};
        blDataPopulation.Setup(x => x.PopulateCultures(table)).Returns(cultureList);
        var result = toTest.UpdatePersonCulture(userId, culture);
        Assert.AreEqual(result.Id, culture.Id);
    }
}

作为奖励，非单元测试类:

public class Database : IDatabase
{
    public DataSet ProvideCultureMappings(Guid userId, Culture culture)
    {

        DatabaseProviderFactory factory = new DatabaseProviderFactory();
        Database database = factory.CreateDefault();

        using (DbConnection dbConnection = database.CreateConnection())
        {
            if (dbConnection.State == ConnectionState.Closed)
                dbConnection.Open();

            DbCommand dbCommand = database.GetStoredProcCommand("usp_UpdatePersonCulture");
            database.DiscoverParameters(dbCommand);
            dbCommand.Parameters["@userId"].Value = userId;
            dbCommand.Parameters["@cultureId"].Value = culture.Id;

            DataSet dataSet = database.ExecuteDataSet(dbCommand);
            return dataSet;
        }
    }

    private DataSet ExecuteDataSet(DbCommand dbCommand)
    {
        throw new NotImplementedException();
    }

    private void DiscoverParameters(DbCommand dbCommand)
    {
        throw new NotImplementedException();
    }

    private DbCommand GetStoredProcCommand(string uspUpdatepersonculture)
    {
        throw new NotImplementedException();
    }

    private DbConnection CreateConnection()
    {
        throw new NotImplementedException();
    }
}