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
- We have implemented test suite wise ordering of test cases in v2.5.0 instead of global ordering as implemented till v2.4.5.
- Earlier test suites were treated similar to tags. Now test suites are treated different from tags.
- Now test suites can have their own ordering.
- Now a Test Case can only linked to a single test suite.
- A test suite is a required property of the test case.
- 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 Case | TC Order | Linked Test Suites | Linked tags |
---|---|---|---|
TC 1 | 1 | Test Suite 1 | tag_1 |
TC2 | 2 | Test Suite 1, Test Suite 2 | tag_1 |
TC3 | 3 | Test Suite 3 | tag_1, tag_2 |
TC4 | 4 | Test Suite 2 | |
TC5 | 5Test Suite 1 | --- | |
TC6 | 6 | Test Suite 3 | tag_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".
- All the test cases of a project have been moved into the test suite named "Migrated Test Suite".
- All of the earlier test suites are kept as it is but now they are not linked to any test cases.
- All of the earlier test suites are also converted into tags with the following rules:
- First space is converted into underscore in the test suite name.
- Then a prefix (ts_<TS_INDEX>_) is added to this name.
- Then the name is truncated to 30 characters as tags have a limit of 30 characters.
- The final string is used to create tags.
- Earlier (Test Suite - Test Case) relation is converted into (Tags - Test Case) association.
Test Case | TC Order | Linked Test SuitesSuite | Linked tags |
---|---|---|---|
TC 1 | 1 | Migrated Test Suite | tag_1, ts_1_Test_Suite_1 |
TC2 | 2 | Migrated Test Suite 1, Test Suite 2 | tag_1, ts_1_Test_Suite_1, ts_2_Test_Suite_2 |
TC3 | 3 | Migrated Test Suite 3 | tag_1, tag_2, ts_3_Test_Suite_3 |
TC4 | 4 | Migrated Test Suite 2 | ts_2_Test_Suite_1 |
TC5 | 5 | Migrated Test Suite 1 | |
TC6 | 6 | Migrated Test Suite 3 | tag_1, ts_3_Test_Suite_3 |
Table 2: Database state in v2.5.0 after migration
Impact of vREST functionality in v2.5.0
- Test Execution in vREST (Critical)
- [Recommended] Move your test cases to your test suites.
- Or use tags (earlier test suites converted into tags) to filter test cases data.
- HTTP Recorder (Trivial Change)
- In HTTP recorder, Test Suite is a mandatory option now. We have set it to either "Migrated Test Suite" or "Sample Test Suite".
- This is a trivial change and no user action is required.
- vrunner (Critical)
- If you are using vrunner in any continuous integration server then you need to change the URL used in the vrunner command.
- As your earlier test suites association has been converted into tags association.
- So, you need to filter on relevant tags in your vREST project.
- Then copy the new test case list URL and use this URL in vrunner command.