feat: Management command to generate a CSV report of xblocks used in all courses or specific courses

[ChrisChV]

Description

• Add a management command for generating a csv report of xblocks used in courses.
• Which edX user roles will this change impact? "Operator".

Usage (with common management command help removed for clarity):

$ python manage.py lms xblock_list_csv --help
...
usage: manage.py xblock_list_csv [-h] [--exclude-core-xblocks] [--version] [-v {0,1,2,3}] [--settings SETTINGS] [--pythonpath PYTHONPATH] [--traceback] [--no-color]
                                 [--force-color] [--skip-checks]
                                 filename

Generate a CSV file with all published components used in courses with their xblock type.

positional arguments:
  filename              Path to the CSV output file. Use '-' to print to stdout.

options:
  -h, --help            show this help message and exit
  --exclude-core-xblocks
                        Exclude components using core XBlocks: (html, problem, video). Default: false
  --courses COURSE_ID [COURSE_ID ...]
                        Filter the report by one or more course IDs
...

Supporting information

Internal ticket: https://tasks.opencraft.com/browse/BB-10607

Testing instructions

• Ensure there is a range of published course content across at least two courses on the devstack
• Start an lms shell: tutor dev exec lms -- bash
• Run python manage.py lms xblock_list_csv -
• Cerify the csv data is printed to the console
• Run python manage.py lms xblock_list_csv components.csv
• Cerify the csv data is saved to components.csv
• Run python manage.py lms xblock_list_csv - > components-stdout.csv
• Run diff components.csv components-stdout.csv and verify the diff is empty (to verify printing to stdout has the same report as writing to file)
• Verify components.csv contains rows as expected - check that all courses are included and the data makes sense
• Run python manage.py lms xblock_list_csv --exclude-core-xblocks components-excluded.csv
• In components-excluded.csv, verify there are no rows for the core xblocks (html, problem, video)
• Run python manage.py lms xblock_list_csv components-filtered.csv --courses <COURSE_ID_1> <COURSE_ID_2>
• In components-filtered.csv verify that the rows are only for the selected courses.

Deadline

None

Other information

N/A

[openedx-webhooks]

Thanks for the pull request, @ChrisChV!

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.

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:

• 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.