openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/services/MultipartRequestOnTheFlyCallbackTest.java

   1 package org.opendaylight.openflowplugin.impl.services;
   2
   3 import static org.junit.Assert.assertEquals;
   4 import static org.junit.Assert.assertNotNull;
   5 import static org.junit.Assert.assertTrue;
   6 import static org.mockito.Matchers.eq;
   7 import static org.mockito.Mockito.mock;
   8 import static org.mockito.Mockito.times;
   9 import static org.mockito.Mockito.verify;
  10 import static org.mockito.Mockito.when;
  11 import com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import com.google.common.util.concurrent.Futures;
  14 import java.math.BigInteger;
  15 import java.util.Collections;
  16 import java.util.List;
  17 import java.util.concurrent.ExecutionException;
  18 import org.junit.Before;
  19 import org.junit.Test;
  20 import org.junit.runner.RunWith;
  21 import org.mockito.Matchers;
  22 import org.mockito.Mock;
  23 import org.mockito.Mockito;
  24 import org.mockito.runners.MockitoJUnitRunner;
  25 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  27 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  28 import org.opendaylight.openflowplugin.api.OFConstants;
  29 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  30 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  31 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  32 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
  33 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  34 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
  35 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.EventIdentifier;
  36 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
  37 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyImpl;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModFlags;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntry;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.MatchBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessageBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyFlowCaseBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.MultipartReplyFlowBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow.FlowStatsBuilder;
  60 import org.opendaylight.yangtools.yang.binding.DataObject;
  61 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  62 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  63 import org.opendaylight.yangtools.yang.common.RpcError;
  64 import org.opendaylight.yangtools.yang.common.RpcResult;
  65 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  66
  67 @RunWith(MockitoJUnitRunner.class)
  68 public class MultipartRequestOnTheFlyCallbackTest {
  69
  70     private static final String DUMMY_NODE_ID = "dummyNodeId";
  71     private static final String DUMMY_EVENT_NAME = "dummy event name 1";
  72     private static final String DUMMY_DEVICE_ID = "dummy device id 1";
  73     private static final Long DUMMY_XID = 55L;
  74     private static final KeyedInstanceIdentifier<Node, NodeKey> NODE_PATH = KeyedInstanceIdentifier
  75             .create(Nodes.class)
  76             .child(Node.class, new NodeKey(new NodeId("uf-node:123")));
  77
  78     @Mock
  79     private DeviceContext mockedDeviceContext;
  80     @Mock
  81     private RequestContext<List<MultipartReply>> mockedRequestContext;
  82     @Mock
  83     private ConnectionContext mockedPrimaryConnection;
  84     @Mock
  85     private NodeId mockedNodeId;
  86     @Mock
  87     private FeaturesReply mockedFeaturesReply;
  88     @Mock
  89     private DeviceState mockedDeviceState;
  90     @Mock
  91     private GetFeaturesOutput mocketGetFeaturesOutput;
  92     @Mock
  93     private DeviceFlowRegistry mockedFlowRegistry;
  94     @Mock
  95     private ReadOnlyTransaction mockedReadOnlyTx;
  96
  97     private AbstractRequestContext<List<MultipartReply>> dummyRequestContext;
  98     private final EventIdentifier dummyEventIdentifier = new EventIdentifier(DUMMY_EVENT_NAME, DUMMY_DEVICE_ID);
  99     private MultipartRequestOnTheFlyCallback multipartRequestOnTheFlyCallback;
 100     private final short tableId = 0;
 101
 102     @Before
 103     public void initialization() {
 104         when(mockedDeviceContext.getMessageSpy()).thenReturn(new MessageIntelligenceAgencyImpl());
 105         when(mockedNodeId.toString()).thenReturn(DUMMY_NODE_ID);
 106         when(mockedPrimaryConnection.getNodeId()).thenReturn(mockedNodeId);
 107         when(mockedPrimaryConnection.getFeatures()).thenReturn(mockedFeaturesReply);
 108         when(mockedFeaturesReply.getVersion()).thenReturn(OFConstants.OFP_VERSION_1_3);
 109         when(mockedFeaturesReply.getDatapathId()).thenReturn(BigInteger.valueOf(123L));
 110
 111         when(mocketGetFeaturesOutput.getTables()).thenReturn(tableId);
 112
 113         when(mockedDeviceContext.getPrimaryConnectionContext()).thenReturn(mockedPrimaryConnection);
 114         when(mockedDeviceState.getNodeInstanceIdentifier()).thenReturn(NODE_PATH);
 115         when(mockedDeviceState.getFeatures()).thenReturn(mocketGetFeaturesOutput);
 116         when(mockedDeviceState.deviceSynchronized()).thenReturn(true);
 117         when(mockedDeviceContext.getDeviceState()).thenReturn(mockedDeviceState);
 118         when(mockedDeviceContext.getDeviceFlowRegistry()).thenReturn(mockedFlowRegistry);
 119
 120         final InstanceIdentifier<FlowCapableNode> nodePath = mockedDeviceState.getNodeInstanceIdentifier().augmentation(FlowCapableNode.class);
 121         final FlowCapableNodeBuilder flowNodeBuilder = new FlowCapableNodeBuilder();
 122         flowNodeBuilder.setTable(Collections.<Table> emptyList());
 123         final Optional<FlowCapableNode> flowNodeOpt = Optional.of(flowNodeBuilder.build());
 124         final CheckedFuture<Optional<FlowCapableNode>, ReadFailedException> flowNodeFuture = Futures.immediateCheckedFuture(flowNodeOpt);
 125         when(mockedReadOnlyTx.read(LogicalDatastoreType.OPERATIONAL, nodePath)).thenReturn(flowNodeFuture);
 126         when(mockedDeviceContext.getReadTransaction()).thenReturn(mockedReadOnlyTx);
 127
 128         dummyRequestContext = new AbstractRequestContext<List<MultipartReply>>(DUMMY_XID) {
 129
 130             @Override
 131             public void close() {
 132                 //NOOP
 133             }
 134         };
 135         multipartRequestOnTheFlyCallback = new MultipartRequestOnTheFlyCallback(dummyRequestContext, String.class, mockedDeviceContext, dummyEventIdentifier);
 136     }
 137
 138
 139     @Test
 140     public void testOnSuccessWithNull() throws Exception {
 141         multipartRequestOnTheFlyCallback.onSuccess(null);
 142         final RpcResult<List<MultipartReply>> expectedRpcResult = RpcResultBuilder.success(Collections.<MultipartReply>emptyList()).build();
 143         final RpcResult<List<MultipartReply>> actualResult = dummyRequestContext.getFuture().get();
 144         assertEquals(expectedRpcResult.getErrors(), actualResult.getErrors());
 145         assertEquals(expectedRpcResult.getResult(), actualResult.getResult());
 146         assertEquals(expectedRpcResult.isSuccessful(), actualResult.isSuccessful());
 147     }
 148
 149     @Test
 150     public void testOnSuccessWithNotMultiNoMultipart() throws ExecutionException, InterruptedException {
 151         final HelloMessage mockedHelloMessage = mock(HelloMessage.class);
 152         multipartRequestOnTheFlyCallback.onSuccess(mockedHelloMessage);
 153
 154         final RpcResult<List<MultipartReply>> expectedRpcResult =
 155                 RpcResultBuilder.<List<MultipartReply>>failed().withError(RpcError.ErrorType.APPLICATION,
 156                         String.format("Unexpected response type received %s.", mockedHelloMessage.getClass())).build();
 157         final RpcResult<List<MultipartReply>> actualResult = dummyRequestContext.getFuture().get();
 158         assertNotNull(actualResult.getErrors());
 159         assertEquals(1, actualResult.getErrors().size());
 160
 161         final RpcError actualError = actualResult.getErrors().iterator().next();
 162         assertEquals(actualError.getMessage(), String.format("Unexpected response type received %s.", mockedHelloMessage.getClass()));
 163         assertEquals(actualError.getErrorType(),RpcError.ErrorType.APPLICATION);
 164         assertEquals(expectedRpcResult.getResult(), actualResult.getResult());
 165         assertEquals(expectedRpcResult.isSuccessful(), actualResult.isSuccessful());
 166
 167         Mockito.verify(mockedDeviceContext, Mockito.never()).writeToTransaction(Matchers.eq(LogicalDatastoreType.OPERATIONAL),
 168                 Matchers.<InstanceIdentifier>any(), Matchers.<DataObject>any());
 169         Mockito.verify(mockedDeviceContext).submitTransaction();
 170     }
 171
 172     /**
 173      * not the last reply
 174      *
 175      * @throws ExecutionException
 176      * @throws InterruptedException
 177      */
 178     @Test
 179     public void testOnSuccessWithValidMultipart1() throws ExecutionException, InterruptedException {
 180         final MatchBuilder matchBuilder = new MatchBuilder()
 181                 .setMatchEntry(Collections.<MatchEntry>emptyList());
 182         final FlowStatsBuilder flowStatsBuilder = new FlowStatsBuilder()
 183 .setTableId(tableId)
 184                 .setPriority(2)
 185                 .setCookie(BigInteger.ZERO)
 186                 .setByteCount(BigInteger.TEN)
 187                 .setPacketCount(BigInteger.ONE)
 188                 .setDurationSec(11L)
 189                 .setDurationNsec(12L)
 190                 .setMatch(matchBuilder.build())
 191                 .setFlags(new FlowModFlags(true, false, false, false, false));
 192         final MultipartReplyFlowBuilder multipartReplyFlowBuilder = new MultipartReplyFlowBuilder()
 193                 .setFlowStats(Collections.singletonList(flowStatsBuilder.build()));
 194         final MultipartReplyFlowCaseBuilder multipartReplyFlowCaseBuilder = new MultipartReplyFlowCaseBuilder()
 195                 .setMultipartReplyFlow(multipartReplyFlowBuilder.build());
 196         final MultipartReplyMessageBuilder mpReplyMessage = new MultipartReplyMessageBuilder()
 197                 .setType(MultipartType.OFPMPFLOW)
 198                 .setFlags(new MultipartRequestFlags(true))
 199                 .setMultipartReplyBody(multipartReplyFlowCaseBuilder.build())
 200                 .setXid(21L);
 201
 202         final InstanceIdentifier<FlowCapableNode> nodePath = mockedDeviceState.getNodeInstanceIdentifier()
 203                 .augmentation(FlowCapableNode.class);
 204         final FlowCapableNodeBuilder flowNodeBuilder = new FlowCapableNodeBuilder();
 205         final TableBuilder tableDataBld = new TableBuilder();
 206         tableDataBld.setId(tableId);
 207         flowNodeBuilder.setTable(Collections.singletonList(tableDataBld.build()));
 208         final Optional<FlowCapableNode> flowNodeOpt = Optional.of(flowNodeBuilder.build());
 209         final CheckedFuture<Optional<FlowCapableNode>, ReadFailedException> flowNodeFuture = Futures
 210                 .immediateCheckedFuture(flowNodeOpt);
 211         when(mockedReadOnlyTx.read(LogicalDatastoreType.OPERATIONAL, nodePath)).thenReturn(flowNodeFuture);
 212         when(mockedDeviceContext.getReadTransaction()).thenReturn(mockedReadOnlyTx);
 213
 214         multipartRequestOnTheFlyCallback.onSuccess(mpReplyMessage.build());
 215         final InstanceIdentifier<Table> tableIdent = nodePath.child(Table.class, new TableKey(tableId));
 216
 217         verify(mockedReadOnlyTx, times(1)).read(LogicalDatastoreType.OPERATIONAL, nodePath);
 218         verify(mockedReadOnlyTx, times(1)).close();
 219         verify(mockedFlowRegistry).storeIfNecessary(Matchers.<FlowRegistryKey> any(), Matchers.anyShort());
 220         verify(mockedDeviceContext, times(1)).writeToTransaction(eq(LogicalDatastoreType.OPERATIONAL),
 221                 eq(tableIdent), Matchers.<Table> any());
 222         /*
 223          * One call for Table one call for Flow
 224          * we are not able to create Flow InstanceIdentifier because we are missing FlowId
 225          */
 226         verify(mockedDeviceContext, times(2)).writeToTransaction(eq(LogicalDatastoreType.OPERATIONAL),
 227                 Matchers.<InstanceIdentifier> any(), Matchers.<DataObject> any());
 228     }
 229
 230     /**
 231      * the last reply
 232      *
 233      * @throws ExecutionException
 234      * @throws InterruptedException
 235      */
 236     @Test
 237     public void testOnSuccessWithValidMultipart2() throws ExecutionException, InterruptedException {
 238         final MultipartReplyMessageBuilder mpReplyMessage = new MultipartReplyMessageBuilder()
 239                 .setType(MultipartType.OFPMPDESC)
 240                 .setFlags(new MultipartRequestFlags(false));
 241
 242         multipartRequestOnTheFlyCallback.onSuccess(mpReplyMessage.build());
 243
 244         final RpcResult<List<MultipartReply>> actualResult = dummyRequestContext.getFuture().get();
 245         assertNotNull(actualResult.getErrors());
 246         assertTrue(actualResult.getErrors().isEmpty());
 247         assertNotNull(actualResult.getResult());
 248         assertTrue(actualResult.getResult().isEmpty());
 249
 250         Mockito.verify(mockedFlowRegistry, Mockito.never()).storeIfNecessary(Matchers.<FlowRegistryKey>any(), Matchers.anyShort());
 251         Mockito.verify(mockedDeviceContext, Mockito.never()).writeToTransaction(Matchers.eq(LogicalDatastoreType.OPERATIONAL),
 252                 Matchers.<InstanceIdentifier>any(), Matchers.<DataObject>any());
 253     }
 254 }