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);
8 use Fcntl qw(FD_CLOEXEC F_SETFD F_GETFD :seek);
11 our @EXPORT = qw(tmpdir tcp_server tcp_connect require_git require_mods
12 run_script start_script key2sub xsys xqx mime_load eml_load);
16 open(my $fh, '<', $path) or die "open $path: $!";
17 # test should've called: require_mods('Email::MIME')
18 require PublicInbox::MIME;
19 PublicInbox::MIME->new(\(do { local $/; <$fh> }));
24 open(my $fh, '<', $path) or die "open $path: $!";
25 require PublicInbox::Eml;
26 PublicInbox::Eml->new(\(do { local $/; <$fh> }));
32 unless (defined $base) {
33 ($base) = ($0 =~ m!\b([^/]+)\.[^\.]+\z!);
35 my $tmpdir = File::Temp->newdir("pi-$base-$$-XXXXXX", TMPDIR => 1);
36 ($tmpdir->dirname, $tmpdir);
40 IO::Socket::INET->new(
41 LocalAddr => '127.0.0.1',
44 Type => Socket::SOCK_STREAM(),
51 my ($dest, %opt) = @_;
52 my $s = IO::Socket::INET->new(
54 Type => Socket::SOCK_STREAM(),
55 PeerAddr => $dest->sockhost . ':' . $dest->sockport,
62 sub require_git ($;$) {
63 my ($req, $maybe) = @_;
64 my ($req_maj, $req_min) = split(/\./, $req);
65 my ($cur_maj, $cur_min) = (`git --version` =~ /version (\d+)\.(\d+)/);
67 my $req_int = ($req_maj << 24) | ($req_min << 16);
68 my $cur_int = ($cur_maj << 24) | ($cur_min << 16);
69 if ($cur_int < $req_int) {
71 Test::More::plan(skip_all =>
72 "git $req+ required, have $cur_maj.$cur_min");
79 my $maybe = pop @mods if $mods[-1] =~ /\A[0-9]+\z/;
82 if ($mod eq 'Search::Xapian') {
83 if (eval { require PublicInbox::Search } &&
84 PublicInbox::Search::load_xapian()) {
87 } elsif ($mod eq 'Search::Xapian::WritableDatabase') {
88 if (eval { require PublicInbox::SearchIdx } &&
89 PublicInbox::SearchIdx::load_xapian_writable()){
95 push @need, $mod if $@;
98 my $m = join(', ', @need)." missing for $0";
99 Test::More::skip($m, $maybe) if $maybe;
100 Test::More::plan(skip_all => $m)
105 return $key if ($key eq 'git' || index($key, '/') >= 0);
106 # n.b. we may have scripts which don't start with "public-inbox" in
108 $key =~ s/\A([-\.])/public-inbox$1/;
112 my @io_mode = ([ *STDIN{IO}, '<&' ], [ *STDOUT{IO}, '>&' ],
113 [ *STDERR{IO}, '>&' ]);
115 sub _prepare_redirects ($) {
118 for (my $fd = 0; $fd <= $#io_mode; $fd++) {
119 my $fh = $fhref->[$fd] or next;
120 my ($oldfh, $mode) = @{$io_mode[$fd]};
121 open my $orig, $mode, $oldfh or die "$$oldfh $mode stash: $!";
122 $orig_io->[$fd] = $orig;
123 open $oldfh, $mode, $fh or die "$$oldfh $mode redirect: $!";
128 sub _undo_redirects ($) {
130 for (my $fd = 0; $fd <= $#io_mode; $fd++) {
131 my $fh = $orig_io->[$fd] or next;
132 my ($oldfh, $mode) = @{$io_mode[$fd]};
133 open $oldfh, $mode, $fh or die "$$oldfh $mode redirect: $!";
137 # $opt->{run_mode} (or $ENV{TEST_RUN_MODE}) allows choosing between
138 # three ways to spawn our own short-lived Perl scripts for testing:
140 # 0 - (fork|vfork) + execve, the most realistic but slowest
141 # 1 - (not currently implemented)
142 # 2 - preloading and running in current process (slightly faster than 1)
144 # 2 is not compatible with scripts which use "exit" (which we'll try to
145 # avoid in the future).
147 our $run_script_exit_code;
148 sub RUN_SCRIPT_EXIT () { "RUN_SCRIPT_EXIT\n" };
149 sub run_script_exit (;$) {
150 $run_script_exit_code = $_[0] // 0;
157 $cached_scripts{$key} //= do {
158 my $f = key2script($key);
159 open my $fh, '<', $f or die "open $f: $!";
160 my $str = do { local $/; <$fh> };
161 my $pkg = (split(m!/!, $f))[-1];
162 $pkg =~ s/([a-z])([a-z0-9]+)(\.t)?\z/\U$1\E$2/;
165 $pkg = "PublicInbox::TestScript::$pkg";
171 *exit = *PublicInbox::TestCommon::run_script_exit;
173 # the below "line" directive is a magic comment, see perlsyn(1) manpage
185 my ($sub, $key, $argv) = @_;
186 local @ARGV = @$argv;
187 $run_script_exit_code = undef;
188 my $exit_code = eval { $sub->(@$argv) };
189 if ($@ eq RUN_SCRIPT_EXIT) {
191 $exit_code = $run_script_exit_code;
192 $? = ($exit_code << 8);
193 } elsif (defined($exit_code)) {
194 $? = ($exit_code << 8);
195 } elsif ($@) { # mimic die() behavior when uncaught
196 warn "E: eval-ed $key: $@\n";
197 $? = ($! << 8) if $!;
198 $? = (255 << 8) if $? == 0;
200 die "BUG: eval-ed $key: no exit code or \$@\n";
204 sub run_script ($;$$) {
205 my ($cmd, $env, $opt) = @_;
206 my ($key, @argv) = @$cmd;
207 my $run_mode = $ENV{TEST_RUN_MODE} // $opt->{run_mode} // 1;
208 my $sub = $run_mode == 0 ? undef : key2sub($key);
212 my $redir = $opt->{$fd};
213 my $ref = ref($redir);
214 if ($ref eq 'SCALAR') {
215 open my $fh, '+>', undef or die "open: $!";
217 $spawn_opt->{$fd} = $fh;
220 print $fh $$redir or die "print: $!";
221 seek($fh, 0, SEEK_SET) or die "seek: $!";
222 } elsif ($ref eq 'GLOB') {
223 $spawn_opt->{$fd} = $fhref->[$fd] = $redir;
225 die "unable to deal with $ref $redir";
228 if ($run_mode == 0) {
229 # spawn an independent new process, like real-world use cases:
230 require PublicInbox::Spawn;
231 my $cmd = [ key2script($key), @argv ];
232 my $pid = PublicInbox::Spawn::spawn($cmd, $env, $spawn_opt);
234 my $r = waitpid($pid, 0);
235 defined($r) or die "waitpid: $!";
236 $r == $pid or die "waitpid: expected $pid, got $r";
238 } else { # localize and run everything in the same process:
239 # note: "local *STDIN = *STDIN;" and so forth did not work in
240 # old versions of perl
241 local %ENV = $env ? (%ENV, %$env) : %ENV;
243 local $0 = join(' ', @$cmd);
244 my $orig_io = _prepare_redirects($fhref);
245 _run_sub($sub, $key, \@argv);
246 _undo_redirects($orig_io);
249 # slurp the redirects back into user-supplied strings
251 my $fh = $fhref->[$fd] or next;
252 seek($fh, 0, SEEK_SET) or die "seek: $!";
253 my $redir = $opt->{$fd};
260 sub wait_for_tail () { sleep(2) }
262 # like system() built-in, but uses spawn() for env/rdr + vfork
264 my ($cmd, $env, $rdr) = @_;
272 run_script($cmd, $env, { %$rdr, run_mode => 0 });
276 # like `backtick` or qx{} op, but uses spawn() for env/rdr + vfork
278 my ($cmd, $env, $rdr) = @_;
280 run_script($cmd, $env, { %$rdr, run_mode => 0, 1 => \(my $out) });
281 wantarray ? split(/^/m, $out) : $out;
285 my ($cmd, $env, $opt) = @_;
286 my ($key, @argv) = @$cmd;
287 my $run_mode = $ENV{TEST_RUN_MODE} // $opt->{run_mode} // 2;
288 my $sub = $run_mode == 0 ? undef : key2sub($key);
290 if (my $tail_cmd = $ENV{TAIL}) {
293 next unless /\A--std(?:err|out)=(.+)\z/;
297 defined($tail_pid = fork) or die "fork: $!\n";
298 if ($tail_pid == 0) {
299 # make sure files exist, first
300 open my $fh, '>>', $_ for @paths;
301 open(STDOUT, '>&STDERR') or die "1>&2: $!";
302 exec(split(' ', $tail_cmd), @paths);
303 die "$tail_cmd failed: $!";
308 defined(my $pid = fork) or die "fork: $!\n";
310 # pretend to be systemd (cf. sd_listen_fds(3))
311 # 3 == SD_LISTEN_FDS_START
313 for ($fd = 0; 1; $fd++) {
315 last if $fd >= 3 && !defined($s);
317 my $fl = fcntl($s, F_GETFD, 0);
318 if (($fl & FD_CLOEXEC) != FD_CLOEXEC) {
319 warn "got FD:".fileno($s)." w/o CLOEXEC\n";
321 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
322 dup2(fileno($s), $fd) or die "dup2 failed: $!\n";
324 %ENV = (%ENV, %$env) if $env;
327 $ENV{LISTEN_PID} = $$;
328 $ENV{LISTEN_FDS} = $fds;
330 $0 = join(' ', @$cmd);
332 _run_sub($sub, $key, \@argv);
333 POSIX::_exit($? >> 8);
335 exec(key2script($key), @argv);
336 die "FAIL: ",join(' ', $key, @argv), ": $!\n";
339 PublicInboxTestProcess->new($pid, $tail_pid);
342 package PublicInboxTestProcess;
345 # prevent new threads from inheriting these objects
349 my ($klass, $pid, $tail_pid) = @_;
350 bless { pid => $pid, tail_pid => $tail_pid, owner => $$ }, $klass;
354 my ($self, $sig) = @_;
355 CORE::kill($sig // 'TERM', $self->{pid});
359 my ($self, $sig) = @_;
360 my $pid = delete $self->{pid} or return;
361 CORE::kill($sig, $pid) if defined $sig;
362 my $ret = waitpid($pid, 0);
363 defined($ret) or die "waitpid($pid): $!";
364 $ret == $pid or die "waitpid($pid) != $ret";
369 return if $self->{owner} != $$;
370 if (my $tail = delete $self->{tail_pid}) {
371 PublicInbox::TestCommon::wait_for_tail();
372 CORE::kill('TERM', $tail);