Skip to main content
Version: Next

Unit Testing and Integration Testing

Files referenced in this document

Table of Contents​

  1. Test System Overview
  2. Test Project Structure
  3. Test Base Classes and Shared Utilities
  4. Test Data Management
  5. Test Module Dependencies
  6. Database Test Configuration
  7. Transactions and Data Isolation
  8. Best Practices

Test System Overview​

This project builds a complete testing system adopting a layered testing strategy, covering unit testing and integration testing for the domain layer, application layer, and Entity Framework layer. The testing system is based on the ABP framework's test infrastructure, ensuring that tests for each layer can run independently while allowing for complete integration verification through layered dependencies and modular design. The system supports features such as parallel execution, transaction rollback, and in-memory databases, guaranteeing test independence and repeatability.

Test Project Structure​

The testing system in the project is divided into four main parts according to functionality and scope:

  • CMS.Plugin.MyPluginName.TestBase: Test infrastructure library, providing base classes, test data, and shared utilities for all tests.
  • CMS.Plugin.MyPluginName.Domain.Tests: Domain layer tests, focusing on business logic, entity behaviors, and domain services.
  • CMS.Plugin.MyPluginName.Application.Tests: Application layer tests, verifying application services, DTO conversions, and API contracts.
  • CMS.Plugin.MyPluginName.EntityFrameworkCore.Tests: Entity Framework Core tests, ensuring the correctness of the data access layer and database interactions.

This layered structure follows Domain-Driven Design principles, ensuring tests accurately cover the responsibilities of each layer.

Section sources

Test Base Classes and Shared Utilities​

MyPluginNameTestBase<TStartupModule> is the base class for all test classes, inheriting from ABP's AbpIntegratedTest<TStartupModule>, providing a complete dependency injection container and application context for tests.

Diagram sources

This base class provides the following key features:

  1. Dependency Injection Configuration: Configures Autofac as the DI container by overriding the SetAbpApplicationCreationOptions method.
  2. Unit of Work Support: Provides multiple WithUnitOfWorkAsync overloads to easily manage transaction boundaries in tests.
  3. Service Retrieval: Inherits from AbpIntegratedTest, allowing direct retrieval of registered services via GetRequiredService<T>().

Section sources

Test Data Management​

Test data is organized and managed via the MyPluginNameTestData class, which implements the ISingletonDependency interface, ensuring it exists as a singleton throughout the test lifecycle.

Diagram sources

MyPluginNameDataSeedContributor acts as a data seed contributor, responsible for preparing test data during test initialization. It acquires MyPluginNameTestData instance and IGuidGenerator via dependency injection and can create preset test data in the SeedAsync method.

Section sources

Test Module Dependencies​

The testing system establishes a clear dependency chain through the ABP modular architecture, ensuring each test layer initializes required dependencies correctly.

Diagram sources

Responsibilities of each test module:

  • MyPluginNameTestBaseModule: Base test module, configuring general test environment settings like authorization and default unit of work options.
  • MyPluginNameTestEntityFrameworkCoreModule: Entity Framework test module, configuring SQLite in-memory database.
  • MyPluginNameDomainTestModule: Domain test module, depending on the Entity Framework test module.
  • MyPluginNameApplicationTestModule: Application test module, depending on the domain test module and application module.

Section sources

Database Test Configuration​

To ensure test independence and performance, the Entity Framework test module configures an SQLite in-memory database as the test database.

Diagram sources

MyPluginNameTestEntityFrameworkCoreModule creates an SQLite in-memory database connection in ConfigureServices and configures AbpDbContextOptions to use it. Through CreateDatabaseAndGetConnection, it ensures a clean database state for each test run.

Section sources

Transactions and Data Isolation​

The testing system ensures data isolation through the Unit of Work pattern and transaction management. MyPluginNameTestBase provides WithUnitOfWorkAsync methods, allowing tests to execute operations within a transaction context.

Diagram sources

In MyPluginNameTestBaseModule, AbpUnitOfWorkDefaultOptions are configured to enable transactions, ensuring all database operations are protected. After the test ends, the transaction is automatically rolled back, guaranteeing data isolation between tests.

Section sources

Best Practices​

Based on the project's testing system, here are best practices for writing high-quality test cases:

  1. Choose the Right Base Class:

    • Domain layer tests should inherit MyPluginNameDomainTestBase.
    • Application layer tests should inherit MyPluginNameApplicationTestBase.
    • Entity Framework tests should inherit MyPluginNameEntityFrameworkTestBase.

  2. Use Unit of Work: For tests involving database operations, use WithUnitOfWorkAsync to ensure operations run within a transaction context.

  3. Test Data Preparation: Organize preset test data by extending MyPluginNameTestData and initialize it in MyPluginNameDataSeedContributor.SeedAsync.

  4. Parallel Testing: Since in-memory databases and transaction rollbacks are used, tests can safely run in parallel. Ensure tests do not depend on external state or static variables.

  5. Assertion Strategy: Use assertion libraries like Shouldly to write clear, readable assertions, ensuring meaningful error messages on failure.

  6. Mocking: Use Mock frameworks like NSubstitute to create test doubles for external service dependencies, ensuring test independence.

  7. Naming Convention: Adopt MethodName_StateUnderTest_ExpectedBehavior naming convention to improve test readability and maintainability.

  8. Coverage: Ensure critical business logic, boundary conditions, and exception paths have corresponding test coverage.

Section sources

Last updated on