Converting first test to Test::More

Converting t/cut.t, the first step script in the t/ directory was quite simple. Within the code that was actually exercising the Pod::Tree module, it had the following lines

my $N = 1;
sub Not { print "not " }
sub OK  { print "ok ", $N++, "\n" }

print "1..6\n";

...

$actual eq $expected or Not; OK;
...
$actual eq $expected or Not; OK;
...
$actual eq $expected or Not; OK;

Every test was comparing two scalars using eq and using the short circuit of the boolean or it called the Not function only if the two scalars were not equal. It then called the OK function. Having the two statements on one line was a bit confusing at first, but they are separated with a semi-colon ; so it is clear there are two independent statement on every line: $actual eq $expected or Not; OK;

We could replace that line by is $actual, $expected;

The print "1..6\n"; line just prints the expected number of tests. This is what the use Test::More tests => 6; statement.

The $N is the counter. We won't need that as Test::More counts automatically.

Replacing all that was quite simple.

Then I could run prove -l t/cut.t. When I saw that all tests are still passing I wanted to commit the changes and push it out to let Travis-CI run them.

Before doing that I also had to add Test::More as a prerequisite to Makefile.PL.

commit

This triggered Travis-CI which reported all test passing.

Converting more tests to Test::More

t/load.t, t/option.t, t/pod.t, and t/template.t had exactly the same lines so they needed the same changes. commit.

t/tree.t had another type of test-case:

($tree->has_pod xor $expected) and Not; OK;

Because this uses and for short circuit this could be converted to

ok !($tree->has_pod xor $expected);

with the negation in-front of the xor expression.

t/pod2html.t had lines like this:

Cmp($html, $exp) and Not; OK;

I did not want to go deeper in this refactoring and did not want to change the Cmp function, and here too and was used for the short circuit, so I replaced those types of expressions with the following expression:

ok ! Cmp($html, $exp);

t/pods2html.t had a variable $Skip declared, but never used. Probably a left-over from some previous version of the code. I could get rid of it.

In addition it had several lines that looked like this one:

RDiff("$d/html_exp", "$d/html_act") and Not; OK;

Which again could be replaced with a negated ok call.

ok ! RDiff("$d/html_exp", "$d/html_act");

commit

The remaining two test files t/html.t and t/mapper.t aren't that different either. Basically the only difference is that the their OK function looks like this:

sub OK  { print "ok ", $N++, ' ', (caller 1)[3], "\n" }

The caller function of perl will return the given entry in the call-stack of the currently executing code. caller 1 will return the entry from the previous call. The 4th element of the returned array (index 3) is the name of the function. So basically this snippet will print the calling function as the name if the test. As the name of the test is only relevant to the person who is looking at the results I could just get rid of this, but this information is needed in order to make it easier for the user to locate a failing test.

In the Test::More environment we don't need this as Test::More automatically ads this information to the failing tests.

So we can really just get rid of that extra part as well.

commit

Gitignore .swp files

While I was editing the test files using vim, once in a while I ran git status and notices it reported on some ...swp not being tracked. I don't want to add these files by accident so I added *.swp to the .gitignore file.

commit

Release of 1.20

Then I've updated the version number in lib/Pod/Tree.pm to 1.20, included information in the Changes file and released version 1.20.

commit