validate uniqueness by identity #54
Open
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
added 3 commits
October 7, 2024 11:46
…uniqueness by required properties; this update makes it check uniqueness by properies with x-Ed-Fi-isIdentity in Swagger
tomreitz
commented
Oct 7, 2024
| return "#/components/schemas/" + camel_case(namespace) + "_" + singularize_endpoint(endpoint) | ||
|
|
||
| def resolve_swagger_ref(swagger, ref): |
There was a problem hiding this comment.
This abstracts Swagger $ref resolution logic, which varies by Ed-Fi version.
| @@ -166,7 +166,8 @@ def write_structured_output(self, command): | |||
| # failures.line_numbers are split each on their own line; here we remove those line breaks | |||
| content = re.sub(r'"line_numbers": \[(\d|,|\s|\n)*\]', self.replace_linebreaks, content) | |||
| fp.write(content) | |||
| self.logger.info(f"results written to {self.results_file}") | |||
|
|
|||
| self.logger.info(f"results written to {self.results_file}") | |||
There was a problem hiding this comment.
(Added an indent here so it's only printed if a results-file was actually created.)
lightbeam/api.py
Outdated
| sub_schema = util.resolve_swagger_ref(swagger, sub_definition) | ||
| for sub_prop in sub_schema["required"]: | ||
| params[f"{prop}.{sub_prop}"] = sub_prop | ||
| elif "$ref" in schema["properties"][prop].keys(): |
There was a problem hiding this comment.
recurse into $ref properties
lightbeam/api.py
Outdated
| for k,v in sub_params.items(): | ||
| params[k] = v | ||
| elif schema["properties"][requiredProperty]["type"]!="array": | ||
| params[requiredProperty] = prefix + requiredProperty | ||
| elif schema["properties"][prop]["type"]!="array" and "x-Ed-Fi-isIdentity" in schema["properties"][prop].keys(): |
There was a problem hiding this comment.
properties with x-Ed-Fi-isIdentity=true are part of identity
| @@ -331,33 +331,52 @@ async def load_descriptors_values(self): | |||
| # } | |||
| # (The first element is a required attribute of the assessmentItem; the other two are required elements | |||
| # of the required nested assessmentReference.) | |||
| def get_params_for_endpoint(self, endpoint): | |||
| def get_params_for_endpoint(self, endpoint, type='required'): | |||
There was a problem hiding this comment.
the default type here ensures non-breaking functionality for any other lightbeam functions that use this function
tomreitz
commented
Oct 15, 2024
lightbeam/api.py
Outdated
| self.logger.critical(f"Swagger contains neither `definitions` nor `components.schemas` - check that the Swagger is valid.") | ||
|
|
||
| for prop in schema["properties"]: | ||
| if prop.endswith("Reference") and "required" in schema.keys() and prop in schema['required']: |
There was a problem hiding this comment.
required properties of a *Reference are part of the identity
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.
lightbeam validatepayload uniqueness previously (and incorrectly) checked uniqueness by required properties; this PR makes it check uniqueness by properties withx-Ed-Fi-isIdentity=truein Swagger.