From 0253b9d3cd2cfab4df08eb36dd48dd8a335e2171 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Juan=20Mart=C3=ADn=20Sotuyo=20Dodero?=
 <juan.sotuyo@pedidosya.com>
Date: Sat, 14 Sep 2024 01:33:20 -0300
Subject: [PATCH 1/4] Ignore generated-sources in coverage reports

 - We don't test it directly, nor is it our job
 - A bad grammar won't be processed, or fail in subtle ways only
   detectable in specific tests on the AST (which is included)
---
 pom.xml | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/pom.xml b/pom.xml
index 3c410ebe80..f2cb4d826c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -612,6 +612,11 @@
                     <groupId>org.jacoco</groupId>
                     <artifactId>jacoco-maven-plugin</artifactId>
                     <version>0.8.11</version>
+                    <configuration>
+                        <excludes>
+                            <exclude>**/target/generated-sources/**</exclude>
+                        </excludes>
+                    </configuration>
                 </plugin>
                 <plugin>
                     <groupId>org.cyclonedx</groupId>

From 029130a478e1c4c585c965dca224961df18c7034 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Juan=20Mart=C3=ADn=20Sotuyo=20Dodero?=
 <juan.sotuyo@pedidosya.com>
Date: Tue, 17 Sep 2024 17:00:42 -0300
Subject: [PATCH 2/4] Use a custom annotation to ignore javacc generated code

---
 javacc-wrapper.xml                            | 21 ++++++++++++-----
 .../sourceforge/pmd/annotation/Generated.java | 23 +++++++++++++++++++
 pom.xml                                       |  7 +-----
 3 files changed, 39 insertions(+), 12 deletions(-)
 create mode 100644 pmd-core/src/main/java/net/sourceforge/pmd/annotation/Generated.java

diff --git a/javacc-wrapper.xml b/javacc-wrapper.xml
index 2c43e086d8..bbd50e21a4 100644
--- a/javacc-wrapper.xml
+++ b/javacc-wrapper.xml
@@ -224,6 +224,11 @@
 
     <target name="cleanup-parser" unless="jjtreeBuildNotRequired">
 
+        <replace token="class ${parser-name}">
+            <replacevalue expandProperties="true"><![CDATA[@net.sourceforge.pmd.annotation.Generated("org.javacc.javacc")
+class ]]>${parser-name}</replacevalue>
+            <file name="${parser-file}" />
+        </replace>
 
         <replace token="new Token()" value="token_source.input_stream.getTokenDocument().open()">
             <file name="${parser-file}" />
@@ -262,7 +267,8 @@
 
         <replaceregexp>
             <regexp pattern="public interface"/>
-            <substitution expression="interface"/>
+            <substitution expression='@net.sourceforge.pmd.annotation.Generated("org.javacc.javacc")${line.separator}
+interface'/>
             <file name="${target-package-dir}/${parser-name}TreeConstants.java" />
         </replaceregexp>
 
@@ -272,7 +278,8 @@
 
         <replaceregexp>
             <regexp pattern='(public )?class ${tokenmgr-name}' />
-            <substitution expression='class ${tokenmgr-name} extends ${base-tokenmgr}' />
+            <substitution expression='@net.sourceforge.pmd.annotation.Generated("org.javacc.javacc")${line.separator}
+class ${tokenmgr-name} extends ${base-tokenmgr}' />
             <file name="${tokenmgr-file}" />
         </replaceregexp>
 
@@ -385,11 +392,12 @@
 
         <replaceregexp>
             <regexp pattern="(public )?interface ${constants-itf-name} \{" />
-            <substitution expression="/** Token kinds ({@link ${ast-impl-package}.JavaccToken#kind}) for this language. */${line.separator}
+            <substitution expression='/** Token kinds ({@link ${ast-impl-package}.JavaccToken#kind}) for this language. */${line.separator}
 @net.sourceforge.pmd.annotation.InternalApi${line.separator}
