Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 579: Update toolbox list formatting #1092

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Issue 579: Update toolbox list formatting #1092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54a50f6
updated listOutput to be clean and simple
tonytheleg Aug 26, 2022
a36fbdd
adds --details flag to toolbox list and updates formatting
tonytheleg Aug 26, 2022
c8caa77
updated output of list and list --detailed
tonytheleg Aug 27, 2022
34bd883
update doc for list command to include changes
tonytheleg Aug 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions doc/toolbox-list.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ List only toolbox containers, not images.

List only toolbox images, not containers.

**--details, -d**

Display more details about existing toolbox containers and images.

## EXAMPLES

### List all existing toolbox containers and images
Expand All @@ -31,6 +35,12 @@ List only toolbox images, not containers.
$ toolbox list
```

### List all existing toolbox containers and images with detailed information

```
$ toolbox list --details
```

### List existing toolbox containers only

```
Expand All @@ -43,6 +53,13 @@ $ toolbox list --containers
$ toolbox list --images
```

### List existing toolbox images or containers only, with detailed information

```
$ toolbox list --images --details
$ toolbox list --containers --details
```

## SEE ALSO

`toolbox(1)`, `podman(1)`, `podman-ps(1)`, `podman-images(1)`
146 changes: 131 additions & 15 deletions src/cmd/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ var (
listFlags struct {
onlyContainers bool
onlyImages bool
detailed bool
}

// toolboxLabels holds labels used by containers/images that mark them as compatible with Toolbox
Expand Down Expand Up @@ -81,6 +82,12 @@ func init() {
false,
"List only toolbox images, not containers")

flags.BoolVarP(&listFlags.detailed,
"details",
"d",
false,
"Display more details about existing toolbox containers and images")

listCmd.SetHelpFunc(listHelp)
rootCmd.AddCommand(listCmd)
}
Expand Down Expand Up @@ -125,7 +132,11 @@ func list(cmd *cobra.Command, args []string) error {
}
}

listOutput(images, containers)
if listFlags.detailed {
listOutputDetailed(images, containers)
} else {
listOutput(images, containers)
}
return nil
}

Expand Down Expand Up @@ -235,32 +246,90 @@ func getImages() ([]toolboxImage, error) {
}

func listOutput(images []toolboxImage, containers []toolboxContainer) {
if len(containers) != 0 {
const boldGreenColor = "\033[1;32m"
const defaultColor = "\033[0;00m" // identical to resetColor, but same length as boldGreenColor
const boldDefaultColor = "\033[1m"
const resetColor = "\033[0m"

stdoutFd := os.Stdout.Fd()
writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)

if isatty.IsTerminal(stdoutFd) {
fmt.Fprintf(writer, "%s", defaultColor)
}

fmt.Fprintf(writer, "%s", boldDefaultColor)
fmt.Fprintf(writer, "Toolboxes\n")

for _, container := range containers {
isRunning := false
if podman.CheckVersion("2.0.0") {
isRunning = container.Status == "running"
}

if isatty.IsTerminal(stdoutFd) {
var color string
if isRunning {
color = boldGreenColor
} else {
color = defaultColor
}

fmt.Fprintf(writer, "%s", color)
}
fmt.Fprintf(writer, "\t%s", container.Names[0])

if isatty.IsTerminal(stdoutFd) {
fmt.Fprintf(writer, "%s", resetColor)
}

fmt.Fprintf(writer, "\n")
}

writer.Flush()
}

if len(images) != 0 {
const boldDefaultColor = "\033[1m"
const resetColor = "\033[0m"

stdoutFd := os.Stdout.Fd()
writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)
fmt.Fprintf(writer, "%s\t%s\t%s\n", "IMAGE ID", "IMAGE NAME", "CREATED")

if isatty.IsTerminal(stdoutFd) {
fmt.Fprintf(writer, "%s", resetColor)
}

fmt.Fprintf(writer, "%s", boldDefaultColor)
fmt.Fprintf(writer, "Images\n")

for _, image := range images {
if isatty.IsTerminal(stdoutFd) {
fmt.Fprintf(writer, "%s", resetColor)
}

imageName := "<none>"
if len(image.Names) != 0 {
imageName = image.Names[0]
}

fmt.Fprintf(writer, "%s\t%s\t%s\n",
utils.ShortID(image.ID),
imageName,
image.Created)
fmt.Fprintf(writer, "\t%s\n", imageName)
}

writer.Flush()
}

if len(images) != 0 && len(containers) != 0 {
if len(images) == 0 && len(containers) == 0 {
fmt.Println()
}
}

func listOutputDetailed(images []toolboxImage, containers []toolboxContainer) {
if len(containers) != 0 {
const boldGreenColor = "\033[1;32m"
const defaultColor = "\033[0;00m" // identical to resetColor, but same length as boldGreenColor
const boldDefaultColor = "\033[1m"
const resetColor = "\033[0m"

stdoutFd := os.Stdout.Fd()
Expand All @@ -270,13 +339,20 @@ func listOutput(images []toolboxImage, containers []toolboxContainer) {
fmt.Fprintf(writer, "%s", defaultColor)
}

fmt.Fprintf(writer, "%s", boldDefaultColor)
fmt.Fprintf(writer, "Toolboxes\n")

if isatty.IsTerminal(stdoutFd) {
fmt.Fprintf(writer, "%s", defaultColor)
}

fmt.Fprintf(writer,
"%s\t%s\t%s\t%s\t%s",
"CONTAINER ID",
"CONTAINER NAME",
"CREATED",
"STATUS",
"IMAGE NAME")
"\t%s\t%s\t%s\t%s\t%s",
"Name",
"Container ID",
"Created",
"Status",
"Image")

if isatty.IsTerminal(stdoutFd) {
fmt.Fprintf(writer, "%s", resetColor)
Expand All @@ -301,9 +377,9 @@ func listOutput(images []toolboxImage, containers []toolboxContainer) {
fmt.Fprintf(writer, "%s", color)
}

fmt.Fprintf(writer, "%s\t%s\t%s\t%s\t%s",
utils.ShortID(container.ID),
fmt.Fprintf(writer, "\t%s\t%s\t%s\t%s\t%s",
container.Names[0],
utils.ShortID(container.ID),
container.Created,
container.Status,
container.Image)
Expand All @@ -314,9 +390,49 @@ func listOutput(images []toolboxImage, containers []toolboxContainer) {

fmt.Fprintf(writer, "\n")
}
fmt.Fprintf(writer, "\n")
writer.Flush()
}

if len(images) != 0 {
const boldDefaultColor = "\033[1m"
const resetColor = "\033[0m"

stdoutFd := os.Stdout.Fd()
writer := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0)

if isatty.IsTerminal(stdoutFd) {
fmt.Fprintf(writer, "%s", resetColor)
}

fmt.Fprintf(writer, "%s", boldDefaultColor)
fmt.Fprintf(writer, "Images\n")

fmt.Fprintf(writer, "%s", resetColor)
fmt.Fprintf(writer, "\t%s\t%s\t%s\n", "Name", "Image ID", "Created")

for _, image := range images {
if isatty.IsTerminal(stdoutFd) {
fmt.Fprintf(writer, "%s", resetColor)
}

imageName := "<none>"
if len(image.Names) != 0 {
imageName = image.Names[0]
}

fmt.Fprintf(writer, "\t%s\t%s\t%s\n",
imageName,
utils.ShortID(image.ID),
image.Created)
}

writer.Flush()
}

if len(images) == 0 && len(containers) == 0 {
fmt.Println()
}
}

func (i *toolboxImage) UnmarshalJSON(data []byte) error {
Expand Down