Merge pull request #7973 from jwhonce/jira/run-898-3

Port V1 --format table to V2 podman

cmd/podman/containers/ps.go

@@ -12,7 +12,9 @@ import (
 
 	tm "github.com/buger/goterm"
 	"github.com/containers/buildah/pkg/formats"
+	"github.com/containers/podman/v2/cmd/podman/parse"
 	"github.com/containers/podman/v2/cmd/podman/registry"
+	"github.com/containers/podman/v2/cmd/podman/report"
 	"github.com/containers/podman/v2/cmd/podman/utils"
 	"github.com/containers/podman/v2/cmd/podman/validate"
 	"github.com/containers/podman/v2/pkg/domain/entities"
@@ -176,47 +178,51 @@ func ps(cmd *cobra.Command, args []string) error {
 			return err
 		}
 	}
-	if listOpts.Format == "json" {
+
+	switch {
+	case parse.MatchesJSONFormat(listOpts.Format):
 		return jsonOut(listContainers)
-	}
-	if listOpts.Quiet {
+	case listOpts.Quiet:
 		return quietOut(listContainers)
 	}
+	// Output table Watch > 0 will refresh screen
 
 	responses := make([]psReporter, 0, len(listContainers))
 	for _, r := range listContainers {
 		responses = append(responses, psReporter{r})
 	}
 
-	headers, format := createPsOut()
-	if cmd.Flag("format").Changed {
-		format = strings.TrimPrefix(listOpts.Format, "table ")
-		if !strings.HasPrefix(format, "\n") {
-			format += "\n"
-		}
-	}
-	format = "{{range . }}" + format + "{{end}}"
-	if !listOpts.Quiet && !cmd.Flag("format").Changed {
-		format = headers + format
+	var headers, format string
+	if cmd.Flags().Changed("format") {
+		headers = ""
+		format = report.NormalizeFormat(listOpts.Format)
+	} else {
+		headers, format = createPsOut()
 	}
+	format = headers + "{{range . }}" + format + "{{end}}"
+
 	tmpl, err := template.New("listContainers").Parse(format)
 	if err != nil {
 		return err
 	}
 	w := tabwriter.NewWriter(os.Stdout, 8, 2, 2, ' ', 0)
+	defer w.Flush()
+
 	if listOpts.Watch > 0 {
 		for {
 			var responses []psReporter
 			tm.Clear()
 			tm.MoveCursor(1, 1)
 			tm.Flush()
-			listContainers, err := getResponses()
-			for _, r := range listContainers {
-				responses = append(responses, psReporter{r})
-			}
-			if err != nil {
+
+			if ctnrs, err := getResponses(); err != nil {
 				return err
+			} else {
+				for _, r := range ctnrs {
+					responses = append(responses, psReporter{r})
+				}
 			}
+
 			if err := tmpl.Execute(w, responses); err != nil {
 				return err
 			}
@@ -232,11 +238,11 @@ func ps(cmd *cobra.Command, args []string) error {
 		if err := tmpl.Execute(w, responses); err != nil {
 			return err
 		}
-		return w.Flush()
 	}
 	return nil
 }
 
+// cannot use report.Headers() as it doesn't support structures as fields
 func createPsOut() (string, string) {
 	var row string
 	if listOpts.Namespace {
@@ -257,12 +263,9 @@ func createPsOut() (string, string) {
 		headers += "\tSIZE"
 		row += "\t{{.Size}}"
 	}
-	if !strings.HasSuffix(headers, "\n") {
-		headers += "\n"
-	}
-	if !strings.HasSuffix(row, "\n") {
-		row += "\n"
-	}
+
+	headers = report.NormalizeFormat(headers)
+	row = report.NormalizeFormat(row)
 	return headers, row
 }
 

cmd/podman/volumes/list.go

@@ -3,13 +3,14 @@ package volumes
 import (
 	"context"
 	"fmt"
-	"io"
 	"os"
 	"strings"
 	"text/tabwriter"
 	"text/template"
 
+	"github.com/containers/podman/v2/cmd/podman/parse"
 	"github.com/containers/podman/v2/cmd/podman/registry"
+	"github.com/containers/podman/v2/cmd/podman/report"
 	"github.com/containers/podman/v2/cmd/podman/validate"
 	"github.com/containers/podman/v2/pkg/domain/entities"
 	"github.com/pkg/errors"
@@ -55,7 +56,6 @@ func init() {
 }
 
 func list(cmd *cobra.Command, args []string) error {
-	var w io.Writer = os.Stdout
 	if cliOpts.Quiet && cmd.Flag("format").Changed {
 		return errors.New("quiet and format flags cannot be used together")
 	}
@@ -73,40 +73,40 @@ func list(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
-	if cliOpts.Format == "json" {
-		return outputJSON(responses)
-	}
 
-	if len(responses) < 1 {
+	switch {
+	case parse.MatchesJSONFormat(cliOpts.Format):
+		return outputJSON(responses)
+	case len(responses) < 1:
 		return nil
 	}
-	// "\t" from the command line is not being recognized as a tab
-	// replacing the string "\t" to a tab character if the user passes in "\t"
-	cliOpts.Format = strings.Replace(cliOpts.Format, `\t`, "\t", -1)
+	return outputTemplate(cmd, responses)
+}
+
+func outputTemplate(cmd *cobra.Command, responses []*entities.VolumeListReport) error {
+	headers := report.Headers(entities.VolumeListReport{}, map[string]string{
+		"Name": "VOLUME NAME",
+	})
+
+	row := report.NormalizeFormat(cliOpts.Format)
 	if cliOpts.Quiet {
-		cliOpts.Format = "{{.Name}}\n"
+		row = "{{.Name}}\n"
 	}
-	headers := "DRIVER\tVOLUME NAME\n"
-	row := cliOpts.Format
-	if !strings.HasSuffix(cliOpts.Format, "\n") {
-		row += "\n"
-	}
-	format := "{{range . }}" + row + "{{end}}"
-	if !cliOpts.Quiet && !cmd.Flag("format").Changed {
-		w = tabwriter.NewWriter(os.Stdout, 12, 2, 2, ' ', 0)
-		format = headers + format
-	}
-	tmpl, err := template.New("listVolume").Parse(format)
+	row = "{{range . }}" + row + "{{end}}"
+
+	tmpl, err := template.New("list volume").Parse(row)
 	if err != nil {
 		return err
 	}
-	if err := tmpl.Execute(w, responses); err != nil {
-		return err
+	w := tabwriter.NewWriter(os.Stdout, 12, 2, 2, ' ', 0)
+	defer w.Flush()
+
+	if !cliOpts.Quiet && !cmd.Flag("format").Changed {
+		if err := tmpl.Execute(w, headers); err != nil {
+			return errors.Wrapf(err, "failed to write report column headers")
+		}
 	}
-	if flusher, ok := w.(interface{ Flush() error }); ok {
-		return flusher.Flush()
-	}
-	return nil
+	return tmpl.Execute(w, responses)
 }
 
 func outputJSON(vols []*entities.VolumeListReport) error {

test/e2e/ps_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/docker/go-units"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	. "github.com/onsi/gomega/gexec"
 )
 
 var _ = Describe("Podman ps", func() {
@@ -218,17 +219,16 @@ var _ = Describe("Podman ps", func() {
 	})
 
 	It("podman ps namespace flag with go template format", func() {
-		Skip("FIXME: table still not supported in podman ps command")
 		_, ec, _ := podmanTest.RunLsContainer("test1")
 		Expect(ec).To(Equal(0))
 
 		result := podmanTest.Podman([]string{"ps", "-a", "--format", "table {{.ID}} {{.Image}} {{.ImageID}} {{.Labels}}"})
 		result.WaitWithDefaultTimeout()
-		Expect(strings.Contains(result.OutputToStringArray()[0], "table")).To(BeFalse())
-		Expect(strings.Contains(result.OutputToStringArray()[0], "ID")).To(BeTrue())
-		Expect(strings.Contains(result.OutputToStringArray()[0], "ImageID")).To(BeTrue())
-		Expect(strings.Contains(result.OutputToStringArray()[1], "alpine:latest")).To(BeTrue())
-		Expect(result.ExitCode()).To(Equal(0))
+
+		Expect(result.OutputToStringArray()[0]).ToNot(ContainSubstring("table"))
+		Expect(result.OutputToStringArray()[0]).ToNot(ContainSubstring("ImageID"))
+		Expect(result.OutputToStringArray()[0]).To(ContainSubstring("alpine:latest"))
+		Expect(result).Should(Exit(0))
 	})
 
 	It("podman ps ancestor filter flag", func() {

test/e2e/volume_ls_test.go

@@ -7,6 +7,7 @@ import (
 	. "github.com/containers/podman/v2/test/utils"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	. "github.com/onsi/gomega/gexec"
 )
 
 var _ = Describe("Podman volume ls", func() {
@@ -56,15 +57,15 @@ var _ = Describe("Podman volume ls", func() {
 	})
 
 	It("podman ls volume with Go template", func() {
-		Skip("FIXME: table still not supported in podman volume command")
 		session := podmanTest.Podman([]string{"volume", "create", "myvol"})
 		session.WaitWithDefaultTimeout()
 		Expect(session.ExitCode()).To(Equal(0))
 
 		session = podmanTest.Podman([]string{"volume", "ls", "--format", "table {{.Name}} {{.Driver}} {{.Scope}}"})
 		session.WaitWithDefaultTimeout()
-		Expect(session.ExitCode()).To(Equal(0))
-		Expect(len(session.OutputToStringArray())).To(Equal(2))
+
+		Expect(session).Should(Exit(0))
+		Expect(len(session.OutputToStringArray())).To(Equal(1), session.OutputToString())
 	})
 
 	It("podman ls volume with --filter flag", func() {