Skip to content
QiTASC.com / intaQt Setup and Configuration /
Reporting and Report Formats
/ .. /
Reporting and Report Formats





Reporting and Report Formats

Reports are generated after every scenario execution and stored by default in the intaqt/reports/ folder. Optional configurations are available to customize the reports' file names and for sending/receiving reports by email. Two types of reports are available:

  • Final reports - A zipped folder that contains all files for the feature's execution. This is the same as the folder that appears in the intaqt/reports/ directory after each execution.

  • HTML-only report - An HTML report file that specifies failures after a feature has failed.

Reporting & Report Formats
Reports
Report Artifacts
Report Formats

Important!

  • If using the mailFrom E-mail feature, the address must be specified in an active Mail configuration.

  • All reports contain copies of the .conf files accessed by the test run. This means that the report folder should not be in the same path as any configuration files being used. Otherwise the .conf files may interfere with each other.

Reporting

Syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
Reporting {
    mailFrom = <String>
    mailTo = <String>
    immediatelyMailFailingFeature = <Boolean>
    mailFinalReportForFailures = <Boolean>
    alwaysMailFinalReport = <Boolean>
    reportsRootFoldername = <String>
    reportFoldernameDateFormat = <String>
    reportFoldernameSuffix = <String>
    reportArtifactFeaturePrefix = <String>
    reportArtifactScenarioPrefix = <String>
    logcatMaxFileSizeinKiB = <Number>
}

Parameters

  • mailFrom - The E-mail address the reports will be sent from

  • mailTo - The E-mail address(es) the reports will be sent to

    • Multiple comma-separated addresses may be specified
  • immediatelyMailFailingFeature -

    • true sends an HTML-only report specifying failures immediately after a feature has failed
    • false (default) otherwise
  • mailFinalReportForFailures

    • true sends a zipped final report in cases of any failures
    • false (default) otherwise
  • alwaysMailFinalReport

    • true sends a zipped final report in case features have failed or passed
    • false (default) otherwise
  • pathToReports - The path to the root folder where the reports will be stored

    • In order to prevent intaQt from using the wrong configuration files, this folder should not be in the same location as the project configuration files folder
  • dateFormat - Configures the date format that each report folder's name will start with

    • Default is set to yyyy-MM-dd-HH-mm-ss.
  • folderSuffix - The folder name's suffix, note that the feature name follows the suffix

  • reportArtifactFeaturePrefix (Optional, additional information below) - The feature name to be used for all report artifacts

    • Default template for the feature name
    • Any combination of placeholders and static strings are accepted
    • Special characters (for example,* , #) will be replaced by their UTF-16 codepoint
  • reportArtifactScenarioPrefix (Optional, additional information below) - The scenario name to be used for all report artifacts

    • Any combination of placeholders and static strings are accepted
    • Special characters (for example, * , #) will be replaced by their UTF-16 codepoint
  • logcatMaxFileSizeinKiB (Optional) - The maximal size for logcat files saved to the report

    • Default value is set to 10240 (10 MiB)

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
Reporting {
    mailFrom = "reports@qitasc.com"
    mailTo   = "reports@qitasc.com, backup@qitasc.com"
    immediatelyMailFailingFeature = true
    mailFinalReportForFailures = true
    alwaysMailFinalReport = true
    reportsRootFoldername = "/Users/QiTASC/ProjectA/reports"
    reportFoldernameDateFormat = "yyyy-MM-dd_HH-mm-ss"
    reportFoldernameSuffix = "sms"
    reportArtifactFeaturePrefix = "{index} Custom feature name"
    reportArtifactScenarioPrefix = "{name} # {index}"
    logcatMaxFileSizeInKiB = 100

}

Using the example configuration above, the test report folder for a feature called websearch could look as follows:

1
2017-08-02_15-34-06smswebsearch

The report artifacts would look like:

1
2
3
1 Custom feature name.csv
1 Custom feature name-National Call x0023 1-protocol.log
1 Custom feature name-International Call x0023 2-protocol.log

In the example above, the second and third report artifacts contain x0023 because the # was replaced by its UTF-16 codepoint.

Report Artifacts

Report Artifacts may be configured in the Reporting block by specifying the prefixes of Feature File (reportArtifactFeaturePrefix) and/or Scenarios (reportArtifactScenarioPrefix), as demonstrated above.

Report Artifacts - Features

When a configuration value for reportArtifactFeaturePrefix is not provided, the following default pattern is used:

Syntax

1
{index}_{name}

Parameters

  • {index} - A placeholder for the feature index, as determined by the execution order

  • {name} - A placeholder for the feature name, as determined in the Feature File

Example The execution of two test cases, named Simple Call and Conference Call will lead to the following report artifacts, among others:

1
2
1_Simple Call.csv
2_Conference Call.csv

Report Artifacts - Scenarios

When a configuration value for reportArtifactScePrefix is not provided, the following default pattern is used:

Syntax

1
{index}_{name}

Parameters

  • {index} - A placeholder for the scenario index, as determined by the scenario order in the Feature File

  • {name} - A placeholder for the scenario name, as determined in the Feature File

Example Executing a Feature File named Simple Call, containing two scenarios called National Call and International Call, will lead to the following report artifacts, among others:

1
2
1_Simple Call-1_National Call-protocol.log
1_Simple Call-2_International Call-protocol.log

Note: The scenario prefix will always be prepended by the feature prefix and separated by a dash (-).

Report Formats

Multiple report formats can be defined using intaQt's pre-formatted templates or user-defined templates.

Syntax

1
2
3
4
5
6
7
8
9
ReportFormats {
    <Name> {
        featureTemplateFilename = <String>
        summaryTemplateFilename = <String>
        summaryFilename = <String>
        featureSuffix = <String>
    }
    ...
}

Parameters

  • formatName - The name assigned to the format configuration

  • featureTemplateUrl - The URL that holds the template for the Feature File report

  • summaryTemplateUrl - The URL that holds the template for the summary report

  • summaryFilename - Specifies the name of the file that contains the summary report

    • If unspecified, the summary report name will be index
  • featureSuffix - Replaces the test case's feature name with the specified configuration

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
ReportFormats {
    csv {
        featureTemplateFilename = "../.autotest/report-templates/management.csv"
    }
    html {
        featureTemplateFilename = "../.autotest/report-templates/management.html"
        summaryTemplateFilename = "../.autotest/report-templates/summary.html"
    }
    xml {
        featureTemplateFilename = "../.autotest/report-templates/management.xml"
        summaryTemplateFilename = "../.autotest/report-templates/summary.xml"
        summaryFilename = "summary"
        featureSuffix = ""
    }
}