Introduction to Debugging

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

Apply classic “debug mode” principles to test creation using both the Clip Editor and the Composition Editor. CloudTest debugging will identify errors and possible performance bottlenecks in a composition by giving attention to each step of the test in the manner of traditional programming debugging tools.

 

CloudTest debugging provides breakpoints and the ability to step through the test while viewing relevant detail information at both the tree level and within any given container.

  • In the Clip Editor, easily define run to next breakpoints on any clip element and gain convenient debug access to any container within the test. Once breakpoints are defined, easily toggle them on/off by clicking the Breakpoint icon.
  • In the Composition Editor, use the new Debug tab to to play, view, and step through a test in one convenient Debugging dashboard. Debug commands appear on the toolbar, and include play control as well as step and resume. The General Debug Options drop-down allows breakpoints to be set on-the-fly for validations, errors, and failures. Conditional breakpoints can be assigned by clicking the Debug Options drop-down.

The Debug tab’s player control displays the Debug play icon instead of the Play button shown in other tabs.

Debug Tab and Default Debugging Dashboard

Like the Play and Results tabs, the Composition Editor, Debug tab uses a toolbar/dashboard approach to display information about a playing, as well as a completed, test.

Note: The debugging widgets can also be included in custom debug dashboards (see the new Debugging category in the Widget Type list). Any dashboard created in the Debug tab of a given composition will continue to be associated with it.

The default system Debugging Dashboard consists of all four debug widgets:

  • Composition Tree – After Load is clicked on the Composition Editor toolbar, this widget shows test components in order and indicates all breakpoints that are set, whether enabled or disabled. This tree is similar to the one presented in the Result Details widget and is used to view the timeline of debug play (in real time);

  • Clip Editors Container– This widget shows a nested Clip Editor view of the item selected in the Composition Tree; right-click to add or remove an existing breakpoint for a clip element in display.

  • Composition Breakpoints – This widget shows where breakpoints are set in the test using the full path of the given clip element.

    • Property Inspector – This widget shows properties of special interest in the test by Name (the name of either a System or Custom property), Type, and Value.

The Property Inspector, Type column shows either System or Custom properties (as in the Property Sets, Path dialog box). System properties can be null or text, while custom properties have six possible types: null, text, integer, float, datetime, and array.

Step and Resume Toolbar Commands

To the right of the Debug player control on the toolbar, the Step/Resume buttons are provided to Step Over, Step Into, Step Back, and to Step Out of the current object. Use Resume to continue after a breakpoint is reached.

  •  Debug – Play the test in debug mode.
  •  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 – 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 – 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 – Step out of the current container and pause in the parent container.
  •  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.

 

General Debug Settings

The General Debug Options drop-down is used to conditionally assign breaks to validation failure(s), on error(s), and on failure(s). Checking a box here will assign an on-the-fly breakpoint for each type checked.

  • Break on Validation Failure

Check this option to break when an item fails a validation (without having to open the clip and clip element in the Clip Editor to do so).

  • Break on Error

Check this option to break when an item produces an error (without having to open the clip and clip element in the Clip Editor to do so).

  • Break on Failure
Check this option when an item fails (without having to open the clip and clip element in the Clip Editor to do so).

General Debug Settings also appear in the Composition Editor, Edit tab when composition properties are in display.

Attachments

    Outcomes