[fix]: refactor code to replace time.Now() with Now() in clock package in pkg/scheduler(#3380)

[TusharMohapatra07]

What type of PR is this?

/kind feature
/kind flake

What this PR does / why we need it:

Replaces time.Now() to use the Now() function present inside clock package

Which issue(s) this PR fixes:

Fixes #3380

Special notes for your reviewer:

This PR is work-in-progress. I've refactored the code inside pkg/scheduler for now. I shall proceed to refactor more post review.

NONE

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: TusharMohapatra07 / name: Tushar Mohapatra (c66ff31, e57f3eb, 46c9979, ddc2354, e6fe93e, f7d342b, 4d3928d, 46b198d)

[k8s-ci-robot]

Welcome @TusharMohapatra07!

It looks like this is your first PR to kubernetes-sigs/kueue 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kueue has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @TusharMohapatra07. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[netlify]

✅ Deploy Preview for kubernetes-sigs-kueue canceled.

Name	Link
🔨 Latest commit	f7d342b
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/672a24575894b70008c28472

[mimowo]

cc @mbobrovskyi for first pass

[mbobrovskyi]

• Don't forget to change time.Since(...) to s.clock.Since(...) as well.
• Please update scheduler_test.go using FakeClock instead of time.
• Implement new Option to provide FakeClock to scheduler.

[TusharMohapatra07]

@mbobrovskyi can you please elaborate on the Option thing ? i couldn't exactly understand the requirement. Also if there's any way i could join any slack or discord , that would be great as it would make a direct source of communication. I tried to join the slack channel but it's showing that it couldn't find my gmail.

[mbobrovskyi]

@mbobrovskyi can you please elaborate on the Option thing ?

We already have a few options on Scheduler

kueue/pkg/scheduler/scheduler.go

Lines 98 to 110 in 55e1367

	func WithPodsReadyRequeuingTimestamp(ts config.RequeuingTimestamp) Option {
	return func(o *options) {
	o.podsReadyRequeuingTimestamp = ts
	}
	}
	func WithFairSharing(fs *config.FairSharing) Option {
	return func(o *options) {
	if fs != nil {
	o.fairSharing = *fs
	}
	}
	}

So you need just to add one more like here

kueue/pkg/controller/jobframework/reconciler.go

Lines 194 to 201 in 55e1367

	// WithClock sets the clock of the reconciler.
	// It default to system's clock and should only
	// be changed in testing.
	func WithClock(_ testing.TB, c clock.Clock) Option {
	return func(o *Options) {
	o.Clock = c
	}
	}

Also if there's any way i could join any slack or discord , that would be great as it would make a direct source of communication. I tried to join the slack channel but it's showing that it couldn't find my gmail.

Yes, here https://kubernetes.slack.com/.

[TusharMohapatra07]

@mbobrovskyi

i get this mail when i try to login.

i do not have this email btw

[mbobrovskyi]

Try this https://slack.k8s.io/

[TusharMohapatra07]

@mbobrovskyi please check if the 1st and 3rd requirement are being fulfilled.

about the 2nd one, is it similar to what's implemented here

kueue/pkg/controller/core/workload_controller_test.go

Line 48 in 13e7705

fakeClock := testingclock.NewFakeClock(now)

?

[mbobrovskyi]

@mbobrovskyi please check if the 1st and 3rd requirement are being fulfilled.

about the 2nd one, is it similar to what's implemented here

kueue/pkg/controller/core/workload_controller_test.go

Line 48 in 13e7705

fakeClock := testingclock.NewFakeClock(now)

?

Yes, exactly.

[mbobrovskyi]

/ok-to-test

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 0eaed30412bd4b2bc6ab9e89428d341f5929c67c

[mbobrovskyi]

/kind cleanup

[mbobrovskyi]

/release-note-edit

NONE

[k8s-ci-robot]

@mbobrovskyi: /release-note-edit must be used with a single release note block.

In response to this:

/release-note-edit

NONE

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[mbobrovskyi]

@TusharMohapatra07 Please add

```release-note
NONE
```

on the PR description.

[mbobrovskyi]

/remove-kind feature flake

[mbobrovskyi]

/cc @mimowo

[TusharMohapatra07]

@mbobrovskyi about the case that you asked me to cover

kueue/pkg/scheduler/scheduler_test.go

Line 2765 in f7d342b

now := time.Now()

i couldn't find any scheduler instance being created inside the test function to pass the fakeClock to

[mbobrovskyi]

@mbobrovskyi about the case that you asked me to cover

kueue/pkg/scheduler/scheduler_test.go

Line 2765 in f7d342b

now := time.Now()

i couldn't find any scheduler instance being created inside the test function to pass the fakeClock to

Yeah, you right, it's not need. Thanks for investigation.

[mbobrovskyi]

@TusharMohapatra07 Also please remove WIP on PR title if it's ready to review.

[TusharMohapatra07]

@mbobrovskyi what about other packages ? should i raise another pr for those ? i think it would be a good idea to make one PR for each package refactor

[mbobrovskyi]

@mbobrovskyi what about other packages ? should i raise another pr for those ? i think it would be a good idea to make one PR for each package refactor

Yes, feel free to follow up on separate PRs.

[TusharMohapatra07]

@mbobrovskyi done

[mimowo]

/approve
thanks folks!

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mimowo, TusharMohapatra07

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [mimowo]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment