[no-relnote] Add unittest for cmd/ctk/installer/container/crio

Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>

Author: ArangoGutierrez

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

@@ -33,75 +33,113 @@ const (
 	runtimeDir  = "/test/runtime/dir"
 )
 
-// TestUpdateV2Config_NoConfigFile tests the scenario when there is no
-// containerd config file present
-func TestUpdateV2Config_NoConfigFile(t *testing.T) {
-	logger, _ := testlog.NewNullLogger()
+// testCase represents a test case configuration used across all
+// UpdateV2Config test functions. Each field controls a specific aspect
+// of the nvidia runtime configuration to test different permutations.
+type testCase struct {
+	// name provides a descriptive identifier for the test case that clearly
+	// states the configuration being tested
+	name string
+	// runtimeName is the name of the nvidia runtime to configure (e.g., "nvidia"
+	// or a custom name like "gpu-runtime")
+	runtimeName string
+	// enableCDI controls whether CDI (Container Device Interface) support should
+	// be enabled in the containerd configuration
+	enableCDI bool
+	// setAsDefault controls whether the nvidia runtime should be set as the
+	// default runtime for containerd
+	setAsDefault bool
+	// withRunc controls whether a runc runtime exists in the configuration that
+	// the nvidia runtime can inherit settings from
+	withRunc bool
+}
 
-	testCases := []struct {
-		name         string
-		runtimeName  string
-		enableCDI    bool
-		setAsDefault bool
-		withRunc     bool
-	}{
+// getSharedTestCases returns a comprehensive set of test cases that validate
+// the core functionality of nvidia runtime configuration across different
+// containerd config scenarios.
+//
+// These test cases are designed to test the same functionality in three
+// different contexts:
+//   - No existing config file (TestUpdateV2Config_NoConfigFile)
+//   - Existing config without nvidia entries (TestUpdateV2Config_ExistingConfigWithoutNvidia)
+//   - Existing config with nvidia entries (TestUpdateV2Config_ExistingConfigWithNvidia)
+//
+// Each test case represents a specific permutation of configuration options:
+//   - Runtime name: "nvidia" (standard) or custom names
+//   - CDI enablement: enabled or disabled
+//   - Default runtime: whether to set the nvidia runtime as default
+//   - Runc inheritance: whether runc runtime exists to inherit settings from
+//
+// This approach ensures consistent test coverage across all scenarios and makes
+// it easy to verify that the same feature works correctly regardless of the
+// initial state of the containerd configuration.
+func getSharedTestCases() []testCase {
+	return []testCase{
 		{
-			name:         "basic nvidia runtime",
+			name:         "nvidia runtime without CDI, not default, no runc",
 			runtimeName:  "nvidia",
 			enableCDI:    false,
 			setAsDefault: false,
 			withRunc:     false,
 		},
 		{
-			name:         "nvidia runtime with CDI enabled",
+			name:         "nvidia runtime with CDI enabled, not default, no runc",
 			runtimeName:  "nvidia",
 			enableCDI:    true,
 			setAsDefault: false,
 			withRunc:     false,
 		},
 		{
-			name:         "nvidia runtime as default",
+			name:         "nvidia runtime without CDI, set as default, no runc",
 			runtimeName:  "nvidia",
 			enableCDI:    false,
 			setAsDefault: true,
 			withRunc:     false,
 		},
 		{
-			name:         "nvidia runtime with CDI and as default",
+			name:         "nvidia runtime with CDI enabled, set as default, no runc",
 			runtimeName:  "nvidia",
 			enableCDI:    true,
 			setAsDefault: true,
 			withRunc:     false,
 		},
 		{
-			name:         "custom runtime name",
+			name:         "custom runtime (CUSTOM) without CDI, not default, no runc",
 			runtimeName:  "CUSTOM",
 			enableCDI:    false,
 			setAsDefault: false,
 			withRunc:     false,
 		},
 		{
-			name:         "custom runtime with CDI and as default",
+			name:         "custom runtime (CUSTOM) with CDI enabled, set as default, no runc",
 			runtimeName:  "CUSTOM",
 			enableCDI:    true,
 			setAsDefault: true,
 			withRunc:     false,
 		},
 		{
-			name:         "nvidia runtime with runc present",
+			name:         "nvidia runtime without CDI, not default, with runc",
 			runtimeName:  "nvidia",
 			enableCDI:    false,
 			setAsDefault: false,
 			withRunc:     true,
 		},
 		{
-			name:         "nvidia runtime with runc, CDI and as default",
+			name:         "nvidia runtime with CDI enabled, set as default, with runc",
 			runtimeName:  "nvidia",
 			enableCDI:    true,
 			setAsDefault: true,
 			withRunc:     true,
 		},
 	}
+}
+
+// TestUpdateV2Config_NoConfigFile tests the scenario when there is no
+// containerd config file present
+func TestUpdateV2Config_NoConfigFile(t *testing.T) {
+	logger, _ := testlog.NewNullLogger()
+
+	testCases := getSharedTestCases()
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
@@ -218,56 +256,7 @@ func TestUpdateV2Config_ExistingConfigWithoutNvidia(t *testing.T) {
 		},
 	}
 
-	testCases := []struct {
-		name         string
-		runtimeName  string
-		enableCDI    bool
-		setAsDefault bool
-		withRunc     bool
-	}{
-		{
-			name:         "add nvidia runtime to existing config",
-			runtimeName:  "nvidia",
-			enableCDI:    false,
-			setAsDefault: false,
-			withRunc:     false,
-		},
-		{
-			name:         "add nvidia runtime with CDI to existing config",
-			runtimeName:  "nvidia",
-			enableCDI:    true,
-			setAsDefault: false,
-			withRunc:     false,
-		},
-		{
-			name:         "add nvidia runtime as default to existing config",
-			runtimeName:  "nvidia",
-			enableCDI:    false,
-			setAsDefault: true,
-			withRunc:     false,
-		},
-		{
-			name:         "add custom runtime with all features to existing config",
-			runtimeName:  "gpu-runtime",
-			enableCDI:    true,
-			setAsDefault: true,
-			withRunc:     false,
-		},
-		{
-			name:         "add nvidia runtime to existing config with runc",
-			runtimeName:  "nvidia",
-			enableCDI:    false,
-			setAsDefault: false,
-			withRunc:     true,
-		},
-		{
-			name:         "add nvidia runtime with all features and runc",
-			runtimeName:  "nvidia",
-			enableCDI:    true,
-			setAsDefault: true,
-			withRunc:     true,
-		},
-	}
+	testCases := getSharedTestCases()
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
@@ -391,56 +380,7 @@ func TestUpdateV2Config_ExistingConfigWithNvidia(t *testing.T) {
 		},
 	}
 
-	testCases := []struct {
-		name         string
-		runtimeName  string
-		enableCDI    bool
-		setAsDefault bool
-		withRunc     bool
-	}{
-		{
-			name:         "update existing nvidia runtime",
-			runtimeName:  "nvidia",
-			enableCDI:    false,
-			setAsDefault: false,
-			withRunc:     false,
-		},
-		{
-			name:         "update nvidia runtime with CDI",
-			runtimeName:  "nvidia",
-			enableCDI:    true,
-			setAsDefault: false,
-			withRunc:     false,
-		},
-		{
-			name:         "update nvidia runtime as default",
-			runtimeName:  "nvidia",
-			enableCDI:    false,
-			setAsDefault: true,
-			withRunc:     false,
-		},
-		{
-			name:         "add custom runtime alongside existing nvidia",
-			runtimeName:  "gpu-runtime",
-			enableCDI:    true,
-			setAsDefault: true,
-			withRunc:     false,
-		},
-		{
-			name:         "update with runc present",
-			runtimeName:  "nvidia",
-			enableCDI:    false,
-			setAsDefault: false,
-			withRunc:     true,
-		},
-		{
-			name:         "update all features with runc",
-			runtimeName:  "nvidia",
-			enableCDI:    true,
-			setAsDefault: true,
-			withRunc:     true,
-		},
-	}
+	testCases := getSharedTestCases()
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {