From d0c56cb6e6ad13ef0fd31ca353ac18dd9193a751 Mon Sep 17 00:00:00 2001 From: OpenStack Project Creator Date: Tue, 27 Mar 2018 11:35:12 +0000 Subject: [PATCH 01/31] Added .gitreview --- .gitreview | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .gitreview diff --git a/.gitreview b/.gitreview new file mode 100644 index 00000000..48bf0a20 --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.openstack.org +port=29418 +project=openstack/ara-clients.git From 353293f1ad4e52fafdb3e026280788f045474248 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Wed, 20 Jun 2018 00:14:20 -0400 Subject: [PATCH 02/31] Bootstrap the ara-clients repository This is the basic machinery to make it installable and things like that. Change-Id: I618ae1a8680ec2275fcf813b1efca4fe180fae3f --- .gitignore | 16 + .zuul.yaml | 7 + LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++ README.rst | 57 ++++ ara/clients/__init__.py | 1 + requirements.txt | 1 + setup.cfg | 57 ++++ setup.py | 22 ++ test-requirements.txt | 5 + tox.ini | 34 ++ 10 files changed, 874 insertions(+) create mode 100644 .gitignore create mode 100644 .zuul.yaml create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 ara/clients/__init__.py create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..36879768 --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +**ansible.sqlite +*.pyc +__pycache__/ +.pytest_cache/ +_build/ +build/ +*.egg* +dist +build +eggs +.tox/ +.cache/ +.coverage +*.retry +cover/ +*.tmp diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 00000000..91472990 --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,7 @@ +- project: + check: + jobs: + - tox-pep8 + gate: + jobs: + - tox-pep8 diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..9cecc1d4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..9d2d4682 --- /dev/null +++ b/README.rst @@ -0,0 +1,57 @@ +ara-clients +=========== + +**This repository does not contain production ready software.** + +If you are looking for the latest stable release of ARA Records Ansible, please +refer to the `openstack/ara`_ repository. + +.. _openstack/ara: https://github.com/openstack/ara + +Documentation +============= + +*Work in progress* + +**TL;DR**: Using tox is convenient for the time being:: + + # Use the source Luke + git clone https://github.com/openstack/ara-clients + cd ara-clients + + # Install tox + pip install tox # (or the tox python library from your distro packages) + + # Run actual tests or get coverage + tox -e pep8 + tox -e cover + + # Build docs + tox -e docs + +Contributors +============ + +See contributors on GitHub_. + +.. _GitHub: https://github.com/openstack/ara-clients/graphs/contributors + +Copyright +========= + +:: + + Copyright (c) 2018 Red Hat, Inc. + + ARA 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. + + ARA 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 ARA. If not, see . diff --git a/ara/clients/__init__.py b/ara/clients/__init__.py new file mode 100644 index 00000000..de40ea7c --- /dev/null +++ b/ara/clients/__init__.py @@ -0,0 +1 @@ +__import__('pkg_resources').declare_namespace(__name__) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..7deef889 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +pbr!=2.1.0,>=2.0.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..6d644b85 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,57 @@ +[metadata] +name = ara-clients +summary = ARA Records Ansible clients +description-file = + README.rst +author = OpenStack Community +author-email = openstack-dev@lists.openstack.org +home-page = https://github.com/openstack/ara-clients +classifier = + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + Intended Audience :: Developers + Topic :: Utilities + License :: OSI Approved :: GNU General Public License v3 (GPLv3) + Operating System :: POSIX :: Linux + Programming Language :: Python + Programming Language :: Python :: 3 + Development Status :: 4 - Beta + +[global] +setup-hooks = + pbr.hooks.setup_hook + +[files] +namespace_packages = + ara.clients +packages = + ara + +[build_sphinx] +source-dir = doc/source +build-dir = doc/build +all_files = 1 + +[upload_sphinx] +upload-dir = docs/html + +[coverage:report] +ignore_errors = True +include = + ara/* +omit = + /usr* + setup.py + *egg* + .venv/* + +[coverage:html] +directory = reports + +[wheel] +universal = 1 + +[pbr] +skip_authors = True +skip_changelog = True diff --git a/setup.py b/setup.py new file mode 100644 index 00000000..bda9dc3c --- /dev/null +++ b/setup.py @@ -0,0 +1,22 @@ +# Copyright (c) 2018 Red Hat, Inc. +# +# This file is part of ARA: Ansible Run Analysis. +# +# ARA 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. +# +# ARA 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 ARA. If not, see . + +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 00000000..97b76743 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,5 @@ +bandit>=1.1.0 # Apache-2.0 +coverage +flake8 +sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 +sphinx-rtd-theme diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..f1d522b6 --- /dev/null +++ b/tox.ini @@ -0,0 +1,34 @@ +[tox] +minversion = 2.0 +envlist = py35,pep8 +skipdist = True + +[testenv] +basepython = python3 +sitepackages = False +usedevelop = True +install_command = pip install -U {opts} {packages} -c{env:CONSTRAINTS_FILE:/dev/null} +setenv = VIRTUAL_ENV={envdir} +deps = -r{toxinidir}/test-requirements.txt + +[testenv:venv] +commands = {posargs} + +[testenv:docs] +commands = sphinx-build -W -b html doc/source doc/build/html + +[testenv:pep8] +commands = + flake8 ara + bandit -r ara + +[flake8] +# E123, E125 skipped as they are invalid PEP-8. +# E741, short ambiguous variable names +# H106 Don’t put vim configuration in source files +# H203 Use assertIs(Not)None to check for None +max-line-length = 120 +ignore = E123,E125,E741 +enable-extensions=H106,H203 +show-source = True +exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build From 31c5af8d10d9a1fbc690a5ea4c7f637823b3a332 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Wed, 20 Jun 2018 00:16:01 -0400 Subject: [PATCH 03/31] First iteration of the offline API client This is the first iteration of an API client implementation for interacting with the ARA API. Change-Id: Ib64f6e535a70d9ec1cfec2cec0d37780fd509be4 --- ara/clients/offline.py | 86 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 ara/clients/offline.py diff --git a/ara/clients/offline.py b/ara/clients/offline.py new file mode 100644 index 00000000..e9de5524 --- /dev/null +++ b/ara/clients/offline.py @@ -0,0 +1,86 @@ +# Copyright (c) 2018 Red Hat, Inc. +# +# This file is part of ARA: Ansible Run Analysis. +# +# ARA 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. +# +# ARA 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 ARA. If not, see . + +# This is an "offline" API client that does not require standing up +# an API server and does not execute actual HTTP calls. + +import json +import logging +import os + +from django import setup as django_setup +from django.core.management import execute_from_command_line +from django.test import Client + + +class OfflineClient(object): + def __init__(self): + self.client = self.bootstrap_django_client() + self.log = logging.getLogger('ara.clients.offline') + + def _bootstrap_django_client(self): + self.log.debug('Bootstrapping Django offline client') + + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ara.server.settings') + # Automatically create the database and run migrations (is there a better way?) + execute_from_command_line(['django', 'migrate']) + + # Set up the things Django needs + django_setup() + + return Client() + + def _request(self, method, endpoint, **kwargs): + func = getattr(self.client, method) + response = func( + endpoint, + json.dumps(kwargs), + content_type='application/json' + ) + + self.log.debug('HTTP {status}: {method} on {endpoint}'.format( + status=response.status_code, + method=method, + endpoint=endpoint + )) + + if response.status_code not in [200, 201]: + self.log.error( + 'Failed to {method} on {endpoint}: {content}'.format( + method=method, + endpoint=endpoint, + content=kwargs + ) + ) + self.log.fatal(response.content) + + return response.json() + + def get(self, endpoint, **kwargs): + return self._request('get', endpoint, **kwargs) + + def patch(self, endpoint, **kwargs): + return self._request('patch', endpoint, **kwargs) + + def post(self, endpoint, **kwargs): + return self._request('post', endpoint, **kwargs) + + def put(self, endpoint, **kwargs): + return self._request('put', endpoint, **kwargs) + + def delete(self, endpoint, **kwargs): + return self._request('delete', endpoint, **kwargs) From d50ebdd1a3ea45aa56f540d2a0b0e82b00049477 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Wed, 20 Jun 2018 09:20:18 -0400 Subject: [PATCH 04/31] Add ara-server to ara-clients requirements The default offline client requires django and the rest of the things. Change-Id: Ice97247a20b0e49c155aac3fc27a67a969a5e570 --- requirements.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/requirements.txt b/requirements.txt index 7deef889..ca961247 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,3 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0 +git+https://git.openstack.org/openstack/ara-server@master#egg=ara-server + From c907258a61ab7d196d576e462224623b98c173e4 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Wed, 20 Jun 2018 10:17:22 -0400 Subject: [PATCH 05/31] Rename offline client class and fix django bootstrap Wrong method name was used when bootstrapping django. Change-Id: Iee112e465daaa7e108fb12999374f4da569411a8 --- ara/clients/offline.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index e9de5524..d7d20209 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -27,10 +27,10 @@ from django.core.management import execute_from_command_line from django.test import Client -class OfflineClient(object): +class AraOfflineClient(object): def __init__(self): - self.client = self.bootstrap_django_client() self.log = logging.getLogger('ara.clients.offline') + self.client = self._bootstrap_django_client() def _bootstrap_django_client(self): self.log.debug('Bootstrapping Django offline client') From c9a08e7680306ac3c23c5897fd3a07539811d858 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Wed, 20 Jun 2018 10:41:17 -0400 Subject: [PATCH 06/31] Don't pass kwargs to the client if there isn't any This resolves an issue where doing a request (i.e, GET) without kwargs would fail. Change-Id: Iac5be67bd1a558701c0ac0dbca50e5284730bebe --- ara/clients/offline.py | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index d7d20209..b9c4b640 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -46,11 +46,18 @@ class AraOfflineClient(object): def _request(self, method, endpoint, **kwargs): func = getattr(self.client, method) - response = func( - endpoint, - json.dumps(kwargs), - content_type='application/json' - ) + # TODO: Is there a better way than doing this if/else ? + if kwargs: + response = func( + endpoint, + json.dumps(kwargs), + content_type='application/json' + ) + else: + response = func( + endpoint, + content_type='application/json' + ) self.log.debug('HTTP {status}: {method} on {endpoint}'.format( status=response.status_code, From d54b3f8e5954b2ea42775dff3eb18125337a30d2 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Mon, 25 Jun 2018 10:34:31 -0400 Subject: [PATCH 07/31] Add helper method to retrieve client instance Change-Id: I0efcf4a9272e70e34dc9c62a963484583628cacc --- ara/clients/utils.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 ara/clients/utils.py diff --git a/ara/clients/utils.py b/ara/clients/utils.py new file mode 100644 index 00000000..99006a8d --- /dev/null +++ b/ara/clients/utils.py @@ -0,0 +1,25 @@ +# Copyright (c) 2018 Red Hat, Inc. +# +# This file is part of ARA Records Ansible. +# +# ARA 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. +# +# ARA 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 ARA. If not, see . + +from ara.clients.offline import AraOfflineClient + + +def get_client(client=None, **kwargs): + if client is None or client == 'offline': + return AraOfflineClient(**kwargs) + else: + raise ValueError('Unsupported client: %s' % client) From b6b4818987760933c3149403fe926abf434d6b48 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Mon, 25 Jun 2018 10:37:18 -0400 Subject: [PATCH 08/31] Only run the Django bootstrapping once in the offline client Change-Id: Idcf388a8dbeef418400546078a78d8d8620dc950 --- ara/clients/offline.py | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index b9c4b640..b5709c69 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -26,23 +26,18 @@ from django import setup as django_setup from django.core.management import execute_from_command_line from django.test import Client +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ara.server.settings') +# Automatically create the database and run migrations (is there a better way?) +execute_from_command_line(['django', 'migrate']) + +# Set up the things Django needs +django_setup() + class AraOfflineClient(object): def __init__(self): - self.log = logging.getLogger('ara.clients.offline') - self.client = self._bootstrap_django_client() - - def _bootstrap_django_client(self): - self.log.debug('Bootstrapping Django offline client') - - os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ara.server.settings') - # Automatically create the database and run migrations (is there a better way?) - execute_from_command_line(['django', 'migrate']) - - # Set up the things Django needs - django_setup() - - return Client() + self.log = logging.getLogger(__name__) + self.client = Client() def _request(self, method, endpoint, **kwargs): func = getattr(self.client, method) From 7310b6cea5891d4bb09faaa21945c03adcc6b7a6 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Mon, 25 Jun 2018 10:38:01 -0400 Subject: [PATCH 09/31] Handle HTTP errors >= 500 and handle HTTP 204 on delete Change-Id: Ie39355274a75e31142920db3810ff2d78f53a48f --- ara/clients/offline.py | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index b5709c69..2d25a5b5 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -54,13 +54,7 @@ class AraOfflineClient(object): content_type='application/json' ) - self.log.debug('HTTP {status}: {method} on {endpoint}'.format( - status=response.status_code, - method=method, - endpoint=endpoint - )) - - if response.status_code not in [200, 201]: + if response.status_code >= 500: self.log.error( 'Failed to {method} on {endpoint}: {content}'.format( method=method, @@ -68,7 +62,24 @@ class AraOfflineClient(object): content=kwargs ) ) - self.log.fatal(response.content) + + self.log.debug('HTTP {status}: {method} on {endpoint}'.format( + status=response.status_code, + method=method, + endpoint=endpoint + )) + + if response.status_code not in [200, 201, 204]: + self.log.error( + 'Failed to {method} on {endpoint}: {content}'.format( + method=method, + endpoint=endpoint, + content=kwargs + ) + ) + + if response.status_code == 204: + return response return response.json() From ee86bb5cfe08e2d47079182b11afb66de67dd3cc Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Wed, 12 Sep 2018 09:09:39 -0400 Subject: [PATCH 10/31] Add first iteration of http client The offline client is ideal for running offline and locally. The http client uses requests to do actual http requests to an API server. Change-Id: I2b1ed6068ab547d55237b3f9ff7150935232caa6 --- ara/clients/http.py | 127 +++++++++++++++++++++++++++++++++++++++++ ara/clients/offline.py | 21 ++++--- ara/clients/utils.py | 3 + 3 files changed, 143 insertions(+), 8 deletions(-) create mode 100644 ara/clients/http.py diff --git a/ara/clients/http.py b/ara/clients/http.py new file mode 100644 index 00000000..30c8dd0d --- /dev/null +++ b/ara/clients/http.py @@ -0,0 +1,127 @@ +# Copyright (c) 2018 Red Hat, Inc. +# +# This file is part of ARA: Ansible Run Analysis. +# +# ARA 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. +# +# ARA 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 ARA. If not, see . + +# This is an "offline" API client that does not require standing up +# an API server and does not execute actual HTTP calls. + +import json +import logging +import requests + + +class HttpClient(object): + def __init__(self, endpoint='http://127.0.0.1:8000', timeout=30, **params): + self.endpoint = endpoint + self.timeout = timeout + self.params = params + + self.log = logging.getLogger(__name__) + self.user_agent = 'ara-http-client' + self.log.debug("%s: %s" % (self.user_agent, str(self.params))) + + self.http = requests.Session() + + def _request(self, method, url, **kwargs): + # Override timeout and headers only if user supplied + kwargs.setdefault('timeout', self.timeout) + kwargs.setdefault('headers', kwargs.get('headers', {})) + + # Headers we're enforcing (kind of) + kwargs['headers']['User-Agent'] = self.user_agent + kwargs['headers']['Accept'] = 'application/json' + kwargs['headers']['Content-Type'] = 'application/json' + + self.log.debug("%s on %s" % (method, url)) + + # Use requests.Session to do the query + # The actual endpoint is: + # + # http://127.0.0.1:8000 / api/v1/playbooks + return self.http.request(method, self.endpoint + url, **kwargs) + + def get(self, url, **kwargs): + return self._request('get', url, **kwargs) + + def patch(self, url, **kwargs): + return self._request('patch', url, **kwargs) + + def post(self, url, **kwargs): + return self._request('post', url, **kwargs) + + def put(self, url, **kwargs): + return self._request('put', url, **kwargs) + + def delete(self, url, **kwargs): + return self._request('delete', url, **kwargs) + + +class AraHttpClient(object): + def __init__(self): + self.log = logging.getLogger(__name__) + self.client = HttpClient() + + def _request(self, method, url, **kwargs): + func = getattr(self.client, method) + # TODO: Is there a better way than doing this if/else ? + if kwargs: + response = func(url, json.dumps(kwargs)) + else: + response = func(url) + + if response.status_code >= 500: + self.log.error( + 'Failed to {method} on {url}: {content}'.format( + method=method, + url=url, + content=kwargs + ) + ) + + self.log.debug('HTTP {status}: {method} on {url}'.format( + status=response.status_code, + method=method, + url=url + )) + + if response.status_code not in [200, 201, 204]: + self.log.error( + 'Failed to {method} on {url}: {content}'.format( + method=method, + url=url, + content=kwargs + ) + ) + + if response.status_code == 204: + return response + + return response.json() + + def get(self, endpoint, **kwargs): + return self._request('get', endpoint, **kwargs) + + def patch(self, endpoint, **kwargs): + return self._request('patch', endpoint, **kwargs) + + def post(self, endpoint, **kwargs): + return self._request('post', endpoint, **kwargs) + + def put(self, endpoint, **kwargs): + return self._request('put', endpoint, **kwargs) + + def delete(self, endpoint, **kwargs): + return self._request('delete', endpoint, **kwargs) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index 2d25a5b5..f2876ed2 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -22,16 +22,21 @@ import json import logging import os -from django import setup as django_setup -from django.core.management import execute_from_command_line -from django.test import Client +try: + from django import setup as django_setup + from django.core.management import execute_from_command_line + from django.test import Client -os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ara.server.settings') -# Automatically create the database and run migrations (is there a better way?) -execute_from_command_line(['django', 'migrate']) + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ara.server.settings') -# Set up the things Django needs -django_setup() + # Automatically create the database and run migrations (is there a better way?) + execute_from_command_line(['django', 'migrate']) + + # Set up the things Django needs + django_setup() +except ImportError as e: + print('ERROR: The offline client requires ara-server to be installed') + raise e class AraOfflineClient(object): diff --git a/ara/clients/utils.py b/ara/clients/utils.py index 99006a8d..e1ce5009 100644 --- a/ara/clients/utils.py +++ b/ara/clients/utils.py @@ -16,10 +16,13 @@ # along with ARA. If not, see . from ara.clients.offline import AraOfflineClient +from ara.clients.http import AraHttpClient def get_client(client=None, **kwargs): if client is None or client == 'offline': return AraOfflineClient(**kwargs) + elif client == 'http': + return AraHttpClient(**kwargs) else: raise ValueError('Unsupported client: %s' % client) From e4d2b27a0fed243f360db7fbc87d8e86efa6911e Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Wed, 12 Sep 2018 09:14:38 -0400 Subject: [PATCH 11/31] Move django import and initialization inside the offline client class This allows to import the class without triggering the import and initialization of django and instead deferring it to when (and if) the class is instanciated. Change-Id: I79be90eb877f21b5254f116e51cc78b310c8674c --- ara/clients/offline.py | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index f2876ed2..c84528d8 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -22,26 +22,27 @@ import json import logging import os -try: - from django import setup as django_setup - from django.core.management import execute_from_command_line - from django.test import Client - - os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ara.server.settings') - - # Automatically create the database and run migrations (is there a better way?) - execute_from_command_line(['django', 'migrate']) - - # Set up the things Django needs - django_setup() -except ImportError as e: - print('ERROR: The offline client requires ara-server to be installed') - raise e - class AraOfflineClient(object): def __init__(self): self.log = logging.getLogger(__name__) + + try: + from django import setup as django_setup + from django.core.management import execute_from_command_line + from django.test import Client + + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ara.server.settings') + + # Automatically create the database and run migrations (is there a better way?) + execute_from_command_line(['django', 'migrate']) + + # Set up the things Django needs + django_setup() + except ImportError as e: + self.log.error('The offline client requires ara-server to be installed') + raise e + self.client = Client() def _request(self, method, endpoint, **kwargs): From 96489515ac1e54ed92b9dde1e62b5316c06c4a33 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Thu, 20 Sep 2018 13:38:31 -0400 Subject: [PATCH 12/31] Streamline how payloads are passed back and forth in the http client - Set default headers through requests.session - Set timeout explicitely - GET parameters need to be passed as "params" - Don't send empty GET parameters - POST/PUT/PATCH parameters need to be passed as "data" - DELETE doesn't expect any parameters Change-Id: Icc1d821501a160be10975333accc6b791b6f058f --- ara/clients/http.py | 65 +++++++++++++++++++++------------------------ 1 file changed, 30 insertions(+), 35 deletions(-) diff --git a/ara/clients/http.py b/ara/clients/http.py index 30c8dd0d..b21059e4 100644 --- a/ara/clients/http.py +++ b/ara/clients/http.py @@ -24,63 +24,58 @@ import requests class HttpClient(object): - def __init__(self, endpoint='http://127.0.0.1:8000', timeout=30, **params): + def __init__(self, endpoint='http://127.0.0.1:8000', timeout=30): + self.log = logging.getLogger(__name__) + self.endpoint = endpoint self.timeout = timeout - self.params = params - - self.log = logging.getLogger(__name__) - self.user_agent = 'ara-http-client' - self.log.debug("%s: %s" % (self.user_agent, str(self.params))) - + self.headers = { + 'User-Agent': 'ara-http-client', + 'Accept': 'application/json', + 'Content-Type': 'application/json' + } self.http = requests.Session() + self.http.headers.update(self.headers) - def _request(self, method, url, **kwargs): - # Override timeout and headers only if user supplied - kwargs.setdefault('timeout', self.timeout) - kwargs.setdefault('headers', kwargs.get('headers', {})) - - # Headers we're enforcing (kind of) - kwargs['headers']['User-Agent'] = self.user_agent - kwargs['headers']['Accept'] = 'application/json' - kwargs['headers']['Content-Type'] = 'application/json' - + def _request(self, method, url, **payload): self.log.debug("%s on %s" % (method, url)) # Use requests.Session to do the query # The actual endpoint is: # # http://127.0.0.1:8000 / api/v1/playbooks - return self.http.request(method, self.endpoint + url, **kwargs) + return self.http.request(method, self.endpoint + url, timeout=self.timeout, **payload) - def get(self, url, **kwargs): - return self._request('get', url, **kwargs) + def get(self, url, **payload): + if payload: + return self._request('get', url, params=json.dumps(payload)) + else: + return self._request('get', url) - def patch(self, url, **kwargs): - return self._request('patch', url, **kwargs) + def patch(self, url, **payload): + return self._request('patch', url, data=json.dumps(payload)) - def post(self, url, **kwargs): - return self._request('post', url, **kwargs) + def post(self, url, **payload): + return self._request('post', url, data=json.dumps(payload)) - def put(self, url, **kwargs): - return self._request('put', url, **kwargs) + def put(self, url, **payload): + return self._request('put', url, data=json.dumps(payload)) - def delete(self, url, **kwargs): - return self._request('delete', url, **kwargs) + def delete(self, url): + return self._request('delete', url) class AraHttpClient(object): - def __init__(self): + def __init__(self, endpoint='http://127.0.0.1:8000', timeout=30): self.log = logging.getLogger(__name__) - self.client = HttpClient() + self.client = HttpClient(endpoint, timeout) def _request(self, method, url, **kwargs): func = getattr(self.client, method) - # TODO: Is there a better way than doing this if/else ? - if kwargs: - response = func(url, json.dumps(kwargs)) - else: + if method == 'delete': response = func(url) + else: + response = func(url, **kwargs) if response.status_code >= 500: self.log.error( @@ -124,4 +119,4 @@ class AraHttpClient(object): return self._request('put', endpoint, **kwargs) def delete(self, endpoint, **kwargs): - return self._request('delete', endpoint, **kwargs) + return self._request('delete', endpoint) From 1e873cf9c95ade40e75538644c280ca460314c1b Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Thu, 20 Sep 2018 13:56:00 -0400 Subject: [PATCH 13/31] Add version of the http agent to the user agent string Change-Id: I61e85899be88788edc9091dd81f7cef3e8fa94a0 --- ara/clients/http.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/ara/clients/http.py b/ara/clients/http.py index b21059e4..c5c10e36 100644 --- a/ara/clients/http.py +++ b/ara/clients/http.py @@ -21,6 +21,9 @@ import json import logging import requests +import pbr.version + +CLIENT_VERSION = pbr.version.VersionInfo(__name__).release_string() class HttpClient(object): @@ -30,7 +33,7 @@ class HttpClient(object): self.endpoint = endpoint self.timeout = timeout self.headers = { - 'User-Agent': 'ara-http-client', + 'User-Agent': 'ara-http-client_%s' % CLIENT_VERSION, 'Accept': 'application/json', 'Content-Type': 'application/json' } From 6590ecdf4556c62fe98e31440c5695af7a254a48 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Thu, 27 Sep 2018 19:16:29 +0200 Subject: [PATCH 14/31] Fixed namespacing to use python3 style namespace packages. Note: the egg name is not allowed to have a dash, because that is interpreted as version by at least pbr. See https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support Change-Id: Ib6666e4aee84a54050a5788de1c12ca36aa130ce --- ara/clients/__init__.py | 1 - requirements.txt | 2 +- setup.cfg | 2 -- 3 files changed, 1 insertion(+), 4 deletions(-) diff --git a/ara/clients/__init__.py b/ara/clients/__init__.py index de40ea7c..e69de29b 100644 --- a/ara/clients/__init__.py +++ b/ara/clients/__init__.py @@ -1 +0,0 @@ -__import__('pkg_resources').declare_namespace(__name__) diff --git a/requirements.txt b/requirements.txt index ca961247..d33ccaab 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0 -git+https://git.openstack.org/openstack/ara-server@master#egg=ara-server +git+https://git.openstack.org/openstack/ara-server@master#egg=ara_server diff --git a/setup.cfg b/setup.cfg index 6d644b85..13d70899 100644 --- a/setup.cfg +++ b/setup.cfg @@ -23,8 +23,6 @@ setup-hooks = pbr.hooks.setup_hook [files] -namespace_packages = - ara.clients packages = ara From 028010c9b0ff13a140a110de5a66429a1db97138 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Fri, 28 Sep 2018 15:32:27 +0200 Subject: [PATCH 15/31] Dropped hard dependency to ara-server. It is only required for the offline client. Change-Id: I80c66bcc097150cd23e48c2a2cfca7139e0c8e66 --- requirements.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d33ccaab..a957593e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,2 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0 -git+https://git.openstack.org/openstack/ara-server@master#egg=ara_server From 883410564566d29d120ea3ac3225626f63add23b Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Fri, 28 Sep 2018 19:21:44 -0400 Subject: [PATCH 16/31] Add requests to requirements.txt It was forgotten when adding in the http client and ara-clients no longer worked when we started not installing ara/ara-server for nothing. Change-Id: I056d1a2822cddb2a6058a86fa5cccef8e810ee2e --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index a957593e..c6fb6969 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0 +requests>=2.14.2 From b1dc3a0944d15d4c6db995d39b90e78abfd3578f Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Tue, 2 Oct 2018 16:44:24 -0500 Subject: [PATCH 17/31] Run black/isort on ara-clients There will be a follow up patch to add black/isort CI. Change-Id: I8f16ad01d9a7c986b12a543ff351cbf17a0df70d --- ara/clients/http.py | 59 ++++++++++++++++-------------------------- ara/clients/offline.py | 49 ++++++++++++----------------------- ara/clients/utils.py | 8 +++--- 3 files changed, 43 insertions(+), 73 deletions(-) diff --git a/ara/clients/http.py b/ara/clients/http.py index c5c10e36..29d253ed 100644 --- a/ara/clients/http.py +++ b/ara/clients/http.py @@ -20,22 +20,23 @@ import json import logging -import requests + import pbr.version +import requests CLIENT_VERSION = pbr.version.VersionInfo(__name__).release_string() class HttpClient(object): - def __init__(self, endpoint='http://127.0.0.1:8000', timeout=30): + def __init__(self, endpoint="http://127.0.0.1:8000", timeout=30): self.log = logging.getLogger(__name__) self.endpoint = endpoint self.timeout = timeout self.headers = { - 'User-Agent': 'ara-http-client_%s' % CLIENT_VERSION, - 'Accept': 'application/json', - 'Content-Type': 'application/json' + "User-Agent": "ara-http-client_%s" % CLIENT_VERSION, + "Accept": "application/json", + "Content-Type": "application/json", } self.http = requests.Session() self.http.headers.update(self.headers) @@ -51,58 +52,42 @@ class HttpClient(object): def get(self, url, **payload): if payload: - return self._request('get', url, params=json.dumps(payload)) + return self._request("get", url, params=json.dumps(payload)) else: - return self._request('get', url) + return self._request("get", url) def patch(self, url, **payload): - return self._request('patch', url, data=json.dumps(payload)) + return self._request("patch", url, data=json.dumps(payload)) def post(self, url, **payload): - return self._request('post', url, data=json.dumps(payload)) + return self._request("post", url, data=json.dumps(payload)) def put(self, url, **payload): - return self._request('put', url, data=json.dumps(payload)) + return self._request("put", url, data=json.dumps(payload)) def delete(self, url): - return self._request('delete', url) + return self._request("delete", url) class AraHttpClient(object): - def __init__(self, endpoint='http://127.0.0.1:8000', timeout=30): + def __init__(self, endpoint="http://127.0.0.1:8000", timeout=30): self.log = logging.getLogger(__name__) self.client = HttpClient(endpoint, timeout) def _request(self, method, url, **kwargs): func = getattr(self.client, method) - if method == 'delete': + if method == "delete": response = func(url) else: response = func(url, **kwargs) if response.status_code >= 500: - self.log.error( - 'Failed to {method} on {url}: {content}'.format( - method=method, - url=url, - content=kwargs - ) - ) + self.log.error("Failed to {method} on {url}: {content}".format(method=method, url=url, content=kwargs)) - self.log.debug('HTTP {status}: {method} on {url}'.format( - status=response.status_code, - method=method, - url=url - )) + self.log.debug("HTTP {status}: {method} on {url}".format(status=response.status_code, method=method, url=url)) if response.status_code not in [200, 201, 204]: - self.log.error( - 'Failed to {method} on {url}: {content}'.format( - method=method, - url=url, - content=kwargs - ) - ) + self.log.error("Failed to {method} on {url}: {content}".format(method=method, url=url, content=kwargs)) if response.status_code == 204: return response @@ -110,16 +95,16 @@ class AraHttpClient(object): return response.json() def get(self, endpoint, **kwargs): - return self._request('get', endpoint, **kwargs) + return self._request("get", endpoint, **kwargs) def patch(self, endpoint, **kwargs): - return self._request('patch', endpoint, **kwargs) + return self._request("patch", endpoint, **kwargs) def post(self, endpoint, **kwargs): - return self._request('post', endpoint, **kwargs) + return self._request("post", endpoint, **kwargs) def put(self, endpoint, **kwargs): - return self._request('put', endpoint, **kwargs) + return self._request("put", endpoint, **kwargs) def delete(self, endpoint, **kwargs): - return self._request('delete', endpoint) + return self._request("delete", endpoint) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index c84528d8..dd446951 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -32,15 +32,15 @@ class AraOfflineClient(object): from django.core.management import execute_from_command_line from django.test import Client - os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ara.server.settings') + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ara.server.settings") # Automatically create the database and run migrations (is there a better way?) - execute_from_command_line(['django', 'migrate']) + execute_from_command_line(["django", "migrate"]) # Set up the things Django needs django_setup() except ImportError as e: - self.log.error('The offline client requires ara-server to be installed') + self.log.error("The offline client requires ara-server to be installed") raise e self.client = Client() @@ -49,39 +49,24 @@ class AraOfflineClient(object): func = getattr(self.client, method) # TODO: Is there a better way than doing this if/else ? if kwargs: - response = func( - endpoint, - json.dumps(kwargs), - content_type='application/json' - ) + response = func(endpoint, json.dumps(kwargs), content_type="application/json") else: - response = func( - endpoint, - content_type='application/json' - ) + response = func(endpoint, content_type="application/json") if response.status_code >= 500: self.log.error( - 'Failed to {method} on {endpoint}: {content}'.format( - method=method, - endpoint=endpoint, - content=kwargs - ) + "Failed to {method} on {endpoint}: {content}".format(method=method, endpoint=endpoint, content=kwargs) ) - self.log.debug('HTTP {status}: {method} on {endpoint}'.format( - status=response.status_code, - method=method, - endpoint=endpoint - )) + self.log.debug( + "HTTP {status}: {method} on {endpoint}".format( + status=response.status_code, method=method, endpoint=endpoint + ) + ) if response.status_code not in [200, 201, 204]: self.log.error( - 'Failed to {method} on {endpoint}: {content}'.format( - method=method, - endpoint=endpoint, - content=kwargs - ) + "Failed to {method} on {endpoint}: {content}".format(method=method, endpoint=endpoint, content=kwargs) ) if response.status_code == 204: @@ -90,16 +75,16 @@ class AraOfflineClient(object): return response.json() def get(self, endpoint, **kwargs): - return self._request('get', endpoint, **kwargs) + return self._request("get", endpoint, **kwargs) def patch(self, endpoint, **kwargs): - return self._request('patch', endpoint, **kwargs) + return self._request("patch", endpoint, **kwargs) def post(self, endpoint, **kwargs): - return self._request('post', endpoint, **kwargs) + return self._request("post", endpoint, **kwargs) def put(self, endpoint, **kwargs): - return self._request('put', endpoint, **kwargs) + return self._request("put", endpoint, **kwargs) def delete(self, endpoint, **kwargs): - return self._request('delete', endpoint, **kwargs) + return self._request("delete", endpoint, **kwargs) diff --git a/ara/clients/utils.py b/ara/clients/utils.py index e1ce5009..1da3e1d9 100644 --- a/ara/clients/utils.py +++ b/ara/clients/utils.py @@ -15,14 +15,14 @@ # You should have received a copy of the GNU General Public License # along with ARA. If not, see . -from ara.clients.offline import AraOfflineClient from ara.clients.http import AraHttpClient +from ara.clients.offline import AraOfflineClient def get_client(client=None, **kwargs): - if client is None or client == 'offline': + if client is None or client == "offline": return AraOfflineClient(**kwargs) - elif client == 'http': + elif client == "http": return AraHttpClient(**kwargs) else: - raise ValueError('Unsupported client: %s' % client) + raise ValueError("Unsupported client: %s" % client) From 001112df9fcce34b5aa2e8cc4527d57a72712128 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Tue, 2 Oct 2018 16:46:01 -0500 Subject: [PATCH 18/31] Add zuul job to run tox-format environment for executing black and isort This will allow us to have more consistent and clean code. Change-Id: I8a49053d016c52b7b44136a6a8f36f9ad12675c3 --- .zuul.yaml | 2 ++ pyproject.toml | 2 ++ setup.cfg | 22 ++++++++++++++++++++++ test-requirements.txt | 2 ++ tox.ini | 14 ++++---------- 5 files changed, 32 insertions(+), 10 deletions(-) create mode 100644 pyproject.toml diff --git a/.zuul.yaml b/.zuul.yaml index 91472990..f222942f 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -1,7 +1,9 @@ - project: check: jobs: + - tox-format - tox-pep8 gate: jobs: + - tox-format - tox-pep8 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..55ec8d78 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,2 @@ +[tool.black] +line-length = 120 diff --git a/setup.cfg b/setup.cfg index 13d70899..2a8d1ea0 100644 --- a/setup.cfg +++ b/setup.cfg @@ -53,3 +53,25 @@ universal = 1 [pbr] skip_authors = True skip_changelog = True + +[flake8] +# E123, E125 skipped as they are invalid PEP-8. +# E741, short ambiguous variable names +# H106 Don’t put vim configuration in source files +# H203 Use assertIs(Not)None to check for None +max-line-length = 120 +ignore = E123,E125,E741 +enable-extensions=H106,H203 +show-source = True +exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build + +[isort] +known_first_party = ara +default_section = THIRDPARTY +skip = build,.git,.tox,.cache,.venv +not_skip = __init__.py +multi_line_output=3 +include_trailing_comma=True +force_grid_wrap=0 +combine_as_imports=True +line_length=88 diff --git a/test-requirements.txt b/test-requirements.txt index 97b76743..d6b4edf4 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,3 +3,5 @@ coverage flake8 sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 sphinx-rtd-theme +black==18.9b0 ; python_version >= '3.6' # Exact version for prerelease +isort diff --git a/tox.ini b/tox.ini index f1d522b6..c03eede6 100644 --- a/tox.ini +++ b/tox.ini @@ -22,13 +22,7 @@ commands = flake8 ara bandit -r ara -[flake8] -# E123, E125 skipped as they are invalid PEP-8. -# E741, short ambiguous variable names -# H106 Don’t put vim configuration in source files -# H203 Use assertIs(Not)None to check for None -max-line-length = 120 -ignore = E123,E125,E741 -enable-extensions=H106,H203 -show-source = True -exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build +[testenv:format] +commands = + black --diff --check ara + isort --recursive --check-only --diff --virtual-env {envdir} ara From f9f75778e2c571a331178e23c1bb4ad861920305 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Sun, 4 Nov 2018 15:21:31 +0100 Subject: [PATCH 19/31] Switched the offline client to use an actual threaded http server. Sadly it has no support for keep-alive, gotta see if we can use a different server. Either way, this should be prefered over the usage of Django's TestClient since it has the exact same request flow like a normal client would have. Change-Id: Ic7065ffbe260701728e9d01213fe3a0fd5f0a6d2 --- ara/clients/offline.py | 106 ++++++++++++++++++++++++++--------------- setup.cfg | 2 +- 2 files changed, 68 insertions(+), 40 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index dd446951..3dc5cd8c 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -18,19 +18,23 @@ # This is an "offline" API client that does not require standing up # an API server and does not execute actual HTTP calls. -import json import logging import os +import threading + +from django.core.handlers.wsgi import WSGIHandler +from django.core.servers.basehttp import ServerHandler as BaseServerHandler, ThreadedWSGIServer, WSGIRequestHandler + +from .http import AraHttpClient -class AraOfflineClient(object): +class AraOfflineClient(AraHttpClient): def __init__(self): self.log = logging.getLogger(__name__) try: from django import setup as django_setup from django.core.management import execute_from_command_line - from django.test import Client os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ara.server.settings") @@ -39,52 +43,76 @@ class AraOfflineClient(object): # Set up the things Django needs django_setup() - except ImportError as e: + + self._start_server() + super().__init__(endpoint="http://localhost:%d" % self.server_thread.port) + except ImportError: self.log.error("The offline client requires ara-server to be installed") - raise e + raise - self.client = Client() + def _start_server(self): + self.server_thread = ServerThread("localhost") + self.server_thread.start() - def _request(self, method, endpoint, **kwargs): - func = getattr(self.client, method) - # TODO: Is there a better way than doing this if/else ? - if kwargs: - response = func(endpoint, json.dumps(kwargs), content_type="application/json") - else: - response = func(endpoint, content_type="application/json") + # Wait for the live server to be ready + self.server_thread.is_ready.wait() + if self.server_thread.error: + raise self.server_thread.error - if response.status_code >= 500: - self.log.error( - "Failed to {method} on {endpoint}: {content}".format(method=method, endpoint=endpoint, content=kwargs) - ) - self.log.debug( - "HTTP {status}: {method} on {endpoint}".format( - status=response.status_code, method=method, endpoint=endpoint - ) - ) +class ServerHandler(BaseServerHandler): + def cleanup_headers(self): + super().cleanup_headers() + self.headers["Connection"] = "close" - if response.status_code not in [200, 201, 204]: - self.log.error( - "Failed to {method} on {endpoint}: {content}".format(method=method, endpoint=endpoint, content=kwargs) - ) - if response.status_code == 204: - return response +class QuietWSGIRequestHandler(WSGIRequestHandler): + def log_message(*args): + pass - return response.json() + def handle(self): + """Copy of WSGIRequestHandler.handle() but with different ServerHandler""" + self.raw_requestline = self.rfile.readline(65537) + if len(self.raw_requestline) > 65536: + self.requestline = "" + self.request_version = "" + self.command = "" + self.send_error(414) + return - def get(self, endpoint, **kwargs): - return self._request("get", endpoint, **kwargs) + if not self.parse_request(): # An error code has been sent, just exit + return - def patch(self, endpoint, **kwargs): - return self._request("patch", endpoint, **kwargs) + handler = ServerHandler(self.rfile, self.wfile, self.get_stderr(), self.get_environ()) + handler.request_handler = self # backpointer for logging + handler.run(self.server.get_app()) - def post(self, endpoint, **kwargs): - return self._request("post", endpoint, **kwargs) - def put(self, endpoint, **kwargs): - return self._request("put", endpoint, **kwargs) +class ServerThread(threading.Thread): + def __init__(self, host, port=0): + self.host = host + self.port = port + self.is_ready = threading.Event() + self.error = None + super().__init__(daemon=True) - def delete(self, endpoint, **kwargs): - return self._request("delete", endpoint, **kwargs) + def run(self): + """ + Set up the live server and databases, and then loop over handling + HTTP requests. + """ + try: + # Create the handler for serving static and media files + self.httpd = self._create_server() + # If binding to port zero, assign the port allocated by the OS. + if self.port == 0: + self.port = self.httpd.server_address[1] + self.httpd.set_app(WSGIHandler()) + self.is_ready.set() + self.httpd.serve_forever() + except Exception as e: + self.error = e + self.is_ready.set() + + def _create_server(self): + return ThreadedWSGIServer((self.host, self.port), QuietWSGIRequestHandler, allow_reuse_address=False) diff --git a/setup.cfg b/setup.cfg index 2a8d1ea0..2cf594a4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -74,4 +74,4 @@ multi_line_output=3 include_trailing_comma=True force_grid_wrap=0 combine_as_imports=True -line_length=88 +line_length=120 From 1e1fd3a4be81019c47022e03368f6ac84d94098c Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Wed, 14 Nov 2018 14:18:49 -0500 Subject: [PATCH 20/31] Remove debug line before initiating request The debug log are already a bit chatty, we don't need this particular line because we're getting the result right after with another debug line. Change-Id: I1d60f90cae9db896d4bceaf3f7211597ad8242f3 --- ara/clients/http.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/ara/clients/http.py b/ara/clients/http.py index 29d253ed..bdfb247e 100644 --- a/ara/clients/http.py +++ b/ara/clients/http.py @@ -42,8 +42,6 @@ class HttpClient(object): self.http.headers.update(self.headers) def _request(self, method, url, **payload): - self.log.debug("%s on %s" % (method, url)) - # Use requests.Session to do the query # The actual endpoint is: # From 1c571dbd54f4f9791e04e208f8dbba7148720846 Mon Sep 17 00:00:00 2001 From: melissaml Date: Fri, 7 Dec 2018 20:33:12 +0800 Subject: [PATCH 21/31] Change openstack-dev to openstack-discuss Mailinglists have been updated. Openstack-discuss replaces openstack-dev. Change-Id: I0850b5df4afd4ec5405be4a8e775d166980fbe87 --- setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index 2cf594a4..87f3b621 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,7 +4,7 @@ summary = ARA Records Ansible clients description-file = README.rst author = OpenStack Community -author-email = openstack-dev@lists.openstack.org +author-email = openstack-discuss@lists.openstack.org home-page = https://github.com/openstack/ara-clients classifier = Environment :: OpenStack From 6597aff444dfe68609be87120ecb32453d65aeb7 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Fri, 14 Dec 2018 12:28:06 -0500 Subject: [PATCH 22/31] Use 'ara-clients' instead of __name__ when determining client version This resolves an exception by pbr when Ansible attempts to load the client: """ Versioning for this project requires either an sdist tarball, or access to an upstream git repository. It's also possible that there is a mismatch between the package name in setup.cfg and the argument given to pbr.version.VersionInfo. Project name ara.clients.http was given, but was not able to be found. """ Change-Id: Id56bf0909d17259313307d433a6104fe02e0215e --- ara/clients/http.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ara/clients/http.py b/ara/clients/http.py index bdfb247e..aacd3b7c 100644 --- a/ara/clients/http.py +++ b/ara/clients/http.py @@ -24,7 +24,7 @@ import logging import pbr.version import requests -CLIENT_VERSION = pbr.version.VersionInfo(__name__).release_string() +CLIENT_VERSION = pbr.version.VersionInfo("ara-clients").release_string() class HttpClient(object): From 051c4c92de9cd0a291cac1258861ba421d77c34c Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Tue, 18 Dec 2018 11:28:46 -0500 Subject: [PATCH 23/31] Fix usage of GET requests with query parameters Python requests accepts GET query parameters (?foo=bar&bar=foo) inside the "params" key of the request. Change-Id: Ia493819c48ec907bb6fb9454dea95e4fe62ef03a --- ara/clients/http.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ara/clients/http.py b/ara/clients/http.py index aacd3b7c..bdb9ec7c 100644 --- a/ara/clients/http.py +++ b/ara/clients/http.py @@ -50,7 +50,7 @@ class HttpClient(object): def get(self, url, **payload): if payload: - return self._request("get", url, params=json.dumps(payload)) + return self._request("get", url, **payload) else: return self._request("get", url) @@ -93,7 +93,7 @@ class AraHttpClient(object): return response.json() def get(self, endpoint, **kwargs): - return self._request("get", endpoint, **kwargs) + return self._request("get", endpoint, params=kwargs) def patch(self, endpoint, **kwargs): return self._request("patch", endpoint, **kwargs) From 9dfa7441ab191bfd9c15431c82e3bd64049d912f Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Sat, 10 Nov 2018 14:08:59 +0100 Subject: [PATCH 24/31] Readded support for keep-alive (better performance). Details in: https://github.com/django/django/commit/934acf1126995f6e6ccba5947ec8f7561633c27f Requires: https://review.openstack.org/#/c/628523/ Change-Id: If249cbd289cf3075f57101b3a7f0329446a00664 --- ara/clients/offline.py | 35 ++++++----------------------------- 1 file changed, 6 insertions(+), 29 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index 3dc5cd8c..8cf15b71 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -23,7 +23,7 @@ import os import threading from django.core.handlers.wsgi import WSGIHandler -from django.core.servers.basehttp import ServerHandler as BaseServerHandler, ThreadedWSGIServer, WSGIRequestHandler +from django.core.servers.basehttp import ThreadedWSGIServer, WSGIRequestHandler from .http import AraHttpClient @@ -60,34 +60,6 @@ class AraOfflineClient(AraHttpClient): raise self.server_thread.error -class ServerHandler(BaseServerHandler): - def cleanup_headers(self): - super().cleanup_headers() - self.headers["Connection"] = "close" - - -class QuietWSGIRequestHandler(WSGIRequestHandler): - def log_message(*args): - pass - - def handle(self): - """Copy of WSGIRequestHandler.handle() but with different ServerHandler""" - self.raw_requestline = self.rfile.readline(65537) - if len(self.raw_requestline) > 65536: - self.requestline = "" - self.request_version = "" - self.command = "" - self.send_error(414) - return - - if not self.parse_request(): # An error code has been sent, just exit - return - - handler = ServerHandler(self.rfile, self.wfile, self.get_stderr(), self.get_environ()) - handler.request_handler = self # backpointer for logging - handler.run(self.server.get_app()) - - class ServerThread(threading.Thread): def __init__(self, host, port=0): self.host = host @@ -116,3 +88,8 @@ class ServerThread(threading.Thread): def _create_server(self): return ThreadedWSGIServer((self.host, self.port), QuietWSGIRequestHandler, allow_reuse_address=False) + + +class QuietWSGIRequestHandler(WSGIRequestHandler): + def log_message(*args): + pass From da4a03032a42fb8e7ba1b2e153222678f5e2a15a Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Fri, 18 Jan 2019 11:37:03 -0500 Subject: [PATCH 25/31] Do not attempt to load the offline client if ara-server isn't installed Handling this ahead of time instead of through exception handling increases the odds of a friendlier error message. Change-Id: Ie4c995e3b124d1f0ba51fb5f46c77179b03b6c26 --- ara/clients/offline.py | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index 3dc5cd8c..4d0cc8ea 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -20,35 +20,36 @@ import logging import os +import sys import threading from django.core.handlers.wsgi import WSGIHandler from django.core.servers.basehttp import ServerHandler as BaseServerHandler, ThreadedWSGIServer, WSGIRequestHandler -from .http import AraHttpClient +from ara.clients.http import AraHttpClient class AraOfflineClient(AraHttpClient): def __init__(self): self.log = logging.getLogger(__name__) - try: - from django import setup as django_setup - from django.core.management import execute_from_command_line + # Validate that ara-server is installed + if "ara.server" not in sys.modules: + raise ImportError("AraOfflineClient requires ara-server to be installed.") - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ara.server.settings") + from django import setup as django_setup + from django.core.management import execute_from_command_line - # Automatically create the database and run migrations (is there a better way?) - execute_from_command_line(["django", "migrate"]) + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ara.server.settings") - # Set up the things Django needs - django_setup() + # Automatically create the database and run migrations (is there a better way?) + execute_from_command_line(["django", "migrate"]) - self._start_server() - super().__init__(endpoint="http://localhost:%d" % self.server_thread.port) - except ImportError: - self.log.error("The offline client requires ara-server to be installed") - raise + # Set up the things Django needs + django_setup() + + self._start_server() + super().__init__(endpoint="http://localhost:%d" % self.server_thread.port) def _start_server(self): self.server_thread = ServerThread("localhost") From b4e0ed4becdb79b1432c0303fb8f9f3e783cc833 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Mon, 21 Jan 2019 10:01:10 -0500 Subject: [PATCH 26/31] Remove pep8 job, it'll be replaced by linters This pep8 job is running py2 and is returning syntax errors on py3 f-strings. We'll standardize on the same linters job across ara projects soon. Change-Id: I2ef4578aeeb262c971fc18a6754c06cda95df67d --- .zuul.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.zuul.yaml b/.zuul.yaml index f222942f..3d2a2cb6 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -2,8 +2,6 @@ check: jobs: - tox-format - - tox-pep8 gate: jobs: - tox-format - - tox-pep8 From f460f76b7e9806d301c80c6645daa25b880e4f7a Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Fri, 18 Jan 2019 11:40:26 -0500 Subject: [PATCH 27/31] Improve utils.get_client to supply sane defaults This will make it easier to get started. Change-Id: I46a1944701f544db202b80871e01a382770e2148 --- ara/clients/utils.py | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/ara/clients/utils.py b/ara/clients/utils.py index 1da3e1d9..819a033a 100644 --- a/ara/clients/utils.py +++ b/ara/clients/utils.py @@ -19,10 +19,16 @@ from ara.clients.http import AraHttpClient from ara.clients.offline import AraOfflineClient -def get_client(client=None, **kwargs): - if client is None or client == "offline": - return AraOfflineClient(**kwargs) - elif client == "http": - return AraHttpClient(**kwargs) - else: - raise ValueError("Unsupported client: %s" % client) +def get_client(client="offline", endpoint="http://127.0.0.1:8000", timeout=30): + """ + Returns a specified client configuration or one with sane defaults. + """ + try: + # fmt: off + return { + "offline": AraOfflineClient(), + "http": AraHttpClient(endpoint=endpoint, timeout=timeout) + }[client] + # fmt: on + except KeyError: + raise ValueError(f"Unsupported API client: {client} (use 'http' or 'offline')") From 4a3f2b4418a8ca77c482f03460457131683758fa Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Mon, 21 Jan 2019 11:48:28 -0500 Subject: [PATCH 28/31] Use import instead of sys.modules for verifying ara-server availability If ara.server hasn't been imported already, it won't be there. Change-Id: I6d9c79142b33882cf634db1c439c1df6f2c96c5c --- ara/clients/offline.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index 9edd1d03..072f06bf 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -33,8 +33,11 @@ class AraOfflineClient(AraHttpClient): def __init__(self): self.log = logging.getLogger(__name__) - # Validate that ara-server is installed - if "ara.server" not in sys.modules: + # Validate that ara-server is available before letting Django attempt to + # import it + try: + import ara.server + except ImportError: raise ImportError("AraOfflineClient requires ara-server to be installed.") from django import setup as django_setup From bb45af0f98ed1d4331508e7731fb95c36d4ddec4 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Tue, 22 Jan 2019 09:26:46 -0500 Subject: [PATCH 29/31] Use an if/else for returning the client in get_client Attempting to do something more fancy lead the method to instanciate both clients, let's not do that. Change-Id: I0c8abc48ce146fe7dec592779b4cd07dedcc3bd8 --- ara/clients/utils.py | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/ara/clients/utils.py b/ara/clients/utils.py index 819a033a..9b060c06 100644 --- a/ara/clients/utils.py +++ b/ara/clients/utils.py @@ -23,12 +23,9 @@ def get_client(client="offline", endpoint="http://127.0.0.1:8000", timeout=30): """ Returns a specified client configuration or one with sane defaults. """ - try: - # fmt: off - return { - "offline": AraOfflineClient(), - "http": AraHttpClient(endpoint=endpoint, timeout=timeout) - }[client] - # fmt: on - except KeyError: + if client == "offline": + return AraOfflineClient() + elif client == "http": + return AraHttpClient(endpoint=endpoint, timeout=timeout) + else: raise ValueError(f"Unsupported API client: {client} (use 'http' or 'offline')") From 72ac0dcf99f0e62d07faf749f92684e33f85a7a0 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Wed, 23 Jan 2019 09:46:12 -0500 Subject: [PATCH 30/31] Add new integration jobs to ara-clients There are new jobs defined in ara-infra for testing ara-clients with the other ARA components. Add them to the check and gate pipelines. Depends-On: https://review.openstack.org/#/c/630303 Change-Id: Ia2353c3a20896242d173405457787a5dd29ac5e0 --- .zuul.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.zuul.yaml b/.zuul.yaml index 3d2a2cb6..1eae70c8 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -2,6 +2,12 @@ check: jobs: - tox-format + - ara-integration-fedora-2.7 + - ara-integration-fedora-devel: + voting: false + - ara-integration-ubuntu-2.6 gate: jobs: - tox-format + - ara-integration-fedora-2.7 + - ara-integration-ubuntu-2.6 From e42c10e7b4b4fa980caed30204af6265905bbbb0 Mon Sep 17 00:00:00 2001 From: David Moreau Simard Date: Fri, 25 Jan 2019 12:35:33 -0500 Subject: [PATCH 31/31] Fix pep8 issues It doesn't look like the integration test job picked those up. Change-Id: I8041e0c0730f5d65c014f52992b0ed086322a4b3 --- ara/clients/offline.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/ara/clients/offline.py b/ara/clients/offline.py index 072f06bf..3c0d92df 100644 --- a/ara/clients/offline.py +++ b/ara/clients/offline.py @@ -20,7 +20,6 @@ import logging import os -import sys import threading from django.core.handlers.wsgi import WSGIHandler @@ -36,7 +35,7 @@ class AraOfflineClient(AraHttpClient): # Validate that ara-server is available before letting Django attempt to # import it try: - import ara.server + import ara.server # noqa except ImportError: raise ImportError("AraOfflineClient requires ara-server to be installed.")