TestEngineSettings Class

Summary

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

Syntax

public class TestEngineSettings : ToolSettings

Constructors

Name Summary
TestEngineSettings()

Properties

Name Value Summary
ConfigurationFile string
Specifies the configuration file to use in the command.
Environment string
Specifies the environment to use during the test run.
Host string
Specifies the address of TestEngine you want to connect to.
OutputFolder string
Exports a test report to the specified folder.
Password string
Specifies the user password used to connect to TestEngine.
PrintReport Nullable<bool>
Command the command-line tool to print test job report to the console.
PriorityJob Nullable<bool>
Specify this option to skip all non-priority jobs in the queue (requires administrator rights).
ProjectPassword string
Specifies the project password.
ProxyHost string
Specifies the proxy host.
ProxyPassword string
Specifies the password to access the proxy.
ProxyPort Nullable<int>
Specifies the port of the proxy.
ProxyUser string
Specifies the username to access the proxy.
Quiet Nullable<bool>
Runs the command in silent mode. The command-line tool will not print the output.
ReportFileName string
Specifies the name of the report file.
ReportFormat Nullable<ReportFormat>
Specifies the report type. Possible values: Saves a report to the JUnit XML format (an XML file).Saves a report in a Microsoft Excel sheet (a XSLX file).Saves a report in the JSON format (a JSON file).
junit
excel
json>
RunAsync Nullable<bool>
If this option is specified, the command-line tool will not wait for the test job to finish.
SecurityTest string
Specifies the security test to run.

If you specify a security test to be run, do not specify the testsuite and testcase options because TestEngine cannot run both functional tests and security tests within the same test job.
SkipDependencies Nullable<bool>
If this option is specified, the command-line tool will not scan the project for external dependencies. It helps you improve the performance of running large projects.
Tags IEnumerable<string>
Specifies a list of tags to run.
TestCase string
Specifies the test case to run.
TestSuite string
Specifies the test suite to run.
TimeoutSeconds Nullable<int>
Specifies a timeout for a test job run in seconds. If a test job runs for the specified amount of time, TestEngine stops it with the FAILED status.
Username string
Specifies the username used to connect to TestEngine.
Verbose Nullable<bool>
Enables more detailed output.

Extension Methods

Name Value Summary
Dump<TestEngineSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TestEngineSettings>(TestEngineSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TestEngineSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TestEngineSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<TestEngineSettings>(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
ThrowIfNull<TestEngineSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin