File Coverage

blib/lib/Test/Class/Tiny.pm

Criterion	Covered	Total	%
statement	106	118	89.8
branch	34	50	68.0
condition	3	3	100.0
subroutine	13	13	100.0
pod	1	4	25.0
total	157	188	83.5

package Test::Class::Tiny;

use strict;
use warnings;

our $VERSION;
$VERSION = '0.03';

=encoding utf-8

=head1 NAME

Test::Class::Tiny - xUnit in Perl, simplified

=head1 SYNOPSIS

    package t::mytest;

    use parent qw( Test::Class::Tiny );

    __PACKAGE__->runtests() if !caller;

    sub T_startup_something {
        # Runs at the start of the test run.
    }

    sub something_T_setup {
        # Runs before each normal test function
    }

    # Expects 2 assertions:
    sub T2_normal {
        ok(1, 'yes');
        ok( !0, 'no');
    }

    # Ignores assertion count:
    sub T0_whatever {
        ok(1, 'yes');
    }

    sub T_teardown_something {
        # Runs after each normal test function
    }

    sub T_shutdown_something {
        # Runs at the end of the test run.
    }

=head1 STATUS

This module is B. If you use it, you MUST check the changelog
before upgrading to a new version. Any CPAN distributions that use this module
could break whenever this module is updated.

=head1 DESCRIPTION

L has served Perl’s xUnit needs for a long time
but is incompatible with the L framework. This module allows for
a similar workflow but in a way that works with both L and the older,
L-based modules.

=head1 HOW (AND WHY) TO USE THIS MODULE

xUnit encourages well-designed tests by encouraging organization of test
logic into independent chunks of test logic rather than a single monolithic
block of code.

xUnit provides standard hooks for:

=over

=item * startup: The start of all tests

=item * setup: The start of an individual test group (i.e., Perl function)

=item * teardown: The end of an individual test group

=item * shutdown: The end of all tests

=back

To write functions that execute at these points in the workflow,
name those functions with the prefixes C, C,
C, or C. B, name such functions
with the I C<_T_startup>, C<_T_setup>, C<_T_teardown>, or
C<_T_shutdown>.

To write a test function—i.e., a function that actually runs some
assertions—prefix the function name with C, the number of test assertions
in the function, then an underscore. For example, a function that contains
9 assertions might be named C. If that function
doesn’t run exactly 9 assertions, a test failure is produced.

To forgo counting test assertions, use 0 as the test count, e.g.,
C.

You may alternatively use suffix-style naming for test functions well,
e.g., C, C.

The above convention is a significant departure from L,
which uses Perl subroutine attributes to indicate this information.
Using method names is dramatically simpler to implement and also easier
to type.

In most other respects this module attempts to imitate L.

=head2 PLANS

The concept of a global “plan” (i.e., an expected number of assertions)
isn’t all that sensible with xUnit because each test function has its
own plan. So, ideally the total number of expected assertions for a given
test module is just the sum of all test functions’ expected assertions.

Thus, currently, C sets the L object’s plan to
C if the plan is undefined.

=head1 TEST INHERITANCE

Like L, this module seamlessly integrates inherited methods.
To have one test module inherit another module’s tests, just make that
first module a subclass of the latter.

B Inheritance in tests, while occasionally useful, can also
make for difficult maintenance over time if overused. Where I’ve found it
most useful is cases like L, where each test needs to run with
each backend implementation.

=head1 RUNNING YOUR TEST

To use this module to write normal Perl test scripts, just define
the script’s package (ideally not C, but it’ll work) as a subclass of
this module. Then put the following somewhere in the script:

    __PACKAGE__->runtests() if !caller;

Your test will thus execute as a “modulino”.

=head1 SPECIAL FEATURES

=over

=item * As in L, a C method may be defined. If this
method returns truthy, then the class’s tests are skipped, and that truthy
return is given as the reason for the skip.

=item * The C environment variable is honored as in L.

=item * L’s C method is NOT recognized
here because an early return will already trigger a failure.

=item * Within a test method, C may be called to retrieve the
number of expected test assertions.

=item * To define a test function whose test count isn’t known until runtime,
name it B the usual C prefix, then at runtime do:

    $test_obj->num_method_tests( $name, $count )

See F in the distribution for an example of this.

=back

=head1 COMMON PITFALLS

Avoid the following:

=over

=item * Writing startup logic outside of the module class, e.g.:

    if (!caller) {
        my $mock = Test::MockModule->new('Some::Module');
        $mock->redefine('somefunc', sub { .. } );

        __PACKAGE__->runtests();
    }

The above works I if the test module runs in its own process; if you try
to run this module with anything else it’ll fail because C will be
truthy, which will prevent the mocking from being set up, which your test
probably depends on.

Instead of the above, write a wrapper around C, thus:

    sub runtests {
        my $self = shift;

        my $mock = Test::MockModule->new('Some::Module');
        $mock->redefine('somefunc', sub { .. } );

        $self->SUPER::runtests();
    }

This ensures your test module will always run with the intended mocking.

=item * REDUX: Writing startup logic outside of the module class, e.g.:

    my $mock = Test::MockModule->new('Some::Module');
    $mock->redefine('somefunc', sub { .. } );

    __PACKAGE__->runtests() if !caller;

This is even worse than before because the mock will be global, which
will quietly apply it where we don’t intend. This produces
action-at-a-distance bugs, which can be notoriously hard to find.

