From 9087d85cfec7694282054dce4acff826677ec19b Mon Sep 17 00:00:00 2001 From: Cristian Maglie Date: Fri, 9 Feb 2024 12:16:59 +0100 Subject: [PATCH] Moved discovery client implementation into his own library --- .../v2.dep.yml | 709 ++++++++++++++++++ commands/board/list.go | 6 +- commands/board/list_test.go | 2 +- commands/upload/upload.go | 6 +- go.mod | 2 +- go.sum | 4 +- .../arduino/cores/packagemanager/loader.go | 7 +- internal/arduino/discovery/discovery.go | 472 ------------ .../discovery/discovery_client/main.go | 4 +- internal/arduino/discovery/discovery_test.go | 73 -- .../discoverymanager/discoverymanager.go | 30 +- .../arduino/discovery/testdata/cat/.gitignore | 2 - .../arduino/discovery/testdata/cat/main.go | 28 - rpc/cc/arduino/cli/commands/v1/common.go | 36 + 14 files changed, 777 insertions(+), 604 deletions(-) create mode 100644 .licenses/go/github.com/arduino/pluggable-discovery-protocol-handler/v2.dep.yml delete mode 100644 internal/arduino/discovery/discovery.go delete mode 100644 internal/arduino/discovery/discovery_test.go delete mode 100644 internal/arduino/discovery/testdata/cat/.gitignore delete mode 100644 internal/arduino/discovery/testdata/cat/main.go diff --git a/.licenses/go/github.com/arduino/pluggable-discovery-protocol-handler/v2.dep.yml b/.licenses/go/github.com/arduino/pluggable-discovery-protocol-handler/v2.dep.yml new file mode 100644 index 00000000000..77fe72e52dd --- /dev/null +++ b/.licenses/go/github.com/arduino/pluggable-discovery-protocol-handler/v2.dep.yml @@ -0,0 +1,709 @@ +--- +name: github.com/arduino/pluggable-discovery-protocol-handler/v2 +version: v2.1.3-0.20240209111235-2b24b07045a5 +type: go +summary: Package discovery is a library for handling the Arduino Pluggable-Discovery + protocol (https://github.com/arduino/tooling-rfcs/blob/main/RFCs/0002-pluggable-discovery.md#pluggable-discovery-api-via-stdinstdout) +homepage: https://pkg.go.dev/github.com/arduino/pluggable-discovery-protocol-handler/v2 +license: other +licenses: +- sources: LICENSE.txt + text: | + This file includes licensing information for serial-discovery + + Copyright (c) 2018 ARDUINO SA (www.arduino.cc) + + The software is released under the GNU General Public License, which covers the main body + of the serial-discovery code. The terms of this license can be found at: + https://www.gnu.org/licenses/gpl-3.0.en.html + + You can be released from the requirements of the above licenses by purchasing + a commercial license. Buying such a license is mandatory if you want to modify or + otherwise use the software for commercial activities involving the Arduino + software without disclosing the source code of your own applications. To purchase + a commercial license, send an email to license@arduino.cc + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for + software and other kinds of works. + + The licenses for most software and other practical works are designed + to take away your freedom to share and change the works. By contrast, + the GNU General Public License is intended to guarantee your freedom to + share and change all versions of a program--to make sure it remains free + software for all its users. We, the Free Software Foundation, use the + GNU General Public License for most of our software; it applies also to + any other work released this way by its authors. You can apply it to + your programs, too. + + When we speak of free software, we are referring to freedom, not + price. Our General Public Licenses are designed to make sure that you + have the freedom to distribute copies of free software (and charge for + them if you wish), that you receive source code or can get it if you + want it, that you can change the software or use pieces of it in new + free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you + these rights or asking you to surrender the rights. Therefore, you have + certain responsibilities if you distribute copies of the software, or if + you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether + gratis or for a fee, you must pass on to the recipients the same + freedoms that you received. You must make sure that they, too, receive + or can get the source code. And you must show them these terms so they + know their rights. + + Developers that use the GNU GPL protect your rights with two steps: + (1) assert copyright on the software, and (2) offer you this License + giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains + that there is no warranty for this free software. For both users' and + authors' sake, the GPL requires that modified versions be marked as + changed, so that their problems will not be attributed erroneously to + authors of previous versions. + + Some devices are designed to deny users access to install or run + modified versions of the software inside them, although the manufacturer + can do so. This is fundamentally incompatible with the aim of + protecting users' freedom to change the software. The systematic + pattern of such abuse occurs in the area of products for individuals to + use, which is precisely where it is most unacceptable. Therefore, we + have designed this version of the GPL to prohibit the practice for those + products. If such problems arise substantially in other domains, we + stand ready to extend this provision to those domains in future versions + of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. + States should not allow patents to restrict development and use of + software on general-purpose computers, but in those that do, we wish to + avoid the special danger that patents applied to a free program could + make it effectively proprietary. To prevent this, the GPL assures that + patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and + modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of + works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this + License. Each licensee is addressed as "you". "Licensees" and + "recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work + in a fashion requiring copyright permission, other than the making of an + exact copy. The resulting work is called a "modified version" of the + earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based + on the Program. + + To "propagate" a work means to do anything with it that, without + permission, would make you directly or secondarily liable for + infringement under applicable copyright law, except executing it on a + computer or modifying a private copy. Propagation includes copying, + distribution (with or without modification), making available to the + public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other + parties to make or receive copies. Mere interaction with a user through + a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" + to the extent that it includes a convenient and prominently visible + feature that (1) displays an appropriate copyright notice, and (2) + tells the user that there is no warranty for the work (except to the + extent that warranties are provided), that licensees may convey the + work under this License, and how to view a copy of this License. If + the interface presents a list of user commands or options, such as a + menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work + for making modifications to it. "Object code" means any non-source + form of a work. + + A "Standard Interface" means an interface that either is an official + standard defined by a recognized standards body, or, in the case of + interfaces specified for a particular programming language, one that + is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other + than the work as a whole, that (a) is included in the normal form of + packaging a Major Component, but which is not part of that Major + Component, and (b) serves only to enable use of the work with that + Major Component, or to implement a Standard Interface for which an + implementation is available to the public in source code form. A + "Major Component", in this context, means a major essential component + (kernel, window system, and so on) of the specific operating system + (if any) on which the executable work runs, or a compiler used to + produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all + the source code needed to generate, install, and (for an executable + work) run the object code and to modify the work, including scripts to + control those activities. However, it does not include the work's + System Libraries, or general-purpose tools or generally available free + programs which are used unmodified in performing those activities but + which are not part of the work. For example, Corresponding Source + includes interface definition files associated with source files for + the work, and the source code for shared libraries and dynamically + linked subprograms that the work is specifically designed to require, + such as by intimate data communication or control flow between those + subprograms and other parts of the work. + + The Corresponding Source need not include anything that users + can regenerate automatically from other parts of the Corresponding + Source. + + The Corresponding Source for a work in source code form is that + same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of + copyright on the Program, and are irrevocable provided the stated + conditions are met. This License explicitly affirms your unlimited + permission to run the unmodified Program. The output from running a + covered work is covered by this License only if the output, given its + content, constitutes a covered work. This License acknowledges your + rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not + convey, without conditions so long as your license otherwise remains + in force. You may convey covered works to others for the sole purpose + of having them make modifications exclusively for you, or provide you + with facilities for running those works, provided that you comply with + the terms of this License in conveying all material for which you do + not control copyright. Those thus making or running the covered works + for you must do so exclusively on your behalf, under your direction + and control, on terms that prohibit them from making any copies of + your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under + the conditions stated below. Sublicensing is not allowed; section 10 + makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological + measure under any applicable law fulfilling obligations under article + 11 of the WIPO copyright treaty adopted on 20 December 1996, or + similar laws prohibiting or restricting circumvention of such + measures. + + When you convey a covered work, you waive any legal power to forbid + circumvention of technological measures to the extent such circumvention + is effected by exercising rights under this License with respect to + the covered work, and you disclaim any intention to limit operation or + modification of the work as a means of enforcing, against the work's + users, your or third parties' legal rights to forbid circumvention of + technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you + receive it, in any medium, provided that you conspicuously and + appropriately publish on each copy an appropriate copyright notice; + keep intact all notices stating that this License and any + non-permissive terms added in accord with section 7 apply to the code; + keep intact all notices of the absence of any warranty; and give all + recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, + and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to + produce it from the Program, in the form of source code under the + terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent + works, which are not by their nature extensions of the covered work, + and which are not combined with it such as to form a larger program, + in or on a volume of a storage or distribution medium, is called an + "aggregate" if the compilation and its resulting copyright are not + used to limit the access or legal rights of the compilation's users + beyond what the individual works permit. Inclusion of a covered work + in an aggregate does not cause this License to apply to the other + parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms + of sections 4 and 5, provided that you also convey the + machine-readable Corresponding Source under the terms of this License, + in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded + from the Corresponding Source as a System Library, need not be + included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any + tangible personal property which is normally used for personal, family, + or household purposes, or (2) anything designed or sold for incorporation + into a dwelling. In determining whether a product is a consumer product, + doubtful cases shall be resolved in favor of coverage. For a particular + product received by a particular user, "normally used" refers to a + typical or common use of that class of product, regardless of the status + of the particular user or of the way in which the particular user + actually uses, or expects or is expected to use, the product. A product + is a consumer product regardless of whether the product has substantial + commercial, industrial or non-consumer uses, unless such uses represent + the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, + procedures, authorization keys, or other information required to install + and execute modified versions of a covered work in that User Product from + a modified version of its Corresponding Source. The information must + suffice to ensure that the continued functioning of the modified object + code is in no case prevented or interfered with solely because + modification has been made. + + If you convey an object code work under this section in, or with, or + specifically for use in, a User Product, and the conveying occurs as + part of a transaction in which the right of possession and use of the + User Product is transferred to the recipient in perpetuity or for a + fixed term (regardless of how the transaction is characterized), the + Corresponding Source conveyed under this section must be accompanied + by the Installation Information. But this requirement does not apply + if neither you nor any third party retains the ability to install + modified object code on the User Product (for example, the work has + been installed in ROM). + + The requirement to provide Installation Information does not include a + requirement to continue to provide support service, warranty, or updates + for a work that has been modified or installed by the recipient, or for + the User Product in which it has been modified or installed. Access to a + network may be denied when the modification itself materially and + adversely affects the operation of the network or violates the rules and + protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, + in accord with this section must be in a format that is publicly + documented (and with an implementation available to the public in + source code form), and must require no special password or key for + unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this + License by making exceptions from one or more of its conditions. + Additional permissions that are applicable to the entire Program shall + be treated as though they were included in this License, to the extent + that they are valid under applicable law. If additional permissions + apply only to part of the Program, that part may be used separately + under those permissions, but the entire Program remains governed by + this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option + remove any additional permissions from that copy, or from any part of + it. (Additional permissions may be written to require their own + removal in certain cases when you modify the work.) You may place + additional permissions on material, added by you to a covered work, + for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you + add to a covered work, you may (if authorized by the copyright holders of + that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further + restrictions" within the meaning of section 10. If the Program as you + received it, or any part of it, contains a notice stating that it is + governed by this License along with a term that is a further + restriction, you may remove that term. If a license document contains + a further restriction but permits relicensing or conveying under this + License, you may add to a covered work material governed by the terms + of that license document, provided that the further restriction does + not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you + must place, in the relevant source files, a statement of the + additional terms that apply to those files, or a notice indicating + where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the + form of a separately written license, or stated as exceptions; + the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly + provided under this License. Any attempt otherwise to propagate or + modify it is void, and will automatically terminate your rights under + this License (including any patent licenses granted under the third + paragraph of section 11). + + However, if you cease all violation of this License, then your + license from a particular copyright holder is reinstated (a) + provisionally, unless and until the copyright holder explicitly and + finally terminates your license, and (b) permanently, if the copyright + holder fails to notify you of the violation by some reasonable means + prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is + reinstated permanently if the copyright holder notifies you of the + violation by some reasonable means, this is the first time you have + received notice of violation of this License (for any work) from that + copyright holder, and you cure the violation prior to 30 days after + your receipt of the notice. + + Termination of your rights under this section does not terminate the + licenses of parties who have received copies or rights from you under + this License. If your rights have been terminated and not permanently + reinstated, you do not qualify to receive new licenses for the same + material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or + run a copy of the Program. Ancillary propagation of a covered work + occurring solely as a consequence of using peer-to-peer transmission + to receive a copy likewise does not require acceptance. However, + nothing other than this License grants you permission to propagate or + modify any covered work. These actions infringe copyright if you do + not accept this License. Therefore, by modifying or propagating a + covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically + receives a license from the original licensors, to run, modify and + propagate that work, subject to this License. You are not responsible + for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an + organization, or substantially all assets of one, or subdividing an + organization, or merging organizations. If propagation of a covered + work results from an entity transaction, each party to that + transaction who receives a copy of the work also receives whatever + licenses to the work the party's predecessor in interest had or could + give under the previous paragraph, plus a right to possession of the + Corresponding Source of the work from the predecessor in interest, if + the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the + rights granted or affirmed under this License. For example, you may + not impose a license fee, royalty, or other charge for exercise of + rights granted under this License, and you may not initiate litigation + (including a cross-claim or counterclaim in a lawsuit) alleging that + any patent claim is infringed by making, using, selling, offering for + sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this + License of the Program or a work on which the Program is based. The + work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims + owned or controlled by the contributor, whether already acquired or + hereafter acquired, that would be infringed by some manner, permitted + by this License, of making, using, or selling its contributor version, + but do not include claims that would be infringed only as a + consequence of further modification of the contributor version. For + purposes of this definition, "control" includes the right to grant + patent sublicenses in a manner consistent with the requirements of + this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free + patent license under the contributor's essential patent claims, to + make, use, sell, offer for sale, import and otherwise run, modify and + propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express + agreement or commitment, however denominated, not to enforce a patent + (such as an express permission to practice a patent or covenant not to + sue for patent infringement). To "grant" such a patent license to a + party means to make such an agreement or commitment not to enforce a + patent against the party. + + If you convey a covered work, knowingly relying on a patent license, + and the Corresponding Source of the work is not available for anyone + to copy, free of charge and under the terms of this License, through a + publicly available network server or other readily accessible means, + then you must either (1) cause the Corresponding Source to be so + available, or (2) arrange to deprive yourself of the benefit of the + patent license for this particular work, or (3) arrange, in a manner + consistent with the requirements of this License, to extend the patent + license to downstream recipients. "Knowingly relying" means you have + actual knowledge that, but for the patent license, your conveying the + covered work in a country, or your recipient's use of the covered work + in a country, would infringe one or more identifiable patents in that + country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or + arrangement, you convey, or propagate by procuring conveyance of, a + covered work, and grant a patent license to some of the parties + receiving the covered work authorizing them to use, propagate, modify + or convey a specific copy of the covered work, then the patent license + you grant is automatically extended to all recipients of the covered + work and works based on it. + + A patent license is "discriminatory" if it does not include within + the scope of its coverage, prohibits the exercise of, or is + conditioned on the non-exercise of one or more of the rights that are + specifically granted under this License. You may not convey a covered + work if you are a party to an arrangement with a third party that is + in the business of distributing software, under which you make payment + to the third party based on the extent of your activity of conveying + the work, and under which the third party grants, to any of the + parties who would receive the covered work from you, a discriminatory + patent license (a) in connection with copies of the covered work + conveyed by you (or copies made from those copies), or (b) primarily + for and in connection with specific products or compilations that + contain the covered work, unless you entered into that arrangement, + or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting + any implied license or other defenses to infringement that may + otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or + otherwise) that contradict the conditions of this License, they do not + excuse you from the conditions of this License. If you cannot convey a + covered work so as to satisfy simultaneously your obligations under this + License and any other pertinent obligations, then as a consequence you may + not convey it at all. For example, if you agree to terms that obligate you + to collect a royalty for further conveying from those to whom you convey + the Program, the only way you could satisfy both those terms and this + License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have + permission to link or combine any covered work with a work licensed + under version 3 of the GNU Affero General Public License into a single + combined work, and to convey the resulting work. The terms of this + License will continue to apply to the part which is the covered work, + but the special requirements of the GNU Affero General Public License, + section 13, concerning interaction through a network will apply to the + combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of + the GNU General Public License from time to time. Such new versions will + be similar in spirit to the present version, but may differ in detail to + address new problems or concerns. + + Each version is given a distinguishing version number. If the + Program specifies that a certain numbered version of the GNU General + Public License "or any later version" applies to it, you have the + option of following the terms and conditions either of that numbered + version or of any later version published by the Free Software + Foundation. If the Program does not specify a version number of the + GNU General Public License, you may choose any version ever published + by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future + versions of the GNU General Public License can be used, that proxy's + public statement of acceptance of a version permanently authorizes you + to choose that version for the Program. + + Later license versions may give you additional or different + permissions. However, no additional obligations are imposed on any + author or copyright holder as a result of your choosing to follow a + later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY + APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT + HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY + OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, + THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM + IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF + ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING + WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS + THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY + GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE + USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF + DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD + PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), + EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF + SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided + above cannot be given local legal effect according to their terms, + reviewing courts shall apply local law that most closely approximates + an absolute waiver of all civil liability in connection with the + Program, unless a warranty or assumption of liability accompanies a + copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest + possible use to the public, the best way to achieve this is to make it + free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest + to attach them to the start of each source file to most effectively + state the exclusion of warranty; and each file should have at least + the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short + notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + + The hypothetical commands `show w' and `show c' should show the appropriate + parts of the General Public License. Of course, your program's commands + might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, + if any, to sign a "copyright disclaimer" for the program, if necessary. + For more information on this, and how to apply and follow the GNU GPL, see + . + + The GNU General Public License does not permit incorporating your program + into proprietary programs. If your program is a subroutine library, you + may consider it more useful to permit linking proprietary applications with + the library. If this is what you want to do, use the GNU Lesser General + Public License instead of this License. But first, please read + . +- sources: README.md + text: |- + Copyright (c) 2021 ARDUINO SA (www.arduino.cc) + + The software is released under the GNU General Public License, which covers the main body + of the serial-discovery code. The terms of this license can be found at: + https://www.gnu.org/licenses/gpl-3.0.en.html + + See [LICENSE.txt](https://github.com/arduino/pluggable-discovery-protocol-handler/blob/master/LICENSE.txt) for details. +notices: [] diff --git a/commands/board/list.go b/commands/board/list.go index 22a66b524c3..25c6ef53401 100644 --- a/commands/board/list.go +++ b/commands/board/list.go @@ -31,11 +31,11 @@ import ( "github.com/arduino/arduino-cli/commands/internal/instances" "github.com/arduino/arduino-cli/internal/arduino/cores" "github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager" - "github.com/arduino/arduino-cli/internal/arduino/discovery" "github.com/arduino/arduino-cli/internal/arduino/httpclient" "github.com/arduino/arduino-cli/internal/inventory" rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1" "github.com/arduino/go-properties-orderedmap" + discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2" "github.com/sirupsen/logrus" ) @@ -234,7 +234,7 @@ func List(req *rpc.BoardListRequest) (r []*rpc.DetectedPort, discoveryStartError // boards slice can be empty at this point if neither the cores nor the // API managed to recognize the connected board b := &rpc.DetectedPort{ - Port: port.ToRPC(), + Port: rpc.DiscoveryPortToRPC(port), MatchingBoards: boards, } @@ -283,7 +283,7 @@ func Watch(ctx context.Context, req *rpc.BoardListWatchRequest) (<-chan *rpc.Boa defer close(outChan) for event := range watcher.Feed() { port := &rpc.DetectedPort{ - Port: event.Port.ToRPC(), + Port: rpc.DiscoveryPortToRPC(event.Port), } boardsError := "" diff --git a/commands/board/list_test.go b/commands/board/list_test.go index 29d342b48a9..f6e46f19a46 100644 --- a/commands/board/list_test.go +++ b/commands/board/list_test.go @@ -22,10 +22,10 @@ import ( "testing" "github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager" - "github.com/arduino/arduino-cli/internal/arduino/discovery" "github.com/arduino/arduino-cli/internal/cli/configuration" "github.com/arduino/go-paths-helper" "github.com/arduino/go-properties-orderedmap" + discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2" "github.com/stretchr/testify/require" semver "go.bug.st/relaxed-semver" ) diff --git a/commands/upload/upload.go b/commands/upload/upload.go index 0200646b435..487840c46aa 100644 --- a/commands/upload/upload.go +++ b/commands/upload/upload.go @@ -29,7 +29,6 @@ import ( f "github.com/arduino/arduino-cli/internal/algorithms" "github.com/arduino/arduino-cli/internal/arduino/cores" "github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager" - "github.com/arduino/arduino-cli/internal/arduino/discovery" "github.com/arduino/arduino-cli/internal/arduino/globals" "github.com/arduino/arduino-cli/internal/arduino/sketch" "github.com/arduino/arduino-cli/internal/i18n" @@ -37,6 +36,7 @@ import ( paths "github.com/arduino/go-paths-helper" properties "github.com/arduino/go-properties-orderedmap" serialutils "github.com/arduino/go-serial-utils" + discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2" "github.com/sirupsen/logrus" ) @@ -209,7 +209,7 @@ func runProgramAction(pme *packagemanager.Explorer, outStream, errStream io.Writer, dryRun bool, userFields map[string]string, ) (*rpc.Port, error) { - port := discovery.PortFromRPCPort(userPort) + port := rpc.DiscoveryPortFromRPCPort(userPort) if port == nil || (port.Address == "" && port.Protocol == "") { // For no-port uploads use "default" protocol port = &discovery.Port{Protocol: "default"} @@ -528,7 +528,7 @@ func runProgramAction(pme *packagemanager.Explorer, // If the algorithms can not detect the new port, fallback to the user-provided port. return userPort, nil } - return updatedPort.ToRPC(), nil + return rpc.DiscoveryPortToRPC(updatedPort), nil } func detectUploadPort( diff --git a/go.mod b/go.mod index c3776bd8f40..0297f56e7d6 100644 --- a/go.mod +++ b/go.mod @@ -12,7 +12,7 @@ require ( github.com/arduino/go-serial-utils v0.1.2 github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b github.com/arduino/go-win32-utils v1.0.0 - github.com/arduino/pluggable-discovery-protocol-handler/v2 v2.1.2 + github.com/arduino/pluggable-discovery-protocol-handler/v2 v2.1.3-0.20240209111235-2b24b07045a5 github.com/arduino/pluggable-monitor-protocol-handler v0.9.2 github.com/cmaglie/pb v1.0.27 github.com/codeclysm/extract/v3 v3.1.1 diff --git a/go.sum b/go.sum index 192d48793ee..b79a0f50895 100644 --- a/go.sum +++ b/go.sum @@ -21,8 +21,8 @@ github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b h1:9hDi4F2st6 github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b/go.mod h1:uwGy5PpN4lqW97FiLnbcx+xx8jly5YuPMJWfVwwjJiQ= github.com/arduino/go-win32-utils v1.0.0 h1:/cXB86sOJxOsCHP7sQmXGLkdValwJt56mIwOHYxgQjQ= github.com/arduino/go-win32-utils v1.0.0/go.mod h1:0jqM7doGEAs6DaJCxxhLBUDS5OawrqF48HqXkcEie/Q= -github.com/arduino/pluggable-discovery-protocol-handler/v2 v2.1.2 h1:Yrljx84UtFilOCpe+xE6+OFDyWyhghYpP/4A7vzQneM= -github.com/arduino/pluggable-discovery-protocol-handler/v2 v2.1.2/go.mod h1:1dgblsmK2iBx3L5iNTyRIokeaxbTLUrYiUbHBK6yC3Y= +github.com/arduino/pluggable-discovery-protocol-handler/v2 v2.1.3-0.20240209111235-2b24b07045a5 h1:DT4xSabkgleQzdXexycKcROLhsIHZGWFl8Mxu5c2+cI= +github.com/arduino/pluggable-discovery-protocol-handler/v2 v2.1.3-0.20240209111235-2b24b07045a5/go.mod h1:1dgblsmK2iBx3L5iNTyRIokeaxbTLUrYiUbHBK6yC3Y= github.com/arduino/pluggable-monitor-protocol-handler v0.9.2 h1:vb5AmE3bT9we5Ej4AdBxcC9dJLXasRimVqaComf9L3M= github.com/arduino/pluggable-monitor-protocol-handler v0.9.2/go.mod h1:vMG8tgHyE+hli26oT0JB/M7NxUMzzWoU5wd6cgJQRK4= github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= diff --git a/internal/arduino/cores/packagemanager/loader.go b/internal/arduino/cores/packagemanager/loader.go index 77d4cc3d848..00f87dd3002 100644 --- a/internal/arduino/cores/packagemanager/loader.go +++ b/internal/arduino/cores/packagemanager/loader.go @@ -24,7 +24,6 @@ import ( "github.com/arduino/arduino-cli/commands/cmderrors" "github.com/arduino/arduino-cli/internal/arduino/cores" - "github.com/arduino/arduino-cli/internal/arduino/discovery" "github.com/arduino/arduino-cli/internal/cli/configuration" "github.com/arduino/go-paths-helper" properties "github.com/arduino/go-properties-orderedmap" @@ -636,8 +635,7 @@ func (pme *Explorer) loadDiscovery(id string) error { return errors.New(tr("discovery %s not installed", id)) } discoveryPath := toolRelease.InstallDir.Join(tool.Name).String() - d := discovery.New(id, discoveryPath) - pme.discoveryManager.Add(d) + pme.discoveryManager.Add(id, discoveryPath) return nil } @@ -713,8 +711,7 @@ func (pme *Explorer) loadDiscoveries(release *cores.PlatformRelease) []error { if cmdArgs, err := properties.SplitQuotedString(cmd, `"'`, true); err != nil { merr = append(merr, err) } else { - d := discovery.New(discoveryID, cmdArgs...) - pme.discoveryManager.Add(d) + pme.discoveryManager.Add(discoveryID, cmdArgs...) } } diff --git a/internal/arduino/discovery/discovery.go b/internal/arduino/discovery/discovery.go deleted file mode 100644 index bc62456e3e0..00000000000 --- a/internal/arduino/discovery/discovery.go +++ /dev/null @@ -1,472 +0,0 @@ -// This file is part of arduino-cli. -// -// Copyright 2020 ARDUINO SA (http://www.arduino.cc/) -// -// This software is released under the GNU General Public License version 3, -// which covers the main part of arduino-cli. -// The terms of this license can be found at: -// https://www.gnu.org/licenses/gpl-3.0.en.html -// -// You can be released from the requirements of the above licenses by purchasing -// a commercial license. Buying such a license is mandatory if you want to -// modify or otherwise use the software for commercial activities involving the -// Arduino software without disclosing the source code of your own applications. -// To purchase a commercial license, send an email to license@arduino.cc. - -package discovery - -import ( - "encoding/json" - "errors" - "fmt" - "io" - "strings" - "sync" - "time" - - "github.com/arduino/arduino-cli/internal/i18n" - rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1" - "github.com/arduino/arduino-cli/version" - "github.com/arduino/go-paths-helper" - "github.com/arduino/go-properties-orderedmap" - "github.com/sirupsen/logrus" -) - -// To work correctly a Pluggable Discovery must respect the state machine specified on the documentation: -// https://arduino.github.io/arduino-cli/latest/pluggable-discovery-specification/#state-machine -// States a PluggableDiscovery can be in -const ( - Alive int = iota - Idling - Running - Syncing - Dead -) - -// PluggableDiscovery is a tool that detects communication ports to interact -// with the boards. -type PluggableDiscovery struct { - id string - processArgs []string - process *paths.Process - outgoingCommandsPipe io.Writer - incomingMessagesChan <-chan *discoveryMessage - - // All the following fields are guarded by statusMutex - statusMutex sync.Mutex - incomingMessagesError error - state int - eventChan chan<- *Event -} - -type discoveryMessage struct { - EventType string `json:"eventType"` - Message string `json:"message"` - Error bool `json:"error"` - ProtocolVersion int `json:"protocolVersion"` // Used in HELLO command - Ports []*Port `json:"ports"` // Used in LIST command - Port *Port `json:"port"` // Used in add and remove events -} - -func (msg discoveryMessage) String() string { - s := fmt.Sprintf("type: %s", msg.EventType) - if msg.Message != "" { - s = tr("%[1]s, message: %[2]s", s, msg.Message) - } - if msg.ProtocolVersion != 0 { - s = tr("%[1]s, protocol version: %[2]d", s, msg.ProtocolVersion) - } - if len(msg.Ports) > 0 { - s = tr("%[1]s, ports: %[2]s", s, msg.Ports) - } - if msg.Port != nil { - s = tr("%[1]s, port: %[2]s", s, msg.Port) - } - return s -} - -// Port contains metadata about a port to connect to a board. -type Port struct { - Address string `json:"address"` - AddressLabel string `json:"label"` - Protocol string `json:"protocol"` - ProtocolLabel string `json:"protocolLabel"` - HardwareID string `json:"hardwareId,omitempty"` - Properties *properties.Map `json:"properties"` -} - -var tr = i18n.Tr - -// Equals returns true if the given port has the same address and protocol -// of the current port. -func (p *Port) Equals(o *Port) bool { - return p.Address == o.Address && p.Protocol == o.Protocol -} - -// ToRPC converts Port into rpc.Port -func (p *Port) ToRPC() *rpc.Port { - props := p.Properties - if props == nil { - props = properties.NewMap() - } - return &rpc.Port{ - Address: p.Address, - Label: p.AddressLabel, - Protocol: p.Protocol, - ProtocolLabel: p.ProtocolLabel, - HardwareId: p.HardwareID, - Properties: props.AsMap(), - } -} - -// PortFromRPCPort converts an *rpc.Port to a *Port -func PortFromRPCPort(o *rpc.Port) (p *Port) { - if o == nil { - return nil - } - res := &Port{ - Address: o.GetAddress(), - AddressLabel: o.GetLabel(), - Protocol: o.GetProtocol(), - ProtocolLabel: o.GetProtocolLabel(), - HardwareID: o.GetHardwareId(), - } - if o.GetProperties() != nil { - res.Properties = properties.NewFromHashmap(o.GetProperties()) - } - return res -} - -func (p *Port) String() string { - if p == nil { - return "none" - } - return p.Address -} - -// Clone creates a copy of this Port -func (p *Port) Clone() *Port { - if p == nil { - return nil - } - res := *p - if p.Properties != nil { - res.Properties = p.Properties.Clone() - } - return &res -} - -// Event is a pluggable discovery event -type Event struct { - Type string - Port *Port - DiscoveryID string -} - -// New create and connect to the given pluggable discovery -func New(id string, args ...string) *PluggableDiscovery { - return &PluggableDiscovery{ - id: id, - processArgs: args, - state: Dead, - } -} - -// GetID returns the identifier for this discovery -func (disc *PluggableDiscovery) GetID() string { - return disc.id -} - -func (disc *PluggableDiscovery) String() string { - return disc.id -} - -func (disc *PluggableDiscovery) jsonDecodeLoop(in io.Reader, outChan chan<- *discoveryMessage) { - decoder := json.NewDecoder(in) - closeAndReportError := func(err error) { - disc.statusMutex.Lock() - disc.state = Dead - disc.incomingMessagesError = err - disc.statusMutex.Unlock() - close(outChan) - logrus.Errorf("stopped discovery %s decode loop: %v", disc.id, err) - } - - for { - var msg discoveryMessage - if err := decoder.Decode(&msg); errors.Is(err, io.EOF) { - // This is fine, we exit gracefully - disc.statusMutex.Lock() - disc.state = Dead - disc.incomingMessagesError = err - disc.statusMutex.Unlock() - close(outChan) - return - } else if err != nil { - closeAndReportError(err) - return - } - logrus.Infof("from discovery %s received message %s", disc.id, msg) - if msg.EventType == "add" { - if msg.Port == nil { - closeAndReportError(errors.New(tr("invalid 'add' message: missing port"))) - return - } - disc.statusMutex.Lock() - if disc.eventChan != nil { - disc.eventChan <- &Event{"add", msg.Port, disc.GetID()} - } - disc.statusMutex.Unlock() - } else if msg.EventType == "remove" { - if msg.Port == nil { - closeAndReportError(errors.New(tr("invalid 'remove' message: missing port"))) - return - } - disc.statusMutex.Lock() - if disc.eventChan != nil { - disc.eventChan <- &Event{"remove", msg.Port, disc.GetID()} - } - disc.statusMutex.Unlock() - } else { - outChan <- &msg - } - } -} - -// State returns the current state of this PluggableDiscovery -func (disc *PluggableDiscovery) State() int { - disc.statusMutex.Lock() - defer disc.statusMutex.Unlock() - return disc.state -} - -func (disc *PluggableDiscovery) waitMessage(timeout time.Duration) (*discoveryMessage, error) { - select { - case msg := <-disc.incomingMessagesChan: - if msg == nil { - return nil, disc.incomingMessagesError - } - return msg, nil - case <-time.After(timeout): - return nil, fmt.Errorf(tr("timeout waiting for message from %s"), disc.id) - } -} - -func (disc *PluggableDiscovery) sendCommand(command string) error { - logrus.Infof("sending command %s to discovery %s", strings.TrimSpace(command), disc) - data := []byte(command) - for { - n, err := disc.outgoingCommandsPipe.Write(data) - if err != nil { - return err - } - if n == len(data) { - return nil - } - data = data[n:] - } -} - -func (disc *PluggableDiscovery) runProcess() error { - logrus.Infof("starting discovery %s process", disc.id) - proc, err := paths.NewProcess(nil, disc.processArgs...) - if err != nil { - return err - } - stdout, err := proc.StdoutPipe() - if err != nil { - return err - } - stdin, err := proc.StdinPipe() - if err != nil { - return err - } - disc.outgoingCommandsPipe = stdin - - messageChan := make(chan *discoveryMessage) - disc.incomingMessagesChan = messageChan - go disc.jsonDecodeLoop(stdout, messageChan) - - if err := proc.Start(); err != nil { - return err - } - - disc.statusMutex.Lock() - defer disc.statusMutex.Unlock() - disc.process = proc - disc.state = Alive - logrus.Infof("started discovery %s process", disc.id) - return nil -} - -func (disc *PluggableDiscovery) killProcess() error { - logrus.Infof("killing discovery %s process", disc.id) - if disc.process != nil { - if err := disc.process.Kill(); err != nil { - return err - } - if err := disc.process.Wait(); err != nil { - return err - } - } - disc.statusMutex.Lock() - defer disc.statusMutex.Unlock() - disc.stopSync() - disc.state = Dead - logrus.Infof("killed discovery %s process", disc.id) - return nil -} - -// Run starts the discovery executable process and sends the HELLO command to the discovery to agree on the -// pluggable discovery protocol. This must be the first command to run in the communication with the discovery. -// If the process is started but the HELLO command fails the process is killed. -func (disc *PluggableDiscovery) Run() (err error) { - if err = disc.runProcess(); err != nil { - return err - } - - defer func() { - // If the discovery process is started successfully but the HELLO handshake - // fails the discovery is an unusable state, we kill the process to avoid - // further issues down the line. - if err == nil { - return - } - if err := disc.killProcess(); err != nil { - // Log failure to kill the process, ideally that should never happen - // but it's best to know it if it does - logrus.Errorf("Killing discovery %s after unsuccessful start: %s", disc.id, err) - } - }() - - if err = disc.sendCommand("HELLO 1 \"arduino-cli " + version.VersionInfo.VersionString + "\"\n"); err != nil { - return err - } - if msg, err := disc.waitMessage(time.Second * 10); err != nil { - return fmt.Errorf(tr("calling %[1]s: %[2]w"), "HELLO", err) - } else if msg.EventType != "hello" { - return errors.New(tr("communication out of sync, expected '%[1]s', received '%[2]s'", "hello", msg.EventType)) - } else if msg.Error { - return errors.New(tr("command failed: %s", msg.Message)) - } else if strings.ToUpper(msg.Message) != "OK" { - return errors.New(tr("communication out of sync, expected '%[1]s', received '%[2]s'", "OK", msg.Message)) - } else if msg.ProtocolVersion > 1 { - return errors.New(tr("protocol version not supported: requested 1, got %d", msg.ProtocolVersion)) - } - disc.statusMutex.Lock() - defer disc.statusMutex.Unlock() - disc.state = Idling - return nil -} - -// Start initializes and start the discovery internal subroutines. This command must be -// called before List or StartSync. -func (disc *PluggableDiscovery) Start() error { - if err := disc.sendCommand("START\n"); err != nil { - return err - } - if msg, err := disc.waitMessage(time.Second * 10); err != nil { - return errors.New(tr("calling %[1]s: %[2]w", "START", err)) - } else if msg.EventType != "start" { - return errors.New(tr("communication out of sync, expected '%[1]s', received '%[2]s'", "start", msg.EventType)) - } else if msg.Error { - return errors.New(tr("command failed: %s", msg.Message)) - } else if strings.ToUpper(msg.Message) != "OK" { - return errors.New(tr("communication out of sync, expected '%[1]s', received '%[2]s'", "OK", msg.Message)) - } - disc.statusMutex.Lock() - defer disc.statusMutex.Unlock() - disc.state = Running - return nil -} - -// Stop stops the discovery internal subroutines and possibly free the internally -// used resources. This command should be called if the client wants to pause the -// discovery for a while. -func (disc *PluggableDiscovery) Stop() error { - if err := disc.sendCommand("STOP\n"); err != nil { - return err - } - if msg, err := disc.waitMessage(time.Second * 10); err != nil { - return errors.New(tr("calling %[1]s: %[2]w", "STOP", err)) - } else if msg.EventType != "stop" { - return errors.New(tr("communication out of sync, expected '%[1]s', received '%[2]s'", "stop", msg.EventType)) - } else if msg.Error { - return errors.New(tr("command failed: %s", msg.Message)) - } else if strings.ToUpper(msg.Message) != "OK" { - return errors.New(tr("communication out of sync, expected '%[1]s', received '%[2]s'", "OK", msg.Message)) - } - disc.statusMutex.Lock() - defer disc.statusMutex.Unlock() - disc.stopSync() - disc.state = Idling - return nil -} - -func (disc *PluggableDiscovery) stopSync() { - if disc.eventChan != nil { - disc.eventChan <- &Event{"stop", nil, disc.GetID()} - close(disc.eventChan) - disc.eventChan = nil - } -} - -// Quit terminates the discovery. No more commands can be accepted by the discovery. -func (disc *PluggableDiscovery) Quit() { - _ = disc.sendCommand("QUIT\n") - if _, err := disc.waitMessage(time.Second * 5); err != nil { - logrus.Errorf("Quitting discovery %s: %s", disc.id, err) - } - disc.stopSync() - disc.killProcess() -} - -// List executes an enumeration of the ports and returns a list of the available -// ports at the moment of the call. -func (disc *PluggableDiscovery) List() ([]*Port, error) { - if err := disc.sendCommand("LIST\n"); err != nil { - return nil, err - } - if msg, err := disc.waitMessage(time.Second * 10); err != nil { - return nil, errors.New(tr("calling %[1]s: %[2]w", "LIST", err)) - } else if msg.EventType != "list" { - return nil, errors.New(tr("communication out of sync, expected '%[1]s', received '%[2]s'", "list", msg.EventType)) - } else if msg.Error { - return nil, errors.New(tr("command failed: %s", msg.Message)) - } else { - return msg.Ports, nil - } -} - -// StartSync puts the discovery in "events" mode: the discovery will send "add" -// and "remove" events each time a new port is detected or removed respectively. -// After calling StartSync an initial burst of "add" events may be generated to -// report all the ports available at the moment of the start. -// It also creates a channel used to receive events from the pluggable discovery. -// The event channel must be consumed as quickly as possible since it may block the -// discovery if it becomes full. The channel size is configurable. -func (disc *PluggableDiscovery) StartSync(size int) (<-chan *Event, error) { - disc.statusMutex.Lock() - defer disc.statusMutex.Unlock() - - if err := disc.sendCommand("START_SYNC\n"); err != nil { - return nil, err - } - - if msg, err := disc.waitMessage(time.Second * 10); err != nil { - return nil, errors.New(tr("calling %[1]s: %[2]w", "START_SYNC", err)) - } else if msg.EventType != "start_sync" { - return nil, errors.New(tr("communication out of sync, expected '%[1]s', received '%[2]s'", "start_sync", msg.EventType)) - } else if msg.Error { - return nil, errors.New(tr("command failed: %s", msg.Message)) - } else if strings.ToUpper(msg.Message) != "OK" { - return nil, errors.New(tr("communication out of sync, expected '%[1]s', received '%[2]s'", "OK", msg.Message)) - } - - disc.state = Syncing - // In case there is already an existing event channel in use we close it before creating a new one. - disc.stopSync() - c := make(chan *Event, size) - disc.eventChan = c - return c, nil -} diff --git a/internal/arduino/discovery/discovery_client/main.go b/internal/arduino/discovery/discovery_client/main.go index f908a791a31..98890c9b31f 100644 --- a/internal/arduino/discovery/discovery_client/main.go +++ b/internal/arduino/discovery/discovery_client/main.go @@ -22,7 +22,6 @@ import ( "os" "sort" - "github.com/arduino/arduino-cli/internal/arduino/discovery" "github.com/arduino/arduino-cli/internal/arduino/discovery/discoverymanager" "github.com/sirupsen/logrus" ) @@ -35,8 +34,7 @@ func main() { logrus.SetLevel(logrus.ErrorLevel) dm := discoverymanager.New() for _, discCmd := range os.Args[1:] { - disc := discovery.New(discCmd, discCmd) - dm.Add(disc) + dm.Add(discCmd, discCmd) } dm.Start() diff --git a/internal/arduino/discovery/discovery_test.go b/internal/arduino/discovery/discovery_test.go deleted file mode 100644 index 0705f453829..00000000000 --- a/internal/arduino/discovery/discovery_test.go +++ /dev/null @@ -1,73 +0,0 @@ -// This file is part of arduino-cli. -// -// Copyright 2020 ARDUINO SA (http://www.arduino.cc/) -// -// This software is released under the GNU General Public License version 3, -// which covers the main part of arduino-cli. -// The terms of this license can be found at: -// https://www.gnu.org/licenses/gpl-3.0.en.html -// -// You can be released from the requirements of the above licenses by purchasing -// a commercial license. Buying such a license is mandatory if you want to -// modify or otherwise use the software for commercial activities involving the -// Arduino software without disclosing the source code of your own applications. -// To purchase a commercial license, send an email to license@arduino.cc. - -package discovery - -import ( - "io" - "testing" - "time" - - "github.com/arduino/go-paths-helper" - "github.com/stretchr/testify/require" -) - -func TestDiscoveryStdioHandling(t *testing.T) { - // Build `cat` helper inside testdata/cat - builder, err := paths.NewProcess(nil, "go", "build") - require.NoError(t, err) - builder.SetDir("testdata/cat") - require.NoError(t, builder.Run()) - - // Run cat and test if streaming json works as expected - disc := New("test", "testdata/cat/cat") // copy stdin to stdout - - err = disc.runProcess() - require.NoError(t, err) - - _, err = disc.outgoingCommandsPipe.Write([]byte(`{ "eventType":`)) // send partial JSON - require.NoError(t, err) - msg, err := disc.waitMessage(time.Millisecond * 100) - require.Error(t, err) - require.Nil(t, msg) - - _, err = disc.outgoingCommandsPipe.Write([]byte(`"ev1" }{ `)) // complete previous json and start another one - require.NoError(t, err) - - msg, err = disc.waitMessage(time.Millisecond * 100) - require.NoError(t, err) - require.NotNil(t, msg) - require.Equal(t, "ev1", msg.EventType) - - msg, err = disc.waitMessage(time.Millisecond * 100) - require.Error(t, err) - require.Nil(t, msg) - - _, err = disc.outgoingCommandsPipe.Write([]byte(`"eventType":"ev2" }`)) // complete previous json - require.NoError(t, err) - - msg, err = disc.waitMessage(time.Millisecond * 100) - require.NoError(t, err) - require.NotNil(t, msg) - require.Equal(t, "ev2", msg.EventType) - - require.Equal(t, disc.State(), Alive) - - err = disc.outgoingCommandsPipe.(io.ReadCloser).Close() - require.NoError(t, err) - time.Sleep(time.Millisecond * 100) - - require.Equal(t, disc.State(), Dead) -} diff --git a/internal/arduino/discovery/discoverymanager/discoverymanager.go b/internal/arduino/discovery/discoverymanager/discoverymanager.go index c1a5f55bd46..831a332545f 100644 --- a/internal/arduino/discovery/discoverymanager/discoverymanager.go +++ b/internal/arduino/discovery/discoverymanager/discoverymanager.go @@ -21,8 +21,9 @@ import ( "sync" "time" - "github.com/arduino/arduino-cli/internal/arduino/discovery" + "github.com/arduino/arduino-cli/internal/cli/configuration" "github.com/arduino/arduino-cli/internal/i18n" + discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2" "github.com/sirupsen/logrus" ) @@ -34,9 +35,9 @@ import ( // is called. type DiscoveryManager struct { discoveriesMutex sync.Mutex - discoveries map[string]*discovery.PluggableDiscovery // all registered PluggableDiscovery - discoveriesRunning bool // set to true once discoveries are started - feed chan *discovery.Event // all events will pass through this channel + discoveries map[string]*discovery.Client // all registered PluggableDiscovery + discoveriesRunning bool // set to true once discoveries are started + feed chan *discovery.Event // all events will pass through this channel watchersMutex sync.Mutex watchers map[*PortWatcher]bool // all registered Watcher watchersCache map[string]map[string]*discovery.Event // this is a cache of all active ports @@ -47,7 +48,7 @@ var tr = i18n.Tr // New creates a new DiscoveryManager func New() *DiscoveryManager { return &DiscoveryManager{ - discoveries: map[string]*discovery.PluggableDiscovery{}, + discoveries: map[string]*discovery.Client{}, watchers: map[*PortWatcher]bool{}, feed: make(chan *discovery.Event, 50), watchersCache: map[string]map[string]*discovery.Event{}, @@ -65,7 +66,7 @@ func (dm *DiscoveryManager) Clear() { logrus.Infof("Closed and removed discovery %s", d.GetID()) } } - dm.discoveries = map[string]*discovery.PluggableDiscovery{} + dm.discoveries = map[string]*discovery.Client{} } // IDs returns the list of discoveries' ids in this DiscoveryManager @@ -101,7 +102,7 @@ func (dm *DiscoveryManager) Start() []error { var wg sync.WaitGroup for _, d := range dm.discoveries { wg.Add(1) - go func(d *discovery.PluggableDiscovery) { + go func(d *discovery.Client) { if err := dm.startDiscovery(d); err != nil { errsLock.Lock() errs = append(errs, err) @@ -117,7 +118,14 @@ func (dm *DiscoveryManager) Start() []error { } // Add adds a discovery to the list of managed discoveries -func (dm *DiscoveryManager) Add(d *discovery.PluggableDiscovery) error { +func (dm *DiscoveryManager) Add(id string, args ...string) error { + d := discovery.NewClient(id, args...) + d.SetLogger(logrus.WithField("discovery", id)) + d.SetUserAgent(configuration.UserAgent(configuration.Settings)) + return dm.add(d) +} + +func (dm *DiscoveryManager) add(d *discovery.Client) error { dm.discoveriesMutex.Lock() defer dm.discoveriesMutex.Unlock() @@ -178,7 +186,7 @@ func (dm *DiscoveryManager) Watch() (*PortWatcher, error) { return watcher, nil } -func (dm *DiscoveryManager) startDiscovery(d *discovery.PluggableDiscovery) (discErr error) { +func (dm *DiscoveryManager) startDiscovery(d *discovery.Client) (discErr error) { defer func() { // If this function returns an error log it if discErr != nil { @@ -194,7 +202,7 @@ func (dm *DiscoveryManager) startDiscovery(d *discovery.PluggableDiscovery) (dis return fmt.Errorf("%s: %s", tr("starting discovery %s", d.GetID()), err) } - go func(d *discovery.PluggableDiscovery) { + go func(d *discovery.Client) { // Transfer all incoming events from this discovery to the feed channel for ev := range eventCh { dm.feed <- ev @@ -281,6 +289,6 @@ func (dm *DiscoveryManager) List() []*discovery.Port { // AddAllDiscoveriesFrom transfers discoveries from src to the receiver func (dm *DiscoveryManager) AddAllDiscoveriesFrom(src *DiscoveryManager) { for _, d := range src.discoveries { - dm.Add(d) + dm.add(d) } } diff --git a/internal/arduino/discovery/testdata/cat/.gitignore b/internal/arduino/discovery/testdata/cat/.gitignore deleted file mode 100644 index a7053b145c4..00000000000 --- a/internal/arduino/discovery/testdata/cat/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -cat -cat.exe diff --git a/internal/arduino/discovery/testdata/cat/main.go b/internal/arduino/discovery/testdata/cat/main.go deleted file mode 100644 index 7f77910fe27..00000000000 --- a/internal/arduino/discovery/testdata/cat/main.go +++ /dev/null @@ -1,28 +0,0 @@ -// This file is part of arduino-cli. -// -// Copyright 2023 ARDUINO SA (http://www.arduino.cc/) -// -// This software is released under the GNU General Public License version 3, -// which covers the main part of arduino-cli. -// The terms of this license can be found at: -// https://www.gnu.org/licenses/gpl-3.0.en.html -// -// You can be released from the requirements of the above licenses by purchasing -// a commercial license. Buying such a license is mandatory if you want to -// modify or otherwise use the software for commercial activities involving the -// Arduino software without disclosing the source code of your own applications. -// To purchase a commercial license, send an email to license@arduino.cc. - -// Echo stdin to stdout. -// This program is used for testing purposes, to make it available on all -// OS a tool equivalent to UNIX "cat". -package main - -import ( - "io" - "os" -) - -func main() { - io.Copy(os.Stdout, os.Stdin) -} diff --git a/rpc/cc/arduino/cli/commands/v1/common.go b/rpc/cc/arduino/cli/commands/v1/common.go index 529c6dfdfb4..2e1464c3fb9 100644 --- a/rpc/cc/arduino/cli/commands/v1/common.go +++ b/rpc/cc/arduino/cli/commands/v1/common.go @@ -18,6 +18,8 @@ package commands import ( "sort" + "github.com/arduino/go-properties-orderedmap" + discovery "github.com/arduino/pluggable-discovery-protocol-handler/v2" semver "go.bug.st/relaxed-semver" ) @@ -98,3 +100,37 @@ func (s *PlatformSummary) GetSortedReleases() []*PlatformRelease { }) return res } + +// DiscoveryPortToRPC converts a *discovery.Port into an *rpc.Port +func DiscoveryPortToRPC(p *discovery.Port) *Port { + props := p.Properties + if props == nil { + props = properties.NewMap() + } + return &Port{ + Address: p.Address, + Label: p.AddressLabel, + Protocol: p.Protocol, + ProtocolLabel: p.ProtocolLabel, + HardwareId: p.HardwareID, + Properties: props.AsMap(), + } +} + +// DiscoveryPortFromRPCPort converts an *rpc.Port into a *discovery.Port +func DiscoveryPortFromRPCPort(o *Port) (p *discovery.Port) { + if o == nil { + return nil + } + res := &discovery.Port{ + Address: o.GetAddress(), + AddressLabel: o.GetLabel(), + Protocol: o.GetProtocol(), + ProtocolLabel: o.GetProtocolLabel(), + HardwareID: o.GetHardwareId(), + } + if o.GetProperties() != nil { + res.Properties = properties.NewFromHashmap(o.GetProperties()) + } + return res +}