Skip to content

Commit

Permalink
podman version: use report.Formatter over Template
Browse files Browse the repository at this point in the history
Currently the podman command --format output code uses a mix of
report.Formatter and report.Template.

I patched report.Formatter to correctly handle newlines[1]. Since we
cannot fix this with report.Template we have to migrate all users to
report.Formatter. This ensures consistent behavior for all commands.

This change does not change the output.

[1] containers/common#1146

Signed-off-by: Paul Holzinger <[email protected]>
  • Loading branch information
Luap99 committed Sep 13, 2022
1 parent 0c21dcf commit 7f8e99d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
19 changes: 11 additions & 8 deletions cmd/podman/system/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ import (
"fmt"
"os"
"strings"
"text/template"

"github.com/containers/common/pkg/completion"
"github.com/containers/common/pkg/report"
"github.com/containers/podman/v4/cmd/podman/common"
"github.com/containers/podman/v4/cmd/podman/registry"
"github.com/containers/podman/v4/cmd/podman/validate"
"github.com/containers/podman/v4/pkg/domain/entities"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
)

Expand Down Expand Up @@ -53,22 +53,25 @@ func version(cmd *cobra.Command, args []string) error {
}

if cmd.Flag("format").Changed {
// Cannot use report.New() as it enforces {{range .}} for OriginUser templates
tmpl := template.New(cmd.Name()).Funcs(template.FuncMap(report.DefaultFuncs))
rpt := report.New(os.Stdout, cmd.Name())
defer rpt.Flush()

versionFormat = report.NormalizeFormat(versionFormat)
tmpl, err := tmpl.Parse(versionFormat)
// Use OriginUnknown so it does not add an extra range since it
// will only be called for a single element and not a slice.
rpt, err = rpt.Parse(report.OriginUnknown, versionFormat)
if err != nil {
return err
}
if err := tmpl.Execute(os.Stdout, versions); err != nil {
if err := rpt.Execute(versions); err != nil {
// only log at debug since we fall back to the client only template
logrus.Debugf("Failed to execute template: %v", err)
// On Failure, assume user is using older version of podman version --format and check client
versionFormat = strings.ReplaceAll(versionFormat, ".Server.", ".")
tmpl, err := tmpl.Parse(versionFormat)
rpt, err := rpt.Parse(report.OriginUnknown, versionFormat)
if err != nil {
return err
}
if err := tmpl.Execute(os.Stdout, versions.Client); err != nil {
if err := rpt.Execute(versions.Client); err != nil {
return err
}
}
Expand Down
2 changes: 0 additions & 2 deletions test/system/610-format.bats
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ function teardown() {
# remove the entire lines, except for pod-inspect, just remove the SKIP
# but leave "mypod")
extra_args_table="
version | SKIP
history | $IMAGE
image history | $IMAGE
image inspect | $IMAGE
Expand Down

0 comments on commit 7f8e99d

Please sign in to comment.