Skip to content

Speed up test suite with early-return polling and parallel execution #98

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.

Sign up for GitHub

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

Merged
dakra merged 1 commit into from
Apr 13, 2026
Merged

Speed up test suite with early-return polling and parallel execution #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,48 @@ jobs:
with:
name: ghostel-module-${{ matrix.platform }}
path: ghostel-module${{ matrix.suffix }}

test-native:
needs: build-native
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-latest
platform: x86_64-linux
suffix: .so
emacs_version: '29.4'
- os: ubuntu-latest
platform: x86_64-linux
suffix: .so
emacs_version: 'snapshot'
- os: macos-latest
platform: aarch64-macos
suffix: .dylib
emacs_version: '29.4'
- os: macos-latest
platform: aarch64-macos
suffix: .dylib
emacs_version: 'snapshot'
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: purcell/setup-emacs@master
with:
version: ${{ matrix.emacs_version }}

- name: Install zsh
if: runner.os == 'Linux'
run: sudo apt-get install -y zsh

- name: Download native module
uses: actions/download-artifact@v4
with:
name: ghostel-module-${{ matrix.platform }}

- name: Run native module tests
run: |
emacs --batch -Q -L . \
-l ert \
-l test/ghostel-test.el \
-f ghostel-test-run-native
8 changes: 5 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ EVIL_DIR ?= $(XDG_CACHE_HOME)/evil

ELC := ghostel.elc ghostel-debug.elc

.PHONY: all build test test-all test-evil lint melpazoid byte-compile bench bench-quick clean
.PHONY: all build test test-native test-all test-evil lint melpazoid byte-compile bench bench-quick clean

all: build test-all test-evil lint

Expand All @@ -23,8 +23,10 @@ build:
test: $(ELC)
$(EMACS) --batch -Q -L . -l ert -l test/ghostel-test.el -f ghostel-test-run-elisp

test-all: build $(ELC)
$(EMACS) --batch -Q -L . -l ert -l test/ghostel-test.el -f ghostel-test-run
test-native: build $(ELC)
$(EMACS) --batch -Q -L . -l ert -l test/ghostel-test.el -f ghostel-test-run-native

test-all: test test-native

test-evil:
@if [ ! -d "$(EVIL_DIR)" ]; then \
Expand Down
74 changes: 55 additions & 19 deletions test/ghostel-test.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,24 @@
(cons (string-to-number (match-string 1 info))
(string-to-number (match-string 2 info))))))

(defun ghostel-test--wait-for (proc pred &optional timeout)
"Poll PROC until PRED returns non-nil, or TIMEOUT seconds (default 5).
Signal an ERT failure if TIMEOUT is reached or PROC exits before PRED
succeeds."
(let* ((timeout (or timeout 5))
(deadline (+ (float-time) timeout))
result)
(while (and (not (setq result (funcall pred)))
(< (float-time) deadline)
(process-live-p proc))
(accept-process-output proc 0.05))
(unless result
(ert-fail
(if (process-live-p proc)
(format "Timed out after %.1fs waiting for predicate" timeout)
(format "Process %s exited before predicate succeeded" (process-name proc)))))
result))

