Reporting Configuration

Add external links to report

User has possibility to link stories/scenarios to external systems like test-management or bug-tracking systems.

There are a few steps to achieve this:

  1. Configure link pattern via properties.

    Example 1. Configure link to issue tracking system in environment.properties
    system.allure.link.issue.pattern=https://vividus.dev/issues/{}

  2. Add meta tags to the story/scenario meta.

    Example 2. Story level meta-tag containing ID of the issue
    Meta:
    @issueId VVD-1

Scenario: Should check variables equals
Then `1` is = `1`

  3. Run tests and explore the links in the report.

    Link in allure report

System types

Property name Meta tag Description Example

system.allure.link.issue.pattern

@issueId

Issue link pattern

https://github.com/vividus-framework/vividus/issues/{}

system.allure.link.requirement.pattern

@requirementId

Requirement link pattern

https://github.com/vividus-framework/vividus/issues/{}

system.allure.link.tms.pattern

@testCaseId

Test case link pattern

https://vividus.jira.com/issues/{}

Multiple external systems

It is possible to configure linking to multiple systems of the same type. To achieve this user should define a custom suffix for the properties and meta tags.

Example 3. Configure links to several issue tracking systems in environment.properties
# Default property
system.allure.link.issue.pattern=https://vividus.prod/issues/{}
# Additional property with .dev suffix, that used to create links annotated with @isssueId.dev
system.allure.link.issue.dev.pattern=https://vividus.dev/issues/{}
Example 4. Story level meta-tags containing IDs of the issues belonging to different systems
Meta:
    @issueId VVD-1
    @issueId.dev DEV-1

Scenario: Should check variables equal
Then `1` is = `1`
Multiple external systems

Notifications

VIVIDUS can send notifications with test execution summary upon test completion.

Base configuration

The following table defines a set of common properties that may be used to generate notification data. All properties are optional, in case if property is not set, no corresponding data will be added to the notification.

Property name Description Example

notifications.base.project

Project name (e.g. abbreviation, code or full descriptive name)

vividus-tests

notifications.base.environment

Test execution environment, by default it’s mapped to configuration.environments property

web/qa

notifications.base.comment

Any comment to add

Smoke tests

notifications.base.report-link

URL of the report

https://my-jenkins.com/build/123/report

E-mail

VIVIDUS can send e-mail notifications via Simple Mail Transfer Protocol (SMTP). The following properties are used configure notification sending.

The properties marked with bold are mandatory.
Property name Description Example

notifications.mail.host

The SMTP server to connect to

smtp.gmail.com

notifications.mail.port

The SMTP server port to connect to

465

notifications.mail.username

User name for SMTP connection

iamvividus@gmail.com

notifications.mail.password

The user’s password

abcdefghijklmnop

notifications.mail.from

The envelope return address

iamvividus@gmail.com

notifications.mail.recipient

Comma-separated set the recipient addresses

dl@my-company.com, test-results@my-company.com

notifications.mail.security-protocol

One of the following security protocols:

  • SSL - use SSL to connect (make sure the SSL port is used).

  • STARTTLS - use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. If the server does not support STARTTLS, the connection continues without the use of TLS.

SSL