Graphical User Interface

The tool bar resides on the left side of the main editor screen, and consists of eight buttons that are used as short cuts for common actions.  From top to bottom, the buttons have the following functions:

• create a new test case and open an editor on it
• create a new test suite and open an editor
• create a new test scenario and open an editor
• execute the currently selected test (will be deactivated if the editor is empty or if the editor's focus is on a non-test file)
• save the currently selected file (will be deactivated if the current file has no changes pending)
• save all open files
• revert the current file to the last saved version that resides on disk
• close the current file

The File menu provides access to functionality for opening, closing, saving, and reverting files.  Some of the menu items are only activated in the right context.  For example, you can't close a file if there are no files open; similarly, you can't save or revert a file that has not been changed.

The "New" submenu provides additional functionality for creating new instances of six types of files:

• test case file
• test suite file
• test scenario file
• text file
• propery file
• expected result file

The Edit menu provides two functions:

• duplicate the currently selected file, and open a new editor on it
• delete the currently selected file, and remove it from disk as well

The System menu provides access to:

• system property editor — for viewing and/or editing system-wide operational properties
• user preference editor — for viewing and/or editing user preferences that affect GUI behavior only

The DoIt! menu provides access to the main Blitz functionality:

• execute the currently selected test (see Execute for details)
• perform a trace analysis on the currently selected test (see Trace for details)
• certify that the currently selected test is valid and will (theoretically) run correctly (see Certify for details)
• promote actual results from a previous test run to expected results for future runs of the same test (see Promote for details)

The Help menu provides access to:

• the main help documentation, displayed through a specified browser
• the Javadoc API documentation, displayed through a specified browser
• an "About" screen that describes the current version of Blitz

There are several preferences that can be set to determine certain kinds of GUI behavior.  These are divided into three categories: browser location, keep data, and start state.

The preference editor is arranged as a set of tabbed panes, with some common buttons on the bottom panel:

• Apply — save the current changes to disk, but don't close the editor
• Revert — revert to the most recently saved values (this will overwrite all preferences currently in memory)
• Save — save the current changes to disk and close the editor
• Cancel — cancel all the most recent changes and close the editor (if there are changes pending, a popup dialog will ask for confirmation of this action)

Another piece of common functionality to be aware of is the existence of a checkbox to the left of each input field.  If checked, this box causes the field to be activated so that it is ready for your input; if left unchecked, your input is ignored and the system default value will be used instead.

If you modify the preferences and try to close the window without saving the changes, you will see a "changes pending" dialog as shown at the left.

See the descriptions below for specific examples and screen shots.

This screen allows you to specify the location of your browser, which is used for the on-line display of these help files.  If you don't supply a value for this preference, or if the value you enter does not refer to a valid browser, you won't be able to view the help files while running Blitz.

System default value: null

This screen allows you to indicate whether or not you want Blitz to keep track of the extents (size and location) for the main GUI window and the Console window and the list of files that are open when the program terminates.  If you select "Yes" for these properties, then Blitz will begin operation the next time you start by opening the windows in the same place and with the same size as when the program terminated, and the main GUI window will be populated with the files that were left open when you last quit. 

System default values:

• keep GUI extents: no
• keep console extents: no
• keep open files list: yes

This screen allows you to specify the start state for the main GUI window and the console window.  The available choices are:

• Normal: the window is neither iconified nor maximized
• Iconified: the window is minimized, and there is an icon on the desktop
• Maximized: the window occupies the full screen
• Last Saved: the window is in the state it was in when you last terminated Blitz

System default value (for both windows): last saved

Like the preference editor, the system properties editor is arranged as a set of tabbed panes, with some common buttons on the bottom panel:

• Apply — save the current changes to disk, but don't close the editor
• Revert — revert to the most recently saved values (this will overwrite all preferences currently in memory)
• Save — save the current changes to disk and close the editor
• Cancel — cancel all the most recent changes and close the editor (if there are changes pending, a popup dialog will ask for confirmation of this action)

Another piece of common functionality to be aware of is the existence of a checkbox to the left of each input field.  If checked, this box causes the field to be activated so that it is ready for your input; if left unchecked, your input is ignored and the system default value will be used instead.

If you modify the properties and try to close the window without saving the changes, you will see a "changes pending" dialog as shown at the left.

Specific examples and screen shots follow.

This screen allows you to specify the classes to use for each of the attributes Agency, Matcher, and Filter.  See System Properties for details about the properties and their meanings.

This screen allows you to identify search paths that will be used for Test File Root, Property File Root, Expected Result, Actual Result, Outcome Output, and Trace Output.  See System Properties for details about the properties and their meanings.

This screen allows you to specify the type of inheritance use when resolving Properties or Matcher details.  See System Properties for details about the properties and their meanings.

This screen allows you to specify whether test execution should be sequential or concurrent by default.  See System Properties for details about the properties and their meanings.

This screen allows you to specify which values to use for maximum Error and maximum Failure counts.  See System Properties for details about the properties and their meanings.

This screen allows you to specify what level of detail should be provided during a Trace run.  See System Properties for details about the properties and their meanings.

• Name: a simple text field.
• Description: a simple text field.
• Test File Root Path: a simple text field.
• Property File Root Path: a simple text field.
• Agency Classname: a simple text field.
• Agency Arguments: a special list field that can hold text entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Matcher Classname: a simple text field.
• Matcher Arguments: a special list field that can hold text entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Filter Classname: a simple text field.  (Note: this field is only visible if the Matcher Classname field contains data.)
• Filter Arguments: a special list field that can hold text entries only.  (Note: this field is only visible if the Matcher Classname field contains data.)
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Properties: a special list field that can hold properties (key-value pairs) or filename entries.
  • See List Manager for descriptions of button functionality.
  • See Edit Property Entry for an explanation of how to modify a particular entry in the list.
• Property Inheritance: 4-value radio button.  (If "Default" is selected, then the value from the system properties is used, or the system default if none is defined there.)
• Matcher Inheritance: 4-value radio button.  (If "Default" is selected, then the value from the system properties is used, or the system default if none is defined there.)
• Commands: a special list field that can hold text entries or filename entries.
  • See List Manager for descriptions of button functionality.
  • See Edit Command Entry for an explanation of how to modify a particular entry in the list.
• Expected Result File: a simple text field.
• Actual Result File: a simple text field.

See Abstract Test and Test Case for specific details around the meanings and requirements for each of the fields.

• Name: a simple text field.
• Description: a simple text field.
• Test File Root Path: a simple text field.
• Property File Root Path: a simple text field.
• Agency Classname: a simple text field.
• Agency Arguments: a special list field that can hold text entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Matcher Classname: a simple text field.
• Matcher Arguments: a special list field that can hold text entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Filter Classname: a simple text field.  (Note: this field is only visible if the Matcher Classname field contains data.)
• Filter Arguments: a special list field that can hold text entries only.  (Note: this field is only visible if the Matcher Classname field contains data.)
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Properties: a special list field that can hold properties (key-value pairs) or filename entries.
  • See List Manager for descriptions of button functionality.
  • See Edit Property Entry for an explanation of how to modify a particular entry in the list.
• Execution Mode: a 3-value radio button.  (If "Default" is selected, then the value from the system properties is used, or the system default if none is defined there.)
• Loop Times: a simple text field.  The contents are validated to ensure correctness.
• Loop Duration: a simple text field.  The contents are validated to ensure correctness.
• Test Files: a special list field that can hold filename entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit File Entry for an explanation of how to modify a particular entry in the list.

See Abstract Test and Test Suite for specific details around the meanings and requirements for each of the fields.

• Name: a simple text field.
• Description: a simple text field.
• Test File Root Path: a simple text field.
• Property File Root Path: a simple text field.
• Agency Classname: a simple text field.
• Agency Arguments: a special list field that can hold text entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Matcher Classname: a simple text field.
• Matcher Arguments: a special list field that can hold text entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Filter Classname: a simple text field.  (Note: this field is only visible if the Matcher Classname field contains data.)
• Filter Arguments: a special list field that can hold text entries only.  (Note: this field is only visible if the Matcher Classname field contains data.)
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Properties: a special list field that can hold properties (key-value pairs) or filename entries.
  • See List Manager for descriptions of button functionality.
  • See Edit Property Entry for an explanation of how to modify a particular entry in the list.
• Execution Mode: a 3-value radio button.  (If "Default" is selected, then the value from the system properties is used, or the system default if none is defined there.)
• Loop Times: a simple text field.  The contents are validated to ensure correctness.
• Loop Duration: a simple text field.  The contents are validated to ensure correctness.
• Test Files: a special list field that can hold filename entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit File Entry for an explanation of how to modify a particular entry in the list.
• Failure Limit: a simple text field.  The contents are validated to ensure correctness.
• Error Limit: a simple text field.  The contents are validated to ensure correctness.

See Abstract Test, Test Suite and Test Scenario for specific details around the meanings and requirements for each of the fields.

• Name: a simple text field.
• Description: a simple text field.
• Test File Root Path: a simple text field.
• Property File Root Path: a simple text field.
• Agency Classname: a simple text field.
• Agency Arguments: a special list field that can hold text entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Matcher Classname: a simple text field.
• Matcher Arguments: a special list field that can hold text entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Filter Classname: a simple text field.  (Note: this field is only visible if the Matcher Classname field contains data.)
• Filter Arguments: a special list field that can hold text entries only.  (Note: this field is only visible if the Matcher Classname field contains data.)
  • See List Manager for descriptions of button functionality.
  • See Edit Text Entry for an explanation of how to modify a particular entry in the list.
• Properties: a special list field that can hold properties (key-value pairs) or filename entries.
  • See List Manager for descriptions of button functionality.
  • See Edit Property Entry for an explanation of how to modify a particular entry in the list.
• Execution Mode: a 3-value radio button.  (If "Default" is selected, then the value from the system properties is used, or the system default if none is defined there.)
• Loop Times: a simple text field.  The contents are validated to ensure correctness.
• Loop Duration: a simple text field.  The contents are validated to ensure correctness.
• Test Files: a special list field that can hold filename entries only.
  • See List Manager for descriptions of button functionality.
  • See Edit File Entry for an explanation of how to modify a particular entry in the list.
• Failure Limit: a simple text field.  The contents are validated to ensure correctness.
• Error Limit: a simple text field.  The contents are validated to ensure correctness.

See Abstract Test, Test Suite and Test Scenario for specific details around the meanings and requirements for each of the fields.

Lists in the Blitz GUI can hold several types of data items.  Each of these will have a distinct appearance in the list:

• Text: Appears as "[T: xxxxx]", where "xxxxx" is the actual data supplied by you.
• Property: Appears as "[P: key=value]" where "key" is a property key supplied by you, and "value" is the value that has been associated with the key.
• Filename: Appears as "[F: xxxxx.xxx]", where "xxxxx.xxx" is the name of the file supplied by you.

Every list manager includes six buttons which appear at the bottom border of the field.  From left to right, these buttons have the following functions:

• Add: Open an appropriate editor dialog to add a new entry to the list.  When you click OK, the new addition will appear immediately following the currently selected item.
• Remove: Remove the currently selected item from the list.  A dialog will prompt you to confirm the deletion of the item.
• Up: Move the selected item upward in the list.
• Down: Move the selected item downward in the list.
• Open: If the selected item represents a filename, open the file in its own editor.
• Edit: Open an appropriate editor dialog to modify the contents of the selected item.

List manager buttons become enabled or disabled depending on the state of the list.  For example, the Remove button is only active if there is an item to delete.  Similarly, the Up and Down buttons are only active if the selected item can be moved in the desired direction.  Also, the Open button is only active when the list contains filenames and the selected item is a filename.

This screen provides a mechanism for entering or editing text that is being handled by the List Manager.  You can modify the contents of the text field.  When complete, click OK to accept the data, or Cancel to discard it.

This screen provides a mechanism for entering or editing a filename that is being handled by the List Manager.  You can modify the contents of the text field directly, or you can use the Browse button to find and select the desired file.  When complete, click OK to accept the data, or Cancel to discard it.

This screen provides a mechanism for entering or editing a property or filename that is being handled by the List Manager.  If there is data in the property section (i.e. either the Key or Value field), then the Filename field will be disabled.  Similarly, if there is data in the Filename field, then the other fields will be disabled.  If the Filename field is enabled, then the Browse button will also be enabled; otherwise, it is disabled.

For this dialog, the file type is assumed to be a typical Java properties file, which means that the file must end with ".properties".  The file chooser will restrict you to files with that extension.

When you are done editing the contents, click OK to accept the data, or Cancel to discard it.

This screen provides a mechanism for entering or editing a text string or a filename that is being handled by the List Manager.  If there is data in the Command field, then the Filename field will be disabled.  Similarly, if there is data in the Filename field, then the other field will be disabled.  If the Filename field is enabled, then the Browse button will also be enabled; otherwise, it is disabled.

For this dialog, the file type is assumed to be a simple text file, which means that the file must end with ".txt".  The file chooser will restrict you to files with that extension.

When you are done editing the contents, click OK to accept the data, or Cancel to discard it.

When a test is executed, and it runs to successful completion, the Console shows a summary of the test outcome; details of that outcome are stored in file, and a separate Outcome Viewer is also opened.

If an executed test fails for some reason, the Console will report the error message that caused the failure.

• you select "Execute" off the DoIt! menu for the selected test, and execution runs to successful completion
• you explicitly open a file that whose name ends with ".outcome"

In either case, the viewer displays all the details of the contents of the specified file.