From 2714ee46e14e9851be4850177196b76d21a5e538 Mon Sep 17 00:00:00 2001 From: NilashishC Date: Mon, 22 Apr 2019 14:32:49 +0530 Subject: [PATCH 1/4] Add vyos_interfaces resource module Signed-off-by: NilashishC --- LICENSE.txt | 674 ++++++++++++++++++ library/__init__.py | 0 library/vyos_facts.py | 82 +++ library/vyos_interfaces.py | 366 ++++++++++ module_utils/__init__.py | 0 module_utils/vyos/__init__.py | 0 module_utils/vyos/argspec/__init__.py | 0 module_utils/vyos/argspec/facts/__init__.py | 0 module_utils/vyos/argspec/facts/facts.py | 23 + .../vyos/argspec/interfaces/__init__.py | 0 .../vyos/argspec/interfaces/interfaces.py | 36 + module_utils/vyos/config/__init__.py | 0 module_utils/vyos/config/base.py | 24 + .../vyos/config/interfaces/__init__.py | 0 .../vyos/config/interfaces/interfaces.py | 248 +++++++ module_utils/vyos/facts/__init__.py | 0 module_utils/vyos/facts/base.py | 109 +++ module_utils/vyos/facts/facts.py | 77 ++ .../vyos/facts/interfaces/__init__.py | 0 .../vyos/facts/interfaces/interfaces.py | 80 +++ module_utils/vyos/utils/__init__.py | 0 module_utils/vyos/utils/utils.py | 20 + 22 files changed, 1739 insertions(+) create mode 100644 LICENSE.txt create mode 100644 library/__init__.py create mode 100644 library/vyos_facts.py create mode 100644 library/vyos_interfaces.py create mode 100644 module_utils/__init__.py create mode 100644 module_utils/vyos/__init__.py create mode 100644 module_utils/vyos/argspec/__init__.py create mode 100644 module_utils/vyos/argspec/facts/__init__.py create mode 100644 module_utils/vyos/argspec/facts/facts.py create mode 100644 module_utils/vyos/argspec/interfaces/__init__.py create mode 100644 module_utils/vyos/argspec/interfaces/interfaces.py create mode 100644 module_utils/vyos/config/__init__.py create mode 100644 module_utils/vyos/config/base.py create mode 100644 module_utils/vyos/config/interfaces/__init__.py create mode 100644 module_utils/vyos/config/interfaces/interfaces.py create mode 100644 module_utils/vyos/facts/__init__.py create mode 100644 module_utils/vyos/facts/base.py create mode 100644 module_utils/vyos/facts/facts.py create mode 100644 module_utils/vyos/facts/interfaces/__init__.py create mode 100644 module_utils/vyos/facts/interfaces/interfaces.py create mode 100644 module_utils/vyos/utils/__init__.py create mode 100644 module_utils/vyos/utils/utils.py diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE.txt @@ -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/library/__init__.py b/library/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/library/vyos_facts.py b/library/vyos_facts.py new file mode 100644 index 0000000..69e684a --- /dev/null +++ b/library/vyos_facts.py @@ -0,0 +1,82 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +""" +The module file for vyos_facts +""" + +from __future__ import absolute_import, division, print_function +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.connection import Connection +from ansible.module_utils. \ + vyos.facts.facts import Facts + +ANSIBLE_METADATA = {'metadata_version': '1.1', + 'status': [u'preview'], + 'supported_by': [u'Ansible Network']} + + +DOCUMENTATION = """ +--- +module: vyos_facts +version_added: 2.9 +short_description: Get facts about vyos devices. +description: + - Collects facts from network devices running the vyos operating + system. This module places the facts gathered in the fact tree keyed by the + respective resource name. The facts module will always collect a + base set of facts from the device and can enable or disable + collection of additional facts. +author: [u'Nilashish Chakraborty (@nilashishc)'] +options: + gather_subset: + description: + - When supplied, this argument will restrict the facts collected + to a given subset. Possible values for this argument include + all, and net_configuration_. Can specify a + list of values to include a larger subset. Values can also be used + with an initial C(M(!)) to specify that a specific subset should + not be collected. + required: false + default: 'all' + version_added: "2.2" +""" + +EXAMPLES = """ +# Gather all facts +- vyos_facts: + gather_subset: all + +# Collect only the interfaces and default facts +- vyos_facts: + gather_subset: + - net_configuration_interfaces + +# Do not collect interfaces facts +- vyos_facts: + gather_subset: + - "!net_configuration_interfaces" +""" + +RETURN = """ +See the respective resource module parameters for the tree. +""" + +def main(): + """ + Main entry point for module execution + + :returns: ansible_facts + """ + module = AnsibleModule(argument_spec=Facts.argument_spec, + supports_check_mode=True) + warnings = list() + + connection = Connection(module._socket_path) #pylint: disable=W0212 + gather_subset = module.params['gather_subset'] + ansible_facts = Facts().get_facts(module, connection, gather_subset) + module.exit_json(ansible_facts=ansible_facts, warnings=warnings) + +if __name__ == '__main__': + main() diff --git a/library/vyos_interfaces.py b/library/vyos_interfaces.py new file mode 100644 index 0000000..3926684 --- /dev/null +++ b/library/vyos_interfaces.py @@ -0,0 +1,366 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +############################################## +################# WARNING #################### +############################################## +### +### This file is auto generated by the resource +### module builder playbook. +### +### Do not edit this file manually. +### +### Changes to this file will be over written +### by the resource module builder. +### +### Changes should be made in the model used to +### generate this file or in the resource module +### builder template. +### +############################################## +############################################## +############################################## + +""" +The module file for vyos_interfaces +""" + +from __future__ import absolute_import, division, print_function +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils. \ + vyos.config.interfaces.interfaces import Interfaces + +ANSIBLE_METADATA = {'metadata_version': '1.1', + 'status': [u'preview'], + 'supported_by': [u'Ansible Network']} + + +DOCUMENTATION = """ +--- +module: vyos_interfaces +version_added: 2.9 +short_description: Manages Interfaces attributes of devices running VyOS. +description: [u'Manages interfaces attributes of devices running VyOS.'] +author: [u'Nilashish Chakraborty (@nilashishc)'] +options: + config: + description: The provided configuration + suboptions: + description: + description: + - Description for the interface. + type: str + duplex: + choices: + - full + - half + - auto + description: + - Interface link duplex mode status. + type: str + enable: + default: true + description: + - Administrative state of the interface. + type: bool + mtu: + description: + - Maximum Transmission Unit size for the interface. + - The value should be between 68 to 9000 + type: str + name: + description: + - Name of the interface, i.e., eth0, eth1. + type: str + speed: + choices: + - auto + - '10' + - '100' + - '1000' + - '2500' + - '10000' + description: + - Interface link speed. + type: str + state: + choices: + - merged + - replaced + - overridden + - deleted + default: merged + description: + - The state the configuration should be left in. + type: str + +""" + +EXAMPLES = """ +# Using merged +# +# Before state: +# ------------- +# +# vyos:~$ show configuration commands | grep -e eth[2,3] +# set interfaces ethernet eth2 description 'Ethernet Interface #3' +# set interfaces ethernet eth2 'disable' +# set interfaces ethernet eth2 duplex 'full' +# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79' +# set interfaces ethernet eth2 mtu '500' +# set interfaces ethernet eth2 smp_affinity 'auto' +# set interfaces ethernet eth2 speed '100' +# set interfaces ethernet eth3 description 'Configured by Ansible' +# set interfaces ethernet eth3 duplex 'full' +# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85' +# set interfaces ethernet eth3 mtu '1200' +# set interfaces ethernet eth3 smp_affinity 'auto' +# set interfaces ethernet eth3 speed '100' +# + +- name: Merge provided configuration with device configuration + vyos_interfaces: + config: + - name: eth2 + description: 'Configured by Ansible' + enable: True + + - name: eth3 + description: 'Configured by Ansible' + mtu: 1500 + state: merged + +# After state: +# ------------- +# +# vyos:~$ show configuration commands | grep -e eth[2,3] +# set interfaces ethernet eth2 description 'Configured by Ansible' +# set interfaces ethernet eth2 duplex 'full' +# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79' +# set interfaces ethernet eth2 mtu '500' +# set interfaces ethernet eth2 smp_affinity 'auto' +# set interfaces ethernet eth2 speed '100' +# set interfaces ethernet eth3 description 'Configured by Ansible' +# set interfaces ethernet eth3 duplex 'full' +# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85' +# set interfaces ethernet eth3 mtu '1500' +# set interfaces ethernet eth3 smp_affinity 'auto' +# set interfaces ethernet eth3 speed '100 + +# Using replaced +# +# Before state: +# ------------- +# +# vyos:~$ show configuration commands | grep eth +# set interfaces ethernet eth0 address 'dhcp' +# set interfaces ethernet eth0 description 'Management Interface for the Appliance' +# set interfaces ethernet eth0 duplex 'auto' +# set interfaces ethernet eth0 hw-id '08:00:27:f3:6c:b5' +# set interfaces ethernet eth0 smp_affinity 'auto' +# set interfaces ethernet eth0 speed 'auto' +# set interfaces ethernet eth1 description 'Configured by Ansible Eng Team' +# set interfaces ethernet eth1 duplex 'full' +# set interfaces ethernet eth1 hw-id '08:00:27:ad:ef:65' +# set interfaces ethernet eth1 smp_affinity 'auto' +# set interfaces ethernet eth1 speed '100' +# set interfaces ethernet eth2 description 'Configured by Ansible' +# set interfaces ethernet eth2 duplex 'full' +# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79' +# set interfaces ethernet eth2 mtu '500' +# set interfaces ethernet eth2 smp_affinity 'auto' +# set interfaces ethernet eth2 speed '100' +# set interfaces ethernet eth3 description 'Configured by Ansible' +# set interfaces ethernet eth3 duplex 'full' +# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85' +# set interfaces ethernet eth3 mtu '1500' +# set interfaces ethernet eth3 smp_affinity 'auto' +# set interfaces ethernet eth3 speed '100' + +- name: Replace device configurations of listed interfaces with provided configurations + vyos_interfaces: + config: + - name: eth2 + description: "Replaced by Ansible" + + - name: eth3 + description: "Replaced by Ansible" + + - name: eth1 + description: "Replaced by Ansible" + state: replaced + +# After state: +# ------------- +# +# vyos:~$ show configuration commands | grep eth +# set interfaces ethernet eth0 address 'dhcp' +# set interfaces ethernet eth0 description 'Management Interface for the Appliance' +# set interfaces ethernet eth0 duplex 'auto' +# set interfaces ethernet eth0 hw-id '08:00:27:f3:6c:b5' +# set interfaces ethernet eth0 smp_affinity 'auto' +# set interfaces ethernet eth0 speed 'auto' +# set interfaces ethernet eth1 description 'Replaced by Ansible' +# set interfaces ethernet eth1 hw-id '08:00:27:ad:ef:65' +# set interfaces ethernet eth1 smp_affinity 'auto' +# set interfaces ethernet eth2 description 'Replaced by Ansible' +# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79' +# set interfaces ethernet eth2 smp_affinity 'auto' +# set interfaces ethernet eth3 description 'Replaced by Ansible' +# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85' +# set interfaces ethernet eth3 smp_affinity 'auto' + +# Using overridden +# +# Before state +# -------------- +# +# vyos@vyos-appliance:~$ show configuration commands | grep eth +# set interfaces ethernet eth0 address 'dhcp' +# set interfaces ethernet eth0 description 'Ethernet Interface - 0' +# set interfaces ethernet eth0 duplex 'auto' +# set interfaces ethernet eth0 hw-id '08:00:27:f3:6c:b5' +# set interfaces ethernet eth0 smp_affinity 'auto' +# set interfaces ethernet eth0 speed 'auto' +# set interfaces ethernet eth0 mtu '1200' +# set interfaces ethernet eth1 address '192.168.1.120/24' +# set interfaces ethernet eth1 description 'Configured by Ansible Eng Team' +# set interfaces ethernet eth1 duplex 'full' +# set interfaces ethernet eth1 hw-id '08:00:27:ad:ef:65' +# set interfaces ethernet eth1 mtu '100' +# set interfaces ethernet eth1 smp_affinity 'auto' +# set interfaces ethernet eth1 speed '100' +# set interfaces ethernet eth2 description 'Configured by Ansible Team (Admin Down)' +# set interfaces ethernet eth2 duplex 'full' +# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79' +# set interfaces ethernet eth2 mtu '600' +# set interfaces ethernet eth2 smp_affinity 'auto' +# set interfaces ethernet eth2 speed '100' +# set interfaces ethernet eth3 description 'Configured by Ansible Network' +# set interfaces ethernet eth3 duplex 'full' +# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85' +# set interfaces ethernet eth3 smp_affinity 'auto' +# set interfaces ethernet eth3 speed '100' + +- name: Overrides all device configuration with provided configuration + vyos_interfaces: + config: + - name: eth1 + description: Outbound Interface For The Appliance + + - name: eth2 + speed: auto + duplex: auto + + - name: eth3 + mtu: 1200 + state: overridden + +# After state +# ------------ +# +# vyos@vyos-appliance:~$ show configuration commands | grep eth +# set interfaces ethernet eth0 address 'dhcp' +# set interfaces ethernet eth0 hw-id '08:00:27:f3:6c:b5' +# set interfaces ethernet eth0 smp_affinity 'auto' +# set interfaces ethernet eth1 address '192.168.1.120/24' +# set interfaces ethernet eth1 description 'Outbound Interface For The Appliance' +# set interfaces ethernet eth1 hw-id '08:00:27:ad:ef:65' +# set interfaces ethernet eth1 smp_affinity 'auto' +# set interfaces ethernet eth2 duplex 'auto' +# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79' +# set interfaces ethernet eth2 smp_affinity 'auto' +# set interfaces ethernet eth2 speed 'auto' +# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85' +# set interfaces ethernet eth3 mtu '1200' +# set interfaces ethernet eth3 smp_affinity 'auto' + +# Using deleted +# +# Before state +# ------------- +# vyos@vyos-appliance:~$ show configuration commands | grep eth +# set interfaces ethernet eth0 address 'dhcp' +# set interfaces ethernet eth0 description 'Outbound Interface for this appliance' +# set interfaces ethernet eth0 duplex 'auto' +# set interfaces ethernet eth0 hw-id '08:00:27:f3:6c:b5' +# set interfaces ethernet eth0 smp_affinity 'auto' +# set interfaces ethernet eth0 speed 'auto' +# set interfaces ethernet eth1 description 'Configured by Ansible Network' +# set interfaces ethernet eth1 duplex 'full' +# set interfaces ethernet eth1 hw-id '08:00:27:ad:ef:65' +# set interfaces ethernet eth1 smp_affinity 'auto' +# set interfaces ethernet eth1 speed '100' +# set interfaces ethernet eth2 description 'Configured by Ansible' +# set interfaces ethernet eth2 duplex 'full' +# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79' +# set interfaces ethernet eth2 mtu '600' +# set interfaces ethernet eth2 smp_affinity 'auto' +# set interfaces ethernet eth2 speed '100' +# set interfaces ethernet eth3 description 'Configured by Ansible Network' +# set interfaces ethernet eth3 duplex 'full' +# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85' +# set interfaces ethernet eth3 smp_affinity 'auto' +# set interfaces ethernet eth3 speed '100' + +- name: Delete attributes of given interfaces (Note: This won't delete the interface itself) + vyos_interfaces: + config: + - name: "{{ item }}" + state: deleted + loop: + - eth1 + - eth2 + - eth3 + +# After state +# ------------ +# vyos@vyos-appliance:~$ show configuration commands | grep eth +# set interfaces ethernet eth0 address 'dhcp' +# set interfaces ethernet eth0 description 'Outbound Interface for this appliance' +# set interfaces ethernet eth0 duplex 'auto' +# set interfaces ethernet eth0 hw-id '08:00:27:f3:6c:b5' +# set interfaces ethernet eth0 smp_affinity 'auto' +# set interfaces ethernet eth0 speed 'auto' +# set interfaces ethernet eth1 address '192.168.1.120/24' +# set interfaces ethernet eth1 hw-id '08:00:27:ad:ef:65' +# set interfaces ethernet eth1 smp_affinity 'auto' +# set interfaces ethernet eth2 hw-id '08:00:27:ab:4e:79' +# set interfaces ethernet eth2 smp_affinity 'auto' +# set interfaces ethernet eth3 hw-id '08:00:27:17:3c:85' +# set interfaces ethernet eth3 smp_affinity 'auto' +""" + +RETURN = """ +before: + description: The configuration prior to the model invocation. + returned: always + sample: The configuration returned will always be in the same format of the parameters above. +after: + description: The resulting configuration model invocation. + returned: when changed + sample: The configuration returned will always be in the same format of the parameters above. +commands: + description: The set of commands pushed to the remote device. + returned: always + type: list + sample: [set interfaces ethernet eth0 mtu 1500', 'set interfaces ethernet eth1 description Configured by Ansible'] +""" + + +def main(): + """ + Main entry point for module execution + + :returns: the result form module invocation + """ + module = AnsibleModule(argument_spec=Interfaces.argument_spec, + supports_check_mode=True) + + result = Interfaces(module).execute_module() + module.exit_json(**result) + +if __name__ == '__main__': + main() diff --git a/module_utils/__init__.py b/module_utils/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/__init__.py b/module_utils/vyos/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/argspec/__init__.py b/module_utils/vyos/argspec/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/argspec/facts/__init__.py b/module_utils/vyos/argspec/facts/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/argspec/facts/facts.py b/module_utils/vyos/argspec/facts/facts.py new file mode 100644 index 0000000..78f2653 --- /dev/null +++ b/module_utils/vyos/argspec/facts/facts.py @@ -0,0 +1,23 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +""" +The arg spec for the vyos facts module. +""" + +class FactsArgs(object): #pylint: disable=R0903 + """ The arg spec for the vyos facts module + """ + + def __init__(self, **kwargs): + pass + + choices = [ + 'all', + 'net_configuration_interfaces', + ] + + argument_spec = { + 'gather_subset': dict(default=['all'], choices=choices, type='list') + } diff --git a/module_utils/vyos/argspec/interfaces/__init__.py b/module_utils/vyos/argspec/interfaces/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/argspec/interfaces/interfaces.py b/module_utils/vyos/argspec/interfaces/interfaces.py new file mode 100644 index 0000000..318f5e4 --- /dev/null +++ b/module_utils/vyos/argspec/interfaces/interfaces.py @@ -0,0 +1,36 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +############################################# +################# WARNING #################### +############################################## +### +### This file is auto generated by the resource +### module builder playbook. +### +### Do not edit this file manually. +### +### Changes to this file will be over written +### by the resource module builder. +### +### Changes should be made in the model used to +### generate this file or in the resource module +### builder template. +### +############################################## +############################################## +############################################## +""" +The arg spec for the vyos_interfaces module +""" + +class InterfacesArgs(object): #pylint: disable=R0903 + """The arg spec for the vyos_interfaces module + """ + + def __init__(self, **kwargs): + pass + + argument_spec = {u'state': {'default': u'merged', 'required': False, 'type': u'str', 'choices': [u'merged', u'replaced', u'overridden', u'deleted']}, u'config': {'elements': u'dict', 'type': 'list', 'options': {u'enable': {'default': True, 'required': False, 'type': u'bool'}, u'description': {'required': False, 'type': u'str'}, u'duplex': {'required': False, 'type': u'str', 'choices': [u'full', u'half', u'auto']}, u'mtu': {'required': False, 'type': u'str'}, u'speed': {'required': False, 'type': u'str', 'choices': [u'auto', u'10', u'100', u'1000', u'2500', u'10000']}, u'name': {'required': False, 'type': u'str'}}}} #pylint: disable=C0301 diff --git a/module_utils/vyos/config/__init__.py b/module_utils/vyos/config/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/config/base.py b/module_utils/vyos/config/base.py new file mode 100644 index 0000000..39da136 --- /dev/null +++ b/module_utils/vyos/config/base.py @@ -0,0 +1,24 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +""" +The base class for all vyos resource modules +""" + +from ansible.module_utils.connection import Connection + +class ConfigBase(object): #pylint: disable=R0205,R0903 + """ The base class for all vyos resource modules + """ + _connection = None + + def __init__(self, module): + self._module = module + self._connection = self._get_connection() + + def _get_connection(self): + if self._connection: + return self._connection + self._connection = Connection(self._module._socket_path) #pylint: disable=W0212 + return self._connection diff --git a/module_utils/vyos/config/interfaces/__init__.py b/module_utils/vyos/config/interfaces/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/config/interfaces/interfaces.py b/module_utils/vyos/config/interfaces/interfaces.py new file mode 100644 index 0000000..e1eaaae --- /dev/null +++ b/module_utils/vyos/config/interfaces/interfaces.py @@ -0,0 +1,248 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +""" +The vyos_interfaces class +It is in this file where the current configuration (as dict) +is compared to the provided configuration (as dict) and the command set +necessary to bring the current configuration to it's desired end-state is +created +""" +from ansible.module_utils.network.common.utils import to_list +from ansible.module_utils. \ + vyos.argspec.interfaces.interfaces import InterfacesArgs +from ansible.module_utils. \ + vyos. \ + config.base import ConfigBase +from ansible.module_utils. \ + vyos.facts.facts import Facts +from ansible.module_utils. \ + vyos.utils.utils import search_obj_in_list, get_interface_type + + +class Interfaces(ConfigBase, InterfacesArgs): + """ + The vyos_interfaces class + """ + + gather_subset = [ + 'net_configuration_interfaces', + ] + + params = ('speed', 'description', 'duplex', 'mtu') + + def get_interfaces_facts(self): + """ Get the 'facts' (the current configuration) + + :rtype: A dictionary + :returns: The current configuration as a dictionary + """ + facts = Facts().get_facts(self._module, self._connection, self.gather_subset) + interfaces_facts = facts['net_configuration'].get('interfaces') + if not interfaces_facts: + return [] + return interfaces_facts + + def execute_module(self): + """ Execute the module + + :rtype: A dictionary + :returns: The result from module execution + """ + result = {'changed': False} + commands = list() + warnings = list() + + existing_interface_facts = self.get_interfaces_facts() + commands.extend(self.set_config()) + if commands: + if self._module.check_mode: + resp = self._connection.edit_config(commands, commit=False) + else: + resp = self._connection.edit_config(commands) + result['changed'] = True + + result['commands'] = commands + + if self._module._diff: + result['diff'] = resp['diff'] if result['changed'] else None + + changed_interfaces_facts = self.get_interfaces_facts() + + result['before'] = existing_interface_facts + if result['changed']: + result['after'] = changed_interfaces_facts + + result['warnings'] = warnings + return result + + def set_config(self): + """ Collect the configuration from the args passed to the module, + collect the current configuration (as a dict from facts) + + :rtype: A list + :returns: the commands necessary to migrate the current configuration + to the desired configuration + """ + want = self._module.params['config'] + for w in want: + if 'name' in w: + w.update({'name': w['name']}) + have = self.get_interfaces_facts() + resp = self.set_state(want, have) + return to_list(resp) + + def set_state(self, want, have): + """ Select the appropriate function based on the state provided + + :param want: the desired configuration as a dictionary + :param have: the current configuration as a dictionary + :rtype: A list + :returns: the commands necessary to migrate the current configuration + to the desired configuration + """ + commands = [] + + state = self._module.params['state'] + if state == 'overridden': + commands.extend(Interfaces._state_overridden(want=want, have=have)) + else: + for w in want: + name = w['name'] + obj_in_have = search_obj_in_list(name, have) + if state == 'deleted': + commands.extend(Interfaces._state_deleted(want_intf=w, have_intf=obj_in_have)) + + elif state == 'merged': + commands.extend(Interfaces._state_merged(want_intf=w, have_intf=obj_in_have)) + + elif state == 'replaced': + commands.extend(Interfaces._state_replaced(want_intf=w, have_intf=obj_in_have)) + + return commands + + @staticmethod + def _state_replaced(**kwargs): + """ The command generator when state is replaced + + :rtype: A list + :returns: the commands necessary to migrate the current configuration + to the desired configuration + """ + commands = [] + + w = kwargs['want_intf'] + obj_in_have = kwargs['have_intf'] + + name = w['name'] + delete_interface = 'delete interfaces ethernet ' + name + + if obj_in_have: + for item in Interfaces.params: + value = obj_in_have.get(item) + if value and w[item] != value: + commands.append(delete_interface + ' ' + item + " '" + value + "'") + if obj_in_have['enable'] != w['enable']: + commands.append(delete_interface + ' disable') + + commands.extend(Interfaces._state_merged(want_intf=w, have_intf=obj_in_have)) + + return commands + + @staticmethod + def _state_overridden(**kwargs): + """ The command generator when state is overridden + + :rtype: A list + :returns: the commands necessary to migrate the current configuration + to the desired configuration + """ + commands = [] + + want = kwargs['want'] + have = kwargs['have'] + + for h in have: + name = h['name'] + obj_in_want = search_obj_in_list(name, want) + + delete_interface = 'delete interfaces ethernet ' + name + + if not obj_in_want: + for item in Interfaces.params: + if h.get(item): + commands.append(delete_interface + ' ' + item) + + for w in want: + name = w['name'] + obj_in_have = search_obj_in_list(name, have) + commands.extend(Interfaces._state_replaced(want_intf=w, have_intf=obj_in_have)) + + return commands + + @staticmethod + def _state_merged(**kwargs): + """ The command generator when state is merged + + :rtype: A list + :returns: the commands necessary to merge the provided into + the current configuration + """ + commands = [] + + w = kwargs['want_intf'] + obj_in_have = kwargs['have_intf'] + + name = w['name'] + set_interface = 'set interfaces ethernet ' + name + delete_interface = 'delete interfaces ethernet ' + name + + if obj_in_have: + for item in Interfaces.params: + value = w[item] + if value and str(value) != obj_in_have.get(item): + commands.append(set_interface + ' ' + item + " '" + value + "'") + + if w['enable'] and not obj_in_have['enable']: + commands.append(delete_interface + ' disable') + + elif not w['enable'] and obj_in_have['enable']: + commands.append(set_interface + ' disable') + + else: + commands.append(set_interface) + for item in Interfaces.params: + value = w[item] + if value: + commands.append(set_interface + ' ' + item + " '" + value + "'") + + if not w['enable']: + commands.append(set_interface + ' disable') + + return commands + + @staticmethod + def _state_deleted(**kwargs): + """ The command generator when state is deleted + + :rtype: A list + :returns: the commands necessary to remove the current configuration + of the provided objects + """ + commands = [] + + w = kwargs['want_intf'] + obj_in_have = kwargs['have_intf'] + + name = w['name'] + delete_interface = 'delete interfaces ethernet ' + name + + if obj_in_have: + for item in Interfaces.params: + if obj_in_have.get(item): + commands.append(delete_interface + ' ' + item) + if not obj_in_have.get('enable'): + commands.append(delete_interface + ' disable') + + return commands diff --git a/module_utils/vyos/facts/__init__.py b/module_utils/vyos/facts/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/facts/base.py b/module_utils/vyos/facts/base.py new file mode 100644 index 0000000..839a49f --- /dev/null +++ b/module_utils/vyos/facts/base.py @@ -0,0 +1,109 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +""" +The vyos facts base class +this contains methods common to all facts subsets +""" + +import re +from copy import deepcopy +from ansible.module_utils.six import iteritems + + +class FactsBase(object): #pylint: disable=R0205 + """ + The vyos facts base class + """ + generated_spec = {} + ansible_facts = {'net_configuration': {}} + + def __init__(self, argspec, subspec=None, options=None): + spec = deepcopy(argspec) + if subspec: + if options: + facts_argument_spec = spec[subspec][options] + else: + facts_argument_spec = spec[subspec] + else: + facts_argument_spec = spec + + self.generated_spec = self.generate_dict(facts_argument_spec) + + @staticmethod + def generate_dict(spec): + """ + Generate dictionary which is in sync with argspec + + :param spec: A dictionary which the argspec of module + :rtype: A dictionary + :returns: A dictionary in sync with argspec with default value + """ + obj = {} + if not spec: + return obj + + for key, val in iteritems(spec): + if 'default' in val: + dct = {key: val['default']} + else: + dct = {key: None} + obj.update(dct) + + return obj + + @staticmethod + def parse_conf_arg(cfg, arg): + """ + Parse config based on argument + + :param cfg: A text string which is a line of configuration. + :param arg: A text string which is to be matched. + :rtype: A text string + :returns: A text string if match is found + """ + result = None + match = re.search(r'%s (.+)(\n|$)' % arg, cfg, re.M) + if match: + result = match.group(1).strip("'") + return result + + @staticmethod + def parse_conf_cmd_arg(cfg, cmd, res1, res2=None): + """ + Parse config based on command + + :param cfg: A text string which is a line of configuration. + :param cmd: A text string which is the command to be matched + :param res1: A text string to be returned if the command is present + :param res2: A text string to be returned if the negate command is present + :rtype: A text string + :returns: A text string if match is found + """ + match = re.search(r'\n\s+%s(\n|$)' % cmd, cfg) + if match: + return res1 + if res2 is not None: + match = re.search(r'\n\s+no %s(\n|$)' % cmd, cfg) + if match: + return res2 + return None + + @staticmethod + def generate_final_config(cfg_dict): + """ + Generate final config dictionary + + :param cfg_dict: A dictionary parsed in the facts system + :rtype: A dictionary + :returns: A dictionary by eliminating keys that have null values + """ + final_cfg = {} + if not cfg_dict: + return final_cfg + + for key, val in iteritems(cfg_dict): + if val is not None: + final_cfg.update({key:val}) + return final_cfg diff --git a/module_utils/vyos/facts/facts.py b/module_utils/vyos/facts/facts.py new file mode 100644 index 0000000..79335db --- /dev/null +++ b/module_utils/vyos/facts/facts.py @@ -0,0 +1,77 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +""" +The facts class for vyos +this file validates each subset of facts and selectively +calls the appropriate facts gathering function +""" + +from ansible.module_utils. \ + vyos.argspec.facts.facts import FactsArgs +from ansible.module_utils. \ + vyos.argspec.interfaces.interfaces import InterfacesArgs +from ansible.module_utils. \ + vyos.facts.base import FactsBase +from ansible.module_utils. \ + vyos.facts.interfaces.interfaces import InterfacesFacts + +class Facts(FactsArgs, FactsBase): #pylint: disable=R0903 + """ The fact class for vyos + """ + + def get_facts(self, module, connection, gather_subset=['all']): + """ Collect the facts for vyos + + :param module: The module instance + :param connection: The device connection + :param gather_subset: The facts subset to collect + :rtype: dict + :returns: the facts gathered + """ + valid_subsets = self.argument_spec['gather_subset'].get('choices', []) + if valid_subsets and 'all' in valid_subsets: + valid_subsets.remove('all') + + runable_subsets = set() + exclude_subsets = set() + if not gather_subset: + gather_subset = ['all'] + + for subset in gather_subset: + if subset == 'all': + runable_subsets.update(valid_subsets) + continue + if subset.startswith('!'): + subset = subset[1:] + if subset == 'all': + exclude_subsets.update(valid_subsets) + continue + exclude = True + else: + exclude = False + + if subset not in valid_subsets: + module.fail_json(msg='Bad subset') + + if exclude: + exclude_subsets.add(subset) + else: + runable_subsets.add(subset) + + if not runable_subsets: + runable_subsets.update(valid_subsets) + + runable_subsets.difference_update(exclude_subsets) + self.ansible_facts['gather_subset'] = list(runable_subsets) + + for attr in runable_subsets: + getattr(self, '_get_%s' % attr, {})(module, connection) + + return self.ansible_facts + + @staticmethod + def _get_net_configuration_interfaces(module, connection): + return InterfacesFacts(InterfacesArgs. \ + argument_spec, 'config', 'options').populate_facts(module, connection) diff --git a/module_utils/vyos/facts/interfaces/__init__.py b/module_utils/vyos/facts/interfaces/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/facts/interfaces/interfaces.py b/module_utils/vyos/facts/interfaces/interfaces.py new file mode 100644 index 0000000..1ff083c --- /dev/null +++ b/module_utils/vyos/facts/interfaces/interfaces.py @@ -0,0 +1,80 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +""" +The vyos interfaces fact class +It is in this file the configuration is collected from the device +for a given resource, parsed, and the facts tree is populated +based on the configuration. +""" +from copy import deepcopy +from ansible.module_utils. \ + vyos.facts.base import FactsBase +from re import findall, M +import q + +class InterfacesFacts(FactsBase): + """ The vyos interfaces fact class + """ + + def populate_facts(self, module, connection, data=None): + """ Populate the facts for interfaces + + :param module: the module instance + :param connection: the device connection + :param data: previously collected conf + :rtype: dictionary + :returns: facts + """ + if module: #just for linting purposes + pass + if connection: #just for linting purposes + pass + + if not data: + data = connection.get_config() + + objs = [] + + interface_names = findall(r'^set interfaces ethernet (\S+)', data, M) + if interface_names: + for interface in set(interface_names): + intf_regex = r' %s .+$' % interface + cfg = findall(intf_regex, data, M) + cfg = '\n'.join(cfg) + obj = self.render_config(self.generated_spec, cfg) + obj['name'] = interface + if obj: + objs.append(obj) + facts = {} + if objs: + facts['interfaces'] = objs + self.ansible_facts['net_configuration'].update(facts) + return self.ansible_facts + + def render_config(self, spec, conf): + """ + Render config as dictionary structure and delete keys from spec for null values + + :param spec: The facts tree, generated from the argspec + :param conf: The configuration + :rtype: dictionary + :returns: The generated config + """ + if conf: + pass + + config = deepcopy(spec) + + # populate the facts from the configuration + attribs = ['description','speed', 'mtu', 'duplex'] + + for x in attribs: + config[x] = self.parse_conf_arg(conf, x) + if '\'disable\'' in conf: + config['enable'] = False + else: + config['enable'] = True + + return self.generate_final_config(config) diff --git a/module_utils/vyos/utils/__init__.py b/module_utils/vyos/utils/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/module_utils/vyos/utils/utils.py b/module_utils/vyos/utils/utils.py new file mode 100644 index 0000000..7689494 --- /dev/null +++ b/module_utils/vyos/utils/utils.py @@ -0,0 +1,20 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# Copyright 2019 Red Hat +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +# utils + +def search_obj_in_list(name, lst): + for o in lst: + if o['name'] == name: + return o + return None + +def get_interface_type(interface): + """Gets the type of interface + """ + if interface.upper().startswith('ET'): + return 'ethernet' + else: + return 'unknown' From 84f580b6bf7b60db841de5241fc4fbf11bc9b378 Mon Sep 17 00:00:00 2001 From: NilashishC Date: Tue, 23 Apr 2019 17:59:53 +0530 Subject: [PATCH 2/4] Add integration tests Signed-off-by: NilashishC --- .../vyos/config/interfaces/interfaces.py | 4 +- tests/vyos/modules/interfaces/deleted.yaml | 36 +++++++++++++ tests/vyos/modules/interfaces/main.yaml | 15 ++++++ tests/vyos/modules/interfaces/merged.yaml | 52 +++++++++++++++++++ tests/vyos/modules/interfaces/overridden.yaml | 36 +++++++++++++ tests/vyos/modules/interfaces/populate.yaml | 16 ++++++ .../modules/interfaces/remove_config.yaml | 17 ++++++ tests/vyos/modules/interfaces/replaced.yaml | 38 ++++++++++++++ 8 files changed, 212 insertions(+), 2 deletions(-) create mode 100644 tests/vyos/modules/interfaces/deleted.yaml create mode 100644 tests/vyos/modules/interfaces/main.yaml create mode 100644 tests/vyos/modules/interfaces/merged.yaml create mode 100644 tests/vyos/modules/interfaces/overridden.yaml create mode 100644 tests/vyos/modules/interfaces/populate.yaml create mode 100644 tests/vyos/modules/interfaces/remove_config.yaml create mode 100644 tests/vyos/modules/interfaces/replaced.yaml diff --git a/module_utils/vyos/config/interfaces/interfaces.py b/module_utils/vyos/config/interfaces/interfaces.py index e1eaaae..67ef16a 100644 --- a/module_utils/vyos/config/interfaces/interfaces.py +++ b/module_utils/vyos/config/interfaces/interfaces.py @@ -141,8 +141,8 @@ def _state_replaced(**kwargs): if obj_in_have: for item in Interfaces.params: value = obj_in_have.get(item) - if value and w[item] != value: - commands.append(delete_interface + ' ' + item + " '" + value + "'") + if value and not w[item]: + commands.append(delete_interface + ' ' + item) if obj_in_have['enable'] != w['enable']: commands.append(delete_interface + ' disable') diff --git a/tests/vyos/modules/interfaces/deleted.yaml b/tests/vyos/modules/interfaces/deleted.yaml new file mode 100644 index 0000000..f3d0b58 --- /dev/null +++ b/tests/vyos/modules/interfaces/deleted.yaml @@ -0,0 +1,36 @@ +--- +- debug: + msg: "Start vyos_interfaces deleted integration tests ansible_connection={{ ansible_connection }}" + +- include_tasks: populate.yaml + +- name: Delete attributes of given interfaces + vyos_interfaces: &deleted + config: + - name: eth1 + + - name: eth2 + state: deleted + register: result + +- assert: + that: + - "'delete interfaces ethernet {{ intf }} description' in result.commands" + - "'delete interfaces ethernet {{ intf }} speed' in result.commands" + - "'delete interfaces ethernet {{ intf }} duplex' in result.commands" + - "'delete interfaces ethernet {{ intf }} mtu' in result.commands" + loop: + - eth1 + - eth2 + loop_control: + loop_var: intf + +- name: Delete attributes of given interfaces (IDEMPOTENT) + vyos_interfaces: *deleted + register: result + +- assert: + that: + - "result.changed == false" + +- include_tasks: remove_config.yaml diff --git a/tests/vyos/modules/interfaces/main.yaml b/tests/vyos/modules/interfaces/main.yaml new file mode 100644 index 0000000..4163016 --- /dev/null +++ b/tests/vyos/modules/interfaces/main.yaml @@ -0,0 +1,15 @@ +--- +- hosts: vyos-appliance + gather_facts: yes + gather_subset: + - net_configuration_interfaces + tasks: + - import_role: + name: ~/collections/network + + - include_tasks: "{{ item }}.yaml" + loop: + - merged + - replaced + - overridden + - deleted diff --git a/tests/vyos/modules/interfaces/merged.yaml b/tests/vyos/modules/interfaces/merged.yaml new file mode 100644 index 0000000..14432ec --- /dev/null +++ b/tests/vyos/modules/interfaces/merged.yaml @@ -0,0 +1,52 @@ +--- +- debug: + msg: "START vyos_interfaces merged integration tests on connection={{ ansible_connection }}" + +- include_tasks: remove_config.yaml + +- name: Merge the provided configuration with the exisiting running configuration + vyos_interfaces: &merged + config: + - name: eth1 + description: "Configured by Ansible - Interface 1" + mtu: 1200 + speed: auto + duplex: auto + + - name: eth2 + description: "Configured by Ansible - Interface 2 (ADMIN DOWN)" + mtu: 600 + enable: False + + - name: eth3 + description: "Configured by Ansible - Interface 3" + speed: 100 + duplex: full + state: merged + register: result + +- debug: + var: result + +- assert: + that: + - "'set interfaces ethernet eth1 description \\'Configured by Ansible - Interface 1\\'' in result.commands" + - "'set interfaces ethernet eth1 mtu \\'1200\\'' in result.commands" + - "'set interfaces ethernet eth1 duplex \\'auto\\'' in result.commands" + - "'set interfaces ethernet eth1 speed \\'auto\\'' in result.commands" + - "'set interfaces ethernet eth2 description \\'Configured by Ansible - Interface 2 (ADMIN DOWN)\\'' in result.commands" + - "'set interfaces ethernet eth2 mtu \\'600\\'' in result.commands" + - "'set interfaces ethernet eth2 disable' in result.commands" + - "'set interfaces ethernet eth3 description \\'Configured by Ansible - Interface 3\\'' in result.commands" + - "'set interfaces ethernet eth3 speed \\'100\\'' in result.commands" + - "'set interfaces ethernet eth3 duplex \\'full\\'' in result.commands" + +- name: Merge the provided configuration with the existing running configuration (IDEMPOTENT) + vyos_interfaces: *merged + register: result + +- assert: + that: + - 'result.changed == false' + +- include_tasks: remove_config.yaml diff --git a/tests/vyos/modules/interfaces/overridden.yaml b/tests/vyos/modules/interfaces/overridden.yaml new file mode 100644 index 0000000..59a8044 --- /dev/null +++ b/tests/vyos/modules/interfaces/overridden.yaml @@ -0,0 +1,36 @@ +--- +- debug: + msg: "START vyos_interfaces merged integration tests on connection={{ ansible_connection }}" + +- include_tasks: populate.yaml + +- name: Overrides all device configuration with provided configuration + vyos_interfaces: &overridden + config: + - name: eth2 + description: "Overridden by Ansible" + mtu: 1500 + state: overridden + register: result + +- assert: + that: + - "'delete interfaces ethernet {{ item }} description' in result.commands" + - "'delete interfaces ethernet {{ item }} speed' in result.commands" + - "'delete interfaces ethernet {{ item }} duplex' in result.commands" + - "'delete interfaces ethernet {{ item }} mtu' in result.commands" + - "'set interfaces ethernet eth2 description \\'Overridden by Ansible\\'' in result.commands" + - "'set interfaces ethernet eth2 mtu \\'1500\\'' in result.commands" + loop: + - eth1 + - eth3 + +- name: Overrides all device configuration with provided configurations (IDEMPOTENT) + vyos_interfaces: *overridden + register: result + +- assert: + that: + - "result.changed == false" + +- include_tasks: remove_config.yaml diff --git a/tests/vyos/modules/interfaces/populate.yaml b/tests/vyos/modules/interfaces/populate.yaml new file mode 100644 index 0000000..6e9f5ff --- /dev/null +++ b/tests/vyos/modules/interfaces/populate.yaml @@ -0,0 +1,16 @@ +--- +- name: Setup + cli_config: + config: "{{ lines }}" + vars: + lines: | + set interfaces ethernet "{{ intf }}" description 'Configured by Ansible' + set interfaces ethernet "{{ intf }}" speed 'auto' + set interfaces ethernet "{{ intf }}" duplex 'auto' + set interfaces ethernet "{{ intf }}" mtu '1200' + loop: + - eth1 + - eth2 + - eth3 + loop_control: + loop_var: intf diff --git a/tests/vyos/modules/interfaces/remove_config.yaml b/tests/vyos/modules/interfaces/remove_config.yaml new file mode 100644 index 0000000..6e83baa --- /dev/null +++ b/tests/vyos/modules/interfaces/remove_config.yaml @@ -0,0 +1,17 @@ +--- +- name: Remove Config + cli_config: + config: "{{ lines }}" + vars: + lines: | + delete interfaces ethernet "{{ intf }}" description + delete interfaces ethernet "{{ intf }}" speed + delete interfaces ethernet "{{ intf }}" duplex + delete interfaces ethernet "{{ intf }}" mtu + delete interfaces ethernet "{{ intf }}" disable + loop: + - eth1 + - eth2 + - eth3 + loop_control: + loop_var: intf diff --git a/tests/vyos/modules/interfaces/replaced.yaml b/tests/vyos/modules/interfaces/replaced.yaml new file mode 100644 index 0000000..360dd00 --- /dev/null +++ b/tests/vyos/modules/interfaces/replaced.yaml @@ -0,0 +1,38 @@ +--- +- debug: + msg: START vyos_interfaces replaced integration tests on connection={{ ansible_connection }} + +- include_tasks: populate.yaml + +- name: Replace device configurations of listed interfaces with provided configurations + vyos_interfaces: &replaced + config: + - name: eth1 + description: "Replaced by Ansible" + + - name: eth2 + mtu: 1500 + description: "Replaced by Ansible" + state: replaced + register: result + +- assert: + that: + - "'delete interfaces ethernet eth1 mtu' in result.commands" + - "'delete interfaces ethernet eth1 speed' in result.commands" + - "'delete interfaces ethernet eth1 duplex' in result.commands" + - "'set interfaces ethernet eth1 description \\'Replaced by Ansible\\'' in result.commands" + - "'set interfaces ethernet eth2 mtu \\'1500\\'' in result.commands" + - "'delete interfaces ethernet eth2 speed' in result.commands" + - "'delete interfaces ethernet eth2 duplex' in result.commands" + - "'set interfaces ethernet eth2 description \\'Replaced by Ansible\\'' in result.commands" + +- name: Replace device configurations of listed interfaces with provided configurarions + vyos_interfaces: *replaced + register: result + +- assert: + that: + - "result.changed == false" + +- include_tasks: remove_config.yaml From 58b40c95dabf2f02e440049f18903f35ccd9ccf6 Mon Sep 17 00:00:00 2001 From: Paul Belanger Date: Thu, 25 Apr 2019 16:08:41 -0400 Subject: [PATCH 3/4] Clean up yamllint error Signed-off-by: Paul Belanger --- tests/vyos/modules/interfaces/deleted.yaml | 4 ++-- tests/vyos/modules/interfaces/main.yaml | 4 ++-- tests/vyos/modules/interfaces/merged.yaml | 8 ++++---- tests/vyos/modules/interfaces/overridden.yaml | 6 +++--- tests/vyos/modules/interfaces/populate.yaml | 2 +- tests/vyos/modules/interfaces/remove_config.yaml | 4 ++-- tests/vyos/modules/interfaces/replaced.yaml | 8 ++++---- 7 files changed, 18 insertions(+), 18 deletions(-) diff --git a/tests/vyos/modules/interfaces/deleted.yaml b/tests/vyos/modules/interfaces/deleted.yaml index f3d0b58..a6e34ef 100644 --- a/tests/vyos/modules/interfaces/deleted.yaml +++ b/tests/vyos/modules/interfaces/deleted.yaml @@ -3,12 +3,12 @@ msg: "Start vyos_interfaces deleted integration tests ansible_connection={{ ansible_connection }}" - include_tasks: populate.yaml - + - name: Delete attributes of given interfaces vyos_interfaces: &deleted config: - name: eth1 - + - name: eth2 state: deleted register: result diff --git a/tests/vyos/modules/interfaces/main.yaml b/tests/vyos/modules/interfaces/main.yaml index 4163016..bf417ff 100644 --- a/tests/vyos/modules/interfaces/main.yaml +++ b/tests/vyos/modules/interfaces/main.yaml @@ -1,6 +1,6 @@ --- -- hosts: vyos-appliance - gather_facts: yes +- hosts: appliance + gather_facts: true gather_subset: - net_configuration_interfaces tasks: diff --git a/tests/vyos/modules/interfaces/merged.yaml b/tests/vyos/modules/interfaces/merged.yaml index 14432ec..da01062 100644 --- a/tests/vyos/modules/interfaces/merged.yaml +++ b/tests/vyos/modules/interfaces/merged.yaml @@ -1,6 +1,6 @@ ---- -- debug: - msg: "START vyos_interfaces merged integration tests on connection={{ ansible_connection }}" +--- +- debug: + msg: "START vyos_interfaces merged integration tests on connection={{ ansible_connection }}" - include_tasks: remove_config.yaml @@ -16,7 +16,7 @@ - name: eth2 description: "Configured by Ansible - Interface 2 (ADMIN DOWN)" mtu: 600 - enable: False + enable: false - name: eth3 description: "Configured by Ansible - Interface 3" diff --git a/tests/vyos/modules/interfaces/overridden.yaml b/tests/vyos/modules/interfaces/overridden.yaml index 59a8044..12b4e4f 100644 --- a/tests/vyos/modules/interfaces/overridden.yaml +++ b/tests/vyos/modules/interfaces/overridden.yaml @@ -1,6 +1,6 @@ ---- +--- - debug: - msg: "START vyos_interfaces merged integration tests on connection={{ ansible_connection }}" + msg: "START vyos_interfaces merged integration tests on connection={{ ansible_connection }}" - include_tasks: populate.yaml @@ -24,7 +24,7 @@ loop: - eth1 - eth3 - + - name: Overrides all device configuration with provided configurations (IDEMPOTENT) vyos_interfaces: *overridden register: result diff --git a/tests/vyos/modules/interfaces/populate.yaml b/tests/vyos/modules/interfaces/populate.yaml index 6e9f5ff..3350a92 100644 --- a/tests/vyos/modules/interfaces/populate.yaml +++ b/tests/vyos/modules/interfaces/populate.yaml @@ -12,5 +12,5 @@ - eth1 - eth2 - eth3 - loop_control: + loop_control: loop_var: intf diff --git a/tests/vyos/modules/interfaces/remove_config.yaml b/tests/vyos/modules/interfaces/remove_config.yaml index 6e83baa..6dab81f 100644 --- a/tests/vyos/modules/interfaces/remove_config.yaml +++ b/tests/vyos/modules/interfaces/remove_config.yaml @@ -1,8 +1,8 @@ --- - name: Remove Config - cli_config: + cli_config: config: "{{ lines }}" - vars: + vars: lines: | delete interfaces ethernet "{{ intf }}" description delete interfaces ethernet "{{ intf }}" speed diff --git a/tests/vyos/modules/interfaces/replaced.yaml b/tests/vyos/modules/interfaces/replaced.yaml index 360dd00..0725a06 100644 --- a/tests/vyos/modules/interfaces/replaced.yaml +++ b/tests/vyos/modules/interfaces/replaced.yaml @@ -1,6 +1,6 @@ ---- -- debug: - msg: START vyos_interfaces replaced integration tests on connection={{ ansible_connection }} +--- +- debug: + msg: START vyos_interfaces replaced integration tests on connection={{ ansible_connection }} - include_tasks: populate.yaml @@ -34,5 +34,5 @@ - assert: that: - "result.changed == false" - + - include_tasks: remove_config.yaml From 1d1718b35384554c2beb61c1b1de9f8dd3fede1d Mon Sep 17 00:00:00 2001 From: Paul Belanger Date: Thu, 25 Apr 2019 16:14:03 -0400 Subject: [PATCH 4/4] DNM: add zuul vyos testing This is an example job to start testing vyos Depends-On: https://github.com/ansible/ansible-zuul-jobs/pull/34 Depends-On: https://github.com/ansible/ansible/pull/55589 Depends-On: https://github.com/ansible/ansible/pull/55923 Signed-off-by: Paul Belanger --- .zuul.yaml | 11 +++++++++++ module_utils/vyos/facts/interfaces/interfaces.py | 2 +- requirements.txt | 1 + setup.cfg | 2 ++ test-requirements.txt | 1 + tests/ansible.cfg | 8 ++++++++ tests/foo.yaml | 7 +++++++ tests/vyos/modules/interfaces/main.yaml | 4 +--- tests/vyos/modules/interfaces/merged.yaml | 8 -------- tests/vyos/modules/interfaces/overridden.yaml | 1 - tests/vyos/modules/interfaces/populate.yaml | 1 - tests/vyos/modules/interfaces/remove_config.yaml | 1 - tox.ini | 6 +++++- 13 files changed, 37 insertions(+), 16 deletions(-) create mode 100644 .zuul.yaml create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 tests/ansible.cfg create mode 100644 tests/foo.yaml diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..3f1c01c --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,11 @@ +- job: + name: network-vyos-test + parent: ansible-network-vyos-base + run: tests/foo.yaml + required-projects: + - name: github.com/ansible/ansible + +- project: + check: + jobs: + - network-vyos-test diff --git a/module_utils/vyos/facts/interfaces/interfaces.py b/module_utils/vyos/facts/interfaces/interfaces.py index 1ff083c..060a19f 100644 --- a/module_utils/vyos/facts/interfaces/interfaces.py +++ b/module_utils/vyos/facts/interfaces/interfaces.py @@ -12,7 +12,7 @@ from ansible.module_utils. \ vyos.facts.base import FactsBase from re import findall, M -import q + class InterfacesFacts(FactsBase): """ The vyos interfaces fact class diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f3a3f52 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +ansible>=2.4.0 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..d7fd16f --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +name = ansible-zuul-jobs diff --git a/test-requirements.txt b/test-requirements.txt index 049cd01..611bc25 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,2 +1,3 @@ +ara flake8 yamllint diff --git a/tests/ansible.cfg b/tests/ansible.cfg new file mode 100644 index 0000000..37cf663 --- /dev/null +++ b/tests/ansible.cfg @@ -0,0 +1,8 @@ +[defaults] +callback_whitelist = profile_tasks, timer +retry_files_enabled = false +roles_path = ../.. +stdout_callback = yaml + +[ssh_connection] +pipelining = true diff --git a/tests/foo.yaml b/tests/foo.yaml new file mode 100644 index 0000000..4880101 --- /dev/null +++ b/tests/foo.yaml @@ -0,0 +1,7 @@ +- hosts: controller + tasks: + - name: Setup tox role + include_role: + name: tox + vars: + tox_extra_args: -- ansible-playbook -v -c network_cli tests/vyos/modules/interfaces/main.yaml diff --git a/tests/vyos/modules/interfaces/main.yaml b/tests/vyos/modules/interfaces/main.yaml index bf417ff..0601c7b 100644 --- a/tests/vyos/modules/interfaces/main.yaml +++ b/tests/vyos/modules/interfaces/main.yaml @@ -1,11 +1,9 @@ --- - hosts: appliance gather_facts: true - gather_subset: - - net_configuration_interfaces tasks: - import_role: - name: ~/collections/network + name: network - include_tasks: "{{ item }}.yaml" loop: diff --git a/tests/vyos/modules/interfaces/merged.yaml b/tests/vyos/modules/interfaces/merged.yaml index da01062..db4ffd1 100644 --- a/tests/vyos/modules/interfaces/merged.yaml +++ b/tests/vyos/modules/interfaces/merged.yaml @@ -17,11 +17,6 @@ description: "Configured by Ansible - Interface 2 (ADMIN DOWN)" mtu: 600 enable: false - - - name: eth3 - description: "Configured by Ansible - Interface 3" - speed: 100 - duplex: full state: merged register: result @@ -37,9 +32,6 @@ - "'set interfaces ethernet eth2 description \\'Configured by Ansible - Interface 2 (ADMIN DOWN)\\'' in result.commands" - "'set interfaces ethernet eth2 mtu \\'600\\'' in result.commands" - "'set interfaces ethernet eth2 disable' in result.commands" - - "'set interfaces ethernet eth3 description \\'Configured by Ansible - Interface 3\\'' in result.commands" - - "'set interfaces ethernet eth3 speed \\'100\\'' in result.commands" - - "'set interfaces ethernet eth3 duplex \\'full\\'' in result.commands" - name: Merge the provided configuration with the existing running configuration (IDEMPOTENT) vyos_interfaces: *merged diff --git a/tests/vyos/modules/interfaces/overridden.yaml b/tests/vyos/modules/interfaces/overridden.yaml index 12b4e4f..943fecd 100644 --- a/tests/vyos/modules/interfaces/overridden.yaml +++ b/tests/vyos/modules/interfaces/overridden.yaml @@ -23,7 +23,6 @@ - "'set interfaces ethernet eth2 mtu \\'1500\\'' in result.commands" loop: - eth1 - - eth3 - name: Overrides all device configuration with provided configurations (IDEMPOTENT) vyos_interfaces: *overridden diff --git a/tests/vyos/modules/interfaces/populate.yaml b/tests/vyos/modules/interfaces/populate.yaml index 3350a92..b2185da 100644 --- a/tests/vyos/modules/interfaces/populate.yaml +++ b/tests/vyos/modules/interfaces/populate.yaml @@ -11,6 +11,5 @@ loop: - eth1 - eth2 - - eth3 loop_control: loop_var: intf diff --git a/tests/vyos/modules/interfaces/remove_config.yaml b/tests/vyos/modules/interfaces/remove_config.yaml index 6dab81f..a20919a 100644 --- a/tests/vyos/modules/interfaces/remove_config.yaml +++ b/tests/vyos/modules/interfaces/remove_config.yaml @@ -12,6 +12,5 @@ loop: - eth1 - eth2 - - eth3 loop_control: loop_var: intf diff --git a/tox.ini b/tox.ini index 86beb92..190fa88 100644 --- a/tox.ini +++ b/tox.ini @@ -6,7 +6,8 @@ envlist = linters [testenv] basepython = python3 install_command = pip install {opts} {packages} -deps = -r{toxinidir}/test-requirements.txt +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt [testenv:linters] basepython = python3 @@ -15,6 +16,9 @@ commands = flake8 {posargs} [testenv:venv] +setenv = + ANSIBLE_CONFIG = {toxinidir}/tests/ansible.cfg + ANSIBLE_CALLBACK_PLUGINS = {envsitepackagesdir}/ara/plugins/callbacks basepython = python3 commands = {posargs}