curator-master/curator-x-discovery/src/test/java/org/apache/curator/x/discovery/details/TestServiceDiscovery.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.x.discovery.details;

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 com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Semaphore;
import org.apache.curator.framework.CuratorFramework;
import org.apache.curator.framework.CuratorFrameworkFactory;
import org.apache.curator.retry.RetryOneTime;
import org.apache.curator.test.BaseClassForTests;
import org.apache.curator.test.Timing;
import org.apache.curator.test.compatibility.CuratorTestBase;
import org.apache.curator.utils.CloseableUtils;
import org.apache.curator.x.discovery.ServiceDiscovery;
import org.apache.curator.x.discovery.ServiceDiscoveryBuilder;
import org.apache.curator.x.discovery.ServiceInstance;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;

@Tag(CuratorTestBase.zk35TestCompatibilityGroup)
public class TestServiceDiscovery extends BaseClassForTests {
    private static final Comparator<ServiceInstance<Void>> comparator = new Comparator<ServiceInstance<Void>>() {
        @Override
        public int compare(ServiceInstance<Void> o1, ServiceInstance<Void> o2) {
            return o1.getId().compareTo(o2.getId());
        }
    };

    @Test
    public void testCrashedServerMultiInstances() throws Exception {
        CuratorFramework client = null;
        ServiceDiscovery<String> discovery = null;
        try {
            Timing timing = new Timing();
            client = CuratorFrameworkFactory.newClient(
                    server.getConnectString(), timing.session(), timing.connection(), new RetryOneTime(1));
            client.start();

            final Semaphore semaphore = new Semaphore(0);
            ServiceInstance<String> instance1 = ServiceInstance.<String>builder()
                    .payload("thing")
                    .name("test")
                    .port(10064)
                    .build();
            ServiceInstance<String> instance2 = ServiceInstance.<String>builder()
                    .payload("thing")
                    .name("test")
                    .port(10065)
                    .build();
            discovery =
                    new ServiceDiscoveryImpl<String>(
                            client, "/test", new JsonInstanceSerializer<String>(String.class), instance1, false) {
                        @Override
                        protected void internalRegisterService(ServiceInstance<String> service) throws Exception {
                            super.internalRegisterService(service);
                            semaphore.release();
                        }
                    };
            discovery.start();
            discovery.registerService(instance2);

            timing.acquireSemaphore(semaphore, 2);
            assertEquals(discovery.queryForInstances("test").size(), 2);

            client.getZookeeperClient().getZooKeeper().getTestable().injectSessionExpiration();
            server.stop();

            server.restart();

            timing.acquireSemaphore(semaphore, 2);
            assertEquals(discovery.queryForInstances("test").size(), 2);
        } finally {
            CloseableUtils.closeQuietly(discovery);
            CloseableUtils.closeQuietly(client);
        }
    }

    @Test
    public void testCrashedServer() throws Exception {
        CuratorFramework client = null;
        ServiceDiscovery<String> discovery = null;
        try {
            Timing timing = new Timing();
            client = CuratorFrameworkFactory.newClient(
                    server.getConnectString(), timing.session(), timing.connection(), new RetryOneTime(1));
            client.start();

            final Semaphore semaphore = new Semaphore(0);
            ServiceInstance<String> instance = ServiceInstance.<String>builder()
                    .payload("thing")
                    .name("test")
                    .port(10064)
                    .build();
            discovery =
                    new ServiceDiscoveryImpl<String>(
                            client, "/test", new JsonInstanceSerializer<String>(String.class), instance, false) {
                        @Override
                        protected void internalRegisterService(ServiceInstance<String> service) throws Exception {
                            super.internalRegisterService(service);
                            semaphore.release();
                        }
                    };
            discovery.start();

            timing.acquireSemaphore(semaphore);
            assertEquals(discovery.queryForInstances("test").size(), 1);

            client.getZookeeperClient().getZooKeeper().getTestable().injectSessionExpiration();
            server.stop();

            server.restart();

            timing.acquireSemaphore(semaphore);
            assertEquals(discovery.queryForInstances("test").size(), 1);
        } finally {
            CloseableUtils.closeQuietly(discovery);
            CloseableUtils.closeQuietly(client);
        }
    }

