Add a minimal output mode that shows output when appropriate. Closes: #694031

[code/myrepos.git] / mr

diff --git a/mr b/mr
index e807778a86035a8a7cda669be26ac5b89936d555..87acef39b279cf4d119f35912ebc8967a7cf524c 100755 (executable)
--- a/mr
+++ b/mr
@@ -28,7 +28,7 @@ B<mr> [options] grep pattern
 
 B<mr> [options] run command [param ...]
 
 
 B<mr> [options] run command [param ...]
 

-B<mr> [options] bootstrap url [directory]
+B<mr> [options] bootstrap src [directory]

 
 B<mr> [options] register [repository]
 
 
 B<mr> [options] register [repository]
 


@@ -130,17 +130,39 @@ These commands are also available:
 
 =over 4
 
 
 =over 4
 

-=item bootstrap url [directory]
+=item bootstrap src [directory]

 
 

-Causes mr to download the url, and use it as a .mrconfig file to checkout
-the repositories listed in it, into the specified directory.
+Causes mr to retrieve the source C<src> and use it as a .mrconfig file to
+checkout the repositories listed in it, into the specified directory.

 
 

-To use scp to download, the url may have the form ssh://[user@]host:file
+B<mr> understands several types of sources:
+
+=over 4
+
+=item URL for curl
+
+C<src> may be an URL understood by B<curl>.
+
+=item copy via ssh
+
+To use B<scp> to download, the C<src> may have the form
+C<ssh://[user@]host:file>.
+
+=item local file
+
+You can retrieve the config file by other means and pass its B<path> as C<src>.
+
+=item standard input
+
+If source C<src> consists in a single dash C<->, config file is read from
+standard input.
+
+=back

 
 The directory will be created if it does not exist. If no directory is
 specified, the current directory will be used.
 
 
 The directory will be created if it does not exist. If no directory is
 specified, the current directory will be used.
 

-If the .mrconfig file includes a repository named ".", that
+As a special case, if source C<src> includes a repository named ".", that

 is checked out into the top of the specified directory.
 
 =item list (or ls)
 is checked out into the top of the specified directory.
 
 =item list (or ls)


@@ -243,6 +265,13 @@ configuration.
 
 Be verbose.
 
 
 Be verbose.
 

+=item -m
+
+=item --minimal
+
+Minimise output. If a command fails or there is any output then the usual
+output will be shown.
+

 =item -q
 
 =item --quiet
 =item -q
 
 =item --quiet


@@ -546,6 +575,7 @@ use constant {
 # configurables
 my $config_overridden=0;
 my $verbose=0;
 # configurables
 my $config_overridden=0;
 my $verbose=0;

+my $minimal=0;

 my $quiet=0;
 my $stats=0;
 my $force=0;
 my $quiet=0;
 my $stats=0;
 my $force=0;


@@ -556,6 +586,7 @@ my $no_chdir=0;
 my $jobs=1;
 my $trust_all=0;
 my $directory=getcwd();
 my $jobs=1;
 my $trust_all=0;
 my $directory=getcwd();

+my $terminal=-t STDOUT && eval{require IO::Pty::Easy;IO::Pty::Easy->import();1;} eq 1;

 
 my $HOME_MR_CONFIG = "$ENV{HOME}/.mrconfig";
 $ENV{MR_CONFIG}=find_mrconfig();
 
 my $HOME_MR_CONFIG = "$ENV{HOME}/.mrconfig";
 $ENV{MR_CONFIG}=find_mrconfig();


@@ -699,6 +730,34 @@ sub fulldir {
        return $subdir =~ /^\// ? $subdir : $topdir.$subdir;
 }
 
        return $subdir =~ /^\// ? $subdir : $topdir.$subdir;
 }
 

+sub terminal_friendly_spawn {
+       my $actionmsg = shift;
+       my $sh = shift;
+       my $quiet = shift;
+       my $minimal = shift;
+       my $output = "";
+       if ($terminal) {
+               my $pty = IO::Pty::Easy->new;
+               $pty->spawn($sh);
+               while ($pty->is_active) {
+                       my $data = $pty->read();
+                       $output .= $data if defined $data;
+               }
+               $pty->close;
+       } else {
+               $output = qx/$sh 2>&1/;
+       }
+       my $ret = $?;
+       if ($quiet && $ret != 0) {
+               print "$actionmsg\n" if $actionmsg;
+               print STDERR $output;
+       } elsif (!$quiet && (!$minimal || $output)) {
+               print "$actionmsg\n" if $actionmsg;
+               print $output;
+       }
+       return ($ret, $output ? 1 : 0);
+}
+

 sub action {
        my ($action, $dir, $topdir, $subdir, $force_checkout) = @_;
        my $fulldir=fulldir($topdir, $subdir);
 sub action {
        my ($action, $dir, $topdir, $subdir, $force_checkout) = @_;
        my $fulldir=fulldir($topdir, $subdir);


@@ -778,7 +837,7 @@ sub action {
                        return FAILED;
                }
                else {
                        return FAILED;
                }
                else {

-                       print STDERR "mr $action: no defined action for $vcs repository $fulldir, skipping\n";
+                       print STDERR "mr $action: no defined action for $vcs repository $fulldir, skipping\n" unless $minimal;

                        return SKIPPED;
                }
        }
                        return SKIPPED;
                }
        }


