Docker

You can setup a local instance of LimeSurvey with Docker Compose:

docker compose up -d

Now you can access LimeSurvey at port 8001.

Other LimeSurvey versions

By default, citric is tested against the latest 6-apache tag of LimeSurvey. If you want to use a different tag, you can specify it using the LS_IMAGE_TAG environment variable.

export LS_IMAGE_TAG=6.0.7+230515-apache
docker compose up -d

Integration tests

Docker Compose allows you to run integration tests against a local instance of LimeSurvey. First you’ll need to setup the environment variables:

export BACKEND=postgres
export LS_URL=http://localhost:8001
export LS_USER=iamadmin
export LS_PASSWORD=secret

Then you can run the tests with Nox:

nox -rs integration

Tip

You can use the --force-python option to run the tests on a different Python version from the default one (3.12).

Run integration tests on a specific LimeSurvey version

export LS_IMAGE_TAG='6.0.7+230515-apache'

docker-compose -d

nox -rs integration

Run integration tests against an unreleased LimeSurvey version

export DOCKER_BUILDKIT=0
export LS_ARCHIVE_URL=https://github.com/LimeSurvey/LimeSurvey/archive/f148781ec57fd1a02e5faa26a7465d78c9ab5dfe.tar.gz
export LS_CHECKSUM=64aec410738b55c51045ac15373e2bc376e67cd6e20938d759c4596837ef6154

docker compose \
    -f docker-compose.yml \
    -f docker-compose.ref.yml up \
    -d

nox -rs integration

Where LS_ARCHIVE_URL is the GitHub source code archive URL, which can reference a tag, a branch, or a commit. LS_CHECKSUM is the SHA256 checksum of the .tar.gz archive of the project at that ref.

Tip

You can obtain the checksum by running:

wget $LS_ARCHIVE_URL -O limesurvey.tar.gz
shasum -a 256 limesurvey.tar.gz

To test against such a version in CI, add the following to the test matrix in the integration job:

- python-version: "3.11"
  ref: "f148781ec57fd1a02e5faa26a7465d78c9ab5dfe"
  context: https://github.com/martialblog/docker-limesurvey.git#master:6.0/apache
  database: postgres