Merge pull request #427 from steiler/containerd

containerd

.github/workflows/cicd.yml

@@ -80,6 +80,9 @@ jobs:
 
   smoke-tests:
     runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        runtime: ["docker", "containerd"]
     needs:
       - staticcheck
       - unit-test
@@ -103,7 +106,7 @@ jobs:
           pip install -r tests/requirements.txt
       - name: Run smoke tests
         run: |
-          bash ./tests/rf-run.sh ./tests/01-smoke
+          bash ./tests/rf-run.sh ${{ matrix.runtime }} ./tests/01-smoke
       # upload test reports as a zip file
       - uses: actions/upload-artifact@v2
         if: always()

.gitlab-ci.yml

@@ -34,35 +34,44 @@ build-containerlab:
 
 smoke-tests:
   stage: smoke-tests
+  parallel:
+    matrix:
+      - RUNTIME: [docker, containerd]
   tags:
     - containerlab
   script:
     - source ~/venvs/rf/bin/activate
-    - bash ./tests/rf-run.sh ./tests/01-smoke
+    - bash ./tests/rf-run.sh $RUNTIME ./tests/01-smoke
   artifacts:
     when: always
     paths:
       - "./tests/out/*.html"
 
 srl-tests:
   stage: integration-tests
+  parallel:
+    matrix:
+      - RUNTIME: [docker, containerd]
   tags:
     - containerlab
   script:
     - source ~/venvs/rf/bin/activate
-    - bash ./tests/rf-run.sh ./tests/02-basic-srl
+    - bash ./tests/rf-run.sh $RUNTIME ./tests/02-basic-srl
   artifacts:
     when: always
     paths:
       - "./tests/out/*.html"
 
 ceos-tests:
   stage: integration-tests
+  parallel:
+    matrix:
+      - RUNTIME: [docker, containerd]
   tags:
     - containerlab
   script:
     - source ~/venvs/rf/bin/activate
-    - bash ./tests/rf-run.sh ./tests/03-basic-ceos
+    - bash ./tests/rf-run.sh $RUNTIME ./tests/02-basic-srl
   artifacts:
     when: always
     paths:

clab/ceos.go

