aboutsummaryrefslogtreecommitdiffstats
path: root/jdisc_core/src/test/java/com/yahoo/jdisc/core/OsgiLogHandlerTestCase.java
blob: 18add8109f0169169f00a54e14a48f6c08993e6b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc.core;

import org.junit.jupiter.api.Test;
import org.osgi.framework.Bundle;
import org.osgi.framework.ServiceReference;
import org.osgi.service.log.LogLevel;
import org.osgi.service.log.LogService;

import java.time.Instant;
import java.util.Enumeration;
import java.util.ResourceBundle;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;

import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;

/**
 * @author Simon Thoresen Hult
 */
public class OsgiLogHandlerTestCase {

    @Test
    void requireThatLogRecordsArePublishedToLogService() {
        MyLogService logService = new MyLogService();
        Logger log = newLogger(logService);

        log.log(Level.INFO, "foo");
        assertEquals(OsgiLogHandler.toServiceLevel(Level.INFO), logService.lastLevel());
        assertEquals("foo", logService.lastMessage);
        assertNull(logService.lastThrowable);

        Throwable t = new Throwable();
        log.log(Level.SEVERE, "bar", t);
        assertEquals(OsgiLogHandler.toServiceLevel(Level.SEVERE), logService.lastLevel());
        assertEquals("bar", logService.lastMessage);
        assertEquals(t, logService.lastThrowable);
    }

    @Test
    void requireThatStadardLogLevelsAreConverted() {
        assertLogLevel(LogLevel.ERROR, Level.SEVERE);
        assertLogLevel(LogLevel.WARN, Level.WARNING);
        assertLogLevel(LogLevel.INFO, Level.INFO);
        assertLogLevel(LogLevel.DEBUG, Level.CONFIG);
        assertLogLevel(LogLevel.DEBUG, Level.FINE);
        assertLogLevel(LogLevel.DEBUG, Level.FINER);
        assertLogLevel(LogLevel.DEBUG, Level.FINEST);
    }

    @Test
    void requireThatCustomLogLevelsAreConverted() {
        for (int i = Level.ALL.intValue() - 69; i < Level.OFF.intValue() + 69; ++i) {
            LogLevel expectedLevel;
            if (i >= Level.SEVERE.intValue()) {
                expectedLevel = LogLevel.ERROR;
            } else if (i >= Level.WARNING.intValue()) {
                expectedLevel = LogLevel.WARN;
            } else if (i >= Level.INFO.intValue()) {
                expectedLevel = LogLevel.INFO;
            } else {
                expectedLevel = LogLevel.DEBUG;
            }
            assertLogLevel(expectedLevel, new MyLogLevel(i));
        }
    }

    @Test
    void requireThatJdk14PropertiesAreAvailableThroughServiceReference() {
        MyLogService logService = new MyLogService();

        Logger log = newLogger(logService);
        LogRecord record = new LogRecord(Level.INFO, "message");
        record.setLoggerName("loggerName");
        record.setInstant(Instant.ofEpochMilli(69));
        Object[] parameters = new Object[0];
        record.setParameters(parameters);
        ResourceBundle resouceBundle = new MyResourceBundle();
        record.setResourceBundle(resouceBundle);
        record.setResourceBundleName("resourceBundleName");
        record.setSequenceNumber(69);
        record.setSourceClassName("sourceClassName");
        record.setSourceMethodName("sourceMethodName");
        record.setLongThreadID(69L);
        Throwable thrown = new Throwable();
        record.setThrown(thrown);
        log.log(record);

        ServiceReference<?> ref = logService.lastServiceReference;
        assertNotNull(ref);
        assertArrayEquals(new String[]{"LEVEL",
                "LOGGER_NAME",
                "MESSAGE",
                "MILLIS",
                "PARAMETERS",
                "RESOURCE_BUNDLE",
                "RESOURCE_BUNDLE_NAME",
                "SEQUENCE_NUMBER",
                "SOURCE_CLASS_NAME",
                "SOURCE_METHOD_NAME",
                "THREAD_ID",
                "THROWN"},
                ref.getPropertyKeys());
        assertEquals(Level.INFO, ref.getProperty("LEVEL"));
        assertEquals("loggerName", ref.getProperty("LOGGER_NAME"));
        assertEquals("message", ref.getProperty("MESSAGE"));
        assertEquals(69L, ref.getProperty("MILLIS"));
        assertSame(parameters, ref.getProperty("PARAMETERS"));
        assertSame(resouceBundle, ref.getProperty("RESOURCE_BUNDLE"));
        assertEquals("resourceBundleName", ref.getProperty("RESOURCE_BUNDLE_NAME"));
        assertEquals(69L, ref.getProperty("SEQUENCE_NUMBER"));
        assertEquals("sourceClassName", ref.getProperty("SOURCE_CLASS_NAME"));
        assertEquals("sourceMethodName", ref.getProperty("SOURCE_METHOD_NAME"));
        assertEquals(69L, ref.getProperty("THREAD_ID"));
        assertSame(thrown, ref.getProperty("THROWN"));
        assertNull(ref.getProperty("unknown"));
    }

    private static void assertLogLevel(LogLevel expectedLevel, Level level) {
        MyLogService logService = new MyLogService();
        Logger log = newLogger(logService);
        log.log(level, "message");
        assertEquals(expectedLevel, logService.lastLevel());
    }

    @SuppressWarnings("unchecked")
    private static Logger newLogger(LogService logService) {
        Logger log = Logger.getAnonymousLogger();
        log.setUseParentHandlers(false);
        log.setLevel(Level.ALL);
        for (Handler handler : log.getHandlers()) {
            log.removeHandler(handler);
        }
        log.addHandler(new OsgiLogHandler(logService));
        return log;
    }

    private static class MyLogLevel extends Level {

        protected MyLogLevel(int val) {
            super("foo", val);
        }
    }

    @SuppressWarnings("rawtypes")
    private static class MyLogService implements LogService {

        ServiceReference<?> lastServiceReference;
        int lastLevel;
        String lastMessage;
        Throwable lastThrowable;

        LogLevel lastLevel() { return LogLevel.values()[lastLevel]; }

        @Override @SuppressWarnings("deprecation")
        public void log(int level, String message) {
            log(null, level, message, null);
        }

        @Override @SuppressWarnings("deprecation")
        public void log(int level, String message, Throwable throwable) {
            log(null, level, message, throwable);
        }

        @Override @SuppressWarnings("deprecation")
        public void log(ServiceReference serviceReference, int level, String message) {
            log(serviceReference, level, message, null);
        }

        @Override @SuppressWarnings("deprecation")
        public void log(ServiceReference serviceReference, int level, String message, Throwable throwable) {
            lastServiceReference = serviceReference;
            lastLevel = level;
            lastMessage = message;
            lastThrowable = throwable;
        }

        @Override public org.osgi.service.log.Logger getLogger(String s) { return null; }
        @Override public org.osgi.service.log.Logger getLogger(Class<?> aClass) { return null; }
        @Override public <L extends org.osgi.service.log.Logger> L getLogger(String s, Class<L> aClass) { return null; }
        @Override public <L extends org.osgi.service.log.Logger> L getLogger(Class<?> aClass, Class<L> aClass1) { return null; }
        @Override public <L extends org.osgi.service.log.Logger> L getLogger(Bundle bundle, String s, Class<L> aClass) { return null; }
    }

    private static class MyResourceBundle extends ResourceBundle {

        @Override
        protected Object handleGetObject(String key) {
            return null;
        }

        @Override
        public Enumeration<String> getKeys() {
            return null;
        }
    }
}