mirror of
https://github.com/protocolbuffers/protobuf-go.git
synced 2025-01-09 03:39:24 +00:00
19058431cd
Create a single binary for handling generation of protos. This replaces previous logic spread throughout the repo in: * regenerate.bash * cmd/protoc-gen-go/golden_test.go * cmd/protoc-gen-go-grpc/golden_test.go * (indirectly) internal/protogen/goldentest One of the problems with the former approaches is that they relied on a version of protoc that was specific to a developer's workstation. This meant that the result of generation was not hermetic. To address this, we rely on the hard-coded version of protobuf specified in the test.bash script. A summary of changes in this CL are: * The internal_gengo.GenerateFile and internal_gengogrpc.GenerateFile functions are unified to have consistent signatures. It seems that the former accepted a *protogen.GeneratedFile to support v1 where gRPC code was generated into the same file as the base .pb.go file. However, the same functionality can be achieved by having the function return the generated file object. * The test.bash script patches the protobuf toolchain to have properly specified go_package options in each proto source file. * The test.bash script accepts a "-regenerate" argument. * Add generation for the well-known types. Contrary to how these were laid out in the v1 repo, all the well-known types are placed in the same Go package. * Add generation for the conformance proto. * Remove regenerate.bash * Remove internal/protogen * Remove cmd/protoc-gen-go/golden_test.go * Remove cmd/protoc-gen-go-grpc/golden_test.go * Add cmd/protoc-gen-go/annotation_test.go Change-Id: I4a1a97ae6f66e2fabcf4e4d292c95ab2a2db0248 Reviewed-on: https://go-review.googlesource.com/c/164477 Reviewed-by: Damien Neil <dneil@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.File_test_test_proto)
|
|
|
|
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.File_google_protobuf_descriptor_proto.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
|
|
})
|
|
}
|