/*
Copyright 2024 The Volcano 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 priority

import (
	"testing"

	v1 "k8s.io/api/core/v1"
	schedulingv1 "k8s.io/api/scheduling/v1"

	vcapisv1 "volcano.sh/apis/pkg/apis/scheduling/v1beta1"
	"volcano.sh/volcano/cmd/scheduler/app/options"
	"volcano.sh/volcano/pkg/scheduler/actions/allocate"
	"volcano.sh/volcano/pkg/scheduler/actions/preempt"
	"volcano.sh/volcano/pkg/scheduler/api"
	"volcano.sh/volcano/pkg/scheduler/conf"
	"volcano.sh/volcano/pkg/scheduler/framework"
	"volcano.sh/volcano/pkg/scheduler/uthelper"
	"volcano.sh/volcano/pkg/scheduler/util"
)

func init() {
	options.Default()
}

var (
	trueValue         = true
	falseValue        = false
	priority          = int32(1000)
	pluginEnableEvict = conf.PluginOption{
		Name:               PluginName,
		EnabledTaskOrder:   &trueValue,
		EnabledJobOrder:    &trueValue,
		EnabledPreemptable: &trueValue,
		EnabledReclaimable: &trueValue,
		EnabledJobStarving: &trueValue,
	}
	pluginDisableEvict = conf.PluginOption{
		Name:               PluginName,
		EnabledTaskOrder:   &trueValue,
		EnabledJobOrder:    &trueValue,
		EnabledPreemptable: &falseValue,
		EnabledReclaimable: &falseValue,
		EnabledJobStarving: &trueValue,
	}
)

func TestUnifiedEvictableFn_GangReclaimPermitsAll(t *testing.T) {
	tests := []struct {
		uthelper.TestCommonStruct
		tiers []conf.Tier
	}{
		{
			tiers: []conf.Tier{
				{Plugins: []conf.PluginOption{pluginEnableEvict}},
			},
			TestCommonStruct: uthelper.TestCommonStruct{
				Name:    "GangReclaim permits all candidates regardless of priority",
				Plugins: map[string]framework.PluginBuilder{PluginName: New},
				PriClass: []*schedulingv1.PriorityClass{
					util.BuildPriorityClass("low-priority", 100),
					util.BuildPriorityClass("high-priority", 1000),
				},
				PodGroups: []*vcapisv1.PodGroup{
					util.BuildPodGroupWithPrio("pg-high", "ns1", "q1", 1, map[string]int32{}, vcapisv1.PodGroupRunning, "high-priority"),
					util.BuildPodGroupWithPrio("pg-low", "ns2", "q1", 1, map[string]int32{}, vcapisv1.PodGroupRunning, "low-priority"),
				},
				Pods: []*v1.Pod{
					util.BuildPod("ns1", "high-task", "node1", v1.PodRunning, api.BuildResourceList("1", "1G"), "pg-high", map[string]string{vcapisv1.PodPreemptable: "true"}, make(map[string]string)),
					util.BuildPod("ns2", "low-task", "node1", v1.PodRunning, api.BuildResourceList("1", "1G"), "pg-low", map[string]string{vcapisv1.PodPreemptable: "true"}, make(map[string]string)),
				},
				Nodes: []*v1.Node{
					util.BuildNode("node1", api.BuildResourceList("4", "4G", []api.ScalarResource{{Name: "pods", Value: "10"}}...), make(map[string]string)),
				},
				Queues: []*vcapisv1.Queue{
					util.BuildQueue("q1", 1, api.BuildResourceList("4", "4G")),
				},
			},
		},
	}

	for _, test := range tests {
		t.Run(test.Name, func(t *testing.T) {
			ssn := test.RegisterSession(test.tiers, nil)
			defer test.Close()
			var highTask, lowTask *api.TaskInfo
			for _, job := range ssn.Jobs {
				for _, task := range job.Tasks {
					if task.Name == "high-task" {
						highTask = task.Clone()
					} else if task.Name == "low-task" {
						lowTask = task.Clone()
					}
				}
			}
			if highTask == nil || lowTask == nil {
				t.Fatal("failed to find test tasks")
			}

			candidates := []*api.TaskInfo{highTask, lowTask}
			reclaimJob := &api.JobInfo{UID: "reclaimer", Priority: 500}

			reclaimResult := ssn.UnifiedEvictable(&api.EvictionContext{
				Kind: api.EvictionKindGangReclaim,
				Job:  reclaimJob,
			}, candidates)
			if len(reclaimResult) != 2 {
				t.Fatalf("GangReclaim: expected all 2 candidates permitted, got %d", len(reclaimResult))
			}

			preemptResult := ssn.UnifiedEvictable(&api.EvictionContext{
				Kind: api.EvictionKindGangPreempt,
				Job:  reclaimJob,
			}, candidates)
			if len(preemptResult) != 1 {
				t.Fatalf("GangPreempt: expected 1 candidate (low-priority only), got %d", len(preemptResult))
			}
			if preemptResult[0].Name != "low-task" {
				t.Fatalf("GangPreempt: expected low-task as victim, got %s", preemptResult[0].Name)
			}
		})
	}
}

func TestPreempt(t *testing.T) {
	actions := []framework.Action{allocate.New(), preempt.New()}
	plugins := map[string]framework.PluginBuilder{PluginName: New}

	tests := []struct {
		uthelper.TestCommonStruct
		actions []framework.Action
		tiers   []conf.Tier
	}{
		{
			actions: actions,
			tiers: []conf.Tier{
				{
					Plugins: []conf.PluginOption{pluginEnableEvict},
				},
			},
			TestCommonStruct: uthelper.TestCommonStruct{
				Name:    "enable preempt low priority: enablePreemptable:true",
				Plugins: plugins,
				PriClass: []*schedulingv1.PriorityClass{
					util.BuildPriorityClass("low-priority", 100),
					util.BuildPriorityClass("high-priority", 1000),
				},
				PodGroups: []*vcapisv1.PodGroup{
					util.BuildPodGroupWithPrio("pg1", "ns1", "q1", 1, map[string]int32{}, vcapisv1.PodGroupInqueue, "low-priority"),
					util.BuildPodGroupWithPrio("pg2", "ns2", "q1", 1, map[string]int32{}, vcapisv1.PodGroupInqueue, "high-priority"),
				},
				Pods: []*v1.Pod{ // as preemptee victims are searched by node, priority can not be guaranteed cross nodes
					util.BuildPod("ns1", "preemptee1", "node1", v1.PodRunning, api.BuildResourceList("3", "3G"), "pg1", map[string]string{vcapisv1.PodPreemptable: "true"}, make(map[string]string)),
					util.BuildPodWithPriority("ns1", "preemptee2", "node1", v1.PodRunning, api.BuildResourceList("3", "3G"), "pg1", map[string]string{vcapisv1.PodPreemptable: "true"}, make(map[string]string), &priority),
					util.BuildPod("ns2", "preemptor1", "", v1.PodPending, api.BuildResourceList("3", "3G"), "pg2", make(map[string]string), make(map[string]string)),
				},
				Nodes: []*v1.Node{
					util.BuildNode("node1", api.BuildResourceList("6", "6G", []api.ScalarResource{{Name: "pods", Value: "10"}}...), make(map[string]string)),
					util.BuildNode("node2", api.BuildResourceList("2", "2G", []api.ScalarResource{{Name: "pods", Value: "10"}}...), make(map[string]string)),
				},
				Queues: []*vcapisv1.Queue{
					util.BuildQueue("q1", 1, api.BuildResourceList("6", "6G")),
				},
				ExpectEvicted:   []string{"ns1/preemptee1"},
				ExpectEvictNum:  1,
				ExpectPipeLined: map[string][]string{"ns2/pg2": {"node1"}},
			},
		},
		{
			tiers: []conf.Tier{
				{
					Plugins: []conf.PluginOption{pluginDisableEvict},
				},
			},
			actions: actions,
			TestCommonStruct: uthelper.TestCommonStruct{
				Name:    "disable preempt low priority: enablePreemptable:false",
				Plugins: plugins,
				PriClass: []*schedulingv1.PriorityClass{
					util.BuildPriorityClass("low-priority", 100),
					util.BuildPriorityClass("high-priority", 1000),
				},
				PodGroups: []*vcapisv1.PodGroup{
					util.BuildPodGroupWithPrio("pg1", "ns1", "q1", 1, map[string]int32{}, vcapisv1.PodGroupInqueue, "low-priority"),
					util.BuildPodGroupWithPrio("pg2", "ns2", "q1", 1, map[string]int32{}, vcapisv1.PodGroupInqueue, "high-priority"),
				},
				Pods: []*v1.Pod{
					util.BuildPod("ns1", "preemptee1", "node1", v1.PodRunning, api.BuildResourceList("3", "3G"), "pg1", map[string]string{vcapisv1.PodPreemptable: "true"}, make(map[string]string)),
					util.BuildPod("ns1", "preemptee2", "node2", v1.PodRunning, api.BuildResourceList("3", "3G"), "pg1", map[string]string{vcapisv1.PodPreemptable: "false"}, make(map[string]string)),
					util.BuildPod("ns2", "preemptor1", "", v1.PodPending, api.BuildResourceList("3", "3G"), "pg2", make(map[string]string), make(map[string]string)),
				},
				Nodes: []*v1.Node{
					util.BuildNode("node1", api.BuildResourceList("3", "3G", []api.ScalarResource{{Name: "pods", Value: "10"}}...), make(map[string]string)),
					util.BuildNode("node2", api.BuildResourceList("3", "3G", []api.ScalarResource{{Name: "pods", Value: "10"}}...), make(map[string]string)),
				},
				Queues: []*vcapisv1.Queue{
					util.BuildQueue("q1", 1, api.BuildResourceList("6", "6G")),
				},
				ExpectEvicted:   []string{},
				ExpectEvictNum:  0,
				ExpectPipeLined: map[string][]string{},
			},
		},
	}
	for i, test := range tests {
		t.Run(test.Name, func(t *testing.T) {
			test.RegisterSession(test.tiers, nil)
			defer test.Close()
			test.Run(test.actions)
			err := test.CheckAll(i)
			if err != nil {
				t.Fatal(err)
			}
		})
	}
}
