chiark / gitweb /
Test suite: Introduce setup/gnupg
[dgit.git] / Debian / Dgit.pm
index f20f1bc44c719d918ea0cb8cf689b13cdaeb4223..5c43f0257b82860f0e6cff3e7d85040c144cd8df 100644 (file)
@@ -1,13 +1,33 @@
 # -*- perl -*-
+# dgit
+# Debian::Dgit: functions common to dgit and its helpers and servers
+#
+# Copyright (C) 2015-2016  Ian Jackson
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 package Debian::Dgit;
 
 use strict;
 use warnings;
 
+use Carp;
 use POSIX;
 use IO::Handle;
 use Config;
+use Digest::SHA;
+use Data::Dumper;
 
 BEGIN {
     use Exporter   ();
@@ -15,17 +35,22 @@ BEGIN {
 
     $VERSION     = 1.00;
     @ISA         = qw(Exporter);
-    @EXPORT      = qw(debiantag server_branch server_ref
-                      stat_exists fail waitstatusmsg failedcmd
+    @EXPORT      = qw(setup_sigwarn
+                      debiantags debiantag_old debiantag_new
+                     server_branch server_ref
+                      stat_exists link_ltarget
+                     hashfile
+                      fail ensuredir executable_on_path
+                      waitstatusmsg failedcmd
                       cmdoutput cmdoutput_errok
-                      git_rev_parse git_for_each_ref
+                      git_rev_parse git_get_ref git_for_each_ref
                       git_for_each_tag_referring is_fast_fwd
                       $package_re $component_re $deliberately_re
                       $branchprefix
                       initdebug enabledebug enabledebuglevel
                       printdebug debugcmd
                       $debugprefix *debuglevel *DEBUG
-                      shellquote printcmd);
+                      shellquote printcmd messagequote);
     # implicitly uses $main::us
     %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO)] );
     @EXPORT_OK   = @{ $EXPORT_TAGS{policyflags} };
@@ -48,6 +73,13 @@ sub FRESHREPO () { return 0x4; }
 our $debugprefix;
 our $debuglevel = 0;
 
