This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update ExtUtils-Install to CPAN version 2.14
[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"
6b44ec68 35 unless (-d ".git" || (exists $ENV{GIT_DIR} && -d $ENV{GIT_DIR}));
42e700c9 36
2385f340 37my $null = devnull();
68d2af03 38
e01fd32a 39unless (defined $tag_to_compare) {
d7d4eceb
GK
40 my $check = 'HEAD';
41 while(1) {
42 $check = `git describe --abbrev=0 $check 2>$null`;
43 chomp $check;
44 last unless $check =~ /-RC/;
17714d93 45 $check .= '~1';
d7d4eceb
GK
46 }
47 $tag_to_compare = $check;
e01fd32a
NC
48 # Thanks to David Golden for this suggestion.
49
e01fd32a
NC
50}
51
0f85f13d
HS
52unless (length $tag_to_compare) {
53 die "$0: Git found, but no Git tags found\n"
54 unless $tap;
55 print "1..0 # SKIP: Git found, but no Git tags found\n";
56 exit 0;
57}
58
68d2af03 59my $tag_exists = `git --no-pager tag -l $tag_to_compare 2>$null`;
42e700c9
MJ
60chomp $tag_exists;
61
76733a60
NC
62unless ($tag_exists eq $tag_to_compare) {
63 die "$0: '$tag_to_compare' is not a known Git tag\n" unless $tap;
64 print "1..0 # SKIP: '$tag_to_compare' is not a known Git tag\n";
65 exit 0;
66}
f1c5bace 67
844d3843
NC
68my %upstream_files;
69if ($exclude_upstream) {
3a06b4ed
NC
70 unshift @INC, 'Porting';
71 require Maintainers;
72
844d3843
NC
73 for my $m (grep {!defined $Maintainers::Modules{$_}{UPSTREAM}
74 or $Maintainers::Modules{$_}{UPSTREAM} ne 'blead'}
75 keys %Maintainers::Modules) {
76 $upstream_files{$_} = 1 for Maintainers::get_module_files($m);
2fb8ff88
DM
77 }
78}
79
88830c88
JH
80# Files to skip from the check for one reason or another,
81# usually because they pull in their version from some other file.
82my %skip;
477acd91 83@skip{
9de35bb2 84 'cpan/ExtUtils-Install/t/lib/MakeMaker/Test/Setup/BFD.pm', # just a test module
955b6d35
SH
85 'cpan/ExtUtils-MakeMaker/t/lib/MakeMaker/Test/Setup/BFD.pm', # just a test module
86 'cpan/ExtUtils-MakeMaker/t/lib/MakeMaker/Test/Setup/XS.pm', # just a test module
5173674b 87 'cpan/IO-Compress/lib/File/GlobMapper.pm', # upstream needs to supply $VERSION
da020b69
SH
88 'cpan/Math-BigInt/t/Math/BigFloat/Subclass.pm', # just a test module
89 'cpan/Math-BigInt/t/Math/BigInt/BareCalc.pm', # just a test module
90 'cpan/Math-BigInt/t/Math/BigInt/Scalar.pm', # just a test module
91 'cpan/Math-BigInt/t/Math/BigInt/Subclass.pm', # just a test module
92 'cpan/Math-BigRat/t/Math/BigRat/Test.pm', # just a test module
d42e1eb7 93 'cpan/podlators/t/lib/Test/Podlators.pm', # just a test module
77218c1e
CB
94 'cpan/podlators/t/lib/Test/RRA.pm', # just a test module
95 'cpan/podlators/t/lib/Test/RRA/Config.pm', # just a test module
130cad93 96 'cpan/version/t/coretests.pm', # just a test module
955b6d35
SH
97 'dist/Attribute-Handlers/demo/MyClass.pm', # it's just demonstration code
98 'dist/Exporter/lib/Exporter/Heavy.pm',
42e700c9
MJ
99 'lib/Carp/Heavy.pm',
100 'lib/Config.pm', # no version number but contents will vary
42e700c9 101 'win32/FindExt.pm',
477acd91 102} = ();
76733a60
NC
103
104# Files to skip just for particular version(s),
105# usually due to some # mix-up
106
f008f53b 107my %skip_versions = (
76733a60 108 # 'some/sample/file.pm' => [ '1.23', '1.24' ],
76733a60 109 );
76733a60 110
42e700c9
MJ
111my $skip_dirs = qr|^t/lib|;
112
96048c95
NC
113sub pm_file_from_xs {
114 my $xs = shift;
115
7ab1c1a4
NC
116 foreach my $try (sub {
117 # First try a .pm at the same level as the .xs file
118 # with the same basename
119 return shift =~ s/\.xs\z//r;
120 },
121 sub {
122 # Try for a (different) .pm at the same level, based
123 # on the directory name:
124 my ($path) = shift =~ m!^(.*)/!;
125 my ($last) = $path =~ m!([^-/]+)\z!;
126 return "$path/$last";
127 },
128 sub {
129 # Try to work out the extension's full package, and
130 # look for a .pm in lib/ based on that:
131 my ($path) = shift =~ m!^(.*)/!;
132 my ($last) = $path =~ m!([^/]+)\z!;
4421e1e9 133 $last = 'List-Util' if $last eq 'Scalar-List-Utils';
7ab1c1a4
NC
134 $last =~ tr !-!/!;
135 return "$path/lib/$last";
136 }) {
137 # For all cases, first look to see if the .pm file is generated.
138 my $base = $try->($xs);
139 return "${base}_pm.PL" if -f "${base}_pm.PL";
140 return "${base}.pm" if -f "${base}.pm";
141 }
42e700c9 142
96048c95
NC
143 die "No idea which .pm file corresponds to '$xs', so aborting";
144}
145
146# Key is the .pm file from which we check the version.
147# Value is a reference to an array of files to check for differences
148# The trivial case is a pure perl module, where the array holds one element,
149# the perl module's file. The "fun" comes with XS modules, and the real fun
150# with XS modules with more than one XS file, and "interesting" layouts.
151
152my %module_diffs;
153
7ac818b2 154foreach (`git --no-pager diff --name-only $tag_to_compare --diff-filter=ACMRTUXB`) {
96048c95
NC
155 chomp;
156 next unless m/^(.*)\//;
157 my $this_dir = $1;
158 next if $this_dir =~ $skip_dirs || exists $skip{$_};
159 next if exists $upstream_files{$_};
7ab1c1a4 160 if (/\.pm\z/ || m|^lib/.*\.pl\z| || /_pm\.PL\z/) {
96048c95 161 push @{$module_diffs{$_}}, $_;
e54eb2b6 162 } elsif (/\.xs\z/ && !/\bt\b/) {
96048c95
NC
163 push @{$module_diffs{pm_file_from_xs($_)}}, $_;
164 }
165}
42e700c9 166
96048c95 167unless (%module_diffs) {
76733a60
NC
168 print "1..1\nok 1 - No difference found\n" if $tap;
169 exit;
170}
171
96048c95 172printf "1..%d\n" => scalar keys %module_diffs if $tap;
8ecf5aeb 173print "#\n# Comparing against $tag_to_compare ....\n#\n" if $tap;
76733a60
NC
174
175my $count;
176my $diff_cmd = "git --no-pager diff $tag_to_compare ";
7ba8970d 177my $q = ($^O eq 'MSWin32' || $^O eq 'NetWare' || $^O eq 'VMS') ? '"' : "'";
76733a60 178my (@diff);
42e700c9 179
96048c95
NC
180foreach my $pm_file (sort keys %module_diffs) {
181 # git has already told us that the files differ, so no need to grab each as
182 # a blob from git, and do the comparison ourselves.
42e700c9
MJ
183 my $pm_version = eval {MM->parse_version($pm_file)};
184 my $orig_pm_content = get_file_from_git($pm_file, $tag_to_compare);
185 my $orig_pm_version = eval {MM->parse_version(\$orig_pm_content)};
63ffcb73 186 ++$count;
97a78671
NC
187
188 if (!defined $orig_pm_version || $orig_pm_version eq 'undef') { # sigh
40f7a2b9
FC
189 print "ok $count - SKIP Can't parse \$VERSION in $pm_file\n"
190 if $tap;
97a78671 191 } elsif (!defined $pm_version || $pm_version eq 'undef') {
db8086f1
JH
192 my $nok = "not ok $count - in $pm_file version was $orig_pm_version, now unparsable\n";
193 print $nok if $tap;
194 print STDERR "# $nok\n";
97a78671 195 } elsif ($pm_version ne $orig_pm_version) { # good
63ffcb73 196 print "ok $count - $pm_file\n" if $tap;
96048c95 197 } else {
76733a60 198 if ($tap) {
8ecf5aeb
DM
199 print "#\n# " . '-' x 75 . "\n"
200 . "# Version number ($pm_version) unchanged since"
201 . " $tag_to_compare, but contents have changed:\n#\n";
96048c95 202 foreach (sort @{$module_diffs{$pm_file}}) {
7ba8970d 203 print "# $_" for `$diff_cmd $q$_$q`;
76733a60 204 }
8ecf5aeb
DM
205 print "# " . '-' x 75 . "\n";
206
f008f53b
NC
207 if (exists $skip_versions{$pm_file}
208 and grep $pm_version eq $_, @{$skip_versions{$pm_file}}) {
63ffcb73 209 print "ok $count - SKIP $pm_file version $pm_version\n";
f008f53b 210 } else {
db8086f1
JH
211 my $nok = "not ok $count - $pm_file version $pm_version\n";
212 print $nok;
213 print STDERR "# $nok";
f008f53b 214 }
76733a60 215 } else {
96048c95 216 push @diff, @{$module_diffs{$pm_file}};
f5872097 217 print "$pm_file version $pm_version\n";
76733a60
NC
218 }
219 }
42e700c9
MJ
220}
221
222sub get_file_from_git {
223 my ($file, $tag) = @_;
96048c95 224 local $/;
f378d7a6
TC
225
226 use open IN => ':raw';
96048c95 227 return scalar `git --no-pager show $tag:$file 2>$null`;
42e700c9
MJ
228}
229
76733a60
NC
230if ($diffs) {
231 for (sort @diff) {
232 print "\n";
7ba8970d 233 system "$diff_cmd $q$_$q";
76733a60 234 }
2547c837 235}