1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
|
/*
* Copyright (c) 2020, 2021, 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.
*/
/*
* @test
* @bug 8062947 8273402
* @summary Test that CommunicationException is thrown when connection is timed out or closed/cancelled,
* and it's text matches the failure reason.
* @library /test/lib lib
* @run testng NamingExceptionMessageTest
*/
import javax.naming.CommunicationException;
import javax.naming.Context;
import javax.naming.NamingException;
import javax.naming.ServiceUnavailableException;
import javax.naming.directory.InitialDirContext;
import java.io.IOException;
import java.io.OutputStream;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.util.Hashtable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import org.testng.annotations.Test;
import org.testng.Assert;
import jdk.test.lib.net.URIBuilder;
public class NamingExceptionMessageTest {
@Test
public void timeoutMessageTest() throws Exception {
try (var ldapServer = TestLdapServer.newInstance(false)) {
ldapServer.start();
ldapServer.awaitStartup();
var env = ldapServer.getInitialLdapCtxEnvironment(TIMEOUT_VALUE);
var communicationException =
Assert.expectThrows(CommunicationException.class, () -> new InitialDirContext(env));
System.out.println("Got CommunicationException:" + communicationException);
Assert.assertEquals(communicationException.getMessage(), EXPECTED_TIMEOUT_MESSAGE);
}
}
@Test
public void connectionClosureMessageTest() throws Exception {
try (var ldapServer = TestLdapServer.newInstance(true)) {
ldapServer.start();
ldapServer.awaitStartup();
var env = ldapServer.getInitialLdapCtxEnvironment(0);
var namingException = Assert.expectThrows(NamingException.class, () -> new InitialDirContext(env));
if (namingException instanceof ServiceUnavailableException) {
// If naming exception is ServiceUnavailableException it could mean
// that the connection was closed on test server-side before LDAP client starts
// read-out of the reply message. For such cases test run is considered as successful.
System.out.println("Got ServiceUnavailableException: Test PASSED");
} else {
// If exception is not ServiceUnavailableException, CommunicationException is expected
Assert.assertTrue(namingException instanceof CommunicationException);
var communicationException = (CommunicationException) namingException;
System.out.println("Got CommunicationException:" + communicationException);
// Check exception message
Assert.assertEquals(communicationException.getMessage(), EXPECTED_CLOSURE_MESSAGE);
}
}
}
// Test LDAP server
private static class TestLdapServer extends BaseLdapServer {
private final boolean closeConnections;
private final CountDownLatch startupLatch = new CountDownLatch(1);
public Hashtable<Object, Object> getInitialLdapCtxEnvironment(int readTimeoutValue) {
// Create environment for initial LDAP context
Hashtable<Object, Object> env = new Hashtable<>();
// Activate LDAPv3
env.put("java.naming.ldap.version", "3");
// De-activate the ManageDsaIT control
env.put(Context.REFERRAL, "follow");
env.put(Context.INITIAL_CONTEXT_FACTORY, "com.sun.jndi.ldap.LdapCtxFactory");
env.put(Context.PROVIDER_URL, getUrlString());
env.put(Context.SECURITY_AUTHENTICATION, "simple");
env.put(Context.SECURITY_PRINCIPAL, "name");
env.put(Context.SECURITY_CREDENTIALS, "pwd");
if (readTimeoutValue > 0) {
env.put("com.sun.jndi.ldap.read.timeout", String.valueOf(readTimeoutValue));
env.put("com.sun.jndi.ldap.connect.timeout", String.valueOf(readTimeoutValue));
}
return env;
}
private String getUrlString() {
String url = URIBuilder.newBuilder()
.scheme("ldap")
.loopback()
.port(getPort())
.buildUnchecked()
.toString();
return url;
}
public static TestLdapServer newInstance(boolean closeConnections) throws IOException {
ServerSocket srvSock = new ServerSocket();
srvSock.bind(new InetSocketAddress(InetAddress.getLoopbackAddress(), 0));
return new TestLdapServer(srvSock, closeConnections);
}
void awaitStartup() throws InterruptedException {
startupLatch.await();
}
private TestLdapServer(ServerSocket serverSocket, boolean closeConnections) {
super(serverSocket);
this.closeConnections = closeConnections;
}
@Override
protected void beforeAcceptingConnections() {
startupLatch.countDown();
}
@Override
protected void handleRequest(Socket socket,
LdapMessage msg,
OutputStream out)
throws IOException {
switch (msg.getOperation()) {
case BIND_REQUEST:
if (closeConnections) {
// Give some time for LDAP client to start-up
try {
TimeUnit.MILLISECONDS.sleep(100);
} catch (InterruptedException e) {
}
// Close the socket
closeSilently(socket);
} else {
try {
TimeUnit.DAYS.sleep(Integer.MAX_VALUE);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
}
default:
break;
}
}
}
// Expected message for case when connection is closed on server side
private static final String EXPECTED_CLOSURE_MESSAGE = "LDAP connection has been closed";
// read and connect timeouts value
private static final int TIMEOUT_VALUE = 129;
// Expected message text when connection is timed-out
private static final String EXPECTED_TIMEOUT_MESSAGE = String.format(
"LDAP response read timed out, timeout used: %d ms.", TIMEOUT_VALUE);
}
|