Page MenuHomeSoftware Heritage
Files F7521373

No OneTemporary
Actions

View Options

diff --git a/.gitignore b/.gitignore
deleted file mode 100644
index 33f4c0b..0000000
--- a/.gitignore
+++ /dev/null
@@ -1,5 +0,0 @@
-__pycache__
-/.coverage
-*egg-info/
-version.txt
-analysis/
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. <http://fsf.org/>
- 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.
-
- <one line to give the program's name and a brief idea of what it does.>
- Copyright (C) <year> <name of author>
-
- 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 <http://www.gnu.org/licenses/>.
-
-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:
-
- <program> Copyright (C) <year> <name of author>
- 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
-<http://www.gnu.org/licenses/>.
-
- 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
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/MANIFEST.in b/MANIFEST.in
index e7c46fc..0014268 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,4 +1,5 @@
include Makefile
include requirements.txt
include requirements-swh.txt
include version.txt
+recursive-include swh/loader/dir/tests/resources *
diff --git a/Makefile.local b/Makefile.local
deleted file mode 100644
index 249d0ef..0000000
--- a/Makefile.local
+++ /dev/null
@@ -1,2 +0,0 @@
-FLAG=-v
-NOSEFLAGS=-v -s
diff --git a/PKG-INFO b/PKG-INFO
index a03a5ed..ba15dd2 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,10 +1,108 @@
-Metadata-Version: 1.0
+Metadata-Version: 2.1
Name: swh.loader.dir
-Version: 0.0.32
+Version: 0.0.34
Summary: Software Heritage Directory Loader
Home-page: https://forge.softwareheritage.org/diffusion/DLDDIR
Author: Software Heritage developers
Author-email: swh-devel@inria.fr
License: UNKNOWN
-Description: 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-dir
+Description: SWH-loader-dir
+ ===================
+
+ The Software Heritage Directory Loader is a tool and a library.
+
+ Its sole purpose is to walk a local directory and inject into the SWH
+ dataset all unknown contained files from that directory structure.
+
+
+ ## Configuration
+
+ The loader needs a configuration file in *`{/etc/softwareheritage |
+ ~/.config/swh | ~/.swh}`/loader/dir.yml*.
+
+ This file should be similar to this (adapt according to your needs):
+
+ ``` yaml
+ storage:
+ cls: remote
+ args:
+ url: http://localhost:5002/
+ ```
+
+ ## Run
+
+ To run the loader, you can use either:
+
+ - python3's toplevel
+ - celery
+
+ ### Toplevel
+
+ Load directory directly from code or toplevel:
+
+ ``` Python
+ dir_path = '/home/storage/dir/'
+
+ # Fill in those
+ origin = {'url': 'some-origin', 'type': 'dir'}
+ visit_date = 'Tue, 3 May 2017 17:16:32 +0200'
+ revision = {
+ 'author': {'name': 'some', 'fullname': 'one', 'email': 'something'},
+ 'committer': {'name': 'some', 'fullname': 'one', 'email': 'something'},
+ 'message': '1.0 Released',
+ 'date': None,
+ 'committer_date': None,
+ 'type': 'tar',
+ 'metadata': {}
+ }
+ import logging
+ logging.basicConfig(level=logging.DEBUG)
+
+ from swh.loader.dir.tasks import LoadDirRepository
+ l = LoadDirRepository()
+ l.run_task(dir_path=dir_path, origin=origin, visit_date=visit_date,
+ revision=revision, release=None, branch_name='master')
+ ```
+
+ ### Celery
+
+ To use celery, add the following entries in the
+ *`{/etc/softwareheritage | ~/.config/swh | ~/.swh}`/worker.yml*` file:
+
+ ``` yaml
+ task_modules:
+ - swh.loader.dir.tasks
+ task_queues:
+ - swh_loader_dir
+ ```
+
+ cf. [swh-core's documentation](https://forge.softwareheritage.org/diffusion/DCORE/browse/master/README.md) for
+ more details.
+
+ You can then send the following message to the task queue:
+
+ ``` Python
+ from swh.loader.dir.tasks import LoadDirRepository
+
+ # Fill in those
+ origin = {'url': 'some-origin', 'type': 'dir'}
+ visit_date = 'Tue, 3 May 2017 17:16:32 +0200'
+ release = None
+ revision = {}
+ occurrence = {}
+
+ # Send message to the task queue
+ LoaderDirRepository().run(('/path/to/dir', origin, visit_date, revision, release, [occurrence]))
+ ```
+
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.md b/README.md
index 0047603..b20a34c 100644
--- a/README.md
+++ b/README.md
@@ -1,96 +1,88 @@
SWH-loader-dir
===================
The Software Heritage Directory Loader is a tool and a library.
Its sole purpose is to walk a local directory and inject into the SWH
dataset all unknown contained files from that directory structure.
## Configuration
The loader needs a configuration file in *`{/etc/softwareheritage |
~/.config/swh | ~/.swh}`/loader/dir.yml*.
This file should be similar to this (adapt according to your needs):
``` yaml
storage:
cls: remote
args:
url: 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
-content_packet_size: 100
-# 100 Mib of content data
-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
-directory_packet_size: 250
-revision_packet_size: 100
-release_packet_size: 100
-occurrence_packet_size: 100
```
## Run
To run the loader, you can use either:
- python3's toplevel
- celery
### Toplevel
Load directory directly from code or toplevel:
``` Python
-from swh.loader.dir.loader import DirLoader
-
-dir_path = '/path/to/directory
+dir_path = '/home/storage/dir/'
# Fill in those
origin = {'url': 'some-origin', 'type': 'dir'}
visit_date = 'Tue, 3 May 2017 17:16:32 +0200'
-release = None
-revision = {}
-occurrence = {}
+revision = {
+ 'author': {'name': 'some', 'fullname': 'one', 'email': 'something'},
+ 'committer': {'name': 'some', 'fullname': 'one', 'email': 'something'},
+ 'message': '1.0 Released',
+ 'date': None,
+ 'committer_date': None,
+ 'type': 'tar',
+ 'metadata': {}
+}
+import logging
+logging.basicConfig(level=logging.DEBUG)
-DirLoader().load(dir_path, origin, visit_date, revision, release, [occurrence])
+from swh.loader.dir.tasks import LoadDirRepository
+l = LoadDirRepository()
+l.run_task(dir_path=dir_path, origin=origin, visit_date=visit_date,
+ revision=revision, release=None, branch_name='master')
```
### Celery
To use celery, add the following entries in the
*`{/etc/softwareheritage | ~/.config/swh | ~/.swh}`/worker.yml*` file:
``` yaml
task_modules:
- swh.loader.dir.tasks
task_queues:
- swh_loader_dir
```
cf. [swh-core's documentation](https://forge.softwareheritage.org/diffusion/DCORE/browse/master/README.md) for
more details.
You can then send the following message to the task queue:
``` Python
from swh.loader.dir.tasks import LoadDirRepository
# Fill in those
origin = {'url': 'some-origin', 'type': 'dir'}
visit_date = 'Tue, 3 May 2017 17:16:32 +0200'
release = None
revision = {}
occurrence = {}
# Send message to the task queue
LoaderDirRepository().run(('/path/to/dir', origin, visit_date, revision, release, [occurrence]))
```
diff --git a/bin/swh-check-missing-objects.py b/bin/swh-check-missing-objects.py
deleted file mode 100755
index 1958e37..0000000
--- a/bin/swh-check-missing-objects.py
+++ /dev/null
@@ -1,189 +0,0 @@
-#!/usr/bin/env python3
-
-import os
-import subprocess
-
-from swh.model.hashutil import hash_path, hash_to_bytes
-
-BATCH_SIZE = 10000
-
-
-config = {
- # with git data for listing trees
- 'dir_path_git': '/home/tony/work/inria/repo/linux-tryouts-git',
-
- # without anything git related
- 'dir_path': '/home/tony/work/inria/repo/linux-tryouts',
-
- 'storage_class': 'remote_storage',
- 'storage_args': ['http://localhost:5002/'],
-}
-
-
-if config['storage_class'] == 'remote_storage':
- from swh.storage.api.client import RemoteStorage as Storage
-else:
- from swh.storage import Storage
-
-
-storage = Storage(*config['storage_args'])
-
-
-def list_files_from(rootpath):
- """Git ls tree from rootpath's latest revision's tree.
-
- Yields:
- Tuple of (perms, type, hex sha1, name)
-
- """
- with subprocess.Popen(
- ['find', '.', '-type', 'f'],
- stdout=subprocess.PIPE,
- cwd=rootpath) as proc:
- for filepath in proc.stdout:
- yield os.path.join(rootpath, filepath.strip().decode('utf-8'))
-
-
-def hashfile(filepath):
- """Hash a file according to what expects storage's api.
-
- """
- hashes = hash_path(filepath)
- hashes.update({'length': os.path.getsize(filepath)})
- return hashes
-
-
-def check_missing_contents(rootpath):
- print('Folder to check: %s' % rootpath)
- # List of contents to check in storage
- contents_batch = []
- # map of content index by sha1, value is their actual path
- contents_map = {}
- # full contents missing is a list of files not in storage
- content_missings = []
- # batch of contents to check
- count_batch_contents = 0
- # total number of checked contents
- count_checked_contents = 0
- # nb files read
- nb_files = 0
-
- for filepath in list_files_from(rootpath):
- nb_files += 1
- content_hashes = hashfile(filepath)
- contents_map.update({content_hashes['sha1']: filepath})
- contents_batch.append(content_hashes)
- count_batch_contents += 1
- if count_batch_contents < BATCH_SIZE: # accumulate content to check
- continue
-
- print('Checks %s contents' % len(contents_batch))
- for content_missing in storage.content_missing(contents_batch):
- content_missings.append(contents_map[content_missing['sha1']])
- count_checked_contents += count_batch_contents
-
- # reinitialize list
- contents_batch = []
- count_batch_contents = 0
-
- if contents_batch is not []:
- contents_batch_len = len(contents_batch)
- print('Checks %s contents' % contents_batch_len)
- for content_missing in storage.content_missing(contents_batch):
- content_missings.append(contents_map[content_missing['sha1']])
- count_checked_contents += contents_batch_len
-
- print('Number of contents checked: %s' % count_checked_contents)
- print('Number of files: %s' % nb_files)
- print('Stats on missing contents -')
- if len(content_missings) > 0:
- print('Missing files: ')
- for file_missing in content_missings:
- print('- %s', file_missing)
- else:
- print('Nothing missing!')
- print()
-
-
-def git_ls_tree(rootpath):
- """Git ls tree from rootpath's latest revision's tree.
-
- Yields:
- Tuple of (perms, type, hex sha1, name)
-
- """
- with subprocess.Popen(
- ['git', 'ls-tree', '-r', '-t', 'master^{tree}'],
- stdout=subprocess.PIPE,
- cwd=rootpath) as proc:
- for line in proc.stdout:
- yield line.strip().decode('utf-8').replace('\t', ' ').split(' ')
-
-
-def trees(rootpath):
- """Filter tree from rootpath in swh's api compliant with search.
-
- Yields:
- SWH compliant directory structure.
-
- """
- for _, type, hex_sha1, name in git_ls_tree(rootpath):
- if type == 'tree':
- yield{'id': hash_to_bytes(hex_sha1),
- 'name': name}
-
-
-def check_missing_trees(rootpath):
- print('Folder to check: %s' % rootpath)
- # List of dirs to check in storage
- dirs_batch = []
- # map of dir index by sha1, value is their actual path
- dirs_map = {}
- # full dirs missing is a list of files not in storage
- dir_missings = []
- # batch of dirs to check
- count_batch_dirs = 0
- # total number of checked dirs
- count_checked_dirs = 0
- # nb trees read
- nb_dirs = 0
-
- for tree in trees(rootpath):
- nb_dirs += 1
- tree_id = tree['id']
- dirs_map.update({tree_id: tree['name']})
- dirs_batch.append(tree_id)
- count_batch_dirs += 1
- if count_batch_dirs < BATCH_SIZE: # accumulate dir to check on storage
- continue
-
- print('Checks %s dirs' % len(dirs_batch))
- for dir_missing in storage.directory_missing(dirs_batch):
- dir_missings.append(dirs_map[dir_missing['id']])
- count_checked_dirs += count_batch_dirs
-
- # reinitialize list
- dirs_batch = []
- count_batch_dirs = 0
-
- if dirs_batch is not []:
- dirs_batch_len = len(dirs_batch)
- print('Checks %s dirs' % dirs_batch_len)
- for dir_missing in storage.directory_missing(dirs_batch):
- dir_missings.append(dirs_map[dir_missing['sha1']])
- count_checked_dirs += dirs_batch_len
-
- print('Number of dirs checked: %s' % count_checked_dirs)
- print('Number of dirs: %s' % nb_dirs)
- print('Stats on missing dirs -')
- if len(dir_missings) > 0:
- print('Missing files: ')
- for file_missing in dir_missings:
- print('- %s', file_missing)
- else:
- print('Nothing missing!')
- print()
-
-
-check_missing_contents(config['dir_path'])
-check_missing_trees(config['dir_path_git'])
diff --git a/bin/swh-loader-dir b/bin/swh-loader-dir
deleted file mode 100755
index 2d681fc..0000000
--- a/bin/swh-loader-dir
+++ /dev/null
@@ -1,63 +0,0 @@
-#!/usr/bin/env python3
-
-# NOT FOR PRODUCTION
-
-# Copyright (C) 2015 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 logging
-import sys
-
-
-from swh.loader.dir.loader import DirLoader
-from swh.core import config
-
-config_filename = sys.argv[1]
-
-logging.basicConfig(
- level=logging.DEBUG,
- format='%(asctime)s %(name)s %(levelname)s %(message)s',
- handlers=[
- logging.StreamHandler()
- ],
-)
-
-requests_log = logging.getLogger("requests")
-requests_log.setLevel(logging.CRITICAL)
-
-
-def load_keys_from_properties(conf, key_pattern):
- """Load keys from the dictionary conf which match the key_pattern.
-
- """
- m = {
- key[len(key_pattern):]: value
- for key, value in conf.items()
- if key.startswith(key_pattern)
- }
- return m
-
-
-# full configuration needed to instantiate misc objects (release,
-# revision, etc...)
-simple_config = config.read(config_filename)
-
-dir_path = simple_config['dir_path']
-
-origin = load_keys_from_properties(simple_config, 'origin_')
-
-release = load_keys_from_properties(simple_config, 'release_')
-release['date'] = int(release['date']) # hackish
-
-revision = load_keys_from_properties(simple_config, 'revision_')
-revision['committer_date'] = int(revision['committer_date']) # hackish
-revision['author_date'] = int(revision['author_date']) # hackish
-
-occurrence_2 = load_keys_from_properties(simple_config, 'occurrence2_')
-occurrence = load_keys_from_properties(simple_config, 'occurrence_')
-
-dir_loader_config = DirLoader.parse_config_file(config_filename)
-loader = DirLoader(dir_loader_config)
-loader.process(dir_path, origin, revision, release, [occurrence, occurrence_2])
diff --git a/docs/.gitignore b/docs/.gitignore
deleted file mode 100644
index f6b5c55..0000000
--- a/docs/.gitignore
+++ /dev/null
@@ -1,4 +0,0 @@
-_build/
-apidoc/
-*-stamp
-README.md
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100644
index ec260d2..0000000
--- a/docs/Makefile
+++ /dev/null
@@ -1,6 +0,0 @@
-include ../../swh-docs/Makefile.sphinx
-
-html: copy_md
-
-copy_md:
- cp ../README.md README.md
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 fc70096..0000000
--- a/docs/index.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-.. _swh-loader-dir:
-
-Software Heritage - Development Documentation
-=============================================
-
-.. toctree::
- :maxdepth: 2
- :caption: Contents:
-
- README.md
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/requirements-swh.txt b/requirements-swh.txt
index 3ef86ce..228d9f4 100644
--- a/requirements-swh.txt
+++ b/requirements-swh.txt
@@ -1,5 +1,5 @@
-swh.core >= 0.0.14
-swh.model >= 0.0.18
-swh.scheduler >= 0.0.14
+swh.core >= 0.0.37
+swh.model >= 0.0.27
+swh.scheduler >= 0.0.39
swh.storage >= 0.0.83
-swh.loader.core >= 0.0.32
+swh.loader.core >= 0.0.35
diff --git a/resources/dir.yml b/resources/dir.yml
deleted file mode 100644
index f60d1e1..0000000
--- a/resources/dir.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-storage:
- cls: remote
- args:
- url: http://localhost:5002/
-
-send_contents: True
-send_directories: True
-send_revisions: True
-send_releases: True
-send_occurrences: True
-content_packet_size: 10000
-content_packet_size_bytes: 1073741824
-content_packet_block_size_bytes: 104857600
-directory_packet_size: 25000
-revision_packet_size: 100000
-release_packet_size: 100000
-occurrence_packet_size: 100000
diff --git a/resources/loader/dir.yml b/resources/loader/dir.yml
deleted file mode 100644
index c6482df..0000000
--- a/resources/loader/dir.yml
+++ /dev/null
@@ -1,35 +0,0 @@
-# file to be used with bin/swh-check-missing-objects.py
-
-dir_path: /home/tony/work/inria/repo/linux-tryouts
-
-# synthetic origin
-origin_url: file:///dev/null
-origin_type: dir
-
-# occurrence
-occurrence_branch: master
-occurrence_date: 2015-10-01 00:00:00+00
-
-# occurrence
-occurrence2_branch: dev
-occurrence2_date: 2015-11-01 00:00:00+00
-
-# synthetic revision
-revision_author_name: swh author
-revision_author_email: swh@inria.fr
-revision_author_date: 1444054085
-revision_author_offset: +0200
-revision_committer_name: swh committer
-revision_committer_email: swh@inria.fr
-revision_committer_date: 1444054085
-revision_committer_offset: +0200
-revision_type: tar
-revision_message: synthetic revision message
-
-# synthetic release
-release_name: v0.0.1
-release_date: 1444054085
-release_offset: +0200
-release_author_name: swh author
-release_author_email: swh@inria.fr
-release_comment: synthetic release
diff --git a/setup.py b/setup.py
old mode 100644
new mode 100755
index 031ad79..7dea5e3
--- a/setup.py
+++ b/setup.py
@@ -1,28 +1,65 @@
+#!/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.dir',
description='Software Heritage Directory 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/DLDDIR',
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-dir',
+ },
)
diff --git a/swh.loader.dir.egg-info/PKG-INFO b/swh.loader.dir.egg-info/PKG-INFO
index a03a5ed..ba15dd2 100644
--- a/swh.loader.dir.egg-info/PKG-INFO
+++ b/swh.loader.dir.egg-info/PKG-INFO
@@ -1,10 +1,108 @@
-Metadata-Version: 1.0
+Metadata-Version: 2.1
Name: swh.loader.dir
-Version: 0.0.32
+Version: 0.0.34
Summary: Software Heritage Directory Loader
Home-page: https://forge.softwareheritage.org/diffusion/DLDDIR
Author: Software Heritage developers
Author-email: swh-devel@inria.fr
License: UNKNOWN
-Description: 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-dir
+Description: SWH-loader-dir
+ ===================
+
+ The Software Heritage Directory Loader is a tool and a library.
+
+ Its sole purpose is to walk a local directory and inject into the SWH
+ dataset all unknown contained files from that directory structure.
+
+
+ ## Configuration
+
+ The loader needs a configuration file in *`{/etc/softwareheritage |
+ ~/.config/swh | ~/.swh}`/loader/dir.yml*.
+
+ This file should be similar to this (adapt according to your needs):
+
+ ``` yaml
+ storage:
+ cls: remote
+ args:
+ url: http://localhost:5002/
+ ```
+
+ ## Run
+
+ To run the loader, you can use either:
+
+ - python3's toplevel
+ - celery
+
+ ### Toplevel
+
+ Load directory directly from code or toplevel:
+
+ ``` Python
+ dir_path = '/home/storage/dir/'
+
+ # Fill in those
+ origin = {'url': 'some-origin', 'type': 'dir'}
+ visit_date = 'Tue, 3 May 2017 17:16:32 +0200'
+ revision = {
+ 'author': {'name': 'some', 'fullname': 'one', 'email': 'something'},
+ 'committer': {'name': 'some', 'fullname': 'one', 'email': 'something'},
+ 'message': '1.0 Released',
+ 'date': None,
+ 'committer_date': None,
+ 'type': 'tar',
+ 'metadata': {}
+ }
+ import logging
+ logging.basicConfig(level=logging.DEBUG)
+
+ from swh.loader.dir.tasks import LoadDirRepository
+ l = LoadDirRepository()
+ l.run_task(dir_path=dir_path, origin=origin, visit_date=visit_date,
+ revision=revision, release=None, branch_name='master')
+ ```
+
+ ### Celery
+
+ To use celery, add the following entries in the
+ *`{/etc/softwareheritage | ~/.config/swh | ~/.swh}`/worker.yml*` file:
+
+ ``` yaml
+ task_modules:
+ - swh.loader.dir.tasks
+ task_queues:
+ - swh_loader_dir
+ ```
+
+ cf. [swh-core's documentation](https://forge.softwareheritage.org/diffusion/DCORE/browse/master/README.md) for
+ more details.
+
+ You can then send the following message to the task queue:
+
+ ``` Python
+ from swh.loader.dir.tasks import LoadDirRepository
+
+ # Fill in those
+ origin = {'url': 'some-origin', 'type': 'dir'}
+ visit_date = 'Tue, 3 May 2017 17:16:32 +0200'
+ release = None
+ revision = {}
+ occurrence = {}
+
+ # Send message to the task queue
+ LoaderDirRepository().run(('/path/to/dir', origin, visit_date, revision, release, [occurrence]))
+ ```
+
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.dir.egg-info/SOURCES.txt b/swh.loader.dir.egg-info/SOURCES.txt
index b02352b..3938678 100644
--- a/swh.loader.dir.egg-info/SOURCES.txt
+++ b/swh.loader.dir.egg-info/SOURCES.txt
@@ -1,40 +1,22 @@
-.gitignore
-AUTHORS
-LICENSE
MANIFEST.in
Makefile
-Makefile.local
README.md
requirements-swh.txt
requirements.txt
setup.py
version.txt
-bin/swh-check-missing-objects.py
-bin/swh-loader-dir
-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
-resources/dir.yml
-resources/loader/dir.yml
swh/__init__.py
swh.loader.dir.egg-info/PKG-INFO
swh.loader.dir.egg-info/SOURCES.txt
swh.loader.dir.egg-info/dependency_links.txt
swh.loader.dir.egg-info/requires.txt
swh.loader.dir.egg-info/top_level.txt
swh/loader/__init__.py
swh/loader/dir/__init__.py
swh/loader/dir/converters.py
swh/loader/dir/loader.py
swh/loader/dir/tasks.py
+swh/loader/dir/tests/__init__.py
swh/loader/dir/tests/test_converters.py
-swh/loader/dir/tests/test_loader.py
\ No newline at end of file
+swh/loader/dir/tests/test_loader.py
+swh/loader/dir/tests/resources/sample-folder.tgz
\ No newline at end of file
diff --git a/swh.loader.dir.egg-info/requires.txt b/swh.loader.dir.egg-info/requires.txt
index eca9d6c..12810a2 100644
--- a/swh.loader.dir.egg-info/requires.txt
+++ b/swh.loader.dir.egg-info/requires.txt
@@ -1,8 +1,11 @@
-click
+vcversioner
retrying
-swh.core>=0.0.14
-swh.loader.core>=0.0.32
-swh.model>=0.0.18
-swh.scheduler>=0.0.14
+click
+swh.core>=0.0.37
+swh.model>=0.0.27
+swh.scheduler>=0.0.39
swh.storage>=0.0.83
-vcversioner
+swh.loader.core>=0.0.35
+
+[testing]
+pytest
diff --git a/swh/loader/dir/loader.py b/swh/loader/dir/loader.py
index fa7d436..c8b3005 100644
--- a/swh/loader/dir/loader.py
+++ b/swh/loader/dir/loader.py
@@ -1,248 +1,252 @@
# 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 os
import uuid
from swh.loader.core import loader
from swh.model.identifiers import (release_identifier, revision_identifier,
snapshot_identifier, identifier_to_bytes)
from swh.model.from_disk import Directory
from . import converters
def revision_from(directory_hash, revision):
full_rev = dict(revision)
full_rev['directory'] = directory_hash
full_rev = converters.commit_to_revision(full_rev)
full_rev['id'] = identifier_to_bytes(revision_identifier(full_rev))
return full_rev
def release_from(revision_hash, release):
full_rel = dict(release)
full_rel['target'] = revision_hash
full_rel['target_type'] = 'revision'
full_rel = converters.annotated_tag_to_release(full_rel)
full_rel['id'] = identifier_to_bytes(release_identifier(full_rel))
return full_rel
def snapshot_from(revision_hash, branch):
"""Build a snapshot from an origin, a visit, a revision, and a branch.
"""
if isinstance(branch, str):
branch = branch.encode('utf-8')
snapshot = {
'id': None,
'branches': {
branch: {
'target': revision_hash,
'target_type': 'revision',
}
}
}
snap_id = identifier_to_bytes(snapshot_identifier(snapshot))
snapshot['id'] = snap_id
return snapshot
-class DirLoader(loader.SWHLoader):
+class DirLoader(loader.BufferedLoader):
"""A bulk loader for a directory."""
CONFIG_BASE_FILENAME = 'loader/dir'
def __init__(self, logging_class='swh.loader.dir.DirLoader',
config=None):
super().__init__(logging_class=logging_class, config=config)
def list_objs(self, *,
dir_path, revision, release, branch_name):
"""List all objects from dir_path.
Args:
dir_path (str): the directory to list
revision (dict): revision dictionary representation
release (dict): release dictionary representation
branch_name (str): branch name
Returns:
dict: a mapping from object types ('content', 'directory',
'revision', 'release', 'snapshot') with a dictionary
mapping each object's id to the object
"""
log_id = str(uuid.uuid4())
sdir_path = dir_path.decode('utf-8')
log_data = {
'swh_type': 'dir_list_objs_end',
'swh_repo': sdir_path,
'swh_id': log_id,
}
self.log.debug("Started listing {swh_repo}".format(**log_data),
extra=log_data)
directory = Directory.from_disk(path=dir_path, save_path=True)
objects = directory.collect()
+ if 'content' not in objects:
+ objects['content'] = {}
+ if 'directory' not in objects:
+ objects['directory'] = {}
full_rev = revision_from(directory.hash, revision)
rev_id = full_rev['id']
objects['revision'] = {
rev_id: full_rev
}
objects['release'] = {}
if release and 'name' in release:
full_rel = release_from(rev_id, release)
objects['release'][full_rel['id']] = full_rel
snapshot = snapshot_from(rev_id, branch_name)
objects['snapshot'] = {
snapshot['id']: snapshot
}
log_data.update({
'swh_num_%s' % key: len(values)
for key, values in objects.items()
})
self.log.debug(("Done listing the objects in {swh_repo}: "
"{swh_num_content} contents, "
"{swh_num_directory} directories, "
"{swh_num_revision} revisions, "
"{swh_num_release} releases, "
"{swh_num_snapshot} snapshot").format(**log_data),
extra=log_data)
return objects
def load(self, *, dir_path, origin, visit_date, revision, release,
branch_name=None):
"""Load the content of the directory to the archive.
Args:
dir_path: root of the directory to import
origin (dict): an origin dictionary as returned by
:func:`swh.storage.storage.Storage.origin_get_one`
visit_date (str): the date the origin was visited (as an
isoformatted string)
revision (dict): a revision as passed to
:func:`swh.storage.storage.Storage.revision_add`, excluding the
`id` and `directory` keys (computed from the directory)
release (dict): a release as passed to
:func:`swh.storage.storage.Storage.release_add`, excluding the
`id`, `target` and `target_type` keys (computed from the
revision)'
branch_name (str): the optional branch_name to use for snapshot
"""
# Yes, this is entirely redundant, but it allows us to document the
# arguments and the entry point.
return super().load(dir_path=dir_path, origin=origin,
visit_date=visit_date, revision=revision,
release=release, branch_name=branch_name)
def prepare_origin_visit(self, *, origin, visit_date=None, **kwargs):
self.origin = origin
self.visit_date = visit_date
def prepare(self, *, dir_path, origin, revision, release, visit_date=None,
branch_name=None):
"""Prepare the loader for directory loading.
Args: identical to :func:`load`.
"""
self.dir_path = dir_path
self.revision = revision
self.release = release
branch = branch_name if branch_name else os.path.basename(dir_path)
self.branch_name = branch
if not os.path.exists(self.dir_path):
warn_msg = 'Skipping inexistent directory %s' % self.dir_path
self.log.error(warn_msg,
extra={
'swh_type': 'dir_repo_list_refs',
'swh_repo': self.dir_path,
'swh_num_refs': 0,
})
raise ValueError(warn_msg)
if isinstance(self.dir_path, str):
self.dir_path = os.fsencode(self.dir_path)
def cleanup(self):
"""Nothing to clean up.
"""
pass
def fetch_data(self):
"""Walk the directory, load all objects with their hashes.
Sets self.objects reference with results.
"""
self.objects = self.list_objs(dir_path=self.dir_path,
revision=self.revision,
release=self.release,
branch_name=self.branch_name)
def store_data(self):
objects = self.objects
self.maybe_load_contents(objects['content'].values())
self.maybe_load_directories(objects['directory'].values())
self.maybe_load_revisions(objects['revision'].values())
self.maybe_load_releases(objects['release'].values())
snapshot = list(objects['snapshot'].values())[0]
self.maybe_load_snapshot(snapshot)
if __name__ == '__main__':
import click
import logging
logging.basicConfig(
level=logging.DEBUG,
format='%(asctime)s %(process)d %(message)s'
)
@click.command()
@click.option('--dir-path', required=1, help='Directory path to load')
@click.option('--origin-url', required=1,
help='Origin url for that directory')
@click.option('--visit-date', default=None,
help='Visit date time override')
def main(dir_path, origin_url, visit_date):
"""Loading directory tryout"""
import datetime
origin = {'url': origin_url, 'type': 'dir'}
commit_time = int(datetime.datetime.now(
tz=datetime.timezone.utc).timestamp())
swh_person = {
'name': 'Software Heritage',
'fullname': 'Software Heritage',
'email': 'robot@softwareheritage.org'
}
revision = {
'date': {'timestamp': commit_time, 'offset': 0},
'committer_date': {'timestamp': commit_time, 'offset': 0},
'author': swh_person,
'committer': swh_person,
'type': 'tar',
'message': 'swh-loader-dir: synthetic revision message',
'metadata': {},
'synthetic': True,
}
DirLoader().load(dir_path=dir_path, origin=origin,
visit_date=visit_date, revision=revision,
release=None)
main()
diff --git a/swh/loader/dir/tasks.py b/swh/loader/dir/tasks.py
index 30dad8c..771b525 100644
--- a/swh/loader/dir/tasks.py
+++ b/swh/loader/dir/tasks.py
@@ -1,26 +1,22 @@
# 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 celery import current_app as app
+
from swh.loader.dir.loader import DirLoader
-from swh.scheduler.task import Task
-class LoadDirRepository(Task):
+@app.task(name=__name__ + '.LoadDirRepository')
+def load_directory(dir_path, origin, visit_date, revision, release,
+ branch_name=None):
"""Import a directory to Software Heritage
- """
- task_queue = 'swh_loader_dir'
-
- def run_task(self, *, dir_path, origin, visit_date, revision, release,
- branch_name=None):
- """Import a directory dir_path with origin at visit_date time.
- Providing the revision, release, and occurrences.
+ Import a directory dir_path with origin at visit_date time.
+ Providing the revision, release, and occurrences.
- """
- loader = DirLoader()
- loader.log = self.log
- return loader.load(dir_path=dir_path, origin=origin,
- visit_date=visit_date, revision=revision,
- release=release, branch_name=branch_name)
+ """
+ return DirLoader().load(dir_path=dir_path, origin=origin,
+ visit_date=visit_date, revision=revision,
+ release=release, branch_name=branch_name)
diff --git a/docs/_static/.placeholder b/swh/loader/dir/tests/__init__.py
similarity index 100%
rename from docs/_static/.placeholder
rename to swh/loader/dir/tests/__init__.py
diff --git a/swh/loader/dir/tests/resources/sample-folder.tgz b/swh/loader/dir/tests/resources/sample-folder.tgz
new file mode 100644
index 0000000..cc84894
Binary files /dev/null and b/swh/loader/dir/tests/resources/sample-folder.tgz differ
diff --git a/swh/loader/dir/tests/test_converters.py b/swh/loader/dir/tests/test_converters.py
index 888cbc2..f88d5ed 100644
--- a/swh/loader/dir/tests/test_converters.py
+++ b/swh/loader/dir/tests/test_converters.py
@@ -1,167 +1,161 @@
# Copyright (C) 2015-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
import shutil
import tempfile
import unittest
-from nose.tools import istest
-
-from swh.model import hashutil
from swh.loader.dir import converters
+from swh.model import hashutil
def tmpfile_with_content(fromdir, contentfile):
"""Create a temporary file with content contentfile in directory fromdir.
"""
tmpfilepath = tempfile.mktemp(
suffix='.swh',
prefix='tmp-file-for-test',
dir=fromdir)
with open(tmpfilepath, 'wb') as f:
f.write(contentfile)
return tmpfilepath
class TestConverters(unittest.TestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.tmpdir = tempfile.mkdtemp(prefix='test-swh-loader-dir.')
@classmethod
def tearDownClass(cls):
shutil.rmtree(cls.tmpdir)
super().tearDownClass()
- @istest
- def format_to_minutes(self):
- self.assertEquals(converters.format_to_minutes('+0100'), 60)
- self.assertEquals(converters.format_to_minutes('-0200'), -120)
- self.assertEquals(converters.format_to_minutes('+1250'), 12*60+50)
- self.assertEquals(converters.format_to_minutes('+0000'), 0)
- self.assertEquals(converters.format_to_minutes('-0000'), 0)
+ def test_format_to_minutes(self):
+ self.assertEqual(converters.format_to_minutes('+0100'), 60)
+ self.assertEqual(converters.format_to_minutes('-0200'), -120)
+ self.assertEqual(converters.format_to_minutes('+1250'), 12*60+50)
+ self.assertEqual(converters.format_to_minutes('+0000'), 0)
+ self.assertEqual(converters.format_to_minutes('-0000'), 0)
- @istest
- def annotated_tag_to_release(self):
+ def test_annotated_tag_to_release(self):
# given
release = {
'name': 'v0.0.1',
'message': 'synthetic-message-input',
'author': {'name': 'author-name',
'email': 'author-email',
'fullname': 'fullname'},
}
expected_release = {
'name': b'v0.0.1',
'message': b'synthetic-message-input',
'author': {'name': b'author-name',
'email': b'author-email',
'fullname': b'fullname'},
'synthetic': True,
}
# when
actual_release = converters.annotated_tag_to_release(release)
# then
self.assertDictEqual(actual_release, expected_release)
- @istest
- def commit_to_revision(self):
+ def test_commit_to_revision(self):
# given
commit = {
'sha1_git': 'commit-git-sha1',
'directory': 'targeted-tree-sha1',
'date': {'timestamp': 1444054085, 'offset': '+0000'},
'committer_date': {'timestamp': 1444054085, 'offset': '+0000'},
'type': 'tar',
'message': 'synthetic-message-input',
'author': {'name': 'author-name',
'email': 'author-email',
'fullname': 'fullname'},
'committer': {'name': 'author-name',
'email': 'author-email',
'fullname': 'fullname'},
'directory': 'targeted-tree-sha1',
}
expected_revision = {
'sha1_git': 'commit-git-sha1',
'directory': 'targeted-tree-sha1',
'date': {'timestamp': 1444054085, 'offset': '+0000'},
'committer_date': {'timestamp': 1444054085, 'offset': '+0000'},
'type': 'tar',
'message': b'synthetic-message-input',
'author': {'name': b'author-name',
'email': b'author-email',
'fullname': b'fullname'},
'committer': {'name': b'author-name',
'email': b'author-email',
'fullname': b'fullname'},
'directory': 'targeted-tree-sha1',
'synthetic': True,
'parents': []
}
# when
actual_revision = converters.commit_to_revision(commit)
# then
- self.assertEquals(actual_revision, expected_revision)
+ self.assertEqual(actual_revision, expected_revision)
- @istest
- def commit_to_revision_with_parents(self):
+ def test_commit_to_revision_with_parents(self):
"""Commit with existing parents should not lose information
"""
h = '10041ddb6cbc154c24227b1e8759b81dcd99ea3e'
# given
commit = {
'sha1_git': 'commit-git-sha1',
'directory': 'targeted-tree-sha1',
'date': {'timestamp': 1444054085, 'offset': '+0000'},
'committer_date': {'timestamp': 1444054085, 'offset': '+0000'},
'type': 'tar',
'message': 'synthetic-message-input',
'author': {'name': 'author-name',
'email': 'author-email',
'fullname': 'fullname'},
'committer': {'name': 'author-name',
'email': 'author-email',
'fullname': 'fullname'},
'directory': 'targeted-tree-sha1',
'parents': [h],
}
expected_revision = {
'sha1_git': 'commit-git-sha1',
'directory': 'targeted-tree-sha1',
'date': {'timestamp': 1444054085, 'offset': '+0000'},
'committer_date': {'timestamp': 1444054085, 'offset': '+0000'},
'type': 'tar',
'message': b'synthetic-message-input',
'author': {'name': b'author-name',
'email': b'author-email',
'fullname': b'fullname'},
'committer': {'name': b'author-name',
'email': b'author-email',
'fullname': b'fullname'},
'directory': 'targeted-tree-sha1',
'synthetic': True,
'parents': [hashutil.hash_to_bytes(h)]
}
# when
actual_revision = converters.commit_to_revision(commit)
# then
- self.assertEquals(actual_revision, expected_revision)
+ self.assertEqual(actual_revision, expected_revision)
diff --git a/swh/loader/dir/tests/test_loader.py b/swh/loader/dir/tests/test_loader.py
index a92be9a..9422d16 100644
--- a/swh/loader/dir/tests/test_loader.py
+++ b/swh/loader/dir/tests/test_loader.py
@@ -1,312 +1,198 @@
# 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 os
-import shutil
-import subprocess
-import tempfile
-import unittest
-
-from nose.tools import istest
-from nose.plugins.attrib import attr
+import pytest
+from swh.loader.core.tests import BaseLoaderTest
from swh.loader.dir.loader import DirLoader
+from swh.model import hashutil
-@attr('fs')
-class InitTestLoader(unittest.TestCase):
- @classmethod
- def setUpClass(cls):
- super().setUpClass()
-
- cls.tmp_root_path = tempfile.mkdtemp().encode('utf-8')
-
- start_path = os.path.dirname(__file__).encode('utf-8')
- sample_folder_archive = os.path.join(start_path,
- b'../../../../..',
- b'swh-storage-testdata',
- b'dir-folders',
- b'sample-folder.tgz')
-
- cls.root_path = os.path.join(cls.tmp_root_path)
- # uncompress the sample folder
- subprocess.check_output(
- ['tar', 'xvf', sample_folder_archive, '-C', cls.tmp_root_path],
- )
+@pytest.mark.fs
+class BaseDirLoaderTest(BaseLoaderTest):
+ def setUp(self, archive_name='sample-folder.tgz'):
+ super().setUp(archive_name=archive_name,
+ prefix_tmp_folder_name='swh.loader.dir.',
+ start_path=os.path.dirname(__file__))
- @classmethod
- def tearDownClass(cls):
- super().tearDownClass()
- shutil.rmtree(cls.tmp_root_path)
-
-
-class DirLoaderListRepoObject(InitTestLoader):
+class DirLoaderNoStorage(DirLoader):
+ """A DirLoader with no persistence.
- def setUp(self):
- super().setUp()
+ Context:
+ Load a tarball with a persistent-less tarball loader
- self.info = {
+ """
+ def parse_config_file(self, *args, **kwargs):
+ return {
'storage': {
- 'cls': 'remote',
+ 'cls': 'memory',
'args': {
- 'url': 'http://localhost:5002/',
}
},
'content_size_limit': 104857600,
'log_db': 'dbname=softwareheritage-log',
'directory_packet_size': 25000,
'content_packet_size': 10000,
'send_contents': True,
'send_directories': True,
'content_packet_size_bytes': 1073741824,
'send_revisions': True,
'revision_packet_size': 100000,
'content_packet_block_size_bytes': 104857600,
- 'send_snaphot': True,
+ 'send_snapshot': True,
'release_packet_size': 100000,
'send_releases': True
}
+
+class DirLoaderListRepoObject(BaseDirLoaderTest):
+ def setUp(self):
+ super().setUp()
+
self.origin = {
'url': 'file:///dev/null',
'type': 'dir',
}
self.revision = {
'author': {
'name': 'swh author',
'email': 'swh@inria.fr',
'fullname': 'swh'
},
'date': {
'timestamp': 1444054085,
'offset': 0
},
'committer': {
'name': 'swh committer',
'email': 'swh@inria.fr',
'fullname': 'swh'
},
'committer_date': {
'timestamp': 1444054085,
'offset': 0,
},
'type': 'tar',
'message': 'synthetic revision',
'metadata': {'foo': 'bar'},
}
self.release = {
'name': 'v0.0.1',
'date': {
'timestamp': 1444054085,
'offset': 0,
},
'author': {
'name': 'swh author',
'fullname': 'swh',
'email': 'swh@inria.fr',
},
'message': 'synthetic release',
}
- self.dirloader = DirLoader(config=self.info)
+ self.dirloader = DirLoaderNoStorage()
- @istest
- def load_without_storage(self):
+ def test_load_without_storage(self):
"""List directory objects without loading should be ok"""
# when
+ dir_path = self.destination_path
+ if isinstance(dir_path, str):
+ dir_path = dir_path.encode('utf-8')
objects = self.dirloader.list_objs(
- dir_path=self.root_path,
+ dir_path=dir_path,
revision=self.revision,
release=self.release,
branch_name=b'master')
# then
- self.assertEquals(len(objects), 5,
- "5 obj types: con, dir, rev, rel, snap")
- self.assertEquals(len(objects['content']), 8,
- "8 contents: 3 files + 5 links")
- self.assertEquals(len(objects['directory']), 6,
- "6 directories: 5 subdirs + 1 empty")
- self.assertEquals(len(objects['revision']), 1, "synthetic revision")
- self.assertEquals(len(objects['release']), 1, "synthetic release")
- self.assertEquals(len(objects['snapshot']), 1, "snapshot")
-
-
-class LoaderNoStorageForTest:
- """Mixin class to inhibit the persistence and keep in memory the data
- sent for storage.
-
- cf. SWHDirLoaderNoStorage
-
- """
- def __init__(self):
- super().__init__()
- # Init the state
- self.all_contents = []
- self.all_directories = []
- self.all_revisions = []
- self.all_releases = []
- self.all_snapshots = []
-
- def send_origin(self, origin):
- origin['id'] = 1
- self.origin = origin
- return self.origin
-
- def send_origin_visit(self, origin_id, ts):
- origin_visit = {
- 'origin': origin_id,
- 'ts': ts,
- 'visit': 1,
- }
- return origin_visit
-
- def update_origin_visit(self, origin_id, visit, status):
- self.status = status
- self.origin_visit = visit
-
- def maybe_load_contents(self, all_contents):
- self.all_contents.extend(all_contents)
-
- def maybe_load_directories(self, all_directories):
- self.all_directories.extend(all_directories)
-
- def maybe_load_revisions(self, all_revisions):
- self.all_revisions.extend(all_revisions)
-
- def maybe_load_releases(self, releases):
- self.all_releases.extend(releases)
-
- def maybe_load_snapshot(self, snapshot):
- self.all_snapshots.append(snapshot)
-
- def open_fetch_history(self):
- return 1
-
- def close_fetch_history_success(self, fetch_history_id):
- pass
-
- def close_fetch_history_failure(self, fetch_history_id):
- pass
-
-
-TEST_CONFIG = {
- 'extraction_dir': '/tmp/tests/loader-tar/', # where to extract the tarball
- 'storage': { # we instantiate it but we don't use it in test context
- 'cls': 'remote',
- 'args': {
- 'url': 'http://127.0.0.1:9999', # somewhere that does not exist
- }
- },
- 'send_contents': False,
- 'send_directories': False,
- 'send_revisions': False,
- 'send_releases': False,
- 'send_snapshot': False,
- 'content_packet_size': 100,
- 'content_packet_block_size_bytes': 104857600,
- 'content_packet_size_bytes': 1073741824,
- 'directory_packet_size': 250,
- 'revision_packet_size': 100,
- 'release_packet_size': 100,
-}
-
-
-def parse_config_file(base_filename=None, config_filename=None,
- additional_configs=None, global_config=True):
- return TEST_CONFIG
-
-
-# Inhibit side-effect loading configuration from disk
-DirLoader.parse_config_file = parse_config_file
-
-
-class SWHDirLoaderNoStorage(LoaderNoStorageForTest, DirLoader):
- """A DirLoader with no persistence.
-
- Context:
- Load a tarball with a persistent-less tarball loader
-
- """
- pass
-
-
-class SWHDirLoaderITTest(InitTestLoader):
+ self.assertEqual(len(objects), 5,
+ "5 obj types: con, dir, rev, rel, snap")
+ self.assertEqual(len(objects['content']), 8,
+ "8 contents: 3 files + 5 links")
+ self.assertEqual(len(objects['directory']), 6,
+ "6 directories: 5 subdirs + 1 empty")
+ self.assertEqual(len(objects['revision']), 1, "synthetic revision")
+ self.assertEqual(len(objects['release']), 1, "synthetic release")
+ self.assertEqual(len(objects['snapshot']), 1, "snapshot")
+
+
+class SWHDirLoaderITTest(BaseDirLoaderTest):
def setUp(self):
super().setUp()
+ self.loader = DirLoaderNoStorage()
+ self.storage = self.loader.storage
- self.loader = SWHDirLoaderNoStorage()
-
- @istest
- def load(self):
+ def test_load(self):
"""Process a new tarball should be ok
"""
# given
origin = {
'url': 'file:///tmp/sample-folder',
'type': 'dir'
}
visit_date = 'Tue, 3 May 2016 17:16:32 +0200'
import datetime
- commit_time = int(datetime.datetime.now(
- tz=datetime.timezone.utc).timestamp()
- )
+ commit_time = int(datetime.datetime(
+ 2018, 12, 5, 13, 35, 23, 0,
+ tzinfo=datetime.timezone(datetime.timedelta(hours=1))
+ ).timestamp())
swh_person = {
'name': 'Software Heritage',
'fullname': 'Software Heritage',
'email': 'robot@softwareheritage.org'
}
revision_message = 'swh-loader-dir: synthetic revision message'
revision_type = 'tar'
revision = {
'date': {
'timestamp': commit_time,
'offset': 0,
},
'committer_date': {
'timestamp': commit_time,
'offset': 0,
},
'author': swh_person,
'committer': swh_person,
'type': revision_type,
'message': revision_message,
'metadata': {},
'synthetic': True,
}
- branch = os.path.basename(self.root_path)
+ branch = os.path.basename(self.destination_path)
# when
self.loader.load(
- dir_path=self.root_path, origin=origin, visit_date=visit_date,
- revision=revision, release=None, branch_name=branch)
+ dir_path=self.destination_path, origin=origin,
+ visit_date=visit_date, revision=revision,
+ release=None, branch_name=branch)
# then
- self.assertEquals(len(self.loader.all_contents), 8)
- self.assertEquals(len(self.loader.all_directories), 6)
- self.assertEquals(len(self.loader.all_revisions), 1)
-
- actual_revision = self.loader.all_revisions[0]
- self.assertEquals(actual_revision['synthetic'],
- True)
- self.assertEquals(actual_revision['parents'],
- [])
- self.assertEquals(actual_revision['type'],
- 'tar')
- self.assertEquals(actual_revision['message'],
- b'swh-loader-dir: synthetic revision message')
-
- self.assertEquals(len(self.loader.all_releases), 0)
- self.assertEquals(len(self.loader.all_snapshots), 1)
+ self.assertCountContents(8)
+ self.assertCountDirectories(6)
+ self.assertCountRevisions(1)
+
+ rev_id = hashutil.hash_to_bytes(
+ 'e974eda2328f6e97bc185307c692a115fe3a7eae')
+ actual_revision = next(self.storage.revision_get([rev_id]))
+ self.assertEqual(actual_revision['synthetic'], True)
+ self.assertEqual(actual_revision['parents'], [])
+ self.assertEqual(actual_revision['type'], 'tar')
+ self.assertEqual(actual_revision['message'],
+ b'swh-loader-dir: synthetic revision message')
+
+ self.assertCountReleases(0)
+ self.assertCountSnapshots(1)
diff --git a/version.txt b/version.txt
index 7c5ef30..013bb72 100644
--- a/version.txt
+++ b/version.txt
@@ -1 +1 @@
-v0.0.32-0-g1fc94eb
\ No newline at end of file
+v0.0.34-0-gf515338
\ No newline at end of file

File Metadata

Mime Type
application/octet-stream
Expires
Fri, Apr 25, 5:40 AM (2 d)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3294008

Event Timeline

About · Developer information · Legal