Debugging a Test

Document created by Chris Sommerstad Employee on Jul 21, 2017Last modified by Chris Sommerstad Employee on Jul 21, 2017
Version 2Show Document
  • View in full screen mode

CloudTest debugging is performed by first applying one or more breakpoints via the Clip Editor and then subsequently using the Composition Editor’s Debug tab to play and step through the composition. Alternately, with your composition open in the Debug tab, click Load to display the test contents in the Composition Tree widget, and then click to navigate to the location where you'd like to add a breakpoint. Breakpoints can be added to items displayed in the Clip Editors Container.

While in Debug play mode, the Composition Tree presents the visual cues to correlate progress with specific clip elements in your test shown in the Clip Editors Container. The debugging widgets work together to show one synchronized debug view.

Once breakpoints are inserted the remaining debugging tasks take place in the Composition Editor, Debug tab. Breakpoints can be set ahead of time for any clip element that fails validation, is an error, or is a failure by checking one or more options in the Debug Options drop-down.

As debug play progresses, the orange “caret” bar progresses in the Composition List widget, while the corresponding clip element displays an orange caret that moves in tandem within the Clip Editors Container.

Working with Breakpoints in the Clip Editor or Clip Editors Container

Breakpoints can be added, enabled and disabled in place, and removed using the following simple instructions.

    1. To begin debugging, first determine where to insert breakpoints. Navigate to that location in either the Clip Editor or the Clip Editors Container in the Debugging dashboard. Be sure to click the Load command on the toolbar if no content displays for any open test in the Debug tab.
      • Adding Breakpoints – Add a breakpoint to one or more selected item(s). This can also be done within the Clip Editor.
      • Remove Breakpoint – Remove the breakpoint from the selected item(s). This can also be done within the Clip Editor. Alternately, click the icon or row surface to toggle off this breakpoint without removing it.

Note: A breakpoint is different from a “stop” of a composition because there is no stop at the API level.

    To add a breakpoint, right-click an item in the Clip Editor, List view and choose Add Breakpoint to insert the breakpoint at this place in the test.

Or, right-click an item in the Icon view.

Expand a container in either view to apply a breakpoint to one of its children.

Once added, the Breakpoint icon appears enabled on the clip element’s surface in Icon view (and it appears next to the Scope icon in List view).

Toggle a Breakpoint On/Off

  • Click the surface breakpoint for a given icon, or click the Breakpoint icon for a given row in List view, to toggle that breakpoint off.

 

Remove a Breakpoint

    1. Click to select the clip element that has the breakpoint, and then right-click to choose Remove Breakpoint.
    2. >Once the breakpoint(s) has been removed, save the clip and proceed to the Composition Editor, either by by clicking Open in Composition Editor or by opening the composition from the Compositions list.

When playing in Debug mode the composition will stop at enabled breakpoints, as well as follow “steps” defined via the toolbar.

Note: The Status Log will indicate Debug mode when playing from this tab.

Using Steps to Debug

Use the Step buttons on the toolbar to play one element at a time to skip over, go back, etc. as indicated by the button.

  •  Step Over – Step over the selection by playing it without pause and proceed to the next (this is often called “Next” in some debuggers) clip element. For example, when no problem exists or is expected in the container.
Step Into a Selection
  •  Step Into – Step into this container and any child containers it may have. Doing so will allow you to track each test component as it plays (indicated by the orange “caret”). 
Step Back to a Selection
  •  Step Back – Step back to the prior container and re-run it (and any of its children). Doing so, will cause the caret to move back in the test.
Step Out of a Selection
  •  Step Out – Step out of the current container and pause in the parent container.
Resuming after a Break
  •  Resume – Resume debug play from this point forward to the next breakpoint or until the test ends. For example, in the container that contained a prior Step Into, Resume will be used to continue debug play.

 

Using  Debug Widgets in a Custom Dashboard

Custom Debug dashboards can be created via the Debugging category in the Widget Type list of the Widget Selection Panel.

Attachments

    Outcomes