knative.dev/pkg@v0.0.0-20260602142205-ac97e43f6622/leaderelection/config_test.go

/*
Copyright 2020 The Knative Authors

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 leaderelection

import (
	"fmt"
	"strconv"
	"strings"
	"testing"
	"time"

	"github.com/google/go-cmp/cmp"
	corev1 "k8s.io/api/core/v1"

	"knative.dev/pkg/kmap"
)

const (
	controllerOrdinalEnv = "STATEFUL_CONTROLLER_ORDINAL"
	serviceNameEnv       = "STATEFUL_SERVICE_NAME"
	servicePortEnv       = "STATEFUL_SERVICE_PORT"
	serviceProtocolEnv   = "STATEFUL_SERVICE_PROTOCOL"
)

func okConfig() *Config {
	return &Config{
		Buckets:       1,
		LeaseDuration: 15 * time.Second,
		RenewDeadline: 10 * time.Second,
		RetryPeriod:   2 * time.Second,
	}
}

func okData() map[string]string {
	return map[string]string{
		"buckets": "1",
		// values in this data come from the defaults suggested in the
		// code:
		// https://github.com/kubernetes/client-go/blob/kubernetes-1.16.0/tools/leaderelection/leaderelection.go
		"lease-duration": "15s",
		"renew-deadline": "10s",
		"retry-period":   "2s",
	}
}

func TestNewConfigMapFromData(t *testing.T) {
	cases := []struct {
		name     string
		data     map[string]string
		expected *Config
		err      string
	}{{
		name:     "OK config - controller enabled",
		data:     okData(),
		expected: okConfig(),
	}, {
		name: "OK config - controller enabled with multiple buckets",
		data: kmap.Union(okData(), map[string]string{
			"buckets": "5",
		}),
		expected: func() *Config {
			config := okConfig()
			config.Buckets = 5
			return config
		}(),
	}, {
		name: "invalid lease-duration",
		data: kmap.Union(okData(), map[string]string{
			"lease-duration": "flops",
		}),
		err: `failed to parse "lease-duration": time: invalid duration`,
	}, {
		name: "invalid renew-deadline",
		data: kmap.Union(okData(), map[string]string{
			"renew-deadline": "flops",
		}),
		err: `failed to parse "renew-deadline": time: invalid duration`,
	}, {
		name: "invalid retry-period",
		data: kmap.Union(okData(), map[string]string{
			"retry-period": "flops",
		}),
		err: `failed to parse "retry-period": time: invalid duration`,
	}, {
		name: "invalid buckets - not an int",
		data: kmap.Union(okData(), map[string]string{
			"buckets": "not-an-int",
		}),
		err: `failed to parse "buckets": strconv.ParseUint: parsing "not-an-int": invalid syntax`,
	}, {
		name: "invalid buckets - too small",
		data: kmap.Union(okData(), map[string]string{
			"buckets": "0",
		}),
		err: fmt.Sprint("buckets: value must be between 1 <= 0 <= ", MaxBuckets),
	}, {
		name: "invalid buckets - too large",
		data: kmap.Union(okData(), map[string]string{
			"buckets": strconv.Itoa(int(MaxBuckets + 1)),
		}),
		err: fmt.Sprintf("buckets: value must be between 1 <= %d <= %d", MaxBuckets+1, MaxBuckets),
	}, {
		name: "legacy keys",
		data: map[string]string{
			"leaseDuration": "2s",
			"renewDeadline": "3s",
			"retryPeriod":   "4s",
			"buckets":       "5",
		},
		expected: &Config{
			Buckets:       5,
			LeaseDuration: 2 * time.Second,
			RenewDeadline: 3 * time.Second,
			RetryPeriod:   4 * time.Second,
		},
	}, {
		name: "prioritize new keys",
		data: map[string]string{
			"lease-duration": "1s",
			"renew-deadline": "2s",
			"retry-period":   "3s",
			"leaseDuration":  "4s",
			"renewDeadline":  "5s",
			"retryPeriod":    "6s",
			"buckets":        "7",
		},
		expected: &Config{
			Buckets:       7,
			LeaseDuration: 1 * time.Second,
			RenewDeadline: 2 * time.Second,
			RetryPeriod:   3 * time.Second,
		},
	}}

	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			actualConfig, actualErr := NewConfigFromConfigMap(
				&corev1.ConfigMap{
					Data: tc.data,
				})

			if actualErr != nil {
				if got, want := actualErr.Error(), tc.err; !strings.HasPrefix(got, want) {
					t.Fatalf("Err = '%s', want: '%s'", got, want)
				}
			} else if tc.err != "" {
				t.Fatal("Expected an error, got none")
			}

			if got, want := actualConfig, tc.expected; !cmp.Equal(got, want) {
				t.Errorf("Config = %#v, want: %#v, diff(-want,+got):\n%s", got, want, cmp.Diff(want, got))
			}
		})
	}
}

func TestNewConfigFromMap(t *testing.T) {
	tt := []struct {
		name    string
		data    map[string]string
		want    Config
		wantErr bool
	}{{
		name: "ok config",
		data: map[string]string{
			"lease-duration": "15s",
			"buckets":        "5",
		},
		want: Config{
			Buckets:       5,
			LeaseDuration: 15 * time.Second,
			RenewDeadline: 40 * time.Second,
			RetryPeriod:   10 * time.Second,
		},
	}, {
		name: "ok config, prefix map",
		data: map[string]string{
			"lease-duration":              "15s",
			"buckets":                     "5",
			"map-lease-prefix.reconciler": "reconciler1",
		},
		want: Config{
			Buckets:       5,
			LeaseDuration: 15 * time.Second,
			RenewDeadline: 40 * time.Second,
			RetryPeriod:   10 * time.Second,
			LeaseNamesPrefixMapping: map[string]string{
				"reconciler": "reconciler1",
			},
		},
	}}

	for _, tc := range tt {
		t.Run(tc.name, func(t *testing.T) {
			c, err := NewConfigFromMap(tc.data)
			if tc.wantErr != (err != nil) {
				t.Fatalf("want err %v got %v", tc.wantErr, err)
			}
			if diff := cmp.Diff(tc.want, *c); diff != "" {
				t.Fatal("(-want, +got)", diff)
			}
		})
	}
}

func TestGetComponentConfig(t *testing.T) {
	const expectedName = "the-component"
	cases := []struct {
		name     string
		config   Config
		expected ComponentConfig
	}{{
		name: "component enabled",
		config: Config{
			LeaseDuration: 15 * time.Second,
			RenewDeadline: 10 * time.Second,
			RetryPeriod:   2 * time.Second,
		},
		expected: ComponentConfig{
			Component:     expectedName,
			LeaseDuration: 15 * time.Second,
			RenewDeadline: 10 * time.Second,
			RetryPeriod:   2 * time.Second,
		},
	}}

	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			actual := tc.config.GetComponentConfig(expectedName)
			if got, want := actual, tc.expected; !cmp.Equal(got, want) {
				t.Errorf("Incorrect config: diff(-want,+got):\n%s", cmp.Diff(want, got))
			}
		})
	}
}

func TestNewStatefulSetConfig(t *testing.T) {
	cases := []struct {
		name     string
		pod      string
		service  string
		port     string
		protocol string
		wantErr  string
		expected statefulSetConfig
	}{{
		name:    "success with default",
		pod:     "as-42",
		service: "autoscaler",
		expected: statefulSetConfig{
			StatefulSetID: statefulSetID{
				ssName:  "as",
				ordinal: 42,
			},
			ServiceName: "autoscaler",
			Port:        "80",
			Protocol:    "http",
		},
	}, {
		name:     "success with overriding",
		pod:      "as-42",
		service:  "autoscaler",
		port:     "8080",
		protocol: "ws",
		expected: statefulSetConfig{
			StatefulSetID: statefulSetID{
				ssName:  "as",
				ordinal: 42,
			},
			ServiceName: "autoscaler",
			Port:        "8080",
			Protocol:    "ws",
		},
	}, {
		name:    "failure with empty envs",
		wantErr: "required key STATEFUL_CONTROLLER_ORDINAL missing value",
	}, {
		name:    "failure with invalid name",
		pod:     "as-abcd",
		wantErr: `envconfig.Process: assigning STATEFUL_CONTROLLER_ORDINAL to StatefulSetID: converting 'as-abcd' to type leaderelection.statefulSetID. details: strconv.Atoi: parsing "abcd": invalid syntax`,
	}}

	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			if tc.pod != "" {
				t.Setenv(controllerOrdinalEnv, tc.pod)
			}
			if tc.service != "" {
				t.Setenv(serviceNameEnv, tc.service)
			}
			if tc.port != "" {
				t.Setenv(servicePortEnv, tc.port)
			}
			if tc.protocol != "" {
				t.Setenv(serviceProtocolEnv, tc.protocol)
			}

			ssc, err := newStatefulSetConfig()
			if err != nil {
				if got, want := err.Error(), tc.wantErr; got != want {
					t.Errorf("Got error: %s. want: %s", got, want)
				}
			} else {
				if got, want := *ssc, tc.expected; !cmp.Equal(got, want, cmp.AllowUnexported(statefulSetID{})) {
					t.Errorf("Incorrect config: diff(-want,+got):\n%s", cmp.Diff(want, got))
				}
			}
		})
	}
}