@@ -10,7 +10,6 @@ import (
 	"net"
 	"path"
 	"path/filepath"
-	"strconv"
 	"strings"
 	"time"
 
@@ -41,13 +40,10 @@ func ceosPostDeploy(ctx context.Context, c *CLab, node *types.Node, lworkers uin
 	if err != nil {
 		return err
 	}
-	// since container has been restarted, we need to get its new NSPath and link netns
-	cont, err := c.Runtime.ContainerInspect(ctx, node.ContainerID)
+	node.NSPath, err = c.Runtime.GetNSPath(ctx, node.ContainerID)
 	if err != nil {
 		return err
 	}
-	log.Debugf("node %s new pid %v", node.LongName, cont.Pid)
-	node.NSPath = "/proc/" + strconv.Itoa(cont.Pid) + "/ns/net"
 	err = utils.LinkContainerNS(node.NSPath, node.LongName)
 	if err != nil {
 		return err

clab/clab.go

@@ -7,6 +7,7 @@ package clab
 import (
 	"context"
 	"fmt"
+	"os"
 	"path"
 	"strings"
 	"sync"
@@ -58,15 +59,29 @@ func WithTimeout(dur time.Duration) ClabOption {
 
 func WithRuntime(name string, d bool, dur time.Duration, gracefulShutdown bool) ClabOption {
 	return func(c *CLab) {
+		// define runtime name.
+		// order of preference: cli flag -> env var -> default value of docker
+		envN := os.Getenv("CLAB_RUNTIME")
+		switch {
+		case name != "":
+		case envN != "":
+			name = envN
+		default:
+			name = runtime.DockerRuntime
+		}
+
 		if rInit, ok := runtime.ContainerRuntimes[name]; ok {
 			c.Runtime = rInit()
-			c.Runtime.Init(
+			err := c.Runtime.Init(
 				runtime.WithConfig(&runtime.RuntimeConfig{
 					Timeout: dur,
 					Debug:   d,
 				}),
 				runtime.WithMgmtNet(c.Config.Mgmt),
 			)
+			if err != nil {
+				log.Fatalf("failed to init the container runtime: %s", err)
+			}
 			return
 		}
 		log.Fatalf("unknown container runtime %q", name)
@@ -337,13 +352,9 @@ func (c *CLab) DeleteNodes(ctx context.Context, workers uint, containers []types
 						log.Debugf("Worker %d terminating...", i)
 						return
 					}
-					name := cont.ID
-					if len(cont.Names) > 0 {
-						name = strings.TrimLeft(cont.Names[0], "/")
-					}
-					err := c.Runtime.DeleteContainer(ctx, name)
+					err := c.Runtime.DeleteContainer(ctx, cont)
 					if err != nil {
-						log.Errorf("could not remove container '%s': %v", name, err)
+						log.Errorf("could not remove container '%s': %v", cont.ID, err)
 					}
 				case <-ctx.Done():
 					return

clab/config.go

@@ -661,8 +661,7 @@ func (c *CLab) VerifyContainersUniqueness(ctx context.Context) error {
 	nctx, cancel := context.WithTimeout(ctx, c.timeout)
 	defer cancel()
 
-	var labels []string
-	containers, err := c.Runtime.ListContainers(nctx, labels)
+	containers, err := c.Runtime.ListContainers(nctx, nil)
 	if err != nil {
 		return fmt.Errorf("could not list containers: %v", err)
 	}

clab/srl.go

@@ -88,8 +88,8 @@ func initSRLNode(c *CLab, nodeCfg NodeConfig, node *types.Node, user string, env
 		log.Fatalf("wrong node type. '%s' doesn't exist. should be any of %s", node.NodeType, strings.Join(keys, ", "))
 	}
 
-	// initialize specifc container information
-	node.Cmd = "sudo sr_linux"
+	// the addition touch is needed to support non docker runtimes
+	node.Cmd = "sudo bash -c 'touch /.dockerenv && /opt/srlinux/bin/sr_linux'"
 
 	kindEnv := map[string]string{"SRLINUX": "1"}
 	node.Env = mergeStringMaps(kindEnv, envs)

cmd/deploy.go

@@ -132,7 +132,7 @@ var deployCmd = &cobra.Command{
 		}
 		log.Debug("containers created, retrieving state and IP addresses...")
 
-		labels = append(labels, "containerlab="+c.Config.Name)
+		labels := []*types.GenericFilter{{FilterType: "label", Match: c.Config.Name, Field: "containerlab", Operator: "="}}
 		containers, err := c.Runtime.ListContainers(ctx, labels)
 		if err != nil {
 			return fmt.Errorf("could not list containers: %v", err)

cmd/destroy.go

@@ -64,7 +64,7 @@ var destroyCmd = &cobra.Command{
 			}
 			c := clab.NewContainerLab(opts...)
 			// list all containerlab containers
-			containers, err := c.Runtime.ListContainers(ctx, []string{"containerlab"})
+			containers, err := c.Runtime.ListContainers(ctx, []*types.GenericFilter{{FilterType: "label", Field: "containerlab", Operator: "exists"}})
 			if err != nil {
 				return fmt.Errorf("could not list containers: %v", err)
 			}
@@ -125,7 +125,7 @@ func deleteEntriesFromHostsFile(containers []types.GenericContainer, bridgeName
 	if bridgeName == "" {
 		return fmt.Errorf("missing bridge name")
 	}
-	f, err := os.OpenFile("/etc/hosts", os.O_RDWR, 0644)
+	f, err := os.OpenFile("/etc/hosts", os.O_RDWR, 0644) // skipcq: GSC-G302
 	if err != nil {
 		return err
 	}
@@ -171,7 +171,9 @@ func deleteEntriesFromHostsFile(containers []types.GenericContainer, bridgeName
 }
 
 func destroyLab(ctx context.Context, c *clab.CLab) (err error) {
-	containers, err := c.Runtime.ListContainers(ctx, []string{fmt.Sprintf("containerlab=%s", c.Config.Name)})
+
+	labels := []*types.GenericFilter{{FilterType: "label", Match: c.Config.Name, Field: "containerlab", Operator: "="}}
+	containers, err := c.Runtime.ListContainers(ctx, labels)
 	if err != nil {
 		return fmt.Errorf("could not list containers: %v", err)
 	}
@@ -207,7 +209,7 @@ func destroyLab(ctx context.Context, c *clab.CLab) (err error) {
 	}
 
 	// delete lab management network
-	log.Infof("Deleting docker network '%s'...", c.Config.Mgmt.Network)
+	log.Infof("Deleting network '%s'...", c.Config.Mgmt.Network)
 	if err = c.Runtime.DeleteNet(ctx); err != nil {
 		// do not log error message if deletion error simply says that such network doesn't exist
 		if err.Error() != fmt.Sprintf("Error: No such network: %s", c.Config.Mgmt.Network) {

cmd/disableTxOffload.go

@@ -6,7 +6,6 @@ package cmd
 
 import (
 	"context"
-	"strconv"
 
 	"github.com/containernetworking/plugins/pkg/ns"
 	log "github.com/sirupsen/logrus"
@@ -33,13 +32,12 @@ var disableTxOffloadCmd = &cobra.Command{
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
 
-		cnt, err := c.Runtime.ContainerInspect(ctx, cntName)
+		log.Infof("getting container '%s' information", cntName)
+
+		NSPath, err := c.Runtime.GetNSPath(ctx, cntName)
 		if err != nil {
 			return err
 		}
-
-		log.Infof("getting container '%s' information", cntName)
-		NSPath := "/proc/" + strconv.Itoa(cnt.Pid) + "/ns/net"
 		nodeNS, err := ns.GetNS(NSPath)
 		if err != nil {
 			return err

cmd/exec.go

@@ -12,6 +12,7 @@ import (
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/srl-labs/containerlab/clab"
+	"github.com/srl-labs/containerlab/types"
 )
 
 var labels []string
@@ -44,8 +45,9 @@ var execCmd = &cobra.Command{
 		}
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
-		labels = append(labels, "containerlab="+name)
-		containers, err := c.Runtime.ListContainers(ctx, labels)
+		filters := []*types.GenericFilter{{FilterType: "label", Match: name, Field: "containerlab", Operator: "="}}
+		filters = append(filters, types.FilterFromLabelStrings(labels)...)
+		containers, err := c.Runtime.ListContainers(ctx, filters)
 		if err != nil {
 			log.Fatalf("could not list containers: %v", err)
 		}

cmd/graph.go

@@ -82,7 +82,8 @@ var graphCmd = &cobra.Command{
 		// if offline mode is not enforced, list containers matching lab name
 		if !offline {
 			var err error
-			containers, err = c.Runtime.ListContainers(ctx, []string{fmt.Sprintf("containerlab=%s", c.Config.Name)})
+			labels := []*types.GenericFilter{{FilterType: "label", Match: c.Config.Name, Field: "containerlab", Operator: "="}}
+			containers, err = c.Runtime.ListContainers(ctx, labels)
 			if err != nil {
 				log.Errorf("could not list containers: %v", err)
 			}

cmd/inspect.go

@@ -64,12 +64,17 @@ var inspectCmd = &cobra.Command{
 		}
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
+		var glabels []*types.GenericFilter
 		if all {
-			labels = append(labels, "containerlab")
+			glabels = []*types.GenericFilter{{FilterType: "label", Field: "containerlab", Operator: "exists"}}
 		} else {
-			labels = append(labels, "containerlab="+name)
+			if name != "" {
+				glabels = []*types.GenericFilter{{FilterType: "label", Match: name, Field: "containerlab", Operator: "="}}
+			} else if topo != "" {
+				glabels = []*types.GenericFilter{{FilterType: "label", Match: c.Config.Name, Field: "containerlab", Operator: "="}}
+			}
 		}
-		containers, err := c.Runtime.ListContainers(ctx, labels)
+		containers, err := c.Runtime.ListContainers(ctx, glabels)
 		if err != nil {
 			log.Fatalf("could not list containers: %v", err)
 		}
@@ -128,9 +133,8 @@ func printContainerInspect(c *clab.CLab, containers []types.GenericContainer, br
 			IPv4Address: getContainerIPv4(cont, bridgeName),
 			IPv6Address: getContainerIPv6(cont, bridgeName),
 		}
-		if len(cont.ID) > 11 {
-			cdet.ContainerID = cont.ID[:12]
-		}
+		cdet.ContainerID = cont.ShortID
+
 		if len(cont.Names) > 0 {
 			cdet.Name = strings.TrimLeft(cont.Names[0], "/")
 		}

cmd/root.go

@@ -11,7 +11,6 @@ import (
 
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
-	"github.com/srl-labs/containerlab/runtime"
 )
 
 var debug bool
@@ -52,8 +51,7 @@ func init() {
 	_ = rootCmd.MarkPersistentFlagFilename("topo", "*.yaml", "*.yml")
 	rootCmd.PersistentFlags().StringVarP(&name, "name", "n", "", "lab name")
 	rootCmd.PersistentFlags().DurationVarP(&timeout, "timeout", "", 30*time.Second, "timeout for docker requests, e.g: 30s, 1m, 2m30s")
-	rootCmd.PersistentFlags().StringVarP(&rt, "runtime", "r", runtime.DockerRuntime, "container runtime")
-
+	rootCmd.PersistentFlags().StringVarP(&rt, "runtime", "r", "", "container runtime")
 }
 
 // returns an error if topo path is not provided

cmd/save.go

@@ -46,7 +46,8 @@ Refer to the https://containerlab.srlinux.dev/cmd/save/ documentation to see the
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
 
-		containers, err := c.Runtime.ListContainers(ctx, []string{"containerlab=" + c.Config.Name})
+		labels := []*types.GenericFilter{{FilterType: "label", Match: c.Config.Name, Field: "containerlab", Operator: "="}}
+		containers, err := c.Runtime.ListContainers(ctx, labels)
 		if err != nil {
 			return fmt.Errorf("could not list containers: %v", err)
 		}

go.mod

@@ -6,24 +6,27 @@ require (
 	github.com/Juniper/go-netconf v0.1.1
 	github.com/awalterschulze/gographviz v2.0.1+incompatible
 	github.com/cloudflare/cfssl v1.4.1
-	github.com/containerd/containerd v1.5.0 // indirect
+	github.com/containerd/containerd v1.5.2
+	github.com/containernetworking/cni v0.8.1
 	github.com/containernetworking/plugins v0.9.1
 	github.com/digitalocean/go-openvswitch v0.0.0-20201214180534-ce0f183468d8
 	github.com/docker/docker v20.10.6+incompatible
 	github.com/docker/go-connections v0.4.0
-	github.com/google/go-cmp v0.5.4
+	github.com/docker/go-units v0.4.0
+	github.com/google/go-cmp v0.5.6
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
 	github.com/google/uuid v1.2.0
 	github.com/hashicorp/go-version v1.2.1
 	github.com/jsimonetti/rtnetlink v0.0.0-20210226120601-1b79e63a70a0
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/morikuni/aec v1.0.0 // indirect
 	github.com/olekukonko/tablewriter v0.0.5-0.20201029120751-42e21c7531a3
-	github.com/sirupsen/logrus v1.7.0
+	github.com/opencontainers/runtime-spec v1.0.3-0.20210303205135-43e4633e40c1
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/sirupsen/logrus v1.8.1
 	github.com/spf13/cobra v1.0.0
-	github.com/vishvananda/netlink v1.1.1-0.20201029203352-d40f9887b852
+	github.com/vishvananda/netlink v1.1.1-0.20210330154013-f5de75959ad5
 	github.com/ziutek/telnet v0.0.0-20180329124119-c3b780dc415b // indirect
 	golang.org/x/term v0.0.0-20210503060354-a79de5458b56
 	gopkg.in/yaml.v2 v2.4.0
 )
-