diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c23d90d --- /dev/null +++ b/.gitignore @@ -0,0 +1,15 @@ +*.pyc +*.sw? +*~ +/.coverage +/.coverage.* +.eggs/ +__pycache__ +*.egg-info/ +version.txt +logs/ +archives/ +build/ +dist/ +.tox/ +.mypy_cache/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..69b3349 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,40 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.4.0 + hooks: + - id: trailing-whitespace + - id: flake8 + - id: check-json + - id: check-yaml + +- 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/python/black + rev: 19.10b0 + hooks: + - id: black + +# unfortunately, we are far from being able to enable this... +# - repo: https://github.com/PyCQA/pydocstyle.git +# rev: 4.0.0 +# hooks: +# - id: pydocstyle +# name: pydocstyle +# description: pydocstyle is a static analysis tool for checking compliance with Python docstring conventions. +# entry: pydocstyle --convention=google +# language: python +# types: [python] + diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..2d0a34a --- /dev/null +++ b/AUTHORS @@ -0,0 +1,3 @@ +Copyright (C) 2015 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..7c3f962 --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1 @@ +Ishan Bhanuka 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/MANIFEST.in b/MANIFEST.in index fcd5ab3..4b92671 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,6 @@ include Makefile include requirements*.txt include version.txt +include conftest.py recursive-include swh/loader/svn/tests/data * recursive-include swh py.typed diff --git a/PKG-INFO b/PKG-INFO index 85fc818..78a4633 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,93 +1,93 @@ Metadata-Version: 2.1 Name: swh.loader.svn -Version: 0.3.1 +Version: 0.3.2 Summary: Software Heritage Loader SVN Home-page: https://forge.softwareheritage.org/diffusion/DLDSVN 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-loader-svn Project-URL: Documentation, https://docs.softwareheritage.org/devel/swh-loader-svn/ Description: swh-loader-svn ============== Documents are in the ./docs folder: - Specification: ./docs/swh-loader-svn.txt # Configuration file ## Location Either: - /etc/softwareheritage/ - ~/.config/swh/ - ~/.swh/ Note: Will call that location $SWH_CONFIG_PATH ## Configuration sample $SWH_CONFIG_PATH/loader/svn.yml: ``` storage: cls: remote args: url: http://localhost:5002/ ``` ## Local run ### local svn repository ``` $ python3 repo = 'pyang-repo-r343-eol-native-mixed-lf-crlf' #repo = 'zipeg-gae' origin_url = 'http://%s.googlecode.com' % repo local_repo_path = '/home/storage/svn/repo' svn_url = 'file://%s/%s' % (local_repo_path, repo) import logging logging.basicConfig(level=logging.DEBUG) from swh.loader.svn.tasks import LoadSvnRepository t = LoadSvnRepository() t.run(svn_url=svn_url, origin_url=origin_url, visit_date='2016-05-03T15:16:32+00:00', start_from_scratch=True) ``` ### Mount and load an archive repository dump ``` $ python3 repo = '0-512-md' archive_name = '%s-repo.svndump.gz' % repo archive_path = '/home/storage/svn/dumps/%s' % archive_name origin_url = 'http://%s.googlecode.com' % repo svn_url = 'file://%s' % repo import logging logging.basicConfig(level=logging.DEBUG) from swh.loader.svn.tasks import MountAndLoadSvnRepository t = MountAndLoadSvnRepository() t.run(archive_path=archive_path, origin_url=origin_url, visit_date='2016-05-03T15:16:32+00:00', start_from_scratch=True) ``` 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 Requires-Python: >=3.7 Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/bin/init-svn-repository.sh b/bin/init-svn-repository.sh new file mode 100755 index 0000000..3ade7c8 --- /dev/null +++ b/bin/init-svn-repository.sh @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +# script to ease the initialization of an svn repository + +SVN_DIR=${1-"/home/storage/svn/example"} +REMOTE_SVN=${2-"http://example.googlecode.com/svn/"} + +[ -d $SVN_DIR ] && echo "$SVN_DIR already present. Do 'rm -rf $SVN_DIR' and relaunch this script if you really want to start from scratch." && exit 1 + +set -x + +svnadmin create $SVN_DIR + +cd $SVN_DIR + +echo -e '#!/bin/sh\n' > hooks/pre-revprop-change +chmod +x hooks/pre-revprop-change + +# Fill in some repository +svnsync init file://$SVN_DIR $REMOTE_SVN +svnsync sync file://$SVN_DIR diff --git a/bin/swh-svn b/bin/swh-svn new file mode 100755 index 0000000..c3f1c71 --- /dev/null +++ b/bin/swh-svn @@ -0,0 +1,26 @@ +#!/usr/bin/env python3 + +# Use sample: +# swh-svn --remote-url file:///home/storage/svn/repos/asf \ +# --revision 30000 --path swh-asf-30000 + +import click + +from subvertpy.ra import Auth, get_username_provider +from subvertpy import client + + +@click.command() +@click.option("--remote-url", help="Remote url to export.") +@click.option("--path", default=".", help="path to checkout locally.") +@click.option("--revision", type=click.INT, help="") +def main(remote_url, path, revision): + _auth = Auth([get_username_provider()]) + _client = client.Client(auth=_auth) + + print("svn export --ignore-keywords %s@%s %s" % (remote_url, revision, path)) + _client.export(remote_url, to=path, rev=revision, ignore_keywords=True) + + +if __name__ == "__main__": + main() diff --git a/conftest.py b/conftest.py new file mode 100644 index 0000000..b486e88 --- /dev/null +++ b/conftest.py @@ -0,0 +1,19 @@ +# Copyright (C) 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 + +import pytest + +pytest_plugins = [ + "swh.scheduler.pytest_plugin", + "swh.storage.pytest_plugin", + "swh.loader.pytest_plugin", +] + + +@pytest.fixture(scope="session") +def swh_scheduler_celery_includes(swh_scheduler_celery_includes): + return swh_scheduler_celery_includes + [ + "swh.loader.svn.tasks", + ] 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..63ca741 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,15 @@ +.. _swh-loader-svn: + +Software Heritage - Subversion loader +===================================== + +Loader for `Subversion `_ repositories. + + +Reference Documentation +----------------------- + +.. toctree:: + :maxdepth: 2 + + /apidoc/swh.loader.svn diff --git a/docs/swh-loader-svn.txt b/docs/swh-loader-svn.txt new file mode 100644 index 0000000..2f56aaa --- /dev/null +++ b/docs/swh-loader-svn.txt @@ -0,0 +1,195 @@ +swh-loader-svn +============== + +The goal is to load a svn repository's lifetime logs to swh-storage. + +This must be able to deal with: +- unknown svn repository (resulting in a new origin) +- known svn repository (starting up from the last known svn revision + and update from that moment on) + +For a full detailed comparison between version's speed, please refer +to https://forge.softwareheritage.org/diffusion/DLDSVN/browse/master/docs/comparison-git-svn-swh-svn.org. + + +# v1 + +## Description + +This is a first basic implementation, a proof-of-concept of sort. +Based on checkout-ing on disk the svn repository at each revision and +walking the tree at svn revision to compute the swh hashes and store +them in swh-storage. + +Conclusion: It is possible but it is slow. + +We use git-svn to check if the hash computations were a match, and +they were not. The swh hashes computation are corrects though. + +It's just not the same assertions as git-svn so the hashes mismatch. + +git-svn: +- does not checkout empty folders +- adds metadata at the end of the svn commit message (by default, this + can be avoided but then no update, in the swh sense, is possible + afterwards) +- integrates the svn repository's uuid in the git revision for the + commit author (author@) + +swh-loader-svn: +- checkouts empty folder (which are then used in swh hashes) +- adds metadata the git way (leveraging git's extra-header slot), so + that we can deal with svn repository updates + +## Pseudo + +``` +Checkout/Update/Export on disk the first known revision or 1 if unknown repository +When revision is not 1 + Check the history is altered (revision hashes won't match) + If it is altered, log an error message and stop + Otherwise continue + +Iterate over logs from revision 1 to revision head_revision + The revision is now rev + checkout/update/export the revision at rev + walk the tree directory for that revision and compute hashes + compute the revision hash + send the blobs for storage in swh + send the directories for storage in swh + send the revision for storage in swh +done + +Send the occurrence pointing to the last revision seen +``` + +## Notes + +SVN checkout/update instructions are faster than export since they +leverage svn diffs. But: +- they do keyword expansion (so bad for diffs with external tools so + bad for swh) +- we need to ignore .svn folder since it's present (this needed some + adaptation in code to ignore folder based on pattern so slow as + well) + +SVN export instruction is slower than the 2 previous ones since they +don't use diffs. But: +- there is one option to ignore keyword expansion (good) +- no folder are to be omitted during hash computation from disk (good) + +All in all, there is a trade-off here to choose from. + +Still, everything was tested (with much code adapted in the lower +level api) and both are slow. + +# v2 + +## Description + +The v2 is more about: +- adding options to match the git-svn's hash computations +- trying to improve the performance + +So, options are added: +- remove empty folder when encountered (to ignore during hash + computations) +- add an extra commit line to the svn commit message +- (de)activate the loader svn's update routine +- (de)activate the sending of + contents/directories/revisions/occurrences/releases to swh-storage +- (de)activate the extra-header metadata in revision hash (thus + deactivating the svn update options altogether) + +As this is thought as genuine implementation, we adapted the revision +message to also use the repository's uuid in the author's email. + +Also, optimization are done as well: +- instead of walking the disk from the top leve at each revision (slow + for huge repository like svn.apache.org), compute from the svn log's + changed paths between the previous revision and the current one, the + lowest common path. Then, walk only that path to compute the updated + hashes. Then update from that path to the top level the in-memory + hashes (less i/o, less RAM are used). + +- in the loader-core, lifting the existing swh-storage api to filter + only the missing entities on the client side (there are already + filters on the server side but filtering client-side uses less RAM. + Especially for blobs, since we extract the data from disk and store + it in RAM, this is now done only for unknown blobs and still before + updating the disk with a new revision content) + +- in the loader-core, cache are added as well + +Now the computations, with the right options, are a match with git-svn. +Still, the performance against git-svn are bad. + +Taking a closer look at git-svn, they used a remote-access approach, +that is discussing directly with the svn server and computing at the +same time the hashes. +That is the base for the v3 implementation. + +## Pseudo + +Relatively to the v1, the logic does not change, only the inner +implementation. + +# v3 + +## Description + +This one is about performance only. + +Leveraging another low-level library (subvertpy) to permit the use of +the same git-svn approach, the remote-access. + +The idea is to replay the logs and diffs on disk and compute hashes +closely in time (not as close as possible though, cf. ## Note below). + +## Pseudo + +``` +Do we know the repository (with swh-svn-update option on)? + Yes, extract the last swh known revision from swh-storage + set start-rev to last-swh-known-revision + Export on disk the svn at start-rev + Compute revision hashes (from top level tree's hashes + commit log for that revision) + Does the revision hash match the one in swh-storage? (<=> Is the history altered?) + No + log an error message and stop + Yes + keep the current in-memory hashes (for the following updates steps if any) + No + set start-rev to 1 + +Set head-revision to latest svn repository's head revision +When start-rev is the same as head revision, we are done. +Otherwise continue + +Iterate over the stream of svn-logs from start-rev to head-rev + The current revision is rev + replay the diffs from previous rev (rev - 1) to rev and compute hashes along + compute the revision hash + send the blobs for storage in swh + send the directories for storage in swh + send the revision for storage in swh +done + +Send the occurrence pointing to the last revision seen +``` + +## Note + +There could be margin for improvement in the actual implementation +here. + +We apply the diff on files first and then open the file to compute its +hashes afterwards. + +If we'd apply the diff and compute the hashes directly, we'd gain one +round-trip. Depending on the ratio files/directory, this could be +significant. + +This approach has also the following benefits: +- no keyword expansion +- no need to ignore .svn folder (since it does not exist) diff --git a/install/install-pysvn.sh b/install/install-pysvn.sh new file mode 100755 index 0000000..a8ca607 --- /dev/null +++ b/install/install-pysvn.sh @@ -0,0 +1,24 @@ +#!/usr/bin/env bash + +# Reference steps to install pysvn from tarballs served at +# http://pysvn.barrys-emacs.org/ + +# system pre-requisites +sudo apt-get install libaprutil1-dev libapr1-dev libsvn1 + +# on to the installation +mkdir /tmp/pysvn-build && cd /tmp/pysvn-build + +wget http://pysvn.barrys-emacs.org/source_kits/pysvn-1.8.0.tar.gz + +tar xvf pysvn-1.8.0.tar.gz + +cd pysvn-1.8.0/Source/ + +python3 setup.py configure --svn-lib-dir=/usr/lib/x86_64-linux-gnu --apr-inc-dir=/usr/include/apr-1.0 --apu-inc-dir=/usr/include/apr-1.0 --apr-lib-dir=/usr/lib/x86_64-linux-gnu + +make + +mkdir -p ~/.local/lib/python3.5/ + +cp -rv pysvn/ ~/.local/lib/python3.5/ diff --git a/install/install-subvertpy.sh b/install/install-subvertpy.sh new file mode 100755 index 0000000..336b4c3 --- /dev/null +++ b/install/install-subvertpy.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +sudo apt-get install libaprutil1-dev libapr1-dev libsvn-dev +sudo pip3 install subvertpy diff --git a/mypy.ini b/mypy.ini new file mode 100644 index 0000000..266db73 --- /dev/null +++ b/mypy.ini @@ -0,0 +1,18 @@ +[mypy] +namespace_packages = True +warn_unused_ignores = True + + +# 3rd party libraries without stubs (yet) + +[mypy-celery.*] +ignore_missing_imports = True + +[mypy-subvertpy.*] +ignore_missing_imports = True + +[mypy-pytest.*] +ignore_missing_imports = True + +[mypy-swh.loader.*] +ignore_missing_imports = True diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..81146c2 --- /dev/null +++ b/pytest.ini @@ -0,0 +1,7 @@ +[pytest] +# Drop this when these fixtures aren't imported automatically +addopts = -p no:pytest_swh_scheduler -p no:pytest_swh_storage + +norecursedirs = docs +markers = + fs: execute tests that write to the filesystem diff --git a/requirements.txt b/requirements.txt index 474c1d7..ea3e3cf 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,7 @@ # Add here external Python modules dependencies, one per line. Module names # should match https://pypi.python.org/pypi names. For the full spec or # dependency lines, see https://pip.readthedocs.org/en/1.1/requirements.html -vcversioner click retrying python-dateutil subvertpy >= 0.9.4 diff --git a/resources/svn.ini b/resources/svn.ini new file mode 100644 index 0000000..8da9f00 --- /dev/null +++ b/resources/svn.ini @@ -0,0 +1,24 @@ +[main] +storage_class = remote_storage +storage_args = http://localhost:5002/ +send_contents = True +send_directories = True +send_revisions = True +send_releases = True +send_occurrences = True +# nb of max contents to send for storage (if size threshold not reached before) +content_packet_size = 10000 +# 100 Mib of content data (size threshold of data before sending for storage) +content_packet_block_size_bytes = 104857600 +# limit for swh content storage for one blob (beyond that limit, the +# content's data is not sent for storage) +content_packet_size_bytes = 1073741824 +# packet of directories to send for storage +directory_packet_size = 25000 +# packet of revisions to send for storage +revision_packet_size = 10000 +# packet of releases to send for storage +release_packet_size = 100000 +# packet of occurrences to send for storage +occurrence_packet_size = 100000 + diff --git a/setup.py b/setup.py index e537fd2..acbb7e4 100755 --- a/setup.py +++ b/setup.py @@ -1,71 +1,71 @@ #!/usr/bin/env python3 -# Copyright (C) 2015-2018 The Software Heritage developers +# Copyright (C) 2015-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 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" 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("#"): continue requirements.append(line) return requirements setup( name="swh.loader.svn", description="Software Heritage Loader SVN", long_description=long_description, 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/DLDSVN", packages=find_packages(), scripts=[], install_requires=parse_requirements() + parse_requirements("swh"), - setup_requires=["vcversioner"], + setup_requires=["setuptools-scm"], + use_scm_version=True, extras_require={"testing": parse_requirements("test")}, - vcversioner={}, include_package_data=True, entry_points=""" [swh.workers] loader.svn=swh.loader.svn:register """, 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-svn", "Documentation": "https://docs.softwareheritage.org/devel/swh-loader-svn/", }, ) diff --git a/svn-lib-client-analysis.org b/svn-lib-client-analysis.org new file mode 100644 index 0000000..aaa7494 --- /dev/null +++ b/svn-lib-client-analysis.org @@ -0,0 +1,25 @@ +#+title: svn lib client analysis + +|-----------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------+-------------+------------------------------------------| +| Client | Cons | Pros | License | work as advertize | +|-----------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------+-------------+------------------------------------------| +| http://subversion.apache.org/ | broken api link to doc: http://subversion.apache.org/docsapi/latest/ | python-subversion debian package | [[http://www.apache.org/licenses/LICENSE-2.0][Apache v2.0]] | X | +| | python 2 only | official bindings | | | +| | | doc: http://svnbook.red-bean.com/en/1.7/svn-book.html#svn.developer.usingapi | | | +|-----------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------+-------------+------------------------------------------| +| http://pysvn.tigris.org/ | no pip package | tigris maintainer (seems legit regarding xp tortoise-svn...) | [[http://www.apache.org/licenses/LICENSE-1.1][Apache v1.1]] | No, not found a way to have with python3 | +| | | python 2/3 compatible | | | +| | | bindings | | | +| | | debian python-svn package | | | +| | | doc: http://pysvn.tigris.org/docs/pysvn.html | | | +| | | fully supports svn 1.9.1 and earlier | | | +|-----------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------+-------------+------------------------------------------| +| https://github.com/dsoprea/PySvn | wrapper around svn command (no c binding) | python2/3 compatible | | Yes | +| https://pypi.python.org/pypi/svn/0.3.36 | incomplete (but maybe sufficient) | pip3 package | [[https://raw.githubusercontent.com/dsoprea/PySvn/master/LICENSE][GPL2]] | | +|-----------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------+-------------+------------------------------------------| +| https://github.com/jelmer/subvertpy | python2 only | pip + debian package (python2) | [[https://raw.githubusercontent.com/jelmer/subvertpy/master/COPYING][GPL2.1]] | X | +| | javadoc like doc | same maintainer as https://github.com/jelmer/dulwich | | | +| | | docs: https://www.samba.org/~jelmer/subvertpy/apidocs/ | | | +| | | full support svn api | | | +|-----------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------+-------------+------------------------------------------| +Note: All are free software, so it's not entertained as pros (as it is implicit). diff --git a/swh.loader.svn.egg-info/PKG-INFO b/swh.loader.svn.egg-info/PKG-INFO index 85fc818..78a4633 100644 --- a/swh.loader.svn.egg-info/PKG-INFO +++ b/swh.loader.svn.egg-info/PKG-INFO @@ -1,93 +1,93 @@ Metadata-Version: 2.1 Name: swh.loader.svn -Version: 0.3.1 +Version: 0.3.2 Summary: Software Heritage Loader SVN Home-page: https://forge.softwareheritage.org/diffusion/DLDSVN 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-loader-svn Project-URL: Documentation, https://docs.softwareheritage.org/devel/swh-loader-svn/ Description: swh-loader-svn ============== Documents are in the ./docs folder: - Specification: ./docs/swh-loader-svn.txt # Configuration file ## Location Either: - /etc/softwareheritage/ - ~/.config/swh/ - ~/.swh/ Note: Will call that location $SWH_CONFIG_PATH ## Configuration sample $SWH_CONFIG_PATH/loader/svn.yml: ``` storage: cls: remote args: url: http://localhost:5002/ ``` ## Local run ### local svn repository ``` $ python3 repo = 'pyang-repo-r343-eol-native-mixed-lf-crlf' #repo = 'zipeg-gae' origin_url = 'http://%s.googlecode.com' % repo local_repo_path = '/home/storage/svn/repo' svn_url = 'file://%s/%s' % (local_repo_path, repo) import logging logging.basicConfig(level=logging.DEBUG) from swh.loader.svn.tasks import LoadSvnRepository t = LoadSvnRepository() t.run(svn_url=svn_url, origin_url=origin_url, visit_date='2016-05-03T15:16:32+00:00', start_from_scratch=True) ``` ### Mount and load an archive repository dump ``` $ python3 repo = '0-512-md' archive_name = '%s-repo.svndump.gz' % repo archive_path = '/home/storage/svn/dumps/%s' % archive_name origin_url = 'http://%s.googlecode.com' % repo svn_url = 'file://%s' % repo import logging logging.basicConfig(level=logging.DEBUG) from swh.loader.svn.tasks import MountAndLoadSvnRepository t = MountAndLoadSvnRepository() t.run(archive_path=archive_path, origin_url=origin_url, visit_date='2016-05-03T15:16:32+00:00', start_from_scratch=True) ``` 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 Requires-Python: >=3.7 Description-Content-Type: text/markdown Provides-Extra: testing diff --git a/swh.loader.svn.egg-info/SOURCES.txt b/swh.loader.svn.egg-info/SOURCES.txt index fe56d79..b0fa6b7 100644 --- a/swh.loader.svn.egg-info/SOURCES.txt +++ b/swh.loader.svn.egg-info/SOURCES.txt @@ -1,45 +1,69 @@ +.gitignore +.pre-commit-config.yaml +AUTHORS +CODE_OF_CONDUCT.md +CONTRIBUTORS +LICENSE MANIFEST.in Makefile README.md +conftest.py +mypy.ini pyproject.toml +pytest.ini requirements-swh.txt requirements-test.txt requirements.txt setup.cfg setup.py +svn-lib-client-analysis.org +tox.ini version.txt +bin/init-svn-repository.sh +bin/swh-svn +docs/.gitignore +docs/Makefile +docs/conf.py +docs/index.rst +docs/swh-loader-svn.txt +docs/_static/.placeholder +docs/_templates/.placeholder +install/install-pysvn.sh +install/install-subvertpy.sh +resources/svn.ini swh/__init__.py swh.loader.svn.egg-info/PKG-INFO swh.loader.svn.egg-info/SOURCES.txt swh.loader.svn.egg-info/dependency_links.txt swh.loader.svn.egg-info/entry_points.txt swh.loader.svn.egg-info/requires.txt swh.loader.svn.egg-info/top_level.txt swh/loader/__init__.py swh/loader/svn/__init__.py swh/loader/svn/converters.py swh/loader/svn/exception.py swh/loader/svn/loader.py swh/loader/svn/py.typed swh/loader/svn/ra.py swh/loader/svn/svn.py swh/loader/svn/tasks.py swh/loader/svn/utils.py swh/loader/svn/tests/__init__.py swh/loader/svn/tests/conftest.py swh/loader/svn/tests/test_converters.py +swh/loader/svn/tests/test_loader.org swh/loader/svn/tests/test_loader.py swh/loader/svn/tests/test_task.py swh/loader/svn/tests/test_utils.py swh/loader/svn/tests/data/httthttt.tgz swh/loader/svn/tests/data/mediawiki-repo-r407-eol-native-crlf.tgz swh/loader/svn/tests/data/pkg-doc-linux-r10.tgz swh/loader/svn/tests/data/pkg-doc-linux-r11.tgz swh/loader/svn/tests/data/pkg-doc-linux-r12.tgz swh/loader/svn/tests/data/pkg-gourmet-tampered-rev6-log.tgz swh/loader/svn/tests/data/pkg-gourmet-with-edge-case-links-and-files.tgz swh/loader/svn/tests/data/pkg-gourmet-with-external-id.tgz swh/loader/svn/tests/data/pkg-gourmet-with-updates.tgz swh/loader/svn/tests/data/pkg-gourmet-with-wrong-link-cases.tgz swh/loader/svn/tests/data/pkg-gourmet.tgz swh/loader/svn/tests/data/pyang-repo-r343-eol-native-mixed-lf-crlf.tgz \ No newline at end of file diff --git a/swh.loader.svn.egg-info/requires.txt b/swh.loader.svn.egg-info/requires.txt index c3309ed..4a0d4e9 100644 --- a/swh.loader.svn.egg-info/requires.txt +++ b/swh.loader.svn.egg-info/requires.txt @@ -1,15 +1,14 @@ -vcversioner click retrying python-dateutil subvertpy>=0.9.4 swh.storage>=0.11.3 swh.model>=0.4.0 swh.scheduler>=0.0.39 swh.loader.core>=0.5.9 [testing] pytest pytest-mock pytest-postgresql swh.core[http]>=0.0.61 diff --git a/swh/loader/svn/tests/test_loader.org b/swh/loader/svn/tests/test_loader.org new file mode 100644 index 0000000..18f764a --- /dev/null +++ b/swh/loader/svn/tests/test_loader.org @@ -0,0 +1,317 @@ +#+title: Prepare test_converters.py it tests +#+author: ardumont + +* Requisite: + +#+BEGIN_SRC sh +sudo apt install subversion git-svn +#+END_SRC + +* Create mirror repository + +Then: +#+BEGIN_SRC sh +./init-svn-repository.sh /home/storage/svn/repos/pkg-gourmet svn://svn.debian.org/svn/pkg-gourmet/ +#+END_SRC +Note: +Saved as ../../../../bin/init-svn-repository.sh + +And now we have a mirror svn repository at file:///home/storage/svn/repos/pkg-gourmet + +* git-svn policy + +`git svn clone` the repository and parse the git log entries for the needed data. + +#+BEGIN_SRC sh +git svn clone file:///home/storage/svn/repos/pkg-gourmet -q --no-metadata +cd pkg-gourmet +# commit +git log --format=raw --reverse | grep '^commit ' | awk '{print $2}' +# tree +git log --format=raw --reverse | grep '^tree ' | awk '{print $2}' +#+END_SRC + +Those are the data to check when done parsing the repository: + +|------------------------------------------+------------------------------------------| +| revision | tree | +|------------------------------------------+------------------------------------------| +| 22c0fa5195a53f2e733ec75a9b6e9d1624a8b771 | 4b825dc642cb6eb9a060e54bf8d69288fbee4904 | +| 17a631d474f49bbebfdf3d885dcde470d7faafd7 | 4b825dc642cb6eb9a060e54bf8d69288fbee4904 | +| c8a9172b2a615d461154f61158180de53edc6070 | 4b825dc642cb6eb9a060e54bf8d69288fbee4904 | +| 7c8f83394b6e8966eb46f0d3416c717612198a4b | 4b825dc642cb6eb9a060e54bf8d69288fbee4904 | +| 852547b3b2bb76c8582cee963e8aa180d552a15c | ab047e38d1532f61ff5c3621202afc3e763e9945 | +| bad4a83737f337d47e0ba681478214b07a707218 | 9bcfc25001b71c333b4b5a89224217de81c56e2e | +|------------------------------------------+------------------------------------------| + +* swh policy + +** New repository + +For this one this was more tedious. +#+BEGIN_SRC sh +$ svn export --ignore-keywords file:///home/storage/svn/repos/pkg-gourmet@1 +#+END_SRC +The export does not expand the keywords and does not include the .svn folder. + +Then: +#+BEGIN_SRC sh +$ cd pkg-gourmet +$ swh-hashtree --path . +669a71cce6c424a81ba42b7dc5d560d32252f0ca +#+END_SRC + +Note: ../../../../bin/hashtree + +Then for the next revision: +#+BEGIN_SRC sh +cd .. ; rm -rf pkg-gourmet; svn export --ignore-keywords file:///home/storage/svn/repos/pkg-gourmet@2 +A pkg-gourmet +A pkg-gourmet/gourmet +A pkg-gourmet/gourmet/trunk +Exported revision 2. +$ cd pkg-gourmet && swh-hashtree --path . +008ac97a1118560797c50e3392fa1443acdaa349 +#+END_SRC +etc... + +|--------------+------------------------------------------+------------------------------------------| +| svn revision | swh revision | tree | +|--------------+------------------------------------------+------------------------------------------| +| 1 | 0d7dd5f751cef8fe17e8024f7d6b0e3aac2cfd71 | 669a71cce6c424a81ba42b7dc5d560d32252f0ca | +| 2 | 95edacc8848369d6fb1608e887d6d2474fd5224f | 008ac97a1118560797c50e3392fa1443acdaa349 | +| 3 | fef26ea45a520071711ba2b9d16a2985ee837021 | 3780effbe846a26751a95a8c95c511fb72be15b4 | +| 4 | 3f51abf3b3d466571be0855dfa67e094f9ceff1b | ffcca9b09c5827a6b8137322d4339c8055c3ee1e | +| 5 | a3a577948fdbda9d1061913b77a1588695eadb41 | 7dc52cc04c3b8bd7c085900d60c159f7b846f866 | +| 6 | 4876cb10aec6f708f7466dddf547567b65f6c39c | 0deab3023ac59398ae467fc4bff5583008af1ee2 | +|--------------+------------------------------------------+------------------------------------------| + +For the revision, cheating a little. +That is adapting swh.model.identifiers.revision_identifiers to print the commit's manifest: + +#+BEGIN_SRC sh +b'tree 669a71cce6c424a81ba42b7dc5d560d32252f0ca\nauthor seanius 1138341038.645397 +0000\ncommitter seanius 1138341038.645397 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 1\n\nmaking dir structure...' +[2016-06-23 12:35:39,291: DEBUG/Worker-1] rev: 1, swhrev: 0d7dd5f751cef8fe17e8024f7d6b0e3aac2cfd71, dir: 669a71cce6c424a81ba42b7dc5d560d32252f0ca +b'tree 008ac97a1118560797c50e3392fa1443acdaa349\nparent 0d7dd5f751cef8fe17e8024f7d6b0e3aac2cfd71\nauthor seanius 1138341044.821526 +0000\ncommitter seanius 1138341044.821526 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 2\n\nmaking dir structure...' +[2016-06-23 12:35:39,302: DEBUG/Worker-1] rev: 2, swhrev: 95edacc8848369d6fb1608e887d6d2474fd5224f, dir: 008ac97a1118560797c50e3392fa1443acdaa349 +b'tree 3780effbe846a26751a95a8c95c511fb72be15b4\nparent 95edacc8848369d6fb1608e887d6d2474fd5224f\nauthor seanius 1138341057.282488 +0000\ncommitter seanius 1138341057.282488 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 3\n\nmaking dir structure...' +[2016-06-23 12:35:39,313: DEBUG/Worker-1] rev: 3, swhrev: fef26ea45a520071711ba2b9d16a2985ee837021, dir: 3780effbe846a26751a95a8c95c511fb72be15b4 +b'tree ffcca9b09c5827a6b8137322d4339c8055c3ee1e\nparent fef26ea45a520071711ba2b9d16a2985ee837021\nauthor seanius 1138341064.191867 +0000\ncommitter seanius 1138341064.191867 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 4\n\nmaking dir structure...' +[2016-06-23 12:35:39,322: DEBUG/Worker-1] rev: 4, swhrev: 3f51abf3b3d466571be0855dfa67e094f9ceff1b, dir: ffcca9b09c5827a6b8137322d4339c8055c3ee1e +b'tree 7dc52cc04c3b8bd7c085900d60c159f7b846f866\nparent 3f51abf3b3d466571be0855dfa67e094f9ceff1b\nauthor seanius 1138342632.066765 +0000\ncommitter seanius 1138342632.066765 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 5\n\ninitial import' +[2016-06-23 12:35:39,339: DEBUG/Worker-1] rev: 5, swhrev: a3a577948fdbda9d1061913b77a1588695eadb41, dir: 7dc52cc04c3b8bd7c085900d60c159f7b846f866 +b'tree 0deab3023ac59398ae467fc4bff5583008af1ee2\nparent a3a577948fdbda9d1061913b77a1588695eadb41\nauthor seanius 1138343905.448277 +0000\ncommitter seanius 1138343905.448277 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 6\n\nfix breakage in rules' +[2016-06-23 12:35:39,348: DEBUG/Worker-1] rev: 6, swhrev: 4876cb10aec6f708f7466dddf547567b65f6c39c, dir: 0deab3023ac59398ae467fc4bff5583008af1ee2 +[2016-06-23 12:35:39,355: INFO/Worker-1] Processed 6 revisions: [0d7dd5f751cef8fe17e8024f7d6b0e3aac2cfd71, ...] +#+END_SRC + +Then checking the manifest's hash is ok: +#+BEGIN_SRC sh +$ echo -en 'tree 669a71cce6c424a81ba42b7dc5d560d32252f0ca\nauthor seanius 1138341038.645397 +0000\ncommitter seanius 1138341038.645397 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 1\n\nmaking dir structure...' | git hash-object -t commit --stdin +0d7dd5f751cef8fe17e8024f7d6b0e3aac2cfd71 +#+END_SRC + +And all is ok. + +** Update existing repository + +Checkout on disk the repository and do some modifications on it: +#+BEGIN_SRC sh +$ svn co file:///home/storage/svn/repos/pkg-gourmet/ +A pkg-gourmet/gourmet +A pkg-gourmet/gourmet/branches +A pkg-gourmet/gourmet/tags +A pkg-gourmet/gourmet/trunk +A pkg-gourmet/gourmet/trunk/debian +A pkg-gourmet/gourmet/trunk/debian/patches +A pkg-gourmet/gourmet/trunk/debian/patches/00list +A pkg-gourmet/gourmet/trunk/debian/patches/01_printer_warning.dpatch +A pkg-gourmet/gourmet/trunk/debian/README.Maintainer +A pkg-gourmet/gourmet/trunk/debian/TODO +A pkg-gourmet/gourmet/trunk/debian/changelog +A pkg-gourmet/gourmet/trunk/debian/compat +A pkg-gourmet/gourmet/trunk/debian/control +A pkg-gourmet/gourmet/trunk/debian/copyright +A pkg-gourmet/gourmet/trunk/debian/dirs +A pkg-gourmet/gourmet/trunk/debian/docs +A pkg-gourmet/gourmet/trunk/debian/gourmet.1 +A pkg-gourmet/gourmet/trunk/debian/menu +A pkg-gourmet/gourmet/trunk/debian/postinst +A pkg-gourmet/gourmet/trunk/debian/postrm +A pkg-gourmet/gourmet/trunk/debian/prerm +A pkg-gourmet/gourmet/trunk/debian/recbox.xpm +A pkg-gourmet/gourmet/trunk/debian/rules +A pkg-gourmet/gourmet/trunk/debian/source.lintian-overrides +Checked out revision 6. +$ cd pkg-gourmet +$ mkdir foo/bar/ -p +$ em foo/bar/new-file +% svn add foo +A foo +A foo/bar +A foo/bar/README +$ svn commit -m 'Add a new README' +Adding foo +Adding foo/bar +Adding foo/bar/README +Transmitting file data .done +Committing transaction... +Committed revision 7. +$ ln -s foo/bar/README README +$ svn add README +A README +$ svn commit -m 'Add link to README' +Adding README +Transmitting file data .done +Committing transaction... +Committed revision 8. +$ svn update +Updating '.': +At revision 8. +#+END_SRC + +Checking the log, we see those new svn commits: +#+BEGIN_SRC sh +$ svn log +------------------------------------------------------------------------ +r11 | tony | 2016-07-11 10:38:43 +0200 (Mon, 11 Jul 2016) | 1 line + +Delete broken link +------------------------------------------------------------------------ +r10 | tony | 2016-07-11 10:09:13 +0200 (Mon, 11 Jul 2016) | 1 line + +Add bin/hello executable +------------------------------------------------------------------------ +r9 | tony | 2016-07-07 11:13:52 +0200 (Thu, 07 Jul 2016) | 1 line + +------------------------------------------------------------------------ +r8 | tony | 2016-06-24 11:08:42 +0200 (Fri, 24 Jun 2016) | 1 line + +Add link to README +------------------------------------------------------------------------ +r7 | tony | 2016-06-24 11:07:04 +0200 (Fri, 24 Jun 2016) | 1 line + +Add a new README +------------------------------------------------------------------------ +r6 | seanius | 2006-01-27 07:38:25 +0100 (Fri, 27 Jan 2006) | 1 line + +fix breakage in rules +#+END_SRC + +Loading the svn repository, we see 2 new swh revisions: +#+BEGIN_SRC sh +b'tree 752c52134dcbf2fff13c7be1ce4e9e5dbf428a59\nparent 4876cb10aec6f708f7466dddf547567b65f6c39c\nauthor tony 1466759224.2817 +0000\ncommitter tony 1466759224.2817 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 7\n\nAdd a new README' +[2016-06-24 11:18:21,055: DEBUG/Worker-1] rev: 7, swhrev: 7f5bc909c29d4e93d8ccfdda516e51ed44930ee1, dir: 752c52134dcbf2fff13c7be1ce4e9e5dbf428a59 +b'tree 39c813fb4717a4864bacefbd90b51a3241ae4140\nparent 7f5bc909c29d4e93d8ccfdda516e51ed44930ee1\nauthor tony 1466759322.099151 +0000\ncommitter tony 1466759322.099151 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 8\n\nAdd link to README' +[2016-06-24 11:18:21,066: DEBUG/Worker-1] rev: 8, swhrev: 38d81702cb28db4f1a6821e64321e5825d1f7fd6, dir: 39c813fb4717a4864bacefbd90b51a3241ae4140 +[2016-07-11 10:47:18,609: DEBUG/Worker-1] rev: 9, swhrev: 99c27ebbd43feca179ac0e895af131d8314cafe1, dir: 3397ca7f709639cbd36b18a0d1b70bce80018c45 +[2016-07-11 10:47:18,644: DEBUG/Worker-1] rev: 10, swhrev: 902f29b4323a9b9de3af6d28e72dd581e76d9397, dir: c4e12483f0a13e6851459295a4ae735eb4e4b5c4 +[2016-07-11 10:47:18,831: DEBUG/Worker-1] rev: 11, swhrev: 171dc35522bfd17dda4e90a542a0377fb2fc707a, dir: fd24a76c87a3207428e06612b49860fc78e9f6dc +#+END_SRC + +|--------------+------------------------------------------+------------------------------------------| +| svn revision | swh revision | tree | +|--------------+------------------------------------------+------------------------------------------| +| 7 | 7f5bc909c29d4e93d8ccfdda516e51ed44930ee1 | 752c52134dcbf2fff13c7be1ce4e9e5dbf428a59 | +| 8 | 38d81702cb28db4f1a6821e64321e5825d1f7fd6 | 39c813fb4717a4864bacefbd90b51a3241ae4140 | +| 9 | 99c27ebbd43feca179ac0e895af131d8314cafe1 | 3397ca7f709639cbd36b18a0d1b70bce80018c45 | +| 10 | 902f29b4323a9b9de3af6d28e72dd581e76d9397 | c4e12483f0a13e6851459295a4ae735eb4e4b5c4 | +| 11 | 171dc35522bfd17dda4e90a542a0377fb2fc707a | fd24a76c87a3207428e06612b49860fc78e9f6dc | +|--------------+------------------------------------------+------------------------------------------| +*** Checks +**** Trees + +#+BEGIN_SRC sh +$ pwd +/home/storage/svn/working-copies/pkg-gourmet +$ cd ..; rm -rf pkg-gourmet; svn export --ignore-keywords file:///home/storage/svn/repos/pkg-gourmet@7; cd pkg-gourmet; swh-hashtree --path . +A pkg-gourmet +A pkg-gourmet/foo +A pkg-gourmet/foo/bar +A pkg-gourmet/foo/bar/README +A pkg-gourmet/gourmet +A pkg-gourmet/gourmet/branches +A pkg-gourmet/gourmet/tags +A pkg-gourmet/gourmet/trunk +A pkg-gourmet/gourmet/trunk/debian +A pkg-gourmet/gourmet/trunk/debian/patches +A pkg-gourmet/gourmet/trunk/debian/patches/00list +A pkg-gourmet/gourmet/trunk/debian/patches/01_printer_warning.dpatch +A pkg-gourmet/gourmet/trunk/debian/README.Maintainer +A pkg-gourmet/gourmet/trunk/debian/TODO +A pkg-gourmet/gourmet/trunk/debian/changelog +A pkg-gourmet/gourmet/trunk/debian/compat +A pkg-gourmet/gourmet/trunk/debian/control +A pkg-gourmet/gourmet/trunk/debian/copyright +A pkg-gourmet/gourmet/trunk/debian/dirs +A pkg-gourmet/gourmet/trunk/debian/docs +A pkg-gourmet/gourmet/trunk/debian/gourmet.1 +A pkg-gourmet/gourmet/trunk/debian/menu +A pkg-gourmet/gourmet/trunk/debian/postinst +A pkg-gourmet/gourmet/trunk/debian/postrm +A pkg-gourmet/gourmet/trunk/debian/prerm +A pkg-gourmet/gourmet/trunk/debian/recbox.xpm +A pkg-gourmet/gourmet/trunk/debian/rules +A pkg-gourmet/gourmet/trunk/debian/source.lintian-overrides +Exported revision 7. +752c52134dcbf2fff13c7be1ce4e9e5dbf428a59 +$ cd ..; rm -rf pkg-gourmet; svn export --ignore-keywords file:///home/storage/svn/repos/pkg-gourmet@8; cd pkg-gourmet; swh-hashtree --path . +A pkg-gourmet +A pkg-gourmet/foo +A pkg-gourmet/foo/bar +A pkg-gourmet/foo/bar/README +A pkg-gourmet/gourmet +A pkg-gourmet/gourmet/branches +A pkg-gourmet/gourmet/tags +A pkg-gourmet/gourmet/trunk +A pkg-gourmet/gourmet/trunk/debian +A pkg-gourmet/gourmet/trunk/debian/patches +A pkg-gourmet/gourmet/trunk/debian/patches/00list +A pkg-gourmet/gourmet/trunk/debian/patches/01_printer_warning.dpatch +A pkg-gourmet/gourmet/trunk/debian/README.Maintainer +A pkg-gourmet/gourmet/trunk/debian/TODO +A pkg-gourmet/gourmet/trunk/debian/changelog +A pkg-gourmet/gourmet/trunk/debian/compat +A pkg-gourmet/gourmet/trunk/debian/control +A pkg-gourmet/gourmet/trunk/debian/copyright +A pkg-gourmet/gourmet/trunk/debian/dirs +A pkg-gourmet/gourmet/trunk/debian/docs +A pkg-gourmet/gourmet/trunk/debian/gourmet.1 +A pkg-gourmet/gourmet/trunk/debian/menu +A pkg-gourmet/gourmet/trunk/debian/postinst +A pkg-gourmet/gourmet/trunk/debian/postrm +A pkg-gourmet/gourmet/trunk/debian/prerm +A pkg-gourmet/gourmet/trunk/debian/recbox.xpm +A pkg-gourmet/gourmet/trunk/debian/rules +A pkg-gourmet/gourmet/trunk/debian/source.lintian-overrides +A pkg-gourmet/README +Exported revision 8. +39c813fb4717a4864bacefbd90b51a3241ae4140 +#+END_SRC + +Trees ok! + +**** Revisions + +#+BEGIN_SRC sh +$ git-revhash 'tree 752c52134dcbf2fff13c7be1ce4e9e5dbf428a59\nparent 4876cb10aec6f708f7466dddf547567b65f6c39c\nauthor tony 1466759224.2817 +0000\ncommitter tony 1466759224.2817 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 7\n\nAdd a new README' +7f5bc909c29d4e93d8ccfdda516e51ed44930ee1 +$ git-revhash 'tree 39c813fb4717a4864bacefbd90b51a3241ae4140\nparent 7f5bc909c29d4e93d8ccfdda516e51ed44930ee1\nauthor tony 1466759322.099151 +0000\ncommitter tony 1466759322.099151 +0000\nsvn_repo_uuid 3187e211-bb14-4c82-9596-0b59d67cd7f4\nsvn_revision 8\n\nAdd link to README +38d81702cb28db4f1a6821e64321e5825d1f7fd6 +#+END_SRC +** Adding new corner cases + +About [[http://svnbook.red-bean.com/en/1.8/svn.advanced.props.file-portability.html#svn.advanced.props.special.eol-style][eol property on files]]. + +|--------------+------------------------------------------+------------------------------------------+-------------------------------------------------+-----------------------------------------| +| svn revision | swh revision | tree | File | Expects | +|--------------+------------------------------------------+------------------------------------------+-------------------------------------------------+-----------------------------------------| +| 12 | 027e8769f4786597436ab94a91f85527d04a6cbb | 2d9ca72c6afec6284fb01e459588cbb007017c8c | Added and committed a file with standard lf eol | Nothing to do | +| 13 | 4474d96018877742d9697d5c76666c9693353bfc | ab111577e0ab39e4a157c476072af48f2641d93f | Added and committed a file with crlf eol | Nothing done (file contains CRLF) | +| 14 | 97ad21eab92961e2a22ca0285f09c6d1e9a7ffbc | ab111577e0ab39e4a157c476072af48f2641d93f | Update that file with svn:style 'CRLF' | Nothing to do (already in CRLF) | +| 15 | d04ea8afcee6205cc8384c091bfc578931c169fd | b0a648b02e55a4dce356ac35187a058f89694ec7 | Update that file with svn:style 'native' | Conversion to LF (during commit) | +| 16 | ded78810401fd354ffe894aa4a1e5c7d30a645d1 | b0a648b02e55a4dce356ac35187a058f89694ec7 | Update that file with svn:style 'LF | Nothing to do (already converted in LF) | +| 17 | 4ee95e39358712f53c4fc720da3fafee9249ed19 | c3c98df624733fef4e592bef983f93e2ed02b179 | Added and committed a file with cr eol | Nothing to do (file contains CR) | +| 18 | ffa901b69ca0f46a2261f42948838d19709cb9f8 | c3c98df624733fef4e592bef983f93e2ed02b179 | Update that file with svn:style 'CR' | Nothing to do (already in CR) | +| 19 | 0148ae3eaa520b73a50802c59f3f416b7a36cf8c | 844d4646d6c2b4f3a3b2b22ab0ee38c7df07bab2 | Update that file with svn:style 'native' | Conversion (during commit) | +|--------------+------------------------------------------+------------------------------------------+-------------------------------------------------+-----------------------------------------| diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..5e4ffc3 --- /dev/null +++ b/tox.ini @@ -0,0 +1,36 @@ +[tox] +envlist=black,flake8,mypy,py3 + +[testenv] +extras = + testing +deps = + pytest-cov + swh.scheduler[testing] >= 0.5.0 + dev: pdbpp +commands = + pytest --cov={envsitepackagesdir}/swh/loader/svn \ + {envsitepackagesdir}/swh/loader/svn \ + --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] +extras = + testing +deps = + mypy +commands = + mypy swh