mirror of
https://github.com/golang/go
synced 2024-11-18 12:54:44 -07:00
godoc: Add tests for corpus indexing options.
R=bradfitz CC=golang-dev https://golang.org/cl/31370043
This commit is contained in:
Brad Garcia
parent
23d25a2ed7
commit
8880e2e9d7
@ -819,6 +819,9 @@ func (x *Indexer) visitFile(dirname string, fi os.FileInfo) {
|
||||
strings.HasPrefix(dirname, "test/") {
|
||||
return
|
||||
}
|
||||
default:
|
||||
// No indexing turned on.
|
||||
return
|
||||
}
|
||||
|
||||
x.fsOpenGate <- true
|
||||
|
||||
@ -42,6 +42,10 @@ func X() {}
|
||||
"src/pkg/skip/skip.go": `// Package skip should be skipped.
|
||||
package skip
|
||||
func Skip() {}
|
||||
`,
|
||||
"src/pkg/bar/readme.txt": `Whitelisted text file.
|
||||
`,
|
||||
"src/pkg/bar/baz.zzz": `Text file not whitelisted.
|
||||
`,
|
||||
}))
|
||||
c.IndexEnabled = true
|
||||
@ -56,98 +60,191 @@ func Skip() {}
|
||||
}
|
||||
|
||||
func TestIndex(t *testing.T) {
|
||||
c := newCorpus(t)
|
||||
c.UpdateIndex()
|
||||
ix, _ := c.CurrentIndex()
|
||||
if ix == nil {
|
||||
t.Fatal("no index")
|
||||
for _, docs := range []bool{true, false} {
|
||||
for _, goCode := range []bool{true, false} {
|
||||
for _, fullText := range []bool{true, false} {
|
||||
c := newCorpus(t)
|
||||
c.IndexDocs = docs
|
||||
c.IndexGoCode = goCode
|
||||
c.IndexFullText = fullText
|
||||
c.UpdateIndex()
|
||||
ix, _ := c.CurrentIndex()
|
||||
if ix == nil {
|
||||
t.Fatal("no index")
|
||||
}
|
||||
t.Logf("docs, goCode, fullText = %v,%v,%v", docs, goCode, fullText)
|
||||
testIndex(t, c, ix)
|
||||
}
|
||||
}
|
||||
}
|
||||
t.Logf("Got: %#v", ix)
|
||||
testIndex(t, ix)
|
||||
}
|
||||
|
||||
func TestIndexWriteRead(t *testing.T) {
|
||||
c := newCorpus(t)
|
||||
c.UpdateIndex()
|
||||
ix, _ := c.CurrentIndex()
|
||||
if ix == nil {
|
||||
t.Fatal("no index")
|
||||
type key struct {
|
||||
docs, goCode, fullText bool
|
||||
}
|
||||
type val struct {
|
||||
buf *bytes.Buffer
|
||||
c *Corpus
|
||||
}
|
||||
m := map[key]val{}
|
||||
|
||||
var buf bytes.Buffer
|
||||
nw, err := ix.WriteTo(&buf)
|
||||
if err != nil {
|
||||
t.Fatalf("Index.WriteTo: %v", err)
|
||||
for _, docs := range []bool{true, false} {
|
||||
for _, goCode := range []bool{true, false} {
|
||||
for _, fullText := range []bool{true, false} {
|
||||
k := key{docs, goCode, fullText}
|
||||
c := newCorpus(t)
|
||||
c.IndexDocs = docs
|
||||
c.IndexGoCode = goCode
|
||||
c.IndexFullText = fullText
|
||||
c.UpdateIndex()
|
||||
ix, _ := c.CurrentIndex()
|
||||
if ix == nil {
|
||||
t.Fatal("no index")
|
||||
}
|
||||
var buf bytes.Buffer
|
||||
nw, err := ix.WriteTo(&buf)
|
||||
if err != nil {
|
||||
t.Fatalf("Index.WriteTo: %v", err)
|
||||
}
|
||||
m[k] = val{bytes.NewBuffer(buf.Bytes()), c}
|
||||
ix2 := new(Index)
|
||||
nr, err := ix2.ReadFrom(&buf)
|
||||
if err != nil {
|
||||
t.Fatalf("Index.ReadFrom: %v", err)
|
||||
}
|
||||
if nr != nw {
|
||||
t.Errorf("Wrote %d bytes to index but read %d", nw, nr)
|
||||
}
|
||||
testIndex(t, c, ix)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
ix2 := new(Index)
|
||||
nr, err := ix2.ReadFrom(&buf)
|
||||
if err != nil {
|
||||
t.Fatalf("Index.ReadFrom: %v", err)
|
||||
// Test CompatibleWith
|
||||
for k1, v1 := range m {
|
||||
ix := new(Index)
|
||||
if _, err := ix.ReadFrom(v1.buf); err != nil {
|
||||
t.Fatalf("Index.ReadFrom: %v", err)
|
||||
}
|
||||
for k2, v2 := range m {
|
||||
if got, want := ix.CompatibleWith(v2.c), k1 == k2; got != want {
|
||||
t.Errorf("CompatibleWith = %v; want %v for %v, %v", got, want, k1, k2)
|
||||
}
|
||||
}
|
||||
}
|
||||
if nr != nw {
|
||||
t.Errorf("Wrote %d bytes to index but read %d", nw, nr)
|
||||
}
|
||||
testIndex(t, ix2)
|
||||
}
|
||||
|
||||
func testIndex(t *testing.T, ix *Index) {
|
||||
wantStats := Statistics{Bytes: 291, Files: 3, Lines: 20, Words: 8, Spots: 12}
|
||||
if !reflect.DeepEqual(ix.Stats(), wantStats) {
|
||||
t.Errorf("Stats = %#v; want %#v", ix.Stats(), wantStats)
|
||||
}
|
||||
|
||||
func testIndex(t *testing.T, c *Corpus, ix *Index) {
|
||||
if _, ok := ix.words["Skip"]; ok {
|
||||
t.Errorf("the word Skip was found; expected it to be skipped")
|
||||
}
|
||||
checkStats(t, c, ix)
|
||||
checkImportCount(t, c, ix)
|
||||
checkPackagePath(t, c, ix)
|
||||
checkExports(t, c, ix)
|
||||
checkIdents(t, c, ix)
|
||||
}
|
||||
|
||||
if got, want := ix.ImportCount(), map[string]int{
|
||||
"bar": 1,
|
||||
}; !reflect.DeepEqual(got, want) {
|
||||
// checkStats checks the Index's statistics.
|
||||
// Some statistics are only set when we're indexing Go code.
|
||||
func checkStats(t *testing.T, c *Corpus, ix *Index) {
|
||||
want := Statistics{}
|
||||
if c.IndexFullText {
|
||||
want.Bytes = 314
|
||||
want.Files = 4
|
||||
want.Lines = 21
|
||||
} else if c.IndexDocs || c.IndexGoCode {
|
||||
want.Bytes = 291
|
||||
want.Files = 3
|
||||
want.Lines = 20
|
||||
}
|
||||
if c.IndexGoCode {
|
||||
want.Words = 8
|
||||
want.Spots = 12
|
||||
}
|
||||
if got := ix.Stats(); !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("Stats = %#v; want %#v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// checkImportCount checks the Index's import count map.
|
||||
// It is only set when we're indexing Go code.
|
||||
func checkImportCount(t *testing.T, c *Corpus, ix *Index) {
|
||||
want := map[string]int{}
|
||||
if c.IndexGoCode {
|
||||
want = map[string]int{
|
||||
"bar": 1,
|
||||
}
|
||||
}
|
||||
if got := ix.ImportCount(); !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("ImportCount = %v; want %v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
if got, want := ix.PackagePath(), map[string]map[string]bool{
|
||||
"foo": map[string]bool{
|
||||
"foo": true,
|
||||
},
|
||||
"bar": map[string]bool{
|
||||
"bar": true,
|
||||
"other/bar": true,
|
||||
},
|
||||
}; !reflect.DeepEqual(got, want) {
|
||||
// checkPackagePath checks the Index's package path map.
|
||||
// It is set if at least one of the indexing options is enabled.
|
||||
func checkPackagePath(t *testing.T, c *Corpus, ix *Index) {
|
||||
want := map[string]map[string]bool{}
|
||||
if c.IndexDocs || c.IndexGoCode || c.IndexFullText {
|
||||
want = map[string]map[string]bool{
|
||||
"foo": map[string]bool{
|
||||
"foo": true,
|
||||
},
|
||||
"bar": map[string]bool{
|
||||
"bar": true,
|
||||
"other/bar": true,
|
||||
},
|
||||
}
|
||||
}
|
||||
if got := ix.PackagePath(); !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("PackagePath = %v; want %v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
if got, want := ix.Exports(), map[string]map[string]SpotKind{
|
||||
"foo": map[string]SpotKind{
|
||||
"Pi": ConstDecl,
|
||||
"Foos": VarDecl,
|
||||
"Foo": TypeDecl,
|
||||
"New": FuncDecl,
|
||||
},
|
||||
"other/bar": map[string]SpotKind{
|
||||
"X": FuncDecl,
|
||||
},
|
||||
}; !reflect.DeepEqual(got, want) {
|
||||
// checkExports checks the Index's exports map.
|
||||
// It is only set when we're indexing Go code.
|
||||
func checkExports(t *testing.T, c *Corpus, ix *Index) {
|
||||
want := map[string]map[string]SpotKind{}
|
||||
if c.IndexGoCode {
|
||||
want = map[string]map[string]SpotKind{
|
||||
"foo": map[string]SpotKind{
|
||||
"Pi": ConstDecl,
|
||||
"Foos": VarDecl,
|
||||
"Foo": TypeDecl,
|
||||
"New": FuncDecl,
|
||||
},
|
||||
"other/bar": map[string]SpotKind{
|
||||
"X": FuncDecl,
|
||||
},
|
||||
}
|
||||
}
|
||||
if got := ix.Exports(); !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("Exports = %v; want %v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
if got, want := ix.Idents(), map[SpotKind]map[string][]Ident{
|
||||
ConstDecl: map[string][]Ident{
|
||||
"Pi": []Ident{{"/src/pkg/foo", "foo", "Pi", ""}},
|
||||
},
|
||||
VarDecl: map[string][]Ident{
|
||||
"Foos": []Ident{{"/src/pkg/foo", "foo", "Foos", ""}},
|
||||
},
|
||||
TypeDecl: map[string][]Ident{
|
||||
"Foo": []Ident{{"/src/pkg/foo", "foo", "Foo", "Foo is stuff."}},
|
||||
},
|
||||
FuncDecl: map[string][]Ident{
|
||||
"New": []Ident{{"/src/pkg/foo", "foo", "New", ""}},
|
||||
"X": []Ident{{"/src/pkg/other/bar", "bar", "X", ""}},
|
||||
},
|
||||
}; !reflect.DeepEqual(got, want) {
|
||||
// checkIdents checks the Index's indents map.
|
||||
// It is only set when we're indexing documentation.
|
||||
func checkIdents(t *testing.T, c *Corpus, ix *Index) {
|
||||
want := map[SpotKind]map[string][]Ident{}
|
||||
if c.IndexDocs {
|
||||
want = map[SpotKind]map[string][]Ident{
|
||||
ConstDecl: map[string][]Ident{
|
||||
"Pi": []Ident{{"/src/pkg/foo", "foo", "Pi", ""}},
|
||||
},
|
||||
VarDecl: map[string][]Ident{
|
||||
"Foos": []Ident{{"/src/pkg/foo", "foo", "Foos", ""}},
|
||||
},
|
||||
TypeDecl: map[string][]Ident{
|
||||
"Foo": []Ident{{"/src/pkg/foo", "foo", "Foo", "Foo is stuff."}},
|
||||
},
|
||||
FuncDecl: map[string][]Ident{
|
||||
"New": []Ident{{"/src/pkg/foo", "foo", "New", ""}},
|
||||
"X": []Ident{{"/src/pkg/other/bar", "bar", "X", ""}},
|
||||
},
|
||||
}
|
||||
}
|
||||
if got := ix.Idents(); !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("Idents = %v; want %v", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user