From 38d6231b1890a66d27710ddebdd7dba5a9019145 Mon Sep 17 00:00:00 2001 From: Petr Schindler Date: May 06 2019 08:11:02 +0000 Subject: Initial commit original author of code is Michal Odehnal. --- diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /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/README.md b/README.md new file mode 100644 index 0000000..3604cf7 --- /dev/null +++ b/README.md @@ -0,0 +1,121 @@ +# Project behave-common-procedures +An alternative submodule to **behave-common-steps** project. +Author: Michal Odehnal + + +## Getting Started +To use this submodule use command to add this to your project: +``` +git submodule add -b f30 https://pagure.io/desktop-qa/behave-common-procedures.git common_procedures --force +``` + + +### Prerequisites +To use some parts of the submodule you may need some libraries: + +To use opencv image matching you will need (this will be needed in CI and you need to include the package in your mapper.yaml): +``` +sudo pip3 install opencv-python +``` +And to use included error message format in color you will need (this will not be needed in CI): +``` +sudo pip3 install termcolor +``` + + +### Setup in environment +You need to change your **environment.py** file. This is an example how to setup your tests: + +``` +from common_procedures.sandbox import * +import traceback +import sys + + +def before_all(context): + try: + context.sandbox = TestSandbox("gnome-terminal") + + context.terminal = context.sandbox.get_app("gnome-terminal", a11yAppName="gnome-terminal-server") + except Exception as e: + print("Environment error: before_all: {0}".format(e)) + traceback.print_exc(file=sys.stdout) + sys.exit(1) + + +def before_scenario(context, scenario): + try: + context.sandbox.before_scenario(context, scenario) + except Exception as e: + print("Environment error: before_scenario: {0}".format(e)) + traceback.print_exc(file=sys.stdout) + sys.exit(1) + + +def after_step(context, step): + try: + context.sandbox.after_step(context, step) + except Exception as e: + print("Environment error: after_step: {0}".format(e)) + traceback.print_exc(file=sys.stdout) + sys.exit(1) + + +def after_scenario(context, scenario): + try: + context.sandbox.after_scenario(context, scenario) + except Exception as e: + print("Environment error: after_scenario: {0}".format(e)) + traceback.print_exc(file=sys.stdout) + sys.exit(1) + +``` + + +### Setup in main code +When you run your tests now and there is no exception caught in environment. That means the environment was setup correctly. To use this setup in your **steps.py** file you need another import: +``` +from common_procedures.common_steps import * +``` +And if you would like image matching you will need: +``` +from common_procedures.image_matching import * +``` + + +### Usage in steps.py +Main change is the query for node in a11y tree. You are used to: +``` +context.app.instance. +``` +You will now be using your defined application from environment. +``` +context.terminal.instance. +context.firefox.instance. +context.nautilus.instance. +``` +You get the idea. + + +### Usage in .feature files. +Examples: +``` + * Start application "terminal" via "menu" + * Close application "terminal" via "shortcut" + + * Left click "System" "menu" in "gnome-shell" + * Left click "Settings" "push button" that is "showing" in "gnome-shell" + * Item "Settings" "menu" is "showing" in "gnome-shell" +``` + + + +## Files included explained +* __init__.py - collection of useful functions. +* application.py - application class that contains methods to deal with applications. +* common_steps.py - behave wrapper for dogtail. +* get_node.py - get_node class that does all asserting and searching for desired node wanted via common_steps.py +* image_matching.py - opencv image comparison. +* sandbox.py - main testing class which takes care of all system settings for successful test run. +* start_recording.py - script for start recording test via dbus. +* time_limit.py - experimental function for time limiting certain tests. diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..14b47da --- /dev/null +++ b/__init__.py @@ -0,0 +1,221 @@ +#!/usr/bin/env python3 +import os +import re +from time import strftime, sleep, localtime +import subprocess +from subprocess import Popen, PIPE, CalledProcessError +import shlex +import types +import pyatspi +from time import sleep, time +from functools import partial + +import logging +logging.basicConfig() +logger = logging.getLogger('test') +logger.setLevel(logging.INFO) + + +##################### Settings for different systems ########################### +testing = False if os.path.isdir("/mnt/tests/") else True +if testing: from termcolor import colored +################################################################################ + + + + + +################ Helping function to keep used naming scheme ################### +def get_application(context, application): + app_class_to_return = None + try: + app_class_to_return = getattr(context, application) + except AttributeError: + default = None + for app in context.sandbox.applications: + if app.component == application: + app_class_to_return = app + break + except TypeError: + app_class_to_return = context.sandbox.default_application + assert context.sandbox.default_application != None, "Default application was not found. Check your environment file!" + + + assert app_class_to_return != None, "Application was not found. Check your environment or feature file!" + assert not isinstance(app_class_to_return, str), "Application class was not found. Usually indication of not installed application." + + return app_class_to_return +################################################################################ + + + + + +####################### behave-common-steps wait_until ######################### +def wait_until(tested, element=None, timeout=30, period=0.25, params_in_list=False): + """ + This function keeps running lambda with specified params until the + result is True or timeout is reached. Instead of lambda, Boolean variable + can be used instead. + Sample usages: + * wait_until(lambda x: x.name != 'Loading...', context.app.instance) + Pause until window title is not 'Loading...'. + Return False if window title is still 'Loading...' + Throw an exception if window doesn't exist after default timeout + + * wait_until(lambda element, expected: x.text == expected, + (element, 'Expected text'), params_in_list=True) + Wait until element text becomes the expected (passed to the lambda) + + * wait_until(dialog.dead) + Wait until the dialog is dead + + """ + if isinstance(tested, bool): + curried_func = lambda: tested + # or if callable(tested) and element is a list or a tuple + elif isinstance(tested, types.FunctionType) and (isinstance(element, tuple) or isinstance(element, list)) and params_in_list: + curried_func = partial(tested, *element) + # or if callable(tested) and element is not None? + elif isinstance(tested, types.FunctionType) and element is not None: + curried_func = partial(tested, element) + else: + curried_func = tested + + exception_thrown = None + mustend = int(time()) + timeout + while int(time()) < mustend: + try: + if curried_func(): + return True + except Exception as e: # pylint: disable=broad-except + # If lambda has thrown the exception we'll re-raise it later + # and forget about if lambda passes + exception_thrown = e + sleep(period) + if exception_thrown is not None: + raise exception_thrown # pylint: disable=raising-bad-type + else: + return False +################################################################################ + + + + + +# Deprecated in wayland, will be redone via ponytail +########################### HoldKey and do stuff ############################### +KEY_VALUE = { + "Alt" : 64, "Alt_L" : 64, "Alt_R" : 108, + "Shift" : 50, "Shift_L" : 50, "Shift_R" : 62, + "Ctrl" : 37, "Tab" : 23, "Super" : 133, +} + +class HoldKey(object): + def __init__(self, key_name): + self.key_name = key_name + pyatspi.Registry.generateKeyboardEvent(KEY_VALUE[self.key_name], None, pyatspi.KEY_PRESS) + def __enter__(self): + return self + def __exit__(self, type, value, traceback): + pyatspi.Registry.generateKeyboardEvent(KEY_VALUE[self.key_name], None, pyatspi.KEY_RELEASE) +################################################################################ + + + + + +############################### Tuple class #################################### +class T(tuple): + def __add__(self, other): + return T(x + y for x, y in zip(self, other)) + def __rmul__(self, other): + return T(other * x for x in self) + def __eq__(self, other): + return (x == y for x, y in zip(self, other)) + def __lt__(self, other): + return self[0] < other[0] or self[1] < other[1] + def __gt__(self, other): + return self[0] > other[0] or self[1] > other[1] +################################################################################ + + + + + +####################### Run command and expect result ########################## +def run(command, verbose=False): + try: + output = subprocess.check_output(command, shell=True, stderr=subprocess.STDOUT, encoding="utf-8") + returncode = 0 + exception = None + except CalledProcessError as e: + output = e.output + returncode = e.returncode + exception = e + + return output if not verbose else (output, returncode, exception) +################################################################################ + + + + + +############################ Script validation ################################# +def validate_command(command): + # Lets take care of any scripts user would like to try. + parsed_command = shlex.split(command) + valid_command = "" + for command_part in parsed_command: + for character in command_part: + valid_command += "\\{0}".format(character) if not character.isalpha() else character + valid_command += " " + return valid_command +################################################################################ + + + + + +############# Verification of file with helpful message on fail ################ +def get_file_error_message(name, path): + directory_contents = os.listdir(path) + files_in_directory_listed = ''.join(["\t{0}. '{1}'\n".format( + colored(index + 1, "yellow") if testing else index + 1, file_name) + for index, file_name in enumerate(directory_contents)]) + + return ''.join(["\n\n{0}:\n\t{1}: '{2}'\n\t{3}: '{4}'\n\n{5}:\n{6}".format( + colored("Failed attempt to use file", "yellow", attrs=["bold"]) if testing else "Failed attempt to use file", + colored("File path", "yellow") if testing else "File path", path, + colored("File name", "yellow") if testing else "File name", name, + colored("Listed directory", "yellow", attrs=["bold"]) if testing else "Listed directory", files_in_directory_listed) + ]) + +def verify_path(template_path): + try: + path_to_template, template = template_path.rsplit("/", 1) + assert os.path.isfile(template_path) + except Exception: + assert False, get_file_error_message(template, path_to_template) + return template_path +################################################################################ + + + + + +######################### Custom dump with extra info ########################## +spacer = ' ' +def plain_dump(node): + def crawl(node, depth): + dump(node, depth) + for child in node.children: + crawl(child, depth + 1) + + def dumpStdOut(item, depth): + # str wont possibly work in p3 + print(spacer * depth + str(item) + " [p:{0}, s:{1}, visible:{2}, showing:{3}]".format(item.position, item.size, item.visible, item.showing)) + + dump = dumpStdOut + crawl(node, 0) +################################################################################ diff --git a/application.py b/application.py new file mode 100644 index 0000000..2a06f1b --- /dev/null +++ b/application.py @@ -0,0 +1,294 @@ +#!/usr/bin/env python3 +from . import * +from .time_limit import * +from dogtail.rawinput import typeText, pressKey, keyCombo +from dogtail.tree import root +import dogtail.utils +import iniparse + + +class Application: + def __init__(self, component, a11yAppName=None, desktopFileExists=True, desktopFileName=None, appProcessName=None, logging=False, session_type=None): + """ + Initiate Application instance. + + @param component : str + Application name. + @param a11yAppName : str + Name of application as it appears in accessibility tree. + @param desktopFileExists : bool + States that desktop file of given application exists or not. + @param desktopFileName : str + Name of desktop file if the name is different from application name. + @param appProcessName : str + Name process of application if the name of is different from application name. + @param logging : bool + Turn on logging of this submodule. Passed from sandbox. + """ + + self.session_type = session_type + self.logging = logging + self.pid = None + self.instance = None + self.component = component + self.a11yAppName = a11yAppName if a11yAppName else component + self.desktopFileExists = desktopFileExists + self.exitShortcut = "" + self._kill = True + self.desktopFileName = desktopFileName if desktopFileName else "" + self.appProcessName = appProcessName if appProcessName else component + self.getDesktopFileData() + + + def getDesktopFileData(self): + """ + Parse desktop file. + """ + + if self.logging: + logger.info("Application '{}': getDesktopFileData(self)".format(self.component)) + + if self.desktopFileExists: # zenity/gnome-shell do not have desktop file + desktop_run = run("rpm -qlf $(which {0}) | grep /usr/share/applications/ | grep .desktop | grep '{1}'".format(self.component, self.desktopFileName), verbose=True) + + if desktop_run[1] != 0: + raise Exception("Desktop file of application '{0}' was not found.".format(self.component)) + + desktopFile = desktop_run[0].strip('\n') + desktopFileConfig = iniparse.ConfigParser() + desktopFileConfig.read(desktopFile) + + self.name = desktopFileConfig.get("Desktop Entry", "name") + self._exec = desktopFileConfig.get("Desktop Entry", "exec").split(" ")[0] + + + def start_via_command(self, command=None, inSession=False, kill=True): + """ + Start application via command. + + @param command : str + Complete command that is to be used to start application. + @param inSession : bool + Start application via command in session. TODO. + @param kill : bool + If application is running while command is run. Application will be killed. + """ + + if self.logging: + logger.info("Application '{}': start_via_command(self, command={}, inSession={}, kill={})".format(self.component, command, inSession, kill)) + + if self.isRunning() and kill: + self.kill() + + if inSession: + pressKey("Esc") + keyCombo(""); sleep(0.5) + keyCombo(""); sleep(0.5) + typeText(command if command else self._exec); sleep(0.5) + pressKey("Enter"); sleep(0.5) + else: + self.process = Popen(shlex.split(command if command else self._exec), stdout=PIPE, stderr=PIPE) + + self.wait_before_app_starts(30) + self.instance = self.getRoot() + + + + def start_via_menu(self, kill=True): + """ + Start application via command. + + @param kill : bool + If application is running while start_via_menu is called. Application will be killed. + """ + + if self.logging: + logger.info("Application '{}': start_via_menu(self, kill={})".format(self.component, kill)) + + if not self.desktopFileExists: + raise Exception("Testing target '{}' does not have desktop file. Indication of user failure!".format(self.a11yAppName)) + + if self.isRunning() and kill: + self.kill() + + run("dbus-send --session --type=method_call --dest=org.gnome.Shell /org/gnome/Shell org.gnome.Shell.FocusSearch") + sleep(1) + typeText(self.name) + pressKey("Enter") + + self.wait_before_app_starts(30) + self.instance = self.getRoot() + + + def close_via_shortcut(self): + """ + Start application via shortcut. + """ + + if self.logging: + logger.info("Application '{}': close_via_shortcut(self)".format(self.component)) + + if not self.isRunning(): + raise Exception("Application '{}' is no longer running. Indication of test failure!".format(self.a11yAppName)) + + keyCombo(self.exitShortcut) + + self.wait_before_app_closes(30) + self.instance = None + + + def already_running(self): + """ + If application is started by other means other than this submodule, this will initiate data that are necessary. + """ + + if self.logging: + logger.info("Application '{}': already_running(self)".format(self.component)) + + self.wait_before_app_starts(15) + self.instance = self.getRoot() + + + def getRoot(self): + """ + Get accessibility root of appllication. + + @return : + Return root object of application. + """ + + if self.logging: + logger.info("Application '{}': getRoot(self) search by '{}'".format(self.component, self.a11yAppName)) + + return root.application(self.a11yAppName) + + + def isRunning(self): + """ + Get accessibility root of appllication. + + @return : bool + Return state of application. Running or not. + """ + + if self.logging: + logger.info("Application '{}': isRunning(self)".format(self.component)) + + try: + return self.a11yAppName in [x.name for x in pyatspi.Registry.getDesktop(0)] + except Exception: + return False + + + def getPid(self): + """ + Get process id of running application. Unused for now. Using getPidList. + + @return : str + Process id number, not converting to int. Return nothing if application is not running. + """ + + if self.logging: + logger.info("Application '{}': getPid(self)".format(self.component)) + + if self.isRunning(): + self.pid = run("pgrep -f {}".format(self.appProcessName)).strip('\n') + return self.pid + + + def getPidList(self): + """ + Get list of processes of running application. + + @return : str + Return all running processes of application, seperated by new line character, not converting to list. Return nothing if application is not running. + """ + + if self.logging: + logger.info("Application '{}': getPidList(self)".format(self.component)) + + if self.isRunning(): + self.pid_list_all = run("pgrep -fla {}".format(self.appProcessName)).strip('\n') + return self.pid_list_all + + + def getAllKillCandidates(self): + """ + Take result of getPidList and return only processes of application. + If kill candidate happens to have ['runtest', 'behave', 'dogtail', '/usr/bin/gnome-shell'] in its process name. Process will not be killed. + This prevents testname colliding with found process so we will not kill the test itself. + + @return : list + Return all processed id of applications. + Return empty list if no satisfactory process was found. + """ + + if self.logging: + logger.info("Application '{}': getAllKillCandidates(self)".format(self.component)) + + app_process_list = self.getPidList().split("\n") + + final_pid_list = [] + for process in app_process_list: + if not (("runtest" in process) or ("behave" in process) or ("dogtail" in process) or ("/usr/bin/gnome-shell" == process)): + extracted_pid = process.split(' ', 1)[0] + try: + final_pid_list.append(int(extracted_pid)) + except ValueError: + pass # skip non-digits + return final_pid_list + + + def kill(self): + """ + Kill application. + """ + + if self.logging: + logger.info("Application '{}': kill(self)".format(self.component)) + + if self.isRunning() and self._kill: + pids = self.getAllKillCandidates() + for pid in pids: + run("sudo kill -9 {} > /dev/null".format(pid)) + + + # Following two could be merged, I could not think of a nice way of doing it though. + def wait_before_app_starts(self, time_limit): + """ + Wait before application starts. + + @param time_limit : int + Number which signifies time before the run is stopped. + """ + + if self.logging: + logger.info("Application '{}': wait_before_app_starts(self, time_limit={})".format(self.component, time_limit)) + + with timeout(time_limit): + if self.session_type == "wayland": + dogtail.utils.waitForWindow(self.a11yAppName) + else: + try: + while not self.isRunning(): + sleep(0.1) + except Exception: + assert False, "Application '{}' is not running. Indication of test failure!".format(self.a11yAppName) + + def wait_before_app_closes(self, time_limit): + """ + Wait before application stops. + + @param time_limit : int + Number which signifies time before the run is stopped. + """ + + if self.logging: + logger.info("Application '{}': wait_before_app_closes(self, time_limit={})".format(self.component, time_limit)) + + with timeout(time_limit): + try: + while self.isRunning(): + sleep(0.1) + except Exception: + assert False, "Application '{}' is running. Indication of test failure!".format(self.a11yAppName) diff --git a/common_steps.py b/common_steps.py new file mode 100644 index 0000000..21abf87 --- /dev/null +++ b/common_steps.py @@ -0,0 +1,207 @@ +#!/usr/bin/env python3 +from . import * +from .time_limit import * +from .get_node import * +from behave import step +from dogtail.rawinput import typeText, pressKey, keyCombo, absoluteMotion +from time import sleep + + +@step('{m_btn} click "{name}" "{roleName}"') +@step('{m_btn} click "{name}" "{roleName}" in "{root}"') +@step('{m_btn} click "{name}" "{roleName}" that is "{attr}"') +@step('{m_btn} click "{name}" "{roleName}" that is "{attr}" in "{root}"') +@step('{m_btn} click "{name}" "{roleName}" with description "{descr}"') +@step('{m_btn} click "{name}" "{roleName}" with description "{descr}" in "{root}"') +@step('{m_btn} click "{name}" "{roleName}" with description "{descr}" that is "{attr}"') +@step('{m_btn} click "{name}" "{roleName}" with description "{descr}" that is "{attr}" in "{root}"') +def mouse_click(ctx, name=None, roleName=None, descr=None, m_btn=None, attr=None, root=None, retry=True, expect_positive=True): + with GetNode(ctx, name, roleName, descr, m_btn, attr, root, retry, expect_positive) as (data, node): + node.click(data.m_btn) + + +@step('Mouse over "{name}" "{roleName}"') +@step('Mouse over "{name}" "{roleName}" in "{root}"') +@step('Mouse over "{name}" "{roleName}" that is "{attr}"') +@step('Mouse over "{name}" "{roleName}" that is "{attr}" in "{root}"') +@step('Mouse over "{name}" "{roleName}" with description "{descr}"') +@step('Mouse over "{name}" "{roleName}" with description "{descr}" in "{root}"') +@step('Mouse over "{name}" "{roleName}" with description "{descr}" that is "{attr}"') +@step('Mouse over "{name}" "{roleName}" with description "{descr}" that is "{attr}" in "{root}"') +def mouse_over(ctx, name=None, roleName=None, descr=None, m_btn=None, attr=None, root=None, retry=True, expect_positive=True): + with GetNode(ctx, name, roleName, descr, m_btn, attr, root, retry, expect_positive) as (data, node): + absoluteMotion(*(get_center(node))) + + +@step('Make an action "{action}" for "{name}" "{roleName}"') +@step('Make an action "{action}" for "{name}" "{roleName}" in "{root}"') +@step('Make an action "{action}" for "{name}" "{roleName}" that is "{attr}"') +@step('Make an action "{action}" for "{name}" "{roleName}" that is "{attr}" in "{root}"') +@step('Make an action "{action}" for "{name}" "{roleName}" with description "{descr}"') +@step('Make an action "{action}" for "{name}" "{roleName}" with description "{descr}" in "{root}"') +@step('Make an action "{action}" for "{name}" "{roleName}" with description "{descr}" that is "{attr}"') +@step('Make an action "{action}" for "{name}" "{roleName}" with description "{descr}" that is "{attr}" in "{root}"') +def make_action(ctx, action=None, name=None, roleName=None, descr=None, m_btn=None, attr=None, root=None, retry=True, expect_positive=True): + with GetNode(ctx, name, roleName, descr, m_btn, attr, root, retry, expect_positive) as (data, node): + node.doActionNamed(action) + + +@step('Item "{name}" "{roleName}" found') +@step('Item "{name}" "{roleName}" found in "{root}"') +@step('Item "{name}" "{roleName}" is "{attr}"') +@step('Item "{name}" "{roleName}" is "{attr}" in "{root}"') +@step('Item "{name}" "{roleName}" with description "{descr}" is "{attr}"') +@step('Item "{name}" "{roleName}" with description "{descr}" is "{attr}" in "{root}"') +def node_attribute(ctx, name=None, roleName=None, descr=None, m_btn=None, attr=None, root=None, retry=True, expect_positive=True): + with GetNode(ctx, name, roleName, descr, m_btn, attr, root, retry, expect_positive) as (data, node): + assert node != None, "Node was not found, it should be!" + + +@step('Item "{name}" "{roleName}" was not found') +@step('Item "{name}" "{roleName}" was not found in "{root}"') +@step('Item "{name}" "{roleName}" is not "{attr}"') +@step('Item "{name}" "{roleName}" is not "{attr}" in "{root}"') +@step('Item "{name}" "{roleName}" with description "{descr}" is not "{attr}"') +@step('Item "{name}" "{roleName}" with description "{descr}" is not "{attr}" in "{root}"') +def node_not_attribute(ctx, name=None, roleName=None, descr=None, m_btn=None, attr=None, root=None, retry=True, expect_positive=False): + with GetNode(ctx, name, roleName, descr, m_btn, attr, root, retry, expect_positive) as (data, node): + assert node == None, "Node was found, it should not be!" + + +@step('Item "{name}" "{roleName}" has text "{text}"') +@step('Item "{name}" "{roleName}" has text "{text}" in "{root}"') +@step('Item "{name}" "{roleName}" with description "{descr}" has text "{text}"') +@step('Item "{name}" "{roleName}" with description "{descr}" has text "{text}" in "{root}"') +def node_with_text(ctx, name=None, roleName=None, descr=None, text=None, m_btn=None, attr=None, root=None, retry=True, expect_positive=True): + with GetNode(ctx, name, roleName, descr, m_btn, attr, root, retry, expect_positive) as (data, node): + assert text in node.text, "Found node should have text: {0}\nInstead the node has text: {1}".format(text, node.text) + + +@step('Item "{name}" "{roleName}" does not have text "{text}"') +@step('Item "{name}" "{roleName}" does not have text "{text}" in "{root}"') +@step('Item "{name}" "{roleName}" with description "{descr}" does not have text "{text}"') +@step('Item "{name}" "{roleName}" with description "{descr}" does not have text "{text}" in "{root}"') +def node_without_text(ctx, name=None, roleName=None, descr=None, text=None, m_btn=None, attr=None, root=None, retry=True, expect_positive=True): + with GetNode(ctx, name, roleName, descr, m_btn, attr, root, retry, expect_positive) as (data, node): + assert not text in node.text , "Found node should not have text: {0}\nNode was found with text: {1}".format(text, node.text) + + +@step('Item "{name}" "{roleName}" does not have description "{descr}"') +@step('Item "{name}" "{roleName}" does not have description "{descr}" in "{root}"') +@step('Item "{name}" "{roleName}" does not have description "{descr}" that is "{attr}"') +@step('Item "{name}" "{roleName}" does not have description "{descr}" that is "{attr}" in "{root}"') +def node_without_description(ctx, name=None, roleName=None, descr=None, m_btn=None, attr=None, root=None, retry=True, expect_positive=True): + with GetNode(ctx, name, roleName, None, m_btn, attr, root, retry, expect_positive) as (data, node): + assert not descr in node.description, "Found node should not have description: {0}\nInstead the node has description: {1}".format(descr, node.description) + + + +@step('Wait until "{name}" "{roleName}" is "{attr}"') +@step('Wait until "{name}" "{roleName}" is "{attr}" in "{root}"') +@step('Wait until "{name}" "{roleName}" with description "{descr}" is "{attr}"') +@step('Wait until "{name}" "{roleName}" with description "{descr}" is "{attr}" in "{root}"') +def wait_until_attr(ctx, name=None, roleName=None, descr=None, m_btn=None, attr=None, root=None, retry=True, expect_positive=True): + with GetNode(ctx, name, roleName, descr, m_btn, attr, root, retry, expect_positive) as (data, node): + time_went_by = 0 + while not node.sensitive and time_went_by < 15: + time_went_by += 0.5 + sleep(0.5) + + +#@step('Start another instance of "{application}" via "{start_via}"') # to be solved +#@step('Start another instance of "{application}" via command:"{command}"') # to be solved +@step('Start {application} via {start_via}') # behave-common-steps decorator +@step('Start "{application}" via command in session') # behave-common-steps decorator +@step('Start application "{application}" via "{start_via}"') +@step('Start application "{application}" via command "{command}"') +@step('Start application "{application}" via command in "{session}"') +def start_application(ctx, application=None, start_via="command", command=None, session=None): + application = get_application(ctx, application) + if start_via == "menu": + try: + application.start_via_menu() + except Exception: + application.start_via_menu() + elif start_via == "command": + try: + application.start_via_command(command=command, inSession=session) + except Exception: + application.start_via_command(command=command, inSession=session) + else: + raise AssertionError("Only defined options are 'command' and 'menu'.") + + +@step('Close app via gnome panel') # behave-common-steps decorator +@step('Close application "{application}" via "{close_via}"') +def application_in_not_running(ctx, application, close_via="gnome panel"): + application = get_application(ctx, application) + if close_via == "gnome panel": + ctx.execute_steps('* Left click "{}" "menu" in "gnome-shell"'.format(application.name)) + sleep(0.5) + ctx.execute_steps('* Left click "Quit" "label" in "gnome-shell"') + + elif close_via == "application menu": + ctx.execute_steps('* Left click "File" "menu" in "{}"'.format(application.component)) + ctx.execute_steps('* Wait until "Quit" "menu item" is "sensitive" in "{}"'.format(application.component)) + ctx.execute_steps('* Left click "Quit" "menu item" in "{}"'.format(application.component)) + + elif close_via == "shortcut": + application.close_via_shortcut() + + elif close_via == "kill command": + application.kill() + + else: + raise AssertionError("Only defined options are 'gnome panel', 'application menu', 'shortcut' and 'kill command'.") + + +@step('{application} shouldn\'t be running anymore') # behave-common-steps decorator +@step('Application "{application}" is no longer running') +def application_is_not_running(ctx, application): + application = get_application(ctx, application) + if application.isRunning(): + application.wait_before_app_closes(15) + + +@step('{application} should start') # behave-common-steps decorator +@step('Application "{application}" is running') +def application_is_running(ctx, application): + application = get_application(ctx, application) + application.already_running() + if application.isRunning(): + application.wait_before_app_starts(15) + + +@step('Click "{target_name}" in GApplication menu') # behave-common-steps decorator +def click_gapp_menu(ctx, target_name): + assert ctx.sandbox.default_application != None, "You need to define a default application if you are using steps without root." + ctx.execute_steps('* Left click "{}" "menu" in "gnome-shell"'.format(ctx.sandbox.default_application.name)) + sleep(0.5) + ctx.execute_steps('* Left click "{}" "label" in "gnome-shell"'.format(target_name)) + + +@step('Type text: "{text}"') +def type_text(ctx, text): + typeText(text) + + +@step('Press key: "{key_name}"') +def press_key(ctx, key_name): + pressKey(key_name) + + +@step('Press "{combo_name}"') # behave-common-steps decorator +@step('Key combo: "{combo_name}"') +def key_combo(ctx, combo_name): + keyCombo(combo_name) + + +@step('Wait {number:d} second before action') +@step('Wait {number:d} seconds before action') +def wait_up(ctx, number): + sleep(number) + + +@step('Move mouse to: "{x:d}", y: "{y:d}"') +def absolutie_motion(ctx, x, y): + absoluteMotion(int(x),int(y)) diff --git a/get_node.py b/get_node.py new file mode 100644 index 0000000..6fadf02 --- /dev/null +++ b/get_node.py @@ -0,0 +1,124 @@ +#!/usr/bin/env python3 +import pyatspi +import traceback +import sys +import os + + +testing = False if os.path.isdir("/mnt/tests/") else True +if testing: from termcolor import colored + + +class GetNode: + def __init__(self, context, name, roleName, description, m_btn, attr, root, retry, expect_positive): + """ + Initiate GetNode instance. + + @param context : + Context object that is passed from common steps. + @param name : str + Node identification: name. + @param roleName : str + Node identification: roleName. + @param description : str + Node identification: description. + @param m_btn : str + Mouse click after node identification. + Accepted values are "Left" and "Right". + @param attr : str + Node identification: attribute. + The most used options are: ["showing", "visible", "checked", "focused", "sensitive"] + @param root : str + Application name. + Application name to be found in context. or in accessibility tree. + If search of accessibility tree fails the context object will be examined for Application instance. + @param retry : bool + Option to give search function to look again a few times if search fails. + Used for slower applications. User might want to click right away but window can have a few secods delay. + @param expect_positive : bool + Option to pass the common step call if the node is not found. + Some steps might want the node not to be found. + """ + a11y_roots = {x.name: x for x in pyatspi.Registry.getDesktop(0)} + self.root = a11y_roots[root] if root in a11y_roots else getattr(context, root).instance if root != None and hasattr(context, root) else None + if self.root == None: + try: + self.root = context.sandbox.default_application.instance + except AttributeError: + assert False, "You need to define a default application if you are using steps without root." + + + self.m_btn = 1 if m_btn == "Left" or m_btn==1 else 3 if m_btn == "Right" or m_btn==3 else None if m_btn == None else 0 + assert self.m_btn != 0, "Unknown mouse button! Check your feature file!" + + self.name = (''.join(name) if name!="Empty" else '') if name != "None" else None + self.roleName = (''.join(roleName) if roleName!="Empty" else '') if roleName != "None" else None + self.description = None if description==None else ''.join(description) if description!="Empty" else '' + + self.attr = attr if attr in ["showing", "visible", "checked", "focused", "sensitive"] else None if attr == None else False + assert self.attr != False, "Unknown attribute. Check your feature file!" + + self.retry = retry if isinstance(retry, bool) else None + assert self.retry != None, "Unknown retry state. Check your feature file!" + + self.expect_positive = expect_positive if isinstance(expect_positive, bool) else None + assert self.expect_positive != None, "Unknown expect_positive state: {}. Check your feature file!".format(self.expect_positive) + + + def __enter__(self): + try: + found_node = self.root.findChild(lambda x: + ( (not (self.name != None) ) or self.name in repr(x.name) ) and \ + ( (not (self.roleName != None) ) or self.roleName == x.roleName ) and \ + ( (not (self.description != None) ) or self.description in x.description ) and \ + ( (not (self.attr != None) ) or getattr(x, self.attr) ) and \ + x.position[0] >= 0 and \ + x.size[0] > 0, + retry=self.retry) + except Exception as error: + if self.expect_positive: + assert False, get_error_message(self, error) + else: + found_node = None + return (self, found_node) + + + def __exit__(self, exc_type, exc_value, trcb): + if exc_type is not None: + traceback.print_exc(file=sys.stdout) + return False + return True + + +def get_center(node): + return (node.position[0] + node.size[0]/2, node.position[1] + node.size[1]/2) + + +def get_formated_duplicates(list_size, list_of_duplicates, attr): + return ''.join(sorted(set(["\t{0}: '{1}' {2}: '{3}' {4}: '{5}' {6}: '{7}' {8}: '{9}'\n".format( + colored("name", "yellow") if testing else "name", repr(node.name), + colored("roleName", "yellow") if testing else "roleName", node.roleName, + colored("position", "yellow") if testing else "position", node.position, + colored("size", "yellow") if testing else "size", node.size, + colored("{0}".format(attr), "yellow") if testing else "{0}".format(attr if attr else "attribute"), getattr(node, attr) if attr else "None") + for node in list_of_duplicates]), key=str.lower)) if list_size != 0 else "\tNone\n" + + +def get_formated_error_message(error, node_name, same_name_items, node_roleName, same_roleName_items): + return ''.join(["\n\n{0}: {1}\n\n{2}: {3}:\n{4}\n{5}: {6}:\n{7}\n".format( + colored("Item was not found", "yellow", attrs=["bold"]) if testing else "Item was not found", error, + colored("Items with name", "yellow", attrs=["bold"]) if testing else "Items with name", repr(node_name), same_name_items, + colored("Items with roleName", "yellow", attrs=["bold"]) if testing else "Items with roleName", node_roleName, same_roleName_items) + ]) + + +def get_error_message(node, error): + nodes_with_name = node.root.findChildren(lambda x: node.name in x.name and ((not (node.name != '') ) or x.name != '')) + nodes_with_name_size = len(nodes_with_name) + nodes_with_name_formatted = get_formated_duplicates(nodes_with_name_size, nodes_with_name, node.attr) + + nodes_with_roleName = node.root.findChildren(lambda x: x.roleName == node.roleName) + nodes_with_roleName_size = len(nodes_with_roleName) + nodes_with_roleName_formatted = get_formated_duplicates(nodes_with_roleName_size, nodes_with_roleName, node.attr) + + return get_formated_error_message(error, node.name, nodes_with_name_formatted, node.roleName, nodes_with_roleName_formatted) diff --git a/image_matching.py b/image_matching.py new file mode 100644 index 0000000..4870fd2 --- /dev/null +++ b/image_matching.py @@ -0,0 +1,102 @@ +#!/usr/bin/env python3 +from . import run +from dogtail.rawinput import click +from os import path +from time import sleep +from behave import step +import cv2 + + +""" +You are encouraged to build your own step function according to your needs. +Two steps that you see bellow are: + * General step that just compares and asserts the result. + * General step that just compares and clicks on the found result. + +What is needed for image match: + * You need to capture an image in which we look for the element you want to find. + * Provided by capture_image method in Matcher class. + * This option is True by default. + * If you have your own, set capture=False and provide self.screen_path in the Matcher class. + + * You need to match the two images, you are looking for a 'needle'. + So you provide it in function or in step call (.feature file). + * Provided by match which will return True or False. Lets user react on False return value. + * Provided by assert_match which will assert the result and terminate the test on False. + + * (Optional) You can draw the result for attachment or your own confirmation that matching works. + * Provided by draw method on Matcher instance to get an image with highlighted needle. + Highlight is a red rectangle exactly in a place of a match, surrounding provided needle. + + * (Optional) You can click on your found result. + * Provided by click method in Matcher instance. + * Requirements are of course success of a match/assert_match. + + * (Optional) You can embed result to test report. + * For this option the method draw is required. + * Use method provided in TestSandbox class: attach_image_to_report(context, image=image_location, caption="DefaultCaption") + * Or embed it on your own: context.embed("image/png", open(image_location, "rb").read(), caption="DefaultCaption") + * Remember that result is saved in Matcher instance as self.diff_path which equals "/tmp/diff.png" +""" + + +@step('Image "{needle}" is shown on screen') +@step('Image "{needle}" is shown on screen with threshold "{threshold:d}"') +def image_match(context, needle, threshold=0.8): + image_match = Matcher() + image_match.assert_match(needle, threshold) + image_match.draw() + + +@step('Locate and click "{needle}"') +def locate_and_click(context, needle): + image_match = Matcher() + image_match.assert_match(needle) + image_match.click() + + +class Matcher: + def __init__(self): + self.screen_path = "/tmp/pic.png" + self.diff_path = "/tmp/diff.png" + self.capture_image_cmd = "gnome-screenshot -f " + self.screen_path + self.needle_width = 0 + self.needle_height = 0 + self.matched_value = 0.0 + self.matched_loc = (0, 0) + + + def capture_image(self): + run(self.capture_image_cmd) + + + def assert_match(self, needle, threshold=0.8, capture=True): + assert self.match(needle, threshold, capture), \ + "Image match value: {}".format(self.matched_value) + + + def match(self, needle, threshold=0.8, capture=True): + if capture: + self.capture_image() + + self.ori_img = cv2.imread(self.screen_path) + self.ori_img_gray = cv2.cvtColor(self.ori_img, cv2.COLOR_BGR2GRAY) + self.needle = cv2.imread(path.abspath(needle), 0) + self.needle_width, self.needle_height = self.needle.shape[::-1] + + match = cv2.matchTemplate(self.ori_img_gray, self.needle, cv2.TM_CCOEFF_NORMED) + _, self.matched_value, _, self.matched_loc = cv2.minMaxLoc(match) + + return self.matched_value > threshold + + + def draw(self): + self.needle_size = (self.matched_loc[0] + self.needle_width, self.matched_loc[1] + self.needle_height) + cv2.rectangle(self.ori_img, self.matched_loc, self.needle_size, (0, 0, 255), 2) + cv2.imwrite(self.diff_path, self.ori_img) + + + def click(self): + match_center_x = self.matched_loc[0] + int(self.needle_width / 2) + match_center_y = self.matched_loc[1] + int(self.needle_height / 2) + click(match_center_x, match_center_y); sleep(1) diff --git a/sandbox.py b/sandbox.py new file mode 100644 index 0000000..de7bb2e --- /dev/null +++ b/sandbox.py @@ -0,0 +1,564 @@ +#!/usr/bin/env python3 +from . import * +from .application import * +from .time_limit import * +from dogtail.utils import config + + +class TestSandbox: + def __init__(self, component, logging=False): + """ + Initiate TestSandbox instance. + + @param component : str + Testing component name. + @param logging : bool + Turn on or off logging of this submodule. + Default option is False. + Mostly used if submodule encounters a corner case that was not caught in implementation. + """ + + self.logging = logging + + if self.logging: + logger.info("Sandbox: __init__(self, component={}, logging={})".format(component, "True" if self.logging else "False")) + + self.resolution = [int(x) for x in re.findall(r"\d+x\d+", run("export DISPLAY=:0; xrandr | grep '*'"))[0].split("x")] + self.component = component + self.current_scenario = None + self.background_color = None + + self.recordVideo = True + self.recordVideoPid = None + + self.attachVideo = True + self.attachVideoOnPass = False + + self.attachJournal = True + self.attachJournalOnPass = False + + self.attachScreenshot = True + self.failedTest = False + + self.attachFAF = True + self.attachFAFOnPass = False + + self.workspace_return = False + + self.production = True + + self.applications = [] + self.default_application = None + self.retrieve_session_data() + self.wait_until_shell_becomes_responsive() + + + def before_scenario(self, ctx, behave_scenario): + """ + Actions that are to be executed before every scenario. + + @param context : + Pass this object from environment file. + @param behave_scenario : + Pass this object from environment file. + """ + + if self.logging: + logger.info("Sandbox: before_scenario(self, context, behave_scenario) test: {}".format(behave_scenario.tags[0])) + + self.main_scenario_steps = behave_scenario.steps + self.current_scenario = behave_scenario.tags[0] + self.set_log_start_time() + self.overview_action("hide") + self.set_typing_delay(0.2) + self.set_debug_to_stdout_as(False) + self.return_to_home_workspace() + self.close_yelp() + self.close_initial_setup() + self.copy_data_folder() + self.html_formatter_hotfix() + self.set_blank_screen_to_never() + + if self.recordVideo and self.production: + self.start_recording() + + + def after_step(self, ctx, behave_step): + """ + Actions that are to be executed after every scenario step. + + @param context : + Pass this object from environment file. + @param behave_scenario : + Pass this object from environment file. + """ + + if self.logging: + logger.info("Sandbox: after_step(self, ctx, behave_step) step: {}".format(behave_step.name)) + + if behave_step.status == "failed" and (behave_step in self.main_scenario_steps): + self.failedTest = True + + if self.attachScreenshot: + self.capture_image() + + if self.recordVideo: + self.stop_recording() + + + def after_scenario(self, ctx, behave_scenario): + """ + Actions that are to be executed after every scenario. + + @param context : + Pass this object from environment file. + @param behave_scenario : + Pass this object from environment file. + """ + + if self.logging: + logger.info("Sandbox: after_scenario(self, context, behave_scenario) test: {}".format(behave_scenario.tags[0])) + + self.overview_action("hide") + + for application in self.applications: + application.kill() + + if self.recordVideo: + self.stop_recording() + + if self.attachScreenshot and self.failedTest: + self.attach_screenshot_to_report(ctx) + + if self.attachJournal and (self.failedTest or self.attachJournalOnPass): + self.attach_journal_to_report(ctx) + + if self.attachVideo and (self.failedTest or self.attachVideoOnPass): + sleep(1) # give video some extra time to be saved completelly + self.attach_video_to_report(ctx) + + if self.attachFAF and (self.failedTest or self.attachFAFOnPass): + self.attach_abrt_link_to_report(ctx) + + + def start_recording(self): + """ + Start recording video. + """ + + if self.logging: + logger.info("Sandbox: start_recording(self)") + + self.display_clock_seconds() + self.set_max_video_length_to(600) + + recordVideoProcess = Popen("python3 common_procedures/start_recording.py", shell=True) + self.recordVideoPid = recordVideoProcess.pid + + + def stop_recording(self): + """ + Stop recording video. + """ + + if self.logging: + logger.info("Sandbox: stop_recording(self)") + + if self.recordVideoPid != None: + run("sudo kill -9 {} > /dev/null".format(self.recordVideoPid)) + + self.recordVideoPid = None + + + def get_app(self, name, a11yAppName=None, desktopFileExists=True, desktopFileName=None, appProcessName=None): + """ + Return application to be used in test. + + @param name : str + Name of application. + @param a11yAppName : str + Name of application in a11y tree. + @param desktopFileExists : bool + Does desktop file of application exist. + @param desktopFileName : str + Name of desktop file of application. + @param appProcessName : str + Name of process after application starts. + """ + + if self.logging: + logger.info("Sandbox: get_app(self, name, a11yAppName={}, desktopFileExists={}, desktopFileName={})".format(name, a11yAppName, desktopFileExists, desktopFileName)) + + new_application = Application(name, a11yAppName, desktopFileExists, desktopFileName, appProcessName, self.logging, self.session_type) + self.applications.append(new_application) + self.default_application = new_application if self.default_application == None else self.default_application + return new_application + + + def wait_until_shell_becomes_responsive(self): + """ + Give some time if shell is not yet loaded fully. + """ + + if self.logging: + logger.info("Sandbox: wait_until_shell_becomes_responsive(self)") + + if self.session_type == "x11": + with timeout(15): + while not "gnome-shell" in [x.name for x in pyatspi.Registry.getDesktop(0)]: + sleep(0.5) + else: + sleep(1) # in wayland there is no way to make sure the session is loaded, so just sleep + + + def retrieve_session_data(self): + """ + Get session type/desktop data. + """ + + if self.logging: + logger.info("Sandbox: retrieve_session_data(self)") + + self.session_desktop = run("echo $XDG_SESSION_DESKTOP").strip('\n') + self.session_type = "x11" + if "XDG_SESSION_TYPE" in os.environ and "wayland" in os.environ["XDG_SESSION_TYPE"]: + self.session_type = "wayland" + + + def set_log_start_time(self): + """ + Save time. Will be used to retrieve logs from journal. + """ + + if self.logging: + logger.info("Sandbox: set_log_start_time(self)") + + self.log_start = strftime("%Y-%m-%d %H:%M:%S", localtime()) + + + def close_yelp(self): + """ + Close yelp application that is opened after fresh installation. + """ + + if self.logging: + logger.info("Sandbox: close_yelp(self)") + + help_process_id = run("pgrep yelp").strip("\n") + if help_process_id.isdigit(): + run("kill -9 {}".format(help_process_id)) + + + def close_initial_setup(self): + """ + Close initial setup window that is opened after first login. + """ + + if self.logging: + logger.info("Sandbox: close_initial_setup(self)") + + run("echo yes > ~/.config/gnome-initial-setup-done") + + + def set_blank_screen_to_never(self): + """ + Set blank screen to never. For longer tests it is undesirable for screen to lock. + """ + + if self.logging: + logger.info("Sandbox: set_blank_screen_to_never(self)") + + run("gsettings set org.gnome.desktop.session idle-delay 0") + + + def set_max_video_length_to(self, number=600): + """ + Set maximum allowed video lenght. + + @param number : int + Maximum video lenght. + """ + + if self.logging: + logger.info("Sandbox: set_max_video_length_to(self, number={})".format(number)) + + run("gsettings set org.gnome.settings-daemon.plugins.media-keys max-screencast-length {}".format(number)) + + + def display_clock_seconds(self): + """ + Display clock seconds for better tracking test in video. + """ + + if self.logging: + logger.info("Sandbox: display_clock_seconds(self)") + + run("gsettings set org.gnome.desktop.interface clock-show-seconds true") + + + def return_to_home_workspace(self): + """ + Return to home workspace. + """ + + if self.logging: + logger.info("Sandbox: return_to_home_workspace(self)") + + if not self.workspace_return: + return + + pressKey("Esc") # Closing any trailing menus + keyCombo("") + + + def set_typing_delay(self, number): + """ + Set typing delay so slower machines will not lose characters on type. + + @param number : int + Time in between accepted key strokes. + """ + + if self.logging: + logger.info("Sandbox: set_typing_delay(self, number={})".format(number)) + + config.typingDelay = number + + + def set_debug_to_stdout_as(self, true_or_false=False): + """ + Set debugging to stdout. + + @param true_or_false : bool + Decision if debug to stdout or not. + """ + + if self.logging: + logger.info("Sandbox: set_debug_to_stdout_as(self, true_or_false={})".format(true_or_false)) + + config.logDebugToStdOut = true_or_false + + + def copy_data_folder(self): + """ + Copy /data folder to /tmp/. + """ + + if self.logging: + logger.info("Sandbox: copy_data_folder(self)") + + if os.path.isdir("data/"): + for single_file in os.listdir("data/"): + run("cp data/{0} /tmp/{0}".format(single_file)) + + + def html_formatter_hotfix(self): + """ + Apply hotfix for html formatter. + """ + + if self.logging: + logger.info("Sandbox: html_formatter_hotfix(self)") + + hotfix_file = "/usr/lib/python3.6/site-packages/behave/formatter/html.py" + replace_patern = "base64.b64encode(data))" + replace_patern_with = "base64.b64encode(data).decode('utf-8').replace('PLACEHOLDER', ''))" + + hotfix_command = """sudo sed -i "s/{}/{}/g" {}""".format(replace_patern, replace_patern_with, hotfix_file) + run(hotfix_command) + + replace_placeholder = "sudo sed -i 's/PLACEHOLDER/\\\\n/g' {}".format(hotfix_file) + run(replace_placeholder) + + + def capture_image(self): + """ + Capture screenshot after failed step. + """ + + if self.logging: + logger.info("Sandbox: capture_image(self)") + + if not self.production: + return True + + self.screenshot_capture = run("gnome-screenshot -f /tmp/screenshot.png", verbose=True) + + + def attach_screenshot_to_report(self, ctx): + """ + Attach screenshot to report upon failed test. + + @param context : + Passed object. + """ + + if self.logging: + logger.info("Sandbox: attach_screenshot_to_report(self, context)") + + if not self.production: + return True + + if self.screenshot_capture[1] != 0: + ctx.embed("text/plain", "Screenshot capture failed: \n{}\n".format(self.screenshot_capture), caption="Screenshot") + else: + ctx.embed("image/png", open("/tmp/screenshot.png", "rb").read(), caption="Screenshot") + + + def attach_image_to_report(self, ctx, image=None, caption="DefaultCaption"): + """ + Attach image to report upon user request. + + @param context : + Passed object. + @param image : str + Location of image/png file. + @param caption : str + Caption that is to be displayed in test report. + """ + + if self.logging: + logger.info("Sandbox: attach_image_to_report(self, context)") + + if not self.production: + return True + + if os.path.isfile(image) and hasattr(ctx, "embed"): + ctx.embed("image/png", open(image, "rb").read(), caption=caption) + + + def attach_video_to_report(self, ctx): + """ + Attach video to report upon failed test. + + @param context : + Passed object. + """ + + if self.logging: + logger.info("Sandbox: attach_video_to_report(self, context)") + + if not (self.production and self.recordVideo): + return True + + absolute_path_to_video = os.path.expanduser("~/Videos") + screencast_list = ["{}/{}".format(absolute_path_to_video, file_name) for file_name in os.listdir(absolute_path_to_video) if "Screencast" in file_name] + absolute_path_to_new_video = "{}/{}_{}.webm".format(absolute_path_to_video, self.component, self.current_scenario) + if screencast_list == []: + ctx.embed("text/plain", "No video file found.", caption="Video") + else: + ctx.embed("video/webm", open(screencast_list[0], "rb").read(), caption="Video") + run("mv {} {}".format(screencast_list[0], absolute_path_to_new_video)) + run("sudo rm -rf {}/Screencast*".format(absolute_path_to_video)) + + + def attach_journal_to_report(self, ctx): + """ + Attach journal to report upon failed test. + + @param context : + Passed object. + """ + if self.logging: + logger.info("Sandbox: attach_journal_to_report(self, context)") + + if not self.production: + return True + + journal_run = run("sudo journalctl --all --output=short-precise --since='{0}' > /tmp/journalctl-short.log".format(self.log_start), verbose=True) + if journal_run[1] != 0: + ctx.embed("text/plain", "Creation of journalctl file failed: \n{}\n".format(journal_run), caption="journalctl") + else: + ctx.embed("text/plain", open("/tmp/journalctl-short.log", "r").read(), caption="journalctl") + + + def attach_abrt_link_to_report(self, ctx): + """ + Attach abrt link to report upon detected abrt FAF report. + + @param context : + Passed object. + """ + + if self.logging: + logger.info("Sandbox: attach_abrt_link_to_report(self, context)") + + if not self.production: + return True + + faf_reports = set() + abrt_directories = run("sudo ls /var/spool/abrt/ | grep ccpp-").strip("\n").split("\n") + + for abrt_directory in abrt_directories: + try: + reason_file = "/var/spool/abrt/{}/reason".format(abrt_directory) + reported_to_file = "/var/spool/abrt/{}/reported_to".format(abrt_directory) + + abrt_faf_reason_run = run("sudo cat '{}'".format(reason_file), verbose=True) + abrt_faf_hyperlink_run = run("sudo cat '{}'".format(reported_to_file), verbose=True) + + if abrt_faf_reason_run[1] == 0 and abrt_faf_hyperlink_run[1] == 0: + abrt_faf_reason = abrt_faf_reason_run[0].strip("\n") + abrt_faf_hyperlink = abrt_faf_hyperlink_run[0].split("ABRT Server: URL=")[-1].split("\n")[0] + + faf_reports.add((abrt_faf_reason, abrt_faf_hyperlink)) + + except Exception as e: + print("Exception caught: {}".format(e)) + continue + + attachment_string = "" + for report in faf_reports: + attachment_string += "\nReason: {}".format(report[0]) + attachment_string += "\nFAF Link: {}\n".format(report[1]) + + if attachment_string and hasattr(ctx, "embed"): + ctx.embed("text/plain", attachment_string, caption="FAF reports") + + + def set_background(self, color=None, background_image=None): + """ + Change background to single color. Currently support for white/black/image. + + @param color : str + String black/white to set as background color. + @param background_image : str + Image location to be set as background. + """ + + if self.logging: + logger.info("Sandbox: set_background(self, color={}, background_image={}).".format(color, background_image)) + + if background_image: + run("gsettings set org.gnome.desktop.background picture-uri file://{}".format(background_image)) + elif color == "white": + run("gsettings set org.gnome.desktop.background picture-uri file://") # needed to remove the picture + run("gsettings set org.gnome.desktop.background primary-color \"#FFFFFF\"") + run("gsettings set org.gnome.desktop.background secondary-color \"#FFFFFF\"") + run("gsettings set org.gnome.desktop.background color-shading-type \"solid\"") + elif color == "black": + run("gsettings set org.gnome.desktop.background picture-uri file://") + run("gsettings set org.gnome.desktop.background primary-color \"#000000\"") + run("gsettings set org.gnome.desktop.background secondary-color \"#000000\"") + run("gsettings set org.gnome.desktop.background color-shading-type \"solid\"") + else: + logger.info("Sandbox: Color '{}' is not defined. Email modehnal@redhat.com for support.".format(color)) + + + def overview_action(self, action="hide"): + """ + Hide or show application overview. + + @param action : str + Hide or show application overview. + """ + + if self.logging: + logger.info("Sandbox: overview_action(self, action={})".format(action)) + + if action=="hide": + run("dbus-send --session --type=method_call --dest=org.gnome.Shell /org/gnome/Shell org.gnome.Shell.Eval string:'Main.overview.hide();'") + elif action=="show": + run("dbus-send --session --type=method_call --dest=org.gnome.Shell /org/gnome/Shell org.gnome.Shell.FocusSearch") + else: + assert False, "Unknown option" diff --git a/start_recording.py b/start_recording.py new file mode 100644 index 0000000..2d46920 --- /dev/null +++ b/start_recording.py @@ -0,0 +1,8 @@ +#!/usr/bin/env python3 +from pydbus import SessionBus +from time import sleep + +bus = SessionBus() +screencast = bus.get('org.gnome.Shell.Screencast', '/org/gnome/Shell/Screencast') +screencast.Screencast('/home/test/Videos/Screencast.webm',{}) +sleep(10000) diff --git a/time_limit.py b/time_limit.py new file mode 100644 index 0000000..3f6a136 --- /dev/null +++ b/time_limit.py @@ -0,0 +1,25 @@ +#!/usr/bin/env python3 +import contextlib +import errno +import os +import signal + +DEFAULT_TIMEOUT_MESSAGE = os.strerror(errno.ETIME) + +class timeout(contextlib.ContextDecorator): + def __init__(self, seconds, timeout_message=DEFAULT_TIMEOUT_MESSAGE, suppress_timeout_errors=False): + self.seconds = int(seconds) + self.timeout_message = timeout_message + self.suppress = bool(suppress_timeout_errors) + + def _timeout_handler(self, signum, frame): + raise TimeoutError(self.timeout_message) + + def __enter__(self): + signal.signal(signal.SIGALRM, self._timeout_handler) + signal.alarm(self.seconds) + + def __exit__(self, exception_type, exception_valeu, exception_traceback): + signal.alarm(0) + if self.suppress and exception_type is TimeoutError: + return True