/
render.go
277 lines (236 loc) · 6 KB
/
render.go
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
package main
import (
"bufio"
"bytes"
"fmt"
"go/format"
"io"
"io/fs"
"os"
"path/filepath"
"regexp"
"strings"
)
func render(rootDir, providerName string, specs []*docFileSpec) error {
if err := writeImportScripts(rootDir, providerName, specs); err != nil {
return fmt.Errorf("could not write import scripts: %w", err)
}
if err := writeTerraformExamples(rootDir, providerName, specs); err != nil {
return fmt.Errorf("could not write Terraform examples: %w", err)
}
if err := processGoFiles(rootDir, providerName, specs); err != nil {
return fmt.Errorf("could not process Golang files: %w", err)
}
return nil
}
func writeImportScripts(rootDir, providerName string, specs []*docFileSpec) error {
for _, spec := range specs {
if spec.ImportComment == "" || spec.ImportCommand == "" {
continue
}
var buf bytes.Buffer
scanner := bufio.NewScanner(strings.NewReader(spec.ImportComment))
for scanner.Scan() {
buf.WriteByte('#')
if len(scanner.Bytes()) > 0 {
buf.WriteByte(' ')
buf.Write(bytes.TrimSpace(scanner.Bytes()))
}
buf.WriteByte('\n')
}
buf.WriteString(spec.ImportCommand)
buf.WriteByte('\n')
exampleDir := filepath.Join(rootDir, "examples", spec.parent, fmt.Sprintf("%s_%s", providerName, spec.name))
if err := os.MkdirAll(exampleDir, 0755); err != nil {
return err
}
err := func() error {
f, err := os.Create(filepath.Join(exampleDir, "import.sh"))
if err != nil {
return err
}
defer f.Close()
if _, err := buf.WriteTo(f); err != nil {
return err
}
return nil
}()
if err != nil {
return err
}
}
return nil
}
func processGoFiles(rootDir, providerName string, specs []*docFileSpec) error {
goFilenameToSpec := make(map[string]*docFileSpec)
for _, spec := range specs {
switch spec.parent {
case "resources":
goFilenameToSpec[fmt.Sprintf("resource_%s_%s.go", providerName, spec.name)] = spec
case "data-sources":
goFilenameToSpec[fmt.Sprintf("data_source_%s_%s.go", providerName, spec.name)] = spec
}
}
return filepath.WalkDir(rootDir, func(path string, d fs.DirEntry, err error) error {
if d.IsDir() {
return nil
}
spec := goFilenameToSpec[filepath.Base(path)]
if spec == nil {
return nil
}
src, err := os.ReadFile(path)
if err != nil {
return err
}
b, err := rewriteGoContents(src, spec)
if err != nil {
return fmt.Errorf("could not rewrite Golang file contents for file %q: %w", path, err)
}
if err := os.Remove(path); err != nil {
return err
}
return os.WriteFile(path, b, 0644)
})
}
func rewriteGoContents(src []byte, spec *docFileSpec) ([]byte, error) {
attributeKeyPattern := regexp.MustCompile(`"([a-z_]+)": {`)
typePattern := regexp.MustCompile(`Type:\s+schema.[A-Za-z]+,`)
resourcePattern := regexp.MustCompile(`return &schema\.Resource{`)
scanner := bufio.NewScanner(bytes.NewReader(src))
var buf bytes.Buffer
var attributeDescription string
for scanner.Scan() {
writeLine := func() func() {
wrote := false
return func() {
if wrote {
return
}
buf.Write(scanner.Bytes())
buf.WriteByte('\n')
wrote = true
}
}()
if m := attributeKeyPattern.FindSubmatch(scanner.Bytes()); m != nil {
attributeDescription = spec.attributes[string(m[1])]
}
if attributeDescription != "" && typePattern.Match(scanner.Bytes()) {
writeDescriptionLine(&buf, attributeDescription, false)
attributeDescription = ""
}
if resourcePattern.Match(scanner.Bytes()) {
writeLine()
writeDescriptionLine(&buf, spec.resourceDescription, true)
}
if !strings.Contains(scanner.Text(), `Description:`) {
writeLine()
}
}
formatted, err := format.Source(buf.Bytes())
if err != nil {
return nil, fmt.Errorf("could not format source code: %w", err)
}
return formatted, nil
}
func writeDescriptionLine(buf *bytes.Buffer, description string, doubleNewline bool) {
if description == "" {
return
}
buf.WriteString(`Description: "`)
var lastCh rune
for _, ch := range description {
if ch == '\r' {
continue
}
if lastCh == '\n' && ch != '\n' {
buf.WriteString("\" +\n\"")
}
switch ch {
case '\n':
buf.WriteString(`\n`)
case '"':
buf.WriteString(`\"`)
case '\\':
buf.WriteString(`\\`)
default:
buf.WriteRune(ch)
}
lastCh = ch
}
buf.WriteString("\",\n")
if doubleNewline {
buf.WriteByte('\n')
}
}
func writeTerraformExamples(rootDir, providerName string, specs []*docFileSpec) error {
for _, spec := range specs {
exampleDir := filepath.Join(rootDir, "examples", spec.parent, fmt.Sprintf("%s_%s", providerName, spec.name))
if err := os.MkdirAll(exampleDir, 0755); err != nil {
return err
}
err := func() error {
f, err := os.Create(filepath.Join(exampleDir, spec.parent[:len(spec.parent)-1]+".tf"))
if err != nil {
return err
}
defer f.Close()
return writeTerraformExample(f, spec.example)
}()
if err != nil {
return err
}
}
return nil
}
func writeTerraformExample(f io.Writer, example string) error {
code := false
scanner := bufio.NewScanner(strings.NewReader(example))
afterCodeBlock := false
for scanner.Scan() {
if len(scanner.Bytes()) == 0 && !code {
continue
}
if strings.Contains(scanner.Text(), "```") {
if code {
afterCodeBlock = true
}
code = !code
continue
}
if code {
if afterCodeBlock {
if _, err := f.Write([]byte{'\n'}); err != nil {
return err
}
afterCodeBlock = false
}
if _, err := f.Write(scanner.Bytes()); err != nil {
return err
}
if _, err := f.Write([]byte{'\n'}); err != nil {
return err
}
} else {
comment := bytes.TrimSpace(bytes.Trim(scanner.Bytes(), "*#"))
if string(comment) != "Example Usage" {
if afterCodeBlock {
if _, err := f.Write([]byte{'\n'}); err != nil {
return err
}
afterCodeBlock = false
}
if _, err := f.Write([]byte("# ")); err != nil {
return err
}
if _, err := f.Write(comment); err != nil {
return err
}
if _, err := f.Write([]byte{'\n'}); err != nil {
return err
}
}
}
}
return nil
}