+sub setup_sigwarn () {
+    our $sigwarn_mainprocess = $$;
+    $SIG{__WARN__} = sub { 
+       die $_[0] unless getppid == $sigwarn_mainprocess;
+    };
+}
+
 sub initdebug ($) { 
     ($debugprefix) = @_;
     open DEBUG, ">/dev/null" or die $!;
@@ -73,12 +105,22 @@ sub printdebug {
     print DEBUG $debugprefix, @_ or die $! if $debuglevel>0;
 }
 
+sub messagequote ($) {
+    local ($_) = @_;
+    s{\\}{\\\\}g;
+    s{\n}{\\n}g;
+    s{\x08}{\\b}g;
+    s{\t}{\\t}g;
+    s{[\000-\037\177]}{ sprintf "\\x%02x", ord $& }ge;
+    $_;
+}
+
 sub shellquote {
     my @out;
     local $_;
     foreach my $a (@_) {
        $_ = $a;
-       if (!length || m{[^-=_./0-9a-z]}i) {
+       if (!length || m{[^-=_./:0-9a-z]}i) {
            s{['\\]}{'\\$&'}g;
            push @out, "'$_'";
        } else {
@@ -101,10 +143,21 @@ sub debugcmd {
     printcmd(\*DEBUG,$debugprefix.$extraprefix,@_) if $debuglevel>0;
 }
 
-sub debiantag ($) { 
-    my ($v) = @_;
+sub debiantag_old ($$) { 
+    my ($v,$distro) = @_;
+    $v =~ y/~:/_%/;
+    return "$distro/$v";
+}
+
+sub debiantag_new ($$) { 
+    my ($v,$distro) = @_;
     $v =~ y/~:/_%/;
-    return "debian/$v";
+    return "archive/$distro/$v";
+}
+
+sub debiantags ($$) {
+    my ($version,$distro) = @_;
+    map { $_->($version, $distro) } (\&debiantag_new, \&debiantag_old);
 }
 
 sub server_branch ($) { return "$branchprefix/$_[0]"; }
@@ -123,11 +176,30 @@ sub _us () {
 
 sub fail { 
     my $s = "@_\n";
+    $s =~ s/\n\n$/\n/;
     my $prefix = _us().": ";
     $s =~ s/^/$prefix/gm;
     die $s;
 }
 
+sub ensuredir ($) {
+    my ($dir) = @_; # does not create parents
+    return if mkdir $dir;
+    return if $! == EEXIST;
+    die "mkdir $dir: $!";
+}
+
+sub executable_on_path ($) {
+    my ($program) = @_;
+    return 1 if $program =~ m{/};
+    my @path = split /:/, ($ENV{PATH} // "/usr/local/bin:/bin:/usr/bin");
+    foreach my $pe (@path) {
+       my $here = "$pe/$program";
+       return $here if stat_exists $here && -x _;
+    }
+    return undef;
+}
+
 our @signames = split / /, $Config{sig_name};
 
 sub waitstatusmsg () {
@@ -146,8 +218,19 @@ sub waitstatusmsg () {
 }
 
 sub failedcmd {
+    # Expects $!,$? as set by close - see below.
+    # To use with system(), set $?=-1 first.
+    #
+    # Actual behaviour of perl operations:
+    #   success              $!==0       $?==0       close of piped open
+    #   program failed       $!==0       $? >0       close of piped open
+    #   syscall failure      $! >0       $?=-1       close of piped open
+    #   failure              $! >0       unchanged   close of something else
+    #   success              trashed     $?==0       system
+    #   program failed       trashed     $? >0       system
+    #   syscall failure      $! >0       unchanged   system
     { local ($!); printcmd \*STDERR, _us().": failed command:", @_ or die $!; };
-    if ($!) {
+    if ($? < 0) {
        fail "failed to fork/exec: $!";
     } elsif ($?) {
        fail "subprocess ".waitstatusmsg();
@@ -157,17 +240,22 @@ sub failedcmd {
 }
 
 sub cmdoutput_errok {
-    die Dumper(\@_)." ?" if grep { !defined } @_;
+    confess Dumper(\@_)." ?" if grep { !defined } @_;
     debugcmd "|",@_;
-    open P, "-|", @_ or die $!;
+    open P, "-|", @_ or die "$_[0] $!";
     my $d;
     $!=0; $?=0;
     { local $/ = undef; $d = <P>; }
     die $! if P->error;
     if (!close P) { printdebug "=>!$?\n"; return undef; }
     chomp $d;
-    $d =~ m/^.*/;
-    printdebug "=> \`$&'",(length $' ? '...' : ''),"\n" if $debuglevel>0; #';
+    if ($debuglevel > 0) {
+       $d =~ m/^.*/;
+       my $dd = $&;
+       my $more = (length $' ? '...' : ''); #');
+       $dd =~ s{[^\n -~]|\\}{ sprintf "\\x%02x", ord $& }ge;
+       printdebug "=> \`$dd'",$more,"\n";
+    }
     return $d;
 }
 
@@ -177,37 +265,70 @@ sub cmdoutput {
     return $d;
 }
 
+sub link_ltarget ($$) {
+    my ($old,$new) = @_;
+    lstat $old or return undef;
+    if (-l _) {
+       $old = cmdoutput qw(realpath  --), $old;
+    }
+    link $old, $new or die "link $old $new: $!";
+}
+
+sub hashfile ($) {
+    my ($fn) = @_;
+    my $h = Digest::SHA->new(256);
+    $h->addfile($fn);
+    return $h->hexdigest();
+}
+
 sub git_rev_parse ($) {
     return cmdoutput qw(git rev-parse), "$_[0]~0";
 }
 
-sub git_for_each_ref ($$) {
-    my ($pattern,$func) = @_;
+sub git_for_each_ref ($$;$) {
+    my ($pattern,$func,$gitdir) = @_;
     # calls $func->($objid,$objtype,$fullrefname,$reftail);
-    # $reftail is RHS of ref after refs/\w+/
+    # $reftail is RHS of ref after refs/[^/]+/
     # breaks if $pattern matches any ref `refs/blah' where blah has no `/'
-    my @cmd = (qw(git for-each-ref), $pattern);
+    # $pattern may be an array ref to mean multiple patterns
+    $pattern = [ $pattern ] unless ref $pattern;
+    my @cmd = (qw(git for-each-ref), @$pattern);
+    if (defined $gitdir) {
+       @cmd = ('sh','-ec','cd "$1"; shift; exec "$@"','x', $gitdir, @cmd);
+    }
     open GFER, "-|", @cmd or die $!;
     debugcmd "|", @cmd;
     while (<GFER>) {
        chomp or die "$_ ?";
        printdebug "|> ", $_, "\n";
-       m#^(\w+)\s+(\w+)\s+(refs/\w+/(\S+))$# or die "$_ ?";
+       m#^(\w+)\s+(\w+)\s+(refs/[^/]+/(\S+))$# or die "$_ ?";
        $func->($1,$2,$3,$4);
     }
     $!=0; $?=0; close GFER or die "$pattern $? $!";
 }
 
+sub git_get_ref ($) {
+    # => '' if no such ref
+    my ($refname) = @_;
+    local $_ = $refname;
+    s{^refs/}{[r]efs/} or die "$refname $_ ?";
+    return cmdoutput qw(git for-each-ref --format=%(objectname)), $_;
+}
+
 sub git_for_each_tag_referring ($$) {
     my ($objreferring, $func) = @_;
-    # calls $func->($objid,$fullrefname,$tagname);
+    # calls $func->($tagobjid,$refobjid,$fullrefname,$tagname);
     printdebug "git_for_each_tag_referring ",
         ($objreferring // 'UNDEF'),"\n";
     git_for_each_ref('refs/tags', sub {
-       my ($objid,$objtype,$fullrefname,$tagname) = @_;
+       my ($tagobjid,$objtype,$fullrefname,$tagname) = @_;
        return unless $objtype eq 'tag';
-       return if defined $objreferring and $objid ne $objreferring;
-       $func->($objid,$fullrefname,$tagname);
+       my $refobjid = git_rev_parse $tagobjid;
+       return unless
+           !defined $objreferring # caller wants them all
+           or $tagobjid eq $objreferring
+           or $refobjid eq $objreferring;
+       $func->($tagobjid,$refobjid,$fullrefname,$tagname);
     });
 }