source_cache_test.go

// Copyright 2017 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package gps

import (
	"io/ioutil"
	"log"
	"path"
	"reflect"
	"sort"
	"testing"
	"time"

	"github.com/golang/dep/gps/pkgtree"
	"github.com/golang/dep/internal/test"
	"github.com/pkg/errors"
)

func Test_singleSourceCache(t *testing.T) {
	newMem := func(*testing.T, string) sourceCache {
		return memoryCache{}
	}
	t.Run("mem", singleSourceCacheTest{newCache: newMem}.run)

	epoch := time.Now().Unix()
	newBolt := func(t *testing.T, cachedir string) sourceCache {
		bc, err := newBoltCache(cachedir, epoch, log.New(test.Writer{TB: t}, "", 0))
		if err != nil {
			t.Fatal(err)
		}
		return bc
	}
	t.Run("bolt/keepOpen", singleSourceCacheTest{newCache: newBolt}.run)
	t.Run("bolt/reOpen", singleSourceCacheTest{newCache: newBolt, persistent: true}.run)

	newMulti := func(t *testing.T, cachedir string) sourceCache {
		bc, err := newBoltCache(cachedir, epoch, log.New(test.Writer{TB: t}, "", 0))
		if err != nil {
			t.Fatal(err)
		}
		return newMultiCache(memoryCache{}, bc)
	}
	t.Run("multi/keepOpen", singleSourceCacheTest{newCache: newMulti}.run)
	t.Run("multi/reOpen", singleSourceCacheTest{persistent: true, newCache: newMulti}.run)

	t.Run("multi/keepOpen/noDisk", singleSourceCacheTest{
		newCache: func(*testing.T, string) sourceCache {
			return newMultiCache(memoryCache{}, discardCache{})
		},
	}.run)

	t.Run("multi/reOpen/noMem", singleSourceCacheTest{
		persistent: true,
		newCache: func(t *testing.T, cachedir string) sourceCache {
			bc, err := newBoltCache(cachedir, epoch, log.New(test.Writer{TB: t}, "", 0))
			if err != nil {
				t.Fatal(err)
			}
			return newMultiCache(discardCache{}, bc)
		},
	}.run)
}

var testAnalyzerInfo = ProjectAnalyzerInfo{
	Name:    "test-analyzer",
	Version: 1,
}

type singleSourceCacheTest struct {
	newCache   func(*testing.T, string) sourceCache
	persistent bool
}

