/*
 * 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;

import junit.framework.TestCase;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;

import org.junit.Test;

import static org.apache.log4j.TestConstants.TEST_WITNESS_PREFIX;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.apache.log4j.TestConstants.TEST_INPUT_PREFIX;
import static org.apache.log4j.TestConstants.TARGET_OUTPUT_PREFIX;

/**
 * Test of RollingFileAppender.
 *
 * @author Curt Arnold
 */
public class RFATestCase {

    public void tearDown() {
        LogManager.resetConfiguration();
    }

    /**
     * Test basic rolling functionality using property file configuration.
     */
    @Test
    public void test1() throws Exception {
        Logger logger = Logger.getLogger(RFATestCase.class);
        PropertyConfigurator.configure(TEST_INPUT_PREFIX + "RFA1.properties");

        // Write exactly 10 bytes with each log
        for (int i = 0; i < 25; i++) {
            if (i < 10) {
                logger.debug("Hello---" + i);
            } else if (i < 100) {
                logger.debug("Hello--" + i);
            }
        }

        assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-test1.log").exists());
        assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-test1.log.1").exists());
    }

    /**
     * Test basic rolling functionality using API configuration.
     */
    @Test
    public void test2() throws Exception {
        Logger logger = Logger.getLogger(RFATestCase.class);
        Logger root = Logger.getRootLogger();
        PatternLayout layout = new PatternLayout("%m\n");
        org.apache.log4j.RollingFileAppender rfa = new org.apache.log4j.RollingFileAppender();
        rfa.setName("ROLLING");
        rfa.setLayout(layout);
        rfa.setAppend(false);
        rfa.setMaxBackupIndex(3);
        rfa.setMaximumFileSize(100);
        rfa.setFile(TARGET_OUTPUT_PREFIX + "RFA-test2.log");
        rfa.activateOptions();
        root.addAppender(rfa);

        // Write exactly 10 bytes with each log
        for (int i = 0; i < 55; i++) {
            if (i < 10) {
                logger.debug("Hello---" + i);
            } else if (i < 100) {
                logger.debug("Hello--" + i);
            }
        }

        assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-test2.log").exists());
        assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-test2.log.1").exists());
        assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-test2.log.2").exists());
        assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-test2.log.3").exists());
        assertFalse(new File(TARGET_OUTPUT_PREFIX + "RFA-test2.log.4").exists());
    }

    /**
     * Tests 2 parameter constructor.
     *
     * @throws IOException if IOException during test.
     */
    @Test
    public void test2ParamConstructor() throws IOException {
        SimpleLayout layout = new SimpleLayout();
        RollingFileAppender appender = new RollingFileAppender(layout, TARGET_OUTPUT_PREFIX + "rfa_2param.log");
        assertEquals(1, appender.getMaxBackupIndex());
        assertEquals(10 * 1024 * 1024, appender.getMaximumFileSize());
    }

    /**
     * Tests 3 parameter constructor.
     *
     * @throws IOException if IOException during test.
     */
    @Test
    public void test3ParamConstructor() throws IOException {
        SimpleLayout layout = new SimpleLayout();
        RollingFileAppender appender = new RollingFileAppender(layout, TARGET_OUTPUT_PREFIX + "rfa_3param.log", false);
        assertEquals(1, appender.getMaxBackupIndex());
    }

    /**
     * Test locking of .1 file.
     */
    @Test
    public void testLockDotOne() throws Exception {
        Logger logger = Logger.getLogger(RFATestCase.class);
        Logger root = Logger.getRootLogger();
        PatternLayout layout = new PatternLayout("%m\n");
        org.apache.log4j.RollingFileAppender rfa = new org.apache.log4j.RollingFileAppender();
        rfa.setName("ROLLING");
        rfa.setLayout(layout);
        rfa.setAppend(false);
        rfa.setMaxBackupIndex(10);
        rfa.setMaximumFileSize(100);
        rfa.setFile(TARGET_OUTPUT_PREFIX + "RFA-dot1.log");
        rfa.activateOptions();
        root.addAppender(rfa);

        new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.2").delete();

        FileWriter dot1 = new FileWriter(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.1");
        dot1.write("Locked file");
        FileWriter dot5 = new FileWriter(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.5");
        dot5.write("Unlocked file");
        dot5.close();

        // Write exactly 10 bytes with each log
        for (int i = 0; i < 15; i++) {
            if (i < 10) {
                logger.debug("Hello---" + i);
            } else if (i < 100) {
                logger.debug("Hello--" + i);
            }
        }
        dot1.close();

        for (int i = 15; i < 25; i++) {
            logger.debug("Hello--" + i);
        }
        rfa.close();

        assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.7").exists());
        //
        // if .2 is the locked file then
        // renaming wasn't successful until the file was closed
        if (new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.2").length() < 15) {
            assertEquals(50, new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log").length());
            assertEquals(200, new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.1").length());
        } else {
            assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log").exists());
            assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.1").exists());
            assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.2").exists());
            assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.3").exists());
            assertFalse(new File(TARGET_OUTPUT_PREFIX + "RFA-dot1.log.4").exists());
        }
    }

    /**
     * Test locking of .3 file.
     */
    @Test
    public void testLockDotThree() throws Exception {
        Logger logger = Logger.getLogger(RFATestCase.class);
        Logger root = Logger.getRootLogger();
        PatternLayout layout = new PatternLayout("%m\n");
        org.apache.log4j.RollingFileAppender rfa = new org.apache.log4j.RollingFileAppender();
        rfa.setName("ROLLING");
        rfa.setLayout(layout);
        rfa.setAppend(false);
        rfa.setMaxBackupIndex(10);
        rfa.setMaximumFileSize(100);
        rfa.setFile(TARGET_OUTPUT_PREFIX + "RFA-dot3.log");
        rfa.activateOptions();
        root.addAppender(rfa);

        new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.1").delete();
        new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.2").delete();
        new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.4").delete();

        FileWriter dot3 = new FileWriter(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.3");
        dot3.write("Locked file");
        FileWriter dot5 = new FileWriter(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.5");
        dot5.write("Unlocked file");
        dot5.close();

        // Write exactly 10 bytes with each log
        for (int i = 0; i < 15; i++) {
            if (i < 10) {
                logger.debug("Hello---" + i);
            } else if (i < 100) {
                logger.debug("Hello--" + i);
            }
        }
        dot3.close();

        for (int i = 15; i < 35; i++) {
            logger.debug("Hello--" + i);
        }
        rfa.close();

        assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.8").exists());
        //
        // if .3 is the locked file then
        // renaming wasn't successful until file was closed
        if (new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.5").exists()) {
            assertEquals(50, new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log").length());
            assertEquals(100, new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.1").length());
            assertEquals(200, new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.2").length());
        } else {
            assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log").exists());
            assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.1").exists());
            assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.2").exists());
            assertTrue(new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.3").exists());
            assertFalse(new File(TARGET_OUTPUT_PREFIX + "RFA-dot3.log.4").exists());
        }
    }

}
