Skip to content

fix: Fix unit tests failing with release branch env variable#38497

Merged
wgu-taylor-payne merged 3 commits intoopenedx:masterfrom
mgwozdz-unicon:fix-unit-tests-failing-for-release-branch
May 1, 2026
Merged

fix: Fix unit tests failing with release branch env variable#38497
wgu-taylor-payne merged 3 commits intoopenedx:masterfrom
mgwozdz-unicon:fix-unit-tests-failing-for-release-branch

Conversation

@mgwozdz-unicon
Copy link
Copy Markdown
Contributor

Description

My Verawood PR has unit tests failing on what appears to be an unrelated environment variable issue:

FAILED lms/djangoapps/mfe_config_api/tests/test_views.py::MFEConfigTestCase::test_legacy_overrides_instructor_dashboard - AssertionError: 'https://docs.openedx.org/en/open-release-verawood.master/educators/index.html' != 'https://docs.openedx.org/en/latest/educators/index.html'
- https://docs.openedx.org/en/open-release-verawood.master/educators/index.html
?                             ^^ ---------------------  --
+ https://docs.openedx.org/en/latest/educators/index.html
?                             ^^^
FAILED lms/djangoapps/mfe_config_api/tests/test_views.py::FrontendSiteConfigTestCase::test_legacy_overrides_instructor_dashboard_support_url - AssertionError: 'https://docs.openedx.org/en/open-release-verawood.master/educators/index.html' != 'https://docs.openedx.org/en/latest/educators/index.html'
- https://docs.openedx.org/en/open-release-verawood.master/educators/index.html
?                             ^^ ---------------------  --
+ https://docs.openedx.org/en/latest/educators/index.html
?                             ^^^

Supporting information

This is blocking getting #38495 into the Verawood release.

Testing instructions

python -m pytest lms/djangoapps/mfe_config_api/tests/test_views.py

Deadline

This is blocking getting #38495 into the Verawood release.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 30, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @mgwozdz-unicon!

This repository is currently maintained by @openedx/wg-maintenance-openedx-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.

Details
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.

Copy link
Copy Markdown
Contributor

@wgu-taylor-payne wgu-taylor-payne left a comment

Choose a reason for hiding this comment

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

The fix makes sense — the hardcoded "latest" breaks on release branches where doc_version() returns "open-release-verawood.master".

How the URL is constructed

The SUPPORT_URL flows through four layers:

  1. View layerviews.py: get_legacy_config_overrides() calls resolve_help_token("instructor")HelpUrlExpert.the_one().url_for_token("instructor")
  2. help-tokens libraryurl_for_token() reads help_tokens.ini (instructor = course_author:index.html), looks up HELP_TOKENS_BOOKS["course_author"], then replaces /latest with /{version}
  3. Settingscommon.py: HELP_TOKENS_VERSION = Derived(lambda settings: doc_version())
  4. Release inforelease.py: doc_version() returns "latest" on master, "open-release-{RELEASE_LINE}.master" on release branches

See inline suggestion for a slightly more precise alternative approach.

Review assisted by Kiro

Comment thread lms/djangoapps/mfe_config_api/tests/test_views.py Outdated
Copy link
Copy Markdown
Contributor

@wgu-taylor-payne wgu-taylor-payne left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for this! Do you plan to make a backport PR for this @mgwozdz-unicon?

@wgu-taylor-payne wgu-taylor-payne enabled auto-merge (squash) May 1, 2026 00:34
@wgu-taylor-payne wgu-taylor-payne merged commit d327dd3 into openedx:master May 1, 2026
41 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions May 1, 2026
@feanil
Copy link
Copy Markdown
Contributor

feanil commented May 1, 2026

Backport PR for verawood: #38503

feanil pushed a commit that referenced this pull request May 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants