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

本文关键字:单元测试 方法 存储过程 | 更新日期: 2023-09-27 18:32:20

我使用企业库来执行数据操作,而不是实体框架。

以下是我的示例 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);
    }
}

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

将类更改为可单元测试的类

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

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

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

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

  • 避免使用静态代码,因为无法对静态代码进行单元测试。实现是用静态类绑定的。如果静态代码调用外部资源,则无法控制输入和输出,也无法测试结果。

  • 学习重构:如果您具备重构的技能,可以轻松处理遗留代码。隔离一小段代码,为其编写单元测试,并将其替换为更可靠的代码。

  • 测试
  • 先测试或测试驱动开发,TDD可以使新编写的代码从一开始就可测试。这是一个过程,涉及在编写类的实现之前编写您对给定类的期望。

  • 行为驱动开发或 BDD:有时,当您的篮子里只有客户请求时,您无法轻松进入单元测试所需的最低级别。您可以使用 Specflow 等工具来构建需求语法并将其转换为测试。

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

例如,在您的案例中,我重构了包含要测试的方法的类:

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);
        }
    }
}

我添加的接口:

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();
    }
}