Use host handler to bootstrap tunnel bridge and related ports

Change-Id: I19bb28d86620b9c42c33e0b570ff176b467d71ac
diff --git a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/DefaultK8sHost.java b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/DefaultK8sHost.java
index 1d49757..e961910 100644
--- a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/DefaultK8sHost.java
+++ b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/DefaultK8sHost.java
@@ -34,6 +34,7 @@
     private final IpAddress hostIp;
     private final Set<String> nodeNames;
     private final K8sHostState state;
+    private final Set<K8sTunnelBridge> tunBridges;
 
     private static final String NOT_NULL_MSG = "Host % cannot be null";
 
@@ -45,12 +46,14 @@
      * @param hostIp        host IP address
      * @param nodeNames     node names
      * @param state         host state
+     * @param tunBridges    a set of tunnel bridges
      */
     protected DefaultK8sHost(IpAddress hostIp, Set<String> nodeNames,
-                             K8sHostState state) {
+                             K8sHostState state, Set<K8sTunnelBridge> tunBridges) {
         this.hostIp = hostIp;
         this.nodeNames = nodeNames;
         this.state = state;
+        this.tunBridges = tunBridges;
     }
 
     @Override
@@ -74,11 +77,17 @@
     }
 
     @Override
+    public Set<K8sTunnelBridge> tunBridges() {
+        return ImmutableSet.copyOf(tunBridges);
+    }
+
+    @Override
     public K8sHost updateState(K8sHostState newState) {
         return new Builder()
                 .hostIp(hostIp)
                 .nodeNames(nodeNames)
                 .state(newState)
+                .tunBridges(tunBridges)
                 .build();
     }
 
@@ -88,6 +97,7 @@
                 .hostIp(hostIp)
                 .nodeNames(nodeNames)
                 .state(state)
+                .tunBridges(tunBridges)
                 .build();
     }
 
@@ -102,7 +112,8 @@
         DefaultK8sHost that = (DefaultK8sHost) o;
         return Objects.equals(hostIp, that.hostIp) &&
                 Objects.equals(nodeNames, that.nodeNames) &&
-                state == that.state;
+                state == that.state &&
+                Objects.equals(tunBridges, that.tunBridges);
     }
 
     @Override
@@ -116,6 +127,7 @@
                 .add("hostIp", hostIp)
                 .add("nodeNames", nodeNames)
                 .add("state", state)
+                .add("tunBridges", tunBridges)
                 .toString();
     }
 
@@ -133,6 +145,7 @@
         private IpAddress hostIp;
         private Set<String> nodeNames;
         private K8sHostState state;
+        private Set<K8sTunnelBridge> tunBridges;
 
         // private constructor not intended to use from external
         private Builder() {
@@ -147,7 +160,11 @@
                 nodeNames = new HashSet<>();
             }
 
-            return new DefaultK8sHost(hostIp, nodeNames, state);
+            if (tunBridges == null) {
+                tunBridges = new HashSet<>();
+            }
+
+            return new DefaultK8sHost(hostIp, nodeNames, state, tunBridges);
         }
 
         @Override
@@ -167,5 +184,11 @@
             this.state = state;
             return this;
         }
+
+        @Override
+        public Builder tunBridges(Set<K8sTunnelBridge> tunBridges) {
+            this.tunBridges = tunBridges;
+            return this;
+        }
     }
 }
diff --git a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHost.java b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHost.java
index c93d4d1..2eeb9c1 100644
--- a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHost.java
+++ b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHost.java
@@ -55,6 +55,13 @@
     DeviceId ovsdb();
 
     /**
+     * Returns the set of tunnel bridges belong to the host.
+     *
+     * @return a set of tunnel bridges
+     */
+    Set<K8sTunnelBridge> tunBridges();
+
+    /**
      * Returns new kubernetes host instance with given state.
      *
      * @param newState updated state
@@ -63,7 +70,7 @@
     K8sHost updateState(K8sHostState newState);
 
     /**
-     * Returns new kuberentes host instance with given node names.
+     * Returns new kubernetes host instance with given node names.
      *
      * @param nodeNames a set of node names
      * @return updated kubernetes host
@@ -105,5 +112,13 @@
          * @return kubernetes host builder
          */
         Builder state(K8sHostState state);
+
+        /**
+         * Returns kubernetes host builder with supplied tunnel bridges set.
+         *
+         * @param tunBridges tunnel bridges
+         * @return kubernetes host builder
+         */
+        Builder tunBridges(Set<K8sTunnelBridge> tunBridges);
     }
 }
