1 # Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # internal APIs used only for tests
5 package PublicInbox::TestCommon;
7 use parent qw(Exporter);
9 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD :seek);
12 our @EXPORT = qw(tmpdir tcp_server tcp_connect require_git require_mods
13 run_script start_script key2sub xsys xqx eml_load tick);
17 open(my $fh, '<', $path) or die "open $path: $!";
18 require PublicInbox::Eml;
19 PublicInbox::Eml->new(\(do { local $/; <$fh> }));
25 unless (defined $base) {
26 ($base) = ($0 =~ m!\b([^/]+)\.[^\.]+\z!);
28 my $tmpdir = File::Temp->newdir("pi-$base-$$-XXXXXX", TMPDIR => 1);
29 ($tmpdir->dirname, $tmpdir);
33 IO::Socket::INET->new(
34 LocalAddr => '127.0.0.1',
37 Type => Socket::SOCK_STREAM(),
40 ) or Test::More::BAIL_OUT("failed to create TCP server: $!");
44 my ($dest, %opt) = @_;
45 my $addr = $dest->sockhost . ':' . $dest->sockport;
46 my $s = IO::Socket::INET->new(
48 Type => Socket::SOCK_STREAM(),
51 ) or Test::More::BAIL_OUT("failed to connect to $addr: $!");
56 sub require_git ($;$) {
57 my ($req, $maybe) = @_;
58 my ($req_maj, $req_min, $req_sub) = split(/\./, $req);
59 my ($cur_maj, $cur_min, $cur_sub) = (xqx([qw(git --version)])
60 =~ /version (\d+)\.(\d+)(?:\.(\d+))?/);
62 my $req_int = ($req_maj << 24) | ($req_min << 16) | ($req_sub // 0);
63 my $cur_int = ($cur_maj << 24) | ($cur_min << 16) | ($cur_sub // 0);
64 if ($cur_int < $req_int) {
66 Test::More::plan(skip_all =>
67 "git $req+ required, have $cur_maj.$cur_min.$cur_sub");
74 my $maybe = pop @mods if $mods[-1] =~ /\A[0-9]+\z/;
76 while (my $mod = shift(@mods)) {
77 if ($mod eq 'Search::Xapian') {
78 if (eval { require PublicInbox::Search } &&
79 PublicInbox::Search::load_xapian()) {
82 } elsif ($mod eq 'Search::Xapian::WritableDatabase') {
83 if (eval { require PublicInbox::SearchIdx } &&
84 PublicInbox::SearchIdx::load_xapian_writable()){
87 } elsif (index($mod, '||') >= 0) { # "Foo||Bar"
89 for my $m (split(/\Q||\E/, $mod)) {
101 } elsif ($mod eq 'IO::Socket::SSL' &&
102 # old versions of IO::Socket::SSL aren't supported
103 # by libnet, at least:
104 # https://rt.cpan.org/Ticket/Display.html?id=100529
105 !eval{ IO::Socket::SSL->VERSION(2.007); 1 }) {
110 my $m = join(', ', @need)." missing for $0";
111 Test::More::skip($m, $maybe) if $maybe;
112 Test::More::plan(skip_all => $m)
117 return $key if ($key eq 'git' || index($key, '/') >= 0);
118 # n.b. we may have scripts which don't start with "public-inbox" in
120 $key =~ s/\A([-\.])/public-inbox$1/;
124 my @io_mode = ([ *STDIN{IO}, '<&' ], [ *STDOUT{IO}, '>&' ],
125 [ *STDERR{IO}, '>&' ]);
127 sub _prepare_redirects ($) {
130 for (my $fd = 0; $fd <= $#io_mode; $fd++) {
131 my $fh = $fhref->[$fd] or next;
132 my ($oldfh, $mode) = @{$io_mode[$fd]};
133 open my $orig, $mode, $oldfh or die "$$oldfh $mode stash: $!";
134 $orig_io->[$fd] = $orig;
135 open $oldfh, $mode, $fh or die "$$oldfh $mode redirect: $!";
140 sub _undo_redirects ($) {
142 for (my $fd = 0; $fd <= $#io_mode; $fd++) {
143 my $fh = $orig_io->[$fd] or next;
144 my ($oldfh, $mode) = @{$io_mode[$fd]};
145 open $oldfh, $mode, $fh or die "$$oldfh $mode redirect: $!";
149 # $opt->{run_mode} (or $ENV{TEST_RUN_MODE}) allows choosing between
150 # three ways to spawn our own short-lived Perl scripts for testing:
152 # 0 - (fork|vfork) + execve, the most realistic but slowest
153 # 1 - (not currently implemented)
154 # 2 - preloading and running in current process (slightly faster than 1)
156 # 2 is not compatible with scripts which use "exit" (which we'll try to
157 # avoid in the future).
159 our $run_script_exit_code;
160 sub RUN_SCRIPT_EXIT () { "RUN_SCRIPT_EXIT\n" };
161 sub run_script_exit (;$) {
162 $run_script_exit_code = $_[0] // 0;
169 $cached_scripts{$key} //= do {
170 my $f = key2script($key);
171 open my $fh, '<', $f or die "open $f: $!";
172 my $str = do { local $/; <$fh> };
173 my $pkg = (split(m!/!, $f))[-1];
174 $pkg =~ s/([a-z])([a-z0-9]+)(\.t)?\z/\U$1\E$2/;
177 $pkg = "PublicInbox::TestScript::$pkg";
183 *exit = *PublicInbox::TestCommon::run_script_exit;
185 # the below "line" directive is a magic comment, see perlsyn(1) manpage
197 my ($sub, $key, $argv) = @_;
198 local @ARGV = @$argv;
199 $run_script_exit_code = undef;
200 my $exit_code = eval { $sub->(@$argv) };
201 if ($@ eq RUN_SCRIPT_EXIT) {
203 $exit_code = $run_script_exit_code;
204 $? = ($exit_code << 8);
205 } elsif (defined($exit_code)) {
206 $? = ($exit_code << 8);
207 } elsif ($@) { # mimic die() behavior when uncaught
208 warn "E: eval-ed $key: $@\n";
209 $? = ($! << 8) if $!;
210 $? = (255 << 8) if $? == 0;
212 die "BUG: eval-ed $key: no exit code or \$@\n";
216 sub run_script ($;$$) {
217 my ($cmd, $env, $opt) = @_;
218 my ($key, @argv) = @$cmd;
219 my $run_mode = $ENV{TEST_RUN_MODE} // $opt->{run_mode} // 1;
220 my $sub = $run_mode == 0 ? undef : key2sub($key);
224 my $redir = $opt->{$fd};
225 my $ref = ref($redir);
226 if ($ref eq 'SCALAR') {
227 open my $fh, '+>', undef or die "open: $!";
229 $spawn_opt->{$fd} = $fh;
232 print $fh $$redir or die "print: $!";
233 seek($fh, 0, SEEK_SET) or die "seek: $!";
234 } elsif ($ref eq 'GLOB') {
235 $spawn_opt->{$fd} = $fhref->[$fd] = $redir;
237 die "unable to deal with $ref $redir";
240 if ($run_mode == 0) {
241 # spawn an independent new process, like real-world use cases:
242 require PublicInbox::Spawn;
243 my $cmd = [ key2script($key), @argv ];
244 my $pid = PublicInbox::Spawn::spawn($cmd, $env, $spawn_opt);
246 my $r = waitpid($pid, 0);
247 defined($r) or die "waitpid: $!";
248 $r == $pid or die "waitpid: expected $pid, got $r";
250 } else { # localize and run everything in the same process:
251 # note: "local *STDIN = *STDIN;" and so forth did not work in
252 # old versions of perl
253 local %ENV = $env ? (%ENV, %$env) : %ENV;
255 local $0 = join(' ', @$cmd);
256 my $orig_io = _prepare_redirects($fhref);
257 _run_sub($sub, $key, \@argv);
258 _undo_redirects($orig_io);
261 # slurp the redirects back into user-supplied strings
263 my $fh = $fhref->[$fd] or next;
264 seek($fh, 0, SEEK_SET) or die "seek: $!";
265 my $redir = $opt->{$fd};
273 my $tick = shift // 0.1;
274 select undef, undef, undef, $tick;
278 sub wait_for_tail ($;$) {
279 my ($tail_pid, $stop) = @_;
281 if ($^O eq 'linux') { # GNU tail may use inotify
282 state $tail_has_inotify;
283 return tick if $stop && $tail_has_inotify;
284 my $end = time + $wait;
288 readlink($_) =~ /\binotify\b/
289 } glob("/proc/$tail_pid/fd/*");
290 } while (!@ino && time <= $end and tick);
292 $tail_has_inotify = 1;
293 $ino[0] =~ s!/fd/!/fdinfo/!;
296 if (open my $fh, '<', $ino[0]) {
298 @info = grep(/^inotify wd:/, <$fh>);
300 } while (scalar(@info) < 2 && time <= $end and tick);
306 # like system() built-in, but uses spawn() for env/rdr + vfork
308 my ($cmd, $env, $rdr) = @_;
316 run_script($cmd, $env, { %$rdr, run_mode => 0 });
320 # like `backtick` or qx{} op, but uses spawn() for env/rdr + vfork
322 my ($cmd, $env, $rdr) = @_;
324 run_script($cmd, $env, { %$rdr, run_mode => 0, 1 => \(my $out) });
325 wantarray ? split(/^/m, $out) : $out;
329 my ($cmd, $env, $opt) = @_;
330 my ($key, @argv) = @$cmd;
331 my $run_mode = $ENV{TEST_RUN_MODE} // $opt->{run_mode} // 2;
332 my $sub = $run_mode == 0 ? undef : key2sub($key);
334 if (my $tail_cmd = $ENV{TAIL}) {
337 next unless /\A--std(?:err|out)=(.+)\z/;
341 defined($tail_pid = fork) or die "fork: $!\n";
342 if ($tail_pid == 0) {
343 # make sure files exist, first
344 open my $fh, '>>', $_ for @paths;
345 open(STDOUT, '>&STDERR') or die "1>&2: $!";
346 exec(split(' ', $tail_cmd), @paths);
347 die "$tail_cmd failed: $!";
349 wait_for_tail($tail_pid);
352 defined(my $pid = fork) or die "fork: $!\n";
354 eval { PublicInbox::DS->Reset };
355 # pretend to be systemd (cf. sd_listen_fds(3))
356 # 3 == SD_LISTEN_FDS_START
358 for ($fd = 0; 1; $fd++) {
360 last if $fd >= 3 && !defined($s);
362 my $fl = fcntl($s, F_GETFD, 0);
363 if (($fl & FD_CLOEXEC) != FD_CLOEXEC) {
364 warn "got FD:".fileno($s)." w/o CLOEXEC\n";
366 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
367 dup2(fileno($s), $fd) or die "dup2 failed: $!\n";
369 %ENV = (%ENV, %$env) if $env;
372 $ENV{LISTEN_PID} = $$;
373 $ENV{LISTEN_FDS} = $fds;
375 $0 = join(' ', @$cmd);
377 eval { PublicInbox::DS->Reset };
378 _run_sub($sub, $key, \@argv);
379 POSIX::_exit($? >> 8);
381 exec(key2script($key), @argv);
382 die "FAIL: ",join(' ', $key, @argv), ": $!\n";
385 PublicInboxTestProcess->new($pid, $tail_pid);
388 package PublicInboxTestProcess;
391 # prevent new threads from inheriting these objects
395 my ($klass, $pid, $tail_pid) = @_;
396 bless { pid => $pid, tail_pid => $tail_pid, owner => $$ }, $klass;
400 my ($self, $sig) = @_;
401 CORE::kill($sig // 'TERM', $self->{pid});
405 my ($self, $sig) = @_;
406 my $pid = delete $self->{pid} or return;
407 CORE::kill($sig, $pid) if defined $sig;
408 my $ret = waitpid($pid, 0);
409 defined($ret) or die "waitpid($pid): $!";
410 $ret == $pid or die "waitpid($pid) != $ret";
415 return if $self->{owner} != $$;
416 if (my $tail_pid = delete $self->{tail_pid}) {
417 PublicInbox::TestCommon::wait_for_tail($tail_pid, 1);
418 CORE::kill('TERM', $tail_pid);
423 package PublicInbox::TestCommon::InboxWakeup;
425 sub on_inbox_unlock { ${$_[0]}->($_[1]) }