QGISLibrary

A Robot Framework library that provides reusable keywords for QGIS UI Automation and Testing

Installation

Install via pip:

pip install QGISLibrary

Features

• Automate QGIS UI actions using section *** Tasks *** in robot file
• Test QGIS UI behaviours using section *** Test Cases *** in robot file
• Generate HTML report of task/test execution
• Capture screenshots and logs
• Supported OS: Windows (PyWinAuto, PyAutoGUI), Linux and MacOS not yet supported

Example of Robot Framework file

qgis_sample.robot

*** Settings ***
Documentation     This is an example QGIS Robot Framework file
Suite Setup       Set Metadata From Variables
Suite Teardown    Log    End of Suite
Metadata          Author    Michal Pilarski
Metadata          Version    1.0.0
Metadata          Environment    TEST
Metadata          QGIS Version    3.40.7-Bratislava
Library           QGISLibrary
Library           Screenshot

*** Variables ***
${QGIS_FILEPATH}    C:\\Program Files\\QGIS 4.0.3\\bin\\qgis-bin.exe
${QGIS_PROFILE}    default

*** Tasks ***
QGIS Init Task
    [Documentation]    Sample of QGIS Init Task
    [Tags]    dev    qgis
    [Setup]    Log    Start Task
    [Teardown]    Log    End Task
    Start Qgis    ${QGIS_FILEPATH}    ${QGIS_PROFILE}
#    Connect Qgis    ${QGIS_FILEPATH}
    ${MAIN_WINDOW}    Main Window
    ${OPEN_PROJECT_BUTTON}    Get Locator By Args    ${MAIN_WINDOW}    title=Otwórz…    control_type=Button
    Mouse Left Click Locator    ${OPEN_PROJECT_BUTTON}    1
    Take Screenshot    qgis_screenshot.jpg
#    Kill Qgis

*** Keywords ***
Set Metadata From Variables
    [Documentation]    Set Suite Metadata
    Set Suite Metadata    QGIS FILEPATH    ${QGIS_FILEPATH}
    Set Suite Metadata    QGIS PROFILE    ${QGIS_PROFILE}

Usage

• Run command via terminal

robot qgis_sample.robot

• For help run via terminal

robot --help

• Open HTML Reports: report.html or log.html

QGIS UI Locators

• Use Inspect.exe or UISpy.exe (located on: QGISLibrary on GitLab) to detect UI locators

Robot Framework Editor

• Use RIDE to edit .robot files:
• Run command via terminal

pip install robotframework-ride
ride

Links

QGIS Documenation

Robot Framework Documentation

QGISLibrary Documentation