    @Test
    public void testCrashedInstance() throws Exception {
        CuratorFramework client = null;
        ServiceDiscovery<String> discovery = null;
        try {
            Timing timing = new Timing();

            client = CuratorFrameworkFactory.newClient(
                    server.getConnectString(), timing.session(), timing.connection(), new RetryOneTime(1));
            client.start();

            ServiceInstance<String> instance = ServiceInstance.<String>builder()
                    .payload("thing")
                    .name("test")
                    .port(10064)
                    .build();
            discovery = new ServiceDiscoveryImpl<String>(
                    client, "/test", new JsonInstanceSerializer<String>(String.class), instance, false);
            discovery.start();

            assertEquals(discovery.queryForInstances("test").size(), 1);

            client.getZookeeperClient().getZooKeeper().getTestable().injectSessionExpiration();
            Thread.sleep(timing.multiple(1.5).session());

            assertEquals(discovery.queryForInstances("test").size(), 1);
        } finally {
            CloseableUtils.closeQuietly(discovery);
            CloseableUtils.closeQuietly(client);
        }
    }

    @Test
    public void testMultipleInstances() throws Exception {
        final String SERVICE_ONE = "one";
        final String SERVICE_TWO = "two";

        CuratorFramework client = null;
        ServiceDiscovery<Void> discovery = null;
        try {
            client = CuratorFrameworkFactory.newClient(server.getConnectString(), new RetryOneTime(1));
            client.start();

            ServiceInstance<Void> s1_i1 =
                    ServiceInstance.<Void>builder().name(SERVICE_ONE).build();
            ServiceInstance<Void> s1_i2 =
                    ServiceInstance.<Void>builder().name(SERVICE_ONE).build();
            ServiceInstance<Void> s2_i1 =
                    ServiceInstance.<Void>builder().name(SERVICE_TWO).build();
            ServiceInstance<Void> s2_i2 =
                    ServiceInstance.<Void>builder().name(SERVICE_TWO).build();

            discovery = ServiceDiscoveryBuilder.builder(Void.class)
                    .client(client)
                    .basePath("/test")
                    .build();
            discovery.start();

            discovery.registerService(s1_i1);
            discovery.registerService(s1_i2);
            discovery.registerService(s2_i1);
            discovery.registerService(s2_i2);

            assertEquals(Sets.newHashSet(discovery.queryForNames()), Sets.newHashSet(SERVICE_ONE, SERVICE_TWO));

            List<ServiceInstance<Void>> list = Lists.newArrayList();
            list.add(s1_i1);
            list.add(s1_i2);
            Collections.sort(list, comparator);
            List<ServiceInstance<Void>> queriedInstances = Lists.newArrayList(discovery.queryForInstances(SERVICE_ONE));
            Collections.sort(queriedInstances, comparator);
            assertEquals(queriedInstances, list, String.format("Not equal l: %s - d: %s", list, queriedInstances));

            list.clear();

            list.add(s2_i1);
            list.add(s2_i2);
            Collections.sort(list, comparator);
            queriedInstances = Lists.newArrayList(discovery.queryForInstances(SERVICE_TWO));
            Collections.sort(queriedInstances, comparator);
            assertEquals(queriedInstances, list, String.format("Not equal 2: %s - d: %s", list, queriedInstances));
        } finally {
            CloseableUtils.closeQuietly(discovery);
            CloseableUtils.closeQuietly(client);
        }
    }

    @Test
    public void testBasic() throws Exception {
        CuratorFramework client = null;
        ServiceDiscovery<String> discovery = null;
        try {
            client = CuratorFrameworkFactory.newClient(server.getConnectString(), new RetryOneTime(1));
            client.start();

            ServiceInstance<String> instance = ServiceInstance.<String>builder()
                    .payload("thing")
                    .name("test")
                    .port(10064)
                    .build();
            discovery = ServiceDiscoveryBuilder.builder(String.class)
                    .basePath("/test")
                    .client(client)
                    .thisInstance(instance)
                    .build();
            discovery.start();

            assertEquals(discovery.queryForNames(), Collections.singletonList("test"));

            List<ServiceInstance<String>> list = Lists.newArrayList();
            list.add(instance);
            assertEquals(discovery.queryForInstances("test"), list);
        } finally {
            CloseableUtils.closeQuietly(discovery);
            CloseableUtils.closeQuietly(client);
        }
    }

