Repository navigation
fix(scheduler): honour HAMI_NODELOCK_EXPIRE when the flag is not set #2721
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.
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
Closed
IIITManjeet
wants to merge
2
commits into
Project-HAMi:master
from
IIITManjeet:fix/nodelock-expire-env-precedence
Closed
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,59 @@ | ||
| /* | ||
| Copyright 2024 The HAMi 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 main | ||
|
|
||
| import ( | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/Project-HAMi/HAMi/pkg/scheduler/config" | ||
| "github.com/Project-HAMi/HAMi/pkg/util/nodelock" | ||
| ) | ||
|
|
||
| func TestApplyNodeLockTimeout(t *testing.T) { | ||
| const defaultTimeout = 5 * time.Minute | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| flagSet bool | ||
| flag time.Duration | ||
| env time.Duration | ||
| want time.Duration | ||
| }{ | ||
| {name: "flag unset keeps env value", flagSet: false, flag: defaultTimeout, env: 5 * time.Second, want: 5 * time.Second}, | ||
| {name: "flag set overrides env", flagSet: true, flag: 5 * time.Second, env: defaultTimeout, want: 5 * time.Second}, | ||
| {name: "neither set keeps default", flagSet: false, flag: defaultTimeout, env: defaultTimeout, want: defaultTimeout}, | ||
| } | ||
| for _, tc := range tests { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| origFlag, origEnv := config.NodeLockTimeout, nodelock.NodeLockTimeout | ||
| t.Cleanup(func() { | ||
| config.NodeLockTimeout, nodelock.NodeLockTimeout = origFlag, origEnv | ||
| }) | ||
| config.NodeLockTimeout, nodelock.NodeLockTimeout = tc.flag, tc.env | ||
|
|
||
| applyNodeLockTimeout(tc.flagSet) | ||
|
|
||
| if nodelock.NodeLockTimeout != tc.want { | ||
| t.Errorf("nodelock.NodeLockTimeout = %v, want %v", nodelock.NodeLockTimeout, tc.want) | ||
| } | ||
| if config.NodeLockTimeout != tc.want { | ||
| t.Errorf("config.NodeLockTimeout = %v, want %v", config.NodeLockTimeout, tc.want) | ||
| } | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 alternative: make the flag default nodelock.NodeLockTimeout in init, the env is already applied there by import order, then no bool threading is needed. also nothing else reads config.NodeLockTimeout, is the write back needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call on both. Done.
Flag default is now
nodelock.NodeLockTimeout—mainimportspkg/util/nodelock, so itsinit()(andsetupNodeLockTimeout, which readsHAMI_NODELOCK_EXPIRE) completes before this package registers flags. The default already carries the env value, sostart()goes back to the plain unconditional assignment andapplyNodeLockTimeout, the bool param and theChanged(...)call are gone. The write-back went too — as you say, nothing outsidecmd/schedulerreadsconfig.NodeLockTimeout.Side benefit:
PrintPFlagsruns beforestart(), so the startup log used to printFLAG: --node-lock-timeout="5m0s"while the effective value was 7s. They agree now.Rebuilt at both revisions and compared startup logs —
Set node lock timeoutis unchanged in all four cases (env only 7s, env+flag 33s, neither 5m0s, bad env 5m0s).One visible trade-off:
--helpnow shows an env-dependent default (7s when the chart setsscheduler.nodeLockExpire: 7s). I think showing the real default is better, but happy to pin it back if you'd rather.TestApplyNodeLockTimeouthad no function left to cover, so it's nowTestNodeLockTimeoutFlagDefault, asserting the registered default isnodelock.NodeLockTimeout— re-hardcoding a duration there is exactly how #2692 comes back. Env parsing is already covered inpkg/util/nodelock/nodelock_test.go.