openflow-protocol-impl/src/test/java/org/opendaylight/openflowjava/protocol/impl/core/connection/SwitchConnectionProviderImpl02Test.java

   1 /*
   2  * Copyright (c) 2014 Pantheon Technologies s.r.o. 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 package org.opendaylight.openflowjava.protocol.impl.core.connection;
   9
  10 import com.google.common.collect.Lists;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import org.junit.Assert;
  13 import org.junit.Test;
  14 import org.mockito.Mock;
  15 import org.mockito.MockitoAnnotations;
  16 import org.opendaylight.openflowjava.protocol.api.connection.SwitchConnectionHandler;
  17 import org.opendaylight.openflowjava.protocol.api.connection.TlsConfiguration;
  18 import org.opendaylight.openflowjava.protocol.api.connection.TlsConfigurationImpl;
  19 import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
  20 import org.opendaylight.openflowjava.protocol.api.extensibility.OFGeneralDeserializer;
  21 import org.opendaylight.openflowjava.protocol.api.extensibility.OFGeneralSerializer;
  22 import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
  23 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterActionDeserializerKey;
  24 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterActionSerializerKey;
  25 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdDeserializerKey;
  26 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdMeterSubTypeSerializerKey;
  27 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterIdSerializerKey;
  28 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterInstructionDeserializerKey;
  29 import org.opendaylight.openflowjava.protocol.api.keys.ExperimenterInstructionSerializerKey;
  30 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntryDeserializerKey;
  31 import org.opendaylight.openflowjava.protocol.api.keys.MatchEntrySerializerKey;
  32 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  33 import org.opendaylight.openflowjava.protocol.impl.core.ServerFacade;
  34 import org.opendaylight.openflowjava.protocol.impl.core.SwitchConnectionProviderImpl;
  35 import org.opendaylight.openflowjava.protocol.spi.connection.SwitchConnectionProvider;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.ExperimenterActionSubType;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.config.rev140630.KeystoreType;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.config.rev140630.PathType;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.config.rev140630.TransportProtocol;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.InPort;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OpenflowBasicClass;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.MeterBandExperimenterCase;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.property.header.QueueProperty;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.table.features.properties.grouping.TableFeatureProperties;
  49
  50 import java.net.InetAddress;
  51 import java.net.UnknownHostException;
  52
  53 /**
  54  * @author madamjak
  55  * @author michal.polkorab
  56  */
  57 public class SwitchConnectionProviderImpl02Test {
  58     @Mock SwitchConnectionHandler handler;
  59     @Mock OFGeneralSerializer serializer;
  60     @Mock OFGeneralDeserializer deserializer;
  61     @Mock OFDeserializer<ErrorMessage> deserializerError;
  62     @Mock OFDeserializer<ExperimenterDataOfChoice> deserializerExpMsg;
  63     @Mock OFDeserializer<ExperimenterDataOfChoice> deserializerMultipartRplMsg;
  64     @Mock OFDeserializer<QueueProperty> deserializerQueueProperty;
  65     @Mock OFDeserializer<MeterBandExperimenterCase> deserializerMeterBandExpCase;
  66     @Mock OFSerializer<ExperimenterDataOfChoice> serializerExperimenterInput;
  67     @Mock OFSerializer<ExperimenterDataOfChoice> serializerMultipartRequestExpCase;
  68     @Mock OFSerializer<MeterBandExperimenterCase> serializerMeterBandExpCase;
  69     private static final int SWITCH_IDLE_TIMEOUT = 2000;
  70     private InetAddress startupAddress;
  71     private TlsConfiguration tlsConfiguration;
  72     private SwitchConnectionProviderImpl provider;
  73     private ConnectionConfigurationImpl config;
  74
  75     /**
  76      * Creates new {@link SwitchConnectionProvider} instance for each test
  77      * @param protocol communication protocol
  78      */
  79     public void startUp(final TransportProtocol protocol) {
  80         MockitoAnnotations.initMocks(this);
  81         config = null;
  82         if (protocol != null) {
  83             createConfig(protocol);
  84         }
  85         provider = new SwitchConnectionProviderImpl();
  86     }
  87
  88     private void createConfig(final TransportProtocol protocol) {
  89         try {
  90             startupAddress = InetAddress.getLocalHost();
  91         } catch (final UnknownHostException e) {
  92             e.printStackTrace();
  93         }
  94         tlsConfiguration = null;
  95         if (protocol.equals(TransportProtocol.TLS)) {
  96             tlsConfiguration = new TlsConfigurationImpl(KeystoreType.JKS,
  97                     "/selfSignedSwitch", PathType.CLASSPATH, KeystoreType.JKS,
  98                     "/selfSignedController", PathType.CLASSPATH,
  99                     Lists.newArrayList("TLS_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_128_CBC_SHA256")) ;
 100         }
 101         config = new ConnectionConfigurationImpl(startupAddress, 0, tlsConfiguration, SWITCH_IDLE_TIMEOUT, true);
 102         config.setTransferProtocol(protocol);
 103     }
 104
 105
 106     /**
 107      * Test getServerFacade
 108      */
 109     @Test
 110     public void testServerFacade(){
 111         startUp(TransportProtocol.TCP);
 112         provider.setConfiguration(config);
 113         final ListenableFuture<Boolean> future = provider.startup();
 114         final ServerFacade serverFacade = provider.getServerFacade();
 115         Assert.assertNotNull("Wrong -- getServerFacade return null",serverFacade);
 116     }
 117
 118     /**
 119      * Test shutdown on unconfigured provider
 120      */
 121     @Test(expected = IllegalStateException.class)
 122     public void testShutdownUnconfigured(){
 123         startUp(TransportProtocol.TCP);
 124         provider.shutdown();
 125     }
 126     /**
 127      * Test unregister by wrong key
 128      */
 129     @Test
 130     public void testUnregisterWrongKeys(){
 131         startUp(TransportProtocol.TCP);
 132         provider.setConfiguration(config);
 133         final ExperimenterInstructionSerializerKey testSerKey
 134             = new ExperimenterInstructionSerializerKey(EncodeConstants.OF10_VERSION_ID,42L);
 135         Assert.assertFalse("Wrong -- unregisterSerializer",provider.unregisterSerializer(testSerKey));
 136         final ExperimenterInstructionDeserializerKey tesDeserKey
 137             = new ExperimenterInstructionDeserializerKey(EncodeConstants.OF10_VERSION_ID,24L);
 138         Assert.assertFalse("Wrong -- unregisterDeserializer",provider.unregisterDeserializer(tesDeserKey));
 139     }
 140
 141     /**
 142      * Test register and unregister method
 143      */
 144     @Test
 145     public void testUnregisterExistingKeys(){
 146         startUp(TransportProtocol.TCP);
 147         provider.setConfiguration(config);
 148         // -- registerActionSerializer
 149         final ExperimenterActionSerializerKey key1
 150             = new ExperimenterActionSerializerKey(EncodeConstants.OF10_VERSION_ID, 42L, TestSubType.class);
 151         provider.registerActionSerializer(key1, serializer);
 152         Assert.assertTrue("Wrong -- unregister ActionSerializer", provider.unregisterSerializer(key1));
 153         Assert.assertFalse("Wrong -- unregister ActionSerializer by not existing key", provider.unregisterSerializer(key1));
 154         // -- registerActionDeserializer
 155         final ExperimenterActionDeserializerKey key2
 156             = new ExperimenterActionDeserializerKey(EncodeConstants.OF10_VERSION_ID, 42L);
 157         provider.registerActionDeserializer(key2, deserializer);
 158         Assert.assertTrue("Wrong -- unregister ActionDeserializer", provider.unregisterDeserializer(key2));
 159         Assert.assertFalse("Wrong -- unregister ActionDeserializer by not existing key", provider.unregisterDeserializer(key2));
 160         // -- registerInstructionSerializer
 161         final ExperimenterInstructionSerializerKey key3
 162             = new ExperimenterInstructionSerializerKey(EncodeConstants.OF10_VERSION_ID,42L);
 163         provider.registerInstructionSerializer(key3, serializer);
 164         Assert.assertTrue("Wrong -- unregister InstructionSerializer", provider.unregisterSerializer(key3));
 165         Assert.assertFalse("Wrong -- unregister InstructionSerializer by not existing key", provider.unregisterSerializer(key3));
 166         // -- registerInstructionDeserializer
 167         final ExperimenterInstructionDeserializerKey key4
 168             = new ExperimenterInstructionDeserializerKey(EncodeConstants.OF10_VERSION_ID,42L);
 169         provider.registerInstructionDeserializer(key4, deserializer);
 170         Assert.assertTrue("Wrong -- unregister InstructionDeserializer", provider.unregisterDeserializer(key4));
 171         Assert.assertFalse("Wrong -- unregister InstructionDeserializer by not existing key", provider.unregisterDeserializer(key4));
 172         // -- registerMatchEntryDeserializer
 173         final MatchEntryDeserializerKey key5
 174             = new MatchEntryDeserializerKey(EncodeConstants.OF10_VERSION_ID, 0x8000, 42);
 175         provider.registerMatchEntryDeserializer(key5, deserializer);
 176         Assert.assertTrue("Wrong -- unregister MatchEntryDeserializer", provider.unregisterDeserializer(key5));
 177         Assert.assertFalse("Wrong -- unregister MatchEntryDeserializer by not existing key", provider.unregisterDeserializer(key5));
 178         // -- registerErrorDeserializer
 179         final ExperimenterIdDeserializerKey key6
 180             = new ExperimenterIdDeserializerKey(EncodeConstants.OF10_VERSION_ID, 42L, ErrorMessage.class);
 181         provider.registerErrorDeserializer(key6, deserializerError);
 182         Assert.assertTrue("Wrong -- unregister ErrorDeserializer", provider.unregisterDeserializer(key6));
 183         Assert.assertFalse("Wrong -- unregister ErrorDeserializer by not existing key", provider.unregisterDeserializer(key6));
 184         // -- registerExperimenterMessageDeserializer
 185         final ExperimenterIdDeserializerKey key7
 186             = new ExperimenterIdDeserializerKey(EncodeConstants.OF10_VERSION_ID, 42L, ExperimenterMessage.class);
 187         provider.registerExperimenterMessageDeserializer(key7, deserializerExpMsg);
 188         Assert.assertTrue("Wrong -- unregister ExperimenterMessageDeserializer", provider.unregisterDeserializer(key7));
 189         Assert.assertFalse("Wrong -- unregister ExperimenterMessageDeserializer by not existing key", provider.unregisterDeserializer(key7));
 190         // -- registerMultipartReplyMessageDeserializer
 191         final ExperimenterIdDeserializerKey key8
 192             = new ExperimenterIdDeserializerKey(EncodeConstants.OF10_VERSION_ID, 42L, MultipartReplyMessage.class);
 193         provider.registerMultipartReplyMessageDeserializer(key8, deserializerMultipartRplMsg);
 194         Assert.assertTrue("Wrong -- unregister MultipartReplyMessageDeserializer", provider.unregisterDeserializer(key8));
 195         Assert.assertFalse("Wrong -- unregister MultipartReplyMessageDeserializer by not existing key", provider.unregisterDeserializer(key8));
 196         // -- registerMultipartReplyTFDeserializer
 197         final ExperimenterIdDeserializerKey key9 =
 198                 new ExperimenterIdDeserializerKey(EncodeConstants.OF10_VERSION_ID, 42L, MultipartReplyMessage.class);
 199         provider.registerMultipartReplyTFDeserializer(key9, deserializer);
 200         Assert.assertTrue("Wrong -- unregister MultipartReplyTFDeserializer", provider.unregisterDeserializer(key9));
 201         Assert.assertFalse("Wrong -- unregister MultipartReplyTFDeserializer by non existing key", provider.unregisterDeserializer(key9));
 202         // -- registerQueuePropertyDeserializer
 203         final ExperimenterIdDeserializerKey key10
 204             = new ExperimenterIdDeserializerKey(EncodeConstants.OF10_VERSION_ID, 42L, QueueProperty.class);
 205         provider.registerQueuePropertyDeserializer(key10, deserializerQueueProperty);
 206         Assert.assertTrue("Wrong -- unregister QueuePropertyDeserializer", provider.unregisterDeserializer(key10));
 207         Assert.assertFalse("Wrong -- unregister QueuePropertyDeserializer by not existing key", provider.unregisterDeserializer(key10));
 208         // -- registerMeterBandDeserializer
 209         final ExperimenterIdDeserializerKey key11
 210             = new ExperimenterIdDeserializerKey(EncodeConstants.OF10_VERSION_ID, 42L, MeterBandExperimenterCase.class);
 211         provider.registerMeterBandDeserializer(key11, deserializerMeterBandExpCase);
 212         Assert.assertTrue("Wrong -- unregister MeterBandDeserializer", provider.unregisterDeserializer(key11));
 213         Assert.assertFalse("Wrong -- unregister MeterBandDeserializer by not existing key", provider.unregisterDeserializer(key11));
 214         // -- registerExperimenterMessageSerializer
 215         ExperimenterIdSerializerKey<ExperimenterDataOfChoice> key12
 216                 = new ExperimenterIdSerializerKey<>(EncodeConstants.OF10_VERSION_ID, 42L, ExperimenterDataOfChoice.class);
 217         provider.registerExperimenterMessageSerializer(key12, serializerExperimenterInput);
 218         Assert.assertTrue("Wrong -- unregister ExperimenterMessageSerializer", provider.unregisterSerializer(key12));
 219         Assert.assertFalse("Wrong -- unregister ExperimenterMessageSerializer by not existing key", provider.unregisterSerializer(key12));
 220         //registerMultipartRequestSerializer
 221         ExperimenterIdSerializerKey<ExperimenterDataOfChoice> key13
 222                 = new ExperimenterIdSerializerKey<>(EncodeConstants.OF10_VERSION_ID, 42L, ExperimenterDataOfChoice.class);
 223         provider.registerMultipartRequestSerializer(key13, serializerMultipartRequestExpCase);
 224         Assert.assertTrue("Wrong -- unregister MultipartRequestSerializer", provider.unregisterSerializer(key13));
 225         Assert.assertFalse("Wrong -- unregister MultipartRequestSerializer by not existing key", provider.unregisterSerializer(key13));
 226         // -- registerMultipartRequestTFSerializer
 227         final ExperimenterIdSerializerKey<TableFeatureProperties> key14
 228             = new ExperimenterIdSerializerKey<>(EncodeConstants.OF10_VERSION_ID,42L,TableFeatureProperties.class);
 229         provider.registerMultipartRequestTFSerializer(key14, serializer);
 230         Assert.assertTrue("Wrong -- unregister MultipartRequestTFSerializer", provider.unregisterSerializer(key14));
 231         Assert.assertFalse("Wrong -- unregister MultipartRequestTFSerializer by not existing key", provider.unregisterSerializer(key14));
 232         // -- registerMeterBandSerializer
 233         final ExperimenterIdMeterSubTypeSerializerKey<MeterBandExperimenterCase> key15
 234             = new ExperimenterIdMeterSubTypeSerializerKey<>(EncodeConstants.OF10_VERSION_ID,42L,MeterBandExperimenterCase.class,null);
 235         provider.registerMeterBandSerializer(key15, serializerMeterBandExpCase);
 236         Assert.assertTrue("Wrong -- unregister MeterBandSerializer", provider.unregisterSerializer(key15));
 237         Assert.assertFalse("Wrong -- unregister MeterBandSerializer by not existing key", provider.unregisterSerializer(key15));
 238         // -- registerMatchEntrySerializer
 239         final MatchEntrySerializerKey<OpenflowBasicClass, InPort> key16
 240             = new MatchEntrySerializerKey<>(EncodeConstants.OF13_VERSION_ID, OpenflowBasicClass.class, InPort.class);
 241         provider.registerMatchEntrySerializer(key16, serializer);
 242         Assert.assertTrue("Wrong -- unregister MatchEntrySerializer", provider.unregisterSerializer(key16));
 243         Assert.assertFalse("Wrong -- unregister MatchEntrySerializer by not existing key", provider.unregisterSerializer(key15));
 244     }
 245
 246     private static class TestSubType extends ExperimenterActionSubType {
 247         // empty class - only used in test for comparation
 248     }
 249 }