    @Test
    public void testNoServerOnStart() throws Exception {
        Timing timing = new Timing();
        server.stop();

        CuratorFramework client = null;
        ServiceDiscovery<String> discovery = null;
        try {
            client = CuratorFrameworkFactory.newClient(server.getConnectString(), new RetryOneTime(1));
            client.start();

            ServiceInstance<String> instance = ServiceInstance.<String>builder()
                    .payload("thing")
                    .name("test")
                    .port(10064)
                    .build();
            discovery = ServiceDiscoveryBuilder.builder(String.class)
                    .basePath("/test")
                    .client(client)
                    .thisInstance(instance)
                    .build();
            discovery.start();

            server.restart();
            timing.sleepABit();
            assertEquals(discovery.queryForNames(), Collections.singletonList("test"));

            List<ServiceInstance<String>> list = Lists.newArrayList();
            list.add(instance);
            assertEquals(discovery.queryForInstances("test"), list);
        } finally {
            CloseableUtils.closeQuietly(discovery);
            CloseableUtils.closeQuietly(client);
        }
    }

    // CURATOR-164
    @Test
    public void testUnregisterService() throws Exception {
        final String name = "name";

        final CountDownLatch restartLatch = new CountDownLatch(1);

        InstanceSerializer<String> slowSerializer = new JsonInstanceSerializer<String>(String.class) {
            private boolean first = true;

            @Override
            public byte[] serialize(ServiceInstance<String> instance) throws Exception {
                if (first) {
                    System.out.println("Serializer first registration.");
                    first = false;
                } else {
                    System.out.println("Waiting for reconnect to finish.");
                    // Simulate the serialize method being slow.
                    // This could just be a timed wait, but that's kind of non-deterministic.
                    restartLatch.await();
                }
                return super.serialize(instance);
            }
        };

        CuratorFramework client = null;
        ServiceDiscovery<String> discovery = null;
        try {
            client = CuratorFrameworkFactory.newClient(server.getConnectString(), new RetryOneTime(1));
            client.start();

            ServiceInstance<String> instance = ServiceInstance.<String>builder()
                    .payload("thing")
                    .name(name)
                    .port(10064)
                    .build();
            discovery = ServiceDiscoveryBuilder.builder(String.class)
                    .basePath("/test")
                    .client(client)
                    .thisInstance(instance)
                    .serializer(slowSerializer)
                    .watchInstances(true)
                    .build();
            discovery.start();

            assertFalse(discovery.queryForInstances(name).isEmpty(), "Service should start registered.");

            server.stop();
            server.restart();

            discovery.unregisterService(instance);
            restartLatch.countDown();

            new Timing().sleepABit(); // Wait for the rest of registration to finish.

            assertTrue(discovery.queryForInstances(name).isEmpty(), "Service should have unregistered.");
        } finally {
            CloseableUtils.closeQuietly(discovery);
            CloseableUtils.closeQuietly(client);
        }
    }

    @Test
    public void testCleaning() throws Exception {
        CuratorFramework client = null;
        ServiceDiscovery<String> discovery = null;
        try {
            client = CuratorFrameworkFactory.newClient(server.getConnectString(), new RetryOneTime(1));
            client.start();

            ServiceInstance<String> instance = ServiceInstance.<String>builder()
                    .payload("thing")
                    .name("test")
                    .port(10064)
                    .build();
            discovery = ServiceDiscoveryBuilder.builder(String.class)
                    .basePath("/test")
                    .client(client)
                    .thisInstance(instance)
                    .build();
            discovery.start();
            discovery.unregisterService(instance);

            assertEquals(((ServiceDiscoveryImpl) discovery).debugServicesQty(), 0);
        } finally {
            CloseableUtils.closeQuietly(discovery);
            CloseableUtils.closeQuietly(client);
        }
    }
}
