Skip to content
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

Jump to bottom

scheduler: fix klog.KObjSlice when applied to []*NodeInfo #125699

Merged
merged 2 commits into from
Jun 26, 2024
Merged

scheduler: fix klog.KObjSlice when applied to []*NodeInfo #125699

merged 2 commits into from
Jun 26, 2024

Conversation

pohly
Copy link
Contributor

@pohly pohly commented Jun 25, 2024

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

The DRA plugin uses klog.KObjSlice on a NodeInfo slice. It didn't actually work and only printed an error message about NodeInfo not implementing klog.KMetata. That's not a compile-time check due to limitations with Go generics and had been missed earlier.

Does this PR introduce a user-facing change?

NONE

/assign @sanposhiho

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jun 25, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Jun 25, 2024
@k8s-ci-robot k8s-ci-robot added sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jun 25, 2024
@pohly pohly mentioned this pull request Jun 25, 2024
Merged
9 tasks
sanposhiho
sanposhiho reviewed Jun 25, 2024
View reviewed changes
pkg/scheduler/framework/types.go Outdated
// when nodes is a []*NodeInfo.
var _ klog.KMetadata = &NodeInfo{}

func (n *NodeInfo) GetName() string { return n.node.Name }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we do if n != nil && n.node != nil just in case?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nil pointer is handled by klog, but I had to write a test to be sure 😁

It also gets handled a bit unexpectedly by klog.KObj under the hood, resulting in an empty string instead of some kind of nil indicator. This predates my involvement, I might need to go back and check that.

In the meantime, let's add a unit test. The only downside is that it encodes the current behavior of klog. If I change that behavior, I'll have to update the test.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know whether NodeInfo may have a nil node pointer, but that definitely looks worth checking. Added.

Pushed, please take another look.

@pohly pohly force-pushed the scheduler-framework-logging branch from e8e23e0 to a818a9f Compare June 25, 2024 15:11
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. area/test sig/testing Categorizes an issue or PR as relevant to SIG Testing. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 25, 2024
@pohly pohly force-pushed the scheduler-framework-logging branch from a818a9f to e9e8209 Compare June 25, 2024 18:35
sanposhiho
sanposhiho reviewed Jun 26, 2024
View reviewed changes
Copy link
Member

@sanposhiho sanposhiho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/retest

test/utils/ktesting/run.go Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Darn. It isn't. Should have gone into a different PR. Fixed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I thought there was some tricks around go testing that I didn't know of 😅

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can copy you on the PR where this will come back if you are curious 😄

But it's not a priority, so might take a while...

@pohly
ktesting: support capturing log output
fc55fec 
This is a feature of the underlying k8s.io/klog/v2/ktesting which is
useful also when using the Kubernetes ktesting.
@pohly
scheduler: fix klog.KObjSlice when applied to []*NodeInfo
719a49c 
The DRA plugin does that. It didn't actually work and only printed an error
message about NodeInfo not implementing klog.KMetata. That's not a compile-time
check due to limitations with Go generics and had been missed earlier.
@pohly pohly force-pushed the scheduler-framework-logging branch from e9e8209 to 719a49c Compare June 26, 2024 06:12
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 26, 2024
sanposhiho
sanposhiho approved these changes Jun 26, 2024
View reviewed changes
Copy link
Member

@sanposhiho sanposhiho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 26, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 7ba66f7b5cb9576e35280e586d59c7bb7a8bfc14

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pohly, sanposhiho

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 26, 2024
@sanposhiho
Copy link
Member

/retest

@pacoxu
Copy link
Member

pacoxu commented Jun 26, 2024

/test pull-kubernetes-unit
for #125688

@k8s-ci-robot k8s-ci-robot merged commit 084d6c4 into kubernetes:master Jun 26, 2024
15 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.31 milestone Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sanposhiho sanposhiho sanposhiho approved these changes

@denkensk denkensk Awaiting requested review from denkensk

Assignees

@sanposhiho sanposhiho

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/test cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. release-note-none Denotes a PR that doesn't merit a release note. sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. sig/testing Categorizes an issue or PR as relevant to SIG Testing. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v1.31
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@pohly @k8s-ci-robot @sanposhiho @pacoxu