From 6e4a925328ed505c008e21bcdc719fa45d950913 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dominik=20S=C3=A4ume?= <Dominik.Saeume@hmmh.de>
Date: Fri, 13 Sep 2024 00:54:02 +0200
Subject: [PATCH] PMT-3: Add Static Analysis

---
 .gitea/workflows/qs.yml                       | 10 ++++--
 ...g.run.xml => Main Static Analysis.run.xml} |  4 +--
 ...S.run.xml => Test Static Analysis.run.xml} |  6 ++--
 build.gradle.kts                              | 33 ++++++++++++++-----
 src/main/resources/spotbugs-exclude.xml       |  5 +++
 5 files changed, 40 insertions(+), 18 deletions(-)
 rename .run/{Validate Linting.run.xml => Main Static Analysis.run.xml} (83%)
 rename .run/{Validate OAS.run.xml => Test Static Analysis.run.xml} (80%)
 create mode 100644 src/main/resources/spotbugs-exclude.xml

diff --git a/.gitea/workflows/qs.yml b/.gitea/workflows/qs.yml
index b1ab1cf..267d479 100644
--- a/.gitea/workflows/qs.yml
+++ b/.gitea/workflows/qs.yml
@@ -15,7 +15,11 @@ jobs:
         uses: "https://git.euph.dev/actions/checkout@v3"
       - name: "Prepare Gradle"
         run: gradle clean
-      - name: "Checkstyle Linting Main"
+      - name: "Linting Main"
         run: gradle checkstyleMain
-      - name: "Checkstyle Linting Test"
-        run: gradle checkstyleTest
\ No newline at end of file
+      - name: "Linting Test"
+        run: gradle checkstyleTest
+      - name: "Static Analysis Main"
+        run: gradle spotbugsMain
+      - name: "Static Analysis Test"
+        run: gradle spotbugsTest
\ No newline at end of file
diff --git a/.run/Validate Linting.run.xml b/.run/Main Static Analysis.run.xml
similarity index 83%
rename from .run/Validate Linting.run.xml
rename to .run/Main Static Analysis.run.xml
index 288d7f2..91509c5 100644
--- a/.run/Validate Linting.run.xml	
+++ b/.run/Main Static Analysis.run.xml	
@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Validate Linting" type="GradleRunConfiguration" factoryName="Gradle">
+  <configuration default="false" name="Main Static Analysis" type="GradleRunConfiguration" factoryName="Gradle">
     <ExternalSystemSettings>
       <option name="executionName" />
       <option name="externalProjectPath" value="$PROJECT_DIR$" />
@@ -10,7 +10,7 @@
       </option>
       <option name="taskNames">
         <list>
-          <option value="checkstyleMain" />
+          <option value="spotbugsMain" />
         </list>
       </option>
       <option name="vmOptions" />
diff --git a/.run/Validate OAS.run.xml b/.run/Test Static Analysis.run.xml
similarity index 80%
rename from .run/Validate OAS.run.xml
rename to .run/Test Static Analysis.run.xml
index 694f324..8e123d1 100644
--- a/.run/Validate OAS.run.xml	
+++ b/.run/Test Static Analysis.run.xml	
@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Validate OAS" type="GradleRunConfiguration" factoryName="Gradle">
+  <configuration default="false" name="Test Static Analysis" type="GradleRunConfiguration" factoryName="Gradle">
     <ExternalSystemSettings>
       <option name="executionName" />
       <option name="externalProjectPath" value="$PROJECT_DIR$" />
@@ -9,9 +9,7 @@
         <list />
       </option>
       <option name="taskNames">
-        <list>
-          <option value="validateSwagger" />
-        </list>
+        <list />
       </option>
       <option name="vmOptions" />
     </ExternalSystemSettings>
diff --git a/build.gradle.kts b/build.gradle.kts
index e7a33e3..40845b5 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -1,3 +1,6 @@
+import com.github.spotbugs.snom.Confidence
+import com.github.spotbugs.snom.Effort
+import com.github.spotbugs.snom.SpotBugsTask
 import org.hidetake.gradle.swagger.generator.GenerateSwaggerCode
 
 repositories {
@@ -7,6 +10,7 @@ repositories {
 plugins {
     java
     checkstyle
+    id("com.github.spotbugs") version "6.0.22"
     id("org.springframework.boot") version "3.3.3"
     id("io.spring.dependency-management") version "1.1.6"
     id("org.hidetake.swagger.generator") version "2.19.2"
@@ -17,6 +21,12 @@ checkstyle {
     configFile = file("src/main/resources/checkstyle.xml")
 }
 
+spotbugs {
+    toolVersion = "4.8.6"    
+    effort.set(Effort.MAX)
+    reportLevel.set(Confidence.LOW)
+}
+
 group = "de.hmmh"
 version = "0.0.1-SNAPSHOT"
 
@@ -38,11 +48,11 @@ dependencies {
     implementation("org.springframework.boot:spring-boot-starter-validation")
     implementation("org.springframework.boot:spring-boot-starter-web")
     runtimeOnly("org.postgresql:postgresql")
-    
+
     //Lombok
     compileOnly("org.projectlombok:lombok")
     annotationProcessor("org.projectlombok:lombok")
-    
+
     //Test
     testImplementation("org.springframework.boot:spring-boot-starter-test")
     testImplementation("org.springframework.boot:spring-boot-testcontainers")
@@ -63,13 +73,24 @@ swaggerSources {
         code(delegateClosureOf<GenerateSwaggerCode> {
             language = "spring"
             components = listOf("models", "apis", "supportingFiles=ApiUtil.java")
-            code.rawOptions = listOf("--ignore-file-override=" + file("${rootDir}/src/main/resources/.codegen-ignore").absolutePath)
+            code.rawOptions =
+                listOf("--ignore-file-override=" + file("${rootDir}/src/main/resources/.codegen-ignore").absolutePath)
             dependsOn(validationTask)
         })
     }
 }
 
 tasks {
+
+    withType<Checkstyle> {
+        reports {
+            xml.required.set(true)
+            html.required.set(false)
+        }
+    }
+    withType<SpotBugsTask> {
+        excludeFilter.set(file("${rootDir}/src/main/resources/spotbugs-exclude.xml"))
+    }
     processResources {
         dependsOn(generateSwaggerCode)
     }
@@ -79,12 +100,6 @@ tasks {
     named("compileJava").configure {
         dependsOn(swaggerSources.getByName("pmt").code)
     }
-    withType<Checkstyle> {
-        reports {
-            xml.required.set(true)
-            html.required.set(false)
-        }
-    }
 }
 
 sourceSets {
diff --git a/src/main/resources/spotbugs-exclude.xml b/src/main/resources/spotbugs-exclude.xml
new file mode 100644
index 0000000..af8fb41
--- /dev/null
+++ b/src/main/resources/spotbugs-exclude.xml
@@ -0,0 +1,5 @@
+<FindBugsFilter>
+    <Match>
+        <Package name="de.hmmh.pmt.oas"/>
+    </Match>
+</FindBugsFilter>