<devsol type="passed_icon" src="http://www.developingsolutions.com/results_icons/thumbs_up_ico.png" /> HTML Test Results
This type of report is designed to be used during automated testing, with dsClient Desktop running in headless mode (without a display) after your test is complete. It will then analyze the results and write the same test criteria Dashboard summaries produced for SmartReport to an HTML file. Your automation tool can then either move the file to a test results location or email it to interested parties. In addition, you can design the template for the HTML file to include branding or any other information you desire - test description and goals, topology diagrams, etc.
Customizing Your Template
You'll find a templates directory in the dsClient cache that contains two simple HTML templates - one that writes the dashboard summaries in a single block and one that shows how to separate them. Both files contain the local styles used for the dashboard summaries, and links to the icons used in SmartReport, as well as instructions on what may be modified. The styles that start with .dashboard are referenced when writing the HTML code for the results layout and the dashboard display, and are therefore required, either locally or in a linked style sheet. All other styles were used to format the example templates and can be replaced. You can add whatever content and styles you like and you can link to your own pass/fail icons.
dsClient interprets your template in much the same way dsTest interprets transparent data - through the use of devsol tags.
Pass/Fail Icons
The first devsol tags in your template must be those in the head section that identify the icons that will be used:
<devsol type="passed_icon" src="http://www.developingsolutions.com/results_icons/thumbs_up_ico.png" />
<devsol type="failed_icon" src="http://www.developingsolutions.com/results_icons/thumbs_down_ico.png" />
<devsol type="indeterminate_icon" src="http://www.developingsolutions.com/results_icons/thumbs_side_ico.png" />
You can modify the URL in the src attributes to bring in any image you like. The only requirement is that it be reachable at run time.
Dashboard Summaries
The dashboard summaries are always written in a two-column format. You specify which summaries you want to include and where you want them to appear. The results devsol tag indicates where some number of summaries will be written and must be closed with a results_end tag, forming a results container. Insert a devsol tag for each summary to be displayed within that container. You can display all summaries in one container or split them up if there is content that you want to add in between the summaries. The values that identify the various summaries are the element names used to store the success criteria in your SmartReport Preferences.
The example below writes all of the dashboards for a particular test separated into two layouts.
<devsol type="results" />
<devsol type="application_status" />
<devsol type="application_action" />
<devsol type="application_tps" />
<devsol type="transaction_duration" />
<devsol type="results_end" />
<devsol type="results" />
<devsol type="transport_status" />
<devsol type="protocol_status" />
<devsol type="results_end" />
Running the Report
Launch dsClient as follows:
>[path to JRE]java -jar dsClient.jar -mode results -in <path to OM database or CSV list of paths to multiple databases> -profile <name of SmartReport profile> -template <path to HTML template> -out <destination and file name for generated file>
java - depending on how Java was installed on the platform, you may need to include the full path to the JRE. The java executable will be in the bin directory.
dsClient.jar - dsClient expects to find the Preferences file (preferences.xml) in its run directory, where it resides in a normal installation.
Any parameter values that contain blank spaces must be enclosed in quotes.
Paths to database, template, and output files may be absolute or relative to the run directory. dsClient will exit with an IO error (code 2) if any referenced file cannot be found.
If you generate the report from multiple databases, dsClient will perform the same validation as it does for any report and will exit with a fatal error (code 5) if that validation fails.
Exit Codes
The jar returns an integer exit code and prints "Exiting with code n" to the console. If the jar is exiting with an error condition, SEVERE log messages in the dsClient log file (client.n.log) provide more detailed information.
0: success
2: IO error - a file could not be found, read, or written
3: invalid template - devsol tags are out of order, malformed, or reference an unknown object
4: invalid profile - the specified SmartReport profile name could not be found in preferences.xml
5: fatal error - an unrecoverable error was encountered during processing