/*
    * 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.commons.logging.simple;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import junit.framework.Test;
  
  import org.apache.commons.logging.DummyException;
  import org.apache.commons.logging.LogFactory;
  import org.apache.commons.logging.PathableClassLoader;
  import org.apache.commons.logging.PathableTestSuite;
  import org.apache.commons.logging.impl.SimpleLog;
  
  /**
   * <p>TestCase for simple logging when running with custom configuration
   * properties.</p>
   */
  public class CustomConfigTestCase extends DefaultConfigTestCase {
  
      /**
       * Return the tests included in this test suite.
       * <p>
       * We need to use a PathableClassLoader here because the SimpleLog class
       * is a pile of junk and chock-full of static variables. Any other test
       * (like simple.CustomConfigTestCase) that has used the SimpleLog class
       * will already have caused it to do once-only initialization that we
       * can't reset, even by calling LogFactory.releaseAll, because of those
       * ugly statics. The only clean solution is to load a clean copy of
       * commons-logging including SimpleLog via a nice clean class loader.
       * Or we could fix SimpleLog to be sane...
       */
      public static Test suite() throws Exception {
          final Class<CustomConfigTestCase> thisClass = CustomConfigTestCase.class;
  
          final PathableClassLoader loader = new PathableClassLoader(null);
          loader.useExplicitLoader("junit.", Test.class.getClassLoader());
          loader.addLogicalLib("testclasses");
          loader.addLogicalLib("commons-logging");
  
          final Class<?> testClass = loader.loadClass(thisClass.getName());
          return new PathableTestSuite(testClass, loader);
      }
  
      /**
       * <p>The message levels that should have been logged.</p>
       */
      /*
      protected Level[] testLevels =
      { Level.FINE, Level.INFO, Level.WARNING, Level.SEVERE, Level.SEVERE };
      */
  
      /**
       * <p>The expected log records.</p>
       */
      protected List<LogRecord> expected;
  
      /**
       * <p>The message strings that should have been logged.</p>
       */
      protected String[] testMessages =
      { "debug", "info", "warn", "error", "fatal" };
  
      // Check the decorated log instance
      @Override
      protected void checkDecorated() {
  
          assertNotNull("Log exists", log);
          assertEquals("Log class",
                       "org.apache.commons.logging.simple.DecoratedSimpleLog",
                       log.getClass().getName());
  
          // Can we call level checkers with no exceptions?
          assertTrue(log.isDebugEnabled());
          assertTrue(log.isErrorEnabled());
          assertTrue(log.isFatalEnabled());
          assertTrue(log.isInfoEnabled());
          assertFalse(log.isTraceEnabled());
          assertTrue(log.isWarnEnabled());
  
          // Can we retrieve the current log level?
          assertEquals(SimpleLog.LOG_LEVEL_DEBUG, ((SimpleLog) log).getLevel());
  
         // Can we validate the extra exposed properties?
         checkDecoratedDateTime();
         assertEquals("DecoratedLogger",
                      ((DecoratedSimpleLog) log).getLogName());
         checkShowDateTime();
         assertTrue(((DecoratedSimpleLog) log).getShowShortName());
 
     }
 
     /** Hook for subclasses */
     protected void checkDecoratedDateTime() {
         assertEquals("yyyy/MM/dd HH:mm:ss:SSS zzz", ((DecoratedSimpleLog) log).getDateTimeFormat());
     }
 
     // Check the actual log records against the expected ones
     protected void checkExpected() {
         final List<LogRecord> acts = ((DecoratedSimpleLog) log).getCache();
         int n = 0;
         for (final LogRecord exp : expected) {
             final LogRecord act = acts.get(n++);
             assertEquals("Row " + n + " type", exp.type, act.type);
             assertEquals("Row " + n + " message", exp.message, act.message);
             assertEquals("Row " + n + " throwable", exp.t, act.t);
         }
     }
 
     /** Hook for subclassses */
     protected void checkShowDateTime() {
         assertFalse(((DecoratedSimpleLog) log).getShowDateTime());
     }
 
     // Check the standard log instance
     @Override
     protected void checkStandard() {
         checkDecorated();
     }
 
     // Log the messages with exceptions
     protected void logExceptionMessages() {
         // Generate log records
         final Throwable t = new DummyException();
         log.trace("trace", t); // Should not actually get logged
         log.debug("debug", t);
         log.info("info", t);
         log.warn("warn", t);
         log.error("error", t);
         log.fatal("fatal", t);
 
         // Record the log records we expect
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_DEBUG, "debug", t));
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_INFO, "info", t));
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_WARN, "warn", t));
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_ERROR, "error", t));
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_FATAL, "fatal", t));
     }
 
     // Log the plain messages
     protected void logPlainMessages() {
         // Generate log records
         log.trace("trace"); // Should not actually get logged
         log.debug("debug");
         log.info("info");
         log.warn("warn");
         log.error("error");
         log.fatal("fatal");
 
         // Record the log records we expect
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_DEBUG, "debug", null));
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_INFO, "info", null));
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_WARN, "warn", null));
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_ERROR, "error", null));
         expected.add(new LogRecord(SimpleLog.LOG_LEVEL_FATAL, "fatal", null));
     }
 
     /**
      * Sets system properties that will control the LogFactory/Log objects
      * when they are created. Subclasses can override this method to
      * define properties that suit them.
      */
     @Override
     public void setProperties() {
         System.setProperty(
             "org.apache.commons.logging.Log",
             "org.apache.commons.logging.simple.DecoratedSimpleLog");
         System.setProperty(
             "org.apache.commons.logging.simplelog.defaultlog",
             "debug");
     }
 
     /**
      * Sets up instance variables required by this test case.
      */
     @Override
     public void setUp() throws Exception {
         LogFactory.releaseAll();
         setProperties();
         expected = new ArrayList<>();
         setUpFactory();
         setUpLog("DecoratedLogger");
     }
 
     /**
      * Tear down instance variables required by this test case.
      */
     @Override
     public void tearDown() {
         super.tearDown();
         expected = null;
     }
 
     // Test logging message strings with exceptions
     public void testExceptionMessages() throws Exception {
         ((DecoratedSimpleLog) log).clearCache();
         logExceptionMessages();
         checkExpected();
     }
 
     // Test logging plain message strings
     public void testPlainMessages() throws Exception {
         ((DecoratedSimpleLog) log).clearCache();
         logPlainMessages();
         checkExpected();
     }
 
     // Test Serializability of standard instance
     @Override
     public void testSerializable() throws Exception {
         ((DecoratedSimpleLog) log).clearCache();
         logPlainMessages();
         super.testSerializable();
         logExceptionMessages();
         checkExpected();
     }
 }