fix: freeze time to avoid jwt expiration#38492
fix: freeze time to avoid jwt expiration#38492wgu-taylor-payne merged 1 commit intoopenedx:masterfrom
Conversation
|
Thanks for the pull request, @wgu-taylor-payne! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Description
Fixes flaky
ExpiredSignatureErrorfailures inopenedx/core/lib/tests/test_jwt.pyby freezing time during test execution.Root cause
test_now = int(time())is evaluated once at module import time. Tokens are created withexp = test_now + 1000. Whenunpack_and_verifycallsjwt.decode, PyJWT checksexpagainstthe real wall clock via
time.time(). If the test runs more than 1000 seconds after the modulewas imported (due to test ordering or slow CI), the token is already expired.
Fix
Wrap both test classes with
@freeze_timeat thetest_nowtimestamp so thattime.time()returns a consistent value during test execution. This ensures PyJWT's internal
expchecksees the same clock that was used to create the token.
Also converts assertions to pytest style (
assert ==,pytest.raises) and removes thecorresponding
# noqasuppressions.Also removes unused variables (
expected_token_with_claims) in a couple of methods.No production code changes.
Supporting information
Testing instructions
Deadline
None
Other information
freezegunis already in test requirements (requirements/edx/testing.in).