mesh/pkg/annotations/middleware_test.go

package annotations

import (
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/traefik/traefik/v2/pkg/config/dynamic"
)

func TestBuildMiddleware(t *testing.T) {
	tests := []struct {
		desc        string
		annotations map[string]string
		want        map[string]*dynamic.Middleware
		err         bool
	}{
		{
			desc:        "nil when no middleware have been created",
			annotations: map[string]string{},
			want:        map[string]*dynamic.Middleware{},
		},
		{
			desc: "retry-attempts annotation is valid",
			annotations: map[string]string{
				"mesh.traefik.io/retry-attempts": "5",
			},
			want: map[string]*dynamic.Middleware{
				"retry": {
					Retry: &dynamic.Retry{
						Attempts: 5,
					},
				},
			},
		},
		{
			desc: "retry-attempts annotation is invalid",
			annotations: map[string]string{
				"mesh.traefik.io/retry-attempts": "hello",
			},
			err: true,
		},
		{
			desc: "circuit-breaker-expression",
			annotations: map[string]string{
				"mesh.traefik.io/circuit-breaker-expression": "LatencyAtQuantileMS(50.0) > 100",
			},
			want: map[string]*dynamic.Middleware{
				"circuit-breaker": {
					CircuitBreaker: &dynamic.CircuitBreaker{
						Expression: "LatencyAtQuantileMS(50.0) > 100",
					},
				},
			},
		},
		{
			desc: "ratelimit-average and ratelimit-burst are both valid",
			annotations: map[string]string{
				"mesh.traefik.io/ratelimit-average": "200",
				"mesh.traefik.io/ratelimit-burst":   "100",
			},
			want: map[string]*dynamic.Middleware{
				"rate-limit": {
					RateLimit: &dynamic.RateLimit{
						Average: 200,
						Burst:   100,
					},
				},
			},
		},
		{
			desc: "ratelimit-average is valid but ratelimit-burst is invalid",
			annotations: map[string]string{
				"mesh.traefik.io/ratelimit-average": "200",
				"mesh.traefik.io/ratelimit-burst":   "hello",
			},
			err: true,
		},
		{
			desc: "ratelimit-burst is valid but ratelimit-average is invalid",
			annotations: map[string]string{
				"mesh.traefik.io/ratelimit-burst":   "200",
				"mesh.traefik.io/ratelimit-average": "hello",
			},
			err: true,
		},
		{
			desc: "ratelimit-average is set but ratelimit-burst is not",
			annotations: map[string]string{
				"mesh.traefik.io/ratelimit-average": "200",
			},
			want: map[string]*dynamic.Middleware{},
		},
		{
			desc: "ratelimit-burst is set but ratelimit-average is not",
			annotations: map[string]string{
				"mesh.traefik.io/ratelimit-burst": "200",
			},
			want: map[string]*dynamic.Middleware{},
		},
		{
			desc: "multiple middlewares",
			annotations: map[string]string{
				"mesh.traefik.io/retry-attempts":             "5",
				"mesh.traefik.io/ratelimit-average":          "200",
				"mesh.traefik.io/ratelimit-burst":            "100",
				"mesh.traefik.io/circuit-breaker-expression": "LatencyAtQuantileMS(50.0) > 100",
			},
			want: map[string]*dynamic.Middleware{
				"retry": {
					Retry: &dynamic.Retry{
						Attempts: 5,
					},
				},
				"rate-limit": {
					RateLimit: &dynamic.RateLimit{
						Average: 200,
						Burst:   100,
					},
				},
				"circuit-breaker": {
					CircuitBreaker: &dynamic.CircuitBreaker{
						Expression: "LatencyAtQuantileMS(50.0) > 100",
					},
				},
			},
		},
	}

	for _, test := range tests {
		test := test
		t.Run(test.desc, func(t *testing.T) {
			t.Parallel()

			got, err := BuildMiddlewares(test.annotations)
			if test.err {
				assert.Error(t, err)
				return
			}

			assert.NoError(t, err)
			assert.Equal(t, test.want, got)
		})
	}
}