Add E2E tests and example for VRFs (#1189)

Create E2E tests and add an example for VRFs to make sure that the
feature works.

Reported-at: #847

Signed-off-by: Andreas Karis <[email protected]>

Author: andreaskaris

docs/examples.md

@@ -83,6 +83,12 @@ toc_sticky: true
 {% include_absolute 'examples/vlan.yaml' %}
 ```
 
+## VRF
+
+```yaml
+{% include_absolute 'examples/vrf.yaml' %}
+```
+
 ## Worker selector
 
 ```yaml

docs/examples/vrf.yaml

@@ -0,0 +1,32 @@
+apiVersion: nmstate.io/v1
+kind: NodeNetworkConfigurationPolicy
+metadata:
+  name: vrf
+spec:
+  desiredState:
+    interfaces:
+    - name: vrf102
+      state: up
+      type: vrf
+      vrf:
+        port:
+        - eth1
+        route-table-id: 102
+    - ipv4:
+        address:
+        - ip: 192.0.2.251
+          prefix-length: 24
+        dhcp: false
+        enabled: true
+      name: eth1
+      state: up
+      type: ethernet
+    routes:
+      config:
+      - destination: 198.51.100.0/24
+        metric: 150
+        next-hop-address: 192.0.2.1
+        next-hop-interface: eth1
+        table-id: 102
+  nodeSelector:
+    kubernetes.io/hostname: node01

test/e2e/handler/states.go

@@ -215,6 +215,28 @@ func vlanAbsent(iface, vlanID string) nmstate.State {
 `, iface, vlanID, iface, vlanID))
 }
 
+// vrfUp creates VRF vrfID and adds the interfaces from ifaceList to that VRF.
+func vrfUp(vrfID string, ifaceList ...string) nmstate.State {
+	ifaces := strings.Join(ifaceList, ",")
+	return nmstate.NewState(fmt.Sprintf(`interfaces:
+    - name: vrf%s
+      type: vrf
+      state: up
+      vrf:
+        port: [%s]
+        route-table-id: %[1]s
+`, vrfID, ifaces))
+}
+
+// vrfAbsent removes VRF vrfID.
+func vrfAbsent(vrfID string) nmstate.State {
+	return nmstate.NewState(fmt.Sprintf(`interfaces:
+    - name: vrf%s
+      type: vrf
+      state: absent
+`, vrfID))
+}
+
 func interfaceAbsent(iface string) nmstate.State {
 	return nmstate.NewState(fmt.Sprintf(`interfaces:
     - name: %s

test/e2e/handler/static_addr_and_route_test.go

@@ -26,7 +26,17 @@ import (
 	nmstate "github.com/nmstate/kubernetes-nmstate/api/shared"
 )
 
+// ipV4AddrAndRoute creates an IP address and routes for the default routing table.
 func ipV4AddrAndRoute(firstSecondaryNic, ipAddress, destIPAddress, prefixLen, nextHopIPAddress string) nmstate.State {
+	return ipV4AddrAndRouteWithTableID(firstSecondaryNic, ipAddress, destIPAddress, prefixLen, nextHopIPAddress, "")
+}
+
+// ipV4AddrAndRouteWithTableID creates an IP address and routes for a given routing table ID.
+func ipV4AddrAndRouteWithTableID(firstSecondaryNic, ipAddress, destIPAddress, prefixLen, nextHopIPAddress,
+	tableID string) nmstate.State {
+	if tableID == "" {
+		tableID = "254"
+	}
 	return nmstate.NewState(fmt.Sprintf(`interfaces:
   - name: %s
     type: ethernet
@@ -43,8 +53,8 @@ routes:
       metric: 150
       next-hop-address: %s
       next-hop-interface: %s
-      table-id: 254
-`, firstSecondaryNic, ipAddress, prefixLen, destIPAddress, nextHopIPAddress, firstSecondaryNic))
+      table-id: %s
+`, firstSecondaryNic, ipAddress, prefixLen, destIPAddress, nextHopIPAddress, firstSecondaryNic, tableID))
 }
 
 func ipV4AddrAndRouteAbsent(firstSecondaryNic string) nmstate.State {

test/e2e/handler/utils.go

@@ -196,8 +196,7 @@ func updateDesiredStateWithCaptureAtNodeAndWait(node string, desiredState nmstat
 	policy.WaitForAvailableTestPolicy()
 }
 
-// TODO: After we implement policy delete (it will cleanUp desiredState) we have
-//       to remove this
+// TODO: After we implement policy delete (it will cleanUp desiredState) we have to remove this.
 func resetDesiredStateForNodes() {
 	By("Resetting nics state primary up and secondaries disable ipv4 and ipv6")
 	updateDesiredState(resetPrimaryAndSecondaryNICs())
@@ -399,6 +398,13 @@ func vlanForNodeInterfaceEventually(node, iface string) AsyncAssertion {
 	}, ReadTimeout, ReadInterval)
 }
 
+// vrfForNodeInterfaceEventually asserts that VRF with vrfID is eventually created.
+func vrfForNodeInterfaceEventually(node, vrfID string) AsyncAssertion {
+	return Eventually(func() string {
+		return vrf(node, vrfID)
+	}, ReadTimeout, ReadInterval)
+}
+
 func interfacesForNode(node string) AsyncAssertion {
 	return Eventually(func() []interface{} {
 		var currentStateYaml nmstate.State
@@ -612,9 +618,19 @@ func routeDest(node, destIP string) string {
 	return gjson.ParseBytes(currentStateJSON(node)).Get(path).String()
 }
 
+// routeNextHopInterfaceWithTableID checks if a route with destIP exists in the default routing table.
 func routeNextHopInterface(node, destIP string) AsyncAssertion {
+	return routeNextHopInterfaceWithTableID(node, destIP, "")
+}
+
+// routeNextHopInterfaceWithTableID checks if a route with destIP exists in table tableID. If tableID is the empty
+// string, use the default table-id (254).
+func routeNextHopInterfaceWithTableID(node, destIP, tableID string) AsyncAssertion {
+	if tableID == "" {
+		tableID = "254"
+	}
 	return Eventually(func() string {
-		path := fmt.Sprintf("routes.running.#(destination==%q).next-hop-interface", destIP)
+		path := fmt.Sprintf("routes.running.#(table-id==%s)#|#(destination==%q).next-hop-interface", tableID, destIP)
 		return gjson.ParseBytes(currentStateJSON(node)).Get(path).String()
 	}, 15*time.Second, 1*time.Second)
 }
@@ -624,6 +640,12 @@ func vlan(node, iface string) string {
 	return gjson.ParseBytes(currentStateJSON(node)).Get(vlanFilter).String()
 }
 
+// vrf verifies if the VRF with vrfID was created on node.
+func vrf(node, vrfID string) string {
+	vrfFilter := fmt.Sprintf("interfaces.#(name==vrf%s).vrf.route-table-id", vrfID)
+	return gjson.ParseBytes(currentStateJSON(node)).Get(vrfFilter).String()
+}
+
 func kubectlAndCheck(command ...string) {
 	out, err := cmd.Kubectl(command...)
 	Expect(err).ShouldNot(HaveOccurred(), out)

test/e2e/handler/vrf_test.go

@@ -0,0 +1,62 @@
+/*
+Copyright The Kubernetes NMState Authors.
+
+
+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 handler
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("NodeNetworkState", func() {
+	var (
+		node string
+	)
+
+	BeforeEach(func() {
+		node = nodes[0]
+	})
+
+	Context("when VRF configured", func() {
+		var (
+			vrfID            = "102"
+			ipAddress        = "192.0.2.251"
+			destIPAddress    = "198.51.100.0/24"
+			prefixLen        = "24"
+			nextHopIPAddress = "192.0.2.1"
+		)
+
+		BeforeEach(func() {
+			updateDesiredStateAtNodeAndWait(node, vrfUp(vrfID, firstSecondaryNic))
+			updateDesiredStateAtNodeAndWait(
+				node,
+				ipV4AddrAndRouteWithTableID(firstSecondaryNic, ipAddress, destIPAddress, prefixLen, nextHopIPAddress, vrfID),
+			)
+		})
+
+		AfterEach(func() {
+			updateDesiredStateAtNodeAndWait(node, vrfAbsent(vrfID))
+			resetDesiredStateForNodes()
+		})
+
+		It("should have the VRF interface configured", func() {
+			vrfForNodeInterfaceEventually(node, vrfID).Should(Equal(vrfID))
+			ipAddressForNodeInterfaceEventually(node, firstSecondaryNic).Should(Equal(ipAddress))
+			routeNextHopInterfaceWithTableID(node, destIPAddress, vrfID).Should(Equal(firstSecondaryNic))
+		})
+	})
+})