[carlos-marquez-wgu]

Description

Tutor plugin to load Authorization schemas contributed through the openedx-authz-schema patch.

Most of it is the output of cookiecutter, leaving it as is for future tutor related changes regarding openedx-authz

Prerequisites

Make sure you have an up to date version of openedx-authz (minimum v1.34.0), as this plugin depends on the availability of the management command load_authz_schema and the PR openedx/openedx-authz#534

Testing instructions

1. Clone this repo / branch
2. Install tutor-contrib-authz plugin

pip installl -e plugins/tutor-contrib-authz

3. Enable it

tutor plugins enable authz

4. Create a tutor patch to contribute to the authz schema

touch $(tutor config printroot)-plugins/my_authz_schema.py

5. Add the schema contents to my_authz_schema.py

from tutor import hooks

hooks.Filters.ENV_PATCHES.add_item(
    (
        "openedx-authz-schema",
        """
schema_version: "1.0"
priority: 100

role_extensions:
- role_id: course_editor
  add_permissions:
    - courses.export_course
  remove_permissions:
    - courses.manage_tags
  display_name: Course author
  description: Creates and exports course content for this site.
        """,
    )
)

6. Enable your patch

tutor plugins enable my_authz_schema

7. Either run do init tasks or run the load_authz_schema management command directly

tutor dev do init

8. With the management command

tutor dev run cms ./manage.py cms load_authz_schema

9. Console should output the newly applied schema:

Authz schema apply: added 1 p row(s), removed 1 p row(s).

Changes to apply:

Casbin policies (2)
  + p, role^course_editor, act^courses.export_course, course-v1^*, allow
  - p, role^course_editor, act^courses.manage_tags, course-v1^*, allow

Definitions (3)
  ~ role: course_editor
  + role-permission: course_editor -> courses.export_course @ course-v1
  - role-permission: course_editor -> courses.manage_tags @ course-v1

Authz schema applied: 1 Casbin policy row(s) added, 1 removed; definition changes: 1 role, 2 role-permission.

10. To roll back the schema changes: disable the patch and run the management command again

tutor plugins disable my_authz_schema
tutor dev run cms ./manage.py cms load_authz_schema

Concerns

PR Depends on this other PR: openedx/openedx-authz#534, do not merge before the PR at openedx-authz is merged

Closes: openedx/openedx-authz#461

[openedx-webhooks]

Thanks for the pull request, @carlos-marquez-wgu!

This repository is currently maintained by @arbrandes.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[carlos-marquez-wgu]

Approach changed (openedx/openedx-authz#519 (comment)), closing this PR as is not needed anymore