protoc-gen-swagger/genswagger: sort extensions by key, expand test

Signed-off-by: Stephan Renatus <[email protected]>
grpc-ecosystem · Sep 8, 2019 · 409ca3a · 409ca3a
1 parent 0290729
commit 409ca3a
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/examples/proto/examplepb/a_bit_of_everything.swagger.json b/examples/proto/examplepb/a_bit_of_everything.swagger.json
@@ -2317,9 +2317,9 @@
     "description": "More about gRPC-Gateway",
     "url": "https://github.com/grpc-ecosystem/grpc-gateway"
   },
-  "x-grpc-gateway-foo": "bar",
   "x-grpc-gateway-baz-list": [
     "one",
     true
-  ]
+  ],
+  "x-grpc-gateway-foo": "bar"
 }
diff --git a/protoc-gen-swagger/genswagger/BUILD.bazel b/protoc-gen-swagger/genswagger/BUILD.bazel
@@ -40,5 +40,6 @@ go_test(
         "@io_bazel_rules_go//proto/wkt:any_go_proto",
         "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
         "@io_bazel_rules_go//proto/wkt:descriptor_go_proto",
+        "@io_bazel_rules_go//proto/wkt:struct_go_proto",
     ],
 )
diff --git a/protoc-gen-swagger/genswagger/template.go b/protoc-gen-swagger/genswagger/template.go
@@ -6,6 +6,7 @@ import (
 	"os"
 	"reflect"
 	"regexp"
+	"sort"
 	"strconv"
 	"strings"
 	"sync"
@@ -1233,6 +1234,7 @@ func applyTemplate(p param) (*swaggerObject, error) {
 				}
 				exts = append(exts, extension{key: k, value: json.RawMessage(ext)})
 			}
+			sort.Slice(exts, func(i, j int) bool { return exts[i].key < exts[j].key })
 			s.extensions = exts
 		}
 

diff --git a/protoc-gen-swagger/genswagger/template_test.go b/protoc-gen-swagger/genswagger/template_test.go
@@ -393,6 +393,7 @@ func TestApplyTemplateTopLevelOptions(t *testing.T) {
 	swagger := swagger_options.Swagger{
 		Extensions: map[string]*structpb.Value{
 			"x-foo": &structpb.Value{Kind: &structpb.Value_StringValue{StringValue: "bar"}},
+			"x-bar": &structpb.Value{Kind: &structpb.Value_ListValue{ListValue: &structpb.ListValue{Values: []*structpb.Value{{Kind: &structpb.Value_StringValue{StringValue: "baz"}}}}}},
 		},
 	}
 	err := proto.SetExtension(proto.Message(file.FileDescriptorProto.Options), swagger_options.E_Openapiv2Swagger, &swagger)
@@ -407,7 +408,10 @@ func TestApplyTemplateTopLevelOptions(t *testing.T) {
 	if want, is, name := "2.0", result.Swagger, "Swagger"; !reflect.DeepEqual(is, want) {
 		t.Errorf("applyTemplate(%#v).%s = %s want to be %s", file, name, is, want)
 	}
-	if want, is, name := []extension{{key: "x-foo", value: json.RawMessage("\"bar\"")}}, result.extensions, "Extensions"; !reflect.DeepEqual(is, want) {
+	if want, is, name := []extension{
+		{key: "x-bar", value: json.RawMessage("[\n      \"baz\"\n    ]")},
+		{key: "x-foo", value: json.RawMessage("\"bar\"")},
+	}, result.extensions, "Extensions"; !reflect.DeepEqual(is, want) {
 		t.Errorf("applyTemplate(%#v).%s = %s want to be %s", file, name, is, want)
 	}
 }