New link struct - Vxlan

.github/workflows/cicd.yml

@@ -408,7 +408,14 @@ jobs:
           path: ./tests/coverage/*
           retention-days: 7
 
-    # create a job that downloads coverage artifact and uses codecov to upload it
+  vxlan-tests:
+    uses: ./.github/workflows/vxlan-tests.yml
+    needs:
+      - unit-test
+      - staticcheck
+      - build-containerlab
+
+  # a job that downloads coverage artifact and uses codecov to upload it
   coverage:
     runs-on: ubuntu-22.04
     needs:
@@ -418,6 +425,7 @@ jobs:
       - ceos-basic-tests
       - srlinux-basic-tests
       - ixiac-one-basic-tests
+      - vxlan-tests
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -473,11 +481,13 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/v')
     needs:
       - docs-test
+      - unit-test
       - smoke-tests
       - ceos-basic-tests
       - srlinux-basic-tests
       - ixiac-one-basic-tests
       - ext-container-tests
+      - vxlan-tests
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/vxlan-tests.yml

@@ -0,0 +1,64 @@
+name: vxlan-test
+
+"on":
+  workflow_call:
+
+jobs:
+  vxlan-tests:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        runtime:
+          - "docker"
+        test-suite:
+          - "01*.robot"
+          - "02*.robot"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: containerlab
+
+      - name: Move containerlab to usr/bin
+        run: sudo mv ./containerlab /usr/bin/containerlab && sudo chmod a+x /usr/bin/containerlab
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: pip
+          cache-dependency-path: "tests/requirements.txt"
+
+      - name: Install robotframework
+        run: |
+          pip install -r tests/requirements.txt
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run tests
+        run: |
+          bash ./tests/rf-run.sh ${{ matrix.runtime }} ./tests/08-vxlan/${{ matrix.test-suite }}
+
+      # upload test reports as a zip file
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: 08-${{ matrix.runtime }}-vxlan-log
+          path: ./tests/out/*.html
+
+      # upload coverage report from unit tests, as they are then
+      # merged with e2e tests coverage
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: coverage
+          path: ./tests/coverage/*
+          retention-days: 7

clab/clab.go

@@ -602,6 +602,14 @@ func (c *CLab) DeleteNodes(ctx context.Context, workers uint, serialNodes map[st
 	close(concurrentChan)
 	close(serialChan)
 
+	// also call delete on the special nodes
+	for _, n := range c.GetSpecialLinkNodes() {
+		err := n.Delete(ctx)
+		if err != nil {
+			log.Warn(err)
+		}
+	}
+
 	wg.Wait()
 }
 
@@ -663,38 +671,9 @@ func (c *CLab) GetNodeRuntime(contName string) (runtime.ContainerRuntime, error)
 	return nil, fmt.Errorf("could not find a container matching name %q", contName)
 }
 
-// VethCleanup iterates over links found in clab topology to initiate removal of dangling veths
-// in host networking namespace or attached to linux bridge.
-// See https://github.com/srl-labs/containerlab/issues/842 for the reference.
-func (c *CLab) VethCleanup(ctx context.Context) error {
-	hostBasedEndpoints := []links.Endpoint{}
-
-	// collect the endpoints of regular nodes
-	for _, n := range c.Nodes {
-		if n.Config().IsRootNamespaceBased || n.Config().NetworkMode == "host" {
-			hostBasedEndpoints = append(hostBasedEndpoints, n.GetEndpoints()...)
-		}
-	}
-
-	// collect the endpoints of the fake nodes
-	hostBasedEndpoints = append(hostBasedEndpoints, links.GetHostLinkNode().GetEndpoints()...)
-	hostBasedEndpoints = append(hostBasedEndpoints, links.GetMgmtBrLinkNode().GetEndpoints()...)
-
-	var joinedErr error
-	for _, ep := range hostBasedEndpoints {
-		// finally remove all the collected endpoints
-		log.Debugf("removing endpoint %s", ep.String())
-		err := ep.Remove()
-		if err != nil {
-			joinedErr = errors.Join(joinedErr, err)
-		}
-	}
-
-	return joinedErr
-}
-
-// ResolveLinks resolves raw links to the actual link types and stores them in the CLab.Links map.
-func (c *CLab) ResolveLinks() error {
+// GetLinkNodes returns all CLab.Nodes nodes as links.Nodes enriched with the special nodes - host and mgmt-net.
+// The CLab nodes are copied to a new map and thus clab.Node interface is converted to link.Node.
+func (c *CLab) GetLinkNodes() map[string]links.Node {
 	// resolveNodes is a map of all nodes in the topology
 	// that is artificially created to combat circular dependencies.
 	// If no circ deps were in place we could've used c.Nodes map instead.
@@ -704,17 +683,32 @@ func (c *CLab) ResolveLinks() error {
 		resolveNodes[k] = v
 	}
 
+	// add the virtual host and mgmt-bridge nodes to the resolve nodes
+	specialNodes := c.GetSpecialLinkNodes()
+	for _, n := range specialNodes {
+		resolveNodes[n.GetShortName()] = n
+	}
+
+	return resolveNodes
+}
+
+// GetSpecialLinkNodes returns a map of special nodes that are used to resolve links.
+// Special nodes are host and mgmt-bridge nodes that are not typically present in the topology file
+// but are required to resolve links.
+func (c *CLab) GetSpecialLinkNodes() map[string]links.Node {
 	// add the virtual host and mgmt-bridge nodes to the resolve nodes
 	specialNodes := map[string]links.Node{
 		"host":     links.GetHostLinkNode(),
 		"mgmt-net": links.GetMgmtBrLinkNode(),
 	}
-	for _, n := range specialNodes {
-		resolveNodes[n.GetShortName()] = n
-	}
 
+	return specialNodes
+}
+
+// ResolveLinks resolves raw links to the actual link types and stores them in the CLab.Links map.
+func (c *CLab) ResolveLinks() error {
 	resolveParams := &links.ResolveParams{
-		Nodes:          resolveNodes,
+		Nodes:          c.GetLinkNodes(),
 		MgmtBridgeName: c.Config.Mgmt.Bridge,
 		NodesFilter:    c.nodeFilter,
 	}

clab/netlink.go

@@ -7,7 +7,6 @@ package clab
 import (
 	"fmt"
 	"net"
-	"strings"
 
 	"github.com/containernetworking/plugins/pkg/ns"
 	"github.com/google/uuid"
@@ -154,7 +153,7 @@ func (c *CLab) CreateVirtualWiring(l *types.Link) (err error) {
 func (c *CLab) RemoveHostOrBridgeVeth(l *types.Link) (err error) {
 	switch {
 	case l.A.Node.Kind == "host" || l.A.Node.Kind == "bridge":
-		link, err := netlink.LinkByName(l.A.EndpointName)
+		link, err := utils.LinkByNameOrAlias(l.A.EndpointName)
 		if err != nil {
 			log.Debugf("Link %q is already gone: %v", l.A.EndpointName, err)
 			break
@@ -168,7 +167,7 @@ func (c *CLab) RemoveHostOrBridgeVeth(l *types.Link) (err error) {
 			log.Debugf("Link %q is already gone: %v", l.A.EndpointName, err)
 		}
 	case l.B.Node.Kind == "host" || l.B.Node.Kind == "bridge":
-		link, err := netlink.LinkByName(l.B.EndpointName)
+		link, err := utils.LinkByNameOrAlias(l.B.EndpointName)
 		if err != nil {
 			log.Debugf("Link %q is already gone: %v", l.B.EndpointName, err)
 			break
@@ -187,7 +186,7 @@ func (c *CLab) RemoveHostOrBridgeVeth(l *types.Link) (err error) {
 
 // createMACVLANInterface creates a macvlan interface in the root netns.
 func createMACVLANInterface(ifName, parentIfName string, mtu int, MAC net.HardwareAddr) (netlink.Link, error) {
-	parentInterface, err := netlink.LinkByName(parentIfName)
+	parentInterface, err := utils.LinkByNameOrAlias(parentIfName)
 	if err != nil {
 		return nil, err
 	}
@@ -227,7 +226,7 @@ func createVethIface(ifName, peerName string, mtu int, aMAC, bMAC net.HardwareAd
 		return nil, nil, err
 	}
 
-	if linkB, err = netlink.LinkByName(peerName); err != nil {
+	if linkB, err = utils.LinkByNameOrAlias(peerName); err != nil {
 		err = fmt.Errorf("failed to lookup %q: %v", peerName, err)
 	}
 
@@ -316,26 +315,3 @@ func genIfName() string {
 	s, _ := uuid.New().MarshalText() // .MarshalText() always return a nil error
 	return string(s[:8])
 }
-
-// GetLinksByNamePrefix returns a list of links whose name matches a prefix.
-func GetLinksByNamePrefix(prefix string) ([]netlink.Link, error) {
-	// filtered list of interfaces
-	if prefix == "" {
-		return nil, fmt.Errorf("prefix is not specified")
-	}
-	var fls []netlink.Link
-
-	ls, err := netlink.LinkList()
-	if err != nil {
-		return nil, err
-	}
-	for _, l := range ls {
-		if strings.HasPrefix(l.Attrs().Name, prefix) {
-			fls = append(fls, l)
-		}
-	}
-	if len(fls) == 0 {
-		return nil, fmt.Errorf("no links found by specified prefix %s", prefix)
-	}
-	return fls, nil
-}

clab/ovs.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/containernetworking/plugins/pkg/ns"
 	"github.com/digitalocean/go-openvswitch/ovs"
+	"github.com/srl-labs/containerlab/utils"
 	"github.com/vishvananda/netlink"
 )
 
@@ -20,7 +21,7 @@ func (veth *vEthEndpoint) toOvsBridge() error {
 		return err
 	}
 	err = vethNS.Do(func(_ ns.NetNS) error {
-		_, err := netlink.LinkByName(veth.OvsBridge)
+		_, err := utils.LinkByNameOrAlias(veth.OvsBridge)
 		if err != nil {
 			return fmt.Errorf("could not find ovs bridge %q: %v", veth.OvsBridge, err)
 		}

clab/tc.go

@@ -10,6 +10,7 @@ import (
 	"syscall"
 
 	log "github.com/sirupsen/logrus"
+	"github.com/srl-labs/containerlab/utils"
 	"github.com/vishvananda/netlink"
 )
 
@@ -34,12 +35,12 @@ func SetIngressMirror(src, dst string) (err error) {
 	var linkSrc, linkDest netlink.Link
 	log.Infof("configuring ingress mirroring with tc in the direction of %s -> %s", src, dst)
 
-	if linkSrc, err = netlink.LinkByName(src); err != nil {
+	if linkSrc, err = utils.LinkByNameOrAlias(src); err != nil {
 		return fmt.Errorf("failed to lookup %q: %v",
 			src, err)
 	}
 
-	if linkDest, err = netlink.LinkByName(dst); err != nil {
+	if linkDest, err = utils.LinkByNameOrAlias(dst); err != nil {
 		return fmt.Errorf("failed to lookup %q: %v",
 			dst, err)
 	}

clab/vxlan.go

@@ -9,6 +9,7 @@ import (
 	"net"
 
 	log "github.com/sirupsen/logrus"
+	"github.com/srl-labs/containerlab/utils"
 	"github.com/vishvananda/netlink"
 )
 
@@ -30,7 +31,7 @@ func AddVxLanInterface(vxlan VxLAN) (err error) {
 	log.Infof("Adding VxLAN link %s to remote address %s via %s with VNI %v", vxlan.Name, vxlan.Remote, vxlan.ParentIf, vxlan.ID)
 
 	// before creating vxlan interface, check if it doesn't exist already
-	if vxlanIf, err = netlink.LinkByName(vxlan.Name); err != nil {
+	if vxlanIf, err = utils.LinkByNameOrAlias(vxlan.Name); err != nil {
 		if _, ok := err.(netlink.LinkNotFoundError); !ok {
 			return fmt.Errorf("failed to check if VxLAN interface %s exists: %v", vxlan.Name, err)
 		}
@@ -39,7 +40,7 @@ func AddVxLanInterface(vxlan VxLAN) (err error) {
 		return fmt.Errorf("interface %s already exists", vxlan.Name)
 	}
 
-	if parentIf, err = netlink.LinkByName(vxlan.ParentIf); err != nil {
+	if parentIf, err = utils.LinkByNameOrAlias(vxlan.ParentIf); err != nil {
 		return fmt.Errorf("failed to get VxLAN parent interface %s: %v", vxlan.ParentIf, err)
 	}
 

cmd/destroy.go

@@ -193,6 +193,15 @@ func destroyLab(ctx context.Context, c *clab.CLab) (err error) {
 		maxWorkers = 1
 	}
 
+	// populating the nspath for the nodes
+	for _, n := range c.Nodes {
+		nsp, err := n.GetRuntime().GetNSPath(ctx, n.Config().LongName)
+		if err != nil {
+			continue
+		}
+		n.Config().NSPath = nsp
+	}
+
 	log.Infof("Destroying lab: %s", c.Config.Name)
 	c.DeleteNodes(ctx, maxWorkers, serialNodes)
 
@@ -221,10 +230,5 @@ func destroyLab(ctx context.Context, c *clab.CLab) (err error) {
 		}
 	}
 
-	// Remove any dangling veths from host netns or bridges
-	err = c.VethCleanup(ctx)
-	if err != nil {
-		return fmt.Errorf("error during veth cleanup procedure, %w", err)
-	}
 	return err
 }