pax_global_header00006660000000000000000000000064145761073510014523gustar00rootroot0000000000000052 comment=2a5f0e498dca6ad9f939d8429d9bfac14dc5b79e python-flaky-3.8.1/000077500000000000000000000000001457610735100141615ustar00rootroot00000000000000python-flaky-3.8.1/.coveragerc000066400000000000000000000002661457610735100163060ustar00rootroot00000000000000[run] # Whether to measure branch coverage in addition to statement coverage. branch = True # List of packages or directories, the source to measure during execution. source = flaky python-flaky-3.8.1/.github/000077500000000000000000000000001457610735100155215ustar00rootroot00000000000000python-flaky-3.8.1/.github/workflows/000077500000000000000000000000001457610735100175565ustar00rootroot00000000000000python-flaky-3.8.1/.github/workflows/tox.yml000066400000000000000000000023241457610735100211140ustar00rootroot00000000000000name: tox on: [push, pull_request] jobs: tox-jobs: strategy: fail-fast: false matrix: job: [coverage, pycodestyle, pylint, readme] runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - uses: actions/setup-python@v4 with: python-version: 3.x cache: 'pip' # Only use if there are requirements.txt files - run: pip install --upgrade pip - run: pip install tox - run: tox -e ${{ matrix.job }} # TODO: Add coveralls token #- if: matrix.job == 'coverage' # run: | # pip install coveralls # coveralls tox: strategy: fail-fast: false # max-parallel: 4 matrix: os: [ubuntu-latest] # [macos-latest, ubuntu-latest, windows-latest] python: ['3.8', '3.9', '3.10', '3.11', 'pypy3.10'] runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v3 - uses: actions/setup-python@v4 with: python-version: ${{ matrix.python }} cache: 'pip' # Only use if there are requirements.txt files - run: python3 --version && python --version - run: pip install --upgrade pip - run: pip install tox - run: tox -e py python-flaky-3.8.1/.gitignore000066400000000000000000000005041457610735100161500ustar00rootroot00000000000000*.py[cod] # C extensions *.so # Packages *.egg *.egg-info dist build eggs parts bin var sdist develop-eggs .installed.cfg lib lib64 # Installer logs pip-log.txt # Unit test / coverage reports .coverage .tox # Translations *.mo # IntelliJ .idea/codeStyleSettings.xml .idea/misc.xml .idea/tasks.xml .idea/workspace.xml python-flaky-3.8.1/.idea/000077500000000000000000000000001457610735100151415ustar00rootroot00000000000000python-flaky-3.8.1/.idea/.name000066400000000000000000000000051457610735100160550ustar00rootroot00000000000000flakypython-flaky-3.8.1/.idea/compiler.xml000066400000000000000000000013731457610735100175010ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/copyright/000077500000000000000000000000001457610735100171515ustar00rootroot00000000000000python-flaky-3.8.1/.idea/copyright/profiles_settings.xml000066400000000000000000000001571457610735100234410ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/encodings.xml000066400000000000000000000002461457610735100176360ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/inspectionProfiles/000077500000000000000000000000001457610735100210205ustar00rootroot00000000000000python-flaky-3.8.1/.idea/inspectionProfiles/Project_Default.xml000066400000000000000000000034341457610735100246200ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/inspectionProfiles/profiles_settings.xml000066400000000000000000000003531457610735100253060ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/modules.xml000066400000000000000000000003741457610735100173370ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/other.xml000066400000000000000000000002731457610735100170060ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/scopes/000077500000000000000000000000001457610735100164355ustar00rootroot00000000000000python-flaky-3.8.1/.idea/scopes/scope_settings.xml000066400000000000000000000002131457610735100222040ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/testrunner.xml000066400000000000000000000003701457610735100200740ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/uiDesigner.xml000066400000000000000000000211321457610735100177600ustar00rootroot00000000000000 python-flaky-3.8.1/.idea/vcs.xml000066400000000000000000000003321457610735100164540ustar00rootroot00000000000000 python-flaky-3.8.1/.pylintrc000066400000000000000000000173531457610735100160370ustar00rootroot00000000000000[MASTER] # Specify a configuration file. #rcfile= # Python code to execute, usually for sys.path manipulation such as # pygtk.require(). #init-hook= # Add files or directories to the blacklist. They should be base names, not # paths. #ignore=CVS # Pickle collected data for later comparisons. #persistent=yes # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. load-plugins=pylint.extensions.no_self_use [MESSAGES CONTROL] # 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. See also the "--disable" option for examples. #enable= # 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" # C0111 => Missing docstring # W0108 => unnecessary lambda # R0205 => Useless object inheritence: codebase still supports 2.7 disable=I, C0111, W0108, R0205 [REPORTS] # Set the output format. Available formats are text, parseable, colorized, msvs # (visual studio) and html. You can also give a reporter class, eg # mypackage.mymodule.MyReporterClass. output-format=text # Put messages in a separate file for each module / package specified on the # command line instead of printing them on stdout. Reports (if any) will be # written in a file name "pylint_global.[txt|html]". # files-output=no # Tells whether to display a full report or only the messages reports=no # 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 massage information. See doc for all details msg-template={module}:{line}:{column}: [{msg_id}({symbol}), {obj}] {msg} [BASIC] # List of builtins function names that should not be used, separated by a comma # bad-functions=map,filter,apply,input # Regular expression which should only match correct module names module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ # Regular expression which should only match correct module level names const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # Regular expression which should only match correct class names class-rgx=[A-Z_][a-zA-Z0-9]+$ # Regular expression which should only match correct function names function-rgx=[a-z_][a-z0-9_]{2,60}$ # Regular expression which should only match correct method names method-rgx=[a-z_][a-z0-9_]{2,60}$ # Regular expression which should only match correct instance attribute names attr-rgx=[a-z_][a-z0-9_]{2,30}$ # Regular expression which should only match correct argument names argument-rgx=[a-z_][a-z0-9_]{2,30}$ # Regular expression which should only match correct variable names variable-rgx=[a-z_][a-z0-9_]{2,30}$ # Regular expression which should only match correct attribute names in class # bodies class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ # Regular expression which should only match correct list comprehension / # generator expression variable names inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ # Good variable names which should always be accepted, separated by a comma good-names=i,j,k,ex,Run,_ # Bad variable names which should always be refused, separated by a comma bad-names=foo,bar,baz,toto,tutu,tata # Regular expression which should only match function or class names that do # not require a docstring. no-docstring-rgx=__.*__ # Minimum line length for functions/classes that require docstrings, shorter # ones are exempt. docstring-min-length=-1 [FORMAT] # Maximum number of characters on a single line. max-line-length=120 # Regexp for a line that is allowed to be longer than the limit. ignore-long-lines=^\s*(# )??$ # Maximum number of lines in a module max-module-lines=1000 # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 # tab). indent-string=' ' [MISCELLANEOUS] # List of note tags to take in consideration, separated by a comma. notes=TODO [SIMILARITIES] # Minimum lines number of a similarity. min-similarity-lines=4 # Ignore comments when computing similarities. ignore-comments=yes # Ignore docstrings when computing similarities. ignore-docstrings=yes # Ignore imports when computing similarities. ignore-imports=no [TYPECHECK] # 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 # List of classes names for which member attributes should not be checked # (useful for classes with attributes dynamically set). #ignored-classes=SQLObject ignored-classes=pytest, _pytest # List of members which are set dynamically and missed by pylint inference # system, and so shouldn't trigger E0201 when accessed. Python regular # expressions are accepted. generated-members=REQUEST,acl_users,aq_parent [VARIABLES] # Tells whether we should check for unused import in __init__ files. init-import=no # A regular expression matching the beginning of the name of dummy variables # (i.e. not used). dummy-variables-rgx=_$|dummy # List of additional names supposed to be defined in builtins. Remember that # you should avoid to define new builtins when possible. additional-builtins= [CLASSES] # List of method names used to declare (i.e. assign) instance attributes. defining-attr-methods=__init__,__new__,setUp # 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=mcs [DESIGN] # Maximum number of arguments for function / method max-args=15 # Argument names that match this expression will be ignored. Default to name # with leading underscore ignored-argument-names=_.* # Maximum number of locals for function / method body max-locals=20 # Maximum number of return / yield for function / method body max-returns=6 # Maximum number of branch for function / method body max-branches=12 # Maximum number of statements in function / method body max-statements=50 # Maximum number of parents for a class (see R0901). max-parents=7 # Maximum number of attributes for a class (see R0902). max-attributes=15 # Minimum number of public methods for a class (see R0903). min-public-methods=0 # Maximum number of public methods for a class (see R0904). max-public-methods=100 [IMPORTS] # Deprecated modules which should not be used, separated by a comma deprecated-modules= # 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 external dependencies in the given file (report RP0402 must # not be disabled) ext-import-graph= # Create a graph of internal dependencies in the given file (report RP0402 must # not be disabled) int-import-graph= [EXCEPTIONS] # Exceptions that will emit a warning when being caught. Defaults to # "Exception" overgeneral-exceptions=builtins.Exception python-flaky-3.8.1/AUTHORS.rst000066400000000000000000000005271457610735100160440ustar00rootroot00000000000000Flaky is an open source project supported by `Box `_ that was born out of our testing framework. This is a list of contributors. - `@Jeff-Meadows `_ - `@benpatterson `_ - `@amygdalama `_ - `@hugovk `_ python-flaky-3.8.1/CONTRIBUTING.rst000066400000000000000000000064461457610735100166340ustar00rootroot00000000000000Contributing ============ All contributions are welcome to this project. Contributor License Agreement ----------------------------- Before a contribution can be merged into this project, please fill out the Contributor License Agreement (CLA) located at:: https://opensource.box.com/cla To learn more about CLAs and why they are important to open source projects, please see the `Wikipedia entry `_. How to contribute ----------------- - **File an issue** - if you found a bug, want to request an enhancement, or want to implement something (bug fix or feature). - **Send a pull request** - if you want to contribute code. Please be sure to file an issue first. Pull request best practices --------------------------- We want to accept your pull requests. Please follow these steps: Step 1: File an issue ~~~~~~~~~~~~~~~~~~~~~ Before writing any code, please file an issue stating the problem you want to solve or the feature you want to implement. This allows us to give you feedback before you spend any time writing code. There may be a known limitation that can't be addressed, or a bug that has already been fixed in a different way. The issue allows us to communicate and figure out if it's worth your time to write a bunch of code for the project. Step 2: Fork this repository in GitHub ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This will create your own copy of our repository. Step 3: Add the upstream source ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The upstream source is the project under the Box organization on GitHub. To add an upstream source for this project, type: .. code-block:: console git remote add upstream git@github.com:box/flaky.git This will come in useful later. Step 4: Create a feature branch ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Create a branch with a descriptive name, such as ``add-search``. Step 5: Push your feature branch to your fork ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ As you develop code, continue to push code to your remote feature branch. Please make sure to include the issue number you're addressing in your commit message, such as: .. code-block:: console git commit -am "Adding search (fixes #123)" This helps us out by allowing us to track which issue your commit relates to. Keep a separate feature branch for each issue you want to address. Step 6: Rebase ~~~~~~~~~~~~~~ Before sending a pull request, rebase against upstream, such as: .. code-block:: console git fetch upstream git rebase upstream/master This will add your changes on top of what's already in upstream, minimizing merge issues. Step 7: Run the tests ~~~~~~~~~~~~~~~~~~~~~ Make sure that all tests are passing before submitting a pull request. Step 8: Send the pull request ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Send the pull request from your feature branch to us. Be sure to include a description that lets us know what work you did. Keep in mind that we like to see one issue addressed per pull request, as this helps keep our git history clean and we can more easily track down issues. Finally, please add a note in HISTORY.rst under the Upcoming section detailing what's new in your change. These will become the release notes for the next release. In addition, feel free to add yourself to AUTHORS.rst if you aren't already listed. python-flaky-3.8.1/HISTORY.rst000066400000000000000000000135541457610735100160640ustar00rootroot00000000000000.. :changelog: Release History --------------- Upcoming ++++++++ 3.8.0 (2024-03-10) ++++++++++++++++++ - nose support has been removed. - Python 3.12 supported. - Bugfixes 3.7.0 (2020-07-07) ++++++++++++++++++ - Flaky now retries tests which fail during setup. 3.6.1 (2019-08-06) ++++++++++++++++++ **Bugfixes** - Reraise ``KeyboardInterrupt`` when running tests under pytest. 3.6.0 (2019-06-25) ++++++++++++++++++ - Do not print an empty report if no tests marked 'flaky' were run at all (#116). NOTE: This change could be breaking if you relied on the flaky report being printed. 3.5.3 (2019-01-16) ++++++++++++++++++ - Add rerun_filter parameter to _make_test_flaky 3.5.2 (2019-01-10) ++++++++++++++++++ **Bugfixes** - Fall back to old pytest marker API for older pytest version (``get_marker`` vs ``iter_markers``). 3.5.1 (2019-01-09) ++++++++++++++++++ - Officially support and test on Python 3.6 and 3.7. - Adds a pytest marker that can be used instead of ```@flaky``. - Replaced references to 'slaveoutput', where possible with 'workeroutput', following the convention chosen by pytest. - Prints formatted tracebacks in the flaky report when using nose. **Bugfixes** - Ensure that tests are only reported as successful to the nose runner once. 3.5.0 (2019-01-07) ++++++++++++++++++ - Updated references to pytest instead of py.test. **Bugfixes** - Flaky is now compatible with pytest >= 4.1. 3.4.0 (2017-06-15) ++++++++++++++++++ **Bugfixes** - Flaky for pytest will no longer silently swallow errors that occur during test setup. 3.3.0 (2016-07-28) ++++++++++++++++++ - Flaky for Nose will now rerun tests using the ``afterTest`` plugin hook, rather than the ``stopTest`` hook. The ``afterTest`` hook is called slightly later in the test run process; this change allows flaky to be used with `TestCase` subclasses that override the test run process, and do teardown after ``stopTest`` is called. In particular, this means that flaky is now compatible with Django's ``LiveServerTestCase``. 3.2.0 (2016-07-21) ++++++++++++++++++ - Flaky will completely suppress the flaky report if ``--no-success-flaky-report`` is specified and no tests needed to be rerun. **Bugfixes** - Flaky will no longer cause ``py.test --pep8`` to fail. 3.1.0 (2016-22-11) ++++++++++++++++++ - Flaky's automated tests now include a run with the ``pytest-xdist`` plugin enabled. - Flaky for pytest has slightly changed how it patches the runner. This simplifies the plugin code a bit, but, more importantly, avoids reporting test retries until flaky is done with them. This *should* improve compatibility with other plugins. 3.0.2 (2015-12-21) ++++++++++++++++++ **Bugfixes** - Flaky for pytest no longer passes None for the first 2 arguments to the optional ``rerun_filter``. 3.0.1 (2015-12-16) ++++++++++++++++++ **Bugfixes** - Flaky for pytest no longer causes errors with the pytester plugin. 3.0.0 (2015-12-14) ++++++++++++++++++ - Flaky for pytest now reruns test setup and teardown. **This is a possibly breaking change.** **Bugfixes** - Bug with nose and multiprocess fixed. 2.4.0 (2015-10-27) ++++++++++++++++++ **Bugfixes** - The flaky report is now available under nose with the multiprocessing plugin. 2.3.0 (2015-10-15) ++++++++++++++++++ - Added support and testing for Python 3.5 - Fixed tests on Python 2.6 with latest version of py.test **Bugfixes** - Flaky will no longer swallow exceptions raised during pytest fixture setup. This change is correct, but is a change in behavior. 2.2.0 (2015-08-28) ++++++++++++++++++ - The `@flaky` decorator now accepts a `rerun_filter` parameter. This allows for failing certain types of failures/errors immediately instead of rerunning. - Flaky now accepts a command line option, `--no-success-flaky-report`. When that option is present, flaky won't add information about test successes to the flaky report. 2.1.2 (2015-07-30) ++++++++++++++++++ **Bugfixes** - Flaky will no longer raise a UnicodeEncodeError for flaky tests which raise exceptions with non-ascii characters. - Flaky will no longer cause nose to report non-flaky test failures and errors twice. - Flaky now works with tests that are parametrized with py.test. 2.1.1 (2015-05-22) ++++++++++++++++++ **Bugfixes** - Flaky will no longer raise a KeyError for failed flaky tests. 2.1.0 (2015-05-05) ++++++++++++++++++ **Bugfixes** - Flaky for nose now reruns failed tests *after* calling the `tearDown()` method. This change is correct, but is a change in behavior. 2.0.4 (2015-04-20) ++++++++++++++++++ **Bugfixes** - Flaky now copies flaky attributes to collected tests, rather than modifying them on the test declaration. This means that tests collected from classes that inherit tests marked flaky (from a base class) will now work correctly. - Running py.test with doctests will no longer cause the doctests to fail. Doctests cannot, however, be marked flaky. - Tests marked flaky will now be correctly rerun from pytest when using the pytest-xdist option. However, they will not be run if the `--boxed` option is used due to a technical limitation. **Documentation updates** - Updated documentation to correctly specify how to suppress the flaky report under py.test. 2.0.3 (2015-03-20) ++++++++++++++++++ **Bugfixes** - Tests marked flaky that are part of a class inheriting from `unittest.TestCase` will now be rerun when they fail under py.test. 2.0.0 (2015-03-01) ++++++++++++++++++ **Bugfixes** - Tests marked flaky that fail after exhausting reruns will now be reported to the nose test runner. This is a *breaking* change, because the exit code of the nose test runner will indicate failure in this case. - Tests marked flaky will now be marked as failures after they have failed ``max_runs - min_passes + 1`` times. This is a *breaking* change as well, because a bug in previous versions was allowing tests with ``min_passes > 0`` to run more than ``max_runs`` times. python-flaky-3.8.1/LICENSE000066400000000000000000000225461457610735100151770ustar00rootroot00000000000000 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 python-flaky-3.8.1/MANIFEST.in000066400000000000000000000001231457610735100157130ustar00rootroot00000000000000include README.rst LICENSE recursive-include test test*.py __init__.py conftest.py python-flaky-3.8.1/README.rst000066400000000000000000000137631457610735100156620ustar00rootroot00000000000000flaky ===== .. image:: http://opensource.box.com/badges/stable.svg :target: http://opensource.box.com/badges .. image:: https://github.com/box/flaky/actions/workflows/tox.yml/badge.svg?branch=master&event=push :target: https://github.com/box/flaky/actions/workflows/tox.yml .. image:: https://img.shields.io/pypi/v/flaky.svg :target: https://pypi.python.org/pypi/flaky About ----- Flaky is a plugin for pytest that automatically reruns flaky tests. Ideally, tests reliably pass or fail, but sometimes test fixtures must rely on components that aren't 100% reliable. With flaky, instead of removing those tests or marking them to @skip, they can be automatically retried. For more information about flaky, see `this presentation `_. Marking tests flaky ~~~~~~~~~~~~~~~~~~~ To mark a test as flaky, simply import flaky and decorate the test with @flaky: .. code-block:: python from flaky import flaky .. code-block:: python @flaky def test_something_that_usually_passes(self): value_to_double = 21 result = get_result_from_flaky_doubler(value_to_double) self.assertEqual(result, value_to_double * 2, 'Result doubled incorrectly.') By default, flaky will retry a failing test once, but that behavior can be overridden by passing values to the flaky decorator. It accepts two parameters: max_runs, and min_passes; flaky will run tests up to max_runs times, until it has succeeded min_passes times. Once a test passes min_passes times, it's considered a success; once it has been run max_runs times without passing min_passes times, it's considered a failure. .. code-block:: python @flaky(max_runs=3, min_passes=2) def test_something_that_usually_passes(self): """This test must pass twice, and it can be run up to three times.""" value_to_double = 21 result = get_result_from_flaky_doubler(value_to_double) self.assertEqual(result, value_to_double * 2, 'Result doubled incorrectly.') Marking a class flaky +++++++++++++++++++++ In addition to marking a single test flaky, entire test cases can be marked flaky: .. code-block:: python @flaky class TestMultipliers(TestCase): def test_flaky_doubler(self): value_to_double = 21 result = get_result_from_flaky_doubler(value_to_double) self.assertEqual(result, value_to_double * 2, 'Result doubled incorrectly.') @flaky(max_runs=3) def test_flaky_tripler(self): value_to_triple = 14 result = get_result_from_flaky_tripler(value_to_triple) self.assertEqual(result, value_to_triple * 3, 'Result tripled incorrectly.') The @flaky class decorator will mark test_flaky_doubler as flaky, but it won't override the 3 max_runs for test_flaky_tripler (from the decorator on that test method). Pytest marker +++++++++++++ When using ``pytest``, ``@pytest.mark.flaky`` can be used in place of ``@flaky``. Don't rerun certain types of failures ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Depending on your tests, some failures are obviously not due to flakiness. Instead of rerunning after those failures, you can specify a filter function that can tell flaky to fail the test right away. .. code-block:: python def is_not_crash(err, *args): return not issubclass(err[0], ProductCrashedError) @flaky def test_something(): raise ProductCrashedError @flaky(rerun_filter=is_not_crash) def test_something_else(): raise ProductCrashedError Flaky will run ``test_something`` twice, but will only run ``test_something_else`` once. It can also be used to incur a delay between test retries: .. code-block:: python import time def delay_rerun(*args): time.sleep(1) return True @flaky(rerun_filter=delay_rerun) def test_something_else(): ... Activating the plugin ~~~~~~~~~~~~~~~~~~~~~ With pytest, flaky will automatically run. It can, however be disabled via the command line: .. code-block:: console pytest -p no:flaky Command line arguments ~~~~~~~~~~~~~~~~~~~~~~ No Flaky Report +++++++++++++++ Pass ``--no-flaky-report`` to suppress the report at the end of the run detailing flaky test results. Shorter Flaky Report ++++++++++++++++++++ Pass ``--no-success-flaky-report`` to suppress information about successful flaky tests. Force Flaky +++++++++++ Pass ``--force-flaky`` to treat all tests as flaky. Pass ``--max-runs=MAX_RUNS`` and/or ``--min-passes=MIN_PASSES`` to control the behavior of flaky if ``--force-flaky`` is specified. Flaky decorators on individual tests will override these defaults. *Additional usage examples are in the code - see test/test_pytest/test_pytest_example.py* Installation ------------ To install, simply: .. code-block:: console pip install flaky Compatibility ------------- Flaky is tested with the following test runners and options: - Py.test. Works with ``pytest-xdist`` but not with the ``--boxed`` option. Doctests cannot be marked flaky. Contributing ------------ See `CONTRIBUTING.rst `_. Setup ~~~~~ Create a virtual environment and install packages - .. code-block:: console mkvirtualenv flaky pip install -r requirements-dev.txt Testing ~~~~~~~ Run all tests using - .. code-block:: console tox The tox tests include code style checks via pycodestyle and pylint. Copyright and License --------------------- :: Copyright 2015 Box, Inc. All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. python-flaky-3.8.1/flaky.iml000066400000000000000000000015661457610735100160020ustar00rootroot00000000000000 python-flaky-3.8.1/flaky/000077500000000000000000000000001457610735100152675ustar00rootroot00000000000000python-flaky-3.8.1/flaky/__init__.py000066400000000000000000000000431457610735100173750ustar00rootroot00000000000000from .flaky_decorator import flaky python-flaky-3.8.1/flaky/_flaky_plugin.py000066400000000000000000000530111457610735100204640ustar00rootroot00000000000000from io import StringIO from traceback import format_exception from flaky import defaults from flaky.names import FlakyNames class _FlakyPlugin: _retry_failure_message = ' failed ({0} runs remaining out of {1}).' _failure_message = ' failed; it passed {0} out of the required {1} times.' _not_rerun_message = ' failed and was not selected for rerun.' def __init__(self): super().__init__() self._stream = StringIO() self._flaky_success_report = True self._had_flaky_tests = False @property def stream(self): """ Returns the stream used for building the flaky report. Anything written to this stream before the end of the test run will be written to the flaky report. :return: The stream used for building the flaky report. :rtype: :class:`StringIO` """ return self._stream def _log_test_failure(self, test_callable_name, err, message): """ Add messaging about a test failure to the stream, which will be printed by the plugin's report method. """ formatted_exception_info = ''.join(format_exception(*err)).replace('\n', '\n\t').rstrip() self._stream.writelines([ str(test_callable_name), str(message), str(formatted_exception_info), '\n', ]) def _report_final_failure(self, err, flaky, name): """ Report that the test has failed too many times to pass at least min_passes times. By default, this means that the test has failed twice. :param err: Information about the test failure (from sys.exc_info()) :type err: `tuple` of `class`, :class:`Exception`, `traceback` :param flaky: Dictionary of flaky attributes :type flaky: `dict` of `unicode` to varies :param name: The test name :type name: `unicode` """ min_passes = flaky[FlakyNames.MIN_PASSES] current_passes = flaky[FlakyNames.CURRENT_PASSES] message = self._failure_message.format( current_passes, min_passes, ) self._log_test_failure(name, err, message) def _log_intermediate_failure(self, err, flaky, name): """ Report that the test has failed, but still has reruns left. Then rerun the test. :param err: Information about the test failure (from sys.exc_info()) :type err: `tuple` of `class`, :class:`Exception`, `traceback` :param flaky: Dictionary of flaky attributes :type flaky: `dict` of `unicode` to varies :param name: The test name :type name: `unicode` """ max_runs = flaky[FlakyNames.MAX_RUNS] runs_left = max_runs - flaky[FlakyNames.CURRENT_RUNS] message = self._retry_failure_message.format( runs_left, max_runs, ) self._log_test_failure(name, err, message) def _should_handle_test_error_or_failure(self, test): """ Whether or not flaky should handle a test error or failure. Only handle tests marked @flaky. Count remaining retries and compare with number of required successes that have not yet been achieved. This method may be called multiple times for the same test run, so it has no side effects. :param test: The test that has raised an error :type test: :class:`Function` :return: True, if the test needs to be rerun; False, otherwise. :rtype: `bool` """ if not self._has_flaky_attributes(test): return False flaky_attributes = self._get_flaky_attributes(test) flaky_attributes[FlakyNames.CURRENT_RUNS] += 1 has_failed = self._has_flaky_test_failed(flaky_attributes) return not has_failed def _will_handle_test_error_or_failure(self, test, name, err): """ Whether or not flaky will handle a test error or failure. Returns True if the plugin should handle the test result, and the `rerun_filter` returns True. :param test: The test that has raised an error :type test: :class:`Function` :param name: The name of the test that has raised an error :type name: `unicode` :param err: Information about the test failure (from sys.exc_info()) :type err: `tuple` of `type`, :class:`Exception`, `traceback` :return: True, if the test will be rerun by flaky; False, otherwise. :rtype: `bool` """ return self._should_handle_test_error_or_failure(test) and self._should_rerun_test(test, name, err) def _handle_test_error_or_failure(self, test, err): """ Handle a flaky test error or failure. Returning True from this method keeps the test runner from reporting the test as a failure; this way we can retry and only report as a failure if we are out of retries. This method may only be called once per test run; it changes persisted flaky attributes. :param test: The test that has raised an error :type test: :class:`Function` :param err: Information about the test failure (from sys.exc_info()) :type err: `tuple` of `type`, :class:`Exception`, `traceback` :return: True, if the test will be rerun; False, if the test runner should handle it. :rtype: `bool` """ try: name = self._get_test_callable_name(test) except AttributeError: return False if self._has_flaky_attributes(test): self._had_flaky_tests = True self._add_flaky_test_failure(test, err) should_handle = self._should_handle_test_error_or_failure(test) self._increment_flaky_attribute(test, FlakyNames.CURRENT_RUNS) if should_handle: flaky_attributes = self._get_flaky_attributes(test) if self._should_rerun_test(test, name, err): self._log_intermediate_failure(err, flaky_attributes, name) self._mark_test_for_rerun(test) return True self._log_test_failure(name, err, self._not_rerun_message) return False flaky_attributes = self._get_flaky_attributes(test) self._report_final_failure(err, flaky_attributes, name) return False def _should_rerun_test(self, test, name, err): """ Whether or not a test should be rerun. This is a pass-through to the test's rerun filter. A flaky test will only be rerun if it hasn't failed too many times to succeed at least min_passes times, and if this method returns True. :param test: The test that has raised an error :type test: :class:`Function` :param name: The test name :type name: `unicode` :param err: Information about the test failure (from sys.exc_info()) :type err: `tuple` of `class`, :class:`Exception`, `traceback` :return: Whether flaky should rerun this test. :rtype: `bool` """ rerun_filter = self._get_flaky_attribute(test, FlakyNames.RERUN_FILTER) return rerun_filter(err, name, test, self) def _mark_test_for_rerun(self, test): """ Mark a flaky test for rerun. :param test: The test that has raised an error or succeeded :type test: :class:`Function` """ raise NotImplementedError # pragma: no cover def _should_handle_test_success(self, test): if not self._has_flaky_attributes(test): return False flaky = self._get_flaky_attributes(test) flaky[FlakyNames.CURRENT_PASSES] += 1 flaky[FlakyNames.CURRENT_RUNS] += 1 return not self._has_flaky_test_succeeded(flaky) def _handle_test_success(self, test): """ Handle a flaky test success. Count remaining retries and compare with number of required successes that have not yet been achieved; retry if necessary. Returning True from this method keeps the test runner from reporting the test as a success; this way we can retry and only report as a success if the test has passed the required number of times. :param test: The test that has raised an error :type test: :class:`Function` :return: True, if the test will be rerun; False, if the test runner should handle it. :rtype: `bool` """ try: name = self._get_test_callable_name(test) except AttributeError: return False need_reruns = self._should_handle_test_success(test) if self._has_flaky_attributes(test): self._had_flaky_tests = True flaky = self._get_flaky_attributes(test) min_passes = flaky[FlakyNames.MIN_PASSES] passes = flaky[FlakyNames.CURRENT_PASSES] + 1 self._set_flaky_attribute(test, FlakyNames.CURRENT_PASSES, passes) self._increment_flaky_attribute(test, FlakyNames.CURRENT_RUNS) if self._flaky_success_report: self._stream.writelines([ str(name), ' passed {} out of the required {} times. '.format( passes, min_passes, ), ]) if need_reruns: self._stream.write( 'Running test again until it passes {} times.\n'.format( min_passes, ) ) else: self._stream.write('Success!\n') if need_reruns: self._mark_test_for_rerun(test) return need_reruns @staticmethod def add_report_option(add_option): """ Add an option to the test runner to suppress the flaky report. :param add_option: A function that can add an option to the test runner. Its argspec should equal that of argparse.add_option. :type add_option: `callable` """ add_option( '--no-flaky-report', action='store_false', dest='flaky_report', default=True, help="Suppress the report at the end of the " "run detailing flaky test results.", ) add_option( '--no-success-flaky-report', action='store_false', dest='flaky_success_report', default=True, help="Suppress reporting flaky test successes" "in the report at the end of the " "run detailing flaky test results.", ) @staticmethod def add_force_flaky_options(add_option): """ Add options to the test runner that force all tests to be flaky. :param add_option: A function that can add an option to the test runner. Its argspec should equal that of argparse.add_option. :type add_option: `callable` """ add_option( '--force-flaky', action="store_true", dest="force_flaky", default=False, help="If this option is specified, we will treat all tests as " "flaky." ) add_option( '--max-runs', action="store", dest="max_runs", type=int, default=2, help="If --force-flaky is specified, we will run each test at " "most this many times (unless the test has its own flaky " "decorator)." ) add_option( '--min-passes', action="store", dest="min_passes", type=int, default=1, help="If --force-flaky is specified, we will run each test at " "least this many times (unless the test has its own flaky " "decorator)." ) def _add_flaky_report(self, stream): """ Baseclass override. Write details about flaky tests to the test report. :param stream: The test stream to which the report can be written. :type stream: `file` """ value = self._stream.getvalue() # Do not print report if there were no tests marked 'flaky' at all. if not self._had_flaky_tests and not value: return # If everything succeeded and --no-success-flaky-report is specified # don't print anything. if not self._flaky_success_report and not value: return stream.write('===Flaky Test Report===\n\n') # Python 2 will write to the stderr stream as a byte string, whereas # Python 3 will write to the stream as text. Only encode into a byte # string if the write tries to encode it first and raises a # UnicodeEncodeError. try: stream.write(value) except UnicodeEncodeError: stream.write(value.encode('utf-8', 'replace')) stream.write('\n===End Flaky Test Report===\n') @classmethod def _copy_flaky_attributes(cls, test, test_class): """ Copy flaky attributes from the test callable or class to the test. :param test: The test that is being prepared to run :type test: :class:`Function` """ test_callable = cls._get_test_callable(test) if test_callable is None: return for attr, value in cls._get_flaky_attributes(test_class).items(): already_set = hasattr(test, attr) if already_set: continue attr_on_callable = getattr(test_callable, attr, None) if attr_on_callable is not None: cls._set_flaky_attribute(test, attr, attr_on_callable) elif value is not None: cls._set_flaky_attribute(test, attr, value) @staticmethod def _get_flaky_attribute(test_item, flaky_attribute): """ Gets an attribute describing the flaky test. :param test_item: The test method from which to get the attribute :type test_item: `callable` or :class:`Function` :param flaky_attribute: The name of the attribute to get :type flaky_attribute: `unicode` :return: The test callable's attribute, or None if the test callable doesn't have that attribute. :rtype: varies """ return getattr(test_item, flaky_attribute, None) @staticmethod def _set_flaky_attribute(test_item, flaky_attribute, value): """ Sets an attribute on a flaky test. Uses magic __dict__ since setattr doesn't work for bound methods. :param test_item: The test callable on which to set the attribute :type test_item: `callable` or :class:`Function` :param flaky_attribute: The name of the attribute to set :type flaky_attribute: `unicode` :param value: The value to set the test callable's attribute to. :type value: varies """ test_item.__dict__[flaky_attribute] = value @classmethod def _increment_flaky_attribute(cls, test_item, flaky_attribute): """ Increments the value of an attribute on a flaky test. :param test_item: The test callable on which to set the attribute :type test_item: `callable` or :class:`Function` :param flaky_attribute: The name of the attribute to set :type flaky_attribute: `unicode` """ cls._set_flaky_attribute(test_item, flaky_attribute, cls._get_flaky_attribute(test_item, flaky_attribute) + 1) @classmethod def _has_flaky_attributes(cls, test): """ Returns True if the test callable in question is marked as flaky. :param test: The test that is being prepared to run :type test: :class:`Function` :return: :rtype: `bool` """ current_runs = cls._get_flaky_attribute(test, FlakyNames.CURRENT_RUNS) return current_runs is not None @classmethod def _get_flaky_attributes(cls, test_item): """ Get all the flaky related attributes from the test. :param test_item: The test callable from which to get the flaky related attributes. :type test_item: `callable` or :class:`Function` :return: :rtype: `dict` of `unicode` to varies """ return { attr: cls._get_flaky_attribute( test_item, attr, ) for attr in FlakyNames() } @classmethod def _add_flaky_test_failure(cls, test, err): """ Store test error information on the test callable. :param test: The flaky test on which to update the flaky attributes. :type test: :class:`Function` :param err: Information about the test failure (from sys.exc_info()) :type err: `tuple` of `class`, :class:`Exception`, `traceback` """ errs = getattr(test, FlakyNames.CURRENT_ERRORS, None) or [] cls._set_flaky_attribute(test, FlakyNames.CURRENT_ERRORS, errs) errs.append(err) @classmethod def _has_flaky_test_failed(cls, flaky): """ Whether or not the flaky test has failed :param flaky: Dictionary of flaky attributes :type flaky: `dict` of `unicode` to varies :return: True if the flaky test should be marked as failure; False if it should be rerun. :rtype: `bool` """ max_runs, current_runs, min_passes, current_passes = ( flaky[FlakyNames.MAX_RUNS], flaky[FlakyNames.CURRENT_RUNS], flaky[FlakyNames.MIN_PASSES], flaky[FlakyNames.CURRENT_PASSES], ) runs_left = max_runs - current_runs passes_needed = min_passes - current_passes no_retry = passes_needed > runs_left return no_retry and not cls._has_flaky_test_succeeded(flaky) @staticmethod def _has_flaky_test_succeeded(flaky): """ Whether or not the flaky test has succeeded :param flaky: Dictionary of flaky attributes :type flaky: `dict` of `unicode` to varies :return: True if the flaky test should be marked as success; False if it should be rerun. :rtype: `bool` """ return flaky[FlakyNames.CURRENT_PASSES] >= flaky[FlakyNames.MIN_PASSES] @classmethod def _get_test_callable(cls, test): """ Get the test callable, from the test. :param test: The test that has raised an error or succeeded :type test: :class:`pytest.Item` :return: The test declaration, callable and name that is being run :rtype: `callable` """ raise NotImplementedError # pragma: no cover @staticmethod def _get_test_callable_name(test): """ Get the name of the test callable from the test. :param test: The test that has raised an error or succeeded :type test: :class:`pytest.Item` :return: The name of the test callable that is being run by the test :rtype: `unicode` """ raise NotImplementedError # pragma: no cover @classmethod def _make_test_flaky(cls, test, max_runs=None, min_passes=None, rerun_filter=None): """ Make a given test flaky. :param test: The test in question. :type test: :class:`Function` :param max_runs: The value of the FlakyNames.MAX_RUNS attribute to use. :type max_runs: `int` :param min_passes: The value of the FlakyNames.MIN_PASSES attribute to use. :type min_passes: `int` :param rerun_filter: Filter function to decide whether a test should be rerun if it fails. Function signature is as follows: (err, name, test, plugin) -> should_rerun - err (`tuple` of `class`, :class:`Exception`, `traceback`): Information about the test failure (from sys.exc_info()) - name (`unicode`): The test name - test (:class:`Function`): The test that has raised an error - plugin (:class:`FlakyPytestPlugin`): The flaky plugin. Has a :prop:`stream` that can be written to in order to add to the Flaky Report. :type rerun_filter: `callable` """ attrib_dict = defaults.default_flaky_attributes(max_runs, min_passes, rerun_filter) for attr, value in attrib_dict.items(): cls._set_flaky_attribute(test, attr, value) python-flaky-3.8.1/flaky/defaults.py000066400000000000000000000033771457610735100174620ustar00rootroot00000000000000from flaky.names import FlakyNames def _true(*args): """ Default rerun filter function that always returns True. """ # pylint:disable=unused-argument return True class FilterWrapper: """ Filter function wrapper. Expected to be called as though it's a filter function. Since @flaky adds attributes to a decorated class, Python wants to turn a bare function into an unbound method, which is not what we want. """ def __init__(self, rerun_filter): self._filter = rerun_filter def __call__(self, *args, **kwargs): return self._filter(*args, **kwargs) def default_flaky_attributes(max_runs=None, min_passes=None, rerun_filter=None): """ Returns the default flaky attributes to set on a flaky test. :param max_runs: The value of the FlakyNames.MAX_RUNS attribute to use. :type max_runs: `int` :param min_passes: The value of the FlakyNames.MIN_PASSES attribute to use. :type min_passes: `int` :param rerun_filter: Filter function to decide whether a test should be rerun if it fails. :type rerun_filter: `callable` :return: Default flaky attributes to set on a flaky test. :rtype: `dict` """ if max_runs is None: max_runs = 2 if min_passes is None: min_passes = 1 if min_passes <= 0: raise ValueError('min_passes must be positive') if max_runs < min_passes: raise ValueError('min_passes cannot be greater than max_runs!') return { FlakyNames.MAX_RUNS: max_runs, FlakyNames.MIN_PASSES: min_passes, FlakyNames.CURRENT_RUNS: 0, FlakyNames.CURRENT_PASSES: 0, FlakyNames.RERUN_FILTER: FilterWrapper(rerun_filter or _true), } python-flaky-3.8.1/flaky/flaky_decorator.py000066400000000000000000000034561457610735100210210ustar00rootroot00000000000000from flaky.defaults import default_flaky_attributes def flaky(max_runs=None, min_passes=None, rerun_filter=None): """ Decorator used to mark a test as "flaky". :param max_runs: The maximum number of times the decorated test will be run. :type max_runs: `int` :param min_passes: The minimum number of times the test must pass to be a success. :type min_passes: `int` :param rerun_filter: Filter function to decide whether a test should be rerun if it fails. Function signature is as follows: (err, name, test, plugin) -> should_rerun - err (`tuple` of `class`, :class:`Exception`, `traceback`): Information about the test failure (from sys.exc_info()) - name (`unicode`): The test name - test (:class:`Function`): The test that has raised an error - plugin (:class:`FlakyPytestPlugin`): The flaky plugin. Has a :prop:`stream` that can be written to in order to add to the Flaky Report. :type rerun_filter: `callable` :return: A wrapper function that includes attributes describing the flaky test. :rtype: `callable` """ # In case @flaky is applied to a function or class without arguments # (and without parentheses), max_runs will refer to the wrapped object. # In this case, the default value can be used. wrapped = None if hasattr(max_runs, '__call__'): wrapped, max_runs = max_runs, None attrib = default_flaky_attributes(max_runs, min_passes, rerun_filter) def wrapper(wrapped_object): for name, value in attrib.items(): setattr(wrapped_object, name, value) return wrapped_object return wrapper(wrapped) if wrapped is not None else wrapper python-flaky-3.8.1/flaky/flaky_pytest_plugin.py000066400000000000000000000355241457610735100217460ustar00rootroot00000000000000from _pytest import runner # pylint:disable=import-error from flaky._flaky_plugin import _FlakyPlugin def _get_worker_output(item): worker_output = None if hasattr(item, 'workeroutput'): worker_output = item.workeroutput elif hasattr(item, 'slaveoutput'): worker_output = item.slaveoutput return worker_output class FlakyXdist: def __init__(self, plugin): super().__init__() self._plugin = plugin def pytest_testnodedown(self, node, error): """ Pytest hook for responding to a test node shutting down. Copy worker flaky report output so it's available on the master flaky report. """ # pylint: disable=unused-argument, no-self-use worker_output = _get_worker_output(node) if worker_output is not None and 'flaky_report' in worker_output: self._plugin.stream.write(worker_output['flaky_report']) class FlakyPlugin(_FlakyPlugin): """ Plugin for pytest that allows retrying flaky tests. """ runner = None flaky_report = True force_flaky = False max_runs = None min_passes = None config = None _call_infos = {} _PYTEST_WHEN_SETUP = 'setup' _PYTEST_WHEN_CALL = 'call' _PYTEST_WHENS = (_PYTEST_WHEN_SETUP, _PYTEST_WHEN_CALL) _PYTEST_OUTCOME_PASSED = 'passed' _PYTEST_OUTCOME_FAILED = 'failed' _PYTEST_EMPTY_STATUS = ('', '', '') def pytest_runtest_protocol(self, item, nextitem): """ Pytest hook to override how tests are run. Runs a test collected by pytest. - First, monkey patches the builtin runner module to call back to FlakyPlugin.call_runtest_hook rather than its own. - Then defers to the builtin runner module to run the test, and repeats the process if the test needs to be rerun. - Reports test results to the flaky report. :param item: pytest wrapper for the test function to be run :type item: :class:`Function` :param nextitem: pytest wrapper for the next test function to be run :type nextitem: :class:`Function` :return: True if no further hook implementations should be invoked. :rtype: `bool` """ test_instance = self._get_test_instance(item) self._copy_flaky_attributes(item, test_instance) if self.force_flaky and not self._has_flaky_attributes(item): self._make_test_flaky( item, self.max_runs, self.min_passes, ) original_call_and_report = self.runner.call_and_report self._call_infos[item] = {} should_rerun = True try: self.runner.call_and_report = self.call_and_report while should_rerun: self.runner.pytest_runtest_protocol(item, nextitem) call_info = None excinfo = None for when in self._PYTEST_WHENS: call_info = self._call_infos.get(item, {}).get(when, None) excinfo = getattr(call_info, 'excinfo', None) if excinfo is not None: break if call_info is None: return False passed = excinfo is None if passed: should_rerun = self.add_success(item) else: skipped = excinfo.typename == 'Skipped' should_rerun = not skipped and self.add_failure(item, excinfo) if not should_rerun: item.excinfo = excinfo finally: self.runner.call_and_report = original_call_and_report del self._call_infos[item] return True def call_and_report(self, item, when, log=True, **kwds): """ Monkey patched from the runner plugin. Responsible for running the test and reporting the outcome. Had to be patched to avoid reporting about test retries. :param item: pytest wrapper for the test function to be run :type item: :class:`Function` :param when: The stage of the test being run. Usually one of 'setup', 'call', 'teardown'. :type when: `str` :param log: Whether or not to report the test outcome. Ignored for test retries; flaky doesn't report test retries, only the final outcome. :type log: `bool` """ def _call_runtest_hook(item, when, **kwds): if when == "setup": ihook = item.ihook.pytest_runtest_setup elif when == "call": ihook = item.ihook.pytest_runtest_call elif when == "teardown": ihook = item.ihook.pytest_runtest_teardown else: assert False, f"Unhandled runtest hook case: {when}" reraise = (runner.Exit,) if not item.config.getoption("usepdb", False): reraise += (KeyboardInterrupt,) return runner.CallInfo.from_call( lambda: ihook(item=item, **kwds), when=when, reraise=reraise ) call = _call_runtest_hook(item, when, **kwds) self._call_infos[item][when] = call hook = item.ihook report = hook.pytest_runtest_makereport(item=item, call=call) # Start flaky modifications # only retry on call, not setup or teardown if report.when in self._PYTEST_WHENS: if report.outcome == self._PYTEST_OUTCOME_PASSED: if self._should_handle_test_success(item): log = False elif report.outcome == self._PYTEST_OUTCOME_FAILED: err, name = self._get_test_name_and_err(item, when) if self._will_handle_test_error_or_failure(item, name, err): log = False # End flaky modifications if log: hook.pytest_runtest_logreport(report=report) if self.runner.check_interactive_exception(call, report): hook.pytest_exception_interact(node=item, call=call, report=report) return report def _get_test_name_and_err(self, item, when): """ Get the test name and error tuple from a test item. :param item: pytest wrapper for the test function to be run :type item: :class:`Function` :return: The test name and error tuple. :rtype: ((`type`, :class:`Exception`, :class:`Traceback`) or (None, None, None), `unicode`) """ name = self._get_test_callable_name(item) call_info = self._call_infos.get(item, {}).get(when, None) if call_info is not None and call_info.excinfo: err = (call_info.excinfo.type, call_info.excinfo.value, call_info.excinfo.tb) else: err = (None, None, None) return err, name def pytest_terminal_summary(self, terminalreporter): """ Pytest hook to write details about flaky tests to the test report. Write details about flaky tests to the test report. :param terminalreporter: Terminal reporter object. Supports stream writing operations. :type terminalreporter: :class: `TerminalReporter` """ if self.flaky_report: self._add_flaky_report(terminalreporter) def pytest_addoption(self, parser): """ Pytest hook to add an option to the argument parser. :param parser: Parser for command line arguments and ini-file values. :type parser: :class:`Parser` """ self.add_report_option(parser.addoption) group = parser.getgroup( "Force flaky", "Force all tests to be flaky.") self.add_force_flaky_options(group.addoption) def pytest_configure(self, config): """ Pytest hook to get information about how the test run has been configured. :param config: The pytest configuration object for this test run. :type config: :class:`Configuration` """ self.flaky_report = config.option.flaky_report self.flaky_success_report = config.option.flaky_success_report self.force_flaky = config.option.force_flaky self.max_runs = config.option.max_runs self.min_passes = config.option.min_passes self.runner = config.pluginmanager.getplugin("runner") if config.pluginmanager.hasplugin('xdist'): config.pluginmanager.register(FlakyXdist(self), name='flaky.xdist') self.config = config worker_output = _get_worker_output(config) if worker_output is not None: worker_output['flaky_report'] = '' config.addinivalue_line('markers', 'flaky: marks tests to be automatically retried upon failure') def pytest_runtest_setup(self, item): """ Pytest hook to modify the test before it's run. :param item: The test item. """ if not self._has_flaky_attributes(item): if hasattr(item, 'iter_markers'): for marker in item.iter_markers(name='flaky'): self._make_test_flaky(item, *marker.args, **marker.kwargs) break elif hasattr(item, 'get_marker'): marker = item.get_marker('flaky') if marker: self._make_test_flaky(item, *marker.args, **marker.kwargs) def pytest_sessionfinish(self): """ Pytest hook to take a final action after the session is complete. Copy flaky report contents so that the master process can read it. """ worker_output = _get_worker_output(self.config) if worker_output is not None: worker_output['flaky_report'] += self.stream.getvalue() @property def stream(self): return self._stream @property def flaky_success_report(self): """ Property for setting whether or not the plugin will print results about flaky tests that were successful. :return: Whether or not flaky will report on test successes. :rtype: `bool` """ return self._flaky_success_report @flaky_success_report.setter def flaky_success_report(self, value): """ Property for setting whether or not the plugin will print results about flaky tests that were successful. :param value: Whether or not flaky will report on test successes. :type value: `bool` """ self._flaky_success_report = value @staticmethod def _get_test_instance(item): """ Get the object containing the test. This might be `test.instance` or `test.parent.obj`. """ test_instance = getattr(item, 'instance', None) if test_instance is None: if hasattr(item, 'parent') and hasattr(item.parent, 'obj'): test_instance = item.parent.obj return test_instance def add_success(self, item): """ Called when a test succeeds. Count remaining retries and compare with number of required successes that have not yet been achieved; retry if necessary. :param item: pytest wrapper for the test function that has succeeded :type item: :class:`Function` """ return self._handle_test_success(item) def add_failure(self, item, err): """ Called when a test fails. Count remaining retries and compare with number of required successes that have not yet been achieved; retry if necessary. :param item: pytest wrapper for the test function that has succeeded :type item: :class:`Function` :param err: Information about the test failure :type err: :class: `ExceptionInfo` """ if err is not None: error = (err.type, err.value, err.traceback) else: error = (None, None, None) return self._handle_test_error_or_failure(item, error) @staticmethod def _get_test_callable_name(test): """ Base class override. """ return test.name @classmethod def _get_test_callable(cls, test): """ Base class override. :param test: The test that has raised an error or succeeded :type test: :class:`Function` :return: The test declaration, callable and name that is being run :rtype: `tuple` of `object`, `callable`, `unicode` """ callable_name = cls._get_test_callable_name(test) if callable_name.endswith(']') and '[' in callable_name: unparametrized_name = callable_name[:callable_name.index('[')] else: unparametrized_name = callable_name test_instance = cls._get_test_instance(test) if hasattr(test_instance, callable_name): # Test is a method of a class def_and_callable = getattr(test_instance, callable_name) return def_and_callable if hasattr(test_instance, unparametrized_name): # Test is a parametrized method of a class def_and_callable = getattr(test_instance, unparametrized_name) return def_and_callable if hasattr(test, 'module'): if hasattr(test.module, callable_name): # Test is a function in a module def_and_callable = getattr(test.module, callable_name) return def_and_callable if hasattr(test.module, unparametrized_name): # Test is a parametrized function in a module def_and_callable = getattr(test.module, unparametrized_name) return def_and_callable elif hasattr(test, 'runtest'): # Test is a doctest or other non-Function Item return test.runtest return None def _mark_test_for_rerun(self, test): """Base class override. Rerun a flaky test.""" def _log_test_failure(self, test_callable_name, err, message): """ Add messaging about a test failure to the stream, which will be printed by the plugin's report method. """ self._stream.writelines([ str(test_callable_name), message, '\n\t', str(err[0]), '\n\t', str(err[1]), '\n\t', str(err[2]), '\n', ]) PLUGIN = FlakyPlugin() # pytest only processes hooks defined on the module # find all hooks defined on the plugin class and copy them to the module globals for _pytest_hook in dir(PLUGIN): if _pytest_hook.startswith('pytest_'): globals()[_pytest_hook] = getattr(PLUGIN, _pytest_hook) python-flaky-3.8.1/flaky/multiprocess_string_io.py000066400000000000000000000016271457610735100224550ustar00rootroot00000000000000import multiprocessing class MultiprocessingStringIO: """ Provide a StringIO-like interface to the multiprocessing ListProxy. The multiprocessing ListProxy needs to be instantiated before the flaky plugin is configured, so the list is created as a class variable. """ _manager = multiprocessing.Manager() proxy = _manager.list() # pylint:disable=no-member def getvalue(self): """ Shadow the StringIO.getvalue method. """ return ''.join(i for i in self.proxy) def writelines(self, content_list): """ Shadow the StringIO.writelines method. Ingests a list and translates that to a string """ for item in content_list: self.write(item) def write(self, content): """ Shadow the StringIO.write method. """ content.strip('\n') self.proxy.append(content) python-flaky-3.8.1/flaky/names.py000066400000000000000000000011661457610735100167500ustar00rootroot00000000000000class FlakyNames: """ Names of flaky attributes that will be added to flaky tests """ CURRENT_ERRORS = '_flaky_current_errors' CURRENT_RUNS = '_flaky_current_runs' CURRENT_PASSES = '_flaky_current_passes' MAX_RUNS = '_flaky_max_runs' MIN_PASSES = '_flaky_min_passes' RERUN_FILTER = '_flaky_rerun_filter' def items(self): return ( self.CURRENT_ERRORS, self.CURRENT_PASSES, self.CURRENT_RUNS, self.MAX_RUNS, self.MIN_PASSES, self.RERUN_FILTER, ) def __iter__(self): yield from self.items() python-flaky-3.8.1/requirements-dev.txt000066400000000000000000000001371457610735100202220ustar00rootroot00000000000000-rrequirements.txt coveralls ordereddict pycodestyle pylint pytest pytest-cov pytest-xdist tox python-flaky-3.8.1/requirements.txt000066400000000000000000000000001457610735100174330ustar00rootroot00000000000000python-flaky-3.8.1/setup.cfg000066400000000000000000000003741457610735100160060ustar00rootroot00000000000000[bdist_wheel] # This flag says that the code is written to work on both Python 2 and Python # 3. If at all possible, it is good practice to do this. If you cannot, you # will need to generate wheels for each Python version that you support. universal=1python-flaky-3.8.1/setup.py000066400000000000000000000046031457610735100156760ustar00rootroot00000000000000from os.path import dirname, join import sys from setuptools.command.test import test as TestCommand from setuptools import setup, find_packages CLASSIFIERS = [ 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', 'License :: OSI Approved :: Apache Software License', 'Topic :: Software Development :: Testing', 'Programming Language :: Python', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3 :: Only', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', 'Operating System :: OS Independent', 'Operating System :: POSIX', 'Operating System :: Microsoft :: Windows', 'Operating System :: MacOS :: MacOS X', ] class Tox(TestCommand): user_options = [(b'tox-args=', b'a', 'Arguments to pass to tox')] def initialize_options(self): TestCommand.initialize_options(self) self.tox_args = None def finalize_options(self): TestCommand.finalize_options(self) self.test_args = [] self.test_suite = True def run_tests(self): import shlex import tox args = self.tox_args if args: args = shlex.split(self.tox_args) errno = tox.cmdline(args=args) sys.exit(errno) def main(): base_dir = dirname(__file__) setup( name='flaky', version='3.8.1', description='Plugin for pytest that automatically reruns flaky tests.', long_description=open(join(base_dir, 'README.rst')).read(), author='Box', author_email='oss@box.com', url='https://github.com/box/flaky', license='Apache Software License, Version 2.0, http://www.apache.org/licenses/LICENSE-2.0', packages=find_packages(exclude=['test*']), test_suite='test', tests_require=['tox'], cmdclass={'test': Tox}, zip_safe=False, entry_points={ 'pytest11': [ 'flaky = flaky.flaky_pytest_plugin' ] }, keywords='pytest plugin flaky tests rerun retry', python_requires='>=3.5', classifiers=CLASSIFIERS, ) if __name__ == '__main__': main() python-flaky-3.8.1/test/000077500000000000000000000000001457610735100151405ustar00rootroot00000000000000python-flaky-3.8.1/test/__init__.py000066400000000000000000000000001457610735100172370ustar00rootroot00000000000000python-flaky-3.8.1/test/test.iml000066400000000000000000000006461457610735100166300ustar00rootroot00000000000000 python-flaky-3.8.1/test/test_flaky_decorator.py000066400000000000000000000025501457610735100217230ustar00rootroot00000000000000from unittest import TestCase from flaky.flaky_decorator import flaky from flaky.names import FlakyNames class TestFlakyDecorator(TestCase): def test_flaky_raises_for_non_positive_min_passes(self): def test_something(): pass self.assertRaises( ValueError, lambda: flaky(min_passes=0)(test_something), ) def test_flaky_raises_for_max_runs_less_than_min_passes(self): def test_something(): pass self.assertRaises( ValueError, lambda: flaky(max_runs=2, min_passes=3)(test_something), ) def test_flaky_adds_flaky_attributes_to_test_method(self): min_passes = 4 max_runs = 7 @flaky(max_runs, min_passes) def test_something(): pass flaky_attribute = { attr: getattr( test_something, attr, None ) for attr in FlakyNames() } self.assertIsNotNone(flaky_attribute) self.assertLessEqual( { FlakyNames.MIN_PASSES: min_passes, FlakyNames.MAX_RUNS: max_runs, FlakyNames.CURRENT_PASSES: 0, FlakyNames.CURRENT_RUNS: 0, FlakyNames.CURRENT_ERRORS: None }.items(), flaky_attribute.items() ) python-flaky-3.8.1/test/test_flaky_plugin.py000066400000000000000000000052501457610735100212370ustar00rootroot00000000000000from collections import namedtuple from io import StringIO from unittest import TestCase from flaky._flaky_plugin import _FlakyPlugin from flaky.names import FlakyNames TestCaseDataset = namedtuple( "TestCaseDataset", ['max_runs', 'min_passes', 'current_runs', 'current_passes', 'expect_fail'], ) class TestFlakyPlugin(TestCase): _test_dataset = { "default_not_started": TestCaseDataset(2, 1, 0, 0, False), "default_one_failure": TestCaseDataset(2, 1, 1, 0, False), "default_one_success": TestCaseDataset(2, 1, 1, 1, False), "default_two_failures": TestCaseDataset(2, 1, 2, 0, True), "default_one_failure_one_success": TestCaseDataset(2, 1, 2, 1, False), "three_two_not_started": TestCaseDataset(3, 2, 0, 0, False), "three_two_one_failure": TestCaseDataset(3, 2, 1, 0, False), "three_two_one_success": TestCaseDataset(3, 2, 1, 1, False), "three_two_two_failures": TestCaseDataset(3, 2, 2, 0, True), "three_two_one_failure_one_success": TestCaseDataset(3, 2, 2, 1, False), "three_two_two_successes": TestCaseDataset(3, 2, 2, 2, False), } def setUp(self): super().setUp() self._flaky_plugin = _FlakyPlugin() def test_flaky_plugin_handles_non_ascii_byte_string_in_exception(self): mock_method_name = 'my_method' mock_exception = 'ńőń ȁŝćȉȉ ŝƭȕƒƒ'.encode('utf-16') mock_message = 'information about retries' # pylint:disable=protected-access self._flaky_plugin._log_test_failure( mock_method_name, (ValueError.__name__, mock_exception, ''), mock_message, ) def test_flaky_plugin_identifies_failure(self): for name, test in self._test_dataset: with self.subTest(name): flaky = { FlakyNames.CURRENT_PASSES: test.current_passes, FlakyNames.CURRENT_RUNS: test.current_runs, FlakyNames.MAX_RUNS: test.max_runs, FlakyNames.MIN_PASSES: test.min_passes, } # pylint:disable=protected-access self.assertEqual( self._flaky_plugin._has_flaky_test_failed(flaky), test.expect_fail, ) def test_write_unicode_to_stream(self): for message in ('ascii stuff', 'ńőń ȁŝćȉȉ ŝƭȕƒƒ'): with self.subTest(message): stream = StringIO() stream.write('ascii stuff') # pylint:disable=protected-access self._flaky_plugin._stream.write(message) self._flaky_plugin._add_flaky_report(stream) python-flaky-3.8.1/test/test_multiprocess_string_io.py000066400000000000000000000026261457610735100233650ustar00rootroot00000000000000from io import StringIO from unittest import TestCase class TestMultiprocessStringIO(TestCase): _unicode_string = 'Plain Hello' _unicode_string_non_ascii = 'ńőń ȁŝćȉȉ ŝƭȕƒƒ' _test_values = { "no_writes": ([], ''), "one_write": ([_unicode_string], _unicode_string), "two_writes": ( [_unicode_string, _unicode_string_non_ascii], '{}{}'.format(_unicode_string, _unicode_string_non_ascii), ), } def setUp(self): super().setUp() from flaky.multiprocess_string_io import MultiprocessingStringIO self._string_io = StringIO() self._mp_string_io = MultiprocessingStringIO() del self._mp_string_io.proxy[:] self._string_ios = (self._string_io, self._mp_string_io) def test_write_then_read(self): for name, value in self._test_values.items(): with self.subTest(name): for string_io in self._string_ios: for item in value[0]: string_io.write(item) self.assertEqual(string_io.getvalue(), value[1]) def test_writelines_then_read(self): for name, value in self._test_values.items(): with self.subTest(name): for string_io in self._string_ios: string_io.writelines(value[0]) self.assertEqual(string_io.getvalue(), value[1]) python-flaky-3.8.1/test/test_pytest/000077500000000000000000000000001457610735100175275ustar00rootroot00000000000000python-flaky-3.8.1/test/test_pytest/__init__.py000066400000000000000000000000001457610735100216260ustar00rootroot00000000000000python-flaky-3.8.1/test/test_pytest/pytest_generate_example/000077500000000000000000000000001457610735100244445ustar00rootroot00000000000000python-flaky-3.8.1/test/test_pytest/pytest_generate_example/__init__.py000066400000000000000000000000001457610735100265430ustar00rootroot00000000000000python-flaky-3.8.1/test/test_pytest/pytest_generate_example/conftest.py000066400000000000000000000003251457610735100266430ustar00rootroot00000000000000def pytest_generate_tests(metafunc): """ Parameterize a fixture named 'dummy_list' with an empty list """ if 'dummy_list' in metafunc.fixturenames: metafunc.parametrize("dummy_list", [[]]) python-flaky-3.8.1/test/test_pytest/pytest_generate_example/test_pytest_generate_example.py000066400000000000000000000005751457610735100330010ustar00rootroot00000000000000from flaky import flaky @flaky def test_something_flaky(dummy_list): dummy_list.append(0) assert len(dummy_list) > 1 class TestExample: _threshold = -1 @flaky def test_flaky_thing_that_fails_then_succeeds(self, dummy_list): # pylint:disable=unused-argument,no-self-use TestExample._threshold += 1 assert TestExample._threshold >= 1 python-flaky-3.8.1/test/test_pytest/test_flaky_pytest_plugin.py000066400000000000000000000364331457610735100252450ustar00rootroot00000000000000from io import StringIO from unittest.mock import Mock, patch # pylint:disable=import-error import pytest from _pytest.runner import CallInfo # pylint:enable=import-error from flaky import flaky from flaky import _flaky_plugin from flaky.flaky_pytest_plugin import ( runner, FlakyPlugin, FlakyXdist, PLUGIN, ) from flaky.names import FlakyNames @pytest.fixture def mock_io(monkeypatch): mock_string_io = StringIO() def string_io(): return mock_string_io monkeypatch.setattr(_flaky_plugin, 'StringIO', string_io) return mock_string_io @pytest.fixture def string_io(): return StringIO() @pytest.fixture def flaky_plugin(mock_io): # pylint:disable=unused-argument return FlakyPlugin() @pytest.fixture def mock_plugin_rerun(monkeypatch, flaky_plugin): calls = [] def rerun_test(test): calls.append(test) monkeypatch.setattr(flaky_plugin, '_mark_test_for_rerun', rerun_test) def get_calls(): return calls return get_calls @pytest.fixture(params=['instance', 'module', 'parent']) def flaky_test(request, mock_config): def test_function(): pass test_owner = Mock() setattr(test_owner, 'test_method', test_function) setattr(test_owner, 'obj', test_owner) kwargs = {request.param: test_owner} test = MockTestItem(**kwargs) setattr(test, 'owner', test_owner) setattr(test, 'config', mock_config) return test @pytest.fixture def call_info(flaky_test): return MockFlakyCallInfo(flaky_test, 'call') @pytest.fixture def mock_error(): return MockError() class MockError: def __init__(self): super().__init__() self.type = Mock() self.value = Mock() self.value.message = 'failed' self.traceback = Mock() class MockTestItem: name = 'test_method' instance = None module = None parent = None def __init__(self, instance=None, module=None, parent=None): if instance is not None: self.instance = instance if module is not None: self.module = module if parent is not None: self.parent = parent def runtest(self): pass class MockConfig: def getvalue(self, key): # pylint:disable=unused-argument,no-self-use return False def getoption(self, key, default): # pylint:disable=unused-argument,no-self-use return default @pytest.fixture def mock_config(): return MockConfig() class MockFlakyCallInfo(CallInfo): def __init__(self, item, when): # pylint:disable=super-init-not-called # super init not called because it has unwanted side effects self.when = when self._item = item def test_flaky_plugin_report(flaky_plugin, mock_io, string_io): flaky_report = 'Flaky tests passed; others failed. ' \ 'No more tests; that ship has sailed.' expected_string_io = StringIO() expected_string_io.write('===Flaky Test Report===\n\n') expected_string_io.write(flaky_report) expected_string_io.write('\n===End Flaky Test Report===\n') mock_io.write(flaky_report) flaky_plugin.pytest_terminal_summary(string_io) assert string_io.getvalue() == expected_string_io.getvalue() @pytest.fixture(params=( {}, {'flaky_report': ''}, {'flaky_report': 'ŝȁḿҏľȅ ƭȅхƭ'}, )) def mock_xdist_node_workeroutput(request): return request.param @pytest.fixture(params=(None, object())) def mock_xdist_error(request): return request.param @pytest.mark.parametrize('assign_workeroutput', (True, False)) def test_flaky_xdist_nodedown( mock_xdist_node_workeroutput, assign_workeroutput, mock_xdist_error ): flaky_xdist = FlakyXdist(PLUGIN) node = Mock() if assign_workeroutput: node.workeroutput = mock_xdist_node_workeroutput else: delattr(node, 'workeroutput') delattr(node, 'slaveoutput') mock_stream = Mock(StringIO) with patch.object(PLUGIN, '_stream', mock_stream): flaky_xdist.pytest_testnodedown(node, mock_xdist_error) if assign_workeroutput and 'flaky_report' in mock_xdist_node_workeroutput: mock_stream.write.assert_called_once_with( mock_xdist_node_workeroutput['flaky_report'], ) else: assert not mock_stream.write.called _REPORT_TEXT1 = 'Flaky report text' _REPORT_TEXT2 = 'Ḿőŕȅ ƒľȁƙŷ ŕȅҏőŕƭ ƭȅхƭ' @pytest.mark.parametrize('initial_report,stream_report,expected_report', ( ('', '', ''), ('', _REPORT_TEXT1, _REPORT_TEXT1), (_REPORT_TEXT1, '', _REPORT_TEXT1), (_REPORT_TEXT1, _REPORT_TEXT2, _REPORT_TEXT1 + _REPORT_TEXT2), (_REPORT_TEXT2, _REPORT_TEXT1, _REPORT_TEXT2 + _REPORT_TEXT1), )) def test_flaky_session_finish_copies_flaky_report( initial_report, stream_report, expected_report, ): PLUGIN.stream.seek(0) PLUGIN.stream.truncate() PLUGIN.stream.write(stream_report) PLUGIN.config = Mock() PLUGIN.config.workeroutput = {'flaky_report': initial_report} PLUGIN.pytest_sessionfinish() assert PLUGIN.config.workeroutput['flaky_report'] == expected_report def test_flaky_plugin_can_suppress_success_report( flaky_test, flaky_plugin, call_info, string_io, mock_io, ): flaky()(flaky_test) # pylint:disable=protected-access flaky_plugin._flaky_success_report = False # pylint:enable=protected-access call_info.when = 'call' actual_plugin_handles_success = flaky_plugin.add_success(flaky_test) assert actual_plugin_handles_success is False assert string_io.getvalue() == mock_io.getvalue() def test_flaky_plugin_raises_errors_in_fixture_setup( flaky_test, flaky_plugin, string_io, mock_io, ): """ Test for Issue #57 - fixtures which raise an error should show up as test errors. This test ensures that exceptions occurring when running a test fixture are copied into the call info's excinfo field. """ def error_raising_setup_function(item): assert item is flaky_test item.ran_setup = True return 5 / 0 flaky()(flaky_test) flaky_test.ihook = Mock() flaky_test.ihook.pytest_runtest_setup = error_raising_setup_function flaky_plugin._call_infos[flaky_test] = {} # pylint:disable=protected-access call_info = runner.CallInfo.from_call(lambda: flaky_test.ihook.pytest_runtest_setup(flaky_test), when='setup') assert flaky_test.ran_setup assert string_io.getvalue() == mock_io.getvalue() assert call_info.excinfo.type is ZeroDivisionError class TestFlakyPytestPlugin: _test_method_name = 'test_method' def test_flaky_plugin_handles_success( self, flaky_test, flaky_plugin, call_info, string_io, mock_io, ): self._test_flaky_plugin_handles_success( flaky_test, flaky_plugin, call_info, string_io, mock_io, ) def test_flaky_plugin_handles_success_for_needs_rerun( self, flaky_test, flaky_plugin, call_info, string_io, mock_io, mock_plugin_rerun, ): self._test_flaky_plugin_handles_success( flaky_test, flaky_plugin, call_info, string_io, mock_io, min_passes=2, ) assert mock_plugin_rerun()[0] == flaky_test def test_flaky_plugin_ignores_success_for_non_flaky_test( self, flaky_plugin, flaky_test, call_info, string_io, mock_io, ): flaky_plugin.add_success(flaky_test) self._assert_test_ignored(mock_io, string_io, call_info) def test_flaky_plugin_ignores_failure_for_non_flaky_test( self, flaky_plugin, flaky_test, call_info, string_io, mock_io, ): flaky_plugin.add_failure(flaky_test, None) self._assert_test_ignored(mock_io, string_io, call_info) def test_flaky_plugin_handles_failure( self, flaky_test, flaky_plugin, call_info, string_io, mock_io, mock_error, mock_plugin_rerun, ): self._test_flaky_plugin_handles_failure( flaky_test, flaky_plugin, call_info, string_io, mock_io, mock_error, ) assert mock_plugin_rerun()[0] == flaky_test def test_flaky_plugin_handles_failure_for_no_more_retries( self, flaky_test, flaky_plugin, call_info, string_io, mock_io, mock_error, ): self._test_flaky_plugin_handles_failure( flaky_test, flaky_plugin, call_info, string_io, mock_io, mock_error, max_runs=1, ) def test_flaky_plugin_handles_additional_failures( self, flaky_test, flaky_plugin, call_info, string_io, mock_io, mock_error, mock_plugin_rerun, ): self._test_flaky_plugin_handles_failure( flaky_test, flaky_plugin, call_info, string_io, mock_io, mock_error, current_errors=[None], ) assert mock_plugin_rerun()[0] == flaky_test def _assert_flaky_attributes_contains( self, expected_flaky_attributes, test, ): actual_flaky_attributes = self._get_flaky_attributes(test) assert all( item in actual_flaky_attributes.items() for item in expected_flaky_attributes.items() ) def test_flaky_plugin_exits_after_false_rerun_filter( self, flaky_test, flaky_plugin, call_info, string_io, mock_io, mock_error, mock_plugin_rerun, ): err_tuple = (mock_error.type, mock_error.value, mock_error.traceback) def rerun_filter(err, name, test, plugin): assert err == err_tuple assert name == flaky_test.name assert test is flaky_test assert plugin is flaky_plugin return False flaky(rerun_filter=rerun_filter)(flaky_test) call_info.when = 'call' actual_plugin_handles_failure = flaky_plugin.add_failure( flaky_test, mock_error, ) assert actual_plugin_handles_failure is False assert not mock_plugin_rerun() string_io.writelines([ self._test_method_name, ' failed and was not selected for rerun.', '\n\t', str(mock_error.type), '\n\t', str(mock_error.value), '\n\t', str(mock_error.traceback), '\n', ]) assert string_io.getvalue() == mock_io.getvalue() @staticmethod def _assert_test_ignored(mock_io, string_io, call_info): assert call_info assert mock_io.getvalue() == string_io.getvalue() def _test_flaky_plugin_handles_success( self, test, plugin, info, stream, mock_stream, current_passes=0, current_runs=0, max_runs=2, min_passes=1, ): flaky(max_runs, min_passes)(test) setattr( test, FlakyNames.CURRENT_PASSES, current_passes, ) setattr( test, FlakyNames.CURRENT_RUNS, current_runs, ) too_few_passes = current_passes + 1 < min_passes retries_remaining = current_runs + 1 < max_runs expected_plugin_handles_success = too_few_passes and retries_remaining info.when = 'call' actual_plugin_handles_success = plugin.add_success(test) assert expected_plugin_handles_success == actual_plugin_handles_success self._assert_flaky_attributes_contains( { FlakyNames.CURRENT_PASSES: current_passes + 1, FlakyNames.CURRENT_RUNS: current_runs + 1, }, test, ) stream.writelines([ self._test_method_name, " passed {} out of the required {} times. ".format( current_passes + 1, min_passes, ), ]) if expected_plugin_handles_success: stream.write( 'Running test again until it passes {} times.\n'.format( min_passes, ), ) else: stream.write('Success!\n') assert stream.getvalue() == mock_stream.getvalue() def _test_flaky_plugin_handles_failure( self, test, plugin, info, stream, mock_stream, mock_error, current_errors=None, current_passes=0, current_runs=0, max_runs=2, min_passes=1, rerun_filter=None, ): flaky(max_runs, min_passes, rerun_filter)(test) if current_errors is None: current_errors = [None] else: current_errors.append(None) setattr( test, FlakyNames.CURRENT_ERRORS, current_errors, ) setattr( test, FlakyNames.CURRENT_PASSES, current_passes, ) setattr( test, FlakyNames.CURRENT_RUNS, current_runs, ) too_few_passes = current_passes < min_passes retries_remaining = current_runs + 1 < max_runs expected_plugin_handles_failure = too_few_passes and retries_remaining info.when = 'call' actual_plugin_handles_failure = plugin.add_failure( test, mock_error, ) assert expected_plugin_handles_failure == actual_plugin_handles_failure self._assert_flaky_attributes_contains( { FlakyNames.CURRENT_RUNS: current_runs + 1, FlakyNames.CURRENT_ERRORS: current_errors }, test, ) if expected_plugin_handles_failure: stream.writelines([ self._test_method_name, ' failed ({} runs remaining out of {}).'.format( max_runs - current_runs - 1, max_runs ), '\n\t', str(mock_error.type), '\n\t', str(mock_error.value), '\n\t', str(mock_error.traceback), '\n', ]) else: message = ' failed; it passed {0} out of the required {1} times.' stream.writelines([ self._test_method_name, message.format( current_passes, min_passes ), '\n\t', str(mock_error.type), '\n\t', str(mock_error.value), '\n\t', str(mock_error.traceback), '\n', ]) assert stream.getvalue() == mock_stream.getvalue() @staticmethod def _get_flaky_attributes(test): actual_flaky_attributes = { attr: getattr( test, attr, None, ) for attr in FlakyNames() } return actual_flaky_attributes python-flaky-3.8.1/test/test_pytest/test_pytest_example.py000066400000000000000000000076521457610735100242150ustar00rootroot00000000000000from unittest import TestCase, skip # pylint:disable=import-error import pytest # pylint:enable=import-error from flaky import flaky # This is an end-to-end example of the flaky package in action. Consider it # a live tutorial, showing the various features in action. @flaky def test_something_flaky(dummy_list=[]): # pylint:disable=dangerous-default-value dummy_list.append(0) assert len(dummy_list) > 1 @pytest.fixture(scope='function') def failing_setup_fixture(): assert False @flaky @pytest.mark.xfail(strict=True) @pytest.mark.usefixtures("failing_setup_fixture") def test_something_good_with_failing_setup_fixture(): assert True class TestExample: _threshold = -1 def test_non_flaky_thing(self): """Flaky will not interact with this test""" @pytest.mark.xfail def test_non_flaky_failing_thing(self): """Flaky will also not interact with this test""" assert self == 1 @flaky(3, 2) def test_flaky_thing_that_fails_then_succeeds(self): """ Flaky will run this test 3 times. It will fail once and then succeed twice. """ # pylint:disable=no-self-use TestExample._threshold += 1 assert TestExample._threshold >= 1 @flaky(3, 2) def test_flaky_thing_that_succeeds_then_fails_then_succeeds(self): """ Flaky will run this test 3 times. It will succeed once, fail once, and then succeed one more time. """ # pylint:disable=no-self-use TestExample._threshold += 1 assert TestExample._threshold != 1 @flaky(2, 2) def test_flaky_thing_that_always_passes(self): """Flaky will run this test twice. Both will succeed.""" @pytest.mark.skipif( 'True', reason="This really fails! Remove skipif to see the test failure." ) @flaky() def test_flaky_thing_that_always_fails(self): """Flaky will run this test twice. Both will fail.""" assert self is None @flaky class TestExampleFlakyTests: _threshold = -1 @staticmethod def test_flaky_thing_that_fails_then_succeeds(): """ Flaky will run this test twice. It will fail once and then succeed. """ TestExampleFlakyTests._threshold += 1 assert TestExampleFlakyTests._threshold >= 1 @flaky class TestExampleFlakyTestCase(TestCase): _threshold = -1 @staticmethod def test_flaky_thing_that_fails_then_succeeds(): """ Flaky will run this test twice. It will fail once and then succeed. """ TestExampleFlakyTestCase._threshold += 1 assert TestExampleFlakyTestCase._threshold >= 1 class TestFlakySubclass(TestExampleFlakyTestCase): pass @pytest.mark.flaky class TestMarkedClass: _threshold = -1 @staticmethod def test_flaky_thing_that_fails_then_succeeds(): """ Flaky will run this test twice. It will fail once and then succeed. """ TestMarkedClass._threshold += 1 assert TestMarkedClass._threshold >= 1 def _test_flaky_doctest(): """ Flaky ignores doctests. This test wouldn't be rerun if it failed. >>> _test_flaky_doctest() True """ return True @pytest.fixture def my_fixture(): return 42 @flaky def test_requiring_my_fixture(my_fixture, dummy_list=[]): # pylint:disable=dangerous-default-value,unused-argument dummy_list.append(0) assert len(dummy_list) > 1 def _rerun_filter(err, name, test, plugin): # pylint:disable=unused-argument return issubclass(err[0], AssertionError) class TestExampleRerunFilter: _threshold = -1 @flaky(rerun_filter=_rerun_filter) def test_something_flaky(self): # pylint:disable=no-self-use TestExampleRerunFilter._threshold += 1 assert TestExampleRerunFilter._threshold >= 1 @skip('This test always fails') @flaky def test_something_that_always_fails_but_should_be_skipped(): assert 0 python-flaky-3.8.1/test/test_pytest/test_pytest_options_example.py000066400000000000000000000023141457610735100257560ustar00rootroot00000000000000# This is a series of tests that do not use the flaky decorator; the flaky # behavior is intended to be enabled with the --force-flaky option on the # command line. from flaky import flaky def test_something_flaky(dummy_list=[]): # pylint:disable=dangerous-default-value dummy_list.append(0) assert len(dummy_list) > 1 class TestExample: _threshold = -2 @staticmethod @flaky(3, 1) def test_flaky_thing_that_fails_then_succeeds(): """ Flaky will run this test 3 times. It will fail twice and then succeed once. This ensures that the flaky decorator overrides any command-line options we specify. """ TestExample._threshold += 1 assert TestExample._threshold >= 1 @flaky(3, 1) class TestExampleFlakyTests: _threshold = -2 @staticmethod def test_flaky_thing_that_fails_then_succeeds(): """ Flaky will run this test 3 times. It will fail twice and then succeed once. This ensures that the flaky decorator on a test suite overrides any command-line options we specify. """ TestExampleFlakyTests._threshold += 1 assert TestExampleFlakyTests._threshold >= 1 python-flaky-3.8.1/test/test_pytest/test_pytester_plugin.py000066400000000000000000000006031457610735100243740ustar00rootroot00000000000000pytest_plugins = 'pytester' # pylint:disable=invalid-name TESTSUITE = """ def test_a_thing(): pass """ def test_output_without_capture(testdir): """ Test for Issue #82. Flaky was breaking tests using the pytester plugin. """ script = testdir.makepyfile(TESTSUITE) result = testdir.runpytest(script, '--verbose', '--capture', 'fd') assert result.ret == 0 python-flaky-3.8.1/tox.ini000066400000000000000000000024401457610735100154740ustar00rootroot00000000000000[tox] envlist = py38, py39, py310, py311, py312, pypy310, pycodestyle, pylint, readme, coverage [testenv] deps = -rrequirements-dev.txt usedevelop = True commands = pytest -k 'example and not options' --doctest-modules test/test_pytest/ pytest -k 'example and not options' -n 1 test/test_pytest/ pytest -p no:flaky test/test_pytest/test_flaky_pytest_plugin.py pytest --force-flaky --max-runs 2 test/test_pytest/test_pytest_options_example.py [testenv:pycodestyle] commands = pycodestyle --ignore=E501 flaky pycodestyle --ignore=E501 test [testenv:pylint] commands = pylint --rcfile=.pylintrc flaky -d C0209,C0415,W4901 pylint --rcfile=.pylintrc test -d C0209,C0411,C0415,W0240,W0621,W0719 [testenv:coverage] commands = pip install setuptools python setup.py develop pytest -k 'example and not options' --doctest-modules --no-flaky-report --cov flaky --cov-report term-missing test/test_pytest/ pytest -p no:flaky --cov flaky --cov-report term-missing test/test_pytest/test_flaky_pytest_plugin.py [testenv:readme] deps = docutils pygments commands = rst2html.py --strict README.rst rst2html.py --strict HISTORY.rst rst2html.py --strict CONTRIBUTING.rst [pycodestyle] show-pep8 = True show-source = True