openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/common/MultipartRequestInputFactoryTest.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.openflowplugin.impl.common;
  10
  11 import org.junit.Assert;
  12 import org.junit.Before;
  13 import org.junit.Test;
  14 import org.opendaylight.openflowplugin.api.OFConstants;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInput;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.MultipartRequestBody;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestAggregateCase;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestDescCase;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestExperimenterCase;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestFlowCase;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupCase;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupDescCase;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestGroupFeaturesCase;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterCase;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterConfigCase;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestMeterFeaturesCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortDescCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestPortStatsCase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestQueueCase;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestTableCase;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.MultipartRequestTableFeaturesCase;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.flow._case.MultipartRequestFlow;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.group._case.MultipartRequestGroup;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.meter._case.MultipartRequestMeter;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.meter.config._case.MultipartRequestMeterConfig;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.port.stats._case.MultipartRequestPortStats;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.queue._case.MultipartRequestQueue;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.table.features._case.MultipartRequestTableFeatures;
  40
  41 /**
  42  * Test for {@link MultipartRequestInputFactory}.
  43  */
  44 public class MultipartRequestInputFactoryTest {
  45
  46     private final long xid = 42L;
  47     private short ofVersion;
  48
  49     @Before
  50
  51     public void setUp() throws Exception {
  52         ofVersion = OFConstants.OFP_VERSION_1_3;
  53     }
  54
  55     @Test
  56     public void testMakeMultipartRequestInput_DESC() throws Exception {
  57         MultipartType mpType = MultipartType.OFPMPDESC;
  58         final MultipartRequestInput mpRqInput =
  59             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
  60         checkHeader(mpRqInput, mpType);
  61         checkEmptyBody(mpRqInput.getMultipartRequestBody(), MultipartRequestDescCase.class);
  62     }
  63
  64     @Test
  65     public void testMakeMultipartRequestInput_FLOW_13() throws Exception {
  66         final MultipartType mpType = MultipartType.OFPMPFLOW;
  67         final MultipartRequestInput mpRqInput =
  68             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
  69         checkHeader(mpRqInput, mpType);
  70         final MultipartRequestBody mpRqBody = mpRqInput.getMultipartRequestBody();
  71         Assert.assertTrue(mpRqBody instanceof MultipartRequestFlowCase);
  72
  73         MultipartRequestFlow mpRq = ((MultipartRequestFlowCase) mpRqBody).getMultipartRequestFlow();
  74         Assert.assertEquals(OFConstants.OFPTT_ALL, mpRq.getTableId());
  75         Assert.assertEquals(OFConstants.OFPP_ANY, mpRq.getOutPort());
  76         Assert.assertEquals(OFConstants.OFPG_ANY, mpRq.getOutGroup());
  77         Assert.assertEquals(0, mpRq.getCookie().intValue());
  78         Assert.assertEquals(0, mpRq.getCookieMask().intValue());
  79         Assert.assertNotNull(mpRq.getMatch());
  80         Assert.assertNull(mpRq.getMatchV10());
  81
  82         final String EMPTY_MATCH_DUMP =
  83                 "Match{_type=class org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OxmMatchType, "
  84                         + "augmentation=[]}";
  85         Assert.assertEquals(EMPTY_MATCH_DUMP, String.valueOf(mpRq.getMatch()));
  86     }
  87
  88     @Test
  89     public void testMakeMultipartRequestInput_FLOW_10() throws Exception {
  90         final MultipartType mpType = MultipartType.OFPMPFLOW;
  91         ofVersion = OFConstants.OFP_VERSION_1_0;
  92         final MultipartRequestInput mpRqInput =
  93             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
  94         checkHeader(mpRqInput, mpType);
  95         final MultipartRequestBody mpRqBody = mpRqInput.getMultipartRequestBody();
  96         Assert.assertTrue(mpRqBody instanceof MultipartRequestFlowCase);
  97
  98         MultipartRequestFlow mpRq = ((MultipartRequestFlowCase) mpRqBody).getMultipartRequestFlow();
  99         Assert.assertEquals(OFConstants.OFPTT_ALL, mpRq.getTableId());
 100         Assert.assertEquals(OFConstants.OFPP_ANY, mpRq.getOutPort());
 101         Assert.assertEquals(OFConstants.OFPG_ANY, mpRq.getOutGroup());
 102         Assert.assertEquals(0, mpRq.getCookie().intValue());
 103         Assert.assertEquals(0, mpRq.getCookieMask().intValue());
 104         Assert.assertNull(mpRq.getMatch());
 105         Assert.assertNotNull(mpRq.getMatchV10());
 106     }
 107
 108     @Test
 109     public void testMakeMultipartRequestInputAggregate() throws Exception {
 110         MultipartType mpType = MultipartType.OFPMPAGGREGATE;
 111         final MultipartRequestInput mpRqInput =
 112             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 113         checkHeader(mpRqInput, mpType);
 114         checkEmptyBody(mpRqInput.getMultipartRequestBody(), MultipartRequestAggregateCase.class);
 115     }
 116
 117     @Test
 118     public void testMakeMultipartRequestInputTable() throws Exception {
 119         MultipartType mpType = MultipartType.OFPMPTABLE;
 120         final MultipartRequestInput mpRqInput =
 121             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 122         checkHeader(mpRqInput, mpType);
 123         checkEmptyBody(mpRqInput.getMultipartRequestBody(), MultipartRequestTableCase.class);
 124     }
 125
 126     @Test
 127     public void testMakeMultipartRequestInputPortStats() throws Exception {
 128         final MultipartType mpType = MultipartType.OFPMPPORTSTATS;
 129         final MultipartRequestInput mpRqInput =
 130             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 131         checkHeader(mpRqInput, mpType);
 132         final MultipartRequestBody mpRqBody = mpRqInput.getMultipartRequestBody();
 133         Assert.assertTrue(mpRqBody instanceof MultipartRequestPortStatsCase);
 134
 135         MultipartRequestPortStats mpRq = ((MultipartRequestPortStatsCase) mpRqBody).getMultipartRequestPortStats();
 136         Assert.assertEquals(OFConstants.OFPP_ANY, mpRq.getPortNo());
 137     }
 138
 139     @Test
 140     public void testMakeMultipartRequestInputQueue() throws Exception {
 141         final MultipartType mpType = MultipartType.OFPMPQUEUE;
 142         final MultipartRequestInput mpRqInput =
 143             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 144         checkHeader(mpRqInput, mpType);
 145         final MultipartRequestBody mpRqBody = mpRqInput.getMultipartRequestBody();
 146         Assert.assertTrue(mpRqBody instanceof MultipartRequestQueueCase);
 147
 148         MultipartRequestQueue mpRq = ((MultipartRequestQueueCase) mpRqBody).getMultipartRequestQueue();
 149         Assert.assertEquals(OFConstants.OFPP_ANY, mpRq.getPortNo());
 150         Assert.assertEquals(OFConstants.OFPQ_ALL, mpRq.getQueueId());
 151     }
 152
 153     @Test
 154     public void testMakeMultipartRequestInputGroup() throws Exception {
 155         final MultipartType mpType = MultipartType.OFPMPGROUP;
 156         final MultipartRequestInput mpRqInput =
 157             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 158         checkHeader(mpRqInput, mpType);
 159         final MultipartRequestBody mpRqBody = mpRqInput.getMultipartRequestBody();
 160         Assert.assertTrue(mpRqBody instanceof MultipartRequestGroupCase);
 161
 162         MultipartRequestGroup mpRq = ((MultipartRequestGroupCase) mpRqBody).getMultipartRequestGroup();
 163         Assert.assertEquals(OFConstants.OFPG_ALL, mpRq.getGroupId().getValue());
 164     }
 165
 166     @Test
 167     public void testMakeMultipartRequestInputGroupDesc() throws Exception {
 168         MultipartType mpType = MultipartType.OFPMPGROUPDESC;
 169         final MultipartRequestInput mpRqInput =
 170             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 171         checkHeader(mpRqInput, mpType);
 172         checkEmptyBody(mpRqInput.getMultipartRequestBody(), MultipartRequestGroupDescCase.class);
 173     }
 174
 175     @Test
 176     public void testMakeMultipartRequestInputGroupFeatures() throws Exception {
 177         MultipartType mpType = MultipartType.OFPMPGROUPFEATURES;
 178         final MultipartRequestInput mpRqInput =
 179             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 180         checkHeader(mpRqInput, mpType);
 181         checkEmptyBody(mpRqInput.getMultipartRequestBody(), MultipartRequestGroupFeaturesCase.class);
 182     }
 183
 184     @Test
 185     public void testMakeMultipartRequestInputMeter() throws Exception {
 186         final MultipartType mpType = MultipartType.OFPMPMETER;
 187         final MultipartRequestInput mpRqInput =
 188             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 189         checkHeader(mpRqInput, mpType);
 190         final MultipartRequestBody mpRqBody = mpRqInput.getMultipartRequestBody();
 191         Assert.assertTrue(mpRqBody instanceof MultipartRequestMeterCase);
 192
 193         MultipartRequestMeter mpRq = ((MultipartRequestMeterCase) mpRqBody).getMultipartRequestMeter();
 194         Assert.assertEquals(OFConstants.OFPM_ALL, mpRq.getMeterId().getValue());
 195     }
 196
 197     @Test
 198     public void testMakeMultipartRequestInputMeterConfig() throws Exception {
 199         final MultipartType mpType = MultipartType.OFPMPMETERCONFIG;
 200         final MultipartRequestInput mpRqInput =
 201             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 202         checkHeader(mpRqInput, mpType);
 203         final MultipartRequestBody mpRqBody = mpRqInput.getMultipartRequestBody();
 204         Assert.assertTrue(mpRqBody instanceof MultipartRequestMeterConfigCase);
 205
 206         MultipartRequestMeterConfig mpRq =
 207                 ((MultipartRequestMeterConfigCase) mpRqBody).getMultipartRequestMeterConfig();
 208         Assert.assertEquals(OFConstants.OFPM_ALL, mpRq.getMeterId().getValue());
 209     }
 210
 211     @Test
 212     public void testMakeMultipartRequestInputMeterFeatures() throws Exception {
 213         MultipartType mpType = MultipartType.OFPMPMETERFEATURES;
 214         final MultipartRequestInput mpRqInput =
 215             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 216         checkHeader(mpRqInput, mpType);
 217         checkEmptyBody(mpRqInput.getMultipartRequestBody(), MultipartRequestMeterFeaturesCase.class);
 218     }
 219
 220     @Test
 221     public void testMakeMultipartRequestInputTableFeatures() throws Exception {
 222         final MultipartType mpType = MultipartType.OFPMPTABLEFEATURES;
 223         final MultipartRequestInput mpRqInput =
 224             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 225         checkHeader(mpRqInput, mpType);
 226         final MultipartRequestBody mpRqBody = mpRqInput.getMultipartRequestBody();
 227         Assert.assertTrue(mpRqBody instanceof MultipartRequestTableFeaturesCase);
 228
 229         MultipartRequestTableFeatures mpRq =
 230                 ((MultipartRequestTableFeaturesCase) mpRqBody).getMultipartRequestTableFeatures();
 231         Assert.assertNotNull(mpRq);
 232     }
 233
 234     @Test
 235     public void testMakeMultipartRequestInputPortDesc() throws Exception {
 236         MultipartType mpType = MultipartType.OFPMPPORTDESC;
 237         final MultipartRequestInput mpRqInput =
 238             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 239         checkHeader(mpRqInput, mpType);
 240         checkEmptyBody(mpRqInput.getMultipartRequestBody(), MultipartRequestPortDescCase.class);
 241     }
 242
 243     @Test
 244     public void testMakeMultipartRequestInputExperimenter() throws Exception {
 245         MultipartType mpType = MultipartType.OFPMPEXPERIMENTER;
 246         final MultipartRequestInput mpRqInput =
 247             (MultipartRequestInput) MultipartRequestInputFactory.makeMultipartRequest(xid, ofVersion, mpType, false);
 248         checkHeader(mpRqInput, mpType);
 249         checkEmptyBody(mpRqInput.getMultipartRequestBody(), MultipartRequestExperimenterCase.class);
 250     }
 251
 252     private void checkHeader(MultipartRequestInput mpRqInput, MultipartType mpType) {
 253         Assert.assertFalse(mpRqInput.getFlags().isOFPMPFREQMORE());
 254         Assert.assertEquals(ofVersion, mpRqInput.getVersion().shortValue());
 255         Assert.assertEquals(mpType, mpRqInput.getType());
 256         Assert.assertEquals(xid, mpRqInput.getXid().longValue());
 257     }
 258
 259     private void checkEmptyBody(MultipartRequestBody mpRqBody, Class<? extends
 260             MultipartRequestBody> expectedMpRqBodyClass) throws Exception {
 261         Assert.assertTrue(expectedMpRqBodyClass.isAssignableFrom(mpRqBody.getImplementedInterface()));
 262         final String expectedDump = expectedMpRqBodyClass.getSimpleName() + "{augmentation=[]}";
 263         Assert.assertEquals(expectedDump, String.valueOf(mpRqBody));
 264     }
 265 }