modules/core/src/test/java/org/apache/ignite/internal/processors/datastreamer/DataStreamerStopCacheTest.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.internal.processors.datastreamer;

import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import javax.cache.Cache;
import javax.cache.CacheException;
import javax.cache.configuration.FactoryBuilder;
import javax.cache.integration.CacheLoaderException;
import javax.cache.integration.CacheWriterException;
import javax.cache.integration.CompletionListener;
import org.apache.ignite.Ignite;
import org.apache.ignite.IgniteCache;
import org.apache.ignite.cache.affinity.rendezvous.RendezvousAffinityFunction;
import org.apache.ignite.cache.store.CacheStoreAdapter;
import org.apache.ignite.configuration.CacheConfiguration;
import org.apache.ignite.configuration.IgniteConfiguration;
import org.apache.ignite.internal.IgniteEx;
import org.apache.ignite.internal.TestRecordingCommunicationSpi;
import org.apache.ignite.internal.processors.cache.distributed.dht.preloader.GridDhtPartitionsSingleMessage;
import org.apache.ignite.internal.util.typedef.X;
import org.apache.ignite.resources.IgniteInstanceResource;
import org.apache.ignite.testframework.GridTestUtils;
import org.apache.ignite.testframework.junits.common.GridCommonAbstractTest;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import static org.apache.ignite.cache.CacheAtomicityMode.ATOMIC;
import static org.apache.ignite.cache.CacheMode.PARTITIONED;

/**
 * Tests that closing cache during uploading does not cause grid hang.
 */
public class DataStreamerStopCacheTest extends GridCommonAbstractTest {
    /**
     * Default timeout for operations.
     */
    private static final long TIMEOUT = 10_000;

    /**
     * Number of partitions.
     */
    private static final int PART_NUM = 32;

    /**
     * {@inheritDoc}
     */
    @Override protected IgniteConfiguration getConfiguration(String igniteInstanceName) throws Exception {
        IgniteConfiguration cfg = super.getConfiguration(igniteInstanceName);

        cfg.setCacheConfiguration(cacheConfiguration());

        TestRecordingCommunicationSpi commSpi = new TestRecordingCommunicationSpi();

        cfg.setCommunicationSpi(commSpi);

        return cfg;
    }

    /**
     *
     */
    @Before
    public void before() throws Exception {
        stopAllGrids();
    }

    /**
     *
     */
    @After
    public void after() throws Exception {
        stopAllGrids();
    }

    /**
     * @return Cache configuration.
     */
    private CacheConfiguration cacheConfiguration() {
        CacheConfiguration ccfg = defaultCacheConfiguration();

        ccfg.setCacheMode(PARTITIONED);
        ccfg.setAtomicityMode(ATOMIC);
        ccfg.setAffinity(new RendezvousAffinityFunction(false, PART_NUM));

        ccfg.setCacheStoreFactory(FactoryBuilder.factoryOf(TestCacheStore.class));

        return ccfg;
    }

    /**
     * Tests that stopping a cache does not lead to a deadlock while loading data through DataStreamer.
     *
     * @throws Exception if failed.
     */
    @Test
    public void testLoadAllAndCacheStop() throws Exception {
        final AtomicReference<Exception> fail = new AtomicReference<>();

        final IgniteEx crd = startGrid(0);
        final IgniteEx node1 = startGrid(1);

        IgniteCache<Integer, String> c = node1.getOrCreateCache(DEFAULT_CACHE_NAME);

        awaitPartitionMapExchange();

        Set<Integer> keys = new HashSet<>();

        for (int i = 0; i < PART_NUM; ++i) {
            if (node1.affinity(DEFAULT_CACHE_NAME).isPrimary(node1.localNode(), i)) {
                keys.add(i);

                break;
            }
        }

        final CountDownLatch loadFinished = new CountDownLatch(1);

        GridTestUtils.runAsync(() -> {
            c.loadAll(keys, true, new CompletionListener() {
                @Override public void onCompletion() {
                    loadFinished.countDown();
                }

                @Override public void onException(Exception e) {
                    fail.compareAndSet(null, e);

                    loadFinished.countDown();
                }
            });
        });

        assertTrue(
            "loadAll() has not finished in " + TIMEOUT + " millis",
            loadFinished.await(TIMEOUT, TimeUnit.MILLISECONDS));

        assertTrue("Expected CacheException is not thrown", X.hasCause(fail.get(), CacheException.class));
    }

    /**
     * Test cache store implementation.
     */
    public static class TestCacheStore extends CacheStoreAdapter<Integer, Integer> {
        /**
         * Ignite instance.
         */
        @IgniteInstanceResource
        private Ignite ignite;

        /**
         * {@inheritDoc}
         */
        @Override public Integer load(Integer key) throws CacheLoaderException {
            // Block loading the key on the second node (non-coordinator).
            if (((IgniteEx)ignite).localNode().order() != 2)
                return key;

            // It is guaranteed that at this point cache gate is already acquired.
            TestRecordingCommunicationSpi spi = TestRecordingCommunicationSpi.spi(ignite);

            spi.blockMessages((node, msg) -> msg instanceof GridDhtPartitionsSingleMessage);

            GridTestUtils.runAsync(() -> ignite.destroyCache(DEFAULT_CACHE_NAME));

            try {
                spi.waitForBlocked(1, TIMEOUT);
            }
            catch (InterruptedException e) {
                throw new CacheLoaderException("Failed to wait partition map exchange in " + TIMEOUT + " millis", e);
            }
            finally {
                spi.stopBlock();
            }

            return key;
        }

        /**
         * {@inheritDoc}
         */
        @Override public void write(
            Cache.Entry<? extends Integer, ? extends Integer> entry) throws CacheWriterException {
            // No-op.
        }

        /**
         * {@inheritDoc}
         */
        @Override public void delete(Object key) throws CacheWriterException {
            // No-op.
        }
    }
}