From bffa2ba0cc25cd77196245399a5fbf658575b334 Mon Sep 17 00:00:00 2001
From: Mark Waite <mark.earl.waite@gmail.com>
Date: Wed, 9 Oct 2024 05:49:06 -0600
Subject: [PATCH] Suppress spotbugs PA_PUBLIC_PRIMITIVE_ATTRIBUTE warnings

https://www.jenkins.io/doc/developer/tutorial-improve/add-more-spotbugs-checks/
describes the technique used here with an exclusions file.  The specific
exclusion for PA_PUBLIC_PRIMITIVE_ATTRIBUTE has been confirmed by Jenkins
developers that it is not helpful in a Jenkins plugin.

https://github.com/jenkinsci/jenkins/pull/8803 describes the changes
that were made in Jenkins core and in many Jenkins plugins to suppress
the PA_PUBLIC_PRIMITIVE_ATTRIBUTE spotbugs warning.
---
 src/spotbugs/excludesFilter.xml | 50 +++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 src/spotbugs/excludesFilter.xml

diff --git a/src/spotbugs/excludesFilter.xml b/src/spotbugs/excludesFilter.xml
new file mode 100644
index 00000000..5d21a4da
--- /dev/null
+++ b/src/spotbugs/excludesFilter.xml
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<FindBugsFilter>
+  <!--
+    Exclusions in this section have been triaged and determined to be
+    false positives.
+  -->
+  <Match>
+    <!-- These primitive attributes need to be public to preserve the API -->
+    <Bug pattern="PA_PUBLIC_PRIMITIVE_ATTRIBUTE" />
+    <Class name="hudson.plugins.jacoco.JacocoPublisher" />
+    <Or>
+      <Field name="DESCRIPTOR" />
+      <Field name="deltaHealthReport" />
+      <Field name="healthReports" />
+    </Or>
+  </Match>
+  <Match>
+    <!-- These primitive attributes need to be public to preserve the API -->
+    <Bug pattern="PA_PUBLIC_PRIMITIVE_ATTRIBUTE" />
+    <Class name="hudson.plugins.jacoco.model.CoverageObject" />
+    <Or>
+      <Field name="maxBranch" />
+      <Field name="maxClazz" />
+      <Field name="maxComplexity" />
+      <Field name="maxInstruction" />
+      <Field name="maxLine" />
+      <Field name="maxMethod" />
+    </Or>
+  </Match>
+  <Match>
+    <!-- This primitive attribute needs to be public to preserve the API -->
+    <Bug pattern="PA_PUBLIC_PRIMITIVE_ATTRIBUTE" />
+    <Class name="hudson.plugins.jacoco.report.CoverageReport" />
+    <Field name="healthReports" />
+  </Match>
+
+  <!--
+    Here lies technical debt. Exclusions in this section have not yet
+    been triaged. When working on this section, pick an exclusion to
+    triage, then:
+
+    - Add a @SuppressFBWarnings(value = "[...]", justification = "[...]")
+      annotation if it is a false positive.  Indicate the reason why
+      it is a false positive, then remove the exclusion from this
+      section.
+
+    - If it is not a false positive, fix the bug, then remove the
+      exclusion from this section.
+   -->
+</FindBugsFilter>