plan: pretty-printing terminal output #22

langston-barrett · 2016-06-02T10:33:08Z

Will detect (just like logrus) if there is a color terminal available. Can be manually disabled. Colors can easily be changed, but for now they are:

path: bold black
current status: yellow if willchange, blue otherwise
willchange: yellow if true, blue if false

fixes #12

langston-barrett · 2016-06-02T11:12:16Z

I'm having some trouble with godep... I can't make it save to vendor/ instead of Godeps/_workspace. Can someone help me out with this?

BrianHicks · 2016-06-02T15:12:54Z

cmd/plan.go


 	"github.com/Sirupsen/logrus"
 	"github.com/asteris-llc/converge/exec"
 	"github.com/asteris-llc/converge/load"
 	"github.com/spf13/cobra"
 )

+var nocolor bool


please find a way to do this without introducing a global variable. We'll need this in more than one place. (hint: viper)

BrianHicks · 2016-06-02T15:37:03Z

For the vendoring issue, what version of Go are you using? It should be 1.6+ and with the latest version of godep. From there, make vendor ought to be the ticket.

BrianHicks · 2016-06-02T15:37:44Z

Also, could you attach a screenshot of the colored and plain output, please?

langston-barrett · 2016-06-02T20:43:21Z

@BrianHicks Ah, it was my version of Godep. Still not working, though :/

converge ➤ godep version
godep v74 (linux/amd64/go1.6.2)
converge ➤ go get ./... 
converge ➤ godep get ./...
converge ➤ make vendor        
godep save -t ./...
godep: Package (github.com/fsnotify/fsnotify) not found
Makefile:15: recipe for target 'vendor' failed
make: *** [vendor] Error 1

langston-barrett · 2016-06-02T20:43:54Z

Here's the screenshot of the latest commit (f880891). Sorry for the crappy quality!

BrianHicks · 2016-06-03T13:15:24Z

cmd/plan.go

@@ -25,6 +26,8 @@ import (
 	"github.com/spf13/viper"
 )

+var nocolor bool


this is still hangin' out here unused

hah! Thanks :)

BrianHicks · 2016-06-03T13:34:23Z

just thinking about future extensibility here: I know we're going to have ApplyResult too. What if we made it so that PlanResult and ApplyResult both implemented an interface, then Results was just a slice of that interface? I'm thinking something like this:

type PrettyPrinter interface {
    fmt.Stringer
    Pretty() string
}

langston-barrett · 2016-06-03T17:34:39Z

@BrianHicks What do you think the ApplyResult stuct should look like? Do you think that they'll have similar enough fields to make a shared interface sensible?

BrianHicks · 2016-06-03T18:33:00Z

https://github.com/asteris-llc/converge/blob/master/exec/apply.go#L26-L31 but they don't need to have similar fields, they just need to be able to pretty print. You could do it with any list of objects. I actually think we're going to have to have a stream of objects instead for quicker feedback, though.

langston-barrett · 2016-06-03T21:20:31Z

Okay, I've implemented a prettyPrinter interface for both ApplyResults and PlanResults, and used templates in both. All of them have tests which are now conceptually separate. Here's what it looks like:

(note that while those trues look more red than green in the screenshot, I'm pretty sure that's just because of my terminal's color pallete. I tried in another terminal and it showed up just green)

Let me know what you think!

BrianHicks · 2016-06-03T21:25:07Z

I'd like to see a blank line between each set, but otherwise that looks good. :)

BrianHicks · 2016-06-03T21:26:19Z

exec/print_results.go

+}
+
+// condFmt returns a function that only formats its input if a condition is true.
+func condFmt(cond bool, format func(interface{}) string) func(interface{}) string {


this is used in both, so it belongs in a utility package. exec/utils.go springs to mind.

langston-barrett · 2016-06-03T21:31:43Z

So in a29f8cb24f9b6a314b6ae1776372fa217eed8802, I attempted to add a newline between each Result, but when I try it in my shell, it doesn't show up 😨 Do you have any idea why that might be?

BrianHicks · 2016-06-06T13:53:05Z

Just to close the loop on my "streaming output" comment earlier, there is now streaming status. The list interface should be unaffected. :)

BrianHicks · 2016-06-06T14:09:56Z

exec/applyresult.go

