Open Source Community: Integration testing is a software testing methodology to test the integration of two or more systems. With Relativity® applications, this typically means the integration between your Relativity application's code and one or more Relativity instances. These components are tested as a single group or organized in an iterative manner. We have created Relativity Integration Test Helpers to assist you with writing high-quality, low-effort integration tests for your Relativity application. You can use this framework to test event handlers, agents, custom pages, or any workflow that combines these Relativity extensibility points.

This project requires references to the Relativity® SDK. You may obtain the necessary assemblies from NuGet, by contacting Relativity support by email at support@relativity.com, by pulling them from your Relativity instance at C:\Program Files\kCura Corporation, or by installing the SDK from the Community Portal.

The develop branch is in active development and is subject to breaking changes.

A build of the master branch is available as a nuget package.

The primary objects of this project are:

Integration tests require configuration to point to the correct Relativity instance with the appropriate user credentials. This project simplifies configuration through the use of an app.config file. A typical integration test contains the following app.config XML settings:

<configuration>
	<appSettings>
		<add key="WorkspaceID" value="0" />
		<add key="WorkspaceName" value="My App Integration Test" />
		<add key="ServerHostBinding" value="http" />
		<add key="ServerHostName" value="myhostname" />
		<add key="AdminUsername" value="my.relativity.admin@mycompanyname.com" />
		<add key="AdminPassword" value="myadminpassword" />
		<add key="SQLUsername" value="mysqlusername" />
		<add key="SQLPassword" value="mysqlpassword" />
		<add key="ApplicationRAPPath" value="thepathtomyapplicationRAPfile" />
	</appSettings>
</configuration>

To retrieve the app.config settings, you can use the following code snippet:

ConfigurationModel LocalConfig = ConfigurationFactory.ReadConfigFromAppSettings();

This is a stand-alone implementation of the IHelper interface. A new instance of this object can be instantiated by using the following code snippet:

TestHelper TestHelper = new TestHelper(LocalConfig);

Integration tests may have complex setup and teardown requirements. A quality integration test manages all objects without manual intervention, which means it must create the workspace, install your application, create agents, and more. When the tests complete, all of these objects must be cleaned up to allow the test to repeat without side effects. ObjectHelper gives you common methods to set up and tear down these necessary objects for your integration test.

To instantiate an instance of ObjectHelper, use the factory method in the following code snippet:

ObjectHelper ObjectHelper = ObjectFactory.ObjectHelperInstance(TestHelper);

There is full or partial support for the following objects:

• Agent
• Application
• Client
• Document
• Field
• Folder
• Group
• Matter
• OAuth2Client
• RDO
• User
• Workspace

For a sample integration test, check the Relativity.Test.Helpers.Example project.