Test2-Workflow-0.000017000755001750001750 012747547341 15111 5ustar00exodistexodist000000000000README100644001750001750 2067312747547341 16102 0ustar00exodistexodist000000000000Test2-Workflow-0.000017NAME Test2::Workflow - Interface for writing 'workflow' tools such as RSPEC implementations that all play nicely together. *** EXPERIMENTAL *** This distribution is experimental, anything can change at any time! DESCRIPTION This module intends to do for 'workflow' test tools what Test::Builder and Test2 do for general test tools. The problem with workflow tools is that most do not play well together. This module is a very generic/abstract look at workflows that allows tools to be built that accomplish their workflows, but in a way that plays well with others. SYNOPSIS package My::Workflow::Tool; use Test2::Workflow qw/gen_unit_builder/; our @EXPORT = qw/my_wrapper/; use base 'Exporter'; # Create a wrapping tool *my_wrapper = gen_unit_builder('simple' => qw/buildup teardown/); To use it: use My::Workflow::Tool qw/my_wrapper/; my_wrapper foo => sub { my $inner = shift; ... $inner->(); ... }; IMPORTANT CONCEPTS A workflow is a way of defining tests with scaffolding. Essentially you are seperating your assertions and your setup/teardown/management code. This results in a separation of concerns that can produce more maintainable tests. In addition each component of a workflow can be re-usable and/or inheritable. UNITS Units are the small composable parts of a workflow. You can think of a unit as a named function that does some work. What separates a unit from a regular function is that it can have other units attashed to it in various ways. A unit can also be a 'group' unit, which means it contains other units as its primary work. See Test2::Workflow::Unit. PACKAGE UNIT The package unit is the root 'group' unit for your test package. All other test units get put into the main package unit. See Test2::Workflow::Meta where the primary unit is stored. BUILDS Units are generally defined using a DSL (Domain Specific Language). In this DSL you declare a unit, which gets added as the current build, then run code which modifies that build to turn it into the unit you need. BUILD STACK Builds can be defined within one another, as such the 'current' build is whatever build is on top of the build stack, which is a private array. There are low level functions exposed to give you control over the stack if you need it, but in general you should use a higher level tool. TASK A task is a composition of units to be run. The runner will compile you units into task form, then run the compiled tasks. VAR STASH There is a var stash. The var stash is a stack of hashes. Every time a task is run a new hash is pushed onto the stack. When a task is complete the hash is popped and cleared. Workflow tools may use this hash to store/define variables that will go away when the current task is complete. EXPORTS All exports are optional, you must request the ones you want. BUILD STACK $unit = workflow_build() Get the unit at the top of the build stack, if any. $unit = workflow_current() Get the unit at the top of the build stack, if there is none then return the root unit for the package the function is called from. push_workflow_build($unit) Push a unit onto the build stack. pop_workflow_build($unit) Pop a unit from the build stack. You must provide the $unit you expect to pop, and it must match the one at the top of the stack. VAR STASH $val = workflow_var($name) $val = workflow_var($name, $val) $val = workflow_var($name, \&default) This function will get/set a variable in the var stash. If only a name is provided then it will return the current value, or undef. If you provide a value as the second argument then the value will be set. A coderef can be passed in as the second argument. If a coderef is used it will be considered a default generator. If the variable name already has a value then that value will be kept and returned. If the variable has not been set then the coderef will be run and the value it returns will be stored and returned. $hr = push_workflow_vars() push_workflow_vars($hr) You can manually push a new hashref to the top of the vars stack. If you do this you need to be sure to pop it before anything else tries to pop any hash below yours in the stack. You can provide a hashref to push, or it will create a new one for you. pop_workflow_vars($hr) This will let you manually pop the workflow vars stack. You must provide a reference to the item you think is at the top of the stack (the one you want to pop). If something else is on top of the stack then an exception will be thrown. $bool = has_workflow_vars() Check if there is a workflow vars hash on the stack. This will return false if there is nothing on the stack. Currently this returns the number of items in the stack, but that may change so do not depend on that behavior. META DATA $meta = workflow_meta() Get the Test2::Workflow::Meta object associated with the current package. workflow_runner($runner) Set the runner to use. The runner can be a package name, or a blessed object. Whichever you provide, it must have a 'run' method. The run method will be called directly on what you provide, that is if you provide a package name then it will call "$package->run()" "new()" will not be called for you. workflow_runner_args(\@args) Arguments that should be passed to the "run()" method of your runner. workflow_run() Run the workflow now. CREATING UNITS $unit = group_builder($name, \%params, sub { ... }) $unit = group_builder($name, sub { ... }) group_builder($name, \%params, sub { ... }) group_builder($name, sub { ... }) The group builder will create a new unit with the given name and parameters. The new unit will be placed onto the build stack, and the code reference you provide will be run. Once the code reference returns the unit will be removed from the build stack. If called in void context the unit will be added to the next unit on the build stack, or to the package root unit. If called in any other context the unit will be returned. $sub = gen_unit_builder($callback, @stashes) This will return a coderef that accepts the typical $name, optional "\%params", and "\&code" arguments. The code returned will construct your unit for you, and then insert it into the specified stashes of the current build whenever it is called. Typically you will only specify one stash, but you may combine "buildup" and "teardown" if the builder you are creating is supposed to wrap other units. Stashes: primary A primary action. modify Something to modify the primary actions. buildup Something to run before the primary actions. teardown Something to run after the primary actions. ($unit, $code, $caller) = new_proto_unit(\%params) level => 1 caller => [caller($level)] args => [$name, \%params, \&code] args => [$name, \&code] set_primary => $bool unit => \%attributes This is used under the hood by "gen_unit_builder()". This will parse the 2 or 3 typical input arguments, verify them, and return a new Test2::Workflow::Unit, the coderef that was passed in, and a caller arrayref. If you use this it is your job to put the unit where it should be. Normally "gen_unit_builder" and "group_builder" are all you should need. SEE ALSO Test2::Tools::Spec Test2::Tools::Spec is an implementation of RSPEC using this library. SOURCE The source code repository for Test2-Workflow can be found at http://github.com/Test-More/Test2-Workflow/. MAINTAINERS Chad Granum AUTHORS Chad Granum COPYRIGHT Copyright 2015 Chad Granum . This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://dev.perl.org/licenses/ LICENSE100644001750001750 4365212747547341 16231 0ustar00exodistexodist000000000000Test2-Workflow-0.000017This software is copyright (c) 2016 by Chad Granum. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2016 by Chad Granum. This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the 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 a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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. END OF TERMS AND CONDITIONS Appendix: 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 humanity, 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 convey 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) 19yy 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 1, 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision 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, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2016 by Chad Granum. This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Changes100644001750001750 356012747547341 16471 0ustar00exodistexodist000000000000Test2-Workflow-0.0000170.000017 2016-07-31 21:24:00-07:00 America/Los_Angeles - Fix acceptance5.t to not assume fork is used. 0.000016 2016-07-29 12:37:29-07:00 America/Los_Angeles - Require newer Importer.pm for :ALL tag 0.000015 2016-07-28 07:07:37-07:00 America/Los_Angeles - Run blocks when done_testing is missing (#3) - Add spec_defaults() 0.000014 2016-07-02 22:11:29-07:00 America/Los_Angeles - No Changes from last trial 0.000013 2016-07-01 17:33:24-07:00 America/Los_Angeles (TRIAL RELEASE) - Do not apply mock defined on root action. 0.000012 2016-06-24 06:01:16-07:00 America/Los_Angeles - No changes since last trial 0.000011 2016-06-22 11:32:58-07:00 America/Los_Angeles (TRIAL RELEASE) - Require newer Test2::AsyncSubtest for bugfixes 0.000010 2016-06-22 09:16:07-07:00 America/Los_Angeles - Fix for (and require) Test2-Suite 0.000032 (#2) - Better TODO handling 0.000009 2016-05-31 07:18:50-07:00 America/Los_Angeles - Require perl 5.10 0.000008 2016-05-30 07:38:55-07:00 America/Los_Angeles - Require newer Test2::AsyncSubtest 0.000007 2016-05-30 06:58:17-07:00 America/Los_Angeles - Complete rewrite 0.000006 2016-02-05 15:45:57-08:00 America/Los_Angeles - Prep for a new Trace::Mask version 0.000005 2016-02-05 11:56:11-08:00 America/Los_Angeles - Bump minimum Test2::Suite version (fixes issue found in windows tests) 0.000004 2016-02-04 21:48:07-08:00 America/Los_Angeles - Add Spec bundle 0.000003 2016-02-04 10:46:41-08:00 America/Los_Angeles - Fix test that needs to be conditional - Fix constant in NoIso 0.000002 2016-02-03 08:12:34-08:00 America/Los_Angeles - Major overhaul - Add isolation runners - Lots of fixes - Masking traces properly - Better filtering 0.000001 2016-01-18 10:54:17-08:00 America/Los_Angeles - Initial conversion from Test::Stream MANIFEST100644001750001750 154312747547341 16326 0ustar00exodistexodist000000000000Test2-Workflow-0.000017# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.006. Changes LICENSE MANIFEST META.json META.yml Makefile.PL README README.md cpanfile lib/Test2/Tools/Spec.pm lib/Test2/Workflow.pm lib/Test2/Workflow/BlockBase.pm lib/Test2/Workflow/Build.pm lib/Test2/Workflow/Runner.pm lib/Test2/Workflow/Task.pm lib/Test2/Workflow/Task/Action.pm lib/Test2/Workflow/Task/Group.pm t/Acceptance.t t/Acceptance2.t t/Acceptance3.t t/Acceptance4.t t/Acceptance5.t t/behavior/Mocking.t t/behavior/filtering.t t/behavior/no_done_testing.t t/behavior/no_leaks_any.t t/behavior/no_leaks_no_fork.t t/behavior/no_leaks_no_iso.t t/behavior/no_leaks_no_threads.t t/units/Tools/Spec.t t/units/Workflow.t t/units/Workflow/BlockBase.t t/units/Workflow/Build.t t/units/Workflow/Runner.t t/units/Workflow/Task.t t/units/Workflow/Task/Action.t t/units/Workflow/Task/Group.t cpanfile100644001750001750 74412747547341 16663 0ustar00exodistexodist000000000000Test2-Workflow-0.000017requires "Carp" => "0"; requires "Exporter" => "0"; requires "Importer" => "0.014"; requires "Scalar::Util" => "0"; requires "Test2" => "1.302048"; requires "Test2::AsyncSubtest" => "0.000017"; requires "Test2::Suite" => "0.000034"; requires "Time::HiRes" => "0"; requires "overload" => "0"; requires "perl" => "5.010000"; suggests "Sub::Name" => "0.11"; on 'configure' => sub { requires "ExtUtils::MakeMaker" => "0"; }; on 'develop' => sub { requires "Test::Pod" => "1.41"; }; META.yml100644001750001750 151012747547341 16440 0ustar00exodistexodist000000000000Test2-Workflow-0.000017--- abstract: 'A test workflow is a way of structuring tests using composable units.' author: - 'Chad Granum ' build_requires: {} configure_requires: ExtUtils::MakeMaker: '0' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.006, CPAN::Meta::Converter version 2.150001' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Test2-Workflow requires: Carp: '0' Exporter: '0' Importer: '0.014' Scalar::Util: '0' Test2: '1.302048' Test2::AsyncSubtest: '0.000017' Test2::Suite: '0.000034' Time::HiRes: '0' overload: '0' perl: '5.010000' resources: bugtracker: http://github.com/Test-More/Test2-Workflow/issues repository: http://github.com/Test-More/Test2-Workflow/ version: '0.000017' x_serialization_backend: 'YAML::Tiny version 1.69' README.md100644001750001750 2040212747547341 16467 0ustar00exodistexodist000000000000Test2-Workflow-0.000017# NAME Test2::Workflow - Interface for writing 'workflow' tools such as RSPEC implementations that all play nicely together. # \*\*\* EXPERIMENTAL \*\*\* This distribution is experimental, anything can change at any time! # DESCRIPTION This module intends to do for 'workflow' test tools what Test::Builder and Test2 do for general test tools. The problem with workflow tools is that most do not play well together. This module is a very generic/abstract look at workflows that allows tools to be built that accomplish their workflows, but in a way that plays well with others. # SYNOPSIS package My::Workflow::Tool; use Test2::Workflow qw/gen_unit_builder/; our @EXPORT = qw/my_wrapper/; use base 'Exporter'; # Create a wrapping tool *my_wrapper = gen_unit_builder('simple' => qw/buildup teardown/); To use it: use My::Workflow::Tool qw/my_wrapper/; my_wrapper foo => sub { my $inner = shift; ... $inner->(); ... }; # IMPORTANT CONCEPTS A workflow is a way of defining tests with scaffolding. Essentially you are seperating your assertions and your setup/teardown/management code. This results in a separation of concerns that can produce more maintainable tests. In addition each component of a workflow can be re-usable and/or inheritable. ## UNITS Units are the small composable parts of a workflow. You can think of a unit as a named function that does some work. What separates a unit from a regular function is that it can have other units attashed to it in various ways. A unit can also be a 'group' unit, which means it contains other units as its primary work. See [Test2::Workflow::Unit](https://metacpan.org/pod/Test2::Workflow::Unit). ## PACKAGE UNIT The package unit is the root 'group' unit for your test package. All other test units get put into the main package unit. See [Test2::Workflow::Meta](https://metacpan.org/pod/Test2::Workflow::Meta) where the primary unit is stored. ## BUILDS Units are generally defined using a DSL (Domain Specific Language). In this DSL you declare a unit, which gets added as the current build, then run code which modifies that build to turn it into the unit you need. ## BUILD STACK Builds can be defined within one another, as such the 'current' build is whatever build is on top of the build stack, which is a private array. There are low level functions exposed to give you control over the stack if you need it, but in general you should use a higher level tool. ## TASK A task is a composition of units to be run. The runner will compile you units into task form, then run the compiled tasks. ## VAR STASH There is a var stash. The var stash is a stack of hashes. Every time a task is run a new hash is pushed onto the stack. When a task is complete the hash is popped and cleared. Workflow tools may use this hash to store/define variables that will go away when the current task is complete. # EXPORTS All exports are optional, you must request the ones you want. ## BUILD STACK - $unit = workflow\_build() Get the unit at the top of the build stack, if any. - $unit = workflow\_current() Get the unit at the top of the build stack, if there is none then return the root unit for the package the function is called from. - push\_workflow\_build($unit) Push a unit onto the build stack. - pop\_workflow\_build($unit) Pop a unit from the build stack. You must provide the `$unit` you expect to pop, and it must match the one at the top of the stack. ## VAR STASH - $val = workflow\_var($name) - $val = workflow\_var($name, $val) - $val = workflow\_var($name, \\&default) This function will get/set a variable in the var stash. If only a name is provided then it will return the current value, or undef. If you provide a value as the second argument then the value will be set. A coderef can be passed in as the second argument. If a coderef is used it will be considered a default generator. If the variable name already has a value then that value will be kept and returned. If the variable has not been set then the coderef will be run and the value it returns will be stored and returned. - $hr = push\_workflow\_vars() - push\_workflow\_vars($hr) You can manually push a new hashref to the top of the vars stack. If you do this you need to be sure to pop it before anything else tries to pop any hash below yours in the stack. You can provide a hashref to push, or it will create a new one for you. - pop\_workflow\_vars($hr) This will let you manually pop the workflow vars stack. You must provide a reference to the item you think is at the top of the stack (the one you want to pop). If something else is on top of the stack then an exception will be thrown. - $bool = has\_workflow\_vars() Check if there is a workflow vars hash on the stack. This will return false if there is nothing on the stack. Currently this returns the number of items in the stack, but that may change so do not depend on that behavior. ## META DATA - $meta = workflow\_meta() Get the [Test2::Workflow::Meta](https://metacpan.org/pod/Test2::Workflow::Meta) object associated with the current package. - workflow\_runner($runner) Set the runner to use. The runner can be a package name, or a blessed object. Whichever you provide, it must have a 'run' method. The run method will be called directly on what you provide, that is if you provide a package name then it will call `$package->run()` `new()` will not be called for you. - workflow\_runner\_args(\\@args) Arguments that should be passed to the `run()` method of your runner. - workflow\_run() Run the workflow now. ## CREATING UNITS - $unit = group\_builder($name, \\%params, sub { ... }) - $unit = group\_builder($name, sub { ... }) - group\_builder($name, \\%params, sub { ... }) - group\_builder($name, sub { ... }) The group builder will create a new unit with the given name and parameters. The new unit will be placed onto the build stack, and the code reference you provide will be run. Once the code reference returns the unit will be removed from the build stack. If called in void context the unit will be added to the next unit on the build stack, or to the package root unit. If called in any other context the unit will be returned. - $sub = gen\_unit\_builder($callback, @stashes) This will return a coderef that accepts the typical `$name`, optional `\%params`, and `\&code` arguments. The code returned will construct your unit for you, and then insert it into the specified stashes of the current build whenever it is called. Typically you will only specify one stash, but you may combine `buildup` and `teardown` if the builder you are creating is supposed to wrap other units. **Stashes:** - primary A primary action. - modify Something to modify the primary actions. - buildup Something to run before the primary actions. - teardown Something to run after the primary actions. - ($unit, $code, $caller) = new\_proto\_unit(\\%params) - level => 1 - caller => \[caller($level)\] - args => \[$name, \\%params, \\&code\] - args => \[$name, \\&code\] - set\_primary => $bool - unit => \\%attributes This is used under the hood by `gen_unit_builder()`. This will parse the 2 or 3 typical input arguments, verify them, and return a new [Test2::Workflow::Unit](https://metacpan.org/pod/Test2::Workflow::Unit), the coderef that was passed in, and a caller arrayref. If you use this it is your job to put the unit where it should be. Normally `gen_unit_builder` and `group_builder` are all you should need. # SEE ALSO - Test2::Tools::Spec [Test2::Tools::Spec](https://metacpan.org/pod/Test2::Tools::Spec) is an implementation of RSPEC using this library. # SOURCE The source code repository for Test2-Workflow can be found at `http://github.com/Test-More/Test2-Workflow/`. # MAINTAINERS - Chad Granum <exodist@cpan.org> # AUTHORS - Chad Granum <exodist@cpan.org> # COPYRIGHT Copyright 2015 Chad Granum <exodist7@gmail.com>. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See `http://dev.perl.org/licenses/` META.json100644001750001750 275412747547341 16623 0ustar00exodistexodist000000000000Test2-Workflow-0.000017{ "abstract" : "A test workflow is a way of structuring tests using composable units.", "author" : [ "Chad Granum " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.006, CPAN::Meta::Converter version 2.150001", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Test2-Workflow", "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "develop" : { "requires" : { "Test::Pod" : "1.41" } }, "runtime" : { "requires" : { "Carp" : "0", "Exporter" : "0", "Importer" : "0.014", "Scalar::Util" : "0", "Test2" : "1.302048", "Test2::AsyncSubtest" : "0.000017", "Test2::Suite" : "0.000034", "Time::HiRes" : "0", "overload" : "0", "perl" : "5.010000" }, "suggests" : { "Sub::Name" : "0.11" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "http://github.com/Test-More/Test2-Workflow/issues" }, "repository" : { "type" : "git", "url" : "http://github.com/Test-More/Test2-Workflow/" } }, "version" : "0.000017", "x_serialization_backend" : "Cpanel::JSON::XS version 3.0213" } Makefile.PL100644001750001750 275312747547341 17153 0ustar00exodistexodist000000000000Test2-Workflow-0.000017# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.006. use strict; use warnings; use 5.010000; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "A test workflow is a way of structuring tests using composable units.", "AUTHOR" => "Chad Granum ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0 }, "DISTNAME" => "Test2-Workflow", "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.010000", "NAME" => "Test2::Workflow", "PREREQ_PM" => { "Carp" => 0, "Exporter" => 0, "Importer" => "0.014", "Scalar::Util" => 0, "Test2" => "1.302048", "Test2::AsyncSubtest" => "0.000017", "Test2::Suite" => "0.000034", "Time::HiRes" => 0, "overload" => 0 }, "VERSION" => "0.000017", "test" => { "TESTS" => "t/*.t t/behavior/*.t t/units/*.t t/units/Tools/*.t t/units/Workflow/*.t t/units/Workflow/Task/*.t" } ); my %FallbackPrereqs = ( "Carp" => 0, "Exporter" => 0, "Importer" => "0.014", "Scalar::Util" => 0, "Test2" => "1.302048", "Test2::AsyncSubtest" => "0.000017", "Test2::Suite" => "0.000034", "Time::HiRes" => 0, "overload" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); t000755001750001750 012747547341 15275 5ustar00exodistexodist000000000000Test2-Workflow-0.000017Acceptance.t100644001750001750 7476212747547341 17710 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/tuse strict; use warnings; use Test2::Bundle::Extended; use Test2::Tools::Spec qw/:DEFAULT include_workflow/; use Test2::Workflow::Runner; use Test2::API qw/intercept/; use Test2::Util qw/get_tid/; my $B = describe foo => sub { before_all start => sub { ok(1, 'start') }; around_all al => sub { my $cont = shift; ok(1, 'al start'); $cont->(); ok(1, 'al end'); }; after_all end => sub { ok(1, 'end') }; before_each bef => sub { ok(1, 'a') }; around_each arr => sub { my $cont = shift; ok(1, 'ar start'); $cont->(); ok(1, 'ar end'); }; after_each aft => sub { ok(1, 'z') }; case c1 => sub { ok(1, 'in c1') }; case c2 => sub { ok(1, 'in c2') }; before_case bc => sub { ok(1, 'in bc') }; around_case arc => sub { my $cont = shift; ok(1, 'arc start'); $cont->(); ok(1, 'arc end'); }; after_case ac => sub { ok(1, 'in ac') }; tests bar => {iso => 1}, sub { ok(1, "inside bar pid $$ - tid " . get_tid()); }; tests baz => sub { ok(1, "inside baz pid $$ - tid " . get_tid()); }; tests uhg => sub { my $todo = todo "foo todo"; ok(0, 'xxx'); }; tests bug => {todo => 'a bug'}, sub { ok(0, 'fail'); }; tests broken => {skip => 'will break things'}, sub { warn "\n\n**** You should not see this! ****\n\n"; print STDERR Carp::longmess('here'); print "not ok - You should not see this\n"; exit 255; }; describe nested => {iso => 1}, sub { before_each n1_be => sub { ok(1, 'nested before') }; after_each n1_ae => sub { ok(1, 'nested after') }; tests n1 => sub { ok(1, 'nested 1') }; tests n2 => sub { ok(1, 'nested 2') }; }; }; my $r1 = Test2::Workflow::Runner->new(task => $B, no_threads => 1); $r1->run; my $r2 = Test2::Workflow::Runner->new(task => $B, no_fork => 1); $r2->run; my $r3 = Test2::Workflow::Runner->new(task => $B, no_fork => 1, no_threads => 1); $r3->run; tests on_root => sub { ok(1, "in root") }; { package Foo::Bar; sub foo { 'xxx' } } describe in_root => {flat => 1}, sub { is(Foo::Bar->foo, 'xxx', "not mocked"); mock 'Foo::Bar' => ( override => [ foo => sub { 'foo' }, ], ); is(Foo::Bar->foo, 'foo', "mocked"); tests on_root_a => sub { ok(1, "in root"); is(Foo::Bar->foo, 'foo', "mocked"); }; describe 'iso-in-iso' => {iso => 1}, sub { tests on_root_b => {iso => 1}, sub { ok(1, "in root") }; tests on_root_c => {iso => 1}, sub { ok(1, "in root") }; tests on_root_d => {iso => 1}, sub { ok(1, "in root") }; }; my $B = describe included => sub { tests inside => sub { ok(1, "xxx") }; }; include_workflow($B); }; is(Foo::Bar->foo, 'xxx', "not mocked"); describe todo_desc => {todo => 'cause'}, sub { ok(0, "not ready"); tests foo => sub { ok(0, "not ready nested"); } }; describe skip_desc => {skip => 'cause'}, sub { print STDERR "Should not see this!\n"; print "not ok - You should not see this\n"; exit 255; }; eval { describe dies => sub { ok(1, 'xxx'); ok(1, 'xxx'); die "xxx"; }; 1; }; like( $@, check_set( qr/^Exception in build 'dies' with 2 unseen event\(s\)\.$/m, qr{^xxx at .*Acceptance\.t line \d+\.$}m, qr/^Overview of unseen events:$/m, qr/^ Test2::Event::Ok at .*Acceptance\.t line \d+$/m, qr/^ Test2::Event::Ok at .*Acceptance\.t line \d+/m, ), "Error is as expected" ); my $events = intercept { my $r = Test2::Workflow::Runner->new(task => $B, no_fork => 1, no_threads => 1, rand => 0); $r->run; }; is( $events, array { event Subtest => sub { call name => 'foo'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 77; call subevents => array { event Ok => sub { call name => 'start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 12; }; event Ok => sub { call name => 'al start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 16; }; event Subtest => sub { call name => 'c1'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 34; call subevents => array { event Ok => sub { call name => 'in bc'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 37; }; event Ok => sub { call name => 'arc start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 40; }; event Ok => sub { call name => 'in c1'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 34; }; event Skip => sub { call name => 'bar'; call pass => 1; call effective_pass => 1; call reason => 'No isolation method available'; prop file => match qr{\QAcceptance.t\E$}; prop line => 48; }; event Subtest => sub { call name => 'baz'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 52; call subevents => array { event Ok => sub { call name => 'a'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 23; }; event Ok => sub { call name => 'ar start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 27; }; event Ok => sub { call name => match qr/inside baz pid/; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 51; }; event Ok => sub { call name => 'ar end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 29; }; event Ok => sub { call name => 'z'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 32; }; event Plan => sub { call max => 5; prop file => match qr{\QAcceptance.t\E$}; prop line => 52; }; end(); }; }; event Subtest => sub { call name => 'uhg'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 57; call subevents => array { event Ok => sub { call name => 'a'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 23; }; event Ok => sub { call name => 'ar start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 27; }; event Ok => sub { call name => 'xxx'; call pass => 0; call effective_pass => 1; call todo => 'foo todo'; prop file => match qr{\QAcceptance.t\E$}; prop line => 56; }; event Note => sub { call message => match qr{^\n?Failed test}; prop file => match qr{\QAcceptance.t\E$}; prop line => 56; }; event Ok => sub { call name => 'ar end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 29; }; event Ok => sub { call name => 'z'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 32; }; event Plan => sub { call max => 5; prop file => match qr{\QAcceptance.t\E$}; prop line => 57; }; end(); }; }; event Subtest => sub { call name => 'bug'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 61; call subevents => array { event Ok => sub { call name => 'a'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 23; }; event Ok => sub { call name => 'ar start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 27; }; event Ok => sub { call name => 'fail'; call pass => 0; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 60; }; event Note => sub { call message => match qr{^\n?Failed test}; prop file => match qr{\QAcceptance.t\E$}; prop line => 60; }; event Ok => sub { call name => 'ar end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 29; }; event Ok => sub { call name => 'z'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 32; }; event Plan => sub { call max => 5; prop file => match qr{\QAcceptance.t\E$}; prop line => 61; }; end(); }; }; event Skip => sub { call name => 'broken'; call pass => 1; call effective_pass => 1; call reason => 'will break things'; prop file => match qr{\QRunner.pm\E$}; prop line => 143; }; event Skip => sub { call name => 'nested'; call pass => 1; call effective_pass => 1; call reason => 'No isolation method available'; prop file => match qr{\QAcceptance.t\E$}; prop line => 76; }; event Ok => sub { call name => 'arc end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 42; }; event Ok => sub { call name => 'in ac'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 44; }; event Plan => sub { call max => 11; prop file => match qr{\QAcceptance.t\E$}; prop line => 34; }; end(); }; }; event Subtest => sub { call name => 'c2'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 35; call subevents => array { event Ok => sub { call name => 'in bc'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 37; }; event Ok => sub { call name => 'arc start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 40; }; event Ok => sub { call name => 'in c2'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 35; }; event Skip => sub { call name => 'bar'; call pass => 1; call effective_pass => 1; call reason => 'No isolation method available'; prop file => match qr{\QAcceptance.t\E$}; prop line => 48; }; event Subtest => sub { call name => 'baz'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 52; call subevents => array { event Ok => sub { call name => 'a'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 23; }; event Ok => sub { call name => 'ar start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 27; }; event Ok => sub { call name => match qr/inside baz pid/; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 51; }; event Ok => sub { call name => 'ar end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 29; }; event Ok => sub { call name => 'z'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 32; }; event Plan => sub { call max => 5; prop file => match qr{\QAcceptance.t\E$}; prop line => 52; }; end(); }; }; event Subtest => sub { call name => 'uhg'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 57; call subevents => array { event Ok => sub { call name => 'a'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 23; }; event Ok => sub { call name => 'ar start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 27; }; event Ok => sub { call name => 'xxx'; call pass => 0; call effective_pass => 1; call todo => 'foo todo'; prop file => match qr{\QAcceptance.t\E$}; prop line => 56; }; event Note => sub { call message => match qr{^\n?Failed test}; prop file => match qr{\QAcceptance.t\E$}; prop line => 56; }; event Ok => sub { call name => 'ar end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 29; }; event Ok => sub { call name => 'z'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 32; }; event Plan => sub { call max => 5; prop file => match qr{\QAcceptance.t\E$}; prop line => 57; }; end(); }; }; event Subtest => sub { call name => 'bug'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 61; call subevents => array { event Ok => sub { call name => 'a'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 23; }; event Ok => sub { call name => 'ar start'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 27; }; event Ok => sub { call name => 'fail'; call pass => 0; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 60; }; event Note => sub { call message => match qr{^\n?Failed test}; prop file => match qr{\QAcceptance.t\E$}; prop line => 60; }; event Ok => sub { call name => 'ar end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 29; }; event Ok => sub { call name => 'z'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 32; }; event Plan => sub { call max => 5; prop file => match qr{\QAcceptance.t\E$}; prop line => 61; }; end(); }; }; event Skip => sub { call name => 'broken'; call pass => 1; call effective_pass => 1; call reason => 'will break things'; prop file => match qr{\QRunner.pm\E$}; prop line => 143; }; event Skip => sub { call name => 'nested'; call pass => 1; call effective_pass => 1; call reason => 'No isolation method available'; prop file => match qr{\QAcceptance.t\E$}; prop line => 76; }; event Ok => sub { call name => 'arc end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 42; }; event Ok => sub { call name => 'in ac'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 44; }; event Plan => sub { call max => 11; prop file => match qr{\QAcceptance.t\E$}; prop line => 35; }; end(); }; }; event Ok => sub { call name => 'al end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 18; }; event Ok => sub { call name => 'end'; call pass => 1; call effective_pass => 1; prop file => match qr{\QAcceptance.t\E$}; prop line => 21; }; event Plan => sub { call max => 6; prop file => match qr{\QAcceptance.t\E$}; prop line => 77; }; end(); }; }; end(); }, "Events look correct" ); done_testing; 1; Acceptance2.t100644001750001750 42412747547341 17712 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/tuse strict; use warnings; use Test2::Bundle::Extended; use Test2::Tools::Spec; describe outer => sub { tests foo => sub { ok(1, 'foo') }; describe inner => sub { tests bar => sub { ok(1, 'bar') }; }; }; tests foo => sub { ok(1, 'foo') }; done_testing; Acceptance4.t100644001750001750 37112747547341 17715 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/tuse Test2::Bundle::Extended; use Test2::Tools::Spec; use Test2::API qw/intercept/; my $unit = tests simple => sub { ok(1, "inside simple"); }; my $runner = Test2::Workflow::Runner->new; $runner->push_task($unit); $runner->run; done_testing; Acceptance5.t100644001750001750 170412747547341 17737 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/tuse Test2::Bundle::Extended; use Test2::Tools::Spec qw/:ALL/; use Test2::Util qw/get_tid/; sub get_ids { return { pid => $$, tid => get_tid(), }; } my $orig = get_ids(); spec_defaults case => (iso => 1, async => 1); spec_defaults tests => (iso => 1, async => 1); tests outside => sub { isnt(get_ids(), $orig, "In child (lexial)"); }; describe wrapper => sub { case foo => sub { isnt(get_ids(), $orig, "In child (inherited)") }; case 'bar', {iso => 0, async => 0} => sub { is(get_ids(), $orig, "In orig (overriden)") }; tests a => sub { ok(1, 'stub') }; tests b => sub { ok(1, 'stub') }; my $x = describe nested => sub { tests nested_t => sub { ok(0, 'Should not see this') }; }; tests nested => sub { ok(!$x->primary->[0]->iso, "Did not inherit when captured"); ok(!$x->primary->[0]->async, "Did not inherit when captured"); }; }; done_testing; Acceptance3.t100644001750001750 25012747547341 17710 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/tuse Test2::Bundle::Extended; use Test2::Tools::Spec; # This is a test that things are ok if you do not use the spec after loading # it. ok(1, "blah"); done_testing; units000755001750001750 012747547341 16437 5ustar00exodistexodist000000000000Test2-Workflow-0.000017/tWorkflow.t100644001750001750 13512747547341 20555 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/unitsuse Test2::Bundle::Extended -target => 'Test2::Workflow'; skip_all "Tests not yet written"; Tools000755001750001750 012747547341 17537 5ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/unitsSpec.t100644001750001750 14012747547341 20731 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/units/Toolsuse Test2::Bundle::Extended -target => 'Test2::Tools::Spec'; skip_all "Tests not yet written"; behavior000755001750001750 012747547341 17074 5ustar00exodistexodist000000000000Test2-Workflow-0.000017/tMocking.t100644001750001750 242312747547341 21011 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/behavioruse Test2::Bundle::Extended -target => 'Test2::Workflow'; use Test2::Tools::Spec; describe mock_spec => sub { mock Fake1 => ( add => [ check => sub { 1 } ] ); before_all ba => sub { mock Fake2 => ( add => [ check => sub { 2 } ])}; before_each be => sub { mock Fake3 => ( add => [ check => sub { 3 } ])}; is( Fake1->check, 1, "mock applies to describe block"); around_each ae => sub { my $inner = shift; mock Fake4 => ( add => [check => sub { 4 } ]); $inner->(); }; tests the_test => sub { mock Fake5 => ( add => [check => sub { 5 } ]); is( Fake1->check, 1, "mock 1"); is( Fake2->check, 2, "mock 2"); is( Fake3->check, 3, "mock 3"); is( Fake4->check, 4, "mock 4"); is( Fake5->check, 5, "mock 5"); }; describe nested => sub { tests inner => sub { is( Fake1->check, 1, "mock 1"); is( Fake2->check, 2, "mock 2"); is( Fake3->check, 3, "mock 3"); is( Fake4->check, 4, "mock 4"); ok(!Fake5->can('check'), "mock 5 did not leak"); }; }; }; tests post => sub { ok(!"Fake$_"->can('check'), "mock $_ did not leak") for 1 .. 5; }; ok(!"Fake$_"->can('check'), "mock $_ did not leak") for 1 .. 5; done_testing; Test2000755001750001750 012747547341 16601 5ustar00exodistexodist000000000000Test2-Workflow-0.000017/libWorkflow.pm100644001750001750 1617212747547341 21140 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2package Test2::Workflow; use strict; use warnings; our $VERSION = "0.000017"; our @EXPORT_OK = qw/parse_args current_build build root_build init_root build_stack/; use base 'Exporter'; use Test2::Workflow::Build; use Test2::Workflow::Task::Group; use Test2::API qw/intercept/; use Scalar::Util qw/blessed/; sub parse_args { my %input = @_; my $args = delete $input{args}; my %out; my %props; my $caller = $out{frame} = $input{caller} || caller(defined $input{level} ? $input{level} : 1); delete @input{qw/caller level/}; for my $arg (@$args) { if (my $r = ref($arg)) { if ($r eq 'HASH') { %props = (%props, %$arg); } elsif ($r eq 'CODE') { die "Code is already set, did you provide multiple code blocks at $caller->[1] line $caller->[2].\n" if $out{code}; $out{code} = $arg } else { die "Not sure what to do with $arg at $caller->[1] line $caller->[2].\n"; } next; } if ($arg =~ m/^\d+$/) { push @{$out{lines}} => $arg; next; } die "Name is already set to '$out{name}', cannot set to '$arg', did you specify multiple names at $caller->[1] line $caller->[2].\n" if $out{name}; $out{name} = $arg; } die "a name must be provided, and must be truthy at $caller->[1] line $caller->[2].\n" unless $out{name}; die "a codeblock must be provided at $caller->[1] line $caller->[2].\n" unless $out{code}; return { %props, %out, %input }; } { my %ROOT_BUILDS; my @BUILD_STACK; sub root_build { $ROOT_BUILDS{$_[0]} } sub current_build { @BUILD_STACK ? $BUILD_STACK[-1] : undef } sub build_stack { @BUILD_STACK } sub init_root { my ($pkg, %args) = @_; $ROOT_BUILDS{$pkg} ||= Test2::Workflow::Build->new( name => $pkg, flat => 1, iso => 0, async => 0, is_root => 1, %args, ); return $ROOT_BUILDS{$pkg}; } sub build { my %params = @_; my $args = parse_args(%params); my $build = Test2::Workflow::Build->new(%$args); return $build if $args->{skip}; push @BUILD_STACK => $build; my ($ok, $err); my $events = intercept { my $todo = $args->{todo} ? Test2::Todo->new(reason => $args->{todo}) : undef; $ok = eval { $args->{code}->(); 1 }; $err = $@; $todo->end if $todo; }; # Clear the stash $build->{stash} = []; $build->set_events($events); pop @BUILD_STACK; unless($ok) { my $hub = Test2::API::test2_stack->top; my $count = @$events; my $list = $count ? "Overview of unseen events:\n" . join "" => map " " . blessed($_) . " " . $_->trace->debug . "\n", @$events : ""; die <<" EOT"; Exception in build '$args->{name}' with $count unseen event(s). $err $list EOT } return $build; } } 1; __END__ =pod =encoding UTF-8 =head1 NAME Test2::Workflow - A test workflow is a way of structuring tests using composable units. =head1 DESCRIPTION A test workflow is a way of structuring tests using composable units. A well known example of a test workflow is L. RSPEC is implemented using Test2::Workflow in L along with several extentions. =head1 IMPORTANT CONCEPTS =head2 BUILD L A Build is used to compose tasks. Usually a build object is pushed to the stack before running code that adds tasks to the build. Once the build sub is complete the build is popped and returned. Usually a build is converted into a root task or task group. =head2 RUNNER L A runner takes the composed tasks and executes them in the proper order. =head2 TASK L A task is a unit of work to accomplish. There are 2 main types of task. =head3 ACTION An action is the most simple unit used in composition. An action is essentially a name and a codeblock to run. =head3 GROUP A group is a task that is composed of other tasks. =head1 EXPORTS All exports are optional, you must request the ones you want. =over 4 =item $parsed = parse_args(args => \@args) =item $parsed = parse_args(args => \@args, level => $L) =item $parsed = parse_args(args => \@args, caller => [caller($L)]) This will parse a "typical" task builers arguments. The C<@args> array MUST contain a name (plain scalar containing text) and also a single CODE reference. The C<@args> array MAY also contain any quantity of line numbers or hashrefs. The resulting data structure will be a single hashref with all the provided hashrefs squashed together, and the 'name', 'code', 'lines' and 'frame' keys set from other arguments. { # All hashrefs from @args get squashed together: %squashed_input_hashref_data, # @args must have exactly 1 plaintext scalar that is not a number, it # is considered the name: name => 'name from input args' # Integer values are treated as line numbers lines => [ 35, 44 ], # Exactly 1 coderef must be provided in @args: code => \&some_code, # 'frame' contains the 'caller' data. This may be passed in directly, # obtained from the 'level' parameter, or automatically deduced. frame => ['A::Package', 'a_file.pm', 42, ...], } =item $build = init_root($pkg, %args) This will initialize (or return the existing) a build for the specified package. C<%args> get passed into the L constructor. This uses the following defaults (which can be overriden using C<%args>): name => $pkg, flat => 1, iso => 0, async => 0, is_root => 1, Note that C<%args> is completely ignored if the package build has already been initialized. =item $build = root_build($pkg) This will return the root build for the specified package. =item $build = current_build() This will return the build cuurently at the top of the build stack (or undef). =item $build = build($name, \%params, sub { ... }) This will push a new build object onto the build stash then run the provided codeblock. Once the codeblock has finished running the build will be popped off the stack and returned. See C for details about argument processing. =back =head1 SEE ALSO =over 4 =item Test2::Tools::Spec L is an implementation of RSPEC using this library. =back =head1 SOURCE The source code repository for Test2-Workflow can be found at F. =head1 MAINTAINERS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 AUTHORS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 COPYRIGHT Copyright 2016 Chad Granum Eexodist7@gmail.comE. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See F =cut filtering.t100644001750001750 6151112747547341 21430 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/behavioruse Test2::Bundle::Extended; use Test2::Tools::Spec -rand => 0; use Test2::Workflow::Runner; my %LINES; sub example { my $unit = describe root => {flat => 1}, sub { before_all 'root_before_all' => sub { note "root_before_all" }; after_all 'root_after_all' => sub { note 'root_after_all' }; before_each 'root_before_each' => sub { note 'root_before_each' }; after_each 'root_after_each' => sub { note 'root_after_each' }; around_all 'root_around_all' => sub { note 'root_around_all_prefix'; $_[0]->(); note 'root_around_all_postfix'; }; around_each 'root_around_each' => sub { note 'root_around_each_prefix'; $_[0]->(); note 'root_around_each_postfix'; }; case root_x => sub { note 'root case x' }; BEGIN { $LINES{root_x} = __LINE__ } case root_y => sub { note 'root case y' }; BEGIN { $LINES{root_y} = __LINE__ } tests 'root_a' => sub { ok(1, 'root_a') }; BEGIN { $LINES{root_a} = __LINE__ } tests 'root_b' => sub { ok(1, 'root_b') }; BEGIN { $LINES{root_b} = __LINE__ } tests 'root_long' => sub { ok(1, 'root_long_1'); BEGIN { $LINES{root_long} = __LINE__ } # Intentional space ok(1, 'root_long_2'); }; tests dup_name => sub { ok(1, 'dup_name') }; describe nested => sub { before_all 'nested_before_all' => sub { note "nested_before_all" }; after_all 'nested_after_all' => sub { note 'nested_after_all' }; before_each 'nested_before_each' => sub { note 'nested_before_each' }; after_each 'nested_after_each' => sub { note 'nested_after_each' }; around_all 'nested_around_all' => sub { note 'nested_around_all_prefix'; $_[0]->(); note 'nested_around_all_postfix'; }; around_each 'nested_around_each' => sub { note 'nested_around_each_prefix'; $_[0]->(); note 'nested_around_each_postfix'; }; BEGIN { $LINES{nested} = __LINE__ } case nested_x => sub { note 'nested case x' }; BEGIN { $LINES{nested_x} = __LINE__ } case nested_y => sub { note 'nested case y' }; BEGIN { $LINES{nested_y} = __LINE__ } tests 'nested_a' => sub { ok(1, 'nested_a') }; BEGIN { $LINES{nested_a} = __LINE__ } tests 'nested_b' => sub { ok(1, 'nested_b') }; BEGIN { $LINES{nested_b} = __LINE__ } tests 'nested_long' => sub { ok(1, 'nested_long_1'); BEGIN { $LINES{nested_long} = __LINE__ } # Intentional space ok(1, 'nested_long_2'); }; tests dup_name => sub { ok(1, 'dup_name') }; }; }; return $unit; }; describe root_test => sub { my $filter; my $type; case line => {flat => 1}, sub { $type = 'line'; $filter = {line => $LINES{root_long}} }; case name => {flat => 1}, sub { $type = 'name'; $filter = {name => 'root_long'} }; tests root => {flat => 1}, sub { my $unit = example(); my $events = intercept { Test2::Workflow::Runner->new( rand => 0, task => $unit, filter => $filter )->run(); }; is( $events, array { event Note => { message => 'root_before_all' }; event Note => { message => 'root_around_all_prefix' }; event Subtest => sub { call name => "root_$_"; call subevents => array { event Note => { message => "root case $_" }; event Skip => {}; event Skip => {}; event Subtest => sub { call name => 'root_long'; call subevents => array { event Note => { message => 'root_before_each' }; event Note => { message => 'root_around_each_prefix' }; event Ok => { name => 'root_long_1' }; event Ok => { name => 'root_long_2' }; event Note => { message => 'root_after_each' }; event Note => { message => 'root_around_each_postfix' }; event Plan => { max => 2 }; }; }; event Skip => {}; event Skip => {}; event Plan => { max => 5 }; }; } for qw/x y/; event Note => { message => 'root_after_all' }; event Note => { message => 'root_around_all_postfix' }; }, "Got only the events that match the $type filter" ); }; }; describe nested_test => sub { my $filter; my $type; case line => {flat => 1}, sub { $type = 'line'; $filter = {line => $LINES{nested_long}} }; case name => {flat => 1}, sub { $type = 'name'; $filter = {name => 'nested_long'} }; tests nested => {flat => 1}, sub { my $unit = example(); my $events = intercept { Test2::Workflow::Runner->new( rand => 0, task => $unit, filter => $filter )->run(); }; is( $events, array { event Note => { message => 'root_before_all' }; event Note => { message => 'root_around_all_prefix' }; event Subtest => sub { call name => "root_$_"; call subevents => array { event Note => { message => "root case $_" }; event Skip => {}; event Skip => {}; event Skip => {}; event Skip => {}; event Subtest => sub { call name => 'nested'; call subevents => array { event Note => { message => 'nested_before_all' }; event Note => { message => 'nested_around_all_prefix' }; event Subtest => sub { call name => "nested_$_"; call subevents => array { event Note => { message => "nested case $_" }; event Skip => {}; event Skip => {}; event Subtest => sub { call name => 'nested_long'; call subevents => array { event Note => { message => 'root_before_each' }; event Note => { message => 'root_around_each_prefix' }; event Note => { message => 'nested_before_each' }; event Note => { message => 'nested_around_each_prefix' }; event Ok => { name => 'nested_long_1' }; event Ok => { name => 'nested_long_2' }; event Note => { message => 'nested_after_each' }; event Note => { message => 'nested_around_each_postfix' }; event Note => { message => 'root_after_each' }; event Note => { message => 'root_around_each_postfix' }; event Plan => { max => 2 }; }; }; event Skip => {}; event Plan => { max => 4 }; }; } for qw/x y/; event Note => { message => 'nested_after_all' }; event Note => { message => 'nested_around_all_postfix' }; event Plan => { max => 2 }; }; }; event Plan => { max => 5 }; }; } for qw/x y/; event Note => { message => 'root_after_all' }; event Note => { message => 'root_around_all_postfix' }; }, "Got only the events that match the $type filter" ); }; }; describe group => sub { my $filter; my $type; case line => {flat => 1}, sub { $type = 'line'; $filter = {line => $LINES{nested}} }; case name => {flat => 1}, sub { $type = 'name'; $filter = {name => 'nested'} }; tests nested => {flat => 1}, sub { my $unit = example(); my $events = intercept { Test2::Workflow::Runner->new( rand => 0, task => $unit, filter => $filter )->run(); }; is( $events, array { event Note => { message => 'root_before_all' }; event Note => { message => 'root_around_all_prefix' }; event Subtest => sub { call name => "root_$_"; call subevents => array { event Note => { message => "root case $_" }; event Skip => {}; event Skip => {}; event Skip => {}; event Skip => {}; event Subtest => sub { call name => 'nested'; call subevents => array { event Note => { message => 'nested_before_all' }; event Note => { message => 'nested_around_all_prefix' }; event Subtest => sub { call name => "nested_$_"; call subevents => array { event Note => { message => "nested case $_" }; event Subtest => sub { call name => $_; call subevents => array { event Note => { message => 'root_before_each' }; event Note => { message => 'root_around_each_prefix' }; event Note => { message => 'nested_before_each' }; event Note => { message => 'nested_around_each_prefix' }; if ($_ eq 'nested_long') { event Ok => { name => 'nested_long_1' }; event Ok => { name => 'nested_long_2' }; } else { event Ok => { name => $_ }; } event Note => { message => 'nested_after_each' }; event Note => { message => 'nested_around_each_postfix' }; event Note => { message => 'root_after_each' }; event Note => { message => 'root_around_each_postfix' }; event Plan => { max => T() }; }; } for qw/nested_a nested_b nested_long dup_name/; event Plan => { max => 4 }; }; } for qw/x y/; event Note => { message => 'nested_after_all' }; event Note => { message => 'nested_around_all_postfix' }; event Plan => { max => 2 }; }; }; event Plan => { max => 5 }; }; } for qw/x y/; event Note => { message => 'root_after_all' }; event Note => { message => 'root_around_all_postfix' }; }, "Got only the events that match the $type filter" ); }; }; tests dup_name => sub { my $unit = example(); my $events = intercept { Test2::Workflow::Runner->new( rand => 0, task => $unit, filter => {name => 'dup_name'} )->run(); }; is( $events, array { event Note => { message => 'root_before_all' }; event Note => { message => 'root_around_all_prefix' }; event Subtest => sub { call name => "root_$_"; call subevents => array { event Note => { message => "root case $_" }; event Skip => {}; event Skip => {}; event Skip => {}; event Subtest => sub { call name => 'dup_name'; call subevents => array { event Note => { message => 'root_before_each' }; event Note => { message => 'root_around_each_prefix' }; event Ok => { name => 'dup_name' }; event Note => { message => 'root_after_each' }; event Note => { message => 'root_around_each_postfix' }; event Plan => { max => 1 }; }; }; event Subtest => sub { call name => 'nested'; call subevents => array { event Note => { message => 'nested_before_all' }; event Note => { message => 'nested_around_all_prefix' }; event Subtest => sub { call name => "nested_$_"; call subevents => array { event Note => { message => "nested case $_" }; event Skip => {}; event Skip => {}; event Skip => {}; event Subtest => sub { call name => 'dup_name'; call subevents => array { event Note => { message => 'root_before_each' }; event Note => { message => 'root_around_each_prefix' }; event Note => { message => 'nested_before_each' }; event Note => { message => 'nested_around_each_prefix' }; event Ok => { name => 'dup_name' }; event Note => { message => 'nested_after_each' }; event Note => { message => 'nested_around_each_postfix' }; event Note => { message => 'root_after_each' }; event Note => { message => 'root_around_each_postfix' }; event Plan => { max => 1 }; }; }; event Plan => { max => 4 }; }; } for qw/x y/; event Note => { message => 'nested_after_all' }; event Note => { message => 'nested_around_all_postfix' }; event Plan => { max => 2 }; }; }; event Plan => { max => 5 }; }; } for qw/x y/; event Note => { message => 'root_after_all' }; event Note => { message => 'root_around_all_postfix' }; }, "Got only the events that match the dup_name filter" ); }; tests root_case => sub { my $unit = example(); my $events = intercept { Test2::Workflow::Runner->new( rand => 0, task => $unit, filter => {name => 'root_x'} )->run(); }; is( $events, array { event Note => { message => 'root_before_all' }; event Note => { message => 'root_around_all_prefix' }; event Subtest => sub { call name => "root_x"; call subevents => array { event Note => { message => "root case x" }; event Subtest => sub { call name => $_; call subevents => array { event Note => { message => 'root_before_each' }; event Note => { message => 'root_around_each_prefix' }; if ($_ eq 'root_long') { event Ok => { name => 'root_long_1' }; event Ok => { name => 'root_long_2' }; } else { event Ok => { name => $_ }; } event Note => { message => 'root_after_each' }; event Note => { message => 'root_around_each_postfix' }; event Plan => { max => T() }; }; } for qw/root_a root_b root_long dup_name/; event Subtest => sub { call name => 'nested'; call subevents => array { event Note => { message => 'nested_before_all' }; event Note => { message => 'nested_around_all_prefix' }; event Subtest => sub { call name => "nested_$_"; call subevents => array { event Note => { message => "nested case $_" }; event Subtest => sub { call name => $_; call subevents => array { event Note => { message => 'root_before_each' }; event Note => { message => 'root_around_each_prefix' }; event Note => { message => 'nested_before_each' }; event Note => { message => 'nested_around_each_prefix' }; if ($_ eq 'nested_long') { event Ok => { name => 'nested_long_1' }; event Ok => { name => 'nested_long_2' }; } else { event Ok => { name => $_ }; } event Note => { message => 'nested_after_each' }; event Note => { message => 'nested_around_each_postfix' }; event Note => { message => 'root_after_each' }; event Note => { message => 'root_around_each_postfix' }; event Plan => { max => T() }; }; } for qw/nested_a nested_b nested_long dup_name/; event Plan => { max => 4 }; }; } for qw/x y/; event Note => { message => 'nested_after_all' }; event Note => { message => 'nested_around_all_postfix' }; event Plan => { max => 2 }; }; }; event Plan => { max => 5 }; }; }; event Skip => {}; event Note => { message => 'root_after_all' }; event Note => { message => 'root_around_all_postfix' }; }, "Got only the events that match the case filter" ); }; tests nested_case => sub { my $unit = example(); my $events = intercept { Test2::Workflow::Runner->new( rand => 0, task => $unit, filter => {name => 'nested_x'} )->run(); }; is( $events, array { event Note => { message => 'root_before_all' }; event Note => { message => 'root_around_all_prefix' }; event Subtest => sub { call name => "root_$_"; call subevents => array { event Note => { message => "root case $_" }; event Skip => {}; event Skip => {}; event Skip => {}; event Skip => {}; event Subtest => sub { call name => 'nested'; call subevents => array { event Note => { message => 'nested_before_all' }; event Note => { message => 'nested_around_all_prefix' }; event Subtest => sub { call name => "nested_x"; call subevents => array { event Note => { message => "nested case x" }; event Subtest => sub { call name => $_; call subevents => array { event Note => { message => 'root_before_each' }; event Note => { message => 'root_around_each_prefix' }; event Note => { message => 'nested_before_each' }; event Note => { message => 'nested_around_each_prefix' }; if ($_ eq 'nested_long') { event Ok => { name => 'nested_long_1' }; event Ok => { name => 'nested_long_2' }; } else { event Ok => { name => $_ }; } event Note => { message => 'nested_after_each' }; event Note => { message => 'nested_around_each_postfix' }; event Note => { message => 'root_after_each' }; event Note => { message => 'root_around_each_postfix' }; event Plan => { max => T() }; }; } for qw/nested_a nested_b nested_long dup_name/; event Plan => { max => 4 }; }; }; event Skip => {}; event Note => { message => 'nested_after_all' }; event Note => { message => 'nested_around_all_postfix' }; event Plan => { max => 2 }; }; }; event Plan => { max => 5 }; }; } for qw/x y/; event Note => { message => 'root_after_all' }; event Note => { message => 'root_around_all_postfix' }; }, "Got only the events that match the nested case filter" ); }; done_testing; Tools000755001750001750 012747547341 17701 5ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2Spec.pm100644001750001750 4015112747547341 21312 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2/Toolspackage Test2::Tools::Spec; use strict; use warnings; use Carp qw/croak/; use Test2::Workflow qw/parse_args build current_build root_build init_root build_stack/; use Test2::Workflow::Runner(); use Test2::Workflow::Task::Action(); use Test2::Workflow::Task::Group(); use Test2::Tools::Mock(); use Importer(); use vars qw/@EXPORT @EXPORT_OK/; push @EXPORT => qw{describe cases}; push @EXPORT_OK => qw{include_workflow include_workflows spec_defaults}; my %HANDLED; sub import { my $class = shift; my @caller = caller(0); my %root_args; my %runner_args; my @import; while (my $arg = shift @_) { if ($arg =~ s/^-//) { my $val = shift @_; if (Test2::Workflow::Runner->can($arg)) { $runner_args{$arg} = $val; } elsif (Test2::Workflow::Task::Group->can($arg)) { $root_args{$arg} = $val; } elsif ($arg eq 'root_args') { %root_args = (%root_args, %$val); } elsif ($arg eq 'runner_args') { %runner_args = (%runner_args, %$val); } else { croak "Unrecognized arg: $arg"; } } else { push @import => $arg; } } if ($HANDLED{$caller[0]}++) { croak "Package $caller[0] has already been initialized" if keys(%root_args) || keys(%runner_args); } else { my $root = init_root( $caller[0], frame => \@caller, code => sub { 1 }, %root_args, ); my $runner = Test2::Workflow::Runner->new(%runner_args); Test2::Tools::Mock->add_handler( $caller[0], sub { my %params = @_; my ($class, $caller, $builder, $args) = @params{qw/class caller builder args/}; my $do_it = eval "package $caller->[0];\n#line $caller->[2] \"$caller->[1]\"\nsub { \$runner\->add_mock(\$builder->()) }"; # Running if (@{$runner->stack}) { $do_it->(); } else { # Not running my $action = Test2::Workflow::Task::Action->new( code => $do_it, name => "mock $class", frame => $caller, scaffold => 1, ); my $build = current_build() || $root; $build->add_primary_setup($action); $build->add_stash($builder->()) unless $build->is_root; } return 1; } ); my $stack = Test2::API::test2_stack; $stack->top; # Insure we have a hub my ($hub) = Test2::API::test2_stack->all; $hub->set_active(1); $hub->follow_up( sub { return unless $root->populated; my $g = $root->compile; $runner->push_task($g); $runner->run; } ); } Importer->import_into($class, $caller[0], @import); } { no warnings 'once'; *cases = \&describe; *include_workflows = \&include_workflow; } sub describe { my @caller = caller(0); my $want = wantarray; my $build = build(args => \@_, caller => \@caller, stack_stop => defined $want ? 1 : 0); return $build if defined $want; my $current = current_build() || root_build($caller[0]) or croak "No current workflow build!"; $current->add_primary($build); } sub include_workflow { my @caller = caller(0); my $build = current_build() || root_build(\$caller[0]) or croak "No current workflow build!"; for my $task (@_) { croak "include_workflow only accepts Test2::Workflow::Task objects, got: $task" unless $task->isa('Test2::Workflow::Task'); $build->add_primary($task); } } sub defaults { my %params = @_; my ($package, $tool) = @params{qw/package tool/}; my @stack = (root_build($package), build_stack()); return unless @stack; my %out; for my $build (@stack) { %out = () if $build->stack_stop; my $new = $build->defaults->{$tool} or next; %out = (%out, %$new); } return \%out; } # Generate a bunch of subs that only have minor differences between them. BEGIN { @EXPORT = qw{ tests it case before_all around_all after_all before_case around_case after_case before_each around_each after_each }; @EXPORT_OK = qw{ mini iso miso async masync }; my %stages = ( case => ['add_variant'], tests => ['add_primary'], it => ['add_primary'], iso => ['add_primary'], miso => ['add_primary'], async => ['add_primary'], masync => ['add_primary'], mini => ['add_primary'], before_all => ['add_setup'], after_all => ['add_teardown'], around_all => ['add_setup', 'add_teardown'], before_case => ['add_variant_setup'], after_case => ['add_variant_teardown'], around_case => ['add_variant_setup', 'add_variant_teardown'], before_each => ['add_primary_setup'], after_each => ['add_primary_teardown'], around_each => ['add_primary_setup', 'add_primary_teardown'], ); my %props = ( case => [], tests => [], it => [], iso => [iso => 1], miso => [iso => 1, flat => 1], async => [async => 1], masync => [async => 1, flat => 1], mini => [flat => 1], before_all => [scaffold => 1], after_all => [scaffold => 1], around_all => [scaffold => 1, around => 1], before_case => [scaffold => 1], after_case => [scaffold => 1], around_case => [scaffold => 1, around => 1], before_each => [scaffold => 1], after_each => [scaffold => 1], around_each => [scaffold => 1, around => 1], ); sub spec_defaults { my ($tool, %params) = @_; my @caller = caller(0); croak "'$tool' is not a spec tool" unless exists $props{$tool} || exists $stages{$tool}; my $build = current_build() || root_build($caller[0]) or croak "No current workflow build!"; my $old = $build->defaults->{$tool} ||= {}; $build->defaults->{$tool} = { %$old, %params }; } my $run = ""; for my $func (@EXPORT, @EXPORT_OK) { $run .= <<" EOT"; #line ${ \(__LINE__ + 1) } "${ \__FILE__ }" sub $func { my \@caller = caller(0); my \$args = parse_args(args => \\\@_, caller => \\\@caller); my \$action = Test2::Workflow::Task::Action->new(\@{\$props{$func}}, %\$args); return \$action if defined wantarray; my \$build = current_build() || root_build(\$caller[0]) or croak "No current workflow build!"; if (my \$defaults = defaults(package => \$caller[0], tool => '$func')) { for my \$attr (keys \%\$defaults) { next if defined \$action->\$attr; my \$sub = "set_\$attr"; \$action->\$sub(\$defaults->{\$attr}); } } \$build->\$_(\$action) for \@{\$stages{$func}}; } EOT } my ($ok, $err); { local $@; $ok = eval "$run\n1"; $err = $@; } die $@ unless $ok; } 1; __END__ =pod =encoding UTF-8 =head1 NAME Test2::Tools::Spec - RSPEC implementation on top of Test2::Workflow =head1 DESCRIPTION This uses L to implement an RSPEC variant. This variant supports isolation and/or concurrency via forking or threads. =head1 SYNOPSIS use Test2::Bundle::Extended; use Test2::Tools::Spec; describe foo => sub { before_all once => sub { ... }; before_each many => sub { ... }; after_all once => sub { ... }; after_each many => sub { ... }; case condition_a => sub { ... }; case condition_b => sub { ... }; tests foo => sub { ... }; tests bar => sub { ... }; }; done_testing; =head1 EXPORTS All of these use the same argument pattern. The first argument must always be a name for the block. The last argument must always be a code reference. Optionally a configuration hash can be inserted between the name and the code reference. FUNCTION "name" => sub { ... }; FUNCTION "name" => {...}, sub { ... }; =over 4 =item NAME The first argument to a Test2::Tools::Spec function MUST be a name. The name does not need to be unique. =item PARAMS This argument is optional. If present this should be a hashref. Here are the valid keys for the hashref: =over 8 =item flat => $bool If this is set to true then the block will not render as a subtest, instead the events will be inline with the parent subtest (or main test). =item async => $bool Set this to true to mark a block as being capable of running concurrently with other test blocks. This does not mean the block WILL be run concurrently, just that it can be. =item iso => $bool Set this to true if the block MUST be run in isolation. If this is true then the block will run in its own thread or fork. =item todo => $reason Use this to mark an entire block as TODO. =item skip => $reason Use this to prevent a block from running at all. =back =item CODEREF This argument is required. This should be a code reference that will run some assertions. =back =head2 ESSENTIALS =over 4 =item tests NAME => sub { ... } =item tests NAME => \%params, sub { ... } =item tests($NAME, \%PARAMS, \&CODE) =item it NAME => sub { ... } =item it NAME => \%params, sub { ... } =item it($NAME, \%PARAMS, \&CODE) This defines a test block. Test blocks are essentially subtests. All test blocks will be run, and are expected to produce events. Test blocks can run multiple times if the C function is also used. C is an alias to C. These ARE NOT inherited by nested describe blocks. =item case NAME => sub { ... } =item case NAME => \%params, sub { ... } =item case($NAME, \%PARAMS, \&CODE) This lets you specify multiple conditions in which the test blocks should be run. Every test block within the same group (C) will be run once per case. These ARE NOT inherited by nested describe blocks, but nested describe blocks will be executed once per case. =item before_each NAME => sub { ... } =item before_each NAME => \%params, sub { ... } =item before_each($NAME, \%PARAMS, \&CODE) Specify a codeblock that should be run multiple times, once before each C block is run. These will run AFTER C blocks but before C blocks. These ARE inherited by nested describe blocks. =item before_case NAME => sub { ... } =item before_case NAME => \%params, sub { ... } =item before_case($NAME, \%PARAMS, \&CODE) Same as C, except these blocks run BEFORE C blocks. These ARE NOT inherited by nested describe blocks. =item before_all NAME => sub { ... } =item before_all NAME => \%params, sub { ... } =item before_all($NAME, \%PARAMS, \&CODE) Specify a codeblock that should be run once, before all the test blocks run. These ARE NOT inherited by nested describe blocks. =item around_each NAME => sub { ... } =item around_each NAME => \%params, sub { ... } =item around_each($NAME, \%PARAMS, \&CODE) Specify a codeblock that should wrap around each test block. These blocks are run AFTER case blocks, but before test blocks. around_each wrapit => sub { my $cont = shift; local %ENV = ( ... ); $cont->(); ... }; The first argument to the codeblock will be a callback that MUST be called somewhere inside the sub in order for nested items to run. These ARE inherited by nested describe blocks. =item around_case NAME => sub { ... } =item around_case NAME => \%params, sub { ... } =item around_case($NAME, \%PARAMS, \&CODE) Same as C except these run BEFORE case blocks. These ARE NOT inherited by nested describe blocks. =item around_all NAME => sub { ... } =item around_all NAME => \%params, sub { ... } =item around_all($NAME, \%PARAMS, \&CODE) Same as C except that it only runs once to wrap ALL test blocks. These ARE NOT inherited by nested describe blocks. =item after_each NAME => sub { ... } =item after_each NAME => \%params, sub { ... } =item after_each($NAME, \%PARAMS, \&CODE) Same as C except it runs right after each test block. These ARE inherited by nested describe blocks. =item after_case NAME => sub { ... } =item after_case NAME => \%params, sub { ... } =item after_case($NAME, \%PARAMS, \&CODE) Same as C except it runs right after the case block, and before the test block. These ARE NOT inherited by nested describe blocks. =item after_all NAME => sub { ... } =item after_all NAME => \%params, sub { ... } =item after_all($NAME, \%PARAMS, \&CODE) Same as C except it runs after all test blocks have been run. These ARE NOT inherited by nested describe blocks. =back =head2 SHORTCUTS These are shortcuts. Each of these is the same as C except some parameters are added for you. These are NOT exported by default/. =over 4 =item mini NAME => sub { ... } Same as: tests NAME => { flat => 1 }, sub { ... } =item iso NAME => sub { ... } Same as: tests NAME => { iso => 1 }, sub { ... } =item miso NAME => sub { ... } Same as: tests NAME => { mini => 1, iso => 1 }, sub { ... } =item async NAME => sub { ... } Same as: tests NAME => { async => 1 }, sub { ... } B This conflicts with the C exported from L. Don't import both. =item masync NAME => sub { ... } Same as: tests NAME => { minit => 1, async => 1 }, sub { ... } =back =head2 CUSTOM ATTRIBUTE DEFAULTS Sometimes you want to apply default attributes to all C or C blocks. This can be done, and is lexical to your describe or package root! use Test2::Bundle::Extended; use Test2::Tools::Spec ':ALL'; # All 'tests' blocks after this declaration will have C< 1>> by default spec_defaults tests => (iso => 1); tests foo => sub { ... }; # isolated tests foo, {iso => 0}, sub { ... }; # Not isolated spec_defaults tests => (iso => 0); # Turn it off again Defaults are inherited by nested describe blocks. You can also override the defaults for the scope of the describe: spec_defaults tests => (iso => 1); describe foo => sub { spec_defaults tests => (async => 1); # Scoped to this describe and any child describes tests bar => sub { ... }; # both iso and async }; tests baz => sub { ... }; # Just iso, no async. You can apply defaults to any type of blocks: spec_defaults case => (iso => 1); # All cases are 'iso'; Defaults are not inherited when a builder's return is captured. spec_defaults tests => (iso => 1); # Note we are not calling this in void context, that is the key here. my $d = describe foo => { tests bar => sub { ... }; # Not iso }; =head1 EXECUTION ORDER As each function is encountered it executes, just like any other function. The C function will immedietly execute the codeblock it is given. All other functions will stash their codeblocks to be run later. When C is run the workflow will be compiled, at which point all other blocks will run. Here is an overview of the order in which blocks get called once compiled (at C). before_all for-each-case { before_case case after_case # AND/OR nested describes before_each tests after_each } after_all =head1 SOURCE The source code repository for Test2-Workflow can be found at F. =head1 MAINTAINERS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 AUTHORS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 COPYRIGHT Copyright 2016 Chad Granum Eexodist7@gmail.comE. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See F =cut Workflow000755001750001750 012747547341 20251 5ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/unitsTask.t100644001750001750 14412747547341 21457 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/units/Workflowuse Test2::Bundle::Extended -target => 'Test2::Workflow::Task'; skip_all "Tests not yet written"; Build.t100644001750001750 14412747547341 21614 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/units/Workflowuse Test2::Bundle::Extended -target => 'Test2::Workflow::Build'; skip_all "Tests not yet written"; Runner.t100644001750001750 14512747547341 22027 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/units/Workflowuse Test2::Bundle::Extended -target => 'Test2::Workflow::Runner'; skip_all "Tests not yet written"; no_leaks_any.t100644001750001750 141312747547341 22062 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/behavioruse Test2::Bundle::Extended; use Test2::Tools::Spec; use Test2::Util qw/get_tid/; my $x; tests a => {mini => 1, async => 1, iso => 1}, sub { ok(!$x, "a $$ " . get_tid); $x = "a"}; tests b => {mini => 1, async => 1, iso => 1}, sub { ok(!$x, "b $$ " . get_tid); $x = "b"}; tests c => {mini => 1, async => 1, iso => 1}, sub { ok(!$x, "c $$ " . get_tid); $x = "c"}; tests d => {mini => 1, async => 1, iso => 1}, sub { ok(!$x, "d $$ " . get_tid); $x = "d"}; tests e => {mini => 1, async => 1, iso => 1}, sub { ok(!$x, "e $$ " . get_tid); $x = "e"}; tests f => {mini => 1, async => 1, iso => 1}, sub { ok(!$x, "f $$ " . get_tid); $x = "f"}; tests g => {mini => 1, async => 1, iso => 1}, sub { ok(!$x, "g $$ " . get_tid); $x = "g"}; done_testing; die "Ooops, we leaked |$x|" if $x; Workflow000755001750001750 012747547341 20413 5ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2Task.pm100644001750001750 740312747547341 22017 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2/Workflowpackage Test2::Workflow::Task; use strict; use warnings; use Test2::API(); use Test2::Event::Exception(); use List::Util qw/min max/; use Scalar::Util qw/blessed/; use Carp qw/croak/; our @CARP_NOT = qw/Test2::Util::HashBase/; use base 'Test2::Workflow::BlockBase'; use Test2::Util::HashBase qw/name flat async iso todo skip scaffold events is_root/; for my $attr (FLAT, ISO, ASYNC, TODO, SKIP, SCAFFOLD) { my $old = __PACKAGE__->can("set_$attr"); my $new = sub { my $self = shift; my $out = $self->$old(@_); $self->verify_scaffold; return $out; }; no strict 'refs'; no warnings 'redefine'; *{"set_$attr"} = $new; } sub init { my $self = shift; $self->{+EVENTS} ||= []; { local $Carp::CarpLevel = $Carp::CarpLevel + 1; $self->SUPER::init(); } $self->throw("the 'name' attribute is required") unless $self->{+NAME}; $self->throw("the 'flat' attribute cannot be combined with 'iso' or 'async'") if $self->{+FLAT} && ($self->{+ISO} || $self->{+ASYNC}); $self->set_subname($self->package . "::<$self->{+NAME}>"); $self->verify_scaffold; } sub clone { my $self = shift; return bless {%$self}, blessed($self); } sub verify_scaffold { my $self = shift; return unless $self->{+SCAFFOLD}; croak "The 'flat' attribute must be true for scaffolding" if defined($self->{+FLAT}) && !$self->{+FLAT}; $self->{+FLAT} = 1; for my $attr (ISO, ASYNC, TODO, SKIP) { croak "The '$attr' attribute cannot be used on scaffolding" if $self->{$attr}; } } sub exception { my $self = shift; my ($err) = @_; my $trace = $self->trace; Test2::API::test2_stack->top->send( Test2::Event::Exception->new( trace => $trace, error => $err, ) ); } sub filter { my $self = shift; my ($filter) = @_; return unless $filter; return if $self->{+IS_ROOT}; return if $self->{+SCAFFOLD}; if (my $name = $filter->{name}) { my $ok = 0; unless(ref($name)) { $ok ||= $self->{+NAME} eq $name; $ok ||= $self->subname eq $name; } if (ref($name) eq 'Regexp') { $ok ||= $self->{+NAME} =~ $name; $ok ||= $self->subname =~ $name; } elsif ($name =~ m{^/}) { my $pattern = eval "qr$name" or die "'$name' does not appear to be a valid pattern"; $ok ||= $self->{+NAME} =~ $pattern; $ok ||= $self->subname =~ $pattern; } return {skip => "Does not match name filter '$name'"} unless $ok; } if (my $file = $filter->{file}) { return {skip => "Does not match file filter '$file'"} unless $self->file eq $file; } if (my $line = $filter->{line}) { my $lines = $self->lines; return {skip => "Does not match line filter '$line' (no lines)"} unless $lines && @$lines; my $min = min(@$lines); my $max = max(@$lines); return {skip => "Does not match line filter '$min <= $line <= $max'"} unless $min <= $line && $max >= $line; } return; } 1; __END__ =pod =encoding UTF-8 =head1 NAME Test2::Workflow::Task - Encapsulation of a Task =head1 SOURCE The source code repository for Test2-Workflow can be found at F. =head1 MAINTAINERS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 AUTHORS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 COPYRIGHT Copyright 2016 Chad Granum Eexodist7@gmail.comE. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See F =cut Build.pm100644001750001750 711012747547341 22147 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2/Workflowpackage Test2::Workflow::Build; use strict; use warnings; use Test2::Workflow::Task::Group; our @BUILD_FIELDS; BEGIN { @BUILD_FIELDS = qw{ primary variant setup teardown variant_setup variant_teardown primary_setup primary_teardown stash }; } use base 'Test2::Workflow::Task'; use Test2::Util::HashBase @BUILD_FIELDS, qw/events defaults stack_stop/; sub init { my $self = shift; { local $Carp::CarpLevel = $Carp::CarpLevel + 1; $self->SUPER::init(); } $self->{$_} ||= [] for @BUILD_FIELDS; $self->{+DEFAULTS} ||= {}; } for my $field (@BUILD_FIELDS) { my $code = sub { my $self = shift; push @{$self->{$field}} => @_; }; no strict 'refs'; *{"add_$field"} = $code; } sub populated { my $self = shift; for my $field (@BUILD_FIELDS) { return 1 if @{$self->{$field}}; } return 0; } sub compile { my $self = shift; warn "Workflow build '$self->{+NAME}' is empty " . $self->debug . "\n" unless $self->populated || $self->{+SKIP}; my ($primary_setup, $primary_teardown) = @_; $primary_setup ||= []; $primary_teardown ||= []; my $variant = $self->{+VARIANT}; my $setup = $self->{+SETUP}; my $teardown = $self->{+TEARDOWN}; my $variant_setup = $self->{+VARIANT_SETUP}; my $variant_teardown = $self->{+VARIANT_TEARDOWN}; $primary_setup = [@$primary_setup, @{$self->{+PRIMARY_SETUP}}]; $primary_teardown = [@{$self->{+PRIMARY_TEARDOWN}}, @$primary_teardown]; # Get primaries in order. my $primary = [ map { $_->isa(__PACKAGE__) ? $_->compile($primary_setup, $primary_teardown) : $_; } @{$self->{+PRIMARY}}, ]; if (@$primary_setup || @$primary_teardown) { $primary = [ map { my $p = $_->clone; $_->isa('Test2::Workflow::Task::Action') ? Test2::Workflow::Task::Group->new( before => $primary_setup, primary => [ $p ], take => $p, after => $primary_teardown, ) : $_; } @$primary ]; } # Build variants if (@$variant) { $primary = [ map { my $v = $_->clone; Test2::Workflow::Task::Group->new( before => $variant_setup, primary => $primary, after => $variant_teardown, variant => $v, take => $v, ); } @$variant ]; } my %params = map { Test2::Workflow::Task::Group->can($_) ? ($_ => $self->{$_}) : () } keys %$self; delete $params{$_} for @BUILD_FIELDS; return Test2::Workflow::Task::Group->new( %params, before => $setup, after => $teardown, primary => $primary, ); } 1; __END__ =pod =encoding UTF-8 =head1 NAME Test2::Workflow::Build - Represents a build in progress. =head1 SOURCE The source code repository for Test2-Workflow can be found at F. =head1 MAINTAINERS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 AUTHORS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 COPYRIGHT Copyright 2016 Chad Granum Eexodist7@gmail.comE. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See F =cut Runner.pm100644001750001750 2742712747547341 22416 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2/Workflowpackage Test2::Workflow::Runner; use strict; use warnings; use Test2::API(); use Test2::Todo(); use Test2::AsyncSubtest(); use Test2::Util qw/get_tid CAN_REALLY_FORK/; use Scalar::Util qw/blessed/; use Time::HiRes qw/sleep/; use List::Util qw/shuffle min/; use Carp qw/confess/; use Test2::Util::HashBase qw{ stack no_fork no_threads max slots pid tid rand subtests filter }; use overload( 'fallback' => 1, '&{}' => sub { my $self = shift; sub { @_ = ($self); goto &run; } }, ); sub init { my $self = shift; $self->{+STACK} = []; $self->{+SUBTESTS} = []; $self->{+PID} = $$; $self->{+TID} = get_tid(); $self->{+NO_FORK} ||= $ENV{T2_WORKFLOW_NO_FORK} || !CAN_REALLY_FORK(); $self->{+NO_THREADS} ||= $ENV{T2_WORKFLOW_NO_THREADS} || !Test2::AsyncSubtest->CAN_REALLY_THREAD(); $self->{+RAND} = 1 unless defined $self->{+RAND}; my @max = grep {defined $_} $self->{+MAX}, $ENV{T2_WORKFLOW_ASYNC}; my $max = @max ? min(@max) : 3; $self->{+MAX} = $max; $self->{+SLOTS} = [] if $max; unless(defined($self->{+FILTER})) { if (my $raw = $ENV{T2_WORKFLOW}) { my ($file, $line, $name); if ($raw =~ m/^(.*)\s+(\d+)$/) { ($file, $line) = ($1, $2); } elsif($raw =~ m/^(\d+)$/) { $line = $1; } else { $name = $raw; } $self->{+FILTER} = { file => $file, line => $line, name => $name, }; } } if (my $task = delete $self->{task}) { $self->push_task($task); } } sub is_local { my $self = shift; return 0 unless $self->{+PID} == $$; return 0 unless $self->{+TID} == get_tid(); return 1; } sub send_event { my $self = shift; my ($type, %params) = @_; my $class; if ($type =~ m/\+(.*)$/) { $class = $1; } else { $class = "Test2::Event::$type"; } my $e = $class->new( trace => Test2::Util::Trace->new(frame => [caller(0)]), %params, ); Test2::API::test2_stack()->top()->send($e); } sub current_subtest { my $self = shift; my $stack = $self->{+STACK} or return undef; for my $state (reverse @$stack) { next unless $state->{subtest}; return $state->{subtest}; } return undef; } sub run { my $self = shift; my $stack = $self->stack; my $c = 0; while (@$stack) { $self->cull; my $state = $stack->[-1]; my $task = $state->{task}; unless($state->{started}++) { my $skip = $task->skip; my $filter; if (my $f = $self->{+FILTER}) { my $in_var = grep { $_->{filter_satisfied} } @$stack; $filter = $task->filter($f) unless $in_var; $state->{filter_satisfied} = 1 if $filter->{satisfied}; } $skip ||= $filter->{skip} if $filter; if ($skip) { $state->{ended}++; $self->send_event( 'Skip', reason => $skip || $filter, name => $task->name, pass => 1, effective_pass => 1, ); pop @$stack; next; } if ($task->flat) { my $st = $self->current_subtest; my $hub = $st ? $st->hub : Test2::API::test2_stack->top; $state->{todo} = Test2::Todo->new(reason => $task->todo, hub => $hub) if $task->todo; $hub->send($_) for @{$task->events}; } else { my $st = Test2::AsyncSubtest->new( name => $task->name, trace => Test2::Util::Trace->new(frame => $task->frame), ); $state->{subtest} = $st; $state->{todo} = Test2::Todo->new(reason => $task->todo, hub => $st->hub) if $task->todo; $st->hub->send($_) for @{$task->events}; my $slot = $self->isolate($state); # if we forked/threaded then this state has ended here. if (defined($slot)) { push @{$self->{+SUBTESTS}} => [$st, $task] unless $st->finished; $state->{subtest} = undef; $state->{ended} = 1; } } } if ($state->{ended}) { $state->{todo}->end() if $state->{todo}; $state->{subtest}->stop() if $state->{subtest}; return if $state->{in_thread}; if(my $guard = delete $state->{in_fork}) { $state->{subtest}->detach; $guard->dismiss; exit 0; } pop @$stack; next; } if($state->{subtest} && !$state->{subtest_started}++) { push @{$self->{+SUBTESTS}} => [$state->{subtest}, $task]; $state->{subtest}->start(); } if ($task->isa('Test2::Workflow::Task::Action')) { $state->{PID} = $$; my $ok = eval { $task->code->($self); 1 }; unless ($state->{PID} == $$) { print STDERR "Task '" . $task->name . "' started in pid $state->{PID}, but ended in pid $$, did you forget to exit after forking?\n"; exit 255; } $task->exception($@) unless $ok; $state->{ended} = 1; next; } if (!$state->{stage} || $state->{stage} eq 'BEFORE') { $state->{before} //= 0; if (my $add = $task->before->[$state->{before}++]) { if ($add->around) { $state->{PID} = $$; my $ok = eval { $add->code->($self); 1 }; my $err = $@; my $complete = $state->{stage} && $state->{stage} eq 'AFTER'; unless ($state->{PID} == $$) { print STDERR "Task '" . $task->name . "' started in pid $state->{PID}, but ended in pid $$, did you forget to exit after forking?\n"; exit 255; } unless($ok && $complete) { $state->{ended} = 1; $state->{stage} = 'AFTER'; $task->exception($ok ? "'around' task failed to continue into the workflow chain.\n" : $err); } } else { $self->push_task($add); } } else { $state->{stage} = 'VARIANT'; } } elsif ($state->{stage} eq 'VARIANT') { if (my $v = $task->variant) { $self->push_task($v); } $state->{stage} = 'PRIMARY'; } elsif ($state->{stage} eq 'PRIMARY') { unless (defined $state->{order}) { my $rand = defined($task->rand) ? $task->rand : $self->rand; $state->{order} = [0 .. scalar(@{$task->primary}) - 1]; @{$state->{order}} = shuffle(@{$state->{order}}) if $rand; } my $num = shift @{$state->{order}}; if (defined $num) { $self->push_task($task->primary->[$num]); } else { $state->{stage} = 'AFTER'; } } elsif ($state->{stage} eq 'AFTER') { $state->{after} //= 0; if (my $add = $task->after->[$state->{after}++]) { return if $add->around; $self->push_task($add); } else { $state->{ended} = 1; } } } $self->finish; } sub push_task { my $self = shift; my ($task) = @_; confess "No Task!" unless $task; confess "Bad Task ($task)!" unless blessed($task) && $task->isa('Test2::Workflow::Task'); if ($task->isa('Test2::Workflow::Build')) { confess "Can only push a Build instance when initializing the stack" if @{$self->{+STACK}}; $task = $task->compile(); } push @{$self->{+STACK}} => { task => $task, name => $task->name, }; } sub add_mock { my $self = shift; my ($mock) = @_; my $stack = $self->{+STACK}; confess "Nothing on the stack!" unless $stack && @$stack; my ($state) = grep { !$_->{task}->scaffold} reverse @$stack; push @{$state->{mocks}} => $mock; } sub isolate { my $self = shift; my ($state) = @_; return if $state->{task}->skip; my $iso = $state->{task}->iso; my $async = $state->{task}->async; # No need to isolate return undef unless $iso || $async; # Cannot isolate unless($self->{+MAX} && $self->is_local) { # async does not NEED to be isolated return undef unless $iso; } # Wait for a slot, if max is set to 0 then we will not find a slot, instead # we use '0'. We need to return a defined value to let the stack know that # the task has ended. my $slot = 0; while($self->{+MAX} && $self->is_local) { $self->cull; for my $s (1 .. $self->{+MAX}) { my $st = $self->{+SLOTS}->[$s]; next if $st && !$st->finished; $self->{+SLOTS}->[$s] = undef; $slot = $s; last; } last if $slot; sleep(0.02); } my $st = $state->{subtest} or confess "Cannot isolate a task without a subtest"; if (!$self->no_fork) { my $out = $st->fork; if (blessed($out)) { $state->{in_fork} = $out; # drop back out to complete the task. return undef; } else { $self->send_event( 'Note', message => "Forked PID $out to run: " . $state->{task}->name, ); $state->{pid} = $out; } } elsif (!$self->no_threads) { $state->{in_thread} = 1; my $thr = $st->run_thread(\&run, $self); $state->{thread} = $thr; delete $state->{in_thread}; $self->send_event( 'Note', message => "Started Thread-ID " . $thr->tid . " to run: " . $state->{task}->name, ); } else { $st->finish(skip => "No isolation method available"); return 0; } if($slot) { $self->{+SLOTS}->[$slot] = $st; } else { $st->finish; } return $slot; } sub cull { my $self = shift; my $subtests = delete $self->{+SUBTESTS} || return; my @new; # Cull subtests in reverse order, Nested subtests end before their parents. for my $set (reverse @$subtests) { my ($st, $task) = @$set; next if $st->finished; if (!$st->active && $st->ready) { $st->finish(); next; } # Use unshift to preserve order. unshift @new => $set; } $self->{+SUBTESTS} = \@new; return; } sub finish { my $self = shift; while(@{$self->{+SUBTESTS}}) { $self->cull; sleep(0.02) if @{$self->{+SUBTESTS}}; } } 1; __END__ =pod =encoding UTF-8 =head1 NAME Test2::Workflow::Runner - Runs the workflows. =head1 SOURCE The source code repository for Test2-Workflow can be found at F. =head1 MAINTAINERS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 AUTHORS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 COPYRIGHT Copyright 2016 Chad Granum Eexodist7@gmail.comE. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See F =cut BlockBase.t100644001750001750 15012747547341 22377 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/units/Workflowuse Test2::Bundle::Extended -target => 'Test2::Workflow::BlockBase'; skip_all "Tests not yet written"; no_done_testing.t100644001750001750 101312747547341 22572 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/behavioruse Test2::Bundle::Extended; use Test2::Tools::Spec; # Get a non-canon context for the root hub. my $ctx = sub { my $ctx = context(); my $out = $ctx->snapshot; $ctx->release; return $out; }->(); tests foo => sub { # This ok is part of the subtest and goes to the subtest hub ok(1, "pass"); # Use the non-canon root hub context to set a plan. We do this here so that # no plan is ever set if the test block does not run. $ctx->plan(1); }; # done_testing intentionally omitted, see #3 no_leaks_no_iso.t100644001750001750 133612747547341 22565 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/behavioruse Test2::Bundle::Extended; use Test2::Tools::Spec -no_threads => 1, -no_fork => 1; use Test2::Util qw/get_tid/; my $x; tests a => {async => 1, iso => 1}, sub { ok(!$x, "a $$ " . get_tid); $x = "a"}; tests b => {async => 1, iso => 1}, sub { ok(!$x, "b $$ " . get_tid); $x = "b"}; tests c => {async => 1, iso => 1}, sub { ok(!$x, "c $$ " . get_tid); $x = "c"}; tests d => {async => 1, iso => 1}, sub { ok(!$x, "d $$ " . get_tid); $x = "d"}; tests e => {async => 1, iso => 1}, sub { ok(!$x, "e $$ " . get_tid); $x = "e"}; tests f => {async => 1, iso => 1}, sub { ok(!$x, "f $$ " . get_tid); $x = "f"}; tests g => {async => 1, iso => 1}, sub { ok(!$x, "g $$ " . get_tid); $x = "g"}; done_testing; die "Ooops, we leaked |$x|" if $x; Task000755001750001750 012747547341 21153 5ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/units/WorkflowGroup.t100644001750001750 26112747547341 22553 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/units/Workflow/Taskuse Test2::Bundle::Extended -target => 'Test2::Workflow::Task::Group'; skip_all "Tests not yet written"; can_ok($CLASS, qw/before after primary rand variant/); done_testing; no_leaks_no_fork.t100644001750001750 131412747547341 22730 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/behavioruse Test2::Bundle::Extended; use Test2::Tools::Spec -no_fork => 1; use Test2::Util qw/get_tid/; my $x; tests a => {async => 1, iso => 1}, sub { ok(!$x, "a $$ " . get_tid); $x = "a"}; tests b => {async => 1, iso => 1}, sub { ok(!$x, "b $$ " . get_tid); $x = "b"}; tests c => {async => 1, iso => 1}, sub { ok(!$x, "c $$ " . get_tid); $x = "c"}; tests d => {async => 1, iso => 1}, sub { ok(!$x, "d $$ " . get_tid); $x = "d"}; tests e => {async => 1, iso => 1}, sub { ok(!$x, "e $$ " . get_tid); $x = "e"}; tests f => {async => 1, iso => 1}, sub { ok(!$x, "f $$ " . get_tid); $x = "f"}; tests g => {async => 1, iso => 1}, sub { ok(!$x, "g $$ " . get_tid); $x = "g"}; done_testing; die "Ooops, we leaked |$x|" if $x; Action.t100644001750001750 16212747547341 22674 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/units/Workflow/Taskuse Test2::Bundle::Extended -target => 'Test2::Workflow::Task::Action'; can_ok($CLASS, 'around'); done_testing; BlockBase.pm100644001750001750 552212747547341 22742 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2/Workflowpackage Test2::Workflow::BlockBase; use strict; use warnings; use Test2::Util::HashBase qw/code frame _info _lines/; use Test2::Util::Sub qw/sub_info/; use List::Util qw/min max/; use Carp qw/croak/; use Test2::Util::Trace(); BEGIN { local ($@, $!, $SIG{__DIE__}); my $set_name = eval { require Sub::Util; Sub::Util->can('set_subname') } || eval { require Sub::Name; Sub::Name->can('subname') }; *set_subname = $set_name ? sub { my $self = shift; my ($name) = @_; $set_name->($name, $self->{+CODE}); delete $self->{+_INFO}; return 1; } : sub { return 0 }; } sub init { my $self = shift; croak "The 'code' attribute is required" unless $self->{+CODE}; croak "The 'frame' attribute is required" unless $self->{+FRAME}; $self->{+_LINES} = delete $self->{lines} if $self->{lines}; } sub file { shift->info->{file} } sub lines { shift->info->{lines} } sub package { shift->info->{package} } sub subname { shift->info->{name} } sub info { my $self = shift; unless ($self->{+_INFO}) { my $info = sub_info($self->code); my $frame = $self->frame; my $file = $info->{file}; my $all_lines = $info->{all_lines}; my $pre_lines = $self->{+_LINES}; my $lines = $info->{lines} ||= []; if ($pre_lines && @$pre_lines) { @$lines = @$pre_lines; } else { @$lines = ( min(@$all_lines, $frame->[2]), max(@$all_lines, $frame->[2]), ) if $frame->[1] eq $file; } # Adjust for start $lines->[0]-- if $lines->[0] != $lines->[1]; $self->{+_INFO} = $info; } return $self->{+_INFO}; } sub trace { my $self = shift; return Test2::Util::Trace->new( frame => $self->frame, detail => $self->debug, ); } sub debug { my $self = shift; my $file = $self->file; my $lines = $self->lines; my $line_str = @$lines == 1 ? "around line $lines->[0]" : "around lines $lines->[0] -> $lines->[1]"; return "at $file $line_str."; } sub throw { my $self = shift; my ($msg) = @_; die "$msg " . $self->debug . "\n"; } 1; __END__ =pod =encoding UTF-8 =head1 NAME Test2::Workflow::BlockBase - Base class for all workflow blocks. =head1 SOURCE The source code repository for Test2-Workflow can be found at F. =head1 MAINTAINERS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 AUTHORS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 COPYRIGHT Copyright 2016 Chad Granum Eexodist7@gmail.comE. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See F =cut Task000755001750001750 012747547341 21315 5ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2/WorkflowGroup.pm100644001750001750 414312747547341 23111 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2/Workflow/Taskpackage Test2::Workflow::Task::Group; use strict; use warnings; use Carp qw/croak/; use Test2::Workflow::Task::Action; use base 'Test2::Workflow::Task'; use Test2::Util::HashBase qw/before after primary rand variant/; sub init { my $self = shift; if (my $take = delete $self->{take}) { $self->{$_} = delete $take->{$_} for ISO, ASYNC, TODO, SKIP; $self->{$_} = $take->{$_} for FLAT, SCAFFOLD, NAME, CODE, FRAME; $take->{+FLAT} = 1; $take->{+SCAFFOLD} = 1; } { local $Carp::CarpLevel = $Carp::CarpLevel + 1; $self->SUPER::init(); } $self->{+BEFORE} ||= []; $self->{+AFTER} ||= []; $self->{+PRIMARY} ||= []; } sub filter { my $self = shift; my ($filter) = @_; return if $self->{+IS_ROOT}; my $result = $self->SUPER::filter($filter); my $child_ok = 0; for my $c (@{$self->{+PRIMARY}}) { next if $c->{+SCAFFOLD}; # A child matches the filter, so we should not be filtered, but also # should not satisfy the filter. my $res = $c->filter($filter); # A child satisfies the filter $child_ok++ if !$res || $res->{satisfied}; last if $child_ok; } # If the filter says we are ok unless($result) { # If we are a variant then allow everything under us to be run return {satisfied => 1} if $self->{+VARIANT} || !$child_ok; # Normal group return; } return if $child_ok; return $result; } 1; __END__ =pod =encoding UTF-8 =head1 NAME Test2::Workflow::Task::Group - Encapsulation of a group (describe). =head1 SOURCE The source code repository for Test2-Workflow can be found at F. =head1 MAINTAINERS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 AUTHORS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 COPYRIGHT Copyright 2016 Chad Granum Eexodist7@gmail.comE. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See F =cut no_leaks_no_threads.t100644001750001750 131712747547341 23424 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/t/behavioruse Test2::Bundle::Extended; use Test2::Tools::Spec -no_threads => 1; use Test2::Util qw/get_tid/; my $x; tests a => {async => 1, iso => 1}, sub { ok(!$x, "a $$ " . get_tid); $x = "a"}; tests b => {async => 1, iso => 1}, sub { ok(!$x, "b $$ " . get_tid); $x = "b"}; tests c => {async => 1, iso => 1}, sub { ok(!$x, "c $$ " . get_tid); $x = "c"}; tests d => {async => 1, iso => 1}, sub { ok(!$x, "d $$ " . get_tid); $x = "d"}; tests e => {async => 1, iso => 1}, sub { ok(!$x, "e $$ " . get_tid); $x = "e"}; tests f => {async => 1, iso => 1}, sub { ok(!$x, "f $$ " . get_tid); $x = "f"}; tests g => {async => 1, iso => 1}, sub { ok(!$x, "g $$ " . get_tid); $x = "g"}; done_testing; die "Ooops, we leaked |$x|" if $x; Action.pm100644001750001750 137512747547341 23236 0ustar00exodistexodist000000000000Test2-Workflow-0.000017/lib/Test2/Workflow/Taskpackage Test2::Workflow::Task::Action; use strict; use warnings; use base 'Test2::Workflow::Task'; use Test2::Util::HashBase qw/around/; 1; __END__ =pod =encoding UTF-8 =head1 NAME Test2::Workflow::Task::Action - Ancapsulation of an action. =head1 SOURCE The source code repository for Test2-Workflow can be found at F. =head1 MAINTAINERS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 AUTHORS =over 4 =item Chad Granum Eexodist@cpan.orgE =back =head1 COPYRIGHT Copyright 2016 Chad Granum Eexodist7@gmail.comE. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See F =cut