4 # cmpVERSION - compare the current Perl source tree and a given tag
5 # for modules that have identical version numbers but different contents.
7 # with -d option, output the diffs too
8 # with -x option, exclude files from modules where blead is not upstream
10 # (after all, there are tools like core-cpan-diff that can already deal with
13 # Original by slaven@rezic.de, modified by jhi and matt.w.johnson@gmail.com.
14 # Adaptation to produce TAP by Abigail, folded back into this file by Nicholas
19 use ExtUtils::MakeMaker;
20 use File::Spec::Functions qw(devnull);
23 my ($diffs, $exclude_upstream, $tag_to_compare, $tap);
24 unless (GetOptions('diffs' => \$diffs,
25 'exclude|x' => \$exclude_upstream,
26 'tag=s' => \$tag_to_compare,
29 die "usage: $0 [ -d -x --tag TAG --tap]";
32 die "$0: This does not look like a Perl directory\n"
33 unless -f "perl.h" && -d "Porting";
34 die "$0: 'This is a Perl directory but does not look like Git working directory\n"
39 unless (defined $tag_to_compare) {
40 # Thanks to David Golden for this suggestion.
42 $tag_to_compare = `git describe --abbrev=0`;
43 chomp $tag_to_compare;
46 my $tag_exists = `git --no-pager tag -l $tag_to_compare 2>$null`;
49 unless ($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";
56 if ($exclude_upstream) {
57 unshift @INC, 'Porting';
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);
67 # Files to skip from the check for one reason or another,
68 # usually because they pull in their version from some other file.
72 'lib/Config.pm', # no version number but contents will vary
73 'lib/Exporter/Heavy.pm',
77 # Files to skip just for particular version(s),
78 # usually due to some # mix-up
81 # 'some/sample/file.pm' => [ '1.23', '1.24' ],
82 'dist/threads/lib/threads.pm' => [ '1.83' ],
85 my $skip_dirs = qr|^t/lib|;
90 # First try a .pm at the same level as the .xs file, with the same basename
95 # Try for a (different) .pm at the same level, based on the directory name:
96 my ($path) = $xs =~ m!^(.*)/!;
97 my ($last) = $path =~ m!([^-/]+)\z!;
98 $pm = "$path/$last.pm";
101 # Try to work out the extension's full package, and look for a .pm in lib/
103 ($last) = $path =~ m!([^/]+)\z!;
105 $pm = "$path/lib/$last.pm";
106 return $pm if -f $pm;
108 die "No idea which .pm file corresponds to '$xs', so aborting";
111 # Key is the .pm file from which we check the version.
112 # Value is a reference to an array of files to check for differences
113 # The trivial case is a pure perl module, where the array holds one element,
114 # the perl module's file. The "fun" comes with XS modules, and the real fun
115 # with XS modules with more than one XS file, and "interesting" layouts.
119 foreach (`git --no-pager diff --name-only $tag_to_compare --diff-filter=ACMRTUXB`) {
121 next unless m/^(.*)\//;
123 next if $this_dir =~ $skip_dirs || exists $skip{$_};
124 next if exists $upstream_files{$_};
126 push @{$module_diffs{$_}}, $_;
128 push @{$module_diffs{pm_file_from_xs($_)}}, $_;
132 unless (%module_diffs) {
133 print "1..1\nok 1 - No difference found\n" if $tap;
137 printf "1..%d\n" => scalar keys %module_diffs if $tap;
140 my $diff_cmd = "git --no-pager diff $tag_to_compare ";
143 foreach my $pm_file (sort keys %module_diffs) {
144 # git has already told us that the files differ, so no need to grab each as
145 # a blob from git, and do the comparison ourselves.
146 my $pm_version = eval {MM->parse_version($pm_file)};
147 my $orig_pm_content = get_file_from_git($pm_file, $tag_to_compare);
148 my $orig_pm_version = eval {MM->parse_version(\$orig_pm_content)};
150 if ((!defined $pm_version || !defined $orig_pm_version)
151 || ($pm_version eq 'undef' || $orig_pm_version eq 'undef') # sigh
152 || ($pm_version ne $orig_pm_version) # good
154 printf "ok %d - %s\n", ++$count, $pm_file if $tap;
157 foreach (sort @{$module_diffs{$pm_file}}) {
158 print "# $_" for `$diff_cmd '$_'`;
160 if (exists $skip_versions{$pm_file}
161 and grep $pm_version eq $_, @{$skip_versions{$pm_file}}) {
162 printf "ok %d - SKIP $pm_file version $pm_version\n", ++$count;
164 printf "not ok %d - %s\n", ++$count, $pm_file;
167 push @diff, @{$module_diffs{$pm_file}};
173 sub get_file_from_git {
174 my ($file, $tag) = @_;
176 return scalar `git --no-pager show $tag:$file 2>$null`;
182 system "$diff_cmd '$_'";