container: deprecate ErrNameReserved, ErrNameNotReserved

thaJeztah · thaJeztah · commit 3cf90ca73f9d · 2024-10-15T12:32:26.000+02:00
Use errdefs definitions instead.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/container/view.go b/container/view.go
@@ -30,8 +30,12 @@ const (
 
 var (
 	// ErrNameReserved is an error which is returned when a name is requested to be reserved that already is reserved
+	//
+	// Deprecated: check for [errdefs.Conflict] errors instead (using [errdefs.IsConflict].
 	ErrNameReserved = errors.New("name is reserved")
 	// ErrNameNotReserved is an error which is returned when trying to find a name that is not reserved
+	//
+	// Deprecated: check for [errdefs.NotFound] errors instead (using [errdefs.IsNotFound].
 	ErrNameNotReserved = errors.New("name is not reserved")
 )
 
@@ -195,7 +199,7 @@ func (db *ViewDB) ReserveName(name, containerID string) error {
 		}
 		if s != nil {
 			if s.(nameAssociation).containerID != containerID {
-				return errdefs.Conflict(ErrNameReserved)
+				return errdefs.Conflict(ErrNameReserved) //nolint:staticcheck  // ignore SA1019: ErrNameReserved is deprecated.
 			}
 			return nil
 		}
@@ -274,7 +278,7 @@ func (v *View) GetID(name string) (string, error) {
 		return "", errdefs.System(err)
 	}
 	if s == nil {
-		return "", errdefs.NotFound(ErrNameNotReserved)
+		return "", errdefs.NotFound(ErrNameNotReserved) //nolint:staticcheck  // ignore SA1019: ErrNameNotReserved is deprecated.
 	}
 	return s.(nameAssociation).containerID, nil
 }
