forked from volcano-sh/volcano
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request volcano-sh#3343 from lowang-bh/utFramework
feat: add ut common framework
- Loading branch information
Showing
10 changed files
with
362 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,234 @@ | ||
| /* | ||
| 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 uthelper | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
| "time" | ||
|
|
||
| v1 "k8s.io/api/core/v1" | ||
| schedulingv1 "k8s.io/api/scheduling/v1" | ||
|
|
||
| "volcano.sh/apis/pkg/apis/scheduling" | ||
| vcapisv1 "volcano.sh/apis/pkg/apis/scheduling/v1beta1" | ||
| "volcano.sh/volcano/pkg/scheduler/api" | ||
| "volcano.sh/volcano/pkg/scheduler/cache" | ||
| "volcano.sh/volcano/pkg/scheduler/conf" | ||
| "volcano.sh/volcano/pkg/scheduler/framework" | ||
| "volcano.sh/volcano/pkg/scheduler/util" | ||
| ) | ||
|
|
||
| // RegistPlugins plugins | ||
| func RegistPlugins(plugins map[string]framework.PluginBuilder) { | ||
| for name, plugin := range plugins { | ||
| framework.RegisterPluginBuilder(name, plugin) | ||
| } | ||
| } | ||
|
|
||
| // TestCommonStruct is the most common used resource when do UT | ||
| // others can wrap it in a new struct | ||
| type TestCommonStruct struct { | ||
| Name string | ||
| Plugins map[string]framework.PluginBuilder // plugins for each case | ||
| Pods []*v1.Pod | ||
| Nodes []*v1.Node | ||
| PodGroups []*vcapisv1.PodGroup | ||
| Queues []*vcapisv1.Queue | ||
| PriClass []*schedulingv1.PriorityClass | ||
| Bind map[string]string // bind results: ns/podName -> nodeName | ||
| PipeLined map[string][]string // pipelined results: map[jobID][]{nodename} | ||
| Evicted []string // evicted pods list of ns/podName | ||
| Status map[api.JobID]scheduling.PodGroupPhase // final status | ||
| BindsNum int // binds events numbers | ||
| EvictNum int // evict events numbers, include preempted and reclaimed evict events | ||
|
|
||
| // fake interface instance when check results need | ||
| stop chan struct{} | ||
| binder cache.Binder | ||
| evictor cache.Evictor | ||
| stsUpdator cache.StatusUpdater | ||
| volBinder cache.VolumeBinder | ||
| ssn *framework.Session // store opened session | ||
| } | ||
|
|
||
| var _ Interface = &TestCommonStruct{} | ||
|
|
||
| // RegistSession open session with tiers and configuration, and mock schedulerCache with self-defined FakeBinder and FakeEvictor | ||
| func (test *TestCommonStruct) RegistSession(tiers []conf.Tier, config []conf.Configuration) *framework.Session { | ||
| binder := &util.FakeBinder{ | ||
| Binds: map[string]string{}, | ||
| Channel: make(chan string), | ||
| } | ||
| evictor := &util.FakeEvictor{ | ||
| Channel: make(chan string), | ||
| } | ||
| stsUpdator := &util.FakeStatusUpdater{} | ||
| test.binder = binder | ||
| test.evictor = evictor | ||
| test.stop = make(chan struct{}) | ||
| // Create scheduler cache with self-defined binder and evictor | ||
| schedulerCache := cache.NewCustomMockSchedulerCache("utmock-scheduler", binder, evictor, stsUpdator, nil, nil, nil) | ||
| test.stsUpdator = schedulerCache.StatusUpdater | ||
| test.volBinder = schedulerCache.VolumeBinder | ||
|
|
||
| for _, node := range test.Nodes { | ||
| schedulerCache.AddOrUpdateNode(node) | ||
| } | ||
| for _, pod := range test.Pods { | ||
| schedulerCache.AddPod(pod) | ||
| } | ||
| for _, pg := range test.PodGroups { | ||
| schedulerCache.AddPodGroupV1beta1(pg) | ||
| } | ||
| for _, queue := range test.Queues { | ||
| schedulerCache.AddQueueV1beta1(queue) | ||
| } | ||
| for _, pc := range test.PriClass { | ||
| schedulerCache.AddPriorityClass(pc) | ||
| } | ||
|
|
||
| RegistPlugins(test.Plugins) | ||
| ssn := framework.OpenSession(schedulerCache, tiers, config) | ||
| test.ssn = ssn | ||
| schedulerCache.Run(test.stop) | ||
| return ssn | ||
| } | ||
|
|
||
| // Run choose to run passed in actions; if no actions provided, will panic | ||
| func (test *TestCommonStruct) Run(actions []framework.Action) { | ||
| if len(actions) == 0 { | ||
| panic("no actions provided, please specify a list of actions to execute") | ||
| } | ||
| for _, action := range actions { | ||
| action.Initialize() | ||
| action.Execute(test.ssn) | ||
| action.UnInitialize() | ||
| } | ||
| } | ||
|
|
||
| // Close do release resource and clean up | ||
| func (test *TestCommonStruct) Close() { | ||
| framework.CloseSession(test.ssn) | ||
| framework.CleanupPluginBuilders() | ||
| close(test.stop) | ||
| } | ||
|
|
||
| // CheckAll checks all the need status | ||
| func (test *TestCommonStruct) CheckAll(caseIndex int) (err error) { | ||
| if err = test.CheckBind(caseIndex); err != nil { | ||
| return | ||
| } | ||
| if err = test.CheckEvict(caseIndex); err != nil { | ||
| return | ||
| } | ||
| if err = test.CheckPipelined(caseIndex); err != nil { | ||
| return | ||
| } | ||
| return test.CheckPGStatus(caseIndex) | ||
| } | ||
|
|
||
| // CheckBind check expected bind result | ||
| func (test *TestCommonStruct) CheckBind(caseIndex int) error { | ||
| binder := test.binder.(*util.FakeBinder) | ||
| for i := 0; i < test.BindsNum; i++ { | ||
| select { | ||
| case <-binder.Channel: | ||
| case <-time.After(300 * time.Millisecond): | ||
| return fmt.Errorf("Failed to get Bind request in case %d(%s).", caseIndex, test.Name) | ||
| } | ||
| } | ||
|
|
||
| if len(test.Bind) != len(binder.Binds) { | ||
| return fmt.Errorf("case %d(%s) check bind: \nwant: %v, \ngot %v ", caseIndex, test.Name, test.Bind, binder.Binds) | ||
| } | ||
| for key, value := range test.Bind { | ||
| got := binder.Binds[key] | ||
| if value != got { | ||
| return fmt.Errorf("case %d(%s) check bind: \nwant: %v->%v\n got: %v->%v ", caseIndex, test.Name, key, value, key, got) | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // CheckEvict check the evicted result | ||
| func (test *TestCommonStruct) CheckEvict(caseIndex int) error { | ||
| evictor := test.evictor.(*util.FakeEvictor) | ||
| for i := 0; i < test.EvictNum; i++ { | ||
| select { | ||
| case <-evictor.Channel: | ||
| case <-time.After(300 * time.Millisecond): | ||
| return fmt.Errorf("Failed to get Evict request in case %d(%s).", caseIndex, test.Name) | ||
| } | ||
| } | ||
|
|
||
| evicts := evictor.Evicts() | ||
| if len(test.Evicted) != len(evicts) { | ||
| return fmt.Errorf("case %d(%s) check evict: \nwant: %v, \ngot %v ", caseIndex, test.Name, test.Evicted, evicts) | ||
| } | ||
|
|
||
| expect := map[string]int{} // evicted number | ||
| got := map[string]int{} | ||
| for _, v := range test.Evicted { | ||
| expect[v]++ | ||
| } | ||
| for _, v := range evicts { | ||
| got[v]++ | ||
| } | ||
|
|
||
| if !reflect.DeepEqual(expect, got) { | ||
| return fmt.Errorf("case %d(%s) check evict: \nwant: %v\n got: %v ", caseIndex, test.Name, expect, got) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // CheckPGStatus check job's podgroups status | ||
| func (test *TestCommonStruct) CheckPGStatus(caseIndex int) error { | ||
| ssn := test.ssn | ||
| for jobID, phase := range test.Status { | ||
| job := ssn.Jobs[jobID] | ||
| if job == nil { | ||
| return fmt.Errorf("case %d(%s) check podgroup status, job <%v> doesn't exist in session", caseIndex, test.Name, jobID) | ||
| } | ||
| got := job.PodGroup.Status.Phase | ||
| if phase != got { | ||
| return fmt.Errorf("case %d(%s) check podgroup <%v> status:\n want: %v, got: %v", caseIndex, test.Name, jobID, phase, got) | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // CheckPipelined checks pipeline results | ||
| func (test *TestCommonStruct) CheckPipelined(caseIndex int) error { | ||
| ssn := test.ssn | ||
| for jobID, nodes := range test.PipeLined { | ||
| job := ssn.Jobs[api.JobID(jobID)] | ||
| if job == nil { | ||
| return fmt.Errorf("case %d(%s) check pipeline, job <%v> doesn't exist in session", caseIndex, test.Name, jobID) | ||
| } | ||
| pipeLined := job.TaskStatusIndex[api.Pipelined] | ||
| if len(pipeLined) == 0 { | ||
| return fmt.Errorf("case %d(%s) check pipeline, want pipelined job: %v, actualy, no tasks pipelined to nodes %v", caseIndex, test.Name, jobID, nodes) | ||
| } | ||
| for _, task := range pipeLined { | ||
| if !Contains(nodes, task.NodeName) { | ||
| return fmt.Errorf("case %d(%s) check pipeline: actual: %v->%v, want: %v->%v", caseIndex, test.Name, task.Name, task.NodeName, task.Name, nodes) | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| } |
Oops, something went wrong.