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
|
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
package autorest
import (
"fmt"
"io"
"os"
"path/filepath"
"github.com/Azure/azure-sdk-for-go/eng/tools/generator/autorest/model"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/exports"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/report"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/utils"
)
// ChangelogContext describes all necessary data that would be needed in the processing of changelogs
type ChangelogContext interface {
SDKRoot() string
RepoContent() map[string]exports.Content
}
// ChangelogProcessor processes the metadata and output changelog with the desired format
type ChangelogProcessor struct {
ctx ChangelogContext
}
// NewChangelogProcessorFromContext returns a new ChangelogProcessor
func NewChangelogProcessorFromContext(ctx ChangelogContext) *ChangelogProcessor {
return &ChangelogProcessor{
ctx: ctx,
}
}
// ChangelogResult describes the result of the generated changelog for one package
type ChangelogResult struct {
Tag string
PackageName string
PackageFullPath string
Changelog model.Changelog
}
// ChangelogProcessError describes the errors during the processing
type ChangelogProcessError struct {
Errors []error
}
// Error ...
func (e *ChangelogProcessError) Error() string {
return fmt.Sprintf("total %d error(s) during processing changelog: %+v", len(e.Errors), e.Errors)
}
type changelogErrorBuilder struct {
errors []error
}
func (b *changelogErrorBuilder) add(err error) {
b.errors = append(b.errors, err)
}
func (b *changelogErrorBuilder) build() error {
if len(b.errors) == 0 {
return nil
}
return &ChangelogProcessError{
Errors: b.errors,
}
}
// Process generates the changelogs using the input metadata map.
// Please ensure the input metadata map does not contain any package that is not under the sdk root, otherwise this might give weird results.
func (p *ChangelogProcessor) Process(metadataMap map[string]model.Metadata) ([]ChangelogResult, error) {
builder := changelogErrorBuilder{}
var results []ChangelogResult
for tag, metadata := range metadataMap {
outputFolder := filepath.Clean(metadata.PackagePath())
// format the package before getting the changelog
if err := FormatPackage(outputFolder); err != nil {
builder.add(err)
continue
}
result, err := p.GenerateChangelog(outputFolder, tag)
if err != nil {
builder.add(err)
continue
}
results = append(results, *result)
}
return results, builder.build()
}
// GenerateChangelog generates a changelog for one package
func (p *ChangelogProcessor) GenerateChangelog(packageFullPath, tag string) (*ChangelogResult, error) {
relativePackagePath, err := p.getRelativePackagePath(packageFullPath)
if err != nil {
return nil, err
}
lhs := p.getLHSContent(relativePackagePath)
rhs, err := getExportsForPackage(packageFullPath)
if err != nil {
return nil, fmt.Errorf("failed to get exports from package '%s' in the sdk '%s': %+v", relativePackagePath, p.ctx.SDKRoot(), err)
}
r, err := GetChangelogForPackage(lhs, rhs)
if err != nil {
return nil, fmt.Errorf("failed to generate changelog for package '%s': %+v", relativePackagePath, err)
}
return &ChangelogResult{
Tag: tag,
PackageName: relativePackagePath,
PackageFullPath: packageFullPath,
Changelog: *r,
}, nil
}
func (p *ChangelogProcessor) getRelativePackagePath(fullPath string) (string, error) {
relative, err := filepath.Rel(p.ctx.SDKRoot(), fullPath)
if err != nil {
return "", err
}
return utils.NormalizePath(relative), nil
}
func (p *ChangelogProcessor) getLHSContent(relativePackagePath string) *exports.Content {
if v, ok := p.ctx.RepoContent()[relativePackagePath]; ok {
return &v
}
return nil
}
func getExportsForPackage(dir string) (*exports.Content, error) {
// The function exports.Get does not handle the circumstance that the package does not exist
// therefore we have to check if it exists and if not exit early to ensure we do not return an error
if _, err := os.Stat(dir); os.IsNotExist(err) {
return nil, nil
}
exp, err := exports.Get(dir)
if err != nil {
return nil, err
}
return &exp, nil
}
// GetChangelogForPackage generates the changelog report with the given two Contents
func GetChangelogForPackage(lhs, rhs *exports.Content) (*model.Changelog, error) {
if lhs == nil && rhs == nil {
return nil, fmt.Errorf("this package does not exist even after the generation, this should never happen")
}
if lhs == nil {
// the package does not exist before the generation: this is a new package
return &model.Changelog{
NewPackage: true,
}, nil
}
if rhs == nil {
// the package no longer exists after the generation: this package was removed
return &model.Changelog{
RemovedPackage: true,
}, nil
}
// lhs and rhs are both non-nil
p := report.Generate(*lhs, *rhs, nil)
return &model.Changelog{
Modified: &p,
}, nil
}
// ToMarkdown convert this ChangelogResult to markdown string
func (r ChangelogResult) ToMarkdown() string {
return r.Changelog.ToMarkdown()
}
// Write writes this ChangelogResult to the specified writer in markdown format
func (r ChangelogResult) Write(writer io.Writer) error {
_, err := writer.Write([]byte(r.ToMarkdown()))
return err
}
const (
// ChangelogFilename ...
ChangelogFilename = "CHANGELOG.md"
)
|
