Managing Test Cases using Edit Scenario Feature

TABLE OF CONTENTS

1. Overview

1.1 Relevant Use Cases

2. Accessing the Edit Scenario Form

3. Edit Scenarios Workflow

4. Edit Scenario Interface

4.1 Editing and Deleting Scenarios

4.2 More Actions Menu

4.3 Adding or editing Given-When-Then lines (GWT) for individual steps

5.4 Adding an Alias Step

4.4 Filtering Scenarios

1. Overview

The Edit Scenarios workflow offers an efficient and organized approach for managing your test scenarios. By utilizing its various capabilities, you can easily update, arrange, and filter scenarios to meet your evolving testing requirements.

1.1 Relevant Use Cases

While Profiling the application, Edit Scenarios workflow is applicable for the following scenarios:

• Modifying Follow Me generated Test Cases: When you choose to modify or update a scenario in a test case that has been generated using Follow Me functionality.
• Accommodating Additional Requirements: When you need to modify an existing test case to accommodate additional requirements, such as updating test case steps.
  

2. Accessing the Edit Scenario Feature

To begin using the Edit Scenarios feature, follow these steps:

1. Open your web browser, enter the  and navigate to https://algoshack.net > algoQA > algoProfiler to access the Main Canvas screen.
2. On the Main Canvas, navigate to More Actions menu and select Edit Scenarios as shown:
   
   

Note: In the centralized project, concurrent users can use Save and Save as functionalities simultaneously without causing any issues with the set up files.

3. Edit Scenarios Workflow

Edit Scenarios screen allows you to access and manage scenarios more efficiently. You will be able to view, add, search, filter and reset the scenarios.

1. Navigate to https://algoshack.net > algoQA > algoProfiler to view the Main Canvas screen.
   In this screen, open an existing project listed in the left pane or create a new one.
2. In the Main Canvas > More Actions menu > Edit scenarios.  
3. Edit Scenario Form appears as shown:
   
   
   
   

Note: In a centralized project, when concurrent users work on the same scenario using the Edit Scenario feature, the active user must save their changes. Until this is done, if another user tries to edit the same scenario, they will see a lock icon displaying the username and ID of the person currently editing the scenario. The another user must wait until the active user saves their changes and exits the feature using the back button.
In a centralized project, you can uncheck scenarios currently being worked on by another user in the Edit Scenario Feature and generate test cases.
Additionally, as an admin, you will be able to uncheck the scenarios in the Edit Scenario screen and generate test cases. 

4. Edit Scenario Interface

Upon accessing Edit Scenarios feature, you will see a comprehensive range of functionalities designed for scenario management.

Viewing and searching scenarios 
You will be able to view and search through a comprehensive list of scenarios based on their scenario names, custom tags, outline, feature and structure. You can search for a particular scenario using keywords, or phrases to view the list of scenarios related to the search criteria. 

Managing scenarios order

The following buttons are available on the top-right corner of the Edit Scenarios Form window.

• Resetting the search options - Click the  button to view default settings after performing search criteria.
• Export the spreadsheet CSV file - Click the button to export the  scenarios details captured in spreadsheet in the CSV format.
• Update Legacy button - Click the button to update the existing JSON configuration files with the latest changes.
• Create new scenarios - Click the button to add new scenarios. 
  
  On the Add scenario section, expand the Scenario Form section by clicking the down arrow on the top-right corner to view the following screen. 
  In this screen, if you provide an existing scenario name, an error message will alert you, saying 'Duplicate Scenario.' This means that the scenario name you entered already exists and cannot be used again. Ensure to choose a unique name for your scenario.
  
  
  You can update an existing GWT step or add a new one by adding alias step as shown by expanding Scenario Sequence section.
  
  You can add comments by selecting the 'Add Comments' tab. This text box is used when you are using the Karate Framework. The comments column provides additional notes about the test steps.
  
  When you add a new step, make sure you save the step to view Successfully added scenario message. Edit and delete buttons will be enabled only after saving the changes to the test steps.
  

Rearranging scenarios- This action can be performed in two ways:

1. Option1: Choose the appropriate number from the Up or Down dropdown lists and then click the corresponding arrow buttons preceding the Up or Down buttons.
2. Option 2: To drag and drop the scenario, press and hold the scenario to drag it to the appropriate location.
   Note: You can use Up and Down buttons by clicking the ‘More Actions’ next to the delete icon. This enables the rearrangement of the test cases, eliminating the need for drag and drop.
   When you drag and drop a scenario, make sure to save the scenario to view Data saved successfully message. Add, Edit and Delete buttons will be enabled only after saving the scenario sequence.

4.1 Editing and Deleting Scenarios

• To edit scenario, you can use icon located before the ‘More Actions’ menu.
  In the Scenario Sequence section, you can rename a Scenario Name. Once you've made changes, the Save as button will be enabled for you to save the modifications, as shown:
  
• To delete a scenario, you can use icon.
  
  

4.2 More Actions Menu

Click the Menu to access more actions as follows:

Upload dataset- You can upload datasets in the CSV format. Ensure to select the same scenario which was created using Follow Me feature.  Dataset option - When checked, this option allows you to generate datasets that were uploaded recently. When unchecked, the system will generate default datasets. Download dataset - Easily download datasets in the CSV format. Note that Download and Delete buttons will be enabled after uploading the datasets. Delete dataset - Remove datasets as needed.

4.3 Adding or editing Given-When-Then lines (GWT) for individual steps

In the Scenario Sequence secondary section of the Edit Scenario Form, you can add or edit 'Given, When, Then' lines for individual steps in the secondary screens. This functionality aligns with the structure found in the generated Feature File, providing you with an intuitive experience.

To add individual steps to the GWT lines, perform the following:

1. In the Scenario Sequence section, click  icon to view the secondary screen as shown.
2. In this screen, you can click plus icon or edit icon to add or edit GWT steps.
   
   
3. In the secondary screen, click plus icon to add a new step, select the appropriate feature, control type from the dropdown list. Select tick mark and save the changes. You can select Show More link to add alias step and required details. Refer to the next section.
   
4. In the secondary screen, click the Edit icon to edit the existing step. Here, you can update the UI element name (control name).
   Note that delete and add icons are disabled. These buttons will be available after saving the changes.
   
   
5. Ensure to save the changes by selecting the tick mark and clicking the Save button. You can view the message Data saved successfully.
   
   

Additionally, you can provide custom values into GWT Input textbox in the Project Settings page.
To access Project Settings page > navigate to the Main Canvas > Gear icon.

5.4 Adding an Alias Step

You can use this functionality when you are adding manual steps. You can add a new step or edit an existing step.

To add an alias step, perform the following: 

1. Click the GWT steps in the Scenario Sequence secondary screen and select Show More link to view the details as shown:
   
   
2. When you enter an Alias step, Data set text box is displayed. In this text box, you can pass the parameters if required. After entering the alias step, Custom Value, TestStep Settings, Alias Name and GwtInput textboxes will be disabled.
3. If you wish to provide alias name for the controls, then you can enter the alias name and other required details and select the tick mark to save the details.
   
   Note that if you are entering any custom values into the 'Custom Value' text box, and if you provide the value in DOUBLE_QUOTE<value>DOUBLE_QUOTE format then you will see the custom value with double quotes generated in the Example table of the Feature File.
   
   If you provide custom values into the Custom Value text boxes in this format "<value>", these values will appear in the Feature File without the double quotes.
   
   As a best practice, it is recommended to select tick mark button, Save button and Back arrow.

Custom Actions are highlighted in a distinct color for easy identification. To use a Custom Action, refer to the article Using Custom Actions.

4.4 Filtering Scenarios

The Filter section of the Edit Scenarios feature provides a convenient way to sort and display scenarios based on specific criteria, enabling you to customize their view according to their needs.

Access filtering options via the filter icon.

Click the icon to view the following screen:

Following is an overview of the available filter options:

• Search and Reset options: The Search and Reset functionalities operate in the same manner as described in the previous section. 
• Filter types: You can utilize a range of filter types to categorize scenarios according to different attribute. These options include:

• Selected: Check this box to view a comprehensive list of all selected scenarios.
• Unselected: Check this box to view a list of unselected scenarios that have not been chosen.
• All: By selecting this option, you can view both selected and unselected scenarios in a unified list.
• Custom Tag: This option allows you to narrow down the scenario display by choosing a specific custom tag. Once selected, the system displays scenarios associated with the chosen custom tag.

5. Related Articles

Generating Separate Feature Files in a Separate Folder