This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
test.pl: allow for undefs in eq_hash
[perl5.git] / Porting / cmpVERSION.pl
CommitLineData
f1c5bace
JH
1#!/usr/bin/perl -w
2
96048c95 3#
42e700c9
MJ
4# cmpVERSION - compare the current Perl source tree and a given tag
5# for modules that have identical version numbers but different contents.
f1c5bace 6#
2fb8ff88 7# with -d option, output the diffs too
844d3843
NC
8# with -x option, exclude files from modules where blead is not upstream
9#
10# (after all, there are tools like core-cpan-diff that can already deal with
11# them)
2547c837 12#
42e700c9 13# Original by slaven@rezic.de, modified by jhi and matt.w.johnson@gmail.com.
76733a60 14# Adaptation to produce TAP by Abigail, folded back into this file by Nicholas
f1c5bace
JH
15
16use strict;
96048c95 17use 5.006;
f1c5bace
JH
18
19use ExtUtils::MakeMaker;
e01fd32a 20use File::Spec::Functions qw(devnull);
00ad0422 21use Getopt::Long;
2547c837 22
76733a60 23my ($diffs, $exclude_upstream, $tag_to_compare, $tap);
00ad0422 24unless (GetOptions('diffs' => \$diffs,
844d3843 25 'exclude|x' => \$exclude_upstream,
e01fd32a 26 'tag=s' => \$tag_to_compare,
76733a60 27 'tap' => \$tap,
e01fd32a 28 ) && @ARGV == 0) {
76733a60 29 die "usage: $0 [ -d -x --tag TAG --tap]";
2547c837 30}
f1c5bace 31
e01fd32a
NC
32die "$0: This does not look like a Perl directory\n"
33 unless -f "perl.h" && -d "Porting";
34die "$0: 'This is a Perl directory but does not look like Git working directory\n"
35 unless -d ".git";
42e700c9 36
2385f340 37my $null = devnull();
68d2af03 38
e01fd32a
NC
39unless (defined $tag_to_compare) {
40 # Thanks to David Golden for this suggestion.
41
42 $tag_to_compare = `git describe --abbrev=0`;
43 chomp $tag_to_compare;
44}
45
68d2af03 46my $tag_exists = `git --no-pager tag -l $tag_to_compare 2>$null`;
42e700c9
MJ
47chomp $tag_exists;
48
76733a60
NC
49unless ($tag_exists eq $tag_to_compare) {
50 die "$0: '$tag_to_compare' is not a known Git tag\n" unless $tap;
51 print "1..0 # SKIP: '$tag_to_compare' is not a known Git tag\n";
52 exit 0;
53}
f1c5bace 54
844d3843
NC
55my %upstream_files;
56if ($exclude_upstream) {
3a06b4ed
NC
57 unshift @INC, 'Porting';
58 require Maintainers;
59
844d3843
NC
60 for my $m (grep {!defined $Maintainers::Modules{$_}{UPSTREAM}
61 or $Maintainers::Modules{$_}{UPSTREAM} ne 'blead'}
62 keys %Maintainers::Modules) {
63 $upstream_files{$_} = 1 for Maintainers::get_module_files($m);
2fb8ff88
DM
64 }
65}
66
88830c88
JH
67# Files to skip from the check for one reason or another,
68# usually because they pull in their version from some other file.
69my %skip;
477acd91 70@skip{
42e700c9
MJ
71 'lib/Carp/Heavy.pm',
72 'lib/Config.pm', # no version number but contents will vary
73 'lib/Exporter/Heavy.pm',
74 'win32/FindExt.pm',
477acd91 75} = ();
76733a60
NC
76
77# Files to skip just for particular version(s),
78# usually due to some # mix-up
79
f008f53b 80my %skip_versions = (
76733a60
NC
81 # 'some/sample/file.pm' => [ '1.23', '1.24' ],
82 'dist/threads/lib/threads.pm' => [ '1.83' ],
83 );
76733a60 84
42e700c9
MJ
85my $skip_dirs = qr|^t/lib|;
86
96048c95
NC
87sub pm_file_from_xs {
88 my $xs = shift;
89
7ab1c1a4
NC
90 foreach my $try (sub {
91 # First try a .pm at the same level as the .xs file
92 # with the same basename
93 return shift =~ s/\.xs\z//r;
94 },
95 sub {
96 # Try for a (different) .pm at the same level, based
97 # on the directory name:
98 my ($path) = shift =~ m!^(.*)/!;
99 my ($last) = $path =~ m!([^-/]+)\z!;
100 return "$path/$last";
101 },
102 sub {
103 # Try to work out the extension's full package, and
104 # look for a .pm in lib/ based on that:
105 my ($path) = shift =~ m!^(.*)/!;
106 my ($last) = $path =~ m!([^/]+)\z!;
107 $last =~ tr !-!/!;
108 return "$path/lib/$last";
109 }) {
110 # For all cases, first look to see if the .pm file is generated.
111 my $base = $try->($xs);
112 return "${base}_pm.PL" if -f "${base}_pm.PL";
113 return "${base}.pm" if -f "${base}.pm";
114 }
42e700c9 115
96048c95
NC
116 die "No idea which .pm file corresponds to '$xs', so aborting";
117}
118
119# Key is the .pm file from which we check the version.
120# Value is a reference to an array of files to check for differences
121# The trivial case is a pure perl module, where the array holds one element,
122# the perl module's file. The "fun" comes with XS modules, and the real fun
123# with XS modules with more than one XS file, and "interesting" layouts.
124
125my %module_diffs;
126
7ac818b2 127foreach (`git --no-pager diff --name-only $tag_to_compare --diff-filter=ACMRTUXB`) {
96048c95
NC
128 chomp;
129 next unless m/^(.*)\//;
130 my $this_dir = $1;
131 next if $this_dir =~ $skip_dirs || exists $skip{$_};
132 next if exists $upstream_files{$_};
7ab1c1a4 133 if (/\.pm\z/ || m|^lib/.*\.pl\z| || /_pm\.PL\z/) {
96048c95 134 push @{$module_diffs{$_}}, $_;
e54eb2b6 135 } elsif (/\.xs\z/ && !/\bt\b/) {
96048c95
NC
136 push @{$module_diffs{pm_file_from_xs($_)}}, $_;
137 }
138}
42e700c9 139
96048c95 140unless (%module_diffs) {
76733a60
NC
141 print "1..1\nok 1 - No difference found\n" if $tap;
142 exit;
143}
144
96048c95 145printf "1..%d\n" => scalar keys %module_diffs if $tap;
76733a60
NC
146
147my $count;
148my $diff_cmd = "git --no-pager diff $tag_to_compare ";
7ba8970d 149my $q = ($^O eq 'MSWin32' || $^O eq 'NetWare' || $^O eq 'VMS') ? '"' : "'";
76733a60 150my (@diff);
42e700c9 151
96048c95
NC
152foreach my $pm_file (sort keys %module_diffs) {
153 # git has already told us that the files differ, so no need to grab each as
154 # a blob from git, and do the comparison ourselves.
42e700c9
MJ
155 my $pm_version = eval {MM->parse_version($pm_file)};
156 my $orig_pm_content = get_file_from_git($pm_file, $tag_to_compare);
157 my $orig_pm_version = eval {MM->parse_version(\$orig_pm_content)};
63ffcb73 158 ++$count;
97a78671
NC
159
160 if (!defined $orig_pm_version || $orig_pm_version eq 'undef') { # sigh
40f7a2b9
FC
161 print "ok $count - SKIP Can't parse \$VERSION in $pm_file\n"
162 if $tap;
97a78671
NC
163 } elsif (!defined $pm_version || $pm_version eq 'undef') {
164 print "not ok $count - in $pm_file version was $orig_pm_version, now unparsable\n" if $tap;
165 } elsif ($pm_version ne $orig_pm_version) { # good
63ffcb73 166 print "ok $count - $pm_file\n" if $tap;
96048c95 167 } else {
76733a60 168 if ($tap) {
96048c95 169 foreach (sort @{$module_diffs{$pm_file}}) {
7ba8970d 170 print "# $_" for `$diff_cmd $q$_$q`;
76733a60 171 }
f008f53b
NC
172 if (exists $skip_versions{$pm_file}
173 and grep $pm_version eq $_, @{$skip_versions{$pm_file}}) {
63ffcb73 174 print "ok $count - SKIP $pm_file version $pm_version\n";
f008f53b 175 } else {
63ffcb73 176 print "not ok $count - $pm_file\n";
f008f53b 177 }
76733a60 178 } else {
96048c95 179 push @diff, @{$module_diffs{$pm_file}};
76733a60
NC
180 print "$pm_file\n";
181 }
182 }
42e700c9
MJ
183}
184
185sub get_file_from_git {
186 my ($file, $tag) = @_;
96048c95
NC
187 local $/;
188 return scalar `git --no-pager show $tag:$file 2>$null`;
42e700c9
MJ
189}
190
76733a60
NC
191if ($diffs) {
192 for (sort @diff) {
193 print "\n";
7ba8970d 194 system "$diff_cmd $q$_$q";
76733a60 195 }
2547c837 196}