Table of Contents

Class TestSuite

Namespace
Ranorex.Core.Testing
Assembly
Ranorex.Core.dll

Provides functionality to create, load, save, and run a test suite.

public sealed class TestSuite : TestSuiteEntryContainer, ITestSuite
Inheritance
TestSuite
Implements
Inherited Members
Extension Methods

Constructors

TestSuite(string) 

public TestSuite(string name)

Parameters

name string

Fields

TestSuiteExtension 

public static readonly string TestSuiteExtension

Field Value

string

Properties

Checked 

[Browsable(false)]
public bool Checked { get; set; }

Property Value

bool

ContainerType 

[Browsable(false)]
public Type ContainerType { get; set; }

Property Value

Type

Current

Gets the current test suite.

[Browsable(false)]
public static ITestSuite Current { get; }

Property Value

ITestSuite

CurrentTestContainer

Gets the current 'test case' or 'smart folder'.

public static ITestContainer CurrentTestContainer { get; }

Property Value

ITestContainer

DataBindingManager 

[Browsable(false)]
public DataBindingManager DataBindingManager { get; }

Property Value

DataBindingManager

DataConnectorCaches

Gets the data connectors of the test suite.

[Browsable(false)]
public IList<DataCache> DataConnectorCaches { get; }

Property Value

IList<DataCache>

The test suite data connectors.

DataConnectorManager 

[Browsable(false)]
public DataConnectorManager DataConnectorManager { get; }

Property Value

DataConnectorManager

DefaultOwnerName 

[Browsable(false)]
public string DefaultOwnerName { get; }

Property Value

string

FileName 

[Browsable(false)]
public string FileName { get; set; }

Property Value

string

HasDirtyModules 

[Browsable(false)]
public bool HasDirtyModules { get; set; }

Property Value

bool

IsDirty 

[Browsable(false)]
public bool IsDirty { get; }

Property Value

bool

IsReadOnly 

[Browsable(false)]
public bool IsReadOnly { get; set; }

Property Value

bool

ParameterMasks

Gets the parameter masks of the test suite.

[Browsable(false)]
public IDictionary<string, string> ParameterMasks { get; }

Property Value

IDictionary<string, string>

The test suite parameters.

Parameters

Gets the parameters of the test suite.

[Browsable(false)]
public IDictionary<string, string> Parameters { get; }

Property Value

IDictionary<string, string>

The test suite parameters.

ReferencedAssemblies 

[Browsable(false)]
public IList<string> ReferencedAssemblies { get; set; }

Property Value

IList<string>

ReportLevel 

[TypeConverter(typeof(TestSuiteReportLevelConverter))]
public ReportLevel ReportLevel { get; set; }

Property Value

ReportLevel

ReportSettings

Gets all the settings for the Report.

[Browsable(false)]
public ReportSettings ReportSettings { get; }

Property Value

ReportSettings

The report settings.

RunConfigurations

Gets the run configurations of the test suite.

[Browsable(false)]
public IList<TestSuiteRunConfig> RunConfigurations { get; }

Property Value

IList<TestSuiteRunConfig>

The run configurations.

RunLabel

Gets the run label of the test suite.

[Browsable(false)]
public string RunLabel { get; set; }

Property Value

string

The test suite run label.

SelectedRunConfig

Gets the selected run configuration of the test suite.

[Browsable(false)]
public TestSuiteRunConfig SelectedRunConfig { get; }

Property Value

TestSuiteRunConfig

The selected run configuration.

ShowProgressDialog 

public bool ShowProgressDialog { get; set; }

Property Value

bool

ShowTestModuleFullPath 

public bool ShowTestModuleFullPath { get; set; }

Property Value

bool

TestSuiteEntry 

[Browsable(false)]
public TestSuiteEntryContainer TestSuiteEntry { get; }

Property Value

TestSuiteEntryContainer

UserRunLabel 

public string UserRunLabel { get; set; }

Property Value

string

WarnUnboundVariables 

[TypeConverter(typeof(WarnUnboundVariablesConverter))]
public bool? WarnUnboundVariables { get; set; }

Property Value

bool?

WorkingDirectory

Gets or sets the working directory for the test suite.

[Browsable(false)]
public static string WorkingDirectory { get; set; }

Property Value

string

The working directory.

Methods

CreateFromFile(string) 

public static TestSuite CreateFromFile(string fileName)

Parameters

fileName string

Returns

TestSuite

CreateFromXmlNode(XmlNode, bool) 

public static TestSuite CreateFromXmlNode(XmlNode node, bool captureChangeState)

Parameters

node XmlNode
captureChangeState bool

Returns

TestSuite

DoGetFactoryIdentifier() 

[Browsable(false)]
protected override string DoGetFactoryIdentifier()

Returns

string

GetAllTestSuiteEntries() 

[Browsable(false)]
public IList<TestSuiteEntry> GetAllTestSuiteEntries()

Returns

IList<TestSuiteEntry>

GetNewUniqueName<T>(string, Opt<T>) 

public string GetNewUniqueName<T>(string name, Opt<T> existing) where T : TestSuiteEntry

Parameters

name string
existing Opt<T>

Returns

string

Type Parameters

T

GetTestContainer(string)

Gets the 'test case' or 'smart folder' with the specified name from the test suite.

public ITestContainer GetTestContainer(string name)

Parameters

name string

The test 'test case' or 'smart folder'.

Returns

ITestContainer

The 'test case' or 'smart folder' with the specified name or null if there is no test container with such a name within the test suite.

GetTestSuitesDirectory()

Gets the default path for test suits.

public static string GetTestSuitesDirectory()

Returns

string

The default path for test suits.

IsNameUsed<T>(string, Opt<T>) 

public bool IsNameUsed<T>(string name, Opt<T> existing) where T : TestSuiteEntry

Parameters

name string
existing Opt<T>

Returns

bool

Type Parameters

T

Run() 

public int Run()

Returns

int

Run(string, string, Dictionary<string, string>) 

public int Run(string runConfigName, string runLabel, Dictionary<string, string> parameters)

Parameters

runConfigName string
runLabel string
parameters Dictionary<string, string>

Returns

int

SaveToFile(Stream, bool) 

public string SaveToFile(Stream stream, bool forceSaveAs)

Parameters

stream Stream
forceSaveAs bool

Returns

string

SerializeToXml(XmlNode) 

public void SerializeToXml(XmlNode node)

Parameters

node XmlNode

ThrowIfNameNotOk(string) 

protected override void ThrowIfNameNotOk(string value)

Parameters

value string

ToXmlDoc() 

public XmlDoc ToXmlDoc()

Returns

XmlDoc

Events

TestSuiteCompleted 

public static event EventHandler TestSuiteCompleted

Event Type

EventHandler

TestSuiteStarting 

public static event EventHandler TestSuiteStarting

Event Type

EventHandler