Class ReportScriptTestRunner
Report available function test runner
Inheritance
Inherited Members
Namespace: PayrollEngine.Client.Test.Report
Assembly: PayrollEngine.Client.Test.dll
Syntax
public abstract class ReportScriptTestRunner : TestRunnerBase
Constructors
ReportScriptTestRunner(PayrollHttpClient, ReportTestContext)
new instance of ReportScriptTestRunnersee
Declaration
protected ReportScriptTestRunner(PayrollHttpClient httpClient, ReportTestContext context)
Parameters
| Type | Name | Description |
|---|---|---|
| PayrollHttpClient | httpClient | The payroll http client |
| ReportTestContext | context | The test context |
Properties
Context
The test context
Declaration
public ReportTestContext Context { get; }
Property Value
| Type | Description |
|---|---|
| ReportTestContext |
Tenant
The Tenant
Declaration
public Tenant Tenant { get; }
Property Value
| Type | Description |
|---|---|
| Tenant |
User
The user
Declaration
public User User { get; }
Property Value
| Type | Description |
|---|---|
| User |
Methods
BuildReportAsync(int, int, int, ReportRequest)
Build report
Declaration
protected Task<ReportSet> BuildReportAsync(int tenantId, int regulationId, int reportId, ReportRequest reportRequest)
Parameters
| Type | Name | Description |
|---|---|---|
| int | tenantId | The tenant id |
| int | regulationId | The regulation id |
| int | reportId | The report id |
| ReportRequest | reportRequest | The report request |
Returns
| Type | Description |
|---|---|
| Task<ReportSet> |
GetRegulationAsync(int, string)
Get regulation
Declaration
protected Task<Regulation> GetRegulationAsync(int tenantId, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| int | tenantId | The tenant id |
| string | name | The regulation name |
Returns
| Type | Description |
|---|---|
| Task<Regulation> |
GetReportAsync(int, int, string)
Get report
Declaration
protected Task<Report> GetReportAsync(int tenantId, int regulationId, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| int | tenantId | The tenant id |
| int | regulationId | The regulation id |
| string | name | The report name |
Returns
| Type | Description |
|---|---|
| Task<Report> |
NewFailedResult(ReportTestType, string, string, object, object)
Create new failed test result
Declaration
protected ReportScriptTestResult NewFailedResult(ReportTestType testType, string testName, string message, object expected = null, object received = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportTestType | testType | The report test type |
| string | testName | The test name |
| string | message | The test message |
| object | expected | The expected value |
| object | received | The received value |
Returns
| Type | Description |
|---|---|
| ReportScriptTestResult | The new failed test result |
NewResult(ReportTestType, string, string, object, object)
Create new test result
Declaration
protected ReportScriptTestResult NewResult(ReportTestType testType, string testName, string message, object expected = null, object received = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ReportTestType | testType | The report test type |
| string | testName | The test name |
| string | message | The test message |
| object | expected | The expected value |
| object | received | The received value |
Returns
| Type | Description |
|---|---|
| ReportScriptTestResult | The new test result |
NewResult(bool, ReportTestType, string, string, object, object)
Create new test result with failed condition
Declaration
protected ReportScriptTestResult NewResult(bool failed, ReportTestType testType, string testName, string message, object expected = null, object received = null)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | failed | The failed state |
| ReportTestType | testType | The report test type |
| string | testName | The test name |
| string | message | The test message |
| object | expected | The expected value |
| object | received | The received value |
Returns
| Type | Description |
|---|---|
| ReportScriptTestResult | The new test or test failed result |
NewResult(HttpRequestException, string, object)
Create new test result from http
Declaration
protected ReportScriptTestResult NewResult(HttpRequestException exception, string testName, object expected = null)
Parameters
| Type | Name | Description |
|---|---|---|
| HttpRequestException | exception | The http request exception |
| string | testName | The test name |
| object | expected | The expected value |
Returns
| Type | Description |
|---|---|
| ReportScriptTestResult | The new test result |