/
docs.go
102 lines (91 loc) · 3.35 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
// 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 componenttest
import (
"fmt"
"go/parser"
"go/token"
"os"
"path/filepath"
"strings"
)
const (
readMeFileName = "README.md"
)
// CheckDocs returns an error if README.md for at least one
// enabled component is missing. "projectPath" is the absolute path to the root
// of the project to which the components belong. "defaultComponentsFilePath" is
// the path to the file that contains imports to all required components,
// "goModule" is the Go module to which the imports belong. This method is intended
// to be used only to verify documentation in Opentelemetry core and contrib
// repositories. Examples,
// 1) Usage in the core repo:
//
// componenttest.CheckDocs(
// "path/to/project",
// "service/defaultcomponents/defaults.go",
// "go.opentelemetry.io/collector",
// )
//
// 2) Usage in the contrib repo:
// componenttest.CheckDocs(
// "path/to/project",
// "cmd/otelcontrib/components.go",
// "github.com/open-telemetry/opentelemetry-collector-contrib",
// ).
func CheckDocs(projectPath string, relativeComponentsPath string, projectGoModule string) error {
defaultComponentsFilePath := filepath.Join(projectPath, relativeComponentsPath)
_, err := os.Stat(defaultComponentsFilePath)
if err != nil {
return fmt.Errorf("failed to load file %s: %v", defaultComponentsFilePath, err)
}
fset := token.NewFileSet()
f, err := parser.ParseFile(fset, defaultComponentsFilePath, nil, parser.ImportsOnly)
if err != nil {
return fmt.Errorf("failed to load imports: %v", err)
}
importPrefixesToCheck := getImportPrefixesToCheck(projectGoModule)
for _, i := range f.Imports {
importPath := strings.Trim(i.Path.Value, `"`)
if isComponentImport(importPath, importPrefixesToCheck) {
relativeComponentPath := strings.Replace(importPath, projectGoModule, "", 1)
readmePath := filepath.Join(projectPath, relativeComponentPath, readMeFileName)
_, err := os.Stat(readmePath)
if err != nil {
return fmt.Errorf("README does not exist at %s, add one", readmePath)
}
}
}
return nil
}
var componentTypes = []string{"extension", "receiver", "processor", "exporter"}
// getImportPrefixesToCheck returns a slice of strings that are relevant import
// prefixes for components in the given module.
func getImportPrefixesToCheck(module string) []string {
out := make([]string, len(componentTypes))
for i, typ := range componentTypes {
out[i] = strings.Join([]string{strings.TrimRight(module, "/"), typ}, "/")
}
return out
}
// isComponentImport returns true if the import corresponds to a Otel component,
// i.e. an extension, exporter, processor or a receiver.
func isComponentImport(importStr string, importPrefixesToCheck []string) bool {
for _, prefix := range importPrefixesToCheck {
if strings.HasPrefix(importStr, prefix) {
return true
}
}
return false
}