godoxy/internal/route/rules/on_test.go

package rules_test

import (
	"crypto/tls"
	"encoding/base64"
	"fmt"
	"net/http"
	"net/http/httptest"
	"net/url"
	"testing"

	"github.com/yusing/godoxy/internal/route"
	"github.com/yusing/godoxy/internal/route/routes"
	. "github.com/yusing/godoxy/internal/route/rules"
	expect "github.com/yusing/goutils/testing"
	"golang.org/x/crypto/bcrypt"
)

type testCorrectness struct {
	name    string
	checker string
	input   *http.Request
	want    bool
}

func genCorrectnessTestCases(field string, genRequest func(k, v string) *http.Request) []testCorrectness {
	return []testCorrectness{
		{
			name:    field + "_match",
			checker: field + " foo bar",
			input:   genRequest("foo", "bar"),
			want:    true,
		},
		{
			name:    field + "_no_match",
			checker: field + " foo baz",
			input:   genRequest("foo", "bar"),
			want:    false,
		},
		{
			name:    field + "_exists",
			checker: field + " foo",
			input:   genRequest("foo", "abcd"),
			want:    true,
		},
		{
			name:    field + "_not_exists",
			checker: field + " foo",
			input:   genRequest("bar", "abcd"),
			want:    false,
		},
		{
			name:    field + "_negated_match",
			checker: "!" + field + " foo",
			input:   genRequest("foo", "bar"),
			want:    false,
		},
		{
			name:    field + "_negated_no_match",
			checker: "!" + field + " foo",
			input:   genRequest("bar", "foo"),
			want:    true,
		},
	}
}

