diff --git a/LICENSE b/LICENSE index 0815c492..186ade81 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,201 @@ - 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) 2021 debugtalk - - 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 -. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 debugtalk + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/boomer.go b/boomer.go index 5719069c..3236a007 100644 --- a/boomer.go +++ b/boomer.go @@ -3,33 +3,34 @@ package hrp import ( "time" + "github.com/jinzhu/copier" "github.com/rs/zerolog/log" "github.com/httprunner/hrp/internal/boomer" "github.com/httprunner/hrp/internal/ga" ) -func NewBoomer(spawnCount int, spawnRate float64) *hrpBoomer { - b := &hrpBoomer{ +func NewBoomer(spawnCount int, spawnRate float64) *HRPBoomer { + b := &HRPBoomer{ Boomer: boomer.NewStandaloneBoomer(spawnCount, spawnRate), debug: false, } return b } -type hrpBoomer struct { +type HRPBoomer struct { *boomer.Boomer debug bool } // SetDebug configures whether to log HTTP request and response content. -func (b *hrpBoomer) SetDebug(debug bool) *hrpBoomer { +func (b *HRPBoomer) SetDebug(debug bool) *HRPBoomer { b.debug = debug return b } // Run starts to run load test for one or multiple testcases. -func (b *hrpBoomer) Run(testcases ...ITestCase) { +func (b *HRPBoomer) Run(testcases ...ITestCase) { event := ga.EventTracking{ Category: "RunLoadTests", Action: "hrp boom", @@ -45,26 +46,44 @@ func (b *hrpBoomer) Run(testcases ...ITestCase) { if err != nil { panic(err) } + cfg := testcase.Config.ToStruct() + err = initParameterIterator(cfg, "boomer") + if err != nil { + panic(err) + } task := b.convertBoomerTask(testcase) taskSlice = append(taskSlice, task) } b.Boomer.Run(taskSlice...) } -func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { +func (b *HRPBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { hrpRunner := NewRunner(nil).SetDebug(b.debug) - runner := hrpRunner.newCaseRunner(testcase) config := testcase.Config.ToStruct() return &boomer.Task{ Name: config.Name, Weight: config.Weight, Fn: func() { + runner := hrpRunner.newCaseRunner(testcase) + testcaseSuccess := true // flag whole testcase result var transactionSuccess = true // flag current transaction result + cfg := testcase.Config.ToStruct() + caseConfig := &TConfig{} + // copy config to avoid data racing + if err := copier.Copy(caseConfig, cfg); err != nil { + log.Error().Err(err).Msg("copy config data failed") + } + // iterate through all parameter iterators and update case variables + for _, it := range caseConfig.ParametersSetting.Iterators { + if it.HasNext() { + caseConfig.Variables = mergeVariables(it.Next(), caseConfig.Variables) + } + } startTime := time.Now() for index, step := range testcase.TestSteps { - stepData, err := runner.runStep(index) + stepData, err := runner.runStep(index, caseConfig) if err != nil { // step failed var elapsed int64 @@ -78,7 +97,7 @@ func (b *hrpBoomer) convertBoomerTask(testcase *TestCase) *boomer.Task { transactionSuccess = false if runner.hrpRunner.failfast { - log.Error().Err(err).Msg("abort running due to failfast setting") + log.Error().Msg("abort running due to failfast setting") break } log.Warn().Err(err).Msg("run step failed, continue next step") diff --git a/docs/BUILTIN.md b/docs/BUILTIN.md new file mode 100644 index 00000000..19c6bff5 --- /dev/null +++ b/docs/BUILTIN.md @@ -0,0 +1,53 @@ +# Builtin + +## Builtin assertions + +HttpRunner+ validation should follow the following format. `check`, `assert` and `expect` are required field. + +```json +{ + "check": "status_code", // target field, usually used with jmespath + "assert": "equals", // assertion method, you can use builtin method or custom defined function + "expect": 200, // expected value + "msg": "check response status code" // optional, print this message if assertion failed +} +``` + +The `assert` method name will be mapped to a built-in function with the following function signature. + +```go +func(t assert.TestingT, expected interface{}, actual interface{}, msgAndArgs ...interface{}) bool +``` + +Currently, HttpRunner+ has the following built-in assertion functions. + +| `assert` | Description | A(check), B(expect) | examples | +| -- | -- | -- | -- | +| `eq`, `equals`, `equal` | value is equal | A == B | 9 eq 9 | +| `lt`, `less_than` | less than | A < B | 7 lt 8 | +| `le`, `less_or_equals` | less than or equals | A <= B | 7 le 8, 8 le 8 | +| `gt`, `greater_than` | greater than | A > B | 8 gt 7 | +| `ge`, `greater_or_equals` | greater than or equals | A >= B | 8 ge 7, 8 ge 8 | +| `ne`, `not_equal` | not equals | A != B | 6 ne 9 | +| `str_eq`, `string_equals` | string equals | str(A) == str(B) | 123 str_eq '123' | +| `len_eq`, `length_equals`, `length_equal` | length equals | len(A) == B | 'abc' len_eq 3, [1,2] len_eq 2 | +| `len_gt`, `count_gt` | length greater than | len(A) > B | 'abc' len_gt 2, [1,2,3] len_gt 2 | +| `len_ge`, `count_ge` | length greater than or equals | len(A) >= B | 'abc' len_ge 3, [1,2,3] len_gt 3 | +| `len_lt`, `count_lt` | length less than | len(A) < B | 'abc' len_lt 4, [1,2,3] len_lt 4 | +| `len_le`, `count_le` | length less than or equals | len(A) <= B | 'abc' len_le 3, [1,2,3] len_le 3 | +| `contains` | contains | [1, 2] contains 1 | 'abc' contains 'a', [1,2,3] len_lt 4 | +| `contained_by` | contained by | A in B | 'a' contained_by 'abc', 1 contained_by [1,2] | +| `type_match` | A and B are in the same type | type(A) == type(B) | 123 type_match 1 | +| `regex_match` | regex matches | re.match(B, A) | 'abcdef' regex 'a\w+d' | +| `startswith` | starts with | A.startswith(B) is True | 'abc' startswith 'ab' | +| `endswith` | ends with | A.endswith(B) is True | 'abc' endswith 'bc' | + +## Builtin functions + +| Name | Arguments | Description | +| --- | --- | --- | +| `get_timestamp` | () | get the thirteen-digit timestamp of current time. | +| `sleep` | (n int) | sleep n seconds to simulate the thinking time. | +| `gen_random_string` | (n int) | get the n-digit random string. | +| `max` | (m,n int) | get the maximum of two numbers m and n. | +| `md5` | (s string) | get the MD5 of the input string s. | diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 9488bbd4..066ac6e2 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,8 +1,15 @@ # Release History -## v0.4.0 (2021-12-28) +## v0.4.0 (2022-01-05) -- feat: support creating and calling custom functions with `go plugin` +- feat: implement `parameterize` mechanism for data driven +- feat: support creating and calling custom functions with [go plugin](https://pkg.go.dev/plugin) +- feat: add multiple builtin assertion methods and builtin functions + +## v0.3.1 (2021-12-30) + +- fix: set ulimit to 10240 before load testing +- fix: concurrent map writes in load testing ## v0.3.0 (2021-12-24) diff --git a/docs/README.md b/docs/README.md index d244ed92..d2dfb861 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ - Homepage: https://httprunner.com - Docs - - English: https://httprunner.com/docs - - 中文: https://httprunner.com/zh/docs + - 中文: https://httprunner.com/docs + - English: https://httprunner.com/en/docs - [hrp command help](cmd/hrp.md) - Blog: https://httprunner.com/blog diff --git a/docs/cmd/hrp.md b/docs/cmd/hrp.md index 82c1c91f..af644700 100644 --- a/docs/cmd/hrp.md +++ b/docs/cmd/hrp.md @@ -32,4 +32,4 @@ Copyright 2021 debugtalk * [hrp har2case](hrp_har2case.md) - Convert HAR to json/yaml testcase files * [hrp run](hrp_run.md) - run API test -###### Auto generated by spf13/cobra on 29-Dec-2021 +###### Auto generated by spf13/cobra on 6-Jan-2022 diff --git a/docs/cmd/hrp_boom.md b/docs/cmd/hrp_boom.md index 524e00de..5690fc09 100644 --- a/docs/cmd/hrp_boom.md +++ b/docs/cmd/hrp_boom.md @@ -38,4 +38,4 @@ hrp boom [flags] * [hrp](hrp.md) - One-stop solution for HTTP(S) testing. -###### Auto generated by spf13/cobra on 29-Dec-2021 +###### Auto generated by spf13/cobra on 6-Jan-2022 diff --git a/docs/cmd/hrp_har2case.md b/docs/cmd/hrp_har2case.md index 3944abd9..144caa8c 100644 --- a/docs/cmd/hrp_har2case.md +++ b/docs/cmd/hrp_har2case.md @@ -23,4 +23,4 @@ hrp har2case harPath... [flags] * [hrp](hrp.md) - One-stop solution for HTTP(S) testing. -###### Auto generated by spf13/cobra on 29-Dec-2021 +###### Auto generated by spf13/cobra on 6-Jan-2022 diff --git a/docs/cmd/hrp_run.md b/docs/cmd/hrp_run.md index 1d45d99c..a0f5d0db 100644 --- a/docs/cmd/hrp_run.md +++ b/docs/cmd/hrp_run.md @@ -31,4 +31,4 @@ hrp run path... [flags] * [hrp](hrp.md) - One-stop solution for HTTP(S) testing. -###### Auto generated by spf13/cobra on 29-Dec-2021 +###### Auto generated by spf13/cobra on 6-Jan-2022 diff --git a/examples/account.csv b/examples/account.csv new file mode 100644 index 00000000..67ce22c6 --- /dev/null +++ b/examples/account.csv @@ -0,0 +1,4 @@ +username,password +test1,111111 +test2,222222 +test3,333333 \ No newline at end of file diff --git a/examples/function_test.go b/examples/function_test.go index cd2c2d98..44c8c590 100644 --- a/examples/function_test.go +++ b/examples/function_test.go @@ -19,14 +19,18 @@ func TestCaseCallFunction(t *testing.T) { TestSteps: []hrp.IStep{ hrp.NewStep("get with params"). GET("/get"). - WithParams(map[string]interface{}{"foo1": "${gen_random_string($n)}", "foo2": "${max($a, $b)}"}). + WithParams(map[string]interface{}{"foo1": "${gen_random_string($n)}", "foo2": "${max($a, $b)}", "foo3": "Foo3"}). WithHeaders(map[string]string{"User-Agent": "HttpRunnerPlus"}). Extract(). WithJmesPath("body.args.foo1", "varFoo1"). Validate(). AssertEqual("status_code", 200, "check status code"). AssertLengthEqual("body.args.foo1", 5, "check args foo1"). - AssertEqual("body.args.foo2", "12.3", "check args foo2"), // notice: request params value will be converted to string + AssertEqual("body.args.foo2", "12.3", "check args foo2"). + AssertTypeMatch("body.args.foo3", "str", "check args foo3 is type string"). + AssertStringEqual("body.args.foo3", "foo3", "check args foo3 case-insensitivity"). + AssertContains("body.args.foo3", "Foo", "check contains "). + AssertContainedBy("body.args.foo3", "this is Foo3 test", "check contained by"), // notice: request params value will be converted to string hrp.NewStep("post json data with functions"). POST("/post"). WithHeaders(map[string]string{"User-Agent": "HttpRunnerPlus"}). diff --git a/examples/parameters_test.json b/examples/parameters_test.json new file mode 100644 index 00000000..1a555593 --- /dev/null +++ b/examples/parameters_test.json @@ -0,0 +1,61 @@ +{ + "config": { + "name": "request methods testcase: validate with parameters", + "parameters": { + "user_agent": [ + "iOS/10.1", + "iOS/10.2" + ], + "username-password": "${parameterize(examples/account.csv)}" + }, + "parameters_setting": { + "strategy": { + "user_agent": "sequential", + "username-password": "random" + }, + "iteration": 6 + }, + "variables": { + "app_version": "v1", + "user_agent": "iOS/10.3" + }, + "base_url": "https://postman-echo.com", + "verify": false + }, + "teststeps": [ + { + "name": "get with params", + "variables": { + "foo1": "$username", + "foo2": "$password", + "foo3": "$user_agent" + }, + "request": { + "method": "GET", + "url": "/get", + "params": { + "foo1": "$foo1", + "foo2": "$foo2", + "foo3": "$foo3" + }, + "headers": { + "User-Agent": "$user_agent,$app_version" + } + }, + "validate": [ + { + "check": "status_code", + "assert": "equals", + "expect": 200, + "msg": "check status code" + }, + { + "check": "body.args.foo3", + "assert": "not_equal", + "expect": "iOS/10.3", + "msg": "check app version" + } + ] + } + ] +} \ No newline at end of file diff --git a/examples/parameters_test.yaml b/examples/parameters_test.yaml new file mode 100644 index 00000000..e2cabc91 --- /dev/null +++ b/examples/parameters_test.yaml @@ -0,0 +1,40 @@ +config: + name: "request methods testcase: validate with parameters" + parameters: + user_agent: [ "iOS/10.1", "iOS/10.2" ] + username-password: ${parameterize(examples/account.csv)} + parameters_setting: + strategy: + user_agent: "sequential" + username-password: "random" + iteration: 6 + variables: + app_version: v1 + user_agent: iOS/10.3 + base_url: "https://postman-echo.com" + verify: False + +teststeps: + - name: get with params + variables: + foo1: $username + foo2: $password + foo3: $user_agent + request: + method: GET + url: /get + params: + foo1: $foo1 + foo2: $foo2 + foo3: $foo3 + headers: + User-Agent: $user_agent,$app_version + validate: + - check: status_code + assert: equals + expect: 200 + msg: check status code + - check: body.args.foo3 + assert: not_equal + expect: iOS/10.3 + msg: check app version \ No newline at end of file diff --git a/hrp/cmd/boom.go b/hrp/cmd/boom.go index 41c67758..b19c239a 100644 --- a/hrp/cmd/boom.go +++ b/hrp/cmd/boom.go @@ -19,7 +19,8 @@ var boomCmd = &cobra.Command{ $ hrp boom examples/ # run testcases in specified folder`, Args: cobra.MinimumNArgs(1), PreRun: func(cmd *cobra.Command, args []string) { - setLogLevel("WARN") // disable info logs for load testing + boomer.SetUlimit(10240) // ulimit -n 10240 + setLogLevel("WARN") // disable info logs for load testing }, Run: func(cmd *cobra.Command, args []string) { var paths []hrp.ITestCase diff --git a/internal/boomer/stats.go b/internal/boomer/stats.go index 24141005..53b4f707 100644 --- a/internal/boomer/stats.go +++ b/internal/boomer/stats.go @@ -86,7 +86,7 @@ func (s *requestStats) logError(method, name, err string) { entry = &statsError{ name: name, method: method, - error: err, + errMsg: err, } s.errors[key] = entry } @@ -296,7 +296,7 @@ func (s *statsEntry) getStrippedReport() map[string]interface{} { type statsError struct { name string method string - error string + errMsg string occurrences int64 } @@ -308,7 +308,7 @@ func (err *statsError) toMap() map[string]interface{} { m := make(map[string]interface{}) m["method"] = err.method m["name"] = err.name - m["error"] = err.error + m["error"] = err.errMsg m["occurrences"] = err.occurrences return m } diff --git a/internal/boomer/stats_test.go b/internal/boomer/stats_test.go index 666a9636..afe0b41e 100644 --- a/internal/boomer/stats_test.go +++ b/internal/boomer/stats_test.go @@ -95,8 +95,8 @@ func TestLogError(t *testing.T) { // md5("httpfailure500 error") = 547c38e4e4742c1c581f9e2809ba4f55 err500 := newStats.errors["547c38e4e4742c1c581f9e2809ba4f55"] - if err500.error != "500 error" { - t.Error("Error message is wrong, expected: 500 error, got:", err500.error) + if err500.errMsg != "500 error" { + t.Error("Error message is wrong, expected: 500 error, got:", err500.errMsg) } if err500.occurrences != 1 { t.Error("Error occurrences is wrong, expected: 1, got:", err500.occurrences) @@ -104,8 +104,8 @@ func TestLogError(t *testing.T) { // md5("httpfailure400 error") = f391c310401ad8e10e929f2ee1a614e4 err400 := newStats.errors["f391c310401ad8e10e929f2ee1a614e4"] - if err400.error != "400 error" { - t.Error("Error message is wrong, expected: 400 error, got:", err400.error) + if err400.errMsg != "400 error" { + t.Error("Error message is wrong, expected: 400 error, got:", err400.errMsg) } if err400.occurrences != 2 { t.Error("Error occurrences is wrong, expected: 2, got:", err400.occurrences) diff --git a/internal/boomer/ulimit.go b/internal/boomer/ulimit.go new file mode 100644 index 00000000..b83585ea --- /dev/null +++ b/internal/boomer/ulimit.go @@ -0,0 +1,32 @@ +// +build !windows + +package boomer + +import ( + "syscall" + + "github.com/rs/zerolog/log" +) + +// set resource limit +// ulimit -n 10240 +func SetUlimit(limit uint64) { + var rLimit syscall.Rlimit + err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit) + if err != nil { + log.Error().Err(err).Msg("get ulimit failed") + return + } + log.Info().Uint64("limit", rLimit.Cur).Msg("get current ulimit") + if rLimit.Cur >= limit { + return + } + + rLimit.Cur = limit + log.Info().Uint64("limit", rLimit.Cur).Msg("set current ulimit") + err = syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit) + if err != nil { + log.Error().Err(err).Msg("set ulimit failed") + return + } +} diff --git a/internal/boomer/ulimit_windows.go b/internal/boomer/ulimit_windows.go new file mode 100644 index 00000000..76ca69fc --- /dev/null +++ b/internal/boomer/ulimit_windows.go @@ -0,0 +1,12 @@ +// +build windows + +package boomer + +import ( + "github.com/rs/zerolog/log" +) + +// set resource limit +func SetUlimit(limit uint64) { + log.Warn().Msg("windows does not support setting ulimit") +} diff --git a/internal/builtin/assertion.go b/internal/builtin/assertion.go index 31110221..d59f6366 100644 --- a/internal/builtin/assertion.go +++ b/internal/builtin/assertion.go @@ -2,6 +2,7 @@ package builtin import ( "fmt" + "reflect" "strings" "github.com/stretchr/testify/assert" @@ -15,13 +16,20 @@ var Assertions = map[string]func(t assert.TestingT, expected interface{}, actual "greater_or_equals": assert.GreaterOrEqual, "less_or_equals": assert.LessOrEqual, "not_equal": assert.NotEqual, - "contains": assert.Contains, + "contained_by": assert.Contains, "regex_match": assert.Regexp, + "type_match": assert.IsType, // custom assertions - "startswith": StartsWith, // check if string starts with substring - "endswith": EndsWith, // check if string ends with substring - "length_equals": EqualLength, - "length_equal": EqualLength, // alias for length_equals + "startswith": StartsWith, // check if string starts with substring + "endswith": EndsWith, // check if string ends with substring + "length_equals": EqualLength, + "length_equal": EqualLength, // alias for length_equals + "length_less_than": LessThanLength, + "length_less_or_equals": LessOrEqualsLength, + "length_greater_than": GreaterThanLength, + "length_greater_or_equals": GreaterOrEqualsLength, + "contains": Contains, + "string_equals": EqualString, } func StartsWith(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { @@ -57,6 +65,66 @@ func EqualLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ... return assert.Len(t, actual, length, msgAndArgs...) } +func GreaterThanLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + length, err := convertInt(expected) + if err != nil { + return assert.Fail(t, fmt.Sprintf("expected type is not int, got %#v", expected), msgAndArgs...) + } + ok, l := getLen(actual) + if !ok { + return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) + } + if l <= length { + return assert.Fail(t, fmt.Sprintf("\"%s\" should be more than %d item(s), but has %d", actual, length, l), msgAndArgs...) + } + return true +} + +func GreaterOrEqualsLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + length, err := convertInt(expected) + if err != nil { + return assert.Fail(t, fmt.Sprintf("expected type is not int, got %#v", expected), msgAndArgs...) + } + ok, l := getLen(actual) + if !ok { + return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) + } + if l < length { + return assert.Fail(t, fmt.Sprintf("\"%s\" should be no less than %d item(s), but has %d", actual, length, l), msgAndArgs...) + } + return true +} + +func LessThanLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + length, err := convertInt(expected) + if err != nil { + return assert.Fail(t, fmt.Sprintf("expected type is not int, got %#v", expected), msgAndArgs...) + } + ok, l := getLen(actual) + if !ok { + return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) + } + if l >= length { + return assert.Fail(t, fmt.Sprintf("\"%s\" should be less than %d item(s), but has %d", actual, length, l), msgAndArgs...) + } + return true +} + +func LessOrEqualsLength(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + length, err := convertInt(expected) + if err != nil { + return assert.Fail(t, fmt.Sprintf("expected type is not int, got %#v", expected), msgAndArgs...) + } + ok, l := getLen(actual) + if !ok { + return assert.Fail(t, fmt.Sprintf("\"%s\" could not be applied builtin len()", actual), msgAndArgs...) + } + if l > length { + return assert.Fail(t, fmt.Sprintf("\"%s\" should be no more than %d item(s), but has %d", actual, length, l), msgAndArgs...) + } + return true +} + func convertInt(value interface{}) (int, error) { switch v := value.(type) { case int: @@ -83,3 +151,32 @@ func convertInt(value interface{}) (int, error) { return 0, fmt.Errorf("unsupported int convertion for %v(%T)", v, v) } } + +// Contains assert whether actual element contains expected element +func Contains(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + return assert.Contains(t, actual, expected, msgAndArgs) +} + +func EqualString(t assert.TestingT, expected, actual interface{}, msgAndArgs ...interface{}) bool { + if !assert.IsType(t, "string", actual, msgAndArgs) { + return false + } + if !assert.IsType(t, "string", expected, msgAndArgs) { + return false + } + actualString := actual.(string) + expectedString := expected.(string) + return assert.True(t, strings.EqualFold(actualString, expectedString), msgAndArgs) +} + +// getLen try to get length of object. +// return (false, 0) if impossible. +func getLen(x interface{}) (ok bool, length int) { + v := reflect.ValueOf(x) + defer func() { + if e := recover(); e != nil { + ok = false + } + }() + return true, v.Len() +} diff --git a/internal/builtin/assertion_test.go b/internal/builtin/assertion_test.go index 632dad30..52d8d5d0 100644 --- a/internal/builtin/assertion_test.go +++ b/internal/builtin/assertion_test.go @@ -61,3 +61,80 @@ func TestEqualLength(t *testing.T) { } } } + +func TestLessThanLength(t *testing.T) { + testData := []struct { + raw interface{} + expected int + }{ + {"", 1}, + {[]string{}, 1}, + {map[string]interface{}{}, 1}, + {"a", 2}, + {[]string{"a"}, 2}, + {map[string]interface{}{"a": 123}, 2}, + } + + for _, data := range testData { + if !assert.True(t, LessThanLength(t, data.expected, data.raw)) { + t.Fail() + } + } +} + +func TestLessOrEqualsLength(t *testing.T) { + testData := []struct { + raw interface{} + expected int + }{ + {"", 1}, + {[]string{}, 1}, + {map[string]interface{}{"A": 111}, 1}, + {"a", 1}, + {[]string{"a"}, 2}, + {map[string]interface{}{"a": 123}, 2}, + } + + for _, data := range testData { + if !assert.True(t, LessOrEqualsLength(t, data.expected, data.raw)) { + t.Fail() + } + } +} + +func TestGreaterThanLength(t *testing.T) { + testData := []struct { + raw interface{} + expected int + }{ + {"abcd", 3}, + {[]string{"a", "b", "c"}, 2}, + {map[string]interface{}{"a": 123, "b": 223, "c": 323}, 2}, + } + + for _, data := range testData { + if !assert.True(t, GreaterThanLength(t, data.expected, data.raw)) { + t.Fail() + } + } +} + +func TestGreaterOrEqualsLength(t *testing.T) { + testData := []struct { + raw interface{} + expected int + }{ + {"abcd", 3}, + {[]string{"w"}, 1}, + {map[string]interface{}{"A": 111}, 1}, + {"a", 1}, + {[]string{"a", "b", "c"}, 2}, + {map[string]interface{}{"a": 123, "b": 223, "c": 323}, 2}, + } + + for _, data := range testData { + if !assert.True(t, GreaterOrEqualsLength(t, data.expected, data.raw)) { + t.Fail() + } + } +} diff --git a/internal/builtin/function.go b/internal/builtin/function.go index d1d3dd3b..5554eaf6 100644 --- a/internal/builtin/function.go +++ b/internal/builtin/function.go @@ -2,10 +2,16 @@ package builtin import ( "crypto/md5" + "encoding/csv" "encoding/hex" + "io/ioutil" "math" "math/rand" + "path/filepath" + "strings" "time" + + "github.com/rs/zerolog/log" ) var Functions = map[string]interface{}{ @@ -13,7 +19,9 @@ var Functions = map[string]interface{}{ "sleep": sleep, // call with one argument "gen_random_string": genRandomString, // call with one argument "max": math.Max, // call with two arguments - "md5": MD5, + "md5": MD5, // call with one argument + "parameterize": loadFromCSV, + "P": loadFromCSV, } func init() { @@ -44,3 +52,33 @@ func MD5(str string) string { hasher.Write([]byte(str)) return hex.EncodeToString(hasher.Sum(nil)) } + +func loadFromCSV(path string) []map[string]interface{} { + path, err := filepath.Abs(path) + if err != nil { + log.Error().Str("path", path).Err(err).Msg("convert absolute path failed") + panic(err) + } + log.Info().Str("path", path).Msg("load csv file") + + file, err := ioutil.ReadFile(path) + if err != nil { + log.Error().Err(err).Msg("load csv file failed") + panic(err) + } + r := csv.NewReader(strings.NewReader(string(file))) + content, err := r.ReadAll() + if err != nil { + log.Error().Err(err).Msg("parse csv file failed") + panic(err) + } + var result []map[string]interface{} + for i := 1; i < len(content); i++ { + row := make(map[string]interface{}) + for j := 0; j < len(content[i]); j++ { + row[content[0][j]] = content[i][j] + } + result = append(result, row) + } + return result +} diff --git a/models.go b/models.go index 9ee1fd89..ebd254b1 100644 --- a/models.go +++ b/models.go @@ -1,5 +1,11 @@ package hrp +import ( + "math/rand" + "sync" + "time" +) + const ( httpGET string = "GET" httpHEAD string = "HEAD" @@ -13,14 +19,69 @@ const ( // TConfig represents config data structure for testcase. // Each testcase should contain one config part. type TConfig struct { - Name string `json:"name" yaml:"name"` // required - Verify bool `json:"verify,omitempty" yaml:"verify,omitempty"` - BaseURL string `json:"base_url,omitempty" yaml:"base_url,omitempty"` - Variables map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty"` - Parameters map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"` - Export []string `json:"export,omitempty" yaml:"export,omitempty"` - Weight int `json:"weight,omitempty" yaml:"weight,omitempty"` - Path string `json:"path,omitempty" yaml:"path,omitempty"` // testcase file path + Name string `json:"name" yaml:"name"` // required + Verify bool `json:"verify,omitempty" yaml:"verify,omitempty"` + BaseURL string `json:"base_url,omitempty" yaml:"base_url,omitempty"` + Variables map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty"` + Parameters map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"` + ParametersSetting *TParamsConfig `json:"parameters_setting,omitempty" yaml:"parameters_setting,omitempty"` + Export []string `json:"export,omitempty" yaml:"export,omitempty"` + Weight int `json:"weight,omitempty" yaml:"weight,omitempty"` + Path string `json:"path,omitempty" yaml:"path,omitempty"` // testcase file path +} + +type TParamsConfig struct { + Strategy interface{} `json:"strategy,omitempty" yaml:"strategy,omitempty"` + Iteration int `json:"iteration,omitempty" yaml:"iteration,omitempty"` + Iterators []*Iterator `json:"parameterIterator,omitempty" yaml:"parameterIterator,omitempty"` //保存参数的迭代器 +} + +const ( + strategyRandom string = "random" + strategySequential string = "Sequential" +) + +type paramsType []map[string]interface{} + +type Iterator struct { + sync.Mutex + data paramsType + strategy string // random, sequential + iteration int + index int +} + +func (params paramsType) Iterator() *Iterator { + return &Iterator{ + data: params, + iteration: len(params), + index: 0, + } +} + +func (iter *Iterator) HasNext() bool { + if iter.iteration == -1 { + return true + } + return iter.index < iter.iteration +} + +func (iter *Iterator) Next() (value map[string]interface{}) { + iter.Lock() + defer iter.Unlock() + if len(iter.data) == 0 { + iter.index++ + return map[string]interface{}{} + } + if iter.strategy == strategyRandom { + randSource := rand.New(rand.NewSource(time.Now().Unix())) + randIndex := randSource.Intn(len(iter.data)) + value = iter.data[randIndex] + } else { + value = iter.data[iter.index%len(iter.data)] + } + iter.index++ + return value } // Request represents HTTP request data structure. diff --git a/parser.go b/parser.go index b9041d0c..7b9a9727 100644 --- a/parser.go +++ b/parser.go @@ -9,6 +9,7 @@ import ( "strings" "github.com/maja42/goval" + "github.com/pkg/errors" "github.com/rs/zerolog/log" "github.com/httprunner/hrp/internal/builtin" @@ -515,3 +516,179 @@ func findallVariables(raw string) variableSet { return varSet } + +func genCartesianProduct(paramsMap map[string]paramsType) paramsType { + if len(paramsMap) == 0 { + return nil + } + var params []paramsType + for _, v := range paramsMap { + params = append(params, v) + } + var cartesianProduct paramsType + cartesianProduct = params[0] + for i := 0; i < len(params)-1; i++ { + var tempProduct paramsType + for _, param1 := range cartesianProduct { + for _, param2 := range params[i+1] { + tempProduct = append(tempProduct, mergeVariables(param1, param2)) + } + } + cartesianProduct = tempProduct + } + return cartesianProduct +} + +func parseParameters(parameters map[string]interface{}, variablesMapping map[string]interface{}) (map[string]paramsType, error) { + if len(parameters) == 0 { + return nil, nil + } + parsedParametersSlice := make(map[string]paramsType) + var err error + for k, v := range parameters { + var parameterSlice paramsType + rawValue := reflect.ValueOf(v) + switch rawValue.Kind() { + case reflect.String: + // e.g. username-password: ${parameterize(examples/account.csv)} -> [{"username": "test1", "password": "111111"}, {"username": "test2", "password": "222222"}] + var parsedParameterContent interface{} + parsedParameterContent, err = parseString(rawValue.String(), variablesMapping, nil) + if err != nil { + log.Error().Interface("parameterContent", rawValue).Msg("[parseParameters] parse parameter content error") + return nil, err + } + parsedParameterRawValue := reflect.ValueOf(parsedParameterContent) + if parsedParameterRawValue.Kind() != reflect.Slice { + log.Error().Interface("parameterContent", parsedParameterRawValue).Msg("[parseParameters] parsed parameter content should be slice") + return nil, errors.New("parsed parameter content should be slice") + } + parameterSlice, err = parseSlice(k, parsedParameterRawValue.Interface()) + case reflect.Slice: + // e.g. user_agent: ["iOS/10.1", "iOS/10.2"] -> [{"user_agent": "iOS/10.1"}, {"user_agent": "iOS/10.2"}] + parameterSlice, err = parseSlice(k, rawValue.Interface()) + default: + log.Error().Interface("parameter", parameters).Msg("[parseParameters] parameter content should be slice or text(functions call)") + return nil, errors.New("parameter content should be slice or text(functions call)") + } + if err != nil { + return nil, err + } + parsedParametersSlice[k] = parameterSlice + } + return parsedParametersSlice, nil +} + +func parseSlice(parameterName string, parameterContent interface{}) ([]map[string]interface{}, error) { + parameterNameSlice := strings.Split(parameterName, "-") + var parameterSlice []map[string]interface{} + parameterContentSlice := reflect.ValueOf(parameterContent) + if parameterContentSlice.Kind() != reflect.Slice { + return nil, errors.New("parameterContent should be slice") + } + for i := 0; i < parameterContentSlice.Len(); i++ { + parameterMap := make(map[string]interface{}) + elem := reflect.ValueOf(parameterContentSlice.Index(i).Interface()) + switch elem.Kind() { + case reflect.Map: + // e.g. "username-password": [{"username": "test1", "password": "passwd1", "other": "111"}, {"username": "test2", "password": "passwd2", "other": ""222}] + // -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] + for _, key := range parameterNameSlice { + if _, ok := elem.Interface().(map[string]interface{})[key]; ok { + parameterMap[key] = elem.MapIndex(reflect.ValueOf(key)).Interface() + } else { + log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name not found") + return nil, errors.New("parameter name not found") + } + } + case reflect.Slice: + // e.g. "username-password": [["test1", "passwd1"], ["test2", "passwd2"]] + // -> [{"username": "test1", "password": "passwd1"}, {"username": "test2", "password": "passwd2"}] + if len(parameterNameSlice) != elem.Len() { + log.Error().Interface("parameterNameSlice", parameterNameSlice).Interface("parameterContent", elem.Interface()).Msg("[parseParameters] parameter name slice and parameter content slice should have the same length") + return nil, errors.New("parameter name slice and parameter content slice should have the same length") + } else { + for j := 0; j < elem.Len(); j++ { + parameterMap[parameterNameSlice[j]] = elem.Index(j).Interface() + } + } + default: + // e.g. "app_version": [3.1, 3.0] + // -> [{"app_version": 3.1}, {"app_version": 3.0}] + if len(parameterNameSlice) != 1 { + log.Error().Interface("parameterNameSlice", parameterNameSlice).Msg("[parseParameters] parameter name slice should have only one element when parameter content is string") + return nil, errors.New("parameter name slice should have only one element when parameter content is string") + } + parameterMap[parameterNameSlice[0]] = elem.Interface() + } + parameterSlice = append(parameterSlice, parameterMap) + } + return parameterSlice, nil +} + +func initParameterIterator(cfg *TConfig, mode string) (err error) { + var parameters map[string]paramsType + parameters, err = parseParameters(cfg.Parameters, cfg.Variables) + if err != nil { + return err + } + // parse config parameters setting + if cfg.ParametersSetting == nil { + cfg.ParametersSetting = &TParamsConfig{Iterators: []*Iterator{}} + } + // boomer模式下不限制迭代次数 + if mode == "boomer" { + cfg.ParametersSetting.Iteration = -1 + } + rawValue := reflect.ValueOf(cfg.ParametersSetting.Strategy) + switch rawValue.Kind() { + case reflect.Map: + // strategy: {"user_agent": "sequential", "username-password": "random"}, 每个参数对应一个迭代器，每个迭代器随机、顺序选取元素互不影响 + for k, v := range parameters { + if _, ok := rawValue.Interface().(map[string]interface{})[k]; ok { + // use strategy if configured + cfg.ParametersSetting.Iterators = append( + cfg.ParametersSetting.Iterators, + newIterator(v, rawValue.MapIndex(reflect.ValueOf(k)).Interface().(string), cfg.ParametersSetting.Iteration), + ) + } else { + // use sequential strategy by default + cfg.ParametersSetting.Iterators = append( + cfg.ParametersSetting.Iterators, + newIterator(v, strategySequential, cfg.ParametersSetting.Iteration), + ) + } + } + case reflect.String: + // strategy: random, 仅生成一个的迭代器，该迭代器在参数笛卡尔积slice中随机选取元素 + if len(rawValue.String()) == 0 { + cfg.ParametersSetting.Strategy = strategySequential + } else { + cfg.ParametersSetting.Strategy = strings.ToLower(rawValue.String()) + } + cfg.ParametersSetting.Iterators = append( + cfg.ParametersSetting.Iterators, + newIterator(genCartesianProduct(parameters), cfg.ParametersSetting.Strategy.(string), cfg.ParametersSetting.Iteration), + ) + default: + // default strategy: sequential, 仅生成一个的迭代器，该迭代器在参数笛卡尔积slice中顺序选取元素 + cfg.ParametersSetting.Strategy = strategySequential + cfg.ParametersSetting.Iterators = append( + cfg.ParametersSetting.Iterators, + newIterator(genCartesianProduct(parameters), cfg.ParametersSetting.Strategy.(string), cfg.ParametersSetting.Iteration), + ) + } + return nil +} + +func newIterator(parameters paramsType, strategy string, iteration int) *Iterator { + iter := parameters.Iterator() + iter.strategy = strategy + if iteration > 0 { + iter.iteration = iteration + } else if iteration < 0 { + iter.iteration = -1 + } else if iter.iteration == 0 { + iter.iteration = 1 + } + return iter +} diff --git a/parser_test.go b/parser_test.go index d7629fd8..abb0136a 100644 --- a/parser_test.go +++ b/parser_test.go @@ -622,3 +622,133 @@ func TestFindallVariables(t *testing.T) { } } } + +func TestParseParameters(t *testing.T) { + testData := []struct { + rawVars map[string]interface{} + expectLength int + }{ + { + map[string]interface{}{ + "username-password": "${parameterize(examples/account.csv)}", + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + 6, + }, + { + map[string]interface{}{ + "username-password": [][]interface{}{{"test1", "111111"}, {"test2", "222222"}, {"test3", "333333"}}, + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}, + "app_version": []interface{}{0.3}}, + 6, + }, + { + map[string]interface{}{ + "username-password": [][]interface{}{{"test1", "111111"}, {"test2", "222222"}, {"test3", "333333"}}, + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}, + "app_version": []interface{}{0.3, 0.4, 0.5}}, + 18, + }, + { + map[string]interface{}{}, 0, + }, + { + nil, 0, + }, + } + for _, data := range testData { + params, _ := parseParameters(data.rawVars, map[string]interface{}{}) + value := genCartesianProduct(params) + if !assert.Len(t, value, data.expectLength) { + t.Fail() + } + } +} + +func TestParseParametersError(t *testing.T) { + testData := []struct { + rawVars map[string]interface{} + }{ + { + map[string]interface{}{ + "username_password": "${parameterize(examples/account.csv)}", + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + }, + { + map[string]interface{}{ + "username-password": "${parameterize(examples/account.csv)}", + "user-agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + }, + { + map[string]interface{}{ + "username-password": "${param(examples/account.csv)}", + "user_agent": []interface{}{"IOS/10.1", "IOS/10.2"}}, + }, + } + for _, data := range testData { + _, err := parseParameters(data.rawVars, map[string]interface{}{}) + if !assert.Error(t, err) { + t.Fail() + } + } +} + +func TestParseSlice(t *testing.T) { + testData := []struct { + rawVar1 string + rawVar2 interface{} + expect []map[string]interface{} + }{ + { + "username-password", + []map[string]interface{}{{"username": "test1", "password": 111111, "other": "111"}, {"username": "test2", "password": 222222, "other": "222"}}, + []map[string]interface{}{ + {"username": "test1", "password": 111111}, + {"username": "test2", "password": 222222}, + }, + }, + { + "username-password", + [][]string{{"test1", "111111"}, {"test2", "222222"}}, + []map[string]interface{}{ + {"username": "test1", "password": "111111"}, + {"username": "test2", "password": "222222"}, + }, + }, + { + "app_version", + []float64{3.1, 3.0}, + []map[string]interface{}{ + {"app_version": 3.1}, + {"app_version": 3.0}, + }, + }, + } + for _, data := range testData { + value, _ := parseSlice(data.rawVar1, data.rawVar2) + if !assert.Equal(t, data.expect, value) { + t.Fail() + } + } +} + +func TestParseSliceError(t *testing.T) { + testData := []struct { + rawVar1 string + rawVar2 interface{} + }{ + { + "app_version", + 123, + }, + { + "app_version", + "123", + }, + } + for _, data := range testData { + _, err := parseSlice(data.rawVar1, data.rawVar2) + if !assert.Error(t, err) { + t.Fail() + } + } +} diff --git a/runner.go b/runner.go index 737b33fc..a6d425dc 100644 --- a/runner.go +++ b/runner.go @@ -32,11 +32,11 @@ func Run(testcases ...ITestCase) error { } // NewRunner constructs a new runner instance. -func NewRunner(t *testing.T) *hrpRunner { +func NewRunner(t *testing.T) *HRPRunner { if t == nil { t = &testing.T{} } - return &hrpRunner{ + return &HRPRunner{ t: t, failfast: true, // default to failfast debug: false, // default to turn off debug @@ -49,7 +49,7 @@ func NewRunner(t *testing.T) *hrpRunner { } } -type hrpRunner struct { +type HRPRunner struct { t *testing.T failfast bool debug bool @@ -57,21 +57,21 @@ type hrpRunner struct { } // SetFailfast configures whether to stop running when one step fails. -func (r *hrpRunner) SetFailfast(failfast bool) *hrpRunner { +func (r *HRPRunner) SetFailfast(failfast bool) *HRPRunner { log.Info().Bool("failfast", failfast).Msg("[init] SetFailfast") r.failfast = failfast return r } // SetDebug configures whether to log HTTP request and response content. -func (r *hrpRunner) SetDebug(debug bool) *hrpRunner { +func (r *HRPRunner) SetDebug(debug bool) *HRPRunner { log.Info().Bool("debug", debug).Msg("[init] SetDebug") r.debug = debug return r } // SetProxyUrl configures the proxy URL, which is usually used to capture HTTP packets for debugging. -func (r *hrpRunner) SetProxyUrl(proxyUrl string) *hrpRunner { +func (r *HRPRunner) SetProxyUrl(proxyUrl string) *HRPRunner { log.Info().Str("proxyUrl", proxyUrl).Msg("[init] SetProxyUrl") p, err := url.Parse(proxyUrl) if err != nil { @@ -86,7 +86,7 @@ func (r *hrpRunner) SetProxyUrl(proxyUrl string) *hrpRunner { } // Run starts to execute one or multiple testcases. -func (r *hrpRunner) Run(testcases ...ITestCase) error { +func (r *HRPRunner) Run(testcases ...ITestCase) error { event := ga.EventTracking{ Category: "RunAPITests", Action: "hrp run", @@ -102,15 +102,31 @@ func (r *hrpRunner) Run(testcases ...ITestCase) error { log.Error().Err(err).Msg("[Run] convert ITestCase interface to TestCase struct failed") return err } - if err := r.newCaseRunner(testcase).run(); err != nil { - log.Error().Err(err).Msg("[Run] run testcase failed") + cfg := testcase.Config.ToStruct() + // parse config parameters + err = initParameterIterator(cfg, "runner") + if err != nil { + log.Error().Interface("parameters", cfg.Parameters).Err(err).Msg("parse config parameters failed") return err } + // 在runner模式下，指定整体策略，cfg.ParametersSetting.Iterators仅包含一个CartesianProduct的迭代器 + for it := cfg.ParametersSetting.Iterators[0]; it.HasNext(); { + // iterate through all parameter iterators and update case variables + for _, it := range cfg.ParametersSetting.Iterators { + if it.HasNext() { + cfg.Variables = mergeVariables(it.Next(), cfg.Variables) + } + } + if err := r.newCaseRunner(testcase).run(); err != nil { + log.Error().Err(err).Msg("[Run] run testcase failed") + return err + } + } } return nil } -func (r *hrpRunner) newCaseRunner(testcase *TestCase) *caseRunner { +func (r *HRPRunner) newCaseRunner(testcase *TestCase) *caseRunner { caseRunner := &caseRunner{ TestCase: testcase, hrpRunner: r, @@ -123,7 +139,7 @@ func (r *hrpRunner) newCaseRunner(testcase *TestCase) *caseRunner { // each testcase has its own caseRunner instance and share session variables. type caseRunner struct { *TestCase - hrpRunner *hrpRunner + hrpRunner *HRPRunner sessionVariables map[string]interface{} // transactions stores transaction timing info. // key is transaction name, value is map of transaction type and time, e.g. start time and end time. @@ -147,17 +163,16 @@ func (r *caseRunner) run() error { if err := r.parseConfig(config); err != nil { return err } - + cfg := config.ToStruct() log.Info().Str("testcase", config.Name()).Msg("run testcase start") + r.startTime = time.Now() for index := range r.TestCase.TestSteps { - _, err := r.runStep(index) + _, err := r.runStep(index, cfg) if err != nil { if r.hrpRunner.failfast { - log.Error().Err(err).Msg("abort running due to failfast setting") - return err + return errors.Wrap(err, "abort running due to failfast setting") } - log.Warn().Err(err).Msg("run step failed, continue next step") } } @@ -165,8 +180,7 @@ func (r *caseRunner) run() error { return nil } -func (r *caseRunner) runStep(index int) (stepResult *stepData, err error) { - config := r.TestCase.Config +func (r *caseRunner) runStep(index int, caseConfig *TConfig) (stepResult *stepData, err error) { step := r.TestCase.TestSteps[index] // step type priority order: transaction > rendezvous > testcase > request @@ -186,23 +200,18 @@ func (r *caseRunner) runStep(index int) (stepResult *stepData, err error) { log.Error().Err(err).Msg("copy step data failed") return nil, err } - copiedConfig := &TConfig{} - if err = copier.Copy(copiedConfig, config.ToStruct()); err != nil { - log.Error().Err(err).Msg("copy config data failed") - return nil, err - } stepVariables := copiedStep.Variables // override variables // step variables > session variables (extracted variables from previous steps) stepVariables = mergeVariables(stepVariables, r.sessionVariables) // step variables > testcase config variables - stepVariables = mergeVariables(stepVariables, copiedConfig.Variables) + stepVariables = mergeVariables(stepVariables, caseConfig.Variables) // parse step variables parsedVariables, err := parseVariables(stepVariables, r.pluginLoader) if err != nil { - log.Error().Interface("variables", copiedConfig.Variables).Err(err).Msg("parse step variables failed") + log.Error().Interface("variables", caseConfig.Variables).Err(err).Msg("parse step variables failed") return nil, err } copiedStep.Variables = parsedVariables // avoid data racing @@ -219,7 +228,7 @@ func (r *caseRunner) runStep(index int) (stepResult *stepData, err error) { } } else { // run request - copiedStep.Request.URL = buildURL(copiedConfig.BaseURL, copiedStep.Request.URL) // avoid data racing + copiedStep.Request.URL = buildURL(caseConfig.BaseURL, copiedStep.Request.URL) // avoid data racing stepResult, err = r.runStepRequest(copiedStep) if err != nil { log.Error().Err(err).Msg("run request step failed") @@ -553,7 +562,7 @@ func (r *caseRunner) loadPlugin(path string) error { return nil } -func (r *hrpRunner) getSummary() *testCaseSummary { +func (r *caseRunner) getSummary() *testCaseSummary { return &testCaseSummary{} } diff --git a/step_test.go b/step_test.go index 5fdd3c02..d7e3ee17 100644 --- a/step_test.go +++ b/step_test.go @@ -79,10 +79,10 @@ func TestRunRequestRun(t *testing.T) { TestSteps: []IStep{stepGET, stepPOSTData}, } runner := NewRunner(t).SetDebug(true).newCaseRunner(testcase) - if _, err := runner.runStep(0); err != nil { + if _, err := runner.runStep(0, testcase.Config.ToStruct()); err != nil { t.Fatalf("tStep.Run() error: %s", err) } - if _, err := runner.runStep(1); err != nil { + if _, err := runner.runStep(1, testcase.Config.ToStruct()); err != nil { t.Fatalf("tStepPOSTData.Run() error: %s", err) } } diff --git a/validate.go b/validate.go index f5d67a8a..8e2e857b 100644 --- a/validate.go +++ b/validate.go @@ -35,6 +35,94 @@ func (s *StepRequestValidation) AssertEqual(jmesPath string, expected interface{ return s } +func (s *StepRequestValidation) AssertGreater(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "greater_than", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLess(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "less_than", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertGreaterOrEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "greater_or_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLessOrEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "less_or_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertNotEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "not_equal", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertContains(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "contains", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertTypeMatch(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "type_match", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertRegexp(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "regex_match", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + func (s *StepRequestValidation) AssertStartsWith(jmesPath string, expected interface{}, msg string) *StepRequestValidation { v := Validator{ Check: jmesPath, @@ -67,3 +155,70 @@ func (s *StepRequestValidation) AssertLengthEqual(jmesPath string, expected inte s.step.Validators = append(s.step.Validators, v) return s } + + +func (s *StepRequestValidation) AssertContainedBy(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "contained_by", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLengthLessThan(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "length_less_than", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertStringEqual(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "string_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLengthLessOrEquals(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "length_less_or_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLengthGreaterThan(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "length_greater_than", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +} + +func (s *StepRequestValidation) AssertLengthGreaterOrEquals(jmesPath string, expected interface{}, msg string) *StepRequestValidation { + v := Validator{ + Check: jmesPath, + Assert: "length_greater_or_equals", + Expect: expected, + Message: msg, + } + s.step.Validators = append(s.step.Validators, v) + return s +}