/*
* Copyright (c) 2008-2017, Hazelcast, Inc. All Rights Reserved.
*
* Licensed 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 com.hazelcast.client.map;
import com.hazelcast.client.test.TestHazelcastFactory;
import com.hazelcast.config.Config;
import com.hazelcast.config.MapConfig;
import com.hazelcast.core.HazelcastInstance;
import com.hazelcast.core.IMap;
import com.hazelcast.core.TransactionalMap;
import com.hazelcast.map.QueryResultSizeExceededException;
import com.hazelcast.map.impl.query.QueryResultSizeLimiter;
import com.hazelcast.query.TruePredicate;
import com.hazelcast.spi.properties.GroupProperty;
import com.hazelcast.transaction.TransactionContext;
import com.hazelcast.util.EmptyStatement;
import com.hazelcast.util.ExceptionUtil;
import org.junit.After;
import java.util.UUID;
import static java.lang.String.format;
import static java.lang.String.valueOf;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
public abstract class ClientMapUnboundReturnValuesTestSupport {
protected static final int PARTITION_COUNT = 271;
protected static final int SMALL_LIMIT = QueryResultSizeLimiter.MINIMUM_MAX_RESULT_LIMIT;
protected static final int PRE_CHECK_TRIGGER_LIMIT_INACTIVE = -1;
protected static final int PRE_CHECK_TRIGGER_LIMIT_ACTIVE = Integer.MAX_VALUE;
private final TestHazelcastFactory hazelcastFactory = new TestHazelcastFactory();
private HazelcastInstance instance;
private IMap<Integer, Integer> serverMap;
private IMap<Integer, Integer> clientMap;
private int configLimit;
private int upperLimit;
@After
public void tearDown() {
if (serverMap != null) {
serverMap.destroy();
}
hazelcastFactory.terminateAll();
}
/**
* This test calls {@link IMap} methods once which are expected to throw {@link QueryResultSizeExceededException}.
* <p/>
* This test fills the map to an amount where the exception is safely triggered. Then all {@link IMap} methods are called
* which should trigger the exception.
* <p/>
* This test fails if any of the called methods does not trigger the exception.
*
* @param partitionCount number of partitions the created cluster
* @param limit result size limit which will be configured for the cluster
* @param preCheckTrigger number of partitions which will be used for local pre-check, <tt>-1</tt> deactivates the pre-check
*/
protected void runClientMapTestWithException(int partitionCount, int limit, int preCheckTrigger) {
internalSetUpClient(partitionCount, 1, limit, preCheckTrigger);
fillToUpperLimit(serverMap, clientMap);
internalRunWithException(clientMap);
}
/**
* This test calls {@link IMap} methods which have to be implemented but are not supported by the client.
* <p/>
* This methods fails if any of the called methods does not throw a {@link UnsupportedOperationException}.
*/
protected void runClientMapTestCheckUnsupported() {
internalSetUpClient(PARTITION_COUNT, 1, 1, PRE_CHECK_TRIGGER_LIMIT_INACTIVE);
internalRunCheckUnsupported(clientMap);
}
/**
* Test which calls {@link TransactionalMap} methods which are expected to throw {@link QueryResultSizeExceededException}.
* <p/>
* This test fills the map to an amount where the exception is safely triggered. Then all {@link TransactionalMap} methods are
* called which should trigger the exception.
* <p/>
* This test fails if any of the called methods does not trigger the exception.
*
* @param partitionCount number of partitions the created cluster
* @param limit result size limit which will be configured for the cluster
* @param preCheckTrigger number of partitions which will be used for local pre-check, <tt>-1</tt> deactivates the pre-check
*/
protected void runClientMapTestTxn(int partitionCount, int limit, int preCheckTrigger) {
internalSetUpClient(partitionCount, 1, limit, preCheckTrigger);
fillToUpperLimit(serverMap, clientMap);
internalRunTxn(clientMap.getName());
}
private void internalSetUpClient(int partitionCount, int clusterSize, int limit, int preCheckTrigger) {
Config config = createConfig(partitionCount, limit, preCheckTrigger);
serverMap = getMapWithNodeCount(clusterSize, config);
instance = hazelcastFactory.newHazelcastClient();
clientMap = instance.getMap(serverMap.getName());
configLimit = limit;
upperLimit = Math.round(limit * 1.5f);
}
private Config createConfig(int partitionCount, int limit, int preCheckTrigger) {
Config config = new Config();
config.setProperty(GroupProperty.PARTITION_COUNT.getName(), valueOf(partitionCount));
config.setProperty(GroupProperty.QUERY_RESULT_SIZE_LIMIT.getName(), valueOf(limit));
config.setProperty(GroupProperty.QUERY_MAX_LOCAL_PARTITION_LIMIT_FOR_PRE_CHECK.getName(), valueOf(preCheckTrigger));
return config;
}
private <K, V> IMap<K, V> getMapWithNodeCount(int nodeCount, Config config) {
String mapName = UUID.randomUUID().toString();
MapConfig mapConfig = new MapConfig();
mapConfig.setName(mapName);
mapConfig.setAsyncBackupCount(0);
mapConfig.setBackupCount(0);
config.addMapConfig(mapConfig);
while (nodeCount > 1) {
hazelcastFactory.newHazelcastInstance(config);
nodeCount--;
}
HazelcastInstance node = hazelcastFactory.newHazelcastInstance(config);
return node.getMap(mapName);
}
private void fillToUpperLimit(IMap<Integer, Integer> fillMap, IMap<Integer, Integer> queryMap) {
for (int index = 1; index <= upperLimit; index++) {
fillMap.put(index, index);
}
assertEquals("Expected map size of server map to match upperLimit", upperLimit, fillMap.size());
assertEquals("Expected map size of client map to match upperLimit", upperLimit, queryMap.size());
}
private void checkException(QueryResultSizeExceededException e) {
String exception = ExceptionUtil.toString(e);
if (exception.contains("QueryPartitionOperation")) {
fail("QueryResultSizeExceededException was thrown by QueryPartitionOperation:\n" + exception);
}
}
private void failExpectedException(String methodName) {
fail(format("Expected QueryResultSizeExceededException while calling %s with limit %d and upperLimit %d",
methodName, configLimit, upperLimit));
}
private void failUnwantedException(String methodName) {
fail(format("Unwanted QueryResultSizeExceededException was thrown while calling %s with limit %d and upperLimit %d",
methodName, configLimit, upperLimit));
}
/**
* Calls {@link IMap} methods once which are expected to throw {@link QueryResultSizeExceededException}.
* <p/>
* This method requires the map to be filled to an amount where the exception is safely triggered.
* <p/>
* This methods fails if any of the called methods does not trigger the exception.
*/
private void internalRunWithException(IMap<Integer, Integer> queryMap) {
try {
queryMap.values(TruePredicate.INSTANCE);
failExpectedException("IMap.values(predicate)");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
try {
queryMap.keySet(TruePredicate.INSTANCE);
failExpectedException("IMap.keySet(predicate)");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
try {
queryMap.entrySet(TruePredicate.INSTANCE);
failExpectedException("IMap.entrySet(predicate)");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
try {
queryMap.values();
failExpectedException("IMap.values()");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
try {
queryMap.keySet();
failExpectedException("IMap.keySet()");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
try {
queryMap.entrySet();
failExpectedException("IMap.entrySet()");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
}
/**
* Calls {@link IMap} methods which have to be implemented but are not supported by the client.
* <p/>
* This methods fails if any of the called methods does not throw a {@link UnsupportedOperationException}.
*/
private void internalRunCheckUnsupported(IMap<Integer, Integer> queryMap) {
try {
queryMap.localKeySet();
failExpectedException("IMap.localKeySet()");
} catch (UnsupportedOperationException e) {
EmptyStatement.ignore(e);
} catch (QueryResultSizeExceededException e) {
failUnwantedException("IMap.localKeySet()");
}
try {
queryMap.localKeySet(TruePredicate.INSTANCE);
failExpectedException("IMap.localKeySet(predicate)");
} catch (UnsupportedOperationException e) {
EmptyStatement.ignore(e);
} catch (QueryResultSizeExceededException e) {
failUnwantedException("IMap.localKeySet()");
}
}
/**
* Calls {@link TransactionalMap} methods once which are expected to throw {@link QueryResultSizeExceededException}.
* <p/>
* This method requires the map to be filled to an amount where the exception is safely triggered.
* <p/>
* This methods fails if any of the called methods does not trigger the exception.
*/
private void internalRunTxn(String mapName) {
TransactionContext transactionContext = instance.newTransactionContext();
try {
transactionContext.beginTransaction();
TransactionalMap<Object, Integer> txnMap = transactionContext.getMap(mapName);
try {
txnMap.values(TruePredicate.INSTANCE);
failExpectedException("TransactionalMap.values(predicate)");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
try {
txnMap.keySet(TruePredicate.INSTANCE);
failExpectedException("TransactionalMap.keySet(predicate)");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
try {
txnMap.values();
failExpectedException("TransactionalMap.values()");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
try {
txnMap.keySet();
failExpectedException("TransactionalMap.keySet()");
} catch (QueryResultSizeExceededException e) {
checkException(e);
}
} finally {
transactionContext.rollbackTransaction();
}
}
}