2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.config.yang.logback.config;
10 import static org.junit.Assert.assertEquals;
13 import java.io.IOException;
14 import java.lang.management.ManagementFactory;
15 import java.util.ArrayList;
16 import java.util.Arrays;
17 import java.util.List;
19 import javax.management.InstanceAlreadyExistsException;
20 import javax.management.InstanceNotFoundException;
21 import javax.management.JMX;
22 import javax.management.MalformedObjectNameException;
23 import javax.management.ObjectName;
25 import org.apache.commons.io.FileUtils;
26 import org.junit.Before;
27 import org.junit.Test;
28 import org.opendaylight.controller.config.api.jmx.ObjectNameUtil;
29 import org.opendaylight.controller.config.manager.impl.AbstractConfigTest;
30 import org.opendaylight.controller.config.manager.impl.factoriesresolver.HardcodedModuleFactoriesResolver;
31 import org.opendaylight.controller.config.util.ConfigTransactionClient;
32 import org.opendaylight.controller.config.util.ConfigTransactionJMXClient;
33 import org.slf4j.LoggerFactory;
35 import ch.qos.logback.classic.LoggerContext;
36 import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
37 import ch.qos.logback.classic.joran.JoranConfigurator;
38 import ch.qos.logback.classic.spi.ILoggingEvent;
39 import ch.qos.logback.core.joran.spi.JoranException;
40 import ch.qos.logback.core.rolling.FixedWindowRollingPolicy;
41 import ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy;
43 import com.google.common.collect.Lists;
45 public class LogbackModuleWithInitialConfigurationTest extends AbstractConfigTest {
47 private LogbackModuleFactory factory;
50 public void setUp() throws IOException, ClassNotFoundException {
52 factory = new LogbackModuleFactory();
53 super.initConfigTransactionManagerImpl(new HardcodedModuleFactoriesResolver(factory));
57 * Tests that initial configuration was changed. Changed attributes:
58 * location, fileName, duplicateInsertTries. Added new FileAppender.
61 public void test() throws Exception {
65 ConfigTransactionClient transaction = configRegistryClient.createTransaction();
67 LogbackModuleMXBean bean = JMX.newMXBeanProxy(ManagementFactory.getPlatformMBeanServer(),
68 transaction.lookupConfigBean("logback", "singleton"), LogbackModuleMXBean.class);
69 assertEquals(1, bean.getConsoleAppenderTO().size());
70 assertEquals(1, bean.getRollingFileAppenderTO().size());
71 assertEquals(0, bean.getFileAppenderTO().size());
72 assertEquals(1, bean.getLoggerTO().size());
74 RollingFileAppenderTO rolling = new RollingFileAppenderTO();
75 RollingFileAppenderTO old = bean.getRollingFileAppenderTO().get(0);
76 rolling.setAppend(old.getAppend());
77 rolling.setEncoderPattern(old.getEncoderPattern());
78 rolling.setRollingPolicyType(old.getRollingPolicyType());
79 rolling.setFileName("target/logFile1.log");
80 rolling.setFileNamePattern("target/%i.log");
81 rolling.setMaxFileSize(old.getMaxFileSize());
82 rolling.setMinIndex(old.getMinIndex());
83 rolling.setMaxIndex(old.getMaxIndex());
84 rolling.setName("FILE");
86 ConsoleAppenderTO console = new ConsoleAppenderTO();
87 console.setEncoderPattern("%date %level [%thread] %logger{10} %msg%n");
88 console.setName("SYSTEM");
89 console.setThresholdFilter("DEBUG");
91 FileAppenderTO file = new FileAppenderTO();
92 file.setName("FILE_APPENDER");
94 file.setEncoderPattern("%-4relative [%thread] %-5level %logger{35} - %msg%n");
95 file.setFileName("target/testFile.log");
97 bean.setConsoleAppenderTO(Lists.newArrayList(console));
98 bean.setRollingFileAppenderTO(Lists.newArrayList(rolling));
99 bean.setFileAppenderTO(Lists.newArrayList(file));
101 LoggerTO logger = new LoggerTO();
102 logger.setLevel("INFO");
103 logger.setLoggerName("logger");
104 logger.setAppenders(Lists.newArrayList("SYSTEM"));
106 LoggerTO fileLogger = new LoggerTO();
107 fileLogger.setLevel("DEBUG");
108 fileLogger.setLoggerName("fileLogger");
109 fileLogger.setAppenders(Lists.newArrayList("FILE_APPENDER"));
111 List<LoggerTO> loggers = Lists.newArrayList(logger, fileLogger);
112 bean.setLoggerTO(loggers);
114 transaction.commit();
116 LogbackModuleMXBean logback = configRegistryClient.newMXBeanProxy(
117 ObjectNameUtil.createReadOnlyModuleON("logback", "singleton"), LogbackModuleMXBean.class);
119 List<RollingFileAppenderTO> rollingList = logback.getRollingFileAppenderTO();
120 assertEquals(1, rollingList.size());
122 RollingFileAppenderTO rollingApp = rollingList.get(0);
123 assertEquals(rollingApp.getFileName(), "target/logFile1.log");
124 assertEquals(rollingApp.getName(), "FILE");
126 List<ConsoleAppenderTO> consoleList = logback.getConsoleAppenderTO();
127 assertEquals(1, consoleList.size());
129 ConsoleAppenderTO consoleApp = consoleList.get(0);
130 assertEquals(consoleApp.getThresholdFilter(), "DEBUG");
131 assertEquals(consoleApp.getName(), "SYSTEM");
133 List<FileAppenderTO> fileList = logback.getFileAppenderTO();
134 assertEquals(1, fileList.size());
136 FileAppenderTO fileApp = fileList.get(0);
137 assertEquals(fileApp.getFileName(), "target/testFile.log");
138 assertEquals(fileApp.getName(), "FILE_APPENDER");
140 loggers = logback.getLoggerTO();
141 assertEquals(2, loggers.size());
142 assertEquals("logger", loggers.get(0).getLoggerName());
143 assertEquals("fileLogger", loggers.get(1).getLoggerName());
147 public ObjectName createBeans() throws JoranException, InstanceAlreadyExistsException, IOException,
148 MalformedObjectNameException, InstanceNotFoundException {
150 LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
152 JoranConfigurator configurator = new JoranConfigurator();
153 configurator.setContext(lc);
154 configurator.doConfigure("src/test/resources/simple_config_logback.xml");
155 File f = new File("target/it");
157 FileUtils.cleanDirectory(f);
158 ch.qos.logback.classic.Logger logger = lc.getLogger(ch.qos.logback.classic.Logger.ROOT_LOGGER_NAME);
159 ch.qos.logback.core.rolling.RollingFileAppender<ILoggingEvent> fileAppender = (ch.qos.logback.core.rolling.RollingFileAppender<ILoggingEvent>) logger
160 .getAppender("VARLOGFILE");
161 fileAppender.start();
163 ch.qos.logback.core.ConsoleAppender<ILoggingEvent> consoleAppender = (ch.qos.logback.core.ConsoleAppender<ILoggingEvent>) logger
164 .getAppender("STDOUT");
165 consoleAppender.start();
166 List<RollingFileAppenderTO> rollingAppenders = new ArrayList<>();
167 RollingFileAppenderTO rollingApp = new RollingFileAppenderTO();
168 rollingApp.setAppend(fileAppender.isAppend());
169 PatternLayoutEncoder enc = (PatternLayoutEncoder) fileAppender.getEncoder();
170 rollingApp.setEncoderPattern(enc.getPattern());
171 rollingApp.setFileName(fileAppender.getFile());
172 FixedWindowRollingPolicy rollingPolicy = (FixedWindowRollingPolicy) fileAppender.getRollingPolicy();
173 rollingApp.setRollingPolicyType("FixedWindowRollingPolicy");
174 rollingApp.setMaxIndex(rollingPolicy.getMaxIndex());
175 rollingApp.setMinIndex(rollingPolicy.getMinIndex());
176 SizeBasedTriggeringPolicy<ILoggingEvent> triggeringPolicy = (SizeBasedTriggeringPolicy<ILoggingEvent>) fileAppender
177 .getTriggeringPolicy();
178 rollingApp.setMaxFileSize(triggeringPolicy.getMaxFileSize());
179 rollingApp.setName(fileAppender.getName());
180 rollingApp.setFileNamePattern(rollingPolicy.getFileNamePattern());
181 rollingAppenders.add(rollingApp);
183 assertEquals(rollingApp.getFileName(), "target/osgi.log");
184 assertEquals(rollingApp.getMaxFileSize(), "50MB");
185 assertEquals(rollingApp.getName(), "VARLOGFILE");
187 List<ConsoleAppenderTO> consoleAppenders = new ArrayList<>();
188 ConsoleAppenderTO consoleApp = new ConsoleAppenderTO();
189 enc = (PatternLayoutEncoder) consoleAppender.getEncoder();
190 consoleApp.setEncoderPattern(enc.getPattern());
191 consoleApp.setName(consoleAppender.getName());
192 consoleApp.setThresholdFilter("ALL");
193 consoleAppenders.add(consoleApp);
195 List<FileAppenderTO> fileAppenders = new ArrayList<>();
197 List<LoggerTO> loggersDTOs = new ArrayList<>();
198 LoggerTO log = new LoggerTO();
199 log.setAppenders(Arrays.asList(fileAppender.getName(), consoleApp.getName()));
201 log.setLevel(logger.getLevel().toString());
202 log.setLoggerName(logger.getName());
203 loggersDTOs.add(log);
205 ConfigTransactionJMXClient transaction = configRegistryClient.createTransaction();
206 ObjectName nameRetrieved = transaction.lookupConfigBean(factory.getImplementationName(), LogbackModuleFactory.INSTANCE_NAME);
207 LogbackModuleMXBean bean = transaction.newMXBeanProxy(nameRetrieved, LogbackModuleMXBean.class);
209 bean.setLoggerTO(loggersDTOs);
210 bean.setRollingFileAppenderTO(rollingAppenders);
211 bean.setConsoleAppenderTO(consoleAppenders);
212 bean.setFileAppenderTO(fileAppenders);
214 transaction.commit();
216 return nameRetrieved;