mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 04:48:33 +07:00
129 lines
2.9 KiB
Go
129 lines
2.9 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"
|
|
"github.com/terraform-docs/terraform-docs/terraform"
|
|
)
|
|
|
|
func TestToml(t *testing.T) {
|
|
tests := map[string]struct {
|
|
settings print.Settings
|
|
options terraform.Options
|
|
}{
|
|
// Base
|
|
"Base": {
|
|
settings: testutil.WithSections(),
|
|
options: terraform.Options{
|
|
ShowFooter: true,
|
|
FooterFromFile: "footer.md",
|
|
},
|
|
},
|
|
"Empty": {
|
|
settings: testutil.WithSections(),
|
|
options: terraform.Options{
|
|
Path: "empty",
|
|
},
|
|
},
|
|
"HideAll": {
|
|
settings: print.Settings{},
|
|
options: terraform.Options{
|
|
ShowHeader: false, // Since we don't show the header, the file won't be loaded at all
|
|
HeaderFromFile: "bad.tf",
|
|
},
|
|
},
|
|
|
|
// Settings
|
|
"OutputValues": {
|
|
settings: print.Settings{
|
|
ShowOutputs: true,
|
|
OutputValues: true,
|
|
ShowSensitivity: true,
|
|
},
|
|
options: terraform.Options{
|
|
OutputValues: true,
|
|
OutputValuesPath: "output_values.json",
|
|
},
|
|
},
|
|
|
|
// Only section
|
|
"OnlyDataSources": {
|
|
settings: print.Settings{ShowDataSources: true},
|
|
options: terraform.Options{},
|
|
},
|
|
"OnlyHeader": {
|
|
settings: print.Settings{ShowHeader: true},
|
|
options: terraform.Options{},
|
|
},
|
|
"OnlyFooter": {
|
|
settings: print.Settings{ShowFooter: true},
|
|
options: terraform.Options{
|
|
ShowFooter: true,
|
|
FooterFromFile: "footer.md",
|
|
},
|
|
},
|
|
"OnlyInputs": {
|
|
settings: print.Settings{ShowInputs: true},
|
|
options: terraform.Options{},
|
|
},
|
|
"OnlyOutputs": {
|
|
settings: print.Settings{ShowOutputs: true},
|
|
options: terraform.Options{},
|
|
},
|
|
"OnlyModulecalls": {
|
|
settings: print.Settings{ShowModuleCalls: true},
|
|
options: terraform.Options{},
|
|
},
|
|
"OnlyProviders": {
|
|
settings: print.Settings{ShowProviders: true},
|
|
options: terraform.Options{},
|
|
},
|
|
"OnlyRequirements": {
|
|
settings: print.Settings{ShowRequirements: true},
|
|
options: terraform.Options{},
|
|
},
|
|
"OnlyResources": {
|
|
settings: print.Settings{ShowResources: true},
|
|
options: terraform.Options{},
|
|
},
|
|
}
|
|
for name, tt := range tests {
|
|
t.Run(name, func(t *testing.T) {
|
|
assert := assert.New(t)
|
|
|
|
expected, err := testutil.GetExpected("toml", "toml-"+name)
|
|
assert.Nil(err)
|
|
|
|
options, err := terraform.NewOptions().With(&tt.options)
|
|
assert.Nil(err)
|
|
|
|
module, err := testutil.GetModule(options)
|
|
assert.Nil(err)
|
|
|
|
formatter := NewTOML(tt.settings.ToConfig())
|
|
|
|
err = formatter.Generate(module)
|
|
assert.Nil(err)
|
|
|
|
actual, err := formatter.ExecuteTemplate("")
|
|
|
|
assert.Nil(err)
|
|
assert.Equal(expected, actual)
|
|
})
|
|
}
|
|
}
|