Only run expectrl gix-prompt tests where supported #1644
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Two important `gix-prompt` tests simulate interactivity with `expectrl`, which (non-optionally) depends on `ptyprocess`. But the only (families of) Unix-like operating systems that `ptyprocess` currently supports are Linux, FreeBSD, and macOS. The tests that used `expectrl` were previously targeted to all "unix" systems. This narrows them to systems where `target_os` is `linux`, `freebsd`, or `macos`, and conditions the `expectrl` dev dependency on those targets. This way, running the test suite no longer fails to build on other Unix-like systems. (In particular, this fixes the failure on OmniOS, an illumos system. But the problem isn't illumos-specific.)
EliahKagan
force-pushed
the
run-ci/ptyprocess-targets
branch
from
2f6ce5f to
9f7b34a
Compare
Byron
approved these changes
Oct 24, 2024
EliahKagan
commented
Oct 24, 2024
EliahKagan
added a commit
to EliahKagan/gitoxide
that referenced
this pull request
Oct 24, 2024
This is cleanup realted to GitoxideLabs#1644, which further complicated the attributes on the `#[ignore]`d `username_password_not_available` test with an empty that was build (but never run) whenever the `expectrl` tests of `gix-prompt` were not built. Instead of keeping its attributes more complicated and maintaining an expectation that they continue to be updated along with the `target_os` support for `expectrl`'s `ptyprocess` dependency, this removes that empty test. The purpose of the test case that this removes is unclear, and it may not have value anymore. It is unclear in part because actual interaction to provide a username and password is likely to work on some systems for which the related tests that use `expectrl` are not being built. But this empty test case might be read to say otherwise. See also the related discussion at: GitoxideLabs#1644 (review)
EliahKagan
added a commit
to EliahKagan/gitoxide
that referenced
this pull request
Oct 24, 2024
This is cleanup related to GitoxideLabs#1644, which further complicated the attributes on the `#[ignore]`d `username_password_not_available` test with an empty that was build (but never run) whenever the `expectrl` tests of `gix-prompt` were not built. Instead of keeping its attributes more complicated and maintaining an expectation that they continue to be updated along with the `target_os` support for `expectrl`'s `ptyprocess` dependency, this removes that empty test. The purpose of the test case that this removes is unclear, and it may not have value anymore. It is unclear in part because actual interaction to provide a username and password is likely to work on some systems for which the related tests that use `expectrl` are not being built. But this empty test case might be read to say otherwise. See also the related discussion at: GitoxideLabs#1644 (review)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Two important
gix-prompttests simulate interactivity usingexpectrl, which (non-optionally) depends onptyprocess. But the only (families of) Unix-like operating systems thatptyprocesscurrently supports are Linux, FreeBSD, and macOS.In
ptyprocesson other Unix-like systems, the call inMaster::get_slave_nameto the free-standingget_slave_namefunction fails to compile, because the latter function is not defined. This is not specific to any particular way of usingptyprocess; it occurs both when buildinggitoxide's tests and when buildingptyprocess's tests.That is from a
cargo nextest run --no-fail-fastrun ingix-prompton OmniOS, which is an illumos system. The error message shown above is from that system, as are the full details in this gist, which shows the problem on the main branch and how the build succeeds and othergix-prompttests are able to run and pass after the fix here.Please note that the problem isn't illumos-specific. Any Unix-like system that is not Linux, FreeBSD, or macOS should be expected to be affected.
The problem does not prevent
gix-promptfrom building other than for tests, because it is a dev dependency. Specifically,ptyprocessis a transitive dependency throughexpectrl, which is a dev dependency ofgix-prompt.The
gix-prompttests that usedexpectrlwere, prior to this PR, targeted to all "unix" systems. This narrows them to systems wheretarget_osislinux,freebsd, ormacos, and conditions theexpectrldev dependency on those targets. This way, running the test suite no longer fails to build on other Unix-like systems.