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, 26 insertions, 56 deletions

diff --git a/pkg/api/handlers/compat/containers_prune.go b/pkg/api/handlers/compat/containers_prune.go
index a1e35dd97..b3d26b8f4 100644
--- a/pkg/api/handlers/compat/containers_prune.go
+++ b/pkg/api/handlers/compat/containers_prune.go
@@ -5,18 +5,13 @@ import (
 
 	"github.com/containers/podman/v2/libpod"
 	"github.com/containers/podman/v2/pkg/api/handlers/utils"
-	"github.com/containers/podman/v2/pkg/domain/entities"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	"github.com/containers/podman/v2/pkg/domain/filters"
-	"github.com/docker/docker/api/types"
 	"github.com/gorilla/schema"
 	"github.com/pkg/errors"
 )
 
 func PruneContainers(w http.ResponseWriter, r *http.Request) {
-	var (
-		delContainers []string
-		space         int64
-	)
 	runtime := r.Context().Value("runtime").(*libpod.Runtime)
 	decoder := r.Context().Value("decoder").(*schema.Decoder)
 
@@ -49,36 +44,21 @@ func PruneContainers(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	prunedContainers, pruneErrors, err := runtime.PruneContainers(filterFuncs)
+	report, err := runtime.PruneContainers(filterFuncs)
 	if err != nil {
 		utils.InternalServerError(w, err)
 		return
 	}
-	for ctrID, size := range prunedContainers {
-		if pruneErrors[ctrID] == nil {
-			space += size
-			delContainers = append(delContainers, ctrID)
-		}
-	}
-	report := types.ContainersPruneReport{
-		ContainersDeleted: delContainers,
-		SpaceReclaimed:    uint64(space),
-	}
 	utils.WriteResponse(w, http.StatusOK, report)
 }
 
 func PruneContainersHelper(w http.ResponseWriter, r *http.Request, filterFuncs []libpod.ContainerFilter) (
-	*entities.ContainerPruneReport, error) {
+	[]*reports.PruneReport, error) {
 	runtime := r.Context().Value("runtime").(*libpod.Runtime)
-	prunedContainers, pruneErrors, err := runtime.PruneContainers(filterFuncs)
+	reports, err := runtime.PruneContainers(filterFuncs)
 	if err != nil {
 		utils.InternalServerError(w, err)
 		return nil, err
 	}
-
-	report := &entities.ContainerPruneReport{
-		Err: pruneErrors,
-		ID:  prunedContainers,
-	}
-	return report, nil
+	return reports, nil
 }
diff --git a/pkg/api/handlers/compat/images.go b/pkg/api/handlers/compat/images.go
index dc72500e4..9d7503aba 100644
--- a/pkg/api/handlers/compat/images.go
+++ b/pkg/api/handlers/compat/images.go
@@ -99,21 +99,23 @@ func PruneImages(w http.ResponseWriter, r *http.Request) {
 			filters = append(filters, fmt.Sprintf("%s=%s", k, val))
 		}
 	}
-	pruneCids, err := runtime.ImageRuntime().PruneImages(r.Context(), query.All, filters)
+	imagePruneReports, err := runtime.ImageRuntime().PruneImages(r.Context(), query.All, filters)
 	if err != nil {
 		utils.InternalServerError(w, err)
 		return
 	}
-	for _, p := range pruneCids {
+	reclaimedSpace := uint64(0)
+	for _, p := range imagePruneReports {
 		idr = append(idr, types.ImageDeleteResponseItem{
-			Deleted: p,
+			Deleted: p.Id,
 		})
+		reclaimedSpace = reclaimedSpace + p.Size
 	}
 
 	// FIXME/TODO to do this exactly correct, pruneimages needs to return idrs and space-reclaimed, then we are golden
 	ipr := types.ImagesPruneReport{
 		ImagesDeleted:  idr,
-		SpaceReclaimed: 1, // TODO we cannot supply this right now
+		SpaceReclaimed: reclaimedSpace,
 	}
 	utils.WriteResponse(w, http.StatusOK, handlers.ImagesPruneReport{ImagesPruneReport: ipr})
 }
