Exercise 15.1 - SysML TestRail Reference Connection
Objectives
The new learning objectives of this exercise are to create reference and model transform connections between a SysML element and a TestRail element.
Preparation
This exercise assumes the student has
Cameo System Modeler 18.0 - 19.0 (or MagicDraw with SysML plug-in) installed correctly on his or her machine with a valid license for use, and
Syndeia 3.3 installed as a plugin for Cameo/MagicDraw with a valid license for use
Syndeia TestRail interface, correctly installed with a valid license for user.
The user can use any TestRail repository they have available with the ability to create and edit elements within a TestRail project. It is generally advisable to carry out these exercises in a non-production repository, a "sandbox", set up for training and practice purposes.
We will use the provided MagicDraw project Syndeia_TestRail_Tutorial.mdzip (get it here - https://intercax.atlassian.net/wiki/spaces/SYN34/pages/2407364009). For this demonstration, we use the Sandbox project which contains an existing set of Test Cases, Test Suite, Test Runs and Milestones, but you may use any existing elements in your TestRail repository, instead.
Background – TestRail
TestRail is a test management solution from Gurock Software GMBH. The generic schema as supported by Syndeia is shown in Figure 1.
All elements are contained within a Project.
A Suite is composed of zero-to-many Sections.
A Section is composed of zero-to-many Cases.
A Milestone is composed of zero-to-many Test Runs.
A Test Run is composed of zero-to-many Tests and references a specific Test Suite.
A Test holds a specific test result and references a specific Case.
Figure 1 TestRail Schema
Exercise
Open the SysML project Syndeia_TestRail_Tutorial.mdzip (get it here - https://intercax.atlassian.net/wiki/spaces/SYN34/pages/2407364009) (or your own), right-click the TestRail Tutorial Test package, and launch the Syndeia dashboard (Figure 2).
Figure 2 Launching Syndeia dashboard
If Syndeia connections are set to store in the SysML model, the dashboard will open immediately. If they are stored in Syndeia Cloud (see Exercise 1.1), choose or create a project for the exercise.
To connect to a TestRail repository, right-click the TestRail category under Repositories in the Repository Manager tab and select Add… (Figure 3), then enter a name, your own TestRail URL and credentials, and click OK (Figure 4).
Figure 3 Adding a TestRail network connection
Figure 4 Entering TestRail repository info
Your repository should load and expand to show Test Suites, Test Runs, and Milestones, as in Figure 5.
Figure 5 Viewing TestRail repository contents in Repository Manager tab
To create a reference connection between a SysML element and a TestRail Case, go to the Connection Manager tab on the Syndeia dashboard, as in Figure 6.
Expand the SysML model in the left pane to show the Test Case 01 block.
Select Reference under Connection Type in the middle pane.
Expand the Issues folder in the right pane to show the Test Case to be connected, for example, New Test1Case.
Drag and drop Test Case 01 from the left pane on top of an issue in the right pane to connect them (or vice versa) and confirm.
Figure 6 Syndeia Dashboard, Connection Manager tab
To see the reference connections that have been created, go to the Connection Search tab on the Syndeia dashboard and click the Get All button (see Figure 7).
Figure 7 Syndeia Dashboard, Connection Search tab
The reference connection can be used in a number of ways by Syndeia. Close the Syndeia dashboard. To open a TestRail element directly from MagicDraw, right-click on Test Case 01 in the containment browser and select Syndeia → Open Connected Artifacts.. The TestRail element New Test1Case will be opened in the default web browser (see Figure 8). Note: your TestRail user interface may appear different depending on your configuration settings.
The reference connection may also be used to detect changes across the connection. To demonstrate,
Figure 8 TestRail web interface
Make a change in New Test Case in the TestRail web interface, e.g. set Priority to High, and save the change
Reopen the Syndeia dashboard. Go to the Connection Browser, load the SysML Repository, expand to find the connection to Test Case 01, right-click and select Compare Source & Target (Figure 9).
Figure 9 Syndeia Connection Browser, comparison across new connection
The Comparison Result tab (Figure 10) shows a newer version of the TestRail element is available. The reference connection can be updated by right-clicking on the red row and selecting either Sync Source to Target or Sync Target to Source.
Figure 10 Syndeia Comparison Results tab showing a newer version of the TestRail element available
