Sync Scenarios
Overview
Sync Scenarios is used to keep the scenarios created in the product aligned with the latest test automation code.
When automation code changes, the scenarios in the product may no longer match the current code structure. For example, new test methods may be added, existing methods may be removed, or scenario names may change in the repository.
With Sync Scenarios, users can compare the scenarios detected from the automation code with the scenarios currently available in the product, then import missing scenarios or remove outdated ones.
What You Can Do with Sync Scenarios
With this feature, users can:
- Detect methods/scenarios that exist in the automation code but are not yet created in the product.
- Create missing scenarios in bulk.
- Detect scenarios that exist in the product but no longer exist in the automation code.
- Remove outdated scenarios in bulk.
- Review the result of the completed sync operation.
When to Use Sync Scenarios
Use Sync Scenarios when there are changes in the test automation code, such as:
- New test methods or specs are added.
- Existing test methods are deleted.
- Test methods are renamed.
- Test files are reorganized.
- The selected branch contains different scenario definitions.
- Scenarios in the product are no longer aligned with the automation repository.
This is especially useful for projects with many scenarios, where manually creating or removing scenarios one by one would take too much time.
Sync Flow
The sync process consists of four steps:
- Project
- Methods to import
- Methods to remove
- Summary
Step 1: Project
In the Project step, select the project whose scenarios will be synchronized.
The selected project is used to detect the available test methods, specs, or scenario definitions from the automation code.
After selecting the project, continue to the next step.
Step 2: Methods to Import
The Methods to import step shows the methods/scenarios that exist in the automation code but have not yet been created in the product.
These items are treated as missing scenarios and can be created in bulk.
In this step, users can:
- Expand files to view detected methods.
- Select all methods or specific methods.
- Select all methods under a specific file.
- Edit the scenario name before creation.
- Continue with the selected methods to create them as scenarios.
Example:
The Method Name represents the method or scenario detected from the automation code.
The Scenario Name represents the scenario name that will be created in the product. This name can be edited before proceeding.
Only selected methods will be created.
Step 3: Methods to Remove
The Methods to remove step shows the scenarios that already exist in the product but are no longer found in the automation code.
These scenarios are considered outdated because their related method, spec, or scenario definition no longer exists in the current code.
In this step, users can:
- Review outdated scenarios grouped by file.
- Select all scenarios or specific scenarios.
- Select all scenarios under a specific file.
- Decide which scenarios should be removed.
- Start the sync operation by clicking Sync.
Only selected scenarios will be removed.
If a scenario should remain in the product, it should be deselected before continuing.
Step 4: Summary
The Summary step displays the result after the sync operation is completed.
This is not a confirmation step. The synchronization has already been performed when the user reaches this page.
The Summary page helps users review which changes were successfully applied.
It can include two result sections:
- Created Scenarios
- Deleted Scenarios
Each section groups results by file name and shows the operation result for each scenario.
Created Scenarios
The Created Scenarios section lists the scenarios that were created during the sync operation.
For each file, the page displays a count in this format:
Example:
This means that 1 scenario was successfully created out of 1 selected scenario.
Each scenario row includes:
- Scenario Name
- Status
A checkmark in the Status column means the scenario was created successfully.
Deleted Scenarios
The Deleted Scenarios section lists the scenarios that were removed during the sync operation.
For each file, the page displays the number of successfully deleted scenarios compared to the total selected scenarios.
Example:
This means that 4 scenarios were successfully deleted out of 4 selected scenarios.
Each scenario row includes:
- Scenario Name
- Status
A checkmark in the Status column means the scenario was deleted successfully.
Summary Actions
At the end of the Summary step, users can use the available actions:
- Start Over: Starts the sync flow again.
- Finish: Closes or completes the sync process.
Example Scenario
A user adds a new scenario to the automation code:
However, this scenario has not yet been created in the product.
When the user opens Sync Scenarios, the scenario appears under Methods to import. The user selects it and continues.
If there are also scenarios in the product that no longer exist in the automation code, they appear under Methods to remove. The user can select the outdated scenarios and click Sync.
After the operation is completed, the Summary step displays the result:
This means that one scenario was created successfully and four outdated scenarios were removed successfully.
Important Notes
- Sync Scenarios does not automatically create or remove every detected difference. Users select which items should be imported or removed.
- Removing a scenario from the product does not delete the test automation code.
- Imported scenarios are created based on the methods or scenarios detected from the automation code.
- Scenario names can be edited during the import step before they are created.
- If a method is renamed in the code, the old scenario may appear under Methods to remove, while the new method may appear under Methods to import.
- The Summary step is shown after the operation is completed and is used to review the result.
- Users should carefully review selected items before clicking Sync, especially in shared projects or projects with active plans.
Recommended Usage
It is recommended to use Sync Scenarios after meaningful automation code changes, especially when:
- New scenarios are added.
- Existing scenarios are renamed.
- Test files are deleted or reorganized.
- A project branch is changed.
- Plans depend on recently updated scenarios.
- Large numbers of scenarios need to be maintained.
Using Sync Scenarios helps keep scenario definitions clean, accurate, and aligned with the latest automation code.