rename patch/highlight_line_numbers.mdwn to todo/highlight_line_numbers.mdwn

[git.ikiwiki.info.git] / t / cvs.t

diff --git a/t/cvs.t b/t/cvs.t
index 5f5ba30a90ed4058fb4f5d9e1f20ac7a519a6972..43a2ca3a81f77e07afb997c3e118e64957ba1e81 100755 (executable)
--- a/t/cvs.t
+++ b/t/cvs.t
@@ -1,9 +1,11 @@
 #!/usr/bin/perl
 use warnings;
 use strict;
 #!/usr/bin/perl
 use warnings;
 use strict;

-use Test::More; my $total_tests = 41;
+use Test::More; my $total_tests = 72;

 use IkiWiki;
 
 use IkiWiki;
 

+my $installed = $ENV{INSTALLED_TESTS};
+

 my $default_test_methods = '^test_*';
 my @required_programs = qw(
        cvs
 my $default_test_methods = '^test_*';
 my @required_programs = qw(
        cvs


@@ -26,14 +28,13 @@ sub test_web_comments {
        # - when the first comment for page.mdwn is added, and page/ is
        #   created to hold the comment, page/ isn't added to CVS control,
        #   so the comment isn't either
        # - when the first comment for page.mdwn is added, and page/ is
        #   created to hold the comment, page/ isn't added to CVS control,
        #   so the comment isn't either

+       #   - can't reproduce after chmod g+s ikiwiki.cgi (20120204)

        # - side effect for moderated comments: after approval they
        #   show up normally AND are still pending, too
        # - comments.pm treats rcs_commit_staged() as returning conflicts?
 }
 
 sub test_chdir_magic {
        # - side effect for moderated comments: after approval they
        #   show up normally AND are still pending, too
        # - comments.pm treats rcs_commit_staged() as returning conflicts?
 }
 
 sub test_chdir_magic {

-       # cvs.pm operations are always occurring inside $config{srcdir}
-       # other ikiwiki operations are occurring wherever, and are unaffected

        # when are we bothering with "local $CWD" and when aren't we?
 }
 
        # when are we bothering with "local $CWD" and when aren't we?
 }
 


@@ -52,12 +53,14 @@ sub test_cvs_run_cvs {
        # steal from git.pm: safe_git(), run_or_{die,cry,non}
        # - open() instead of system()
        # always call cvs_run_cvs(), don't ever run 'cvs' directly
        # steal from git.pm: safe_git(), run_or_{die,cry,non}
        # - open() instead of system()
        # always call cvs_run_cvs(), don't ever run 'cvs' directly

+       # - for cvs_info(), make it respect wantarray

 }
 
 sub test_cvs_run_cvsps {
        # parameterize command like run_cvs()
        # expose config vars for e.g. "--cvs-direct -z 30"
        # always pass -x (unless proven otherwise)
 }
 
 sub test_cvs_run_cvsps {
        # parameterize command like run_cvs()
        # expose config vars for e.g. "--cvs-direct -z 30"
        # always pass -x (unless proven otherwise)

+       # - but diff doesn't! optimization alert

        # always pass -b HEAD (configurable like gitmaster_branch?)
 }
 
        # always pass -b HEAD (configurable like gitmaster_branch?)
 }
 


