Add tests for unexpected raw responses (#774)

This adds tests for unexpected values such as: * Unmapped HTTP code * Nonexistent HTTP code * Invalid Content-Type * Invalid Content-Encoding --------- Co-authored-by: Josh Humphries <[email protected]>
connectrpc · Feb 15, 2024 · 926b534 · 926b534
1 parent 208a0b5
commit 926b534
Show file tree

Hide file tree

Showing 6 changed files with 91 additions and 15 deletions.
diff --git a/internal/app/connectconformance/testsuites/data/client_unexpected.yaml b/internal/app/connectconformance/testsuites/data/client_unexpected.yaml
@@ -0,0 +1,53 @@
+name: Unexpected Responses
+mode: TEST_MODE_CLIENT
+relevantCompressions:
+  - COMPRESSION_IDENTITY
+relevantCodecs:
+  - CODEC_PROTO
+testCases:
+- request:
+    testName: unmapped HTTP status code
+    service: connectrpc.conformance.v1.ConformanceService
+    method: Unary
+    streamType: STREAM_TYPE_UNARY
+    requestMessages:
+    - "@type": type.googleapis.com/connectrpc.conformance.v1.UnaryRequest
+      responseDefinition:
+        rawResponse:
+          statusCode: 418 # I'm a teapot
+  expectedResponse:
+    error:
+      # unknown
+      code: 2
+- request:
+    testName: nonexistent HTTP status code
+    service: connectrpc.conformance.v1.ConformanceService
+    method: Unary
+    streamType: STREAM_TYPE_UNARY
+    requestMessages:
+    - "@type": type.googleapis.com/connectrpc.conformance.v1.UnaryRequest
+      responseDefinition:
+        rawResponse:
+          statusCode: 800
+  expectedResponse:
+    error:
+      # unknown
+      code: 2
+# TODO - Fixed in https://github.com/connectrpc/connect-go/pull/679 
+# Uncomment when released
+# - request:
+#     testName: unexpected content type 
+#     service: connectrpc.conformance.v1.ConformanceService
+#     method: Unary
+#     streamType: STREAM_TYPE_UNARY
+#     requestMessages:
+#     - "@type": type.googleapis.com/connectrpc.conformance.v1.UnaryRequest
+#       responseDefinition:
+#         rawResponse:
+#           headers:
+#             - name: Content-Type
+#               value: ["junk"]
+#   expectedResponse:
+#     error:
+#       # internal
+#       code: 13
diff --git a/internal/app/connectconformance/testsuites/data/connect_client_http_to_connect_code.yaml b/internal/app/connectconformance/testsuites/data/connect_client_http_to_connect_code.yaml
@@ -209,17 +209,4 @@ testCases:
     error:
       # unavailable
       code: 14
-- request:
-    testName: im-a-teapot
-    service: connectrpc.conformance.v1.ConformanceService
-    method: Unary
-    streamType: STREAM_TYPE_UNARY
-    requestMessages:
-    - "@type": type.googleapis.com/connectrpc.conformance.v1.UnaryRequest
-      responseDefinition:
-        rawResponse:
-          statusCode: 418
-  expectedResponse:
-    error:
-      # unknown
-      code: 2
+
diff --git a/internal/app/connectconformance/testsuites/data/connect_client_unexpected.yaml b/internal/app/connectconformance/testsuites/data/connect_client_unexpected.yaml
@@ -0,0 +1,29 @@
+name: Connect Unexpected Responses
+mode: TEST_MODE_CLIENT
+relevantProtocols:
+  - PROTOCOL_CONNECT
+relevantCompressions:
+  - COMPRESSION_IDENTITY
+relevantCodecs:
+  - CODEC_JSON
+testCases:
+  - request:
+      testName: unexpected content encoding
+      service: connectrpc.conformance.v1.ConformanceService
+      method: Unary
+      streamType: STREAM_TYPE_UNARY
+      requestMessages:
+        - "@type": type.googleapis.com/connectrpc.conformance.v1.UnaryRequest
+          responseDefinition:
+            rawResponse:
+              unary:
+                text: "{\"payload\": {\"data\": \"dGVzdCByZXNwb25zZQ\"}}"
+              headers:
+                - name: content-type
+                  value: [ "application/json" ]
+                - name: content-encoding
+                  value: ["foo"]
+    expectedResponse:
+      error:
+        # internal
+        code: 13
diff --git a/internal/app/referenceserver/raw_response.go b/internal/app/referenceserver/raw_response.go
@@ -156,7 +156,12 @@ func (r *rawResponseWriter) finish(feedback *feedbackPrinter) {
 	for _, hdr := range resp.Trailers {
 		r.respWriter.Header().Add("Trailer", hdr.Name)
 	}
-	r.respWriter.WriteHeader(int(resp.StatusCode))
+	statusCode := int(resp.StatusCode)
+	// If no status code was specified in the raw response, default to 200
+	if statusCode == 0 {
+		statusCode = 200
+	}
+	r.respWriter.WriteHeader(statusCode)
 	switch contents := resp.Body.(type) {
 	case *v1.RawHTTPResponse_Unary:
 		_ = internal.WriteRawMessageContents(contents.Unary, r.respWriter)

diff --git a/internal/gen/proto/go/connectrpc/conformance/v1/service.pb.go b/internal/gen/proto/go/connectrpc/conformance/v1/service.pb.go
diff --git a/proto/connectrpc/conformance/v1/service.proto b/proto/connectrpc/conformance/v1/service.proto
@@ -400,6 +400,7 @@ message StreamContents {
 // custom responses with odd properties (including certain kinds of
 // malformed responses) to test edge cases in clients.
 message RawHTTPResponse {
+  // If status code is not specified, it will default to a 200 response code.
   uint32 status_code = 1;
   repeated Header headers = 2;
   oneof body {