// run tests singleSourceCache methods of caches returned by test.newCache.
// For test.persistent caches, test.newCache is periodically called mid-test to ensure persistence.
func (test singleSourceCacheTest) run(t *testing.T) {
	const root = "example.com/test"
	pi := mkPI(root).normalize()
	cpath, err := ioutil.TempDir("", "singlesourcecache")
	if err != nil {
		t.Fatalf("Failed to create temp cache dir: %s", err)
	}

	t.Run("info", func(t *testing.T) {
		const rev Revision = "revision"

		sc := test.newCache(t, cpath)
		c := sc.newSingleSourceCache(pi)
		defer func() {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
		}()

		var m Manifest = &simpleRootManifest{
			c: ProjectConstraints{
				ProjectRoot("foo"): ProjectProperties{
					Constraint: Any(),
				},
				ProjectRoot("bar"): ProjectProperties{
					Source:     "whatever",
					Constraint: testSemverConstraint(t, "> 1.3"),
				},
			},
			ovr: ProjectConstraints{
				ProjectRoot("b"): ProjectProperties{
					Constraint: testSemverConstraint(t, "2.0.0"),
				},
			},
			req: map[string]bool{
				"c": true,
				"d": true,
			},
			ig: pkgtree.NewIgnoredRuleset([]string{"a", "b"}),
		}
		var l Lock = &safeLock{
			p: []LockedProject{
				NewLockedProject(mkPI("github.com/sdboyer/gps"), NewVersion("v0.10.0").Pair("anything"), []string{"gps"}),
				NewLockedProject(mkPI("github.com/sdboyer/gps2"), NewVersion("v0.10.0").Pair("whatever"), nil),
				NewLockedProject(mkPI("github.com/sdboyer/gps3"), NewVersion("v0.10.0").Pair("again"), []string{"gps", "flugle"}),
				NewLockedProject(mkPI("foo"), NewVersion("nada").Pair("itsaliving"), []string{"foo"}),
				NewLockedProject(mkPI("github.com/sdboyer/gps4"), NewVersion("v0.10.0").Pair("meow"), []string{"flugle", "gps"}),
			},
		}
		c.setManifestAndLock(rev, testAnalyzerInfo, m, l)

		if test.persistent {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
			sc = test.newCache(t, cpath)
			c = sc.newSingleSourceCache(pi)
		}

		gotM, gotL, ok := c.getManifestAndLock(rev, testAnalyzerInfo)
		if !ok {
			t.Error("no manifest and lock found for revision")
		}
		compareManifests(t, m, gotM)
		// TODO(sdboyer) use DiffLocks after refactoring to avoid import cycles
		if !locksAreEq(l, gotL) {
			t.Errorf("locks are different:\n\t(GOT): %s\n\t(WNT): %s", l, gotL)
		}

		m = &simpleRootManifest{
			c: ProjectConstraints{
				ProjectRoot("foo"): ProjectProperties{
					Source:     "whatever",
					Constraint: Any(),
				},
			},
			ovr: ProjectConstraints{
				ProjectRoot("bar"): ProjectProperties{
					Constraint: testSemverConstraint(t, "2.0.0"),
				},
			},
			req: map[string]bool{
				"a": true,
				"b": true,
			},
			ig: pkgtree.NewIgnoredRuleset([]string{"c", "d"}),
		}
		l = &safeLock{
			p: []LockedProject{
				NewLockedProject(mkPI("github.com/sdboyer/gps"), NewVersion("v0.10.0").Pair("278a227dfc3d595a33a77ff3f841fd8ca1bc8cd0"), []string{"gps"}),
				NewLockedProject(mkPI("github.com/sdboyer/gps2"), NewVersion("v0.11.0").Pair("anything"), []string{"gps"}),
				NewLockedProject(mkPI("github.com/sdboyer/gps3"), Revision("278a227dfc3d595a33a77ff3f841fd8ca1bc8cd0"), []string{"gps"}),
			},
		}
		c.setManifestAndLock(rev, testAnalyzerInfo, m, l)

		if test.persistent {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
			sc = test.newCache(t, cpath)
			c = sc.newSingleSourceCache(pi)
		}

		gotM, gotL, ok = c.getManifestAndLock(rev, testAnalyzerInfo)
		if !ok {
			t.Error("no manifest and lock found for revision")
		}
		compareManifests(t, m, gotM)
		// TODO(sdboyer) use DiffLocks after refactoring to avoid import cycles
		if !locksAreEq(l, gotL) {
			t.Errorf("locks are different:\n\t(GOT): %s\n\t(WNT): %s", l, gotL)
		}
	})

	t.Run("pkgTree", func(t *testing.T) {
		sc := test.newCache(t, cpath)
		c := sc.newSingleSourceCache(pi)
		defer func() {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
		}()

		const rev Revision = "rev_adsfjkl"

		if got, ok := c.getPackageTree(rev, root); ok {
			t.Fatalf("unexpected result before setting package tree: %v", got)
		}

		if test.persistent {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
			sc = test.newCache(t, cpath)
			c = sc.newSingleSourceCache(pi)
		}

		pt := pkgtree.PackageTree{
			ImportRoot: root,
			Packages: map[string]pkgtree.PackageOrErr{
				root: {
					P: pkgtree.Package{
						ImportPath:  root,
						CommentPath: "comment",
						Name:        "test",
						Imports: []string{
							"sort",
						},
					},
				},
				path.Join(root, "simple"): {
					P: pkgtree.Package{
						ImportPath:  path.Join(root, "simple"),
						CommentPath: "comment",
						Name:        "simple",
						Imports: []string{
							"github.com/golang/dep/gps",
							"sort",
						},
					},
				},
				path.Join(root, "m1p"): {
					P: pkgtree.Package{
						ImportPath:  path.Join(root, "m1p"),
						CommentPath: "",
						Name:        "m1p",
						Imports: []string{
							"github.com/golang/dep/gps",
							"os",
							"sort",
						},
					},
				},
			},
		}
		c.setPackageTree(rev, pt)

		if test.persistent {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
			sc = test.newCache(t, cpath)
			c = sc.newSingleSourceCache(pi)
		}

		got, ok := c.getPackageTree(rev, root)
		if !ok {
			t.Errorf("no package tree found:\n\t(WNT): %#v", pt)
		}
		comparePackageTree(t, pt, got)

		if test.persistent {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
			sc = test.newCache(t, cpath)
			c = sc.newSingleSourceCache(pi)
		}

		pt = pkgtree.PackageTree{
			ImportRoot: root,
			Packages: map[string]pkgtree.PackageOrErr{
				path.Join(root, "test"): {
					Err: errors.New("error"),
				},
			},
		}
		c.setPackageTree(rev, pt)

		if test.persistent {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
			sc = test.newCache(t, cpath)
			c = sc.newSingleSourceCache(pi)
		}

		got, ok = c.getPackageTree(rev, root)
		if !ok {
			t.Errorf("no package tree found:\n\t(WNT): %#v", pt)
		}
		comparePackageTree(t, pt, got)
	})

	t.Run("versions", func(t *testing.T) {
		sc := test.newCache(t, cpath)
		c := sc.newSingleSourceCache(pi)
		defer func() {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
		}()

		const rev1, rev2 = "rev1", "rev2"
		const br, ver = "branch_name", "2.10"
		versions := []PairedVersion{
			NewBranch(br).Pair(rev1),
			NewVersion(ver).Pair(rev2),
		}
		SortPairedForDowngrade(versions)
		c.setVersionMap(versions)

		if test.persistent {
			if err := sc.close(); err != nil {
				t.Fatal("failed to close cache:", err)
			}
			sc = test.newCache(t, cpath)
			c = sc.newSingleSourceCache(pi)
		}

		t.Run("getAllVersions", func(t *testing.T) {
			got, ok := c.getAllVersions()
			if !ok || len(got) != len(versions) {
				t.Errorf("unexpected versions:\n\t(GOT): %#v\n\t(WNT): %#v", got, versions)
			} else {
				SortPairedForDowngrade(got)
				for i := range versions {
					if !versions[i].identical(got[i]) {
						t.Errorf("unexpected versions:\n\t(GOT): %#v\n\t(WNT): %#v", got, versions)
						break
					}
				}
			}
		})

		revToUV := map[Revision]UnpairedVersion{
			rev1: NewBranch(br),
			rev2: NewVersion(ver),
		}

		t.Run("getVersionsFor", func(t *testing.T) {
			for rev, want := range revToUV {
				rev, want := rev, want
				t.Run(string(rev), func(t *testing.T) {
					uvs, ok := c.getVersionsFor(rev)
					if !ok {
						t.Errorf("no version found:\n\t(WNT) %#v", want)
					} else if len(uvs) != 1 {
						t.Errorf("expected one result but got %d", len(uvs))
					} else {
						uv := uvs[0]
						if uv.Type() != want.Type() {
							t.Errorf("expected version type %d but got %d", want.Type(), uv.Type())
						}
						if uv.String() != want.String() {
							t.Errorf("expected version %q but got %q", want.String(), uv.String())
						}
					}
				})
			}
		})

		t.Run("getRevisionFor", func(t *testing.T) {
			for want, uv := range revToUV {
				want, uv := want, uv
				t.Run(uv.String(), func(t *testing.T) {
					rev, ok := c.getRevisionFor(uv)
					if !ok {
						t.Errorf("expected revision %q but got none", want)
					} else if rev != want {
						t.Errorf("expected revision %q but got %q", want, rev)
					}
				})
			}
		})

		t.Run("toRevision", func(t *testing.T) {
			for want, uv := range revToUV {
				want, uv := want, uv
				t.Run(uv.String(), func(t *testing.T) {
					rev, ok := c.toRevision(uv)
					if !ok {
						t.Errorf("expected revision %q but got none", want)
					} else if rev != want {
						t.Errorf("expected revision %q but got %q", want, rev)
					}
				})
			}
		})

		t.Run("toUnpaired", func(t *testing.T) {
			for rev, want := range revToUV {
				rev, want := rev, want
				t.Run(want.String(), func(t *testing.T) {
					uv, ok := c.toUnpaired(rev)
					if !ok {
						t.Errorf("no UnpairedVersion found:\n\t(WNT): %#v", uv)
					} else if !uv.identical(want) {
						t.Errorf("unexpected UnpairedVersion:\n\t(GOT): %#v\n\t(WNT): %#v", uv, want)
					}
				})
			}
		})
	})
}

