Flaky test: test_capture_pane_flags[join_wrapped_numbers] matches marker in command echo

Open Beginner friendly
#654 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Quiet
Tech stack
python
Domain
testing-qa

Research direction

Start with test_capture_pane_flags[join_wrapped_numbers] and the command_complete() check shown in the issue. Reproduce the intermittent failure, ensure the marker is detected only from command output rather than the shell command echo, and run the named test to confirm it passes reliably.

Written by the indexing model from the issue text.

Description

Bug

test_capture_pane_flags[join_wrapped_numbers] fails intermittently because the completion marker is detected in the shell command echo line before the command actually executes.

Root cause

The command_complete() check uses:

def command_complete() -> bool:
    output = "\n".join(pane.capture_pane())
    return marker in output

This matches the marker string inside the prompt echo ($ printf ... echo "__DONE_join_wrapped_numbers__") — a false positive. The shell echoes the full command before executing it, so the marker appears in the pane buffer before seq produces any output.

Expected behavior

The marker should only be detected when it appears as command output (its own line), not as part of the typed command echo.

Fix

Change the check to skip lines that start with the shell prompt ($):

def command_complete() -> bool:
    lines = pane.capture_pane()
    return any(marker in line and not line.lstrip().startswith("$") for line in lines)

Reproduction

The failure is timing-dependent. On fast systems seq completes before the next capture, masking the bug. On slower systems or CI, the race is more visible.

Dominant language
Python
Stars
1.2k
Forks
127
Avg merge
2h 13m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tmux-python/libtmux

All issues in tmux-python/libtmux

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.