Skip to content

[FC-0099] feat: enhance enforcement command#106

Merged
mariajgrimaldi merged 10 commits intoopenedx:mainfrom
eduNEXT:bav/enhance-enforcement-command
Oct 23, 2025
Merged

[FC-0099] feat: enhance enforcement command#106
mariajgrimaldi merged 10 commits intoopenedx:mainfrom
eduNEXT:bav/enhance-enforcement-command

Conversation

@BryanttV
Copy link
Copy Markdown
Contributor

@BryanttV BryanttV commented Oct 20, 2025

Description

This PR enhances the enforcement command to allow it to be used in two different ways:

  1. Database mode (default): Uses AuthzEnforcer with policies from the database.
  2. File mode: Uses a custom Casbin enforcer with policies and model from files. Activated when --policy-file-path or -p and --model-file-path or -m are provided, and reads policies directly from the specified file.

How to Test

Using Tutor:

  1. Install this plugin with the changes in this PR.
  2. Run the migrations by running tutor dev exec lms python manage.py lms migrate
  3. Load the default policies by running tutor dev exec lms python manage.py lms load_policies

Example usage

Use policies from the database with the default model and AuthzEnforcer:

python manage.py lms enforcement

Use custom model and policy files with default Casbin Enforcer:

python manage.py lms enforcement -m /path/to/model.conf -p /path/to/policy.csv

Example test input

Database mode

image

File mode

image

Merge Checklist

Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@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 Oct 20, 2025
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Oct 20, 2025

Thanks for the pull request, @BryanttV!

This repository is currently maintained by @openedx/committers-openedx-authz.

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Oct 20, 2025
@BryanttV BryanttV changed the title feat: enhance enforcement command [FC-0099] feat: enhance enforcement command Oct 21, 2025
@BryanttV BryanttV marked this pull request as ready for review October 21, 2025 14:37
@BryanttV BryanttV force-pushed the bav/enhance-enforcement-command branch from cd8c743 to 62e119a Compare October 21, 2025 23:10
@BryanttV BryanttV force-pushed the bav/enhance-enforcement-command branch from 62e119a to eac6cbd Compare October 22, 2025 15:44
@MaferMazu MaferMazu moved this to Ready for testing in RBAC AuthZ Board Oct 22, 2025
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 22, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Oct 22, 2025
Copy link
Copy Markdown
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

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

I'll merge this once you update the unreleased changelog :)

@BryanttV BryanttV force-pushed the bav/enhance-enforcement-command branch from 5ceeb62 to 89dd526 Compare October 23, 2025 14:45
@BryanttV
Copy link
Copy Markdown
Contributor Author

@mariajgrimaldi, unreleased changelog updated!

@mariajgrimaldi mariajgrimaldi merged commit 8298d3e into openedx:main Oct 23, 2025
14 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for review to Done in RBAC AuthZ Board Oct 23, 2025
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Oct 23, 2025
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). FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project
Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants