RecorderTest.java

/**
 * HistogramTest.java
 * Written by Gil Tene of Azul Systems, and released to the public domain,
 * as explained at http://creativecommons.org/publicdomain/zero/1.0/
 *
 * @author Gil Tene
 */

package org.HdrHistogram;

import org.HdrHistogram.packedarray.PackedArrayRecorder;
import org.HdrHistogram.packedarray.PackedLongArray;
import org.junit.Assert;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.function.Executable;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

/**
 * JUnit test for {@link Histogram}
 */
public class RecorderTest {
    static final long highestTrackableValue = 3600L * 1000 * 1000; // e.g. for 1 hr in usec units
    static final int packedArrayLength = 300 * 10000 * 2;
    static final int nonPackedPhysicalLength = 128 * 1024;

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testIntervalRecording(boolean usePacked) throws Exception {

        Histogram histogram = new Histogram(highestTrackableValue, 3);
        DoubleHistogram doubleHistogram = new DoubleHistogram(highestTrackableValue * 1000, 3);
        Recorder recorder1 =
                new Recorder(3, usePacked);
        Recorder recorder2 =
                new Recorder(3, usePacked);
        DoubleRecorder doubleRecorder1 =
                new DoubleRecorder(3, usePacked);
        DoubleRecorder doubleRecorder2 =
                new DoubleRecorder(3, usePacked);
        PackedLongArray array1 = new PackedLongArray(packedArrayLength);
        PackedArrayRecorder arrayRecorder1 = new PackedArrayRecorder(packedArrayLength);

        for (int i = 0; i < 10000; i++) {
            histogram.recordValue(3000 * i);
            recorder1.recordValue(3000 * i);
            recorder2.recordValue(3000 * i);
            doubleHistogram.recordValue(5000 * i);
            doubleRecorder1.recordValue(5000 * i);
            doubleRecorder2.recordValue(5000 * i);
            doubleHistogram.recordValue(0.001); // Makes some internal shifts happen.
            doubleRecorder1.recordValue(0.001); // Makes some internal shifts happen.
            doubleRecorder2.recordValue(0.001); // Makes some internal shifts happen.
            array1.increment(300 * i);
            arrayRecorder1.increment(300 * i);
        }

        Histogram histogram2 = recorder1.getIntervalHistogram();
        Assert.assertEquals(histogram, histogram2);

        recorder2.getIntervalHistogramInto(histogram2);
        Assert.assertEquals(histogram, histogram2);

        DoubleHistogram doubleHistogram2 = doubleRecorder1.getIntervalHistogram();
        Assert.assertEquals(doubleHistogram, doubleHistogram2);

        doubleRecorder2.getIntervalHistogramInto(doubleHistogram2);
        Assert.assertEquals(doubleHistogram, doubleHistogram2);

        PackedLongArray array2 = arrayRecorder1.getIntervalArray();
        boolean arraysAreEqual = array1.equals(array2);
        Assert.assertEquals(arraysAreEqual, true);

        for (int i = 0; i < 5000; i++) {
            histogram.recordValue(3000 * i);
            recorder1.recordValue(3000 * i);
            recorder2.recordValue(3000 * i);
            doubleHistogram.recordValue(5000 * i);
            doubleRecorder1.recordValue(5000 * i);
            doubleRecorder2.recordValue(5000 * i);
            doubleHistogram.recordValue(0.001);
            doubleRecorder1.recordValue(0.001);
            doubleRecorder2.recordValue(0.001);
            array1.increment(300 * i);
            arrayRecorder1.increment(300 * i);
        }

        Histogram histogram3 = recorder1.getIntervalHistogram();

        Histogram sumHistogram = histogram2.copy();
        sumHistogram.add(histogram3);
        Assert.assertEquals(histogram, sumHistogram);

        DoubleHistogram doubleHistogram3 = doubleRecorder1.getIntervalHistogram();

        DoubleHistogram sumDoubleHistogram = doubleHistogram2.copy();
        sumDoubleHistogram.add(doubleHistogram3);
        Assert.assertEquals(doubleHistogram, sumDoubleHistogram);

        PackedLongArray array3 = arrayRecorder1.getIntervalArray();

        PackedLongArray sumArray = array2.copy();
        sumArray.add(array3);
        arraysAreEqual = array1.equals(sumArray);
        Assert.assertEquals(arraysAreEqual, true);

        recorder2.getIntervalHistogram();
        doubleRecorder2.getIntervalHistogram();

        for (int i = 5000; i < 10000; i++) {
            histogram.recordValue(3000 * i);
            recorder1.recordValue(3000 * i);
            recorder2.recordValue(3000 * i);
            doubleHistogram.recordValue(5000 * i);
            doubleRecorder1.recordValue(5000 * i);
            doubleRecorder2.recordValue(5000 * i);
            doubleHistogram.recordValue(0.001);
            doubleRecorder1.recordValue(0.001);
            doubleRecorder2.recordValue(0.001);
            array1.increment(300 * i);
            arrayRecorder1.increment(300 * i);
        }

        Histogram histogram4 = recorder1.getIntervalHistogram();
        histogram4.add(histogram3);
        Assert.assertEquals(histogram4, histogram2);

        recorder2.getIntervalHistogramInto(histogram4);
        histogram4.add(histogram3);
        Assert.assertEquals(histogram4, histogram2);

        DoubleHistogram doubleHistogram4 = doubleRecorder1.getIntervalHistogram();
        doubleHistogram4.add(doubleHistogram3);
        Assert.assertEquals(doubleHistogram4, doubleHistogram2);

        doubleHistogram4.reset();
        doubleRecorder2.getIntervalHistogramInto(doubleHistogram4);
        doubleHistogram4.add(doubleHistogram3);
        Assert.assertEquals(doubleHistogram4, doubleHistogram2);

        PackedLongArray array4 = arrayRecorder1.getIntervalArray();
        array4.add(array3);
        arraysAreEqual = array4.equals(array2);
        Assert.assertEquals(arraysAreEqual, true);
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testSimpleAutosizingRecorder(boolean usePacked) throws Exception {
        Recorder recorder = new Recorder(3, usePacked);
        Histogram histogram = recorder.getIntervalHistogram();
    }

    // PackedArrayRecorder recycling tests:

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testPARecycling(boolean usePacked) throws Exception {
        PackedArrayRecorder recorder = new PackedArrayRecorder(packedArrayLength, usePacked ? 0 : nonPackedPhysicalLength);
        PackedLongArray arrayA = recorder.getIntervalArray();
        PackedLongArray arrayB = recorder.getIntervalArray(arrayA);
        PackedLongArray arrayC = recorder.getIntervalArray(arrayB, true);
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testPARecyclingContainingClassEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        PackedLongArray arrayToRecycle = new PackedLongArray(packedArrayLength, usePacked ? 0 : nonPackedPhysicalLength);
                        PackedArrayRecorder recorder = new PackedArrayRecorder(packedArrayLength, usePacked ? 0 : nonPackedPhysicalLength);
                        PackedLongArray arrayA = recorder.getIntervalArray(arrayToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testPARecyclingContainingInstanceEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        PackedArrayRecorder recorder1 = new PackedArrayRecorder(packedArrayLength, usePacked ? 0 : nonPackedPhysicalLength);
                        PackedArrayRecorder recorder2 = new PackedArrayRecorder(packedArrayLength, usePacked ? 0 : nonPackedPhysicalLength);
                        PackedLongArray arrayToRecycle = recorder1.getIntervalArray();
                        PackedLongArray arrayToRecycle2 = recorder2.getIntervalArray(arrayToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testPARecyclingContainingInstanceNonEnforcement(final boolean usePacked) throws Exception {
        PackedArrayRecorder recorder1 = new PackedArrayRecorder(packedArrayLength, usePacked ? 0 : nonPackedPhysicalLength);
        PackedArrayRecorder recorder2 = new PackedArrayRecorder(packedArrayLength, usePacked ? 0 : nonPackedPhysicalLength);
        PackedLongArray arrayToRecycle = recorder1.getIntervalArray();
        PackedLongArray arrayToRecycle2 = recorder2.getIntervalArray(arrayToRecycle, false);
    }

    // Recorder Recycling tests:

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testRecycling(boolean usePacked) throws Exception {
        Recorder recorder = new Recorder(3, usePacked);
        Histogram histogramA = recorder.getIntervalHistogram();
        Histogram histogramB = recorder.getIntervalHistogram(histogramA);
        Histogram histogramC = recorder.getIntervalHistogram(histogramB, true);
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testRecyclingContainingClassEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        Histogram histToRecycle = new Histogram(3);
                        Recorder recorder = new Recorder(3, usePacked);
                        Histogram histogramA = recorder.getIntervalHistogram(histToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testRecyclingContainingInstanceEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        Recorder recorder1 = new Recorder(3, usePacked);
                        Recorder recorder2 = new Recorder(3, usePacked);
                        Histogram histToRecycle = recorder1.getIntervalHistogram();
                        Histogram histToRecycle2 = recorder2.getIntervalHistogram(histToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testRecyclingContainingInstanceNonEnforcement(final boolean usePacked) throws Exception {
        Recorder recorder1 = new Recorder(3, usePacked);
        Recorder recorder2 = new Recorder(3, usePacked);
        Histogram histToRecycle = recorder1.getIntervalHistogram();
        Histogram histToRecycle2 = recorder2.getIntervalHistogram(histToRecycle, false);
    }

    // SingleWriterRecorder Recycling tests:

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testSWRecycling(final boolean usePacked) throws Exception {
        SingleWriterRecorder recorder = new SingleWriterRecorder(3, usePacked);
        Histogram histogramA = recorder.getIntervalHistogram();
        Histogram histogramB = recorder.getIntervalHistogram(histogramA);
        Histogram histogramC = recorder.getIntervalHistogram(histogramB, true);
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testSWRecyclingContainingClassEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        Histogram histToRecycle = new Histogram(3);
                        SingleWriterRecorder recorder = new SingleWriterRecorder(3, usePacked);
                        Histogram histogramA = recorder.getIntervalHistogram(histToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testSWRecyclingContainingInstanceEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        SingleWriterRecorder recorder1 = new SingleWriterRecorder(3, usePacked);
                        SingleWriterRecorder recorder2 = new SingleWriterRecorder(3, usePacked);
                        Histogram histToRecycle = recorder1.getIntervalHistogram();
                        Histogram histToRecycle2 = recorder2.getIntervalHistogram(histToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testSWRecyclingContainingInstanceNonEnforcement(final boolean usePacked) throws Exception {
        SingleWriterRecorder recorder1 = new SingleWriterRecorder(3, usePacked);
        SingleWriterRecorder recorder2 = new SingleWriterRecorder(3, usePacked);
        Histogram histToRecycle = recorder1.getIntervalHistogram();
        Histogram histToRecycle2 = recorder2.getIntervalHistogram(histToRecycle, false);
    }

    // DoubleRecorder Recycling tests:

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testDRecycling(final boolean usePacked) throws Exception {
        DoubleRecorder recorder = new DoubleRecorder(3, usePacked);
        DoubleHistogram histogramA = recorder.getIntervalHistogram();
        DoubleHistogram histogramB = recorder.getIntervalHistogram(histogramA);
        DoubleHistogram histogramC = recorder.getIntervalHistogram(histogramB, true);
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testDRecyclingContainingClassEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        DoubleHistogram histToRecycle = new DoubleHistogram(3);
                        DoubleRecorder recorder = new DoubleRecorder(3, usePacked);
                        DoubleHistogram histogramA = recorder.getIntervalHistogram(histToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testDRecyclingContainingInstanceEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        DoubleRecorder recorder1 = new DoubleRecorder(3, usePacked);
                        DoubleRecorder recorder2 = new DoubleRecorder(3, usePacked);
                        DoubleHistogram histToRecycle = recorder1.getIntervalHistogram();
                        DoubleHistogram histToRecycle2 = recorder2.getIntervalHistogram(histToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testDRecyclingContainingInstanceNonEnforcement(final boolean usePacked) throws Exception {
        DoubleRecorder recorder1 = new DoubleRecorder(3, usePacked);
        DoubleRecorder recorder2 = new DoubleRecorder(3, usePacked);
        DoubleHistogram histToRecycle = recorder1.getIntervalHistogram();
        DoubleHistogram histToRecycle2 = recorder2.getIntervalHistogram(histToRecycle, false);
    }

    // SingleWriterDoubleRecorder Recycling tests:

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testSWDRecycling(final boolean usePacked) throws Exception {
        SingleWriterDoubleRecorder recorder = new SingleWriterDoubleRecorder(3, usePacked);
        DoubleHistogram histogramA = recorder.getIntervalHistogram();
        DoubleHistogram histogramB = recorder.getIntervalHistogram(histogramA);
        DoubleHistogram histogramC = recorder.getIntervalHistogram(histogramB, true);
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testSWDRecyclingContainingClassEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        DoubleHistogram histToRecycle = new DoubleHistogram(3);
                        SingleWriterDoubleRecorder recorder = new SingleWriterDoubleRecorder(3, usePacked);
                        DoubleHistogram histogramA = recorder.getIntervalHistogram(histToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testSWDRecyclingContainingInstanceEnforcement(final boolean usePacked) throws Exception {
        Assertions.assertThrows(IllegalArgumentException.class,
                new Executable() {
                    @Override
                    public void execute() throws Throwable {
                        SingleWriterDoubleRecorder recorder1 = new SingleWriterDoubleRecorder(3, usePacked);
                        SingleWriterDoubleRecorder recorder2 = new SingleWriterDoubleRecorder(3, usePacked);
                        DoubleHistogram histToRecycle = recorder1.getIntervalHistogram();
                        DoubleHistogram histToRecycle2 = recorder2.getIntervalHistogram(histToRecycle);
                    }
                });
    }

    @ParameterizedTest
    @ValueSource(booleans = {false, true})
    public void testSWDRecyclingContainingInstanceNonEnforcement(final boolean usePacked) throws Exception {
        SingleWriterDoubleRecorder recorder1 = new SingleWriterDoubleRecorder(3, usePacked);
        SingleWriterDoubleRecorder recorder2 = new SingleWriterDoubleRecorder(3, usePacked);
        DoubleHistogram histToRecycle = recorder1.getIntervalHistogram();
        DoubleHistogram histToRecycle2 = recorder2.getIntervalHistogram(histToRecycle, false);
    }
}