curator-framework/src/test/java/org/apache/curator/framework/imps/TestWatcherIdentity.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.curator.framework.imps;

import com.google.common.collect.Sets;
import org.apache.curator.framework.CuratorFramework;
import org.apache.curator.framework.CuratorFrameworkFactory;
import org.apache.curator.framework.api.CuratorWatcher;
import org.apache.curator.retry.RetryOneTime;
import org.apache.curator.test.BaseClassForTests;
import org.apache.curator.test.Timing;
import org.apache.curator.utils.CloseableUtils;
import org.apache.zookeeper.WatchedEvent;
import org.apache.zookeeper.Watcher;
import org.awaitility.Awaitility;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;

public class TestWatcherIdentity extends BaseClassForTests
{
  private static final String PATH = "/foo";
  private static final int TIMEOUT_MS = 100000;

  private static class CountZKWatcher implements Watcher
  {
    private final AtomicInteger count = new AtomicInteger(0);

    @Override
    public void process(WatchedEvent event)
    {
      count.incrementAndGet();
    }
  }

  @Test
  public void testSameWatcherPerZKDocs() throws Exception
  {
    CountZKWatcher actualWatcher = new CountZKWatcher();
    Timing timing = new Timing();
    CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), timing.session(),
        timing.connection(), new RetryOneTime(1));
    try {
      client.start();
      client.create().forPath("/test");

      // per ZK docs, this watcher should only trigger once
      client.checkExists().usingWatcher(actualWatcher).forPath("/test");
      client.getData().usingWatcher(actualWatcher).forPath("/test");

      client.setData().forPath("/test", "foo".getBytes());
      client.delete().forPath("/test");
      Awaitility.await()
          .untilAsserted(() -> assertEquals(1, actualWatcher.count.getAndSet(0)));

      client.create().forPath("/test");
      client.checkExists().usingWatcher(actualWatcher).forPath("/test");
      client.delete().forPath("/test");
      Awaitility.await()
          .untilAsserted(() -> assertEquals(1, actualWatcher.count.get()));
    } finally {
      CloseableUtils.closeQuietly(client);
    }
  }

  @Test
  public void testSameCuratorWatcherPerZKDocs() throws Exception
  {
    // Construct mock object
    CuratorWatcher actualWatcher = mock(CuratorWatcher.class);

    Timing timing = new Timing();
    CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), timing.session(),
        timing.connection(), new RetryOneTime(1));
    try {
      client.start();
      client.create().forPath("/test");

      // per ZK docs, this watcher should only trigger once
      client.checkExists().usingWatcher(actualWatcher).forPath("/test");
      client.getData().usingWatcher(actualWatcher).forPath("/test");

      client.setData().forPath("/test", "foo".getBytes());
      client.delete().forPath("/test");
      Mockito.verify(actualWatcher, Mockito.timeout(TIMEOUT_MS).times(1)).process(any(WatchedEvent.class));

      client.create().forPath("/test");
      client.checkExists().usingWatcher(actualWatcher).forPath("/test");
      client.delete().forPath("/test");
      Mockito.verify(actualWatcher, Mockito.timeout(TIMEOUT_MS).times(2)).process(any(WatchedEvent.class));
    } finally {
      CloseableUtils.closeQuietly(client);
    }
  }

  @Test
  public void testSetAddition()
  {
    Watcher watcher = new Watcher()
    {
      @Override
      public void process(WatchedEvent event)
      {

      }
    };
    NamespaceWatcher namespaceWatcher1 = new NamespaceWatcher(null, watcher, "/foo");
    NamespaceWatcher namespaceWatcher2 = new NamespaceWatcher(null, watcher, "/foo");
    assertEquals(namespaceWatcher1, namespaceWatcher2);
    assertFalse(namespaceWatcher1.equals(watcher));
    assertFalse(watcher.equals(namespaceWatcher1));
    Set<Watcher> set = Sets.newHashSet();
    set.add(namespaceWatcher1);
    set.add(namespaceWatcher2);
    assertEquals(set.size(), 1);
  }

  @Test
  public void testCuratorWatcher() throws Exception
  {
    Timing timing = new Timing();
    // Construct mock object
    CuratorWatcher watcher = mock(CuratorWatcher.class);
    CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), timing.session(),
        timing.connection(), new RetryOneTime(1));
    try {
      client.start();
      client.create().forPath(PATH);
      // Add twice the same watcher on the same path
      client.getData().usingWatcher(watcher).forPath(PATH);
      client.getData().usingWatcher(watcher).forPath(PATH);
      // Ok, let's test it
      client.setData().forPath(PATH, new byte[] {});
      Mockito.verify(watcher, Mockito.timeout(TIMEOUT_MS).times(1)).process(any(WatchedEvent.class));
    } finally {
      CloseableUtils.closeQuietly(client);
    }
  }

  @Test
  public void testZKWatcher() throws Exception
  {
    Timing timing = new Timing();
    CountZKWatcher watcher = new CountZKWatcher();
    CuratorFramework client = CuratorFrameworkFactory.newClient(server.getConnectString(), timing.session(),
        timing.connection(), new RetryOneTime(1));
    try {
      client.start();
      client.create().forPath(PATH);
      // Add twice the same watcher on the same path
      client.getData().usingWatcher(watcher).forPath(PATH);
      client.getData().usingWatcher(watcher).forPath(PATH);
      // Ok, let's test it
      client.setData().forPath(PATH, new byte[] {});
      Awaitility.await()
          .untilAsserted(() -> assertEquals(1, watcher.count.get()));
    } finally {
      CloseableUtils.closeQuietly(client);
    }
  }
}