modules/topology-validator-ext/src/test/java/org/apache/ignite/plugin/cache/IgniteCacheTopologyValidatorTest.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.ignite.plugin.cache;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.CountDownLatch;
import java.util.stream.Collectors;
import org.apache.ignite.Ignite;
import org.apache.ignite.IgniteCache;
import org.apache.ignite.cluster.ClusterNode;
import org.apache.ignite.configuration.CacheConfiguration;
import org.apache.ignite.configuration.DataRegionConfiguration;
import org.apache.ignite.configuration.DataStorageConfiguration;
import org.apache.ignite.configuration.IgniteConfiguration;
import org.apache.ignite.internal.IgniteEx;
import org.apache.ignite.internal.processors.cache.CacheInvalidStateException;
import org.apache.ignite.internal.processors.cache.distributed.GridCacheModuloAffinityFunction;
import org.apache.ignite.internal.processors.cache.distributed.dht.IgniteCacheTopologySplitAbstractTest;
import org.apache.ignite.internal.util.typedef.G;
import org.apache.ignite.internal.util.typedef.internal.U;
import org.apache.ignite.spi.IgniteSpiException;
import org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi;
import org.apache.ignite.spi.discovery.tcp.ipfinder.vm.TcpDiscoveryVmIpFinder;
import org.apache.ignite.testframework.GridTestUtils.RunnableX;
import org.junit.Assume;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;

import static java.util.Collections.singletonMap;
import static java.util.stream.Collectors.toList;
import static org.apache.ignite.cache.CacheMode.REPLICATED;
import static org.apache.ignite.cache.CacheWriteSynchronizationMode.FULL_SYNC;
import static org.apache.ignite.cluster.ClusterState.ACTIVE;
import static org.apache.ignite.cluster.ClusterState.ACTIVE_READ_ONLY;
import static org.apache.ignite.events.EventType.EVT_NODE_JOINED;
import static org.apache.ignite.internal.processors.cache.distributed.GridCacheModuloAffinityFunction.IDX_ATTR;
import static org.apache.ignite.plugin.cache.CacheTopologyValidatorPluginProvider.TOP_VALIDATOR_DEACTIVATION_THRESHOLD_PROP_NAME;
import static org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi.DFLT_PORT;
import static org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpi.DFLT_PORT_RANGE;
import static org.apache.ignite.testframework.GridTestUtils.assertThrowsAnyCause;
import static org.apache.ignite.testframework.GridTestUtils.waitForCondition;

/** */
@RunWith(Parameterized.class)
public class IgniteCacheTopologyValidatorTest extends IgniteCacheTopologySplitAbstractTest {
    /** */
    private static final String LOCAL_HOST = "localhost";

    /** */
    private static final int CACHE_KEY_CNT = 10;

    /** */
    public static final int CACHE_CNT = 2;

    /** */
    @Parameterized.Parameter
    public boolean isPersistenceEnabled;

    /** */
    @Parameterized.Parameters(name = "isPersistenceEnabled={0}")
    public static Collection<?> parameters() {
        return Arrays.asList(new Object[]{true}, new Object[]{false});
    }

    /** */
    @Override protected IgniteConfiguration getConfiguration(String igniteInstanceName) throws Exception {
        return getConfiguration(igniteInstanceName, true);
    }

    /** */
    private IgniteConfiguration getConfiguration(
        String igniteInstanceName,
        boolean configureSegmentationResolverPlugin
    ) throws Exception {
        int idx = getTestIgniteInstanceIndex(igniteInstanceName);

        IgniteConfiguration cfg = super.getConfiguration(igniteInstanceName)
            .setUserAttributes(singletonMap(IDX_ATTR, idx));

        if (configureSegmentationResolverPlugin)
            cfg.setPluginProviders(new CacheTopologyValidatorPluginProvider());

        ((TcpDiscoverySpi)cfg.getDiscoverySpi())
            .setIpFinder(sharedStaticIpFinder)
            .setLocalPortRange(1)
            .setLocalPort(discoPort(idx))
            .setConnectionRecoveryTimeout(0);

        if (isPersistenceEnabled) {
            cfg.setDataStorageConfiguration(new DataStorageConfiguration()
                .setDefaultDataRegionConfiguration(new DataRegionConfiguration()
                    .setInitialSize(100L * 1024 * 1024)
                    .setMaxSize(200L * 1024 * 1024)
                    .setPersistenceEnabled(true)));
        }

        return cfg;
    }

    /** {@inheritDoc} */
    @Override protected void beforeTest() throws Exception {
        super.beforeTest();

        cleanPersistenceDir();
    }

    /** {@inheritDoc} */
    @Override protected void afterTest() throws Exception {
        super.afterTest();

        stopAllGrids();
    }

    /** {@inheritDoc} */
    @Override protected boolean isBlocked(int locPort, int rmtPort) {
        return isDiscoPort(locPort) && isDiscoPort(rmtPort) && segment(locPort) != segment(rmtPort);
    }

    /**  */
    private int segment(int discoPort) {
        return (discoPort - DFLT_PORT) % 2 == 0 ? 0 : 1;
    }

    /** */
    @Override public int segment(ClusterNode node) {
        return node.<Integer>attribute(IDX_ATTR) % 2 == 0 ? 0 : 1;
    }

    /** */
    @Test
    public void testConnectionToIncompatibleCluster() throws Exception {
        startGrid(getConfiguration(getTestIgniteInstanceName(0), false));

        startGrid(1);

        if (isPersistenceEnabled)
            grid(0).cluster().state(ACTIVE);
        else
            grid(0).cluster().baselineAutoAdjustEnabled(false);

        assertTrue(waitForCondition(
            () -> 0F == (Float)grid(1).context()
                .distributedConfiguration()
                .property(TOP_VALIDATOR_DEACTIVATION_THRESHOLD_PROP_NAME)
                .get(),
            getTestTimeout()
        ));

        splitAndWait();

        connectNodeToSegment(3, false, 1);

        assertTrue(waitForCondition(
            () -> 0F == (Float)grid(3).context()
                .distributedConfiguration()
                .property(TOP_VALIDATOR_DEACTIVATION_THRESHOLD_PROP_NAME)
                .get(),
            getTestTimeout()
        ));
    }

    /** */
    @Test
    public void testIncompatibleNodeConnection() throws Exception {
        prepareCluster(1);

        assertThrowsAnyCause(
            log,
            () -> startGrid(getConfiguration(getTestIgniteInstanceName(1), false)),
            IgniteSpiException.class,
            "The Topology Validator plugin is not configured for the server node that is trying to join the cluster."
        );

        startClientGrid(getConfiguration(getTestIgniteInstanceName(2), false));

        assertEquals(2, grid(0).cluster().nodes().size());

        checkPutGet(G.allGrids(), true);
    }

    /** */
    @Test
    public void testConnectionToSegmentedCluster() throws Exception {
        prepareCluster(6);

        stopGrid(4);
        stopGrid(5);

        splitAndWait();

        checkPutGet(G.allGrids(), false);

        connectNodeToSegment(4, false, 0);
        connectNodeToSegment(6, true, 0);

        checkPutGet(0, false);

        connectNodeToSegment(5, false, 1);
        connectNodeToSegment(7, true, 1);

        checkPutGet(1, false);

        stopSegmentNodes(1);

        unsplit();

        startGrid(1);

        checkPutGet(G.allGrids(), false);
    }

    /** */
    @Test
    public void testRegularNodeStartStop() throws Exception {
        prepareCluster(1);

        checkPutGetAfter(() -> startGrid(1));
        checkPutGetAfter(() -> stopGrid(1));

        checkPutGetAfter(() -> startClientGrid(2));
        checkPutGetAfter(() -> stopGrid(2));

        startGrid(1);

        grid(0).cluster().setBaselineTopology(grid(0).cluster().topologyVersion());

        checkPutGetAfter(() -> startGrid(3));
        checkPutGetAfter(() -> stopGrid(3));

        checkPutGetAfter(() -> stopGrid(1));

        checkPutGetAfter(() -> startClientGrid(2));
        checkPutGetAfter(() -> stopGrid(2));
    }

    /** */
    @Test
    public void testClientNodeSegmentationIgnored() throws Exception {
        prepareCluster(1);

        startClientGrid(1);

        failNode(1, Collections.singleton(grid(0)));

        checkPutGet(Collections.singleton(grid(0)), true);
    }

    /** */
    @Test
    public void testSplitWithoutBaseline() throws Exception {
        Assume.assumeFalse(isPersistenceEnabled);

        startGridsMultiThreaded(4);

        createCaches();

        splitAndWait();

        checkPutGet(G.allGrids(), true);
    }

