Give us feedback
Web icon


Stable version 2.1.0 (Compatible with OutSystems 11)
Other versions available for 10
Uploaded on 27 January 2021 by 
 (60 ratings)





In order to use the TestFramework you need to import tests created in BDD Framework, Unit Testing Framework, an API test or an UI test created in Ghost Inspector (if you use another framework or tool for UI tests, contact us and we'll implement it in TestFramework).

So let's begin!

Creating a Test Suite in TestFramework

The first thing to do to import Unit Tests, is to create a new Test Suite. 

  1. Navigate to the “Define” (1) menu, and then press the “New Test Suite” (2) on the right side, and the "New Test Suite" popup will appear (3):

Fill in the fields accordingly:

  • Name: the test suite name;
  • Target URL: the application's URL;
  • Description: a short description about the test suite;
  • Import Ghost Inspector suite: to import an Ghost Inspector suite (UI Test). Note: this option will be only available if you acquired the Premium version of TestFramework;
  • Active: defines if the test suite should be runnable or not. If off, the suite will not run;
  • Daily Run: the suite will run at a scheduled time, every day. Note: it's still possible to run the suite manually;
  • Based On: will duplicate the defined suite;
  • Depends On: will run after the define suite;

After filling in the data, click “Create Test Suite” button. The test suite should now appear in the TestSuite's list, of the Define page. Next, we'll setup the suite.

Note: if it's a Ghost Inspector suite, the suite is ready to run and you won't need to import the Unit Tests.

Adding Tests to a Test Suite

  1. Select the suite to which you want to add/import the tests;
  2. If you expand the Test Suite Setup section, you'll see the details filled in during the suite creation;
  3. This step depends on what kind of tests you want to import. Jump to Step1 for instructions on importing BDD or UTF tests, or Step2 to import API Tests.


  1. Click in the UTF/BDD Test (1) button;
  2. Fill in the fields. Field Target URL (2) must be the URL of the UTF/BDD tests application;
  3. Click either the Load BDD Tests (3) or Load UTF Tests (4) button, depending on the type of tests you want to import;
  4. Once the tests are loaded, you can see which test steps were created for this test case in the left column (5);
  5. After that, click the Save Test Case button (6);


Test Framework natively supports API testing for APIs that expose REST or SOAP methods

  1. Click in the API Test (1) button;
  2. Fill in the Test Case Name and Description fields;
  3. Select the kind of API Test you want to import (2);
  4. Field API Protocol URL (3) must be the URL of the REST's swagger or SOAP's .wsdl;
  5. Click  Load API methods from Swagger definition (4) button;
  6. Once the tests are loaded, you can see which test steps were created for this test case in the left column (5);
  7. After that, click the Save Test Case button (6);

Classifying the Execution of a Test

The reason behind the importance of Testing, is to ensure that new features or changes in an application do not break anything and at the end the application behaves as expected. That being said, when a test fails it’s important to understand the reason behind the fail: was it due to a defect or is there a problem with the test itself?

TestFramework automatically classifies all tests as “Passed” if they passed or as “Unclassified”, in case they failed. In case the test is classified as Unclassified, the Tester needs to define manually if it's "Broken" or a "Defect", as the TestFramework can not do it itself. So, what defines what's a Defect or a Broken test?

Defect:  a test that failed due to a malfunction of the application. It's important to document as much information about it as possible with details such as data used, results obtained, expected results and attach logs, for example. In case it's not possible for fix what's breaking the test, the corresponding step should be put in Quarantine.

Broken:  a test that failed due to a mistake in the test itself. Could've been caused because of wrong logic for example. In this case the Tester should fix it so it does not fail again. In case that's not possible for the moment, the test should be put in Quarantine. That prevents additional classification until the test is fixed.

Test Framework Overview screen

Test results are organized on a daily basis in the Overview screen. This screen provides a way to easily follow test trends. Press the “Overview” menu option and the following screen appears.