Skip to content

Commit d84f0e7

Browse files
juanvallejojuanvallejo
committed
add tests
1 parent 2f84236 commit d84f0e7

File tree

2 files changed

+258
-24
lines changed

2 files changed

+258
-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

+216
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
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+
},
52+
},
53+
{
54+
ImportPath: "foo.com/bar/baz/vendor/vendor.com/ours",
55+
Imports: []string{
56+
"fmt",
57+
},
58+
},
59+
{
60+
ImportPath: "foo.com/bar/baz/vendor/vendor.com/mine",
61+
Imports: []string{
62+
"fmt",
63+
},
64+
},
65+
},
66+
},
67+
}
68+
69+
// add roots
70+
opts.Roots = []string{
71+
"foo.com/bar/baz",
72+
"foo.com/bar/baz/one",
73+
"foo.com/bar/baz/two",
74+
}
75+
76+
return opts
77+
}
78+
79+
func TestGraphAnalysisCalculatesDependencyRoots(t *testing.T) {
80+
opts := &AnalyzeOptions{
81+
GraphOptions: newGraphOptions(),
82+
Dependencies: []string{
83+
"foo.com/bar/baz/vendor/vendor.com/one",
84+
},
85+
}
86+
87+
expected := []string{"foo.com/bar/baz/vendor/vendor.com/one"}
88+
89+
g, err := opts.GraphOptions.BuildGraph()
90+
if err != nil {
91+
t.Fatalf("unexpected error: %v", err)
92+
}
93+
94+
actual, err := opts.calculateYoursRoots(g)
95+
if err != nil {
96+
t.Fatalf("unexpected error: %v", err)
97+
}
98+
99+
if len(actual) != len(expected) {
100+
t.Fatalf("node count mismatch; expecting %v \"yours\" roots, but got %v", len(expected), len(actual))
101+
}
102+
103+
for idx := range actual {
104+
if actual[idx].UniqueName != expected[idx] {
105+
t.Fatalf("expecting root with import path %q but saw %q", expected[idx], actual[idx].UniqueName)
106+
}
107+
}
108+
}
109+
110+
func TestGraphAnalyzisCalculatesYoursDependencies(t *testing.T) {
111+
opts := &AnalyzeOptions{
112+
GraphOptions: newGraphOptions(),
113+
Dependencies: []string{
114+
"foo.com/bar/baz/vendor/vendor.com/one",
115+
},
116+
}
117+
118+
g, err := opts.GraphOptions.BuildGraph()
119+
if err != nil {
120+
t.Fatalf("unexpected error: %v", err)
121+
}
122+
123+
yoursRoots, err := opts.calculateYoursRoots(g)
124+
if err != nil {
125+
t.Fatalf("unexpected error: %v", err)
126+
}
127+
128+
// dependencies unique to the vendored dependency we are analyzing
129+
expected := []string{
130+
"vendor.com/two",
131+
"vendor.com/three",
132+
}
133+
actual := analyze.FindExclusiveDependencies(g, yoursRoots)
134+
135+
if len(expected) != len(actual) {
136+
t.Fatalf("node count mismatch; expecting %v \"yours\" dependencies, but got %v", len(expected), len(actual))
137+
}
138+
139+
for _, expectedNode := range expected {
140+
found := false
141+
for _, actualNode := range actual {
142+
if actualNode.String() == expectedNode {
143+
found = true
144+
break
145+
}
146+
}
147+
if !found {
148+
t.Fatalf("expected \"yours\" dependency %q was not found", expectedNode)
149+
}
150+
}
151+
}
152+
153+
func TestGraphAnalyzisCalculatesMineAndOurs(t *testing.T) {
154+
opts := &AnalyzeOptions{
155+
GraphOptions: newGraphOptions(),
156+
Dependencies: []string{
157+
"foo.com/bar/baz/vendor/vendor.com/one",
158+
},
159+
}
160+
161+
g, err := opts.GraphOptions.BuildGraph()
162+
if err != nil {
163+
t.Fatalf("unexpected error: %v", err)
164+
}
165+
166+
yoursRoots, err := opts.calculateYoursRoots(g)
167+
if err != nil {
168+
t.Fatalf("unexpected error: %v", err)
169+
}
170+
171+
expectedMine := []string{
172+
"vendor.com/one",
173+
"vendor.com/mine",
174+
}
175+
expectedOurs := []string{
176+
"vendor.com/ours",
177+
}
178+
179+
mine, ours, err := opts.calculateMineOurs(g, analyze.FindExclusiveDependencies(g, yoursRoots))
180+
if err != nil {
181+
t.Fatalf("unexpected error: %v", err)
182+
}
183+
184+
if len(ours) != len(expectedOurs) {
185+
t.Fatalf("node count mismatch; expecting %v \"ours\" dependencies, but got %v", len(expectedOurs), len(ours))
186+
}
187+
if len(mine) != len(expectedMine) {
188+
t.Fatalf("node count mismatch; expecting %v \"mine\" dependencies, but got %v", len(expectedMine), len(mine))
189+
}
190+
191+
for _, expected := range expectedOurs {
192+
found := false
193+
for _, actualOurs := range ours {
194+
if expected == actualOurs.String() {
195+
found = true
196+
break
197+
}
198+
}
199+
if !found {
200+
t.Fatalf("expected \"ours\" dependency %q was not found", expected)
201+
}
202+
}
203+
204+
for _, expected := range expectedMine {
205+
found := false
206+
for _, actualMine := range mine {
207+
if expected == actualMine.String() {
208+
found = true
209+
break
210+
}
211+
}
212+
if !found {
213+
t.Fatalf("expected \"ours\" dependency %q was not found", expected)
214+
}
215+
}
216+
}

0 commit comments

Comments
 (0)