terraform-plugin-docs/internal/check/frontmatter_test.go at d2947df19f65a46fe8980cf28a4432c136cb3cf4 · hashicorp/terraform-plugin-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package check

import (
	"testing"
)

func TestFrontMatterCheck(t *testing.T) {
	t.Parallel()
	testCases := map[string]struct {
		Source      string
		Options     *FrontMatterOptions
		ExpectError bool
	}{
		"empty source": {
			Source:      ``,
			ExpectError: true,
		},
		"valid YAML with default options": {
			Source: `
---
description: |-
 Example description
layout: "example"
page_title: Example Page Title
subcategory: Example Subcategory
---
`,
		},
		"valid YAML section and Markdown with default options": {
			Source: `
---
description: |-
 Example description
layout: "example"
page_title: Example Page Title
subcategory: Example Subcategory
---

# Markdown here we go!
`,
		},
		"invalid YAML": {
			Source: `
description: |-
 Example description
Extraneous newline
`,
			ExpectError: true,
		},
		"no layout option": {
			Source: `
description: |-
 Example description
layout: "example"
page_title: Example Page Title
subcategory: Example Subcategory
`,
			Options: &FrontMatterOptions{
				NoLayout: true,
			},
			ExpectError: true,
		},
		"no page_title option": {
			Source: `
description: |-
 Example description
layout: "example"
page_title: Example Page Title
subcategory: Example Subcategory
`,
			Options: &FrontMatterOptions{
				NoPageTitle: true,
			},
			ExpectError: true,
		},
		"no sidebar_current option": {
			Source: `
description: |-
 Example description
layout: "example"
page_title: Example Page Title
sidebar_current: "example_resource"
subcategory: Example Subcategory
`,
			Options: &FrontMatterOptions{
				NoSidebarCurrent: true,
			},
			ExpectError: true,
		},
		"no subcategory option": {
			Source: `
description: |-
 Example description
layout: "example"
page_title: Example Page Title
subcategory: Example Subcategory
`,
			Options: &FrontMatterOptions{
				NoSubcategory: true,
			},
			ExpectError: true,
		},
		"require description option": {
			Source: `
layout: "example"
page_title: Example Page Title
subcategory: Example Subcategory
`,
			Options: &FrontMatterOptions{
				RequireDescription: true,
			},
			ExpectError: true,
		},
		"require layout option": {
			Source: `
description: |-
 Example description
page_title: Example Page Title
subcategory: Example Subcategory
`,
			Options: &FrontMatterOptions{
				RequireLayout: true,
			},
			ExpectError: true,
		},
		"require page_title option": {
			Source: `
description: |-
 Example description
layout: "example"
subcategory: Example Subcategory
`,
			Options: &FrontMatterOptions{
				RequirePageTitle: true,
			},
			ExpectError: true,
		},
	}

	for name, testCase := range testCases {
		t.Run(name, func(t *testing.T) {
			t.Parallel()

			got := NewFrontMatterCheck(testCase.Options).Run([]byte(testCase.Source))

			if got == nil && testCase.ExpectError {
				t.Errorf("expected error, got no error")
			}

			if got != nil && !testCase.ExpectError {
				t.Errorf("expected no error, got error: %s", got)
			}
		})
	}
}