Add L2 selector options to connectivity intents

Added --etherType, --etherSrc, and --etherDst to PointToPointIntent and MultiPontToSinglePointIntent creation in the ONOS CLI. Change-Id: Ibccd3c0b331e7f89be6903f264a6889ac1ad5f17

Add L2 selector options to connectivity intents
Added --etherType, --etherSrc, and --etherDst to PointToPointIntent and MultiPontToSinglePointIntent creation in the ONOS CLI. Change-Id: Ibccd3c0b331e7f89be6903f264a6889ac1ad5f17
Ray Milkey
Commit 9fdf1eaaae5a15342b9b06f4bc7540bc506dfca1 9fdf1eaa 1 parent ebf51604
Showing 6 changed files with 136 additions and 16 deletions
cli/src/main/java/org/onlab/onos/cli/net/AddMultiPointToSinglePointIntentCommand.java
cli/src/main/java/org/onlab/onos/cli/net/AddPointToPointIntentCommand.java
cli/src/main/java/org/onlab/onos/cli/net/ConnectivityIntentCommand.java
cli/src/main/java/org/onlab/onos/cli/net/EthType.java
cli/src/main/java/org/onlab/onos/cli/net/EthTypeCompleter.java
cli/src/main/resources/OSGI-INF/blueprint/shell-config.xml
--- a/cli/src/main/java/org/onlab/onos/cli/net/AddMultiPointToSinglePointIntentCommand.java
View file @9fdf1ea
+++ b/cli/src/main/java/org/onlab/onos/cli/net/AddMultiPointToSinglePointIntentCommand.java
View file @9fdf1ea
@@ -2,18 +2,15 @@ package org.onlab.onos.cli.net;
 import org.apache.karaf.shell.commands.Argument;
 import org.apache.karaf.shell.commands.Command;
-import org.onlab.onos.cli.AbstractShellCommand;
 import org.onlab.onos.net.ConnectPoint;
 import org.onlab.onos.net.DeviceId;
 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.intent.Intent;
 import org.onlab.onos.net.intent.IntentService;
 import org.onlab.onos.net.intent.MultiPointToSinglePointIntent;
-import org.onlab.packet.Ethernet;
 import java.util.HashSet;
 import java.util.Set;
@@ -26,7 +23,7 @@ import static org.onlab.onos.net.PortNumber.portNumber;
  */
 @Command(scope = "onos", name = "add-multi-to-single-intent",
          description = "Installs point-to-point connectivity intent")
