Fix test which was not setting the SourceCodeInfo field.

This field should generally be non-nil while running the generator. This commit also adds a trivial check to make panic more informative in case a future test breaks in a similar fashion.
grpc-ecosystem · May 1, 2016 · bdceda1 · bdceda1
1 parent 8bdac72
commit bdceda1
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 13 deletions.
diff --git a/protoc-gen-swagger/genswagger/template.go b/protoc-gen-swagger/genswagger/template.go
@@ -514,6 +514,16 @@ func applyTemplate(p param) (string, error) {
 }
 
 func protoComments(reg *descriptor.Registry, file *descriptor.File, outers []string, typeName string, typeIndex int32, fieldPaths ...int32) string {
+	if file.SourceCodeInfo == nil {
+		// Curious! A file without any source code info.
+		// This could be a test that's providing incomplete
+		// descriptor.File information.
+		//
+		// We could simply return no comments, but panic
+		// could make debugging easier.
+		panic("descriptor.File should not contain nil SourceCodeInfo")
+	}
+
 	outerPaths := make([]int32, len(outers))
 	for i := range outers {
 		location := ""

diff --git a/protoc-gen-swagger/genswagger/template_test.go b/protoc-gen-swagger/genswagger/template_test.go
@@ -48,11 +48,12 @@ func TestApplyTemplateSimple(t *testing.T) {
 	}
 	file := descriptor.File{
 		FileDescriptorProto: &protodescriptor.FileDescriptorProto{
-			Name:        proto.String("example.proto"),
-			Package:     proto.String("example"),
-			Dependency:  []string{"a.example/b/c.proto", "a.example/d/e.proto"},
-			MessageType: []*protodescriptor.DescriptorProto{msgdesc},
-			Service:     []*protodescriptor.ServiceDescriptorProto{svc},
+			SourceCodeInfo: &protodescriptor.SourceCodeInfo{},
+			Name:           proto.String("example.proto"),
+			Package:        proto.String("example"),
+			Dependency:     []string{"a.example/b/c.proto", "a.example/d/e.proto"},
+			MessageType:    []*protodescriptor.DescriptorProto{msgdesc},
+			Service:        []*protodescriptor.ServiceDescriptorProto{svc},
 		},
 		GoPkg: descriptor.GoPackage{
 			Path: "example.com/path/to/example/example.pb",
@@ -182,10 +183,11 @@ func TestApplyTemplateRequestWithoutClientStreaming(t *testing.T) {
 	}
 	file := descriptor.File{
 		FileDescriptorProto: &protodescriptor.FileDescriptorProto{
-			Name:        proto.String("example.proto"),
-			Package:     proto.String("example"),
-			MessageType: []*protodescriptor.DescriptorProto{msgdesc, nesteddesc},
-			Service:     []*protodescriptor.ServiceDescriptorProto{svc},
+			SourceCodeInfo: &protodescriptor.SourceCodeInfo{},
+			Name:           proto.String("example.proto"),
+			Package:        proto.String("example"),
+			MessageType:    []*protodescriptor.DescriptorProto{msgdesc, nesteddesc},
+			Service:        []*protodescriptor.ServiceDescriptorProto{svc},
 		},
 		GoPkg: descriptor.GoPackage{
 			Path: "example.com/path/to/example/example.pb",
@@ -343,10 +345,11 @@ func TestApplyTemplateRequestWithClientStreaming(t *testing.T) {
 	}
 	file := descriptor.File{
 		FileDescriptorProto: &protodescriptor.FileDescriptorProto{
-			Name:        proto.String("example.proto"),
-			Package:     proto.String("example"),
-			MessageType: []*protodescriptor.DescriptorProto{msgdesc, nesteddesc},
-			Service:     []*protodescriptor.ServiceDescriptorProto{svc},
+			SourceCodeInfo: &protodescriptor.SourceCodeInfo{},
+			Name:           proto.String("example.proto"),
+			Package:        proto.String("example"),
+			MessageType:    []*protodescriptor.DescriptorProto{msgdesc, nesteddesc},
+			Service:        []*protodescriptor.ServiceDescriptorProto{svc},
 		},
 		GoPkg: descriptor.GoPackage{
 			Path: "example.com/path/to/example/example.pb",