Timeout.java

/*
 * Copyright (c) 2002, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

import javax.naming.CommunicationException;
import javax.naming.Context;
import javax.naming.directory.InitialDirContext;
import java.net.SocketTimeoutException;
import java.time.Duration;
import java.time.Instant;

/*
 * @test
 * @bug 8200151 8265309
 * @summary Tests that we can set the initial UDP timeout interval and the
 *          number of retries.
 * @library ../lib/
 * @modules java.base/sun.security.util
 * @run main Timeout
 */

public class Timeout extends DNSTestBase {
    // Host 10.0.0.0 is a bit bucket, used here to simulate a DNS server that
    // doesn't respond. 10.0.0.0 server shouldn't be reachable.
    // Ping to this address should not give any reply
    private static final String HOST = "10.0.0.0";
    // Port 9 is a bit bucket, used here to simulate a DNS server that
    // doesn't respond.
    private static final int PORT = 9;
    // initial timeout = 1/4 sec
    private static final int TIMEOUT = 250;
    // try 5 times per server
    private static final int RETRIES = 5;

    private Instant startTime;

    public Timeout() {
        setLocalServer(false);
    }

    public static void main(String[] args) throws Exception {
        new Timeout().run(args);
    }

    /*
     * Tests that we can set the initial UDP timeout interval and the
     * number of retries.
     */
    @Override
    public void runTest() throws Exception {
        String allQuietUrl = "dns://" + HOST + ":" + PORT;
        env().put(Context.PROVIDER_URL, allQuietUrl);
        env().put("com.sun.jndi.dns.timeout.initial", String.valueOf(TIMEOUT));
        env().put("com.sun.jndi.dns.timeout.retries", String.valueOf(RETRIES));
        setContext(new InitialDirContext(env()));

        // Any request should fail after timeouts have expired.
        startTime = Instant.now();
        context().getAttributes("");

        throw new RuntimeException(
                "Failed: getAttributes succeeded unexpectedly");
    }

    @Override
    public boolean handleException(Exception e) {
        if (e instanceof CommunicationException) {
            Duration elapsedTime = Duration.between(startTime, Instant.now());
            if (!(((CommunicationException) e)
                    .getRootCause() instanceof SocketTimeoutException)) {
                return false;
            }

            Duration expectedTime = Duration.ofMillis(TIMEOUT)
                    .multipliedBy((1 << RETRIES) - 1);
            DNSTestUtils.debug("Elapsed (ms):  " + elapsedTime.toMillis());
            DNSTestUtils.debug("Expected (ms): " + expectedTime.toMillis());

            // Check that elapsed time is as long as expected, and
            // not more than 50% greater.
            if (elapsedTime.compareTo(expectedTime) >= 0 &&
                    elapsedTime.multipliedBy(2)
                            .compareTo(expectedTime.multipliedBy(3)) <= 0) {
                System.out.println("elapsed time is as long as expected.");
                return true;
            }
            throw new RuntimeException(
                    "Failed: timeout in " + elapsedTime.toMillis()
                            + " ms, expected" + expectedTime.toMillis() + "ms");
        }

        return super.handleException(e);
    }
}