diff --git a/.bumpversion.cfg b/.bumpversion.cfg new file mode 100644 index 0000000..4580a39 --- /dev/null +++ b/.bumpversion.cfg @@ -0,0 +1,20 @@ +[bumpversion] +current_version = 1.4.0 +commit = True +tag = True +message = "Release {new_version}" + +[bumpversion:file:setup.py] +search = version='{current_version}' +replace = version='{new_version}' + +[bumpversion:file:src/pytest_postgresql/__init__.py] + +[bumpversion:file:README.rst] + +[bumpversion:file:CHANGES.rst] +search = unreleased + ------- +replace = {new_version} + ------- + diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..1e01055 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,2 @@ +[run] +source = pytest_postgresql diff --git a/.github/ISSUE_TEMPLATE.rst b/.github/ISSUE_TEMPLATE.rst new file mode 100644 index 0000000..0946e37 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.rst @@ -0,0 +1,7 @@ +### What action do you want to perform + + +### What are the results + + +### What are the expected results \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.rst b/.github/PULL_REQUEST_TEMPLATE.rst new file mode 100644 index 0000000..8f849ce --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.rst @@ -0,0 +1,3 @@ +Fixes #[ISSUE_NUMBER_HERE]. + +Changes proposed. \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8df19ab --- /dev/null +++ b/.gitignore @@ -0,0 +1,38 @@ +*.py[cod] + +# C extensions +*.so + +# Packages +*.egg +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 +.cache +.pytest_cache + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox +nosetests.xml + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject +.idea diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..0c5f18c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,50 @@ +dist: xenial +language: python +python: +- 2.7 +- 3.5 +- 3.6 +- 3.7 +- pypy2.7-6.0 +- pypy3.5 +# blocklist branches +branches: + except: + - requires-io-master +install: +- pip install -r requirements-test.txt +- pip install -e .[tests] coveralls wheel +script: +- py.test -n 0 --cov src/pytest_postgresql +after_success: +- coveralls +jobs: + include: + - stage: xdist + python: 3.7 + script: py.test -n 1 --cov src/pytest_postgresql tests + - stage: linters + python: 3.7 + install: + - pip install -r requirements-lint.txt + - pip install .[tests] psycopg2-binary + script: + - pycodestyle + - pydocstyle + - pylint pytest_postgresql tests + - pyroma . + after_success: skip + - stage: deploy + python: 3.7 + if: tag IS present + script: skip + deploy: + provider: pypi + user: thearoom + password: + secure: FAN5dMk+ktvFdfZX6OjKy9+XWwbTrJcZ4OrV6LVKNyZdsVRi0+iE6opSQXH8HjO6DCXsyHkZDD8a6f81y/Cc3j6QsRItnJwjQllu4dNce5LYHZNA/sQ9O8mgC9+DrPWzPYRlMkSgG9eVH3tI8UX1P7Wh4yuJLbQbNkWw8ZX7j+HSwZtYLPhP2uBp7xMF5rYO+9PcIA/I0QI0AkfRQtYtwSp3QAjKUVWnWXnUQOILey5wP+3ENYVojKmYSocmOtbKUUNfExgZIep8gsZXx60fuBQLRSG0XhDxud51nGKvzNegqQoN5Mpt61VslT7trS/D6zOzMCUTqNwbg/gMrebU5IMZm5ijJSKkvw5Cl30Yc5+cZ0o7N9NbepBjlEX3ByDUnDk7bfSRHukJw9lG5+mBHLi+aJ9+ZPEqUcIHuYzv6+yvjlGPkETqlxkCunU6HzwrsD5QdYwqcY4PLHf7Onx3I2Vjg4XxZO27BDbhvpOTF4SaAk45ALi9y10Gu7FSswp44/l5k54Ur1/JPhSmFGIO8XZJZ7mLGftextYLEmQuai7IKmu46rZ3ffzEpIk0lP5xi2NWyQvD9DHEJSMKxc4koVKb72lLbl69aVp+6vKRH4VtJ1E5/Hybrxe9bbz+upQ4xRdXjRAml4xAnGeBcH5hf2owbijYuoU26qOHKl68Ej0= + on: + tags: true + all_branches: true + repo: ClearcodeHQ/pytest-postgresql + distributions: bdist_wheel diff --git a/AUTHORS.rst b/AUTHORS.rst index 1111705..42fdbb4 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -1,17 +1,18 @@ Authors ======= This file contains the list of people involved in the development of pytest-postgresql along its history. * Grzegorz Śliwiński * Jonas Brunsgaard * Tomasz Karbownicki * Domen Kožar * Przemysław Spodymek * Michał Masłowski * Karolina Blümke * Paweł Wilczyński * Georg Walther * François Scala * Donald Stufft +* Will Vaughn diff --git a/CHANGES.rst b/CHANGES.rst index 8ee3913..c4cd88b 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,64 +1,72 @@ CHANGELOG ========= +1.4.0 +------- + +- [enhancements] Ability to configure additional options for postgresql process and connection +- [bugfix] - removed hard dependency on ``psycopg2``, allowing any of its alternative packages, like + ``psycopg2-binary``, to be used. +- [maintenance] Drop support for python 3.4 and use 3.7 instead + 1.3.4 ------- - [bugfix] properly detect if executor running and clean after executor is being stopped .. note:: Previously if a test failed, there was a possibility of the executor being removed when python was closing, causing it to print ignored errors on already unloaded modules. 1.3.3 ------- - [enhancement] use executor's context manager to start/stop postrgesql server in a fixture 1.3.2 ------- - [bugfix] version regexp to correctly catch postgresql 10 1.3.1 ------- - [enhancement] explicitly turn off logging_collector 1.3.0 ------- - [feature] pypy compatibility 1.2.0 ------- - [bugfix] - disallow connection to database before it gets dropped. .. note:: Otherwise it caused random test subprocess to connect again and this the drop was unsucessfull which resulted in many more test failes on setup. - [cleanup] - removed path.py dependency 1.1.1 ------- - [bugfix] - Fixing the default pg_ctl path creation 1.1.0 ------- - [feature] - migrate usage of getfuncargvalue to getfixturevalue. require at least pytest 3.0.0 1.0.0 ------- - create command line and pytest.ini configuration options for postgresql starting parameters - create command line and pytest.ini configuration options for postgresql username - make the port random by default - create command line and pytest.ini configuration options for executable - create command line and pytest.ini configuration options for host - create command line and pytest.ini configuration options for port - Extracted code from pytest-dbfixtures diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..20d40b6 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/COPYING.lesser b/COPYING.lesser new file mode 100644 index 0000000..02bbb60 --- /dev/null +++ b/COPYING.lesser @@ -0,0 +1,165 @@ + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. \ No newline at end of file diff --git a/PKG-INFO b/PKG-INFO deleted file mode 100644 index d001f46..0000000 --- a/PKG-INFO +++ /dev/null @@ -1,222 +0,0 @@ -Metadata-Version: 2.1 -Name: pytest-postgresql -Version: 1.3.4 -Summary: Postgresql fixtures and fixture factories for Pytest. -Home-page: https://github.com/ClearcodeHQ/pytest-postgresql -Author: Clearcode - The A Room -Author-email: thearoom@clearcode.cc -License: LGPLv3+ -Description: pytest-postgresql - ================= - - .. image:: https://img.shields.io/pypi/v/pytest-postgresql.svg - :target: https://pypi.python.org/pypi/pytest-postgresql/ - :alt: Latest PyPI version - - .. image:: https://img.shields.io/pypi/wheel/pytest-postgresql.svg - :target: https://pypi.python.org/pypi/pytest-postgresql/ - :alt: Wheel Status - - .. image:: https://img.shields.io/pypi/pyversions/pytest-postgresql.svg - :target: https://pypi.python.org/pypi/pytest-postgresql/ - :alt: Supported Python Versions - - .. image:: https://img.shields.io/pypi/l/pytest-postgresql.svg - :target: https://pypi.python.org/pypi/pytest-postgresql/ - :alt: License - - Package status - -------------- - - .. image:: https://travis-ci.org/ClearcodeHQ/pytest-postgresql.svg?branch=v1.3.4 - :target: https://travis-ci.org/ClearcodeHQ/pytest-postgresql - :alt: Tests - - .. image:: https://coveralls.io/repos/ClearcodeHQ/pytest-postgresql/badge.png?branch=v1.3.4 - :target: https://coveralls.io/r/ClearcodeHQ/pytest-postgresql?branch=v1.3.4 - :alt: Coverage Status - - .. image:: https://requires.io/github/ClearcodeHQ/pytest-postgresql/requirements.svg?tag=v1.3.4 - :target: https://requires.io/github/ClearcodeHQ/pytest-postgresql/requirements/?tag=v1.3.4 - :alt: Requirements Status - - What is this? - ============= - - This is a pytest plugin, that enables you to test your code that relies on a running PostgreSQL Database. - It allows you to specify fixtures for PostgreSQL process and client. - - How to use - ========== - - .. warning:: - - Tested on PostgreSQL versions > 9.x. See tests for more details. - - Plugin contains two fixtures - - * **postgresql** - it's a client fixture that has functional scope. After each test it ends all leftover connections, and drops test database from PostgreSQL ensuring repeatability. - * **postgresql_proc** - session scoped fixture, that starts PostgreSQL instance at it's first use and stops at the end of the tests. - - Simply include one of these fixtures into your tests fixture list. - - You can also create additional postgresql client and process fixtures if you'd need to: - - - .. code-block:: python - - from pytest_postgresql import factories - - postgresql_my_proc = factories.postgresql_proc( - port=None, logsdir='/tmp') - postgresql_my = factories.postgresql('postgresql_my_proc') - - .. note:: - - Each PostgreSQL process fixture can be configured in a different way than the others through the fixture factory arguments. - - Configuration - ============= - - You can define your settings in three ways, it's fixture factory argument, command line option and pytest.ini configuration option. - You can pick which you prefer, but remember that these settings are handled in the following order: - - * ``Fixture factory argument`` - * ``Command line option`` - * ``Configuration option in your pytest.ini file`` - - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | PostgreSQL option | Fixture factory argument | Command line option | pytest.ini option | Default | - +==========================+==========================+============================+==========================+====================================+ - | Path to executable | executable | --postgresql-exec | postgresql_exec | /usr/lib/postgresql/9.1/bin/pg_ctl | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | host | host | --postgresql-host | postgresql_host | 127.0.0.1 | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | port | port | --postgresql-port | postgresql_port | random | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | postgresql user | user | --postgresql-user | postgresql_user | postgres | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | Starting parameters | startparams | --postgresql-startparams | postgresql_startparams | -w | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | Log directory location | logsdir | --postgresql-logsdir | postgresql_logsdir | $TMPDIR | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | Log filename's prefix | logsprefix | --postgresql-logsprefix | postgresql_logsprefix | | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | Location for unixsockets | unixsocket | --postgresql-unixsocketdir | postgresql_unixsocketdir | $TMPDIR | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - - Example usage: - - * pass it as an argument in your own fixture - - .. code-block:: python - - postgresql_proc = factories.postgresql_proc( - port=8888) - - * use ``--postgresql-port`` command line option when you run your tests - - .. code-block:: - - py.test tests --postgresql-port=8888 - - - * specify your port as ``postgresql_port`` in your ``pytest.ini`` file. - - To do so, put a line like the following under the ``[pytest]`` section of your ``pytest.ini``: - - .. code-block:: ini - - [pytest] - postgresql_port = 8888 - - Package resources - ----------------- - - * Bug tracker: https://github.com/ClearcodeHQ/pytest-postgresql/issues - - - - CHANGELOG - ========= - - 1.3.4 - ------- - - - [bugfix] properly detect if executor running and clean after executor is being stopped - - .. note:: - - Previously if a test failed, there was a possibility of the executor being removed when python was closing, - causing it to print ignored errors on already unloaded modules. - - 1.3.3 - ------- - - - [enhancement] use executor's context manager to start/stop postrgesql server in a fixture - - 1.3.2 - ------- - - - [bugfix] version regexp to correctly catch postgresql 10 - - 1.3.1 - ------- - - - [enhancement] explicitly turn off logging_collector - - 1.3.0 - ------- - - - [feature] pypy compatibility - - 1.2.0 - ------- - - - [bugfix] - disallow connection to database before it gets dropped. - - .. note:: - - Otherwise it caused random test subprocess to connect again and this the drop was unsucessfull which resulted in many more test failes on setup. - - - [cleanup] - removed path.py dependency - - 1.1.1 - ------- - - - [bugfix] - Fixing the default pg_ctl path creation - - 1.1.0 - ------- - - - [feature] - migrate usage of getfuncargvalue to getfixturevalue. require at least pytest 3.0.0 - - 1.0.0 - ------- - - - create command line and pytest.ini configuration options for postgresql starting parameters - - create command line and pytest.ini configuration options for postgresql username - - make the port random by default - - create command line and pytest.ini configuration options for executable - - create command line and pytest.ini configuration options for host - - create command line and pytest.ini configuration options for port - - Extracted code from pytest-dbfixtures - -Keywords: tests py.test pytest fixture postgresql -Platform: UNKNOWN -Classifier: Development Status :: 5 - Production/Stable -Classifier: Environment :: Web Environment -Classifier: Intended Audience :: Developers -Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+) -Classifier: Natural Language :: English -Classifier: Operating System :: OS Independent -Classifier: Programming Language :: Python -Classifier: Programming Language :: Python :: 2 -Classifier: Programming Language :: Python :: 2.7 -Classifier: Programming Language :: Python :: 3 -Classifier: Programming Language :: Python :: 3.4 -Classifier: Programming Language :: Python :: 3.5 -Classifier: Programming Language :: Python :: 3.6 -Classifier: Topic :: Software Development :: Libraries :: Python Modules -Provides-Extra: docs -Provides-Extra: tests diff --git a/README.rst b/README.rst index 3e12701..a11681c 100644 --- a/README.rst +++ b/README.rst @@ -1,129 +1,138 @@ pytest-postgresql ================= .. image:: https://img.shields.io/pypi/v/pytest-postgresql.svg :target: https://pypi.python.org/pypi/pytest-postgresql/ :alt: Latest PyPI version .. image:: https://img.shields.io/pypi/wheel/pytest-postgresql.svg :target: https://pypi.python.org/pypi/pytest-postgresql/ :alt: Wheel Status .. image:: https://img.shields.io/pypi/pyversions/pytest-postgresql.svg :target: https://pypi.python.org/pypi/pytest-postgresql/ :alt: Supported Python Versions .. image:: https://img.shields.io/pypi/l/pytest-postgresql.svg :target: https://pypi.python.org/pypi/pytest-postgresql/ :alt: License Package status -------------- -.. image:: https://travis-ci.org/ClearcodeHQ/pytest-postgresql.svg?branch=v1.3.4 +.. image:: https://travis-ci.org/ClearcodeHQ/pytest-postgresql.svg?branch=v1.4.0 :target: https://travis-ci.org/ClearcodeHQ/pytest-postgresql :alt: Tests -.. image:: https://coveralls.io/repos/ClearcodeHQ/pytest-postgresql/badge.png?branch=v1.3.4 - :target: https://coveralls.io/r/ClearcodeHQ/pytest-postgresql?branch=v1.3.4 +.. image:: https://coveralls.io/repos/ClearcodeHQ/pytest-postgresql/badge.png?branch=v1.4.0 + :target: https://coveralls.io/r/ClearcodeHQ/pytest-postgresql?branch=v1.4.0 :alt: Coverage Status -.. image:: https://requires.io/github/ClearcodeHQ/pytest-postgresql/requirements.svg?tag=v1.3.4 - :target: https://requires.io/github/ClearcodeHQ/pytest-postgresql/requirements/?tag=v1.3.4 +.. image:: https://requires.io/github/ClearcodeHQ/pytest-postgresql/requirements.svg?tag=v1.4.0 + :target: https://requires.io/github/ClearcodeHQ/pytest-postgresql/requirements/?tag=v1.4.0 :alt: Requirements Status What is this? ============= This is a pytest plugin, that enables you to test your code that relies on a running PostgreSQL Database. It allows you to specify fixtures for PostgreSQL process and client. How to use ========== .. warning:: Tested on PostgreSQL versions > 9.x. See tests for more details. -Plugin contains two fixtures +Install with: + +.. code-block:: sh + + pip install pytest-postgresql + +You will also need to install ``psycopg2``, or one of its alternative packagings such as ``psycopg2-binary`` +(pre-compiled wheels) or ``psycopg2cffi`` (CFFI based, useful on PyPy). + +Plugin contains two fixtures: * **postgresql** - it's a client fixture that has functional scope. After each test it ends all leftover connections, and drops test database from PostgreSQL ensuring repeatability. * **postgresql_proc** - session scoped fixture, that starts PostgreSQL instance at it's first use and stops at the end of the tests. Simply include one of these fixtures into your tests fixture list. You can also create additional postgresql client and process fixtures if you'd need to: .. code-block:: python from pytest_postgresql import factories postgresql_my_proc = factories.postgresql_proc( port=None, logsdir='/tmp') postgresql_my = factories.postgresql('postgresql_my_proc') .. note:: Each PostgreSQL process fixture can be configured in a different way than the others through the fixture factory arguments. Configuration ============= You can define your settings in three ways, it's fixture factory argument, command line option and pytest.ini configuration option. You can pick which you prefer, but remember that these settings are handled in the following order: * ``Fixture factory argument`` * ``Command line option`` * ``Configuration option in your pytest.ini file`` +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ | PostgreSQL option | Fixture factory argument | Command line option | pytest.ini option | Default | +==========================+==========================+============================+==========================+====================================+ | Path to executable | executable | --postgresql-exec | postgresql_exec | /usr/lib/postgresql/9.1/bin/pg_ctl | +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ | host | host | --postgresql-host | postgresql_host | 127.0.0.1 | +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ | port | port | --postgresql-port | postgresql_port | random | +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ | postgresql user | user | --postgresql-user | postgresql_user | postgres | +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ | Starting parameters | startparams | --postgresql-startparams | postgresql_startparams | -w | +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ | Log directory location | logsdir | --postgresql-logsdir | postgresql_logsdir | $TMPDIR | +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ | Log filename's prefix | logsprefix | --postgresql-logsprefix | postgresql_logsprefix | | +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ | Location for unixsockets | unixsocket | --postgresql-unixsocketdir | postgresql_unixsocketdir | $TMPDIR | +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ Example usage: * pass it as an argument in your own fixture .. code-block:: python postgresql_proc = factories.postgresql_proc( port=8888) * use ``--postgresql-port`` command line option when you run your tests .. code-block:: py.test tests --postgresql-port=8888 * specify your port as ``postgresql_port`` in your ``pytest.ini`` file. To do so, put a line like the following under the ``[pytest]`` section of your ``pytest.ini``: .. code-block:: ini [pytest] postgresql_port = 8888 Package resources ----------------- * Bug tracker: https://github.com/ClearcodeHQ/pytest-postgresql/issues diff --git a/pylintrc b/pylintrc new file mode 100644 index 0000000..6227ca0 --- /dev/null +++ b/pylintrc @@ -0,0 +1,479 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable= + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma, + dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package.. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# Maximum number of arguments for function / method. +max-args=13 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement. +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled). +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled). +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception". +overgeneral-exceptions=Exception diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..a34198b --- /dev/null +++ b/pytest.ini @@ -0,0 +1,5 @@ +[pytest] +addopts = --max-slave-restart=0 --showlocals --verbose +postgresql_exec = /usr/lib/postgresql/9.6/bin/pg_ctl +testpaths = tests +xfail_strict = true diff --git a/requirements-lint.txt b/requirements-lint.txt new file mode 100644 index 0000000..aba7974 --- /dev/null +++ b/requirements-lint.txt @@ -0,0 +1,6 @@ +# linters +pycodestyle==2.5.0 +pydocstyle==3.0.0 +pylint==2.3.1; python_version>'3.3' +pygments +pyroma==2.4 diff --git a/requirements-test.txt b/requirements-test.txt new file mode 100644 index 0000000..3167391 --- /dev/null +++ b/requirements-test.txt @@ -0,0 +1,9 @@ +# test runs requirements (versions we'll be testing against) - automatically updated by requires.io +pip>=9 # minimum installation requirements +setuptools>=21 # minimum installation requirements +coverage==4.5.3 # pytest-cov +pytest==4.4.0 +psycopg2-binary==2.8.1; platform_python_implementation != "PyPy" +psycopg2cffi==2.8.1; platform_python_implementation == "PyPy" +port-for==0.4 +mirakuru==1.1.0 diff --git a/setup.cfg b/setup.cfg index 1e3eb36..0b2cc00 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,10 @@ [wheel] universal = 1 -[egg_info] -tag_build = -tag_date = 0 +[pycodestyle] +max-line-length = 80 +exclude = docs/*,build/*,venv/* +[pydocstyle] +ignore = D203,D212 +match = '(?!docs|build|venv).*\.py' \ No newline at end of file diff --git a/setup.py b/setup.py index e4edcbe..0583104 100644 --- a/setup.py +++ b/setup.py @@ -1,104 +1,102 @@ # -*- coding: utf-8 -*- # Copyright (C) 2016 by Clearcode # and associates (see AUTHORS). # This file is part of pytest-postgresql. # pytest-postgresql is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # pytest-postgresql 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 Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public License # along with pytest-postgresql. If not, see . """pytest-postgresql setup.py module.""" import os from setuptools import setup, find_packages here = os.path.dirname(__file__) def read(fname): """ Read given file's content. :param str fname: file name :returns: file contents :rtype: str """ return open(os.path.join(here, fname)).read() requirements = [ 'pytest>=3.0.0', 'port-for', 'mirakuru' ] test_requires = [ - 'pytest-cov==2.5.1', - 'pytest-xdist==1.22.2', + 'pytest-cov==2.6.1', + 'pytest-xdist==1.28.0', ] extras_require = { 'docs': ['sphinx'], 'tests': test_requires, - ': platform_python_implementation != "PyPy"': ['psycopg2'], - ': platform_python_implementation == "PyPy"': ['psycopg2cffi'], } setup_requires = [ 'setuptools>=21', 'pip>=9' ] setup( name='pytest-postgresql', - version='1.3.4', + version='1.4.0', description='Postgresql fixtures and fixture factories for Pytest.', long_description=( read('README.rst') + '\n\n' + read('CHANGES.rst') ), keywords='tests py.test pytest fixture postgresql', author='Clearcode - The A Room', author_email='thearoom@clearcode.cc', url='https://github.com/ClearcodeHQ/pytest-postgresql', license='LGPLv3+', classifiers=[ 'Development Status :: 5 - Production/Stable', 'Environment :: Web Environment', 'Intended Audience :: Developers', 'License :: OSI Approved :: ' 'GNU Lesser General Public License v3 or later (LGPLv3+)', 'Natural Language :: English', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', 'Topic :: Software Development :: Libraries :: Python Modules', ], package_dir={'': 'src'}, packages=find_packages('src'), install_requires=requirements, tests_require=test_requires, setup_requires=setup_requires, test_suite='tests', entry_points={ 'pytest11': [ 'pytest_postgresql = pytest_postgresql.plugin' ]}, include_package_data=True, zip_safe=False, extras_require=extras_require, ) diff --git a/src/pytest_postgresql.egg-info/PKG-INFO b/src/pytest_postgresql.egg-info/PKG-INFO deleted file mode 100644 index d001f46..0000000 --- a/src/pytest_postgresql.egg-info/PKG-INFO +++ /dev/null @@ -1,222 +0,0 @@ -Metadata-Version: 2.1 -Name: pytest-postgresql -Version: 1.3.4 -Summary: Postgresql fixtures and fixture factories for Pytest. -Home-page: https://github.com/ClearcodeHQ/pytest-postgresql -Author: Clearcode - The A Room -Author-email: thearoom@clearcode.cc -License: LGPLv3+ -Description: pytest-postgresql - ================= - - .. image:: https://img.shields.io/pypi/v/pytest-postgresql.svg - :target: https://pypi.python.org/pypi/pytest-postgresql/ - :alt: Latest PyPI version - - .. image:: https://img.shields.io/pypi/wheel/pytest-postgresql.svg - :target: https://pypi.python.org/pypi/pytest-postgresql/ - :alt: Wheel Status - - .. image:: https://img.shields.io/pypi/pyversions/pytest-postgresql.svg - :target: https://pypi.python.org/pypi/pytest-postgresql/ - :alt: Supported Python Versions - - .. image:: https://img.shields.io/pypi/l/pytest-postgresql.svg - :target: https://pypi.python.org/pypi/pytest-postgresql/ - :alt: License - - Package status - -------------- - - .. image:: https://travis-ci.org/ClearcodeHQ/pytest-postgresql.svg?branch=v1.3.4 - :target: https://travis-ci.org/ClearcodeHQ/pytest-postgresql - :alt: Tests - - .. image:: https://coveralls.io/repos/ClearcodeHQ/pytest-postgresql/badge.png?branch=v1.3.4 - :target: https://coveralls.io/r/ClearcodeHQ/pytest-postgresql?branch=v1.3.4 - :alt: Coverage Status - - .. image:: https://requires.io/github/ClearcodeHQ/pytest-postgresql/requirements.svg?tag=v1.3.4 - :target: https://requires.io/github/ClearcodeHQ/pytest-postgresql/requirements/?tag=v1.3.4 - :alt: Requirements Status - - What is this? - ============= - - This is a pytest plugin, that enables you to test your code that relies on a running PostgreSQL Database. - It allows you to specify fixtures for PostgreSQL process and client. - - How to use - ========== - - .. warning:: - - Tested on PostgreSQL versions > 9.x. See tests for more details. - - Plugin contains two fixtures - - * **postgresql** - it's a client fixture that has functional scope. After each test it ends all leftover connections, and drops test database from PostgreSQL ensuring repeatability. - * **postgresql_proc** - session scoped fixture, that starts PostgreSQL instance at it's first use and stops at the end of the tests. - - Simply include one of these fixtures into your tests fixture list. - - You can also create additional postgresql client and process fixtures if you'd need to: - - - .. code-block:: python - - from pytest_postgresql import factories - - postgresql_my_proc = factories.postgresql_proc( - port=None, logsdir='/tmp') - postgresql_my = factories.postgresql('postgresql_my_proc') - - .. note:: - - Each PostgreSQL process fixture can be configured in a different way than the others through the fixture factory arguments. - - Configuration - ============= - - You can define your settings in three ways, it's fixture factory argument, command line option and pytest.ini configuration option. - You can pick which you prefer, but remember that these settings are handled in the following order: - - * ``Fixture factory argument`` - * ``Command line option`` - * ``Configuration option in your pytest.ini file`` - - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | PostgreSQL option | Fixture factory argument | Command line option | pytest.ini option | Default | - +==========================+==========================+============================+==========================+====================================+ - | Path to executable | executable | --postgresql-exec | postgresql_exec | /usr/lib/postgresql/9.1/bin/pg_ctl | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | host | host | --postgresql-host | postgresql_host | 127.0.0.1 | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | port | port | --postgresql-port | postgresql_port | random | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | postgresql user | user | --postgresql-user | postgresql_user | postgres | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | Starting parameters | startparams | --postgresql-startparams | postgresql_startparams | -w | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | Log directory location | logsdir | --postgresql-logsdir | postgresql_logsdir | $TMPDIR | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | Log filename's prefix | logsprefix | --postgresql-logsprefix | postgresql_logsprefix | | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - | Location for unixsockets | unixsocket | --postgresql-unixsocketdir | postgresql_unixsocketdir | $TMPDIR | - +--------------------------+--------------------------+----------------------------+--------------------------+------------------------------------+ - - Example usage: - - * pass it as an argument in your own fixture - - .. code-block:: python - - postgresql_proc = factories.postgresql_proc( - port=8888) - - * use ``--postgresql-port`` command line option when you run your tests - - .. code-block:: - - py.test tests --postgresql-port=8888 - - - * specify your port as ``postgresql_port`` in your ``pytest.ini`` file. - - To do so, put a line like the following under the ``[pytest]`` section of your ``pytest.ini``: - - .. code-block:: ini - - [pytest] - postgresql_port = 8888 - - Package resources - ----------------- - - * Bug tracker: https://github.com/ClearcodeHQ/pytest-postgresql/issues - - - - CHANGELOG - ========= - - 1.3.4 - ------- - - - [bugfix] properly detect if executor running and clean after executor is being stopped - - .. note:: - - Previously if a test failed, there was a possibility of the executor being removed when python was closing, - causing it to print ignored errors on already unloaded modules. - - 1.3.3 - ------- - - - [enhancement] use executor's context manager to start/stop postrgesql server in a fixture - - 1.3.2 - ------- - - - [bugfix] version regexp to correctly catch postgresql 10 - - 1.3.1 - ------- - - - [enhancement] explicitly turn off logging_collector - - 1.3.0 - ------- - - - [feature] pypy compatibility - - 1.2.0 - ------- - - - [bugfix] - disallow connection to database before it gets dropped. - - .. note:: - - Otherwise it caused random test subprocess to connect again and this the drop was unsucessfull which resulted in many more test failes on setup. - - - [cleanup] - removed path.py dependency - - 1.1.1 - ------- - - - [bugfix] - Fixing the default pg_ctl path creation - - 1.1.0 - ------- - - - [feature] - migrate usage of getfuncargvalue to getfixturevalue. require at least pytest 3.0.0 - - 1.0.0 - ------- - - - create command line and pytest.ini configuration options for postgresql starting parameters - - create command line and pytest.ini configuration options for postgresql username - - make the port random by default - - create command line and pytest.ini configuration options for executable - - create command line and pytest.ini configuration options for host - - create command line and pytest.ini configuration options for port - - Extracted code from pytest-dbfixtures - -Keywords: tests py.test pytest fixture postgresql -Platform: UNKNOWN -Classifier: Development Status :: 5 - Production/Stable -Classifier: Environment :: Web Environment -Classifier: Intended Audience :: Developers -Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+) -Classifier: Natural Language :: English -Classifier: Operating System :: OS Independent -Classifier: Programming Language :: Python -Classifier: Programming Language :: Python :: 2 -Classifier: Programming Language :: Python :: 2.7 -Classifier: Programming Language :: Python :: 3 -Classifier: Programming Language :: Python :: 3.4 -Classifier: Programming Language :: Python :: 3.5 -Classifier: Programming Language :: Python :: 3.6 -Classifier: Topic :: Software Development :: Libraries :: Python Modules -Provides-Extra: docs -Provides-Extra: tests diff --git a/src/pytest_postgresql.egg-info/SOURCES.txt b/src/pytest_postgresql.egg-info/SOURCES.txt deleted file mode 100644 index a82af0a..0000000 --- a/src/pytest_postgresql.egg-info/SOURCES.txt +++ /dev/null @@ -1,26 +0,0 @@ -AUTHORS.rst -CHANGES.rst -CONTRIBUTING.rst -MANIFEST.in -README.rst -setup.cfg -setup.py -docs/Makefile -docs/make.bat -docs/source/authors.rst -docs/source/changelog.rst -docs/source/conf.py -docs/source/contributing.rst -docs/source/index.rst -src/pytest_postgresql/__init__.py -src/pytest_postgresql/executor.py -src/pytest_postgresql/factories.py -src/pytest_postgresql/plugin.py -src/pytest_postgresql/port.py -src/pytest_postgresql.egg-info/PKG-INFO -src/pytest_postgresql.egg-info/SOURCES.txt -src/pytest_postgresql.egg-info/dependency_links.txt -src/pytest_postgresql.egg-info/entry_points.txt -src/pytest_postgresql.egg-info/not-zip-safe -src/pytest_postgresql.egg-info/requires.txt -src/pytest_postgresql.egg-info/top_level.txt \ No newline at end of file diff --git a/src/pytest_postgresql.egg-info/dependency_links.txt b/src/pytest_postgresql.egg-info/dependency_links.txt deleted file mode 100644 index 8b13789..0000000 --- a/src/pytest_postgresql.egg-info/dependency_links.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/src/pytest_postgresql.egg-info/entry_points.txt b/src/pytest_postgresql.egg-info/entry_points.txt deleted file mode 100644 index e83af0c..0000000 --- a/src/pytest_postgresql.egg-info/entry_points.txt +++ /dev/null @@ -1,3 +0,0 @@ -[pytest11] -pytest_postgresql = pytest_postgresql.plugin - diff --git a/src/pytest_postgresql.egg-info/not-zip-safe b/src/pytest_postgresql.egg-info/not-zip-safe deleted file mode 100644 index 8b13789..0000000 --- a/src/pytest_postgresql.egg-info/not-zip-safe +++ /dev/null @@ -1 +0,0 @@ - diff --git a/src/pytest_postgresql.egg-info/requires.txt b/src/pytest_postgresql.egg-info/requires.txt deleted file mode 100644 index 1f0f381..0000000 --- a/src/pytest_postgresql.egg-info/requires.txt +++ /dev/null @@ -1,16 +0,0 @@ -pytest>=3.0.0 -port-for -mirakuru - -[: platform_python_implementation != "PyPy"] -psycopg2 - -[: platform_python_implementation == "PyPy"] -psycopg2cffi - -[docs] -sphinx - -[tests] -pytest-cov==2.5.1 -pytest-xdist==1.22.2 diff --git a/src/pytest_postgresql.egg-info/top_level.txt b/src/pytest_postgresql.egg-info/top_level.txt deleted file mode 100644 index 906e435..0000000 --- a/src/pytest_postgresql.egg-info/top_level.txt +++ /dev/null @@ -1 +0,0 @@ -pytest_postgresql diff --git a/src/pytest_postgresql/__init__.py b/src/pytest_postgresql/__init__.py index 989cf8d..1ebb785 100644 --- a/src/pytest_postgresql/__init__.py +++ b/src/pytest_postgresql/__init__.py @@ -1,31 +1,27 @@ # -*- coding: utf-8 -*- # Copyright (C) 2016 by Clearcode # and associates (see AUTHORS). # This file is part of pytest-postgresql. # pytest-postgresql is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # pytest-postgresql 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 Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public License # along with pytest-postgresql. If not, see . """Main module for pytest-postgresql.""" - -import logging -import platform - -__version__ = '1.3.4' - - -logger = logging.getLogger(__name__) - -if platform.python_implementation() == "PyPy": - import psycopg2cffi.compat +try: + import psycopg2cffi.compat # pylint:disable=import-error +except ImportError: + pass +else: psycopg2cffi.compat.register() + +__version__ = '1.4.0' diff --git a/src/pytest_postgresql/executor.py b/src/pytest_postgresql/executor.py index 75baf41..c12c71c 100644 --- a/src/pytest_postgresql/executor.py +++ b/src/pytest_postgresql/executor.py @@ -1,125 +1,126 @@ + # Copyright (C) 2013 by Clearcode # and associates (see AUTHORS). # This file is part of pytest-dbfixtures. # pytest-dbfixtures is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # pytest-dbfixtures 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 Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public License # along with pytest-dbfixtures. If not, see . """PostgreSQL executor crafter around pg_ctl.""" import os.path import re import subprocess from mirakuru import TCPExecutor class PostgreSQLExecutor(TCPExecutor): """ PostgreSQL executor running on pg_ctl. Based over an `pg_ctl program `_ """ BASE_PROC_START_COMMAND = ' '.join(( "{executable} start -D {datadir}", "-o \"-F -p {port} -c log_destination='stderr'", "-c logging_collector=off -c %s='{unixsocketdir}'\"", "-l {logfile} {startparams}" )) - VERSION_RE = re.compile('.* (?P\d+\.\d)') + VERSION_RE = re.compile(r'.* (?P\d+\.\d)') def __init__(self, executable, host, port, datadir, unixsocketdir, logfile, startparams, - shell=False, timeout=60, sleep=0.1, user='postgres'): + shell=False, timeout=60, sleep=0.1, user='postgres', + options=''): """ Initialize PostgreSQLExecutor executor. :param str executable: pg_ctl location :param str host: host under which process is accessible :param int port: port under which process is accessible :param str datadir: path to postgresql datadir :param str unixsocketdir: path to socket directory :param str logfile: path to logfile for postgresql :param str startparams: additional start parameters :param bool shell: see `subprocess.Popen` :param int timeout: time to wait for process to start or stop. if None, wait indefinitely. :param float sleep: how often to check for start/stop condition :param str user: [default] postgresql's username used to manage and access PostgreSQL """ self.executable = executable self.user = user - self.version = self.version() + self.options = options self.datadir = datadir self.unixsocketdir = unixsocketdir command = self.proc_start_command().format( executable=self.executable, datadir=self.datadir, port=port, unixsocketdir=self.unixsocketdir, logfile=logfile, startparams=startparams, ) super(PostgreSQLExecutor, self).__init__( command, host, port, shell=shell, timeout=timeout, sleep=sleep) def proc_start_command(self): """Based on postgres version return proper start command.""" if float(self.version) > 9.2: unix_socket_dir_arg_name = 'unix_socket_directories' else: unix_socket_dir_arg_name = 'unix_socket_directory' return self.BASE_PROC_START_COMMAND % unix_socket_dir_arg_name + @property def version(self): """Detect postgresql version.""" version_string = subprocess.check_output( [self.executable, '--version']).decode('utf-8') matches = self.VERSION_RE.search(version_string) return matches.groupdict()['version'] def running(self): """Check if server is still running.""" if not os.path.exists(self.datadir): return False try: output = subprocess.check_output( '{pg_ctl} status -D {datadir}'.format( pg_ctl=self.executable, datadir=self.datadir ), shell=True ).decode('utf-8') - except subprocess.CalledProcessError as e: - if b'pg_ctl: no server running' in e.output: + except subprocess.CalledProcessError as ex: + if b'pg_ctl: no server running' in ex.output: return False raise return "pg_ctl: server is running" in output - def stop(self): + def stop(self, sig=None): """Issue a stop request to executable.""" subprocess.check_output( '{pg_ctl} stop -D {datadir} -m f'.format( pg_ctl=self.executable, datadir=self.datadir, - port=self.port, - unixsocketdir=self.unixsocketdir ), shell=True) - super(PostgreSQLExecutor, self).stop() + super(PostgreSQLExecutor, self).stop(sig) diff --git a/src/pytest_postgresql/factories.py b/src/pytest_postgresql/factories.py index dc09c29..5b778f2 100644 --- a/src/pytest_postgresql/factories.py +++ b/src/pytest_postgresql/factories.py @@ -1,291 +1,301 @@ # Copyright (C) 2013-2016 by Clearcode # and associates (see AUTHORS). # This file is part of pytest-dbfixtures. # pytest-dbfixtures is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # pytest-dbfixtures 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 Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public License # along with pytest-dbfixtures. If not, see . """Fixture factories for postgresql fixtures.""" import os.path import time import shutil import platform import subprocess from tempfile import gettempdir import pytest -import psycopg2 +try: + import psycopg2 +except ImportError: + psycopg2 = False from pytest_postgresql.executor import PostgreSQLExecutor from pytest_postgresql.port import get_port def get_config(request): """Return a dictionary with config options.""" config = {} options = [ - 'exec', 'host', 'port', 'user', 'startparams', 'logsdir', + 'exec', 'host', 'port', 'user', 'options', 'startparams', 'logsdir', 'logsprefix', 'unixsocketdir' ] for option in options: option_name = 'postgresql_' + option conf = request.config.getoption(option_name) or \ request.config.getini(option_name) config[option] = conf return config START_INFO = 'database system is ready to accept connections' def wait_for_postgres(logfile, awaited_msg): """ Wait for postgresql being started. :param str logfile: logfile path :param str awaited_msg: awaited message """ # wait until logfile is created while not os.path.isfile(logfile): time.sleep(1) # wait for expected message. while 1: with open(logfile, 'r') as content_file: content = content_file.read() if awaited_msg in content: break time.sleep(1) def remove_postgresql_directory(datadir): """ Remove directory created for postgresql run. :param str datadir: datadir path """ if os.path.isdir(datadir): shutil.rmtree(datadir) def init_postgresql_directory(postgresql_ctl, user, datadir): """ Initialize postgresql data directory. See `Initialize postgresql data directory `_ :param str postgresql_ctl: ctl path :param str user: postgresql username :param str datadir: datadir path """ # remove old one if exists first. remove_postgresql_directory(datadir) init_directory = ( postgresql_ctl, 'initdb', '-o "--auth=trust --username=%s"' % user, '-D %s' % datadir, ) subprocess.check_output(' '.join(init_directory), shell=True) -def init_postgresql_database(user, host, port, db): +def init_postgresql_database(user, host, port, db_name): """ Create database in postgresql. :param str user: postgresql username :param str host: postgresql host :param str port: postgresql port - :param str db: database name + :param str db_name: database name """ conn = psycopg2.connect(user=user, host=host, port=port) conn.set_isolation_level(psycopg2.extensions.ISOLATION_LEVEL_AUTOCOMMIT) cur = conn.cursor() - cur.execute('CREATE DATABASE {0};'.format(db)) + cur.execute('CREATE DATABASE {0};'.format(db_name)) cur.close() conn.close() -def drop_postgresql_database(user, host, port, db, version): +def drop_postgresql_database(user, host, port, db_name, version): """ Drop databse in postgresql. :param str user: postgresql username :param str host: postgresql host :param str port: postgresql port - :param str db: database name + :param str db_name: database name :param str version: postgresql version number """ conn = psycopg2.connect(user=user, host=host, port=port) conn.set_isolation_level(psycopg2.extensions.ISOLATION_LEVEL_AUTOCOMMIT) cur = conn.cursor() # We cannot drop the database while there are connections to it, so we # terminate all connections first while not allowing new connections. if float(version) >= 9.2: pid_column = 'pid' else: pid_column = 'procpid' cur.execute( 'UPDATE pg_database SET datallowconn=false WHERE datname = %s;', - (db,)) + (db_name,)) cur.execute( 'SELECT pg_terminate_backend(pg_stat_activity.{0})' 'FROM pg_stat_activity WHERE pg_stat_activity.datname = %s;'.format( pid_column), - (db,)) - cur.execute('DROP DATABASE IF EXISTS {0};'.format(db)) + (db_name,)) + cur.execute('DROP DATABASE IF EXISTS {0};'.format(db_name)) cur.close() conn.close() def postgresql_proc( - executable=None, host=None, port=-1, user=None, + executable=None, host=None, port=-1, user=None, options='', startparams=None, unixsocketdir=None, logsdir=None, logs_prefix='', ): """ Postgresql process factory. :param str executable: path to postgresql_ctl :param str host: hostname :param str|int|tuple|set|list port: exact port (e.g. '8000', 8000) randomly selected port (None) - any random available port -1 - command line or pytest.ini configured port [(2000,3000)] or (2000,3000) - random available port from a given range [{4002,4003}] or {4002,4003} - random of 4002 or 4003 ports [(2000,3000), {4002,4003}] - random of given range and set :param str user: postgresql username :param str startparams: postgresql starting parameters :param str unixsocketdir: directory to create postgresql's unixsockets :param str logsdir: location for logs :param str logs_prefix: prefix for log filename :rtype: func :returns: function which makes a postgresql process """ @pytest.fixture(scope='session') def postgresql_proc_fixture(request): """ Process fixture for PostgreSQL. :param FixtureRequest request: fixture request object :rtype: pytest_dbfixtures.executors.TCPExecutor :returns: tcp executor """ config = get_config(request) postgresql_ctl = executable or config['exec'] # check if that executable exists, as it's no on system PATH # only replace if executable isn't passed manually if not os.path.exists(postgresql_ctl) and executable is None: pg_bindir = subprocess.check_output( ['pg_config', '--bindir'], universal_newlines=True ).strip() postgresql_ctl = os.path.join(pg_bindir, 'pg_ctl') pg_host = host or config['host'] pg_port = get_port(port) or get_port(config['port']) datadir = os.path.join( gettempdir(), 'postgresqldata.{0}'.format(pg_port)) pg_user = user or config['user'] + pg_options = options or config['options'] pg_unixsocketdir = unixsocketdir or config['unixsocketdir'] pg_startparams = startparams or config['startparams'] pg_logsdir = logsdir or config['logsdir'] logfile_path = os.path.join( pg_logsdir, '{prefix}postgresql.{port}.log'.format( prefix=logs_prefix, port=pg_port )) init_postgresql_directory( postgresql_ctl, pg_user, datadir ) - if 'FreeBSD' == platform.system(): - with (datadir / 'pg_hba.conf').open(mode='a') as f: - f.write('host all all 0.0.0.0/0 trust\n') + if platform.system() == 'FreeBSD': + with (datadir / 'pg_hba.conf').open(mode='a') as conf_file: + conf_file.write('host all all 0.0.0.0/0 trust\n') postgresql_executor = PostgreSQLExecutor( executable=postgresql_ctl, host=pg_host, port=pg_port, user=pg_user, + options=pg_options, datadir=datadir, unixsocketdir=pg_unixsocketdir, logfile=logfile_path, startparams=pg_startparams, ) # start server with postgresql_executor: if '-w' in pg_startparams: wait_for_postgres(logfile_path, START_INFO) yield postgresql_executor remove_postgresql_directory(datadir) return postgresql_proc_fixture -def postgresql(process_fixture_name, db='tests'): +def postgresql(process_fixture_name, db_name='tests'): """ Return connection fixture factory for PostgreSQL. :param str process_fixture_name: name of the process fixture - :param str db: database name + :param str db_name: database name :rtype: func :returns: function which makes a connection to postgresql """ @pytest.fixture def postgresql_factory(request): """ Fixture factory for PostgreSQL. :param FixtureRequest request: fixture request object :rtype: psycopg2.connection :returns: postgresql client """ + if not psycopg2: + raise ImportError( + 'No module named psycopg2. Please install either ' + 'psycopg2 or psycopg2-binary package for CPython ' + 'or psycopg2cffi for Pypy.' + ) proc_fixture = request.getfixturevalue(process_fixture_name) # _, config = try_import('psycopg2', request) pg_host = proc_fixture.host pg_port = proc_fixture.port pg_user = proc_fixture.user - pg_db = db + pg_options = proc_fixture.options + pg_db = db_name - init_postgresql_database( - pg_user, pg_host, pg_port, pg_db - ) + init_postgresql_database(pg_user, pg_host, pg_port, pg_db) connection = psycopg2.connect( dbname=pg_db, user=pg_user, host=pg_host, - port=pg_port + port=pg_port, + options=pg_options ) def drop_database(): connection.close() drop_postgresql_database( - pg_user, pg_host, pg_port, pg_db, - proc_fixture.version + pg_user, pg_host, pg_port, pg_db, proc_fixture.version ) request.addfinalizer(drop_database) return connection return postgresql_factory __all__ = ('postgresql', 'postgresql_proc') diff --git a/src/pytest_postgresql/plugin.py b/src/pytest_postgresql/plugin.py index 32b04cd..a473e5b 100644 --- a/src/pytest_postgresql/plugin.py +++ b/src/pytest_postgresql/plugin.py @@ -1,143 +1,158 @@ # Copyright (C) 2016 by Clearcode # and associates (see AUTHORS). # This file is part of pytest-postgresql. # pytest-dbfixtures is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # pytest-postgresql 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 Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public License # along with pytest-postgresql. If not, see . """Plugin module of pytest-postgresql.""" from tempfile import gettempdir from pytest_postgresql import factories +# pylint:disable=invalid-name _help_executable = 'Path to PostgreSQL executable' _help_host = 'Host at which PostgreSQL will accept connections' _help_port = 'Port at which PostgreSQL will accept connections' _help_user = "PostgreSQL username" +_help_options = "PostgreSQL connection options" _help_startparams = "Starting parameters for the PostgreSQL" _help_logsdir = "Logs directory location" _help_logsprefix = "Prefix for the log files" _help_unixsocketdir = "Location of the socket directory" def pytest_addoption(parser): """Configure options for pytest-postgresql.""" parser.addini( name='postgresql_exec', help=_help_executable, default='/usr/lib/postgresql/9.1/bin/pg_ctl' ) parser.addini( name='postgresql_host', help=_help_host, default='127.0.0.1' ) parser.addini( name='postgresql_port', help=_help_port, default=None, ) parser.addini( name='postgresql_user', help=_help_user, default='postgres' ) + parser.addini( + name='postgresql_options', + help=_help_options, + default='' + ) + parser.addini( name='postgresql_startparams', help=_help_startparams, default='-w' ) parser.addini( name='postgresql_logsdir', help=_help_logsdir, default=gettempdir() ) parser.addini( name='postgresql_logsprefix', help=_help_logsprefix, default='' ) parser.addini( name='postgresql_unixsocketdir', help=_help_unixsocketdir, default=gettempdir() ) parser.addoption( '--postgresql-exec', action='store', metavar='path', dest='postgresql_exec', help=_help_executable ) parser.addoption( '--postgresql-host', action='store', dest='postgresql_host', help=_help_host, ) parser.addoption( '--postgresql-port', action='store', dest='postgresql_port', help=_help_port ) parser.addoption( '--postgresql-user', action='store', dest='postgresql_user', help=_help_user ) + parser.addoption( + '--postgresql-options', + action='store', + dest='postgresql_options', + help=_help_options + ) + parser.addoption( '--postgresql-startparams', action='store', dest='postgresql_startparams', help=_help_startparams ) parser.addoption( '--postgresql-logsdir', action='store', dest='postgresql_logsdir', help=_help_logsdir ) parser.addoption( '--postgresql-logsprefix', action='store', dest='postgresql_logsprefix', help=_help_logsprefix ) parser.addoption( '--postgresql-unixsocketdir', action='store', dest='postgresql_unixsocketdir', help=_help_unixsocketdir ) postgresql_proc = factories.postgresql_proc() postgresql = factories.postgresql('postgresql_proc') diff --git a/src/pytest_postgresql/port.py b/src/pytest_postgresql/port.py index e8a43db..2ee0464 100644 --- a/src/pytest_postgresql/port.py +++ b/src/pytest_postgresql/port.py @@ -1,88 +1,85 @@ # Copyright (C) 2016 by Clearcode # and associates (see AUTHORS). # This file is part of pytest-postgresql. # pytest-postgresql is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # pytest-postgresql 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 Lesser General Public License for more details. # You should have received a copy of the GNU Lesser General Public License # along with pytest-postgresql. If not, see . """Helpers for port-for package.""" from itertools import chain import port_for class InvalidPortsDefinition(ValueError): """Exception raised if ports definition is not a valid string.""" def __init__(self, ports): """Construct InvalidPortsDefinition exception.""" - self.ports = ports - - def __str__(self): - """Return string representation.""" - return ( - 'Unknown format of ports: {0}.\n' - 'You should provide a ports range "[(4000,5000)]"' - 'or "(4000,5000)" or a comma-separated ports set' - '"[{4000,5000,6000}]" or list of ints "[400,5000,6000,8000]"' - 'or all of them "[(20000, 30000), {48889, 50121}, 4000, 4004]"' - ).format(self.ports) + super(InvalidPortsDefinition, self).__init__( + 'Unknown format of ports: {0}.\n'.format(ports) + ( + 'You should provide a ports range "[(4000,5000)]"' + 'or "(4000,5000)" or a comma-separated ports set' + '"[{4000,5000,6000}]" or list of ints "[400,5000,6000,8000]"' + 'or all of them "[(20000, 30000), {48889, 50121}, 4000, 4004]"' + ) + ) def get_port(ports): """ Retun a random available port. If there's only one port passed (e.g. 5000 or '5000') function does not check if port is available. it there's -1 passed as an argument, function returns None. When a range or list of ports is passed `port_for` external package is used in order to find a free port. :param str|int|tuple|set|list port: exact port (e.g. '8000', 8000) randomly selected port (None) - any random available port [(2000,3000)] or (2000,3000) - random available port from a given range [{4002,4003}] or {4002,4003} - random of 4002 or 4003 ports [(2000,3000), {4002,4003}] -random of given orange and set :returns: a random free port :raises: ValueError """ if ports == -1: return None - elif not ports: + if not ports: return port_for.select_random(None) try: return int(ports) except TypeError: pass ports_set = set() try: if not isinstance(ports, list): ports = [ports] ranges = port_for.utils.ranges_to_set(filter_by_type(ports, tuple)) nums = set(filter_by_type(ports, int)) sets = set(chain(*filter_by_type(ports, (set, frozenset)))) ports_set = ports_set.union(ranges, sets, nums) except ValueError: raise InvalidPortsDefinition return port_for.select_random(ports_set) def filter_by_type(lst, type_of): """Return a list of elements with given type.""" return [e for e in lst if isinstance(e, type_of)] diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..3177959 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1 @@ +"""Main test module.""" diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..1c00ae2 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,27 @@ +"""Tests main conftest file.""" +import sys +import warnings + +from pytest_postgresql import factories + +if not sys.version_info >= (3, 5): + warnings.simplefilter("error", category=DeprecationWarning) + + +PG_CTL = '/usr/lib/postgresql/{ver}/bin/pg_ctl' + +# pylint:disable=invalid-name +postgresql92 = factories.postgresql_proc(PG_CTL.format(ver='9.2'), port=None) +postgresql93 = factories.postgresql_proc(PG_CTL.format(ver='9.3'), port=None) +postgresql94 = factories.postgresql_proc(PG_CTL.format(ver='9.4'), port=None) +postgresql95 = factories.postgresql_proc(PG_CTL.format(ver='9.5'), port=None) +postgresql96 = factories.postgresql_proc(PG_CTL.format(ver='9.6'), port=None) +postgresql10 = factories.postgresql_proc(PG_CTL.format(ver='10'), port=None) +postgresql101 = factories.postgresql_proc(PG_CTL.format(ver='10.1'), port=None) + +postgresql_proc2 = factories.postgresql_proc(port=9876) +postgresql2 = factories.postgresql('postgresql_proc2') + +postgresql_rand_proc = factories.postgresql_proc(port=None) +postgresql_rand = factories.postgresql('postgresql_rand_proc') +# pylint:enable=invalid-name diff --git a/tests/test_postgresql.py b/tests/test_postgresql.py new file mode 100644 index 0000000..4086a8a --- /dev/null +++ b/tests/test_postgresql.py @@ -0,0 +1,59 @@ +"""All tests for pytest-postgresql.""" +import psycopg2 +import pytest + + +QUERY = "CREATE TABLE test (id serial PRIMARY KEY, num integer, data varchar);" + + +@pytest.mark.parametrize('postgres', ( + 'postgresql94', + 'postgresql95', + 'postgresql96', + 'postgresql10', + pytest.param('postgresql11', marks=pytest.mark.xfail), +)) +def test_postgresql_proc(request, postgres): + """Test different postgresql versions.""" + postgresql_proc = request.getfixturevalue(postgres) + assert postgresql_proc.running() is True + + +def test_main_postgres(postgresql): + """Check main postgresql fixture.""" + cur = postgresql.cursor() + cur.execute(QUERY) + postgresql.commit() + cur.close() + + +def test_two_postgreses(postgresql, postgresql2): + """Check two postgresql fixtures on one test.""" + cur = postgresql.cursor() + cur.execute(QUERY) + postgresql.commit() + cur.close() + + cur = postgresql2.cursor() + cur.execute(QUERY) + postgresql2.commit() + cur.close() + + +def test_rand_postgres_port(postgresql_rand): + """Check if postgres fixture can be started on random port.""" + assert postgresql_rand.status == psycopg2.extensions.STATUS_READY + + +@pytest.mark.parametrize('_', range(2)) +def test_postgres_terminate_connection( + postgresql, _): + """ + Test that connections are terminated between tests. + + And check that only one exists at a time. + """ + cur = postgresql.cursor() + cur.execute('SELECT * FROM pg_stat_activity;') + assert len(cur.fetchall()) == 1, 'there is always only one connection' + cur.close() diff --git a/tests/test_version.py b/tests/test_version.py new file mode 100644 index 0000000..0459b4c --- /dev/null +++ b/tests/test_version.py @@ -0,0 +1,17 @@ +"""Auxiliary tests.""" +import pytest + +from pytest_postgresql.executor import PostgreSQLExecutor + + +@pytest.mark.parametrize('ctl_input, version', ( + ('pg_ctl (PostgreSQL) 9.6.6', '9.6'), + ('pg_ctl (PostgreSQL) 9.5', '9.5'), + ('pg_ctl (PostgreSQL) 9.4.1', '9.4'), + ('pg_ctl (PostgreSQL) 10.0', '10.0'), + ('pg_ctl (PostgreSQL) 10.1', '10.1'), +)) +def test_versions(ctl_input, version): + """Check correctness of the version regexp.""" + match = PostgreSQLExecutor.VERSION_RE.search(ctl_input) + assert match.groupdict()['version'] == version