t/examples: skip all if missing dependency

[barcat.git] / t / examples.t

diff --git a/t/examples.t b/t/examples.t
index 52e7a5a7b732f06bec7a4037617d8eb36afa1e7d..c9b285e70d84a6b410b4951d24e2b248a2e4c9da 100755 (executable)
--- a/t/examples.t
+++ b/t/examples.t
@@ -2,7 +2,6 @@
 use 5.014;
 use warnings;
 use re '/ms';
-use IPC::Run 'run';
 
 use Test::More;
 { # silence fail diagnostics because of single caller
@@ -10,10 +9,14 @@ use Test::More;
        sub Test::Builder::_ok_debug {}
 }
 
+eval q(use IPC::Run 'run');
+plan skip_all => "IPC::Run required to test commands" if $@;
+
 my %CMDARGS = (
-       ping => '-c 1',
-       curl => '-sS',
-       'cat \Klog/' => '/var/log/apache2/',
+       ping => '-c 1 ',
+       'cat \Khttpd/' => '/var/log/apache2/',
+       ' \K\*(?=\h*\|)' => 'sample/media/*.*',
+       find => 'sample/media -name \*.\* ',
 );
 
 my $filename = 'barcat';
@@ -22,10 +25,39 @@ open my $input, '<', $filename
 
 local $/ = "\n\n";
 while (readline $input) {
-       # find code snippets in the appropriate section
+SKIP: {
+       # find scriptlets in the appropriate section
        /^=head1 EXAMPLES/ ... /^=head1/ or next;
-       /^\h/ or next;
+       /^\h/ or next;  # indented code snippet
+       /\A\h*>/ and next;  # psql prompt
        chomp;
+       my $cmd = $_;
+       my $ref = "$filename line $.";
+
+       # store curl downloads
+       $cmd =~ s{\bcurl (\S*)([^|]*)}{
+               my ($url, $params) = ($1, $2);
+               my $cache = 'sample/data/';
+               -w $cache or skip($url, 2);
+               my $ext = (
+                       $cmd =~ /\bxml/     ? 'xml'  :
+                       $cmd =~ / jq /      ? 'json' :
+                       $cmd =~ /[=.]csv\b/ ? 'csv'  :
+                                             'txt'
+               );
+               my ($domain, $path) = $url =~ m{//([^/]+) .*/ ([^/]*) \z}x;
+               $path =~ s/\.$ext\z//;
+               $cache .= join '.', $path =~ tr/./_/r, $domain, $ext;
+               my $cached = -e $cache;
+               SKIP: {
+                       # download to file
+                       skip($url, 1) if $cached;
+                       $cached = defined runres("curl -sSf $url$params -o $cache");
+                       ok($cached, $url) or diag("download at $ref: $@");
+               }
+               $cached or skip($url, 1);
+               "cat $cache"
+       }e;
 
        # compose an identifier from significant parts
        do {
@@ -33,30 +65,46 @@ while (readline $input) {
                s/\\\n\s*//g;         # line continuations
                s/^[(\h]+//;          # subshell
                s/^echo\ .*?\|\s*//;  # preceding input
-               s/\|.*//;             # subsequent pipes
-               s/^cat\ //;           # local file
-               s/^curl\ // and do {  # remote url
-                       s/\ -.+//g;                 # download options
-                       s{//[^/\s]+/\K\S*(?=/)}{};  # subdirectories
-                       s{^https?://}{};            # http protocol
-               };
-       } for my $name = $_;
+               s/'(\S+)[^']*'/$1/g;  # quoted arguments
+               s/\h*\|.*//;          # subsequent pipes
+               s/^cat\ (?:\S+\/)?//; # local file
+       } for my $name = $cmd;
 
        # prepare shell command to execute
-       my $cmd = $_;
        while (my ($subcmd, $args) = each %CMDARGS) {
-               $subcmd .= " \\K", $args .= ' ' unless $subcmd =~ m/\\K/;
-               $cmd =~ s/\b$subcmd/$args/;
+               $subcmd .= " \\K" unless $subcmd =~ m/\\K/;
+               $cmd =~ s/$subcmd/$args/;
+       }
+
+       for my $param ($cmd =~ m{^[(\h]* (\w\S*)}gx) {
+               $param eq 'cat' or
+               runres(['which', $param])
+                       or diag("dependency $param missing at $ref\n$cmd"), skip($name, 1);
        }
-       my @cmd = (bash => -c => "set -o pipefail\n$cmd");
 
        # run and report unexpected results
-       ok(eval {
-               run(\@cmd, \undef, \my $output);
-               $? == 0 or die "error status ", $? >> 8, "\n";
-               length $output or die "empty output\n";
-               return 1;
-       }, $name) or diag("Failed command\n@cmd\nfrom $filename line $.: $@");
+       my $output = runres($cmd);
+       ok(!!$output, $name)
+               or diag("command at $ref\n$cmd\n" . ($@ || 'empty output'));
+       defined $output or next;
+
+       # record output for review
+       my $numprefix = sprintf '%02d', Test::More->builder->current_test;
+       if (open my $record, '>', "sample/out/t$numprefix-$name.txt") {
+               print {$record} $output;
+       }
+}}
+
+sub runres {
+       my ($cmd) = @_;
+       ref $cmd eq 'ARRAY'
+               or $cmd = [bash => -c => "set -o pipefail\n$cmd"];
+       eval {
+               run($cmd, \undef, \my $output, \my $error);
+               die("error message:\n".($error =~ s/^/    /gr)."\n") if $error;
+               $? == 0 or die "exit status ", $? >> 8, "\n";
+               return $output;
+       };
 }
 
 done_testing();