diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..944f0eb --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +__pycache__ +pytestdebug.log +.idea diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..4471bd3 --- /dev/null +++ b/.yamllint @@ -0,0 +1,37 @@ +--- +# Based on ansible-lint config +extends: default + +ignore: | + env + venv + +rules: + braces: + max-spaces-inside: 1 + level: error + brackets: + max-spaces-inside: 1 + level: error + colons: + max-spaces-after: -1 + level: error + commas: + max-spaces-after: -1 + level: error + comments: disable + comments-indentation: disable + document-start: disable + empty-lines: + max: 3 + level: error + hyphens: + level: error + indentation: disable + key-duplicates: enable + line-length: disable + new-line-at-end-of-file: disable + new-lines: + type: unix + trailing-spaces: disable + truthy: disable diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..667f3e2 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,154 @@ +RETRY = '3' +TIMEOUT = '60' // Adapt it based on the hardware resources and internet connection speed of your Jenkins agent. + +pipeline { + agent { + label 'x86_64 && bm' + } + options { + timestamps() + parallelsAlwaysFailFast() + } + environment { + VAGRANT_NO_COLOR = '1' + } + stages { + stage('EL9') { + matrix { + axes { + axis { + name 'EL9' + values 'oracle9', 'rhel9', 'rocky9' + } + } + stages { + stage('EL9 to AlmaLinux OS 9') { + steps { + retry(RETRY) { + timeout(time: TIMEOUT, unit: 'MINUTES') { + sh script: 'vagrant up $EL9', + label: 'Create EL9 Machine' + sh script: 'vagrant ssh $EL9 -c \"sudo /home/vagrant/almalinux-deploy/almalinux-deploy.sh\"', + label: 'Start AlmaLinux Deploy' + sh script: 'vagrant destroy $EL9 -f', + label: 'Destroy the machine' + } + } + } + } + } + } + } + stage('EL8') { + matrix { + axes { + axis { + name 'EL8' + values 'oracle8', 'rhel8', 'rocky8' + } + } + stages { + stage('EL8 to AlmaLinux 8') { + steps { + retry(RETRY) { + timeout(time: TIMEOUT, unit: 'MINUTES') { + sh script: 'vagrant up $EL8', + label: 'Create EL8 machine' + sh script: 'vagrant ssh $EL8 -c \"sudo /home/vagrant/almalinux-deploy/almalinux-deploy.sh\"', + label: 'Start AlmaLinux Deploy' + sh script: 'vagrant destroy $EL8 -f', + label: 'Destroy the machine' + } + } + } + } + } + } + } + stage('CentOS Stream') { + matrix { + axes { + axis { + name 'CS' + values 'centos8stream', 'centos9stream' + } + } + stages { + stage('CS to AlmaLinux') { + steps { + retry(RETRY) { + timeout(time: TIMEOUT, unit: 'MINUTES') { + sh script: 'vagrant up $CS', + label: 'Create CentOS Stream machine' + sh script: 'vagrant ssh $CS -c \"sudo /home/vagrant/almalinux-deploy/almalinux-deploy.sh -d\"', + label: 'Start AlmaLinux Deploy' + sh script: 'vagrant destroy $CS -f', + label: 'Destroy the machine' + } + } + } + } + } + } + } + stage('EL8.5') { + matrix { + axes { + axis { + name 'EL85' + values 'centos8-5', 'oracle8-5', 'rhel8-5', 'rocky8-5' + } + } + stages { + stage('EL8.5 to AlmaLinux 8') { + steps { + retry(RETRY) { + timeout(time: TIMEOUT, unit: 'MINUTES') { + sh script: 'vagrant up $EL85', + label: 'Create EL8.5 machine' + sh script: 'vagrant ssh $EL85 -c \"sudo /home/vagrant/almalinux-deploy/almalinux-deploy.sh\"', + label: 'Start AlmaLinux Deploy' + sh script: 'vagrant destroy $EL85 -f', + label: 'Destroy the machine' + } + } + } + } + } + } + } + stage('EL8.4') { + matrix { + axes { + axis { + name 'EL84' + values 'centos8-4', 'oracle8-4', 'rhel8-4', 'rocky8-4' + } + } + stages { + stage('EL8.4 to AlmaLinux 8') { + steps { + retry(RETRY) { + timeout(time: TIMEOUT, unit: 'MINUTES') { + sh script: 'vagrant up $EL84', + label: 'Create EL8.4 machine' + sh script: 'vagrant ssh $EL84 -c \"sudo /home/vagrant/almalinux-deploy/almalinux-deploy.sh\"', + label: 'Start AlmaLinux Deploy' + sh script: 'vagrant destroy $EL84 -f', + label: 'Destroy the machine' + } + } + } + } + } + } + } + } + post { + always { + sh script: 'vagrant destroy -f', + label: 'Destroy All Machines' + cleanWs() + } + } +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 96ba520..6b23098 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,116 @@ -# msvsphere-deploy +# almalinux-deploy +An EL to AlmaLinux migration tool. + +## Usage + +In order to convert your EL8 and EL9 operating systems to AlmaLinux do the following: + +1. CentOS 8.4 or 8.5 is required to convert to AlmaLinux. It is recommended to update to 8.5 prior to moving to +AlmaLinux but not required if you are on at least CentOS 8.4. Rebooting after the updates is recommended if your system +received new updates. + + ```shell + sudo dnf update -y + sudo reboot + ``` + + - As of January 31, 2022 the CentOS 8 mirrorlists are offline. In order to successfully perform `dnf update -y` +you need to update your `dnf` config files to point to a valid mirror. You can use the following `sed` commands for +convenience to restore `dnf` to a functional state that will let you update to 8.5 and subsequently AlmaLinux. + - ```bash + sudo sed -i -e '/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=$releasever&arch=$basearch&repo=/ s/^#*/#/' -e '/baseurl=http:\/\/mirror.centos.org\/$contentdir\/$releasever\// s/^#*/#/' -e '/^\[baseos\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/BaseOS/$basearch/os' /etc/yum.repos.d/CentOS-Linux-BaseOS.repo + sudo sed -i -e '/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=$releasever&arch=$basearch&repo=/ s/^#*/#/' -e '/baseurl=http:\/\/mirror.centos.org\/$contentdir\/$releasever\// s/^#*/#/' -e '/^\[appstream\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/AppStream/$basearch/os' /etc/yum.repos.d/CentOS-Linux-AppStream.repo + sudo sed -i -e '/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=$releasever&arch=$basearch&repo=/ s/^#*/#/' -e '/baseurl=http:\/\/mirror.centos.org\/$contentdir\/$releasever\// s/^#*/#/' -e '/^\[cr\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/ContinuousRelease/$basearch/os' /etc/yum.repos.d/CentOS-Linux-ContinuousRelease.repo + sudo sed -i -e '/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=$releasever&arch=$basearch&repo=/ s/^#*/#/' -e '/baseurl=http:\/\/mirror.centos.org\/$contentdir\/$releasever\// s/^#*/#/' -e '/^\[devel\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/Devel/$basearch/os' /etc/yum.repos.d/CentOS-Linux-Devel.repo + sudo sed -i -e '/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=$releasever&arch=$basearch&repo=/ s/^#*/#/' -e '/baseurl=http:\/\/mirror.centos.org\/$contentdir\/$releasever\// s/^#*/#/' -e '/^\[extras\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/extras/$basearch/os' /etc/yum.repos.d/CentOS-Linux-Extras.repo + sudo sed -i -e '/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=$releasever&arch=$basearch&repo=/ s/^#*/#/' -e '/baseurl=http:\/\/mirror.centos.org\/$contentdir\/$releasever\// s/^#*/#/' -e '/^\[fasttrack\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/fasttrack/$basearch/os' /etc/yum.repos.d/CentOS-Linux-FastTrack.repo + sudo sed -i -e '/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=$releasever&arch=$basearch&repo=/ s/^#*/#/' -e '/baseurl=http:\/\/mirror.centos.org\/$contentdir\/$releasever\// s/^#*/#/' -e '/^\[ha\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/HighAvailability/$basearch/os' /etc/yum.repos.d/CentOS-Linux-HighAvailability.repo + sudo sed -i -e '/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=$releasever&arch=$basearch&repo=/ s/^#*/#/' -e '/baseurl=http:\/\/mirror.centos.org\/$contentdir\/$releasever\// s/^#*/#/' -e '/^\[plus\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/centosplus/$basearch/os' /etc/yum.repos.d/CentOS-Linux-Plus.repo + sudo sed -i -e '/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=$releasever&arch=$basearch&repo=/ s/^#*/#/' -e '/baseurl=http:\/\/mirror.centos.org\/$contentdir\/$releasever\// s/^#*/#/' -e '/^\[powertools\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/PowerTools/$basearch/os' /etc/yum.repos.d/CentOS-Linux-PowerTools.repo + ``` + - You can use the `-f` flag (ie `sudo bash almalinux-deploy.sh -f`) to handle this for you. +2. Back up of the system. We didn't test all possible scenarios so there + is a risk that something goes wrong. In such a situation you will have a + restore point. + +3. Download the [almalinux-deploy.sh](almalinux-deploy.sh) script: + + ```shell + curl -O https://raw.githubusercontent.com/AlmaLinux/almalinux-deploy/master/almalinux-deploy.sh + ``` + +4. Run the script and check its output for errors: + + ```shell + $ sudo bash almalinux-deploy.sh + ... + Migration to AlmaLinux is completed + ``` + +5. Reboot is recommended to boot with AlmaLinux kernel: + + ```shell + sudo reboot + ``` + +6. Ensure that your system was successfully converted: + + ```shell + # check release file + $ cat /etc/redhat-release + AlmaLinux release 8.5 (Arctic Sphynx) + + # check that the system boots AlmaLinux kernel by default + $ sudo grubby --info DEFAULT | grep AlmaLinux + title="AlmaLinux (4.18.0-348.el8.x86_64) 8.5 (Arctic Sphynx)" + ``` + +7. Thank you for choosing AlmaLinux! + +## Roadmap + +* [x] CentOS 8 support. +* [x] Write debug information to a log file for failed migration analysis. +* [x] Oracle Linux 8 support. +* [x] RHEL 8 support. +* [x] Rocky Linux 8 support. +* [x] Virtuozzo Linux (VZLinux) 8 support. +* [x] DirectAdmin control panel support. +* [x] cPanel control panel support. +* [x] Plesk control panel support. +* [x] CentOS Stream 8 downgrade support with `-d` option. +* [x] EL9 (RHEL 9, Oracle Linux 9, Rocky Linux 9, Virtuozzo Linux 9) and CentOS Stream 9 support +* [ ] Cover all common scenarios with tests. +* [ ] Add OpenNebula support to Molecule test suite. + +## Get Involved + +Any contribution is welcome: + +* Find and [report](https://github.com/AlmaLinux/almalinux-deploy/issues) bugs. +* Submit pull requests with bug fixes, improvements and new tests. +* Test it on different configurations and share your thoughts in + [discussions](https://github.com/AlmaLinux/almalinux-deploy/discussions). + +Technology stack: + +* The migration script is written in [Bash](https://www.gnu.org/software/bash/). +* We use [Bats](https://github.com/bats-core/bats-core) for unit tests. +* Functional tests are implemented using + [Molecule](https://github.com/ansible-community/molecule), + [Ansible](https://github.com/ansible/ansible) and + [Testinfra](https://github.com/pytest-dev/pytest-testinfra). Virtual machines + are powered by [Vagrant](https://www.vagrantup.com/) and + [VirtualBox](https://www.virtualbox.org/). + * CI/CD: Jenkins and an agent with [Vagrant Libvirt](https://github.com/vagrant-libvirt/vagrant-libvirt). + +To run the functional tests do the following: + +1. Install Vagrant and VirtualBox. +2. Install requirements from the requirements.txt file. +3. Run `molecule test --all` in the project root. + +## License + +Licensed under the GPLv3 license, see the [LICENSE](LICENSE) file for details. diff --git a/Vagrantfile b/Vagrantfile new file mode 100644 index 0000000..85d2c6d --- /dev/null +++ b/Vagrantfile @@ -0,0 +1,106 @@ +# -*- mode: ruby -*- +# vi: set ft=ruby : + +Vagrant.configure("2") do |config| + config.vm.box_check_update = true + + # Disable the builtin syncing functionality and use a file provisioner + # instead. This allows us to use RHEL boxes that do not come with rsync or + # other easy ways of getting the files into a box. + config.vm.synced_folder '.', '/vagrant', disabled: true + config.vm.provision :file, source: File.expand_path('../', __FILE__), destination: '/home/vagrant/almalinux-deploy' + + config.vm.provider "libvirt" do |libvirt| + libvirt.random_hostname = true + libvirt.uri = 'qemu:///system' + end + + config.vm.define "centos8-4" do |i| + i.vm.box = "generic/centos8" + i.vm.hostname = "centos8-4" + i.vm.box_version = "3.4.6" + end + + config.vm.define "centos8-5" do |i| + i.vm.box = "generic/centos8" + i.vm.hostname = "centos8-5" + i.vm.box_version = "3.6.4" + end + + config.vm.define "centos8stream" do |i| + i.vm.box = "generic/centos8s" + i.vm.hostname = "centos8stream" + end + + config.vm.define "centos9stream" do |i| + i.vm.box = "generic/centos9s" + i.vm.hostname = "centos9stream" + end + + config.vm.define "oracle8-4" do |i| + i.vm.box = "generic/oracle8" + i.vm.hostname = "oracle8-4" + i.vm.box_version = "3.4.6" + end + + config.vm.define "oracle8-5" do |i| + i.vm.box = "generic/oracle8" + i.vm.hostname = "oracle8-5" + i.vm.box_version = "3.6.4" + end + + config.vm.define "oracle8" do |i| + i.vm.box = "generic/oracle8" + i.vm.hostname = "oracle8" + end + + config.vm.define "oracle9" do |i| + i.vm.box = "eurolinux-vagrant/oracle-linux-9" + i.vm.hostname = "oracle9" + end + + config.vm.define "rhel8-4" do |i| + i.vm.box = "generic/rhel8" + i.vm.hostname = "rhel8-4" + i.vm.box_version = "3.4.6" + end + + config.vm.define "rhel8-5" do |i| + i.vm.box = "generic/rhel8" + i.vm.hostname = "rhel8-5" + i.vm.box_version = "3.6.4" + end + + config.vm.define "rhel8" do |i| + i.vm.box = "generic/rhel8" + i.vm.hostname = "rhel8" + end + + config.vm.define "rhel9" do |i| + i.vm.box = "generic/rhel9" + i.vm.hostname = "rhel9" + end + + config.vm.define "rocky8-4" do |i| + i.vm.box = "generic/rocky8" + i.vm.hostname = "rocky8-4" + i.vm.box_version = "3.4.6" + end + + config.vm.define "rocky8-5" do |i| + i.vm.box = "generic/rocky8" + i.vm.hostname = "rocky8-5" + i.vm.box_version = "3.6.4" + end + + config.vm.define "rocky8" do |i| + i.vm.box = "generic/rocky8" + i.vm.hostname = "rocky8" + end + + config.vm.define "rocky9" do |i| + i.vm.box = "generic/rocky9" + i.vm.hostname = "rocky9" + end +end + diff --git a/almalinux-deploy.sh b/almalinux-deploy.sh new file mode 100755 index 0000000..1438116 --- /dev/null +++ b/almalinux-deploy.sh @@ -0,0 +1,1188 @@ +#!/bin/bash + +# Description: EL to AlmaLinux migration script. +# License: GPLv3. +# Environment variables: +# ALMA_RELEASE_URL - almalinux-release package download URL. +# ALMA_PUBKEY_URL - RPM-GPG-KEY-AlmaLinux download URL. + +set -euo pipefail + +BASE_TMP_DIR='/root' +OS_RELEASE_PATH='/etc/os-release' +REDHAT_RELEASE_PATH='/etc/redhat-release' +STAGE_STATUSES_DIR='/var/run/almalinux-deploy-statuses' +ALT_ADM_DIR="/var/lib/alternatives" +BAK_DIR="/tmp/alternatives_backup" +ALT_DIR="/etc/alternatives" + +# AlmaLinux OS 8.5 +MINIMAL_SUPPORTED_VERSION='8.4' +VERSION='0.1.13' +DOWNGRADE='NO' + +BRANDING_PKGS=("centos-backgrounds" "centos-logos" "centos-indexhtml" \ + "centos-logos-ipa" "centos-logos-httpd" \ + "oracle-backgrounds" "oracle-logos" "oracle-indexhtml" \ + "oracle-logos-ipa" "oracle-logos-httpd" \ + "oracle-epel-release-el8" "oracle-epel-release-el9" \ + "redhat-backgrounds" "redhat-logos" "redhat-indexhtml" \ + "redhat-logos-ipa" "redhat-logos-httpd" \ + "rocky-backgrounds" "rocky-logos" "rocky-indexhtml" \ + "rocky-logos-ipa" "rocky-logos-httpd" \ + "vzlinux-backgrounds" "vzlinux-logos" "vzlinux-indexhtml" \ + "vzlinux-logos-ipa" "vzlinux-logos-httpd") + +REMOVE_PKGS=("centos-linux-release" "centos-gpg-keys" "centos-linux-repos" \ + "centos-stream-release" "centos-stream-repos" \ + "kernel-uek" "kernel-uek-core" "kernel-uek-modules" \ + "libreport-plugin-rhtsupport" "libreport-rhel" "insights-client" \ + "libreport-rhel-anaconda-bugzilla" "libreport-rhel-bugzilla" \ + "linux-firmware-core" \ + "oraclelinux-release" "oraclelinux-release-el8" \ + "oraclelinux-release-el9" "python3-gobject-base-noarch" \ + "redhat-release" "redhat-release-eula" \ + "rocky-release" "rocky-gpg-keys" "rocky-repos" \ + "rocky-obsolete-packages" "libblockdev-btrfs" \ + "vzlinux-release" "vzlinux-gpg-keys" "vzlinux-repos" "vzlinux-obsolete-packages" \ + "evolution-data-server-ui" "epel-next-release") +REDHAT_DNF_PLUGINS=("product-id" "subscription-manager" "upload-profile") + +module_list_enabled="" +module_list_installed="" +is_container=0 + +setup_log_files() { + exec > >(tee /var/log/almalinux-deploy.log) + exec 5> /var/log/almalinux-deploy.debug.log + BASH_XTRACEFD=5 +} + + +# Save the successful status of a stage for future continue of it +# $1 - name of a stage +save_status_of_stage() { + if [[ 0 != "$(id -u)" ]]; then + # the function is called in tests and should be skipped + return 0 + fi + local -r stage_name="${1}" + if [[ ! -d "${STAGE_STATUSES_DIR}" ]]; then + mkdir -p "${STAGE_STATUSES_DIR}" + fi + touch "${STAGE_STATUSES_DIR}/${stage_name}" +} + + +# Get a status of a stage for continue of it +# $1 - name of a stage +# The function returns 1 if stage isn't completed and 0 if it's completed +get_status_of_stage() { + if [[ 0 != "$(id -u)" ]]; then + # the function is called in tests and should be skipped + return 1 + fi + local -r stage_name="${1}" + if [[ ! -d "${STAGE_STATUSES_DIR}" ]]; then + return 1 + fi + if [[ ! -f "${STAGE_STATUSES_DIR}/${stage_name}" ]]; then + return 1 + fi + return 0 +} + + +is_migration_completed() { + if get_status_of_stage "completed"; then + printf '\n\033[0;32mMigration to AlmaLinux was already completed\033[0m\n' + exit 0 + fi +} + + +# Reports a completed step using a green color. +# +# $1 - Message to print. +report_step_done() { + local -r message="${1}" + printf '\033[0;32m%-70sOK\033[0m\n' "${message}" +} + +# Reports a failed step using a red color. +# +# $1 - Message to print. +# $2 - Additional information to show (optional). +report_step_error() { + local -r message="${1}" + local -r trace="${2:-}" + printf '\033[0;31m%-70sERROR\033[0m\n' "${message}" 1>&2 + if [[ -n "${trace}" ]]; then + echo "${trace}" | while read -r line; do + printf ' %s\n' "${line}" 1>&2 + done + fi +} + +# Prints program usage information. +show_usage() { + echo -e 'Migrates an EL system to AlmaLinux\n' + echo -e 'Usage: almalinux-deploy.sh [OPTION]...\n' + echo ' -h, --help show this message and exit' + echo ' -f, --full perform yum upgrade to 8.5 if necessary' + echo ' -d, --downgrade option to allow downgrade from CentOS Stream' + echo ' -v, --version print version information and exit' +} + +# Terminates the program if it is not run with root privileges +assert_run_as_root() { + if [[ $(id -u) -ne 0 ]]; then + report_step_error 'Check root privileges' \ + 'Migration tool must be run as root' + exit 2 + fi + report_step_done 'Check root privileges' +} + +# Terminates the program if UEFI Secure Boot is enabled +assert_secureboot_disabled() { + local -r message='Check Secure Boot disabled' + if LC_ALL='C' mokutil --sb-state 2>/dev/null | grep -P '^SecureBoot\s+enabled' 1>/dev/null; then + report_step_error "${message}" 'Secure Boot is not supported yet' + exit 1 + fi + report_step_done "${message}" +} + +# Prints a system architecture. +get_system_arch() { + uname -i +} + +# Reads a variable value from /etc/os-release. +# +# $1 - variable name. +# +# Returns the variable value. +get_os_release_var() { + local -r var="${1}" + local val + if ! val="$(grep -oP "^${var}=\"\K.*?(?=\")" "${OS_RELEASE_PATH}")"; then + echo "Error: ${var} is not found in ${OS_RELEASE_PATH}" >&2 + exit 1 + fi + echo "${val}" +} + +# Detects an operational system version. +# +# $1 - operational system type. +# +# Prints OS version. +get_os_version() { + local -r os_type="${1}" + local os_version + if [[ "${os_type}" == 'centos' ]]; then + if [[ "$(get_os_release_var 'NAME')" == 'CentOS Stream' ]]; then + if [[ ! "${DOWNGRADE}" == 'YES' ]]; then + report_step_error "Use '-d or --downgrade' option to allow downgrade from CentOS Stream" + exit 1 + fi + os_version="$(get_os_release_var 'VERSION_ID')" + else + if ! os_version="$(grep -oP 'CentOS\s+Linux\s+release\s+\K(\d+\.\d+)' \ + "${REDHAT_RELEASE_PATH}" 2>/dev/null)"; then + report_step_error "Detect ${os_type} version" + fi + fi + elif [[ "${os_type}" == 'virtuozzo' ]]; then + if ! os_version="$(grep -oP 'Virtuozzo\s+Linux\s+release\s+\K(\d+\.\d+)' \ + "${REDHAT_RELEASE_PATH}" 2>/dev/null)"; then + report_step_error "Detect ${os_type} version" + fi + else + os_version="$(get_os_release_var 'VERSION_ID')" + fi + echo "${os_version}" +} + +# Prints control type and version. +get_panel_info() { + local panel_type='' + local panel_version='' + local -r cpanel_file='/usr/local/cpanel/cpanel' + local -r plesk_file='/usr/local/psa/version' + if [[ -x "${cpanel_file}" ]]; then + panel_type='cpanel' + panel_version=$("${cpanel_file}" -V 2>/dev/null | grep -oP '^[\d.]+') + elif [[ -f "${plesk_file}" ]]; then + panel_type='plesk' + panel_version=$(grep -oP '^[\d.]+' "${plesk_file}" 2>/dev/null) + fi + echo "${panel_type} ${panel_version}" +} + +# Terminates the program if a platform is not supported by AlmaLinux. +# +# $1 - Operational system id (ID). +# $2 - Operational system version (e.g. 8 or 8.3). +# $3 - System architecture (e.g. x86_64). +assert_supported_system() { + if get_status_of_stage "assert_supported_system"; then + return 0 + fi + local -r os_type="${1}" + local -r os_version="${2:0:1}" + local -r arch="${3}" + case "${arch}" in + x86_64|aarch64|ppc64le|s390x) + ;; + *) + report_step_error "Check ${arch} architecture is supported" + exit 1 + ;; + esac + if [[ ${os_version} -lt ${MINIMAL_SUPPORTED_VERSION:0:1} ]]; then + report_step_error "Check EL${os_version} is supported" + exit 1 + fi + os_types=("centos" "almalinux" "ol" "rhel" "rocky" "virtuozzo") + if [[ ! " ${os_types[*]} " =~ ${os_type} ]]; then + report_step_error "Check ${os_type} operating system is supported" + exit 1 + fi + report_step_done "Check ${os_type}-${os_version}.${arch} is supported" + save_status_of_stage "assert_supported_system" + return 0 +} + +# Terminates the program if a control panel is not supported by AlmaLinux. +# +# $1 - Control panel type. +# $2 - Control panel version. +assert_supported_panel() { + if get_status_of_stage "assert_supported_panel"; then + return 0 + fi + local -r panel_type="${1}" + local -r panel_version="${2}" + local plesk_min_major=18 + local plesk_min_minor=0 + local plesk_min_micro=35 + local major + local minor + local micro + local error_msg="${panel_type} version \"${panel_version}\" is not supported. Please update the control panel to version \"${plesk_min_major}.${plesk_min_minor}.${plesk_min_micro}\"." + if [[ "${panel_type}" == 'plesk' ]]; then + local IFS=. +read -r major minor micro << EOF +${panel_version} +EOF + if [[ -z ${micro} ]]; then + micro=0 + fi + if [[ -z ${minor} ]]; then + minor=0 + fi + if [[ ${major} -lt ${plesk_min_major} ]]; then + report_step_error "${error_msg}" + exit 1 + elif [[ ${major} -eq ${plesk_min_major} && ${minor} -lt ${plesk_min_minor} ]]; then + report_step_error "${error_msg}" + exit 1 + elif [[ ${major} -eq ${plesk_min_major} && ${minor} -eq ${plesk_min_minor} && ${micro} -lt ${plesk_min_micro} ]]; then + report_step_error "${error_msg}" + exit 1 + fi + fi + save_status_of_stage "assert_supported_panel" +} + +assert_supported_filesystem() { + if get_status_of_stage "assert_supported_filesystem"; then + return 0 + fi + local result + if result=$(df -Th | awk '{print $2}' | grep btrfs); then + report_step_error "${result} is not supported filesystem" + exit 1 + fi + save_status_of_stage "assert_supported_filesystem" +} + +# Returns a latest almalinux-release RPM package download URL. +# +# $1 - AlmaLinux major version (e.g. 8). +# $2 - System architecture (e.g. x86_64). +# +# Prints almalinux-release RPM package download URL. +get_release_file_url() { + local -r os_version="${1:0:1}" + local -r arch="${2}" + echo "${ALMA_RELEASE_URL:-https://repo.almalinux.org/almalinux/almalinux-release-latest-${os_version}.${arch}.rpm}" +} + +# Returns a latest almalinux-repos RPM package download URL. +# +# $1 - AlmaLinux major version (e.g. 9). +# $2 - System architecture (e.g. x86_64). +# +# Prints almalinux-release RPM package download URL. +get_repos_file_url() { + local -r os_version="${1:0:1}" + local -r arch="${2}" + echo "${ALMA_REPOS_URL:-https://repo.almalinux.org/almalinux/almalinux-repos-latest-${os_version}.${arch}.rpm}" +} + +# Returns a latest almalinux-gpg-keys RPM package download URL. +# +# $1 - AlmaLinux major version (e.g. 9). +# $2 - System architecture (e.g. x86_64). +# +# Prints almalinux-gpg-keys RPM package download URL. +get_gpg_keys_file_url() { + local -r os_version="${1:0:1}" + local -r arch="${2}" + echo "${ALMA_REPOS_URL:-https://repo.almalinux.org/almalinux/almalinux-gpg-keys-latest-${os_version}.${arch}.rpm}" +} + +# Downloads and installs the AlmaLinux public PGP key. +# +# $1 - Temporary directory path. +# $2 - AlmaLinux major version (e.g. 8). +install_rpm_pubkey() { + if get_status_of_stage "install_rpm_pubkey"; then + return 0 + fi + local -r tmp_dir="${1}" + local -r os_version="${2:0:1}" + local -r ALMA_PUBKEY_URL="https://repo.almalinux.org/almalinux/RPM-GPG-KEY-AlmaLinux-${os_version}" + local -r pubkey_url="${ALMA_PUBKEY_URL:-https://repo.almalinux.org/almalinux/RPM-GPG-KEY-AlmaLinux}" + local -r pubkey_path="${tmp_dir}/RPM-GPG-KEY-AlmaLinux" + local -r step='Download RPM-GPG-KEY-AlmaLinux' + local output + if ! output=$(curl -f -s -S -o "${pubkey_path}" "${pubkey_url}" 2>&1); then + report_step_error "${step}" "${output}" + exit 1 + else + report_step_done "${step}" + fi + rpm --import "${pubkey_path}" + report_step_done 'Import RPM-GPG-KEY-AlmaLinux to RPM DB' + rm -f "${pubkey_path}" + save_status_of_stage "install_rpm_pubkey" +} + +# Downloads almalinux-release package. +# +# $1 - Temporary directory path. +# $2 - almalinux-release package download URL. +# +# Prints downloaded file path. +download_release_files() { + local -r tmp_dir="${1}" + local -r release_url="${2}" + local -r release_path="${tmp_dir}/almalinux-release-latest.rpm" + local output + if ! output=$(curl -f -s -S -o "${release_path}" "${release_url}" 2>&1); then + report_step_error 'Download almalinux packages - release' "${output}" + exit 1 + fi + echo "${release_path}" +} + +# Downloads almalinux-repos package. +# +# $1 - Temporary directory path. +# $2 - almalinux-repos package download URL. +# +# Prints downloaded file path. +download_repos_files() { + local -r tmp_dir="${1}" + local -r repos_url="${2}" + local -r repos_path="${tmp_dir}/almalinux-repos.rpm" + local output + if ! output=$(curl -f -s -S -o "${repos_path}" "${repos_url}" 2>&1); then + report_step_error 'Download almalinux packages - repos' "${output}" + exit 1 + fi + echo "${repos_path}" +} + +# Downloads almalinux-gpg-keys package. +# +# $1 - Temporary directory path. +# $2 - almalinux-gpg-keys package download URL. +# +# Prints downloaded file path. +download_gpg_keys_files() { + local -r tmp_dir="${1}" + local -r gpg_keys_url="${2}" + local -r gpg_keys_path="${tmp_dir}/almalinux-gpg-keys.rpm" + local output + if ! output=$(curl -f -s -S -o "${gpg_keys_path}" "${gpg_keys_url}" 2>&1); then + report_step_error 'Download almalinux packages - gpg-keys' "${output}" + exit 1 + fi + echo "${gpg_keys_path}" +} + +# Terminates the program if a given RPM package checksum/signature is invalid. +# +# $1 - RPM package path. +assert_valid_package() { + local -r pkg_path="${1}" + local output + if ! output=$(rpm -K "${pkg_path}" 2>&1); then + report_step_error "Verify $(basename "${pkg_path}") package" \ + "${output}" + exit 1 + fi + report_step_done 'Verify almalinux-release package' +} + +# +# Change repo file to point to last CentOS 8 release in vault +# +# $1 - Repo id. +# $2 - Repo name. +# $3 - Repo name for earlier releases if different from name. +# $4 - Repo subdir if different from name. +fix_repo_file() { + local -r repo_id="${1}" + local -r repo_name="${2}" + local -r repo_name_alt="${3-$2}" + local -r repo_subdir="${4:-$2}" + if [ -f "/etc/yum.repos.d/CentOS-Linux-${repo_name}.repo" ]; then + sed -i -e "/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=\$releasever&arch=\$basearch&repo=/ s/^#*/#/" -e "/baseurl=http:\/\/mirror.centos.org\/\$contentdir\/\$releasever\// s/^#*/#/" -e "/^\[${repo_id}\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/${repo_subdir}/\$basearch/os" "/etc/yum.repos.d/CentOS-Linux-${repo_name}.repo" + elif [ -f "/etc/yum.repos.d/CentOS-${repo_name_alt}.repo" ]; then + sed -i -e "/mirrorlist=http:\/\/mirrorlist.centos.org\/?release=\$releasever&arch=\$basearch&repo=/ s/^#*/#/" -e "/baseurl=http:\/\/mirror.centos.org\/\$contentdir\/\$releasever\// s/^#*/#/" -e "/^\[\(${repo_id}\|${repo_name}\)\]/a baseurl=https://mirror.rackspace.com/centos-vault/8.5.2111/${repo_subdir}/\$basearch/os" "/etc/yum.repos.d/CentOS-${repo_name_alt}.repo" + elif [ -n "${repo_name_alt}" ]; then + echo "Error: No repo file found for ${repo_name}" >&2 + return 1 + fi +} + +# +# Perform dnf upgrade (and fix repos since CentOS mirrorlist is offline as of 2022-01-31) +# +dnf_upgrade() { + local -r step='Fix DNF repositories to live mirror and run dnf upgrade -y' + if [[ "$(get_os_release_var 'NAME')" != 'CentOS Stream' ]]; then + fix_repo_file baseos BaseOS Base + fix_repo_file appstream AppStream + fix_repo_file cr ContinuousRelease CR + fix_repo_file devel Devel '' + fix_repo_file extras Extras Extras extras + fix_repo_file fasttrack FastTrack fasttrack fasttrack + fix_repo_file ha HighAvailability '' + fix_repo_file plus Plus centosplus + fix_repo_file powertools PowerTools + fix_repo_file crb CRB + fi + dnf upgrade -y || { + ret_code=${?} + if [[ ${ret_code} -ne 0 ]]; then + report_step_error "${step}. Exit code: ${ret_code}" + exit ${ret_code} + fi + } + # Make sure RPM DB is clean for gpg key installation in a subsequent step + dnf clean dbcache + report_step_done 'DNF upgrade' +} + +# Terminates the program if OS version doesn't match AlmaLinux version. +# +# $1 - OS version. +# $2 - almalinux-release package file path. +assert_compatible_os_version() { + if get_status_of_stage "assert_compatible_os_version"; then + return 0 + fi + local -r os_version="${1}" + local -r release_path="${2}" + local alma_version + alma_version=$(rpm -qp --queryformat '%{version}' "${release_path}") + + if [[ "$(get_os_release_var 'NAME')" != 'CentOS Stream' ]]; then + if [[ "${os_version:0:1}" -lt "${MINIMAL_SUPPORTED_VERSION:0:1}" ]] && [[ "${os_version:2:3}" -lt "${MINIMAL_SUPPORTED_VERSION:2:3}" ]]; then + report_step_error "Please upgrade your OS from ${os_version} to" \ + "at least ${MINIMAL_SUPPORTED_VERSION} and try again" + exit 1 + fi + fi + if [[ "${os_version:0:1}" -lt "${alma_version:0:1}" ]] && [[ "${os_version:2:3}" -gt "${alma_version:2:3}" ]]; then + report_step_error "Version of your OS ${os_version} is not supported yet" + exit 1 + fi + report_step_done 'Your OS is supported' + save_status_of_stage "assert_compatible_os_version" +} + +# Backup /etc/issue* files +backup_issue() { + if get_status_of_stage "backup_issue"; then + return 0 + fi + for file in $(rpm -Vf /etc/issue | cut -d' ' -f4); do + if [[ ${file} =~ "/etc/issue" ]]; then + cp "${file}" "${file}.bak" + fi + done + save_status_of_stage "backup_issue" +} + +# Restore /etc/issue* files +restore_issue() { + if get_status_of_stage "restore_issue"; then + return 0 + fi + for file in /etc/issue /etc/issue.net; do + [ ! -f "${file}.bak" ] || mv -f ${file}.bak ${file} + done + save_status_of_stage "restore_issue" +} + +# Recursively removes a given directory. +# +# $1 - Directory path. +cleanup_tmp_dir() { + rm -fr "${1:?}" +} + +# Remove OS specific packages +remove_os_specific_packages_before_migration() { + if get_status_of_stage "remove_os_specific_packages_before_migration"; then + return 0 + fi + for i in "${!REMOVE_PKGS[@]}"; do + if ! rpm -q "${REMOVE_PKGS[i]}" &> /dev/null; then + # remove an erased package from the list if it isn't installed + unset "REMOVE_PKGS[i]" + fi + done + if [[ "${#REMOVE_PKGS[@]}" -ne 0 ]]; then + rpm -e --nodeps --allmatches "${REMOVE_PKGS[@]}" + fi + report_step_done 'Remove OS specific rpm packages' + save_status_of_stage "remove_os_specific_packages_before_migration" +} + + +# Remove not needed Red Hat directories +remove_not_needed_redhat_dirs() { + if get_status_of_stage "remove_not_needed_redhat_dirs"; then + return 0 + fi + [ -d /usr/share/doc/redhat-release ] && rm -r /usr/share/doc/redhat-release + [ -d /usr/share/redhat-release ] && rm -r /usr/share/redhat-release + save_status_of_stage "remove_not_needed_redhat_dirs" +} + + +# Install package almalinux-release +install_almalinux_release_package() { + if get_status_of_stage "install_almalinux_release_package"; then + return 0 + fi + local -r release_path="${1}" + rpm -Uvh --nodeps "${release_path}" + report_step_done 'Install almalinux-release package' + save_status_of_stage "install_almalinux_release_package" +} + +# Install package almalinux-repos +install_almalinux_repos_package() { + if get_status_of_stage "install_almalinux_repos_package"; then + return 0 + fi + local -r repos_path="${1}" + rpm -Uvh --nodeps "${repos_path}" + report_step_done 'Install almalinux-repos package' + save_status_of_stage "install_almalinux_repos_package" +} + +# Install package almalinux-gpg-keys +# +# $1 - full path (including package filename) to the almalinux-gpg-keys package +install_almalinux_gpg_keys_package() { + if get_status_of_stage "install_almalinux_gpg_keys_package"; then + return 0 + fi + local -r gpg_keys_path="${1}" + rpm -Uvh --nodeps "${gpg_keys_path}" + report_step_done 'Install almalinux-gpg-keys package' + save_status_of_stage "install_almalinux_gpg_keys_package" +} + +# Remove brand packages and install the same AlmaLinux packages +replace_brand_packages() { + if get_status_of_stage "replace_brand_packages"; then + return 0 + fi + local alma_pkgs=() + local alma_pkg + local output + local pkg_name + # replace GUI packages + for i in "${!BRANDING_PKGS[@]}"; do + pkg_name="${BRANDING_PKGS[i]}" + if rpm -q "${pkg_name}" &>/dev/null; then + # shellcheck disable=SC2001 + case "${pkg_name}" in + oracle-epel-release-el*) + alma_pkg="epel-release" + ;; + *) + # shellcheck disable=SC2001 + alma_pkg="$(echo "${pkg_name}" | sed 's#centos\|oracle\|redhat\|rocky\|vzlinux#almalinux#')" + ;; + esac + alma_pkgs+=("${alma_pkg}") + else + unset "BRANDING_PKGS[i]" + fi + done + if [[ "${#BRANDING_PKGS[@]}" -ne 0 ]]; then + rpm -e --nodeps --allmatches "${BRANDING_PKGS[@]}" + report_step_done "Remove ${BRANDING_PKGS[*]} packages" + fi + if [[ "${#alma_pkgs[@]}" -ne 0 ]]; then + if ! output=$(dnf install -y "${alma_pkgs[@]}" 2>&1); then + report_step_error "Install ${alma_pkgs[*]} packages" "${output}" + fi + report_step_done "Install ${alma_pkgs[*]} packages" + fi + save_status_of_stage "replace_brand_packages" +} + + +# Converts a CentOS like system to AlmaLinux +# +# $1 - almalinux-release RPM package path. +# $2 - almalinux-repos RPM package path. +# $3 - almalinux-gpg-keys RPM package path +migrate_from_centos() { + if get_status_of_stage "migrate_from_centos"; then + return 0 + fi + local -r release_path="${1}" + case "${os_version}" in + 9*) + local -r repos_path="${2}" + local -r gpg_keys_path="${3}" + ;; + esac + # replace OS packages with almalinux-release + # and OS centos-specific packages + remove_os_specific_packages_before_migration + remove_not_needed_redhat_dirs + install_almalinux_release_package "${release_path}" + case "${os_version}" in + 9*) + install_almalinux_repos_package "${repos_path}" + install_almalinux_gpg_keys_package "${gpg_keys_path}" + ;; + esac + replace_brand_packages + save_status_of_stage "migrate_from_centos" +} + +# Reset modules stream ol8 for OracleLinux +reset_wrong_module_streams() { + module_list_enabled=$(dnf -e 1 module list --enabled | awk '$2 == "ol8" {printf $1" "}') + module_list_installed=$(dnf -e 1 module list --installed | awk '$2 == "ol8" {printf $1" "}') + if [ -n "${module_list_enabled}" ]; then + # shellcheck disable=SC2086 + dnf module reset -y ${module_list_enabled} + echo "reset modules: ${module_list_enabled}" + report_step_done "Reset modules" + fi +} + +# Executes the 'dnf distro-sync -y' command. +# +# $1 - operational system type. +# +distro_sync() { + if get_status_of_stage "distro_sync"; then + return 0 + fi + local -r step='Run dnf distro-sync -y' + local ret_code=0 + local -r os_version="${1}" + case "${os_version}" in + 8*) + local dnf_repos="--enablerepo=powertools" + ;; + 9*) + local dnf_repos="--enablerepo=crb" + ;; + esac + local exclude_pkgs="--exclude=" + # create needed repo + if [ "${panel_type}" == "plesk" ]; then + plesk installer --select-release-current --show-components --skip-cleanup + dnf_repos+=",PLESK_*-dist" + fi + dnf check-update || { + ret_code=${?} + if [[ ${ret_code} -ne 0 ]] && [[ ${ret_code} -ne 100 ]]; then + report_step_error "${step}. Exit code: ${ret_code}" + exit ${ret_code} + fi + } + # check if we inside lxc container + if [ $is_container -eq 1 ]; then + exclude_pkgs+="filesystem*,grub*" + fi + dnf distro-sync -y "${dnf_repos}" "${exclude_pkgs}" || { + ret_code=${?} + report_step_error "${step}. Exit code: ${ret_code}" + exit ${ret_code} + } + # remove unnecessary repo + if [ "${panel_type}" == "plesk" ]; then + plesk installer --select-release-current --show-components + fi + report_step_done "${step}" + save_status_of_stage "distro_sync" +} + +# Enable reseted modules with new stream rhel8 +restore_module_streams() { + if [ -n "${module_list_enabled}" ]; then + # shellcheck disable=SC2001,2086 + module_enabled_rhel=$(echo ${module_list_enabled} | sed -e 's# #:rhel8 #g') + # shellcheck disable=SC2086 + dnf module enable -y ${module_enabled_rhel} + echo "re-enabled modules: ${module_enabled_rhel}" + report_step_done "Enable modules" + fi + if [ -n "${module_list_installed}" ]; then + # shellcheck disable=SC2001,2086 + module_installed_rhel=$(echo ${module_list_installed} | sed -e 's# #:rhel8 #g') + # shellcheck disable=SC2086 + dnf module install -y ${module_installed_rhel} + echo "installed modules: ${module_installed_rhel}" + report_step_done "Install modules" + fi +} + +install_kernel() { + if get_status_of_stage "install_kernel"; then + return 0 + fi + if ! output=$(rpm -q kernel 2>&1); then + if output=$(dnf -y install kernel 2>&1); then + report_step_done "Install AlmaLinux kernel" + else + report_step_error "Install AlmaLinux kernel" + fi + fi + save_status_of_stage "install_kernel" +} + +grub_update() { + if get_status_of_stage "grub_update"; then + return 0 + fi + if [ "$(which grub2-mkconfig)" ] ; then + if [ -d /sys/firmware/efi ]; then + grub2-mkconfig -o /etc/grub2-efi.cfg + else + grub2-mkconfig -o /etc/grub2.cfg + fi + fi + save_status_of_stage "grub_update" +} + +# Check do we have custom kernel (e.g. kernel-uek) and print warning +check_custom_kernel() { + if get_status_of_stage "check_custom_kernel"; then + return 0 + fi + local output + output=$(rpm -qa | grep kernel-uek) || : + if [ -n "${output}" ]; then + if [ -x /usr/bin/mokutil ] && /usr/bin/mokutil --sb-state 2>&1 | grep -q enabled; then + echo -ne "\n!! There are kernels left from previous operating system +that won't boot in Secure Boot mode anymore:\n" + else + echo "There are kernels left from previous operating system:" + fi + # shellcheck disable=SC2001,SC2086 + echo "$output" | sed 's# #\n#' + echo "" + echo "If you don't need them, you can remove them by using the 'dnf remove" \ + "${output}' command" + fi + save_status_of_stage "check_custom_kernel" +} + +_backup_alternative() { + local path="${1}" + local bak_dir="${2}" + local bak_prefix="current_point" + local alt_name= + local alt_dest= + local alt_link= + alt_name="$(basename "${path}")" + alt_link="${ALT_DIR}/${alt_name}" + alt_dest="$(readlink "${alt_link}")" + mkdir -p "${bak_dir}" + + # backup the current state of an alternative + echo "${alt_dest} ${alt_link}" > "${bak_dir}/${bak_prefix}.${alt_name}" +} + + +_restore_alternative() { + local path="${1}" + local bak_dir="${2}" + local bak_point="${bak_dir}/current_point" + local alt_name= + local shift_begin=3 + local shift_middle=2 + local main_link= + local alternatives=() + local priorities=() + local links=() + local dests=() + local names=() + local line= + local _alt_link= + local _alt_dest= + local alt_link= + local alt_dest= + local i= + local empty_num= + local len= + local begin_index= + local end_index= + len="$(wc -l < "${path}")" + # name of a backup alternatives, e.g. python or java + alt_name="$(basename "${path}")" + # system link which points to an alternative, e.g. + # /usr/bin/unversioned-python -> /etc/alternatives/python + main_link="$(sed -n -e 2p "${path}")" + i=0 + # this cycle saves info about slave's links + # and slave's names of an alternative + # e.g. + # unversioned-python - name + # /usr/bin/python - link + # python2 - name + # /usr/bin/python2 - link + # unversioned-python-man - name + # /usr/share/man/man1/python.1.gz - link + while read -r line; do + i=$(("${i}" + 1)) + if [[ -z $line ]]; then + empty_num=$(("${shift_begin}" + "${i}")) + break + fi + if [[ $(( "${i}" % 2 )) -eq 0 ]]; then + links+=("$line") + else + names+=("$line") + fi + done < <(tail -n +${shift_begin} "${path}") + + # this cycle saves info about available alternatives and them priorites + # e.g. + # /usr/libexec/no-python alternative with priority 404 + # /usr/bin/python3 alternative with priority 300 + while [[ "${len}" -gt $(("${#names[@]}" + "${empty_num}")) ]]; do + alternatives+=("$(sed -n -e "${empty_num}"p "${path}")") + priorities+=("$(sed -n -e $(("${empty_num}" + 1))p "${path}")") + begin_index="$(("${empty_num}" + "${shift_middle}"))" + end_index="$(("${#names[@]}" + "${shift_middle}" + "${empty_num}"))" + # this cycle saves info about slave's dests for an each alternative, + # e.g. + # /usr/bin/python3 - dest for /usr/bin/python + #/usr/share/man/man1/python3.1.gz - dest for /usr/share/man/man1/python.1.gz + # destination can be empty and in this case we don't create symlink + if [[ "${begin_index}" -ne "${end_index}" ]]; then + while read -r line; do + dests+=("$line") + done < <(sed -n -e "${begin_index}","${end_index}"p "${path}") + fi + empty_num=$(("${empty_num}" + "${#names[@]}" + "${shift_middle}")) + done + # read and restore current state of an alternative + # e.g. + # /etc/alternatives/python -> /usr/libexec/no-python + while read -r _alt_dest _alt_link; do + alt_link="${_alt_link}" + alt_dest="${_alt_dest}" + if [[ ! -e "${alt_link}" ]]; then + ln -sf "${alt_dest}" "${alt_link}" + fi + done < "${bak_point}.${alt_name}" + + for i in "${!alternatives[@]}"; do + if [[ ! -e "${main_link}" ]]; then + # restore system symlink for alternative, e.g. + # /usr/bin/unversioned-python -> /etc/alternatives/python + ln -sf "${alt_link}" "${main_link}" + fi + for j in "${!names[@]}"; do + if [[ "${alt_dest}" == "${alternatives[$i]}" ]]; then + if [[ -e "${dests[$(( "${j}" + "${#links[@]}" * "${i}"))]}" && ! -e "${ALT_DIR}/${names[$j]}" ]]; then + # restore system slave link to an alternative, e.g. + # /etc/alternatives/unversioned-python-man -> /usr/share/man/man1/unversioned-python.1.gz + ln -sf "${dests[$(( "${j}" + "${#links[@]}" * "${i}"))]}" "${ALT_DIR}/${names[$j]}" + fi + if [[ -e "${ALT_DIR}/${names[$j]}" && ! -e "${links[$j]}" ]]; then + # restore slave link for an alternative + # e.g. /usr/share/man/man1/python.1.gz -> /etc/alternatives/unversioned-python-man + ln -sf "${ALT_DIR}/${names[$j]}" "${links[$j]}" + fi + fi + done + done + +} + +# backup existing alternatives, including the current states of alternatives +backup_alternatives() { + if get_status_of_stage "backup_alternatives"; then + return 0 + fi + for alt_file in "${ALT_ADM_DIR}"/*; do + _backup_alternative "${alt_file}" "${BAK_DIR}" + done + /usr/bin/cp -rf "${ALT_ADM_DIR}" "${BAK_DIR}"/. + report_step_done "Backup of alternatives is done" + save_status_of_stage "backup_alternatives" +} + + +# restore existing alternatives, including the current states of alternatives +restore_alternatives() { + if get_status_of_stage "restore_alternatives"; then + return 0 + fi + for alt_file in "${BAK_DIR}/alternatives/"*; do + _restore_alternative "${alt_file}" "${BAK_DIR}" + done + /usr/bin/cp -rn "${BAK_DIR}/alternatives/"* "${ALT_ADM_DIR}/" + report_step_done "Restoring of alternatives is done" + save_status_of_stage "restore_alternatives" +} + + +add_efi_boot_record() { + if get_status_of_stage "add_efi_boot_record"; then + return 0 + fi + if [[ ! -d /sys/firmware/efi ]]; then + return + fi + local device + local disk_name + local disk_num + local soft_dev1 + local soft_dev2 + local disk_name1 + local disk_name2 + local disk_num1 + local disk_num2 + local arch + arch="$(get_system_arch)" + device="$(df -T /boot/efi | sed -n 2p | awk '{ print $1}')" + + if [[ $device == *"/dev/md"* ]]; then + echo "ESP Partition on software raid detected:" + soft_dev1="$(lsblk -f -l -p | grep boot_efi |sed -n 1p | awk '{ print $1}')" + soft_dev2="$(lsblk -f -l -p | grep boot_efi |sed -n 2p | awk '{ print $1}')" + echo "$soft_dev1" + echo "$soft_dev2" + disk_name1="$(echo "${soft_dev1}" | sed -re 's/(p|)[0-9]$//g')" + disk_name2="$(echo "${soft_dev2}" | sed -re 's/(p|)[0-9]$//g')" + disk_num1="$(echo "${soft_dev1}" | tail -c 2|sed 's|[^0-9]||g')" + disk_num2="$(echo "${soft_dev2}" | tail -c 2|sed 's|[^0-9]||g')" + else + disk_name="$(echo "${device}" | sed -re 's/(p|)[0-9]$//g')" + disk_num="$(echo "${device}" | tail -c 2|sed 's|[^0-9]||g')" + fi + + if [[ ${arch} == "x86_64" && $device == *"/dev/md"* ]]; then + efibootmgr -c -L "AlmaLinux" -l "\EFI\almalinux\shimx64.efi" -d "${disk_name1}" -p "${disk_num1}" + efibootmgr -c -L "AlmaLinux" -l "\EFI\almalinux\shimx64.efi" -d "${disk_name2}" -p "${disk_num2}" + + elif [[ ${arch} == "aarch64" && $device == *"/dev/md"* ]]; then + efibootmgr -c -L "AlmaLinux" -l "\EFI\almalinux\shimaa64.efi" -d "${disk_name1}" -p "${disk_num1}" + efibootmgr -c -L "AlmaLinux" -l "\EFI\almalinux\shimaa64.efi" -d "${disk_name2}" -p "${disk_num2}" + + elif [[ ${arch} == "x86_64" ]]; then + efibootmgr -c -L "AlmaLinux" -l "\EFI\almalinux\shimx64.efi" -d "${disk_name}" -p "${disk_num}" + + elif [[ ${arch} == "aarch64" ]]; then + efibootmgr -c -L "AlmaLinux" -l "\EFI\almalinux\shimaa64.efi" -d "${disk_name}" -p "${disk_num}" + + fi + report_step_done "The new EFI boot record for AlmaLinux is added" + save_status_of_stage "add_efi_boot_record" +} + + +reinstall_secure_boot_packages() { + if get_status_of_stage "reinstall_secure_boot_packages"; then + return 0 + fi + if [ "$(which grubby)" ] ; then #if this happens on a system with GRUB and related tools, rather than on RPi + local kernel_package + for pkg in $(rpm -qa | grep -E 'shim|fwupd|grub2'); do + if [[ "AlmaLinux" != "$(rpm -q --queryformat '%{vendor}' "$pkg")" ]]; then + yum reinstall "${pkg}" -y + fi + done + kernel_package="$(rpm -qf "$(grubby --default-kernel)")" + if [[ "AlmaLinux" != "$(rpm -q --queryformat '%{vendor}' "${kernel_package}")" ]]; then + yum reinstall "${kernel_package}" -y + fi + fi + report_step_done "All Secure Boot related packages which were not released by AlmaLinux are reinstalled" + save_status_of_stage "reinstall_secure_boot_packages" +} + +disable_dnf_plugin() { + local plugin="$1" + + local conf + conf="/etc/dnf/plugins/${plugin}.conf" + + if [ -f "${conf}" ]; then + sed -i -e 's/^enabled\s*=\s*1/enabled=0/g' "${conf}" + else + printf '[main]\nenabled=0\n' > "${conf}" + fi +} + +disable_redhat_dnf_plugins() { + local plugin + + for plugin in "${REDHAT_DNF_PLUGINS[@]}"; do + disable_dnf_plugin "${plugin}" + done +} + +main() { + is_migration_completed + local arch + local os_version + local os_type + local release_url + local tmp_dir + local release_path + local panel_type + local panel_version + assert_run_as_root + arch="$(get_system_arch)" + os_type="$(get_os_release_var 'ID')" + os_version="$(get_os_version "${os_type}")" + #os_version="$(get_os_release_var 'VERSION_ID')" + #os_version="${os_version:0:1}" + assert_supported_system "${os_type}" "${os_version}" "${arch}" + assert_supported_filesystem + + read -r panel_type panel_version < <(get_panel_info) + assert_supported_panel "${panel_type}" "${panel_version}" + + release_url=$(get_release_file_url "${os_version}" "${arch}") + tmp_dir=$(mktemp -d --tmpdir="${BASE_TMP_DIR}" .alma.XXXXXX) + # shellcheck disable=SC2064 + trap "cleanup_tmp_dir ${tmp_dir}" EXIT + install_rpm_pubkey "${tmp_dir}" "${os_version}" + + release_path=$(download_release_files "${tmp_dir}" "${release_url}") + report_step_done 'Download almalinux-release package' + if mount | grep -q fuse.lxcfs || + env | grep -q 'container=lxc' || + awk '{print $1}' /proc/vz/veinfo 2>/dev/null || + grep docker '/proc/1/cgroup' >/dev/null; then + is_container=1 + fi + + assert_valid_package "${release_path}" + assert_compatible_os_version "${os_version}" "${release_path}" + + case "${os_type}" in + almalinux|centos|ol|rhel|rocky|virtuozzo) + backup_issue + + if [[ "${os_type}" == "rhel" ]]; then + disable_redhat_dnf_plugins + fi + + case "${os_version}" in + 8*) + migrate_from_centos "${release_path}" + ;; + 9*) + repos_url=$(get_repos_file_url "${os_version}" "${arch}") + repos_path=$(download_repos_files "${tmp_dir}" "${repos_url}") + gpg_keys_url=$(get_gpg_keys_file_url "${os_version}" "${arch}") + gpg_keys_path=$(download_gpg_keys_files "${tmp_dir}" "${gpg_keys_url}") + migrate_from_centos "${release_path}" "${repos_path}" "${gpg_keys_path}" + ;; + esac + ;; + *) + report_step_error "Migrate ${os_type}: not supported" + exit 1 + ;; + esac + + backup_alternatives + reset_wrong_module_streams + distro_sync "${os_version}" + restore_module_streams + restore_alternatives + restore_issue + # don't do this steps if we inside the lxc container + if [ $is_container -eq 0 ]; then + install_kernel + grub_update + reinstall_secure_boot_packages + add_efi_boot_record + fi + check_custom_kernel + save_status_of_stage "completed" + printf '\n\033[0;32mMigration to AlmaLinux is completed\033[0m\n' +} + +if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then + for opt in "$@"; do + case ${opt} in + -h | --help) + show_usage + exit 0 + ;; + -f | --full) + dnf_upgrade + ;; + -v | --version) + echo "${VERSION}" + exit 0 + ;; + -d | --downgrade) + DOWNGRADE='YES' + ;; + -t | --tests) + exit 0 + ;; + *) + echo "Error: unknown option ${opt}" >&2 + exit 2 + ;; + esac + done + setup_log_files + set -x + main + set +x +fi diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..fc8307e --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +ansible-lint[yamllint] +molecule[lint] +molecule-vagrant +python-vagrant +pytest-testinfra diff --git a/test_almalinux-deploy.bats b/test_almalinux-deploy.bats new file mode 100755 index 0000000..b10c123 --- /dev/null +++ b/test_almalinux-deploy.bats @@ -0,0 +1,176 @@ +#!/usr/bin/env bats +source almalinux-deploy.sh -t + + +setup() { + if [[ ${BATS_TEST_DESCRIPTION} =~ 'get_os_release_var' ]] \ + || [[ ${BATS_TEST_DESCRIPTION} =~ 'get_os_version' ]]; then + MOCKED_OS_RELEASE=$(mktemp -p ${BATS_TMPDIR} osrel_XXXX ) + fi +} + +teardown() { + if [[ ${BATS_TEST_NAME} =~ 'get_os_release_var' ]] \ + || [[ ${BATS_TEST_DESCRIPTION} =~ 'get_os_version' ]]; then + rm -f ${MOCKED_OS_RELEASE} + fi +} + +@test 'get_system_arch returns x86_64 architecture' { + function uname() { echo 'x86_64'; } + export -f uname + run get_system_arch + [[ ${status} -eq 0 ]] + [[ ${output} == 'x86_64' ]] +} + +@test 'get_system_arch returns aarch64 architecture' { + function uname() { echo 'aarch64'; } + export -f uname + run get_system_arch + [[ ${status} -eq 0 ]] + [[ ${output} == 'aarch64' ]] +} + +@test 'get_system_arch returns ppc64le architecture' { + function uname() { echo 'ppc64le'; } + export -f uname + run get_system_arch + [[ ${status} -eq 0 ]] + [[ ${output} == 'ppc64le' ]] +} + +@test 'get_system_arch returns s390x architecture' { + function uname() { echo 's390x'; } + export -f uname + run get_system_arch + [[ ${status} -eq 0 ]] + [[ ${output} == 's390x' ]] +} + +@test 'assert_run_as_root passes for root' { + function id() { echo 0; } + export -f id + run assert_run_as_root + [[ ${status} -eq 0 ]] +} + +@test 'assert_run_as_root fails for user' { + function id() { echo 1000; } + export -f id + run assert_run_as_root + [[ ${status} -ne 0 ]] +} + +@test 'assert_secureboot_disabled fails on enabled Secure Boot' { + function mokutil() { + case "$1" in + '--sb-state' ) echo 'SecureBoot enabled' ;; + esac + } + export -f mokutil + run assert_secureboot_disabled + [[ ${status} -ne 0 ]] +} + +@test 'assert_secureboot_disabled passes on disabled Secure Boot' { + function mokutil() { + case "$1" in + '--sb-state' ) echo 'SecureBoot disabled' ;; + esac + } + export -f mokutil + run assert_secureboot_disabled + [[ ${status} -eq 0 ]] +} + +@test 'get_os_release_var extracts VERSION_ID' { + echo 'VERSION_ID="8"' >> ${MOCKED_OS_RELEASE} + export OS_RELEASE_PATH="${MOCKED_OS_RELEASE}" + run get_os_release_var 'VERSION_ID' + [[ ${status} -eq 0 ]] + [[ ${output} -eq 8 ]] +} + +@test 'get_os_release_var extracts ID' { + echo 'ID="centos"' >> ${MOCKED_OS_RELEASE} + export OS_RELEASE_PATH="${MOCKED_OS_RELEASE}" + run get_os_release_var 'ID' + [[ ${status} -eq 0 ]] + [[ ${output} == 'centos' ]] +} + +@test 'get_os_release_var fails on missing variable' { + export OS_RELEASE_PATH="${MOCKED_OS_RELEASE}" + run get_os_release_var 'VERSION_ID' + [[ ${status} -ne 0 ]] + [[ ${output} =~ 'Error' ]] +} + +@test 'get_release_file_url returns default URL' { + run get_release_file_url '8' 'x86_64' + [[ ${status} -eq 0 ]] + [[ ${output} == 'https://repo.almalinux.org/almalinux/almalinux-release-latest-8.x86_64.rpm' ]] +} + +@test 'get_release_file_url returns ALMA_RELEASE_URL environment variable' { + export ALMA_RELEASE_URL='https://example.com/almalinux-release-latest-8.aarch64.rpm' + run get_release_file_url '8' 'aarch64' + [[ ${status} -eq 0 ]] + [[ ${output} == "${ALMA_RELEASE_URL}" ]] +} + +@test 'assert_supported_system passes on CentOS-8 x86_64' { + for os_version in 8 9; do + run assert_supported_system 'centos' "${os_version}" 'x86_64' + [[ ${status} -eq 0 ]] + done +} + +@test 'assert_supported_system fails on unsupported architectures' { + for arch in 'i686' 'armv7l'; do + run assert_supported_system 'centos' '8' "${arch}" + [[ ${status} -ne 0 ]] + [[ ${output} =~ 'ERROR' ]] + done +} + +@test 'assert_supported_system fails on non-EL8' { + for os_version in 6 7; do + run assert_supported_system 'centos' "${os_version}" 'x86_64' + [[ ${status} -ne 0 ]] + [[ ${output} =~ 'ERROR' ]] + done +} + +@test 'assert_supported_system fails on unsupported distributions' { + for os_id in 'fedora'; do + run assert_supported_system "${os_id}" '8' 'x86_64' + [[ ${status} -ne 0 ]] + [[ ${output} =~ 'ERROR' ]] + done +} + +@test 'get_os_version detects CentOS 8.2 Core' { + echo 'CentOS Linux release 8.2.2004 (Core)' >> ${MOCKED_OS_RELEASE} + export REDHAT_RELEASE_PATH="${MOCKED_OS_RELEASE}" + run get_os_version 'centos' + [[ ${status} -eq 0 ]] + [[ ${output} == '8.2' ]] +} + +@test 'get_os_version detects CentOS 8.3' { + echo 'CentOS Linux release 8.3.2011' >> ${MOCKED_OS_RELEASE} + export REDHAT_RELEASE_PATH="${MOCKED_OS_RELEASE}" + run get_os_version 'centos' + [[ ${status} -eq 0 ]] + [[ ${output} == '8.3' ]] +} + +@test 'get_os_version reads OS_RELEASE' { + echo 'VERSION_ID="8"' >> ${MOCKED_OS_RELEASE} + export OS_RELEASE_PATH="${MOCKED_OS_RELEASE}" + run get_os_version 'weirdos' + [[ ${status} -eq 0 ]] + [[ ${output} == '8' ]] +}