Merge pull request #7152 from dcantah/fix-err-comments-cri

estesp · web-flow · commit ff91434af1b9 · 2022-07-12T10:46:49.000-04:00
Fix out of date comments for CRI store packages
diff --git a/pkg/cri/server/helpers.go b/pkg/cri/server/helpers.go
@@ -162,7 +162,7 @@ func getRepoDigestAndTag(namedRef docker.Named, digest imagedigest.Digest, schem
 }
 
 // localResolve resolves image reference locally and returns corresponding image metadata. It
-// returns store.ErrNotExist if the reference doesn't exist.
+// returns errdefs.ErrNotFound if the reference doesn't exist.
 func (c *criService) localResolve(refOrID string) (imagestore.Image, error) {
 	getImageID := func(refOrId string) string {
 		if _, err := imagedigest.Parse(refOrID); err == nil {
diff --git a/pkg/cri/store/container/container.go b/pkg/cri/store/container/container.go
@@ -122,7 +122,7 @@ func NewStore(labels *label.Store) *Store {
 	}
 }
 
-// Add a container into the store. Returns store.ErrAlreadyExist if the
+// Add a container into the store. Returns errdefs.ErrAlreadyExists if the
 // container already exists.
 func (s *Store) Add(c Container) error {
 	s.lock.Lock()
@@ -140,7 +140,7 @@ func (s *Store) Add(c Container) error {
 	return nil
 }
 
-// Get returns the container with specified id. Returns store.ErrNotExist
+// Get returns the container with specified id. Returns errdefs.ErrNotFound
 // if the container doesn't exist.
 func (s *Store) Get(id string) (Container, error) {
 	s.lock.RLock()
@@ -169,6 +169,9 @@ func (s *Store) List() []Container {
 	return containers
 }
 
+// UpdateContainerStats updates the container specified by ID with the
+// stats present in 'newContainerStats'. Returns errdefs.ErrNotFound
+// if the container does not exist in the store.
 func (s *Store) UpdateContainerStats(id string, newContainerStats *stats.ContainerStats) error {
 	s.lock.Lock()
 	defer s.lock.Unlock()
diff --git a/pkg/cri/store/image/image.go b/pkg/cri/store/image/image.go
@@ -161,7 +161,7 @@ func (s *Store) Resolve(ref string) (string, error) {
 
 // Get gets image metadata by image id. The id can be truncated.
 // Returns various validation errors if the image id is invalid.
-// Returns storeutil.ErrNotExist if the image doesn't exist.
+// Returns errdefs.ErrNotFound if the image doesn't exist.
 func (s *Store) Get(id string) (Image, error) {
 	return s.store.get(id)
 }
diff --git a/pkg/cri/store/sandbox/sandbox.go b/pkg/cri/store/sandbox/sandbox.go
@@ -78,7 +78,8 @@ func NewStore(labels *label.Store) *Store {
 	}
 }
 
-// Add a sandbox into the store.
+// Add a sandbox into the store. Returns errdefs.ErrAlreadyExists if the sandbox is
+// already stored.
 func (s *Store) Add(sb Sandbox) error {
 	s.lock.Lock()
 	defer s.lock.Unlock()
@@ -96,7 +97,7 @@ func (s *Store) Add(sb Sandbox) error {
 }
 
 // Get returns the sandbox with specified id.
-// Returns store.ErrNotExist if the sandbox doesn't exist.
+// Returns errdefs.ErrNotFound if the sandbox doesn't exist.
 func (s *Store) Get(id string) (Sandbox, error) {
 	s.lock.RLock()
 	defer s.lock.RUnlock()
@@ -124,6 +125,9 @@ func (s *Store) List() []Sandbox {
 	return sandboxes
 }
 
+// UpdateContainerStats updates the sandbox specified by ID with the
+// stats present in 'newContainerStats'. Returns errdefs.ErrNotFound
+// if the sandbox does not exist in the store.
 func (s *Store) UpdateContainerStats(id string, newContainerStats *stats.ContainerStats) error {
 	s.lock.RLock()
 	defer s.lock.RUnlock()
diff --git a/pkg/cri/store/snapshot/snapshot.go b/pkg/cri/store/snapshot/snapshot.go
@@ -56,7 +56,7 @@ func (s *Store) Add(snapshot Snapshot) {
 	s.snapshots[snapshot.Key] = snapshot
 }
 
-// Get returns the snapshot with specified key. Returns store.ErrNotExist if the
+// Get returns the snapshot with specified key. Returns errdefs.ErrNotFound if the
 // snapshot doesn't exist.
 func (s *Store) Get(key string) (Snapshot, error) {
 	s.lock.RLock()

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ func getRepoDigestAndTag(namedRef docker.Named, digest imagedigest.Digest, schem`
`162`	`162`	`}`
`163`	`163`
`164`	`164`	`// localResolve resolves image reference locally and returns corresponding image metadata. It`
`165`		`-// returns store.ErrNotExist if the reference doesn't exist.`
	`165`	`+// returns errdefs.ErrNotFound if the reference doesn't exist.`
`166`	`166`	`func (c *criService) localResolve(refOrID string) (imagestore.Image, error) {`
`167`	`167`	`getImageID := func(refOrId string) string {`
`168`	`168`	`if _, err := imagedigest.Parse(refOrID); err == nil {`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ func NewStore(labels label.Store) Store {`
`122`	`122`	`}`
`123`	`123`	`}`
`124`	`124`
`125`		`-// Add a container into the store. Returns store.ErrAlreadyExist if the`
	`125`	`+// Add a container into the store. Returns errdefs.ErrAlreadyExists if the`
`126`	`126`	`// container already exists.`
`127`	`127`	`func (s *Store) Add(c Container) error {`
`128`	`128`	`s.lock.Lock()`
`@@ -140,7 +140,7 @@ func (s *Store) Add(c Container) error {`
`140`	`140`	`return nil`
`141`	`141`	`}`
`142`	`142`
`143`		`-// Get returns the container with specified id. Returns store.ErrNotExist`
	`143`	`+// Get returns the container with specified id. Returns errdefs.ErrNotFound`
`144`	`144`	`// if the container doesn't exist.`
`145`	`145`	`func (s *Store) Get(id string) (Container, error) {`
`146`	`146`	`s.lock.RLock()`
`@@ -169,6 +169,9 @@ func (s *Store) List() []Container {`
`169`	`169`	`return containers`
`170`	`170`	`}`
`171`	`171`
	`172`	`+// UpdateContainerStats updates the container specified by ID with the`
	`173`	`+// stats present in 'newContainerStats'. Returns errdefs.ErrNotFound`
	`174`	`+// if the container does not exist in the store.`
`172`	`175`	`func (s Store) UpdateContainerStats(id string, newContainerStats stats.ContainerStats) error {`
`173`	`176`	`s.lock.Lock()`
`174`	`177`	`defer s.lock.Unlock()`
Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ func (s *Store) Resolve(ref string) (string, error) {`
`161`	`161`
`162`	`162`	`// Get gets image metadata by image id. The id can be truncated.`
`163`	`163`	`// Returns various validation errors if the image id is invalid.`
`164`		`-// Returns storeutil.ErrNotExist if the image doesn't exist.`
	`164`	`+// Returns errdefs.ErrNotFound if the image doesn't exist.`
`165`	`165`	`func (s *Store) Get(id string) (Image, error) {`
`166`	`166`	`return s.store.get(id)`
`167`	`167`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,8 @@ func NewStore(labels label.Store) Store {`
`78`	`78`	`}`
`79`	`79`	`}`
`80`	`80`
`81`		`-// Add a sandbox into the store.`
	`81`	`+// Add a sandbox into the store. Returns errdefs.ErrAlreadyExists if the sandbox is`
	`82`	`+// already stored.`
`82`	`83`	`func (s *Store) Add(sb Sandbox) error {`
`83`	`84`	`s.lock.Lock()`
`84`	`85`	`defer s.lock.Unlock()`
`@@ -96,7 +97,7 @@ func (s *Store) Add(sb Sandbox) error {`
`96`	`97`	`}`
`97`	`98`
`98`	`99`	`// Get returns the sandbox with specified id.`
`99`		`-// Returns store.ErrNotExist if the sandbox doesn't exist.`
	`100`	`+// Returns errdefs.ErrNotFound if the sandbox doesn't exist.`
`100`	`101`	`func (s *Store) Get(id string) (Sandbox, error) {`
`101`	`102`	`s.lock.RLock()`
`102`	`103`	`defer s.lock.RUnlock()`
`@@ -124,6 +125,9 @@ func (s *Store) List() []Sandbox {`
`124`	`125`	`return sandboxes`
`125`	`126`	`}`
`126`	`127`
	`128`	`+// UpdateContainerStats updates the sandbox specified by ID with the`
	`129`	`+// stats present in 'newContainerStats'. Returns errdefs.ErrNotFound`
	`130`	`+// if the sandbox does not exist in the store.`
`127`	`131`	`func (s Store) UpdateContainerStats(id string, newContainerStats stats.ContainerStats) error {`
`128`	`132`	`s.lock.RLock()`
`129`	`133`	`defer s.lock.RUnlock()`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ func (s *Store) Add(snapshot Snapshot) {`
`56`	`56`	`s.snapshots[snapshot.Key] = snapshot`
`57`	`57`	`}`
`58`	`58`
`59`		`-// Get returns the snapshot with specified key. Returns store.ErrNotExist if the`
	`59`	`+// Get returns the snapshot with specified key. Returns errdefs.ErrNotFound if the`
`60`	`60`	`// snapshot doesn't exist.`
`61`	`61`	`func (s *Store) Get(key string) (Snapshot, error) {`
`62`	`62`	`s.lock.RLock()`