diff --git a/LICENSE b/LICENSE index a5fcacc9..0ad25db4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,202 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + Preamble - 1. Definitions. + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. + 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. - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). + The precise terms and conditions for copying, distribution and +modification follow. - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. + TERMS AND CONDITIONS - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." + 0. Definitions. - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. + "This License" refers to version 3 of the GNU Affero General Public License. - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. + "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. - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: + 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) You must give any other recipients of the Work or - Derivative Works a copy of this License; and + A "covered work" means either the unmodified Program or a work based +on the Program. - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and + 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. - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and + 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. - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. + 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. - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. + 1. Source Code. - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. + 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. - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. + 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. - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. + 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. - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. + 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. - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. - END OF TERMS AND CONDITIONS + The Corresponding Source for a work in source code form is that +same work. - APPENDIX: How to apply the Apache License to your work. + 2. Basic Permissions. - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. + 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. - Copyright [2023] [Codium ltd] + 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. - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. - http://www.apache.org/licenses/LICENSE-2.0 + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. + 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md index 67fa57a7..8fcfb0d0 100644 --- a/README.md +++ b/README.md @@ -27,17 +27,6 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing -[//]: # (### [Documentation](https://qodo-merge-docs.qodo.ai/)) - -[//]: # () -[//]: # (- See the [Installation Guide](https://qodo-merge-docs.qodo.ai/installation/) for instructions on installing PR-Agent on different platforms.) - -[//]: # () -[//]: # (- See the [Usage Guide](https://qodo-merge-docs.qodo.ai/usage-guide/) for instructions on running PR-Agent tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened.) - -[//]: # () -[//]: # (- See the [Tools Guide](https://qodo-merge-docs.qodo.ai/tools/) for a detailed description of the different tools, and the available configurations for each tool.) - ## Table of Contents - [News and Updates](#news-and-updates) @@ -53,6 +42,12 @@ PR-Agent aims to help efficiently review and handle pull requests, by providing ## News and Updates +## May 17, 2025 + +- v0.29 was [released](https://github.com/qodo-ai/pr-agent/releases) +- `Qodo Merge Pull Request Benchmark` was [released](https://qodo-merge-docs.qodo.ai/pr_benchmark/). This benchmark evaluates and compares the performance of LLMs in analyzing pull request code. +- `Recent Updates and Future Roadmap` page was added to the [Qodo Merge Docs](https://qodo-merge-docs.qodo.ai/recent_updates/) + ## Apr 30, 2025 A new feature is now available in the `/improve` tool for Qodo Merge 💎 - Chat on code suggestions. @@ -69,22 +64,6 @@ New tool for Qodo Merge 💎 - `/scan_repo_discussions`. Read more about it [here](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/). -## Apr 14, 2025 - -GPT-4.1 is out. And it's quite good on coding tasks... - -https://openai.com/index/gpt-4-1/ - -image - -## March 28, 2025 - -A new version, v0.28, was released. See release notes [here](https://github.com/qodo-ai/pr-agent/releases/tag/v0.28). - -This version includes a new tool, [Help Docs](https://qodo-merge-docs.qodo.ai/tools/help_docs/), which can answer free-text questions based on a documentation folder. - -`/help_docs` is now being used to provide immediate automatic feedback to any user who [opens an issue](https://github.com/qodo-ai/pr-agent/issues/1608#issue-2897328825) on PR-Agent's open-source project - ## Overview
diff --git a/docs/docs/core-abilities/incremental_update.md b/docs/docs/core-abilities/incremental_update.md new file mode 100644 index 00000000..3813fb73 --- /dev/null +++ b/docs/docs/core-abilities/incremental_update.md @@ -0,0 +1,33 @@ +# Incremental Update 💎 + +`Supported Git Platforms: GitHub` + +## Overview +The Incremental Update feature helps users focus on feedback for their newest changes, making large PRs more manageable. + +### How it works + +=== "Update Option on Subsequent Commits" + ![code_suggestions_update](https://www.qodo.ai/images/pr_agent/inc_update_before.png){width=512} + +=== "Generation of Incremental Update" + ![code_suggestions_inc_update_result](https://www.qodo.ai/images/pr_agent/inc_update_shown.png){width=512} + +___ + +Whenever new commits are pushed following a recent code suggestions report for this PR, an Update button appears (as seen above). + +Once the user clicks on the button: + +- The `improve` tool identifies the new changes (the "delta") +- Provides suggestions on these recent changes +- Combines these suggestions with the overall PR feedback, prioritizing delta-related comments +- Marks delta-related comments with a textual indication followed by an asterisk (*) with a link to this page, so they can easily be identified + +### Benefits for Developers + +- Focus on what matters: See feedback on newest code first +- Clearer organization: Comments on recent changes are clearly marked +- Better workflow: Address feedback more systematically, starting with recent changes + + diff --git a/docs/docs/core-abilities/index.md b/docs/docs/core-abilities/index.md index 9af26e2e..b97260ee 100644 --- a/docs/docs/core-abilities/index.md +++ b/docs/docs/core-abilities/index.md @@ -8,6 +8,7 @@ Qodo Merge utilizes a variety of core abilities to provide a comprehensive and e - [Dynamic context](https://qodo-merge-docs.qodo.ai/core-abilities/dynamic_context/) - [Fetching ticket context](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) - [Impact evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) +- [Incremental Update](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update/) - [Interactivity](https://qodo-merge-docs.qodo.ai/core-abilities/interactivity/) - [Local and global metadata](https://qodo-merge-docs.qodo.ai/core-abilities/metadata/) - [RAG context enrichment](https://qodo-merge-docs.qodo.ai/core-abilities/rag_context_enrichment/) diff --git a/docs/docs/index.md b/docs/docs/index.md index 8dd7c955..79a06e5d 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -67,6 +67,7 @@ PR-Agent and Qodo Merge offers extensive pull request functionalities across var | | [Impact Evaluation](https://qodo-merge-docs.qodo.ai/core-abilities/impact_evaluation/) 💎 | ✅ | ✅ | | | | | [Code Validation 💎](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/) | ✅ | ✅ | ✅ | ✅ | | | [Auto Best Practices 💎](https://qodo-merge-docs.qodo.ai/core-abilities/auto_best_practices/) | ✅ | | | | +| | [Incremental Update 💎](https://qodo-merge-docs.qodo.ai/core-abilities/incremental_update/) | ✅ | | | | !!! note "💎 means Qodo Merge only" All along the documentation, 💎 marks a feature available only in [Qodo Merge](https://www.codium.ai/pricing/){:target="_blank"}, and not in the open-source version. diff --git a/docs/docs/installation/github.md b/docs/docs/installation/github.md index 018499ee..3eeace4f 100644 --- a/docs/docs/installation/github.md +++ b/docs/docs/installation/github.md @@ -193,9 +193,8 @@ For example: `GITHUB.WEBHOOK_SECRET` --> `GITHUB__WEBHOOK_SECRET` 3. Push image to ECR ```shell - - docker tag codiumai/pr-agent:serverless .dkr.ecr..amazonaws.com/codiumai/pr-agent:serverless - docker push .dkr.ecr..amazonaws.com/codiumai/pr-agent:serverless + docker tag codiumai/pr-agent:serverless .dkr.ecr..amazonaws.com/codiumai/pr-agent:serverless + docker push .dkr.ecr..amazonaws.com/codiumai/pr-agent:serverless ``` 4. Create a lambda function that uses the uploaded image. Set the lambda timeout to be at least 3m. diff --git a/docs/docs/recent_updates/index.md b/docs/docs/recent_updates/index.md index dc7ea8d1..158fb5ca 100644 --- a/docs/docs/recent_updates/index.md +++ b/docs/docs/recent_updates/index.md @@ -7,11 +7,11 @@ This page summarizes recent enhancements to Qodo Merge (last three months). It also outlines our development roadmap for the upcoming three months. Please note that the roadmap is subject to change, and features may be adjusted, added, or reprioritized. === "Recent Updates" + - **Qodo Merge Pull Request Benchmark** - evaluating the performance of LLMs in analyzing pull request code ([Learn more](https://qodo-merge-docs.qodo.ai/pr_benchmark/)) - **Chat on Suggestions**: Users can now chat with Qodo Merge code suggestions ([Learn more](https://qodo-merge-docs.qodo.ai/tools/improve/#chat-on-code-suggestions)) - **Scan Repo Discussions Tool**: A new tool that analyzes past code discussions to generate a `best_practices.md` file, distilling key insights and recommendations. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/scan_repo_discussions/)) - **Enhanced Models**: Qodo Merge now defaults to a combination of top models (Claude Sonnet 3.7 and Gemini 2.5 Pro) and incorporates dedicated code validation logic for improved results. ([Details 1](https://qodo-merge-docs.qodo.ai/usage-guide/qodo_merge_models/), [Details 2](https://qodo-merge-docs.qodo.ai/core-abilities/code_validation/)) - **Chrome Extension Update**: Qodo Merge Chrome extension now supports single-tenant users. ([Learn more](https://qodo-merge-docs.qodo.ai/chrome-extension/options/#configuration-options/)) - - **Help Docs Tool**: The help_docs tool can answer free-text questions based on any git documentation folder. ([Learn more](https://qodo-merge-docs.qodo.ai/tools/help_docs/)) === "Future Roadmap" - **Smart Update**: Upon PR updates, Qodo Merge will offer tailored code suggestions, addressing both the entire PR and the specific incremental changes since the last feedback. diff --git a/docs/docs/tools/documentation.md b/docs/docs/tools/documentation.md index 247d5d6d..47222f51 100644 --- a/docs/docs/tools/documentation.md +++ b/docs/docs/tools/documentation.md @@ -26,6 +26,29 @@ You can state a name of a specific component in the PR to get documentation only /add_docs component_name ``` +## Manual triggering + +Comment `/add_docs` on a PR to invoke it manually. + +## Automatic triggering + +To automatically run the `add_docs` tool when a pull request is opened, define in a [configuration file](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/): + + +```toml +[github_app] +pr_commands = [ + "/add_docs", + ... +] +``` + +The `pr_commands` list defines commands that run automatically when a PR is opened. +Since this is under the [github_app] section, it only applies when using the Qodo Merge GitHub App in GitHub environments. + +!!! note +By default, /add_docs is not triggered automatically. You must explicitly include it in pr_commands to enable this behavior. + ## Configuration options - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`. diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md index e5cc6b93..8d4a5543 100644 --- a/docs/docs/tools/review.md +++ b/docs/docs/tools/review.md @@ -70,6 +70,10 @@ extra_instructions = "..." enable_help_text If set to true, the tool will display a help text in the comment. Default is true. + + num_max_findings + Number of maximum returned findings. Default is 3. + !!! example "Enable\\disable specific sub-sections" @@ -112,7 +116,7 @@ extra_instructions = "..." enable_review_labels_effort - If set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true. + If set to true, the tool will publish a 'Review effort x/5' label (1–5 scale). Default is true. @@ -141,7 +145,7 @@ extra_instructions = "..." The `review` tool can auto-generate two specific types of labels for a PR: - a `possible security issue` label that detects if a possible [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) exists in the PR code (`enable_review_labels_security` flag) - - a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag) + - a `Review effort x/5` label, where x is the estimated effort to review the PR on a 1–5 scale (`enable_review_labels_effort` flag) Both modes are useful, and we recommended to enable them. diff --git a/docs/docs/usage-guide/additional_configurations.md b/docs/docs/usage-guide/additional_configurations.md index c345e0c6..9f9202f6 100644 --- a/docs/docs/usage-guide/additional_configurations.md +++ b/docs/docs/usage-guide/additional_configurations.md @@ -50,7 +50,7 @@ glob = ['*.py'] And to ignore Python files in all PRs using `regex` pattern, set in a configuration file: ``` -[regex] +[ignore] regex = ['.*\.py$'] ``` @@ -164,6 +164,7 @@ Qodo Merge allows you to automatically ignore certain PRs based on various crite - PRs with specific titles (using regex matching) - PRs between specific branches (using regex matching) +- PRs from specific repositories (using regex matching) - PRs not from specific folders - PRs containing specific labels - PRs opened by specific users @@ -172,7 +173,7 @@ Qodo Merge allows you to automatically ignore certain PRs based on various crite To ignore PRs with a specific title such as "[Bump]: ...", you can add the following to your `configuration.toml` file: -``` +```toml [config] ignore_pr_title = ["\\[Bump\\]"] ``` @@ -183,7 +184,7 @@ Where the `ignore_pr_title` is a list of regex patterns to match the PR title yo To ignore PRs from specific source or target branches, you can add the following to your `configuration.toml` file: -``` +```toml [config] ignore_pr_source_branches = ['develop', 'main', 'master', 'stage'] ignore_pr_target_branches = ["qa"] @@ -192,6 +193,18 @@ ignore_pr_target_branches = ["qa"] Where the `ignore_pr_source_branches` and `ignore_pr_target_branches` are lists of regex patterns to match the source and target branches you want to ignore. They are not mutually exclusive, you can use them together or separately. +### Ignoring PRs from specific repositories + +To ignore PRs from specific repositories, you can add the following to your `configuration.toml` file: + +```toml +[config] +ignore_repositories = ["my-org/my-repo1", "my-org/my-repo2"] +``` + +Where the `ignore_repositories` is a list of regex patterns to match the repositories you want to ignore. This is useful when you have multiple repositories and want to exclude certain ones from analysis. + + ### Ignoring PRs not from specific folders To allow only specific folders (often needed in large monorepos), set: diff --git a/docs/docs/usage-guide/changing_a_model.md b/docs/docs/usage-guide/changing_a_model.md index c0b2bc28..bfeb7c3a 100644 --- a/docs/docs/usage-guide/changing_a_model.md +++ b/docs/docs/usage-guide/changing_a_model.md @@ -16,6 +16,23 @@ You can give parameters via a configuration file, or from environment variables. See [litellm documentation](https://litellm.vercel.app/docs/proxy/quick_start#supported-llms) for the environment variables needed per model, as they may vary and change over time. Our documentation per-model may not always be up-to-date with the latest changes. Failing to set the needed keys of a specific model will usually result in litellm not identifying the model type, and failing to utilize it. +### OpenAI like API +To use an OpenAI like API, set the following in your `.secrets.toml` file: + +```toml +[openai] +api_base = "https://api.openai.com/v1" +api_key = "sk-..." +``` + +or use the environment variables (make sure to use double underscores `__`): + +```bash +OPENAI__API_BASE=https://api.openai.com/v1 +OPENAI__KEY=sk-... +``` + + ### Azure To use Azure, set in your `.secrets.toml` (working from CLI), or in the GitHub `Settings > Secrets and variables` (working from GitHub App or GitHub Action): diff --git a/docs/docs/usage-guide/configuration_options.md b/docs/docs/usage-guide/configuration_options.md index fba4bb48..f3b91031 100644 --- a/docs/docs/usage-guide/configuration_options.md +++ b/docs/docs/usage-guide/configuration_options.md @@ -1,20 +1,22 @@ -The different tools and sub-tools used by Qodo Merge are adjustable via the **[configuration file](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml)**. +The different tools and sub-tools used by Qodo Merge are adjustable via a Git configuration file. +There are three main ways to set persistent configurations: -In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L16) section in the configuration file. -See the [Tools Guide](https://qodo-merge-docs.qodo.ai/tools/) for a detailed description of the different tools and their configurations. - -There are three ways to set persistent configurations: - -1. Wiki configuration page 💎 -2. Local configuration file -3. Global configuration file 💎 +1. [Wiki](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#wiki-configuration-file) configuration page 💎 +2. [Local](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#local-configuration-file) configuration file +3. [Global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration file 💎 In terms of precedence, wiki configurations will override local configurations, and local configurations will override global configurations. -!!! tip "Tip1: edit only what you need" + +For a list of all possible configurations, see the [configuration options](https://github.com/qodo-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml/) page. +In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L16) section in the configuration file. + +!!! tip "Tip1: Edit only what you need" Your configuration file should be minimal, and edit only the relevant values. Don't copy the entire configuration options, since it can lead to legacy problems when something changes. -!!! tip "Tip2: show relevant configurations" - If you set `config.output_relevant_configurations=true`, each tool will also output in a collapsible section its relevant configurations. This can be useful for debugging, or getting to know the configurations better. +!!! tip "Tip2: Show relevant configurations" + If you set `config.output_relevant_configurations` to True, each tool will also output in a collapsible section its relevant configurations. This can be useful for debugging, or getting to know the configurations better. + + ## Wiki configuration file 💎 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8525fdee..a25c081b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -49,6 +49,7 @@ nav: - Dynamic context: 'core-abilities/dynamic_context.md' - Fetching ticket context: 'core-abilities/fetching_ticket_context.md' - Impact evaluation: 'core-abilities/impact_evaluation.md' + - Incremental Update: 'core-abilities/incremental_update.md' - Interactivity: 'core-abilities/interactivity.md' - Local and global metadata: 'core-abilities/metadata.md' - RAG context enrichment: 'core-abilities/rag_context_enrichment.md' diff --git a/pr_agent/algo/__init__.py b/pr_agent/algo/__init__.py index 8d805baf..e38bd713 100644 --- a/pr_agent/algo/__init__.py +++ b/pr_agent/algo/__init__.py @@ -58,6 +58,7 @@ MAX_TOKENS = { 'vertex_ai/claude-3-7-sonnet@20250219': 200000, 'vertex_ai/gemini-1.5-pro': 1048576, 'vertex_ai/gemini-2.5-pro-preview-03-25': 1048576, + 'vertex_ai/gemini-2.5-pro-preview-05-06': 1048576, 'vertex_ai/gemini-1.5-flash': 1048576, 'vertex_ai/gemini-2.0-flash': 1048576, 'vertex_ai/gemini-2.5-flash-preview-04-17': 1048576, @@ -66,6 +67,7 @@ MAX_TOKENS = { 'gemini/gemini-1.5-flash': 1048576, 'gemini/gemini-2.0-flash': 1048576, 'gemini/gemini-2.5-pro-preview-03-25': 1048576, + 'gemini/gemini-2.5-pro-preview-05-06': 1048576, 'codechat-bison': 6144, 'codechat-bison-32k': 32000, 'anthropic.claude-instant-v1': 100000, diff --git a/pr_agent/algo/ai_handlers/litellm_ai_handler.py b/pr_agent/algo/ai_handlers/litellm_ai_handler.py index ba4630f4..8d727b8b 100644 --- a/pr_agent/algo/ai_handlers/litellm_ai_handler.py +++ b/pr_agent/algo/ai_handlers/litellm_ai_handler.py @@ -59,6 +59,7 @@ class LiteLLMAIHandler(BaseAiHandler): litellm.api_version = get_settings().openai.api_version if get_settings().get("OPENAI.API_BASE", None): litellm.api_base = get_settings().openai.api_base + self.api_base = get_settings().openai.api_base if get_settings().get("ANTHROPIC.KEY", None): litellm.anthropic_key = get_settings().anthropic.key if get_settings().get("COHERE.KEY", None): @@ -370,12 +371,12 @@ class LiteLLMAIHandler(BaseAiHandler): get_logger().info(f"\nUser prompt:\n{user}") response = await acompletion(**kwargs) - except (openai.APIError, openai.APITimeoutError) as e: - get_logger().warning(f"Error during LLM inference: {e}") - raise except (openai.RateLimitError) as e: get_logger().error(f"Rate limit error during LLM inference: {e}") raise + except (openai.APIError, openai.APITimeoutError) as e: + get_logger().warning(f"Error during LLM inference: {e}") + raise except (Exception) as e: get_logger().warning(f"Unknown error during LLM inference: {e}") raise openai.APIError from e diff --git a/pr_agent/algo/utils.py b/pr_agent/algo/utils.py index 4a341386..780c7953 100644 --- a/pr_agent/algo/utils.py +++ b/pr_agent/algo/utils.py @@ -731,8 +731,9 @@ def try_fix_yaml(response_text: str, response_text_original="") -> dict: response_text_lines = response_text.split('\n') - keys_yaml = ['relevant line:', 'suggestion content:', 'relevant file:', 'existing code:', 'improved code:'] + keys_yaml = ['relevant line:', 'suggestion content:', 'relevant file:', 'existing code:', 'improved code:', 'label:'] keys_yaml = keys_yaml + keys_fix_yaml + # first fallback - try to convert 'relevant line: ...' to relevant line: |-\n ...' response_text_lines_copy = response_text_lines.copy() for i in range(0, len(response_text_lines_copy)): @@ -747,8 +748,29 @@ def try_fix_yaml(response_text: str, except: pass - # second fallback - try to extract only range from first ```yaml to ```` - snippet_pattern = r'```(yaml)?[\s\S]*?```' + # 1.5 fallback - try to convert '|' to '|2'. Will solve cases of indent decreasing during the code + response_text_copy = copy.deepcopy(response_text) + response_text_copy = response_text_copy.replace('|\n', '|2\n') + try: + data = yaml.safe_load(response_text_copy) + get_logger().info(f"Successfully parsed AI prediction after replacing | with |2") + return data + except: + # if it fails, we can try to add spaces to the lines that are not indented properly, and contain '}'. + response_text_lines_copy = response_text_copy.split('\n') + for i in range(0, len(response_text_lines_copy)): + initial_space = len(response_text_lines_copy[i]) - len(response_text_lines_copy[i].lstrip()) + if initial_space == 2 and '|2' not in response_text_lines_copy[i] and '}' in response_text_lines_copy[i]: + response_text_lines_copy[i] = ' ' + response_text_lines_copy[i].lstrip() + try: + data = yaml.safe_load('\n'.join(response_text_lines_copy)) + get_logger().info(f"Successfully parsed AI prediction after replacing | with |2 and adding spaces") + return data + except: + pass + + # second fallback - try to extract only range from first ```yaml to the last ``` + snippet_pattern = r'```yaml([\s\S]*?)```(?=\s*$|")' snippet = re.search(snippet_pattern, '\n'.join(response_text_lines_copy)) if not snippet: snippet = re.search(snippet_pattern, response_text_original) # before we removed the "```" @@ -803,16 +825,47 @@ def try_fix_yaml(response_text: str, except: pass - # sixth fallback - try to remove last lines - for i in range(1, len(response_text_lines)): - response_text_lines_tmp = '\n'.join(response_text_lines[:-i]) + # sixth fallback - replace tabs with spaces + if '\t' in response_text: + response_text_copy = copy.deepcopy(response_text) + response_text_copy = response_text_copy.replace('\t', ' ') try: - data = yaml.safe_load(response_text_lines_tmp) - get_logger().info(f"Successfully parsed AI prediction after removing {i} lines") + data = yaml.safe_load(response_text_copy) + get_logger().info(f"Successfully parsed AI prediction after replacing tabs with spaces") return data except: pass + # seventh fallback - add indent for sections of code blocks + response_text_copy = copy.deepcopy(response_text) + response_text_copy_lines = response_text_copy.split('\n') + start_line = -1 + for i, line in enumerate(response_text_copy_lines): + if 'existing_code:' in line or 'improved_code:' in line: + start_line = i + elif line.endswith(': |') or line.endswith(': |-') or line.endswith(': |2') or line.endswith(':'): + start_line = -1 + elif start_line != -1: + response_text_copy_lines[i] = ' ' + line + response_text_copy = '\n'.join(response_text_copy_lines) + try: + data = yaml.safe_load(response_text_copy) + get_logger().info(f"Successfully parsed AI prediction after adding indent for sections of code blocks") + return data + except: + pass + + # # sixth fallback - try to remove last lines + # for i in range(1, len(response_text_lines)): + # response_text_lines_tmp = '\n'.join(response_text_lines[:-i]) + # try: + # data = yaml.safe_load(response_text_lines_tmp) + # get_logger().info(f"Successfully parsed AI prediction after removing {i} lines") + # return data + # except: + # pass + + def set_custom_labels(variables, git_provider=None): if not get_settings().config.enable_custom_labels: diff --git a/pr_agent/git_providers/__init__.py b/pr_agent/git_providers/__init__.py index 8ee2db08..e4acfc22 100644 --- a/pr_agent/git_providers/__init__.py +++ b/pr_agent/git_providers/__init__.py @@ -12,6 +12,7 @@ from pr_agent.git_providers.gitea_provider import GiteaProvider from pr_agent.git_providers.github_provider import GithubProvider from pr_agent.git_providers.gitlab_provider import GitLabProvider from pr_agent.git_providers.local_git_provider import LocalGitProvider +from pr_agent.git_providers.gitea_provider import GiteaProvider _GIT_PROVIDERS = { 'github': GithubProvider, @@ -22,7 +23,7 @@ _GIT_PROVIDERS = { 'codecommit': CodeCommitProvider, 'local': LocalGitProvider, 'gerrit': GerritProvider, - 'gitea': GiteaProvider + 'gitea': GiteaProvider, } diff --git a/pr_agent/git_providers/azuredevops_provider.py b/pr_agent/git_providers/azuredevops_provider.py index 35165bdd..d71a029f 100644 --- a/pr_agent/git_providers/azuredevops_provider.py +++ b/pr_agent/git_providers/azuredevops_provider.py @@ -618,7 +618,7 @@ class AzureDevopsProvider(GitProvider): return pr_id except Exception as e: if get_settings().config.verbosity_level >= 2: - get_logger().info(f"Failed to get pr id, error: {e}") + get_logger().info(f"Failed to get PR id, error: {e}") return "" def publish_file_comments(self, file_comments: list) -> bool: diff --git a/pr_agent/git_providers/github_provider.py b/pr_agent/git_providers/github_provider.py index 4f3a5ec7..fa52b7dc 100644 --- a/pr_agent/git_providers/github_provider.py +++ b/pr_agent/git_providers/github_provider.py @@ -96,7 +96,7 @@ class GithubProvider(GitProvider): parsed_url = urlparse(given_url) repo_path = (parsed_url.path.split('.git')[0])[1:] # //.git -> / if not repo_path: - get_logger().error(f"url is neither an issues url nor a pr url nor a valid git url: {given_url}. Returning empty result.") + get_logger().error(f"url is neither an issues url nor a PR url nor a valid git url: {given_url}. Returning empty result.") return "" return repo_path except Exception as e: diff --git a/pr_agent/git_providers/utils.py b/pr_agent/git_providers/utils.py index 1b4232df..0cfbe116 100644 --- a/pr_agent/git_providers/utils.py +++ b/pr_agent/git_providers/utils.py @@ -6,8 +6,7 @@ from dynaconf import Dynaconf from starlette_context import context from pr_agent.config_loader import get_settings -from pr_agent.git_providers import (get_git_provider, - get_git_provider_with_context) +from pr_agent.git_providers import get_git_provider_with_context from pr_agent.log import get_logger diff --git a/pr_agent/identity_providers/identity_provider.py b/pr_agent/identity_providers/identity_provider.py index 58e5f6c6..0fdb9a37 100644 --- a/pr_agent/identity_providers/identity_provider.py +++ b/pr_agent/identity_providers/identity_provider.py @@ -10,7 +10,7 @@ class Eligibility(Enum): class IdentityProvider(ABC): @abstractmethod - def verify_eligibility(self, git_provider, git_provier_id, pr_url): + def verify_eligibility(self, git_provider, git_provider_id, pr_url): pass @abstractmethod diff --git a/pr_agent/servers/bitbucket_app.py b/pr_agent/servers/bitbucket_app.py index a641adeb..0d75d143 100644 --- a/pr_agent/servers/bitbucket_app.py +++ b/pr_agent/servers/bitbucket_app.py @@ -127,6 +127,14 @@ def should_process_pr_logic(data) -> bool: source_branch = pr_data.get("source", {}).get("branch", {}).get("name", "") target_branch = pr_data.get("destination", {}).get("branch", {}).get("name", "") sender = _get_username(data) + repo_full_name = pr_data.get("destination", {}).get("repository", {}).get("full_name", "") + + # logic to ignore PRs from specific repositories + ignore_repos = get_settings().get("CONFIG.IGNORE_REPOSITORIES", []) + if repo_full_name and ignore_repos: + if any(re.search(regex, repo_full_name) for regex in ignore_repos): + get_logger().info(f"Ignoring PR from repository '{repo_full_name}' due to 'config.ignore_repositories' setting") + return False # logic to ignore PRs from specific users ignore_pr_users = get_settings().get("CONFIG.IGNORE_PR_AUTHORS", []) diff --git a/pr_agent/servers/github_app.py b/pr_agent/servers/github_app.py index 4576bd9d..36db3c69 100644 --- a/pr_agent/servers/github_app.py +++ b/pr_agent/servers/github_app.py @@ -258,6 +258,14 @@ def should_process_pr_logic(body) -> bool: source_branch = pull_request.get("head", {}).get("ref", "") target_branch = pull_request.get("base", {}).get("ref", "") sender = body.get("sender", {}).get("login") + repo_full_name = body.get("repository", {}).get("full_name", "") + + # logic to ignore PRs from specific repositories + ignore_repos = get_settings().get("CONFIG.IGNORE_REPOSITORIES", []) + if ignore_repos and repo_full_name: + if any(re.search(regex, repo_full_name) for regex in ignore_repos): + get_logger().info(f"Ignoring PR from repository '{repo_full_name}' due to 'config.ignore_repositories' setting") + return False # logic to ignore PRs from specific users ignore_pr_users = get_settings().get("CONFIG.IGNORE_PR_AUTHORS", []) diff --git a/pr_agent/servers/gitlab_webhook.py b/pr_agent/servers/gitlab_webhook.py index 7a753c9e..af777a9a 100644 --- a/pr_agent/servers/gitlab_webhook.py +++ b/pr_agent/servers/gitlab_webhook.py @@ -113,6 +113,14 @@ def should_process_pr_logic(data) -> bool: return False title = data['object_attributes'].get('title') sender = data.get("user", {}).get("username", "") + repo_full_name = data.get('project', {}).get('path_with_namespace', "") + + # logic to ignore PRs from specific repositories + ignore_repos = get_settings().get("CONFIG.IGNORE_REPOSITORIES", []) + if ignore_repos and repo_full_name: + if any(re.search(regex, repo_full_name) for regex in ignore_repos): + get_logger().info(f"Ignoring MR from repository '{repo_full_name}' due to 'config.ignore_repositories' setting") + return False # logic to ignore PRs from specific users ignore_pr_users = get_settings().get("CONFIG.IGNORE_PR_AUTHORS", []) diff --git a/pr_agent/settings/configuration.toml b/pr_agent/settings/configuration.toml index 421ecff4..f03a5e66 100644 --- a/pr_agent/settings/configuration.toml +++ b/pr_agent/settings/configuration.toml @@ -55,6 +55,7 @@ ignore_pr_target_branches = [] # a list of regular expressions of target branche ignore_pr_source_branches = [] # a list of regular expressions of source branches to ignore from PR agent when an PR is created ignore_pr_labels = [] # labels to ignore from PR agent when an PR is created ignore_pr_authors = [] # authors to ignore from PR agent when an PR is created +ignore_repositories = [] # a list of regular expressions of repository full names (e.g. "org/repo") to ignore from PR agent processing # is_auto_command = false # will be auto-set to true if the command is triggered by an automation enable_ai_metadata = false # will enable adding ai metadata @@ -80,6 +81,7 @@ require_ticket_analysis_review=true # general options persistent_comment=true extra_instructions = "" +num_max_findings = 3 final_update_message = true # review labels enable_review_labels_security=true diff --git a/pr_agent/settings/pr_reviewer_prompts.toml b/pr_agent/settings/pr_reviewer_prompts.toml index a322b2b9..d4c0a523 100644 --- a/pr_agent/settings/pr_reviewer_prompts.toml +++ b/pr_agent/settings/pr_reviewer_prompts.toml @@ -98,7 +98,7 @@ class Review(BaseModel): {%- if question_str %} insights_from_user_answers: str = Field(description="shortly summarize the insights you gained from the user's answers to the questions") {%- endif %} - key_issues_to_review: List[KeyIssuesComponentLink] = Field("A short and diverse list (0-3 issues) of high-priority bugs, problems or performance concerns introduced in the PR code, which the PR reviewer should further focus on and validate during the review process.") + key_issues_to_review: List[KeyIssuesComponentLink] = Field("A short and diverse list (0-{{ num_max_findings }} issues) of high-priority bugs, problems or performance concerns introduced in the PR code, which the PR reviewer should further focus on and validate during the review process.") {%- if require_security_review %} security_concerns: str = Field(description="Does this PR code introduce possible vulnerabilities such as exposure of sensitive information (e.g., API keys, secrets, passwords), or security concerns like SQL injection, XSS, CSRF, and others ? Answer 'No' (without explaining why) if there are no possible issues. If there are security concerns or issues, start your answer with a short header, such as: 'Sensitive information exposure: ...', 'SQL injection: ...' etc. Explain your answer. Be specific and give examples if possible") {%- endif %} diff --git a/pr_agent/tools/pr_description.py b/pr_agent/tools/pr_description.py index 6ab13ee1..df82db67 100644 --- a/pr_agent/tools/pr_description.py +++ b/pr_agent/tools/pr_description.py @@ -199,7 +199,7 @@ class PRDescription: async def _prepare_prediction(self, model: str) -> None: if get_settings().pr_description.use_description_markers and 'pr_agent:' not in self.user_description: - get_logger().info("Markers were enabled, but user description does not contain markers. skipping AI prediction") + get_logger().info("Markers were enabled, but user description does not contain markers. Skipping AI prediction") return None large_pr_handling = get_settings().pr_description.enable_large_pr_handling and "pr_description_only_files_prompts" in get_settings() @@ -707,7 +707,7 @@ class PRDescription: pr_body += """""" except Exception as e: - get_logger().error(f"Error processing pr files to markdown {self.pr_id}: {str(e)}") + get_logger().error(f"Error processing PR files to markdown {self.pr_id}: {str(e)}") pass return pr_body, pr_comments diff --git a/pr_agent/tools/pr_reviewer.py b/pr_agent/tools/pr_reviewer.py index ff48819f..714ee867 100644 --- a/pr_agent/tools/pr_reviewer.py +++ b/pr_agent/tools/pr_reviewer.py @@ -81,6 +81,7 @@ class PRReviewer: "language": self.main_language, "diff": "", # empty diff for initial calculation "num_pr_files": self.git_provider.get_num_of_files(), + "num_max_findings": get_settings().pr_reviewer.num_max_findings, "require_score": get_settings().pr_reviewer.require_score_review, "require_tests": get_settings().pr_reviewer.require_tests_review, "require_estimate_effort_to_review": get_settings().pr_reviewer.require_estimate_effort_to_review, @@ -316,7 +317,9 @@ class PRReviewer: get_logger().exception(f"Failed to remove previous review comment, error: {e}") def _can_run_incremental_review(self) -> bool: - """Checks if we can run incremental review according the various configurations and previous review""" + """ + Checks if we can run incremental review according the various configurations and previous review. + """ # checking if running is auto mode but there are no new commits if self.is_auto and not self.incremental.first_new_commit_sha: get_logger().info(f"Incremental review is enabled for {self.pr_url} but there are no new commits") diff --git a/requirements.txt b/requirements.txt index 1038af69..5290b749 100644 --- a/requirements.txt +++ b/requirements.txt @@ -13,7 +13,7 @@ google-cloud-aiplatform==1.38.0 google-generativeai==0.8.3 google-cloud-storage==2.10.0 Jinja2==3.1.2 -litellm==1.66.3 +litellm==1.69.3 loguru==0.7.2 msrest==0.7.1 openai>=1.55.3 diff --git a/tests/e2e_tests/test_gitea_app.py b/tests/e2e_tests/test_gitea_app.py new file mode 100644 index 00000000..3a209975 --- /dev/null +++ b/tests/e2e_tests/test_gitea_app.py @@ -0,0 +1,185 @@ +import os +import time +import requests +from datetime import datetime + +from pr_agent.config_loader import get_settings +from pr_agent.log import get_logger, setup_logger +from tests.e2e_tests.e2e_utils import (FILE_PATH, + IMPROVE_START_WITH_REGEX_PATTERN, + NEW_FILE_CONTENT, NUM_MINUTES, + PR_HEADER_START_WITH, REVIEW_START_WITH) + +log_level = os.environ.get("LOG_LEVEL", "INFO") +setup_logger(log_level) +logger = get_logger() + +def test_e2e_run_gitea_app(): + repo_name = 'pr-agent-tests' + owner = 'codiumai' + base_branch = "main" + new_branch = f"gitea_app_e2e_test-{datetime.now().strftime('%Y-%m-%d-%H-%M-%S')}" + get_settings().config.git_provider = "gitea" + + headers = None + pr_number = None + + try: + gitea_url = get_settings().get("GITEA.URL", None) + gitea_token = get_settings().get("GITEA.TOKEN", None) + + if not gitea_url: + logger.error("GITEA.URL is not set in the configuration") + logger.info("Please set GITEA.URL in .env file or environment variables") + assert False, "GITEA.URL is not set in the configuration" + + if not gitea_token: + logger.error("GITEA.TOKEN is not set in the configuration") + logger.info("Please set GITEA.TOKEN in .env file or environment variables") + assert False, "GITEA.TOKEN is not set in the configuration" + + headers = { + 'Authorization': f'token {gitea_token}', + 'Content-Type': 'application/json', + 'Accept': 'application/json' + } + + logger.info(f"Creating a new branch {new_branch} from {base_branch}") + + response = requests.get( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/branches/{base_branch}", + headers=headers + ) + response.raise_for_status() + base_branch_data = response.json() + base_commit_sha = base_branch_data['commit']['id'] + + branch_data = { + 'ref': f"refs/heads/{new_branch}", + 'sha': base_commit_sha + } + response = requests.post( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/git/refs", + headers=headers, + json=branch_data + ) + response.raise_for_status() + + logger.info(f"Updating file {FILE_PATH} in branch {new_branch}") + + import base64 + file_content_encoded = base64.b64encode(NEW_FILE_CONTENT.encode()).decode() + + try: + response = requests.get( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/contents/{FILE_PATH}?ref={new_branch}", + headers=headers + ) + response.raise_for_status() + existing_file = response.json() + file_sha = existing_file.get('sha') + + file_data = { + 'message': 'Update cli_pip.py', + 'content': file_content_encoded, + 'sha': file_sha, + 'branch': new_branch + } + except: + file_data = { + 'message': 'Add cli_pip.py', + 'content': file_content_encoded, + 'branch': new_branch + } + + response = requests.put( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/contents/{FILE_PATH}", + headers=headers, + json=file_data + ) + response.raise_for_status() + + logger.info(f"Creating a pull request from {new_branch} to {base_branch}") + pr_data = { + 'title': f'Test PR from {new_branch}', + 'body': 'update cli_pip.py', + 'head': new_branch, + 'base': base_branch + } + response = requests.post( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/pulls", + headers=headers, + json=pr_data + ) + response.raise_for_status() + pr = response.json() + pr_number = pr['number'] + + for i in range(NUM_MINUTES): + logger.info(f"Waiting for the PR to get all the tool results...") + time.sleep(60) + + response = requests.get( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/issues/{pr_number}/comments", + headers=headers + ) + response.raise_for_status() + comments = response.json() + + if len(comments) >= 5: + valid_review = False + for comment in comments: + if comment['body'].startswith('## PR Reviewer Guide 🔍'): + valid_review = True + break + if valid_review: + break + else: + logger.error("REVIEW feedback is invalid") + raise Exception("REVIEW feedback is invalid") + else: + logger.info(f"Waiting for the PR to get all the tool results. {i + 1} minute(s) passed") + else: + assert False, f"After {NUM_MINUTES} minutes, the PR did not get all the tool results" + + logger.info(f"Cleaning up: closing PR and deleting branch {new_branch}") + + close_data = {'state': 'closed'} + response = requests.patch( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/pulls/{pr_number}", + headers=headers, + json=close_data + ) + response.raise_for_status() + + response = requests.delete( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/git/refs/heads/{new_branch}", + headers=headers + ) + response.raise_for_status() + + logger.info(f"Succeeded in running e2e test for Gitea app on the PR") + except Exception as e: + logger.error(f"Failed to run e2e test for Gitea app: {e}") + raise + finally: + try: + if headers is None or gitea_url is None: + return + + if pr_number is not None: + requests.patch( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/pulls/{pr_number}", + headers=headers, + json={'state': 'closed'} + ) + + requests.delete( + f"{gitea_url}/api/v1/repos/{owner}/{repo_name}/git/refs/heads/{new_branch}", + headers=headers + ) + except Exception as cleanup_error: + logger.error(f"Failed to clean up after test: {cleanup_error}") + +if __name__ == '__main__': + test_e2e_run_gitea_app() \ No newline at end of file diff --git a/tests/unittest/test_gitea_provider.py b/tests/unittest/test_gitea_provider.py new file mode 100644 index 00000000..d88de0e0 --- /dev/null +++ b/tests/unittest/test_gitea_provider.py @@ -0,0 +1,126 @@ +from unittest.mock import MagicMock, patch + +import pytest + +from pr_agent.algo.types import EDIT_TYPE +from pr_agent.git_providers.gitea_provider import GiteaProvider + + +class TestGiteaProvider: + """Unit-tests for GiteaProvider following project style (explicit object construction, minimal patching).""" + + def _provider(self): + """Create provider instance with patched settings and avoid real HTTP calls.""" + with patch('pr_agent.git_providers.gitea_provider.get_settings') as mock_get_settings, \ + patch('requests.get') as mock_get: + settings = MagicMock() + settings.get.side_effect = lambda k, d=None: { + 'GITEA.URL': 'https://gitea.example.com', + 'GITEA.TOKEN': 'test-token' + }.get(k, d) + mock_get_settings.return_value = settings + # Stub the PR fetch triggered during provider initialization + pr_resp = MagicMock() + pr_resp.json.return_value = { + 'title': 'stub', + 'body': 'stub', + 'head': {'ref': 'main'}, + 'user': {'id': 1} + } + pr_resp.raise_for_status = MagicMock() + mock_get.return_value = pr_resp + return GiteaProvider('https://gitea.example.com/owner/repo/pulls/123') + + # ---------------- URL parsing ---------------- + def test_parse_pr_url_valid(self): + owner, repo, pr_num = GiteaProvider._parse_pr_url('https://gitea.example.com/owner/repo/pulls/123') + assert (owner, repo, pr_num) == ('owner', 'repo', '123') + + def test_parse_pr_url_invalid(self): + with pytest.raises(ValueError): + GiteaProvider._parse_pr_url('https://gitea.example.com/owner/repo') + + # ---------------- simple getters ---------------- + def test_get_files(self): + provider = self._provider() + mock_resp = MagicMock() + mock_resp.json.return_value = [{'filename': 'a.txt'}, {'filename': 'b.txt'}] + mock_resp.raise_for_status = MagicMock() + with patch('requests.get', return_value=mock_resp) as mock_get: + assert provider.get_files() == ['a.txt', 'b.txt'] + mock_get.assert_called_once() + + def test_get_diff_files(self): + provider = self._provider() + mock_resp = MagicMock() + mock_resp.json.return_value = [ + {'filename': 'f1', 'previous_filename': 'old_f1', 'status': 'renamed', 'patch': ''}, + {'filename': 'f2', 'status': 'added', 'patch': ''}, + {'filename': 'f3', 'status': 'deleted', 'patch': ''}, + {'filename': 'f4', 'status': 'modified', 'patch': ''} + ] + mock_resp.raise_for_status = MagicMock() + with patch('requests.get', return_value=mock_resp): + res = provider.get_diff_files() + assert [f.edit_type for f in res] == [EDIT_TYPE.RENAMED, EDIT_TYPE.ADDED, EDIT_TYPE.DELETED, + EDIT_TYPE.MODIFIED] + + # ---------------- publishing methods ---------------- + def test_publish_description(self): + provider = self._provider() + mock_resp = MagicMock(); + mock_resp.raise_for_status = MagicMock() + with patch('requests.patch', return_value=mock_resp) as mock_patch: + provider.publish_description('t', 'b'); + mock_patch.assert_called_once() + + def test_publish_comment(self): + provider = self._provider() + mock_resp = MagicMock(); + mock_resp.raise_for_status = MagicMock() + with patch('requests.post', return_value=mock_resp) as mock_post: + provider.publish_comment('c'); + mock_post.assert_called_once() + + def test_publish_inline_comment(self): + provider = self._provider() + mock_resp = MagicMock(); + mock_resp.raise_for_status = MagicMock() + with patch('requests.post', return_value=mock_resp) as mock_post: + provider.publish_inline_comment('body', 'file', '10'); + mock_post.assert_called_once() + + # ---------------- labels & reactions ---------------- + def test_get_pr_labels(self): + provider = self._provider() + mock_resp = MagicMock(); + mock_resp.raise_for_status = MagicMock(); + mock_resp.json.return_value = [{'name': 'l1'}] + with patch('requests.get', return_value=mock_resp): + assert provider.get_pr_labels() == ['l1'] + + def test_add_eyes_reaction(self): + provider = self._provider() + mock_resp = MagicMock(); + mock_resp.raise_for_status = MagicMock(); + mock_resp.json.return_value = {'id': 7} + with patch('requests.post', return_value=mock_resp): + assert provider.add_eyes_reaction(1) == 7 + + # ---------------- commit messages & url helpers ---------------- + def test_get_commit_messages(self): + provider = self._provider() + mock_resp = MagicMock(); + mock_resp.raise_for_status = MagicMock() + mock_resp.json.return_value = [ + {'commit': {'message': 'm1'}}, {'commit': {'message': 'm2'}}] + with patch('requests.get', return_value=mock_resp): + assert provider.get_commit_messages() == ['m1', 'm2'] + + def test_git_url_helpers(self): + provider = self._provider() + issues_url = 'https://gitea.example.com/owner/repo/pulls/3' + assert provider.get_git_repo_url(issues_url) == 'https://gitea.example.com/owner/repo.git' + prefix, suffix = provider.get_canonical_url_parts('https://gitea.example.com/owner/repo.git', 'dev') + assert prefix == 'https://gitea.example.com/owner/repo/src/branch/dev' + assert suffix == '' diff --git a/tests/unittest/test_ignore_repositories.py b/tests/unittest/test_ignore_repositories.py new file mode 100644 index 00000000..e05447d5 --- /dev/null +++ b/tests/unittest/test_ignore_repositories.py @@ -0,0 +1,79 @@ +import pytest +from pr_agent.servers.github_app import should_process_pr_logic as github_should_process_pr_logic +from pr_agent.servers.bitbucket_app import should_process_pr_logic as bitbucket_should_process_pr_logic +from pr_agent.servers.gitlab_webhook import should_process_pr_logic as gitlab_should_process_pr_logic +from pr_agent.config_loader import get_settings + +def make_bitbucket_payload(full_name): + return { + "data": { + "pullrequest": { + "title": "Test PR", + "source": {"branch": {"name": "feature/test"}}, + "destination": { + "branch": {"name": "main"}, + "repository": {"full_name": full_name} + } + }, + "actor": {"username": "user", "type": "user"} + } + } + +def make_github_body(full_name): + return { + "pull_request": {}, + "repository": {"full_name": full_name}, + "sender": {"login": "user"} + } + +def make_gitlab_body(full_name): + return { + "object_attributes": {"title": "Test MR"}, + "project": {"path_with_namespace": full_name} + } + +PROVIDERS = [ + ("github", github_should_process_pr_logic, make_github_body), + ("bitbucket", bitbucket_should_process_pr_logic, make_bitbucket_payload), + ("gitlab", gitlab_should_process_pr_logic, make_gitlab_body), +] + +class TestIgnoreRepositories: + def setup_method(self): + get_settings().set("CONFIG.IGNORE_REPOSITORIES", []) + + @pytest.mark.parametrize("provider_name, provider_func, body_func", PROVIDERS) + def test_should_ignore_matching_repository(self, provider_name, provider_func, body_func): + get_settings().set("CONFIG.IGNORE_REPOSITORIES", ["org/repo-to-ignore"]) + body = { + "pull_request": {}, + "repository": {"full_name": "org/repo-to-ignore"}, + "sender": {"login": "user"} + } + result = provider_func(body_func(body["repository"]["full_name"])) + # print(f"DEBUG: Provider={provider_name}, test_should_ignore_matching_repository, result={result}") + assert result is False, f"{provider_name}: PR from ignored repository should be ignored (return False)" + + @pytest.mark.parametrize("provider_name, provider_func, body_func", PROVIDERS) + def test_should_not_ignore_non_matching_repository(self, provider_name, provider_func, body_func): + get_settings().set("CONFIG.IGNORE_REPOSITORIES", ["org/repo-to-ignore"]) + body = { + "pull_request": {}, + "repository": {"full_name": "org/other-repo"}, + "sender": {"login": "user"} + } + result = provider_func(body_func(body["repository"]["full_name"])) + # print(f"DEBUG: Provider={provider_name}, test_should_not_ignore_non_matching_repository, result={result}") + assert result is True, f"{provider_name}: PR from non-ignored repository should not be ignored (return True)" + + @pytest.mark.parametrize("provider_name, provider_func, body_func", PROVIDERS) + def test_should_not_ignore_when_config_empty(self, provider_name, provider_func, body_func): + get_settings().set("CONFIG.IGNORE_REPOSITORIES", []) + body = { + "pull_request": {}, + "repository": {"full_name": "org/repo-to-ignore"}, + "sender": {"login": "user"} + } + result = provider_func(body_func(body["repository"]["full_name"])) + # print(f"DEBUG: Provider={provider_name}, test_should_not_ignore_when_config_empty, result={result}") + assert result is True, f"{provider_name}: PR should not be ignored if ignore_repositories config is empty" \ No newline at end of file diff --git a/tests/unittest/test_try_fix_yaml.py b/tests/unittest/test_try_fix_yaml.py index 336c4af5..826d7312 100644 --- a/tests/unittest/test_try_fix_yaml.py +++ b/tests/unittest/test_try_fix_yaml.py @@ -32,11 +32,6 @@ age: 35 expected_output = {'name': 'John Smith', 'age': 35} assert try_fix_yaml(review_text) == expected_output - # The function removes the last line(s) of the YAML string and successfully parses the YAML string. - def test_remove_last_line(self): - review_text = "key: value\nextra invalid line\n" - expected_output = {"key": "value"} - assert try_fix_yaml(review_text) == expected_output # The YAML string is empty. def test_empty_yaml_fixed(self):