-
Notifications
You must be signed in to change notification settings - Fork 796
/
generation.go
368 lines (322 loc) · 11.6 KB
/
generation.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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
package common
import (
"fmt"
"log"
"os"
"path/filepath"
"strings"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/autorest"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/autorest/model"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/cmd/template"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/common"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/repo"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/exports"
"github.com/Masterminds/semver"
)
type GenerateContext struct {
SDKPath string
SDKRepo *repo.SDKRepository
SpecPath string
SpecCommitHash string
SpecReadmeFile string
SpecReadmeGoFile string
SpecRepoURL string
UpdateSpecVersion bool
}
type GenerateResult struct {
Version string
RPName string
PackageName string
PackageAbsPath string
Changelog model.Changelog
ChangelogMD string
PullRequestLabels string
}
type GenerateParam struct {
RPName string
NamespaceName string
NamespaceConfig string
SpecficVersion string
SpecficPackageTitle string
SpecRPName string
ReleaseDate string
SkipGenerateExample bool
GoVersion string
RemoveTagSet bool
ForceStableVersion bool
}
func (ctx *GenerateContext) GenerateForAutomation(readme, repo, goVersion string) ([]GenerateResult, []error) {
absReadme, err := filepath.Abs(filepath.Join(ctx.SpecPath, readme))
if err != nil {
return nil, []error{
fmt.Errorf("cannot get absolute path for spec path '%s': %+v", ctx.SpecPath, err),
}
}
absReadmeGo := filepath.Join(filepath.Dir(absReadme), "readme.go.md")
ctx.SpecReadmeFile = absReadme
ctx.SpecReadmeGoFile = absReadmeGo
specRPName := strings.Split(readme, "/")[0]
var result []GenerateResult
var errors []error
log.Printf("Get all namespaces from readme file")
rpMap, err := ReadV2ModuleNameToGetNamespace(absReadmeGo)
if err != nil {
return nil, []error{
fmt.Errorf("cannot get rp and namespaces from readme '%s': %+v", readme, err),
}
}
for rpName, packageInfos := range rpMap {
for _, packageInfo := range packageInfos {
log.Printf("Process rp: %s, namespace: %s", rpName, packageInfo.Name)
singleResult, err := ctx.GenerateForSingleRPNamespace(&GenerateParam{
RPName: rpName,
NamespaceName: packageInfo.Name,
SpecRPName: specRPName,
SkipGenerateExample: true,
NamespaceConfig: packageInfo.Config,
GoVersion: goVersion,
RemoveTagSet: true,
})
if err != nil {
errors = append(errors, err)
continue
}
result = append(result, *singleResult)
}
}
return result, errors
}
func (ctx *GenerateContext) GenerateForSingleRPNamespace(generateParam *GenerateParam) (*GenerateResult, error) {
packagePath := filepath.Join(ctx.SDKPath, "sdk", "resourcemanager", generateParam.RPName, generateParam.NamespaceName)
changelogPath := filepath.Join(packagePath, common.ChangelogFilename)
onBoard := false
version, err := semver.NewVersion("0.1.0")
if err != nil {
return nil, err
}
if generateParam.SpecficVersion != "" {
log.Printf("Use specfic version: %s", generateParam.SpecficVersion)
version, err = semver.NewVersion(generateParam.SpecficVersion)
if err != nil {
return nil, err
}
}
if _, err := os.Stat(changelogPath); os.IsNotExist(err) {
onBoard = true
log.Printf("Package '%s' changelog not exist, do onboard process", packagePath)
if generateParam.SpecficPackageTitle == "" {
generateParam.SpecficPackageTitle = strings.Title(generateParam.RPName)
}
log.Printf("Use template to generate new rp folder and basic package files...")
if err = template.GeneratePackageByTemplate(generateParam.RPName, generateParam.NamespaceName, template.Flags{
SDKRoot: ctx.SDKPath,
TemplatePath: "eng/tools/generator/template/rpName/packageName",
PackageTitle: generateParam.SpecficPackageTitle,
Commit: ctx.SpecCommitHash,
PackageConfig: generateParam.NamespaceConfig,
GoVersion: generateParam.GoVersion,
PackageVersion: version.String(),
ReleaseDate: generateParam.ReleaseDate,
}); err != nil {
return nil, err
}
} else {
log.Printf("Package '%s' existed, do update process", packagePath)
log.Printf("Remove all the generated files ...")
if err = CleanSDKGeneratedFiles(packagePath); err != nil {
return nil, err
}
}
// same step for onboard and update
if ctx.SpecCommitHash == "" {
log.Printf("Change swagger config in `autorest.md` according to local path...")
autorestMdPath := filepath.Join(packagePath, "autorest.md")
if err := ChangeConfigWithLocalPath(autorestMdPath, ctx.SpecReadmeFile, ctx.SpecReadmeGoFile); err != nil {
return nil, err
}
} else {
log.Printf("Change swagger config in `autorest.md` according to repo URL and commit ID...")
autorestMdPath := filepath.Join(packagePath, "autorest.md")
if ctx.UpdateSpecVersion {
if err := ChangeConfigWithCommitID(autorestMdPath, ctx.SpecRepoURL, ctx.SpecCommitHash, generateParam.SpecRPName); err != nil {
return nil, err
}
}
}
// remove tag set
if generateParam.RemoveTagSet {
log.Printf("Remove tag set for swagger config in `autorest.md`...")
autorestMdPath := filepath.Join(packagePath, "autorest.md")
if err := RemoveTagSet(autorestMdPath); err != nil {
return nil, err
}
}
// add tag set
if !generateParam.RemoveTagSet && generateParam.NamespaceConfig != "" && !onBoard {
log.Printf("Add tag in `autorest.md`...")
autorestMdPath := filepath.Join(packagePath, "autorest.md")
if err := AddTagSet(autorestMdPath, generateParam.NamespaceConfig); err != nil {
return nil, err
}
}
log.Printf("Run `go generate` to regenerate the code...")
if err := ExecuteGoGenerate(packagePath); err != nil {
return nil, err
}
previousVersion := ""
isCurrentPreview := false
var oriExports *exports.Content
isCurrentPreview, err = ContainsPreviewAPIVersion(packagePath)
if err != nil {
return nil, err
}
if isCurrentPreview && generateParam.ForceStableVersion {
tag, err := GetTag(filepath.Join(packagePath, "autorest.md"))
if err != nil {
return nil, err
}
if tag != "" {
if !strings.Contains(tag, "preview") {
isCurrentPreview = false
}
}
}
if !onBoard {
log.Printf("Get ori exports for changelog generation...")
tags, err := GetAllVersionTags(generateParam.RPName, generateParam.NamespaceName)
if err != nil {
return nil, err
}
previousVersionTag := GetPreviousVersionTag(isCurrentPreview, tags)
oriExports, err = GetExportsFromTag(*ctx.SDKRepo, packagePath, previousVersionTag)
if err != nil {
return nil, err
}
tagSplit := strings.Split(previousVersionTag, "/")
previousVersion = strings.TrimLeft(tagSplit[len(tagSplit)-1], "v")
}
log.Printf("Generate changelog for package...")
newExports, err := exports.Get(packagePath)
if err != nil {
return nil, err
}
changelog, err := autorest.GetChangelogForPackage(oriExports, &newExports)
if err != nil {
return nil, err
}
log.Printf("filter changelog...")
FilterChangelog(changelog, NonExportedFilter, MarshalUnmarshalFilter, EnumFilter, FuncFilter, LROFilter, PageableFilter, InterfaceToAnyFilter)
var prl PullRequestLabel
if onBoard {
log.Printf("Replace {{NewClientName}} placeholder in the README.md ")
if err = ReplaceNewClientNamePlaceholder(packagePath, newExports); err != nil {
return nil, err
}
if !generateParam.SkipGenerateExample {
log.Printf("Generate examples...")
flag, err := GetAlwaysSetBodyParamRequiredFlag(filepath.Join(packagePath, "build.go"))
if err != nil {
return nil, err
}
if err := ExecuteExampleGenerate(packagePath, filepath.Join("resourcemanager", generateParam.RPName, generateParam.NamespaceName), flag); err != nil {
return nil, err
}
}
prl = FirstBetaLabel
if !isCurrentPreview {
version, err = semver.NewVersion("1.0.0")
if err != nil {
return nil, err
}
log.Printf("Replace version in CHANGELOG.md...")
if err = UpdateOnboardChangelogVersion(packagePath, version.String()); err != nil {
return nil, err
}
log.Printf("Replace version in autorest.md and constants...")
if err = ReplaceVersion(packagePath, version.String()); err != nil {
return nil, err
}
prl = FirstGALabel
}
return &GenerateResult{
Version: version.String(),
RPName: generateParam.RPName,
PackageName: generateParam.NamespaceName,
PackageAbsPath: packagePath,
Changelog: *changelog,
ChangelogMD: changelog.ToCompactMarkdown() + "\n" + changelog.GetChangeSummary(),
PullRequestLabels: string(prl),
}, nil
} else {
log.Printf("Calculate new version...")
if generateParam.SpecficVersion == "" {
version, prl, err = CalculateNewVersion(changelog, previousVersion, isCurrentPreview)
if err != nil {
return nil, err
}
}
log.Printf("Add changelog to file...")
changelogMd, err := AddChangelogToFile(changelog, version, packagePath, generateParam.ReleaseDate)
if err != nil {
return nil, err
}
log.Printf("Update module definition if v2+...")
err = UpdateModuleDefinition(packagePath, generateParam.RPName, generateParam.NamespaceName, version)
if err != nil {
return nil, err
}
oldModuleVersion, err := getModuleVersion(filepath.Join(packagePath, "autorest.md"))
if err != nil {
return nil, err
}
log.Printf("Replace version in autorest.md and constants...")
if err = ReplaceVersion(packagePath, version.String()); err != nil {
return nil, err
}
if _, err := os.Stat(filepath.Join(packagePath, "fake")); !os.IsNotExist(err) && oldModuleVersion.Major() != version.Major() {
log.Printf("Replace fake module v2+...")
if err = replaceModuleImport(packagePath, generateParam.RPName, generateParam.NamespaceName, oldModuleVersion.String(), version.String(),
"fake", ".go"); err != nil {
return nil, err
}
}
// When sdk has major version bump, the live test needs to update the module referenced in the code.
if oldModuleVersion.Major() != version.Major() && existSuffixFile(packagePath, "_live_test.go") {
log.Printf("Replace live test module v2+...")
if err = replaceModuleImport(packagePath, generateParam.RPName, generateParam.NamespaceName, oldModuleVersion.String(), version.String(),
"", "_live_test.go"); err != nil {
return nil, err
}
}
log.Printf("Replace README.md module...")
if err = replaceReadmeModule(packagePath, generateParam.RPName, generateParam.NamespaceName, version.String()); err != nil {
return nil, err
}
log.Printf("Replace README.md NewClient name...")
if err = ReplaceReadmeNewClientName(packagePath, newExports); err != nil {
return nil, err
}
// Example generation should be the last step because the package import relay on the new calculated version
if !generateParam.SkipGenerateExample {
log.Printf("Generate examples...")
flag, err := GetAlwaysSetBodyParamRequiredFlag(filepath.Join(packagePath, "build.go"))
if err != nil {
return nil, err
}
if err := ExecuteExampleGenerate(packagePath, filepath.Join("resourcemanager", generateParam.RPName, generateParam.NamespaceName), flag); err != nil {
return nil, err
}
}
return &GenerateResult{
Version: version.String(),
RPName: generateParam.RPName,
PackageName: generateParam.NamespaceName,
PackageAbsPath: packagePath,
Changelog: *changelog,
ChangelogMD: changelogMd + "\n" + changelog.GetChangeSummary(),
PullRequestLabels: string(prl),
}, nil
}
}