-
-
Notifications
You must be signed in to change notification settings - Fork 419
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Replace GabrielBB/xvfb-action #5478
Conversation
…adless-gui action
Codecov Report
@@ Coverage Diff @@
## main #5478 +/- ##
==========================================
+ Coverage 89.30% 89.32% +0.02%
==========================================
Files 600 600
Lines 51030 51010 -20
==========================================
- Hits 45570 45564 -6
+ Misses 5460 5446 -14
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this change.
After merging this, it will be nice to have similar PR to:
- https://github.com/napari/cookiecutter-napari-plugin (Switch from GabrielBB/xvfb-action to aganders3/headless-gui cookiecutter-napari-plugin#149)
- https://github.com/napari/npe2 (Switch from GabrielBB/xvfb-action to aganders3/headless-gui npe2#269)
- https://github.com/napari/docs (Switch from GabrielBB/xvfb-action to aganders3/headless-gui docs#94)
- https://github.com/napari/napari-console (Replace GabrielBB/xvfb-action with aganders3/headless-gui napari-console#26)
And maybe some other.
Let us wait if another core-dev has some objections.
looks good to me and runs well (I tested in another project)! |
# Description <!-- What does this pull request (PR) do? Why is it necessary? --> <!-- Tell us about your new content, improvement, or fix! --> <!-- If you can, please add an image, or an animation "An image is worth a thousand words!" --> <!-- You can use https://www.cockos.com/licecap/ or similar to create animations --> following main repo napari/napari#5478 ## Type of change <!-- Please delete options that are not relevant. --> - [ ] Fixes or improves existing content - [ ] Adds new content page(s) - [x] Fixes or improves workflow, documentation build or deployment # References <!-- What resources, documentation, and guides were used in the creation of this PR? --> <!-- If this is a fix or otherwise resolves an issue, reference it here with "closes #(issue)" --> ## Final checklist: - [ ] My PR is the minimum possible work for the desired functionality - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have added [alt text](https://webaim.org/techniques/alttext/) to new images included in this PR
This pull request has been mentioned on Image.sc Forum. There might be relevant details there: https://forum.image.sc/t/request-for-update-of-gui-tests-gihub-workflows-for-napari-plugins/76196/1 |
This (potentially) closes #5476 by replacing https://github.com/GabrielBB/xvfb-action with https://github.com/aganders3/headless-gui. I am also happy to move this action into the napari org if the community prefers to maintain it collectively. The purpose of this action is to run the same commands on multiple platforms (Windows, macOS, Linux) for consistency, but Linux requires a bit of extra setup: * For GUI tests we need a display server, so we run [Xvfb](https://en.wikipedia.org/wiki/Xvfb) * [Some GUI tests additionally require a window manager](https://pytest-qt.readthedocs.io/en/latest/troubleshooting.html#xvfb-assertionerror-timeouterror-when-using-waituntil-waitexposed-and-ui-events), so this runs [herbstluftwm](https://herbstluftwm.org/) (though this is configurable) Adding the WM startup in here also removes the need for the `linux_wm` test fixture added in #5208. Other options: * Put more logic into the GitHub Actions Workflow file(s) to install dependencies and modify commands for Linux * (Maybe?) put more logic into `tox.ini` and other cross-platform command runners * Use another existing action e.g. https://github.com/coactions/setup-xvfb As part of testing I also added a pre-commit hook to check GitHub Actions Workflows against a schema. I am happy to remove this or put it in a separate PR if it's muddying the scope here. ## Type of change - [x] Bug-fix/CI change # References * Prior discussions: * #5208 (comment) * #5476 * Old action currently in use: https://github.com/GabrielBB/xvfb-action * New action proposed by this PR: https://github.com/aganders3/headless-gui # How has this been tested? - [x] PR tests pass with this change in my fork
This (potentially) closes #5476 by replacing https://github.com/GabrielBB/xvfb-action with https://github.com/aganders3/headless-gui. I am also happy to move this action into the napari org if the community prefers to maintain it collectively. The purpose of this action is to run the same commands on multiple platforms (Windows, macOS, Linux) for consistency, but Linux requires a bit of extra setup: * For GUI tests we need a display server, so we run [Xvfb](https://en.wikipedia.org/wiki/Xvfb) * [Some GUI tests additionally require a window manager](https://pytest-qt.readthedocs.io/en/latest/troubleshooting.html#xvfb-assertionerror-timeouterror-when-using-waituntil-waitexposed-and-ui-events), so this runs [herbstluftwm](https://herbstluftwm.org/) (though this is configurable) Adding the WM startup in here also removes the need for the `linux_wm` test fixture added in #5208. Other options: * Put more logic into the GitHub Actions Workflow file(s) to install dependencies and modify commands for Linux * (Maybe?) put more logic into `tox.ini` and other cross-platform command runners * Use another existing action e.g. https://github.com/coactions/setup-xvfb As part of testing I also added a pre-commit hook to check GitHub Actions Workflows against a schema. I am happy to remove this or put it in a separate PR if it's muddying the scope here. ## Type of change - [x] Bug-fix/CI change # References * Prior discussions: * #5208 (comment) * #5476 * Old action currently in use: https://github.com/GabrielBB/xvfb-action * New action proposed by this PR: https://github.com/aganders3/headless-gui # How has this been tested? - [x] PR tests pass with this change in my fork
This (potentially) closes #5476 by replacing https://github.com/GabrielBB/xvfb-action with https://github.com/aganders3/headless-gui. I am also happy to move this action into the napari org if the community prefers to maintain it collectively. The purpose of this action is to run the same commands on multiple platforms (Windows, macOS, Linux) for consistency, but Linux requires a bit of extra setup: * For GUI tests we need a display server, so we run [Xvfb](https://en.wikipedia.org/wiki/Xvfb) * [Some GUI tests additionally require a window manager](https://pytest-qt.readthedocs.io/en/latest/troubleshooting.html#xvfb-assertionerror-timeouterror-when-using-waituntil-waitexposed-and-ui-events), so this runs [herbstluftwm](https://herbstluftwm.org/) (though this is configurable) Adding the WM startup in here also removes the need for the `linux_wm` test fixture added in #5208. Other options: * Put more logic into the GitHub Actions Workflow file(s) to install dependencies and modify commands for Linux * (Maybe?) put more logic into `tox.ini` and other cross-platform command runners * Use another existing action e.g. https://github.com/coactions/setup-xvfb As part of testing I also added a pre-commit hook to check GitHub Actions Workflows against a schema. I am happy to remove this or put it in a separate PR if it's muddying the scope here. ## Type of change - [x] Bug-fix/CI change # References * Prior discussions: * #5208 (comment) * #5476 * Old action currently in use: https://github.com/GabrielBB/xvfb-action * New action proposed by this PR: https://github.com/aganders3/headless-gui # How has this been tested? - [x] PR tests pass with this change in my fork
This (potentially) closes #5476 by replacing https://github.com/GabrielBB/xvfb-action with https://github.com/aganders3/headless-gui. I am also happy to move this action into the napari org if the community prefers to maintain it collectively. The purpose of this action is to run the same commands on multiple platforms (Windows, macOS, Linux) for consistency, but Linux requires a bit of extra setup: * For GUI tests we need a display server, so we run [Xvfb](https://en.wikipedia.org/wiki/Xvfb) * [Some GUI tests additionally require a window manager](https://pytest-qt.readthedocs.io/en/latest/troubleshooting.html#xvfb-assertionerror-timeouterror-when-using-waituntil-waitexposed-and-ui-events), so this runs [herbstluftwm](https://herbstluftwm.org/) (though this is configurable) Adding the WM startup in here also removes the need for the `linux_wm` test fixture added in #5208. Other options: * Put more logic into the GitHub Actions Workflow file(s) to install dependencies and modify commands for Linux * (Maybe?) put more logic into `tox.ini` and other cross-platform command runners * Use another existing action e.g. https://github.com/coactions/setup-xvfb As part of testing I also added a pre-commit hook to check GitHub Actions Workflows against a schema. I am happy to remove this or put it in a separate PR if it's muddying the scope here. ## Type of change - [x] Bug-fix/CI change # References * Prior discussions: * #5208 (comment) * #5476 * Old action currently in use: https://github.com/GabrielBB/xvfb-action * New action proposed by this PR: https://github.com/aganders3/headless-gui # How has this been tested? - [x] PR tests pass with this change in my fork
This (potentially) closes #5476 by replacing https://github.com/GabrielBB/xvfb-action with https://github.com/aganders3/headless-gui. I am also happy to move this action into the napari org if the community prefers to maintain it collectively. The purpose of this action is to run the same commands on multiple platforms (Windows, macOS, Linux) for consistency, but Linux requires a bit of extra setup: * For GUI tests we need a display server, so we run [Xvfb](https://en.wikipedia.org/wiki/Xvfb) * [Some GUI tests additionally require a window manager](https://pytest-qt.readthedocs.io/en/latest/troubleshooting.html#xvfb-assertionerror-timeouterror-when-using-waituntil-waitexposed-and-ui-events), so this runs [herbstluftwm](https://herbstluftwm.org/) (though this is configurable) Adding the WM startup in here also removes the need for the `linux_wm` test fixture added in #5208. Other options: * Put more logic into the GitHub Actions Workflow file(s) to install dependencies and modify commands for Linux * (Maybe?) put more logic into `tox.ini` and other cross-platform command runners * Use another existing action e.g. https://github.com/coactions/setup-xvfb As part of testing I also added a pre-commit hook to check GitHub Actions Workflows against a schema. I am happy to remove this or put it in a separate PR if it's muddying the scope here. ## Type of change - [x] Bug-fix/CI change # References * Prior discussions: * #5208 (comment) * #5476 * Old action currently in use: https://github.com/GabrielBB/xvfb-action * New action proposed by this PR: https://github.com/aganders3/headless-gui # How has this been tested? - [x] PR tests pass with this change in my fork
This (potentially) closes #5476 by replacing https://github.com/GabrielBB/xvfb-action with https://github.com/aganders3/headless-gui. I am also happy to move this action into the napari org if the community prefers to maintain it collectively. The purpose of this action is to run the same commands on multiple platforms (Windows, macOS, Linux) for consistency, but Linux requires a bit of extra setup: * For GUI tests we need a display server, so we run [Xvfb](https://en.wikipedia.org/wiki/Xvfb) * [Some GUI tests additionally require a window manager](https://pytest-qt.readthedocs.io/en/latest/troubleshooting.html#xvfb-assertionerror-timeouterror-when-using-waituntil-waitexposed-and-ui-events), so this runs [herbstluftwm](https://herbstluftwm.org/) (though this is configurable) Adding the WM startup in here also removes the need for the `linux_wm` test fixture added in #5208. Other options: * Put more logic into the GitHub Actions Workflow file(s) to install dependencies and modify commands for Linux * (Maybe?) put more logic into `tox.ini` and other cross-platform command runners * Use another existing action e.g. https://github.com/coactions/setup-xvfb As part of testing I also added a pre-commit hook to check GitHub Actions Workflows against a schema. I am happy to remove this or put it in a separate PR if it's muddying the scope here. ## Type of change - [x] Bug-fix/CI change # References * Prior discussions: * #5208 (comment) * #5476 * Old action currently in use: https://github.com/GabrielBB/xvfb-action * New action proposed by this PR: https://github.com/aganders3/headless-gui # How has this been tested? - [x] PR tests pass with this change in my fork
This (potentially) closes #5476 by replacing https://github.com/GabrielBB/xvfb-action with https://github.com/aganders3/headless-gui. I am also happy to move this action into the napari org if the community prefers to maintain it collectively. The purpose of this action is to run the same commands on multiple platforms (Windows, macOS, Linux) for consistency, but Linux requires a bit of extra setup: * For GUI tests we need a display server, so we run [Xvfb](https://en.wikipedia.org/wiki/Xvfb) * [Some GUI tests additionally require a window manager](https://pytest-qt.readthedocs.io/en/latest/troubleshooting.html#xvfb-assertionerror-timeouterror-when-using-waituntil-waitexposed-and-ui-events), so this runs [herbstluftwm](https://herbstluftwm.org/) (though this is configurable) Adding the WM startup in here also removes the need for the `linux_wm` test fixture added in #5208. Other options: * Put more logic into the GitHub Actions Workflow file(s) to install dependencies and modify commands for Linux * (Maybe?) put more logic into `tox.ini` and other cross-platform command runners * Use another existing action e.g. https://github.com/coactions/setup-xvfb As part of testing I also added a pre-commit hook to check GitHub Actions Workflows against a schema. I am happy to remove this or put it in a separate PR if it's muddying the scope here. ## Type of change - [x] Bug-fix/CI change # References * Prior discussions: * #5208 (comment) * #5476 * Old action currently in use: https://github.com/GabrielBB/xvfb-action * New action proposed by this PR: https://github.com/aganders3/headless-gui # How has this been tested? - [x] PR tests pass with this change in my fork
This (potentially) closes #5476 by replacing https://github.com/GabrielBB/xvfb-action with https://github.com/aganders3/headless-gui.
I am also happy to move this action into the napari org if the community prefers to maintain it collectively.
The purpose of this action is to run the same commands on multiple platforms (Windows, macOS, Linux) for consistency, but Linux requires a bit of extra setup:
Adding the WM startup in here also removes the need for the
linux_wm
test fixture added in #5208.Other options:
tox.ini
and other cross-platform command runnersAs part of testing I also added a pre-commit hook to check GitHub Actions Workflows against a schema. I am happy to remove this or put it in a separate PR if it's muddying the scope here.
Type of change
References
How has this been tested?