TestRunnerSettings Class

Summary

Contains the settings used by TestRunner.bat Please see Command-Line SystemProperties for additional information
Assembly
Cake.Tools.ReadyAPI.TestRunner.dll
Namespace
Cake.Tools.ReadyAPI.TestRunner
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["TestRunnerSettings"] class Type type-node

Syntax

public class TestRunnerSettings : ToolSettings

Constructors

Name Summary
TestRunnerSettings()

Properties

Name Value Summary
BriefResults bool
Commands the runner to create an XML file with brief test results.
CreateCoverageReport bool
Commands the runner to create a coverage report (HTML format).
CreateJUnitCompatibleReports bool
Commands the runner to create JUnit-compatible reports.
Domain string
Specifies the domain that ReadyAPI will use for authorization.

This argument overrides the authorization domain you have specified for test steps in your project.

EnableUIComponents bool
Commands the runner to enable UI components. Use this command-line argument if you use the
UISupport
class in your tests.
EndPoint string
Specifies the endpoint to be used in test requests. The specified endpoint should include the protocol part (for example, https://).

This argument overrides the endpoints you have specified for test steps in your project.See the -h argument description.

Note: The runner ignores this parameter if Environment is specified.In this case, the endpoint is taken from the environment settings.

Environment string
Specifies the environment to be used in the test run. If specified, Environment overrides the EndPoint, Username, and Password parameters so that the values are taken from the environment.
ExportResults bool
Commands the runner to export all test results. Otherwise, it exports only information about errors.
ExportResultsUsingFolders bool
Turns on exporting of all results using folders instead of long filenames
GlobalProperties IDictionary<string, string>
Specifies a value of the global property for the test run. This value will override the variable�s value during the run.
Headers IDictionary<string, string>
Use this argument to add a custom HTTP header to all simulated requests.
Host string
Specifies the host and port to be used in test requests.

You can specify the host by using its IP address or name.

This argument overrides the endpoints you have specified in the project file. See the EndPoint argument description.

IgnoreErrors bool
Commands the runner to ignore errors. If you put this argument to the command line, the test log will contain no information on errors occurred during the test run. If you skip this argument, the runner will stop the run after the first error occurs and will post full information about the error to the log.
IncludeTestProperties bool
Commands the runner to include JUnit XML reports with test properties to the report.
OpenReportsInBrowser bool
Commands the runner to open the reports ReadyAPI created in your default web browser after the test run is over.
OutputFolder string
Sets the output folder to export results to
Password string
Sets password for readyapi-settings.xml file
PasswordType Nullable<PasswordType>
Sets the WSS password type, either 'Text' or 'Digest'
PrintSummaryReport bool
Prints a small summary report
ProjectPassword string
Specifies the project password, if you have encrypted the entire project or some of its custom properties. See Protecting Sensitive Data.
ProjectProperties IDictionary<string, string>
Specifies a value of a project property for the test run. This value will override the variable�s value during the run.
Report Nullable<ReportType>
Specifies the type of the report data.
  • Project Report:Generates a report in the format the -F argument specifies.The runner will save the report files to the directory that the OutputFolder argument specifies.Depending on the ExportResultsUsingFolders argument value, the runner can organize files into subdirectories.
  • TestSuite Report:As above, but for test suites.
  • TestCase Report:As above, but for test cases.
  • JUnit-Style HTML Report:Generates a report as JUnit-style HTML files. See JUnit-Style HTML Reports For Automation. When you use this value, the runner ignores the ReportFormats and ExportResultsUsingFolders arguments.
  • Data Export:Generates XML files with report data. See Data Export For Automation.
  • Allure Report:Generates Allure results.Use the Allure framework to generate an actual report.See Allure Report.
ReportFormats Nullable<ReportFormat>
Specifies the format of the reports ReadyAPI exports.

ReadyAPI supports the following formats: PDF, XLS, HTML, RTF, CSV, TXT and XML.If you have not specified the parameter, ReadyAPI will use the PDF format.

SaveProject bool
Commands the runner to save the test project after the test run finishes. Use this command-line argument if you store data within the project during the test.
SettingsFile string
Sets the readyapi-settings.xml file to use
SettingsPassword string
Specifies the password for your XML setting file.
SlackAccessToken string
Your Slack bot authentication token
SlackChannels IEnumerable<string>
List of Slack channels in the #channel-name format, or the IDs of the users the test results will be sent to. You can specify both channels and user IDs.
SuppressUsageStatistics bool
Commands the runner to renounce collecting and sending usage statistics.
SystemProperties IDictionary<string, string>
Specifies a value of a system property for the test run. This value will override the variable�s value during the run.
TestCase string
Specifies the test case to be run. If you skip this argument, the runner will execute all test cases in your test project.
TestCaseTags string
Runs only the test cases whose tags are specified
TestSuite string
Specifies the test suite to be run. If you skip this argument, the runner will execute all test suites in your project.
TestSuiteTags string
Runs only the test cases or test suites whose tags are specified.Format: "TestCase tag1[,tag2...]" or "TestSuite tag1[, tag2...]".
Username string
Specifies the user name to be used in test request authorizations. This argument overrides user names in your test project.

Note: The runner ignores this parameter if -E is specified.In this case, the user name is taken from the environment settings.

Extension Methods

Name Value Summary
Dump<TestRunnerSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TestRunnerSettings>(TestRunnerSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TestRunnerSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TestRunnerSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<TestRunnerSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<TestRunnerSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin