/*
* 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.brooklyn.core.entity;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import org.apache.brooklyn.api.entity.Application;
import org.apache.brooklyn.api.entity.EntitySpec;
import org.apache.brooklyn.api.sensor.AttributeSensor;
import org.apache.brooklyn.core.sensor.AttributeMap;
import org.apache.brooklyn.core.sensor.Sensors;
import org.apache.brooklyn.core.test.entity.TestApplication;
import org.apache.brooklyn.core.test.entity.TestEntity;
import org.apache.brooklyn.core.test.entity.TestEntityImpl;
import org.apache.brooklyn.test.Asserts;
import org.apache.brooklyn.util.collections.MutableMap;
import org.apache.brooklyn.util.guava.Maybe;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import com.google.common.base.Function;
import com.google.common.base.Functions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
public class AttributeMapTest {
final int NUM_TASKS = Math.min(500 * Runtime.getRuntime().availableProcessors(), 1000);
Application app;
TestEntity entity;
TestEntityImpl entityImpl;
AttributeMap map;
ExecutorService executor;
@BeforeMethod(alwaysRun=true)
public void setUp() {
app = TestApplication.Factory.newManagedInstanceForTests();
TestEntity entity = app.addChild(EntitySpec.create(TestEntity.class));
entityImpl = (TestEntityImpl) Entities.deproxy(entity);
map = new AttributeMap(entityImpl, Collections.synchronizedMap(MutableMap.<Collection<String>,Object>of()));
executor = Executors.newCachedThreadPool();
}
@AfterMethod(alwaysRun=true)
public void tearDown() {
if (executor != null) executor.shutdownNow();
if (app != null) Entities.destroyAll(app.getManagementContext());
}
// See ENGR-2111
@Test
public void testConcurrentUpdatesDoNotCauseConcurrentModificationException() throws Exception {
List<Future<?>> futures = Lists.newArrayList();
for (int i = 0; i < NUM_TASKS; i++) {
final AttributeSensor<String> nextSensor = Sensors.newStringSensor("attributeMapTest.exampleSensor"+i, "");
Future<?> future = executor.submit(newUpdateMapRunnable(map, nextSensor, "a"));
futures.add(future);
}
for (Future<?> future : futures) {
future.get();
}
}
@Test
public void testConcurrentUpdatesAndGetsDoNotCauseConcurrentModificationException() throws Exception {
List<Future<?>> futures = Lists.newArrayList();
for (int i = 0; i < NUM_TASKS; i++) {
final AttributeSensor<String> nextSensor = Sensors.newStringSensor("attributeMapTest.exampleSensor"+i, "");
Future<?> future = executor.submit(newUpdateMapRunnable(map, nextSensor, "a"));
Future<?> future2 = executor.submit(newGetAttributeCallable(map, nextSensor));
futures.add(future);
futures.add(future2);
}
for (Future<?> future : futures) {
future.get();
}
}
@Test
public void testConcurrentUpdatesAllApplied() throws Exception {
List<Future<?>> futures = Lists.newArrayList();
for (int i = 0; i < NUM_TASKS; i++) {
AttributeSensor<Integer> nextSensor = Sensors.newIntegerSensor("attributeMapTest.exampleSensor"+i);
Future<?> future = executor.submit(newUpdateMapRunnable(map, nextSensor, i));
futures.add(future);
}
for (Future<?> future : futures) {
future.get();
}
for (int i = 0; i < NUM_TASKS; i++) {
AttributeSensor<Integer> nextSensor = Sensors.newIntegerSensor("attributeMapTest.exampleSensor"+i);
assertEquals(map.getValue(nextSensor), (Integer)i);
}
}
@Test
public void testStoredSensorsCanBeRetrieved() throws Exception {
AttributeSensor<String> sensor1 = Sensors.newStringSensor("a", "");
AttributeSensor<String> sensor2 = Sensors.newStringSensor("b.c", "");
map.update(sensor1, "1val");
map.update(sensor2, "2val");
assertEquals(map.getValue(sensor1), "1val");
assertEquals(map.getValue(sensor2), "2val");
assertEquals(map.getValue(ImmutableList.of("a")), "1val");
assertEquals(map.getValue(ImmutableList.of("b","c")), "2val");
}
@Test
public void testStoredByPathCanBeRetrieved() throws Exception {
AttributeSensor<String> sensor1 = Sensors.newStringSensor("a", "");
AttributeSensor<String> sensor2 = Sensors.newStringSensor("b.c", "");
map.update(ImmutableList.of("a"), "1val");
map.update(ImmutableList.of("b", "c"), "2val");
assertEquals(map.getValue(sensor1), "1val");
assertEquals(map.getValue(sensor2), "2val");
assertEquals(map.getValue(ImmutableList.of("a")), "1val");
assertEquals(map.getValue(ImmutableList.of("b","c")), "2val");
}
@Test
public void testCanStoreSensorThenChildSensor() throws Exception {
AttributeSensor<String> sensor = Sensors.newStringSensor("a", "");
AttributeSensor<String> childSensor = Sensors.newStringSensor("a.b", "");
map.update(sensor, "parentValue");
map.update(childSensor, "childValue");
assertEquals(map.getValue(childSensor), "childValue");
assertEquals(map.getValue(sensor), "parentValue");
}
@Test
public void testCanStoreChildThenParentSensor() throws Exception {
AttributeSensor<String> sensor = Sensors.newStringSensor("a", "");
AttributeSensor<String> childSensor = Sensors.newStringSensor("a.b", "");
map.update(childSensor, "childValue");
map.update(sensor, "parentValue");
assertEquals(map.getValue(childSensor), "childValue");
assertEquals(map.getValue(sensor), "parentValue");
}
@Test
public void testConcurrentModifyAttributeCalls() throws Exception {
AttributeSensor<Integer> sensor = Sensors.newIntegerSensor("a", "");
Function<Integer, Maybe<Integer>> modifier = new Function<Integer, Maybe<Integer>>() {
@Override public Maybe<Integer> apply(Integer input) {
return Maybe.of((input == null) ? 1 : input + 1);
}
};
List<Future<?>> futures = Lists.newArrayList();
for (int i = 0; i < NUM_TASKS; i++) {
Future<?> future = executor.submit(newModifyAttributeCallable(map, sensor, modifier));
futures.add(future);
}
for (Future<?> future : futures) {
future.get();
}
assertEquals(map.getValue(sensor), Integer.valueOf(NUM_TASKS));
}
@Test
public void testModifyAttributeReturningAbsentDoesNotEmit() throws Exception {
AttributeSensor<Integer> sensor = Sensors.newIntegerSensor("a", "");
AttributeSensor<Integer> childSensor = Sensors.newIntegerSensor("a.b", "");
final RecordingSensorEventListener<Object> listener = new RecordingSensorEventListener<>();
entityImpl.subscriptions().subscribe(entityImpl, sensor, listener);
map.modify(childSensor, Functions.constant(Maybe.<Integer>absent()));
Asserts.succeedsContinually(new Runnable() {
@Override public void run() {
assertTrue(Iterables.isEmpty(listener.getEvents()), "events="+listener.getEvents());
}});
}
protected <T> Runnable newUpdateMapRunnable(final AttributeMap map, final AttributeSensor<T> attribute, final T val) {
return new Runnable() {
@Override public void run() {
map.update(attribute, val);
}
};
}
protected <T> Callable<T> newGetAttributeCallable(final AttributeMap map, final AttributeSensor<T> attribute) {
return new Callable<T>() {
@Override public T call() {
return map.getValue(attribute);
}
};
}
protected <T> Callable<T> newModifyAttributeCallable(final AttributeMap map, final AttributeSensor<T> attribute, final Function<? super T, Maybe<T>> modifier) {
return new Callable<T>() {
@Override public T call() {
return map.modify(attribute, modifier);
}
};
}
}