Dgit.pm: "confess" when we die due to a warning, rather than symply dieing.

[dgit.git] / Debian / Dgit.pm

diff --git a/Debian/Dgit.pm b/Debian/Dgit.pm
index b678ba53ead7cba05a4d579ebef5ae1f5f5df6c9..d086cbe50d36d33e14cea82de5f00b8b367d569a 100644 (file)
--- a/Debian/Dgit.pm
+++ b/Debian/Dgit.pm
@@ -49,7 +49,7 @@ BEGIN {
                      failedcmd_report_cmd failedcmd
                       runcmd cmdoutput cmdoutput_errok
                       git_rev_parse git_cat_file
-                     git_get_ref git_for_each_ref
+                     git_get_ref git_get_symref git_for_each_ref
                       git_for_each_tag_referring is_fast_fwd
                       $package_re $component_re $deliberately_re
                      $distro_re $versiontag_re $series_filename_re
@@ -65,7 +65,7 @@ BEGIN {
     %EXPORT_TAGS = ( policyflags => [qw(NOFFCHECK FRESHREPO NOCOMMITCHECK)],
                     playground => [qw(record_maindir $maindir $local_git_cfg
                                       $maindir_gitdir $maindir_gitcommon
-                                      fresh_playground $playground
+                                      fresh_playground
                                        ensure_a_playground)]);
     @EXPORT_OK   = ( @{ $EXPORT_TAGS{policyflags} },
                     @{ $EXPORT_TAGS{playground} } );
@@ -108,7 +108,7 @@ sub forkcheck_mainprocess () {
 sub setup_sigwarn () {
     forkcheck_setup();
     $SIG{__WARN__} = sub { 
-       die $_[0] if forkcheck_mainprocess;
+       confess $_[0] if forkcheck_mainprocess;
     };
 }
 
@@ -348,11 +348,21 @@ sub git_rev_parse ($) {
     return cmdoutput qw(git rev-parse), "$_[0]~0";
 }
 
-sub git_cat_file ($) {
-    my ($objname) = @_;
+sub git_cat_file ($;$) {
+    my ($objname, $etype) = @_;
     # => ($type, $data) or ('missing', undef)
     # in scalar context, just the data
+    # if $etype defined, dies unless type is $etype or in @$etype
     our ($gcf_pid, $gcf_i, $gcf_o);
+    my $chk = sub {
+       my ($gtype, $data) = @_;
+       if ($etype) {
+           $etype = [$etype] unless ref $etype;
+           confess "$objname expected @$etype but is $gtype"
+               unless grep { $gtype eq $_ } @$etype;
+       }
+       return ($gtype, $data);
+    };
     if (!$gcf_pid) {
        my @cmd = qw(git cat-file --batch);
        debugcmd "GCF|", @cmd;
@@ -362,13 +372,26 @@ sub git_cat_file ($) {
     print $gcf_i $objname, "\n" or die $!;
     my $x = <$gcf_o>;
     printdebug "GCF<| ", $x;
-    if ($x =~ m/ (missing)$/) { return ($1, undef); }
+    if ($x =~ m/ (missing)$/) { return $chk->($1, undef); }
     my ($type, $size) = $x =~ m/^.* (\w+) (\d+)\n/ or die "$objname ?";
     my $data;
     (read $gcf_o, $data, $size) == $size or die "$objname $!";
     $x = <$gcf_o>;
     $x eq "\n" or die "$objname ($_) $!";
-    return ($type, $data);
+    return $chk->($type, $data);
+}
+
+sub git_get_symref (;$) {
+    my ($symref) = @_;  $symref //= 'HEAD';
+    # => undef if not a symref, otherwise refs/...
+    my @cmd = (qw(git symbolic-ref -q HEAD));
+    my $branch = cmdoutput_errok @cmd;
+    if (!defined $branch) {
+       $?==256 or failedcmd @cmd;
+    } else {
+       chomp $branch;
+    }
+    return $branch;
 }
 
 sub git_for_each_ref ($$;$) {
@@ -465,7 +488,7 @@ sub git_slurp_config_src ($) {
 # terminology:
 #
 #   $maindir      user's git working tree
-#   $playground   area in .git/ where we can make files, unpack, etc. etc.
+#   playground    area in .git/ where we can make files, unpack, etc. etc.
 #   playtree      git working tree sharing object store with the user's
 #                 inside playground, or identical to it
 #
@@ -485,28 +508,26 @@ sub git_slurp_config_src ($) {
 #
 #    fresh_playground SUBDIR_PATH_COMPONENTS
 #      e.g fresh_playground 'dgit/unpack' ('.git/' is implied)
-#      default SUBDIR_PATH_COMPONENTS is $playground_subdir
+#      default SUBDIR_PATH_COMPONENTS is playground_subdir
 #      calls record_maindir
 #      sets up a new playground (destroying any old one)
-#      assigns to $playground and returns the same pathname
+#      returns playground pathname
 #      caller may call multiple times with different subdir paths
-#       createing different playgrounds; but $playground global can
-#       refer only to one, obv.
+#       createing different playgrounds
 #
 #    ensure_a_playground SUBDIR_PATH_COMPONENTS
 #      like fresh_playground except:
 #      merely ensures the directory exists; does not delete an existing one
-#      never sets global $playground
 #
 #  then can use
 #
-#    changedir $playground
+#    changedir playground
 #    changedir $maindir
 #
 #    playtree_setup $local_git_cfg
-#            # ^ call in some (perhaps trivial) subdir of $playground
+#            # ^ call in some (perhaps trivial) subdir of playground
 #
-#    rmtree $playground
+#    rmtree playground
 
 # ----- maindir -----
 
@@ -538,12 +559,10 @@ sub record_maindir () {
 
 # ----- playgrounds -----
 
-our $playground;
-
 sub ensure_a_playground_parent ($) {
     my ($spc) = @_;
     record_maindir();
-    $spc = ".git/$spc";
+    $spc = "$maindir_gitdir/$spc";
     my $parent = dirname $spc;
     mkdir $parent or $!==EEXIST
        or fail "failed to mkdir playground parent $parent: $!";
@@ -561,8 +580,8 @@ sub fresh_playground ($) {
     my ($spc) = @_;
     $spc = ensure_a_playground_parent $spc;
     rmtree $spc;
-    mkdir $spc or die "$spc $!";
-    return $playground = "$maindir/$spc";
+    mkdir $spc or fail "failed to mkdir the playground $spc: $!";
+    return $spc;
 }
 
 # ----- playtrees -----
@@ -582,8 +601,13 @@ sub playtree_setup (;$) {
        next unless $v;
        runcmd qw(git config), $copy, $_ foreach @$v;
     }
+    # this is confusing: we have
+    #   .                   playtree, not a worktree, has .git/, our cwd
+    #   $maindir            might be a worktree so
+    #   $maindir_gitdir     contains our main working "dgit", HEAD, etc.
+    #   $maindir_gitcommon  the shared stuff, including .objects
     rmtree('.git/objects');
-    symlink "$maindir/.git/objects",'.git/objects' or die $!;
+    symlink "$maindir_gitcommon/objects",'.git/objects' or die $!;
     ensuredir '.git/info';
     open GA, "> .git/info/attributes" or die $!;
     print GA "* $negate_harmful_gitattrs\n" or die $!;