httpcore5/src/test/java/org/apache/hc/core5/util/TestTimeValue.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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.hc.core5.util;

import java.text.ParseException;
import java.util.concurrent.TimeUnit;

import org.hamcrest.CoreMatchers;
import org.hamcrest.MatcherAssert;
import org.junit.Assert;
import org.junit.Test;

public class TestTimeValue {

    private void checkToDays(final long value, final TimeUnit timeUnit) {
        Assert.assertEquals(timeUnit.toDays(value), TimeValue.of(value, timeUnit).toDays());
    }

    private void checkToHours(final long value, final TimeUnit timeUnit) {
        Assert.assertEquals(timeUnit.toHours(value), TimeValue.of(value, timeUnit).toHours());
    }

    private void checkToMicroseconds(final long value, final TimeUnit timeUnit) {
        Assert.assertEquals(timeUnit.toMicros(value), TimeValue.of(value, timeUnit).toMicroseconds());
    }

    private void checkToMilliseconds(final long value, final TimeUnit timeUnit) {
        Assert.assertEquals(timeUnit.toMillis(value), TimeValue.of(value, timeUnit).toMilliseconds());
    }

    private void checkToMinutes(final long value, final TimeUnit timeUnit) {
        Assert.assertEquals(timeUnit.toMinutes(value), TimeValue.of(value, timeUnit).toMinutes());
    }

    private void checkToNanoseconds(final long value, final TimeUnit timeUnit) {
        Assert.assertEquals(timeUnit.toNanos(value), TimeValue.of(value, timeUnit).toNanoseconds());
    }

    private void checkToSeconds(final long value, final TimeUnit timeUnit) {
        Assert.assertEquals(timeUnit.toSeconds(value), TimeValue.of(value, timeUnit).toSeconds());
    }

    private void test(final long value) {
        for (final TimeUnit timeUnit : TimeUnit.values()) {
            checkToDays(value, timeUnit);
            checkToHours(value, timeUnit);
            checkToMinutes(value, timeUnit);
            checkToSeconds(value, timeUnit);
            checkToMilliseconds(value, timeUnit);
            checkToMicroseconds(value, timeUnit);
            checkToNanoseconds(value, timeUnit);
        }
    }

    @Test
    public void test0() {
        test(0);
    }

    @Test
    public void test1() {
        test(1);
    }

