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

import java.lang.reflect.Field;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;

import org.junit.Assert;
import org.junit.Test;

public class TestDateFormatCache {

    // Note that there is a similar test:
    // org.apache.catalina.valves.TestAccessLogValve.testBug54044()
    @Test
    public void testBug54044() throws Exception {

        final String timeFormat = "dd-MMM-yyyy HH:mm:ss";
        final int cacheSize = 10;

        SimpleDateFormat sdf = new SimpleDateFormat(timeFormat, Locale.US);
        sdf.setTimeZone(TimeZone.getDefault());

        DateFormatCache dfc = new DateFormatCache(cacheSize, timeFormat, null);

        // Get dfc.cache.cache field
        Object dfcCache;
        Field dfcCacheArray;
        Field dfcCacheField = dfc.getClass().getDeclaredField("cache");
        dfcCacheField.setAccessible(true);
        dfcCache = dfcCacheField.get(dfc);
        dfcCacheArray = dfcCache.getClass().getDeclaredField("cache");
        dfcCacheArray.setAccessible(true);

        // Create an array to hold the expected values
        String[] expected = new String[cacheSize];

        // Fill the cache & populate the expected values
        for (int secs = 0; secs < (cacheSize); secs++) {
            dfc.getFormat(secs * 1000);
            expected[secs] = generateExpected(sdf, secs);
        }
        Assert.assertArrayEquals(expected, (String[]) dfcCacheArray.get(dfcCache));

        // Cause the cache to roll-around by one and then confirm
        dfc.getFormat(cacheSize * 1000);
        expected[0] = generateExpected(sdf, cacheSize);
        Assert.assertArrayEquals(expected, (String[]) dfcCacheArray.get(dfcCache));

        // Jump 2 ahead and then confirm (skipped value should be null)
        dfc.getFormat((cacheSize + 2) * 1000);
        expected[1] = null;
        expected[2] = generateExpected(sdf, cacheSize + 2);
        Assert.assertArrayEquals(expected, (String[]) dfcCacheArray.get(dfcCache));

        // Back 1 to fill in the gap
        dfc.getFormat((cacheSize + 1) * 1000);
        expected[1] = generateExpected(sdf, cacheSize + 1);
        Assert.assertArrayEquals(expected, (String[]) dfcCacheArray.get(dfcCache));

        // Return to 1 and confirm skipped value is null
        dfc.getFormat(1 * 1000);
        expected[1] = generateExpected(sdf, 1);
        expected[2] = null;
        Assert.assertArrayEquals(expected, (String[]) dfcCacheArray.get(dfcCache));

        // Go back one further
        dfc.getFormat(0);
        expected[0] = generateExpected(sdf, 0);
        Assert.assertArrayEquals(expected, (String[]) dfcCacheArray.get(dfcCache));

        // Jump ahead far enough that the entire cache will need to be cleared
        dfc.getFormat(42 * 1000);
        for (int i = 0; i < cacheSize; i++) {
            expected[i] = null;
        }
        expected[0] = generateExpected(sdf, 42);
        Assert.assertArrayEquals(expected, (String[]) dfcCacheArray.get(dfcCache));
    }

    private String generateExpected(SimpleDateFormat sdf, long secs) {
        return sdf.format(new Date(secs * 1000));
    }

    @Test
    public void replacesUnquotedS() {
        Assert.assertEquals("HH:mm:ss.###", DateFormatCache.tidyFormat("HH:mm:ss.SSS"));
    }

    @Test
    public void doesNotReplaceQuotedS() {
        Assert.assertEquals("HH:mm:ss.'SSS'", DateFormatCache.tidyFormat("HH:mm:ss.'SSS'"));
    }

    @Test
    public void handlesEscapedQuoteInsideLiteral() {
        Assert.assertEquals("'o''clock' ###", DateFormatCache.tidyFormat("'o''clock' SSS"));
    }

    @Test
    public void doesNotReplaceSInsideLiteralAfterEscapedQuote() {
        Assert.assertEquals("'abc''SSS'", DateFormatCache.tidyFormat("'abc''SSS'"));
    }

    @Test
    public void handlesMultipleLiteralSections() {
        Assert.assertEquals("'foo' ### 'bar'", DateFormatCache.tidyFormat("'foo' SSS 'bar'"));
    }

    @Test
    public void handlesEscapedQuoteOutsideLiteral() {
        Assert.assertEquals("'' ###", DateFormatCache.tidyFormat("'' SSS"));
    }

    @Test
    public void complexQuoteScenario() {
        Assert.assertEquals("'Start' ### 'o''clock' ### '' 'End'",
                DateFormatCache.tidyFormat("'Start' SSS 'o''clock' SSS '' 'End'"));
    }
}
