Skip to content

Commit

Permalink
Merge pull request #1080 from jgallimore/update-slf4j
Browse files Browse the repository at this point in the history
TOMEE-4269: Update SLF4J API, and JUL binding to 2.0.9, allow SLF4J to be loaded from application classpath
  • Loading branch information
jgallimore authored Nov 6, 2023
2 parents 46f9fd7 + df1806f commit f15c485
Show file tree
Hide file tree
Showing 13 changed files with 455 additions and 31 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/**
* 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.openejb.arquillian.tests.slf4j;

import org.apache.ziplock.WebModule;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.arquillian.test.api.ArquillianResource;
import org.jboss.shrinkwrap.api.asset.ClassLoaderAsset;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.junit.Test;
import org.junit.runner.RunWith;

import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.net.URL;

import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

@RunWith(Arquillian.class)
public class BasicSlf4jWebappTest {
@ArquillianResource(SimpleServlet.class)
private URL url;

@Deployment(testable = false)
public static WebArchive getArchive() {
final WebArchive archive = new WebModule(BasicSlf4jWebappTest.class.getSimpleName()).getArchive();
archive.addClass(SimpleServlet.class);
archive.add(new ClassLoaderAsset("org/apache/openejb/arquillian/tests/slf4j/logback.xml"), "WEB-INF/logback.xml");
System.out.println(archive.toString(true));
return archive;
}

@Test
public void validate() throws Exception {
final String launchProfile = System.getProperty("arquillian.launch");
if ("tomee-embedded".equals(launchProfile)) {
System.out.println("Skipping this test in TomEE embedded");
return;
}

final InputStream is = new URL(url.toExternalForm() + "logtest").openStream();
final ByteArrayOutputStream os = new ByteArrayOutputStream();

int bytesRead;
byte[] buffer = new byte[8192];
while ((bytesRead = is.read(buffer)) > -1) {
os.write(buffer, 0, bytesRead);
}

is.close();
os.close();

final String output = new String(os.toByteArray(), "UTF-8");
assertNotNull("Response shouldn't be null", output);
assertTrue("Output should contain: " + "It works!" + "\n" + output, output.contains("It works!"));
assertTrue("Output should contain: " + "Logger Factory: org.slf4j.jul.JDK14LoggerFactory" + "\n" + output, output.contains("Logger Factory: org.slf4j.jul.JDK14LoggerFactory"));
assertTrue("Output should contain: " + "slf4j-jdk14-2.0.9.jar" + "\n" + output, output.contains("slf4j-jdk14-2.0.9.jar"));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/**
* 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.openejb.arquillian.tests.slf4j;

import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.slf4j.ILoggerFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.io.PrintWriter;

@WebServlet(urlPatterns = "/logtest")
public class SimpleServlet extends HttpServlet {

private static final Logger LOGGER = LoggerFactory.getLogger(SimpleServlet.class);

@Override
protected void doGet(final HttpServletRequest req, final HttpServletResponse resp) throws ServletException, IOException {
final ILoggerFactory iLoggerFactory = LoggerFactory.getILoggerFactory();
final String loggerFactoryName = iLoggerFactory.getClass().getName();

LOGGER.info("Simple servlet called");
LOGGER.info("Logger Factory: " + loggerFactoryName);

final PrintWriter writer = resp.getWriter();
writer.println("It works!\n" +
"Logger Factory: " + loggerFactoryName + "\n" +
"Protection Domain: " + iLoggerFactory.getClass().getProtectionDomain().toString());
writer.flush();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/**
* 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.openejb.arquillian.tests.slf4j;

import org.apache.ziplock.WebModule;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.arquillian.test.api.ArquillianResource;
import org.jboss.shrinkwrap.api.asset.ClassLoaderAsset;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.jboss.shrinkwrap.resolver.api.ResolutionException;
import org.jboss.shrinkwrap.resolver.api.maven.Maven;
import org.junit.Test;
import org.junit.runner.RunWith;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.InputStream;
import java.net.URL;

import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

@RunWith(Arquillian.class)
public class Slf4j1xLogbackWebappTest {
@ArquillianResource(SimpleServlet.class)
private URL url;

@Deployment(testable = false)
public static WebArchive getArchive() {
File[] dependencies;
try { // try offline first since it is generally faster
dependencies = Maven.configureResolver()
.workOffline()
.loadPomFromFile("src/test/resources/slf4j1x-pom.xml")
.importCompileAndRuntimeDependencies().resolve().withTransitivity()
.asFile();
} catch (ResolutionException re) { // try on central
dependencies = Maven.resolver()
.loadPomFromFile("src/test/resources/slf4j1x-pom.xml")
.importCompileAndRuntimeDependencies().resolve().withTransitivity()
.asFile();
}


final WebArchive archive = new WebModule(BasicSlf4jWebappTest.class.getSimpleName()).getArchive();
archive.addClass(SimpleServlet.class);
archive.add(new ClassLoaderAsset("org/apache/openejb/arquillian/tests/slf4j/logback.xml"), "WEB-INF/logback.xml");
archive.addAsLibraries(dependencies);
System.out.println(archive.toString(true));
return archive;
}

@Test
public void validate() throws Exception {
final String launchProfile = System.getProperty("arquillian.launch");
if ("tomee-embedded".equals(launchProfile)) {
System.out.println("Skipping this test in TomEE embedded");
return;
}

final InputStream is = new URL(url.toExternalForm() + "logtest").openStream();
final ByteArrayOutputStream os = new ByteArrayOutputStream();

int bytesRead;
byte[] buffer = new byte[8192];
while ((bytesRead = is.read(buffer)) > -1) {
os.write(buffer, 0, bytesRead);
}

is.close();
os.close();

final String output = new String(os.toByteArray(), "UTF-8");
assertNotNull("Response shouldn't be null", output);
assertTrue("Output should contain: " + "It works!" + "\n" + output, output.contains("It works!"));
assertTrue("Output should contain: " + "Logger Factory: ch.qos.logback.classic.LoggerContext" + "\n" + output, output.contains("Logger Factory: ch.qos.logback.classic.LoggerContext"));
assertTrue("Output should contain: " + "logback-classic-1.2.11.jar" + "\n" + output, output.contains("logback-classic-1.2.11.jar"));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/**
* 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.openejb.arquillian.tests.slf4j;

import org.apache.ziplock.WebModule;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.arquillian.test.api.ArquillianResource;
import org.jboss.shrinkwrap.api.asset.ClassLoaderAsset;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.jboss.shrinkwrap.resolver.api.ResolutionException;
import org.jboss.shrinkwrap.resolver.api.maven.Maven;
import org.junit.Test;
import org.junit.runner.RunWith;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.InputStream;
import java.net.URL;

import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

@RunWith(Arquillian.class)
public class Slf4j2xLogbackWebappTest {
@ArquillianResource(SimpleServlet.class)
private URL url;

@Deployment(testable = false)
public static WebArchive getArchive() {
File[] dependencies;
try { // try offline first since it is generally faster
dependencies = Maven.configureResolver()
.workOffline()
.loadPomFromFile("src/test/resources/slf4j2x-pom.xml")
.importCompileAndRuntimeDependencies().resolve().withTransitivity()
.asFile();
} catch (ResolutionException re) { // try on central
dependencies = Maven.resolver()
.loadPomFromFile("src/test/resources/slf4j2x-pom.xml")
.importCompileAndRuntimeDependencies().resolve().withTransitivity()
.asFile();
}


final WebArchive archive = new WebModule(BasicSlf4jWebappTest.class.getSimpleName()).getArchive();
archive.addClass(SimpleServlet.class);
archive.add(new ClassLoaderAsset("org/apache/openejb/arquillian/tests/slf4j/logback.xml"), "WEB-INF/logback.xml");
archive.addAsLibraries(dependencies);
System.out.println(archive.toString(true));
return archive;
}

@Test
public void validate() throws Exception {
final String launchProfile = System.getProperty("arquillian.launch");
if ("tomee-embedded".equals(launchProfile)) {
System.out.println("Skipping this test in TomEE embedded");
return;
}

final InputStream is = new URL(url.toExternalForm() + "logtest").openStream();
final ByteArrayOutputStream os = new ByteArrayOutputStream();

int bytesRead;
byte[] buffer = new byte[8192];
while ((bytesRead = is.read(buffer)) > -1) {
os.write(buffer, 0, bytesRead);
}

is.close();
os.close();

final String output = new String(os.toByteArray(), "UTF-8");
assertNotNull("Response shouldn't be null", output);
assertTrue("Output should contain: " + "It works!" + "\n" + output, output.contains("It works!"));
assertTrue("Output should contain: " + "Logger Factory: ch.qos.logback.classic.LoggerContext" + "\n" + output, output.contains("Logger Factory: ch.qos.logback.classic.LoggerContext"));
assertTrue("Output should contain: " + "logback-classic-1.4.11.jar" + "\n" + output, output.contains("logback-classic-1.4.11.jar"));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<configuration debug="true" scan="true" scanPeriod="30 seconds">
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${catalina.base}/logs/tomcat.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>
${catalina.base}/logs/application.%i.log.zip
</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>5</maxIndex>
</rollingPolicy>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>1MB</maxFileSize>
</triggeringPolicy>
</appender>

<root level="INFO">
<appender-ref ref="FILE"/>
</root>
</configuration>
Loading

0 comments on commit f15c485

Please sign in to comment.