-	tmplStr += `Status: "{{blueOrYellow (trimNewline .OldStatus)}}" `
-	tmplStr += `=> "{{blueOrYellow (trimNewline .NewStatus)}}"`
-	tmplStr += "\n\tSuccess: {{redOrGreen .Success}}"
+	tmplStr := `{{plusOrMinus}}{{redOrGreen .Path}}:


space here, please. {{plusOrMinus}} {{redOrGreen .Path}}

moves plusOrMinus to a utility function

BrianHicks · 2016-06-07T14:37:02Z

I'll let you rewrite to use that utility function, it's merged :) When that's done, we'll merge this, looks good. Thanks for all your effort!

langston-barrett · 2016-06-07T14:55:22Z

There's only one problem! That utility function is now in cmd which imports exec, so we can't have exec import it. Should we put it in a third spot?

BrianHicks · 2016-06-07T14:59:19Z

exec/print_results.go

+
+// Print implements a pretty printer that uses ANSI terminal colors when a color
+// terminal is available.
+func (rs Results) Print() string {


@siddharthist regarding your comment: how about Print(color bool)? This is not the place to determine that anyway.

langston-barrett · 2016-06-08T09:43:43Z

@BrianHicks this is ready for review

plan: pretty-printing terminal output

langston-barrett force-pushed the feature/plan-pretty-printing branch from 4066b59 to 28cb6bb Compare June 2, 2016 10:42

BrianHicks reviewed Jun 2, 2016
View reviewed changes

langston-barrett force-pushed the feature/plan-pretty-printing branch from 28cb6bb to 17fc025 Compare June 2, 2016 20:36

BrianHicks reviewed Jun 3, 2016
View reviewed changes

langston-barrett added 3 commits June 6, 2016 12:33

Use strings.Join where appropriate

c9f289f

move condFmt to a utils file

3839402

Warn on templating errors

c1575c5

langston-barrett force-pushed the feature/plan-pretty-printing branch from 41d9a32 to c1575c5 Compare June 6, 2016 11:33

langston-barrett added 2 commits June 6, 2016 14:59

Convert to a different output format/coloring

c688a81

highlight whole path on apply

95a914d

BrianHicks reviewed Jun 6, 2016
View reviewed changes

langston-barrett added 2 commits June 6, 2016 15:19

Add space after plus/minus

bf288e8

add plus or minus to the output of plan

2740b71

moves plusOrMinus to a utility function

langston-barrett modified the milestone: 0.1 Jun 6, 2016

langston-barrett mentioned this pull request Jun 7, 2016

color summaries #49

Merged

langston-barrett added 2 commits June 7, 2016 15:53

Merge branch 'master' into feature/plan-pretty-printing

55b523c

Merge branch 'master' into feature/plan-pretty-printing

7af2547

BrianHicks reviewed Jun 7, 2016
View reviewed changes

langston-barrett added 5 commits June 7, 2016 16:05

Print shouldn't decide whether or not to use color

abf5f1e

fix accidental comment

8c68f5c

Print tests no longer need Viper

837284c

plan shouldn't print results twice

7c1a22e

Merge branch 'master' into feature/plan-pretty-printing

27df047

BrianHicks merged commit 734c11f into master Jun 8, 2016

BrianHicks deleted the feature/plan-pretty-printing branch June 8, 2016 13:56

BrianHicks added a commit that referenced this pull request Dec 22, 2016

Merge pull request #22 from asteris-llc/feature/plan-pretty-printing

e494a62

plan: pretty-printing terminal output

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

plan: pretty-printing terminal output #22

plan: pretty-printing terminal output #22

langston-barrett commented Jun 2, 2016

langston-barrett commented Jun 2, 2016

BrianHicks Jun 2, 2016 •

edited

Loading

BrianHicks commented Jun 2, 2016

BrianHicks commented Jun 2, 2016

langston-barrett commented Jun 2, 2016

langston-barrett commented Jun 2, 2016 •

edited

Loading

BrianHicks Jun 3, 2016

langston-barrett Jun 3, 2016

BrianHicks commented Jun 3, 2016 •

edited

Loading

langston-barrett commented Jun 3, 2016

BrianHicks commented Jun 3, 2016

langston-barrett commented Jun 3, 2016 •

edited

Loading

BrianHicks commented Jun 3, 2016

BrianHicks Jun 3, 2016

langston-barrett commented Jun 3, 2016

BrianHicks commented Jun 6, 2016

BrianHicks Jun 6, 2016

BrianHicks commented Jun 7, 2016

langston-barrett commented Jun 7, 2016

BrianHicks Jun 7, 2016

langston-barrett Jun 7, 2016

langston-barrett commented Jun 8, 2016

plan: pretty-printing terminal output #22

plan: pretty-printing terminal output #22

Conversation

langston-barrett commented Jun 2, 2016

langston-barrett commented Jun 2, 2016

BrianHicks Jun 2, 2016 • edited Loading

Choose a reason for hiding this comment

BrianHicks commented Jun 2, 2016

BrianHicks commented Jun 2, 2016

langston-barrett commented Jun 2, 2016

langston-barrett commented Jun 2, 2016 • edited Loading

BrianHicks Jun 3, 2016

Choose a reason for hiding this comment

langston-barrett Jun 3, 2016

Choose a reason for hiding this comment

BrianHicks commented Jun 3, 2016 • edited Loading

langston-barrett commented Jun 3, 2016

BrianHicks commented Jun 3, 2016

langston-barrett commented Jun 3, 2016 • edited Loading

BrianHicks commented Jun 3, 2016

BrianHicks Jun 3, 2016

Choose a reason for hiding this comment

langston-barrett commented Jun 3, 2016

BrianHicks commented Jun 6, 2016

BrianHicks Jun 6, 2016

Choose a reason for hiding this comment

BrianHicks commented Jun 7, 2016

langston-barrett commented Jun 7, 2016

BrianHicks Jun 7, 2016

Choose a reason for hiding this comment

langston-barrett Jun 7, 2016

Choose a reason for hiding this comment

langston-barrett commented Jun 8, 2016

BrianHicks Jun 2, 2016 •

edited

Loading

langston-barrett commented Jun 2, 2016 •

edited

Loading

BrianHicks commented Jun 3, 2016 •

edited

Loading

langston-barrett commented Jun 3, 2016 •

edited

Loading