From 2bbab11d671ba452771fdf5ab8ad33225cc67397 Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Sat, 5 Apr 2014 15:42:41 -0400 Subject: Add sangria-log4j module. --- pom.xml | 7 ++ sangria-log4j/pom.xml | 66 ++++++++++++++++++ .../sangria/log4j/Log4jLoggerProvider.java | 46 +++++++++++++ .../sangria/log4j/SangriaLog4jModule.java | 39 +++++++++++ .../com/tavianator/sangria/log4j/package-info.java | 25 +++++++ .../sangria/log4j/SangriaLog4jModuleTest.java | 80 ++++++++++++++++++++++ .../sangria/slf4j/SangriaSlf4jModuleTest.java | 2 +- 7 files changed, 264 insertions(+), 1 deletion(-) create mode 100644 sangria-log4j/pom.xml create mode 100644 sangria-log4j/src/main/java/com/tavianator/sangria/log4j/Log4jLoggerProvider.java create mode 100644 sangria-log4j/src/main/java/com/tavianator/sangria/log4j/SangriaLog4jModule.java create mode 100644 sangria-log4j/src/main/java/com/tavianator/sangria/log4j/package-info.java create mode 100644 sangria-log4j/src/test/java/com/tavianator/sangria/log4j/SangriaLog4jModuleTest.java diff --git a/pom.xml b/pom.xml index fb15de9..3e75e16 100644 --- a/pom.xml +++ b/pom.xml @@ -66,6 +66,12 @@ 1.0-SNAPSHOT + + com.tavianator.sangria + sangria-log4j + 1.0-SNAPSHOT + + com.google.inject guice @@ -272,6 +278,7 @@ sangria-core sangria-contextual sangria-slf4j + sangria-log4j diff --git a/sangria-log4j/pom.xml b/sangria-log4j/pom.xml new file mode 100644 index 0000000..b39995f --- /dev/null +++ b/sangria-log4j/pom.xml @@ -0,0 +1,66 @@ + + + 4.0.0 + + + com.tavianator.sangria + sangria + 1.0-SNAPSHOT + + + sangria-log4j + jar + Sangria Log4j + Log4j Logger injection + + + + com.tavianator.sangria + sangria-contextual + + + + com.google.inject + guice + + + + org.apache.logging.log4j + log4j-api + 2.0-rc1 + + + + com.google.code.findbugs + jsr305 + true + + + + junit + junit + test + + + + org.hamcrest + hamcrest-integration + test + + + + org.mockito + mockito-core + test + + + + org.apache.logging.log4j + log4j-core + 2.0-rc1 + test + + + diff --git a/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/Log4jLoggerProvider.java b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/Log4jLoggerProvider.java new file mode 100644 index 0000000..dae2323 --- /dev/null +++ b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/Log4jLoggerProvider.java @@ -0,0 +1,46 @@ +/**************************************************************************** + * Sangria * + * Copyright (C) 2014 Tavian Barnes * + * * + * Licensed 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 com.tavianator.sangria.log4j; + +import javax.inject.Singleton; + +import com.google.inject.spi.InjectionPoint; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; + +import com.tavianator.sangria.contextual.ContextSensitiveProvider; + +/** + * Actual {@link Logger} provider implementation. + * + * @author Tavian Barnes (tavianator@tavianator.com) + * @version 1.0 + * @since 1.0 + */ +@Singleton +class Log4jLoggerProvider implements ContextSensitiveProvider { + @Override + public Logger getInContext(InjectionPoint injectionPoint) { + return LogManager.getLogger(injectionPoint.getDeclaringType().getRawType()); + } + + @Override + public Logger getInUnknownContext() { + return LogManager.getRootLogger(); + } +} diff --git a/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/SangriaLog4jModule.java b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/SangriaLog4jModule.java new file mode 100644 index 0000000..7f5baa3 --- /dev/null +++ b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/SangriaLog4jModule.java @@ -0,0 +1,39 @@ +/**************************************************************************** + * Sangria * + * Copyright (C) 2014 Tavian Barnes * + * * + * Licensed 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 com.tavianator.sangria.log4j; + +import com.google.inject.AbstractModule; +import org.apache.logging.log4j.Logger; + +import com.tavianator.sangria.contextual.ContextSensitiveBinder; + +/** + * Module for Log4j {@link Logger} injection. + * + * @author Tavian Barnes (tavianator@tavianator.com) + * @version 1.0 + * @since 1.0 + */ +public class SangriaLog4jModule extends AbstractModule { + @Override + protected void configure() { + ContextSensitiveBinder.create(binder()) + .bind(Logger.class) + .toContextSensitiveProvider(Log4jLoggerProvider.class); + } +} diff --git a/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/package-info.java b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/package-info.java new file mode 100644 index 0000000..7f07951 --- /dev/null +++ b/sangria-log4j/src/main/java/com/tavianator/sangria/log4j/package-info.java @@ -0,0 +1,25 @@ +/**************************************************************************** + * Sangria * + * Copyright (C) 2014 Tavian Barnes * + * * + * Licensed 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. * + ****************************************************************************/ + +/** + * {@code sangria-log4j}: Log4j {@link org.apache.logging.log4j.Logger} injection. + * + * @author Tavian Barnes (tavianator@tavianator.com) + * @version 1.0 + * @since 1.0 + */ +package com.tavianator.sangria.log4j; diff --git a/sangria-log4j/src/test/java/com/tavianator/sangria/log4j/SangriaLog4jModuleTest.java b/sangria-log4j/src/test/java/com/tavianator/sangria/log4j/SangriaLog4jModuleTest.java new file mode 100644 index 0000000..d91cf90 --- /dev/null +++ b/sangria-log4j/src/test/java/com/tavianator/sangria/log4j/SangriaLog4jModuleTest.java @@ -0,0 +1,80 @@ +/**************************************************************************** + * Sangria * + * Copyright (C) 2014 Tavian Barnes * + * * + * Licensed 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 com.tavianator.sangria.log4j; + +import javax.inject.Inject; +import javax.inject.Provider; + +import com.google.inject.AbstractModule; +import com.google.inject.Guice; +import com.google.inject.Injector; +import com.google.inject.Provides; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.junit.Before; +import org.junit.Test; + +import static org.hamcrest.Matchers.*; +import static org.junit.Assert.*; + +/** + * @author Tavian Barnes (tavianator@tavianator.com) + * @version 1.0 + * @since 1.0 + */ +public class SangriaLog4jModuleTest { + @Inject Logger logger; + @Inject Provider provider; + + @Before + public void setUp() { + Guice.createInjector(new SangriaLog4jModule()).injectMembers(this); + } + + @Test + public void testLogger() { + assertThat(logger.getName(), equalTo(SangriaLog4jModuleTest.class.getName())); + } + + @Test + public void testProvider() { + assertThat(provider.get().getName(), equalTo(LogManager.ROOT_LOGGER_NAME)); + } + + @Test + public void testProviderMethod() { + Injector injector = Guice.createInjector(new AbstractModule() { + @Override + protected void configure() { + install(new SangriaLog4jModule()); + } + + @Provides + String getLoggerName(Logger logger) { + return logger.getName(); + } + }); + + assertThat(injector.getInstance(String.class), equalTo(LogManager.ROOT_LOGGER_NAME)); + } + + @Test + public void testDeDuplication() { + Guice.createInjector(new SangriaLog4jModule(), new SangriaLog4jModule()); + } +} diff --git a/sangria-slf4j/src/test/java/com/tavianator/sangria/slf4j/SangriaSlf4jModuleTest.java b/sangria-slf4j/src/test/java/com/tavianator/sangria/slf4j/SangriaSlf4jModuleTest.java index 1869008..d142bde 100644 --- a/sangria-slf4j/src/test/java/com/tavianator/sangria/slf4j/SangriaSlf4jModuleTest.java +++ b/sangria-slf4j/src/test/java/com/tavianator/sangria/slf4j/SangriaSlf4jModuleTest.java @@ -49,7 +49,7 @@ public class SangriaSlf4jModuleTest { @Test public void testLogger() { - assertThat(logger.getName(), equalTo("com.tavianator.sangria.slf4j.SangriaSlf4jModuleTest")); + assertThat(logger.getName(), equalTo(SangriaSlf4jModuleTest.class.getName())); } @Test -- cgit v1.2.3