From bbdcf094dc414a146adfe144d3f1f2bfc47c48a9 Mon Sep 17 00:00:00 2001 From: Jerry Date: Fri, 15 Jan 2021 23:30:01 +0800 Subject: [PATCH] push to github --- .gitignore | 138 ++++++ LICENSE | 674 ++++++++++++++++++++++++++++++ README.md | 3 + setup.py | 30 ++ src/pacroller/__init__.py | 0 src/pacroller/checker.py | 284 +++++++++++++ src/pacroller/config.json.example | 16 + src/pacroller/config.py | 34 ++ src/pacroller/known_output.py | 41 ++ src/pacroller/main.py | 208 +++++++++ src/pacroller/utils.py | 85 ++++ 11 files changed, 1513 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 setup.py create mode 100644 src/pacroller/__init__.py create mode 100644 src/pacroller/checker.py create mode 100644 src/pacroller/config.json.example create mode 100644 src/pacroller/config.py create mode 100644 src/pacroller/known_output.py create mode 100644 src/pacroller/main.py create mode 100644 src/pacroller/utils.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a81c8ee --- /dev/null +++ b/.gitignore @@ -0,0 +1,138 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +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: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c72fcb6 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Pacroller + +W.I.P. diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..5eae905 --- /dev/null +++ b/setup.py @@ -0,0 +1,30 @@ +import setuptools + +with open("README.md", "r", encoding="utf-8") as fh: + long_description = fh.read() + +setuptools.setup( + name="pacroller", + version="0.0.1", + author="Jerry Xiao", + author_email="pacroller@mail.jerryxiao.cc", + description="unattended pacman upgrade for archlinux", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://github.com/isjerryxiao/pacroller", + packages=setuptools.find_packages('src'), + package_dir={'': 'src'}, + classifiers=[ + "Development Status :: 3 - Alpha" + "Programming Language :: Python :: 3", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: POSIX :: Linux", + ], + python_requires='>=3.8', + entry_points={ + 'console_scripts': [ + 'pacroller=pacroller.main:main' + ] + }, + install_requires=['pyalpm'] +) diff --git a/src/pacroller/__init__.py b/src/pacroller/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/pacroller/checker.py b/src/pacroller/checker.py new file mode 100644 index 0000000..756aec2 --- /dev/null +++ b/src/pacroller/checker.py @@ -0,0 +1,284 @@ +import logging +from typing import List, Tuple, Dict +from pathlib import Path +from re import compile, Pattern, match +from pacroller.utils import pacman_time_to_timestamp +from pacroller.known_output import KNOWN_HOOK_OUTPUT, KNOWN_PACKAGE_OUTPUT +from pacroller.config import IGNORED_PACNEW +from time import ctime, time + +logger = logging.getLogger() + +REGEX = { + 's_process_pkg_changes': r':: Processing package changes\.\.\.', + 's_post-transaction': r':: Running post-transaction hooks\.\.\.$', + 's_optdepend': r'(?i)(?:new )?optional dependencies for (.+)$', + 's_optdepend_list': r' (.+): (?:.+)', + 's_upgrade_pkg': r'upgrading (.+)\.\.\.', + 'l_running_hook': r'running \'(.+)\'\.\.\.', + 'l_transaction_start': r'transaction started', + 'l_transaction_complete': r'transaction completed', + 'l_upgrade': r'upgraded (.+) \((.+) -> (.+)\)', + 'l_install': r'installed (.+) \((.+)\)', + 'l_remove': r'removed (.+) \((.+)\)', + 'l_pacnew': r'warning: (.+) installed as (.+\.pacnew)', +} +for k, v in REGEX.items(): + REGEX[k] = compile(v) +REGEX: Dict[str, Pattern] # get through lint + +class checkReport: + def __init__(self, info: List[str] = None, warn: List[str] = None, + crit: List[str] = None, changes: List[Tuple[str]] = None, + date: int = int(time)) -> None: + self._info = info or list() + self._warn = warn or list() + self._crit = crit or list() + self._changes = changes or list() + self._date = date + def to_dict(self) -> dict: + return {'info': self._info, 'warn': self._warn, 'crit': self._crit, 'changes': self._changes, 'date': self._date} + def summary(self, verbose=True, show_package=False, indent=2) -> str: + ret = [f"Pacroller Report at {ctime(self._date)}",] + if self._crit: + ret.append("Collected Errors:") + ret.extend([" " * indent + i for i in self._crit]) + if self._warn: + ret.append("Collected Warnings:") + ret.extend([" " * indent + i for i in self._warn]) + if verbose and self._info: + ret.append("Collected Info:") + ret.extend([" " * indent + i for i in self._info]) + if show_package: + pkg_ret = list() + installed = list() + upgraded = list() + removed = list() + for c in self._changes: + name, old, new = c + if old and new: + upgraded.append(c) + elif old is None: + installed.append(c) + elif new is None: + removed.append(c) + else: + raise RuntimeError(f"{c=}") + if verbose: + for c in upgraded: + name, old, new = c + pkg_ret.append(f'upgrade {name} from {old} to {new}') + for c in installed: + name, _, new = c + pkg_ret.append(f'install {name} {new}') + for c in removed: + name, old, _ = c + pkg_ret.append(f'remove {name} {old}') + else: + up, ins, rem = [[c[0] for c in x] for x in (upgraded, installed, removed)] + if up: + pkg_ret.append(f'upgrade: {" ".join(up)}') + if ins: + pkg_ret.append(f'install: {" ".join(ins)}') + if rem: + pkg_ret.append(f'remove: {" ".join(rem)}') + if pkg_ret: + ret.append("Package changes:") + ret.extend([" " * indent + i for i in pkg_ret]) + if len(ret) == 1: + ret.append('all systems go') + return "\n".join(ret) + def info(self, text: str) -> None: + logger.debug(f'report info {text}') + self._info.append(text) + def warn(self, text: str) -> None: + logger.debug(f'report warn {text}') + self._warn.append(text) + def crit(self, text: str) -> None: + logger.debug(f'report crit {text}') + self._crit.append(text) + def change(self, name: str, old: str, new: str) -> None: + logger.debug(f'report change {name=} {old=} {new=}') + self._changes.append((name, old, new)) + +def log_checker(stdout: List[str], log: List[str], debug=False) -> checkReport: + if debug: + Path('/tmp/pacroller-stdout.log').write_text('\n'.join(stdout)) + Path('/tmp/pacroller-pacman.log').write_text('\n'.join(log)) + report = checkReport() + _stdout_parser(stdout, report) + _log_parser(log, report) + return report + +def _stdout_parser(stdout: List[str], report: checkReport) -> None: + ln = 0 + in_package_change = False + while ln < len(stdout): + line = stdout[ln] + if REGEX['s_process_pkg_changes'].match(line): + in_package_change = True + ln += 1 + continue + elif REGEX['s_post-transaction'].match(line): + in_package_change = False + # we don't care anything below this + logger.debug(f'break {line=}') + break + if in_package_change: + if _m := REGEX['s_optdepend'].match(line): + logger.debug(f'optdepend start {line=}') + pkg = _m.groups()[0] + optdeps = list() + while True: + ln += 1 + line = stdout[ln] + if _m := REGEX['s_optdepend_list'].match(line): + logger.debug(f'optdepend found {line=}') + optdeps.append(_m.groups()[0]) + else: + logger.debug(f'optdepend end {line=}') + ln -= 1 + break + report.info(f'new optional dependencies for {pkg}: {", ".join(optdeps)}') + else: + # then it should be upgrade message + if _m := REGEX['s_upgrade_pkg'].match(line): + logger.debug(f's_upgrade_pkg {line=}') + else: + report.crit(f'{line=} is unknown') + else: + logger.debug(f'skip {line=}') + ln += 1 + +def _split_log_line(line: str) -> Tuple[int, str, str]: + (time, source, msg) = line.split(' ', maxsplit=2) + time: int = pacman_time_to_timestamp(time.strip('[]')) + source = source.strip('[]') + return (time, source, msg) +def _log_parser(log: List[str], report: checkReport) -> None: + # preprocess + if log[-1] == '': + log = log[:-1] + nlog = list() + for line in log: + try: + _split_log_line(line) + nlog.append(line) + except Exception: + logger.debug(f"preprocess logs: should not be on a new line, {line=}") + assert nlog + nlog[-1] = f"{nlog[-1]} {line}" + log = nlog + ln = 0 + in_transaction = 0 + while ln < len(log): + line = log[ln] + (_, source, msg) = _split_log_line(line) + if source == 'PACMAN': + pass # nothing concerning here + elif source == 'ALPM': + if _m := REGEX['l_upgrade'].match(msg): + report.change(*(_m.groups())) + elif _m := REGEX['l_install'].match(msg): + name, new = _m.groups() + report.change(name, None, new) + elif _m := REGEX['l_remove'].match(msg): + name, old = _m.groups() + report.change(name, old, None) + elif REGEX['l_transaction_start'].match(msg): + logger.debug('transaction_start') + if in_transaction == 0: + in_transaction = 1 + else: + report.crit(f'{ln=} duplicate transaction_start') + elif REGEX['l_transaction_complete'].match(msg): + logger.debug('transaction_complete') + if in_transaction == 1: + in_transaction = 2 + else: + report.crit(f'{ln=} transaction_complete while {in_transaction=}') + elif _m := REGEX['l_pacnew'].match(msg): + orig, _ = _m.groups() + if orig in IGNORED_PACNEW: + logger.debug(f'pacnew ignored for {orig}') + else: + report.warn(f'please merge pacnew for {orig}') + elif _m := REGEX['l_running_hook'].match(msg): + hook_name = _m.groups()[0] + logger.debug(f'hook start {hook_name=}') + while True: + ln += 1 + if ln >= len(log): + logger.debug(f'hook end {hook_name=} {msg=}') + ln -= 1 + break + line = log[ln] + (_, source, msg) = _split_log_line(line) + if source == 'ALPM-SCRIPTLET': + for r in (*(KNOWN_HOOK_OUTPUT.get('', [])), *(KNOWN_HOOK_OUTPUT.get(hook_name, []))): + if match(r, msg): + logger.debug(f'hook output match {hook_name=} {msg=} {r=}') + break + else: + report.warn(f'hook {hook_name} says {msg}') + else: + logger.debug(f'hook end {hook_name=} {msg=}') + ln -= 1 + break + else: + report.crit(f'ALPM {line=} is unknown') + elif source == 'ALPM-SCRIPTLET': + (_, _, _pmsg) = _split_log_line(log[ln-1]) + if _m := REGEX['s_upgrade_pkg'].match(_pmsg): + pkg, *_ = _m.groups() + elif _m := REGEX['l_install'].match(_pmsg): + pkg, *_ = _m.groups() + elif _m := REGEX['l_remove'].match(_pmsg): + pkg, *_ = _m.groups() + else: + report.crit(f'{line=} has unknown SCRIPTLET output') + logger.debug(f'.install start {pkg=}') + while True: + ln += 1 + line = log[ln] + (_, source, msg) = _split_log_line(line) + if source == 'ALPM-SCRIPTLET': + for r in (*(KNOWN_PACKAGE_OUTPUT.get('', [])), *(KNOWN_PACKAGE_OUTPUT.get(pkg, []))): + if match(r, msg): + logger.debug(f'.install output match {pkg=} {msg=} {r=}') + break + else: + report.warn(f'package {pkg} says {msg}') + else: + logger.debug(f'.install end {pkg=} {msg=}') + ln -= 1 + break + else: + report.crit(f'{line=} has unknown source') + ln += 1 + +def sync_err_is_net(output: str) -> bool: + ''' check if a sync failure is caused by network ''' + output = output.strip().split('\n') + if output[-1] == 'error: failed to synchronize all databases': + return True + else: + return False +def upgrade_err_is_net(output: str) -> bool: + ''' check if an upgrade failure is caused by network ''' + output = output.strip().split('\n') + if len(output) >= 2 and 'warning: failed to retrieve some files' in output and \ + 'error: failed to commit transaction (failed to retrieve some files)' in output: + return True + else: + return False + +if __name__ == '__main__': + logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(module)s - %(funcName)s - %(levelname)s - %(message)s') + stdout = Path('/tmp/pacroller-stdout.log').read_text().split('\n') + log = Path('/tmp/pacroller-pacman.log').read_text().split('\n') + report = checkReport() + _stdout_parser(stdout, report) + _log_parser(log, report) + print(report.to_dict()) + print(report.summary(show_package=True, verbose=True)) diff --git a/src/pacroller/config.json.example b/src/pacroller/config.json.example new file mode 100644 index 0000000..d52f4b7 --- /dev/null +++ b/src/pacroller/config.json.example @@ -0,0 +1,16 @@ +{ + "upgrade_timeout": 3600, + "network_retry": 5, + "custom_sync": false, + "sync_shell": "sync.sh", + "extra_safe": false, + "shell": "/bin/bash", + "hold": { + "linux": "(.*)", + "python": "[0-9]+[.]([0-9]+)[.][0-9]+[-][0-9]+" + } + 'ignored_pacnew': [ + '/etc/locale.gen', + '/etc/pacman.d/mirrorlist' + ] +} diff --git a/src/pacroller/config.py b/src/pacroller/config.py new file mode 100644 index 0000000..09f0d56 --- /dev/null +++ b/src/pacroller/config.py @@ -0,0 +1,34 @@ +import json +from pathlib import Path + +CONFIG_DIR = Path('/etc/pacroller') +CONFIG_FILE = 'config.json' +LIB_DIR = Path('/var/lib/pacroller') +DB_FILE = 'db' +PACMAN_CONFIG = '/etc/pacman.conf' +PACMAN_LOG = '/var/log/pacman.log' +assert LIB_DIR.is_dir() + +if (cfg := (CONFIG_DIR / CONFIG_FILE)).exists(): + _config: dict = json.loads(cfg.read_text()) +else: + _config = dict() + +UPGRADE_TIMEOUT = int(_config.get('upgrade_timeout', 3600)) +NETWORK_RETRY = int(_config.get('network_retry', 5)) +assert UPGRADE_TIMEOUT > 0 and NETWORK_RETRY > 0 + +CUSTOM_SYNC = bool(_config.get('custom_sync', False)) +SYNC_SH = CONFIG_DIR / str(_config.get('sync_shell', "sync.sh")) +if CUSTOM_SYNC: + assert SYNC_SH.exists() + +EXTRA_SAFE = bool(_config.get('extra_safe', False)) +SHELL = str(_config.get('shell', '/bin/bash')) + +HOLD = _config.get('hold', dict()) +for (k, v) in HOLD: + assert isinstance(k, str) and isinstance(v, str) + +IGNORED_PACNEW = _config.get('ignored_pacnew', list()) +assert isinstance(IGNORED_PACNEW, list) diff --git a/src/pacroller/known_output.py b/src/pacroller/known_output.py new file mode 100644 index 0000000..cacebb6 --- /dev/null +++ b/src/pacroller/known_output.py @@ -0,0 +1,41 @@ +KNOWN_HOOK_OUTPUT = { + '': [], + '20-systemd-sysusers.hook': [ + r'(?i)creating group .+', + r'(?i)creating user .+', + ], + '30-systemd-sysctl.hook': [ + r'Not setting (.+) \(explicit setting exists\)\.', + ], + '90-mkinitcpio-install.hook': [ + r'==> Building image from preset: .+', + r'==> Starting build: .+', + r'==> WARNING: Possibly missing firmware for module: .+', + r'==> Generating module dependencies', + r'==> Creating (?:.+)-compressed initcpio image: .+', + r'==> Image generation successful.*', + r'[ ]+-> .+', + ] +} + +_keyring_output = [ + r'==> Appending keys from .+', + r'==> Locally signing trusted keys in keyring\.\.\.', + r'==> Importing owner trust values\.\.\.', + r'==> Disabling revoked keys in keyring\.\.\.', + r'==> Updating trust database\.\.\.', + r'gpg: next trustdb check due at .+', + r'gpg: public key .+ is .+ than the signature', + r'gpg: Warning: using insecure memory!', + r'[ ]+-> .+', +] + +KNOWN_PACKAGE_OUTPUT = { + '': [], + 'archlinux-keyring': _keyring_output, + 'archlinuxcn-keyring': [ + *_keyring_output, + r'gpg: marginals needed:.+ completes needed:.+ trust model: pgp', + r'gpg: depth:.+ valid:.+ signed:.+ trust:.+, .+, .+, .+, .+, .+', + ] +} diff --git a/src/pacroller/main.py b/src/pacroller/main.py new file mode 100644 index 0000000..3f0c34e --- /dev/null +++ b/src/pacroller/main.py @@ -0,0 +1,208 @@ +#!/usr/bin/python + +from pathlib import Path +import subprocess +import logging +from re import match +import json +from os import environ +import traceback +import pyalpm +import pycman +from typing import List, Iterator +from pacroller.utils import execute_with_io, UnknownQuestionError, back_readline +from pacroller.checker import log_checker, sync_err_is_net, upgrade_err_is_net, checkReport +from pacroller.config import (CONFIG_DIR, CONFIG_FILE, LIB_DIR, DB_FILE, PACMAN_LOG, PACMAN_CONFIG, + UPGRADE_TIMEOUT, NETWORK_RETRY, CUSTOM_SYNC, SYNC_SH, EXTRA_SAFE, SHELL, HOLD) + +logger = logging.getLogger() + +environ['LANG'] = 'en_US.utf8' # required for parsing + +class NonFatal(Exception): + pass +class SyncRetry(NonFatal): + pass +class MaxRetryReached(NonFatal): + pass +class PackageHold(Exception): + pass +class CheckFailed(Exception): + pass + +def sync() -> None: + logger.info('sync start') + if CUSTOM_SYNC: + sync_cmd = [SHELL, SYNC_SH.resolve()] + else: + sync_cmd = ['pacman', '-Sy', '--noprogressbar', '--color', 'never'] + try: + p = subprocess.run( + sync_cmd, + stdin=subprocess.DEVNULL, + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT, + encoding='utf-8', + timeout=300 + ) + except subprocess.CalledProcessError as e: + if sync_err_is_net(e.output): + logger.warning('unable to download databases') + raise SyncRetry() + else: + logger.exception(f'sync failed with {e.returncode=} {e.output=}') + raise + else: + logger.debug(f'sync {p.stdout=}') + logger.info('sync end') + +class alpmCallback: + @staticmethod + def noop() -> None: + pass + def setup_hdl(self, handle: pyalpm.Handle) -> None: + handle.dlcb = self.noop + handle.eventcb = self.noop + handle.questioncb = self.noop + handle.progresscb = self.noop + +def upgrade() -> List[str]: + logger.info('upgrade start') + handle = pycman.config.init_with_config(PACMAN_CONFIG) + localdb = handle.get_localdb() + alpmCallback().setup_hdl(handle) + t = handle.init_transaction() + try: + t.sysupgrade(False) # no downgrade + if len(t.to_add) + len(t.to_remove) == 0: + logger.info('upgrade end, nothing to do') + else: + def examine_upgrade(toadd: List[pyalpm.Package], toremove: List[pyalpm.Package]) -> None: + for pkg in toadd: + localpkg: pyalpm.Package = localdb.get_pkg(pkg.name) + localver = localpkg.version if localpkg else "" + logger.debug(f"will upgrade {pkg.name} from {localver} to {pkg.version}") + if _testreg := HOLD.get(pkg.name): + _m_old = match(_testreg, localver) + _m_new = match(_testreg, pkg.version) + if _m_old and _m_new: + if (o := _m_old.groups()) != (n := _m_new.groups()): + raise PackageHold(f"hold package {pkg.name} is going to be upgraded from {o=} to {n=}") + else: + raise PackageHold(f"cannot match version regex for hold package {pkg.name}") + for pkg in toremove: + logger.debug(f"will remove {pkg.name} version {pkg.version}") + if pkg.name in HOLD: + raise PackageHold(f"attempt to remove {pkg.name} which is set to hold") + examine_upgrade(t.to_add, t.to_remove) + finally: + t.release() + pacman_output = execute_with_io(['pacman', '-Su', '--noprogressbar', '--color', 'never']) + logger.info('upgrade end') + return pacman_output + +def do_system_upgrade(debug=False) -> checkReport: + for _ in range(NETWORK_RETRY): + try: + sync() + except SyncRetry: + pass + else: + break + else: + raise MaxRetryReached(f'sync failed {NETWORK_RETRY} times') + + for _ in range(NETWORK_RETRY): + try: + with open(PACMAN_LOG, 'r') as pacman_log: + log_anchor = pacman_log.seek(0, 2) + stdout = upgrade() + except subprocess.CalledProcessError as e: + if upgrade_err_is_net(e.output): + logger.warning('upgrade download failed') + else: + raise + else: + break + else: + raise MaxRetryReached(f'upgrade failed {NETWORK_RETRY} times') + + with open(PACMAN_LOG, 'r') as pacman_log: + pacman_log.seek(log_anchor) + log = pacman_log.read().split('\n') + report = log_checker(stdout, log, debug=debug) + logger.info(report.summary(verbose=True, show_package=False)) + return report + +def write_db(report: checkReport, error: Exception = None) -> None: + with open(LIB_DIR / DB_FILE, 'a') as db: + db.write(json.dumps({'error': repr(error) if error else None, 'report': report.to_dict() if report else None})) + db.write("\n") + +def read_db() -> Iterator[dict]: + if not (LIB_DIR / DB_FILE).exists(): + (LIB_DIR / DB_FILE).touch() + with open(LIB_DIR / DB_FILE, 'rb') as db: + for line in back_readline(db): + if line: + entry = json.loads(line) + yield entry + +def has_previous_error() -> Exception: + for entry in read_db(): + return entry.get('error') + else: + return None + +def main() -> None: + import argparse + parser = argparse.ArgumentParser(description='Pacman Automatic Rolling Helper') + parser.add_argument('action', choices=['run', 'status', 'fail-reset']) + parser.add_argument('-d', '--debug', action='store_true', help='enable debug mode') + parser.add_argument('-v', '--verbose', action='store_true', help='show verbose report') + parser.add_argument('-m', '--max', type=int, default=1, help='Number of upgrades to show') + args = parser.parse_args() + if args.debug: + logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(module)s - %(funcName)s - %(levelname)s - %(message)s') + else: + logging.basicConfig(level=logging.INFO, format='%(levelname)s - %(message)s') + + if args.action == 'run': + if prev_err := has_previous_error(): + logger.error(f'Cannot continue, a previous error {prev_err} is still present. Please resolve this issue and run fail-reset.') + else: + try: + report = do_system_upgrade(args.debug) + except NonFatal: + raise + except Exception as e: + write_db(None, e) + raise + else: + exc = None + if EXTRA_SAFE: + if report._info or report._warn or report._crit: + exc = CheckFailed('manual inspection required') + else: + if report._warn or report._crit: + exc = CheckFailed('manual inspection required') + write_db(report, exc) + elif args.action == 'status': + count = 0 + for entry in read_db(): + if report_dict := entry.get('report'): + count += 1 + report = checkReport(**report_dict) + print(report.summary(verbose=args.verbose, show_package=True)) + if count >= args.max: + break + print() + elif args.action == 'fail-reset': + if prev_err := has_previous_error(): + write_db(None) + logger.info(f'reset previous error {prev_err}') + else: + logger.warning('nothing to do') + +if __name__ == '__main__': + main() diff --git a/src/pacroller/utils.py b/src/pacroller/utils.py new file mode 100644 index 0000000..e2f7be9 --- /dev/null +++ b/src/pacroller/utils.py @@ -0,0 +1,85 @@ +import subprocess +from threading import Thread +import logging +from typing import List, BinaryIO, Iterator +from io import DEFAULT_BUFFER_SIZE +from time import mktime +from datetime import datetime +logger = logging.getLogger() + +class UnknownQuestionError(subprocess.SubprocessError): + def __init__(self, question, output=None): + self.question = question + self.output = output + def __str__(self): + return f"Pacman returned an unknown question {self.question}" + +def execute_with_io(command: List[str]) -> List[str]: + ''' + captures stdout and stderr and + automatically handles [y/n] questions of pacman + ''' + def terminate(p: subprocess.Popen, timeout: int = 30) -> None: + p.terminate() + try: + p.wait(timeout=30) + except subprocess.TimeoutExpired: + logger.critical(f'unable to terminate {p}, killing') + p.kill() + def set_timeout(p: subprocess.Popen, timeout: int) -> None: + try: + p.wait(timeout=timeout) + except subprocess.TimeoutExpired: + logger.exception(f'{timeout=} expired for {p}, terminating') + terminate(p) + else: + logger.debug('set_timeout exit') + p = subprocess.Popen( + command, + stdin=subprocess.PIPE, + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT, + encoding='utf-8' + ) + Thread(target=set_timeout, args=(p, 3600), daemon=True).start() # should be configurable + line = '' + output = '' + while (r := p.stdout.read(1)) != '': + output += r + line += r + if r == '\n': + logger.debug('STDOUT: %s', line[:-1]) + line = '' + elif r == ']': + if line == ':: Proceed with installation? [Y/n]': + p.stdin.write('y\n') + p.stdin.flush() + elif line.lower().endswith('[y/n]'): + terminate(p) + raise UnknownQuestionError(line, output) + + if (ret := p.wait()) != 0: + raise subprocess.CalledProcessError(ret, command, output) + return output.split('\n') + +def pacman_time_to_timestamp(stime: str) -> int: + ''' the format pacman is using seems to be not iso compatible ''' + dt = datetime.strptime(stime, "%Y-%m-%dT%H:%M:%S%z") + return mktime(dt.astimezone().timetuple()) + +def back_readline(fp: BinaryIO) -> Iterator[str]: + pos = fp.seek(0, 2) + if pos == 0: + return + previous = b'' + while pos > 0: + next = max(pos - DEFAULT_BUFFER_SIZE, 0) + fp.seek(next) + got = fp.read(pos - next) + got = got + previous + blines = got.split(b'\n') + while len(blines) > 1: + yield blines.pop(-1).decode('utf-8') + previous = blines[0] + pos = next + yield blines.pop(-1).decode('utf-8')