Open Source Community: Integration testing is a software testing methodology used to test individual software components or units of code to verify their interaction. These components are tested as a single group or organized in an iterative manner. Relativity Integration Test Helpers was created to assist with writing best practice Integration Tests for Relativity applications. The framework can be used to test event handlers, agents or any workflow that combines agents and event handlers.
The framework will currently enable you to proxy and create documents, create workspaces and create dbcontext with more functionality to be added in the future.
TestHelpers v8 release is only compatible with Ninebark (12.0) and above. Any previous version of TestHelpers will only be compatible with Relativity until Prairie Smoke (12.2), which will remove RSAPI.
This is also available as a nuget package.
With the upgrade of Relativity.DataExchange.Client.SDK/1.15.30+ and Relativity.Transfer.Client/7.4.7+ these updates may bring about breaking changes. This release was tested against Tiger Lily EAU.
With the deprecation of RSAPI, TestHelpers was significantly updated to account for this. These updates, however, did bring about many breaking changes.
Note: Previous packages of TestHelpers will still be available, but previous major releases will not be updated with RSAPI removal
| Context | v7 | v8 |
|---|---|---|
| All | Any IRSAPIClient usage | Removed Use IServicesMgr in IRSAPIClient's place |
| All | SharedTestHelpers.ConfigurationHelper.FORCE_DBCONTEXT | Removed |
| All | SharedTestHelpers.ConfigurationHelper.RSAPI_SERVER_ADDRESS | Removed Use RELATIVITY_INSTANCE_ADDRESS or REST_SERVER_ADDRESS |
| Application | Application.ApplicationHelpers.ImportApplication | Moved to Kepler.ApplicationInstallHelper.InstallApplicationAsync |
| Client | ArtifactHelpers.Client.Create_Client | Moved to ArtifactHelpers.ClientHelper.CreateClient |
| Client | ArtifactHelpers.Client.Delete_Client | Moved to ArtifactHelpers.ClientHelper.DeleteClient |
| Document | ArtifactHelpers.Document.GetDocumentIdentifierFieldColumnName | Removed |
| Document | ArtifactHelpers.Document.GetDocumentIdentifierFieldColumnNameWithDbContext | Removed |
| Document | ArtifactHelpers.Document.GetDocumentIdentifierFieldName | Moved to ArtifactHelpers.DocumentHelper.GetDocumentIdentifierFieldName |
| Document | ArtifactHelpers.Document.GetDocumentIdentifierFieldNameWithDbContext | Removed |
| Field | ArtifactHelpers.Fields.CreateField | Removed |
| Field | ArtifactHelpers.Fields.CreateField_Date | Moved to ArtifactHelpers.FieldHelper.CreateFieldDate |
| Field | ArtifactHelpers.Fields.CreateField_FixedLengthText | Moved to ArtifactHelpers.FieldHelper.CreateFieldFixedLengthText |
| Field | ArtifactHelpers.Fields.CreateField_LongText | Moved to ArtifactHelpers.FieldHelper.CreateFieldLongText |
| Field | ArtifactHelpers.Fields.CreateField_MultipleChoice | Moved to ArtifactHelpers.FieldHelper.CreateFieldMultipleChoice |
| Field | ArtifactHelpers.Fields.CreateField_SingleChoice | Moved to ArtifactHelpers.FieldHelper.CreateFieldSingleChoice |
| Field | ArtifactHelpers.Fields.CreateField_User | Moved to ArtifactHelpers.FieldHelper.CreateFieldUser |
| Field | ArtifactHelpers.Fields.CreateField_WholeNumber | Moved to ArtifactHelpers.FieldHelper.CreateFieldWholeNumber |
| Field | ArtifactHelpers.Fields.CreateField_YesNO | Moved to ArtifactHelpers.FieldHelper.CreateFieldYesNo |
| Field | ArtifactHelpers.Fields.GetFieldArtifactID | Moved to ArtifactHelpers.FieldHelper.GetFieldArtifactID |
| Field | ArtifactHelpers.Fields.GetFieldArtifactIDWithDbContext | Removed |
| Field | ArtifactHelpers.Fields.GetFieldCount | Moved to ArtifactHelpers.FieldHelper.GetFieldCount |
| Field | ArtifactHelpers.Fields.GetFieldCountWithDbContext | Removed |
| Folder | ArtifactHelpers.Folder.CreateFolder | Moved to ArtifactHelpers.FoldersHelper.CreateFolder |
| Folder | ArtifactHelpers.Folder.GetFolderName | Moved to ArtifactHelpers.FoldersHelper.GetFolderName |
| Folder | ArtifactHelpers.Folder.GetRootFolderArtifactID | Moved to ArtifactHelpers.FoldersHelper.GetRootFolderArtifactID |
| Group | GroupHelpers.CreateGroup.Create_Group | Moved to GroupHelpers.GroupHelper.CreateGroup |
| Group | GroupHelpers.DeleteGroup.Delete_Group | Moved to GroupHelpers.GroupHelper.DeleteGroup |
| KeplerHelper | Any Usage | Removed |
| TestHelper | GetDbContext | No longer implemented |
| User | UserHelpers.CreateUser.CreateNewUser | Moved to UserHelpers.UserHelper.Create |
| User | UserHelpers.CreateUser.FindChoiceArtifactId | Moved to ArtifactHelpers.ChoiceHelper.GetChoiceId |
| User | UserHelpers.CreateUser.FindClientArtifactId | Moved to ArtifactHelpers.ClientHelper.GetClientId |
| User | UserHelpers.CreateUser.FindGroupArtifactId | Moved to GroupHelpers.GroupHelper.GetGroupId |
| User | UserHelpers.DeleteUser.Delete_User | Moved to UserHelpers.UserHelper.Delete |
| Workspace | WorkspaceHelpers.CreateWorkspace.Create | Moved to WorkspaceHelpers.WorkspaceHelpers.Create |
| Workspace | WorkspaceHelpers.DeleteWorkspace.Delete | Moved to WorkspaceHelpers.WorkspaceHelpers.Delete |
| Workspace | WorkspaceHelpers.DeleteWorkspace.Delete | Moved to WorkspaceHelpers.WorkspaceHelpers.Delete |
As of update 7.1.0.X of Test Helpers, you can optionally utilize Runsettings instead of app.config for your testing. Both can still be used, but just not within the same Test Fixture, as the code does a hard swap of the value collection after the TestHelpers constructor.
To quickly describe Runsettings, it's just an XML file with data to be used only when a test is being run. Azure and other CI/CD pipelines use it to supply parameters during the test. Normally, this would be done via an app.config file, but cloud pipelines do not allow the use of these config files, so the switch to Runsettings is necessary.
While in a testing project, you can simply utilize the Test dropdown menu at the top of Visual studio. You can checkout Microsoft's documentation on how to setup a Runsettings file for more details.
The gist of the new setup is the new Runsettings file you will need in the project, and the new overloaded constructor for Test Helpers. There are two overloads, one that takes in your Current TestContext, and one that takes in a Dictionary of values. Both will be used to automatically map values to the static ConfigurationHelper TestHelpers creates. You can view samples below for Runsettings files and Constructors.
Note: For ease of use, TestHelpers expects the same parameter keys in Runsettings as it does with app.config.
<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
<!-- Parameters used by tests at run time -->
<TestRunParameters>
<Parameter name="WorkspaceID" value="-1" />
<Parameter name="TestWorkspaceName" value="Test Workspace Name" />
<Parameter name="TestWorkspaceTemplateName" value="New Case Template" />
<Parameter name="AdminUsername" value="your.admin.account@relativity.com" />
<Parameter name="AdminPassword" value="somepassword" />
<Parameter name="SQLUserName" value="eddsdbo" />
<Parameter name="SQLPassword" value="somepassword" />
<Parameter name="SQLServerAddress" value="172.99.99.99" />
<Parameter name="TestingServiceRapPath" value="C:\Users\user.name\Downloads" />
<Parameter name="UploadTestingServiceRap" value="MyApp.rap" />
<Parameter name="EmailTo" value="your.email.account@relativity.com" />
<Parameter name="RESTServerAddress" value="172.99.99.99" />
<Parameter name="ServerBindingType" value="http" />
<Parameter name="RelativityInstanceAddress" value="172.99.99.99" />
</TestRunParameters>
</RunSettings>[TestFixture]
public class TestHelperRunSettingsIntegrationTests
{
private IHelper SuT;
[OneTimeSetUp]
public void SetUp()
{
Dictionary<string, string> configDictionary = new Dictionary<string, string>();
foreach (string testParameterName in TestContext.Parameters.Names)
{
configDictionary.Add(testParameterName, TestContext.Parameters[testParameterName]);
}
SuT = new TestHelper(configDictionary);
}With gmail, you will need to allow IMAP on your account. It is recommended to make an alternate fake account just for testing. With that, you will just need to use your gmail and gmail password in the GmailMailHelper constructor.
You will need at least a free MailTrap account to utilize these helpers. The free account grants you a username, password, and Api Key. The API Key is used to access your inbox which MailTrapMailHelper takes in from its constructor.