-
Notifications
You must be signed in to change notification settings - Fork 46
docs: post-#866 slurm platform-enum drift + nodeSelector catalog note #884
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
Open
ArangoGutierrez
wants to merge
1
commit into
NVIDIA:main
Choose a base branch
from
ArangoGutierrez:chore/post-866-slurm-followups
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
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
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
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
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,45 @@ | ||
| // Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| // | ||
| // 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 recipe | ||
|
|
||
| import ( | ||
| "sort" | ||
| "testing" | ||
| ) | ||
|
|
||
| // TestCriteriaPlatformConstantsMatchGetter guards against drift between the | ||
| // CriteriaPlatform* constants and the slice returned by | ||
| // GetCriteriaPlatformTypes(). Adding a new constant without registering it in | ||
| // the getter (or vice versa) is exactly the class of bug that left earlier | ||
| // platform-enum doc surfaces stale before this test existed. | ||
| func TestCriteriaPlatformConstantsMatchGetter(t *testing.T) { | ||
| declared := []string{ | ||
| string(CriteriaPlatformDynamo), | ||
| string(CriteriaPlatformKubeflow), | ||
| string(CriteriaPlatformNIM), | ||
| string(CriteriaPlatformSlurm), | ||
| } | ||
| sort.Strings(declared) | ||
|
|
||
| got := GetCriteriaPlatformTypes() | ||
| if len(got) != len(declared) { | ||
| t.Fatalf("len(GetCriteriaPlatformTypes())=%d, declared constants=%d", len(got), len(declared)) | ||
| } | ||
| for i, want := range declared { | ||
| if got[i] != want { | ||
| t.Errorf("GetCriteriaPlatformTypes()[%d] = %q, want %q (declared)", i, got[i], 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.
🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win
Convert this to a table-driven test with multiple cases.
The guard is useful, but this file’s guideline requires table-driven tests with multiple test cases.
♻️ Proposed refactor
func TestCriteriaPlatformConstantsMatchGetter(t *testing.T) { declared := []string{ string(CriteriaPlatformDynamo), string(CriteriaPlatformKubeflow), string(CriteriaPlatformNIM), string(CriteriaPlatformSlurm), } sort.Strings(declared) - got := GetCriteriaPlatformTypes() - if len(got) != len(declared) { - t.Fatalf("len(GetCriteriaPlatformTypes())=%d, declared constants=%d", len(got), len(declared)) - } - for i, want := range declared { - if got[i] != want { - t.Errorf("GetCriteriaPlatformTypes()[%d] = %q, want %q (declared)", i, got[i], want) - } - } + got := GetCriteriaPlatformTypes() + tests := []struct { + name string + want []string + }{ + { + name: "getter matches declared constants", + want: declared, + }, + { + name: "getter output is alphabetically sorted", + want: func() []string { + sorted := append([]string(nil), got...) + sort.Strings(sorted) + return sorted + }(), + }, + } + + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + if len(got) != len(tc.want) { + t.Fatalf("len(GetCriteriaPlatformTypes())=%d, want=%d", len(got), len(tc.want)) + } + for i, want := range tc.want { + if got[i] != want { + t.Errorf("GetCriteriaPlatformTypes()[%d] = %q, want %q", i, got[i], want) + } + } + }) + } }As per coding guidelines: "
**/*_test.go: Always use table-driven tests with multiple test cases organized in a slice of structs".🤖 Prompt for AI Agents
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.
Pushing back on this one. Project CLAUDE.md says "Table-driven tests (required for multiple cases)" — emphasis on multiple. This test has one invariant: the
CriteriaPlatform*constants match whatGetCriteriaPlatformTypes()returns. The constants and the getter are package-level singletons, so the "empty/modified set" case in your suggestion would test the framework, not the invariant under guard.Converting would add ~20 lines of boilerplate for zero additional behavior coverage. Happy to revisit if a reviewer disagrees.
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.
@ArangoGutierrez, you're right — the guideline says "required for multiple cases", and this test has exactly one meaningful invariant. My proposed second case ("getter output is alphabetically sorted") was a tautology: it sortedgotagainstgot, exercising nothing real. The pushback is well-founded and the current implementation is appropriate for a single-invariant guard test. Withdrawing the suggestion.(ᵔᴥᵔ)
✏️ Learnings added
🧠 Learnings used