commit cba529dd3b415f29a2cb4a101f7feae6d4645a63 Author: Kirill Sosnovskikh Date: Fri Aug 2 15:56:22 2024 +0300 Initial commit Signed-off-by: Kirill Sosnovskikh diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..393cb37 --- /dev/null +++ b/.gitignore @@ -0,0 +1,31 @@ +# ignore IDE files +.vscode +.idea + +.DS_Store +venv.* +venv_macos +/build + + +# ignore test results +**/log.html +**/output.xml +**/report.html +**/dockerlogs*.tar.gz +allure_results/* +xunit_results.xml + +# ignore caches under any path +**/__pycache__ +**/.pytest_cache +*.egg-info + +# ignore work directories and setup files +.setup +.env +TemporaryDir/* +artifacts/* +docs/* +venv.*/* +wallet_config.yml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..032a87d --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,15 @@ +repos: + - repo: https://github.com/psf/black + rev: 22.8.0 + hooks: + - id: black + language_version: python3.10 + - repo: https://github.com/pycqa/isort + rev: 5.12.0 + hooks: + - id: isort + name: isort (python) + +ci: + autofix_prs: false + autoupdate_schedule: quarterly diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..245c800 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @JuliaKovshova @abereziny @anikeev-yadro @Kiriruso diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..fcd3f37 --- /dev/null +++ b/Makefile @@ -0,0 +1,37 @@ +SHELL := /bin/bash +PYTHON_VERSION := 3.10 +VENV_NAME = allure-validator-${PYTHON_VERSION} +VENV_DIR := venv.${VENV_NAME} + +current_dir := $(shell pwd) +FROM_VENV := . ${VENV_DIR}/bin/activate && + +venv: create requirements paths precommit + @echo Ready + +precommit: + @echo Isntalling pre-commit hooks + ${FROM_VENV} pre-commit install + +paths: + @echo Append paths for project + @echo Virtual environment: ${VENV_DIR} + @rm -rf ${VENV_DIR}/lib/python${PYTHON_VERSION}/site-packages/_paths.pth + @touch ${VENV_DIR}/lib/python${PYTHON_VERSION}/site-packages/_paths.pth + @echo ${current_dir} | tee ${VENV_DIR}/lib/python${PYTHON_VERSION}/site-packages/_paths.pth + +create: ${VENV_DIR} + +${VENV_DIR}: + @echo Create virtual environment ${VENV_DIR} + virtualenv --python=python${PYTHON_VERSION} --prompt=${VENV_NAME} ${VENV_DIR} + +requirements: + @echo Isntalling pip requirements + ${FROM_VENV} pip install -Ur requirements.txt + ${FROM_VENV} pip install -Ur requirements_dev.txt + + +#### VALIDATION SECTION #### +lint: create requirements + ${FROM_VENV} pylint --disable R,C,W pytest_tests diff --git a/README.md b/README.md new file mode 100644 index 0000000..918da9b --- /dev/null +++ b/README.md @@ -0,0 +1,104 @@ +# allure-validator + +Linter for checking uniqueness and correctness of `allure.title` in the entire test database. + +## Installation + +```shell +pip install git+https://git.frostfs.info/TrueCloudLab/allure-validator.git@master +``` + +## Usage + +To start, simply specify the folder with the test database that needs to be checked: + +```shell +allure-validator +``` + +Additionally, `allure-validator` can be added to pre-commit hooks: +```yaml +# .pre-commit-config.yaml +repos: + - repo: local + hooks: + - id: allure-validator + name: allure-validator + entry: allure-validator + language: system + args: ["pytest_tests/"] # folder with tests + pass_filenames: false + types: [python] +``` + +### Ignore mechanism + +The linter can be made to ignore functions/classes. To do this, just write a comment `# noqa: allure-validator` to the right of the function/class name. For example: + +```python +@pytest.mark.parametrize("test_param", [1, 2]) +def test_ignored_function(test_param): # noqa: allure-validator + ... + + +@pytest.mark.parametrize("class_param", [1, 2]) +class TestIngoredClass: # noqa: allure-validator + def test_1(self, class_param): + ... + + def test_2(self, class_param): + ... +``` + +> Note: this may also miss fixtures, so use with caution. + +## Work example + +Let's run the linter for some [sample tests](https://git.frostfs.info/Kiriruso/allure-validator/src/branch/master/tests): + +```shell +NOT UNIQUE TITLE: Not unique test +In the following tests: + tests/test_validator.py:20:0: title is not unique by `test_not_unique_2` + tests/test_validator.py:119:4: title is not unique by `test_not_unique_3` + tests/test_validator.py:15:0: title is not unique by `test_not_unique_1` + +NOT UNIQUE TITLE: Test title +In the following tests: + tests/test_validator.py:30:0: title is not unique by `test_title_not_unique_2` + tests/test_validator.py:25:0: title is not unique by `test_title_not_unique_1` + +tests/test_validator.py:5:0: EMPTY TITLE: Missing title in `test_empty_title` +tests/test_validator.py:10:0: EMPTY TITLE: Missing title in `test_empty_title_2` +tests/test_validator.py:20:0: MISSING PARAMS: Parameters are missing from title: object_size +tests/test_validator.py:62:0: MISSING PARAMS: Parameters are missing from title: param_two OR param_three +tests/test_validator.py:115:4: MISSING PARAMS: Parameters are missing from title: root_fixture +tests/test_validator.py:119:4: MISSING PARAMS: Parameters are missing from title: param_class_1 +``` + +## Undetectable cases + +Since the linter works with AST python code, any dynamic titles will not be found. For example: + +```python +import allure + + +def test_example(): + data = 10 + allure.dynamic.title(f"Dynamic title {data}") # Undetected title + ... + +``` + +Dynamic fixtures are only supported if they are declared in `pytest_generate_tests`: + +```python +def pytest_generate_tests(metafunc): + ... + metafunc.parametrize("fixture1, fixture2", [(1, 2), (3, 4)]) # OK + ... + +``` + +Plugins are not supported (**temporarily**), so fixtures and tests from there cannot be found. \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..6c0cd57 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,42 @@ +[build-system] +requires = ["setuptools>=65.0.0", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "allure-validator" +version = "1.0.0" +description = "Linter for allure.title validation" +readme = "README.md" +authors = [{ name = "YADRO", email = "info@yadro.com" }] +license = { text = "GNU General Public License v3 (GPLv3)" } +classifiers = [ + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Programming Language :: Python", + "Programming Language :: Python :: 3", +] +keywords = ["test", "allure"] +dependencies = [ + "allure-pytest>=2.13.2", + "allure-python-commons>=2.13.2", + "pytest>=7.1.2", + "pytest-lazy-fixture>=0.6.3" +] +requires-python = "==3.10.*" + +[project.optional-dependencies] +dev = ["black", "pylint", "isort", "pre-commit"] + +[project.scripts] +allure-validator = "allure_validator.main:main" + +[project.urls] +Homepage = "https://git.frostfs.info/Kiriruso/allure-validator/" + +[tool.isort] +profile = "black" +src_paths = ["src"] +line_length = 140 + +[tool.black] +line-length = 140 +target-version = ["py310"] diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..96c3d4b --- /dev/null +++ b/pytest.ini @@ -0,0 +1,7 @@ +[pytest] +log_cli = 1 +log_cli_level = DEBUG +log_cli_format = %(asctime)s [%(levelname)4s] %(message)s +log_format = %(asctime)s [%(levelname)4s] %(message)s +log_cli_date_format = %Y-%m-%d %H:%M:%S +log_date_format = %H:%M:%S diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6a24a5c --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +allure-pytest==2.13.2 +allure-python-commons==2.13.2 +pytest==7.1.2 +pytest-lazy-fixture==0.6.3 \ No newline at end of file diff --git a/requirements_dev.txt b/requirements_dev.txt new file mode 100644 index 0000000..b2d249b --- /dev/null +++ b/requirements_dev.txt @@ -0,0 +1,4 @@ +pre-commit==2.20.0 +isort==5.12.0 +pylint==2.17.4 +black==24.8.0 \ No newline at end of file diff --git a/src/allure_validator/__init__.py b/src/allure_validator/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/allure_validator/arguments.py b/src/allure_validator/arguments.py new file mode 100644 index 0000000..cd5b866 --- /dev/null +++ b/src/allure_validator/arguments.py @@ -0,0 +1,10 @@ +import argparse + +parser = argparse.ArgumentParser( + "pyfactoring", + "%(prog)s ", + "Linter for allure.title validation", +) +parser.add_argument("folder", type=str, help="folder with tests") + +args = parser.parse_args() diff --git a/src/allure_validator/collect.py b/src/allure_validator/collect.py new file mode 100644 index 0000000..e0343bd --- /dev/null +++ b/src/allure_validator/collect.py @@ -0,0 +1,267 @@ +import ast +import os +from pathlib import Path + +from allure_validator import parse +from allure_validator.common import ATTR_CLASS_NAME, ATTR_PATH, PYTEST_GENERATE_TESTS, PYTEST_METAFUNC_PARAMETRIZE, PYTEST_PARAMETRIZE +from allure_validator.pytest_items import ASTPytestItems, Fixture, Test + + +def paths(folder: str) -> list[Path]: + """ + Collects paths to all .py files in directories with tests. + + Args: + folder: Path to the folder with tests. + + Returns: + list[Path]: List of paths to .py files. + """ + + if not os.path.isdir(folder): + raise NotADirectoryError(f"Path '{folder}' does not point to a directory") + + paths = [] + files_or_dirs = [fod for fod in os.scandir(folder) if not (fod.name.startswith(".") or fod.name.startswith("_"))] + + for fod in files_or_dirs: + if fod.is_file() and fod.name.endswith(".py"): + paths.append(Path(fod)) + continue + + for folder, _, files in os.walk(fod): + paths.extend([Path(folder) / file for file in files if file.endswith(".py")]) + + return paths + + +def ast_pytest_items(paths: list[Path]) -> ASTPytestItems: + """ + Collects AST objects of pytest tests, fixtures and hooks. + + Functions and classes with the comment `# noqa: allure-validator` are ignored + + Args: + paths: List of paths to .py files. + + Returns: + ASTPytestItems: An object containing sets of AST tests, fixtures and hooks. + """ + + items = ASTPytestItems() + + for path in paths: + with open(path, "r", encoding="utf-8") as f: + src = f.read() + module = ast.parse(src) + src = src.splitlines() + + for class_or_func in ast.iter_child_nodes(module): + if isinstance(class_or_func, ast.ClassDef): + if parse.is_ignore(class_or_func, src): + continue + + common_parameterization_decos = [ + deco for deco in class_or_func.decorator_list if parse.decorator(deco) == PYTEST_PARAMETRIZE + ] + ast_funcs = [func for func in class_or_func.body if isinstance(func, ast.FunctionDef)] + + for func in ast_funcs: + if parse.is_ignore(func, src): + continue + + # Dynamic attributes + setattr(func, ATTR_PATH, path) + setattr(func, ATTR_CLASS_NAME, class_or_func.name) + + if parse.is_fixture(func): + items.fixtures.append(func) + elif parse.is_test(func): + func.decorator_list.extend(common_parameterization_decos) + items.tests.append(func) + elif isinstance(class_or_func, ast.FunctionDef): + if parse.is_ignore(class_or_func, src): + continue + + # Dynamic attributes + setattr(class_or_func, ATTR_PATH, path) + setattr(class_or_func, ATTR_CLASS_NAME, None) + + if parse.is_fixture(class_or_func): + items.fixtures.append(class_or_func) + elif parse.is_test(class_or_func): + items.tests.append(class_or_func) + elif class_or_func.name == PYTEST_GENERATE_TESTS: + items.hooks.append(class_or_func) + + return items + + +def fixtures(ast_fixtures: list[ast.FunctionDef], ast_hooks: list[ast.FunctionDef]) -> dict[tuple, Fixture]: + """ + From AST objects it forms fixtures and connections between these fixtures. + + Args: + ast_fixtures: List of AST fixtures. + ast_hooks: List of AST hooks. + + Returns: + dict[tuple, Fixture]: A dictionary of fixtures, where each fixture has a name, a path, and a class name. + """ + + fixtures: dict[tuple, Fixture] = {} + + for ast_fixture in ast_fixtures: + path = getattr(ast_fixture, ATTR_PATH) + in_class = getattr(ast_fixture, ATTR_CLASS_NAME, None) + + args = [arg.arg for arg in ast_fixture.args.args if arg.arg != "self"] + params = parse.fixture_params(ast_fixture) + title = parse.title(ast_fixture) + + fixture = Fixture( + ast_fixture.name, + path, + ast_fixture.lineno, + ast_fixture.col_offset, + args, + params, + title=title, + in_class=in_class, + ) + fixtures[fixture] = fixture + + for ast_hook in ast_hooks: + path = getattr(ast_hook, ATTR_PATH) + for node in ast_hook.body: + if isinstance(node, ast.Expr): + if parse.decorator(node.value) == PYTEST_METAFUNC_PARAMETRIZE: + fixture_names = parse.param_names(node.value.args[0]) + for name in fixture_names: + # Dynamic fake fixture + fixture = Fixture( + name, + path, + node.lineno, + node.col_offset, + args=[], + params=["parametrized"], + ) + fixtures[fixture] = fixture + + for fixture in fixtures.values(): + for arg in fixture.args: + current_path = fixture.path + current_class = fixture.in_class + + while current_path.parent.name: + possible_fixture = (arg, current_path, current_class) + + if possible_fixture in fixtures.keys(): + depend = fixtures[possible_fixture] + fixture.depends.add(depend) + break + + # Finding fixture outside class + if current_class: + current_class = None + continue + + # Finding fixture from current file to root directory + is_conftest = current_path.name == "conftest.py" + current_path = current_path.parent.parent / "conftest.py" if is_conftest else current_path.parent / "conftest.py" + + # TODO: Finding fixture from plugins + + return fixtures + + +def tests(ast_tests: list[ast.FunctionDef], fixtures: dict[tuple, Fixture]) -> list[Test]: + """ + From AST objects it forms fixtures and connections between these fixtures. + + Args: + ast_tests: Tests are formed from AST objects. + fixtures: Needed to define dependencies for tests. + + Returns: + list[Test]: A list of tests for which all required dependencies are defined. + """ + + tests = [] + + for ast_test in ast_tests: + path = getattr(ast_test, ATTR_PATH) + in_class = getattr(ast_test, ATTR_CLASS_NAME, None) + + args = [arg.arg for arg in ast_test.args.args if arg.arg != "self"] + params = parse.test_params(ast_test) + title = parse.title(ast_test) + + test = Test( + ast_test.name, + path, + ast_test.lineno, + ast_test.col_offset, + args, + params.required, + title=title, + in_class=in_class, + ) + + depends = _only_parametirzed_depends(test, fixtures) + depends = {depend for depend in depends if depend.name not in params.optional} + + # Test parameters take precedence over fixtures + if params.required: + test.depends = {depend for params in params.required for depend in depends if depend.name not in params} + else: + test.depends = depends + + tests.append(test) + + return tests + + +def _all_depends(fixture: Fixture) -> set[Fixture]: + """Get all dependencies of the passed fixture.""" + + if not fixture.depends: + return {fixture} + + depends = {fixture} + for depend in fixture.depends: + depends.update(_all_depends(depend)) + + return depends + + +def _only_parametirzed_depends(test: Test, fixtures: dict[tuple, Fixture]) -> set[Fixture]: + """Get only parameterized dependencies for the given test.""" + + depends = set() + + for arg in test.args: + current_path = test.path + current_class = test.in_class + + while current_path.parent.name: + possible_fixture = (arg, current_path, current_class) + + if possible_fixture in fixtures.keys(): + fixture = fixtures[possible_fixture] + depends.update(depend for depend in _all_depends(fixture) if depend.parametrized) + break + + # Finding fixture outside class + if current_class: + current_class = None + continue + + # Finding fixture from current file to root directory + is_conftest = current_path.name == "conftest.py" + current_path = current_path.parent.parent / "conftest.py" if is_conftest else current_path.parent / "conftest.py" + + # TODO: Finding fixture from plugins + + return depends diff --git a/src/allure_validator/common.py b/src/allure_validator/common.py new file mode 100644 index 0000000..edc1952 --- /dev/null +++ b/src/allure_validator/common.py @@ -0,0 +1,16 @@ +ALLURE_TITLE = "allure.title" +REPORTER_TITLE = "reporter.title" + +PYTEST_FIXTURE = "pytest.fixture" +PYTEST_PARAMETRIZE = "pytest.mark.parametrize" +PYTEST_GENERATE_TESTS = "pytest_generate_tests" +PYTEST_METAFUNC_PARAMETRIZE = "metafunc.parametrize" + +ATTR_PATH = "__func_path" +ATTR_CLASS_NAME = "__class_name" + +VALIDATE_DONE = 0 +VALIDATE_ERROR = 1 +DIRECTORY_ERROR = 2 + +ALLURE_VALIDATOR_IGNORE = "noqa: allure-validator" diff --git a/src/allure_validator/main.py b/src/allure_validator/main.py new file mode 100644 index 0000000..b86fce8 --- /dev/null +++ b/src/allure_validator/main.py @@ -0,0 +1,40 @@ +import sys + +from allure_validator import collect, validate +from allure_validator.arguments import args +from allure_validator.common import DIRECTORY_ERROR, VALIDATE_DONE, VALIDATE_ERROR + + +def main(): + tests_folder = args.folder + + try: + paths = collect.paths(tests_folder) + except NotADirectoryError as e: + print(e) + sys.exit(DIRECTORY_ERROR) + + ast_items = collect.ast_pytest_items(paths) + fixtures = collect.fixtures(ast_items.fixtures, ast_items.hooks) + tests = collect.tests(ast_items.tests, fixtures) + validate_result = validate.titles(tests) + + if validate_result.errors == 0: + print(f"Done🎉\nFiles analyzed: {len(paths)}\nTests analyzed: {len(tests)}") + sys.exit(VALIDATE_DONE) + + for title, tests in validate_result.not_unique.items(): + print(f"NOT UNIQUE TITLE: {title}") + print("In the following tests:") + for test in tests: + print(f"\t{test.link}: title is not unique by `{test.name}`") + print() + + for test in validate_result.empty_title: + print(f"{test.link}: EMPTY TITLE: Missing title in `{test.name}`") + + for test, params in validate_result.missing_params: + params_str = " OR ".join(params) if isinstance(params, list) else params + print(f"{test.link}: MISSING PARAMS: Parameters are missing from title: {params_str}") + + sys.exit(VALIDATE_ERROR) diff --git a/src/allure_validator/parse.py b/src/allure_validator/parse.py new file mode 100644 index 0000000..b3ed3d2 --- /dev/null +++ b/src/allure_validator/parse.py @@ -0,0 +1,143 @@ +import ast +import re + +from allure_validator.common import ALLURE_TITLE, ALLURE_VALIDATOR_IGNORE, PYTEST_FIXTURE, PYTEST_PARAMETRIZE, REPORTER_TITLE +from allure_validator.pytest_items import TestParams + + +def decorator(deco: ast.Call | ast.Attribute) -> str: + """ + Retrieves the decorator name as a string. + + Args: + deco: AST decorator object. + + Returns: + str: Decorator's name. + """ + + if isinstance(deco, ast.Call): + return ast.unparse(deco.func) + return ast.unparse(deco) + + +def decorated_as(pattern: str, func: ast.FunctionDef) -> bool: + """ + Check if the passed function can be decorated with the given pattern. + + Args: + pattern: The pattern that the decorator of the passed function must conform to. + func: The function for which the check is performed. + + Returns: + bool: True if there is a decorator with the given pattern. + """ + + return any(True for deco in func.decorator_list if decorator(deco) == pattern) + + +def is_test(func: ast.FunctionDef) -> bool: + """Check if a function is a test.""" + + return bool(re.search(r"\btest_|_test\(", func.name)) + + +def is_fixture(func: ast.FunctionDef) -> bool: + """Check that the function is a fixture.""" + + return decorated_as(PYTEST_FIXTURE, func) + + +def is_ignore(class_or_func: ast.ClassDef | ast.FunctionDef, src: list[str]) -> bool: + return ALLURE_VALIDATOR_IGNORE in src[class_or_func.lineno - 1] + + +def title(func: ast.FunctionDef) -> str | None: + """ + Extracts the title text from the decorator of the passed function. + + The function must be decorated with `allure.title` or `reporter.title`. + + Args: + func: The function for which the title will be extracted. + + Returns: + str | None: Extracted text. + """ + + for deco in func.decorator_list: + if decorator(deco) in (ALLURE_TITLE, REPORTER_TITLE): + ast_title = deco.args[0] if deco.args else ast.Constant("") + raw_title = ast.unparse(ast_title) + return raw_title.lstrip("f").strip("\"'") + return None + + +def title_params(title: str) -> str: + """Parsing title parameters specified in the format `{param}`.""" + + params = re.findall(r"(?<=\{).+?(?=\})", title) if title else [] + return " ".join(params) + + +def test_params(func: ast.FunctionDef) -> TestParams: + """ + Extracts parameters for a test from `pytest.parametrize` decorators. + + Args: + func: The test for which extraction is required. + + Returns: + TestParams: An object containing mandatory and optional parameters. + """ + + optional = [] + required = [] + + for deco in func.decorator_list: + if decorator(deco) == PYTEST_PARAMETRIZE: + names = param_names(deco.args[0]) + + if len(deco.args[1].elts) == 1: + optional.extend(names) + else: + # The parameter list is just one required parameter + required.append(names) + + return TestParams(required, optional) + + +def fixture_params(func: ast.FunctionDef) -> list[str]: + """ + Extracts parameters for the fixture from the `params` argument of the `pytest.fixture` decorator. + + Args: + func: A fixture that requires extraction. + + Returns: + list[str]: Fixture parameter names. + """ + + ast_params = [] + for deco in func.decorator_list: + if not isinstance(deco, ast.Call): + continue + + for keyword in deco.keywords: + if keyword.arg == "params": + ast_params.extend(keyword.value.elts) + + params = [] + for ast_param in ast_params: + for arg in ast_param.args: + params.append(ast.unparse(arg)) + + return params + + +def param_names(ast_names: ast.Constant | ast.List) -> list[str]: + """Generates a list of parameter names from `pytest.parametrize`.""" + + if isinstance(ast_names, ast.Constant): + return ast_names.value.replace(",", " ").split() + return [elt.value for elt in ast_names.elts] diff --git a/src/allure_validator/pytest_items.py b/src/allure_validator/pytest_items.py new file mode 100644 index 0000000..9a1fe66 --- /dev/null +++ b/src/allure_validator/pytest_items.py @@ -0,0 +1,67 @@ +import ast +from abc import ABC +from dataclasses import dataclass, field +from pathlib import Path + + +@dataclass(eq=False) +class Item(ABC): + """Represents a pytest object for ease of analysis.""" + + name: str + path: Path + lineno: int = field(repr=False) + colno: int = field(repr=False) + args: list[str] + params: list[str] + depends: set["Fixture"] = field(default_factory=set, repr=False) + title: str | None = field(default=None) + in_class: str | None = field(default=None) + + @property + def link(self) -> str: + return f"{self.path}:{self.lineno}:{self.colno}" + + +@dataclass(eq=False) +class Fixture(Item): + """Represents a pytest fixture object.""" + + def __hash__(self) -> int: + return hash((self.name, self.path, self.in_class)) + + def __eq__(self, other: "Fixture | tuple") -> bool: + if isinstance(other, Fixture): + return self.name == other.name and self.path == other.path and self.in_class == other.in_class + + if isinstance(other, tuple): + return (self.name, self.path, self.in_class) == other + + @property + def parametrized(self) -> bool: + return bool(self.params) + + +@dataclass(eq=False) +class Test(Item): + """Represents a pytest test object.""" + + params: list[list[str]] + title: str + + +@dataclass(frozen=True) +class TestParams: + """Represents a set of required and optional test parameters.""" + + required: list[list[str]] = field(default_factory=list) + optional: list[str] = field(default_factory=list) + + +@dataclass(eq=False) +class ASTPytestItems: + """Represents a set of pytest items: tests, fixtures and hooks.""" + + tests: list[ast.FunctionDef] = field(default_factory=list) + fixtures: list[ast.FunctionDef] = field(default_factory=list) + hooks: list[ast.FunctionDef] = field(default_factory=list) diff --git a/src/allure_validator/validate.py b/src/allure_validator/validate.py new file mode 100644 index 0000000..699f574 --- /dev/null +++ b/src/allure_validator/validate.py @@ -0,0 +1,85 @@ +import re +from collections import defaultdict +from dataclasses import dataclass, field + +from allure_validator import parse +from allure_validator.pytest_items import Test + + +@dataclass +class ValidateResult: + """ + Represents the result of validation of titles of all tests. + + Fields: + errors: Number of problems found during the analysis. + not_unique: Set of tests with non-unique titles. + empty_title: Set of tests with empty or missing titles. + missing_params: Set of tests that are missing required parameters in the title. + """ + + errors: int = 0 + not_unique: dict[str, list[Test]] = field(default_factory=lambda: defaultdict(list)) + empty_title: list[Test] = field(default_factory=list) + missing_params: list[tuple[Test, list[str]]] = field(default_factory=list) + + +def titles(tests: list[Test]) -> ValidateResult: + """ + Validation of titles of all found tests. + + Three cases for validation: + - Checking if each test has a title + - Checking the uniqueness of each title + - Checking the required test parameters and specifying them in the title. + + Args: + tests: Tests that will be validated. + + Returns: + ValidateResult: An object representing the problems found during validation. + """ + + result = ValidateResult() + title_to_test_map: dict[str, Test] = {} + + for test in tests: + if not test.title: + result.errors += 1 + result.empty_title.append(test) + + if test.title in title_to_test_map.keys(): + result.errors += 1 + result.not_unique[test.title].append(test) + elif test.title: + title_to_test_map[test.title] = test + + params_in_title = parse.title_params(test.title) + missing_params = [] + + for params in test.params: + missing = [] + + for param in params: + if re.search(rf"\b{param}\b", params_in_title): + missing.clear() + break + missing.append(param) + + if missing: + missing_params.append(missing) + + for depend in test.depends: + if not re.search(rf"\b{depend.name}\b", params_in_title): + missing_params.append(depend.name) + + if test.title and missing_params: + for missing in missing_params: + result.errors += 1 + result.missing_params.append((test, missing)) + + for title, test in title_to_test_map.items(): + if title in result.not_unique.keys(): + result.not_unique[title].append(test) + + return result diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..d560c27 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,36 @@ +import allure +import pytest + + +@pytest.fixture( + scope="function", + params=[ + pytest.param(1), + pytest.param(2), + ], +) +def object_size(request: pytest.FixtureRequest): + return request.param + + +@pytest.fixture +def file_path(object_size): + return 0 + + +@allure.title("[Function] Object fixture") +@pytest.fixture(scope="function") +def object_fixture(file_path): + return file_path + + +@allure.title("[Session] Parametrized fixture") +@pytest.fixture( + scope="session", + params=[ + pytest.param(1, marks=[pytest.mark.test_1]), + pytest.param(2, marks=[pytest.mark.test_2]), + ], +) +def parametrized_fixture(request: pytest.FixtureRequest): + return request.param diff --git a/tests/test_validator.py b/tests/test_validator.py new file mode 100644 index 0000000..7d49e5f --- /dev/null +++ b/tests/test_validator.py @@ -0,0 +1,164 @@ +import allure +import pytest + +# ============== DYNAMIC FIXTURE ============== # + + +def pytest_generate_tests(metafunc: pytest.Metafunc): + if "runtime_fixture" not in metafunc.fixturenames: + return + + metafunc.parametrize("runtime_fixture", [1, 2, 3]) + + +@allure.title("Test runtime fixture") +def test_runtime_fixture(runtime_fixture): + assert True + + +# ============== IGNORE ============== # + + +@allure.title("Ignored test") +@pytest.mark.parametrize("param_in_ignored_test", [1, 2, 3]) +def test_ignored(param_in_ignored_test): # noqa: allure-validator + assert True + + +# ============== EMPTY TITLE ============== # + + +def test_empty_title_1(): + assert True + + +# @allure.title() - even pytest complains about this +def test_empty_title_2(): + assert True + + +@allure.title("") +def test_empty_title_3(): + assert True + + +# ============== NOT UNIQUE ============== # + + +@allure.title("Not unique test") +def test_not_unique_1(): + assert True + + +@allure.title("Not unique test") +def test_not_unique_2(object_fixture): + assert True + + +@allure.title("Test title") +def test_title_not_unique_1(): + assert True + + +@allure.title("Test title") +def test_title_not_unique_2(): + assert True + + +# ============== MISSING PARAMS ============== # + + +@allure.title("Test: match (p1={p1}, p2={p2})") # One required, other optional +@pytest.mark.parametrize(["p1", "p2"], [[1, 2], [3, 4]]) +def test_multi_params(p1, p2): + assert True + + +@allure.title("Test: match (p1={p1})") # One required, other optional +@pytest.mark.parametrize("p1, p2, p3", [[1, 2, 3], [4, 5, 6], [7, 8, 9]]) +def test_str_params(p1, p2, p3): + assert True + + +@allure.title("Test: 1 (param_one={param_one}, param_two={param_two}, obj_size={object_size.value})") +@pytest.mark.parametrize("param_one", [1, 2]) # Required +@pytest.mark.parametrize("param_two", [3, 4]) # Required +def test_one(param_one: int, param_two: int, object_fixture: str): + assert True + + +@allure.title("Test: 2 (param_one={param_one}, param_three={param_three}, obj_size={object_size})") +@pytest.mark.parametrize("param_one", [1, 2]) # Required +@pytest.mark.parametrize( + ["param_two", "param_three"], # One required, other optional + [ + [3, 4], + [5, 6], + ], +) +def test_two(param_one: int, param_two: list, param_three: list, object_fixture: str): + assert True + + +@allure.title("Test: 3 (obj_size={object_size})") # Required, object_size is parametrized +def test_three(object_fixture: str): + assert True + + +@allure.title("Test: 3 indirect=True") # Optional, len(params) == 1 +@pytest.mark.parametrize("object_size", ["complex"], indirect=True) +def test_three_indirect_true(object_fixture: str): + assert True + + +@allure.title("Test: 3 multiple indirect (obj_size={object_size})") # Required, len(params) != 1 +@pytest.mark.parametrize("object_size", ["single", "complex"], indirect=True) +def test_three_multiple_indirect(object_fixture: str): + assert True + + +# ============== TESTS/FIXTURES IN CLASS ============== # + + +@pytest.mark.parametrize("param_class_1", [1, 2]) # Required +@pytest.mark.parametrize("param_class_2", [3]) # Optional +class TestClassParam: + @pytest.fixture( + params=[ + pytest.param(6), + pytest.param(7), + ] + ) + def root_fixture(self): + return 1 + + @pytest.fixture + def dependency_fixture(self, root_fixture): + return root_fixture + 1 + + @pytest.fixture(scope="function") # Optional fixture + def object_fixture(self, simple_object_size): + return simple_object_size + + @allure.title("Test: 4 (param_class_1={param_class_1})") # One required, other optional + def test_four(self, param_class_1: int, param_class_2: int, object_fixture): + assert True + + @allure.title("Test: 5 (param_class_1={param_class_1}, param_class_2={param_class_2}, param_five={param_five}") + @pytest.mark.parametrize("param_five", [4, 5]) # Required + def test_five(self, param_five, param_class_1, param_class_2, dependency_fixture): + assert True + + @allure.title("Not unique test (param_class_1={param_class_1})") # One required, other optional + def test_not_unique_3(self, param_class_1, param_class_2): + assert True + + +@pytest.fixture(scope="function") # Required fixture +def object_fixture(file_path): + return file_path + + +@pytest.fixture # Optional fixture +def dependency_fixture(): + return 1