Running tests

Instructions on how to run all existence tests.

E2E tests

Initial steps:

  1. Run CVAT instance:
    docker-compose \
              -f docker-compose.yml \
              -f \
              -f components/serverless/docker-compose.serverless.yml \
              -f tests/docker-compose.minio.yml \
              -f tests/docker-compose.file_share.yml up -d
  2. Add test user in CVAT:
    docker exec -i cvat_server \
              /bin/bash -c \
              "echo \"from django.contrib.auth.models import User; User.objects.create_superuser('admin', '', '12qwaszx')\" | python3 ~/ shell"
  3. Install npm dependencies:
    cd tests
    yarn --frozen-lockfile

Running tests

yarn run cypress:run:chrome
yarn run cypress:run:chrome:canvas3d

REST API, SDK and CLI tests

Initial steps

  1. Follow this guide to prepare cvat-sdk and cvat-cli source code
  2. Install all necessary requirements before running REST API tests:
    pip install -r ./tests/python/requirements.txt
    pip install -e ./cvat-sdk
    pip install -e ./cvat-cli
  3. Stop any other CVAT containers which you run previously. They keep ports which are used by containers for the testing system.

Running tests

Run all REST API tests:

pytest ./tests/python

This command will automatically start all necessary docker containers.

If you want to start/stop these containers without running tests use special options for it:

pytest ./tests/python --start-services
pytest ./tests/python --stop-services

If you need to rebuild your CVAT images add --rebuild option:

pytest ./tests/python --rebuild


Currently, this is only supported in docker-compose-based deployments, which should be enough to fix errors arising in REST API tests.

To debug a server deployed with Docker, you need to do the following:

Rebuild the images and start the test containers:

CVAT_DEBUG_ENABLED=yes pytest --rebuild --start-services tests/python

Now, you can use VS Code tasks to attach to the running server containers. To attach to a container, run one of the following tasks:

  • REST API tests: Attach to server for the server container
  • REST API tests: Attach to RQ low for the low priority queue worker
  • REST API tests: Attach to RQ default for the default priority queue worker

If you have a custom development environment setup, you need to adjust host-remote path mappings in the .vscode/launch.json:

"pathMappings": [
      "localRoot": "${workspaceFolder}/my_venv",
      "remoteRoot": "/opt/venv",
      "localRoot": "/some/other/path",
      "remoteRoot": "/some/container/path",

Extra options:

  • If you want the server to wait for a debugger on startup, use the CVAT_DEBUG_WAIT_CLIENT environment variable:
    CVAT_DEBUG_WAIT_CLIENT=yes pytest ...
  • If you want to change the default debugging ports, check the *_DEBUG_PORT variables in the

Unit tests

Initial steps

  1. Install necessary Python dependencies:
    pip install -r cvat/requirements/testing.txt
  2. Install npm dependencies:
    yarn --frozen-lockfile
  3. Run CVAT instance
    docker-compose -f docker-compose.yml -f up -d

Running tests

  1. Python tests
    python test --settings cvat.settings.testing cvat/apps
  2. JS tests
    cd cvat-core
    yarn run test

IAM and Open Policy Agent tests

Generate tests

python cvat/apps/iam/rules/tests/ \
   --output-dir cvat/apps/iam/rules/

Run testing

  • In a Docker container
docker run --rm -v ${PWD}/cvat/apps/iam/rules:/rules \
   openpolicyagent/opa:0.34.2-rootless \
   test /rules -v
  • or execute OPA directly
curl -L -o opa
chmod +x ./opa
./opa test cvat/apps/iam/rules