-
Notifications
You must be signed in to change notification settings - Fork 66
/
template.go
228 lines (206 loc) · 6.52 KB
/
template.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
// Copyright (c) 2023 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package codegen
import (
"bytes"
"io"
"os"
"path/filepath"
"strings"
tmpl "text/template"
"github.com/pkg/errors"
templates "github.com/uber/zanzibar/codegen/template_bundle"
)
// CustomTemplate custom template representation
const CustomTemplate = "customTemplate"
// AssetProvider provides access to template assets
type AssetProvider interface {
// AssetNames returns a list of named assets available
AssetNames() []string
// Asset returns the bytes for a provided asset name
Asset(string) ([]byte, error)
}
type defaultAssetCollection struct{}
func (*defaultAssetCollection) AssetNames() []string {
return templates.AssetNames()
}
func (*defaultAssetCollection) Asset(assetName string) ([]byte, error) {
return templates.Asset(assetName)
}
var defaultFuncMap = tmpl.FuncMap{
"lower": strings.ToLower,
"title": strings.Title,
"fullTypeName": fullTypeName,
"camel": CamelCase,
"split": strings.Split,
"dec": decrement,
"basePath": filepath.Base,
"pascal": PascalCase,
"isPointerType": IsPointerType,
"unref": Unref,
"lintAcronym": LintAcronym,
"args": args,
"firstIsClientOrEmpty": firstIsClientOrEmpty,
}
func fullTypeName(typeName, packageName string) string {
if typeName == "" || strings.Contains(typeName, ".") {
return typeName
}
return packageName + "." + typeName
}
// work around since text/template variables can not be overwritten until go1.11
func firstIsClientOrEmpty(list []string) string {
if len(list) > 0 && list[0] == "client" {
return "client"
}
return ""
}
func decrement(num int) int {
return num - 1
}
// IsPointerType determines if the passed in string is a string for a pointer
func IsPointerType(t string) bool {
return strings.HasPrefix(t, "*")
}
// Unref unrefs a pointer reference
func Unref(t string) string {
if strings.HasPrefix(t, "*") {
return strings.TrimLeft(t, "*")
}
return t
}
func args(v ...interface{}) []interface{} {
return v
}
// Template generates code for edge gateway clients and edgegateway endpoints.
type Template struct {
template *tmpl.Template
}
// NewDefaultTemplate creates a bundle of templates.
func NewDefaultTemplate() (*Template, error) {
return NewTemplate(
&defaultAssetCollection{},
defaultFuncMap,
)
}
// NewTemplate returns a template helper for the provided asset collection
func NewTemplate(
assetProvider AssetProvider,
functionMap tmpl.FuncMap,
) (*Template, error) {
t := tmpl.New("main").Funcs(functionMap)
for _, file := range assetProvider.AssetNames() {
fileContent, err := assetProvider.Asset(file)
if err != nil {
return nil, errors.Wrapf(
err,
"Could not read bin data for template %s",
file,
)
}
if _, err := t.New(file).Parse(string(fileContent)); err != nil {
return nil, errors.Wrapf(err, "Could not parse template %s", file)
}
}
return &Template{
template: t,
}, nil
}
// GetDefaultOrCustomTemplate verify and returns overridden template if present
func GetDefaultOrCustomTemplate(defaultTemplateName string,
defaultTemplate *Template,
customTemplate *Template,
config map[string]interface{},
) (string, *Template) {
// returns default template if custom template is nil
if customTemplate == nil {
return defaultTemplateName, defaultTemplate
}
// verify if config contains template override
if _, ok := config[CustomTemplate]; !ok {
return defaultTemplateName, defaultTemplate
}
// verify if override template config contains given template
templateMap := config[CustomTemplate].(map[string]interface{})
if _, ok := templateMap[defaultTemplateName]; !ok {
return defaultTemplateName, defaultTemplate
}
return templateMap[defaultTemplateName].(string), customTemplate
}
// ExecTemplate executes the named templated, returning the generated bytes
func (t *Template) ExecTemplate(
tplName string,
tplData interface{},
pkgHelper *PackageHelper,
buildTags ...string,
) (ret []byte, rErr error) {
defer func() {
if r := recover(); r != nil {
rErr = errors.Errorf(
"panic when generating %s template in %s: %+v",
tplName, pkgHelper.packageRoot, r,
)
}
}()
tplBuffer := bytes.NewBuffer(nil)
if _, err := io.WriteString(tplBuffer, "// Code generated by zanzibar \n"+
"// @generated \n \n"); err != nil {
rErr = errors.Wrapf(err, "failed to write to file: %s", err)
return
}
buildTagsLine := strings.Join(buildTags, " ")
if buildTagsLine != "" {
if _, err := io.WriteString(tplBuffer, "// +build "+buildTagsLine+"\n\n"); err != nil {
rErr = errors.Wrapf(err, "failed to write to file: %s", err)
return
}
}
if _, err := io.WriteString(tplBuffer, pkgHelper.copyrightHeader); err != nil {
rErr = errors.Wrapf(err, "failed to write to file: %s", err)
return
}
if _, err := io.WriteString(tplBuffer, "\n\n"); err != nil {
rErr = errors.Wrapf(err, "failed to write to file: %s", err)
return
}
if err := t.template.ExecuteTemplate(
tplBuffer,
tplName,
tplData,
); err != nil {
rErr = errors.Wrapf(
err,
"Error generating template %s",
tplName,
)
}
ret = tplBuffer.Bytes()
return
}
func openFileOrCreate(file string) (*os.File, error) {
if _, err := os.Stat(file); os.IsNotExist(err) {
if err := os.MkdirAll(filepath.Dir(file), os.ModePerm); err != nil {
return nil, errors.Wrapf(
err, "could not make directory: %s", file,
)
}
}
return os.OpenFile(file, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, 0644)
}