[BB-7106] Add new endpoint for cloning course

[pkulkark]

Description

This PR add a new studio endpoint for the existing clone_course method, so that external applications can call it using the following API:

/api/v1/course_runs/clone/

And passing the source_course_id (of an existing course) and destination_course_id (of a non-existing course) in the request data, like below:

{
    "source_course_id": "course-v1:edX+DemoX+Demo_Course",
    "destination_course_id": "course-v1:new+TestX+Demo_Course_Clone",
}

Supporting information

OpenCraft Internal Jira ticket: BB-7106

Testing instructions

1. Checkout this branch and provision devstack.
2. Login to studio and select a course which you want to clone. Note the course id.
3. Using a valid client ID and secret, obtain the oath access token (see ref)
4. With the access token, make a POST api call to endpoint: <your-studio-url>/api/v1/course_runs/clone/, and pass the source_course_id and destination_course_id in the data params.
5. Check your studio home and verify that the new course has been created with the destination_course_id you provided and contains the contents of the source_course_id.

[openedx-webhooks]

Thanks for the pull request, @pkulkark! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[pdpinch]

Is cloning a course the same as creating a "Re-Run Course" ?

[Cup0fCoffee]

👍

• I tested this:
  • tested on the local devstack
  • sent POST request with only source_course_id
  • sent POST request with only destination_course_id
  • sent POST request with both valid source_course_id and destination_course_id
  • sent POST request with both valid source_course_id and destination_course_id again to verify that it won't clone again
• I read through the code
• [N/A] I checked for accessibility issues

[pkulkark]

@pdpinch "re-run course" uses the clone function underneath. The difference being the course ID would remain the same. Essentially it creates a new course with the same course ID and copies over the contents. The changes here expose the function as an api endpoint and allows you to create a new course (with different course ID) and copy over the contents without having to manually export and import it.

[mphilbrick211]

Hi @pkulkark - just seeing if there's any update on this?

[mphilbrick211]

Hi @pkulkark - just seeing if there's any update on this?

Hi @pkulkark just following up on this :)

[pkulkark]

@mphilbrick211 This is ready for review. Please let me know if you need any further information from me.

[mphilbrick211]

Hi @jristau1984 - would you mind reviewing this and merging if all looks good? Thanks!

[jristau1984]

@mphilbrick211 I do not have availability to review this for at least the next several weeks.

[mphilbrick211]

Hi @pkulkark! While we wait for @jristau1984 for review, would you mind re-running the tests? We have a couple new ones that have popped up (shellcheck) that need to be run. Please let me know if you have any questions. Thanks!

[mphilbrick211]

Hi @pkulkark! While we wait for @jristau1984 for review, would you mind re-running the tests? We have a couple new ones that have popped up (shellcheck) that need to be run. Please let me know if you have any questions. Thanks!

Friendly ping on this @pkulkark :)

[pkulkark]

@mphilbrick211 Sure, Done.

[mphilbrick211]

Hi @openedx/teaching-and-learning! Is someone able to review/merge this for us? Thanks!

[mphilbrick211]

Hi @pkulkark - looks like some additional tests have popped up!

[pkulkark]

@mphilbrick211 Thanks for the ping. I rebased it to latest master and ran all the tests.

[mphilbrick211]

Thanks, @pkulkark!

@openedx/teaching-and-learning - just flagging that this is all set for review. Thanks!

[mphilbrick211]

Hi @pkulkark - please see here re: the tests that have popped up above. I think if you rebase, it should be all set.

[openedx-webhooks]

Thanks for the pull request, @pkulkark! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[pkulkark]

@mphilbrick211 Sorry for the delay. I've rebased this now and all tests are green.

[Cup0fCoffee]

@mphilbrick211 @jristau1984 The PR has been fixed and is ready for review.

[farhaanbukhsh]

@mphilbrick211 @pkulkark I can review this PR as CC :)

[Cup0fCoffee]

@farhaanbukhsh FYI, I've picked this ticket up from Pooja and am currently the assignee on the PR.

Sure, please do review this when you have the time!

[mphilbrick211]

Thank you, @farhaanbukhsh!

[Cup0fCoffee]

@farhaanbukhsh Just checking if you're still planning to review the PR?

[farhaanbukhsh]

@Cup0fCoffee Yes it's on my list :)

[farhaanbukhsh]

Hey @Cup0fCoffee @pkulkark

I have reviewed the code and read through it, this works great, Kudos on the work done here. I have a slight concern and improvement. We should probably add a docstring to the clone method because if we don't we wouldn't know the difference between clone and rerun.

If we can add the documentation then we will know how to use it and when to use it and maybe substanciate with an example.

What do you say?

PS: @Cup0fCoffee your commit also has a typo can we correct that as well?

[Cup0fCoffee]

@farhaanbukhsh Thank you for your suggestions. I fixed the typo and added docstring for the clone API endpoint.

[farhaanbukhsh]

@Cup0fCoffee can you rebase the branch please :)

[farhaanbukhsh]

👍

• ✅ I tested this on the devstack.
• ✅ I read through the code
• ❌ I checked for accessibility issues
• ✅ Includes documentation
• ❌ I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository.

[openedx-webhooks]

@pkulkark 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.