com.qmetry.qaf.automation.report

Class EmailableReport

java.lang.Object

com.qmetry.qaf.automation.report.EmailableReport

All Implemented Interfaces:

TestCaseResultUpdator

public class EmailableReport
extends java.lang.Object
implements TestCaseResultUpdator

TestCaseResultUpdator implementation to generate emailable version of Overview with link to the detailed report.

Properties used

emailable.report.enabled

boolean to enable/disable this listener. Default value is true.

report.server

set report server URL where actual detailed reports available. For example jenkins job workspace URL.

emailablereport.savelocal

boolean to save email content in file. Default value is true.You use the generated file to send as email in CI post build action

emailablereport.sendemail

boolean to send email. Default value is false. You need to set smtp properties, email credentials and recipient list to send email.

emailablereport.multipart

boolean to send email as multipart. Default value is false. Takes effect if you configured to send email

emailablereport.user

sender email id. Required if you configured to send email

emailablereport.password

sender psasword. Required if you configured to send email

emailablereport.to

list of recipients email address. Required if you configured to send email

emailablereport.subject

Optional email subject line. Will be used if you configured to send email

Features

Generates emailable report same as Overview in detailed reporting.

• Execution summary with pass, fail, skip and total test count, percentage
• Pie chart or stacked bar chart
• Test set wise pass, fail, skip and total test count and pass rate
• Environment information
• Link to dashboard for detailed report
• Responsive design

If mail client doesn't supports advance CSS features, as a alternate of pie chart, you may see horizontal stacked bar chart in email message. If app-logo.png file is available at project root, it will be placed in message header.

Author:

chirag.jayswal

Constructor Summary

Constructors

Constructor and Description
EmailableReport()

Method Summary

Modifier and Type	Method and Description
void	beforeShutDown() Each Updator class can define implementation for this method.
boolean	enabled() Useful when registered with service, to enable disable based on some condition.
java.lang.String	getToolName()
boolean	updateResult(TestCaseRunResult result)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.qmetry.qaf.automation.integration.TestCaseResultUpdator

allowConfigAndRetry, allowParallel

Constructor Detail

EmailableReport

public EmailableReport()

Method Detail

updateResult

public boolean updateResult(TestCaseRunResult result)

Specified by:

updateResult in interface TestCaseResultUpdator

Parameters:

result - - test case result

Returns:

status of update call

getToolName

public java.lang.String getToolName()

Specified by:

getToolName in interface TestCaseResultUpdator

Returns:

tool name

beforeShutDown

public void beforeShutDown()

Description copied from interface: TestCaseResultUpdator

Each Updator class can define implementation for this method. This method will be invoked at the end of execution either all test completed or force exit. Separate instance will be created to execute this method.

Specified by:

beforeShutDown in interface TestCaseResultUpdator

enabled

public boolean enabled()

Description copied from interface: TestCaseResultUpdator

Useful when registered with service, to enable disable based on some condition.

Specified by:

enabled in interface TestCaseResultUpdator

Returns: