Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions cmd/txtpbfmt/fmt.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ import (
"strings"

"flag"

"google.golang.org/protobuf/reflect/protoreflect"
// Google internal base/go package, commented out by copybara
log "github.com/golang/glog"
"github.com/protocolbuffers/txtpbfmt/config"
"github.com/protocolbuffers/txtpbfmt/descriptor"
"github.com/protocolbuffers/txtpbfmt/logger"
"github.com/protocolbuffers/txtpbfmt/parser"
)
Expand Down Expand Up @@ -61,6 +64,28 @@ func contentForLogging(content []byte) string {
return res
}

// rootMessageDescriptor is loaded from the -proto_descriptor and
// -message_full_name flags when field number sorting is enabled.
var rootMessageDescriptor protoreflect.MessageDescriptor

func loadRootMessageDescriptor() error {
if !*sortFieldsByFieldNumber {
return nil
}
if *protoDescriptor == "" {
return fmt.Errorf("-proto_descriptor is required when using -sort_fields_by_field_number")
}
loader, err := descriptor.NewLoader(*protoDescriptor)
if err != nil {
return fmt.Errorf("failed to create descriptor loader: %v", err)
}
rootMessageDescriptor, err = loader.GetRootMessageDescriptor(*messageFullName)
if err != nil {
return fmt.Errorf("failed to get root message descriptor: %v", err)
}
return nil
}

