feat(test): add utilities for JSONPath-like access to unstructured Kubernetes objects #519
Conversation
…bernetes objects Signed-off-by: Marc Nuri <[email protected]>
| return nil, false | ||
| } | ||
| val, exists := m[segment.field] | ||
| if !exists { |
There was a problem hiding this comment.
@manusa I think you still need a nil check on val here as well
| } | ||
|
|
||
| // FieldInt retrieves an integer field from an unstructured object using JSONPath-like notation. | ||
| // Returns 0 if the field is not found or is not an integer type (int, int64, int32). |
There was a problem hiding this comment.
@manusa I'm not 100% sure this behaviour is ideal - there could be scenarios where I'm testing and expecting to receive a value of 0 - for example status.replicas. How would we be able to distinguish between the value actually being 0 vs. not being set/not being an int?
Or do you think that's fine because this is for tests? In that case I'm fine with it but let's add a note in the docstring about ensuring that you don't assert expecting an actual value to be 0
There was a problem hiding this comment.
For that purpose you would use test.FieldExists(vm, "spec.instancetype") and expect it to be false
There was a problem hiding this comment.
I'll need to revisit for this case for the expecting to be 0
| // FieldString retrieves a string field from an unstructured object using JSONPath-like notation. | ||
| // Examples: | ||
| // - "spec.runStrategy" | ||
| // - "spec.template.spec.volumes[0].containerDisk.image" | ||
| // - "spec.dataVolumeTemplates[0].spec.sourceRef.kind" |
There was a problem hiding this comment.
Same as my comment about FieldInt - it would be nice to be able to tell the difference between not set and set to ""
There was a problem hiding this comment.
For that purpose you would use test.FieldExists(vm, "spec.instancetype") and expect it to be false
2 participants
This PR adds test utility functions that provide JSONPath-like field access for
unstructured.Unstructuredobjects.The primary goal is to improve test assertion readability by replacing deeply-nested type assertions with clean, concise path-based field access.
Readability Improvement
Before:
After: