-
Notifications
You must be signed in to change notification settings - Fork 15
/
run.go
198 lines (165 loc) · 5.75 KB
/
run.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
/*
Copyright 2019 Joe Lanford.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package diff
import (
"fmt"
"go/types"
"strings"
"gopkg.in/src-d/go-git.v4/plumbing"
"golang.org/x/exp/apidiff"
"golang.org/x/tools/go/packages"
"gopkg.in/src-d/go-git.v4"
)
type Options struct {
RepoPath string
OldCommit string
NewCommit string
CompareImports bool
}
func Run(opts Options) (*Diff, error) {
repo, err := git.PlainOpen(opts.RepoPath)
if err != nil {
return nil, fmt.Errorf("failed to open git repo: %w", err)
}
wt, err := repo.Worktree()
if err != nil {
return nil, fmt.Errorf("failed to get git worktree: %w", err)
}
if stat, err := wt.Status(); err != nil {
return nil, fmt.Errorf("failed to get git status: %w", err)
} else if !stat.IsClean() {
return nil, fmt.Errorf("git tree is dirty")
}
origRef, err := repo.Head()
if err != nil {
return nil, fmt.Errorf("failed to get current HEAD reference: %w", err)
}
oldHash, newHash, err := getHashes(repo, plumbing.Revision(opts.OldCommit), plumbing.Revision(opts.NewCommit))
if err != nil {
return nil, fmt.Errorf("failed to lookup git commit hashes: %w", err)
}
defer func() {
if err := checkoutRef(*wt, *origRef); err != nil {
fmt.Printf("WARNING: failed to checkout your original working commit after diff: %v\n", err)
}
}()
selfOld, importsOld, err := getPackages(*wt, *oldHash)
if err != nil {
return nil, fmt.Errorf("failed to get packages from old commit %q (%s): %w", opts.OldCommit, oldHash, err)
}
selfNew, importsNew, err := getPackages(*wt, *newHash)
if err != nil {
return nil, fmt.Errorf("failed to get packages from new commit %q (%s): %w", opts.NewCommit, newHash, err)
}
diff := &Diff{}
diff.selfReports, diff.selfIncompatible = compareChangesAdditionsAndRemovals(selfOld, selfNew)
if opts.CompareImports {
// When comparing imports, we only compare the changes and additions
// between oldPkgs and newPkgs. We ignore removals in newPkgs because
// the removed packages are no longer dependencies and therefore have
// no impact on compatibility of imports.
diff.importsReports, diff.importsIncompatible = compareChangesAndAdditions(importsOld, importsNew)
}
return diff, nil
}
func compareChangesAdditionsAndRemovals(oldPkgs, newPkgs map[string]*packages.Package) (map[string]apidiff.Report, bool) {
reports, incompatible := compareChangesAndAdditions(oldPkgs, newPkgs)
// remove packages from oldPkgs that are present in newPkgs. When this loop
// completes, the packages left in oldPkgs are the ones that were removed
// and no longer used in the new commit of this repo.
//
// This is required for the next loop to be able to report correctly on
// removes between the old commit and new commit.
for k := range newPkgs {
delete(oldPkgs, k)
}
for k, oldPackage := range oldPkgs {
report := apidiff.Changes(oldPackage.Types, types.NewPackage(k, oldPackage.Name))
for _, c := range report.Changes {
if !c.Compatible {
incompatible = true
}
}
reports[k] = report
}
return reports, incompatible
}
func compareChangesAndAdditions(oldPkgs, newPkgs map[string]*packages.Package) (map[string]apidiff.Report, bool) {
reports := map[string]apidiff.Report{}
incompatible := false
for k, newPackage := range newPkgs {
// if this is a brand new package, use a dummy empty package for
// oldPackage, so that everything in newPackage is reported as new.
oldPackage, ok := oldPkgs[k]
if !ok {
oldPackage = &packages.Package{Types: types.NewPackage(newPackage.PkgPath, newPackage.Name)}
}
report := apidiff.Changes(oldPackage.Types, newPackage.Types)
for _, c := range report.Changes {
if !c.Compatible {
incompatible = true
}
}
reports[k] = report
}
return reports, incompatible
}
func getHashes(repo *git.Repository, oldRev, newRev plumbing.Revision) (*plumbing.Hash, *plumbing.Hash, error) {
oldCommitHash, err := repo.ResolveRevision(oldRev)
if err != nil {
return nil, nil, fmt.Errorf("could not get hash for %q: %v", oldRev, err)
}
newCommitHash, err := repo.ResolveRevision(newRev)
if err != nil {
return nil, nil, fmt.Errorf("could not get hash for %q: %v", newRev, err)
}
return oldCommitHash, newCommitHash, nil
}
func getPackages(wt git.Worktree, hash plumbing.Hash) (map[string]*packages.Package, map[string]*packages.Package, error) {
if err := wt.Checkout(&git.CheckoutOptions{
Hash: hash,
}); err != nil {
return nil, nil, err
}
cfg := packages.Config{
Mode: packages.LoadTypes,
Tests: false,
}
pkgs, err := packages.Load(&cfg, "./...")
if err != nil {
return nil, nil, err
}
selfPkgs := make(map[string]*packages.Package)
importPkgs := make(map[string]*packages.Package)
for _, pkg := range pkgs {
// skip internal packages since they do not contain public APIs
if strings.HasSuffix(pkg.PkgPath, "/internal") || strings.Contains(pkg.PkgPath, "/internal/") {
continue
}
selfPkgs[pkg.PkgPath] = pkg
}
for _, pkg := range pkgs {
for _, ipkg := range pkg.Imports {
if _, ok := selfPkgs[ipkg.PkgPath]; !ok {
importPkgs[ipkg.PkgPath] = ipkg
}
}
}
return selfPkgs, importPkgs, nil
}
func checkoutRef(wt git.Worktree, ref plumbing.Reference) (err error) {
if ref.Name() == "HEAD" {
return wt.Checkout(&git.CheckoutOptions{Hash: ref.Hash()})
}
return wt.Checkout(&git.CheckoutOptions{Branch: ref.Name()})
}