Studio:Reporter

Introduction

The STRIDE Reporter allows you to track and report test cases for scripts, store test data in XML format, and produce HTML output for viewing of test case results.

The STRIDE Reporter tracks two primary objects: Suites and Test Cases, which are further described as follows:

• A Suite is a collection of Test Cases and other Suites. A Suite has a name, a description, and zero (0) or more children, which can be either Test Cases or other sub Suites.
• A Test Case represents a single pass/fail item and it consists of a name, a description, any test data that is added during the lifetime of the TestCase, and a status. The status can be any one of the following:
  • PASS
  • FAIL
  • IN PROGRESS
  • NOT APPLICABLE (or N/A)
    

Automation API

reporter

Member	Type	Description
Load (     string file )	Method	This method is a shortcut to reporter.Suites.Load().
RemoveAll ()	Method	This method is a shortcut to reporter.Suites.RemoveAll().
string MakeReport (     string file [optional],     bool linked [optional] )	Method	This method is a shortcut to reporter.Suites.MakeReport().
string Save (     string file )	Method	This method is a shortcut to reporter.Suites.Save().
ReportTemplate	Property, string	Gets/sets the report template file to use when generating HTML reports.
Suites	Object	Top level Suites collection.

reporter.Suites

Member	Type	Description
object Item (     index )	Method	Returns the specified Suite object.  The index can be integer or string. When using a string index, If the specified item is not found, this method returns null.  When using an integer index, an exception will be thrown if the requested index is out of range.
Count	Property, integer read-only	Read only property that returns the number of suites in the collection.
object Add (     string name [optional] )	Method	Creates a new Suite in the collection.  A name may be provided, but will default to TestSuite_# where # is chosen as 1 greater than the current Count of the collection. Returns the new object or throws an exception if an object with the provided name already exists. Any name that contains path separation characters (forward or back slashes) will be treated as a suite path and trigger the creation all child suites represented by the path string.
object Remove (     index )	Method	Removes a Suite from the collection and returns reference to the removed obejct.  The index can integer or string.  If the specified string index is not found, nothing is removed and null is returned.  If a provided integer index is out of range, an exception is thrown.
RemoveAll()	Method	Empties the collection.
string MakeReport (     string file [optional],     bool linked [optional] )	Method	Builds an HTML report for all suites. A filename can be passed in so the HTML results can be written to that file -- otherwise, the default filename of SuiteReport.html is used. If a full path is not specified as part of the filename, the report is generated in the STRIDE installation directory. If the linked parameter is set to true (default is false), each suite will be shown as a link in the parent suite's report.
object Find (     string name,     bool depth [optional] )	Method	Searches for a suite with the specified name and returns the object if found, null otherwise.  If depth is set to true (the default), all sub-suites will also be searched in depth first order. If a name contains path separation characters (forward or back slash), this method attempts to find the corresponding child suites represented by the path.
string Save (     string file [optional] )	Method	Saves the collection's data (including all children) as XML.  The persisted file is able to be read using the Load() method or can be upload to the STRIDE Portal. The file parameter, if provided, is the full system path to the file to create -- otherwise defaults to SuiteData.xml located in the STRIDE installation directory.
Load (     string file )	Method	Loads the results from a saved XML file. This method will not clear the current data in the collection before loading the file. The file parameter is the full system path to the XML file to load.

reporter.Suites.Item

Member	Type	Description
Suites	Object	Collection of sub-suites.
Tests	Object	Collection of Tests contained in the suite.
Name	Property, string	Gets/sets the name of the suite.  When setting the name, if another suite already exists with the same name, an exception will be thrown.
Description	Property, string	Gets/sets the description for the suite. Supports URL markdown .
string Save (     string file [optional] )	Method	Saves the suite's data (including all children) as XML. The persisted file is able to be read using the Load() method or can be upload to the STRIDE Portal. The file parameter, if provided, is the full system path to the file to create -- otherwise defaults to SuiteData.xml located in the STRIDE installation directory.
Load (     string file )	Method	Loads the results from a saved XML file. This method will not clear the current data in the collection before loading the file. The file parameter is the full system path to the XML file to load.
string MakeReport (     string file [optional],     bool linked [optional] )	Method	Builds an HTML report for the suite. A filename can be passed in so the HTML results can be written to that file -- otherwise, the default filename of SuiteReport.html is used. If a full path is not specified as part of the filename, the report is generated in the STRIDE installation directory. If the linked parameter is set to true (default is false), each suite will be shown as a link in the parent suite's report.
Linked	Property, bool	Gets/sets the linked property of the suite, used only when generating reports.  If true, this suite will be shown as a link in the parent suite's report.
Parent	Object	Returns a reference to the parent suite of the suite.  If the suite is at the root level and thus has no parent, null is returned.
Path	Property, string, read-only	Read-only property that returns the full path of the suite, with each ancestor suite separated by a forward slash (/).
Annotations	Object	Collection of annotations associated with the suite.
CustomData	Object	Collection of CustomData fields associated with the suite.

reporter.Suites.Item.CustomData

Member	Type	Description
object Item (     index )	Method	Returns the specified custom data object. The index can be integer or string. When using a string index, If the specified item is not found, this method returns null. When using an integer index, an exception will be thrown if the requested index is out of range.
Count	Method	Read only property that returns the number of custom data fields in the collection.
object Add (     string name [optional] )	Method	Creates a new custom data object in the collection. A name may be provided, but will default to CustomData_# where # is chosen as 1 greater than the current Count of the collection. Returns the created object or throws an exception if an item with the specified name already exists.
object Remove (     index )	Method	Removes a custom data object from the collection and returns reference to the removed object. The index can integer or string. If the specified string index is not found, nothing is removed and null is returned. If a provided integer index is out of range, an exception is thrown.
RemoveAll ()	Method	Empties the collection.

reporter.Suites.Item.CustomData.Item

Member	Type	Description
Name	Property, string	Gets/sets the name of the custom data field.
Value	Property, string	Gets/sets the value of the custom data field. Supports URL markdown .

reporter.Suites.Item.Annotations

Member	Type	Description
object Item (     index )	Method	Returns the specified annotation object. The index can be integer or string. When using a string index, If the specified item is not found, this method returns null. When using an integer index, an exception will be thrown if the requested index is out of range.
Count	Method	Read only property that returns the number of annotations in the collection.
object Add (     string name [optional] )	Method	Creates a new annotation in the collection. A name may be provided, but will default to Annotation_# where # is chosen as 1 greater than the current Count of the collection. Returns the new object or throws an exception if an item with the specified name already exists.
object Remove (     index )	Method	Removes an annotation from the collection and returns reference to the removed object. The index can integer or string. If the specified string index is not found, nothing is removed and null is returned. If a provided integer index is out of range, an exception is thrown.
RemoveAll ()	Method	Empties the collection.

reporter.Suites.Item.Annotations.Item

Member	Type	Description
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx

reporter.Suites.Item.Tests

Member	Type	Description
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx

reporter.Suites.Item.Tests.Item

Member	Type	Description
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx

reporter.Suites.Item.Tests.Item.Comments

Member	Type	Description
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx
xxx	xxx	xxx

reporter.Suites.Item.Tests.Item.Comments.Item

Member	Type	Description
xxx	xxx	xxx
xxx	xxx	xxx