Writing to the Report¶
Purpose¶
You can write to individual columns, create columns, and add data to the report.
Usage¶
Writing to and Creating a Column¶
Use Tester.PushReportAttribute or Tester.SetReportAttribute to set values in specific rows. Tester.PopReportAttribute reverses the effect of Tester.PushReportAttribute:
PushReportAttribute
Tester.PushReportAttribute("columnName", "value");
// ...some test steps... // The rows corresponding to these steps will have
// value in their columnName column.
Tester.PushReportAttribute("columnName", "value2");
// ...some test steps... // The rows corresponding to these steps will have
// value2 in their columnName column.
Tester.PopReportAttribute("columnName"); // Subsequent test steps will revert to the previous value for this column.
If columnName
does not exist, it will be added to the report.
SetReportAttribute
Tester.SetReportAttribute("columnName", "value");
If columnName
does not exist, it will be added to the report. For rows created after this function call, columnName
will be populated with value
(unless specified otherwise).
Adding Data¶
Data must be associated with an Assert row or a Message row.
Tester.Assert("description", "expression", "data", "columnValuePairs");
Tester.Message("description", "data", "columnValuePairs");
- description is a string.
- expression is the boolean expression that the assertion tests.
- data is an array of data objects. Each data element is written to its own row, appearing below the associated assert/message row. Data can be text, a link, or an image. The following is an example of an array containing text, link, and image data.
- columnValuePairs is an object with key/value pairs. Column names serve as the keys. If the specified column does not exist, it will be created. Example:
{requirement: "Req1.2.3", paragraph: "12.5"}
Example data array:
[
new SeSReportText("text"),
new SeSReportLink("urlString", "linkText"),
new SeSReportImage("ImageWrapperObject", "imageDescription")
]
See Also¶
- Automated Reporting
- The test samples include a reporting sample (Reporting.sstest).