Skip to content

Commit

Permalink
Diff'ing packages can contain incorrect information (Azure#2072)
Browse files Browse the repository at this point in the history
Using "packageName:apiVersion" as the dictionary key is not enough info
to ensure unique package identity; this is because there are duplicated
packages in the services and services/preview directories.  The result
is incorrect delta information.  Use the full package package which is
guaranteed to be unique.
  • Loading branch information
jhendrixMSFT committed Jun 19, 2018
1 parent db918e3 commit 4c729a2
Showing 1 changed file with 41 additions and 78 deletions.
119 changes: 41 additions & 78 deletions tools/apidiff/cmd/packages.go
Original file line number Diff line number Diff line change
Expand Up @@ -136,52 +136,46 @@ func getRepoContentForCommit(wt repo.WorkingTree, dir, commit string) (r repoCon
}
}

r, err = getExportsForPackages(pkgDirs)
r, err = getExportsForPackages(wt.Root(), pkgDirs)
if err != nil {
err = fmt.Errorf("failed to get exports for commit '%s': %s", commit, err)
}
return
}

// contains repo content, it's structured as "package":"apiversion":content
type repoContent map[string]map[string]exports.Content
// contains repo content, it's structured as "package path":content
type repoContent map[string]exports.Content

// returns repoContent based on the provided slice of package directories
func getExportsForPackages(pkgDirs []string) (repoContent, error) {
func getExportsForPackages(root string, pkgDirs []string) (repoContent, error) {
exps := repoContent{}
for _, pkgDir := range pkgDirs {
vprintf("getting exports for %s\n", pkgDir)
// pkgDir = "D:\work\src\github.com\Azure\azure-sdk-for-go\services\analysisservices\mgmt\2016-05-16\analysisservices"
// we want ver = "2016-05-16", pkg = "analysisservices"
i := strings.LastIndexByte(pkgDir, os.PathSeparator)
j := strings.LastIndexByte(pkgDir[:i], os.PathSeparator)
ver := pkgDir[j+1 : j+(i-j)]
pkg := pkgDir[i+1:]

if _, ok := exps[pkg]; !ok {
exps[pkg] = map[string]exports.Content{}
// pkgDir = "C:\Users\somebody\AppData\Local\Temp\apidiff-1529437978\services\addons\mgmt\2017-05-15\addons"
// convert to package path "github.com/Azure/azure-sdk-for-go/services/analysisservices/mgmt/2016-05-16/analysisservices"
pkgPath := strings.Replace(pkgDir, root, "github.com/Azure/azure-sdk-for-go", -1)
pkgPath = strings.Replace(pkgPath, string(os.PathSeparator), "/", -1)
if _, ok := exps[pkgPath]; ok {
return nil, fmt.Errorf("duplicate package: %s", pkgPath)
}

if _, ok := exps[pkg][ver]; !ok {
exp, err := exports.Get(pkgDir)
if err != nil {
return nil, err
}
exps[pkg][ver] = exp
exp, err := exports.Get(pkgDir)
if err != nil {
return nil, err
}
exps[pkgPath] = exp
}
return exps, nil
}

// contains a collection of packages, it's structured as "package":{"apiver1", "apiver2",...}
type pkgsList map[string][]string
// contains a collection of packages
type pkgsList []string

// contains a collection of package reports, it's structured as "package":"apiversion":pkgReport
type modifiedPackages map[string]map[string]pkgReport
// contains a collection of package reports, it's structured as "package path":pkgReport
type modifiedPackages map[string]pkgReport

// CommitPkgsReport represents a collection of reports, one for each commit hash.
type CommitPkgsReport struct {
AffectedPackages pkgsList `json:"affectedPackages"`
AffectedPackages map[string]pkgsList `json:"affectedPackages"`
BreakingChanges []string `json:"breakingChanges,omitempty"`
CommitsReports map[string]pkgsReport `json:"deltas"`
}
Expand Down Expand Up @@ -219,25 +213,19 @@ func (c CommitPkgsReport) hasAdditiveChanges() bool {
// 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][]string{}
c.AffectedPackages = map[string]pkgsList{}
}

for pkgName, apiVers := range r.AddedPackages {
for _, apiVer := range apiVers {
c.AffectedPackages[commit] = append(c.AffectedPackages[commit], fmt.Sprintf("%s/%s", pkgName, apiVer))
}
for _, pkg := range r.AddedPackages {
c.AffectedPackages[commit] = append(c.AffectedPackages[commit], pkg)
}

for pkgName, apiVers := range r.ModifiedPackages {
for apiVer := range apiVers {
c.AffectedPackages[commit] = append(c.AffectedPackages[commit], fmt.Sprintf("%s/%s", pkgName, apiVer))
}
for pkgName := range r.ModifiedPackages {
c.AffectedPackages[commit] = append(c.AffectedPackages[commit], pkgName)
}

for pkgName, apiVers := range r.RemovedPackages {
for _, apiVer := range apiVers {
c.AffectedPackages[commit] = append(c.AffectedPackages[commit], fmt.Sprintf("%s/%s", pkgName, apiVer))
}
for _, pkg := range r.RemovedPackages {
c.AffectedPackages[commit] = append(c.AffectedPackages[commit], pkg)
}
}

Expand Down Expand Up @@ -277,30 +265,22 @@ func getPkgsReport(lhs, rhs repoContent) pkgsReport {
}

// diff packages
for rhsK, rhsV := range rhs {
if _, ok := lhs[rhsK]; !ok {
for rhsPkg, rhsCnt := range rhs {
if _, ok := lhs[rhsPkg]; !ok {
continue
}
for rhsAPI, rhsCnt := range rhsV {
if _, ok := lhs[rhsK][rhsAPI]; !ok {
continue
if r := getPkgReport(lhs[rhsPkg], rhsCnt); !r.isEmpty() {
if r.hasBreakingChanges() {
report.modPkgHasBreaking = true
}
if r := getPkgReport(lhs[rhsK][rhsAPI], rhsCnt); !r.isEmpty() {
if r.hasBreakingChanges() {
report.modPkgHasBreaking = true
}
if r.hasAdditiveChanges() {
report.modPkgHasAdditions = true
}
// only add an entry if the report contains data
if report.ModifiedPackages == nil {
report.ModifiedPackages = modifiedPackages{}
}
if _, ok := report.ModifiedPackages[rhsK]; !ok {
report.ModifiedPackages[rhsK] = map[string]pkgReport{}
}
report.ModifiedPackages[rhsK][rhsAPI] = r
if r.hasAdditiveChanges() {
report.modPkgHasAdditions = true
}
// only add an entry if the report contains data
if report.ModifiedPackages == nil {
report.ModifiedPackages = modifiedPackages{}
}
report.ModifiedPackages[rhsPkg] = r
}
}

Expand All @@ -310,26 +290,9 @@ func getPkgsReport(lhs, rhs repoContent) pkgsReport {
// returns a list of packages in rhs that aren't in lhs
func getPkgsList(lhs, rhs repoContent) pkgsList {
list := pkgsList{}
for rhsK, rhsV := range rhs {
if lhsV, ok := lhs[rhsK]; !ok {
// package doesn't exist, add all API versions
apis := []string{}
for rhsAPI := range rhsV {
apis = append(apis, rhsAPI)
}
list[rhsK] = apis
} else {
// package exists, check for any new API versions
for rhsAPI := range rhsV {
apis := []string{}
if _, ok := lhsV[rhsAPI]; !ok {
// API version is new, add to slice
apis = append(apis, rhsAPI)
}
if len(apis) > 0 {
list[rhsK] = apis
}
}
for rhsPkg := range rhs {
if _, ok := lhs[rhsPkg]; !ok {
list = append(list, rhsPkg)
}
}
return list
Expand Down

0 comments on commit 4c729a2

Please sign in to comment.