geode-core/src/test/java/org/apache/geode/internal/logging/SortLogFileTest.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.geode.internal.logging;

import static org.assertj.core.api.Assertions.assertThat;

import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.Date;
import java.util.Random;

import org.junit.Test;
import org.junit.experimental.categories.Category;

import org.apache.geode.LogWriter;
import org.apache.geode.test.junit.categories.LoggingTest;

/**
 * Unit tests for {@link SortLogFile}.
 *
 * @since GemFire 3.0
 */
@Category(LoggingTest.class)
public class SortLogFileTest {

  /**
   * Generates a "log file" whose entry timestamps are in a random order. Then it sorts the log file
   * and asserts that the entries are sorted order.
   */
  @Test
  public void testRandomLog() throws Exception {
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    PrintWriter printWriter = new PrintWriter(new OutputStreamWriter(baos), true);
    LogWriter logWriter = new RandomLogWriter(printWriter);

    for (int i = 0; i < 100; i++) {
      logWriter.info(String.valueOf(i));
    }

    printWriter.flush();
    printWriter.close();

    byte[] bytes = baos.toByteArray();

    ByteArrayInputStream bais = new ByteArrayInputStream(bytes);

    StringWriter stringWriter = new StringWriter();
    printWriter = new PrintWriter(stringWriter, true);
    SortLogFile.sortLogFile(bais, printWriter);

    String sorted = stringWriter.toString();

    BufferedReader reader = new BufferedReader(new StringReader(sorted));
    LogFileParser parser = new LogFileParser(null, reader);
    String prevTimestamp = null;
    while (parser.hasMoreEntries()) {
      LogFileParser.LogEntry entry = parser.getNextEntry();
      String timestamp = entry.getTimestamp();
      if (prevTimestamp != null) {
        assertThat(prevTimestamp.compareTo(timestamp))
            .as("Prev: " + prevTimestamp + ", current: " + timestamp)
            .isLessThanOrEqualTo(0);
      }
      prevTimestamp = entry.getTimestamp();
    }
  }

  /**
   * A {@code LogWriter} that generates random time stamps.
   */
  private static class RandomLogWriter extends LocalLogWriter {

    /** Used to generate a random date */
    private final Random random = new Random();

    /**
     * Creates a new {@code RandomLogWriter} that logs to the given {@code PrintWriter}.
     */
    private RandomLogWriter(PrintWriter printWriter) {
      super(ALL_LEVEL, printWriter);
    }

    /**
     * Ignores {@code date} and returns the timestamp for a random date.
     */
    @Override
    protected String formatDate(Date date) {
      long time = date.getTime() + random.nextInt(100_000) * 1_000;
      date = new Date(time);
      return super.formatDate(date);
    }
  }
}