Merge pull request #9 from SmartBear/add-support-for-pdf-report

Download reports in pdf format

Author: Anders Jaensson

README.md

@@ -73,7 +73,7 @@ table includes the currently implemented options.
 | tags | "smoketest,regression"  | See description above|
 | output | c:\\temp\\reports  | Directory to store reports in.|
 | reportFileName | File name for the report. If omitted, the report will get a name based on the test job ID|
-| format | excel | Specify the file type of the report. Currently supported formats are json, junit and excel. The default format is junit|
+| format | excel | Specify the file type of the report. Currently supported formats are json, junit, excel and pdf. The default format is junit|
 | proxyHost | 172.0.1.10  | Hostname or IP of the server to use as a proxy for outgoing requests (from TestEngine)|
 | proxyPort | 8888  | Port of the proxyHost to contact for outgoing requests (from TestEngine)|
 | proxyUser | John  | Optional username to authenticate with the proxy|
@@ -118,13 +118,13 @@ Each job has a job ID, with the command "jobs cancel" a running (or queued) job
 Each job has a job ID, with the command "jobs report" you can request the execution report for a completed job.
 The "output" argument is mandatory, "format" is optional.
 
-`testengine jobs report output=/tmp/reports foramat=excel <job ID>`
+`testengine jobs report output=/tmp/reports format=excel <job ID>`
 
 | Option  | Sample Value  | Description|
 |---|---|---|
 | output | c:\\temp\\reports  | Directory to store reports in.|
 | reportFileName | File name for the report. If omitted, the report will get a name based on the test job ID|
-| format | excel | Specify the file type of the report. Currently supported formats are json, junit and excel. The default format is junit|
+| format | excel | Specify the file type of the report. Currently supported formats are json, junit, excel and pdf. The default format is junit|
 
 ### Clean up old jobs from the server database
 To remove old jobs from the server (to preserve disk space or limit the risk of data leakage), you can use the prune command:

bin/jobs_functions.js

@@ -69,7 +69,7 @@ function printModuleHelp() {
     util.error("Usage: testengine jobs <command>");
     util.error("Commands: ");
     util.error("   list [format=text/csv/json] [user=username|list of usernames] [status=status|(list of statuses)]");
-    util.error("   report output=<directory> [reportFileName=<filename>] [format=junit/excel/json] <testjobId>");
+    util.error("   report output=<directory> [reportFileName=<filename>] [format=junit/excel/json/pdf] <testjobId>");
     util.error("   status <testjobId>");
     util.error("   cancel <testjobId>");
     util.error("   prune [before=YYYY-MM-DD]");
@@ -131,6 +131,11 @@ function reportForTestJob(testjobId, outputFolder, fileName, format) {
                     reportFilename = fileName ? fileName : ('report-' + testjobId);
                     reportFilename += '.json';
                     break;
+                case 'pdf':
+                    contentType = 'application/pdf';
+                    reportFilename = fileName ? fileName : ('report-' + testjobId);
+                    reportFilename += '.pdf';
+                    break;
                 default:
                     util.error("Invalid format: " + format);
                     contentType = '';

bin/run_functions.js

@@ -55,7 +55,7 @@ module.exports.dispatcher = function (args) {
 function printModuleHelp() {
     util.error("Usage: testengine run <command>");
     util.error("Commands: ");
-    util.error("   project [testsuite=<name>] [async] [skipdeps] [testcase=<name>] [timeout=<seconds>] [tags=(tag1,tag2)] [output=<directory>] [reportFileName=<filename>] [format=junit/excel/json] [environment=<environment name>]");
+    util.error("   project [testsuite=<name>] [async] [skipdeps] [testcase=<name>] [timeout=<seconds>] [tags=(tag1,tag2)] [output=<directory>] [reportFileName=<filename>] [format=junit/excel/json/pdf] [environment=<environment name>]");
     util.error("           [projectPassword=<password>] [proxyHost=<hostname>] [proxyPort=<port>] [proxyUser=<username>]");
     util.error("           [proxyPassword=<password>] <filename>");
     util.error("   help");