Add checkstyle suppressions.

cs125-illinois · Oct 30, 2022 · 0df9b41 · 0df9b41
1 parent 229d820
commit 0df9b41
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 16 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -18,7 +18,7 @@ allprojects {
 }
 subprojects {
     group = "com.github.cs125-illinois.jeed"
-    version = "2022.10.6"
+    version = "2022.10.7"
     tasks.withType<Test> {
         useJUnitPlatform()
         enableAssertions = true

diff --git a/containerrunner/src/main/resources/edu.illinois.cs.cs125.jeed.containerrunner.version b/containerrunner/src/main/resources/edu.illinois.cs.cs125.jeed.containerrunner.version
@@ -1 +1 @@
-version=2022.10.6
+version=2022.10.7
diff --git a/core/src/main/kotlin/Checkstyle.kt b/core/src/main/kotlin/Checkstyle.kt
@@ -23,7 +23,8 @@ import javax.xml.xpath.XPathFactory
 data class CheckstyleArguments(
     val sources: Set<String>? = null,
     val failOnError: Boolean = false,
-    val skipUnmapped: Boolean = true
+    val skipUnmapped: Boolean = true,
+    val suppressions: Set<String> = setOf()
 )
 
 @JsonClass(generateAdapter = true)
@@ -164,38 +165,38 @@ suspend fun Source.checkstyle(
         sources.filter {
             names.contains(it.key)
         }
-    ).values.flatten().mapNotNull {
+    ).values.flatten().mapNotNull { error ->
         val mappedLocation = try {
-            mapLocation(it.location)
+            mapLocation(error.location)
         } catch (e: SourceMappingException) {
             if (!checkstyleArguments.skipUnmapped) {
                 throw e
             }
             null
         }
-        if (mappedLocation != null) {
-            val message = if (it.key?.startsWith("indentation") == true) {
+        if (mappedLocation != null && error.key !in checkstyleArguments.suppressions) {
+            val message = if (error.key?.startsWith("indentation") == true) {
                 @Suppress("TooGenericExceptionCaught")
                 try {
-                    val addedIndent = leadingIndentation(it.location)
+                    val addedIndent = leadingIndentation(error.location)
                     val (incorrectMessage, incorrectAmount) =
-                        incorrectLevelRegex.find(it.message)?.groups?.let { match ->
+                        incorrectLevelRegex.find(error.message)?.groups?.let { match ->
                             Pair(match[0]?.value, match[1]?.value?.toInt())
                         } ?: error("Couldn't parse indentation error")
                     val (expectedMessage, expectedAmount) =
-                        expectedLevelRegex.find(it.message)?.groups?.let { match ->
+                        expectedLevelRegex.find(error.message)?.groups?.let { match ->
                             Pair(match[0]?.value, match[1]?.value?.toInt())
                         } ?: error("Couldn't parse indentation error")
-                    it.message
+                    error.message
                         .replace(incorrectMessage!!, "incorrect indentation level ${incorrectAmount!! - addedIndent}")
                         .replace(expectedMessage!!, "expected level should be ${expectedAmount!! - addedIndent}")
                 } catch (_: Exception) {
-                    it.message
+                    error.message
                 }
             } else {
-                it.message
+                error.message
             }
-            CheckstyleError(it.severity, it.key, mappedLocation, message)
+            CheckstyleError(error.severity, error.key, mappedLocation, message)
         } else {
             null
         }

diff --git a/core/src/main/resources/edu.illinois.cs.cs125.jeed.core.version b/core/src/main/resources/edu.illinois.cs.cs125.jeed.core.version
@@ -1 +1 @@
-version=2022.10.6
+version=2022.10.7
diff --git a/core/src/test/kotlin/TestCheckstyle.kt b/core/src/test/kotlin/TestCheckstyle.kt
@@ -284,6 +284,15 @@ public int add(int a, int b) {
             it shouldNot haveCheckstyleErrors()
         }
     }
+    "should allow suppressions" {
+        Source.fromSnippet(
+            """
+for (int i = 0; i < 10; i++);
+""".trim()
+        ).checkstyle(CheckstyleArguments(suppressions = setOf("empty.statement"))).also {
+            it shouldNot haveCheckstyleErrors()
+        }
+    }
 })
 
 fun haveCheckstyleErrors() = object : Matcher<CheckstyleResults> {

diff --git a/server/src/main/resources/edu.illinois.cs.cs125.jeed.server.version b/server/src/main/resources/edu.illinois.cs.cs125.jeed.server.version
@@ -1 +1 @@
-version=2022.10.6
+version=2022.10.7
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,2 +1,8 @@
 rootProject.name = "jeed"
 include("core", "server", "containerrunner", "leaktest")
+pluginManagement {
+    repositories {
+        mavenCentral()
+        gradlePluginPortal()
+    }
+}