Class TestModuleRunner

Namespace

Ranorex.Core.Testing

Assembly

Ranorex.Core.dll

Provides functionality to execute ITestModule instances.

public class TestModuleRunner

Inheritance

object

TestModuleRunner

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

TestModuleRunner(ITestModule)

Initializes a new instance of the TestModuleRunner class with a specified test module instance.

public TestModuleRunner(ITestModule testModule)

Parameters

testModule ITestModule

The test module instance to to use for the newly created runner.

Methods

Run()

Runs the configured test module instance, providing its public properties marked with the TestVariableAttribute as variables for data binding.

public void Run()

Run(ITestModule)

Runs the specified test module instance, providing its public properties marked with the TestVariableAttribute as variables for data binding.

public static void Run(ITestModule testModule)

Parameters

testModule ITestModule

The test module instance to run.

Run(ITestModule, CommandLine)

Runs the specified test module instance, providing its public properties marked with the TestVariableAttribute as variables for data binding. Additionally, parameters are parsed from the specified CommandLine and matching public properties are set.

public static void Run(ITestModule testModule, CommandLine commandLine)

Parameters

testModule ITestModule

The test module instance to run.

commandLine CommandLine

The command line object to use for setting parameter values to instance properties.

RunStandalone(ITestModule, string, bool)

Runs the specified module instance in a standalone context and sets up reporting.

public static int RunStandalone(ITestModule module, string reportFilename, bool generateReport)

Parameters

module ITestModule

The module instance to run.

reportFilename string

The report filename to use.

generateReport bool

if set to true, generate the report file specified in 'filename'.

Returns

int

An error code which can be used as a return value for command line execution (0 = Success, -1 = Failure).

RunStandalone(ITestModule, string, bool, string, CaseInsensitiveString)

Runs the specified module instance in a standalone context. For Ranorex internal use only.

public static int RunStandalone(ITestModule module, string reportFilename, bool generateReport, string standaloneModuleName, CaseInsensitiveString guid)

Parameters

module ITestModule

The module instance.

reportFilename string

The report filename.

generateReport bool

if set to true, generate report.

standaloneModuleName string

Name of the standalone module.

guid CaseInsensitiveString

The GUID of the standalone module.

Returns

int

An error code which can be used as a return value for command line execution (0 = Success, -1 = Failure).

SetReferencedAssemblies(string[])

Sets a list of additionally referenced assemblies.

public static void SetReferencedAssemblies(string[] assemblyLocations)

Parameters

assemblyLocations string[]

The referenced list of assemblies to use.

SetupStandalone(string)

Sets up a standalone module run. Assembly names can be passed for additionally needed references, separated by a pipe ('|') character.

public static void SetupStandalone(string assemblyLocations)

Parameters

assemblyLocations string

A list of additionally referenced assembly names.