diff --git a/container/view_test.go b/container/view_test.go
@@ -118,7 +118,7 @@ func TestNames(t *testing.T) {
 
 	err = db.ReserveName("name2", "containerid3")
 	assert.Check(t, is.ErrorType(err, errdefs.IsConflict))
-	assert.Check(t, is.ErrorIs(err, ErrNameReserved))
+	assert.Check(t, is.ErrorIs(err, ErrNameReserved)) //nolint:staticcheck  // ignore SA1019: ErrNameReserved is deprecated.
 
 	// Releasing a name allows the name to point to something else later.
 	assert.Check(t, db.ReleaseName("name2"))
@@ -136,7 +136,7 @@ func TestNames(t *testing.T) {
 
 	_, err = view.GetID("notreserved")
 	assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
-	assert.Check(t, is.ErrorIs(err, ErrNameNotReserved))
+	assert.Check(t, is.ErrorIs(err, ErrNameNotReserved)) //nolint:staticcheck  // ignore SA1019: ErrNameNotReserved is deprecated.
 
 	// Releasing and re-reserving a name doesn't affect the snapshot.
 	assert.Check(t, db.ReleaseName("name2"))
diff --git a/daemon/daemon.go b/daemon/daemon.go
@@ -761,7 +761,7 @@ func (daemon *Daemon) parents(c *container.Container) map[string]*container.Cont
 func (daemon *Daemon) registerLink(parent, child *container.Container, alias string) error {
 	fullName := path.Join(parent.Name, alias)
 	if err := daemon.containersReplica.ReserveName(fullName, child.ID); err != nil {
-		if errors.Is(err, container.ErrNameReserved) {
+		if errdefs.IsConflict(err) {
 			log.G(context.TODO()).Warnf("error registering link for %s, to %s, as alias %s, ignoring: %v", parent.ID, child.ID, alias, err)
 			return nil
 		}
diff --git a/daemon/names.go b/daemon/names.go
@@ -66,7 +66,7 @@ func (daemon *Daemon) reserveName(id, name string) (string, error) {
 	}
 
 	if err := daemon.containersReplica.ReserveName(name, id); err != nil {
-		if errors.Is(err, container.ErrNameReserved) {
+		if errdefs.IsConflict(err) {
 			id, err := daemon.containersReplica.Snapshot().GetID(name)
 			if err != nil {
 				log.G(context.TODO()).Errorf("got unexpected error while looking up reserved name: %v", err)
@@ -92,7 +92,7 @@ func (daemon *Daemon) generateAndReserveName(id string) (string, error) {
 		}
 
 		if err := daemon.containersReplica.ReserveName(name, id); err != nil {
-			if errors.Is(err, container.ErrNameReserved) {
+			if errdefs.IsConflict(err) {
 				continue
 			}
 			return "", err

Original file line number	Diff line number	Diff line change
`@@ -30,8 +30,12 @@ const (`
`30`	`30`
`31`	`31`	`var (`
`32`	`32`	`// ErrNameReserved is an error which is returned when a name is requested to be reserved that already is reserved`
	`33`	`+ //`
	`34`	`+ // Deprecated: check for [errdefs.Conflict] errors instead (using [errdefs.IsConflict].`
`33`	`35`	`ErrNameReserved = errors.New("name is reserved")`
`34`	`36`	`// ErrNameNotReserved is an error which is returned when trying to find a name that is not reserved`
	`37`	`+ //`
	`38`	`+ // Deprecated: check for [errdefs.NotFound] errors instead (using [errdefs.IsNotFound].`
`35`	`39`	`ErrNameNotReserved = errors.New("name is not reserved")`
`36`	`40`	`)`
`37`	`41`
`@@ -195,7 +199,7 @@ func (db *ViewDB) ReserveName(name, containerID string) error {`
`195`	`199`	`}`
`196`	`200`	`if s != nil {`
`197`	`201`	`if s.(nameAssociation).containerID != containerID {`
`198`		`- return errdefs.Conflict(ErrNameReserved)`
	`202`	`+ return errdefs.Conflict(ErrNameReserved) //nolint:staticcheck // ignore SA1019: ErrNameReserved is deprecated.`
`199`	`203`	`}`
`200`	`204`	`return nil`
`201`	`205`	`}`
`@@ -274,7 +278,7 @@ func (v *View) GetID(name string) (string, error) {`
`274`	`278`	`return "", errdefs.System(err)`
`275`	`279`	`}`
`276`	`280`	`if s == nil {`
`277`		`- return "", errdefs.NotFound(ErrNameNotReserved)`
	`281`	`+ return "", errdefs.NotFound(ErrNameNotReserved) //nolint:staticcheck // ignore SA1019: ErrNameNotReserved is deprecated.`
`278`	`282`	`}`
`279`	`283`	`return s.(nameAssociation).containerID, nil`
`280`	`284`	`}`
Original file line number	Diff line number	Diff line change
`@@ -761,7 +761,7 @@ func (daemon Daemon) parents(c container.Container) map[string]*container.Cont`
`761`	`761`	`func (daemon Daemon) registerLink(parent, child container.Container, alias string) error {`
`762`	`762`	`fullName := path.Join(parent.Name, alias)`
`763`	`763`	`if err := daemon.containersReplica.ReserveName(fullName, child.ID); err != nil {`
`764`		`- if errors.Is(err, container.ErrNameReserved) {`
	`764`	`+ if errdefs.IsConflict(err) {`
`765`	`765`	`log.G(context.TODO()).Warnf("error registering link for %s, to %s, as alias %s, ignoring: %v", parent.ID, child.ID, alias, err)`
`766`	`766`	`return nil`
`767`	`767`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ func (daemon *Daemon) reserveName(id, name string) (string, error) {`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`if err := daemon.containersReplica.ReserveName(name, id); err != nil {`
`69`		`- if errors.Is(err, container.ErrNameReserved) {`
	`69`	`+ if errdefs.IsConflict(err) {`
`70`	`70`	`id, err := daemon.containersReplica.Snapshot().GetID(name)`
`71`	`71`	`if err != nil {`
`72`	`72`	`log.G(context.TODO()).Errorf("got unexpected error while looking up reserved name: %v", err)`
`@@ -92,7 +92,7 @@ func (daemon *Daemon) generateAndReserveName(id string) (string, error) {`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`if err := daemon.containersReplica.ReserveName(name, id); err != nil {`
`95`		`- if errors.Is(err, container.ErrNameReserved) {`
	`95`	`+ if errdefs.IsConflict(err) {`
`96`	`96`	`continue`
`97`	`97`	`}`
`98`	`98`	`return "", err`