fix podman pod inspect to support multiple pods

Just like the other inspect commands `podman pod inspect p1 p2` should
return the json for both.

To correctly implement this we follow the container inspect logic, this
allows use to reuse the global inspect command.
Note: To not break the existing single pod output format for podman pod
inspect I added a pod-legacy inspect type. This is only used to make
sure we will print the pod as single json and not an array like for the
other commands. We cannot use the pod type since podman inspect --type
pod did return an array and we should not break that as well.

Fixes #15674

Signed-off-by: Paul Holzinger <pholzing@redhat.com>

4 files changed, 63 insertions, 33 deletions

diff --git a/pkg/domain/entities/engine_container.go b/pkg/domain/entities/engine_container.go
index 69adc9732..19b666f8e 100644
--- a/pkg/domain/entities/engine_container.go
+++ b/pkg/domain/entities/engine_container.go
@@ -75,7 +75,7 @@ type ContainerEngine interface {
 	PodCreate(ctx context.Context, specg PodSpec) (*PodCreateReport, error)
 	PodClone(ctx context.Context, podClone PodCloneOptions) (*PodCloneReport, error)
 	PodExists(ctx context.Context, nameOrID string) (*BoolReport, error)
-	PodInspect(ctx context.Context, options PodInspectOptions) (*PodInspectReport, error)
+	PodInspect(ctx context.Context, namesOrID []string, options InspectOptions) ([]*PodInspectReport, []error, error)
 	PodKill(ctx context.Context, namesOrIds []string, options PodKillOptions) ([]*PodKillReport, error)
 	PodLogs(ctx context.Context, pod string, options PodLogsOptions) error
 	PodPause(ctx context.Context, namesOrIds []string, options PodPauseOptions) ([]*PodPauseReport, error)
diff --git a/pkg/domain/entities/pods.go b/pkg/domain/entities/pods.go
index b672434d8..55e2fd574 100644
--- a/pkg/domain/entities/pods.go
+++ b/pkg/domain/entities/pods.go
@@ -438,15 +438,6 @@ type PodPSOptions struct {
 	Sort      string
 }
 
-type PodInspectOptions struct {
-	Latest bool
-
-	// Options for the API.
-	NameOrID string
-
-	Format string
-}
-
 type PodInspectReport struct {
 	*define.InspectPodData
 }
diff --git a/pkg/domain/infra/abi/pods.go b/pkg/domain/infra/abi/pods.go
index 03c8082c4..68f2fa125 100644
--- a/pkg/domain/infra/abi/pods.go
+++ b/pkg/domain/infra/abi/pods.go
@@ -505,23 +505,49 @@ func (ic *ContainerEngine) PodPs(ctx context.Context, options entities.PodPSOpti
 	return reports, nil
 }
 
-func (ic *ContainerEngine) PodInspect(ctx context.Context, options entities.PodInspectOptions) (*entities.PodInspectReport, error) {
-	var (
-		pod *libpod.Pod
-		err error
-	)
-	// Look up the pod.
+func (ic *ContainerEngine) PodInspect(ctx context.Context, nameOrIDs []string, options entities.InspectOptions) ([]*entities.PodInspectReport, []error, error) {
 	if options.Latest {
-		pod, err = ic.Libpod.GetLatestPod()
-	} else {
-		pod, err = ic.Libpod.LookupPod(options.NameOrID)
-	}
-	if err != nil {
-		return nil, fmt.Errorf("unable to look up requested container: %w", err)
+		pod, err := ic.Libpod.GetLatestPod()
+		if err != nil {
+			return nil, nil, err
+		}
+		inspect, err := pod.Inspect()
+		if err != nil {
+			return nil, nil, err
+		}
+
+		return []*entities.PodInspectReport{
+			{
+				InspectPodData: inspect,
+			},
+		}, nil, nil
 	}
-	inspect, err := pod.Inspect()
-	if err != nil {
-		return nil, err
+
+	var errs []error
+	podReport := make([]*entities.PodInspectReport, 0, len(nameOrIDs))
+	for _, name := range nameOrIDs {
+		pod, err := ic.Libpod.LookupPod(name)
+		if err != nil {
+			// ErrNoSuchPod is non-fatal, other errors will be
+			// treated as fatal.
+			if errors.Is(err, define.ErrNoSuchPod) {
+				errs = append(errs, fmt.Errorf("no such pod %s", name))
+				continue
+			}
+			return nil, nil, err
+		}
+
+		inspect, err := pod.Inspect()
+		if err != nil {
+			// ErrNoSuchPod is non-fatal, other errors will be
+			// treated as fatal.
+			if errors.Is(err, define.ErrNoSuchPod) {
+				errs = append(errs, fmt.Errorf("no such pod %s", name))
+				continue
+			}
+			return nil, nil, err
+		}
+		podReport = append(podReport, &entities.PodInspectReport{InspectPodData: inspect})
 	}
-	return &entities.PodInspectReport{InspectPodData: inspect}, nil
+	return podReport, errs, nil
 }
diff --git a/pkg/domain/infra/tunnel/pods.go b/pkg/domain/infra/tunnel/pods.go
index bcbd32d1b..f9314dcfe 100644
--- a/pkg/domain/infra/tunnel/pods.go
+++ b/pkg/domain/infra/tunnel/pods.go
@@ -3,10 +3,12 @@ package tunnel
 import (
 	"context"
 	"errors"
+	"fmt"
 
 	"github.com/containers/podman/v4/libpod/define"
 	"github.com/containers/podman/v4/pkg/bindings/pods"
 	"github.com/containers/podman/v4/pkg/domain/entities"
+	"github.com/containers/podman/v4/pkg/errorhandling"
 	"github.com/containers/podman/v4/pkg/util"
 )
 
@@ -223,14 +225,25 @@ func (ic *ContainerEngine) PodPs(ctx context.Context, opts entities.PodPSOptions
 	return pods.List(ic.ClientCtx, options)
 }
 
-func (ic *ContainerEngine) PodInspect(ctx context.Context, options entities.PodInspectOptions) (*entities.PodInspectReport, error) {
-	switch {
-	case options.Latest:
-		return nil, errors.New("latest is not supported")
-	case options.NameOrID == "":
-		return nil, errors.New("NameOrID must be specified")
+func (ic *ContainerEngine) PodInspect(ctx context.Context, namesOrIDs []string, options entities.InspectOptions) ([]*entities.PodInspectReport, []error, error) {
+	var errs []error
+	podReport := make([]*entities.PodInspectReport, 0, len(namesOrIDs))
+	for _, name := range namesOrIDs {
+		inspect, err := pods.Inspect(ic.ClientCtx, name, nil)
+		if err != nil {
+			errModel, ok := err.(*errorhandling.ErrorModel)
+			if !ok {
+				return nil, nil, err
+			}
+			if errModel.ResponseCode == 404 {
+				errs = append(errs, fmt.Errorf("no such pod %q", name))
+				continue
+			}
+			return nil, nil, err
+		}
+		podReport = append(podReport, inspect)
 	}
-	return pods.Inspect(ic.ClientCtx, options.NameOrID, nil)
+	return podReport, errs, nil
 }
 
 func (ic *ContainerEngine) PodStats(ctx context.Context, namesOrIds []string, opts entities.PodStatsOptions) ([]*entities.PodStatsReport, error) {