Merge pull request #11 from mdb/html-output

mdb · web-flow · commit 41d790d413de · 2021-09-21T16:32:21.000-04:00
add support for '-output html' option
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-VERSION = 0.1.0
+VERSION = 0.1.1
 SOURCE = ./...
 
 .PHONY: help \
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ A CLI to generate Terraform outputs documentation.
 ## What's the use case?
 
 `terraputs` analyzes the contents of a [terraform state](https://www.terraform.io/docs/language/state/index.html)
-file and generates Markdown documentation from its [outputs](https://www.terraform.io/docs/language/values/outputs.html).
+file and generates Markdown or HTML documentation from its [outputs](https://www.terraform.io/docs/language/values/outputs.html).
 
 A common workflow might execute `terraputs -state $(terraform show -json) > outputs.md` after each
 invocation of `terraform apply`, then commit `outputs.md` to source control or publish its contents to
@@ -17,6 +17,19 @@ offer up-to-date documentation about resources managed by a Terraform project.
 
 ## Usage
 
+```
+terraputs -h
+Usage of terraputs:
+  -heading string
+        Optional; the heading text for use in the printed output. (default "Outputs")
+  -output string
+        Optional; the output format. Supported values: md, html. (default "md")
+  -state string
+        Optional; the state JSON output by 'terraform show -json'. Read from stdin if omitted
+  -state-file string
+        Optional; the path to a local file containing 'terraform show -json' output
+```
+
 A few typical usage examples:
 
 ```
@@ -31,7 +44,11 @@ terraform show -json | terraputs -heading "Terraform Outputs"
 terraputs < terraform.tfstate
 ```
 
-Example output:
+### Results examples
+
+<details>
+
+<summary>Example markdown output</summary>
 
 ```
 # Terraform Outputs
@@ -47,20 +64,15 @@ Terraform state outputs.
 | a_string | foo | string
 ```
 
-## More options
+</details>
 
-```
-terraputs -h
-Usage of terraputs:
-  -heading string
-        Optional; the heading text for use in the printed markdown (default "Outputs")
-  -state string
-        Optional; the state JSON output by 'terraform show -json', read from stdin if omitted
-  -state-file string
-        Optional; the path to a local file containing 'terraform show -json' output
-```
+<details>
+
+<summary>Markdown output rendered via GitHub-flavored markdown</summary>
+
+# Terraform Outputs
 
-## Example output table formatted by GitHub
+Terraform state outputs.
 
 | Output | Value | Type
 | --- | --- | --- |
@@ -70,10 +82,125 @@ Usage of terraputs:
 | a_sensitive_value | sensitive; redacted | string
 | a_string | foo | string
 
-## TODO
+</details>
+
+<details>
+
+<summary>Example HTML output</summary>
+
+```html
+<h2>Outputs</h2>
+<p>Terraform state outputs.</p>
+<table>
+  <tr>
+    <th>Output</th>
+    <th>Value</th>
+    <th>Type</th>
+  </tr>
+
+  <tr>
+    <td>a_basic_map</td>
+    <td><pre>{
+  "foo": "bar",
+  "number": 42
+}</pre></td>
+    <td>map[string]interface {}</td>
+  </tr>
+
+  <tr>
+    <td>a_list</td>
+    <td><pre>[
+  "foo",
+  "bar"
+]</pre></td>
+    <td>[]interface {}</td>
+  </tr>
+
+  <tr>
+    <td>a_nested_map</td>
+    <td><pre>{
+  "baz": {
+    "bar": "baz",
+    "id": "123"
+  },
+  "foo": "bar",
+  "number": 42
+}</pre></td>
+    <td>map[string]interface {}</td>
+  </tr>
+
+  <tr>
+    <td>a_sensitive_value</td>
+    <td><pre>sensitive; redacted</pre></td>
+    <td>string</td>
+  </tr>
+
+  <tr>
+    <td>a_string</td>
+    <td><pre>"foo"</pre></td>
+    <td>string</td>
+  </tr>
+
+</table>
+```
 
-* provide the ability to pass a custom template
-* improve the formatting and readability of lists and maps
-* create automated releases
-* create a GitHub Action
-* publish an OCI image
+</details>
+
+<details>
+<summary>HTML output rendered via GitHub-flavored markdown</summary>
+
+<h2>Outputs</h2>
+<p>Terraform state outputs.</p>
+<table>
+  <tr>
+    <th>Output</th>
+    <th>Value</th>
+    <th>Type</th>
+  </tr>
+
+  <tr>
+    <td>a_basic_map</td>
+    <td><pre>{
+  "foo": "bar",
+  "number": 42
+}</pre></td>
+    <td>map[string]interface {}</td>
+  </tr>
+
+  <tr>
+    <td>a_list</td>
+    <td><pre>[
+  "foo",
+  "bar"
+]</pre></td>
+    <td>[]interface {}</td>
+  </tr>
+
+  <tr>
+    <td>a_nested_map</td>
+    <td><pre>{
+  "baz": {
+    "bar": "baz",
+    "id": "123"
+  },
+  "foo": "bar",
+  "number": 42
+}</pre></td>
+    <td>map[string]interface {}</td>
+  </tr>
+
+  <tr>
+    <td>a_sensitive_value</td>
+    <td><pre>sensitive; redacted</pre></td>
+    <td>string</td>
+  </tr>
+
+  <tr>
+    <td>a_string</td>
+    <td><pre>"foo"</pre></td>
+    <td>string</td>
+  </tr>
+
+</table>
+
+</details>
diff --git a/main.go b/main.go
@@ -25,11 +25,14 @@ var (
 )
 
 const (
-	stateDesc      string = "Optional; the state JSON output by 'terraform show -json', read from stdin if omitted"
+	stateDesc      string = "Optional; the state JSON output by 'terraform show -json'. Read from stdin if omitted"
 	stateFileDesc  string = "Optional; the path to a local file containing 'terraform show -json' output"
-	headingDesc    string = "Optional; the heading text for use in the printed markdown"
+	headingDesc    string = "Optional; the heading text for use in the printed output."
+	outputDesc     string = "Optional; the output format. Supported values: md, html."
 	versionDesc    string = "Print the current version and exit"
 	defaultHeading string = "Outputs"
+	defaultOutput  string = "md"
+	sensitive      string = "sensitive; redacted"
 )
 
 type data struct {
@@ -39,12 +42,25 @@ type data struct {
 
 func value(output tfjson.StateOutput) string {
 	if output.Sensitive {
-		return "sensitive; redacted"
+		return sensitive
 	}
 
 	return fmt.Sprintf("%v", output.Value)
 }
 
+func prettyPrintValue(output tfjson.StateOutput) template.HTML {
+	if output.Sensitive {
+		return template.HTML(sensitive)
+	}
+
+	pretty, err := json.MarshalIndent(output.Value, "", "  ")
+	if err != nil {
+		exit(err)
+	}
+
+	return template.HTML(string(pretty))
+}
+
 func dataType(output tfjson.StateOutput) string {
 	return fmt.Sprintf("%T", output.Value)
 }
@@ -53,6 +69,7 @@ func main() {
 	stateJSON := flag.String("state", "", stateDesc)
 	stateFile := flag.String("state-file", "", stateFileDesc)
 	heading := flag.String("heading", defaultHeading, headingDesc)
+	output := flag.String("output", defaultOutput, outputDesc)
 	flag.Parse()
 
 	args := flag.Args()
@@ -84,10 +101,16 @@ func main() {
 		exit(err)
 	}
 
-	t, err := template.New("markdown.tmpl").Funcs(template.FuncMap{
-		"value":    value,
-		"dataType": dataType,
-	}).ParseFS(templates, "templates/markdown.tmpl")
+	tmpl, err := getTemplatePath(*output)
+	if err != nil {
+		exit(err)
+	}
+
+	t, err := template.New(strings.Split(tmpl, "/")[1]).Funcs(template.FuncMap{
+		"value":       value,
+		"dataType":    dataType,
+		"prettyPrint": prettyPrintValue,
+	}).ParseFS(templates, tmpl)
 	if err != nil {
 		exit(err)
 	}
@@ -106,6 +129,17 @@ func main() {
 	}
 }
 
+func getTemplatePath(output string) (string, error) {
+	switch output {
+	case "html":
+		return "templates/html.tmpl", nil
+	case "md":
+		return "templates/markdown.tmpl", nil
+	default:
+		return "", fmt.Errorf("'%s' is not a supported output format. Supported formats: 'md' (default), 'html'", output)
+	}
+}
+
 func exit(err error) {
 	fmt.Fprintf(os.Stderr, "%s", err.Error())
 	os.Exit(1)
diff --git a/main_test.go b/main_test.go
@@ -37,6 +37,8 @@ func TestHelpFlag(t *testing.T) {
 		stateFileDesc,
 		"-heading string",
 		headingDesc,
+		"-output string",
+		outputDesc,
 	}
 
 	tests := []struct {
@@ -195,6 +197,63 @@ Terraform state outputs.
 
 `,
 	}, {
+		command: `./terraputs -state-file testdata/basic/show.json -heading foo -output html`,
+		expectedOutput: `<h2>foo</h2>
+<p>Terraform state outputs.</p>
+<table>
+  <tr>
+    <th>Output</th>
+    <th>Value</th>
+    <th>Type</th>
+  </tr>
+
+  <tr>
+    <td>a_basic_map</td>
+    <td><pre>{
+  "foo": "bar",
+  "number": 42
+}</pre></td>
+    <td>map[string]interface {}</td>
+  </tr>
+
+  <tr>
+    <td>a_list</td>
+    <td><pre>[
+  "foo",
+  "bar"
+]</pre></td>
+    <td>[]interface {}</td>
+  </tr>
+
+  <tr>
+    <td>a_nested_map</td>
+    <td><pre>{
+  "baz": {
+    "bar": "baz",
+    "id": "123"
+  },
+  "foo": "bar",
+  "number": 42
+}</pre></td>
+    <td>map[string]interface {}</td>
+  </tr>
+
+  <tr>
+    <td>a_sensitive_value</td>
+    <td><pre>sensitive; redacted</pre></td>
+    <td>string</td>
+  </tr>
+
+  <tr>
+    <td>a_string</td>
+    <td><pre>"foo"</pre></td>
+    <td>string</td>
+  </tr>
+
+</table>
+`,
+	}, {
+
 		command: `./terraputs -state-file testdata/nooutputs/show.json -heading foo`,
 		expectedOutput: `# foo
 
@@ -222,6 +281,10 @@ Terraform state outputs.
 		command:        `./terraputs -state $(cat testdata/basic/show.json) -state-file testdata/basic/show.json -heading foo`,
 		expectedError:  errors.New("exit status 1"),
 		expectedOutput: "'-state' and '-state-file' are mutually exclusive; specify just one",
+	}, {
+		command:        `./terraputs -state $(cat testdata/basic/show.json) -output foo`,
+		expectedError:  errors.New("exit status 1"),
+		expectedOutput: "'foo' is not a supported output format. Supported formats: 'md' (default), 'html'",
 	}}
 
 	for _, test := range tests {
diff --git a/templates/html.tmpl b/templates/html.tmpl
@@ -0,0 +1,16 @@
+<h2>{{ .Heading }}</h2>
+<p>Terraform state outputs.</p>
+<table>
+  <tr>
+    <th>Output</th>
+    <th>Value</th>
+    <th>Type</th>
+  </tr>
+{{ range $key, $value := .Outputs }}
+  <tr>
+    <td>{{ $key }}</td>
+    <td><pre>{{ prettyPrint $value }}</pre></td>
+    <td>{{ dataType $value }}</td>
+  </tr>
+{{ end }}
+</table>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-VERSION = 0.1.0`
	`1`	`+VERSION = 0.1.1`
`2`	`2`	`SOURCE = ./...`
`3`	`3`
`4`	`4`	`.PHONY: help \`