Test2::Tools::Mock - Class/Instance mocking for Test2.

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Test2::Tools::Mock - Class/Instance mocking for Test2. - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/Test2::Tools::Mock"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.41.5</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/Test2::Tools::Mock">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/Test2::Tools::Mock">5.40.1</a> <a class="dropdown-item" href="/5.40.0/Test2::Tools::Mock">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/Test2::Tools::Mock">5.38.3</a> <a class="dropdown-item" href="/5.38.2/Test2::Tools::Mock">5.38.2</a> <a class="dropdown-item" href="/5.38.1/Test2::Tools::Mock">5.38.1</a> <a class="dropdown-item" href="/5.38.0/Test2::Tools::Mock">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/Test2::Tools::Mock">5.36.3</a> <a class="dropdown-item" href="/5.36.2/Test2::Tools::Mock">5.36.2</a> <a class="dropdown-item" href="/5.36.1/Test2::Tools::Mock">5.36.1</a> <a class="dropdown-item" href="/5.36.0/Test2::Tools::Mock">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/Test2::Tools::Mock">5.34.3</a> <a class="dropdown-item" href="/5.34.2/Test2::Tools::Mock">5.34.2</a> <a class="dropdown-item" href="/5.34.1/Test2::Tools::Mock">5.34.1</a> <a class="dropdown-item" href="/5.34.0/Test2::Tools::Mock">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/Test2::Tools::Mock">5.32.1</a> <a class="dropdown-item" href="/5.32.0/Test2::Tools::Mock">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/Test2::Tools::Mock">5.30.3</a> <a class="dropdown-item" href="/5.30.2/Test2::Tools::Mock">5.30.2</a> <a class="dropdown-item" href="/5.30.1/Test2::Tools::Mock">5.30.1</a> <a class="dropdown-item" href="/5.30.0/Test2::Tools::Mock">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/Test2::Tools::Mock">5.28.3</a> <a class="dropdown-item" href="/5.28.2/Test2::Tools::Mock">5.28.2</a> <a class="dropdown-item" href="/5.28.1/Test2::Tools::Mock">5.28.1</a> <a class="dropdown-item" href="/5.28.0/Test2::Tools::Mock">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/Test2::Tools::Mock">5.26.3</a> <a class="dropdown-item" href="/5.26.2/Test2::Tools::Mock">5.26.2</a> <a class="dropdown-item" href="/5.26.1/Test2::Tools::Mock">5.26.1</a> <a class="dropdown-item" href="/5.26.0/Test2::Tools::Mock">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/Test2::Tools::Mock">5.24.4</a> <a class="dropdown-item" href="/5.24.3/Test2::Tools::Mock">5.24.3</a> <a class="dropdown-item" href="/5.24.2/Test2::Tools::Mock">5.24.2</a> <a class="dropdown-item" href="/5.24.1/Test2::Tools::Mock">5.24.1</a> <a class="dropdown-item" href="/5.24.0/Test2::Tools::Mock">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/Test2::Tools::Mock">5.22.4</a> <a class="dropdown-item" href="/5.22.3/Test2::Tools::Mock">5.22.3</a> <a class="dropdown-item" href="/5.22.2/Test2::Tools::Mock">5.22.2</a> <a class="dropdown-item" href="/5.22.1/Test2::Tools::Mock">5.22.1</a> <a class="dropdown-item" href="/5.22.0/Test2::Tools::Mock">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/Test2::Tools::Mock">5.20.3</a> <a class="dropdown-item" href="/5.20.2/Test2::Tools::Mock">5.20.2</a> <a class="dropdown-item" href="/5.20.1/Test2::Tools::Mock">5.20.1</a> <a class="dropdown-item" href="/5.20.0/Test2::Tools::Mock">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/Test2::Tools::Mock">5.18.4</a> <a class="dropdown-item" href="/5.18.3/Test2::Tools::Mock">5.18.3</a> <a class="dropdown-item" href="/5.18.2/Test2::Tools::Mock">5.18.2</a> <a class="dropdown-item" href="/5.18.1/Test2::Tools::Mock">5.18.1</a> <a class="dropdown-item" href="/5.18.0/Test2::Tools::Mock">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/Test2::Tools::Mock">5.16.3</a> <a class="dropdown-item" href="/5.16.2/Test2::Tools::Mock">5.16.2</a> <a class="dropdown-item" href="/5.16.1/Test2::Tools::Mock">5.16.1</a> <a class="dropdown-item" href="/5.16.0/Test2::Tools::Mock">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/Test2::Tools::Mock">5.14.4</a> <a class="dropdown-item" href="/5.14.3/Test2::Tools::Mock">5.14.3</a> <a class="dropdown-item" href="/5.14.2/Test2::Tools::Mock">5.14.2</a> <a class="dropdown-item" href="/5.14.1/Test2::Tools::Mock">5.14.1</a> <a class="dropdown-item" href="/5.14.0/Test2::Tools::Mock">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/Test2::Tools::Mock">5.12.5</a> <a class="dropdown-item" href="/5.12.4/Test2::Tools::Mock">5.12.4</a> <a class="dropdown-item" href="/5.12.3/Test2::Tools::Mock">5.12.3</a> <a class="dropdown-item" href="/5.12.2/Test2::Tools::Mock">5.12.2</a> <a class="dropdown-item" href="/5.12.1/Test2::Tools::Mock">5.12.1</a> <a class="dropdown-item" href="/5.12.0/Test2::Tools::Mock">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/Test2::Tools::Mock">5.10.1</a> <a class="dropdown-item" href="/5.10.0/Test2::Tools::Mock">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/Test2::Tools::Mock">5.8.9</a> <a class="dropdown-item" href="/5.8.8/Test2::Tools::Mock">5.8.8</a> <a class="dropdown-item" href="/5.8.7/Test2::Tools::Mock">5.8.7</a> <a class="dropdown-item" href="/5.8.6/Test2::Tools::Mock">5.8.6</a> <a class="dropdown-item" href="/5.8.5/Test2::Tools::Mock">5.8.5</a> <a class="dropdown-item" href="/5.8.4/Test2::Tools::Mock">5.8.4</a> <a class="dropdown-item" href="/5.8.3/Test2::Tools::Mock">5.8.3</a> <a class="dropdown-item" href="/5.8.2/Test2::Tools::Mock">5.8.2</a> <a class="dropdown-item" href="/5.8.1/Test2::Tools::Mock">5.8.1</a> <a class="dropdown-item" href="/5.8.0/Test2::Tools::Mock">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/Test2::Tools::Mock">5.6.2</a> <a class="dropdown-item" href="/5.6.1/Test2::Tools::Mock">5.6.1</a> <a class="dropdown-item" href="/5.6.0/Test2::Tools::Mock">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/Test2::Tools::Mock">5.005_04</a> <a class="dropdown-item" href="/5.005_03/Test2::Tools::Mock">5.005_03</a> <a class="dropdown-item" href="/5.005_02/Test2::Tools::Mock">5.005_02</a> <a class="dropdown-item" href="/5.005_01/Test2::Tools::Mock">5.005_01</a> <a class="dropdown-item" href="/5.005/Test2::Tools::Mock">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/Test2::Tools::Mock">blead</a> <a class="dropdown-item" href="/5.41.10/Test2::Tools::Mock">5.41.10</a> <a class="dropdown-item" href="/5.41.9/Test2::Tools::Mock">5.41.9</a> <a class="dropdown-item" href="/5.41.8/Test2::Tools::Mock">5.41.8</a> <a class="dropdown-item" href="/5.41.7/Test2::Tools::Mock">5.41.7</a> <a class="dropdown-item" href="/5.41.6/Test2::Tools::Mock">5.41.6</a> <a class="dropdown-item active" href="/5.41.5/Test2::Tools::Mock">5.41.5</a> <a class="dropdown-item" href="/5.41.4/Test2::Tools::Mock">5.41.4</a> <a class="dropdown-item" href="/5.41.3/Test2::Tools::Mock">5.41.3</a> <a class="dropdown-item" href="/5.41.2/Test2::Tools::Mock">5.41.2</a> <a class="dropdown-item" href="/5.41.1/Test2::Tools::Mock">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/Test2::Tools::Mock">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/Test2::Tools::Mock">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/Test2::Tools::Mock">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/Test2::Tools::Mock">5.39.10</a> <a class="dropdown-item" href="/5.39.9/Test2::Tools::Mock">5.39.9</a> <a class="dropdown-item" href="/5.39.8/Test2::Tools::Mock">5.39.8</a> <a class="dropdown-item" href="/5.39.7/Test2::Tools::Mock">5.39.7</a> <a class="dropdown-item" href="/5.39.6/Test2::Tools::Mock">5.39.6</a> <a class="dropdown-item" href="/5.39.5/Test2::Tools::Mock">5.39.5</a> <a class="dropdown-item" href="/5.39.4/Test2::Tools::Mock">5.39.4</a> <a class="dropdown-item" href="/5.39.3/Test2::Tools::Mock">5.39.3</a> <a class="dropdown-item" href="/5.39.2/Test2::Tools::Mock">5.39.2</a> <a class="dropdown-item" href="/5.39.1/Test2::Tools::Mock">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/Test2::Tools::Mock">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.41.5/perl">Perl</a> <a class="dropdown-item" href="/5.41.5/perlintro">Intro</a> <a class="dropdown-item" href="/5.41.5/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.41.5/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.41.5/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.41.5/perlop">Operators</a> <a class="dropdown-item" href="/5.41.5/functions">Functions</a> <a class="dropdown-item" href="/5.41.5/variables">Variables</a> <a class="dropdown-item" href="/5.41.5/modules">Modules</a> <a class="dropdown-item" href="/5.41.5/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.41.5/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.41.5/perlcommunity">Community</a> <a class="dropdown-item" href="/5.41.5/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.41.5/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.41.5/Test2::Tools::Mock">Test2::Tools::Mock</a> <div id="more"> (<a href="/5.41.5/Test2::Tools::Mock.txt">source</a>, <a href="https://metacpan.org/pod/Test2::Tools::Mock">CPAN</a>) </div> <div id="moduleversion">version 1.302204</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.41.5. This is a development version of Perl. </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#EXPORTS">EXPORTS</a> <ul> <li> <a class="text-decoration-none" href="#DEFAULT">DEFAULT</a> </li> <li> <a class="text-decoration-none" href="#BY-REQUEST">BY REQUEST</a> <ul> <li> <a class="text-decoration-none" href="#DEFINING-MOCKS">DEFINING MOCKS</a> </li> <li> <a class="text-decoration-none" href="#BUILDING-MOCKS">BUILDING MOCKS</a> </li> <li> <a class="text-decoration-none" href="#METHOD-GENERATORS">METHOD GENERATORS</a> </li> </ul> </li> </ul> </li> <li> <a class="text-decoration-none" href="#MOCK-CONTROL-OBJECTS">MOCK CONTROL OBJECTS</a> </li> <li> <a class="text-decoration-none" href="#SOURCE">SOURCE</a> </li> <li> <a class="text-decoration-none" href="#MAINTAINERS">MAINTAINERS</a> </li> <li> <a class="text-decoration-none" href="#AUTHORS">AUTHORS</a> </li> <li> <a class="text-decoration-none" href="#COPYRIGHT">COPYRIGHT</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>Test2::Tools::Mock - Class/Instance mocking for Test2.</p> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p>Mocking is often an essential part of testing. This library covers some of the most common mocking needs. This plugin is heavily influenced by <a href="/5.41.5/Mock::Quick">Mock::Quick</a>, but with an improved API. This plugin is also intended to play well with other plugins in ways <a href="/5.41.5/Mock::Quick">Mock::Quick</a> would be unable to.</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <pre><code>my $mock = mock 'Some::Class' => ( track => $BOOL, # Enable/Disable tracking on subs defined below add => [ new_method => sub { ... }, ], override => [ replace_method => sub { ... }, ], set => [ replace_or_inject => sub { ... }, ], track => $bool, # enable/disable tracking again to affect mocks made after this point ..., # Argument keys may be repeated ); Some::Class->new_method(); # Calls the newly injected method Some::Class->replace_method(); # Calls our replacement method. $mock->override(...) # Override some more $mock = undef; # Undoes all the mocking, restoring all original methods. my $simple_mock = mock {} => ( add => [ is_active => sub { ... } ] ); $simple_mock->is_active(); # Calls our newly mocked method.</code></pre> <h1 id="EXPORTS"><a class="permalink" href="#EXPORTS">#</a>EXPORTS</h1> <h2 id="DEFAULT"><a class="permalink" href="#DEFAULT">#</a>DEFAULT</h2> <dl> <dt id="mock"><a class="permalink" href="#mock">#</a>mock</dt> <dd> <p>This is a one-stop shop function that delegates to one of the other methods depending on how it is used. If you are not comfortable with a function that has a lot of potential behaviors, you can use one of the other functions directly.</p> </dd> <dt id="@mocks-=-mocked($object)"><a class="permalink" href="#@mocks-=-mocked($object)">#</a><a id="mocks-mocked-object"></a>@mocks = mocked($object)</dt> <dd> </dd> <dt id="@mocks-=-mocked($class)"><a class="permalink" href="#@mocks-=-mocked($class)">#</a><a id="mocks-mocked-class"></a>@mocks = mocked($class)</dt> <dd> <p>Check if an object or class is mocked. If it is mocked the <code>$mock</code> object(s) (<a href="/5.41.5/Test2::Mock">Test2::Mock</a>) will be returned.</p> </dd> <dt id="$mock-=-mock-$class-=>-(-...-);"><a class="permalink" href="#$mock-=-mock-$class-=%3E-(-...-);">#</a><a id="mock-mock-class"></a>$mock = mock $class => ( ... );</dt> <dd> </dd> <dt id="$mock-=-mock-$instance-=>-(-...-)"><a class="permalink" href="#$mock-=-mock-$instance-=%3E-(-...-)">#</a><a id="mock-mock-instance"></a>$mock = mock $instance => ( ... )</dt> <dd> </dd> <dt id="$mock-=-mock-'class',-$class-=>-(-...-)"><a class="permalink" href="#$mock-=-mock-'class',-$class-=%3E-(-...-)">#</a><a id="mock-mock-class-class"></a>$mock = mock 'class', $class => ( ... )</dt> <dd> <p>These forms delegate to <code>mock_class()</code> to mock a package. The third form is to be explicit about what type of mocking you want.</p> </dd> <dt id="$obj-=-mock()"><a class="permalink" href="#$obj-=-mock()">#</a><a id="obj-mock"></a>$obj = mock()</dt> <dd> </dd> <dt id="$obj-=-mock-{-...-}"><a class="permalink" href="#$obj-=-mock-%7B-...-%7D">#</a><a id="obj-mock1"></a>$obj = mock { ... }</dt> <dd> </dd> <dt id="$obj-=-mock-'obj',-...;"><a class="permalink" href="#$obj-=-mock-'obj',-...;">#</a><a id="obj-mock-obj"></a>$obj = mock 'obj', ...;</dt> <dd> <p>These forms delegate to <code>mock_obj()</code> to create instances of anonymous packages where methods are vivified into existence as needed.</p> </dd> <dt id="mock-$mock-=>-sub-{-...-}"><a class="permalink" href="#mock-$mock-=%3E-sub-%7B-...-%7D">#</a><a id="mock1"></a><a id="mock-mock-sub"></a>mock $mock => sub { ... }</dt> <dd> </dd> <dt id="mock-$method-=>-(-...-)"><a class="permalink" href="#mock-$method-=%3E-(-...-)">#</a><a id="mock2"></a><a id="mock-method"></a>mock $method => ( ... )</dt> <dd> <p>These forms go together, the first form will set <code>$mock</code> as the current mock build, then run the sub. Within the sub you can declare mock specifications using the second form. The first form delegates to <code>mock_build()</code>.</p> <p>The second form calls the specified method on the current build. This second form delegates to <code>mock_do()</code>.</p> </dd> </dl> <h2 id="BY-REQUEST"><a class="permalink" href="#BY-REQUEST">#</a><a id="BY"></a>BY REQUEST</h2> <h3 id="DEFINING-MOCKS"><a class="permalink" href="#DEFINING-MOCKS">#</a><a id="DEFINING"></a>DEFINING MOCKS</h3> <dl> <dt id="$obj-=-mock_obj(-...-)"><a class="permalink" href="#$obj-=-mock_obj(-...-)">#</a><a id="obj-mock_obj"></a>$obj = mock_obj( ... )</dt> <dd> </dd> <dt id="$obj-=-mock_obj-{-...-}-=>-(-...-)"><a class="permalink" href="#$obj-=-mock_obj-%7B-...-%7D-=%3E-(-...-)">#</a><a id="obj-mock_obj1"></a>$obj = mock_obj { ... } => ( ... )</dt> <dd> </dd> <dt id="$obj-=-mock_obj-sub-{-...-}"><a class="permalink" href="#$obj-=-mock_obj-sub-%7B-...-%7D">#</a><a id="obj-mock_obj-sub"></a>$obj = mock_obj sub { ... }</dt> <dd> </dd> <dt id="$obj-=-mock_obj-{-...-}-=>-sub-{-...-}"><a class="permalink" href="#$obj-=-mock_obj-%7B-...-%7D-=%3E-sub-%7B-...-%7D">#</a><a id="obj-mock_obj-...-sub"></a>$obj = mock_obj { ... } => sub { ... }</dt> <dd> <p>This method lets you quickly generate a blessed object. The object will be an instance of a randomly generated package name. Methods will vivify as read/write accessors as needed.</p> <p>Arguments can be any method available to <a href="/5.41.5/Test2::Mock">Test2::Mock</a> followed by an argument. If the very first argument is a hashref then it will be blessed as your new object.</p> <p>If you provide a coderef instead of key/value pairs, the coderef will be run to build the mock. (See the <a href="#BUILDING-MOCKS">"BUILDING MOCKS"</a> section).</p> </dd> <dt id="$mock-=-mock_class-$class-=>-(-...-)"><a class="permalink" href="#$mock-=-mock_class-$class-=%3E-(-...-)">#</a><a id="mock-mock_class-class"></a>$mock = mock_class $class => ( ... )</dt> <dd> </dd> <dt id="$mock-=-mock_class-$instance-=>-(-...-)"><a class="permalink" href="#$mock-=-mock_class-$instance-=%3E-(-...-)">#</a><a id="mock-mock_class-instance"></a>$mock = mock_class $instance => ( ... )</dt> <dd> </dd> <dt id="$mock-=-mock_class-...-=>-sub-{-...-}"><a class="permalink" href="#$mock-=-mock_class-...-=%3E-sub-%7B-...-%7D">#</a><a id="mock-mock_class-...-sub"></a>$mock = mock_class ... => sub { ... }</dt> <dd> <p>This will create a new instance of <a href="/5.41.5/Test2::Mock">Test2::Mock</a> to control the package specified. If you give it a blessed reference it will use the class of the instance.</p> <p>Arguments can be any method available to <a href="/5.41.5/Test2::Mock">Test2::Mock</a> followed by an argument. If the very first argument is a hashref then it will be blessed as your new object.</p> <p>If you provide a coderef instead of key/value pairs, the coderef will be run to build the mock. (See the <a href="#BUILDING-MOCKS">"BUILDING MOCKS"</a> section).</p> </dd> </dl> <h3 id="BUILDING-MOCKS"><a class="permalink" href="#BUILDING-MOCKS">#</a><a id="BUILDING"></a>BUILDING MOCKS</h3> <dl> <dt id="mock_build-$mock-=>-sub-{-...-}"><a class="permalink" href="#mock_build-$mock-=%3E-sub-%7B-...-%7D">#</a><a id="mock_build"></a><a id="mock_build-mock-sub"></a>mock_build $mock => sub { ... }</dt> <dd> <p>Set <code>$mock</code> as the current build, then run the specified code. <code>$mock</code> will no longer be the current build when the sub is complete.</p> </dd> <dt id="$mock-=-mock_building()"><a class="permalink" href="#$mock-=-mock_building()">#</a><a id="mock-mock_building"></a>$mock = mock_building()</dt> <dd> <p>Get the current building <code>$mock</code> object.</p> </dd> <dt id="mock_do-$method-=>-$args"><a class="permalink" href="#mock_do-$method-=%3E-$args">#</a><a id="mock_do"></a><a id="mock_do-method-args"></a>mock_do $method => $args</dt> <dd> <p>Run the specified method on the currently building object.</p> </dd> </dl> <h3 id="METHOD-GENERATORS"><a class="permalink" href="#METHOD-GENERATORS">#</a><a id="METHOD"></a>METHOD GENERATORS</h3> <dl> <dt id="$sub-=-mock_accessor-$field"><a class="permalink" href="#$sub-=-mock_accessor-$field">#</a><a id="sub-mock_accessor-field"></a>$sub = mock_accessor $field</dt> <dd> <p>Generate a read/write accessor for the specified field. This will generate a sub like the following:</p> <pre><code>$sub = sub { my $self = shift; ($self->{$field}) = @_ if @_; return $self->{$field}; };</code></pre> </dd> <dt id="$sub-=-mock_getter-$field"><a class="permalink" href="#$sub-=-mock_getter-$field">#</a><a id="sub-mock_getter-field"></a>$sub = mock_getter $field</dt> <dd> <p>Generate a read only accessor for the specified field. This will generate a sub like the following:</p> <pre><code>$sub = sub { my $self = shift; return $self->{$field}; };</code></pre> </dd> <dt id="$sub-=-mock_setter-$field"><a class="permalink" href="#$sub-=-mock_setter-$field">#</a><a id="sub-mock_setter-field"></a>$sub = mock_setter $field</dt> <dd> <p>Generate a write accessor for the specified field. This will generate a sub like the following:</p> <pre><code>$sub = sub { my $self = shift; ($self->{$field}) = @_; };</code></pre> </dd> <dt id="%pairs-=-mock_accessors(qw/name1-name2-name3/)"><a class="permalink" href="#%25pairs-=-mock_accessors(qw/name1-name2-name3/)">#</a><a id="pairs-mock_accessors-qw-name1-name2-name3"></a>%pairs = mock_accessors(qw/name1 name2 name3/)</dt> <dd> <p>Generates several read/write accessors at once, returns key/value pairs where the key is the field name, and the value is the coderef.</p> </dd> <dt id="%pairs-=-mock_getters(qw/name1-name2-name3/)"><a class="permalink" href="#%25pairs-=-mock_getters(qw/name1-name2-name3/)">#</a><a id="pairs-mock_getters-qw-name1-name2-name3"></a>%pairs = mock_getters(qw/name1 name2 name3/)</dt> <dd> <p>Generates several read only accessors at once, returns key/value pairs where the key is the field name, and the value is the coderef.</p> </dd> <dt id="%pairs-=-mock_setters(qw/name1-name2-name3/)"><a class="permalink" href="#%25pairs-=-mock_setters(qw/name1-name2-name3/)">#</a><a id="pairs-mock_setters-qw-name1-name2-name3"></a>%pairs = mock_setters(qw/name1 name2 name3/)</dt> <dd> <p>Generates several write accessors at once, returns key/value pairs where the key is the field name, and the value is the coderef.</p> </dd> </dl> <h1 id="MOCK-CONTROL-OBJECTS"><a class="permalink" href="#MOCK-CONTROL-OBJECTS">#</a><a id="MOCK"></a>MOCK CONTROL OBJECTS</h1> <pre><code>my $mock = mock(...);</code></pre> <p>Mock objects are instances of <a href="/5.41.5/Test2::Mock">Test2::Mock</a>. See it for their methods.</p> <h1 id="SOURCE"><a class="permalink" href="#SOURCE">#</a>SOURCE</h1> <p>The source code repository for Test2-Suite can be found at <a href="https://github.com/Test-More/test-more/">https://github.com/Test-More/test-more/</a>.</p> <h1 id="MAINTAINERS"><a class="permalink" href="#MAINTAINERS">#</a>MAINTAINERS</h1> <dl> <dt id="Chad-Granum-<exodist@cpan.org>"><a class="permalink" href="#Chad-Granum-%3Cexodist@cpan.org%3E">#</a><a id="Chad"></a><a id="Chad-Granum-exodist-cpan.org"></a>Chad Granum <exodist@cpan.org></dt> <dd> </dd> </dl> <h1 id="AUTHORS"><a class="permalink" href="#AUTHORS">#</a>AUTHORS</h1> <dl> <dt id="Chad-Granum-<exodist@cpan.org>1"><a class="permalink" href="#Chad-Granum-%3Cexodist@cpan.org%3E1">#</a><a id="Chad1"></a><a id="Chad-Granum-exodist-cpan.org1"></a>Chad Granum <exodist@cpan.org></dt> <dd> </dd> </dl> <h1 id="COPYRIGHT"><a class="permalink" href="#COPYRIGHT">#</a>COPYRIGHT</h1> <p>Copyright Chad Granum <exodist@cpan.org>.</p> <p>This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p> <p>See <a href="https://dev.perl.org/licenses/">https://dev.perl.org/licenses/</a></p> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

Test2::Tools::Mock - Class/Instance mocking for Test2. - Perldoc Browser