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

Tests over API Best Practices #2344

Merged
merged 38 commits into from
Sep 22, 2022
Merged

Tests over API Best Practices #2344

merged 38 commits into from
Sep 22, 2022

Conversation

colin99d
Copy link
Contributor

@colin99d colin99d commented Aug 18, 2022

Description

I know this isn't supposed to be until next sprint, but I had nothing else to do. Adds a super cool function that crawls our API and makes sure no parameter names are probably incorrect versions of standard parameter names. It's also super verbose to make fixing EZ. @minhhoang1023, let me know if there are common mistakes I need to add to the dictionary

Screen Shot 2022-08-17 at 9 01 43 PM

Update: This PR found a LOT of places where we missed stuff (over 90). This will take me a decent amount of time to be ready.

I finished changing all of the bad functions. I am now trying to add a reliable way to check all of them. To do this I have added CI checks over our jupyter notebooks.

How has this been tested?

Ran pytest, add pytest coverage over jupyter notebooks.

Checklist:

Others

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My code passes all the checks pylint, flake8, black, ... To speed up development you should run pre-commit install.
  • New and existing unit tests pass locally with my changes. You can test this locally using pytest tests/....

@colin99d colin99d marked this pull request as draft August 18, 2022 13:10
@colin99d colin99d marked this pull request as ready for review September 20, 2022 18:37
.github/workflows/test.yml Outdated Show resolved Hide resolved
@jose-donato jose-donato merged commit 5bc7bc0 into main Sep 22, 2022
@colin99d colin99d deleted the special_tests branch September 23, 2022 05:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants