Refactoring of min-level set tests for better naming

quarkusio · Dec 4, 2020 · cae32ee · cae32ee
1 parent 3b9aacf
commit cae32ee
Show file tree

Hide file tree

Showing 20 changed files with 134 additions and 97 deletions.
diff --git a/...inlevel/set/warn/LoggingWarnResource.java → ...level/set/above/LoggingMinLevelAbove.java b/...inlevel/set/warn/LoggingWarnResource.java → ...level/set/above/LoggingMinLevelAbove.java
@@ -1,4 +1,4 @@
-package io.quarkus.it.logging.minlevel.set.warn;
+package io.quarkus.it.logging.minlevel.set.above;
 
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
@@ -9,9 +9,10 @@
 
 import io.quarkus.it.logging.minlevel.set.LoggingWitness;
 
-@Path("/log/warn")
-public class LoggingWarnResource {
-    static final Logger LOG = Logger.getLogger(LoggingWarnResource.class);
+@Path("/log/above")
+public class LoggingMinLevelAbove {
+
+    static final Logger LOG = Logger.getLogger(LoggingMinLevelAbove.class);
 
     @GET
     @Path("/not-info")

diff --git a/...level/set/trace/LoggingTraceResource.java → ...level/set/below/LoggingMinLevelBelow.java b/...level/set/trace/LoggingTraceResource.java → ...level/set/below/LoggingMinLevelBelow.java
@@ -1,4 +1,4 @@
-package io.quarkus.it.logging.minlevel.set.trace;
+package io.quarkus.it.logging.minlevel.set.below;
 
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
@@ -9,10 +9,10 @@
 
 import io.quarkus.it.logging.minlevel.set.LoggingWitness;
 
-@Path("/log/trace")
-public class LoggingTraceResource {
+@Path("/log/below")
+public class LoggingMinLevelBelow {
 
-    static final Logger LOG = Logger.getLogger(LoggingTraceResource.class);
+    static final Logger LOG = Logger.getLogger(LoggingMinLevelBelow.class);
 
     @GET
     @Path("/trace")

diff --git a/.../minlevel/set/any/LoggingAnyResource.java → ...t/bydefault/LoggingMinLevelByDefault.java b/.../minlevel/set/any/LoggingAnyResource.java → ...t/bydefault/LoggingMinLevelByDefault.java
@@ -1,4 +1,4 @@
-package io.quarkus.it.logging.minlevel.set.any;
+package io.quarkus.it.logging.minlevel.set.bydefault;
 
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
@@ -9,10 +9,10 @@
 
 import io.quarkus.it.logging.minlevel.set.LoggingWitness;
 
-@Path("/log/any")
-public class LoggingAnyResource {
+@Path("/log/bydefault")
+public class LoggingMinLevelByDefault {
 
-    static final Logger LOG = Logger.getLogger(LoggingAnyResource.class);
+    static final Logger LOG = Logger.getLogger(LoggingMinLevelByDefault.class);
 
     @GET
     @Path("/debug")

diff --git a/...level_error/sub/LoggingMinLevelError.java → ...l/set/promote/LoggingMinLevelPromote.java b/...level_error/sub/LoggingMinLevelError.java → ...l/set/promote/LoggingMinLevelPromote.java
@@ -1,4 +1,4 @@
-package io.quarkus.it.logging.minlevel.set.min_level_error.sub;
+package io.quarkus.it.logging.minlevel.set.promote;
 
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
@@ -9,10 +9,10 @@
 
 import io.quarkus.it.logging.minlevel.set.LoggingWitness;
 
-@Path("/log/min-level-error")
-public class LoggingMinLevelError {
+@Path("/log/promote")
+public class LoggingMinLevelPromote {
 
-    static final Logger LOG = Logger.getLogger(LoggingMinLevelError.class);
+    static final Logger LOG = Logger.getLogger(LoggingMinLevelPromote.class);
 
     @GET
     @Path("/not-info")

diff --git a/...c/main/java/io/quarkus/it/logging/minlevel/set/promote/sub/LoggingMinLevelPromoteSub.java b/...c/main/java/io/quarkus/it/logging/minlevel/set/promote/sub/LoggingMinLevelPromoteSub.java
@@ -0,0 +1,31 @@
+package io.quarkus.it.logging.minlevel.set.promote.sub;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+
+import org.jboss.logging.Logger;
+
+import io.quarkus.it.logging.minlevel.set.LoggingWitness;
+
+@Path("/log/promote/sub")
+public class LoggingMinLevelPromoteSub {
+
+    static final Logger LOG = Logger.getLogger(LoggingMinLevelPromoteSub.class);
+
+    @GET
+    @Path("/not-info")
+    @Produces(MediaType.TEXT_PLAIN)
+    public boolean isNotInfo() {
+        return !LOG.isInfoEnabled() && !LoggingWitness.loggedInfo("should not print", LOG);
+    }
+
+    @GET
+    @Path("/error")
+    @Produces(MediaType.TEXT_PLAIN)
+    public boolean isError() {
+        return LoggingWitness.loggedError("error message", LOG);
+    }
+
+}
diff --git a/...t/src/main/java/io/quarkus/it/logging/minlevel/set/trace/sub/LoggingSubTraceResource.java b/...t/src/main/java/io/quarkus/it/logging/minlevel/set/trace/sub/LoggingSubTraceResource.java
diff --git a/integration-tests/logging-min-level-set/src/main/resources/application.properties b/integration-tests/logging-min-level-set/src/main/resources/application.properties
@@ -1,4 +1,4 @@
 quarkus.log.min-level=DEBUG
-quarkus.log.category."io.quarkus.it.logging.minlevel.set.trace".min-level=TRACE
-quarkus.log.category."io.quarkus.it.logging.minlevel.set.warn".min-level=INFO
-quarkus.log.category."io.quarkus.it.logging.minlevel.set.min_level_error".min-level=ERROR
+quarkus.log.category."io.quarkus.it.logging.minlevel.set.above".min-level=INFO
+quarkus.log.category."io.quarkus.it.logging.minlevel.set.below".min-level=TRACE
+quarkus.log.category."io.quarkus.it.logging.minlevel.set.promote".min-level=ERROR
diff --git a/...minlevel/set/LoggingWarnResourceTest.java → ...inlevel/set/LoggingMinLevelAboveTest.java b/...minlevel/set/LoggingWarnResourceTest.java → ...inlevel/set/LoggingMinLevelAboveTest.java
@@ -8,14 +8,18 @@
 import io.quarkus.test.common.QuarkusTestResource;
 import io.quarkus.test.junit.QuarkusTest;
 
+/**
+ * Test that verifies that min-level can go higher than default min-level,
+ * and this can be further tweaked at runtime to go to above to an even higher level.
+ */
 @QuarkusTest
 @QuarkusTestResource(SetRuntimeLogLevels.class)
-public class LoggingWarnResourceTest {
+public class LoggingMinLevelAboveTest {
 
     @Test
     public void testNotInfo() {
         given()
-                .when().get("/log/warn/not-info")
+                .when().get("/log/above/not-info")
                 .then()
                 .statusCode(200)
                 .body(is("true"));
@@ -24,7 +28,7 @@ public void testNotInfo() {
     @Test
     public void testWarn() {
         given()
-                .when().get("/log/warn/warn")
+                .when().get("/log/above/warn")
                 .then()
                 .statusCode(200)
                 .body(is("true"));

diff --git a/...evel/set/LoggingSubTraceResourceTest.java → ...inlevel/set/LoggingMinLevelBelowTest.java b/...evel/set/LoggingSubTraceResourceTest.java → ...inlevel/set/LoggingMinLevelBelowTest.java
@@ -8,14 +8,17 @@
 import io.quarkus.test.common.QuarkusTestResource;
 import io.quarkus.test.junit.QuarkusTest;
 
+/**
+ * Test verifies that a min-level override that goes below the default min-level is applied correctly.
+ */
 @QuarkusTest
 @QuarkusTestResource(SetRuntimeLogLevels.class)
-public class LoggingSubTraceResourceTest {
+public class LoggingMinLevelBelowTest {
 
     @Test
     public void testTrace() {
         given()
-                .when().get("/log/trace/sub/trace")
+                .when().get("/log/below/trace")
                 .then()
                 .statusCode(200)
                 .body(is("true"));

diff --git a/...el-set/src/test/java/io/quarkus/it/logging/minlevel/set/LoggingMinLevelByDefaultTest.java b/...el-set/src/test/java/io/quarkus/it/logging/minlevel/set/LoggingMinLevelByDefaultTest.java
@@ -0,0 +1,40 @@
+package io.quarkus.it.logging.minlevel.set;
+
+import static io.restassured.RestAssured.given;
+import static org.hamcrest.CoreMatchers.is;
+
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.test.common.QuarkusTestResource;
+import io.quarkus.test.junit.QuarkusTest;
+
+/**
+ * Tests that verify that changes to the default min-level are applied correctly.
+ *
+ * If unset, the default is INFO,
+ * so this test verifies that when the default min-level is changed,
+ * say to DEBUG, the code works as expected.
+ */
+@QuarkusTest
+@QuarkusTestResource(SetRuntimeLogLevels.class)
+public class LoggingMinLevelByDefaultTest {
+
+    @Test
+    public void testDebug() {
+        given()
+                .when().get("/log/bydefault/debug")
+                .then()
+                .statusCode(200)
+                .body(is("true"));
+    }
+
+    @Test
+    public void testNotTrace() {
+        given()
+                .when().get("/log/bydefault/not-trace")
+                .then()
+                .statusCode(200)
+                .body(is("true"));
+    }
+
+}
diff --git a/.../minlevel/set/LoggingAnyResourceTest.java → ...el/set/LoggingMinLevelPromoteSubTest.java b/.../minlevel/set/LoggingAnyResourceTest.java → ...el/set/LoggingMinLevelPromoteSubTest.java
@@ -8,23 +8,26 @@
 import io.quarkus.test.common.QuarkusTestResource;
 import io.quarkus.test.junit.QuarkusTest;
 
+/**
+ * This test verifies that log levels are promoted to min-level when set below, even for subpackages.
+ */
 @QuarkusTest
 @QuarkusTestResource(SetRuntimeLogLevels.class)
-public class LoggingAnyResourceTest {
+public class LoggingMinLevelPromoteSubTest {
 
     @Test
-    public void testDebug() {
+    public void testNotInfo() {
         given()
-                .when().get("/log/any/debug")
+                .when().get("/log/promote/sub/not-info")
                 .then()
                 .statusCode(200)
                 .body(is("true"));
     }
 
     @Test
-    public void testNotTrace() {
+    public void testError() {
         given()
-                .when().get("/log/any/not-trace")
+                .when().get("/log/promote/sub/error")
                 .then()
                 .statusCode(200)
                 .body(is("true"));

diff --git a/...inlevel/set/LoggingMinLevelErrorTest.java → ...level/set/LoggingMinLevelPromoteTest.java b/...inlevel/set/LoggingMinLevelErrorTest.java → ...level/set/LoggingMinLevelPromoteTest.java
@@ -8,14 +8,17 @@
 import io.quarkus.test.common.QuarkusTestResource;
 import io.quarkus.test.junit.QuarkusTest;
 
+/**
+ * This test verifies that log levels are promoted to min-level when set below.
+ */
 @QuarkusTest
 @QuarkusTestResource(SetRuntimeLogLevels.class)
-public class LoggingMinLevelErrorTest {
+public class LoggingMinLevelPromoteTest {
 
     @Test
     public void testNotInfo() {
         given()
-                .when().get("/log/min-level-error/not-info")
+                .when().get("/log/promote/not-info")
                 .then()
                 .statusCode(200)
                 .body(is("true"));
@@ -24,7 +27,7 @@ public void testNotInfo() {
     @Test
     public void testError() {
         given()
-                .when().get("/log/min-level-error/error")
+                .when().get("/log/promote/error")
                 .then()
                 .statusCode(200)
                 .body(is("true"));

diff --git a/...-level-set/src/test/java/io/quarkus/it/logging/minlevel/set/LoggingTraceResourceTest.java b/...-level-set/src/test/java/io/quarkus/it/logging/minlevel/set/LoggingTraceResourceTest.java
diff --git a/...level/set/NativeLoggingAnyResourceIT.java → ...vel/set/NativeLoggingMinLevelAboveIT.java b/...level/set/NativeLoggingAnyResourceIT.java → ...vel/set/NativeLoggingMinLevelAboveIT.java
@@ -3,7 +3,7 @@
 import io.quarkus.test.junit.NativeImageTest;
 
 @NativeImageTest
-public class NativeLoggingAnyResourceIT extends LoggingAnyResourceTest {
+public class NativeLoggingMinLevelAboveIT extends LoggingMinLevelAboveTest {
 
     // Execute the same tests but in native mode.
 }
diff --git a/...vel/set/NativeLoggingTraceResourceIT.java → ...vel/set/NativeLoggingMinLevelBelowIT.java b/...vel/set/NativeLoggingTraceResourceIT.java → ...vel/set/NativeLoggingMinLevelBelowIT.java
@@ -3,7 +3,7 @@
 import io.quarkus.test.junit.NativeImageTest;
 
 @NativeImageTest
-public class NativeLoggingTraceResourceIT extends LoggingTraceResourceTest {
+public class NativeLoggingMinLevelBelowIT extends LoggingMinLevelBelowTest {
 
     // Execute the same tests but in native mode.
 }
diff --git a/.../set/NativeLoggingSubTraceResourceIT.java → ...set/NativeLoggingMinLevelByDefaultIT.java b/.../set/NativeLoggingSubTraceResourceIT.java → ...set/NativeLoggingMinLevelByDefaultIT.java
@@ -3,7 +3,7 @@
 import io.quarkus.test.junit.NativeImageTest;
 
 @NativeImageTest
-public class NativeLoggingSubTraceResourceIT extends LoggingSubTraceResourceTest {
+public class NativeLoggingMinLevelByDefaultIT extends LoggingMinLevelByDefaultTest {
 
     // Execute the same tests but in native mode.
 }
diff --git a/...el-set/src/test/java/io/quarkus/it/logging/minlevel/set/NativeLoggingMinLevelErrorIT.java b/...el-set/src/test/java/io/quarkus/it/logging/minlevel/set/NativeLoggingMinLevelErrorIT.java
diff --git a/...evel/set/NativeLoggingWarnResourceIT.java → ...l/set/NativeLoggingMinLevelPromoteIT.java b/...evel/set/NativeLoggingWarnResourceIT.java → ...l/set/NativeLoggingMinLevelPromoteIT.java
@@ -3,7 +3,7 @@
 import io.quarkus.test.junit.NativeImageTest;
 
 @NativeImageTest
-public class NativeLoggingWarnResourceIT extends LoggingWarnResourceTest {
+public class NativeLoggingMinLevelPromoteIT extends LoggingMinLevelPromoteTest {
 
     // Execute the same tests but in native mode.
 }
diff --git a/...t/src/test/java/io/quarkus/it/logging/minlevel/set/NativeLoggingMinLevelPromoteSubIT.java b/...t/src/test/java/io/quarkus/it/logging/minlevel/set/NativeLoggingMinLevelPromoteSubIT.java
@@ -0,0 +1,9 @@
+package io.quarkus.it.logging.minlevel.set;
+
+import io.quarkus.test.junit.NativeImageTest;
+
+@NativeImageTest
+public class NativeLoggingMinLevelPromoteSubIT extends LoggingMinLevelPromoteSubTest {
+
+    // Execute the same tests but in native mode.
+}
diff --git a/...g-min-level-set/src/test/java/io/quarkus/it/logging/minlevel/set/SetRuntimeLogLevels.java b/...g-min-level-set/src/test/java/io/quarkus/it/logging/minlevel/set/SetRuntimeLogLevels.java
@@ -10,10 +10,10 @@ public final class SetRuntimeLogLevels implements QuarkusTestResourceLifecycleMa
     @Override
     public Map<String, String> start() {
         final Map<String, String> systemProperties = new HashMap<>();
-        systemProperties.put("quarkus.log.category.\"io.quarkus.it.logging.minlevel.set.any\".level", "DEBUG");
-        systemProperties.put("quarkus.log.category.\"io.quarkus.it.logging.minlevel.set.trace\".level", "TRACE");
-        systemProperties.put("quarkus.log.category.\"io.quarkus.it.logging.minlevel.set.warn\".level", "WARN");
-        systemProperties.put("quarkus.log.category.\"io.quarkus.it.logging.minlevel.set.min_level_error.sub\".level", "INFO");
+        systemProperties.put("quarkus.log.category.\"io.quarkus.it.logging.minlevel.set.bydefault\".level", "DEBUG");
+        systemProperties.put("quarkus.log.category.\"io.quarkus.it.logging.minlevel.set.above\".level", "WARN");
+        systemProperties.put("quarkus.log.category.\"io.quarkus.it.logging.minlevel.set.below\".level", "TRACE");
+        systemProperties.put("quarkus.log.category.\"io.quarkus.it.logging.minlevel.set.promote\".level", "INFO");
         return systemProperties;
     }