This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update rmg concerning feature bundles
[perl5.git] / Porting / cmpVERSION.pl
index d5e4700..e618533 100755 (executable)
@@ -1,5 +1,6 @@
 #!/usr/bin/perl -w
 
+#
 # cmpVERSION - compare the current Perl source tree and a given tag
 # for modules that have identical version numbers but different contents.
 #
 # them)
 #
 # Original by slaven@rezic.de, modified by jhi and matt.w.johnson@gmail.com.
-#
+# Adaptation to produce TAP by Abigail, folded back into this file by Nicholas
 
 use strict;
+use 5.006;
 
 use ExtUtils::MakeMaker;
-use File::Compare;
 use File::Spec::Functions qw(devnull);
 use Getopt::Long;
 
-my ($diffs, $exclude_upstream, $tag_to_compare);
+my ($diffs, $exclude_upstream, $tag_to_compare, $tap);
 unless (GetOptions('diffs' => \$diffs,
                   'exclude|x' => \$exclude_upstream,
                   'tag=s' => \$tag_to_compare,
+                  'tap' => \$tap,
                   ) && @ARGV == 0) {
-    die "usage: $0 [ -d -x --tag TAG]";
+    die "usage: $0 [ -d -x --tag TAG --tap]";
 }
 
 die "$0: This does not look like a Perl directory\n"
