-
Notifications
You must be signed in to change notification settings - Fork 9
test: regression tests for filehandle ref leak (GH #179) #204
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.
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
atoomic
merged 4 commits into
cpanel:master
from
atoomic:koan.atoomic/fix-179-spooky-action
Feb 26, 2026
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
b3e2921
test: add regression tests for filehandle reference leak (GH #179)
Koan-Bot f275b40
rebase: apply review feedback on #204
Koan-Bot e70f53a
rebase: apply review feedback on #204
Koan-Bot 36ea1cc
rebase: apply review feedback on #204
Koan-Bot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| #!/usr/bin/perl -w | ||
|
|
||
| # Test for GitHub issue #179: "Spooky action-at-a-distance" | ||
| # | ||
| # File check operators (-S, -f, etc.) on real (unmocked) filehandles should | ||
| # not retain references that prevent garbage collection. A leaked reference | ||
| # to a socket filehandle can keep the fd open, causing reads on the other | ||
| # end of a socketpair to hang waiting for EOF. | ||
| # | ||
| # Root cause: $_last_call_for in Overload::FileCheck stored filehandle refs. | ||
| # Fix: Only cache string filenames, not refs (Overload::FileCheck PR #25). | ||
|
|
||
| use strict; | ||
| use warnings; | ||
|
|
||
| use Test2::Bundle::Extended; | ||
| use Test2::Tools::Explain; | ||
|
|
||
| use Scalar::Util qw(weaken); | ||
| use Socket; | ||
|
|
||
| use Test::MockFile qw< nostrict >; | ||
|
|
||
| # Test 1: Filehandle passed to -f is not retained | ||
| { | ||
| my $weak_ref; | ||
|
|
||
| { | ||
| open my $fh, '<', '/dev/null' or die "Cannot open /dev/null: $!"; | ||
| $weak_ref = $fh; | ||
| weaken($weak_ref); | ||
|
|
||
| ok( defined $weak_ref, "weak ref is defined before scope exit" ); | ||
|
|
||
| no warnings; | ||
| -f $fh; | ||
| } | ||
|
|
||
| ok( !defined $weak_ref, "filehandle is garbage collected after -f (GH #179)" ); | ||
| } | ||
|
|
||
| # Test 2: Socket filehandle passed to -S is not retained | ||
| { | ||
| my $weak_ref; | ||
|
|
||
| { | ||
| open my $fh, '<', '/dev/null' or die "Cannot open /dev/null: $!"; | ||
| $weak_ref = $fh; | ||
| weaken($weak_ref); | ||
|
|
||
| no warnings; | ||
| -S $fh; | ||
| } | ||
|
|
||
| ok( !defined $weak_ref, "filehandle is garbage collected after -S (GH #179)" ); | ||
| } | ||
|
|
||
| # Test 3: The exact scenario from GH #179 — socketpair with dup'd fd | ||
| # This would hang without the fix because the dup'd write handle stays open. | ||
| { | ||
| socketpair my $r, my $w, AF_UNIX, SOCK_STREAM, 0 | ||
| or die "socketpair: $!"; | ||
|
|
||
| my $pid = fork(); | ||
| die "fork: $!" unless defined $pid; | ||
|
|
||
| if ( $pid == 0 ) { | ||
| # Child: reproduce the bug scenario with a timeout | ||
| $SIG{ALRM} = sub { exit 1 }; # exit 1 = hung (bug present) | ||
| alarm(5); | ||
|
|
||
| my $fd = fileno $w; | ||
| do { | ||
| open my $w2, "<&=", $fd; | ||
| -S $w2; | ||
| }; | ||
|
|
||
| close $w; | ||
| my $line = <$r>; # Should get EOF immediately if $w2 was freed | ||
| exit 0; # exit 0 = success (no hang) | ||
| } | ||
|
|
||
| close $w; | ||
| waitpid $pid, 0; | ||
| my $exit = $? >> 8; | ||
|
|
||
| is( $exit, 0, "socketpair read does not hang after -S on dup'd filehandle (GH #179)" ); | ||
| } | ||
|
|
||
| done_testing; | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to bump the minimal version for Overload::FileCheck to be 0.014 to make sure every users got the correct fix.