src/test/java/org/apache/log4j/rolling/RenamingTest.java

/*
 * 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.log4j.rolling;

import junit.framework.TestCase;
import org.apache.log4j.ConsoleAppender;
import org.apache.log4j.Logger;
import org.apache.log4j.PatternLayout;
import org.apache.log4j.util.Compare;

import java.io.File;
import java.text.SimpleDateFormat;
import java.util.Calendar;


/**
 * 
 * This test case aims to unit test/reproduce problems encountered while
 * renaming the log file under windows.
 * 
 * @author Ceki
 *
 */
public class RenamingTest extends TestCase {
  Logger logger = Logger.getLogger(RenamingTest.class);
  
  Logger root;
  PatternLayout layout;
  
  public RenamingTest(String arg0) {
    super(arg0);
  }

  protected void setUp() throws Exception {
    super.setUp();
    root = Logger.getRootLogger();
    layout = new PatternLayout("%c{1} - %m%n");
    root.addAppender(new ConsoleAppender(new PatternLayout()));
    
  }

  protected void tearDown() throws Exception {
    super.tearDown();
  }

  public void testRename() throws Exception {
  
    RollingFileAppender rfa = new RollingFileAppender();
    rfa.setLayout(layout);
    rfa.setAppend(false);

    // rollover by the second
    String datePattern = "yyyy-MM-dd_HH_mm_ss";
    SimpleDateFormat sdf = new SimpleDateFormat(datePattern);

    TimeBasedRollingPolicy tbrp = new TimeBasedRollingPolicy();
    tbrp.setFileNamePattern("target/test-%d{" + datePattern + "}");
    rfa.setFile("target/test.log");
    tbrp.activateOptions();
    rfa.setRollingPolicy(tbrp);
    rfa.activateOptions();

    Calendar cal = Calendar.getInstance();

    root.addAppender(rfa);
    logger.debug("Hello   " + 0);
    Thread.sleep(5000);
    logger.debug("Hello   " + 1);
    
    String rolledFile = "target/test-" + sdf.format(cal.getTime());

    //
    //   if the rolled file exists
    //       either the test wasn't run from the Ant script
    //            which opens test.log in another process or
    //              the test is running on a platform that allows open files to be renamed
    if (new File(rolledFile).exists()) {
        assertTrue(Compare.compare(RenamingTest.class,
                rolledFile, "witness/rolling/renaming.0"));
        assertTrue(Compare.compare(RenamingTest.class,
                "target/test.log", "witness/rolling/renaming.1"));
    } else {
        //
        //   otherwise the rollover should have been blocked
        //
        assertTrue(Compare.compare(RenamingTest.class,
                "target/test.log", "witness/rolling/renaming.2"));
    }
  }
}