// compareManifests compares two manifests and reports differences as test errors.
func compareManifests(t *testing.T, want, got Manifest) {
	if (want == nil || got == nil) && (got != nil || want != nil) {
		t.Errorf("one manifest is nil:\n\t(GOT): %#v\n\t(WNT): %#v", got, want)
		return
	}
	{
		want, got := want.DependencyConstraints(), got.DependencyConstraints()
		if !projectConstraintsEqual(want, got) {
			t.Errorf("unexpected constraints:\n\t(GOT): %#v\n\t(WNT): %#v", got, want)
		}
	}

	wantRM, wantOK := want.(RootManifest)
	gotRM, gotOK := got.(RootManifest)
	if wantOK && !gotOK {
		t.Errorf("expected RootManifest:\n\t(GOT): %#v", got)
		return
	}
	if gotOK && !wantOK {
		t.Errorf("didn't expected RootManifest:\n\t(GOT): %#v", got)
		return
	}

	{
		want, got := wantRM.IgnoredPackages(), gotRM.IgnoredPackages()
		if !reflect.DeepEqual(want.ToSlice(), got.ToSlice()) {
			t.Errorf("unexpected ignored packages:\n\t(GOT): %#v\n\t(WNT): %#v", got, want)
		}
	}

	{
		want, got := wantRM.Overrides(), gotRM.Overrides()
		if !projectConstraintsEqual(want, got) {
			t.Errorf("unexpected overrides:\n\t(GOT): %#v\n\t(WNT): %#v", got, want)
		}
	}

	{
		want, got := wantRM.RequiredPackages(), gotRM.RequiredPackages()
		if !mapStringBoolEqual(want, got) {
			t.Errorf("unexpected required packages:\n\t(GOT): %#v\n\t(WNT): %#v", got, want)
		}
	}
}

