Summary Checks

Summary Checks are a kind of Assertion Check that examines the summary information about an item in your script such as the number of times it has played, succeeded or failed.

Adding a Summary Check

To add a Summary Check, drag it from the Checks toolbox in the tabbed view and drop it into your script at the position your would like it to execute.

When you drag a Summary Check from the Checks Toolbox, slightly different behavior occurs depending on whether you drop it inside an existing Assertion. If you drop it inside an existing Assertion then Badboy simply creates the Check in there. However if you drop it straight into the script then Badboy will automatically create a new Assertion and put the Check inside it.

Summary Check Properties

A Summary Check has a number of properties that control how it works. Below is an example of the Properties dialog showing the options that you can choose:

Summary Check Properties Dialog

The options you can choose are described below.

Choosing Which Summary to Check

A Summary Check can only check the summary of one specific item in your script. There are two ways you can identify which item it should check:

  • By Location - This option determines an item to check by its relation to the position of the Summary Check itself. For example if you want to verify that the current playing Step has not experienced any timeouts, you can choose to check the Parent Step of the Check, and set timeouts to zero in the Values section.
  • By Id - If you wish you can simply put in an Id to check any item in your script. While this provides a lot of flexibility, it is not usually recommended since you might later change the Id of or remove the item it is referring to, in which case the Check will not play properly.

If you want to check the summaries for a group of items then you can place them in a Step and check the summary of the Step.

Setting Values to Check

To set the values to check, just check the boxes in the Values list for each summary property that you want to be examined, and then specify a maximum and minimum value for that property. If any property falls outside the range you specify then the check will fail.

Combining Value Checks

By default the Summary Check requires that all of the values selected are in the specified ranges. In this case the values are combined using and AND strategy. You can, however, choose an OR strategy in which case any one of the values being in range will allow the Summary Check to pass.


Badboy Documentation Generated on Mon Dec 29 22:28:42 EST 2008