@@ -792,22 +851,16 @@ sub action {
                        $s=~s/^\Q$fulldir\E\/?//;
                        $actionmsg="mr $action: $fulldir (in subdir $s)";
                }
                        $s=~s/^\Q$fulldir\E\/?//;
                        $actionmsg="mr $action: $fulldir (in subdir $s)";
                }

-               print "$actionmsg\n" unless $quiet;
+               print "$actionmsg\n" unless $quiet || $minimal;

 
                my $hookret=hook("pre_$action", $topdir, $subdir);
                return $hookret if $hookret != OK;
 
 
                my $hookret=hook("pre_$action", $topdir, $subdir);
                return $hookret if $hookret != OK;
 

-               my $ret=runsh $action, $topdir, $subdir,
+               my ($ret, $out)=runsh $action, $topdir, $subdir,

                        $command, \@ARGV, sub {
                                my $sh=shift;
                        $command, \@ARGV, sub {
                                my $sh=shift;

-                               if ($quiet) {
-                                       my $output = qx/$sh 2>&1/;
-                                       my $ret = $?;
-                                       if ($ret != 0) {
-                                               print "$actionmsg\n";
-                                               print STDERR $output;
-                                       }
-                                       return $ret;
+                               if (!$jobs || $jobs > 1 || $quiet || $minimal) {
+                                       return terminal_friendly_spawn($actionmsg, $sh, $quiet, $minimal);

                                }
                                else {
                                        system($sh);
                                }
                                else {
                                        system($sh);


@@ -845,7 +898,7 @@ sub action {
                                return FAILED;
                        }
 
                                return FAILED;
                        }
 

-                       my $ret=hook("post_$action", $topdir, $subdir);
+                       my ($ret, $hook_out)=hook("post_$action", $topdir, $subdir);

                        return $ret if $ret != OK;
                        
                        if ($is_checkout || $is_update) {
                        return $ret if $ret != OK;
                        
                        if ($is_checkout || $is_update) {


@@ -859,7 +912,7 @@ sub action {
                                return $ret if $ret != OK;
                        }
                        
                                return $ret if $ret != OK;
                        }
                        

-                       return OK;
+                       return (OK, $out || $hook_out);

                }
        }
 }
                }
        }
 }


@@ -869,15 +922,10 @@ sub hook {
 
        my $command=$config{$topdir}{$subdir}{$hook};
        return OK unless defined $command;
 
        my $command=$config{$topdir}{$subdir}{$hook};
        return OK unless defined $command;

-       my $ret=runsh $hook, $topdir, $subdir, $command, [], sub {
+       my ($ret,$out)=runsh $hook, $topdir, $subdir, $command, [], sub {

                        my $sh=shift;
                        my $sh=shift;

-                       if ($quiet) {
-                               my $output = qx/$sh 2>&1/;
-                               my $ret = $?;
-                               if ($ret != 0) {
-                                       print STDERR $output;
-                               }
-                               return $ret;
+                       if (!$jobs || $jobs > 1 || $quiet || $minimal) {
+                               return terminal_friendly_spawn(undef, $sh, $quiet, $minimal);

                        }
                        else {
                                system($sh);
                        }
                        else {
                                system($sh);


@@ -897,7 +945,7 @@ sub hook {
                }
        }
 
                }
        }
 

-       return OK;
+       return (OK, $out);

 }
 
 # run actions on multiple repos, in parallel
 }
 
 # run actions on multiple repos, in parallel


@@ -925,7 +973,7 @@ sub mrs {
                                close CHILD_STDERR;
                                close $outfh;
                                close $errfh;
                                close CHILD_STDERR;
                                close $outfh;
                                close $errfh;

-                               exit action($action, @$repo);
+                               exit +(action($action, @$repo))[0];

                        }
                        close CHILD_STDOUT;
                        close CHILD_STDERR;
                        }
                        close CHILD_STDOUT;
                        close CHILD_STDERR;


