haskell-bee-tests (empty) → 0.1.0.0
raw patch · 6 files changed
+1578/−0 lines, 6 filesdep +aesondep +basedep +containers
Dependencies added: aeson, base, containers, haskell-bee, hedis, hspec, postgresql-simple, random-strings, stm, tasty, tasty-hspec, text
Files
- LICENSE +661/−0
- README.md +5/−0
- haskell-bee-tests.cabal +98/−0
- tests/Test/Integration/Broker.hs +154/−0
- tests/Test/Integration/Utils.hs +109/−0
- tests/Test/Integration/Worker.hs +551/−0
+ LICENSE view
@@ -0,0 +1,661 @@+ GNU AFFERO GENERAL PUBLIC LICENSE+ Version 3, 19 November 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU Affero General Public License is a free, copyleft license for+software and other kinds of works, specifically designed to ensure+cooperation with the community in the case of network server software.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+our General Public Licenses are 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.++ 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.++ Developers that use our General Public Licenses protect your rights+with two steps: (1) assert copyright on the software, and (2) offer+you this License which gives you legal permission to copy, distribute+and/or modify the software.++ A secondary benefit of defending all users' freedom is that+improvements made in alternate versions of the program, if they+receive widespread use, become available for other developers to+incorporate. Many developers of free software are heartened and+encouraged by the resulting cooperation. However, in the case of+software used on network servers, this result may fail to come about.+The GNU General Public License permits making a modified version and+letting the public access it on a server without ever releasing its+source code to the public.++ The GNU Affero General Public License is designed specifically to+ensure that, in such cases, the modified source code becomes available+to the community. It requires the operator of a network server to+provide the source code of the modified version running there to the+users of that server. Therefore, public use of a modified version, on+a publicly accessible server, gives the public access to the source+code of the modified version.++ An older license, called the Affero General Public License and+published by Affero, was designed to accomplish similar goals. This is+a different license, not a version of the Affero GPL, but Affero has+released a new version of the Affero GPL which permits relicensing under+this license.++ 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.++ Notwithstanding any other provision of this License, if you modify the+Program, your modified version must prominently offer all users+interacting with it remotely through a computer network (if your version+supports such interaction) an opportunity to receive the Corresponding+Source of your version by providing access to the Corresponding Source+from a network server at no charge, through some standard or customary+means of facilitating copying of software. This Corresponding Source+shall include the Corresponding Source for any work covered by version 3+of the GNU General Public License that is incorporated pursuant to the+following paragraph.++ 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 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 work with which it is combined will remain governed by version+3 of the GNU General Public License.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.++ You should have received a copy of the GNU Affero General Public License+ along with this program. If not, see <http://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If your software can interact with users remotely through a computer+network, you should also make sure that it provides a way for users to+get its source. For example, if your program is a web application, its+interface could display a "Source" link that leads users to an archive+of the code. There are many ways you could offer source, and different+solutions will be better for different programs; see section 13 for the+specific requirements.++ 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 AGPL, see+<http://www.gnu.org/licenses/>.
+ README.md view
@@ -0,0 +1,5 @@+# haskell-bee-tests++Generic tests for [haskell-bee](https://github.com/garganscript/haskell-bee).++This package provides a reusable test suite for any `Broker` implementation. The tests are broker-agnostic and must be integrated into specific broker packages. See [`haskell-bee-pgmq`](https://github.com/garganscript/haskell-bee/tree/master/haskell-bee-pgmq) for an example of how to use these tests in your own broker implementation.
+ haskell-bee-tests.cabal view
@@ -0,0 +1,98 @@+cabal-version: 3.4+-- The cabal-version field refers to the version of the .cabal specification,+-- and can be different from the cabal-install (the tool) version and the+-- Cabal (the library) version you are using. As such, the Cabal (the library)+-- version used must be equal or greater than the version stated in this field.+-- Starting from the specification version 2.2, the cabal-version field must be+-- the first thing in the cabal file.++-- Initial package description 'haskell-bee' generated by+-- 'cabal init'. For further documentation, see:+-- http://haskell.org/cabal/users-guide/+--+-- The name of the package.+name: haskell-bee-tests++-- The package version.+-- See the Haskell package versioning policy (PVP) for standards+-- guiding when and how versions should be incremented.+-- https://pvp.haskell.org+-- PVP summary: +-+------- breaking API changes+-- | | +----- non-breaking API additions+-- | | | +--- code changes with no API change+version: 0.1.0.0++-- A short (one-line) description of the package.+synopsis: Reusable test suite for any haskell-bee Broker implementation+ +-- Extra doc files to be distributed with the package, such as a CHANGELOG or a README.+extra-doc-files: README.md++-- A longer description of the package.+description: + Please see the README on GitHub at <https://github.com/garganscript/haskell-bee/blob/master/haskell-bee/README.md>+ +-- URL for the project homepage or repository.+homepage: https://gitlab.iscpif.fr/gargantext/haskell-bee++-- The license under which the package is released.+license: AGPL-3.0-or-later++-- The file containing the license text.+license-file: LICENSE++-- The package author(s).+author: Gargantext++-- An email address to which users can send suggestions, bug reports, and patches.+maintainer: gargantext@iscpif.fr++-- A copyright notice.+-- copyright:+category: Concurrency+build-type: Simple++-- Extra source files to be distributed with the package, such as examples, or a tutorial module.+-- extra-source-files:++common warnings+ ghc-options: -Wall++library+ -- Import common warning flags.+ import: warnings+ + exposed-modules: Test.Integration.Broker+ , Test.Integration.Utils+ , Test.Integration.Worker+ + build-depends: base >=4.17.2.0 && < 5+ , aeson >= 2.1 && < 2.3+ , containers >= 0.6 && < 0.8+ , hedis >= 0.15.2 && < 0.16+ , hspec >= 2.11 && < 3+ , postgresql-simple >= 0.6 && < 0.8+ , random-strings == 0.1.1.0+ , stm >= 2.5.3 && < 3+ , tasty >= 1.5 && < 1.6+ , tasty-hspec >= 1.2.0 && < 2+ , text >= 1.2 && < 2.2+ + , haskell-bee ^>= 0.1.0.0++ -- Directories containing source files.+ hs-source-dirs: tests++ -- Base language which the package is written in.+ default-language: Haskell2010++ default-extensions:+ DeriveGeneric+ DuplicateRecordFields+ GeneralizedNewtypeDeriving+ ImportQualifiedPost+ NamedFieldPuns+ OverloadedStrings+ RecordWildCards++ ghc-options: -threaded
+ tests/Test/Integration/Broker.hs view
@@ -0,0 +1,154 @@+{-|+ Generic Broker tests. All brokers should satisfy them.+-}++{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE ScopedTypeVariables #-}++module Test.Integration.Broker+ ( Message(..)+ + , brokerTests )+where++import Async.Worker.Broker.Types qualified as BT+import Control.Exception (bracket)+import Data.Aeson (ToJSON(..), FromJSON(..), withText)+import Data.Maybe (isJust)+import Data.Text qualified as T+import Test.Hspec+import Test.Integration.Utils (randomQueueName, waitUntil)+import Test.RandomStrings (randomASCII, randomString, onlyAlphaNum)+++data TestEnv b =+ TestEnv { broker :: BT.Broker b Message+ , queue :: BT.Queue }++testQueuePrefix :: BT.Queue+testQueuePrefix = "test_broker"+++data Message =+ Message { text :: String }+ deriving (Show, Eq)+instance ToJSON Message where+ toJSON (Message { text }) = toJSON text+instance FromJSON Message where+ parseJSON = withText "Message" $ \text -> do+ pure $ Message { text = T.unpack text }+++withBroker :: (BT.MessageBroker b Message)+ => BT.BrokerInitParams b Message+ -> (TestEnv b -> IO ())+ -> IO ()+withBroker bInitParams = bracket (setUpBroker bInitParams) tearDownBroker+ where+ -- NOTE I need to pass 'b' again, otherwise GHC can't infer the+ -- type of 'b' (even with 'ScopedTypeVariables' turned on)+ setUpBroker :: (BT.MessageBroker b Message)+ => BT.BrokerInitParams b Message -> IO (TestEnv b)+ setUpBroker bInit = do+ b <- BT.initBroker bInit++ queue <- randomQueueName testQueuePrefix+ BT.dropQueue b queue+ BT.createQueue b queue+ + return $ TestEnv { broker = b+ , queue }++ tearDownBroker (TestEnv { broker, queue }) = do+ BT.dropQueue broker queue+ BT.deinitBroker broker+++brokerTests :: (BT.MessageBroker b Message)+ => BT.BrokerInitParams b Message -> Spec+brokerTests bInitParams =+ parallel $ around (withBroker bInitParams) $ describe "Broker tests" $ do+ it "can send and receive a message" $ \(TestEnv { broker, queue }) -> do+ let msg = Message { text = "test" }+ msgId <- BT.sendMessage broker queue (BT.toMessage msg)+ msg2 <- BT.readMessageWaiting broker queue+ -- putStrLn $ "[messageId] " <> show (BT.messageId msg2)+ msg `shouldBe` BT.toA (BT.getMessage msg2)+ msgId `shouldBe` BT.messageId msg2++ it "can send, archive and read message from archive" $ \(TestEnv { broker, queue }) -> do+ let msg = Message { text = "test" }+ msgId <- BT.sendMessage broker queue (BT.toMessage msg)+ msg2 <- BT.readMessageWaiting broker queue+ msgId `shouldBe` BT.messageId msg2+ BT.archiveMessage broker queue msgId+ -- It might take some time to archive a message so we wait a bit+ waitUntil (isJust <$> BT.getArchivedMessage broker queue msgId) 200+ msgArchive <- BT.getArchivedMessage broker queue msgId+ let msgIdArchive = BT.messageId <$> msgArchive+ msgIdArchive `shouldBe` Just msgId++ it "returns correct message id when sending message to broker" $ \(TestEnv { broker, queue }) -> do+ let iter = [1..20] :: [Int] -- number of steps+ mapM_ (\_i -> do+ -- Generate random strings and make sure that the+ -- message ids we get from sendMessage match our data+ text <- randomString (onlyAlphaNum randomASCII) 20+ let msg = Message { text }+ msgId <- BT.sendMessage broker queue (BT.toMessage msg)+ bMsg <- BT.readMessageWaiting broker queue+ msg `shouldBe` BT.toA (BT.getMessage bMsg)+ msgId `shouldBe` BT.messageId bMsg+ BT.deleteMessage broker queue msgId+ ) iter++ it "preserves msgId when archiving a message" $ \(TestEnv { broker, queue }) -> do+ let iter = [1..20] :: [Int] -- number of steps+ mapM_ (\_i -> do+ -- Generate random strings and make sure that the+ -- message ids we get from sendMessage match our data+ text <- randomString (onlyAlphaNum randomASCII) 20+ let msg = Message { text }+ msgId <- BT.sendMessage broker queue (BT.toMessage msg)+ BT.archiveMessage broker queue msgId+ msgArchive <- BT.getArchivedMessage broker queue msgId+ Just msg `shouldBe` (BT.toA . BT.getMessage <$> msgArchive)+ ) iter++ it "returns the same size of pending messages as 'getQueueSize'" $ \(TestEnv { broker, queue }) -> do+ let numSteps = 20 :: Int+ let iter = [1..numSteps] :: [Int] -- number of steps+ mapM_ (\i -> do+ -- Generate random strings and make sure that the+ -- message ids we get from sendMessage match our data+ text <- randomString (onlyAlphaNum randomASCII) 20+ let msg = Message { text }+ msgId <- BT.sendMessage broker queue (BT.toMessage msg)+ qs <- BT.getQueueSize broker queue+ qs `shouldBe` i+ msgIds <- BT.listPendingMessageIds broker queue+ length msgIds `shouldBe` qs+ msgIds `shouldSatisfy` (elem msgId)+ ) iter++ msgIds <- BT.listPendingMessageIds broker queue+ let timeoutS = 10 -- some large enough value++ -- after message timeout is set, it shouldn't be counted+ mapM_ (\msgId -> do+ BT.setMessageTimeout broker queue msgId timeoutS+ msgIds' <- BT.listPendingMessageIds broker queue+ msgIds' `shouldSatisfy` (not . elem msgId)+ ) msgIds++ -- queue should be "empty" since all messages are timed out+ qs <- BT.getQueueSize broker queue+ qs `shouldBe` 0++ it "can get message by it's id (from queue)" $ \(TestEnv { broker, queue }) -> do+ text <- randomString (onlyAlphaNum randomASCII) 20+ let msg = Message { text }+ msgId <- BT.sendMessage broker queue (BT.toMessage msg)+ mMsg <- BT.getMessageById broker queue msgId+ (BT.toA . BT.getMessage <$> mMsg) `shouldBe` (Just msg)
+ tests/Test/Integration/Utils.hs view
@@ -0,0 +1,109 @@+{-# LANGUAGE OverloadedStrings #-}++module Test.Integration.Utils+ ( randomQueueName+ , waitUntil+ , waitUntilTVarEq+ , waitUntilTVarPred+ , waitUntilQueueSizeIs+ , waitUntilQueueEmpty )+where++import Async.Worker.Broker qualified as B+import Control.Concurrent (threadDelay)+import Control.Concurrent.STM.TVar (TVar, readTVarIO)+import Control.Monad (unless)+import Data.Maybe (fromMaybe)+import Data.String (fromString)+import System.Environment (lookupEnv)+import System.Timeout qualified as Timeout+import Test.Hspec (expectationFailure, shouldBe, shouldSatisfy, Expectation, HasCallStack)+import Test.RandomStrings (randomASCII, randomString, onlyLower)++++-- | Timeout for 'wait' jobs, in ms.+newtype TimeoutMs = TimeoutMs Int+ deriving (Eq, Show, Num, Integral, Real, Enum, Ord)+++-- | Given a queue prefix, add a random suffix to create a queue name+randomQueueName :: B.Queue -> IO B.Queue+randomQueueName prefix = do+ postfix <- fromString <$> randomString (onlyLower randomASCII) 10+ return $ prefix <> "_" <> postfix+++waitThreadDelay :: Int+waitThreadDelay = 50 * 1000++-- | Given a predicate IO action, test it for given number of+-- milliseconds or fail+waitUntil :: HasCallStack => IO Bool -> TimeoutMs -> Expectation+waitUntil pred' (TimeoutMs timeoutMs) = do+ _mTimeout <- Timeout.timeout (timeoutMs * 1000) performTest+ -- shortcut for testing mTimeout+ p <- pred'+ unless p (expectationFailure "Predicate test failed")+ + where+ performTest = do+ p <- pred'+ if p+ then return ()+ else do+ threadDelay waitThreadDelay+ performTest++-- | Similar to 'waitUntil' but specialized to 'TVar' equality checking+waitUntilTVarEq :: (HasCallStack, Show a, Eq a) => TVar a -> a -> TimeoutMs -> Expectation+waitUntilTVarEq tvar expected (TimeoutMs timeoutMs) = do+ _mTimeout <- Timeout.timeout (timeoutMs * 1000) performTest+ -- shortcut for testing mTimeout+ val <- readTVarIO tvar+ val `shouldBe` expected+ + where+ performTest = do+ val <- readTVarIO tvar+ if val == expected+ then return ()+ else do+ threadDelay waitThreadDelay+ performTest++-- | Similar to 'waitUntilTVarEq' but with predicate checking+waitUntilTVarPred :: (HasCallStack, Show a) => TVar a -> (a -> Bool) -> TimeoutMs -> Expectation+waitUntilTVarPred tvar predicate (TimeoutMs timeoutMs) = do+ _mTimeout <- Timeout.timeout (timeoutMs * 1000) performTest+ -- shortcut for testing mTimeout+ val <- readTVarIO tvar+ val `shouldSatisfy` predicate+ + where+ performTest = do+ val <- readTVarIO tvar+ if predicate val+ then return ()+ else do+ threadDelay waitThreadDelay+ performTest++waitUntilQueueSizeIs :: (B.MessageBroker b a) => B.Broker b a -> B.Queue -> Int -> TimeoutMs -> Expectation+waitUntilQueueSizeIs b queue size (TimeoutMs timeoutMs) = do+ _mTimeout <- Timeout.timeout (timeoutMs * 1000) performTest++ qSize <- B.getQueueSize b queue+ qSize `shouldBe` size++ where+ performTest = do+ qSize <- B.getQueueSize b queue+ if qSize == size+ then return ()+ else do+ threadDelay waitThreadDelay+ performTest++waitUntilQueueEmpty :: (B.MessageBroker b a) => B.Broker b a -> B.Queue -> TimeoutMs -> Expectation+waitUntilQueueEmpty b queue timeoutMs = waitUntilQueueSizeIs b queue 0 timeoutMs
+ tests/Test/Integration/Worker.hs view
@@ -0,0 +1,551 @@+{-|+ Generic Worker tests.++ TODO Add tests for which there are multiple workers in the same+ queue.+-}++{-# LANGUAGE AllowAmbiguousTypes #-}+{-# LANGUAGE FlexibleContexts #-}+{-# LANGUAGE MonoLocalBinds #-} -- TODO can remove this if 'Show a' is removed from 'HasWorkerBroker'+{-# LANGUAGE ScopedTypeVariables #-}++module Test.Integration.Worker+ ( Message(..)+ + , workerTests+ , multiWorkerTests )+where++import Async.Worker (run, mkDefaultSendJob, mkDefaultSendJob', sendJob', errStrat, toStrat, resendOnKill, KillWorkerSafely(..))+import Async.Worker.Broker.Types qualified as BT+import Async.Worker.Types+import Control.Concurrent (forkIO, killThread, threadDelay, ThreadId, throwTo)+import Control.Concurrent.STM (atomically)+import Control.Concurrent.STM.TVar (readTVarIO, newTVarIO, TVar, modifyTVar)+import Control.Exception (bracket, Exception, throwIO)+import Control.Monad (void)+import Data.Aeson (ToJSON, FromJSON)+import Data.Maybe (fromJust, isJust)+import Data.Set qualified as Set+import GHC.Generics (Generic)+import Test.Hspec+import Test.Integration.Utils (randomQueueName, waitUntil, waitUntilTVarEq, waitUntilTVarPred, waitUntil, waitUntilQueueEmpty)+++data TestEnv b =+ TestEnv { state :: State b Message+ , events :: TVar [Event]+ , threadId :: ThreadId+ , brokerInitParams :: BT.BrokerInitParams b (Job Message)+ -- | a separate broker so that we use separate connection from the worker+ , broker :: BT.Broker b (Job Message)+ , queueName :: BT.Queue+ }+++testQueuePrefix :: BT.Queue+testQueuePrefix = "test_worker"+++-- | Messages that we will send to worker via the broker (i.e. jobs)+data Message =+ Message { text :: String }+ | Error+ | Timeout { delay :: Int }+ deriving (Show, Eq, Ord, Generic)+instance ToJSON Message+instance FromJSON Message+-- instance ToJSON Message where+-- toJSON (Message { text }) = toJSON $ object [ "type" .= ("Message" :: String), "text" .= text ]+-- toJSON Error = toJSON $ object [ "type" .= ("Error" :: String) ]+-- toJSON (Timeout { delay }) = toJSON $ object [ "type" .= ("Timeout" :: String), "delay" .= delay ]+-- instance FromJSON Message where+-- parseJSON = withObject "Message" $ \o -> do+-- type_ <- o .: "type"+-- case type_ of+-- "Message" -> do+-- text <- o .: "text"+-- pure $ Message { text }+-- "Error" -> pure Error+-- "Timeout" -> do+-- delay <- o .: "delay"+-- pure $ Timeout { delay }+-- _ -> fail $ "Unknown type " <> type_+++-- | We will handle job events from the worker to track what and how+-- was processed+data Event =+ EMessageReceived Message+ | EJobFinished Message+ | EJobTimeout Message+ | EJobError Message+ | EWorkerKilledSafely (Maybe Message)+ deriving (Eq, Show, Ord)+++data SimpleException = SimpleException String+ deriving Show+instance Exception SimpleException+++-- | Perform Action for this worker+pa :: (HasWorkerBroker b Message) => State b Message -> BT.BrokerMessage b (Job Message) -> IO ()+pa _state bm = do+ let job' = BT.toA $ BT.getMessage bm+ case job job' of+ Message { text = _text } -> return () -- putStrLn text+ Error -> throwIO $ SimpleException "Error!"+ Timeout { delay } -> threadDelay (delay * second)++pushEvent :: BT.MessageBroker b (Job Message)+ => TVar [Event]+ -> (Message -> Event)+ -> BT.BrokerMessage b (Job Message)+ -> IO ()+pushEvent events evt bm = atomically $ modifyTVar events (\e -> e ++ [evt $ job $ BT.toA $ BT.getMessage bm])++pushEventMMsg :: BT.MessageBroker b (Job Message)+ => TVar [Event]+ -> (Maybe Message -> Event)+ -> Maybe (BT.BrokerMessage b (Job Message))+ -> IO ()+pushEventMMsg events evt mbm = atomically $ modifyTVar events (\e -> e ++ [evt $ job <$> BT.toA <$> BT.getMessage <$> mbm])+++initState :: (HasWorkerBroker b Message)+ => BT.BrokerInitParams b (Job Message)+ -> TVar [Event]+ -> BT.Queue+ -> String+ -> IO (State b Message, ThreadId)+initState bInitParams events queue workerName = do+ let pushEvt evt _s = pushEvent events evt++ b' <- BT.initBroker bInitParams+ let state = State { broker = b'+ , queueName = queue+ , name = workerName <> " for " <> BT.renderQueue queue+ , performAction = pa+ , onMessageReceived = Just (pushEvt EMessageReceived)+ , onJobFinish = Just (pushEvt EJobFinished)+ , onJobTimeout = Just (pushEvt EJobTimeout)+ , onJobError = Just (\_s bm _exc -> pushEvent events EJobError bm)+ , onWorkerKilledSafely = Just (const $ pushEventMMsg events EWorkerKilledSafely) }++ threadId <- forkIO $ run state++ pure (state, threadId)+++withWorker :: (HasWorkerBroker b Message)+ => BT.BrokerInitParams b (Job Message)+ -> (TestEnv b -> IO ())+ -> IO ()+withWorker brokerInitParams = bracket (setUpWorker brokerInitParams) tearDownWorker+ where+ -- NOTE I need to pass 'b' again, otherwise GHC can't infer the+ -- type of 'b' (even with 'ScopedTypeVariables' turned on)+ setUpWorker :: (HasWorkerBroker b Message)+ => BT.BrokerInitParams b (Job Message)+ -> IO (TestEnv b)+ setUpWorker bInitParams = do+ b <- BT.initBroker bInitParams++ queue <- randomQueueName testQueuePrefix+ + BT.dropQueue b queue+ BT.createQueue b queue++ events <- newTVarIO []++ (state, threadId) <- initState bInitParams events queue "test worker"+ + return $ TestEnv { state+ , events+ , threadId+ , brokerInitParams = bInitParams+ , broker = b+ , queueName = queue }++ tearDownWorker :: (HasWorkerBroker b Message)+ => TestEnv b+ -> IO ()+ tearDownWorker (TestEnv { broker = b, queueName, state = State { broker = b' }, threadId }) = do+ killThread threadId+ BT.deinitBroker b'+ BT.dropQueue b queueName+ BT.deinitBroker b+++-- | Single 'Worker' tests, abstracting the 'Broker' away.+workerTests :: (HasWorkerBroker b Message)+ => BT.BrokerInitParams b (Job Message)+ -> Spec+workerTests brokerInitParams =+ parallel $ around (withWorker brokerInitParams) $ describe "Worker tests" $ do+ it "can process a simple job" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0+ + let text = "simple test"+ let msg = Message { text }+ let job = mkDefaultSendJob' broker queueName msg+ void $ sendJob' job+ + waitUntilTVarEq events [ EMessageReceived msg, EJobFinished msg ] 500++ -- queue should be empty+ waitUntilQueueEmpty broker queueName 100++ it "can handle a job with error" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ let msg = Error+ let job = mkDefaultSendJob' broker queueName msg+ void $ sendJob' job+ + waitUntilTVarEq events [ EMessageReceived msg, EJobError msg ] 500++ -- queue should be empty (error jobs archived by default)+ waitUntilQueueEmpty broker queueName 100++ it "can handle a job with error (with archive)" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ let msg = Error+ let job = (mkDefaultSendJob' broker queueName msg) { errStrat = ESDelete }+ void $ sendJob' job+ + waitUntilTVarEq events [ EMessageReceived msg, EJobError msg ] 500++ -- queue should be empty (error job deleted)+ waitUntilQueueEmpty broker queueName 100++ it "can handle a job with error (with repeat n)" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ let msg = Error+ let job = (mkDefaultSendJob' broker queueName msg) { errStrat = ESRepeatNElseArchive 1 }+ void $ sendJob' job+ + waitUntilTVarEq events [ EMessageReceived msg, EJobError msg+ , EMessageReceived msg, EJobError msg ] 500++ -- queue should be empty (error job archived)+ waitUntilQueueEmpty broker queueName 100++ it "can handle a job with timeout (archive strategy)" $ \(TestEnv { broker, queueName, events}) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ let msg = Timeout { delay = 2 }+ let job' = (mkDefaultSendJob broker queueName msg 1) { toStrat = TSArchive }+ msgId <- sendJob' job'++ waitUntilTVarEq events [ EMessageReceived msg, EJobTimeout msg ] 1200++ -- There might be a slight delay before the message is archived+ -- (handling exception step in the thread)+ waitUntil (isJust <$> BT.getArchivedMessage broker queueName msgId) 100++ -- The archive should contain our message+ mMsgArchive <- BT.getArchivedMessage broker queueName msgId+ mMsgArchive `shouldSatisfy` isJust+ let msgArchive = fromJust mMsgArchive+ job (BT.toA $ BT.getMessage msgArchive) `shouldBe` msg++ -- Queue should be empty, since we archive timed out jobs+ waitUntilQueueEmpty broker queueName 100++ it "can handle a job with timeout (delete strategy)" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ let msg = Timeout { delay = 2 }+ let job = (mkDefaultSendJob broker queueName msg 1) { toStrat = TSDelete }+ void $ sendJob' job+ + waitUntilTVarEq events [ EMessageReceived msg, EJobTimeout msg ] 1200++ -- Queue should be empty, since we archive timed out jobs+ waitUntilQueueEmpty broker queueName 100++ it "can handle a job with timeout (repeat strategy)" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ let msg = Timeout { delay = 2 }+ let job = (mkDefaultSendJob broker queueName msg 1) { toStrat = TSRepeat }+ void $ sendJob' job+ + waitUntilTVarPred events (\evts -> ((EMessageReceived msg) `elem` evts)+ && ((EJobTimeout msg) `elem` evts)) 2500++ -- NOTE It doesn't make sense to check queue size here, the+ -- worker just continues to run the errored task in background+ -- and currently there is no way to stop it. Maybe implementing+ -- a custom test queue could help us here.++ it "can handle a job with timeout (repeat N times, then archive strategy)" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ let msg = Timeout { delay = 2 }+ let job = (mkDefaultSendJob broker queueName msg 1) { toStrat = TSRepeatNElseArchive 1 }+ void $ sendJob' job+ + -- | Should have been run 2 times, then archived+ waitUntilTVarEq events [ EMessageReceived msg, EJobTimeout msg+ , EMessageReceived msg, EJobTimeout msg ] 2500++ -- Queue should be empty, since we archive timed out jobs+ waitUntilQueueEmpty broker queueName 100++ it "can handle a job with timeout (repeat N times, then delete strategy)" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ let msg = Timeout { delay = 2 }+ let job = (mkDefaultSendJob broker queueName msg 1) { toStrat = TSRepeatNElseDelete 1 }+ void $ sendJob' job+ + -- | Should have been run 2 times, then archived+ waitUntilTVarEq events [ EMessageReceived msg, EJobTimeout msg+ , EMessageReceived msg, EJobTimeout msg ] 2500++ -- Queue should be empty, since we deleted timed out jobs+ waitUntilQueueEmpty broker queueName 100++ it "can process two jobs" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0+ + let text1 = "simple test 1"+ let msg1 = Message { text = text1 }+ let job1 = mkDefaultSendJob' broker queueName msg1+ void $ sendJob' job1+ let text2 = "simple test 2"+ let msg2 = Message { text = text2 }+ let job2 = mkDefaultSendJob' broker queueName msg2+ void $ sendJob' job2+ + -- The jobs don't have to be process exactly in this order so we just use Set here+ waitUntilTVarPred events (+ \e -> Set.fromList e == Set.fromList + [ EMessageReceived msg1, EJobFinished msg1+ , EMessageReceived msg2, EJobFinished msg2 ]) 500++ -- queue should be empty+ waitUntilQueueEmpty broker queueName 100++ it "after job with error, continue with another one" $ \(TestEnv { broker, queueName, events }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ let msgErr = Error+ let jobErr = mkDefaultSendJob' broker queueName msgErr+ void $ sendJob' jobErr+ let text = "simple test"+ let msg = Message { text }+ let job = mkDefaultSendJob' broker queueName msg+ void $ sendJob' job+ + waitUntilTVarPred events (+ \e -> Set.fromList e ==+ Set.fromList [ EMessageReceived msgErr, EJobError msgErr+ , EMessageReceived msg, EJobFinished msg ]) 500++ -- queue should be empty+ waitUntilQueueEmpty broker queueName 100++ it "killing worker should leave a currently processed message on queue (when resendWhenWorkerKilled is True)" $ \(TestEnv { broker, queueName, events, threadId }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ -- Perform some long job+ let msg = Timeout { delay = 2 }+ let job = (mkDefaultSendJob broker queueName msg 2) { resendOnKill = True }+ void $ sendJob' job++ -- Let's wait a bit to make sure the message is picked up by the+ -- worker+ waitUntilTVarEq events [ EMessageReceived msg ] 300++ -- Now let's kill the thread immediately+ throwTo threadId KillWorkerSafely+ putStrLn $ "After KillWorkerSafely: " <> BT.renderQueue queueName++ waitUntilTVarEq events [ EMessageReceived msg+ , EWorkerKilledSafely (Just msg) ] 300+ + -- The message should still be there+ BT.getQueueSize broker queueName >>= \qs -> do+ putStrLn $ "After threadDelay: " <> BT.renderQueue queueName <> " size: " <> show qs+ qs `shouldBe` 1++ it "killing worker should discard the currently processed message (when resendWhenWorkerKilled is False)" $ \(TestEnv { broker, queueName, events, threadId }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= flip shouldBe 0++ -- Perform some long job+ let msg = Timeout { delay = 2 }+ let job = (mkDefaultSendJob broker queueName msg 2) { resendOnKill = False }+ void $ sendJob' job++ -- Let's wait a bit to make sure the message is picked up by the+ -- worker+ waitUntilTVarEq events [ EMessageReceived msg ] 300+ waitUntilQueueEmpty broker queueName 300++ -- Now let's kill the thread immediately+ throwTo threadId KillWorkerSafely++ waitUntilTVarEq events [ EMessageReceived msg+ , EWorkerKilledSafely (Just msg) ] 300++ -- The message shouldn't be there+ BT.getQueueSize broker queueName >>= shouldBe 0+++data TestEnvMulti b =+ TestEnvMulti { broker :: BT.Broker b (Job Message) -- a broker with which you can query its state+ , statesWithThreadIds :: [(State b Message, ThreadId)]+ , events :: TVar [Event]+ , brokerInitParams :: BT.BrokerInitParams b (Job Message)+ , queueName :: BT.Queue+ , numWorkers :: Int }+++testMultiQueuePrefix :: BT.Queue+testMultiQueuePrefix = "test_workers"+++withWorkers :: (HasWorkerBroker b Message)+ => BT.BrokerInitParams b (Job Message)+ -> Int+ -> (TestEnvMulti b -> IO ())+ -> IO ()+withWorkers brokerInitParams numWorkers = bracket (setUpWorkers brokerInitParams) tearDownWorkers+ where+ -- NOTE I need to pass 'b' again, otherwise GHC can't infer the+ -- type of 'b' (even with 'ScopedTypeVariables' turned on)+ setUpWorkers :: (HasWorkerBroker b Message)+ => BT.BrokerInitParams b (Job Message)+ -> IO (TestEnvMulti b)+ setUpWorkers bInitParams = do+ b <- BT.initBroker bInitParams++ queue <- randomQueueName testMultiQueuePrefix+ + BT.dropQueue b queue+ BT.createQueue b queue++ events <- newTVarIO []++ statesWithThreadIds <-+ mapM (\idx -> initState bInitParams events queue ("test worker " <> show idx)) [1..numWorkers]+ + return $ TestEnvMulti { broker = b+ , queueName = queue+ , statesWithThreadIds+ , events+ , brokerInitParams = bInitParams+ , numWorkers }++ tearDownWorkers :: (HasWorkerBroker b Message)+ => TestEnvMulti b+ -> IO ()+ tearDownWorkers (TestEnvMulti { broker = b, queueName, statesWithThreadIds }) = do+ mapM_ (\(State { broker = b' }, threadId) -> do+ killThread threadId+ BT.deinitBroker b'+ ) statesWithThreadIds+ BT.dropQueue b queueName+ BT.deinitBroker b+++ +-- | Multiple 'Worker' tests, abstracting the 'Broker' away. All these+-- workers operate on the same queue.+multiWorkerTests :: (HasWorkerBroker b Message)+ => BT.BrokerInitParams b (Job Message)+ -> Int+ -> Spec+multiWorkerTests brokerInitParams numWorkers =+ parallel $ around (withWorkers brokerInitParams numWorkers) $ describe "Worker tests" $ do+ it "can process simple jobs" $ \(TestEnvMulti { broker, queueName, events, numWorkers = nw }) -> do+ -- no events initially+ readTVarIO events >>= shouldBe []+ -- queue should be empty+ BT.getQueueSize broker queueName >>= shouldBe 0++ -- create some messages and make sure they are processed (bombarding with messages)+ let msgs = [Message { text = "task " <> show idx } | idx <- [1..20*nw]]+ + let jobs = map (mkDefaultSendJob' broker queueName) msgs+ mapM_ sendJob' jobs+ + -- The jobs don't have to be process exactly in this order so we just use Set here+ let expected = concat [[EMessageReceived msg, EJobFinished msg] | msg <- msgs]+ waitUntilTVarPred events (\e -> Set.fromList e == Set.fromList expected) (fromIntegral $ 200*nw)++ -- queue should be empty+ waitUntilQueueEmpty broker queueName 100++ -- it "multiple workers and one long message should result in one message processed" $ \(TestEnvMulti { broker, queueName, events }) -> do+ -- let msg = Timeout { delay = 2 }+ -- let job' = (mkDefaultSendJob broker queueName msg 1) { toStrat = TSArchive }+ -- msgId <- sendJob' job'+ + -- waitUntilTVarEq events [ EMessageReceived msg, EJobTimeout msg ] 1500+ + -- -- There might be a slight delay before the message is archived+ -- -- (handling exception step in the thread)+ -- waitUntil (isJust <$> BT.getArchivedMessage broker queueName msgId) 100+ + -- -- The archive should contain our message+ -- mMsgArchive <- BT.getArchivedMessage broker queueName msgId+ -- mMsgArchive `shouldSatisfy` isJust+ -- let msgArchive = fromJust mMsgArchive+ -- job (BT.toA $ BT.getMessage msgArchive) `shouldBe` msg+ + -- -- Queue should be empty, since we archive timed out jobs+ -- waitUntilQueueEmpty broker queueName 100+ ++second :: Int+second = 1000 * millisecond++millisecond :: Int+millisecond = 1000