    @Test
    public void testConvert() {
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).convert(TimeUnit.DAYS));
        Assert.assertEquals(1000, TimeValue.ofSeconds(1).convert(TimeUnit.MILLISECONDS));
    }

    @Test
    public void testDivide() {
        // nominator is 0, result should be 0.
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).divide(2).toDays());
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).divide(2).toHours());
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).divide(2).toMicroseconds());
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).divide(2).toMilliseconds());
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).divide(2).toMinutes());
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).divide(2).toNanoseconds());
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).divide(2).toSeconds());
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).divide(2).toMillisecondsIntBound());
        Assert.assertEquals(0, TimeValue.ofMilliseconds(0).divide(2).toSecondsIntBound());
        //
        Assert.assertEquals(50, TimeValue.ofMilliseconds(100).divide(2).toMilliseconds());
        Assert.assertEquals(0, TimeValue.ofMinutes(1).divide(2).toSeconds());
        Assert.assertEquals(30, TimeValue.ofMinutes(1).divide(2, TimeUnit.SECONDS).toSeconds());
        Assert.assertEquals(30000, TimeValue.ofMinutes(1).divide(2, TimeUnit.MILLISECONDS).toMilliseconds());
    }

    @Test(expected = ArithmeticException.class)
    public void testDivideBy0() {
        TimeValue.ofMilliseconds(0).divide(0);
    }

    private void testFactory(final TimeUnit timeUnit) {
        Assert.assertEquals(timeUnit, TimeValue.of(1, timeUnit).getTimeUnit());
    }

    @Test
    public void testFactoryForDays() {
        testFactory(TimeUnit.DAYS);
    }

    @Test
    public void testFactoryForHours() {
        testFactory(TimeUnit.HOURS);
    }

    @Test
    public void testFactoryForMicroseconds() {
        testFactory(TimeUnit.MICROSECONDS);
    }

    @Test
    public void testFactoryForMilliseconds() {
        testFactory(TimeUnit.MILLISECONDS);
    }

    @Test
    public void testFactoryForMinutes() {
        testFactory(TimeUnit.MINUTES);
    }

    @Test
    public void testFactoryForNanoseconds() {
        testFactory(TimeUnit.NANOSECONDS);
    }

    @Test
    public void testFactoryForSeconds() {
        testFactory(TimeUnit.SECONDS);
    }

    @Test
    public void testMin() {
        final TimeValue nanos1 = TimeValue.ofNanoseconds(1);
        final TimeValue micros1 = TimeValue.ofMicroseconds(1);
        final TimeValue millis1 = TimeValue.ofMilliseconds(1);
        final TimeValue seconds1 = TimeValue.ofSeconds(1);
        final TimeValue minutes1 = TimeValue.ofMinutes(1);
        final TimeValue hours1 = TimeValue.ofHours(1);
        final TimeValue days1 = TimeValue.ofDays(1);
        //
        Assert.assertEquals(TimeValue.ZERO_MILLISECONDS, TimeValue.ZERO_MILLISECONDS.min(nanos1));
        Assert.assertEquals(TimeValue.ZERO_MILLISECONDS, TimeValue.ZERO_MILLISECONDS.min(micros1));
        Assert.assertEquals(TimeValue.ZERO_MILLISECONDS, TimeValue.ZERO_MILLISECONDS.min(millis1));
        Assert.assertEquals(TimeValue.ZERO_MILLISECONDS, TimeValue.ZERO_MILLISECONDS.min(seconds1));
        Assert.assertEquals(TimeValue.ZERO_MILLISECONDS, TimeValue.ZERO_MILLISECONDS.min(minutes1));
        Assert.assertEquals(TimeValue.ZERO_MILLISECONDS, TimeValue.ZERO_MILLISECONDS.min(hours1));
        Assert.assertEquals(TimeValue.ZERO_MILLISECONDS, TimeValue.ZERO_MILLISECONDS.min(days1));
        //
        Assert.assertEquals(nanos1, nanos1.min(nanos1));
        Assert.assertEquals(nanos1, nanos1.min(micros1));
        Assert.assertEquals(nanos1, nanos1.min(millis1));
        Assert.assertEquals(nanos1, nanos1.min(seconds1));
        Assert.assertEquals(nanos1, nanos1.min(minutes1));
        Assert.assertEquals(nanos1, nanos1.min(hours1));
        Assert.assertEquals(nanos1, nanos1.min(days1));
        //
        Assert.assertEquals(nanos1, micros1.min(nanos1));
        Assert.assertEquals(micros1, micros1.min(micros1));
        Assert.assertEquals(micros1, micros1.min(millis1));
        Assert.assertEquals(micros1, micros1.min(seconds1));
        Assert.assertEquals(micros1, micros1.min(minutes1));
        Assert.assertEquals(micros1, micros1.min(hours1));
        Assert.assertEquals(micros1, micros1.min(days1));
        //
        Assert.assertEquals(nanos1, millis1.min(nanos1));
        Assert.assertEquals(micros1, millis1.min(micros1));
        Assert.assertEquals(millis1, millis1.min(millis1));
        Assert.assertEquals(millis1, millis1.min(seconds1));
        Assert.assertEquals(millis1, millis1.min(minutes1));
        Assert.assertEquals(millis1, millis1.min(hours1));
        Assert.assertEquals(millis1, millis1.min(days1));
        //
        Assert.assertEquals(nanos1, seconds1.min(nanos1));
        Assert.assertEquals(micros1, seconds1.min(micros1));
        Assert.assertEquals(millis1, seconds1.min(millis1));
        Assert.assertEquals(seconds1, seconds1.min(seconds1));
        Assert.assertEquals(seconds1, seconds1.min(minutes1));
        Assert.assertEquals(seconds1, seconds1.min(hours1));
        Assert.assertEquals(seconds1, seconds1.min(days1));
        //
        Assert.assertEquals(nanos1, minutes1.min(nanos1));
        Assert.assertEquals(micros1, minutes1.min(micros1));
        Assert.assertEquals(millis1, minutes1.min(millis1));
        Assert.assertEquals(seconds1, minutes1.min(seconds1));
        Assert.assertEquals(minutes1, minutes1.min(minutes1));
        Assert.assertEquals(minutes1, minutes1.min(hours1));
        Assert.assertEquals(minutes1, minutes1.min(days1));
        //
        Assert.assertEquals(nanos1, hours1.min(nanos1));
        Assert.assertEquals(micros1, hours1.min(micros1));
        Assert.assertEquals(millis1, hours1.min(millis1));
        Assert.assertEquals(seconds1, hours1.min(seconds1));
        Assert.assertEquals(minutes1, hours1.min(minutes1));
        Assert.assertEquals(hours1, hours1.min(hours1));
        Assert.assertEquals(hours1, hours1.min(days1));
        //
        Assert.assertEquals(nanos1, days1.min(nanos1));
        Assert.assertEquals(micros1, days1.min(micros1));
        Assert.assertEquals(millis1, days1.min(millis1));
        Assert.assertEquals(seconds1, days1.min(seconds1));
        Assert.assertEquals(minutes1, days1.min(minutes1));
        Assert.assertEquals(hours1, days1.min(hours1));
        Assert.assertEquals(days1, days1.min(days1));
    }

    @Test
    public void testMaxInt() {
        test(Integer.MAX_VALUE);
    }

    @Test
    public void testMaxLong() {
        test(Long.MAX_VALUE);
    }

    @Test
    public void testNegative1() {
        test(-1);
    }

    @Test
    public void testToString() {
        Assert.assertEquals("9223372036854775807 SECONDS", TimeValue.ofSeconds(Long.MAX_VALUE).toString());
        Assert.assertEquals("0 MILLISECONDS", TimeValue.ZERO_MILLISECONDS.toString());
    }

    @Test
    public void testFromString() throws ParseException {
        Assert.assertEquals(TimeValue.ofSeconds(Long.MAX_VALUE), TimeValue.parse("9223372036854775807 SECONDS"));
        Assert.assertEquals(TimeValue.ofSeconds(Long.MAX_VALUE), TimeValue.parse("9223372036854775807 SECONDS"));
        Assert.assertEquals(TimeValue.ofSeconds(Long.MAX_VALUE), TimeValue.parse(" 9223372036854775807 SECONDS "));
        Assert.assertEquals(TimeValue.ofSeconds(Long.MAX_VALUE), TimeValue.parse("9223372036854775807 Seconds"));
        Assert.assertEquals(TimeValue.ofSeconds(Long.MAX_VALUE), TimeValue.parse("9223372036854775807  Seconds"));
        Assert.assertEquals(TimeValue.ofSeconds(Long.MAX_VALUE), TimeValue.parse("9223372036854775807\tSeconds"));
        Assert.assertEquals(TimeValue.ZERO_MILLISECONDS, TimeValue.parse("0 MILLISECONDS"));
        Assert.assertEquals(TimeValue.ofMilliseconds(1), TimeValue.parse("1 MILLISECOND"));
    }

    @Test
    public void testEqualsAndHashCode() throws ParseException {
        final TimeValue tv1 = TimeValue.ofMilliseconds(1000L);
        final TimeValue tv2 = TimeValue.ofMilliseconds(1001L);
        final TimeValue tv3 = TimeValue.ofMilliseconds(1000L);
        final TimeValue tv4 = TimeValue.ofSeconds(1L);
        final TimeValue tv5 = TimeValue.ofSeconds(1000L);

        MatcherAssert.assertThat(tv1.equals(tv1), CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv1.equals(null), CoreMatchers.equalTo(false));
        MatcherAssert.assertThat(tv1.equals(tv2), CoreMatchers.equalTo(false));
        MatcherAssert.assertThat(tv1.equals(tv3), CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv1.equals(tv4), CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv4.equals(tv1), CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv1.equals(tv5), CoreMatchers.equalTo(false));

        MatcherAssert.assertThat(tv1.hashCode() == tv2.hashCode(), CoreMatchers.equalTo(false));
        MatcherAssert.assertThat(tv1.hashCode() == tv3.hashCode(), CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv1.hashCode() == tv4.hashCode(), CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv4.hashCode() == tv1.hashCode(), CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv1.hashCode() == tv5.hashCode(), CoreMatchers.equalTo(false));
    }

    @Test
    public void testCompareTo() throws ParseException {
        final TimeValue tv1 = TimeValue.ofMilliseconds(1000L);
        final TimeValue tv2 = TimeValue.ofMilliseconds(1001L);
        final TimeValue tv3 = TimeValue.ofMilliseconds(1000L);
        final TimeValue tv4 = TimeValue.ofSeconds(1L);
        final TimeValue tv5 = TimeValue.ofSeconds(60L);
        final TimeValue tv6 = TimeValue.ofMinutes(1L);

        MatcherAssert.assertThat(tv1.compareTo(tv1) == 0, CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv1.compareTo(tv2) < 0, CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv1.compareTo(tv3) == 0, CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv1.compareTo(tv4) == 0, CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv1.compareTo(tv5) < 0, CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv6.compareTo(tv5) == 0, CoreMatchers.equalTo(true));
        MatcherAssert.assertThat(tv6.compareTo(tv4) > 0, CoreMatchers.equalTo(true));
        try {
            tv1.compareTo(null);
            Assert.fail("NullPointerException expected");
        } catch (final NullPointerException expected) {
        }
    }

}