func processPath(path string) error {
if strings.HasPrefix(path, "//depot/google3/") {
path = strings.Replace(path, "//depot/google3/", "", 1)
Expand Down Expand Up @@ -92,8 +117,7 @@ func processPath(path string) error {
SkipAllColons: *skipAllColons,
SortFieldsByFieldName: *sortFieldsByFieldName,
SortFieldsByFieldNumber: *sortFieldsByFieldNumber,
ProtoDescriptor: *protoDescriptor,
MessageFullName: *messageFullName,
RootMessageDescriptor: rootMessageDescriptor,
SortRepeatedFieldsByContent: *sortRepeatedFieldsByContent,
SortRepeatedFieldsBySubfield: strings.Split(*sortRepeatedFieldsBySubfield, ","),
RemoveDuplicateValuesForRepeatedFields: *removeDuplicateValuesForRepeatedFields,
Expand Down Expand Up @@ -136,6 +160,9 @@ func write(path string, content, newContent []byte) error {

func main() {
flag.Parse()
if err := loadRootMessageDescriptor(); err != nil {
log.Exit(err)
}
paths := flag.Args()
if len(paths) == 0 {
paths = append(paths, stdinPlaceholderPath)
Expand Down
11 changes: 6 additions & 5 deletions config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
package config

import (
"google.golang.org/protobuf/reflect/protoreflect"

"github.com/protocolbuffers/txtpbfmt/logger"
)

Expand All @@ -27,11 +29,10 @@ type Config struct {
// Sort fields by field number from proto definition.
SortFieldsByFieldNumber bool

// Path to protobuf descriptor file (.desc).
ProtoDescriptor string

// Full message type name for field number lookup (required, e.g. google.protobuf.Any).
MessageFullName string
// Descriptor of the message at the root of the textproto, required when
// SortFieldsByFieldNumber is set. Load one from a descriptor file with
// [github.com/protocolbuffers/txtpbfmt/descriptor.Loader].
RootMessageDescriptor protoreflect.MessageDescriptor

// Sort adjacent scalar fields of the same field name by their contents.
SortRepeatedFieldsByContent bool
Expand Down
21 changes: 3 additions & 18 deletions impl/impl.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import (
"google.golang.org/protobuf/reflect/protoreflect"
"github.com/protocolbuffers/txtpbfmt/ast"
"github.com/protocolbuffers/txtpbfmt/config"
"github.com/protocolbuffers/txtpbfmt/descriptor"
"github.com/protocolbuffers/txtpbfmt/quote"
"github.com/protocolbuffers/txtpbfmt/sort"
"github.com/protocolbuffers/txtpbfmt/wrap"
Expand Down Expand Up @@ -156,23 +155,9 @@ func ParseWithMetaCommentConfig(in []byte, c config.Config) ([]*ast.Node, error)
return nil, err
}

// Load descriptor if field number sorting is enabled
var rootDesc protoreflect.MessageDescriptor
if c.SortFieldsByFieldNumber {
if c.ProtoDescriptor == "" {
return nil, fmt.Errorf("proto_descriptor is required when using sort_fields_by_field_number")
}

loader, err := descriptor.NewLoader(c.ProtoDescriptor)
if err != nil {
return nil, fmt.Errorf("failed to create descriptor loader: %v", err)
}

// Get root message descriptor
rootDesc, err = loader.GetRootMessageDescriptor(c.MessageFullName)
if err != nil {
return nil, fmt.Errorf("failed to get root message descriptor: %v", err)
}
rootDesc := c.RootMessageDescriptor
if c.SortFieldsByFieldNumber && rootDesc == nil {
return nil, fmt.Errorf("RootMessageDescriptor is required when using SortFieldsByFieldNumber")
}

if p.config.InfoLevel() {
Expand Down
66 changes: 21 additions & 45 deletions impl/impl_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ import (
"testing"

// Google internal testing/gobase/runfilestest package, commented out by copybara
"google.golang.org/protobuf/reflect/protoreflect"
"github.com/kylelemons/godebug/pretty"
"github.com/protocolbuffers/txtpbfmt/config"
"github.com/protocolbuffers/txtpbfmt/descriptor"
)

func TestPreprocess(t *testing.T) {
Expand Down Expand Up @@ -200,9 +202,22 @@ p {}`,
}
}

func TestParseWithMetaCommentConfig_ErrorHandling(t *testing.T) {
descriptorFile := "../testdata/test.desc"
// rootMessageDescriptor loads the descriptor for messageFullName from the test
// descriptor file.
func rootMessageDescriptor(t *testing.T, messageFullName string) protoreflect.MessageDescriptor {
t.Helper()
loader, err := descriptor.NewLoader("../testdata/test.desc")
if err != nil {
t.Fatalf("NewLoader: %v", err)
}
desc, err := loader.GetRootMessageDescriptor(messageFullName)
if err != nil {
t.Fatalf("GetRootMessageDescriptor(%q): %v", messageFullName, err)
}
return desc
}

func TestParseWithMetaCommentConfig_ErrorHandling(t *testing.T) {
tests := []struct {
name string
config config.Config
Expand All @@ -211,48 +226,13 @@ func TestParseWithMetaCommentConfig_ErrorHandling(t *testing.T) {
errorSubstring string
}{
{
name: "SortFieldsByFieldNumber without ProtoDescriptor",
config: config.Config{
SortFieldsByFieldNumber: true,
ProtoDescriptor: "",
MessageFullName: "testproto.UserProfile",
},
input: `name: "test"`,
expectError: true,
errorSubstring: "proto_descriptor is required",
},
{
name: "SortFieldsByFieldNumber without MessageFullName",
name: "SortFieldsByFieldNumber without RootMessageDescriptor",
config: config.Config{
SortFieldsByFieldNumber: true,
ProtoDescriptor: descriptorFile,
MessageFullName: "",
},
input: `name: "test"`,
expectError: true,
errorSubstring: "message_full_name is required",
},
{
name: "SortFieldsByFieldNumber with invalid descriptor file",
config: config.Config{
SortFieldsByFieldNumber: true,
ProtoDescriptor: "nonexistent.desc",
MessageFullName: "testproto.UserProfile",
},
input: `name: "test"`,
expectError: true,
errorSubstring: "failed to read descriptor file",
},
{
name: "SortFieldsByFieldNumber with invalid message name",
config: config.Config{
SortFieldsByFieldNumber: true,
ProtoDescriptor: descriptorFile,
MessageFullName: "testproto.NonExistentMessage",
},
input: `name: "test"`,
expectError: true,
errorSubstring: "failed to get root message descriptor",
errorSubstring: "RootMessageDescriptor is required",
},
}

Expand All @@ -276,8 +256,6 @@ func TestParseWithMetaCommentConfig_ErrorHandling(t *testing.T) {
}

func TestParseWithMetaCommentConfig_SortFieldsByFieldNumber(t *testing.T) {
descriptorFile := "../testdata/test.desc"

tests := []struct {
name string
config config.Config
Expand All @@ -289,8 +267,7 @@ func TestParseWithMetaCommentConfig_SortFieldsByFieldNumber(t *testing.T) {
name: "Sort fields by field number - UserProfile",
config: config.Config{
SortFieldsByFieldNumber: true,
ProtoDescriptor: descriptorFile,
MessageFullName: "testproto.UserProfile",
RootMessageDescriptor: rootMessageDescriptor(t, "testproto.UserProfile"),
},
input: `name: "test"
priority: 10
Expand All @@ -305,8 +282,7 @@ active: true`,
name: "Sort fields by field number - ProductCatalog",
config: config.Config{
SortFieldsByFieldNumber: true,
ProtoDescriptor: descriptorFile,
MessageFullName: "testproto.ProductCatalog",
RootMessageDescriptor: rootMessageDescriptor(t, "testproto.ProductCatalog"),
},
input: `name: "product_test"
priority: 100
Expand Down