mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
465dd14cff
Add one extra special variable the `content`:
- `{{ .Module }}`
As opposed to the other variables, which are generated sections based on
a selected formatter, the `{{ .Module }}` variable is just a `struct`
representing a Terraform module.
It can be used to build highly complex and highly customized content:
```yaml
content: |-
## Resources
{{ range .Module.Resources }}
- {{ .GetMode }}.{{ .Spec }} ({{ .Position.Filename }}#{{ .Position.Line }})
{{- end }}
```
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
112 lines
2.7 KiB
Go
112 lines
2.7 KiB
Go
/*
|
|
Copyright 2021 The terraform-docs Authors.
|
|
|
|
Licensed under the MIT license (the "License"); you may not
|
|
use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at the LICENSE file in
|
|
the root directory of this source tree.
|
|
*/
|
|
|
|
package format
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"github.com/terraform-docs/terraform-docs/internal/testutil"
|
|
"github.com/terraform-docs/terraform-docs/print"
|
|
)
|
|
|
|
func TestPretty(t *testing.T) {
|
|
tests := map[string]struct {
|
|
config print.Config
|
|
}{
|
|
// Base
|
|
"Base": {
|
|
config: testutil.WithSections(),
|
|
},
|
|
"Empty": {
|
|
config: testutil.WithDefaultSections(
|
|
testutil.With(func(c *print.Config) {
|
|
c.ModuleRoot = "empty"
|
|
}),
|
|
),
|
|
},
|
|
"HideAll": {
|
|
config: testutil.With(func(c *print.Config) {
|
|
c.Sections.Header = false // Since we don't show the header, the file won't be loaded at all
|
|
c.HeaderFrom = "bad.tf"
|
|
}),
|
|
},
|
|
|
|
// Settings
|
|
"WithColor": {
|
|
config: testutil.WithSections(
|
|
testutil.With(func(c *print.Config) {
|
|
c.Settings.Color = true
|
|
}),
|
|
),
|
|
},
|
|
"OutputValues": {
|
|
config: testutil.With(func(c *print.Config) {
|
|
c.Sections.Outputs = true
|
|
c.OutputValues.Enabled = true
|
|
c.OutputValues.From = "output_values.json"
|
|
c.Settings.Sensitive = true
|
|
}),
|
|
},
|
|
|
|
// Only section
|
|
"OnlyDataSources": {
|
|
config: testutil.With(func(c *print.Config) { c.Sections.DataSources = true }),
|
|
},
|
|
"OnlyHeader": {
|
|
config: testutil.With(func(c *print.Config) { c.Sections.Header = true }),
|
|
},
|
|
"OnlyFooter": {
|
|
config: testutil.With(func(c *print.Config) {
|
|
c.Sections.Footer = true
|
|
c.FooterFrom = "footer.md"
|
|
}),
|
|
},
|
|
"OnlyInputs": {
|
|
config: testutil.With(func(c *print.Config) { c.Sections.Inputs = true }),
|
|
},
|
|
"OnlyOutputs": {
|
|
config: testutil.With(func(c *print.Config) { c.Sections.Outputs = true }),
|
|
},
|
|
"OnlyModulecalls": {
|
|
config: testutil.With(func(c *print.Config) { c.Sections.ModuleCalls = true }),
|
|
},
|
|
"OnlyProviders": {
|
|
config: testutil.With(func(c *print.Config) { c.Sections.Providers = true }),
|
|
},
|
|
"OnlyRequirements": {
|
|
config: testutil.With(func(c *print.Config) { c.Sections.Requirements = true }),
|
|
},
|
|
"OnlyResources": {
|
|
config: testutil.With(func(c *print.Config) { c.Sections.Resources = true }),
|
|
},
|
|
}
|
|
for name, tt := range tests {
|
|
t.Run(name, func(t *testing.T) {
|
|
assert := assert.New(t)
|
|
|
|
expected, err := testutil.GetExpected("pretty", "pretty-"+name)
|
|
assert.Nil(err)
|
|
|
|
module, err := testutil.GetModule(&tt.config)
|
|
assert.Nil(err)
|
|
|
|
formatter := NewPretty(&tt.config)
|
|
|
|
err = formatter.Generate(module)
|
|
assert.Nil(err)
|
|
|
|
assert.Equal(expected, formatter.Content())
|
|
})
|
|
}
|
|
}
|