diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU 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. + + + Copyright (C) + + 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 . + +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 +. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# tasty-tmux + +Library for user acceptance testing (UAT) using tmux as the +vehicle for running programs and interacting with them. + +See "Test.Tasty.Tmux" module for usage examples and API +documentation. + +Note: This package currently does not integrate with the tasty +packages API. We currently don't see any gain from doing so. If you +find there would be a specific benefit, please file an issue. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/src/Test/Tasty/Tmux.hs b/src/Test/Tasty/Tmux.hs new file mode 100644 --- /dev/null +++ b/src/Test/Tasty/Tmux.hs @@ -0,0 +1,568 @@ +-- This file is part of tasty-tmux +-- Copyright (C) 2017-2019 Róman Joost and Fraser Tweedale +-- +-- tasty-tmux 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 . + +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE RankNTypes #-} + +{- | + +This module provides a test framework for user acceptance testing +(UAT) of command line or console applications. The framework +establishes sessions for +test cases and provides functions for sending input to the tmux +session and making assertions about the state of the terminal (i.e. +what is on the screen). + +At a glance, the library works like this. Test cases ('TestCase') +are defined using 'withTmuxSession'. The 'testTmux' function groups +test cases into a /Tasty/ 'TestTree'. Test cases are executed +sequentially, each in a separate tmux session. Each test case can +have a setup and teardown action, and there can also be a setup and +teardown around the whole group of tests. + +Let's look at a specific usage example. You want to test some +program. There are two tests. Each test needs a dedicated +temporary directory, but they also need a separate, shared temporary +directory. We want the setup routines to create these directories +and the teardown routines to remove them. Assume the +existence of @mkTempDir :: IO FilePath@ and @rmDir :: FilePath +-> IO ()@. + +Looking first at 'testTmux': + +@ +data SharedEnv = SharedEnv FilePath + +myTests :: TestTree +myTests = 'testTmux' pre post [test1, test2] + where + pre = SharedEnv \<$\> mkTempDir + post (SharedEnv path) = rmDir path +@ + +The shared setup action @pre@ returns a @SharedEnv@ value that will +be propagated to each test case, as well as the @teardown@ action, +after all test cases have run. + +@test1@ and @test2@ are defined thus: + +@ +test1 :: TestCase SharedEnv +test1 = withTmuxSession setup teardown "putFile" $ \\step -> do + -- test environment is availabe via 'ask' + TestEnv _ sharedDir testDir <- 'ask' + + -- send a command to the tmux session and wait for \"Done\" + 'sendLine' ("myProg putFile " <> sharedDir) (Substring "Done.") + + -- save a snapshot of the terminal state and make some assertions + 'snapshot' + 'assertSubstringS' "The output should contain this substring" + 'assertRegexS' "The output should match this [Rr]eg[Ee]x" + +test2 :: TestCase SharedEnv +test2 = withTmuxSession setup teardown "checkFile" $ \\step -> do + TestEnv _ sharedDir testDir <- 'ask' + + -- use 'step' to label different stages of the test + step "Run program" + sendLine ("myProg checkFile " <> sharedDir) (Substring "Yep, it's there.") + + step "Check exit code" + sendLine "echo status $?" (Substring "status 0") +@ + +Further discussion of the setup action is warranted. This function, +at minimum, must incorporate the 'TmuxSession' argument into the +value it returns. The type it returns must have an instance of +'HasTmuxSession'; this provides the name of the tmux session to the +framework functions that interact with tmux. + +In our example, it also creates a per-test case temporary directory. +The value returned by the setup action is provided to the teardown +action. + +@ +data TestEnv = TestEnv + { _session :: 'TmuxSession' + , _sharedDir :: FilePath + , _testDir :: FilePath + } + +instance 'HasTmuxSession' TestEnv where + 'tmuxSession' = 'lens' _session (\\s b -> s { _session = b }) + +setup :: SharedEnv -> TmuxSession -> IO TestEnv +setup (SharedEnv sharedDir) session = TestEnv session sharedDir \<$\> mkTempDir + +teardown :: TestEnv -> IO () +teardown (TestEnv _ _ testDir) = rmDir testDir +@ + +If either shared or test-specific setup and teardown are not needed, +the 'testTmux'' and 'withTmuxSession'' functions are provided for +convenience. + +-} +module Test.Tasty.Tmux + ( + -- * Creating test cases + testTmux + , testTmux' + , withTmuxSession + , withTmuxSession' + , TestCase + + -- ** Test environment + , HasTmuxSession(..) + , TmuxSession + + -- * Sending input to a session + , sendKeys + , sendLiteralKeys + , sendLine + , tmuxSendKeys + , TmuxKeysMode(..) + , setEnvVarInSession + + -- * Capturing terminal state + , capture + , snapshot + , Capture + , captureBytes + , captureString + + -- * Assertions + , waitForCondition + , Condition(..) + , defaultRetries + , defaultBackoff + , assertCondition + , assertSubstring + , assertRegex + + -- ** State-aware assertions + , assertConditionS + , assertSubstringS + , assertRegexS + + -- ** ANSI escape sequence regex helpers + , AnsiAttrParam + , AnsiFGParam + , AnsiBGParam + , buildAnsiRegex + + -- * Re-exports + , put + + ) where + +import Control.Concurrent (threadDelay) +import Control.Exception (catch, IOException) +import Control.Monad (void) +import Control.Monad.IO.Class (liftIO) +import Control.Monad.Reader (MonadIO, MonadReader, asks, runReaderT) +import Control.Monad.State (MonadState, get, put, runStateT) +import qualified Data.ByteString.Char8 as B +import qualified Data.ByteString.Lazy as L +import Data.Char (isAscii, isAlphaNum) +import Data.Functor.Const (Const(..)) +import Data.List (intercalate) +import Data.Semigroup ((<>)) +import qualified Data.Text as T +import qualified Data.Text.Encoding as T +import qualified Data.Text.Encoding.Error as T +import System.IO (hPutStrLn, stderr) + +import System.Process.Typed + ( proc, runProcess_, readProcessInterleaved_, ProcessConfig ) +import Text.Regex.Posix ((=~)) + +import Test.Tasty (TestTree, TestName, testGroup, withResource) +import Test.Tasty.HUnit (assertBool, testCaseSteps) + +-- | A condition to check for in the output of the program +data Condition + = Unconditional + | Substring B.ByteString + | Regex B.ByteString + deriving (Show) + +-- | A captured pane. For now this just contains the string content, +-- but in the future perhaps we will augment it with terminal title, +-- terminal dimensions, timestamp, etc. +-- +-- Use 'captureBytes' to get the raw terminal output. +-- +newtype Capture = Capture { _captureBytes :: B.ByteString } + +-- | Get the captured terminal content as a string (assume UTF-8 encoding), +-- including escape sequences. +captureString :: Capture -> String +captureString = T.unpack . T.decodeUtf8With T.lenientDecode . _captureBytes + +-- | Get the raw bytes of the capture, including escape sequences. +captureBytes :: Capture -> B.ByteString +captureBytes = _captureBytes + +-- | A test case that will be executed in a dedicated tmux session. +-- Parameterised over the shared environment type. +type TestCase a = IO a -> Int -> TestTree + +-- | tmux session name +type TmuxSession = String + +-- | This class provides access to a tmux session name. Test +-- environment types must have an instance of this class. +class HasTmuxSession a where + -- | Lens to the 'TmuxSession' + tmuxSession :: Functor f => (TmuxSession -> f TmuxSession) -> a -> f a + +instance HasTmuxSession TmuxSession where + tmuxSession = id + +view :: MonadReader s m => ((a -> Const a a) -> s -> Const a s) -> m a +view l = asks (getConst . l Const) + + +-- | Run a series of tests in tmux sessions. +-- +-- Tests are executed sequentially. Each test case is executed in a +-- new tmux session. The name of the session is derived from the +-- name of the test and prepended with the sequence number. +-- +-- A session called "keepalive" is created before any test cases are +-- run, and killed after all the test cases have finished. This +-- session ensures that the tmux server remains alive, avoiding some race +-- conditions. +-- +testTmux + :: IO a + -- ^ Set-up action. Executed one time, after the keepalive + -- session is created but before any test cases are executed. + -> (a -> IO ()) + -- ^ Tear-down action. Executed after all test cases have + -- finished but before the keepalive session gets killed. + -> [TestCase a] + -> TestTree +testTmux pre post tests = + withResource (frameworkPre *> pre) (\a -> post a *> frameworkPost) $ \env -> + testGroup "user acceptance tests" $ zipWith ($ env) tests [0..] + where + keepaliveSessionName = "keepalive" + frameworkPre = setUpTmuxSession keepaliveSessionName + frameworkPost = cleanUpTmuxSession keepaliveSessionName + +-- | Like 'testTmux' but with no setup or teardown +testTmux' :: [TestCase ()] -> TestTree +testTmux' = testTmux (pure ()) (const $ pure ()) + + +-- | ANSI attribute +type AnsiAttrParam = String +-- | ANSI foreground colour +type AnsiFGParam = String +-- | ANSI background colour +type AnsiBGParam = String + +-- | Generate a regex for an escape sequence, setting the given +-- foreground and background parameters. +-- +-- tmux < +-- +-- (first released in tmux-2.5) ran attributes, foreground +-- colour and background colour params separated by semicolons +-- (foreground first). +-- After that commit, attributes, foreground colours and background +-- colours are written in separate escape sequences. Therefore for +-- compatibility with different versions of tmux there are two +-- patterns to check. +-- +buildAnsiRegex :: [AnsiAttrParam] -> [AnsiFGParam] -> [AnsiBGParam] -> B.ByteString +buildAnsiRegex attrs fgs bgs = + let + withSemis = intercalate ";" + wrap [] = "" + wrap xs = "\ESC\\[" <> withSemis xs <> "m" + tmux24 = wrap (attrs <> fgs <> bgs) + tmux25 = wrap attrs <> wrap fgs <> wrap bgs + choice "" "" = "" + choice "" r = r + choice l "" = l + choice l r = "(" <> l <> "|" <> r <> ")" + in + B.pack $ choice tmux24 tmux25 + +-- | Sets a shell environment variable. +-- +-- Note: The tmux program provides a command to set environment variables for +-- running sessions, yet they seem to be not inherited by the shell. +-- +-- This assumes that a standard shell prompt is ready in the session. +-- No attempt is made to check this; it just blindly send they keystrokes. +-- +setEnvVarInSession + :: (HasTmuxSession a, MonadReader a m, MonadIO m) + => String -> String -> m () +setEnvVarInSession name value = + void $ sendLine ("export " <> name <> "=" <> value) Unconditional + +-- | Send interpreted keys into the program and wait for the +-- condition to be met, failing the test if the condition is not met +-- after some time. +sendKeys + :: (HasTmuxSession a, MonadReader a m, MonadIO m) + => String -> Condition -> m Capture +sendKeys keys expect = do + tmuxSendKeys InterpretKeys keys + waitForCondition expect defaultRetries defaultBackoff + +-- | Send literal keys to the terminal and wait for the condition to +-- be satisfied, with default timeout. +sendLiteralKeys + :: (HasTmuxSession a, MonadReader a m, MonadIO m) + => String -> Condition -> m Capture +sendLiteralKeys keys cond = do + tmuxSendKeys LiteralKeys keys + waitForCondition cond defaultRetries defaultBackoff + +-- | Send the literal string to the terminal, followed by @Enter@, +-- then wait for the condition be satisfied, with default timeout. +sendLine + :: (HasTmuxSession a, MonadReader a m, MonadIO m) + => String -> Condition -> m Capture +sendLine s cond = do + void $ sendLiteralKeys s Unconditional + sendKeys "Enter" cond + +-- | Whether to tell tmux to treat keys literally or interpret +-- sequences like "Enter" or "C-x". +-- +data TmuxKeysMode = LiteralKeys | InterpretKeys + deriving (Eq) + +-- | Send keystrokes into a tmux session. +-- +tmuxSendKeys + :: (HasTmuxSession a, MonadReader a m, MonadIO m) + => TmuxKeysMode -> String -> m () +tmuxSendKeys mode keys = tmuxSendKeysProc mode keys >>= runProcess_ + +-- | Construct the 'ProcessConfig' for a tmux command. The session +-- name is read from the 'MonadReader' environment. +-- +tmuxSendKeysProc + :: (HasTmuxSession a, MonadReader a m) + => TmuxKeysMode -> String -> m (ProcessConfig () () ()) +tmuxSendKeysProc mode keys = tmuxSessionProc "send-keys" (["-l" | mode == LiteralKeys] <> [keys]) + +-- | Create a 'ProcessConfig' for a tmux command, taking the session +-- name from the 'MonadReader' environment. +-- +tmuxSessionProc + :: (HasTmuxSession a, MonadReader a m) + => String -> [String] -> m (ProcessConfig () () ()) +tmuxSessionProc cmd args = do + sessionName <- view tmuxSession + pure $ proc "tmux" (cmd : "-t" : sessionName : args) + +-- | Capture the pane and check for a condition, optionally retrying +-- with exponential backoff. If the condition is not met after the +-- final attempt, the test fails. +waitForCondition + :: (HasTmuxSession a, MonadReader a m, MonadIO m) + => Condition + -> Int -- ^ Number of retries allowed + -> Int -- ^ Initial microseconds to back off. Multiplied by 4 on each retry. + -> m Capture -- ^ Return the successful capture (or throw an exception) +waitForCondition cond n backOff = do + cap <- capture + case checkCondition cond (captureBytes cap) of + True -> pure cap + _ | n > 0 -> do + liftIO $ threadDelay backOff + waitForCondition cond (n - 1) (backOff * 4) + | otherwise -> cap <$ assertCondition cond cap + +checkCondition :: Condition -> B.ByteString -> Bool +checkCondition Unconditional = const True +checkCondition (Substring s) = (s `B.isInfixOf`) +checkCondition (Regex re) = (=~ re) + +-- | Assert that the capture satisfies a condition +assertCondition :: (MonadIO m) => Condition -> Capture -> m () +assertCondition cond cap = + let s = captureString cap + in liftIO $ assertBool + ( "Condition not met: '" <> show cond + -- TODO we probably should emit terminal reset sequence + -- after outputting the capture. + <> "'. Last capture:\n\n " <> s <> "\n\n" + <> " raw: " <> show s ) + (checkCondition cond (captureBytes cap)) + +-- | Substring assertion. +assertSubstring :: (MonadIO m) => B.ByteString -> Capture -> m () +assertSubstring = assertCondition . Substring + +-- | Regex assertion. +assertRegex :: (MonadIO m) => B.ByteString -> Capture -> m () +assertRegex = assertCondition . Regex + +-- | Assert that the saved capture satisfies a condition. +-- +-- Use 'snapshot' to save a capture: +-- +-- @ +-- snapshot +-- assertConditionS (Regex "[Ff][Oo][Oo]") +-- @ +-- +-- Alternatively, use 'put' on the result of any action that returns +-- a 'Capture': +-- +-- @ +-- 'sendKeys' "Enter" Unconditional >>= 'put' +-- assertConditionS (Substring "Doing thing...") +-- @ +-- +-- See also 'assertSubstringS' and 'assertRegexS'. +-- +assertConditionS :: (MonadIO m, MonadState Capture m) => Condition -> m () +assertConditionS cond = get >>= assertCondition cond + +-- | State-aware substring assertion. +assertSubstringS :: (MonadIO m, MonadState Capture m) => B.ByteString -> m () +assertSubstringS s = get >>= assertSubstring s + +-- | State-aware regex assertion. +assertRegexS :: (MonadIO m, MonadState Capture m) => B.ByteString -> m () +assertRegexS s = get >>= assertRegex s + +-- | 5 +defaultRetries :: Int +defaultRetries = 5 + +-- | Run all application steps in a session defined by session name. +withTmuxSession + :: (HasTmuxSession testEnv) + => (sharedEnv -> TmuxSession -> IO testEnv) + -- ^ Set up session. The tmux session is established before this + -- action is run. Takes the shared environment and Tmux session + -- and constructs a test environment value (which must make the + -- 'TmuxSession' available via its 'HasTmuxSession' instance). + -> (testEnv -> IO ()) + -- ^ Tear down the session. The tmux session will be torn down + -- /after/ this action. + -> TestName + -- ^ Name of the test (a string). + -> ( forall m. (MonadReader testEnv m, MonadState Capture m, MonadIO m) + => (String -> m ()) -> m a + ) + -- ^ The main test function. The argument is the "step" function + -- which can be called with a description to label the steps of + -- the test procedure. + -> TestCase sharedEnv +withTmuxSession pre post desc f getGEnv i = + withResource + (getGEnv >>= \gEnv -> frameworkPre >>= pre gEnv) + (\env -> post env *> cleanUpTmuxSession (view tmuxSession env)) + $ \env -> testCaseSteps desc $ + \step -> env >>= void . runReaderT (runStateT (f (liftIO . step)) initCap) + where + initCap = error "no Capture; use 'snapshot' first" + frameworkPre = + let + -- FIXME? customisable session name prefix? + sessionName = intercalate "-" ("tasty-tmux" : show i : descWords) + descWords = words $ filter (\c -> isAscii c && (isAlphaNum c || c == ' ')) desc + in + setUpTmuxSession sessionName + +-- | Like 'withTmuxSession' but without setup and teardown. Shared +-- environment value (and its type) is ignored. +withTmuxSession' + :: TestName + -> ( forall m. (MonadReader TmuxSession m, MonadState Capture m, MonadIO m) + => (String -> m ()) -> m a + ) + -- ^ The main test function. The argument is the "step" function + -- which can be called with a description to label the steps of + -- the test procedure. + -> TestCase sharedEnv +withTmuxSession' = withTmuxSession (const pure) (const $ pure ()) + +-- | Capture the current terminal state. +capture :: (HasTmuxSession a, MonadReader a m, MonadIO m) => m Capture +capture = Capture . L.toStrict + <$> (tmuxSessionProc "capture-pane" + [ "-e" -- include escape sequences + , "-p" -- send output to stdout + , "-J" -- join wrapped lines and preserve trailing whitespace + ] + >>= liftIO . readProcessInterleaved_) + +-- | Snapshot the current terminal state. +-- +-- @ +-- snapshot = 'capture' >>= 'put' +-- @ +-- +-- Use functions like 'assertConditionS' to make assertions on the +-- most recent snapshot. +-- +snapshot :: (HasTmuxSession a, MonadReader a m, MonadState Capture m, MonadIO m) => m () +snapshot = capture >>= put + +-- | 20 milliseconds +defaultBackoff :: Int +defaultBackoff = 20 * 10 ^ (3 :: Int) + +-- | create a tmux session running in the background +-- Note: the width and height are the default values tmux uses, but I thought +-- it's better to be explicit. +-- +-- Returns the session name (whatever the input was) for convenience. +setUpTmuxSession :: TmuxSession -> IO TmuxSession +setUpTmuxSession sessionname = sessionname <$ + catch + (runProcess_ $ proc + "tmux" + [ "new-session" + , "-x" + , "80" + , "-y" + , "24" + , "-d" + , "-s" + , sessionname + , "-n" + , "tasty-tmux"]) + (\e -> + do let err = show (e :: IOException) + hPutStrLn stderr ("\nException during setUp: " <> err) + pure ()) + +-- | Kills the whole session including pane and application +cleanUpTmuxSession :: String -> IO () +cleanUpTmuxSession sessionname = + catch + (runProcess_ $ proc "tmux" ["kill-session", "-t", sessionname]) + (\e -> + do let err = show (e :: IOException) + hPutStrLn stderr ("\nException when killing session: " <> err) + pure ()) diff --git a/tasty-tmux.cabal b/tasty-tmux.cabal new file mode 100644 --- /dev/null +++ b/tasty-tmux.cabal @@ -0,0 +1,44 @@ +name: tasty-tmux +version: 0.1.0.0 +synopsis: Terminal user acceptance testing (UAT) via tmux + +description: + Library for user acceptance testing (UAT) using tmux as the + vehicle for running programs and interacting with them. + . + See "Test.Tasty.Tmux" for usage examples and API documentation. + + +license: AGPL-3 +license-file: LICENSE +author: Róman Joost and Fraser Tweedale +maintainer: roman@bromeco.de +copyright: Copyright 2017-2019 Róman Joost and Fraser Tweedale +category: Testing +build-type: Simple +cabal-version: >=1.10 +extra-source-files: + README.md + +homepage: https://github.com/purebred-mua/tasty-tmux +bug-reports: https://github.com/purebred-mua/tasty-tmux/issues +source-repository head + type: git + location: https://github.com/purebred-mua/tasty-tmux.git + +library + hs-source-dirs: src + ghc-options: -Wall -Wredundant-constraints + exposed-modules: Test.Tasty.Tmux + -- other-modules: + other-extensions: FlexibleContexts, FlexibleInstances, RankNTypes + build-depends: + base >=4.11 && <5 + , mtl >=2.2 && <2.3 + , bytestring >=0.10 && <0.11 + , text >=1.2 && <1.3 + , typed-process >=0.2.4 && <0.3 + , regex-posix >= 0.95 + , tasty >= 1.2 + , tasty-hunit >= 0.10 + default-language: Haskell2010