Class PayrunTestRunner
Payrun test runner
Inherited Members
Namespace: PayrollEngine.Client.Test.Payrun
Assembly: PayrollEngine.Client.Test.dll
Syntax
public class PayrunTestRunner : PayrunTestRunnerBaseConstructors
PayrunTestRunner(PayrollHttpClient, IScriptParser, PayrunTestSettings, DataImportMode, TestRunMode)
Initializes a new instance of the PayrunTestRunner class
Declaration
public PayrunTestRunner(PayrollHttpClient httpClient, IScriptParser scriptParser, PayrunTestSettings settings, DataImportMode importMode = DataImportMode.Single, TestRunMode runMode = TestRunMode.RunTests)Parameters
| Type | Name | Description |
|---|---|---|
| PayrollHttpClient | httpClient | The payroll engine http client |
| IScriptParser | scriptParser | The script parser |
| PayrunTestSettings | settings | The test settings |
| DataImportMode | importMode | The data import mode (default: single) |
| TestRunMode | runMode | The employee test mode |
Properties
ImportMode
The data import mode
Declaration
public DataImportMode ImportMode { get; }Property Value
| Type | Description |
|---|---|
| DataImportMode |
RunMode
The test running mode
Declaration
public TestRunMode RunMode { get; }Property Value
| Type | Description |
|---|---|
| TestRunMode |
ScriptParser
The employee test mode
Declaration
public IScriptParser ScriptParser { get; }Property Value
| Type | Description |
|---|---|
| IScriptParser |
Methods
CleanupTenant(Tenant)
Cleanup test tenant
Declaration
protected virtual Task CleanupTenant(Tenant exchangeTenant)Parameters
| Type | Name | Description |
|---|---|---|
| Tenant | exchangeTenant | The exchange tenant |
Returns
| Type | Description |
|---|---|
| Task |
CleanupTenants(Exchange, Dictionary<Tenant, List<PayrollTestResult>>)
Cleanup test tenants
Declaration
protected virtual Task CleanupTenants(Exchange exchange, Dictionary<Tenant, List<PayrollTestResult>> results)Parameters
| Type | Name | Description |
|---|---|---|
| Exchange | exchange | The exchange |
| Dictionary<Tenant, List<PayrollTestResult>> | results | Results |
Returns
| Type | Description |
|---|---|
| Task |
ImportAsync(Exchange)
Import exchange data without running tests
Declaration
public Task ImportAsync(Exchange exchange)Parameters
| Type | Name | Description |
|---|---|---|
| Exchange | exchange | The test exchange |
Returns
| Type | Description |
|---|---|
| Task |
TestAllAsync(Exchange)
Start the test (import + test in one step)
Declaration
public override Task<Dictionary<Tenant, List<PayrollTestResult>>> TestAllAsync(Exchange exchange)Parameters
| Type | Name | Description |
|---|---|---|
| Exchange | exchange |
Returns
| Type | Description |
|---|---|
| Task<Dictionary<Tenant, List<PayrollTestResult>>> | A list of payrun job results |
Overrides
TestAsync(Exchange)
Run payrun tests on already-imported exchange data
Declaration
public Task<Dictionary<Tenant, List<PayrollTestResult>>> TestAsync(Exchange exchange)Parameters
| Type | Name | Description |
|---|---|---|
| Exchange | exchange | The test exchange (must have been imported via ImportAsync(Exchange)) |
Returns
| Type | Description |
|---|---|
| Task<Dictionary<Tenant, List<PayrollTestResult>>> | A list of payrun job results |
ValidateTenant(ExchangeTenant)
Validate the tenant
Declaration
protected virtual void ValidateTenant(ExchangeTenant tenant)Parameters
| Type | Name | Description |
|---|---|---|
| ExchangeTenant | tenant | The tenant |