Merge pull request #5907 from sujil02/systemprune-v2

Adding system prune for podman v2

2 files changed, 128 insertions, 2 deletions

diff --git a/pkg/bindings/system/system.go b/pkg/bindings/system/system.go
index e2f264139..df6b529de 100644
--- a/pkg/bindings/system/system.go
+++ b/pkg/bindings/system/system.go
@@ -6,6 +6,7 @@ import (
 	"io"
 	"net/http"
 	"net/url"
+	"strconv"
 
 	"github.com/containers/libpod/pkg/bindings"
 	"github.com/containers/libpod/pkg/domain/entities"
@@ -59,3 +60,26 @@ func Events(ctx context.Context, eventChan chan (entities.Event), cancelChan cha
 	}
 	return nil
 }
+
+// Prune removes all unused system data.
+func Prune(ctx context.Context, all, volumes *bool) (*entities.SystemPruneReport, error) {
+	var (
+		report entities.SystemPruneReport
+	)
+	conn, err := bindings.GetClient(ctx)
+	if err != nil {
+		return nil, err
+	}
+	params := url.Values{}
+	if all != nil {
+		params.Set("All", strconv.FormatBool(*all))
+	}
+	if volumes != nil {
+		params.Set("Volumes", strconv.FormatBool(*volumes))
+	}
+	response, err := conn.DoRequest(nil, http.MethodPost, "/system/prune", params)
+	if err != nil {
+		return nil, err
+	}
+	return &report, response.Process(&report)
+}
diff --git a/pkg/bindings/test/system_test.go b/pkg/bindings/test/system_test.go
index 3abc26b34..87e6d56dc 100644
--- a/pkg/bindings/test/system_test.go
+++ b/pkg/bindings/test/system_test.go
@@ -4,7 +4,12 @@ import (
 	"time"
 
 	"github.com/containers/libpod/pkg/api/handlers"
+	"github.com/containers/libpod/pkg/bindings"
+	"github.com/containers/libpod/pkg/bindings/containers"
+	"github.com/containers/libpod/pkg/bindings/pods"
 	"github.com/containers/libpod/pkg/bindings/system"
+	"github.com/containers/libpod/pkg/bindings/volumes"
+	"github.com/containers/libpod/pkg/domain/entities"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 	"github.com/onsi/gomega/gexec"
@@ -12,13 +17,16 @@ import (
 
 var _ = Describe("Podman system", func() {
 	var (
-		bt *bindingTest
-		s  *gexec.Session
+		bt     *bindingTest
+		s      *gexec.Session
+		newpod string
 	)
 
 	BeforeEach(func() {
 		bt = newBindingTest()
 		bt.RestoreImagesFromCache()
+		newpod = "newpod"
+		bt.Podcreate(&newpod)
 		s = bt.startAPIService()
 		time.Sleep(1 * time.Second)
 		err := bt.NewConnection()
@@ -48,4 +56,98 @@ var _ = Describe("Podman system", func() {
 		cancelChan <- true
 		Expect(len(messages)).To(BeNumerically("==", 3))
 	})
+
+	It("podman system prune - pod,container stopped", func() {
+		// Start and stop a pod to enter in exited state.
+		_, err := pods.Start(bt.conn, newpod)
+		Expect(err).To(BeNil())
+		_, err = pods.Stop(bt.conn, newpod, nil)
+		Expect(err).To(BeNil())
+		// Start and stop a container to enter in exited state.
+		var name = "top"
+		_, err = bt.RunTopContainer(&name, &bindings.PFalse, nil)
+		Expect(err).To(BeNil())
+		err = containers.Stop(bt.conn, name, nil)
+		Expect(err).To(BeNil())
+
+		systemPruneResponse, err := system.Prune(bt.conn, &bindings.PTrue, &bindings.PFalse)
+		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)).
+			To(BeNumerically(">", 0))
+		Expect(systemPruneResponse.ImagePruneReport.Report.Id).
+			To(ContainElement("docker.io/library/alpine:latest"))
+		Expect(len(systemPruneResponse.VolumePruneReport)).To(Equal(0))
+	})
+
+	It("podman system prune running alpine container", func() {
+		// Start and stop a pod to enter in exited state.
+		_, err := pods.Start(bt.conn, newpod)
+		Expect(err).To(BeNil())
+		_, err = pods.Stop(bt.conn, newpod, nil)
+		Expect(err).To(BeNil())
+
+		// Start and stop a container to enter in exited state.
+		var name = "top"
+		_, err = bt.RunTopContainer(&name, &bindings.PFalse, nil)
+		Expect(err).To(BeNil())
+		err = containers.Stop(bt.conn, name, nil)
+		Expect(err).To(BeNil())
+
+		// Start container and leave in running
+		var name2 = "top2"
+		_, err = bt.RunTopContainer(&name2, &bindings.PFalse, nil)
+		Expect(err).To(BeNil())
+
+		// Adding an unused volume
+		_, err = volumes.Create(bt.conn, entities.VolumeCreateOptions{})
+		Expect(err).To(BeNil())
+
+		systemPruneResponse, err := system.Prune(bt.conn, &bindings.PTrue, &bindings.PFalse)
+		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)).
+			To(BeNumerically(">", 0))
+		// Alpine image should not be pruned as used by running container
+		Expect(systemPruneResponse.ImagePruneReport.Report.Id).
+			ToNot(ContainElement("docker.io/library/alpine:latest"))
+		// Though unsed volume is available it should not be pruned as flag set to false.
+		Expect(len(systemPruneResponse.VolumePruneReport)).To(Equal(0))
+	})
+
+	It("podman system prune running alpine container volume prune", func() {
+		// Start a pod and leave it running
+		_, err := pods.Start(bt.conn, newpod)
+		Expect(err).To(BeNil())
+
+		// Start and stop a container to enter in exited state.
+		var name = "top"
+		_, err = bt.RunTopContainer(&name, &bindings.PFalse, nil)
+		Expect(err).To(BeNil())
+		err = containers.Stop(bt.conn, name, nil)
+		Expect(err).To(BeNil())
+
+		// Start second container and leave in running
+		var name2 = "top2"
+		_, err = bt.RunTopContainer(&name2, &bindings.PFalse, nil)
+		Expect(err).To(BeNil())
+
+		// Adding an unused volume should work
+		_, err = volumes.Create(bt.conn, entities.VolumeCreateOptions{})
+		Expect(err).To(BeNil())
+
+		systemPruneResponse, err := system.Prune(bt.conn, &bindings.PTrue, &bindings.PTrue)
+		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)).
+			To(BeNumerically(">", 0))
+		// Alpine image should not be pruned as used by running container
+		Expect(systemPruneResponse.ImagePruneReport.Report.Id).
+			ToNot(ContainElement("docker.io/library/alpine:latest"))
+		// Volume should be pruned now as flag set true
+		Expect(len(systemPruneResponse.VolumePruneReport)).To(Equal(1))
+	})
 })