diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f9ef9a5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +*.egg-info/ +*.pyc +*.sw? +*~ +.coverage +.eggs/ +.mypy_cache +.tox +__pycache__ +build/ +dist/ +version.txt +.mypy_cache/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..3111d72 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,37 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.4.0 + hooks: + - id: trailing-whitespace + - id: check-json + - id: check-yaml + +- repo: https://gitlab.com/pycqa/flake8 + rev: 3.8.3 + hooks: + - id: flake8 + +- repo: https://github.com/codespell-project/codespell + rev: v1.16.0 + hooks: + - id: codespell + +- repo: local + hooks: + - id: mypy + name: mypy + entry: mypy + args: [swh] + pass_filenames: false + language: system + types: [python] + +- repo: https://github.com/PyCQA/isort + rev: 5.5.2 + hooks: + - id: isort + +- repo: https://github.com/python/black + rev: 19.10b0 + hooks: + - id: black diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..c329086 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,3 @@ +Copyright (C) 2019 The Software Heritage developers + +See http://www.softwareheritage.org/ for more information. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0ad22b5 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,78 @@ +# Software Heritage Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as Software +Heritage contributors and maintainers pledge to making participation in our +project and our community a harassment-free experience for everyone, regardless +of age, body size, disability, ethnicity, sex characteristics, gender identity +and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at `conduct@softwareheritage.org`. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an +incident. Further details of specific enforcement policies may be posted +separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTORS b/CONTRIBUTORS new file mode 100644 index 0000000..e69de29 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/PKG-INFO b/PKG-INFO index 5dcb9b1..17acbf0 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,24 +1,25 @@ Metadata-Version: 2.1 Name: swh.icinga_plugins -Version: 0.0.2 +Version: 0.1.0 Summary: Icinga plugins for Software Heritage infrastructure monitoring Home-page: https://forge.softwareheritage.org/diffusion/swh-icinga-plugins Author: Software Heritage developers Author-email: swh-devel@inria.fr License: UNKNOWN Project-URL: Bug Reports, https://forge.softwareheritage.org/maniphest Project-URL: Funding, https://www.softwareheritage.org/donate Project-URL: Source, https://forge.softwareheritage.org/source/swh-icinga-plugins Description: swh-icinga-plugins ================== Scripts for end-to-end monitoring of the SWH infrastructure Platform: UNKNOWN Classifier: Programming Language :: Python :: 3 Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) Classifier: Operating System :: OS Independent Classifier: Development Status :: 3 - Alpha +Requires-Python: >=3.7 Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..58a761e --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +_build/ +apidoc/ +*-stamp diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..c30c50a --- /dev/null +++ b/docs/Makefile @@ -0,0 +1 @@ +include ../../swh-docs/Makefile.sphinx diff --git a/docs/_static/.placeholder b/docs/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/docs/_templates/.placeholder b/docs/_templates/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..190deb7 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from swh.docs.sphinx.conf import * # NoQA diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..3a7c929 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +Software Heritage - Python module template +========================================== + +Python module template, used as skeleton to create new modules. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/mypy.ini b/mypy.ini new file mode 100644 index 0000000..2b77ba2 --- /dev/null +++ b/mypy.ini @@ -0,0 +1,18 @@ +[mypy] +namespace_packages = True +warn_unused_ignores = True + + +# 3rd party libraries without stubs (yet) + +[mypy-pkg_resources.*] +ignore_missing_imports = True + +[mypy-pytest.*] +ignore_missing_imports = True + +[mypy-requests_mock.*] +ignore_missing_imports = True + +# [mypy-add_your_lib_here.*] +# ignore_missing_imports = True diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..69b8f4d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,11 @@ +[tool.black] +target-version = ['py37'] + +[tool.isort] +multi_line_output = 3 +include_trailing_comma = true +force_grid_wrap = 0 +use_parentheses = true +ensure_newline_before_comments = true +line_length = 88 +force_sort_within_sections = true diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..b712d00 --- /dev/null +++ b/pytest.ini @@ -0,0 +1,2 @@ +[pytest] +norecursedirs = docs .* diff --git a/requirements-swh.txt b/requirements-swh.txt index 4abaae7..8ec47d2 100644 --- a/requirements-swh.txt +++ b/requirements-swh.txt @@ -1,3 +1,3 @@ -swh.core[http] # required by swh.storage +swh.core[http] >= 0.3 swh.deposit swh.storage >= v0.0.162 diff --git a/requirements.txt b/requirements.txt index d49dc43..7748e9d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,2 @@ psycopg2 requests -vcversioner diff --git a/setup.cfg b/setup.cfg index 8bfd5a1..1d722c2 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,4 +1,8 @@ +[flake8] +ignore = E203,E231,W503 +max-line-length = 88 + [egg_info] tag_build = tag_date = 0 diff --git a/setup.py b/setup.py index 110bb92..7d0e2bd 100755 --- a/setup.py +++ b/setup.py @@ -1,80 +1,78 @@ #!/usr/bin/env python3 # Copyright (C) 2019-2020 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information -from setuptools import setup, find_packages - -from os import path, walk from io import open +from os import path, walk + +from setuptools import find_packages, setup here = path.abspath(path.dirname(__file__)) # Get the long description from the README file -with open(path.join(here, 'README.md'), encoding='utf-8') as f: +with open(path.join(here, "README.md"), encoding="utf-8") as f: long_description = f.read() def parse_requirements(name=None): if name: - reqf = 'requirements-%s.txt' % name + reqf = "requirements-%s.txt" % name else: - reqf = 'requirements.txt' + reqf = "requirements.txt" requirements = [] if not path.exists(reqf): return requirements with open(reqf) as f: for line in f.readlines(): line = line.strip() - if not line or line.startswith('#'): + if not line or line.startswith("#"): continue requirements.append(line) return requirements # package generated static assets as module data files data_files = [] -for root, _, files in walk('data/'): +for root, _, files in walk("data/"): root_files = [path.join(root, i) for i in files] - data_files.append((path.join('share/swh/icinga-plugins', root), - root_files)) + data_files.append((path.join("share/swh/icinga-plugins", root), root_files)) setup( - name='swh.icinga_plugins', - description='Icinga plugins for Software Heritage infrastructure ' - 'monitoring', + name="swh.icinga_plugins", + description="Icinga plugins for Software Heritage infrastructure " "monitoring", long_description=long_description, - long_description_content_type='text/markdown', - author='Software Heritage developers', - author_email='swh-devel@inria.fr', - url='https://forge.softwareheritage.org/diffusion/swh-icinga-plugins', + long_description_content_type="text/markdown", + python_requires=">=3.7", + author="Software Heritage developers", + author_email="swh-devel@inria.fr", + url="https://forge.softwareheritage.org/diffusion/swh-icinga-plugins", packages=find_packages(), # packages's modules - install_requires=parse_requirements() + parse_requirements('swh'), - tests_require=parse_requirements('test'), - setup_requires=['vcversioner'], - extras_require={'testing': parse_requirements('test')}, - vcversioner={}, + install_requires=parse_requirements() + parse_requirements("swh"), + tests_require=parse_requirements("test"), + setup_requires=["setuptools-scm"], + use_scm_version=True, + extras_require={"testing": parse_requirements("test")}, include_package_data=True, - entry_points=''' + entry_points=""" [swh.cli.subcommands] - icinga_plugins=swh.icinga_plugins.cli:cli - ''', + icinga_plugins=swh.icinga_plugins.cli + """, classifiers=[ "Programming Language :: Python :: 3", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Development Status :: 3 - Alpha", ], project_urls={ - 'Bug Reports': 'https://forge.softwareheritage.org/maniphest', - 'Funding': 'https://www.softwareheritage.org/donate', - 'Source': - 'https://forge.softwareheritage.org/source/swh-icinga-plugins', + "Bug Reports": "https://forge.softwareheritage.org/maniphest", + "Funding": "https://www.softwareheritage.org/donate", + "Source": "https://forge.softwareheritage.org/source/swh-icinga-plugins", }, - data_files=data_files + data_files=data_files, ) diff --git a/swh.icinga_plugins.egg-info/PKG-INFO b/swh.icinga_plugins.egg-info/PKG-INFO index e20533b..1bdbb68 100644 --- a/swh.icinga_plugins.egg-info/PKG-INFO +++ b/swh.icinga_plugins.egg-info/PKG-INFO @@ -1,24 +1,25 @@ Metadata-Version: 2.1 Name: swh.icinga-plugins -Version: 0.0.2 +Version: 0.1.0 Summary: Icinga plugins for Software Heritage infrastructure monitoring Home-page: https://forge.softwareheritage.org/diffusion/swh-icinga-plugins Author: Software Heritage developers Author-email: swh-devel@inria.fr License: UNKNOWN Project-URL: Bug Reports, https://forge.softwareheritage.org/maniphest Project-URL: Funding, https://www.softwareheritage.org/donate Project-URL: Source, https://forge.softwareheritage.org/source/swh-icinga-plugins Description: swh-icinga-plugins ================== Scripts for end-to-end monitoring of the SWH infrastructure Platform: UNKNOWN Classifier: Programming Language :: Python :: 3 Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) Classifier: Operating System :: OS Independent Classifier: Development Status :: 3 - Alpha +Requires-Python: >=3.7 Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/swh.icinga_plugins.egg-info/SOURCES.txt b/swh.icinga_plugins.egg-info/SOURCES.txt index 96d2d49..bb58e0c 100644 --- a/swh.icinga_plugins.egg-info/SOURCES.txt +++ b/swh.icinga_plugins.egg-info/SOURCES.txt @@ -1,28 +1,44 @@ +.gitignore +.pre-commit-config.yaml +AUTHORS +CODE_OF_CONDUCT.md +CONTRIBUTORS +LICENSE MANIFEST.in Makefile README.md +mypy.ini +pyproject.toml +pytest.ini requirements-swh.txt requirements-test.txt requirements.txt +setup.cfg setup.py -version.txt +tox.ini data/deposit/jesuisgpl.tgz data/deposit/jesuisgpl.tgz.xml +docs/.gitignore +docs/Makefile +docs/conf.py +docs/index.rst +docs/_static/.placeholder +docs/_templates/.placeholder swh/__init__.py swh.icinga_plugins.egg-info/PKG-INFO swh.icinga_plugins.egg-info/SOURCES.txt swh.icinga_plugins.egg-info/dependency_links.txt swh.icinga_plugins.egg-info/entry_points.txt swh.icinga_plugins.egg-info/requires.txt swh.icinga_plugins.egg-info/top_level.txt swh/icinga_plugins/__init__.py swh/icinga_plugins/base_check.py swh/icinga_plugins/cli.py swh/icinga_plugins/deposit.py swh/icinga_plugins/py.typed swh/icinga_plugins/vault.py swh/icinga_plugins/tests/__init__.py swh/icinga_plugins/tests/conftest.py swh/icinga_plugins/tests/test_deposit.py swh/icinga_plugins/tests/test_vault.py swh/icinga_plugins/tests/web_scenario.py \ No newline at end of file diff --git a/swh.icinga_plugins.egg-info/entry_points.txt b/swh.icinga_plugins.egg-info/entry_points.txt index cf84265..1d44810 100644 --- a/swh.icinga_plugins.egg-info/entry_points.txt +++ b/swh.icinga_plugins.egg-info/entry_points.txt @@ -1,4 +1,4 @@ [swh.cli.subcommands] - icinga_plugins=swh.icinga_plugins.cli:cli + icinga_plugins=swh.icinga_plugins.cli \ No newline at end of file diff --git a/swh.icinga_plugins.egg-info/requires.txt b/swh.icinga_plugins.egg-info/requires.txt index 5040820..714c3c9 100644 --- a/swh.icinga_plugins.egg-info/requires.txt +++ b/swh.icinga_plugins.egg-info/requires.txt @@ -1,11 +1,10 @@ psycopg2 requests -vcversioner -swh.core[http] +swh.core[http]>=0.3 swh.deposit swh.storage>=v0.0.162 [testing] pytest pytest-mock requests-mock diff --git a/swh/icinga_plugins/base_check.py b/swh/icinga_plugins/base_check.py index b3f29dc..ce60aed 100644 --- a/swh/icinga_plugins/base_check.py +++ b/swh/icinga_plugins/base_check.py @@ -1,25 +1,27 @@ # Copyright (C) 2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information class BaseCheck: def __init__(self, obj): self.warning_threshold = obj.get( - 'warning_threshold', self.DEFAULT_WARNING_THRESHOLD) + "warning_threshold", self.DEFAULT_WARNING_THRESHOLD + ) self.critical_threshold = obj.get( - 'critical_threshold', self.DEFAULT_CRITICAL_THRESHOLD) + "critical_threshold", self.DEFAULT_CRITICAL_THRESHOLD + ) def get_status(self, value): if self.critical_threshold and value >= self.critical_threshold: - return (2, 'CRITICAL') + return (2, "CRITICAL") elif self.warning_threshold and value >= self.warning_threshold: - return (1, 'WARNING') + return (1, "WARNING") else: - return (0, 'OK') + return (0, "OK") def print_result(self, status_type, status_string, **metrics): - print(f'{self.TYPE} {status_type} - {status_string}') + print(f"{self.TYPE} {status_type} - {status_string}") for (metric_name, metric_value) in sorted(metrics.items()): print(f"| '{metric_name}' = {metric_value:.2f}s") diff --git a/swh/icinga_plugins/cli.py b/swh/icinga_plugins/cli.py index 08b437d..26ce1fa 100644 --- a/swh/icinga_plugins/cli.py +++ b/swh/icinga_plugins/cli.py @@ -1,80 +1,103 @@ -# Copyright (C) 2019 The Software Heritage developers +# Copyright (C) 2019-2020 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information +# WARNING: do not import unnecessary things here to keep cli startup time under +# control import sys import click -from swh.core.cli import CONTEXT_SETTINGS +from swh.core.cli import CONTEXT_SETTINGS, swh as swh_cli_group -from .deposit import DepositCheck -from .vault import VaultCheck - -@click.group(name='icinga_plugins', context_settings=CONTEXT_SETTINGS) -@click.option('-w', '--warning', type=int, - help='Warning threshold.') -@click.option('-c', '--critical', type=int, - help='Critical threshold.') +@swh_cli_group.group(name="icinga_plugins", context_settings=CONTEXT_SETTINGS) +@click.option("-w", "--warning", type=int, help="Warning threshold.") +@click.option("-c", "--critical", type=int, help="Critical threshold.") @click.pass_context -def cli(ctx, warning, critical): +def icinga_cli_group(ctx, warning, critical): """Main command for Icinga plugins """ ctx.ensure_object(dict) if warning: - ctx.obj['warning_threshold'] = int(warning) + ctx.obj["warning_threshold"] = int(warning) if critical: - ctx.obj['critical_threshold'] = int(critical) + ctx.obj["critical_threshold"] = int(critical) -@cli.group(name='check-vault') -@click.option('--swh-storage-url', type=str, required=True, - help='URL to an swh-storage HTTP API') -@click.option('--swh-web-url', type=str, required=True, - help='URL to an swh-web instance') -@click.option('--poll-interval', type=int, default=10, - help='Interval (in seconds) between two polls to the API, ' - 'to check for cooking status.') +@icinga_cli_group.group(name="check-vault") +@click.option( + "--swh-storage-url", type=str, required=True, help="URL to an swh-storage HTTP API" +) +@click.option( + "--swh-web-url", type=str, required=True, help="URL to an swh-web instance" +) +@click.option( + "--poll-interval", + type=int, + default=10, + help="Interval (in seconds) between two polls to the API, " + "to check for cooking status.", +) @click.pass_context def check_vault(ctx, **kwargs): ctx.obj.update(kwargs) -@check_vault.command(name='directory') +@check_vault.command(name="directory") @click.pass_context def check_vault_directory(ctx): """Picks a random directory, requests its cooking via swh-web, and waits for completion.""" + from .vault import VaultCheck + sys.exit(VaultCheck(ctx.obj).main()) -@cli.group(name='check-deposit') -@click.option('--server', type=str, - default='https://deposit.softwareheritage.org/1', - help='URL to the SWORD server to test') -@click.option('--username', type=str, required=True, - help='Login for the SWORD server') -@click.option('--password', type=str, required=True, - help='Password for the SWORD server') -@click.option('--collection', type=str, required=True, - help='Software collection to use on the SWORD server') -@click.option('--poll-interval', type=int, default=10, - help='Interval (in seconds) between two polls to the API, ' - 'to check for ingestion status.') +@icinga_cli_group.group(name="check-deposit") +@click.option( + "--server", + type=str, + default="https://deposit.softwareheritage.org/1", + help="URL to the SWORD server to test", +) +@click.option("--username", type=str, required=True, help="Login for the SWORD server") +@click.option( + "--password", type=str, required=True, help="Password for the SWORD server" +) +@click.option( + "--collection", + type=str, + required=True, + help="Software collection to use on the SWORD server", +) +@click.option( + "--poll-interval", + type=int, + default=10, + help="Interval (in seconds) between two polls to the API, " + "to check for ingestion status.", +) @click.pass_context def check_deposit(ctx, **kwargs): ctx.obj.update(kwargs) -@check_deposit.command(name='single') -@click.option('--archive', type=click.Path(), required=True, - help='Software artefact to upload') -@click.option('--metadata', type=click.Path(), required=True, - help='Metadata file for the software artefact.') +@check_deposit.command(name="single") +@click.option( + "--archive", type=click.Path(), required=True, help="Software artefact to upload" +) +@click.option( + "--metadata", + type=click.Path(), + required=True, + help="Metadata file for the software artefact.", +) @click.pass_context def check_deposit_single(ctx, **kwargs): """Checks the provided archive and metadata file and be deposited.""" + from .deposit import DepositCheck + ctx.obj.update(kwargs) sys.exit(DepositCheck(ctx.obj).main()) diff --git a/swh/icinga_plugins/deposit.py b/swh/icinga_plugins/deposit.py index 92fffe1..26271c4 100644 --- a/swh/icinga_plugins/deposit.py +++ b/swh/icinga_plugins/deposit.py @@ -1,122 +1,128 @@ # Copyright (C) 2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information import datetime import sys import time -from .base_check import BaseCheck - from swh.deposit.client import PublicApiDepositClient +from .base_check import BaseCheck + class DepositCheck(BaseCheck): - TYPE = 'DEPOSIT' + TYPE = "DEPOSIT" DEFAULT_WARNING_THRESHOLD = 120 DEFAULT_CRITICAL_THRESHOLD = 3600 def __init__(self, obj): super().__init__(obj) - self._poll_interval = obj['poll_interval'] - self._archive_path = obj['archive'] - self._metadata_path = obj['metadata'] - self._collection = obj['collection'] - - self._client = PublicApiDepositClient({ - 'url': obj['server'], - 'auth': { - 'username': obj['username'], - 'password': obj['password'], - }, - }) + self._poll_interval = obj["poll_interval"] + self._archive_path = obj["archive"] + self._metadata_path = obj["metadata"] + self._collection = obj["collection"] + + self._client = PublicApiDepositClient( + { + "url": obj["server"], + "auth": {"username": obj["username"], "password": obj["password"]}, + } + ) def upload_deposit(self): result = self._client.deposit_create( - archive=self._archive_path, metadata=self._metadata_path, - collection=self._collection, in_progress=False, - slug='check-deposit-%s' % datetime.datetime.now().isoformat()) - self._deposit_id = result['deposit_id'] + archive=self._archive_path, + metadata=self._metadata_path, + collection=self._collection, + in_progress=False, + slug="check-deposit-%s" % datetime.datetime.now().isoformat(), + ) + self._deposit_id = result["deposit_id"] return result def get_deposit_status(self): return self._client.deposit_status( - collection=self._collection, - deposit_id=self._deposit_id) + collection=self._collection, deposit_id=self._deposit_id + ) def wait_while_status(self, statuses, start_time, metrics, result): - while result['deposit_status'] in statuses: - metrics['total_time'] = time.time() - start_time - if metrics['total_time'] > self.critical_threshold: + while result["deposit_status"] in statuses: + metrics["total_time"] = time.time() - start_time + if metrics["total_time"] > self.critical_threshold: self.print_result( - 'CRITICAL', - f'Timed out while in status ' + "CRITICAL", + f"Timed out while in status " f'{result["deposit_status"]} ' f'({metrics["total_time"]}s seconds since deposit ' - f'started)', - **metrics) + f"started)", + **metrics, + ) sys.exit(2) time.sleep(self._poll_interval) result = self.get_deposit_status() return result def main(self): start_time = time.time() metrics = {} # Upload the archive and metadata result = self.upload_deposit() - metrics['upload_time'] = time.time() - start_time + metrics["upload_time"] = time.time() - start_time # Wait for validation - result = self.wait_while_status( - ['deposited'], start_time, metrics, result) - metrics['total_time'] = time.time() - start_time - metrics['validation_time'] = \ - metrics['total_time'] - metrics['upload_time'] + result = self.wait_while_status(["deposited"], start_time, metrics, result) + metrics["total_time"] = time.time() - start_time + metrics["validation_time"] = metrics["total_time"] - metrics["upload_time"] # Check validation succeeded - if result['deposit_status'] == 'rejected': + if result["deposit_status"] == "rejected": self.print_result( - 'CRITICAL', + "CRITICAL", f'Deposit was rejected: {result["deposit_status_detail"]}', - **metrics) + **metrics, + ) return 2 # Wait for loading result = self.wait_while_status( - ['verified', 'loading'], start_time, metrics, result) - metrics['total_time'] = time.time() - start_time - metrics['load_time'] = ( - metrics['total_time'] - metrics['upload_time'] - - metrics['validation_time']) + ["verified", "loading"], start_time, metrics, result + ) + metrics["total_time"] = time.time() - start_time + metrics["load_time"] = ( + metrics["total_time"] - metrics["upload_time"] - metrics["validation_time"] + ) # Check loading succeeded - if result['deposit_status'] == 'failed': + if result["deposit_status"] == "failed": self.print_result( - 'CRITICAL', + "CRITICAL", f'Deposit loading failed: {result["deposit_status_detail"]}', - **metrics) + **metrics, + ) return 2 # Check for unexpected status - if result['deposit_status'] != 'done': + if result["deposit_status"] != "done": self.print_result( - 'CRITICAL', + "CRITICAL", f'Deposit got unexpected status: {result["deposit_status"]} ' f'({result["deposit_status_detail"]})', - **metrics) + **metrics, + ) return 2 # Everything went fine, check total time wasn't too large and # print result - (status_code, status) = self.get_status(metrics['total_time']) + (status_code, status) = self.get_status(metrics["total_time"]) self.print_result( status, f'Deposit took {metrics["total_time"]:.2f}s and succeeded.', - **metrics) + **metrics, + ) return status_code diff --git a/swh/icinga_plugins/tests/conftest.py b/swh/icinga_plugins/tests/conftest.py index 860b69e..5aa807a 100644 --- a/swh/icinga_plugins/tests/conftest.py +++ b/swh/icinga_plugins/tests/conftest.py @@ -1,25 +1,25 @@ # Copyright (C) 2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information import time import pytest @pytest.fixture def mocked_time(mocker): start_time = time.time() time_offset = 0 def fake_sleep(seconds): nonlocal time_offset time_offset += seconds def fake_time(): return start_time + time_offset - mocker.patch('time.sleep', side_effect=fake_sleep) - mocker.patch('time.time', side_effect=fake_time) + mocker.patch("time.sleep", side_effect=fake_sleep) + mocker.patch("time.time", side_effect=fake_time) diff --git a/swh/icinga_plugins/tests/test_deposit.py b/swh/icinga_plugins/tests/test_deposit.py index 7df3095..de4327c 100644 --- a/swh/icinga_plugins/tests/test_deposit.py +++ b/swh/icinga_plugins/tests/test_deposit.py @@ -1,375 +1,467 @@ # Copyright (C) 2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information import io import os import tarfile import time from click.testing import CliRunner import pytest -from swh.icinga_plugins.cli import cli -from .web_scenario import WebScenario +from swh.icinga_plugins.cli import icinga_cli_group +from .web_scenario import WebScenario -BASE_URL = 'http://swh-deposit.example.org/1' +BASE_URL = "http://swh-deposit.example.org/1" COMMON_OPTIONS = [ - '--server', BASE_URL, - '--username', 'test', - '--password', 'test', - '--collection', 'testcol', + "--server", + BASE_URL, + "--username", + "test", + "--password", + "test", + "--collection", + "testcol", ] -SAMPLE_METADATA = ''' +SAMPLE_METADATA = """ Test Software swh test-software No One -''' +""" -ENTRY_TEMPLATE = ''' +ENTRY_TEMPLATE = """ 42 2019-12-19 18:11:00 foo.tar.gz {status} http://purl.org/net/sword/package/SimpleZip -''' +""" -STATUS_TEMPLATE = ''' +STATUS_TEMPLATE = """ 42 {status} {status_detail} -''' +""" -@pytest.fixture(scope='session') +@pytest.fixture(scope="session") def tmp_path(tmp_path_factory): return tmp_path_factory.mktemp(__name__) -@pytest.fixture(scope='session') +@pytest.fixture(scope="session") def sample_metadata(tmp_path): """Returns a sample metadata file's path """ - path = os.path.join(tmp_path, 'metadata.xml') + path = os.path.join(tmp_path, "metadata.xml") - with open(path, 'w') as fd: + with open(path, "w") as fd: fd.write(SAMPLE_METADATA) return path -@pytest.fixture(scope='session') +@pytest.fixture(scope="session") def sample_archive(tmp_path): """Returns a sample archive's path """ - path = os.path.join(tmp_path, 'archive.tar.gz') + path = os.path.join(tmp_path, "archive.tar.gz") - with tarfile.open(path, 'w:gz') as tf: - tf.addfile( - tarfile.TarInfo('hello.py'), - io.BytesIO(b'print("Hello world")')) + with tarfile.open(path, "w:gz") as tf: + tf.addfile(tarfile.TarInfo("hello.py"), io.BytesIO(b'print("Hello world")')) return path def invoke(args, catch_exceptions=False): runner = CliRunner() - result = runner.invoke(cli, args) + result = runner.invoke(icinga_cli_group, args) if not catch_exceptions and result.exception: print(result.output) raise result.exception return result def test_deposit_immediate_success( - requests_mock, mocker, sample_archive, sample_metadata, mocked_time): + requests_mock, mocker, sample_archive, sample_metadata, mocked_time +): scenario = WebScenario() scenario.add_step( - 'post', BASE_URL + '/testcol/', - ENTRY_TEMPLATE.format(status='done')) + "post", BASE_URL + "/testcol/", ENTRY_TEMPLATE.format(status="done") + ) scenario.install_mock(requests_mock) - result = invoke([ - 'check-deposit', - *COMMON_OPTIONS, - 'single', - '--archive', sample_archive, - '--metadata', sample_metadata, - ]) + result = invoke( + [ + "check-deposit", + *COMMON_OPTIONS, + "single", + "--archive", + sample_archive, + "--metadata", + sample_metadata, + ] + ) assert result.output == ( "DEPOSIT OK - Deposit took 0.00s and succeeded.\n" "| 'load_time' = 0.00s\n" "| 'total_time' = 0.00s\n" "| 'upload_time' = 0.00s\n" - "| 'validation_time' = 0.00s\n") + "| 'validation_time' = 0.00s\n" + ) assert result.exit_code == 0, result.output def test_deposit_delays( - requests_mock, mocker, sample_archive, sample_metadata, mocked_time): + requests_mock, mocker, sample_archive, sample_metadata, mocked_time +): scenario = WebScenario() scenario.add_step( - 'post', BASE_URL + '/testcol/', - ENTRY_TEMPLATE.format(status='deposited')) + "post", BASE_URL + "/testcol/", ENTRY_TEMPLATE.format(status="deposited") + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='verified', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="verified", status_detail=""), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='loading', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="loading", status_detail=""), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='done', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="done", status_detail=""), + ) scenario.install_mock(requests_mock) - result = invoke([ - 'check-deposit', - *COMMON_OPTIONS, - 'single', - '--archive', sample_archive, - '--metadata', sample_metadata, - ]) + result = invoke( + [ + "check-deposit", + *COMMON_OPTIONS, + "single", + "--archive", + sample_archive, + "--metadata", + sample_metadata, + ] + ) assert result.output == ( "DEPOSIT OK - Deposit took 30.00s and succeeded.\n" "| 'load_time' = 20.00s\n" "| 'total_time' = 30.00s\n" "| 'upload_time' = 0.00s\n" - "| 'validation_time' = 10.00s\n") + "| 'validation_time' = 10.00s\n" + ) assert result.exit_code == 0, result.output def test_deposit_delay_warning( - requests_mock, mocker, sample_archive, sample_metadata, mocked_time): + requests_mock, mocker, sample_archive, sample_metadata, mocked_time +): scenario = WebScenario() scenario.add_step( - 'post', BASE_URL + '/testcol/', - ENTRY_TEMPLATE.format(status='deposited')) + "post", BASE_URL + "/testcol/", ENTRY_TEMPLATE.format(status="deposited") + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='verified', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="verified", status_detail=""), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='done', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="done", status_detail=""), + ) scenario.install_mock(requests_mock) - result = invoke([ - '--warning', '15', - 'check-deposit', - *COMMON_OPTIONS, - 'single', - '--archive', sample_archive, - '--metadata', sample_metadata, - ], catch_exceptions=True) + result = invoke( + [ + "--warning", + "15", + "check-deposit", + *COMMON_OPTIONS, + "single", + "--archive", + sample_archive, + "--metadata", + sample_metadata, + ], + catch_exceptions=True, + ) assert result.output == ( "DEPOSIT WARNING - Deposit took 20.00s and succeeded.\n" "| 'load_time' = 10.00s\n" "| 'total_time' = 20.00s\n" "| 'upload_time' = 0.00s\n" - "| 'validation_time' = 10.00s\n") + "| 'validation_time' = 10.00s\n" + ) assert result.exit_code == 1, result.output def test_deposit_delay_critical( - requests_mock, mocker, sample_archive, sample_metadata, mocked_time): + requests_mock, mocker, sample_archive, sample_metadata, mocked_time +): scenario = WebScenario() scenario.add_step( - 'post', BASE_URL + '/testcol/', - ENTRY_TEMPLATE.format(status='deposited')) + "post", BASE_URL + "/testcol/", ENTRY_TEMPLATE.format(status="deposited") + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='verified', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="verified", status_detail=""), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='done', status_detail=''), - callback=lambda: time.sleep(60)) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="done", status_detail=""), + callback=lambda: time.sleep(60), + ) scenario.install_mock(requests_mock) - result = invoke([ - '--critical', '50', - 'check-deposit', - *COMMON_OPTIONS, - 'single', - '--archive', sample_archive, - '--metadata', sample_metadata, - ], catch_exceptions=True) + result = invoke( + [ + "--critical", + "50", + "check-deposit", + *COMMON_OPTIONS, + "single", + "--archive", + sample_archive, + "--metadata", + sample_metadata, + ], + catch_exceptions=True, + ) assert result.output == ( "DEPOSIT CRITICAL - Deposit took 80.00s and succeeded.\n" "| 'load_time' = 70.00s\n" "| 'total_time' = 80.00s\n" "| 'upload_time' = 0.00s\n" - "| 'validation_time' = 10.00s\n") + "| 'validation_time' = 10.00s\n" + ) assert result.exit_code == 2, result.output def test_deposit_timeout( - requests_mock, mocker, sample_archive, sample_metadata, mocked_time): + requests_mock, mocker, sample_archive, sample_metadata, mocked_time +): scenario = WebScenario() scenario.add_step( - 'post', BASE_URL + '/testcol/', - ENTRY_TEMPLATE.format(status='deposited'), - callback=lambda: time.sleep(1500)) + "post", + BASE_URL + "/testcol/", + ENTRY_TEMPLATE.format(status="deposited"), + callback=lambda: time.sleep(1500), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='verified', status_detail=''), - callback=lambda: time.sleep(1500)) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="verified", status_detail=""), + callback=lambda: time.sleep(1500), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='loading', status_detail=''), - callback=lambda: time.sleep(1500)) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="loading", status_detail=""), + callback=lambda: time.sleep(1500), + ) scenario.install_mock(requests_mock) - result = invoke([ - 'check-deposit', - *COMMON_OPTIONS, - 'single', - '--archive', sample_archive, - '--metadata', sample_metadata, - ], catch_exceptions=True) + result = invoke( + [ + "check-deposit", + *COMMON_OPTIONS, + "single", + "--archive", + sample_archive, + "--metadata", + sample_metadata, + ], + catch_exceptions=True, + ) assert result.output == ( "DEPOSIT CRITICAL - Timed out while in status loading " "(4520.0s seconds since deposit started)\n" "| 'total_time' = 4520.00s\n" "| 'upload_time' = 1500.00s\n" - "| 'validation_time' = 1510.00s\n") + "| 'validation_time' = 1510.00s\n" + ) assert result.exit_code == 2, result.output def test_deposit_rejected( - requests_mock, mocker, sample_archive, sample_metadata, mocked_time): + requests_mock, mocker, sample_archive, sample_metadata, mocked_time +): scenario = WebScenario() scenario.add_step( - 'post', BASE_URL + '/testcol/', - ENTRY_TEMPLATE.format(status='deposited')) + "post", BASE_URL + "/testcol/", ENTRY_TEMPLATE.format(status="deposited") + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='rejected', status_detail='booo')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="rejected", status_detail="booo"), + ) scenario.install_mock(requests_mock) - result = invoke([ - 'check-deposit', - *COMMON_OPTIONS, - 'single', - '--archive', sample_archive, - '--metadata', sample_metadata, - ], catch_exceptions=True) + result = invoke( + [ + "check-deposit", + *COMMON_OPTIONS, + "single", + "--archive", + sample_archive, + "--metadata", + sample_metadata, + ], + catch_exceptions=True, + ) assert result.output == ( "DEPOSIT CRITICAL - Deposit was rejected: booo\n" "| 'total_time' = 10.00s\n" "| 'upload_time' = 0.00s\n" - "| 'validation_time' = 10.00s\n") + "| 'validation_time' = 10.00s\n" + ) assert result.exit_code == 2, result.output def test_deposit_failed( - requests_mock, mocker, sample_archive, sample_metadata, mocked_time): + requests_mock, mocker, sample_archive, sample_metadata, mocked_time +): scenario = WebScenario() scenario.add_step( - 'post', BASE_URL + '/testcol/', - ENTRY_TEMPLATE.format(status='deposited')) + "post", BASE_URL + "/testcol/", ENTRY_TEMPLATE.format(status="deposited") + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='verified', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="verified", status_detail=""), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='loading', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="loading", status_detail=""), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='failed', status_detail='booo')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="failed", status_detail="booo"), + ) scenario.install_mock(requests_mock) - result = invoke([ - 'check-deposit', - *COMMON_OPTIONS, - 'single', - '--archive', sample_archive, - '--metadata', sample_metadata, - ], catch_exceptions=True) + result = invoke( + [ + "check-deposit", + *COMMON_OPTIONS, + "single", + "--archive", + sample_archive, + "--metadata", + sample_metadata, + ], + catch_exceptions=True, + ) assert result.output == ( "DEPOSIT CRITICAL - Deposit loading failed: booo\n" "| 'load_time' = 20.00s\n" "| 'total_time' = 30.00s\n" "| 'upload_time' = 0.00s\n" - "| 'validation_time' = 10.00s\n") + "| 'validation_time' = 10.00s\n" + ) assert result.exit_code == 2, result.output def test_deposit_unexpected_status( - requests_mock, mocker, sample_archive, sample_metadata, mocked_time): + requests_mock, mocker, sample_archive, sample_metadata, mocked_time +): scenario = WebScenario() scenario.add_step( - 'post', BASE_URL + '/testcol/', - ENTRY_TEMPLATE.format(status='deposited')) + "post", BASE_URL + "/testcol/", ENTRY_TEMPLATE.format(status="deposited") + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='verified', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="verified", status_detail=""), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='loading', status_detail='')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="loading", status_detail=""), + ) scenario.add_step( - 'get', BASE_URL + '/testcol/42/status/', - STATUS_TEMPLATE.format(status='what', status_detail='booo')) + "get", + BASE_URL + "/testcol/42/status/", + STATUS_TEMPLATE.format(status="what", status_detail="booo"), + ) scenario.install_mock(requests_mock) - result = invoke([ - 'check-deposit', - *COMMON_OPTIONS, - 'single', - '--archive', sample_archive, - '--metadata', sample_metadata, - ], catch_exceptions=True) + result = invoke( + [ + "check-deposit", + *COMMON_OPTIONS, + "single", + "--archive", + sample_archive, + "--metadata", + sample_metadata, + ], + catch_exceptions=True, + ) assert result.output == ( "DEPOSIT CRITICAL - Deposit got unexpected status: what (booo)\n" "| 'load_time' = 20.00s\n" "| 'total_time' = 30.00s\n" "| 'upload_time' = 0.00s\n" - "| 'validation_time' = 10.00s\n") + "| 'validation_time' = 10.00s\n" + ) assert result.exit_code == 2, result.output diff --git a/swh/icinga_plugins/tests/test_vault.py b/swh/icinga_plugins/tests/test_vault.py index ee99db4..787612a 100644 --- a/swh/icinga_plugins/tests/test_vault.py +++ b/swh/icinga_plugins/tests/test_vault.py @@ -1,256 +1,291 @@ # Copyright (C) 2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information import time from click.testing import CliRunner -from swh.icinga_plugins.cli import cli -from .web_scenario import WebScenario +from swh.icinga_plugins.cli import icinga_cli_group +from .web_scenario import WebScenario -dir_id = 'ab'*20 +dir_id = "ab" * 20 response_pending = { "obj_id": dir_id, "obj_type": "directory", "progress_message": "foo", - "status": "pending" + "status": "pending", } response_done = { "fetch_url": f"/api/1/vault/directory/{dir_id}/raw/", "id": 9, "obj_id": dir_id, "obj_type": "directory", - "status": "done" + "status": "done", } response_failed = { "obj_id": dir_id, "obj_type": "directory", "progress_message": "foobar", - "status": "failed" + "status": "failed", } response_unknown_status = { "obj_id": dir_id, "obj_type": "directory", "progress_message": "what", - "status": "boo" + "status": "boo", } class FakeStorage: def __init__(self, foo, **kwargs): pass def directory_get_random(self): return bytes.fromhex(dir_id) def invoke(args, catch_exceptions=False): runner = CliRunner() - result = runner.invoke(cli, args) + result = runner.invoke(icinga_cli_group, args) if not catch_exceptions and result.exception: print(result.output) raise result.exception return result def test_vault_immediate_success(requests_mock, mocker, mocked_time): scenario = WebScenario() - url = f'mock://swh-web.example.org/api/1/vault/directory/{dir_id}/' + url = f"mock://swh-web.example.org/api/1/vault/directory/{dir_id}/" - scenario.add_step('get', url, {}, status_code=404) - scenario.add_step('post', url, response_pending) - scenario.add_step('get', url, response_done) + scenario.add_step("get", url, {}, status_code=404) + scenario.add_step("post", url, response_pending) + scenario.add_step("get", url, response_done) scenario.install_mock(requests_mock) - get_storage_mock = mocker.patch('swh.icinga_plugins.vault.get_storage') + get_storage_mock = mocker.patch("swh.icinga_plugins.vault.get_storage") get_storage_mock.side_effect = FakeStorage - result = invoke([ - 'check-vault', - '--swh-web-url', 'mock://swh-web.example.org', - '--swh-storage-url', 'foo://example.org', - 'directory', - ]) + result = invoke( + [ + "check-vault", + "--swh-web-url", + "mock://swh-web.example.org", + "--swh-storage-url", + "foo://example.org", + "directory", + ] + ) assert result.output == ( f"VAULT OK - cooking directory {dir_id} took " f"10.00s and succeeded.\n" - f"| 'total_time' = 10.00s\n") + f"| 'total_time' = 10.00s\n" + ) assert result.exit_code == 0, result.output def test_vault_delayed_success(requests_mock, mocker, mocked_time): scenario = WebScenario() - url = f'mock://swh-web.example.org/api/1/vault/directory/{dir_id}/' + url = f"mock://swh-web.example.org/api/1/vault/directory/{dir_id}/" - scenario.add_step('get', url, {}, status_code=404) - scenario.add_step('post', url, response_pending) - scenario.add_step('get', url, response_pending) - scenario.add_step('get', url, response_done) + scenario.add_step("get", url, {}, status_code=404) + scenario.add_step("post", url, response_pending) + scenario.add_step("get", url, response_pending) + scenario.add_step("get", url, response_done) scenario.install_mock(requests_mock) - get_storage_mock = mocker.patch('swh.icinga_plugins.vault.get_storage') + get_storage_mock = mocker.patch("swh.icinga_plugins.vault.get_storage") get_storage_mock.side_effect = FakeStorage - result = invoke([ - 'check-vault', - '--swh-web-url', 'mock://swh-web.example.org', - '--swh-storage-url', 'foo://example.org', - 'directory', - ]) + result = invoke( + [ + "check-vault", + "--swh-web-url", + "mock://swh-web.example.org", + "--swh-storage-url", + "foo://example.org", + "directory", + ] + ) assert result.output == ( f"VAULT OK - cooking directory {dir_id} took " f"20.00s and succeeded.\n" - f"| 'total_time' = 20.00s\n") + f"| 'total_time' = 20.00s\n" + ) assert result.exit_code == 0, result.output def test_vault_failure(requests_mock, mocker, mocked_time): scenario = WebScenario() - url = f'mock://swh-web.example.org/api/1/vault/directory/{dir_id}/' + url = f"mock://swh-web.example.org/api/1/vault/directory/{dir_id}/" - scenario.add_step('get', url, {}, status_code=404) - scenario.add_step('post', url, response_pending) - scenario.add_step('get', url, response_failed) + scenario.add_step("get", url, {}, status_code=404) + scenario.add_step("post", url, response_pending) + scenario.add_step("get", url, response_failed) scenario.install_mock(requests_mock) - get_storage_mock = mocker.patch('swh.icinga_plugins.vault.get_storage') + get_storage_mock = mocker.patch("swh.icinga_plugins.vault.get_storage") get_storage_mock.side_effect = FakeStorage - result = invoke([ - 'check-vault', - '--swh-web-url', 'mock://swh-web.example.org', - '--swh-storage-url', 'foo://example.org', - 'directory', - ], catch_exceptions=True) + result = invoke( + [ + "check-vault", + "--swh-web-url", + "mock://swh-web.example.org", + "--swh-storage-url", + "foo://example.org", + "directory", + ], + catch_exceptions=True, + ) assert result.output == ( f"VAULT CRITICAL - cooking directory {dir_id} took " f"10.00s and failed with: foobar\n" - f"| 'total_time' = 10.00s\n") + f"| 'total_time' = 10.00s\n" + ) assert result.exit_code == 2, result.output def test_vault_unknown_status(requests_mock, mocker, mocked_time): scenario = WebScenario() - url = f'mock://swh-web.example.org/api/1/vault/directory/{dir_id}/' + url = f"mock://swh-web.example.org/api/1/vault/directory/{dir_id}/" - scenario.add_step('get', url, {}, status_code=404) - scenario.add_step('post', url, response_pending) - scenario.add_step('get', url, response_unknown_status) + scenario.add_step("get", url, {}, status_code=404) + scenario.add_step("post", url, response_pending) + scenario.add_step("get", url, response_unknown_status) scenario.install_mock(requests_mock) - get_storage_mock = mocker.patch('swh.icinga_plugins.vault.get_storage') + get_storage_mock = mocker.patch("swh.icinga_plugins.vault.get_storage") get_storage_mock.side_effect = FakeStorage - result = invoke([ - 'check-vault', - '--swh-web-url', 'mock://swh-web.example.org', - '--swh-storage-url', 'foo://example.org', - 'directory', - ], catch_exceptions=True) + result = invoke( + [ + "check-vault", + "--swh-web-url", + "mock://swh-web.example.org", + "--swh-storage-url", + "foo://example.org", + "directory", + ], + catch_exceptions=True, + ) assert result.output == ( f"VAULT CRITICAL - cooking directory {dir_id} took " f"10.00s and resulted in unknown status: boo\n" - f"| 'total_time' = 10.00s\n") + f"| 'total_time' = 10.00s\n" + ) assert result.exit_code == 2, result.output def test_vault_timeout(requests_mock, mocker, mocked_time): scenario = WebScenario() - url = f'mock://swh-web.example.org/api/1/vault/directory/{dir_id}/' + url = f"mock://swh-web.example.org/api/1/vault/directory/{dir_id}/" - scenario.add_step('get', url, {}, status_code=404) - scenario.add_step('post', url, response_pending) - scenario.add_step('get', url, response_pending) - scenario.add_step('get', url, response_pending, - callback=lambda: time.sleep(4000)) + scenario.add_step("get", url, {}, status_code=404) + scenario.add_step("post", url, response_pending) + scenario.add_step("get", url, response_pending) + scenario.add_step("get", url, response_pending, callback=lambda: time.sleep(4000)) scenario.install_mock(requests_mock) - get_storage_mock = mocker.patch('swh.icinga_plugins.vault.get_storage') + get_storage_mock = mocker.patch("swh.icinga_plugins.vault.get_storage") get_storage_mock.side_effect = FakeStorage - result = invoke([ - 'check-vault', - '--swh-web-url', 'mock://swh-web.example.org', - '--swh-storage-url', 'foo://example.org', - 'directory', - ], catch_exceptions=True) + result = invoke( + [ + "check-vault", + "--swh-web-url", + "mock://swh-web.example.org", + "--swh-storage-url", + "foo://example.org", + "directory", + ], + catch_exceptions=True, + ) assert result.output == ( f"VAULT CRITICAL - cooking directory {dir_id} took more than " f"4020.00s and has status: foo\n" - f"| 'total_time' = 4020.00s\n") + f"| 'total_time' = 4020.00s\n" + ) assert result.exit_code == 2, result.output def test_vault_cached_directory(requests_mock, mocker, mocked_time): """First serves a directory that's already in the cache, to test that vault_check requests another one.""" scenario = WebScenario() - url = f'mock://swh-web.example.org/api/1/vault/directory/{dir_id}/' + url = f"mock://swh-web.example.org/api/1/vault/directory/{dir_id}/" - scenario.add_step('get', url, {}, status_code=200) - scenario.add_step('get', url, {}, status_code=404) - scenario.add_step('post', url, response_pending) - scenario.add_step('get', url, response_done) + scenario.add_step("get", url, {}, status_code=200) + scenario.add_step("get", url, {}, status_code=404) + scenario.add_step("post", url, response_pending) + scenario.add_step("get", url, response_done) scenario.install_mock(requests_mock) - get_storage_mock = mocker.patch('swh.icinga_plugins.vault.get_storage') + get_storage_mock = mocker.patch("swh.icinga_plugins.vault.get_storage") get_storage_mock.side_effect = FakeStorage - result = invoke([ - 'check-vault', - '--swh-web-url', 'mock://swh-web.example.org', - '--swh-storage-url', 'foo://example.org', - 'directory', - ]) + result = invoke( + [ + "check-vault", + "--swh-web-url", + "mock://swh-web.example.org", + "--swh-storage-url", + "foo://example.org", + "directory", + ] + ) assert result.output == ( f"VAULT OK - cooking directory {dir_id} took " f"10.00s and succeeded.\n" - f"| 'total_time' = 10.00s\n") + f"| 'total_time' = 10.00s\n" + ) assert result.exit_code == 0, result.output def test_vault_no_directory(requests_mock, mocker, mocked_time): """Tests with an empty storage""" scenario = WebScenario() scenario.install_mock(requests_mock) - get_storage_mock = mocker.patch('swh.icinga_plugins.vault.get_storage') + get_storage_mock = mocker.patch("swh.icinga_plugins.vault.get_storage") get_storage_mock.side_effect = FakeStorage - mocker.patch( - f'{__name__}.FakeStorage.directory_get_random', return_value=None) - - result = invoke([ - 'check-vault', - '--swh-web-url', 'mock://swh-web.example.org', - '--swh-storage-url', 'foo://example.org', - 'directory', - ], catch_exceptions=True) - - assert result.output == ( - "VAULT CRITICAL - No directory exists in the archive.\n") + mocker.patch(f"{__name__}.FakeStorage.directory_get_random", return_value=None) + + result = invoke( + [ + "check-vault", + "--swh-web-url", + "mock://swh-web.example.org", + "--swh-storage-url", + "foo://example.org", + "directory", + ], + catch_exceptions=True, + ) + + assert result.output == ("VAULT CRITICAL - No directory exists in the archive.\n") assert result.exit_code == 2, result.output diff --git a/swh/icinga_plugins/tests/web_scenario.py b/swh/icinga_plugins/tests/web_scenario.py index 0a0c57e..26c8d81 100644 --- a/swh/icinga_plugins/tests/web_scenario.py +++ b/swh/icinga_plugins/tests/web_scenario.py @@ -1,90 +1,90 @@ # Copyright (C) 2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information """Wrapper around requests-mock to mock successive responses from a web service. Tests can build successive steps by calling :py:meth:`WebScenario.add_step` with specifications of what endpoints should be called and in what order.""" from dataclasses import dataclass import json -from typing import List, Set, Optional, Callable +from typing import Callable, List, Optional, Set import requests_mock @dataclass(frozen=True) class Step: expected_method: str expected_url: str response: object status_code: int = 200 callback: Optional[Callable[[], int]] = None @dataclass(frozen=True) class Endpoint: method: str url: str class WebScenario: """Stores the state of the successive calls to the web service expected by tests.""" _steps: List[Step] _endpoints: Set[Endpoint] _current_step: int def __init__(self): self._steps = [] self._endpoints = set() self._current_step = 0 def add_endpoint(self, *args, **kwargs): """Adds an endpoint to be mocked. Arguments are the same as :py:class:Endpoint. """ self._endpoints.add(Endpoint(*args, **kwargs)) def add_step(self, *args, **kwargs): """Adds an expected call to the list of expected calls. Also automatically calls :py:meth:`add_endpoint` so the associated endpoint is mocked. Arguments are the same as :py:class:`Step`. """ step = Step(*args, **kwargs) self._steps.append(step) self.add_endpoint(step.expected_method, step.expected_url) def install_mock(self, mocker: requests_mock.Mocker): """Mocks entrypoints registered with :py:meth:`add_endpoint` (or :py:meth:`add_step`) using the provided mocker. """ for endpoint in self._endpoints: mocker.register_uri( - endpoint.method.upper(), endpoint.url, - text=self._request_callback) + endpoint.method.upper(), endpoint.url, text=self._request_callback + ) def _request_callback(self, request, context): step = self._steps[self._current_step] assert request.url == step.expected_url assert request.method.upper() == step.expected_method.upper() self._current_step += 1 context.status_code = step.status_code if step.callback: step.callback() if isinstance(step.response, str): return step.response else: return json.dumps(step.response) diff --git a/swh/icinga_plugins/vault.py b/swh/icinga_plugins/vault.py index 95c1883..03d4d1c 100644 --- a/swh/icinga_plugins/vault.py +++ b/swh/icinga_plugins/vault.py @@ -1,98 +1,100 @@ # Copyright (C) 2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information import time import requests from swh.storage import get_storage from .base_check import BaseCheck class NoDirectory(Exception): pass class VaultCheck(BaseCheck): - TYPE = 'VAULT' + TYPE = "VAULT" DEFAULT_WARNING_THRESHOLD = 0 DEFAULT_CRITICAL_THRESHOLD = 3600 def __init__(self, obj): super().__init__(obj) - self._swh_storage = get_storage('remote', url=obj['swh_storage_url']) - self._swh_web_url = obj['swh_web_url'] - self._poll_interval = obj['poll_interval'] + self._swh_storage = get_storage("remote", url=obj["swh_storage_url"]) + self._swh_web_url = obj["swh_web_url"] + self._poll_interval = obj["poll_interval"] def _url_for_dir(self, dir_id): - return self._swh_web_url + f'/api/1/vault/directory/{dir_id.hex()}/' + return self._swh_web_url + f"/api/1/vault/directory/{dir_id.hex()}/" def _pick_directory(self): dir_ = self._swh_storage.directory_get_random() if dir_ is None: raise NoDirectory() return dir_ def _pick_uncached_directory(self): while True: dir_id = self._pick_directory() response = requests.get(self._url_for_dir(dir_id)) if response.status_code == 404: return dir_id def main(self): try: dir_id = self._pick_uncached_directory() except NoDirectory: - self.print_result( - 'CRITICAL', - 'No directory exists in the archive.') + self.print_result("CRITICAL", "No directory exists in the archive.") return 2 start_time = time.time() total_time = 0 response = requests.post(self._url_for_dir(dir_id)) assert response.status_code == 200, (response, response.text) result = response.json() - while result['status'] in ('new', 'pending'): + while result["status"] in ("new", "pending"): time.sleep(self._poll_interval) response = requests.get(self._url_for_dir(dir_id)) assert response.status_code == 200, (response, response.text) result = response.json() total_time = time.time() - start_time if total_time > self.critical_threshold: self.print_result( - 'CRITICAL', - f'cooking directory {dir_id.hex()} took more than ' - f'{total_time:.2f}s and has status: ' + "CRITICAL", + f"cooking directory {dir_id.hex()} took more than " + f"{total_time:.2f}s and has status: " f'{result["progress_message"]}', - total_time=total_time) + total_time=total_time, + ) return 2 - if result['status'] == 'done': + if result["status"] == "done": (status_code, status) = self.get_status(total_time) self.print_result( status, - f'cooking directory {dir_id.hex()} took {total_time:.2f}s ' - f'and succeeded.', - total_time=total_time) + f"cooking directory {dir_id.hex()} took {total_time:.2f}s " + f"and succeeded.", + total_time=total_time, + ) return status_code - elif result['status'] == 'failed': + elif result["status"] == "failed": self.print_result( - 'CRITICAL', - f'cooking directory {dir_id.hex()} took {total_time:.2f}s ' + "CRITICAL", + f"cooking directory {dir_id.hex()} took {total_time:.2f}s " f'and failed with: {result["progress_message"]}', - total_time=total_time) + total_time=total_time, + ) return 2 else: self.print_result( - 'CRITICAL', - f'cooking directory {dir_id.hex()} took {total_time:.2f}s ' + "CRITICAL", + f"cooking directory {dir_id.hex()} took {total_time:.2f}s " f'and resulted in unknown status: {result["status"]}', - total_time=total_time) + total_time=total_time, + ) return 2 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..041cd4a --- /dev/null +++ b/tox.ini @@ -0,0 +1,34 @@ +[tox] +envlist=black,flake8,mypy,py3 + +[testenv:py3] +deps = + .[testing] + pytest-cov +commands = + pytest --doctest-modules \ + {envsitepackagesdir}/swh/icinga_plugins \ + --cov={envsitepackagesdir}/swh/icinga_plugins \ + --cov-branch {posargs} + +[testenv:black] +skip_install = true +deps = + black +commands = + {envpython} -m black --check swh + +[testenv:flake8] +skip_install = true +deps = + flake8 +commands = + {envpython} -m flake8 + +[testenv:mypy] +skip_install = true +deps = + .[testing] + mypy +commands = + mypy swh diff --git a/version.txt b/version.txt deleted file mode 100644 index 398088f..0000000 --- a/version.txt +++ /dev/null @@ -1 +0,0 @@ -v0.0.2-0-g8d0abfa \ No newline at end of file