func TestOnCorrectness(t *testing.T) {
	tests := []testCorrectness{
		{
			name:    "proto_match_http",
			checker: "proto http",
			input:   &http.Request{TLS: nil},
			want:    true,
		},
		{
			name:    "proto_match_https",
			checker: "proto https",
			input:   &http.Request{TLS: &tls.ConnectionState{}},
			want:    true,
		},
		{
			name:    "proto_match_h3",
			checker: "proto h3",
			input:   &http.Request{TLS: &tls.ConnectionState{}, ProtoMajor: 3},
			want:    true,
		},
		{
			name:    "proto_no_match_h3",
			checker: "proto h3",
			input:   &http.Request{TLS: &tls.ConnectionState{}, ProtoMajor: 2},
			want:    false,
		},
		{
			name:    "method_match",
			checker: "method GET",
			input:   &http.Request{Method: http.MethodGet},
			want:    true,
		},
		{
			name:    "method_no_match",
			checker: "method GET",
			input:   &http.Request{Method: http.MethodPost},
			want:    false,
		},
		{
			name:    "method_negated_match",
			checker: "!method GET",
			input:   &http.Request{Method: http.MethodGet},
			want:    false,
		},
		{
			name:    "method_negated_no_match",
			checker: "!method GET",
			input:   &http.Request{Method: http.MethodPost},
			want:    true,
		},
		{
			name:    "host_match",
			checker: "host example.com",
			input: &http.Request{
				Host: "example.com",
			},
			want: true,
		},
		{
			name:    "host_no_match",
			checker: "host example.com",
			input: &http.Request{
				Host: "example.org",
			},
			want: false,
		},
		{
			name:    "host_negated_match",
			checker: "!host example.com",
			input: &http.Request{
				Host: "example.com",
			},
			want: false,
		},
		{
			name:    "host_negated_no_match",
			checker: "!host example.com",
			input: &http.Request{
				Host: "example.org",
			},
			want: true,
		},
		{
			name:    "path_exact_match",
			checker: "path /example",
			input: &http.Request{
				URL: &url.URL{Path: "/example"},
			},
			want: true,
		},
		{
			name:    "path_negated_match",
			checker: "!path /example",
			input: &http.Request{
				URL: &url.URL{Path: "/example"},
			},
			want: false,
		},
		{
			name:    "path_negated_no_match",
			checker: "!path /example",
			input: &http.Request{
				URL: &url.URL{Path: "/example/foo"},
			},
			want: true,
		},
		{
			name:    "remote_match",
			checker: "remote 192.168.1.0/24",
			input: &http.Request{
				RemoteAddr: "192.168.1.5",
			},
			want: true,
		},
		{
			name:    "remote_negated_match",
			checker: "!remote 192.168.1.0/24",
			input: &http.Request{
				RemoteAddr: "192.168.1.5",
			},
			want: false,
		},
		{
			name:    "remote_negated_no_match",
			checker: "!remote 192.168.1.0/24",
			input: &http.Request{
				RemoteAddr: "192.168.2.5",
			},
			want: true,
		},
		{
			name:    "remote_no_match",
			checker: "remote 192.168.1.0/24",
			input: &http.Request{
				RemoteAddr: "192.168.2.5",
			},
			want: false,
		},
		{
			name:    "basic_auth_correct",
			checker: "basic_auth user " + string(expect.Must(bcrypt.GenerateFromPassword([]byte("password"), bcrypt.DefaultCost))),
			input: &http.Request{
				Header: http.Header{
					"Authorization": {"Basic " + base64.StdEncoding.EncodeToString([]byte("user:password"))}, // "user:password"
				},
			},
			want: true,
		},
		{
			name:    "basic_auth_incorrect",
			checker: "basic_auth user " + string(expect.Must(bcrypt.GenerateFromPassword([]byte("password"), bcrypt.DefaultCost))),
			input: &http.Request{
				Header: http.Header{
					"Authorization": {"Basic " + base64.StdEncoding.EncodeToString([]byte("user:incorrect"))}, // "user:wrong"
				},
			},
			want: false,
		},
		{
			name:    "basic_auth_negated_match",
			checker: "!basic_auth user " + string(expect.Must(bcrypt.GenerateFromPassword([]byte("password"), bcrypt.DefaultCost))),
			input: &http.Request{
				Header: http.Header{
					"Authorization": {"Basic " + base64.StdEncoding.EncodeToString([]byte("user:password"))}, // "user:password"
				},
			},
			want: false,
		},
		{
			name:    "basic_auth_negated_no_match",
			checker: "!basic_auth user " + string(expect.Must(bcrypt.GenerateFromPassword([]byte("password"), bcrypt.DefaultCost))),
			input: &http.Request{
				Header: http.Header{
					"Authorization": {"Basic " + base64.StdEncoding.EncodeToString([]byte("user:incorrect"))}, // "user:wrong"
				},
			},
			want: true,
		},
		{
			name:    "route_match",
			checker: "route example",
			input: routes.WithRouteContext(&http.Request{}, expect.Must(route.NewFileServer(&route.Route{
				Alias: "example",
				Root:  "/",
			}))),
			want: true,
		},
		{
			name:    "route_no_match",
			checker: "route example",
			input: &http.Request{
				Header: http.Header{},
			},
			want: false,
		},
		{
			name:    "route_negated_match",
			checker: "!route example",
			input: routes.WithRouteContext(&http.Request{}, expect.Must(route.NewFileServer(&route.Route{
				Alias: "example",
				Root:  "/",
			}))),
			want: false,
		},
		{
			name:    "route_negated_no_match",
			checker: "!route example",
			input: &http.Request{
				Header: http.Header{},
			},
			want: true,
		},
		{
			name:    "regex_match",
			checker: `host regex(example\w+\.com)`,
			input: &http.Request{
				Host: "exampleabc.com",
			},
			want: true,
		},
		{
			name:    "regex_no_match",
			checker: `host regex(example\w+\.com)`,
			input: &http.Request{
				Host: "example.org",
			},
			want: false,
		},
		{
			name:    "regex_negated_match",
			checker: `!host regex(example\w+\.com)`,
			input: &http.Request{
				Host: "example.org",
			},
			want: true,
		},
		{
			name:    "regex_negated_no_match",
			checker: `!host regex(example\w+\.com)`,
			input: &http.Request{
				Host: "exampleabc.com",
			},
			want: false,
		},
		{
			name:    "glob match",
			checker: `host glob(*.example.com)`,
			input: &http.Request{
				Host: "abc.example.com",
			},
			want: true,
		},
		{
			name:    "glob no match",
			checker: `host glob(*.example.com)`,
			input: &http.Request{
				Host: "example.com",
			},
			want: false,
		},
		{
			name:    "glob no match 2",
			checker: `host glob(*.example.com)`,
			input: &http.Request{
				Host: "example.org",
			},
			want: false,
		},
		{
			name:    "glob negated_match",
			checker: `!host glob(*.example.com)`,
			input: &http.Request{
				Host: "example.com",
			},
			want: true,
		},
		{
			name:    "glob negated_no_match",
			checker: `!host glob(*.example.com)`,
			input: &http.Request{
				Host: "a.example.com",
			},
			want: false,
		},
	}

	tests = append(tests, genCorrectnessTestCases("header", func(k, v string) *http.Request {
		return &http.Request{
			Header: http.Header{k: []string{v}},
		}
	})...)
	tests = append(tests, genCorrectnessTestCases("query", func(k, v string) *http.Request {
		return &http.Request{
			URL: &url.URL{
				RawQuery: fmt.Sprintf("%s=%s", k, v),
			},
		}
	})...)
	tests = append(tests, genCorrectnessTestCases("cookie", func(k, v string) *http.Request {
		return &http.Request{
			Header: http.Header{
				"Cookie": {fmt.Sprintf("%s=%s", k, v)},
			},
		}
	})...)
	tests = append(tests, genCorrectnessTestCases("form", func(k, v string) *http.Request {
		return &http.Request{
			Form: url.Values{
				k: []string{v},
			},
		}
	})...)
	tests = append(tests, genCorrectnessTestCases("postform", func(k, v string) *http.Request {
		return &http.Request{
			PostForm: url.Values{
				k: []string{v},
			},
		}
	})...)

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			w := httptest.NewRecorder()
			var on RuleOn
			err := on.Parse(tt.checker)
			expect.NoError(t, err)
			got := on.Check(w, tt.input)
			expect.Equal(t, tt.want, got, fmt.Sprintf("expect %s to %v", tt.checker, tt.want))
		})
	}
}