Collections Django Admin + soft delete, hard delete, and restore

[pomegranited]

Description

Adds API methods for soft-deleting, hard-deleting and restoring Collections, and a Django Admin screen to allow superusers to hard delete any soft-deleted collections.

Also adds a convenience method get_collection_components, which makes it easier for ContentLibraries to interact with collection entities.

Supporting information

Related to: openedx/modular-learning#231
Private-ref: FAL-3809

Testing instructions

1. Using the API, create a couple collections (python manage.py shell):

   from openedx_learning.authoring import api
   learning_package = api.create_learning_package("FAL-3809", "Learning package for FAL-3809")
   api.create_collection(learning_package.id, "FAL-3809-1", title="Collection 1 for FAL-3809")
   api.create_collection(learning_package.id, "FAL-3809-2", title="Collection 2 for FAL-3809")

2. View the collection in the Django Admin: (python manage.py runserver), and ensure you can:
   • toggle the collections' "enabled" flag on and off from the list view.
   • edit the collections' title and/or description.
   • delete Collection 1 using Django Admin
3. Using the API, soft-delete, restore, and delete a collection (python manage.py shell):

   from openedx_learning.authoring import api
   collection = api.get_collection("FAL-3809", "FAL-3809-2")
   assert collection.enabled
   # Soft delete
   collection = api.delete_collection("FAL-3809", "FAL-3809-2")
   assert not collection.enabled
   # Restore
   collection = api.restore_collection("FAL-3809", "FAL-3809-2")
   assert collection.enabled
   # Hard delete
   collection = api.delete_collection("FAL-3809", "FAL-3809-2", hard_delete=True)
   assert not collection.id
   

Deadline

ASAP

[openedx-webhooks]

Thanks for the pull request, @pomegranited!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @axim-engineering. Tag them in a comment and let them know that your changes are ready for review.

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.

[ChrisChV]

@pomegranited Looks good 👍

• I tested this: I followed the testing instructions
• I read through the code and considered the security, stability and performance implications of the changes.
• Includes tests for bugfixes and/or features added.
• Includes documentation
• Includes fixtures that create objects required for manual testing.