From 11f9084522ee5a134232903171f4b953cce5c1d5 Mon Sep 17 00:00:00 2001 From: Packit Date: Sep 16 2020 16:25:24 +0000 Subject: perl-Test-MockModule-0.13 base --- diff --git a/Build.PL b/Build.PL new file mode 100644 index 0000000..3df0329 --- /dev/null +++ b/Build.PL @@ -0,0 +1,40 @@ +use strict; +use warnings; +use Module::Build; + +my $builder = Module::Build->new( + module_name => 'Test::MockModule', + create_license => 1, + license => 'GPL_3', + dist_author => [q{Current Maintainer: Geoff Franks }, q{Original Author: Simon Flack }], + dist_version_from => 'lib/Test/MockModule.pm', + meta_merge => { + resources => { + homepage => 'https://github.com/geofffranks/test-mockmodule', + bugtracker => 'https://github.com/geofffranks/test-mockmodule/issues', + repository => 'git://github.com/geofffranks/test-mockmodule.git', + }, + }, + + configure_requires => { + 'Module::Build' => '0.38', + }, + requires => { + 'perl' => 5.006, + 'Carp' => 0, + 'Scalar::Util' => 0, + 'SUPER' => 0, + }, + build_requires => { + 'Test::More' => 0.88, + }, + + add_to_cleanup => [ + 'Test-MockModule-*', + 'cover_db', + '*.rpm', + '*.deb', + ] +); + +$builder->create_build_script(); diff --git a/Changes b/Changes new file mode 100644 index 0000000..4b595f0 --- /dev/null +++ b/Changes @@ -0,0 +1,48 @@ +Revision history for Test::MockModule + +v0.13 + - Added the `redefine()` function. It works just like `mock()`, except if the + method being mocked doesn't exist, it causes a panic. Many thanks to Felipe + Gasper for this feature! + +v0.12 + - Added the `noop()` function to make mocking noops easier. Thanks for the PR, + Ali Zia! + +v0.11 2016-10-27 + - Various housekeeping, testing and minor fixes, courtesy of Paul Cochrane, thanks! + +v0.10 2015-05-30 + - Updated docs for mocking when using exported functions + +v0.09 2015-03-15 + - Ensure LICENSE autogenerates for distribution, fixed license issues in Build.PL + +v0.08 2015-03-14 + - Updated README with correct instructions now that we use Build.PL + +v0.07 2015-03-14 + - Updated docs for more clarity when handling objects of mocked classes. + +v0.06 2015-03-07 + - unmock() on inherited subroutines will dispatch to the parent module, + rather than replace the local subroutine with the parent's subroutine + from the time of mocking (RT77439) + +v0.05 2004-03-24 + - unmock() accepts a list of subroutines to unmock. Thanks to David Wheeler + for the suggestion and patch + - Added t/pod_coverage.t + +v0.04 2004-12-12 + - You can now mock a subroutine with a scalar value or a reference + (install sub that returns the value). Thanks to Ovid for the suggestion. + +v0.03 2004-12-05 + - Restores subs/methods that previously didn't exist (undefine them) + +v0.02 2004-11-28 + - Fixed restoring inherited methods + +v0.01 2004-11-28 + - Initial revision diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5575488 --- /dev/null +++ b/LICENSE @@ -0,0 +1,680 @@ +This software is Copyright (c) 2017 by Current Maintainer: Geoff Franks & Original Author: Simon Flack . + +This is free software, licensed under: + + The GNU General Public License, Version 3, June 2007 + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..2288621 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,14 @@ +Build.PL +Changes +lib/Test/MockModule.pm +LICENSE +MANIFEST This list of files +MANIFEST.SKIP +META.json +META.yml +README.md +t/inheritance.t +t/lib/ExampleModule.pm +t/mockmodule.t +t/pod.t +t/pod_coverage.t diff --git a/MANIFEST.SKIP b/MANIFEST.SKIP new file mode 100644 index 0000000..559567c --- /dev/null +++ b/MANIFEST.SKIP @@ -0,0 +1,77 @@ + +#!start included /usr/share/perl/5.14/ExtUtils/MANIFEST.SKIP +# Avoid version control files. +\bRCS\b +\bCVS\b +\bSCCS\b +,v$ +\B\.svn\b +\B\.git\b +\B\.gitignore\b +\b_darcs\b +\B\.cvsignore$ + +# Avoid VMS specific MakeMaker generated files +\bDescrip.MMS$ +\bDESCRIP.MMS$ +\bdescrip.mms$ + +# Avoid Makemaker generated and utility files. +\bMANIFEST\.bak +\bMakefile$ +\bblib/ +\bMakeMaker-\d +\bpm_to_blib\.ts$ +\bpm_to_blib$ +\bblibdirs\.ts$ # 6.18 through 6.25 generated this + +# Avoid Module::Build generated and utility files. +\bBuild$ +\b_build/ +\bBuild.bat$ +\bBuild.COM$ +\bBUILD.COM$ +\bbuild.com$ + +# Avoid temp and backup files. +~$ +\.old$ +\#$ +\b\.# +\.bak$ +\.tmp$ +\.# +\.rej$ + +# Avoid OS-specific files/dirs +# Mac OSX metadata +\B\.DS_Store +# Mac OSX SMB mount metadata files +\B\._ + +# Avoid Devel::Cover and Devel::CoverX::Covered files. +\bcover_db\b +\bcovered\b + +# Avoid MYMETA files +^MYMETA\. +#!end included /usr/share/perl/5.14/ExtUtils/MANIFEST.SKIP + +# Avoid configuration metadata file +^MYMETA\. + +# Avoid Module::Build generated and utility files. +\bBuild$ +\bBuild.bat$ +\b_build +\bBuild.COM$ +\bBUILD.COM$ +\bbuild.com$ +#^MANIFEST\.SKIP + +# Avoid archives of this distribution +^Test-MockModule-* +^t/tmp + +# Avoid Travis-CI configuration file +\.travis.yml diff --git a/META.json b/META.json new file mode 100644 index 0000000..5b5ac1a --- /dev/null +++ b/META.json @@ -0,0 +1,58 @@ +{ + "abstract" : "Override subroutines in a module for unit testing", + "author" : [ + "Current Maintainer: Geoff Franks ", + "Original Author: Simon Flack " + ], + "dynamic_config" : 1, + "generated_by" : "Module::Build version 0.4214", + "license" : [ + "gpl_3" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : "2" + }, + "name" : "Test-MockModule", + "prereqs" : { + "build" : { + "requires" : { + "Test::More" : "0.88" + } + }, + "configure" : { + "requires" : { + "Module::Build" : "0.38" + } + }, + "runtime" : { + "requires" : { + "Carp" : "0", + "SUPER" : "0", + "Scalar::Util" : "0", + "perl" : "5.006" + } + } + }, + "provides" : { + "Test::MockModule" : { + "file" : "lib/Test/MockModule.pm", + "version" : "0.13" + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "https://github.com/geofffranks/test-mockmodule/issues" + }, + "homepage" : "https://github.com/geofffranks/test-mockmodule", + "license" : [ + "http://www.gnu.org/licenses/gpl-3.0.txt" + ], + "repository" : { + "url" : "git://github.com/geofffranks/test-mockmodule.git" + } + }, + "version" : "0.13", + "x_serialization_backend" : "JSON::PP version 2.27400" +} diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..8c9088c --- /dev/null +++ b/META.yml @@ -0,0 +1,32 @@ +--- +abstract: 'Override subroutines in a module for unit testing' +author: + - 'Current Maintainer: Geoff Franks ' + - 'Original Author: Simon Flack ' +build_requires: + Test::More: '0.88' +configure_requires: + Module::Build: '0.38' +dynamic_config: 1 +generated_by: 'Module::Build version 0.4214, CPAN::Meta::Converter version 2.150005' +license: gpl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: '1.4' +name: Test-MockModule +provides: + Test::MockModule: + file: lib/Test/MockModule.pm + version: '0.13' +requires: + Carp: '0' + SUPER: '0' + Scalar::Util: '0' + perl: '5.006' +resources: + bugtracker: https://github.com/geofffranks/test-mockmodule/issues + homepage: https://github.com/geofffranks/test-mockmodule + license: http://www.gnu.org/licenses/gpl-3.0.txt + repository: git://github.com/geofffranks/test-mockmodule.git +version: '0.13' +x_serialization_backend: 'CPAN::Meta::YAML version 0.016' diff --git a/README.md b/README.md new file mode 100644 index 0000000..d18b088 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Test::MockModule - mock subroutines in a module + +See the LICENSE section in `lib/Test/MockModule.pm` for usage and +distribution rights. + +## Installation + +Run these commands in the source directory: + + perl Build.PL + ./Build + ./Build test + ./Build install + +Then delete the source directory tree since it's no longer needed. + +Alternatively, you can simply install the module via `cpanm`: + + cpanm Test::MockModule + +## Documentation + +Run `perldoc Test::MockModule` to read the full documentation. diff --git a/lib/Test/MockModule.pm b/lib/Test/MockModule.pm new file mode 100644 index 0000000..63272b3 --- /dev/null +++ b/lib/Test/MockModule.pm @@ -0,0 +1,390 @@ +package Test::MockModule; +use strict qw/subs vars/; +use vars qw/$VERSION/; +use Scalar::Util qw/reftype weaken/; +use Carp; +use SUPER; +$VERSION = '0.13'; + +my %mocked; +sub new { + my $class = shift; + my ($package, %args) = @_; + if ($package && (my $existing = $mocked{$package})) { + return $existing; + } + + croak "Cannot mock $package" if $package && $package eq $class; + unless (_valid_package($package)) { + $package = 'undef' unless defined $package; + croak "Invalid package name $package"; + } + + unless ($args{no_auto} || ${"$package\::VERSION"}) { + (my $load_package = "$package.pm") =~ s{::}{/}g; + TRACE("$package is empty, loading $load_package"); + require $load_package; + } + + TRACE("Creating MockModule object for $package"); + my $self = bless { + _package => $package, + _mocked => {}, + }, $class; + $mocked{$package} = $self; + weaken $mocked{$package}; + return $self; +} + +sub DESTROY { + my $self = shift; + $self->unmock_all; +} + +sub get_package { + my $self = shift; + return $self->{_package}; +} + +sub redefine { + my ($self, @mocks) = (shift, @_); + + while ( my ($name, $value) = splice @mocks, 0, 2 ) { + my $sub_name = $self->_full_name($name); + my $coderef = *{$sub_name}{'CODE'}; + if ('CODE' ne ref $coderef) { + croak "$sub_name does not exist!"; + } + } + + return $self->mock(@_); +} + +sub mock { + my $self = shift; + + while (my ($name, $value) = splice @_, 0, 2) { + my $code = sub { }; + if (ref $value && reftype $value eq 'CODE') { + $code = $value; + } elsif (defined $value) { + $code = sub {$value}; + } + + TRACE("$name: $code"); + croak "Invalid subroutine name: $name" unless _valid_subname($name); + my $sub_name = _full_name($self, $name); + if (!$self->{_mocked}{$name}) { + TRACE("Storing existing $sub_name"); + $self->{_mocked}{$name} = 1; + if (defined &{$sub_name}) { + $self->{_orig}{$name} = \&$sub_name; + } else { + $self->{_orig}{$name} = undef; + } + } + TRACE("Installing mocked $sub_name"); + _replace_sub($sub_name, $code); + } +} + +sub noop { + my $self = shift; + $self->mock($_,1) for @_; +} + +sub original { + my $self = shift; + my ($name) = @_; + return carp _full_name($self, $name) . " is not mocked" + unless $self->{_mocked}{$name}; + return defined $self->{_orig}{$name} ? $self->{_orig}{$name} : $self->{_package}->super($name); +} +sub unmock { + my $self = shift; + + for my $name (@_) { + croak "Invalid subroutine name: $name" unless _valid_subname($name); + + my $sub_name = _full_name($self, $name); + unless ($self->{_mocked}{$name}) { + carp $sub_name . " was not mocked"; + next; + } + + TRACE("Restoring original $sub_name"); + _replace_sub($sub_name, $self->{_orig}{$name}); + delete $self->{_mocked}{$name}; + delete $self->{_orig}{$name}; + } + return $self; +} + +sub unmock_all { + my $self = shift; + foreach (keys %{$self->{_mocked}}) { + $self->unmock($_); + } +} + +sub is_mocked { + my $self = shift; + my ($name) = shift; + return $self->{_mocked}{$name}; +} + +sub _full_name { + my ($self, $sub_name) = @_; + sprintf "%s::%s", $self->{_package}, $sub_name; +} + +sub _valid_package { + defined($_[0]) && $_[0] =~ /^[a-z_]\w*(?:::\w+)*$/i; +} + +sub _valid_subname { + $_[0] =~ /^[a-z_]\w*$/i; +} + +sub _replace_sub { + my ($sub_name, $coderef) = @_; + # from Test::MockObject + local $SIG{__WARN__} = sub { warn $_[0] unless $_[0] =~ /redefined/ }; + if (defined $coderef) { + *{$sub_name} = $coderef; + } else { + TRACE("removing subroutine: $sub_name"); + my ($package, $sub) = $sub_name =~ /(.*::)(.*)/; + my %symbols = %{$package}; + + # save a copy of all non-code slots + my %slot; + foreach (qw(ARRAY FORMAT HASH IO SCALAR)) { + next unless defined(my $elem = *{$symbols{$sub}}{$_}); + $slot{$_} = $elem; + } + + # clear the symbol table entry for the subroutine + undef *$sub_name; + + # restore everything except the code slot + return unless keys %slot; + foreach (keys %slot) { + *$sub_name = $slot{$_}; + } + } +} + +# Log::Trace stubs +sub TRACE {} +sub DUMP {} + +1; + +=pod + +=head1 NAME + +Test::MockModule - Override subroutines in a module for unit testing + +=head1 SYNOPSIS + + use Module::Name; + use Test::MockModule; + + { + my $module = Test::MockModule->new('Module::Name'); + $module->mock('subroutine', sub { ... }); + Module::Name::subroutine(@args); # mocked + + #Same effect, but this will die() if other_subroutine() + #doesn't already exist, which is often desirable. + $module->redefine('other_subroutine', sub { ... }); + } + + Module::Name::subroutine(@args); # original subroutine + + # Working with objects + use Foo; + use Test::MockModule; + { + my $mock = Test::MockModule->new('Foo'); + $mock->mock(foo => sub { print "Foo!\n"; }); + + my $foo = Foo->new(); + $foo->foo(); # prints "Foo!\n" + } + +=head1 DESCRIPTION + +C lets you temporarily redefine subroutines in other packages +for the purposes of unit testing. + +A C 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 C the subroutine. + +=head1 METHODS + +=over 4 + +=item new($package[, %options]) + +Returns an object that will mock subroutines in the specified C<$package>. + +If there is no C<$VERSION> defined in C<$package>, the module will be +automatically loaded. You can override this behaviour by setting the C +option: + + my $mock = Test::MockModule->new('Module::Name', no_auto => 1); + +=item get_package() + +Returns the target package name for the mocked subroutines + +=item is_mocked($subroutine) + +Returns a boolean value indicating whether or not the subroutine is currently +mocked + +=item mock($subroutine =E \Ecoderef) + +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. + +The following statements are equivalent: + + $module->mock(purge => 'purged'); + $module->mock(purge => sub { return 'purged'}); + +When dealing with references, things behave slightly differently. The following +statements are B equivalent: + + # 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()]}); + +The following statements are in fact equivalent: + + my $array_ref = [localtime()] + $module->mock(updated => $array_ref) + $module->mock(updated => sub { return $array_ref }); + + +However, C is a special case. If you mock a subroutine with C it +will install an empty subroutine + + $module->mock(purge => undef); + $module->mock(purge => sub { }); + +rather than a subroutine that returns C: + + $module->mock(purge => sub { undef }); + +You can call C for the same subroutine many times, but when you call +C, the original subroutine is restored (not the last mocked +instance). + +B + +If you are trying to mock a subroutine exported from another module, this may +not behave as you initialy 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: + + 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 + +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: + + 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-tewntyfour` got mocked"; # fails + + my $mymodule = Test::MockModule->new("MyModule", no_auto => 1); + $mymodule->mock("strftime", "Yesterday"); + is MyModule::minus_twentyfour(), "Yesterday", "`minus-tewntyfour` got mocked"; # suceeds + +=item redefine($subroutine) + +The same behavior as C, 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. + +=item original($subroutine) + +Returns the original (unmocked) subroutine + +=item unmock($subroutine [, ...]) + +Restores the original C<$subroutine>. You can specify a list of subroutines to +C in one go. + +=item unmock_all() + +Restores all the subroutines in the package that were mocked. This is +automatically called when all C objects for the given package +go out of scope. + +=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! + + # Neuter a list of methods in one go + $module->noop('purge', 'updated'); + +=back + +=head1 SEE ALSO + +L + +L + +=head1 AUTHORS + +Current Maintainer: Geoff Franks + +Original Author: Simon Flack Esimonflk _AT_ cpan.orgE + +=head1 COPYRIGHT + +Copyright 2004 Simon Flack Esimonflk _AT_ cpan.orgE. +All rights reserved + +You may distribute under the terms of either the GNU General Public License or +the Artistic License, as specified in the Perl README file. + +=cut diff --git a/t/inheritance.t b/t/inheritance.t new file mode 100644 index 0000000..c5f1404 --- /dev/null +++ b/t/inheritance.t @@ -0,0 +1,42 @@ +use warnings; +use strict; + +use Test::MockModule; +use Test::More; + +@Bar::ISA = 'Foo'; +@Baz::ISA = 'Bar'; + +sub Foo::motto { 'Foo!' }; + +is(Foo->motto(), "Foo!", "pre-mock: Foo original motto is correct"); +is(Bar->motto(), "Foo!", "pre-mock: Bar inherit's Foo's motto"); +is(Baz->motto(), "Foo!", "pre-mock: Baz inherit's Bar's inheritance of Foo's motto"); + +{ + my $mock_bar = Test::MockModule->new('Bar', no_auto => 1); + $mock_bar->mock('motto', sub { 'Bar!' }); + is(Foo->motto(), "Foo!", "Foo motto is unchanged post-Bar mock"); + is(Bar->motto(), "Bar!", "Bar motto has been mocked"); + is(Baz->motto(), "Bar!", "Baz inherits from Bar's mocked motto"); + is($mock_bar->original("motto")->(), "Foo!", "Bar's original function can still be reached correctly"); + ok($mock_bar->is_mocked("motto"), "Baz's motto is really mocked"); + + my $mock_baz = Test::MockModule->new('Baz', no_auto => 1); + $mock_baz->mock('motto', sub { 'Baz!' }); + is(Foo->motto(), "Foo!", "Foo motto is unchanged post-Baz mock"); + is(Bar->motto(), "Bar!", "Bar motto is unchanged post-Baz mock"); + is(Baz->motto(), "Baz!", "Baz motto has been mocked"); + + is($mock_baz->original("motto")->(), "Bar!", "Baz's original function is Bar's mocked function"); + ok($mock_baz->is_mocked("motto"), "Baz's motto is really mocked"); + + $mock_bar->unmock("motto"); + is(Bar->motto, "Foo!", "Bar's motto is unmocked"); + is($mock_baz->original("motto")->(), "Foo!", "Baz's original function is now magically inherited up to Foo"); +} + +is(Foo->motto(), "Foo!", "post-unmock: Foo original motto is correct"); +is(Bar->motto(), "Foo!", "post-unmock: Bar inherit's Foo's motto"); +is(Baz->motto(), "Foo!", "post-unmock: Baz inherit's Bar's inheritance of Foo's motto"); +done_testing; diff --git a/t/lib/ExampleModule.pm b/t/lib/ExampleModule.pm new file mode 100644 index 0000000..de06a69 --- /dev/null +++ b/t/lib/ExampleModule.pm @@ -0,0 +1,20 @@ +package ExampleModule; + +use strict; +use warnings; + +# This is an example module used by Test::MockModule for testing. + +sub Vars { + return; +} + +sub param { + return; +} + +sub cookie { + return 'choc-chip'; +} + +1; diff --git a/t/mockmodule.t b/t/mockmodule.t new file mode 100644 index 0000000..163d131 --- /dev/null +++ b/t/mockmodule.t @@ -0,0 +1,163 @@ +use warnings; +use strict; + +use Test::More; + +use lib "t/lib"; + +BEGIN { + use_ok('Test::MockModule') or BAIL_OUT "Could not load Test::MockModule. Giving up"; +} + +package Test_Package; +our $VERSION=1; +sub listify { + my ($lower, $upper) = @_; + return ($lower .. $upper); +} +package main; + +# new() +ok(Test::MockModule->can('new'), 'new()'); +eval {Test::MockModule->new('Test::MockModule')}; +like($@, qr/Cannot mock Test::MockModule/, '... cannot mock itself'); +eval {Test::MockModule->new('12Monkeys')}; +like($@, qr/Invalid package name/, ' ... croaks if package looks invalid'); +eval {Test::MockModule->new()}; +like($@, qr/Invalid package name/, ' ... croaks if package is undefined'); + +{ + { + Test::MockModule->new('ExampleModule', no_auto => 1); + ok(!$INC{'ExampleModule.pm'}, '... no_auto prevents module being loaded'); + } + + my $mcgi = Test::MockModule->new('ExampleModule'); + ok($INC{'ExampleModule.pm'}, '... module loaded if !$VERSION'); + ok($mcgi->isa('Test::MockModule'), '... returns a Test::MockModule object'); + my $mcgi2 = Test::MockModule->new('ExampleModule'); + is($mcgi, $mcgi2, + "... returns existing object if there's already one for the package"); + + # get_package() + ok($mcgi->can('get_package'), 'get_package'); + is($mcgi->get_package, 'ExampleModule', '... returns the package name'); + + # mock() + + ok($mcgi->can('mock'), 'mock()'); + eval {$mcgi->mock(q[p-ram])}; + + like($@, qr/Invalid subroutine name: /, + '... dies if a subroutine name is invalid'); + + my $orig_param = \&ExampleModule::param; + $mcgi->mock('param', sub {return qw(abc def)}); + my @params = ExampleModule::param(); + is_deeply(\@params, ['abc', 'def'], + '... replaces the subroutine with a mocked sub'); + + $mcgi->mock('param' => undef); + @params = ExampleModule::param(); + is_deeply(\@params, [], '... which is an empty sub if !defined'); + + $mcgi->mock(param => 'The quick brown fox jumped over the lazy dog'); + my $a2z = ExampleModule::param(); + is($a2z, 'The quick brown fox jumped over the lazy dog', + '... or a subroutine returning the supplied value'); + + my $ref = [1,2,3]; + $mcgi->mock(param => $ref); + @params = ExampleModule::param(); + is($params[0], $ref, + '... given a reference, install a sub that returns said reference'); + + my $blessed_code = bless sub { return 'Hello World' }, 'FOO'; + $mcgi->mock(param => $blessed_code); + @params = ExampleModule::param(); + is($params[0], 'Hello World', '... a blessed coderef is properly detected'); + + $mcgi->mock(Just => 'another', Perl => 'Hacker'); + @params = (ExampleModule::Just(), ExampleModule::Perl()); + is_deeply(\@params, ['another', 'Hacker'], + '... can mock multiple subroutines at a time'); + + + # original() + ok($mcgi->can('original'), 'original()'); + is($mcgi->original('param'), $orig_param, + '... returns the original subroutine'); + my ($warn); + local $SIG{__WARN__} = sub {$warn = shift}; + $mcgi->original('Vars'); + like($warn, qr/ is not mocked/, "... warns if a subroutine isn't mocked"); + + # unmock() + ok($mcgi->can('unmock'), 'unmock()'); + eval {$mcgi->unmock('V@rs')}; + like($@, qr/Invalid subroutine name/, + '... dies if the subroutine is invalid'); + + $warn = ''; + $mcgi->unmock('Vars'); + like($warn, qr/ was not mocked/, "... warns if a subroutine isn't mocked"); + + $mcgi->unmock('param'); + is(\&{"ExampleModule::param"}, $orig_param, '... restores the original subroutine'); + + # unmock_all() + ok($mcgi->can('unmock_all'), 'unmock_all'); + $mcgi->mock('Vars' => sub {1}, param => sub {2}); + ok(ExampleModule::Vars() == 1 && ExampleModule::param() == 2, + 'mock: can mock multiple subroutines'); + my @orig = ($mcgi->original('Vars'), $mcgi->original('param')); + $mcgi->unmock_all(); + ok(\&ExampleModule::Vars eq $orig[0] && \&ExampleModule::param eq $orig[1], + '... removes all mocked subroutines'); + + # is_mocked() + ok($mcgi->can('is_mocked'), 'is_mocked'); + ok(!$mcgi->is_mocked('param'), '... returns false for non-mocked sub'); + $mcgi->mock('param', sub { return 'This sub is mocked' }); + is(ExampleModule::param(), 'This sub is mocked', '... mocked params'); + ok($mcgi->is_mocked('param'), '... returns true for non-mocked sub'); + + # noop() + is(ExampleModule::cookie(), 'choc-chip', 'cookie does default behaviour'); + $mcgi->noop('cookie'); + ok($mcgi->is_mocked('cookie'), 'cookie is mocked using noop'); + $mcgi->unmock('cookie'); + $mcgi->unmock('Vars'); + $mcgi->noop('cookie', 'Vars'); + is(ExampleModule::cookie(), 1, 'now cookie does nothing'); + is(ExampleModule::Vars(), 1, 'now Vars does nothing'); +} + +isnt(ExampleModule::param(), 'This sub is mocked', + '... params is unmocked when object goes out of scope'); + +# test inherited methods +package Test_Parent; +sub method { 1 } +package Test_Child; +@Test_Child::ISA = 'Test_Parent'; +package main; + +my $test_mock = Test::MockModule->new('Test_Child', no_auto => 1); +ok(Test_Child->can('method'), 'test class inherits from parent'); +$test_mock->mock('method' => sub {2}); +is(Test_Child->method, 2, 'mocked subclass method'); +$test_mock->unmock('method'); +ok(Test_Child->can('method'), 'unmocked subclass method still exists'); +is(Test_Child->method, 1, 'mocked subclass method'); + +# test restoring non-existant functions +$test_mock->mock(ISA => sub {'basic test'}); +can_ok(Test_Child => 'ISA'); +is(Test_Child::ISA(), 'basic test', + "testing a mocked sub that didn't exist before"); +$test_mock->unmock('ISA'); +ok(!Test_Child->can('ISA') && $Test_Child::ISA[0] eq 'Test_Parent', + "restoring an undefined sub doesn't clear out the rest of the symbols"); + +done_testing; diff --git a/t/pod.t b/t/pod.t new file mode 100644 index 0000000..3f90bd3 --- /dev/null +++ b/t/pod.t @@ -0,0 +1,8 @@ +use warnings; +use strict; + +use Test::More; + +eval "use Test::Pod 1.00"; +plan skip_all => "Test::Pod 1.00 required for testing POD" if $@; +all_pod_files_ok(); diff --git a/t/pod_coverage.t b/t/pod_coverage.t new file mode 100644 index 0000000..ca3fda2 --- /dev/null +++ b/t/pod_coverage.t @@ -0,0 +1,8 @@ +use warnings; +use strict; + +use Test::More; + +eval "use Test::Pod::Coverage 1.00"; +plan skip_all => "Test::Pod::Coverage 1.00 required for testing pod coverage" if $@; +all_pod_coverage_ok({also_private => [qr/^TRACE(?:F|_HERE)?|DUMP$/]});