IntentSync test without state

The current Router class does not check the Intent state.
So I did not add the state in this patch.
I will push another patch for testing the intent state.

Change-Id: Idb44dcace5f33a0144852a999445931bc2189448

@@ -447,7 +447,8 @@ public class Router implements RouteListener {
             Objects.equal(action1, action2) &&
             Objects.equal(action1, action2) &&
             Objects.equal(egressPort1, egressPort2) &&
             Objects.equal(egressPort1, egressPort2) &&
             Objects.equal(ingressPorts1, ingressPorts2);*/
             Objects.equal(ingressPorts1, ingressPorts2);*/
-        return Objects.equal(intent1.selector(), intent2.selector()) &&
+        return Objects.equal(intent1.appId(), intent2.appId()) &&
+                Objects.equal(intent1.selector(), intent2.selector()) &&
                 Objects.equal(intent1.treatment(), intent2.treatment()) &&
                 Objects.equal(intent1.treatment(), intent2.treatment()) &&
                 Objects.equal(intent1.ingressPoints(), intent2.ingressPoints()) &&
                 Objects.equal(intent1.ingressPoints(), intent2.ingressPoints()) &&
                 Objects.equal(intent1.egressPoint(), intent2.egressPoint());
                 Objects.equal(intent1.egressPoint(), intent2.egressPoint());

+package org.onlab.onos.sdnip;
+
+import static org.easymock.EasyMock.anyObject;
+import static org.easymock.EasyMock.createMock;
+import static org.easymock.EasyMock.expect;
+import static org.easymock.EasyMock.expectLastCall;
+import static org.easymock.EasyMock.replay;
+import static org.easymock.EasyMock.reset;
+import static org.easymock.EasyMock.verify;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.util.HashSet;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.onlab.junit.TestUtils;
+import org.onlab.junit.TestUtils.TestUtilsException;
+import org.onlab.onos.core.ApplicationId;
+import org.onlab.onos.net.ConnectPoint;
+import org.onlab.onos.net.DefaultHost;
+import org.onlab.onos.net.DeviceId;
+import org.onlab.onos.net.Host;
+import org.onlab.onos.net.HostId;
+import org.onlab.onos.net.HostLocation;
+import org.onlab.onos.net.PortNumber;
+import org.onlab.onos.net.flow.DefaultTrafficSelector;
+import org.onlab.onos.net.flow.DefaultTrafficTreatment;
+import org.onlab.onos.net.flow.TrafficSelector;
+import org.onlab.onos.net.flow.TrafficTreatment;
+import org.onlab.onos.net.host.HostListener;
+import org.onlab.onos.net.host.HostService;
+import org.onlab.onos.net.host.InterfaceIpAddress;
+import org.onlab.onos.net.intent.Intent;
+import org.onlab.onos.net.intent.IntentService;
+import org.onlab.onos.net.intent.MultiPointToSinglePointIntent;
+import org.onlab.onos.net.provider.ProviderId;
+import org.onlab.onos.sdnip.config.Interface;
+import org.onlab.packet.Ethernet;
+import org.onlab.packet.IpAddress;
+import org.onlab.packet.IpPrefix;
+import org.onlab.packet.MacAddress;
+import org.onlab.packet.VlanId;
+
+import com.google.common.collect.Sets;
+import com.googlecode.concurrenttrees.radix.node.concrete.DefaultByteArrayNodeFactory;
+import com.googlecode.concurrenttrees.radixinverted.ConcurrentInvertedRadixTree;
+import com.googlecode.concurrenttrees.radixinverted.InvertedRadixTree;
+
+/**
+ * This class tests the intent synchronization function in Router class.
+ */
+public class IntentSyncTest {
+
+    private InterfaceService interfaceService;
+    private IntentService intentService;
+    private HostService hostService;
+
+    private static final ConnectPoint SW1_ETH1 = new ConnectPoint(
+            DeviceId.deviceId("of:0000000000000001"),
+            PortNumber.portNumber(1));
+
+    private static final ConnectPoint SW2_ETH1 = new ConnectPoint(
+            DeviceId.deviceId("of:0000000000000002"),
+            PortNumber.portNumber(1));
+
+    private static final ConnectPoint SW3_ETH1 = new ConnectPoint(
+            DeviceId.deviceId("of:0000000000000003"),
+            PortNumber.portNumber(1));
+
+    private Router router;
+
+    private static final ApplicationId APPID = new ApplicationId() {
+        @Override
+        public short id() {
+            return 1;
+        }
+
+        @Override
+        public String name() {
+            return "SDNIP";
+        }
+    };
+
+    @Before
+    public void setUp() throws Exception {
+        setUpInterfaceService();
+        setUpHostService();
+        intentService = createMock(IntentService.class);
+
+        router = new Router(APPID, intentService,
+                hostService, null, interfaceService);
+    }
+
+    /**
+     * Sets up InterfaceService.
+     */
+    private void setUpInterfaceService() {
+
+        interfaceService = createMock(InterfaceService.class);
+
+        Set<Interface> interfaces = Sets.newHashSet();
+
+        Set<InterfaceIpAddress> interfaceIpAddresses1 = Sets.newHashSet();
+        interfaceIpAddresses1.add(new InterfaceIpAddress(
+                IpAddress.valueOf("192.168.10.101"),
+                IpPrefix.valueOf("192.168.10.0/24")));
+        Interface sw1Eth1 = new Interface(SW1_ETH1,
+                interfaceIpAddresses1, MacAddress.valueOf("00:00:00:00:00:01"));
+        interfaces.add(sw1Eth1);
+
+        Set<InterfaceIpAddress> interfaceIpAddresses2 = Sets.newHashSet();
+        interfaceIpAddresses2.add(new InterfaceIpAddress(
+                IpAddress.valueOf("192.168.20.101"),
+                IpPrefix.valueOf("192.168.20.0/24")));
+        Interface sw2Eth1 = new Interface(SW2_ETH1,
+                interfaceIpAddresses2, MacAddress.valueOf("00:00:00:00:00:02"));
+        interfaces.add(sw2Eth1);
+
+        Set<InterfaceIpAddress> interfaceIpAddresses3 = Sets.newHashSet();
+        interfaceIpAddresses3.add(new InterfaceIpAddress(
+                IpAddress.valueOf("192.168.30.101"),
+                IpPrefix.valueOf("192.168.30.0/24")));
+        Interface sw3Eth1 = new Interface(SW3_ETH1,
+                interfaceIpAddresses3, MacAddress.valueOf("00:00:00:00:00:03"));
+        interfaces.add(sw3Eth1);
+
+        expect(interfaceService.getInterface(SW1_ETH1)).andReturn(
+                sw1Eth1).anyTimes();
+        expect(interfaceService.getInterface(SW2_ETH1)).andReturn(
+                sw2Eth1).anyTimes();
+        expect(interfaceService.getInterface(SW3_ETH1)).andReturn(
+                sw3Eth1).anyTimes();
+        expect(interfaceService.getInterfaces()).andReturn(
+                interfaces).anyTimes();
+        replay(interfaceService);
+    }
+
+    /**
+     * Sets up the host service with details of hosts.
+     */
+    private void setUpHostService() {
+        hostService = createMock(HostService.class);
+
+        hostService.addListener(anyObject(HostListener.class));
+        expectLastCall().anyTimes();
+
+        IpAddress host1Address = IpAddress.valueOf("192.168.10.1");
+        Host host1 = new DefaultHost(ProviderId.NONE, HostId.NONE,
+                MacAddress.valueOf("00:00:00:00:00:01"), VlanId.NONE,
+                new HostLocation(SW1_ETH1, 1),
+                        Sets.newHashSet(host1Address));
+
+        expect(hostService.getHostsByIp(host1Address))
+                .andReturn(Sets.newHashSet(host1)).anyTimes();
+        hostService.startMonitoringIp(host1Address);
+        expectLastCall().anyTimes();
+
+
+        IpAddress host2Address = IpAddress.valueOf("192.168.20.1");
+        Host host2 = new DefaultHost(ProviderId.NONE, HostId.NONE,
+                MacAddress.valueOf("00:00:00:00:00:02"), VlanId.NONE,
+                new HostLocation(SW2_ETH1, 1),
+                        Sets.newHashSet(host2Address));
+
+        expect(hostService.getHostsByIp(host2Address))
+                .andReturn(Sets.newHashSet(host2)).anyTimes();
+        hostService.startMonitoringIp(host2Address);
+        expectLastCall().anyTimes();
+
+
+        IpAddress host3Address = IpAddress.valueOf("192.168.30.1");
+        Host host3 = new DefaultHost(ProviderId.NONE, HostId.NONE,
+                MacAddress.valueOf("00:00:00:00:00:03"), VlanId.NONE,
+                new HostLocation(SW3_ETH1, 1),
+                        Sets.newHashSet(host3Address));
+
+        expect(hostService.getHostsByIp(host3Address))
+                .andReturn(Sets.newHashSet(host3)).anyTimes();
+        hostService.startMonitoringIp(host3Address);
+        expectLastCall().anyTimes();
+
+
+        replay(hostService);
+    }
+
+    /**
+     * This method tests the behavior of intent Synchronizer.
+     *
+     * @throws TestUtilsException
+     */
+    @Test
+    public void testIntentSync() throws TestUtilsException {
+
+        //
+        // Construct routes and intents.
+        // This test simulates the following cases during the master change
+        // time interval:
+        // 1. RouteEntry1 did not change and the intent also did not change.
+        // 2. RouteEntry2 was deleted, but the intent was not deleted.
+        // 3. RouteEntry3 was newly added, and the intent was also submitted.
+        // 4. RouteEntry4 was updated to RouteEntry4Update, and the intent was
+        // also updated to a new one.
+        // 5. RouteEntry5 did not change, but its intent id changed.
+        // 6. RouteEntry6 was newly added, but the intent was not submitted.
+        //
+        RouteEntry routeEntry1 = new RouteEntry(
+                IpPrefix.valueOf("1.1.1.0/24"),
+                IpAddress.valueOf("192.168.10.1"));
+
+        RouteEntry routeEntry2 = new RouteEntry(
+                IpPrefix.valueOf("2.2.2.0/24"),
+                IpAddress.valueOf("192.168.20.1"));
+
+        RouteEntry routeEntry3 = new RouteEntry(
+                IpPrefix.valueOf("3.3.3.0/24"),
+                IpAddress.valueOf("192.168.30.1"));
+
+        RouteEntry routeEntry4 = new RouteEntry(
+                IpPrefix.valueOf("4.4.4.0/24"),
+                IpAddress.valueOf("192.168.30.1"));
+
+        RouteEntry routeEntry4Update = new RouteEntry(
+                IpPrefix.valueOf("4.4.4.0/24"),
+                IpAddress.valueOf("192.168.20.1"));
+
+        RouteEntry routeEntry5 = new RouteEntry(
+                IpPrefix.valueOf("5.5.5.0/24"),
+                IpAddress.valueOf("192.168.10.1"));
+
+        RouteEntry routeEntry6 = new RouteEntry(
+                IpPrefix.valueOf("6.6.6.0/24"),
+                IpAddress.valueOf("192.168.10.1"));
+
+        MultiPointToSinglePointIntent intent1 = intentBuilder(
+                routeEntry1.prefix(), "00:00:00:00:00:01", SW1_ETH1);
+        MultiPointToSinglePointIntent intent2 = intentBuilder(
+                routeEntry2.prefix(), "00:00:00:00:00:02", SW2_ETH1);
+        MultiPointToSinglePointIntent intent3 = intentBuilder(
+                routeEntry3.prefix(), "00:00:00:00:00:03", SW3_ETH1);
+        MultiPointToSinglePointIntent intent4 = intentBuilder(
+                routeEntry4.prefix(), "00:00:00:00:00:03", SW3_ETH1);
+        MultiPointToSinglePointIntent intent4Update = intentBuilder(
+                routeEntry4Update.prefix(), "00:00:00:00:00:02", SW2_ETH1);
+        MultiPointToSinglePointIntent intent5 = intentBuilder(
+                routeEntry5.prefix(), "00:00:00:00:00:01",  SW1_ETH1);
+
+        // Compose a intent, which is equal to intent5 but the id is different.
+        MultiPointToSinglePointIntent intent5New =
+                staticIntentBuilder(intent5, routeEntry5, "00:00:00:00:00:01");
+        assertTrue(TestUtils.callMethod(router,
+                "compareMultiPointToSinglePointIntents",
+                new Class<?>[] {MultiPointToSinglePointIntent.class,
+                MultiPointToSinglePointIntent.class},
+                intent5, intent5New).equals(true));
+        assertTrue(!intent5.equals(intent5New));
+
+        MultiPointToSinglePointIntent intent6 = intentBuilder(
+                routeEntry6.prefix(), "00:00:00:00:00:01",  SW1_ETH1);
+
+        // Set up the bgpRoutes and pushedRouteIntents fields in Router class
+        InvertedRadixTree<RouteEntry> bgpRoutes =
+                new ConcurrentInvertedRadixTree<>(
+                new DefaultByteArrayNodeFactory());
+        bgpRoutes.put(RouteEntry.createBinaryString(routeEntry1.prefix()),
+                routeEntry1);
+        bgpRoutes.put(RouteEntry.createBinaryString(routeEntry3.prefix()),
+                routeEntry3);
+        bgpRoutes.put(RouteEntry.createBinaryString(routeEntry4Update.prefix()),
+                routeEntry4Update);
+        bgpRoutes.put(RouteEntry.createBinaryString(routeEntry5.prefix()),
+                routeEntry5);
+        bgpRoutes.put(RouteEntry.createBinaryString(routeEntry6.prefix()),
+                routeEntry6);
+        TestUtils.setField(router, "bgpRoutes", bgpRoutes);
+
+        ConcurrentHashMap<IpPrefix, MultiPointToSinglePointIntent>
+        pushedRouteIntents =  new ConcurrentHashMap<>();
+        pushedRouteIntents.put(routeEntry1.prefix(), intent1);
+        pushedRouteIntents.put(routeEntry3.prefix(), intent3);
+        pushedRouteIntents.put(routeEntry4Update.prefix(), intent4Update);
+        pushedRouteIntents.put(routeEntry5.prefix(), intent5New);
+        pushedRouteIntents.put(routeEntry6.prefix(), intent6);
+        TestUtils.setField(router, "pushedRouteIntents", pushedRouteIntents);
+
+        // Set up expectation
+        reset(intentService);
+        Set<Intent> intents = new HashSet<Intent>();
+        intents.add(intent1);
+        intents.add(intent2);
+        intents.add(intent4);
+        intents.add(intent5);
+        expect(intentService.getIntents()).andReturn(intents).anyTimes();
+
+        intentService.withdraw(intent2);
+        intentService.submit(intent3);
+        intentService.withdraw(intent4);
+        intentService.submit(intent4Update);
+        intentService.submit(intent6);
+        replay(intentService);
+
+        // Start the test
+        router.leaderChanged(true);
+        TestUtils.callMethod(router, "syncIntents", new Class<?>[] {});
+
+        // Verify
+        assertEquals(router.getRoutes().size(), 5);
+        assertTrue(router.getRoutes().contains(routeEntry1));
+        assertTrue(router.getRoutes().contains(routeEntry3));
+        assertTrue(router.getRoutes().contains(routeEntry4Update));
+        assertTrue(router.getRoutes().contains(routeEntry5));
+        assertTrue(router.getRoutes().contains(routeEntry6));
+
+        assertEquals(router.getPushedRouteIntents().size(), 5);
+        assertTrue(router.getPushedRouteIntents().contains(intent1));
+        assertTrue(router.getPushedRouteIntents().contains(intent3));
+        assertTrue(router.getPushedRouteIntents().contains(intent4Update));
+        assertTrue(router.getPushedRouteIntents().contains(intent5));
+        assertTrue(router.getPushedRouteIntents().contains(intent6));
+
+        verify(intentService);
+    }
+
+    /**
+     * MultiPointToSinglePointIntent builder.
+     *
+     * @param ipPrefix the ipPrefix to match
+     * @param nextHopMacAddress to which the destination MAC address in packet
+     * should be rewritten
+     * @param egressPoint to which packets should be sent
+     * @return the constructed MultiPointToSinglePointIntent
+     */
+    private MultiPointToSinglePointIntent intentBuilder(IpPrefix ipPrefix,
+            String nextHopMacAddress, ConnectPoint egressPoint) {
+
+        TrafficSelector.Builder selectorBuilder =
+                DefaultTrafficSelector.builder();
+        selectorBuilder.matchEthType(Ethernet.TYPE_IPV4).matchIPDst(ipPrefix);
+
+        TrafficTreatment.Builder treatmentBuilder =
+                DefaultTrafficTreatment.builder();
+        treatmentBuilder.setEthDst(MacAddress.valueOf(nextHopMacAddress));
+
+        Set<ConnectPoint> ingressPoints = new HashSet<ConnectPoint>();
+        for (Interface intf : interfaceService.getInterfaces()) {
+            if (!intf.equals(interfaceService.getInterface(egressPoint))) {
+                ConnectPoint srcPort = intf.connectPoint();
+                ingressPoints.add(srcPort);
+            }
+        }
+        MultiPointToSinglePointIntent intent =
+                new MultiPointToSinglePointIntent(APPID,
+                        selectorBuilder.build(), treatmentBuilder.build(),
+                        ingressPoints, egressPoint);
+        return intent;
+    }
+
+    /**
+     * A static MultiPointToSinglePointIntent builder, the returned intent is
+     * equal to the input intent except that the id is different.
+     *
+     *
+     * @param intent the intent to be used for building a new intent
+     * @param routeEntry the relative routeEntry of the intent
+     * @return the newly constructed MultiPointToSinglePointIntent
+     * @throws TestUtilsException
+     */
+    private  MultiPointToSinglePointIntent staticIntentBuilder(
+            MultiPointToSinglePointIntent intent, RouteEntry routeEntry,
+            String nextHopMacAddress) throws TestUtilsException {
+
+        // Use a different egress ConnectPoint with that in intent
+        // to generate a different id
+        MultiPointToSinglePointIntent intentNew = intentBuilder(
+                routeEntry.prefix(), nextHopMacAddress, SW2_ETH1);
+        TestUtils.setField(intentNew, "egressPoint", intent.egressPoint());
+        TestUtils.setField(intentNew,
+                "ingressPoints", intent.ingressPoints());
+        return intentNew;
+    }
+}