ecommerce icon indicating copy to clipboard operation
ecommerce copied to clipboard

feat: install extra requirements in the tox environments

Open farhaanbukhsh opened this issue 3 years ago • 4 comments

Ported From: https://github.com/openedx/ecommerce/pull/3478

This PR adds a requirements/extra.txt requirement file and configures tox to install them in its environments.

Description

Extra requirements for ecommerce specified via the ECOMMERCE_EXTRA_REQUIREMENTS ansible variable in the edx/configuration repository do not get installed in the tox environments used to run the migrations (make migrate).

This is necessary when the extra requirements are added to

INSTALLED_APPS and hence have to be installed in the tox virtualenv environments used for the various Django management commands.

This PR is related to and depends on https://github.com/openedx/configuration/pull/6489

Testing instructions

  • Add some extra requirements (for example, git+https://github.com/open-craft/ecommerce-hyperpay.git#egg=hyperpay-ecommerce) to requirements/extra.txt and add them to INSTALLED_APPS (for example, hyperpay`).
    
  • Run make migrate in as the ecommerce user in the ecommerce environment.
    
  • Verify that the specified extra requirements are installed in the tox environment and the migration command completes successfully.
    

farhaanbukhsh avatar Sep 14 '22 08:09 farhaanbukhsh

Thanks for the pull request, @farhaanbukhsh! 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.

openedx-webhooks avatar Sep 14 '22 08:09 openedx-webhooks

@farhaanbukhsh Thank you, but please note that we do not accept any new code contributions to this repo.

natabene avatar Sep 14 '22 14:09 natabene

@natabene This is not a new contribution but a port of https://github.com/openedx/ecommerce/pull/3478

farhaanbukhsh avatar Sep 18 '22 14:09 farhaanbukhsh

Ecommerce is blocked now but will assign myself for when merging opens up again, sometime mid-November.

pshiu avatar Oct 21 '22 19:10 pshiu