README.md

Description

Maven plugin for interaction with AssertThat BDD Jira plugin.

Main features are:

• Download feature files before test run
• Filter features to download based on mode (automated/manual/both), or/and JQL
• Upload cucumber json after the run to AsserTthat Jira plugin

Installation

Full plugin configuration below, optional properties can be omitted

 <plugin>
    <groupId>com.assertthat.plugins</groupId>
    <artifactId>assertthat-bdd-maven-plugin</artifactId>
    <version>1.7.4</version>
    <configuration>
        <projectId>
            <!--Jira project id e.g. 10001-->
        </projectId>
        <!--Optional can be supplied as environment variable ASSERTTHAT_ACCESS_KEY -->
        <accessKey>
            <!-- ASSERTTHAT_ACCESS_KEY -->
        </accessKey>
        <!--Optional can be supplied as environment variable ASSERTTHAT_SECRET_KEY -->
        <secretKey>
            <!-- ASSERTTHAT_SECRET_KEY -->
        </secretKey>
        <!--Optional can be supplied as environment variable ASSERTTHAT_TOKEN -->
        <!-- Jira API token (for DataCenter only) as an alternative to accessKey/secretKey basic auth -->
        <token>
            <!-- ASSERTTHAT_TOKEN -->
        </token>
        <!-- Used for jira server integration only. If using cloud remove this option-->
        <jiraServerUrl>https://mycompanyjira.com</jiraServerUrl>
        <!-- Optional - Ignore ssl certificate errors for self-signed certificates (default is false)-->
        <ignoreCertErrors>true</ignoreCertErrors>
    </configuration>
    <executions>
        <execution>
            <configuration>
                <!--Optional - default ./features-->
                <outputFolder>src/test/resources/com/assertthat/features</outputFolder>
                <!--Optional - all features downloaded by default - should be a valid JQL-->
                <jql>project = XX AND key in ('XXX-1')</jql>
                <!--Optional - default automated (can be one of: manual/automated/both)-->
                <mode>automated</mode>
                <!--Optional - tag expression filter for scenarios. More on tag expressions https://cucumber.io/docs/cucumber/api/#tag-expressions-->
                <tags>(@smoke or @ui) and (not @slow)</tags>
                <!--Optional - prepend ordinal to feature name (default is true)-->                
                <numbered>false</numbered>
                <!--Optional - whether the phase is enabled (default is true)-->
                <enabled>true</enabled>
                <!--Optional - Delete features in outputFolder directory before downloading (default is true)-->
                <ceanupFeatures>true</ceanupFeatures>
            </configuration>
            <id>features</id>
            <goals>
                <goal>features</goal>
            </goals>
            <phase>pre-integration-test</phase>
        </execution>
        <execution>
            <id>report</id>
            <goals>
                <goal>report</goal>
            </goals>
            <phase>post-integration-test</phase>
            <configuration>
                <!--Optional - default ./report-->
                <jsonReportFolder>target/report/surefire-reports/cucumber/</jsonReportFolder>
                <!--Optional - default - **/*.json -->
                <jsonReportIncludePattern>**/cucumber.json</jsonReportIncludePattern>
                <!--Optional - default cucumber (can be one of: cucumber/karate)-->
                <type>cucumber</type>
                <!--Optional - default 'Test run Test run dd MMM yyyy HH:mm:ss'-->
                <runName>Custom test run name</runName>
                <!--Optional - Run metadata -->
                <metadata>{"env ":"uat ","build":"456"}</metadata>
                <!--Optional - all Jira tickets will be updated with test results by default; when JQL is provided only filtered tickets will be updated -->
                <jql>project = XX AND key in ('XXX-1')</jql>
                 <!--Optional - In case you want to append results to the existing test run -->
                <runId>123</runId>
                <!--Optional - whether the phase is enabled (default is true)-->
                <enabled>true</enabled>
            </configuration>
        </execution>
    </executions>
</plugin>

Usage

We recommend ruuning cucumber tests on integration-test phase as

• download features is running on pre-integration-test phase
• report submission on post-integration-test

Example project

Refer to example project assertthat-bdd-maven-example