[issue-558] add test for optional feature to GitHub Action #568
Conversation
| - name: Install optional dependencies | ||
| run: python -m pip install networkx | ||
| - name: Run tests for graph generation | ||
| run: pytest tests/spdx/test_graph_generation.py |
There was a problem hiding this comment.
Can't we just install the optional dependencies together with the rest under "Installation"? Then we wouldn't need to call pytest again here.
By the way, is there a way to make sure that these tests actually are not skipped in the workflow?
There was a problem hiding this comment.
We can but I thought it would be good to test the basic installation without the optional dependencies to ensure that these tests are skipped and wouldn't cause an issue for users that don't have the optional dependencies.
Good question and good point, I will try to find out how to do this.
There was a problem hiding this comment.
One approach to enforce the execution of the tests would be to set an environment variable like PYTEST_DISALLOW_SKIP and set this in the GitHub Action. Or we could check the output of pytest if the tests were executed. As all of this seems rather complicated, I think we can postpone this issue and stick to the current GitHub Action.
There was a problem hiding this comment.
Ok, let's open an issue then to keep it in the backlog.
meretp
force-pushed
the
issue_558_fix
branch
2 times, most recently
from
0bba5ea to
90f8cdb
Compare
Signed-off-by: Meret Behrens <meret.behrens@tngtech.com>
Signed-off-by: Meret Behrens <meret.behrens@tngtech.com>
I decided to add the installation of the optional dependency and the test as additional steps to the GitHub Action so that we ensure on the one hand that the source installation is successful und all tests pass (resp. are skipped) and on the other hand also run the tests for the optional feature.
addition to #562, fixes #558
Edit: I updated the test to only be skipped if
networkxis not installed and install this package manually in the GitHub Action, as this is the only package needed for the tests.pygraphvizrequires an installation ofgraphvizon the operating system. This seems to be more involving for Windows so I decided not to add this for the moment, as this is only an optional feature.