diff --git a/pkg/api/handlers/compat/volumes.go b/pkg/api/handlers/compat/volumes.go
index f49f06b17..1188d8f84 100644
--- a/pkg/api/handlers/compat/volumes.go
+++ b/pkg/api/handlers/compat/volumes.go
@@ -269,9 +269,9 @@ func PruneVolumes(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 	prunedIds := make([]string, 0, len(pruned))
-	for k := range pruned {
+	for _, v := range pruned {
 		// XXX: This drops any pruning per-volume error messages on the floor
-		prunedIds = append(prunedIds, k)
+		prunedIds = append(prunedIds, v.Id)
 	}
 	pruneResponse := docker_api_types.VolumesPruneReport{
 		VolumesDeleted: prunedIds,
diff --git a/pkg/api/handlers/libpod/images.go b/pkg/api/handlers/libpod/images.go
index 0b8712f16..979a8adc4 100644
--- a/pkg/api/handlers/libpod/images.go
+++ b/pkg/api/handlers/libpod/images.go
@@ -156,12 +156,12 @@ func PruneImages(w http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	cids, err := runtime.ImageRuntime().PruneImages(r.Context(), query.All, libpodFilters)
+	imagePruneReports, err := runtime.ImageRuntime().PruneImages(r.Context(), query.All, libpodFilters)
 	if err != nil {
 		utils.Error(w, "Something went wrong.", http.StatusInternalServerError, err)
 		return
 	}
-	utils.WriteResponse(w, http.StatusOK, cids)
+	utils.WriteResponse(w, http.StatusOK, imagePruneReports)
 }
 
 func ExportImage(w http.ResponseWriter, r *http.Request) {
diff --git a/pkg/api/handlers/libpod/system.go b/pkg/api/handlers/libpod/system.go
index b157dfc7b..130e563ae 100644
--- a/pkg/api/handlers/libpod/system.go
+++ b/pkg/api/handlers/libpod/system.go
@@ -38,35 +38,28 @@ func SystemPrune(w http.ResponseWriter, r *http.Request) {
 	systemPruneReport.PodPruneReport = podPruneReport
 
 	// We could parallelize this, should we?
-	containerPruneReport, err := compat.PruneContainersHelper(w, r, nil)
+	containerPruneReports, err := compat.PruneContainersHelper(w, r, nil)
 	if err != nil {
 		utils.InternalServerError(w, err)
 		return
 	}
-	systemPruneReport.ContainerPruneReport = containerPruneReport
+	systemPruneReport.ContainerPruneReports = containerPruneReports
 
-	results, err := runtime.ImageRuntime().PruneImages(r.Context(), query.All, nil)
+	imagePruneReports, err := runtime.ImageRuntime().PruneImages(r.Context(), query.All, nil)
 	if err != nil {
 		utils.InternalServerError(w, err)
 		return
 	}
 
-	report := entities.ImagePruneReport{
-		Report: entities.Report{
-			Id:  results,
-			Err: nil,
-		},
-	}
-
-	systemPruneReport.ImagePruneReport = &report
+	systemPruneReport.ImagePruneReports = imagePruneReports
 
 	if query.Volumes {
-		volumePruneReport, err := pruneVolumesHelper(r)
+		volumePruneReports, err := pruneVolumesHelper(r)
 		if err != nil {
 			utils.InternalServerError(w, err)
 			return
 		}
-		systemPruneReport.VolumePruneReport = volumePruneReport
+		systemPruneReport.VolumePruneReports = volumePruneReports
 	}
 	utils.WriteResponse(w, http.StatusOK, systemPruneReport)
 }
diff --git a/pkg/api/handlers/libpod/volumes.go b/pkg/api/handlers/libpod/volumes.go
index b02a6a8ce..6f9537515 100644
--- a/pkg/api/handlers/libpod/volumes.go
+++ b/pkg/api/handlers/libpod/volumes.go
@@ -9,6 +9,7 @@ import (
 	"github.com/containers/podman/v2/libpod/define"
 	"github.com/containers/podman/v2/pkg/api/handlers/utils"
 	"github.com/containers/podman/v2/pkg/domain/entities"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	"github.com/containers/podman/v2/pkg/domain/filters"
 	"github.com/containers/podman/v2/pkg/domain/infra/abi/parse"
 	"github.com/gorilla/schema"
@@ -178,7 +179,7 @@ func PruneVolumes(w http.ResponseWriter, r *http.Request) {
 	utils.WriteResponse(w, http.StatusOK, reports)
 }
 
-func pruneVolumesHelper(r *http.Request) ([]*entities.VolumePruneReport, error) {
+func pruneVolumesHelper(r *http.Request) ([]*reports.PruneReport, error) {
 	var (
 		runtime = r.Context().Value("runtime").(*libpod.Runtime)
 		decoder = r.Context().Value("decoder").(*schema.Decoder)
@@ -199,17 +200,10 @@ func pruneVolumesHelper(r *http.Request) ([]*entities.VolumePruneReport, error)
 		return nil, err
 	}
 
-	pruned, err := runtime.PruneVolumes(r.Context(), filterFuncs)
+	reports, err := runtime.PruneVolumes(r.Context(), filterFuncs)
 	if err != nil {
 		return nil, err
 	}
-	reports := make([]*entities.VolumePruneReport, 0, len(pruned))
-	for k, v := range pruned {
-		reports = append(reports, &entities.VolumePruneReport{
-			Err: v,
-			Id:  k,
-		})
-	}
 	return reports, nil
 }
 func RemoveVolume(w http.ResponseWriter, r *http.Request) {
diff --git a/pkg/api/server/swagger.go b/pkg/api/server/swagger.go
index 6d349bb7d..45253e01a 100644
--- a/pkg/api/server/swagger.go
+++ b/pkg/api/server/swagger.go
@@ -4,6 +4,7 @@ import (
 	"github.com/containers/podman/v2/libpod"
 	"github.com/containers/podman/v2/libpod/define"
 	"github.com/containers/podman/v2/pkg/domain/entities"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 )
 
 // No such image
@@ -170,7 +171,7 @@ type ok struct {
 // swagger:response VolumePruneResponse
 type swagVolumePruneResponse struct {
 	// in:body
-	Body []entities.VolumePruneReport
+	Body []reports.PruneReport
 }
 
 // Volume create response