Merge branch 'lookup-functional-options' into 'main'

Use functional options when creating Symlink and Directory locators

See merge request nvidia/container-toolkit/container-toolkit!452

Author: Evan Lezar

cmd/nvidia-ctk/hook/create-symlinks/create-symlinks.go

@@ -101,7 +101,10 @@ func (m command) run(c *cli.Context, cfg *config) error {
 
 	csvFiles := cfg.filenames.Value()
 
-	chainLocator := lookup.NewSymlinkChainLocator(m.logger, cfg.hostRoot)
+	chainLocator := lookup.NewSymlinkChainLocator(
+		lookup.WithLogger(m.logger),
+		lookup.WithRoot(cfg.hostRoot),
+	)
 
 	var candidates []string
 	for _, file := range csvFiles {

internal/discover/csv.go

@@ -33,10 +33,13 @@ func NewFromCSVFiles(logger logger.Interface, files []string, driverRoot string)
 		return None{}, nil
 	}
 
-	symlinkLocator := lookup.NewSymlinkLocator(logger, driverRoot)
+	symlinkLocator := lookup.NewSymlinkLocator(
+		lookup.WithLogger(logger),
+		lookup.WithRoot(driverRoot),
+	)
 	locators := map[csv.MountSpecType]lookup.Locator{
 		csv.MountSpecDev: lookup.NewCharDeviceLocator(lookup.WithLogger(logger), lookup.WithRoot(driverRoot)),
-		csv.MountSpecDir: lookup.NewDirectoryLocator(logger, driverRoot),
+		csv.MountSpecDir: lookup.NewDirectoryLocator(lookup.WithLogger(logger), lookup.WithRoot(driverRoot)),
 		// Libraries and symlinks are handled in the same way
 		csv.MountSpecLib: symlinkLocator,
 		csv.MountSpecSym: symlinkLocator,

internal/discover/gds.go

@@ -38,7 +38,7 @@ func NewGDSDiscoverer(logger logger.Interface, root string) (Discover, error) {
 
 	udev := NewMounts(
 		logger,
-		lookup.NewDirectoryLocator(logger, root),
+		lookup.NewDirectoryLocator(lookup.WithLogger(logger), lookup.WithRoot(root)),
 		root,
 		[]string{"/run/udev"},
 	)

internal/discover/symlinks.go

@@ -113,7 +113,10 @@ func (d symlinkHook) getSpecificLinks() ([]string, error) {
 }
 
 func (d symlinkHook) getCSVFileSymlinks() []string {
-	chainLocator := lookup.NewSymlinkChainLocator(d.logger, d.driverRoot)
+	chainLocator := lookup.NewSymlinkChainLocator(
+		lookup.WithLogger(d.logger),
+		lookup.WithRoot(d.driverRoot),
+	)
 
 	var candidates []string
 	for _, file := range d.csvFiles {

internal/lookup/dir.go

@@ -19,17 +19,15 @@ package lookup
 import (
 	"fmt"
 	"os"
-
-	"github.com/NVIDIA/nvidia-container-toolkit/internal/logger"
 )
 
-// NewDirectoryLocator creates a Locator that can be used to find directories at the specified root. A logger
-// is also specified.
-func NewDirectoryLocator(logger logger.Interface, root string) Locator {
+// NewDirectoryLocator creates a Locator that can be used to find directories at the specified root.
+func NewDirectoryLocator(opts ...Option) Locator {
 	return NewFileLocator(
-		WithLogger(logger),
-		WithRoot(root),
-		WithFilter(assertDirectory),
+		append(
+			opts,
+			WithFilter(assertDirectory),
+		)...,
 	)
 }
 

internal/lookup/library.go

@@ -41,7 +41,7 @@ func NewLibraryLocator(logger logger.Interface, root string) (Locator, error) {
 
 	l := library{
 		logger:  logger,
-		symlink: NewSymlinkLocator(logger, root),
+		symlink: NewSymlinkLocator(WithLogger(logger), WithRoot(root)),
 		cache:   cache,
 	}
 

internal/lookup/symlinks.go

@@ -20,7 +20,6 @@ import (
 	"fmt"
 	"path/filepath"
 
-	"github.com/NVIDIA/nvidia-container-toolkit/internal/logger"
 	"github.com/NVIDIA/nvidia-container-toolkit/internal/lookup/symlinks"
 )
 
@@ -33,9 +32,8 @@ type symlink struct {
 }
 
 // NewSymlinkChainLocator creats a locator that can be used for locating files through symlinks.
-// A logger can also be specified.
-func NewSymlinkChainLocator(logger logger.Interface, root string) Locator {
-	f := newFileLocator(WithLogger(logger), WithRoot(root))
+func NewSymlinkChainLocator(opts ...Option) Locator {
+	f := newFileLocator(opts...)
 	l := symlinkChain{
 		file: *f,
 	}
@@ -44,9 +42,8 @@ func NewSymlinkChainLocator(logger logger.Interface, root string) Locator {
 }
 
 // NewSymlinkLocator creats a locator that can be used for locating files through symlinks.
-// A logger can also be specified.
-func NewSymlinkLocator(logger logger.Interface, root string) Locator {
-	f := newFileLocator(WithLogger(logger), WithRoot(root))
+func NewSymlinkLocator(opts ...Option) Locator {
+	f := newFileLocator(opts...)
 	l := symlink{
 		file: *f,
 	}