diff --git a/README.adoc b/README.adoc
index 71b3e2a..c0e9baa 100644
--- a/README.adoc
+++ b/README.adoc
@@ -12,7 +12,7 @@ Shared Java annotations and utilities for _Software Engineering Done Right_ proj
[cols="1,1"]
|===
-|Latest version |`0.2.1`
+|Latest version |`0.2.6`
|Group ID |`com.arc-e-tect.sedr.utils`
|Artifact ID |`sedr-library`
|===
@@ -141,3 +141,118 @@ In GitHub Actions, `GITHUB_ACTOR` and `GITHUB_TOKEN` are injected automatically
GITHUB_ACTOR: ${{ github.actor }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
----
+
+=== Enforcing the justification convention with ArchUnit
+
+The library ships a `test-fixtures` artifact that contains the reusable ArchUnit rule `AbstractCoverageExclusionConventionsTest`.
+It verifies that every use of `@ExcludeFromJacocoGeneratedCodeCoverage` in your production code carries a non-blank `justification`.
+
+==== Add the test-fixtures dependency
+
+.Gradle (Kotlin DSL)
+[source,kotlin]
+----
+dependencies {
+ testImplementation(testFixtures("com.arc-e-tect.sedr.utils:sedr-library:0.2.6"))
+}
+----
+
+.Gradle (Groovy DSL)
+[source,groovy]
+----
+dependencies {
+ testImplementation testFixtures('com.arc-e-tect.sedr.utils:sedr-library:0.2.6')
+}
+----
+
+The test-fixtures artifact brings `archunit-junit5` and `junit-jupiter-api` in as transitive dependencies, so no extra entries are needed for those.
+You do need to add the JUnit Jupiter engine for test execution:
+
+.Gradle (Kotlin DSL)
+[source,kotlin]
+----
+dependencies {
+ testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.14.4")
+ testRuntimeOnly("org.junit.platform:junit-platform-launcher")
+}
+----
+
+.Gradle (Groovy DSL)
+[source,groovy]
+----
+dependencies {
+ testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.14.4'
+ testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+}
+----
+
+==== Write the convention test
+
+Extend `AbstractCoverageExclusionConventionsTest` and override `getBasePackage()` to scope the rule to your project's root package.
+
+[source,java]
+----
+class CoverageExclusionConventionsTest extends AbstractCoverageExclusionConventionsTest {
+
+ @Override
+ protected String getBasePackage() {
+ return "com.example.myapp";
+ }
+}
+----
+
+The inherited test `coverageExclusionAnnotationsMustHaveJustification()` runs automatically and fails if any class, constructor, or method in the scanned packages carries `@ExcludeFromJacocoGeneratedCodeCoverage` without a non-blank `justification`.
+
+==== Using the annotation correctly
+
+.Compliant — justification provided
+[source,java]
+----
+@ExcludeFromJacocoGeneratedCodeCoverage(
+ justification = "Spring Boot entry point – not unit-testable")
+public static void main(String[] args) {
+ SpringApplication.run(MyApp.class, args);
+}
+----
+
+.Non-compliant — ArchUnit rule will fail
+[source,java]
+----
+@ExcludeFromJacocoGeneratedCodeCoverage // missing justification
+public static void main(String[] args) {
+ SpringApplication.run(MyApp.class, args);
+}
+----
+
+=== Example project
+
+A self-contained example demonstrating both compliant and non-compliant usage is located at link:examples/sedr-library/jacoco-marker/[`examples/sedr-library/jacoco-marker/`].
+
+[cols="1,2"]
+|===
+|File |Purpose
+
+|`src/main/java/.../CompliantService.java`
+|Uses `@ExcludeFromJacocoGeneratedCodeCoverage` with a justification — passes the rule.
+
+|`src/main/java/.../NonCompliantService.java`
+|Uses `@ExcludeFromJacocoGeneratedCodeCoverage` without a justification — the ArchUnit test reports a violation for this class.
+
+|`src/test/java/.../CoverageExclusionConventionsTest.java`
+|Extends `AbstractCoverageExclusionConventionsTest` targeting the example package.
+|===
+
+To run the example (requires the library to be published to your local Maven repository first):
+
+[source,bash]
+----
+# 1. Publish the library locally
+cd sedr-library && ./gradlew clean build publishToMavenLocal
+
+# 2. Run the example — expected to FAIL with one ArchUnit violation
+cd ../examples/sedr-library/jacoco-marker && ./gradlew test
+----
+
+The test run reports exactly one violation:
+`Method NonCompliantService.stop() uses @ExcludeFromJacocoGeneratedCodeCoverage without a justification`.
+`CompliantService` is not mentioned.
diff --git a/examples/sedr-library/jacoco-marker/build.gradle b/examples/sedr-library/jacoco-marker/build.gradle
new file mode 100644
index 0000000..9025f28
--- /dev/null
+++ b/examples/sedr-library/jacoco-marker/build.gradle
@@ -0,0 +1,41 @@
+/*
+ * Example project demonstrating the sedr-library jacoco-marker annotation
+ * and the reusable ArchUnit convention test shipped as a test-fixtures artifact.
+ *
+ * Prerequisites:
+ * cd ../../../sedr-library && ./gradlew clean build publishToMavenLocal
+ *
+ * Run the example (intentionally fails to demonstrate the ArchUnit check):
+ * ./gradlew test
+ */
+plugins {
+ id 'java'
+}
+
+java {
+ toolchain {
+ languageVersion = JavaLanguageVersion.of(21)
+ }
+}
+
+repositories {
+ // mavenLocal() first so the locally published snapshot is found during
+ // development before the library is released to Maven Central.
+ // Once released, the same repositories block resolves from Maven Central
+ // without any change.
+ mavenLocal()
+ mavenCentral()
+}
+
+def sedrLibraryVersion = '0.2.6'
+
+dependencies {
+ implementation("com.arc-e-tect.sedr.utils:sedr-library:${sedrLibraryVersion}")
+ testImplementation(testFixtures("com.arc-e-tect.sedr.utils:sedr-library:${sedrLibraryVersion}"))
+ testRuntimeOnly('org.junit.jupiter:junit-jupiter-engine:5.14.4')
+ testRuntimeOnly('org.junit.platform:junit-platform-launcher')
+}
+
+test {
+ useJUnitPlatform()
+}
diff --git a/examples/sedr-library/jacoco-marker/gradle/wrapper/gradle-wrapper.jar b/examples/sedr-library/jacoco-marker/gradle/wrapper/gradle-wrapper.jar
new file mode 100644
index 0000000..d997cfc
Binary files /dev/null and b/examples/sedr-library/jacoco-marker/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/examples/sedr-library/jacoco-marker/gradle/wrapper/gradle-wrapper.properties b/examples/sedr-library/jacoco-marker/gradle/wrapper/gradle-wrapper.properties
new file mode 100644
index 0000000..1a70468
--- /dev/null
+++ b/examples/sedr-library/jacoco-marker/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.5.0-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
diff --git a/examples/sedr-library/jacoco-marker/gradlew b/examples/sedr-library/jacoco-marker/gradlew
new file mode 100755
index 0000000..739907d
--- /dev/null
+++ b/examples/sedr-library/jacoco-marker/gradlew
@@ -0,0 +1,248 @@
+#!/bin/sh
+
+#
+# Copyright © 2015 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+##############################################################################
+#
+# Gradle start up script for POSIX generated by Gradle.
+#
+# Important for running:
+#
+# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+# noncompliant, but you have some other compliant shell such as ksh or
+# bash, then to run this script, type that shell name before the whole
+# command line, like:
+#
+# ksh Gradle
+#
+# Busybox and similar reduced shells will NOT work, because this script
+# requires all of these POSIX shell features:
+# * functions;
+# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+# * compound commands having a testable exit status, especially «case»;
+# * various built-in commands including «command», «set», and «ulimit».
+#
+# Important for patching:
+#
+# (2) This script targets any POSIX shell, so it avoids extensions provided
+# by Bash, Ksh, etc; in particular arrays are avoided.
+#
+# The "traditional" practice of packing multiple parameters into a
+# space-separated string is a well documented source of bugs and security
+# problems, so this is (mostly) avoided, by progressively accumulating
+# options in "$@", and eventually passing that to Java.
+#
+# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+# see the in-line comments for details.
+#
+# There are tweaks for specific operating systems such as AIX, CygWin,
+# Darwin, MinGW, and NonStop.
+#
+# (3) This script is generated from the Groovy template
+# https://github.com/gradle/gradle/blob/2d6327017519d23b96af35865dc997fcb544fb40/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+# within the Gradle project.
+#
+# You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+ APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
+ [ -h "$app_path" ]
+do
+ ls=$( ls -ld "$app_path" )
+ link=${ls#*' -> '}
+ case $link in #(
+ /*) app_path=$link ;; #(
+ *) app_path=$APP_HOME$link ;;
+ esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=${0##*/}
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+ echo "$*"
+} >&2
+
+die () {
+ echo
+ echo "$*"
+ echo
+ exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in #(
+ CYGWIN* ) cygwin=true ;; #(
+ Darwin* ) darwin=true ;; #(
+ MSYS* | MINGW* ) msys=true ;; #(
+ NONSTOP* ) nonstop=true ;;
+esac
+
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+ if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+ # IBM's JDK on AIX uses strange locations for the executables
+ JAVACMD=$JAVA_HOME/jre/sh/java
+ else
+ JAVACMD=$JAVA_HOME/bin/java
+ fi
+ if [ ! -x "$JAVACMD" ] ; then
+ die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+ fi
+else
+ JAVACMD=java
+ if ! command -v java >/dev/null 2>&1
+ then
+ die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+ fi
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+ case $MAX_FD in #(
+ max*)
+ # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+ # shellcheck disable=SC2039,SC3045
+ MAX_FD=$( ulimit -H -n ) ||
+ warn "Could not query maximum file descriptor limit"
+ esac
+ case $MAX_FD in #(
+ '' | soft) :;; #(
+ *)
+ # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+ # shellcheck disable=SC2039,SC3045
+ ulimit -n "$MAX_FD" ||
+ warn "Could not set maximum file descriptor limit to $MAX_FD"
+ esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+# * args from the command line
+# * the main class name
+# * -classpath
+# * -D...appname settings
+# * --module-path (only if needed)
+# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+ APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+
+ JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+ # Now convert the arguments - kludge to limit ourselves to /bin/sh
+ for arg do
+ if
+ case $arg in #(
+ -*) false ;; # don't mess with options #(
+ /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
+ [ -e "$t" ] ;; #(
+ *) false ;;
+ esac
+ then
+ arg=$( cygpath --path --ignore --mixed "$arg" )
+ fi
+ # Roll the args list around exactly as many times as the number of
+ # args, so each arg winds up back in the position where it started, but
+ # possibly modified.
+ #
+ # NB: a `for` loop captures its iteration list before it begins, so
+ # changing the positional parameters here affects neither the number of
+ # iterations, nor the values presented in `arg`.
+ shift # remove old arg
+ set -- "$@" "$arg" # push replacement arg
+ done
+fi
+
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+# and any embedded shellness will be escaped.
+# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+# treated as '${Hostname}' itself on the command line.
+
+set -- \
+ "-Dorg.gradle.appname=$APP_BASE_NAME" \
+ -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
+ "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+ die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+# set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+ printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+ xargs -n1 |
+ sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+ tr '\n' ' '
+ )" '"$@"'
+
+exec "$JAVACMD" "$@"
diff --git a/examples/sedr-library/jacoco-marker/gradlew.bat b/examples/sedr-library/jacoco-marker/gradlew.bat
new file mode 100644
index 0000000..c4bdd3a
--- /dev/null
+++ b/examples/sedr-library/jacoco-marker/gradlew.bat
@@ -0,0 +1,93 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega
diff --git a/examples/sedr-library/jacoco-marker/settings.gradle b/examples/sedr-library/jacoco-marker/settings.gradle
new file mode 100644
index 0000000..9cfa26e
--- /dev/null
+++ b/examples/sedr-library/jacoco-marker/settings.gradle
@@ -0,0 +1,5 @@
+plugins {
+ id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0'
+}
+
+rootProject.name = 'jacoco-marker-example'
diff --git a/examples/sedr-library/jacoco-marker/src/main/java/com/arc_e_tect/sedr/example/jacoco/marker/CompliantService.java b/examples/sedr-library/jacoco-marker/src/main/java/com/arc_e_tect/sedr/example/jacoco/marker/CompliantService.java
new file mode 100644
index 0000000..c56369c
--- /dev/null
+++ b/examples/sedr-library/jacoco-marker/src/main/java/com/arc_e_tect/sedr/example/jacoco/marker/CompliantService.java
@@ -0,0 +1,17 @@
+package com.arc_e_tect.sedr.example.jacoco.marker;
+
+import com.arc_e_tect.sedr.utils.jacoco.marker.ExcludeFromJacocoGeneratedCodeCoverage;
+
+/**
+ * Compliant example — every use of
+ * {@link ExcludeFromJacocoGeneratedCodeCoverage} supplies a non-blank
+ * {@code justification}, so the ArchUnit convention check will pass for this class.
+ */
+public class CompliantService {
+
+ @ExcludeFromJacocoGeneratedCodeCoverage(
+ justification = "Stub entry point executed only by the container, not unit-testable")
+ public void start() {
+ // framework entry point — excluded from coverage by design
+ }
+}
diff --git a/examples/sedr-library/jacoco-marker/src/main/java/com/arc_e_tect/sedr/example/jacoco/marker/NonCompliantService.java b/examples/sedr-library/jacoco-marker/src/main/java/com/arc_e_tect/sedr/example/jacoco/marker/NonCompliantService.java
new file mode 100644
index 0000000..f2862a3
--- /dev/null
+++ b/examples/sedr-library/jacoco-marker/src/main/java/com/arc_e_tect/sedr/example/jacoco/marker/NonCompliantService.java
@@ -0,0 +1,18 @@
+package com.arc_e_tect.sedr.example.jacoco.marker;
+
+import com.arc_e_tect.sedr.utils.jacoco.marker.ExcludeFromJacocoGeneratedCodeCoverage;
+
+/**
+ * Non-compliant example — the annotation is used without a
+ * {@code justification}, which is the pattern the ArchUnit convention check
+ * is designed to reject.
+ *
+ * Running {@code ./gradlew test} will report a violation for this class.
+ */
+public class NonCompliantService {
+
+ @ExcludeFromJacocoGeneratedCodeCoverage
+ public void stop() {
+ // annotation has no justification — the ArchUnit test will fail here
+ }
+}
diff --git a/examples/sedr-library/jacoco-marker/src/test/java/com/arc_e_tect/sedr/example/jacoco/marker/CoverageExclusionConventionsTest.java b/examples/sedr-library/jacoco-marker/src/test/java/com/arc_e_tect/sedr/example/jacoco/marker/CoverageExclusionConventionsTest.java
new file mode 100644
index 0000000..767f109
--- /dev/null
+++ b/examples/sedr-library/jacoco-marker/src/test/java/com/arc_e_tect/sedr/example/jacoco/marker/CoverageExclusionConventionsTest.java
@@ -0,0 +1,21 @@
+package com.arc_e_tect.sedr.example.jacoco.marker;
+
+import com.arc_e_tect.sedr.utils.jacoco.marker.AbstractCoverageExclusionConventionsTest;
+
+/**
+ * Extends {@link AbstractCoverageExclusionConventionsTest} to apply the
+ * coverage-exclusion convention check to this example project's packages.
+ *
+ *
Running {@code ./gradlew test} will:
+ *
+ * - PASS for {@code CompliantService} (justification is present)
+ * - FAIL for {@code NonCompliantService} (no justification)
+ *
+ */
+class CoverageExclusionConventionsTest extends AbstractCoverageExclusionConventionsTest {
+
+ @Override
+ protected String getBasePackage() {
+ return "com.arc_e_tect.sedr.example.jacoco.marker";
+ }
+}
diff --git a/sedr-library/build.gradle b/sedr-library/build.gradle
index 709de60..534d4ce 100644
--- a/sedr-library/build.gradle
+++ b/sedr-library/build.gradle
@@ -6,11 +6,11 @@
*/
plugins {
id 'java-library'
+ id 'java-test-fixtures'
id 'maven-publish'
alias(libs.plugins.jreleaser)
alias(libs.plugins.owaspDependencycheck)
}
-import groovy.json.JsonSlurper
def resolveVersion = {
def propsVersion = project.version as String
@@ -27,12 +27,11 @@ def resolveVersion = {
def cmd = ['gh', 'release', 'list',
'--repo', 'Arc-E-Tect/SoftwareEngineeringDoneRight-Code',
'--limit', '50',
- '--json', 'tagName']
+ '--json', 'tagName',
+ '--jq', '.[] | select(.tagName | startswith("sedr-library-v")) | .tagName']
def proc = cmd.execute()
proc.waitForOrKill(10_000)
- def releases = new JsonSlurper().parseText(proc.text)
- def tag = releases.findAll { it.tagName.startsWith('sedr-library-v') }
- .collect { it.tagName }
+ def tag = proc.text.readLines().findAll { it.startsWith('sedr-library-v') }
.sort()
.last()
if (tag) {
@@ -61,6 +60,11 @@ repositories {
mavenCentral()
}
+dependencies {
+ testFixturesApi(libs.archunit.junit5)
+ testFixturesApi(libs.junit.jupiter.api)
+}
+
publishing {
publications {
maven(MavenPublication) {
diff --git a/sedr-library/gradle/libs.versions.toml b/sedr-library/gradle/libs.versions.toml
index 1485954..3999cee 100644
--- a/sedr-library/gradle/libs.versions.toml
+++ b/sedr-library/gradle/libs.versions.toml
@@ -7,9 +7,35 @@ owaspDependencycheck = { id = "org.owasp.dependencycheck", version.ref = "owaspD
[versions]
+archunit = "1.4.2"
+## ⬆ = "1.3.1"
+## ⬆ = "1.3.2"
+## ⬆ = "1.4.0"
+## ⬆ = "1.4.1"
+## ⬆ = "1.4.2"
+junit-jupiter = "5.14.4"
+## ⬆ = "5.12.0"
+## ⬆ = "5.12.1"
+## ⬆ = "5.12.2"
+## ⬆ = "5.13.0"
+## ⬆ = "5.13.1"
+## ⬆ = "5.13.2"
+## ⬆ = "5.13.3"
+## ⬆ = "5.13.4"
+## ⬆ = "5.14.0"
+## ⬆ = "5.14.1"
+## ⬆ = "5.14.2"
+## ⬆ = "5.14.3"
+## ⬆ = "5.14.4"
+## ⬆ = "6.0.0"
+## ⬆ = "6.0.1"
+## ⬆ = "6.0.2"
+## ⬆ = "6.0.3"
jreleaser = "1.24.0"
owaspDependencycheck = "12.2.1"
+## ⬆ = "12.2.2"
[libraries]
-
+archunit-junit5 = { module = "com.tngtech.archunit:archunit-junit5", version.ref = "archunit" }
+junit-jupiter-api = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit-jupiter" }
diff --git a/sedr-library/src/main/java/com/arc_e_tect/sedr/utils/jacoco/marker/ExcludeFromJacocoGeneratedCodeCoverage.java b/sedr-library/src/main/java/com/arc_e_tect/sedr/utils/jacoco/marker/ExcludeFromJacocoGeneratedCodeCoverage.java
index 6c26bf7..855f47c 100644
--- a/sedr-library/src/main/java/com/arc_e_tect/sedr/utils/jacoco/marker/ExcludeFromJacocoGeneratedCodeCoverage.java
+++ b/sedr-library/src/main/java/com/arc_e_tect/sedr/utils/jacoco/marker/ExcludeFromJacocoGeneratedCodeCoverage.java
@@ -19,7 +19,7 @@
*
* Example usage:
*
- * {@literal @}ExcludeFromJacocoGeneratedCodeCoverage("Spring Boot entry point")
+ * {@literal @}ExcludeFromJacocoGeneratedCodeCoverage(justification = "Spring Boot entry point – not unit-testable")
* public static void main(String[] args) { ... }
*
* {@literal @}ExcludeFromJacocoGeneratedCodeCoverage(justification = "Lombok-generated boilerplate")
@@ -35,7 +35,7 @@
*
* Examples:
*
- * {@literal @}ExcludeFromJacocoGeneratedCodeCoverage("Spring Boot entry point – not unit-testable")
+ * {@literal @}ExcludeFromJacocoGeneratedCodeCoverage(justification = "Spring Boot entry point – not unit-testable")
* {@literal @}ExcludeFromJacocoGeneratedCodeCoverage(justification = "Lombok-generated boilerplate")
*
*
diff --git a/sedr-library/src/testFixtures/java/com/arc_e_tect/sedr/utils/jacoco/marker/AbstractCoverageExclusionConventionsTest.java b/sedr-library/src/testFixtures/java/com/arc_e_tect/sedr/utils/jacoco/marker/AbstractCoverageExclusionConventionsTest.java
new file mode 100644
index 0000000..b532125
--- /dev/null
+++ b/sedr-library/src/testFixtures/java/com/arc_e_tect/sedr/utils/jacoco/marker/AbstractCoverageExclusionConventionsTest.java
@@ -0,0 +1,137 @@
+package com.arc_e_tect.sedr.utils.jacoco.marker;
+
+import com.tngtech.archunit.core.domain.JavaClass;
+import com.tngtech.archunit.core.domain.JavaClasses;
+import com.tngtech.archunit.core.domain.JavaConstructor;
+import com.tngtech.archunit.core.domain.JavaMethod;
+import com.tngtech.archunit.core.importer.ClassFileImporter;
+import com.tngtech.archunit.core.importer.ImportOption;
+import com.tngtech.archunit.lang.ArchCondition;
+import com.tngtech.archunit.lang.ConditionEvents;
+import com.tngtech.archunit.lang.SimpleConditionEvent;
+import org.junit.jupiter.api.Test;
+
+import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
+
+/**
+ * Reusable ArchUnit test that enforces the convention that every use of
+ * {@link ExcludeFromJacocoGeneratedCodeCoverage} must supply a non-blank
+ * {@code justification} value.
+ *
+ * Extend this class and implement {@link #getBasePackage()} to scope the
+ * rule to your project's root package:
+ *
+ *
+ * class MyCoverageExclusionConventionsTest extends AbstractCoverageExclusionConventionsTest {
+ * {@literal @}Override
+ * protected String getBasePackage() {
+ * return "com.example.myapp";
+ * }
+ * }
+ *
+ *
+ * Add the test-fixtures artifact to your build:
+ *
+ * // Gradle (Groovy DSL)
+ * testImplementation(testFixtures("com.arc-e-tect.sedr.utils:sedr-library:VERSION"))
+ *
+ *
+ * The single test {@code coverageExclusionAnnotationsMustHaveJustification()}
+ * fails if any class, constructor, or method in the scanned packages carries
+ * {@code @ExcludeFromJacocoGeneratedCodeCoverage} without a non-blank
+ * {@code justification}.
+ */
+public abstract class AbstractCoverageExclusionConventionsTest {
+
+ /**
+ * Returns the root package to scan for classes.
+ * All sub-packages are included automatically.
+ *
+ * @return the base package name, e.g. {@code "com.example.myapp"}
+ */
+ protected abstract String getBasePackage();
+
+ /**
+ * Verifies that every {@code @ExcludeFromJacocoGeneratedCodeCoverage}
+ * annotation present in production code carries a non-blank
+ * {@code justification} value.
+ *
+ *
An empty or missing justification makes it impossible to distinguish
+ * deliberate exclusions from accidental ones during code review.
+ */
+ @Test
+ void coverageExclusionAnnotationsMustHaveJustification() {
+ String basePackage = getBasePackage();
+
+ JavaClasses importedClasses = new ClassFileImporter()
+ .withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)
+ .importPackages(basePackage);
+
+ classes()
+ .that().resideInAPackage(basePackage + "..")
+ .should(haveNonEmptyJustificationOnAllCoverageExclusionAnnotations())
+ .because("@ExcludeFromJacocoGeneratedCodeCoverage without a justification makes it " +
+ "impossible to distinguish deliberate exclusions from accidental ones — " +
+ "always document the reason")
+ .check(importedClasses);
+ }
+
+ // -------------------------------------------------------------------------
+ // Custom condition
+ // -------------------------------------------------------------------------
+
+ private static ArchCondition haveNonEmptyJustificationOnAllCoverageExclusionAnnotations() {
+ return new ArchCondition<>("have a non-empty justification on every @ExcludeFromJacocoGeneratedCodeCoverage annotation") {
+
+ @Override
+ public void check(JavaClass clazz, ConditionEvents events) {
+ checkClassAnnotation(clazz, events);
+ checkConstructorAnnotations(clazz, events);
+ checkMethodAnnotations(clazz, events);
+ }
+
+ private void checkClassAnnotation(JavaClass clazz, ConditionEvents events) {
+ if (!clazz.isAnnotatedWith(ExcludeFromJacocoGeneratedCodeCoverage.class)) {
+ return;
+ }
+ ExcludeFromJacocoGeneratedCodeCoverage ann =
+ clazz.getAnnotationOfType(ExcludeFromJacocoGeneratedCodeCoverage.class);
+ if (ann.justification().trim().isEmpty()) {
+ events.add(SimpleConditionEvent.violated(clazz,
+ "Class " + clazz.getName() +
+ " uses @ExcludeFromJacocoGeneratedCodeCoverage without a justification"));
+ }
+ }
+
+ private void checkConstructorAnnotations(JavaClass clazz, ConditionEvents events) {
+ for (JavaConstructor ctor : clazz.getConstructors()) {
+ if (!ctor.isAnnotatedWith(ExcludeFromJacocoGeneratedCodeCoverage.class)) {
+ continue;
+ }
+ ExcludeFromJacocoGeneratedCodeCoverage ann =
+ ctor.getAnnotationOfType(ExcludeFromJacocoGeneratedCodeCoverage.class);
+ if (ann.justification().trim().isEmpty()) {
+ events.add(SimpleConditionEvent.violated(clazz,
+ "Constructor " + ctor.getFullName() +
+ " uses @ExcludeFromJacocoGeneratedCodeCoverage without a justification"));
+ }
+ }
+ }
+
+ private void checkMethodAnnotations(JavaClass clazz, ConditionEvents events) {
+ for (JavaMethod method : clazz.getMethods()) {
+ if (!method.isAnnotatedWith(ExcludeFromJacocoGeneratedCodeCoverage.class)) {
+ continue;
+ }
+ ExcludeFromJacocoGeneratedCodeCoverage ann =
+ method.getAnnotationOfType(ExcludeFromJacocoGeneratedCodeCoverage.class);
+ if (ann.justification().trim().isEmpty()) {
+ events.add(SimpleConditionEvent.violated(clazz,
+ "Method " + method.getFullName() +
+ " uses @ExcludeFromJacocoGeneratedCodeCoverage without a justification"));
+ }
+ }
+ }
+ };
+ }
+}