Skip to content

trim extraneous whitespaces when parsing comma-separated config sources #1535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tariq1890 merged 1 commit into from
Dec 16, 2025
Merged

trim extraneous whitespaces when parsing comma-separated config sources #1535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cmd/nvidia-ctk-installer/container/container.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,12 @@ func (o Options) GetConfigLoaders(commandSourceFunc func(string, string) toml.Lo
var loaders []toml.Loader
for _, configSource := range o.ConfigSources {
parts := strings.SplitN(configSource, "=", 2)
source := parts[0]
source := strings.TrimSpace(parts[0])
switch source {
case "file":
fileSourcePath := o.TopLevelConfigPath
if len(parts) > 1 {
fileSourcePath = parts[1]
fileSourcePath = strings.TrimSpace(parts[1])
}
loaders = append(loaders, toml.FromFile(fileSourcePath))
case "command":
Expand Down
266 changes: 266 additions & 0 deletions cmd/nvidia-ctk-installer/container/runtime/containerd/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1777,6 +1777,272 @@ version = 3

require.NoFileExists(t, co.DropInConfig)

return nil
},
},
{
description: "v3: minimal config using runtime config sources with extraneous spaces",
containerOptions: container.Options{
TopLevelConfigPath: "{{ .testRoot }}/etc/containerd/config.toml",
DropInConfig: "{{ .testRoot }}/conf.d/99-nvidia.toml",
RuntimeName: "nvidia",
RuntimeDir: "/usr/bin",
SetAsDefault: false,
RestartMode: "none",
ExecutablePath: "not-containerd",
ConfigSources: []string{" command", "file "},
},
options: Options{
runtimeType: "io.containerd.runc.v2",
},
prepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {
require.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))

// Write v3 config with runc runtime
initialConfig := `version = 3

[plugins]
[plugins."io.containerd.cri.v1.runtime"]
[plugins."io.containerd.cri.v1.runtime".containerd]
[plugins."io.containerd.cri.v1.runtime".containerd.runtimes]
[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))
return nil
},
assertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {
require.FileExists(t, co.TopLevelConfigPath)

actual, err := os.ReadFile(co.TopLevelConfigPath)
require.NoError(t, err)

expected := `imports = ["` + filepath.Dir(co.DropInConfig) + `/*.toml"]
version = 3

[plugins]

[plugins."io.containerd.cri.v1.runtime"]

[plugins."io.containerd.cri.v1.runtime".containerd]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.Equal(t, expected, string(actual))

require.FileExists(t, co.DropInConfig)

actualDropIn, err := os.ReadFile(co.DropInConfig)
require.NoError(t, err)

expectedDropIn := `version = 3

[plugins]

[plugins."io.containerd.cri.v1.runtime"]

[plugins."io.containerd.cri.v1.runtime".containerd]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia.options]
BinaryName = "/usr/bin/nvidia-container-runtime"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia-cdi]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia-cdi.options]
BinaryName = "/usr/bin/nvidia-container-runtime.cdi"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia-legacy]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia-legacy.options]
BinaryName = "/usr/bin/nvidia-container-runtime.legacy"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.Equal(t, expectedDropIn, string(actualDropIn))

return nil
},
assertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {
require.FileExists(t, co.TopLevelConfigPath)

actual, err := os.ReadFile(co.TopLevelConfigPath)
require.NoError(t, err)

// Should return to original v3 config with just runc
expected := `imports = ["` + filepath.Dir(co.DropInConfig) + `/*.toml"]
version = 3

[plugins]

[plugins."io.containerd.cri.v1.runtime"]

[plugins."io.containerd.cri.v1.runtime".containerd]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.Equal(t, expected, string(actual))

require.NoFileExists(t, co.DropInConfig)

return nil
},
},
{
description: "v3: minimal config using runtime config sources with extraneous spaces in the config file name",
containerOptions: container.Options{
TopLevelConfigPath: "{{ .testRoot }}/etc/containerd/config.toml",
DropInConfig: "{{ .testRoot }}/conf.d/99-nvidia.toml",
RuntimeName: "nvidia",
RuntimeDir: "/usr/bin",
SetAsDefault: false,
RestartMode: "none",
ExecutablePath: "not-containerd",
ConfigSources: []string{"command", "file= {{ .testRoot }}/etc/containerd/config.toml "},
},
options: Options{
runtimeType: "io.containerd.runc.v2",
},
prepareEnvironment: func(t *testing.T, co *container.Options, o *Options) error {
require.NoError(t, os.MkdirAll(filepath.Dir(co.TopLevelConfigPath), 0755))

// Write v3 config with runc runtime
initialConfig := `version = 3

[plugins]
[plugins."io.containerd.cri.v1.runtime"]
[plugins."io.containerd.cri.v1.runtime".containerd]
[plugins."io.containerd.cri.v1.runtime".containerd.runtimes]
[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.NoError(t, os.WriteFile(co.TopLevelConfigPath, []byte(initialConfig), 0600))
return nil
},
assertSetupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {
require.FileExists(t, co.TopLevelConfigPath)

actual, err := os.ReadFile(co.TopLevelConfigPath)
require.NoError(t, err)

expected := `imports = ["` + filepath.Dir(co.DropInConfig) + `/*.toml"]
version = 3

[plugins]

[plugins."io.containerd.cri.v1.runtime"]

[plugins."io.containerd.cri.v1.runtime".containerd]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.Equal(t, expected, string(actual))

require.FileExists(t, co.DropInConfig)

actualDropIn, err := os.ReadFile(co.DropInConfig)
require.NoError(t, err)

expectedDropIn := `version = 3

[plugins]

[plugins."io.containerd.cri.v1.runtime"]

[plugins."io.containerd.cri.v1.runtime".containerd]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia.options]
BinaryName = "/usr/bin/nvidia-container-runtime"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia-cdi]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia-cdi.options]
BinaryName = "/usr/bin/nvidia-container-runtime.cdi"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia-legacy]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.nvidia-legacy.options]
BinaryName = "/usr/bin/nvidia-container-runtime.legacy"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.Equal(t, expectedDropIn, string(actualDropIn))

return nil
},
assertCleanupPostConditions: func(t *testing.T, co *container.Options, o *Options) error {
require.FileExists(t, co.TopLevelConfigPath)

actual, err := os.ReadFile(co.TopLevelConfigPath)
require.NoError(t, err)

// Should return to original v3 config with just runc
expected := `imports = ["` + filepath.Dir(co.DropInConfig) + `/*.toml"]
version = 3

[plugins]

[plugins."io.containerd.cri.v1.runtime"]

[plugins."io.containerd.cri.v1.runtime".containerd]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes]

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc]
runtime_type = "io.containerd.runc.v2"

[plugins."io.containerd.cri.v1.runtime".containerd.runtimes.runc.options]
BinaryName = "/usr/bin/runc"
`
require.Equal(t, expected, string(actual))

require.NoFileExists(t, co.DropInConfig)

return nil
},
},
Expand Down