-
Notifications
You must be signed in to change notification settings - Fork 64
/
docs.go
171 lines (157 loc) · 4.43 KB
/
docs.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
/*
Copyright 2021 The Knative Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package docs
import (
"fmt"
"go/ast"
"go/doc"
"go/parser"
"go/token"
"os"
"reflect"
"strings"
)
type OpenAPIRequired int
const (
Unknown OpenAPIRequired = iota
Optional
Required
)
// TODO: root needs to be dynamic based on where this is being executed in the context of gomod.
var root = "knative.dev/hack/schema"
func SetRoot(r string) {
root = r
}
func GetDocsForField(t reflect.Type, fieldName string) (string, OpenAPIRequired, error) {
pkg := t.PkgPath()
pm, err := makeParserMapForPackage(pkg)
if err != nil {
return "", Unknown, fmt.Errorf("unable to parse dir: %w", err)
}
p, present := pm[pkg]
if !present {
return "", Unknown, fmt.Errorf("package not present: %q", pkg)
}
dp := doc.New(p, pkg, 0)
for _, dt := range dp.Types {
if dt.Name == t.Name() {
for _, spec := range dt.Decl.Specs {
typeSpec, ok := spec.(*ast.TypeSpec)
if !ok {
continue
}
structType, ok := typeSpec.Type.(*ast.StructType)
if !ok {
continue
}
for _, field := range structType.Fields.List {
for _, name := range field.Names {
if fieldName == name.Name {
fieldDoc, isRequired := parseFieldDocs(field)
return fieldDoc, isRequired, nil
}
}
}
}
}
}
return "", Unknown, fmt.Errorf("did not find doc for %q", t.Name())
}
func ignoreDirectories(fi os.FileInfo) bool {
return !fi.IsDir()
}
var parserMapCache = map[string]*ast.Package{}
func makeParserMapForPackage(pkg string) (map[string]*ast.Package, error) {
fs := token.NewFileSet()
// pList is the list of packages to parse. As we parse one package, we will often encounter
// other packages that need to be parsed, adding them to this list.
pList := []string{strings.Replace(pkg, root, ".", 1)}
for len(pList) > 0 {
current := pList[0]
pList = pList[1:]
if _, ok := parserMapCache[current]; ok {
continue
}
if !strings.HasPrefix(current, root) &&
!strings.HasPrefix(current, ".") &&
!strings.HasPrefix(current, "vendor/") { // TODO: this will not work with go mod cache as written.
current = "vendor/" + current
}
spm, err := parser.ParseDir(fs, current, ignoreDirectories, parser.ParseComments)
if err != nil {
return parserMapCache, fmt.Errorf("error parse dir %q: %w", current, err)
}
for _, v := range spm {
localName := current
if strings.HasPrefix(localName, "./") {
localName = localName[2:]
}
name := fmt.Sprintf("%s/%s", root, localName)
name = strings.Replace(name, root+"/vendor/", "", 1)
parserMapCache[name] = v
}
fd, err := os.Open(current)
if err != nil {
return parserMapCache, fmt.Errorf("can't open: %w", err)
}
l, err := fd.Readdir(-1)
if err != nil {
return parserMapCache, fmt.Errorf("can't readdir: %w", err)
}
for _, f := range l {
if f.IsDir() {
pList = append(pList, fmt.Sprintf("%s/%s", current, f.Name()))
}
}
err = fd.Close()
if err != nil {
return parserMapCache, fmt.Errorf("can't close: %w", err)
}
}
return parserMapCache, nil
}
// parseFieldDocs parses the comments of a specific field. It attempts to figure out whether the
// comment says if this field is required or not.
func parseFieldDocs(f *ast.Field) (string, OpenAPIRequired) {
if f.Doc == nil {
return "", Unknown
}
var lines []string
docSaysRequired := Unknown
for _, line := range f.Doc.List {
l := strings.TrimPrefix(line.Text, "//")
l = strings.TrimSpace(l)
skip := false
switch strings.ToLower(l) {
case "+optional":
docSaysRequired = Optional
continue
case "+required":
docSaysRequired = Required
continue
}
if strings.HasPrefix(l, "+") {
// Not really a comment, normally alters the semantics of the field, like mergePatchKey.
continue
}
if strings.HasPrefix(l, "TODO") {
// Assume that from this forward is a TODO, not real docs.
skip = true
break
}
if !skip {
lines = append(lines, l)
}
}
return strings.Join(lines, " "), docSaysRequired
}