Add github workflow to launch Chromium and dump its tree on Linux

Igalia / acacia

Library for inspecting accessibility APIs

https://igalia.github.io/acacia

GNU Lesser General Public License v2.1

8 stars 1 forks source link

Add github workflow to launch Chromium and dump its tree on Linux #132

Closed elima closed 7 months ago

elima commented 8 months ago

This will supersede existing workflow because it already include building the NodeJS module on Linux.

The workflow will:

Install and launch headless chromium
Build acacia native library, examples and tests; and NodeJS module, example and tests (see #195 to understand why not Python).
Run the test suite via ctest (make test).
Dump the chromium a11y tree from native and nodejs dump_tree_atspi examples.

There is a timeout of 5 minutes for the whole workflow. We should remember to increase it if we make it more complex in the future, or if it starts to fail due to timeout.

elima commented 7 months ago

Ok, so after quite a few iterations on this, I got something that work (sometimes). There is some kind of timing issue that is being challenging to pinpoint. Depending on the ordering of the action that runs chromium compared to when AT-SPI services are launched, and when the dump tree tests are run; we get a pass or fail.

Some important findings:

For chromium to actually enable accessibility introspection, it has to be launched with a couple of environment variables assigned:

QT_ACCESSIBILITY=1            
XDG_RUNTIME_DIR=/run/user/1001

It took a fair amount of time to find this (undocumented) magic.

SWIG introduced support for unique pointers on version 4.1.0, so we have to build that version from source because version shipped with runner's system is 4.0.1.

WIP: Apart from the flakiness of the workflow, there is an issue with python bindings where SWIG complains that it can't find std_unique_ptr.i. This only happens in the runner. I'm investigating it.

elima commented 7 months ago

Ok, some more progress:

Finally I think I fixed the flakiness running dump_tree. At least I have not got any new failure in the last ~15 runs.
I found a problem with the linked libraries of the NodeJS module. In the github runner (and only in the runner), specifying the atspi library via pkgconfig --libs in bindings.gyp didn't work. I found a solution by specifying the dependency libraries in a new "libraries" section in binding.gyp.in. So that is the somewhat unrelated hunk in this patch about.
I found that Python binding doesn't build in the github runner. SWIG fails saying it can't find std_unique_ptr.i. Oddly enough, NodeJS module builds ok. I have filed #195 to track this issue. But this means that this workflow has python disabled so the chromium a11y tree is only dumped from native and nodejs dump_tree_atspi examples.

I'm opening this up for review as-is.