Apps documentation
TestFLO - Test Management for Jira
TestFLO - Test Management for Jira
8.13.x
8.12.x
8.11.x
8.10.x
FAQ
Release notes
Last updated May 23, 2023

Run automated tests from Test Plan

To run automated tests from Test Plan you need to use a dedicated operation called Run automated tests. This operation lets you trigger automated tests from integrated CI Servers in the Test Plan. After choosing the operation, you can select the appropriate CI server from which the tests are to be run, and after all the tests are completed, the results will be pulled to the Test Plan as Test Cases with the appropriate statuses. You can run automated tests without or with additional parameters.

Note

To use the Run automated tests operation you need to:

Info

The Run automated tests operation in Test Plan can be restricted to certain users/groups/roles in the TestFLO Permissions.

Running tests without additional parameters configured

Steps

To use the Run automated tests operation:

  1. Click the Run automated tests operation from the Test information panel or select from menu More. After selecting the operation, a dialog box will appear where you can select the tests to run.
    Run automated tests operation in Test Plan in TestFLO - Test Management in Jira
    Run automated tests operation in Test Plan
  2. In the Server name option select the appropriate CI Server from the list.
    Run automated tests operation in Test Plan in TestFLO - Test Management in Jira
    CI Server selection in Run automated tests operation
  3. Select the automated tests you want to run. Depending on the selected CI Server, the name of this option will change to:
    • Build plan for the Bamboo CI server build plans
    • Job for Jenkins CI server jobs
      Run automated tests operation in Test Plan in TestFLO - Test Management in Jira
      Tests selection in Run automated tests operation
  4. In the Import results to option you can select which iteration to import the test results for.
    Run automated tests in TestFLO
    Selecting the Iteration to which to import the automated test results
    You have two options available:
    • Current iteration - Creates Test Cases in the current iteration in Test Plan. Select this option if you are running automated tests for the first time in the Test Plan or want to run them in the same iteration.
    • New iteration - Creates Test Cases in the new iteration in Test Plan. Select this option if you want to run automated tests in the next iteration. In this option, you can also set a different iteration name than the default one.
      Note

      If there are no Test Cases created for the Test Plan yet, selecting this option will not allow you to create a new iteration and the results of the automated tests will be imported into the current iteration. In the same case, if you change the iteration name, it will not be renamed.

      Info

      To be able to rename iterations during the Run automated tests operation, you must configure an additional testFloImportResultsParameters parameter on the Jenkins side. See more at Jenkins integration. For Bamboo CI Server no additional configuration is needed.

  5. In the Processing test results you can choose how to process the Test Cases:
    Run automated tests operation in Test Plan in TestFLO - Test Management in Jira
    CI Server selection in Run automated tests operation
    • Update and create new Test Cases - Updates existing Test Cases and creates new Test Cases based on the results of the automated tests. Select this option:
      • If you are running tests for the first time on a Test Plan and you want to create Test Cases.
      • If you run the tests again and the scope of the tests on CI Server has changed and you want to update the existing Test Cases but also create new tests.
    • Update existing Test Cases - Updates existing Test Cases based on the results of the automated tests. Select this option:
      • If you are running the tests again and want to update only the existing Test Cases on the Test Plan.
  6. After selecting the appropriate options, click Run.
  7. You have started the process of creating Test Cases. In the Test Cases panel, you will see the progress of Running CI Automated Tests. The status of running tests you can track on the Automated test runs page.
    The progress of Running CI Automated Tests in Test Plan in TestFLO - Test Management in Jira
    The progress of Running CI Automated Tests
    Note

    You can execute the same test run twice or more within a given Test Plan without having to wait until the first test run is completed. All pending test runs are queued in the Activity tab on the Automated test runs page.

    Note

    While automated tests are running other operations in the Test Plan are blocked to avoid affecting the import of test results.

Result

Run automated tests operation in Test Plan in TestFLO - Test Management in Jira
Result of Run automated tests operation in Test Plan

After Run automated tests operation is complete the Test Cases will be created on the Test Plan with the appropriate test names and statuses. The connection between the created Test Cases and the automated tests is stored in the Automation Test Key. If the creation of Test Case Templates is enabled then for each Test Case a Test Case Template will be created as well. In the Test Case, the key of the Test Case Template will be visible in the TC Template field.

Info

By default, the Automation Test Key custom field is not present in the Test Case and Test Case Template view. For more information, see Automation Test Key.

Note

If the creation of Test Case Templates is enabled then you can reuse tests once again. You can only add selected Test Case Templates to the Test Plan to limit which test results are to be imported. You can also link the Test Case Templates and their executions in Test Cases with Requirements to track their connection in TestFLO Reports.

Note

You can also create a Test Case Template first and then add it to the Plan Test and use Run automated tests. This approach will require knowledge of the special key for the test from CI Server, which is stored in the field Automation Test Key in the Test Case Template and Test Case.

Example

