Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add unit testing to JSON schema #5593

Merged
merged 8 commits into from
Jul 24, 2023

Conversation

Leo10Gama
Copy link
Member

Why is this change necessary?

The generation logic of the JSON schema must be proven to be correct, which is why its methods should be unit tested.

How does it address the issue?

Unit tests have been added for all of the methods in schema.py, ensuring that they are correct and complete.

What side effects does this change have?

N/A

Mandatory Checklist

PRs will only be reviewed after checklist is complete

  • Add input/output type hints to new functions/methods
  • Write design document if needed (Do I need to write a design document?)
  • Write/update unit tests
  • Write/update integration tests
  • Write/update functional tests if needed
  • make pr passes
  • make update-reproducible-reqs if dependencies were changed
  • Write documentation

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@Leo10Gama Leo10Gama requested a review from a team as a code owner July 21, 2023 16:32
@github-actions github-actions bot added pr/external stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at. labels Jul 21, 2023
tests/unit/schema/test_schema_logic.py Show resolved Hide resolved
tests/unit/schema/test_schema_logic.py Outdated Show resolved Hide resolved
tests/unit/schema/test_schema_logic.py Outdated Show resolved Hide resolved
Copy link
Contributor

@hnnasit hnnasit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good to me.

@lucashuy
Copy link
Contributor

lucashuy commented Jul 24, 2023

Could we also add the schema folder to the Makefile testing related targets so that they also get run by make pr?

@lucashuy lucashuy merged commit 6d440eb into aws:feat/json-schema Jul 24, 2023
73 checks passed
@Leo10Gama Leo10Gama deleted the schema-unit-testing branch July 24, 2023 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/external stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants