This page is maintained for older versions of Rapise only. The latest documentation can be found at: https://rapisedoc.inflectra.com
SpiraTest Integration

SpiraTest Integration

Top  Previous  Next

For more details on using SpiraTest with Rapise, please refer to the separate "Using SpiraTest with Rapise" guide.


Overview

SpiraTest is a web-based quality assurance and test management system with integrated release scheduling and defect tracking. SpiraTest includes the ability to execute manual tests, record the results and log any associated defects. Note: SpiraTeam is an integrated ALM Suite that includes SpiraTest as part of its functionality, so wherever you see references to SpiraTest in this section, it applies equally to SpiraTeam.

When you use SpiraTest with Rapise you get the ability to store your Rapise automated tests inside the central SpiraTest repository with full version control and test scheduling capabilities:

SpiraTest Rapise Architecture

You can record and create your test cases using Rapise, upload them to SpiraTest and then schedule the tests to be executed on multiple remote computers to execute the tests immediately or according to a predefined schedule. The results are then reported back to SpiraTest where they are archived as part of the project. Also the test results can be used to update requirements' test coverage and other key metrics in real-time.


Connecting to SpiraTest

The first thing you need to do is to configure the connection to SpiraTest. To do this, click on the Options button in the Tools section of the Rapise Test ribbon:

Options Button

This will bring up the Options dialog box. Click on the Tools tab to bring up the settings related to the various Tools:

Tool Settings Dialog

Click on the "Spira Connection Settings" button to bring up the dialog box that lets you configure the connection to SpiraTest:

SpiraTest/Team Connection Settings

Enter the URL, login and password that you use to connect to SpiraTest and then click the "Test" button to verify that the connection information is correct.

You need to be running SpiraTest / SpiraTeam v3.1 or later to use the integration with Rapise.


Creating a Rapise test from a SpiraTest test case

To create a new Rapise test based on the manual test steps already defined in a SpiraTest test case, click on the Rapise icon in the top left of the application and from the popup menu, choose the option "Create From Spira Manual Test". This will bring up the following dialog box:

Create New Test from SpiraTest Manual Test Case Dialog
  1. Click on the [Load Projects] button and the dropdown list will display the list of available projects.
  2. Select the project that has our new test case. The list of test case folders will be displayed.
  3. Expand the folders until you can see the desired test case:
Create New Test from SpiraTest Manual Test Case Dialog

Now click on the test case we previously created and you will see its test steps displayed:

Create New Test from SpiraTest Manual Test Case Dialog

Once you are satisfied that this is the correct test case, click the [Open] button and Rapise will display the normal "Create New Test" dialog box that lets you choose a name and location for this new Rapise test.

Saving a Test to SpiraTest

To save the a Rapise test into SpiraTest you need to make sure that the following has been setup first:

  1. You have a project created in SpiraTest to store the Rapise tests in. The Rapise tests will be stored in a repository located inside the Project Home > Documents section of the project.
  2. The user you will be connecting to SpiraTest with has the permissions to create new document folders. In SpiraTest v3.1 that means the user needs to be a Project Owner role, however in future versions it will not require such a high-priviledged role.
  3. You have created the Test Case in SpiraTest that the Rapise test will be associated with. This is important because without being associated to a SpiraTest Test Case, you will not be able to schedule and execute the tests using SpiraTest and RapiseLauncher.
  4. You have created an AutomationEngine in SpiraTest that has the token name "Rapise". This will be used to identify Rapise automation scripts inside SpiraTest.

Once you have setup SpiraTest accordingly, click on the Save to Spira icon in the File section of the Rapise Test ribbon:

Save to Spira Button

That will bring up the Save to SpiraTest dialog box:

Save to Test Repository Dialog Box

The first thing you will need to do is choose the SpiraTest project from the dropdown list. Once you have done that, the system will ask you to choose the local Repository path for the Rapise test. This is when the test will get saved-to locally before checking-in to from SpiraTest. Also it's where the test gets checked-out to if you open the test in the future.

