feat: typed param registry with schema validation#190
Merged
Conversation
Introduce ParamType (String, Int, Bool, List, Dict), ParamDef, and ParamSchema types with per-type validation. Add ParamSchema field and GetParam method to BaseWorkload so workloads can look up param values against a declared schema with defaults. Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
Replace 27 private getter methods across 9 workloads with GetParam calls backed by per-workload ParamSchema declarations. Each workload now declares an exported XxxParamSchema var and sets it on the embedded BaseWorkload in its constructor. Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
Change Registry from map[string]WorkloadFactory to map[string]RegistryEntry, pairing each factory with its ParamSchema. Add ValidateParams (rejects unknown keys with "did you mean?" suggestions, validates values against declared types) and AllParamSchemas (enables future CLI help and doc generation). Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
Wire ValidateParams in the orchestrator before workload construction so invalid param keys and type-mismatched values produce clear errors instead of silently falling through to defaults. Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mrhillsman The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
exe-prow-github-app
Bot
added
the
approved
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
ParamSchemaand a singleGetParammethod onBaseWorkloadRegistryto carry param schemas alongside factories viaRegistryEntry, enablingValidateParams(unknown key detection with "did you mean?" suggestions, type checking) andAllParamSchemas(for future CLI help/doc generation)ValidateParamsinto the orchestrator so invalid params fail fast at deploy time with clear error messagesParamString,ParamInt,ParamBool,ParamList,ParamDictTest plan
ParamSchema.Find()— known key, unknown key, each typeParamDef.Validate()— all 5 types with positive and negative casesGetParam— nil params, empty params, user values, partial params, empty string falls back to default, panic on unknown keyValidateParams— valid params, empty params, unknown keys, typo suggestions, type mismatches, unknown workloadAllParamSchemas— all 9 workloads present with correct param countsgo vetandgolangci-lintcleanResolves #188