Automation Test Key sample value:
[package name].[class name].[method name] com.deviniti.jira.plugins.steps.StepsServiceTest.shouldSetStepsComment

Running tests with additional parameters configured

Running tests with additional parameters configured will give you the possibility to add more information to the build and parametrize it according to special requirements. Parameters can be set in the project settings on the Test Automation tab and later use while the Run automated tests operation is triggered.

Info

See how to set additional parameters on the Test Automation project configuration.

Steps

To run automated tests with additional parameters:

  1. Click the Run automated tests operation from the Test information panel or select from menu More. After selecting the operation, a dialog box will appear where you can select the tests to run.
    Run automated tests in TestFLO
    Selecting the Run automated tests operation
  2. In the CI server section select the Server name and job/plan that you want to run.
    Run automated tests in TestFLO
    Selecting the CI server name and job or plan
  3. The configured parameters will appear in the CI server parameters section. If a parameter is configured as editable you will be able to change it. Parameters that cannot be edited are configured as read-only. Parameters that are configured as hidden are not shown on the screen but will be sent after running the operation.
    Run automated tests in TestFLO
    Filling and review of parameters
  4. Click Next.
  5. In the Import results to select if you want to import results to Current iteration or New iteration. If you pick the New iteration option you can change the iteration name or leave the default one.
    Run automated tests in TestFLO
    Configuring the Test results section
  6. In the Processing test results you can choose how to process the Test Cases:
    • Update and create new Test Cases - Updates existing Test Cases and creates new Test Cases based on the results of the automated tests. Select this option:
      • If you are running tests for the first time on a Test Plan and you want to create Test Cases.
      • If you run the tests again and the scope of the tests on the CI Server has changed and you want to update the existing Test Cases but also create new tests.
    • Update existing Test Cases - Updates existing Test Cases based on the results of the automated tests. Select this option:
      • If you are running the tests again and want to update only the existing Test Cases on the Test Plan.
  7. After selecting the appropriate options, click Run.
  8. You have started the process of creating Test Cases. In the Test Cases panel, you will see the progress of Running CI Automated Tests. The status of running tests you can track on the Automated test runs page.

Result

After Run automated tests operation is complete the Test Cases will be created on the Test Plan with the appropriate test names and statuses. All values of the configured parameters TestFLO has sent to the given build of the selected job/plan.

Run automated tests in TestFLO
Test Plan view with Test Cases created from automated test results
Example

Example of parameters sent to the Jenkins job:

Run automated tests in TestFLO
View of the parameters transferred to the executed job on the CI Server

Running tests with Selected Test Cases Parameter configured

The configured Selected Test Cases Parameter will allow you to select only those Test Cases that you want to run again in the current or new iteration. This will save you a lot of time by avoiding the need to re-run the whole Test Plan when all you need is to re-run just a few failed Test Cases.

Info

Learn how to configure Selected Test Cases Parameter in the Test Automation project configuration page.

Note

To use selecting Test Cases, automated tests must be run at least once in the Test Plan.

Steps

To run automated tests with a selection of Test Cases:

  1. On a Test Plan on which you have run automated tests at least once, click the Run automated tests operation.
    Running automated tests with Selected Test Cases Parameter configured
    Running tests with Selected Test Cases Parameter configured
  2. In the CI server section select the Server name and job/plan that was run on this Test Plan.
    Running automated tests with Selected Test Cases Parameter configured
    Running tests with Selected Test Cases Parameter configured
    Note

    Remember that the autocomplete suggests data from recently run tests. It does not necessarily have to be the same CI Server and job/plan, so you need to change these data to those that were run on this Test Plan. Otherwise, even if you select Test Cases and run the wrong job/plan, no Test Cases will be imported into the Test Plan.

  3. Click the slider next to the Select Test Cases to run option.
    Running automated tests with Selected Test Cases Parameter configured
    Running tests with Selected Test Cases Parameter configured
  4. In the Test Cases list, select the ones you want to run again. You can filter the Test Cases list using text, statuses and iteration.
    Running automated tests with Selected Test Cases Parameter configured
    Selecting Test Cases to rerun
  5. Click Next.
  6. In the Import results to select if you want to import results to Current iteration or New iteration. If you pick the New iteration option you can change the iteration name or leave the default one.
    Running automated tests with Selected Test Cases Parameter configured
    Selecting the target iteration where to send the test results
    Note

    When the Select Test Cases to run option is enabled, TestFLO does not allow the creation of new Test Cases, therefore the Update and create new Test Cases option is unavailable and the entire Processing test results option is inactive because TestFLO only updates existing Test Cases on the Test Plan.

  7. Click Run
  8. You have started the process of updating Test Cases. In the Test Cases panel you will see the progress of Running CI Automated Tests. The status of running tests you can also track on the Automated test runs page.

Result

The selected Test Cases were rerun on the CI server and their results were sent to the Test Plan and updated.

Running automated tests with Selected Test Cases Parameter configured
Running tests with Selected Test Cases Parameter configured