isabella232 / qgis-server-perfsuite

QGIS Server Performance test suite

QGIS Server PerfSuite

The goal of this project is to provide a simple and convenient way to deploy an infrastructure for assessing the performance of QGIS Server.

The repo includes:

• Dockerfiles for building and executing QGIS Server 2.18, 3.10, 3.16 and Master
• A Dockerfile for PostGIS and test data
• some tests to generate a HTML report with Graffiti
• everything needed for running your own test scenarios with you own QGIS Server version!

Moreover, considering that docker-compose is used to run the tests, QGIS Server may be configured through environment variables (to activate the parallel rendering for example).

Note that if you just want to measure the performance of an already-running QGIS Server you just need to use Graffiti without the whole infrastructure.

Clone

To clone the project:

$ git clone https://qgis/QGIS-Server-Perfsuite
$ cd QGIS-Server-Perfsuite
$ ls
docker  docs  README.md  scenarios

Description of the content:

• docker: directory with Dockerfiles for QGIS Server and PostGIS (with data)
• README.md: the current file
• scenarios: docker-compose.yml and configuration files for Graffiti

Running tests

Once deployed (locally or remotely), you just have to execute the next script to run Graffiti:

$ cd scenarios
$ sh run.sh

Then the generated HTML report should be /tmp/graffiti/report.html.

Note that the data used for testing is in the scenarios/data subdirectory.

Write your own tests

The tool used to run and generate the report is Graffiti, so you should take a look at its documentation first.

Modify the current scenario

If you just want to modify or add some tests in the current infrastructure without adding/updating a QGIS Server instance, you may:

• update the scenarios.sample.yml file
• update *.html description files

Configure a QGIS Server instance

If you just want to add a QGIS Server instance with some specific configuration based on environment variables, you can take a look at the docker-compose.yml file. For example, if you want to add a QGIS Server 3.16 instance with 8 cores to test the parallel rendering:

  qgis-3.16-parallel-rendering-8-cores:
    container_name: qgisserver-perfsuite-3.16-parallel-rendering-8-cores
    image: qgisserver-perfsuite/3.16
    volumes:
      - ./data:/data
    links:
      - data
    environment:
      - QGIS_SERVER_PARALLEL_RENDERING=1
      - QGIS_SERVER_MAX_THREADS=8

Add a test with a custom project and custom data

If you want to run some tests with a custom .qgs project, you need to add your project to the scenarios/data subdirectory. Moreover, if your data is based on GeoTIFF, Shapefile, ... files, you also need to copy the date files to scenarios/data. In this way the Docker containers will be able to use them!