This is an automated email from the ASF dual-hosted git repository. rfscholte pushed a commit to branch MNG-6065 in repository https://gitbox.apache.org/repos/asf/maven.git
commit 0539acc709376a1c19b8adb256737f878e1f701f Author: Martin Kanters <[email protected]> AuthorDate: Wed Nov 27 22:07:12 2019 +0100 Log fail-level option. Submitted by: Martin Kanters. Processed minor review comments regarding naming of certain classes and methods --- .../org/slf4j/impl/MavenLoggerFactoryTest.java | 25 ++++++++++++--------- .../main/java/org/apache/maven/cli/MavenCli.java | 2 +- .../maven/cli/event/ExecutionEventLogger.java | 2 +- ...LevelLoggerState.java => LogLevelRecorder.java} | 8 +++---- .../java/org/slf4j/impl/MavenFailLevelLogger.java | 26 +++++++++++----------- .../java/org/slf4j/impl/MavenLoggerFactory.java | 18 +++++++-------- .../maven/logwrapper/MavenSlf4jWrapperFactory.java | 4 ++-- 7 files changed, 45 insertions(+), 40 deletions(-) diff --git a/apache-maven/src/test/java/org/slf4j/impl/MavenLoggerFactoryTest.java b/apache-maven/src/test/java/org/slf4j/impl/MavenLoggerFactoryTest.java index cc42172..8baf624 100644 --- a/apache-maven/src/test/java/org/slf4j/impl/MavenLoggerFactoryTest.java +++ b/apache-maven/src/test/java/org/slf4j/impl/MavenLoggerFactoryTest.java @@ -23,7 +23,12 @@ import org.junit.Test; import org.slf4j.Logger; import static org.hamcrest.CoreMatchers.instanceOf; -import static org.junit.Assert.*; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNotSame; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; public class MavenLoggerFactoryTest { @@ -56,7 +61,7 @@ public class MavenLoggerFactoryTest public void createsFailLevelLogger() { MavenLoggerFactory mavenLoggerFactory = new MavenLoggerFactory(); - mavenLoggerFactory.breakOnLogsOfLevel( "WARN" ); + mavenLoggerFactory.breakOnLogLevel( "WARN" ); Logger logger = mavenLoggerFactory.getLogger( "Test" ); @@ -67,33 +72,33 @@ public class MavenLoggerFactoryTest public void reportsWhenFailLevelHasBeenHit() { MavenLoggerFactory mavenLoggerFactory = new MavenLoggerFactory(); - mavenLoggerFactory.breakOnLogsOfLevel( "ERROR" ); + mavenLoggerFactory.breakOnLogLevel( "ERROR" ); MavenFailLevelLogger logger = ( MavenFailLevelLogger ) mavenLoggerFactory.getLogger( "Test" ); - assertFalse( mavenLoggerFactory.threwLogsOfBreakingLevel() ); + assertFalse( mavenLoggerFactory.isThresholdHit() ); logger.warn( "This should not hit the fail level" ); - assertFalse( mavenLoggerFactory.threwLogsOfBreakingLevel() ); + assertFalse( mavenLoggerFactory.isThresholdHit() ); logger.error( "This should hit the fail level" ); - assertTrue( mavenLoggerFactory.threwLogsOfBreakingLevel() ); + assertTrue( mavenLoggerFactory.isThresholdHit() ); logger.warn( "This should not reset the fail level" ); - assertTrue( mavenLoggerFactory.threwLogsOfBreakingLevel() ); + assertTrue( mavenLoggerFactory.isThresholdHit() ); } @Test( expected = IllegalStateException.class ) public void failLevelThresholdCanOnlyBeSetOnce() { MavenLoggerFactory mavenLoggerFactory = new MavenLoggerFactory(); - mavenLoggerFactory.breakOnLogsOfLevel( "WARN" ); - mavenLoggerFactory.breakOnLogsOfLevel( "ERROR" ); + mavenLoggerFactory.breakOnLogLevel( "WARN" ); + mavenLoggerFactory.breakOnLogLevel( "ERROR" ); } @Test( expected = IllegalArgumentException.class ) public void onlyWarningOrHigherFailLevelsCanBeSet() { MavenLoggerFactory mavenLoggerFactory = new MavenLoggerFactory(); - mavenLoggerFactory.breakOnLogsOfLevel( "INFO" ); + mavenLoggerFactory.breakOnLogLevel( "INFO" ); } } \ No newline at end of file diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java index f7f92d6..c18d74f 100644 --- a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java +++ b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java @@ -550,7 +550,7 @@ public class MavenCli if ( slf4jLoggerFactory instanceof MavenSlf4jWrapperFactory ) { - ( (MavenSlf4jWrapperFactory) slf4jLoggerFactory ).breakOnLogsOfLevel( logLevelToBreakOn ); + ( (MavenSlf4jWrapperFactory) slf4jLoggerFactory ).breakOnLogLevel( logLevelToBreakOn ); slf4jLogger.info( "Enabled to break the build on log level {}.", logLevelToBreakOn ); } } diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/event/ExecutionEventLogger.java b/maven-embedder/src/main/java/org/apache/maven/cli/event/ExecutionEventLogger.java index 85c895e..2422fba 100644 --- a/maven-embedder/src/main/java/org/apache/maven/cli/event/ExecutionEventLogger.java +++ b/maven-embedder/src/main/java/org/apache/maven/cli/event/ExecutionEventLogger.java @@ -138,7 +138,7 @@ public class ExecutionEventLogger extends AbstractExecutionListener if ( iLoggerFactory instanceof MavenSlf4jWrapperFactory ) { - if ( ( (MavenSlf4jWrapperFactory) iLoggerFactory ).threwLogsOfBreakingLevel() ) + if ( ( (MavenSlf4jWrapperFactory) iLoggerFactory ).isThresholdHit() ) { event.getSession().getResult().addException( new Exception( "Build failed due to log statements with a higher severity than allowed. " diff --git a/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenFailLevelLoggerState.java b/maven-slf4j-provider/src/main/java/org/slf4j/impl/LogLevelRecorder.java similarity index 89% rename from maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenFailLevelLoggerState.java rename to maven-slf4j-provider/src/main/java/org/slf4j/impl/LogLevelRecorder.java index ba6ecdb..652fee7 100644 --- a/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenFailLevelLoggerState.java +++ b/maven-slf4j-provider/src/main/java/org/slf4j/impl/LogLevelRecorder.java @@ -24,18 +24,18 @@ import org.slf4j.event.Level; /** * Responsible for keeping state of whether the threshold of the --fail-level flag has been hit. */ -class MavenFailLevelLoggerState +class LogLevelRecorder { private final Level logThreshold; private boolean thresholdHit = false; - MavenFailLevelLoggerState( Level logLevel ) + LogLevelRecorder( Level logLevel ) { assert logLevel != null; this.logThreshold = logLevel; } - void recordLogLevel( Level logLevel ) + void record( Level logLevel ) { if ( !thresholdHit && logLevel.toInt() >= logThreshold.toInt() ) { @@ -43,7 +43,7 @@ class MavenFailLevelLoggerState } } - boolean threwLogsOfBreakingLevel() + boolean isThresholdHit() { return thresholdHit; } diff --git a/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenFailLevelLogger.java b/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenFailLevelLogger.java index 7fde35a..7cfa608 100644 --- a/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenFailLevelLogger.java +++ b/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenFailLevelLogger.java @@ -27,12 +27,12 @@ import org.slf4j.event.Level; */ public class MavenFailLevelLogger extends MavenSimpleLogger { - private final MavenFailLevelLoggerState failLevelLoggerState; + private final LogLevelRecorder logLevelRecorder; - MavenFailLevelLogger( String name, MavenFailLevelLoggerState failLevelLoggerState ) + MavenFailLevelLogger( String name, LogLevelRecorder logLevelRecorder ) { super( name ); - this.failLevelLoggerState = failLevelLoggerState; + this.logLevelRecorder = logLevelRecorder; } /** @@ -43,7 +43,7 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void warn( String msg ) { super.warn( msg ); - failLevelLoggerState.recordLogLevel( Level.WARN ); + logLevelRecorder.record( Level.WARN ); } /** @@ -54,7 +54,7 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void warn( String format, Object arg ) { super.warn( format, arg ); - failLevelLoggerState.recordLogLevel( Level.WARN ); + logLevelRecorder.record( Level.WARN ); } /** @@ -65,7 +65,7 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void warn( String format, Object arg1, Object arg2 ) { super.warn( format, arg1, arg2 ); - failLevelLoggerState.recordLogLevel( Level.WARN ); + logLevelRecorder.record( Level.WARN ); } /** @@ -76,7 +76,7 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void warn( String format, Object... argArray ) { super.warn( format, argArray ); - failLevelLoggerState.recordLogLevel( Level.WARN ); + logLevelRecorder.record( Level.WARN ); } /** Log a message of level WARN, including an exception. */ @@ -84,7 +84,7 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void warn( String msg, Throwable t ) { super.warn( msg, t ); - failLevelLoggerState.recordLogLevel( Level.WARN ); + logLevelRecorder.record( Level.WARN ); } /** @@ -95,7 +95,7 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void error( String msg ) { super.error( msg ); - failLevelLoggerState.recordLogLevel( Level.ERROR ); + logLevelRecorder.record( Level.ERROR ); } /** @@ -106,7 +106,7 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void error( String format, Object arg ) { super.error( format, arg ); - failLevelLoggerState.recordLogLevel( Level.ERROR ); + logLevelRecorder.record( Level.ERROR ); } /** @@ -117,7 +117,7 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void error( String format, Object arg1, Object arg2 ) { super.error( format, arg1, arg2 ); - failLevelLoggerState.recordLogLevel( Level.ERROR ); + logLevelRecorder.record( Level.ERROR ); } /** @@ -128,7 +128,7 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void error( String format, Object... argArray ) { super.error( format, argArray ); - failLevelLoggerState.recordLogLevel( Level.ERROR ); + logLevelRecorder.record( Level.ERROR ); } /** Log a message of level ERROR, including an exception. */ @@ -136,6 +136,6 @@ public class MavenFailLevelLogger extends MavenSimpleLogger public void error( String msg, Throwable t ) { super.error( msg, t ); - failLevelLoggerState.recordLogLevel( Level.ERROR ); + logLevelRecorder.record( Level.ERROR ); } } diff --git a/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenLoggerFactory.java b/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenLoggerFactory.java index 612a11f..cf3760a 100644 --- a/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenLoggerFactory.java +++ b/maven-slf4j-provider/src/main/java/org/slf4j/impl/MavenLoggerFactory.java @@ -28,12 +28,12 @@ import org.slf4j.event.Level; */ public class MavenLoggerFactory extends SimpleLoggerFactory implements MavenSlf4jWrapperFactory { - private MavenFailLevelLoggerState failLevelLoggerState = null; + private LogLevelRecorder logLevelRecorder = null; @Override - public void breakOnLogsOfLevel( String logLevelToBreakOn ) + public void breakOnLogLevel( String logLevelToBreakOn ) { - if ( failLevelLoggerState != null ) + if ( logLevelRecorder != null ) { throw new IllegalStateException( "Maven logger fail level has already been set." ); } @@ -44,15 +44,15 @@ public class MavenLoggerFactory extends SimpleLoggerFactory implements MavenSlf4 throw new IllegalArgumentException( "Logging level thresholds can only be set to WARN or ERROR" ); } - failLevelLoggerState = new MavenFailLevelLoggerState( level ); + logLevelRecorder = new LogLevelRecorder( level ); } @Override - public boolean threwLogsOfBreakingLevel() + public boolean isThresholdHit() { - if ( failLevelLoggerState != null ) + if ( logLevelRecorder != null ) { - return failLevelLoggerState.threwLogsOfBreakingLevel(); + return logLevelRecorder.isThresholdHit(); } return false; @@ -79,13 +79,13 @@ public class MavenLoggerFactory extends SimpleLoggerFactory implements MavenSlf4 private Logger getNewLoggingInstance( String name ) { - if ( failLevelLoggerState == null ) + if ( logLevelRecorder == null ) { return new MavenSimpleLogger( name ); } else { - return new MavenFailLevelLogger( name, failLevelLoggerState ); + return new MavenFailLevelLogger( name, logLevelRecorder ); } } } diff --git a/maven-slf4j-wrapper/src/main/java/org/apache/maven/logwrapper/MavenSlf4jWrapperFactory.java b/maven-slf4j-wrapper/src/main/java/org/apache/maven/logwrapper/MavenSlf4jWrapperFactory.java index 92e6b0c..bdd1520 100644 --- a/maven-slf4j-wrapper/src/main/java/org/apache/maven/logwrapper/MavenSlf4jWrapperFactory.java +++ b/maven-slf4j-wrapper/src/main/java/org/apache/maven/logwrapper/MavenSlf4jWrapperFactory.java @@ -26,7 +26,7 @@ import org.slf4j.ILoggerFactory; */ public interface MavenSlf4jWrapperFactory extends ILoggerFactory { - boolean threwLogsOfBreakingLevel(); + boolean isThresholdHit(); - void breakOnLogsOfLevel( String logLevelToBreakOn ); + void breakOnLogLevel( String logLevelToBreakOn ); }
