Python and Node.js package providing support for Cypress and Django integration.
Issue commands to operate on the project's Cypress test database.
Expects settings/cypress.py
to exist for the Django settings and
cypress/db/setup_test_data.py
to exist to house the functions for loading
in test data (though both can be customised, see below).
This script can be used in Cypress tests to load data into the test database, as well as be run on the command line as a shortcut for various operations on the test database.
It caches the last loaded test data function and exits early if the same function is loaded again - for tests that do not alter the database, it is not necessary to reload the data, so we can save time here.
Implemented as a standalone script rather than a management command to avoid the
overhead of manage.py
when exiting early, since we want tests to be as fast as
possible.
pip install cypress-django
cypress_db [-h] [--init] [--flush] [--clearcache] [func]
positional arguments:
func Setup test data function to run
optional arguments:
-h, --help show this help message and exit
--init Initialise the database (run `migrate` and `createcachetable`)
--flush Clear all data (run `flush`)
--clearcache Delete the test data cache (use when a test will modify the database)
These are python functions that should load data into the test database as required for tests. The functions should not have any required arguments, as when they are invoked, no arguments will be passed. There is no particular restriction on what the functions can do, so it is possbile to have helper functions setup to do common setup that the exposed setup functions can call.
For example, one possible function could be to create a superuser:
def superuser():
User.objects.create_superuser(username="test", password="a")
Another function may be something like:
def make_some_objects():
# we also need a create a superuser
superuser()
# make some objects
# ...
When a new function is loaded, the database is always flushed first, so you are starting from scratch every time.
Environment variables:
CYPRESS_SETTINGS
- python module for the cypress settings (default<project_name>.settings.cypress
)
Settings:
CYPRESS_SETUP_TEST_DATA_MODULE
- python module for setup test data functions (defaultcypress.db.setup_test_data
)CYPRESS_CACHE_KEY
- cache key for tracking last setup test data function loaded (defaultcypress_last_func
)CYPRESS_CACHE_TIMEOUT
- how long theCYPRESS_CACHE_KEY
lasts before expiring in seconds (default 1 day)
Provides a login
helper function:
cy.login()
will programmatically login using theUSERNAME
andPASSWORD
environment variables defined incypress.json
(or withCYPRESS_
prefix if defined elsewhere)- Recommended way to use is to put
cy.login()
inbeforeEach
- If it is necessary to login as a different user, for example to test behaviour for users with limited permissions, simply provide the appropriate username and password as arguments
Provides a setupDB
helper function that expects the python package in this repo to be
installed:
cy.setupDB
will flush the test database and load new data according to the functionsetupFunc
- If the test will write to the database,
mutable
should be set totrue
- Otherwise set
mutable
tofalse
to allow early exit from the script if no DB setup is necessary (this means repeated test runs with such tests will be significantly faster) - The
setupFunc
argument should be the name of a function living incypress/db/setup_test_data.py
which loads whatever data necessary into the test database - this is similar to aTestCase.setUpTestData
method
Example cypress.json
:
{
"baseUrl": "http://127.0.0.1:8000",
"env": {
"USERNAME": "test",
"PASSWORD": "a"
},
"viewportHeight": 800,
"viewportWidth": 1400
}
Ensure cypress
is installed:
npm install cypress --save-dev
Install cypress-django
:
npm install cypress-django --save-dev
and include this line in cypress/support/index.js
or cypress/support/commands.js
:
import 'cypress-django/commands'