=back

=head1 SEE ALSO

Besides L, you might also look at the following:

=over

=item * L also implements xUnit for L but doesn’t
allow inheritance.

=item * L works with L, but the L requirement
makes use in CPAN modules problematic.

=back

=head1 AUTHOR

Copyright 2019 L (FELIPE)

=head1 LICENSE

This code is licensed under the same license as Perl itself.

=cut

#----------------------------------------------------------------------

use mro ();

use Test2::API ();

our ($a, $b);

#----------------------------------------------------------------------

use constant SKIP_CLASS => ();

sub new { bless {}, shift }

sub num_tests {
    my ($self) = @_;

    if (!$self->{'_running'}) {
        die "num_tests() called outside of running test!";
    }

    return $self->{'_num_tests'};
}

sub num_method_tests {
    my ($self, $name, $count) = @_;

    die 'need name!' if !$name;

    if (@_ == 2) {
        return $self->{'test'}{$name};
    }

    $self->{'test'}{$name}{'count'} = $count;
    $self->{'test'}{$name}{'simple_name'} = $name;

    return $self;
}

sub runtests {
    my ($self) = @_;

    if (!ref $self) {
        $self = $self->new();
    }

    local $self->{'_running'} = 1;

    # Allow calls as either instance or object method.
    if (!ref $self) {
        my $obj = $self->new();
        $self = $obj;
    }

    my $big_ctx = Test2::API::context();
    my $ctx = $big_ctx->snapshot();
    $big_ctx->release();

    if (my $reason = $self->SKIP_CLASS()) {
        $ctx->plan(1);
        $ctx->skip( ref($self), $reason );
    }
    else {
        $self->_analyze();

        if ( my $startup_hr = $self->{'startup'} ) {
            $self->_run_funcs($startup_hr);
        }

        if ( my $tests_hr = $self->{'test'} ) {
            my $setup_hr = $self->{'setup'};
            my $teardown_hr = $self->{'teardown'};

            my $filter_fn;
            my $got_count;

            my $hub = $ctx->hub();

            $hub->plan('NO PLAN') if !defined $hub->plan();

            my $filter_cr = sub {
                my ($hub, $event) = @_;

                $got_count++ if $event->increments_count();

                if ($event->can('name') && !defined $event->name()) {
                    my $name = $tests_hr->{$filter_fn}{'simple_name'};
                    $name =~ tr<_>< >;
                    $event->set_name($name);
                }

                return $event;
            };

            $hub->filter($filter_cr);

            my @sorted_fns = sort {
                ( $tests_hr->{$a}{'simple_name'} cmp $tests_hr->{$b}{'simple_name'} )
                || ( $a cmp $b )
            } keys %$tests_hr;

            for my $fn (@sorted_fns) {
                $filter_fn = $fn;

                if (my $ptn = $ENV{'TEST_METHOD'}) {
                    next if $fn !~ m<$ptn>;
                }

                if ($ENV{'TEST_VERBOSE'}) {
                    $ctx->diag( $/ . ref($self) . "->$fn()" );
                }

                $self->_run_funcs($setup_hr);

                $got_count = 0;

                my $want_count = $tests_hr->{$fn}{'count'};

                local $self->{'_num_tests'} = $want_count;

                local $@;
                eval { $self->$fn(); 1 } or do {
                    my $err = $@;
                    $ctx->fail("$fn()", "Caught exception: $err");
                };

                if ($want_count) {
                    if ($want_count != $got_count) {
                        $ctx->fail("Test count mismatch: got $got_count, expected $want_count");
                    }
                }

                $self->_run_funcs($teardown_hr);
            }

            $hub->unfilter($filter_cr);
        }

        if ( my $shutdown_hr = $self->{'shutdown'} ) {
            $self->_run_funcs($shutdown_hr);
        }
    }

    return;
}

sub _analyze {
    my ($self) = @_;

    if (!$self->{'_analyzed'}) {
        my @isa = @{ mro::get_linear_isa(ref $self) };

        my $t_regexp = q;
        my $prefix_regexp = qr<\A${t_regexp}_(.+)>;
        my $suffix_regexp = qr<(.+)_$t_regexp\z>;

        for my $ns (@isa) {
            my $ptbl_hr = do {
                no strict 'refs';
                \%{"${ns}::"};
            };

            for my $name (keys %$ptbl_hr) {
                next if !$self->can($name);

                my ($whatsit, $simple_name);

                if ($name =~ $prefix_regexp) {
                    $whatsit = $1;
                    $simple_name = $2;
                }
                elsif ($name =~ $suffix_regexp) {
                    $simple_name = $1;
                    $whatsit = $2;
                }
                else {
                    next;
                }

                if ( $whatsit =~ s<_><> ) {
                    $self->{$whatsit}{$name} = undef;
                }
                else {
                    $self->{'test'}{$name} = {
                        count => $whatsit,
                        simple_name => $simple_name,
                    };
                }
            }
        }

        $self->{'_analyzed'} = 1;
    }

    return;
}

sub _run_funcs {
    my ($self, $funcs_hr) = @_;

    for my $fn (sort keys %$funcs_hr) {
        if ( $funcs_hr->{$fn} ) {
            $funcs_hr->{$fn}->($self);
        }
        else {
            $self->$fn();
        }
    }

    return;
}

1;