Skip to content

Commit

Permalink
feat: Support matching pseudo headers (alibaba#803)
Browse files Browse the repository at this point in the history
  • Loading branch information
CH3CHO authored Jan 26, 2024
1 parent acd80d2 commit c412648
Show file tree
Hide file tree
Showing 9 changed files with 321 additions and 26 deletions.
33 changes: 26 additions & 7 deletions pkg/ingress/kube/annotations/match.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,14 @@ import (
)

const (
exact = "exact"
regex = "regex"
prefix = "prefix"
MatchMethod = "match-method"
MatchQuery = "match-query"
MatchHeader = "match-header"
sep = " "
exact = "exact"
regex = "regex"
prefix = "prefix"
MatchMethod = "match-method"
MatchQuery = "match-query"
MatchHeader = "match-header"
MatchPseudoHeader = "match-pseudo-header"
sep = " "
)

var (
Expand All @@ -56,6 +57,24 @@ func (m match) Parse(annotations Annotations, config *Ingress, _ *GlobalContext)
IngressLog.Errorf("parse headers error %v within ingress %s/%s", err, config.Namespace, config.Name)
}

var pseudoHeaderMatches map[string]map[string]string
if pseudoHeaderMatches, err = m.matchByHeaderOrQueryParma(annotations, MatchPseudoHeader, pseudoHeaderMatches); err != nil {
IngressLog.Errorf("parse headers error %v within ingress %s/%s", err, config.Namespace, config.Name)
}
if pseudoHeaderMatches != nil && len(pseudoHeaderMatches) > 0 {
if config.Match.Headers == nil {
config.Match.Headers = make(map[string]map[string]string)
}
for typ, mmap := range pseudoHeaderMatches {
if config.Match.Headers[typ] == nil {
config.Match.Headers[typ] = make(map[string]string)
}
for k, v := range mmap {
config.Match.Headers[typ][":"+k] = v
}
}
}

if config.Match.QueryParams, err = m.matchByHeaderOrQueryParma(annotations, MatchQuery, config.Match.QueryParams); err != nil {
IngressLog.Errorf("parse query params error %v within ingress %s/%s", err, config.Namespace, config.Name)
}
Expand Down
39 changes: 38 additions & 1 deletion pkg/ingress/kube/annotations/match_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
package annotations

import (
"strings"
"testing"

"github.com/google/go-cmp/cmp"
Expand Down Expand Up @@ -112,11 +113,47 @@ func TestMatch_ParseHeaders(t *testing.T) {
},
},
},
{
typ: "exact",
key: ":method",
value: "GET",
expect: map[string]map[string]string{
exact: {
":method": "GET",
},
},
},
{
typ: "prefix",
key: ":path",
value: "/foo",
expect: map[string]map[string]string{
prefix: {
":path": "/foo",
},
},
},
{
typ: "regex",
key: ":authority",
value: "test\\d+\\.com",
expect: map[string]map[string]string{
regex: {
":authority": "test\\d+\\.com",
},
},
},
}

