Skip to content
This repository was archived by the owner on Jun 28, 2022. It is now read-only.

Commit 2fa8d04

Browse files
TommyBigNoseTommyBigNose
authored
Merge pull request #195 from relativitydev/develop
Develop > Master
2 parents 2eb673b + d1a0527 commit 2fa8d04

2 files changed

Lines changed: 49 additions & 34 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
- This file is used to list changes made in the relativity-test-helpers repo.
44
- **Place Newer updates on the top**
55

6+
-------------------------
7+
8+
## 2021-03-18
9+
10+
- REL-535838 - Updating README for clearer breaking changes for v8.
11+
12+
613
-------------------------
714

815
## 2021-03-10

‎README.md‎

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# relativity-integration-test-helpers
2-
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. That said, we have created Relativity Integration Test Helpers to assist you with writing good Integration Tests for your Relativity application. You can use this framework to test event handlers, agents or any workflow that combines agents and Eventhandlers. We will continue adding more helpers but in the mean time you should be able to create workspaces, create dbcontext, proxy and create documents with this framework.
2+
## Overview
3+
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.
4+
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.
35

4-
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, which will remove RSAPI.
6+
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.
7+
8+
## Compatibility
9+
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.
510

611
This is also available as a [nuget package](https://www.nuget.org/packages/RelativityDev.RelativityTestHelpers/).
712

@@ -14,44 +19,44 @@ With the deprecation of RSAPI, TestHelpers was significantly updated to account
1419
## Breaking Changes
1520
Context | v7 | v8 |
1621
|:-----|:--------|:------|
17-
| All | IRSAPIClient | IServicesMgr |
22+
| All | Any **IRSAPIClient** usage | Removed <br> Use **IServicesMgr** in IRSAPIClient's place |
1823
| All | SharedTestHelpers.ConfigurationHelper.FORCE_DBCONTEXT | Removed |
19-
| All | SharedTestHelpers.ConfigurationHelper.RSAPI_SERVER_ADDRESS | Removed, use RELATIVITY_INSTANCE_ADDRESS or REST_SERVER_ADDRESS |
20-
| Application | Application.ApplicationHelpers.ImportApplication | Kepler.ApplicationInstallHelper.InstallApplicationAsync |
21-
| Client | ArtifactHelpers.Client.Create_Client | ArtifactHelpers.ClientHelper.CreateClient |
22-
| Client | ArtifactHelpers.Client.Delete_Client | ArtifactHelpers.ClientHelper.DeleteClient |
24+
| All | SharedTestHelpers.ConfigurationHelper.RSAPI_SERVER_ADDRESS | Removed <br> Use RELATIVITY_INSTANCE_ADDRESS or REST_SERVER_ADDRESS |
25+
| Application | Application.ApplicationHelpers.ImportApplication | *Moved to* <br> Kepler.**ApplicationInstallHelper**.InstallApplicationAsync |
26+
| Client | ArtifactHelpers.Client.Create_Client | *Moved to* <br> ArtifactHelpers.**ClientHelper**.CreateClient |
27+
| Client | ArtifactHelpers.Client.Delete_Client | *Moved to* <br> ArtifactHelpers.**ClientHelper**.DeleteClient |
2328
| Document | ArtifactHelpers.Document.GetDocumentIdentifierFieldColumnName | Removed |
2429
| Document | ArtifactHelpers.Document.GetDocumentIdentifierFieldColumnNameWithDbContext | Removed |
25-
| Document | ArtifactHelpers.Document.GetDocumentIdentifierFieldName | ArtifactHelpers.DocumentHelper.GetDocumentIdentifierFieldName |
30+
| Document | ArtifactHelpers.Document.GetDocumentIdentifierFieldName | *Moved to* <br> ArtifactHelpers.**DocumentHelper**.GetDocumentIdentifierFieldName |
2631
| Document | ArtifactHelpers.Document.GetDocumentIdentifierFieldNameWithDbContext | Removed |
2732
| Field | ArtifactHelpers.Fields.CreateField | Removed |
28-
| Field | ArtifactHelpers.Fields.CreateField_Date | ArtifactHelpers.FieldHelper.CreateFieldDate |
29-
| Field | ArtifactHelpers.Fields.CreateField_FixedLengthText | ArtifactHelpers.FieldHelper.CreateFieldFixedLengthText |
30-
| Field | ArtifactHelpers.Fields.CreateField_LongText | ArtifactHelpers.FieldHelper.CreateFieldLongText |
31-
| Field | ArtifactHelpers.Fields.CreateField_MultipleChoice | ArtifactHelpers.FieldHelper.CreateFieldMultipleChoice |
32-
| Field | ArtifactHelpers.Fields.CreateField_SingleChoice | ArtifactHelpers.FieldHelper.CreateFieldSingleChoice |
33-
| Field | ArtifactHelpers.Fields.CreateField_User | ArtifactHelpers.FieldHelper.CreateFieldUser |
34-
| Field | ArtifactHelpers.Fields.CreateField_WholeNumber | ArtifactHelpers.FieldHelper.CreateFieldWholeNumber |
35-
| Field | ArtifactHelpers.Fields.CreateField_YesNO | ArtifactHelpers.FieldHelper.CreateFieldYesNo |
36-
| Field | ArtifactHelpers.Fields.GetFieldArtifactID | ArtifactHelpers.FieldHelper.GetFieldArtifactID |
33+
| Field | ArtifactHelpers.Fields.CreateField_Date | *Moved to* <br> ArtifactHelpers.**FieldHelper**.CreateFieldDate |
34+
| Field | ArtifactHelpers.Fields.CreateField_FixedLengthText | *Moved to* <br> ArtifactHelpers.**FieldHelper**.CreateFieldFixedLengthText |
35+
| Field | ArtifactHelpers.Fields.CreateField_LongText | *Moved to* <br> ArtifactHelpers.**FieldHelper**.CreateFieldLongText |
36+
| Field | ArtifactHelpers.Fields.CreateField_MultipleChoice | *Moved to* <br> ArtifactHelpers.**FieldHelper**.CreateFieldMultipleChoice |
37+
| Field | ArtifactHelpers.Fields.CreateField_SingleChoice | *Moved to* <br> ArtifactHelpers.**FieldHelper**.CreateFieldSingleChoice |
38+
| Field | ArtifactHelpers.Fields.CreateField_User | *Moved to* <br> ArtifactHelpers.**FieldHelper**.CreateFieldUser |
39+
| Field | ArtifactHelpers.Fields.CreateField_WholeNumber | *Moved to* <br> ArtifactHelpers.**FieldHelper**.CreateFieldWholeNumber |
40+
| Field | ArtifactHelpers.Fields.CreateField_YesNO | *Moved to* <br> ArtifactHelpers.**FieldHelper**.CreateFieldYesNo |
41+
| Field | ArtifactHelpers.Fields.GetFieldArtifactID | *Moved to* <br> ArtifactHelpers.**FieldHelper**.GetFieldArtifactID |
3742
| Field | ArtifactHelpers.Fields.GetFieldArtifactIDWithDbContext | Removed |
38-
| Field | ArtifactHelpers.Fields.GetFieldCount | ArtifactHelpers.FieldHelper.GetFieldCount |
43+
| Field | ArtifactHelpers.Fields.GetFieldCount | *Moved to* <br> ArtifactHelpers.**FieldHelper**.GetFieldCount |
3944
| Field | ArtifactHelpers.Fields.GetFieldCountWithDbContext | Removed |
40-
| Folder | ArtifactHelpers.Folder.CreateFolder | ArtifactHelpers.FoldersHelper.CreateFolder |
41-
| Folder | ArtifactHelpers.Folder.GetFolderName | ArtifactHelpers.FoldersHelper.GetFolderName |
42-
| Folder | ArtifactHelpers.Folder.GetRootFolderArtifactID | ArtifactHelpers.FoldersHelper.GetRootFolderArtifactID |
43-
| Group | GroupHelpers.CreateGroup.Create_Group | GroupHelpers.GroupHelper.CreateGroup |
44-
| Group | GroupHelpers.DeleteGroup.Delete_Group | GroupHelpers.GroupHelper.DeleteGroup |
45+
| Folder | ArtifactHelpers.Folder.CreateFolder | *Moved to* <br> ArtifactHelpers.**FoldersHelper**.CreateFolder |
46+
| Folder | ArtifactHelpers.Folder.GetFolderName | *Moved to* <br> ArtifactHelpers.**FoldersHelper**.GetFolderName |
47+
| Folder | ArtifactHelpers.Folder.GetRootFolderArtifactID | *Moved to* <br> ArtifactHelpers.**FoldersHelper**.GetRootFolderArtifactID |
48+
| Group | GroupHelpers.CreateGroup.Create_Group | *Moved to* <br> GroupHelpers.**GroupHelper**.CreateGroup |
49+
| Group | GroupHelpers.DeleteGroup.Delete_Group | *Moved to* <br> GroupHelpers.**GroupHelper**.DeleteGroup |
4550
| KeplerHelper | Any Usage | Removed |
46-
| TestHelper | GetDbContent | No longer implemented |
47-
| User | UserHelpers.CreateUser.CreateNewUser | UserHelpers.UserHelper.Create |
48-
| User | UserHelpers.CreateUser.FindChoiceArtifactId | ArtifactHelpers.ChoiceHelper.GetChoiceId |
49-
| User | UserHelpers.CreateUser.FindClientArtifactId | ArtifactHelpers.ClientHelper.GetClientId |
50-
| User | UserHelpers.CreateUser.FindGroupArtifactId | GroupHelpers.GroupHelper.GetGroupId |
51-
| User | UserHelpers.DeleteUser.Delete_User | UserHelpers.UserHelper.Delete |
52-
| Workspace | WorkspaceHelpers.CreateWorkspace.Create | WorkspaceHelpers.WorkspaceHelpers.Create |
53-
| Workspace | WorkspaceHelpers.DeleteWorkspace.Delete | WorkspaceHelpers.WorkspaceHelpers.Delete |
54-
| Workspace | WorkspaceHelpers.DeleteWorkspace.Delete | WorkspaceHelpers.WorkspaceHelpers.Delete |
51+
| TestHelper | GetDbContext | No longer implemented |
52+
| User | UserHelpers.CreateUser.CreateNewUser | *Moved to* <br> UserHelpers.**UserHelper**.Create |
53+
| User | UserHelpers.CreateUser.FindChoiceArtifactId | *Moved to* <br> ArtifactHelpers.**ChoiceHelper**.GetChoiceId |
54+
| User | UserHelpers.CreateUser.FindClientArtifactId | *Moved to* <br> ArtifactHelpers.**ClientHelper**.GetClientId |
55+
| User | UserHelpers.CreateUser.FindGroupArtifactId | *Moved to* <br> GroupHelpers.**GroupHelper**.GetGroupId |
56+
| User | UserHelpers.DeleteUser.Delete_User | *Moved to* <br> UserHelpers.**UserHelper**.Delete |
57+
| Workspace | WorkspaceHelpers.CreateWorkspace.Create | *Moved to* <br> WorkspaceHelpers.**WorkspaceHelpers**.Create |
58+
| Workspace | WorkspaceHelpers.DeleteWorkspace.Delete | *Moved to* <br> WorkspaceHelpers.**WorkspaceHelpers**.Delete |
59+
| Workspace | WorkspaceHelpers.DeleteWorkspace.Delete | *Moved to* <br> WorkspaceHelpers.**WorkspaceHelpers**.Delete |
5560

5661

5762
<br>
@@ -115,8 +120,11 @@ public class TestHelperRunSettingsIntegrationTests
115120
# Utilizing MailHelper for tests
116121
## Gmail
117122
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.
123+
118124
## MailTrap
119-
[MailTrap Site]([https://mailtrap.io/inboxes](https://mailtrap.io/inboxes))
120-
You will need at least a free account with MailTrap 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.
125+
[MailTrap Site](https://mailtrap.io/inboxes)
126+
127+
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.
128+
121129
## Licensing
122130
[MailKit NuGet](https://github.com/jstedfast/MailKit)

0 commit comments

Comments
 (0)