Skip to content

feat: add generate exception certificates modal#38547

Draft
wgu-jesse-stewart wants to merge 4 commits intoopenedx:masterfrom
WGU-Open-edX:wgu-jesse-stewart/inst-dashboard-certificates-exceptions
Draft

feat: add generate exception certificates modal#38547
wgu-jesse-stewart wants to merge 4 commits intoopenedx:masterfrom
WGU-Open-edX:wgu-jesse-stewart/inst-dashboard-certificates-exceptions

Conversation

@wgu-jesse-stewart
Copy link
Copy Markdown
Contributor

@wgu-jesse-stewart wgu-jesse-stewart commented May 5, 2026

Description

Adds comprehensive test coverage for the certificate regeneration API's student set filtering contract between the API layer and task layer.

This PR introduces RegenerateCertificatesViewTest, a new test class with three tests that verify the exact calling contract between RegenerateCertificatesView (API v2) and task_api.generate_certificates_for_students. These tests prevent silent failures if either layer is renamed independently.

User Impact: None. This is a test-only change with no functional modifications.

Context: During code review, a naming asymmetry was flagged between how different student_set values are handled:

  • 'allowlisted' → translated to 'all_allowlisted' (legacy compatibility)
  • 'allowlisted_not_generated' → passed through unchanged (modern native value)
  • 'all' → omitted entirely (default behavior)

While the existing code is correct, there were no tests pinning this contract. These tests serve as both documentation and regression prevention.

Changes

Added RegenerateCertificatesViewTest to lms/djangoapps/instructor/tests/test_api_v2.py with three test methods:

  1. test_allowlisted_not_generated_passes_correct_student_set
    Verifies that student_set='allowlisted_not_generated' is passed to the task layer without translation.

  2. test_allowlisted_translates_to_all_allowlisted
    Verifies that student_set='allowlisted' is translated to 'all_allowlisted' for backward compatibility with the pre-allowlist "whitelist" naming era.

  3. test_all_students_omits_student_set_kwarg
    Verifies that student_set='all' results in calling the task layer with no student_set kwarg, preserving the default "generate for all enrolled students" behavior.

Supporting information

  • Jira: [Link to ticket if applicable]
  • Context: This addresses defensive testing feedback from code review
  • Related: Part of the instructor API v2 certificate management feature set

Testing instructions

Run the new test class:

pytest lms/djangoapps/instructor/tests/test_api_v2.py::RegenerateCertificatesViewTest -v

All three tests should pass and verify:

  1. Mock assertions on task_api.generate_certificates_for_students
  2. Correct positional and keyword arguments for each student set variant
  3. No regressions in the API ↔ task layer contract

Deadline

None

Other information

Naming asymmetry explanation

The intentional asymmetry in student_set handling exists because:

  • 'all_allowlisted' is a legacy value from the pre-allowlist "whitelist" naming era. The API layer accepts the modern term 'allowlisted' and translates it for backward compatibility with the task layer.
  • 'allowlisted_not_generated' is a native value that the task layer was updated to accept directly without translation.

This asymmetry is now documented and locked in by tests, preventing future drift between the API and task layers.

Dependencies

  • No external dependencies
  • No database migrations
  • No configuration changes required
  • Safe to merge independently

Code archaeology notes

For future maintainers: If you're renaming student_set values, these tests will fail loudly rather than allowing silent misbehavior. Update both the view logic AND the tests together, ensuring the contract remains explicit.

@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 May 5, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @wgu-jesse-stewart!

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


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.

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: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants