identifiers_test.go

/*
 * Copyright 2017 The Kythe Authors. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package identifiers

import (
	"context"
	"testing"

	"kythe.io/kythe/go/storage/table"
	"kythe.io/kythe/go/test/testutil"

	"google.golang.org/protobuf/proto"

	ipb "kythe.io/kythe/proto/identifier_go_proto"
	srvpb "kythe.io/kythe/proto/serving_go_proto"
)

var matchTable = Table{testProtoTable{
	"foo::bar": []proto.Message{
		&srvpb.IdentifierMatch{
			Node: []*srvpb.IdentifierMatch_Node{
				node("kythe://corpus?lang=c++", "", "record", "class"),
			},
			BaseName:      "bar",
			QualifiedName: "foo::bar",
		},
		&srvpb.IdentifierMatch{
			Node: []*srvpb.IdentifierMatch_Node{
				node("kythe://corpus?lang=c++#decl", "kythe://corpus?lang=c++", "record", "class"),
			},
			BaseName:      "bar",
			QualifiedName: "foo::bar",
		},
		&srvpb.IdentifierMatch{
			Node: []*srvpb.IdentifierMatch_Node{
				node("kythe://corpus?lang=rust", "", "record", "struct"),
			},
			BaseName:      "bar",
			QualifiedName: "foo::bar",
		},
	},

	"foo.bar": []proto.Message{
		&srvpb.IdentifierMatch{
			Node: []*srvpb.IdentifierMatch_Node{
				node("kythe://corpus?lang=java", "kythe://corpus?lang=c++", "record", "interface"),
			},
			BaseName:      "bar",
			QualifiedName: "foo.bar",
		},
	},

	"com.java.package.Interface": []proto.Message{
		&srvpb.IdentifierMatch{
			Node: []*srvpb.IdentifierMatch_Node{
				node("kythe://habeas?lang=java", "", "record", "interface"),
			},
			BaseName:      "Interface",
			QualifiedName: "com.java.package.Interface",
		},
	},
}}

var tests = []testCase{
	{
		"Qualified name across languages",
		findRequest("foo::bar", nil, nil, false),
		[]*ipb.FindReply_Match{
			match("kythe://corpus?lang=c++", "record", "class", "bar", "foo::bar"),
			match("kythe://corpus?lang=c++#decl", "record", "class", "bar", "foo::bar"),
			match("kythe://corpus?lang=rust", "record", "struct", "bar", "foo::bar"),
		},
	},
	{
		"Canonical node for Qualified name across languages",
		findRequest("foo::bar", nil, nil, true),
		[]*ipb.FindReply_Match{
			match("kythe://corpus?lang=c++", "record", "class", "bar", "foo::bar"),
			match("kythe://corpus?lang=rust", "record", "struct", "bar", "foo::bar"),
		},
	},
	{
		"Java qualified name",
		findRequest("foo.bar", nil, nil, false),
		[]*ipb.FindReply_Match{
			match("kythe://corpus?lang=java", "record", "interface", "bar", "foo.bar"),
		},
	},
	{
		"Java qualified name with canonical node with a different qualified name",
		findRequest("foo.bar", nil, nil, true),
		[]*ipb.FindReply_Match{
			match("kythe://corpus?lang=java", "record", "interface", "bar", "foo.bar"),
		},
	},
	{
		"Rust only",
		findRequest("foo::bar", nil, []string{"rust"}, false),
		[]*ipb.FindReply_Match{
			match("kythe://corpus?lang=rust", "record", "struct", "bar", "foo::bar"),
		},
	},
	{
		"Corpus filter matches",
		findRequest("com.java.package.Interface", []string{"habeas"}, nil, false),
		[]*ipb.FindReply_Match{
			match("kythe://habeas?lang=java", "record", "interface", "Interface", "com.java.package.Interface"),
		},
	},
	{
		"Corpus filter does not match",
		findRequest("com.java.package.Interface", []string{"corpus"}, nil, false),
		nil,
	},
}

func TestFind(t *testing.T) {
	for _, test := range tests {
		reply, err := matchTable.Find(context.TODO(), test.Request)
		if err != nil {
			t.Errorf("unexpected error for request %v: %v", test.Request, err)
		}

		if err := testutil.DeepEqual(test.Matches, reply.Matches); err != nil {
			t.Errorf("Failed %s\n%v", test.Name, err)
		}
	}
}

func findRequest(qname string, corpora, langs []string, canonicalOnly bool) *ipb.FindRequest {
	return &ipb.FindRequest{
		Identifier:         qname,
		PickCanonicalNodes: canonicalOnly,
		Corpus:             corpora,
		Languages:          langs,
	}
}

func node(ticket, canonicalNodeTicket, kind, subkind string) *srvpb.IdentifierMatch_Node {
	return &srvpb.IdentifierMatch_Node{
		Ticket:              ticket,
		CanonicalNodeTicket: canonicalNodeTicket,
		NodeKind:            kind,
		NodeSubkind:         subkind,
	}
}

func match(ticket, kind, subkind, bname, qname string) *ipb.FindReply_Match {
	return &ipb.FindReply_Match{
		Ticket:        ticket,
		NodeKind:      kind,
		NodeSubkind:   subkind,
		BaseName:      bname,
		QualifiedName: qname,
	}
}

type testCase struct {
	Name    string
	Request *ipb.FindRequest
	Matches []*ipb.FindReply_Match
}

type testProtoTable map[string][]proto.Message

func (t testProtoTable) Put(_ context.Context, key []byte, val proto.Message) error {
	t[string(key)] = []proto.Message{val}
	return nil
}

func (t testProtoTable) Lookup(_ context.Context, key []byte, msg proto.Message) error {
	m, ok := t[string(key)]
	if !ok || len(m) == 0 {
		return table.ErrNoSuchKey
	}
	proto.Merge(msg, m[0])
	return nil
}

func (t testProtoTable) LookupValues(_ context.Context, key []byte, m proto.Message, f func(proto.Message) error) error {
	for _, val := range t[string(key)] {
		msg := m.ProtoReflect().New().Interface()
		proto.Merge(msg, val)
		if err := f(msg); err == table.ErrStopLookup {
			return nil
		} else if err != nil {
			return err
		}
	}
	return nil
}

func (t testProtoTable) Buffered() table.BufferedProto { panic("UNIMPLEMENTED") }

func (t testProtoTable) Close(_ context.Context) error { return nil }