.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test::MockModule 3pm"
.TH Test::MockModule 3pm 2024-05-13 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Test::MockModule \- Override subroutines in a module for unit testing
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&        use Module::Name;
\&        use Test::MockModule;
\&
\&        {
\&                my $module = Test::MockModule\->new(\*(AqModule::Name\*(Aq);
\&                $module\->mock(\*(Aqsubroutine\*(Aq, sub { ... });
\&                Module::Name::subroutine(@args); # mocked
\&
\&                # Same effect, but this will die() if other_subroutine()
\&                # doesn\*(Aqt already exist, which is often desirable.
\&                $module\->redefine(\*(Aqother_subroutine\*(Aq, sub { ... });
\&
\&                # This will die() if another_subroutine() is defined.
\&                $module\->define(\*(Aqanother_subroutine\*(Aq, sub { ... });
\&        }
\&
\&        {
\&                # you can also chain new/mock/redefine/define
\&
\&                Test::MockModule\->new(\*(AqModule::Name\*(Aq)
\&                \->mock( one_subroutine => sub { ... })
\&                \->redefine( other_subroutine => sub { ... } )
\&                \->define( a_new_sub => 1234 );
\&        }
\&
\&        Module::Name::subroutine(@args); # original subroutine
\&
\&        # Working with objects
\&        use Foo;
\&        use Test::MockModule;
\&        {
\&                my $mock = Test::MockModule\->new(\*(AqFoo\*(Aq);
\&                $mock\->mock(foo => sub { print "Foo!\en"; });
\&
\&                my $foo = Foo\->new();
\&                $foo\->foo(); # prints "Foo!\en"
\&        }
\&
\&    # If you want to prevent noop and mock from working, you can
\&    # load Test::MockModule in strict mode.
\&
\&    use Test::MockModule qw/strict/;
\&    my $module = Test::MockModule\->new(\*(AqModule::Name\*(Aq);
\&
\&    # Redefined the other_subroutine or dies if it\*(Aqs not there.
\&    $module\->redefine(\*(Aqother_subroutine\*(Aq, sub { ... });
\&
\&    # Dies since you specified you wanted strict mode.
\&    $module\->mock(\*(Aqsubroutine\*(Aq, sub { ... });
\&
\&    # Turn strictness off in this lexical scope
\&    {
\&        use Test::MockModule \*(Aqnostrict\*(Aq;
\&        # \->mock() works now
\&        $module\->mock(\*(Aqsubroutine\*(Aq, sub { ... });
\&    }
\&
\&    # Back in the strict scope, so mock() dies here
\&    $module\->mock(\*(Aqsubroutine\*(Aq, sub { ... });
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Test::MockModule\*(C'\fR lets you temporarily redefine subroutines in other packages
for the purposes of unit testing.
.PP
A \f(CW\*(C`Test::MockModule\*(C'\fR object is set up to mock subroutines for a given
module. The object remembers the original subroutine so it can be easily
restored. This happens automatically when all MockModule objects for the given
module go out of scope, or when you \f(CWunmock()\fR the subroutine.
.SH "STRICT MODE"
.IX Header "STRICT MODE"
One of the weaknesses of testing using mocks is that the implementation of the
interface that you are mocking might change, while your mocks get left alone.
You are not now mocking what you thought you were, and your mocks might now be
hiding bugs that will only be spotted in production. To help prevent this you
can load Test::MockModule in 'strict' mode:
.PP
.Vb 1
\&    use Test::MockModule qw(strict);
.Ve
.PP
This will disable use of the \f(CWmock()\fR method, making it a fatal runtime error.
You should instead define mocks using \f(CWredefine()\fR, which will only mock
things that already exist and die if you try to redefine something that doesn't
exist.
.PP
Strictness is lexically scoped, so you can do this in one file:
.PP
.Vb 1
\&    use Test::MockModule qw(strict);
\&    
\&    ...\->redefine(...);
.Ve
.PP
and this in another:
.PP
.Vb 1
\&    use Test::MockModule; # the default is nostrict
\&
\&    ...\->mock(...);
.Ve
.PP
You can even mix n match at different places in a single file thus:
.PP
.Vb 2
\&    use Test::MockModule qw(strict);
\&    # here mock() dies
\&
\&    {
\&        use Test::MockModule qw(nostrict);
\&        # here mock() works
\&    }
\&
\&    # here mock() goes back to dieing
\&
\&    use Test::MockModule qw(nostrict);
\&    # and from here on mock() works again
.Ve
.PP
NB that strictness must be defined at compile-time, and set using \f(CW\*(C`use\*(C'\fR. If
you think you're going to try and be clever by calling Test::MockModule's
\&\f(CWimport()\fR method at runtime then what happens in undefined, with results
differing from one version of perl to another. What larks!
.SH METHODS
.IX Header "METHODS"
.ie n .IP "new($package[, %options])" 4
.el .IP "new($package[, \f(CW%options\fR])" 4
.IX Item "new($package[, %options])"
Returns an object that will mock subroutines in the specified \f(CW$package\fR.
.Sp
If there is no \f(CW$VERSION\fR defined in \f(CW$package\fR, the module will be
automatically loaded. You can override this behaviour by setting the \f(CW\*(C`no_auto\*(C'\fR
option:
.Sp
.Vb 1
\&        my $mock = Test::MockModule\->new(\*(AqModule::Name\*(Aq, no_auto => 1);
.Ve
.IP \fBget_package()\fR 4
.IX Item "get_package()"
Returns the target package name for the mocked subroutines
.IP is_mocked($subroutine) 4
.IX Item "is_mocked($subroutine)"
Returns a boolean value indicating whether or not the subroutine is currently
mocked
.IP "mock($subroutine => \e&coderef)" 4
.IX Item "mock($subroutine => &coderef)"
Temporarily replaces one or more subroutines in the mocked module. A subroutine
can be mocked with a code reference or a scalar. A scalar will be recast as a
subroutine that returns the scalar.
.Sp
Returns the current \f(CW\*(C`Test::MockModule\*(C'\fR object, so you can chain new with mock.
.Sp
.Vb 1
\&        my $mock = Test::MockModule\->new\->(...)\->mock(...);
.Ve
.Sp
The following statements are equivalent:
.Sp
.Vb 2
\&        $module\->mock(purge => \*(Aqpurged\*(Aq);
\&        $module\->mock(purge => sub { return \*(Aqpurged\*(Aq});
.Ve
.Sp
When dealing with references, things behave slightly differently. The following
statements are \fBNOT\fR equivalent:
.Sp
.Vb 4
\&        # Returns the same arrayref each time, with the localtime() at time of mocking
\&        $module\->mock(updated => [localtime()]);
\&        # Returns a new arrayref each time, with up\-to\-date localtime() value
\&        $module\->mock(updated => sub { return [localtime()]});
.Ve
.Sp
The following statements are in fact equivalent:
.Sp
.Vb 3
\&        my $array_ref = [localtime()]
\&        $module\->mock(updated => $array_ref)
\&        $module\->mock(updated => sub { return $array_ref });
.Ve
.Sp
However, \f(CW\*(C`undef\*(C'\fR is a special case. If you mock a subroutine with \f(CW\*(C`undef\*(C'\fR it
will install an empty subroutine
.Sp
.Vb 2
\&        $module\->mock(purge => undef);
\&        $module\->mock(purge => sub { });
.Ve
.Sp
rather than a subroutine that returns \f(CW\*(C`undef\*(C'\fR:
.Sp
.Vb 1
\&        $module\->mock(purge => sub { undef });
.Ve
.Sp
You can call \f(CWmock()\fR for the same subroutine many times, but when you call
\&\f(CWunmock()\fR, the original subroutine is restored (not the last mocked
instance).
.Sp
\&\fBMOCKING + EXPORT\fR
.Sp
If you are trying to mock a subroutine exported from another module, this may
not behave as you initially would expect, since Test::MockModule is only mocking
at the target module, not anything importing that module. If you mock the local
package, or use a fully qualified function name, you will get the behavior you
desire:
.Sp
.Vb 3
\&        use Test::MockModule;
\&        use Test::More;
\&        use POSIX qw/strftime/;
\&
\&        my $posix = Test::MockModule\->new("POSIX");
\&
\&        $posix\->mock("strftime", "Yesterday");
\&        is strftime("%D", localtime(time)), "Yesterday", "\`strftime\` was mocked successfully"; # Fails
\&        is POSIX::strftime("%D", localtime(time)), "Yesterday", "\`strftime\` was mocked successfully"; # Succeeds
\&
\&        my $main = Test::MockModule\->new("main", no_auto => 1);
\&        $main\->mock("strftime", "today");
\&        is strftime("%D", localtime(time)), "today", "\`strftime\` was mocked successfully"; # Succeeds
.Ve
.Sp
If you are trying to mock a subroutine that was exported into a module that you're
trying to test, rather than mocking the subroutine in its originating module,
you can instead mock it in the module you are testing:
.Sp
.Vb 2
\&        package MyModule;
\&        use POSIX qw/strftime/;
\&
\&        sub minus_twentyfour
\&        {
\&                return strftime("%a, %b %d, %Y", localtime(time \- 86400));
\&        }
\&
\&        package main;
\&        use Test::More;
\&        use Test::MockModule;
\&
\&        my $posix = Test::MockModule\->new("POSIX");
\&        $posix\->mock("strftime", "Yesterday");
\&
\&        is MyModule::minus_twentyfour(), "Yesterday", "\`minus\-twentyfour\` got mocked"; # fails
\&
\&        my $mymodule = Test::MockModule\->new("MyModule", no_auto => 1);
\&        $mymodule\->mock("strftime", "Yesterday");
\&        is MyModule::minus_twentyfour(), "Yesterday", "\`minus\-twentyfour\` got mocked"; # succeeds
.Ve
.IP redefine($subroutine) 4
.IX Item "redefine($subroutine)"
The same behavior as \f(CWmock()\fR, but this will preemptively check to be
sure that all passed subroutines actually exist. This is useful to ensure that
if a mocked module's interface changes the test doesn't just keep on testing a
code path that no longer behaves consistently with the mocked behavior.
.Sp
Note that redefine is also now checking if one of the parent provides the sub
and will not die if it's available in the chain.
.Sp
Returns the current \f(CW\*(C`Test::MockModule\*(C'\fR object, so you can chain new with redefine.
.Sp
.Vb 1
\&        my $mock = Test::MockModule\->new\->(...)\->redefine(...);
.Ve
.IP define($subroutine) 4
.IX Item "define($subroutine)"
The reverse of redefine, this will fail if the passed subroutine exists.
While this use case is rare, there are times where the perl code you are
testing is inspecting a package and adding a missing subroutine is actually
what you want to do.
.Sp
By using define, you're asserting that the subroutine you want to be mocked
should not exist in advance.
.Sp
Note: define does not check for inheritance like redefine.
.Sp
Returns the current \f(CW\*(C`Test::MockModule\*(C'\fR object, so you can chain new with define.
.Sp
.Vb 1
\&        my $mock = Test::MockModule\->new\->(...)\->define(...);
.Ve
.IP original($subroutine) 4
.IX Item "original($subroutine)"
Returns the original (unmocked) subroutine
.Sp
Here is a sample how to wrap a function with custom arguments using the original subroutine.
This is useful when you cannot (do not) want to alter the original code to abstract
one hardcoded argument pass to a function.
.Sp
.Vb 1
\&        package MyModule;
\&
\&        sub sample {
\&                return get_path_for("/a/b/c/d");
\&        }
\&
\&        sub get_path_for {
\&                ... # anything goes there...
\&        }
\&
\&        package main;
\&        use Test::MockModule;
\&
\&        my $mock = Test::MockModule\->new("MyModule");
\&        # replace all calls to get_path_for using a different argument
\&        $mock\->redefine("get_path_for", sub {
\&                return $mock\->original("get_path_for")\->("/my/custom/path");
\&        });
\&
\&        # or
\&
\&        $mock\->redefine("get_path_for", sub {
\&                my $path = shift;
\&                if ( $path && $path eq "/a/b/c/d" ) {
\&                        # only alter calls with path set to "/a/b/c/d"
\&                        return $mock\->original("get_path_for")\->("/my/custom/path");
\&                } else { # preserve the original arguments
\&                        return $mock\->original("get_path_for")\->($path, @_);
\&                }
\&        });
.Ve
.IP "unmock($subroutine [, ...])" 4
.IX Item "unmock($subroutine [, ...])"
Restores the original \f(CW$subroutine\fR. You can specify a list of subroutines to
\&\f(CWunmock()\fR in one go.
.IP \fBunmock_all()\fR 4
.IX Item "unmock_all()"
Restores all the subroutines in the package that were mocked. This is
automatically called when all \f(CW\*(C`Test::MockObject\*(C'\fR objects for the given package
go out of scope.
.IP "noop($subroutine [, ...])" 4
.IX Item "noop($subroutine [, ...])"
Given a list of subroutine names, mocks each of them with a no-op subroutine. Handy
for mocking methods you want to ignore!
.Sp
.Vb 2
\&    # Neuter a list of methods in one go
\&    $module\->noop(\*(Aqpurge\*(Aq, \*(Aqupdated\*(Aq);
.Ve
.IP TRACE 4
.IX Item "TRACE"
A stub for Log::Trace
.IP DUMP 4
.IX Item "DUMP"
A stub for Log::Trace
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test::MockObject::Extends
.PP
Sub::Override
.SH AUTHORS
.IX Header "AUTHORS"
Current Maintainer: Geoff Franks <gfranks@cpan.org>
.PP
Original Author: Simon Flack <simonflk _AT_ cpan.org>
.PP
Lexical scoping of strictness: David Cantrell <david@cantrell.org.uk>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2004 Simon Flack <simonflk _AT_ cpan.org>.
All rights reserved
.PP
You may distribute under the terms of either the GNU General Public License or
the Artistic License, as specified in the Perl README file.