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, 41 insertions, 33 deletions

diff --git a/pkg/bindings/containers/containers.go b/pkg/bindings/containers/containers.go
index 650aa9ac5..1081a0e61 100644
--- a/pkg/bindings/containers/containers.go
+++ b/pkg/bindings/containers/containers.go
@@ -12,6 +12,7 @@ import (
 	"github.com/containers/podman/v2/pkg/api/handlers"
 	"github.com/containers/podman/v2/pkg/bindings"
 	"github.com/containers/podman/v2/pkg/domain/entities"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )
@@ -49,11 +50,11 @@ func List(ctx context.Context, options *ListOptions) ([]entities.ListContainer,
 // used for more granular selection of containers.  The main error returned indicates if there were runtime
 // errors like finding containers.  Errors specific to the removal of a container are in the PruneContainerResponse
 // structure.
-func Prune(ctx context.Context, options *PruneOptions) (*entities.ContainerPruneReport, error) {
+func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error) {
 	if options == nil {
 		options = new(PruneOptions)
 	}
-	var reports *entities.ContainerPruneReport
+	var reports []*reports.PruneReport
 	conn, err := bindings.GetClient(ctx)
 	if err != nil {
 		return nil, err
diff --git a/pkg/bindings/images/images.go b/pkg/bindings/images/images.go
index 9beb493c8..ecdd1f553 100644
--- a/pkg/bindings/images/images.go
+++ b/pkg/bindings/images/images.go
@@ -12,6 +12,7 @@ import (
 	"github.com/containers/podman/v2/pkg/auth"
 	"github.com/containers/podman/v2/pkg/bindings"
 	"github.com/containers/podman/v2/pkg/domain/entities"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	"github.com/pkg/errors"
 )
 
@@ -163,9 +164,9 @@ func Export(ctx context.Context, nameOrIDs []string, w io.Writer, options *Expor
 
 // Prune removes unused images from local storage.  The optional filters can be used to further
 // define which images should be pruned.
-func Prune(ctx context.Context, options *PruneOptions) ([]string, error) {
+func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error) {
 	var (
-		deleted []string
+		deleted []*reports.PruneReport
 	)
 	if options == nil {
 		options = new(PruneOptions)
@@ -182,7 +183,8 @@ func Prune(ctx context.Context, options *PruneOptions) ([]string, error) {
 	if err != nil {
 		return deleted, err
 	}
-	return deleted, response.Process(&deleted)
+	err = response.Process(&deleted)
+	return deleted, err
 }
 
 // Tag adds an additional name to locally-stored image. Both the tag and repo parameters are required.
diff --git a/pkg/bindings/test/containers_test.go b/pkg/bindings/test/containers_test.go
index 2ab5e45d0..fa601e7e5 100644
--- a/pkg/bindings/test/containers_test.go
+++ b/pkg/bindings/test/containers_test.go
@@ -8,6 +8,7 @@ import (
 	"github.com/containers/podman/v2/libpod/define"
 	"github.com/containers/podman/v2/pkg/bindings"
 	"github.com/containers/podman/v2/pkg/bindings/containers"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	"github.com/containers/podman/v2/pkg/specgen"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -533,8 +534,8 @@ var _ = Describe("Podman containers ", func() {
 		// Prune container should return no errors and one pruned container ID.
 		pruneResponse, err := containers.Prune(bt.conn, nil)
 		Expect(err).To(BeNil())
-		Expect(len(pruneResponse.Err)).To(Equal(0))
-		Expect(len(pruneResponse.ID)).To(Equal(1))
+		Expect(len(reports.PruneReportsErrs(pruneResponse))).To(Equal(0))
+		Expect(len(reports.PruneReportsIds(pruneResponse))).To(Equal(1))
 	})
 
 	It("podman prune stopped containers with filters", func() {
@@ -558,8 +559,8 @@ var _ = Describe("Podman containers ", func() {
 		}
 		pruneResponse, err = containers.Prune(bt.conn, new(containers.PruneOptions).WithFilters(filtersIncorrect))
 		Expect(err).To(BeNil())
-		Expect(len(pruneResponse.Err)).To(Equal(0))
-		Expect(len(pruneResponse.ID)).To(Equal(0))
+		Expect(len(reports.PruneReportsIds(pruneResponse))).To(Equal(0))
+		Expect(len(reports.PruneReportsErrs(pruneResponse))).To(Equal(0))
 
 		// Valid filter params container should be pruned now.
 		filters := map[string][]string{
@@ -567,8 +568,8 @@ var _ = Describe("Podman containers ", func() {
 		}
 		pruneResponse, err = containers.Prune(bt.conn, new(containers.PruneOptions).WithFilters(filters))
 		Expect(err).To(BeNil())
-		Expect(len(pruneResponse.Err)).To(Equal(0))
-		Expect(len(pruneResponse.ID)).To(Equal(1))
+		Expect(len(reports.PruneReportsErrs(pruneResponse))).To(Equal(0))
+		Expect(len(reports.PruneReportsIds(pruneResponse))).To(Equal(1))
 	})
 
 	It("podman prune running containers", func() {
@@ -585,7 +586,7 @@ var _ = Describe("Podman containers ", func() {
 		// Prune. Should return no error no prune response ID.
 		pruneResponse, err := containers.Prune(bt.conn, nil)
 		Expect(err).To(BeNil())
-		Expect(len(pruneResponse.ID)).To(Equal(0))
+		Expect(len(pruneResponse)).To(Equal(0))
 	})
 
 	It("podman inspect bogus container", func() {
diff --git a/pkg/bindings/test/images_test.go b/pkg/bindings/test/images_test.go
index e178f4219..c6b9c20f9 100644
--- a/pkg/bindings/test/images_test.go
+++ b/pkg/bindings/test/images_test.go
@@ -9,6 +9,7 @@ import (
 	"github.com/containers/podman/v2/pkg/bindings"
 	"github.com/containers/podman/v2/pkg/bindings/containers"
 	"github.com/containers/podman/v2/pkg/bindings/images"
+	dreports "github.com/containers/podman/v2/pkg/domain/entities/reports"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 	"github.com/onsi/gomega/gexec"
@@ -355,7 +356,7 @@ var _ = Describe("Podman images", func() {
 		results, err := images.Prune(bt.conn, options)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(len(results)).To(BeNumerically(">", 0))
-		Expect(results).To(ContainElement("docker.io/library/alpine:latest"))
+		Expect(dreports.PruneReportsIds(results)).To(ContainElement("docker.io/library/alpine:latest"))
 	})
 
 	// TODO: we really need to extent to pull tests once we have a more sophisticated CI.
diff --git a/pkg/bindings/test/system_test.go b/pkg/bindings/test/system_test.go
index 25fda5575..44067b61d 100644
--- a/pkg/bindings/test/system_test.go
+++ b/pkg/bindings/test/system_test.go
@@ -10,6 +10,7 @@ import (
 	"github.com/containers/podman/v2/pkg/bindings/system"
 	"github.com/containers/podman/v2/pkg/bindings/volumes"
 	"github.com/containers/podman/v2/pkg/domain/entities"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 	"github.com/onsi/gomega/gexec"
@@ -80,12 +81,12 @@ var _ = Describe("Podman system", func() {
 		systemPruneResponse, err := system.Prune(bt.conn, options)
 		Expect(err).To(BeNil())
 		Expect(len(systemPruneResponse.PodPruneReport)).To(Equal(1))
-		Expect(len(systemPruneResponse.ContainerPruneReport.ID)).To(Equal(1))
-		Expect(len(systemPruneResponse.ImagePruneReport.Report.Id)).
+		Expect(len(systemPruneResponse.ContainerPruneReports)).To(Equal(1))
+		Expect(len(systemPruneResponse.ImagePruneReports)).
 			To(BeNumerically(">", 0))
-		Expect(systemPruneResponse.ImagePruneReport.Report.Id).
+		Expect(reports.PruneReportsIds(systemPruneResponse.ImagePruneReports)).
 			To(ContainElement("docker.io/library/alpine:latest"))
-		Expect(len(systemPruneResponse.VolumePruneReport)).To(Equal(0))
+		Expect(len(systemPruneResponse.VolumePruneReports)).To(Equal(0))
 	})
 
 	It("podman system prune running alpine container", func() {
@@ -114,14 +115,14 @@ var _ = Describe("Podman system", func() {
 		systemPruneResponse, err := system.Prune(bt.conn, options)
 		Expect(err).To(BeNil())
 		Expect(len(systemPruneResponse.PodPruneReport)).To(Equal(1))
-		Expect(len(systemPruneResponse.ContainerPruneReport.ID)).To(Equal(1))
-		Expect(len(systemPruneResponse.ImagePruneReport.Report.Id)).
+		Expect(len(systemPruneResponse.ContainerPruneReports)).To(Equal(1))
+		Expect(len(systemPruneResponse.ImagePruneReports)).
 			To(BeNumerically(">", 0))
 		// Alpine image should not be pruned as used by running container
-		Expect(systemPruneResponse.ImagePruneReport.Report.Id).
+		Expect(reports.PruneReportsIds(systemPruneResponse.ImagePruneReports)).
 			ToNot(ContainElement("docker.io/library/alpine:latest"))
 		// Though unused volume is available it should not be pruned as flag set to false.
-		Expect(len(systemPruneResponse.VolumePruneReport)).To(Equal(0))
+		Expect(len(systemPruneResponse.VolumePruneReports)).To(Equal(0))
 	})
 
 	It("podman system prune running alpine container volume prune", func() {
@@ -149,14 +150,14 @@ var _ = Describe("Podman system", func() {
 		systemPruneResponse, err := system.Prune(bt.conn, options)
 		Expect(err).To(BeNil())
 		Expect(len(systemPruneResponse.PodPruneReport)).To(Equal(0))
-		Expect(len(systemPruneResponse.ContainerPruneReport.ID)).To(Equal(1))
-		Expect(len(systemPruneResponse.ImagePruneReport.Report.Id)).
+		Expect(len(systemPruneResponse.ContainerPruneReports)).To(Equal(1))
+		Expect(len(systemPruneResponse.ImagePruneReports)).
 			To(BeNumerically(">", 0))
 		// Alpine image should not be pruned as used by running container
-		Expect(systemPruneResponse.ImagePruneReport.Report.Id).
+		Expect(reports.PruneReportsIds(systemPruneResponse.ImagePruneReports)).
 			ToNot(ContainElement("docker.io/library/alpine:latest"))
 		// Volume should be pruned now as flag set true
-		Expect(len(systemPruneResponse.VolumePruneReport)).To(Equal(1))
+		Expect(len(systemPruneResponse.VolumePruneReports)).To(Equal(1))
 	})
 
 	It("podman system prune running alpine container volume prune --filter", func() {
@@ -197,14 +198,14 @@ var _ = Describe("Podman system", func() {
 		//      This check **should** be "Equal(0)" since we are passing label
 		//      filters however the Prune function doesn't seem to pass filters
 		//      to each component.
-		Expect(len(systemPruneResponse.ContainerPruneReport.ID)).To(Equal(1))
-		Expect(len(systemPruneResponse.ImagePruneReport.Report.Id)).
+		Expect(len(systemPruneResponse.ContainerPruneReports)).To(Equal(1))
+		Expect(len(systemPruneResponse.ImagePruneReports)).
 			To(BeNumerically(">", 0))
 		// Alpine image should not be pruned as used by running container
-		Expect(systemPruneResponse.ImagePruneReport.Report.Id).
+		Expect(reports.PruneReportsIds(systemPruneResponse.ImagePruneReports)).
 			ToNot(ContainElement("docker.io/library/alpine:latest"))
 		// Volume shouldn't be pruned because the PruneOptions filters doesn't match
-		Expect(len(systemPruneResponse.VolumePruneReport)).To(Equal(0))
+		Expect(len(systemPruneResponse.VolumePruneReports)).To(Equal(0))
 
 		// Fix filter and re prune
 		f["label"] = []string{"label1=value1"}
@@ -213,6 +214,6 @@ var _ = Describe("Podman system", func() {
 		Expect(err).To(BeNil())
 
 		// Volume should be pruned because the PruneOptions filters now match
-		Expect(len(systemPruneResponse.VolumePruneReport)).To(Equal(1))
+		Expect(len(systemPruneResponse.VolumePruneReports)).To(Equal(1))
 	})
 })
diff --git a/pkg/bindings/test/volumes_test.go b/pkg/bindings/test/volumes_test.go
index e0d854b66..1f1da3cfa 100644
--- a/pkg/bindings/test/volumes_test.go
+++ b/pkg/bindings/test/volumes_test.go
@@ -10,6 +10,7 @@ import (
 	"github.com/containers/podman/v2/pkg/bindings/containers"
 	"github.com/containers/podman/v2/pkg/bindings/volumes"
 	"github.com/containers/podman/v2/pkg/domain/entities"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 	"github.com/onsi/gomega/gexec"
@@ -166,7 +167,7 @@ var _ = Describe("Podman volumes", func() {
 		session.Wait(45)
 		vols, err = volumes.Prune(connText, nil)
 		Expect(err).To(BeNil())
-		Expect(len(vols)).To(BeNumerically("==", 1))
+		Expect(len(reports.PruneReportsIds(vols))).To(BeNumerically("==", 1))
 		_, err = volumes.Inspect(connText, "homer", nil)
 		Expect(err).To(BeNil())
 
diff --git a/pkg/bindings/volumes/volumes.go b/pkg/bindings/volumes/volumes.go
index 626f52d39..fe081eb46 100644
--- a/pkg/bindings/volumes/volumes.go
+++ b/pkg/bindings/volumes/volumes.go
@@ -7,6 +7,7 @@ import (
 
 	"github.com/containers/podman/v2/pkg/bindings"
 	"github.com/containers/podman/v2/pkg/domain/entities"
+	"github.com/containers/podman/v2/pkg/domain/entities/reports"
 	jsoniter "github.com/json-iterator/go"
 )
 
@@ -77,9 +78,9 @@ func List(ctx context.Context, options *ListOptions) ([]*entities.VolumeListRepo
 }
 
 // Prune removes unused volumes from the local filesystem.
-func Prune(ctx context.Context, options *PruneOptions) ([]*entities.VolumePruneReport, error) {
+func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error) {
 	var (
-		pruned []*entities.VolumePruneReport
+		pruned []*reports.PruneReport
 	)
 	conn, err := bindings.GetClient(ctx)
 	if err != nil {