+@net.sourceforge.pmd.annotation.Generated("org.javacc.javacc")${line.separator}
 public final class ${token-constants-name} \{${line.separator}
     private ${token-constants-name}() { /* Utility class */ }${line.separator}
-"/>
+'/>
             <file name="${token-constants-file}" />
         </replaceregexp>
 
@@ -534,8 +542,9 @@ public final class ${token-constants-name} \{${line.separator}
     <target name="default-visitor" depends="jjtree" unless="jjtreeBuildNotRequired">
         <move file="${target-package-dir}/${gen-visitor-name}.java" tofile="${generic-visitor-interface-file}" />
         <replace file="${generic-visitor-interface-file}">
-            <replacefilter token="${gen-visitor-name}"
-                           value="${generic-visitor-interface-name}&lt;P, R> extends ${ast-api-package}.AstVisitor&lt;P, R>" />
+            <replacefilter token="public interface ${gen-visitor-name}"
+                           value='@net.sourceforge.pmd.annotation.Generated("org.javacc.javacc")${line.separator}
+public interface ${generic-visitor-interface-name}&lt;P, R> extends ${ast-api-package}.AstVisitor&lt;P, R>' />
 
             <replacefilter token="SimpleNode" value="${node-name}" />
             <!-- Root method, eg visitJavaNode -->
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/annotation/Generated.java b/pmd-core/src/main/java/net/sourceforge/pmd/annotation/Generated.java
new file mode 100644
index 0000000000..ab9b46f465
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/annotation/Generated.java
@@ -0,0 +1,23 @@
+/*
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.annotation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Marks a class as generated code, and therefore to be ignored for code coverage purposes.
+ *
+ * @since 7.6.0
+ */
+@Retention(RetentionPolicy.CLASS)
+@Documented
+public @interface Generated {
+
+    /** The generator that produced this code */
+    String value() default "";
+
+}
diff --git a/pom.xml b/pom.xml
index f2cb4d826c..216fad4056 100644
--- a/pom.xml
+++ b/pom.xml
@@ -611,12 +611,7 @@
                 <plugin>
                     <groupId>org.jacoco</groupId>
                     <artifactId>jacoco-maven-plugin</artifactId>
-                    <version>0.8.11</version>
-                    <configuration>
-                        <excludes>
-                            <exclude>**/target/generated-sources/**</exclude>
-                        </excludes>
-                    </configuration>
+                    <version>0.8.12</version>
                 </plugin>
                 <plugin>
                     <groupId>org.cyclonedx</groupId>

From cae71e7a5e72bba07867a38072b9e580aebfa97e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Juan=20Mart=C3=ADn=20Sotuyo=20Dodero?=
 <juan.sotuyo@pedidosya.com>
Date: Tue, 17 Sep 2024 17:09:29 -0300
Subject: [PATCH 3/4] Be consistent in how we replace tokens

---
 javacc-wrapper.xml | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/javacc-wrapper.xml b/javacc-wrapper.xml
index bbd50e21a4..05837e96ba 100644
--- a/javacc-wrapper.xml
+++ b/javacc-wrapper.xml
@@ -224,9 +224,7 @@
 
     <target name="cleanup-parser" unless="jjtreeBuildNotRequired">
 
-        <replace token="class ${parser-name}">
-            <replacevalue expandProperties="true"><![CDATA[@net.sourceforge.pmd.annotation.Generated("org.javacc.javacc")
-class ]]>${parser-name}</replacevalue>
+        <replace token="class ${parser-name}" value='@net.sourceforge.pmd.annotation.Generated("org.javacc.javacc")${line.separator}class ${parser-name}'>
             <file name="${parser-file}" />
         </replace>
 

From d77a63da952feebb53c01b8da45bca600b49f35e Mon Sep 17 00:00:00 2001
From: Andreas Dangel <andreas.dangel@pmd-code.org>
Date: Thu, 3 Oct 2024 20:29:53 +0200
Subject: [PATCH 4/4] [doc] Update release notes (#5241)

---
 docs/pages/release_notes.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md
index a0bd73f9c6..978145ff2e 100644
--- a/docs/pages/release_notes.md
+++ b/docs/pages/release_notes.md
@@ -29,6 +29,7 @@ This is a {{ site.pmd.release_type }} release.
 
 ### ✨ External Contributions
 * [#5208](https://github.com/pmd/pmd/pull/5208): \[doc] Added Codety to "Tools / Integrations" - [Tony](https://github.com/random1223) (@random1223)
+* [#5241](https://github.com/pmd/pmd/pull/5241): \Ignore javacc code in coverage report - [Juan Martín Sotuyo Dodero](https://github.com/jsotuyod) (@jsotuyod)
 
 {% endtocmaker %}