How to
Before using TestRail Integration app
Configure TestRail
For the app to work in monday, some minor configuration should be done on TestRail side.
From the main TestRail dashboard go to Admin at the top-right corner of the screen
Then open Site Settings section, which is located on the left side of the screen
Switch to the API tab
Turn on Enable API and click Save settings
Add the app to monday item
To add TestRail Integration app to your items, open any item and in the item view (appears on the right side of the screen) press "+"
List with the available Item Views will appear. Search for "TestRail Integration" and click "Add to item" to add the app to your item
The app will be added as a new tab
Configure the app in monday
Before using the app, connection to TestRail should be configured in the app settings in monday
Configuration consists of:
- Server URL — URL to TestRail server in your company
- TestRail Admin Username — The username of a TestRail admin with permission to create test cases and custom fields.
- API key — Used to connect to TestRail from monday. You can get it in TestRail:
- Click on your user name in the top right corner of the screen
- Go to My Settings
- Switch to API KEYS tab
- Click Add Key to add a new API key
- Specify name for the new API key (e.g. monday) and click Generate Key
- Copy the generated key value. It will not be shown after saving the key
- Click + Add Key to save the key in TestRail.
- Click Save Settings to save the settings in TestRail.
- Go back to monday.com and paste the copied API key into the API key app setting
After specifying values for the above settings, click Save to save them for your account in monday.
Note
The app will create test cases on behalf of the above user name.
It is recommended to use a dedicated system (not personal) user name.
Add test case
To add a new test case for your monday item, open the item, switch to TestRail Integration tab in the item view and click "Add test case" button
A pop-up will appear, where you can enter test case title and specify additional test case parameters.
Values for the parameters other than Title are taken from your TestRail server, i.e. projects, sections, templates, types and priorities.
After setting values for all the test case parameters click Create to add the test case to the item.
The test case will be created in your TestRail server. ID and title of the new test case will be added to the table with all the item test cases
The created test case in TestRail will have "monday Item" property with the link to the monday item, for which it was created
Link test cases
There can be test cases, initially created in TestRail, which you want to link to an item in monday.com. To do that, click Link test cases button
It will show a pop-up, where you can search for the test cases, which should be linked to the item.
Before searching, select a TestRail project, where the test cases are located. If the project has multiple test suites, a test suite should be selected as well.
To search, just start typing test case title into the Title input field.
From the list of found test cases select those, which should be linked to the item in monday.com, and click Link test cases button
Once the test cases are linked to the item, they will appear in the list of all the item test cases.
Each of the linked test cases will also have a link to the item from monday.com in their monday Items property in TestRail.
Test case statistic
To view test case results across multiple test runs, click graph icon near the test case title.
After collecting data from TestRail, test results across multiple test runs will be shown.
Testing status
To view testing status for test plans and test runs, click graph icon in the top right corner.
Then select test plan or test run for which the testing status should be shown
Delete test case
If you need to delete a test case from your monday item, click on the trash can icon near the test case title
The test case will be deleted in monday, but not in TestRail, not to loose test results for the test case from TestRail.
If you have any questions about using the app, please contact us: support@kilomray.com