plan: pretty-printing terminal output

cmd/apply.go

@@ -83,13 +83,19 @@ var applyCmd = &cobra.Command{
 				logger.WithError(err).Fatal("applying failed")
 			}
 
+			// giving the results the type exec.Results allows us to pretty-print them
+			var typedResults exec.Results
+			for _, result := range results {
+				typedResults = append(typedResults, result)
+			}
+			fmt.Println(typedResults.Print(UseColor()))
+
+			// count successes and failures to print summary
 			var counts struct {
 				results, success, failures int
 			}
 
-			fmt.Print("\n")
 			for _, result := range results {
-				fmt.Println(result)
 				counts.results++
 				if result.Success {
 					counts.success++

cmd/plan.go

@@ -68,13 +68,19 @@ var planCmd = &cobra.Command{
 				logger.WithError(err).Fatal("planning failed")
 			}
 
+			// giving the results the type exec.Results allows us to pretty-print them
+			var typedResults exec.Results
+			for _, result := range results {
+				typedResults = append(typedResults, result)
+			}
+			fmt.Println(typedResults.Print(UseColor()))
+
+			// count results and changes to print summary
 			var counts struct {
 				results, changes int
 			}
 
-			fmt.Print("\n")
 			for _, result := range results {
-				fmt.Println(result)
 				counts.results++
 				if result.WillChange {
 					counts.changes++

cmd/root.go

@@ -52,6 +52,7 @@ func init() {
 	cobra.OnInitialize(initConfig)
 
 	RootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.converge.yaml)")
+	RootCmd.PersistentFlags().BoolP("nocolor", "n", false, "force colorless output")
 
 	viperBindPFlags(RootCmd.PersistentFlags())
 }

exec/apply.go

@@ -15,7 +15,6 @@
 package exec
 
 import (
-	"fmt"
 	"sync"
 
 	"golang.org/x/net/context"
@@ -24,24 +23,6 @@ import (
 	"github.com/asteris-llc/converge/resource"
 )
 
-// ApplyResult contains the result of a resource check
-type ApplyResult struct {
-	Path      string
-	OldStatus string
-	NewStatus string
-	Success   bool
-}
-
-func (p *ApplyResult) String() string {
-	return fmt.Sprintf(
-		"%s:\n\tStatus: %q => %q\n\tSuccess: %t",
-		p.Path,
-		p.OldStatus,
-		p.NewStatus,
-		p.Success,
-	)
-}
-
 // ApplyWithStatus applies the operations checked in plan
 func ApplyWithStatus(ctx context.Context, graph *load.Graph, plan []*PlanResult, status chan<- *StatusMessage) (results []*ApplyResult, err error) {
 	// transform checks into something we can look up easily

exec/applyresult.go

@@ -0,0 +1,67 @@
+// Copyright © 2016 Asteris, LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package exec
+
+import (
+	"bytes"
+	"strings"
+	"text/template"
+
+	"github.com/Sirupsen/logrus"
+	"github.com/acmacalister/skittles"
+)
+
+// ApplyResult contains the result of a resource check
+type ApplyResult struct {
+	Path      string
+	OldStatus string
+	NewStatus string
+	Success   bool
+}
+
+func (a *ApplyResult) string(pretty bool) string {
+	funcs := map[string]interface{}{
+		"plusOrMinus": plusOrMinus(pretty),
+		"redOrGreen": condFmt(pretty, func(in interface{}) string {
+			if a.Success {
+				return skittles.Green(in)
+			}
+			return skittles.Red(in)
+		}),
+		"trimNewline": func(in string) string { return strings.TrimSuffix(in, "\n") },
+	}
+	tmplStr := `{{plusOrMinus .Success}} {{redOrGreen .Path}}:
+	Status: "{{trimNewline .OldStatus}}" => "{{trimNewline .NewStatus}}"
+	Success: {{redOrGreen .Success}}`
+	tmpl := template.Must(template.New("").Funcs(funcs).Parse(tmplStr))
+
+	var buf bytes.Buffer
+	err := tmpl.Execute(&buf, a)
+	if err != nil {
+		logrus.WithError(err).Warn("error while outputting the result of `apply`")
+	}
+	return buf.String()
+}
+
+// Pretty pretty-prints an ApplyResult with ANSI terminal colors.
+func (a *ApplyResult) Pretty() string {
+	return a.string(true)
+}
+
+// String satisfies the Stringer interface, and is used to print a string
+// representation of a ApplyResult.
+func (a *ApplyResult) String() string {
+	return a.string(false)
+}

exec/applyresult_test.go

@@ -0,0 +1,54 @@
+// Copyright © 2016 Asteris, LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package exec_test
+
+import (
+	"testing"
+
+	"github.com/asteris-llc/converge/exec"
+	"github.com/stretchr/testify/assert"
+)
+
+var applyResult1 = &exec.ApplyResult{
+	Path:      "moduleC/submodule1",
+	OldStatus: "old",
+	NewStatus: "new",
+	Success:   true,
+}
+
+var applyResult2 = &exec.ApplyResult{
+	Path:      "moduleD/submodule1",
+	OldStatus: "old",
+	NewStatus: "old",
+	Success:   false,
+}
+
+func TestApplyResultString(t *testing.T) {
+	t.Parallel()
+
+	expected1 := "+ moduleC/submodule1:\n\tStatus: \"old\" => \"new\"\n\tSuccess: true"
+	expected2 := "- moduleD/submodule1:\n\tStatus: \"old\" => \"old\"\n\tSuccess: false"
+	assert.Equal(t, expected1, applyResult1.String())
+	assert.Equal(t, expected2, applyResult2.String())
+}
+
+func TestApplyResultPretty(t *testing.T) {
+	t.Parallel()
+
+	expected1 := "\x1b[32m+\x1b[0m \x1b[32mmoduleC/submodule1\x1b[0m:\n\tStatus: \"old\" => \"new\"\n\tSuccess: \x1b[32mtrue\x1b[0m"
+	expected2 := "\x1b[31m-\x1b[0m \x1b[31mmoduleD/submodule1\x1b[0m:\n\tStatus: \"old\" => \"old\"\n\tSuccess: \x1b[31mfalse\x1b[0m"
+	assert.Equal(t, expected1, applyResult1.Pretty())
+	assert.Equal(t, expected2, applyResult2.Pretty())
+}

exec/plan.go

@@ -15,7 +15,6 @@
 package exec
 
 import (
-	"fmt"
 	"sync"
 
 	"golang.org/x/net/context"
@@ -24,22 +23,6 @@ import (
 	"github.com/asteris-llc/converge/resource"
 )
 
-// PlanResult contains the result of a resource check
-type PlanResult struct {
-	Path          string
-	CurrentStatus string
-	WillChange    bool
-}
-
-func (p *PlanResult) String() string {
-	return fmt.Sprintf(
-		"%s:\n\tCurrently: %q\n\tWill Change: %t",
-		p.Path,
-		p.CurrentStatus,
-		p.WillChange,
-	)
-}
-
 // PlanWithStatus plans the operations to be performed and outputs status
 func PlanWithStatus(ctx context.Context, graph *load.Graph, status chan<- *StatusMessage) (results []*PlanResult, err error) {
 	lock := new(sync.Mutex)

exec/planresult.go

@@ -0,0 +1,66 @@
+// Copyright © 2016 Asteris, LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package exec
+
+import (
+	"bytes"
+	"strings"
+	"text/template"
+
+	"github.com/Sirupsen/logrus"
+	"github.com/acmacalister/skittles"
+)
+
+// PlanResult contains the result of a resource check
+type PlanResult struct {
+	Path          string
+	CurrentStatus string
+	WillChange    bool
+}
+
+func (p *PlanResult) string(pretty bool) string {
+	funcs := map[string]interface{}{
+		"plusOrMinus": plusOrMinus(pretty),
+		"blueOrYellow": condFmt(pretty, func(in interface{}) string {
+			if p.WillChange {
+				return skittles.Yellow(in)
+			}
+			return skittles.Blue(in)
+		}),
+		"trimNewline": func(in string) string { return strings.TrimSuffix(in, "\n") },
+	}
+	tmplStr := `{{plusOrMinus .WillChange}} {{blueOrYellow (trimNewline .Path)}}:
+	Currently: {{trimNewline .CurrentStatus}}
+	Will Change: {{blueOrYellow .WillChange}}`
+	tmpl := template.Must(template.New("").Funcs(funcs).Parse(tmplStr))
+
+	var buf bytes.Buffer
+	err := tmpl.Execute(&buf, p)
+	if err != nil {
+		logrus.WithError(err).Warn("error while outputting the result of `plan`")
+	}
+	return buf.String()
+}
+
+// Pretty pretty-prints a PlanResult with ANSI terminal colors.
+func (p *PlanResult) Pretty() string {
+	return p.string(true)
+}
+
+// String satisfies the Stringer interface, and is used to print a string
+// representation of a PlanResult.
+func (p *PlanResult) String() string {
+	return p.string(false)
+}

exec/planresult_test.go

@@ -0,0 +1,52 @@
+// Copyright © 2016 Asteris, LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package exec_test
+
+import (
+	"testing"
+
+	"github.com/asteris-llc/converge/exec"
+	"github.com/stretchr/testify/assert"
+)
+
+var planResult1 = &exec.PlanResult{
+	Path:          "moduleA/submodule1",
+	CurrentStatus: "status",
+	WillChange:    true,
+}
+
+var planResult2 = &exec.PlanResult{
+	Path:          "moduleB/submodule1",
+	CurrentStatus: "status",
+	WillChange:    false,
+}
+
+func TestPlanResultString(t *testing.T) {
+	t.Parallel()
+
+	expected1 := "+ moduleA/submodule1:\n\tCurrently: status\n\tWill Change: true"
+	expected2 := "- moduleB/submodule1:\n\tCurrently: status\n\tWill Change: false"
+	assert.Equal(t, expected1, planResult1.String())
+	assert.Equal(t, expected2, planResult2.String())
+}
+
+func TestPlanResultPretty(t *testing.T) {
+	t.Parallel()
+
+	expected1 := "\x1b[32m+\x1b[0m \x1b[33mmoduleA/submodule1\x1b[0m:\n\tCurrently: status\n\tWill Change: \x1b[33mtrue\x1b[0m"
+	expected2 := "\x1b[31m-\x1b[0m \x1b[34mmoduleB/submodule1\x1b[0m:\n\tCurrently: status\n\tWill Change: \x1b[34mfalse\x1b[0m"
+	assert.Equal(t, expected1, planResult1.Pretty())
+	assert.Equal(t, expected2, planResult2.Pretty())
+}