diff --git a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostHandler.java b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostHandler.java
index 335c89c..84d7d83 100644
--- a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostHandler.java
+++ b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostHandler.java
@@ -29,6 +29,14 @@
     void processInitState(K8sHost k8sHost);
 
     /**
+     * Processes the given node for device created state.
+     * It creates required ports on the bridges based on the node type.
+     *
+     * @param k8sHost kubernetes host
+     */
+    void processDeviceCreatedState(K8sHost k8sHost);
+
+    /**
      * Processes the given host for complete state.
      * It performs post-init jobs for the complete host.
      *
diff --git a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostService.java b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostService.java
index abdbb74..cf7b77f 100644
--- a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostService.java
+++ b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostService.java
@@ -17,6 +17,7 @@
 
 import org.onlab.packet.IpAddress;
 import org.onosproject.event.ListenerService;
+import org.onosproject.net.DeviceId;
 
 import java.util.Set;
 
@@ -48,4 +49,20 @@
      * @return kubernetes host
      */
     K8sHost host(IpAddress hostIp);
+
+    /**
+     * Returns the host with the specified device ID.
+     *
+     * @param deviceId device identifier
+     * @return kubernetes host
+     */
+    K8sHost host(DeviceId deviceId);
+
+    /**
+     * Returns the host with the specified tunnel bridge device ID.
+     *
+     * @param deviceId tunnel bridge's device ID
+     * @return kubernetes host
+     */
+    K8sHost hostByTunBridge(DeviceId deviceId);
 }
diff --git a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostState.java b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostState.java
index f9a07c3..1455297 100644
--- a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostState.java
+++ b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sHostState.java
@@ -31,6 +31,20 @@
 
         @Override
         public K8sHostState nextState() {
+            return DEVICE_CREATED;
+        }
+    },
+    /**
+     * Indicates bridge devices are added according to the host state.
+     */
+    DEVICE_CREATED {
+        @Override
+        public void process(K8sHostHandler handler, K8sHost host) {
+            handler.processDeviceCreatedState(host);
+        }
+
+        @Override
+        public K8sHostState nextState() {
             return COMPLETE;
         }
     },
diff --git a/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sTunnelBridge.java b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sTunnelBridge.java
new file mode 100644
index 0000000..50d155e
--- /dev/null
+++ b/apps/k8s-node/api/src/main/java/org/onosproject/k8snode/api/K8sTunnelBridge.java
@@ -0,0 +1,142 @@
+/*
+ * Copyright 2020-present Open Networking Foundation
+ *
+ * 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.k8snode.api;
+
+import com.google.common.base.MoreObjects;
+import com.google.common.base.Strings;
+import org.onosproject.net.DeviceId;
+
+import java.util.Objects;
+
+import static org.onosproject.k8snode.api.Constants.GENEVE_TUNNEL;
+import static org.onosproject.k8snode.api.Constants.GRE_TUNNEL;
+import static org.onosproject.k8snode.api.Constants.TUNNEL_BRIDGE;
+import static org.onosproject.k8snode.api.Constants.VXLAN_TUNNEL;
+
+/**
+ * K8s tunnel bridge.
+ */
+public class K8sTunnelBridge {
+
+    private static final String OF_PREFIX = "of:";
+
+    private final int tunnelId;
+
+    /**
+     * Default constructor.
+     *
+     * @param tunnelId  tunnel identifier
+     */
+    public K8sTunnelBridge(int tunnelId) {
+        this.tunnelId = tunnelId;
+    }
+
+    /**
+     * Returns device identifier.
+     *
+     * @return device identifier
+     */
+    public DeviceId deviceId() {
+        return DeviceId.deviceId(dpid());
+    }
+
+    /**
+     * Returns tunnel ID.
+     *
+     * @return tunnel ID
+     */
+    public int tunnelId() {
+        return tunnelId;
+    }
+
+    /**
+     * Return the datapath identifier.
+     *
+     * @return datapath identifier
+     */
+    public String dpid() {
+        return genDpidFromName(name());
+    }
+
+    /**
+     * Returns bridge name.
+     *
+     * @return bridge name
+     */
+    public String name() {
+        return TUNNEL_BRIDGE + "-" + tunnelId;
+    }
+
+    /**
+     * Returns GRE port name.
+     *
+     * @return GRE port name
+     */
+    public String grePortName() {
+        return GRE_TUNNEL + "-" + tunnelId;
+    }
+
+    /**
+     * Returns VXLAN port name.
+     *
+     * @return VXLAN port name
+     */
+    public String vxlanPortName() {
+        return VXLAN_TUNNEL + "-" + tunnelId;
+    }
+
+    /**
+     * Returns GENEVE port name.
+     *
+     * @return GENEVE port name
+     */
+    public String genevePortName() {
+        return GENEVE_TUNNEL + "-" + tunnelId;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        K8sTunnelBridge that = (K8sTunnelBridge) o;
+        return tunnelId == that.tunnelId;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(tunnelId);
+    }
+
+    @Override
+    public String toString() {
+        return MoreObjects.toStringHelper(this)
+                .add("tunnelId", tunnelId)
+                .toString();
+    }
+
+    private String genDpidFromName(String name) {
+        if (name != null) {
+            String hexString = Integer.toHexString(name.hashCode());
+            return OF_PREFIX + Strings.padStart(hexString, 16, '0');
+        }
+
+        return null;
+    }
+}