1 # Copyright (C) 2015-2019 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD :seek);
11 IO::Socket::INET->new(
12 LocalAddr => '127.0.0.1',
15 Type => Socket::SOCK_STREAM(),
22 my ($dest, %opt) = @_;
23 my $s = IO::Socket::INET->new(
25 Type => Socket::SOCK_STREAM(),
26 PeerAddr => $dest->sockhost . ':' . $dest->sockport,
33 sub require_git ($;$) {
34 my ($req, $maybe) = @_;
35 my ($req_maj, $req_min) = split(/\./, $req);
36 my ($cur_maj, $cur_min) = (`git --version` =~ /version (\d+)\.(\d+)/);
38 my $req_int = ($req_maj << 24) | ($req_min << 16);
39 my $cur_int = ($cur_maj << 24) | ($cur_min << 16);
40 if ($cur_int < $req_int) {
42 plan skip_all => "git $req+ required, have $cur_maj.$cur_min";
49 return $key if $key =~ m!\A/!;
50 # n.b. we may have scripts which don't start with "public-inbox" in
52 $key =~ s/\A([-\.])/public-inbox$1/;
56 sub _prepare_redirects ($) {
58 my @x = ([ \*STDIN, '<&' ], [ \*STDOUT, '>&' ], [ \*STDERR, '>&' ]);
59 for (my $fd = 0; $fd <= $#x; $fd++) {
60 my $fh = $fhref->[$fd] or next;
61 my ($oldfh, $mode) = @{$x[$fd]};
62 open $oldfh, $mode, $fh or die "$$oldfh $mode redirect: $!";
66 # $opt->{run_mode} (or $ENV{TEST_RUN_MODE}) allows chosing between
67 # three ways to spawn our own short-lived Perl scripts for testing:
69 # 0 - (fork|vfork) + execve, the most realistic but slowest
70 # 1 - preloading and running in a forked subprocess (fast)
71 # 2 - preloading and running in current process (slightly faster than 1)
73 # 2 is not compatible with scripts which use "exit" (which we'll try to
74 # avoid in the future).
76 our $run_script_exit_code;
77 sub RUN_SCRIPT_EXIT () { "RUN_SCRIPT_EXIT\n" };
78 sub run_script_exit (;$) {
79 $run_script_exit_code = $_[0] // 0;
86 $cached_scripts{$key} //= do {
87 my $f = key2script($key);
88 open my $fh, '<', $f or die "open $f: $!";
89 my $str = do { local $/; <$fh> };
90 my ($fc, $rest) = ($key =~ m/([a-z])([a-z0-9]+)\z/);
92 my $pkg = "PublicInbox::TestScript::$fc$rest";
98 *exit = *::run_script_exit;
110 my ($sub, $key, $argv) = @_;
111 local @ARGV = @$argv;
112 $run_script_exit_code = undef;
113 my $exit_code = eval { $sub->(@$argv) };
114 if ($@ eq RUN_SCRIPT_EXIT) {
116 $exit_code = $run_script_exit_code;
117 $? = ($exit_code << 8);
118 } elsif (defined($exit_code)) {
119 $? = ($exit_code << 8);
120 } elsif ($@) { # mimic die() behavior when uncaught
121 warn "E: eval-ed $key: $@\n";
122 $? = ($! << 8) if $!;
123 $? = (255 << 8) if $? == 0;
125 die "BUG: eval-ed $key: no exit code or \$@\n";
129 sub run_script ($;$$) {
130 my ($cmd, $env, $opt) = @_;
131 my ($key, @argv) = @$cmd;
132 my $run_mode = $ENV{TEST_RUN_MODE} // $opt->{run_mode} // 1;
133 my $sub = $run_mode == 0 ? undef : key2sub($key);
137 my $redir = $opt->{$fd};
138 next unless ref($redir);
139 open my $fh, '+>', undef or die "open: $!";
141 $spawn_opt->{$fd} = fileno($fh);
144 print $fh $$redir or die "print: $!";
145 seek($fh, 0, SEEK_SET) or die "seek: $!";
147 if ($run_mode == 0) {
148 # spawn an independent new process, like real-world use cases:
149 require PublicInbox::Spawn;
150 my $cmd = [ key2script($key), @argv ];
151 my $pid = PublicInbox::Spawn::spawn($cmd, $env, $spawn_opt);
152 defined($pid) or die "spawn: $!";
154 my $r = waitpid($pid, 0);
155 defined($r) or die "waitpid: $!";
156 $r == $pid or die "waitpid: expected $pid, got $r";
158 } else { # localize and run everything in the same process:
159 local *STDIN = *STDIN;
160 local *STDOUT = *STDOUT;
161 local *STDERR = *STDERR;
162 local %ENV = $env ? (%ENV, %$env) : %ENV;
164 _prepare_redirects($fhref);
165 _run_sub($sub, $key, \@argv);
168 # slurp the redirects back into user-supplied strings
170 my $fh = $fhref->[$fd] or next;
171 seek($fh, 0, SEEK_SET) or die "seek: $!";
172 my $redir = $opt->{$fd};
179 sub wait_for_tail () { sleep(2) }
182 my ($cmd, $env, $opt) = @_;
183 my ($key, @argv) = @$cmd;
184 my $run_mode = $ENV{TEST_RUN_MODE} // $opt->{run_mode} // 1;
185 my $sub = $run_mode == 0 ? undef : key2sub($key);
187 if (my $tail_cmd = $ENV{TAIL}) {
190 next unless /\A--std(?:err|out)=(.+)\z/;
194 defined($tail_pid = fork) or die "fork: $!\n";
195 if ($tail_pid == 0) {
196 # make sure files exist, first
197 open my $fh, '>>', $_ for @paths;
198 open(STDOUT, '>&STDERR') or die "1>&2: $!";
199 exec(split(' ', $tail_cmd), @paths);
200 die "$tail_cmd failed: $!";
205 defined(my $pid = fork) or die "fork: $!\n";
207 # pretend to be systemd (cf. sd_listen_fds(3))
208 # 3 == SD_LISTEN_FDS_START
210 for ($fd = 0; 1; $fd++) {
212 last if $fd >= 3 && !defined($s);
214 my $fl = fcntl($s, F_GETFD, 0);
215 if (($fl & FD_CLOEXEC) != FD_CLOEXEC) {
216 warn "got FD:".fileno($s)." w/o CLOEXEC\n";
218 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
219 dup2(fileno($s), $fd) or die "dup2 failed: $!\n";
221 %ENV = (%ENV, %$env) if $env;
224 $ENV{LISTEN_PID} = $$;
225 $ENV{LISTEN_FDS} = $fds;
227 $0 = join(' ', @$cmd);
229 _run_sub($sub, $key, \@argv);
230 POSIX::_exit($? >> 8);
232 exec(key2script($key), @argv);
233 die "FAIL: ",join(' ', $key, @argv), ": $!\n";
236 TestProcess->new($pid, $tail_pid);
242 # prevent new threads from inheriting these objects
246 my ($klass, $pid, $tail_pid) = @_;
247 bless { pid => $pid, tail_pid => $tail_pid, owner => $$ }, $klass;
251 my ($self, $sig) = @_;
252 CORE::kill($sig // 'TERM', $self->{pid});
257 my $pid = delete $self->{pid} or return;
258 my $ret = waitpid($pid, 0);
259 defined($ret) or die "waitpid($pid): $!";
260 $ret == $pid or die "waitpid($pid) != $ret";
265 return if $self->{owner} != $$;
266 if (my $tail = delete $self->{tail_pid}) {
268 CORE::kill('TERM', $tail);
270 my $pid = delete $self->{pid} or return;
271 CORE::kill('TERM', $pid);