Skip to content

[v0.14] - Sort AgentTolerations when creating agent Bundle (#4367) #4388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0xavi0 merged 1 commit into from
Dec 1, 2025
Merged

[v0.14] - Sort AgentTolerations when creating agent Bundle (#4367) #4388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions internal/cmd/controller/agentmanagement/controllers/manageagent/manageagent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"crypto/sha256"
"encoding/json"
"fmt"
"sort"

"github.com/sirupsen/logrus"

Expand All @@ -34,6 +35,46 @@ import (
"k8s.io/utils/ptr"
)

func sortTolerations(tols []corev1.Toleration) {
sort.Slice(tols, func(i, j int) bool {
a := tols[i]
b := tols[j]

// 1. Key
if a.Key != b.Key {
return a.Key < b.Key
}

// 2. Value
if a.Value != b.Value {
return a.Value < b.Value
}

// 3. Operator
if a.Operator != b.Operator {
return a.Operator < b.Operator
}

// 4. Effect
if a.Effect != b.Effect {
return a.Effect < b.Effect
}

// 5. TolerationSeconds (nil-safe)
if a.TolerationSeconds == nil && b.TolerationSeconds != nil {
return true // nil sorts first
}
if a.TolerationSeconds != nil && b.TolerationSeconds == nil {
return false
}
if a.TolerationSeconds == nil && b.TolerationSeconds == nil {
return false
}

return *a.TolerationSeconds < *b.TolerationSeconds
})
}

const (
AgentBundleName = "fleet-agent"
)
Expand Down Expand Up @@ -286,6 +327,10 @@ func (h *handler) newAgentBundle(ns string, cluster *fleet.Cluster) (runtime.Obj
priorityClassName = scheduling.FleetAgentPriorityClassName
}

if cluster.Spec.AgentTolerations != nil {
sortTolerations(cluster.Spec.AgentTolerations)
}

// Notice we only set the agentScope when it's a non-default agentNamespace. This is for backwards compatibility
// for when we didn't have agent scope before
objs := agent.Manifest(
Expand Down
197 changes: 197 additions & 0 deletions internal/cmd/controller/agentmanagement/controllers/manageagent/manageagent_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
package manageagent

import (
"reflect"
"strings"
"testing"

"github.com/rancher/wrangler/v3/pkg/generic/fake"
"github.com/rancher/wrangler/v3/pkg/schemes"
"go.uber.org/mock/gomock"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/utils/ptr"

fleet "github.com/rancher/fleet/pkg/apis/fleet.cattle.io/v1alpha1"
appsv1 "k8s.io/api/apps/v1"
networkv1 "k8s.io/api/networking/v1"
"sigs.k8s.io/yaml"

"github.com/rancher/fleet/internal/config"
)

func TestOnClusterChangeAffinity(t *testing.T) {
Expand Down Expand Up @@ -107,6 +117,85 @@ func TestOnClusterChangeAffinity(t *testing.T) {
}
}

func TestNewAgentBundle_SortsAgentTolerations(t *testing.T) {
// make sure config is set for newAgentBundle
config.Set(config.DefaultConfig())

checkRegisterAddToScheme(t, appsv1.AddToScheme)
checkRegisterAddToScheme(t, networkv1.AddToScheme)

h := &handler{systemNamespace: "fleet-system"}

unsorted := []corev1.Toleration{
{Key: "b", Value: "2", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoExecute},
{Key: "a", Value: "1", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "a", Value: "1", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoSchedule},
{Key: "a", Value: "0", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoExecute},
}

cluster := &fleet.Cluster{ObjectMeta: metav1.ObjectMeta{Name: "c1"}, Spec: fleet.ClusterSpec{AgentTolerations: unsorted}}

wantUser := []corev1.Toleration{
{Key: "a", Value: "0", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoExecute},
{Key: "a", Value: "1", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "a", Value: "1", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoSchedule},
{Key: "b", Value: "2", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoExecute},
}

// ensure leader election env is set so NewLeaderElectionOptionsWithPrefix doesn't error
t.Setenv("FLEET_AGENT_ELECTION_LEASE_DURATION", "15s")
t.Setenv("FLEET_AGENT_ELECTION_RENEW_DEADLINE", "10s")
t.Setenv("FLEET_AGENT_ELECTION_RETRY_PERIOD", "2s")

obj, err := h.newAgentBundle("ns", cluster)
if err != nil {
t.Fatalf("unexpected error from newAgentBundle: %v", err)
}

b, ok := obj.(*fleet.Bundle)
if !ok {
t.Fatalf("expected bundle object, got %#v", obj)
}

if len(b.Spec.Resources) == 0 {
t.Fatalf("bundle resources empty")
}

content := b.Spec.Resources[0].Content
docs := strings.Split(content, "\n---\n")

var found bool
for _, d := range docs {
var m map[string]interface{}
if err := yaml.Unmarshal([]byte(d), &m); err != nil {
continue
}
if kind, _ := m["kind"].(string); kind == "Deployment" {
dep := &appsv1.Deployment{}
if err := yaml.Unmarshal([]byte(d), dep); err != nil {
t.Fatalf("failed to unmarshal deployment: %v", err)
}

wantFinal := []corev1.Toleration{
{Key: "node.cloudprovider.kubernetes.io/uninitialized", Operator: corev1.TolerationOpEqual, Value: "true", Effect: corev1.TaintEffectNoSchedule},
{Key: "cattle.io/os", Operator: corev1.TolerationOpEqual, Value: "linux", Effect: corev1.TaintEffectNoSchedule},
}
wantFinal = append(wantFinal, wantUser...)

if !reflect.DeepEqual(dep.Spec.Template.Spec.Tolerations, wantFinal) {
t.Fatalf("deployment tolerations mismatch:\n got: %#v\n want: %#v", dep.Spec.Template.Spec.Tolerations, wantFinal)
}

found = true
break
}
}

if !found {
t.Fatalf("no Deployment found in bundle yaml")
}
}

func TestOnClusterChangeResources(t *testing.T) {
ctrl := gomock.NewController(t)
namespaces := fake.NewMockNonNamespacedControllerInterface[*corev1.Namespace, *corev1.NamespaceList](ctrl)
Expand Down Expand Up @@ -328,3 +417,111 @@ func TestOnClusterChangeHostNetwork(t *testing.T) {
})
}
}

// Table-driven tests covering all comparator fields used by sortTolerations
func TestSortTolerations(t *testing.T) {
five := int64(5)
ten := int64(10)

tests := []struct {
name string
in []corev1.Toleration
want []corev1.Toleration
}{
{
name: "basic ordering",
in: []corev1.Toleration{
{Key: "b", Value: "2", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoExecute},
{Key: "a", Value: "1", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "a", Value: "1", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoSchedule},
{Key: "a", Value: "0", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoExecute},
},
want: []corev1.Toleration{
{Key: "a", Value: "0", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoExecute},
{Key: "a", Value: "1", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "a", Value: "1", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoSchedule},
{Key: "b", Value: "2", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoExecute},
},
},
{
name: "toleration seconds nil first",
in: []corev1.Toleration{
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule, TolerationSeconds: &ten},
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule}, // nil
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule, TolerationSeconds: &five},
},
want: []corev1.Toleration{
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule, TolerationSeconds: &five},
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule, TolerationSeconds: &ten},
},
},
{
name: "key ordering",
in: []corev1.Toleration{
{Key: "z", Value: "x", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "a", Value: "x", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
},
want: []corev1.Toleration{
{Key: "a", Value: "x", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "z", Value: "x", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
},
},
{
name: "value ordering",
in: []corev1.Toleration{
{Key: "k", Value: "z", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "k", Value: "a", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
},
want: []corev1.Toleration{
{Key: "k", Value: "a", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "k", Value: "z", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
},
},
{
name: "operator ordering",
in: []corev1.Toleration{
{Key: "k", Value: "v", Operator: "", Effect: corev1.TaintEffectNoSchedule},
{Key: "k", Value: "v", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoSchedule},
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
},
want: []corev1.Toleration{
{Key: "k", Value: "v", Operator: "", Effect: corev1.TaintEffectNoSchedule},
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "k", Value: "v", Operator: corev1.TolerationOpExists, Effect: corev1.TaintEffectNoSchedule},
},
},
{
name: "effect ordering",
in: []corev1.Toleration{
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoExecute},
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectPreferNoSchedule},
},
want: []corev1.Toleration{
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoExecute},
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectNoSchedule},
{Key: "k", Value: "v", Operator: corev1.TolerationOpEqual, Effect: corev1.TaintEffectPreferNoSchedule},
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
inCopy := make([]corev1.Toleration, len(tt.in))
copy(inCopy, tt.in)
sortTolerations(inCopy)
if !reflect.DeepEqual(inCopy, tt.want) {
t.Fatalf("%s: got:\n%#v\nwant:\n%#v", tt.name, inCopy, tt.want)
}
})
}
}

func checkRegisterAddToScheme(t *testing.T, f func(*runtime.Scheme) error) {
t.Helper()
err := schemes.Register(f)
if err != nil {
t.Fatalf("failed to add to scheme: %v", err)
}
}