#!/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.
#
# 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;
die "$0: This does not look like a Perl directory\n"
unless -f "perl.h" && -d "Porting";
die "$0: 'This is a Perl directory but does not look like Git working directory\n"
- unless -d ".git";
+ unless (-d ".git" || (exists $ENV{GIT_DIR} && -d $ENV{GIT_DIR}));
my $null = devnull();
unless (defined $tag_to_compare) {
+ my $check = 'HEAD';
+ while(1) {
+ $check = `git describe --abbrev=0 $check 2>$null`;
+ chomp $check;
+ last unless $check =~ /-RC/;
+ $check .= '^';
+ }
+ $tag_to_compare = $check;
# Thanks to David Golden for this suggestion.
- $tag_to_compare = `git describe --abbrev=0`;
- chomp $tag_to_compare;
+}
+
+unless (length $tag_to_compare) {
+ die "$0: Git found, but no Git tags found\n"
+ unless $tap;
+ print "1..0 # SKIP: Git found, but no Git tags found\n";
+ exit 0;
}
my $tag_exists = `git --no-pager tag -l $tag_to_compare 2>$null`;
# usually because they pull in their version from some other file.
my %skip;
@skip{
+ 'cpan/ExtUtils-MakeMaker/t/lib/MakeMaker/Test/Setup/BFD.pm', # just a test module
+ 'cpan/ExtUtils-MakeMaker/t/lib/MakeMaker/Test/Setup/XS.pm', # just a test module
+ 'dist/Attribute-Handlers/demo/MyClass.pm', # it's just demonstration code
+ 'dist/Exporter/lib/Exporter/Heavy.pm',
'lib/Carp/Heavy.pm',
'lib/Config.pm', # no version number but contents will vary
- 'lib/Exporter/Heavy.pm',
'win32/FindExt.pm',
} = ();
# Files to skip just for particular version(s),
# usually due to some # mix-up
-my %skip_versions;
-if ($tap) {
- %skip_versions
- = (
+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;
+sub pm_file_from_xs {
+ my $xs = shift;
+
+ foreach my $try (sub {
+ # First try a .pm at the same level as the .xs file
+ # with the same basename
+ return shift =~ s/\.xs\z//r;
+ },
+ sub {
+ # Try for a (different) .pm at the same level, based
+ # on the directory name:
+ my ($path) = shift =~ m!^(.*)/!;
+ my ($last) = $path =~ m!([^-/]+)\z!;
+ return "$path/$last";
+ },
+ sub {
+ # Try to work out the extension's full package, and
+ # look for a .pm in lib/ based on that:
+ my ($path) = shift =~ m!^(.*)/!;
+ my ($last) = $path =~ m!([^/]+)\z!;
+ $last = 'List-Util' if $last eq 'Scalar-List-Utils';
+ $last =~ tr !-!/!;
+ return "$path/lib/$last";
+ }) {
+ # For all cases, first look to see if the .pm file is generated.
+ my $base = $try->($xs);
+ return "${base}_pm.PL" if -f "${base}_pm.PL";
+ return "${base}.pm" if -f "${base}.pm";
+ }
-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;
+ die "No idea which .pm file corresponds to '$xs', so aborting";
+}
-unless (@module_diffs) {
+# 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| || /_pm\.PL\z/) {
+ push @{$module_diffs{$_}}, $_;
+ } elsif (/\.xs\z/ && !/\bt\b/) {
+ push @{$module_diffs{pm_file_from_xs($_)}}, $_;
+ }
+}
+
+unless (%module_diffs) {
print "1..1\nok 1 - No difference found\n" if $tap;
exit;
}
-printf "1..%d\n" => scalar @module_diffs if $tap;
+printf "1..%d\n" => scalar keys %module_diffs if $tap;
my $count;
my $diff_cmd = "git --no-pager diff $tag_to_compare ";
+my $q = ($^O eq 'MSWin32' || $^O eq 'NetWare' || $^O eq 'VMS') ? '"' : "'";
my (@diff);
-foreach my $pm_file (sort @module_diffs) {
- # --tap does diff inline, --diff does it at the end.
- @diff = () if $tap;
- (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;
- }
- next if ($pm_eq && $xs_eq);
+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;
- next if exists $skip_versions{$pm_file}
- and grep $pm_version eq $_, @{$skip_versions{$pm_file}};
- push @diff, $pm_file unless $pm_eq;
- push @diff, $xs_file unless $xs_eq;
-}
-continue {
- if (@diff) {
+ ++$count;
+
+ if (!defined $orig_pm_version || $orig_pm_version eq 'undef') { # sigh
+ print "ok $count - SKIP Can't parse \$VERSION in $pm_file\n"
+ if $tap;
+ } elsif (!defined $pm_version || $pm_version eq 'undef') {
+ print "not ok $count - in $pm_file version was $orig_pm_version, now unparsable\n" if $tap;
+ } elsif ($pm_version ne $orig_pm_version) { # good
+ print "ok $count - $pm_file\n" if $tap;
+ } else {
if ($tap) {
- foreach (@diff) {
- print "# $_" for `$diff_cmd '$_'`;
+ foreach (sort @{$module_diffs{$pm_file}}) {
+ print "# $_" for `$diff_cmd $q$_$q`;
+ }
+ if (exists $skip_versions{$pm_file}
+ and grep $pm_version eq $_, @{$skip_versions{$pm_file}}) {
+ print "ok $count - SKIP $pm_file version $pm_version\n";
+ } else {
+ print "not ok $count - $pm_file\n";
}
- printf "not ok %d - %s\n", ++$count, $pm_file;
} else {
+ push @diff, @{$module_diffs{$pm_file}};
print "$pm_file\n";
}
}
- elsif ($tap) {
- printf "ok %d - %s\n", ++$count, $pm_file;
- }
-}
-
-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;
}
sub get_file_from_git {
my ($file, $tag) = @_;
- local $/ = undef;
- my $file_content = `git --no-pager show $tag:$file 2>$null`;
- return $file_content;
+ local $/;
+
+ use open IN => ':raw';
+ return scalar `git --no-pager show $tag:$file 2>$null`;
}
if ($diffs) {
for (sort @diff) {
print "\n";
- system "$diff_cmd '$_'";
+ system "$diff_cmd $q$_$q";
}
}