Merge pull request #11 from jamezp/test

Add a simple test and CI runner

Author: jamezp

.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+# This workflow will build a Java project with Maven
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+
+name: SLF4J JBoss Log Manager Binding - CI
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  build:
+    name: ${{ matrix.os }}-jdk${{ matrix.java }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest ]
+        java: ['1.8', '11']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v1
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+      - name: Set up JDK ${{ matrix.java }}
+        uses: actions/setup-java@v1
+        with:
+          java-version: ${{ matrix.java }}
+      - name: Build and Test on ${{ matrix.java }}
+        run: mvn clean install
+      - uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: surefire-reports-${{ matrix.os }}-${{ matrix.java }}
+          path: '**/surefire-reports/*.txt'

pom.xml

@@ -37,6 +37,7 @@
     </parent>
 
     <properties>
+        <version.junit>4.13.1</version.junit>
         <version.org.jboss.logmanager>2.1.17.Final</version.org.jboss.logmanager>
         <version.org.slf4j>1.7.30</version.org.slf4j>
     </properties>
@@ -72,5 +73,11 @@
             <version>${version.org.slf4j}</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>${version.junit}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

src/test/java/org/slf4j/impl/LoggerTestCase.java

@@ -0,0 +1,140 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ *
+ * Copyright 2020 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * 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 org.slf4j.impl;
+
+import java.util.concurrent.BlockingDeque;
+import java.util.concurrent.LinkedBlockingDeque;
+import java.util.logging.Level;
+import java.util.logging.LogRecord;
+
+import org.jboss.logmanager.ExtHandler;
+import org.jboss.logmanager.ExtLogRecord;
+import org.jboss.logmanager.LogContext;
+import org.jboss.logmanager.LogContextSelector;
+import org.junit.After;
+import org.junit.AfterClass;
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
+
+/**
+ * @author <a href="mailto:[email protected]">James R. Perkins</a>
+ */
+public class LoggerTestCase {
+    private static final LogContext LOG_CONTEXT = LogContext.create();
+    private static final java.util.logging.Logger ROOT = LOG_CONTEXT.getLogger("");
+    private static final QueueHandler HANDLER = new QueueHandler();
+
+    private static final LogContextSelector DEFAULT_SELECTOR = LogContext.getLogContextSelector();
+
+    @BeforeClass
+    public static void configureLogManager() {
+        LogContext.setLogContextSelector(() -> LOG_CONTEXT);
+        ROOT.addHandler(HANDLER);
+    }
+
+    @AfterClass
+    public static void cleanup() throws Exception {
+        LOG_CONTEXT.close();
+        LogContext.setLogContextSelector(DEFAULT_SELECTOR);
+    }
+
+    @After
+    public void clearHandler() {
+        HANDLER.close();
+    }
+
+    @Test
+    public void testLogger() {
+        final Logger logger = LoggerFactory.getLogger(LoggerTestCase.class);
+        Assert.assertTrue(expectedTypeMessage(Slf4jLogger.class, logger.getClass()), logger instanceof Slf4jLogger);
+
+        // Ensure the logger logs something
+        final String testMsg = "This is a test message";
+        logger.info(testMsg);
+        ExtLogRecord record = HANDLER.messages.poll();
+        Assert.assertNotNull(record);
+        Assert.assertEquals(testMsg, record.getMessage());
+        Assert.assertNull(record.getParameters());
+
+        // Test a formatted message
+        logger.info("This is a test formatted {}", "{message}");
+        record = HANDLER.messages.poll();
+        Assert.assertNotNull(record);
+        Assert.assertEquals("This is a test formatted {message}", record.getFormattedMessage());
+        Assert.assertArrayEquals("Expected parameter not found.", new Object[] {"{message}"}, record.getParameters());
+    }
+
+    @Test
+    public void testLoggerWithExceptions() {
+        final Logger logger = LoggerFactory.getLogger(LoggerTestCase.class);
+
+        final RuntimeException e = new RuntimeException("Test exception");
+        final String testMsg = "This is a test message";
+        logger.info(testMsg, e);
+        LogRecord record = HANDLER.messages.poll();
+        Assert.assertNotNull(record);
+        Assert.assertEquals(testMsg, record.getMessage());
+        Assert.assertEquals("Cause is different from the expected cause", e, record.getThrown());
+
+        // Test format with the last parameter being the throwable which should set be set on the record
+        logger.info("This is a test formatted {}", "{message}", e);
+        record = HANDLER.messages.poll();
+        Assert.assertNotNull(record);
+        Assert.assertEquals("This is a test formatted {message}", record.getMessage());
+        Assert.assertEquals("Cause is different from the expected cause", e, record.getThrown());
+
+    }
+
+    @Test
+    public void testMDC() {
+        Assert.assertSame(expectedTypeMessage(Slf4jMDCAdapter.class, MDC.getMDCAdapter().getClass()), MDC.getMDCAdapter().getClass(), Slf4jMDCAdapter.class);
+        final String key = Long.toHexString(System.currentTimeMillis());
+        MDC.put(key, "value");
+        Assert.assertEquals("MDC value should be \"value\"", "value", MDC.get(key));
+        Assert.assertEquals("MDC value should be \"value\"", "value", org.jboss.logmanager.MDC.get(key));
+    }
+
+    private static String expectedTypeMessage(final Class<?> expected, final Class<?> found) {
+        return String.format("Expected type %s but found type %s", expected.getName(), found.getName());
+    }
+
+    private static class QueueHandler extends ExtHandler {
+        final BlockingDeque<ExtLogRecord> messages = new LinkedBlockingDeque<>();
+
+        @Override
+        protected void doPublish(final ExtLogRecord record) {
+            messages.add(record);
+        }
+
+        @Override
+        public void flush() {
+        }
+
+        @Override
+        public void close() throws SecurityException {
+            messages.clear();
+            setLevel(Level.ALL);
+        }
+    }
+}