nvidia-container-toolkit/tools/container/docker/docker_test.go

/**
# Copyright (c) 2021, NVIDIA CORPORATION.  All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
*/

package main

import (
	"encoding/json"
	"testing"

	"github.com/NVIDIA/nvidia-container-toolkit/pkg/config/engine/docker"
	"github.com/stretchr/testify/require"
)

func TestUpdateConfigDefaultRuntime(t *testing.T) {
	const runtimeDir = "/test/runtime/dir"

	testCases := []struct {
		setAsDefault               bool
		runtimeName                string
		expectedDefaultRuntimeName interface{}
	}{
		{},
		{
			setAsDefault:               false,
			expectedDefaultRuntimeName: nil,
		},
		{
			setAsDefault:               true,
			runtimeName:                "NAME",
			expectedDefaultRuntimeName: "NAME",
		},
		{
			setAsDefault:               true,
			runtimeName:                "nvidia-experimental",
			expectedDefaultRuntimeName: "nvidia-experimental",
		},
		{
			setAsDefault:               true,
			runtimeName:                "nvidia",
			expectedDefaultRuntimeName: "nvidia",
		},
	}

	for i, tc := range testCases {
		o := &options{
			setAsDefault: tc.setAsDefault,
			runtimeName:  tc.runtimeName,
			runtimeDir:   runtimeDir,
		}

		config := docker.Config(map[string]interface{}{})

		err := UpdateConfig(&config, o)
		require.NoError(t, err, "%d: %v", i, tc)

		defaultRuntimeName := config["default-runtime"]
		require.EqualValues(t, tc.expectedDefaultRuntimeName, defaultRuntimeName, "%d: %v", i, tc)
	}
}

func TestUpdateConfig(t *testing.T) {
	const runtimeDir = "/test/runtime/dir"

	testCases := []struct {
		config         docker.Config
		setAsDefault   bool
		runtimeName    string
		expectedConfig map[string]interface{}
	}{
		{
			config:       map[string]interface{}{},
			setAsDefault: false,
			expectedConfig: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
					"nvidia-cdi": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.cdi",
						"args": []string{},
					},
					"nvidia-legacy": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.legacy",
						"args": []string{},
					},
				},
			},
		},
		{
			config:       map[string]interface{}{},
			setAsDefault: false,
			runtimeName:  "NAME",
			expectedConfig: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"NAME": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
					"nvidia-cdi": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.cdi",
						"args": []string{},
					},
					"nvidia-legacy": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.legacy",
						"args": []string{},
					},
				},
			},
		},
		{
			config:       map[string]interface{}{},
			setAsDefault: false,
			runtimeName:  "nvidia-experimental",
			expectedConfig: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
					"nvidia-cdi": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.cdi",
						"args": []string{},
					},
					"nvidia-legacy": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.legacy",
						"args": []string{},
					},
				},
			},
		},
		{
			config: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "nvidia-container-runtime",
						"args": []string{},
					},
				},
			},
			setAsDefault: false,
			expectedConfig: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
					"nvidia-cdi": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.cdi",
						"args": []string{},
					},
					"nvidia-legacy": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.legacy",
						"args": []string{},
					},
				},
			},
		},
		{
			config: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"not-nvidia": map[string]interface{}{
						"path": "some-other-path",
						"args": []string{},
					},
				},
			},
			expectedConfig: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"not-nvidia": map[string]interface{}{
						"path": "some-other-path",
						"args": []string{},
					},
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
					"nvidia-cdi": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.cdi",
						"args": []string{},
					},
					"nvidia-legacy": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.legacy",
						"args": []string{},
					},
				},
			},
		},
		{
			config: map[string]interface{}{
				"default-runtime": "runc",
			},
			setAsDefault: true,
			runtimeName:  "nvidia",
			expectedConfig: map[string]interface{}{
				"default-runtime": "nvidia",
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
					"nvidia-cdi": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.cdi",
						"args": []string{},
					},
					"nvidia-legacy": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.legacy",
						"args": []string{},
					},
				},
			},
		},
		{
			config: map[string]interface{}{
				"default-runtime": "runc",
			},
			setAsDefault: true,
			runtimeName:  "nvidia-experimental",
			expectedConfig: map[string]interface{}{
				"default-runtime": "nvidia-experimental",
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
					"nvidia-cdi": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.cdi",
						"args": []string{},
					},
					"nvidia-legacy": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.legacy",
						"args": []string{},
					},
				},
			},
		},
		{
			config: map[string]interface{}{
				"exec-opts":  []string{"native.cgroupdriver=systemd"},
				"log-driver": "json-file",
				"log-opts": map[string]string{
					"max-size": "100m",
				},
				"storage-driver": "overlay2",
			},
			expectedConfig: map[string]interface{}{
				"exec-opts":  []string{"native.cgroupdriver=systemd"},
				"log-driver": "json-file",
				"log-opts": map[string]string{
					"max-size": "100m",
				},
				"storage-driver": "overlay2",
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
					"nvidia-cdi": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.cdi",
						"args": []string{},
					},
					"nvidia-legacy": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.legacy",
						"args": []string{},
					},
				},
			},
		},
	}

	for i, tc := range testCases {
		options := &options{
			setAsDefault: tc.setAsDefault,
			runtimeName:  tc.runtimeName,
			runtimeDir:   runtimeDir,
		}

		err := UpdateConfig(&tc.config, options)
		require.NoError(t, err, "%d: %v", i, tc)

		configContent, err := json.MarshalIndent(tc.config, "", "    ")
		require.NoError(t, err)

		expectedContent, err := json.MarshalIndent(tc.expectedConfig, "", "    ")
		require.NoError(t, err)

		require.EqualValues(t, string(expectedContent), string(configContent), "%d: %v", i, tc)
	}
}

