junit5-tag-check-maven-plugin

A simple plugin to check the presence of JUnit5 test by tags.

Configuration reference

parameter	type	required	notes
format	string	false	default 'txt', accepts 'html', 'json', 'xml', 'pdf', 'txt', 'xlsx', 'md', 'adoc' (*)
outputFile	string	true	path where should be produced the report
requiredTags.requiredTag	string	true	tag to be checked
failOnMissingTag	boolean	true	if set to 'true' the build will fail on missing tags

(*) html, pdf, xlsx, md and adoc formats are based on a common template. txt, xml and json reports are based on a specific format report.

Here is a sample configuration

          <plugin>
            <groupId>org.fugerit.java</groupId>
            <artifactId>junit5-tag-check-maven-plugin</artifactId>
            <version>${junit5-tag-check-maven-plugin-version}</version>
            <executions>
              <execution>
                <id>report-executed-test-tags</id>
                <phase>verify</phase>
                <goals>
                  <goal>report-executed-tags</goal>
                </goals>
                <configuration>
                  <format>html</format>
                  <outputFile>${project.build.directory}/executed-test-tag-report.html</outputFile>
                  <requiredTags>
                    <requiredTag>security</requiredTag>
                    <requiredTag>authorized</requiredTag>
                    <requiredTag>unauthorized</requiredTag>
                    <requiredTag>forbidden</requiredTag>
                  </requiredTags>
                  <failOnMissingTag>true</failOnMissingTag>
                </configuration>
              </execution>
            </executions>
          </plugin>

Report

Sample reports output

• HTML
• TXT
• JSON
• XML
• PDF
• XLSX
• Markdown
• AsciiDoc

And here is the Markdown version

# **Executed Test Tag Report**

## **Summary**


| Metric | Count  |
|---------------|---------------|
| Total Tests | 8  |
| Passed | 8  |
| Failed | 0  |
| Errors | 0  |

## **Tags Summary**

| Tag | Tests  |
|---------------|---------------|
| security | 8  |
| authorized | 2  |
| unauthorized | 5  |
| forbidden | 1  |

## **All Executed Tests**

| Status | Test | Tags | Time  |
|---------------|---------------|---------------|---------------|
| ✅ | test.org.fugerit.java.demo.unittestdemoapp.DocResourceSicurezzaTest​#testHtmlOkNoAdminRole | security authorized | 1.512s  |
| ✅ | test.org.fugerit.java.demo.unittestdemoapp.DocResourceSicurezzaTest​#testHtml401NoAuthorizationBearer | security unauthorized | 0.01s  |
| ✅ | test.org.fugerit.java.demo.unittestdemoapp.DocResourceSicurezzaTest​#testAsciiDocNoAuthorizationBearer | security unauthorized | 0.007s  |
| ✅ | test.org.fugerit.java.demo.unittestdemoapp.DocResourceSicurezzaTest​#testPdfOkNoAdminRole | security authorized | 0.057s  |
| ✅ | test.org.fugerit.java.demo.unittestdemoapp.DocResourceSicurezzaTest​#testInvalidJwtPayload | security unauthorized | 0.012s  |
| ✅ | test.org.fugerit.java.demo.unittestdemoapp.DocResourceSicurezzaTest​#testMarkdown403NoAdminRole | security forbidden | 0.007s  |
| ✅ | test.org.fugerit.java.demo.unittestdemoapp.DocResourceSicurezzaTest​#testMarkdown401NoAuthorizationBearer | security unauthorized | 0.005s  |
| ✅ | test.org.fugerit.java.demo.unittestdemoapp.DocResourceSicurezzaTest​#testInvalidJwt | security unauthorized | 0.008s  |