mirror of
https://github.com/protocolbuffers/protobuf-go.git
synced 2025-01-18 13:11:16 +00:00
71c6603a26
For a file "foo/bar.proto", put the FileDescriptor in "ProtoFile_foo_bar" rather than "Bar_fileDescriptor". Avoid name clashes when a package contains "a/foo.proto" and "b/foo.proto". Don't camelcase the filename: These vars weren't fully camelcased to begin with, and leaving the filename relatively unchanged is clearer and more predictable. Move "ProtoFile" from the end of the var name to the start, so that vars will sort better in packages with multiple descriptors. These changes do add a chance of name collision when the input filename begins with an uppercase letter: Foo.proto becomes "ProtoFile_Foo", which could be the result of camelcasing "proto_file.foo". The readability benefits seem worth it. Change-Id: If27d3a0d7b5bf3535aa1607a8579eb057c74d2dc Reviewed-on: https://go-review.googlesource.com/c/163199 Reviewed-by: Joe Tsai <thebrokentoaster@gmail.com> Reviewed-by: Herbie Ong <herbie@google.com>
93 lines
3.1 KiB
Go
93 lines
3.1 KiB
Go
package fileinit_test
|
|
|
|
import (
|
|
"bytes"
|
|
"compress/gzip"
|
|
"io/ioutil"
|
|
"testing"
|
|
|
|
proto "github.com/golang/protobuf/proto"
|
|
testpb "github.com/golang/protobuf/v2/internal/testprotos/test"
|
|
"github.com/golang/protobuf/v2/reflect/protodesc"
|
|
"github.com/golang/protobuf/v2/reflect/protoreflect"
|
|
descriptorpb "github.com/golang/protobuf/v2/types/descriptor"
|
|
)
|
|
|
|
func TestInit(t *testing.T) {
|
|
// Compare the FileDescriptorProto for the same test file from two different sources:
|
|
//
|
|
// 1. The result of passing the fileinit-produced FileDescriptor through protodesc.
|
|
// 2. The protoc-generated wire-encoded message.
|
|
//
|
|
// This serves as a test of both fileinit and protodesc.
|
|
got := protodesc.ToFileDescriptorProto(testpb.ProtoFile_test)
|
|
|
|
want := &descriptorpb.FileDescriptorProto{}
|
|
zb, _ := (&testpb.TestAllTypes{}).Descriptor()
|
|
r, _ := gzip.NewReader(bytes.NewBuffer(zb))
|
|
b, _ := ioutil.ReadAll(r)
|
|
if err := proto.Unmarshal(b, want); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if !proto.Equal(got, want) {
|
|
t.Errorf("protodesc.ToFileDescriptorProto(testpb.Test_protoFile) is not equal to the protoc-generated FileDescriptorProto for internal/testprotos/test/test.proto")
|
|
}
|
|
|
|
// Verify that the test proto file provides exhaustive coverage of all descriptor fields.
|
|
seen := make(map[protoreflect.FullName]bool)
|
|
visitFields(want.ProtoReflect(), func(field protoreflect.FieldDescriptor) {
|
|
seen[field.FullName()] = true
|
|
})
|
|
ignore := map[protoreflect.FullName]bool{
|
|
// The protoreflect descriptors don't include source info.
|
|
"google.protobuf.FileDescriptorProto.source_code_info": true,
|
|
"google.protobuf.FileDescriptorProto.syntax": true,
|
|
|
|
// TODO: Test oneof and extension options. Testing these requires extending the
|
|
// options messages (because they contain no user-settable fields), but importing
|
|
// decriptor.proto from test.proto currently causes an import cycle. Add test
|
|
// cases when that import cycle has been fixed.
|
|
"google.protobuf.OneofDescriptorProto.options": true,
|
|
}
|
|
for _, messageName := range []protoreflect.Name{
|
|
"FileDescriptorProto",
|
|
"DescriptorProto",
|
|
"FieldDescriptorProto",
|
|
"OneofDescriptorProto",
|
|
"EnumDescriptorProto",
|
|
"EnumValueDescriptorProto",
|
|
"ServiceDescriptorProto",
|
|
"MethodDescriptorProto",
|
|
} {
|
|
message := descriptorpb.ProtoFile_google_protobuf_descriptor.Messages().ByName(messageName)
|
|
for i, fields := 0, message.Fields(); i < fields.Len(); i++ {
|
|
if name := fields.Get(i).FullName(); !seen[name] && !ignore[name] {
|
|
t.Errorf("No test for descriptor field: %v", name)
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
// visitFields calls f for every field set in m and its children.
|
|
func visitFields(m protoreflect.Message, f func(protoreflect.FieldDescriptor)) {
|
|
typ := m.Type()
|
|
k := m.KnownFields()
|
|
k.Range(func(num protoreflect.FieldNumber, value protoreflect.Value) bool {
|
|
field := typ.Fields().ByNumber(num)
|
|
f(field)
|
|
switch field.Kind() {
|
|
case protoreflect.MessageKind, protoreflect.GroupKind:
|
|
if field.Cardinality() == protoreflect.Repeated {
|
|
for i, list := 0, value.List(); i < list.Len(); i++ {
|
|
visitFields(list.Get(i).Message(), f)
|
|
}
|
|
} else {
|
|
visitFields(value.Message(), f)
|
|
}
|
|
}
|
|
return true
|
|
})
|
|
}
|