ONOS-2186 - GUI Topo Overlay - (WIP)
- added devicesWithHover(), hostsWithHover(), hovered() to NodeSelection.
- wrote unit tests for NodeSelection.
Change-Id: I6dca0f4f0a4ce2412438c8411102034969ef4343
diff --git a/core/api/src/main/java/org/onosproject/ui/topo/NodeSelection.java b/core/api/src/main/java/org/onosproject/ui/topo/NodeSelection.java
index cefbf03..b284de1 100644
--- a/core/api/src/main/java/org/onosproject/ui/topo/NodeSelection.java
+++ b/core/api/src/main/java/org/onosproject/ui/topo/NodeSelection.java
@@ -21,6 +21,7 @@
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.onosproject.net.Device;
+import org.onosproject.net.Element;
import org.onosproject.net.Host;
import org.onosproject.net.device.DeviceService;
import org.onosproject.net.host.HostService;
@@ -55,10 +56,12 @@
private final Set<Device> devices = new HashSet<>();
private final Set<Host> hosts = new HashSet<>();
+ private Element hovered;
/**
* Creates a node selection entity, from the given payload, using the
- * supplied device and host services.
+ * supplied device and host services. Note that if a device or host was
+ * hovered over by the mouse, it is available via {@link #hovered()}.
*
* @param payload message payload
* @param deviceService device service
@@ -73,25 +76,24 @@
ids = extractIds(payload);
hover = extractHover(payload);
+ // start by extracting the hovered element if any
+ if (isNullOrEmpty(hover)) {
+ hovered = null;
+ } else {
+ setHoveredElement();
+ }
+
+ // now go find the devices and hosts that are in the selection list
Set<String> unmatched = findDevices(ids);
unmatched = findHosts(unmatched);
if (unmatched.size() > 0) {
log.debug("Skipping unmatched IDs {}", unmatched);
}
- if (!isNullOrEmpty(hover)) {
- unmatched = new HashSet<>();
- unmatched.add(hover);
- unmatched = findDevices(unmatched);
- unmatched = findHosts(unmatched);
- if (unmatched.size() > 0) {
- log.debug("Skipping unmatched HOVER {}", unmatched);
- }
- }
}
/**
- * Returns a view of the selected devices.
+ * Returns a view of the selected devices (hover not included).
*
* @return selected devices
*/
@@ -100,7 +102,24 @@
}
/**
- * Returns a view of the selected hosts.
+ * Returns a view of the selected devices, including the hovered device
+ * if there was one.
+ *
+ * @return selected (plus hovered) devices
+ */
+ public Set<Device> devicesWithHover() {
+ Set<Device> withHover;
+ if (hovered != null && hovered instanceof Device) {
+ withHover = new HashSet<>(devices);
+ withHover.add((Device) hovered);
+ } else {
+ withHover = devices;
+ }
+ return Collections.unmodifiableSet(withHover);
+ }
+
+ /**
+ * Returns a view of the selected hosts (hover not included).
*
* @return selected hosts
*/
@@ -109,6 +128,33 @@
}
/**
+ * Returns a view of the selected hosts, including the hovered host
+ * if thee was one.
+ *
+ * @return selected (plus hovered) hosts
+ */
+ public Set<Host> hostsWithHover() {
+ Set<Host> withHover;
+ if (hovered != null && hovered instanceof Host) {
+ withHover = new HashSet<>(hosts);
+ withHover.add((Host) hovered);
+ } else {
+ withHover = hosts;
+ }
+ return Collections.unmodifiableSet(withHover);
+ }
+
+ /**
+ * Returns the element (host or device) over which the mouse was hovering,
+ * or null.
+ *
+ * @return element hovered over
+ */
+ public Element hovered() {
+ return hovered;
+ }
+
+ /**
* Returns true if nothing is selected.
*
* @return true if nothing selected
@@ -146,6 +192,26 @@
return JsonUtils.string(payload, HOVER);
}
+ private void setHoveredElement() {
+ Set<String> unmatched;
+ unmatched = new HashSet<>();
+ unmatched.add(hover);
+ unmatched = findDevices(unmatched);
+ if (devices.size() == 1) {
+ hovered = devices.iterator().next();
+ devices.clear();
+ } else {
+ unmatched = findHosts(unmatched);
+ if (hosts.size() == 1) {
+ hovered = hosts.iterator().next();
+ hosts.clear();
+ } else {
+ hovered = null;
+ log.debug("Skipping unmatched HOVER {}", unmatched);
+ }
+ }
+ }
+
private Set<String> findDevices(Set<String> ids) {
Set<String> unmatched = new HashSet<>();
Device device;
@@ -156,9 +222,9 @@
if (device != null) {
devices.add(device);
} else {
- log.debug("Device with ID {} not found", id);
+ unmatched.add(id);
}
- } catch (IllegalArgumentException e) {
+ } catch (Exception e) {
unmatched.add(id);
}
}
@@ -175,9 +241,9 @@
if (host != null) {
hosts.add(host);
} else {
- log.debug("Host with ID {} not found", id);
+ unmatched.add(id);
}
- } catch (IllegalArgumentException e) {
+ } catch (Exception e) {
unmatched.add(id);
}
}
diff --git a/core/api/src/test/java/org/onosproject/ui/topo/NodeSelectionTest.java b/core/api/src/test/java/org/onosproject/ui/topo/NodeSelectionTest.java
new file mode 100644
index 0000000..60cada4
--- /dev/null
+++ b/core/api/src/test/java/org/onosproject/ui/topo/NodeSelectionTest.java
@@ -0,0 +1,349 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.onosproject.ui.topo;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.junit.Test;
+import org.onlab.packet.ChassisId;
+import org.onlab.packet.IpAddress;
+import org.onlab.packet.MacAddress;
+import org.onlab.packet.VlanId;
+import org.onosproject.net.Annotations;
+import org.onosproject.net.Device;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.Host;
+import org.onosproject.net.HostId;
+import org.onosproject.net.HostLocation;
+import org.onosproject.net.device.DeviceService;
+import org.onosproject.net.device.DeviceServiceAdapter;
+import org.onosproject.net.host.HostService;
+import org.onosproject.net.host.HostServiceAdapter;
+import org.onosproject.net.provider.ProviderId;
+
+import java.util.Set;
+
+import static org.junit.Assert.*;
+
+/**
+ * Unit tests for {@link NodeSelection}.
+ */
+public class NodeSelectionTest {
+
+ private static class FakeDevice implements Device {
+
+ private final DeviceId id;
+
+ FakeDevice(DeviceId id) {
+ this.id = id;
+ }
+
+ @Override
+ public DeviceId id() {
+ return id;
+ }
+
+ @Override
+ public Type type() {
+ return null;
+ }
+
+ @Override
+ public String manufacturer() {
+ return null;
+ }
+
+ @Override
+ public String hwVersion() {
+ return null;
+ }
+
+ @Override
+ public String swVersion() {
+ return null;
+ }
+
+ @Override
+ public String serialNumber() {
+ return null;
+ }
+
+ @Override
+ public ChassisId chassisId() {
+ return null;
+ }
+
+ @Override
+ public Annotations annotations() {
+ return null;
+ }
+
+ @Override
+ public ProviderId providerId() {
+ return null;
+ }
+ }
+
+ private static class FakeHost implements Host {
+
+ private final HostId id;
+
+ FakeHost(HostId id) {
+ this.id = id;
+ }
+
+ @Override
+ public HostId id() {
+ return id;
+ }
+
+ @Override
+ public MacAddress mac() {
+ return null;
+ }
+
+ @Override
+ public VlanId vlan() {
+ return null;
+ }
+
+ @Override
+ public Set<IpAddress> ipAddresses() {
+ return null;
+ }
+
+ @Override
+ public HostLocation location() {
+ return null;
+ }
+
+ @Override
+ public Annotations annotations() {
+ return null;
+ }
+
+ @Override
+ public ProviderId providerId() {
+ return null;
+ }
+ }
+
+
+
+ private final ObjectMapper mapper = new ObjectMapper();
+
+ private static final String IDS = "ids";
+ private static final String HOVER = "hover";
+
+ private static final DeviceId DEVICE_1_ID = DeviceId.deviceId("Device-1");
+ private static final DeviceId DEVICE_2_ID = DeviceId.deviceId("Device-2");
+ private static final HostId HOST_A_ID = HostId.hostId("aa:aa:aa:aa:aa:aa/1");
+ private static final HostId HOST_B_ID = HostId.hostId("bb:bb:bb:bb:bb:bb/2");
+
+ private static final Device DEVICE_1 = new FakeDevice(DEVICE_1_ID);
+ private static final Device DEVICE_2 = new FakeDevice(DEVICE_2_ID);
+ private static final Host HOST_A = new FakeHost(HOST_A_ID);
+ private static final Host HOST_B = new FakeHost(HOST_B_ID);
+
+ // ==================
+ // == FAKE SERVICES
+ private static class FakeDevices extends DeviceServiceAdapter {
+ @Override
+ public Device getDevice(DeviceId deviceId) {
+ if (DEVICE_1_ID.equals(deviceId)) {
+ return DEVICE_1;
+ }
+ if (DEVICE_2_ID.equals(deviceId)) {
+ return DEVICE_2;
+ }
+ return null;
+ }
+ }
+
+ private static class FakeHosts extends HostServiceAdapter {
+ @Override
+ public Host getHost(HostId hostId) {
+ if (HOST_A_ID.equals(hostId)) {
+ return HOST_A;
+ }
+ if (HOST_B_ID.equals(hostId)) {
+ return HOST_B;
+ }
+ return null;
+ }
+ }
+
+ private DeviceService deviceService = new FakeDevices();
+ private HostService hostService = new FakeHosts();
+
+ private NodeSelection ns;
+
+ private ObjectNode objectNode() {
+ return mapper.createObjectNode();
+ }
+
+ private ArrayNode arrayNode() {
+ return mapper.createArrayNode();
+ }
+
+ private NodeSelection createNodeSelection(ObjectNode payload) {
+ return new NodeSelection(payload, deviceService, hostService);
+ }
+
+ // selection JSON payload creation methods
+ private ObjectNode emptySelection() {
+ ObjectNode payload = objectNode();
+ ArrayNode ids = arrayNode();
+ payload.set(IDS, ids);
+ return payload;
+ }
+
+ private ObjectNode oneDeviceSelected() {
+ ObjectNode payload = objectNode();
+ ArrayNode ids = arrayNode();
+ payload.set(IDS, ids);
+ ids.add(DEVICE_1_ID.toString());
+ return payload;
+ }
+
+ private ObjectNode oneHostSelected() {
+ ObjectNode payload = objectNode();
+ ArrayNode ids = arrayNode();
+ payload.set(IDS, ids);
+ ids.add(HOST_A_ID.toString());
+ return payload;
+ }
+
+ private ObjectNode twoHostsOneDeviceSelected() {
+ ObjectNode payload = objectNode();
+ ArrayNode ids = arrayNode();
+ payload.set(IDS, ids);
+ ids.add(HOST_A_ID.toString());
+ ids.add(DEVICE_1_ID.toString());
+ ids.add(HOST_B_ID.toString());
+ return payload;
+ }
+
+ private ObjectNode oneHostAndHoveringDeviceSelected() {
+ ObjectNode payload = objectNode();
+ ArrayNode ids = arrayNode();
+ payload.set(IDS, ids);
+ ids.add(HOST_A_ID.toString());
+ payload.put(HOVER, DEVICE_2_ID.toString());
+ return payload;
+ }
+
+ private ObjectNode twoDevicesOneHostAndHoveringHostSelected() {
+ ObjectNode payload = objectNode();
+ ArrayNode ids = arrayNode();
+ payload.set(IDS, ids);
+ ids.add(HOST_A_ID.toString());
+ ids.add(DEVICE_1_ID.toString());
+ ids.add(DEVICE_2_ID.toString());
+ payload.put(HOVER, HOST_B_ID.toString());
+ return payload;
+ }
+
+
+ @Test
+ public void basic() {
+ ns = createNodeSelection(emptySelection());
+ assertEquals("unexpected devices", 0, ns.devices().size());
+ assertEquals("unexpected devices w/hover", 0, ns.devicesWithHover().size());
+ assertEquals("unexpected hosts", 0, ns.hosts().size());
+ assertEquals("unexpected hosts w/hover", 0, ns.hostsWithHover().size());
+ assertTrue("unexpected selection", ns.none());
+ assertNull("hover?", ns.hovered());
+ }
+
+ @Test
+ public void oneDevice() {
+ ns = createNodeSelection(oneDeviceSelected());
+ assertEquals("missing device", 1, ns.devices().size());
+ assertTrue("missing device 1", ns.devices().contains(DEVICE_1));
+ assertEquals("missing device w/hover", 1, ns.devicesWithHover().size());
+ assertTrue("missing device 1 w/hover", ns.devicesWithHover().contains(DEVICE_1));
+ assertEquals("unexpected hosts", 0, ns.hosts().size());
+ assertEquals("unexpected hosts w/hover", 0, ns.hostsWithHover().size());
+ assertFalse("unexpected selection", ns.none());
+ assertNull("hover?", ns.hovered());
+ }
+
+ @Test
+ public void oneHost() {
+ ns = createNodeSelection(oneHostSelected());
+ assertEquals("unexpected devices", 0, ns.devices().size());
+ assertEquals("unexpected devices w/hover", 0, ns.devicesWithHover().size());
+ assertEquals("missing host", 1, ns.hosts().size());
+ assertTrue("missing host A", ns.hosts().contains(HOST_A));
+ assertEquals("missing host w/hover", 1, ns.hostsWithHover().size());
+ assertTrue("missing host A w/hover", ns.hostsWithHover().contains(HOST_A));
+ assertFalse("unexpected selection", ns.none());
+ assertNull("hover?", ns.hovered());
+ }
+
+ @Test
+ public void twoHostsOneDevice() {
+ ns = createNodeSelection(twoHostsOneDeviceSelected());
+ assertEquals("missing device", 1, ns.devices().size());
+ assertTrue("missing device 1", ns.devices().contains(DEVICE_1));
+ assertEquals("missing device w/hover", 1, ns.devicesWithHover().size());
+ assertTrue("missing device 1 w/hover", ns.devicesWithHover().contains(DEVICE_1));
+ assertEquals("unexpected hosts", 2, ns.hosts().size());
+ assertTrue("missing host A", ns.hosts().contains(HOST_A));
+ assertTrue("missing host B", ns.hosts().contains(HOST_B));
+ assertEquals("unexpected hosts w/hover", 2, ns.hostsWithHover().size());
+ assertTrue("missing host A w/hover", ns.hostsWithHover().contains(HOST_A));
+ assertTrue("missing host B w/hover", ns.hostsWithHover().contains(HOST_B));
+ assertFalse("unexpected selection", ns.none());
+ assertNull("hover?", ns.hovered());
+ }
+
+ @Test
+ public void oneHostAndHoveringDevice() {
+ ns = createNodeSelection(oneHostAndHoveringDeviceSelected());
+ assertEquals("unexpected devices", 0, ns.devices().size());
+ assertEquals("unexpected devices w/hover", 1, ns.devicesWithHover().size());
+ assertTrue("missing device 2 w/hover", ns.devicesWithHover().contains(DEVICE_2));
+ assertEquals("missing host", 1, ns.hosts().size());
+ assertTrue("missing host A", ns.hosts().contains(HOST_A));
+ assertEquals("missing host w/hover", 1, ns.hostsWithHover().size());
+ assertTrue("missing host A w/hover", ns.hostsWithHover().contains(HOST_A));
+ assertFalse("unexpected selection", ns.none());
+ assertEquals("missing hover device 2", DEVICE_2, ns.hovered());
+ }
+
+ @Test
+ public void twoDevicesOneHostAndHoveringHost() {
+ ns = createNodeSelection(twoDevicesOneHostAndHoveringHostSelected());
+ assertEquals("missing devices", 2, ns.devices().size());
+ assertTrue("missing device 1", ns.devices().contains(DEVICE_1));
+ assertTrue("missing device 2", ns.devices().contains(DEVICE_2));
+ assertEquals("missing devices w/hover", 2, ns.devicesWithHover().size());
+ assertTrue("missing device 1 w/hover", ns.devicesWithHover().contains(DEVICE_1));
+ assertTrue("missing device 2 w/hover", ns.devicesWithHover().contains(DEVICE_2));
+ assertEquals("missing host", 1, ns.hosts().size());
+ assertTrue("missing host A", ns.hosts().contains(HOST_A));
+ assertEquals("missing host w/hover", 2, ns.hostsWithHover().size());
+ assertTrue("missing host A w/hover", ns.hostsWithHover().contains(HOST_A));
+ assertTrue("missing host B w/hover", ns.hostsWithHover().contains(HOST_B));
+ assertFalse("unexpected selection", ns.none());
+ assertEquals("missing hover host B", HOST_B, ns.hovered());
+ }
+}
diff --git a/web/gui/src/main/java/org/onosproject/ui/impl/TrafficMonitor.java b/web/gui/src/main/java/org/onosproject/ui/impl/TrafficMonitor.java
index 39beb0b..45e0a6c 100644
--- a/web/gui/src/main/java/org/onosproject/ui/impl/TrafficMonitor.java
+++ b/web/gui/src/main/java/org/onosproject/ui/impl/TrafficMonitor.java
@@ -186,7 +186,7 @@
switch (mode) {
case DEV_LINK_FLOWS:
// only care about devices (not hosts)
- if (selectedNodes.devices().isEmpty()) {
+ if (selectedNodes.devicesWithHover().isEmpty()) {
sendClearAll();
} else {
scheduleTask();
@@ -371,11 +371,11 @@
private Highlights deviceLinkFlows() {
Highlights highlights = new Highlights();
- if (selectedNodes != null && !selectedNodes.devices().isEmpty()) {
+ if (selectedNodes != null && !selectedNodes.devicesWithHover().isEmpty()) {
// capture flow counts on bilinks
TrafficLinkMap linkMap = new TrafficLinkMap();
- for (Device device : selectedNodes.devices()) {
+ for (Device device : selectedNodes.devicesWithHover()) {
Map<Link, Integer> counts = getLinkFlowCounts(device.id());
for (Link link : counts.keySet()) {
TrafficLink tlink = linkMap.add(link);
diff --git a/web/gui/src/main/java/org/onosproject/ui/impl/topo/IntentSelection.java b/web/gui/src/main/java/org/onosproject/ui/impl/topo/IntentSelection.java
index 01ae93d..151e613 100644
--- a/web/gui/src/main/java/org/onosproject/ui/impl/topo/IntentSelection.java
+++ b/web/gui/src/main/java/org/onosproject/ui/impl/topo/IntentSelection.java
@@ -50,7 +50,7 @@
*/
public IntentSelection(NodeSelection nodes, TopoIntentFilter filter) {
this.nodes = nodes;
- intents = filter.findPathIntents(nodes.hosts(), nodes.devices());
+ intents = filter.findPathIntents(nodes.hostsWithHover(), nodes.devicesWithHover());
if (intents.size() == 1) {
index = 0; // pre-select a single intent
}