diff --git a/LICENSES/GPL-3.0-only.txt b/LICENSES/GPL-3.0-only.txt new file mode 100644 index 0000000..e142a52 --- /dev/null +++ b/LICENSES/GPL-3.0-only.txt @@ -0,0 +1,625 @@ +GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright © 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/LICENSES/LicenseRef-KDE-Accepted-GPL.txt b/LICENSES/LicenseRef-KDE-Accepted-GPL.txt new file mode 100644 index 0000000..60a2dff --- /dev/null +++ b/LICENSES/LicenseRef-KDE-Accepted-GPL.txt @@ -0,0 +1,12 @@ +This library 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) at any later version that is +accepted by the membership of KDE e.V. (or its successor +approved by the membership of KDE e.V.), which shall act as a +proxy as defined in Section 14 of version 3 of the license. + +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. diff --git a/apis/apis_test.go b/apis/apis_test.go index feac565..0a360ca 100644 --- a/apis/apis_test.go +++ b/apis/apis_test.go @@ -1,66 +1,49 @@ -/* - Copyright © 2017 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package apis import ( "bytes" "net/http" "net/http/httptest" "testing" "github.com/gin-gonic/gin" "github.com/stretchr/testify/assert" ) var router *gin.Engine func init() { router = gin.Default() } type apiTestCase struct { tag string method string url string body string status int response string } func testAPI(method, URL, body string) *httptest.ResponseRecorder { req, _ := http.NewRequest(method, URL, bytes.NewBufferString(body)) req.Header.Set("Content-Type", "application/json") res := httptest.NewRecorder() router.ServeHTTP(res, req) return res } func runAPITests(t *testing.T, tests []apiTestCase) { for _, test := range tests { t.Run(test.tag, func(t *testing.T) { res := testAPI(test.method, test.url, test.body) assert.Equal(t, test.status, res.Code, test.tag) if test.response != "" { assert.JSONEq(t, test.response, res.Body.String(), test.tag) } }) } } diff --git a/apis/git.go b/apis/git.go index 307c907..1dcb5aa 100644 --- a/apis/git.go +++ b/apis/git.go @@ -1,69 +1,52 @@ -/* - Copyright © 2017 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package apis import ( "fmt" "net/http" "time" "github.com/gin-gonic/gin" ) type gitService interface { UpdateClone() string Age() time.Duration } type gitResource struct { service gitService } // ServeGitResource creates a new API resource. func ServeGitResource(rg *gin.RouterGroup, service gitService) { r := &gitResource{service} rg.GET("/poll", r.poll) } /** * @api {get} /poll Update Clone * * @apiVersion 1.0.0 * @apiGroup Project * @apiName poll * * @apiDescription Updates internal repo-metadata clone. Generally not necessary * to call as the clone is updated automatically. This endpoint is handy when * forcing an update is called for. This is subject to rate limiting. * * @apiSuccessExample {json} Success-Response: * "Alread up-to-date." * @apiError {json} TooManyRequests Already up to date enough. */ func (r *gitResource) poll(c *gin.Context) { since := r.service.Age() if since.Minutes() < 2.0 { c.JSON(http.StatusTooManyRequests, fmt.Sprintf("Not updating. Last update was %s ago.", since)) return } c.JSON(http.StatusOK, r.service.UpdateClone()) } diff --git a/apis/git_test.go b/apis/git_test.go index b6c8c8c..4605797 100644 --- a/apis/git_test.go +++ b/apis/git_test.go @@ -1,60 +1,43 @@ -/* - Copyright © 2017 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package apis import ( "net/http" "testing" "time" ) // Test Double type GitService struct { age time.Duration } func NewGitService() *GitService { age, _ := time.ParseDuration("5m") return &GitService{age} } func (s *GitService) UpdateClone() string { s.age = 0 return "UPDATED" } func (s *GitService) Age() time.Duration { return s.age } func init() { v1 := router.Group("/v1") { ServeGitResource(v1, NewGitService()) } } func TestGit(t *testing.T) { runAPITests(t, []apiTestCase{ {"t1 - poll", "GET", "/v1/poll", "", http.StatusOK, `"UPDATED"`}, {"t2 - poll", "GET", "/v1/poll", "", http.StatusTooManyRequests, `"Not updating. Last update was 0s ago."`}, }) } diff --git a/apis/project.go b/apis/project.go index 91b83e0..b1308e1 100644 --- a/apis/project.go +++ b/apis/project.go @@ -1,240 +1,223 @@ -/* - Copyright © 2017-2019 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017-2019 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package apis import ( "net/http" "strings" "invent.kde.org/sysadmin/projects-api.git/models" "github.com/gin-gonic/gin" ) type projectService interface { Get(path string) (*models.Project, error) Find(filter *models.ProjectFilter) ([]string, error) List(path string) ([]string, error) } type projectResource struct { service projectService } // ServeProjectResource creates a new API resource. func ServeProjectResource(rg *gin.RouterGroup, service projectService) { r := &projectResource{service} rg.GET("/repo/*path", r.repo) rg.GET("/project/*path", r.get) rg.GET("/find", r.find) rg.GET("/projects", r.projects) rg.GET("/projects/*path", r.projects) } /** * @apiDefine ProjectSuccessExample * @apiSuccessExample {json} Success-Response: * { * "i18n": { * "stable": "none", * "stableKF5": "krita/3.1", * "trunk": "none", * "trunkKF5": "master", * "component": "calligra" * }, * "repo": "krita" * "path": "calligra/krita" * } */ /** * @api {get} /project/:path Get (by Project) * * @apiVersion 1.0.0 * @apiGroup Project * @apiName project * * @apiDescription Gets the metadata of the project identified by path. * * @apiUse ProjectSuccessExample * * @apiError Forbidden Path may not be accessed. */ func (r *projectResource) get(c *gin.Context) { path := strings.TrimLeft(c.Param("path"), "/") if strings.Contains(path, "/..") || strings.Contains(path, "../") { c.AbortWithStatus(http.StatusForbidden) return } response, err := r.service.Get(path) if err != nil { panic(err) } if response == nil { c.AbortWithStatus(http.StatusNotFound) return } c.JSON(http.StatusOK, response) } /** * @apiDeprecated use the /project endpoint. Since the gitlab migration the * repo path and the project path are the same. * @api {get} /repo/:path Get (by Repository) * @apiParam {String} path Repository path as seen in git clone kde:path/is/this. * * @apiVersion 1.0.0 * @apiGroup Project * @apiName repo * * @apiDescription Gets the metadata of the project identified by a query. * * @apiUse ProjectSuccessExample * * @apiError NotFound Couldn't find a project associated with this repo. * @apiError MultipleChoices Couldn't find a unique project for this repo. * You'll need to pick a project and get it via the /project/ * endpoint * @apiErrorExample {json} MultipleChoices-Response: * [ * "books/kf5book", * "books/kf5book-duplcate" * ] */ func (r *projectResource) repo(c *gin.Context) { path := strings.TrimLeft(c.Param("path"), "/") matches, err := r.service.Find(&models.ProjectFilter{RepoPath: path}) if err != nil { panic(err) } if len(matches) < 1 { c.AbortWithStatus(http.StatusNotFound) return } if len(matches) > 1 { c.JSON(http.StatusMultipleChoices, matches) return } response, err := r.service.Get(matches[0]) if err != nil { panic(err) } c.JSON(http.StatusOK, response) } /** * @api {get} /find Find * @apiParam {String} i18n_component I18n component of the project to find. * Since the gitlab transition this acts as unique project identifier. * This is the i18n{component:foo} value returned by the /project endpoint. * @apiParam {String} repo repo attribute of the project * to find. * @apiParam {Bool} active Whether to find only projects marked active (inactive * projects can be skipped by code that wants to iterate worthwhile code * projects only e.g. sysadmin repos are usually inactive). * This defaults to false, giving you all repos. * @apiParam {Bool} inactive Whether to find only inactive projects (see active) * This defaults to false, giving you all repos. * @apiParam {String} id Basename of the project to find. Since the gitlab * migration this filter doesn't have much purpose since the basenames are * not unique. Do not assume that you'll get a unique result when using this * filter! * * @apiVersion 1.0.0 * @apiGroup Project * @apiName find * * @apiDescription Finds matching projects by a combination of filter params or * none to list all projects. * * @apiError NotFound Nothing matched the filter criteria * * @apiSuccessExample {json} Success-Response: * [ * "books", * "books/kf5book", * "calligra", * ... * ] */ func (r *projectResource) find(c *gin.Context) { var filter models.ProjectFilter c.BindQuery(&filter) matches, err := r.service.Find(&filter) if len(matches) == 0 || err != nil { c.AbortWithStatus(http.StatusNotFound) return } c.JSON(http.StatusOK, matches) } /** * @api {get} /projects/:prefix List * @apiParam {String} prefix Prefix path of the project. This will usually be * the module/components the project is sorted under. * * @apiVersion 1.0.0 * @apiGroup Project * @apiName projects * * @apiDescription Lists all *projects* underneath the prefix. If the prefix is * a project itself it will be included in the list. If the prefix is not a * project only its "children" will be returned. * * @apiSuccessExample {json} Project (/projects/calligra/krita): * [ * "calligra/krita" * ] * * @apiSuccessExample {json} Project with Children (/projects/papa): * [ * "aba", * "aba/bubbale1", * "aba/bubbale2" * ] * * @apiSuccessExample {json} Component (/projects/frameworks) * [ * "frameworks/solid", * "frameworks/ki18n", * "..." * ] */ func (r *projectResource) projects(c *gin.Context) { path := strings.TrimLeft(c.Param("path"), "/") matches, err := r.service.List(path) if len(matches) == 0 || err != nil { c.AbortWithStatus(http.StatusNotFound) return } c.JSON(http.StatusOK, matches) } diff --git a/apis/project_test.go b/apis/project_test.go index 04c1474..1332e83 100644 --- a/apis/project_test.go +++ b/apis/project_test.go @@ -1,99 +1,82 @@ -/* - Copyright © 2017-2019 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017-2019 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package apis import ( "errors" "net/http" "testing" "invent.kde.org/sysadmin/projects-api.git/models" ) // Test Double type ProjectService struct { } func NewProjectService() *ProjectService { return &ProjectService{} } func (s *ProjectService) Get(path string) (*models.Project, error) { project := models.Project{} if path == "calligra/krita" { project.Path = "calligra/krita" project.Repo = "krita" return &project, nil } if path == "calligra" { return nil, nil } return &project, errors.New("unexpected path " + path) } func (s *ProjectService) Find(filter *models.ProjectFilter) ([]string, error) { projects := []string{"calligra/krita"} if filter.ID == "krita" && filter.RepoPath == "" { return projects, nil } if filter.ID == "" && filter.RepoPath == "krita" { return projects, nil } if filter.ID == "" && filter.InactiveOnly { return []string{"kde/hole"}, nil } if filter.ID == "" && filter.RepoPath == "" { return append(projects, "frameworks/solid"), nil } panic("unexpected query " + filter.ID + " " + filter.RepoPath) } func (s *ProjectService) List(path string) ([]string, error) { if path == "" { return []string{"calligra/krita", "frameworks/solid"}, nil } if path == "calligra" { return []string{"calligra/krita"}, nil } panic("unexpected query " + path) } func init() { v1 := router.Group("/v1") { ServeProjectResource(v1, NewProjectService()) } } func TestProject(t *testing.T) { kritaObj := `{"i18n":{"trunkKF5":"", "component":"", "stable":"", "stableKF5":"", "trunk":""}, "repo":"krita", "path":"calligra/krita"}` runAPITests(t, []apiTestCase{ {"get a project", "GET", "/v1/project/calligra/krita", "", http.StatusOK, kritaObj}, {"get nil project", "GET", "/v1/project/calligra", "", http.StatusNotFound, ""}, {"get by repopath", "GET", "/v1/repo/krita", "", http.StatusOK, kritaObj}, {"find by id", "GET", "/v1/find?id=krita", "", http.StatusOK, `["calligra/krita"]`}, {"find by repopath", "GET", "/v1/find?repo=krita", "", http.StatusOK, `["calligra/krita"]`}, {"find by only inactive", "GET", "/v1/find?inactive=true", "", http.StatusOK, `["kde/hole"]`}, {"find all", "GET", "/v1/find", "", http.StatusOK, `["calligra/krita", "frameworks/solid"]`}, {"list", "GET", "/v1/projects", "", http.StatusOK, `["calligra/krita", "frameworks/solid"]`}, {"list component", "GET", "/v1/projects/calligra", "", http.StatusOK, `["calligra/krita"]`}, }) } diff --git a/daos/git.go b/daos/git.go index 5f1806b..268bcee 100644 --- a/daos/git.go +++ b/daos/git.go @@ -1,334 +1,317 @@ -/* - Copyright © 2017 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package daos import ( "encoding/json" "fmt" "io/ioutil" "os" "os/exec" "path/filepath" "sync" "time" "invent.kde.org/sysadmin/projects-api.git/models" "github.com/danwakefield/fnmatch" "gopkg.in/yaml.v2" ) type i18nDefaultsData []map[string]models.I18nData type _Cache struct { path map[string]*models.Project list []string i18nDefaults i18nDefaultsData mutex sync.RWMutex } func (c *_Cache) Reset() { defer c.Locker()() fmt.Println("RESET CACHE") c.path = map[string]*models.Project{} c.list = []string{} c.i18nDefaults = i18nDefaultsData{} } func (c *_Cache) RLocker() func() { c.mutex.RLock() return func() { c.mutex.RUnlock() } } func (c *_Cache) Locker() func() { c.mutex.Lock() return func() { c.mutex.Unlock() } } func (c *_Cache) Project(path string) *models.Project { defer c.RLocker()() return c.path[path] } func (c *_Cache) AddProject(path string, project *models.Project) { defer c.Locker()() c.path[path] = project } func (c *_Cache) List() []string { defer c.RLocker()() return c.list } func (c *_Cache) SetList(list []string) { defer c.Locker()() c.list = list } func (c *_Cache) I18nDefaults() i18nDefaultsData { defer c.RLocker()() return c.i18nDefaults } func (c *_Cache) SetI18nDefaults(i18nDefaults i18nDefaultsData) { defer c.Locker()() c.i18nDefaults = i18nDefaults } // GitDAO is a wrapper around repo-metadata git repo. type GitDAO struct { cache _Cache revSHA string lastPoll time.Time updateMutex sync.Mutex } // NewGitDAO creates a new data access object for the repo-metadata git repo. func NewGitDAO() *GitDAO { return newGitDAOInternal(true) } func newGitDAOInternal(autoUpdate bool) *GitDAO { dao := &GitDAO{} dao.maybeResetCache() // Always true here ;) if !autoUpdate { return dao } updateTicker := time.NewTicker(4 * time.Minute) go func() { for { dao.UpdateClone() <-updateTicker.C } }() return dao } // ResetCache resets internal caching. func (dao *GitDAO) ResetCache() { dao.cache.Reset() } func (dao *GitDAO) revParse() (string, error) { cmd := exec.Command("git", "rev-parse", "--verify", "HEAD") cmd.Dir = "repo-metadata" stdoutStderr, err := cmd.CombinedOutput() if err != nil { return "", err } return string(stdoutStderr), nil } func (dao *GitDAO) maybeResetCache() { sha, err := dao.revParse() if err != nil { dao.ResetCache() return } if sha != dao.revSHA { dao.revSHA = sha dao.ResetCache() } } // UpdateClone clones (if applicable), pulls, restes caches (if applicable). func (dao *GitDAO) UpdateClone() string { dao.updateMutex.Lock() // Make sure we have consistent rev values. defer dao.updateMutex.Unlock() dao.lastPoll = time.Now() dao.revSHA, _ = dao.revParse() // So we definitely know where we were at. dao.clone() ret := dao.update() dao.maybeResetCache() return ret } // Age returns the age of the underlying repository (time since last poll) func (dao *GitDAO) Age() time.Duration { return time.Since(dao.lastPoll) } // Get returns a new Project entity. Either from cache or from the data layer. func (dao *GitDAO) Get(path string) (*models.Project, error) { if path[0] == '/' { panic("expect path to NOT start with slash") } project := dao.cache.Project(path) if project != nil { return project, nil } project, err := dao.newProject(path) if err == nil { // TODO: maybe should cache pointers, foot print small enough to not matter // really, but deep copy runtime implications are meh. dao.cache.AddProject(path, project) } return project, err } func isEntity(path string) bool { _, err := os.Stat(path + "/metadata.yaml") return err == nil } func (dao *GitDAO) List() []string { if len(dao.cache.List()) <= 0 { dao.cache.SetList(dao.list()) } return dao.cache.List() } func (dao *GitDAO) list() []string { matches := []string{} filepath.Walk("repo-metadata/projects/", func(path string, info os.FileInfo, err error) error { if err != nil { panic(err) } if info.IsDir() && isEntity(path) { rel, err := filepath.Rel("repo-metadata/projects/", path) if err != nil { panic(err) } matches = append(matches, rel) } return nil }) return matches } func (dao *GitDAO) i18nDefaults() i18nDefaultsData { if len(dao.cache.I18nDefaults()) <= 0 { dao.cache.SetI18nDefaults(dao.i18nDefaultsLoad()) } return dao.cache.I18nDefaults() } func (dao *GitDAO) i18nDefaultsLoad() i18nDefaultsData { obj := i18nDefaultsData{} // NOTE: Documentation of repo-metadata says the entires in the json must // be ordered so we'll rely on this here. // Ruby implicitly preserves key order when parsing objects, use it to parse // and then convert to actually ordered array of objects. cmd := exec.Command("ruby", "-e", ` require 'json' hash = JSON.parse(File.read('repo-metadata/config/i18n_defaults.json')) puts JSON.dump(hash.map {|k,v| { k => v } }) `) stdoutStderr, err := cmd.CombinedOutput() if err != nil { panic(err) } err = json.Unmarshal(stdoutStderr, &obj) if err != nil { panic(err) } // err = json.NewDecoder(i18nFile).Decode(&obj) return obj } func (dao *GitDAO) newProject(path string) (*models.Project, error) { data, err := ioutil.ReadFile("repo-metadata/projects/" + path + "/metadata.yaml") if err != nil { return nil, err } var project models.Project if err = yaml.Unmarshal([]byte(data), &project); err != nil { panic(err) } if project.Repo == "" { return nil, nil } // TODO: cache the bloody defaults // First use default values foundDefault := false for _, rule := range dao.i18nDefaults() { for pattern, values := range rule { if !fnmatch.Match(pattern, path, 0) { continue } project.I18n = values foundDefault = true break } if foundDefault { break } } // Then patch sepcific project data in if available. This cascades the // attributes, e.g. if there's x and y in the defaults, the specific data may // specify only y to override y but leave x at the default. i18nFile, err := os.Open("repo-metadata/projects/" + path + "/i18n.json") if err == nil { // Components and the like have no i18n data. var overrideData models.I18nData if err = json.NewDecoder(i18nFile).Decode(&overrideData); err != nil { panic(err) } project.I18n.Merge(overrideData) } project.I18n.Infer(&project) // TODO: not cascading urls_gitrepo or urls_webaccess, useless. // This data patching is too depressing for me. return &project, nil } func (dao *GitDAO) clone() { _, err := os.Stat("repo-metadata") if err == nil { return // exists already } cmd := exec.Command("git", "clone", "--depth=1", "https://anongit.kde.org/sysadmin/repo-metadata.git") stdoutStderr, err := cmd.CombinedOutput() if err != nil { fmt.Println(string(stdoutStderr)) panic(err) } } func (dao *GitDAO) update() string { cmd := exec.Command("git", "pull") cmd.Dir = "repo-metadata" stdoutStderr, err := cmd.CombinedOutput() if err != nil { panic(err) } return string(stdoutStderr) } diff --git a/daos/git_test.go b/daos/git_test.go index 8760fc4..45c0496 100644 --- a/daos/git_test.go +++ b/daos/git_test.go @@ -1,102 +1,85 @@ -/* - Copyright © 2017-2019 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017-2019 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package daos import ( "fmt" "io/ioutil" "os" "testing" "github.com/stretchr/testify/assert" ) // Shared dao so tests don't clone over and over again (implies that // TestGitUpdateClone is working ;)) var dao = newGitDAOInternal(false) func TestGitUpdateClone(t *testing.T) { tmpdir, _ := ioutil.TempDir("", "") twd, _ := os.Getwd() twd = twd + "/" os.Chdir(tmpdir) defer func() { os.Chdir(twd) os.RemoveAll(tmpdir) }() // DO NOT MUTATE TWD BELOW! // No clone pwd, _ := os.Getwd() fmt.Println(pwd) _, err := os.Stat("repo-metadata") assert.Error(t, err) cloneDAO := newGitDAOInternal(false) cloneDAO.UpdateClone() // Clone now pwd, _ = os.Getwd() fmt.Println(pwd) _, err = os.Stat("repo-metadata") assert.NoError(t, err) } func TestGitGet(t *testing.T) { project, err := dao.Get("frameworks/solid") assert.NoError(t, err) assert.NotNil(t, project) assert.Equal(t, "frameworks/solid", project.Path) assert.Equal(t, "solid", project.Repo) assert.Equal(t, "master", project.I18n.TrunkKF5) assert.Equal(t, "none", project.I18n.StableKF5) assert.Equal(t, true, project.Active) } func TestGitGetComponent(t *testing.T) { project, err := dao.Get("frameworks") assert.NoError(t, err) assert.Nil(t, project) } func TestGitList(t *testing.T) { // We work on live data, so we can't assert much here. Other than list not // being empty. assert.NotEmpty(t, dao.List()) } func TestMain(m *testing.M) { tmpdir, _ := ioutil.TempDir("", "") twd, _ := os.Getwd() twd = twd + "/" os.Chdir(tmpdir) defer func() { os.Chdir(twd) os.RemoveAll(tmpdir) }() // DO NOT MUTATE TWD BELOW! dao.UpdateClone() os.Exit(m.Run()) } diff --git a/deploy.rb b/deploy.rb index 1d2b942..0bea7da 100644 --- a/deploy.rb +++ b/deploy.rb @@ -1,60 +1,45 @@ #!/usr/bin/env ruby # frozen_string_literal: true -# -# Copyright (C) 2016-2017 Harald Sitter -# -# 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 any later version accepted by the membership of -# KDE e.V. (or its successor approved by the membership of KDE -# e.V.), which shall act as a proxy defined in Section 14 of -# version 3 of the license. -# -# 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 . + +# SPDX-FileCopyrightText: 2016-2017 Harald Sitter +# SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL require 'net/ssh' bin = 'projects-api' service = 'projects-kde-org-api' user = 'projectsadmin' host = 'mason.kde.org' home = "/home/#{user}" path = "#{home}/api/" binpath = "#{path}/bin/" systemd = "#{home}/.config/systemd/user" system('go', 'build', '-v', '-o', bin) || raise system('ssh', "#{user}@#{host}", "mkdir -p #{path}") || raise system('rsync', '-av', '--progress', '-e', 'ssh', bin, "#{user}@#{host}:#{binpath}") || raise system('ssh', "#{user}@#{host}", "mkdir -p #{home}/.config/systemd/user") || raise system('rsync', '-av', '--progress', '-e', 'ssh', "systemd/#{service}.service", "#{user}@#{host}:#{systemd}") || raise system('rsync', '-av', '--progress', '-e', 'ssh', "systemd/#{service}.socket", "#{user}@#{host}:#{systemd}") || raise system('ssh', "#{user}@#{host}", 'systemctl --user daemon-reload') || raise system('ssh', "#{user}@#{host}", "systemctl --user stop #{service}.service") || raise system('ssh', "#{user}@#{host}", "systemctl --user restart #{service}.socket") || raise # optional, exit if docs fail system('make', 'doc') || exit system('rsync', '-avz', '--progress', '-e', 'ssh', 'doc', "#{user}@#{host}:#{path}/") diff --git a/main.go b/main.go index dbcc453..286c44f 100644 --- a/main.go +++ b/main.go @@ -1,100 +1,83 @@ -/* - Copyright © 2017 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package main import ( "context" "flag" "fmt" "log" "net/http" "os" "os/signal" "syscall" "time" "invent.kde.org/sysadmin/projects-api.git/apis" "invent.kde.org/sysadmin/projects-api.git/daos" "invent.kde.org/sysadmin/projects-api.git/services" "github.com/coreos/go-systemd/activation" "github.com/gin-gonic/gin" ) func main() { flag.Parse() fmt.Println("Ready to rumble...") router := gin.Default() router.GET("/", func(c *gin.Context) { c.Redirect(http.StatusMovedPermanently, "http://"+c.Request.Host+"/doc") }) router.StaticFS("/doc", http.Dir("doc")) router.GET("/ping", func(c *gin.Context) { c.String(http.StatusOK, "OK") }) v1 := router.Group("/v1") { gitDAO := daos.NewGitDAO() apis.ServeGitResource(v1, services.NewGitService(gitDAO)) apis.ServeProjectResource(v1, services.NewProjectService(gitDAO)) } listeners, err := activation.Listeners() if err != nil { panic(err) } log.Println("starting servers") var servers []*http.Server for _, listener := range listeners { server := &http.Server{Handler: router} go server.Serve(listener) servers = append(servers, server) } quit := make(chan os.Signal, 1) signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT) // Wait for some quit cause. // This could be INT, TERM, QUIT or the db update trigger. // We'll then do a zero downtime shutdown. // This relies on systemd managing the socket and us doing graceful listener // shutdown. Once we are no longer listening, the system starts backlogging // the socket until we get restarted and listen again. // Ideally this results in zero dropped connections. <-quit log.Println("servers are shutting down") for _, srv := range servers { ctx, cancel := context.WithTimeout(context.Background(), 4*time.Second) defer cancel() srv.SetKeepAlivesEnabled(false) if err := srv.Shutdown(ctx); err != nil { log.Fatalf("Server Shutdown: %s", err) } } log.Println("Server exiting") } diff --git a/models/i18n.go b/models/i18n.go index 395798e..e508b99 100644 --- a/models/i18n.go +++ b/models/i18n.go @@ -1,158 +1,141 @@ -/* - Copyright © 2017 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017-2020 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package models import ( "encoding/json" "strings" ) // I18nInputData is an auxiliary struct used to unmarshal the input data from // disk which uses snake_case in its json representation. This struct should // not be used directly, it is used by UnmarshalJSON whilst working with // a I18nData. I18nData's UnmarshalJSON should be kept in sync with // new fields here! type i18nInputData struct { Stable string `json:"stable"` StableKF5 string `json:"stable_kf5"` Trunk string `json:"trunk"` TrunkKF5 string `json:"trunk_kf5"` } // I18nData represents I18n relevant data. type I18nData struct { Stable string `json:"stable"` StableKF5 string `json:"stableKF5"` Trunk string `json:"trunk"` TrunkKF5 string `json:"trunkKF5"` // Custom fields not found in input data. Calculated by us. Component string `json:"component"` } // Merge merges another i18nData into this i18nData. The other's values always // override unless they are empty. func (i *I18nData) Merge(o I18nData) { if o.Stable != "" { i.Stable = o.Stable } if o.StableKF5 != "" { i.StableKF5 = o.StableKF5 } if o.Trunk != "" { i.Trunk = o.Trunk } if o.TrunkKF5 != "" { i.TrunkKF5 = o.TrunkKF5 } } // Infer infers additional properties of I18nData from its Project. func (i *I18nData) Infer(project *Project) { if project.Identifier != "" { // With the move to gitlab we have a new identifier that is used as // k18n component (and is now per-repo). This replaces the shoddy // inference from before. i.Component = project.Identifier return } if project.Repo == "" { return } // Component inference is ported over from releaseme. // Break the full project path down into parts and mangle them until // we get the path under which this project would appear in SVN. parts := strings.Split(project.Path, "/") dropLimit := 2 // Start off with stripping the leading kde/. if parts[0] == "kde" && parts[1] != "workspace" { // Everything but kde/workspace is flattend without the kde part. // kde/workspace on the other hand is kde-workspace. // So, for everything but workspace, drop the kde part. // [kde,workspace] => same // [kde,kdepim-runtime] => [kdepim-runtime] // [kde,kdegraphics,libs] => [kdegraphics,libs] parts = parts[1:] // Shrink the drop limit. When we dropped kde/ we'll effectively have // removed the original assumption of there being two elements to join // as we already removed the first element. Workspace is the best example // of this fact as it is kde-workspace even though pim isn't kde-pim. // That is also why it needs special treatment. dropLimit = 1 } else if parts[0] == "kdesupport" && parts[1] == "phonon" && len(parts) >= 3 { // For phonon the correct mapping rules are not correct as per SVN // r1545471. // It has a nested structure, but this is flattened for i18n. // To mimic this we'll kdesupport/phonon/phonon => kdesupport/phonon // which results in the correct i18n path "/kdesupport/". parts = append(parts[:1], parts[2:]...) dropLimit = 1 } // Ditch last part as that is our name. But only if we in fact have more // parts. Otherwise the last part is the i18n_path of a flat // component. e.g. kdepim-runtime is a component AND the project. if len(parts) > 1 { parts = parts[:len(parts)-1] } // Reduce the path down to 2-1 parts at the most to strip subprojects // [calligra] => same // [frameworks] => same // [workspace] => same // [kdepim-runtime] => same // [kdegraphics,libs] => [kdegraphics] (drop limit was 1) // [extragear,utils,telepathy] => [extragear,utils] (drop limit was 2) for len(parts) > dropLimit { parts = parts[:len(parts)-1] } // The remainder is between 1 and 2 parts long which we'll join to get // the i18n path. // [calligra] => 'calligra' // [frameworks] => 'frameworks' // [kde,workspace] => 'kde-workspace' // [kdepim-runtime] => 'kdepim-runtime' // [kdegraphics] => 'kdegraphics' // [extragear,utils] => 'extragear-utils' i.Component = strings.Join(parts, "-") } // UnmarshalJSON unmarshals the input snake_case attributes into our struct // which will marshal to CamelCase upon output via encoding tags. func (i *I18nData) UnmarshalJSON(data []byte) error { // This would be oh-so unnecessary if the de/encoder simply allowed specifying // an arbitrary tag instead of json so one could use two distinct tags for // input and output -.- m := i18nInputData{} if err := json.Unmarshal(data, &m); err != nil { return err } i.Stable = m.Stable i.StableKF5 = m.StableKF5 i.Trunk = m.Trunk i.TrunkKF5 = m.TrunkKF5 return nil } diff --git a/models/i18n_test.go b/models/i18n_test.go index 989cd8c..c0cbcfc 100644 --- a/models/i18n_test.go +++ b/models/i18n_test.go @@ -1,78 +1,61 @@ -/* - Copyright © 2017 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017-2020 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package models import ( "path/filepath" "testing" "github.com/stretchr/testify/assert" ) func TestInfer(t *testing.T) { // Testing component inference. Given the infer function a project should // correctly infer the i18n component from the available information. cases := []struct { path string component string }{ {"calligra/krita", "calligra"}, {"kde/workspace/plasma-workspace", "kde-workspace"}, {"kde/kdemultimedia/dragon", "kdemultimedia"}, {"frameworks/solid", "frameworks"}, {"extragear/utils/telepathy/fishy", "extragear-utils"}, // Make sure i18n_path of modules that are also projects get properly // constructed. // https://bugs.kde.org/show_bug.cgi?id=379164 {"kde/kdepim-runtime", "kdepim-runtime"}, // Make sure i18n_path of modules that are inside projects on a third level // nested get properly constructed. // https://bugs.kde.org/show_bug.cgi?id=379161 {"kde/kdegraphics/libs/libksane", "kdegraphics"}, // Phonon does not follow the general rule, it's nested in the project // structure but flattened in i18n. {"kdesupport/phonon/phonon-vlc", "kdesupport"}, // ... in case it gets flattened in project structure as well, let's // ensure it will behave correctly still. {"kdesupport/phonon", "kdesupport"}, } for _, testCase := range cases { t.Run(testCase.path, func(t *testing.T) { i := I18nData{} p := Project{Path: testCase.path, Repo: filepath.Base(testCase.path)} i.Infer(&p) assert.Equal(t, testCase.component, i.Component) }) } } func testInferIdentifier(t *testing.T) { // Not actually an inference. If the Project has an Identifier set, it's the // component since the gitlab transition. i := I18nData{} p := Project{ Path: "kdesupport/phonon", Repo: "kdesupport/phonon", Identifier: "foobar", } i.Infer(&p) assert.Equal(t, "foobar", i.Component) } diff --git a/models/project.go b/models/project.go index 75a2f8c..488f163 100644 --- a/models/project.go +++ b/models/project.go @@ -1,30 +1,13 @@ -/* - Copyright © 2017-2019 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017-2020 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package models // Project is the core model of a project entity. type Project struct { I18n I18nData `yaml:"i18n" json:"i18n"` Path string `yaml:"projectpath" json:"path"` Repo string `yaml:"repopath" json:"repo"` Active bool `yaml:"repoactive" json:"-"` // do not marshal to json, we presently have no use case for it Identifier string `yaml:"identifier" json:"-"` // marshal'd via I18nData } diff --git a/models/project_filter.go b/models/project_filter.go index ce5ee7c..a2d2aba 100644 --- a/models/project_filter.go +++ b/models/project_filter.go @@ -1,32 +1,15 @@ -/* - Copyright © 2019-2020 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017-2020 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package models // ProjectFilter is used to filter projects on find() calls. // The type(names) in this struct must be chosen so that an uninitialized // filter results in match-all behavior! type ProjectFilter struct { ID string `form:"id"` // basename of project path RepoPath string `form:"repo"` // complete repo path ActiveOnly bool `form:"active"` // whether to select active projects InactiveOnly bool `form:"inactive"` // whether to select inactive projects I18nComponent string `form:"i18n_component"` // the i18n component (aka identifier) } diff --git a/services/git.go b/services/git.go index 51ab393..90dd735 100644 --- a/services/git.go +++ b/services/git.go @@ -1,50 +1,33 @@ -/* - Copyright © 2017 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package services import ( "time" "invent.kde.org/sysadmin/projects-api.git/models" ) type gitDAO interface { UpdateClone() string Age() time.Duration Get(path string) (*models.Project, error) List() []string } type GitService struct { dao gitDAO } func NewGitService(dao gitDAO) *GitService { return &GitService{dao} } func (s *GitService) UpdateClone() string { return s.dao.UpdateClone() } func (s *GitService) Age() time.Duration { return s.dao.Age() } diff --git a/services/project.go b/services/project.go index 9769b9c..e8e0e2c 100644 --- a/services/project.go +++ b/services/project.go @@ -1,97 +1,80 @@ -/* - Copyright © 2017-2020 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017-2020 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package services import ( "path/filepath" "strings" "invent.kde.org/sysadmin/projects-api.git/models" ) type ProjectService struct { dao gitDAO } func NewProjectService(dao gitDAO) *ProjectService { return &ProjectService{dao} } func (s *ProjectService) Get(path string) (*models.Project, error) { return s.dao.Get(path) } func (s *ProjectService) isProject(path string) bool { model, err := s.Get(path) if err != nil { panic(err) } return model != nil && model.Repo != "" } func (s *ProjectService) Find(filter *models.ProjectFilter) ([]string, error) { matches := []string{} for _, path := range s.dao.List() { if !s.isProject(path) { continue } if len(filter.ID) != 0 && filter.ID != filepath.Base(path) { continue } model, _ := s.Get(path) if len(filter.RepoPath) != 0 { if model.Repo != filter.RepoPath { continue // doesn't match repopath constraint } } if filter.ActiveOnly && !model.Active { continue } if filter.InactiveOnly && model.Active { continue } if len(filter.I18nComponent) != 0 && filter.I18nComponent != model.Identifier { continue } matches = append(matches, path) } return matches, nil } func (s *ProjectService) List(prefix string) ([]string, error) { matches := []string{} for _, path := range s.dao.List() { if !s.isProject(path) { continue } if len(prefix) == 0 || path == prefix || strings.HasPrefix(path, prefix+"/") { matches = append(matches, path) } } return matches, nil } diff --git a/services/project_test.go b/services/project_test.go index ebbd764..f6f7eca 100644 --- a/services/project_test.go +++ b/services/project_test.go @@ -1,124 +1,107 @@ -/* - Copyright © 2017-2019 Harald Sitter - - 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 any later version accepted by the membership of - KDE e.V. (or its successor approved by the membership of KDE - e.V.), which shall act as a proxy defined in Section 14 of - version 3 of the license. - - 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 . -*/ +// SPDX-FileCopyrightText: 2017-2019 Harald Sitter +// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL package services import ( "testing" "time" "invent.kde.org/sysadmin/projects-api.git/models" "github.com/stretchr/testify/assert" ) type GitDAO struct { } func NewGitDAO() *GitDAO { return &GitDAO{} } func (d *GitDAO) Age() time.Duration { return 0 } func (d *GitDAO) Get(path string) (*models.Project, error) { if path == "calligra/krita" { return &models.Project{ Repo: "kritarepo", }, nil } if path == "calligra/krita-extensions/krita-analogies" { return &models.Project{ Repo: "krita-analogiesrepo", Active: true, }, nil } if path == "frameworks/solid" { return &models.Project{ Repo: "solidrepo", }, nil } if path == "calligra" { return nil, nil } panic("unknown path requested " + path) } func (d *GitDAO) List() []string { return []string{"calligra", "calligra/krita", "calligra/krita-extensions/krita-analogies", "frameworks/solid"} } func (d *GitDAO) UpdateClone() string { return "" } func TestProjectFind(t *testing.T) { s := NewProjectService(NewGitDAO()) t.Run("no filter", func(t *testing.T) { ret, err := s.Find(&models.ProjectFilter{}) assert.NoError(t, err) assert.Equal(t, []string{"calligra/krita", "calligra/krita-extensions/krita-analogies", "frameworks/solid"}, ret) }) t.Run("filter by id", func(t *testing.T) { ret, err := s.Find(&models.ProjectFilter{ID: "krita"}) assert.NoError(t, err) assert.Equal(t, []string{"calligra/krita"}, ret) }) t.Run("filter by repo", func(t *testing.T) { ret, err := s.Find(&models.ProjectFilter{RepoPath: "kritarepo"}) assert.NoError(t, err) assert.Equal(t, []string{"calligra/krita"}, ret) }) t.Run("filter by active", func(t *testing.T) { ret, err := s.Find(&models.ProjectFilter{ActiveOnly: true}) assert.NoError(t, err) assert.Equal(t, []string{"calligra/krita-extensions/krita-analogies"}, ret) }) } func TestProjectList(t *testing.T) { s := NewProjectService(NewGitDAO()) t.Run("root", func(t *testing.T) { ret, err := s.List("") assert.NoError(t, err) assert.Equal(t, []string{"calligra/krita", "calligra/krita-extensions/krita-analogies", "frameworks/solid"}, ret) }) t.Run("component", func(t *testing.T) { ret, err := s.List("calligra") assert.NoError(t, err) assert.Equal(t, []string{"calligra/krita", "calligra/krita-extensions/krita-analogies"}, ret) }) t.Run("project", func(t *testing.T) { ret, err := s.List("calligra/krita") assert.NoError(t, err) // This must not include krita-extensions as it is not a child, it happens // to have the same stringy prefix though. assert.Equal(t, []string{"calligra/krita"}, ret) }) }