To test new applications that you develop for the E-Commerce service, you create and run tests for the Open edX platform first, and then you run a set of tests that are specific to E-Commerce.
For more information about tests for the Open edX platform, see Test Features.
When you develop E-Commerce applications, you must run a pre-packaged set of unit tests, Python tests, and E-Commerce acceptance tests.
The E-Commerce unit tests include migrations, the unit test suite, and quality checks. You can run the full unit test, or save time for a local test by disabling the migrations. (You can also run the quality checks independent of the unit test suite.)
To run the full unit test, including migrations and quality checks, use the following command.
$ make validate
If numerous unit tests fail with an
OfflineGenerationError message, run
the following command, then try to run unit tests again.
$ DJANGO_SETTINGS_MODULE=ecommerce.settings.test make static
To run unit tests with quality checks but without migrations, run the following command.
$ DISABLE_MIGRATIONS=1 make validate
We recommend that you only run tests without migrations when you run the tests locally.
To validate code quality independently, run the following command.
$ make quality
When you create E-Commerce tests, use the
TestCase class in
ecommerce/tests/testcases.py to ensure every test has
Partner objects configured. This will help you test any code that relies on
these models, which are used for multi-tenancy.
To run a test really fast, use pytest.
$ pytest path/to/file.py::TestSuiteClass::test_name
To run all Python unit tests and quality checks, run the following command.
$ make validate_python
To run all Python unit tests and quality checks in parallel, run the following command.
$ make fast_validate_python
To run the Python unit tests in a specific file and a specific test, such as
ecommerce/courses/tests/test_utils.py, run the following command and
substitute the desired file path.
$ DISABLE_ACCEPTANCE_TESTS=True ./manage.py test ecommerce.courses.tests.test_utils:UtilsTests.test_get_course_info_from_catalog_cached --settings=ecommerce.settings.test --with-ignore-docstrings --logging-level=DEBUG
DISABLE_MIGRATIONS is broken as of June 2019.
DISABLE_MIGRATIONS variable significantly decreases the time
needed to run tests by creating the test database directly from Django model
definitions as opposed to applying the defined migrations.
$ DISABLE_MIGRATIONS=1 DISABLE_ACCEPTANCE_TESTS=True ./manage.py test ecommerce.courses.tests.test_utils:UtilsTests.test_get_course_info_from_catalog_cached --settings=ecommerce.settings.test --with-ignore-docstrings --logging-level=DEBUG
To debug when running tests using
manage.py, you may need to use the
following instead of
pdb directly, or nosetests may hang while creating
import nose.tools as nosepdb; nosepdb.set_trace()
these tests, place your tests in the
directory, and add a
_spec suffix. For example, your test name may be
$ make validate_js
To run specific acceptance tests for the E-Commerce service, you must complete the following procedures.
To configure the LMS, follow these steps.
Verify that the following settings in
lms.env.json are correct.
"ECOMMERCE_API_URL": "http://localhost:8002/api/v2/" "ECOMMERCE_PUBLIC_URL_ROOT": "http://localhost:8002/" "JWT_ISSUER": "http://127.0.0.1:8000/oauth2" // Must match the E-Commerce JWT_ISSUER setting "OAUTH_ENFORCE_SECURE": false
Verify that the following settings in
lms.auth.json are correct.
"EDX_API_KEY": "replace-me" // Must match the E-Commerce EDX_API_KEY setting "ECOMMERCE_API_SIGNING_KEY": "insecure-secret-key" // Must match the E-Commerce JWT_SECRET_KEY setting
Verify that an LMS account with staff and superuser permissions exists.
By default, most devstack and fullstack LMS instances include a user account
that has staff permissions. This account has the username
email@example.com, and the password
edx. Run the
following commands to grant the account superuser permissions.
$ ``./manage.py lms shell --settings=devstack`` >>> from django.contrib.auth.models import User >>> u = User.objects.get(username='staff') >>> u.is_superuser = True >>> u.save()
In the Django administration panel, verify that an OAuth2 client with the
following attributes exists. If one does not already exist, create a
new one. The client ID and secret must match the
values of the E-Commerce
SOCIAL_AUTH_EDX_OAUTH2_SECRET settings, respectively.
URL: http://localhost:8002/ Redirect uris: http://localhost:8002/complete/edx-oauth2/ Client id: 'replace-me' Client secret: 'replace-me' Client type: Confidentials Authorization grant type: Authorization code
In the Django administration panel, verify that the OAuth2 client referred to above is designated as a trusted client. If this isn’t already the case, add the client created above as a new trusted client.
In the Django administration panel, create a new access token for the superuser account. Set the client to the OAuth2 client referred to above. Make note of this token; it is required to run the acceptance tests.
Make sure that the LMS instance that you will use for testing has at least two courses that learners could enroll in. By default, most LMS instances include the edX demonstration course. Use Studio to create a second course.
You use the CAT to finish configuring the two courses in your LMS instance.
In your browser, go to
http://localhost:8002/courses/ to access the CAT.
In the CAT, add both of the courses present on your LMS instance to E-Commerce. Configure one as a “Free (Audit)” course, and the second as a “Verified” course.
So that you can test integration with external payment processors, update
the contents of the
PAYMENT_PROCESSOR_CONFIG dictionary found in the
settings with valid credentials. To override the default values for
development, create a private settings module,
private.py, and set
PAYMENT_PROCESSOR_CONFIG inside the module.
If you created a
private.py file to create settings overrides when you
set up your virtual environment, you
can use that same
You configure acceptance tests by using the settings in the
ecommerce/blob/master/acceptance_tests/config.py file. You can use the
default values for most settings in this file. However, you must specify values
for the following settings by using environment variables.
|ACCESS_TOKEN||The OAuth2 access token used to authenticate requests.|
|ECOMMERCE_URL_ROOT||The URL root for the E-Commerce service.|
|ECOMMERCE_TEST_WEB_SECURITY||Whether to run security tests against the E-Commerce service.|
|LMS_URL_ROOT||The URL root for the LMS.|
|LMS_USERNAME||A username for any current LMS user, to use during testing.|
|LMS_EMAIL||The email address used to sign in to the LMS.|
|LMS_PASSWORD||The password used to sign in to the LMS.|
If you test PayPal integration, you must also specify values for the following settings by using environment variables.
|PAYPAL_EMAIL||The email address used to sign in to PayPal during payment.|
|PAYPAL_PASSWORD||The password used to sign in to PayPal during payment.|
Run all acceptance tests by executing
make e2e. To run a specific test,
execute the following command.
$ nosetests -v <path/to/the/test/module>
The acceptance tests rely on the environment variables that you have configured. For example, when you run the acceptance tests against local instances of E-Commerce and the LMS, you might run the following command, replacing values between angle brackets (<>) with your own values.
$ ECOMMERCE_URL_ROOT="http://localhost:8002" LMS_URL_ROOT="http://127.0.0.1:8000" LMS_USERNAME="<username>" LMS_EMAIL="<email address>" LMS_PASSWORD="<password>" ACCESS_TOKEN="<access token>" LMS_HTTPS="False" LMS_AUTO_AUTH="True" PAYPAL_EMAIL="<email address>" PAYPAL_PASSWORD="<password>" ENABLE_CYBERSOURCE_TESTS="False" VERIFIED_COURSE_ID="<course ID>" make e2e
When you run the acceptance tests against a production-like staging environment, you might run the following command.
$ ECOMMERCE_URL_ROOT="https://ecommerce.stage.edx.org" LMS_URL_ROOT="https://courses.stage.edx.org" LMS_USERNAME="<username>" LMS_EMAIL="<email address>" LMS_PASSWORD="<password>" ACCESS_TOKEN="<access token>" LMS_HTTPS="True" LMS_AUTO_AUTH="False" PAYPAL_EMAIL="<email address>" PAYPAL_PASSWORD="<password>" BASIC_AUTH_USERNAME="<username>" BASIC_AUTH_PASSWORD="<password>" HONOR_COURSE_ID="<course ID>" VERIFIED_COURSE_ID="<course ID>" make e2e