PayrollEngine.Client.Test 0.10.0-beta.1

Payroll Engine Client Test

Part of the Payroll Engine open-source payroll automation framework. Full documentation at payrollengine.org.

Client library for testing Payroll Engine regulations and payrun results. Provides three test categories — Case, Payrun, and Report — each with dedicated runners, JSON schemas, and support for custom C# test extensions.

Test Categories

Case Test

Tests the case lifecycle in three phases:

Test definition class: CaseTest — specifies tenant, user, payroll, optional employee, evaluation date, optional init cases, and lists of AvailableTests, BuildTests, and ValidateTests.

JSON schema: PayrollEngine.CaseTest.schema.json

Payrun Test

Tests payrun results for wage types, collectors, and custom results. Three runners cover different test scenarios:

All runners extend PayrunTestRunnerBase and accept a PayrunTestSettings configuration object.

Report Test

Tests report parameter handling and execution output in two phases:

Test definition class: ReportTest — specifies tenant, user, regulation, and lists of BuildTests and ExecuteTests.

JSON schema: PayrollEngine.ReportTest.schema.json

Test Settings

PayrunTestSettings controls payrun test behavior:

TestResultMode

TestPrecision

Numeric comparison precision from TestPrecisionOff (no rounding) to TestPrecision6 (6 decimal places). Default is TestPrecision2.

Custom Tests

All three test categories support custom C# test extensions. Custom tests are compiled at runtime from source files and invoked alongside the standard assertions.

Implement a custom test class with a constructor accepting PayrollHttpClient and the test context (CaseTestContext or ReportTestContext), and use Assert for assertions:

public class MyCustomTests(PayrollHttpClient httpClient, CaseTestContext context)
    : CaseCustomTest(httpClient, context)
{
    public void MyBuildTest(CaseBuildTest test)
    {
        Assert.AreEqual("ExpectedValue", test.BuildCase.Fields["MyField"].Value);
    }
}

Register the source file in the test definition:

{
  "customTestFiles": ["MyCustomTests.cs"],
  "buildTests": [
    { "testName": "MyBuildTest", "caseName": "MyCaseName" }
  ]
}

JSON Schemas

The library generates two JSON schemas during build (requires PayrollEngineSchemaDir to be set):

Schemas are included in the NuGet package and can be referenced in test files for IDE validation:

{
  "$schema": "../../Schemas/PayrollEngine.CaseTest.schema.json",
  "testName": "MySalaryCaseTest",
  ...
}

Build

Environment variables used during build:

NuGet Package

Available on NuGet.org:

dotnet add package PayrollEngine.Client.Test

See Also

• Testing — test-driven payroll development
• Payroll Console — CLI runner for .et.json and .pt.json test files
• Client Services — SDK used by the test runners