renderers/ofoverlay/src/test/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/arp/ArpTaskerTest.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.groupbasedpolicy.renderer.ofoverlay.arp;
  10
  11 import java.net.InetAddress;
  12 import java.util.Collections;
  13 import java.util.concurrent.Future;
  14
  15 import org.junit.Assert;
  16 import org.junit.Before;
  17 import org.junit.Test;
  18 import org.mockito.ArgumentCaptor;
  19 import org.mockito.Matchers;
  20 import org.mockito.Mockito;
  21 import org.opendaylight.controller.liblldp.EtherTypes;
  22 import org.opendaylight.controller.liblldp.Ethernet;
  23 import org.opendaylight.controller.liblldp.HexEncode;
  24 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  25 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  26 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  29 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  30 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.test.OfOverlayDataBrokerTest;
  31 import org.opendaylight.groupbasedpolicy.util.IidFactory;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev100924.MacAddress;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnectorBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutput;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L2BridgeDomainId;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L2ContextId;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.L3ContextId;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.NetworkDomainId;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.SubnetId;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.Endpoints;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointL3;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointL3Builder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.EndpointL3Key;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayContext;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayContextBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayL3Context;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayL3ContextBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayNodeConfig;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayNodeConfigBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.nodes.node.ExternalInterfacesBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.Tenants;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.TenantsBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.Tenant;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.TenantBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.TenantKey;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.ForwardingContext;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.ForwardingContextBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.L2BridgeDomain;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.L2BridgeDomainBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.L2BridgeDomainKey;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.forwarding.context.SubnetBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.ArpMatch;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingService;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceivedBuilder;
  87 import org.opendaylight.yangtools.yang.binding.DataObject;
  88 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  89 import org.opendaylight.yangtools.yang.common.RpcResult;
  90
  91 import com.google.common.base.Optional;
  92 import com.google.common.util.concurrent.CheckedFuture;
  93 import com.google.common.util.concurrent.Futures;
  94
  95 public class ArpTaskerTest extends OfOverlayDataBrokerTest {
  96
  97     private ArpTasker arpTasker;
  98     private DataBroker broker;
  99     private RpcProviderRegistry rpcRegistry;
 100     private SalFlowService flowService;
 101
 102     @Before
 103     public void init() {
 104
 105         PacketProcessingService packetService = Mockito.mock(PacketProcessingService.class);
 106         flowService = Mockito.mock(SalFlowService.class);
 107         rpcRegistry = Mockito.mock(RpcProviderRegistry.class);
 108         Mockito.when(rpcRegistry.getRpcService(PacketProcessingService.class)).thenReturn(packetService);
 109         Mockito.when(rpcRegistry.getRpcService(SalFlowService.class)).thenReturn(flowService);
 110     }
 111
 112     @SuppressWarnings("unchecked")
 113     @Test
 114     public void addMacForL3EpAndCreateEp_onPacketReceivedTest() throws Exception {
 115
 116         IpAddress ipAddr = new IpAddress(new Ipv4Address("192.168.0.1"));
 117         L3ContextId l3conId = new L3ContextId("l3context");
 118         EndpointL3Key key = new EndpointL3Key(ipAddr, l3conId);
 119         EndpointL3Builder epL3 = new EndpointL3Builder();
 120         // node conector
 121         NodeConnectorId connectorId = new NodeConnectorId("nodeConnector");
 122         MacAddress macAddr = new MacAddress("00:00:00:00:00:01");
 123         FlowCapableNodeConnectorBuilder fcnConnector =
 124                 new FlowCapableNodeConnectorBuilder().setHardwareAddress(macAddr);
 125         NodeConnectorBuilder connector = new NodeConnectorBuilder().setKey(new NodeConnectorKey(connectorId))
 126             .addAugmentation(FlowCapableNodeConnector.class, fcnConnector.build());
 127         // node
 128         NodeId nodeId = new NodeId("node");
 129         ExternalInterfacesBuilder extIface = new ExternalInterfacesBuilder().setNodeConnectorId(connectorId);
 130         OfOverlayNodeConfigBuilder ofOverNodeCfg =
 131                 new OfOverlayNodeConfigBuilder().setExternalInterfaces(Collections.singletonList(extIface.build()));
 132         NodeBuilder node = new NodeBuilder().addAugmentation(OfOverlayNodeConfig.class, ofOverNodeCfg.build())
 133                 .setKey(new NodeKey(nodeId))
 134                 .setId(nodeId)
 135                 .setNodeConnector(Collections.singletonList(connector.build()));
 136         // subnet
 137         NetworkDomainId domainId = new NetworkDomainId("domainId");
 138         TenantId tenantId = new TenantId("tenant");
 139         L2ContextId l2conId = new L2ContextId("l2context");
 140         SubnetBuilder subnet = new SubnetBuilder().setId(new SubnetId(domainId))
 141             .setIpPrefix(new IpPrefix(new Ipv4Prefix(ipAddr.getIpv4Address().getValue() + "/24")))
 142             .setParent(l2conId);
 143         TenantsBuilder tenants =
 144                 new TenantsBuilder().setTenant(Collections.singletonList(new TenantBuilder().setId(tenantId)
 145                     .setForwardingContext(
 146                             new ForwardingContextBuilder().setSubnet(Collections.singletonList(subnet.build())).build())
 147                     .build()));
 148
 149         // test without key
 150         ReadOnlyTransaction rtx = Mockito.mock(ReadOnlyTransaction.class);
 151         broker = Mockito.mock(DataBroker.class);
 152         arpTasker = new ArpTasker(rpcRegistry, broker);
 153
 154         epL3.setKey(new EndpointL3Key(Mockito.mock(IpAddress.class), null));
 155         arpTasker.addMacForL3EpAndCreateEp(epL3.build());
 156         Mockito.verify(broker, Mockito.never()).newReadOnlyTransaction();
 157
 158         // test without node with external interface
 159         epL3.setKey(key);
 160         Mockito.when(broker.newReadOnlyTransaction()).thenReturn(rtx);
 161         CheckedFuture<Optional<DataObject>, ReadFailedException> future =
 162                 Futures.immediateCheckedFuture(Optional.<DataObject>absent());
 163         Mockito.when(rtx.read(Matchers.eq(LogicalDatastoreType.CONFIGURATION), Matchers.any(InstanceIdentifier.class)))
 164             .thenReturn(future);
 165         arpTasker.addMacForL3EpAndCreateEp(epL3.build());
 166         Mockito.verify(broker).newReadOnlyTransaction();
 167         Mockito.verify(rtx).close();
 168
 169         // test correct
 170         broker = getDataBroker();
 171         arpTasker = new ArpTasker(rpcRegistry, broker);
 172         WriteTransaction wtx = broker.newWriteOnlyTransaction();
 173         wtx.put(LogicalDatastoreType.CONFIGURATION, InstanceIdentifier.builder(Nodes.class).build(),
 174                 new NodesBuilder().setNode(Collections.singletonList(node.build())).build(), true);
 175         wtx.put(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.builder(Nodes.class)
 176                 .child(Node.class, node.getKey())
 177                 .child(NodeConnector.class, new NodeConnectorKey(connectorId))
 178                 .build(),
 179                 connector.build(), true);
 180         wtx.put(LogicalDatastoreType.CONFIGURATION, InstanceIdentifier.builder(Tenants.class).build(), tenants.build(),
 181                 true);
 182         wtx.submit().get();
 183
 184         Future<RpcResult<AddFlowOutput>> flowFuture = Mockito.mock(Future.class);
 185         Mockito.when(flowService.addFlow(Mockito.any(AddFlowInput.class))).thenReturn(flowFuture);
 186
 187         epL3.setNetworkContainment(domainId).setTenant(tenantId);
 188         arpTasker.addMacForL3EpAndCreateEp(epL3.build());
 189         ArgumentCaptor<AddFlowInput> argument = ArgumentCaptor.forClass(AddFlowInput.class);
 190         Mockito.verify(flowService).addFlow(argument.capture());
 191         AddFlowInput result = argument.getValue();
 192         Assert.assertEquals(EtherTypes.ARP.intValue(),
 193                 result.getMatch().getEthernetMatch().getEthernetType().getType().getValue().intValue());
 194         ArpMatch match = (ArpMatch)result.getMatch().getLayer3Match();
 195         Assert.assertEquals(ArpOperation.REPLY.intValue(),match.getArpOp().intValue());
 196         Assert.assertEquals("192.168.0.254/32",match.getArpTargetTransportAddress().getValue());
 197         Assert.assertEquals("192.168.0.1/32", match.getArpSourceTransportAddress().getValue());
 198         Assert.assertEquals(connectorId, result.getMatch().getInPort());
 199         Assert.assertEquals(new NodeRef(InstanceIdentifier.builder(Nodes.class)
 200                 .child(Node.class, node.getKey()).build()), result.getNode());
 201
 202         // onPacketReceived
 203         Arp arp = new Arp();
 204         byte[] sha = HexEncode.bytesFromHexString("00:00:00:00:00:01");
 205         byte[] spa = InetAddress.getByName("192.168.0.1").getAddress();
 206         byte[] tha = HexEncode.bytesFromHexString("00:00:00:00:00:02");
 207         byte[] tpa = InetAddress.getByName("192.168.0.2").getAddress();
 208         int htype = 1;
 209         int ptype = EtherTypes.IPv4.intValue();
 210         short hlen = 6;
 211         short plen = 4;
 212         int operation = ArpOperation.REPLY.intValue();
 213
 214         arp.setSenderHardwareAddress(sha);
 215         arp.setSenderProtocolAddress(spa);
 216         arp.setTargetHardwareAddress(tha);
 217         arp.setTargetProtocolAddress(tpa);
 218         arp.setOperation(operation);
 219         arp.setHardwareLength(hlen);
 220         arp.setProtocolLength(plen);
 221         arp.setHardwareType(htype);
 222         arp.setProtocolType(ptype);
 223
 224         Ethernet arpFrame = new Ethernet().setSourceMACAddress(sha)
 225             .setDestinationMACAddress(tha)
 226             .setEtherType(EtherTypes.ARP.shortValue());
 227         arpFrame.setPayload(arp);
 228
 229         L2BridgeDomainId l2domainId = new L2BridgeDomainId(l2conId);
 230         L2BridgeDomainBuilder l2domain = new L2BridgeDomainBuilder().setId(l2domainId);
 231
 232         InstanceIdentifier<NodeConnector> ncIid = InstanceIdentifier.builder(Nodes.class)
 233             .child(Node.class, new NodeKey(new NodeId("node")))
 234             .child(NodeConnector.class, new NodeConnectorKey(new NodeConnectorId("connector")))
 235             .build();
 236         PacketReceived packet = new PacketReceivedBuilder().setPayload(arpFrame.serialize())
 237             .setIngress(new NodeConnectorRef(ncIid))
 238             .build();
 239
 240         wtx = broker.newWriteOnlyTransaction();
 241         OfOverlayL3Context augment = new OfOverlayL3ContextBuilder().build();
 242         epL3.addAugmentation(OfOverlayL3Context.class, augment);
 243         InstanceIdentifier<EndpointL3> epL3Iid =
 244                 InstanceIdentifier.builder(Endpoints.class).child(EndpointL3.class, key).build();
 245         wtx.put(LogicalDatastoreType.OPERATIONAL, epL3Iid, epL3.build(), true);
 246
 247         InstanceIdentifier<L2BridgeDomain> l2domainIid = InstanceIdentifier.builder(Tenants.class)
 248             .child(Tenant.class, new TenantKey(tenantId))
 249             .child(ForwardingContext.class)
 250             .child(L2BridgeDomain.class, new L2BridgeDomainKey(l2domainId))
 251             .build();
 252         wtx.put(LogicalDatastoreType.OPERATIONAL, l2domainIid, l2domain.build() ,true);
 253         wtx.submit();
 254
 255         arpTasker.onPacketReceived(packet);
 256         rtx = broker.newReadOnlyTransaction();
 257         Optional<EndpointL3> optional = rtx.read(LogicalDatastoreType.OPERATIONAL, epL3Iid).get();
 258         Assert.assertTrue(optional.isPresent());
 259         EndpointL3 epl3 = optional.get();
 260         Assert.assertArrayEquals(sha, HexEncode.bytesFromHexString(epl3.getMacAddress().getValue()));
 261         Assert.assertEquals(l2domain.getId(), epl3.getL2Context());
 262         Optional<Endpoint> optionalEp = rtx.read(LogicalDatastoreType.OPERATIONAL,
 263                 IidFactory.endpointIid(l2domainId, new MacAddress("00:00:00:00:00:01"))).get();
 264         Assert.assertTrue(optionalEp.isPresent());
 265         Assert.assertEquals(new OfOverlayContextBuilder(augment).build(), optionalEp.get().getAugmentation(OfOverlayContext.class));
 266     }
 267 }