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
|
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
package model
import (
"fmt"
"strings"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/delta"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/markdown"
"github.com/Azure/azure-sdk-for-go/eng/tools/internal/report"
)
// Changelog describes the changelog generated for a package.
type Changelog struct {
// NewPackage is true if this package does not exist in the old version
NewPackage bool
// RemovedPackage is true if this package does not exist in the new version
RemovedPackage bool
// Modified contains the details of a modified package. This is nil when either NewPackage or RemovedPackage is true
Modified *report.Package
}
// HasBreakingChanges returns if this report of changelog contains breaking changes
func (c Changelog) HasBreakingChanges() bool {
return c.RemovedPackage || (c.Modified != nil && c.Modified.HasBreakingChanges())
}
// String ...
func (c Changelog) String() string {
return c.ToMarkdown()
}
// ToMarkdown returns the markdown string of this changelog
func (c Changelog) ToMarkdown() string {
if c.NewPackage {
return ""
}
if c.RemovedPackage {
return "This package was removed" // this should never be executed
}
return c.Modified.ToMarkdown()
}
// ToCompactMarkdown returns the markdown string of this changelog but more compact
func (c Changelog) ToCompactMarkdown() string {
if c.NewPackage {
return "This is a new package"
}
if c.RemovedPackage {
return "This package was removed"
}
return writeChangelogForPackage(c.Modified)
}
// Seperate change summary text get
func (c Changelog) GetChangeSummary() string {
if c.NewPackage || c.RemovedPackage {
return ""
}
return getSummaries(c.Modified.BreakingChanges, c.Modified.AdditiveChanges)
}
// GetBreakingChangeItems returns an array of the breaking change items
func (c Changelog) GetBreakingChangeItems() []string {
if c.RemovedPackage {
return []string{
fmt.Sprintf("Package was removed"),
}
}
if c.Modified == nil {
return []string{}
}
return getBreakingChanges(c.Modified.BreakingChanges)
}
func writeChangelogForPackage(r *report.Package) string {
if r == nil || r.IsEmpty() {
return "### Other Changes\n"
}
md := &markdown.Writer{}
// write breaking changes
breakings := getBreakingChanges(r.BreakingChanges)
if len(breakings) > 0 {
md.WriteHeader("Breaking Changes")
for _, item := range breakings {
md.WriteListItem(item)
}
}
// write additional changes
additives := getNewContents(r.AdditiveChanges)
if len(additives) > 0 {
md.WriteHeader("Features Added")
for _, item := range additives {
md.WriteListItem(item)
}
}
return md.String()
}
func getSummaries(breaking *report.BreakingChanges, additive *delta.Content) string {
bc := 0
if breaking != nil {
bc = breaking.Count()
}
ac := 0
if additive != nil {
ac = additive.Count()
}
return fmt.Sprintf("Total %d breaking change(s), %d additive change(s).", bc, ac)
}
func getNewContents(c *delta.Content) []string {
if c == nil || c.IsEmpty() {
return nil
}
var items []string
if len(c.Consts) > 0 {
for k := range c.Consts {
line := fmt.Sprintf("New const `%s`", k)
items = append(items, line)
}
}
if len(c.Funcs) > 0 {
for k, v := range c.Funcs {
params := ""
if v.Params != nil {
params = *v.Params
}
returns := ""
if v.Returns != nil {
returns = *v.Returns
if strings.Contains(returns, ",") {
returns = fmt.Sprintf("(%s)", returns)
}
}
line := fmt.Sprintf("New function `%s(%s) %s`", k, params, returns)
items = append(items, line)
}
}
if len(c.CompleteStructs) > 0 {
for _, v := range c.CompleteStructs {
line := fmt.Sprintf("New struct `%s`", v)
items = append(items, line)
}
}
if len(c.Structs) > 0 {
modified := c.GetModifiedStructs()
for s, f := range modified {
for _, af := range f.AnonymousFields {
line := fmt.Sprintf("New anonymous field `%s` in struct `%s`", af, s)
items = append(items, line)
}
for f := range f.Fields {
line := fmt.Sprintf("New field `%s` in struct `%s`", f, s)
items = append(items, line)
}
}
}
return items
}
func getBreakingChanges(b *report.BreakingChanges) []string {
items := make([]string, 0)
if b == nil || b.IsEmpty() {
return items
}
// get signature changes
items = append(items, getSignatureChangeItems(b)...)
// get removed content
items = append(items, getRemovedContent(b.Removed)...)
return items
}
func getSignatureChangeItems(b *report.BreakingChanges) []string {
if b.IsEmpty() {
return nil
}
var items []string
// write const changes
if len(b.Consts) > 0 {
for k, v := range b.Consts {
line := fmt.Sprintf("Const `%s` type has been changed from `%s` to `%s`", k, v.From, v.To)
items = append(items, line)
}
// TODO -- sort?
}
// write function changes
if len(b.Funcs) > 0 {
for k, v := range b.Funcs {
if v.Params != nil {
line := fmt.Sprintf("Function `%s` parameter(s) have been changed from `(%s)` to `(%s)`", k, v.Params.From, v.Params.To)
items = append(items, line)
}
if v.Returns != nil {
line := fmt.Sprintf("Function `%s` return value(s) have been changed from `(%s)` to `(%s)`", k, v.Returns.From, v.Returns.To)
items = append(items, line)
}
}
}
// write struct changes
if len(b.Structs) > 0 {
for k, v := range b.Structs {
for f, d := range v.Fields {
line := fmt.Sprintf("Type of `%s.%s` has been changed from `%s` to `%s`", k, f, d.From, d.To)
items = append(items, line)
}
}
}
// interfaces are skipped, which are identical to some of the functions
return items
}
func getRemovedContent(removed *delta.Content) []string {
if removed == nil {
return nil
}
var items []string
// write constants
if len(removed.Consts) > 0 {
for k := range removed.Consts {
line := fmt.Sprintf("Const `%s` has been removed", k)
items = append(items, line)
}
}
// write functions
if len(removed.Funcs) > 0 {
for k := range removed.Funcs {
line := fmt.Sprintf("Function `%s` has been removed", k)
items = append(items, line)
}
}
// write complete struct removal
if len(removed.CompleteStructs) > 0 {
for _, v := range removed.CompleteStructs {
line := fmt.Sprintf("Struct `%s` has been removed", v)
items = append(items, line)
}
}
// write struct modification (some fields are removed)
modified := removed.GetModifiedStructs()
if len(modified) > 0 {
for s, f := range modified {
for _, af := range f.AnonymousFields {
line := fmt.Sprintf("Field `%s` of struct `%s` has been removed", af, s)
items = append(items, line)
}
for f := range f.Fields {
line := fmt.Sprintf("Field `%s` of struct `%s` has been removed", f, s)
items = append(items, line)
}
}
}
return items
}
|