QuorumServerTest.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.server.quorum;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import java.net.InetSocketAddress;
import org.apache.zookeeper.KeeperException;
import org.apache.zookeeper.ZKTestCase;
import org.apache.zookeeper.server.quorum.QuorumPeer.QuorumServer;
import org.apache.zookeeper.server.quorum.QuorumPeerConfig.ConfigException;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;

public class QuorumServerTest extends ZKTestCase {

    private String ipv6n1 = "[2500:0:0:0:0:0:1:0]";
    private String ipv6n2 = "[2600:0:0:0:0:0:1:0]";
    private String ipv4config = "127.0.0.1:1234:1236";

    @AfterEach
    public void tearDown() {
        System.clearProperty(QuorumPeer.CONFIG_KEY_MULTI_ADDRESS_ENABLED);
    }

    @Test
    public void testToString() throws ConfigException {
        String provided = ipv4config + ":participant;0.0.0.0:1237";
        String expected = ipv4config + ":participant;0.0.0.0:1237";
        QuorumServer qs = new QuorumServer(0, provided);
        assertEquals(expected, qs.toString(), "Use IP address");

        provided = ipv4config + ";0.0.0.0:1237";
        expected = ipv4config + ":participant;0.0.0.0:1237";
        qs = new QuorumServer(0, provided);
        assertEquals(expected, qs.toString(), "Type unspecified");

        provided = ipv4config + ":observer;0.0.0.0:1237";
        expected = ipv4config + ":observer;0.0.0.0:1237";
        qs = new QuorumServer(0, provided);
        assertEquals(expected, qs.toString(), "Observer type");

        provided = ipv4config + ":participant;1237";
        expected = ipv4config + ":participant;0.0.0.0:1237";
        qs = new QuorumServer(0, provided);
        assertEquals(expected, qs.toString(), "Client address unspecified");

        provided = ipv4config + ":participant;1.2.3.4:1237";
        expected = ipv4config + ":participant;1.2.3.4:1237";
        qs = new QuorumServer(0, provided);
        assertEquals(expected, qs.toString(), "Client address specified");

        provided = "example.com:1234:1236:participant;1237";
        expected = "example.com:1234:1236:participant;0.0.0.0:1237";
        qs = new QuorumServer(0, provided);
        assertEquals(expected, qs.toString(), "Use hostname");

        provided = "example.com:1234:1236:participant;1237;1238";
        expected = "example.com:1234:1236:participant;0.0.0.0:1237;0.0.0.0:1238";
        qs = new QuorumServer(0, provided);
        assertEquals(expected, qs.toString(), "clientPort and secureClientPort");

        provided = ipv4config + ":participant;;1.2.3.4:1237";
        expected = ipv4config + ":participant;;1.2.3.4:1237";
        qs = new QuorumServer(0, provided);
        assertEquals(expected, qs.toString(), "Only secureClientPort");

    }

    @Test
    public void constructionUnderstandsIpv6LiteralsInServerConfig() throws ConfigException {
        String config = "[::1]:1234:1236:participant";
        QuorumServer qs = new QuorumServer(0, config);
        assertEquals("[0:0:0:0:0:0:0:1]:1234:1236:participant", qs.toString());
    }

    @Test
    public void constructionUnderstandsIpv6LiteralsInClientConfig() throws ConfigException {
        String config = ipv4config + ":participant;[::1]:1237";
        QuorumServer qs = new QuorumServer(0, config);
        assertEquals(ipv4config + ":participant;[0:0:0:0:0:0:0:1]:1237", qs.toString());
    }

    @Test
    public void unbalancedIpv6LiteralsInServerConfigFailToBeParsed()  {
        assertThrows(ConfigException.class, () -> {
            new QuorumServer(0, "[::1:1234:1236:participant");
        });
    }

    @Test
    public void unbalancedIpv6LiteralsInClientConfigFailToBeParsed() {
        assertThrows(ConfigException.class, () -> {
            new QuorumServer(0, ipv4config + ":participant;[::1:1237");
        });
    }

    @Test
    public void shouldNotAllowMultipleAddressesWhenMultiAddressFeatureIsDisabled() {
        assertThrows(ConfigException.class, () -> {
            System.setProperty(QuorumPeer.CONFIG_KEY_MULTI_ADDRESS_ENABLED, "false");
            new QuorumServer(0, "127.0.0.1:1234:1236|127.0.0.1:2234:2236");
        });
    }

