src/test/java/org/apache/commons/net/time/TimeTCPClientTest.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
 *
 *      https://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.commons.net.time;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

import java.io.IOException;
import java.net.InetAddress;
import java.util.Calendar;
import java.util.TimeZone;

import org.junit.jupiter.api.Test;

class TimeTCPClientTest {
    private TimeTestSimpleServer server1;

    private int _port = 3333; // default test port

    protected void closeConnections() {
        try {
            server1.stop();
            Thread.sleep(1000);
        } catch (final Exception e) {
            // ignored
        }
    }

    protected void openConnections() throws Exception {
        try {
            server1 = new TimeTestSimpleServer(_port);
            server1.connect();
        } catch (final IOException ioe) {
            // try again on another port
            _port = 4000;
            server1 = new TimeTestSimpleServer(_port);
            server1.connect();
        }
        server1.start();
    }

    /**
     * Tests the times retrieved via the Time protocol implementation.
     */
    @Test
    void testCompareTimes() throws Exception {
        openConnections();

        final long time;
        final long time2;
        final long clientTime;
        final long clientTime2;
        final TimeTCPClient client = new TimeTCPClient();
        try {
            // Not sure why code used to use getLocalHost.
            final InetAddress localHost = InetAddress.getByName("localhost"); // WAS InetAddress.getLocalHost();
            try {
                // We want to timeout if a response takes longer than 60 seconds
                client.setDefaultTimeout(60000);
                client.connect(localHost, _port);
                clientTime = client.getDate().getTime();
                time = System.currentTimeMillis();
            } catch (final IOException e) { // catch the first connect error; assume second will work if this does
                fail("IOError <" + e + "> trying to connect to " + localHost + " " + _port);
                throw e;
            } finally {
                if (client.isConnected()) {
                    client.disconnect();
                }
            }

            try {
                // We want to timeout if a response takes longer than 60 seconds
                client.setDefaultTimeout(60000);
                client.connect(localHost, _port);
                clientTime2 = (client.getTime() - TimeTCPClient.SECONDS_1900_TO_1970) * 1000L;
                time2 = System.currentTimeMillis();
            } finally {
                if (client.isConnected()) {
                    client.disconnect();
                }
            }
        } finally {
            closeConnections();
        }

        // current time shouldn't differ from time reported via network by 5 seconds
        assertTrue(Math.abs(time - clientTime) < 5000);
        assertTrue(Math.abs(time2 - clientTime2) < 5000);
    }

    /**
     * Tests the constant basetime used by TimeClient against tha computed from Calendar class.
     */
    @Test
    void testInitial() {
        final TimeZone utcZone = TimeZone.getTimeZone("UTC");
        final Calendar calendar = Calendar.getInstance(utcZone);
        calendar.set(1900, Calendar.JANUARY, 1, 0, 0, 0);
        calendar.set(Calendar.MILLISECOND, 0);
        final long baseTime = calendar.getTime().getTime() / 1000L;

        assertEquals(-TimeTCPClient.SECONDS_1900_TO_1970, baseTime);
    }
}