test: port missing Word Cloud test coverage from openedx-platform#273
Conversation
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.
|
Thanks for the pull request, @irfanuddinahmad! 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. |
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.pyandlms/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
xblocks_contrib/word_cloud/tests/test_word_cloud.pyhere, a few scenarios only ever ran in openedx-platform and have no equivalent in this repo:test_xml_import_export_cycle)test_indexibility)block.handle(...)rather than calling the underlying method directly (test_bad_dispatch_request/test_handle_submit_state_request)submit_studio_edits), including boolean field handling fordisplay_student_percents(test_submit_studio_edits)This PR ports those scenarios into this repo's own test suite (adapted to
ToyRuntimeinstead of edx-platform'sTestModuleStoreRuntime/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 xblocks_contrib/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 regressionspylint/pycodestyleclean on the changed file