-public class AddMultiPointToSinglePointIntentCommand extends AbstractShellCommand {
+public class AddMultiPointToSinglePointIntentCommand extends ConnectivityIntentCommand {
     @Argument(index = 0, name = "ingressDevices",
               description = "Ingress Device/Port Description",
@@ -55,9 +52,7 @@ public class AddMultiPointToSinglePointIntentCommand extends AbstractShellComman
             ingressPoints.add(ingress);
         }
-        TrafficSelector selector = DefaultTrafficSelector.builder()
+        TrafficSelector selector = buildTrafficSelector();
-                .matchEthType(Ethernet.TYPE_IPV4)
-                .build();
         TrafficTreatment treatment = DefaultTrafficTreatment.builder().build();
         Intent intent = new MultiPointToSinglePointIntent(appId(), selector, treatment,
--- a/cli/src/main/java/org/onlab/onos/cli/net/AddPointToPointIntentCommand.java
View file @9fdf1ea
+++ b/cli/src/main/java/org/onlab/onos/cli/net/AddPointToPointIntentCommand.java
View file @9fdf1ea
@@ -2,18 +2,16 @@ package org.onlab.onos.cli.net;
 import org.apache.karaf.shell.commands.Argument;
 import org.apache.karaf.shell.commands.Command;
-import org.onlab.onos.cli.AbstractShellCommand;
 import org.onlab.onos.net.ConnectPoint;
 import org.onlab.onos.net.DeviceId;
 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.intent.Intent;
 import org.onlab.onos.net.intent.IntentService;
 import org.onlab.onos.net.intent.PointToPointIntent;
-import org.onlab.packet.Ethernet;
+
+import static org.onlab.onos.net.flow.DefaultTrafficTreatment.builder;
 import static org.onlab.onos.net.DeviceId.deviceId;
 import static org.onlab.onos.net.PortNumber.portNumber;
@@ -23,7 +21,7 @@ import static org.onlab.onos.net.PortNumber.portNumber;
  */
 @Command(scope = "onos", name = "add-point-intent",
          description = "Installs point-to-point connectivity intent")
-public class AddPointToPointIntentCommand extends AbstractShellCommand {
+public class AddPointToPointIntentCommand extends ConnectivityIntentCommand {
     @Argument(index = 0, name = "ingressDevice",
               description = "Ingress Device/Port Description",
@@ -47,10 +45,8 @@ public class AddPointToPointIntentCommand extends AbstractShellCommand {
         PortNumber egressPortNumber = portNumber(getPortNumber(egressDeviceString));
         ConnectPoint egress = new ConnectPoint(egressDeviceId, egressPortNumber);
-        TrafficSelector selector = DefaultTrafficSelector.builder()
+        TrafficSelector selector = buildTrafficSelector();
-                .matchEthType(Ethernet.TYPE_IPV4)
+        TrafficTreatment treatment = builder().build();
-                .build();
-        TrafficTreatment treatment = DefaultTrafficTreatment.builder().build();
         Intent intent = new PointToPointIntent(appId(), selector, treatment,
                                                ingress, egress);
--- a/cli/src/main/java/org/onlab/onos/cli/net/ConnectivityIntentCommand.java 0 → 100644
View file @9fdf1ea
+++ b/cli/src/main/java/org/onlab/onos/cli/net/ConnectivityIntentCommand.java 0 → 100644
View file @9fdf1ea
+package org.onlab.onos.cli.net;
+
+import org.apache.karaf.shell.commands.Option;
+import org.onlab.onos.cli.AbstractShellCommand;
+import org.onlab.onos.net.flow.DefaultTrafficSelector;
+import org.onlab.onos.net.flow.TrafficSelector;
+import org.onlab.packet.Ethernet;
+import org.onlab.packet.MacAddress;
+
+import com.google.common.base.Strings;
+
+/**
+ * Base class for command line operations for connectivity based intents.
+ */
+public abstract class ConnectivityIntentCommand extends AbstractShellCommand {
+
+    @Option(name = "-s", aliases = "--ethSrc", description = "Source MAC Address",
+            required = false, multiValued = false)
+    private String srcMacString = null;
+
+    @Option(name = "-d", aliases = "--ethDst", description = "Destination MAC Address",
+            required = false, multiValued = false)
+    private String dstMacString = null;
+
+    @Option(name = "-t", aliases = "--ethType", description = "Ethernet Type",
+            required = false, multiValued = false)
+    private String ethTypeString = "";
+
+    /**
+     * Constructs a traffic selector based on the command line arguments
+     * presented to the command.
+     */
+    protected TrafficSelector buildTrafficSelector() {
+        TrafficSelector.Builder selectorBuilder = DefaultTrafficSelector.builder();
+
+        Short ethType = Ethernet.TYPE_IPV4;
+        if (!Strings.isNullOrEmpty(ethTypeString)) {
+            EthType ethTypeParameter = EthType.valueOf(ethTypeString);
+            ethType = ethTypeParameter.value();
+        }
+        selectorBuilder.matchEthType(ethType);
+
+        if (!Strings.isNullOrEmpty(srcMacString)) {
+            selectorBuilder.matchEthSrc(MacAddress.valueOf(srcMacString));
+        }
+
+        if (!Strings.isNullOrEmpty(dstMacString)) {
+            selectorBuilder.matchEthDst(MacAddress.valueOf(dstMacString));
+        }
+
+        return selectorBuilder.build();
+    }
+
+}
--- a/cli/src/main/java/org/onlab/onos/cli/net/EthType.java 0 → 100644
View file @9fdf1ea
+++ b/cli/src/main/java/org/onlab/onos/cli/net/EthType.java 0 → 100644
View file @9fdf1ea
+package org.onlab.onos.cli.net;
+
+import org.onlab.packet.Ethernet;
+
+/**
+ * Allowed values for Ethernet types.  Used by the CLI completer for
+ * connectivity based intent L2 parameters.
+ */
+public enum EthType {
+    /** ARP. */
+    ARP(Ethernet.TYPE_ARP),
+    /** RARP. */
+    RARP(Ethernet.TYPE_RARP),
+    /** IPV4. */
+    IPV4(Ethernet.TYPE_IPV4),
+    /** LLDP. */
+    LLDP(Ethernet.TYPE_LLDP),
+    /** BSN. */
+    BSN(Ethernet.TYPE_BSN);
+
+    private short value;
+
+    /**
+     * Constructs an EthType with the given value.
+     *
+     * @param value value to use when this EthType is seen.
+     */
+    private EthType(short value) {
+        this.value = value;
+    }
+
+    /**
+     * Gets the value to use for this EthType.
+     *
+     * @return short value to use for this EthType
+     */
+    public short value() {
+        return this.value;
+    }
+}
--- a/cli/src/main/java/org/onlab/onos/cli/net/EthTypeCompleter.java 0 → 100644
View file @9fdf1ea
+++ b/cli/src/main/java/org/onlab/onos/cli/net/EthTypeCompleter.java 0 → 100644
View file @9fdf1ea
+package org.onlab.onos.cli.net;
+
+import java.util.List;
+import java.util.SortedSet;
+
+import org.apache.karaf.shell.console.Completer;
+import org.apache.karaf.shell.console.completer.StringsCompleter;
+
+/**
+ * Ethernet type completer.
+ */
+public class EthTypeCompleter implements Completer {
+    @Override
+    public int complete(String buffer, int cursor, List<String> candidates) {
+        // Delegate string completer
+        StringsCompleter delegate = new StringsCompleter();
+        SortedSet<String> strings = delegate.getStrings();
+        strings.add(EthType.ARP.toString());
+        strings.add(EthType.BSN.toString());
+        strings.add(EthType.IPV4.toString());
+        strings.add(EthType.LLDP.toString());
+        strings.add(EthType.RARP.toString());
+
+        // Now let the completer do the work for figuring out what to offer.
+        return delegate.complete(buffer, cursor, candidates);
+    }
+
+}
--- a/cli/src/main/resources/OSGI-INF/blueprint/shell-config.xml
View file @9fdf1ea
+++ b/cli/src/main/resources/OSGI-INF/blueprint/shell-config.xml
View file @9fdf1ea
@@ -96,12 +96,18 @@
                 <ref component-id="connectPointCompleter"/>
                 <null/>
             </completers>
+            <optional-completers>
+                <entry key="-t" value-ref="ethTypeCompleter"/>
+            </optional-completers>
         </command>
         <command>
             <action class="org.onlab.onos.cli.net.AddMultiPointToSinglePointIntentCommand"/>
             <completers>
                 <ref component-id="connectPointCompleter"/>
             </completers>
+            <optional-completers>
+                <entry key="-t" value-ref="ethTypeCompleter"/>
+            </optional-completers>
         </command>
         <command>
             <action class="org.onlab.onos.cli.net.IntentPushTestCommand"/>
@@ -158,5 +164,6 @@
     <bean id="flowRuleStatusCompleter" class="org.onlab.onos.cli.net.FlowRuleStatusCompleter"/>
     <bean id="connectPointCompleter" class="org.onlab.onos.cli.net.ConnectPointCompleter"/>
     <bean id="nullCompleter" class="org.apache.karaf.shell.console.completer.NullCompleter"/>
+    <bean id="ethTypeCompleter" class="org.onlab.onos.cli.net.EthTypeCompleter"/>
 </blueprint>