Merge branch 'master' into paths_pkg

Author: jmank88

FAQ.md

@@ -18,6 +18,7 @@ Summarize the question and quote the reply, linking back to the original comment
 * [Can I put the manifest and lock in the vendor directory?](#can-i-put-the-manifest-and-lock-in-the-vendor-directory)
 * [Why did dep use a different revision for package X instead of the revision in the lock file?](#why-did-dep-use-a-different-revision-for-package-x-instead-of-the-revision-in-the-lock-file)
 * [Why is `dep` slow?](#why-is-dep-slow)
+* [How does `dep` handle symbolic links?](#how-does-dep-handle-symbolic-links)
 
 ## What is the difference between Gopkg.toml (the "manifest") and Gopkg.lock (the "lock")?
 
@@ -178,4 +179,16 @@ gateway to all of these improvements.
 
 There's another major performance issue that's much harder - the process of picking versions itself is an NP-complete problem in `dep`'s current design. This is a much trickier problem 😜
 
+## How does `dep` handle symbolic links?
+
+> because we're not crazy people who delight in inviting chaos into our lives, we need to work within one GOPATH at a time.
+-[@sdboyer in #247](https://github.com/golang/dep/pull/247#issuecomment-284181879)
+
+Out of convenience, one might create a symlink to a directory within their `GOPATH`, e.g. `ln -s ~/go/src/github.com/golang/dep dep`. When `dep` is invoked it will resolve the current working directory accordingly:
+
+- If the cwd is a symlink outside a `GOPATH` and links to directory within a `GOPATH`, or vice versa, `dep` chooses whichever path is within the `GOPATH`.  If neither path is within a `GOPATH`, `dep` produces an error.
+- If both the cwd and resolved path are in the same `GOPATH`, an error is thrown since the users intentions and expectations can't be accurately deduced.
+- If the symlink is within a `GOPATH` and the real path is within a *different* `GOPATH` - an error is thrown.
+
+This is the only symbolic link support that `dep` really intends to provide. In keeping with the general practices of the `go` tool, `dep` tends to either ignore symlinks (when walking) or copy the symlink itself, depending on the filesystem operation being performed.
 

cmd/dep/ensure_test.go

@@ -11,6 +11,8 @@ import (
 )
 
 func TestDeduceConstraint(t *testing.T) {
+	t.Parallel()
+
 	sv, err := gps.NewSemverConstraint("v1.2.3")
 	if err != nil {
 		t.Fatal(err)

cmd/dep/graphviz_test.go

@@ -11,10 +11,12 @@ import (
 )
 
 func TestEmptyProject(t *testing.T) {
-	g := new(graphviz).New()
 	h := test.NewHelper(t)
+	h.Parallel()
 	defer h.Cleanup()
 
+	g := new(graphviz).New()
+
 	b := g.output()
 	want := h.GetTestFileString("graphviz/empty.dot")
 
@@ -24,10 +26,12 @@ func TestEmptyProject(t *testing.T) {
 }
 
 func TestSimpleProject(t *testing.T) {
-	g := new(graphviz).New()
 	h := test.NewHelper(t)
+	h.Parallel()
 	defer h.Cleanup()
 
+	g := new(graphviz).New()
+
 	g.createNode("project", "", []string{"foo", "bar"})
 	g.createNode("foo", "master", []string{"bar"})
 	g.createNode("bar", "dev", []string{})
@@ -40,10 +44,12 @@ func TestSimpleProject(t *testing.T) {
 }
 
 func TestNoLinks(t *testing.T) {
-	g := new(graphviz).New()
 	h := test.NewHelper(t)
+	h.Parallel()
 	defer h.Cleanup()
 
+	g := new(graphviz).New()
+
 	g.createNode("project", "", []string{})
 
 	b := g.output()
@@ -54,6 +60,8 @@ func TestNoLinks(t *testing.T) {
 }
 
 func TestIsPathPrefix(t *testing.T) {
+	t.Parallel()
+
 	tcs := []struct {
 		path string
 		pre  string

cmd/dep/init_test.go

@@ -12,6 +12,8 @@ import (
 )
 
 func TestContains(t *testing.T) {
+	t.Parallel()
+
 	a := []string{"a", "b", "abcd"}
 
 	if !contains(a, "a") {
@@ -23,6 +25,8 @@ func TestContains(t *testing.T) {
 }
 
 func TestGetProjectPropertiesFromVersion(t *testing.T) {
+	t.Parallel()
+
 	wantSemver, _ := gps.NewSemverConstraint("^v1.0.0")
 	cases := []struct {
 		version, want gps.Constraint

cmd/dep/integration_test.go

@@ -18,6 +18,8 @@ import (
 )
 
 func TestIntegration(t *testing.T) {
+	t.Parallel()
+
 	test.NeedsExternalNetwork(t)
 	test.NeedsGit(t)
 

cmd/dep/remove_test.go

@@ -12,6 +12,8 @@ import (
 )
 
 func TestRemoveErrors(t *testing.T) {
+	t.Parallel()
+
 	test.NeedsExternalNetwork(t)
 	test.NeedsGit(t)
 
@@ -27,6 +29,8 @@ func TestRemoveErrors(t *testing.T) {
 
 func removeErrors(name, wd string, externalProc bool, run test.RunFunc) func(*testing.T) {
 	return func(t *testing.T) {
+		t.Parallel()
+
 		testCase := test.NewTestCase(t, name, "harness_tests", wd)
 		testProj := test.NewTestProject(t, testCase.InitialPath(), wd, externalProc, run)
 		defer testProj.Cleanup()

cmd/dep/status_test.go

@@ -11,6 +11,8 @@ import (
 )
 
 func TestStatusFormatVersion(t *testing.T) {
+	t.Parallel()
+
 	tests := map[gps.Version]string{
 		nil: "",
 		gps.NewBranch("master"):        "branch master",

internal/test/test.go

@@ -77,8 +77,8 @@ func (h *Helper) check(err error) {
 	}
 }
 
-// parallel runs the test in parallel by calling t.Parallel.
-func (h *Helper) parallel() {
+// Parallel runs the test in parallel by calling t.Parallel.
+func (h *Helper) Parallel() {
 	if h.ran {
 		h.t.Fatalf("%+v", errors.New("internal testsuite error: call to parallel after run"))
 	}