From 715e09fbd4c7ec11e559e3671cd6cf7e7cf4234f Mon Sep 17 00:00:00 2001 From: Evan Lezar Date: Fri, 28 Feb 2025 14:29:52 +0200 Subject: [PATCH] Move CreateLdsoconfdFile to ContainerRoot Since the creation of a .conf file in /etc/ld.so.conf.d is shared by both the update-ldcache and enable-cuda-compat hooks, this is moved to the ContainerRoot type. Signed-off-by: Evan Lezar --- cmd/nvidia-cdi-hook/cudacompat/cudacompat.go | 48 +------------- .../cudacompat/cudacompat_test.go | 44 ------------- .../update-ldcache/update-ldcache.go | 48 +------------- internal/oci/container-root.go | 43 ++++++++++++ internal/oci/container-root_test.go | 66 +++++++++++++++++++ 5 files changed, 111 insertions(+), 138 deletions(-) create mode 100644 internal/oci/container-root_test.go diff --git a/cmd/nvidia-cdi-hook/cudacompat/cudacompat.go b/cmd/nvidia-cdi-hook/cudacompat/cudacompat.go index f149d2bd..bc5cad4e 100644 --- a/cmd/nvidia-cdi-hook/cudacompat/cudacompat.go +++ b/cmd/nvidia-cdi-hook/cudacompat/cudacompat.go @@ -18,7 +18,6 @@ package cudacompat import ( "fmt" - "os" "path/filepath" "strconv" "strings" @@ -116,7 +115,7 @@ func (m command) run(_ *cli.Context, cfg *options) error { return nil } - return m.createLdsoconfdFile(containerRootDirPath, cudaCompatLdsoconfdFilenamePattern, containerForwardCompatDir) + return containerRootDirPath.CreateLdsoconfdFile(cudaCompatLdsoconfdFilenamePattern, containerForwardCompatDir) } // getContainerForwardCompatDirPathInContainer returns the path to the directory containing @@ -175,51 +174,6 @@ func (m command) getContainerForwardCompatDirPathInContainer(containerRootDirPat return resolvedCompatDirPathInContainer, nil } -// createLdsoconfdFile creates a file at /etc/ld.so.conf.d/ in the specified root. -// The file is created at /etc/ld.so.conf.d/{{ .pattern }} using `CreateTemp` and -// contains the specified directories on each line. -func (m command) createLdsoconfdFile(in oci.ContainerRoot, pattern string, dirs ...string) error { - if len(dirs) == 0 { - m.logger.Debugf("No directories to add to /etc/ld.so.conf") - return nil - } - - ldsoconfdDir, err := in.Resolve("/etc/ld.so.conf.d") - if err != nil { - return err - } - if err := os.MkdirAll(ldsoconfdDir, 0755); err != nil { - return fmt.Errorf("failed to create ld.so.conf.d: %w", err) - } - - configFile, err := os.CreateTemp(ldsoconfdDir, pattern) - if err != nil { - return fmt.Errorf("failed to create config file: %w", err) - } - defer configFile.Close() - - m.logger.Debugf("Adding directories %v to %v", dirs, configFile.Name()) - - added := make(map[string]bool) - for _, dir := range dirs { - if added[dir] { - continue - } - _, err = configFile.WriteString(fmt.Sprintf("%s\n", dir)) - if err != nil { - return fmt.Errorf("failed to update config file: %w", err) - } - added[dir] = true - } - - // The created file needs to be world readable for the cases where the container is run as a non-root user. - if err := configFile.Chmod(0644); err != nil { - return fmt.Errorf("failed to chmod config file: %w", err) - } - - return nil -} - // extractMajorVersion parses a version string and returns the major version as an int. func extractMajorVersion(version string) (int, error) { majorString := strings.SplitN(version, ".", 2)[0] diff --git a/cmd/nvidia-cdi-hook/cudacompat/cudacompat_test.go b/cmd/nvidia-cdi-hook/cudacompat/cudacompat_test.go index a795a3d5..1916ac73 100644 --- a/cmd/nvidia-cdi-hook/cudacompat/cudacompat_test.go +++ b/cmd/nvidia-cdi-hook/cudacompat/cudacompat_test.go @@ -138,47 +138,3 @@ func TestCompatLibs(t *testing.T) { }) } } - -func TestUpdateLdconfig(t *testing.T) { - logger, _ := testlog.NewNullLogger() - testCases := []struct { - description string - folders []string - expectedContents string - }{ - { - description: "no folders; have no contents", - }, - { - description: "single folder is added", - folders: []string{"/usr/local/cuda/compat"}, - expectedContents: "/usr/local/cuda/compat\n", - }, - } - - for _, tc := range testCases { - t.Run(tc.description, func(t *testing.T) { - containerRootDir := t.TempDir() - c := command{ - logger: logger, - } - err := c.createLdsoconfdFile(oci.ContainerRoot(containerRootDir), cudaCompatLdsoconfdFilenamePattern, tc.folders...) - require.NoError(t, err) - - matches, err := filepath.Glob(filepath.Join(containerRootDir, "/etc/ld.so.conf.d/00-compat-*.conf")) - require.NoError(t, err) - - if tc.expectedContents == "" { - require.Empty(t, matches) - return - } - - require.Len(t, matches, 1) - contents, err := os.ReadFile(matches[0]) - require.NoError(t, err) - - require.EqualValues(t, tc.expectedContents, string(contents)) - }) - } - -} diff --git a/cmd/nvidia-cdi-hook/update-ldcache/update-ldcache.go b/cmd/nvidia-cdi-hook/update-ldcache/update-ldcache.go index c39d8cba..df0bd6c6 100644 --- a/cmd/nvidia-cdi-hook/update-ldcache/update-ldcache.go +++ b/cmd/nvidia-cdi-hook/update-ldcache/update-ldcache.go @@ -19,7 +19,6 @@ package ldcache import ( "errors" "fmt" - "os" "path/filepath" "strings" @@ -134,7 +133,7 @@ func (m command) run(c *cli.Context, cfg *options) error { folders := cfg.folders.Value() if containerRootDirPath.HasPath("/etc/ld.so.conf.d") { - err := m.createLdsoconfdFile(containerRootDirPath, ldsoconfdFilenamePattern, folders...) + err := containerRootDirPath.CreateLdsoconfdFile(ldsoconfdFilenamePattern, folders...) if err != nil { return fmt.Errorf("failed to update ld.so.conf.d: %v", err) } @@ -151,48 +150,3 @@ func (m command) run(c *cli.Context, cfg *options) error { func (m command) resolveLDConfigPath(path string) string { return strings.TrimPrefix(config.NormalizeLDConfigPath("@"+path), "@") } - -// createLdsoconfdFile creates a file at /etc/ld.so.conf.d/ in the specified root. -// The file is created at /etc/ld.so.conf.d/{{ .pattern }} using `CreateTemp` and -// contains the specified directories on each line. -func (m command) createLdsoconfdFile(in oci.ContainerRoot, pattern string, dirs ...string) error { - if len(dirs) == 0 { - m.logger.Debugf("No directories to add to /etc/ld.so.conf") - return nil - } - - ldsoconfdDir, err := in.Resolve("/etc/ld.so.conf.d") - if err != nil { - return err - } - if err := os.MkdirAll(ldsoconfdDir, 0755); err != nil { - return fmt.Errorf("failed to create ld.so.conf.d: %w", err) - } - - configFile, err := os.CreateTemp(ldsoconfdDir, pattern) - if err != nil { - return fmt.Errorf("failed to create config file: %w", err) - } - defer configFile.Close() - - m.logger.Debugf("Adding directories %v to %v", dirs, configFile.Name()) - - added := make(map[string]bool) - for _, dir := range dirs { - if added[dir] { - continue - } - _, err = configFile.WriteString(fmt.Sprintf("%s\n", dir)) - if err != nil { - return fmt.Errorf("failed to update config file: %w", err) - } - added[dir] = true - } - - // The created file needs to be world readable for the cases where the container is run as a non-root user. - if err := configFile.Chmod(0644); err != nil { - return fmt.Errorf("failed to chmod config file: %w", err) - } - - return nil -} diff --git a/internal/oci/container-root.go b/internal/oci/container-root.go index 2613fab5..ef2f9db7 100644 --- a/internal/oci/container-root.go +++ b/internal/oci/container-root.go @@ -18,6 +18,7 @@ package oci import ( + "fmt" "os" "path/filepath" "strings" @@ -28,6 +29,48 @@ import ( // A ContainerRoot represents the root directory of a container's filesystem. type ContainerRoot string +// CreateLdsoconfdFile creates a file at /etc/ld.so.conf.d/ in the specified container root. +// The file is created at /etc/ld.so.conf.d/{{ .pattern }} using `CreateTemp` and +// contains the specified directories on each line. +func (r ContainerRoot) CreateLdsoconfdFile(pattern string, dirs ...string) error { + if len(dirs) == 0 { + return nil + } + + ldsoconfdDir, err := r.Resolve("/etc/ld.so.conf.d") + if err != nil { + return err + } + if err := os.MkdirAll(ldsoconfdDir, 0755); err != nil { + return fmt.Errorf("failed to create ld.so.conf.d: %w", err) + } + + configFile, err := os.CreateTemp(ldsoconfdDir, pattern) + if err != nil { + return fmt.Errorf("failed to create config file: %w", err) + } + defer configFile.Close() + + added := make(map[string]bool) + for _, dir := range dirs { + if added[dir] { + continue + } + _, err = configFile.WriteString(fmt.Sprintf("%s\n", dir)) + if err != nil { + return fmt.Errorf("failed to update config file: %w", err) + } + added[dir] = true + } + + // The created file needs to be world readable for the cases where the container is run as a non-root user. + if err := configFile.Chmod(0644); err != nil { + return fmt.Errorf("failed to chmod config file: %w", err) + } + + return nil +} + // GlobFiles matches the specified pattern in the container root. // The files that match must be regular files. Symlinks and directories are ignored. func (r ContainerRoot) GlobFiles(pattern string) ([]string, error) { diff --git a/internal/oci/container-root_test.go b/internal/oci/container-root_test.go new file mode 100644 index 00000000..93e5453b --- /dev/null +++ b/internal/oci/container-root_test.go @@ -0,0 +1,66 @@ +/** +# Copyright (c) 2025, 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 oci + +import ( + "os" + "path/filepath" + "testing" + + "github.com/stretchr/testify/require" +) + +func TestUpdateLdconfig(t *testing.T) { + testCases := []struct { + description string + folders []string + expectedContents string + }{ + { + description: "no folders; have no contents", + }, + { + description: "single folder is added", + folders: []string{"/usr/local/cuda/compat"}, + expectedContents: "/usr/local/cuda/compat\n", + }, + } + + for _, tc := range testCases { + t.Run(tc.description, func(t *testing.T) { + containerRootDir := t.TempDir() + c := ContainerRoot(containerRootDir) + err := c.CreateLdsoconfdFile("00-test-*.conf", tc.folders...) + require.NoError(t, err) + + matches, err := filepath.Glob(filepath.Join(containerRootDir, "/etc/ld.so.conf.d/00-test-*.conf")) + require.NoError(t, err) + + if tc.expectedContents == "" { + require.Empty(t, matches) + return + } + + require.Len(t, matches, 1) + contents, err := os.ReadFile(matches[0]) + require.NoError(t, err) + + require.EqualValues(t, tc.expectedContents, string(contents)) + }) + } + +}