This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Elide use of `grep`
[perl5.git] / Porting / sync-with-cpan
1 #!/usr/bin/env perl
2
3 =head1 NAME
4
5 Porting/sync-with-cpan - Synchronize with CPAN distributions
6
7 =head1 SYNOPSIS
8
9   perl Porting/sync-with-cpan <module>
10
11 where <module> is the name it appears in the C<%Modules> hash
12 of F<Porting/Maintainers.pl>
13
14 =head1 DESCRIPTION
15
16 Script to help out with syncing cpan distros.
17
18 Does the following:
19
20 =over 4
21
22 =item *
23
24 Fetches the package list from CPAN. Finds the current version of the given
25 package. [1]
26
27 =item *
28
29 Downloads the relevant tarball; unpacks the tarball. [1]
30
31 =item *
32
33 Clean out the old directory (C<git clean -dfx>)
34
35 =item *
36
37 Moves the old directory out of the way, moves the new directory in place.
38
39 =item *
40
41 Restores any F<.gitignore> file.
42
43 =item *
44
45 Removes files from C<@IGNORE> and C<EXCLUDED>
46
47 =item *
48
49 C<git add> any new files.
50
51 =item *
52
53 C<git rm> any files that are gone.
54
55 =item *
56
57 Remove the +x bit on files in F<t/>
58
59 =item *
60
61 Remove the +x bit on files that don't have it enabled in the current dir
62
63 =item *
64
65 Restore files mentioned in C<CUSTOMIZED>
66
67 =item *
68
69 Adds new files to F<MANIFEST>
70
71 =item *
72
73 Runs a C<make> (assumes a configure has been run)
74
75 =item *
76
77 Cleans up
78
79 =item *
80
81 Runs tests for the package
82
83 =item *
84
85 Runs the porting tests
86
87 =back
88
89 [1]  If the C<--tarball> option is given, then CPAN is not consulted.
90 C<--tarball> should be the path to the tarball; the version is extracted
91 from the filename -- but can be overwritten by the C<--version> option.
92
93 =head1 TODO
94
95 =over 4
96
97 =item *
98
99 Delete files from F<MANIFEST>
100
101 =item *
102
103 Update F<Porting/Maintainers.pl>
104
105 =item *
106
107 Optional, run a full test suite
108
109 =item *
110
111 Handle complicated C<FILES>
112
113 =back
114
115 This is an initial version; no attempt has been made yet to make this
116 portable. It shells out instead of trying to find a Perl solution.
117 In particular, it assumes git, perl, and make
118 to be available.
119
120 =cut
121
122
123 package Maintainers;
124
125 use 5.010;
126
127 use strict;
128 use warnings;
129 use Getopt::Long;
130 use Archive::Tar;
131 use File::Path qw( remove_tree );
132 use File::Find;
133 use Config qw( %Config );
134
135 $| = 1;
136
137 die "This does not look like a top level directory"
138      unless -d "cpan" && -d "Porting";
139
140 our @IGNORABLE;
141 our %Modules;
142
143 use autodie;
144
145 require "Porting/Maintainers.pl";
146
147 my %IGNORABLE    = map {$_ => 1} @IGNORABLE;
148
149 my $tmpdir= $ENV{ TEMP } // '/tmp';
150
151 my $package      = "02packages.details.txt";
152 my $package_url  = "http://www.cpan.org/modules/$package";
153 my $package_file = "$tmpdir/$package"; # this is a cache
154
155 my @problematic = (
156     'podlators', # weird CUSTOMIZED section due to .PL files
157 );
158
159
160 GetOptions ('tarball=s'  =>  \my $tarball,
161             'version=s'  =>  \my $version,
162              force       =>  \my $force,)
163         or  die "Failed to parse arguments";
164
165 die "Usage: $0 module [args] [cpan package]" unless @ARGV == 1 || @ARGV == 2;
166
167 sub find_type_f {
168     my @res;
169     find( { no_chdir => 1, wanted => sub {
170         my $file= $File::Find::name;
171         return unless -f $file;
172         push @res, $file
173     }}, @_ );
174     @res
175 };
176
177 # Equivalent of `chmod a-x`
178 sub de_exec {
179     for my $filename ( @_ ) {
180         my $mode= (stat $filename)[2] & 0777;
181         if( $mode & 0111 ) { # exec-bit set
182             chmod $mode & 0666, $filename;
183         };
184     }
185 }
186
187 sub make {
188     my @args= @_;
189     if( $^O eq 'MSWin32') {
190         chdir "Win32";
191         system "$Config{make} @args> ..\\make.log 2>&1" and die "Running make failed, see make.log";
192         chdir '..';
193     } else {
194         system "$Config{make} @args> make.log 2>&1" and die "Running make failed, see make.log";
195     };
196 };
197
198 my ($module)  = shift;
199 my  $cpan_mod = @ARGV ? shift : $module;
200
201
202 my  $info         = $Modules {$module} or die "Cannot find module $module";
203 my  $distribution = $$info {DISTRIBUTION};
204
205 my @files         = glob $$info {FILES};
206 if (!-d $files [0] || grep { $_ eq $module } @problematic) {
207     say "This looks like a setup $0 cannot handle (yet)";
208     unless ($force) {
209         say "Will not continue without a --force option";
210         exit 1;
211     }
212     say "--force is in effect, so we'll soldier on. Wish me luck!";
213 }
214
215
216 chdir "cpan";
217
218 my  $pkg_dir      = $files[0];
219     $pkg_dir      =~ s!.*/!!;
220
221 my ($old_version) = $distribution =~ /-([0-9.]+)\.tar\.gz/;
222
223 my  $o_module     = $module;
224 if ($cpan_mod =~ /-/ && $cpan_mod !~ /::/) {
225     $cpan_mod =~ s/-/::/g;
226 }
227
228 #
229 # Find the information from CPAN.
230 #
231 my $new_file;
232 my $new_version;
233 unless ($tarball) {
234     #
235     # Poor man's cache
236     #
237     unless (-f $package_file && -M $package_file < 1) {
238         eval {
239             require HTTP::Tiny;
240             my $http= HTTP::Tiny->new();
241             $http->mirror( $package_url => $package_file );
242             1
243         } or system wget => $package_url, '-qO', $package_file;
244     }
245
246     open my $fh, '<', $package_file;
247     (my $new_line) = grep {/^$cpan_mod/} <$fh> # Yes, this needs a lot of memory
248                      or die "Cannot find $cpan_mod on CPAN\n";
249     (undef, $new_version, my $new_path) = split ' ', $new_line;
250     if (defined $version) {
251         $new_path =~ s/-$new_version\./-$version\./;
252         $new_version = $version;
253     }
254     $new_file = (split '/', $new_path) [-1];
255
256     my $url = "http://search.cpan.org/CPAN/authors/id/$new_path";
257     say "Fetching $url";
258     #
259     # Fetch the new distro
260     #
261     eval {
262         require HTTP::Tiny;
263         my $http= HTTP::Tiny->new();
264         $http->mirror( $url => $new_file );
265         1
266     } or system wget => $url, '-qO', $new_file;
267 }
268 else {
269     $new_file     = $tarball;
270     $new_version  = $version // ($new_file =~ /-([0-9._]+)\.tar\.gz/) [0];
271 }
272
273 my  $old_dir      = "$pkg_dir-$old_version";
274
275 say "Cleaning out old directory";
276 system git => 'clean', '-dfxq', $pkg_dir;
277
278 say "Unpacking $new_file";
279 Archive::Tar->extract_archive( $new_file );
280
281 (my $new_dir = $new_file) =~ s/\.tar\.gz//;
282 # ensure 'make' will update all files
283 my $t= time;
284 for my $file (find_type_f($new_dir)) {
285     open(my $fh,">>$file") || die "Cannot write $file:$!";
286     close($fh);
287     utime($t,$t,$file);
288 };
289
290 say "Renaming directories";
291 rename $pkg_dir => $old_dir;
292
293 say "Creating new package directory";
294 mkdir $pkg_dir;
295
296 say "Populating new package directory";
297 my $map = $$info {MAP};
298 my @EXCLUDED_QR;
299 my %EXCLUDED_QQ;
300 if ($$info {EXCLUDED}) {
301     foreach my $entry (@{$$info {EXCLUDED}}) {
302         if (ref $entry) {push @EXCLUDED_QR => $entry}
303         else            {$EXCLUDED_QQ {$entry} = 1}
304     }
305 }
306
307 FILE: for my $file ( find_type_f( $new_dir )) {
308     my $old_file = $file;
309     $file =~ s{^$new_dir/}{};
310
311     next if $EXCLUDED_QQ{$file};
312     for my $qr (@EXCLUDED_QR) {
313         next FILE if $file =~ $qr;
314     }
315
316     if ( $map ) {
317         for my $key ( sort { length $b <=> length $a } keys %$map ) {
318             my $val = $map->{$key};
319             last if $file =~ s/^$key/$val/;
320         }
321     }
322     else {
323         $file = $files[0] . '/' . $file;
324     }
325
326     if ( $file =~ m{^cpan/} ) {
327         $file =~ s{^cpan/}{};
328     }
329     else {
330         $file = '../' . $file;
331     }
332
333     my $prefix = '';
334     my @parts = split '/', $file;
335     pop @parts;
336     for my $part (@parts) {
337         $prefix .= '/' if $prefix;
338         $prefix .= $part;
339         mkdir $prefix unless -d $prefix;
340     }
341
342     rename $old_file => $file;
343 }
344 remove_tree( $new_dir );
345
346 if (-f "$old_dir/.gitignore") {
347     say "Restoring .gitignore";
348     system git => 'checkout', "$pkg_dir/.gitignore";
349 }
350
351 my @new_files = find_type_f( $pkg_dir );
352 @new_files = grep {$_ ne $pkg_dir} @new_files;
353 s!^[^/]+/!! for @new_files;
354 my %new_files = map {$_ => 1} @new_files;
355
356 my @old_files = find_type_f( $old_dir );
357 @old_files = grep {$_ ne $old_dir} @old_files;
358 s!^[^/]+/!! for @old_files;
359 my %old_files = map {$_ => 1} @old_files;
360
361 my @delete;
362 my @commit;
363 my @gone;
364 FILE:
365 foreach my $file (@new_files) {
366     next if -d "$pkg_dir/$file";   # Ignore directories.
367     next if $old_files {$file};    # It's already there.
368     if ($IGNORABLE {$file}) {
369         push @delete => $file;
370         next;
371     }
372     push @commit => $file;
373 }
374 foreach my $file (@old_files) {
375     next if -d "$old_dir/$file";
376     next if $new_files {$file};
377     push @gone => $file;
378 }
379
380 #
381 # Find all files with an exec bit
382 #
383 my @exec = find_type_f( $pkg_dir );
384 my @de_exec;
385 foreach my $file (@exec) {
386     # Remove leading dir
387     $file =~ s!^[^/]+/!!;
388     if ($file =~ m!^t/!) {
389         push @de_exec => $file;
390         next;
391     }
392     # Check to see if the file exists; if it doesn't and doesn't have
393     # the exec bit, remove it.
394     if ($old_files {$file}) {
395         unless (-x "$old_dir/$file") {
396             push @de_exec => $file;
397         }
398     }
399 }
400
401 #
402 # No need to change the +x bit on files that will be deleted.
403 #
404 if (@de_exec && @delete) {
405     my %delete = map {+"$pkg_dir/$_" => 1} @delete;
406     @de_exec = grep {!$delete {$_}} @de_exec;
407 }
408
409 say "unlink $pkg_dir/$_" for @delete;
410 say "git add $pkg_dir/$_" for @commit;
411 say "git rm -f $pkg_dir/$_" for @gone;
412 say "chmod a-x $pkg_dir/$_" for @de_exec;
413
414 print "Hit return to continue; ^C to abort "; <STDIN>;
415
416 unlink "$pkg_dir/$_"                      for @delete;
417 system git   => 'add', "$pkg_dir/$_"      for @commit;
418 system git   => 'rm', '-f', "$pkg_dir/$_" for @gone;
419 de_exec( "$pkg_dir/$_" )                  for @de_exec;
420
421 #
422 # Restore anything that is customized.
423 # We don't really care whether we've deleted the file - since we
424 # do a git restore, it's going to be resurrected if necessary.
425 #
426 if ($$info {CUSTOMIZED}) {
427     say "Restoring customized files";
428     foreach my $file (@{$$info {CUSTOMIZED}}) {
429         system git => "checkout", "$pkg_dir/$file";
430     }
431 }
432
433 chdir "..";
434 if (@commit) {
435     say "Fixing MANIFEST";
436     my $MANIFEST      = "MANIFEST";
437     my $MANIFEST_SORT = "$MANIFEST.sorted";
438     open my $fh, ">>", $MANIFEST;
439     say $fh "cpan/$pkg_dir/$_" for @commit;
440     close $fh;
441     system perl => "Porting/manisort", '--output', $MANIFEST_SORT;
442     rename $MANIFEST_SORT => $MANIFEST;
443 }
444
445
446 print "Running a make ... ";
447 # Prepare for running (selected) tests
448 make 'test-prep';
449 print "done\n";
450
451 #
452 # Must clean up, or else t/porting/FindExt.t will fail.
453 # Note that we can always retrieve the original directory with a git checkout.
454 #
455 print "About to clean up; hit return or abort (^C) "; <STDIN>;
456
457 remove_tree( "cpan/$old_dir" );
458 unlink "cpan/$new_file" unless $tarball;
459
460 #
461 # Run the tests. First the test belonging to the module, followed by the
462 # the tests in t/porting
463 #
464 chdir "t";
465 say "Running module tests";
466 my @test_files = grep { /\.t$/ } find_type_f( $pkg_dir );
467 my $exe_dir= $^O =~ /MSWin/ ? "..\\" : './';
468 my $output = `${exe_dir}perl$Config{_exe} TEST @test_files`;
469 unless ($output =~ /All tests successful/) {
470     say $output;
471     exit 1;
472 }
473
474 print "Running tests in t/porting ";
475 my @tests = glob 'porting/*.t';
476 chomp @tests;
477 my @failed;
478 foreach my $t (@tests) {
479     my @not = grep {!/# TODO/ }
480               grep { /^not/ }
481               `${exe_dir}perl -I../lib -I.. $t`;
482     print @not ? '!' : '.';
483     push @failed => $t if @not;
484 }
485 print "\n";
486 say "Failed tests: @failed" if @failed;
487
488
489 say "Attempting to update Maintainers.pl";
490 chdir '..';
491
492 open my $Maintainers_pl, '<', 'Porting/Maintainers.pl';
493 open my $new_Maintainers_pl, '>', 'Maintainers.pl';
494
495 my $found;
496 my $in_mod_section;
497 while (<$Maintainers_pl>) {
498     if (!$found) {
499         if ($in_mod_section) {
500             if (/DISTRIBUTION/) {
501                 if (s/\Q$old_version/$new_version/) {
502                     $found = 1;
503                 }
504             }
505
506             if (/^    }/) {
507                 $in_mod_section = 0;
508             }
509         }
510
511         if (/\Q$cpan_mod/) {
512             $in_mod_section = 1;
513         }
514     }
515
516     print $new_Maintainers_pl $_;
517 }
518
519 if ($found) {
520     unlink 'Porting/Maintainers.pl';
521     rename 'Maintainers.pl' => 'Porting/Maintainers.pl';
522     chmod 0755 => 'Porting/Maintainers.pl';
523 }
524 else {
525     say "Could not update Porting/Maintainers.pl.";
526     say "Make sure you update this by hand before committing.";
527 }
528
529 say "$o_module is now version $new_version";
530 say "Now you ought to run a make; make test ...";
531
532
533 __END__