daemon/graphdriver: deprecate GetDriver(), and remove its use

thaJeztah · thaJeztah · commit 84cabde357a7 · 2024-06-27T20:05:44.000+02:00
The exported function was only used in tests, and identical in use when
using New with a name provided. Deprecate it, and remove the uses of it
in our (integration-)tests.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/daemon/graphdriver/driver.go b/daemon/graphdriver/driver.go
@@ -158,7 +158,7 @@ func Register(name string, initFunc InitFunc) error {
 
 // GetDriver initializes and returns the registered driver.
 //
-// It is exported for use in (integration-)tests, but should be considered internal.
+// Deprecated: this function was exported for (integration-)tests, but no longer used, and will be removed in the next release.
 func GetDriver(name string, config Options) (Driver, error) {
 	return getDriver(name, config)
 }
diff --git a/daemon/graphdriver/graphtest/graphtest_unix.go b/daemon/graphdriver/graphtest/graphtest_unix.go
@@ -30,11 +30,16 @@ type Driver struct {
 }
 
 func newDriver(t testing.TB, name string, options []string) *Driver {
+	if name == "" {
+		// Prevent graphdriver.New() from auto-detecting / picking a storage driver.
+		t.Fatal("newDriver requires a name for the storage driver to use")
+	}
+
 	root, err := os.MkdirTemp("", "docker-graphtest-")
 	assert.NilError(t, err)
 
 	assert.NilError(t, os.MkdirAll(root, 0o755))
-	d, err := graphdriver.GetDriver(name, graphdriver.Options{DriverOptions: options, Root: root})
+	d, err := graphdriver.New(name, graphdriver.Options{DriverOptions: options, Root: root})
 	if err != nil {
 		t.Logf("graphdriver: %v\n", err)
 		if graphdriver.IsDriverNotSupported(err) {
diff --git a/daemon/graphdriver/vfs/vfs_test.go b/daemon/graphdriver/vfs/vfs_test.go
@@ -92,7 +92,7 @@ func TestXattrUnsupportedByBackingFS(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			subdir := filepath.Join(rootdir, tt.name)
 			assert.NilError(t, os.Mkdir(subdir, 0o755))
-			d, err := graphdriver.GetDriver("vfs", graphdriver.Options{
+			d, err := graphdriver.New("vfs", graphdriver.Options{
 				DriverOptions: tt.opts,
 				Root:          subdir,
 			})
diff --git a/layer/layer_test.go b/layer/layer_test.go
@@ -26,7 +26,7 @@ func init() {
 }
 
 func newVFSGraphDriver(td string) (graphdriver.Driver, error) {
-	return graphdriver.GetDriver("vfs", graphdriver.Options{
+	return graphdriver.New("vfs", graphdriver.Options{
 		Root: td,
 		IDMap: idtools.IdentityMapping{
 			UIDMaps: []idtools.IDMap{{

Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,7 @@ func Register(name string, initFunc InitFunc) error {`
`158`	`158`
`159`	`159`	`// GetDriver initializes and returns the registered driver.`
`160`	`160`	`//`
`161`		`-// It is exported for use in (integration-)tests, but should be considered internal.`
	`161`	`+// Deprecated: this function was exported for (integration-)tests, but no longer used, and will be removed in the next release.`
`162`	`162`	`func GetDriver(name string, config Options) (Driver, error) {`
`163`	`163`	`return getDriver(name, config)`
`164`	`164`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ func init() {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`func newVFSGraphDriver(td string) (graphdriver.Driver, error) {`
`29`		`- return graphdriver.GetDriver("vfs", graphdriver.Options{`
	`29`	`+ return graphdriver.New("vfs", graphdriver.Options{`
`30`	`30`	`Root: td,`
`31`	`31`	`IDMap: idtools.IdentityMapping{`
`32`	`32`	`UIDMaps: []idtools.IDMap{{`