Add warning logging for poorly formed URL config parameters #775
Conversation
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
Signed-off-by: Carson Cook <carson.cook@ibm.com>
Signed-off-by: Carson Cook <carson.cook@ibm.com>
URLs can easily be malformed with poor configuration parameters. Relative path URLs are concatenated with the base URL, so the baseUrl parameter is expected not to have a trailing '/' and relative URLs are expected to begin with '/'. Logging has been added for the baseUrl, contextPath, homePageRelativeUrl, statusPageRelativeUrl, and healthCheckRelativeUrl parameters. Signed-off-by: Carson Cook <carson.cook@ibm.com>
2 tasks
|
Kudos, SonarCloud Quality Gate passed!
|
balhar-jakub
approved these changes
Aug 10, 2020
2 tasks
balhar-jakub
pushed a commit
that referenced
this pull request
Aug 13, 2020
* Fix intellij warnings in EurekaInstanceConfigValidator Signed-off-by: Carson Cook <carson.cook@ibm.com> * Fix intellij warnings in EurekaInstanceConfigValidatorTest Signed-off-by: Carson Cook <carson.cook@ibm.com> * Add new logging for URL parameters URLs can easily be malformed with poor configuration parameters. Relative path URLs are concatenated with the base URL, so the baseUrl parameter is expected not to have a trailing '/' and relative URLs are expected to begin with '/'. Logging has been added for the baseUrl, contextPath, homePageRelativeUrl, statusPageRelativeUrl, and healthCheckRelativeUrl parameters. Signed-off-by: Carson Cook <carson.cook@ibm.com>
balhar-jakub
pushed a commit
that referenced
this pull request
Aug 13, 2020
* Fix intellij warnings in EurekaInstanceConfigValidator Signed-off-by: Carson Cook <carson.cook@ibm.com> * Fix intellij warnings in EurekaInstanceConfigValidatorTest Signed-off-by: Carson Cook <carson.cook@ibm.com> * Add new logging for URL parameters URLs can easily be malformed with poor configuration parameters. Relative path URLs are concatenated with the base URL, so the baseUrl parameter is expected not to have a trailing '/' and relative URLs are expected to begin with '/'. Logging has been added for the baseUrl, contextPath, homePageRelativeUrl, statusPageRelativeUrl, and healthCheckRelativeUrl parameters. Signed-off-by: Carson Cook <carson.cook@ibm.com> Signed-off-by: Jakub Balhar <jakub.balhar@broadcom.com>
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.
Description
Malformed URLs are apt to occur when the
baseUrlorcontextPathparameters end with a trailing/, and/or whenhomePageRelativeUrl,statusPageRelativeUrl,healthCheckRelativeUrl, andcontextPathparameters don't begin with a/. This PR adds warnings that are logged when the/are not in appropriate places.Tests were not added as there is no precedent in api-layer for using log messages as acceptance conditions, and there are no other acceptance conditions than log status.
Fixes #744
Type of change
Please delete options that are not relevant.
Checklist:
For more details about how should the code look like read the Contributing guideline