@@ -44,8 +46,11 @@ unless (defined $tag_to_compare) {
 my $tag_exists = `git --no-pager tag -l $tag_to_compare 2>$null`;
 chomp $tag_exists;
 
-die "$0: '$tag_to_compare' is not a known Git tag\n"
-    unless $tag_exists eq $tag_to_compare;
+unless ($tag_exists eq $tag_to_compare) {
+    die "$0: '$tag_to_compare' is not a known Git tag\n" unless $tap;
+    print "1..0 # SKIP: '$tag_to_compare' is not a known Git tag\n";
+    exit 0;
+}
 
 my %upstream_files;
 if ($exclude_upstream) {
@@ -68,67 +73,112 @@ my %skip;
     'lib/Exporter/Heavy.pm',
     'win32/FindExt.pm',
 } = ();
+
+# Files to skip just for particular version(s),
+# usually due to some # mix-up
+
+my %skip_versions = (
+          # 'some/sample/file.pm' => [ '1.23', '1.24' ],
+          'dist/threads/lib/threads.pm' => [ '1.83' ],
+         );
+
 my $skip_dirs = qr|^t/lib|;
 
-my @all_diffs = `git --no-pager diff --name-only $tag_to_compare`;
-chomp @all_diffs;
-
-my @module_diffs = grep {
-    my $this_dir;
-    $this_dir = $1 if m/^(.*)\//;
-    /\.pm$/ &&
-    (!defined($this_dir) || ($this_dir !~ $skip_dirs)) &&
-    !exists $skip{$_} &&
-    !exists $upstream_files{$_}
-} @all_diffs;
-
-my (@output_files, @output_diffs);
-
-foreach my $pm_file (@module_diffs) {
-    (my $xs_file = $pm_file) =~ s/\.pm$/.xs/;
-    my $pm_eq = compare_git_file($pm_file, $tag_to_compare);
-    next unless defined $pm_eq;
-    my $xs_eq = 1;
-    if (-e $xs_file) {
-        $xs_eq = compare_git_file($xs_file, $tag_to_compare);
-        next unless defined $xs_eq;
+sub pm_file_from_xs {
+    my $xs = shift;
+
+    # First try a .pm at the same level as the .xs file, with the same basename
+    my $pm = $xs;
+    $pm =~ s/xs\z/pm/;
+    return $pm if -f $pm;
+
+    # Try for a (different) .pm at the same level, based on the directory name:
+    my ($path) = $xs =~ m!^(.*)/!;
+    my ($last) = $path =~ m!([^-/]+)\z!;
+    $pm = "$path/$last.pm";
+    return $pm if -f $pm;
+
+    # Try to work out the extension's full package, and look for a .pm in lib/
+    # based on that:
+    ($last) = $path =~ m!([^/]+)\z!;
+    $last =~ tr !-!/!;
+    $pm = "$path/lib/$last.pm";
+    return $pm if -f $pm;
+
+    die "No idea which .pm file corresponds to '$xs', so aborting";
+}
+
+# Key is the .pm file from which we check the version.
+# Value is a reference to an array of files to check for differences
+# The trivial case is a pure perl module, where the array holds one element,
+# the perl module's file. The "fun" comes with XS modules, and the real fun
+# with XS modules with more than one XS file, and "interesting" layouts.
+
+my %module_diffs;
+
+foreach (`git --no-pager diff --name-only $tag_to_compare --diff-filter=ACMRTUXB`) {
+    chomp;
+    next unless m/^(.*)\//;
+    my $this_dir = $1;
+    next if $this_dir =~ $skip_dirs || exists $skip{$_};
+    next if exists $upstream_files{$_};
+    if (/\.pm\z/ || m|^lib/.*\.pl\z|) {
+       push @{$module_diffs{$_}}, $_;
+    } elsif (/\.xs\z/ && !/\bt\b/) {
+       push @{$module_diffs{pm_file_from_xs($_)}}, $_;
     }
-    next if ($pm_eq && $xs_eq);
+}
+
+unless (%module_diffs) {
+    print "1..1\nok 1 - No difference found\n" if $tap;
+    exit;
+}
+
+printf "1..%d\n" => scalar keys %module_diffs if $tap;
+
+my $count;
+my $diff_cmd = "git --no-pager diff $tag_to_compare ";
+my (@diff);
+
+foreach my $pm_file (sort keys %module_diffs) {
+    # git has already told us that the files differ, so no need to grab each as
+    # a blob from git, and do the comparison ourselves.
     my $pm_version = eval {MM->parse_version($pm_file)};
     my $orig_pm_content = get_file_from_git($pm_file, $tag_to_compare);
     my $orig_pm_version = eval {MM->parse_version(\$orig_pm_content)};
-    next if ( ! defined $pm_version || ! defined $orig_pm_version );
-    next if ( $pm_version eq 'undef' || $orig_pm_version eq 'undef' ); # sigh
-    next if $pm_version ne $orig_pm_version;
-    push @output_files, $pm_file;
-    push @output_diffs, $pm_file unless $pm_eq;
-    push @output_diffs, $xs_file unless $xs_eq;
-}
-
-sub compare_git_file {
-    my ($file, $tag) = @_;
-    open(my $orig_fh, "-|", "git --no-pager show $tag:$file 2>$null");
-    return undef if eof($orig_fh);
-    my $is_eq = compare($file, $orig_fh) == 0;
-    close($orig_fh);
-    return $is_eq;
+    
+    if ((!defined $pm_version || !defined $orig_pm_version)
+       || ($pm_version eq 'undef' || $orig_pm_version eq 'undef') # sigh
+       || ($pm_version ne $orig_pm_version) # good
+       ) {
+        printf "ok %d - %s\n", ++$count, $pm_file if $tap;
+    } else {
+       if ($tap) {
+           foreach (sort @{$module_diffs{$pm_file}}) {
+               print "# $_" for `$diff_cmd '$_'`;
+           }
+           if (exists $skip_versions{$pm_file}
+               and grep $pm_version eq $_, @{$skip_versions{$pm_file}}) {
+               printf "ok %d - SKIP $pm_file version $pm_version\n", ++$count;
+           } else {
+               printf "not ok %d - %s\n", ++$count, $pm_file;
+           }
+       } else {
+           push @diff, @{$module_diffs{$pm_file}};
+           print "$pm_file\n";
+       }
+    }
 }
 
 sub get_file_from_git {
     my ($file, $tag) = @_;
-    local $/ = undef;
-    my $file_content = `git --no-pager show $tag:$file 2>$null`;
-    return $file_content;
-}
-
-for (sort @output_files) {
-    print "$_\n";
+    local $/;
+    return scalar `git --no-pager show $tag:$file 2>$null`;
 }
 
-exit unless $diffs;
-
-for (sort @output_diffs) {
-    print "\n";
-    system "git --no-pager diff $tag_to_compare '$_'";
+if ($diffs) {
+    for (sort @diff) {
+       print "\n";
+       system "$diff_cmd '$_'";
+    }
 }
-