@@ -956,7 +1004,7 @@ sub mrs {
                                                        waitpid($active[$i][0], 0);
                                                        print STDOUT $out[$i][0];
                                                        print STDERR $out[$i][1];
                                                        waitpid($active[$i][0], 0);
                                                        print STDOUT $out[$i][0];
                                                        print STDERR $out[$i][1];

-                                                       record($active[$i][1], $? >> 8);
+                                                       record($active[$i][1], $? >> 8, $out[$i][0] || $out[$i][1]);

                                                        splice(@fhs, $i, 1);
                                                        splice(@active, $i, 1);
                                                        splice(@out, $i, 1);
                                                        splice(@fhs, $i, 1);
                                                        splice(@active, $i, 1);
                                                        splice(@out, $i, 1);


@@ -973,10 +1021,11 @@ sub mrs {
 sub record {
        my $dir=shift()->[0];
        my $ret=shift;
 sub record {
        my $dir=shift()->[0];
        my $ret=shift;

+       my $out=shift;

 
        if ($ret == OK) {
                push @ok, $dir;
 
        if ($ret == OK) {
                push @ok, $dir;

-               print "\n" unless $quiet;
+               print "\n" unless $quiet || ($minimal && !$out);

        }
        elsif ($ret == FAILED) {
                if ($interactive) {
        }
        elsif ($ret == FAILED) {
                if ($interactive) {


@@ -985,7 +1034,7 @@ sub record {
                        system((getpwuid($<))[8], "-i");
                }
                push @failed, $dir;
                        system((getpwuid($<))[8], "-i");
                }
                push @failed, $dir;

-               print "\n" unless $quiet;
+               print "\n";

        }
        elsif ($ret == SKIPPED) {
                push @skipped, $dir;
        }
        elsif ($ret == SKIPPED) {
                push @skipped, $dir;


@@ -1007,10 +1056,10 @@ sub showstats {
                showstat($#ok+1, "ok", "ok"),
                showstat($#failed+1, "failed", "failed"),
                showstat($#skipped+1, "skipped", "skipped"),
                showstat($#ok+1, "ok", "ok"),
                showstat($#failed+1, "failed", "failed"),
                showstat($#skipped+1, "skipped", "skipped"),

-       ).")\n" unless $quiet;
+       ).")\n" unless $quiet || $minimal;

        if ($stats) {
                if (@skipped) {
        if ($stats) {
                if (@skipped) {

-                       print "mr $action: (skipped: ".join(" ", @skipped).")\n" unless $quiet;
+                       print "mr $action: (skipped: ".join(" ", @skipped).")\n" unless $quiet || $minimal;

                }
                if (@failed) {
                        print STDERR "mr $action: (failed: ".join(" ", @failed).")\n";
                }
                if (@failed) {
                        print STDERR "mr $action: (failed: ".join(" ", @failed).")\n";


@@ -1132,7 +1181,8 @@ sub is_trusted_config {
                        while (<TRUST>) {
                                chomp;
                                s/^~\//$ENV{HOME}\//;
                        while (<TRUST>) {
                                chomp;
                                s/^~\//$ENV{HOME}\//;

-                               $trusted{abs_path($_)}=1;
+                               my $d=abs_path($_);
+                               $trusted{$d}=1 if defined $d;

                        }
                        close TRUST;
                }
                        }
                        close TRUST;
                }


@@ -1223,7 +1273,7 @@ my %loaded;
 sub loadconfig {
        my $f=shift;
        my $dir=shift;
 sub loadconfig {
        my $f=shift;
        my $dir=shift;

-       my $bootstrap_url=shift;
+       my $bootstrap_src=shift;

 
        my @toload;
 
 
        my @toload;
 


@@ -1311,8 +1361,8 @@ sub loadconfig {
        my $trusterror = sub {
                my $msg=shift;
        
        my $trusterror = sub {
                my $msg=shift;
        

-               if (defined $bootstrap_url) {
-                       die "mr: $msg in untrusted $bootstrap_url line $lineno\n".
+               if (defined $bootstrap_src) {
+                       die "mr: $msg in untrusted $bootstrap_src line $lineno\n".

                                "(To trust this url, --trust-all can be used; but please use caution;\n".
                                "this can allow arbitrary code execution!)\n";
                }
                                "(To trust this url, --trust-all can be used; but please use caution;\n".
                                "this can allow arbitrary code execution!)\n";
                }


@@ -1686,30 +1736,47 @@ sub register {
 }
 
 sub bootstrap {
 }
 
 sub bootstrap {

-       my $url=shift @ARGV;
+       eval q{use File::Copy};
+       die $@ if $@;
+
+       my $src=shift @ARGV;

        my $dir=shift @ARGV || ".";
        
        my $dir=shift @ARGV || ".";
        

-       if (! defined $url || ! length $url) {
-               die "mr: bootstrap requires url\n";
+       if (! defined $src || ! length $src) {
+               die "mr: bootstrap requires source\n";

        }
        }

-       
-       # Download the config file to a temporary location.
+
+       # Retrieve config file.

        eval q{use File::Temp};
        die $@ if $@;
        my $tmpconfig=File::Temp->new();
        eval q{use File::Temp};
        die $@ if $@;
        my $tmpconfig=File::Temp->new();

-       my @downloader;
-       if ($url =~ m!^ssh://(.*)!) {
-               @downloader = ("scp", $1, $tmpconfig);
+       if ($src =~ m!^[\w\d]+://!) {
+               # Download the config file to a temporary location.
+               my @downloader;
+               if ($src =~ m!^ssh://(.*)!) {
+                       @downloader = ("scp", $1, $tmpconfig);
+               }
+               else {
+                       @downloader = ("curl", "-A", "mr", "-L", "-s", $src, "-o", $tmpconfig);
+                       push(@downloader, "-k") if $insecure;
+               }
+               my $status = system(@downloader);
+               die "mr bootstrap: invalid SSL certificate for $src (consider -k)\n"
+                       if $downloader[0] eq 'curl' && $status >> 8 == 60;
+               die "mr bootstrap: download of $src failed\n" if $status != 0;
+       }
+       elsif ($src eq '-') {
+               # Config file is read from stdin.
+               copy(\*STDIN, $tmpconfig) || die "stdin: $!";

        }
        else {
        }
        else {

-               @downloader = ("curl", "-A", "mr", "-L", "-s", $url, "-o", $tmpconfig);
-               push(@downloader, "-k") if $insecure;
+               # Config file is local.
+               die "mr bootstrap: cannot read file '$src'"
+                       unless -r $src;
+               copy($src, $tmpconfig) || die "copy: $!";

        }
        }

-       my $status = system(@downloader);
-       die "mr bootstrap: invalid SSL certificate for $url (consider -k)\n"
-               if $downloader[0] eq 'curl' && $status >> 8 == 60;
-       die "mr bootstrap: download of $url failed\n" if $status != 0;

 
 

+       # Sanity check on destination directory.

        if (! -e $dir) {
                system("mkdir", "-p", $dir);
        }
        if (! -e $dir) {
                system("mkdir", "-p", $dir);
        }


@@ -1719,16 +1786,14 @@ sub bootstrap {
        # would normally be skipped.
        my $topdir=abs_path(".")."/";
        my @repo=($topdir, $topdir, ".");
        # would normally be skipped.
        my $topdir=abs_path(".")."/";
        my @repo=($topdir, $topdir, ".");

-       loadconfig($tmpconfig, $topdir, $url);
+       loadconfig($tmpconfig, $topdir, $src);

        record(\@repo, action("checkout", @repo, 1))
                if exists $config{$topdir}{"."}{"checkout"};
 
        if (-e ".mrconfig") {
        record(\@repo, action("checkout", @repo, 1))
                if exists $config{$topdir}{"."}{"checkout"};
 
        if (-e ".mrconfig") {

-               print STDERR "mr bootstrap: .mrconfig file already exists, not overwriting with $url\n";
+               print STDERR "mr bootstrap: .mrconfig file already exists, not overwriting with $src\n";

        }
        else {
        }
        else {

-               eval q{use File::Copy};
-               die $@ if $@;

                move($tmpconfig, ".mrconfig") || die "rename: $!";
        }
 
                move($tmpconfig, ".mrconfig") || die "rename: $!";
        }
 


@@ -1786,6 +1851,7 @@ sub getopts {
                "p|path" => sub { }, # now default, ignore
                "f|force" => \$force,
                "v|verbose" => \$verbose,
                "p|path" => sub { }, # now default, ignore
                "f|force" => \$force,
                "v|verbose" => \$verbose,

+               "m|minimal" => \$minimal,

                "q|quiet" => \$quiet,
                "s|stats" => \$stats,
                "k|insecure" => \$insecure,
                "q|quiet" => \$quiet,
                "s|stats" => \$stats,
                "k|insecure" => \$insecure,