Setup for github actions on linux, macos, and windows

[hakonhagland]

Hi, should we add some up-to-date information in the docs about how to use this module from GitHub actions with xvfb or QT_QPA_PLATFORM=offscreen ? It might be useful for newcomers. I have created two minimal examples. The first example tested the following combination:

• https://github.com/tlambert03/setup-qt-libs
• https://github.com/aganders3/headless-gui
• https://pypi.org/project/pytest-xvfb/

here: https://github.com/hakonhagland/pytest-xvfb-test/tree/xvfb3, github actions logs: https://github.com/hakonhagland/pytest-xvfb-test/actions/runs/5632618698, and works fine. The second test uses the following combination:

• sets environment variable QT_QPA_PLATFORM=offscreen
• uses: https://github.com/tlambert03/setup-qt-libs to install extra libs on linux

it also seems to work fine: source: https://github.com/hakonhagland/pytest-xvfb-test/tree/offscreen, github actions logs: https://github.com/hakonhagland/pytest-xvfb-test/actions/runs/5632807241

I tried some of the advice in the docs: https://pytest-qt.readthedocs.io/en/latest/troubleshooting.html but was unsuccessful to get the correct combination. Then I found the actions https://github.com/tlambert03/setup-qt-libs (also mentioned in the docs) and https://github.com/aganders3/headless-gui which worked fine.

[nicoddemus]

Hi @hakonhagland,

Indeed some updated docs would be a great contribution!

[hakonhagland]

Indeed some updated docs would be a great contribution!

Hi @nicoddemus, yes! I am going on a summer holiday now, but will have a look at this when I come back!

[Tasty213]

Hi, many thanks, @hakonhagland, for the demo links. I finally got my CI to work with pytest-qt. It would be great if this were in the docs!

Example run
Current setup

[pdelboca]

Hello! Thanks for all the demos and examples.

Running the documentation's Github Action didn't work for me:

E   ImportError: libEGL.so.1: cannot open shared object file: No such file or directory

Following @Tasty213 example I was able to get it running by just copying his example run. Looks like running https://github.com/tlambert03/setup-qt-libs instals libegl1 that is missing from official docs.

[The-Compiler]

I don't follow regarding

It would be great if this were in the docs!

and

instals libegl1 that is missing from official docs.

as both are already mentioned in the docs?

[pdelboca]

@The-Compiler your are right, libegl1 is mentioned in the docs (my bad), however the working Github Action config snippet is missing that dependency and therefore does not work. So it might be worth updating it?