    /** */
    @Test
    public void testSplitWithBaseline() throws Exception {
        prepareCluster(3);

        startGrid(3);

        splitAndWait();

        connectNodeToSegment(4, true, 0);
        connectNodeToSegment(5, true, 1);

        checkPutGet(0, true);
        checkPutGet(1, false);

        assertTrue(waitForCondition(() -> ACTIVE_READ_ONLY == grid(1).cluster().state(), getTestTimeout()));

        stopSegmentNodes(1);
        stopGrid(4);

        unsplit();

        startGrid(1);
        startGrid(3);

        grid(0).cluster().setBaselineTopology(grid(0).cluster().topologyVersion());

        awaitPartitionMapExchange(true, true, null);

        checkPutGet(G.allGrids(), true);

        splitAndWait();

        checkPutGet(G.allGrids(), false);

        assertTrue(waitForCondition(() -> ACTIVE_READ_ONLY == grid(1).cluster().state(), getTestTimeout()));
        assertTrue(waitForCondition(() -> ACTIVE_READ_ONLY == grid(0).cluster().state(), getTestTimeout()));

        grid(0).cluster().state(ACTIVE);

        checkPutGet(0, true);
        checkPutGet(1, false);
    }

    /** */
    @Test
    public void testConsequentSegmentationResolving() throws Exception {
        prepareCluster(4);

        splitAndWait();

        checkPutGet(G.allGrids(), false);

        grid(1).cluster().state(ACTIVE);

        checkPutGet(0, false);
        checkPutGet(1, true);

        stopSegmentNodes(0);

        unsplit();

        failNode(1, Collections.singleton(grid(3)));

        checkPutGet(Collections.singleton(grid(3)), false);

        grid(3).cluster().state(ACTIVE);

        checkPutGet(Collections.singleton(grid(3)), true);
    }

    /** */
    @Test
    public void testDeactivationThreshold() throws Exception {
        prepareCluster(5);

        grid(0).context().distributedConfiguration().property(TOP_VALIDATOR_DEACTIVATION_THRESHOLD_PROP_NAME)
            .propagate(0.8F);

        Collection<Ignite> segment = new ArrayList<>(G.allGrids());

        segment.remove(grid(0));

        failNode(0, segment);

        checkPutGet(segment, false);

        stopGrid(0);

        grid(1).cluster().state(ACTIVE);

        grid(1).context().distributedConfiguration().property(TOP_VALIDATOR_DEACTIVATION_THRESHOLD_PROP_NAME)
            .propagate(0.5F);

        segment.remove(grid(4));

        failNode(4, segment);

        checkPutGet(segment, true);
    }

    /** */
    @Test
    public void testValidationDisabled() throws Exception {
        prepareCluster(4);

        grid(1).context().distributedConfiguration().property(TOP_VALIDATOR_DEACTIVATION_THRESHOLD_PROP_NAME)
            .propagate(0F);

        splitAndWait();

        connectNodeToSegment(4, true, 0);
        connectNodeToSegment(5, true, 1);

        checkPutGet(G.allGrids(), true);

        stopSegmentNodes(0);

        unsplit();

        grid(1).context().distributedConfiguration().property(TOP_VALIDATOR_DEACTIVATION_THRESHOLD_PROP_NAME)
            .propagate(0.5F);

        failNode(1, Collections.singleton(grid(3)));

        checkPutGet(Collections.singleton(grid(3)), false);
    }

    /** */
    @Test
    public void testNodeJoinWithHalfBaselineNodesLeft() throws Exception {
        prepareCluster(4);

        stopGrid(0);
        stopGrid(1);
        stopGrid(2);

        checkPutGet(G.allGrids(), true);

        startGrid(0);

        checkPutGet(G.allGrids(), true);
    }

    /** */
    @Test
    public void testNodeJoinConcurrentWithLeftRejected() throws Exception {
        prepareCluster(2);

        CountDownLatch discoveryWorkerBlockedLatch = new CountDownLatch(1);

        try {
            grid(0).events().localListen(evt -> {
                try {
                    discoveryWorkerBlockedLatch.await();
                }
                catch (InterruptedException e) {
                    U.error(log, e);

                    Thread.currentThread().interrupt();
                }

                return true;
            }, EVT_NODE_JOINED);

            startGrid(2);

            stopGrid(1);

            assertThrowsAnyCause(
                log,
                () -> startGrid(1),
                IgniteSpiException.class,
                "Node join request was rejected due to concurrent node left process handling"
            );
        }
        finally {
            discoveryWorkerBlockedLatch.countDown();
        }
    }

    /** */
    @Test
    public void testPreconfiguredClusterState() throws Exception {
        Assume.assumeFalse(isPersistenceEnabled);

        startGrid(0);

        startGrid(getConfiguration(getTestIgniteInstanceName(1)).setClusterStateOnStart(ACTIVE_READ_ONLY));

        grid(0).cluster().baselineAutoAdjustEnabled(false);

        createCaches();

        splitAndWait();

        checkPutGet(G.allGrids(), false);
    }

