/
md.go
98 lines (88 loc) · 2.91 KB
/
md.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
// Copyright The OpenTelemetry 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 configschema // import "github.com/open-telemetry/opentelemetry-collector-contrib/lib/configschema"
import (
"errors"
"fmt"
"os"
"path/filepath"
"reflect"
"strings"
"text/template"
"go.opentelemetry.io/collector/otelcol"
)
func generateMDFile(factories otelcol.Factories, readComments commentReaderFunc, writeFile writeFileFunc, componentType, componentName string) error {
tableTmpl, err := tableTemplate()
if err != nil {
return err
}
ci, err := getCfgInfo(factories, componentType, componentName)
if err != nil {
return err
}
return writeMarkdown(tableTmpl, ci, writeFile, readComments)
}
func generateMDFiles(factories otelcol.Factories, readComments commentReaderFunc, writeFile writeFileFunc) error {
tableTmpl, err := tableTemplate()
if err != nil {
return err
}
infos := getAllCfgInfos(factories)
for _, ci := range infos {
err = writeMarkdown(tableTmpl, ci, writeFile, readComments)
if err != nil {
return fmt.Errorf("failed to write markdown for type: %s: %w", ci.Type, err)
}
}
return nil
}
type writeFileFunc func(v reflect.Value, data []byte) error
func writeMarkdown(tableTmpl *template.Template, ci cfgInfo, writeFile writeFileFunc, readComments commentReaderFunc) error {
v := reflect.ValueOf(ci.CfgInstance)
f, err := readFields(v, readComments)
if err != nil {
return fmt.Errorf("failed to read fields for type: %s: %w", ci.Type, err)
}
mdBytes := renderHeader(string(ci.Type), ci.Group, f.Doc)
f.Name = typeToName(f.Type)
tableBytes, err := renderTable(tableTmpl, f)
if err != nil {
return fmt.Errorf("failed to render table for type: %s: %w", ci.Type, err)
}
mdBytes = append(mdBytes, tableBytes...)
if hasTimeDuration(f) {
mdBytes = append(mdBytes, durationBlock...)
}
err = writeFile(v, mdBytes)
if err != nil {
return fmt.Errorf("failed to write file for type: %s: %w", ci.Type, err)
}
return nil
}
func typeToName(typ string) string {
idx := strings.IndexRune(typ, '.')
return typ[:idx]
}
type mdFileWriter struct {
dr dirResolver
}
func (w mdFileWriter) writeFile(v reflect.Value, bytes []byte) error {
dir := w.dr.reflectValueToProjectPath(v)
if dir == "" {
return errors.New("writeFile: skipping, local path not found for component")
}
fname := filepath.Join(dir, "config.md")
fmt.Printf("writing file: %s\n", fname)
return os.WriteFile(fname, bytes, 0600)
}