for _, tt := range testCases {
t.Run("", func(t *testing.T) {
key := buildHigressAnnotationKey(tt.typ + "-" + MatchHeader + "-" + tt.key)
matchKeyword := MatchHeader
headerKey := tt.key
if strings.HasPrefix(headerKey, ":") {
headerKey = strings.TrimPrefix(headerKey, ":")
matchKeyword = MatchPseudoHeader
}
key := buildHigressAnnotationKey(tt.typ + "-" + matchKeyword + "-" + headerKey)
input := Annotations{key: tt.value}
config := &Ingress{}
_ = parser.Parse(input, config, nil)
Expand Down
6 changes: 4 additions & 2 deletions pkg/ingress/kube/ingress/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -1279,8 +1279,10 @@ func createRuleKey(annots map[string]string, hostAndPath string) string {
if idx := strings.Index(k, annotations.MatchHeader); idx != -1 {
key := k[start:idx] + k[idx+len(annotations.MatchHeader)+1:]
headers = append(headers, [2]string{key, val})
}
if idx := strings.Index(k, annotations.MatchQuery); idx != -1 {
} else if idx := strings.Index(k, annotations.MatchPseudoHeader); idx != -1 {
key := k[start:idx] + ":" + k[idx+len(annotations.MatchPseudoHeader)+1:]
headers = append(headers, [2]string{key, val})
} else if idx := strings.Index(k, annotations.MatchQuery); idx != -1 {
key := k[start:idx] + k[idx+len(annotations.MatchQuery)+1:]
params = append(params, [2]string{key, val})
}
Expand Down
15 changes: 9 additions & 6 deletions pkg/ingress/kube/ingress/controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1302,15 +1302,18 @@ func TestCreateRuleKey(t *testing.T) {
}

annots := annotations.Annotations{
buildHigressAnnotationKey(annotations.MatchMethod): "GET PUT",
buildHigressAnnotationKey("exact-" + annotations.MatchHeader + "-abc"): "123",
buildHigressAnnotationKey("prefix-" + annotations.MatchHeader + "-def"): "456",
buildHigressAnnotationKey("exact-" + annotations.MatchQuery + "-region"): "beijing",
buildHigressAnnotationKey("prefix-" + annotations.MatchQuery + "-user-id"): "user-",
buildHigressAnnotationKey(annotations.MatchMethod): "GET PUT",
buildHigressAnnotationKey("exact-" + annotations.MatchHeader + "-abc"): "123",
buildHigressAnnotationKey("prefix-" + annotations.MatchHeader + "-def"): "456",
buildHigressAnnotationKey("exact-" + annotations.MatchPseudoHeader + "-authority"): "foo.bar.com",
buildHigressAnnotationKey("prefix-" + annotations.MatchPseudoHeader + "-scheme"): "htt",
buildHigressAnnotationKey("exact-" + annotations.MatchQuery + "-region"): "beijing",
buildHigressAnnotationKey("prefix-" + annotations.MatchQuery + "-user-id"): "user-",
}
expect := "higress.com-prefix-/foo" + sep + //host-pathType-path
"GET PUT" + sep + // method
"exact-abc\t123" + "\n" + "prefix-def\t456" + sep + // header
"exact-:authority\tfoo.bar.com" + "\n" + "exact-abc\t123" + "\n" +
"prefix-:scheme\thtt" + "\n" + "prefix-def\t456" + sep + // header
"exact-region\tbeijing" + "\n" + "prefix-user-id\tuser-" + sep // params

key := createRuleKey(annots, wrapperHttpRoute.PathFormat())
Expand Down
6 changes: 4 additions & 2 deletions pkg/ingress/kube/ingressv1/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -1226,8 +1226,10 @@ func createRuleKey(annots map[string]string, hostAndPath string) string {
if idx := strings.Index(k, annotations.MatchHeader); idx != -1 {
key := k[start:idx] + k[idx+len(annotations.MatchHeader)+1:]
headers = append(headers, [2]string{key, val})
}
if idx := strings.Index(k, annotations.MatchQuery); idx != -1 {
} else if idx := strings.Index(k, annotations.MatchPseudoHeader); idx != -1 {
key := k[start:idx] + ":" + k[idx+len(annotations.MatchPseudoHeader)+1:]
headers = append(headers, [2]string{key, val})
} else if idx := strings.Index(k, annotations.MatchQuery); idx != -1 {
key := k[start:idx] + k[idx+len(annotations.MatchQuery)+1:]
params = append(params, [2]string{key, val})
}
Expand Down
6 changes: 4 additions & 2 deletions pkg/ingress/kube/kingress/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -699,8 +699,10 @@ func createRuleKey(annots map[string]string, hostAndPath string) string {
if idx := strings.Index(k, annotations.MatchHeader); idx != -1 {
key := k[start:idx] + k[idx+len(annotations.MatchHeader)+1:]
headers = append(headers, [2]string{key, val})
}
if idx := strings.Index(k, annotations.MatchQuery); idx != -1 {
} else if idx := strings.Index(k, annotations.MatchPseudoHeader); idx != -1 {
key := k[start:idx] + ":" + k[idx+len(annotations.MatchPseudoHeader)+1:]
headers = append(headers, [2]string{key, val})
} else if idx := strings.Index(k, annotations.MatchQuery); idx != -1 {
key := k[start:idx] + k[idx+len(annotations.MatchQuery)+1:]
params = append(params, [2]string{key, val})
}
Expand Down
15 changes: 9 additions & 6 deletions pkg/ingress/kube/kingress/controller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -581,15 +581,18 @@ func TestCreateRuleKey(t *testing.T) {
}

annots := annotations.Annotations{
buildHigressAnnotationKey(annotations.MatchMethod): "GET PUT",
buildHigressAnnotationKey("exact-" + annotations.MatchHeader + "-abc"): "123",
buildHigressAnnotationKey("prefix-" + annotations.MatchHeader + "-def"): "456",
buildHigressAnnotationKey("exact-" + annotations.MatchQuery + "-region"): "beijing",
buildHigressAnnotationKey("prefix-" + annotations.MatchQuery + "-user-id"): "user-",
buildHigressAnnotationKey(annotations.MatchMethod): "GET PUT",
buildHigressAnnotationKey("exact-" + annotations.MatchHeader + "-abc"): "123",
buildHigressAnnotationKey("prefix-" + annotations.MatchHeader + "-def"): "456",
buildHigressAnnotationKey("exact-" + annotations.MatchPseudoHeader + "-authority"): "foo.bar.com",
buildHigressAnnotationKey("prefix-" + annotations.MatchPseudoHeader + "-scheme"): "htt",
buildHigressAnnotationKey("exact-" + annotations.MatchQuery + "-region"): "beijing",
buildHigressAnnotationKey("prefix-" + annotations.MatchQuery + "-user-id"): "user-",
}
expect := "higress.com-prefix-/foo" + sep + //host-pathType-path
"GET PUT" + sep + // method
"exact-abc\t123" + "\n" + "prefix-def\t456" + sep + // header
"exact-:authority\tfoo.bar.com" + "\n" + "exact-abc\t123" + "\n" +
"prefix-:scheme\thtt" + "\n" + "prefix-def\t456" + sep + // header
"exact-region\tbeijing" + "\n" + "prefix-user-id\tuser-" + sep // params

key := createRuleKey(annots, wrapperHttpRoute.PathFormat())
Expand Down
148 changes: 148 additions & 0 deletions test/e2e/conformance/tests/httproute-match-pseudo-headers.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
// Copyright (c) 2022 Alibaba Group Holding Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package tests

import (
"testing"

"github.com/alibaba/higress/test/e2e/conformance/utils/http"
"github.com/alibaba/higress/test/e2e/conformance/utils/suite"
)

func init() {
Register(HTTPRouteMatchPseudoHeaders)
}

var HTTPRouteMatchPseudoHeaders = suite.ConformanceTest{
ShortName: "HTTPRouteMatchPseudoHeaders",
Description: "Ingresses in the higress-conformance-infra namespace uses the match pseudo-headers.",
Manifests: []string{"tests/httproute-match-pseudo-headers.yaml"},
Features: []suite.SupportedFeature{suite.HTTPConformanceFeature},
Test: func(t *testing.T, suite *suite.ConformanceTestSuite) {
testcases := []http.Assertion{
{
Request: http.AssertionRequest{
ActualRequest: http.Request{
Path: "/v1",
Host: "bad.foo.com",
},
},

Response: http.AssertionResponse{
ExpectedResponse: http.Response{
StatusCode: 404,
},
},

Meta: http.AssertionMeta{},
},
{
Request: http.AssertionRequest{
ActualRequest: http.Request{
Path: "/v1",
Host: "test.foo.com",
},
},

Response: http.AssertionResponse{
ExpectedResponse: http.Response{
StatusCode: 200,
},
},

Meta: http.AssertionMeta{
TargetBackend: "infra-backend-v1",
TargetNamespace: "higress-conformance-infra",
},
},
{
Request: http.AssertionRequest{
ActualRequest: http.Request{
Path: "/v2",
Host: "test.foo.com",
},
},

Response: http.AssertionResponse{
ExpectedResponse: http.Response{
StatusCode: 404,
},
},

Meta: http.AssertionMeta{},
},
{
Request: http.AssertionRequest{
ActualRequest: http.Request{
Path: "/v2",
Host: "test2.foo.com",
},
},

Response: http.AssertionResponse{
ExpectedResponse: http.Response{
StatusCode: 200,
},
},

Meta: http.AssertionMeta{
TargetBackend: "infra-backend-v2",
TargetNamespace: "higress-conformance-infra",
},
},
{
Request: http.AssertionRequest{
ActualRequest: http.Request{
Path: "/v3",
Host: "bar.foo.com",
},
},

Response: http.AssertionResponse{
ExpectedResponse: http.Response{
StatusCode: 404,
},
},

Meta: http.AssertionMeta{},
},
{
Request: http.AssertionRequest{
ActualRequest: http.Request{
Path: "/v3/bar",
Host: "bar.foo.com",
},
},

Response: http.AssertionResponse{
ExpectedResponse: http.Response{
StatusCode: 200,
},
},

Meta: http.AssertionMeta{
TargetBackend: "infra-backend-v3",
TargetNamespace: "higress-conformance-infra",
},
},
}

t.Run("Match HTTPRoute by pseudo-headers", func(t *testing.T) {
for _, testcase := range testcases {
http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, suite.TimeoutConfig, suite.GatewayAddress, testcase)
}
})
},
}
Loading

0 comments on commit c412648

Please sign in to comment.