Extract and render output values from Terraform #191

gshel · 2020-02-06T20:03:05Z

Prerequisites

Put an x into the box(es) that apply:

This pull request fixes a bug.
This pull request adds a feature.
This pull request enhances existing functionality.
This pull request introduces breaking change.

For more information, see the Contributing Guide.

Description

This PR allows users to pass the global flag '--output-values PATH' to inject a project's outputs' values into the chosen format.

cd intoYourTF/project
terraform outputs --json > output_values.json
terraform-docs markdown table --output-values output_values.json

Issues Resolved

#165

Checklist

Put an x into all boxes that apply:

I have read the Contributing Guidelines.

Tests

I have added tests to cover my changes.
All tests pass when I run make test.

Documentation

My change requires a change to the documentation.
[TBD] I have updated the documentation accordingly.

Code Style

My code follows the code style of this project.

Pass empty string to CreateModule.outputValuePath

gshel · 2020-02-06T20:09:59Z

Some things I can think off of the top of my head that I would like to hear your input on:

If an output value is "" should that display as n/a?
If an output value is "" should json/yaml omit the empty field?
I looked over the documentation, noticing that there are not currently sections detailing flags. Since you marked my issue with the documentation label, I wanted to confirm that you'd like it added into the readme.
I have some clunky if/else statements that I'm wondering if there are alternative, elegant solutions for (e.g. internal/pkg/tfconf/module.go:142)

As for tests, I was hoping to get your feedback on the code first and then I will tackle those.

I appreciate your feedback; apologies in advance for n00b go questions :)

internal/pkg/print/pretty/pretty.go

khos2ow

That's awesome @gshel, thank you so much. I have some comments and suggestions bellow, please feel free to reach out before you start refactoring/applying changes, if you have any questions, suggestions or objections.

cmd/root.go

internal/pkg/print/markdown/table/table.go

internal/pkg/testutil/testing.go

internal/pkg/print/pretty/pretty.go

internal/pkg/tfconf/output.go

khos2ow · 2020-02-08T19:53:37Z

If an output value is "" should that display as n/a?

If an output value is "" should json/yaml omit the empty field?

We definitely should not drop the empty field, I don't have an answer for it at the moment, check out #191 (comment)

I looked over the documentation, noticing that there are not currently sections detailing flags. Since you marked my issue with the documentation label, I wanted to confirm that you'd like it added into the readme.

There are some documentation available here. I'm currently working on an enhancement to auto-generate that from whatever exists in cmd/. I put the documentation label to not forget about it.

I have some clunky if/else statements that I'm wondering if there are alternative, elegant solutions for (e.g. internal/pkg/tfconf/module.go:142)

That's true :) we need to address that after/with this #191 (comment)

Co-authored-by: Khosrow Moossavi <khos2ow@gmail.com>

* Auto generate formats document from examples * fix lint issues

Read the outputValuesPath from an env variable Use an env var with a path for '--output-values' Update Changelog Use an env var with a path for '--output-values' Update Changelog properly write output values for evrythng but yaml

internal/pkg/tmpl/template.go

internal/pkg/tfconf/module.go

internal/pkg/tfconf/output.go

…nto 165-output-values

khos2ow

Thank you @gshel for the hard work, this PR's starting to get shape! I have some comments below.

cmd/root.go

internal/pkg/print/markdown/table/table.go

internal/pkg/print/settings.go

internal/pkg/tfconf/module.go

internal/pkg/tmpl/template.go

internal/pkg/tfconf/module.go

internal/pkg/testutil/testing.go

gshel · 2020-02-15T21:07:16Z

I'm not sure how we can test --outputValues without including the path to my pre-generated output_values.json. I ran into issues running terraform output --json inside the examples folder because I'm using Terraform v0.12.19. Ideas?

internal/pkg/testutil/testing.go

internal/pkg/tfconf/output.go

internal/pkg/tmpl/template.go

internal/pkg/tfconf/module.go

internal/pkg/print/pretty/pretty.go

internal/pkg/tfconf/module.go

khos2ow

Almost finished, we're getting there! I have some small comments.

internal/pkg/testutil/testing.go

internal/pkg/tfconf/output.go

internal/pkg/tfconf/module.go

khos2ow

Thank you so much @gshel for the brilliant work ❤️

Allow users to pass '--output-values'

6c88539

Pass empty string to CreateModule.outputValuePath

gshel marked this pull request as ready for review February 6, 2020 20:03

gshel requested a review from khos2ow February 6, 2020 20:03

khos2ow added do-not-merge/wip new feature section/outputs labels Feb 6, 2020

