Qt Checker

Authors: Jan Kotański <jan.kotanski at desy.de>

Introduction

This is a simple helper module to perform PyQt GUI tests.

Source code: https://github.com/jkotan/qtchecker

Project Web page: https://jkotan.github.io/qtchecker

With the qtchecker module its user

1. creates QtChecker object with the global QApplication object and a given tested QWidget dialog parameters
2. defines a sequence of checks with setChecks() method and the following helper classes:

• AttrCheck - read a tested dialog attribute value
• CmdCheck - execute a tested dialog command and read its result value
• WrapAttrCheck - execute a wrapper command on a tested dialog attribute
• WrapCmdCheck - execute a wrapper command on a result value of a tested dialog command
• ExtAttrCheck - read an external attribute value defined outside the dialog
• ExtCmdCheck - execute an external command defined outside the dialog and read its result value
• AttrChange - write a dialog attribute value

3. starts event loop and performs checkes with executeChecks() or executeChecksAndClose() method
4. compare results by reading results attribute of executing

for example

import unittest

from PyQt5 import QtGui
from PyQt5 import QtCore
from PyQt5 import QtTest

from qtchecker.qtChecker import QtChecker, CmdCheck, WrapAttrCheck, ExtCmdCheck

# import my dialog module
from lavuelib import liveViewer


# QApplication object should be one for all tess
app = QtGui.QApplication([])


class GuiTest(unittest.TestCase):

    def __init__(self, methodName):
        unittest.TestCase.__init__(self, methodName)

    def test_run(self):

        # my tested MainWindow dialog
        dialog = liveViewer.MainWindow()
        dialog.show()

        # create QtChecker object
        qtck = QtChecker(app, dialog)

        # define a sequence of action of the dialog
        qtck.setChecks([
            # read return value of execute isConnected command
            CmdCheck(
                # a python path to a method executed in the first action
                "_MainWindow__lavue._LiveViewer__sourcewg.isConnected"
            ),
            # click pushButton with the left-mouse-click
            WrapAttrCheck(
                # a python path to an pushButton object
                "_MainWindow__lavue._LiveViewer__sourcewg._SourceTabWidget__sourcetabs[],0._ui.pushButton",
                # Wrapper command to be executed on the action object
                QtTest.QTest.mouseClick,
                # additional parameters of the wrapper command
                [QtCore.Qt.LeftButton]
            ),
            # read a result of external "getLAvueState" command
            ExtCmdCheck(
                # parent object of the external command
                self,
                # external command name
                "getLavueState"
            ),
        ])

        # execute the check actions and close the dialog
        status = qtck.executeChecksAndClose()
        self.assertEqual(status, 0)

        # compare results returned by each action
        qtck.compareResults(self,
            [
                # a result of isConnected() command
                True,
                # a result of the mouseClick on the pushButton
                None,
                # a result of getLavueState() command
                '{"connected": false}'
            ]
        )

   def getLavueState(self):
       """ an external command """

       import tango
       return tango.DeviceProxy("po/lavuecontroller/1").LavueState

More examples can be found at like LavueTests or LavueStateTests.

Installation

QtChecker requires the following python packages: qt4 or qt5 or pyqtgraph.

From sources

Download the latest QtChecker version from https://github.com/jkotan/qtchecker

Extract sources and run

$ python setup.py install

The setup.py script may need: setuptools sphinx python packages as well as qtbase5-dev-tools or libqt4-dev-bin.

Debian packages

Debian bookworm, bullseye and buster or Ubuntu oracular, noble, jammy packages can be found in the HDRI repository.

To install the debian packages, add the PGP repository key

$ sudo su
$ curl -s http://repos.pni-hdri.de/debian_repo.pub.gpg  | gpg --no-default-keyring --keyring gnupg-ring:/etc/apt/trusted.gpg.d/debian-hdri-repo.gpg --import
$ chmod 644 /etc/apt/trusted.gpg.d/debian-hdri-repo.gpg

and then download the corresponding source list, e.g.

$ cd /etc/apt/sources.list.d

and

$ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list

or

$ wget http://repos.pni-hdri.de/buster-pni-hdri.list

or

$ wget http://repos.pni-hdri.de/noble-pni-hdri.list

respectively.

Finally,

$ apt-get update
$ apt-get install python3-qtchecker

$ apt-get update
$ apt-get install python-qtchecker

for python 2 version.

From pip

To install it from pip you need to install pyqt5 in advance, e.g.

$ python3 -m venv myvenv
$ . myvenv/bin/activate

$ pip install pyqt5

$ pip install qtchecker