ONOS Network Troubleshooting System

Newest Commit changes:

1. Add unit tests.
2. Fix review comments.
3. Add support to BUCK.

Could you please make a Code Review, we wish to hear anything from you :)

Thank you very much!

----------------------------------------------------

ONOS Network Troubleshooting System

Modularity design. In present, include these tow module:
1. Routing Loop Detection

Welcome your contribution for more modules in the future...

Beijing University of Posts and Telecommunications

new: withdraw blackhole tracing for redesign;
     fix obvious checkstyle problem.

Change-Id: Id6d3aa0bc00c8da8ac046e6903f17cfdf954d919

Author: MaoJianwei

apps/network-troubleshoot/BUCK

@@ -0,0 +1,13 @@
+BUNDLES = [
+  '//apps/network-troubleshoot/api:onos-apps-network-troubleshoot-api',
+  '//apps/network-troubleshoot/cli:onos-apps-network-troubleshoot-cli',
+  '//apps/network-troubleshoot/core:onos-apps-network-troubleshoot-core',
+]
+
+onos_app (
+  title = 'Network TroubleShoot SubSystem',
+  description = 'ONOS Network TroubleShoot SubSystem',
+  category = 'Core',
+  url = 'https://wiki.onosproject.org/display/ONOS/Network+TroubleShooting+Module',
+  included_bundles = BUNDLES,
+)

apps/network-troubleshoot/api/BUCK

@@ -0,0 +1,12 @@
+COMPILE_DEPS = [
+  '//lib:CORE_DEPS',
+]
+
+TEST_DEPS = [
+  '//lib:TEST_ADAPTERS',
+]
+
+osgi_jar_with_tests (
+  deps = COMPILE_DEPS,
+  test_deps = TEST_DEPS,
+)

apps/network-troubleshoot/api/pom.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright 2014-present 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.
+  -->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.onosproject</groupId>
+        <artifactId>onos-network-troubleshoot</artifactId>
+        <version>1.10.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>onos-network-troubleshoot-api</artifactId>
+    <packaging>bundle</packaging>
+
+    <description>ONOS Network TroubleShoot SubSystem API</description>
+
+    <dependencies>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.onosproject</groupId>
+            <artifactId>onlab-junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+</project>

apps/network-troubleshoot/api/src/main/java/org/onosproject/fnl/base/NetworkDiagnosticUtils.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright 2015-present 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.fnl.base;
+
+import org.onosproject.net.ConnectPoint;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.HostId;
+import org.onosproject.net.flow.FlowEntry;
+import org.onosproject.net.flow.criteria.Criterion;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Common utility functions and constants.
+ */
+public final class NetworkDiagnosticUtils {
+
+    private NetworkDiagnosticUtils() {
+        // no instantiation
+    }
+
+    /**
+     * Returns a list of flow entries sorted by priority in descending order.
+     *
+     * @param flowEntries flow entries to be sorted
+     * @return flow entries in descending order
+     */
+    public static List<FlowEntry> sortFlowTable(Iterable<FlowEntry> flowEntries) {
+
+        List<FlowEntry> flows = new ArrayList<>();
+        flowEntries.forEach(flows::add);
+
+        Collections.sort(flows,
+                (f1, f2) -> f2.priority() - f1.priority());
+        return flows;
+    }
+
+    /**
+     * Returns a list of match fields sorted by their types in ascending order.
+     *
+     * @param criterionSet the criteria to be sorted
+     * @return the list of criteria in ascending order
+     */
+    public static List<Criterion> sortCriteria(Set<Criterion> criterionSet) {
+
+        List<Criterion> array = new ArrayList<>(criterionSet);
+        Collections.sort(array,
+                (c1, c2) -> c1.type().compareTo(c2.type()));
+        return array;
+    }
+
+    /**
+     * Returns true if the given connect point is a device point.
+     *
+     * @param connectPoint the connect point to be checked
+     * @return true if the connect point is a device point
+     */
+    public static boolean isDevice(ConnectPoint connectPoint) {
+        return connectPoint.elementId() instanceof DeviceId;
+    }
+
+    /**
+     * Returns true if the given connect point is a host point.
+     *
+     * @param connectPoint the connect point to be checked
+     * @return true if the connect point is a host point
+     */
+    public static boolean isHost(ConnectPoint connectPoint) {
+        // TODO - not debug yet
+        return connectPoint.elementId() instanceof HostId;
+    }
+}