Rework pruning to report reclaimed space

This change adds code to report the reclaimed space after a prune.
Reclaimed space from volumes, images, and containers is recorded
during the prune call in a PruneReport struct. These structs are
collected into a slice during a system prune and processed afterwards
to calculate the total reclaimed space.

Closes #8658

Signed-off-by: Baron Lenardson <lenardson.baron@gmail.com>

7 files changed, 51 insertions, 24 deletions

diff --git a/pkg/domain/entities/containers.go b/pkg/domain/entities/containers.go
index b8d49d067..05b9b774e 100644
--- a/pkg/domain/entities/containers.go
+++ b/pkg/domain/entities/containers.go
@@ -390,13 +390,6 @@ type ContainerPruneOptions struct {
 	Filters url.Values `json:"filters" schema:"filters"`
 }
 
-// ContainerPruneReport describes the results after pruning the
-// stopped containers.
-type ContainerPruneReport struct {
-	ID  map[string]int64
-	Err map[string]error
-}
-
 // ContainerPortOptions describes the options to obtain
 // port information on containers
 type ContainerPortOptions struct {
diff --git a/pkg/domain/entities/engine_container.go b/pkg/domain/entities/engine_container.go
index 80127ea45..7d38a97f2 100644
--- a/pkg/domain/entities/engine_container.go
+++ b/pkg/domain/entities/engine_container.go
@@ -6,6 +6,7 @@ import (
 
 	"github.com/containers/common/pkg/config"
 	"github.com/containers/podman/v2/libpod/define"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	"github.com/containers/podman/v2/pkg/specgen"
 	"github.com/spf13/cobra"
 )
@@ -35,7 +36,7 @@ type ContainerEngine interface {
 	ContainerMount(ctx context.Context, nameOrIDs []string, options ContainerMountOptions) ([]*ContainerMountReport, error)
 	ContainerPause(ctx context.Context, namesOrIds []string, options PauseUnPauseOptions) ([]*PauseUnpauseReport, error)
 	ContainerPort(ctx context.Context, nameOrID string, options ContainerPortOptions) ([]*ContainerPortReport, error)
-	ContainerPrune(ctx context.Context, options ContainerPruneOptions) (*ContainerPruneReport, error)
+	ContainerPrune(ctx context.Context, options ContainerPruneOptions) ([]*reports.PruneReport, error)
 	ContainerRestart(ctx context.Context, namesOrIds []string, options RestartOptions) ([]*RestartReport, error)
 	ContainerRestore(ctx context.Context, namesOrIds []string, options RestoreOptions) ([]*RestoreReport, error)
 	ContainerRm(ctx context.Context, namesOrIds []string, options RmOptions) ([]*RmReport, error)
@@ -85,6 +86,6 @@ type ContainerEngine interface {
 	VolumeCreate(ctx context.Context, opts VolumeCreateOptions) (*IDOrNameResponse, error)
 	VolumeInspect(ctx context.Context, namesOrIds []string, opts InspectOptions) ([]*VolumeInspectReport, []error, error)
 	VolumeList(ctx context.Context, opts VolumeListOptions) ([]*VolumeListReport, error)
-	VolumePrune(ctx context.Context, options VolumePruneOptions) ([]*VolumePruneReport, error)
+	VolumePrune(ctx context.Context, options VolumePruneOptions) ([]*reports.PruneReport, error)
 	VolumeRm(ctx context.Context, namesOrIds []string, opts VolumeRmOptions) ([]*VolumeRmReport, error)
 }
diff --git a/pkg/domain/entities/engine_image.go b/pkg/domain/entities/engine_image.go
index 7f33d8e9d..26a136f13 100644
--- a/pkg/domain/entities/engine_image.go
+++ b/pkg/domain/entities/engine_image.go
@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/containers/common/pkg/config"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 )
 
 type ImageEngine interface {
@@ -17,7 +18,7 @@ type ImageEngine interface {
 	List(ctx context.Context, opts ImageListOptions) ([]*ImageSummary, error)
 	Load(ctx context.Context, opts ImageLoadOptions) (*ImageLoadReport, error)
 	Mount(ctx context.Context, images []string, options ImageMountOptions) ([]*ImageMountReport, error)
-	Prune(ctx context.Context, opts ImagePruneOptions) (*ImagePruneReport, error)
+	Prune(ctx context.Context, opts ImagePruneOptions) ([]*reports.PruneReport, error)
 	Pull(ctx context.Context, rawImage string, opts ImagePullOptions) (*ImagePullReport, error)
 	Push(ctx context.Context, source string, destination string, opts ImagePushOptions) error
 	Remove(ctx context.Context, images []string, opts ImageRemoveOptions) (*ImageRemoveReport, []error)
diff --git a/pkg/domain/entities/images.go b/pkg/domain/entities/images.go
index 67910a34c..d5f88502a 100644
--- a/pkg/domain/entities/images.go
+++ b/pkg/domain/entities/images.go
@@ -247,11 +247,6 @@ type ImagePruneOptions struct {
 	Filter []string `json:"filter" schema:"filter"`
 }
 
-type ImagePruneReport struct {
-	Report Report
-	Size   int64
-}
-
 type ImageTagOptions struct{}
 type ImageUntagOptions struct{}
 
diff --git a/pkg/domain/entities/reports/prune.go b/pkg/domain/entities/reports/prune.go
new file mode 100644
index 000000000..5494ac3ae
--- /dev/null
+++ b/pkg/domain/entities/reports/prune.go
@@ -0,0 +1,40 @@
+package reports
+
+type PruneReport struct {
+	Id   string //nolint
+	Err  error
+	Size uint64
+}
+
+func PruneReportsIds(r []*PruneReport) []string {
+	ids := make([]string, 0, len(r))
+	for _, v := range r {
+		if v == nil || v.Id == "" {
+			continue
+		}
+		ids = append(ids, v.Id)
+	}
+	return ids
+}
+
+func PruneReportsErrs(r []*PruneReport) []error {
+	errs := make([]error, 0, len(r))
+	for _, v := range r {
+		if v == nil || v.Err == nil {
+			continue
+		}
+		errs = append(errs, v.Err)
+	}
+	return errs
+}
+
+func PruneReportsSize(r []*PruneReport) uint64 {
+	size := uint64(0)
+	for _, v := range r {
+		if v == nil {
+			continue
+		}
+		size = size + v.Size
+	}
+	return size
+}
diff --git a/pkg/domain/entities/system.go b/pkg/domain/entities/system.go
index d5118f6a8..99fa947f0 100644
--- a/pkg/domain/entities/system.go
+++ b/pkg/domain/entities/system.go
@@ -4,6 +4,7 @@ import (
 	"time"
 
 	"github.com/containers/podman/v2/libpod/define"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	"github.com/docker/docker/api/types"
 	"github.com/spf13/cobra"
 )
@@ -24,10 +25,11 @@ type SystemPruneOptions struct {
 
 // SystemPruneReport provides report after system prune is executed.
 type SystemPruneReport struct {
-	PodPruneReport []*PodPruneReport
-	*ContainerPruneReport
-	*ImagePruneReport
-	VolumePruneReport []*VolumePruneReport
+	PodPruneReport        []*PodPruneReport
+	ContainerPruneReports []*reports.PruneReport
+	ImagePruneReports     []*reports.PruneReport
+	VolumePruneReports    []*reports.PruneReport
+	ReclaimedSpace        uint64
 }
 
 // SystemMigrateOptions describes the options needed for the
diff --git a/pkg/domain/entities/volumes.go b/pkg/domain/entities/volumes.go
index e6b29e374..06438f5e9 100644
--- a/pkg/domain/entities/volumes.go
+++ b/pkg/domain/entities/volumes.go
@@ -116,11 +116,6 @@ type VolumePruneOptions struct {
 	Filters url.Values `json:"filters" schema:"filters"`
 }
 
-type VolumePruneReport struct {
-	Err error
-	Id  string //nolint
-}
-
 type VolumeListOptions struct {
 	Filter map[string][]string
 }