/*
    * 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.tccl.log;
  
  import java.net.URL;
  
  import junit.framework.Test;
  import junit.framework.TestCase;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.apache.commons.logging.PathableClassLoader;
  import org.apache.commons.logging.PathableTestSuite;
  
  /**
   * Verify that by default the standard LogFactoryImpl class loads a
   * custom Log implementation via the TCCL.
   */
  
  public class TcclEnabledTestCase extends TestCase {
  
      public static final String MY_LOG_PKG =
          "org.apache.commons.logging.tccl.custom";
  
      public static final String MY_LOG_IMPL =
          MY_LOG_PKG + ".MyLog";
  
      /**
       * Return the tests included in this test suite.
       */
      public static Test suite() throws Exception {
          final Class thisClass = TcclEnabledTestCase.class;
  
          // Determine the URL to this .class file, so that we can then
          // append the priority dirs to it. For tidiness, load this
          // class through a dummy loader though this is not absolutely
          // necessary...
          final PathableClassLoader dummy = new PathableClassLoader(null);
          dummy.useExplicitLoader("junit.", Test.class.getClassLoader());
          dummy.addLogicalLib("testclasses");
          dummy.addLogicalLib("commons-logging");
  
          final String thisClassPath = thisClass.getName().replace('.', '/') + ".class";
          final URL baseUrl = dummy.findResource(thisClassPath);
  
          // Now set up the desired class loader hierarchy. Everything goes into
          // the parent classpath, but we exclude the custom Log class.
          //
          // We then create a tccl class loader that can see the custom
          // Log class. Therefore if that class can be found, then the
          // TCCL must have been used to load it.
          final PathableClassLoader emptyLoader = new PathableClassLoader(null);
  
          final PathableClassLoader parentLoader = new PathableClassLoader(null);
          parentLoader.useExplicitLoader("junit.", Test.class.getClassLoader());
          parentLoader.addLogicalLib("commons-logging");
          parentLoader.addLogicalLib("testclasses");
          // hack to ensure that the test class loader can't see
          // the custom MyLogFactoryImpl
          parentLoader.useExplicitLoader(MY_LOG_PKG + ".", emptyLoader);
  
          final URL propsEnableUrl = new URL(baseUrl, "props_enable_tccl/");
          parentLoader.addURL(propsEnableUrl);
  
          final PathableClassLoader tcclLoader = new PathableClassLoader(parentLoader);
          tcclLoader.addLogicalLib("testclasses");
  
          final Class testClass = parentLoader.loadClass(thisClass.getName());
          return new PathableTestSuite(testClass, tcclLoader);
      }
  
      /**
       * Sets up instance variables required by this test case.
       */
      @Override
      public void setUp() throws Exception {
          LogFactory.releaseAll();
      }
  
      /**
       * Tear down instance variables required by this test case.
       */
      @Override
      public void tearDown() {
         LogFactory.releaseAll();
     }
 
     /**
      * Verify that MyLogFactoryImpl is only loadable via the tccl.
      */
     public void testLoader() throws Exception {
 
         final ClassLoader thisClassLoader = this.getClass().getClassLoader();
         final ClassLoader tcclLoader = Thread.currentThread().getContextClassLoader();
 
         // the tccl loader should NOT be the same as the loader that loaded this test class.
         assertNotSame("tccl not same as test class loader", thisClassLoader, tcclLoader);
 
         // MyLog should not be loadable via parent loader
         try {
             final Class clazz = thisClassLoader.loadClass(MY_LOG_IMPL);
             fail("Unexpectedly able to load MyLog via test class class loader");
             assertNotNull(clazz); // silence warnings about unused var
         } catch (final ClassNotFoundException ex) {
             // ok, expected
         }
 
         // MyLog should be loadable via tccl loader
         try {
             final Class clazz = tcclLoader.loadClass(MY_LOG_IMPL);
             assertNotNull(clazz);
         } catch (final ClassNotFoundException ex) {
             fail("Unexpectedly unable to load MyLog via tccl class loader");
         }
     }
 
     /**
      * Verify that the custom Log implementation which is only accessible
      * via the TCCL has successfully been loaded as specified in the config file.
      * This proves that the TCCL was used to load that class.
      */
     public void testTcclLoading() throws Exception {
         final LogFactory instance = LogFactory.getFactory();
 
         assertEquals(
             "Correct LogFactory loaded",
             "org.apache.commons.logging.impl.LogFactoryImpl",
             instance.getClass().getName());
 
         final Log log = instance.getInstance("test");
         assertEquals(
             "Correct Log loaded",
             MY_LOG_IMPL,
             log.getClass().getName());
     }
 }