Skip to content

Fix Flakey "Wait for Item" Python Dragon Tests in MacOS CI #22

Description

@MattToast

Currently, we have tests to test for a python dragon client's ability wait for key to be set before returning a value in test_wait_for_item.py. These tests start by starting a dragon process and to set a key after a time limit and in the main process having the client wait for a key and ensuring that the time limit is within a reasonable bound.

For whatever reason, these tests seem to work consistently on Linux both locally and in the CI. They also appear to work locally on MacOS. What's interesting, however, is that these tests seem to consistently not work when run in the CI on MacOS. We're not quite sure what is causing this, but at time of writing we have decided to simply exclude the tests from the CI with the following mark.

# FIXME: For some reason these tests fail in the Github Actions MacOS runner via
# a timeout. These do pass on local MacOS environments.
skip_macos_on_github_actions = (sys.platform == "darwin") and (
os.environ.get("GITHUB_ACTIONS", "false") == "true"
)
pytestmark = pytest.mark.skipif(
skip_macos_on_github_actions,
reason="Tests currently fail on Github Actions under MacOS",
)

We should spend some time to try and dissect this issue to either run these tests in the CI or refactor these tests so that they can be run either locally or in the CI without issue.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions