diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 303d302..0000000 --- a/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -*.pyc -*.sw? -*~ -.coverage -.eggs/ -__pycache__ -*.egg-info/ -dist -version.txt diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index 2d0a34a..0000000 --- a/AUTHORS +++ /dev/null @@ -1,3 +0,0 @@ -Copyright (C) 2015 The Software Heritage developers - -See http://www.softwareheritage.org/ for more information. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 94a9ed0..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - 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 baf9ee5..ce01f59 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,10 +1,25 @@ -Metadata-Version: 1.0 +Metadata-Version: 2.1 Name: swh.loader.debian -Version: 0.0.11 +Version: 0.0.13 Summary: Software Heritage Debian loader Home-page: https://forge.softwareheritage.org/diffusion/DLDDEB/ Author: Software Heritage developers Author-email: swh-devel@inria.fr License: UNKNOWN -Description: UNKNOWN +Project-URL: Funding, https://www.softwareheritage.org/donate +Project-URL: Source, https://forge.softwareheritage.org/source/swh-loader-debian +Project-URL: Bug Reports, https://forge.softwareheritage.org/maniphest +Description: swh-loader-debian + ================= + + The Software Heritage Debian Loader is a tool and a library to inject + unknown files contained in a debian source archive into the SWH dataset + 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 :: 5 - Production/Stable +Description-Content-Type: text/markdown +Provides-Extra: testing diff --git a/README b/README.md similarity index 79% rename from README rename to README.md index d3a3b9f..516fe01 100644 --- a/README +++ b/README.md @@ -1,3 +1,5 @@ +swh-loader-debian +================= + The Software Heritage Debian Loader is a tool and a library to inject unknown files contained in a debian source archive into the SWH dataset - diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 58a761e..0000000 --- a/docs/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -_build/ -apidoc/ -*-stamp diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index c30c50a..0000000 --- a/docs/Makefile +++ /dev/null @@ -1 +0,0 @@ -include ../../swh-docs/Makefile.sphinx diff --git a/docs/_static/.placeholder b/docs/_static/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/docs/_templates/.placeholder b/docs/_templates/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 190deb7..0000000 --- a/docs/conf.py +++ /dev/null @@ -1 +0,0 @@ -from swh.docs.sphinx.conf import * # NoQA diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 9fb48b8..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _swh-loader-debian: - -Software Heritage - Development Documentation -============================================= - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/requirements-swh.txt b/requirements-swh.txt index 83ba2be..ec2cd5d 100644 --- a/requirements-swh.txt +++ b/requirements-swh.txt @@ -1,5 +1,5 @@ swh.core -swh.loader.core >= 0.0.32 -swh.model >= 0.0.18 -swh.scheduler >= 0.0.14 +swh.loader.core >= 0.0.37 +swh.model >= 0.0.27 +swh.scheduler >= 0.0.39 swh.storage[schemata] diff --git a/setup.py b/setup.py old mode 100644 new mode 100755 index d68a7a0..9c4d1d4 --- a/setup.py +++ b/setup.py @@ -1,28 +1,66 @@ +#!/usr/bin/env python3 +# Copyright (C) 2015-2018 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 +from io import open + +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: + long_description = f.read() + + +def parse_requirements(name=None): + if name: + reqf = 'requirements-%s.txt' % name + else: + reqf = 'requirements.txt' -def parse_requirements(): requirements = [] - for reqf in ('requirements.txt', 'requirements-swh.txt'): - with open(reqf) as f: - for line in f.readlines(): - line = line.strip() - if not line or line.startswith('#'): - continue - requirements.append(line) + 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('#'): + continue + requirements.append(line) return requirements setup( name='swh.loader.debian', description='Software Heritage Debian loader', + 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/DLDDEB/', packages=find_packages(), scripts=[], - install_requires=parse_requirements(), + install_requires=parse_requirements() + parse_requirements('swh'), setup_requires=['vcversioner'], + extras_require={'testing': parse_requirements('test')}, vcversioner={}, include_package_data=True, + classifiers=[ + "Programming Language :: Python :: 3", + "Intended Audience :: Developers", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: OS Independent", + "Development Status :: 5 - Production/Stable", + ], + project_urls={ + 'Bug Reports': 'https://forge.softwareheritage.org/maniphest', + 'Funding': 'https://www.softwareheritage.org/donate', + 'Source': ( + 'https://forge.softwareheritage.org/source/swh-loader-debian'), + }, ) diff --git a/swh.loader.debian.egg-info/PKG-INFO b/swh.loader.debian.egg-info/PKG-INFO index baf9ee5..ce01f59 100644 --- a/swh.loader.debian.egg-info/PKG-INFO +++ b/swh.loader.debian.egg-info/PKG-INFO @@ -1,10 +1,25 @@ -Metadata-Version: 1.0 +Metadata-Version: 2.1 Name: swh.loader.debian -Version: 0.0.11 +Version: 0.0.13 Summary: Software Heritage Debian loader Home-page: https://forge.softwareheritage.org/diffusion/DLDDEB/ Author: Software Heritage developers Author-email: swh-devel@inria.fr License: UNKNOWN -Description: UNKNOWN +Project-URL: Funding, https://www.softwareheritage.org/donate +Project-URL: Source, https://forge.softwareheritage.org/source/swh-loader-debian +Project-URL: Bug Reports, https://forge.softwareheritage.org/maniphest +Description: swh-loader-debian + ================= + + The Software Heritage Debian Loader is a tool and a library to inject + unknown files contained in a debian source archive into the SWH dataset + 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 :: 5 - Production/Stable +Description-Content-Type: text/markdown +Provides-Extra: testing diff --git a/swh.loader.debian.egg-info/SOURCES.txt b/swh.loader.debian.egg-info/SOURCES.txt index a521f9a..5d7deaa 100644 --- a/swh.loader.debian.egg-info/SOURCES.txt +++ b/swh.loader.debian.egg-info/SOURCES.txt @@ -1,33 +1,20 @@ -.gitignore -AUTHORS -LICENSE MANIFEST.in Makefile -README +README.md requirements-swh.txt requirements.txt setup.py version.txt -debian/changelog -debian/compat -debian/control -debian/copyright -debian/rules -debian/source/format -docs/.gitignore -docs/Makefile -docs/conf.py -docs/index.rst -docs/_static/.placeholder -docs/_templates/.placeholder swh/__init__.py swh.loader.debian.egg-info/PKG-INFO swh.loader.debian.egg-info/SOURCES.txt swh.loader.debian.egg-info/dependency_links.txt swh.loader.debian.egg-info/requires.txt swh.loader.debian.egg-info/top_level.txt swh/loader/__init__.py swh/loader/debian/__init__.py swh/loader/debian/converters.py swh/loader/debian/loader.py -swh/loader/debian/tasks.py \ No newline at end of file +swh/loader/debian/tasks.py +swh/loader/debian/tests/__init__.py +swh/loader/debian/tests/test_loader.py \ No newline at end of file diff --git a/swh.loader.debian.egg-info/requires.txt b/swh.loader.debian.egg-info/requires.txt index 5df15fe..73c26ff 100644 --- a/swh.loader.debian.egg-info/requires.txt +++ b/swh.loader.debian.egg-info/requires.txt @@ -1,7 +1,12 @@ python-debian +vcversioner swh.core -swh.loader.core>=0.0.32 -swh.model>=0.0.18 -swh.scheduler>=0.0.14 +swh.loader.core>=0.0.37 +swh.model>=0.0.27 +swh.scheduler>=0.0.39 swh.storage[schemata] -vcversioner + +[testing] +pytest +requests-mock +sqlalchemy diff --git a/swh/loader/debian/loader.py b/swh/loader/debian/loader.py index d958048..deb76a6 100644 --- a/swh/loader/debian/loader.py +++ b/swh/loader/debian/loader.py @@ -1,516 +1,508 @@ # Copyright (C) 2015-2018 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 copy import hashlib import logging import os import re import subprocess import tempfile from dateutil.parser import parse as parse_date from debian.changelog import Changelog from debian.deb822 import Dsc import requests from sqlalchemy import create_engine from sqlalchemy.orm import sessionmaker -from swh.loader.core.loader import SWHLoader +from swh.loader.core.loader import BufferedLoader from swh.storage.schemata.distribution import Package from swh.model import hashutil from swh.model.from_disk import Directory from swh.model.identifiers import identifier_to_bytes, snapshot_identifier from . import converters UPLOADERS_SPLIT = re.compile(r'(?<=\>)\s*,\s*') log = logging.getLogger(__name__) class DebianLoaderException(Exception): pass class PackageDownloadFailed(DebianLoaderException): """Raise this exception when a package extraction failed""" pass class PackageExtractionFailed(DebianLoaderException): """Raise this exception when a package extraction failed""" pass def _debian_to_hashlib(hashname): """Convert Debian hash names to hashlib-compatible names""" return { 'md5sum': 'md5', }.get(hashname, hashname) def download_package(package): """Fetch a source package in a temporary directory and check the checksums for all files""" tempdir = tempfile.TemporaryDirectory( prefix='swh.loader.debian.%s.' % package['name'] ) for filename, fileinfo in copy.deepcopy(package['files']).items(): uri = fileinfo.pop('uri') hashes = { hashname: hashlib.new(_debian_to_hashlib(hashname)) for hashname in fileinfo if hashname not in ('name', 'size') } r = requests.get(uri, stream=True) if r.status_code != 200: raise PackageDownloadFailed( 'Download of %s returned status_code %s: %s' % (uri, r.status_code, r.text) ) size = 0 with open(os.path.join(tempdir.name, filename), 'wb') as f: for chunk in r.iter_content(chunk_size=1024 * 1024): size += len(chunk) f.write(chunk) for hash in hashes.values(): hash.update(chunk) downloadinfo = { 'name': filename, 'size': size, } for hashname, hash in hashes.items(): downloadinfo[hashname] = hash.hexdigest() if fileinfo != downloadinfo: raise PackageDownloadFailed( 'Checksums mismatch: fetched %s, expected %s' % (downloadinfo, fileinfo) ) return tempdir def extract_package(package, tempdir): """Extract a Debian source package to a given directory Note that after extraction the target directory will be the root of the extracted package, rather than containing it. Args: package (dict): package information dictionary tempdir (str): directory where the package files are stored Returns: tuple: path to the dsc (str) and extraction directory (str) """ dsc_name = None for filename in package['files']: if filename.endswith('.dsc'): if dsc_name: raise PackageExtractionFailed( 'Package %s_%s references several dsc files' % (package['name'], package['version']) ) dsc_name = filename dsc_path = os.path.join(tempdir.name, dsc_name) destdir = os.path.join(tempdir.name, 'extracted') logfile = os.path.join(tempdir.name, 'extract.log') log.debug('extract Debian source package %s in %s' % (dsc_path, destdir), extra={ 'swh_type': 'deb_extract', 'swh_dsc': dsc_path, 'swh_destdir': destdir, }) cmd = ['dpkg-source', '--no-copy', '--no-check', '--ignore-bad-version', '-x', dsc_path, destdir] try: with open(logfile, 'w') as stdout: subprocess.check_call(cmd, stdout=stdout, stderr=subprocess.STDOUT) except subprocess.CalledProcessError as e: logdata = open(logfile, 'r').read() raise PackageExtractionFailed('dpkg-source exited with code %s: %s' % (e.returncode, logdata)) from None return dsc_path, destdir def get_file_info(filepath): """Retrieve the original file information from the file at filepath. Args: filepath: the path to the original file Returns: dict: information about the original file, in a dictionary with the following keys - name: the file name - sha1, sha1_git, sha256: original file hashes - length: original file length """ name = os.path.basename(filepath) if isinstance(name, bytes): name = name.decode('utf-8') - ret = { - 'name': name, - } - - hashes = hashutil.hash_path(filepath) - for hash in hashes: - if hash == 'length': - ret[hash] = hashes[hash] - continue - ret[hash] = hashutil.hash_to_hex(hashes[hash]) - - return ret + hashes = hashutil.MultiHash.from_path(filepath).hexdigest() + hashes['name'] = name + hashes['length'] = os.path.getsize(filepath) + return hashes def get_package_metadata(package, dsc_path, extracted_path): """Get the package metadata from the source package at dsc_path, extracted in extracted_path. Args: package: the package dict (with a dsc_path key) dsc_path: path to the package's dsc file extracted_path: the path where the package got extracted Returns: dict: a dictionary with the following keys: - history: list of (package_name, package_version) tuples parsed from the package changelog - source_files: information about all the files in the source package """ ret = {} with open(dsc_path, 'rb') as dsc: parsed_dsc = Dsc(dsc) source_files = [get_file_info(dsc_path)] dsc_dir = os.path.dirname(dsc_path) for filename in package['files']: file_path = os.path.join(dsc_dir, filename) file_info = get_file_info(file_path) source_files.append(file_info) ret['original_artifact'] = source_files # Parse the changelog to retrieve the rest of the package information changelog_path = os.path.join(extracted_path, 'debian/changelog') with open(changelog_path, 'rb') as changelog: try: parsed_changelog = Changelog(changelog) except UnicodeDecodeError: log.warn('Unknown encoding for changelog %s,' ' falling back to iso' % changelog_path.decode('utf-8'), extra={ 'swh_type': 'deb_changelog_encoding', 'swh_name': package['name'], 'swh_version': str(package['version']), 'swh_changelog': changelog_path.decode('utf-8'), }) # need to reset as Changelog scrolls to the end of the file changelog.seek(0) parsed_changelog = Changelog(changelog, encoding='iso-8859-15') package_info = { 'name': package['name'], 'version': str(package['version']), 'changelog': { 'person': converters.uid_to_person(parsed_changelog.author), 'date': parse_date(parsed_changelog.date), 'history': [(block.package, str(block.version)) for block in parsed_changelog][1:], } } maintainers = [ converters.uid_to_person(parsed_dsc['Maintainer'], encode=False), ] maintainers.extend( converters.uid_to_person(person, encode=False) for person in UPLOADERS_SPLIT.split(parsed_dsc.get('Uploaders', '')) ) package_info['maintainers'] = maintainers ret['package_info'] = package_info return ret def process_package(package): """Process a source package into its constituent components. The source package will be decompressed in a temporary directory. Args: package (dict): a dict with the following keys: - name: source package name - version: source package version - dsc: the full path of the package's DSC file. Returns: tuple: A tuple with two elements: - package: the original package dict augmented with the following keys: - metadata: the metadata from get_package_metadata - directory: the sha1_git of the root directory of the package - objects: a dictionary of the parsed directories and files, both indexed by id Raises: FileNotFoundError: if the dsc file does not exist PackageExtractionFailed: if package extraction failed """ log.info("Processing package %s_%s" % (package['name'], str(package['version'])), extra={ 'swh_type': 'deb_process_start', 'swh_name': package['name'], 'swh_version': str(package['version']), }) tempdir = download_package(package) dsc, debdir = extract_package(package, tempdir) directory = Directory.from_disk(path=os.fsencode(debdir), save_path=True) metadata = get_package_metadata(package, dsc, debdir) return directory, metadata, tempdir -class DebianLoader(SWHLoader): +class DebianLoader(BufferedLoader): """A loader for Debian packages""" CONFIG_BASE_FILENAME = 'loader/debian' ADDITIONAL_CONFIG = { 'lister_db_url': ('str', 'postgresql:///lister-debian'), } def __init__(self, config=None): super().__init__(logging_class=None, config=config) self.db_engine = create_engine(self.config['lister_db_url']) self.mk_session = sessionmaker(bind=self.db_engine) self.db_session = self.mk_session() def load(self, *, origin, date, packages): return super().load(origin=origin, date=date, packages=packages) def prepare_origin_visit(self, *, origin, date, packages): self.origin = origin self.visit_date = date def prepare(self, *, origin, date, packages): self.packages = packages # Deduplicate branches according to equivalent files branches_files = {} branches_revs = {} equiv_branch = {} for branch, package in packages.items(): if 'files' not in package: # already loaded, use default values branches_revs[branch] = identifier_to_bytes( package['revision_id'] ) equiv_branch[branch] = branch continue for eq_branch, files in branches_files.items(): if package['files'] == files: equiv_branch[branch] = eq_branch if (not branches_revs[eq_branch] and package['revision_id']): branches_revs[eq_branch] = identifier_to_bytes( package['revision_id'] ) break else: # No match: new entry equiv_branch[branch] = branch branches_files[branch] = package['files'] if package['revision_id']: branches_revs[branch] = identifier_to_bytes( package['revision_id'] ) else: branches_revs[branch] = None self.equivs = { 'branches': equiv_branch, 'revisions': branches_revs, } self.versions_to_load = [ (branch, self.packages[branch]) for branch in sorted(branches_revs) if not branches_revs[branch] ] self.version_idx = 0 self.done = self.version_idx >= len(self.versions_to_load) self.current_data = {} self.tempdirs = [] self.partial = False def fetch_data(self): if self.done: return False branch, package = self.versions_to_load[self.version_idx] self.version_idx += 1 try: directory, metadata, tempdir = process_package(package) self.tempdirs.append(tempdir) self.current_data = directory.collect() revision = converters.package_metadata_to_revision( package, directory, metadata ) self.current_data['revision'] = { revision['id']: revision, } self.equivs['revisions'][branch] = revision['id'] - except DebianLoaderException as e: + except DebianLoaderException: log.exception('Package %s_%s failed to load' % (package['name'], package['version'])) self.partial = True self.done = self.version_idx >= len(self.versions_to_load) return not self.done def store_data(self): self.maybe_load_contents( self.current_data.get('content', {}).values()) self.maybe_load_directories( self.current_data.get('directory', {}).values()) self.maybe_load_revisions( self.current_data.get('revision', {}).values()) self.current_data = {} if self.done: self.flush() self.update_packages() self.generate_and_load_snapshot() def update_packages(self): for branch in self.packages: package = self.packages[branch] if package['revision_id']: continue rev = self.equivs['revisions'][self.equivs['branches'][branch]] if not rev: continue db_package = self.db_session.query(Package)\ .filter(Package.id == package['id'])\ .one() db_package.revision_id = rev self.db_session.commit() def generate_and_load_snapshot(self): """Create a SWH archive "snapshot" of the package being loaded, and send it to the archive. """ branches = {} for branch in self.packages: rev = self.equivs['revisions'][self.equivs['branches'][branch]] if rev: target = { 'target_type': 'revision', 'target': rev, } else: self.partial = True target = None branches[branch.encode('utf-8')] = target snapshot = {'branches': branches} snapshot['id'] = identifier_to_bytes(snapshot_identifier(snapshot)) self.maybe_load_snapshot(snapshot) def load_status(self): status = 'eventful' if self.versions_to_load else 'uneventful' return { 'status': status if not self.partial else 'failed', } def visit_status(self): return 'partial' if self.partial else 'full' def cleanup(self): for d in self.tempdirs: d.cleanup() if __name__ == '__main__': import click import logging logging.basicConfig( level=logging.DEBUG, format='%(asctime)s %(process)d %(message)s' ) @click.command() @click.option('--origin-url', required=1, help='Origin url to associate') @click.option('--packages', help='Debian packages to load') @click.option('--visit-date', default=None, help='Visit date time override') def main(origin_url, packages, visit_date): """Loading debian package tryout.""" origin = {'url': origin_url, 'type': 'deb'} if not packages: packages = { "buster/main/3.2.3-1": { "id": 178584, "name": "alex", "version": "3.2.3-1", "revision_id": "e8b2fe173ab909aa49d40b59292a44c2668e8a26" }, "jessie/main/3.1.3-1": { "id": 230994, "name": "alex", "version": "3.1.3-1", "revision_id": "9a7c853d4cb2521f59108d8d5f21f26a800038ca" }, } DebianLoader().load(origin=origin, date=visit_date, packages=packages) main() diff --git a/swh/loader/debian/tasks.py b/swh/loader/debian/tasks.py index b635c70..b793769 100644 --- a/swh/loader/debian/tasks.py +++ b/swh/loader/debian/tasks.py @@ -1,17 +1,13 @@ # Copyright (C) 2017 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 swh.scheduler.task import Task +from celery import current_app as app from .loader import DebianLoader -class LoadDebianPackage(Task): - task_queue = 'swh_loader_debian' - - def run_task(self, *, origin, date, packages): - loader = DebianLoader() - return loader.load(origin=origin, date=date, packages=packages) +@app.task(name=__name__ + '.LoadDebianPackage') +def load_debian_packages(origin, date, packages): + return DebianLoader().load(origin=origin, date=date, packages=packages) diff --git a/swh/loader/debian/tests/__init__.py b/swh/loader/debian/tests/__init__.py new file mode 100644 index 0000000..9ef4c60 --- /dev/null +++ b/swh/loader/debian/tests/__init__.py @@ -0,0 +1,27 @@ +import os + +TEST_LOADER_CONFIG = { + 'storage': { + 'cls': 'memory', + 'args': { + } + }, + 'send_contents': True, + 'send_directories': True, + 'send_revisions': True, + 'send_releases': True, + 'send_snapshot': True, + + 'content_size_limit': 100 * 1024 * 1024, + 'content_packet_size': 10, + 'content_packet_size_bytes': 100 * 1024 * 1024, + 'directory_packet_size': 10, + 'revision_packet_size': 10, + 'release_packet_size': 10, + + 'save_data': False, + + 'lister_db_url': + 'postgresql+psycopg2:///test-lister-debian?host={PGHOST}'.format( + **os.environ) +} diff --git a/swh/loader/debian/tests/test_loader.py b/swh/loader/debian/tests/test_loader.py new file mode 100644 index 0000000..e13fcb8 --- /dev/null +++ b/swh/loader/debian/tests/test_loader.py @@ -0,0 +1,148 @@ +# Copyright (C) 2018 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 os +from unittest import TestCase + +import pytest +import requests_mock + +from swh.core.tests.db_testing import SingleDbTestFixture +from swh.model.hashutil import hash_to_bytes +from swh.storage.schemata.distribution import SQLBase +from swh.loader.core.tests import BaseLoaderTest +from swh.loader.debian.loader import get_file_info, DebianLoader + +from . import TEST_LOADER_CONFIG + +RESOURCES_PATH = os.path.join(os.path.dirname(__file__), 'resources') + + +class DebianLoaderTest(DebianLoader): + def parse_config_file(self, *args, **kwargs): + return TEST_LOADER_CONFIG + + +@pytest.mark.fs +class TestFileInfo(TestCase): + + def test_get_file_info(self): + path = '%s/%s' % (RESOURCES_PATH, 'onefile.txt') + + actual_info = get_file_info(path) + + expected_info = { + 'name': 'onefile.txt', + 'length': 62, + 'sha1': '135572f4ac013f49e624612301f9076af1eacef2', + 'sha1_git': '1d62cd247ef251d52d98bbd931d44ad1f967ea99', + 'sha256': '40f1a3cbe9355879319759bae1a6ba09cbf34056e79e951cd2dc0adbff169b9f', # noqa + 'blake2s256': '4072cf9a0017ad7705a9995bbfbbc098276e6a3afea8d84ab54bff6381c897ab', # noqa + } + + self.assertEqual(actual_info, expected_info) + + +@pytest.mark.fs +class TestDebianLoader(SingleDbTestFixture, BaseLoaderTest): + TEST_DB_NAME = 'test-lister-debian' + TEST_DB_DUMP = [] + + def setUp(self): + super().setUp(archive_name='', + start_path=os.path.dirname(__file__), + uncompress_archive=False) + self.loader = DebianLoaderTest() + SQLBase.metadata.create_all(self.loader.db_engine) + self.storage = self.loader.storage + make_uri = ('file://' + RESOURCES_PATH + '/').__add__ + self.debian_src_name = 'hello_2.10-1+deb9u1.debian.tar.xz' + self.orig_src_name = 'hello_2.10.orig.tar.gz' + self.dsc_name = 'hello_2.10-1+deb9u1.dsc' + self.files = { + self.dsc_name: { + 'name': self.dsc_name, + 'uri': make_uri(self.dsc_name), + 'size': 1866, + }, + self.debian_src_name: { + 'name': self.debian_src_name, + 'uri': make_uri(self.debian_src_name), + 'size': 6156, + }, + self.orig_src_name: { + 'name': self.orig_src_name, + 'uri': make_uri(self.orig_src_name), + 'size': 725946, + }, + } + self._fill_db() + + def tearDown(self): + SQLBase.metadata.drop_all(self.loader.db_engine) + self.loader.db_session.close() + self.loader.db_engine.dispose() # close the connection pool + super().tearDown() + + def _fill_db(self): + from swh.storage.schemata.distribution import \ + Area, Distribution, Package + dist = Distribution(name='Debian', type='deb', mirror_uri='devnull://') + area = Area(distribution=dist, name='main') + pkg = Package(area=area, name='hello', version='2.10-1+deb9u1', + directory='dir', files=self.files) + self.loader.db_session.add_all([area, pkg]) + self.loader.db_session.commit() + self.pkg_id = pkg.id + + def _load(self): + self.loader.load( + origin={'url': self.repo_url, 'type': 'deb'}, + date='2018-12-14 16:45:00+00', + packages={ + 'stretch/main/2.10-1+deb9u1': { + 'id': self.pkg_id, + 'name': 'hello', + 'version': '2.10-1+deb9u1', + 'revision_id': None, + 'files': self.files, + } + } + ) + + def test_load(self): + with requests_mock.Mocker() as m: + for file_ in self.files.values(): + path = os.path.join(RESOURCES_PATH, file_['name']) + with open(path, 'rb') as fd: + m.get(file_['uri'], content=fd.read()) + self._load() + + self.assertCountSnapshots(1) + self.assertCountReleases(0) # FIXME: Why not 1? + self.assertCountRevisions(1) + self.assertCountDirectories(14) + self.assertCountContents(315) + + # Check the root dir was loaded, and contains 'src/' + root_hash = 'c906789049d2327a69b81cca6a1c1737321c836f' + ls_root = list(self.storage.directory_ls( + hash_to_bytes(root_hash))) + src_dirs = [x for x in ls_root if x['name'] == b'src'] + self.assertEqual(len(src_dirs), 1, src_dirs) + + # Check 'src/hello.c' exists + src_dir_hash = src_dirs[0]['target'] + ls_src = list(self.storage.directory_ls(src_dir_hash)) + hello_c = [x for x in ls_src if x['name'] == b'hello.c'] + self.assertEqual(len(hello_c), 1, hello_c) + + # Check 'src.hello.c' was loaded and has the right hash + hello_c_hash = 'b60a061ac9dd25b29d57b756b5959aadc1fe6386' + self.assertEqual(hello_c[0]['sha1'], hash_to_bytes(hello_c_hash)) + + missing = list(self.storage.content_missing( + [{'sha1': hash_to_bytes(hello_c_hash)}])) + self.assertEqual(missing, []) diff --git a/version.txt b/version.txt index dd52828..1805a40 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -v0.0.11-0-g1744ae5 \ No newline at end of file +v0.0.13-0-gf7c2973 \ No newline at end of file