Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
@Named
public class EventSpyDispatcher {

private final Logger logger = LoggerFactory.getLogger(getClass());
private static final Logger LOGGER = LoggerFactory.getLogger(EventSpyDispatcher.class);

private final List<EventSpy> eventSpies;

Expand Down Expand Up @@ -107,10 +107,10 @@ public void close() {
private void logError(String action, Throwable e, EventSpy spy) {
String msg = "Failed to " + action + " spy " + spy.getClass().getName() + ": " + e.getMessage();

if (logger.isDebugEnabled()) {
logger.warn(msg, e);
if (LOGGER.isDebugEnabled()) {
LOGGER.warn(msg, e);
} else {
logger.warn(msg);
LOGGER.warn(msg);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/*
* 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.eventspy.internal;

import java.lang.reflect.Modifier;
import java.util.Arrays;

import org.junit.jupiter.api.Test;
import org.slf4j.Logger;

import static org.junit.jupiter.api.Assertions.assertFalse;

class EventSpyDispatcherTest {

@Test
void doesNotExposeFinalInstanceLoggerFieldForInjection() {
boolean hasFinalInstanceLogger = Arrays.stream(EventSpyDispatcher.class.getDeclaredFields())
.filter(field -> Logger.class.equals(field.getType()))
.anyMatch(field -> !Modifier.isStatic(field.getModifiers()) && Modifier.isFinal(field.getModifiers()));

assertFalse(hasFinalInstanceLogger);
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test guards against reintroducing a final instance Logger field, but it would not catch someone reintroducing a non-final instance Logger field (which would still be subject to Sisu injection and equally problematic). A simpler and broader guard would be to assert that no instance Logger field exists at all:

Suggested change
}
boolean hasInstanceLogger = Arrays.stream(EventSpyDispatcher.class.getDeclaredFields())
.filter(field -> Logger.class.equals(field.getType()))
.anyMatch(field -> !Modifier.isStatic(field.getModifiers()));
assertFalse(hasInstanceLogger, "Logger field should be static to avoid Sisu reflective mutation");
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO testing final presence is a little redundant ...

}