Exclude logger classes from test coverage metrics

Nobody cares if logger.trace has never been called...
Col-E · Nov 18, 2024 · b9304ba · b9304ba
1 parent 85d8186
commit b9304ba
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/recaf-core/src/main/java/software/coley/recaf/analytics/logging/DebuggingLogger.java b/recaf-core/src/main/java/software/coley/recaf/analytics/logging/DebuggingLogger.java
@@ -2,6 +2,7 @@
 
 import jakarta.annotation.Nonnull;
 import org.slf4j.Logger;
+import software.coley.recaf.util.ExcludeFromJacocoGeneratedReport;
 
 import java.util.function.Consumer;
 
@@ -11,6 +12,7 @@
  *
  * @author Matt Coley
  */
+@ExcludeFromJacocoGeneratedReport(justification = "Logging not relevant for test coverage")
 public interface DebuggingLogger extends Logger {
 	boolean DEBUG = System.getenv("RECAF_DEBUG") != null;
 

diff --git a/recaf-core/src/main/java/software/coley/recaf/analytics/logging/InterceptingLogger.java b/recaf-core/src/main/java/software/coley/recaf/analytics/logging/InterceptingLogger.java
@@ -4,6 +4,7 @@
 import org.slf4j.Logger;
 import org.slf4j.Marker;
 import org.slf4j.event.Level;
+import software.coley.recaf.util.ExcludeFromJacocoGeneratedReport;
 
 import java.util.regex.Matcher;
 
@@ -12,6 +13,7 @@
  *
  * @author Matt Coley
  */
+@ExcludeFromJacocoGeneratedReport(justification = "Logging not relevant for test coverage")
 public abstract class InterceptingLogger implements DebuggingLogger {
 	private final Logger backing;
 

diff --git a/recaf-core/src/main/java/software/coley/recaf/analytics/logging/Logging.java b/recaf-core/src/main/java/software/coley/recaf/analytics/logging/Logging.java
@@ -7,6 +7,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.event.Level;
+import software.coley.recaf.util.ExcludeFromJacocoGeneratedReport;
 
 import java.nio.file.Path;
 import java.util.ArrayList;
@@ -26,6 +27,7 @@
  *
  * @author Matt Coley
  */
+@ExcludeFromJacocoGeneratedReport(justification = "Logging not relevant for test coverage")
 public class Logging {
 	private static final Map<String, DebuggingLogger> loggers = new ConcurrentHashMap<>();
 	private static final NavigableSet<String> loggerKeys = Collections.synchronizedNavigableSet(new TreeSet<>());

diff --git a/recaf-core/src/main/java/software/coley/recaf/analytics/logging/RecafLoggingFilter.java b/recaf-core/src/main/java/software/coley/recaf/analytics/logging/RecafLoggingFilter.java
@@ -4,12 +4,14 @@
 import ch.qos.logback.core.filter.Filter;
 import ch.qos.logback.core.spi.FilterReply;
 import jakarta.annotation.Nonnull;
+import software.coley.recaf.util.ExcludeFromJacocoGeneratedReport;
 
 /**
  * Logging filter impl that only allows Recaf logger calls.
  *
  * @author Matt Coley
  */
+@ExcludeFromJacocoGeneratedReport(justification = "Logging not relevant for test coverage")
 public class RecafLoggingFilter extends Filter<ILoggingEvent> {
 	@Override
 	public FilterReply decide(@Nonnull ILoggingEvent event) {