;; -----------------------------------------------------------------------
;; Test: terminal creation
;; -----------------------------------------------------------------------
Expand Down Expand Up @@ -372,13 +390,18 @@ scrolling libghostty's viewport."
(set-process-window-size proc 5 80)
(set-process-query-on-exit-flag proc nil)
;; Wait for shell init
(dotimes (_ 30) (accept-process-output proc 0.2))
(ghostel-test--wait-for proc
(lambda () ghostel--pending-output) 10)
(ghostel--flush-pending-output)
(let ((inhibit-read-only t)) (ghostel--redraw ghostel--term t))
;; Generate scrollback
(dotimes (i 15)
(process-send-string proc (format "echo clear-test-%d\n" i)))
(dotimes (_ 20) (accept-process-output proc 0.2))
(ghostel-test--wait-for proc
(lambda ()
(cl-some (lambda (s) (string-match-p "clear-test-14" s))
ghostel--pending-output))
10)
;; Do NOT manually flush — let ghostel-clear handle it
(should (> (length ghostel--pending-output) 0)) ; pending output exists
;; Clear screen
Expand Down Expand Up @@ -715,23 +738,30 @@ than the full terminal `cols'."
(set-process-window-size proc 25 80)
(set-process-query-on-exit-flag proc nil)
;; Wait for shell init
(dotimes (_ 30) (accept-process-output proc 0.2))
(ghostel-test--wait-for proc
(lambda () (not (equal "" (ghostel--debug-state ghostel--term)))) 10)
(should (process-live-p proc)) ; shell process alive

;; Run a command
(process-send-string proc "echo GHOSTEL_TEST_OK\n")
(dotimes (_ 10) (accept-process-output proc 0.2))
(ghostel-test--wait-for proc
(lambda () (string-match-p "GHOSTEL_TEST_OK"
(ghostel--debug-state ghostel--term))))
(let ((state (ghostel--debug-state ghostel--term)))
(should (string-match-p "GHOSTEL_TEST_OK" state))) ; command output visible

;; Test typing + backspace via PTY echo
(process-send-string proc "abc")
(dotimes (_ 5) (accept-process-output proc 0.2))
(ghostel-test--wait-for proc
(lambda () (string-match-p "abc"
(ghostel--debug-state ghostel--term))))
(let ((state (ghostel--debug-state ghostel--term)))
(should (string-match-p "abc" state))) ; typed text visible

(process-send-string proc "\x7f")
(dotimes (_ 5) (accept-process-output proc 0.2))
(ghostel-test--wait-for proc
(lambda () (not (string-match-p "abc"
(ghostel--debug-state ghostel--term)))))
(let ((state (ghostel--debug-state ghostel--term)))
(should (string-match-p "ab" state)) ; backspace removed char
(should-not (string-match-p "abc" state))) ; no abc after BS
Expand Down Expand Up @@ -830,18 +860,23 @@ Mirrors the real zsh case where the directory still contains a
(set-process-window-size proc 25 80)
(set-process-query-on-exit-flag proc nil)
;; Wait for fish init (may need longer for DA query handshake)
(dotimes (_ 50) (accept-process-output proc 0.2))
(ghostel-test--wait-for proc
(lambda () (not (equal "" (ghostel--debug-state ghostel--term)))) 10)
(should (process-live-p proc))

;; Type "abc" then backspace
(process-send-string proc "abc")
(dotimes (_ 10) (accept-process-output proc 0.2))
(ghostel-test--wait-for proc
(lambda () (string-match-p "abc"
(ghostel--debug-state ghostel--term))))
(let ((state (ghostel--debug-state ghostel--term)))
(should (string-match-p "abc" state)))

;; Send backspace (\x7f) and verify it works
(process-send-string proc "\x7f")
(dotimes (_ 10) (accept-process-output proc 0.2))
(ghostel-test--wait-for proc
(lambda () (not (string-match-p "abc"
(ghostel--debug-state ghostel--term)))))
(ghostel--flush-pending-output)
(let ((state (ghostel--debug-state ghostel--term)))
(should (string-match-p "ab" state))
Expand Down Expand Up @@ -2685,12 +2720,7 @@ ncurses apps like htop at start-up size and breaks live resize."

;;; SIGWINCH delivery tests — verify the PTY actually sends the signal

(defun ghostel-test--sigwinch-wait-for (proc pred timeout)
"Wait up to TIMEOUT seconds for PRED to become non-nil on PROC output."
(let ((deadline (+ (float-time) timeout)))
(while (and (not (funcall pred))
(< (float-time) deadline))
(accept-process-output proc 0.05))))
;; Uses ghostel-test--wait-for defined at the top of this file.

(defconst ghostel-test--bash (executable-find "bash")
"Absolute path to bash, or nil if not found.
Expand Down Expand Up @@ -2731,7 +2761,7 @@ is broken on this system."
;; adjust-window-size-function returns a (width . height).
(set-process-window-size proc 30 120)
;; Wait up to 2 seconds for trap to fire.
(ghostel-test--sigwinch-wait-for
(ghostel-test--wait-for
proc (lambda () (string-match-p "__WINCH__" output)) 2.0)
(should (string-match-p "__WINCH__" output)))
(when (and proc (process-live-p proc))
Expand Down Expand Up @@ -2770,7 +2800,7 @@ printf '\\033[H\\033[2J'; exec %s"
(sleep-for 0.3)
(setq output "")
(set-process-window-size proc 30 120)
(ghostel-test--sigwinch-wait-for
(ghostel-test--wait-for
proc (lambda () (string-match-p "__WINCH__" output)) 2.0)
(should (string-match-p "__WINCH__" output)))
(when (and proc (process-live-p proc))
Expand Down Expand Up @@ -2826,7 +2856,7 @@ while :; do sleep 0.1; done'\n")
;; Emacs calls set-process-window-size with the returned size.
(should (equal size (cons 120 30)))
(set-process-window-size proc (cdr size) (car size))))))
(ghostel-test--sigwinch-wait-for
(ghostel-test--wait-for
proc (lambda () (string-match-p "__CHILD_WINCH__" output)) 2.0)
(should (string-match-p "__CHILD_WINCH__" output)))
(when (and proc (process-live-p proc))
Expand Down Expand Up @@ -2869,7 +2899,7 @@ foreground process group."
while :; do sleep 0.1; done'\n")
(sleep-for 0.5)
(set-process-window-size proc 30 120)
(ghostel-test--sigwinch-wait-for
(ghostel-test--wait-for
proc (lambda () (string-match-p "__CHILD_WINCH__" output)) 2.0)
(should (string-match-p "__CHILD_WINCH__" output)))
(when (and proc (process-live-p proc))
Expand Down Expand Up @@ -2949,6 +2979,12 @@ while :; do sleep 0.1; done'\n")
(ert-run-tests-batch-and-exit
`(member ,@ghostel-test--elisp-tests)))

(defun ghostel-test-run-native ()
"Run only tests that require the native module."
(ert-run-tests-batch-and-exit
`(and "^ghostel-test-"
(not (member ,@ghostel-test--elisp-tests)))))

(defun ghostel-test-run ()
"Run all ghostel tests."
(ert-run-tests-batch-and-exit "^ghostel-test-"))
Expand Down
Loading