stevedunn / generic-math-examples

Unit Testing & Test-Driven Development

The generic-math project utilizes a comprehensive unit testing strategy to ensure code quality and correctness. This outline provides an overview of the project’s testing approach and key considerations.

Test-Driven Development

The project follows the principles of Test-Driven Development (TDD). This means tests are written before any production code, driving the development process through a cycle of:

  1. Write a failing test: Define a test for a specific feature or functionality before implementing it.
  2. Write the minimum production code: Implement just enough production code to make the test pass.
  3. Refactor: Improve the code’s design and structure while maintaining test coverage.

Unit Testing Framework

The project leverages the xUnit.net framework for unit testing.

Test Coverage

The goal is to achieve high test coverage, ensuring that most of the codebase is exercised through automated tests. Test coverage is reported using tools like SonarQube.

Example Tests

// Example test in RomanNumeralTest.cs
          [Fact]
          public void WhenInputIsOneThenOutputIsI()
          {
              // Arrange
              var input = "1";
              var expected = "I";
              // Act
              var actual = RomanNumeral.ConvertFromInt(1);
              // Assert
              Assert.Equal(expected, actual);
          }

Test Project Configuration

The generic-math.csproj file contains the necessary configurations for building and running tests.

<Project Sdk="Microsoft.NET.Sdk">
          
            <PropertyGroup>
              <OutputType>Exe</OutputType>
              <TargetFramework>net6.0</TargetFramework>
              <ImplicitUsings>enable</ImplicitUsings>
              <Nullable>enable</Nullable>
            </PropertyGroup>
          
            <ItemGroup>
              <PackageReference Include="System.Runtime.Experimental" Version="[6.0.0-preview.7.21377.19, )" />
            </ItemGroup>
          
          </Project>

Important Considerations

  • Test Data: Use a variety of valid and invalid test data to thoroughly test different scenarios.
  • Test Independence: Ensure each test is independent and doesn’t rely on the outcome of other tests.
  • Test Naming: Use clear and descriptive test names that reflect the tested functionality.
  • Test Documentation: Add comments to explain the purpose of each test and its expected behavior.
  • Code Coverage Analysis: Utilize code coverage tools to identify areas of the codebase not covered by tests.

This information provides a foundation for understanding the unit testing and test-driven development approach used in the generic-math project.

Top-Level Directory Explanations

obj/ - Temporary directory that stores compiled intermediate files during the build process.

obj/Debug/ - Temporary directory for debug versions of the compiled intermediate files.

obj/Debug/net6.0/ - Temporary directory for debug versions of the compiled intermediate files for .NET 6.0.