forked from Azure/azure-sdk-for-go
-
Notifications
You must be signed in to change notification settings - Fork 1
/
metadata.go
154 lines (137 loc) · 3.98 KB
/
metadata.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
package cmd
import (
"fmt"
"os"
"path/filepath"
"strings"
"github.com/Azure/azure-sdk-for-go/tools/generator/autorest"
"github.com/Azure/azure-sdk-for-go/tools/generator/autorest/model"
"github.com/Azure/azure-sdk-for-go/tools/generator/validate"
)
type changelogContext struct {
sdkRoot string
clnRoot string
specRoot string
commitHash string
codeGenVer string
readme string
removedPackages []packageOutput
}
func (ctx changelogContext) SDKRoot() string {
return ctx.sdkRoot
}
func (ctx changelogContext) SDKCloneRoot() string {
return ctx.clnRoot
}
func (ctx changelogContext) SpecRoot() string {
return ctx.specRoot
}
func (ctx changelogContext) SpecCommitHash() string {
return ctx.commitHash
}
func (ctx changelogContext) CodeGenVersion() string {
return ctx.codeGenVer
}
func (ctx changelogContext) process(metadataLocation string) ([]autorest.ChangelogResult, error) {
// get the metadata
m := autorest.NewMetadataProcessorFromLocation(metadataLocation)
metadataMap, err := m.Process()
if err != nil {
return nil, err
}
// validate the metadata output-folder
if err := ctx.validateMetadata(metadataMap); err != nil {
return nil, err
}
// generate the changelogs
p := autorest.NewChangelogProcessorFromContext(ctx).WithLocation(metadataLocation).WithReadme(ctx.readme)
changelogResults, err := p.Process(metadataMap)
if err != nil {
return nil, err
}
for _, result := range changelogResults {
// we need to write the changelog file to the corresponding package here
if err := writeChangelogFile(result); err != nil {
return nil, err
}
}
// iterate over the removed packages, generate changelogs for them as well
var removedResults []autorest.ChangelogResult
for _, rp := range ctx.removedPackages {
if contains(changelogResults, rp.outputFolder) {
// this package has been regenerated
continue
}
result, err := p.GenerateChangelog(rp.outputFolder, rp.tag)
if err != nil {
return nil, err
}
removedResults = append(removedResults, *result)
}
changelogResults = append(changelogResults, removedResults...)
return changelogResults, nil
}
func contains(array []autorest.ChangelogResult, item string) bool {
for _, r := range array {
if r.PackagePath == item {
return true
}
}
return false
}
func writeChangelogFile(result autorest.ChangelogResult) error {
fileContent := fmt.Sprintf(`%s
%s`, result.GenerationMetadata.String(), result.Changelog.ToMarkdown())
changelogFile, err := os.Create(filepath.Join(result.PackagePath, autorest.ChangelogFilename))
if err != nil {
return err
}
defer changelogFile.Close()
if _, err := changelogFile.WriteString(fileContent); err != nil {
return err
}
return nil
}
func (ctx changelogContext) validateMetadata(metadataMap map[string]model.Metadata) error {
builder := validationErrorBuilder{
readme: ctx.readme,
}
validateContext := validate.MetadataValidateContext{
Readme: ctx.readme,
SDKRoot: ctx.sdkRoot,
Validators: []validate.MetadataValidateFunc{
validate.PreviewCheck,
// TODO -- we do have some exceptions (see file tools/pkgchk/exceptions.txt) that might need to be considered here
validate.MgmtCheck,
validate.NamespaceCheck,
},
}
for tag, metadata := range metadataMap {
// validate the output-folder, etc
if errors := validateContext.Validate(tag, metadata); len(errors) != 0 {
builder.addMultiple(errors)
continue
}
}
return builder.build()
}
type validationErrorBuilder struct {
readme string
errors []error
}
func (b *validationErrorBuilder) addMultiple(errors []error) {
b.errors = append(b.errors, errors...)
}
func (b *validationErrorBuilder) add(err error) {
b.errors = append(b.errors, err)
}
func (b *validationErrorBuilder) build() error {
if len(b.errors) == 0 {
return nil
}
var messages []string
for _, e := range b.errors {
messages = append(messages, e.Error())
}
return fmt.Errorf("validation failed in readme '%s' with %d error(s): \n%s", b.readme, len(b.errors), strings.Join(messages, "\n"))
}