func TestRevertConfig(t *testing.T) {
	testCases := []struct {
		config         docker.Config
		expectedConfig map[string]interface{}
	}{
		{
			config:         map[string]interface{}{},
			expectedConfig: map[string]interface{}{},
		},
		{
			config: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
				},
			},
			expectedConfig: map[string]interface{}{},
		},
		{
			config: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
				},
			},
			expectedConfig: map[string]interface{}{},
		},
		{
			config: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
				},
			},
			expectedConfig: map[string]interface{}{},
		},
		{
			config: map[string]interface{}{
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
					"nvidia-experimental": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.experimental",
						"args": []string{},
					},
					"nvidia-cdi": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.cdi",
						"args": []string{},
					},
					"nvidia-legacy": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime.legacy",
						"args": []string{},
					},
				},
			},
			expectedConfig: map[string]interface{}{},
		},
		{
			config: map[string]interface{}{
				"default-runtime": "nvidia",
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
				},
			},
			expectedConfig: map[string]interface{}{
				"default-runtime": "runc",
			},
		},
		{
			config: map[string]interface{}{
				"default-runtime": "not-nvidia",
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
				},
			},
			expectedConfig: map[string]interface{}{
				"default-runtime": "not-nvidia",
			},
		},
		{
			config: map[string]interface{}{
				"exec-opts":  []string{"native.cgroupdriver=systemd"},
				"log-driver": "json-file",
				"log-opts": map[string]string{
					"max-size": "100m",
				},
				"storage-driver": "overlay2",
				"runtimes": map[string]interface{}{
					"nvidia": map[string]interface{}{
						"path": "/test/runtime/dir/nvidia-container-runtime",
						"args": []string{},
					},
				},
			},
			expectedConfig: map[string]interface{}{
				"exec-opts":  []string{"native.cgroupdriver=systemd"},
				"log-driver": "json-file",
				"log-opts": map[string]string{
					"max-size": "100m",
				},
				"storage-driver": "overlay2",
			},
		},
	}

	for i, tc := range testCases {
		err := RevertConfig(&tc.config, &options{})

		require.NoError(t, err, "%d: %v", i, tc)

		configContent, err := json.MarshalIndent(tc.config, "", "    ")
		require.NoError(t, err)

		expectedContent, err := json.MarshalIndent(tc.expectedConfig, "", "    ")
		require.NoError(t, err)

		require.EqualValues(t, string(expectedContent), string(configContent), "%d: %v", i, tc)
	}
}