Siemens.AspNet.CodeRules.XUnit 7.7.4

Siemens.AspNet.CodeRules.XUnit

One setup class. Every code rule becomes its own xUnit test. No test classes to write.

Runs code rules as xUnit v3 tests. You register your rules in one ICodeRuleSetup; a source generator (shipped inside this package) reads the registrations at build time and writes one test per rule, grouped into one class per group. Test Explorer, dotnet test, trait filters and CI test results work as for any other test.

public sealed class CodeRuleSetup : ICodeRuleSetup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddCodeRuleEngine("My.slnx", o => o.AddRulePack<NamingRulePack>());
    }
}

That is the whole test project.

Quick start

1. Create a normal xUnit v3 project (e.g. Microsoft.NET.Test.Sdk, xunit.v3, xunit.runner.visualstudio).

2. Add the adapter and your rule packs:

   dotnet add package Siemens.AspNet.CodeRules.XUnit
   dotnet add package My.Team.CodeRules          # a rule pack, or write rules directly in this project
   

3. Add exactly one class that implements ICodeRuleSetup (see above) and register the rules with AddRule<TRule>(), Add<TRule>(), AddRulePack<TPack>() or AddRulesFrom(typeof(X).Assembly).

4. Build and run dotnet test.

The package brings the engine, the contracts and the source generator. One PackageReference, nothing else to wire up.

Optional: <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> writes the generated tests to obj/.../generated/CodeRules.XUnit.g.cs so you can read them without the IDE.

What you get

• One test per rule, one class per group: CodeRules.Generated.Code, CodeRules.Generated.Solution, ...
• Test name <ID>_<ClassName> (the class name alone when the ID is computed), no display name.
• Category traits in clear text: Category=CodeRules, Category=CodeRules <Group>, Category=CodeRules <Tag>: dotnet test --filter "Category=CodeRules Naming"
• Rules from packs and local rules of the test project; a rule the setup does not register gets no test.
• Compiled packs get the same tests as rules in source: ID, title and tags come from the pack's [assembly: CodeRuleDescriptor] (written by the generator in Siemens.AspNet.CodeRules.Contracts).
• Skipped rules (IRule.SkipReason, SkipRule<TRule>(reason)) show up as skipped tests with the reason.
• A guard test fails when a registered rule has no generated test, so no rule is silently lost.
• The engine creates every context once and thread safe: the solution is parsed once per test run.

A failing rule

The environment variable wins over the setup. Order, .runsettings example: Output mode.

Build warnings

Also runs in the CLI

Referencing this package makes the project a code rule project: build/Siemens.AspNet.CodeRules.XUnit.props sets <IsCodeRuleProject>true</IsCodeRuleProject> (only as a default, set it to false to opt out). The coderules CLI (Siemens.AspNet.CodeRules.Cli) finds such projects and runs the same ICodeRuleSetup natively, without a test host:

dotnet tool install -g Siemens.AspNet.CodeRules.Cli
coderules run                 # same rules, same result as dotnet test
coderules run --format ai     # one JSON document for AI agents and scripts

Related packages

License

Copyright (c) Siemens AG. See LICENSE.md in the package.