validation: improve warning message for unexpected properties #693
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
giuseppe-steduto
force-pushed
the
validate-improve-warnings
branch
from
a6a4974
to
5f52cae
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #693 +/- ##
==========================================
- Coverage 58.62% 58.57% -0.05%
==========================================
Files 24 24
Lines 2388 2390 +2
==========================================
Hits 1400 1400
- Misses 988 990 +2
|
mdonadoni
reviewed
Nov 29, 2023
reana_client/validation/utils.py
Outdated
| if warning_key == "additional_properties": | ||
| # warning_values is a list of unexpected properties | ||
| messages = [ | ||
| f"'{value['property']}' (at {value['path']})" |
There was a problem hiding this comment.
The path might be empty, so sometimes this is shown:
Unexpected properties found in REANA specification file: 'environment' (at )
setup.py
Outdated
| @@ -45,7 +45,7 @@ | |||
| "click>=7", | |||
| "pathspec==0.9.0", | |||
| "jsonpointer>=2.0", | |||
| "reana-commons[yadage,snakemake,cwl]>=0.9.4a1,<0.10.0", | |||
| "reana-commons[yadage,snakemake,cwl]>=0.9.4a4,<0.10.0", | |||
There was a problem hiding this comment.
Suggested change
| "reana-commons[yadage,snakemake,cwl]>=0.9.4a4,<0.10.0", | |
| "reana-commons[yadage,snakemake,cwl]>=0.9.4a3,<0.10.0", |
After this CI should pass!
Change the warning message generated when unexpected properties are found in the REANA specification during the validation phase to include the path to the invalidating properties. Closes reanahub#679.
giuseppe-steduto
force-pushed
the
validate-improve-warnings
branch
from
5f52cae
to
208a8e6
Compare
mdonadoni
approved these changes
Dec 1, 2023
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.
Change the warning message generated when unexpected properties are
found in the REANA specification during the validation phase to include
the path to the invalidating properties.
Closes #679.