terraform-docs/format/markdown_document_test.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/print"
	"github.com/terraform-docs/terraform-docs/internal/testutil"
	"github.com/terraform-docs/terraform-docs/terraform"
)

func TestMarkdownDocument(t *testing.T) {
	tests := map[string]struct {
		settings print.Settings
		options  terraform.Options
	}{
		// Base
		"Base": {
			settings: testutil.WithSections(testutil.WithHTML()),
			options: terraform.Options{
				ShowFooter:     true,
				FooterFromFile: "footer.md",
			},
		},
		"Empty": {
			settings: testutil.WithSections(testutil.WithHTML()),
			options: terraform.Options{
				Path: "empty",
			},
		},
		"HideEmpty": {
			settings: testutil.WithSections(testutil.WithHideEmpty()),
			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
		"WithRequired": {
			settings: testutil.WithSections(
				testutil.WithHTML(),
				print.Settings{
					ShowRequired: true,
				},
			),
			options: terraform.Options{
				ShowFooter:     true,
				FooterFromFile: "footer.md",
			},
		},
		"WithAnchor": {
			settings: testutil.WithSections(
				testutil.WithHTML(),
				print.Settings{
					ShowAnchor: true,
				},
			),
			options: terraform.Options{
				ShowFooter:     true,
				FooterFromFile: "footer.md",
			},
		},
		"WithoutHTML": {
			settings: testutil.WithSections(
				print.Settings{
					ShowHTML: false,
				},
			),
			options: terraform.Options{
				ShowFooter:     true,
				FooterFromFile: "footer.md",
			},
		},
		"WithoutHTMLWithAnchor": {
			settings: testutil.WithSections(
				print.Settings{
					ShowHTML:   false,
					ShowAnchor: true,
				},
			),
			options: terraform.Options{
				ShowFooter:     true,
				FooterFromFile: "footer.md",
			},
		},
		"WithoutDefault": {
			settings: testutil.WithHTML(
				print.Settings{
					ShowInputs:  true,
					ShowDefault: false,
					ShowType:    true,
				},
			),
			options: terraform.Options{},
		},
		"WithoutType": {
			settings: testutil.WithHTML(
				print.Settings{
					ShowInputs:  true,
					ShowDefault: true,
					ShowType:    false,
				},
			),
			options: terraform.Options{},
		},
		"EscapeCharacters": {
			settings: testutil.WithSections(
				testutil.WithHTML(),
				print.Settings{
					EscapeCharacters: true,
				},
			),
			options: terraform.Options{
				ShowFooter:     true,
				FooterFromFile: "footer.md",
			},
		},
		"IndentationOfFour": {
			settings: testutil.WithSections(
				testutil.WithHTML(),
				print.Settings{
					IndentLevel: 4,
				},
			),
			options: terraform.Options{
				ShowFooter:     true,
				FooterFromFile: "footer.md",
			},
		},
		"OutputValues": {
			settings: testutil.WithHTML(
				print.Settings{
					ShowOutputs:     true,
					OutputValues:    true,
					ShowSensitivity: true,
				},
			),
			options: terraform.Options{
				OutputValues:     true,
				OutputValuesPath: "output_values.json",
			},
		},
		"OutputValuesNoSensitivity": {
			settings: testutil.WithHTML(
				print.Settings{
					ShowOutputs:     true,
					OutputValues:    true,
					ShowSensitivity: false,
				},
			),
			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: testutil.WithHTML(
				print.Settings{
					ShowInputs:  true,
					ShowDefault: true,
					ShowType:    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("markdown", "document-"+name)
			assert.Nil(err)

			options, err := terraform.NewOptions().With(&tt.options)
			assert.Nil(err)

			module, err := testutil.GetModule(options)
			assert.Nil(err)

			formatter := NewMarkdownDocument(&tt.settings)

			generator, err := formatter.Generate(module)
			assert.Nil(err)

			actual, err := generator.ExecuteTemplate("")

			assert.Nil(err)
			assert.Equal(expected, actual)
		})
	}
}