diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..e81838d --- /dev/null +++ b/.coveragerc @@ -0,0 +1,9 @@ +[run] +concurrency = eventlet +branch = 1 +source = + pytest_eventlet + tests +[report] +show_missing = true +fail_under = 100 diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..faf18bb --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,86 @@ +on: + push: + branches: + - "**" + tags: + - "v*" + pull_request: + branches: + - main + + workflow_dispatch: + +jobs: + static: + runs-on: ubuntu-latest + steps: + - name: checkout + uses: actions/checkout@v2 + + - name: setup python + uses: actions/setup-python@v2 + with: + python-version: 3.9 + + - name: install test dependencies + run: | + python -m pip install --upgrade pip + pip install tox + + - name: run tox + run: tox + env: + TOXENV: static + + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: + - 3.9 + + steps: + - name: checkout + uses: actions/checkout@v2 + + - name: setup python + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + + - name: install test dependencies + run: | + python -m pip install --upgrade pip + pip install tox + + - name: run tox + run: tox + env: + TOXENV: py${{ matrix.python-version }}-test + + distribute: + runs-on: ubuntu-latest + needs: + - static + - test + if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') + + steps: + - name: checkout + uses: actions/checkout@v2 + + - name: setup python + uses: actions/setup-python@v2 + with: + python-version: 3.9 + + - name: generate distributables + run: | + pip install wheel + python setup.py sdist bdist_wheel + + - name: publish to pypi + uses: pypa/gh-action-pypi-publish@release/v1 + with: + user: __token__ + password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9c65ce5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +__pycache__ +*.egg-info +.tox +.coverage +.pytest_cache diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..faed9cd --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,23 @@ +repos: +- repo: git://github.com/pre-commit/pre-commit-hooks + rev: v1.3.0 + hooks: + - id: trailing-whitespace + - id: check-ast + - id: check-merge-conflict + - id: fix-encoding-pragma + - id: flake8 + - id: end-of-file-fixer +- repo: https://github.com/pycqa/isort + rev: 5.6.3 + hooks: + - id: isort +- repo: https://github.com/ambv/black + rev: 19.10b0 + hooks: + - id: black +- repo: https://github.com/adrienverge/yamllint.git + rev: v1.25.0 + hooks: + - id: yamllint + args: ["-d", "relaxed"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..a206c08 --- /dev/null +++ b/Makefile @@ -0,0 +1,9 @@ +static: + pre-commit run --all-files + +test: + pytest tests.py -v + +coverage: + coverage run -m pytest tests.py -v + coverage report diff --git a/README.md b/README.md index 180bbbd..2598453 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,4 @@ A pytest plugin that applies the eventlet monkey patch. -This plugin registers itself using a setuptools entrypoint. \ No newline at end of file +This plugin registers itself using a setuptools entrypoint. diff --git a/pytest_eventlet/__init__.py b/pytest_eventlet/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/pytest_eventlet/plugin.py b/pytest_eventlet/plugin.py new file mode 100644 index 0000000..7065952 --- /dev/null +++ b/pytest_eventlet/plugin.py @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +def pytest_load_initial_conftests(): + # make sure we monkey_patch before local conftests + import eventlet + + eventlet.monkey_patch() diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..7b43486 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,20 @@ +[bdist_wheel] +universal = 1 + +[flake8] +exclude = + .git, + .tox, + __pycache__, +max-line-length = 88 +[isort] +line_length=88 +known_first_party=pytest_eventlet +known_standard_library= +indent=' ' +multi_line_output=3 +include_trailing_comma=true +forced_separate= +default_section=THIRDPARTY +lines_after_imports=2 +skip=.tox,.git diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..87ae44a --- /dev/null +++ b/setup.py @@ -0,0 +1,19 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +from setuptools import find_packages, setup + + +setup( + name="pytest-eventlet", + description="Applies eventlet monkey-patch as a pytest plugin.", + version="1.0.0", + author="Nameko Authors", + url="https://github.com/nameko/pytest-eventlet", + packages=find_packages(exclude=["test", "tests", "tests.*"]), + install_requires=["eventlet"], + extras_require={"dev": ["coverage", "pytest"]}, + dependency_links=[], + entry_points={"pytest11": ["pytest_eventlet=pytest_eventlet.plugin"]}, + zip_safe=True, + license="Apache License, Version 2.0", +) diff --git a/tests.py b/tests.py new file mode 100644 index 0000000..e06c412 --- /dev/null +++ b/tests.py @@ -0,0 +1,20 @@ +# -*- coding: utf-8 -*- +pytest_plugins = "pytester" + + +def test_patched(testdir): + + testdir.makepyfile( + """ + import eventlet + + def test_patched(): + assert eventlet.patcher.is_monkey_patched("socket") + assert eventlet.patcher.is_monkey_patched("os") + assert eventlet.patcher.is_monkey_patched("select") + assert eventlet.patcher.is_monkey_patched("thread") + assert eventlet.patcher.is_monkey_patched("time") + """ + ) + result = testdir.runpytest() + assert result.ret == 0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..e7d4675 --- /dev/null +++ b/tox.ini @@ -0,0 +1,13 @@ +[tox] +envlist = static, py3.9-test +skipsdist = True + +[testenv] +allowlist_externals = make + +commands = + static: pip install pre-commit + static: make static + + test: pip install --editable .[dev] + test: make coverage