terraform-plugin-docs/internal/check/directory_test.go at 0bf1b9c9437e72f2e2db4ce03a4816106932f320 · 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
159
160
161
// Copyright IBM Corp. 2020, 2026
// SPDX-License-Identifier: MPL-2.0

package check

import (
	"io/fs"
	"testing"
	"testing/fstest"

	"github.com/bmatcuk/doublestar/v4"
)

var DocumentationGlobPattern = `{docs/index.*,docs/{,cdktf/}{actions,data-sources,ephemeral-resources,guides,list-resources,resources,functions}/**/*,website/docs/**/*}`

func TestMixedDirectoriesCheck(t *testing.T) {
	t.Parallel()
	testCases := map[string]struct {
		ProviderFS  fs.FS
		ExpectError bool
	}{
		"valid mixed directories": {
			ProviderFS: fstest.MapFS{
				"docs/nonregistrydocs/thing.md": {},
				"website/docs/index.md":         {},
			},
		},
		"valid mixed directories - cdktf": {
			ProviderFS: fstest.MapFS{
				"docs/cdktf/typescript/index.md": {},
				"website/docs/index.md":          {},
			},
		},
		"invalid mixed directories - registry action": {
			ProviderFS: fstest.MapFS{
				"docs/actions/invalid.md": {},
				"website/docs/index.md":   {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - registry data source": {
			ProviderFS: fstest.MapFS{
				"docs/data-sources/invalid.md": {},
				"website/docs/index.md":        {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - registry ephemeral resource": {
			ProviderFS: fstest.MapFS{
				"docs/ephemeral-resources/invalid.md": {},
				"website/docs/index.md":               {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - registry list resource": {
			ProviderFS: fstest.MapFS{
				"docs/list-resources/invalid.md": {},
				"website/docs/index.md":          {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - registry resource": {
			ProviderFS: fstest.MapFS{
				"docs/resources/invalid.md": {},
				"website/docs/index.md":     {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - registry guide": {
			ProviderFS: fstest.MapFS{
				"docs/guides/invalid.md": {},
				"website/docs/index.md":  {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - registry function": {
			ProviderFS: fstest.MapFS{
				"docs/functions/invalid.md": {},
				"website/docs/index.md":     {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - legacy action": {
			ProviderFS: fstest.MapFS{
				"website/docs/actions/invalid.html.markdown": {},
				"docs/resources/thing.md":                    {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - legacy data source": {
			ProviderFS: fstest.MapFS{
				"website/docs/d/invalid.html.markdown": {},
				"docs/resources/thing.md":              {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - legacy ephemeral resource": {
			ProviderFS: fstest.MapFS{
				"website/docs/ephemeral-resources/invalid.html.markdown": {},
				"docs/resources/thing.md":                                {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - legacy list resource": {
			ProviderFS: fstest.MapFS{
				"website/docs/list-resources/invalid.html.markdown": {},
				"docs/resources/thing.md":                           {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - legacy resource": {
			ProviderFS: fstest.MapFS{
				"website/docs/r/invalid.html.markdown": {},
				"docs/resources/thing.md":              {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - legacy guide": {
			ProviderFS: fstest.MapFS{
				"website/docs/guides/invalid.html.markdown": {},
				"docs/resources/thing.md":                   {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - legacy function": {
			ProviderFS: fstest.MapFS{
				"website/docs/functions/invalid.html.markdown": {},
				"docs/resources/thing.md":                      {},
			},
			ExpectError: true,
		},
		"invalid mixed directories - legacy index": {
			ProviderFS: fstest.MapFS{
				"website/docs/index.html.markdown": {},
				"docs/resources/thing.md":          {},
			},
			ExpectError: true,
		},
	}

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

			files, err := doublestar.Glob(testCase.ProviderFS, DocumentationGlobPattern)
			if err != nil {
				t.Fatalf("error finding documentation files: %s", err)
			}

			got := MixedDirectoriesCheck(files)

			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)
			}
		})
	}
}