Once you have chosen the repository path, you need to expand the test case folders in SpiraTest and choose the existing Test Case that you want to attach the Rapise test to:

Save to Test Repository Dialog Box

When you expand the folders to display the list of contained test cases, it will display the name of the associated Rapise test script associated with it (to the right). If you are adding a new Rapise test, choose a test case that doeesn't have an associated Repository path. If you are updating an existing test, choose a test case that has the matching Repository path.

Once you have chosen the appropriate test case, confirm the path of the test repository folder that will be created in SpiraTest (normally the default is fine). Then click the [Save/Synchronize] button:

Save/Synchronize File List

A dialog box will be displayed that lists all the files in the local working directory and shows which ones will be checked-in to SpiraTest. The system will filter out result and report files that shouldn't be uploaded. You can change which files are filtered out and also selectively include/exclude files. Once you are happy with the list of files being checked-in, click the [OK] button:

The system will display the message that it's saving the files to the server:

Saving Files Dialog

If an error occurs during the save, a message box will be displayed, otherwise the dialog box will simply close.


Opening a Test from SpiraTest

To open a Rapise test from SpiraTest you need to make sure that the following has been setup first:

  1. You have already configured the connection to the SpiraTest service (see the instructions at the top of this page).
  2. The user you will be connecting to SpiraTest with has the permission to view the project that the tests are being stored in.

Once you have setup SpiraTest accordingly, click on the Open Test from Spira icon in the File section of the Rapise Test ribbon:

Open Test from Spira Button

That will bring up the Open Test from SpiraTest dialog box:

Open Test from Repository Dialog Box

The first thing you will need to do is choose the SpiraTest project from the dropdown list. Once you have done that, the system will ask you to choose the local Repository path for the Rapise test. This is when the test will get saved-to locally after checking-out from SpiraTest.

Once you have chosen the repository path, you need to expand the test case folders in SpiraTest and choose the existing Test Case that you want to attach the Rapise test to:

Save Test from Repository Dialog Box

When you expand the folders to display the list of contained test cases, it will display the name of the associated Rapise test script associated with it (to the right). Choose a test case that has the matching Rapise test case listed to the right of it (in the Repository Path column).

Once you have chosen the appropriate test case, confirm the path of the test repository folder that will be created in SpiraTest (normally the default is fine). Then click the [Load/Synchronize] button:

Load/Synchronize File List

A dialog box will be displayed that lists all the files on the server which will be downloaded from SpiraTest. You can change which files are to be downloaded. Once you are happy with the list of files being checked-out, click the [OK] button:

The system will display the message that it's downloading the files from the server. If an error occurs during the download, a message box will be displayed, otherwise the dialog box will simply close.


Viewing the SpiraTest Properties of a Test

To see which SpiraTest project and test case  the current Rapise test is associated with, click on the Spira Properties icon in the File section of the Rapise Test ribbon. This will bring up the Spira Properties dialog box:

View the Spira Properties of a Test

This will display the name of the current Rapise test together with the name of the SpiraTest project, test folder and test case that this test is associated with.

If you would to save the current Rapise test into a new SpiraTest project or if you want to save it against a new test case in the same project, you must first unlink the test. To do this click on the Unlink from Test Case button. This will tell Rapise to remove the stored SpiraTest information from the .sstest file so that it can be associated with a new project and/or test case in SpiraTest.

Warning: This operation cannot be undone so please make sure you really want to unlink the current test.


Using RapiseLauncher

RapiseLauncher is a separate application that installs with Rapise. It allows you to remotely schedule the automated tests in SpiraTest and have RapiseLauncher automatically invoke the tests according to the schedule. Details on using SpiraTest with RapiseLauncher to remotely schedule and execute tests is described in the separate "Using SpiraTest with Rapise" guide. This guide can be found in the Rapise program files folder. Click on Start > Programs > Inflectra > Rapise in Windows and you will see the shortcut for the guide.