使用 NUnit 进行单元测试：现有代码库指南

• 下载 InventoryManagementSystem.zip - 10.3 MB
• 下载 InventoryManagementSystem.rar - 9 MB

引言

在软件开发领域，单元测试对于代码质量和稳定性至关重要。虽然测试驱动开发 (TDD) 是理想的选择，但将单元测试集成到预先存在的代码库中可能很棘手。本文旨在为使用 NUnit 编写现有代码库的单元测试提供指导。

场景

考虑一个库存管理系统，它由一个类库DataAccessLayer和一个 C# 项目InventoryManagementSystem组成。

类库DataAccessLayer 包含一个从DbContext 继承的DatabaseTransactions类，并且 DataAccessLayer 包含一个实体类ProductEntity 和一个仓库类ProductRepository

DatabaseTransactions

public class DatabaseTransactions : DbContext
{
   public DatabaseTransactions() : base("name=conStr"){}	
   public virtual DbSet<ProductEntity> Product { get; set; }	
   
   protected override void OnModelCreating(DbModelBuilder modelBuilder)
   {
	 modelBuilder.Entity<ProductEntity>().ToTable("tblProduct");
   }
}

ProductEntity

public class ProductEntity
{
   public int ID { get; set; }
   public string ProductName { get; set; }
   public int UnitPrice { get; set; }
   public int Quantity { get; set; }
}

ProductRepository

public class ProductRepository
{
    private readonly DatabaseTransactions transaction;
	
    public ProductRepository(DatabaseTransactions _transaction) 
    { 
       transaction = _transaction; 
    }
    public int AddProduct(ProductEntity _productEntity)
    {
       try
       {
           transaction.Product.Add(_productEntity);
           return transaction.SaveChanges();      
       }
       catch (Exception ex)
       {
           return -1;
       }
    }
}

设置 InventoryManagementSystem.Test 项目

添加单元测试项目InventoryManagementSystem.Test 并在 InventoryManagementSystem.Test 项目中集成 NUnit 和 Moq NuGet 包，以便促进 DatabaseTransactionClass 的模拟。

为了模拟DatabaseTransaction 并在 InventoryManagementSystem.Test 项目中测试ProductRepository 方法，添加DataAccessLayer 解决方案引用。

使用 NUnit 编写单元测试

识别可测试单元

在开始编写测试之前，确定可以独立测试的代码单元至关重要。在我们的场景中，ProductRepository 类的AddProduct 方法是测试的合适候选对象。

建立基础

添加一个类ProductRepositoryTest，并提及[TestFixture] ，它用于将一个类标记为包含测试夹具。我们遵循单元测试的准备 (Arrange)、执行 (Act) 和断言 (Assert) (AAA) 原则。

[TestFixture]
public class ProductRepositoryTest
{
   [Test]
   public void AddProduct_OnSuccessful_ShouldReturnOne()
   {
      //Arrange - Initializing Product Entity that will be passed to AddProduct method
      var _ProductEntity = new ProductEntity()
      {
         ProductName = "Computer Table",
         UnitPrice = 25000,
         Quantity = 500,
      };  
     
      //productData will act as Dataset which will be utilized in mocking DatabaseTransections
      var productData = new List<ProductEntity>().AsQueryable(); 
      
      //we create a mock object of the <code>DbSet<ProductEntity></code> class using Moq. This mock object will simulate the behavior of a DbSet for testing purposes.  
      var mockSet = new Mock<DbSet<ProductEntity>>();
      mockSet.As<IQueryable<ProductEntity>>().Setup(m => m.GetEnumerator()).Returns(productData.GetEnumerator());
      mockSet.As<IQueryable<ProductEntity>>().Setup(m => m.Expression).Returns(productData.Expression);
      mockSet.As<IQueryable<ProductEntity>>().Setup(m => m.ElementType).Returns(productData.ElementType);
      mockSet.As<IQueryable<ProductEntity>>().Setup(m => m.Provider).Returns(productData.Provider);
      
      //Now we create a mock object of the <code>DatabaseTransactions </code>class using Moq. This mock object will simulate the behavior of a database context for testing purposes.  
      var mockContext = new Mock<DatabaseTransactions>();
      mockContext.Setup(c => c.Product).Returns(mockSet.Object);
     
      //initializing ProductRepository with mockedObject of DataBaseTransections class
      var repository = new ProductRepository(mockContext.Object);
        
      //Act
      int result = repository.AddProduct(_ProductEntity);
       
      //Assert
      Assert.That(result, Is.EqualTo(1));
    }
}

结论

如本文所示，使用 NUnit 和 Moq，我们可以为现有代码编写简洁且有针对性的单元测试，而无需进行大量修改。通过遵循这些指南，开发人员可以提高软件系统的可维护性和可靠性，同时最大限度地减少对现有代码库的破坏。