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