TLT (empty) → 0.1.0.0
raw patch · 8 files changed
+1745/−0 lines, 8 filesdep +HUnitdep +STMonadTransdep +TLTsetup-changed
Dependencies added: HUnit, STMonadTrans, TLT, ansi-terminal, base, either, free, mtl, resourcet, symbol, transformers
Files
- ChangeLog.md +3/−0
- LICENSE +674/−0
- README.md +10/−0
- Setup.hs +2/−0
- TLT.cabal +89/−0
- app/Failing.hs +23/−0
- src/Test/TLT.hs +860/−0
- test/Passing.hs +84/−0
+ ChangeLog.md view
@@ -0,0 +1,3 @@+# Changelog for TLT++## Unreleased changes
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU General Public License is a free, copyleft license for+software and other kinds of works.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+the GNU General Public License is intended to guarantee your freedom to+share and change all versions of a program--to make sure it remains free+software for all its users. We, the Free Software Foundation, use the+GNU General Public License for most of our software; it applies also to+any other work released this way by its authors. You can apply it to+your programs, too.++ When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++ To protect your rights, we need to prevent others from denying you+these rights or asking you to surrender the rights. Therefore, you have+certain responsibilities if you distribute copies of the software, or if+you modify it: responsibilities to respect the freedom of others.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must pass on to the recipients the same+freedoms that you received. You must make sure that they, too, receive+or can get the source code. And you must show them these terms so they+know their rights.++ Developers that use the GNU GPL protect your rights with two steps:+(1) assert copyright on the software, and (2) offer you this License+giving you legal permission to copy, distribute and/or modify it.++ For the developers' and authors' protection, the GPL clearly explains+that there is no warranty for this free software. For both users' and+authors' sake, the GPL requires that modified versions be marked as+changed, so that their problems will not be attributed erroneously to+authors of previous versions.++ Some devices are designed to deny users access to install or run+modified versions of the software inside them, although the manufacturer+can do so. This is fundamentally incompatible with the aim of+protecting users' freedom to change the software. The systematic+pattern of such abuse occurs in the area of products for individuals to+use, which is precisely where it is most unacceptable. Therefore, we+have designed this version of the GPL to prohibit the practice for those+products. If such problems arise substantially in other domains, we+stand ready to extend this provision to those domains in future versions+of the GPL, as needed to protect the freedom of users.++ Finally, every program is threatened constantly by software patents.+States should not allow patents to restrict development and use of+software on general-purpose computers, but in those that do, we wish to+avoid the special danger that patents applied to a free program could+make it effectively proprietary. To prevent this, the GPL assures that+patents cannot be used to render the program non-free.++ The precise terms and conditions for copying, distribution and+modification follow.++ TERMS AND CONDITIONS++ 0. Definitions.++ "This License" refers to version 3 of the GNU General Public License.++ "Copyright" also means copyright-like laws that apply to other kinds of+works, such as semiconductor masks.++ "The Program" refers to any copyrightable work licensed under this+License. Each licensee is addressed as "you". "Licensees" and+"recipients" may be individuals or organizations.++ To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of an+exact copy. The resulting work is called a "modified version" of the+earlier work or a work "based on" the earlier work.++ A "covered work" means either the unmodified Program or a work based+on the Program.++ To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy. Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++ To "convey" a work means any kind of propagation that enables other+parties to make or receive copies. Mere interaction with a user through+a computer network, with no transfer of a copy, is not conveying.++ An interactive user interface displays "Appropriate Legal Notices"+to the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License. If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++ 1. Source Code.++ The "source code" for a work means the preferred form of the work+for making modifications to it. "Object code" means any non-source+form of a work.++ A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++ The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form. A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++ The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities. However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work. For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++ The Corresponding Source need not include anything that users+can regenerate automatically from other parts of the Corresponding+Source.++ The Corresponding Source for a work in source code form is that+same work.++ 2. Basic Permissions.++ All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met. This License explicitly affirms your unlimited+permission to run the unmodified Program. The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work. This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++ You may make, run and propagate covered works that you do not+convey, without conditions so long as your license otherwise remains+in force. You may convey covered works to others for the sole purpose+of having them make modifications exclusively for you, or provide you+with facilities for running those works, provided that you comply with+the terms of this License in conveying all material for which you do+not control copyright. Those thus making or running the covered works+for you must do so exclusively on your behalf, under your direction+and control, on terms that prohibit them from making any copies of+your copyrighted material outside their relationship with you.++ Conveying under any other circumstances is permitted solely under+the conditions stated below. Sublicensing is not allowed; section 10+makes it unnecessary.++ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.++ No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++ When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such circumvention+is effected by exercising rights under this License with respect to+the covered work, and you disclaim any intention to limit operation or+modification of the work as a means of enforcing, against the work's+users, your or third parties' legal rights to forbid circumvention of+technological measures.++ 4. Conveying Verbatim Copies.++ You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++ You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++ 5. Conveying Modified Source Versions.++ You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these conditions:++ a) The work must carry prominent notices stating that you modified+ it, and giving a relevant date.++ b) The work must carry prominent notices stating that it is+ released under this License and any conditions added under section+ 7. This requirement modifies the requirement in section 4 to+ "keep intact all notices".++ c) You must license the entire work, as a whole, under this+ License to anyone who comes into possession of a copy. This+ License will therefore apply, along with any applicable section 7+ additional terms, to the whole of the work, and all its parts,+ regardless of how they are packaged. This License gives no+ permission to license the work in any other way, but it does not+ invalidate such permission if you have separately received it.++ d) If the work has interactive user interfaces, each must display+ Appropriate Legal Notices; however, if the Program has interactive+ interfaces that do not display Appropriate Legal Notices, your+ work need not make them do so.++ A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit. Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++ 6. Conveying Non-Source Forms.++ You may convey a covered work in object code form under the terms+of sections 4 and 5, provided that you also convey the+machine-readable Corresponding Source under the terms of this License,+in one of these ways:++ a) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by the+ Corresponding Source fixed on a durable physical medium+ customarily used for software interchange.++ b) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by a+ written offer, valid for at least three years and valid for as+ long as you offer spare parts or customer support for that product+ model, to give anyone who possesses the object code either (1) a+ copy of the Corresponding Source for all the software in the+ product that is covered by this License, on a durable physical+ medium customarily used for software interchange, for a price no+ more than your reasonable cost of physically performing this+ conveying of source, or (2) access to copy the+ Corresponding Source from a network server at no charge.++ c) Convey individual copies of the object code with a copy of the+ written offer to provide the Corresponding Source. This+ alternative is allowed only occasionally and noncommercially, and+ only if you received the object code with such an offer, in accord+ with subsection 6b.++ d) Convey the object code by offering access from a designated+ place (gratis or for a charge), and offer equivalent access to the+ Corresponding Source in the same way through the same place at no+ further charge. You need not require recipients to copy the+ Corresponding Source along with the object code. If the place to+ copy the object code is a network server, the Corresponding Source+ may be on a different server (operated by you or a third party)+ that supports equivalent copying facilities, provided you maintain+ clear directions next to the object code saying where to find the+ Corresponding Source. Regardless of what server hosts the+ Corresponding Source, you remain obligated to ensure that it is+ available for as long as needed to satisfy these requirements.++ e) Convey the object code using peer-to-peer transmission, provided+ you inform other peers where the object code and Corresponding+ Source of the work are being offered to the general public at no+ charge under subsection 6d.++ A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++ A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal, family,+or household purposes, or (2) anything designed or sold for incorporation+into a dwelling. In determining whether a product is a consumer product,+doubtful cases shall be resolved in favor of coverage. For a particular+product received by a particular user, "normally used" refers to a+typical or common use of that class of product, regardless of the status+of the particular user or of the way in which the particular user+actually uses, or expects or is expected to use, the product. A product+is a consumer product regardless of whether the product has substantial+commercial, industrial or non-consumer uses, unless such uses represent+the only significant mode of use of the product.++ "Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to install+and execute modified versions of a covered work in that User Product from+a modified version of its Corresponding Source. The information must+suffice to ensure that the continued functioning of the modified object+code is in no case prevented or interfered with solely because+modification has been made.++ If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information. But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++ The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or updates+for a work that has been modified or installed by the recipient, or for+the User Product in which it has been modified or installed. Access to a+network may be denied when the modification itself materially and+adversely affects the operation of the network or violates the rules and+protocols for communication across the network.++ Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++ 7. Additional Terms.++ "Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law. If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++ When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it. (Additional permissions may be written to require their own+removal in certain cases when you modify the work.) You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++ Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders of+that material) supplement the terms of this License with terms:++ a) Disclaiming warranty or limiting liability differently from the+ terms of sections 15 and 16 of this License; or++ b) Requiring preservation of specified reasonable legal notices or+ author attributions in that material or in the Appropriate Legal+ Notices displayed by works containing it; or++ c) Prohibiting misrepresentation of the origin of that material, or+ requiring that modified versions of such material be marked in+ reasonable ways as different from the original version; or++ d) Limiting the use for publicity purposes of names of licensors or+ authors of the material; or++ e) Declining to grant rights under trademark law for use of some+ trade names, trademarks, or service marks; or++ f) Requiring indemnification of licensors and authors of that+ material by anyone who conveys the material (or modified versions of+ it) with contractual assumptions of liability to the recipient, for+ any liability that these contractual assumptions directly impose on+ those licensors and authors.++ All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10. If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term. If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++ If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++ Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions;+the above requirements apply either way.++ 8. Termination.++ You may not propagate or modify a covered work except as expressly+provided under this License. Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++ However, if you cease all violation of this License, then your+license from a particular copyright holder is reinstated (a)+provisionally, unless and until the copyright holder explicitly and+finally terminates your license, and (b) permanently, if the copyright+holder fails to notify you of the violation by some reasonable means+prior to 60 days after the cessation.++ Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++ Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License. If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++ 9. Acceptance Not Required for Having Copies.++ You are not required to accept this License in order to receive or+run a copy of the Program. Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance. However,+nothing other than this License grants you permission to propagate or+modify any covered work. These actions infringe copyright if you do+not accept this License. Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++ 10. Automatic Licensing of Downstream Recipients.++ Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License. You are not responsible+for enforcing compliance by third parties with this License.++ An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations. If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++ You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License. For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++ 11. Patents.++ A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based. The+work thus licensed is called the contributor's "contributor version".++ A contributor's "essential patent claims" are all patent claims+owned or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version. For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++ Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++ In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement). To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++ If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients. "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++ If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++ A patent license is "discriminatory" if it does not include within+the scope of its coverage, prohibits the exercise of, or is+conditioned on the non-exercise of one or more of the rights that are+specifically granted under this License. You may not convey a covered+work if you are a party to an arrangement with a third party that is+in the business of distributing software, under which you make payment+to the third party based on the extent of your activity of conveying+the work, and under which the third party grants, to any of the+parties who would receive the covered work from you, a discriminatory+patent license (a) in connection with copies of the covered work+conveyed by you (or copies made from those copies), or (b) primarily+for and in connection with specific products or compilations that+contain the covered work, unless you entered into that arrangement,+or that patent license was granted, prior to 28 March 2007.++ Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++ 12. No Surrender of Others' Freedom.++ If conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot convey a+covered work so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you may+not convey it at all. For example, if you agree to terms that obligate you+to collect a royalty for further conveying from those to whom you convey+the Program, the only way you could satisfy both those terms and this+License would be to refrain entirely from conveying the Program.++ 13. Use with the GNU Affero General Public License.++ Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU Affero General Public License into a single+combined work, and to convey the resulting work. The terms of this+License will continue to apply to the part which is the covered work,+but the special requirements of the GNU Affero General Public License,+section 13, concerning interaction through a network will apply to the+combination as such.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU General Public License from time to time. Such new versions will+be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++ Each version is given a distinguishing version number. If the+Program specifies that a certain numbered version of the GNU General+Public License "or any later version" applies to it, you have the+option of following the terms and conditions either of that numbered+version or of any later version published by the Free Software+Foundation. If the Program does not specify a version number of the+GNU General Public License, you may choose any version ever published+by the Free Software Foundation.++ If the Program specifies that a proxy can decide which future+versions of the GNU General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++ Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++ 15. Disclaimer of Warranty.++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. Limitation of Liability.++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++ 17. Interpretation of Sections 15 and 16.++ If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+state the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU General Public License as published by+ the Free Software Foundation, either version 3 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU General Public License for more details.++ You should have received a copy of the GNU General Public License+ along with this program. If not, see <https://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If the program does terminal interaction, make it output a short+notice like this when it starts in an interactive mode:++ <program> Copyright (C) <year> <name of author>+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands `show w' and `show c' should show the appropriate+parts of the General Public License. Of course, your program's commands+might be different; for a GUI interface, you would use an "about box".++ You should also get your employer (if you work as a programmer) or school,+if any, to sign a "copyright disclaimer" for the program, if necessary.+For more information on this, and how to apply and follow the GNU GPL, see+<https://www.gnu.org/licenses/>.++ The GNU General Public License does not permit incorporating your program+into proprietary programs. If your program is a subroutine library, you+may consider it more useful to permit linking proprietary applications with+the library. If this is what you want to do, use the GNU Lesser General+Public License instead of this License. But first, please read+<https://www.gnu.org/licenses/why-not-lgpl.html>.
+ README.md view
@@ -0,0 +1,10 @@+# TLT++TLT is a Haskell test framework oriented towards stacked monad+transformers. TLT has no explicit test specifications. Tests are run+where declared, with results accumulated and reported at the end.+Tests can live in an arbitrary monad transformer so long as the `TLT`+transformer is part of the stack. Some control of the results display+is available.++See the TLT Haddock page for instructions and examples.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ TLT.cabal view
@@ -0,0 +1,89 @@+cabal-version: 1.12++-- This file has been generated from package.yaml by hpack version 0.34.4.+--+-- see: https://github.com/sol/hpack++name: TLT+version: 0.1.0.0+synopsis: Testing in monads and transformers without explicit specs+description: A small unit test system oriented with an emphasis on examining intermediate results of computations in monad transformers. The Test.TLT Haddock page is the main piece of documentation; or see also the GitHub repository <https://github.com/jphmrst/TLT/>.+category: Test+homepage: https://github.com/jphmrst/TLT#readme+bug-reports: https://github.com/jphmrst/TLT/issues+author: John Maraist+maintainer: haskell-tlt@maraist.org+copyright: 2022 John Maraist+license: LGPL-3+license-file: LICENSE+build-type: Simple+extra-source-files:+ README.md+ ChangeLog.md++source-repository head+ type: git+ location: https://github.com/jphmrst/TLT++library+ exposed-modules:+ Test.TLT+ other-modules:+ Paths_TLT+ hs-source-dirs:+ src+ build-depends:+ HUnit >=1.6.2 && <1.7+ , STMonadTrans >=0.4.6 && <0.5+ , ansi-terminal >=0.11.1 && <0.12+ , base (>=4.14.3 && <4.15) || (>=4.15.1 && <4.16) || (>=4.16.0 && <4.17)+ , either >=5.0.1 && <5.1+ , free >=5.1.7 && <5.2+ , mtl >=2.2.2 && <2.3+ , resourcet >=1.2.4 && <1.3+ , symbol >=0.2.4 && <0.3+ , transformers >=0.5.6 && <0.6+ default-language: Haskell2010++executable TLT-exe+ main-is: Failing.hs+ other-modules:+ Paths_TLT+ hs-source-dirs:+ app+ ghc-options: -threaded -rtsopts -with-rtsopts=-N+ build-depends:+ HUnit >=1.6.2 && <1.7+ , STMonadTrans >=0.4.6 && <0.5+ , TLT+ , ansi-terminal >=0.11.1 && <0.12+ , base (>=4.14.3 && <4.15) || (>=4.15.1 && <4.16) || (>=4.16.0 && <4.17)+ , either >=5.0.1 && <5.1+ , free >=5.1.7 && <5.2+ , mtl >=2.2.2 && <2.3+ , resourcet >=1.2.4 && <1.3+ , symbol >=0.2.4 && <0.3+ , transformers >=0.5.6 && <0.6+ default-language: Haskell2010++test-suite TLT-test-fail+ type: exitcode-stdio-1.0+ main-is: Passing.hs+ other-modules:+ Paths_TLT+ hs-source-dirs:+ test+ ghc-options: -threaded -rtsopts -with-rtsopts=-N+ build-depends:+ HUnit >=1.6.2 && <1.7+ , STMonadTrans >=0.4.6 && <0.5+ , TLT+ , ansi-terminal >=0.11.1 && <0.12+ , base (>=4.14.3 && <4.15) || (>=4.15.1 && <4.16) || (>=4.16.0 && <4.17)+ , either >=5.0.1 && <5.1+ , free >=5.1.7 && <5.2+ , mtl >=2.2.2 && <2.3+ , resourcet >=1.2.4 && <1.3+ , symbol >=0.2.4 && <0.3+ , transformers >=0.5.6 && <0.6+ default-language: Haskell2010
+ app/Failing.hs view
@@ -0,0 +1,23 @@+import Test.TLT++main :: IO ()+main = do+ tlt test++test :: Monad m => TLT m ()+test = do+ "True passes" ~::- True+ "2 is 3 as single Bool" ~::- 2 == 3+ "2 is 2 as single Bool" ~::- 2 == 2+ inGroup "== assertions" $ do+ inGroup "pure" $ do+ "2 is 3 as pure assertion" ~: 2 @==- 3+ "2 is 2 as pure assertion" ~: 2 @==- 2+ inGroup "monadic" $ do+ "2 is 3 as result" ~: 2 @== return 3+ "2 is 2 as result" ~: 2 @== return 2+ inGroup "/= pure assertions" $ do+ "2 not 3" ~: 2 @/=- 3+ "2 not 2" ~: 2 @/=- 2+ "2 not 3 as result" ~: 2 @/= return 3+ "2 not 2 as result" ~: 2 @/= return 2
+ src/Test/TLT.hs view
@@ -0,0 +1,860 @@+{-|+Module : TLT+Description : Testing in a monad transformer layer+Copyright : (c) John Maraist, 2022+License : GPL3+Maintainer : haskell-tlt@maraist.org+Stability : experimental+Portability : POSIX++TLT is a small unit test system oriented towards examining+intermediate results of computations in monad transformers. It is+intended to be lightweight for the programmer, and does not require+tests to be specified in some sort of formal list of tests. Rather,+tests are simply commands in a monad stack which includes the+transformer layer @Test.TLT@.++This Haddock page is the main piece of documentation; or see also the+GitHub repository <https://github.com/jphmrst/TLT/>.++-}++{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE UndecidableInstances #-}+{-# LANGUAGE MultiParamTypeClasses #-}+{-# LANGUAGE FunctionalDependencies #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}++module Test.TLT (+ -- * Overview++ -- |A TLT test is a command in the `TLT` monad transformer. There+ -- is no separation between the specification and execution of a+ -- test; TLT makes no record of an executable test itself, only of+ -- its result. So in the main instance for testing, the core `IO`+ -- monad should be wrapped in the `TLT` transformer, and in whatever+ -- other layers are also to be tested.+ --+ -- In TLT, all tests are associated with a string which names or+ -- otherwise describes the test. Each test is introduced with one+ -- of the @~:@, @~::@, or @~::-@ infix operators.+ --+ -- The simplest tests simply look for a `True` boolean value. These+ -- tests are introduced with @~::@ or @~::-@. The difference+ -- between the two is whether the boolean value is the result of a+ -- pure `Bool` expression, or whether it is returned as the result+ -- of a computation. In TLT, we distinguish between the two cases+ -- by including a trailing hyphen @-@ to operators on pure+ -- expressions, and omitting the hyphen from operators on monadic+ -- arguments. So these two tests will both pass,+ --+ -- > "2 is 2 as single Bool" ~::- 2 == 2+ -- > "2 is 2 a returned Bool" ~:: return $ 2 == 2+ --+ -- The @~:@ operator introduces a more general form of test. The+ -- right-hand side of @~:@ should be an `Assertion` formed with one+ -- of TLT's built-in assertion operators, or returned from a+ -- package's custom assertions. `Assertion`s can give more detailed+ -- failure information then simple `Bool`s.+ --+ -- Syntactically, most assertions are infix operators which start+ -- with a @\@@ character. The value to the left of the operator is+ -- the expected value, and the symbol to the right is (or returns)+ -- the value under test. A hyphen or @P@ suffixes assertion+ -- operators which operate on pure values; for operators without the+ -- trailing hyphen, the value under test should is expected to be+ -- returned as the result of a monadic computation (as with @~::@+ -- and @~::-@).+ --+ -- TLT provides these assertion operators:+ --+ -- +---------------------------------+---------------------------------------++ -- | Operator | Meaning |+ -- +=================================+=======================================++ -- | @/expected/ \@== /monadic/@ | The actual result must be equal |+ -- +---------------------------------+ to the given expected result. |+ -- | @/expected/ \@==- /expr/@ | |+ -- +---------------------------------+---------------------------------------++ -- | @/unexpected/ \@\/= /monadic/@ | The actual result must differ |+ -- +---------------------------------+ from the given unexpected result. |+ -- | @/unexpected/ \@\/=- /expr/@ | |+ -- +---------------------------------+---------------------------------------++ -- | @/expected/ \@< /monadic/@ | The actual result must be greater |+ -- +---------------------------------+ than the given lower bound. |+ -- | @/expected/ \@<- /expr/@ | |+ -- +---------------------------------+---------------------------------------++ -- | @/expected/ \@> /monadic/@ | The actual result must be less |+ -- +---------------------------------+ than the given upper bound. |+ -- | @/expected/ \@>- /expr/@ | |+ -- +---------------------------------+---------------------------------------++ -- | @/expected/ \@<= /monadic/@ | The actual result must be greater |+ -- +---------------------------------+ than or equal to the given lower |+ -- | @/expected/ \@<=- /expr/@ | bound. |+ -- +---------------------------------+---------------------------------------++ -- | @/expected/ \@>= /monadic/@ | The actual result must be less than |+ -- +---------------------------------+ or equal to the given upper bound. |+ -- | @/expected/ \@>=- /expr/@ | |+ -- +---------------------------------+---------------------------------------++ -- | @empty /monadic/@ | The actual result must be an empty |+ -- +---------------------------------+ `Traversable` structure. |+ -- | @emptyP /expr/@ | |+ -- +---------------------------------+---------------------------------------++ -- | @nonempty /monadic/@ | The actual result must be a nonempty |+ -- +---------------------------------+ `Traversable` structure. |+ -- | @nonemptyP /expr/@ | |+ -- +---------------------------------+---------------------------------------++ -- | @nothing /monadic/@ | The actual result must be `Nothing` |+ -- +---------------------------------+ (in a `Maybe`-typed value) |+ -- | @nothingP /expr/@ | |+ -- +---------------------------------+---------------------------------------++ -- | @assertFailed /message/@ | Trivial assertions, intended for the |+ -- +---------------------------------+ less interesting branches of |+ -- | @assertSuccess@ | conditional and selection expressions.|+ -- +---------------------------------+---------------------------------------++ --+ -- Note that although the assertions are in pairs of one for testing+ -- a pure expression value, and one for testing the result returned+ -- from a monadic computation, in all of the builtin binary+ -- assertions the /expected/ value argument is always a pure value,+ -- not itself monadic.+ --+ -- The `inGroup` function allows related tests to be reported as a+ -- group. The function takes two arguments, a `String` name for the+ -- group, and the `TLT` computation housing its tests. Groups have+ -- impact only in terms of organizing the output you see in the+ -- final report of tests run.+ --+ -- Finally, it is straightforward to write new `Assertion`s for+ -- project-specific test criteria: they are simply functions+ -- returning monadic values. There are several functions in the+ -- final section of this document which transform pure predicates+ -- into `Assertion`s, or which transform one form of `Assertion`+ -- into another.+ --+ -- The source repository for TLT lives at+ -- <https://github.com/jphmrst/tlt>.++ -- * Examples++ -- |These examples are from the sample executables and test suite of+ -- the @TLT@ package.++ -- ** A simple example++ -- |The tests in this example are vacuous, but they show a simple+ -- setup with both passing and failing tests.+ --+ -- > main :: IO ()+ -- > main = do+ -- > tlt test+ -- >+ -- > test :: Monad m => TLT m ()+ -- > test = do+ -- > "True passes" ~::- True+ -- > "2 is 3 as single Bool" ~::- 2 == 3+ -- > "2 is 2 as single Bool" ~::- 2 == 2+ -- > inGroup "== assertions" $ do+ -- > inGroup "pure" $ do+ -- > "2 is 3 as pure assertion" ~: 2 @==- 3+ -- > "2 is 2 as pure assertion" ~: 2 @==- 2+ -- > inGroup "monadic" $ do+ -- > "2 is 3 as result" ~: 2 @== return 3+ -- > "2 is 2 as result" ~: 2 @== return 2+ -- > inGroup "/= pure assertions" $ do+ -- > "2 not 3" ~: 2 @/=- 3+ -- > "2 not 2" ~: 2 @/=- 2+ -- > "2 not 3 as result" ~: 2 @/= return 3+ -- > "2 not 2 as result" ~: 2 @/= return 2+ --+ -- Running these tests should give:+ --+ -- > Running tests:+ -- > - 2 is 3 as single Bool: FAIL Expected True but got False+ -- > - == assertions:+ -- > - pure:+ -- > - 2 is 3 as pure assertion: FAIL Expected 2 but got 3+ -- > - monadic:+ -- > - 2 is 3 as result: FAIL Expected 2 but got 3+ -- > - /= pure assertions:+ -- > - 2 not 2: FAIL Expected other than 2 but got 2+ -- > - 2 not 2 as result: FAIL Expected other than 2 but got 2+ -- > Found 5 errors in 11 tests; exiting+ --+ -- Note that only failing tests appear. This can be configured in the+ -- @test@ command: add a call at the beginning of @test@ to+ -- @reportAllTestResults@ to control this behavior:+ --+ -- > test :: Monad m => TLT m ()+ -- > test = do+ -- > reportAllTestResults True+ -- > "True passes" ~::- True+ -- > ...+ --+ -- and the output will be+ --+ -- > Running tests:+ -- > - True passes: Pass+ -- > - 2 is 3 as single Bool: FAIL Expected True but got False+ -- > - 2 is 2 as single Bool: Pass+ -- > - == assertions:+ -- > - pure:+ -- > - 2 is 3 as pure assertion: FAIL Expected 2 but got 3+ -- > - 2 is 2 as pure assertion: Pass+ -- > - monadic:+ -- > - 2 is 3 as result: FAIL Expected 2 but got 3+ -- > - 2 is 2 as result: Pass+ -- > - /= pure assertions:+ -- > - 2 not 3: Pass+ -- > - 2 not 2: FAIL Expected other than 2 but got 2+ -- > - 2 not 3 as result: Pass+ -- > - 2 not 2 as result: FAIL Expected other than 2 but got 2+ -- > Found 5 errors in 11 tests; exiting++ -- ** Testing monad transformers++ -- |In the previous example `TLT` was the outermost (in fact only)+ -- monad transformer, but it can appear at any level of the test+ -- suite's application stack. Using `TLT` at other than the top+ -- level is easiest when all of the transformers which might wrap it+ -- are declared as instances of `MonadTLT`.+ --+ -- Consider an application which declares two monad transformers+ -- @M1T@ and @M2T@. For simplicity here we take them to be just+ -- aliases for `IdentityT`:+ --+ -- > newtype Monad m => M1T m a = M1T { unwrap1 :: IdentityT m a }+ -- > runM1T :: Monad m => M1T m a -> m a+ -- > runM1T = runIdentityT . unwrap1+ -- >+ -- > newtype Monad m => M2T m a = M2T { unwrap2 :: IdentityT m a }+ -- > runM2T :: Monad m => M2T m a -> m a+ -- > runM2T = runIdentityT . unwrap2+ --+ -- And we elide the usual details of including each of them in+ -- `Functor`, `Applicative`, `Monad` and `MonadTrans`. We can+ -- declare instances of each in `MonadTLT`,+ --+ -- > instance MonadTLT m n => MonadTLT (M1T m) n where+ -- > liftTLT = lift . liftTLT+ --+ -- and similarly for @M2T@. Note that this declaration does require+ -- @FlexibleInstances@ (because @n@ does not appear in the instance+ -- type), @MultiParamTypeClasses@ (because we must mention both the+ -- top transformer @m@ and the monadic type @n@ directly wrapped by+ -- `TLT` within @m@), and @UndecidableInstances@ (because @n@ is not+ -- smaller in the recursive context of `MonadTLT`, which is not+ -- actually a problem because in the definition of `MonadTLT`, @n@+ -- is functionally dependent on @m@, which /is/ smaller in the+ -- recursive context) in the module where the `MonadTLT` instance is+ -- declared.+ --+ -- Now it is convenient to test both transformers:+ --+ -- > ttest = do+ -- > runM1T $ inGroup "M1T tests" $ m1tests+ -- > runM2T $ inGroup "M2T tests" $ m2tests+ -- >+ -- > m1tests = M1T $ do+ -- > "3 is 3 as pure assertion" ~: 3 @==- 3+ -- > "4 is 4 as pure assertion" ~: 4 @==- 4+ -- >+ -- > m2tests = M2T $ do+ -- > "5 is 5 as pure assertion" ~: 5 @==- 5+ -- > "6 is 6 as pure assertion" ~: 6 @==- 6+ --+ -- It is not necessary, for example, to harvest test declarations+ -- from the executions of the @MnT@s for assembly into an overall+ -- test declaration.++ -- * The TLT transformer+ TLT, tlt, MonadTLT, liftTLT,+ -- ** Session options+ reportAllTestResults, setExitAfterFailDisplay,+ -- * Writing tests+ Assertion,+ -- ** `TLT` commands+ (~:), (~::), (~::-), tltFail, inGroup,+ -- ** Assertions+ -- *** About the values of pure expressions of `Eq`- and `Ord`-type+ (@==), (@/=), (@<), (@>), (@<=), (@>=),+ -- *** About monadic computations returing `Eq`s and `Ord`s+ (@==-), (@/=-), (@<-), (@>-), (@<=-), (@>=-),+ -- *** About list values+ empty, nonempty, emptyP, nonemptyP,+ -- *** About `Maybe` values+ nothing, nothingP, assertFailed, assertSuccess,+ -- ** Building new assertions+ -- *** Unary assertions+ liftAssertionPure, assertionPtoM, liftAssertionM,+ -- *** Binary assertions+ liftAssertion2Pure, assertion2PtoM, liftAssertion2M++ ) where++import Data.Maybe+import Control.Exception+import Control.Monad+import Control.Monad.IO.Class+import Control.Monad.ST.Trans+import Control.Monad.Trans.Class+-- import Control.Monad.Trans.Either+import Control.Monad.Trans.Free+import Control.Monad.Trans.Identity+import Control.Monad.Trans.Maybe+import Control.Monad.Trans.Reader+import Control.Monad.Trans.Resource+import Control.Monad.Trans.State.Strict+import qualified Control.Monad.Trans.State.Lazy as SL+import qualified Control.Monad.Trans.Writer.Lazy as WL+import qualified Control.Monad.Trans.Writer.Strict as WS+import System.Console.ANSI+import System.Exit++-- * Results of tests++-- |Reasons why a test might fail.+data TestFail = Asserted String+ -- ^ A failure arising from an `Assertion` which is not met.+ | Erred String+ -- ^ A failure associated with a call to a Haskell+ -- function triggering an error.++formatFail :: TestFail -> String+formatFail (Asserted s) = s+formatFail (Erred s) = "Assertion raised exception: " ++ s++-- |An assertion is a computation (typically in the monad wrapped by+-- `TLT`) which returns a list of zero of more reasons for the failure+-- of the assertion. A successful computation returns an empty list:+-- no reasons for failure, hence success.+type Assertion m = m [TestFail]++-- |Hierarchical structure holding the result of running tests,+-- possibly grouped into tests.+data TestResult = Test String [TestFail]+ | Group String Int Int [TestResult]+ -- ^ The `Int`s are respectively the total number of+ -- tests executed, and total number of failures+ -- detected.++-- |Return the number of failed tests reported in a `TestResult`.+failCount :: TestResult -> Int+failCount (Test _ []) = 0+failCount (Test _ _) = 1+failCount (Group _ _ n _) = n++testCount :: TestResult -> Int+testCount (Test _ _) = 1+testCount (Group _ n _ _) = n++totalFailCount :: [TestResult] -> Int+totalFailCount = foldr (+) 0 . map failCount++totalTestCount :: [TestResult] -> Int+totalTestCount = foldr (+) 0 . map testCount++-- |Report the results of tests.+report :: TLTopts -> [TestResult] -> IO ()+report (TLTopts showPasses exitAfterFailDisplay) trs =+ let fails = totalFailCount trs+ tests = totalTestCount trs+ in do report' "" trs+ if fails > 0+ then do boldRed+ putStrLn $+ "Found " ++ show fails ++ " error"+ ++ (if fails > 1 then "s" else "")+ ++ " in " ++ show tests ++ " tests; exiting"+ mediumBlack+ when exitAfterFailDisplay exitFailure+ else do boldGreen+ putStrLn $ show tests ++ " test"+ ++ (if tests > 1 then "s" else "")+ ++ " passing."+ mediumBlack+ where report' ind trs = forM_ trs $ \ tr ->+ when (failCount tr > 0 || showPasses) $+ case tr of+ Test s r -> do+ putStr $ ind ++ "- " ++ s ++ ": "+ case r of+ [] -> do+ greenPass+ putStrLn ""+ x : [] -> do+ redFail+ putStrLn $ " " ++ formatFail x+ _ -> do+ redFail+ putStrLn ":"+ forM_ r $ \ f -> putStrLn $ ind ++ "- " ++ formatFail f+ Group s _ _ trs' -> do+ putStrLn $ ind ++ "- " ++ s ++ ":"+ report' (" " ++ ind) trs'++boldBlack = setSGR [+ SetColor Foreground Vivid Black, SetConsoleIntensity BoldIntensity ]+boldRed = setSGR [+ SetColor Foreground Vivid Red, SetConsoleIntensity BoldIntensity ]+boldGreen = setSGR [+ SetColor Foreground Vivid Green, SetConsoleIntensity BoldIntensity ]++mediumRed = setSGR [+ SetColor Foreground Vivid Red, SetConsoleIntensity NormalIntensity ]+mediumGreen = setSGR [+ SetColor Foreground Vivid Green, SetConsoleIntensity NormalIntensity ]+mediumBlue = setSGR [+ SetColor Foreground Vivid Blue, SetConsoleIntensity NormalIntensity ]+mediumBlack = setSGR [+ SetColor Foreground Vivid Black, SetConsoleIntensity NormalIntensity ]++greenPass = do+ mediumBlue+ putStr "Pass"+ mediumBlack++redFail = do+ boldRed+ putStr "FAIL"+ mediumBlack++-- |Accumulator for test results, in the style of a simplified Huet's+-- zipper which only ever adds to the end of the structure.+data TRBuf = Buf TRBuf Int Int String [TestResult] | Top Int Int [TestResult]++-- |Add a single test result to a `TRBuf`.+addResult :: TRBuf -> TestResult -> TRBuf+addResult (Top tc fc trs) tr =+ Top (tc + testCount tr) (fc + failCount tr) $ tr : trs+addResult (Buf up tc fc s trs) tr =+ Buf up (tc + testCount tr) (fc + failCount tr) s $ tr : trs++-- |Convert the topmost group of a bottom-up `TRBuf` into a completed+-- top-down report about the group.+currentGroup :: TRBuf -> TestResult+currentGroup (Buf up tc fc s trs) = Group s tc fc (reverse trs)++-- |Derive a new `TRBuf` corresponding to finishing the current group+-- and continuing to accumulate results into its enclosure.+popGroup :: TRBuf -> TRBuf+popGroup trb@(Buf acc _ _ _ _) = addResult acc $ currentGroup trb++-- |Convert a `TRBuf` into a list of top-down `TestResult`s.+closeTRBuf :: TRBuf -> [TestResult]+closeTRBuf (Top _ _ ts) = reverse ts+closeTRBuf b = closeTRBuf $ popGroup b++-- |Record of options which may be specified for running and reporting+-- TLT tests.+data TLTopts = TLTopts {+ optShowPasses :: Bool,+ optQuitAfterFailReport :: Bool+}++-- |Default initial options+defaultOpts = TLTopts False True++-- |Update the display of showing passes in a `TLTopts` record.+withShowPasses :: TLTopts -> Bool -> TLTopts+withShowPasses (TLTopts _ f) b = TLTopts b f++-- |Update the display of showing passes in a `TLTopts` record.+withExitAfterFail :: TLTopts -> Bool -> TLTopts+withExitAfterFail (TLTopts p _) b = TLTopts p b++-- |Synonym for the elements of the `TLT` state.+type TLTstate = (TLTopts, TRBuf)++-- |Monad transformer for TLT tests. This layer stores the results+-- from tests as they are executed.+newtype Monad m => TLT m r = TLT { unwrap :: StateT TLTstate m r }+ deriving (Functor, Applicative, Monad, MonadTrans, MonadIO)++{- ------------------------------------------------------------ -}++-- |Extending `TLT` operations across other monad transformers. For+-- easiest and most flexible testing, declare the monad transformers+-- of your application as instances of this class.+class (Monad m, Monad n) => MonadTLT m n | m -> n where+ -- |Lift TLT operations within a monad transformer stack. Note that+ -- with enough transformer types included in this class, the+ -- @liftTLT@ function should usually be unnecessary: the commands in+ -- this module which actually configure testing, or specify a test,+ -- already @liftTLT@ their own result. So they will all act as+ -- top-level transformers in @MonadTLT@.+ liftTLT :: TLT n a -> m a++instance Monad m => MonadTLT (TLT m) m where+ liftTLT = id++instance (MonadTLT m n, Functor f) => MonadTLT (FreeT f m) n where+ liftTLT = lift . liftTLT++instance MonadTLT m n => MonadTLT (IdentityT m) n where+ liftTLT = lift . liftTLT++instance MonadTLT m n => MonadTLT (MaybeT m) n where+ liftTLT = lift . liftTLT++instance MonadTLT m n => MonadTLT (ReaderT r m) n where+ liftTLT = lift . liftTLT++instance MonadTLT m n => MonadTLT (ResourceT m) n where+ liftTLT = lift . liftTLT++instance MonadTLT m n => MonadTLT (StateT s m) n where+ liftTLT = lift . liftTLT++instance MonadTLT m n => MonadTLT (SL.StateT s m) n where+ liftTLT = lift . liftTLT++instance MonadTLT m n => MonadTLT (STT s m) n where+ liftTLT = lift . liftTLT++instance (MonadTLT m n, Monoid w) => MonadTLT (WL.WriterT w m) n where+ liftTLT = lift . liftTLT++instance (MonadTLT m n, Monoid w) => MonadTLT (WS.WriterT w m) n where+ liftTLT = lift . liftTLT++{- ------------------------------------------------------------ -}++-- |Execute the tests specified in a `TLT` monad, and report the+-- results.+tlt :: MonadIO m => TLT m r -> m ()+tlt (TLT t) = do+ liftIO $ putStrLn "Running tests:"+ (_, (opts, resultsBuf)) <- runStateT t $ (defaultOpts, Top 0 0 [])+ liftIO $ report opts $ closeTRBuf resultsBuf++-- |This function controls whether `tlt` will report only tests which+-- fail, suppressing any display of tests which pass, or else report+-- the results of all tests. The default is the former: the idea is+-- that no news should be good news, with the programmer bothered only+-- with problems which need fixing.+reportAllTestResults :: MonadTLT m n => Bool -> m ()+reportAllTestResults b = liftTLT $ TLT $ do+ (opts, tr) <- get+ put $ (opts `withShowPasses` b, tr)++-- |This function controls whether `tlt` will exit after displaying+-- test results which include at least one failing test. By default,+-- it will exit in this situation. The idea is that a test suite can+-- be broken into parts when it makes sense to run the latter parts+-- only when the former parts all pass.+setExitAfterFailDisplay :: MonadTLT m n => Bool -> m ()+setExitAfterFailDisplay b = liftTLT $ TLT $ do+ (opts, tr) <- get+ put $ (opts `withExitAfterFail` b, tr)++-- |Report a failure. Useful in pattern-matching cases which are+-- entirely not expected.+tltFail :: MonadTLT m n => String -> String -> m ()+desc `tltFail` detail = liftTLT $ TLT $ do+ (opts, before) <- get+ let after = addResult before $ Test desc [Asserted detail]+ put (opts, after)++-- |Organize the tests in the given subcomputation as a separate group+-- within the test results we will report.+inGroup :: MonadTLT m n => String -> m a -> m a+inGroup name group = do+ (opts, before) <- liftTLT $ TLT get+ liftTLT $ TLT $ put $ (opts, Buf before 0 0 name [])+ result <- group+ (opts', after) <- liftTLT $ TLT $ get+ liftTLT $ TLT $ put $ (opts', popGroup after)+ return result++-- * Specifying individual tests++infix 0 ~:, ~::, ~::-++-- |Label and perform a test of an `Assertion`.+--+-- ===== Example+--+-- > test :: Monad m => TLT m ()+-- > test = do+-- > "2 is 2 as result" ~: 2 @== return 2 -- This test passes.+-- > "2 not 3" ~: 2 @/=- 3 -- This test fails.+(~:) :: MonadTLT m n => String -> Assertion m -> m ()+s ~: a = do+ (opts, oldState) <- liftTLT $ TLT $ get+ assessment <- a+ liftTLT $ TLT $ put (opts, addResult oldState $ Test s assessment)++-- |Label and perform a test of a (pure) boolean value.+--+-- ===== Example+--+-- > test :: Monad m => TLT m ()+-- > test = do+-- > "True passes" ~::- return True -- This test passes.+-- > "2 is 2 as single Bool" ~::- return (2 == 2) -- This test passes.+-- > "2 is 3!?" ~::- myFn 4 "Hammer" -- Passes if myFn (which+-- > -- must be monadic)+-- > -- returns True.+(~::-) :: MonadTLT m n => String -> Bool -> m ()+s ~::- b = do+ (opts, oldState) <- liftTLT $ TLT $ get+ liftTLT $ TLT $ put (opts, addResult oldState $ Test s $+ if b then [] else [Asserted $ "Expected True but got False"])++-- |Label and perform a test of a boolean value returned by a+-- computation in the wrapped monad @m@.+--+-- ===== Example+--+-- > test :: Monad m => TLT m ()+-- > test = do+-- > "True passes" ~::- True -- This test passes.+-- > "2 is 2 as single Bool" ~::- 2 == 2 -- This test passes.+-- > "2 is 3!?" ~::- 2 == 2 -- This test fails.+(~::) :: MonadTLT m n => String -> m Bool -> m ()+s ~:: bM = do+ b <- bM+ (opts, oldState) <- liftTLT $ TLT $ get+ liftTLT $ TLT $ put (opts, addResult oldState $ Test s $+ if b then [] else [Asserted $ "Expected True but got False"])++infix 1 @==, @/=, @<, @>, @<=, @>=+infix 1 @==-, @/=-, @<-, @>-, @<=-, @>=-++-- |Transform a binary function on an expected and an actual value+-- (plus a binary generator of a failure message) into an `Assertion`+-- for a pure given actual value.+--+-- ===== Example+--+-- TLT's scalar-testing operators like @\@==-@ are defined with this+-- function:+--+-- > (@==-) :: (Monad m, Eq a, Show a) => a -> a -> Assertion m+-- > (@==-) = liftAssertion2Pure (==) $+-- > \ exp actual -> "Expected " ++ show exp ++ " but got " ++ show actual+--+-- The `(==)` operator tests equality, and the result here allows the+-- assertion that a value should be exactly equal to a target. The+-- second argument formats the detail reported when the assertion+-- fails.+liftAssertion2Pure ::+ (Monad m) => (a -> a -> Bool) -> (a -> a -> String) -> a -> a -> Assertion m+liftAssertion2Pure tester explainer exp actual = return $+ if (tester exp actual) then [] else [Asserted $ explainer exp actual]++-- |Given an `Assertion` for two pure values (expected and actual),+-- lift it to an `Assertion` expecting the actual value to be returned+-- from a computation.+--+-- ===== Examples+--+-- The TLT assertion `(@==)` lifts `(@==-)` from expecting a pure+-- actual result to expecting a computation returning a value to test.+--+-- > (@==) :: (Monad m, Eq a, Show a) => a -> m a -> Assertion m+-- > (@==) = assertion2PtoM (@==-)+assertion2PtoM ::+ (Monad m) => (a -> a -> Assertion m) -> a -> m a -> Assertion m+assertion2PtoM pa exp actualM = do actual <- actualM+ pa exp actual++-- |Transform a binary function on expected and actual values (plus+-- a generator of a failure message) into an `Assertion` where the+-- actual value is to be returned from a subcomputation.+liftAssertion2M ::+ (Monad m) => (a -> a -> Bool) -> (a -> a -> String) -> a -> m a -> Assertion m+liftAssertion2M tester explainer exp actualM =+ let assertPure = liftAssertion2Pure tester explainer exp+ in do actual <- actualM+ assertPure actual++-- |Assert that two values are equal. This assertion takes an+-- expected and an actual /value/; see `(@==)` to compare the result+-- of a /monadic computation/ to an expected value.+--+-- ===== Examples+--+-- > test :: Monad m => TLT m ()+-- > test = do+-- > "Make sure that 2 is still equal to itself" ~: 2 @==- 2+-- > "Make sure that there are four lights" ~: 4 @==- length lights+(@==-) :: (Monad m, Eq a, Show a) => a -> a -> Assertion m+(@==-) = liftAssertion2Pure (==) $+ \ exp actual -> "Expected " ++ show exp ++ " but got " ++ show actual++-- |Assert that a calculated value is as expected. This assertion+-- compare the result of a /monadic computation/ to an expected value;+-- see `(@==-)` to compare an /actual value/ to the expected value.+--+-- ===== Examples+--+-- > test :: Monad m => TLT m ()+-- > test = do+-- > "Make sure that 2 is still equal to itself" ~: 2 @== return 2+-- > "Make sure that there are four lights" ~: 4 @== countLights+-- > -- where countLights :: m Int+(@==) :: (Monad m, Eq a, Show a) => a -> m a -> Assertion m+(@==) = assertion2PtoM (@==-)++-- |Assert that two values are not equal. This assertion takes an+-- expected and an actual /value/; see `(@/=)` to compare the result+-- of a /monadic computation/ to an expected value.+(@/=-) :: (Monad m, Eq a, Show a) => a -> a -> Assertion m+(@/=-) = liftAssertion2Pure (/=) $+ \ exp actual ->+ "Expected other than " ++ show exp ++ " but got " ++ show actual++-- |Assert that a calculated value differs from some known value.+-- This assertion compares the result of a /monadic computation/ to an+-- expected value; see `(@/=-)` to compare an /actual value/ to the+-- expected value.+(@/=) :: (Monad m, Eq a, Show a) => a -> m a -> Assertion m+(@/=) = assertion2PtoM (@/=-)++-- |Assert that a given boundary is strictly less than some value.+-- This assertion takes an expected and an actual /value/; see `(@<)`+-- to compare the result of a /monadic computation/ to an expected+-- value.+(@<-) :: (Monad m, Ord a, Show a) => a -> a -> Assertion m+(@<-) = liftAssertion2Pure (<) $+ \ exp actual ->+ "Lower bound (open) is " ++ show exp ++ " but got " ++ show actual++-- |Assert that a given, constant boundary is strictly less than some+-- calculated value. This assertion compares the result of a /monadic+-- computation/ to an expected value; see `(@<-)` to compare an+-- /actual value/ to the expected value.+(@<) :: (Monad m, Ord a, Show a) => a -> m a -> Assertion m+(@<) = assertion2PtoM (@<-)++-- |Assert that a given boundary is strictly less than some value.+-- This assertion takes an expected and an actual /value/; see `(@>)`+-- to compare the result of a /monadic computation/ to an expected+-- value.+(@>-) :: (Monad m, Ord a, Show a) => a -> a -> Assertion m+(@>-) = liftAssertion2Pure (>) $+ \ exp actual ->+ "Upper bound (open) is " ++ show exp ++ " but got " ++ show actual++-- |Assert that a given, constant boundary is strictly less than some+-- calculated value. This assertion compares the result of a /monadic+-- computation/ to an expected value; see `(@>-)` to compare an+-- /actual value/ to the expected value.+(@>) :: (Monad m, Ord a, Show a) => a -> m a -> Assertion m+(@>) = assertion2PtoM (@>-)++-- |Assert that a given boundary is strictly less than some value.+-- This assertion takes an expected and an actual /value/; see `(@<=)`+-- to compare the result of a /monadic computation/ to an expected+-- value.+(@<=-) :: (Monad m, Ord a, Show a) => a -> a -> Assertion m+(@<=-) = liftAssertion2Pure (<=) $+ \ exp actual ->+ "Lower bound (closed) is " ++ show exp ++ " but got " ++ show actual++-- |Assert that a given, constant boundary is strictly less than some+-- calculated value. This assertion compares the result of a /monadic+-- computation/ to an expected value; see `(@<=-)` to compare an+-- /actual value/ to the expected value.+(@<=) :: (Monad m, Ord a, Show a) => a -> m a -> Assertion m+(@<=) = assertion2PtoM (@<=-)++-- |Assert that a given boundary is strictly less than some value.+-- This assertion takes an expected and an actual /value/; see `(@>=)`+-- to compare the result of a /monadic computation/ to an expected+-- value.+(@>=-) :: (Monad m, Ord a, Show a) => a -> a -> Assertion m+(@>=-) = liftAssertion2Pure (>=) $+ \ exp actual ->+ "Upper bound (closed) is " ++ show exp ++ " but got " ++ show actual++-- |Assert that a given, constant boundary is strictly less than some+-- calculated value. This assertion compares the result of a /monadic+-- computation/ to an expected value; see `(@>=-)` to compare an+-- /actual value/ to the expected value.+(@>=) :: (Monad m, Ord a, Show a) => a -> m a -> Assertion m+(@>=) = assertion2PtoM (@>=-)++-- |This assertion always fails with the given message.+assertFailed :: Monad m => String -> Assertion m+assertFailed msg = return [Asserted msg]++-- |This assertion always succeeds.+assertSuccess :: Monad m => Assertion m+assertSuccess = return []++-- |Transform a unary function on a value (plus a generator of a+-- failure message) into a unary function returning an `Assertion` for+-- a pure given actual value.+--+-- ===== Example+--+-- The TLT assertion `emptyP` is built from the `Traversable` predicate+-- `null`+--+-- > emptyP :: (Monad m, Traversable t) => t a -> Assertion m+-- > emptyP = liftAssertionPure null+-- > (\ _ -> "Expected empty structure but got non-empty")++liftAssertionPure ::+ (Monad m) => (a -> Bool) -> (a -> String) -> a -> Assertion m+liftAssertionPure tester explainer actual = return $+ if (tester actual) then [] else [Asserted $ explainer actual]++-- |Given an `Assertion` for a pure (actual) value, lift it to an+-- `Assertion` expecting the value to be returned from a computation.+--+-- ===== Example+--+-- The TLT assertion `empty` on monadic computations returning lists+-- is defined in terms of the corresponging assertion on pure+-- list-valued expressions.+--+-- > empty :: (Monad m, Traversable t) => m (t a) -> Assertion m+-- > empty = assertionPtoM emptyP+assertionPtoM :: (Monad m) => (a -> Assertion m) -> m a -> Assertion m+assertionPtoM pa actualM = do actual <- actualM+ pa actual++-- |Transform a unary function on an actual value (plus a generator of+-- a failure message) into an `Assertion` where the value is to be+-- returned from a subcomputation.+liftAssertionM ::+ (Monad m) => (a -> Bool) -> (a -> String) -> m a -> Assertion m+liftAssertionM tester explainer actualM =+ let assertPure = liftAssertionPure tester explainer+ in do actual <- actualM+ assertPure actual++-- |Assert that a pure traversable structure (such as a list) is+-- empty.+emptyP :: (Monad m, Traversable t) => t a -> Assertion m+emptyP = liftAssertionPure null+ (\ _ -> "Expected empty structure but got non-empty")++-- |Assert that a traversable structure (such as a list) returned from+-- a computation is empty.+empty :: (Monad m, Traversable t) => m (t a) -> Assertion m+empty = assertionPtoM emptyP++-- |Assert that a pure traversable structure (such as a list) is+-- nonempty.+nonemptyP :: (Monad m, Traversable t) => t a -> Assertion m+nonemptyP = liftAssertionPure (not . null)+ (\ _ -> "Expected non-empty structure but got empty")++-- |Assert that a traversable structure (such as a list) returned from+-- a computation is non-empty.+nonempty :: (Monad m, Traversable t) => m (t a) -> Assertion m+nonempty = assertionPtoM nonemptyP++-- |Assert that a `Maybe` value is `Nothing`.+nothingP :: Monad m => Maybe a -> Assertion m+nothingP = liftAssertionPure isNothing+ (\ _ -> "Expected empty Maybe value but got non-Nothing")++-- |Assert that a `Maybe` result ofa computation is `Nothing`.+nothing :: Monad m => m (Maybe a) -> Assertion m+nothing = assertionPtoM nothingP
+ test/Passing.hs view
@@ -0,0 +1,84 @@++{-# LANGUAGE FlexibleInstances #-}+{-# LANGUAGE MultiParamTypeClasses #-}+{-# LANGUAGE UndecidableInstances #-}++import Test.TLT+import Control.Monad.Trans.Identity+import Control.Monad.Trans++main :: IO ()+main = do+ tlt test+ tlt ttest++test :: Monad m => TLT m ()+test = do+ "True passes" ~::- True+ "2 is 2 as single Bool" ~::- 2 == 2+ inGroup "== assertions" $ do+ inGroup "pure" $ do+ "2 is 2 as pure assertion" ~: 2 @==- 2+ inGroup "monadic" $ do+ "2 is 2 as result" ~: 2 @== return 2+ inGroup "/= pure assertions" $ do+ "2 not 3" ~: 2 @/=- 3+ "2 not 4" ~: 2 @/=- 4+ "2 not 3 as result" ~: 2 @/= return 3++newtype Monad m => M1T m a = M1T { unwrap1 :: IdentityT m a }+runM1T :: Monad m => M1T m a -> m a+runM1T = runIdentityT . unwrap1+newtype Monad m => M2T m a = M2T { unwrap2 :: IdentityT m a }+runM2T :: Monad m => M2T m a -> m a+runM2T = runIdentityT . unwrap2++instance Monad m => Functor (M1T m) where+ fmap f (M1T m) = M1T $ do+ v <- m+ return $ f v+instance Monad m => Applicative (M1T m) where+ pure v = M1T $ pure v+ (M1T m1) <*> (M1T m2) = M1T $ do+ f <- m1+ v <- m2+ return (f v)+instance Monad m => Monad (M1T m) where+ (M1T m) >>= f = M1T $ m >>= (unwrap1 . f)+ (M1T m1) >> (M1T m2) = M1T $ m1 >> m2+ return v = M1T $ return v+instance MonadTrans M1T where lift = M1T . lift++instance Monad m => Functor (M2T m) where+ fmap f (M2T m) = M2T $ do+ v <- m+ return $ f v+instance Monad m => Applicative (M2T m) where+ pure v = M2T $ pure v+ (M2T m1) <*> (M2T m2) = M2T $ do+ f <- m1+ v <- m2+ return (f v)+instance Monad m => Monad (M2T m) where+ (M2T m) >>= f = M2T $ m >>= (unwrap2 . f)+ (M2T m1) >> (M2T m2) = M2T $ m1 >> m2+ return v = M2T $ return v+instance MonadTrans M2T where lift = M2T . lift++instance MonadTLT m n => MonadTLT (M1T m) n where+ liftTLT = lift . liftTLT+instance MonadTLT m n => MonadTLT (M2T m) n where+ liftTLT = lift . liftTLT++ttest = do+ runM1T $ inGroup "M1T tests" $ m1tests+ runM2T $ inGroup "M2T tests" $ m2tests++m1tests = M1T $ do+ "3 is 3 as pure assertion" ~: 3 @==- 3+ "4 is 4 as pure assertion" ~: 4 @==- 4++m2tests = M2T $ do+ "5 is 5 as pure assertion" ~: 5 @==- 5+ "6 is 6 as pure assertion" ~: 6 @==- 6+