Skip to content

Edx platform 35175 deprecate assert dict contains subset #36236

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Mar 25, 2025
Merged

Edx platform 35175 deprecate assert dict contains subset #36236

merged 5 commits into from
Mar 25, 2025
+1 −1

Conversation

leoaulasneo98
Copy link
Contributor

Description
Replace the deprecated assertDictContainsSubset method in test_course_runs.py with assertEqual. This change is necessary as assertDictContainsSubset was deprecated in Python 3.2 and removed in Python 3.11.
This change impacts the "Developer" role only, as it's a modification to the test suite.
Before:
self.assertDictContainsSubset({'team': ['Course team user does not exist']}, response.data)
After:
self.assertEqual(response.data.get('team'), ['Course team user does not exist'])
Supporting information

Related Python issue: python/cpython#28268
The change aligns with Python's deprecation of assertDictContainsSubset

Testing instructions

Navigate to the edx-platform directory
Run the specific test:
pytest cms/djangoapps/api/v1/tests/test_views/test_course_runs.py::CourseRunViewSetTests::test_create_with_invalid_course_team -v
Verify the test passes

Deadline
None - This is a maintenance update to support Python 3.11 compatibility.
Other information

This change is part of the ongoing effort to maintain Python 3.11 compatibility
No database migrations are required
No special concerns or limitations
No dependencies on other changes
Screenshot 2025-02-10 at 10 28 02 AM

@leoaulasneo98 leoaulasneo98 requested a review from a team as a code owner February 10, 2025 14:28
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 10, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 10, 2025 •
edited
Loading

Thanks for the pull request, @leoaulasneo98!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@mphilbrick211 mphilbrick211 added needs test run Author's first PR to this repository, awaiting test authorization from Axim and removed needs test run Author's first PR to this repository, awaiting test authorization from Axim labels Feb 11, 2025
@mphilbrick211
Copy link

Hi @leoaulasneo98! Can you try re-running the checks? Hopefully the CLA check should turn green.

@mphilbrick211 mphilbrick211 moved this from Waiting on Author to Ready for Review in Contributions Mar 3, 2025
@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Mar 3, 2025
angonz and others added 3 commits March 5, 2025 12:45
@angonz @leoaulasneo98
fix: Redirect non-enterprise SAML to authn MFE
e95fa03 
The original request was that enterprise users with tpa hint and SAML should not be redirected to MFE. The current condition also excludes regular non-enterprise users with SAML authentication from the MFE.
@angonz @leoaulasneo98
fix: Redirect non-enterprise SAML to authn MFE
b0d6144 
The original request was that enterprise users with tpa hint and SAML should not be redirected to MFE. The current condition also excludes regular non-enterprise users with SAML authentication from the MFE.
@leoaulasneo98
fix: replace deprecated assertDictContainsSubset with assertEqual
c9f7ccc 
The assertDictContainsSubset method was deprecated in version 3.2 and
removed in version 3.11. Updated test_create_with_invalid_course_team
to use assertEqual with dict.get() instead.
@leoaulasneo98 leoaulasneo98 force-pushed the EDX-PLATFORM-35175-deprecate-assertDictContainsSubset branch from e07667c to c9f7ccc Compare March 5, 2025 16:45
awais786
awais786 reviewed Mar 17, 2025
View reviewed changes
openedx/core/djangoapps/user_authn/views/login_form.py Outdated
not enterprise_customer and \
not tpa_hint_provider and \
not saml_provider:
if should_redirect_to_authn_microfrontend() and not \
Copy link
Contributor

Choose a reason for hiding this comment

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

This PR seems to only update the assertDictContainsSubset assertion. What is the purpose of this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi Awais, nice to meet you. This line was part of another PR that was already merged into open edx. I just updated the branch, and it no longer appears as a change. The PR is a single-line fix.

@AhtishamShahid AhtishamShahid self-requested a review March 17, 2025 09:34
@awais786 awais786 merged commit 1dfe43a into openedx:master Mar 25, 2025
49 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Mar 25, 2025
@openedx-webhooks openedx-webhooks removed the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Mar 25, 2025
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

leoaulasneo98 added a commit to aulasneo/edx-platform that referenced this pull request Mar 26, 2025
@leoaulasneo98
Edx platform 35175 deprecate assert dict contains subset (openedx#36236)
7cd50cc 
* fix: replace deprecated assertDictContainsSubset with assertEqual
tonybusa pushed a commit to tonybusa/edx-platform that referenced this pull request Apr 23, 2025
@leoaulasneo98 @tonybusa
Edx platform 35175 deprecate assert dict contains subset (openedx#36236)
27626a4 
* fix: replace deprecated assertDictContainsSubset with assertEqual
UsamaSadiq pushed a commit that referenced this pull request May 14, 2025
@leoaulasneo98 @UsamaSadiq
Edx platform 35175 deprecate assert dict contains subset (#36236)
e9f2bb6 
* fix: replace deprecated assertDictContainsSubset with assertEqual
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@awais786 awais786 awais786 approved these changes

@AhtishamShahid AhtishamShahid AhtishamShahid approved these changes

@muhammadadeeltajamul muhammadadeeltajamul Awaiting requested review from muhammadadeeltajamul

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@leoaulasneo98 @openedx-webhooks @mphilbrick211 @edx-pipeline-bot @awais786 @AhtishamShahid @angonz