Repository navigation
Conversation
httpretty has had no release since 2021 and patches sockets globally, which is how it broke MongoDB connections under pymongo 4.12+ in #39246. `responses` mocks at the `requests` adapter level instead, which covers every HTTP call the httpretty-based tests exercise, and it is already used by the user retirement scripts in this repo. This adds it so the httpretty tests can be migrated one app at a time; httpretty itself is removed once the last use is gone. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ests `CommentsServiceMockMixin` registered httpretty responses for the old cs_comments_service endpoints, but since the move to openedx-forum every discussion test resolves the same `register_*` names to `ForumMockUtilsMixin`, which mocks the forum API's Python functions. The only remaining references were an unused import, a base class that was shadowed in the MRO, and `httpretty.enable()` calls in setUp that never had a URL registered against them. Remove the mixin, the request-parsing helpers and callbacks only it used, and the vestigial httpretty setup in the serializer tests. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The commerce mock context managers used to enable and disable httpretty themselves, which is why nested uses needed `reset_on_exit=False` and the module docstring warned against mixing them with direct httpretty use. They now register on the `responses` default registry and the caller keeps `responses` active, via `@responses.activate` or `responses.start()` in setUp. `expect_called` compares the number of requests to the mocked endpoint before and after the block instead of inspecting the global last request, so it no longer depends on what other mocks did. The verify_student, refunds and course_modes tests that depend on these mocks are converted in the same commit. Request bodies are passed to `json.loads` directly, which accepts both `str` and `bytes`, since `responses` hands back the prepared request body as either depending on how the client sent it. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Mechanical replacement of `httpretty.register_uri` with `responses.add` and `@httpretty.activate` with `@responses.activate`. Request counts come from `responses.calls` instead of `httpretty.latest_requests`. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Mostly mechanical, with a few things worth knowing: - `@httpretty.activate` on a class decorated every test method; the same decorator from `responses` wraps the class object itself, so pytest stops collecting the class and its tests silently disappear. The class-level uses in the cache_programs and edx_api_utils tests become `responses.start()` in setUp with stop and reset as cleanups. - `responses` matches a registration on scheme, host and path only, so the per-page pathway mocks in cache_programs match on their query parameters explicitly with `matchers.query_param_matcher`. - Callback bodies take the prepared request alone and return the response headers themselves, and query strings are read from the request URL since there is no `querystring` attribute. - The edx_api_utils test passed a `url` keyword into `httpretty.Response` where it was ignored; it now goes to `_mock_catalog_api`, which is where it was meant to go. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
`ThirdPartyOAuthTestMixin` carried a class-level `@httpretty.activate` that every OAuth test class in auth_exchange, oauth_dispatch and user_authn repeated. The mixin's setUp now starts `responses` and registers stop and reset as cleanups, and the per-class decorators go away, since `responses.activate` on a class would hide its tests from pytest. The TestShib SAML spec used httpretty callbacks for the SAP SuccessFactors endpoints. Those become `responses.add_callback` callbacks that take the prepared request. Two tests re-register the OData user endpoint to override the default mock from setUp; httpretty served the newest registration for a path but `responses` serves the oldest, so those tests remove the setUp mock first. Request bodies are compared as bytes through a small helper because `requests` prepares form data as `str`. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
httpretty's last release was 1.1.4 in 2021. It patches the socket module globally, which broke MongoDB connections under pymongo 4.12+ in #39246, and it does not support Python 3.14. Every test that used it has been migrated to `responses`, so remove it from the testing group and the lock. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Follow-up to #39246. Replaces httpretty with
responsesin every test that used it and drops httpretty from the testing group. httpretty's last release was in 2021, it patches sockets globally, which is how it broke MongoDB connections under pymongo 4.12+, and it does not support Python 3.14.One commit per app so each is reviewable on its own. The first adds the dependency, the last removes httpretty; everything in between is green at each step.
A few things that are not mechanical and worth a look:
CommentsServiceMockMixinand the request-parsing helpers only it used are deleted rather than migrated. Since the move to openedx-forum every discussion test resolves the sameregister_*names toForumMockUtilsMixin, so the HTTP mixin was dead code.mock_*context managers inlms/djangoapps/commerce/tests/mocks.pyused to enable and disable httpretty themselves. They now register on theresponsesdefault registry and expect the caller to haveresponsesactive, andexpect_calledcounts requests to the mocked endpoint rather than inspecting the global last request.reset_on_exitis gone because it only existed to work around the old nesting behaviour.@httpretty.activate: httpretty decorated every test method;responses.activateon a class wraps the class object instead and pytest silently stops collecting its tests. Those becameresponses.start()in setUp with stop and reset cleanups. The cache_programs tests had been silently dropped by an early version of this change, which is how I found out.responsesmatches a registration on scheme, host and path only. Where tests register several mocks on the same path with different query strings (pathway pages in cache_programs) they now usematchers.query_param_matcher. Where a test re-registers a path to override a setUp mock (two TestShib SAP SuccessFactors tests), it removes the setUp mock first, sinceresponsesserves the oldest registration and httpretty served the newest.responseshands back the prepared request body asstrorbytesdepending on how the client sent it, so the tests pass it tojson.loadsdirectly or go through a small bytes helper instead of calling.decode()._mock_catalog_apiin the edx_api_utils test was being handed aurlinsidehttpretty.Response, where it was ignored. It now goes to the helper, where it was meant to go.After this there are no httpretty references left in the repo outside the lockfile history.