/*
 * Copyright (c) 2017 Pantheon Technologies s.r.o. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.openflowplugin.impl.lifecycle;

import com.google.common.util.concurrent.Futures;
import java.util.concurrent.ExecutorService;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;
import org.opendaylight.mdsal.eos.binding.api.Entity;
import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
import org.opendaylight.mdsal.eos.common.api.EntityOwnershipStateChange;
import org.opendaylight.mdsal.singleton.api.ClusterSingletonServiceProvider;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionStatus;
import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainMastershipState;
import org.opendaylight.openflowplugin.api.openflow.mastership.MastershipChangeServiceManager;
import org.opendaylight.openflowplugin.api.openflow.mastership.ReconciliationFrameworkEvent;
import org.opendaylight.openflowplugin.api.openflow.role.RoleContext;
import org.opendaylight.openflowplugin.api.openflow.role.RoleManager;
import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
import org.opendaylight.openflowplugin.api.openflow.rpc.RpcManager;
import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
import org.opendaylight.openflowplugin.impl.mastership.MastershipChangeServiceManagerImpl;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.NonZeroUint32Type;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow.provider.config.rev160510.OpenflowProviderConfig;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.rf.state.rev170713.ResultState;
import org.opendaylight.yangtools.concepts.Registration;
import org.opendaylight.yangtools.yang.common.Uint32;
import org.opendaylight.yangtools.yang.common.Uint8;

@RunWith(MockitoJUnitRunner.class)
public class ContextChainHolderImplTest {

    private static final String ENTITY_TEST = "EntityTest";
    private static final String OPENFLOW_TEST = "openflow:test";
    private static final Uint8 AUXILIARY_ID = Uint8.ZERO;
    private static final Uint32 DEVICE_DATASTORE_REMOVAL_DELAY = Uint32.valueOf(500);
    @Mock
    private StatisticsManager statisticsManager;
    @Mock
    private RpcManager rpcManager;
    @Mock
    private DeviceManager deviceManager;
    @Mock
    private RoleManager roleManager;
    @Mock
    private StatisticsContext statisticsContext;
    @Mock
    private RpcContext rpcContext;
    @Mock
    private DeviceContext deviceContext;
    @Mock
    private RoleContext roleContext;
    @Mock
    private ConnectionContext connectionContext;
    @Mock
    private DeviceInfo deviceInfo;
    @Mock
    private ClusterSingletonServiceProvider singletonServicesProvider;
    @Mock
    private ExecutorService executorService;
    @Mock
    private Registration clusterSingletonServiceRegistration;
    @Mock
    private EntityOwnershipService entityOwnershipService;
    @Mock
    private Registration entityOwnershipListenerRegistration;
    @Mock
    private ReconciliationFrameworkEvent reconciliationFrameworkEvent;
    @Mock
    private FeaturesReply featuresReply;
    @Mock
    private OpenflowProviderConfig config;

    private ContextChainHolderImpl contextChainHolder;
    private Registration registration;
    private final MastershipChangeServiceManager manager = new MastershipChangeServiceManagerImpl();

    @Before
    public void setUp() throws Exception {
        Mockito.when(connectionContext.getDeviceInfo()).thenReturn(deviceInfo);
        Mockito.when(deviceManager.createContext(connectionContext)).thenReturn(deviceContext);
        Mockito.when(rpcManager.createContext(deviceContext)).thenReturn(rpcContext);
        Mockito.when(roleManager.createContext(deviceContext)).thenReturn(roleContext);
        Mockito.when(statisticsManager.createContext(Mockito.eq(deviceContext), Mockito.anyBoolean()))
            .thenReturn(statisticsContext);
        Mockito.when(deviceContext.getDeviceInfo()).thenReturn(deviceInfo);

        Mockito.when(singletonServicesProvider.registerClusterSingletonService(Mockito.any()))
                .thenReturn(clusterSingletonServiceRegistration);
        Mockito.when(entityOwnershipService.registerListener(Mockito.any(), Mockito.any()))
                .thenReturn(entityOwnershipListenerRegistration);
        Mockito.when(connectionContext.getFeatures()).thenReturn(featuresReply);
        Mockito.when(featuresReply.getAuxiliaryId()).thenReturn(AUXILIARY_ID);
        Mockito.when(config.getDeviceDatastoreRemovalDelay())
                .thenReturn(new NonZeroUint32Type(DEVICE_DATASTORE_REMOVAL_DELAY));

        registration = manager.reconciliationFrameworkRegistration(reconciliationFrameworkEvent);

        contextChainHolder = new ContextChainHolderImpl(
                executorService,
                singletonServicesProvider,
                entityOwnershipService,
                manager,
                config);
        contextChainHolder.addManager(statisticsManager);
        contextChainHolder.addManager(rpcManager);
        contextChainHolder.addManager(deviceManager);
        contextChainHolder.addManager(roleManager);
    }

    @Test
    public void addManager() {
        Assert.assertTrue(contextChainHolder.checkAllManagers());
    }

    @Test
    public void createContextChain() {
        contextChainHolder.createContextChain(connectionContext);
        Mockito.verify(deviceManager).createContext(Mockito.any(ConnectionContext.class));
        Mockito.verify(rpcManager).createContext(Mockito.any(DeviceContext.class));
        Mockito.verify(roleManager).createContext(Mockito.any(DeviceContext.class));
        Mockito.verify(statisticsManager).createContext(Mockito.any(DeviceContext.class), Mockito.anyBoolean());
    }


    @Test
    public void reconciliationFrameworkFailure() {
        Mockito.when(reconciliationFrameworkEvent.onDevicePrepared(deviceInfo))
            .thenReturn(Futures.immediateFailedFuture(new Throwable("test")));
        contextChainHolder.createContextChain(connectionContext);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.RPC_REGISTRATION);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.MASTER_ON_DEVICE);
        Mockito.verify(connectionContext).closeConnection(false);
    }

    @Test
    public void reconciliationFrameworkDisconnect() {
        Mockito.when(reconciliationFrameworkEvent.onDevicePrepared(deviceInfo))
            .thenReturn(Futures.immediateFuture(ResultState.DISCONNECT));
        contextChainHolder.createContextChain(connectionContext);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.RPC_REGISTRATION);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.MASTER_ON_DEVICE);
        Mockito.verify(connectionContext).closeConnection(false);
    }

    @Test
    public void reconciliationFrameworkSuccess() {
        contextChainHolder.createContextChain(connectionContext);
        Mockito.when(reconciliationFrameworkEvent.onDevicePrepared(deviceInfo))
            .thenReturn(Futures.immediateFuture(ResultState.DONOTHING));
        contextChainHolder.createContextChain(connectionContext);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.RPC_REGISTRATION);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.MASTER_ON_DEVICE);
        Mockito.verify(reconciliationFrameworkEvent).onDevicePrepared(deviceInfo);
    }

    @Test
    public void reconciliationFrameworkSuccessButNotSubmit() {
        contextChainHolder.createContextChain(connectionContext);
        Mockito.when(reconciliationFrameworkEvent.onDevicePrepared(deviceInfo))
                .thenReturn(Futures.immediateFuture(ResultState.DONOTHING));
        // TODO when if (future != null) check in MastershipChangeServiceManagerImpl's becomeSlaveOrDisconnect() is rm
        // Mockito.when(reconciliationFrameworkEvent.onDevicePrepared(deviceInfo))
        //    .thenReturn(Futures.immediateFuture(null));
        contextChainHolder.createContextChain(connectionContext);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.RPC_REGISTRATION);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.MASTER_ON_DEVICE);
        contextChainHolder.onNotAbleToStartMastershipMandatory(deviceInfo, "Test reason");
        Mockito.verify(reconciliationFrameworkEvent).onDeviceDisconnected(deviceInfo);
        Mockito.verify(connectionContext).closeConnection(false);
    }

    @Test
    public void deviceMastered() throws Exception {
        registration.close();
        contextChainHolder.createContextChain(connectionContext);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.RPC_REGISTRATION);
        Assert.assertFalse(contextChainHolder.isAnyDeviceMastered());
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.MASTER_ON_DEVICE);
        Assert.assertFalse(contextChainHolder.isAnyDeviceMastered());
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.INITIAL_SUBMIT);
        Assert.assertTrue(contextChainHolder.isAnyDeviceMastered());
        Assert.assertTrue(contextChainHolder.listOfMasteredDevices().size() == 1);
    }

    @Test
    public void deviceConnected() throws Exception {
        registration.close();
        Assert.assertTrue(contextChainHolder.deviceConnected(connectionContext)
                == ConnectionStatus.MAY_CONTINUE);
        Mockito.when(featuresReply.getAuxiliaryId()).thenReturn(Uint8.ONE);
        Assert.assertTrue(contextChainHolder.deviceConnected(connectionContext)
                == ConnectionStatus.MAY_CONTINUE);
        Mockito.when(featuresReply.getAuxiliaryId()).thenReturn(AUXILIARY_ID);
        Assert.assertTrue(contextChainHolder.deviceConnected(connectionContext)
                == ConnectionStatus.MAY_CONTINUE);
    }

    @Test
    public void notToAbleMastership() throws Exception {
        registration.close();
        contextChainHolder.deviceConnected(connectionContext);
        contextChainHolder.onNotAbleToStartMastership(deviceInfo, "Test reason", true);
        Mockito.verify(deviceContext).close();
        Mockito.verify(statisticsContext).close();
        Mockito.verify(rpcContext).close();
    }

    @Test
    public void notAbleToSetSlave() throws Exception {
        registration.close();
        contextChainHolder.deviceConnected(connectionContext);
        contextChainHolder.onSlaveRoleNotAcquired(deviceInfo, "Test reason");
        Mockito.verify(deviceContext).close();
        Mockito.verify(statisticsContext).close();
        Mockito.verify(rpcContext).close();
    }

    @Test
    public void deviceDisconnected() throws Exception {
        registration.close();
        contextChainHolder.createContextChain(connectionContext);
        contextChainHolder.onDeviceDisconnected(connectionContext);
        Mockito.verify(deviceContext).close();
        Mockito.verify(statisticsContext).close();
        Mockito.verify(rpcContext).close();
    }

    @Test
    public void onClose() throws Exception {
        registration.close();
        contextChainHolder.createContextChain(connectionContext);
        contextChainHolder.close();
        Mockito.verify(deviceContext).close();
        Mockito.verify(statisticsContext).close();
        Mockito.verify(rpcContext).close();
    }

    @Test
    public void ownershipChanged() throws Exception {
        registration.close();
        contextChainHolder.createContextChain(connectionContext);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.RPC_REGISTRATION);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.MASTER_ON_DEVICE);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.INITIAL_SUBMIT);
        contextChainHolder.ownershipChanged(new Entity(ENTITY_TEST, OPENFLOW_TEST),
            EntityOwnershipStateChange.LOCAL_OWNERSHIP_LOST_NO_OWNER, false);
        Mockito.verify(deviceManager, Mockito.timeout(1000)).removeDeviceFromOperationalDS(Mockito.any());
    }

    @Test
    public void ownershipChangedButHasOwner() throws Exception {
        registration.close();
        contextChainHolder.createContextChain(connectionContext);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.RPC_REGISTRATION);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.MASTER_ON_DEVICE);
        contextChainHolder.onMasterRoleAcquired(deviceInfo, ContextChainMastershipState.INITIAL_SUBMIT);
        contextChainHolder.ownershipChanged(new Entity(ENTITY_TEST, OPENFLOW_TEST),
            EntityOwnershipStateChange.LOCAL_OWNERSHIP_LOST_NEW_OWNER, false);
        Mockito.verify(deviceManager,Mockito.never()).removeDeviceFromOperationalDS(Mockito.any());
    }
}