This documentation provides a step-by-step guide to running tests for the stevedunn/vogen.serialization project. The tests are critical for ensuring the integrity and functionality of the code before deployment. Below are the detailed instructions tailored for expert developers.

Prerequisites

Before running the tests, ensure that the following prerequisites are met:

• A working environment set up for C# development.
• PowerShell is installed and accessible.

Step 1: Clone the Repository

Firstly, clone the project repository from GitHub. Open your terminal or PowerShell, and run the following command:

git clone https://github.com/stevedunn/vogen.serialization.git

Change into the project directory:

cd vogen.serialization

Step 2: Restore Project Dependencies

Ensure all necessary dependencies are restored before running the tests. Run the following command within the project directory:

dotnet restore

This command restores any packages specified in the project’s .csproj files.

Step 3: Build the Project

After restoring the dependencies, build the project to ensure that all components are compiled successfully:

dotnet build

This step compiles the source code and detects any issues prior to running tests.

Step 4: Run the Tests

To execute the tests for the project, use the following command:

dotnet test

This command will run all the tests defined within the project. The output will include information about which tests passed, which failed, and other relevant details.

Step 4.1: Running Specific Tests

If you wish to run a specific test, you can use the --filter option. For instance, to run tests in a specific namespace or with a certain name, execute:

dotnet test --filter "FullyQualifiedName~Namespace.TestClassName"

Replace Namespace.TestClassName with the appropriate namespace and test class name.

Step 5: Viewing Test Results

Once the tests are completed, the results will be displayed in the terminal. The output provides a summary, including the number of tests run, passed, failed, and skipped.

For detailed testing reports, consider using the --logger option. For example:

dotnet test --logger "console;verbosity=detailed"

This command boosts output verbosity, helping in diagnosing any issues encountered during testing.

Step 6: Testing with Coverage Reports

If code coverage is a requirement, integrate the coverlet tool with the tests:

1. Add the coverlet NuGet package to the test project:

dotnet add package coverlet.collector

2. Run the tests with coverage:

dotnet test /p:CollectCoverage=true

This command will execute the tests and generate a code coverage report.

Conclusion

Following these steps will enable you to run tests effectively for the stevedunn/vogen.serialization project. Utilizing the provided commands will help you maintain the project’s robustness and ensure that any changes meet the necessary requirements before deployment. Always verify test outcomes and adjust your development practices accordingly.

For further details refer to the project documentation.