/*
 * 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.assertNotNull;
import static org.testng.Assert.fail;

import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import org.apache.brooklyn.api.entity.EntitySpec;
import org.apache.brooklyn.api.policy.Policy;
import org.apache.brooklyn.api.policy.PolicySpec;
import org.apache.brooklyn.api.sensor.EnricherSpec;
import org.apache.brooklyn.api.sensor.SensorEvent;
import org.apache.brooklyn.api.sensor.SensorEventListener;
import org.apache.brooklyn.core.enricher.AbstractEnricher;
import org.apache.brooklyn.core.entity.lifecycle.PolicyDescriptor;
import org.apache.brooklyn.core.policy.AbstractPolicy;
import org.apache.brooklyn.core.test.BrooklynAppUnitTestSupport;
import org.apache.brooklyn.core.test.entity.TestEntity;
import org.apache.brooklyn.core.test.entity.TestEntityNoEnrichersImpl;
import org.apache.brooklyn.test.Asserts;
import org.apache.brooklyn.util.collections.MutableMap;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;

public class PolicyRegistrationTest extends BrooklynAppUnitTestSupport {

    private static final int TIMEOUT_MS = 10*1000;
    
    private TestEntity entity;

    private List<PolicyDescriptor> added;
    private List<PolicyDescriptor> removed;

    @BeforeMethod(alwaysRun=true)
    @Override
    public void setUp() throws Exception {
        super.setUp();
        entity = app.createAndManageChild(EntitySpec.create(TestEntity.class).impl(TestEntityNoEnrichersImpl.class));
        
        added = Lists.newCopyOnWriteArrayList();
        removed = Lists.newCopyOnWriteArrayList();
        
        app.subscriptions().subscribe(entity, AbstractEntity.POLICY_ADDED, new SensorEventListener<PolicyDescriptor>() {
            @Override public void onEvent(SensorEvent<PolicyDescriptor> event) {
                added.add(event.getValue());
            }});
        app.subscriptions().subscribe(entity, AbstractEntity.POLICY_REMOVED, new SensorEventListener<PolicyDescriptor>() {
                @Override public void onEvent(SensorEvent<PolicyDescriptor> event) {
                    removed.add(event.getValue());
                }});
    }
    
    @Test
    public void testGetPoliciesIsInitiallyEmpty() {
        assertEquals(ImmutableList.copyOf(entity.policies()), ImmutableList.of());
    }

    @Test(expectedExceptions = { UnsupportedOperationException.class })
    @SuppressWarnings("deprecation")
    public void testGetPoliciesReturnsImmutableCollection() {
        entity.getPolicies().add(new MyPolicy());
        fail();
    }

    @Test(expectedExceptions = { UnsupportedOperationException.class })
    public void testPoliciesAsListReturnsImmutableCollection() {
        entity.policies().asList().add(new MyPolicy());
        fail();
    }

    @Test(expectedExceptions = { UnsupportedOperationException.class })
    public void testPoliciesIteratorReturnsImmutable() {
        entity.policies().add(PolicySpec.create(MyPolicy.class));
        Iterator<Policy> iterator = entity.policies().iterator();
        iterator.next();
        iterator.remove();
        fail();
    }

    @Test
    public void testAddAndRemovePolicies() {
        MyPolicy policy1 = entity.policies().add(PolicySpec.create(MyPolicy.class));
        assertEquals(ImmutableList.copyOf(entity.policies()), ImmutableList.of(policy1));
        assertEqualsEventually(added, ImmutableList.of(new PolicyDescriptor(policy1)));
        
        MyPolicy policy2 = entity.policies().add(PolicySpec.create(MyPolicy.class));
        assertEquals(ImmutableList.copyOf(entity.policies()), ImmutableList.of(policy1, policy2));
        assertEqualsEventually(added, ImmutableList.of(new PolicyDescriptor(policy1), new PolicyDescriptor(policy2)));
        
        entity.policies().remove(policy1);
        assertEquals(ImmutableList.copyOf(entity.policies()), ImmutableList.of(policy2));
        assertEqualsEventually(removed, ImmutableList.of(new PolicyDescriptor(policy1)));
        
        entity.policies().remove(policy2);
        assertEquals(ImmutableList.copyOf(entity.policies()), ImmutableList.of());
        assertEqualsEventually(removed, ImmutableList.of(new PolicyDescriptor(policy1), new PolicyDescriptor(policy2)));
    }

    @Test
    public void testAddPolicySpec() {
        MyPolicy policy = entity.policies().add(PolicySpec.create(MyPolicy.class));
        assertNotNull(policy);
        assertEquals(ImmutableList.copyOf(entity.policies()), ImmutableList.of(policy));
        assertEqualsEventually(added, ImmutableList.of(new PolicyDescriptor(policy)));
    }
    
    @Test
    public void testAddEnricherSpec() {
        MyEnricher enricher = entity.enrichers().add(EnricherSpec.create(MyEnricher.class));
        assertNotNull(enricher);
        assertEquals(ImmutableList.copyOf(entity.enrichers()), ImmutableList.of(enricher));
    }

    @Test
    public void testRemoveAllPolicies() {
        MyPolicy policy1 = entity.policies().add(PolicySpec.create(MyPolicy.class));
        MyPolicy policy2 = entity.policies().add(PolicySpec.create(MyPolicy.class));
        entity.policies().removeAllPolicies();
        
        assertEquals(ImmutableList.copyOf(entity.policies()), ImmutableList.of());
        assertCollectionEqualsEventually(removed, ImmutableSet.of(new PolicyDescriptor(policy1), new PolicyDescriptor(policy2)));
    }
    
    private <T> void assertEqualsEventually(final T actual, final T expected) {
        Asserts.succeedsEventually(MutableMap.of("timeout", TIMEOUT_MS), new Runnable() {
                @Override public void run() {
                    assertEquals(actual, expected, "actual="+actual);
                }});
    }
    
    // Ignores order of vals in collection, but asserts each same size and same elements 
    private <T> void assertCollectionEqualsEventually(final Collection<? extends T> actual, final Collection<? extends T> expected) {
        Asserts.succeedsEventually(MutableMap.of("timeout", TIMEOUT_MS), new Runnable() {
                @Override public void run() {
                    assertEquals(ImmutableSet.copyOf(actual), ImmutableSet.copyOf(expected), "actual="+actual);
                    assertEquals(actual.size(), expected.size(), "actual="+actual);
                }});
    }
    
    public static class MyPolicy extends AbstractPolicy {
    }
    
    public static class MyEnricher extends AbstractEnricher {
    }
}
