Tests for validation of DCAT-US records #5
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
Coverage Report
|
||||||||||||||||||||||||||||||||||||||||||
rshewitt
requested review from
Jin-Sun-tts and
jbrown-xentity
and removed request for
Jin-Sun-tts
jbrown-xentity
approved these changes
Apr 19, 2023
|
Spent some time better understanding the pyproject.toml file. Mistakenly deleted the example package and replaced the |
jbrown-xentity
approved these changes
Apr 26, 2023
Merged
Comment on lines
+4
to
+6
| def open_json(file_path): | ||
| with open(file_path) as fp: | ||
| return json.load(fp) |
There was a problem hiding this comment.
Is this function really necessary? What's the long-term benefit of it? It seems like a frivolous abstraction...
Comment on lines
+5
to
+13
| def parse_errors(errors): | ||
| error_message = "" | ||
|
|
||
| for error in errors: | ||
| error_message += ( | ||
| f"error: {error.message}. offending element: {error.json_path} \n" | ||
| ) | ||
|
|
||
| return error_message |
There was a problem hiding this comment.
Is this the best consolidation of errors that makes sense? A single string of an unknown number of errors? Isn't a list of strings more flexible?
Comment on lines
+5
to
+8
| BASE_DIR = Path(__file__).parents[3] | ||
| DATA_DIR = BASE_DIR / "data" / "dcatus" | ||
| SCHEMA_DIR = DATA_DIR / "schemas" | ||
| JSON_DIR = DATA_DIR / "jsons" |
There was a problem hiding this comment.
This is really cool 👍
Comment on lines
+11
to
+111
| def open_dataset_schema(): | ||
| dataset_schema = SCHEMA_DIR / "dataset.json" | ||
| return open_json(dataset_schema) | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def open_catalog_schema(): | ||
| catalog_schema = SCHEMA_DIR / "catalog.json" | ||
| return open_json(catalog_schema) | ||
|
|
||
|
|
||
| # invalid | ||
| @pytest.fixture | ||
| def open_numerical_title_json(): | ||
| json_file = JSON_DIR / "numerical-title.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # valid | ||
| @pytest.fixture | ||
| def open_collection_1_parent_2_children_json(): | ||
| json_file = JSON_DIR / "collection-1-parent-2-children.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # invalid | ||
| @pytest.fixture | ||
| def open_missing_catalog_json(): | ||
| json_file = JSON_DIR / "missing-catalog.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # invalid | ||
| @pytest.fixture | ||
| def open_ny_json(): | ||
| json_file = JSON_DIR / "ny.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # invalid | ||
| @pytest.fixture | ||
| def open_missing_identifier_title_json(): | ||
| json_file = JSON_DIR / "missing-identifier-title.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # invalid | ||
| @pytest.fixture | ||
| def open_missing_dataset_fields_json(): | ||
| json_file = JSON_DIR / "missing-dataset-fields.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # valid | ||
| @pytest.fixture | ||
| def open_usda_gov_json(): | ||
| json_file = JSON_DIR / "usda.gov.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # valid | ||
| @pytest.fixture | ||
| def open_arm_json(): | ||
| json_file = JSON_DIR / "arm.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # valid | ||
| @pytest.fixture | ||
| def open_large_spatial_json(): | ||
| json_file = JSON_DIR / "large-spatial.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # valid | ||
| @pytest.fixture | ||
| def open_reserved_title_json(): | ||
| json_file = JSON_DIR / "reserved-title.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # valid | ||
| @pytest.fixture | ||
| def open_collection_2_parent_4_children_json(): | ||
| json_file = JSON_DIR / "collection-2-parent-4-children.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # valid | ||
| @pytest.fixture | ||
| def open_geospatial_json(): | ||
| json_file = JSON_DIR / "geospatial.data.json" | ||
| return open_json(json_file) | ||
|
|
||
|
|
||
| # valid | ||
| @pytest.fixture | ||
| def open_null_spatial_json(): | ||
| json_file = JSON_DIR / "null-spatial.data.json" | ||
| return open_json(json_file) |
There was a problem hiding this comment.
These tests seem a bit wasteful... Can we have a datajson creator that we pass different parameters to generate the datasets instead of hardcoding the files and having a growing number of open functions? It is a different design choice, but I think it'll be more sustainable than this historical way of running tests.
Comment on lines
+16
to
+31
| def validate_json_schema(json_data, dataset_schema): | ||
| success = None | ||
| error_message = "" | ||
|
|
||
| validator = Draft202012Validator(dataset_schema) | ||
|
|
||
| try: | ||
| validator.validate(json_data) | ||
| success = True | ||
| error_message = "no errors" | ||
| except ValidationError: | ||
| success = False | ||
| errors = validator.iter_errors(json_data) | ||
| error_message = parse_errors(errors) | ||
|
|
||
| return success, error_message |
There was a problem hiding this comment.
Can we somehow highlight that this is the only real core code that was added? Add docstrings and a feature list in the README?
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.
Pull Request
Related to ticket
About
Tests for validation of DCAT-US records. All JSON files in this directory are used.
PR TASKS