openstack/net-virt-providers/src/test/java/org/opendaylight/ovsdb/openstack/netvirt/providers/openflow13/AbstractServiceInstanceTest.java

   1 /*
   2  * Copyright (c) 2015 Inocybe and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.ovsdb.openstack.netvirt.providers.openflow13;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.mockito.Matchers.any;
  15 import static org.mockito.Matchers.anyString;
  16 import static org.mockito.Matchers.eq;
  17 import static org.mockito.Mockito.mock;
  18 import static org.mockito.Mockito.times;
  19 import static org.mockito.Mockito.verify;
  20 import static org.mockito.Mockito.when;
  21
  22 import java.lang.reflect.Field;
  23
  24 import org.junit.Test;
  25 import org.junit.runner.RunWith;
  26 import org.mockito.InjectMocks;
  27 import org.mockito.Mock;
  28 import org.mockito.Mockito;
  29 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  30 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  31 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  32 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  33 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  34 import org.opendaylight.ovsdb.openstack.netvirt.api.Constants;
  35 import org.opendaylight.ovsdb.openstack.netvirt.api.Southbound;
  36 import org.opendaylight.ovsdb.utils.servicehelper.ServiceHelper;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  45 import org.opendaylight.yangtools.yang.binding.DataObject;
  46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  47 import org.osgi.framework.ServiceReference;
  48 import org.powermock.api.mockito.PowerMockito;
  49 import org.powermock.modules.junit4.PowerMockRunner;
  50
  51 import com.google.common.base.Optional;
  52 import com.google.common.util.concurrent.CheckedFuture;
  53
  54 /**
  55  * Unit test for {@link AbstractServiceInstance}
  56  */
  57 //@PrepareForTest(ServiceHelper.class)
  58 @RunWith(PowerMockRunner.class)
  59 @SuppressWarnings("unchecked")
  60 public class AbstractServiceInstanceTest {
  61
  62     @InjectMocks private AbstractServiceInstance abstractServiceInstance = mock(AbstractServiceInstance.class, Mockito.CALLS_REAL_METHODS);
  63
  64     @Mock private DataBroker dataBroker;
  65     @Mock private PipelineOrchestrator orchestrator;
  66     @Mock private Southbound southbound;
  67
  68     private Service service = Service.L3_FORWARDING;
  69
  70     private final String ID = "5710881121";
  71     private final String NODE_ID = Constants.INTEGRATION_BRIDGE + ":" +  ID;
  72
  73     /**
  74      * Test method {@link AbstractServiceInstance#isBridgeInPipeline(String)}
  75      */
  76     @Test
  77     public void testIsBridgeInPipeline() {
  78         when(southbound.getBridgeName(any(Node.class))).thenReturn(Constants.INTEGRATION_BRIDGE);
  79         assertTrue("Error, isBridgeInPipeline() did not return the correct value", abstractServiceInstance.isBridgeInPipeline(mock(Node.class)));
  80     }
  81
  82     /**
  83      * Test method {@link AbstractServiceInstance#getTable()}
  84      */
  85     @Test
  86     public void testGetTable() {
  87         abstractServiceInstance.setService(service);
  88         assertEquals("Error, getTable() did not return the correct value", 70, abstractServiceInstance.getTable());
  89     }
  90
  91     @Test
  92     public void testGetService() {
  93         abstractServiceInstance.setService(service);
  94         assertEquals("Error, getService() did not return the correct value", service, abstractServiceInstance.getService());
  95     }
  96
  97     /**
  98      * Test method {@link AbstractServiceInstance#createNodeBuilder(String)}
  99      */
 100     @Test
 101     public void testCreateNodeBuilder() {
 102         NodeId nodeId = mock(NodeId.class);
 103         when(nodeId.getValue()).thenReturn(NODE_ID);
 104
 105         NodeBuilder nodeBuilder = abstractServiceInstance.createNodeBuilder(NODE_ID);
 106         assertNotNull("Error, createNodeBuilder() did not return the correct value", nodeBuilder);
 107         assertEquals("Error, createNodeBuilder() did not return the correct ID", NODE_ID, nodeBuilder.getId().getValue());
 108         assertEquals("Error, createNodeBuilder() did not return the correct Key", new NodeKey(nodeBuilder.getId()), nodeBuilder.getKey());
 109     }
 110
 111     /**
 112      * Test method {@link AbstractServiceInstance#getMutablePipelineInstructionBuilder()}
 113      */
 114     @Test
 115     public void testGetMutablePipelineInstructionBuilder() {
 116         // service == null
 117         assertNotNull("Error, getMutablePipelineInstructionBuilder() did not return the correct value", abstractServiceInstance.getMutablePipelineInstructionBuilder());
 118         assertTrue("Error, getMutablePipelineInstructionBuilder() did not return a InstructionBuilder object", abstractServiceInstance.getMutablePipelineInstructionBuilder() instanceof InstructionBuilder);
 119
 120         when(orchestrator.getNextServiceInPipeline(any(Service.class))).thenReturn(Service.ARP_RESPONDER);
 121
 122         // service defined
 123         assertNotNull("Error, getMutablePipelineInstructionBuilder() did not return the correct value", abstractServiceInstance.getMutablePipelineInstructionBuilder());
 124         assertTrue("Error, getMutablePipelineInstructionBuilder() did not return a InstructionBuilder object", abstractServiceInstance.getMutablePipelineInstructionBuilder() instanceof InstructionBuilder);
 125     }
 126
 127     /**
 128      * Test method {@link AbstractServiceInstance#writeFlow(FlowBuilder, NodeBuilder)}
 129      */
 130     @Test
 131     public void testWriteFlow() throws Exception {
 132         WriteTransaction transaction = mock(WriteTransaction.class);
 133         when(dataBroker.newWriteOnlyTransaction()).thenReturn(transaction);
 134         CheckedFuture<Void, TransactionCommitFailedException> commitFuture = mock(CheckedFuture.class);
 135         when(transaction.submit()).thenReturn(commitFuture);
 136
 137         NodeBuilder nodeBuilder = mock(NodeBuilder.class);
 138         when(nodeBuilder.getKey()).thenReturn(mock(NodeKey.class));
 139
 140         FlowBuilder flowBuilder = mock(FlowBuilder.class);
 141         when(flowBuilder.getKey()).thenReturn(mock(FlowKey.class));
 142
 143         abstractServiceInstance.writeFlow(flowBuilder, nodeBuilder);
 144
 145         verify(transaction, times(2)).put(eq(LogicalDatastoreType.CONFIGURATION), any(InstanceIdentifier.class), any(DataObject.class), eq(true));
 146         verify(commitFuture, times(1)).get();
 147     }
 148
 149     /**
 150      * Test method {@link AbstractServiceInstance#removeFlow(FlowBuilder, NodeBuilder)}
 151      */
 152     @Test
 153     public void testRemoveFlow() throws Exception {
 154         WriteTransaction transaction = mock(WriteTransaction.class);
 155         when(dataBroker.newWriteOnlyTransaction()).thenReturn(transaction);
 156         CheckedFuture<Void, TransactionCommitFailedException> commitFuture = mock(CheckedFuture.class);
 157         when(transaction.submit()).thenReturn(commitFuture);
 158
 159         NodeBuilder nodeBuilder = mock(NodeBuilder.class);
 160         when(nodeBuilder.getKey()).thenReturn(mock(NodeKey.class));
 161
 162         FlowBuilder flowBuilder = mock(FlowBuilder.class);
 163         when(flowBuilder.getKey()).thenReturn(mock(FlowKey.class));
 164
 165         abstractServiceInstance.removeFlow(flowBuilder, nodeBuilder);
 166         verify(transaction, times(1)).delete(eq(LogicalDatastoreType.CONFIGURATION), any(InstanceIdentifier.class));
 167         verify(commitFuture, times(1)).get();
 168     }
 169
 170     /**
 171      * Test method {@link AbstractServiceInstance#getFlow(FlowBuilder, NodeBuilder)}
 172      */
 173     @Test
 174     public void testGetFlow() throws Exception {
 175         ReadOnlyTransaction transaction = mock(ReadOnlyTransaction.class);
 176         when(dataBroker.newReadOnlyTransaction()).thenReturn(transaction);
 177         //when(mdsalConsumer.getDataBroker()).thenReturn(dataBrocker);
 178
 179         NodeBuilder nodeBuilder = mock(NodeBuilder.class);
 180         when(nodeBuilder.getKey()).thenReturn(mock(NodeKey.class));
 181
 182         FlowBuilder flowBuilder = mock(FlowBuilder.class);
 183         when(flowBuilder.getKey()).thenReturn(mock(FlowKey.class));
 184
 185         CheckedFuture dataRead = mock(CheckedFuture.class);
 186         when(transaction.read(eq(LogicalDatastoreType.CONFIGURATION), any(InstanceIdentifier.class))).thenReturn(dataRead);
 187         Optional<Flow> data = mock(Optional.class);
 188         when(dataRead.get()).thenReturn(data);
 189
 190         abstractServiceInstance.getFlow(flowBuilder, nodeBuilder);
 191         verify(transaction, times(1)).read(eq(LogicalDatastoreType.CONFIGURATION), any(InstanceIdentifier.class));
 192     }
 193
 194     /**
 195      * Test method {@link AbstractServiceInstance#programDefaultPipelineRule(String)}
 196      */
 197     @Test
 198     public void testProgramDefaultPipelineRule() {
 199         when(southbound.getBridgeName(any(Node.class))).thenReturn(Constants.INTEGRATION_BRIDGE);
 200         when(southbound.getDataPathId(any(Node.class))).thenReturn(Long.valueOf(261));
 201
 202         when(orchestrator.getNextServiceInPipeline(any(Service.class))).thenReturn(Service.ARP_RESPONDER);
 203
 204         abstractServiceInstance.setService(service);
 205
 206         WriteTransaction transaction = mock(WriteTransaction.class);
 207         when(dataBroker.newWriteOnlyTransaction()).thenReturn(transaction);
 208         CheckedFuture<Void, TransactionCommitFailedException> commitFuture = mock(CheckedFuture.class);
 209         when(transaction.submit()).thenReturn(commitFuture);
 210
 211         NodeBuilder nodeBuilder = mock(NodeBuilder.class);
 212         when(nodeBuilder.getKey()).thenReturn(mock(NodeKey.class));
 213
 214         FlowBuilder flowBuilder = mock(FlowBuilder.class);
 215         when(flowBuilder.getKey()).thenReturn(mock(FlowKey.class));
 216
 217         abstractServiceInstance.programDefaultPipelineRule(mock(Node.class));
 218
 219         verify(abstractServiceInstance, times(1)).isBridgeInPipeline(any(Node.class));
 220         verify(abstractServiceInstance, times(1)).createNodeBuilder(anyString());
 221         verify(abstractServiceInstance, times(1)).writeFlow(any(FlowBuilder.class), any(NodeBuilder.class));
 222     }
 223
 224 //    @Test TODO - re-activate test
 225     public void testSetDependencies() throws Exception {
 226         PipelineOrchestrator pipelineOrchestrator = mock(PipelineOrchestrator.class);
 227         Southbound southbound = mock(Southbound.class);
 228
 229         PowerMockito.mockStatic(ServiceHelper.class);
 230         PowerMockito.when(ServiceHelper.getGlobalInstance(PipelineOrchestrator.class, abstractServiceInstance)).thenReturn(pipelineOrchestrator);
 231         PowerMockito.when(ServiceHelper.getGlobalInstance(Southbound.class, abstractServiceInstance)).thenReturn(southbound);
 232
 233         abstractServiceInstance.setDependencies(mock(ServiceReference.class), mock(AbstractServiceInstance.class));
 234
 235         assertEquals("Error, did not return the correct object", getField("pipelineOrchestrator"), pipelineOrchestrator);
 236         assertEquals("Error, did not return the correct object", getField("southbound"), southbound);
 237     }
 238
 239     private Object getField(String fieldName) throws Exception {
 240         Field field = AbstractServiceInstance.class.getDeclaredField(fieldName);
 241         field.setAccessible(true);
 242         return field.get(abstractServiceInstance);
 243     }
 244 }