@@ -94,21 +97,43 @@ sub test_cvs_is_controlling {
 # TESTS FOR GENERAL PLUGIN API CALLS
 
 sub test_checkconfig {
 # TESTS FOR GENERAL PLUGIN API CALLS
 
 sub test_checkconfig {

-       # undef cvspath, expect "ikiwiki"
-       # define cvspath normally, get it back
-       # define cvspath in a subdir, get it back?
-       # define cvspath with extra slashes, get sanitized version back
-       # - yoink test_extra_path_slashes
-       # undef cvs_wrapper, expect $config{wrappers} same size as before
-
-       my $initial_cvspath = $config{cvspath};
-       $config{cvspath} = "/ikiwiki//";
+       my $default_cvspath = 'ikiwiki';
+
+       undef $config{cvspath}; IkiWiki::checkconfig();
+       is(
+               $config{cvspath}, $default_cvspath,
+               q{can provide default cvspath},
+       );
+
+       $config{cvspath} = "/$default_cvspath/"; IkiWiki::checkconfig();
+       is(
+               $config{cvspath}, $default_cvspath,
+               q{can set typical cvspath and strip well-meaning slashes},
+       );
+
+       $config{cvspath} = "/$default_cvspath//subdir"; IkiWiki::checkconfig();
+       is(
+               $config{cvspath}, "$default_cvspath/subdir",
+               q{can really sanitize cvspath as assumed by rcs_recentchanges},
+       );
+
+       my $default_num_wrappers = @{$config{wrappers}};
+       undef $config{cvs_wrapper}; IkiWiki::checkconfig();
+       is(
+               @{$config{wrappers}}, $default_num_wrappers,
+               q{can start with no wrappers configured},
+       );
+
+       $config{cvs_wrapper} = $config{cvsrepo} . "/CVSROOT/post-commit";

        IkiWiki::checkconfig();
        is(
        IkiWiki::checkconfig();
        is(

-               $config{cvspath},
-               $initial_cvspath,
-               q{rcs_recentchanges assumes checkconfig has sanitized cvspath},
+               @{$config{wrappers}}, ++$default_num_wrappers,
+               q{can add cvs_wrapper},

        );
        );

+
+       undef $config{cvs_wrapper};
+       $config{cvspath} = $default_cvspath;
+       IkiWiki::checkconfig();

 }
 
 sub test_getsetup {
 }
 
 sub test_getsetup {


@@ -132,6 +157,11 @@ sub test_rcs_prepedit {
        # for existing file, returns latest revision in repo
        # - what's this used for? should it return latest revision in checkout?
        # for new file, returns empty string
        # for existing file, returns latest revision in repo
        # - what's this used for? should it return latest revision in checkout?
        # for new file, returns empty string

+
+       # netbsd web log says "could not open lock file"
+       # XXX does this work right?
+       # how about with un-added dirs in the srcdir?
+       # how about with cvsps.core lying around?

 }
 
 sub test_rcs_commit {
 }
 
 sub test_rcs_commit {


@@ -145,7 +175,8 @@ sub test_rcs_commit {
        # - else, revert + return content with the conflict markers in it
        # git.pm receives "session" param -- useful here?
        # web commits start with "web commit {by,from} "
        # - else, revert + return content with the conflict markers in it
        # git.pm receives "session" param -- useful here?
        # web commits start with "web commit {by,from} "

-       # seeing File::chdir errors on commit?
+
+       # XXX commit can fail due to "could not open lock file"

 }
 
 sub test_rcs_commit_staged {
 }
 
 sub test_rcs_commit_staged {


@@ -159,9 +190,21 @@ sub test_rcs_add {
 
        my $message = "add a top-level ASCII (non-UTF-8) page via VCS API";
        my $file = q{test0.mdwn};
 
        my $message = "add a top-level ASCII (non-UTF-8) page via VCS API";
        my $file = q{test0.mdwn};

-       add_and_commit($file, $message, q{* some plain ASCII text});
+       add_and_commit($file, $message, qq{# \$Id\$\n* some plain ASCII text});

        is_newly_added($file);
        is_newly_added($file);

-       is_in_keyword_substitution_mode($file, undef);
+       is_in_keyword_substitution_mode($file, q{-kkv});
+       like(
+               readfile($config{srcdir} . "/$file"),
+               qr/^# \$Id: $file,v 1\.1 .+\$$/m,
+               q{can expand RCS Id keyword},
+       );
+       my $generated_file = $config{destdir} . q{/test0/index.html};
+       ok(-e $generated_file, q{post-commit hook generates content});
+       like(
+               readfile($generated_file),
+               qr/^<h1>\$Id: $file,v 1\.1 .+\$<\/h1>$/m,
+               q{can htmlize mdwn, including RCS Id},
+       );

        @changes = IkiWiki::rcs_recentchanges(3);
        is_total_number_of_changes(\@changes, 1);
        is_most_recent_change(\@changes, stripext($file), $message);
        @changes = IkiWiki::rcs_recentchanges(3);
        is_total_number_of_changes(\@changes, 1);
        is_most_recent_change(\@changes, stripext($file), $message);


@@ -187,7 +230,7 @@ sub test_rcs_add {
        $file = q{test4/test5/test1.mdwn};
        add_and_commit($file, $message, readfile("t/test1.mdwn"));
        is_newly_added($file);
        $file = q{test4/test5/test1.mdwn};
        add_and_commit($file, $message, readfile("t/test1.mdwn"));
        is_newly_added($file);

-       is_in_keyword_substitution_mode($file, undef);
+       is_in_keyword_substitution_mode($file, q{-kkv});

        @changes = IkiWiki::rcs_recentchanges(3);
        is_total_number_of_changes(\@changes, 2);
        is_most_recent_change(\@changes, stripext($file), $message);
        @changes = IkiWiki::rcs_recentchanges(3);
        is_total_number_of_changes(\@changes, 2);
        is_most_recent_change(\@changes, stripext($file), $message);


@@ -218,14 +261,14 @@ sub test_rcs_add {
        $message = "add a UTF-8 and a binary file in different dirs";
        my $file1 = "test8/test9.mdwn";
        my $file2 = "test10/test11.ico";
        $message = "add a UTF-8 and a binary file in different dirs";
        my $file1 = "test8/test9.mdwn";
        my $file2 = "test10/test11.ico";

-       can_mkdir(qw(test8 test10));
+       can_mkdir($_) for (qw(test8 test10));

        writefile($file1, $config{srcdir}, readfile('t/test2.mdwn'));
        writefile($file2, $config{srcdir}, $bindata_in, 1);
        IkiWiki::rcs_add($_) for ($file1, $file2);
        IkiWiki::rcs_commit_staged(message => $message);
        is_newly_added($_) for ($file1, $file2);
        writefile($file1, $config{srcdir}, readfile('t/test2.mdwn'));
        writefile($file2, $config{srcdir}, $bindata_in, 1);
        IkiWiki::rcs_add($_) for ($file1, $file2);
        IkiWiki::rcs_commit_staged(message => $message);
        is_newly_added($_) for ($file1, $file2);

-       is_in_keyword_substitution_mode($file1, undef);
-       is_in_keyword_substitution_mode($file2, '-kb');
+       is_in_keyword_substitution_mode($file1, q{-kkv});
+       is_in_keyword_substitution_mode($file2, q{-kb});

        @changes = IkiWiki::rcs_recentchanges(3);
        is_total_number_of_changes(\@changes, 3);
        @changes = IkiWiki::rcs_recentchanges(4);
        @changes = IkiWiki::rcs_recentchanges(3);
        is_total_number_of_changes(\@changes, 3);
        @changes = IkiWiki::rcs_recentchanges(4);


@@ -233,15 +276,39 @@ sub test_rcs_add {
        # XXX test for both files in the commit, and no other files
        is_most_recent_change(\@changes, $file2, $message);
 
        # XXX test for both files in the commit, and no other files
        is_most_recent_change(\@changes, $file2, $message);
 

+       $message = "remove the UTF-8 and binary files we just added";
+       IkiWiki::rcs_remove($_) for ($file1, $file2);
+       IkiWiki::rcs_commit_staged(message => $message);
+       ok(! -d "$config{srcdir}/test8", q{empty dir pruned by post-commit});
+       ok(! -d "$config{srcdir}/test10", q{empty dir pruned by post-commit});
+       @changes = IkiWiki::rcs_recentchanges(11);
+       is_total_number_of_changes(\@changes, 5);
+       # XXX test for both files in the commit, and no other files
+       is_most_recent_change(\@changes, $file2, $message);
+
+       $message = "re-add UTF-8 and binary files with names swapped";
+       writefile($file2, $config{srcdir}, readfile('t/test2.mdwn'));
+       writefile($file1, $config{srcdir}, $bindata_in, 1);
+       IkiWiki::rcs_add($_) for ($file1, $file2);
+       IkiWiki::rcs_commit_staged(message => $message);
+       isnt_newly_added($_) for ($file1, $file2);
+       is_in_keyword_substitution_mode($file2, q{-kkv});
+       is_in_keyword_substitution_mode($file1, q{-kb});
+       @changes = IkiWiki::rcs_recentchanges(11);
+       is_total_number_of_changes(\@changes, 6);
+       # XXX test for both files in the commit, and no other files
+       is_most_recent_change(\@changes, $file2, $message);
+

        # prevent web edits from attempting to create .../CVS/foo.mdwn
        # on case-insensitive filesystems, also prevent .../cvs/foo.mdwn
        # unless your "CVS" is something else and we've made it configurable
        # prevent web edits from attempting to create .../CVS/foo.mdwn
        # on case-insensitive filesystems, also prevent .../cvs/foo.mdwn
        # unless your "CVS" is something else and we've made it configurable

+       # also want a pre-commit hook for this?

 
 

-       # can it assume we're under CVS control? or must it check?
+       # pre-commit hook:
+       # - lcase filenames
+       # - ?

 
 

-       # extract method: filetype-guessing
-       # add a binary file, remove it, add a text file by same name, no -kb?
-       # add a text file, remove it, add a binary file by same name, -kb?
+       # can it assume we're under CVS control? or must it check?

 }
 
 sub test_rcs_remove {
 }
 
 sub test_rcs_remove {


@@ -304,9 +371,67 @@ sub test_rcs_recentchanges {
 }
 
 sub test_rcs_diff {
 }
 
 sub test_rcs_diff {

+       my @changes = IkiWiki::rcs_recentchanges(3);
+       is_total_number_of_changes(\@changes, 0);
+
+       my $message = "add a UTF-8 and an ASCII file in different dirs";
+       my $file1 = "rcsdiff1/utf8.mdwn";
+       my $file2 = "rcsdiff2/ascii.mdwn";
+       my $contents2 = ''; $contents2 .= "$_. foo\n" for (1..11);
+       can_mkdir($_) for (qw(rcsdiff1 rcsdiff2));
+       writefile($file1, $config{srcdir}, readfile('t/test2.mdwn'));
+       writefile($file2, $config{srcdir}, $contents2);
+       IkiWiki::rcs_add($_) for ($file1, $file2);
+       IkiWiki::rcs_commit_staged(message => $message);
+
+       # XXX we rely on rcs_recentchanges() to be called first!
+       # XXX or else for no cvsps cache to exist yet...
+       # XXX because rcs_diff() doesn't pass -x (as an optimization)
+       @changes = IkiWiki::rcs_recentchanges(3);
+       is_total_number_of_changes(\@changes, 1);
+
+       unlike(
+               $changes[0]->{pages}->[0]->{diffurl},
+               qr/%2F/m,
+               q{path separators are preserved when UTF-8scaping filename},
+       );
+
+       my $changeset = 1;
+
+       my $maxlines = undef;
+       my $scalar_diffs = IkiWiki::rcs_diff($changeset, $maxlines);
+       like(
+               $scalar_diffs,
+               qr/^\+11\. foo$/m,
+               q{unbounded scalar diffs go all the way to 11},
+       );
+       my @array_diffs = IkiWiki::rcs_diff($changeset, $maxlines);
+       is(
+               $array_diffs[$#array_diffs],
+               "+11. foo\n",
+               q{unbounded array diffs go all the way to 11},
+       );
+
+       $maxlines = 8;
+       $scalar_diffs = IkiWiki::rcs_diff($changeset, $maxlines);
+       unlike(
+               $scalar_diffs,
+               qr/^\+11\. foo$/m,
+               q{bounded scalar diffs don't go all the way to 11},
+       );
+       @array_diffs = IkiWiki::rcs_diff($changeset, $maxlines);
+       isnt(
+               $array_diffs[$#array_diffs],
+               "+11. foo\n",
+               q{bounded array diffs don't go all the way to 11},
+       );
+       is(
+               scalar @array_diffs,
+               $maxlines,
+               q{bounded array diffs contain expected maximum number of lines},
+       );
+

        # can it assume we're under CVS control? or must it check?
        # can it assume we're under CVS control? or must it check?

-       # in list context, return all lines (with \n), up to $maxlines if set
-       # in scalar context, return the whole diff, up to $maxlines if set

 }
 
 sub test_rcs_getctime {
 }
 
 sub test_rcs_getctime {


@@ -415,6 +540,7 @@ sub list_module {
 sub _startup {
        my $can_plan = shift;
        _plan_for_test_more($can_plan);
 sub _startup {
        my $can_plan = shift;
        _plan_for_test_more($can_plan);

+       hook(type => "genwrapper", id => "cvstest", call => \&_wrapper_paths);

        _generate_test_config();
 }
 
        _generate_test_config();
 }
 


@@ -450,8 +576,12 @@ sub _generate_test_config {
        %config = IkiWiki::defaultconfig();
        $config{rcs} = "cvs";
        $config{srcdir} = "$dir/src";
        %config = IkiWiki::defaultconfig();
        $config{rcs} = "cvs";
        $config{srcdir} = "$dir/src";

+       $config{allow_symlinks_before_srcdir} = 1;
+       $config{destdir} = "$dir/dest";

        $config{cvsrepo} = "$dir/repo";
        $config{cvspath} = "ikiwiki";
        $config{cvsrepo} = "$dir/repo";
        $config{cvspath} = "ikiwiki";

+       use Cwd; $config{templatedir} = getcwd() . '/templates';
+       $config{diffurl} = "/nonexistent/cvsweb/[[file]]";

        IkiWiki::loadplugins();
        IkiWiki::checkconfig();
 }
        IkiWiki::loadplugins();
        IkiWiki::checkconfig();
 }


@@ -462,12 +592,41 @@ sub _generate_test_repo {
 
        my $cvs = "cvs -d $config{cvsrepo}";
        my $dn = ">/dev/null";
 
        my $cvs = "cvs -d $config{cvsrepo}";
        my $dn = ">/dev/null";

+

        system "$cvs init $dn";
        system "mkdir $dir/$config{cvspath} $dn";
        system "cd $dir/$config{cvspath} && "
                . "$cvs import -m import $config{cvspath} VENDOR RELEASE $dn";
        system "rm -rf $dir/$config{cvspath} $dn";
        system "$cvs co -d $config{srcdir} $config{cvspath} $dn";
        system "$cvs init $dn";
        system "mkdir $dir/$config{cvspath} $dn";
        system "cd $dir/$config{cvspath} && "
                . "$cvs import -m import $config{cvspath} VENDOR RELEASE $dn";
        system "rm -rf $dir/$config{cvspath} $dn";
        system "$cvs co -d $config{srcdir} $config{cvspath} $dn";

+
+       _generate_and_configure_post_commit_hook();
+}
+
+sub _generate_and_configure_post_commit_hook {
+       $config{cvs_wrapper} = $config{cvsrepo} . "/CVSROOT/test-post";
+       $config{wrapper} = $config{cvs_wrapper};
+
+       require IkiWiki::Wrapper;
+       if ($installed) {
+               $IkiWiki::program_to_wrap = 'ikiwiki.out';
+       }
+       else {
+               $IkiWiki::program_to_wrap = `which ikiwiki`;
+       }
+       # XXX substitute its interpreter to Makefile's $(PERL)
+       # XXX best solution: do this to all scripts during build
+       IkiWiki::gen_wrapper();
+
+       my $cvs = "cvs -d $config{cvsrepo}";
+       my $dn = ">/dev/null";
+
+       system "mkdir $config{destdir} $dn";
+       system "cd $dir && $cvs co CVSROOT $dn && cd CVSROOT && " .
+               "echo 'DEFAULT $config{cvsrepo}/CVSROOT/test-post %{sVv} &' "
+               . " >> loginfo && "
+               . "$cvs commit -m 'test repo setup' $dn && "
+               . "cd .. && rm -rf CVSROOT";

 }
 
 sub add_and_commit {
 }
 
 sub add_and_commit {


@@ -489,18 +648,28 @@ sub can_mkdir {
        );
 }
 
        );
 }
 

-sub is_newly_added {
-       my $file = shift;
-       is(
+sub is_newly_added { _newly_added_or_not(shift, 1) }
+sub isnt_newly_added { _newly_added_or_not(shift, 0) }
+sub _newly_added_or_not {
+       my ($file, $expected_new) = @_;
+       my ($func, $word);
+       if ($expected_new) {
+               $func = \&Test::More::is;
+               $word = q{is};
+       }
+       else {
+               $func = \&Test::More::isnt;
+               $word = q{isn't};
+       }
+       $func->(

                IkiWiki::Plugin::cvs::cvs_info("Repository revision", $file),
                '1.1',
                IkiWiki::Plugin::cvs::cvs_info("Repository revision", $file),
                '1.1',

-               qq{$file is newly added to CVS},
+               qq{$file $word newly added to CVS},

        );
 }
 
 sub is_in_keyword_substitution_mode {
        my ($file, $mode) = @_;
        );
 }
 
 sub is_in_keyword_substitution_mode {
        my ($file, $mode) = @_;

-       $mode = '(none)' unless defined $mode;

        is(
                IkiWiki::Plugin::cvs::cvs_info("Sticky Options", $file),
                $mode,
        is(
                IkiWiki::Plugin::cvs::cvs_info("Sticky Options", $file),
                $mode,


@@ -537,3 +706,7 @@ sub stripext {
        $file =~ s|$extension$||g;
        return $file;
 }
        $file =~ s|$extension$||g;
        return $file;
 }

+
+sub _wrapper_paths {
+       return qq{newenviron[i++]="PERL5LIB=$ENV{PERL5LIB}";};
+}