SessionTest.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.
*/
package org.apache.zookeeper.test;
import static org.apache.zookeeper.test.ClientBase.CONNECTION_TIMEOUT;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import org.apache.zookeeper.AsyncCallback;
import org.apache.zookeeper.CreateMode;
import org.apache.zookeeper.KeeperException;
import org.apache.zookeeper.PortAssignment;
import org.apache.zookeeper.WatchedEvent;
import org.apache.zookeeper.Watcher;
import org.apache.zookeeper.Watcher.Event.EventType;
import org.apache.zookeeper.Watcher.Event.KeeperState;
import org.apache.zookeeper.ZKTestCase;
import org.apache.zookeeper.ZooDefs.Ids;
import org.apache.zookeeper.ZooKeeper;
import org.apache.zookeeper.data.Stat;
import org.apache.zookeeper.server.ServerCnxnFactory;
import org.apache.zookeeper.server.ZooKeeperServer;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class SessionTest extends ZKTestCase {
protected static final Logger LOG = LoggerFactory.getLogger(SessionTest.class);
private static final String HOSTPORT = "127.0.0.1:" + PortAssignment.unique();
private ServerCnxnFactory serverFactory;
private ZooKeeperServer zs;
private CountDownLatch startSignal;
File tmpDir;
private final int TICK_TIME = 3000;
@BeforeEach
public void setUp() throws Exception {
if (tmpDir == null) {
tmpDir = ClientBase.createTmpDir();
}
ClientBase.setupTestEnv();
zs = new ZooKeeperServer(tmpDir, tmpDir, TICK_TIME);
final int PORT = Integer.parseInt(HOSTPORT.split(":")[1]);
serverFactory = ServerCnxnFactory.createFactory(PORT, -1);
serverFactory.startup(zs);
assertTrue(ClientBase.waitForServerUp(HOSTPORT, CONNECTION_TIMEOUT), "waiting for server up");
}
@AfterEach
public void tearDown() throws Exception {
serverFactory.shutdown();
zs.shutdown();
assertTrue(ClientBase.waitForServerDown(HOSTPORT, CONNECTION_TIMEOUT), "waiting for server down");
}
private static class CountdownWatcher implements Watcher {
volatile CountDownLatch clientConnected = new CountDownLatch(1);
final CountDownLatch sessionTerminated = new CountDownLatch(1);
public void process(WatchedEvent event) {
switch (event.getState()) {
case SyncConnected:
clientConnected.countDown();
break;
case AuthFailed:
case Expired:
case Closed:
sessionTerminated.countDown();
break;
}
}
}
private DisconnectableZooKeeper createClient() throws IOException, InterruptedException {
CountdownWatcher watcher = new CountdownWatcher();
return createClient(CONNECTION_TIMEOUT, watcher);
}
private DisconnectableZooKeeper createClient(int timeout) throws IOException, InterruptedException {
CountdownWatcher watcher = new CountdownWatcher();
return createClient(timeout, watcher);
}
private DisconnectableZooKeeper createClient(int timeout, CountdownWatcher watcher) throws IOException, InterruptedException {
DisconnectableZooKeeper zk = new DisconnectableZooKeeper(HOSTPORT, timeout, watcher);
if (!watcher.clientConnected.await(timeout, TimeUnit.MILLISECONDS)) {
fail("Unable to connect to server");
}
return zk;
}
// TODO this test is failing due to client close race condition fixing in separate patch for ZOOKEEPER-63
// /**
// * this test checks to see if the sessionid that was created for the
// * first zookeeper client can be reused for the second one immediately
// * after the first client closes and the new client reuses them.
// * @throws IOException
// * @throws InterruptedException
// * @throws KeeperException
// */
// public void testSessionReuse() throws IOException, InterruptedException {
// ZooKeeper zk = createClient();
//
// long sessionId = zk.getSessionId();
// byte[] passwd = zk.getSessionPasswd();
// zk.close();
//
// zk.close();
//
// LOG.info("Closed first session");
//
// startSignal = new CountDownLatch(1);
// zk = new ZooKeeper(HOSTPORT, CONNECTION_TIMEOUT, this,
// sessionId, passwd);
// startSignal.await();
//
// LOG.info("Opened reuse");
//
// assertEquals(sessionId, zk.getSessionId());
//
// zk.close();
// }
private class MyWatcher implements Watcher {
private String name;
public MyWatcher(String name) {
this.name = name;
}
public void process(WatchedEvent event) {
LOG.info("{} event:{} {} {}", name, event.getState(), event.getType(), event.getPath());
if (event.getState() == KeeperState.SyncConnected && startSignal != null && startSignal.getCount() > 0) {
startSignal.countDown();
}
}
}
/**
* This test verifies that when the session id is reused, and the original
* client is disconnected, but not session closed, that the server
* will remove ephemeral nodes created by the original session.
*/
@Test
public void testSession() throws IOException, InterruptedException, KeeperException {
DisconnectableZooKeeper zk = createClient();
zk.create("/e", new byte[0], Ids.OPEN_ACL_UNSAFE, CreateMode.EPHEMERAL);
LOG.info("zk with session id 0x{} was destroyed!", Long.toHexString(zk.getSessionId()));
// disconnect the client by killing the socket, not sending the
// session disconnect to the server as usual. This allows the test
// to verify disconnect handling
zk.disconnect();
Stat stat = new Stat();
startSignal = new CountDownLatch(1);
zk = new DisconnectableZooKeeper(HOSTPORT, CONNECTION_TIMEOUT, new MyWatcher("testSession"), zk.getSessionId(), zk.getSessionPasswd());
startSignal.await();
LOG.info("zk with session id 0x{} was created!", Long.toHexString(zk.getSessionId()));
zk.getData("/e", false, stat);
LOG.info("After get data /e");
zk.close();
zk = createClient();
assertEquals(null, zk.exists("/e", false));
LOG.info("before close zk with session id 0x{}!", Long.toHexString(zk.getSessionId()));
zk.close();
try {
zk.getData("/e", false, stat);
fail("Should have received a SessionExpiredException");
} catch (KeeperException.SessionExpiredException e) {
}
AsyncCallback.DataCallback cb = new AsyncCallback.DataCallback() {
String status = "not done";
public void processResult(int rc, String p, Object c, byte[] b, Stat s) {
synchronized (this) {
status = KeeperException.Code.get(rc).toString();
this.notify();
}
}
public String toString() {
return status;
}
};
zk.getData("/e", false, cb, null);
synchronized (cb) {
if (cb.toString().equals("not done")) {
cb.wait(1000);
}
}
assertEquals(KeeperException.Code.SESSIONEXPIRED.toString(), cb.toString());
}
/**
* Make sure that we cannot have two connections with the same
* session id.
*
* @throws IOException
* @throws InterruptedException
* @throws KeeperException
*/
@Test
public void testSessionMove() throws Exception {
String[] hostPorts = HOSTPORT.split(",");
DisconnectableZooKeeper zk = new DisconnectableZooKeeper(hostPorts[0], CONNECTION_TIMEOUT, new MyWatcher("0"));
zk.create("/sessionMoveTest", new byte[0], Ids.OPEN_ACL_UNSAFE, CreateMode.EPHEMERAL);
// we want to loop through the list twice
for (int i = 0; i < hostPorts.length * 2; i++) {
zk.dontReconnect();
// This should stomp the zk handle
DisconnectableZooKeeper zknew = new DisconnectableZooKeeper(hostPorts[(i + 1)
% hostPorts.length], CONNECTION_TIMEOUT, new MyWatcher(Integer.toString(
i
+ 1)), zk.getSessionId(), zk.getSessionPasswd());
zknew.sync("/");
LOG.info("{} Sync succeed", hostPorts[(i + 1) % hostPorts.length]);
zknew.setData("/", new byte[1], -1);
try {
zk.setData("/", new byte[1], -1);
fail("Should have lost the connection");
} catch (KeeperException.ConnectionLossException e) {
LOG.info("Got connection loss exception as expected");
}
//zk.close();
zk = zknew;
}
zk.close();
}
/**
* This test makes sure that duplicate state changes are not communicated
* to the client watcher. For example we should not notify state as
* "disconnected" if the watch has already been disconnected. In general
* we don't consider a dup state notification if the event type is
* not "None" (ie non-None communicates an event).
*/
@Test
public void testSessionStateNoDupStateReporting() throws IOException, InterruptedException, KeeperException {
final int TIMEOUT = 3000;
DupWatcher watcher = new DupWatcher();
ZooKeeper zk = createClient(TIMEOUT, watcher);
// shutdown the server
serverFactory.shutdown();
watcher.sessionTerminated.await();
// verify that there is no duplicated disconnected event.
List<KeeperState> states = Arrays.asList(
KeeperState.SyncConnected,
KeeperState.Disconnected,
KeeperState.Expired
);
assertEquals(states, watcher.states);
zk.close();
}
/**
* Verify access to the negotiated session timeout.
*/
@Test
public void testSessionTimeoutAccess() throws Exception {
// validate typical case - requested == negotiated
DisconnectableZooKeeper zk = createClient(TICK_TIME * 4);
assertEquals(TICK_TIME * 4, zk.getSessionTimeout());
// make sure tostring works in both cases
LOG.info(zk.toString());
zk.close();
LOG.info(zk.toString());
// validate lower limit
zk = createClient(TICK_TIME);
assertEquals(TICK_TIME * 2, zk.getSessionTimeout());
LOG.info(zk.toString());
zk.close();
LOG.info(zk.toString());
// validate upper limit
zk = createClient(TICK_TIME * 30);
assertEquals(TICK_TIME * 20, zk.getSessionTimeout());
LOG.info(zk.toString());
zk.close();
LOG.info(zk.toString());
}
private class DupWatcher extends CountdownWatcher {
public List<KeeperState> states = new LinkedList<>();
public void process(WatchedEvent event) {
super.process(event);
if (event.getType() == EventType.None) {
states.add(event.getState());
}
}
}
@Test
public void testMinMaxSessionTimeout() throws Exception {
// override the defaults
final int MINSESS = 20000;
final int MAXSESS = 240000;
{
ZooKeeperServer zs = serverFactory.getZooKeeperServer();
zs.setMinSessionTimeout(MINSESS);
zs.setMaxSessionTimeout(MAXSESS);
}
// validate typical case - requested == negotiated
int timeout = 120000;
DisconnectableZooKeeper zk = createClient(timeout);
assertEquals(timeout, zk.getSessionTimeout());
// make sure tostring works in both cases
LOG.info(zk.toString());
zk.close();
LOG.info(zk.toString());
// validate lower limit
zk = createClient(MINSESS / 2);
assertEquals(MINSESS, zk.getSessionTimeout());
LOG.info(zk.toString());
zk.close();
LOG.info(zk.toString());
// validate upper limit
zk = createClient(MAXSESS * 2);
assertEquals(MAXSESS, zk.getSessionTimeout());
LOG.info(zk.toString());
zk.close();
LOG.info(zk.toString());
}
@Test
public void testMaximumCnxnPerIP() throws Exception {
final int maxClientCnxnsPerIP = 3;
serverFactory.setMaxClientCnxnsPerHost(maxClientCnxnsPerIP);
ZooKeeper[] clients = new ZooKeeper[maxClientCnxnsPerIP + 1];
for (int i = 0; i < clients.length; i++) {
CountdownWatcher watcher = new CountdownWatcher();
// wait for 3s
int timeout = 3000;
clients[i] = new DisconnectableZooKeeper(HOSTPORT, timeout, watcher);
boolean result = watcher.clientConnected.await(timeout, TimeUnit.MILLISECONDS);
if (i >= maxClientCnxnsPerIP) {
assertFalse(result);
} else {
assertTrue(result);
}
}
}
}