🚀 RocketPilot

Cross-platform tool for functional GUI testing of Qt applications based on Canonical Autopilot project.

Installation

Ubuntu

sudo apt-get install python3 python3-pyqt5 -y
sudo apt-get install libxpathselect-dev -y
sudo apt-get install libdbus-1-dev libdbus-glib-1-dev -y

virtualenv --system-site-packages -p python3 .venv

source .venv/bin/activate

pip install -e . 

macOS

WARNING: Do NOT install Qt from brew, use the official Qt version instead (https://www.qt.io/download-open-source).

brew install python3 pkgconfig dbus dbus-glib
brew services start dbus

python3 -m venv --system-site-packages ~/.venv

source ~/.venv/bin/activate

pip install -e . 

Helpful link about dbus installation and troubleshooting on macOS https://github.com/zbentley/dbus-osx-examples/blob/master/installation/README.md

Apple Silicone

Ensure that LD_LIBRARY_PATH contains path to libdbus, for example /opt/homebrew/Cellar/dbus/1.12.20/lib

Windows

1. Install Python 3.9 amd64, Qt5 (https://www.qt.io/download-open-source)
2. Install Msys2 to C:\msys64 & update core packages
3. Install dbus:

pacman -S mingw64/mingw-w64-x86_64-dbus

4. Update C:\msys64\mingw64\share\dbus-1\session.conf :

<listen>tcp:host=localhost,port=54321,family=ipv4</listen>

5. Add C:\msys64\mingw64\bin to PATH
6. Add DBUS_SESSION_BUS_ADDRESS env variable with value tcp:host=localhost,port=54321,family=ipv4
7. Run dbus-daemon.exe --session
8. Download & unpack pre-compiled dbus-python package to Python 3.9 amd64 installation directory
9. Verify that dbus-python package is installed correctly:

C:\Python39-x64>python
>>> import os
>>> os.add_dll_directory("C:/msys64/mingw64/bin")
>>> import dbus.mainloop.glib
>>> # No errors should appear here

Introspect application

1. Build rocketpilot-driver https://github.com/uglide/rocketpilot-driver/blob/master/README.md
2. Install PyQt5
3. Run vis tool

   rocketpilot-vis APPNAME