// comparePackageTree compares two pkgtree.PackageTree and reports differences as test errors.
func comparePackageTree(t *testing.T, want, got pkgtree.PackageTree) {
	if got.ImportRoot != want.ImportRoot {
		t.Errorf("expected package tree root %q but got %q", want.ImportRoot, got.ImportRoot)
	}
	{
		want, got := want.Packages, got.Packages
		if len(want) != len(got) {
			t.Errorf("unexpected packages:\n\t(GOT): %#v\n\t(WNT): %#v", got, want)
		} else {
			for k, v := range want {
				if v2, ok := got[k]; !ok {
					t.Errorf("key %s: expected %v but got none", k, v)
				} else if !packageOrErrEqual(v, v2) {
					t.Errorf("key %s: expected %v but got %v", k, v, v2)
				}
			}
		}
	}
}

func projectConstraintsEqual(want, got ProjectConstraints) bool {
	loop, check := want, got
	if len(got) > len(want) {
		loop, check = got, want
	}
	for pr, pp := range loop {
		pp2, ok := check[pr]
		if !ok {
			return false
		}
		if pp.Source != pp2.Source {
			return false
		}
		if pp.Constraint == nil || pp2.Constraint == nil {
			if pp.Constraint != nil || pp2.Constraint != nil {
				return false
			}
		} else if !pp.Constraint.identical(pp2.Constraint) {
			return false
		}
	}
	return true
}

