cmd, pkg/podman: Turn Image into an interface

In reaction to the conversation in PR containers#1707, I made suggested changes
to the implementation in terms of how Image information, received
from Podman, is represented and treated in the Toolbx code. I used
the same procedure as in the case of representing Containers:
 - Commit e611969
 - Commit ec7eb59

In short, the JSON from 'podman inspect --type image' and
'podman images' are different, so logically, there should be
different implementations of the JSON.Unmarshaler interface [1]
for them as well. The new Image interface provides access to the
values ​​parsed from the JSONs and two different concrete types,
which are implemented separately to handle the differences in
the JSONs.

GetImages() now returns an Images iterator-like structure that
handles image flattening and sorting internally. InspectImage()
returns an Image interface instead of map[string]interface{},
and the IsToolboxImage() function was replaced with the IsToolbx()
method on the Image interface.

[1] https://pkg.go.dev/encoding/json#Unmarshaler

Signed-off-by: Dalibor Kricka <[email protected]>

Author: DaliborKr

src/cmd/completion.go

@@ -132,11 +132,11 @@ func completionImageNames(cmd *cobra.Command, _ []string, _ string) ([]string, c
 	var imageNames []string
 	if images, err := getImages(true); err == nil {
 		for _, image := range images {
-			if len(image.Names) != 1 {
+			if len(image.Names()) != 1 {
 				panic("cannot complete unflattened Image")
 			}
 
-			imageNames = append(imageNames, image.Names[0])
+			imageNames = append(imageNames, image.Names()[0])
 		}
 	}
 
@@ -149,12 +149,12 @@ func completionImageNamesFiltered(_ *cobra.Command, args []string, _ string) ([]
 		for _, image := range images {
 			skip := false
 
-			if len(image.Names) != 1 {
+			if len(image.Names()) != 1 {
 				panic("cannot complete unflattened Image")
 			}
 
 			for _, arg := range args {
-				if arg == image.Names[0] {
+				if arg == image.Names()[0] {
 					skip = true
 					break
 				}
@@ -164,7 +164,7 @@ func completionImageNamesFiltered(_ *cobra.Command, args []string, _ string) ([]
 				continue
 			}
 
-			imageNames = append(imageNames, image.Names[0])
+			imageNames = append(imageNames, image.Names()[0])
 		}
 	}
 

src/cmd/list.go

@@ -20,7 +20,6 @@ import (
 	"errors"
 	"fmt"
 	"os"
-	"sort"
 	"text/tabwriter"
 
 	"github.com/containers/toolbox/pkg/podman"
@@ -35,12 +34,6 @@ var (
 		onlyContainers bool
 		onlyImages     bool
 	}
-
-	// toolboxLabels holds labels used by containers/images that mark them as compatible with Toolbx
-	toolboxLabels = map[string]string{
-		"com.github.debarshiray.toolbox": "true",
-		"com.github.containers.toolbox":  "true",
-	}
 )
 
 var listCmd = &cobra.Command{
@@ -154,38 +147,20 @@ func listHelp(cmd *cobra.Command, args []string) {
 func getImages(fillNameWithID bool) ([]podman.Image, error) {
 	logrus.Debug("Fetching all images")
 	var args []string
-	images, err := podman.GetImages(args...)
+	images, err := podman.GetImages(fillNameWithID, true, args...)
 	if err != nil {
 		logrus.Debugf("Fetching all images failed: %s", err)
 		return nil, errors.New("failed to get images")
 	}
 
-	processed := make(map[string]struct{})
 	var toolboxImages []podman.Image
 
-	for _, image := range images {
-		if _, ok := processed[image.ID]; ok {
-			continue
+	for images.Next() {
+		if image := images.Get(); image.IsToolbx() {
+			toolboxImages = append(toolboxImages, image)
 		}
-
-		processed[image.ID] = struct{}{}
-		var isToolboxImage bool
-
-		for label := range toolboxLabels {
-			if _, ok := image.Labels[label]; ok {
-				isToolboxImage = true
-				break
-			}
-		}
-
-		if isToolboxImage {
-			flattenedImages := image.FlattenNames(fillNameWithID)
-			toolboxImages = append(toolboxImages, flattenedImages...)
-		}
-
 	}
 
-	sort.Sort(podman.ImageSlice(toolboxImages))
 	return toolboxImages, nil
 }
 
@@ -195,14 +170,14 @@ func listOutput(images []podman.Image, containers []podman.Container) {
 		fmt.Fprintf(writer, "%s\t%s\t%s\n", "IMAGE ID", "IMAGE NAME", "CREATED")
 
 		for _, image := range images {
-			if len(image.Names) != 1 {
+			if len(image.Names()) != 1 {
 				panic("cannot list unflattened Image")
 			}
 
 			fmt.Fprintf(writer, "%s\t%s\t%s\n",
-				utils.ShortID(image.ID),
-				image.Names[0],
-				image.Created)
+				utils.ShortID(image.ID()),
+				image.Names()[0],
+				image.Created())
 		}
 
 		writer.Flush()

src/cmd/rmi.go

@@ -73,7 +73,7 @@ func rmi(cmd *cobra.Command, args []string) error {
 		}
 
 		for _, image := range toolboxImages {
-			imageID := image.ID
+			imageID := image.ID()
 			if err := podman.RemoveImage(imageID, rmiFlags.forceDelete); err != nil {
 				fmt.Fprintf(os.Stderr, "Error: %s\n", err)
 				continue
@@ -90,8 +90,14 @@ func rmi(cmd *cobra.Command, args []string) error {
 		}
 
 		for _, image := range args {
-			if _, err := podman.IsToolboxImage(image); err != nil {
-				fmt.Fprintf(os.Stderr, "Error: %s\n", err)
+			imageObj, err := podman.InspectImage(image)
+			if err != nil {
+				fmt.Fprintf(os.Stderr, "Error: failed to inspect image %s\n", image)
+				continue
+			}
+
+			if !imageObj.IsToolbx() {
+				fmt.Fprintf(os.Stderr, "Error: %s is not a Toolbx image\n", image)
 				continue
 			}
 

src/meson.build

@@ -23,6 +23,7 @@ sources = files(
   'pkg/nvidia/nvidia.go',
   'pkg/podman/container.go',
   'pkg/podman/errors.go',
+  'pkg/podman/image.go',
   'pkg/podman/podman.go',
   'pkg/podman/containerInspect_test.go',
   'pkg/shell/shell.go',