[GitHub] incubator-brooklyn pull request: Add EntityAsserts and HttpUtils.

[ahgittin <gi...@git.apache.org>]

Github user ahgittin commented on a diff in the pull request:

    https://github.com/apache/incubator-brooklyn/pull/994#discussion_r43643555
  
    --- Diff: core/src/main/java/org/apache/brooklyn/core/entity/EntityAsserts.java ---
    @@ -0,0 +1,192 @@
    +/*
    + * 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 com.google.common.annotations.Beta;
    +import com.google.common.base.Objects;
    +import com.google.common.base.Predicate;
    +import com.google.common.base.Predicates;
    +import com.google.common.collect.ImmutableMap;
    +import com.google.common.collect.Maps;
    +import com.google.common.collect.Sets;
    +import org.apache.brooklyn.api.entity.Entity;
    +import org.apache.brooklyn.api.entity.Group;
    +import org.apache.brooklyn.api.mgmt.SubscriptionHandle;
    +import org.apache.brooklyn.api.sensor.AttributeSensor;
    +import org.apache.brooklyn.api.sensor.SensorEvent;
    +import org.apache.brooklyn.api.sensor.SensorEventListener;
    +import org.apache.brooklyn.config.ConfigKey;
    +import org.apache.brooklyn.test.Asserts;
    +
    +import java.util.Collection;
    +import java.util.Map;
    +import java.util.Set;
    +import java.util.concurrent.atomic.AtomicBoolean;
    +import java.util.concurrent.atomic.AtomicReference;
    +
    +import static org.apache.brooklyn.test.Asserts.assertEquals;
    +
    +/**
    + * Convenience class containing assertions that may be made about entities.
    + */
    +public class EntityAsserts {
    +
    +
    +    public static <T> void assertAttributeEquals(Entity entity, AttributeSensor<T> attribute, T expected) {
    +        assertEquals(entity.getAttribute(attribute), expected, "entity=" + entity + "; attribute=" + attribute);
    +    }
    +
    +    public static <T> void assertConfigEquals(Entity entity, ConfigKey<T> configKey, T expected) {
    +        assertEquals(entity.getConfig(configKey), expected, "entity=" + entity + "; configKey=" + configKey);
    +    }
    +
    +    public static <T> void assertAttributeEqualsEventually(final Entity entity, final AttributeSensor<T> attribute, final T expected) {
    +        assertAttributeEqualsEventually(Maps.newLinkedHashMap(), entity, attribute, expected);
    +    }
    +
    +    public static <T> void assertAttributeEqualsEventually(Map<?,?> flags, final Entity entity, final AttributeSensor<T> attribute, final T expected) {
    +        // Not using assertAttributeEventually(predicate) so get nicer error message
    +        Asserts.succeedsEventually((Map) flags, new Runnable() {
    +            @Override
    +            public void run() {
    +                assertAttributeEquals(entity, attribute, expected);
    +            }
    +        });
    +    }
    +
    +    public static <T> T assertAttributeEventuallyNonNull(final Entity entity, final AttributeSensor<T> attribute) {
    +        return assertAttributeEventuallyNonNull(Maps.newLinkedHashMap(), entity, attribute);
    +    }
    +
    +    public static <T> T assertAttributeEventuallyNonNull(Map<?,?> flags, final Entity entity, final AttributeSensor<T> attribute) {
    +        return assertAttributeEventually(flags, entity, attribute, Predicates.notNull());
    +    }
    +
    +    public static <T> T assertAttributeEventually(final Entity entity, final AttributeSensor<T> attribute, Predicate<? super T> predicate) {
    +        return assertAttributeEventually(ImmutableMap.of(), entity, attribute, predicate);
    +    }
    +
    +    public static <T> T assertAttributeEventually(Map<?,?> flags, final Entity entity, final AttributeSensor<T> attribute, final Predicate<? super T> predicate) {
    +        final AtomicReference<T> result = new AtomicReference<T>();
    +        Asserts.succeedsEventually((Map)flags, new Runnable() {
    +            @Override public void run() {
    +                T val = entity.getAttribute(attribute);
    +                Asserts.assertTrue(predicate.apply(val), "val=" + val);
    +                result.set(val);
    +            }});
    +        return result.get();
    +    }
    +
    +    public static <T> T assertAttribute(final Entity entity, final AttributeSensor<T> attribute, final Predicate<? super T> predicate) {
    +        T val = entity.getAttribute(attribute);
    +        Asserts.assertTrue(predicate.apply(val), "val=" + val);
    +        return val;
    +    }
    +
    +
    +    public static <T extends Entity> void assertPredicateEventuallyTrue(final T entity, final Predicate<? super T> predicate) {
    +        assertPredicateEventuallyTrue(Maps.newLinkedHashMap(), entity, predicate);
    +    }
    +
    +    public static <T extends Entity> void assertPredicateEventuallyTrue(Map<?,?> flags, final T entity, final Predicate<? super T> predicate) {
    +        Asserts.succeedsEventually((Map)flags, new Runnable() {
    +            @Override public void run() {
    +                Asserts.assertTrue(predicate.apply(entity), "predicate unsatisfied");
    +            }});
    +    }
    +
    +    public static <T> void assertAttributeEqualsContinually(final Entity entity, final AttributeSensor<T> attribute, final T expected) {
    +        assertAttributeEqualsContinually(Maps.newLinkedHashMap(), entity, attribute, expected);
    +    }
    +
    +    public static <T> void assertAttributeEqualsContinually(Map<?,?> flags, final Entity entity, final AttributeSensor<T> attribute, final T expected) {
    +        Asserts.succeedsContinually(flags, new Runnable() {
    +            @Override public void run() {
    +                assertAttributeEquals(entity, attribute, expected);
    +            }});
    +    }
    +
    +    public static void assertGroupSizeEqualsEventually(final Group group, int expected) {
    +        assertGroupSizeEqualsEventually(ImmutableMap.of(), group, expected);
    +    }
    +
    +    public static void assertGroupSizeEqualsEventually(Map<?,?> flags, final Group group, final int expected) {
    +        Asserts.succeedsEventually((Map)flags, new Runnable() {
    +            @Override public void run() {
    +                Collection<Entity> members = group.getMembers();
    +                assertEquals(members.size(), expected, "members=" + members);
    +            }});
    +    }
    +
    +
    +    /**
    +     * Asserts that the entity's value for this attribute changes, by registering a subscription and checking the value.
    +     *
    +     * @param entity The entity whose attribute will be checked.
    +     * @param attribute The attribute to check on the entity.
    +     *
    +     * @throws AssertionError if the assertion fails.
    +     */
    +    public static void assertAttributeChangesEventually(final Entity entity, final AttributeSensor<?> attribute) {
    +        final Object origValue = entity.getAttribute(attribute);
    +        final AtomicBoolean changed = new AtomicBoolean();
    +        SubscriptionHandle handle = entity.subscriptions().subscribe(entity, attribute, new SensorEventListener<Object>() {
    +            @Override public void onEvent(SensorEvent<Object> event) {
    +                if (!Objects.equal(origValue, event.getValue())) {
    +                    changed.set(true);
    +                }
    +            }});
    +        try {
    +            Asserts.succeedsEventually(new Runnable() {
    +                @Override public void run() {
    +                    Asserts.assertTrue(changed.get(), entity + " -> " + attribute + " not changed");
    +                }});
    +        } finally {
    +            entity.subscriptions().unsubscribe(entity, handle);
    +        }
    +    }
    +
    +
    +    @Beta @SafeVarargs
    +    public static <T> void assertAttributeNever(final Entity entity, final AttributeSensor<T> attribute, T... disallowed) {
    --- End diff --
    
    can we call this `assertAttributeContinuallyNotEqualTo`?
    
    add javadoc noting that this loops checking the value, it does not currently set up a subscription so a disallowed value might come up very quickly and be missed.  (we could fix this if needed.)
    
    cleaner would be for this to call the next method, `assertAttribute...(Map, ...)`, with `null` flags, or perhaps to introduce an `assertAttributeContinually(..., Predicate)` and build up a predicate of `not(or(equalTo(disallowed[0]), equalTo(disallowed[1]), ...))`


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---