    @Test
    public void shouldAllowMultipleAddressesWhenMultiAddressFeatureIsEnabled() throws ConfigException {
        System.setProperty(QuorumPeer.CONFIG_KEY_MULTI_ADDRESS_ENABLED, "true");
        QuorumServer qs = new QuorumServer(0, "127.0.0.1:1234:1236|127.0.0.1:2234:2236");
        assertEquals("127.0.0.1:1234:1236|127.0.0.1:2234:2236:participant", qs.toString(), "MultiAddress parse error");

        qs = new QuorumServer(0, "127.0.0.1:1234:1236|127.0.0.1:2234:2236;1237;1238");
        assertEquals("127.0.0.1:1234:1236|127.0.0.1:2234:2236:participant;0.0.0.0:1237;0.0.0.0:1238", qs.toString(), "MultiAddress parse with clientPort and secureClientPort");
    }

    @Test
    public void testWildcard() throws KeeperException.BadArgumentsException {
        String[] addrs = new String[]{"127.0.0.1", "[0:0:0:0:0:0:0:1]", "0.0.0.0", "[::]"};
        for (int i = 0; i < addrs.length; i++) {
            for (int j = i; j < addrs.length; j++) {
                QuorumPeer.QuorumServer server1 = new QuorumPeer.QuorumServer(1, new InetSocketAddress(ipv6n1, 1234), // peer
                                                                              new InetSocketAddress(ipv6n1, 1236), // election
                                                                              new InetSocketAddress(addrs[i], 1237)  // client
                );
                QuorumPeer.QuorumServer server2 = new QuorumPeer.QuorumServer(2, new InetSocketAddress(ipv6n2, 1234), // peer
                                                                              new InetSocketAddress(ipv6n2, 1236), // election
                                                                              new InetSocketAddress(addrs[j], 1237)  // client
                );
                server1.checkAddressDuplicate(server2);
            }
        }
    }

    @Test
    public void testDuplicate() {
        assertThrows(KeeperException.BadArgumentsException.class, () -> {
            QuorumPeer.QuorumServer server1 = new QuorumPeer.QuorumServer(1, new InetSocketAddress(ipv6n1, 1234), // peer
                    new InetSocketAddress(ipv6n1, 1236), // election
                    new InetSocketAddress(ipv6n1, 1237)  // client
            );
            QuorumPeer.QuorumServer server2 = new QuorumPeer.QuorumServer(2, new InetSocketAddress(ipv6n2, 1234), // peer
                    new InetSocketAddress(ipv6n2, 1236), // election
                    new InetSocketAddress(ipv6n1, 1237)  // client
            );
            server1.checkAddressDuplicate(server2);
        });
    }

    @Test
    public void testClientAddrAndSecureClientAddr() throws ConfigException {
        QuorumPeer.QuorumServer qs = new QuorumPeer.QuorumServer(0, "example.com:1234:1236:participant;1237;1238");
        assertNotNull(qs.clientAddr, "clientPort specified");
        assertNotNull(qs.secureClientAddr, "secureClientPort specified");

        qs = new QuorumPeer.QuorumServer(0, "example.com:1234:1236:participant;;1238");
        assertNull(qs.clientAddr, "clientPort not specified");
        assertNotNull(qs.secureClientAddr, "secureClientPort specified");

        qs = new QuorumPeer.QuorumServer(0, "example.com:1234:1236:participant;1237;");
        assertNotNull(qs.clientAddr, "clientPort specified");
        assertNull(qs.secureClientAddr, "secureClientPort not specified");

        qs = new QuorumPeer.QuorumServer(0, "example.com:1234:1236:participant;1237");
        assertNotNull(qs.clientAddr, "clientPort specified");
        assertNull(qs.secureClientAddr, "secureClientPort not specified");

        qs = new QuorumPeer.QuorumServer(0, "example.com:1234:1236:participant");
        assertNull(qs.clientAddr, "clientPort not specified");
        assertNull(qs.secureClientAddr, "secureClientPort not specified");

        qs = new QuorumPeer.QuorumServer(0, "example.com:1234:1236:participant;;");
        assertNull(qs.clientAddr, "clientPort not specified");
        assertNull(qs.secureClientAddr, "secureClientPort not specified");
    }

}