You can use the Step editor to navigate through the steps in a batch or a test result and investigate differences between checkpoint and baseline images in a step. When reviewing a step, you can resolve the image differences by accepting or rejecting the differences. If the action you perform in one step is a maintenance action, then the test manager prompts you to apply the action to all other steps that fall within the scope that was set for Automated test maintenance.
The Step editor and Test editor both provide a way to review steps, deal with step differences and accept or reject changes.
- The Test editor opens in the entire Test Manager window, whereas the Step editor opens in a smaller panel that overlays the current window.
- The Test editor is limited to dealing with steps in a test, whereas the Step editor can deal with steps in a test or batch.
- The Test editor initially loads images at a larger size.
- Navigation between steps is performed differently in the two editors.
This article provides an overview of the Step editor, the Step editor interface and the operations that you perform from within the Step editor.
Accessing the Step editor
You can access the Step editor from either the Batch details view or the Batch steps view of the Test results page while viewing step thumbnails.
- Hover over a Step thumbnail.
- Click the thumbnail or from the More options drop down menu click Open in the step editor.
The Step editor shows basic test and test environment information about the step image. The editor also displays the Checkpoint image, Baseline image or both side by side, provides tools for viewing and editing the image, as well as accepting or rejecting image differences should they exist.The Step editor is divided into a number of areas:
- Indicates the position of the step within the test, the step title and the name of the Test to which the step belongs.
- Contains a set of tools for viewing, treating and resolving differences between step checkpoint and baseline images.
- Step details panel
- Indicates whether the image is a Baseline or Checkpoint image: Lists the Match level, Step title and position, and test environment details.
- Step status indicator
- Indicates the step status and whether the step is resolved or unresolved.
- Step image
- Displays a step image as it appears in the Baseline, Checkpoint or both.
- Move to previous step
- Clicking the arrow directs the Step editor to display the previous step in the test.
- Move to next step
- Clicking the arrow directs the Step editor to display the next step in the test.
- Zoom controls
- A set of controls that allow you to change the size of the baseline or checkpoint image relative to the browser window.
The Step editor displays either the checkpoint image of the step or the baseline image or both images side by side. Click anywhere on the image control , or press the T key to toggle between viewing the baseline and checkpoint images. Click the triangle on the right of the control to select a specific view.
Select visible layers
Use the select visible layer control to select what information is overlaid on the step image. For more information see Test editor select visible layer.
Hide displacement diffs
The hide displacement diffs tool in the Step and Test editors toggles a mode that displays only differences arising from changed content, hiding differences that arise from content whose position on the page has changed. This feature is useful for example, where content is added or deleted, causing other elements on the page to be displaced and generating additional differences. When a large area of the page is impacted by such a change, the page is full of pink mismatched areas, and it can be hard to identify content that has changed. By using this tool you can hide content that has only moved and focus on mismatches caused by actual changes in the content. For more information see Hide displacement diffs tool
View Root Cause Analysis (RCA) data
Open the RCA panel by clicking the Root Cause Analysis button in the View toolbar. You can also open and close the RCA panel by using the I shortcut key.
The editor displays RCA information when you click on a pink area that flags a visual difference in the checkpoint or baseline image panels (called here "diff"). The editor compares the DOM and CSS information stored with the images, and displays significant differences for any DOM elements that could impact the diff. RCA also allows you to manually select the elements whose DOM and CSS information will be compared.
For more information see Using the Root cause analysis feature.
View the test details
Open the Test details dialog box by clicking the drop down menu in the View toolbar and then clicking Test details.
The Test details dialog box displays reference information on the Test and the Baseline to which the test belongs. Some of the information provided is general information and other details can be used for trouble shooting.
For more information see Viewing test details
Show the baseline and baseline history pages
The Show baseline and Show baseline history pages can be opened from options located in the View toolbar's drop down menu .
Show baseline: Opens the Branch baselines page listing all the baselines of the test.
Show baseline history: Opens the Baseline history page listing all past revisions made to the baseline of the test.
Use the Preview match level options to preview the result of matching the checkpoint and baseline image using a different match level.
To display the step baseline and checkpoint images as they would appear using any of the match level options, click the drop down menu in the View toolbar, hover the mouse pointer over Preview match level and click one of the match level options in the list.
To run a test using a different match level you must set the match level in the SDK using the
set match level.
For more information on the Match levels see How to use Eyes match levels.
Undo changes in the test
Use the Undo changes in test option to undo changes that were not yet saved to the test baseline. As a result, the test status also reverts to the state which existed immediately after the most recent save.
Use the Diff Navigator to highlight diffs that appear in the step baseline and checkpoint images.
Click the radar button, and circles will flash wherever there are differences in the images. If a difference is positioned outside the field of view, then when you click , a circle flashes and a blurred pink strip appears on the edge of the view that indicates the direction in which to scroll to see the diff. Similarly, if a difference is positioned outside the field of view, grabbing and moving the step image causes the blurred pink strip to appear on the edge of the view to indicate that there are differences located beyond the field of view.
Click the button or type the . key repeatedly to step through all the differences by zooming on each difference in turn. Use the or the , key to navigate to the previous differences. After you see the last difference, the zoom will return to its previous zoom level.
You can create a remark or an issue with a region you mark on the step baseline or checkpoint images.
- Click Issue , or Remark from the Annotations toolbar and then drag the crosshair pointer around the area of interest on the step image.
- Add a title in the comment box that opens, click Create and then add more information or details in the text edit field. If you reference a team member's name in the text then an email is sent to the team member.
- The dialog also has tools that allow you to:
- Follow the thread (get a notification when other users add comments).
- Copy a link to your copy/paste buffer that you can save in a file or send in an email. When you paste this link into a browser it will open the Test editor on this step, with the commend editor open on this comment.
- Delete the issue or remark.
- In the case of an Issue you can also select the check box labeled Fail tests. Once you resolve the step, the test status will be Failed in the current and future runs even if you accept the test.
- If you select Fail tests, you can select the check box labeled snooze failure and select a date, in which case the test failure will only apply after the specified date.
- In the case of an issue, if you have integrated Jira into Eyes, you can also create a Jira issue or link to an existing Jira issue.
You can apply annotation regions to control how the matching mechanism matches a particular region.
- Ignore: Don't report any mismatches in a region.
- Floating: Allow the position of a region to move without reporting a mismatch.
- Match Levels
- Strict: Detect any mismatch visible to the human eye.
- Content: Allow small variations such as ignoring color.
- Layout: Check only the layout and ignore actual text and graphics.
For more information on the available match levels see How to use Eyes match levels
Click from the Annotations toolbar to open the regions menu and select a region to apply to an image.
After you select a region a dialog opens and offers you the option to apply the region to other similar steps. For more information see Adding, modifying, or deleting regions of a step.
Set the Automated Maintenance scope
Setting the Automated test maintenance scope lets you control the extent that Automated maintenance operates over the steps in a batch. You can set the scope to default, batch, explicitly selected tests or steps in a batch, or the current step only.
Set the scope by selecting an option from the Auto Maintenance menu in the Step editor tool bar.
For more information see Setting the automated test maintenance scope.
Resolve differences in a step by accepting or rejecting the differences.
Click to accept the differences and checkpoint image of a test's step, and then advance to the next step that has differences.
Click to reject the differences and keep the baseline image of a test's step, and then advance to the next step that has differences.
Note that Accepting and Rejecting differences are Automated test maintenance operations and the range over which the selected function operates is dependent on the scope you set for Automated Maintenance.
For more information see Accepting and rejecting steps.
Zoom in and out of the step images
The Zoom controls allow you to change the size of the displayed image in the browser, so you can choose to see the entire image or to focus on the details in one part of the image.
For more details see Test editor zoom controls.