Skip to content

Commit a4f06ff

Browse files
Logger Level Logic Updates (#638)
* Test Updates Updating Logger tests to reflect the desired system behavior. * Logger updates Correcting log level comparison logic in Logger implementations.
1 parent fef3963 commit a4f06ff

File tree

6 files changed

+30
-33
lines changed

6 files changed

+30
-33
lines changed

src/main/java/org/owasp/esapi/logging/java/JavaLogger.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public class JavaLogger implements org.owasp.esapi.Logger {
2424
/** Handler for translating events from ESAPI context for Java processing.*/
2525
private final JavaLogBridge logBridge;
2626
/** Maximum log level that will be forwarded to Java from the ESAPI context.*/
27-
private int maxLogLevel;
27+
private int loggingLevel;
2828

2929
/**
3030
* Constructs a new instance.
@@ -35,7 +35,7 @@ public class JavaLogger implements org.owasp.esapi.Logger {
3535
public JavaLogger(java.util.logging.Logger JavaLogger, JavaLogBridge bridge, int defaultEsapiLevel) {
3636
delegate = JavaLogger;
3737
this.logBridge = bridge;
38-
maxLogLevel = defaultEsapiLevel;
38+
loggingLevel = defaultEsapiLevel;
3939
}
4040

4141
private void log(int esapiLevel, EventType type, String message) {
@@ -52,8 +52,7 @@ private void log(int esapiLevel, EventType type, String message, Throwable throw
5252

5353

5454
private boolean isEnabled(int esapiLevel) {
55-
//Are Logger.OFF and Logger.ALL reversed? This should be simply the less than or equal to check...
56-
return (esapiLevel <= maxLogLevel && maxLogLevel != Logger.OFF) || maxLogLevel == Logger.ALL;
55+
return esapiLevel >= loggingLevel;
5756
}
5857

5958
@Override
@@ -128,7 +127,7 @@ public void fatal(EventType type, String message, Throwable throwable) {
128127

129128
@Override
130129
public int getESAPILevel() {
131-
return maxLogLevel;
130+
return loggingLevel;
132131
}
133132

134133
@Override
@@ -162,7 +161,7 @@ public boolean isFatalEnabled() {
162161

163162
@Override
164163
public void setLevel(int level) {
165-
maxLogLevel = level;
164+
loggingLevel = level;
166165
}
167166

168167
}

src/main/java/org/owasp/esapi/logging/log4j/Log4JLogger.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public class Log4JLogger implements org.owasp.esapi.Logger {
2525
/** Handler for translating events from ESAPI context for SLF4J processing.*/
2626
private final Log4JLogBridge logBridge;
2727
/** Maximum log level that will be forwarded to SLF4J from the ESAPI context.*/
28-
private int maxLogLevel;
28+
private int loggingLevel;
2929

3030
/**
3131
* Constructs a new instance.
@@ -36,7 +36,7 @@ public class Log4JLogger implements org.owasp.esapi.Logger {
3636
public Log4JLogger(org.apache.log4j.Logger slf4JLogger, Log4JLogBridge bridge, int defaultEsapiLevel) {
3737
delegate = slf4JLogger;
3838
this.logBridge = bridge;
39-
maxLogLevel = defaultEsapiLevel;
39+
loggingLevel = defaultEsapiLevel;
4040
}
4141

4242
private void log(int esapiLevel, EventType type, String message) {
@@ -53,8 +53,7 @@ private void log(int esapiLevel, EventType type, String message, Throwable throw
5353

5454

5555
private boolean isEnabled(int esapiLevel) {
56-
//Are Logger.OFF and Logger.ALL reversed? This should be simply the less than or equal to check...
57-
return (esapiLevel <= maxLogLevel && maxLogLevel != Logger.OFF) || maxLogLevel == Logger.ALL;
56+
return esapiLevel >= loggingLevel;
5857
}
5958

6059
@Override
@@ -129,7 +128,7 @@ public void fatal(EventType type, String message, Throwable throwable) {
129128

130129
@Override
131130
public int getESAPILevel() {
132-
return maxLogLevel;
131+
return loggingLevel;
133132
}
134133

135134
@Override
@@ -163,7 +162,7 @@ public boolean isFatalEnabled() {
163162

164163
@Override
165164
public void setLevel(int level) {
166-
maxLogLevel = level;
165+
loggingLevel = level;
167166
}
168167

169168
}

src/main/java/org/owasp/esapi/logging/slf4j/Slf4JLogger.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public class Slf4JLogger implements org.owasp.esapi.Logger {
2424
/** Handler for translating events from ESAPI context for SLF4J processing.*/
2525
private final Slf4JLogBridge logBridge;
2626
/** Maximum log level that will be forwarded to SLF4J from the ESAPI context.*/
27-
private int maxLogLevel;
27+
private int loggingLevel;
2828

2929
/**
3030
* Constructs a new instance.
@@ -35,7 +35,7 @@ public class Slf4JLogger implements org.owasp.esapi.Logger {
3535
public Slf4JLogger(org.slf4j.Logger slf4JLogger, Slf4JLogBridge bridge, int defaultEsapiLevel) {
3636
delegate = slf4JLogger;
3737
this.logBridge = bridge;
38-
maxLogLevel = defaultEsapiLevel;
38+
loggingLevel = defaultEsapiLevel;
3939
}
4040

4141
private void log(int esapiLevel, EventType type, String message) {
@@ -52,8 +52,7 @@ private void log(int esapiLevel, EventType type, String message, Throwable throw
5252

5353

5454
private boolean isEnabled(int esapiLevel) {
55-
//Are Logger.OFF and Logger.ALL reversed? This should be simply the less than or equal to check...
56-
return (esapiLevel <= maxLogLevel && maxLogLevel != Logger.OFF) || maxLogLevel == Logger.ALL;
55+
return esapiLevel >= loggingLevel;
5756
}
5857

5958
@Override
@@ -128,7 +127,7 @@ public void fatal(EventType type, String message, Throwable throwable) {
128127

129128
@Override
130129
public int getESAPILevel() {
131-
return maxLogLevel;
130+
return loggingLevel;
132131
}
133132

134133
@Override
@@ -162,7 +161,7 @@ public boolean isFatalEnabled() {
162161

163162
@Override
164163
public void setLevel(int level) {
165-
maxLogLevel = level;
164+
loggingLevel = level;
166165
}
167166

168167
}

src/test/java/org/owasp/esapi/logging/java/JavaLoggerTest.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ public void setup() {
4646
public void testLevelEnablement() {
4747
testLogger.setLevel(Logger.INFO);
4848

49-
Assert.assertFalse(testLogger.isFatalEnabled());
50-
Assert.assertFalse(testLogger.isErrorEnabled());
51-
Assert.assertFalse(testLogger.isWarningEnabled());
49+
Assert.assertTrue(testLogger.isFatalEnabled());
50+
Assert.assertTrue(testLogger.isErrorEnabled());
51+
Assert.assertTrue(testLogger.isWarningEnabled());
5252
Assert.assertTrue(testLogger.isInfoEnabled());
53-
Assert.assertTrue(testLogger.isDebugEnabled());
54-
Assert.assertTrue(testLogger.isTraceEnabled());
53+
Assert.assertFalse(testLogger.isDebugEnabled());
54+
Assert.assertFalse(testLogger.isTraceEnabled());
5555

5656
Assert.assertEquals(Logger.INFO, testLogger.getESAPILevel());
5757
}

src/test/java/org/owasp/esapi/logging/log4j/Log4JLoggerTest.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ public class Log4JLoggerTest {
3636
public void testLevelEnablement() {
3737
testLogger.setLevel(Logger.INFO);
3838

39-
Assert.assertFalse(testLogger.isFatalEnabled());
40-
Assert.assertFalse(testLogger.isErrorEnabled());
41-
Assert.assertFalse(testLogger.isWarningEnabled());
39+
Assert.assertTrue(testLogger.isFatalEnabled());
40+
Assert.assertTrue(testLogger.isErrorEnabled());
41+
Assert.assertTrue(testLogger.isWarningEnabled());
4242
Assert.assertTrue(testLogger.isInfoEnabled());
43-
Assert.assertTrue(testLogger.isDebugEnabled());
44-
Assert.assertTrue(testLogger.isTraceEnabled());
43+
Assert.assertFalse(testLogger.isDebugEnabled());
44+
Assert.assertFalse(testLogger.isTraceEnabled());
4545

4646
Assert.assertEquals(Logger.INFO, testLogger.getESAPILevel());
4747
}

src/test/java/org/owasp/esapi/logging/slf4j/Slf4JLoggerTest.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ public class Slf4JLoggerTest {
3434
public void testLevelEnablement() {
3535
testLogger.setLevel(Logger.INFO);
3636

37-
Assert.assertFalse(testLogger.isFatalEnabled());
38-
Assert.assertFalse(testLogger.isErrorEnabled());
39-
Assert.assertFalse(testLogger.isWarningEnabled());
37+
Assert.assertTrue(testLogger.isFatalEnabled());
38+
Assert.assertTrue(testLogger.isErrorEnabled());
39+
Assert.assertTrue(testLogger.isWarningEnabled());
4040
Assert.assertTrue(testLogger.isInfoEnabled());
41-
Assert.assertTrue(testLogger.isDebugEnabled());
42-
Assert.assertTrue(testLogger.isTraceEnabled());
41+
Assert.assertFalse(testLogger.isDebugEnabled());
42+
Assert.assertFalse(testLogger.isTraceEnabled());
4343

4444
Assert.assertEquals(Logger.INFO, testLogger.getESAPILevel());
4545
}

0 commit comments

Comments
 (0)