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: uses containerised core in unit tests #561

Merged
merged 1 commit into from
Mar 6, 2025

Conversation

namsnath
Copy link
Contributor

@namsnath namsnath commented Feb 13, 2025

Summary of change

  • Adds unit test workflow
  • Test changes:
    • Removes all instances of start_st, clean_st, setup_st, setup_function, teardown_function
    • Adds per-test setup/teardown to call reset()
    • Replaces start_st calls and usages of localhost:3567 with get_new_core_app_url equivalents
      • Creates a new application in the core
    • Removes unused constants and functions
    • Adds TODOs for test cleanup
    • Removes st_common_init_args constant, prefers use of get_st_init_args instead
  • Adds actions for common tasks
  • Updates unit test Circle CI scripts

Related issues

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Documentation changes

(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)

Checklist for important updates

  • Changelog has been updated
  • coreDriverInterfaceSupported.json file has been updated (if needed)
    • Along with the associated array in supertokens_python/constants.py
  • frontendDriverInterfaceSupported.json file has been updated (if needed)
  • Changes to the version if needed
    • In setup.py
    • In supertokens_python/constants.py
  • Had installed and ran the pre-commit hook
  • Issue this PR against the latest non released version branch.
    • To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
    • If no such branch exists, then create one from the latest released branch.
  • If have added a new web framework, update the supertokens_python/utils.py file to include that in the FRAMEWORKS variable
  • If added a new recipe that has a User type with extra info, then be sure to change the User type in supertokens_python/types.py
  • Make sure that syncio / asyncio functions are consistent.
  • If access token structure has changed
    • Modified test in tests/sessions/test_access_token_version.py to account for any new claims that are optional or omitted by the core

Remaining TODOs for this PR

  • Move to dev images
  • Post-Merge: Remove required checks OR change settings to allow merge after all checks successful

@namsnath namsnath self-assigned this Feb 17, 2025
@namsnath namsnath marked this pull request as ready for review February 17, 2025 12:21
@namsnath namsnath requested a review from porcellus February 17, 2025 14:20
@namsnath namsnath changed the title feat: uses containerised core in tests feat: uses containerised core in unit tests Feb 24, 2025
@namsnath namsnath changed the base branch from 0.28 to 0.29 February 24, 2025 10:05
@namsnath namsnath force-pushed the ci/github-actions/containerized-core/unit-tests branch from 3684f9b to 5d00d6d Compare March 3, 2025 09:28
@namsnath namsnath changed the base branch from 0.29 to 0.28 March 5, 2025 05:26
@namsnath namsnath force-pushed the ci/github-actions/containerized-core/unit-tests branch from d642354 to 7fd939b Compare March 6, 2025 05:34
- Adds unit test workflow
- Test changes:
  - Removes all instances of start_st, clean_st, setup_st, setup_function, teardown_function
  - Adds per-test setup/teardown to call `reset()`
  - Replaces `start_st` calls and usages of `localhost:3567` with `get_new_core_app_url` equivalents
    - Creates a new application in the core
  - Removes unused constants and functions
  - Adds TODOs for test cleanup
  - Removes `st_common_init_args` constant, prefers use of `get_st_init_args` instead
- Adds actions for common tasks
  - https://github.com/supertokens/get-versions-action
  - https://github.com/supertokens/get-supported-versions-action
- Updates unit test Circle CI scripts
@namsnath namsnath force-pushed the ci/github-actions/containerized-core/unit-tests branch from 7fd939b to 6651f79 Compare March 6, 2025 05:34
@namsnath namsnath changed the base branch from 0.28 to 0.29 March 6, 2025 05:34
@sattvikc sattvikc merged commit d00c0a6 into 0.29 Mar 6, 2025
13 checks passed
@sattvikc sattvikc deleted the ci/github-actions/containerized-core/unit-tests branch March 6, 2025 07:07
namsnath added a commit that referenced this pull request Mar 6, 2025
- Changes `test-unit` command to ensure `Makefile` is found
- Reverts use of `get_new_core_url` in `test-server`
    - Introduced in #561
sattvikc pushed a commit that referenced this pull request Mar 6, 2025
- Changes `test-unit` command to ensure `Makefile` is found
- Reverts use of `get_new_core_url` in `test-server`
    - Introduced in #561
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.

3 participants