/
doc.go
174 lines (151 loc) 路 6.07 KB
/
doc.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
// Copyright 2016-2020, Pulumi Corporation.
//
// 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.
// Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the
// goconst linter's warning.
//
// nolint: lll, goconst
package gen
import (
"fmt"
"os"
"strings"
"github.com/golang/glog"
"github.com/pulumi/pulumi/pkg/v3/codegen"
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
)
const pulumiSDKVersion = "v3"
// DocLanguageHelper is the Go-specific implementation of the DocLanguageHelper.
type DocLanguageHelper struct {
packages map[string]*pkgContext
}
var _ codegen.DocLanguageHelper = DocLanguageHelper{}
// GetDocLinkForPulumiType returns the doc link for a Pulumi type.
func (d DocLanguageHelper) GetDocLinkForPulumiType(pkg *schema.Package, typeName string) string {
version := pulumiSDKVersion
if info, ok := pkg.Language["go"].(GoPackageInfo); ok {
if info.PulumiSDKVersion == 1 {
return fmt.Sprintf("https://pkg.go.dev/github.com/pulumi/pulumi/sdk/go/pulumi?tab=doc#%s", typeName)
}
if info.PulumiSDKVersion != 0 {
version = fmt.Sprintf("v%d", info.PulumiSDKVersion)
}
}
return fmt.Sprintf("https://pkg.go.dev/github.com/pulumi/pulumi/sdk/%s/go/pulumi?tab=doc#%s", version, typeName)
}
// GetDocLinkForResourceType returns the godoc URL for a type belonging to a resource provider.
func (d DocLanguageHelper) GetDocLinkForResourceType(pkg *schema.Package, moduleName string, typeName string) string {
path := fmt.Sprintf("%s/%s", packageName(pkg), moduleName)
typeNameParts := strings.Split(typeName, ".")
typeName = typeNameParts[len(typeNameParts)-1]
typeName = strings.TrimPrefix(typeName, "*")
moduleVersion := ""
if pkg.Version != nil {
if pkg.Version.Major > 1 {
moduleVersion = fmt.Sprintf("v%d/", pkg.Version.Major)
}
}
return fmt.Sprintf("https://pkg.go.dev/github.com/pulumi/pulumi-%s/sdk/%sgo/%s?tab=doc#%s", pkg.Name, moduleVersion, path, typeName)
}
// GetDocLinkForResourceInputOrOutputType returns the godoc URL for an input or output type.
func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string {
link := d.GetDocLinkForResourceType(pkg, moduleName, typeName)
if !input {
return link + "Output"
}
return link + "Args"
}
// GetDocLinkForFunctionInputOrOutputType returns the doc link for an input or output type of a Function.
func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string {
link := d.GetDocLinkForResourceType(pkg, moduleName, typeName)
if !input {
return link
}
return link + "Args"
}
// GetLanguageTypeString returns the Go-specific type given a Pulumi schema type.
func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input bool) string {
modPkg, ok := d.packages[moduleName]
if !ok {
glog.Errorf("cannot calculate type string for type %q. could not find a package for module %q", t.String(), moduleName)
os.Exit(1)
}
return modPkg.typeString(t)
}
// GeneratePackagesMap generates a map of Go packages for resources, functions and types.
func (d *DocLanguageHelper) GeneratePackagesMap(pkg *schema.Package, tool string, goInfo GoPackageInfo) {
var err error
d.packages, err = generatePackageContextMap(tool, pkg.Reference(), goInfo, nil)
contract.AssertNoError(err)
}
// GetPropertyName returns the property name specific to Go.
func (d DocLanguageHelper) GetPropertyName(p *schema.Property) (string, error) {
return strings.Title(p.Name), nil
}
// GetEnumName returns the enum name specific to Go.
func (d DocLanguageHelper) GetEnumName(e *schema.Enum, typeName string) (string, error) {
name := fmt.Sprintf("%v", e.Value)
if e.Name != "" {
name = e.Name
}
return makeSafeEnumName(name, typeName)
}
func (d DocLanguageHelper) GetFunctionName(modName string, f *schema.Function) string {
funcName := tokenToName(f.Token)
pkg, ok := d.packages[modName]
if !ok {
return funcName
}
if override, ok := pkg.functionNames[f]; ok {
funcName = override
}
return funcName
}
// GetResourceFunctionResultName returns the name of the result type when a function is used to lookup
// an existing resource.
func (d DocLanguageHelper) GetResourceFunctionResultName(modName string, f *schema.Function) string {
funcName := d.GetFunctionName(modName, f)
return funcName + "Result"
}
func (d DocLanguageHelper) GetMethodName(m *schema.Method) string {
return Title(m.Name)
}
func (d DocLanguageHelper) GetMethodResultName(pkg *schema.Package, modName string, r *schema.Resource,
m *schema.Method) string {
if info, ok := pkg.Language["go"].(GoPackageInfo); ok {
if info.LiftSingleValueMethodReturns && m.Function.Outputs != nil && len(m.Function.Outputs.Properties) == 1 {
t := m.Function.Outputs.Properties[0].Type
modPkg, ok := d.packages[modName]
if !ok {
glog.Errorf("cannot calculate type string for type %q. could not find a package for module %q",
t.String(), modName)
os.Exit(1)
}
return modPkg.outputType(t)
}
}
return fmt.Sprintf("%s%sResultOutput", rawResourceName(r), d.GetMethodName(m))
}
// GetModuleDocLink returns the display name and the link for a module.
func (d DocLanguageHelper) GetModuleDocLink(pkg *schema.Package, modName string) (string, string) {
var displayName string
var link string
if modName == "" {
displayName = packageName(pkg)
} else {
displayName = fmt.Sprintf("%s/%s", packageName(pkg), modName)
}
link = d.GetDocLinkForResourceType(pkg, modName, "")
return displayName, link
}