add glog for skipped packages

Author: juanvallejo

tools/depcheck/pkg/cmd/cmd.go

@@ -1,10 +1,12 @@
 package cmd
 
 import (
+	"flag"
 	"fmt"
 	"io"
 
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 
 	"github.com/openshift/origin/tools/depcheck/pkg/cmd/trace"
 )
@@ -13,7 +15,7 @@ func NewCmdDepCheck(name string, out, errout io.Writer) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     fmt.Sprintf("%s (ARGUMENT) [OPTIONS]", name),
 		Short:   "Gather information about a dependency tree.",
-		Long:    "Modfify or gather information about a dependency tree.",
+		Long:    "Modify or gather information about a dependency tree.",
 		Example: fmt.Sprintf(pinImportsExample, name),
 		RunE: func(c *cobra.Command, args []string) error {
 			c.SetOutput(errout)
@@ -23,5 +25,9 @@ func NewCmdDepCheck(name string, out, errout io.Writer) *cobra.Command {
 
 	cmd.AddCommand(NewCmdPinImports(name, out, errout))
 	cmd.AddCommand(trace.NewCmdTraceImports(name, out, errout))
+
+	// add glog flags to our global flag set
+	pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
+	pflag.CommandLine.Set("logtostderr", "true")
 	return cmd
 }

tools/depcheck/pkg/cmd/trace/pkg.go

@@ -5,6 +5,8 @@ import (
 	"regexp"
 	"strings"
 
+	"github.com/golang/glog"
+
 	"github.com/gonum/graph/concrete"
 
 	depgraph "github.com/openshift/origin/tools/depcheck/pkg/graph"
@@ -94,6 +96,7 @@ func BuildGraph(packages *PackageList, excludes []string) (*depgraph.MutableDire
 				// if a package imports a dependency that we did not visit
 				// while traversing the code tree, ignore it, as it is not
 				// required for the root repository to build.
+				glog.V(1).Infof("Skipping unvisited (missing) dependency %q, which is imported by package %q", dependency, pkg.ImportPath)
 				continue
 			}
 

tools/depcheck/pkg/cmd/trace/pkg_test.go

@@ -69,9 +69,32 @@ var pkgs = &PackageList{
 			ImportPath: "github.com/test/repo/unique/unique_vendor_one",
 			Imports:    []string{},
 		},
+
+		// simulate a package that is not brought in through any of the repo entrypoints
+		// ("github.com/test/repo/root" in this case) but exists in the codebase
+		// because another package that is part of its repo is a transitive dependency
+		// of one of the main repo's entrypoints.
+		{
+			Dir:        "/path/to/github.com/test/repo/unique/unique_vendor_two",
+			ImportPath: "github.com/test/repo/unique/unique_vendor_two",
+			Imports: []string{
+				"github.com/test/repo/no/node/should/exist/for/this/pkg",
+			},
+		},
 	},
 }
 
+// pkgsWithNoNodes is a map containing importPaths for packages
+// that are not expected to have a node in the dependency graph
+var pkgsWithNoNodes = map[string]bool{
+	"github.com/test/repo/no/node/should/exist/for/this/pkg": true,
+}
+
+func shouldHaveNode(name string) bool {
+	_, exists := pkgsWithNoNodes[name]
+	return !exists
+}
+
 func TestBuildGraphCreatesExpectedNodesAndEdges(t *testing.T) {
 	invalidImports := map[string]bool{
 		"fmt": true,
@@ -98,8 +121,16 @@ func TestBuildGraphCreatesExpectedNodesAndEdges(t *testing.T) {
 			}
 
 			to, exists := g.NodeByName(dep)
+			if !shouldHaveNode(dep) {
+				if exists {
+					t.Fatalf("expected node with name %q to not exist", dep)
+				}
+
+				continue
+			}
+
 			if !exists || !g.Has(to) {
-				t.Fatalf("expected node with name ")
+				t.Fatalf("expected node with name %q to exist", dep)
 			}
 
 			if !g.HasEdgeFromTo(from, to) {