validator checks import attributes #420
Merged
Conversation
This file contains 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
Signed-off-by: Stephanie <[email protected]>
yangcao77
requested review from
amisevsk,
davidfestal and
sleshchenko
as code owners
Signed-off-by: Stephanie <[email protected]>
Signed-off-by: Stephanie <[email protected]>
yangcao77
force-pushed
the
397-validatorChecksImportAttributes
branch
2 times, most recently
from
e62b6f1 to
565f6e0
Compare
… reference if any Signed-off-by: Stephanie <[email protected]>
yangcao77
force-pushed
the
397-validatorChecksImportAttributes
branch
from
565f6e0 to
a22cea8
Compare
Signed-off-by: Stephanie <[email protected]>
amisevsk
reviewed
May 4, 2021
pkg/validation/commands.go
Outdated
| return fmt.Errorf("there should be exactly one default command, currently there is more than one default command") | ||
| var commandsReference string | ||
| for _, command := range defaultCommands { | ||
| commandsReference += resolveErrorMessageWithImportAttributes(fmt.Errorf("; command: %s", command.Id), command.Attributes).Error() |
There was a problem hiding this comment.
I think fmt.Sprintf might be cleaner here for formatting:
Suggested change
| commandsReference += resolveErrorMessageWithImportAttributes(fmt.Errorf("; command: %s", command.Id), command.Attributes).Error() | |
| commandsReference = fmt.Sprintf("%s; %s", commandsReference, resolveErrorMessageWithImportAttributes(fmt.Errorf("command: %s", command.Id), command.Attributes).Error() |
or we could accumulate to a []string and use Join:
Suggested change
| commandsReference += resolveErrorMessageWithImportAttributes(fmt.Errorf("; command: %s", command.Id), command.Attributes).Error() | |
| commandsReferenceList = append(commandsReferenceList, resolveErrorMessageWithImportAttributes(fmt.Errorf("command: %s", command.Id), command.Attributes).Error()) | |
| //... | |
| strings.Join(commandsReferenceList, "; ") |
This would avoid the need to format the message below with "default command%s"
pkg/validation/components.go
Outdated
| @@ -103,7 +106,9 @@ func ValidateComponents(components []v1alpha2.Component) error { | |||
| for componentName, volumeMountNames := range processedVolumeMounts { | |||
| for _, volumeMountName := range volumeMountNames { | |||
| if !processedVolumes[volumeMountName] { | |||
| invalidVolumeMountsErr += fmt.Sprintf("\nvolume mount %s belonging to the container component %s", volumeMountName, componentName) | |||
| missingVolumeMountErr := fmt.Errorf("\nvolume mount %s belonging to the container component %s", volumeMountName, componentName) | |||
There was a problem hiding this comment.
Outside the scope of this PR, but seeing fmt.Errorf("\nvolume makes me feel like MissingVolumeMountError should store errs: []string rather than errMsg: string.
pkg/validation/errors.go
Outdated
| } | ||
|
|
||
| func (e *InvalidCommandTypeError) Error() string { | ||
| return fmt.Sprintf("command %s type is invalid", e.commandId) |
There was a problem hiding this comment.
Suggested change
| return fmt.Sprintf("command %s type is invalid", e.commandId) | |
| return fmt.Sprintf("command %s has invalid type", e.commandId) |
pkg/validation/projects.go
Outdated
| errString += fmt.Sprintf("\nstarterProject %s should have at least one remote", starterProject.Name) | ||
| starterProjectErr := fmt.Errorf("\nstarterProject %s should have at least one remote", starterProject.Name) | ||
| newErr := resolveErrorMessageWithImportAttributes(starterProjectErr, starterProject.Attributes) | ||
| errString += newErr.Error() |
There was a problem hiding this comment.
I think we should accumulate errors in []string and use strings.Join(errList, "\n")
There was a problem hiding this comment.
updated. Also update all error concatenation to use []string & string join
Signed-off-by: Stephanie <[email protected]>
yangcao77
force-pushed
the
397-validatorChecksImportAttributes
branch
from
16269b2 to
7cc978e
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: amisevsk, yangcao77 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
This PR checks import attributes before validator returns an error message to improve the error message shown
validator will check for the specific attribute before sending back the error message. If the attribute does not exist, the error message will be as what it currently has.
What issues does this PR fix or reference?
#397
Is your PR tested? Consider putting some instruction how to test your changes
Added unit tests
Docs PR