forked from Azure/azure-sdk-for-go
/
packages.go
210 lines (185 loc) · 5.71 KB
/
packages.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
package report
import (
"fmt"
"io/ioutil"
"os"
"path/filepath"
"github.com/Azure/azure-sdk-for-go/tools/apidiff/markdown"
)
const apiDirSuffix = "api"
// GetPackages returns all the go sdk packages under the given root directory
func GetPackages(dir string) ([]string, error) {
var pkgDirs []string
err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if info.IsDir() {
// check if leaf dir
fi, err := ioutil.ReadDir(path)
if err != nil {
return err
}
hasSubDirs := false
for _, f := range fi {
// check if this is the interfaces subdir, if it is don't count it as a subdir
if f.IsDir() && f.Name() != filepath.Base(path)+apiDirSuffix {
hasSubDirs = true
break
}
}
if !hasSubDirs {
pkgDirs = append(pkgDirs, path)
// skip any dirs under us (i.e. interfaces subdir)
return filepath.SkipDir
}
}
return nil
})
return pkgDirs, err
}
// PkgsList contains a collection of packages
type PkgsList []string
// ModifiedPackages contains a collection of package reports, it's structured as "package path":pkgReport
type ModifiedPackages map[string]Package
// IsEmpty ...
func (m ModifiedPackages) IsEmpty() bool {
return len(m) == 0
}
// HasBreakingChanges returns true if any package contained in has a breaking change
func (m ModifiedPackages) HasBreakingChanges() bool {
for _, p := range m {
if p.HasBreakingChanges() {
return true
}
}
return false
}
// HasAdditiveChanges returns true if any package contained in has an additive change
func (m ModifiedPackages) HasAdditiveChanges() bool {
for _, p := range m {
if p.HasAdditiveChanges() {
return true
}
}
return false
}
// CommitPkgsReport represents a collection of reports, one for each commit hash.
type CommitPkgsReport struct {
// AffectedPackages stores the package list with key of commit hashes
AffectedPackages map[string]PkgsList `json:"affectedPackages"`
// BreakingChanges stores the commit hashes that contain breaking changes
BreakingChanges []string `json:"breakingChanges,omitempty"`
// CommitsReports stores the detailed reports with the key of commit hashes
CommitsReports map[string]PkgsReport `json:"deltas"`
}
// IsEmpty returns true if the report contains no data.
func (c CommitPkgsReport) IsEmpty() bool {
for _, r := range c.CommitsReports {
if !r.IsEmpty() {
return false
}
}
return true
}
// HasBreakingChanges returns true if the report contains breaking changes.
func (c CommitPkgsReport) HasBreakingChanges() bool {
for _, r := range c.CommitsReports {
if r.HasBreakingChanges() {
return true
}
}
return false
}
// HasAdditiveChanges returns true if the package contains additive changes.
func (c CommitPkgsReport) HasAdditiveChanges() bool {
for _, r := range c.CommitsReports {
if r.HasAdditiveChanges() {
return true
}
}
return false
}
// UpdateAffectedPackages updates the collection of affected packages with the packages that were touched in the specified commit
func (c *CommitPkgsReport) UpdateAffectedPackages(commit string, r PkgsReport) {
if c.AffectedPackages == nil {
c.AffectedPackages = map[string]PkgsList{}
}
for _, pkg := range r.AddedPackages {
c.AffectedPackages[commit] = append(c.AffectedPackages[commit], pkg)
}
for pkgName := range r.ModifiedPackages {
c.AffectedPackages[commit] = append(c.AffectedPackages[commit], pkgName)
}
for _, pkg := range r.RemovedPackages {
c.AffectedPackages[commit] = append(c.AffectedPackages[commit], pkg)
}
}
// PkgsReport represents a complete report of added, removed, and modified packages
type PkgsReport struct {
// AddedPackages stores the added packages in the report
AddedPackages PkgsList `json:"added,omitempty"`
// ModifiedPackages stores the details of all modified packages
ModifiedPackages ModifiedPackages `json:"modified,omitempty"`
// RemovedPackages stores the removed packages in the report
RemovedPackages PkgsList `json:"removed,omitempty"`
}
// HasBreakingChanges returns true if the package report contains breaking changes
func (r PkgsReport) HasBreakingChanges() bool {
return len(r.RemovedPackages) > 0 || (r.ModifiedPackages != nil && r.ModifiedPackages.HasBreakingChanges())
}
// HasAdditiveChanges returns true if the package report contains additive changes
func (r PkgsReport) HasAdditiveChanges() bool {
return len(r.AddedPackages) > 0 || (r.ModifiedPackages != nil && r.ModifiedPackages.HasAdditiveChanges())
}
// IsEmpty returns true if the report contains no data
func (r PkgsReport) IsEmpty() bool {
return len(r.AddedPackages) == 0 && len(r.ModifiedPackages) == 0 && len(r.RemovedPackages) == 0
}
// ToMarkdown writes the report to string in the markdown form
func (r *PkgsReport) ToMarkdown() string {
if r.IsEmpty() {
return ""
}
md := markdown.Writer{}
r.writeAddedPackages(&md)
r.writeRemovedPackages(&md)
r.writeModifiedPackages(&md)
return md.String()
}
func (r *PkgsReport) writeAddedPackages(md *markdown.Writer) {
if len(r.AddedPackages) == 0 {
return
}
md.WriteHeader("New Packages")
// write list
for _, p := range r.AddedPackages {
md.WriteLine("- " + p)
}
}
func (r *PkgsReport) writeModifiedPackages(md *markdown.Writer) {
if len(r.ModifiedPackages) == 0 {
return
}
md.WriteHeader("Modified Packages")
// write list
for n := range r.ModifiedPackages {
md.WriteLine(fmt.Sprintf("- `%s`", n))
}
// write details
for n, p := range r.ModifiedPackages {
md.WriteHeader(fmt.Sprintf("Modified `%s`", n))
md.WriteLine(p.ToMarkdown())
}
}
func (r *PkgsReport) writeRemovedPackages(md *markdown.Writer) {
if len(r.RemovedPackages) == 0 {
return
}
md.WriteHeader("Removed Packages")
// write list
for _, p := range r.RemovedPackages {
md.WriteLine("- " + p)
}
md.EmptyLine()
}