Skip to content

Commit 98802b7

Browse files
juanvallejojuanvallejo
committed
add tests
1 parent 2f84236 commit 98802b7

File tree

2 files changed

+279
-24
lines changed

2 files changed

+279
-24
lines changed

‎tools/depcheck/pkg/cmd/analyze.go

+42-24
Original file line numberDiff line numberDiff line change
@@ -113,37 +113,66 @@ func (o *AnalyzeOptions) Run() error {
113113
// - "Mine": a list of every node in the set of dependencies unique to the root nodes.
114114
// - "Ours": a list of every node in the overlapping set between the "Yours" and "Mine" sets.
115115
func (o *AnalyzeOptions) analyzeGraph(g *graph.MutableDirectedGraph) error {
116+
yoursRoots, err := o.calculateYoursRoots(g)
117+
if err != nil {
118+
return err
119+
}
120+
121+
fmt.Printf("Analyzing a total of %v packages\n", len(g.Nodes()))
122+
fmt.Println()
123+
124+
yours := analyze.FindExclusiveDependencies(g, yoursRoots)
125+
fmt.Printf("\"Yours\": %v dependencies exclusive to %q\n", len(yours), yoursRoots)
126+
for _, n := range yours {
127+
fmt.Printf(" - %s\n", n)
128+
}
129+
fmt.Println()
130+
131+
mine, ours, err := o.calculateMineOurs(g, yours)
132+
if err != nil {
133+
return err
134+
}
135+
136+
fmt.Printf("\"Mine\": %v direct (first-level) dependencies exclusive to the origin repo\n", len(mine))
137+
for _, n := range mine {
138+
fmt.Printf(" - %s\n", n)
139+
}
140+
fmt.Println()
141+
142+
fmt.Printf("\"Ours\": %v shared dependencies between the origin repo and %v\n", len(ours), yoursRoots)
143+
for _, n := range ours {
144+
fmt.Printf(" - %s\n", n)
145+
}
146+
147+
return nil
148+
}
149+
150+
func (o *AnalyzeOptions) calculateYoursRoots(g *graph.MutableDirectedGraph) ([]*graph.Node, error) {
116151
yoursRoots := []*graph.Node{}
117152
for _, dep := range o.Dependencies {
118153
n, exists := g.NodeByName(dep)
119154
if !exists {
120-
return fmt.Errorf("unable to find dependency with import path %q", dep)
155+
return nil, fmt.Errorf("unable to find dependency with import path %q", dep)
121156
}
122157
node, ok := n.(*graph.Node)
123158
if !ok {
124-
return fmt.Errorf("expected node to analyze to be of type *graph.Node. Got: %v", n)
159+
return nil, fmt.Errorf("expected node to analyze to be of type *graph.Node. Got: %v", n)
125160
}
126161

127162
yoursRoots = append(yoursRoots, node)
128163
}
129164

130-
fmt.Printf("Analyzing a total of %v packages\n", len(g.Nodes()))
131-
fmt.Println()
132-
133-
yours := analyze.FindExclusiveDependencies(g, yoursRoots)
134-
fmt.Printf("\"Yours\": %v dependencies exclusive to %q\n", len(yours), yoursRoots)
135-
for _, n := range yours {
136-
fmt.Printf(" - %s\n", n)
137-
}
138-
fmt.Println()
165+
return yoursRoots, nil
166+
}
139167

168+
func (o *AnalyzeOptions) calculateMineOurs(g *graph.MutableDirectedGraph, yours []*graph.Node) ([]*graph.Node, []*graph.Node, error) {
140169
// calculate root repo packages, as well as their
141170
// immediate vendor package dependencies
142171
unfilteredMine := map[int]*graph.Node{}
143172
for _, n := range g.Nodes() {
144173
node, ok := n.(*graph.Node)
145174
if !ok {
146-
return fmt.Errorf("expected node to analyze to be of type *graph.Node. Got: %v", n)
175+
return nil, nil, fmt.Errorf("expected node to analyze to be of type *graph.Node. Got: %v", n)
147176
}
148177
if isVendorPackage(node) {
149178
continue
@@ -172,18 +201,7 @@ func (o *AnalyzeOptions) analyzeGraph(g *graph.MutableDirectedGraph) error {
172201
mine = append(mine, n)
173202
}
174203

175-
fmt.Printf("\"Mine\": %v direct (first-level) dependencies exclusive to the origin repo\n", len(mine))
176-
for _, n := range mine {
177-
fmt.Printf(" - %s\n", n)
178-
}
179-
fmt.Println()
180-
181-
fmt.Printf("\"Ours\": %v shared dependencies between the origin repo and %v\n", len(ours), yoursRoots)
182-
for _, n := range ours {
183-
fmt.Printf(" - %s\n", n)
184-
}
185-
186-
return nil
204+
return mine, ours, nil
187205
}
188206

189207
// isVendorPackage receives a *graph.Node and

‎tools/depcheck/pkg/cmd/analyze_test.go

+237
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,237 @@
1+
package cmd
2+
3+
import (
4+
"testing"
5+
6+
"github.com/openshift/origin/tools/depcheck/pkg/analyze"
7+
"github.com/openshift/origin/tools/depcheck/pkg/graph"
8+
)
9+
10+
func newGraphOptions() *graph.GraphOptions {
11+
opts := &graph.GraphOptions{
12+
Packages: &graph.PackageList{
13+
Packages: []graph.Package{
14+
{
15+
ImportPath: "foo.com/bar/baz",
16+
Imports: []string{
17+
"foo.com/bar/baz/one",
18+
"foo.com/bar/baz/two",
19+
},
20+
},
21+
{
22+
ImportPath: "foo.com/bar/baz/one",
23+
Imports: []string{
24+
"foo.com/bar/baz/vendor/vendor.com/one",
25+
"foo.com/bar/baz/vendor/vendor.com/mine",
26+
},
27+
},
28+
{
29+
ImportPath: "foo.com/bar/baz/two",
30+
Imports: []string{
31+
"foo.com/bar/baz/vendor/vendor.com/ours",
32+
},
33+
},
34+
{
35+
ImportPath: "foo.com/bar/baz/vendor/vendor.com/one",
36+
Imports: []string{
37+
"foo.com/bar/baz/vendor/vendor.com/two",
38+
"foo.com/bar/baz/vendor/vendor.com/three",
39+
},
40+
},
41+
{
42+
ImportPath: "foo.com/bar/baz/vendor/vendor.com/two",
43+
Imports: []string{
44+
"fmt",
45+
},
46+
},
47+
{
48+
ImportPath: "foo.com/bar/baz/vendor/vendor.com/three",
49+
Imports: []string{
50+
"foo.com/bar/baz/vendor/vendor.com/ours",
51+
"foo.com/bar/baz/vendor/vendor.com/transitive_ours",
52+
},
53+
},
54+
{
55+
ImportPath: "foo.com/bar/baz/vendor/vendor.com/ours",
56+
Imports: []string{
57+
"foo.com/bar/baz/vendor/vendor.com/transitive_ours",
58+
},
59+
},
60+
{
61+
ImportPath: "foo.com/bar/baz/vendor/vendor.com/mine",
62+
Imports: []string{
63+
"fmt",
64+
},
65+
},
66+
},
67+
},
68+
}
69+
70+
// add roots
71+
opts.Roots = []string{
72+
"foo.com/bar/baz",
73+
"foo.com/bar/baz/one",
74+
"foo.com/bar/baz/two",
75+
}
76+
77+
return opts
78+
}
79+
80+
func TestGraphAnalysisCalculatesDependencyRoots(t *testing.T) {
81+
opts := &AnalyzeOptions{
82+
GraphOptions: newGraphOptions(),
83+
Dependencies: []string{
84+
"foo.com/bar/baz/vendor/vendor.com/one",
85+
},
86+
}
87+
88+
expected := []string{"foo.com/bar/baz/vendor/vendor.com/one"}
89+
90+
g, err := opts.GraphOptions.BuildGraph()
91+
if err != nil {
92+
t.Fatalf("unexpected error: %v", err)
93+
}
94+
95+
actual, err := opts.calculateYoursRoots(g)
96+
if err != nil {
97+
t.Fatalf("unexpected error: %v", err)
98+
}
99+
100+
if len(actual) != len(expected) {
101+
t.Fatalf("node count mismatch; expecting %v \"yours\" roots, but got %v", len(expected), len(actual))
102+
}
103+
104+
for idx := range actual {
105+
if actual[idx].UniqueName != expected[idx] {
106+
t.Fatalf("expecting root with import path %q but saw %q", expected[idx], actual[idx].UniqueName)
107+
}
108+
}
109+
}
110+
111+
func TestGraphAnalyzisCalculatesYoursDependencies(t *testing.T) {
112+
opts := &AnalyzeOptions{
113+
GraphOptions: newGraphOptions(),
114+
Dependencies: []string{
115+
"foo.com/bar/baz/vendor/vendor.com/one",
116+
},
117+
}
118+
119+
g, err := opts.GraphOptions.BuildGraph()
120+
if err != nil {
121+
t.Fatalf("unexpected error: %v", err)
122+
}
123+
124+
yoursRoots, err := opts.calculateYoursRoots(g)
125+
if err != nil {
126+
t.Fatalf("unexpected error: %v", err)
127+
}
128+
129+
// dependencies unique to the vendored dependency we are analyzing
130+
expected := []string{
131+
"vendor.com/two",
132+
"vendor.com/three",
133+
}
134+
actual := analyze.FindExclusiveDependencies(g, yoursRoots)
135+
136+
if len(expected) != len(actual) {
137+
t.Fatalf("node count mismatch; expecting %v \"yours\" dependencies, but got %v", len(expected), len(actual))
138+
}
139+
140+
for _, expectedNode := range expected {
141+
found := false
142+
for _, actualNode := range actual {
143+
if actualNode.String() == expectedNode {
144+
found = true
145+
break
146+
}
147+
}
148+
if !found {
149+
t.Fatalf("expected \"yours\" dependency %q was not found", expectedNode)
150+
}
151+
}
152+
}
153+
154+
func TestGraphAnalyzisCalculatesMineAndOurs(t *testing.T) {
155+
opts := &AnalyzeOptions{
156+
GraphOptions: newGraphOptions(),
157+
Dependencies: []string{
158+
"foo.com/bar/baz/vendor/vendor.com/one",
159+
},
160+
}
161+
162+
g, err := opts.GraphOptions.BuildGraph()
163+
if err != nil {
164+
t.Fatalf("unexpected error: %v", err)
165+
}
166+
167+
yoursRoots, err := opts.calculateYoursRoots(g)
168+
if err != nil {
169+
t.Fatalf("unexpected error: %v", err)
170+
}
171+
172+
expectedMine := []string{
173+
"vendor.com/one",
174+
"vendor.com/mine",
175+
}
176+
expectedOurs := []string{
177+
"vendor.com/ours",
178+
}
179+
180+
// transitive dependencies (that are also not unique to the vendor dep we are analyzing)
181+
expectedMissing := []string{
182+
"vendor.com/transitive_ours",
183+
}
184+
185+
yours := analyze.FindExclusiveDependencies(g, yoursRoots)
186+
mine, ours, err := opts.calculateMineOurs(g, yours)
187+
if err != nil {
188+
t.Fatalf("unexpected error: %v", err)
189+
}
190+
191+
if len(ours) != len(expectedOurs) {
192+
t.Fatalf("node count mismatch; expecting %v \"ours\" dependencies, but got %v", len(expectedOurs), len(ours))
193+
}
194+
if len(mine) != len(expectedMine) {
195+
t.Fatalf("node count mismatch; expecting %v \"mine\" dependencies, but got %v", len(expectedMine), len(mine))
196+
}
197+
198+
for _, expected := range expectedOurs {
199+
found := false
200+
for _, actualOurs := range ours {
201+
if expected == actualOurs.String() {
202+
found = true
203+
break
204+
}
205+
}
206+
if !found {
207+
t.Fatalf("expected \"ours\" dependency %q was not found", expected)
208+
}
209+
}
210+
211+
for _, expected := range expectedMine {
212+
found := false
213+
for _, actualMine := range mine {
214+
if expected == actualMine.String() {
215+
found = true
216+
break
217+
}
218+
}
219+
if !found {
220+
t.Fatalf("expected \"ours\" dependency %q was not found", expected)
221+
}
222+
}
223+
224+
for _, missing := range expectedMissing {
225+
found := false
226+
for _, actual := range append(yours, append(mine, ours...)...) {
227+
if missing == actual.String() {
228+
found = true
229+
break
230+
}
231+
}
232+
233+
if found {
234+
t.Fatalf("expecting %q to be missing, but was found in yours, mine, ours set", missing)
235+
}
236+
}
237+
}

0 commit comments

Comments
 (0)