Skip to content

Commit f46f3d5

Browse files
committed
fix: remove AbstractConfigurationService dependency on slf4j
1 parent fad4baf commit f46f3d5

File tree

4 files changed

+32
-13
lines changed

4 files changed

+32
-13
lines changed

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AbstractConfigurationService.java

+4-8
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,8 @@
77
import java.util.Set;
88
import java.util.concurrent.ConcurrentHashMap;
99
import java.util.stream.Stream;
10-
import org.slf4j.Logger;
11-
import org.slf4j.LoggerFactory;
1210

1311
public abstract class AbstractConfigurationService implements ConfigurationService {
14-
15-
public static final String LOGGER_NAME = "Default ConfigurationService implementation";
16-
protected static final Logger log = LoggerFactory.getLogger(LOGGER_NAME);
17-
1812
private final Map<String, ControllerConfiguration> configurations = new ConcurrentHashMap<>();
1913
private final Version version;
2014

@@ -60,12 +54,14 @@ public <R extends CustomResource> ControllerConfiguration<R> getConfigurationFor
6054
final var key = keyFor(controller);
6155
final var configuration = configurations.get(key);
6256
if (configuration == null) {
63-
log.warn(
64-
"Configuration for controller '{}' was not found. {}", key, getControllersNameMessage());
57+
logMissingControllerWarning(key, getControllersNameMessage());
6558
}
6659
return configuration;
6760
}
6861

62+
protected abstract void logMissingControllerWarning(String controllerKey,
63+
String controllersNameMessage);
64+
6965
private String getControllersNameMessage() {
7066
return "Known controllers: "
7167
+ getKnownControllerNames().stream().reduce((s, s2) -> s + ", " + s2).orElse("None")
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
11
package io.javaoperatorsdk.operator.api.config;
22

3+
import org.slf4j.Logger;
4+
import org.slf4j.LoggerFactory;
5+
36
public class BaseConfigurationService extends AbstractConfigurationService {
47

8+
private static final String LOGGER_NAME = "Default ConfigurationService implementation";
9+
private static final Logger logger = LoggerFactory.getLogger(LOGGER_NAME);
10+
511
public BaseConfigurationService(Version version) {
612
super(version);
713
}
14+
15+
@Override
16+
protected void logMissingControllerWarning(String controllerKey, String controllersNameMessage) {
17+
logger.warn("Configuration for controller '{}' was not found. {}", controllerKey,
18+
controllersNameMessage);
19+
}
20+
21+
public String getLoggerName() {
22+
return LOGGER_NAME;
23+
}
24+
25+
protected Logger getLogger() {
26+
return logger;
27+
}
828
}

Diff for: operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationService.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ <R extends CustomResource> ControllerConfiguration<R> getConfigurationFor(
3232
// create the configuration on demand and register it
3333
config = new AnnotationConfiguration<>(controller);
3434
register(config);
35-
log.info(
35+
getLogger().info(
3636
"Created configuration for controller {} with name {}",
3737
controller.getClass().getName(),
3838
config.getName());

Diff for: operator-framework/src/test/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationServiceTest.java

+7-4
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ public class DefaultConfigurationServiceTest {
2828

2929
@Test
3030
void attemptingToRetrieveAnUnknownControllerShouldLogWarning() {
31+
final var configurationService = DefaultConfigurationService.instance();
32+
3133
final LoggerContext context = LoggerContext.getContext(false);
3234
final PatternLayout layout = PatternLayout.createDefaultLayout(context.getConfiguration());
3335
final ListAppender appender = new ListAppender("list", null, layout, false, false);
@@ -37,24 +39,25 @@ void attemptingToRetrieveAnUnknownControllerShouldLogWarning() {
3739
context.getConfiguration().addAppender(appender);
3840

3941
AppenderRef ref = AppenderRef.createAppenderRef("list", null, null);
42+
final var loggerName = configurationService.getLoggerName();
4043
LoggerConfig loggerConfig =
4144
LoggerConfig.createLogger(
4245
false,
4346
Level.valueOf("info"),
44-
AbstractConfigurationService.LOGGER_NAME,
47+
loggerName,
4548
"false",
4649
new AppenderRef[] {ref},
4750
null,
4851
context.getConfiguration(),
4952
null);
5053
loggerConfig.addAppender(appender, null, null);
5154

52-
context.getConfiguration().addLogger(AbstractConfigurationService.LOGGER_NAME, loggerConfig);
55+
context.getConfiguration().addLogger(loggerName, loggerConfig);
5356
context.updateLoggers();
5457

5558
try {
5659
final var config =
57-
DefaultConfigurationService.instance()
60+
configurationService
5861
.getConfigurationFor(new NotAutomaticallyCreated(), false);
5962

6063
assertThat(config).isNull();
@@ -64,7 +67,7 @@ void attemptingToRetrieveAnUnknownControllerShouldLogWarning() {
6467
} finally {
6568
appender.stop();
6669

67-
context.getConfiguration().removeLogger(AbstractConfigurationService.LOGGER_NAME);
70+
context.getConfiguration().removeLogger(loggerName);
6871
context.updateLoggers();
6972
}
7073
}

0 commit comments

Comments
 (0)