t/cvs.t

   1 #!/usr/bin/perl
   2 use warnings;
   3 use strict;
   4 use Test::More; my $total_tests = 41;
   5 use IkiWiki;
   6
   7 my $default_test_methods = '^test_*';
   8 my @required_programs = qw(
   9         cvs
  10         cvsps
  11 );
  12 my @required_modules = qw(
  13         File::chdir
  14         File::MimeInfo
  15         Date::Parse
  16         File::Temp
  17         File::ReadBackwards
  18 );
  19 my $dir = "/tmp/ikiwiki-test-cvs.$$";
  20
  21 # TESTS FOR GENERAL META-BEHAVIOR
  22
  23 sub test_web_comments {
  24         # how much of the web-edit workflow are we actually testing?
  25         # because we want to test comments:
  26         # - when the first comment for page.mdwn is added, and page/ is
  27         #   created to hold the comment, page/ isn't added to CVS control,
  28         #   so the comment isn't either
  29         # - side effect for moderated comments: after approval they
  30         #   show up normally AND are still pending, too
  31         # - comments.pm treats rcs_commit_staged() as returning conflicts?
  32 }
  33
  34 sub test_chdir_magic {
  35         # cvs.pm operations are always occurring inside $config{srcdir}
  36         # other ikiwiki operations are occurring wherever, and are unaffected
  37         # when are we bothering with "local $CWD" and when aren't we?
  38 }
  39
  40 sub test_cvs_info {
  41         # inspect "Repository revision" (used in code)
  42         # inspect "Sticky Options" (used in tests to verify existence of "-kb")
  43 }
  44
  45 sub test_cvs_run_cvs {
  46         # extract the stdout-redirect thing
  47         # - prove that it silences stdout
  48         # - prove that stderr comes through just fine
  49         # prove that when cvs exits nonzero (fail), function exits false
  50         # prove that when cvs exits zero (success), function exits true
  51         # always pass -f, just in case
  52         # steal from git.pm: safe_git(), run_or_{die,cry,non}
  53         # - open() instead of system()
  54         # always call cvs_run_cvs(), don't ever run 'cvs' directly
  55 }
  56
  57 sub test_cvs_run_cvsps {
  58         # parameterize command like run_cvs()
  59         # expose config vars for e.g. "--cvs-direct -z 30"
  60         # always pass -x (unless proven otherwise)
  61         # always pass -b HEAD (configurable like gitmaster_branch?)
  62 }
  63
  64 sub test_cvs_parse_cvsps {
  65         # extract method from rcs_recentchanges
  66         # document expected changeset format
  67         # document expected changeset delimiter
  68         # try: cvsps -q -x -p && ls | sort -rn | head -100
  69         # - benchmark against current impl (that uses File::ReadBackwards)
  70 }
  71
  72 sub test_cvs_parse_log_accum {
  73         # add new, preferred method for rcs_recentchanges to use
  74         # teach log_accum to record commits (into transient?)
  75         # script cvsps to bootstrap (or replace?) commit history
  76         # teach ikiwiki-makerepo to set up log_accum and commit_prep
  77         # why are NetBSD commit mails unreliable?
  78         # - is it working for CVS commits and failing for web commits?
  79 }
  80
  81 sub test_cvs_is_controlling {
  82         # with no args:
  83         # - if srcdir is in CVS, return true
  84         # - else, return false
  85         # with a dir arg:
  86         # - if dir is in CVS, return true
  87         # - else, return false
  88         # with a file arg:
  89         # - is there anything that wants the answer? if so, answer
  90         # - else, die
  91 }
  92
  93
  94 # TESTS FOR GENERAL PLUGIN API CALLS
  95
  96 sub test_checkconfig {
  97         # undef cvspath, expect "ikiwiki"
  98         # define cvspath normally, get it back
  99         # define cvspath in a subdir, get it back?
 100         # define cvspath with extra slashes, get sanitized version back
 101         # - yoink test_extra_path_slashes
 102         # undef cvs_wrapper, expect $config{wrappers} same size as before
 103
 104         my $initial_cvspath = $config{cvspath};
 105         $config{cvspath} = "/ikiwiki//";
 106         IkiWiki::checkconfig();
 107         is(
 108                 $config{cvspath},
 109                 $initial_cvspath,
 110                 q{rcs_recentchanges assumes checkconfig has sanitized cvspath},
 111         );
 112 }
 113
 114 sub test_getsetup {
 115         # anything worth testing?
 116 }
 117
 118 sub test_genwrapper {
 119         # testable directly? affects rcs_add, but are we exercising this?
 120 }
 121
 122
 123 # TESTS FOR VCS PLUGIN API CALLS
 124
 125 sub test_rcs_update {
 126         # can it assume we're under CVS control? or must it check?
 127         # anything else worth testing?
 128 }
 129
 130 sub test_rcs_prepedit {
 131         # can it assume we're under CVS control? or must it check?
 132         # for existing file, returns latest revision in repo
 133         # - what's this used for? should it return latest revision in checkout?
 134         # for new file, returns empty string
 135 }
 136
 137 sub test_rcs_commit {
 138         # can it assume we're under CVS control? or must it check?
 139         # if someone else changed the page since rcs_prepedit was called:
 140         # - try to merge into our working copy
 141         # - if merge succeeds, proceed to commit
 142         # - else, return page content with the conflict markers in it
 143         # commit:
 144         # - if success, return undef
 145         # - else, revert + return content with the conflict markers in it
 146         # git.pm receives "session" param -- useful here?
 147         # web commits start with "web commit {by,from} "
 148         # seeing File::chdir errors on commit?
 149 }
 150
 151 sub test_rcs_commit_staged {
 152         # if commit succeeds, return undef
 153         # else, warn and return error message (really? or just non-undef?)
 154 }
 155
 156 sub test_rcs_add {
 157         my @changes = IkiWiki::rcs_recentchanges(3);
 158         is_total_number_of_changes(\@changes, 0);
 159
 160         my $message = "add a top-level ASCII (non-UTF-8) page via VCS API";
 161         my $file = q{test0.mdwn};
 162         add_and_commit($file, $message, q{* some plain ASCII text});
 163         is_newly_added($file);
 164         is_in_keyword_substitution_mode($file, undef);
 165         @changes = IkiWiki::rcs_recentchanges(3);
 166         is_total_number_of_changes(\@changes, 1);
 167         is_most_recent_change(\@changes, stripext($file), $message);
 168
 169         $message = "add a top-level dir via VCS API";
 170         my $dir1 = q{test3};
 171         can_mkdir($dir1);
 172         IkiWiki::rcs_add($dir1);
 173         # XXX test that the wrapper hangs here without our genwrapper()
 174         # XXX test that the wrapper doesn't hang here with it
 175         @changes = IkiWiki::rcs_recentchanges(3);
 176         is_total_number_of_changes(\@changes, 1);       # despite the dir add
 177         IkiWiki::rcs_commit(
 178                 file => $dir1,
 179                 message => $message,
 180                 token => "oom",
 181         );
 182         @changes = IkiWiki::rcs_recentchanges(3);
 183         is_total_number_of_changes(\@changes, 1);       # dirs aren't tracked
 184
 185         $message = "add a non-ASCII (UTF-8) text file in an un-added dir";
 186         can_mkdir($_) for (qw(test4 test4/test5));
 187         $file = q{test4/test5/test1.mdwn};
 188         add_and_commit($file, $message, readfile("t/test1.mdwn"));
 189         is_newly_added($file);
 190         is_in_keyword_substitution_mode($file, undef);
 191         @changes = IkiWiki::rcs_recentchanges(3);
 192         is_total_number_of_changes(\@changes, 2);
 193         is_most_recent_change(\@changes, stripext($file), $message);
 194
 195         $message = "add a binary file in an un-added dir, and commit_staged";
 196         can_mkdir(q{test6});
 197         $file = q{test6/test7.ico};
 198         my $bindata_in = readfile("doc/favicon.ico", 1);
 199         my $bindata_out = sub { readfile($config{srcdir} . "/$file", 1) };
 200         writefile($file, $config{srcdir}, $bindata_in, 1);
 201         is(&$bindata_out(), $bindata_in, q{binary files match before commit});
 202         IkiWiki::rcs_add($file);
 203         IkiWiki::rcs_commit_staged(message => $message);
 204         is_newly_added($file);
 205         is_in_keyword_substitution_mode($file, q{-kb});
 206         is(&$bindata_out(), $bindata_in, q{binary files match after commit});
 207         @changes = IkiWiki::rcs_recentchanges(3);
 208         is_total_number_of_changes(\@changes, 3);
 209         is_most_recent_change(\@changes, $file, $message);
 210         ok(
 211                 unlink($config{srcdir} . "/$file"),
 212                 q{can remove file in order to re-fetch it from repo},
 213         );
 214         ok(! -e $config{srcdir} . "/$file", q{really removed file});
 215         IkiWiki::rcs_update();
 216         is(&$bindata_out(), $bindata_in, q{binary files match after re-fetch});
 217
 218         $message = "add a UTF-8 and a binary file in different dirs";
 219         my $file1 = "test8/test9.mdwn";
 220         my $file2 = "test10/test11.ico";
 221         can_mkdir(qw(test8 test10));
 222         writefile($file1, $config{srcdir}, readfile('t/test2.mdwn'));
 223         writefile($file2, $config{srcdir}, $bindata_in, 1);
 224         IkiWiki::rcs_add($_) for ($file1, $file2);
 225         IkiWiki::rcs_commit_staged(message => $message);
 226         is_newly_added($_) for ($file1, $file2);
 227         is_in_keyword_substitution_mode($file1, undef);
 228         is_in_keyword_substitution_mode($file2, '-kb');
 229         @changes = IkiWiki::rcs_recentchanges(3);
 230         is_total_number_of_changes(\@changes, 3);
 231         @changes = IkiWiki::rcs_recentchanges(4);
 232         is_total_number_of_changes(\@changes, 4);
 233         # XXX test for both files in the commit, and no other files
 234         is_most_recent_change(\@changes, $file2, $message);
 235
 236         # prevent web edits from attempting to create .../CVS/foo.mdwn
 237         # on case-insensitive filesystems, also prevent .../cvs/foo.mdwn
 238         # unless your "CVS" is something else and we've made it configurable
 239
 240         # can it assume we're under CVS control? or must it check?
 241
 242         # extract method: filetype-guessing
 243         # add a binary file, remove it, add a text file by same name, no -kb?
 244         # add a text file, remove it, add a binary file by same name, -kb?
 245 }
 246
 247 sub test_rcs_remove {
 248         # can it assume we're under CVS control? or must it check?
 249         # remove a top-level file
 250         # - rcs_commit
 251         # - inspect recentchanges: one new change, file removed
 252         # remove two files (in different dirs)
 253         # - rcs_commit_staged
 254         # - inspect recentchanges: one new change, both files removed
 255 }
 256
 257 sub test_rcs_rename {
 258         # can it assume we're under CVS control? or must it check?
 259         # rename a file in the same dir
 260         # - rcs_commit_staged
 261         # - inspect recentchanges: one new change, one file removed, one added
 262         # rename a file into a different dir
 263         # - rcs_commit_staged
 264         # - inspect recentchanges: one new change, one file removed, one added
 265         # rename a file into a not-yet-existing dir
 266         # - rcs_commit_staged
 267         # - inspect recentchanges: one new change, one file removed, one added
 268         # is it safe to use "mv"? what if $dest is somehow outside the wiki?
 269 }
 270
 271 sub test_rcs_recentchanges {
 272         my $message = "Add a page via CVS directly";
 273         writefile('test2.mdwn', $config{srcdir}, readfile("t/test2.mdwn"));
 274         system "cd $config{srcdir}"
 275                 . " && cvs add test2.mdwn >/dev/null 2>&1";
 276         system "cd $config{srcdir}"
 277                 . " && cvs commit -m \"$message\" test2.mdwn >/dev/null";
 278
 279         my @changes = IkiWiki::rcs_recentchanges(3);
 280         is(
 281                 $#changes,
 282                 0,
 283                 q{total commits: 1},
 284         );
 285         is(
 286                 $changes[0]{message}[0]{"line"},
 287                 $message,
 288                 q{most recent commit's first message line matches},
 289         );
 290         is(
 291                 $changes[0]{pages}[0]{"page"},
 292                 "test2",
 293                 q{most recent commit's first pagename matches},
 294         );
 295
 296         # CVS commits run ikiwiki once for every committed file (!)
 297         # - commit_prep alone should fix this
 298         # CVS multi-dir commits show only the first dir in recentchanges
 299         # - commit_prep might also fix this?
 300         # CVS post-commit hook is amped off to avoid locking against itself
 301         # - commit_prep probably doesn't fix this... but maybe?
 302         # can it assume we're under CVS control? or must it check?
 303         # don't worry whether we're called with a number (we always are)
 304         # other rcs tests already inspect much of the returned structure
 305         # CVS commits say "cvs" and get the right committer
 306         # web commits say "web" and get the right committer
 307         # - and don't start with "web commit {by,from} "
 308         # "nickname" -- can we ever meaningfully set this?
 309
 310         # prefer log_accum, then cvsps, else die
 311         # run the high-level recentchanges tests 2x (once for each method)
 312         # - including in other test subs that check recentchanges?
 313 }
 314
 315 sub test_rcs_diff {
 316         # can it assume we're under CVS control? or must it check?
 317         # in list context, return all lines (with \n), up to $maxlines if set
 318         # in scalar context, return the whole diff, up to $maxlines if set
 319 }
 320
 321 sub test_rcs_getctime {
 322         # can it assume we're under CVS control? or must it check?
 323         # given a file, find its creation time, else return 0
 324         # first implement in the obvious way
 325         # then cache
 326 }
 327
 328 sub test_rcs_getmtime {
 329         # can it assume we're under CVS control? or must it check?
 330         # given a file, find its modification time, else return 0
 331         # first implement in the obvious way
 332         # then cache
 333 }
 334
 335 sub test_rcs_receive {
 336         pass(q{rcs_receive doesn't make sense for CVS});
 337 }
 338
 339 sub test_rcs_preprevert {
 340         # can it assume we're under CVS control? or must it check?
 341         # given a patchset number, return structure describing what'd happen:
 342         # - see doc/plugins/write.mdwn:rcs_receive()
 343         # don't forget about attachments
 344 }
 345
 346 sub test_rcs_revert {
 347         # can it assume we're under CVS control? or must it check?
 348         # given a patchset number, stage the revert for rcs_commit_staged()
 349         # if commit succeeds, return undef
 350         # else, warn and return error message (really? or just non-undef?)
 351 }
 352
 353 sub main {
 354         my $test_methods = defined $ENV{TEST_METHOD}
 355                          ? $ENV{TEST_METHOD}
 356                          : $default_test_methods;
 357
 358         _startup($test_methods eq $default_test_methods);
 359         _runtests(_get_matching_test_subs($test_methods));
 360         _shutdown($test_methods eq $default_test_methods);
 361 }
 362
 363 main();
 364
 365
 366 # INTERNAL SUPPORT ROUTINES
 367
 368 sub _plan_for_test_more {
 369         my $can_plan = shift;
 370
 371         foreach my $program (@required_programs) {
 372                 my $program_path = `which $program`;
 373                 chomp $program_path;
 374                 return plan(skip_all => "$program not available")
 375                         unless -x $program_path;
 376         }
 377
 378         foreach my $module (@required_modules) {
 379                 eval qq{use $module};
 380                 return plan(skip_all => "$module not available")
 381                         if $@;
 382         }
 383
 384         return plan(skip_all => "can't create $dir: $!")
 385                 unless mkdir($dir);
 386         return plan(skip_all => "can't remove $dir: $!")
 387                 unless rmdir($dir);
 388
 389         return unless $can_plan;
 390
 391         return plan(tests => $total_tests);
 392 }
 393
 394 # http://stackoverflow.com/questions/607282/whats-the-best-way-to-discover-all-subroutines-a-perl-module-has
 395
 396 use B qw/svref_2object/;
 397
 398 sub in_package {
 399         my ($coderef, $package) = @_;
 400         my $cv = svref_2object($coderef);
 401         return if not $cv->isa('B::CV') or $cv->GV->isa('B::SPECIAL');
 402         return $cv->GV->STASH->NAME eq $package;
 403 }
 404
 405 sub list_module {
 406         my $module = shift;
 407         no strict 'refs';
 408         return grep {
 409                 defined &{"$module\::$_"} and in_package(\&{*$_}, $module)
 410         } keys %{"$module\::"};
 411 }
 412
 413
 414 # support for xUnit-style testing, a la Test::Class
 415
 416 sub _startup {
 417         my $can_plan = shift;
 418         _plan_for_test_more($can_plan);
 419         _generate_test_config();
 420 }
 421
 422 sub _shutdown {
 423         my $had_plan = shift;
 424         done_testing() unless $had_plan;
 425 }
 426
 427 sub _setup {
 428         _generate_test_repo();
 429 }
 430
 431 sub _teardown {
 432         system "rm -rf $dir";
 433 }
 434
 435 sub _runtests {
 436         my @coderefs = (@_);
 437         for (@coderefs) {
 438                 _setup();
 439                 $_->();
 440                 _teardown();
 441         }
 442 }
 443
 444 sub _get_matching_test_subs {
 445         my $re = shift;
 446         no strict 'refs';
 447         return map { \&{*$_} } grep { /$re/ } sort(list_module('main'));
 448 }
 449
 450 sub _generate_test_config {
 451         %config = IkiWiki::defaultconfig();
 452         $config{rcs} = "cvs";
 453         $config{srcdir} = "$dir/src";
 454         $config{cvsrepo} = "$dir/repo";
 455         $config{cvspath} = "ikiwiki";
 456         IkiWiki::loadplugins();
 457         IkiWiki::checkconfig();
 458 }
 459
 460 sub _generate_test_repo {
 461         die "can't create $dir: $!"
 462                 unless mkdir($dir);
 463
 464         my $cvs = "cvs -d $config{cvsrepo}";
 465         my $dn = ">/dev/null";
 466         system "$cvs init $dn";
 467         system "mkdir $dir/$config{cvspath} $dn";
 468         system "cd $dir/$config{cvspath} && "
 469                 . "$cvs import -m import $config{cvspath} VENDOR RELEASE $dn";
 470         system "rm -rf $dir/$config{cvspath} $dn";
 471         system "$cvs co -d $config{srcdir} $config{cvspath} $dn";
 472 }
 473
 474 sub add_and_commit {
 475         my ($file, $message, $contents) = @_;
 476         writefile($file, $config{srcdir}, $contents);
 477         IkiWiki::rcs_add($file);
 478         IkiWiki::rcs_commit(
 479                 file => $file,
 480                 message => $message,
 481                 token => "moo",
 482         );
 483 }
 484
 485 sub can_mkdir {
 486         my $dir = shift;
 487         ok(
 488                 mkdir($config{srcdir} . "/$dir"),
 489                 qq{can mkdir $dir},
 490         );
 491 }
 492
 493 sub is_newly_added {
 494         my $file = shift;
 495         is(
 496                 IkiWiki::Plugin::cvs::cvs_info("Repository revision", $file),
 497                 '1.1',
 498                 qq{$file is newly added to CVS},
 499         );
 500 }
 501
 502 sub is_in_keyword_substitution_mode {
 503         my ($file, $mode) = @_;
 504         $mode = '(none)' unless defined $mode;
 505         is(
 506                 IkiWiki::Plugin::cvs::cvs_info("Sticky Options", $file),
 507                 $mode,
 508                 qq{$file is in CVS with expected keyword substitution mode},
 509         );
 510 }
 511
 512 sub is_total_number_of_changes {
 513         my ($changes, $expected_total) = @_;
 514         is(
 515                 $#{$changes},
 516                 $expected_total - 1,
 517                 qq{total commits == $expected_total},
 518         );
 519 }
 520
 521 sub is_most_recent_change {
 522         my ($changes, $page, $message) = @_;
 523         is(
 524                 $changes->[0]{message}[0]{"line"},
 525                 $message,
 526                 q{most recent commit's first message line matches},
 527         );
 528         is(
 529                 $changes->[0]{pages}[0]{"page"},
 530                 $page,
 531                 q{most recent commit's first pagename matches},
 532         );
 533 }
 534
 535 sub stripext {
 536         my ($file, $extension) = @_;
 537         $extension = '\..+?' unless defined $extension;
 538         $file =~ s|$extension$||g;
 539         return $file;
 540 }