khos2ow added this to the v0.9.0 milestone Feb 6, 2020

Fix bug causing 'pretty' tests to fail

847489f

gshel commented Feb 7, 2020

View reviewed changes

internal/pkg/print/pretty/pretty.go Outdated Show resolved Hide resolved

khos2ow requested changes Feb 8, 2020

View reviewed changes

khos2ow linked an issue Feb 10, 2020 that may be closed by this pull request

Inject terraform output into terraform-docs as an additional 'Value' field #165

Closed

2 tasks

iMartyn and others added 6 commits February 13, 2020 10:54

Link formats documentation in README (#181)

a6dc389

Co-authored-by: Khosrow Moossavi <khos2ow@gmail.com>

docs: Auto generate formats document from examples (#192)

a29c5eb

* Auto generate formats document from examples * fix lint issues

refactor: Add tfconf.Options to load Module with (#193)

cec24f8

Update Changelog

9181213

Allow users to pass '--output-values'

cff42c2

Read the outputValuesPath from an env variable Use an env var with a path for '--output-values' Update Changelog Use an env var with a path for '--output-values' Update Changelog properly write output values for evrythng but yaml

Fix failing json+yaml tests

14a74c9

gshel commented Feb 15, 2020

View reviewed changes

internal/pkg/tmpl/template.go Show resolved Hide resolved

gshel commented Feb 15, 2020

View reviewed changes

internal/pkg/tfconf/module.go Show resolved Hide resolved

gshel commented Feb 15, 2020

View reviewed changes

internal/pkg/tfconf/output.go Show resolved Hide resolved

Gretchen Shelby-Dormer and others added 5 commits February 14, 2020 19:10

Remove unneeded code block from output.go

5248368

Remove unused import statement from output.go

6039016

Merge branch 'master' into 165-output-values

d211a74

Fix some noob mistakes

2707fee

Merge branch '165-output-values' of github.com:gshel/terraform-docs i…

dd56c82

…nto 165-output-values

khos2ow reviewed Feb 15, 2020

View reviewed changes

internal/pkg/tfconf/module.go Outdated Show resolved Hide resolved

internal/pkg/tfconf/module.go Outdated Show resolved Hide resolved

Create two flags to use for output value injection

cef023d

Gretchen Shelby-Dormer added 4 commits February 15, 2020 12:20

Fix bug vanilla commands+build test to fail

9a6ce68

Modify all tests and add new for outputvalues

57a92b0

Modify to include many output types

db54401

Optimize imports to appease checkfmt

90a95af

gshel commented Feb 15, 2020

View reviewed changes

internal/pkg/testutil/testing.go Show resolved Hide resolved

Gretchen Shelby-Dormer added 2 commits February 15, 2020 15:40

Create loadOutputValues function

7513890

Fix linter issue

477cf50

khos2ow reviewed Feb 17, 2020

View reviewed changes

khos2ow changed the title ~~WIP: #165 Allow users to pass '--output-values'~~ Extract and render output values from Terraform Feb 17, 2020

Gretchen Shelby-Dormer added 2 commits February 18, 2020 15:48

Code review fixes. Hopefully the final commit!

c65d5bb

appease linter

6287ee4

khos2ow reviewed Feb 18, 2020

View reviewed changes

internal/pkg/testutil/testing.go Outdated Show resolved Hide resolved

internal/pkg/tfconf/output.go Outdated Show resolved Hide resolved

internal/pkg/tfconf/module.go Outdated Show resolved Hide resolved

Gretchen Shelby-Dormer added 3 commits February 18, 2020 17:18

Not allow sensitive output values to be injected

6e2a297

Remove trailing slash from tests

743ff24

Remove default values from --output-values-from

85e29fd

khos2ow approved these changes Feb 19, 2020

View reviewed changes

khos2ow removed the do-not-merge/wip label Feb 19, 2020

khos2ow merged commit 31cdef0 into terraform-docs:master Feb 19, 2020

khos2ow mentioned this pull request Feb 24, 2020

Show sensitivity of the output value in rendered result #207

Merged

10 tasks

Extract and render output values from Terraform #191

Extract and render output values from Terraform #191

Uh oh!

Conversation

gshel commented Feb 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Prerequisites

Description

Issues Resolved

Checklist

Tests

Documentation

Code Style

Uh oh!

gshel commented Feb 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

khos2ow left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

khos2ow commented Feb 8, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

khos2ow left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gshel commented Feb 15, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

khos2ow left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

khos2ow left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gshel commented Feb 6, 2020 •

edited

Loading

gshel commented Feb 6, 2020 •

edited

Loading

khos2ow left a comment •

edited

Loading