Skip to content

test: port missing Word Cloud test coverage from openedx-platform - #273

Open
irfanuddinahmad wants to merge 2 commits into
openedx:mainfrom
irfanuddinahmad:irfanuddinahmad/word-cloud-port-missing-tests
Open

irfanuddinahmad wants to merge 2 commits into
openedx:mainfrom
irfanuddinahmad:irfanuddinahmad/word-cloud-port-missing-tests

Conversation

@irfanuddinahmad

@irfanuddinahmad irfanuddinahmad commented Jul 6, 2026 •

Copy link
Copy Markdown
Contributor

Update (2026-11-10): Rebased onto main after #244: the file is now src/xblock_word_cloud/tests/test_word_cloud.py. A separate ruff format commit brings the ported tests in line with the repo-wide format pass from #244. 13/13 tests pass on the rebased branch.

Update (2026-11-05): openedx/openedx-platform#38745 no longer deletes the platform Word Cloud tests. Following review, both xmodule/tests/test_word_cloud.py and lms/djangoapps/courseware/tests/test_word_cloud.py are kept in openedx-platform and now run directly against the extracted WordCloudBlock (now xblock_word_cloud.WordCloudBlock). This PR is therefore additional coverage, so that regressions are caught in this repo's CI before a release, rather than a replacement for the platform tests.

The test_good_ajax_request gap from review (the pre-seeded all_words merge path) is handled in a separate follow-up PR that keeps the original test name, setup and assertions: #318

| Generated using Claude Code

Summary

In openedx/openedx-platform#38745, the built-in Word Cloud block is being removed now that it's fully extracted here. That PR deletes xmodule/tests/test_word_cloud.py and lms/djangoapps/courseware/tests/test_word_cloud.py, which currently run a shared, parametrized test suite against both the built-in and the extracted (xblocks_contrib) block via @override_settings(USE_EXTRACTED_WORD_CLOUD_BLOCK=...).

Comparing that suite to src/xblock_word_cloud/tests/test_word_cloud.py here, a few scenarios only ever ran in openedx-platform and have no equivalent in this repo:

  • OLX import/export round-trip (test_xml_import_export_cycle)
  • Search indexing content (test_indexibility)
  • Handler-dispatch-level AJAX calls, i.e. going through block.handle(...) rather than calling the underlying method directly (test_bad_dispatch_request / test_handle_submit_state_request)
  • The Studio editor Save pathway (submit_studio_edits), including boolean field handling for display_student_percents (test_submit_studio_edits)

This PR ports those scenarios into this repo's own test suite (adapted to ToyRuntime instead of edx-platform's TestModuleStoreRuntime/get_test_descriptor_system), so the coverage isn't lost once the openedx-platform copies are deleted.

Raised in response to review feedback on openedx-platform#38745:

Test plan

  • pytest src/xblock_word_cloud/tests/test_word_cloud.py -v — all 13 tests pass (8 existing + 5 new)
  • pytest xblocks_contrib — full suite passes (839 passed, 1 skipped), no regressions
  • pylint/pycodestyle clean on the changed file

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jul 6, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @irfanuddinahmad!

This repository is currently maintained by @openedx/axim-engineering.

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.

@mphilbrick211

Copy link
Copy Markdown

Hi @openedx/axim-engineering! Would someone be able to review this for us?

@kdmccormick

Copy link
Copy Markdown
Member

Hey @mphilbrick211, you can assume that this PR and any other PR on xblocks-core will be reviewed by @openedx/axim-aximprovements unless they reach out for help.

@farhan
farhan requested a review from a team August 24, 2026 10:15
@farhan farhan assigned farhan and irfanuddinahmad and unassigned farhan Aug 24, 2026
@farhan
farhan self-requested a review August 24, 2026 10:15
irfanuddinahmad added a commit to openedx/openedx-platform that referenced this pull request Nov 4, 2026
…dBlock

Per review on this PR, keep xmodule/tests/test_word_cloud.py and
lms/djangoapps/courseware/tests/test_word_cloud.py in openedx-platform
instead of deleting them. They already exercised the extracted block
(USE_EXTRACTED_WORD_CLOUD_BLOCK=True), and xblocks-core does not yet have
equivalent coverage (openedx/xblocks-core#273 is still open; the LMS
integration tests cannot move there as-is).

Only the BuiltIn variants, the toggle overrides and the built-in-only
branches are removed. Test names and assertions are unchanged, including
the pre-seeded all_words merge path in test_good_ajax_request.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Irfan Ahmad and others added 2 commits November 10, 2026 12:49
openedx-platform#38745 removes the built-in Word Cloud block and its
tests now that Word Cloud has been extracted here. Some scenarios
were only ever covered in openedx-platform's parametrized test suite
(run against both the built-in and extracted block) and had no
equivalent here: OLX import/export round-trip, search indexing,
handler-dispatch-level AJAX calls, and the submit_studio_edits Save
pathway (including boolean field handling).

Port those scenarios so this coverage isn't lost when the
openedx-platform test files are deleted.
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/word-cloud-port-missing-tests branch from ab56ee5 to 8b39046 Compare November 10, 2026 07:54
irfanuddinahmad added a commit to irfanuddinahmad/xblocks-core that referenced this pull request Nov 10, 2026
… seed and assertions

Restores the pre-seeded all_words/top_words merge path that the
handler-level port in openedx#273 (test_handle_submit_state_request) does not
assert. Name, setup and assertions match
openedx-platform xmodule/tests/test_word_cloud.py (openedx/openedx-platform#38745).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
irfanuddinahmad added a commit to openedx/openedx-platform that referenced this pull request Nov 10, 2026
…dBlock

Per review on this PR, keep xmodule/tests/test_word_cloud.py and
lms/djangoapps/courseware/tests/test_word_cloud.py in openedx-platform
instead of deleting them. They already exercised the extracted block
(USE_EXTRACTED_WORD_CLOUD_BLOCK=True), and xblocks-core does not yet have
equivalent coverage (openedx/xblocks-core#273 is still open; the LMS
integration tests cannot move there as-is).

Only the BuiltIn variants, the toggle overrides and the built-in-only
branches are removed. Test names and assertions are unchanged, including
the pre-seeded all_words merge path in test_good_ajax_request.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

5 participants