gnodet-bot commented on code in PR #14066: URL: https://github.com/apache/maven/pull/14066#discussion_r4642515549
########## impl/maven-core/src/test/java/org/apache/maven/internal/impl/DefaultLoggerTest.java: ########## @@ -0,0 +1,306 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.internal.impl; + +import java.util.concurrent.atomic.AtomicBoolean; + +import org.apache.maven.api.logging.LogEventBuilder; +import org.apache.maven.api.logging.Logger; +import org.junit.jupiter.api.Test; +import org.slf4j.spi.LoggingEventBuilder; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotSame; +import static org.junit.jupiter.api.Assertions.assertSame; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.verifyNoMoreInteractions; +import static org.mockito.Mockito.when; + +/** + * Tests for {@link DefaultLogger}. + */ +class DefaultLoggerTest { + + @Test + void warnWithSupplierAndThrowableDelegatesToWarn() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + when(mockLogger.isWarnEnabled()).thenReturn(true); + + Logger log = new DefaultLogger(mockLogger); + RuntimeException ex = new RuntimeException("test"); + log.warn(() -> "warning message", ex); + + verify(mockLogger).warn("warning message", ex); + } + + @Test + void traceMethodsDelegateToSlf4jTrace() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + when(mockLogger.isTraceEnabled()).thenReturn(true); + + Logger log = new DefaultLogger(mockLogger); + log.trace("trace message"); + + verify(mockLogger).trace("trace message"); + } + + @Test + void traceIsNoOpWhenDisabled() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + when(mockLogger.isTraceEnabled()).thenReturn(false); + + Logger log = new DefaultLogger(mockLogger); + log.trace("should not be logged"); + + verify(mockLogger).isTraceEnabled(); + verifyNoMoreInteractions(mockLogger); + } + + @Test + void childCreatesChildLoggerWithAppendedName() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + when(mockLogger.getName()).thenReturn("org.example.MyMojo"); + + Logger log = new DefaultLogger(mockLogger); + Logger child = log.child("sub"); + + assertNotSame(log, child); + assertEquals("org.example.MyMojo.sub", child.name()); + } + + @Test + void childRejectsEmptyName() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + Logger log = new DefaultLogger(mockLogger); + + assertThrows(IllegalArgumentException.class, () -> log.child("")); + } + + // ---- Fluent builder: key-value pairs ---- + + @Test + void fluentBuilderWithKeyValueDelegatesToSlf4jAddKeyValue() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + LoggingEventBuilder mockBuilder = mock(LoggingEventBuilder.class); + when(mockLogger.isInfoEnabled()).thenReturn(true); + when(mockLogger.atInfo()).thenReturn(mockBuilder); + when(mockBuilder.addKeyValue("module", "compiler")).thenReturn(mockBuilder); + when(mockBuilder.addKeyValue("count", 3L)).thenReturn(mockBuilder); + + Logger log = new DefaultLogger(mockLogger); + log.atInfo() + .withKeyValue("module", "compiler") + .withKeyValue("count", 3L) + .log("Building {} modules", 3); + + verify(mockBuilder).addKeyValue("module", "compiler"); + verify(mockBuilder).addKeyValue("count", 3L); + verify(mockBuilder).log("Building {} modules", 3); + } + + @Test + void fluentBuilderBooleanKeyValueDelegatesToSlf4j() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + LoggingEventBuilder mockBuilder = mock(LoggingEventBuilder.class); + when(mockLogger.isDebugEnabled()).thenReturn(true); + when(mockLogger.atDebug()).thenReturn(mockBuilder); + when(mockBuilder.addKeyValue("incremental", true)).thenReturn(mockBuilder); + + Logger log = new DefaultLogger(mockLogger); + log.atDebug().withKeyValue("incremental", true).log("Compile"); + + verify(mockBuilder).addKeyValue("incremental", true); + verify(mockBuilder).log("Compile"); + } + + // ---- NOP builder laziness ---- + + @Test + void nopBuilderDoesNotInvokeMessageSupplier() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + when(mockLogger.isTraceEnabled()).thenReturn(false); + + AtomicBoolean supplierCalled = new AtomicBoolean(false); + Logger log = new DefaultLogger(mockLogger); + log.atTrace().log(() -> { + supplierCalled.set(true); + return "expensive message"; + }); + + assertFalse(supplierCalled.get(), "Supplier must not be called when TRACE is disabled"); + } + + @Test + void nopBuilderReturnsSameInstanceForAllChainedCalls() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + when(mockLogger.isDebugEnabled()).thenReturn(false); + + Logger log = new DefaultLogger(mockLogger); + LogEventBuilder b1 = log.atDebug(); + LogEventBuilder b2 = b1.withKeyValue("k", "v"); + LogEventBuilder b3 = b2.withKeyValue("n", 42L); + LogEventBuilder b4 = b3.withThrowable(null); + + assertSame(b1, b2, "NOP builder must return itself from withKeyValue(String,String)"); + assertSame(b2, b3, "NOP builder must return itself from withKeyValue(String,long)"); + assertSame(b3, b4, "NOP builder must return itself from withThrowable"); + } + + // ---- withThrowable after builder already initialised ---- + + @Test + void withThrowableAfterKeyValueSetsSlf4jCause() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + LoggingEventBuilder mockBuilder = mock(LoggingEventBuilder.class); + when(mockLogger.isErrorEnabled()).thenReturn(true); + when(mockLogger.atError()).thenReturn(mockBuilder); + when(mockBuilder.addKeyValue("phase", "compile")).thenReturn(mockBuilder); + when(mockBuilder.setCause(org.mockito.ArgumentMatchers.any())).thenReturn(mockBuilder); + + RuntimeException ex = new RuntimeException("fail"); + Logger log = new DefaultLogger(mockLogger); + log.atError() + .withKeyValue("phase", "compile") // triggers ensureBuilder() → slf4jBuilder is now set + .withThrowable(ex) // must call slf4jBuilder.setCause(ex), not store in field + .log("Build failed"); + + verify(mockBuilder).setCause(ex); + verify(mockBuilder).log("Build failed"); + } + + @Test + void withThrowableBeforeKeyValueStoresAndPassesToBuilder() { + org.slf4j.Logger mockLogger = mock(org.slf4j.Logger.class); + LoggingEventBuilder mockBuilder = mock(LoggingEventBuilder.class); + when(mockLogger.isWarnEnabled()).thenReturn(true); + when(mockLogger.atWarn()).thenReturn(mockBuilder); + when(mockBuilder.addKeyValue("key", "val")).thenReturn(mockBuilder); + when(mockBuilder.setCause(org.mockito.ArgumentMatchers.any())).thenReturn(mockBuilder); + + RuntimeException ex = new RuntimeException("warn"); + Logger log = new DefaultLogger(mockLogger); + log.atWarn() + .withThrowable(ex) // stored in field — builder not yet initialised + .withKeyValue("key", "val") // triggers ensureBuilder() → must pass stored throwable + .log("Warning"); + + // The throwable is passed via setCause inside ensureBuilder() when slf4jBuilder is first created + verify(mockBuilder).setCause(ex); + verify(mockBuilder).addKeyValue("key", "val"); + verify(mockBuilder).log("Warning"); + } + + // ---- ModelProcessor bridge: strict option handling ---- + + /** + * Verifies that the default {@code read(Source, Map)} bridge in {@link org.apache.maven.api.services.model.ModelProcessor} + * passes {@code strict=true} to the underlying {@code read(XmlReaderRequest)} when options is {@code null}. + */ + @Test + void modelProcessorReadBridgeUsesStrictTrueByDefault() throws Exception { + final boolean[] strictSeen = {false}; + org.apache.maven.api.services.model.ModelProcessor processor = modelProcessorCapturingStrict(strictSeen); + + java.nio.file.Path tmp = java.nio.file.Files.createTempFile("pom", ".xml"); + try { + java.nio.file.Files.writeString(tmp, "<project/>"); + org.apache.maven.api.services.Source source = pathSource(tmp); + try { + processor.read(source, null); + } catch (Exception ignored) { + } + assert strictSeen[0] : "strict must be true when options is null"; Review Comment: `assert strictSeen[0]` uses the Java language `assert` keyword, which is a no-op unless `-ea` is passed to the JVM. Surefire does not enable assertions by default, so this test will silently pass even if `strict` is not being set to `true`. The companion test `modelProcessorReadBridgeRespectsStrictFalseOption` correctly uses `assertFalse()` — use `assertTrue()` here for consistency: ```suggestion assertTrue(strictSeen[0], "strict must be true when options is null"); ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
