Add tests for URL path unescaping

grpc-ecosystem · Sep 10, 2021 · a18708e · a18708e
1 parent 229eed3
commit a18708e
Show file tree

Hide file tree

Showing 2 changed files with 111 additions and 2 deletions.
diff --git a/runtime/mux_test.go b/runtime/mux_test.go
@@ -30,6 +30,7 @@ func TestMuxServeHTTP(t *testing.T) {
 		respContent string
 
 		disablePathLengthFallback bool
+		unescapingMode            runtime.UnescapingMode
 	}{
 		{
 			patterns:   nil,
@@ -330,11 +331,74 @@ func TestMuxServeHTTP(t *testing.T) {
 			respStatus:  http.StatusOK,
 			respContent: "POST /foo/{id=*}:verb:subverb",
 		},
+		{
+			patterns: []stubPattern{
+				{
+					method: "GET",
+					ops:    []int{int(utilities.OpLitPush), 0, int(utilities.OpPush), 1, int(utilities.OpCapture), 1, int(utilities.OpLitPush), 2},
+					pool:   []string{"foo", "id", "bar"},
+				},
+			},
+			reqMethod: "POST",
+			reqPath:   "/foo/404%2fwith%2Fspace/bar",
+			headers: map[string]string{
+				"Content-Type": "application/json",
+			},
+			respStatus:     http.StatusNotFound,
+			unescapingMode: runtime.UnescapingModeLegacy,
+		},
+		{
+			patterns: []stubPattern{
+				{
+					method: "GET",
+					ops: []int{
+						int(utilities.OpLitPush), 0,
+						int(utilities.OpPush), 0,
+						int(utilities.OpConcatN), 1,
+						int(utilities.OpCapture), 1,
+						int(utilities.OpLitPush), 2},
+					pool: []string{"foo", "id", "bar"},
+				},
+			},
+			reqMethod: "GET",
+			reqPath:   "/foo/success%2fwith%2Fspace/bar",
+			headers: map[string]string{
+				"Content-Type": "application/json",
+			},
+			respStatus:     http.StatusOK,
+			unescapingMode: runtime.UnescapingModeAllExceptReserved,
+			respContent:    "GET /foo/{id=*}/bar",
+		},
+		{
+			patterns: []stubPattern{
+				{
+					method: "GET",
+					ops: []int{
+						int(utilities.OpLitPush), 0,
+						int(utilities.OpPushM), 0,
+						int(utilities.OpConcatN), 1,
+						int(utilities.OpCapture), 1,
+					},
+					pool: []string{"foo", "id", "bar"},
+				},
+			},
+			reqMethod: "GET",
+			reqPath:   "/foo/success%2fwith%2Fspace",
+			headers: map[string]string{
+				"Content-Type": "application/json",
+			},
+			respStatus:     http.StatusOK,
+			unescapingMode: runtime.UnescapingModeAllExceptReserved,
+			respContent:    "GET /foo/{id=**}",
+		},
 	} {
 		t.Run(strconv.Itoa(i), func(t *testing.T) {
 			var opts []runtime.ServeMuxOption
+			opts = append(opts, runtime.WithUnescapingMode(spec.unescapingMode))
 			if spec.disablePathLengthFallback {
-				opts = append(opts, runtime.WithDisablePathLengthFallback())
+				opts = append(opts,
+					runtime.WithDisablePathLengthFallback(),
+				)
 			}
 			mux := runtime.NewServeMux(opts...)
 			for _, p := range spec.patterns {

diff --git a/runtime/pattern_test.go b/runtime/pattern_test.go
@@ -367,6 +367,7 @@ func TestMatchWithBinding(t *testing.T) {
 		pool []string
 		path string
 		verb string
+		mode UnescapingMode
 
 		want map[string]string
 	}{
@@ -477,14 +478,58 @@ func TestMatchWithBinding(t *testing.T) {
 				"oname": "obj",
 			},
 		},
+		{
+			ops: []int{
+				int(utilities.OpLitPush), 0,
+				int(utilities.OpPush), 0,
+				int(utilities.OpConcatN), 1,
+				int(utilities.OpCapture), 1,
+				int(utilities.OpLitPush), 2,
+			},
+			pool: []string{"foo", "id", "bar"},
+			path: "foo/part1%2Fpart2/bar",
+			want: map[string]string{
+				"id": "part1/part2",
+			},
+			mode: UnescapingModeAllExceptReserved,
+		},
+		{
+			ops: []int{
+				int(utilities.OpLitPush), 0,
+				int(utilities.OpPushM), 0,
+				int(utilities.OpConcatN), 1,
+				int(utilities.OpCapture), 1,
+			},
+			pool: []string{"foo", "id"},
+			path: "foo/test%2Fbar",
+			want: map[string]string{
+				"id": "test%2Fbar",
+			},
+			mode: UnescapingModeAllExceptReserved,
+		},
+		{
+			ops: []int{
+				int(utilities.OpLitPush), 0,
+				int(utilities.OpPushM), 0,
+				int(utilities.OpConcatN), 1,
+				int(utilities.OpCapture), 1,
+			},
+			pool: []string{"foo", "id"},
+			path: "foo/test%2Fbar",
+			want: map[string]string{
+				"id": "test/bar",
+			},
+			mode: UnescapingModeAllCharacters,
+		},
 	} {
 		pat, err := NewPattern(validVersion, spec.ops, spec.pool, spec.verb)
 		if err != nil {
 			t.Errorf("NewPattern(%d, %v, %q, %q) failed with %v; want success", validVersion, spec.ops, spec.pool, spec.verb, err)
 			continue
 		}
 
-		got, err := pat.Match(segments(spec.path))
+		components, verb := segments(spec.path)
+		got, err := pat.MatchAndEscape(components, verb, spec.mode)
 		if err != nil {
 			t.Errorf("pat.Match(%q) failed with %v; want success; pattern = (%v, %q)", spec.path, err, spec.ops, spec.pool)
 		}