Add SetupCleanup test for containerd

Signed-off-by: Evan Lezar <[email protected]>

Author: elezar

cmd/nvidia-ctk-installer/container/container.go

@@ -35,8 +35,9 @@ const (
 
 // Options defines the shared options for the CLIs to configure containers runtimes.
 type Options struct {
-	Config string
-	Socket string
+	DropInConfig string
+	Config       string
+	Socket       string
 	// ExecutablePath specifies the path to the container runtime executable.
 	// This is used to extract the current config, for example.
 	// If a HostRootMount is specified, this path is relative to the host root
@@ -71,8 +72,12 @@ func (o Options) Unconfigure(cfg engine.Interface) error {
 
 // flush flushes the specified config to disk
 func (o Options) flush(cfg engine.Interface) error {
-	logrus.Infof("Flushing config to %v", o.Config)
-	n, err := cfg.Save(o.Config)
+	filepath := o.DropInConfig
+	if filepath == "" {
+		filepath = o.Config
+	}
+	logrus.Infof("Flushing config to %v", filepath)
+	n, err := cfg.Save(filepath)
 	if err != nil {
 		return fmt.Errorf("unable to flush config: %v", err)
 	}

cmd/nvidia-ctk-installer/container/runtime/containerd/config_v2_test.go

@@ -16,10 +16,132 @@
 
 package containerd
 
+import (
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+	"github.com/urfave/cli/v3"
+
+	"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-ctk-installer/container"
+	"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/toml"
+)
+
 const (
 	runtimeType = "runtime_type"
 )
 
+func TestSetupCleanup(t *testing.T) {
+	c := &cli.Command{
+		Name: "test",
+	}
+	testCases := []struct {
+		description                 string
+		containerOptions            container.Options
+		options                     Options
+		prepareEnvironment          func(*testing.T, string) error
+		expectedSetupError          error
+		assertSetupPostConditions   func(*testing.T, string) error
+		expectedCleanupError        error
+		assertCleanupPostConditions func(*testing.T, string) error
+	}{
+		{
+			description: "top-level config does not exist",
+			containerOptions: container.Options{
+				DropInConfig: "{{ .testRoot }}/conf.d/99-nvidia.toml",
+				Config:       "{{ .testRoot }}/etc/containerd/config.toml",
+			},
+			assertSetupPostConditions: func(t *testing.T, testRoot string) error {
+				require.FileExists(t, filepath.Join(testRoot, "/etc/containerd/config.toml"))
+				topLevel, err := toml.FromFile(filepath.Join(testRoot, "/etc/containerd/config.toml")).Load()
+				require.NoError(t, err)
+				require.EqualValues(t, `imports = ["`+filepath.Join(testRoot, "/conf.d/*.toml")+`"]
+version = 2
+`, topLevel.String())
+				require.FileExists(t, filepath.Join(testRoot, "/conf.d/99-nvidia.toml"))
+				dropIn, err := toml.FromFile(filepath.Join(testRoot, "/conf.d/99-nvidia.toml")).Load()
+				require.NoError(t, err)
+				require.EqualValues(t, `version = 2
+
+[plugins]
+
+  [plugins."io.containerd.grpc.v1.cri"]
+
+    [plugins."io.containerd.grpc.v1.cri".containerd]
+
+      [plugins."io.containerd.grpc.v1.cri".containerd.runtimes]
+
+        [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia]
+          privileged_without_host_devices = false
+          runtime_engine = ""
+          runtime_root = ""
+          runtime_type = ""
+
+          [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia.options]
+            BinaryName = "nvidia-container-runtime"
+
+        [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia-cdi]
+          privileged_without_host_devices = false
+          runtime_engine = ""
+          runtime_root = ""
+          runtime_type = ""
+
+          [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia-cdi.options]
+            BinaryName = "nvidia-container-runtime.cdi"
+
+        [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia-legacy]
+          privileged_without_host_devices = false
+          runtime_engine = ""
+          runtime_root = ""
+          runtime_type = ""
+
+          [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.nvidia-legacy.options]
+            BinaryName = "nvidia-container-runtime.legacy"
+`, dropIn.String())
+				return nil
+			},
+			assertCleanupPostConditions: func(t *testing.T, testRoot string) error {
+				require.NoFileExists(t, filepath.Join(testRoot, "/etc/containerd/config.toml"))
+				require.NoFileExists(t, filepath.Join(testRoot, "/conf.d/99-nvidia.toml"))
+				return nil
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		// TODO: Add tests for restart mode.
+		tc.containerOptions.RestartMode = "none"
+		t.Run(tc.description, func(t *testing.T) {
+			// Update any paths as required:
+			testRoot := t.TempDir()
+			tc.containerOptions.Config = strings.ReplaceAll(tc.containerOptions.Config, "{{ .testRoot }}", testRoot)
+			tc.containerOptions.DropInConfig = strings.ReplaceAll(tc.containerOptions.DropInConfig, "{{ .testRoot }}", testRoot)
+
+			// Prepare the test environment
+			if tc.prepareEnvironment != nil {
+				require.NoError(t, tc.prepareEnvironment(t, testRoot))
+			}
+
+			err := Setup(c, &tc.containerOptions, &tc.options)
+			require.EqualValues(t, tc.expectedSetupError, err)
+
+			// TODO: Check state
+			if tc.assertSetupPostConditions != nil {
+				require.NoError(t, tc.assertSetupPostConditions(t, testRoot))
+			}
+
+			err = Cleanup(c, &tc.containerOptions, &tc.options)
+			require.EqualValues(t, tc.expectedCleanupError, err)
+
+			if tc.assertCleanupPostConditions != nil {
+				require.NoError(t, tc.assertCleanupPostConditions(t, testRoot))
+			}
+		})
+	}
+
+}
+
 // func TestUpdateV2ConfigDefaultRuntime(t *testing.T) {
 // 	logger, _ := testlog.NewNullLogger()
 // 	const runtimeDir = "/test/runtime/dir"

cmd/nvidia-ctk-installer/container/runtime/containerd/containerd.go

@@ -170,7 +170,7 @@ func GetLowlevelRuntimePaths(o *container.Options, co *Options) ([]string, error
 
 func getRuntimeConfig(o *container.Options, co *Options) (engine.Interface, error) {
 	return containerd.New(
-		containerd.WithPath(o.Config),
+		containerd.WithTopLevelConfigPath(o.Config),
 		containerd.WithConfigSource(
 			toml.LoadFirst(
 				containerd.CommandLineSource(o.HostRootMount, o.ExecutablePath),