README

vue-cli-plugin-cypress-django

Integration testing with cypress and django.

Setup

yarn add --dev @4tw/vue-cli-plugin-cypress-django

Prerequisite

The plugin requires the cypress binary. https://www.npmjs.com/package/cypress

Usage

manage.py

The plugin is able to interact with the django server and database. Therefore it is important to provide the djangopath when executing the tests. The djangopath should be the root directory of your project. The plugin assumes to have a manage.py to interact with the django server.

database

The following database scripts need to be provided in the project root so the plugin can properly interact with the database:

bin/e2e_setup_db (create and fill database before tests are executed)
bin/e2e_reload_db (reset database for isolation)
bin/e2e_teardown_db (cleanup database)

What the script are doing is up to you but the goal they should achieve is described on the list above.

The databasename is provided during the execution as the first parameter $1.

The database can be imported and created to interact with it.

const Database = require('@4tw/vue-cli-plugin-cypress-django/database');

const database = new Database({ djangopath, DJANGO_DATABASE_NAME });

database.reset()

Resets the database.

database.drop()

Drops the database.

database.load(dataset)

Loads data during the tests. dataset is the name of the django-fixture.

Those interactions are usually done in cypress tasks: https://docs.cypress.io/api/commands/task.html#Syntax so they can be called in setup and teardown hooks:


module.exports = (on, config) => {
  on('task', {
    djangoTestSetup({ test, gever }) {
      database.reset();
    },
    loadData(dataSet) {
      return database.load(dataSet);
    },
  });
  return config;
};

django management commands

The management command load_e2e_data is required if specific data should be loaded on a 'per test' basis. The command should accept an optional parameter: --datasets.

The command has access to the BACKEND_PORT (the port on which the server is currently running). Example: os.environ.get("BACKEND_PORT", 8000).

Interactive mode

The interactive mode enables you to run the e2e tests in the cypress electron app. This is best for development because you have hot reload when the production or test code is updated. You are also able to interact with the application after the tests are done.

vue-cli-service test:django:e2e --djangopath=/path/to/django/root

Headless mode

The headless mode runs the tests in the background. This is best for running the tests in a pipeline on an integration server.

vue-cli-service test:django:e2e --djangopath=/path/to/django/root --headless

Specifying test files to run

If you want to run only selected test file(s) in headless mode instead of running all tests, specify the path of the file using --spec. This is then passed to Cypress (see https://docs.cypress.io/guides/guides/command-line.html#cypress-run-spec-lt-spec-gt).

vue-cli-service test:django:e2e --headless --spec=tests/e2e/specs/some.spec.js

Using a `.env` file

You may specify a mode, which loads a corresponding .env.[mode] file that allows you to specify environment variables.

vue-cli-service test:django:e2e --djangopath=/path/to/django/root --mode testing_e2e

Above example will look for a file called .env.testing_e2e and pick up the environment variables specified in this file.

Without runserver

By default, the backend server is started using Django's python manage.py runserver command.

If you want to prevent this and run the tests against a backend which is already running (e.g. started using uwsgi), you can set --runserver=false. In this case you need to explicitly pass the port of the backend server using the environment variable BACKEND_PORT.

vue-cli-service test:django:e2e --djangopath=/path/to/django/root --runserver=false

Environment variables

Following (optional) environment variables can be made use of:

DJANGO_E2E_DATABASE_NAME: The name of the database used by django. Defaults to E2E_TESTING_34000
DJANGO_PYTHON_PATH: The path to the python binary used by django. Defaults to 'bin/python', '.tox/py36/bin/python', 'python'
DJANGO_CONFIGURATION: The name of the django settings class. Defaults to 'TestingE2E'
DJANGO_MEDIA_ROOT: Optional: path to the django media root. Defaults to null.
BACKEND_PORT: The port used by django. Defaults to 34000
FRONTEND_PORT: The port used by vue. Defaults to 35000
CYPRESS_PORT: The port used by cypress. Defaults to 36000
HEARTBEAT_PATH: The frontend server will only start once the backend server is ready. A relative URL is requested repeatedly to check if the backend server is ready yet, using a HTTP HEAD method and waiting for a 200 or 302 status code. Defaults to /
CYPRESS_CONFIG: Override Cypress options, passed as a string as --config when running Cypress (https://docs.cypress.io/guides/references/configuration.html#Overriding-Options). Defaults to '' (baseUrl=http://localhost:[PORT2] is always passed)

Usage no npm install needed!