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 # 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
12 run_script start_script key2sub);
17 unless (defined $base) {
18 ($base) = ($0 =~ m!\b([^/]+)\.[^\.]+\z!);
20 my $tmpdir = File::Temp->newdir("pi-$base-$$-XXXXXX", TMPDIR => 1);
21 ($tmpdir->dirname, $tmpdir);
25 IO::Socket::INET->new(
26 LocalAddr => '127.0.0.1',
29 Type => Socket::SOCK_STREAM(),
36 my ($dest, %opt) = @_;
37 my $s = IO::Socket::INET->new(
39 Type => Socket::SOCK_STREAM(),
40 PeerAddr => $dest->sockhost . ':' . $dest->sockport,
47 sub require_git ($;$) {
48 my ($req, $maybe) = @_;
49 my ($req_maj, $req_min) = split(/\./, $req);
50 my ($cur_maj, $cur_min) = (`git --version` =~ /version (\d+)\.(\d+)/);
52 my $req_int = ($req_maj << 24) | ($req_min << 16);
53 my $cur_int = ($cur_maj << 24) | ($cur_min << 16);
54 if ($cur_int < $req_int) {
56 Test::More::plan(skip_all =>
57 "git $req+ required, have $cur_maj.$cur_min");
64 return $key if (index($key, '/') >= 0);
65 # n.b. we may have scripts which don't start with "public-inbox" in
67 $key =~ s/\A([-\.])/public-inbox$1/;
71 my @io_mode = ([ *STDIN{IO}, '<&' ], [ *STDOUT{IO}, '>&' ],
72 [ *STDERR{IO}, '>&' ]);
74 sub _prepare_redirects ($) {
77 for (my $fd = 0; $fd <= $#io_mode; $fd++) {
78 my $fh = $fhref->[$fd] or next;
79 my ($oldfh, $mode) = @{$io_mode[$fd]};
80 open my $orig, $mode, $oldfh or die "$$oldfh $mode stash: $!";
81 $orig_io->[$fd] = $orig;
82 open $oldfh, $mode, $fh or die "$$oldfh $mode redirect: $!";
87 sub _undo_redirects ($) {
89 for (my $fd = 0; $fd <= $#io_mode; $fd++) {
90 my $fh = $orig_io->[$fd] or next;
91 my ($oldfh, $mode) = @{$io_mode[$fd]};
92 open $oldfh, $mode, $fh or die "$$oldfh $mode redirect: $!";
96 # $opt->{run_mode} (or $ENV{TEST_RUN_MODE}) allows chosing between
97 # three ways to spawn our own short-lived Perl scripts for testing:
99 # 0 - (fork|vfork) + execve, the most realistic but slowest
100 # 1 - preloading and running in a forked subprocess (fast)
101 # 2 - preloading and running in current process (slightly faster than 1)
103 # 2 is not compatible with scripts which use "exit" (which we'll try to
104 # avoid in the future).
106 our $run_script_exit_code;
107 sub RUN_SCRIPT_EXIT () { "RUN_SCRIPT_EXIT\n" };
108 sub run_script_exit (;$) {
109 $run_script_exit_code = $_[0] // 0;
116 $cached_scripts{$key} //= do {
117 my $f = key2script($key);
118 open my $fh, '<', $f or die "open $f: $!";
119 my $str = do { local $/; <$fh> };
120 my $pkg = (split(m!/!, $f))[-1];
121 $pkg =~ s/([a-z])([a-z0-9]+)(\.t)?\z/\U$1\E$2/;
124 $pkg = "PublicInbox::TestScript::$pkg";
130 *exit = *PublicInbox::TestCommon::run_script_exit;
132 # the below "line" directive is a magic comment, see perlsyn(1) manpage
144 my ($sub, $key, $argv) = @_;
145 local @ARGV = @$argv;
146 $run_script_exit_code = undef;
147 my $exit_code = eval { $sub->(@$argv) };
148 if ($@ eq RUN_SCRIPT_EXIT) {
150 $exit_code = $run_script_exit_code;
151 $? = ($exit_code << 8);
152 } elsif (defined($exit_code)) {
153 $? = ($exit_code << 8);
154 } elsif ($@) { # mimic die() behavior when uncaught
155 warn "E: eval-ed $key: $@\n";
156 $? = ($! << 8) if $!;
157 $? = (255 << 8) if $? == 0;
159 die "BUG: eval-ed $key: no exit code or \$@\n";
163 sub run_script ($;$$) {
164 my ($cmd, $env, $opt) = @_;
165 my ($key, @argv) = @$cmd;
166 my $run_mode = $ENV{TEST_RUN_MODE} // $opt->{run_mode} // 1;
167 my $sub = $run_mode == 0 ? undef : key2sub($key);
171 my $redir = $opt->{$fd};
172 next unless ref($redir);
173 open my $fh, '+>', undef or die "open: $!";
175 $spawn_opt->{$fd} = fileno($fh);
178 print $fh $$redir or die "print: $!";
179 seek($fh, 0, SEEK_SET) or die "seek: $!";
181 if ($run_mode == 0) {
182 # spawn an independent new process, like real-world use cases:
183 require PublicInbox::Spawn;
184 my $cmd = [ key2script($key), @argv ];
185 my $pid = PublicInbox::Spawn::spawn($cmd, $env, $spawn_opt);
186 defined($pid) or die "spawn: $!";
188 my $r = waitpid($pid, 0);
189 defined($r) or die "waitpid: $!";
190 $r == $pid or die "waitpid: expected $pid, got $r";
192 } else { # localize and run everything in the same process:
193 # note: "local *STDIN = *STDIN;" and so forth did not work in
194 # old versions of perl
195 local %ENV = $env ? (%ENV, %$env) : %ENV;
197 local $0 = join(' ', @$cmd);
198 my $orig_io = _prepare_redirects($fhref);
199 _run_sub($sub, $key, \@argv);
200 _undo_redirects($orig_io);
203 # slurp the redirects back into user-supplied strings
205 my $fh = $fhref->[$fd] or next;
206 seek($fh, 0, SEEK_SET) or die "seek: $!";
207 my $redir = $opt->{$fd};
214 sub wait_for_tail () { sleep(2) }
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);
222 if (my $tail_cmd = $ENV{TAIL}) {
225 next unless /\A--std(?:err|out)=(.+)\z/;
229 defined($tail_pid = fork) or die "fork: $!\n";
230 if ($tail_pid == 0) {
231 # make sure files exist, first
232 open my $fh, '>>', $_ for @paths;
233 open(STDOUT, '>&STDERR') or die "1>&2: $!";
234 exec(split(' ', $tail_cmd), @paths);
235 die "$tail_cmd failed: $!";
240 defined(my $pid = fork) or die "fork: $!\n";
242 # pretend to be systemd (cf. sd_listen_fds(3))
243 # 3 == SD_LISTEN_FDS_START
245 for ($fd = 0; 1; $fd++) {
247 last if $fd >= 3 && !defined($s);
249 my $fl = fcntl($s, F_GETFD, 0);
250 if (($fl & FD_CLOEXEC) != FD_CLOEXEC) {
251 warn "got FD:".fileno($s)." w/o CLOEXEC\n";
253 fcntl($s, F_SETFD, $fl &= ~FD_CLOEXEC);
254 dup2(fileno($s), $fd) or die "dup2 failed: $!\n";
256 %ENV = (%ENV, %$env) if $env;
259 $ENV{LISTEN_PID} = $$;
260 $ENV{LISTEN_FDS} = $fds;
262 $0 = join(' ', @$cmd);
264 _run_sub($sub, $key, \@argv);
265 POSIX::_exit($? >> 8);
267 exec(key2script($key), @argv);
268 die "FAIL: ",join(' ', $key, @argv), ": $!\n";
271 PublicInboxTestProcess->new($pid, $tail_pid);
274 package PublicInboxTestProcess;
277 # prevent new threads from inheriting these objects
281 my ($klass, $pid, $tail_pid) = @_;
282 bless { pid => $pid, tail_pid => $tail_pid, owner => $$ }, $klass;
286 my ($self, $sig) = @_;
287 CORE::kill($sig // 'TERM', $self->{pid});
292 my $pid = delete $self->{pid} or return;
293 my $ret = waitpid($pid, 0);
294 defined($ret) or die "waitpid($pid): $!";
295 $ret == $pid or die "waitpid($pid) != $ret";
300 return if $self->{owner} != $$;
301 if (my $tail = delete $self->{tail_pid}) {
302 PublicInbox::TestCommon::wait_for_tail();
303 CORE::kill('TERM', $tail);
305 my $pid = delete $self->{pid} or return;
306 CORE::kill('TERM', $pid);