    /** */
    private IgniteEx connectNodeToSegment(int nodeIdx, boolean isClient, int segment) throws Exception {
        IgniteConfiguration cfg = getConfiguration(getTestIgniteInstanceName(nodeIdx));

        List<String> segmentDiscoPorts = segmentNodes(segment, false).stream()
            .map(node -> LOCAL_HOST + ':' + discoPort(node.localNode().<Integer>attribute(IDX_ATTR)))
            .collect(toList());

        ((TcpDiscoverySpi)cfg.getDiscoverySpi()).setIpFinder(new TcpDiscoveryVmIpFinder().setAddresses(segmentDiscoPorts));

        cfg.setClientMode(isClient);

        return startGrid(cfg);
    }

    /**  */
    private boolean isDiscoPort(int port) {
        return port >= DFLT_PORT &&
            port <= (DFLT_PORT + DFLT_PORT_RANGE);
    }

    /** */
    public void createCaches() {
        for (int cacheIdx = 0; cacheIdx < CACHE_CNT; cacheIdx++) {
            grid(0).createCache(new CacheConfiguration<>()
                .setAffinity(new GridCacheModuloAffinityFunction(CACHE_KEY_CNT, CACHE_KEY_CNT))
                .setName(cacheName(cacheIdx))
                .setWriteSynchronizationMode(FULL_SYNC)
                .setCacheMode(REPLICATED)
                .setReadFromBackup(false));
        }

        checkPutGet(G.allGrids(), true);
    }

    /** */
    private void checkPutGetAfter(RunnableX r) {
        r.run();

        checkPutGet(G.allGrids(), true);
    }

    /** */
    private void checkPutGet(int segment, boolean successfulPutExpected) {
        checkPutGet(segmentNodes(segment, true), successfulPutExpected);
    }

    /** */
    private String cacheName(int cacheIdx) {
        return DEFAULT_CACHE_NAME + '_' + cacheIdx;
    }

    /**  */
    private int discoPort(int idx) {
        return DFLT_PORT + idx;
    }

    /** */
    private void checkPutGet(Collection<? extends Ignite> nodes, boolean successfulPutExpected) {
        assertFalse(nodes.isEmpty());

        for (Ignite node : nodes) {
            for (int cacheIdx = 0; cacheIdx < CACHE_CNT; cacheIdx++) {
                IgniteCache<Object, Object> cache = node.cache(cacheName(cacheIdx));

                for (int i = 0; i < CACHE_KEY_CNT; i++) {
                    int key = i;

                    if (!successfulPutExpected) {
                        assertThrowsAnyCause(
                            null,
                            () -> {
                                cache.put(key, key);

                                return null;
                            },
                            CacheInvalidStateException.class,
                            "Failed to perform cache operation");
                    }
                    else
                        cache.put(key, key);

                    assertEquals(key, cache.get(key));
                }
            }
        }
    }

    /** */
    private void stopSegmentNodes(int segment) throws Exception {
        for (IgniteEx node : segmentNodes(segment, true)) {
            if (isPersistenceEnabled) {
                String pdsFolder = node.context().pdsFolderResolver().resolveFolders().folderName();

                stopGrid(node.name());

                cleanPersistenceDir(pdsFolder);
            }
            else
                stopGrid(node.name());
        }
    }

    /** */
    private void failNode(int idx, Collection<Ignite> awaitingNodes) {
        assertFalse(awaitingNodes.isEmpty());

        long topVer = awaitingNodes.iterator().next().cluster().topologyVersion();

        TcpDiscoverySpi spi = (TcpDiscoverySpi)grid(idx).context().discovery().getInjectedDiscoverySpi();

        spi.setClientReconnectDisabled(true);
        spi.disconnect();

        awaitExchangeVersionFinished(awaitingNodes, topVer + 1);
    }

    /** */
    private Collection<IgniteEx> segmentNodes(int segment, boolean includeClients) {
        return G.allGrids().stream()
            .filter(ignite -> includeClients || !ignite.cluster().localNode().isClient())
            .filter(ignite -> segment(ignite.cluster().localNode()) == segment)
            .map(ignite -> (IgniteEx)ignite)
            .collect(Collectors.toList());
    }

    /** */
    private void prepareCluster(int nodes) throws Exception {
        startGridsMultiThreaded(nodes);

        if (isPersistenceEnabled)
            grid(0).cluster().state(ACTIVE);
        else
            grid(0).cluster().baselineAutoAdjustEnabled(false);

        createCaches();
    }
}