You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2023/03/08 13:04:00 UTC
[jira] [Commented] (MNG-7724) Don't log warnings when runtime is not broken (slf4j integrations)
[ https://issues.apache.org/jira/browse/MNG-7724?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17697885#comment-17697885 ]
ASF GitHub Bot commented on MNG-7724:
-------------------------------------
elharo commented on code in PR #1041:
URL: https://github.com/apache/maven/pull/1041#discussion_r1129397818
##########
maven-embedder/src/test/java/org/apache/maven/cli/logging/Slf4jConfigurationFactoryTest.java:
##########
@@ -0,0 +1,107 @@
+/*
+ * 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.cli.logging;
+
+import java.io.IOException;
+import java.lang.reflect.Field;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.function.BiConsumer;
+
+import org.apache.maven.cli.logging.impl.UnsupportedSlf4jBindingConfiguration;
+import org.junit.jupiter.api.Test;
+import org.slf4j.ILoggerFactory;
+import org.slf4j.Logger;
+
+import static java.util.Collections.singletonList;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
+import static org.junit.jupiter.api.Assertions.fail;
+
+/**
+ * Validates some edge cases of Slf4jConfigurationFactory.
+ */
+public class Slf4jConfigurationFactoryTest {
+ @Test
+ void logInfoWhenNoBindingIsFound() {
+ final UnsupportedSlf4jBindingConfiguration configuration = assertInstanceOf(
+ UnsupportedSlf4jBindingConfiguration.class,
+ Slf4jConfigurationFactory.getConfiguration(new UnknownLoggerFactory()));
+ final BiConsumer<Logger, String> logHandler = findLogHandler(configuration);
+ final CapturingLogger logger = new CapturingLogger();
+ logHandler.accept(logger, "should be info");
+ assertEquals(singletonList("info"), logger.events);
+ }
+
+ @Test
+ void logWarnWhenNoBindingIsFoundButSomeFailedToLoad() throws IOException {
+ final Path fakeProvider = Paths.get("target/test-classes/META-INF/maven/slf4j-configuration.properties");
+ Files.createDirectories(fakeProvider.getParent());
+ Files.write(
+ fakeProvider,
+ ("org.apache.maven.cli.logging.Slf4jConfigurationFactoryTest.UnknownLoggerFactory will.fail.for.test")
+ .getBytes(StandardCharsets.UTF_8));
+ try {
+ final UnsupportedSlf4jBindingConfiguration configuration = assertInstanceOf(
+ UnsupportedSlf4jBindingConfiguration.class,
+ Slf4jConfigurationFactory.getConfiguration(new UnknownLoggerFactory()));
+ final BiConsumer<Logger, String> logHandler = findLogHandler(configuration);
+ final CapturingLogger logger = new CapturingLogger();
+ logHandler.accept(logger, "should be warn");
+ assertEquals(singletonList("warn"), logger.events);
+ } finally {
+ Files.deleteIfExists(fakeProvider);
+ }
+ }
+
+ private BiConsumer<Logger, String> findLogHandler(final UnsupportedSlf4jBindingConfiguration configuration) {
+ try {
+ final Field log = configuration.getClass().getDeclaredField("log");
+ log.setAccessible(true);
+ return (BiConsumer<Logger, String>) log.get(configuration);
+ } catch (final Exception e) {
Review Comment:
Strongly disagree. Catching Exception here risks pulling in runtime exceptions we're not actually handling.
> Don't log warnings when runtime is not broken (slf4j integrations)
> ------------------------------------------------------------------
>
> Key: MNG-7724
> URL: https://issues.apache.org/jira/browse/MNG-7724
> Project: Maven
> Issue Type: Improvement
> Affects Versions: 4.0.0-alpha-4
> Reporter: Romain Manni-Bucau
> Priority: Minor
>
> As of now if we change the SLF4J bindings maven will issue warnings because a few features are disabled but due to the nature of switching these bindings it is highly likely it is intended and therefore the warning are misleading more than helping.
> The solution can be to log a warning if a configured factory fails to load but just log info when it succeeds.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)