func mapStringBoolEqual(exp, got map[string]bool) bool {
	loop, check := exp, got
	if len(got) > len(exp) {
		loop, check = got, exp
	}
	for k, v := range loop {
		v2, ok := check[k]
		if !ok || v != v2 {
			return false
		}
	}
	return true
}

func safeError(err error) string {
	if err == nil {
		return ""
	}
	return err.Error()
}

// packageOrErrEqual return true if the pkgtree.PackageOrErrs are equal. Error equality is
// string based. Imports and TestImports are treated as sets, and will be sorted.
func packageOrErrEqual(a, b pkgtree.PackageOrErr) bool {
	if safeError(a.Err) != safeError(b.Err) {
		return false
	}
	if a.P.Name != b.P.Name {
		return false
	}
	if a.P.ImportPath != b.P.ImportPath {
		return false
	}
	if a.P.CommentPath != b.P.CommentPath {
		return false
	}

	if len(a.P.Imports) != len(b.P.Imports) {
		return false
	}
	sort.Strings(a.P.Imports)
	sort.Strings(b.P.Imports)
	for i := range a.P.Imports {
		if a.P.Imports[i] != b.P.Imports[i] {
			return false
		}
	}

	if len(a.P.TestImports) != len(b.P.TestImports) {
		return false
	}
	sort.Strings(a.P.TestImports)
	sort.Strings(b.P.TestImports)
	for i := range a.P.TestImports {
		if a.P.TestImports[i] != b.P.TestImports[i] {
			return false
		}
	}

	return true
}

// discardCache produces singleSourceDiscardCaches.
type discardCache struct{}

func (discardCache) newSingleSourceCache(ProjectIdentifier) singleSourceCache {
	return discard
}

func (discardCache) close() error { return nil }

var discard singleSourceCache = singleSourceDiscardCache{}

// singleSourceDiscardCache discards set values and returns nothing.
type singleSourceDiscardCache struct{}

func (singleSourceDiscardCache) setManifestAndLock(Revision, ProjectAnalyzerInfo, Manifest, Lock) {}

func (singleSourceDiscardCache) getManifestAndLock(Revision, ProjectAnalyzerInfo) (Manifest, Lock, bool) {
	return nil, nil, false
}

func (singleSourceDiscardCache) setPackageTree(Revision, pkgtree.PackageTree) {}

func (singleSourceDiscardCache) getPackageTree(Revision, ProjectRoot) (pkgtree.PackageTree, bool) {
	return pkgtree.PackageTree{}, false
}

func (singleSourceDiscardCache) markRevisionExists(r Revision) {}

func (singleSourceDiscardCache) setVersionMap(versionList []PairedVersion) {}

func (singleSourceDiscardCache) getVersionsFor(Revision) ([]UnpairedVersion, bool) {
	return nil, false
}

func (singleSourceDiscardCache) getAllVersions() ([]PairedVersion, bool) {
	return nil, false
}

func (singleSourceDiscardCache) getRevisionFor(UnpairedVersion) (Revision, bool) {
	return "", false
}

func (singleSourceDiscardCache) toRevision(v Version) (Revision, bool) {
	return "", false
}

func (singleSourceDiscardCache) toUnpaired(v Version) (UnpairedVersion, bool) {
	return nil, false
}