vREST data migration from v2.4.5 to v2.5.0

We have made some architectural changes in vREST in version 2.5.0. Which required us to migrate your data according to new architecture. If you were using test suites functionality in vREST, then you should read this migration guide.

Changes in vREST v2.5.0

  1. We have implemented test suite wise ordering of test cases in v2.5.0 instead of global ordering as implemented till v2.4.5.
  2. Earlier test suites were treated similar to tags. Now test suites are treated different from tags.
    1. Now test suites can have their own ordering.
    2. Now a Test Case can only linked to a single test suite.
    3. A test suite is a required property of the test case.
    4. A vREST project will have always at least single test suite.

Let us visualise the migration changes as shown in the following tables:

Before v2.5.0

Let us suppose, we have 6 test cases in v2.4.5 with some linked test suites and tags as shown in Table 1.

Test CaseTC OrderLinked Test SuitesLinked tags
TC 11Test Suite 1tag_1
TC22Test Suite 1, Test Suite 2tag_1
TC33Test Suite 3tag_1, tag_2
TC44Test Suite 2 
TC66Test Suite 3tag_1

Table 1: Database state in v2.4.5

After v2.5.0

In v2.5.0, we have migrated that data into the following state as shown in Table 2. The migration rules applied are as follows:

  • If a project don't have any test cases then we have created a Test Suite named "Sample Test Suite".
  • Otherwise we have created test suite named "Migrated Test Suite".
    1. All the test cases of a project have been moved into the test suite named "Migrated Test Suite".
    2. All of the earlier test suites are kept as it is but now they are not linked to any test cases.
    3. All of the earlier test suites are also converted into tags with the following rules:
      1. First space is converted into underscore in the test suite name.
      2. Then a prefix (ts_<TS_INDEX>_) is added to this name.
      3. Then the name is truncated to 30 characters as tags have a limit of 30 characters.
      4. The final string is used to create tags.
    4. Earlier (Test Suite - Test Case) relation is converted into (Tags - Test Case) association.
Test CaseTC OrderLinked Test SuiteLinked tags
TC 11Migrated Test Suitetag_1, ts_1_Test_Suite_1
TC22Migrated Test Suitetag_1, ts_1_Test_Suite_1, ts_2_Test_Suite_2
TC33Migrated Test Suitetag_1, tag_2, ts_3_Test_Suite_3
TC44Migrated Test Suitets_2_Test_Suite_1 
TC55Migrated Test Suite 
TC66Migrated Test Suitetag_1, ts_3_Test_Suite_3

Table 2: Database state in v2.5.0 after migration

Impact of vREST functionality in v2.5.0

  1. Test Execution in vREST (Critical)
    1. [Recommended] Move your test cases to your test suites.
    2. Or use tags (earlier test suites converted into tags) to filter test cases data.
  2. HTTP Recorder (Trivial Change)
    1. In HTTP recorder, Test Suite is a mandatory option now. We have set it to either "Migrated Test Suite" or "Sample Test Suite".
    2. This is a trivial change and no user action is required.
  3. vrunner (Critical)
    1. If you are using vrunner in any continuous integration server then you need to change the URL used in the vrunner command.
    2. As your earlier test suites association has been converted into tags association. 
      1. So, you need to filter on relevant tags in your vREST project.
      2. Then copy the new test case list URL and use this URL in vrunner command.

Moving test cases to test suites

To move test cases from one test suite to another test suite, please follow the steps below:

  1. First select the test cases which you want to move to another test suite.
  2. Now select "Bulk Operation" option from the "# selected" dropdown.
  3. In the new modal window, select Operation "Move to Test Suite" and select the target test suite.
  4. Click on "Apply" button to complete the operation.