org.apache.accumulo.fate.zookeeper.ZooCacheTest.java Source code

Java tutorial

Introduction

Here is the source code for org.apache.accumulo.fate.zookeeper.ZooCacheTest.java

Source

/*
 * 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.accumulo.fate.zookeeper;

import static org.easymock.EasyMock.anyObject;
import static org.easymock.EasyMock.capture;
import static org.easymock.EasyMock.createMock;
import static org.easymock.EasyMock.createStrictMock;
import static org.easymock.EasyMock.eq;
import static org.easymock.EasyMock.expect;
import static org.easymock.EasyMock.expectLastCall;
import static org.easymock.EasyMock.replay;
import static org.easymock.EasyMock.verify;
import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;

import java.util.List;

import org.apache.zookeeper.KeeperException;
import org.apache.zookeeper.WatchedEvent;
import org.apache.zookeeper.Watcher;
import org.apache.zookeeper.ZooKeeper;
import org.apache.zookeeper.data.Stat;
import org.easymock.Capture;
import org.easymock.EasyMock;
import org.junit.Before;
import org.junit.Test;

public class ZooCacheTest {
    private static final String ZPATH = "/some/path/in/zk";
    private static final byte[] DATA = { (byte) 1, (byte) 2, (byte) 3, (byte) 4 };
    private static final List<String> CHILDREN = java.util.Arrays.asList(new String[] { "huey", "dewey", "louie" });

    private ZooReader zr;
    private ZooKeeper zk;
    private ZooCache zc;

    @Before
    public void setUp() throws Exception {
        zr = createMock(ZooReader.class);
        zk = createStrictMock(ZooKeeper.class);
        expect(zr.getZooKeeper()).andReturn(zk);
        expectLastCall().anyTimes();
        replay(zr);

        zc = new ZooCache(zr, null);
    }

    @Test
    public void testGet() throws Exception {
        testGet(false);
    }

    @Test
    public void testGet_FillStat() throws Exception {
        testGet(true);
    }

    private void testGet(boolean fillStat) throws Exception {
        Stat myStat = null;
        if (fillStat) {
            myStat = new Stat();
        }
        long now = System.currentTimeMillis();
        Stat existsStat = new Stat();
        existsStat.setMtime(now);
        expect(zk.exists(eq(ZPATH), anyObject(Watcher.class))).andReturn(existsStat);
        expect(zk.getData(eq(ZPATH), anyObject(Watcher.class), eq(existsStat))).andReturn(DATA);
        replay(zk);

        assertFalse(zc.dataCached(ZPATH));
        assertArrayEquals(DATA, (fillStat ? zc.get(ZPATH, myStat) : zc.get(ZPATH)));
        verify(zk);
        if (fillStat) {
            assertEquals(now, myStat.getMtime());
        }

        assertTrue(zc.dataCached(ZPATH));
        assertSame(DATA, zc.get(ZPATH)); // cache hit
    }

    @Test
    public void testGet_NonExistent() throws Exception {
        expect(zk.exists(eq(ZPATH), anyObject(Watcher.class))).andReturn(null);
        replay(zk);

        assertNull(zc.get(ZPATH));
        verify(zk);
    }

    @Test
    public void testGet_Retry_NoNode() throws Exception {
        testGet_Retry(new KeeperException.NoNodeException(ZPATH));
    }

    @Test
    public void testGet_Retry_ConnectionLoss() throws Exception {
        testGet_Retry(new KeeperException.ConnectionLossException());
    }

    @Test
    public void testGet_Retry_BadVersion() throws Exception {
        testGet_Retry(new KeeperException.BadVersionException(ZPATH));
    }

    @Test
    public void testGet_Retry_Interrupted() throws Exception {
        testGet_Retry(new InterruptedException());
    }

    private void testGet_Retry(Exception e) throws Exception {
        expect(zk.exists(eq(ZPATH), anyObject(Watcher.class))).andThrow(e);
        Stat existsStat = new Stat();
        expect(zk.exists(eq(ZPATH), anyObject(Watcher.class))).andReturn(existsStat);
        expect(zk.getData(eq(ZPATH), anyObject(Watcher.class), eq(existsStat))).andReturn(DATA);
        replay(zk);

        assertArrayEquals(DATA, zc.get(ZPATH));
        verify(zk);
    }

    @Test
    public void testGet_Retry2_NoNode() throws Exception {
        testGet_Retry2(new KeeperException.NoNodeException(ZPATH));
    }

    @Test
    public void testGet_Retry2_ConnectionLoss() throws Exception {
        testGet_Retry2(new KeeperException.ConnectionLossException());
    }

    @Test
    public void testGet_Retry2_BadVersion() throws Exception {
        testGet_Retry2(new KeeperException.BadVersionException(ZPATH));
    }

    @Test
    public void testGet_Retry2_Interrupted() throws Exception {
        testGet_Retry2(new InterruptedException());
    }

    private void testGet_Retry2(Exception e) throws Exception {
        Stat existsStat = new Stat();
        expect(zk.exists(eq(ZPATH), anyObject(Watcher.class))).andReturn(existsStat);
        expect(zk.getData(eq(ZPATH), anyObject(Watcher.class), eq(existsStat))).andThrow(e);
        expect(zk.exists(eq(ZPATH), anyObject(Watcher.class))).andReturn(existsStat);
        expect(zk.getData(eq(ZPATH), anyObject(Watcher.class), eq(existsStat))).andReturn(DATA);
        replay(zk);

        assertArrayEquals(DATA, zc.get(ZPATH));
        verify(zk);
    }

    // ---

    @Test
    public void testGetChildren() throws Exception {
        expect(zk.getChildren(eq(ZPATH), anyObject(Watcher.class))).andReturn(CHILDREN);
        replay(zk);

        assertFalse(zc.childrenCached(ZPATH));
        assertEquals(CHILDREN, zc.getChildren(ZPATH));
        verify(zk);

        assertTrue(zc.childrenCached(ZPATH));
        // cannot check for sameness, return value is wrapped each time
        assertEquals(CHILDREN, zc.getChildren(ZPATH)); // cache hit
    }

    @Test
    public void testGetChildren_NoKids() throws Exception {
        expect(zk.getChildren(eq(ZPATH), anyObject(Watcher.class))).andReturn(null);
        replay(zk);

        assertNull(zc.getChildren(ZPATH));
        verify(zk);

        assertNull(zc.getChildren(ZPATH)); // cache hit
    }

    @Test
    public void testGetChildren_Retry() throws Exception {
        expect(zk.getChildren(eq(ZPATH), anyObject(Watcher.class)))
                .andThrow(new KeeperException.BadVersionException(ZPATH));
        expect(zk.getChildren(eq(ZPATH), anyObject(Watcher.class))).andReturn(CHILDREN);
        replay(zk);

        assertEquals(CHILDREN, zc.getChildren(ZPATH));
        verify(zk);
    }

    @Test
    public void testGetChildren_EatNoNode() throws Exception {
        expect(zk.getChildren(eq(ZPATH), anyObject(Watcher.class)))
                .andThrow(new KeeperException.NoNodeException(ZPATH));
        replay(zk);

        assertNull(zc.getChildren(ZPATH));
        verify(zk);
    }

    private static class TestWatcher implements Watcher {
        private final WatchedEvent expectedEvent;
        private boolean wasCalled;

        TestWatcher(WatchedEvent event) {
            expectedEvent = event;
            wasCalled = false;
        }

        @Override
        public void process(WatchedEvent event) {
            assertSame(expectedEvent, event);
            wasCalled = true;
        }

        boolean wasCalled() {
            return wasCalled;
        }
    }

    @Test
    public void testWatchDataNode_Deleted() throws Exception {
        testWatchDataNode(DATA, Watcher.Event.EventType.NodeDeleted, false);
    }

    @Test
    public void testWatchDataNode_DataChanged() throws Exception {
        testWatchDataNode(DATA, Watcher.Event.EventType.NodeDataChanged, false);
    }

    @Test
    public void testWatchDataNode_Created() throws Exception {
        testWatchDataNode(null, Watcher.Event.EventType.NodeCreated, false);
    }

    @Test
    public void testWatchDataNode_NoneSyncConnected() throws Exception {
        testWatchDataNode(null, Watcher.Event.EventType.None, true);
    }

    private void testWatchDataNode(byte[] initialData, Watcher.Event.EventType eventType, boolean stillCached)
            throws Exception {
        WatchedEvent event = new WatchedEvent(eventType, Watcher.Event.KeeperState.SyncConnected, ZPATH);
        TestWatcher exw = new TestWatcher(event);
        zc = new ZooCache(zr, exw);

        Watcher w = watchData(initialData);
        w.process(event);
        assertTrue(exw.wasCalled());
        assertEquals(stillCached, zc.dataCached(ZPATH));
    }

    private Watcher watchData(byte[] initialData) throws Exception {
        Capture<Watcher> cw = EasyMock.newCapture();
        Stat existsStat = new Stat();
        if (initialData != null) {
            expect(zk.exists(eq(ZPATH), capture(cw))).andReturn(existsStat);
            expect(zk.getData(eq(ZPATH), anyObject(Watcher.class), eq(existsStat))).andReturn(initialData);
        } else {
            expect(zk.exists(eq(ZPATH), capture(cw))).andReturn(null);
        }
        replay(zk);
        zc.get(ZPATH);
        assertTrue(zc.dataCached(ZPATH));

        return cw.getValue();
    }

    @Test
    public void testWatchDataNode_Disconnected() throws Exception {
        testWatchDataNode_Clear(Watcher.Event.KeeperState.Disconnected);
    }

    @Test
    public void testWatchDataNode_Expired() throws Exception {
        testWatchDataNode_Clear(Watcher.Event.KeeperState.Expired);
    }

    private void testWatchDataNode_Clear(Watcher.Event.KeeperState state) throws Exception {
        WatchedEvent event = new WatchedEvent(Watcher.Event.EventType.None, state, null);
        TestWatcher exw = new TestWatcher(event);
        zc = new ZooCache(zr, exw);

        Watcher w = watchData(DATA);
        assertTrue(zc.dataCached(ZPATH));
        w.process(event);
        assertTrue(exw.wasCalled());
        assertFalse(zc.dataCached(ZPATH));
    }

    @Test
    public void testWatchChildrenNode_Deleted() throws Exception {
        testWatchChildrenNode(CHILDREN, Watcher.Event.EventType.NodeDeleted, false);
    }

    @Test
    public void testWatchChildrenNode_ChildrenChanged() throws Exception {
        testWatchChildrenNode(CHILDREN, Watcher.Event.EventType.NodeChildrenChanged, false);
    }

    @Test
    public void testWatchChildrenNode_Created() throws Exception {
        testWatchChildrenNode(null, Watcher.Event.EventType.NodeCreated, false);
    }

    @Test
    public void testWatchChildrenNode_NoneSyncConnected() throws Exception {
        testWatchChildrenNode(CHILDREN, Watcher.Event.EventType.None, true);
    }

    private void testWatchChildrenNode(List<String> initialChildren, Watcher.Event.EventType eventType,
            boolean stillCached) throws Exception {
        WatchedEvent event = new WatchedEvent(eventType, Watcher.Event.KeeperState.SyncConnected, ZPATH);
        TestWatcher exw = new TestWatcher(event);
        zc = new ZooCache(zr, exw);

        Watcher w = watchChildren(initialChildren);
        w.process(event);
        assertTrue(exw.wasCalled());
        assertEquals(stillCached, zc.childrenCached(ZPATH));
    }

    private Watcher watchChildren(List<String> initialChildren) throws Exception {
        Capture<Watcher> cw = EasyMock.newCapture();
        expect(zk.getChildren(eq(ZPATH), capture(cw))).andReturn(initialChildren);
        replay(zk);
        zc.getChildren(ZPATH);
        assertTrue(zc.childrenCached(ZPATH));

        return cw.getValue();
    }
}