diff options
author | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
---|---|---|
committer | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
commit | 5f8de423f190bbb79a62f804151bc24824fa32d8 (patch) | |
tree | 10027f336435511475e392454359edea8e25895d /testing/web-platform/tests/tools/pytest | |
parent | 49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff) | |
download | UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip |
Add m-esr52 at 52.6.0
Diffstat (limited to 'testing/web-platform/tests/tools/pytest')
279 files changed, 55077 insertions, 0 deletions
diff --git a/testing/web-platform/tests/tools/pytest/.gitattributes b/testing/web-platform/tests/tools/pytest/.gitattributes new file mode 100644 index 000000000..242d3da0d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/.gitattributes @@ -0,0 +1 @@ +CHANGELOG merge=union diff --git a/testing/web-platform/tests/tools/pytest/.github/ISSUE_TEMPLATE.md b/testing/web-platform/tests/tools/pytest/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..bc62e8a3f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,8 @@ +Thanks for submitting an issue! + +Here's a quick checklist in what to include: + +- [ ] Include a detailed description of the bug or suggestion +- [ ] `pip list` of the virtual environment you are using +- [ ] py.test and operating system versions +- [ ] Minimal example if possible diff --git a/testing/web-platform/tests/tools/pytest/.github/PULL_REQUEST_TEMPLATE.md b/testing/web-platform/tests/tools/pytest/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..d09edce43 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,8 @@ +Thanks for submitting a PR, your contribution is really appreciated! + +Here's a quick checklist that should be present in PRs: + +- [ ] Target: for bug or doc fixes, target `master`; for new features, target `features` +- [ ] Make sure to include one or more tests for your change +- [ ] Add yourself to `AUTHORS` +- [ ] Add a new entry to the `CHANGELOG` (choose any open position to avoid merge conflicts with other PRs) diff --git a/testing/web-platform/tests/tools/pytest/.gitignore b/testing/web-platform/tests/tools/pytest/.gitignore new file mode 100644 index 000000000..e4355b859 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/.gitignore @@ -0,0 +1,34 @@ +# Automatically generated by `hgimportsvn` +.svn +.hgsvn + +# Ignore local virtualenvs +lib/ +bin/ +include/ +.Python/ + +# These lines are suggested according to the svn:ignore property +# Feel free to enable them by uncommenting them +*.pyc +*.pyo +*.swp +*.class +*.orig +*~ + +.eggs/ + +doc/*/_build +build/ +dist/ +*.egg-info +issue/ +env/ +.env/ +3rdparty/ +.tox +.cache +.coverage +.ropeproject +.idea diff --git a/testing/web-platform/tests/tools/pytest/.travis.yml b/testing/web-platform/tests/tools/pytest/.travis.yml new file mode 100644 index 000000000..3a8f36e95 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/.travis.yml @@ -0,0 +1,40 @@ +sudo: false +language: python +python: + - '3.5' +# command to install dependencies +install: "pip install -U tox" +# # command to run tests +env: + matrix: + # coveralls is not listed in tox's envlist, but should run in travis + - TESTENV=coveralls + # note: please use "tox --listenvs" to populate the build matrix below + - TESTENV=linting + - TESTENV=py26 + - TESTENV=py27 + - TESTENV=py33 + - TESTENV=py34 + - TESTENV=py35 + - TESTENV=pypy + - TESTENV=py27-pexpect + - TESTENV=py27-xdist + - TESTENV=py27-trial + - TESTENV=py35-pexpect + - TESTENV=py35-xdist + - TESTENV=py35-trial + - TESTENV=py27-nobyte + - TESTENV=doctesting + - TESTENV=py27-cxfreeze + +script: tox --recreate -e $TESTENV + +notifications: + irc: + channels: + - "chat.freenode.net#pytest" + on_success: change + on_failure: change + skip_join: true + email: + - pytest-commit@python.org diff --git a/testing/web-platform/tests/tools/pytest/AUTHORS b/testing/web-platform/tests/tools/pytest/AUTHORS new file mode 100644 index 000000000..dfc0a542e --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/AUTHORS @@ -0,0 +1,87 @@ +Holger Krekel, holger at merlinux eu +merlinux GmbH, Germany, office at merlinux eu + +Contributors include:: + +Abhijeet Kasurde +Anatoly Bubenkoff +Andreas Zeidler +Andy Freeland +Anthon van der Neut +Armin Rigo +Aron Curzon +Aviv Palivoda +Benjamin Peterson +Bob Ippolito +Brian Dorsey +Brian Okken +Brianna Laugher +Bruno Oliveira +Carl Friedrich Bolz +Charles Cloud +Chris Lamb +Christian Theunert +Christian Tismer +Christopher Gilling +Daniel Grana +Daniel Hahler +Daniel Nuri +Dave Hunt +David Mohr +David Vierra +Edison Gustavo Muenz +Eduardo Schettino +Endre Galaczi +Elizaveta Shashkova +Eric Hunsberger +Eric Siegerman +Erik M. Bray +Florian Bruhin +Floris Bruynooghe +Gabriel Reis +Georgy Dyuldin +Graham Horler +Grig Gheorghiu +Guido Wesdorp +Harald Armin Massa +Ian Bicking +Jaap Broekhuizen +Jan Balster +Janne Vanhala +Jason R. Coombs +Joshua Bronson +Jurko Gospodnetić +Katarzyna Jachim +Kevin Cox +Lee Kamentsky +Lukas Bednar +Maciek Fijalkowski +Maho +Marc Schlaich +Mark Abramowitz +Markus Unterwaditzer +Martijn Faassen +Matt Bachmann +Michael Aquilina +Michael Birtwell +Michael Droettboom +Nicolas Delaby +Pieter Mulder +Piotr Banaszkiewicz +Punyashloka Biswal +Ralf Schmitt +Raphael Pierzina +Ronny Pfannschmidt +Ross Lawley +Ryan Wooden +Samuele Pedroni +Tom Viner +Trevor Bekolay +Wouter van Ackooy +David Díaz-Barquero +Eric Hunsberger +Simon Gomizelj +Russel Winder +Ben Webb +Alexei Kozlenok +Cal Leeming diff --git a/testing/web-platform/tests/tools/pytest/CHANGELOG.rst b/testing/web-platform/tests/tools/pytest/CHANGELOG.rst new file mode 100644 index 000000000..f18f646f0 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/CHANGELOG.rst @@ -0,0 +1,2586 @@ +2.9.1 +===== + +**Bug Fixes** + +* Improve error message when a plugin fails to load. + Thanks `@nicoddemus`_ for the PR. + +* Fix (`#1178 <https://github.com/pytest-dev/pytest/issues/1178>`_): + ``pytest.fail`` with non-ascii characters raises an internal pytest error. + Thanks `@nicoddemus`_ for the PR. + +* Fix (`#469`_): junit parses report.nodeid incorrectly, when params IDs + contain ``::``. Thanks `@tomviner`_ for the PR (`#1431`_). + +* Fix (`#578 <https://github.com/pytest-dev/pytest/issues/578>`_): SyntaxErrors + containing non-ascii lines at the point of failure generated an internal + py.test error. + Thanks `@asottile`_ for the report and `@nicoddemus`_ for the PR. + +* Fix (`#1437`_): When passing in a bytestring regex pattern to parameterize + attempt to decode it as utf-8 ignoring errors. + +* Fix (`#649`_): parametrized test nodes cannot be specified to run on the command line. + + +.. _#1437: https://github.com/pytest-dev/pytest/issues/1437 +.. _#469: https://github.com/pytest-dev/pytest/issues/469 +.. _#1431: https://github.com/pytest-dev/pytest/pull/1431 +.. _#649: https://github.com/pytest-dev/pytest/issues/649 + +.. _@asottile: https://github.com/asottile + + +2.9.0 +===== + +**New Features** + +* New ``pytest.mark.skip`` mark, which unconditionally skips marked tests. + Thanks `@MichaelAquilina`_ for the complete PR (`#1040`_). + +* ``--doctest-glob`` may now be passed multiple times in the command-line. + Thanks `@jab`_ and `@nicoddemus`_ for the PR. + +* New ``-rp`` and ``-rP`` reporting options give the summary and full output + of passing tests, respectively. Thanks to `@codewarrior0`_ for the PR. + +* ``pytest.mark.xfail`` now has a ``strict`` option, which makes ``XPASS`` + tests to fail the test suite (defaulting to ``False``). There's also a + ``xfail_strict`` ini option that can be used to configure it project-wise. + Thanks `@rabbbit`_ for the request and `@nicoddemus`_ for the PR (`#1355`_). + +* ``Parser.addini`` now supports options of type ``bool``. + Thanks `@nicoddemus`_ for the PR. + +* New ``ALLOW_BYTES`` doctest option. This strips ``b`` prefixes from byte strings + in doctest output (similar to ``ALLOW_UNICODE``). + Thanks `@jaraco`_ for the request and `@nicoddemus`_ for the PR (`#1287`_). + +* Give a hint on ``KeyboardInterrupt`` to use the ``--fulltrace`` option to show the errors. + Fixes `#1366`_. + Thanks to `@hpk42`_ for the report and `@RonnyPfannschmidt`_ for the PR. + +* Catch ``IndexError`` exceptions when getting exception source location. + Fixes a pytest internal error for dynamically generated code (fixtures and tests) + where source lines are fake by intention. + +**Changes** + +* **Important**: `py.code <http://pylib.readthedocs.org/en/latest/code.html>`_ has been + merged into the ``pytest`` repository as ``pytest._code``. This decision + was made because ``py.code`` had very few uses outside ``pytest`` and the + fact that it was in a different repository made it difficult to fix bugs on + its code in a timely manner. The team hopes with this to be able to better + refactor out and improve that code. + This change shouldn't affect users, but it is useful to let users aware + if they encounter any strange behavior. + + Keep in mind that the code for ``pytest._code`` is **private** and + **experimental**, so you definitely should not import it explicitly! + + Please note that the original ``py.code`` is still available in + `pylib <http://pylib.readthedocs.org>`_. + +* ``pytest_enter_pdb`` now optionally receives the pytest config object. + Thanks `@nicoddemus`_ for the PR. + +* Removed code and documentation for Python 2.5 or lower versions, + including removal of the obsolete ``_pytest.assertion.oldinterpret`` module. + Thanks `@nicoddemus`_ for the PR (`#1226`_). + +* Comparisons now always show up in full when ``CI`` or ``BUILD_NUMBER`` is + found in the environment, even when ``-vv`` isn't used. + Thanks `@The-Compiler`_ for the PR. + +* ``--lf`` and ``--ff`` now support long names: ``--last-failed`` and + ``--failed-first`` respectively. + Thanks `@MichaelAquilina`_ for the PR. + +* Added expected exceptions to ``pytest.raises`` fail message. + +* Collection only displays progress ("collecting X items") when in a terminal. + This avoids cluttering the output when using ``--color=yes`` to obtain + colors in CI integrations systems (`#1397`_). + +**Bug Fixes** + +* The ``-s`` and ``-c`` options should now work under ``xdist``; + ``Config.fromdictargs`` now represents its input much more faithfully. + Thanks to `@bukzor`_ for the complete PR (`#680`_). + +* Fix (`#1290`_): support Python 3.5's ``@`` operator in assertion rewriting. + Thanks `@Shinkenjoe`_ for report with test case and `@tomviner`_ for the PR. + +* Fix formatting utf-8 explanation messages (`#1379`_). + Thanks `@biern`_ for the PR. + +* Fix `traceback style docs`_ to describe all of the available options + (auto/long/short/line/native/no), with `auto` being the default since v2.6. + Thanks `@hackebrot`_ for the PR. + +* Fix (`#1422`_): junit record_xml_property doesn't allow multiple records + with same name. + +.. _`traceback style docs`: https://pytest.org/latest/usage.html#modifying-python-traceback-printing + +.. _#1422: https://github.com/pytest-dev/pytest/issues/1422 +.. _#1379: https://github.com/pytest-dev/pytest/issues/1379 +.. _#1366: https://github.com/pytest-dev/pytest/issues/1366 +.. _#1040: https://github.com/pytest-dev/pytest/pull/1040 +.. _#680: https://github.com/pytest-dev/pytest/issues/680 +.. _#1287: https://github.com/pytest-dev/pytest/pull/1287 +.. _#1226: https://github.com/pytest-dev/pytest/pull/1226 +.. _#1290: https://github.com/pytest-dev/pytest/pull/1290 +.. _#1355: https://github.com/pytest-dev/pytest/pull/1355 +.. _#1397: https://github.com/pytest-dev/pytest/issues/1397 +.. _@biern: https://github.com/biern +.. _@MichaelAquilina: https://github.com/MichaelAquilina +.. _@bukzor: https://github.com/bukzor +.. _@hpk42: https://github.com/hpk42 +.. _@nicoddemus: https://github.com/nicoddemus +.. _@jab: https://github.com/jab +.. _@codewarrior0: https://github.com/codewarrior0 +.. _@jaraco: https://github.com/jaraco +.. _@The-Compiler: https://github.com/The-Compiler +.. _@Shinkenjoe: https://github.com/Shinkenjoe +.. _@tomviner: https://github.com/tomviner +.. _@RonnyPfannschmidt: https://github.com/RonnyPfannschmidt +.. _@rabbbit: https://github.com/rabbbit +.. _@hackebrot: https://github.com/hackebrot + +2.8.7 +===== + +- fix #1338: use predictable object resolution for monkeypatch + +2.8.6 +===== + +- fix #1259: allow for double nodeids in junitxml, + this was a regression failing plugins combinations + like pytest-pep8 + pytest-flakes + +- Workaround for exception that occurs in pyreadline when using + ``--pdb`` with standard I/O capture enabled. + Thanks Erik M. Bray for the PR. + +- fix #900: Better error message in case the target of a ``monkeypatch`` call + raises an ``ImportError``. + +- fix #1292: monkeypatch calls (setattr, setenv, etc.) are now O(1). + Thanks David R. MacIver for the report and Bruno Oliveira for the PR. + +- fix #1223: captured stdout and stderr are now properly displayed before + entering pdb when ``--pdb`` is used instead of being thrown away. + Thanks Cal Leeming for the PR. + +- fix #1305: pytest warnings emitted during ``pytest_terminal_summary`` are now + properly displayed. + Thanks Ionel Maries Cristian for the report and Bruno Oliveira for the PR. + +- fix #628: fixed internal UnicodeDecodeError when doctests contain unicode. + Thanks Jason R. Coombs for the report and Bruno Oliveira for the PR. + +- fix #1334: Add captured stdout to jUnit XML report on setup error. + Thanks Georgy Dyuldin for the PR. + + +2.8.5 +===== + +- fix #1243: fixed issue where class attributes injected during collection could break pytest. + PR by Alexei Kozlenok, thanks Ronny Pfannschmidt and Bruno Oliveira for the review and help. + +- fix #1074: precompute junitxml chunks instead of storing the whole tree in objects + Thanks Bruno Oliveira for the report and Ronny Pfannschmidt for the PR + +- fix #1238: fix ``pytest.deprecated_call()`` receiving multiple arguments + (Regression introduced in 2.8.4). Thanks Alex Gaynor for the report and + Bruno Oliveira for the PR. + + +2.8.4 +===== + +- fix #1190: ``deprecated_call()`` now works when the deprecated + function has been already called by another test in the same + module. Thanks Mikhail Chernykh for the report and Bruno Oliveira for the + PR. + +- fix #1198: ``--pastebin`` option now works on Python 3. Thanks + Mehdy Khoshnoody for the PR. + +- fix #1219: ``--pastebin`` now works correctly when captured output contains + non-ascii characters. Thanks Bruno Oliveira for the PR. + +- fix #1204: another error when collecting with a nasty __getattr__(). + Thanks Florian Bruhin for the PR. + +- fix the summary printed when no tests did run. + Thanks Florian Bruhin for the PR. +- fix #1185 - ensure MANIFEST.in exactly matches what should go to a sdist + +- a number of documentation modernizations wrt good practices. + Thanks Bruno Oliveira for the PR. + +2.8.3 +===== + +- fix #1169: add __name__ attribute to testcases in TestCaseFunction to + support the @unittest.skip decorator on functions and methods. + Thanks Lee Kamentsky for the PR. + +- fix #1035: collecting tests if test module level obj has __getattr__(). + Thanks Suor for the report and Bruno Oliveira / Tom Viner for the PR. + +- fix #331: don't collect tests if their failure cannot be reported correctly + e.g. they are a callable instance of a class. + +- fix #1133: fixed internal error when filtering tracebacks where one entry + belongs to a file which is no longer available. + Thanks Bruno Oliveira for the PR. + +- enhancement made to highlight in red the name of the failing tests so + they stand out in the output. + Thanks Gabriel Reis for the PR. + +- add more talks to the documentation +- extend documentation on the --ignore cli option +- use pytest-runner for setuptools integration +- minor fixes for interaction with OS X El Capitan + system integrity protection (thanks Florian) + + +2.8.2 +===== + +- fix #1085: proper handling of encoding errors when passing encoded byte + strings to pytest.parametrize in Python 2. + Thanks Themanwithoutaplan for the report and Bruno Oliveira for the PR. + +- fix #1087: handling SystemError when passing empty byte strings to + pytest.parametrize in Python 3. + Thanks Paul Kehrer for the report and Bruno Oliveira for the PR. + +- fix #995: fixed internal error when filtering tracebacks where one entry + was generated by an exec() statement. + Thanks Daniel Hahler, Ashley C Straw, Philippe Gauthier and Pavel Savchenko + for contributing and Bruno Oliveira for the PR. + +- fix #1100 and #1057: errors when using autouse fixtures and doctest modules. + Thanks Sergey B Kirpichev and Vital Kudzelka for contributing and Bruno + Oliveira for the PR. + +2.8.1 +===== + +- fix #1034: Add missing nodeid on pytest_logwarning call in + addhook. Thanks Simon Gomizelj for the PR. + +- 'deprecated_call' is now only satisfied with a DeprecationWarning or + PendingDeprecationWarning. Before 2.8.0, it accepted any warning, and 2.8.0 + made it accept only DeprecationWarning (but not PendingDeprecationWarning). + Thanks Alex Gaynor for the issue and Eric Hunsberger for the PR. + +- fix issue #1073: avoid calling __getattr__ on potential plugin objects. + This fixes an incompatibility with pytest-django. Thanks Andreas Pelme, + Bruno Oliveira and Ronny Pfannschmidt for contributing and Holger Krekel + for the fix. + +- Fix issue #704: handle versionconflict during plugin loading more + gracefully. Thanks Bruno Oliveira for the PR. + +- Fix issue #1064: ""--junitxml" regression when used with the + "pytest-xdist" plugin, with test reports being assigned to the wrong tests. + Thanks Daniel Grunwald for the report and Bruno Oliveira for the PR. + +- (experimental) adapt more SEMVER style versioning and change meaning of + master branch in git repo: "master" branch now keeps the bugfixes, changes + aimed for micro releases. "features" branch will only be be released + with minor or major pytest releases. + +- Fix issue #766 by removing documentation references to distutils. + Thanks Russel Winder. + +- Fix issue #1030: now byte-strings are escaped to produce item node ids + to make them always serializable. + Thanks Andy Freeland for the report and Bruno Oliveira for the PR. + +- Python 2: if unicode parametrized values are convertible to ascii, their + ascii representation is used for the node id. + +- Fix issue #411: Add __eq__ method to assertion comparison example. + Thanks Ben Webb. +- Fix issue #653: deprecated_call can be used as context manager. + +- fix issue 877: properly handle assertion explanations with non-ascii repr + Thanks Mathieu Agopian for the report and Ronny Pfannschmidt for the PR. + +- fix issue 1029: transform errors when writing cache values into pytest-warnings + +2.8.0 +===== + +- new ``--lf`` and ``-ff`` options to run only the last failing tests or + "failing tests first" from the last run. This functionality is provided + through porting the formerly external pytest-cache plugin into pytest core. + BACKWARD INCOMPAT: if you used pytest-cache's functionality to persist + data between test runs be aware that we don't serialize sets anymore. + Thanks Ronny Pfannschmidt for most of the merging work. + +- "-r" option now accepts "a" to include all possible reports, similar + to passing "fEsxXw" explicitly (isse960). + Thanks Abhijeet Kasurde for the PR. + +- avoid python3.5 deprecation warnings by introducing version + specific inspection helpers, thanks Michael Droettboom. + +- fix issue562: @nose.tools.istest now fully respected. + +- fix issue934: when string comparison fails and a diff is too large to display + without passing -vv, still show a few lines of the diff. + Thanks Florian Bruhin for the report and Bruno Oliveira for the PR. + +- fix issue736: Fix a bug where fixture params would be discarded when combined + with parametrization markers. + Thanks to Markus Unterwaditzer for the PR. + +- fix issue710: introduce ALLOW_UNICODE doctest option: when enabled, the + ``u`` prefix is stripped from unicode strings in expected doctest output. This + allows doctests which use unicode to run in Python 2 and 3 unchanged. + Thanks Jason R. Coombs for the report and Bruno Oliveira for the PR. + +- parametrize now also generates meaningful test IDs for enum, regex and class + objects (as opposed to class instances). + Thanks to Florian Bruhin for the PR. + +- Add 'warns' to assert that warnings are thrown (like 'raises'). + Thanks to Eric Hunsberger for the PR. + +- Fix issue683: Do not apply an already applied mark. Thanks ojake for the PR. + +- Deal with capturing failures better so fewer exceptions get lost to + /dev/null. Thanks David Szotten for the PR. + +- fix issue730: deprecate and warn about the --genscript option. + Thanks Ronny Pfannschmidt for the report and Christian Pommranz for the PR. + +- fix issue751: multiple parametrize with ids bug if it parametrizes class with + two or more test methods. Thanks Sergey Chipiga for reporting and Jan + Bednarik for PR. + +- fix issue82: avoid loading conftest files from setup.cfg/pytest.ini/tox.ini + files and upwards by default (--confcutdir can still be set to override this). + Thanks Bruno Oliveira for the PR. + +- fix issue768: docstrings found in python modules were not setting up session + fixtures. Thanks Jason R. Coombs for reporting and Bruno Oliveira for the PR. + +- added ``tmpdir_factory``, a session-scoped fixture that can be used to create + directories under the base temporary directory. Previously this object was + installed as a ``_tmpdirhandler`` attribute of the ``config`` object, but now it + is part of the official API and using ``config._tmpdirhandler`` is + deprecated. + Thanks Bruno Oliveira for the PR. + +- fix issue808: pytest's internal assertion rewrite hook now implements the + optional PEP302 get_data API so tests can access data files next to them. + Thanks xmo-odoo for request and example and Bruno Oliveira for + the PR. + +- rootdir and inifile are now displayed during usage errors to help + users diagnose problems such as unexpected ini files which add + unknown options being picked up by pytest. Thanks to Pavel Savchenko for + bringing the problem to attention in #821 and Bruno Oliveira for the PR. + +- Summary bar now is colored yellow for warning + situations such as: all tests either were skipped or xpass/xfailed, + or no tests were run at all (this is a partial fix for issue500). + +- fix issue812: pytest now exits with status code 5 in situations where no + tests were run at all, such as the directory given in the command line does + not contain any tests or as result of a command line option filters + all out all tests (-k for example). + Thanks Eric Siegerman (issue812) and Bruno Oliveira for the PR. + +- Summary bar now is colored yellow for warning + situations such as: all tests either were skipped or xpass/xfailed, + or no tests were run at all (related to issue500). + Thanks Eric Siegerman. + +- New ``testpaths`` ini option: list of directories to search for tests + when executing pytest from the root directory. This can be used + to speed up test collection when a project has well specified directories + for tests, being usually more practical than configuring norecursedirs for + all directories that do not contain tests. + Thanks to Adrian for idea (#694) and Bruno Oliveira for the PR. + +- fix issue713: JUnit XML reports for doctest failures. + Thanks Punyashloka Biswal. + +- fix issue970: internal pytest warnings now appear as "pytest-warnings" in + the terminal instead of "warnings", so it is clear for users that those + warnings are from pytest and not from the builtin "warnings" module. + Thanks Bruno Oliveira. + +- Include setup and teardown in junitxml test durations. + Thanks Janne Vanhala. + +- fix issue735: assertion failures on debug versions of Python 3.4+ + +- new option ``--import-mode`` to allow to change test module importing + behaviour to append to sys.path instead of prepending. This better allows + to run test modules against installated versions of a package even if the + package under test has the same import root. In this example:: + + testing/__init__.py + testing/test_pkg_under_test.py + pkg_under_test/ + + the tests will run against the installed version + of pkg_under_test when ``--import-mode=append`` is used whereas + by default they would always pick up the local version. Thanks Holger Krekel. + +- pytester: add method ``TmpTestdir.delete_loaded_modules()``, and call it + from ``inline_run()`` to allow temporary modules to be reloaded. + Thanks Eduardo Schettino. + +- internally refactor pluginmanager API and code so that there + is a clear distinction between a pytest-agnostic rather simple + pluginmanager and the PytestPluginManager which adds a lot of + behaviour, among it handling of the local conftest files. + In terms of documented methods this is a backward compatible + change but it might still break 3rd party plugins which relied on + details like especially the pluginmanager.add_shutdown() API. + Thanks Holger Krekel. + +- pluginmanagement: introduce ``pytest.hookimpl`` and + ``pytest.hookspec`` decorators for setting impl/spec + specific parameters. This substitutes the previous + now deprecated use of ``pytest.mark`` which is meant to + contain markers for test functions only. + +- write/refine docs for "writing plugins" which now have their + own page and are separate from the "using/installing plugins`` page. + +- fix issue732: properly unregister plugins from any hook calling + sites allowing to have temporary plugins during test execution. + +- deprecate and warn about ``__multicall__`` argument in hook + implementations. Use the ``hookwrapper`` mechanism instead already + introduced with pytest-2.7. + +- speed up pytest's own test suite considerably by using inprocess + tests by default (testrun can be modified with --runpytest=subprocess + to create subprocesses in many places instead). The main + APIs to run pytest in a test is "runpytest()" or "runpytest_subprocess" + and "runpytest_inprocess" if you need a particular way of running + the test. In all cases you get back a RunResult but the inprocess + one will also have a "reprec" attribute with the recorded events/reports. + +- fix monkeypatch.setattr("x.y", raising=False) to actually not raise + if "y" is not a pre-existing attribute. Thanks Florian Bruhin. + +- fix issue741: make running output from testdir.run copy/pasteable + Thanks Bruno Oliveira. + +- add a new ``--noconftest`` argument which ignores all ``conftest.py`` files. + +- add ``file`` and ``line`` attributes to JUnit-XML output. + +- fix issue890: changed extension of all documentation files from ``txt`` to + ``rst``. Thanks to Abhijeet for the PR. + +- fix issue714: add ability to apply indirect=True parameter on particular argnames. + Thanks Elizaveta239. + +- fix issue890: changed extension of all documentation files from ``txt`` to + ``rst``. Thanks to Abhijeet for the PR. + +- fix issue957: "# doctest: SKIP" option will now register doctests as SKIPPED + rather than PASSED. + Thanks Thomas Grainger for the report and Bruno Oliveira for the PR. + +- issue951: add new record_xml_property fixture, that supports logging + additional information on xml output. Thanks David Diaz for the PR. + +- issue949: paths after normal options (for example ``-s``, ``-v``, etc) are now + properly used to discover ``rootdir`` and ``ini`` files. + Thanks Peter Lauri for the report and Bruno Oliveira for the PR. + +2.7.3 (compared to 2.7.2) +============================= + +- Allow 'dev', 'rc', or other non-integer version strings in ``importorskip``. + Thanks to Eric Hunsberger for the PR. + +- fix issue856: consider --color parameter in all outputs (for example + --fixtures). Thanks Barney Gale for the report and Bruno Oliveira for the PR. + +- fix issue855: passing str objects as ``plugins`` argument to pytest.main + is now interpreted as a module name to be imported and registered as a + plugin, instead of silently having no effect. + Thanks xmo-odoo for the report and Bruno Oliveira for the PR. + +- fix issue744: fix for ast.Call changes in Python 3.5+. Thanks + Guido van Rossum, Matthias Bussonnier, Stefan Zimmermann and + Thomas Kluyver. + +- fix issue842: applying markers in classes no longer propagate this markers + to superclasses which also have markers. + Thanks xmo-odoo for the report and Bruno Oliveira for the PR. + +- preserve warning functions after call to pytest.deprecated_call. Thanks + Pieter Mulder for PR. + +- fix issue854: autouse yield_fixtures defined as class members of + unittest.TestCase subclasses now work as expected. + Thannks xmo-odoo for the report and Bruno Oliveira for the PR. + +- fix issue833: --fixtures now shows all fixtures of collected test files, instead of just the + fixtures declared on the first one. + Thanks Florian Bruhin for reporting and Bruno Oliveira for the PR. + +- fix issue863: skipped tests now report the correct reason when a skip/xfail + condition is met when using multiple markers. + Thanks Raphael Pierzina for reporting and Bruno Oliveira for the PR. + +- optimized tmpdir fixture initialization, which should make test sessions + faster (specially when using pytest-xdist). The only visible effect + is that now pytest uses a subdirectory in the $TEMP directory for all + directories created by this fixture (defaults to $TEMP/pytest-$USER). + Thanks Bruno Oliveira for the PR. + +2.7.2 (compared to 2.7.1) +============================= + +- fix issue767: pytest.raises value attribute does not contain the exception + instance on Python 2.6. Thanks Eric Siegerman for providing the test + case and Bruno Oliveira for PR. + +- Automatically create directory for junitxml and results log. + Thanks Aron Curzon. + +- fix issue713: JUnit XML reports for doctest failures. + Thanks Punyashloka Biswal. + +- fix issue735: assertion failures on debug versions of Python 3.4+ + Thanks Benjamin Peterson. + +- fix issue114: skipif marker reports to internal skipping plugin; + Thanks Floris Bruynooghe for reporting and Bruno Oliveira for the PR. + +- fix issue748: unittest.SkipTest reports to internal pytest unittest plugin. + Thanks Thomas De Schampheleire for reporting and Bruno Oliveira for the PR. + +- fix issue718: failed to create representation of sets containing unsortable + elements in python 2. Thanks Edison Gustavo Muenz. + +- fix issue756, fix issue752 (and similar issues): depend on py-1.4.29 + which has a refined algorithm for traceback generation. + + +2.7.1 (compared to 2.7.0) +============================= + +- fix issue731: do not get confused by the braces which may be present + and unbalanced in an object's repr while collapsing False + explanations. Thanks Carl Meyer for the report and test case. + +- fix issue553: properly handling inspect.getsourcelines failures in + FixtureLookupError which would lead to to an internal error, + obfuscating the original problem. Thanks talljosh for initial + diagnose/patch and Bruno Oliveira for final patch. + +- fix issue660: properly report scope-mismatch-access errors + independently from ordering of fixture arguments. Also + avoid the pytest internal traceback which does not provide + information to the user. Thanks Holger Krekel. + +- streamlined and documented release process. Also all versions + (in setup.py and documentation generation) are now read + from _pytest/__init__.py. Thanks Holger Krekel. + +- fixed docs to remove the notion that yield-fixtures are experimental. + They are here to stay :) Thanks Bruno Oliveira. + +- Support building wheels by using environment markers for the + requirements. Thanks Ionel Maries Cristian. + +- fixed regression to 2.6.4 which surfaced e.g. in lost stdout capture printing + when tests raised SystemExit. Thanks Holger Krekel. + +- reintroduced _pytest fixture of the pytester plugin which is used + at least by pytest-xdist. + +2.7.0 (compared to 2.6.4) +============================= + +- fix issue435: make reload() work when assert rewriting is active. + Thanks Daniel Hahler. + +- fix issue616: conftest.py files and their contained fixutres are now + properly considered for visibility, independently from the exact + current working directory and test arguments that are used. + Many thanks to Eric Siegerman and his PR235 which contains + systematic tests for conftest visibility and now passes. + This change also introduces the concept of a ``rootdir`` which + is printed as a new pytest header and documented in the pytest + customize web page. + +- change reporting of "diverted" tests, i.e. tests that are collected + in one file but actually come from another (e.g. when tests in a test class + come from a base class in a different file). We now show the nodeid + and indicate via a postfix the other file. + +- add ability to set command line options by environment variable PYTEST_ADDOPTS. + +- added documentation on the new pytest-dev teams on bitbucket and + github. See https://pytest.org/latest/contributing.html . + Thanks to Anatoly for pushing and initial work on this. + +- fix issue650: new option ``--docttest-ignore-import-errors`` which + will turn import errors in doctests into skips. Thanks Charles Cloud + for the complete PR. + +- fix issue655: work around different ways that cause python2/3 + to leak sys.exc_info into fixtures/tests causing failures in 3rd party code + +- fix issue615: assertion re-writing did not correctly escape % signs + when formatting boolean operations, which tripped over mixing + booleans with modulo operators. Thanks to Tom Viner for the report, + triaging and fix. + +- implement issue351: add ability to specify parametrize ids as a callable + to generate custom test ids. Thanks Brianna Laugher for the idea and + implementation. + +- introduce and document new hookwrapper mechanism useful for plugins + which want to wrap the execution of certain hooks for their purposes. + This supersedes the undocumented ``__multicall__`` protocol which + pytest itself and some external plugins use. Note that pytest-2.8 + is scheduled to drop supporting the old ``__multicall__`` + and only support the hookwrapper protocol. + +- majorly speed up invocation of plugin hooks + +- use hookwrapper mechanism in builtin pytest plugins. + +- add a doctest ini option for doctest flags, thanks Holger Peters. + +- add note to docs that if you want to mark a parameter and the + parameter is a callable, you also need to pass in a reason to disambiguate + it from the "decorator" case. Thanks Tom Viner. + +- "python_classes" and "python_functions" options now support glob-patterns + for test discovery, as discussed in issue600. Thanks Ldiary Translations. + +- allow to override parametrized fixtures with non-parametrized ones and vice versa (bubenkoff). + +- fix issue463: raise specific error for 'parameterize' misspelling (pfctdayelise). + +- On failure, the ``sys.last_value``, ``sys.last_type`` and + ``sys.last_traceback`` are set, so that a user can inspect the error + via postmortem debugging (almarklein). + +2.6.4 +===== + +- Improve assertion failure reporting on iterables, by using ndiff and + pprint. + +- removed outdated japanese docs from source tree. + +- docs for "pytest_addhooks" hook. Thanks Bruno Oliveira. + +- updated plugin index docs. Thanks Bruno Oliveira. + +- fix issue557: with "-k" we only allow the old style "-" for negation + at the beginning of strings and even that is deprecated. Use "not" instead. + This should allow to pick parametrized tests where "-" appeared in the parameter. + +- fix issue604: Escape % character in the assertion message. + +- fix issue620: add explanation in the --genscript target about what + the binary blob means. Thanks Dinu Gherman. + +- fix issue614: fixed pastebin support. + + +- fix issue620: add explanation in the --genscript target about what + the binary blob means. Thanks Dinu Gherman. + +- fix issue614: fixed pastebin support. + +2.6.3 +===== + +- fix issue575: xunit-xml was reporting collection errors as failures + instead of errors, thanks Oleg Sinyavskiy. + +- fix issue582: fix setuptools example, thanks Laszlo Papp and Ronny + Pfannschmidt. + +- Fix infinite recursion bug when pickling capture.EncodedFile, thanks + Uwe Schmitt. + +- fix issue589: fix bad interaction with numpy and others when showing + exceptions. Check for precise "maximum recursion depth exceed" exception + instead of presuming any RuntimeError is that one (implemented in py + dep). Thanks Charles Cloud for analysing the issue. + +- fix conftest related fixture visibility issue: when running with a + CWD outside a test package pytest would get fixture discovery wrong. + Thanks to Wolfgang Schnerring for figuring out a reproducable example. + +- Introduce pytest_enter_pdb hook (needed e.g. by pytest_timeout to cancel the + timeout when interactively entering pdb). Thanks Wolfgang Schnerring. + +- check xfail/skip also with non-python function test items. Thanks + Floris Bruynooghe. + +2.6.2 +===== + +- Added function pytest.freeze_includes(), which makes it easy to embed + pytest into executables using tools like cx_freeze. + See docs for examples and rationale. Thanks Bruno Oliveira. + +- Improve assertion rewriting cache invalidation precision. + +- fixed issue561: adapt autouse fixture example for python3. + +- fixed issue453: assertion rewriting issue with __repr__ containing + "\n{", "\n}" and "\n~". + +- fix issue560: correctly display code if an "else:" or "finally:" is + followed by statements on the same line. + +- Fix example in monkeypatch documentation, thanks t-8ch. + +- fix issue572: correct tmpdir doc example for python3. + +- Do not mark as universal wheel because Python 2.6 is different from + other builds due to the extra argparse dependency. Fixes issue566. + Thanks sontek. + +- Implement issue549: user-provided assertion messages now no longer + replace the py.test introspection message but are shown in addition + to them. + +2.6.1 +===== + +- No longer show line numbers in the --verbose output, the output is now + purely the nodeid. The line number is still shown in failure reports. + Thanks Floris Bruynooghe. + +- fix issue437 where assertion rewriting could cause pytest-xdist slaves + to collect different tests. Thanks Bruno Oliveira. + +- fix issue555: add "errors" attribute to capture-streams to satisfy + some distutils and possibly other code accessing sys.stdout.errors. + +- fix issue547 capsys/capfd also work when output capturing ("-s") is disabled. + +- address issue170: allow pytest.mark.xfail(...) to specify expected exceptions via + an optional "raises=EXC" argument where EXC can be a single exception + or a tuple of exception classes. Thanks David Mohr for the complete + PR. + +- fix integration of pytest with unittest.mock.patch decorator when + it uses the "new" argument. Thanks Nicolas Delaby for test and PR. + +- fix issue with detecting conftest files if the arguments contain + "::" node id specifications (copy pasted from "-v" output) + +- fix issue544 by only removing "@NUM" at the end of "::" separated parts + and if the part has an ".py" extension + +- don't use py.std import helper, rather import things directly. + Thanks Bruno Oliveira. + +2.6 +=== + +- Cache exceptions from fixtures according to their scope (issue 467). + +- fix issue537: Avoid importing old assertion reinterpretation code by default. + +- fix issue364: shorten and enhance tracebacks representation by default. + The new "--tb=auto" option (default) will only display long tracebacks + for the first and last entry. You can get the old behaviour of printing + all entries as long entries with "--tb=long". Also short entries by + default are now printed very similarly to "--tb=native" ones. + +- fix issue514: teach assertion reinterpretation about private class attributes + +- change -v output to include full node IDs of tests. Users can copy + a node ID from a test run, including line number, and use it as a + positional argument in order to run only a single test. + +- fix issue 475: fail early and comprehensible if calling + pytest.raises with wrong exception type. + +- fix issue516: tell in getting-started about current dependencies. + +- cleanup setup.py a bit and specify supported versions. Thanks Jurko + Gospodnetic for the PR. + +- change XPASS colour to yellow rather then red when tests are run + with -v. + +- fix issue473: work around mock putting an unbound method into a class + dict when double-patching. + +- fix issue498: if a fixture finalizer fails, make sure that + the fixture is still invalidated. + +- fix issue453: the result of the pytest_assertrepr_compare hook now gets + it's newlines escaped so that format_exception does not blow up. + +- internal new warning system: pytest will now produce warnings when + it detects oddities in your test collection or execution. + Warnings are ultimately sent to a new pytest_logwarning hook which is + currently only implemented by the terminal plugin which displays + warnings in the summary line and shows more details when -rw (report on + warnings) is specified. + +- change skips into warnings for test classes with an __init__ and + callables in test modules which look like a test but are not functions. + +- fix issue436: improved finding of initial conftest files from command + line arguments by using the result of parse_known_args rather than + the previous flaky heuristics. Thanks Marc Abramowitz for tests + and initial fixing approaches in this area. + +- fix issue #479: properly handle nose/unittest(2) SkipTest exceptions + during collection/loading of test modules. Thanks to Marc Schlaich + for the complete PR. + +- fix issue490: include pytest_load_initial_conftests in documentation + and improve docstring. + +- fix issue472: clarify that ``pytest.config.getvalue()`` cannot work + if it's triggered ahead of command line parsing. + +- merge PR123: improved integration with mock.patch decorator on tests. + +- fix issue412: messing with stdout/stderr FD-level streams is now + captured without crashes. + +- fix issue483: trial/py33 works now properly. Thanks Daniel Grana for PR. + +- improve example for pytest integration with "python setup.py test" + which now has a generic "-a" or "--pytest-args" option where you + can pass additional options as a quoted string. Thanks Trevor Bekolay. + +- simplified internal capturing mechanism and made it more robust + against tests or setups changing FD1/FD2, also better integrated + now with pytest.pdb() in single tests. + +- improvements to pytest's own test-suite leakage detection, courtesy of PRs + from Marc Abramowitz + +- fix issue492: avoid leak in test_writeorg. Thanks Marc Abramowitz. + +- fix issue493: don't run tests in doc directory with ``python setup.py test`` + (use tox -e doctesting for that) + +- fix issue486: better reporting and handling of early conftest loading failures + +- some cleanup and simplification of internal conftest handling. + +- work a bit harder to break reference cycles when catching exceptions. + Thanks Jurko Gospodnetic. + +- fix issue443: fix skip examples to use proper comparison. Thanks Alex + Groenholm. + +- support nose-style ``__test__`` attribute on modules, classes and + functions, including unittest-style Classes. If set to False, the + test will not be collected. + +- fix issue512: show "<notset>" for arguments which might not be set + in monkeypatch plugin. Improves output in documentation. + + +2.5.2 +===== + +- fix issue409 -- better interoperate with cx_freeze by not + trying to import from collections.abc which causes problems + for py27/cx_freeze. Thanks Wolfgang L. for reporting and tracking it down. + +- fixed docs and code to use "pytest" instead of "py.test" almost everywhere. + Thanks Jurko Gospodnetic for the complete PR. + +- fix issue425: mention at end of "py.test -h" that --markers + and --fixtures work according to specified test path (or current dir) + +- fix issue413: exceptions with unicode attributes are now printed + correctly also on python2 and with pytest-xdist runs. (the fix + requires py-1.4.20) + +- copy, cleanup and integrate py.io capture + from pylib 1.4.20.dev2 (rev 13d9af95547e) + +- address issue416: clarify docs as to conftest.py loading semantics + +- fix issue429: comparing byte strings with non-ascii chars in assert + expressions now work better. Thanks Floris Bruynooghe. + +- make capfd/capsys.capture private, its unused and shouldnt be exposed + + +2.5.1 +===== + +- merge new documentation styling PR from Tobias Bieniek. + +- fix issue403: allow parametrize of multiple same-name functions within + a collection node. Thanks Andreas Kloeckner and Alex Gaynor for reporting + and analysis. + +- Allow parameterized fixtures to specify the ID of the parameters by + adding an ids argument to pytest.fixture() and pytest.yield_fixture(). + Thanks Floris Bruynooghe. + +- fix issue404 by always using the binary xml escape in the junitxml + plugin. Thanks Ronny Pfannschmidt. + +- fix issue407: fix addoption docstring to point to argparse instead of + optparse. Thanks Daniel D. Wright. + + + +2.5.0 +===== + +- dropped python2.5 from automated release testing of pytest itself + which means it's probably going to break soon (but still works + with this release we believe). + +- simplified and fixed implementation for calling finalizers when + parametrized fixtures or function arguments are involved. finalization + is now performed lazily at setup time instead of in the "teardown phase". + While this might sound odd at first, it helps to ensure that we are + correctly handling setup/teardown even in complex code. User-level code + should not be affected unless it's implementing the pytest_runtest_teardown + hook and expecting certain fixture instances are torn down within (very + unlikely and would have been unreliable anyway). + +- PR90: add --color=yes|no|auto option to force terminal coloring + mode ("auto" is default). Thanks Marc Abramowitz. + +- fix issue319 - correctly show unicode in assertion errors. Many + thanks to Floris Bruynooghe for the complete PR. Also means + we depend on py>=1.4.19 now. + +- fix issue396 - correctly sort and finalize class-scoped parametrized + tests independently from number of methods on the class. + +- refix issue323 in a better way -- parametrization should now never + cause Runtime Recursion errors because the underlying algorithm + for re-ordering tests per-scope/per-fixture is not recursive + anymore (it was tail-call recursive before which could lead + to problems for more than >966 non-function scoped parameters). + +- fix issue290 - there is preliminary support now for parametrizing + with repeated same values (sometimes useful to to test if calling + a second time works as with the first time). + +- close issue240 - document precisely how pytest module importing + works, discuss the two common test directory layouts, and how it + interacts with PEP420-namespace packages. + +- fix issue246 fix finalizer order to be LIFO on independent fixtures + depending on a parametrized higher-than-function scoped fixture. + (was quite some effort so please bear with the complexity of this sentence :) + Thanks Ralph Schmitt for the precise failure example. + +- fix issue244 by implementing special index for parameters to only use + indices for paramentrized test ids + +- fix issue287 by running all finalizers but saving the exception + from the first failing finalizer and re-raising it so teardown will + still have failed. We reraise the first failing exception because + it might be the cause for other finalizers to fail. + +- fix ordering when mock.patch or other standard decorator-wrappings + are used with test methods. This fixues issue346 and should + help with random "xdist" collection failures. Thanks to + Ronny Pfannschmidt and Donald Stufft for helping to isolate it. + +- fix issue357 - special case "-k" expressions to allow for + filtering with simple strings that are not valid python expressions. + Examples: "-k 1.3" matches all tests parametrized with 1.3. + "-k None" filters all tests that have "None" in their name + and conversely "-k 'not None'". + Previously these examples would raise syntax errors. + +- fix issue384 by removing the trial support code + since the unittest compat enhancements allow + trial to handle it on its own + +- don't hide an ImportError when importing a plugin produces one. + fixes issue375. + +- fix issue275 - allow usefixtures and autouse fixtures + for running doctest text files. + +- fix issue380 by making --resultlog only rely on longrepr instead + of the "reprcrash" attribute which only exists sometimes. + +- address issue122: allow @pytest.fixture(params=iterator) by exploding + into a list early on. + +- fix pexpect-3.0 compatibility for pytest's own tests. + (fixes issue386) + +- allow nested parametrize-value markers, thanks James Lan for the PR. + +- fix unicode handling with new monkeypatch.setattr(import_path, value) + API. Thanks Rob Dennis. Fixes issue371. + +- fix unicode handling with junitxml, fixes issue368. + +- In assertion rewriting mode on Python 2, fix the detection of coding + cookies. See issue #330. + +- make "--runxfail" turn imperative pytest.xfail calls into no ops + (it already did neutralize pytest.mark.xfail markers) + +- refine pytest / pkg_resources interactions: The AssertionRewritingHook + PEP302 compliant loader now registers itself with setuptools/pkg_resources + properly so that the pkg_resources.resource_stream method works properly. + Fixes issue366. Thanks for the investigations and full PR to Jason R. Coombs. + +- pytestconfig fixture is now session-scoped as it is the same object during the + whole test run. Fixes issue370. + +- avoid one surprising case of marker malfunction/confusion:: + + @pytest.mark.some(lambda arg: ...) + def test_function(): + + would not work correctly because pytest assumes @pytest.mark.some + gets a function to be decorated already. We now at least detect if this + arg is an lambda and thus the example will work. Thanks Alex Gaynor + for bringing it up. + +- xfail a test on pypy that checks wrong encoding/ascii (pypy does + not error out). fixes issue385. + +- internally make varnames() deal with classes's __init__, + although it's not needed by pytest itself atm. Also + fix caching. Fixes issue376. + +- fix issue221 - handle importing of namespace-package with no + __init__.py properly. + +- refactor internal FixtureRequest handling to avoid monkeypatching. + One of the positive user-facing effects is that the "request" object + can now be used in closures. + +- fixed version comparison in pytest.importskip(modname, minverstring) + +- fix issue377 by clarifying in the nose-compat docs that pytest + does not duplicate the unittest-API into the "plain" namespace. + +- fix verbose reporting for @mock'd test functions + +2.4.2 +===== + +- on Windows require colorama and a newer py lib so that py.io.TerminalWriter() + now uses colorama instead of its own ctypes hacks. (fixes issue365) + thanks Paul Moore for bringing it up. + +- fix "-k" matching of tests where "repr" and "attr" and other names would + cause wrong matches because of an internal implementation quirk + (don't ask) which is now properly implemented. fixes issue345. + +- avoid tmpdir fixture to create too long filenames especially + when parametrization is used (issue354) + +- fix pytest-pep8 and pytest-flakes / pytest interactions + (collection names in mark plugin was assuming an item always + has a function which is not true for those plugins etc.) + Thanks Andi Zeidler. + +- introduce node.get_marker/node.add_marker API for plugins + like pytest-pep8 and pytest-flakes to avoid the messy + details of the node.keywords pseudo-dicts. Adapted + docs. + +- remove attempt to "dup" stdout at startup as it's icky. + the normal capturing should catch enough possibilities + of tests messing up standard FDs. + +- add pluginmanager.do_configure(config) as a link to + config.do_configure() for plugin-compatibility + +2.4.1 +===== + +- When using parser.addoption() unicode arguments to the + "type" keyword should also be converted to the respective types. + thanks Floris Bruynooghe, @dnozay. (fixes issue360 and issue362) + +- fix dotted filename completion when using argcomplete + thanks Anthon van der Neuth. (fixes issue361) + +- fix regression when a 1-tuple ("arg",) is used for specifying + parametrization (the values of the parametrization were passed + nested in a tuple). Thanks Donald Stufft. + +- merge doc typo fixes, thanks Andy Dirnberger + +2.4 +=== + +known incompatibilities: + +- if calling --genscript from python2.7 or above, you only get a + standalone script which works on python2.7 or above. Use Python2.6 + to also get a python2.5 compatible version. + +- all xunit-style teardown methods (nose-style, pytest-style, + unittest-style) will not be called if the corresponding setup method failed, + see issue322 below. + +- the pytest_plugin_unregister hook wasn't ever properly called + and there is no known implementation of the hook - so it got removed. + +- pytest.fixture-decorated functions cannot be generators (i.e. use + yield) anymore. This change might be reversed in 2.4.1 if it causes + unforeseen real-life issues. However, you can always write and return + an inner function/generator and change the fixture consumer to iterate + over the returned generator. This change was done in lieu of the new + ``pytest.yield_fixture`` decorator, see below. + +new features: + +- experimentally introduce a new ``pytest.yield_fixture`` decorator + which accepts exactly the same parameters as pytest.fixture but + mandates a ``yield`` statement instead of a ``return statement`` from + fixture functions. This allows direct integration with "with-style" + context managers in fixture functions and generally avoids registering + of finalization callbacks in favour of treating the "after-yield" as + teardown code. Thanks Andreas Pelme, Vladimir Keleshev, Floris + Bruynooghe, Ronny Pfannschmidt and many others for discussions. + +- allow boolean expression directly with skipif/xfail + if a "reason" is also specified. Rework skipping documentation + to recommend "condition as booleans" because it prevents surprises + when importing markers between modules. Specifying conditions + as strings will remain fully supported. + +- reporting: color the last line red or green depending if + failures/errors occurred or everything passed. thanks Christian + Theunert. + +- make "import pdb ; pdb.set_trace()" work natively wrt capturing (no + "-s" needed anymore), making ``pytest.set_trace()`` a mere shortcut. + +- fix issue181: --pdb now also works on collect errors (and + on internal errors) . This was implemented by a slight internal + refactoring and the introduction of a new hook + ``pytest_exception_interact`` hook (see next item). + +- fix issue341: introduce new experimental hook for IDEs/terminals to + intercept debugging: ``pytest_exception_interact(node, call, report)``. + +- new monkeypatch.setattr() variant to provide a shorter + invocation for patching out classes/functions from modules: + + monkeypatch.setattr("requests.get", myfunc) + + will replace the "get" function of the "requests" module with ``myfunc``. + +- fix issue322: tearDownClass is not run if setUpClass failed. Thanks + Mathieu Agopian for the initial fix. Also make all of pytest/nose + finalizer mimick the same generic behaviour: if a setupX exists and + fails, don't run teardownX. This internally introduces a new method + "node.addfinalizer()" helper which can only be called during the setup + phase of a node. + +- simplify pytest.mark.parametrize() signature: allow to pass a + CSV-separated string to specify argnames. For example: + ``pytest.mark.parametrize("input,expected", [(1,2), (2,3)])`` + works as well as the previous: + ``pytest.mark.parametrize(("input", "expected"), ...)``. + +- add support for setUpModule/tearDownModule detection, thanks Brian Okken. + +- integrate tab-completion on options through use of "argcomplete". + Thanks Anthon van der Neut for the PR. + +- change option names to be hyphen-separated long options but keep the + old spelling backward compatible. py.test -h will only show the + hyphenated version, for example "--collect-only" but "--collectonly" + will remain valid as well (for backward-compat reasons). Many thanks to + Anthon van der Neut for the implementation and to Hynek Schlawack for + pushing us. + +- fix issue 308 - allow to mark/xfail/skip individual parameter sets + when parametrizing. Thanks Brianna Laugher. + +- call new experimental pytest_load_initial_conftests hook to allow + 3rd party plugins to do something before a conftest is loaded. + +Bug fixes: + +- fix issue358 - capturing options are now parsed more properly + by using a new parser.parse_known_args method. + +- pytest now uses argparse instead of optparse (thanks Anthon) which + means that "argparse" is added as a dependency if installing into python2.6 + environments or below. + +- fix issue333: fix a case of bad unittest/pytest hook interaction. + +- PR27: correctly handle nose.SkipTest during collection. Thanks + Antonio Cuni, Ronny Pfannschmidt. + +- fix issue355: junitxml puts name="pytest" attribute to testsuite tag. + +- fix issue336: autouse fixture in plugins should work again. + +- fix issue279: improve object comparisons on assertion failure + for standard datatypes and recognise collections.abc. Thanks to + Brianna Laugher and Mathieu Agopian. + +- fix issue317: assertion rewriter support for the is_package method + +- fix issue335: document py.code.ExceptionInfo() object returned + from pytest.raises(), thanks Mathieu Agopian. + +- remove implicit distribute_setup support from setup.py. + +- fix issue305: ignore any problems when writing pyc files. + +- SO-17664702: call fixture finalizers even if the fixture function + partially failed (finalizers would not always be called before) + +- fix issue320 - fix class scope for fixtures when mixed with + module-level functions. Thanks Anatloy Bubenkoff. + +- you can specify "-q" or "-qq" to get different levels of "quieter" + reporting (thanks Katarzyna Jachim) + +- fix issue300 - Fix order of conftest loading when starting py.test + in a subdirectory. + +- fix issue323 - sorting of many module-scoped arg parametrizations + +- make sessionfinish hooks execute with the same cwd-context as at + session start (helps fix plugin behaviour which write output files + with relative path such as pytest-cov) + +- fix issue316 - properly reference collection hooks in docs + +- fix issue 306 - cleanup of -k/-m options to only match markers/test + names/keywords respectively. Thanks Wouter van Ackooy. + +- improved doctest counting for doctests in python modules -- + files without any doctest items will not show up anymore + and doctest examples are counted as separate test items. + thanks Danilo Bellini. + +- fix issue245 by depending on the released py-1.4.14 + which fixes py.io.dupfile to work with files with no + mode. Thanks Jason R. Coombs. + +- fix junitxml generation when test output contains control characters, + addressing issue267, thanks Jaap Broekhuizen + +- fix issue338: honor --tb style for setup/teardown errors as well. Thanks Maho. + +- fix issue307 - use yaml.safe_load in example, thanks Mark Eichin. + +- better parametrize error messages, thanks Brianna Laugher + +- pytest_terminal_summary(terminalreporter) hooks can now use + ".section(title)" and ".line(msg)" methods to print extra + information at the end of a test run. + +2.3.5 +===== + +- fix issue169: respect --tb=style with setup/teardown errors as well. + +- never consider a fixture function for test function collection + +- allow re-running of test items / helps to fix pytest-reruntests plugin + and also help to keep less fixture/resource references alive + +- put captured stdout/stderr into junitxml output even for passing tests + (thanks Adam Goucher) + +- Issue 265 - integrate nose setup/teardown with setupstate + so it doesnt try to teardown if it did not setup + +- issue 271 - dont write junitxml on slave nodes + +- Issue 274 - dont try to show full doctest example + when doctest does not know the example location + +- issue 280 - disable assertion rewriting on buggy CPython 2.6.0 + +- inject "getfixture()" helper to retrieve fixtures from doctests, + thanks Andreas Zeidler + +- issue 259 - when assertion rewriting, be consistent with the default + source encoding of ASCII on Python 2 + +- issue 251 - report a skip instead of ignoring classes with init + +- issue250 unicode/str mixes in parametrization names and values now works + +- issue257, assertion-triggered compilation of source ending in a + comment line doesn't blow up in python2.5 (fixed through py>=1.4.13.dev6) + +- fix --genscript option to generate standalone scripts that also + work with python3.3 (importer ordering) + +- issue171 - in assertion rewriting, show the repr of some + global variables + +- fix option help for "-k" + +- move long description of distribution into README.rst + +- improve docstring for metafunc.parametrize() + +- fix bug where using capsys with pytest.set_trace() in a test + function would break when looking at capsys.readouterr() + +- allow to specify prefixes starting with "_" when + customizing python_functions test discovery. (thanks Graham Horler) + +- improve PYTEST_DEBUG tracing output by puting + extra data on a new lines with additional indent + +- ensure OutcomeExceptions like skip/fail have initialized exception attributes + +- issue 260 - don't use nose special setup on plain unittest cases + +- fix issue134 - print the collect errors that prevent running specified test items + +- fix issue266 - accept unicode in MarkEvaluator expressions + +2.3.4 +===== + +- yielded test functions will now have autouse-fixtures active but + cannot accept fixtures as funcargs - it's anyway recommended to + rather use the post-2.0 parametrize features instead of yield, see: + http://pytest.org/latest/example/parametrize.html +- fix autouse-issue where autouse-fixtures would not be discovered + if defined in a a/conftest.py file and tests in a/tests/test_some.py +- fix issue226 - LIFO ordering for fixture teardowns +- fix issue224 - invocations with >256 char arguments now work +- fix issue91 - add/discuss package/directory level setups in example +- allow to dynamically define markers via + item.keywords[...]=assignment integrating with "-m" option +- make "-k" accept an expressions the same as with "-m" so that one + can write: -k "name1 or name2" etc. This is a slight incompatibility + if you used special syntax like "TestClass.test_method" which you now + need to write as -k "TestClass and test_method" to match a certain + method in a certain test class. + +2.3.3 +===== + +- fix issue214 - parse modules that contain special objects like e. g. + flask's request object which blows up on getattr access if no request + is active. thanks Thomas Waldmann. + +- fix issue213 - allow to parametrize with values like numpy arrays that + do not support an __eq__ operator + +- fix issue215 - split test_python.org into multiple files + +- fix issue148 - @unittest.skip on classes is now recognized and avoids + calling setUpClass/tearDownClass, thanks Pavel Repin + +- fix issue209 - reintroduce python2.4 support by depending on newer + pylib which re-introduced statement-finding for pre-AST interpreters + +- nose support: only call setup if its a callable, thanks Andrew + Taumoefolau + +- fix issue219 - add py2.4-3.3 classifiers to TROVE list + +- in tracebacks *,** arg values are now shown next to normal arguments + (thanks Manuel Jacob) + +- fix issue217 - support mock.patch with pytest's fixtures - note that + you need either mock-1.0.1 or the python3.3 builtin unittest.mock. + +- fix issue127 - improve documentation for pytest_addoption() and + add a ``config.getoption(name)`` helper function for consistency. + +2.3.2 +===== + +- fix issue208 and fix issue29 use new py version to avoid long pauses + when printing tracebacks in long modules + +- fix issue205 - conftests in subdirs customizing + pytest_pycollect_makemodule and pytest_pycollect_makeitem + now work properly + +- fix teardown-ordering for parametrized setups + +- fix issue127 - better documentation for pytest_addoption + and related objects. + +- fix unittest behaviour: TestCase.runtest only called if there are + test methods defined + +- improve trial support: don't collect its empty + unittest.TestCase.runTest() method + +- "python setup.py test" now works with pytest itself + +- fix/improve internal/packaging related bits: + + - exception message check of test_nose.py now passes on python33 as well + + - issue206 - fix test_assertrewrite.py to work when a global + PYTHONDONTWRITEBYTECODE=1 is present + + - add tox.ini to pytest distribution so that ignore-dirs and others config + bits are properly distributed for maintainers who run pytest-own tests + +2.3.1 +===== + +- fix issue202 - fix regression: using "self" from fixture functions now + works as expected (it's the same "self" instance that a test method + which uses the fixture sees) + +- skip pexpect using tests (test_pdb.py mostly) on freebsd* systems + due to pexpect not supporting it properly (hanging) + +- link to web pages from --markers output which provides help for + pytest.mark.* usage. + +2.3.0 +===== + +- fix issue202 - better automatic names for parametrized test functions +- fix issue139 - introduce @pytest.fixture which allows direct scoping + and parametrization of funcarg factories. +- fix issue198 - conftest fixtures were not found on windows32 in some + circumstances with nested directory structures due to path manipulation issues +- fix issue193 skip test functions with were parametrized with empty + parameter sets +- fix python3.3 compat, mostly reporting bits that previously depended + on dict ordering +- introduce re-ordering of tests by resource and parametrization setup + which takes precedence to the usual file-ordering +- fix issue185 monkeypatching time.time does not cause pytest to fail +- fix issue172 duplicate call of pytest.fixture decoratored setup_module + functions +- fix junitxml=path construction so that if tests change the + current working directory and the path is a relative path + it is constructed correctly from the original current working dir. +- fix "python setup.py test" example to cause a proper "errno" return +- fix issue165 - fix broken doc links and mention stackoverflow for FAQ +- catch unicode-issues when writing failure representations + to terminal to prevent the whole session from crashing +- fix xfail/skip confusion: a skip-mark or an imperative pytest.skip + will now take precedence before xfail-markers because we + can't determine xfail/xpass status in case of a skip. see also: + http://stackoverflow.com/questions/11105828/in-py-test-when-i-explicitly-skip-a-test-that-is-marked-as-xfail-how-can-i-get + +- always report installed 3rd party plugins in the header of a test run + +- fix issue160: a failing setup of an xfail-marked tests should + be reported as xfail (not xpass) + +- fix issue128: show captured output when capsys/capfd are used + +- fix issue179: propperly show the dependency chain of factories + +- pluginmanager.register(...) now raises ValueError if the + plugin has been already registered or the name is taken + +- fix issue159: improve http://pytest.org/latest/faq.html + especially with respect to the "magic" history, also mention + pytest-django, trial and unittest integration. + +- make request.keywords and node.keywords writable. All descendant + collection nodes will see keyword values. Keywords are dictionaries + containing markers and other info. + +- fix issue 178: xml binary escapes are now wrapped in py.xml.raw + +- fix issue 176: correctly catch the builtin AssertionError + even when we replaced AssertionError with a subclass on the + python level + +- factory discovery no longer fails with magic global callables + that provide no sane __code__ object (mock.call for example) + +- fix issue 182: testdir.inprocess_run now considers passed plugins + +- fix issue 188: ensure sys.exc_info is clear on python2 + before calling into a test + +- fix issue 191: add unittest TestCase runTest method support +- fix issue 156: monkeypatch correctly handles class level descriptors + +- reporting refinements: + + - pytest_report_header now receives a "startdir" so that + you can use startdir.bestrelpath(yourpath) to show + nice relative path + + - allow plugins to implement both pytest_report_header and + pytest_sessionstart (sessionstart is invoked first). + + - don't show deselected reason line if there is none + + - py.test -vv will show all of assert comparisations instead of truncating + +2.2.4 +===== + +- fix error message for rewritten assertions involving the % operator +- fix issue 126: correctly match all invalid xml characters for junitxml + binary escape +- fix issue with unittest: now @unittest.expectedFailure markers should + be processed correctly (you can also use @pytest.mark markers) +- document integration with the extended distribute/setuptools test commands +- fix issue 140: propperly get the real functions + of bound classmethods for setup/teardown_class +- fix issue #141: switch from the deceased paste.pocoo.org to bpaste.net +- fix issue #143: call unconfigure/sessionfinish always when + configure/sessionstart where called +- fix issue #144: better mangle test ids to junitxml classnames +- upgrade distribute_setup.py to 0.6.27 + +2.2.3 +===== + +- fix uploaded package to only include neccesary files + +2.2.2 +===== + +- fix issue101: wrong args to unittest.TestCase test function now + produce better output +- fix issue102: report more useful errors and hints for when a + test directory was renamed and some pyc/__pycache__ remain +- fix issue106: allow parametrize to be applied multiple times + e.g. from module, class and at function level. +- fix issue107: actually perform session scope finalization +- don't check in parametrize if indirect parameters are funcarg names +- add chdir method to monkeypatch funcarg +- fix crash resulting from calling monkeypatch undo a second time +- fix issue115: make --collectonly robust against early failure + (missing files/directories) +- "-qq --collectonly" now shows only files and the number of tests in them +- "-q --collectonly" now shows test ids +- allow adding of attributes to test reports such that it also works + with distributed testing (no upgrade of pytest-xdist needed) + +2.2.1 +===== + +- fix issue99 (in pytest and py) internallerrors with resultlog now + produce better output - fixed by normalizing pytest_internalerror + input arguments. +- fix issue97 / traceback issues (in pytest and py) improve traceback output + in conjunction with jinja2 and cython which hack tracebacks +- fix issue93 (in pytest and pytest-xdist) avoid "delayed teardowns": + the final test in a test node will now run its teardown directly + instead of waiting for the end of the session. Thanks Dave Hunt for + the good reporting and feedback. The pytest_runtest_protocol as well + as the pytest_runtest_teardown hooks now have "nextitem" available + which will be None indicating the end of the test run. +- fix collection crash due to unknown-source collected items, thanks + to Ralf Schmitt (fixed by depending on a more recent pylib) + +2.2.0 +===== + +- fix issue90: introduce eager tearing down of test items so that + teardown function are called earlier. +- add an all-powerful metafunc.parametrize function which allows to + parametrize test function arguments in multiple steps and therefore + from indepdenent plugins and palces. +- add a @pytest.mark.parametrize helper which allows to easily + call a test function with different argument values +- Add examples to the "parametrize" example page, including a quick port + of Test scenarios and the new parametrize function and decorator. +- introduce registration for "pytest.mark.*" helpers via ini-files + or through plugin hooks. Also introduce a "--strict" option which + will treat unregistered markers as errors + allowing to avoid typos and maintain a well described set of markers + for your test suite. See exaples at http://pytest.org/latest/mark.html + and its links. +- issue50: introduce "-m marker" option to select tests based on markers + (this is a stricter and more predictable version of '-k' in that "-m" + only matches complete markers and has more obvious rules for and/or + semantics. +- new feature to help optimizing the speed of your tests: + --durations=N option for displaying N slowest test calls + and setup/teardown methods. +- fix issue87: --pastebin now works with python3 +- fix issue89: --pdb with unexpected exceptions in doctest work more sensibly +- fix and cleanup pytest's own test suite to not leak FDs +- fix issue83: link to generated funcarg list +- fix issue74: pyarg module names are now checked against imp.find_module false positives +- fix compatibility with twisted/trial-11.1.0 use cases +- simplify Node.listchain +- simplify junitxml output code by relying on py.xml +- add support for skip properties on unittest classes and functions + +2.1.3 +===== + +- fix issue79: assertion rewriting failed on some comparisons in boolops +- correctly handle zero length arguments (a la pytest '') +- fix issue67 / junitxml now contains correct test durations, thanks ronny +- fix issue75 / skipping test failure on jython +- fix issue77 / Allow assertrepr_compare hook to apply to a subset of tests + +2.1.2 +===== + +- fix assertion rewriting on files with windows newlines on some Python versions +- refine test discovery by package/module name (--pyargs), thanks Florian Mayer +- fix issue69 / assertion rewriting fixed on some boolean operations +- fix issue68 / packages now work with assertion rewriting +- fix issue66: use different assertion rewriting caches when the -O option is passed +- don't try assertion rewriting on Jython, use reinterp + +2.1.1 +===== + +- fix issue64 / pytest.set_trace now works within pytest_generate_tests hooks +- fix issue60 / fix error conditions involving the creation of __pycache__ +- fix issue63 / assertion rewriting on inserts involving strings containing '%' +- fix assertion rewriting on calls with a ** arg +- don't cache rewritten modules if bytecode generation is disabled +- fix assertion rewriting in read-only directories +- fix issue59: provide system-out/err tags for junitxml output +- fix issue61: assertion rewriting on boolean operations with 3 or more operands +- you can now build a man page with "cd doc ; make man" + +2.1.0 +===== + +- fix issue53 call nosestyle setup functions with correct ordering +- fix issue58 and issue59: new assertion code fixes +- merge Benjamin's assertionrewrite branch: now assertions + for test modules on python 2.6 and above are done by rewriting + the AST and saving the pyc file before the test module is imported. + see doc/assert.txt for more info. +- fix issue43: improve doctests with better traceback reporting on + unexpected exceptions +- fix issue47: timing output in junitxml for test cases is now correct +- fix issue48: typo in MarkInfo repr leading to exception +- fix issue49: avoid confusing error when initizaliation partially fails +- fix issue44: env/username expansion for junitxml file path +- show releaselevel information in test runs for pypy +- reworked doc pages for better navigation and PDF generation +- report KeyboardInterrupt even if interrupted during session startup +- fix issue 35 - provide PDF doc version and download link from index page + +2.0.3 +===== + +- fix issue38: nicer tracebacks on calls to hooks, particularly early + configure/sessionstart ones + +- fix missing skip reason/meta information in junitxml files, reported + via http://lists.idyll.org/pipermail/testing-in-python/2011-March/003928.html + +- fix issue34: avoid collection failure with "test" prefixed classes + deriving from object. + +- don't require zlib (and other libs) for genscript plugin without + --genscript actually being used. + +- speed up skips (by not doing a full traceback represenation + internally) + +- fix issue37: avoid invalid characters in junitxml's output + +2.0.2 +===== + +- tackle issue32 - speed up test runs of very quick test functions + by reducing the relative overhead + +- fix issue30 - extended xfail/skipif handling and improved reporting. + If you have a syntax error in your skip/xfail + expressions you now get nice error reports. + + Also you can now access module globals from xfail/skipif + expressions so that this for example works now:: + + import pytest + import mymodule + @pytest.mark.skipif("mymodule.__version__[0] == "1") + def test_function(): + pass + + This will not run the test function if the module's version string + does not start with a "1". Note that specifying a string instead + of a boolean expressions allows py.test to report meaningful information + when summarizing a test run as to what conditions lead to skipping + (or xfail-ing) tests. + +- fix issue28 - setup_method and pytest_generate_tests work together + The setup_method fixture method now gets called also for + test function invocations generated from the pytest_generate_tests + hook. + +- fix issue27 - collectonly and keyword-selection (-k) now work together + Also, if you do "py.test --collectonly -q" you now get a flat list + of test ids that you can use to paste to the py.test commandline + in order to execute a particular test. + +- fix issue25 avoid reported problems with --pdb and python3.2/encodings output + +- fix issue23 - tmpdir argument now works on Python3.2 and WindowsXP + Starting with Python3.2 os.symlink may be supported. By requiring + a newer py lib version the py.path.local() implementation acknowledges + this. + +- fixed typos in the docs (thanks Victor Garcia, Brianna Laugher) and particular + thanks to Laura Creighton who also revieved parts of the documentation. + +- fix slighly wrong output of verbose progress reporting for classes + (thanks Amaury) + +- more precise (avoiding of) deprecation warnings for node.Class|Function accesses + +- avoid std unittest assertion helper code in tracebacks (thanks Ronny) + +2.0.1 +===== + +- refine and unify initial capturing so that it works nicely + even if the logging module is used on an early-loaded conftest.py + file or plugin. +- allow to omit "()" in test ids to allow for uniform test ids + as produced by Alfredo's nice pytest.vim plugin. +- fix issue12 - show plugin versions with "--version" and + "--traceconfig" and also document how to add extra information + to reporting test header +- fix issue17 (import-* reporting issue on python3) by + requiring py>1.4.0 (1.4.1 is going to include it) +- fix issue10 (numpy arrays truth checking) by refining + assertion interpretation in py lib +- fix issue15: make nose compatibility tests compatible + with python3 (now that nose-1.0 supports python3) +- remove somewhat surprising "same-conftest" detection because + it ignores conftest.py when they appear in several subdirs. +- improve assertions ("not in"), thanks Floris Bruynooghe +- improve behaviour/warnings when running on top of "python -OO" + (assertions and docstrings are turned off, leading to potential + false positives) +- introduce a pytest_cmdline_processargs(args) hook + to allow dynamic computation of command line arguments. + This fixes a regression because py.test prior to 2.0 + allowed to set command line options from conftest.py + files which so far pytest-2.0 only allowed from ini-files now. +- fix issue7: assert failures in doctest modules. + unexpected failures in doctests will not generally + show nicer, i.e. within the doctest failing context. +- fix issue9: setup/teardown functions for an xfail-marked + test will report as xfail if they fail but report as normally + passing (not xpassing) if they succeed. This only is true + for "direct" setup/teardown invocations because teardown_class/ + teardown_module cannot closely relate to a single test. +- fix issue14: no logging errors at process exit +- refinements to "collecting" output on non-ttys +- refine internal plugin registration and --traceconfig output +- introduce a mechanism to prevent/unregister plugins from the + command line, see http://pytest.org/plugins.html#cmdunregister +- activate resultlog plugin by default +- fix regression wrt yielded tests which due to the + collection-before-running semantics were not + setup as with pytest 1.3.4. Note, however, that + the recommended and much cleaner way to do test + parametraization remains the "pytest_generate_tests" + mechanism, see the docs. + +2.0.0 +===== + +- pytest-2.0 is now its own package and depends on pylib-2.0 +- new ability: python -m pytest / python -m pytest.main ability +- new python invcation: pytest.main(args, plugins) to load + some custom plugins early. +- try harder to run unittest test suites in a more compatible manner + by deferring setup/teardown semantics to the unittest package. + also work harder to run twisted/trial and Django tests which + should now basically work by default. +- introduce a new way to set config options via ini-style files, + by default setup.cfg and tox.ini files are searched. The old + ways (certain environment variables, dynamic conftest.py reading + is removed). +- add a new "-q" option which decreases verbosity and prints a more + nose/unittest-style "dot" output. +- fix issue135 - marks now work with unittest test cases as well +- fix issue126 - introduce py.test.set_trace() to trace execution via + PDB during the running of tests even if capturing is ongoing. +- fix issue123 - new "python -m py.test" invocation for py.test + (requires Python 2.5 or above) +- fix issue124 - make reporting more resilient against tests opening + files on filedescriptor 1 (stdout). +- fix issue109 - sibling conftest.py files will not be loaded. + (and Directory collectors cannot be customized anymore from a Directory's + conftest.py - this needs to happen at least one level up). +- introduce (customizable) assertion failure representations and enhance + output on assertion failures for comparisons and other cases (Floris Bruynooghe) +- nose-plugin: pass through type-signature failures in setup/teardown + functions instead of not calling them (Ed Singleton) +- remove py.test.collect.Directory (follows from a major refactoring + and simplification of the collection process) +- majorly reduce py.test core code, shift function/python testing to own plugin +- fix issue88 (finding custom test nodes from command line arg) +- refine 'tmpdir' creation, will now create basenames better associated + with test names (thanks Ronny) +- "xpass" (unexpected pass) tests don't cause exitcode!=0 +- fix issue131 / issue60 - importing doctests in __init__ files used as namespace packages +- fix issue93 stdout/stderr is captured while importing conftest.py +- fix bug: unittest collected functions now also can have "pytestmark" + applied at class/module level +- add ability to use "class" level for cached_setup helper +- fix strangeness: mark.* objects are now immutable, create new instances + +1.3.4 +===== + +- fix issue111: improve install documentation for windows +- fix issue119: fix custom collectability of __init__.py as a module +- fix issue116: --doctestmodules work with __init__.py files as well +- fix issue115: unify internal exception passthrough/catching/GeneratorExit +- fix issue118: new --tb=native for presenting cpython-standard exceptions + +1.3.3 +===== + +- fix issue113: assertion representation problem with triple-quoted strings + (and possibly other cases) +- make conftest loading detect that a conftest file with the same + content was already loaded, avoids surprises in nested directory structures + which can be produced e.g. by Hudson. It probably removes the need to use + --confcutdir in most cases. +- fix terminal coloring for win32 + (thanks Michael Foord for reporting) +- fix weirdness: make terminal width detection work on stdout instead of stdin + (thanks Armin Ronacher for reporting) +- remove trailing whitespace in all py/text distribution files + +1.3.2 +===== + +**New features** + +- fix issue103: introduce py.test.raises as context manager, examples:: + + with py.test.raises(ZeroDivisionError): + x = 0 + 1 / x + + with py.test.raises(RuntimeError) as excinfo: + call_something() + + # you may do extra checks on excinfo.value|type|traceback here + + (thanks Ronny Pfannschmidt) + +- Funcarg factories can now dynamically apply a marker to a + test invocation. This is for example useful if a factory + provides parameters to a test which are expected-to-fail:: + + def pytest_funcarg__arg(request): + request.applymarker(py.test.mark.xfail(reason="flaky config")) + ... + + def test_function(arg): + ... + +- improved error reporting on collection and import errors. This makes + use of a more general mechanism, namely that for custom test item/collect + nodes ``node.repr_failure(excinfo)`` is now uniformly called so that you can + override it to return a string error representation of your choice + which is going to be reported as a (red) string. + +- introduce '--junitprefix=STR' option to prepend a prefix + to all reports in the junitxml file. + +**Bug fixes** + +- make tests and the ``pytest_recwarn`` plugin in particular fully compatible + to Python2.7 (if you use the ``recwarn`` funcarg warnings will be enabled so that + you can properly check for their existence in a cross-python manner). +- refine --pdb: ignore xfailed tests, unify its TB-reporting and + don't display failures again at the end. +- fix assertion interpretation with the ** operator (thanks Benjamin Peterson) +- fix issue105 assignment on the same line as a failing assertion (thanks Benjamin Peterson) +- fix issue104 proper escaping for test names in junitxml plugin (thanks anonymous) +- fix issue57 -f|--looponfail to work with xpassing tests (thanks Ronny) +- fix issue92 collectonly reporter and --pastebin (thanks Benjamin Peterson) +- fix py.code.compile(source) to generate unique filenames +- fix assertion re-interp problems on PyPy, by defering code + compilation to the (overridable) Frame.eval class. (thanks Amaury Forgeot) +- fix py.path.local.pyimport() to work with directories +- streamline py.path.local.mkdtemp implementation and usage +- don't print empty lines when showing junitxml-filename +- add optional boolean ignore_errors parameter to py.path.local.remove +- fix terminal writing on win32/python2.4 +- py.process.cmdexec() now tries harder to return properly encoded unicode objects + on all python versions +- install plain py.test/py.which scripts also for Jython, this helps to + get canonical script paths in virtualenv situations +- make path.bestrelpath(path) return ".", note that when calling + X.bestrelpath the assumption is that X is a directory. +- make initial conftest discovery ignore "--" prefixed arguments +- fix resultlog plugin when used in an multicpu/multihost xdist situation + (thanks Jakub Gustak) +- perform distributed testing related reporting in the xdist-plugin + rather than having dist-related code in the generic py.test + distribution +- fix homedir detection on Windows +- ship distribute_setup.py version 0.6.13 + +1.3.1 +===== + +**New features** + +- issue91: introduce new py.test.xfail(reason) helper + to imperatively mark a test as expected to fail. Can + be used from within setup and test functions. This is + useful especially for parametrized tests when certain + configurations are expected-to-fail. In this case the + declarative approach with the @py.test.mark.xfail cannot + be used as it would mark all configurations as xfail. + +- issue102: introduce new --maxfail=NUM option to stop + test runs after NUM failures. This is a generalization + of the '-x' or '--exitfirst' option which is now equivalent + to '--maxfail=1'. Both '-x' and '--maxfail' will + now also print a line near the end indicating the Interruption. + +- issue89: allow py.test.mark decorators to be used on classes + (class decorators were introduced with python2.6) and + also allow to have multiple markers applied at class/module level + by specifying a list. + +- improve and refine letter reporting in the progress bar: + . pass + f failed test + s skipped tests (reminder: use for dependency/platform mismatch only) + x xfailed test (test that was expected to fail) + X xpassed test (test that was expected to fail but passed) + + You can use any combination of 'fsxX' with the '-r' extended + reporting option. The xfail/xpass results will show up as + skipped tests in the junitxml output - which also fixes + issue99. + +- make py.test.cmdline.main() return the exitstatus instead of raising + SystemExit and also allow it to be called multiple times. This of + course requires that your application and tests are properly teared + down and don't have global state. + +**Bug Fixes** + +- improved traceback presentation: + - improved and unified reporting for "--tb=short" option + - Errors during test module imports are much shorter, (using --tb=short style) + - raises shows shorter more relevant tracebacks + - --fulltrace now more systematically makes traces longer / inhibits cutting + +- improve support for raises and other dynamically compiled code by + manipulating python's linecache.cache instead of the previous + rather hacky way of creating custom code objects. This makes + it seemlessly work on Jython and PyPy where it previously didn't. + +- fix issue96: make capturing more resilient against Control-C + interruptions (involved somewhat substantial refactoring + to the underlying capturing functionality to avoid race + conditions). + +- fix chaining of conditional skipif/xfail decorators - so it works now + as expected to use multiple @py.test.mark.skipif(condition) decorators, + including specific reporting which of the conditions lead to skipping. + +- fix issue95: late-import zlib so that it's not required + for general py.test startup. + +- fix issue94: make reporting more robust against bogus source code + (and internally be more careful when presenting unexpected byte sequences) + + +1.3.0 +===== + +- deprecate --report option in favour of a new shorter and easier to + remember -r option: it takes a string argument consisting of any + combination of 'xfsX' characters. They relate to the single chars + you see during the dotted progress printing and will print an extra line + per test at the end of the test run. This extra line indicates the exact + position or test ID that you directly paste to the py.test cmdline in order + to re-run a particular test. + +- allow external plugins to register new hooks via the new + pytest_addhooks(pluginmanager) hook. The new release of + the pytest-xdist plugin for distributed and looponfailing + testing requires this feature. + +- add a new pytest_ignore_collect(path, config) hook to allow projects and + plugins to define exclusion behaviour for their directory structure - + for example you may define in a conftest.py this method:: + + def pytest_ignore_collect(path): + return path.check(link=1) + + to prevent even a collection try of any tests in symlinked dirs. + +- new pytest_pycollect_makemodule(path, parent) hook for + allowing customization of the Module collection object for a + matching test module. + +- extend and refine xfail mechanism: + ``@py.test.mark.xfail(run=False)`` do not run the decorated test + ``@py.test.mark.xfail(reason="...")`` prints the reason string in xfail summaries + specifiying ``--runxfail`` on command line virtually ignores xfail markers + +- expose (previously internal) commonly useful methods: + py.io.get_terminal_with() -> return terminal width + py.io.ansi_print(...) -> print colored/bold text on linux/win32 + py.io.saferepr(obj) -> return limited representation string + +- expose test outcome related exceptions as py.test.skip.Exception, + py.test.raises.Exception etc., useful mostly for plugins + doing special outcome interpretation/tweaking + +- (issue85) fix junitxml plugin to handle tests with non-ascii output + +- fix/refine python3 compatibility (thanks Benjamin Peterson) + +- fixes for making the jython/win32 combination work, note however: + jython2.5.1/win32 does not provide a command line launcher, see + http://bugs.jython.org/issue1491 . See pylib install documentation + for how to work around. + +- fixes for handling of unicode exception values and unprintable objects + +- (issue87) fix unboundlocal error in assertionold code + +- (issue86) improve documentation for looponfailing + +- refine IO capturing: stdin-redirect pseudo-file now has a NOP close() method + +- ship distribute_setup.py version 0.6.10 + +- added links to the new capturelog and coverage plugins + + +1.2.0 +===== + +- refined usage and options for "py.cleanup":: + + py.cleanup # remove "*.pyc" and "*$py.class" (jython) files + py.cleanup -e .swp -e .cache # also remove files with these extensions + py.cleanup -s # remove "build" and "dist" directory next to setup.py files + py.cleanup -d # also remove empty directories + py.cleanup -a # synonym for "-s -d -e 'pip-log.txt'" + py.cleanup -n # dry run, only show what would be removed + +- add a new option "py.test --funcargs" which shows available funcargs + and their help strings (docstrings on their respective factory function) + for a given test path + +- display a short and concise traceback if a funcarg lookup fails + +- early-load "conftest.py" files in non-dot first-level sub directories. + allows to conveniently keep and access test-related options in a ``test`` + subdir and still add command line options. + +- fix issue67: new super-short traceback-printing option: "--tb=line" will print a single line for each failing (python) test indicating its filename, lineno and the failure value + +- fix issue78: always call python-level teardown functions even if the + according setup failed. This includes refinements for calling setup_module/class functions + which will now only be called once instead of the previous behaviour where they'd be called + multiple times if they raise an exception (including a Skipped exception). Any exception + will be re-corded and associated with all tests in the according module/class scope. + +- fix issue63: assume <40 columns to be a bogus terminal width, default to 80 + +- fix pdb debugging to be in the correct frame on raises-related errors + +- update apipkg.py to fix an issue where recursive imports might + unnecessarily break importing + +- fix plugin links + +1.1.1 +===== + +- moved dist/looponfailing from py.test core into a new + separately released pytest-xdist plugin. + +- new junitxml plugin: --junitxml=path will generate a junit style xml file + which is processable e.g. by the Hudson CI system. + +- new option: --genscript=path will generate a standalone py.test script + which will not need any libraries installed. thanks to Ralf Schmitt. + +- new option: --ignore will prevent specified path from collection. + Can be specified multiple times. + +- new option: --confcutdir=dir will make py.test only consider conftest + files that are relative to the specified dir. + +- new funcarg: "pytestconfig" is the pytest config object for access + to command line args and can now be easily used in a test. + +- install ``py.test`` and ``py.which`` with a ``-$VERSION`` suffix to + disambiguate between Python3, python2.X, Jython and PyPy installed versions. + +- new "pytestconfig" funcarg allows access to test config object + +- new "pytest_report_header" hook can return additional lines + to be displayed at the header of a test run. + +- (experimental) allow "py.test path::name1::name2::..." for pointing + to a test within a test collection directly. This might eventually + evolve as a full substitute to "-k" specifications. + +- streamlined plugin loading: order is now as documented in + customize.html: setuptools, ENV, commandline, conftest. + also setuptools entry point names are turned to canonical namees ("pytest_*") + +- automatically skip tests that need 'capfd' but have no os.dup + +- allow pytest_generate_tests to be defined in classes as well + +- deprecate usage of 'disabled' attribute in favour of pytestmark +- deprecate definition of Directory, Module, Class and Function nodes + in conftest.py files. Use pytest collect hooks instead. + +- collection/item node specific runtest/collect hooks are only called exactly + on matching conftest.py files, i.e. ones which are exactly below + the filesystem path of an item + +- change: the first pytest_collect_directory hook to return something + will now prevent further hooks to be called. + +- change: figleaf plugin now requires --figleaf to run. Also + change its long command line options to be a bit shorter (see py.test -h). + +- change: pytest doctest plugin is now enabled by default and has a + new option --doctest-glob to set a pattern for file matches. + +- change: remove internal py._* helper vars, only keep py._pydir + +- robustify capturing to survive if custom pytest_runtest_setup + code failed and prevented the capturing setup code from running. + +- make py.test.* helpers provided by default plugins visible early - + works transparently both for pydoc and for interactive sessions + which will regularly see e.g. py.test.mark and py.test.importorskip. + +- simplify internal plugin manager machinery +- simplify internal collection tree by introducing a RootCollector node + +- fix assert reinterpreation that sees a call containing "keyword=..." + +- fix issue66: invoke pytest_sessionstart and pytest_sessionfinish + hooks on slaves during dist-testing, report module/session teardown + hooks correctly. + +- fix issue65: properly handle dist-testing if no + execnet/py lib installed remotely. + +- skip some install-tests if no execnet is available + +- fix docs, fix internal bin/ script generation + + +1.1.0 +===== + +- introduce automatic plugin registration via 'pytest11' + entrypoints via setuptools' pkg_resources.iter_entry_points + +- fix py.test dist-testing to work with execnet >= 1.0.0b4 + +- re-introduce py.test.cmdline.main() for better backward compatibility + +- svn paths: fix a bug with path.check(versioned=True) for svn paths, + allow '%' in svn paths, make svnwc.update() default to interactive mode + like in 1.0.x and add svnwc.update(interactive=False) to inhibit interaction. + +- refine distributed tarball to contain test and no pyc files + +- try harder to have deprecation warnings for py.compat.* accesses + report a correct location + +1.0.3 +===== + +* adjust and improve docs + +* remove py.rest tool and internal namespace - it was + never really advertised and can still be used with + the old release if needed. If there is interest + it could be revived into its own tool i guess. + +* fix issue48 and issue59: raise an Error if the module + from an imported test file does not seem to come from + the filepath - avoids "same-name" confusion that has + been reported repeatedly + +* merged Ronny's nose-compatibility hacks: now + nose-style setup_module() and setup() functions are + supported + +* introduce generalized py.test.mark function marking + +* reshuffle / refine command line grouping + +* deprecate parser.addgroup in favour of getgroup which creates option group + +* add --report command line option that allows to control showing of skipped/xfailed sections + +* generalized skipping: a new way to mark python functions with skipif or xfail + at function, class and modules level based on platform or sys-module attributes. + +* extend py.test.mark decorator to allow for positional args + +* introduce and test "py.cleanup -d" to remove empty directories + +* fix issue #59 - robustify unittest test collection + +* make bpython/help interaction work by adding an __all__ attribute + to ApiModule, cleanup initpkg + +* use MIT license for pylib, add some contributors + +* remove py.execnet code and substitute all usages with 'execnet' proper + +* fix issue50 - cached_setup now caches more to expectations + for test functions with multiple arguments. + +* merge Jarko's fixes, issue #45 and #46 + +* add the ability to specify a path for py.lookup to search in + +* fix a funcarg cached_setup bug probably only occuring + in distributed testing and "module" scope with teardown. + +* many fixes and changes for making the code base python3 compatible, + many thanks to Benjamin Peterson for helping with this. + +* consolidate builtins implementation to be compatible with >=2.3, + add helpers to ease keeping 2 and 3k compatible code + +* deprecate py.compat.doctest|subprocess|textwrap|optparse + +* deprecate py.magic.autopath, remove py/magic directory + +* move pytest assertion handling to py/code and a pytest_assertion + plugin, add "--no-assert" option, deprecate py.magic namespaces + in favour of (less) py.code ones. + +* consolidate and cleanup py/code classes and files + +* cleanup py/misc, move tests to bin-for-dist + +* introduce delattr/delitem/delenv methods to py.test's monkeypatch funcarg + +* consolidate py.log implementation, remove old approach. + +* introduce py.io.TextIO and py.io.BytesIO for distinguishing between + text/unicode and byte-streams (uses underlying standard lib io.* + if available) + +* make py.unittest_convert helper script available which converts "unittest.py" + style files into the simpler assert/direct-test-classes py.test/nosetests + style. The script was written by Laura Creighton. + +* simplified internal localpath implementation + +1.0.2 +===== + +* fixing packaging issues, triggered by fedora redhat packaging, + also added doc, examples and contrib dirs to the tarball. + +* added a documentation link to the new django plugin. + +1.0.1 +===== + +* added a 'pytest_nose' plugin which handles nose.SkipTest, + nose-style function/method/generator setup/teardown and + tries to report functions correctly. + +* capturing of unicode writes or encoded strings to sys.stdout/err + work better, also terminalwriting was adapted and somewhat + unified between windows and linux. + +* improved documentation layout and content a lot + +* added a "--help-config" option to show conftest.py / ENV-var names for + all longopt cmdline options, and some special conftest.py variables. + renamed 'conf_capture' conftest setting to 'option_capture' accordingly. + +* fix issue #27: better reporting on non-collectable items given on commandline + (e.g. pyc files) + +* fix issue #33: added --version flag (thanks Benjamin Peterson) + +* fix issue #32: adding support for "incomplete" paths to wcpath.status() + +* "Test" prefixed classes are *not* collected by default anymore if they + have an __init__ method + +* monkeypatch setenv() now accepts a "prepend" parameter + +* improved reporting of collection error tracebacks + +* simplified multicall mechanism and plugin architecture, + renamed some internal methods and argnames + +1.0.0 +===== + +* more terse reporting try to show filesystem path relatively to current dir +* improve xfail output a bit + +1.0.0b9 +======= + +* cleanly handle and report final teardown of test setup + +* fix svn-1.6 compat issue with py.path.svnwc().versioned() + (thanks Wouter Vanden Hove) + +* setup/teardown or collection problems now show as ERRORs + or with big "E"'s in the progress lines. they are reported + and counted separately. + +* dist-testing: properly handle test items that get locally + collected but cannot be collected on the remote side - often + due to platform/dependency reasons + +* simplified py.test.mark API - see keyword plugin documentation + +* integrate better with logging: capturing now by default captures + test functions and their immediate setup/teardown in a single stream + +* capsys and capfd funcargs now have a readouterr() and a close() method + (underlyingly py.io.StdCapture/FD objects are used which grew a + readouterr() method as well to return snapshots of captured out/err) + +* make assert-reinterpretation work better with comparisons not + returning bools (reported with numpy from thanks maciej fijalkowski) + +* reworked per-test output capturing into the pytest_iocapture.py plugin + and thus removed capturing code from config object + +* item.repr_failure(excinfo) instead of item.repr_failure(excinfo, outerr) + + +1.0.0b8 +======= + +* pytest_unittest-plugin is now enabled by default + +* introduced pytest_keyboardinterrupt hook and + refined pytest_sessionfinish hooked, added tests. + +* workaround a buggy logging module interaction ("closing already closed + files"). Thanks to Sridhar Ratnakumar for triggering. + +* if plugins use "py.test.importorskip" for importing + a dependency only a warning will be issued instead + of exiting the testing process. + +* many improvements to docs: + - refined funcargs doc , use the term "factory" instead of "provider" + - added a new talk/tutorial doc page + - better download page + - better plugin docstrings + - added new plugins page and automatic doc generation script + +* fixed teardown problem related to partially failing funcarg setups + (thanks MrTopf for reporting), "pytest_runtest_teardown" is now + always invoked even if the "pytest_runtest_setup" failed. + +* tweaked doctest output for docstrings in py modules, + thanks Radomir. + +1.0.0b7 +======= + +* renamed py.test.xfail back to py.test.mark.xfail to avoid + two ways to decorate for xfail + +* re-added py.test.mark decorator for setting keywords on functions + (it was actually documented so removing it was not nice) + +* remove scope-argument from request.addfinalizer() because + request.cached_setup has the scope arg. TOOWTDI. + +* perform setup finalization before reporting failures + +* apply modified patches from Andreas Kloeckner to allow + test functions to have no func_code (#22) and to make + "-k" and function keywords work (#20) + +* apply patch from Daniel Peolzleithner (issue #23) + +* resolve issue #18, multiprocessing.Manager() and + redirection clash + +* make __name__ == "__channelexec__" for remote_exec code + +1.0.0b3 +======= + +* plugin classes are removed: one now defines + hooks directly in conftest.py or global pytest_*.py + files. + +* added new pytest_namespace(config) hook that allows + to inject helpers directly to the py.test.* namespace. + +* documented and refined many hooks + +* added new style of generative tests via + pytest_generate_tests hook that integrates + well with function arguments. + + +1.0.0b1 +======= + +* introduced new "funcarg" setup method, + see doc/test/funcarg.txt + +* introduced plugin architecture and many + new py.test plugins, see + doc/test/plugins.txt + +* teardown_method is now guaranteed to get + called after a test method has run. + +* new method: py.test.importorskip(mod,minversion) + will either import or call py.test.skip() + +* completely revised internal py.test architecture + +* new py.process.ForkedFunc object allowing to + fork execution of a function to a sub process + and getting a result back. + +XXX lots of things missing here XXX + +0.9.2 +===== + +* refined installation and metadata, created new setup.py, + now based on setuptools/ez_setup (thanks to Ralf Schmitt + for his support). + +* improved the way of making py.* scripts available in + windows environments, they are now added to the + Scripts directory as ".cmd" files. + +* py.path.svnwc.status() now is more complete and + uses xml output from the 'svn' command if available + (Guido Wesdorp) + +* fix for py.path.svn* to work with svn 1.5 + (Chris Lamb) + +* fix path.relto(otherpath) method on windows to + use normcase for checking if a path is relative. + +* py.test's traceback is better parseable from editors + (follows the filenames:LINENO: MSG convention) + (thanks to Osmo Salomaa) + +* fix to javascript-generation, "py.test --runbrowser" + should work more reliably now + +* removed previously accidentally added + py.test.broken and py.test.notimplemented helpers. + +* there now is a py.__version__ attribute + +0.9.1 +===== + +This is a fairly complete list of v0.9.1, which can +serve as a reference for developers. + +* allowing + signs in py.path.svn urls [39106] +* fixed support for Failed exceptions without excinfo in py.test [39340] +* added support for killing processes for Windows (as well as platforms that + support os.kill) in py.misc.killproc [39655] +* added setup/teardown for generative tests to py.test [40702] +* added detection of FAILED TO LOAD MODULE to py.test [40703, 40738, 40739] +* fixed problem with calling .remove() on wcpaths of non-versioned files in + py.path [44248] +* fixed some import and inheritance issues in py.test [41480, 44648, 44655] +* fail to run greenlet tests when pypy is available, but without stackless + [45294] +* small fixes in rsession tests [45295] +* fixed issue with 2.5 type representations in py.test [45483, 45484] +* made that internal reporting issues displaying is done atomically in py.test + [45518] +* made that non-existing files are igored by the py.lookup script [45519] +* improved exception name creation in py.test [45535] +* made that less threads are used in execnet [merge in 45539] +* removed lock required for atomical reporting issue displaying in py.test + [45545] +* removed globals from execnet [45541, 45547] +* refactored cleanup mechanics, made that setDaemon is set to 1 to make atexit + get called in 2.5 (py.execnet) [45548] +* fixed bug in joining threads in py.execnet's servemain [45549] +* refactored py.test.rsession tests to not rely on exact output format anymore + [45646] +* using repr() on test outcome [45647] +* added 'Reason' classes for py.test.skip() [45648, 45649] +* killed some unnecessary sanity check in py.test.collect [45655] +* avoid using os.tmpfile() in py.io.fdcapture because on Windows it's only + usable by Administrators [45901] +* added support for locking and non-recursive commits to py.path.svnwc [45994] +* locking files in py.execnet to prevent CPython from segfaulting [46010] +* added export() method to py.path.svnurl +* fixed -d -x in py.test [47277] +* fixed argument concatenation problem in py.path.svnwc [49423] +* restore py.test behaviour that it exits with code 1 when there are failures + [49974] +* don't fail on html files that don't have an accompanying .txt file [50606] +* fixed 'utestconvert.py < input' [50645] +* small fix for code indentation in py.code.source [50755] +* fix _docgen.py documentation building [51285] +* improved checks for source representation of code blocks in py.test [51292] +* added support for passing authentication to py.path.svn* objects [52000, + 52001] +* removed sorted() call for py.apigen tests in favour of [].sort() to support + Python 2.3 [52481] diff --git a/testing/web-platform/tests/tools/pytest/CONTRIBUTING.rst b/testing/web-platform/tests/tools/pytest/CONTRIBUTING.rst new file mode 100644 index 000000000..75ee3ec32 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/CONTRIBUTING.rst @@ -0,0 +1,253 @@ +============================ +Contribution getting started +============================ + +Contributions are highly welcomed and appreciated. Every little help counts, +so do not hesitate! + +.. contents:: Contribution links + :depth: 2 + + +.. _submitfeedback: + +Feature requests and feedback +----------------------------- + +Do you like pytest? Share some love on Twitter or in your blog posts! + +We'd also like to hear about your propositions and suggestions. Feel free to +`submit them as issues <https://github.com/pytest-dev/pytest/issues>`_ and: + +* Explain in detail how they should work. +* Keep the scope as narrow as possible. This will make it easier to implement. + + +.. _reportbugs: + +Report bugs +----------- + +Report bugs for pytest in the `issue tracker <https://github.com/pytest-dev/pytest/issues>`_. + +If you are reporting a bug, please include: + +* Your operating system name and version. +* Any details about your local setup that might be helpful in troubleshooting, + specifically Python interpreter version, + installed libraries and pytest version. +* Detailed steps to reproduce the bug. + +If you can write a demonstration test that currently fails but should pass (xfail), +that is a very useful commit to make as well, even if you can't find how +to fix the bug yet. + + +.. _fixbugs: + +Fix bugs +-------- + +Look through the GitHub issues for bugs. Here is sample filter you can use: +https://github.com/pytest-dev/pytest/labels/bug + +:ref:`Talk <contact>` to developers to find out how you can fix specific bugs. + +Don't forget to check the issue trackers of your favourite plugins, too! + +.. _writeplugins: + +Implement features +------------------ + +Look through the GitHub issues for enhancements. Here is sample filter you +can use: +https://github.com/pytest-dev/pytest/labels/enhancement + +:ref:`Talk <contact>` to developers to find out how you can implement specific +features. + +Write documentation +------------------- + +pytest could always use more documentation. What exactly is needed? + +* More complementary documentation. Have you perhaps found something unclear? +* Documentation translations. We currently have only English. +* Docstrings. There can never be too many of them. +* Blog posts, articles and such -- they're all very appreciated. + +You can also edit documentation files directly in the Github web interface +without needing to make a fork and local copy. This can be convenient for +small fixes. + + +.. _submitplugin: + +Submitting Plugins to pytest-dev +-------------------------------- + +Pytest development of the core, some plugins and support code happens +in repositories living under the ``pytest-dev`` organisations: + +- `pytest-dev on GitHub <https://github.com/pytest-dev>`_ + +- `pytest-dev on Bitbucket <https://bitbucket.org/pytest-dev>`_ + +All pytest-dev Contributors team members have write access to all contained +repositories. pytest core and plugins are generally developed +using `pull requests`_ to respective repositories. + +The objectives of the ``pytest-dev`` organisation are: + +* Having a central location for popular pytest plugins +* Sharing some of the maintenance responsibility (in case a maintainer no longer whishes to maintain a plugin) + +You can submit your plugin by subscribing to the `pytest-dev mail list +<https://mail.python.org/mailman/listinfo/pytest-dev>`_ and writing a +mail pointing to your existing pytest plugin repository which must have +the following: + +- PyPI presence with a ``setup.py`` that contains a license, ``pytest-`` + prefixed name, version number, authors, short and long description. + +- a ``tox.ini`` for running tests using `tox <http://tox.testrun.org>`_. + +- a ``README.txt`` describing how to use the plugin and on which + platforms it runs. + +- a ``LICENSE.txt`` file or equivalent containing the licensing + information, with matching info in ``setup.py``. + +- an issue tracker for bug reports and enhancement requests. + +If no contributor strongly objects and two agree, the repository can then be +transferred to the ``pytest-dev`` organisation. + +Here's a rundown of how a repository transfer usually proceeds +(using a repository named ``joedoe/pytest-xyz`` as example): + +* One of the ``pytest-dev`` administrators creates: + + - ``pytest-xyz-admin`` team, with full administration rights to + ``pytest-dev/pytest-xyz``. + - ``pytest-xyz-developers`` team, with write access to + ``pytest-dev/pytest-xyz``. + +* ``joedoe`` is invited to the ``pytest-xyz-admin`` team; + +* After accepting the invitation, ``joedoe`` transfers the repository from its + original location to ``pytest-dev/pytest-xyz`` (A nice feature is that GitHub handles URL redirection from + the old to the new location automatically). + +* ``joedoe`` is free to add any other collaborators to the + ``pytest-xyz-admin`` or ``pytest-xyz-developers`` team as desired. + +The ``pytest-dev/Contributors`` team has write access to all projects, and +every project administrator is in it. We recommend that each plugin has at least three +people who have the right to release to PyPI. + +Repository owners can be assured that no ``pytest-dev`` administrator will ever make +releases of your repository or take ownership in any way, except in rare cases +where someone becomes unresponsive after months of contact attempts. +As stated, the objective is to share maintenance and avoid "plugin-abandon". + + +.. _`pull requests`: +.. _pull-requests: + +Preparing Pull Requests on GitHub +--------------------------------- + +There's an excellent tutorial on how Pull Requests work in the +`GitHub Help Center <https://help.github.com/articles/using-pull-requests/>`_ + + +.. note:: + What is a "pull request"? It informs project's core developers about the + changes you want to review and merge. Pull requests are stored on + `GitHub servers <https://github.com/pytest-dev/pytest/pulls>`_. + Once you send pull request, we can discuss it's potential modifications and + even add more commits to it later on. + +There's an excellent tutorial on how Pull Requests work in the +`GitHub Help Center <https://help.github.com/articles/using-pull-requests/>`_, +but here is a simple overview: + +#. Fork the + `pytest GitHub repository <https://github.com/pytest-dev/pytest>`__. It's + fine to use ``pytest`` as your fork repository name because it will live + under your user. + +#. Clone your fork locally using `git <https://git-scm.com/>`_ and create a branch:: + + $ git clone git@github.com:YOUR_GITHUB_USERNAME/pytest.git + $ cd pytest + # now, to fix a bug create your own branch off "master": + + $ git checkout -b your-bugfix-branch-name master + + # or to instead add a feature create your own branch off "features": + + $ git checkout -b your-feature-branch-name features + + Given we have "major.minor.micro" version numbers, bugfixes will usually + be released in micro releases whereas features will be released in + minor releases and incompatible changes in major releases. + + If you need some help with Git, follow this quick start + guide: https://git.wiki.kernel.org/index.php/QuickStart + +#. Install tox + + Tox is used to run all the tests and will automatically setup virtualenvs + to run the tests in. + (will implicitly use http://www.virtualenv.org/en/latest/):: + + $ pip install tox + +#. Run all the tests + + You need to have Python 2.7 and 3.5 available in your system. Now + running tests is as simple as issuing this command:: + + $ python runtox.py -e linting,py27,py35 + + This command will run tests via the "tox" tool against Python 2.7 and 3.5 + and also perform "lint" coding-style checks. ``runtox.py`` is + a thin wrapper around ``tox`` which installs from a development package + index where newer (not yet released to pypi) versions of dependencies + (especially ``py``) might be present. + +#. You can now edit your local working copy. + + You can now make the changes you want and run the tests again as necessary. + + To run tests on py27 and pass options to pytest (e.g. enter pdb on failure) + to pytest you can do:: + + $ python runtox.py -e py27 -- --pdb + + or to only run tests in a particular test module on py35:: + + $ python runtox.py -e py35 -- testing/test_config.py + +#. Commit and push once your tests pass and you are happy with your change(s):: + + $ git commit -a -m "<commit message>" + $ git push -u + + Make sure you add a CHANGELOG message, and add yourself to AUTHORS. If you + are unsure about either of these steps, submit your pull request and we'll + help you fix it up. + +#. Finally, submit a pull request through the GitHub website using this data:: + + head-fork: YOUR_GITHUB_USERNAME/pytest + compare: your-branch-name + + base-fork: pytest-dev/pytest + base: master # if it's a bugfix + base: feature # if it's a feature + + diff --git a/testing/web-platform/tests/tools/pytest/HOWTORELEASE.rst b/testing/web-platform/tests/tools/pytest/HOWTORELEASE.rst new file mode 100644 index 000000000..3ebfa28b1 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/HOWTORELEASE.rst @@ -0,0 +1,92 @@ +How to release pytest +-------------------------------------------- + +Note: this assumes you have already registered on pypi. + +0. create the branch release-VERSION + use features as base for minor/major releases + and master as base for bugfix releases + +1. Bump version numbers in _pytest/__init__.py (setup.py reads it) + +2. Check and finalize CHANGELOG + +3. Write doc/en/announce/release-VERSION.txt and include + it in doc/en/announce/index.txt:: + + git log 2.8.2..HEAD --format='%aN' | sort -u # lists the names of authors involved + +4. Use devpi for uploading a release tarball to a staging area:: + + devpi use https://devpi.net/USER/dev + devpi upload --formats sdist,bdist_wheel + +5. Run from multiple machines:: + + devpi use https://devpi.net/USER/dev + devpi test pytest==VERSION + +6. Check that tests pass for relevant combinations with:: + + devpi list pytest + + or look at failures with "devpi list -f pytest". + +7. Regenerate the docs examples using tox, and check for regressions:: + + tox -e regen + git diff + + +8. Build the docs, you need a virtualenv with py and sphinx + installed:: + + cd doc/en + make html + + Commit any changes before tagging the release. + +9. Tag the release:: + + git tag VERSION + git push + +10. Upload the docs using doc/en/Makefile:: + + cd doc/en + make install # or "installall" if you have LaTeX installed for PDF + + This requires ssh-login permission on pytest.org because it uses + rsync. + Note that the ``install`` target of ``doc/en/Makefile`` defines where the + rsync goes to, typically to the "latest" section of pytest.org. + + If you are making a minor release (e.g. 5.4), you also need to manually + create a symlink for "latest":: + + ssh pytest-dev@pytest.org + ln -s 5.4 latest + + Browse to pytest.org to verify. + +11. Publish to pypi:: + + devpi push pytest-VERSION pypi:NAME + + where NAME is the name of pypi.python.org as configured in your ``~/.pypirc`` + file `for devpi <http://doc.devpi.net/latest/quickstart-releaseprocess.html?highlight=pypirc#devpi-push-releasing-to-an-external-index>`_. + + +12. Send release announcement to mailing lists: + + - pytest-dev + - testing-in-python + - python-announce-list@python.org + + +13. **after the release** Bump the version number in ``_pytest/__init__.py``, + to the next Minor release version (i.e. if you released ``pytest-2.8.0``, + set it to ``pytest-2.9.0.dev1``). + +14. merge the actual release into the master branch and do a pull request against it +15. merge from master to features diff --git a/testing/web-platform/tests/tools/pytest/ISSUES.txt b/testing/web-platform/tests/tools/pytest/ISSUES.txt new file mode 100644 index 000000000..081d727e8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/ISSUES.txt @@ -0,0 +1,365 @@ + + +recorder = monkeypatch.function(".......") +------------------------------------------------------------- +tags: nice feature + +Like monkeypatch.replace but sets a mock-like call recorder: + + recorder = monkeypatch.function("os.path.abspath") + recorder.set_return("/hello") + os.path.abspath("hello") + call, = recorder.calls + assert call.args.path == "hello" + assert call.returned == "/hello" + ... + +Unlike mock, "args.path" acts on the parsed auto-spec'ed ``os.path.abspath`` +so it's independent from if the client side called "os.path.abspath(path=...)" +or "os.path.abspath('positional')". + + +refine parametrize API +------------------------------------------------------------- +tags: critical feature + +extend metafunc.parametrize to directly support indirection, example: + + def setupdb(request, config): + # setup "resource" based on test request and the values passed + # in to parametrize. setupfunc is called for each such value. + # you may use request.addfinalizer() or request.cached_setup ... + return dynamic_setup_database(val) + + @pytest.mark.parametrize("db", ["pg", "mysql"], setupfunc=setupdb) + def test_heavy_functional_test(db): + ... + +There would be no need to write or explain funcarg factories and +their special __ syntax. + +The examples and improvements should also show how to put the parametrize +decorator to a class, to a module or even to a directory. For the directory +part a conftest.py content like this:: + + pytestmark = [ + @pytest.mark.parametrize_setup("db", ...), + ] + +probably makes sense in order to keep the declarative nature. This mirrors +the marker-mechanism with respect to a test module but puts it to a directory +scale. + +When doing larger scoped parametrization it probably becomes necessary +to allow parametrization to be ignored if the according parameter is not +used (currently any parametrized argument that is not present in a function will cause a ValueError). Example: + + @pytest.mark.parametrize("db", ..., mustmatch=False) + +means to not raise an error but simply ignore the parametrization +if the signature of a decorated function does not match. XXX is it +not sufficient to always allow non-matches? + + +allow parametrized attributes on classes +-------------------------------------------------- + +tags: wish 2.4 + +example: + + @pytest.mark.parametrize_attr("db", setupfunc, [1,2,3], scope="class") + @pytest.mark.parametrize_attr("tmp", setupfunc, scope="...") + class TestMe: + def test_hello(self): + access self.db ... + +this would run the test_hello() function three times with three +different values for self.db. This could also work with unittest/nose +style tests, i.e. it leverages existing test suites without needing +to rewrite them. Together with the previously mentioned setup_test() +maybe the setupfunc could be omitted? + +optimizations +--------------------------------------------------------------- +tags: 2.4 core + +- look at ihook optimization such that all lookups for + hooks relating to the same fspath are cached. + +fix start/finish partial finailization problem +--------------------------------------------------------------- +tags: bug core + +if a configure/runtest_setup/sessionstart/... hook invocation partially +fails the sessionfinishes is not called. Each hook implementation +should better be repsonsible for registering a cleanup/finalizer +appropriately to avoid this issue. Moreover/Alternatively, we could +record which implementations of a hook succeeded and only call their +teardown. + + +relax requirement to have tests/testing contain an __init__ +---------------------------------------------------------------- +tags: feature +bb: http://bitbucket.org/hpk42/py-trunk/issue/64 + +A local test run of a "tests" directory may work +but a remote one fail because the tests directory +does not contain an "__init__.py". Either give +an error or make it work without the __init__.py +i.e. port the nose-logic of unloading a test module. + +customize test function collection +------------------------------------------------------- +tags: feature + +- introduce pytest.mark.nocollect for not considering a function for + test collection at all. maybe also introduce a pytest.mark.test to + explicitly mark a function to become a tested one. Lookup JUnit ways + of tagging tests. + +introduce pytest.mark.importorskip +------------------------------------------------------- +tags: feature + +in addition to the imperative pytest.importorskip also introduce +a pytest.mark.importorskip so that the test count is more correct. + + +introduce pytest.mark.platform +------------------------------------------------------- +tags: feature + +Introduce nice-to-spell platform-skipping, examples: + + @pytest.mark.platform("python3") + @pytest.mark.platform("not python3") + @pytest.mark.platform("win32 and not python3") + @pytest.mark.platform("darwin") + @pytest.mark.platform("not (jython and win32)") + @pytest.mark.platform("not (jython and win32)", xfail=True) + +etc. Idea is to allow Python expressions which can operate +on common spellings for operating systems and python +interpreter versions. + +pytest.mark.xfail signature change +------------------------------------------------------- +tags: feature + +change to pytest.mark.xfail(reason, (optional)condition) +to better implement the word meaning. It also signals +better that we always have some kind of an implementation +reason that can be formualated. +Compatibility? how to introduce a new name/keep compat? + +allow to non-intrusively apply skipfs/xfail/marks +--------------------------------------------------- +tags: feature + +use case: mark a module or directory structures +to be skipped on certain platforms (i.e. no import +attempt will be made). + +consider introducing a hook/mechanism that allows to apply marks +from conftests or plugins. (See extended parametrization) + + +explicit referencing of conftest.py files +----------------------------------------- +tags: feature + +allow to name conftest.py files (in sub directories) that should +be imported early, as to include command line options. + +improve central pytest ini file +------------------------------- +tags: feature + +introduce more declarative configuration options: +- (to-be-collected test directories) +- required plugins +- test func/class/file matching patterns +- skip/xfail (non-intrusive) +- pytest.ini and tox.ini and setup.cfg configuration in the same file + +new documentation +---------------------------------- +tags: feature + +- logo pytest +- examples for unittest or functional testing +- resource management for functional testing +- patterns: page object + +have imported module mismatch honour relative paths +-------------------------------------------------------- +tags: bug + +With 1.1.1 pytest fails at least on windows if an import +is relative and compared against an absolute conftest.py +path. Normalize. + +consider globals: pytest.ensuretemp and config +-------------------------------------------------------------- +tags: experimental-wish + +consider deprecating pytest.ensuretemp and pytest.config +to further reduce pytest globality. Also consider +having pytest.config and ensuretemp coming from +a plugin rather than being there from the start. + + +consider pytest_addsyspath hook +----------------------------------------- +tags: wish + +pytest could call a new pytest_addsyspath() in order to systematically +allow manipulation of sys.path and to inhibit it via --no-addsyspath +in order to more easily run against installed packages. + +Alternatively it could also be done via the config object +and pytest_configure. + + + +deprecate global pytest.config usage +---------------------------------------------------------------- +tags: feature + +pytest.ensuretemp and pytest.config are probably the last +objects containing global state. Often using them is not +necessary. This is about trying to get rid of them, i.e. +deprecating them and checking with PyPy's usages as well +as others. + +remove deprecated bits in collect.py +------------------------------------------------------------------- +tags: feature + +In an effort to further simplify code, review and remove deprecated bits +in collect.py. Probably good: +- inline consider_file/dir methods, no need to have them + subclass-overridable because of hooks + +implement fslayout decorator +--------------------------------- +tags: feature + +Improve the way how tests can work with pre-made examples, +keeping the layout close to the test function: + +@pytest.mark.fslayout(""" + conftest.py: + # empty + tests/ + test_%(NAME)s: # becomes test_run1.py + def test_function(self): + pass +""") +def test_run(pytester, fslayout): + p = fslayout.findone("test_*.py") + result = pytester.runpytest(p) + assert result.ret == 0 + assert result.passed == 1 + +Another idea is to allow to define a full scenario including the run +in one content string:: + + runscenario(""" + test_{TESTNAME}.py: + import pytest + @pytest.mark.xfail + def test_that_fails(): + assert 0 + + @pytest.mark.skipif("True") + def test_hello(): + pass + + conftest.py: + import pytest + def pytest_runsetup_setup(item): + pytest.skip("abc") + + runpytest -rsxX + *SKIP*{TESTNAME}* + *1 skipped* + """) + +This could be run with at least three different ways to invoke pytest: +through the shell, through "python -m pytest" and inlined. As inlined +would be the fastest it could be run first (or "--fast" mode). + + +Create isolate plugin +--------------------- +tags: feature + +The idea is that you can e.g. import modules in a test and afterwards +sys.modules, sys.meta_path etc would be reverted. It can go further +then just importing however, e.g. current working directory, file +descriptors, ... + +This would probably be done by marking:: + + @pytest.mark.isolate(importing=True, cwd=True, fds=False) + def test_foo(): + ... + +With the possibility of doing this globally in an ini-file. + + +fnmatch for test names +---------------------- +tags: feature-wish + +various testsuites use suffixes instead of prefixes for test classes +also it lends itself to bdd style test names:: + + class UserBehaviour: + def anonymous_should_not_have_inbox(user): + ... + def registred_should_have_inbox(user): + .. + +using the following in pytest.ini:: + + [pytest] + python_classes = Test *Behaviour *Test + python_functions = test *_should_* + + +mechanism for running named parts of tests with different reporting behaviour +------------------------------------------------------------------------------ +tags: feature-wish-incomplete + +a few use-cases come to mind: + +* fail assertions and record that without stopping a complete test + + * this is in particular hepfull if a small bit of a test is known to fail/xfail:: + + def test_fun(): + with pytest.section('fdcheck, marks=pytest.mark.xfail_if(...)): + breaks_on_windows() + +* divide functional/acceptance tests into sections +* provide a different mechanism for generators, maybe something like:: + + def pytest_runtest_call(item) + if not generator: + ... + prepare_check = GeneratorCheckprepare() + + gen = item.obj(**fixtures) + for check in gen + id, call = prepare_check(check) + # bubble should only prevent exception propagation after a failure + # the whole test should still fail + # there might be need for a lower level api and taking custom markers into account + with pytest.section(id, bubble=False): + call() + + diff --git a/testing/web-platform/tests/tools/pytest/LICENSE b/testing/web-platform/tests/tools/pytest/LICENSE new file mode 100644 index 000000000..9e27bd784 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2004-2016 Holger Krekel and others + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/testing/web-platform/tests/tools/pytest/MANIFEST.in b/testing/web-platform/tests/tools/pytest/MANIFEST.in new file mode 100644 index 000000000..266a9184d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/MANIFEST.in @@ -0,0 +1,34 @@ +include CHANGELOG.rst +include LICENSE +include AUTHORS + +include README.rst +include CONTRIBUTING.rst + +include tox.ini +include setup.py + +include .coveragerc + +include plugin-test.sh +include requirements-docs.txt +include runtox.py + +recursive-include bench *.py +recursive-include extra *.py + +graft testing +graft doc + +exclude _pytest/impl + +graft _pytest/vendored_packages + +recursive-exclude * *.pyc *.pyo + +exclude appveyor/install.ps1 +exclude appveyor.yml +exclude appveyor + +exclude ISSUES.txt +exclude HOWTORELEASE.rst diff --git a/testing/web-platform/tests/tools/pytest/README.rst b/testing/web-platform/tests/tools/pytest/README.rst new file mode 100644 index 000000000..68fc92211 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/README.rst @@ -0,0 +1,102 @@ +.. image:: http://pytest.org/latest/_static/pytest1.png + :target: http://pytest.org + :align: center + :alt: pytest + +------ + +.. image:: https://img.shields.io/pypi/v/pytest.svg + :target: https://pypi.python.org/pypi/pytest +.. image:: https://img.shields.io/pypi/pyversions/pytest.svg + :target: https://pypi.python.org/pypi/pytest +.. image:: https://img.shields.io/coveralls/pytest-dev/pytest/master.svg + :target: https://coveralls.io/r/pytest-dev/pytest +.. image:: https://travis-ci.org/pytest-dev/pytest.svg?branch=master + :target: https://travis-ci.org/pytest-dev/pytest +.. image:: https://ci.appveyor.com/api/projects/status/mrgbjaua7t33pg6b?svg=true + :target: https://ci.appveyor.com/project/pytestbot/pytest + +The ``pytest`` framework makes it easy to write small tests, yet +scales to support complex functional testing for applications and libraries. + +An example of a simple test: + +.. code-block:: python + + # content of test_sample.py + def func(x): + return x + 1 + + def test_answer(): + assert func(3) == 5 + + +To execute it:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.3, pytest-2.8.5, py-1.4.31, pluggy-0.3.1 + collected 1 items + + test_sample.py F + + ======= FAILURES ======== + _______ test_answer ________ + + def test_answer(): + > assert func(3) == 5 + E assert 4 == 5 + E + where 4 = func(3) + + test_sample.py:5: AssertionError + ======= 1 failed in 0.12 seconds ======== + +Due to ``py.test``'s detailed assertion introspection, only plain ``assert`` statements are used. See `getting-started <http://pytest.org/latest/getting-started.html#our-first-test-run>`_ for more examples. + + +Features +-------- + +- Detailed info on failing `assert statements <http://pytest.org/latest/assert.html>`_ (no need to remember ``self.assert*`` names); + +- `Auto-discovery + <http://pytest.org/latest/goodpractices.html#python-test-discovery>`_ + of test modules and functions; + +- `Modular fixtures <http://pytest.org/latest/fixture.html>`_ for + managing small or parametrized long-lived test resources; + +- Can run `unittest <http://pytest.org/latest/unittest.html>`_ (or trial), + `nose <http://pytest.org/latest/nose.html>`_ test suites out of the box; + +- Python2.6+, Python3.2+, PyPy-2.3, Jython-2.5 (untested); + +- Rich plugin architecture, with over 150+ `external plugins <http://pytest.org/latest/plugins.html#installing-external-plugins-searching>`_ and thriving community; + + +Documentation +------------- + +For full documentation, including installation, tutorials and PDF documents, please see http://pytest.org. + + +Bugs/Requests +------------- + +Please use the `GitHub issue tracker <https://github.com/pytest-dev/pytest/issues>`_ to submit bugs or request features. + + +Changelog +--------- + +Consult the `Changelog <http://pytest.org/latest/changelog.html>`_ page for fixes and enhancements of each version. + + +License +------- + +Copyright Holger Krekel and others, 2004-2016. + +Distributed under the terms of the `MIT`_ license, pytest is free and open source software. + +.. _`MIT`: https://github.com/pytest-dev/pytest/blob/master/LICENSE diff --git a/testing/web-platform/tests/tools/pytest/_pytest/__init__.py b/testing/web-platform/tests/tools/pytest/_pytest/__init__.py new file mode 100644 index 000000000..723fb9e85 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/__init__.py @@ -0,0 +1,2 @@ +# +__version__ = '2.9.1' diff --git a/testing/web-platform/tests/tools/pytest/_pytest/_argcomplete.py b/testing/web-platform/tests/tools/pytest/_pytest/_argcomplete.py new file mode 100644 index 000000000..955855a96 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/_argcomplete.py @@ -0,0 +1,101 @@ + +"""allow bash-completion for argparse with argcomplete if installed +needs argcomplete>=0.5.6 for python 3.2/3.3 (older versions fail +to find the magic string, so _ARGCOMPLETE env. var is never set, and +this does not need special code. + +argcomplete does not support python 2.5 (although the changes for that +are minor). + +Function try_argcomplete(parser) should be called directly before +the call to ArgumentParser.parse_args(). + +The filescompleter is what you normally would use on the positional +arguments specification, in order to get "dirname/" after "dirn<TAB>" +instead of the default "dirname ": + + optparser.add_argument(Config._file_or_dir, nargs='*' + ).completer=filescompleter + +Other, application specific, completers should go in the file +doing the add_argument calls as they need to be specified as .completer +attributes as well. (If argcomplete is not installed, the function the +attribute points to will not be used). + +SPEEDUP +======= +The generic argcomplete script for bash-completion +(/etc/bash_completion.d/python-argcomplete.sh ) +uses a python program to determine startup script generated by pip. +You can speed up completion somewhat by changing this script to include + # PYTHON_ARGCOMPLETE_OK +so the the python-argcomplete-check-easy-install-script does not +need to be called to find the entry point of the code and see if that is +marked with PYTHON_ARGCOMPLETE_OK + +INSTALL/DEBUGGING +================= +To include this support in another application that has setup.py generated +scripts: +- add the line: + # PYTHON_ARGCOMPLETE_OK + near the top of the main python entry point +- include in the file calling parse_args(): + from _argcomplete import try_argcomplete, filescompleter + , call try_argcomplete just before parse_args(), and optionally add + filescompleter to the positional arguments' add_argument() +If things do not work right away: +- switch on argcomplete debugging with (also helpful when doing custom + completers): + export _ARC_DEBUG=1 +- run: + python-argcomplete-check-easy-install-script $(which appname) + echo $? + will echo 0 if the magic line has been found, 1 if not +- sometimes it helps to find early on errors using: + _ARGCOMPLETE=1 _ARC_DEBUG=1 appname + which should throw a KeyError: 'COMPLINE' (which is properly set by the + global argcomplete script). +""" + +import sys +import os +from glob import glob + +class FastFilesCompleter: + 'Fast file completer class' + def __init__(self, directories=True): + self.directories = directories + + def __call__(self, prefix, **kwargs): + """only called on non option completions""" + if os.path.sep in prefix[1:]: # + prefix_dir = len(os.path.dirname(prefix) + os.path.sep) + else: + prefix_dir = 0 + completion = [] + globbed = [] + if '*' not in prefix and '?' not in prefix: + if prefix[-1] == os.path.sep: # we are on unix, otherwise no bash + globbed.extend(glob(prefix + '.*')) + prefix += '*' + globbed.extend(glob(prefix)) + for x in sorted(globbed): + if os.path.isdir(x): + x += '/' + # append stripping the prefix (like bash, not like compgen) + completion.append(x[prefix_dir:]) + return completion + +if os.environ.get('_ARGCOMPLETE'): + try: + import argcomplete.completers + except ImportError: + sys.exit(-1) + filescompleter = FastFilesCompleter() + + def try_argcomplete(parser): + argcomplete.autocomplete(parser) +else: + def try_argcomplete(parser): pass + filescompleter = None diff --git a/testing/web-platform/tests/tools/pytest/_pytest/_code/__init__.py b/testing/web-platform/tests/tools/pytest/_pytest/_code/__init__.py new file mode 100644 index 000000000..c046b9716 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/_code/__init__.py @@ -0,0 +1,12 @@ +""" python inspection/code generation API """ +from .code import Code # noqa +from .code import ExceptionInfo # noqa +from .code import Frame # noqa +from .code import Traceback # noqa +from .code import getrawcode # noqa +from .code import patch_builtins # noqa +from .code import unpatch_builtins # noqa +from .source import Source # noqa +from .source import compile_ as compile # noqa +from .source import getfslineno # noqa + diff --git a/testing/web-platform/tests/tools/pytest/_pytest/_code/_py2traceback.py b/testing/web-platform/tests/tools/pytest/_pytest/_code/_py2traceback.py new file mode 100644 index 000000000..a830d9899 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/_code/_py2traceback.py @@ -0,0 +1,81 @@ +# copied from python-2.7.3's traceback.py +# CHANGES: +# - some_str is replaced, trying to create unicode strings +# +import types + +def format_exception_only(etype, value): + """Format the exception part of a traceback. + + The arguments are the exception type and value such as given by + sys.last_type and sys.last_value. The return value is a list of + strings, each ending in a newline. + + Normally, the list contains a single string; however, for + SyntaxError exceptions, it contains several lines that (when + printed) display detailed information about where the syntax + error occurred. + + The message indicating which exception occurred is always the last + string in the list. + + """ + + # An instance should not have a meaningful value parameter, but + # sometimes does, particularly for string exceptions, such as + # >>> raise string1, string2 # deprecated + # + # Clear these out first because issubtype(string1, SyntaxError) + # would throw another exception and mask the original problem. + if (isinstance(etype, BaseException) or + isinstance(etype, types.InstanceType) or + etype is None or type(etype) is str): + return [_format_final_exc_line(etype, value)] + + stype = etype.__name__ + + if not issubclass(etype, SyntaxError): + return [_format_final_exc_line(stype, value)] + + # It was a syntax error; show exactly where the problem was found. + lines = [] + try: + msg, (filename, lineno, offset, badline) = value.args + except Exception: + pass + else: + filename = filename or "<string>" + lines.append(' File "%s", line %d\n' % (filename, lineno)) + if badline is not None: + if isinstance(badline, bytes): # python 2 only + badline = badline.decode('utf-8', 'replace') + lines.append(u' %s\n' % badline.strip()) + if offset is not None: + caretspace = badline.rstrip('\n')[:offset].lstrip() + # non-space whitespace (likes tabs) must be kept for alignment + caretspace = ((c.isspace() and c or ' ') for c in caretspace) + # only three spaces to account for offset1 == pos 0 + lines.append(' %s^\n' % ''.join(caretspace)) + value = msg + + lines.append(_format_final_exc_line(stype, value)) + return lines + +def _format_final_exc_line(etype, value): + """Return a list of a single line -- normal case for format_exception_only""" + valuestr = _some_str(value) + if value is None or not valuestr: + line = "%s\n" % etype + else: + line = "%s: %s\n" % (etype, valuestr) + return line + +def _some_str(value): + try: + return unicode(value) + except Exception: + try: + return str(value) + except Exception: + pass + return '<unprintable %s object>' % type(value).__name__ diff --git a/testing/web-platform/tests/tools/pytest/_pytest/_code/code.py b/testing/web-platform/tests/tools/pytest/_pytest/_code/code.py new file mode 100644 index 000000000..bc68aac55 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/_code/code.py @@ -0,0 +1,795 @@ +import sys +from inspect import CO_VARARGS, CO_VARKEYWORDS + +import py + +builtin_repr = repr + +reprlib = py.builtin._tryimport('repr', 'reprlib') + +if sys.version_info[0] >= 3: + from traceback import format_exception_only +else: + from ._py2traceback import format_exception_only + +class Code(object): + """ wrapper around Python code objects """ + def __init__(self, rawcode): + if not hasattr(rawcode, "co_filename"): + rawcode = getrawcode(rawcode) + try: + self.filename = rawcode.co_filename + self.firstlineno = rawcode.co_firstlineno - 1 + self.name = rawcode.co_name + except AttributeError: + raise TypeError("not a code object: %r" %(rawcode,)) + self.raw = rawcode + + def __eq__(self, other): + return self.raw == other.raw + + def __ne__(self, other): + return not self == other + + @property + def path(self): + """ return a path object pointing to source code (note that it + might not point to an actually existing file). """ + p = py.path.local(self.raw.co_filename) + # maybe don't try this checking + if not p.check(): + # XXX maybe try harder like the weird logic + # in the standard lib [linecache.updatecache] does? + p = self.raw.co_filename + return p + + @property + def fullsource(self): + """ return a _pytest._code.Source object for the full source file of the code + """ + from _pytest._code import source + full, _ = source.findsource(self.raw) + return full + + def source(self): + """ return a _pytest._code.Source object for the code object's source only + """ + # return source only for that part of code + import _pytest._code + return _pytest._code.Source(self.raw) + + def getargs(self, var=False): + """ return a tuple with the argument names for the code object + + if 'var' is set True also return the names of the variable and + keyword arguments when present + """ + # handfull shortcut for getting args + raw = self.raw + argcount = raw.co_argcount + if var: + argcount += raw.co_flags & CO_VARARGS + argcount += raw.co_flags & CO_VARKEYWORDS + return raw.co_varnames[:argcount] + +class Frame(object): + """Wrapper around a Python frame holding f_locals and f_globals + in which expressions can be evaluated.""" + + def __init__(self, frame): + self.lineno = frame.f_lineno - 1 + self.f_globals = frame.f_globals + self.f_locals = frame.f_locals + self.raw = frame + self.code = Code(frame.f_code) + + @property + def statement(self): + """ statement this frame is at """ + import _pytest._code + if self.code.fullsource is None: + return _pytest._code.Source("") + return self.code.fullsource.getstatement(self.lineno) + + def eval(self, code, **vars): + """ evaluate 'code' in the frame + + 'vars' are optional additional local variables + + returns the result of the evaluation + """ + f_locals = self.f_locals.copy() + f_locals.update(vars) + return eval(code, self.f_globals, f_locals) + + def exec_(self, code, **vars): + """ exec 'code' in the frame + + 'vars' are optiona; additional local variables + """ + f_locals = self.f_locals.copy() + f_locals.update(vars) + py.builtin.exec_(code, self.f_globals, f_locals ) + + def repr(self, object): + """ return a 'safe' (non-recursive, one-line) string repr for 'object' + """ + return py.io.saferepr(object) + + def is_true(self, object): + return object + + def getargs(self, var=False): + """ return a list of tuples (name, value) for all arguments + + if 'var' is set True also include the variable and keyword + arguments when present + """ + retval = [] + for arg in self.code.getargs(var): + try: + retval.append((arg, self.f_locals[arg])) + except KeyError: + pass # this can occur when using Psyco + return retval + +class TracebackEntry(object): + """ a single entry in a traceback """ + + _repr_style = None + exprinfo = None + + def __init__(self, rawentry): + self._rawentry = rawentry + self.lineno = rawentry.tb_lineno - 1 + + def set_repr_style(self, mode): + assert mode in ("short", "long") + self._repr_style = mode + + @property + def frame(self): + import _pytest._code + return _pytest._code.Frame(self._rawentry.tb_frame) + + @property + def relline(self): + return self.lineno - self.frame.code.firstlineno + + def __repr__(self): + return "<TracebackEntry %s:%d>" %(self.frame.code.path, self.lineno+1) + + @property + def statement(self): + """ _pytest._code.Source object for the current statement """ + source = self.frame.code.fullsource + return source.getstatement(self.lineno) + + @property + def path(self): + """ path to the source code """ + return self.frame.code.path + + def getlocals(self): + return self.frame.f_locals + locals = property(getlocals, None, None, "locals of underlaying frame") + + def reinterpret(self): + """Reinterpret the failing statement and returns a detailed information + about what operations are performed.""" + from _pytest.assertion.reinterpret import reinterpret + if self.exprinfo is None: + source = py.builtin._totext(self.statement).strip() + x = reinterpret(source, self.frame, should_fail=True) + if not py.builtin._istext(x): + raise TypeError("interpret returned non-string %r" % (x,)) + self.exprinfo = x + return self.exprinfo + + def getfirstlinesource(self): + # on Jython this firstlineno can be -1 apparently + return max(self.frame.code.firstlineno, 0) + + def getsource(self, astcache=None): + """ return failing source code. """ + # we use the passed in astcache to not reparse asttrees + # within exception info printing + from _pytest._code.source import getstatementrange_ast + source = self.frame.code.fullsource + if source is None: + return None + key = astnode = None + if astcache is not None: + key = self.frame.code.path + if key is not None: + astnode = astcache.get(key, None) + start = self.getfirstlinesource() + try: + astnode, _, end = getstatementrange_ast(self.lineno, source, + astnode=astnode) + except SyntaxError: + end = self.lineno + 1 + else: + if key is not None: + astcache[key] = astnode + return source[start:end] + + source = property(getsource) + + def ishidden(self): + """ return True if the current frame has a var __tracebackhide__ + resolving to True + + mostly for internal use + """ + try: + return self.frame.f_locals['__tracebackhide__'] + except KeyError: + try: + return self.frame.f_globals['__tracebackhide__'] + except KeyError: + return False + + def __str__(self): + try: + fn = str(self.path) + except py.error.Error: + fn = '???' + name = self.frame.code.name + try: + line = str(self.statement).lstrip() + except KeyboardInterrupt: + raise + except: + line = "???" + return " File %r:%d in %s\n %s\n" %(fn, self.lineno+1, name, line) + + def name(self): + return self.frame.code.raw.co_name + name = property(name, None, None, "co_name of underlaying code") + +class Traceback(list): + """ Traceback objects encapsulate and offer higher level + access to Traceback entries. + """ + Entry = TracebackEntry + def __init__(self, tb): + """ initialize from given python traceback object. """ + if hasattr(tb, 'tb_next'): + def f(cur): + while cur is not None: + yield self.Entry(cur) + cur = cur.tb_next + list.__init__(self, f(tb)) + else: + list.__init__(self, tb) + + def cut(self, path=None, lineno=None, firstlineno=None, excludepath=None): + """ return a Traceback instance wrapping part of this Traceback + + by provding any combination of path, lineno and firstlineno, the + first frame to start the to-be-returned traceback is determined + + this allows cutting the first part of a Traceback instance e.g. + for formatting reasons (removing some uninteresting bits that deal + with handling of the exception/traceback) + """ + for x in self: + code = x.frame.code + codepath = code.path + if ((path is None or codepath == path) and + (excludepath is None or not hasattr(codepath, 'relto') or + not codepath.relto(excludepath)) and + (lineno is None or x.lineno == lineno) and + (firstlineno is None or x.frame.code.firstlineno == firstlineno)): + return Traceback(x._rawentry) + return self + + def __getitem__(self, key): + val = super(Traceback, self).__getitem__(key) + if isinstance(key, type(slice(0))): + val = self.__class__(val) + return val + + def filter(self, fn=lambda x: not x.ishidden()): + """ return a Traceback instance with certain items removed + + fn is a function that gets a single argument, a TracebackItem + instance, and should return True when the item should be added + to the Traceback, False when not + + by default this removes all the TracebackItems which are hidden + (see ishidden() above) + """ + return Traceback(filter(fn, self)) + + def getcrashentry(self): + """ return last non-hidden traceback entry that lead + to the exception of a traceback. + """ + for i in range(-1, -len(self)-1, -1): + entry = self[i] + if not entry.ishidden(): + return entry + return self[-1] + + def recursionindex(self): + """ return the index of the frame/TracebackItem where recursion + originates if appropriate, None if no recursion occurred + """ + cache = {} + for i, entry in enumerate(self): + # id for the code.raw is needed to work around + # the strange metaprogramming in the decorator lib from pypi + # which generates code objects that have hash/value equality + #XXX needs a test + key = entry.frame.code.path, id(entry.frame.code.raw), entry.lineno + #print "checking for recursion at", key + l = cache.setdefault(key, []) + if l: + f = entry.frame + loc = f.f_locals + for otherloc in l: + if f.is_true(f.eval(co_equal, + __recursioncache_locals_1=loc, + __recursioncache_locals_2=otherloc)): + return i + l.append(entry.frame.f_locals) + return None + +co_equal = compile('__recursioncache_locals_1 == __recursioncache_locals_2', + '?', 'eval') + +class ExceptionInfo(object): + """ wraps sys.exc_info() objects and offers + help for navigating the traceback. + """ + _striptext = '' + def __init__(self, tup=None, exprinfo=None): + import _pytest._code + if tup is None: + tup = sys.exc_info() + if exprinfo is None and isinstance(tup[1], AssertionError): + exprinfo = getattr(tup[1], 'msg', None) + if exprinfo is None: + exprinfo = str(tup[1]) + if exprinfo and exprinfo.startswith('assert '): + self._striptext = 'AssertionError: ' + self._excinfo = tup + #: the exception class + self.type = tup[0] + #: the exception instance + self.value = tup[1] + #: the exception raw traceback + self.tb = tup[2] + #: the exception type name + self.typename = self.type.__name__ + #: the exception traceback (_pytest._code.Traceback instance) + self.traceback = _pytest._code.Traceback(self.tb) + + def __repr__(self): + return "<ExceptionInfo %s tblen=%d>" % (self.typename, len(self.traceback)) + + def exconly(self, tryshort=False): + """ return the exception as a string + + when 'tryshort' resolves to True, and the exception is a + _pytest._code._AssertionError, only the actual exception part of + the exception representation is returned (so 'AssertionError: ' is + removed from the beginning) + """ + lines = format_exception_only(self.type, self.value) + text = ''.join(lines) + text = text.rstrip() + if tryshort: + if text.startswith(self._striptext): + text = text[len(self._striptext):] + return text + + def errisinstance(self, exc): + """ return True if the exception is an instance of exc """ + return isinstance(self.value, exc) + + def _getreprcrash(self): + exconly = self.exconly(tryshort=True) + entry = self.traceback.getcrashentry() + path, lineno = entry.frame.code.raw.co_filename, entry.lineno + return ReprFileLocation(path, lineno+1, exconly) + + def getrepr(self, showlocals=False, style="long", + abspath=False, tbfilter=True, funcargs=False): + """ return str()able representation of this exception info. + showlocals: show locals per traceback entry + style: long|short|no|native traceback style + tbfilter: hide entries (where __tracebackhide__ is true) + + in case of style==native, tbfilter and showlocals is ignored. + """ + if style == 'native': + return ReprExceptionInfo(ReprTracebackNative( + py.std.traceback.format_exception( + self.type, + self.value, + self.traceback[0]._rawentry, + )), self._getreprcrash()) + + fmt = FormattedExcinfo(showlocals=showlocals, style=style, + abspath=abspath, tbfilter=tbfilter, funcargs=funcargs) + return fmt.repr_excinfo(self) + + def __str__(self): + entry = self.traceback[-1] + loc = ReprFileLocation(entry.path, entry.lineno + 1, self.exconly()) + return str(loc) + + def __unicode__(self): + entry = self.traceback[-1] + loc = ReprFileLocation(entry.path, entry.lineno + 1, self.exconly()) + return unicode(loc) + + +class FormattedExcinfo(object): + """ presenting information about failing Functions and Generators. """ + # for traceback entries + flow_marker = ">" + fail_marker = "E" + + def __init__(self, showlocals=False, style="long", abspath=True, tbfilter=True, funcargs=False): + self.showlocals = showlocals + self.style = style + self.tbfilter = tbfilter + self.funcargs = funcargs + self.abspath = abspath + self.astcache = {} + + def _getindent(self, source): + # figure out indent for given source + try: + s = str(source.getstatement(len(source)-1)) + except KeyboardInterrupt: + raise + except: + try: + s = str(source[-1]) + except KeyboardInterrupt: + raise + except: + return 0 + return 4 + (len(s) - len(s.lstrip())) + + def _getentrysource(self, entry): + source = entry.getsource(self.astcache) + if source is not None: + source = source.deindent() + return source + + def _saferepr(self, obj): + return py.io.saferepr(obj) + + def repr_args(self, entry): + if self.funcargs: + args = [] + for argname, argvalue in entry.frame.getargs(var=True): + args.append((argname, self._saferepr(argvalue))) + return ReprFuncArgs(args) + + def get_source(self, source, line_index=-1, excinfo=None, short=False): + """ return formatted and marked up source lines. """ + import _pytest._code + lines = [] + if source is None or line_index >= len(source.lines): + source = _pytest._code.Source("???") + line_index = 0 + if line_index < 0: + line_index += len(source) + space_prefix = " " + if short: + lines.append(space_prefix + source.lines[line_index].strip()) + else: + for line in source.lines[:line_index]: + lines.append(space_prefix + line) + lines.append(self.flow_marker + " " + source.lines[line_index]) + for line in source.lines[line_index+1:]: + lines.append(space_prefix + line) + if excinfo is not None: + indent = 4 if short else self._getindent(source) + lines.extend(self.get_exconly(excinfo, indent=indent, markall=True)) + return lines + + def get_exconly(self, excinfo, indent=4, markall=False): + lines = [] + indent = " " * indent + # get the real exception information out + exlines = excinfo.exconly(tryshort=True).split('\n') + failindent = self.fail_marker + indent[1:] + for line in exlines: + lines.append(failindent + line) + if not markall: + failindent = indent + return lines + + def repr_locals(self, locals): + if self.showlocals: + lines = [] + keys = [loc for loc in locals if loc[0] != "@"] + keys.sort() + for name in keys: + value = locals[name] + if name == '__builtins__': + lines.append("__builtins__ = <builtins>") + else: + # This formatting could all be handled by the + # _repr() function, which is only reprlib.Repr in + # disguise, so is very configurable. + str_repr = self._saferepr(value) + #if len(str_repr) < 70 or not isinstance(value, + # (list, tuple, dict)): + lines.append("%-10s = %s" %(name, str_repr)) + #else: + # self._line("%-10s =\\" % (name,)) + # # XXX + # py.std.pprint.pprint(value, stream=self.excinfowriter) + return ReprLocals(lines) + + def repr_traceback_entry(self, entry, excinfo=None): + import _pytest._code + source = self._getentrysource(entry) + if source is None: + source = _pytest._code.Source("???") + line_index = 0 + else: + # entry.getfirstlinesource() can be -1, should be 0 on jython + line_index = entry.lineno - max(entry.getfirstlinesource(), 0) + + lines = [] + style = entry._repr_style + if style is None: + style = self.style + if style in ("short", "long"): + short = style == "short" + reprargs = self.repr_args(entry) if not short else None + s = self.get_source(source, line_index, excinfo, short=short) + lines.extend(s) + if short: + message = "in %s" %(entry.name) + else: + message = excinfo and excinfo.typename or "" + path = self._makepath(entry.path) + filelocrepr = ReprFileLocation(path, entry.lineno+1, message) + localsrepr = None + if not short: + localsrepr = self.repr_locals(entry.locals) + return ReprEntry(lines, reprargs, localsrepr, filelocrepr, style) + if excinfo: + lines.extend(self.get_exconly(excinfo, indent=4)) + return ReprEntry(lines, None, None, None, style) + + def _makepath(self, path): + if not self.abspath: + try: + np = py.path.local().bestrelpath(path) + except OSError: + return path + if len(np) < len(str(path)): + path = np + return path + + def repr_traceback(self, excinfo): + traceback = excinfo.traceback + if self.tbfilter: + traceback = traceback.filter() + recursionindex = None + if excinfo.errisinstance(RuntimeError): + if "maximum recursion depth exceeded" in str(excinfo.value): + recursionindex = traceback.recursionindex() + last = traceback[-1] + entries = [] + extraline = None + for index, entry in enumerate(traceback): + einfo = (last == entry) and excinfo or None + reprentry = self.repr_traceback_entry(entry, einfo) + entries.append(reprentry) + if index == recursionindex: + extraline = "!!! Recursion detected (same locals & position)" + break + return ReprTraceback(entries, extraline, style=self.style) + + def repr_excinfo(self, excinfo): + reprtraceback = self.repr_traceback(excinfo) + reprcrash = excinfo._getreprcrash() + return ReprExceptionInfo(reprtraceback, reprcrash) + +class TerminalRepr: + def __str__(self): + s = self.__unicode__() + if sys.version_info[0] < 3: + s = s.encode('utf-8') + return s + + def __unicode__(self): + # FYI this is called from pytest-xdist's serialization of exception + # information. + io = py.io.TextIO() + tw = py.io.TerminalWriter(file=io) + self.toterminal(tw) + return io.getvalue().strip() + + def __repr__(self): + return "<%s instance at %0x>" %(self.__class__, id(self)) + + +class ReprExceptionInfo(TerminalRepr): + def __init__(self, reprtraceback, reprcrash): + self.reprtraceback = reprtraceback + self.reprcrash = reprcrash + self.sections = [] + + def addsection(self, name, content, sep="-"): + self.sections.append((name, content, sep)) + + def toterminal(self, tw): + self.reprtraceback.toterminal(tw) + for name, content, sep in self.sections: + tw.sep(sep, name) + tw.line(content) + +class ReprTraceback(TerminalRepr): + entrysep = "_ " + + def __init__(self, reprentries, extraline, style): + self.reprentries = reprentries + self.extraline = extraline + self.style = style + + def toterminal(self, tw): + # the entries might have different styles + for i, entry in enumerate(self.reprentries): + if entry.style == "long": + tw.line("") + entry.toterminal(tw) + if i < len(self.reprentries) - 1: + next_entry = self.reprentries[i+1] + if entry.style == "long" or \ + entry.style == "short" and next_entry.style == "long": + tw.sep(self.entrysep) + + if self.extraline: + tw.line(self.extraline) + +class ReprTracebackNative(ReprTraceback): + def __init__(self, tblines): + self.style = "native" + self.reprentries = [ReprEntryNative(tblines)] + self.extraline = None + +class ReprEntryNative(TerminalRepr): + style = "native" + + def __init__(self, tblines): + self.lines = tblines + + def toterminal(self, tw): + tw.write("".join(self.lines)) + +class ReprEntry(TerminalRepr): + localssep = "_ " + + def __init__(self, lines, reprfuncargs, reprlocals, filelocrepr, style): + self.lines = lines + self.reprfuncargs = reprfuncargs + self.reprlocals = reprlocals + self.reprfileloc = filelocrepr + self.style = style + + def toterminal(self, tw): + if self.style == "short": + self.reprfileloc.toterminal(tw) + for line in self.lines: + red = line.startswith("E ") + tw.line(line, bold=True, red=red) + #tw.line("") + return + if self.reprfuncargs: + self.reprfuncargs.toterminal(tw) + for line in self.lines: + red = line.startswith("E ") + tw.line(line, bold=True, red=red) + if self.reprlocals: + #tw.sep(self.localssep, "Locals") + tw.line("") + self.reprlocals.toterminal(tw) + if self.reprfileloc: + if self.lines: + tw.line("") + self.reprfileloc.toterminal(tw) + + def __str__(self): + return "%s\n%s\n%s" % ("\n".join(self.lines), + self.reprlocals, + self.reprfileloc) + +class ReprFileLocation(TerminalRepr): + def __init__(self, path, lineno, message): + self.path = str(path) + self.lineno = lineno + self.message = message + + def toterminal(self, tw): + # filename and lineno output for each entry, + # using an output format that most editors unterstand + msg = self.message + i = msg.find("\n") + if i != -1: + msg = msg[:i] + tw.line("%s:%s: %s" %(self.path, self.lineno, msg)) + +class ReprLocals(TerminalRepr): + def __init__(self, lines): + self.lines = lines + + def toterminal(self, tw): + for line in self.lines: + tw.line(line) + +class ReprFuncArgs(TerminalRepr): + def __init__(self, args): + self.args = args + + def toterminal(self, tw): + if self.args: + linesofar = "" + for name, value in self.args: + ns = "%s = %s" %(name, value) + if len(ns) + len(linesofar) + 2 > tw.fullwidth: + if linesofar: + tw.line(linesofar) + linesofar = ns + else: + if linesofar: + linesofar += ", " + ns + else: + linesofar = ns + if linesofar: + tw.line(linesofar) + tw.line("") + + + +oldbuiltins = {} + +def patch_builtins(assertion=True, compile=True): + """ put compile and AssertionError builtins to Python's builtins. """ + if assertion: + from _pytest.assertion import reinterpret + l = oldbuiltins.setdefault('AssertionError', []) + l.append(py.builtin.builtins.AssertionError) + py.builtin.builtins.AssertionError = reinterpret.AssertionError + if compile: + import _pytest._code + l = oldbuiltins.setdefault('compile', []) + l.append(py.builtin.builtins.compile) + py.builtin.builtins.compile = _pytest._code.compile + +def unpatch_builtins(assertion=True, compile=True): + """ remove compile and AssertionError builtins from Python builtins. """ + if assertion: + py.builtin.builtins.AssertionError = oldbuiltins['AssertionError'].pop() + if compile: + py.builtin.builtins.compile = oldbuiltins['compile'].pop() + +def getrawcode(obj, trycall=True): + """ return code object for given function. """ + try: + return obj.__code__ + except AttributeError: + obj = getattr(obj, 'im_func', obj) + obj = getattr(obj, 'func_code', obj) + obj = getattr(obj, 'f_code', obj) + obj = getattr(obj, '__code__', obj) + if trycall and not hasattr(obj, 'co_firstlineno'): + if hasattr(obj, '__call__') and not py.std.inspect.isclass(obj): + x = getrawcode(obj.__call__, trycall=False) + if hasattr(x, 'co_firstlineno'): + return x + return obj + diff --git a/testing/web-platform/tests/tools/pytest/_pytest/_code/source.py b/testing/web-platform/tests/tools/pytest/_pytest/_code/source.py new file mode 100644 index 000000000..a1521f8a2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/_code/source.py @@ -0,0 +1,421 @@ +from __future__ import generators + +from bisect import bisect_right +import sys +import inspect, tokenize +import py +from types import ModuleType +cpy_compile = compile + +try: + import _ast + from _ast import PyCF_ONLY_AST as _AST_FLAG +except ImportError: + _AST_FLAG = 0 + _ast = None + + +class Source(object): + """ a immutable object holding a source code fragment, + possibly deindenting it. + """ + _compilecounter = 0 + def __init__(self, *parts, **kwargs): + self.lines = lines = [] + de = kwargs.get('deindent', True) + rstrip = kwargs.get('rstrip', True) + for part in parts: + if not part: + partlines = [] + if isinstance(part, Source): + partlines = part.lines + elif isinstance(part, (tuple, list)): + partlines = [x.rstrip("\n") for x in part] + elif isinstance(part, py.builtin._basestring): + partlines = part.split('\n') + if rstrip: + while partlines: + if partlines[-1].strip(): + break + partlines.pop() + else: + partlines = getsource(part, deindent=de).lines + if de: + partlines = deindent(partlines) + lines.extend(partlines) + + def __eq__(self, other): + try: + return self.lines == other.lines + except AttributeError: + if isinstance(other, str): + return str(self) == other + return False + + def __getitem__(self, key): + if isinstance(key, int): + return self.lines[key] + else: + if key.step not in (None, 1): + raise IndexError("cannot slice a Source with a step") + return self.__getslice__(key.start, key.stop) + + def __len__(self): + return len(self.lines) + + def __getslice__(self, start, end): + newsource = Source() + newsource.lines = self.lines[start:end] + return newsource + + def strip(self): + """ return new source object with trailing + and leading blank lines removed. + """ + start, end = 0, len(self) + while start < end and not self.lines[start].strip(): + start += 1 + while end > start and not self.lines[end-1].strip(): + end -= 1 + source = Source() + source.lines[:] = self.lines[start:end] + return source + + def putaround(self, before='', after='', indent=' ' * 4): + """ return a copy of the source object with + 'before' and 'after' wrapped around it. + """ + before = Source(before) + after = Source(after) + newsource = Source() + lines = [ (indent + line) for line in self.lines] + newsource.lines = before.lines + lines + after.lines + return newsource + + def indent(self, indent=' ' * 4): + """ return a copy of the source object with + all lines indented by the given indent-string. + """ + newsource = Source() + newsource.lines = [(indent+line) for line in self.lines] + return newsource + + def getstatement(self, lineno, assertion=False): + """ return Source statement which contains the + given linenumber (counted from 0). + """ + start, end = self.getstatementrange(lineno, assertion) + return self[start:end] + + def getstatementrange(self, lineno, assertion=False): + """ return (start, end) tuple which spans the minimal + statement region which containing the given lineno. + """ + if not (0 <= lineno < len(self)): + raise IndexError("lineno out of range") + ast, start, end = getstatementrange_ast(lineno, self) + return start, end + + def deindent(self, offset=None): + """ return a new source object deindented by offset. + If offset is None then guess an indentation offset from + the first non-blank line. Subsequent lines which have a + lower indentation offset will be copied verbatim as + they are assumed to be part of multilines. + """ + # XXX maybe use the tokenizer to properly handle multiline + # strings etc.pp? + newsource = Source() + newsource.lines[:] = deindent(self.lines, offset) + return newsource + + def isparseable(self, deindent=True): + """ return True if source is parseable, heuristically + deindenting it by default. + """ + try: + import parser + except ImportError: + syntax_checker = lambda x: compile(x, 'asd', 'exec') + else: + syntax_checker = parser.suite + + if deindent: + source = str(self.deindent()) + else: + source = str(self) + try: + #compile(source+'\n', "x", "exec") + syntax_checker(source+'\n') + except KeyboardInterrupt: + raise + except Exception: + return False + else: + return True + + def __str__(self): + return "\n".join(self.lines) + + def compile(self, filename=None, mode='exec', + flag=generators.compiler_flag, + dont_inherit=0, _genframe=None): + """ return compiled code object. if filename is None + invent an artificial filename which displays + the source/line position of the caller frame. + """ + if not filename or py.path.local(filename).check(file=0): + if _genframe is None: + _genframe = sys._getframe(1) # the caller + fn,lineno = _genframe.f_code.co_filename, _genframe.f_lineno + base = "<%d-codegen " % self._compilecounter + self.__class__._compilecounter += 1 + if not filename: + filename = base + '%s:%d>' % (fn, lineno) + else: + filename = base + '%r %s:%d>' % (filename, fn, lineno) + source = "\n".join(self.lines) + '\n' + try: + co = cpy_compile(source, filename, mode, flag) + except SyntaxError: + ex = sys.exc_info()[1] + # re-represent syntax errors from parsing python strings + msglines = self.lines[:ex.lineno] + if ex.offset: + msglines.append(" "*ex.offset + '^') + msglines.append("(code was compiled probably from here: %s)" % filename) + newex = SyntaxError('\n'.join(msglines)) + newex.offset = ex.offset + newex.lineno = ex.lineno + newex.text = ex.text + raise newex + else: + if flag & _AST_FLAG: + return co + lines = [(x + "\n") for x in self.lines] + if sys.version_info[0] >= 3: + # XXX py3's inspect.getsourcefile() checks for a module + # and a pep302 __loader__ ... we don't have a module + # at code compile-time so we need to fake it here + m = ModuleType("_pycodecompile_pseudo_module") + py.std.inspect.modulesbyfile[filename] = None + py.std.sys.modules[None] = m + m.__loader__ = 1 + py.std.linecache.cache[filename] = (1, None, lines, filename) + return co + +# +# public API shortcut functions +# + +def compile_(source, filename=None, mode='exec', flags= + generators.compiler_flag, dont_inherit=0): + """ compile the given source to a raw code object, + and maintain an internal cache which allows later + retrieval of the source code for the code object + and any recursively created code objects. + """ + if _ast is not None and isinstance(source, _ast.AST): + # XXX should Source support having AST? + return cpy_compile(source, filename, mode, flags, dont_inherit) + _genframe = sys._getframe(1) # the caller + s = Source(source) + co = s.compile(filename, mode, flags, _genframe=_genframe) + return co + + +def getfslineno(obj): + """ Return source location (path, lineno) for the given object. + If the source cannot be determined return ("", -1) + """ + import _pytest._code + try: + code = _pytest._code.Code(obj) + except TypeError: + try: + fn = (py.std.inspect.getsourcefile(obj) or + py.std.inspect.getfile(obj)) + except TypeError: + return "", -1 + + fspath = fn and py.path.local(fn) or None + lineno = -1 + if fspath: + try: + _, lineno = findsource(obj) + except IOError: + pass + else: + fspath = code.path + lineno = code.firstlineno + assert isinstance(lineno, int) + return fspath, lineno + +# +# helper functions +# + +def findsource(obj): + try: + sourcelines, lineno = py.std.inspect.findsource(obj) + except py.builtin._sysex: + raise + except: + return None, -1 + source = Source() + source.lines = [line.rstrip() for line in sourcelines] + return source, lineno + +def getsource(obj, **kwargs): + import _pytest._code + obj = _pytest._code.getrawcode(obj) + try: + strsrc = inspect.getsource(obj) + except IndentationError: + strsrc = "\"Buggy python version consider upgrading, cannot get source\"" + assert isinstance(strsrc, str) + return Source(strsrc, **kwargs) + +def deindent(lines, offset=None): + if offset is None: + for line in lines: + line = line.expandtabs() + s = line.lstrip() + if s: + offset = len(line)-len(s) + break + else: + offset = 0 + if offset == 0: + return list(lines) + newlines = [] + def readline_generator(lines): + for line in lines: + yield line + '\n' + while True: + yield '' + + it = readline_generator(lines) + + try: + for _, _, (sline, _), (eline, _), _ in tokenize.generate_tokens(lambda: next(it)): + if sline > len(lines): + break # End of input reached + if sline > len(newlines): + line = lines[sline - 1].expandtabs() + if line.lstrip() and line[:offset].isspace(): + line = line[offset:] # Deindent + newlines.append(line) + + for i in range(sline, eline): + # Don't deindent continuing lines of + # multiline tokens (i.e. multiline strings) + newlines.append(lines[i]) + except (IndentationError, tokenize.TokenError): + pass + # Add any lines we didn't see. E.g. if an exception was raised. + newlines.extend(lines[len(newlines):]) + return newlines + + +def get_statement_startend2(lineno, node): + import ast + # flatten all statements and except handlers into one lineno-list + # AST's line numbers start indexing at 1 + l = [] + for x in ast.walk(node): + if isinstance(x, _ast.stmt) or isinstance(x, _ast.ExceptHandler): + l.append(x.lineno - 1) + for name in "finalbody", "orelse": + val = getattr(x, name, None) + if val: + # treat the finally/orelse part as its own statement + l.append(val[0].lineno - 1 - 1) + l.sort() + insert_index = bisect_right(l, lineno) + start = l[insert_index - 1] + if insert_index >= len(l): + end = None + else: + end = l[insert_index] + return start, end + + +def getstatementrange_ast(lineno, source, assertion=False, astnode=None): + if astnode is None: + content = str(source) + if sys.version_info < (2,7): + content += "\n" + try: + astnode = compile(content, "source", "exec", 1024) # 1024 for AST + except ValueError: + start, end = getstatementrange_old(lineno, source, assertion) + return None, start, end + start, end = get_statement_startend2(lineno, astnode) + # we need to correct the end: + # - ast-parsing strips comments + # - there might be empty lines + # - we might have lesser indented code blocks at the end + if end is None: + end = len(source.lines) + + if end > start + 1: + # make sure we don't span differently indented code blocks + # by using the BlockFinder helper used which inspect.getsource() uses itself + block_finder = inspect.BlockFinder() + # if we start with an indented line, put blockfinder to "started" mode + block_finder.started = source.lines[start][0].isspace() + it = ((x + "\n") for x in source.lines[start:end]) + try: + for tok in tokenize.generate_tokens(lambda: next(it)): + block_finder.tokeneater(*tok) + except (inspect.EndOfBlock, IndentationError): + end = block_finder.last + start + except Exception: + pass + + # the end might still point to a comment or empty line, correct it + while end: + line = source.lines[end - 1].lstrip() + if line.startswith("#") or not line: + end -= 1 + else: + break + return astnode, start, end + + +def getstatementrange_old(lineno, source, assertion=False): + """ return (start, end) tuple which spans the minimal + statement region which containing the given lineno. + raise an IndexError if no such statementrange can be found. + """ + # XXX this logic is only used on python2.4 and below + # 1. find the start of the statement + from codeop import compile_command + for start in range(lineno, -1, -1): + if assertion: + line = source.lines[start] + # the following lines are not fully tested, change with care + if 'super' in line and 'self' in line and '__init__' in line: + raise IndexError("likely a subclass") + if "assert" not in line and "raise" not in line: + continue + trylines = source.lines[start:lineno+1] + # quick hack to prepare parsing an indented line with + # compile_command() (which errors on "return" outside defs) + trylines.insert(0, 'def xxx():') + trysource = '\n '.join(trylines) + # ^ space here + try: + compile_command(trysource) + except (SyntaxError, OverflowError, ValueError): + continue + + # 2. find the end of the statement + for end in range(lineno+1, len(source)+1): + trysource = source[start:end] + if trysource.isparseable(): + return start, end + raise SyntaxError("no valid source range around line %d " % (lineno,)) + + diff --git a/testing/web-platform/tests/tools/pytest/_pytest/_pluggy.py b/testing/web-platform/tests/tools/pytest/_pytest/_pluggy.py new file mode 100644 index 000000000..87d32cf8d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/_pluggy.py @@ -0,0 +1,11 @@ +""" +imports symbols from vendored "pluggy" if available, otherwise +falls back to importing "pluggy" from the default namespace. +""" + +try: + from _pytest.vendored_packages.pluggy import * # noqa + from _pytest.vendored_packages.pluggy import __version__ # noqa +except ImportError: + from pluggy import * # noqa + from pluggy import __version__ # noqa diff --git a/testing/web-platform/tests/tools/pytest/_pytest/assertion/__init__.py b/testing/web-platform/tests/tools/pytest/_pytest/assertion/__init__.py new file mode 100644 index 000000000..6921deb2a --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/assertion/__init__.py @@ -0,0 +1,176 @@ +""" +support for presenting detailed information in failing assertions. +""" +import py +import os +import sys +from _pytest.monkeypatch import monkeypatch +from _pytest.assertion import util + + +def pytest_addoption(parser): + group = parser.getgroup("debugconfig") + group.addoption('--assert', + action="store", + dest="assertmode", + choices=("rewrite", "reinterp", "plain",), + default="rewrite", + metavar="MODE", + help="""control assertion debugging tools. 'plain' + performs no assertion debugging. 'reinterp' + reinterprets assert statements after they failed + to provide assertion expression information. + 'rewrite' (the default) rewrites assert + statements in test modules on import to + provide assert expression information. """) + group.addoption('--no-assert', + action="store_true", + default=False, + dest="noassert", + help="DEPRECATED equivalent to --assert=plain") + group.addoption('--nomagic', '--no-magic', + action="store_true", + default=False, + help="DEPRECATED equivalent to --assert=plain") + + +class AssertionState: + """State for the assertion plugin.""" + + def __init__(self, config, mode): + self.mode = mode + self.trace = config.trace.root.get("assertion") + + +def pytest_configure(config): + mode = config.getvalue("assertmode") + if config.getvalue("noassert") or config.getvalue("nomagic"): + mode = "plain" + if mode == "rewrite": + try: + import ast # noqa + except ImportError: + mode = "reinterp" + else: + # Both Jython and CPython 2.6.0 have AST bugs that make the + # assertion rewriting hook malfunction. + if (sys.platform.startswith('java') or + sys.version_info[:3] == (2, 6, 0)): + mode = "reinterp" + if mode != "plain": + _load_modules(mode) + m = monkeypatch() + config._cleanup.append(m.undo) + m.setattr(py.builtin.builtins, 'AssertionError', + reinterpret.AssertionError) # noqa + hook = None + if mode == "rewrite": + hook = rewrite.AssertionRewritingHook() # noqa + sys.meta_path.insert(0, hook) + warn_about_missing_assertion(mode) + config._assertstate = AssertionState(config, mode) + config._assertstate.hook = hook + config._assertstate.trace("configured with mode set to %r" % (mode,)) + def undo(): + hook = config._assertstate.hook + if hook is not None and hook in sys.meta_path: + sys.meta_path.remove(hook) + config.add_cleanup(undo) + + +def pytest_collection(session): + # this hook is only called when test modules are collected + # so for example not in the master process of pytest-xdist + # (which does not collect test modules) + hook = session.config._assertstate.hook + if hook is not None: + hook.set_session(session) + + +def _running_on_ci(): + """Check if we're currently running on a CI system.""" + env_vars = ['CI', 'BUILD_NUMBER'] + return any(var in os.environ for var in env_vars) + + +def pytest_runtest_setup(item): + """Setup the pytest_assertrepr_compare hook + + The newinterpret and rewrite modules will use util._reprcompare if + it exists to use custom reporting via the + pytest_assertrepr_compare hook. This sets up this custom + comparison for the test. + """ + def callbinrepr(op, left, right): + """Call the pytest_assertrepr_compare hook and prepare the result + + This uses the first result from the hook and then ensures the + following: + * Overly verbose explanations are dropped unless -vv was used or + running on a CI. + * Embedded newlines are escaped to help util.format_explanation() + later. + * If the rewrite mode is used embedded %-characters are replaced + to protect later % formatting. + + The result can be formatted by util.format_explanation() for + pretty printing. + """ + hook_result = item.ihook.pytest_assertrepr_compare( + config=item.config, op=op, left=left, right=right) + for new_expl in hook_result: + if new_expl: + if (sum(len(p) for p in new_expl[1:]) > 80*8 and + item.config.option.verbose < 2 and + not _running_on_ci()): + show_max = 10 + truncated_lines = len(new_expl) - show_max + new_expl[show_max:] = [py.builtin._totext( + 'Detailed information truncated (%d more lines)' + ', use "-vv" to show' % truncated_lines)] + new_expl = [line.replace("\n", "\\n") for line in new_expl] + res = py.builtin._totext("\n~").join(new_expl) + if item.config.getvalue("assertmode") == "rewrite": + res = res.replace("%", "%%") + return res + util._reprcompare = callbinrepr + + +def pytest_runtest_teardown(item): + util._reprcompare = None + + +def pytest_sessionfinish(session): + hook = session.config._assertstate.hook + if hook is not None: + hook.session = None + + +def _load_modules(mode): + """Lazily import assertion related code.""" + global rewrite, reinterpret + from _pytest.assertion import reinterpret # noqa + if mode == "rewrite": + from _pytest.assertion import rewrite # noqa + + +def warn_about_missing_assertion(mode): + try: + assert False + except AssertionError: + pass + else: + if mode == "rewrite": + specifically = ("assertions which are not in test modules " + "will be ignored") + else: + specifically = "failing tests may report as passing" + + sys.stderr.write("WARNING: " + specifically + + " because assert statements are not executed " + "by the underlying Python interpreter " + "(are you using python -O?)\n") + + +# Expose this plugin's implementation for the pytest_assertrepr_compare hook +pytest_assertrepr_compare = util.assertrepr_compare diff --git a/testing/web-platform/tests/tools/pytest/_pytest/assertion/reinterpret.py b/testing/web-platform/tests/tools/pytest/_pytest/assertion/reinterpret.py new file mode 100644 index 000000000..f4262c3ac --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/assertion/reinterpret.py @@ -0,0 +1,407 @@ +""" +Find intermediate evalutation results in assert statements through builtin AST. +""" +import ast +import sys + +import _pytest._code +import py +from _pytest.assertion import util +u = py.builtin._totext + + +class AssertionError(util.BuiltinAssertionError): + def __init__(self, *args): + util.BuiltinAssertionError.__init__(self, *args) + if args: + # on Python2.6 we get len(args)==2 for: assert 0, (x,y) + # on Python2.7 and above we always get len(args) == 1 + # with args[0] being the (x,y) tuple. + if len(args) > 1: + toprint = args + else: + toprint = args[0] + try: + self.msg = u(toprint) + except Exception: + self.msg = u( + "<[broken __repr__] %s at %0xd>" + % (toprint.__class__, id(toprint))) + else: + f = _pytest._code.Frame(sys._getframe(1)) + try: + source = f.code.fullsource + if source is not None: + try: + source = source.getstatement(f.lineno, assertion=True) + except IndexError: + source = None + else: + source = str(source.deindent()).strip() + except py.error.ENOENT: + source = None + # this can also occur during reinterpretation, when the + # co_filename is set to "<run>". + if source: + self.msg = reinterpret(source, f, should_fail=True) + else: + self.msg = "<could not determine information>" + if not self.args: + self.args = (self.msg,) + +if sys.version_info > (3, 0): + AssertionError.__module__ = "builtins" + +if sys.platform.startswith("java"): + # See http://bugs.jython.org/issue1497 + _exprs = ("BoolOp", "BinOp", "UnaryOp", "Lambda", "IfExp", "Dict", + "ListComp", "GeneratorExp", "Yield", "Compare", "Call", + "Repr", "Num", "Str", "Attribute", "Subscript", "Name", + "List", "Tuple") + _stmts = ("FunctionDef", "ClassDef", "Return", "Delete", "Assign", + "AugAssign", "Print", "For", "While", "If", "With", "Raise", + "TryExcept", "TryFinally", "Assert", "Import", "ImportFrom", + "Exec", "Global", "Expr", "Pass", "Break", "Continue") + _expr_nodes = set(getattr(ast, name) for name in _exprs) + _stmt_nodes = set(getattr(ast, name) for name in _stmts) + def _is_ast_expr(node): + return node.__class__ in _expr_nodes + def _is_ast_stmt(node): + return node.__class__ in _stmt_nodes +else: + def _is_ast_expr(node): + return isinstance(node, ast.expr) + def _is_ast_stmt(node): + return isinstance(node, ast.stmt) + +try: + _Starred = ast.Starred +except AttributeError: + # Python 2. Define a dummy class so isinstance() will always be False. + class _Starred(object): pass + + +class Failure(Exception): + """Error found while interpreting AST.""" + + def __init__(self, explanation=""): + self.cause = sys.exc_info() + self.explanation = explanation + + +def reinterpret(source, frame, should_fail=False): + mod = ast.parse(source) + visitor = DebugInterpreter(frame) + try: + visitor.visit(mod) + except Failure: + failure = sys.exc_info()[1] + return getfailure(failure) + if should_fail: + return ("(assertion failed, but when it was re-run for " + "printing intermediate values, it did not fail. Suggestions: " + "compute assert expression before the assert or use --assert=plain)") + +def run(offending_line, frame=None): + if frame is None: + frame = _pytest._code.Frame(sys._getframe(1)) + return reinterpret(offending_line, frame) + +def getfailure(e): + explanation = util.format_explanation(e.explanation) + value = e.cause[1] + if str(value): + lines = explanation.split('\n') + lines[0] += " << %s" % (value,) + explanation = '\n'.join(lines) + text = "%s: %s" % (e.cause[0].__name__, explanation) + if text.startswith('AssertionError: assert '): + text = text[16:] + return text + +operator_map = { + ast.BitOr : "|", + ast.BitXor : "^", + ast.BitAnd : "&", + ast.LShift : "<<", + ast.RShift : ">>", + ast.Add : "+", + ast.Sub : "-", + ast.Mult : "*", + ast.Div : "/", + ast.FloorDiv : "//", + ast.Mod : "%", + ast.Eq : "==", + ast.NotEq : "!=", + ast.Lt : "<", + ast.LtE : "<=", + ast.Gt : ">", + ast.GtE : ">=", + ast.Pow : "**", + ast.Is : "is", + ast.IsNot : "is not", + ast.In : "in", + ast.NotIn : "not in" +} + +unary_map = { + ast.Not : "not %s", + ast.Invert : "~%s", + ast.USub : "-%s", + ast.UAdd : "+%s" +} + + +class DebugInterpreter(ast.NodeVisitor): + """Interpret AST nodes to gleam useful debugging information. """ + + def __init__(self, frame): + self.frame = frame + + def generic_visit(self, node): + # Fallback when we don't have a special implementation. + if _is_ast_expr(node): + mod = ast.Expression(node) + co = self._compile(mod) + try: + result = self.frame.eval(co) + except Exception: + raise Failure() + explanation = self.frame.repr(result) + return explanation, result + elif _is_ast_stmt(node): + mod = ast.Module([node]) + co = self._compile(mod, "exec") + try: + self.frame.exec_(co) + except Exception: + raise Failure() + return None, None + else: + raise AssertionError("can't handle %s" %(node,)) + + def _compile(self, source, mode="eval"): + return compile(source, "<assertion interpretation>", mode) + + def visit_Expr(self, expr): + return self.visit(expr.value) + + def visit_Module(self, mod): + for stmt in mod.body: + self.visit(stmt) + + def visit_Name(self, name): + explanation, result = self.generic_visit(name) + # See if the name is local. + source = "%r in locals() is not globals()" % (name.id,) + co = self._compile(source) + try: + local = self.frame.eval(co) + except Exception: + # have to assume it isn't + local = None + if local is None or not self.frame.is_true(local): + return name.id, result + return explanation, result + + def visit_Compare(self, comp): + left = comp.left + left_explanation, left_result = self.visit(left) + for op, next_op in zip(comp.ops, comp.comparators): + next_explanation, next_result = self.visit(next_op) + op_symbol = operator_map[op.__class__] + explanation = "%s %s %s" % (left_explanation, op_symbol, + next_explanation) + source = "__exprinfo_left %s __exprinfo_right" % (op_symbol,) + co = self._compile(source) + try: + result = self.frame.eval(co, __exprinfo_left=left_result, + __exprinfo_right=next_result) + except Exception: + raise Failure(explanation) + try: + if not self.frame.is_true(result): + break + except KeyboardInterrupt: + raise + except: + break + left_explanation, left_result = next_explanation, next_result + + if util._reprcompare is not None: + res = util._reprcompare(op_symbol, left_result, next_result) + if res: + explanation = res + return explanation, result + + def visit_BoolOp(self, boolop): + is_or = isinstance(boolop.op, ast.Or) + explanations = [] + for operand in boolop.values: + explanation, result = self.visit(operand) + explanations.append(explanation) + if result == is_or: + break + name = is_or and " or " or " and " + explanation = "(" + name.join(explanations) + ")" + return explanation, result + + def visit_UnaryOp(self, unary): + pattern = unary_map[unary.op.__class__] + operand_explanation, operand_result = self.visit(unary.operand) + explanation = pattern % (operand_explanation,) + co = self._compile(pattern % ("__exprinfo_expr",)) + try: + result = self.frame.eval(co, __exprinfo_expr=operand_result) + except Exception: + raise Failure(explanation) + return explanation, result + + def visit_BinOp(self, binop): + left_explanation, left_result = self.visit(binop.left) + right_explanation, right_result = self.visit(binop.right) + symbol = operator_map[binop.op.__class__] + explanation = "(%s %s %s)" % (left_explanation, symbol, + right_explanation) + source = "__exprinfo_left %s __exprinfo_right" % (symbol,) + co = self._compile(source) + try: + result = self.frame.eval(co, __exprinfo_left=left_result, + __exprinfo_right=right_result) + except Exception: + raise Failure(explanation) + return explanation, result + + def visit_Call(self, call): + func_explanation, func = self.visit(call.func) + arg_explanations = [] + ns = {"__exprinfo_func" : func} + arguments = [] + for arg in call.args: + arg_explanation, arg_result = self.visit(arg) + if isinstance(arg, _Starred): + arg_name = "__exprinfo_star" + ns[arg_name] = arg_result + arguments.append("*%s" % (arg_name,)) + arg_explanations.append("*%s" % (arg_explanation,)) + else: + arg_name = "__exprinfo_%s" % (len(ns),) + ns[arg_name] = arg_result + arguments.append(arg_name) + arg_explanations.append(arg_explanation) + for keyword in call.keywords: + arg_explanation, arg_result = self.visit(keyword.value) + if keyword.arg: + arg_name = "__exprinfo_%s" % (len(ns),) + keyword_source = "%s=%%s" % (keyword.arg) + arguments.append(keyword_source % (arg_name,)) + arg_explanations.append(keyword_source % (arg_explanation,)) + else: + arg_name = "__exprinfo_kwds" + arguments.append("**%s" % (arg_name,)) + arg_explanations.append("**%s" % (arg_explanation,)) + + ns[arg_name] = arg_result + + if getattr(call, 'starargs', None): + arg_explanation, arg_result = self.visit(call.starargs) + arg_name = "__exprinfo_star" + ns[arg_name] = arg_result + arguments.append("*%s" % (arg_name,)) + arg_explanations.append("*%s" % (arg_explanation,)) + + if getattr(call, 'kwargs', None): + arg_explanation, arg_result = self.visit(call.kwargs) + arg_name = "__exprinfo_kwds" + ns[arg_name] = arg_result + arguments.append("**%s" % (arg_name,)) + arg_explanations.append("**%s" % (arg_explanation,)) + args_explained = ", ".join(arg_explanations) + explanation = "%s(%s)" % (func_explanation, args_explained) + args = ", ".join(arguments) + source = "__exprinfo_func(%s)" % (args,) + co = self._compile(source) + try: + result = self.frame.eval(co, **ns) + except Exception: + raise Failure(explanation) + pattern = "%s\n{%s = %s\n}" + rep = self.frame.repr(result) + explanation = pattern % (rep, rep, explanation) + return explanation, result + + def _is_builtin_name(self, name): + pattern = "%r not in globals() and %r not in locals()" + source = pattern % (name.id, name.id) + co = self._compile(source) + try: + return self.frame.eval(co) + except Exception: + return False + + def visit_Attribute(self, attr): + if not isinstance(attr.ctx, ast.Load): + return self.generic_visit(attr) + source_explanation, source_result = self.visit(attr.value) + explanation = "%s.%s" % (source_explanation, attr.attr) + source = "__exprinfo_expr.%s" % (attr.attr,) + co = self._compile(source) + try: + try: + result = self.frame.eval(co, __exprinfo_expr=source_result) + except AttributeError: + # Maybe the attribute name needs to be mangled? + if not attr.attr.startswith("__") or attr.attr.endswith("__"): + raise + source = "getattr(__exprinfo_expr.__class__, '__name__', '')" + co = self._compile(source) + class_name = self.frame.eval(co, __exprinfo_expr=source_result) + mangled_attr = "_" + class_name + attr.attr + source = "__exprinfo_expr.%s" % (mangled_attr,) + co = self._compile(source) + result = self.frame.eval(co, __exprinfo_expr=source_result) + except Exception: + raise Failure(explanation) + explanation = "%s\n{%s = %s.%s\n}" % (self.frame.repr(result), + self.frame.repr(result), + source_explanation, attr.attr) + # Check if the attr is from an instance. + source = "%r in getattr(__exprinfo_expr, '__dict__', {})" + source = source % (attr.attr,) + co = self._compile(source) + try: + from_instance = self.frame.eval(co, __exprinfo_expr=source_result) + except Exception: + from_instance = None + if from_instance is None or self.frame.is_true(from_instance): + rep = self.frame.repr(result) + pattern = "%s\n{%s = %s\n}" + explanation = pattern % (rep, rep, explanation) + return explanation, result + + def visit_Assert(self, assrt): + test_explanation, test_result = self.visit(assrt.test) + explanation = "assert %s" % (test_explanation,) + if not self.frame.is_true(test_result): + try: + raise util.BuiltinAssertionError + except Exception: + raise Failure(explanation) + return explanation, test_result + + def visit_Assign(self, assign): + value_explanation, value_result = self.visit(assign.value) + explanation = "... = %s" % (value_explanation,) + name = ast.Name("__exprinfo_expr", ast.Load(), + lineno=assign.value.lineno, + col_offset=assign.value.col_offset) + new_assign = ast.Assign(assign.targets, name, lineno=assign.lineno, + col_offset=assign.col_offset) + mod = ast.Module([new_assign]) + co = self._compile(mod, "exec") + try: + self.frame.exec_(co, __exprinfo_expr=value_result) + except Exception: + raise Failure(explanation) + return explanation, value_result + diff --git a/testing/web-platform/tests/tools/pytest/_pytest/assertion/rewrite.py b/testing/web-platform/tests/tools/pytest/_pytest/assertion/rewrite.py new file mode 100644 index 000000000..14b8e49db --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/assertion/rewrite.py @@ -0,0 +1,885 @@ +"""Rewrite assertion AST to produce nice error messages""" + +import ast +import errno +import itertools +import imp +import marshal +import os +import re +import struct +import sys +import types + +import py +from _pytest.assertion import util + + +# pytest caches rewritten pycs in __pycache__. +if hasattr(imp, "get_tag"): + PYTEST_TAG = imp.get_tag() + "-PYTEST" +else: + if hasattr(sys, "pypy_version_info"): + impl = "pypy" + elif sys.platform == "java": + impl = "jython" + else: + impl = "cpython" + ver = sys.version_info + PYTEST_TAG = "%s-%s%s-PYTEST" % (impl, ver[0], ver[1]) + del ver, impl + +PYC_EXT = ".py" + (__debug__ and "c" or "o") +PYC_TAIL = "." + PYTEST_TAG + PYC_EXT + +REWRITE_NEWLINES = sys.version_info[:2] != (2, 7) and sys.version_info < (3, 2) +ASCII_IS_DEFAULT_ENCODING = sys.version_info[0] < 3 + +if sys.version_info >= (3,5): + ast_Call = ast.Call +else: + ast_Call = lambda a,b,c: ast.Call(a, b, c, None, None) + + +class AssertionRewritingHook(object): + """PEP302 Import hook which rewrites asserts.""" + + def __init__(self): + self.session = None + self.modules = {} + self._register_with_pkg_resources() + + def set_session(self, session): + self.fnpats = session.config.getini("python_files") + self.session = session + + def find_module(self, name, path=None): + if self.session is None: + return None + sess = self.session + state = sess.config._assertstate + state.trace("find_module called for: %s" % name) + names = name.rsplit(".", 1) + lastname = names[-1] + pth = None + if path is not None: + # Starting with Python 3.3, path is a _NamespacePath(), which + # causes problems if not converted to list. + path = list(path) + if len(path) == 1: + pth = path[0] + if pth is None: + try: + fd, fn, desc = imp.find_module(lastname, path) + except ImportError: + return None + if fd is not None: + fd.close() + tp = desc[2] + if tp == imp.PY_COMPILED: + if hasattr(imp, "source_from_cache"): + fn = imp.source_from_cache(fn) + else: + fn = fn[:-1] + elif tp != imp.PY_SOURCE: + # Don't know what this is. + return None + else: + fn = os.path.join(pth, name.rpartition(".")[2] + ".py") + fn_pypath = py.path.local(fn) + # Is this a test file? + if not sess.isinitpath(fn): + # We have to be very careful here because imports in this code can + # trigger a cycle. + self.session = None + try: + for pat in self.fnpats: + if fn_pypath.fnmatch(pat): + state.trace("matched test file %r" % (fn,)) + break + else: + return None + finally: + self.session = sess + else: + state.trace("matched test file (was specified on cmdline): %r" % + (fn,)) + # The requested module looks like a test file, so rewrite it. This is + # the most magical part of the process: load the source, rewrite the + # asserts, and load the rewritten source. We also cache the rewritten + # module code in a special pyc. We must be aware of the possibility of + # concurrent pytest processes rewriting and loading pycs. To avoid + # tricky race conditions, we maintain the following invariant: The + # cached pyc is always a complete, valid pyc. Operations on it must be + # atomic. POSIX's atomic rename comes in handy. + write = not sys.dont_write_bytecode + cache_dir = os.path.join(fn_pypath.dirname, "__pycache__") + if write: + try: + os.mkdir(cache_dir) + except OSError: + e = sys.exc_info()[1].errno + if e == errno.EEXIST: + # Either the __pycache__ directory already exists (the + # common case) or it's blocked by a non-dir node. In the + # latter case, we'll ignore it in _write_pyc. + pass + elif e in [errno.ENOENT, errno.ENOTDIR]: + # One of the path components was not a directory, likely + # because we're in a zip file. + write = False + elif e in [errno.EACCES, errno.EROFS, errno.EPERM]: + state.trace("read only directory: %r" % fn_pypath.dirname) + write = False + else: + raise + cache_name = fn_pypath.basename[:-3] + PYC_TAIL + pyc = os.path.join(cache_dir, cache_name) + # Notice that even if we're in a read-only directory, I'm going + # to check for a cached pyc. This may not be optimal... + co = _read_pyc(fn_pypath, pyc, state.trace) + if co is None: + state.trace("rewriting %r" % (fn,)) + source_stat, co = _rewrite_test(state, fn_pypath) + if co is None: + # Probably a SyntaxError in the test. + return None + if write: + _make_rewritten_pyc(state, source_stat, pyc, co) + else: + state.trace("found cached rewritten pyc for %r" % (fn,)) + self.modules[name] = co, pyc + return self + + def load_module(self, name): + # If there is an existing module object named 'fullname' in + # sys.modules, the loader must use that existing module. (Otherwise, + # the reload() builtin will not work correctly.) + if name in sys.modules: + return sys.modules[name] + + co, pyc = self.modules.pop(name) + # I wish I could just call imp.load_compiled here, but __file__ has to + # be set properly. In Python 3.2+, this all would be handled correctly + # by load_compiled. + mod = sys.modules[name] = imp.new_module(name) + try: + mod.__file__ = co.co_filename + # Normally, this attribute is 3.2+. + mod.__cached__ = pyc + mod.__loader__ = self + py.builtin.exec_(co, mod.__dict__) + except: + del sys.modules[name] + raise + return sys.modules[name] + + + + def is_package(self, name): + try: + fd, fn, desc = imp.find_module(name) + except ImportError: + return False + if fd is not None: + fd.close() + tp = desc[2] + return tp == imp.PKG_DIRECTORY + + @classmethod + def _register_with_pkg_resources(cls): + """ + Ensure package resources can be loaded from this loader. May be called + multiple times, as the operation is idempotent. + """ + try: + import pkg_resources + # access an attribute in case a deferred importer is present + pkg_resources.__name__ + except ImportError: + return + + # Since pytest tests are always located in the file system, the + # DefaultProvider is appropriate. + pkg_resources.register_loader_type(cls, pkg_resources.DefaultProvider) + + def get_data(self, pathname): + """Optional PEP302 get_data API. + """ + with open(pathname, 'rb') as f: + return f.read() + + +def _write_pyc(state, co, source_stat, pyc): + # Technically, we don't have to have the same pyc format as + # (C)Python, since these "pycs" should never be seen by builtin + # import. However, there's little reason deviate, and I hope + # sometime to be able to use imp.load_compiled to load them. (See + # the comment in load_module above.) + try: + fp = open(pyc, "wb") + except IOError: + err = sys.exc_info()[1].errno + state.trace("error writing pyc file at %s: errno=%s" %(pyc, err)) + # we ignore any failure to write the cache file + # there are many reasons, permission-denied, __pycache__ being a + # file etc. + return False + try: + fp.write(imp.get_magic()) + mtime = int(source_stat.mtime) + size = source_stat.size & 0xFFFFFFFF + fp.write(struct.pack("<ll", mtime, size)) + marshal.dump(co, fp) + finally: + fp.close() + return True + +RN = "\r\n".encode("utf-8") +N = "\n".encode("utf-8") + +cookie_re = re.compile(r"^[ \t\f]*#.*coding[:=][ \t]*[-\w.]+") +BOM_UTF8 = '\xef\xbb\xbf' + +def _rewrite_test(state, fn): + """Try to read and rewrite *fn* and return the code object.""" + try: + stat = fn.stat() + source = fn.read("rb") + except EnvironmentError: + return None, None + if ASCII_IS_DEFAULT_ENCODING: + # ASCII is the default encoding in Python 2. Without a coding + # declaration, Python 2 will complain about any bytes in the file + # outside the ASCII range. Sadly, this behavior does not extend to + # compile() or ast.parse(), which prefer to interpret the bytes as + # latin-1. (At least they properly handle explicit coding cookies.) To + # preserve this error behavior, we could force ast.parse() to use ASCII + # as the encoding by inserting a coding cookie. Unfortunately, that + # messes up line numbers. Thus, we have to check ourselves if anything + # is outside the ASCII range in the case no encoding is explicitly + # declared. For more context, see issue #269. Yay for Python 3 which + # gets this right. + end1 = source.find("\n") + end2 = source.find("\n", end1 + 1) + if (not source.startswith(BOM_UTF8) and + cookie_re.match(source[0:end1]) is None and + cookie_re.match(source[end1 + 1:end2]) is None): + if hasattr(state, "_indecode"): + # encodings imported us again, so don't rewrite. + return None, None + state._indecode = True + try: + try: + source.decode("ascii") + except UnicodeDecodeError: + # Let it fail in real import. + return None, None + finally: + del state._indecode + # On Python versions which are not 2.7 and less than or equal to 3.1, the + # parser expects *nix newlines. + if REWRITE_NEWLINES: + source = source.replace(RN, N) + N + try: + tree = ast.parse(source) + except SyntaxError: + # Let this pop up again in the real import. + state.trace("failed to parse: %r" % (fn,)) + return None, None + rewrite_asserts(tree) + try: + co = compile(tree, fn.strpath, "exec") + except SyntaxError: + # It's possible that this error is from some bug in the + # assertion rewriting, but I don't know of a fast way to tell. + state.trace("failed to compile: %r" % (fn,)) + return None, None + return stat, co + +def _make_rewritten_pyc(state, source_stat, pyc, co): + """Try to dump rewritten code to *pyc*.""" + if sys.platform.startswith("win"): + # Windows grants exclusive access to open files and doesn't have atomic + # rename, so just write into the final file. + _write_pyc(state, co, source_stat, pyc) + else: + # When not on windows, assume rename is atomic. Dump the code object + # into a file specific to this process and atomically replace it. + proc_pyc = pyc + "." + str(os.getpid()) + if _write_pyc(state, co, source_stat, proc_pyc): + os.rename(proc_pyc, pyc) + +def _read_pyc(source, pyc, trace=lambda x: None): + """Possibly read a pytest pyc containing rewritten code. + + Return rewritten code if successful or None if not. + """ + try: + fp = open(pyc, "rb") + except IOError: + return None + with fp: + try: + mtime = int(source.mtime()) + size = source.size() + data = fp.read(12) + except EnvironmentError as e: + trace('_read_pyc(%s): EnvironmentError %s' % (source, e)) + return None + # Check for invalid or out of date pyc file. + if (len(data) != 12 or data[:4] != imp.get_magic() or + struct.unpack("<ll", data[4:]) != (mtime, size)): + trace('_read_pyc(%s): invalid or out of date pyc' % source) + return None + try: + co = marshal.load(fp) + except Exception as e: + trace('_read_pyc(%s): marshal.load error %s' % (source, e)) + return None + if not isinstance(co, types.CodeType): + trace('_read_pyc(%s): not a code object' % source) + return None + return co + + +def rewrite_asserts(mod): + """Rewrite the assert statements in mod.""" + AssertionRewriter().run(mod) + + +def _saferepr(obj): + """Get a safe repr of an object for assertion error messages. + + The assertion formatting (util.format_explanation()) requires + newlines to be escaped since they are a special character for it. + Normally assertion.util.format_explanation() does this but for a + custom repr it is possible to contain one of the special escape + sequences, especially '\n{' and '\n}' are likely to be present in + JSON reprs. + + """ + repr = py.io.saferepr(obj) + if py.builtin._istext(repr): + t = py.builtin.text + else: + t = py.builtin.bytes + return repr.replace(t("\n"), t("\\n")) + + +from _pytest.assertion.util import format_explanation as _format_explanation # noqa + +def _format_assertmsg(obj): + """Format the custom assertion message given. + + For strings this simply replaces newlines with '\n~' so that + util.format_explanation() will preserve them instead of escaping + newlines. For other objects py.io.saferepr() is used first. + + """ + # reprlib appears to have a bug which means that if a string + # contains a newline it gets escaped, however if an object has a + # .__repr__() which contains newlines it does not get escaped. + # However in either case we want to preserve the newline. + if py.builtin._istext(obj) or py.builtin._isbytes(obj): + s = obj + is_repr = False + else: + s = py.io.saferepr(obj) + is_repr = True + if py.builtin._istext(s): + t = py.builtin.text + else: + t = py.builtin.bytes + s = s.replace(t("\n"), t("\n~")).replace(t("%"), t("%%")) + if is_repr: + s = s.replace(t("\\n"), t("\n~")) + return s + +def _should_repr_global_name(obj): + return not hasattr(obj, "__name__") and not py.builtin.callable(obj) + +def _format_boolop(explanations, is_or): + explanation = "(" + (is_or and " or " or " and ").join(explanations) + ")" + if py.builtin._istext(explanation): + t = py.builtin.text + else: + t = py.builtin.bytes + return explanation.replace(t('%'), t('%%')) + +def _call_reprcompare(ops, results, expls, each_obj): + for i, res, expl in zip(range(len(ops)), results, expls): + try: + done = not res + except Exception: + done = True + if done: + break + if util._reprcompare is not None: + custom = util._reprcompare(ops[i], each_obj[i], each_obj[i + 1]) + if custom is not None: + return custom + return expl + + +unary_map = { + ast.Not: "not %s", + ast.Invert: "~%s", + ast.USub: "-%s", + ast.UAdd: "+%s" +} + +binop_map = { + ast.BitOr: "|", + ast.BitXor: "^", + ast.BitAnd: "&", + ast.LShift: "<<", + ast.RShift: ">>", + ast.Add: "+", + ast.Sub: "-", + ast.Mult: "*", + ast.Div: "/", + ast.FloorDiv: "//", + ast.Mod: "%%", # escaped for string formatting + ast.Eq: "==", + ast.NotEq: "!=", + ast.Lt: "<", + ast.LtE: "<=", + ast.Gt: ">", + ast.GtE: ">=", + ast.Pow: "**", + ast.Is: "is", + ast.IsNot: "is not", + ast.In: "in", + ast.NotIn: "not in" +} +# Python 3.5+ compatibility +try: + binop_map[ast.MatMult] = "@" +except AttributeError: + pass + +# Python 3.4+ compatibility +if hasattr(ast, "NameConstant"): + _NameConstant = ast.NameConstant +else: + def _NameConstant(c): + return ast.Name(str(c), ast.Load()) + + +def set_location(node, lineno, col_offset): + """Set node location information recursively.""" + def _fix(node, lineno, col_offset): + if "lineno" in node._attributes: + node.lineno = lineno + if "col_offset" in node._attributes: + node.col_offset = col_offset + for child in ast.iter_child_nodes(node): + _fix(child, lineno, col_offset) + _fix(node, lineno, col_offset) + return node + + +class AssertionRewriter(ast.NodeVisitor): + """Assertion rewriting implementation. + + The main entrypoint is to call .run() with an ast.Module instance, + this will then find all the assert statements and re-write them to + provide intermediate values and a detailed assertion error. See + http://pybites.blogspot.be/2011/07/behind-scenes-of-pytests-new-assertion.html + for an overview of how this works. + + The entry point here is .run() which will iterate over all the + statements in an ast.Module and for each ast.Assert statement it + finds call .visit() with it. Then .visit_Assert() takes over and + is responsible for creating new ast statements to replace the + original assert statement: it re-writes the test of an assertion + to provide intermediate values and replace it with an if statement + which raises an assertion error with a detailed explanation in + case the expression is false. + + For this .visit_Assert() uses the visitor pattern to visit all the + AST nodes of the ast.Assert.test field, each visit call returning + an AST node and the corresponding explanation string. During this + state is kept in several instance attributes: + + :statements: All the AST statements which will replace the assert + statement. + + :variables: This is populated by .variable() with each variable + used by the statements so that they can all be set to None at + the end of the statements. + + :variable_counter: Counter to create new unique variables needed + by statements. Variables are created using .variable() and + have the form of "@py_assert0". + + :on_failure: The AST statements which will be executed if the + assertion test fails. This is the code which will construct + the failure message and raises the AssertionError. + + :explanation_specifiers: A dict filled by .explanation_param() + with %-formatting placeholders and their corresponding + expressions to use in the building of an assertion message. + This is used by .pop_format_context() to build a message. + + :stack: A stack of the explanation_specifiers dicts maintained by + .push_format_context() and .pop_format_context() which allows + to build another %-formatted string while already building one. + + This state is reset on every new assert statement visited and used + by the other visitors. + + """ + + def run(self, mod): + """Find all assert statements in *mod* and rewrite them.""" + if not mod.body: + # Nothing to do. + return + # Insert some special imports at the top of the module but after any + # docstrings and __future__ imports. + aliases = [ast.alias(py.builtin.builtins.__name__, "@py_builtins"), + ast.alias("_pytest.assertion.rewrite", "@pytest_ar")] + expect_docstring = True + pos = 0 + lineno = 0 + for item in mod.body: + if (expect_docstring and isinstance(item, ast.Expr) and + isinstance(item.value, ast.Str)): + doc = item.value.s + if "PYTEST_DONT_REWRITE" in doc: + # The module has disabled assertion rewriting. + return + lineno += len(doc) - 1 + expect_docstring = False + elif (not isinstance(item, ast.ImportFrom) or item.level > 0 or + item.module != "__future__"): + lineno = item.lineno + break + pos += 1 + imports = [ast.Import([alias], lineno=lineno, col_offset=0) + for alias in aliases] + mod.body[pos:pos] = imports + # Collect asserts. + nodes = [mod] + while nodes: + node = nodes.pop() + for name, field in ast.iter_fields(node): + if isinstance(field, list): + new = [] + for i, child in enumerate(field): + if isinstance(child, ast.Assert): + # Transform assert. + new.extend(self.visit(child)) + else: + new.append(child) + if isinstance(child, ast.AST): + nodes.append(child) + setattr(node, name, new) + elif (isinstance(field, ast.AST) and + # Don't recurse into expressions as they can't contain + # asserts. + not isinstance(field, ast.expr)): + nodes.append(field) + + def variable(self): + """Get a new variable.""" + # Use a character invalid in python identifiers to avoid clashing. + name = "@py_assert" + str(next(self.variable_counter)) + self.variables.append(name) + return name + + def assign(self, expr): + """Give *expr* a name.""" + name = self.variable() + self.statements.append(ast.Assign([ast.Name(name, ast.Store())], expr)) + return ast.Name(name, ast.Load()) + + def display(self, expr): + """Call py.io.saferepr on the expression.""" + return self.helper("saferepr", expr) + + def helper(self, name, *args): + """Call a helper in this module.""" + py_name = ast.Name("@pytest_ar", ast.Load()) + attr = ast.Attribute(py_name, "_" + name, ast.Load()) + return ast_Call(attr, list(args), []) + + def builtin(self, name): + """Return the builtin called *name*.""" + builtin_name = ast.Name("@py_builtins", ast.Load()) + return ast.Attribute(builtin_name, name, ast.Load()) + + def explanation_param(self, expr): + """Return a new named %-formatting placeholder for expr. + + This creates a %-formatting placeholder for expr in the + current formatting context, e.g. ``%(py0)s``. The placeholder + and expr are placed in the current format context so that it + can be used on the next call to .pop_format_context(). + + """ + specifier = "py" + str(next(self.variable_counter)) + self.explanation_specifiers[specifier] = expr + return "%(" + specifier + ")s" + + def push_format_context(self): + """Create a new formatting context. + + The format context is used for when an explanation wants to + have a variable value formatted in the assertion message. In + this case the value required can be added using + .explanation_param(). Finally .pop_format_context() is used + to format a string of %-formatted values as added by + .explanation_param(). + + """ + self.explanation_specifiers = {} + self.stack.append(self.explanation_specifiers) + + def pop_format_context(self, expl_expr): + """Format the %-formatted string with current format context. + + The expl_expr should be an ast.Str instance constructed from + the %-placeholders created by .explanation_param(). This will + add the required code to format said string to .on_failure and + return the ast.Name instance of the formatted string. + + """ + current = self.stack.pop() + if self.stack: + self.explanation_specifiers = self.stack[-1] + keys = [ast.Str(key) for key in current.keys()] + format_dict = ast.Dict(keys, list(current.values())) + form = ast.BinOp(expl_expr, ast.Mod(), format_dict) + name = "@py_format" + str(next(self.variable_counter)) + self.on_failure.append(ast.Assign([ast.Name(name, ast.Store())], form)) + return ast.Name(name, ast.Load()) + + def generic_visit(self, node): + """Handle expressions we don't have custom code for.""" + assert isinstance(node, ast.expr) + res = self.assign(node) + return res, self.explanation_param(self.display(res)) + + def visit_Assert(self, assert_): + """Return the AST statements to replace the ast.Assert instance. + + This re-writes the test of an assertion to provide + intermediate values and replace it with an if statement which + raises an assertion error with a detailed explanation in case + the expression is false. + + """ + self.statements = [] + self.variables = [] + self.variable_counter = itertools.count() + self.stack = [] + self.on_failure = [] + self.push_format_context() + # Rewrite assert into a bunch of statements. + top_condition, explanation = self.visit(assert_.test) + # Create failure message. + body = self.on_failure + negation = ast.UnaryOp(ast.Not(), top_condition) + self.statements.append(ast.If(negation, body, [])) + if assert_.msg: + assertmsg = self.helper('format_assertmsg', assert_.msg) + explanation = "\n>assert " + explanation + else: + assertmsg = ast.Str("") + explanation = "assert " + explanation + template = ast.BinOp(assertmsg, ast.Add(), ast.Str(explanation)) + msg = self.pop_format_context(template) + fmt = self.helper("format_explanation", msg) + err_name = ast.Name("AssertionError", ast.Load()) + exc = ast_Call(err_name, [fmt], []) + if sys.version_info[0] >= 3: + raise_ = ast.Raise(exc, None) + else: + raise_ = ast.Raise(exc, None, None) + body.append(raise_) + # Clear temporary variables by setting them to None. + if self.variables: + variables = [ast.Name(name, ast.Store()) + for name in self.variables] + clear = ast.Assign(variables, _NameConstant(None)) + self.statements.append(clear) + # Fix line numbers. + for stmt in self.statements: + set_location(stmt, assert_.lineno, assert_.col_offset) + return self.statements + + def visit_Name(self, name): + # Display the repr of the name if it's a local variable or + # _should_repr_global_name() thinks it's acceptable. + locs = ast_Call(self.builtin("locals"), [], []) + inlocs = ast.Compare(ast.Str(name.id), [ast.In()], [locs]) + dorepr = self.helper("should_repr_global_name", name) + test = ast.BoolOp(ast.Or(), [inlocs, dorepr]) + expr = ast.IfExp(test, self.display(name), ast.Str(name.id)) + return name, self.explanation_param(expr) + + def visit_BoolOp(self, boolop): + res_var = self.variable() + expl_list = self.assign(ast.List([], ast.Load())) + app = ast.Attribute(expl_list, "append", ast.Load()) + is_or = int(isinstance(boolop.op, ast.Or)) + body = save = self.statements + fail_save = self.on_failure + levels = len(boolop.values) - 1 + self.push_format_context() + # Process each operand, short-circuting if needed. + for i, v in enumerate(boolop.values): + if i: + fail_inner = [] + # cond is set in a prior loop iteration below + self.on_failure.append(ast.If(cond, fail_inner, [])) # noqa + self.on_failure = fail_inner + self.push_format_context() + res, expl = self.visit(v) + body.append(ast.Assign([ast.Name(res_var, ast.Store())], res)) + expl_format = self.pop_format_context(ast.Str(expl)) + call = ast_Call(app, [expl_format], []) + self.on_failure.append(ast.Expr(call)) + if i < levels: + cond = res + if is_or: + cond = ast.UnaryOp(ast.Not(), cond) + inner = [] + self.statements.append(ast.If(cond, inner, [])) + self.statements = body = inner + self.statements = save + self.on_failure = fail_save + expl_template = self.helper("format_boolop", expl_list, ast.Num(is_or)) + expl = self.pop_format_context(expl_template) + return ast.Name(res_var, ast.Load()), self.explanation_param(expl) + + def visit_UnaryOp(self, unary): + pattern = unary_map[unary.op.__class__] + operand_res, operand_expl = self.visit(unary.operand) + res = self.assign(ast.UnaryOp(unary.op, operand_res)) + return res, pattern % (operand_expl,) + + def visit_BinOp(self, binop): + symbol = binop_map[binop.op.__class__] + left_expr, left_expl = self.visit(binop.left) + right_expr, right_expl = self.visit(binop.right) + explanation = "(%s %s %s)" % (left_expl, symbol, right_expl) + res = self.assign(ast.BinOp(left_expr, binop.op, right_expr)) + return res, explanation + + def visit_Call_35(self, call): + """ + visit `ast.Call` nodes on Python3.5 and after + """ + new_func, func_expl = self.visit(call.func) + arg_expls = [] + new_args = [] + new_kwargs = [] + for arg in call.args: + res, expl = self.visit(arg) + arg_expls.append(expl) + new_args.append(res) + for keyword in call.keywords: + res, expl = self.visit(keyword.value) + new_kwargs.append(ast.keyword(keyword.arg, res)) + if keyword.arg: + arg_expls.append(keyword.arg + "=" + expl) + else: ## **args have `arg` keywords with an .arg of None + arg_expls.append("**" + expl) + + expl = "%s(%s)" % (func_expl, ', '.join(arg_expls)) + new_call = ast.Call(new_func, new_args, new_kwargs) + res = self.assign(new_call) + res_expl = self.explanation_param(self.display(res)) + outer_expl = "%s\n{%s = %s\n}" % (res_expl, res_expl, expl) + return res, outer_expl + + def visit_Starred(self, starred): + # From Python 3.5, a Starred node can appear in a function call + res, expl = self.visit(starred.value) + return starred, '*' + expl + + def visit_Call_legacy(self, call): + """ + visit `ast.Call nodes on 3.4 and below` + """ + new_func, func_expl = self.visit(call.func) + arg_expls = [] + new_args = [] + new_kwargs = [] + new_star = new_kwarg = None + for arg in call.args: + res, expl = self.visit(arg) + new_args.append(res) + arg_expls.append(expl) + for keyword in call.keywords: + res, expl = self.visit(keyword.value) + new_kwargs.append(ast.keyword(keyword.arg, res)) + arg_expls.append(keyword.arg + "=" + expl) + if call.starargs: + new_star, expl = self.visit(call.starargs) + arg_expls.append("*" + expl) + if call.kwargs: + new_kwarg, expl = self.visit(call.kwargs) + arg_expls.append("**" + expl) + expl = "%s(%s)" % (func_expl, ', '.join(arg_expls)) + new_call = ast.Call(new_func, new_args, new_kwargs, + new_star, new_kwarg) + res = self.assign(new_call) + res_expl = self.explanation_param(self.display(res)) + outer_expl = "%s\n{%s = %s\n}" % (res_expl, res_expl, expl) + return res, outer_expl + + # ast.Call signature changed on 3.5, + # conditionally change which methods is named + # visit_Call depending on Python version + if sys.version_info >= (3, 5): + visit_Call = visit_Call_35 + else: + visit_Call = visit_Call_legacy + + + def visit_Attribute(self, attr): + if not isinstance(attr.ctx, ast.Load): + return self.generic_visit(attr) + value, value_expl = self.visit(attr.value) + res = self.assign(ast.Attribute(value, attr.attr, ast.Load())) + res_expl = self.explanation_param(self.display(res)) + pat = "%s\n{%s = %s.%s\n}" + expl = pat % (res_expl, res_expl, value_expl, attr.attr) + return res, expl + + def visit_Compare(self, comp): + self.push_format_context() + left_res, left_expl = self.visit(comp.left) + res_variables = [self.variable() for i in range(len(comp.ops))] + load_names = [ast.Name(v, ast.Load()) for v in res_variables] + store_names = [ast.Name(v, ast.Store()) for v in res_variables] + it = zip(range(len(comp.ops)), comp.ops, comp.comparators) + expls = [] + syms = [] + results = [left_res] + for i, op, next_operand in it: + next_res, next_expl = self.visit(next_operand) + results.append(next_res) + sym = binop_map[op.__class__] + syms.append(ast.Str(sym)) + expl = "%s %s %s" % (left_expl, sym, next_expl) + expls.append(ast.Str(expl)) + res_expr = ast.Compare(left_res, [op], [next_res]) + self.statements.append(ast.Assign([store_names[i]], res_expr)) + left_res, left_expl = next_res, next_expl + # Use pytest.assertion.util._reprcompare if that's available. + expl_call = self.helper("call_reprcompare", + ast.Tuple(syms, ast.Load()), + ast.Tuple(load_names, ast.Load()), + ast.Tuple(expls, ast.Load()), + ast.Tuple(results, ast.Load())) + if len(comp.ops) > 1: + res = ast.BoolOp(ast.And(), load_names) + else: + res = load_names[0] + return res, self.explanation_param(self.pop_format_context(expl_call)) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/assertion/util.py b/testing/web-platform/tests/tools/pytest/_pytest/assertion/util.py new file mode 100644 index 000000000..f2f23efea --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/assertion/util.py @@ -0,0 +1,332 @@ +"""Utilities for assertion debugging""" +import pprint + +import _pytest._code +import py +try: + from collections import Sequence +except ImportError: + Sequence = list + +BuiltinAssertionError = py.builtin.builtins.AssertionError +u = py.builtin._totext + +# The _reprcompare attribute on the util module is used by the new assertion +# interpretation code and assertion rewriter to detect this plugin was +# loaded and in turn call the hooks defined here as part of the +# DebugInterpreter. +_reprcompare = None + + +# the re-encoding is needed for python2 repr +# with non-ascii characters (see issue 877 and 1379) +def ecu(s): + try: + return u(s, 'utf-8', 'replace') + except TypeError: + return s + + +def format_explanation(explanation): + """This formats an explanation + + Normally all embedded newlines are escaped, however there are + three exceptions: \n{, \n} and \n~. The first two are intended + cover nested explanations, see function and attribute explanations + for examples (.visit_Call(), visit_Attribute()). The last one is + for when one explanation needs to span multiple lines, e.g. when + displaying diffs. + """ + explanation = ecu(explanation) + explanation = _collapse_false(explanation) + lines = _split_explanation(explanation) + result = _format_lines(lines) + return u('\n').join(result) + + +def _collapse_false(explanation): + """Collapse expansions of False + + So this strips out any "assert False\n{where False = ...\n}" + blocks. + """ + where = 0 + while True: + start = where = explanation.find("False\n{False = ", where) + if where == -1: + break + level = 0 + prev_c = explanation[start] + for i, c in enumerate(explanation[start:]): + if prev_c + c == "\n{": + level += 1 + elif prev_c + c == "\n}": + level -= 1 + if not level: + break + prev_c = c + else: + raise AssertionError("unbalanced braces: %r" % (explanation,)) + end = start + i + where = end + if explanation[end - 1] == '\n': + explanation = (explanation[:start] + explanation[start+15:end-1] + + explanation[end+1:]) + where -= 17 + return explanation + + +def _split_explanation(explanation): + """Return a list of individual lines in the explanation + + This will return a list of lines split on '\n{', '\n}' and '\n~'. + Any other newlines will be escaped and appear in the line as the + literal '\n' characters. + """ + raw_lines = (explanation or u('')).split('\n') + lines = [raw_lines[0]] + for l in raw_lines[1:]: + if l and l[0] in ['{', '}', '~', '>']: + lines.append(l) + else: + lines[-1] += '\\n' + l + return lines + + +def _format_lines(lines): + """Format the individual lines + + This will replace the '{', '}' and '~' characters of our mini + formatting language with the proper 'where ...', 'and ...' and ' + + ...' text, taking care of indentation along the way. + + Return a list of formatted lines. + """ + result = lines[:1] + stack = [0] + stackcnt = [0] + for line in lines[1:]: + if line.startswith('{'): + if stackcnt[-1]: + s = u('and ') + else: + s = u('where ') + stack.append(len(result)) + stackcnt[-1] += 1 + stackcnt.append(0) + result.append(u(' +') + u(' ')*(len(stack)-1) + s + line[1:]) + elif line.startswith('}'): + stack.pop() + stackcnt.pop() + result[stack[-1]] += line[1:] + else: + assert line[0] in ['~', '>'] + stack[-1] += 1 + indent = len(stack) if line.startswith('~') else len(stack) - 1 + result.append(u(' ')*indent + line[1:]) + assert len(stack) == 1 + return result + + +# Provide basestring in python3 +try: + basestring = basestring +except NameError: + basestring = str + + +def assertrepr_compare(config, op, left, right): + """Return specialised explanations for some operators/operands""" + width = 80 - 15 - len(op) - 2 # 15 chars indentation, 1 space around op + left_repr = py.io.saferepr(left, maxsize=int(width/2)) + right_repr = py.io.saferepr(right, maxsize=width-len(left_repr)) + + summary = u('%s %s %s') % (ecu(left_repr), op, ecu(right_repr)) + + issequence = lambda x: (isinstance(x, (list, tuple, Sequence)) and + not isinstance(x, basestring)) + istext = lambda x: isinstance(x, basestring) + isdict = lambda x: isinstance(x, dict) + isset = lambda x: isinstance(x, (set, frozenset)) + + def isiterable(obj): + try: + iter(obj) + return not istext(obj) + except TypeError: + return False + + verbose = config.getoption('verbose') + explanation = None + try: + if op == '==': + if istext(left) and istext(right): + explanation = _diff_text(left, right, verbose) + else: + if issequence(left) and issequence(right): + explanation = _compare_eq_sequence(left, right, verbose) + elif isset(left) and isset(right): + explanation = _compare_eq_set(left, right, verbose) + elif isdict(left) and isdict(right): + explanation = _compare_eq_dict(left, right, verbose) + if isiterable(left) and isiterable(right): + expl = _compare_eq_iterable(left, right, verbose) + if explanation is not None: + explanation.extend(expl) + else: + explanation = expl + elif op == 'not in': + if istext(left) and istext(right): + explanation = _notin_text(left, right, verbose) + except Exception: + explanation = [ + u('(pytest_assertion plugin: representation of details failed. ' + 'Probably an object has a faulty __repr__.)'), + u(_pytest._code.ExceptionInfo())] + + if not explanation: + return None + + return [summary] + explanation + + +def _diff_text(left, right, verbose=False): + """Return the explanation for the diff between text or bytes + + Unless --verbose is used this will skip leading and trailing + characters which are identical to keep the diff minimal. + + If the input are bytes they will be safely converted to text. + """ + from difflib import ndiff + explanation = [] + if isinstance(left, py.builtin.bytes): + left = u(repr(left)[1:-1]).replace(r'\n', '\n') + if isinstance(right, py.builtin.bytes): + right = u(repr(right)[1:-1]).replace(r'\n', '\n') + if not verbose: + i = 0 # just in case left or right has zero length + for i in range(min(len(left), len(right))): + if left[i] != right[i]: + break + if i > 42: + i -= 10 # Provide some context + explanation = [u('Skipping %s identical leading ' + 'characters in diff, use -v to show') % i] + left = left[i:] + right = right[i:] + if len(left) == len(right): + for i in range(len(left)): + if left[-i] != right[-i]: + break + if i > 42: + i -= 10 # Provide some context + explanation += [u('Skipping %s identical trailing ' + 'characters in diff, use -v to show') % i] + left = left[:-i] + right = right[:-i] + explanation += [line.strip('\n') + for line in ndiff(left.splitlines(), + right.splitlines())] + return explanation + + +def _compare_eq_iterable(left, right, verbose=False): + if not verbose: + return [u('Use -v to get the full diff')] + # dynamic import to speedup pytest + import difflib + + try: + left_formatting = pprint.pformat(left).splitlines() + right_formatting = pprint.pformat(right).splitlines() + explanation = [u('Full diff:')] + except Exception: + # hack: PrettyPrinter.pformat() in python 2 fails when formatting items that can't be sorted(), ie, calling + # sorted() on a list would raise. See issue #718. + # As a workaround, the full diff is generated by using the repr() string of each item of each container. + left_formatting = sorted(repr(x) for x in left) + right_formatting = sorted(repr(x) for x in right) + explanation = [u('Full diff (fallback to calling repr on each item):')] + explanation.extend(line.strip() for line in difflib.ndiff(left_formatting, right_formatting)) + return explanation + + +def _compare_eq_sequence(left, right, verbose=False): + explanation = [] + for i in range(min(len(left), len(right))): + if left[i] != right[i]: + explanation += [u('At index %s diff: %r != %r') + % (i, left[i], right[i])] + break + if len(left) > len(right): + explanation += [u('Left contains more items, first extra item: %s') + % py.io.saferepr(left[len(right)],)] + elif len(left) < len(right): + explanation += [ + u('Right contains more items, first extra item: %s') % + py.io.saferepr(right[len(left)],)] + return explanation + + +def _compare_eq_set(left, right, verbose=False): + explanation = [] + diff_left = left - right + diff_right = right - left + if diff_left: + explanation.append(u('Extra items in the left set:')) + for item in diff_left: + explanation.append(py.io.saferepr(item)) + if diff_right: + explanation.append(u('Extra items in the right set:')) + for item in diff_right: + explanation.append(py.io.saferepr(item)) + return explanation + + +def _compare_eq_dict(left, right, verbose=False): + explanation = [] + common = set(left).intersection(set(right)) + same = dict((k, left[k]) for k in common if left[k] == right[k]) + if same and not verbose: + explanation += [u('Omitting %s identical items, use -v to show') % + len(same)] + elif same: + explanation += [u('Common items:')] + explanation += pprint.pformat(same).splitlines() + diff = set(k for k in common if left[k] != right[k]) + if diff: + explanation += [u('Differing items:')] + for k in diff: + explanation += [py.io.saferepr({k: left[k]}) + ' != ' + + py.io.saferepr({k: right[k]})] + extra_left = set(left) - set(right) + if extra_left: + explanation.append(u('Left contains more items:')) + explanation.extend(pprint.pformat( + dict((k, left[k]) for k in extra_left)).splitlines()) + extra_right = set(right) - set(left) + if extra_right: + explanation.append(u('Right contains more items:')) + explanation.extend(pprint.pformat( + dict((k, right[k]) for k in extra_right)).splitlines()) + return explanation + + +def _notin_text(term, text, verbose=False): + index = text.find(term) + head = text[:index] + tail = text[index+len(term):] + correct_text = head + tail + diff = _diff_text(correct_text, text, verbose) + newdiff = [u('%s is contained here:') % py.io.saferepr(term, maxsize=42)] + for line in diff: + if line.startswith(u('Skipping')): + continue + if line.startswith(u('- ')): + continue + if line.startswith(u('+ ')): + newdiff.append(u(' ') + line[2:]) + else: + newdiff.append(line) + return newdiff diff --git a/testing/web-platform/tests/tools/pytest/_pytest/cacheprovider.py b/testing/web-platform/tests/tools/pytest/_pytest/cacheprovider.py new file mode 100755 index 000000000..0657001f2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/cacheprovider.py @@ -0,0 +1,245 @@ +""" +merged implementation of the cache provider + +the name cache was not choosen to ensure pluggy automatically +ignores the external pytest-cache +""" + +import py +import pytest +import json +from os.path import sep as _sep, altsep as _altsep + + +class Cache(object): + def __init__(self, config): + self.config = config + self._cachedir = config.rootdir.join(".cache") + self.trace = config.trace.root.get("cache") + if config.getvalue("cacheclear"): + self.trace("clearing cachedir") + if self._cachedir.check(): + self._cachedir.remove() + self._cachedir.mkdir() + + def makedir(self, name): + """ return a directory path object with the given name. If the + directory does not yet exist, it will be created. You can use it + to manage files likes e. g. store/retrieve database + dumps across test sessions. + + :param name: must be a string not containing a ``/`` separator. + Make sure the name contains your plugin or application + identifiers to prevent clashes with other cache users. + """ + if _sep in name or _altsep is not None and _altsep in name: + raise ValueError("name is not allowed to contain path separators") + return self._cachedir.ensure_dir("d", name) + + def _getvaluepath(self, key): + return self._cachedir.join('v', *key.split('/')) + + def get(self, key, default): + """ return cached value for the given key. If no value + was yet cached or the value cannot be read, the specified + default is returned. + + :param key: must be a ``/`` separated value. Usually the first + name is the name of your plugin or your application. + :param default: must be provided in case of a cache-miss or + invalid cache values. + + """ + path = self._getvaluepath(key) + if path.check(): + try: + with path.open("r") as f: + return json.load(f) + except ValueError: + self.trace("cache-invalid at %s" % (path,)) + return default + + def set(self, key, value): + """ save value for the given key. + + :param key: must be a ``/`` separated value. Usually the first + name is the name of your plugin or your application. + :param value: must be of any combination of basic + python types, including nested types + like e. g. lists of dictionaries. + """ + path = self._getvaluepath(key) + try: + path.dirpath().ensure_dir() + except (py.error.EEXIST, py.error.EACCES): + self.config.warn( + code='I9', message='could not create cache path %s' % (path,) + ) + return + try: + f = path.open('w') + except py.error.ENOTDIR: + self.config.warn( + code='I9', message='cache could not write path %s' % (path,)) + else: + with f: + self.trace("cache-write %s: %r" % (key, value,)) + json.dump(value, f, indent=2, sort_keys=True) + + +class LFPlugin: + """ Plugin which implements the --lf (run last-failing) option """ + def __init__(self, config): + self.config = config + active_keys = 'lf', 'failedfirst' + self.active = any(config.getvalue(key) for key in active_keys) + if self.active: + self.lastfailed = config.cache.get("cache/lastfailed", {}) + else: + self.lastfailed = {} + + def pytest_report_header(self): + if self.active: + if not self.lastfailed: + mode = "run all (no recorded failures)" + else: + mode = "rerun last %d failures%s" % ( + len(self.lastfailed), + " first" if self.config.getvalue("failedfirst") else "") + return "run-last-failure: %s" % mode + + def pytest_runtest_logreport(self, report): + if report.failed and "xfail" not in report.keywords: + self.lastfailed[report.nodeid] = True + elif not report.failed: + if report.when == "call": + self.lastfailed.pop(report.nodeid, None) + + def pytest_collectreport(self, report): + passed = report.outcome in ('passed', 'skipped') + if passed: + if report.nodeid in self.lastfailed: + self.lastfailed.pop(report.nodeid) + self.lastfailed.update( + (item.nodeid, True) + for item in report.result) + else: + self.lastfailed[report.nodeid] = True + + def pytest_collection_modifyitems(self, session, config, items): + if self.active and self.lastfailed: + previously_failed = [] + previously_passed = [] + for item in items: + if item.nodeid in self.lastfailed: + previously_failed.append(item) + else: + previously_passed.append(item) + if not previously_failed and previously_passed: + # running a subset of all tests with recorded failures outside + # of the set of tests currently executing + pass + elif self.config.getvalue("failedfirst"): + items[:] = previously_failed + previously_passed + else: + items[:] = previously_failed + config.hook.pytest_deselected(items=previously_passed) + + def pytest_sessionfinish(self, session): + config = self.config + if config.getvalue("cacheshow") or hasattr(config, "slaveinput"): + return + prev_failed = config.cache.get("cache/lastfailed", None) is not None + if (session.testscollected and prev_failed) or self.lastfailed: + config.cache.set("cache/lastfailed", self.lastfailed) + + +def pytest_addoption(parser): + group = parser.getgroup("general") + group.addoption( + '--lf', '--last-failed', action='store_true', dest="lf", + help="rerun only the tests that failed " + "at the last run (or all if none failed)") + group.addoption( + '--ff', '--failed-first', action='store_true', dest="failedfirst", + help="run all tests but run the last failures first. " + "This may re-order tests and thus lead to " + "repeated fixture setup/teardown") + group.addoption( + '--cache-show', action='store_true', dest="cacheshow", + help="show cache contents, don't perform collection or tests") + group.addoption( + '--cache-clear', action='store_true', dest="cacheclear", + help="remove all cache contents at start of test run.") + + +def pytest_cmdline_main(config): + if config.option.cacheshow: + from _pytest.main import wrap_session + return wrap_session(config, cacheshow) + + + +@pytest.hookimpl(tryfirst=True) +def pytest_configure(config): + config.cache = Cache(config) + config.pluginmanager.register(LFPlugin(config), "lfplugin") + + +@pytest.fixture +def cache(request): + """ + Return a cache object that can persist state between testing sessions. + + cache.get(key, default) + cache.set(key, value) + + Keys must be a ``/`` separated value, where the first part is usually the + name of your plugin or application to avoid clashes with other cache users. + + Values can be any object handled by the json stdlib module. + """ + return request.config.cache + + +def pytest_report_header(config): + if config.option.verbose: + relpath = py.path.local().bestrelpath(config.cache._cachedir) + return "cachedir: %s" % relpath + + +def cacheshow(config, session): + from pprint import pprint + tw = py.io.TerminalWriter() + tw.line("cachedir: " + str(config.cache._cachedir)) + if not config.cache._cachedir.check(): + tw.line("cache is empty") + return 0 + dummy = object() + basedir = config.cache._cachedir + vdir = basedir.join("v") + tw.sep("-", "cache values") + for valpath in vdir.visit(lambda x: x.isfile()): + key = valpath.relto(vdir).replace(valpath.sep, "/") + val = config.cache.get(key, dummy) + if val is dummy: + tw.line("%s contains unreadable content, " + "will be ignored" % key) + else: + tw.line("%s contains:" % key) + stream = py.io.TextIO() + pprint(val, stream=stream) + for line in stream.getvalue().splitlines(): + tw.line(" " + line) + + ddir = basedir.join("d") + if ddir.isdir() and ddir.listdir(): + tw.sep("-", "cache directories") + for p in basedir.join("d").visit(): + #if p.check(dir=1): + # print("%s/" % p.relto(basedir)) + if p.isfile(): + key = p.relto(basedir) + tw.line("%s is a file of length %d" % ( + key, p.size())) + return 0 diff --git a/testing/web-platform/tests/tools/pytest/_pytest/capture.py b/testing/web-platform/tests/tools/pytest/_pytest/capture.py new file mode 100644 index 000000000..3895a714a --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/capture.py @@ -0,0 +1,472 @@ +""" +per-test stdout/stderr capturing mechanism. + +""" +from __future__ import with_statement + +import sys +import os +from tempfile import TemporaryFile + +import py +import pytest + +from py.io import TextIO +unicode = py.builtin.text + +patchsysdict = {0: 'stdin', 1: 'stdout', 2: 'stderr'} + + +def pytest_addoption(parser): + group = parser.getgroup("general") + group._addoption( + '--capture', action="store", + default="fd" if hasattr(os, "dup") else "sys", + metavar="method", choices=['fd', 'sys', 'no'], + help="per-test capturing method: one of fd|sys|no.") + group._addoption( + '-s', action="store_const", const="no", dest="capture", + help="shortcut for --capture=no.") + + +@pytest.hookimpl(hookwrapper=True) +def pytest_load_initial_conftests(early_config, parser, args): + _readline_workaround() + ns = early_config.known_args_namespace + pluginmanager = early_config.pluginmanager + capman = CaptureManager(ns.capture) + pluginmanager.register(capman, "capturemanager") + + # make sure that capturemanager is properly reset at final shutdown + early_config.add_cleanup(capman.reset_capturings) + + # make sure logging does not raise exceptions at the end + def silence_logging_at_shutdown(): + if "logging" in sys.modules: + sys.modules["logging"].raiseExceptions = False + early_config.add_cleanup(silence_logging_at_shutdown) + + # finally trigger conftest loading but while capturing (issue93) + capman.init_capturings() + outcome = yield + out, err = capman.suspendcapture() + if outcome.excinfo is not None: + sys.stdout.write(out) + sys.stderr.write(err) + + +class CaptureManager: + def __init__(self, method): + self._method = method + + def _getcapture(self, method): + if method == "fd": + return MultiCapture(out=True, err=True, Capture=FDCapture) + elif method == "sys": + return MultiCapture(out=True, err=True, Capture=SysCapture) + elif method == "no": + return MultiCapture(out=False, err=False, in_=False) + else: + raise ValueError("unknown capturing method: %r" % method) + + def init_capturings(self): + assert not hasattr(self, "_capturing") + self._capturing = self._getcapture(self._method) + self._capturing.start_capturing() + + def reset_capturings(self): + cap = self.__dict__.pop("_capturing", None) + if cap is not None: + cap.pop_outerr_to_orig() + cap.stop_capturing() + + def resumecapture(self): + self._capturing.resume_capturing() + + def suspendcapture(self, in_=False): + self.deactivate_funcargs() + cap = getattr(self, "_capturing", None) + if cap is not None: + try: + outerr = cap.readouterr() + finally: + cap.suspend_capturing(in_=in_) + return outerr + + def activate_funcargs(self, pyfuncitem): + capfuncarg = pyfuncitem.__dict__.pop("_capfuncarg", None) + if capfuncarg is not None: + capfuncarg._start() + self._capfuncarg = capfuncarg + + def deactivate_funcargs(self): + capfuncarg = self.__dict__.pop("_capfuncarg", None) + if capfuncarg is not None: + capfuncarg.close() + + @pytest.hookimpl(hookwrapper=True) + def pytest_make_collect_report(self, collector): + if isinstance(collector, pytest.File): + self.resumecapture() + outcome = yield + out, err = self.suspendcapture() + rep = outcome.get_result() + if out: + rep.sections.append(("Captured stdout", out)) + if err: + rep.sections.append(("Captured stderr", err)) + else: + yield + + @pytest.hookimpl(hookwrapper=True) + def pytest_runtest_setup(self, item): + self.resumecapture() + yield + self.suspendcapture_item(item, "setup") + + @pytest.hookimpl(hookwrapper=True) + def pytest_runtest_call(self, item): + self.resumecapture() + self.activate_funcargs(item) + yield + #self.deactivate_funcargs() called from suspendcapture() + self.suspendcapture_item(item, "call") + + @pytest.hookimpl(hookwrapper=True) + def pytest_runtest_teardown(self, item): + self.resumecapture() + yield + self.suspendcapture_item(item, "teardown") + + @pytest.hookimpl(tryfirst=True) + def pytest_keyboard_interrupt(self, excinfo): + self.reset_capturings() + + @pytest.hookimpl(tryfirst=True) + def pytest_internalerror(self, excinfo): + self.reset_capturings() + + def suspendcapture_item(self, item, when): + out, err = self.suspendcapture() + item.add_report_section(when, "stdout", out) + item.add_report_section(when, "stderr", err) + +error_capsysfderror = "cannot use capsys and capfd at the same time" + + +@pytest.fixture +def capsys(request): + """enables capturing of writes to sys.stdout/sys.stderr and makes + captured output available via ``capsys.readouterr()`` method calls + which return a ``(out, err)`` tuple. + """ + if "capfd" in request._funcargs: + raise request.raiseerror(error_capsysfderror) + request.node._capfuncarg = c = CaptureFixture(SysCapture) + return c + +@pytest.fixture +def capfd(request): + """enables capturing of writes to file descriptors 1 and 2 and makes + captured output available via ``capfd.readouterr()`` method calls + which return a ``(out, err)`` tuple. + """ + if "capsys" in request._funcargs: + request.raiseerror(error_capsysfderror) + if not hasattr(os, 'dup'): + pytest.skip("capfd funcarg needs os.dup") + request.node._capfuncarg = c = CaptureFixture(FDCapture) + return c + + +class CaptureFixture: + def __init__(self, captureclass): + self.captureclass = captureclass + + def _start(self): + self._capture = MultiCapture(out=True, err=True, in_=False, + Capture=self.captureclass) + self._capture.start_capturing() + + def close(self): + cap = self.__dict__.pop("_capture", None) + if cap is not None: + self._outerr = cap.pop_outerr_to_orig() + cap.stop_capturing() + + def readouterr(self): + try: + return self._capture.readouterr() + except AttributeError: + return self._outerr + + +def safe_text_dupfile(f, mode, default_encoding="UTF8"): + """ return a open text file object that's a duplicate of f on the + FD-level if possible. + """ + encoding = getattr(f, "encoding", None) + try: + fd = f.fileno() + except Exception: + if "b" not in getattr(f, "mode", "") and hasattr(f, "encoding"): + # we seem to have a text stream, let's just use it + return f + else: + newfd = os.dup(fd) + if "b" not in mode: + mode += "b" + f = os.fdopen(newfd, mode, 0) # no buffering + return EncodedFile(f, encoding or default_encoding) + + +class EncodedFile(object): + errors = "strict" # possibly needed by py3 code (issue555) + def __init__(self, buffer, encoding): + self.buffer = buffer + self.encoding = encoding + + def write(self, obj): + if isinstance(obj, unicode): + obj = obj.encode(self.encoding, "replace") + self.buffer.write(obj) + + def writelines(self, linelist): + data = ''.join(linelist) + self.write(data) + + def __getattr__(self, name): + return getattr(object.__getattribute__(self, "buffer"), name) + + +class MultiCapture(object): + out = err = in_ = None + + def __init__(self, out=True, err=True, in_=True, Capture=None): + if in_: + self.in_ = Capture(0) + if out: + self.out = Capture(1) + if err: + self.err = Capture(2) + + def start_capturing(self): + if self.in_: + self.in_.start() + if self.out: + self.out.start() + if self.err: + self.err.start() + + def pop_outerr_to_orig(self): + """ pop current snapshot out/err capture and flush to orig streams. """ + out, err = self.readouterr() + if out: + self.out.writeorg(out) + if err: + self.err.writeorg(err) + return out, err + + def suspend_capturing(self, in_=False): + if self.out: + self.out.suspend() + if self.err: + self.err.suspend() + if in_ and self.in_: + self.in_.suspend() + self._in_suspended = True + + def resume_capturing(self): + if self.out: + self.out.resume() + if self.err: + self.err.resume() + if hasattr(self, "_in_suspended"): + self.in_.resume() + del self._in_suspended + + def stop_capturing(self): + """ stop capturing and reset capturing streams """ + if hasattr(self, '_reset'): + raise ValueError("was already stopped") + self._reset = True + if self.out: + self.out.done() + if self.err: + self.err.done() + if self.in_: + self.in_.done() + + def readouterr(self): + """ return snapshot unicode value of stdout/stderr capturings. """ + return (self.out.snap() if self.out is not None else "", + self.err.snap() if self.err is not None else "") + +class NoCapture: + __init__ = start = done = suspend = resume = lambda *args: None + +class FDCapture: + """ Capture IO to/from a given os-level filedescriptor. """ + + def __init__(self, targetfd, tmpfile=None): + self.targetfd = targetfd + try: + self.targetfd_save = os.dup(self.targetfd) + except OSError: + self.start = lambda: None + self.done = lambda: None + else: + if targetfd == 0: + assert not tmpfile, "cannot set tmpfile with stdin" + tmpfile = open(os.devnull, "r") + self.syscapture = SysCapture(targetfd) + else: + if tmpfile is None: + f = TemporaryFile() + with f: + tmpfile = safe_text_dupfile(f, mode="wb+") + if targetfd in patchsysdict: + self.syscapture = SysCapture(targetfd, tmpfile) + else: + self.syscapture = NoCapture() + self.tmpfile = tmpfile + self.tmpfile_fd = tmpfile.fileno() + + def __repr__(self): + return "<FDCapture %s oldfd=%s>" % (self.targetfd, self.targetfd_save) + + def start(self): + """ Start capturing on targetfd using memorized tmpfile. """ + try: + os.fstat(self.targetfd_save) + except (AttributeError, OSError): + raise ValueError("saved filedescriptor not valid anymore") + os.dup2(self.tmpfile_fd, self.targetfd) + self.syscapture.start() + + def snap(self): + f = self.tmpfile + f.seek(0) + res = f.read() + if res: + enc = getattr(f, "encoding", None) + if enc and isinstance(res, bytes): + res = py.builtin._totext(res, enc, "replace") + f.truncate(0) + f.seek(0) + return res + return '' + + def done(self): + """ stop capturing, restore streams, return original capture file, + seeked to position zero. """ + targetfd_save = self.__dict__.pop("targetfd_save") + os.dup2(targetfd_save, self.targetfd) + os.close(targetfd_save) + self.syscapture.done() + self.tmpfile.close() + + def suspend(self): + self.syscapture.suspend() + os.dup2(self.targetfd_save, self.targetfd) + + def resume(self): + self.syscapture.resume() + os.dup2(self.tmpfile_fd, self.targetfd) + + def writeorg(self, data): + """ write to original file descriptor. """ + if py.builtin._istext(data): + data = data.encode("utf8") # XXX use encoding of original stream + os.write(self.targetfd_save, data) + + +class SysCapture: + def __init__(self, fd, tmpfile=None): + name = patchsysdict[fd] + self._old = getattr(sys, name) + self.name = name + if tmpfile is None: + if name == "stdin": + tmpfile = DontReadFromInput() + else: + tmpfile = TextIO() + self.tmpfile = tmpfile + + def start(self): + setattr(sys, self.name, self.tmpfile) + + def snap(self): + f = self.tmpfile + res = f.getvalue() + f.truncate(0) + f.seek(0) + return res + + def done(self): + setattr(sys, self.name, self._old) + del self._old + self.tmpfile.close() + + def suspend(self): + setattr(sys, self.name, self._old) + + def resume(self): + setattr(sys, self.name, self.tmpfile) + + def writeorg(self, data): + self._old.write(data) + self._old.flush() + + +class DontReadFromInput: + """Temporary stub class. Ideally when stdin is accessed, the + capturing should be turned off, with possibly all data captured + so far sent to the screen. This should be configurable, though, + because in automated test runs it is better to crash than + hang indefinitely. + """ + + encoding = None + + def read(self, *args): + raise IOError("reading from stdin while output is captured") + readline = read + readlines = read + __iter__ = read + + def fileno(self): + raise ValueError("redirected Stdin is pseudofile, has no fileno()") + + def isatty(self): + return False + + def close(self): + pass + + +def _readline_workaround(): + """ + Ensure readline is imported so that it attaches to the correct stdio + handles on Windows. + + Pdb uses readline support where available--when not running from the Python + prompt, the readline module is not imported until running the pdb REPL. If + running py.test with the --pdb option this means the readline module is not + imported until after I/O capture has been started. + + This is a problem for pyreadline, which is often used to implement readline + support on Windows, as it does not attach to the correct handles for stdout + and/or stdin if they have been redirected by the FDCapture mechanism. This + workaround ensures that readline is imported before I/O capture is setup so + that it can attach to the actual stdin/out for the console. + + See https://github.com/pytest-dev/pytest/pull/1281 + """ + + if not sys.platform.startswith('win32'): + return + try: + import readline # noqa + except ImportError: + pass diff --git a/testing/web-platform/tests/tools/pytest/_pytest/config.py b/testing/web-platform/tests/tools/pytest/_pytest/config.py new file mode 100644 index 000000000..fb7b1774f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/config.py @@ -0,0 +1,1192 @@ +""" command line options, ini-file and conftest.py processing. """ +import argparse +import shlex +import traceback +import types +import warnings + +import py +# DON't import pytest here because it causes import cycle troubles +import sys, os +import _pytest._code +import _pytest.hookspec # the extension point definitions +from _pytest._pluggy import PluginManager, HookimplMarker, HookspecMarker + +hookimpl = HookimplMarker("pytest") +hookspec = HookspecMarker("pytest") + +# pytest startup +# + + +class ConftestImportFailure(Exception): + def __init__(self, path, excinfo): + Exception.__init__(self, path, excinfo) + self.path = path + self.excinfo = excinfo + + +def main(args=None, plugins=None): + """ return exit code, after performing an in-process test run. + + :arg args: list of command line arguments. + + :arg plugins: list of plugin objects to be auto-registered during + initialization. + """ + try: + try: + config = _prepareconfig(args, plugins) + except ConftestImportFailure as e: + tw = py.io.TerminalWriter(sys.stderr) + for line in traceback.format_exception(*e.excinfo): + tw.line(line.rstrip(), red=True) + tw.line("ERROR: could not load %s\n" % (e.path), red=True) + return 4 + else: + try: + config.pluginmanager.check_pending() + return config.hook.pytest_cmdline_main(config=config) + finally: + config._ensure_unconfigure() + except UsageError as e: + for msg in e.args: + sys.stderr.write("ERROR: %s\n" %(msg,)) + return 4 + +class cmdline: # compatibility namespace + main = staticmethod(main) + +class UsageError(Exception): + """ error in pytest usage or invocation""" + +_preinit = [] + +default_plugins = ( + "mark main terminal runner python pdb unittest capture skipping " + "tmpdir monkeypatch recwarn pastebin helpconfig nose assertion genscript " + "junitxml resultlog doctest cacheprovider").split() + +builtin_plugins = set(default_plugins) +builtin_plugins.add("pytester") + + +def _preloadplugins(): + assert not _preinit + _preinit.append(get_config()) + +def get_config(): + if _preinit: + return _preinit.pop(0) + # subsequent calls to main will create a fresh instance + pluginmanager = PytestPluginManager() + config = Config(pluginmanager) + for spec in default_plugins: + pluginmanager.import_plugin(spec) + return config + +def get_plugin_manager(): + """ + Obtain a new instance of the + :py:class:`_pytest.config.PytestPluginManager`, with default plugins + already loaded. + + This function can be used by integration with other tools, like hooking + into pytest to run tests into an IDE. + """ + return get_config().pluginmanager + +def _prepareconfig(args=None, plugins=None): + if args is None: + args = sys.argv[1:] + elif isinstance(args, py.path.local): + args = [str(args)] + elif not isinstance(args, (tuple, list)): + if not isinstance(args, str): + raise ValueError("not a string or argument list: %r" % (args,)) + args = shlex.split(args) + config = get_config() + pluginmanager = config.pluginmanager + try: + if plugins: + for plugin in plugins: + if isinstance(plugin, py.builtin._basestring): + pluginmanager.consider_pluginarg(plugin) + else: + pluginmanager.register(plugin) + return pluginmanager.hook.pytest_cmdline_parse( + pluginmanager=pluginmanager, args=args) + except BaseException: + config._ensure_unconfigure() + raise + + +class PytestPluginManager(PluginManager): + """ + Overwrites :py:class:`pluggy.PluginManager` to add pytest-specific + functionality: + + * loading plugins from the command line, ``PYTEST_PLUGIN`` env variable and + ``pytest_plugins`` global variables found in plugins being loaded; + * ``conftest.py`` loading during start-up; + """ + def __init__(self): + super(PytestPluginManager, self).__init__("pytest", implprefix="pytest_") + self._conftest_plugins = set() + + # state related to local conftest plugins + self._path2confmods = {} + self._conftestpath2mod = {} + self._confcutdir = None + self._noconftest = False + + self.add_hookspecs(_pytest.hookspec) + self.register(self) + if os.environ.get('PYTEST_DEBUG'): + err = sys.stderr + encoding = getattr(err, 'encoding', 'utf8') + try: + err = py.io.dupfile(err, encoding=encoding) + except Exception: + pass + self.trace.root.setwriter(err.write) + self.enable_tracing() + + def addhooks(self, module_or_class): + """ + .. deprecated:: 2.8 + + Use :py:meth:`pluggy.PluginManager.add_hookspecs` instead. + """ + warning = dict(code="I2", + fslocation=_pytest._code.getfslineno(sys._getframe(1)), + nodeid=None, + message="use pluginmanager.add_hookspecs instead of " + "deprecated addhooks() method.") + self._warn(warning) + return self.add_hookspecs(module_or_class) + + def parse_hookimpl_opts(self, plugin, name): + # pytest hooks are always prefixed with pytest_ + # so we avoid accessing possibly non-readable attributes + # (see issue #1073) + if not name.startswith("pytest_"): + return + # ignore some historic special names which can not be hooks anyway + if name == "pytest_plugins" or name.startswith("pytest_funcarg__"): + return + + method = getattr(plugin, name) + opts = super(PytestPluginManager, self).parse_hookimpl_opts(plugin, name) + if opts is not None: + for name in ("tryfirst", "trylast", "optionalhook", "hookwrapper"): + opts.setdefault(name, hasattr(method, name)) + return opts + + def parse_hookspec_opts(self, module_or_class, name): + opts = super(PytestPluginManager, self).parse_hookspec_opts( + module_or_class, name) + if opts is None: + method = getattr(module_or_class, name) + if name.startswith("pytest_"): + opts = {"firstresult": hasattr(method, "firstresult"), + "historic": hasattr(method, "historic")} + return opts + + def _verify_hook(self, hook, hookmethod): + super(PytestPluginManager, self)._verify_hook(hook, hookmethod) + if "__multicall__" in hookmethod.argnames: + fslineno = _pytest._code.getfslineno(hookmethod.function) + warning = dict(code="I1", + fslocation=fslineno, + nodeid=None, + message="%r hook uses deprecated __multicall__ " + "argument" % (hook.name)) + self._warn(warning) + + def register(self, plugin, name=None): + ret = super(PytestPluginManager, self).register(plugin, name) + if ret: + self.hook.pytest_plugin_registered.call_historic( + kwargs=dict(plugin=plugin, manager=self)) + return ret + + def getplugin(self, name): + # support deprecated naming because plugins (xdist e.g.) use it + return self.get_plugin(name) + + def hasplugin(self, name): + """Return True if the plugin with the given name is registered.""" + return bool(self.get_plugin(name)) + + def pytest_configure(self, config): + # XXX now that the pluginmanager exposes hookimpl(tryfirst...) + # we should remove tryfirst/trylast as markers + config.addinivalue_line("markers", + "tryfirst: mark a hook implementation function such that the " + "plugin machinery will try to call it first/as early as possible.") + config.addinivalue_line("markers", + "trylast: mark a hook implementation function such that the " + "plugin machinery will try to call it last/as late as possible.") + + def _warn(self, message): + kwargs = message if isinstance(message, dict) else { + 'code': 'I1', + 'message': message, + 'fslocation': None, + 'nodeid': None, + } + self.hook.pytest_logwarning.call_historic(kwargs=kwargs) + + # + # internal API for local conftest plugin handling + # + def _set_initial_conftests(self, namespace): + """ load initial conftest files given a preparsed "namespace". + As conftest files may add their own command line options + which have arguments ('--my-opt somepath') we might get some + false positives. All builtin and 3rd party plugins will have + been loaded, however, so common options will not confuse our logic + here. + """ + current = py.path.local() + self._confcutdir = current.join(namespace.confcutdir, abs=True) \ + if namespace.confcutdir else None + self._noconftest = namespace.noconftest + testpaths = namespace.file_or_dir + foundanchor = False + for path in testpaths: + path = str(path) + # remove node-id syntax + i = path.find("::") + if i != -1: + path = path[:i] + anchor = current.join(path, abs=1) + if exists(anchor): # we found some file object + self._try_load_conftest(anchor) + foundanchor = True + if not foundanchor: + self._try_load_conftest(current) + + def _try_load_conftest(self, anchor): + self._getconftestmodules(anchor) + # let's also consider test* subdirs + if anchor.check(dir=1): + for x in anchor.listdir("test*"): + if x.check(dir=1): + self._getconftestmodules(x) + + def _getconftestmodules(self, path): + if self._noconftest: + return [] + try: + return self._path2confmods[path] + except KeyError: + if path.isfile(): + clist = self._getconftestmodules(path.dirpath()) + else: + # XXX these days we may rather want to use config.rootdir + # and allow users to opt into looking into the rootdir parent + # directories instead of requiring to specify confcutdir + clist = [] + for parent in path.parts(): + if self._confcutdir and self._confcutdir.relto(parent): + continue + conftestpath = parent.join("conftest.py") + if conftestpath.isfile(): + mod = self._importconftest(conftestpath) + clist.append(mod) + + self._path2confmods[path] = clist + return clist + + def _rget_with_confmod(self, name, path): + modules = self._getconftestmodules(path) + for mod in reversed(modules): + try: + return mod, getattr(mod, name) + except AttributeError: + continue + raise KeyError(name) + + def _importconftest(self, conftestpath): + try: + return self._conftestpath2mod[conftestpath] + except KeyError: + pkgpath = conftestpath.pypkgpath() + if pkgpath is None: + _ensure_removed_sysmodule(conftestpath.purebasename) + try: + mod = conftestpath.pyimport() + except Exception: + raise ConftestImportFailure(conftestpath, sys.exc_info()) + + self._conftest_plugins.add(mod) + self._conftestpath2mod[conftestpath] = mod + dirpath = conftestpath.dirpath() + if dirpath in self._path2confmods: + for path, mods in self._path2confmods.items(): + if path and path.relto(dirpath) or path == dirpath: + assert mod not in mods + mods.append(mod) + self.trace("loaded conftestmodule %r" %(mod)) + self.consider_conftest(mod) + return mod + + # + # API for bootstrapping plugin loading + # + # + + def consider_preparse(self, args): + for opt1,opt2 in zip(args, args[1:]): + if opt1 == "-p": + self.consider_pluginarg(opt2) + + def consider_pluginarg(self, arg): + if arg.startswith("no:"): + name = arg[3:] + self.set_blocked(name) + if not name.startswith("pytest_"): + self.set_blocked("pytest_" + name) + else: + self.import_plugin(arg) + + def consider_conftest(self, conftestmodule): + if self.register(conftestmodule, name=conftestmodule.__file__): + self.consider_module(conftestmodule) + + def consider_env(self): + self._import_plugin_specs(os.environ.get("PYTEST_PLUGINS")) + + def consider_module(self, mod): + self._import_plugin_specs(getattr(mod, "pytest_plugins", None)) + + def _import_plugin_specs(self, spec): + if spec: + if isinstance(spec, str): + spec = spec.split(",") + for import_spec in spec: + self.import_plugin(import_spec) + + def import_plugin(self, modname): + # most often modname refers to builtin modules, e.g. "pytester", + # "terminal" or "capture". Those plugins are registered under their + # basename for historic purposes but must be imported with the + # _pytest prefix. + assert isinstance(modname, str) + if self.get_plugin(modname) is not None: + return + if modname in builtin_plugins: + importspec = "_pytest." + modname + else: + importspec = modname + try: + __import__(importspec) + except ImportError as e: + new_exc = ImportError('Error importing plugin "%s": %s' % (modname, e)) + # copy over name and path attributes + for attr in ('name', 'path'): + if hasattr(e, attr): + setattr(new_exc, attr, getattr(e, attr)) + raise new_exc + except Exception as e: + import pytest + if not hasattr(pytest, 'skip') or not isinstance(e, pytest.skip.Exception): + raise + self._warn("skipped plugin %r: %s" %((modname, e.msg))) + else: + mod = sys.modules[importspec] + self.register(mod, modname) + self.consider_module(mod) + + +class Parser: + """ Parser for command line arguments and ini-file values. + + :ivar extra_info: dict of generic param -> value to display in case + there's an error processing the command line arguments. + """ + + def __init__(self, usage=None, processopt=None): + self._anonymous = OptionGroup("custom options", parser=self) + self._groups = [] + self._processopt = processopt + self._usage = usage + self._inidict = {} + self._ininames = [] + self.extra_info = {} + + def processoption(self, option): + if self._processopt: + if option.dest: + self._processopt(option) + + def getgroup(self, name, description="", after=None): + """ get (or create) a named option Group. + + :name: name of the option group. + :description: long description for --help output. + :after: name of other group, used for ordering --help output. + + The returned group object has an ``addoption`` method with the same + signature as :py:func:`parser.addoption + <_pytest.config.Parser.addoption>` but will be shown in the + respective group in the output of ``pytest. --help``. + """ + for group in self._groups: + if group.name == name: + return group + group = OptionGroup(name, description, parser=self) + i = 0 + for i, grp in enumerate(self._groups): + if grp.name == after: + break + self._groups.insert(i+1, group) + return group + + def addoption(self, *opts, **attrs): + """ register a command line option. + + :opts: option names, can be short or long options. + :attrs: same attributes which the ``add_option()`` function of the + `argparse library + <http://docs.python.org/2/library/argparse.html>`_ + accepts. + + After command line parsing options are available on the pytest config + object via ``config.option.NAME`` where ``NAME`` is usually set + by passing a ``dest`` attribute, for example + ``addoption("--long", dest="NAME", ...)``. + """ + self._anonymous.addoption(*opts, **attrs) + + def parse(self, args, namespace=None): + from _pytest._argcomplete import try_argcomplete + self.optparser = self._getparser() + try_argcomplete(self.optparser) + return self.optparser.parse_args([str(x) for x in args], namespace=namespace) + + def _getparser(self): + from _pytest._argcomplete import filescompleter + optparser = MyOptionParser(self, self.extra_info) + groups = self._groups + [self._anonymous] + for group in groups: + if group.options: + desc = group.description or group.name + arggroup = optparser.add_argument_group(desc) + for option in group.options: + n = option.names() + a = option.attrs() + arggroup.add_argument(*n, **a) + # bash like autocompletion for dirs (appending '/') + optparser.add_argument(FILE_OR_DIR, nargs='*').completer=filescompleter + return optparser + + def parse_setoption(self, args, option, namespace=None): + parsedoption = self.parse(args, namespace=namespace) + for name, value in parsedoption.__dict__.items(): + setattr(option, name, value) + return getattr(parsedoption, FILE_OR_DIR) + + def parse_known_args(self, args, namespace=None): + """parses and returns a namespace object with known arguments at this + point. + """ + return self.parse_known_and_unknown_args(args, namespace=namespace)[0] + + def parse_known_and_unknown_args(self, args, namespace=None): + """parses and returns a namespace object with known arguments, and + the remaining arguments unknown at this point. + """ + optparser = self._getparser() + args = [str(x) for x in args] + return optparser.parse_known_args(args, namespace=namespace) + + def addini(self, name, help, type=None, default=None): + """ register an ini-file option. + + :name: name of the ini-variable + :type: type of the variable, can be ``pathlist``, ``args``, ``linelist`` + or ``bool``. + :default: default value if no ini-file option exists but is queried. + + The value of ini-variables can be retrieved via a call to + :py:func:`config.getini(name) <_pytest.config.Config.getini>`. + """ + assert type in (None, "pathlist", "args", "linelist", "bool") + self._inidict[name] = (help, type, default) + self._ininames.append(name) + + +class ArgumentError(Exception): + """ + Raised if an Argument instance is created with invalid or + inconsistent arguments. + """ + + def __init__(self, msg, option): + self.msg = msg + self.option_id = str(option) + + def __str__(self): + if self.option_id: + return "option %s: %s" % (self.option_id, self.msg) + else: + return self.msg + + +class Argument: + """class that mimics the necessary behaviour of optparse.Option """ + _typ_map = { + 'int': int, + 'string': str, + } + # enable after some grace period for plugin writers + TYPE_WARN = False + + def __init__(self, *names, **attrs): + """store parms in private vars for use in add_argument""" + self._attrs = attrs + self._short_opts = [] + self._long_opts = [] + self.dest = attrs.get('dest') + if self.TYPE_WARN: + try: + help = attrs['help'] + if '%default' in help: + warnings.warn( + 'pytest now uses argparse. "%default" should be' + ' changed to "%(default)s" ', + FutureWarning, + stacklevel=3) + except KeyError: + pass + try: + typ = attrs['type'] + except KeyError: + pass + else: + # this might raise a keyerror as well, don't want to catch that + if isinstance(typ, py.builtin._basestring): + if typ == 'choice': + if self.TYPE_WARN: + warnings.warn( + 'type argument to addoption() is a string %r.' + ' For parsearg this is optional and when supplied ' + ' should be a type.' + ' (options: %s)' % (typ, names), + FutureWarning, + stacklevel=3) + # argparse expects a type here take it from + # the type of the first element + attrs['type'] = type(attrs['choices'][0]) + else: + if self.TYPE_WARN: + warnings.warn( + 'type argument to addoption() is a string %r.' + ' For parsearg this should be a type.' + ' (options: %s)' % (typ, names), + FutureWarning, + stacklevel=3) + attrs['type'] = Argument._typ_map[typ] + # used in test_parseopt -> test_parse_defaultgetter + self.type = attrs['type'] + else: + self.type = typ + try: + # attribute existence is tested in Config._processopt + self.default = attrs['default'] + except KeyError: + pass + self._set_opt_strings(names) + if not self.dest: + if self._long_opts: + self.dest = self._long_opts[0][2:].replace('-', '_') + else: + try: + self.dest = self._short_opts[0][1:] + except IndexError: + raise ArgumentError( + 'need a long or short option', self) + + def names(self): + return self._short_opts + self._long_opts + + def attrs(self): + # update any attributes set by processopt + attrs = 'default dest help'.split() + if self.dest: + attrs.append(self.dest) + for attr in attrs: + try: + self._attrs[attr] = getattr(self, attr) + except AttributeError: + pass + if self._attrs.get('help'): + a = self._attrs['help'] + a = a.replace('%default', '%(default)s') + #a = a.replace('%prog', '%(prog)s') + self._attrs['help'] = a + return self._attrs + + def _set_opt_strings(self, opts): + """directly from optparse + + might not be necessary as this is passed to argparse later on""" + for opt in opts: + if len(opt) < 2: + raise ArgumentError( + "invalid option string %r: " + "must be at least two characters long" % opt, self) + elif len(opt) == 2: + if not (opt[0] == "-" and opt[1] != "-"): + raise ArgumentError( + "invalid short option string %r: " + "must be of the form -x, (x any non-dash char)" % opt, + self) + self._short_opts.append(opt) + else: + if not (opt[0:2] == "--" and opt[2] != "-"): + raise ArgumentError( + "invalid long option string %r: " + "must start with --, followed by non-dash" % opt, + self) + self._long_opts.append(opt) + + def __repr__(self): + retval = 'Argument(' + if self._short_opts: + retval += '_short_opts: ' + repr(self._short_opts) + ', ' + if self._long_opts: + retval += '_long_opts: ' + repr(self._long_opts) + ', ' + retval += 'dest: ' + repr(self.dest) + ', ' + if hasattr(self, 'type'): + retval += 'type: ' + repr(self.type) + ', ' + if hasattr(self, 'default'): + retval += 'default: ' + repr(self.default) + ', ' + if retval[-2:] == ', ': # always long enough to test ("Argument(" ) + retval = retval[:-2] + retval += ')' + return retval + + +class OptionGroup: + def __init__(self, name, description="", parser=None): + self.name = name + self.description = description + self.options = [] + self.parser = parser + + def addoption(self, *optnames, **attrs): + """ add an option to this group. + + if a shortened version of a long option is specified it will + be suppressed in the help. addoption('--twowords', '--two-words') + results in help showing '--two-words' only, but --twowords gets + accepted **and** the automatic destination is in args.twowords + """ + option = Argument(*optnames, **attrs) + self._addoption_instance(option, shortupper=False) + + def _addoption(self, *optnames, **attrs): + option = Argument(*optnames, **attrs) + self._addoption_instance(option, shortupper=True) + + def _addoption_instance(self, option, shortupper=False): + if not shortupper: + for opt in option._short_opts: + if opt[0] == '-' and opt[1].islower(): + raise ValueError("lowercase shortoptions reserved") + if self.parser: + self.parser.processoption(option) + self.options.append(option) + + +class MyOptionParser(argparse.ArgumentParser): + def __init__(self, parser, extra_info=None): + if not extra_info: + extra_info = {} + self._parser = parser + argparse.ArgumentParser.__init__(self, usage=parser._usage, + add_help=False, formatter_class=DropShorterLongHelpFormatter) + # extra_info is a dict of (param -> value) to display if there's + # an usage error to provide more contextual information to the user + self.extra_info = extra_info + + def parse_args(self, args=None, namespace=None): + """allow splitting of positional arguments""" + args, argv = self.parse_known_args(args, namespace) + if argv: + for arg in argv: + if arg and arg[0] == '-': + lines = ['unrecognized arguments: %s' % (' '.join(argv))] + for k, v in sorted(self.extra_info.items()): + lines.append(' %s: %s' % (k, v)) + self.error('\n'.join(lines)) + getattr(args, FILE_OR_DIR).extend(argv) + return args + + +class DropShorterLongHelpFormatter(argparse.HelpFormatter): + """shorten help for long options that differ only in extra hyphens + + - collapse **long** options that are the same except for extra hyphens + - special action attribute map_long_option allows surpressing additional + long options + - shortcut if there are only two options and one of them is a short one + - cache result on action object as this is called at least 2 times + """ + def _format_action_invocation(self, action): + orgstr = argparse.HelpFormatter._format_action_invocation(self, action) + if orgstr and orgstr[0] != '-': # only optional arguments + return orgstr + res = getattr(action, '_formatted_action_invocation', None) + if res: + return res + options = orgstr.split(', ') + if len(options) == 2 and (len(options[0]) == 2 or len(options[1]) == 2): + # a shortcut for '-h, --help' or '--abc', '-a' + action._formatted_action_invocation = orgstr + return orgstr + return_list = [] + option_map = getattr(action, 'map_long_option', {}) + if option_map is None: + option_map = {} + short_long = {} + for option in options: + if len(option) == 2 or option[2] == ' ': + continue + if not option.startswith('--'): + raise ArgumentError('long optional argument without "--": [%s]' + % (option), self) + xxoption = option[2:] + if xxoption.split()[0] not in option_map: + shortened = xxoption.replace('-', '') + if shortened not in short_long or \ + len(short_long[shortened]) < len(xxoption): + short_long[shortened] = xxoption + # now short_long has been filled out to the longest with dashes + # **and** we keep the right option ordering from add_argument + for option in options: # + if len(option) == 2 or option[2] == ' ': + return_list.append(option) + if option[2:] == short_long.get(option.replace('-', '')): + return_list.append(option.replace(' ', '=')) + action._formatted_action_invocation = ', '.join(return_list) + return action._formatted_action_invocation + + + +def _ensure_removed_sysmodule(modname): + try: + del sys.modules[modname] + except KeyError: + pass + +class CmdOptions(object): + """ holds cmdline options as attributes.""" + def __init__(self, values=()): + self.__dict__.update(values) + def __repr__(self): + return "<CmdOptions %r>" %(self.__dict__,) + def copy(self): + return CmdOptions(self.__dict__) + +class Notset: + def __repr__(self): + return "<NOTSET>" + +notset = Notset() +FILE_OR_DIR = 'file_or_dir' + +class Config(object): + """ access to configuration values, pluginmanager and plugin hooks. """ + + def __init__(self, pluginmanager): + #: access to command line option as attributes. + #: (deprecated), use :py:func:`getoption() <_pytest.config.Config.getoption>` instead + self.option = CmdOptions() + _a = FILE_OR_DIR + self._parser = Parser( + usage="%%(prog)s [options] [%s] [%s] [...]" % (_a, _a), + processopt=self._processopt, + ) + #: a pluginmanager instance + self.pluginmanager = pluginmanager + self.trace = self.pluginmanager.trace.root.get("config") + self.hook = self.pluginmanager.hook + self._inicache = {} + self._opt2dest = {} + self._cleanup = [] + self._warn = self.pluginmanager._warn + self.pluginmanager.register(self, "pytestconfig") + self._configured = False + def do_setns(dic): + import pytest + setns(pytest, dic) + self.hook.pytest_namespace.call_historic(do_setns, {}) + self.hook.pytest_addoption.call_historic(kwargs=dict(parser=self._parser)) + + def add_cleanup(self, func): + """ Add a function to be called when the config object gets out of + use (usually coninciding with pytest_unconfigure).""" + self._cleanup.append(func) + + def _do_configure(self): + assert not self._configured + self._configured = True + self.hook.pytest_configure.call_historic(kwargs=dict(config=self)) + + def _ensure_unconfigure(self): + if self._configured: + self._configured = False + self.hook.pytest_unconfigure(config=self) + self.hook.pytest_configure._call_history = [] + while self._cleanup: + fin = self._cleanup.pop() + fin() + + def warn(self, code, message, fslocation=None): + """ generate a warning for this test session. """ + self.hook.pytest_logwarning.call_historic(kwargs=dict( + code=code, message=message, + fslocation=fslocation, nodeid=None)) + + def get_terminal_writer(self): + return self.pluginmanager.get_plugin("terminalreporter")._tw + + def pytest_cmdline_parse(self, pluginmanager, args): + # REF1 assert self == pluginmanager.config, (self, pluginmanager.config) + self.parse(args) + return self + + def notify_exception(self, excinfo, option=None): + if option and option.fulltrace: + style = "long" + else: + style = "native" + excrepr = excinfo.getrepr(funcargs=True, + showlocals=getattr(option, 'showlocals', False), + style=style, + ) + res = self.hook.pytest_internalerror(excrepr=excrepr, + excinfo=excinfo) + if not py.builtin.any(res): + for line in str(excrepr).split("\n"): + sys.stderr.write("INTERNALERROR> %s\n" %line) + sys.stderr.flush() + + def cwd_relative_nodeid(self, nodeid): + # nodeid's are relative to the rootpath, compute relative to cwd + if self.invocation_dir != self.rootdir: + fullpath = self.rootdir.join(nodeid) + nodeid = self.invocation_dir.bestrelpath(fullpath) + return nodeid + + @classmethod + def fromdictargs(cls, option_dict, args): + """ constructor useable for subprocesses. """ + config = get_config() + config.option.__dict__.update(option_dict) + config.parse(args, addopts=False) + for x in config.option.plugins: + config.pluginmanager.consider_pluginarg(x) + return config + + def _processopt(self, opt): + for name in opt._short_opts + opt._long_opts: + self._opt2dest[name] = opt.dest + + if hasattr(opt, 'default') and opt.dest: + if not hasattr(self.option, opt.dest): + setattr(self.option, opt.dest, opt.default) + + @hookimpl(trylast=True) + def pytest_load_initial_conftests(self, early_config): + self.pluginmanager._set_initial_conftests(early_config.known_args_namespace) + + def _initini(self, args): + ns, unknown_args = self._parser.parse_known_and_unknown_args(args, namespace=self.option.copy()) + r = determine_setup(ns.inifilename, ns.file_or_dir + unknown_args) + self.rootdir, self.inifile, self.inicfg = r + self._parser.extra_info['rootdir'] = self.rootdir + self._parser.extra_info['inifile'] = self.inifile + self.invocation_dir = py.path.local() + self._parser.addini('addopts', 'extra command line options', 'args') + self._parser.addini('minversion', 'minimally required pytest version') + + def _preparse(self, args, addopts=True): + self._initini(args) + if addopts: + args[:] = shlex.split(os.environ.get('PYTEST_ADDOPTS', '')) + args + args[:] = self.getini("addopts") + args + self._checkversion() + self.pluginmanager.consider_preparse(args) + try: + self.pluginmanager.load_setuptools_entrypoints("pytest11") + except ImportError as e: + self.warn("I2", "could not load setuptools entry import: %s" % (e,)) + self.pluginmanager.consider_env() + self.known_args_namespace = ns = self._parser.parse_known_args(args, namespace=self.option.copy()) + if self.known_args_namespace.confcutdir is None and self.inifile: + confcutdir = py.path.local(self.inifile).dirname + self.known_args_namespace.confcutdir = confcutdir + try: + self.hook.pytest_load_initial_conftests(early_config=self, + args=args, parser=self._parser) + except ConftestImportFailure: + e = sys.exc_info()[1] + if ns.help or ns.version: + # we don't want to prevent --help/--version to work + # so just let is pass and print a warning at the end + self._warn("could not load initial conftests (%s)\n" % e.path) + else: + raise + + def _checkversion(self): + import pytest + minver = self.inicfg.get('minversion', None) + if minver: + ver = minver.split(".") + myver = pytest.__version__.split(".") + if myver < ver: + raise pytest.UsageError( + "%s:%d: requires pytest-%s, actual pytest-%s'" %( + self.inicfg.config.path, self.inicfg.lineof('minversion'), + minver, pytest.__version__)) + + def parse(self, args, addopts=True): + # parse given cmdline arguments into this config object. + assert not hasattr(self, 'args'), ( + "can only parse cmdline args at most once per Config object") + self._origargs = args + self.hook.pytest_addhooks.call_historic( + kwargs=dict(pluginmanager=self.pluginmanager)) + self._preparse(args, addopts=addopts) + # XXX deprecated hook: + self.hook.pytest_cmdline_preparse(config=self, args=args) + args = self._parser.parse_setoption(args, self.option, namespace=self.option) + if not args: + cwd = os.getcwd() + if cwd == self.rootdir: + args = self.getini('testpaths') + if not args: + args = [cwd] + self.args = args + + def addinivalue_line(self, name, line): + """ add a line to an ini-file option. The option must have been + declared but might not yet be set in which case the line becomes the + the first line in its value. """ + x = self.getini(name) + assert isinstance(x, list) + x.append(line) # modifies the cached list inline + + def getini(self, name): + """ return configuration value from an :ref:`ini file <inifiles>`. If the + specified name hasn't been registered through a prior + :py:func:`parser.addini <pytest.config.Parser.addini>` + call (usually from a plugin), a ValueError is raised. """ + try: + return self._inicache[name] + except KeyError: + self._inicache[name] = val = self._getini(name) + return val + + def _getini(self, name): + try: + description, type, default = self._parser._inidict[name] + except KeyError: + raise ValueError("unknown configuration value: %r" %(name,)) + try: + value = self.inicfg[name] + except KeyError: + if default is not None: + return default + if type is None: + return '' + return [] + if type == "pathlist": + dp = py.path.local(self.inicfg.config.path).dirpath() + l = [] + for relpath in shlex.split(value): + l.append(dp.join(relpath, abs=True)) + return l + elif type == "args": + return shlex.split(value) + elif type == "linelist": + return [t for t in map(lambda x: x.strip(), value.split("\n")) if t] + elif type == "bool": + return bool(_strtobool(value.strip())) + else: + assert type is None + return value + + def _getconftest_pathlist(self, name, path): + try: + mod, relroots = self.pluginmanager._rget_with_confmod(name, path) + except KeyError: + return None + modpath = py.path.local(mod.__file__).dirpath() + l = [] + for relroot in relroots: + if not isinstance(relroot, py.path.local): + relroot = relroot.replace("/", py.path.local.sep) + relroot = modpath.join(relroot, abs=True) + l.append(relroot) + return l + + def getoption(self, name, default=notset, skip=False): + """ return command line option value. + + :arg name: name of the option. You may also specify + the literal ``--OPT`` option instead of the "dest" option name. + :arg default: default value if no option of that name exists. + :arg skip: if True raise pytest.skip if option does not exists + or has a None value. + """ + name = self._opt2dest.get(name, name) + try: + val = getattr(self.option, name) + if val is None and skip: + raise AttributeError(name) + return val + except AttributeError: + if default is not notset: + return default + if skip: + import pytest + pytest.skip("no %r option found" %(name,)) + raise ValueError("no option named %r" % (name,)) + + def getvalue(self, name, path=None): + """ (deprecated, use getoption()) """ + return self.getoption(name) + + def getvalueorskip(self, name, path=None): + """ (deprecated, use getoption(skip=True)) """ + return self.getoption(name, skip=True) + +def exists(path, ignore=EnvironmentError): + try: + return path.check() + except ignore: + return False + +def getcfg(args, inibasenames): + args = [x for x in args if not str(x).startswith("-")] + if not args: + args = [py.path.local()] + for arg in args: + arg = py.path.local(arg) + for base in arg.parts(reverse=True): + for inibasename in inibasenames: + p = base.join(inibasename) + if exists(p): + iniconfig = py.iniconfig.IniConfig(p) + if 'pytest' in iniconfig.sections: + return base, p, iniconfig['pytest'] + elif inibasename == "pytest.ini": + # allowed to be empty + return base, p, {} + return None, None, None + + +def get_common_ancestor(args): + # args are what we get after early command line parsing (usually + # strings, but can be py.path.local objects as well) + common_ancestor = None + for arg in args: + if str(arg)[0] == "-": + continue + p = py.path.local(arg) + if common_ancestor is None: + common_ancestor = p + else: + if p.relto(common_ancestor) or p == common_ancestor: + continue + elif common_ancestor.relto(p): + common_ancestor = p + else: + shared = p.common(common_ancestor) + if shared is not None: + common_ancestor = shared + if common_ancestor is None: + common_ancestor = py.path.local() + elif not common_ancestor.isdir(): + common_ancestor = common_ancestor.dirpath() + return common_ancestor + + +def determine_setup(inifile, args): + if inifile: + iniconfig = py.iniconfig.IniConfig(inifile) + try: + inicfg = iniconfig["pytest"] + except KeyError: + inicfg = None + rootdir = get_common_ancestor(args) + else: + ancestor = get_common_ancestor(args) + rootdir, inifile, inicfg = getcfg( + [ancestor], ["pytest.ini", "tox.ini", "setup.cfg"]) + if rootdir is None: + for rootdir in ancestor.parts(reverse=True): + if rootdir.join("setup.py").exists(): + break + else: + rootdir = ancestor + return rootdir, inifile, inicfg or {} + + +def setns(obj, dic): + import pytest + for name, value in dic.items(): + if isinstance(value, dict): + mod = getattr(obj, name, None) + if mod is None: + modname = "pytest.%s" % name + mod = types.ModuleType(modname) + sys.modules[modname] = mod + mod.__all__ = [] + setattr(obj, name, mod) + obj.__all__.append(name) + setns(mod, value) + else: + setattr(obj, name, value) + obj.__all__.append(name) + #if obj != pytest: + # pytest.__all__.append(name) + setattr(pytest, name, value) + + +def create_terminal_writer(config, *args, **kwargs): + """Create a TerminalWriter instance configured according to the options + in the config object. Every code which requires a TerminalWriter object + and has access to a config object should use this function. + """ + tw = py.io.TerminalWriter(*args, **kwargs) + if config.option.color == 'yes': + tw.hasmarkup = True + if config.option.color == 'no': + tw.hasmarkup = False + return tw + + +def _strtobool(val): + """Convert a string representation of truth to true (1) or false (0). + + True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values + are 'n', 'no', 'f', 'false', 'off', and '0'. Raises ValueError if + 'val' is anything else. + + .. note:: copied from distutils.util + """ + val = val.lower() + if val in ('y', 'yes', 't', 'true', 'on', '1'): + return 1 + elif val in ('n', 'no', 'f', 'false', 'off', '0'): + return 0 + else: + raise ValueError("invalid truth value %r" % (val,)) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/doctest.py b/testing/web-platform/tests/tools/pytest/_pytest/doctest.py new file mode 100644 index 000000000..a57f7a494 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/doctest.py @@ -0,0 +1,290 @@ +""" discover and run doctests in modules and test files.""" +from __future__ import absolute_import + +import traceback + +import pytest +from _pytest._code.code import TerminalRepr, ReprFileLocation, ExceptionInfo +from _pytest.python import FixtureRequest + + + +def pytest_addoption(parser): + parser.addini('doctest_optionflags', 'option flags for doctests', + type="args", default=["ELLIPSIS"]) + group = parser.getgroup("collect") + group.addoption("--doctest-modules", + action="store_true", default=False, + help="run doctests in all .py modules", + dest="doctestmodules") + group.addoption("--doctest-glob", + action="append", default=[], metavar="pat", + help="doctests file matching pattern, default: test*.txt", + dest="doctestglob") + group.addoption("--doctest-ignore-import-errors", + action="store_true", default=False, + help="ignore doctest ImportErrors", + dest="doctest_ignore_import_errors") + + +def pytest_collect_file(path, parent): + config = parent.config + if path.ext == ".py": + if config.option.doctestmodules: + return DoctestModule(path, parent) + elif _is_doctest(config, path, parent): + return DoctestTextfile(path, parent) + + +def _is_doctest(config, path, parent): + if path.ext in ('.txt', '.rst') and parent.session.isinitpath(path): + return True + globs = config.getoption("doctestglob") or ['test*.txt'] + for glob in globs: + if path.check(fnmatch=glob): + return True + return False + + +class ReprFailDoctest(TerminalRepr): + + def __init__(self, reprlocation, lines): + self.reprlocation = reprlocation + self.lines = lines + + def toterminal(self, tw): + for line in self.lines: + tw.line(line) + self.reprlocation.toterminal(tw) + + +class DoctestItem(pytest.Item): + + def __init__(self, name, parent, runner=None, dtest=None): + super(DoctestItem, self).__init__(name, parent) + self.runner = runner + self.dtest = dtest + self.obj = None + self.fixture_request = None + + def setup(self): + if self.dtest is not None: + self.fixture_request = _setup_fixtures(self) + globs = dict(getfixture=self.fixture_request.getfuncargvalue) + self.dtest.globs.update(globs) + + def runtest(self): + _check_all_skipped(self.dtest) + self.runner.run(self.dtest) + + def repr_failure(self, excinfo): + import doctest + if excinfo.errisinstance((doctest.DocTestFailure, + doctest.UnexpectedException)): + doctestfailure = excinfo.value + example = doctestfailure.example + test = doctestfailure.test + filename = test.filename + if test.lineno is None: + lineno = None + else: + lineno = test.lineno + example.lineno + 1 + message = excinfo.type.__name__ + reprlocation = ReprFileLocation(filename, lineno, message) + checker = _get_checker() + REPORT_UDIFF = doctest.REPORT_UDIFF + if lineno is not None: + lines = doctestfailure.test.docstring.splitlines(False) + # add line numbers to the left of the error message + lines = ["%03d %s" % (i + test.lineno + 1, x) + for (i, x) in enumerate(lines)] + # trim docstring error lines to 10 + lines = lines[example.lineno - 9:example.lineno + 1] + else: + lines = ['EXAMPLE LOCATION UNKNOWN, not showing all tests of that example'] + indent = '>>>' + for line in example.source.splitlines(): + lines.append('??? %s %s' % (indent, line)) + indent = '...' + if excinfo.errisinstance(doctest.DocTestFailure): + lines += checker.output_difference(example, + doctestfailure.got, REPORT_UDIFF).split("\n") + else: + inner_excinfo = ExceptionInfo(excinfo.value.exc_info) + lines += ["UNEXPECTED EXCEPTION: %s" % + repr(inner_excinfo.value)] + lines += traceback.format_exception(*excinfo.value.exc_info) + return ReprFailDoctest(reprlocation, lines) + else: + return super(DoctestItem, self).repr_failure(excinfo) + + def reportinfo(self): + return self.fspath, None, "[doctest] %s" % self.name + + +def _get_flag_lookup(): + import doctest + return dict(DONT_ACCEPT_TRUE_FOR_1=doctest.DONT_ACCEPT_TRUE_FOR_1, + DONT_ACCEPT_BLANKLINE=doctest.DONT_ACCEPT_BLANKLINE, + NORMALIZE_WHITESPACE=doctest.NORMALIZE_WHITESPACE, + ELLIPSIS=doctest.ELLIPSIS, + IGNORE_EXCEPTION_DETAIL=doctest.IGNORE_EXCEPTION_DETAIL, + COMPARISON_FLAGS=doctest.COMPARISON_FLAGS, + ALLOW_UNICODE=_get_allow_unicode_flag(), + ALLOW_BYTES=_get_allow_bytes_flag(), + ) + + +def get_optionflags(parent): + optionflags_str = parent.config.getini("doctest_optionflags") + flag_lookup_table = _get_flag_lookup() + flag_acc = 0 + for flag in optionflags_str: + flag_acc |= flag_lookup_table[flag] + return flag_acc + + +class DoctestTextfile(DoctestItem, pytest.Module): + + def runtest(self): + import doctest + fixture_request = _setup_fixtures(self) + + # inspired by doctest.testfile; ideally we would use it directly, + # but it doesn't support passing a custom checker + text = self.fspath.read() + filename = str(self.fspath) + name = self.fspath.basename + globs = dict(getfixture=fixture_request.getfuncargvalue) + if '__name__' not in globs: + globs['__name__'] = '__main__' + + optionflags = get_optionflags(self) + runner = doctest.DebugRunner(verbose=0, optionflags=optionflags, + checker=_get_checker()) + + parser = doctest.DocTestParser() + test = parser.get_doctest(text, globs, name, filename, 0) + _check_all_skipped(test) + runner.run(test) + + +def _check_all_skipped(test): + """raises pytest.skip() if all examples in the given DocTest have the SKIP + option set. + """ + import doctest + all_skipped = all(x.options.get(doctest.SKIP, False) for x in test.examples) + if all_skipped: + pytest.skip('all tests skipped by +SKIP option') + + +class DoctestModule(pytest.Module): + def collect(self): + import doctest + if self.fspath.basename == "conftest.py": + module = self.config.pluginmanager._importconftest(self.fspath) + else: + try: + module = self.fspath.pyimport() + except ImportError: + if self.config.getvalue('doctest_ignore_import_errors'): + pytest.skip('unable to import module %r' % self.fspath) + else: + raise + # uses internal doctest module parsing mechanism + finder = doctest.DocTestFinder() + optionflags = get_optionflags(self) + runner = doctest.DebugRunner(verbose=0, optionflags=optionflags, + checker=_get_checker()) + for test in finder.find(module, module.__name__): + if test.examples: # skip empty doctests + yield DoctestItem(test.name, self, runner, test) + + +def _setup_fixtures(doctest_item): + """ + Used by DoctestTextfile and DoctestItem to setup fixture information. + """ + def func(): + pass + + doctest_item.funcargs = {} + fm = doctest_item.session._fixturemanager + doctest_item._fixtureinfo = fm.getfixtureinfo(node=doctest_item, func=func, + cls=None, funcargs=False) + fixture_request = FixtureRequest(doctest_item) + fixture_request._fillfixtures() + return fixture_request + + +def _get_checker(): + """ + Returns a doctest.OutputChecker subclass that takes in account the + ALLOW_UNICODE option to ignore u'' prefixes in strings and ALLOW_BYTES + to strip b'' prefixes. + Useful when the same doctest should run in Python 2 and Python 3. + + An inner class is used to avoid importing "doctest" at the module + level. + """ + if hasattr(_get_checker, 'LiteralsOutputChecker'): + return _get_checker.LiteralsOutputChecker() + + import doctest + import re + + class LiteralsOutputChecker(doctest.OutputChecker): + """ + Copied from doctest_nose_plugin.py from the nltk project: + https://github.com/nltk/nltk + + Further extended to also support byte literals. + """ + + _unicode_literal_re = re.compile(r"(\W|^)[uU]([rR]?[\'\"])", re.UNICODE) + _bytes_literal_re = re.compile(r"(\W|^)[bB]([rR]?[\'\"])", re.UNICODE) + + def check_output(self, want, got, optionflags): + res = doctest.OutputChecker.check_output(self, want, got, + optionflags) + if res: + return True + + allow_unicode = optionflags & _get_allow_unicode_flag() + allow_bytes = optionflags & _get_allow_bytes_flag() + if not allow_unicode and not allow_bytes: + return False + + else: # pragma: no cover + def remove_prefixes(regex, txt): + return re.sub(regex, r'\1\2', txt) + + if allow_unicode: + want = remove_prefixes(self._unicode_literal_re, want) + got = remove_prefixes(self._unicode_literal_re, got) + if allow_bytes: + want = remove_prefixes(self._bytes_literal_re, want) + got = remove_prefixes(self._bytes_literal_re, got) + res = doctest.OutputChecker.check_output(self, want, got, + optionflags) + return res + + _get_checker.LiteralsOutputChecker = LiteralsOutputChecker + return _get_checker.LiteralsOutputChecker() + + +def _get_allow_unicode_flag(): + """ + Registers and returns the ALLOW_UNICODE flag. + """ + import doctest + return doctest.register_optionflag('ALLOW_UNICODE') + + +def _get_allow_bytes_flag(): + """ + Registers and returns the ALLOW_BYTES flag. + """ + import doctest + return doctest.register_optionflag('ALLOW_BYTES') diff --git a/testing/web-platform/tests/tools/pytest/_pytest/genscript.py b/testing/web-platform/tests/tools/pytest/_pytest/genscript.py new file mode 100755 index 000000000..d2962d8fc --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/genscript.py @@ -0,0 +1,132 @@ +""" (deprecated) generate a single-file self-contained version of pytest """ +import os +import sys +import pkgutil + +import py +import _pytest + + + +def find_toplevel(name): + for syspath in sys.path: + base = py.path.local(syspath) + lib = base/name + if lib.check(dir=1): + return lib + mod = base.join("%s.py" % name) + if mod.check(file=1): + return mod + raise LookupError(name) + +def pkgname(toplevel, rootpath, path): + parts = path.parts()[len(rootpath.parts()):] + return '.'.join([toplevel] + [x.purebasename for x in parts]) + +def pkg_to_mapping(name): + toplevel = find_toplevel(name) + name2src = {} + if toplevel.check(file=1): # module + name2src[toplevel.purebasename] = toplevel.read() + else: # package + for pyfile in toplevel.visit('*.py'): + pkg = pkgname(name, toplevel, pyfile) + name2src[pkg] = pyfile.read() + # with wheels py source code might be not be installed + # and the resulting genscript is useless, just bail out. + assert name2src, "no source code found for %r at %r" %(name, toplevel) + return name2src + +def compress_mapping(mapping): + import base64, pickle, zlib + data = pickle.dumps(mapping, 2) + data = zlib.compress(data, 9) + data = base64.encodestring(data) + data = data.decode('ascii') + return data + + +def compress_packages(names): + mapping = {} + for name in names: + mapping.update(pkg_to_mapping(name)) + return compress_mapping(mapping) + +def generate_script(entry, packages): + data = compress_packages(packages) + tmpl = py.path.local(__file__).dirpath().join('standalonetemplate.py') + exe = tmpl.read() + exe = exe.replace('@SOURCES@', data) + exe = exe.replace('@ENTRY@', entry) + return exe + + +def pytest_addoption(parser): + group = parser.getgroup("debugconfig") + group.addoption("--genscript", action="store", default=None, + dest="genscript", metavar="path", + help="create standalone pytest script at given target path.") + +def pytest_cmdline_main(config): + import _pytest.config + genscript = config.getvalue("genscript") + if genscript: + tw = _pytest.config.create_terminal_writer(config) + tw.line("WARNING: usage of genscript is deprecated.", + red=True) + deps = ['py', '_pytest', 'pytest'] # pluggy is vendored + if sys.version_info < (2,7): + deps.append("argparse") + tw.line("generated script will run on python2.6-python3.3++") + else: + tw.line("WARNING: generated script will not run on python2.6 " + "due to 'argparse' dependency. Use python2.6 " + "to generate a python2.6 compatible script", red=True) + script = generate_script( + 'import pytest; raise SystemExit(pytest.cmdline.main())', + deps, + ) + genscript = py.path.local(genscript) + genscript.write(script) + tw.line("generated pytest standalone script: %s" % genscript, + bold=True) + return 0 + + +def pytest_namespace(): + return {'freeze_includes': freeze_includes} + + +def freeze_includes(): + """ + Returns a list of module names used by py.test that should be + included by cx_freeze. + """ + result = list(_iter_all_modules(py)) + result += list(_iter_all_modules(_pytest)) + return result + + +def _iter_all_modules(package, prefix=''): + """ + Iterates over the names of all modules that can be found in the given + package, recursively. + + Example: + _iter_all_modules(_pytest) -> + ['_pytest.assertion.newinterpret', + '_pytest.capture', + '_pytest.core', + ... + ] + """ + if type(package) is not str: + path, prefix = package.__path__[0], package.__name__ + '.' + else: + path = package + for _, name, is_package in pkgutil.iter_modules([path]): + if is_package: + for m in _iter_all_modules(os.path.join(path, name), prefix=name + '.'): + yield prefix + m + else: + yield prefix + name diff --git a/testing/web-platform/tests/tools/pytest/_pytest/helpconfig.py b/testing/web-platform/tests/tools/pytest/_pytest/helpconfig.py new file mode 100644 index 000000000..1df0c56ac --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/helpconfig.py @@ -0,0 +1,139 @@ +""" version info, help messages, tracing configuration. """ +import py +import pytest +import os, sys + +def pytest_addoption(parser): + group = parser.getgroup('debugconfig') + group.addoption('--version', action="store_true", + help="display pytest lib version and import information.") + group._addoption("-h", "--help", action="store_true", dest="help", + help="show help message and configuration info") + group._addoption('-p', action="append", dest="plugins", default = [], + metavar="name", + help="early-load given plugin (multi-allowed). " + "To avoid loading of plugins, use the `no:` prefix, e.g. " + "`no:doctest`.") + group.addoption('--traceconfig', '--trace-config', + action="store_true", default=False, + help="trace considerations of conftest.py files."), + group.addoption('--debug', + action="store_true", dest="debug", default=False, + help="store internal tracing debug information in 'pytestdebug.log'.") + + +@pytest.hookimpl(hookwrapper=True) +def pytest_cmdline_parse(): + outcome = yield + config = outcome.get_result() + if config.option.debug: + path = os.path.abspath("pytestdebug.log") + debugfile = open(path, 'w') + debugfile.write("versions pytest-%s, py-%s, " + "python-%s\ncwd=%s\nargs=%s\n\n" %( + pytest.__version__, py.__version__, + ".".join(map(str, sys.version_info)), + os.getcwd(), config._origargs)) + config.trace.root.setwriter(debugfile.write) + undo_tracing = config.pluginmanager.enable_tracing() + sys.stderr.write("writing pytestdebug information to %s\n" % path) + def unset_tracing(): + debugfile.close() + sys.stderr.write("wrote pytestdebug information to %s\n" % + debugfile.name) + config.trace.root.setwriter(None) + undo_tracing() + config.add_cleanup(unset_tracing) + +def pytest_cmdline_main(config): + if config.option.version: + p = py.path.local(pytest.__file__) + sys.stderr.write("This is pytest version %s, imported from %s\n" % + (pytest.__version__, p)) + plugininfo = getpluginversioninfo(config) + if plugininfo: + for line in plugininfo: + sys.stderr.write(line + "\n") + return 0 + elif config.option.help: + config._do_configure() + showhelp(config) + config._ensure_unconfigure() + return 0 + +def showhelp(config): + reporter = config.pluginmanager.get_plugin('terminalreporter') + tw = reporter._tw + tw.write(config._parser.optparser.format_help()) + tw.line() + tw.line() + #tw.sep( "=", "config file settings") + tw.line("[pytest] ini-options in the next " + "pytest.ini|tox.ini|setup.cfg file:") + tw.line() + + for name in config._parser._ininames: + help, type, default = config._parser._inidict[name] + if type is None: + type = "string" + spec = "%s (%s)" % (name, type) + line = " %-24s %s" %(spec, help) + tw.line(line[:tw.fullwidth]) + + tw.line() + tw.line("environment variables:") + vars = [ + ("PYTEST_ADDOPTS", "extra command line options"), + ("PYTEST_PLUGINS", "comma-separated plugins to load during startup"), + ("PYTEST_DEBUG", "set to enable debug tracing of pytest's internals") + ] + for name, help in vars: + tw.line(" %-24s %s" % (name, help)) + tw.line() + tw.line() + + tw.line("to see available markers type: py.test --markers") + tw.line("to see available fixtures type: py.test --fixtures") + tw.line("(shown according to specified file_or_dir or current dir " + "if not specified)") + + for warningreport in reporter.stats.get('warnings', []): + tw.line("warning : " + warningreport.message, red=True) + return + + +conftest_options = [ + ('pytest_plugins', 'list of plugin names to load'), +] + +def getpluginversioninfo(config): + lines = [] + plugininfo = config.pluginmanager.list_plugin_distinfo() + if plugininfo: + lines.append("setuptools registered plugins:") + for plugin, dist in plugininfo: + loc = getattr(plugin, '__file__', repr(plugin)) + content = "%s-%s at %s" % (dist.project_name, dist.version, loc) + lines.append(" " + content) + return lines + +def pytest_report_header(config): + lines = [] + if config.option.debug or config.option.traceconfig: + lines.append("using: pytest-%s pylib-%s" % + (pytest.__version__,py.__version__)) + + verinfo = getpluginversioninfo(config) + if verinfo: + lines.extend(verinfo) + + if config.option.traceconfig: + lines.append("active plugins:") + items = config.pluginmanager.list_name_plugin() + for name, plugin in items: + if hasattr(plugin, '__file__'): + r = plugin.__file__ + else: + r = repr(plugin) + lines.append(" %-20s: %s" %(name, r)) + return lines diff --git a/testing/web-platform/tests/tools/pytest/_pytest/hookspec.py b/testing/web-platform/tests/tools/pytest/_pytest/hookspec.py new file mode 100644 index 000000000..60e9b47d2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/hookspec.py @@ -0,0 +1,295 @@ +""" hook specifications for pytest plugins, invoked from main.py and builtin plugins. """ + +from _pytest._pluggy import HookspecMarker + +hookspec = HookspecMarker("pytest") + +# ------------------------------------------------------------------------- +# Initialization hooks called for every plugin +# ------------------------------------------------------------------------- + +@hookspec(historic=True) +def pytest_addhooks(pluginmanager): + """called at plugin registration time to allow adding new hooks via a call to + pluginmanager.add_hookspecs(module_or_class, prefix).""" + + +@hookspec(historic=True) +def pytest_namespace(): + """return dict of name->object to be made globally available in + the pytest namespace. This hook is called at plugin registration + time. + """ + +@hookspec(historic=True) +def pytest_plugin_registered(plugin, manager): + """ a new pytest plugin got registered. """ + + +@hookspec(historic=True) +def pytest_addoption(parser): + """register argparse-style options and ini-style config values, + called once at the beginning of a test run. + + .. note:: + + This function should be implemented only in plugins or ``conftest.py`` + files situated at the tests root directory due to how py.test + :ref:`discovers plugins during startup <pluginorder>`. + + :arg parser: To add command line options, call + :py:func:`parser.addoption(...) <_pytest.config.Parser.addoption>`. + To add ini-file values call :py:func:`parser.addini(...) + <_pytest.config.Parser.addini>`. + + Options can later be accessed through the + :py:class:`config <_pytest.config.Config>` object, respectively: + + - :py:func:`config.getoption(name) <_pytest.config.Config.getoption>` to + retrieve the value of a command line option. + + - :py:func:`config.getini(name) <_pytest.config.Config.getini>` to retrieve + a value read from an ini-style file. + + The config object is passed around on many internal objects via the ``.config`` + attribute or can be retrieved as the ``pytestconfig`` fixture or accessed + via (deprecated) ``pytest.config``. + """ + +@hookspec(historic=True) +def pytest_configure(config): + """ called after command line options have been parsed + and all plugins and initial conftest files been loaded. + This hook is called for every plugin. + """ + +# ------------------------------------------------------------------------- +# Bootstrapping hooks called for plugins registered early enough: +# internal and 3rd party plugins as well as directly +# discoverable conftest.py local plugins. +# ------------------------------------------------------------------------- + +@hookspec(firstresult=True) +def pytest_cmdline_parse(pluginmanager, args): + """return initialized config object, parsing the specified args. """ + +def pytest_cmdline_preparse(config, args): + """(deprecated) modify command line arguments before option parsing. """ + +@hookspec(firstresult=True) +def pytest_cmdline_main(config): + """ called for performing the main command line action. The default + implementation will invoke the configure hooks and runtest_mainloop. """ + +def pytest_load_initial_conftests(early_config, parser, args): + """ implements the loading of initial conftest files ahead + of command line option parsing. """ + + +# ------------------------------------------------------------------------- +# collection hooks +# ------------------------------------------------------------------------- + +@hookspec(firstresult=True) +def pytest_collection(session): + """ perform the collection protocol for the given session. """ + +def pytest_collection_modifyitems(session, config, items): + """ called after collection has been performed, may filter or re-order + the items in-place.""" + +def pytest_collection_finish(session): + """ called after collection has been performed and modified. """ + +@hookspec(firstresult=True) +def pytest_ignore_collect(path, config): + """ return True to prevent considering this path for collection. + This hook is consulted for all files and directories prior to calling + more specific hooks. + """ + +@hookspec(firstresult=True) +def pytest_collect_directory(path, parent): + """ called before traversing a directory for collection files. """ + +def pytest_collect_file(path, parent): + """ return collection Node or None for the given path. Any new node + needs to have the specified ``parent`` as a parent.""" + +# logging hooks for collection +def pytest_collectstart(collector): + """ collector starts collecting. """ + +def pytest_itemcollected(item): + """ we just collected a test item. """ + +def pytest_collectreport(report): + """ collector finished collecting. """ + +def pytest_deselected(items): + """ called for test items deselected by keyword. """ + +@hookspec(firstresult=True) +def pytest_make_collect_report(collector): + """ perform ``collector.collect()`` and return a CollectReport. """ + +# ------------------------------------------------------------------------- +# Python test function related hooks +# ------------------------------------------------------------------------- + +@hookspec(firstresult=True) +def pytest_pycollect_makemodule(path, parent): + """ return a Module collector or None for the given path. + This hook will be called for each matching test module path. + The pytest_collect_file hook needs to be used if you want to + create test modules for files that do not match as a test module. + """ + +@hookspec(firstresult=True) +def pytest_pycollect_makeitem(collector, name, obj): + """ return custom item/collector for a python object in a module, or None. """ + +@hookspec(firstresult=True) +def pytest_pyfunc_call(pyfuncitem): + """ call underlying test function. """ + +def pytest_generate_tests(metafunc): + """ generate (multiple) parametrized calls to a test function.""" + +# ------------------------------------------------------------------------- +# generic runtest related hooks +# ------------------------------------------------------------------------- + +@hookspec(firstresult=True) +def pytest_runtestloop(session): + """ called for performing the main runtest loop + (after collection finished). """ + +def pytest_itemstart(item, node): + """ (deprecated, use pytest_runtest_logstart). """ + +@hookspec(firstresult=True) +def pytest_runtest_protocol(item, nextitem): + """ implements the runtest_setup/call/teardown protocol for + the given test item, including capturing exceptions and calling + reporting hooks. + + :arg item: test item for which the runtest protocol is performed. + + :arg nextitem: the scheduled-to-be-next test item (or None if this + is the end my friend). This argument is passed on to + :py:func:`pytest_runtest_teardown`. + + :return boolean: True if no further hook implementations should be invoked. + """ + +def pytest_runtest_logstart(nodeid, location): + """ signal the start of running a single test item. """ + +def pytest_runtest_setup(item): + """ called before ``pytest_runtest_call(item)``. """ + +def pytest_runtest_call(item): + """ called to execute the test ``item``. """ + +def pytest_runtest_teardown(item, nextitem): + """ called after ``pytest_runtest_call``. + + :arg nextitem: the scheduled-to-be-next test item (None if no further + test item is scheduled). This argument can be used to + perform exact teardowns, i.e. calling just enough finalizers + so that nextitem only needs to call setup-functions. + """ + +@hookspec(firstresult=True) +def pytest_runtest_makereport(item, call): + """ return a :py:class:`_pytest.runner.TestReport` object + for the given :py:class:`pytest.Item` and + :py:class:`_pytest.runner.CallInfo`. + """ + +def pytest_runtest_logreport(report): + """ process a test setup/call/teardown report relating to + the respective phase of executing a test. """ + +# ------------------------------------------------------------------------- +# test session related hooks +# ------------------------------------------------------------------------- + +def pytest_sessionstart(session): + """ before session.main() is called. """ + +def pytest_sessionfinish(session, exitstatus): + """ whole test run finishes. """ + +def pytest_unconfigure(config): + """ called before test process is exited. """ + + +# ------------------------------------------------------------------------- +# hooks for customising the assert methods +# ------------------------------------------------------------------------- + +def pytest_assertrepr_compare(config, op, left, right): + """return explanation for comparisons in failing assert expressions. + + Return None for no custom explanation, otherwise return a list + of strings. The strings will be joined by newlines but any newlines + *in* a string will be escaped. Note that all but the first line will + be indented sligthly, the intention is for the first line to be a summary. + """ + +# ------------------------------------------------------------------------- +# hooks for influencing reporting (invoked from _pytest_terminal) +# ------------------------------------------------------------------------- + +def pytest_report_header(config, startdir): + """ return a string to be displayed as header info for terminal reporting.""" + +@hookspec(firstresult=True) +def pytest_report_teststatus(report): + """ return result-category, shortletter and verbose word for reporting.""" + +def pytest_terminal_summary(terminalreporter): + """ add additional section in terminal summary reporting. """ + + +@hookspec(historic=True) +def pytest_logwarning(message, code, nodeid, fslocation): + """ process a warning specified by a message, a code string, + a nodeid and fslocation (both of which may be None + if the warning is not tied to a partilar node/location).""" + +# ------------------------------------------------------------------------- +# doctest hooks +# ------------------------------------------------------------------------- + +@hookspec(firstresult=True) +def pytest_doctest_prepare_content(content): + """ return processed content for a given doctest""" + +# ------------------------------------------------------------------------- +# error handling and internal debugging hooks +# ------------------------------------------------------------------------- + +def pytest_internalerror(excrepr, excinfo): + """ called for internal errors. """ + +def pytest_keyboard_interrupt(excinfo): + """ called for keyboard interrupt. """ + +def pytest_exception_interact(node, call, report): + """called when an exception was raised which can potentially be + interactively handled. + + This hook is only called if an exception was raised + that is not an internal exception like ``skip.Exception``. + """ + +def pytest_enter_pdb(config): + """ called upon pdb.set_trace(), can be used by plugins to take special + action just before the python debugger enters in interactive mode. + + :arg config: pytest config object + :type config: _pytest.config.Config + """ diff --git a/testing/web-platform/tests/tools/pytest/_pytest/impl b/testing/web-platform/tests/tools/pytest/_pytest/impl new file mode 100644 index 000000000..889e37e5a --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/impl @@ -0,0 +1,254 @@ +Sorting per-resource +----------------------------- + +for any given set of items: + +- collect items per session-scoped parametrized funcarg +- re-order until items no parametrizations are mixed + + examples: + + test() + test1(s1) + test1(s2) + test2() + test3(s1) + test3(s2) + + gets sorted to: + + test() + test2() + test1(s1) + test3(s1) + test1(s2) + test3(s2) + + +the new @setup functions +-------------------------------------- + +Consider a given @setup-marked function:: + + @pytest.mark.setup(maxscope=SCOPE) + def mysetup(request, arg1, arg2, ...) + ... + request.addfinalizer(fin) + ... + +then FUNCARGSET denotes the set of (arg1, arg2, ...) funcargs and +all of its dependent funcargs. The mysetup function will execute +for any matching test item once per scope. + +The scope is determined as the minimum scope of all scopes of the args +in FUNCARGSET and the given "maxscope". + +If mysetup has been called and no finalizers have been called it is +called "active". + +Furthermore the following rules apply: + +- if an arg value in FUNCARGSET is about to be torn down, the + mysetup-registered finalizers will execute as well. + +- There will never be two active mysetup invocations. + +Example 1, session scope:: + + @pytest.mark.funcarg(scope="session", params=[1,2]) + def db(request): + request.addfinalizer(db_finalize) + + @pytest.mark.setup + def mysetup(request, db): + request.addfinalizer(mysetup_finalize) + ... + +And a given test module: + + def test_something(): + ... + def test_otherthing(): + pass + +Here is what happens:: + + db(request) executes with request.param == 1 + mysetup(request, db) executes + test_something() executes + test_otherthing() executes + mysetup_finalize() executes + db_finalize() executes + db(request) executes with request.param == 2 + mysetup(request, db) executes + test_something() executes + test_otherthing() executes + mysetup_finalize() executes + db_finalize() executes + +Example 2, session/function scope:: + + @pytest.mark.funcarg(scope="session", params=[1,2]) + def db(request): + request.addfinalizer(db_finalize) + + @pytest.mark.setup(scope="function") + def mysetup(request, db): + ... + request.addfinalizer(mysetup_finalize) + ... + +And a given test module: + + def test_something(): + ... + def test_otherthing(): + pass + +Here is what happens:: + + db(request) executes with request.param == 1 + mysetup(request, db) executes + test_something() executes + mysetup_finalize() executes + mysetup(request, db) executes + test_otherthing() executes + mysetup_finalize() executes + db_finalize() executes + db(request) executes with request.param == 2 + mysetup(request, db) executes + test_something() executes + mysetup_finalize() executes + mysetup(request, db) executes + test_otherthing() executes + mysetup_finalize() executes + db_finalize() executes + + +Example 3 - funcargs session-mix +---------------------------------------- + +Similar with funcargs, an example:: + + @pytest.mark.funcarg(scope="session", params=[1,2]) + def db(request): + request.addfinalizer(db_finalize) + + @pytest.mark.funcarg(scope="function") + def table(request, db): + ... + request.addfinalizer(table_finalize) + ... + +And a given test module: + + def test_something(table): + ... + def test_otherthing(table): + pass + def test_thirdthing(): + pass + +Here is what happens:: + + db(request) executes with param == 1 + table(request, db) + test_something(table) + table_finalize() + table(request, db) + test_otherthing(table) + table_finalize() + db_finalize + db(request) executes with param == 2 + table(request, db) + test_something(table) + table_finalize() + table(request, db) + test_otherthing(table) + table_finalize() + db_finalize + test_thirdthing() + +Data structures +-------------------- + +pytest internally maintains a dict of active funcargs with cache, param, +finalizer, (scopeitem?) information: + + active_funcargs = dict() + +if a parametrized "db" is activated: + + active_funcargs["db"] = FuncargInfo(dbvalue, paramindex, + FuncargFinalize(...), scopeitem) + +if a test is torn down and the next test requires a differently +parametrized "db": + + for argname in item.callspec.params: + if argname in active_funcargs: + funcarginfo = active_funcargs[argname] + if funcarginfo.param != item.callspec.params[argname]: + funcarginfo.callfinalizer() + del node2funcarg[funcarginfo.scopeitem] + del active_funcargs[argname] + nodes_to_be_torn_down = ... + for node in nodes_to_be_torn_down: + if node in node2funcarg: + argname = node2funcarg[node] + active_funcargs[argname].callfinalizer() + del node2funcarg[node] + del active_funcargs[argname] + +if a test is setup requiring a "db" funcarg: + + if "db" in active_funcargs: + return active_funcargs["db"][0] + funcarginfo = setup_funcarg() + active_funcargs["db"] = funcarginfo + node2funcarg[funcarginfo.scopeitem] = "db" + +Implementation plan for resources +------------------------------------------ + +1. Revert FuncargRequest to the old form, unmerge item/request + (done) +2. make funcarg factories be discovered at collection time +3. Introduce funcarg marker +4. Introduce funcarg scope parameter +5. Introduce funcarg parametrize parameter +6. make setup functions be discovered at collection time +7. (Introduce a pytest_fixture_protocol/setup_funcargs hook) + +methods and data structures +-------------------------------- + +A FuncarcManager holds all information about funcarg definitions +including parametrization and scope definitions. It implements +a pytest_generate_tests hook which performs parametrization as appropriate. + +as a simple example, let's consider a tree where a test function requires +a "abc" funcarg and its factory defines it as parametrized and scoped +for Modules. When collections hits the function item, it creates +the metafunc object, and calls funcargdb.pytest_generate_tests(metafunc) +which looks up available funcarg factories and their scope and parametrization. +This information is equivalent to what can be provided today directly +at the function site and it should thus be relatively straight forward +to implement the additional way of defining parametrization/scoping. + +conftest loading: + each funcarg-factory will populate the session.funcargmanager + +When a test item is collected, it grows a dictionary +(funcargname2factorycalllist). A factory lookup is performed +for each required funcarg. The resulting factory call is stored +with the item. If a function is parametrized multiple items are +created with respective factory calls. Else if a factory is parametrized +multiple items and calls to the factory function are created as well. + +At setup time, an item populates a funcargs mapping, mapping names +to values. If a value is funcarg factories are queried for a given item +test functions and setup functions are put in a class +which looks up required funcarg factories. + + diff --git a/testing/web-platform/tests/tools/pytest/_pytest/junitxml.py b/testing/web-platform/tests/tools/pytest/_pytest/junitxml.py new file mode 100644 index 000000000..660d718a6 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/junitxml.py @@ -0,0 +1,387 @@ +""" + report test results in JUnit-XML format, + for use with Jenkins and build integration servers. + + +Based on initial code from Ross Lawley. +""" +# Output conforms to https://github.com/jenkinsci/xunit-plugin/blob/master/ +# src/main/resources/org/jenkinsci/plugins/xunit/types/model/xsd/junit-10.xsd + +import py +import os +import re +import sys +import time +import pytest + +# Python 2.X and 3.X compatibility +if sys.version_info[0] < 3: + from codecs import open +else: + unichr = chr + unicode = str + long = int + + +class Junit(py.xml.Namespace): + pass + +# We need to get the subset of the invalid unicode ranges according to +# XML 1.0 which are valid in this python build. Hence we calculate +# this dynamically instead of hardcoding it. The spec range of valid +# chars is: Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] +# | [#x10000-#x10FFFF] +_legal_chars = (0x09, 0x0A, 0x0d) +_legal_ranges = ( + (0x20, 0x7E), (0x80, 0xD7FF), (0xE000, 0xFFFD), (0x10000, 0x10FFFF), +) +_legal_xml_re = [ + unicode("%s-%s") % (unichr(low), unichr(high)) + for (low, high) in _legal_ranges if low < sys.maxunicode +] +_legal_xml_re = [unichr(x) for x in _legal_chars] + _legal_xml_re +illegal_xml_re = re.compile(unicode('[^%s]') % unicode('').join(_legal_xml_re)) +del _legal_chars +del _legal_ranges +del _legal_xml_re + +_py_ext_re = re.compile(r"\.py$") + + +def bin_xml_escape(arg): + def repl(matchobj): + i = ord(matchobj.group()) + if i <= 0xFF: + return unicode('#x%02X') % i + else: + return unicode('#x%04X') % i + + return py.xml.raw(illegal_xml_re.sub(repl, py.xml.escape(arg))) + + +class _NodeReporter(object): + def __init__(self, nodeid, xml): + + self.id = nodeid + self.xml = xml + self.add_stats = self.xml.add_stats + self.duration = 0 + self.properties = [] + self.nodes = [] + self.testcase = None + self.attrs = {} + + def append(self, node): + self.xml.add_stats(type(node).__name__) + self.nodes.append(node) + + def add_property(self, name, value): + self.properties.append((str(name), bin_xml_escape(value))) + + def make_properties_node(self): + """Return a Junit node containing custom properties, if any. + """ + if self.properties: + return Junit.properties([ + Junit.property(name=name, value=value) + for name, value in self.properties + ]) + return '' + + def record_testreport(self, testreport): + assert not self.testcase + names = mangle_test_address(testreport.nodeid) + classnames = names[:-1] + if self.xml.prefix: + classnames.insert(0, self.xml.prefix) + attrs = { + "classname": ".".join(classnames), + "name": bin_xml_escape(names[-1]), + "file": testreport.location[0], + } + if testreport.location[1] is not None: + attrs["line"] = testreport.location[1] + self.attrs = attrs + + def to_xml(self): + testcase = Junit.testcase(time=self.duration, **self.attrs) + testcase.append(self.make_properties_node()) + for node in self.nodes: + testcase.append(node) + return testcase + + def _add_simple(self, kind, message, data=None): + data = bin_xml_escape(data) + node = kind(data, message=message) + self.append(node) + + def _write_captured_output(self, report): + for capname in ('out', 'err'): + allcontent = "" + for name, content in report.get_sections("Captured std%s" % + capname): + allcontent += content + if allcontent: + tag = getattr(Junit, 'system-' + capname) + self.append(tag(bin_xml_escape(allcontent))) + + def append_pass(self, report): + self.add_stats('passed') + self._write_captured_output(report) + + def append_failure(self, report): + # msg = str(report.longrepr.reprtraceback.extraline) + if hasattr(report, "wasxfail"): + self._add_simple( + Junit.skipped, + "xfail-marked test passes unexpectedly") + else: + if hasattr(report.longrepr, "reprcrash"): + message = report.longrepr.reprcrash.message + elif isinstance(report.longrepr, (unicode, str)): + message = report.longrepr + else: + message = str(report.longrepr) + message = bin_xml_escape(message) + fail = Junit.failure(message=message) + fail.append(bin_xml_escape(report.longrepr)) + self.append(fail) + self._write_captured_output(report) + + def append_collect_error(self, report): + # msg = str(report.longrepr.reprtraceback.extraline) + self.append(Junit.error(bin_xml_escape(report.longrepr), + message="collection failure")) + + def append_collect_skipped(self, report): + self._add_simple( + Junit.skipped, "collection skipped", report.longrepr) + + def append_error(self, report): + self._add_simple( + Junit.error, "test setup failure", report.longrepr) + self._write_captured_output(report) + + def append_skipped(self, report): + if hasattr(report, "wasxfail"): + self._add_simple( + Junit.skipped, "expected test failure", report.wasxfail + ) + else: + filename, lineno, skipreason = report.longrepr + if skipreason.startswith("Skipped: "): + skipreason = bin_xml_escape(skipreason[9:]) + self.append( + Junit.skipped("%s:%s: %s" % (filename, lineno, skipreason), + type="pytest.skip", + message=skipreason)) + self._write_captured_output(report) + + def finalize(self): + data = self.to_xml().unicode(indent=0) + self.__dict__.clear() + self.to_xml = lambda: py.xml.raw(data) + + +@pytest.fixture +def record_xml_property(request): + """Fixture that adds extra xml properties to the tag for the calling test. + The fixture is callable with (name, value), with value being automatically + xml-encoded. + """ + request.node.warn( + code='C3', + message='record_xml_property is an experimental feature', + ) + xml = getattr(request.config, "_xml", None) + if xml is not None: + node_reporter = xml.node_reporter(request.node.nodeid) + return node_reporter.add_property + else: + def add_property_noop(name, value): + pass + + return add_property_noop + + +def pytest_addoption(parser): + group = parser.getgroup("terminal reporting") + group.addoption( + '--junitxml', '--junit-xml', + action="store", + dest="xmlpath", + metavar="path", + default=None, + help="create junit-xml style report file at given path.") + group.addoption( + '--junitprefix', '--junit-prefix', + action="store", + metavar="str", + default=None, + help="prepend prefix to classnames in junit-xml output") + + +def pytest_configure(config): + xmlpath = config.option.xmlpath + # prevent opening xmllog on slave nodes (xdist) + if xmlpath and not hasattr(config, 'slaveinput'): + config._xml = LogXML(xmlpath, config.option.junitprefix) + config.pluginmanager.register(config._xml) + + +def pytest_unconfigure(config): + xml = getattr(config, '_xml', None) + if xml: + del config._xml + config.pluginmanager.unregister(xml) + + +def mangle_test_address(address): + path, possible_open_bracket, params = address.partition('[') + names = path.split("::") + try: + names.remove('()') + except ValueError: + pass + # convert file path to dotted path + names[0] = names[0].replace("/", '.') + names[0] = _py_ext_re.sub("", names[0]) + # put any params back + names[-1] += possible_open_bracket + params + return names + + +class LogXML(object): + def __init__(self, logfile, prefix): + logfile = os.path.expanduser(os.path.expandvars(logfile)) + self.logfile = os.path.normpath(os.path.abspath(logfile)) + self.prefix = prefix + self.stats = dict.fromkeys([ + 'error', + 'passed', + 'failure', + 'skipped', + ], 0) + self.node_reporters = {} # nodeid -> _NodeReporter + self.node_reporters_ordered = [] + + def finalize(self, report): + nodeid = getattr(report, 'nodeid', report) + # local hack to handle xdist report order + slavenode = getattr(report, 'node', None) + reporter = self.node_reporters.pop((nodeid, slavenode)) + if reporter is not None: + reporter.finalize() + + def node_reporter(self, report): + nodeid = getattr(report, 'nodeid', report) + # local hack to handle xdist report order + slavenode = getattr(report, 'node', None) + + key = nodeid, slavenode + + if key in self.node_reporters: + # TODO: breasks for --dist=each + return self.node_reporters[key] + reporter = _NodeReporter(nodeid, self) + self.node_reporters[key] = reporter + self.node_reporters_ordered.append(reporter) + return reporter + + def add_stats(self, key): + if key in self.stats: + self.stats[key] += 1 + + def _opentestcase(self, report): + reporter = self.node_reporter(report) + reporter.record_testreport(report) + return reporter + + def pytest_runtest_logreport(self, report): + """handle a setup/call/teardown report, generating the appropriate + xml tags as necessary. + + note: due to plugins like xdist, this hook may be called in interlaced + order with reports from other nodes. for example: + + usual call order: + -> setup node1 + -> call node1 + -> teardown node1 + -> setup node2 + -> call node2 + -> teardown node2 + + possible call order in xdist: + -> setup node1 + -> call node1 + -> setup node2 + -> call node2 + -> teardown node2 + -> teardown node1 + """ + if report.passed: + if report.when == "call": # ignore setup/teardown + reporter = self._opentestcase(report) + reporter.append_pass(report) + elif report.failed: + reporter = self._opentestcase(report) + if report.when == "call": + reporter.append_failure(report) + else: + reporter.append_error(report) + elif report.skipped: + reporter = self._opentestcase(report) + reporter.append_skipped(report) + self.update_testcase_duration(report) + if report.when == "teardown": + self.finalize(report) + + def update_testcase_duration(self, report): + """accumulates total duration for nodeid from given report and updates + the Junit.testcase with the new total if already created. + """ + reporter = self.node_reporter(report) + reporter.duration += getattr(report, 'duration', 0.0) + + def pytest_collectreport(self, report): + if not report.passed: + reporter = self._opentestcase(report) + if report.failed: + reporter.append_collect_error(report) + else: + reporter.append_collect_skipped(report) + + def pytest_internalerror(self, excrepr): + reporter = self.node_reporter('internal') + reporter.attrs.update(classname="pytest", name='internal') + reporter._add_simple(Junit.error, 'internal error', excrepr) + + def pytest_sessionstart(self): + self.suite_start_time = time.time() + + def pytest_sessionfinish(self): + dirname = os.path.dirname(os.path.abspath(self.logfile)) + if not os.path.isdir(dirname): + os.makedirs(dirname) + logfile = open(self.logfile, 'w', encoding='utf-8') + suite_stop_time = time.time() + suite_time_delta = suite_stop_time - self.suite_start_time + + numtests = self.stats['passed'] + self.stats['failure'] + + logfile.write('<?xml version="1.0" encoding="utf-8"?>') + logfile.write(Junit.testsuite( + [x.to_xml() for x in self.node_reporters_ordered], + name="pytest", + errors=self.stats['error'], + failures=self.stats['failure'], + skips=self.stats['skipped'], + tests=numtests, + time="%.3f" % suite_time_delta, ).unicode(indent=0)) + logfile.close() + + def pytest_terminal_summary(self, terminalreporter): + terminalreporter.write_sep("-", + "generated xml file: %s" % (self.logfile)) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/main.py b/testing/web-platform/tests/tools/pytest/_pytest/main.py new file mode 100644 index 000000000..8654d7af6 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/main.py @@ -0,0 +1,744 @@ +""" core implementation of testing process: init, session, runtest loop. """ +import imp +import os +import re +import sys + +import _pytest +import _pytest._code +import py +import pytest +try: + from collections import MutableMapping as MappingMixin +except ImportError: + from UserDict import DictMixin as MappingMixin + +from _pytest.runner import collect_one_node + +tracebackcutdir = py.path.local(_pytest.__file__).dirpath() + +# exitcodes for the command line +EXIT_OK = 0 +EXIT_TESTSFAILED = 1 +EXIT_INTERRUPTED = 2 +EXIT_INTERNALERROR = 3 +EXIT_USAGEERROR = 4 +EXIT_NOTESTSCOLLECTED = 5 + +name_re = re.compile("^[a-zA-Z_]\w*$") + +def pytest_addoption(parser): + parser.addini("norecursedirs", "directory patterns to avoid for recursion", + type="args", default=['.*', 'CVS', '_darcs', '{arch}', '*.egg']) + parser.addini("testpaths", "directories to search for tests when no files or directories are given in the command line.", + type="args", default=[]) + #parser.addini("dirpatterns", + # "patterns specifying possible locations of test files", + # type="linelist", default=["**/test_*.txt", + # "**/test_*.py", "**/*_test.py"] + #) + group = parser.getgroup("general", "running and selection options") + group._addoption('-x', '--exitfirst', action="store_true", default=False, + dest="exitfirst", + help="exit instantly on first error or failed test."), + group._addoption('--maxfail', metavar="num", + action="store", type=int, dest="maxfail", default=0, + help="exit after first num failures or errors.") + group._addoption('--strict', action="store_true", + help="run pytest in strict mode, warnings become errors.") + group._addoption("-c", metavar="file", type=str, dest="inifilename", + help="load configuration from `file` instead of trying to locate one of the implicit configuration files.") + + group = parser.getgroup("collect", "collection") + group.addoption('--collectonly', '--collect-only', action="store_true", + help="only collect tests, don't execute them."), + group.addoption('--pyargs', action="store_true", + help="try to interpret all arguments as python packages.") + group.addoption("--ignore", action="append", metavar="path", + help="ignore path during collection (multi-allowed).") + # when changing this to --conf-cut-dir, config.py Conftest.setinitial + # needs upgrading as well + group.addoption('--confcutdir', dest="confcutdir", default=None, + metavar="dir", + help="only load conftest.py's relative to specified dir.") + group.addoption('--noconftest', action="store_true", + dest="noconftest", default=False, + help="Don't load any conftest.py files.") + + group = parser.getgroup("debugconfig", + "test session debugging and configuration") + group.addoption('--basetemp', dest="basetemp", default=None, metavar="dir", + help="base temporary directory for this test run.") + + +def pytest_namespace(): + collect = dict(Item=Item, Collector=Collector, File=File, Session=Session) + return dict(collect=collect) + +def pytest_configure(config): + pytest.config = config # compatibiltiy + if config.option.exitfirst: + config.option.maxfail = 1 + +def wrap_session(config, doit): + """Skeleton command line program""" + session = Session(config) + session.exitstatus = EXIT_OK + initstate = 0 + try: + try: + config._do_configure() + initstate = 1 + config.hook.pytest_sessionstart(session=session) + initstate = 2 + session.exitstatus = doit(config, session) or 0 + except pytest.UsageError: + raise + except KeyboardInterrupt: + excinfo = _pytest._code.ExceptionInfo() + config.hook.pytest_keyboard_interrupt(excinfo=excinfo) + session.exitstatus = EXIT_INTERRUPTED + except: + excinfo = _pytest._code.ExceptionInfo() + config.notify_exception(excinfo, config.option) + session.exitstatus = EXIT_INTERNALERROR + if excinfo.errisinstance(SystemExit): + sys.stderr.write("mainloop: caught Spurious SystemExit!\n") + + finally: + excinfo = None # Explicitly break reference cycle. + session.startdir.chdir() + if initstate >= 2: + config.hook.pytest_sessionfinish( + session=session, + exitstatus=session.exitstatus) + config._ensure_unconfigure() + return session.exitstatus + +def pytest_cmdline_main(config): + return wrap_session(config, _main) + +def _main(config, session): + """ default command line protocol for initialization, session, + running tests and reporting. """ + config.hook.pytest_collection(session=session) + config.hook.pytest_runtestloop(session=session) + + if session.testsfailed: + return EXIT_TESTSFAILED + elif session.testscollected == 0: + return EXIT_NOTESTSCOLLECTED + +def pytest_collection(session): + return session.perform_collect() + +def pytest_runtestloop(session): + if session.config.option.collectonly: + return True + + def getnextitem(i): + # this is a function to avoid python2 + # keeping sys.exc_info set when calling into a test + # python2 keeps sys.exc_info till the frame is left + try: + return session.items[i+1] + except IndexError: + return None + + for i, item in enumerate(session.items): + nextitem = getnextitem(i) + item.config.hook.pytest_runtest_protocol(item=item, nextitem=nextitem) + if session.shouldstop: + raise session.Interrupted(session.shouldstop) + return True + +def pytest_ignore_collect(path, config): + p = path.dirpath() + ignore_paths = config._getconftest_pathlist("collect_ignore", path=p) + ignore_paths = ignore_paths or [] + excludeopt = config.getoption("ignore") + if excludeopt: + ignore_paths.extend([py.path.local(x) for x in excludeopt]) + return path in ignore_paths + +class FSHookProxy: + def __init__(self, fspath, pm, remove_mods): + self.fspath = fspath + self.pm = pm + self.remove_mods = remove_mods + + def __getattr__(self, name): + x = self.pm.subset_hook_caller(name, remove_plugins=self.remove_mods) + self.__dict__[name] = x + return x + +def compatproperty(name): + def fget(self): + # deprecated - use pytest.name + return getattr(pytest, name) + + return property(fget) + +class NodeKeywords(MappingMixin): + def __init__(self, node): + self.node = node + self.parent = node.parent + self._markers = {node.name: True} + + def __getitem__(self, key): + try: + return self._markers[key] + except KeyError: + if self.parent is None: + raise + return self.parent.keywords[key] + + def __setitem__(self, key, value): + self._markers[key] = value + + def __delitem__(self, key): + raise ValueError("cannot delete key in keywords dict") + + def __iter__(self): + seen = set(self._markers) + if self.parent is not None: + seen.update(self.parent.keywords) + return iter(seen) + + def __len__(self): + return len(self.__iter__()) + + def keys(self): + return list(self) + + def __repr__(self): + return "<NodeKeywords for node %s>" % (self.node, ) + + +class Node(object): + """ base class for Collector and Item the test collection tree. + Collector subclasses have children, Items are terminal nodes.""" + + def __init__(self, name, parent=None, config=None, session=None): + #: a unique name within the scope of the parent node + self.name = name + + #: the parent collector node. + self.parent = parent + + #: the pytest config object + self.config = config or parent.config + + #: the session this node is part of + self.session = session or parent.session + + #: filesystem path where this node was collected from (can be None) + self.fspath = getattr(parent, 'fspath', None) + + #: keywords/markers collected from all scopes + self.keywords = NodeKeywords(self) + + #: allow adding of extra keywords to use for matching + self.extra_keyword_matches = set() + + # used for storing artificial fixturedefs for direct parametrization + self._name2pseudofixturedef = {} + + @property + def ihook(self): + """ fspath sensitive hook proxy used to call pytest hooks""" + return self.session.gethookproxy(self.fspath) + + Module = compatproperty("Module") + Class = compatproperty("Class") + Instance = compatproperty("Instance") + Function = compatproperty("Function") + File = compatproperty("File") + Item = compatproperty("Item") + + def _getcustomclass(self, name): + cls = getattr(self, name) + if cls != getattr(pytest, name): + py.log._apiwarn("2.0", "use of node.%s is deprecated, " + "use pytest_pycollect_makeitem(...) to create custom " + "collection nodes" % name) + return cls + + def __repr__(self): + return "<%s %r>" %(self.__class__.__name__, + getattr(self, 'name', None)) + + def warn(self, code, message): + """ generate a warning with the given code and message for this + item. """ + assert isinstance(code, str) + fslocation = getattr(self, "location", None) + if fslocation is None: + fslocation = getattr(self, "fspath", None) + else: + fslocation = "%s:%s" % fslocation[:2] + + self.ihook.pytest_logwarning.call_historic(kwargs=dict( + code=code, message=message, + nodeid=self.nodeid, fslocation=fslocation)) + + # methods for ordering nodes + @property + def nodeid(self): + """ a ::-separated string denoting its collection tree address. """ + try: + return self._nodeid + except AttributeError: + self._nodeid = x = self._makeid() + return x + + def _makeid(self): + return self.parent.nodeid + "::" + self.name + + def __hash__(self): + return hash(self.nodeid) + + def setup(self): + pass + + def teardown(self): + pass + + def _memoizedcall(self, attrname, function): + exattrname = "_ex_" + attrname + failure = getattr(self, exattrname, None) + if failure is not None: + py.builtin._reraise(failure[0], failure[1], failure[2]) + if hasattr(self, attrname): + return getattr(self, attrname) + try: + res = function() + except py.builtin._sysex: + raise + except: + failure = sys.exc_info() + setattr(self, exattrname, failure) + raise + setattr(self, attrname, res) + return res + + def listchain(self): + """ return list of all parent collectors up to self, + starting from root of collection tree. """ + chain = [] + item = self + while item is not None: + chain.append(item) + item = item.parent + chain.reverse() + return chain + + def add_marker(self, marker): + """ dynamically add a marker object to the node. + + ``marker`` can be a string or pytest.mark.* instance. + """ + from _pytest.mark import MarkDecorator + if isinstance(marker, py.builtin._basestring): + marker = MarkDecorator(marker) + elif not isinstance(marker, MarkDecorator): + raise ValueError("is not a string or pytest.mark.* Marker") + self.keywords[marker.name] = marker + + def get_marker(self, name): + """ get a marker object from this node or None if + the node doesn't have a marker with that name. """ + val = self.keywords.get(name, None) + if val is not None: + from _pytest.mark import MarkInfo, MarkDecorator + if isinstance(val, (MarkDecorator, MarkInfo)): + return val + + def listextrakeywords(self): + """ Return a set of all extra keywords in self and any parents.""" + extra_keywords = set() + item = self + for item in self.listchain(): + extra_keywords.update(item.extra_keyword_matches) + return extra_keywords + + def listnames(self): + return [x.name for x in self.listchain()] + + def addfinalizer(self, fin): + """ register a function to be called when this node is finalized. + + This method can only be called when this node is active + in a setup chain, for example during self.setup(). + """ + self.session._setupstate.addfinalizer(fin, self) + + def getparent(self, cls): + """ get the next parent node (including ourself) + which is an instance of the given class""" + current = self + while current and not isinstance(current, cls): + current = current.parent + return current + + def _prunetraceback(self, excinfo): + pass + + def _repr_failure_py(self, excinfo, style=None): + fm = self.session._fixturemanager + if excinfo.errisinstance(fm.FixtureLookupError): + return excinfo.value.formatrepr() + tbfilter = True + if self.config.option.fulltrace: + style="long" + else: + self._prunetraceback(excinfo) + tbfilter = False # prunetraceback already does it + if style == "auto": + style = "long" + # XXX should excinfo.getrepr record all data and toterminal() process it? + if style is None: + if self.config.option.tbstyle == "short": + style = "short" + else: + style = "long" + + return excinfo.getrepr(funcargs=True, + showlocals=self.config.option.showlocals, + style=style, tbfilter=tbfilter) + + repr_failure = _repr_failure_py + +class Collector(Node): + """ Collector instances create children through collect() + and thus iteratively build a tree. + """ + + class CollectError(Exception): + """ an error during collection, contains a custom message. """ + + def collect(self): + """ returns a list of children (items and collectors) + for this collection node. + """ + raise NotImplementedError("abstract") + + def repr_failure(self, excinfo): + """ represent a collection failure. """ + if excinfo.errisinstance(self.CollectError): + exc = excinfo.value + return str(exc.args[0]) + return self._repr_failure_py(excinfo, style="short") + + def _memocollect(self): + """ internal helper method to cache results of calling collect(). """ + return self._memoizedcall('_collected', lambda: list(self.collect())) + + def _prunetraceback(self, excinfo): + if hasattr(self, 'fspath'): + traceback = excinfo.traceback + ntraceback = traceback.cut(path=self.fspath) + if ntraceback == traceback: + ntraceback = ntraceback.cut(excludepath=tracebackcutdir) + excinfo.traceback = ntraceback.filter() + +class FSCollector(Collector): + def __init__(self, fspath, parent=None, config=None, session=None): + fspath = py.path.local(fspath) # xxx only for test_resultlog.py? + name = fspath.basename + if parent is not None: + rel = fspath.relto(parent.fspath) + if rel: + name = rel + name = name.replace(os.sep, "/") + super(FSCollector, self).__init__(name, parent, config, session) + self.fspath = fspath + + def _makeid(self): + relpath = self.fspath.relto(self.config.rootdir) + if os.sep != "/": + relpath = relpath.replace(os.sep, "/") + return relpath + +class File(FSCollector): + """ base class for collecting tests from a file. """ + +class Item(Node): + """ a basic test invocation item. Note that for a single function + there might be multiple test invocation items. + """ + nextitem = None + + def __init__(self, name, parent=None, config=None, session=None): + super(Item, self).__init__(name, parent, config, session) + self._report_sections = [] + + def add_report_section(self, when, key, content): + if content: + self._report_sections.append((when, key, content)) + + def reportinfo(self): + return self.fspath, None, "" + + @property + def location(self): + try: + return self._location + except AttributeError: + location = self.reportinfo() + # bestrelpath is a quite slow function + cache = self.config.__dict__.setdefault("_bestrelpathcache", {}) + try: + fspath = cache[location[0]] + except KeyError: + fspath = self.session.fspath.bestrelpath(location[0]) + cache[location[0]] = fspath + location = (fspath, location[1], str(location[2])) + self._location = location + return location + +class NoMatch(Exception): + """ raised if matching cannot locate a matching names. """ + +class Interrupted(KeyboardInterrupt): + """ signals an interrupted test run. """ + __module__ = 'builtins' # for py3 + +class Session(FSCollector): + Interrupted = Interrupted + + def __init__(self, config): + FSCollector.__init__(self, config.rootdir, parent=None, + config=config, session=self) + self._fs2hookproxy = {} + self.testsfailed = 0 + self.testscollected = 0 + self.shouldstop = False + self.trace = config.trace.root.get("collection") + self._norecursepatterns = config.getini("norecursedirs") + self.startdir = py.path.local() + self.config.pluginmanager.register(self, name="session") + + def _makeid(self): + return "" + + @pytest.hookimpl(tryfirst=True) + def pytest_collectstart(self): + if self.shouldstop: + raise self.Interrupted(self.shouldstop) + + @pytest.hookimpl(tryfirst=True) + def pytest_runtest_logreport(self, report): + if report.failed and not hasattr(report, 'wasxfail'): + self.testsfailed += 1 + maxfail = self.config.getvalue("maxfail") + if maxfail and self.testsfailed >= maxfail: + self.shouldstop = "stopping after %d failures" % ( + self.testsfailed) + pytest_collectreport = pytest_runtest_logreport + + def isinitpath(self, path): + return path in self._initialpaths + + def gethookproxy(self, fspath): + try: + return self._fs2hookproxy[fspath] + except KeyError: + # check if we have the common case of running + # hooks with all conftest.py filesall conftest.py + pm = self.config.pluginmanager + my_conftestmodules = pm._getconftestmodules(fspath) + remove_mods = pm._conftest_plugins.difference(my_conftestmodules) + if remove_mods: + # one or more conftests are not in use at this fspath + proxy = FSHookProxy(fspath, pm, remove_mods) + else: + # all plugis are active for this fspath + proxy = self.config.hook + + self._fs2hookproxy[fspath] = proxy + return proxy + + def perform_collect(self, args=None, genitems=True): + hook = self.config.hook + try: + items = self._perform_collect(args, genitems) + hook.pytest_collection_modifyitems(session=self, + config=self.config, items=items) + finally: + hook.pytest_collection_finish(session=self) + self.testscollected = len(items) + return items + + def _perform_collect(self, args, genitems): + if args is None: + args = self.config.args + self.trace("perform_collect", self, args) + self.trace.root.indent += 1 + self._notfound = [] + self._initialpaths = set() + self._initialparts = [] + self.items = items = [] + for arg in args: + parts = self._parsearg(arg) + self._initialparts.append(parts) + self._initialpaths.add(parts[0]) + rep = collect_one_node(self) + self.ihook.pytest_collectreport(report=rep) + self.trace.root.indent -= 1 + if self._notfound: + errors = [] + for arg, exc in self._notfound: + line = "(no name %r in any of %r)" % (arg, exc.args[0]) + errors.append("not found: %s\n%s" % (arg, line)) + #XXX: test this + raise pytest.UsageError(*errors) + if not genitems: + return rep.result + else: + if rep.passed: + for node in rep.result: + self.items.extend(self.genitems(node)) + return items + + def collect(self): + for parts in self._initialparts: + arg = "::".join(map(str, parts)) + self.trace("processing argument", arg) + self.trace.root.indent += 1 + try: + for x in self._collect(arg): + yield x + except NoMatch: + # we are inside a make_report hook so + # we cannot directly pass through the exception + self._notfound.append((arg, sys.exc_info()[1])) + + self.trace.root.indent -= 1 + + def _collect(self, arg): + names = self._parsearg(arg) + path = names.pop(0) + if path.check(dir=1): + assert not names, "invalid arg %r" %(arg,) + for path in path.visit(fil=lambda x: x.check(file=1), + rec=self._recurse, bf=True, sort=True): + for x in self._collectfile(path): + yield x + else: + assert path.check(file=1) + for x in self.matchnodes(self._collectfile(path), names): + yield x + + def _collectfile(self, path): + ihook = self.gethookproxy(path) + if not self.isinitpath(path): + if ihook.pytest_ignore_collect(path=path, config=self.config): + return () + return ihook.pytest_collect_file(path=path, parent=self) + + def _recurse(self, path): + ihook = self.gethookproxy(path.dirpath()) + if ihook.pytest_ignore_collect(path=path, config=self.config): + return + for pat in self._norecursepatterns: + if path.check(fnmatch=pat): + return False + ihook = self.gethookproxy(path) + ihook.pytest_collect_directory(path=path, parent=self) + return True + + def _tryconvertpyarg(self, x): + mod = None + path = [os.path.abspath('.')] + sys.path + for name in x.split('.'): + # ignore anything that's not a proper name here + # else something like --pyargs will mess up '.' + # since imp.find_module will actually sometimes work for it + # but it's supposed to be considered a filesystem path + # not a package + if name_re.match(name) is None: + return x + try: + fd, mod, type_ = imp.find_module(name, path) + except ImportError: + return x + else: + if fd is not None: + fd.close() + + if type_[2] != imp.PKG_DIRECTORY: + path = [os.path.dirname(mod)] + else: + path = [mod] + return mod + + def _parsearg(self, arg): + """ return (fspath, names) tuple after checking the file exists. """ + arg = str(arg) + if self.config.option.pyargs: + arg = self._tryconvertpyarg(arg) + parts = str(arg).split("::") + relpath = parts[0].replace("/", os.sep) + path = self.config.invocation_dir.join(relpath, abs=True) + if not path.check(): + if self.config.option.pyargs: + msg = "file or package not found: " + else: + msg = "file not found: " + raise pytest.UsageError(msg + arg) + parts[0] = path + return parts + + def matchnodes(self, matching, names): + self.trace("matchnodes", matching, names) + self.trace.root.indent += 1 + nodes = self._matchnodes(matching, names) + num = len(nodes) + self.trace("matchnodes finished -> ", num, "nodes") + self.trace.root.indent -= 1 + if num == 0: + raise NoMatch(matching, names[:1]) + return nodes + + def _matchnodes(self, matching, names): + if not matching or not names: + return matching + name = names[0] + assert name + nextnames = names[1:] + resultnodes = [] + for node in matching: + if isinstance(node, pytest.Item): + if not names: + resultnodes.append(node) + continue + assert isinstance(node, pytest.Collector) + rep = collect_one_node(node) + if rep.passed: + has_matched = False + for x in rep.result: + # TODO: remove parametrized workaround once collection structure contains parametrization + if x.name == name or x.name.split("[")[0] == name: + resultnodes.extend(self.matchnodes([x], nextnames)) + has_matched = True + # XXX accept IDs that don't have "()" for class instances + if not has_matched and len(rep.result) == 1 and x.name == "()": + nextnames.insert(0, name) + resultnodes.extend(self.matchnodes([x], nextnames)) + node.ihook.pytest_collectreport(report=rep) + return resultnodes + + def genitems(self, node): + self.trace("genitems", node) + if isinstance(node, pytest.Item): + node.ihook.pytest_itemcollected(item=node) + yield node + else: + assert isinstance(node, pytest.Collector) + rep = collect_one_node(node) + if rep.passed: + for subnode in rep.result: + for x in self.genitems(subnode): + yield x + node.ihook.pytest_collectreport(report=rep) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/mark.py b/testing/web-platform/tests/tools/pytest/_pytest/mark.py new file mode 100644 index 000000000..1a7635402 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/mark.py @@ -0,0 +1,311 @@ +""" generic mechanism for marking and selecting python functions. """ +import inspect + + +class MarkerError(Exception): + + """Error in use of a pytest marker/attribute.""" + + +def pytest_namespace(): + return {'mark': MarkGenerator()} + + +def pytest_addoption(parser): + group = parser.getgroup("general") + group._addoption( + '-k', + action="store", dest="keyword", default='', metavar="EXPRESSION", + help="only run tests which match the given substring expression. " + "An expression is a python evaluatable expression " + "where all names are substring-matched against test names " + "and their parent classes. Example: -k 'test_method or test " + "other' matches all test functions and classes whose name " + "contains 'test_method' or 'test_other'. " + "Additionally keywords are matched to classes and functions " + "containing extra names in their 'extra_keyword_matches' set, " + "as well as functions which have names assigned directly to them." + ) + + group._addoption( + "-m", + action="store", dest="markexpr", default="", metavar="MARKEXPR", + help="only run tests matching given mark expression. " + "example: -m 'mark1 and not mark2'." + ) + + group.addoption( + "--markers", action="store_true", + help="show markers (builtin, plugin and per-project ones)." + ) + + parser.addini("markers", "markers for test functions", 'linelist') + + +def pytest_cmdline_main(config): + import _pytest.config + if config.option.markers: + config._do_configure() + tw = _pytest.config.create_terminal_writer(config) + for line in config.getini("markers"): + name, rest = line.split(":", 1) + tw.write("@pytest.mark.%s:" % name, bold=True) + tw.line(rest) + tw.line() + config._ensure_unconfigure() + return 0 +pytest_cmdline_main.tryfirst = True + + +def pytest_collection_modifyitems(items, config): + keywordexpr = config.option.keyword + matchexpr = config.option.markexpr + if not keywordexpr and not matchexpr: + return + # pytest used to allow "-" for negating + # but today we just allow "-" at the beginning, use "not" instead + # we probably remove "-" alltogether soon + if keywordexpr.startswith("-"): + keywordexpr = "not " + keywordexpr[1:] + selectuntil = False + if keywordexpr[-1:] == ":": + selectuntil = True + keywordexpr = keywordexpr[:-1] + + remaining = [] + deselected = [] + for colitem in items: + if keywordexpr and not matchkeyword(colitem, keywordexpr): + deselected.append(colitem) + else: + if selectuntil: + keywordexpr = None + if matchexpr: + if not matchmark(colitem, matchexpr): + deselected.append(colitem) + continue + remaining.append(colitem) + + if deselected: + config.hook.pytest_deselected(items=deselected) + items[:] = remaining + + +class MarkMapping: + """Provides a local mapping for markers where item access + resolves to True if the marker is present. """ + def __init__(self, keywords): + mymarks = set() + for key, value in keywords.items(): + if isinstance(value, MarkInfo) or isinstance(value, MarkDecorator): + mymarks.add(key) + self._mymarks = mymarks + + def __getitem__(self, name): + return name in self._mymarks + + +class KeywordMapping: + """Provides a local mapping for keywords. + Given a list of names, map any substring of one of these names to True. + """ + def __init__(self, names): + self._names = names + + def __getitem__(self, subname): + for name in self._names: + if subname in name: + return True + return False + + +def matchmark(colitem, markexpr): + """Tries to match on any marker names, attached to the given colitem.""" + return eval(markexpr, {}, MarkMapping(colitem.keywords)) + + +def matchkeyword(colitem, keywordexpr): + """Tries to match given keyword expression to given collector item. + + Will match on the name of colitem, including the names of its parents. + Only matches names of items which are either a :class:`Class` or a + :class:`Function`. + Additionally, matches on names in the 'extra_keyword_matches' set of + any item, as well as names directly assigned to test functions. + """ + mapped_names = set() + + # Add the names of the current item and any parent items + import pytest + for item in colitem.listchain(): + if not isinstance(item, pytest.Instance): + mapped_names.add(item.name) + + # Add the names added as extra keywords to current or parent items + for name in colitem.listextrakeywords(): + mapped_names.add(name) + + # Add the names attached to the current function through direct assignment + if hasattr(colitem, 'function'): + for name in colitem.function.__dict__: + mapped_names.add(name) + + mapping = KeywordMapping(mapped_names) + if " " not in keywordexpr: + # special case to allow for simple "-k pass" and "-k 1.3" + return mapping[keywordexpr] + elif keywordexpr.startswith("not ") and " " not in keywordexpr[4:]: + return not mapping[keywordexpr[4:]] + return eval(keywordexpr, {}, mapping) + + +def pytest_configure(config): + import pytest + if config.option.strict: + pytest.mark._config = config + + +class MarkGenerator: + """ Factory for :class:`MarkDecorator` objects - exposed as + a ``pytest.mark`` singleton instance. Example:: + + import pytest + @pytest.mark.slowtest + def test_function(): + pass + + will set a 'slowtest' :class:`MarkInfo` object + on the ``test_function`` object. """ + + def __getattr__(self, name): + if name[0] == "_": + raise AttributeError("Marker name must NOT start with underscore") + if hasattr(self, '_config'): + self._check(name) + return MarkDecorator(name) + + def _check(self, name): + try: + if name in self._markers: + return + except AttributeError: + pass + self._markers = l = set() + for line in self._config.getini("markers"): + beginning = line.split(":", 1) + x = beginning[0].split("(", 1)[0] + l.add(x) + if name not in self._markers: + raise AttributeError("%r not a registered marker" % (name,)) + +def istestfunc(func): + return hasattr(func, "__call__") and \ + getattr(func, "__name__", "<lambda>") != "<lambda>" + +class MarkDecorator: + """ A decorator for test functions and test classes. When applied + it will create :class:`MarkInfo` objects which may be + :ref:`retrieved by hooks as item keywords <excontrolskip>`. + MarkDecorator instances are often created like this:: + + mark1 = pytest.mark.NAME # simple MarkDecorator + mark2 = pytest.mark.NAME(name1=value) # parametrized MarkDecorator + + and can then be applied as decorators to test functions:: + + @mark2 + def test_function(): + pass + + When a MarkDecorator instance is called it does the following: + 1. If called with a single class as its only positional argument and no + additional keyword arguments, it attaches itself to the class so it + gets applied automatically to all test cases found in that class. + 2. If called with a single function as its only positional argument and + no additional keyword arguments, it attaches a MarkInfo object to the + function, containing all the arguments already stored internally in + the MarkDecorator. + 3. When called in any other case, it performs a 'fake construction' call, + i.e. it returns a new MarkDecorator instance with the original + MarkDecorator's content updated with the arguments passed to this + call. + + Note: The rules above prevent MarkDecorator objects from storing only a + single function or class reference as their positional argument with no + additional keyword or positional arguments. + + """ + def __init__(self, name, args=None, kwargs=None): + self.name = name + self.args = args or () + self.kwargs = kwargs or {} + + @property + def markname(self): + return self.name # for backward-compat (2.4.1 had this attr) + + def __repr__(self): + d = self.__dict__.copy() + name = d.pop('name') + return "<MarkDecorator %r %r>" % (name, d) + + def __call__(self, *args, **kwargs): + """ if passed a single callable argument: decorate it with mark info. + otherwise add *args/**kwargs in-place to mark information. """ + if args and not kwargs: + func = args[0] + is_class = inspect.isclass(func) + if len(args) == 1 and (istestfunc(func) or is_class): + if is_class: + if hasattr(func, 'pytestmark'): + mark_list = func.pytestmark + if not isinstance(mark_list, list): + mark_list = [mark_list] + # always work on a copy to avoid updating pytestmark + # from a superclass by accident + mark_list = mark_list + [self] + func.pytestmark = mark_list + else: + func.pytestmark = [self] + else: + holder = getattr(func, self.name, None) + if holder is None: + holder = MarkInfo( + self.name, self.args, self.kwargs + ) + setattr(func, self.name, holder) + else: + holder.add(self.args, self.kwargs) + return func + kw = self.kwargs.copy() + kw.update(kwargs) + args = self.args + args + return self.__class__(self.name, args=args, kwargs=kw) + + +class MarkInfo: + """ Marking object created by :class:`MarkDecorator` instances. """ + def __init__(self, name, args, kwargs): + #: name of attribute + self.name = name + #: positional argument list, empty if none specified + self.args = args + #: keyword argument dictionary, empty if nothing specified + self.kwargs = kwargs.copy() + self._arglist = [(args, kwargs.copy())] + + def __repr__(self): + return "<MarkInfo %r args=%r kwargs=%r>" % ( + self.name, self.args, self.kwargs + ) + + def add(self, args, kwargs): + """ add a MarkInfo with the given args and kwargs. """ + self._arglist.append((args, kwargs)) + self.args += args + self.kwargs.update(kwargs) + + def __iter__(self): + """ yield MarkInfo objects each relating to a marking-call. """ + for args, kwargs in self._arglist: + yield MarkInfo(self.name, args, kwargs) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/monkeypatch.py b/testing/web-platform/tests/tools/pytest/_pytest/monkeypatch.py new file mode 100644 index 000000000..d4c169d37 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/monkeypatch.py @@ -0,0 +1,254 @@ +""" monkeypatching and mocking functionality. """ + +import os, sys +import re + +from py.builtin import _basestring + +RE_IMPORT_ERROR_NAME = re.compile("^No module named (.*)$") + + +def pytest_funcarg__monkeypatch(request): + """The returned ``monkeypatch`` funcarg provides these + helper methods to modify objects, dictionaries or os.environ:: + + monkeypatch.setattr(obj, name, value, raising=True) + monkeypatch.delattr(obj, name, raising=True) + monkeypatch.setitem(mapping, name, value) + monkeypatch.delitem(obj, name, raising=True) + monkeypatch.setenv(name, value, prepend=False) + monkeypatch.delenv(name, value, raising=True) + monkeypatch.syspath_prepend(path) + monkeypatch.chdir(path) + + All modifications will be undone after the requesting + test function has finished. The ``raising`` + parameter determines if a KeyError or AttributeError + will be raised if the set/deletion operation has no target. + """ + mpatch = monkeypatch() + request.addfinalizer(mpatch.undo) + return mpatch + + +def resolve(name): + # simplified from zope.dottedname + parts = name.split('.') + + used = parts.pop(0) + found = __import__(used) + for part in parts: + used += '.' + part + try: + found = getattr(found, part) + except AttributeError: + pass + else: + continue + # we use explicit un-nesting of the handling block in order + # to avoid nested exceptions on python 3 + try: + __import__(used) + except ImportError as ex: + # str is used for py2 vs py3 + expected = str(ex).split()[-1] + if expected == used: + raise + else: + raise ImportError( + 'import error in %s: %s' % (used, ex) + ) + found = annotated_getattr(found, part, used) + return found + + +def annotated_getattr(obj, name, ann): + try: + obj = getattr(obj, name) + except AttributeError: + raise AttributeError( + '%r object at %s has no attribute %r' % ( + type(obj).__name__, ann, name + ) + ) + return obj + + +def derive_importpath(import_path, raising): + if not isinstance(import_path, _basestring) or "." not in import_path: + raise TypeError("must be absolute import path string, not %r" % + (import_path,)) + module, attr = import_path.rsplit('.', 1) + target = resolve(module) + if raising: + annotated_getattr(target, attr, ann=module) + return attr, target + + +class Notset: + def __repr__(self): + return "<notset>" + + +notset = Notset() + + +class monkeypatch: + """ Object keeping a record of setattr/item/env/syspath changes. """ + + def __init__(self): + self._setattr = [] + self._setitem = [] + self._cwd = None + self._savesyspath = None + + def setattr(self, target, name, value=notset, raising=True): + """ Set attribute value on target, memorizing the old value. + By default raise AttributeError if the attribute did not exist. + + For convenience you can specify a string as ``target`` which + will be interpreted as a dotted import path, with the last part + being the attribute name. Example: + ``monkeypatch.setattr("os.getcwd", lambda x: "/")`` + would set the ``getcwd`` function of the ``os`` module. + + The ``raising`` value determines if the setattr should fail + if the attribute is not already present (defaults to True + which means it will raise). + """ + __tracebackhide__ = True + import inspect + + if value is notset: + if not isinstance(target, _basestring): + raise TypeError("use setattr(target, name, value) or " + "setattr(target, value) with target being a dotted " + "import string") + value = name + name, target = derive_importpath(target, raising) + + oldval = getattr(target, name, notset) + if raising and oldval is notset: + raise AttributeError("%r has no attribute %r" % (target, name)) + + # avoid class descriptors like staticmethod/classmethod + if inspect.isclass(target): + oldval = target.__dict__.get(name, notset) + self._setattr.append((target, name, oldval)) + setattr(target, name, value) + + def delattr(self, target, name=notset, raising=True): + """ Delete attribute ``name`` from ``target``, by default raise + AttributeError it the attribute did not previously exist. + + If no ``name`` is specified and ``target`` is a string + it will be interpreted as a dotted import path with the + last part being the attribute name. + + If ``raising`` is set to False, no exception will be raised if the + attribute is missing. + """ + __tracebackhide__ = True + if name is notset: + if not isinstance(target, _basestring): + raise TypeError("use delattr(target, name) or " + "delattr(target) with target being a dotted " + "import string") + name, target = derive_importpath(target, raising) + + if not hasattr(target, name): + if raising: + raise AttributeError(name) + else: + self._setattr.append((target, name, getattr(target, name, notset))) + delattr(target, name) + + def setitem(self, dic, name, value): + """ Set dictionary entry ``name`` to value. """ + self._setitem.append((dic, name, dic.get(name, notset))) + dic[name] = value + + def delitem(self, dic, name, raising=True): + """ Delete ``name`` from dict. Raise KeyError if it doesn't exist. + + If ``raising`` is set to False, no exception will be raised if the + key is missing. + """ + if name not in dic: + if raising: + raise KeyError(name) + else: + self._setitem.append((dic, name, dic.get(name, notset))) + del dic[name] + + def setenv(self, name, value, prepend=None): + """ Set environment variable ``name`` to ``value``. If ``prepend`` + is a character, read the current environment variable value + and prepend the ``value`` adjoined with the ``prepend`` character.""" + value = str(value) + if prepend and name in os.environ: + value = value + prepend + os.environ[name] + self.setitem(os.environ, name, value) + + def delenv(self, name, raising=True): + """ Delete ``name`` from the environment. Raise KeyError it does not + exist. + + If ``raising`` is set to False, no exception will be raised if the + environment variable is missing. + """ + self.delitem(os.environ, name, raising=raising) + + def syspath_prepend(self, path): + """ Prepend ``path`` to ``sys.path`` list of import locations. """ + if self._savesyspath is None: + self._savesyspath = sys.path[:] + sys.path.insert(0, str(path)) + + def chdir(self, path): + """ Change the current working directory to the specified path. + Path can be a string or a py.path.local object. + """ + if self._cwd is None: + self._cwd = os.getcwd() + if hasattr(path, "chdir"): + path.chdir() + else: + os.chdir(path) + + def undo(self): + """ Undo previous changes. This call consumes the + undo stack. Calling it a second time has no effect unless + you do more monkeypatching after the undo call. + + There is generally no need to call `undo()`, since it is + called automatically during tear-down. + + Note that the same `monkeypatch` fixture is used across a + single test function invocation. If `monkeypatch` is used both by + the test function itself and one of the test fixtures, + calling `undo()` will undo all of the changes made in + both functions. + """ + for obj, name, value in reversed(self._setattr): + if value is not notset: + setattr(obj, name, value) + else: + delattr(obj, name) + self._setattr[:] = [] + for dictionary, name, value in reversed(self._setitem): + if value is notset: + try: + del dictionary[name] + except KeyError: + pass # was already deleted, so we have the desired state + else: + dictionary[name] = value + self._setitem[:] = [] + if self._savesyspath is not None: + sys.path[:] = self._savesyspath + self._savesyspath = None + + if self._cwd is not None: + os.chdir(self._cwd) + self._cwd = None diff --git a/testing/web-platform/tests/tools/pytest/_pytest/nose.py b/testing/web-platform/tests/tools/pytest/_pytest/nose.py new file mode 100644 index 000000000..038746868 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/nose.py @@ -0,0 +1,71 @@ +""" run test suites written for nose. """ + +import sys + +import py +import pytest +from _pytest import unittest + + +def get_skip_exceptions(): + skip_classes = set() + for module_name in ('unittest', 'unittest2', 'nose'): + mod = sys.modules.get(module_name) + if hasattr(mod, 'SkipTest'): + skip_classes.add(mod.SkipTest) + return tuple(skip_classes) + + +def pytest_runtest_makereport(item, call): + if call.excinfo and call.excinfo.errisinstance(get_skip_exceptions()): + # let's substitute the excinfo with a pytest.skip one + call2 = call.__class__(lambda: + pytest.skip(str(call.excinfo.value)), call.when) + call.excinfo = call2.excinfo + + +@pytest.hookimpl(trylast=True) +def pytest_runtest_setup(item): + if is_potential_nosetest(item): + if isinstance(item.parent, pytest.Generator): + gen = item.parent + if not hasattr(gen, '_nosegensetup'): + call_optional(gen.obj, 'setup') + if isinstance(gen.parent, pytest.Instance): + call_optional(gen.parent.obj, 'setup') + gen._nosegensetup = True + if not call_optional(item.obj, 'setup'): + # call module level setup if there is no object level one + call_optional(item.parent.obj, 'setup') + #XXX this implies we only call teardown when setup worked + item.session._setupstate.addfinalizer((lambda: teardown_nose(item)), item) + +def teardown_nose(item): + if is_potential_nosetest(item): + if not call_optional(item.obj, 'teardown'): + call_optional(item.parent.obj, 'teardown') + #if hasattr(item.parent, '_nosegensetup'): + # #call_optional(item._nosegensetup, 'teardown') + # del item.parent._nosegensetup + + +def pytest_make_collect_report(collector): + if isinstance(collector, pytest.Generator): + call_optional(collector.obj, 'setup') + + +def is_potential_nosetest(item): + # extra check needed since we do not do nose style setup/teardown + # on direct unittest style classes + return isinstance(item, pytest.Function) and \ + not isinstance(item, unittest.TestCaseFunction) + + +def call_optional(obj, name): + method = getattr(obj, name, None) + isfixture = hasattr(method, "_pytestfixturefunction") + if method is not None and not isfixture and py.builtin.callable(method): + # If there's any problems allow the exception to raise rather than + # silently ignoring them + method() + return True diff --git a/testing/web-platform/tests/tools/pytest/_pytest/pastebin.py b/testing/web-platform/tests/tools/pytest/_pytest/pastebin.py new file mode 100644 index 000000000..4ec62d022 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/pastebin.py @@ -0,0 +1,92 @@ +""" submit failure or test session information to a pastebin service. """ +import pytest +import sys +import tempfile + + +def pytest_addoption(parser): + group = parser.getgroup("terminal reporting") + group._addoption('--pastebin', metavar="mode", + action='store', dest="pastebin", default=None, + choices=['failed', 'all'], + help="send failed|all info to bpaste.net pastebin service.") + +@pytest.hookimpl(trylast=True) +def pytest_configure(config): + import py + if config.option.pastebin == "all": + tr = config.pluginmanager.getplugin('terminalreporter') + # if no terminal reporter plugin is present, nothing we can do here; + # this can happen when this function executes in a slave node + # when using pytest-xdist, for example + if tr is not None: + # pastebin file will be utf-8 encoded binary file + config._pastebinfile = tempfile.TemporaryFile('w+b') + oldwrite = tr._tw.write + def tee_write(s, **kwargs): + oldwrite(s, **kwargs) + if py.builtin._istext(s): + s = s.encode('utf-8') + config._pastebinfile.write(s) + tr._tw.write = tee_write + +def pytest_unconfigure(config): + if hasattr(config, '_pastebinfile'): + # get terminal contents and delete file + config._pastebinfile.seek(0) + sessionlog = config._pastebinfile.read() + config._pastebinfile.close() + del config._pastebinfile + # undo our patching in the terminal reporter + tr = config.pluginmanager.getplugin('terminalreporter') + del tr._tw.__dict__['write'] + # write summary + tr.write_sep("=", "Sending information to Paste Service") + pastebinurl = create_new_paste(sessionlog) + tr.write_line("pastebin session-log: %s\n" % pastebinurl) + +def create_new_paste(contents): + """ + Creates a new paste using bpaste.net service. + + :contents: paste contents as utf-8 encoded bytes + :returns: url to the pasted contents + """ + import re + if sys.version_info < (3, 0): + from urllib import urlopen, urlencode + else: + from urllib.request import urlopen + from urllib.parse import urlencode + + params = { + 'code': contents, + 'lexer': 'python3' if sys.version_info[0] == 3 else 'python', + 'expiry': '1week', + } + url = 'https://bpaste.net' + response = urlopen(url, data=urlencode(params).encode('ascii')).read() + m = re.search(r'href="/raw/(\w+)"', response.decode('utf-8')) + if m: + return '%s/show/%s' % (url, m.group(1)) + else: + return 'bad response: ' + response + +def pytest_terminal_summary(terminalreporter): + import _pytest.config + if terminalreporter.config.option.pastebin != "failed": + return + tr = terminalreporter + if 'failed' in tr.stats: + terminalreporter.write_sep("=", "Sending information to Paste Service") + for rep in terminalreporter.stats.get('failed'): + try: + msg = rep.longrepr.reprtraceback.reprentries[-1].reprfileloc + except AttributeError: + msg = tr._getfailureheadline(rep) + tw = _pytest.config.create_terminal_writer(terminalreporter.config, stringio=True) + rep.toterminal(tw) + s = tw.stringio.getvalue() + assert len(s) + pastebinurl = create_new_paste(s) + tr.write_line("%s --> %s" %(msg, pastebinurl)) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/pdb.py b/testing/web-platform/tests/tools/pytest/_pytest/pdb.py new file mode 100644 index 000000000..84c920d17 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/pdb.py @@ -0,0 +1,109 @@ +""" interactive debugging with PDB, the Python Debugger. """ +from __future__ import absolute_import +import pdb +import sys + +import pytest + + +def pytest_addoption(parser): + group = parser.getgroup("general") + group._addoption('--pdb', + action="store_true", dest="usepdb", default=False, + help="start the interactive Python debugger on errors.") + +def pytest_namespace(): + return {'set_trace': pytestPDB().set_trace} + +def pytest_configure(config): + if config.getvalue("usepdb"): + config.pluginmanager.register(PdbInvoke(), 'pdbinvoke') + + old = (pdb.set_trace, pytestPDB._pluginmanager) + def fin(): + pdb.set_trace, pytestPDB._pluginmanager = old + pytestPDB._config = None + pdb.set_trace = pytest.set_trace + pytestPDB._pluginmanager = config.pluginmanager + pytestPDB._config = config + config._cleanup.append(fin) + +class pytestPDB: + """ Pseudo PDB that defers to the real pdb. """ + _pluginmanager = None + _config = None + + def set_trace(self): + """ invoke PDB set_trace debugging, dropping any IO capturing. """ + import _pytest.config + frame = sys._getframe().f_back + if self._pluginmanager is not None: + capman = self._pluginmanager.getplugin("capturemanager") + if capman: + capman.suspendcapture(in_=True) + tw = _pytest.config.create_terminal_writer(self._config) + tw.line() + tw.sep(">", "PDB set_trace (IO-capturing turned off)") + self._pluginmanager.hook.pytest_enter_pdb(config=self._config) + pdb.Pdb().set_trace(frame) + + +class PdbInvoke: + def pytest_exception_interact(self, node, call, report): + capman = node.config.pluginmanager.getplugin("capturemanager") + if capman: + out, err = capman.suspendcapture(in_=True) + sys.stdout.write(out) + sys.stdout.write(err) + _enter_pdb(node, call.excinfo, report) + + def pytest_internalerror(self, excrepr, excinfo): + for line in str(excrepr).split("\n"): + sys.stderr.write("INTERNALERROR> %s\n" %line) + sys.stderr.flush() + tb = _postmortem_traceback(excinfo) + post_mortem(tb) + + +def _enter_pdb(node, excinfo, rep): + # XXX we re-use the TerminalReporter's terminalwriter + # because this seems to avoid some encoding related troubles + # for not completely clear reasons. + tw = node.config.pluginmanager.getplugin("terminalreporter")._tw + tw.line() + tw.sep(">", "traceback") + rep.toterminal(tw) + tw.sep(">", "entering PDB") + tb = _postmortem_traceback(excinfo) + post_mortem(tb) + rep._pdbshown = True + return rep + + +def _postmortem_traceback(excinfo): + # A doctest.UnexpectedException is not useful for post_mortem. + # Use the underlying exception instead: + from doctest import UnexpectedException + if isinstance(excinfo.value, UnexpectedException): + return excinfo.value.exc_info[2] + else: + return excinfo._excinfo[2] + + +def _find_last_non_hidden_frame(stack): + i = max(0, len(stack) - 1) + while i and stack[i][0].f_locals.get("__tracebackhide__", False): + i -= 1 + return i + + +def post_mortem(t): + class Pdb(pdb.Pdb): + def get_stack(self, f, t): + stack, i = pdb.Pdb.get_stack(self, f, t) + if f is None: + i = _find_last_non_hidden_frame(stack) + return stack, i + p = Pdb() + p.reset() + p.interaction(None, t) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/pytester.py b/testing/web-platform/tests/tools/pytest/_pytest/pytester.py new file mode 100644 index 000000000..faed7f581 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/pytester.py @@ -0,0 +1,1110 @@ +""" (disabled by default) support for testing pytest and pytest plugins. """ +import codecs +import gc +import os +import platform +import re +import subprocess +import sys +import time +import traceback +from fnmatch import fnmatch + +from py.builtin import print_ + +from _pytest._code import Source +import py +import pytest +from _pytest.main import Session, EXIT_OK + + +def pytest_addoption(parser): + # group = parser.getgroup("pytester", "pytester (self-tests) options") + parser.addoption('--lsof', + action="store_true", dest="lsof", default=False, + help=("run FD checks if lsof is available")) + + parser.addoption('--runpytest', default="inprocess", dest="runpytest", + choices=("inprocess", "subprocess", ), + help=("run pytest sub runs in tests using an 'inprocess' " + "or 'subprocess' (python -m main) method")) + + +def pytest_configure(config): + # This might be called multiple times. Only take the first. + global _pytest_fullpath + try: + _pytest_fullpath + except NameError: + _pytest_fullpath = os.path.abspath(pytest.__file__.rstrip("oc")) + _pytest_fullpath = _pytest_fullpath.replace("$py.class", ".py") + + if config.getvalue("lsof"): + checker = LsofFdLeakChecker() + if checker.matching_platform(): + config.pluginmanager.register(checker) + + +class LsofFdLeakChecker(object): + def get_open_files(self): + out = self._exec_lsof() + open_files = self._parse_lsof_output(out) + return open_files + + def _exec_lsof(self): + pid = os.getpid() + return py.process.cmdexec("lsof -Ffn0 -p %d" % pid) + + def _parse_lsof_output(self, out): + def isopen(line): + return line.startswith('f') and ("deleted" not in line and + 'mem' not in line and "txt" not in line and 'cwd' not in line) + + open_files = [] + + for line in out.split("\n"): + if isopen(line): + fields = line.split('\0') + fd = fields[0][1:] + filename = fields[1][1:] + if filename.startswith('/'): + open_files.append((fd, filename)) + + return open_files + + def matching_platform(self): + try: + py.process.cmdexec("lsof -v") + except (py.process.cmdexec.Error, UnicodeDecodeError): + # cmdexec may raise UnicodeDecodeError on Windows systems + # with locale other than english: + # https://bitbucket.org/pytest-dev/py/issues/66 + return False + else: + return True + + @pytest.hookimpl(hookwrapper=True, tryfirst=True) + def pytest_runtest_item(self, item): + lines1 = self.get_open_files() + yield + if hasattr(sys, "pypy_version_info"): + gc.collect() + lines2 = self.get_open_files() + + new_fds = set([t[0] for t in lines2]) - set([t[0] for t in lines1]) + leaked_files = [t for t in lines2 if t[0] in new_fds] + if leaked_files: + error = [] + error.append("***** %s FD leakage detected" % len(leaked_files)) + error.extend([str(f) for f in leaked_files]) + error.append("*** Before:") + error.extend([str(f) for f in lines1]) + error.append("*** After:") + error.extend([str(f) for f in lines2]) + error.append(error[0]) + error.append("*** function %s:%s: %s " % item.location) + pytest.fail("\n".join(error), pytrace=False) + + +# XXX copied from execnet's conftest.py - needs to be merged +winpymap = { + 'python2.7': r'C:\Python27\python.exe', + 'python2.6': r'C:\Python26\python.exe', + 'python3.1': r'C:\Python31\python.exe', + 'python3.2': r'C:\Python32\python.exe', + 'python3.3': r'C:\Python33\python.exe', + 'python3.4': r'C:\Python34\python.exe', + 'python3.5': r'C:\Python35\python.exe', +} + +def getexecutable(name, cache={}): + try: + return cache[name] + except KeyError: + executable = py.path.local.sysfind(name) + if executable: + if name == "jython": + import subprocess + popen = subprocess.Popen([str(executable), "--version"], + universal_newlines=True, stderr=subprocess.PIPE) + out, err = popen.communicate() + if not err or "2.5" not in err: + executable = None + if "2.5.2" in err: + executable = None # http://bugs.jython.org/issue1790 + cache[name] = executable + return executable + +@pytest.fixture(params=['python2.6', 'python2.7', 'python3.3', "python3.4", + 'pypy', 'pypy3']) +def anypython(request): + name = request.param + executable = getexecutable(name) + if executable is None: + if sys.platform == "win32": + executable = winpymap.get(name, None) + if executable: + executable = py.path.local(executable) + if executable.check(): + return executable + pytest.skip("no suitable %s found" % (name,)) + return executable + +# used at least by pytest-xdist plugin +@pytest.fixture +def _pytest(request): + """ Return a helper which offers a gethookrecorder(hook) + method which returns a HookRecorder instance which helps + to make assertions about called hooks. + """ + return PytestArg(request) + +class PytestArg: + def __init__(self, request): + self.request = request + + def gethookrecorder(self, hook): + hookrecorder = HookRecorder(hook._pm) + self.request.addfinalizer(hookrecorder.finish_recording) + return hookrecorder + + +def get_public_names(l): + """Only return names from iterator l without a leading underscore.""" + return [x for x in l if x[0] != "_"] + + +class ParsedCall: + def __init__(self, name, kwargs): + self.__dict__.update(kwargs) + self._name = name + + def __repr__(self): + d = self.__dict__.copy() + del d['_name'] + return "<ParsedCall %r(**%r)>" %(self._name, d) + + +class HookRecorder: + """Record all hooks called in a plugin manager. + + This wraps all the hook calls in the plugin manager, recording + each call before propagating the normal calls. + + """ + + def __init__(self, pluginmanager): + self._pluginmanager = pluginmanager + self.calls = [] + + def before(hook_name, hook_impls, kwargs): + self.calls.append(ParsedCall(hook_name, kwargs)) + + def after(outcome, hook_name, hook_impls, kwargs): + pass + + self._undo_wrapping = pluginmanager.add_hookcall_monitoring(before, after) + + def finish_recording(self): + self._undo_wrapping() + + def getcalls(self, names): + if isinstance(names, str): + names = names.split() + return [call for call in self.calls if call._name in names] + + def assert_contains(self, entries): + __tracebackhide__ = True + i = 0 + entries = list(entries) + backlocals = sys._getframe(1).f_locals + while entries: + name, check = entries.pop(0) + for ind, call in enumerate(self.calls[i:]): + if call._name == name: + print_("NAMEMATCH", name, call) + if eval(check, backlocals, call.__dict__): + print_("CHECKERMATCH", repr(check), "->", call) + else: + print_("NOCHECKERMATCH", repr(check), "-", call) + continue + i += ind + 1 + break + print_("NONAMEMATCH", name, "with", call) + else: + pytest.fail("could not find %r check %r" % (name, check)) + + def popcall(self, name): + __tracebackhide__ = True + for i, call in enumerate(self.calls): + if call._name == name: + del self.calls[i] + return call + lines = ["could not find call %r, in:" % (name,)] + lines.extend([" %s" % str(x) for x in self.calls]) + pytest.fail("\n".join(lines)) + + def getcall(self, name): + l = self.getcalls(name) + assert len(l) == 1, (name, l) + return l[0] + + # functionality for test reports + + def getreports(self, + names="pytest_runtest_logreport pytest_collectreport"): + return [x.report for x in self.getcalls(names)] + + def matchreport(self, inamepart="", + names="pytest_runtest_logreport pytest_collectreport", when=None): + """ return a testreport whose dotted import path matches """ + l = [] + for rep in self.getreports(names=names): + try: + if not when and rep.when != "call" and rep.passed: + # setup/teardown passing reports - let's ignore those + continue + except AttributeError: + pass + if when and getattr(rep, 'when', None) != when: + continue + if not inamepart or inamepart in rep.nodeid.split("::"): + l.append(rep) + if not l: + raise ValueError("could not find test report matching %r: " + "no test reports at all!" % (inamepart,)) + if len(l) > 1: + raise ValueError( + "found 2 or more testreports matching %r: %s" %(inamepart, l)) + return l[0] + + def getfailures(self, + names='pytest_runtest_logreport pytest_collectreport'): + return [rep for rep in self.getreports(names) if rep.failed] + + def getfailedcollections(self): + return self.getfailures('pytest_collectreport') + + def listoutcomes(self): + passed = [] + skipped = [] + failed = [] + for rep in self.getreports( + "pytest_collectreport pytest_runtest_logreport"): + if rep.passed: + if getattr(rep, "when", None) == "call": + passed.append(rep) + elif rep.skipped: + skipped.append(rep) + elif rep.failed: + failed.append(rep) + return passed, skipped, failed + + def countoutcomes(self): + return [len(x) for x in self.listoutcomes()] + + def assertoutcome(self, passed=0, skipped=0, failed=0): + realpassed, realskipped, realfailed = self.listoutcomes() + assert passed == len(realpassed) + assert skipped == len(realskipped) + assert failed == len(realfailed) + + def clear(self): + self.calls[:] = [] + + +@pytest.fixture +def linecomp(request): + return LineComp() + + +def pytest_funcarg__LineMatcher(request): + return LineMatcher + + +@pytest.fixture +def testdir(request, tmpdir_factory): + return Testdir(request, tmpdir_factory) + + +rex_outcome = re.compile("(\d+) ([\w-]+)") +class RunResult: + """The result of running a command. + + Attributes: + + :ret: The return value. + :outlines: List of lines captured from stdout. + :errlines: List of lines captures from stderr. + :stdout: :py:class:`LineMatcher` of stdout, use ``stdout.str()`` to + reconstruct stdout or the commonly used + ``stdout.fnmatch_lines()`` method. + :stderrr: :py:class:`LineMatcher` of stderr. + :duration: Duration in seconds. + + """ + def __init__(self, ret, outlines, errlines, duration): + self.ret = ret + self.outlines = outlines + self.errlines = errlines + self.stdout = LineMatcher(outlines) + self.stderr = LineMatcher(errlines) + self.duration = duration + + def parseoutcomes(self): + """ Return a dictionary of outcomestring->num from parsing + the terminal output that the test process produced.""" + for line in reversed(self.outlines): + if 'seconds' in line: + outcomes = rex_outcome.findall(line) + if outcomes: + d = {} + for num, cat in outcomes: + d[cat] = int(num) + return d + + def assert_outcomes(self, passed=0, skipped=0, failed=0): + """ assert that the specified outcomes appear with the respective + numbers (0 means it didn't occur) in the text output from a test run.""" + d = self.parseoutcomes() + assert passed == d.get("passed", 0) + assert skipped == d.get("skipped", 0) + assert failed == d.get("failed", 0) + + + +class Testdir: + """Temporary test directory with tools to test/run py.test itself. + + This is based on the ``tmpdir`` fixture but provides a number of + methods which aid with testing py.test itself. Unless + :py:meth:`chdir` is used all methods will use :py:attr:`tmpdir` as + current working directory. + + Attributes: + + :tmpdir: The :py:class:`py.path.local` instance of the temporary + directory. + + :plugins: A list of plugins to use with :py:meth:`parseconfig` and + :py:meth:`runpytest`. Initially this is an empty list but + plugins can be added to the list. The type of items to add to + the list depend on the method which uses them so refer to them + for details. + + """ + + def __init__(self, request, tmpdir_factory): + self.request = request + # XXX remove duplication with tmpdir plugin + basetmp = tmpdir_factory.ensuretemp("testdir") + name = request.function.__name__ + for i in range(100): + try: + tmpdir = basetmp.mkdir(name + str(i)) + except py.error.EEXIST: + continue + break + self.tmpdir = tmpdir + self.plugins = [] + self._savesyspath = (list(sys.path), list(sys.meta_path)) + self._savemodulekeys = set(sys.modules) + self.chdir() # always chdir + self.request.addfinalizer(self.finalize) + method = self.request.config.getoption("--runpytest") + if method == "inprocess": + self._runpytest_method = self.runpytest_inprocess + elif method == "subprocess": + self._runpytest_method = self.runpytest_subprocess + + def __repr__(self): + return "<Testdir %r>" % (self.tmpdir,) + + def finalize(self): + """Clean up global state artifacts. + + Some methods modify the global interpreter state and this + tries to clean this up. It does not remove the temporary + directory however so it can be looked at after the test run + has finished. + + """ + sys.path[:], sys.meta_path[:] = self._savesyspath + if hasattr(self, '_olddir'): + self._olddir.chdir() + self.delete_loaded_modules() + + def delete_loaded_modules(self): + """Delete modules that have been loaded during a test. + + This allows the interpreter to catch module changes in case + the module is re-imported. + """ + for name in set(sys.modules).difference(self._savemodulekeys): + # it seems zope.interfaces is keeping some state + # (used by twisted related tests) + if name != "zope.interface": + del sys.modules[name] + + def make_hook_recorder(self, pluginmanager): + """Create a new :py:class:`HookRecorder` for a PluginManager.""" + assert not hasattr(pluginmanager, "reprec") + pluginmanager.reprec = reprec = HookRecorder(pluginmanager) + self.request.addfinalizer(reprec.finish_recording) + return reprec + + def chdir(self): + """Cd into the temporary directory. + + This is done automatically upon instantiation. + + """ + old = self.tmpdir.chdir() + if not hasattr(self, '_olddir'): + self._olddir = old + + def _makefile(self, ext, args, kwargs): + items = list(kwargs.items()) + if args: + source = py.builtin._totext("\n").join( + map(py.builtin._totext, args)) + py.builtin._totext("\n") + basename = self.request.function.__name__ + items.insert(0, (basename, source)) + ret = None + for name, value in items: + p = self.tmpdir.join(name).new(ext=ext) + source = Source(value) + def my_totext(s, encoding="utf-8"): + if py.builtin._isbytes(s): + s = py.builtin._totext(s, encoding=encoding) + return s + source_unicode = "\n".join([my_totext(line) for line in source.lines]) + source = py.builtin._totext(source_unicode) + content = source.strip().encode("utf-8") # + "\n" + #content = content.rstrip() + "\n" + p.write(content, "wb") + if ret is None: + ret = p + return ret + + def makefile(self, ext, *args, **kwargs): + """Create a new file in the testdir. + + ext: The extension the file should use, including the dot. + E.g. ".py". + + args: All args will be treated as strings and joined using + newlines. The result will be written as contents to the + file. The name of the file will be based on the test + function requesting this fixture. + E.g. "testdir.makefile('.txt', 'line1', 'line2')" + + kwargs: Each keyword is the name of a file, while the value of + it will be written as contents of the file. + E.g. "testdir.makefile('.ini', pytest='[pytest]\naddopts=-rs\n')" + + """ + return self._makefile(ext, args, kwargs) + + def makeconftest(self, source): + """Write a contest.py file with 'source' as contents.""" + return self.makepyfile(conftest=source) + + def makeini(self, source): + """Write a tox.ini file with 'source' as contents.""" + return self.makefile('.ini', tox=source) + + def getinicfg(self, source): + """Return the pytest section from the tox.ini config file.""" + p = self.makeini(source) + return py.iniconfig.IniConfig(p)['pytest'] + + def makepyfile(self, *args, **kwargs): + """Shortcut for .makefile() with a .py extension.""" + return self._makefile('.py', args, kwargs) + + def maketxtfile(self, *args, **kwargs): + """Shortcut for .makefile() with a .txt extension.""" + return self._makefile('.txt', args, kwargs) + + def syspathinsert(self, path=None): + """Prepend a directory to sys.path, defaults to :py:attr:`tmpdir`. + + This is undone automatically after the test. + """ + if path is None: + path = self.tmpdir + sys.path.insert(0, str(path)) + # a call to syspathinsert() usually means that the caller + # wants to import some dynamically created files. + # with python3 we thus invalidate import caches. + self._possibly_invalidate_import_caches() + + def _possibly_invalidate_import_caches(self): + # invalidate caches if we can (py33 and above) + try: + import importlib + except ImportError: + pass + else: + if hasattr(importlib, "invalidate_caches"): + importlib.invalidate_caches() + + def mkdir(self, name): + """Create a new (sub)directory.""" + return self.tmpdir.mkdir(name) + + def mkpydir(self, name): + """Create a new python package. + + This creates a (sub)direcotry with an empty ``__init__.py`` + file so that is recognised as a python package. + + """ + p = self.mkdir(name) + p.ensure("__init__.py") + return p + + Session = Session + def getnode(self, config, arg): + """Return the collection node of a file. + + :param config: :py:class:`_pytest.config.Config` instance, see + :py:meth:`parseconfig` and :py:meth:`parseconfigure` to + create the configuration. + + :param arg: A :py:class:`py.path.local` instance of the file. + + """ + session = Session(config) + assert '::' not in str(arg) + p = py.path.local(arg) + config.hook.pytest_sessionstart(session=session) + res = session.perform_collect([str(p)], genitems=False)[0] + config.hook.pytest_sessionfinish(session=session, exitstatus=EXIT_OK) + return res + + def getpathnode(self, path): + """Return the collection node of a file. + + This is like :py:meth:`getnode` but uses + :py:meth:`parseconfigure` to create the (configured) py.test + Config instance. + + :param path: A :py:class:`py.path.local` instance of the file. + + """ + config = self.parseconfigure(path) + session = Session(config) + x = session.fspath.bestrelpath(path) + config.hook.pytest_sessionstart(session=session) + res = session.perform_collect([x], genitems=False)[0] + config.hook.pytest_sessionfinish(session=session, exitstatus=EXIT_OK) + return res + + def genitems(self, colitems): + """Generate all test items from a collection node. + + This recurses into the collection node and returns a list of + all the test items contained within. + + """ + session = colitems[0].session + result = [] + for colitem in colitems: + result.extend(session.genitems(colitem)) + return result + + def runitem(self, source): + """Run the "test_func" Item. + + The calling test instance (the class which contains the test + method) must provide a ``.getrunner()`` method which should + return a runner which can run the test protocol for a single + item, like e.g. :py:func:`_pytest.runner.runtestprotocol`. + + """ + # used from runner functional tests + item = self.getitem(source) + # the test class where we are called from wants to provide the runner + testclassinstance = self.request.instance + runner = testclassinstance.getrunner() + return runner(item) + + def inline_runsource(self, source, *cmdlineargs): + """Run a test module in process using ``pytest.main()``. + + This run writes "source" into a temporary file and runs + ``pytest.main()`` on it, returning a :py:class:`HookRecorder` + instance for the result. + + :param source: The source code of the test module. + + :param cmdlineargs: Any extra command line arguments to use. + + :return: :py:class:`HookRecorder` instance of the result. + + """ + p = self.makepyfile(source) + l = list(cmdlineargs) + [p] + return self.inline_run(*l) + + def inline_genitems(self, *args): + """Run ``pytest.main(['--collectonly'])`` in-process. + + Retuns a tuple of the collected items and a + :py:class:`HookRecorder` instance. + + This runs the :py:func:`pytest.main` function to run all of + py.test inside the test process itself like + :py:meth:`inline_run`. However the return value is a tuple of + the collection items and a :py:class:`HookRecorder` instance. + + """ + rec = self.inline_run("--collect-only", *args) + items = [x.item for x in rec.getcalls("pytest_itemcollected")] + return items, rec + + def inline_run(self, *args, **kwargs): + """Run ``pytest.main()`` in-process, returning a HookRecorder. + + This runs the :py:func:`pytest.main` function to run all of + py.test inside the test process itself. This means it can + return a :py:class:`HookRecorder` instance which gives more + detailed results from then run then can be done by matching + stdout/stderr from :py:meth:`runpytest`. + + :param args: Any command line arguments to pass to + :py:func:`pytest.main`. + + :param plugin: (keyword-only) Extra plugin instances the + ``pytest.main()`` instance should use. + + :return: A :py:class:`HookRecorder` instance. + + """ + rec = [] + class Collect: + def pytest_configure(x, config): + rec.append(self.make_hook_recorder(config.pluginmanager)) + + plugins = kwargs.get("plugins") or [] + plugins.append(Collect()) + ret = pytest.main(list(args), plugins=plugins) + self.delete_loaded_modules() + if len(rec) == 1: + reprec = rec.pop() + else: + class reprec: + pass + reprec.ret = ret + + # typically we reraise keyboard interrupts from the child run + # because it's our user requesting interruption of the testing + if ret == 2 and not kwargs.get("no_reraise_ctrlc"): + calls = reprec.getcalls("pytest_keyboard_interrupt") + if calls and calls[-1].excinfo.type == KeyboardInterrupt: + raise KeyboardInterrupt() + return reprec + + def runpytest_inprocess(self, *args, **kwargs): + """ Return result of running pytest in-process, providing a similar + interface to what self.runpytest() provides. """ + if kwargs.get("syspathinsert"): + self.syspathinsert() + now = time.time() + capture = py.io.StdCapture() + try: + try: + reprec = self.inline_run(*args, **kwargs) + except SystemExit as e: + class reprec: + ret = e.args[0] + except Exception: + traceback.print_exc() + class reprec: + ret = 3 + finally: + out, err = capture.reset() + sys.stdout.write(out) + sys.stderr.write(err) + + res = RunResult(reprec.ret, + out.split("\n"), err.split("\n"), + time.time()-now) + res.reprec = reprec + return res + + def runpytest(self, *args, **kwargs): + """ Run pytest inline or in a subprocess, depending on the command line + option "--runpytest" and return a :py:class:`RunResult`. + + """ + args = self._ensure_basetemp(args) + return self._runpytest_method(*args, **kwargs) + + def _ensure_basetemp(self, args): + args = [str(x) for x in args] + for x in args: + if str(x).startswith('--basetemp'): + #print ("basedtemp exists: %s" %(args,)) + break + else: + args.append("--basetemp=%s" % self.tmpdir.dirpath('basetemp')) + #print ("added basetemp: %s" %(args,)) + return args + + def parseconfig(self, *args): + """Return a new py.test Config instance from given commandline args. + + This invokes the py.test bootstrapping code in _pytest.config + to create a new :py:class:`_pytest.core.PluginManager` and + call the pytest_cmdline_parse hook to create new + :py:class:`_pytest.config.Config` instance. + + If :py:attr:`plugins` has been populated they should be plugin + modules which will be registered with the PluginManager. + + """ + args = self._ensure_basetemp(args) + + import _pytest.config + config = _pytest.config._prepareconfig(args, self.plugins) + # we don't know what the test will do with this half-setup config + # object and thus we make sure it gets unconfigured properly in any + # case (otherwise capturing could still be active, for example) + self.request.addfinalizer(config._ensure_unconfigure) + return config + + def parseconfigure(self, *args): + """Return a new py.test configured Config instance. + + This returns a new :py:class:`_pytest.config.Config` instance + like :py:meth:`parseconfig`, but also calls the + pytest_configure hook. + + """ + config = self.parseconfig(*args) + config._do_configure() + self.request.addfinalizer(config._ensure_unconfigure) + return config + + def getitem(self, source, funcname="test_func"): + """Return the test item for a test function. + + This writes the source to a python file and runs py.test's + collection on the resulting module, returning the test item + for the requested function name. + + :param source: The module source. + + :param funcname: The name of the test function for which the + Item must be returned. + + """ + items = self.getitems(source) + for item in items: + if item.name == funcname: + return item + assert 0, "%r item not found in module:\n%s\nitems: %s" %( + funcname, source, items) + + def getitems(self, source): + """Return all test items collected from the module. + + This writes the source to a python file and runs py.test's + collection on the resulting module, returning all test items + contained within. + + """ + modcol = self.getmodulecol(source) + return self.genitems([modcol]) + + def getmodulecol(self, source, configargs=(), withinit=False): + """Return the module collection node for ``source``. + + This writes ``source`` to a file using :py:meth:`makepyfile` + and then runs the py.test collection on it, returning the + collection node for the test module. + + :param source: The source code of the module to collect. + + :param configargs: Any extra arguments to pass to + :py:meth:`parseconfigure`. + + :param withinit: Whether to also write a ``__init__.py`` file + to the temporarly directory to ensure it is a package. + + """ + kw = {self.request.function.__name__: Source(source).strip()} + path = self.makepyfile(**kw) + if withinit: + self.makepyfile(__init__ = "#") + self.config = config = self.parseconfigure(path, *configargs) + node = self.getnode(config, path) + return node + + def collect_by_name(self, modcol, name): + """Return the collection node for name from the module collection. + + This will search a module collection node for a collection + node matching the given name. + + :param modcol: A module collection node, see + :py:meth:`getmodulecol`. + + :param name: The name of the node to return. + + """ + for colitem in modcol._memocollect(): + if colitem.name == name: + return colitem + + def popen(self, cmdargs, stdout, stderr, **kw): + """Invoke subprocess.Popen. + + This calls subprocess.Popen making sure the current working + directory is the PYTHONPATH. + + You probably want to use :py:meth:`run` instead. + + """ + env = os.environ.copy() + env['PYTHONPATH'] = os.pathsep.join(filter(None, [ + str(os.getcwd()), env.get('PYTHONPATH', '')])) + kw['env'] = env + return subprocess.Popen(cmdargs, + stdout=stdout, stderr=stderr, **kw) + + def run(self, *cmdargs): + """Run a command with arguments. + + Run a process using subprocess.Popen saving the stdout and + stderr. + + Returns a :py:class:`RunResult`. + + """ + return self._run(*cmdargs) + + def _run(self, *cmdargs): + cmdargs = [str(x) for x in cmdargs] + p1 = self.tmpdir.join("stdout") + p2 = self.tmpdir.join("stderr") + print_("running:", ' '.join(cmdargs)) + print_(" in:", str(py.path.local())) + f1 = codecs.open(str(p1), "w", encoding="utf8") + f2 = codecs.open(str(p2), "w", encoding="utf8") + try: + now = time.time() + popen = self.popen(cmdargs, stdout=f1, stderr=f2, + close_fds=(sys.platform != "win32")) + ret = popen.wait() + finally: + f1.close() + f2.close() + f1 = codecs.open(str(p1), "r", encoding="utf8") + f2 = codecs.open(str(p2), "r", encoding="utf8") + try: + out = f1.read().splitlines() + err = f2.read().splitlines() + finally: + f1.close() + f2.close() + self._dump_lines(out, sys.stdout) + self._dump_lines(err, sys.stderr) + return RunResult(ret, out, err, time.time()-now) + + def _dump_lines(self, lines, fp): + try: + for line in lines: + py.builtin.print_(line, file=fp) + except UnicodeEncodeError: + print("couldn't print to %s because of encoding" % (fp,)) + + def _getpytestargs(self): + # we cannot use "(sys.executable,script)" + # because on windows the script is e.g. a py.test.exe + return (sys.executable, _pytest_fullpath,) # noqa + + def runpython(self, script): + """Run a python script using sys.executable as interpreter. + + Returns a :py:class:`RunResult`. + """ + return self.run(sys.executable, script) + + def runpython_c(self, command): + """Run python -c "command", return a :py:class:`RunResult`.""" + return self.run(sys.executable, "-c", command) + + def runpytest_subprocess(self, *args, **kwargs): + """Run py.test as a subprocess with given arguments. + + Any plugins added to the :py:attr:`plugins` list will added + using the ``-p`` command line option. Addtionally + ``--basetemp`` is used put any temporary files and directories + in a numbered directory prefixed with "runpytest-" so they do + not conflict with the normal numberd pytest location for + temporary files and directories. + + Returns a :py:class:`RunResult`. + + """ + p = py.path.local.make_numbered_dir(prefix="runpytest-", + keep=None, rootdir=self.tmpdir) + args = ('--basetemp=%s' % p, ) + args + #for x in args: + # if '--confcutdir' in str(x): + # break + #else: + # pass + # args = ('--confcutdir=.',) + args + plugins = [x for x in self.plugins if isinstance(x, str)] + if plugins: + args = ('-p', plugins[0]) + args + args = self._getpytestargs() + args + return self.run(*args) + + def spawn_pytest(self, string, expect_timeout=10.0): + """Run py.test using pexpect. + + This makes sure to use the right py.test and sets up the + temporary directory locations. + + The pexpect child is returned. + + """ + basetemp = self.tmpdir.mkdir("pexpect") + invoke = " ".join(map(str, self._getpytestargs())) + cmd = "%s --basetemp=%s %s" % (invoke, basetemp, string) + return self.spawn(cmd, expect_timeout=expect_timeout) + + def spawn(self, cmd, expect_timeout=10.0): + """Run a command using pexpect. + + The pexpect child is returned. + """ + pexpect = pytest.importorskip("pexpect", "3.0") + if hasattr(sys, 'pypy_version_info') and '64' in platform.machine(): + pytest.skip("pypy-64 bit not supported") + if sys.platform == "darwin": + pytest.xfail("pexpect does not work reliably on darwin?!") + if sys.platform.startswith("freebsd"): + pytest.xfail("pexpect does not work reliably on freebsd") + logfile = self.tmpdir.join("spawn.out").open("wb") + child = pexpect.spawn(cmd, logfile=logfile) + self.request.addfinalizer(logfile.close) + child.timeout = expect_timeout + return child + +def getdecoded(out): + try: + return out.decode("utf-8") + except UnicodeDecodeError: + return "INTERNAL not-utf8-decodeable, truncated string:\n%s" % ( + py.io.saferepr(out),) + + +class LineComp: + def __init__(self): + self.stringio = py.io.TextIO() + + def assert_contains_lines(self, lines2): + """ assert that lines2 are contained (linearly) in lines1. + return a list of extralines found. + """ + __tracebackhide__ = True + val = self.stringio.getvalue() + self.stringio.truncate(0) + self.stringio.seek(0) + lines1 = val.split("\n") + return LineMatcher(lines1).fnmatch_lines(lines2) + + +class LineMatcher: + """Flexible matching of text. + + This is a convenience class to test large texts like the output of + commands. + + The constructor takes a list of lines without their trailing + newlines, i.e. ``text.splitlines()``. + + """ + + def __init__(self, lines): + self.lines = lines + + def str(self): + """Return the entire original text.""" + return "\n".join(self.lines) + + def _getlines(self, lines2): + if isinstance(lines2, str): + lines2 = Source(lines2) + if isinstance(lines2, Source): + lines2 = lines2.strip().lines + return lines2 + + def fnmatch_lines_random(self, lines2): + """Check lines exist in the output. + + The argument is a list of lines which have to occur in the + output, in any order. Each line can contain glob whildcards. + + """ + lines2 = self._getlines(lines2) + for line in lines2: + for x in self.lines: + if line == x or fnmatch(x, line): + print_("matched: ", repr(line)) + break + else: + raise ValueError("line %r not found in output" % line) + + def get_lines_after(self, fnline): + """Return all lines following the given line in the text. + + The given line can contain glob wildcards. + """ + for i, line in enumerate(self.lines): + if fnline == line or fnmatch(line, fnline): + return self.lines[i+1:] + raise ValueError("line %r not found in output" % fnline) + + def fnmatch_lines(self, lines2): + """Search the text for matching lines. + + The argument is a list of lines which have to match and can + use glob wildcards. If they do not match an pytest.fail() is + called. The matches and non-matches are also printed on + stdout. + + """ + def show(arg1, arg2): + py.builtin.print_(arg1, arg2, file=sys.stderr) + lines2 = self._getlines(lines2) + lines1 = self.lines[:] + nextline = None + extralines = [] + __tracebackhide__ = True + for line in lines2: + nomatchprinted = False + while lines1: + nextline = lines1.pop(0) + if line == nextline: + show("exact match:", repr(line)) + break + elif fnmatch(nextline, line): + show("fnmatch:", repr(line)) + show(" with:", repr(nextline)) + break + else: + if not nomatchprinted: + show("nomatch:", repr(line)) + nomatchprinted = True + show(" and:", repr(nextline)) + extralines.append(nextline) + else: + pytest.fail("remains unmatched: %r, see stderr" % (line,)) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/python.py b/testing/web-platform/tests/tools/pytest/_pytest/python.py new file mode 100644 index 000000000..3580eae07 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/python.py @@ -0,0 +1,2302 @@ +""" Python test discovery, setup and run of test functions. """ +import fnmatch +import functools +import inspect +import re +import types +import sys + +import py +import pytest +from _pytest._code.code import TerminalRepr +from _pytest.mark import MarkDecorator, MarkerError + +try: + import enum +except ImportError: # pragma: no cover + # Only available in Python 3.4+ or as a backport + enum = None + +import _pytest +import _pytest._pluggy as pluggy + +cutdir2 = py.path.local(_pytest.__file__).dirpath() +cutdir1 = py.path.local(pluggy.__file__.rstrip("oc")) + + +NoneType = type(None) +NOTSET = object() +isfunction = inspect.isfunction +isclass = inspect.isclass +callable = py.builtin.callable +# used to work around a python2 exception info leak +exc_clear = getattr(sys, 'exc_clear', lambda: None) +# The type of re.compile objects is not exposed in Python. +REGEX_TYPE = type(re.compile('')) + +_PY3 = sys.version_info > (3, 0) +_PY2 = not _PY3 + + +if hasattr(inspect, 'signature'): + def _format_args(func): + return str(inspect.signature(func)) +else: + def _format_args(func): + return inspect.formatargspec(*inspect.getargspec(func)) + +if sys.version_info[:2] == (2, 6): + def isclass(object): + """ Return true if the object is a class. Overrides inspect.isclass for + python 2.6 because it will return True for objects which always return + something on __getattr__ calls (see #1035). + Backport of https://hg.python.org/cpython/rev/35bf8f7a8edc + """ + return isinstance(object, (type, types.ClassType)) + +def _has_positional_arg(func): + return func.__code__.co_argcount + + +def filter_traceback(entry): + # entry.path might sometimes return a str object when the entry + # points to dynamically generated code + # see https://bitbucket.org/pytest-dev/py/issues/71 + raw_filename = entry.frame.code.raw.co_filename + is_generated = '<' in raw_filename and '>' in raw_filename + if is_generated: + return False + # entry.path might point to an inexisting file, in which case it will + # alsso return a str object. see #1133 + p = py.path.local(entry.path) + return p != cutdir1 and not p.relto(cutdir2) + + +def get_real_func(obj): + """ gets the real function object of the (possibly) wrapped object by + functools.wraps or functools.partial. + """ + while hasattr(obj, "__wrapped__"): + obj = obj.__wrapped__ + if isinstance(obj, functools.partial): + obj = obj.func + return obj + +def getfslineno(obj): + # xxx let decorators etc specify a sane ordering + obj = get_real_func(obj) + if hasattr(obj, 'place_as'): + obj = obj.place_as + fslineno = _pytest._code.getfslineno(obj) + assert isinstance(fslineno[1], int), obj + return fslineno + +def getimfunc(func): + try: + return func.__func__ + except AttributeError: + try: + return func.im_func + except AttributeError: + return func + +def safe_getattr(object, name, default): + """ Like getattr but return default upon any Exception. + + Attribute access can potentially fail for 'evil' Python objects. + See issue214 + """ + try: + return getattr(object, name, default) + except Exception: + return default + + +class FixtureFunctionMarker: + def __init__(self, scope, params, + autouse=False, yieldctx=False, ids=None): + self.scope = scope + self.params = params + self.autouse = autouse + self.yieldctx = yieldctx + self.ids = ids + + def __call__(self, function): + if isclass(function): + raise ValueError( + "class fixtures not supported (may be in the future)") + function._pytestfixturefunction = self + return function + + +def fixture(scope="function", params=None, autouse=False, ids=None): + """ (return a) decorator to mark a fixture factory function. + + This decorator can be used (with or or without parameters) to define + a fixture function. The name of the fixture function can later be + referenced to cause its invocation ahead of running tests: test + modules or classes can use the pytest.mark.usefixtures(fixturename) + marker. Test functions can directly use fixture names as input + arguments in which case the fixture instance returned from the fixture + function will be injected. + + :arg scope: the scope for which this fixture is shared, one of + "function" (default), "class", "module", "session". + + :arg params: an optional list of parameters which will cause multiple + invocations of the fixture function and all of the tests + using it. + + :arg autouse: if True, the fixture func is activated for all tests that + can see it. If False (the default) then an explicit + reference is needed to activate the fixture. + + :arg ids: list of string ids each corresponding to the params + so that they are part of the test id. If no ids are provided + they will be generated automatically from the params. + + """ + if callable(scope) and params is None and autouse == False: + # direct decoration + return FixtureFunctionMarker( + "function", params, autouse)(scope) + if params is not None and not isinstance(params, (list, tuple)): + params = list(params) + return FixtureFunctionMarker(scope, params, autouse, ids=ids) + +def yield_fixture(scope="function", params=None, autouse=False, ids=None): + """ (return a) decorator to mark a yield-fixture factory function + (EXPERIMENTAL). + + This takes the same arguments as :py:func:`pytest.fixture` but + expects a fixture function to use a ``yield`` instead of a ``return`` + statement to provide a fixture. See + http://pytest.org/en/latest/yieldfixture.html for more info. + """ + if callable(scope) and params is None and autouse == False: + # direct decoration + return FixtureFunctionMarker( + "function", params, autouse, yieldctx=True)(scope) + else: + return FixtureFunctionMarker(scope, params, autouse, + yieldctx=True, ids=ids) + +defaultfuncargprefixmarker = fixture() + +def pyobj_property(name): + def get(self): + node = self.getparent(getattr(pytest, name)) + if node is not None: + return node.obj + doc = "python %s object this node was collected from (can be None)." % ( + name.lower(),) + return property(get, None, None, doc) + + +def pytest_addoption(parser): + group = parser.getgroup("general") + group.addoption('--fixtures', '--funcargs', + action="store_true", dest="showfixtures", default=False, + help="show available fixtures, sorted by plugin appearance") + parser.addini("usefixtures", type="args", default=[], + help="list of default fixtures to be used with this project") + parser.addini("python_files", type="args", + default=['test_*.py', '*_test.py'], + help="glob-style file patterns for Python test module discovery") + parser.addini("python_classes", type="args", default=["Test",], + help="prefixes or glob names for Python test class discovery") + parser.addini("python_functions", type="args", default=["test",], + help="prefixes or glob names for Python test function and " + "method discovery") + + group.addoption("--import-mode", default="prepend", + choices=["prepend", "append"], dest="importmode", + help="prepend/append to sys.path when importing test modules, " + "default is to prepend.") + + +def pytest_cmdline_main(config): + if config.option.showfixtures: + showfixtures(config) + return 0 + + +def pytest_generate_tests(metafunc): + # those alternative spellings are common - raise a specific error to alert + # the user + alt_spellings = ['parameterize', 'parametrise', 'parameterise'] + for attr in alt_spellings: + if hasattr(metafunc.function, attr): + msg = "{0} has '{1}', spelling should be 'parametrize'" + raise MarkerError(msg.format(metafunc.function.__name__, attr)) + try: + markers = metafunc.function.parametrize + except AttributeError: + return + for marker in markers: + metafunc.parametrize(*marker.args, **marker.kwargs) + +def pytest_configure(config): + config.addinivalue_line("markers", + "parametrize(argnames, argvalues): call a test function multiple " + "times passing in different arguments in turn. argvalues generally " + "needs to be a list of values if argnames specifies only one name " + "or a list of tuples of values if argnames specifies multiple names. " + "Example: @parametrize('arg1', [1,2]) would lead to two calls of the " + "decorated test function, one with arg1=1 and another with arg1=2." + "see http://pytest.org/latest/parametrize.html for more info and " + "examples." + ) + config.addinivalue_line("markers", + "usefixtures(fixturename1, fixturename2, ...): mark tests as needing " + "all of the specified fixtures. see http://pytest.org/latest/fixture.html#usefixtures " + ) + +def pytest_sessionstart(session): + session._fixturemanager = FixtureManager(session) + +@pytest.hookimpl(trylast=True) +def pytest_namespace(): + raises.Exception = pytest.fail.Exception + return { + 'fixture': fixture, + 'yield_fixture': yield_fixture, + 'raises' : raises, + 'collect': { + 'Module': Module, 'Class': Class, 'Instance': Instance, + 'Function': Function, 'Generator': Generator, + '_fillfuncargs': fillfixtures} + } + +@fixture(scope="session") +def pytestconfig(request): + """ the pytest config object with access to command line opts.""" + return request.config + + +@pytest.hookimpl(trylast=True) +def pytest_pyfunc_call(pyfuncitem): + testfunction = pyfuncitem.obj + if pyfuncitem._isyieldedfunction(): + testfunction(*pyfuncitem._args) + else: + funcargs = pyfuncitem.funcargs + testargs = {} + for arg in pyfuncitem._fixtureinfo.argnames: + testargs[arg] = funcargs[arg] + testfunction(**testargs) + return True + +def pytest_collect_file(path, parent): + ext = path.ext + if ext == ".py": + if not parent.session.isinitpath(path): + for pat in parent.config.getini('python_files'): + if path.fnmatch(pat): + break + else: + return + ihook = parent.session.gethookproxy(path) + return ihook.pytest_pycollect_makemodule(path=path, parent=parent) + +def pytest_pycollect_makemodule(path, parent): + return Module(path, parent) + +@pytest.hookimpl(hookwrapper=True) +def pytest_pycollect_makeitem(collector, name, obj): + outcome = yield + res = outcome.get_result() + if res is not None: + raise StopIteration + # nothing was collected elsewhere, let's do it here + if isclass(obj): + if collector.istestclass(obj, name): + Class = collector._getcustomclass("Class") + outcome.force_result(Class(name, parent=collector)) + elif collector.istestfunction(obj, name): + # mock seems to store unbound methods (issue473), normalize it + obj = getattr(obj, "__func__", obj) + # We need to try and unwrap the function if it's a functools.partial + # or a funtools.wrapped. + # We musn't if it's been wrapped with mock.patch (python 2 only) + if not (isfunction(obj) or isfunction(get_real_func(obj))): + collector.warn(code="C2", message= + "cannot collect %r because it is not a function." + % name, ) + elif getattr(obj, "__test__", True): + if is_generator(obj): + res = Generator(name, parent=collector) + else: + res = list(collector._genfunctions(name, obj)) + outcome.force_result(res) + +def is_generator(func): + try: + return _pytest._code.getrawcode(func).co_flags & 32 # generator function + except AttributeError: # builtin functions have no bytecode + # assume them to not be generators + return False + +class PyobjContext(object): + module = pyobj_property("Module") + cls = pyobj_property("Class") + instance = pyobj_property("Instance") + +class PyobjMixin(PyobjContext): + def obj(): + def fget(self): + try: + return self._obj + except AttributeError: + self._obj = obj = self._getobj() + return obj + def fset(self, value): + self._obj = value + return property(fget, fset, None, "underlying python object") + obj = obj() + + def _getobj(self): + return getattr(self.parent.obj, self.name) + + def getmodpath(self, stopatmodule=True, includemodule=False): + """ return python path relative to the containing module. """ + chain = self.listchain() + chain.reverse() + parts = [] + for node in chain: + if isinstance(node, Instance): + continue + name = node.name + if isinstance(node, Module): + assert name.endswith(".py") + name = name[:-3] + if stopatmodule: + if includemodule: + parts.append(name) + break + parts.append(name) + parts.reverse() + s = ".".join(parts) + return s.replace(".[", "[") + + def _getfslineno(self): + return getfslineno(self.obj) + + def reportinfo(self): + # XXX caching? + obj = self.obj + compat_co_firstlineno = getattr(obj, 'compat_co_firstlineno', None) + if isinstance(compat_co_firstlineno, int): + # nose compatibility + fspath = sys.modules[obj.__module__].__file__ + if fspath.endswith(".pyc"): + fspath = fspath[:-1] + lineno = compat_co_firstlineno + else: + fspath, lineno = getfslineno(obj) + modpath = self.getmodpath() + assert isinstance(lineno, int) + return fspath, lineno, modpath + +class PyCollector(PyobjMixin, pytest.Collector): + + def funcnamefilter(self, name): + return self._matches_prefix_or_glob_option('python_functions', name) + + def isnosetest(self, obj): + """ Look for the __test__ attribute, which is applied by the + @nose.tools.istest decorator + """ + # We explicitly check for "is True" here to not mistakenly treat + # classes with a custom __getattr__ returning something truthy (like a + # function) as test classes. + return safe_getattr(obj, '__test__', False) is True + + def classnamefilter(self, name): + return self._matches_prefix_or_glob_option('python_classes', name) + + def istestfunction(self, obj, name): + return ( + (self.funcnamefilter(name) or self.isnosetest(obj)) and + safe_getattr(obj, "__call__", False) and getfixturemarker(obj) is None + ) + + def istestclass(self, obj, name): + return self.classnamefilter(name) or self.isnosetest(obj) + + def _matches_prefix_or_glob_option(self, option_name, name): + """ + checks if the given name matches the prefix or glob-pattern defined + in ini configuration. + """ + for option in self.config.getini(option_name): + if name.startswith(option): + return True + # check that name looks like a glob-string before calling fnmatch + # because this is called for every name in each collected module, + # and fnmatch is somewhat expensive to call + elif ('*' in option or '?' in option or '[' in option) and \ + fnmatch.fnmatch(name, option): + return True + return False + + def collect(self): + if not getattr(self.obj, "__test__", True): + return [] + + # NB. we avoid random getattrs and peek in the __dict__ instead + # (XXX originally introduced from a PyPy need, still true?) + dicts = [getattr(self.obj, '__dict__', {})] + for basecls in inspect.getmro(self.obj.__class__): + dicts.append(basecls.__dict__) + seen = {} + l = [] + for dic in dicts: + for name, obj in list(dic.items()): + if name in seen: + continue + seen[name] = True + res = self.makeitem(name, obj) + if res is None: + continue + if not isinstance(res, list): + res = [res] + l.extend(res) + l.sort(key=lambda item: item.reportinfo()[:2]) + return l + + def makeitem(self, name, obj): + #assert self.ihook.fspath == self.fspath, self + return self.ihook.pytest_pycollect_makeitem( + collector=self, name=name, obj=obj) + + def _genfunctions(self, name, funcobj): + module = self.getparent(Module).obj + clscol = self.getparent(Class) + cls = clscol and clscol.obj or None + transfer_markers(funcobj, cls, module) + fm = self.session._fixturemanager + fixtureinfo = fm.getfixtureinfo(self, funcobj, cls) + metafunc = Metafunc(funcobj, fixtureinfo, self.config, + cls=cls, module=module) + methods = [] + if hasattr(module, "pytest_generate_tests"): + methods.append(module.pytest_generate_tests) + if hasattr(cls, "pytest_generate_tests"): + methods.append(cls().pytest_generate_tests) + if methods: + self.ihook.pytest_generate_tests.call_extra(methods, + dict(metafunc=metafunc)) + else: + self.ihook.pytest_generate_tests(metafunc=metafunc) + + Function = self._getcustomclass("Function") + if not metafunc._calls: + yield Function(name, parent=self, fixtureinfo=fixtureinfo) + else: + # add funcargs() as fixturedefs to fixtureinfo.arg2fixturedefs + add_funcarg_pseudo_fixture_def(self, metafunc, fm) + + for callspec in metafunc._calls: + subname = "%s[%s]" %(name, callspec.id) + yield Function(name=subname, parent=self, + callspec=callspec, callobj=funcobj, + fixtureinfo=fixtureinfo, + keywords={callspec.id:True}) + +def add_funcarg_pseudo_fixture_def(collector, metafunc, fixturemanager): + # this function will transform all collected calls to a functions + # if they use direct funcargs (i.e. direct parametrization) + # because we want later test execution to be able to rely on + # an existing FixtureDef structure for all arguments. + # XXX we can probably avoid this algorithm if we modify CallSpec2 + # to directly care for creating the fixturedefs within its methods. + if not metafunc._calls[0].funcargs: + return # this function call does not have direct parametrization + # collect funcargs of all callspecs into a list of values + arg2params = {} + arg2scope = {} + for callspec in metafunc._calls: + for argname, argvalue in callspec.funcargs.items(): + assert argname not in callspec.params + callspec.params[argname] = argvalue + arg2params_list = arg2params.setdefault(argname, []) + callspec.indices[argname] = len(arg2params_list) + arg2params_list.append(argvalue) + if argname not in arg2scope: + scopenum = callspec._arg2scopenum.get(argname, + scopenum_function) + arg2scope[argname] = scopes[scopenum] + callspec.funcargs.clear() + + # register artificial FixtureDef's so that later at test execution + # time we can rely on a proper FixtureDef to exist for fixture setup. + arg2fixturedefs = metafunc._arg2fixturedefs + for argname, valuelist in arg2params.items(): + # if we have a scope that is higher than function we need + # to make sure we only ever create an according fixturedef on + # a per-scope basis. We thus store and cache the fixturedef on the + # node related to the scope. + scope = arg2scope[argname] + node = None + if scope != "function": + node = get_scope_node(collector, scope) + if node is None: + assert scope == "class" and isinstance(collector, Module) + # use module-level collector for class-scope (for now) + node = collector + if node and argname in node._name2pseudofixturedef: + arg2fixturedefs[argname] = [node._name2pseudofixturedef[argname]] + else: + fixturedef = FixtureDef(fixturemanager, '', argname, + get_direct_param_fixture_func, + arg2scope[argname], + valuelist, False, False) + arg2fixturedefs[argname] = [fixturedef] + if node is not None: + node._name2pseudofixturedef[argname] = fixturedef + + +def get_direct_param_fixture_func(request): + return request.param + +class FuncFixtureInfo: + def __init__(self, argnames, names_closure, name2fixturedefs): + self.argnames = argnames + self.names_closure = names_closure + self.name2fixturedefs = name2fixturedefs + + +def _marked(func, mark): + """ Returns True if :func: is already marked with :mark:, False otherwise. + This can happen if marker is applied to class and the test file is + invoked more than once. + """ + try: + func_mark = getattr(func, mark.name) + except AttributeError: + return False + return mark.args == func_mark.args and mark.kwargs == func_mark.kwargs + + +def transfer_markers(funcobj, cls, mod): + # XXX this should rather be code in the mark plugin or the mark + # plugin should merge with the python plugin. + for holder in (cls, mod): + try: + pytestmark = holder.pytestmark + except AttributeError: + continue + if isinstance(pytestmark, list): + for mark in pytestmark: + if not _marked(funcobj, mark): + mark(funcobj) + else: + if not _marked(funcobj, pytestmark): + pytestmark(funcobj) + +class Module(pytest.File, PyCollector): + """ Collector for test classes and functions. """ + def _getobj(self): + return self._memoizedcall('_obj', self._importtestmodule) + + def collect(self): + self.session._fixturemanager.parsefactories(self) + return super(Module, self).collect() + + def _importtestmodule(self): + # we assume we are only called once per module + importmode = self.config.getoption("--import-mode") + try: + mod = self.fspath.pyimport(ensuresyspath=importmode) + except SyntaxError: + raise self.CollectError( + _pytest._code.ExceptionInfo().getrepr(style="short")) + except self.fspath.ImportMismatchError: + e = sys.exc_info()[1] + raise self.CollectError( + "import file mismatch:\n" + "imported module %r has this __file__ attribute:\n" + " %s\n" + "which is not the same as the test file we want to collect:\n" + " %s\n" + "HINT: remove __pycache__ / .pyc files and/or use a " + "unique basename for your test file modules" + % e.args + ) + #print "imported test module", mod + self.config.pluginmanager.consider_module(mod) + return mod + + def setup(self): + setup_module = xunitsetup(self.obj, "setUpModule") + if setup_module is None: + setup_module = xunitsetup(self.obj, "setup_module") + if setup_module is not None: + #XXX: nose compat hack, move to nose plugin + # if it takes a positional arg, its probably a pytest style one + # so we pass the current module object + if _has_positional_arg(setup_module): + setup_module(self.obj) + else: + setup_module() + fin = getattr(self.obj, 'tearDownModule', None) + if fin is None: + fin = getattr(self.obj, 'teardown_module', None) + if fin is not None: + #XXX: nose compat hack, move to nose plugin + # if it takes a positional arg, it's probably a pytest style one + # so we pass the current module object + if _has_positional_arg(fin): + finalizer = lambda: fin(self.obj) + else: + finalizer = fin + self.addfinalizer(finalizer) + + +class Class(PyCollector): + """ Collector for test methods. """ + def collect(self): + if hasinit(self.obj): + self.warn("C1", "cannot collect test class %r because it has a " + "__init__ constructor" % self.obj.__name__) + return [] + return [self._getcustomclass("Instance")(name="()", parent=self)] + + def setup(self): + setup_class = xunitsetup(self.obj, 'setup_class') + if setup_class is not None: + setup_class = getattr(setup_class, 'im_func', setup_class) + setup_class = getattr(setup_class, '__func__', setup_class) + setup_class(self.obj) + + fin_class = getattr(self.obj, 'teardown_class', None) + if fin_class is not None: + fin_class = getattr(fin_class, 'im_func', fin_class) + fin_class = getattr(fin_class, '__func__', fin_class) + self.addfinalizer(lambda: fin_class(self.obj)) + +class Instance(PyCollector): + def _getobj(self): + obj = self.parent.obj() + return obj + + def collect(self): + self.session._fixturemanager.parsefactories(self) + return super(Instance, self).collect() + + def newinstance(self): + self.obj = self._getobj() + return self.obj + +class FunctionMixin(PyobjMixin): + """ mixin for the code common to Function and Generator. + """ + + def setup(self): + """ perform setup for this test function. """ + if hasattr(self, '_preservedparent'): + obj = self._preservedparent + elif isinstance(self.parent, Instance): + obj = self.parent.newinstance() + self.obj = self._getobj() + else: + obj = self.parent.obj + if inspect.ismethod(self.obj): + setup_name = 'setup_method' + teardown_name = 'teardown_method' + else: + setup_name = 'setup_function' + teardown_name = 'teardown_function' + setup_func_or_method = xunitsetup(obj, setup_name) + if setup_func_or_method is not None: + setup_func_or_method(self.obj) + fin = getattr(obj, teardown_name, None) + if fin is not None: + self.addfinalizer(lambda: fin(self.obj)) + + def _prunetraceback(self, excinfo): + if hasattr(self, '_obj') and not self.config.option.fulltrace: + code = _pytest._code.Code(get_real_func(self.obj)) + path, firstlineno = code.path, code.firstlineno + traceback = excinfo.traceback + ntraceback = traceback.cut(path=path, firstlineno=firstlineno) + if ntraceback == traceback: + ntraceback = ntraceback.cut(path=path) + if ntraceback == traceback: + #ntraceback = ntraceback.cut(excludepath=cutdir2) + ntraceback = ntraceback.filter(filter_traceback) + if not ntraceback: + ntraceback = traceback + + excinfo.traceback = ntraceback.filter() + # issue364: mark all but first and last frames to + # only show a single-line message for each frame + if self.config.option.tbstyle == "auto": + if len(excinfo.traceback) > 2: + for entry in excinfo.traceback[1:-1]: + entry.set_repr_style('short') + + def _repr_failure_py(self, excinfo, style="long"): + if excinfo.errisinstance(pytest.fail.Exception): + if not excinfo.value.pytrace: + return py._builtin._totext(excinfo.value) + return super(FunctionMixin, self)._repr_failure_py(excinfo, + style=style) + + def repr_failure(self, excinfo, outerr=None): + assert outerr is None, "XXX outerr usage is deprecated" + style = self.config.option.tbstyle + if style == "auto": + style = "long" + return self._repr_failure_py(excinfo, style=style) + + +class Generator(FunctionMixin, PyCollector): + def collect(self): + # test generators are seen as collectors but they also + # invoke setup/teardown on popular request + # (induced by the common "test_*" naming shared with normal tests) + self.session._setupstate.prepare(self) + # see FunctionMixin.setup and test_setupstate_is_preserved_134 + self._preservedparent = self.parent.obj + l = [] + seen = {} + for i, x in enumerate(self.obj()): + name, call, args = self.getcallargs(x) + if not callable(call): + raise TypeError("%r yielded non callable test %r" %(self.obj, call,)) + if name is None: + name = "[%d]" % i + else: + name = "['%s']" % name + if name in seen: + raise ValueError("%r generated tests with non-unique name %r" %(self, name)) + seen[name] = True + l.append(self.Function(name, self, args=args, callobj=call)) + return l + + def getcallargs(self, obj): + if not isinstance(obj, (tuple, list)): + obj = (obj,) + # explict naming + if isinstance(obj[0], py.builtin._basestring): + name = obj[0] + obj = obj[1:] + else: + name = None + call, args = obj[0], obj[1:] + return name, call, args + + +def hasinit(obj): + init = getattr(obj, '__init__', None) + if init: + if init != object.__init__: + return True + + + +def fillfixtures(function): + """ fill missing funcargs for a test function. """ + try: + request = function._request + except AttributeError: + # XXX this special code path is only expected to execute + # with the oejskit plugin. It uses classes with funcargs + # and we thus have to work a bit to allow this. + fm = function.session._fixturemanager + fi = fm.getfixtureinfo(function.parent, function.obj, None) + function._fixtureinfo = fi + request = function._request = FixtureRequest(function) + request._fillfixtures() + # prune out funcargs for jstests + newfuncargs = {} + for name in fi.argnames: + newfuncargs[name] = function.funcargs[name] + function.funcargs = newfuncargs + else: + request._fillfixtures() + + +_notexists = object() + +class CallSpec2(object): + def __init__(self, metafunc): + self.metafunc = metafunc + self.funcargs = {} + self._idlist = [] + self.params = {} + self._globalid = _notexists + self._globalid_args = set() + self._globalparam = _notexists + self._arg2scopenum = {} # used for sorting parametrized resources + self.keywords = {} + self.indices = {} + + def copy(self, metafunc): + cs = CallSpec2(self.metafunc) + cs.funcargs.update(self.funcargs) + cs.params.update(self.params) + cs.keywords.update(self.keywords) + cs.indices.update(self.indices) + cs._arg2scopenum.update(self._arg2scopenum) + cs._idlist = list(self._idlist) + cs._globalid = self._globalid + cs._globalid_args = self._globalid_args + cs._globalparam = self._globalparam + return cs + + def _checkargnotcontained(self, arg): + if arg in self.params or arg in self.funcargs: + raise ValueError("duplicate %r" %(arg,)) + + def getparam(self, name): + try: + return self.params[name] + except KeyError: + if self._globalparam is _notexists: + raise ValueError(name) + return self._globalparam + + @property + def id(self): + return "-".join(map(str, filter(None, self._idlist))) + + def setmulti(self, valtypes, argnames, valset, id, keywords, scopenum, + param_index): + for arg,val in zip(argnames, valset): + self._checkargnotcontained(arg) + valtype_for_arg = valtypes[arg] + getattr(self, valtype_for_arg)[arg] = val + self.indices[arg] = param_index + self._arg2scopenum[arg] = scopenum + if val is _notexists: + self._emptyparamspecified = True + self._idlist.append(id) + self.keywords.update(keywords) + + def setall(self, funcargs, id, param): + for x in funcargs: + self._checkargnotcontained(x) + self.funcargs.update(funcargs) + if id is not _notexists: + self._idlist.append(id) + if param is not _notexists: + assert self._globalparam is _notexists + self._globalparam = param + for arg in funcargs: + self._arg2scopenum[arg] = scopenum_function + + +class FuncargnamesCompatAttr: + """ helper class so that Metafunc, Function and FixtureRequest + don't need to each define the "funcargnames" compatibility attribute. + """ + @property + def funcargnames(self): + """ alias attribute for ``fixturenames`` for pre-2.3 compatibility""" + return self.fixturenames + +class Metafunc(FuncargnamesCompatAttr): + """ + Metafunc objects are passed to the ``pytest_generate_tests`` hook. + They help to inspect a test function and to generate tests according to + test configuration or values specified in the class or module where a + test function is defined. + + :ivar fixturenames: set of fixture names required by the test function + + :ivar function: underlying python test function + + :ivar cls: class object where the test function is defined in or ``None``. + + :ivar module: the module object where the test function is defined in. + + :ivar config: access to the :class:`_pytest.config.Config` object for the + test session. + + :ivar funcargnames: + .. deprecated:: 2.3 + Use ``fixturenames`` instead. + """ + def __init__(self, function, fixtureinfo, config, cls=None, module=None): + self.config = config + self.module = module + self.function = function + self.fixturenames = fixtureinfo.names_closure + self._arg2fixturedefs = fixtureinfo.name2fixturedefs + self.cls = cls + self._calls = [] + self._ids = py.builtin.set() + + def parametrize(self, argnames, argvalues, indirect=False, ids=None, + scope=None): + """ Add new invocations to the underlying test function using the list + of argvalues for the given argnames. Parametrization is performed + during the collection phase. If you need to setup expensive resources + see about setting indirect to do it rather at test setup time. + + :arg argnames: a comma-separated string denoting one or more argument + names, or a list/tuple of argument strings. + + :arg argvalues: The list of argvalues determines how often a + test is invoked with different argument values. If only one + argname was specified argvalues is a list of values. If N + argnames were specified, argvalues must be a list of N-tuples, + where each tuple-element specifies a value for its respective + argname. + + :arg indirect: The list of argnames or boolean. A list of arguments' + names (subset of argnames). If True the list contains all names from + the argnames. Each argvalue corresponding to an argname in this list will + be passed as request.param to its respective argname fixture + function so that it can perform more expensive setups during the + setup phase of a test rather than at collection time. + + :arg ids: list of string ids, or a callable. + If strings, each is corresponding to the argvalues so that they are + part of the test id. + If callable, it should take one argument (a single argvalue) and return + a string or return None. If None, the automatically generated id for that + argument will be used. + If no ids are provided they will be generated automatically from + the argvalues. + + :arg scope: if specified it denotes the scope of the parameters. + The scope is used for grouping tests by parameter instances. + It will also override any fixture-function defined scope, allowing + to set a dynamic scope using test context or configuration. + """ + + # individual parametrized argument sets can be wrapped in a series + # of markers in which case we unwrap the values and apply the mark + # at Function init + newkeywords = {} + unwrapped_argvalues = [] + for i, argval in enumerate(argvalues): + while isinstance(argval, MarkDecorator): + newmark = MarkDecorator(argval.markname, + argval.args[:-1], argval.kwargs) + newmarks = newkeywords.setdefault(i, {}) + newmarks[newmark.markname] = newmark + argval = argval.args[-1] + unwrapped_argvalues.append(argval) + argvalues = unwrapped_argvalues + + if not isinstance(argnames, (tuple, list)): + argnames = [x.strip() for x in argnames.split(",") if x.strip()] + if len(argnames) == 1: + argvalues = [(val,) for val in argvalues] + if not argvalues: + argvalues = [(_notexists,) * len(argnames)] + + if scope is None: + scope = "function" + scopenum = scopes.index(scope) + valtypes = {} + for arg in argnames: + if arg not in self.fixturenames: + raise ValueError("%r uses no fixture %r" %(self.function, arg)) + + if indirect is True: + valtypes = dict.fromkeys(argnames, "params") + elif indirect is False: + valtypes = dict.fromkeys(argnames, "funcargs") + elif isinstance(indirect, (tuple, list)): + valtypes = dict.fromkeys(argnames, "funcargs") + for arg in indirect: + if arg not in argnames: + raise ValueError("indirect given to %r: fixture %r doesn't exist" %( + self.function, arg)) + valtypes[arg] = "params" + idfn = None + if callable(ids): + idfn = ids + ids = None + if ids and len(ids) != len(argvalues): + raise ValueError('%d tests specified with %d ids' %( + len(argvalues), len(ids))) + if not ids: + ids = idmaker(argnames, argvalues, idfn) + newcalls = [] + for callspec in self._calls or [CallSpec2(self)]: + for param_index, valset in enumerate(argvalues): + assert len(valset) == len(argnames) + newcallspec = callspec.copy(self) + newcallspec.setmulti(valtypes, argnames, valset, ids[param_index], + newkeywords.get(param_index, {}), scopenum, + param_index) + newcalls.append(newcallspec) + self._calls = newcalls + + def addcall(self, funcargs=None, id=_notexists, param=_notexists): + """ (deprecated, use parametrize) Add a new call to the underlying + test function during the collection phase of a test run. Note that + request.addcall() is called during the test collection phase prior and + independently to actual test execution. You should only use addcall() + if you need to specify multiple arguments of a test function. + + :arg funcargs: argument keyword dictionary used when invoking + the test function. + + :arg id: used for reporting and identification purposes. If you + don't supply an `id` an automatic unique id will be generated. + + :arg param: a parameter which will be exposed to a later fixture function + invocation through the ``request.param`` attribute. + """ + assert funcargs is None or isinstance(funcargs, dict) + if funcargs is not None: + for name in funcargs: + if name not in self.fixturenames: + pytest.fail("funcarg %r not used in this function." % name) + else: + funcargs = {} + if id is None: + raise ValueError("id=None not allowed") + if id is _notexists: + id = len(self._calls) + id = str(id) + if id in self._ids: + raise ValueError("duplicate id %r" % id) + self._ids.add(id) + + cs = CallSpec2(self) + cs.setall(funcargs, id, param) + self._calls.append(cs) + + +if _PY3: + import codecs + + def _escape_bytes(val): + """ + If val is pure ascii, returns it as a str(), otherwise escapes + into a sequence of escaped bytes: + b'\xc3\xb4\xc5\xd6' -> u'\\xc3\\xb4\\xc5\\xd6' + + note: + the obvious "v.decode('unicode-escape')" will return + valid utf-8 unicode if it finds them in the string, but we + want to return escaped bytes for any byte, even if they match + a utf-8 string. + """ + if val: + # source: http://goo.gl/bGsnwC + encoded_bytes, _ = codecs.escape_encode(val) + return encoded_bytes.decode('ascii') + else: + # empty bytes crashes codecs.escape_encode (#1087) + return '' +else: + def _escape_bytes(val): + """ + In py2 bytes and str are the same type, so return it unchanged if it + is a full ascii string, otherwise escape it into its binary form. + """ + try: + return val.decode('ascii') + except UnicodeDecodeError: + return val.encode('string-escape') + + +def _idval(val, argname, idx, idfn): + if idfn: + try: + s = idfn(val) + if s: + return s + except Exception: + pass + + if isinstance(val, bytes): + return _escape_bytes(val) + elif isinstance(val, (float, int, str, bool, NoneType)): + return str(val) + elif isinstance(val, REGEX_TYPE): + return _escape_bytes(val.pattern) if isinstance(val.pattern, bytes) else val.pattern + elif enum is not None and isinstance(val, enum.Enum): + return str(val) + elif isclass(val) and hasattr(val, '__name__'): + return val.__name__ + elif _PY2 and isinstance(val, unicode): + # special case for python 2: if a unicode string is + # convertible to ascii, return it as an str() object instead + try: + return str(val) + except UnicodeError: + # fallthrough + pass + return str(argname)+str(idx) + +def _idvalset(idx, valset, argnames, idfn): + this_id = [_idval(val, argname, idx, idfn) + for val, argname in zip(valset, argnames)] + return "-".join(this_id) + +def idmaker(argnames, argvalues, idfn=None): + ids = [_idvalset(valindex, valset, argnames, idfn) + for valindex, valset in enumerate(argvalues)] + if len(set(ids)) < len(ids): + # user may have provided a bad idfn which means the ids are not unique + ids = [str(i) + testid for i, testid in enumerate(ids)] + return ids + +def showfixtures(config): + from _pytest.main import wrap_session + return wrap_session(config, _showfixtures_main) + +def _showfixtures_main(config, session): + import _pytest.config + session.perform_collect() + curdir = py.path.local() + tw = _pytest.config.create_terminal_writer(config) + verbose = config.getvalue("verbose") + + fm = session._fixturemanager + + available = [] + for argname, fixturedefs in fm._arg2fixturedefs.items(): + assert fixturedefs is not None + if not fixturedefs: + continue + fixturedef = fixturedefs[-1] + loc = getlocation(fixturedef.func, curdir) + available.append((len(fixturedef.baseid), + fixturedef.func.__module__, + curdir.bestrelpath(loc), + fixturedef.argname, fixturedef)) + + available.sort() + currentmodule = None + for baseid, module, bestrel, argname, fixturedef in available: + if currentmodule != module: + if not module.startswith("_pytest."): + tw.line() + tw.sep("-", "fixtures defined from %s" %(module,)) + currentmodule = module + if verbose <= 0 and argname[0] == "_": + continue + if verbose > 0: + funcargspec = "%s -- %s" %(argname, bestrel,) + else: + funcargspec = argname + tw.line(funcargspec, green=True) + loc = getlocation(fixturedef.func, curdir) + doc = fixturedef.func.__doc__ or "" + if doc: + for line in doc.strip().split("\n"): + tw.line(" " + line.strip()) + else: + tw.line(" %s: no docstring available" %(loc,), + red=True) + +def getlocation(function, curdir): + import inspect + fn = py.path.local(inspect.getfile(function)) + lineno = py.builtin._getcode(function).co_firstlineno + if fn.relto(curdir): + fn = fn.relto(curdir) + return "%s:%d" %(fn, lineno+1) + +# builtin pytest.raises helper + +def raises(expected_exception, *args, **kwargs): + """ assert that a code block/function call raises ``expected_exception`` + and raise a failure exception otherwise. + + This helper produces a ``ExceptionInfo()`` object (see below). + + If using Python 2.5 or above, you may use this function as a + context manager:: + + >>> with raises(ZeroDivisionError): + ... 1/0 + + .. note:: + + When using ``pytest.raises`` as a context manager, it's worthwhile to + note that normal context manager rules apply and that the exception + raised *must* be the final line in the scope of the context manager. + Lines of code after that, within the scope of the context manager will + not be executed. For example:: + + >>> with raises(OSError) as exc_info: + assert 1 == 1 # this will execute as expected + raise OSError(errno.EEXISTS, 'directory exists') + assert exc_info.value.errno == errno.EEXISTS # this will not execute + + Instead, the following approach must be taken (note the difference in + scope):: + + >>> with raises(OSError) as exc_info: + assert 1 == 1 # this will execute as expected + raise OSError(errno.EEXISTS, 'directory exists') + + assert exc_info.value.errno == errno.EEXISTS # this will now execute + + Or you can specify a callable by passing a to-be-called lambda:: + + >>> raises(ZeroDivisionError, lambda: 1/0) + <ExceptionInfo ...> + + or you can specify an arbitrary callable with arguments:: + + >>> def f(x): return 1/x + ... + >>> raises(ZeroDivisionError, f, 0) + <ExceptionInfo ...> + >>> raises(ZeroDivisionError, f, x=0) + <ExceptionInfo ...> + + A third possibility is to use a string to be executed:: + + >>> raises(ZeroDivisionError, "f(0)") + <ExceptionInfo ...> + + .. autoclass:: _pytest._code.ExceptionInfo + :members: + + .. note:: + Similar to caught exception objects in Python, explicitly clearing + local references to returned ``ExceptionInfo`` objects can + help the Python interpreter speed up its garbage collection. + + Clearing those references breaks a reference cycle + (``ExceptionInfo`` --> caught exception --> frame stack raising + the exception --> current frame stack --> local variables --> + ``ExceptionInfo``) which makes Python keep all objects referenced + from that cycle (including all local variables in the current + frame) alive until the next cyclic garbage collection run. See the + official Python ``try`` statement documentation for more detailed + information. + + """ + __tracebackhide__ = True + if expected_exception is AssertionError: + # we want to catch a AssertionError + # replace our subclass with the builtin one + # see https://github.com/pytest-dev/pytest/issues/176 + from _pytest.assertion.util import BuiltinAssertionError \ + as expected_exception + msg = ("exceptions must be old-style classes or" + " derived from BaseException, not %s") + if isinstance(expected_exception, tuple): + for exc in expected_exception: + if not isclass(exc): + raise TypeError(msg % type(exc)) + elif not isclass(expected_exception): + raise TypeError(msg % type(expected_exception)) + + if not args: + return RaisesContext(expected_exception) + elif isinstance(args[0], str): + code, = args + assert isinstance(code, str) + frame = sys._getframe(1) + loc = frame.f_locals.copy() + loc.update(kwargs) + #print "raises frame scope: %r" % frame.f_locals + try: + code = _pytest._code.Source(code).compile() + py.builtin.exec_(code, frame.f_globals, loc) + # XXX didn'T mean f_globals == f_locals something special? + # this is destroyed here ... + except expected_exception: + return _pytest._code.ExceptionInfo() + else: + func = args[0] + try: + func(*args[1:], **kwargs) + except expected_exception: + return _pytest._code.ExceptionInfo() + pytest.fail("DID NOT RAISE {0}".format(expected_exception)) + +class RaisesContext(object): + def __init__(self, expected_exception): + self.expected_exception = expected_exception + self.excinfo = None + + def __enter__(self): + self.excinfo = object.__new__(_pytest._code.ExceptionInfo) + return self.excinfo + + def __exit__(self, *tp): + __tracebackhide__ = True + if tp[0] is None: + pytest.fail("DID NOT RAISE") + if sys.version_info < (2, 7): + # py26: on __exit__() exc_value often does not contain the + # exception value. + # http://bugs.python.org/issue7853 + if not isinstance(tp[1], BaseException): + exc_type, value, traceback = tp + tp = exc_type, exc_type(value), traceback + self.excinfo.__init__(tp) + return issubclass(self.excinfo.type, self.expected_exception) + +# +# the basic pytest Function item +# + +class Function(FunctionMixin, pytest.Item, FuncargnamesCompatAttr): + """ a Function Item is responsible for setting up and executing a + Python test function. + """ + _genid = None + def __init__(self, name, parent, args=None, config=None, + callspec=None, callobj=NOTSET, keywords=None, session=None, + fixtureinfo=None): + super(Function, self).__init__(name, parent, config=config, + session=session) + self._args = args + if callobj is not NOTSET: + self.obj = callobj + + self.keywords.update(self.obj.__dict__) + if callspec: + self.callspec = callspec + self.keywords.update(callspec.keywords) + if keywords: + self.keywords.update(keywords) + + if fixtureinfo is None: + fixtureinfo = self.session._fixturemanager.getfixtureinfo( + self.parent, self.obj, self.cls, + funcargs=not self._isyieldedfunction()) + self._fixtureinfo = fixtureinfo + self.fixturenames = fixtureinfo.names_closure + self._initrequest() + + def _initrequest(self): + self.funcargs = {} + if self._isyieldedfunction(): + assert not hasattr(self, "callspec"), ( + "yielded functions (deprecated) cannot have funcargs") + else: + if hasattr(self, "callspec"): + callspec = self.callspec + assert not callspec.funcargs + self._genid = callspec.id + if hasattr(callspec, "param"): + self.param = callspec.param + self._request = FixtureRequest(self) + + @property + def function(self): + "underlying python 'function' object" + return getattr(self.obj, 'im_func', self.obj) + + def _getobj(self): + name = self.name + i = name.find("[") # parametrization + if i != -1: + name = name[:i] + return getattr(self.parent.obj, name) + + @property + def _pyfuncitem(self): + "(compatonly) for code expecting pytest-2.2 style request objects" + return self + + def _isyieldedfunction(self): + return getattr(self, "_args", None) is not None + + def runtest(self): + """ execute the underlying test function. """ + self.ihook.pytest_pyfunc_call(pyfuncitem=self) + + def setup(self): + # check if parametrization happend with an empty list + try: + self.callspec._emptyparamspecified + except AttributeError: + pass + else: + fs, lineno = self._getfslineno() + pytest.skip("got empty parameter set, function %s at %s:%d" %( + self.function.__name__, fs, lineno)) + super(Function, self).setup() + fillfixtures(self) + + +scope2props = dict(session=()) +scope2props["module"] = ("fspath", "module") +scope2props["class"] = scope2props["module"] + ("cls",) +scope2props["instance"] = scope2props["class"] + ("instance", ) +scope2props["function"] = scope2props["instance"] + ("function", "keywords") + +def scopeproperty(name=None, doc=None): + def decoratescope(func): + scopename = name or func.__name__ + def provide(self): + if func.__name__ in scope2props[self.scope]: + return func(self) + raise AttributeError("%s not available in %s-scoped context" % ( + scopename, self.scope)) + return property(provide, None, None, func.__doc__) + return decoratescope + + +class FixtureRequest(FuncargnamesCompatAttr): + """ A request for a fixture from a test or fixture function. + + A request object gives access to the requesting test context + and has an optional ``param`` attribute in case + the fixture is parametrized indirectly. + """ + + def __init__(self, pyfuncitem): + self._pyfuncitem = pyfuncitem + #: fixture for which this request is being performed + self.fixturename = None + #: Scope string, one of "function", "cls", "module", "session" + self.scope = "function" + self._funcargs = {} + self._fixturedefs = {} + fixtureinfo = pyfuncitem._fixtureinfo + self._arg2fixturedefs = fixtureinfo.name2fixturedefs.copy() + self._arg2index = {} + self.fixturenames = fixtureinfo.names_closure + self._fixturemanager = pyfuncitem.session._fixturemanager + + @property + def node(self): + """ underlying collection node (depends on current request scope)""" + return self._getscopeitem(self.scope) + + + def _getnextfixturedef(self, argname): + fixturedefs = self._arg2fixturedefs.get(argname, None) + if fixturedefs is None: + # we arrive here because of a a dynamic call to + # getfuncargvalue(argname) usage which was naturally + # not known at parsing/collection time + fixturedefs = self._fixturemanager.getfixturedefs( + argname, self._pyfuncitem.parent.nodeid) + self._arg2fixturedefs[argname] = fixturedefs + # fixturedefs list is immutable so we maintain a decreasing index + index = self._arg2index.get(argname, 0) - 1 + if fixturedefs is None or (-index > len(fixturedefs)): + raise FixtureLookupError(argname, self) + self._arg2index[argname] = index + return fixturedefs[index] + + @property + def config(self): + """ the pytest config object associated with this request. """ + return self._pyfuncitem.config + + + @scopeproperty() + def function(self): + """ test function object if the request has a per-function scope. """ + return self._pyfuncitem.obj + + @scopeproperty("class") + def cls(self): + """ class (can be None) where the test function was collected. """ + clscol = self._pyfuncitem.getparent(pytest.Class) + if clscol: + return clscol.obj + + @property + def instance(self): + """ instance (can be None) on which test function was collected. """ + # unittest support hack, see _pytest.unittest.TestCaseFunction + try: + return self._pyfuncitem._testcase + except AttributeError: + function = getattr(self, "function", None) + if function is not None: + return py.builtin._getimself(function) + + @scopeproperty() + def module(self): + """ python module object where the test function was collected. """ + return self._pyfuncitem.getparent(pytest.Module).obj + + @scopeproperty() + def fspath(self): + """ the file system path of the test module which collected this test. """ + return self._pyfuncitem.fspath + + @property + def keywords(self): + """ keywords/markers dictionary for the underlying node. """ + return self.node.keywords + + @property + def session(self): + """ pytest session object. """ + return self._pyfuncitem.session + + def addfinalizer(self, finalizer): + """ add finalizer/teardown function to be called after the + last test within the requesting test context finished + execution. """ + # XXX usually this method is shadowed by fixturedef specific ones + self._addfinalizer(finalizer, scope=self.scope) + + def _addfinalizer(self, finalizer, scope): + colitem = self._getscopeitem(scope) + self._pyfuncitem.session._setupstate.addfinalizer( + finalizer=finalizer, colitem=colitem) + + def applymarker(self, marker): + """ Apply a marker to a single test function invocation. + This method is useful if you don't want to have a keyword/marker + on all function invocations. + + :arg marker: a :py:class:`_pytest.mark.MarkDecorator` object + created by a call to ``pytest.mark.NAME(...)``. + """ + try: + self.node.keywords[marker.markname] = marker + except AttributeError: + raise ValueError(marker) + + def raiseerror(self, msg): + """ raise a FixtureLookupError with the given message. """ + raise self._fixturemanager.FixtureLookupError(None, self, msg) + + def _fillfixtures(self): + item = self._pyfuncitem + fixturenames = getattr(item, "fixturenames", self.fixturenames) + for argname in fixturenames: + if argname not in item.funcargs: + item.funcargs[argname] = self.getfuncargvalue(argname) + + def cached_setup(self, setup, teardown=None, scope="module", extrakey=None): + """ (deprecated) Return a testing resource managed by ``setup`` & + ``teardown`` calls. ``scope`` and ``extrakey`` determine when the + ``teardown`` function will be called so that subsequent calls to + ``setup`` would recreate the resource. With pytest-2.3 you often + do not need ``cached_setup()`` as you can directly declare a scope + on a fixture function and register a finalizer through + ``request.addfinalizer()``. + + :arg teardown: function receiving a previously setup resource. + :arg setup: a no-argument function creating a resource. + :arg scope: a string value out of ``function``, ``class``, ``module`` + or ``session`` indicating the caching lifecycle of the resource. + :arg extrakey: added to internal caching key of (funcargname, scope). + """ + if not hasattr(self.config, '_setupcache'): + self.config._setupcache = {} # XXX weakref? + cachekey = (self.fixturename, self._getscopeitem(scope), extrakey) + cache = self.config._setupcache + try: + val = cache[cachekey] + except KeyError: + self._check_scope(self.fixturename, self.scope, scope) + val = setup() + cache[cachekey] = val + if teardown is not None: + def finalizer(): + del cache[cachekey] + teardown(val) + self._addfinalizer(finalizer, scope=scope) + return val + + def getfuncargvalue(self, argname): + """ Dynamically retrieve a named fixture function argument. + + As of pytest-2.3, it is easier and usually better to access other + fixture values by stating it as an input argument in the fixture + function. If you only can decide about using another fixture at test + setup time, you may use this function to retrieve it inside a fixture + function body. + """ + return self._get_active_fixturedef(argname).cached_result[0] + + def _get_active_fixturedef(self, argname): + try: + return self._fixturedefs[argname] + except KeyError: + try: + fixturedef = self._getnextfixturedef(argname) + except FixtureLookupError: + if argname == "request": + class PseudoFixtureDef: + cached_result = (self, [0], None) + scope = "function" + return PseudoFixtureDef + raise + # remove indent to prevent the python3 exception + # from leaking into the call + result = self._getfuncargvalue(fixturedef) + self._funcargs[argname] = result + self._fixturedefs[argname] = fixturedef + return fixturedef + + def _get_fixturestack(self): + current = self + l = [] + while 1: + fixturedef = getattr(current, "_fixturedef", None) + if fixturedef is None: + l.reverse() + return l + l.append(fixturedef) + current = current._parent_request + + def _getfuncargvalue(self, fixturedef): + # prepare a subrequest object before calling fixture function + # (latter managed by fixturedef) + argname = fixturedef.argname + funcitem = self._pyfuncitem + scope = fixturedef.scope + try: + param = funcitem.callspec.getparam(argname) + except (AttributeError, ValueError): + param = NOTSET + param_index = 0 + else: + # indices might not be set if old-style metafunc.addcall() was used + param_index = funcitem.callspec.indices.get(argname, 0) + # if a parametrize invocation set a scope it will override + # the static scope defined with the fixture function + paramscopenum = funcitem.callspec._arg2scopenum.get(argname) + if paramscopenum is not None: + scope = scopes[paramscopenum] + + subrequest = SubRequest(self, scope, param, param_index, fixturedef) + + # check if a higher-level scoped fixture accesses a lower level one + subrequest._check_scope(argname, self.scope, scope) + + # clear sys.exc_info before invoking the fixture (python bug?) + # if its not explicitly cleared it will leak into the call + exc_clear() + try: + # call the fixture function + val = fixturedef.execute(request=subrequest) + finally: + # if fixture function failed it might have registered finalizers + self.session._setupstate.addfinalizer(fixturedef.finish, + subrequest.node) + return val + + def _check_scope(self, argname, invoking_scope, requested_scope): + if argname == "request": + return + if scopemismatch(invoking_scope, requested_scope): + # try to report something helpful + lines = self._factorytraceback() + pytest.fail("ScopeMismatch: You tried to access the %r scoped " + "fixture %r with a %r scoped request object, " + "involved factories\n%s" %( + (requested_scope, argname, invoking_scope, "\n".join(lines))), + pytrace=False) + + def _factorytraceback(self): + lines = [] + for fixturedef in self._get_fixturestack(): + factory = fixturedef.func + fs, lineno = getfslineno(factory) + p = self._pyfuncitem.session.fspath.bestrelpath(fs) + args = _format_args(factory) + lines.append("%s:%d: def %s%s" %( + p, lineno, factory.__name__, args)) + return lines + + def _getscopeitem(self, scope): + if scope == "function": + # this might also be a non-function Item despite its attribute name + return self._pyfuncitem + node = get_scope_node(self._pyfuncitem, scope) + if node is None and scope == "class": + # fallback to function item itself + node = self._pyfuncitem + assert node + return node + + def __repr__(self): + return "<FixtureRequest for %r>" %(self.node) + + +class SubRequest(FixtureRequest): + """ a sub request for handling getting a fixture from a + test function/fixture. """ + def __init__(self, request, scope, param, param_index, fixturedef): + self._parent_request = request + self.fixturename = fixturedef.argname + if param is not NOTSET: + self.param = param + self.param_index = param_index + self.scope = scope + self._fixturedef = fixturedef + self.addfinalizer = fixturedef.addfinalizer + self._pyfuncitem = request._pyfuncitem + self._funcargs = request._funcargs + self._fixturedefs = request._fixturedefs + self._arg2fixturedefs = request._arg2fixturedefs + self._arg2index = request._arg2index + self.fixturenames = request.fixturenames + self._fixturemanager = request._fixturemanager + + def __repr__(self): + return "<SubRequest %r for %r>" % (self.fixturename, self._pyfuncitem) + + +class ScopeMismatchError(Exception): + """ A fixture function tries to use a different fixture function which + which has a lower scope (e.g. a Session one calls a function one) + """ + +scopes = "session module class function".split() +scopenum_function = scopes.index("function") +def scopemismatch(currentscope, newscope): + return scopes.index(newscope) > scopes.index(currentscope) + + +class FixtureLookupError(LookupError): + """ could not return a requested Fixture (missing or invalid). """ + def __init__(self, argname, request, msg=None): + self.argname = argname + self.request = request + self.fixturestack = request._get_fixturestack() + self.msg = msg + + def formatrepr(self): + tblines = [] + addline = tblines.append + stack = [self.request._pyfuncitem.obj] + stack.extend(map(lambda x: x.func, self.fixturestack)) + msg = self.msg + if msg is not None: + # the last fixture raise an error, let's present + # it at the requesting side + stack = stack[:-1] + for function in stack: + fspath, lineno = getfslineno(function) + try: + lines, _ = inspect.getsourcelines(get_real_func(function)) + except (IOError, IndexError): + error_msg = "file %s, line %s: source code not available" + addline(error_msg % (fspath, lineno+1)) + else: + addline("file %s, line %s" % (fspath, lineno+1)) + for i, line in enumerate(lines): + line = line.rstrip() + addline(" " + line) + if line.lstrip().startswith('def'): + break + + if msg is None: + fm = self.request._fixturemanager + available = [] + for name, fixturedef in fm._arg2fixturedefs.items(): + parentid = self.request._pyfuncitem.parent.nodeid + faclist = list(fm._matchfactories(fixturedef, parentid)) + if faclist: + available.append(name) + msg = "fixture %r not found" % (self.argname,) + msg += "\n available fixtures: %s" %(", ".join(available),) + msg += "\n use 'py.test --fixtures [testpath]' for help on them." + + return FixtureLookupErrorRepr(fspath, lineno, tblines, msg, self.argname) + +class FixtureLookupErrorRepr(TerminalRepr): + def __init__(self, filename, firstlineno, tblines, errorstring, argname): + self.tblines = tblines + self.errorstring = errorstring + self.filename = filename + self.firstlineno = firstlineno + self.argname = argname + + def toterminal(self, tw): + #tw.line("FixtureLookupError: %s" %(self.argname), red=True) + for tbline in self.tblines: + tw.line(tbline.rstrip()) + for line in self.errorstring.split("\n"): + tw.line(" " + line.strip(), red=True) + tw.line() + tw.line("%s:%d" % (self.filename, self.firstlineno+1)) + +class FixtureManager: + """ + pytest fixtures definitions and information is stored and managed + from this class. + + During collection fm.parsefactories() is called multiple times to parse + fixture function definitions into FixtureDef objects and internal + data structures. + + During collection of test functions, metafunc-mechanics instantiate + a FuncFixtureInfo object which is cached per node/func-name. + This FuncFixtureInfo object is later retrieved by Function nodes + which themselves offer a fixturenames attribute. + + The FuncFixtureInfo object holds information about fixtures and FixtureDefs + relevant for a particular function. An initial list of fixtures is + assembled like this: + + - ini-defined usefixtures + - autouse-marked fixtures along the collection chain up from the function + - usefixtures markers at module/class/function level + - test function funcargs + + Subsequently the funcfixtureinfo.fixturenames attribute is computed + as the closure of the fixtures needed to setup the initial fixtures, + i. e. fixtures needed by fixture functions themselves are appended + to the fixturenames list. + + Upon the test-setup phases all fixturenames are instantiated, retrieved + by a lookup of their FuncFixtureInfo. + """ + + _argprefix = "pytest_funcarg__" + FixtureLookupError = FixtureLookupError + FixtureLookupErrorRepr = FixtureLookupErrorRepr + + def __init__(self, session): + self.session = session + self.config = session.config + self._arg2fixturedefs = {} + self._holderobjseen = set() + self._arg2finish = {} + self._nodeid_and_autousenames = [("", self.config.getini("usefixtures"))] + session.config.pluginmanager.register(self, "funcmanage") + + + def getfixtureinfo(self, node, func, cls, funcargs=True): + if funcargs and not hasattr(node, "nofuncargs"): + if cls is not None: + startindex = 1 + else: + startindex = None + argnames = getfuncargnames(func, startindex) + else: + argnames = () + usefixtures = getattr(func, "usefixtures", None) + initialnames = argnames + if usefixtures is not None: + initialnames = usefixtures.args + initialnames + fm = node.session._fixturemanager + names_closure, arg2fixturedefs = fm.getfixtureclosure(initialnames, + node) + return FuncFixtureInfo(argnames, names_closure, arg2fixturedefs) + + def pytest_plugin_registered(self, plugin): + nodeid = None + try: + p = py.path.local(plugin.__file__) + except AttributeError: + pass + else: + # construct the base nodeid which is later used to check + # what fixtures are visible for particular tests (as denoted + # by their test id) + if p.basename.startswith("conftest.py"): + nodeid = p.dirpath().relto(self.config.rootdir) + if p.sep != "/": + nodeid = nodeid.replace(p.sep, "/") + self.parsefactories(plugin, nodeid) + + def _getautousenames(self, nodeid): + """ return a tuple of fixture names to be used. """ + autousenames = [] + for baseid, basenames in self._nodeid_and_autousenames: + if nodeid.startswith(baseid): + if baseid: + i = len(baseid) + nextchar = nodeid[i:i+1] + if nextchar and nextchar not in ":/": + continue + autousenames.extend(basenames) + # make sure autousenames are sorted by scope, scopenum 0 is session + autousenames.sort( + key=lambda x: self._arg2fixturedefs[x][-1].scopenum) + return autousenames + + def getfixtureclosure(self, fixturenames, parentnode): + # collect the closure of all fixtures , starting with the given + # fixturenames as the initial set. As we have to visit all + # factory definitions anyway, we also return a arg2fixturedefs + # mapping so that the caller can reuse it and does not have + # to re-discover fixturedefs again for each fixturename + # (discovering matching fixtures for a given name/node is expensive) + + parentid = parentnode.nodeid + fixturenames_closure = self._getautousenames(parentid) + def merge(otherlist): + for arg in otherlist: + if arg not in fixturenames_closure: + fixturenames_closure.append(arg) + merge(fixturenames) + arg2fixturedefs = {} + lastlen = -1 + while lastlen != len(fixturenames_closure): + lastlen = len(fixturenames_closure) + for argname in fixturenames_closure: + if argname in arg2fixturedefs: + continue + fixturedefs = self.getfixturedefs(argname, parentid) + if fixturedefs: + arg2fixturedefs[argname] = fixturedefs + merge(fixturedefs[-1].argnames) + return fixturenames_closure, arg2fixturedefs + + def pytest_generate_tests(self, metafunc): + for argname in metafunc.fixturenames: + faclist = metafunc._arg2fixturedefs.get(argname) + if faclist: + fixturedef = faclist[-1] + if fixturedef.params is not None: + func_params = getattr(getattr(metafunc.function, 'parametrize', None), 'args', [[None]]) + # skip directly parametrized arguments + argnames = func_params[0] + if not isinstance(argnames, (tuple, list)): + argnames = [x.strip() for x in argnames.split(",") if x.strip()] + if argname not in func_params and argname not in argnames: + metafunc.parametrize(argname, fixturedef.params, + indirect=True, scope=fixturedef.scope, + ids=fixturedef.ids) + else: + continue # will raise FixtureLookupError at setup time + + def pytest_collection_modifyitems(self, items): + # separate parametrized setups + items[:] = reorder_items(items) + + def parsefactories(self, node_or_obj, nodeid=NOTSET, unittest=False): + if nodeid is not NOTSET: + holderobj = node_or_obj + else: + holderobj = node_or_obj.obj + nodeid = node_or_obj.nodeid + if holderobj in self._holderobjseen: + return + self._holderobjseen.add(holderobj) + autousenames = [] + for name in dir(holderobj): + obj = getattr(holderobj, name, None) + # fixture functions have a pytest_funcarg__ prefix (pre-2.3 style) + # or are "@pytest.fixture" marked + marker = getfixturemarker(obj) + if marker is None: + if not name.startswith(self._argprefix): + continue + if not callable(obj): + continue + marker = defaultfuncargprefixmarker + name = name[len(self._argprefix):] + elif not isinstance(marker, FixtureFunctionMarker): + # magic globals with __getattr__ might have got us a wrong + # fixture attribute + continue + else: + assert not name.startswith(self._argprefix) + fixturedef = FixtureDef(self, nodeid, name, obj, + marker.scope, marker.params, + yieldctx=marker.yieldctx, + unittest=unittest, ids=marker.ids) + faclist = self._arg2fixturedefs.setdefault(name, []) + if fixturedef.has_location: + faclist.append(fixturedef) + else: + # fixturedefs with no location are at the front + # so this inserts the current fixturedef after the + # existing fixturedefs from external plugins but + # before the fixturedefs provided in conftests. + i = len([f for f in faclist if not f.has_location]) + faclist.insert(i, fixturedef) + if marker.autouse: + autousenames.append(name) + if autousenames: + self._nodeid_and_autousenames.append((nodeid or '', autousenames)) + + def getfixturedefs(self, argname, nodeid): + try: + fixturedefs = self._arg2fixturedefs[argname] + except KeyError: + return None + else: + return tuple(self._matchfactories(fixturedefs, nodeid)) + + def _matchfactories(self, fixturedefs, nodeid): + for fixturedef in fixturedefs: + if nodeid.startswith(fixturedef.baseid): + yield fixturedef + + +def fail_fixturefunc(fixturefunc, msg): + fs, lineno = getfslineno(fixturefunc) + location = "%s:%s" % (fs, lineno+1) + source = _pytest._code.Source(fixturefunc) + pytest.fail(msg + ":\n\n" + str(source.indent()) + "\n" + location, + pytrace=False) + +def call_fixture_func(fixturefunc, request, kwargs, yieldctx): + if yieldctx: + if not is_generator(fixturefunc): + fail_fixturefunc(fixturefunc, + msg="yield_fixture requires yield statement in function") + iter = fixturefunc(**kwargs) + next = getattr(iter, "__next__", None) + if next is None: + next = getattr(iter, "next") + res = next() + def teardown(): + try: + next() + except StopIteration: + pass + else: + fail_fixturefunc(fixturefunc, + "yield_fixture function has more than one 'yield'") + request.addfinalizer(teardown) + else: + if is_generator(fixturefunc): + fail_fixturefunc(fixturefunc, + msg="pytest.fixture functions cannot use ``yield``. " + "Instead write and return an inner function/generator " + "and let the consumer call and iterate over it.") + res = fixturefunc(**kwargs) + return res + +class FixtureDef: + """ A container for a factory definition. """ + def __init__(self, fixturemanager, baseid, argname, func, scope, params, + yieldctx, unittest=False, ids=None): + self._fixturemanager = fixturemanager + self.baseid = baseid or '' + self.has_location = baseid is not None + self.func = func + self.argname = argname + self.scope = scope + self.scopenum = scopes.index(scope or "function") + self.params = params + startindex = unittest and 1 or None + self.argnames = getfuncargnames(func, startindex=startindex) + self.yieldctx = yieldctx + self.unittest = unittest + self.ids = ids + self._finalizer = [] + + def addfinalizer(self, finalizer): + self._finalizer.append(finalizer) + + def finish(self): + try: + while self._finalizer: + func = self._finalizer.pop() + func() + finally: + # even if finalization fails, we invalidate + # the cached fixture value + if hasattr(self, "cached_result"): + del self.cached_result + + def execute(self, request): + # get required arguments and register our own finish() + # with their finalization + kwargs = {} + for argname in self.argnames: + fixturedef = request._get_active_fixturedef(argname) + result, arg_cache_key, exc = fixturedef.cached_result + request._check_scope(argname, request.scope, fixturedef.scope) + kwargs[argname] = result + if argname != "request": + fixturedef.addfinalizer(self.finish) + + my_cache_key = request.param_index + cached_result = getattr(self, "cached_result", None) + if cached_result is not None: + result, cache_key, err = cached_result + if my_cache_key == cache_key: + if err is not None: + py.builtin._reraise(*err) + else: + return result + # we have a previous but differently parametrized fixture instance + # so we need to tear it down before creating a new one + self.finish() + assert not hasattr(self, "cached_result") + + fixturefunc = self.func + + if self.unittest: + if request.instance is not None: + # bind the unbound method to the TestCase instance + fixturefunc = self.func.__get__(request.instance) + else: + # the fixture function needs to be bound to the actual + # request.instance so that code working with "self" behaves + # as expected. + if request.instance is not None: + fixturefunc = getimfunc(self.func) + if fixturefunc != self.func: + fixturefunc = fixturefunc.__get__(request.instance) + + try: + result = call_fixture_func(fixturefunc, request, kwargs, + self.yieldctx) + except Exception: + self.cached_result = (None, my_cache_key, sys.exc_info()) + raise + self.cached_result = (result, my_cache_key, None) + return result + + def __repr__(self): + return ("<FixtureDef name=%r scope=%r baseid=%r >" % + (self.argname, self.scope, self.baseid)) + +def num_mock_patch_args(function): + """ return number of arguments used up by mock arguments (if any) """ + patchings = getattr(function, "patchings", None) + if not patchings: + return 0 + mock = sys.modules.get("mock", sys.modules.get("unittest.mock", None)) + if mock is not None: + return len([p for p in patchings + if not p.attribute_name and p.new is mock.DEFAULT]) + return len(patchings) + + +def getfuncargnames(function, startindex=None): + # XXX merge with main.py's varnames + #assert not isclass(function) + realfunction = function + while hasattr(realfunction, "__wrapped__"): + realfunction = realfunction.__wrapped__ + if startindex is None: + startindex = inspect.ismethod(function) and 1 or 0 + if realfunction != function: + startindex += num_mock_patch_args(function) + function = realfunction + if isinstance(function, functools.partial): + argnames = inspect.getargs(_pytest._code.getrawcode(function.func))[0] + partial = function + argnames = argnames[len(partial.args):] + if partial.keywords: + for kw in partial.keywords: + argnames.remove(kw) + else: + argnames = inspect.getargs(_pytest._code.getrawcode(function))[0] + defaults = getattr(function, 'func_defaults', + getattr(function, '__defaults__', None)) or () + numdefaults = len(defaults) + if numdefaults: + return tuple(argnames[startindex:-numdefaults]) + return tuple(argnames[startindex:]) + +# algorithm for sorting on a per-parametrized resource setup basis +# it is called for scopenum==0 (session) first and performs sorting +# down to the lower scopes such as to minimize number of "high scope" +# setups and teardowns + +def reorder_items(items): + argkeys_cache = {} + for scopenum in range(0, scopenum_function): + argkeys_cache[scopenum] = d = {} + for item in items: + keys = set(get_parametrized_fixture_keys(item, scopenum)) + if keys: + d[item] = keys + return reorder_items_atscope(items, set(), argkeys_cache, 0) + +def reorder_items_atscope(items, ignore, argkeys_cache, scopenum): + if scopenum >= scopenum_function or len(items) < 3: + return items + items_done = [] + while 1: + items_before, items_same, items_other, newignore = \ + slice_items(items, ignore, argkeys_cache[scopenum]) + items_before = reorder_items_atscope( + items_before, ignore, argkeys_cache,scopenum+1) + if items_same is None: + # nothing to reorder in this scope + assert items_other is None + return items_done + items_before + items_done.extend(items_before) + items = items_same + items_other + ignore = newignore + + +def slice_items(items, ignore, scoped_argkeys_cache): + # we pick the first item which uses a fixture instance in the + # requested scope and which we haven't seen yet. We slice the input + # items list into a list of items_nomatch, items_same and + # items_other + if scoped_argkeys_cache: # do we need to do work at all? + it = iter(items) + # first find a slicing key + for i, item in enumerate(it): + argkeys = scoped_argkeys_cache.get(item) + if argkeys is not None: + argkeys = argkeys.difference(ignore) + if argkeys: # found a slicing key + slicing_argkey = argkeys.pop() + items_before = items[:i] + items_same = [item] + items_other = [] + # now slice the remainder of the list + for item in it: + argkeys = scoped_argkeys_cache.get(item) + if argkeys and slicing_argkey in argkeys and \ + slicing_argkey not in ignore: + items_same.append(item) + else: + items_other.append(item) + newignore = ignore.copy() + newignore.add(slicing_argkey) + return (items_before, items_same, items_other, newignore) + return items, None, None, None + +def get_parametrized_fixture_keys(item, scopenum): + """ return list of keys for all parametrized arguments which match + the specified scope. """ + assert scopenum < scopenum_function # function + try: + cs = item.callspec + except AttributeError: + pass + else: + # cs.indictes.items() is random order of argnames but + # then again different functions (items) can change order of + # arguments so it doesn't matter much probably + for argname, param_index in cs.indices.items(): + if cs._arg2scopenum[argname] != scopenum: + continue + if scopenum == 0: # session + key = (argname, param_index) + elif scopenum == 1: # module + key = (argname, param_index, item.fspath) + elif scopenum == 2: # class + key = (argname, param_index, item.fspath, item.cls) + yield key + + +def xunitsetup(obj, name): + meth = getattr(obj, name, None) + if getfixturemarker(meth) is None: + return meth + +def getfixturemarker(obj): + """ return fixturemarker or None if it doesn't exist or raised + exceptions.""" + try: + return getattr(obj, "_pytestfixturefunction", None) + except KeyboardInterrupt: + raise + except Exception: + # some objects raise errors like request (from flask import request) + # we don't expect them to be fixture functions + return None + +scopename2class = { + 'class': Class, + 'module': Module, + 'function': pytest.Item, +} +def get_scope_node(node, scope): + cls = scopename2class.get(scope) + if cls is None: + if scope == "session": + return node.session + raise ValueError("unknown scope") + return node.getparent(cls) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/recwarn.py b/testing/web-platform/tests/tools/pytest/_pytest/recwarn.py new file mode 100644 index 000000000..a89474c03 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/recwarn.py @@ -0,0 +1,221 @@ +""" recording warnings during test function execution. """ + +import inspect + +import _pytest._code +import py +import sys +import warnings +import pytest + + +@pytest.yield_fixture +def recwarn(request): + """Return a WarningsRecorder instance that provides these methods: + + * ``pop(category=None)``: return last warning matching the category. + * ``clear()``: clear list of warnings + + See http://docs.python.org/library/warnings.html for information + on warning categories. + """ + wrec = WarningsRecorder() + with wrec: + warnings.simplefilter('default') + yield wrec + + +def pytest_namespace(): + return {'deprecated_call': deprecated_call, + 'warns': warns} + + +def deprecated_call(func=None, *args, **kwargs): + """ assert that calling ``func(*args, **kwargs)`` triggers a + ``DeprecationWarning`` or ``PendingDeprecationWarning``. + + This function can be used as a context manager:: + + >>> with deprecated_call(): + ... myobject.deprecated_method() + + Note: we cannot use WarningsRecorder here because it is still subject + to the mechanism that prevents warnings of the same type from being + triggered twice for the same module. See #1190. + """ + if not func: + return WarningsChecker(expected_warning=DeprecationWarning) + + categories = [] + + def warn_explicit(message, category, *args, **kwargs): + categories.append(category) + old_warn_explicit(message, category, *args, **kwargs) + + def warn(message, category=None, *args, **kwargs): + if isinstance(message, Warning): + categories.append(message.__class__) + else: + categories.append(category) + old_warn(message, category, *args, **kwargs) + + old_warn = warnings.warn + old_warn_explicit = warnings.warn_explicit + warnings.warn_explicit = warn_explicit + warnings.warn = warn + try: + ret = func(*args, **kwargs) + finally: + warnings.warn_explicit = old_warn_explicit + warnings.warn = old_warn + deprecation_categories = (DeprecationWarning, PendingDeprecationWarning) + if not any(issubclass(c, deprecation_categories) for c in categories): + __tracebackhide__ = True + raise AssertionError("%r did not produce DeprecationWarning" % (func,)) + return ret + + +def warns(expected_warning, *args, **kwargs): + """Assert that code raises a particular class of warning. + + Specifically, the input @expected_warning can be a warning class or + tuple of warning classes, and the code must return that warning + (if a single class) or one of those warnings (if a tuple). + + This helper produces a list of ``warnings.WarningMessage`` objects, + one for each warning raised. + + This function can be used as a context manager, or any of the other ways + ``pytest.raises`` can be used:: + + >>> with warns(RuntimeWarning): + ... warnings.warn("my warning", RuntimeWarning) + """ + wcheck = WarningsChecker(expected_warning) + if not args: + return wcheck + elif isinstance(args[0], str): + code, = args + assert isinstance(code, str) + frame = sys._getframe(1) + loc = frame.f_locals.copy() + loc.update(kwargs) + + with wcheck: + code = _pytest._code.Source(code).compile() + py.builtin.exec_(code, frame.f_globals, loc) + else: + func = args[0] + with wcheck: + return func(*args[1:], **kwargs) + + +class RecordedWarning(object): + def __init__(self, message, category, filename, lineno, file, line): + self.message = message + self.category = category + self.filename = filename + self.lineno = lineno + self.file = file + self.line = line + + +class WarningsRecorder(object): + """A context manager to record raised warnings. + + Adapted from `warnings.catch_warnings`. + """ + + def __init__(self, module=None): + self._module = sys.modules['warnings'] if module is None else module + self._entered = False + self._list = [] + + @property + def list(self): + """The list of recorded warnings.""" + return self._list + + def __getitem__(self, i): + """Get a recorded warning by index.""" + return self._list[i] + + def __iter__(self): + """Iterate through the recorded warnings.""" + return iter(self._list) + + def __len__(self): + """The number of recorded warnings.""" + return len(self._list) + + def pop(self, cls=Warning): + """Pop the first recorded warning, raise exception if not exists.""" + for i, w in enumerate(self._list): + if issubclass(w.category, cls): + return self._list.pop(i) + __tracebackhide__ = True + raise AssertionError("%r not found in warning list" % cls) + + def clear(self): + """Clear the list of recorded warnings.""" + self._list[:] = [] + + def __enter__(self): + if self._entered: + __tracebackhide__ = True + raise RuntimeError("Cannot enter %r twice" % self) + self._entered = True + self._filters = self._module.filters + self._module.filters = self._filters[:] + self._showwarning = self._module.showwarning + + def showwarning(message, category, filename, lineno, + file=None, line=None): + self._list.append(RecordedWarning( + message, category, filename, lineno, file, line)) + + # still perform old showwarning functionality + self._showwarning( + message, category, filename, lineno, file=file, line=line) + + self._module.showwarning = showwarning + + # allow the same warning to be raised more than once + + self._module.simplefilter('always') + return self + + def __exit__(self, *exc_info): + if not self._entered: + __tracebackhide__ = True + raise RuntimeError("Cannot exit %r without entering first" % self) + self._module.filters = self._filters + self._module.showwarning = self._showwarning + + +class WarningsChecker(WarningsRecorder): + def __init__(self, expected_warning=None, module=None): + super(WarningsChecker, self).__init__(module=module) + + msg = ("exceptions must be old-style classes or " + "derived from Warning, not %s") + if isinstance(expected_warning, tuple): + for exc in expected_warning: + if not inspect.isclass(exc): + raise TypeError(msg % type(exc)) + elif inspect.isclass(expected_warning): + expected_warning = (expected_warning,) + elif expected_warning is not None: + raise TypeError(msg % type(expected_warning)) + + self.expected_warning = expected_warning + + def __exit__(self, *exc_info): + super(WarningsChecker, self).__exit__(*exc_info) + + # only check if we're not currently handling an exception + if all(a is None for a in exc_info): + if self.expected_warning is not None: + if not any(r.category in self.expected_warning for r in self): + __tracebackhide__ = True + pytest.fail("DID NOT WARN") diff --git a/testing/web-platform/tests/tools/pytest/_pytest/resultlog.py b/testing/web-platform/tests/tools/pytest/_pytest/resultlog.py new file mode 100644 index 000000000..3670f0214 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/resultlog.py @@ -0,0 +1,104 @@ +""" log machine-parseable test session result information in a plain +text file. +""" + +import py +import os + +def pytest_addoption(parser): + group = parser.getgroup("terminal reporting", "resultlog plugin options") + group.addoption('--resultlog', '--result-log', action="store", + metavar="path", default=None, + help="path for machine-readable result log.") + +def pytest_configure(config): + resultlog = config.option.resultlog + # prevent opening resultlog on slave nodes (xdist) + if resultlog and not hasattr(config, 'slaveinput'): + dirname = os.path.dirname(os.path.abspath(resultlog)) + if not os.path.isdir(dirname): + os.makedirs(dirname) + logfile = open(resultlog, 'w', 1) # line buffered + config._resultlog = ResultLog(config, logfile) + config.pluginmanager.register(config._resultlog) + +def pytest_unconfigure(config): + resultlog = getattr(config, '_resultlog', None) + if resultlog: + resultlog.logfile.close() + del config._resultlog + config.pluginmanager.unregister(resultlog) + +def generic_path(item): + chain = item.listchain() + gpath = [chain[0].name] + fspath = chain[0].fspath + fspart = False + for node in chain[1:]: + newfspath = node.fspath + if newfspath == fspath: + if fspart: + gpath.append(':') + fspart = False + else: + gpath.append('.') + else: + gpath.append('/') + fspart = True + name = node.name + if name[0] in '([': + gpath.pop() + gpath.append(name) + fspath = newfspath + return ''.join(gpath) + +class ResultLog(object): + def __init__(self, config, logfile): + self.config = config + self.logfile = logfile # preferably line buffered + + def write_log_entry(self, testpath, lettercode, longrepr): + py.builtin.print_("%s %s" % (lettercode, testpath), file=self.logfile) + for line in longrepr.splitlines(): + py.builtin.print_(" %s" % line, file=self.logfile) + + def log_outcome(self, report, lettercode, longrepr): + testpath = getattr(report, 'nodeid', None) + if testpath is None: + testpath = report.fspath + self.write_log_entry(testpath, lettercode, longrepr) + + def pytest_runtest_logreport(self, report): + if report.when != "call" and report.passed: + return + res = self.config.hook.pytest_report_teststatus(report=report) + code = res[1] + if code == 'x': + longrepr = str(report.longrepr) + elif code == 'X': + longrepr = '' + elif report.passed: + longrepr = "" + elif report.failed: + longrepr = str(report.longrepr) + elif report.skipped: + longrepr = str(report.longrepr[2]) + self.log_outcome(report, code, longrepr) + + def pytest_collectreport(self, report): + if not report.passed: + if report.failed: + code = "F" + longrepr = str(report.longrepr) + else: + assert report.skipped + code = "S" + longrepr = "%s:%d: %s" % report.longrepr + self.log_outcome(report, code, longrepr) + + def pytest_internalerror(self, excrepr): + reprcrash = getattr(excrepr, 'reprcrash', None) + path = getattr(reprcrash, "path", None) + if path is None: + path = "cwd:%s" % py.path.local() + self.write_log_entry(path, '!', str(excrepr)) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/runner.py b/testing/web-platform/tests/tools/pytest/_pytest/runner.py new file mode 100644 index 000000000..cde94c8c8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/runner.py @@ -0,0 +1,515 @@ +""" basic collect and runtest protocol implementations """ +import bdb +import sys +from time import time + +import py +import pytest +from _pytest._code.code import TerminalRepr, ExceptionInfo + + +def pytest_namespace(): + return { + 'fail' : fail, + 'skip' : skip, + 'importorskip' : importorskip, + 'exit' : exit, + } + +# +# pytest plugin hooks + +def pytest_addoption(parser): + group = parser.getgroup("terminal reporting", "reporting", after="general") + group.addoption('--durations', + action="store", type=int, default=None, metavar="N", + help="show N slowest setup/test durations (N=0 for all)."), + +def pytest_terminal_summary(terminalreporter): + durations = terminalreporter.config.option.durations + if durations is None: + return + tr = terminalreporter + dlist = [] + for replist in tr.stats.values(): + for rep in replist: + if hasattr(rep, 'duration'): + dlist.append(rep) + if not dlist: + return + dlist.sort(key=lambda x: x.duration) + dlist.reverse() + if not durations: + tr.write_sep("=", "slowest test durations") + else: + tr.write_sep("=", "slowest %s test durations" % durations) + dlist = dlist[:durations] + + for rep in dlist: + nodeid = rep.nodeid.replace("::()::", "::") + tr.write_line("%02.2fs %-8s %s" % + (rep.duration, rep.when, nodeid)) + +def pytest_sessionstart(session): + session._setupstate = SetupState() +def pytest_sessionfinish(session): + session._setupstate.teardown_all() + +class NodeInfo: + def __init__(self, location): + self.location = location + +def pytest_runtest_protocol(item, nextitem): + item.ihook.pytest_runtest_logstart( + nodeid=item.nodeid, location=item.location, + ) + runtestprotocol(item, nextitem=nextitem) + return True + +def runtestprotocol(item, log=True, nextitem=None): + hasrequest = hasattr(item, "_request") + if hasrequest and not item._request: + item._initrequest() + rep = call_and_report(item, "setup", log) + reports = [rep] + if rep.passed: + reports.append(call_and_report(item, "call", log)) + reports.append(call_and_report(item, "teardown", log, + nextitem=nextitem)) + # after all teardown hooks have been called + # want funcargs and request info to go away + if hasrequest: + item._request = False + item.funcargs = None + return reports + +def pytest_runtest_setup(item): + item.session._setupstate.prepare(item) + +def pytest_runtest_call(item): + try: + item.runtest() + except Exception: + # Store trace info to allow postmortem debugging + type, value, tb = sys.exc_info() + tb = tb.tb_next # Skip *this* frame + sys.last_type = type + sys.last_value = value + sys.last_traceback = tb + del tb # Get rid of it in this namespace + raise + +def pytest_runtest_teardown(item, nextitem): + item.session._setupstate.teardown_exact(item, nextitem) + +def pytest_report_teststatus(report): + if report.when in ("setup", "teardown"): + if report.failed: + # category, shortletter, verbose-word + return "error", "E", "ERROR" + elif report.skipped: + return "skipped", "s", "SKIPPED" + else: + return "", "", "" + + +# +# Implementation + +def call_and_report(item, when, log=True, **kwds): + call = call_runtest_hook(item, when, **kwds) + hook = item.ihook + report = hook.pytest_runtest_makereport(item=item, call=call) + if log: + hook.pytest_runtest_logreport(report=report) + if check_interactive_exception(call, report): + hook.pytest_exception_interact(node=item, call=call, report=report) + return report + +def check_interactive_exception(call, report): + return call.excinfo and not ( + hasattr(report, "wasxfail") or + call.excinfo.errisinstance(skip.Exception) or + call.excinfo.errisinstance(bdb.BdbQuit)) + +def call_runtest_hook(item, when, **kwds): + hookname = "pytest_runtest_" + when + ihook = getattr(item.ihook, hookname) + return CallInfo(lambda: ihook(item=item, **kwds), when=when) + +class CallInfo: + """ Result/Exception info a function invocation. """ + #: None or ExceptionInfo object. + excinfo = None + def __init__(self, func, when): + #: context of invocation: one of "setup", "call", + #: "teardown", "memocollect" + self.when = when + self.start = time() + try: + self.result = func() + except KeyboardInterrupt: + self.stop = time() + raise + except: + self.excinfo = ExceptionInfo() + self.stop = time() + + def __repr__(self): + if self.excinfo: + status = "exception: %s" % str(self.excinfo.value) + else: + status = "result: %r" % (self.result,) + return "<CallInfo when=%r %s>" % (self.when, status) + +def getslaveinfoline(node): + try: + return node._slaveinfocache + except AttributeError: + d = node.slaveinfo + ver = "%s.%s.%s" % d['version_info'][:3] + node._slaveinfocache = s = "[%s] %s -- Python %s %s" % ( + d['id'], d['sysplatform'], ver, d['executable']) + return s + +class BaseReport(object): + + def __init__(self, **kw): + self.__dict__.update(kw) + + def toterminal(self, out): + if hasattr(self, 'node'): + out.line(getslaveinfoline(self.node)) + + longrepr = self.longrepr + if longrepr is None: + return + + if hasattr(longrepr, 'toterminal'): + longrepr.toterminal(out) + else: + try: + out.line(longrepr) + except UnicodeEncodeError: + out.line("<unprintable longrepr>") + + def get_sections(self, prefix): + for name, content in self.sections: + if name.startswith(prefix): + yield prefix, content + + passed = property(lambda x: x.outcome == "passed") + failed = property(lambda x: x.outcome == "failed") + skipped = property(lambda x: x.outcome == "skipped") + + @property + def fspath(self): + return self.nodeid.split("::")[0] + +def pytest_runtest_makereport(item, call): + when = call.when + duration = call.stop-call.start + keywords = dict([(x,1) for x in item.keywords]) + excinfo = call.excinfo + sections = [] + if not call.excinfo: + outcome = "passed" + longrepr = None + else: + if not isinstance(excinfo, ExceptionInfo): + outcome = "failed" + longrepr = excinfo + elif excinfo.errisinstance(pytest.skip.Exception): + outcome = "skipped" + r = excinfo._getreprcrash() + longrepr = (str(r.path), r.lineno, r.message) + else: + outcome = "failed" + if call.when == "call": + longrepr = item.repr_failure(excinfo) + else: # exception in setup or teardown + longrepr = item._repr_failure_py(excinfo, + style=item.config.option.tbstyle) + for rwhen, key, content in item._report_sections: + sections.append(("Captured %s %s" %(key, rwhen), content)) + return TestReport(item.nodeid, item.location, + keywords, outcome, longrepr, when, + sections, duration) + +class TestReport(BaseReport): + """ Basic test report object (also used for setup and teardown calls if + they fail). + """ + def __init__(self, nodeid, location, keywords, outcome, + longrepr, when, sections=(), duration=0, **extra): + #: normalized collection node id + self.nodeid = nodeid + + #: a (filesystempath, lineno, domaininfo) tuple indicating the + #: actual location of a test item - it might be different from the + #: collected one e.g. if a method is inherited from a different module. + self.location = location + + #: a name -> value dictionary containing all keywords and + #: markers associated with a test invocation. + self.keywords = keywords + + #: test outcome, always one of "passed", "failed", "skipped". + self.outcome = outcome + + #: None or a failure representation. + self.longrepr = longrepr + + #: one of 'setup', 'call', 'teardown' to indicate runtest phase. + self.when = when + + #: list of (secname, data) extra information which needs to + #: marshallable + self.sections = list(sections) + + #: time it took to run just the test + self.duration = duration + + self.__dict__.update(extra) + + def __repr__(self): + return "<TestReport %r when=%r outcome=%r>" % ( + self.nodeid, self.when, self.outcome) + +class TeardownErrorReport(BaseReport): + outcome = "failed" + when = "teardown" + def __init__(self, longrepr, **extra): + self.longrepr = longrepr + self.sections = [] + self.__dict__.update(extra) + +def pytest_make_collect_report(collector): + call = CallInfo(collector._memocollect, "memocollect") + longrepr = None + if not call.excinfo: + outcome = "passed" + else: + from _pytest import nose + skip_exceptions = (Skipped,) + nose.get_skip_exceptions() + if call.excinfo.errisinstance(skip_exceptions): + outcome = "skipped" + r = collector._repr_failure_py(call.excinfo, "line").reprcrash + longrepr = (str(r.path), r.lineno, r.message) + else: + outcome = "failed" + errorinfo = collector.repr_failure(call.excinfo) + if not hasattr(errorinfo, "toterminal"): + errorinfo = CollectErrorRepr(errorinfo) + longrepr = errorinfo + rep = CollectReport(collector.nodeid, outcome, longrepr, + getattr(call, 'result', None)) + rep.call = call # see collect_one_node + return rep + + +class CollectReport(BaseReport): + def __init__(self, nodeid, outcome, longrepr, result, + sections=(), **extra): + self.nodeid = nodeid + self.outcome = outcome + self.longrepr = longrepr + self.result = result or [] + self.sections = list(sections) + self.__dict__.update(extra) + + @property + def location(self): + return (self.fspath, None, self.fspath) + + def __repr__(self): + return "<CollectReport %r lenresult=%s outcome=%r>" % ( + self.nodeid, len(self.result), self.outcome) + +class CollectErrorRepr(TerminalRepr): + def __init__(self, msg): + self.longrepr = msg + def toterminal(self, out): + out.line(self.longrepr, red=True) + +class SetupState(object): + """ shared state for setting up/tearing down test items or collectors. """ + def __init__(self): + self.stack = [] + self._finalizers = {} + + def addfinalizer(self, finalizer, colitem): + """ attach a finalizer to the given colitem. + if colitem is None, this will add a finalizer that + is called at the end of teardown_all(). + """ + assert colitem and not isinstance(colitem, tuple) + assert py.builtin.callable(finalizer) + #assert colitem in self.stack # some unit tests don't setup stack :/ + self._finalizers.setdefault(colitem, []).append(finalizer) + + def _pop_and_teardown(self): + colitem = self.stack.pop() + self._teardown_with_finalization(colitem) + + def _callfinalizers(self, colitem): + finalizers = self._finalizers.pop(colitem, None) + exc = None + while finalizers: + fin = finalizers.pop() + try: + fin() + except Exception: + # XXX Only first exception will be seen by user, + # ideally all should be reported. + if exc is None: + exc = sys.exc_info() + if exc: + py.builtin._reraise(*exc) + + def _teardown_with_finalization(self, colitem): + self._callfinalizers(colitem) + if hasattr(colitem, "teardown"): + colitem.teardown() + for colitem in self._finalizers: + assert colitem is None or colitem in self.stack \ + or isinstance(colitem, tuple) + + def teardown_all(self): + while self.stack: + self._pop_and_teardown() + for key in list(self._finalizers): + self._teardown_with_finalization(key) + assert not self._finalizers + + def teardown_exact(self, item, nextitem): + needed_collectors = nextitem and nextitem.listchain() or [] + self._teardown_towards(needed_collectors) + + def _teardown_towards(self, needed_collectors): + while self.stack: + if self.stack == needed_collectors[:len(self.stack)]: + break + self._pop_and_teardown() + + def prepare(self, colitem): + """ setup objects along the collector chain to the test-method + and teardown previously setup objects.""" + needed_collectors = colitem.listchain() + self._teardown_towards(needed_collectors) + + # check if the last collection node has raised an error + for col in self.stack: + if hasattr(col, '_prepare_exc'): + py.builtin._reraise(*col._prepare_exc) + for col in needed_collectors[len(self.stack):]: + self.stack.append(col) + try: + col.setup() + except Exception: + col._prepare_exc = sys.exc_info() + raise + +def collect_one_node(collector): + ihook = collector.ihook + ihook.pytest_collectstart(collector=collector) + rep = ihook.pytest_make_collect_report(collector=collector) + call = rep.__dict__.pop("call", None) + if call and check_interactive_exception(call, rep): + ihook.pytest_exception_interact(node=collector, call=call, report=rep) + return rep + + +# ============================================================= +# Test OutcomeExceptions and helpers for creating them. + + +class OutcomeException(Exception): + """ OutcomeException and its subclass instances indicate and + contain info about test and collection outcomes. + """ + def __init__(self, msg=None, pytrace=True): + Exception.__init__(self, msg) + self.msg = msg + self.pytrace = pytrace + + def __repr__(self): + if self.msg: + val = self.msg + if isinstance(val, bytes): + val = py._builtin._totext(val, errors='replace') + return val + return "<%s instance>" %(self.__class__.__name__,) + __str__ = __repr__ + +class Skipped(OutcomeException): + # XXX hackish: on 3k we fake to live in the builtins + # in order to have Skipped exception printing shorter/nicer + __module__ = 'builtins' + +class Failed(OutcomeException): + """ raised from an explicit call to pytest.fail() """ + __module__ = 'builtins' + +class Exit(KeyboardInterrupt): + """ raised for immediate program exits (no tracebacks/summaries)""" + def __init__(self, msg="unknown reason"): + self.msg = msg + KeyboardInterrupt.__init__(self, msg) + +# exposed helper methods + +def exit(msg): + """ exit testing process as if KeyboardInterrupt was triggered. """ + __tracebackhide__ = True + raise Exit(msg) + +exit.Exception = Exit + +def skip(msg=""): + """ skip an executing test with the given message. Note: it's usually + better to use the pytest.mark.skipif marker to declare a test to be + skipped under certain conditions like mismatching platforms or + dependencies. See the pytest_skipping plugin for details. + """ + __tracebackhide__ = True + raise Skipped(msg=msg) +skip.Exception = Skipped + +def fail(msg="", pytrace=True): + """ explicitly fail an currently-executing test with the given Message. + + :arg pytrace: if false the msg represents the full failure information + and no python traceback will be reported. + """ + __tracebackhide__ = True + raise Failed(msg=msg, pytrace=pytrace) +fail.Exception = Failed + + +def importorskip(modname, minversion=None): + """ return imported module if it has at least "minversion" as its + __version__ attribute. If no minversion is specified the a skip + is only triggered if the module can not be imported. + """ + __tracebackhide__ = True + compile(modname, '', 'eval') # to catch syntaxerrors + try: + __import__(modname) + except ImportError: + skip("could not import %r" %(modname,)) + mod = sys.modules[modname] + if minversion is None: + return mod + verattr = getattr(mod, '__version__', None) + if minversion is not None: + try: + from pkg_resources import parse_version as pv + except ImportError: + skip("we have a required version for %r but can not import " + "no pkg_resources to parse version strings." %(modname,)) + if verattr is None or pv(verattr) < pv(minversion): + skip("module %r has __version__ %r, required is: %r" %( + modname, verattr, minversion)) + return mod + diff --git a/testing/web-platform/tests/tools/pytest/_pytest/skipping.py b/testing/web-platform/tests/tools/pytest/_pytest/skipping.py new file mode 100644 index 000000000..69157f485 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/skipping.py @@ -0,0 +1,354 @@ +""" support for skip/xfail functions and markers. """ +import os +import sys +import traceback + +import py +import pytest +from _pytest.mark import MarkInfo, MarkDecorator + + +def pytest_addoption(parser): + group = parser.getgroup("general") + group.addoption('--runxfail', + action="store_true", dest="runxfail", default=False, + help="run tests even if they are marked xfail") + + parser.addini("xfail_strict", "default for the strict parameter of xfail " + "markers when not given explicitly (default: " + "False)", + default=False, + type="bool") + + +def pytest_configure(config): + if config.option.runxfail: + old = pytest.xfail + config._cleanup.append(lambda: setattr(pytest, "xfail", old)) + def nop(*args, **kwargs): + pass + nop.Exception = XFailed + setattr(pytest, "xfail", nop) + + config.addinivalue_line("markers", + "skipif(condition): skip the given test function if eval(condition) " + "results in a True value. Evaluation happens within the " + "module global context. Example: skipif('sys.platform == \"win32\"') " + "skips the test if we are on the win32 platform. see " + "http://pytest.org/latest/skipping.html" + ) + config.addinivalue_line("markers", + "xfail(condition, reason=None, run=True, raises=None): mark the the test function " + "as an expected failure if eval(condition) has a True value. " + "Optionally specify a reason for better reporting and run=False if " + "you don't even want to execute the test function. If only specific " + "exception(s) are expected, you can list them in raises, and if the test fails " + "in other ways, it will be reported as a true failure. " + "See http://pytest.org/latest/skipping.html" + ) + + +def pytest_namespace(): + return dict(xfail=xfail) + + +class XFailed(pytest.fail.Exception): + """ raised from an explicit call to pytest.xfail() """ + + +def xfail(reason=""): + """ xfail an executing test or setup functions with the given reason.""" + __tracebackhide__ = True + raise XFailed(reason) +xfail.Exception = XFailed + + +class MarkEvaluator: + def __init__(self, item, name): + self.item = item + self.name = name + + @property + def holder(self): + return self.item.keywords.get(self.name) + + def __bool__(self): + return bool(self.holder) + __nonzero__ = __bool__ + + def wasvalid(self): + return not hasattr(self, 'exc') + + def invalidraise(self, exc): + raises = self.get('raises') + if not raises: + return + return not isinstance(exc, raises) + + def istrue(self): + try: + return self._istrue() + except Exception: + self.exc = sys.exc_info() + if isinstance(self.exc[1], SyntaxError): + msg = [" " * (self.exc[1].offset + 4) + "^",] + msg.append("SyntaxError: invalid syntax") + else: + msg = traceback.format_exception_only(*self.exc[:2]) + pytest.fail("Error evaluating %r expression\n" + " %s\n" + "%s" + %(self.name, self.expr, "\n".join(msg)), + pytrace=False) + + def _getglobals(self): + d = {'os': os, 'sys': sys, 'config': self.item.config} + func = self.item.obj + try: + d.update(func.__globals__) + except AttributeError: + d.update(func.func_globals) + return d + + def _istrue(self): + if hasattr(self, 'result'): + return self.result + if self.holder: + d = self._getglobals() + if self.holder.args: + self.result = False + # "holder" might be a MarkInfo or a MarkDecorator; only + # MarkInfo keeps track of all parameters it received in an + # _arglist attribute + if hasattr(self.holder, '_arglist'): + arglist = self.holder._arglist + else: + arglist = [(self.holder.args, self.holder.kwargs)] + for args, kwargs in arglist: + for expr in args: + self.expr = expr + if isinstance(expr, py.builtin._basestring): + result = cached_eval(self.item.config, expr, d) + else: + if "reason" not in kwargs: + # XXX better be checked at collection time + msg = "you need to specify reason=STRING " \ + "when using booleans as conditions." + pytest.fail(msg) + result = bool(expr) + if result: + self.result = True + self.reason = kwargs.get('reason', None) + self.expr = expr + return self.result + else: + self.result = True + return getattr(self, 'result', False) + + def get(self, attr, default=None): + return self.holder.kwargs.get(attr, default) + + def getexplanation(self): + expl = getattr(self, 'reason', None) or self.get('reason', None) + if not expl: + if not hasattr(self, 'expr'): + return "" + else: + return "condition: " + str(self.expr) + return expl + + +@pytest.hookimpl(tryfirst=True) +def pytest_runtest_setup(item): + # Check if skip or skipif are specified as pytest marks + + skipif_info = item.keywords.get('skipif') + if isinstance(skipif_info, (MarkInfo, MarkDecorator)): + eval_skipif = MarkEvaluator(item, 'skipif') + if eval_skipif.istrue(): + item._evalskip = eval_skipif + pytest.skip(eval_skipif.getexplanation()) + + skip_info = item.keywords.get('skip') + if isinstance(skip_info, (MarkInfo, MarkDecorator)): + item._evalskip = True + if 'reason' in skip_info.kwargs: + pytest.skip(skip_info.kwargs['reason']) + elif skip_info.args: + pytest.skip(skip_info.args[0]) + else: + pytest.skip("unconditional skip") + + item._evalxfail = MarkEvaluator(item, 'xfail') + check_xfail_no_run(item) + + +@pytest.mark.hookwrapper +def pytest_pyfunc_call(pyfuncitem): + check_xfail_no_run(pyfuncitem) + outcome = yield + passed = outcome.excinfo is None + if passed: + check_strict_xfail(pyfuncitem) + + +def check_xfail_no_run(item): + """check xfail(run=False)""" + if not item.config.option.runxfail: + evalxfail = item._evalxfail + if evalxfail.istrue(): + if not evalxfail.get('run', True): + pytest.xfail("[NOTRUN] " + evalxfail.getexplanation()) + + +def check_strict_xfail(pyfuncitem): + """check xfail(strict=True) for the given PASSING test""" + evalxfail = pyfuncitem._evalxfail + if evalxfail.istrue(): + strict_default = pyfuncitem.config.getini('xfail_strict') + is_strict_xfail = evalxfail.get('strict', strict_default) + if is_strict_xfail: + del pyfuncitem._evalxfail + explanation = evalxfail.getexplanation() + pytest.fail('[XPASS(strict)] ' + explanation, pytrace=False) + + +@pytest.hookimpl(hookwrapper=True) +def pytest_runtest_makereport(item, call): + outcome = yield + rep = outcome.get_result() + evalxfail = getattr(item, '_evalxfail', None) + evalskip = getattr(item, '_evalskip', None) + # unitttest special case, see setting of _unexpectedsuccess + if hasattr(item, '_unexpectedsuccess') and rep.when == "call": + # we need to translate into how pytest encodes xpass + rep.wasxfail = "reason: " + repr(item._unexpectedsuccess) + rep.outcome = "failed" + elif item.config.option.runxfail: + pass # don't interefere + elif call.excinfo and call.excinfo.errisinstance(pytest.xfail.Exception): + rep.wasxfail = "reason: " + call.excinfo.value.msg + rep.outcome = "skipped" + elif evalxfail and not rep.skipped and evalxfail.wasvalid() and \ + evalxfail.istrue(): + if call.excinfo: + if evalxfail.invalidraise(call.excinfo.value): + rep.outcome = "failed" + else: + rep.outcome = "skipped" + rep.wasxfail = evalxfail.getexplanation() + elif call.when == "call": + rep.outcome = "failed" # xpass outcome + rep.wasxfail = evalxfail.getexplanation() + elif evalskip is not None and rep.skipped and type(rep.longrepr) is tuple: + # skipped by mark.skipif; change the location of the failure + # to point to the item definition, otherwise it will display + # the location of where the skip exception was raised within pytest + filename, line, reason = rep.longrepr + filename, line = item.location[:2] + rep.longrepr = filename, line, reason + +# called by terminalreporter progress reporting +def pytest_report_teststatus(report): + if hasattr(report, "wasxfail"): + if report.skipped: + return "xfailed", "x", "xfail" + elif report.failed: + return "xpassed", "X", ("XPASS", {'yellow': True}) + +# called by the terminalreporter instance/plugin +def pytest_terminal_summary(terminalreporter): + tr = terminalreporter + if not tr.reportchars: + #for name in "xfailed skipped failed xpassed": + # if not tr.stats.get(name, 0): + # tr.write_line("HINT: use '-r' option to see extra " + # "summary info about tests") + # break + return + + lines = [] + for char in tr.reportchars: + if char == "x": + show_xfailed(terminalreporter, lines) + elif char == "X": + show_xpassed(terminalreporter, lines) + elif char in "fF": + show_simple(terminalreporter, lines, 'failed', "FAIL %s") + elif char in "sS": + show_skipped(terminalreporter, lines) + elif char == "E": + show_simple(terminalreporter, lines, 'error', "ERROR %s") + elif char == 'p': + show_simple(terminalreporter, lines, 'passed', "PASSED %s") + + if lines: + tr._tw.sep("=", "short test summary info") + for line in lines: + tr._tw.line(line) + +def show_simple(terminalreporter, lines, stat, format): + failed = terminalreporter.stats.get(stat) + if failed: + for rep in failed: + pos = terminalreporter.config.cwd_relative_nodeid(rep.nodeid) + lines.append(format %(pos,)) + +def show_xfailed(terminalreporter, lines): + xfailed = terminalreporter.stats.get("xfailed") + if xfailed: + for rep in xfailed: + pos = terminalreporter.config.cwd_relative_nodeid(rep.nodeid) + reason = rep.wasxfail + lines.append("XFAIL %s" % (pos,)) + if reason: + lines.append(" " + str(reason)) + +def show_xpassed(terminalreporter, lines): + xpassed = terminalreporter.stats.get("xpassed") + if xpassed: + for rep in xpassed: + pos = terminalreporter.config.cwd_relative_nodeid(rep.nodeid) + reason = rep.wasxfail + lines.append("XPASS %s %s" %(pos, reason)) + +def cached_eval(config, expr, d): + if not hasattr(config, '_evalcache'): + config._evalcache = {} + try: + return config._evalcache[expr] + except KeyError: + import _pytest._code + exprcode = _pytest._code.compile(expr, mode="eval") + config._evalcache[expr] = x = eval(exprcode, d) + return x + + +def folded_skips(skipped): + d = {} + for event in skipped: + key = event.longrepr + assert len(key) == 3, (event, key) + d.setdefault(key, []).append(event) + l = [] + for key, events in d.items(): + l.append((len(events),) + key) + return l + +def show_skipped(terminalreporter, lines): + tr = terminalreporter + skipped = tr.stats.get('skipped', []) + if skipped: + #if not tr.hasopt('skipped'): + # tr.write_line( + # "%d skipped tests, specify -rs for more info" % + # len(skipped)) + # return + fskips = folded_skips(skipped) + if fskips: + #tr.write_sep("_", "skipped test summary") + for num, fspath, lineno, reason in fskips: + if reason.startswith("Skipped: "): + reason = reason[9:] + lines.append("SKIP [%d] %s:%d: %s" % + (num, fspath, lineno, reason)) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/standalonetemplate.py b/testing/web-platform/tests/tools/pytest/_pytest/standalonetemplate.py new file mode 100755 index 000000000..484d5d1b2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/standalonetemplate.py @@ -0,0 +1,89 @@ +#! /usr/bin/env python + +# Hi There! +# You may be wondering what this giant blob of binary data here is, you might +# even be worried that we're up to something nefarious (good for you for being +# paranoid!). This is a base64 encoding of a zip file, this zip file contains +# a fully functional basic pytest script. +# +# Pytest is a thing that tests packages, pytest itself is a package that some- +# one might want to install, especially if they're looking to run tests inside +# some package they want to install. Pytest has a lot of code to collect and +# execute tests, and other such sort of "tribal knowledge" that has been en- +# coded in its code base. Because of this we basically include a basic copy +# of pytest inside this blob. We do this because it let's you as a maintainer +# or application developer who wants people who don't deal with python much to +# easily run tests without installing the complete pytest package. +# +# If you're wondering how this is created: you can create it yourself if you +# have a complete pytest installation by using this command on the command- +# line: ``py.test --genscript=runtests.py``. + +sources = """ +@SOURCES@""" + +import sys +import base64 +import zlib + +class DictImporter(object): + def __init__(self, sources): + self.sources = sources + + def find_module(self, fullname, path=None): + if fullname == "argparse" and sys.version_info >= (2,7): + # we were generated with <python2.7 (which pulls in argparse) + # but we are running now on a stdlib which has it, so use that. + return None + if fullname in self.sources: + return self + if fullname + '.__init__' in self.sources: + return self + return None + + def load_module(self, fullname): + # print "load_module:", fullname + from types import ModuleType + try: + s = self.sources[fullname] + is_pkg = False + except KeyError: + s = self.sources[fullname + '.__init__'] + is_pkg = True + + co = compile(s, fullname, 'exec') + module = sys.modules.setdefault(fullname, ModuleType(fullname)) + module.__file__ = "%s/%s" % (__file__, fullname) + module.__loader__ = self + if is_pkg: + module.__path__ = [fullname] + + do_exec(co, module.__dict__) # noqa + return sys.modules[fullname] + + def get_source(self, name): + res = self.sources.get(name) + if res is None: + res = self.sources.get(name + '.__init__') + return res + +if __name__ == "__main__": + try: + import pkg_resources # noqa + except ImportError: + sys.stderr.write("ERROR: setuptools not installed\n") + sys.exit(2) + if sys.version_info >= (3, 0): + exec("def do_exec(co, loc): exec(co, loc)\n") + import pickle + sources = sources.encode("ascii") # ensure bytes + sources = pickle.loads(zlib.decompress(base64.decodebytes(sources))) + else: + import cPickle as pickle + exec("def do_exec(co, loc): exec co in loc\n") + sources = pickle.loads(zlib.decompress(base64.decodestring(sources))) + + importer = DictImporter(sources) + sys.meta_path.insert(0, importer) + entry = "@ENTRY@" + do_exec(entry, locals()) # noqa diff --git a/testing/web-platform/tests/tools/pytest/_pytest/terminal.py b/testing/web-platform/tests/tools/pytest/_pytest/terminal.py new file mode 100644 index 000000000..825f553ef --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/terminal.py @@ -0,0 +1,593 @@ +""" terminal reporting of the full testing process. + +This is a good source for looking at the various reporting hooks. +""" +from _pytest.main import EXIT_OK, EXIT_TESTSFAILED, EXIT_INTERRUPTED, \ + EXIT_USAGEERROR, EXIT_NOTESTSCOLLECTED +import pytest +import py +import sys +import time +import platform + +import _pytest._pluggy as pluggy + + +def pytest_addoption(parser): + group = parser.getgroup("terminal reporting", "reporting", after="general") + group._addoption('-v', '--verbose', action="count", + dest="verbose", default=0, help="increase verbosity."), + group._addoption('-q', '--quiet', action="count", + dest="quiet", default=0, help="decrease verbosity."), + group._addoption('-r', + action="store", dest="reportchars", default=None, metavar="chars", + help="show extra test summary info as specified by chars (f)ailed, " + "(E)error, (s)skipped, (x)failed, (X)passed (w)pytest-warnings " + "(p)passed, (P)passed with output, (a)all except pP.") + group._addoption('-l', '--showlocals', + action="store_true", dest="showlocals", default=False, + help="show locals in tracebacks (disabled by default).") + group._addoption('--report', + action="store", dest="report", default=None, metavar="opts", + help="(deprecated, use -r)") + group._addoption('--tb', metavar="style", + action="store", dest="tbstyle", default='auto', + choices=['auto', 'long', 'short', 'no', 'line', 'native'], + help="traceback print mode (auto/long/short/line/native/no).") + group._addoption('--fulltrace', '--full-trace', + action="store_true", default=False, + help="don't cut any tracebacks (default is to cut).") + group._addoption('--color', metavar="color", + action="store", dest="color", default='auto', + choices=['yes', 'no', 'auto'], + help="color terminal output (yes/no/auto).") + +def pytest_configure(config): + config.option.verbose -= config.option.quiet + reporter = TerminalReporter(config, sys.stdout) + config.pluginmanager.register(reporter, 'terminalreporter') + if config.option.debug or config.option.traceconfig: + def mywriter(tags, args): + msg = " ".join(map(str, args)) + reporter.write_line("[traceconfig] " + msg) + config.trace.root.setprocessor("pytest:config", mywriter) + +def getreportopt(config): + reportopts = "" + optvalue = config.option.report + if optvalue: + py.builtin.print_("DEPRECATED: use -r instead of --report option.", + file=sys.stderr) + if optvalue: + for setting in optvalue.split(","): + setting = setting.strip() + if setting == "skipped": + reportopts += "s" + elif setting == "xfailed": + reportopts += "x" + reportchars = config.option.reportchars + if reportchars: + for char in reportchars: + if char not in reportopts and char != 'a': + reportopts += char + elif char == 'a': + reportopts = 'fEsxXw' + return reportopts + +def pytest_report_teststatus(report): + if report.passed: + letter = "." + elif report.skipped: + letter = "s" + elif report.failed: + letter = "F" + if report.when != "call": + letter = "f" + return report.outcome, letter, report.outcome.upper() + +class WarningReport: + def __init__(self, code, message, nodeid=None, fslocation=None): + self.code = code + self.message = message + self.nodeid = nodeid + self.fslocation = fslocation + + +class TerminalReporter: + def __init__(self, config, file=None): + import _pytest.config + self.config = config + self.verbosity = self.config.option.verbose + self.showheader = self.verbosity >= 0 + self.showfspath = self.verbosity >= 0 + self.showlongtestinfo = self.verbosity > 0 + self._numcollected = 0 + + self.stats = {} + self.startdir = py.path.local() + if file is None: + file = sys.stdout + self._tw = self.writer = _pytest.config.create_terminal_writer(config, + file) + self.currentfspath = None + self.reportchars = getreportopt(config) + self.hasmarkup = self._tw.hasmarkup + self.isatty = file.isatty() + + def hasopt(self, char): + char = {'xfailed': 'x', 'skipped': 's'}.get(char, char) + return char in self.reportchars + + def write_fspath_result(self, nodeid, res): + fspath = self.config.rootdir.join(nodeid.split("::")[0]) + if fspath != self.currentfspath: + self.currentfspath = fspath + fspath = self.startdir.bestrelpath(fspath) + self._tw.line() + self._tw.write(fspath + " ") + self._tw.write(res) + + def write_ensure_prefix(self, prefix, extra="", **kwargs): + if self.currentfspath != prefix: + self._tw.line() + self.currentfspath = prefix + self._tw.write(prefix) + if extra: + self._tw.write(extra, **kwargs) + self.currentfspath = -2 + + def ensure_newline(self): + if self.currentfspath: + self._tw.line() + self.currentfspath = None + + def write(self, content, **markup): + self._tw.write(content, **markup) + + def write_line(self, line, **markup): + if not py.builtin._istext(line): + line = py.builtin.text(line, errors="replace") + self.ensure_newline() + self._tw.line(line, **markup) + + def rewrite(self, line, **markup): + line = str(line) + self._tw.write("\r" + line, **markup) + + def write_sep(self, sep, title=None, **markup): + self.ensure_newline() + self._tw.sep(sep, title, **markup) + + def section(self, title, sep="=", **kw): + self._tw.sep(sep, title, **kw) + + def line(self, msg, **kw): + self._tw.line(msg, **kw) + + def pytest_internalerror(self, excrepr): + for line in py.builtin.text(excrepr).split("\n"): + self.write_line("INTERNALERROR> " + line) + return 1 + + def pytest_logwarning(self, code, fslocation, message, nodeid): + warnings = self.stats.setdefault("warnings", []) + if isinstance(fslocation, tuple): + fslocation = "%s:%d" % fslocation + warning = WarningReport(code=code, fslocation=fslocation, + message=message, nodeid=nodeid) + warnings.append(warning) + + def pytest_plugin_registered(self, plugin): + if self.config.option.traceconfig: + msg = "PLUGIN registered: %s" % (plugin,) + # XXX this event may happen during setup/teardown time + # which unfortunately captures our output here + # which garbles our output if we use self.write_line + self.write_line(msg) + + def pytest_deselected(self, items): + self.stats.setdefault('deselected', []).extend(items) + + def pytest_runtest_logstart(self, nodeid, location): + # ensure that the path is printed before the + # 1st test of a module starts running + if self.showlongtestinfo: + line = self._locationline(nodeid, *location) + self.write_ensure_prefix(line, "") + elif self.showfspath: + fsid = nodeid.split("::")[0] + self.write_fspath_result(fsid, "") + + def pytest_runtest_logreport(self, report): + rep = report + res = self.config.hook.pytest_report_teststatus(report=rep) + cat, letter, word = res + self.stats.setdefault(cat, []).append(rep) + self._tests_ran = True + if not letter and not word: + # probably passed setup/teardown + return + if self.verbosity <= 0: + if not hasattr(rep, 'node') and self.showfspath: + self.write_fspath_result(rep.nodeid, letter) + else: + self._tw.write(letter) + else: + if isinstance(word, tuple): + word, markup = word + else: + if rep.passed: + markup = {'green':True} + elif rep.failed: + markup = {'red':True} + elif rep.skipped: + markup = {'yellow':True} + line = self._locationline(rep.nodeid, *rep.location) + if not hasattr(rep, 'node'): + self.write_ensure_prefix(line, word, **markup) + #self._tw.write(word, **markup) + else: + self.ensure_newline() + if hasattr(rep, 'node'): + self._tw.write("[%s] " % rep.node.gateway.id) + self._tw.write(word, **markup) + self._tw.write(" " + line) + self.currentfspath = -2 + + def pytest_collection(self): + if not self.isatty and self.config.option.verbose >= 1: + self.write("collecting ... ", bold=True) + + def pytest_collectreport(self, report): + if report.failed: + self.stats.setdefault("error", []).append(report) + elif report.skipped: + self.stats.setdefault("skipped", []).append(report) + items = [x for x in report.result if isinstance(x, pytest.Item)] + self._numcollected += len(items) + if self.isatty: + #self.write_fspath_result(report.nodeid, 'E') + self.report_collect() + + def report_collect(self, final=False): + if self.config.option.verbose < 0: + return + + errors = len(self.stats.get('error', [])) + skipped = len(self.stats.get('skipped', [])) + if final: + line = "collected " + else: + line = "collecting " + line += str(self._numcollected) + " items" + if errors: + line += " / %d errors" % errors + if skipped: + line += " / %d skipped" % skipped + if self.isatty: + if final: + line += " \n" + self.rewrite(line, bold=True) + else: + self.write_line(line) + + def pytest_collection_modifyitems(self): + self.report_collect(True) + + @pytest.hookimpl(trylast=True) + def pytest_sessionstart(self, session): + self._sessionstarttime = time.time() + if not self.showheader: + return + self.write_sep("=", "test session starts", bold=True) + verinfo = platform.python_version() + msg = "platform %s -- Python %s" % (sys.platform, verinfo) + if hasattr(sys, 'pypy_version_info'): + verinfo = ".".join(map(str, sys.pypy_version_info[:3])) + msg += "[pypy-%s-%s]" % (verinfo, sys.pypy_version_info[3]) + msg += ", pytest-%s, py-%s, pluggy-%s" % ( + pytest.__version__, py.__version__, pluggy.__version__) + if self.verbosity > 0 or self.config.option.debug or \ + getattr(self.config.option, 'pastebin', None): + msg += " -- " + str(sys.executable) + self.write_line(msg) + lines = self.config.hook.pytest_report_header( + config=self.config, startdir=self.startdir) + lines.reverse() + for line in flatten(lines): + self.write_line(line) + + def pytest_report_header(self, config): + inifile = "" + if config.inifile: + inifile = config.rootdir.bestrelpath(config.inifile) + lines = ["rootdir: %s, inifile: %s" %(config.rootdir, inifile)] + + plugininfo = config.pluginmanager.list_plugin_distinfo() + if plugininfo: + + lines.append( + "plugins: %s" % ", ".join(_plugin_nameversions(plugininfo))) + return lines + + def pytest_collection_finish(self, session): + if self.config.option.collectonly: + self._printcollecteditems(session.items) + if self.stats.get('failed'): + self._tw.sep("!", "collection failures") + for rep in self.stats.get('failed'): + rep.toterminal(self._tw) + return 1 + return 0 + if not self.showheader: + return + #for i, testarg in enumerate(self.config.args): + # self.write_line("test path %d: %s" %(i+1, testarg)) + + def _printcollecteditems(self, items): + # to print out items and their parent collectors + # we take care to leave out Instances aka () + # because later versions are going to get rid of them anyway + if self.config.option.verbose < 0: + if self.config.option.verbose < -1: + counts = {} + for item in items: + name = item.nodeid.split('::', 1)[0] + counts[name] = counts.get(name, 0) + 1 + for name, count in sorted(counts.items()): + self._tw.line("%s: %d" % (name, count)) + else: + for item in items: + nodeid = item.nodeid + nodeid = nodeid.replace("::()::", "::") + self._tw.line(nodeid) + return + stack = [] + indent = "" + for item in items: + needed_collectors = item.listchain()[1:] # strip root node + while stack: + if stack == needed_collectors[:len(stack)]: + break + stack.pop() + for col in needed_collectors[len(stack):]: + stack.append(col) + #if col.name == "()": + # continue + indent = (len(stack) - 1) * " " + self._tw.line("%s%s" % (indent, col)) + + @pytest.hookimpl(hookwrapper=True) + def pytest_sessionfinish(self, exitstatus): + outcome = yield + outcome.get_result() + self._tw.line("") + summary_exit_codes = ( + EXIT_OK, EXIT_TESTSFAILED, EXIT_INTERRUPTED, EXIT_USAGEERROR, + EXIT_NOTESTSCOLLECTED) + if exitstatus in summary_exit_codes: + self.config.hook.pytest_terminal_summary(terminalreporter=self) + self.summary_errors() + self.summary_failures() + self.summary_warnings() + self.summary_passes() + if exitstatus == EXIT_INTERRUPTED: + self._report_keyboardinterrupt() + del self._keyboardinterrupt_memo + self.summary_deselected() + self.summary_stats() + + def pytest_keyboard_interrupt(self, excinfo): + self._keyboardinterrupt_memo = excinfo.getrepr(funcargs=True) + + def pytest_unconfigure(self): + if hasattr(self, '_keyboardinterrupt_memo'): + self._report_keyboardinterrupt() + + def _report_keyboardinterrupt(self): + excrepr = self._keyboardinterrupt_memo + msg = excrepr.reprcrash.message + self.write_sep("!", msg) + if "KeyboardInterrupt" in msg: + if self.config.option.fulltrace: + excrepr.toterminal(self._tw) + else: + self._tw.line("to show a full traceback on KeyboardInterrupt use --fulltrace", yellow=True) + excrepr.reprcrash.toterminal(self._tw) + + def _locationline(self, nodeid, fspath, lineno, domain): + def mkrel(nodeid): + line = self.config.cwd_relative_nodeid(nodeid) + if domain and line.endswith(domain): + line = line[:-len(domain)] + l = domain.split("[") + l[0] = l[0].replace('.', '::') # don't replace '.' in params + line += "[".join(l) + return line + # collect_fspath comes from testid which has a "/"-normalized path + + if fspath: + res = mkrel(nodeid).replace("::()", "") # parens-normalization + if nodeid.split("::")[0] != fspath.replace("\\", "/"): + res += " <- " + self.startdir.bestrelpath(fspath) + else: + res = "[location]" + return res + " " + + def _getfailureheadline(self, rep): + if hasattr(rep, 'location'): + fspath, lineno, domain = rep.location + return domain + else: + return "test session" # XXX? + + def _getcrashline(self, rep): + try: + return str(rep.longrepr.reprcrash) + except AttributeError: + try: + return str(rep.longrepr)[:50] + except AttributeError: + return "" + + # + # summaries for sessionfinish + # + def getreports(self, name): + l = [] + for x in self.stats.get(name, []): + if not hasattr(x, '_pdbshown'): + l.append(x) + return l + + def summary_warnings(self): + if self.hasopt("w"): + warnings = self.stats.get("warnings") + if not warnings: + return + self.write_sep("=", "pytest-warning summary") + for w in warnings: + self._tw.line("W%s %s %s" % (w.code, + w.fslocation, w.message)) + + def summary_passes(self): + if self.config.option.tbstyle != "no": + if self.hasopt("P"): + reports = self.getreports('passed') + if not reports: + return + self.write_sep("=", "PASSES") + for rep in reports: + msg = self._getfailureheadline(rep) + self.write_sep("_", msg) + self._outrep_summary(rep) + + def summary_failures(self): + if self.config.option.tbstyle != "no": + reports = self.getreports('failed') + if not reports: + return + self.write_sep("=", "FAILURES") + for rep in reports: + if self.config.option.tbstyle == "line": + line = self._getcrashline(rep) + self.write_line(line) + else: + msg = self._getfailureheadline(rep) + markup = {'red': True, 'bold': True} + self.write_sep("_", msg, **markup) + self._outrep_summary(rep) + + def summary_errors(self): + if self.config.option.tbstyle != "no": + reports = self.getreports('error') + if not reports: + return + self.write_sep("=", "ERRORS") + for rep in self.stats['error']: + msg = self._getfailureheadline(rep) + if not hasattr(rep, 'when'): + # collect + msg = "ERROR collecting " + msg + elif rep.when == "setup": + msg = "ERROR at setup of " + msg + elif rep.when == "teardown": + msg = "ERROR at teardown of " + msg + self.write_sep("_", msg) + self._outrep_summary(rep) + + def _outrep_summary(self, rep): + rep.toterminal(self._tw) + for secname, content in rep.sections: + self._tw.sep("-", secname) + if content[-1:] == "\n": + content = content[:-1] + self._tw.line(content) + + def summary_stats(self): + session_duration = time.time() - self._sessionstarttime + (line, color) = build_summary_stats_line(self.stats) + msg = "%s in %.2f seconds" % (line, session_duration) + markup = {color: True, 'bold': True} + + if self.verbosity >= 0: + self.write_sep("=", msg, **markup) + if self.verbosity == -1: + self.write_line(msg, **markup) + + def summary_deselected(self): + if 'deselected' in self.stats: + l = [] + k = self.config.option.keyword + if k: + l.append("-k%s" % k) + m = self.config.option.markexpr + if m: + l.append("-m %r" % m) + if l: + self.write_sep("=", "%d tests deselected by %r" % ( + len(self.stats['deselected']), " ".join(l)), bold=True) + +def repr_pythonversion(v=None): + if v is None: + v = sys.version_info + try: + return "%s.%s.%s-%s-%s" % v + except (TypeError, ValueError): + return str(v) + +def flatten(l): + for x in l: + if isinstance(x, (list, tuple)): + for y in flatten(x): + yield y + else: + yield x + +def build_summary_stats_line(stats): + keys = ("failed passed skipped deselected " + "xfailed xpassed warnings error").split() + key_translation = {'warnings': 'pytest-warnings'} + unknown_key_seen = False + for key in stats.keys(): + if key not in keys: + if key: # setup/teardown reports have an empty key, ignore them + keys.append(key) + unknown_key_seen = True + parts = [] + for key in keys: + val = stats.get(key, None) + if val: + key_name = key_translation.get(key, key) + parts.append("%d %s" % (len(val), key_name)) + + if parts: + line = ", ".join(parts) + else: + line = "no tests ran" + + if 'failed' in stats or 'error' in stats: + color = 'red' + elif 'warnings' in stats or unknown_key_seen: + color = 'yellow' + elif 'passed' in stats: + color = 'green' + else: + color = 'yellow' + + return (line, color) + + +def _plugin_nameversions(plugininfo): + l = [] + for plugin, dist in plugininfo: + # gets us name and version! + name = '{dist.project_name}-{dist.version}'.format(dist=dist) + # questionable convenience, but it keeps things short + if name.startswith("pytest-"): + name = name[7:] + # we decided to print python package names + # they can have more than one plugin + if name not in l: + l.append(name) + return l diff --git a/testing/web-platform/tests/tools/pytest/_pytest/tmpdir.py b/testing/web-platform/tests/tools/pytest/_pytest/tmpdir.py new file mode 100644 index 000000000..ebc48dbe5 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/tmpdir.py @@ -0,0 +1,123 @@ +""" support for providing temporary directories to test functions. """ +import re + +import pytest +import py +from _pytest.monkeypatch import monkeypatch + + +class TempdirFactory: + """Factory for temporary directories under the common base temp directory. + + The base directory can be configured using the ``--basetemp`` option. + """ + + def __init__(self, config): + self.config = config + self.trace = config.trace.get("tmpdir") + + def ensuretemp(self, string, dir=1): + """ (deprecated) return temporary directory path with + the given string as the trailing part. It is usually + better to use the 'tmpdir' function argument which + provides an empty unique-per-test-invocation directory + and is guaranteed to be empty. + """ + #py.log._apiwarn(">1.1", "use tmpdir function argument") + return self.getbasetemp().ensure(string, dir=dir) + + def mktemp(self, basename, numbered=True): + """Create a subdirectory of the base temporary directory and return it. + If ``numbered``, ensure the directory is unique by adding a number + prefix greater than any existing one. + """ + basetemp = self.getbasetemp() + if not numbered: + p = basetemp.mkdir(basename) + else: + p = py.path.local.make_numbered_dir(prefix=basename, + keep=0, rootdir=basetemp, lock_timeout=None) + self.trace("mktemp", p) + return p + + def getbasetemp(self): + """ return base temporary directory. """ + try: + return self._basetemp + except AttributeError: + basetemp = self.config.option.basetemp + if basetemp: + basetemp = py.path.local(basetemp) + if basetemp.check(): + basetemp.remove() + basetemp.mkdir() + else: + temproot = py.path.local.get_temproot() + user = get_user() + if user: + # use a sub-directory in the temproot to speed-up + # make_numbered_dir() call + rootdir = temproot.join('pytest-of-%s' % user) + else: + rootdir = temproot + rootdir.ensure(dir=1) + basetemp = py.path.local.make_numbered_dir(prefix='pytest-', + rootdir=rootdir) + self._basetemp = t = basetemp.realpath() + self.trace("new basetemp", t) + return t + + def finish(self): + self.trace("finish") + + +def get_user(): + """Return the current user name, or None if getuser() does not work + in the current environment (see #1010). + """ + import getpass + try: + return getpass.getuser() + except (ImportError, KeyError): + return None + +# backward compatibility +TempdirHandler = TempdirFactory + + +def pytest_configure(config): + """Create a TempdirFactory and attach it to the config object. + + This is to comply with existing plugins which expect the handler to be + available at pytest_configure time, but ideally should be moved entirely + to the tmpdir_factory session fixture. + """ + mp = monkeypatch() + t = TempdirFactory(config) + config._cleanup.extend([mp.undo, t.finish]) + mp.setattr(config, '_tmpdirhandler', t, raising=False) + mp.setattr(pytest, 'ensuretemp', t.ensuretemp, raising=False) + + +@pytest.fixture(scope='session') +def tmpdir_factory(request): + """Return a TempdirFactory instance for the test session. + """ + return request.config._tmpdirhandler + + +@pytest.fixture +def tmpdir(request, tmpdir_factory): + """return a temporary directory path object + which is unique to each test function invocation, + created as a sub directory of the base temporary + directory. The returned object is a `py.path.local`_ + path object. + """ + name = request.node.name + name = re.sub("[\W]", "_", name) + MAXVAL = 30 + if len(name) > MAXVAL: + name = name[:MAXVAL] + x = tmpdir_factory.mktemp(name, numbered=True) + return x diff --git a/testing/web-platform/tests/tools/pytest/_pytest/unittest.py b/testing/web-platform/tests/tools/pytest/_pytest/unittest.py new file mode 100644 index 000000000..8120e94fb --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/unittest.py @@ -0,0 +1,205 @@ +""" discovery and running of std-library "unittest" style tests. """ +from __future__ import absolute_import + +import sys +import traceback + +import pytest +# for transfering markers +import _pytest._code +from _pytest.python import transfer_markers +from _pytest.skipping import MarkEvaluator + + +def pytest_pycollect_makeitem(collector, name, obj): + # has unittest been imported and is obj a subclass of its TestCase? + try: + if not issubclass(obj, sys.modules["unittest"].TestCase): + return + except Exception: + return + # yes, so let's collect it + return UnitTestCase(name, parent=collector) + + +class UnitTestCase(pytest.Class): + # marker for fixturemanger.getfixtureinfo() + # to declare that our children do not support funcargs + nofuncargs = True + + def setup(self): + cls = self.obj + if getattr(cls, '__unittest_skip__', False): + return # skipped + setup = getattr(cls, 'setUpClass', None) + if setup is not None: + setup() + teardown = getattr(cls, 'tearDownClass', None) + if teardown is not None: + self.addfinalizer(teardown) + super(UnitTestCase, self).setup() + + def collect(self): + from unittest import TestLoader + cls = self.obj + if not getattr(cls, "__test__", True): + return + self.session._fixturemanager.parsefactories(self, unittest=True) + loader = TestLoader() + module = self.getparent(pytest.Module).obj + foundsomething = False + for name in loader.getTestCaseNames(self.obj): + x = getattr(self.obj, name) + funcobj = getattr(x, 'im_func', x) + transfer_markers(funcobj, cls, module) + yield TestCaseFunction(name, parent=self) + foundsomething = True + + if not foundsomething: + runtest = getattr(self.obj, 'runTest', None) + if runtest is not None: + ut = sys.modules.get("twisted.trial.unittest", None) + if ut is None or runtest != ut.TestCase.runTest: + yield TestCaseFunction('runTest', parent=self) + + + +class TestCaseFunction(pytest.Function): + _excinfo = None + + def setup(self): + self._testcase = self.parent.obj(self.name) + self._fix_unittest_skip_decorator() + self._obj = getattr(self._testcase, self.name) + if hasattr(self._testcase, 'setup_method'): + self._testcase.setup_method(self._obj) + if hasattr(self, "_request"): + self._request._fillfixtures() + + def _fix_unittest_skip_decorator(self): + """ + The @unittest.skip decorator calls functools.wraps(self._testcase) + The call to functools.wraps() fails unless self._testcase + has a __name__ attribute. This is usually automatically supplied + if the test is a function or method, but we need to add manually + here. + + See issue #1169 + """ + if sys.version_info[0] == 2: + setattr(self._testcase, "__name__", self.name) + + def teardown(self): + if hasattr(self._testcase, 'teardown_method'): + self._testcase.teardown_method(self._obj) + + def startTest(self, testcase): + pass + + def _addexcinfo(self, rawexcinfo): + # unwrap potential exception info (see twisted trial support below) + rawexcinfo = getattr(rawexcinfo, '_rawexcinfo', rawexcinfo) + try: + excinfo = _pytest._code.ExceptionInfo(rawexcinfo) + except TypeError: + try: + try: + l = traceback.format_exception(*rawexcinfo) + l.insert(0, "NOTE: Incompatible Exception Representation, " + "displaying natively:\n\n") + pytest.fail("".join(l), pytrace=False) + except (pytest.fail.Exception, KeyboardInterrupt): + raise + except: + pytest.fail("ERROR: Unknown Incompatible Exception " + "representation:\n%r" %(rawexcinfo,), pytrace=False) + except KeyboardInterrupt: + raise + except pytest.fail.Exception: + excinfo = _pytest._code.ExceptionInfo() + self.__dict__.setdefault('_excinfo', []).append(excinfo) + + def addError(self, testcase, rawexcinfo): + self._addexcinfo(rawexcinfo) + def addFailure(self, testcase, rawexcinfo): + self._addexcinfo(rawexcinfo) + + def addSkip(self, testcase, reason): + try: + pytest.skip(reason) + except pytest.skip.Exception: + self._evalskip = MarkEvaluator(self, 'SkipTest') + self._evalskip.result = True + self._addexcinfo(sys.exc_info()) + + def addExpectedFailure(self, testcase, rawexcinfo, reason=""): + try: + pytest.xfail(str(reason)) + except pytest.xfail.Exception: + self._addexcinfo(sys.exc_info()) + + def addUnexpectedSuccess(self, testcase, reason=""): + self._unexpectedsuccess = reason + + def addSuccess(self, testcase): + pass + + def stopTest(self, testcase): + pass + + def runtest(self): + self._testcase(result=self) + + def _prunetraceback(self, excinfo): + pytest.Function._prunetraceback(self, excinfo) + traceback = excinfo.traceback.filter( + lambda x:not x.frame.f_globals.get('__unittest')) + if traceback: + excinfo.traceback = traceback + +@pytest.hookimpl(tryfirst=True) +def pytest_runtest_makereport(item, call): + if isinstance(item, TestCaseFunction): + if item._excinfo: + call.excinfo = item._excinfo.pop(0) + try: + del call.result + except AttributeError: + pass + +# twisted trial support + +@pytest.hookimpl(hookwrapper=True) +def pytest_runtest_protocol(item): + if isinstance(item, TestCaseFunction) and \ + 'twisted.trial.unittest' in sys.modules: + ut = sys.modules['twisted.python.failure'] + Failure__init__ = ut.Failure.__init__ + check_testcase_implements_trial_reporter() + def excstore(self, exc_value=None, exc_type=None, exc_tb=None, + captureVars=None): + if exc_value is None: + self._rawexcinfo = sys.exc_info() + else: + if exc_type is None: + exc_type = type(exc_value) + self._rawexcinfo = (exc_type, exc_value, exc_tb) + try: + Failure__init__(self, exc_value, exc_type, exc_tb, + captureVars=captureVars) + except TypeError: + Failure__init__(self, exc_value, exc_type, exc_tb) + ut.Failure.__init__ = excstore + yield + ut.Failure.__init__ = Failure__init__ + else: + yield + + +def check_testcase_implements_trial_reporter(done=[]): + if done: + return + from zope.interface import classImplements + from twisted.trial.itrial import IReporter + classImplements(TestCaseFunction, IReporter) + done.append(1) diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/README.md b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/README.md new file mode 100644 index 000000000..eab7c714f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/README.md @@ -0,0 +1,13 @@ +This directory vendors the `pluggy` module. + +For a more detailed discussion for the reasons to vendoring this +package, please see [this issue](https://github.com/pytest-dev/pytest/issues/944). + +To update the current version, execute: + +``` +$ pip install -U pluggy==<version> --no-compile --target=_pytest/vendored_packages +``` + +And commit the modified files. The `pluggy-<version>.dist-info` directory +created by `pip` should be ignored. diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/__init__.py b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/__init__.py new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/__init__.py diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/DESCRIPTION.rst b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/DESCRIPTION.rst new file mode 100644 index 000000000..aa3bbf812 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/DESCRIPTION.rst @@ -0,0 +1,10 @@ +Plugin registration and hook calling for Python +=============================================== + +This is the plugin manager as used by pytest but stripped +of pytest specific details. + +During the 0.x series this plugin does not have much documentation +except extensive docstrings in the pluggy.py module. + + diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/METADATA b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/METADATA new file mode 100644 index 000000000..ec81f0a6b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/METADATA @@ -0,0 +1,39 @@ +Metadata-Version: 2.0 +Name: pluggy +Version: 0.3.1 +Summary: plugin and hook calling mechanisms for python +Home-page: UNKNOWN +Author: Holger Krekel +Author-email: holger at merlinux.eu +License: MIT license +Platform: unix +Platform: linux +Platform: osx +Platform: win32 +Classifier: Development Status :: 4 - Beta +Classifier: Intended Audience :: Developers +Classifier: License :: OSI Approved :: MIT License +Classifier: Operating System :: POSIX +Classifier: Operating System :: Microsoft :: Windows +Classifier: Operating System :: MacOS :: MacOS X +Classifier: Topic :: Software Development :: Testing +Classifier: Topic :: Software Development :: Libraries +Classifier: Topic :: Utilities +Classifier: Programming Language :: Python :: 2 +Classifier: Programming Language :: Python :: 2.6 +Classifier: Programming Language :: Python :: 2.7 +Classifier: Programming Language :: Python :: 3 +Classifier: Programming Language :: Python :: 3.3 +Classifier: Programming Language :: Python :: 3.4 +Classifier: Programming Language :: Python :: 3.5 + +Plugin registration and hook calling for Python +=============================================== + +This is the plugin manager as used by pytest but stripped +of pytest specific details. + +During the 0.x series this plugin does not have much documentation +except extensive docstrings in the pluggy.py module. + + diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/RECORD b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/RECORD new file mode 100644 index 000000000..9626673c4 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/RECORD @@ -0,0 +1,8 @@ +pluggy.py,sha256=v_RfWzyW6DPU1cJu_EFoL_OHq3t13qloVdR6UaMCXQA,29862 +pluggy-0.3.1.dist-info/top_level.txt,sha256=xKSCRhai-v9MckvMuWqNz16c1tbsmOggoMSwTgcpYHE,7 +pluggy-0.3.1.dist-info/pbr.json,sha256=xX3s6__wOcAyF-AZJX1sdZyW6PUXT-FkfBlM69EEUCg,47 +pluggy-0.3.1.dist-info/RECORD,, +pluggy-0.3.1.dist-info/metadata.json,sha256=nLKltOT78dMV-00uXD6Aeemp4xNsz2q59j6ORSDeLjw,1027 +pluggy-0.3.1.dist-info/METADATA,sha256=1b85Ho2u4iK30M099k7axMzcDDhLcIMb-A82JUJZnSo,1334 +pluggy-0.3.1.dist-info/WHEEL,sha256=AvR0WeTpDaxT645bl5FQxUK6NPsTls2ttpcGJg3j1Xg,110 +pluggy-0.3.1.dist-info/DESCRIPTION.rst,sha256=P5Akh1EdIBR6CeqtV2P8ZwpGSpZiTKPw0NyS7jEiD-g,306 diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/WHEEL b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/WHEEL new file mode 100644 index 000000000..9dff69d86 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/WHEEL @@ -0,0 +1,6 @@ +Wheel-Version: 1.0 +Generator: bdist_wheel (0.24.0) +Root-Is-Purelib: true +Tag: py2-none-any +Tag: py3-none-any + diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/metadata.json b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/metadata.json new file mode 100644 index 000000000..426a3a7ad --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/metadata.json @@ -0,0 +1 @@ +{"license": "MIT license", "name": "pluggy", "metadata_version": "2.0", "generator": "bdist_wheel (0.24.0)", "summary": "plugin and hook calling mechanisms for python", "platform": "unix", "version": "0.3.1", "extensions": {"python.details": {"document_names": {"description": "DESCRIPTION.rst"}, "contacts": [{"role": "author", "email": "holger at merlinux.eu", "name": "Holger Krekel"}]}}, "classifiers": ["Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: POSIX", "Operating System :: Microsoft :: Windows", "Operating System :: MacOS :: MacOS X", "Topic :: Software Development :: Testing", "Topic :: Software Development :: Libraries", "Topic :: Utilities", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5"]}
\ No newline at end of file diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/pbr.json b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/pbr.json new file mode 100644 index 000000000..d6b798640 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/pbr.json @@ -0,0 +1 @@ +{"is_release": false, "git_version": "7d4c9cd"}
\ No newline at end of file diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/top_level.txt b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/top_level.txt new file mode 100644 index 000000000..11bdb5c1f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy-0.3.1.dist-info/top_level.txt @@ -0,0 +1 @@ +pluggy diff --git a/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy.py b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy.py new file mode 100644 index 000000000..2f848b23d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/_pytest/vendored_packages/pluggy.py @@ -0,0 +1,777 @@ +""" +PluginManager, basic initialization and tracing. + +pluggy is the cristallized core of plugin management as used +by some 150 plugins for pytest. + +Pluggy uses semantic versioning. Breaking changes are only foreseen for +Major releases (incremented X in "X.Y.Z"). If you want to use pluggy in +your project you should thus use a dependency restriction like +"pluggy>=0.1.0,<1.0" to avoid surprises. + +pluggy is concerned with hook specification, hook implementations and hook +calling. For any given hook specification a hook call invokes up to N implementations. +A hook implementation can influence its position and type of execution: +if attributed "tryfirst" or "trylast" it will be tried to execute +first or last. However, if attributed "hookwrapper" an implementation +can wrap all calls to non-hookwrapper implementations. A hookwrapper +can thus execute some code ahead and after the execution of other hooks. + +Hook specification is done by way of a regular python function where +both the function name and the names of all its arguments are significant. +Each hook implementation function is verified against the original specification +function, including the names of all its arguments. To allow for hook specifications +to evolve over the livetime of a project, hook implementations can +accept less arguments. One can thus add new arguments and semantics to +a hook specification by adding another argument typically without breaking +existing hook implementations. + +The chosen approach is meant to let a hook designer think carefuly about +which objects are needed by an extension writer. By contrast, subclass-based +extension mechanisms often expose a lot more state and behaviour than needed, +thus restricting future developments. + +Pluggy currently consists of functionality for: + +- a way to register new hook specifications. Without a hook + specification no hook calling can be performed. + +- a registry of plugins which contain hook implementation functions. It + is possible to register plugins for which a hook specification is not yet + known and validate all hooks when the system is in a more referentially + consistent state. Setting an "optionalhook" attribution to a hook + implementation will avoid PluginValidationError's if a specification + is missing. This allows to have optional integration between plugins. + +- a "hook" relay object from which you can launch 1:N calls to + registered hook implementation functions + +- a mechanism for ordering hook implementation functions + +- mechanisms for two different type of 1:N calls: "firstresult" for when + the call should stop when the first implementation returns a non-None result. + And the other (default) way of guaranteeing that all hook implementations + will be called and their non-None result collected. + +- mechanisms for "historic" extension points such that all newly + registered functions will receive all hook calls that happened + before their registration. + +- a mechanism for discovering plugin objects which are based on + setuptools based entry points. + +- a simple tracing mechanism, including tracing of plugin calls and + their arguments. + +""" +import sys +import inspect + +__version__ = '0.3.1' +__all__ = ["PluginManager", "PluginValidationError", + "HookspecMarker", "HookimplMarker"] + +_py3 = sys.version_info > (3, 0) + + +class HookspecMarker: + """ Decorator helper class for marking functions as hook specifications. + + You can instantiate it with a project_name to get a decorator. + Calling PluginManager.add_hookspecs later will discover all marked functions + if the PluginManager uses the same project_name. + """ + + def __init__(self, project_name): + self.project_name = project_name + + def __call__(self, function=None, firstresult=False, historic=False): + """ if passed a function, directly sets attributes on the function + which will make it discoverable to add_hookspecs(). If passed no + function, returns a decorator which can be applied to a function + later using the attributes supplied. + + If firstresult is True the 1:N hook call (N being the number of registered + hook implementation functions) will stop at I<=N when the I'th function + returns a non-None result. + + If historic is True calls to a hook will be memorized and replayed + on later registered plugins. + + """ + def setattr_hookspec_opts(func): + if historic and firstresult: + raise ValueError("cannot have a historic firstresult hook") + setattr(func, self.project_name + "_spec", + dict(firstresult=firstresult, historic=historic)) + return func + + if function is not None: + return setattr_hookspec_opts(function) + else: + return setattr_hookspec_opts + + +class HookimplMarker: + """ Decorator helper class for marking functions as hook implementations. + + You can instantiate with a project_name to get a decorator. + Calling PluginManager.register later will discover all marked functions + if the PluginManager uses the same project_name. + """ + def __init__(self, project_name): + self.project_name = project_name + + def __call__(self, function=None, hookwrapper=False, optionalhook=False, + tryfirst=False, trylast=False): + + """ if passed a function, directly sets attributes on the function + which will make it discoverable to register(). If passed no function, + returns a decorator which can be applied to a function later using + the attributes supplied. + + If optionalhook is True a missing matching hook specification will not result + in an error (by default it is an error if no matching spec is found). + + If tryfirst is True this hook implementation will run as early as possible + in the chain of N hook implementations for a specfication. + + If trylast is True this hook implementation will run as late as possible + in the chain of N hook implementations. + + If hookwrapper is True the hook implementations needs to execute exactly + one "yield". The code before the yield is run early before any non-hookwrapper + function is run. The code after the yield is run after all non-hookwrapper + function have run. The yield receives an ``_CallOutcome`` object representing + the exception or result outcome of the inner calls (including other hookwrapper + calls). + + """ + def setattr_hookimpl_opts(func): + setattr(func, self.project_name + "_impl", + dict(hookwrapper=hookwrapper, optionalhook=optionalhook, + tryfirst=tryfirst, trylast=trylast)) + return func + + if function is None: + return setattr_hookimpl_opts + else: + return setattr_hookimpl_opts(function) + + +def normalize_hookimpl_opts(opts): + opts.setdefault("tryfirst", False) + opts.setdefault("trylast", False) + opts.setdefault("hookwrapper", False) + opts.setdefault("optionalhook", False) + + +class _TagTracer: + def __init__(self): + self._tag2proc = {} + self.writer = None + self.indent = 0 + + def get(self, name): + return _TagTracerSub(self, (name,)) + + def format_message(self, tags, args): + if isinstance(args[-1], dict): + extra = args[-1] + args = args[:-1] + else: + extra = {} + + content = " ".join(map(str, args)) + indent = " " * self.indent + + lines = [ + "%s%s [%s]\n" % (indent, content, ":".join(tags)) + ] + + for name, value in extra.items(): + lines.append("%s %s: %s\n" % (indent, name, value)) + return lines + + def processmessage(self, tags, args): + if self.writer is not None and args: + lines = self.format_message(tags, args) + self.writer(''.join(lines)) + try: + self._tag2proc[tags](tags, args) + except KeyError: + pass + + def setwriter(self, writer): + self.writer = writer + + def setprocessor(self, tags, processor): + if isinstance(tags, str): + tags = tuple(tags.split(":")) + else: + assert isinstance(tags, tuple) + self._tag2proc[tags] = processor + + +class _TagTracerSub: + def __init__(self, root, tags): + self.root = root + self.tags = tags + + def __call__(self, *args): + self.root.processmessage(self.tags, args) + + def setmyprocessor(self, processor): + self.root.setprocessor(self.tags, processor) + + def get(self, name): + return self.__class__(self.root, self.tags + (name,)) + + +def _raise_wrapfail(wrap_controller, msg): + co = wrap_controller.gi_code + raise RuntimeError("wrap_controller at %r %s:%d %s" % + (co.co_name, co.co_filename, co.co_firstlineno, msg)) + + +def _wrapped_call(wrap_controller, func): + """ Wrap calling to a function with a generator which needs to yield + exactly once. The yield point will trigger calling the wrapped function + and return its _CallOutcome to the yield point. The generator then needs + to finish (raise StopIteration) in order for the wrapped call to complete. + """ + try: + next(wrap_controller) # first yield + except StopIteration: + _raise_wrapfail(wrap_controller, "did not yield") + call_outcome = _CallOutcome(func) + try: + wrap_controller.send(call_outcome) + _raise_wrapfail(wrap_controller, "has second yield") + except StopIteration: + pass + return call_outcome.get_result() + + +class _CallOutcome: + """ Outcome of a function call, either an exception or a proper result. + Calling the ``get_result`` method will return the result or reraise + the exception raised when the function was called. """ + excinfo = None + + def __init__(self, func): + try: + self.result = func() + except BaseException: + self.excinfo = sys.exc_info() + + def force_result(self, result): + self.result = result + self.excinfo = None + + def get_result(self): + if self.excinfo is None: + return self.result + else: + ex = self.excinfo + if _py3: + raise ex[1].with_traceback(ex[2]) + _reraise(*ex) # noqa + +if not _py3: + exec(""" +def _reraise(cls, val, tb): + raise cls, val, tb +""") + + +class _TracedHookExecution: + def __init__(self, pluginmanager, before, after): + self.pluginmanager = pluginmanager + self.before = before + self.after = after + self.oldcall = pluginmanager._inner_hookexec + assert not isinstance(self.oldcall, _TracedHookExecution) + self.pluginmanager._inner_hookexec = self + + def __call__(self, hook, hook_impls, kwargs): + self.before(hook.name, hook_impls, kwargs) + outcome = _CallOutcome(lambda: self.oldcall(hook, hook_impls, kwargs)) + self.after(outcome, hook.name, hook_impls, kwargs) + return outcome.get_result() + + def undo(self): + self.pluginmanager._inner_hookexec = self.oldcall + + +class PluginManager(object): + """ Core Pluginmanager class which manages registration + of plugin objects and 1:N hook calling. + + You can register new hooks by calling ``addhooks(module_or_class)``. + You can register plugin objects (which contain hooks) by calling + ``register(plugin)``. The Pluginmanager is initialized with a + prefix that is searched for in the names of the dict of registered + plugin objects. An optional excludefunc allows to blacklist names which + are not considered as hooks despite a matching prefix. + + For debugging purposes you can call ``enable_tracing()`` + which will subsequently send debug information to the trace helper. + """ + + def __init__(self, project_name, implprefix=None): + """ if implprefix is given implementation functions + will be recognized if their name matches the implprefix. """ + self.project_name = project_name + self._name2plugin = {} + self._plugin2hookcallers = {} + self._plugin_distinfo = [] + self.trace = _TagTracer().get("pluginmanage") + self.hook = _HookRelay(self.trace.root.get("hook")) + self._implprefix = implprefix + self._inner_hookexec = lambda hook, methods, kwargs: \ + _MultiCall(methods, kwargs, hook.spec_opts).execute() + + def _hookexec(self, hook, methods, kwargs): + # called from all hookcaller instances. + # enable_tracing will set its own wrapping function at self._inner_hookexec + return self._inner_hookexec(hook, methods, kwargs) + + def register(self, plugin, name=None): + """ Register a plugin and return its canonical name or None if the name + is blocked from registering. Raise a ValueError if the plugin is already + registered. """ + plugin_name = name or self.get_canonical_name(plugin) + + if plugin_name in self._name2plugin or plugin in self._plugin2hookcallers: + if self._name2plugin.get(plugin_name, -1) is None: + return # blocked plugin, return None to indicate no registration + raise ValueError("Plugin already registered: %s=%s\n%s" % + (plugin_name, plugin, self._name2plugin)) + + # XXX if an error happens we should make sure no state has been + # changed at point of return + self._name2plugin[plugin_name] = plugin + + # register matching hook implementations of the plugin + self._plugin2hookcallers[plugin] = hookcallers = [] + for name in dir(plugin): + hookimpl_opts = self.parse_hookimpl_opts(plugin, name) + if hookimpl_opts is not None: + normalize_hookimpl_opts(hookimpl_opts) + method = getattr(plugin, name) + hookimpl = HookImpl(plugin, plugin_name, method, hookimpl_opts) + hook = getattr(self.hook, name, None) + if hook is None: + hook = _HookCaller(name, self._hookexec) + setattr(self.hook, name, hook) + elif hook.has_spec(): + self._verify_hook(hook, hookimpl) + hook._maybe_apply_history(hookimpl) + hook._add_hookimpl(hookimpl) + hookcallers.append(hook) + return plugin_name + + def parse_hookimpl_opts(self, plugin, name): + method = getattr(plugin, name) + res = getattr(method, self.project_name + "_impl", None) + if res is not None and not isinstance(res, dict): + # false positive + res = None + elif res is None and self._implprefix and name.startswith(self._implprefix): + res = {} + return res + + def unregister(self, plugin=None, name=None): + """ unregister a plugin object and all its contained hook implementations + from internal data structures. """ + if name is None: + assert plugin is not None, "one of name or plugin needs to be specified" + name = self.get_name(plugin) + + if plugin is None: + plugin = self.get_plugin(name) + + # if self._name2plugin[name] == None registration was blocked: ignore + if self._name2plugin.get(name): + del self._name2plugin[name] + + for hookcaller in self._plugin2hookcallers.pop(plugin, []): + hookcaller._remove_plugin(plugin) + + return plugin + + def set_blocked(self, name): + """ block registrations of the given name, unregister if already registered. """ + self.unregister(name=name) + self._name2plugin[name] = None + + def is_blocked(self, name): + """ return True if the name blogs registering plugins of that name. """ + return name in self._name2plugin and self._name2plugin[name] is None + + def add_hookspecs(self, module_or_class): + """ add new hook specifications defined in the given module_or_class. + Functions are recognized if they have been decorated accordingly. """ + names = [] + for name in dir(module_or_class): + spec_opts = self.parse_hookspec_opts(module_or_class, name) + if spec_opts is not None: + hc = getattr(self.hook, name, None) + if hc is None: + hc = _HookCaller(name, self._hookexec, module_or_class, spec_opts) + setattr(self.hook, name, hc) + else: + # plugins registered this hook without knowing the spec + hc.set_specification(module_or_class, spec_opts) + for hookfunction in (hc._wrappers + hc._nonwrappers): + self._verify_hook(hc, hookfunction) + names.append(name) + + if not names: + raise ValueError("did not find any %r hooks in %r" % + (self.project_name, module_or_class)) + + def parse_hookspec_opts(self, module_or_class, name): + method = getattr(module_or_class, name) + return getattr(method, self.project_name + "_spec", None) + + def get_plugins(self): + """ return the set of registered plugins. """ + return set(self._plugin2hookcallers) + + def is_registered(self, plugin): + """ Return True if the plugin is already registered. """ + return plugin in self._plugin2hookcallers + + def get_canonical_name(self, plugin): + """ Return canonical name for a plugin object. Note that a plugin + may be registered under a different name which was specified + by the caller of register(plugin, name). To obtain the name + of an registered plugin use ``get_name(plugin)`` instead.""" + return getattr(plugin, "__name__", None) or str(id(plugin)) + + def get_plugin(self, name): + """ Return a plugin or None for the given name. """ + return self._name2plugin.get(name) + + def get_name(self, plugin): + """ Return name for registered plugin or None if not registered. """ + for name, val in self._name2plugin.items(): + if plugin == val: + return name + + def _verify_hook(self, hook, hookimpl): + if hook.is_historic() and hookimpl.hookwrapper: + raise PluginValidationError( + "Plugin %r\nhook %r\nhistoric incompatible to hookwrapper" % + (hookimpl.plugin_name, hook.name)) + + for arg in hookimpl.argnames: + if arg not in hook.argnames: + raise PluginValidationError( + "Plugin %r\nhook %r\nargument %r not available\n" + "plugin definition: %s\n" + "available hookargs: %s" % + (hookimpl.plugin_name, hook.name, arg, + _formatdef(hookimpl.function), ", ".join(hook.argnames))) + + def check_pending(self): + """ Verify that all hooks which have not been verified against + a hook specification are optional, otherwise raise PluginValidationError""" + for name in self.hook.__dict__: + if name[0] != "_": + hook = getattr(self.hook, name) + if not hook.has_spec(): + for hookimpl in (hook._wrappers + hook._nonwrappers): + if not hookimpl.optionalhook: + raise PluginValidationError( + "unknown hook %r in plugin %r" % + (name, hookimpl.plugin)) + + def load_setuptools_entrypoints(self, entrypoint_name): + """ Load modules from querying the specified setuptools entrypoint name. + Return the number of loaded plugins. """ + from pkg_resources import iter_entry_points, DistributionNotFound + for ep in iter_entry_points(entrypoint_name): + # is the plugin registered or blocked? + if self.get_plugin(ep.name) or self.is_blocked(ep.name): + continue + try: + plugin = ep.load() + except DistributionNotFound: + continue + self.register(plugin, name=ep.name) + self._plugin_distinfo.append((plugin, ep.dist)) + return len(self._plugin_distinfo) + + def list_plugin_distinfo(self): + """ return list of distinfo/plugin tuples for all setuptools registered + plugins. """ + return list(self._plugin_distinfo) + + def list_name_plugin(self): + """ return list of name/plugin pairs. """ + return list(self._name2plugin.items()) + + def get_hookcallers(self, plugin): + """ get all hook callers for the specified plugin. """ + return self._plugin2hookcallers.get(plugin) + + def add_hookcall_monitoring(self, before, after): + """ add before/after tracing functions for all hooks + and return an undo function which, when called, + will remove the added tracers. + + ``before(hook_name, hook_impls, kwargs)`` will be called ahead + of all hook calls and receive a hookcaller instance, a list + of HookImpl instances and the keyword arguments for the hook call. + + ``after(outcome, hook_name, hook_impls, kwargs)`` receives the + same arguments as ``before`` but also a :py:class:`_CallOutcome`` object + which represents the result of the overall hook call. + """ + return _TracedHookExecution(self, before, after).undo + + def enable_tracing(self): + """ enable tracing of hook calls and return an undo function. """ + hooktrace = self.hook._trace + + def before(hook_name, methods, kwargs): + hooktrace.root.indent += 1 + hooktrace(hook_name, kwargs) + + def after(outcome, hook_name, methods, kwargs): + if outcome.excinfo is None: + hooktrace("finish", hook_name, "-->", outcome.result) + hooktrace.root.indent -= 1 + + return self.add_hookcall_monitoring(before, after) + + def subset_hook_caller(self, name, remove_plugins): + """ Return a new _HookCaller instance for the named method + which manages calls to all registered plugins except the + ones from remove_plugins. """ + orig = getattr(self.hook, name) + plugins_to_remove = [plug for plug in remove_plugins if hasattr(plug, name)] + if plugins_to_remove: + hc = _HookCaller(orig.name, orig._hookexec, orig._specmodule_or_class, + orig.spec_opts) + for hookimpl in (orig._wrappers + orig._nonwrappers): + plugin = hookimpl.plugin + if plugin not in plugins_to_remove: + hc._add_hookimpl(hookimpl) + # we also keep track of this hook caller so it + # gets properly removed on plugin unregistration + self._plugin2hookcallers.setdefault(plugin, []).append(hc) + return hc + return orig + + +class _MultiCall: + """ execute a call into multiple python functions/methods. """ + + # XXX note that the __multicall__ argument is supported only + # for pytest compatibility reasons. It was never officially + # supported there and is explicitly deprecated since 2.8 + # so we can remove it soon, allowing to avoid the below recursion + # in execute() and simplify/speed up the execute loop. + + def __init__(self, hook_impls, kwargs, specopts={}): + self.hook_impls = hook_impls + self.kwargs = kwargs + self.kwargs["__multicall__"] = self + self.specopts = specopts + + def execute(self): + all_kwargs = self.kwargs + self.results = results = [] + firstresult = self.specopts.get("firstresult") + + while self.hook_impls: + hook_impl = self.hook_impls.pop() + args = [all_kwargs[argname] for argname in hook_impl.argnames] + if hook_impl.hookwrapper: + return _wrapped_call(hook_impl.function(*args), self.execute) + res = hook_impl.function(*args) + if res is not None: + if firstresult: + return res + results.append(res) + + if not firstresult: + return results + + def __repr__(self): + status = "%d meths" % (len(self.hook_impls),) + if hasattr(self, "results"): + status = ("%d results, " % len(self.results)) + status + return "<_MultiCall %s, kwargs=%r>" % (status, self.kwargs) + + +def varnames(func, startindex=None): + """ return argument name tuple for a function, method, class or callable. + + In case of a class, its "__init__" method is considered. + For methods the "self" parameter is not included unless you are passing + an unbound method with Python3 (which has no supports for unbound methods) + """ + cache = getattr(func, "__dict__", {}) + try: + return cache["_varnames"] + except KeyError: + pass + if inspect.isclass(func): + try: + func = func.__init__ + except AttributeError: + return () + startindex = 1 + else: + if not inspect.isfunction(func) and not inspect.ismethod(func): + func = getattr(func, '__call__', func) + if startindex is None: + startindex = int(inspect.ismethod(func)) + + try: + rawcode = func.__code__ + except AttributeError: + return () + try: + x = rawcode.co_varnames[startindex:rawcode.co_argcount] + except AttributeError: + x = () + else: + defaults = func.__defaults__ + if defaults: + x = x[:-len(defaults)] + try: + cache["_varnames"] = x + except TypeError: + pass + return x + + +class _HookRelay: + """ hook holder object for performing 1:N hook calls where N is the number + of registered plugins. + + """ + + def __init__(self, trace): + self._trace = trace + + +class _HookCaller(object): + def __init__(self, name, hook_execute, specmodule_or_class=None, spec_opts=None): + self.name = name + self._wrappers = [] + self._nonwrappers = [] + self._hookexec = hook_execute + if specmodule_or_class is not None: + assert spec_opts is not None + self.set_specification(specmodule_or_class, spec_opts) + + def has_spec(self): + return hasattr(self, "_specmodule_or_class") + + def set_specification(self, specmodule_or_class, spec_opts): + assert not self.has_spec() + self._specmodule_or_class = specmodule_or_class + specfunc = getattr(specmodule_or_class, self.name) + argnames = varnames(specfunc, startindex=inspect.isclass(specmodule_or_class)) + assert "self" not in argnames # sanity check + self.argnames = ["__multicall__"] + list(argnames) + self.spec_opts = spec_opts + if spec_opts.get("historic"): + self._call_history = [] + + def is_historic(self): + return hasattr(self, "_call_history") + + def _remove_plugin(self, plugin): + def remove(wrappers): + for i, method in enumerate(wrappers): + if method.plugin == plugin: + del wrappers[i] + return True + if remove(self._wrappers) is None: + if remove(self._nonwrappers) is None: + raise ValueError("plugin %r not found" % (plugin,)) + + def _add_hookimpl(self, hookimpl): + if hookimpl.hookwrapper: + methods = self._wrappers + else: + methods = self._nonwrappers + + if hookimpl.trylast: + methods.insert(0, hookimpl) + elif hookimpl.tryfirst: + methods.append(hookimpl) + else: + # find last non-tryfirst method + i = len(methods) - 1 + while i >= 0 and methods[i].tryfirst: + i -= 1 + methods.insert(i + 1, hookimpl) + + def __repr__(self): + return "<_HookCaller %r>" % (self.name,) + + def __call__(self, **kwargs): + assert not self.is_historic() + return self._hookexec(self, self._nonwrappers + self._wrappers, kwargs) + + def call_historic(self, proc=None, kwargs=None): + self._call_history.append((kwargs or {}, proc)) + # historizing hooks don't return results + self._hookexec(self, self._nonwrappers + self._wrappers, kwargs) + + def call_extra(self, methods, kwargs): + """ Call the hook with some additional temporarily participating + methods using the specified kwargs as call parameters. """ + old = list(self._nonwrappers), list(self._wrappers) + for method in methods: + opts = dict(hookwrapper=False, trylast=False, tryfirst=False) + hookimpl = HookImpl(None, "<temp>", method, opts) + self._add_hookimpl(hookimpl) + try: + return self(**kwargs) + finally: + self._nonwrappers, self._wrappers = old + + def _maybe_apply_history(self, method): + if self.is_historic(): + for kwargs, proc in self._call_history: + res = self._hookexec(self, [method], kwargs) + if res and proc is not None: + proc(res[0]) + + +class HookImpl: + def __init__(self, plugin, plugin_name, function, hook_impl_opts): + self.function = function + self.argnames = varnames(self.function) + self.plugin = plugin + self.opts = hook_impl_opts + self.plugin_name = plugin_name + self.__dict__.update(hook_impl_opts) + + +class PluginValidationError(Exception): + """ plugin failed validation. """ + + +if hasattr(inspect, 'signature'): + def _formatdef(func): + return "%s%s" % ( + func.__name__, + str(inspect.signature(func)) + ) +else: + def _formatdef(func): + return "%s%s" % ( + func.__name__, + inspect.formatargspec(*inspect.getargspec(func)) + ) diff --git a/testing/web-platform/tests/tools/pytest/appveyor.yml b/testing/web-platform/tests/tools/pytest/appveyor.yml new file mode 100644 index 000000000..4b73645f7 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/appveyor.yml @@ -0,0 +1,28 @@ +environment: + COVERALLS_REPO_TOKEN: + secure: 2NJ5Ct55cHJ9WEg3xbSqCuv0rdgzzb6pnzOIG5OkMbTndw3wOBrXntWFoQrXiMFi + # this is pytest's token in coveralls.io, encrypted + # using pytestbot account as detailed here: + # https://www.appveyor.com/docs/build-configuration#secure-variables + +install: + - echo Installed Pythons + - dir c:\Python* + + # install pypy using choco (redirect to a file and write to console in case + # choco install returns non-zero, because choco install python.pypy is too + # noisy) + - choco install python.pypy > pypy-inst.log 2>&1 || (type pypy-inst.log & exit /b 1) + - set PATH=C:\tools\pypy\pypy;%PATH% # so tox can find pypy + - echo PyPy installed + - pypy --version + + - C:\Python35\python -m pip install tox + +build: false # Not a C# project, build stuff at the test step instead. + +test_script: + - C:\Python35\python -m tox + # coveralls is not in tox's envlist, plus for PRs the secure variable + # is not defined so we have to check for it + - if defined COVERALLS_REPO_TOKEN C:\Python35\python -m tox -e coveralls diff --git a/testing/web-platform/tests/tools/pytest/bench/bench.py b/testing/web-platform/tests/tools/pytest/bench/bench.py new file mode 100644 index 000000000..ce9496417 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/bench/bench.py @@ -0,0 +1,12 @@ +import sys + +if __name__ == '__main__': + import cProfile + import pytest + import pstats + script = sys.argv[1:] if len(sys.argv) > 1 else "empty.py" + stats = cProfile.run('pytest.cmdline.main(%r)' % script, 'prof') + p = pstats.Stats("prof") + p.strip_dirs() + p.sort_stats('cumulative') + print(p.print_stats(500)) diff --git a/testing/web-platform/tests/tools/pytest/bench/bench_argcomplete.py b/testing/web-platform/tests/tools/pytest/bench/bench_argcomplete.py new file mode 100644 index 000000000..d66c664f3 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/bench/bench_argcomplete.py @@ -0,0 +1,19 @@ + + +# 10000 iterations, just for relative comparison +# 2.7.5 3.3.2 +# FilesCompleter 75.1109 69.2116 +# FastFilesCompleter 0.7383 1.0760 + + +if __name__ == '__main__': + import sys + import timeit + from argcomplete.completers import FilesCompleter + from _pytest._argcomplete import FastFilesCompleter + count = 1000 # only a few seconds + setup = 'from __main__ import FastFilesCompleter\nfc = FastFilesCompleter()' + run = 'fc("/d")' + sys.stdout.write('%s\n' % (timeit.timeit(run, + setup=setup.replace('Fast', ''), number=count))) + sys.stdout.write('%s\n' % (timeit.timeit(run, setup=setup, number=count))) diff --git a/testing/web-platform/tests/tools/pytest/bench/empty.py b/testing/web-platform/tests/tools/pytest/bench/empty.py new file mode 100644 index 000000000..ac5e25701 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/bench/empty.py @@ -0,0 +1,3 @@ +import py +for i in range(1000): + py.builtin.exec_("def test_func_%d(): pass" % i) diff --git a/testing/web-platform/tests/tools/pytest/bench/manyparam.py b/testing/web-platform/tests/tools/pytest/bench/manyparam.py new file mode 100644 index 000000000..d2bca0e8a --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/bench/manyparam.py @@ -0,0 +1,12 @@ + +import pytest + +@pytest.fixture(scope='module', params=range(966)) +def foo(request): + return request.param + +def test_it(foo): + pass +def test_it2(foo): + pass + diff --git a/testing/web-platform/tests/tools/pytest/bench/skip.py b/testing/web-platform/tests/tools/pytest/bench/skip.py new file mode 100644 index 000000000..960b30864 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/bench/skip.py @@ -0,0 +1,10 @@ + +import pytest + + +SKIP = True + +@pytest.mark.parametrize("x", xrange(5000)) +def test_foo(x): + if SKIP: + pytest.skip("heh") diff --git a/testing/web-platform/tests/tools/pytest/doc/en/Makefile b/testing/web-platform/tests/tools/pytest/doc/en/Makefile new file mode 100644 index 000000000..8621f779c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/Makefile @@ -0,0 +1,164 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +REGENDOC_ARGS := \ + --normalize "/={8,} (.*) ={8,}/======= \1 ========/" \ + --normalize "/_{8,} (.*) _{8,}/_______ \1 ________/" \ + --normalize "/in \d+.\d+ seconds/in 0.12 seconds/" \ + --normalize "@/tmp/pytest-of-.*/pytest-\d+@PYTEST_TMPDIR@" \ + + + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + + +help: + @echo "Please use \`make <target>' where <target> is one of" + @echo " html to make standalone HTML files" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " showtarget to show the pytest.org target directory" + @echo " install to install docs to pytest.org/SITETARGET" + @echo " install-ldf to install the doc pdf to pytest.org/SITETARGET" + @echo " regen to regenerate pytest examples using the installed pytest" + @echo " linkcheck to check all external links for integrity" + +clean: + -rm -rf $(BUILDDIR)/* + +SITETARGET=$(shell ./_getdoctarget.py) + +showtarget: + @echo $(SITETARGET) + +install: html + # for access talk to someone with login rights to + # pytest-dev@pytest.org to add your ssh key + rsync -avz _build/html/ pytest-dev@pytest.org:pytest.org/$(SITETARGET) + +installpdf: latexpdf + @scp $(BUILDDIR)/latex/pytest.pdf pytest-dev@pytest.org:pytest.org/$(SITETARGET) + +installall: clean install installpdf + @echo "done" + +regen: + PYTHONDONTWRITEBYTECODE=1 COLUMNS=76 regendoc --update *.rst */*.rst ${REGENDOC_ARGS} + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pytest.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pytest.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/pytest" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pytest" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + make -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +texinfo: + mkdir -p $(BUILDDIR)/texinfo + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + mkdir -p $(BUILDDIR)/texinfo + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_getdoctarget.py b/testing/web-platform/tests/tools/pytest/doc/en/_getdoctarget.py new file mode 100755 index 000000000..20e487bb7 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_getdoctarget.py @@ -0,0 +1,16 @@ +#!/usr/bin/env python + +import py + +def get_version_string(): + fn = py.path.local(__file__).join("..", "..", "..", + "_pytest", "__init__.py") + for line in fn.readlines(): + if "version" in line and not line.strip().startswith('#'): + return eval(line.split("=")[-1]) + +def get_minor_version_string(): + return ".".join(get_version_string().split(".")[:2]) + +if __name__ == "__main__": + print (get_minor_version_string()) diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_templates/globaltoc.html b/testing/web-platform/tests/tools/pytest/doc/en/_templates/globaltoc.html new file mode 100644 index 000000000..af427198a --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_templates/globaltoc.html @@ -0,0 +1,18 @@ +<h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3> + +<ul> + <li><a href="{{ pathto('index') }}">Home</a></li> + <li><a href="{{ pathto('contents') }}">Contents</a></li> + <li><a href="{{ pathto('getting-started') }}">Install</a></li> + <li><a href="{{ pathto('example/index') }}">Examples</a></li> + <li><a href="{{ pathto('customize') }}">Customize</a></li> + <li><a href="{{ pathto('contact') }}">Contact</a></li> + <li><a href="{{ pathto('talks') }}">Talks/Posts</a></li> + <li><a href="{{ pathto('changelog') }}">Changelog</a></li> + <li><a href="{{ pathto('license') }}">License</a></li> +</ul> + +{%- if display_toc %} + <hr> + {{ toc }} +{%- endif %} diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_templates/layout.html b/testing/web-platform/tests/tools/pytest/doc/en/_templates/layout.html new file mode 100644 index 000000000..0ce480be3 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_templates/layout.html @@ -0,0 +1,34 @@ +{% extends "!layout.html" %} +{% block header %} +<div align="center" xmlns="http://www.w3.org/1999/html" style="background-color: lightgreen; padding: .5em"> + <h4> + Want to help improve pytest? Please + <a href="https://www.indiegogo.com/projects/python-testing-sprint-mid-2016#/"> + contribute to + </a> + or + <a href="announce/sprint2016.html"> + join + </a> + our upcoming sprint in June 2016! + + </h4> +</div> + {{super()}} +{% endblock %} +{% block footer %} +{{ super() }} +<script type="text/javascript"> + + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-7597274-13']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + +</script> +{% endblock %} diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_templates/links.html b/testing/web-platform/tests/tools/pytest/doc/en/_templates/links.html new file mode 100644 index 000000000..200258e16 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_templates/links.html @@ -0,0 +1,16 @@ +<h3>Useful Links</h3> +<ul> + <li> + <a href="https://www.indiegogo.com/projects/python-testing-sprint-mid-2016#/"> + <b>Sprint funding campaign</b> + </a> + </li> + <li><a href="{{ pathto('index') }}">The pytest Website</a></li> + <li><a href="{{ pathto('contributing') }}">Contribution Guide</a></li> + <li><a href="https://pypi.python.org/pypi/pytest">pytest @ PyPI</a></li> + <li><a href="https://github.com/pytest-dev/pytest/">pytest @ GitHub</a></li> + <li><a href="http://plugincompat.herokuapp.com/">3rd party plugins</a></li> + <li><a href="https://github.com/pytest-dev/pytest/issues">Issue Tracker</a></li> + <li><a href="http://pytest.org/latest/pytest.pdf">PDF Documentation</a> +</ul> + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_templates/sidebarintro.html b/testing/web-platform/tests/tools/pytest/doc/en/_templates/sidebarintro.html new file mode 100644 index 000000000..ae860c172 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_templates/sidebarintro.html @@ -0,0 +1,5 @@ +<h3>About pytest</h3> +<p> + pytest is a mature full-featured Python testing tool that helps + you write better programs. +</p> diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_themes/.gitignore b/testing/web-platform/tests/tools/pytest/doc/en/_themes/.gitignore new file mode 100644 index 000000000..66b6e4c2f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_themes/.gitignore @@ -0,0 +1,3 @@ +*.pyc +*.pyo +.DS_Store diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_themes/LICENSE b/testing/web-platform/tests/tools/pytest/doc/en/_themes/LICENSE new file mode 100644 index 000000000..8daab7ee6 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_themes/LICENSE @@ -0,0 +1,37 @@ +Copyright (c) 2010 by Armin Ronacher. + +Some rights reserved. + +Redistribution and use in source and binary forms of the theme, with or +without modification, are permitted provided that the following conditions +are met: + +* Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + +* The names of the contributors may not be used to endorse or + promote products derived from this software without specific + prior written permission. + +We kindly ask you to only use these themes in an unmodified manner just +for Flask and Flask-related products, not for unrelated projects. If you +like the visual style and want to use it for your own projects, please +consider making some larger changes to the themes (such as changing +font faces, sizes, colors or margins). + +THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_themes/README b/testing/web-platform/tests/tools/pytest/doc/en/_themes/README new file mode 100644 index 000000000..b3292bdff --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_themes/README @@ -0,0 +1,31 @@ +Flask Sphinx Styles +=================== + +This repository contains sphinx styles for Flask and Flask related +projects. To use this style in your Sphinx documentation, follow +this guide: + +1. put this folder as _themes into your docs folder. Alternatively + you can also use git submodules to check out the contents there. +2. add this to your conf.py: + + sys.path.append(os.path.abspath('_themes')) + html_theme_path = ['_themes'] + html_theme = 'flask' + +The following themes exist: + +- 'flask' - the standard flask documentation theme for large + projects +- 'flask_small' - small one-page theme. Intended to be used by + very small addon libraries for flask. + +The following options exist for the flask_small theme: + + [options] + index_logo = '' filename of a picture in _static + to be used as replacement for the + h1 in the index.rst file. + index_logo_height = 120px height of the index logo + github_fork = '' repository name on github for the + "fork me" badge diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/layout.html b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/layout.html new file mode 100644 index 000000000..19c43fbbe --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/layout.html @@ -0,0 +1,24 @@ +{%- extends "basic/layout.html" %} +{%- block extrahead %} + {{ super() }} + {% if theme_touch_icon %} + <link rel="apple-touch-icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" /> + {% endif %} + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> +{% endblock %} +{%- block relbar2 %}{% endblock %} +{% block header %} + {{ super() }} + {% if pagename == 'index' %} + <div class=indexwrapper> + {% endif %} +{% endblock %} +{%- block footer %} + <div class="footer"> + © Copyright {{ copyright }}. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>. + </div> + {% if pagename == 'index' %} + </div> + {% endif %} +{%- endblock %} diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/relations.html b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/relations.html new file mode 100644 index 000000000..3bbcde85b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/relations.html @@ -0,0 +1,19 @@ +<h3>Related Topics</h3> +<ul> + <li><a href="{{ pathto(master_doc) }}">Documentation overview</a><ul> + {%- for parent in parents %} + <li><a href="{{ parent.link|e }}">{{ parent.title }}</a><ul> + {%- endfor %} + {%- if prev %} + <li>Previous: <a href="{{ prev.link|e }}" title="{{ _('previous chapter') + }}">{{ prev.title }}</a></li> + {%- endif %} + {%- if next %} + <li>Next: <a href="{{ next.link|e }}" title="{{ _('next chapter') + }}">{{ next.title }}</a></li> + {%- endif %} + {%- for parent in parents %} + </ul></li> + {%- endfor %} + </ul></li> +</ul> diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/static/flasky.css_t b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/static/flasky.css_t new file mode 100644 index 000000000..6b593da29 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/static/flasky.css_t @@ -0,0 +1,557 @@ +/* + * flasky.css_t + * ~~~~~~~~~~~~ + * + * :copyright: Copyright 2010 by Armin Ronacher. + * :license: Flask Design License, see LICENSE for details. + */ + +{% set page_width = '1020px' %} +{% set sidebar_width = '220px' %} +/* orange of logo is #d67c29 but we use black for links for now */ +{% set link_color = '#000' %} +{% set link_hover_color = '#000' %} +{% set base_font = 'sans-serif' %} +{% set header_font = 'serif' %} + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: {{ base_font }}; + font-size: 17px; + background-color: white; + color: #000; + margin: 0; + padding: 0; +} + +div.document { + width: {{ page_width }}; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 {{ sidebar_width }}; +} + +div.sphinxsidebar { + width: {{ sidebar_width }}; +} + +hr { + border: 0; + border-top: 1px solid #B1B4B6; +} + +div.body { + background-color: #ffffff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +img.floatingflask { + padding: 0 0 10px 10px; + float: right; +} + +div.footer { + width: {{ page_width }}; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +div.related { + display: none; +} + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebar { + font-size: 14px; + line-height: 1.5; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0 0 20px 0; + margin: 0; + text-align: center; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: {{ header_font }}; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar input { + border: 1px solid #ccc; + font-family: {{ base_font }}; + font-size: 1em; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: {{ link_color }}; + text-decoration: underline; +} + +a:hover { + color: {{ link_hover_color }}; + text-decoration: underline; +} + +a.reference.internal em { + font-style: normal; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: {{ header_font }}; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +{% if theme_index_logo %} +div.indexwrapper h1 { + text-indent: -999999px; + background: url({{ theme_index_logo }}) no-repeat center center; + height: {{ theme_index_logo_height }}; +} +{% else %} +div.indexwrapper div.body h1 { + font-size: 200%; +} +{% endif %} +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #ddd; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #eaeaea; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + background: #fafafa; + margin: 20px -30px; + padding: 10px 30px; + border-top: 1px solid #ccc; + border-bottom: 1px solid #ccc; +} + +div.admonition tt.xref, div.admonition a tt { + border-bottom: 1px solid #fafafa; +} + +dd div.admonition { + margin-left: -60px; + padding-left: 60px; +} + +div.admonition p.admonition-title { + font-family: {{ header_font }}; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: white; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +div.topic { + background-color: #eee; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; + background: #eee; +} + +img.screenshot { +} + +tt.descname, tt.descclassname { + font-size: 0.95em; +} + +tt.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #eee; + -webkit-box-shadow: 2px 2px 4px #eee; + box-shadow: 2px 2px 4px #eee; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #eee; + -webkit-box-shadow: 2px 2px 4px #eee; + box-shadow: 2px 2px 4px #eee; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #eee; + background: #fdfdfd; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.footnote td.label { + width: 0px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #eee; + padding: 7px 30px; + margin: 15px -30px; + line-height: 1.3em; +} + +dl pre, blockquote pre, li pre { + margin-left: -60px; + padding-left: 60px; +} + +dl dl pre { + margin-left: -90px; + padding-left: 90px; +} + +tt { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid white; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted {{ link_color }}; +} + +a.reference:hover { + border-bottom: 1px solid {{ link_hover_color }}; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted {{ link_color }}; +} + +a.footnote-reference:hover { + border-bottom: 1px solid {{ link_hover_color }}; +} + +a:hover tt { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: white; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: white; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a, div.sphinxsidebar ul { + color: white; + } + + div.sphinxsidebar a { + color: #aaa; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.related { + display: block; + margin: 0; + padding: 10px 0 20px 0; + } + + div.related ul, + div.related ul li { + margin: 0; + padding: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + +/* misc. */ + +.revsys-inline { + display: none!important; +} diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/theme.conf b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/theme.conf new file mode 100644 index 000000000..18c720f80 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask/theme.conf @@ -0,0 +1,9 @@ +[theme] +inherit = basic +stylesheet = flasky.css +pygments_style = flask_theme_support.FlaskyStyle + +[options] +index_logo = '' +index_logo_height = 120px +touch_icon = diff --git a/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask_theme_support.py b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask_theme_support.py new file mode 100644 index 000000000..33f47449c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/_themes/flask_theme_support.py @@ -0,0 +1,86 @@ +# flasky extensions. flasky pygments style based on tango style +from pygments.style import Style +from pygments.token import Keyword, Name, Comment, String, Error, \ + Number, Operator, Generic, Whitespace, Punctuation, Other, Literal + + +class FlaskyStyle(Style): + background_color = "#f8f8f8" + default_style = "" + + styles = { + # No corresponding class for the following: + #Text: "", # class: '' + Whitespace: "underline #f8f8f8", # class: 'w' + Error: "#a40000 border:#ef2929", # class: 'err' + Other: "#000000", # class 'x' + + Comment: "italic #8f5902", # class: 'c' + Comment.Preproc: "noitalic", # class: 'cp' + + Keyword: "bold #004461", # class: 'k' + Keyword.Constant: "bold #004461", # class: 'kc' + Keyword.Declaration: "bold #004461", # class: 'kd' + Keyword.Namespace: "bold #004461", # class: 'kn' + Keyword.Pseudo: "bold #004461", # class: 'kp' + Keyword.Reserved: "bold #004461", # class: 'kr' + Keyword.Type: "bold #004461", # class: 'kt' + + Operator: "#582800", # class: 'o' + Operator.Word: "bold #004461", # class: 'ow' - like keywords + + Punctuation: "bold #000000", # class: 'p' + + # because special names such as Name.Class, Name.Function, etc. + # are not recognized as such later in the parsing, we choose them + # to look the same as ordinary variables. + Name: "#000000", # class: 'n' + Name.Attribute: "#c4a000", # class: 'na' - to be revised + Name.Builtin: "#004461", # class: 'nb' + Name.Builtin.Pseudo: "#3465a4", # class: 'bp' + Name.Class: "#000000", # class: 'nc' - to be revised + Name.Constant: "#000000", # class: 'no' - to be revised + Name.Decorator: "#888", # class: 'nd' - to be revised + Name.Entity: "#ce5c00", # class: 'ni' + Name.Exception: "bold #cc0000", # class: 'ne' + Name.Function: "#000000", # class: 'nf' + Name.Property: "#000000", # class: 'py' + Name.Label: "#f57900", # class: 'nl' + Name.Namespace: "#000000", # class: 'nn' - to be revised + Name.Other: "#000000", # class: 'nx' + Name.Tag: "bold #004461", # class: 'nt' - like a keyword + Name.Variable: "#000000", # class: 'nv' - to be revised + Name.Variable.Class: "#000000", # class: 'vc' - to be revised + Name.Variable.Global: "#000000", # class: 'vg' - to be revised + Name.Variable.Instance: "#000000", # class: 'vi' - to be revised + + Number: "#990000", # class: 'm' + + Literal: "#000000", # class: 'l' + Literal.Date: "#000000", # class: 'ld' + + String: "#4e9a06", # class: 's' + String.Backtick: "#4e9a06", # class: 'sb' + String.Char: "#4e9a06", # class: 'sc' + String.Doc: "italic #8f5902", # class: 'sd' - like a comment + String.Double: "#4e9a06", # class: 's2' + String.Escape: "#4e9a06", # class: 'se' + String.Heredoc: "#4e9a06", # class: 'sh' + String.Interpol: "#4e9a06", # class: 'si' + String.Other: "#4e9a06", # class: 'sx' + String.Regex: "#4e9a06", # class: 'sr' + String.Single: "#4e9a06", # class: 's1' + String.Symbol: "#4e9a06", # class: 'ss' + + Generic: "#000000", # class: 'g' + Generic.Deleted: "#a40000", # class: 'gd' + Generic.Emph: "italic #000000", # class: 'ge' + Generic.Error: "#ef2929", # class: 'gr' + Generic.Heading: "bold #000080", # class: 'gh' + Generic.Inserted: "#00A000", # class: 'gi' + Generic.Output: "#888", # class: 'go' + Generic.Prompt: "#745334", # class: 'gp' + Generic.Strong: "bold #000000", # class: 'gs' + Generic.Subheading: "bold #800080", # class: 'gu' + Generic.Traceback: "bold #a40000", # class: 'gt' + } diff --git a/testing/web-platform/tests/tools/pytest/doc/en/adopt.rst b/testing/web-platform/tests/tools/pytest/doc/en/adopt.rst new file mode 100644 index 000000000..aead96e7f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/adopt.rst @@ -0,0 +1,78 @@ + +April 2015 is "adopt pytest month" +============================================= + +Are you an enthusiastic pytest user, the local testing guru in your workplace? Or are you considering using pytest for your open source project, but not sure how to get started? Then you may be interested in "adopt pytest month"! + +We will pair experienced pytest users with open source projects, for a month's effort of getting new development teams started with pytest. + +In 2015 we are trying this for the first time. In February and March 2015 we will gather volunteers on both sides, in April we will do the work, and in May we will evaluate how it went. This effort is being coordinated by Brianna Laugher. If you have any questions or comments, you can raise them on the `@pytestdotorg twitter account <https://twitter.com/pytestdotorg>`_ the `issue tracker`_ or the `pytest-dev mailing list`_. + + +.. _`issue tracker`: https://github.com/pytest-dev/pytest/issues/676 +.. _`pytest-dev mailing list`: https://mail.python.org/mailman/listinfo/pytest-dev + + +The ideal pytest helper +----------------------------------------- + + - will be able to commit 2-4 hours a week to working with their particular project (this might involve joining their mailing list, installing the software and exploring any existing tests, offering advice, writing some example tests) + - feels confident in using pytest (e.g. has explored command line options, knows how to write parametrized tests, has an idea about conftest contents) + - does not need to be an expert in every aspect! + +`Pytest helpers, sign up here`_! (preferably in February, hard deadline 22 March) + + +.. _`Pytest helpers, sign up here`: http://goo.gl/forms/nxqAhqWt1P + + +The ideal partner project +----------------------------------------- + + - is open source, and predominantly written in Python + - has an automated/documented install process for developers + - has more than one core developer + - has at least one official release (e.g. is available on pypi) + - has the support of the core development team, in trying out pytest adoption + - has no tests... or 100% test coverage... or somewhere in between! + +`Partner projects, sign up here`_! (by 22 March) + + +.. _`Partner projects, sign up here`: http://goo.gl/forms/ZGyqlHiwk3 + + +What does it mean to "adopt pytest"? +----------------------------------------- + +There can be many different definitions of "success". Pytest can run many `nose and unittest`_ tests by default, so using pytest as your testrunner may be possible from day 1. Job done, right? + +Progressive success might look like: + + - tests can be run (by pytest) without errors (there may be failures) + - tests can be run (by pytest) without failures + - test runner is integrated into CI server + - existing tests are rewritten to take advantage of pytest features - this can happen in several iterations, for example: + - changing to native assert_ statements (pycmd_ has a script to help with that, ``pyconvert_unittest.py``) + - changing `setUp/tearDown methods`_ to fixtures_ + - adding markers_ + - other changes to reduce boilerplate + - assess needs for future tests to be written, e.g. new fixtures, distributed_ testing tweaks + +"Success" should also include that the development team feels comfortable with their knowledge of how to use pytest. In fact this is probably more important than anything else. So spending a lot of time on communication, giving examples, etc will probably be important - both in running the tests, and in writing them. + +It may be after the month is up, the partner project decides that pytest is not right for it. That's okay - hopefully the pytest team will also learn something about its weaknesses or deficiencies. + +.. _`nose and unittest`: faq.html#how-does-pytest-relate-to-nose-and-unittest +.. _assert: asserts.html +.. _pycmd: https://bitbucket.org/hpk42/pycmd/overview +.. _`setUp/tearDown methods`: xunit_setup.html +.. _fixtures: fixture.html +.. _markers: markers.html +.. _distributed: xdist.html + + +Other ways to help +----------------------------------------- + +Promote! Do your favourite open source Python projects use pytest? If not, why not tell them about this page? diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/index.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/index.rst new file mode 100644 index 000000000..877afff77 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/index.rst @@ -0,0 +1,48 @@ + +Release announcements +=========================================== + +.. toctree:: + :maxdepth: 2 + + + sprint2016 + release-2.9.0 + release-2.8.7 + release-2.8.6 + release-2.8.5 + release-2.8.4 + release-2.8.3 + release-2.8.2 + release-2.7.2 + release-2.7.1 + release-2.7.0 + release-2.6.3 + release-2.6.2 + release-2.6.1 + release-2.6.0 + release-2.5.2 + release-2.5.1 + release-2.5.0 + release-2.4.2 + release-2.4.1 + release-2.4.0 + release-2.3.5 + release-2.3.4 + release-2.3.3 + release-2.3.2 + release-2.3.1 + release-2.3.0 + release-2.2.4 + release-2.2.2 + release-2.2.1 + release-2.2.0 + release-2.1.3 + release-2.1.2 + release-2.1.1 + release-2.1.0 + release-2.0.3 + release-2.0.2 + release-2.0.1 + release-2.0.0 + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.0.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.0.rst new file mode 100644 index 000000000..af745fc59 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.0.rst @@ -0,0 +1,129 @@ +py.test 2.0.0: asserts++, unittest++, reporting++, config++, docs++ +=========================================================================== + +Welcome to pytest-2.0.0, a major new release of "py.test", the rapid +easy Python testing tool. There are many new features and enhancements, +see below for summary and detailed lists. A lot of long-deprecated code +has been removed, resulting in a much smaller and cleaner +implementation. See the new docs with examples here: + + http://pytest.org/2.0.0/index.html + +A note on packaging: pytest used to part of the "py" distribution up +until version py-1.3.4 but this has changed now: pytest-2.0.0 only +contains py.test related code and is expected to be backward-compatible +to existing test code. If you want to install pytest, just type one of:: + + pip install -U pytest + easy_install -U pytest + +Many thanks to all issue reporters and people asking questions or +complaining. Particular thanks to Floris Bruynooghe and Ronny Pfannschmidt +for their great coding contributions and many others for feedback and help. + +best, +holger krekel + + +New Features +----------------------- + +- new invocations through Python interpreter and from Python:: + + python -m pytest # on all pythons >= 2.5 + + or from a python program:: + + import pytest ; pytest.main(arglist, pluginlist) + + see http://pytest.org/2.0.0/usage.html for details. + +- new and better reporting information in assert expressions + if comparing lists, sequences or strings. + + see http://pytest.org/2.0.0/assert.html#newreport + +- new configuration through ini-files (setup.cfg or tox.ini recognized), + for example:: + + [pytest] + norecursedirs = .hg data* # don't ever recurse in such dirs + addopts = -x --pyargs # add these command line options by default + + see http://pytest.org/2.0.0/customize.html + +- improved standard unittest support. In general py.test should now + better be able to run custom unittest.TestCases like twisted trial + or Django based TestCases. Also you can now run the tests of an + installed 'unittest' package with py.test:: + + py.test --pyargs unittest + +- new "-q" option which decreases verbosity and prints a more + nose/unittest-style "dot" output. + +- many many more detailed improvements details + +Fixes +----------------------- + +- fix issue126 - introduce py.test.set_trace() to trace execution via + PDB during the running of tests even if capturing is ongoing. +- fix issue124 - make reporting more resilient against tests opening + files on filedescriptor 1 (stdout). +- fix issue109 - sibling conftest.py files will not be loaded. + (and Directory collectors cannot be customized anymore from a Directory's + conftest.py - this needs to happen at least one level up). +- fix issue88 (finding custom test nodes from command line arg) +- fix issue93 stdout/stderr is captured while importing conftest.py +- fix bug: unittest collected functions now also can have "pytestmark" + applied at class/module level + +Important Notes +-------------------- + +* The usual way in pre-2.0 times to use py.test in python code was + to import "py" and then e.g. use "py.test.raises" for the helper. + This remains valid and is not planned to be deprecated. However, + in most examples and internal code you'll find "import pytest" + and "pytest.raises" used as the recommended default way. + +* pytest now first performs collection of the complete test suite + before running any test. This changes for example the semantics of when + pytest_collectstart/pytest_collectreport are called. Some plugins may + need upgrading. + +* The pytest package consists of a 400 LOC core.py and about 20 builtin plugins, + summing up to roughly 5000 LOCs, including docstrings. To be fair, it also + uses generic code from the "pylib", and the new "py" package to help + with filesystem and introspection/code manipulation. + +(Incompatible) Removals +----------------------------- + +- py.test.config is now only available if you are in a test run. + +- the following (mostly already deprecated) functionality was removed: + + - removed support for Module/Class/... collection node definitions + in conftest.py files. They will cause nothing special. + - removed support for calling the pre-1.0 collection API of "run()" and "join" + - removed reading option values from conftest.py files or env variables. + This can now be done much much better and easier through the ini-file + mechanism and the "addopts" entry in particular. + - removed the "disabled" attribute in test classes. Use the skipping + and pytestmark mechanism to skip or xfail a test class. + +- py.test.collect.Directory does not exist anymore and it + is not possible to provide an own "Directory" object. + If you have used this and don't know what to do, get + in contact. We'll figure something out. + + Note that pytest_collect_directory() is still called but + any return value will be ignored. This allows to keep + old code working that performed for example "py.test.skip()" + in collect() to prevent recursion into directory trees + if a certain dependency or command line option is missing. + + +see :ref:`changelog` for more detailed changes. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.1.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.1.rst new file mode 100644 index 000000000..2f41ef943 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.1.rst @@ -0,0 +1,67 @@ +py.test 2.0.1: bug fixes +=========================================================================== + +Welcome to pytest-2.0.1, a maintenance and bug fix release of pytest, +a mature testing tool for Python, supporting CPython 2.4-3.2, Jython +and latest PyPy interpreters. See extensive docs with tested examples here: + + http://pytest.org/ + +If you want to install or upgrade pytest, just type one of:: + + pip install -U pytest # or + easy_install -U pytest + +Many thanks to all issue reporters and people asking questions or +complaining. Particular thanks to Floris Bruynooghe and Ronny Pfannschmidt +for their great coding contributions and many others for feedback and help. + +best, +holger krekel + +Changes between 2.0.0 and 2.0.1 +---------------------------------------------- + +- refine and unify initial capturing so that it works nicely + even if the logging module is used on an early-loaded conftest.py + file or plugin. +- fix issue12 - show plugin versions with "--version" and + "--traceconfig" and also document how to add extra information + to reporting test header +- fix issue17 (import-* reporting issue on python3) by + requiring py>1.4.0 (1.4.1 is going to include it) +- fix issue10 (numpy arrays truth checking) by refining + assertion interpretation in py lib +- fix issue15: make nose compatibility tests compatible + with python3 (now that nose-1.0 supports python3) +- remove somewhat surprising "same-conftest" detection because + it ignores conftest.py when they appear in several subdirs. +- improve assertions ("not in"), thanks Floris Bruynooghe +- improve behaviour/warnings when running on top of "python -OO" + (assertions and docstrings are turned off, leading to potential + false positives) +- introduce a pytest_cmdline_processargs(args) hook + to allow dynamic computation of command line arguments. + This fixes a regression because py.test prior to 2.0 + allowed to set command line options from conftest.py + files which so far pytest-2.0 only allowed from ini-files now. +- fix issue7: assert failures in doctest modules. + unexpected failures in doctests will not generally + show nicer, i.e. within the doctest failing context. +- fix issue9: setup/teardown functions for an xfail-marked + test will report as xfail if they fail but report as normally + passing (not xpassing) if they succeed. This only is true + for "direct" setup/teardown invocations because teardown_class/ + teardown_module cannot closely relate to a single test. +- fix issue14: no logging errors at process exit +- refinements to "collecting" output on non-ttys +- refine internal plugin registration and --traceconfig output +- introduce a mechanism to prevent/unregister plugins from the + command line, see http://pytest.org/latest/plugins.html#cmdunregister +- activate resultlog plugin by default +- fix regression wrt yielded tests which due to the + collection-before-running semantics were not + setup as with pytest 1.3.4. Note, however, that + the recommended and much cleaner way to do test + parametrization remains the "pytest_generate_tests" + mechanism, see the docs. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.2.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.2.rst new file mode 100644 index 000000000..733a9f7bd --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.2.rst @@ -0,0 +1,73 @@ +py.test 2.0.2: bug fixes, improved xfail/skip expressions, speed ups +=========================================================================== + +Welcome to pytest-2.0.2, a maintenance and bug fix release of pytest, +a mature testing tool for Python, supporting CPython 2.4-3.2, Jython +and latest PyPy interpreters. See the extensive docs with tested examples here: + + http://pytest.org/ + +If you want to install or upgrade pytest, just type one of:: + + pip install -U pytest # or + easy_install -U pytest + +Many thanks to all issue reporters and people asking questions +or complaining, particularly Jurko for his insistence, +Laura, Victor and Brianna for helping with improving +and Ronny for his general advise. + +best, +holger krekel + +Changes between 2.0.1 and 2.0.2 +---------------------------------------------- + +- tackle issue32 - speed up test runs of very quick test functions + by reducing the relative overhead + +- fix issue30 - extended xfail/skipif handling and improved reporting. + If you have a syntax error in your skip/xfail + expressions you now get nice error reports. + + Also you can now access module globals from xfail/skipif + expressions so that this for example works now:: + + import pytest + import mymodule + @pytest.mark.skipif("mymodule.__version__[0] == "1") + def test_function(): + pass + + This will not run the test function if the module's version string + does not start with a "1". Note that specifying a string instead + of a boolean expressions allows py.test to report meaningful information + when summarizing a test run as to what conditions lead to skipping + (or xfail-ing) tests. + +- fix issue28 - setup_method and pytest_generate_tests work together + The setup_method fixture method now gets called also for + test function invocations generated from the pytest_generate_tests + hook. + +- fix issue27 - collectonly and keyword-selection (-k) now work together + Also, if you do "py.test --collectonly -q" you now get a flat list + of test ids that you can use to paste to the py.test commandline + in order to execute a particular test. + +- fix issue25 avoid reported problems with --pdb and python3.2/encodings output + +- fix issue23 - tmpdir argument now works on Python3.2 and WindowsXP + Starting with Python3.2 os.symlink may be supported. By requiring + a newer py lib version the py.path.local() implementation acknowledges + this. + +- fixed typos in the docs (thanks Victor Garcia, Brianna Laugher) and particular + thanks to Laura Creighton who also revieved parts of the documentation. + +- fix slighly wrong output of verbose progress reporting for classes + (thanks Amaury) + +- more precise (avoiding of) deprecation warnings for node.Class|Function accesses + +- avoid std unittest assertion helper code in tracebacks (thanks Ronny) diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.3.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.3.rst new file mode 100644 index 000000000..ed746e851 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.0.3.rst @@ -0,0 +1,40 @@ +py.test 2.0.3: bug fixes and speed ups +=========================================================================== + +Welcome to pytest-2.0.3, a maintenance and bug fix release of pytest, +a mature testing tool for Python, supporting CPython 2.4-3.2, Jython +and latest PyPy interpreters. See the extensive docs with tested examples here: + + http://pytest.org/ + +If you want to install or upgrade pytest, just type one of:: + + pip install -U pytest # or + easy_install -U pytest + +There also is a bugfix release 1.6 of pytest-xdist, the plugin +that enables seemless distributed and "looponfail" testing for Python. + +best, +holger krekel + +Changes between 2.0.2 and 2.0.3 +---------------------------------------------- + +- fix issue38: nicer tracebacks on calls to hooks, particularly early + configure/sessionstart ones + +- fix missing skip reason/meta information in junitxml files, reported + via http://lists.idyll.org/pipermail/testing-in-python/2011-March/003928.html + +- fix issue34: avoid collection failure with "test" prefixed classes + deriving from object. + +- don't require zlib (and other libs) for genscript plugin without + --genscript actually being used. + +- speed up skips (by not doing a full traceback represenation + internally) + +- fix issue37: avoid invalid characters in junitxml's output + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.0.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.0.rst new file mode 100644 index 000000000..831548ac2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.0.rst @@ -0,0 +1,47 @@ +py.test 2.1.0: perfected assertions and bug fixes +=========================================================================== + +Welcome to the release of pytest-2.1, a mature testing tool for Python, +supporting CPython 2.4-3.2, Jython and latest PyPy interpreters. See +the improved extensive docs (now also as PDF!) with tested examples here: + + http://pytest.org/ + +The single biggest news about this release are **perfected assertions** +courtesy of Benjamin Peterson. You can now safely use ``assert`` +statements in test modules without having to worry about side effects +or python optimization ("-OO") options. This is achieved by rewriting +assert statements in test modules upon import, using a PEP302 hook. +See http://pytest.org/assert.html#advanced-assertion-introspection for +detailed information. The work has been partly sponsored by my company, +merlinux GmbH. + +For further details on bug fixes and smaller enhancements see below. + +If you want to install or upgrade pytest, just type one of:: + + pip install -U pytest # or + easy_install -U pytest + +best, +holger krekel / http://merlinux.eu + +Changes between 2.0.3 and 2.1.0 +---------------------------------------------- + +- fix issue53 call nosestyle setup functions with correct ordering +- fix issue58 and issue59: new assertion code fixes +- merge Benjamin's assertionrewrite branch: now assertions + for test modules on python 2.6 and above are done by rewriting + the AST and saving the pyc file before the test module is imported. + see doc/assert.txt for more info. +- fix issue43: improve doctests with better traceback reporting on + unexpected exceptions +- fix issue47: timing output in junitxml for test cases is now correct +- fix issue48: typo in MarkInfo repr leading to exception +- fix issue49: avoid confusing error when initialization partially fails +- fix issue44: env/username expansion for junitxml file path +- show releaselevel information in test runs for pypy +- reworked doc pages for better navigation and PDF generation +- report KeyboardInterrupt even if interrupted during session startup +- fix issue 35 - provide PDF doc version and download link from index page diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.1.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.1.rst new file mode 100644 index 000000000..ecdd69f4d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.1.rst @@ -0,0 +1,37 @@ +py.test 2.1.1: assertion fixes and improved junitxml output +=========================================================================== + +pytest-2.1.1 is a backward compatible maintenance release of the +popular py.test testing tool. See extensive docs with examples here: + + http://pytest.org/ + +Most bug fixes address remaining issues with the perfected assertions +introduced with 2.1.0 - many thanks to the bug reporters and to Benjamin +Peterson for helping to fix them. Also, junitxml output now produces +system-out/err tags which lead to better displays of tracebacks with Jenkins. + +Also a quick note to package maintainers and others interested: there now +is a "pytest" man page which can be generated with "make man" in doc/. + +If you want to install or upgrade pytest, just type one of:: + + pip install -U pytest # or + easy_install -U pytest + +best, +holger krekel / http://merlinux.eu + +Changes between 2.1.0 and 2.1.1 +---------------------------------------------- + +- fix issue64 / pytest.set_trace now works within pytest_generate_tests hooks +- fix issue60 / fix error conditions involving the creation of __pycache__ +- fix issue63 / assertion rewriting on inserts involving strings containing '%' +- fix assertion rewriting on calls with a ** arg +- don't cache rewritten modules if bytecode generation is disabled +- fix assertion rewriting in read-only directories +- fix issue59: provide system-out/err tags for junitxml output +- fix issue61: assertion rewriting on boolean operations with 3 or more operands +- you can now build a man page with "cd doc ; make man" + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.2.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.2.rst new file mode 100644 index 000000000..51b7591d3 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.2.rst @@ -0,0 +1,33 @@ +py.test 2.1.2: bug fixes and fixes for jython +=========================================================================== + +pytest-2.1.2 is a minor backward compatible maintenance release of the +popular py.test testing tool. pytest is commonly used for unit, +functional- and integration testing. See extensive docs with examples +here: + + http://pytest.org/ + +Most bug fixes address remaining issues with the perfected assertions +introduced in the 2.1 series - many thanks to the bug reporters and to Benjamin +Peterson for helping to fix them. pytest should also work better with +Jython-2.5.1 (and Jython trunk). + +If you want to install or upgrade pytest, just type one of:: + + pip install -U pytest # or + easy_install -U pytest + +best, +holger krekel / http://merlinux.eu + +Changes between 2.1.1 and 2.1.2 +---------------------------------------- + +- fix assertion rewriting on files with windows newlines on some Python versions +- refine test discovery by package/module name (--pyargs), thanks Florian Mayer +- fix issue69 / assertion rewriting fixed on some boolean operations +- fix issue68 / packages now work with assertion rewriting +- fix issue66: use different assertion rewriting caches when the -O option is passed +- don't try assertion rewriting on Jython, use reinterp + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.3.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.3.rst new file mode 100644 index 000000000..f4da60b8b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.1.3.rst @@ -0,0 +1,32 @@ +py.test 2.1.3: just some more fixes +=========================================================================== + +pytest-2.1.3 is a minor backward compatible maintenance release of the +popular py.test testing tool. It is commonly used for unit, functional- +and integration testing. See extensive docs with examples here: + + http://pytest.org/ + +The release contains another fix to the perfected assertions introduced +with the 2.1 series as well as the new possibility to customize reporting +for assertion expressions on a per-directory level. + +If you want to install or upgrade pytest, just type one of:: + + pip install -U pytest # or + easy_install -U pytest + +Thanks to the bug reporters and to Ronny Pfannschmidt, Benjamin Peterson +and Floris Bruynooghe who implemented the fixes. + +best, +holger krekel + +Changes between 2.1.2 and 2.1.3 +---------------------------------------- + +- fix issue79: assertion rewriting failed on some comparisons in boolops, +- correctly handle zero length arguments (a la pytest '') +- fix issue67 / junitxml now contains correct test durations +- fix issue75 / skipping test failure on jython +- fix issue77 / Allow assertrepr_compare hook to apply to a subset of tests diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.0.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.0.rst new file mode 100644 index 000000000..20bfe0a19 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.0.rst @@ -0,0 +1,95 @@ +py.test 2.2.0: test marking++, parametrization++ and duration profiling +=========================================================================== + +pytest-2.2.0 is a test-suite compatible release of the popular +py.test testing tool. Plugins might need upgrades. It comes +with these improvements: + +* easier and more powerful parametrization of tests: + + - new @pytest.mark.parametrize decorator to run tests with different arguments + - new metafunc.parametrize() API for parametrizing arguments independently + - see examples at http://pytest.org/latest/example/parametrize.html + - NOTE that parametrize() related APIs are still a bit experimental + and might change in future releases. + +* improved handling of test markers and refined marking mechanism: + + - "-m markexpr" option for selecting tests according to their mark + - a new "markers" ini-variable for registering test markers for your project + - the new "--strict" bails out with an error if using unregistered markers. + - see examples at http://pytest.org/latest/example/markers.html + +* duration profiling: new "--duration=N" option showing the N slowest test + execution or setup/teardown calls. This is most useful if you want to + find out where your slowest test code is. + +* also 2.2.0 performs more eager calling of teardown/finalizers functions + resulting in better and more accurate reporting when they fail + +Besides there is the usual set of bug fixes along with a cleanup of +pytest's own test suite allowing it to run on a wider range of environments. + +For general information, see extensive docs with examples here: + + http://pytest.org/ + +If you want to install or upgrade pytest you might just type:: + + pip install -U pytest # or + easy_install -U pytest + +Thanks to Ronny Pfannschmidt, David Burns, Jeff Donner, Daniel Nouri, Alfredo Deza and all who gave feedback or sent bug reports. + +best, +holger krekel + + +notes on incompatibility +------------------------------ + +While test suites should work unchanged you might need to upgrade plugins: + +* You need a new version of the pytest-xdist plugin (1.7) for distributing + test runs. + +* Other plugins might need an upgrade if they implement + the ``pytest_runtest_logreport`` hook which now is called unconditionally + for the setup/teardown fixture phases of a test. You may choose to + ignore setup/teardown failures by inserting "if rep.when != 'call': return" + or something similar. Note that most code probably "just" works because + the hook was already called for failing setup/teardown phases of a test + so a plugin should have been ready to grok such reports already. + + +Changes between 2.1.3 and 2.2.0 +---------------------------------------- + +- fix issue90: introduce eager tearing down of test items so that + teardown function are called earlier. +- add an all-powerful metafunc.parametrize function which allows to + parametrize test function arguments in multiple steps and therefore + from independent plugins and places. +- add a @pytest.mark.parametrize helper which allows to easily + call a test function with different argument values. +- Add examples to the "parametrize" example page, including a quick port + of Test scenarios and the new parametrize function and decorator. +- introduce registration for "pytest.mark.*" helpers via ini-files + or through plugin hooks. Also introduce a "--strict" option which + will treat unregistered markers as errors + allowing to avoid typos and maintain a well described set of markers + for your test suite. See examples at http://pytest.org/latest/mark.html + and its links. +- issue50: introduce "-m marker" option to select tests based on markers + (this is a stricter and more predictable version of "-k" in that "-m" + only matches complete markers and has more obvious rules for and/or + semantics. +- new feature to help optimizing the speed of your tests: + --durations=N option for displaying N slowest test calls + and setup/teardown methods. +- fix issue87: --pastebin now works with python3 +- fix issue89: --pdb with unexpected exceptions in doctest work more sensibly +- fix and cleanup pytest's own test suite to not leak FDs +- fix issue83: link to generated funcarg list +- fix issue74: pyarg module names are now checked against imp.find_module false positives +- fix compatibility with twisted/trial-11.1.0 use cases diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.1.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.1.rst new file mode 100644 index 000000000..f9764634c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.1.rst @@ -0,0 +1,41 @@ +pytest-2.2.1: bug fixes, perfect teardowns +=========================================================================== + + +pytest-2.2.1 is a minor backward-compatible release of the the py.test +testing tool. It contains bug fixes and little improvements, including +documentation fixes. If you are using the distributed testing +pluginmake sure to upgrade it to pytest-xdist-1.8. + +For general information see here: + + http://pytest.org/ + +To install or upgrade pytest: + + pip install -U pytest # or + easy_install -U pytest + +Special thanks for helping on this release to Ronny Pfannschmidt, Jurko +Gospodnetic and Ralf Schmitt. + +best, +holger krekel + + +Changes between 2.2.0 and 2.2.1 +---------------------------------------- + +- fix issue99 (in pytest and py) internallerrors with resultlog now + produce better output - fixed by normalizing pytest_internalerror + input arguments. +- fix issue97 / traceback issues (in pytest and py) improve traceback output + in conjunction with jinja2 and cython which hack tracebacks +- fix issue93 (in pytest and pytest-xdist) avoid "delayed teardowns": + the final test in a test node will now run its teardown directly + instead of waiting for the end of the session. Thanks Dave Hunt for + the good reporting and feedback. The pytest_runtest_protocol as well + as the pytest_runtest_teardown hooks now have "nextitem" available + which will be None indicating the end of the test run. +- fix collection crash due to unknown-source collected items, thanks + to Ralf Schmitt (fixed by depending on a more recent pylib) diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.2.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.2.rst new file mode 100644 index 000000000..733aedec4 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.2.rst @@ -0,0 +1,43 @@ +pytest-2.2.2: bug fixes +=========================================================================== + +pytest-2.2.2 (updated to 2.2.3 to fix packaging issues) is a minor +backward-compatible release of the versatile py.test testing tool. It +contains bug fixes and a few refinements particularly to reporting with +"--collectonly", see below for betails. + +For general information see here: + + http://pytest.org/ + +To install or upgrade pytest: + + pip install -U pytest # or + easy_install -U pytest + +Special thanks for helping on this release to Ronny Pfannschmidt +and Ralf Schmitt and the contributors of issues. + +best, +holger krekel + + +Changes between 2.2.1 and 2.2.2 +---------------------------------------- + +- fix issue101: wrong args to unittest.TestCase test function now + produce better output +- fix issue102: report more useful errors and hints for when a + test directory was renamed and some pyc/__pycache__ remain +- fix issue106: allow parametrize to be applied multiple times + e.g. from module, class and at function level. +- fix issue107: actually perform session scope finalization +- don't check in parametrize if indirect parameters are funcarg names +- add chdir method to monkeypatch funcarg +- fix crash resulting from calling monkeypatch undo a second time +- fix issue115: make --collectonly robust against early failure + (missing files/directories) +- "-qq --collectonly" now shows only files and the number of tests in them +- "-q --collectonly" now shows test ids +- allow adding of attributes to test reports such that it also works + with distributed testing (no upgrade of pytest-xdist needed) diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.4.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.4.rst new file mode 100644 index 000000000..8720bdb28 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.2.4.rst @@ -0,0 +1,39 @@ +pytest-2.2.4: bug fixes, better junitxml/unittest/python3 compat +=========================================================================== + +pytest-2.2.4 is a minor backward-compatible release of the versatile +py.test testing tool. It contains bug fixes and a few refinements +to junitxml reporting, better unittest- and python3 compatibility. + +For general information see here: + + http://pytest.org/ + +To install or upgrade pytest: + + pip install -U pytest # or + easy_install -U pytest + +Special thanks for helping on this release to Ronny Pfannschmidt +and Benjamin Peterson and the contributors of issues. + +best, +holger krekel + +Changes between 2.2.3 and 2.2.4 +----------------------------------- + +- fix error message for rewritten assertions involving the % operator +- fix issue 126: correctly match all invalid xml characters for junitxml + binary escape +- fix issue with unittest: now @unittest.expectedFailure markers should + be processed correctly (you can also use @pytest.mark markers) +- document integration with the extended distribute/setuptools test commands +- fix issue 140: propperly get the real functions + of bound classmethods for setup/teardown_class +- fix issue #141: switch from the deceased paste.pocoo.org to bpaste.net +- fix issue #143: call unconfigure/sessionfinish always when + configure/sessionstart where called +- fix issue #144: better mangle test ids to junitxml classnames +- upgrade distribute_setup.py to 0.6.27 + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.0.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.0.rst new file mode 100644 index 000000000..54fe3961f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.0.rst @@ -0,0 +1,134 @@ +pytest-2.3: improved fixtures / better unittest integration +============================================================================= + +pytest-2.3 comes with many major improvements for fixture/funcarg management +and parametrized testing in Python. It is now easier, more efficient and +more predicatable to re-run the same tests with different fixture +instances. Also, you can directly declare the caching "scope" of +fixtures so that dependent tests throughout your whole test suite can +re-use database or other expensive fixture objects with ease. Lastly, +it's possible for fixture functions (formerly known as funcarg +factories) to use other fixtures, allowing for a completely modular and +re-useable fixture design. + +For detailed info and tutorial-style examples, see: + + http://pytest.org/latest/fixture.html + +Moreover, there is now support for using pytest fixtures/funcargs with +unittest-style suites, see here for examples: + + http://pytest.org/latest/unittest.html + +Besides, more unittest-test suites are now expected to "simply work" +with pytest. + +All changes are backward compatible and you should be able to continue +to run your test suites and 3rd party plugins that worked with +pytest-2.2.4. + +If you are interested in the precise reasoning (including examples) of the +pytest-2.3 fixture evolution, please consult +http://pytest.org/latest/funcarg_compare.html + +For general info on installation and getting started: + + http://pytest.org/latest/getting-started.html + +Docs and PDF access as usual at: + + http://pytest.org + +and more details for those already in the knowing of pytest can be found +in the CHANGELOG below. + +Particular thanks for this release go to Floris Bruynooghe, Alex Okrushko +Carl Meyer, Ronny Pfannschmidt, Benjamin Peterson and Alex Gaynor for helping +to get the new features right and well integrated. Ronny and Floris +also helped to fix a number of bugs and yet more people helped by +providing bug reports. + +have fun, +holger krekel + + +Changes between 2.2.4 and 2.3.0 +----------------------------------- + +- fix issue202 - better automatic names for parametrized test functions +- fix issue139 - introduce @pytest.fixture which allows direct scoping + and parametrization of funcarg factories. Introduce new @pytest.setup + marker to allow the writing of setup functions which accept funcargs. +- fix issue198 - conftest fixtures were not found on windows32 in some + circumstances with nested directory structures due to path manipulation issues +- fix issue193 skip test functions with were parametrized with empty + parameter sets +- fix python3.3 compat, mostly reporting bits that previously depended + on dict ordering +- introduce re-ordering of tests by resource and parametrization setup + which takes precedence to the usual file-ordering +- fix issue185 monkeypatching time.time does not cause pytest to fail +- fix issue172 duplicate call of pytest.setup-decoratored setup_module + functions +- fix junitxml=path construction so that if tests change the + current working directory and the path is a relative path + it is constructed correctly from the original current working dir. +- fix "python setup.py test" example to cause a proper "errno" return +- fix issue165 - fix broken doc links and mention stackoverflow for FAQ +- catch unicode-issues when writing failure representations + to terminal to prevent the whole session from crashing +- fix xfail/skip confusion: a skip-mark or an imperative pytest.skip + will now take precedence before xfail-markers because we + can't determine xfail/xpass status in case of a skip. see also: + http://stackoverflow.com/questions/11105828/in-py-test-when-i-explicitly-skip-a-test-that-is-marked-as-xfail-how-can-i-get + +- always report installed 3rd party plugins in the header of a test run + +- fix issue160: a failing setup of an xfail-marked tests should + be reported as xfail (not xpass) + +- fix issue128: show captured output when capsys/capfd are used + +- fix issue179: propperly show the dependency chain of factories + +- pluginmanager.register(...) now raises ValueError if the + plugin has been already registered or the name is taken + +- fix issue159: improve http://pytest.org/latest/faq.html + especially with respect to the "magic" history, also mention + pytest-django, trial and unittest integration. + +- make request.keywords and node.keywords writable. All descendant + collection nodes will see keyword values. Keywords are dictionaries + containing markers and other info. + +- fix issue 178: xml binary escapes are now wrapped in py.xml.raw + +- fix issue 176: correctly catch the builtin AssertionError + even when we replaced AssertionError with a subclass on the + python level + +- factory discovery no longer fails with magic global callables + that provide no sane __code__ object (mock.call for example) + +- fix issue 182: testdir.inprocess_run now considers passed plugins + +- fix issue 188: ensure sys.exc_info is clear on python2 + before calling into a test + +- fix issue 191: add unittest TestCase runTest method support +- fix issue 156: monkeypatch correctly handles class level descriptors + +- reporting refinements: + + - pytest_report_header now receives a "startdir" so that + you can use startdir.bestrelpath(yourpath) to show + nice relative path + + - allow plugins to implement both pytest_report_header and + pytest_sessionstart (sessionstart is invoked first). + + - don't show deselected reason line if there is none + + - py.test -vv will show all of assert comparisations instead of truncating + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.1.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.1.rst new file mode 100644 index 000000000..b787dc203 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.1.rst @@ -0,0 +1,39 @@ +pytest-2.3.1: fix regression with factory functions +=========================================================================== + +pytest-2.3.1 is a quick follow-up release: + +- fix issue202 - regression with fixture functions/funcarg factories: + using "self" is now safe again and works as in 2.2.4. Thanks + to Eduard Schettino for the quick bug report. + +- disable pexpect pytest self tests on Freebsd - thanks Koob for the + quick reporting + +- fix/improve interactive docs with --markers + +See + + http://pytest.org/ + +for general information. To install or upgrade pytest: + + pip install -U pytest # or + easy_install -U pytest + +best, +holger krekel + + +Changes between 2.3.0 and 2.3.1 +----------------------------------- + +- fix issue202 - fix regression: using "self" from fixture functions now + works as expected (it's the same "self" instance that a test method + which uses the fixture sees) + +- skip pexpect using tests (test_pdb.py mostly) on freebsd* systems + due to pexpect not supporting it properly (hanging) + +- link to web pages from --markers output which provides help for + pytest.mark.* usage. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.2.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.2.rst new file mode 100644 index 000000000..948b374d4 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.2.rst @@ -0,0 +1,57 @@ +pytest-2.3.2: some fixes and more traceback-printing speed +=========================================================================== + +pytest-2.3.2 is a another stabilization release: + +- issue 205: fixes a regression with conftest detection +- issue 208/29: fixes traceback-printing speed in some bad cases +- fix teardown-ordering for parametrized setups +- fix unittest and trial compat behaviour with respect to runTest() methods +- issue 206 and others: some improvements to packaging +- fix issue127 and others: improve some docs + +See + + http://pytest.org/ + +for general information. To install or upgrade pytest: + + pip install -U pytest # or + easy_install -U pytest + +best, +holger krekel + + +Changes between 2.3.1 and 2.3.2 +----------------------------------- + +- fix issue208 and fix issue29 use new py version to avoid long pauses + when printing tracebacks in long modules + +- fix issue205 - conftests in subdirs customizing + pytest_pycollect_makemodule and pytest_pycollect_makeitem + now work properly + +- fix teardown-ordering for parametrized setups + +- fix issue127 - better documentation for pytest_addoption + and related objects. + +- fix unittest behaviour: TestCase.runtest only called if there are + test methods defined + +- improve trial support: don't collect its empty + unittest.TestCase.runTest() method + +- "python setup.py test" now works with pytest itself + +- fix/improve internal/packaging related bits: + + - exception message check of test_nose.py now passes on python33 as well + + - issue206 - fix test_assertrewrite.py to work when a global + PYTHONDONTWRITEBYTECODE=1 is present + + - add tox.ini to pytest distribution so that ignore-dirs and others config + bits are properly distributed for maintainers who run pytest-own tests diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.3.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.3.rst new file mode 100644 index 000000000..1d7c7027b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.3.rst @@ -0,0 +1,62 @@ +pytest-2.3.3: integration fixes, py24 suport, ``*/**`` shown in traceback +=========================================================================== + +pytest-2.3.3 is a another stabilization release of the py.test tool +which offers uebersimple assertions, scalable fixture mechanisms +and deep customization for testing with Python. Particularly, +this release provides: + +- integration fixes and improvements related to flask, numpy, nose, + unittest, mock + +- makes pytest work on py24 again (yes, people sometimes still need to use it) + +- show ``*,**`` args in pytest tracebacks + +Thanks to Manuel Jacob, Thomas Waldmann, Ronny Pfannschmidt, Pavel Repin +and Andreas Taumoefolau for providing patches and all for the issues. + +See + + http://pytest.org/ + +for general information. To install or upgrade pytest: + + pip install -U pytest # or + easy_install -U pytest + +best, +holger krekel + +Changes between 2.3.2 and 2.3.3 +----------------------------------- + +- fix issue214 - parse modules that contain special objects like e. g. + flask's request object which blows up on getattr access if no request + is active. thanks Thomas Waldmann. + +- fix issue213 - allow to parametrize with values like numpy arrays that + do not support an __eq__ operator + +- fix issue215 - split test_python.org into multiple files + +- fix issue148 - @unittest.skip on classes is now recognized and avoids + calling setUpClass/tearDownClass, thanks Pavel Repin + +- fix issue209 - reintroduce python2.4 support by depending on newer + pylib which re-introduced statement-finding for pre-AST interpreters + +- nose support: only call setup if its a callable, thanks Andrew + Taumoefolau + +- fix issue219 - add py2.4-3.3 classifiers to TROVE list + +- in tracebacks *,** arg values are now shown next to normal arguments + (thanks Manuel Jacob) + +- fix issue217 - support mock.patch with pytest's fixtures - note that + you need either mock-1.0.1 or the python3.3 builtin unittest.mock. + +- fix issue127 - improve documentation for pytest_addoption() and + add a ``config.getoption(name)`` helper function for consistency. + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.4.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.4.rst new file mode 100644 index 000000000..d6c597b54 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.4.rst @@ -0,0 +1,39 @@ +pytest-2.3.4: stabilization, more flexible selection via "-k expr" +=========================================================================== + +pytest-2.3.4 is a small stabilization release of the py.test tool +which offers uebersimple assertions, scalable fixture mechanisms +and deep customization for testing with Python. This release +comes with the following fixes and features: + +- make "-k" option accept an expressions the same as with "-m" so that one + can write: -k "name1 or name2" etc. This is a slight usage incompatibility + if you used special syntax like "TestClass.test_method" which you now + need to write as -k "TestClass and test_method" to match a certain + method in a certain test class. +- allow to dynamically define markers via + item.keywords[...]=assignment integrating with "-m" option +- yielded test functions will now have autouse-fixtures active but + cannot accept fixtures as funcargs - it's anyway recommended to + rather use the post-2.0 parametrize features instead of yield, see: + http://pytest.org/latest/example/parametrize.html +- fix autouse-issue where autouse-fixtures would not be discovered + if defined in a a/conftest.py file and tests in a/tests/test_some.py +- fix issue226 - LIFO ordering for fixture teardowns +- fix issue224 - invocations with >256 char arguments now work +- fix issue91 - add/discuss package/directory level setups in example +- fixes related to autouse discovery and calling + +Thanks in particular to Thomas Waldmann for spotting and reporting issues. + +See + + http://pytest.org/ + +for general information. To install or upgrade pytest: + + pip install -U pytest # or + easy_install -U pytest + +best, +holger krekel diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.5.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.5.rst new file mode 100644 index 000000000..c4e91e0e6 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.3.5.rst @@ -0,0 +1,97 @@ +pytest-2.3.5: bug fixes and little improvements +=========================================================================== + +pytest-2.3.5 is a maintenance release with many bug fixes and little +improvements. See the changelog below for details. No backward +compatibility issues are foreseen and all plugins which worked with the +prior version are expected to work unmodified. Speaking of which, a +few interesting new plugins saw the light last month: + +- pytest-instafail: show failure information while tests are running +- pytest-qt: testing of GUI applications written with QT/Pyside +- pytest-xprocess: managing external processes across test runs +- pytest-random: randomize test ordering + +And several others like pytest-django saw maintenance releases. +For a more complete list, check out +https://pypi.python.org/pypi?%3Aaction=search&term=pytest&submit=search. + +For general information see: + + http://pytest.org/ + +To install or upgrade pytest: + + pip install -U pytest # or + easy_install -U pytest + +Particular thanks to Floris, Ronny, Benjamin and the many bug reporters +and fix providers. + +may the fixtures be with you, +holger krekel + + +Changes between 2.3.4 and 2.3.5 +----------------------------------- + +- never consider a fixture function for test function collection + +- allow re-running of test items / helps to fix pytest-reruntests plugin + and also help to keep less fixture/resource references alive + +- put captured stdout/stderr into junitxml output even for passing tests + (thanks Adam Goucher) + +- Issue 265 - integrate nose setup/teardown with setupstate + so it doesnt try to teardown if it did not setup + +- issue 271 - dont write junitxml on slave nodes + +- Issue 274 - dont try to show full doctest example + when doctest does not know the example location + +- issue 280 - disable assertion rewriting on buggy CPython 2.6.0 + +- inject "getfixture()" helper to retrieve fixtures from doctests, + thanks Andreas Zeidler + +- issue 259 - when assertion rewriting, be consistent with the default + source encoding of ASCII on Python 2 + +- issue 251 - report a skip instead of ignoring classes with init + +- issue250 unicode/str mixes in parametrization names and values now works + +- issue257, assertion-triggered compilation of source ending in a + comment line doesn't blow up in python2.5 (fixed through py>=1.4.13.dev6) + +- fix --genscript option to generate standalone scripts that also + work with python3.3 (importer ordering) + +- issue171 - in assertion rewriting, show the repr of some + global variables + +- fix option help for "-k" + +- move long description of distribution into README.rst + +- improve docstring for metafunc.parametrize() + +- fix bug where using capsys with pytest.set_trace() in a test + function would break when looking at capsys.readouterr() + +- allow to specify prefixes starting with "_" when + customizing python_functions test discovery. (thanks Graham Horler) + +- improve PYTEST_DEBUG tracing output by puting + extra data on a new lines with additional indent + +- ensure OutcomeExceptions like skip/fail have initialized exception attributes + +- issue 260 - don't use nose special setup on plain unittest cases + +- fix issue134 - print the collect errors that prevent running specified test items + +- fix issue266 - accept unicode in MarkEvaluator expressions + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.4.0.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.4.0.rst new file mode 100644 index 000000000..88130c481 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.4.0.rst @@ -0,0 +1,225 @@ +pytest-2.4.0: new fixture features/hooks and bug fixes +=========================================================================== + +The just released pytest-2.4.0 brings many improvements and numerous +bug fixes while remaining plugin- and test-suite compatible apart +from a few supposedly very minor incompatibilities. See below for +a full list of details. A few feature highlights: + +- new yield-style fixtures `pytest.yield_fixture + <http://pytest.org/latest/yieldfixture.html>`_, allowing to use + existing with-style context managers in fixture functions. + +- improved pdb support: ``import pdb ; pdb.set_trace()`` now works + without requiring prior disabling of stdout/stderr capturing. + Also the ``--pdb`` options works now on collection and internal errors + and we introduced a new experimental hook for IDEs/plugins to + intercept debugging: ``pytest_exception_interact(node, call, report)``. + +- shorter monkeypatch variant to allow specifying an import path as + a target, for example: ``monkeypatch.setattr("requests.get", myfunc)`` + +- better unittest/nose compatibility: all teardown methods are now only + called if the corresponding setup method succeeded. + +- integrate tab-completion on command line options if you + have `argcomplete <http://pypi.python.org/pypi/argcomplete>`_ + configured. + +- allow boolean expression directly with skipif/xfail + if a "reason" is also specified. + +- a new hook ``pytest_load_initial_conftests`` allows plugins like + `pytest-django <http://pypi.python.org/pypi/pytest-django>`_ to + influence the environment before conftest files import ``django``. + +- reporting: color the last line red or green depending if + failures/errors occurred or everything passed. + +The documentation has been updated to accomodate the changes, +see `http://pytest.org <http://pytest.org>`_ + +To install or upgrade pytest:: + + pip install -U pytest # or + easy_install -U pytest + + +**Many thanks to all who helped, including Floris Bruynooghe, +Brianna Laugher, Andreas Pelme, Anthon van der Neut, Anatoly Bubenkoff, +Vladimir Keleshev, Mathieu Agopian, Ronny Pfannschmidt, Christian +Theunert and many others.** + +may passing tests be with you, + +holger krekel + +Changes between 2.3.5 and 2.4 +----------------------------------- + +known incompatibilities: + +- if calling --genscript from python2.7 or above, you only get a + standalone script which works on python2.7 or above. Use Python2.6 + to also get a python2.5 compatible version. + +- all xunit-style teardown methods (nose-style, pytest-style, + unittest-style) will not be called if the corresponding setup method failed, + see issue322 below. + +- the pytest_plugin_unregister hook wasn't ever properly called + and there is no known implementation of the hook - so it got removed. + +- pytest.fixture-decorated functions cannot be generators (i.e. use + yield) anymore. This change might be reversed in 2.4.1 if it causes + unforeseen real-life issues. However, you can always write and return + an inner function/generator and change the fixture consumer to iterate + over the returned generator. This change was done in lieu of the new + ``pytest.yield_fixture`` decorator, see below. + +new features: + +- experimentally introduce a new ``pytest.yield_fixture`` decorator + which accepts exactly the same parameters as pytest.fixture but + mandates a ``yield`` statement instead of a ``return statement`` from + fixture functions. This allows direct integration with "with-style" + context managers in fixture functions and generally avoids registering + of finalization callbacks in favour of treating the "after-yield" as + teardown code. Thanks Andreas Pelme, Vladimir Keleshev, Floris + Bruynooghe, Ronny Pfannschmidt and many others for discussions. + +- allow boolean expression directly with skipif/xfail + if a "reason" is also specified. Rework skipping documentation + to recommend "condition as booleans" because it prevents surprises + when importing markers between modules. Specifying conditions + as strings will remain fully supported. + +- reporting: color the last line red or green depending if + failures/errors occurred or everything passed. thanks Christian + Theunert. + +- make "import pdb ; pdb.set_trace()" work natively wrt capturing (no + "-s" needed anymore), making ``pytest.set_trace()`` a mere shortcut. + +- fix issue181: --pdb now also works on collect errors (and + on internal errors) . This was implemented by a slight internal + refactoring and the introduction of a new hook + ``pytest_exception_interact`` hook (see next item). + +- fix issue341: introduce new experimental hook for IDEs/terminals to + intercept debugging: ``pytest_exception_interact(node, call, report)``. + +- new monkeypatch.setattr() variant to provide a shorter + invocation for patching out classes/functions from modules: + + monkeypatch.setattr("requests.get", myfunc) + + will replace the "get" function of the "requests" module with ``myfunc``. + +- fix issue322: tearDownClass is not run if setUpClass failed. Thanks + Mathieu Agopian for the initial fix. Also make all of pytest/nose + finalizer mimick the same generic behaviour: if a setupX exists and + fails, don't run teardownX. This internally introduces a new method + "node.addfinalizer()" helper which can only be called during the setup + phase of a node. + +- simplify pytest.mark.parametrize() signature: allow to pass a + CSV-separated string to specify argnames. For example: + ``pytest.mark.parametrize("input,expected", [(1,2), (2,3)])`` + works as well as the previous: + ``pytest.mark.parametrize(("input", "expected"), ...)``. + +- add support for setUpModule/tearDownModule detection, thanks Brian Okken. + +- integrate tab-completion on options through use of "argcomplete". + Thanks Anthon van der Neut for the PR. + +- change option names to be hyphen-separated long options but keep the + old spelling backward compatible. py.test -h will only show the + hyphenated version, for example "--collect-only" but "--collectonly" + will remain valid as well (for backward-compat reasons). Many thanks to + Anthon van der Neut for the implementation and to Hynek Schlawack for + pushing us. + +- fix issue 308 - allow to mark/xfail/skip individual parameter sets + when parametrizing. Thanks Brianna Laugher. + +- call new experimental pytest_load_initial_conftests hook to allow + 3rd party plugins to do something before a conftest is loaded. + +Bug fixes: + +- fix issue358 - capturing options are now parsed more properly + by using a new parser.parse_known_args method. + +- pytest now uses argparse instead of optparse (thanks Anthon) which + means that "argparse" is added as a dependency if installing into python2.6 + environments or below. + +- fix issue333: fix a case of bad unittest/pytest hook interaction. + +- PR27: correctly handle nose.SkipTest during collection. Thanks + Antonio Cuni, Ronny Pfannschmidt. + +- fix issue355: junitxml puts name="pytest" attribute to testsuite tag. + +- fix issue336: autouse fixture in plugins should work again. + +- fix issue279: improve object comparisons on assertion failure + for standard datatypes and recognise collections.abc. Thanks to + Brianna Laugher and Mathieu Agopian. + +- fix issue317: assertion rewriter support for the is_package method + +- fix issue335: document py.code.ExceptionInfo() object returned + from pytest.raises(), thanks Mathieu Agopian. + +- remove implicit distribute_setup support from setup.py. + +- fix issue305: ignore any problems when writing pyc files. + +- SO-17664702: call fixture finalizers even if the fixture function + partially failed (finalizers would not always be called before) + +- fix issue320 - fix class scope for fixtures when mixed with + module-level functions. Thanks Anatloy Bubenkoff. + +- you can specify "-q" or "-qq" to get different levels of "quieter" + reporting (thanks Katarzyna Jachim) + +- fix issue300 - Fix order of conftest loading when starting py.test + in a subdirectory. + +- fix issue323 - sorting of many module-scoped arg parametrizations + +- make sessionfinish hooks execute with the same cwd-context as at + session start (helps fix plugin behaviour which write output files + with relative path such as pytest-cov) + +- fix issue316 - properly reference collection hooks in docs + +- fix issue 306 - cleanup of -k/-m options to only match markers/test + names/keywords respectively. Thanks Wouter van Ackooy. + +- improved doctest counting for doctests in python modules -- + files without any doctest items will not show up anymore + and doctest examples are counted as separate test items. + thanks Danilo Bellini. + +- fix issue245 by depending on the released py-1.4.14 + which fixes py.io.dupfile to work with files with no + mode. Thanks Jason R. Coombs. + +- fix junitxml generation when test output contains control characters, + addressing issue267, thanks Jaap Broekhuizen + +- fix issue338: honor --tb style for setup/teardown errors as well. Thanks Maho. + +- fix issue307 - use yaml.safe_load in example, thanks Mark Eichin. + +- better parametrize error messages, thanks Brianna Laugher + +- pytest_terminal_summary(terminalreporter) hooks can now use + ".section(title)" and ".line(msg)" methods to print extra + information at the end of a test run. + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.4.1.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.4.1.rst new file mode 100644 index 000000000..64ba170f8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.4.1.rst @@ -0,0 +1,25 @@ +pytest-2.4.1: fixing three regressions compared to 2.3.5 +=========================================================================== + +pytest-2.4.1 is a quick follow up release to fix three regressions +compared to 2.3.5 before they hit more people: + +- When using parser.addoption() unicode arguments to the + "type" keyword should also be converted to the respective types. + thanks Floris Bruynooghe, @dnozay. (fixes issue360 and issue362) + +- fix dotted filename completion when using argcomplete + thanks Anthon van der Neuth. (fixes issue361) + +- fix regression when a 1-tuple ("arg",) is used for specifying + parametrization (the values of the parametrization were passed + nested in a tuple). Thanks Donald Stufft. + +- also merge doc typo fixes, thanks Andy Dirnberger + +as usual, docs at http://pytest.org and upgrades via:: + + pip install -U pytest + +have fun, +holger krekel diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.4.2.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.4.2.rst new file mode 100644 index 000000000..3b4aa95ab --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.4.2.rst @@ -0,0 +1,39 @@ +pytest-2.4.2: colorama on windows, plugin/tmpdir fixes +=========================================================================== + +pytest-2.4.2 is another bug-fixing release: + +- on Windows require colorama and a newer py lib so that py.io.TerminalWriter() + now uses colorama instead of its own ctypes hacks. (fixes issue365) + thanks Paul Moore for bringing it up. + +- fix "-k" matching of tests where "repr" and "attr" and other names would + cause wrong matches because of an internal implementation quirk + (don't ask) which is now properly implemented. fixes issue345. + +- avoid tmpdir fixture to create too long filenames especially + when parametrization is used (issue354) + +- fix pytest-pep8 and pytest-flakes / pytest interactions + (collection names in mark plugin was assuming an item always + has a function which is not true for those plugins etc.) + Thanks Andi Zeidler. + +- introduce node.get_marker/node.add_marker API for plugins + like pytest-pep8 and pytest-flakes to avoid the messy + details of the node.keywords pseudo-dicts. Adapted + docs. + +- remove attempt to "dup" stdout at startup as it's icky. + the normal capturing should catch enough possibilities + of tests messing up standard FDs. + +- add pluginmanager.do_configure(config) as a link to + config.do_configure() for plugin-compatibility + +as usual, docs at http://pytest.org and upgrades via:: + + pip install -U pytest + +have fun, +holger krekel diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.5.0.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.5.0.rst new file mode 100644 index 000000000..b8f28d6fd --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.5.0.rst @@ -0,0 +1,175 @@ +pytest-2.5.0: now down to ZERO reported bugs! +=========================================================================== + +pytest-2.5.0 is a big fixing release, the result of two community bug +fixing days plus numerous additional works from many people and +reporters. The release should be fully compatible to 2.4.2, existing +plugins and test suites. We aim at maintaining this level of ZERO reported +bugs because it's no fun if your testing tool has bugs, is it? Under a +condition, though: when submitting a bug report please provide +clear information about the circumstances and a simple example which +reproduces the problem. + +The issue tracker is of course not empty now. We have many remaining +"enhacement" issues which we'll hopefully can tackle in 2014 with your +help. + +For those who use older Python versions, please note that pytest is not +automatically tested on python2.5 due to virtualenv, setuptools and tox +not supporting it anymore. Manual verification shows that it mostly +works fine but it's not going to be part of the automated release +process and thus likely to break in the future. + +As usual, current docs are at + + http://pytest.org + +and you can upgrade from pypi via:: + + pip install -U pytest + +Particular thanks for helping with this release go to Anatoly Bubenkoff, +Floris Bruynooghe, Marc Abramowitz, Ralph Schmitt, Ronny Pfannschmidt, +Donald Stufft, James Lan, Rob Dennis, Jason R. Coombs, Mathieu Agopian, +Virgil Dupras, Bruno Oliveira, Alex Gaynor and others. + +have fun, +holger krekel + + +2.5.0 +----------------------------------- + +- dropped python2.5 from automated release testing of pytest itself + which means it's probably going to break soon (but still works + with this release we believe). + +- simplified and fixed implementation for calling finalizers when + parametrized fixtures or function arguments are involved. finalization + is now performed lazily at setup time instead of in the "teardown phase". + While this might sound odd at first, it helps to ensure that we are + correctly handling setup/teardown even in complex code. User-level code + should not be affected unless it's implementing the pytest_runtest_teardown + hook and expecting certain fixture instances are torn down within (very + unlikely and would have been unreliable anyway). + +- PR90: add --color=yes|no|auto option to force terminal coloring + mode ("auto" is default). Thanks Marc Abramowitz. + +- fix issue319 - correctly show unicode in assertion errors. Many + thanks to Floris Bruynooghe for the complete PR. Also means + we depend on py>=1.4.19 now. + +- fix issue396 - correctly sort and finalize class-scoped parametrized + tests independently from number of methods on the class. + +- refix issue323 in a better way -- parametrization should now never + cause Runtime Recursion errors because the underlying algorithm + for re-ordering tests per-scope/per-fixture is not recursive + anymore (it was tail-call recursive before which could lead + to problems for more than >966 non-function scoped parameters). + +- fix issue290 - there is preliminary support now for parametrizing + with repeated same values (sometimes useful to to test if calling + a second time works as with the first time). + +- close issue240 - document precisely how pytest module importing + works, discuss the two common test directory layouts, and how it + interacts with PEP420-namespace packages. + +- fix issue246 fix finalizer order to be LIFO on independent fixtures + depending on a parametrized higher-than-function scoped fixture. + (was quite some effort so please bear with the complexity of this sentence :) + Thanks Ralph Schmitt for the precise failure example. + +- fix issue244 by implementing special index for parameters to only use + indices for paramentrized test ids + +- fix issue287 by running all finalizers but saving the exception + from the first failing finalizer and re-raising it so teardown will + still have failed. We reraise the first failing exception because + it might be the cause for other finalizers to fail. + +- fix ordering when mock.patch or other standard decorator-wrappings + are used with test methods. This fixues issue346 and should + help with random "xdist" collection failures. Thanks to + Ronny Pfannschmidt and Donald Stufft for helping to isolate it. + +- fix issue357 - special case "-k" expressions to allow for + filtering with simple strings that are not valid python expressions. + Examples: "-k 1.3" matches all tests parametrized with 1.3. + "-k None" filters all tests that have "None" in their name + and conversely "-k 'not None'". + Previously these examples would raise syntax errors. + +- fix issue384 by removing the trial support code + since the unittest compat enhancements allow + trial to handle it on its own + +- don't hide an ImportError when importing a plugin produces one. + fixes issue375. + +- fix issue275 - allow usefixtures and autouse fixtures + for running doctest text files. + +- fix issue380 by making --resultlog only rely on longrepr instead + of the "reprcrash" attribute which only exists sometimes. + +- address issue122: allow @pytest.fixture(params=iterator) by exploding + into a list early on. + +- fix pexpect-3.0 compatibility for pytest's own tests. + (fixes issue386) + +- allow nested parametrize-value markers, thanks James Lan for the PR. + +- fix unicode handling with new monkeypatch.setattr(import_path, value) + API. Thanks Rob Dennis. Fixes issue371. + +- fix unicode handling with junitxml, fixes issue368. + +- In assertion rewriting mode on Python 2, fix the detection of coding + cookies. See issue #330. + +- make "--runxfail" turn imperative pytest.xfail calls into no ops + (it already did neutralize pytest.mark.xfail markers) + +- refine pytest / pkg_resources interactions: The AssertionRewritingHook + PEP302 compliant loader now registers itself with setuptools/pkg_resources + properly so that the pkg_resources.resource_stream method works properly. + Fixes issue366. Thanks for the investigations and full PR to Jason R. Coombs. + +- pytestconfig fixture is now session-scoped as it is the same object during the + whole test run. Fixes issue370. + +- avoid one surprising case of marker malfunction/confusion:: + + @pytest.mark.some(lambda arg: ...) + def test_function(): + + would not work correctly because pytest assumes @pytest.mark.some + gets a function to be decorated already. We now at least detect if this + arg is an lambda and thus the example will work. Thanks Alex Gaynor + for bringing it up. + +- xfail a test on pypy that checks wrong encoding/ascii (pypy does + not error out). fixes issue385. + +- internally make varnames() deal with classes's __init__, + although it's not needed by pytest itself atm. Also + fix caching. Fixes issue376. + +- fix issue221 - handle importing of namespace-package with no + __init__.py properly. + +- refactor internal FixtureRequest handling to avoid monkeypatching. + One of the positive user-facing effects is that the "request" object + can now be used in closures. + +- fixed version comparison in pytest.importskip(modname, minverstring) + +- fix issue377 by clarifying in the nose-compat docs that pytest + does not duplicate the unittest-API into the "plain" namespace. + +- fix verbose reporting for @mock'd test functions + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.5.1.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.5.1.rst new file mode 100644 index 000000000..a3a74cec6 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.5.1.rst @@ -0,0 +1,47 @@ +pytest-2.5.1: fixes and new home page styling +=========================================================================== + +pytest is a mature Python testing tool with more than a 1000 tests +against itself, passing on many different interpreters and platforms. + +The 2.5.1 release maintains the "zero-reported-bugs" promise by fixing +the three bugs reported since the last release a few days ago. It also +features a new home page styling implemented by Tobias Bieniek, based on +the flask theme from Armin Ronacher: + + http://pytest.org + +If you have anything more to improve styling and docs, +we'd be very happy to merge further pull requests. + +On the coding side, the release also contains a little enhancement to +fixture decorators allowing to directly influence generation of test +ids, thanks to Floris Bruynooghe. Other thanks for helping with +this release go to Anatoly Bubenkoff and Ronny Pfannschmidt. + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +have fun and a nice remaining "bug-free" time of the year :) +holger krekel + +2.5.1 +----------------------------------- + +- merge new documentation styling PR from Tobias Bieniek. + +- fix issue403: allow parametrize of multiple same-name functions within + a collection node. Thanks Andreas Kloeckner and Alex Gaynor for reporting + and analysis. + +- Allow parameterized fixtures to specify the ID of the parameters by + adding an ids argument to pytest.fixture() and pytest.yield_fixture(). + Thanks Floris Bruynooghe. + +- fix issue404 by always using the binary xml escape in the junitxml + plugin. Thanks Ronny Pfannschmidt. + +- fix issue407: fix addoption docstring to point to argparse instead of + optparse. Thanks Daniel D. Wright. + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.5.2.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.5.2.rst new file mode 100644 index 000000000..9308ffdd6 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.5.2.rst @@ -0,0 +1,64 @@ +pytest-2.5.2: fixes +=========================================================================== + +pytest is a mature Python testing tool with more than a 1000 tests +against itself, passing on many different interpreters and platforms. + +The 2.5.2 release fixes a few bugs with two maybe-bugs remaining and +actively being worked on (and waiting for the bug reporter's input). +We also have a new contribution guide thanks to Piotr Banaszkiewicz +and others. + +See docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to the following people who contributed to this release: + + Anatoly Bubenkov + Ronny Pfannschmidt + Floris Bruynooghe + Bruno Oliveira + Andreas Pelme + Jurko Gospodnetić + Piotr Banaszkiewicz + Simon Liedtke + lakka + Lukasz Balcerzak + Philippe Muller + Daniel Hahler + +have fun, +holger krekel + +2.5.2 +----------------------------------- + +- fix issue409 -- better interoperate with cx_freeze by not + trying to import from collections.abc which causes problems + for py27/cx_freeze. Thanks Wolfgang L. for reporting and tracking it down. + +- fixed docs and code to use "pytest" instead of "py.test" almost everywhere. + Thanks Jurko Gospodnetic for the complete PR. + +- fix issue425: mention at end of "py.test -h" that --markers + and --fixtures work according to specified test path (or current dir) + +- fix issue413: exceptions with unicode attributes are now printed + correctly also on python2 and with pytest-xdist runs. (the fix + requires py-1.4.20) + +- copy, cleanup and integrate py.io capture + from pylib 1.4.20.dev2 (rev 13d9af95547e) + +- address issue416: clarify docs as to conftest.py loading semantics + +- fix issue429: comparing byte strings with non-ascii chars in assert + expressions now work better. Thanks Floris Bruynooghe. + +- make capfd/capsys.capture private, its unused and shouldnt be exposed + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.0.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.0.rst new file mode 100644 index 000000000..36b545a28 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.0.rst @@ -0,0 +1,153 @@ +pytest-2.6.0: shorter tracebacks, new warning system, test runner compat +=========================================================================== + +pytest is a mature Python testing tool with more than a 1000 tests +against itself, passing on many different interpreters and platforms. + +The 2.6.0 release should be drop-in backward compatible to 2.5.2 and +fixes a number of bugs and brings some new features, mainly: + +- shorter tracebacks by default: only the first (test function) entry + and the last (failure location) entry are shown, the ones between + only in "short" format. Use ``--tb=long`` to get back the old + behaviour of showing "long" entries everywhere. + +- a new warning system which reports oddities during collection + and execution. For example, ignoring collecting Test* classes with an + ``__init__`` now produces a warning. + +- various improvements to nose/mock/unittest integration + +Note also that 2.6.0 departs with the "zero reported bugs" policy +because it has been too hard to keep up with it, unfortunately. +Instead we are for now rather bound to work on "upvoted" issues in +the https://bitbucket.org/pytest-dev/pytest/issues?status=new&status=open&sort=-votes +issue tracker. + +See docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed, among them: + + Benjamin Peterson + Jurko Gospodnetić + Floris Bruynooghe + Marc Abramowitz + Marc Schlaich + Trevor Bekolay + Bruno Oliveira + Alex Groenholm + +have fun, +holger krekel + +2.6.0 +----------------------------------- + +- fix issue537: Avoid importing old assertion reinterpretation code by default. + Thanks Benjamin Peterson. + +- fix issue364: shorten and enhance tracebacks representation by default. + The new "--tb=auto" option (default) will only display long tracebacks + for the first and last entry. You can get the old behaviour of printing + all entries as long entries with "--tb=long". Also short entries by + default are now printed very similarly to "--tb=native" ones. + +- fix issue514: teach assertion reinterpretation about private class attributes + Thanks Benjamin Peterson. + +- change -v output to include full node IDs of tests. Users can copy + a node ID from a test run, including line number, and use it as a + positional argument in order to run only a single test. + +- fix issue 475: fail early and comprehensible if calling + pytest.raises with wrong exception type. + +- fix issue516: tell in getting-started about current dependencies. + +- cleanup setup.py a bit and specify supported versions. Thanks Jurko + Gospodnetic for the PR. + +- change XPASS colour to yellow rather then red when tests are run + with -v. + +- fix issue473: work around mock putting an unbound method into a class + dict when double-patching. + +- fix issue498: if a fixture finalizer fails, make sure that + the fixture is still invalidated. + +- fix issue453: the result of the pytest_assertrepr_compare hook now gets + it's newlines escaped so that format_exception does not blow up. + +- internal new warning system: pytest will now produce warnings when + it detects oddities in your test collection or execution. + Warnings are ultimately sent to a new pytest_logwarning hook which is + currently only implemented by the terminal plugin which displays + warnings in the summary line and shows more details when -rw (report on + warnings) is specified. + +- change skips into warnings for test classes with an __init__ and + callables in test modules which look like a test but are not functions. + +- fix issue436: improved finding of initial conftest files from command + line arguments by using the result of parse_known_args rather than + the previous flaky heuristics. Thanks Marc Abramowitz for tests + and initial fixing approaches in this area. + +- fix issue #479: properly handle nose/unittest(2) SkipTest exceptions + during collection/loading of test modules. Thanks to Marc Schlaich + for the complete PR. + +- fix issue490: include pytest_load_initial_conftests in documentation + and improve docstring. + +- fix issue472: clarify that ``pytest.config.getvalue()`` cannot work + if it's triggered ahead of command line parsing. + +- merge PR123: improved integration with mock.patch decorator on tests. + +- fix issue412: messing with stdout/stderr FD-level streams is now + captured without crashes. + +- fix issue483: trial/py33 works now properly. Thanks Daniel Grana for PR. + +- improve example for pytest integration with "python setup.py test" + which now has a generic "-a" or "--pytest-args" option where you + can pass additional options as a quoted string. Thanks Trevor Bekolay. + +- simplified internal capturing mechanism and made it more robust + against tests or setups changing FD1/FD2, also better integrated + now with pytest.pdb() in single tests. + +- improvements to pytest's own test-suite leakage detection, courtesy of PRs + from Marc Abramowitz + +- fix issue492: avoid leak in test_writeorg. Thanks Marc Abramowitz. + +- fix issue493: don't run tests in doc directory with ``python setup.py test`` + (use tox -e doctesting for that) + +- fix issue486: better reporting and handling of early conftest loading failures + +- some cleanup and simplification of internal conftest handling. + +- work a bit harder to break reference cycles when catching exceptions. + Thanks Jurko Gospodnetic. + +- fix issue443: fix skip examples to use proper comparison. Thanks Alex + Groenholm. + +- support nose-style ``__test__`` attribute on modules, classes and + functions, including unittest-style Classes. If set to False, the + test will not be collected. + +- fix issue512: show "<notset>" for arguments which might not be set + in monkeypatch plugin. Improves output in documentation. + +- avoid importing "py.test" (an old alias module for "pytest") diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.1.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.1.rst new file mode 100644 index 000000000..6f27c5861 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.1.rst @@ -0,0 +1,59 @@ +pytest-2.6.1: fixes and new xfail feature +=========================================================================== + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +The 2.6.1 release is drop-in compatible to 2.5.2 and actually fixes some +regressions introduced with 2.6.0. It also brings a little feature +to the xfail marker which now recognizes expected exceptions, +see the CHANGELOG below. + +See docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed, among them: + + Floris Bruynooghe + Bruno Oliveira + Nicolas Delaby + +have fun, +holger krekel + +Changes 2.6.1 +================= + +- No longer show line numbers in the --verbose output, the output is now + purely the nodeid. The line number is still shown in failure reports. + Thanks Floris Bruynooghe. + +- fix issue437 where assertion rewriting could cause pytest-xdist slaves + to collect different tests. Thanks Bruno Oliveira. + +- fix issue555: add "errors" attribute to capture-streams to satisfy + some distutils and possibly other code accessing sys.stdout.errors. + +- fix issue547 capsys/capfd also work when output capturing ("-s") is disabled. + +- address issue170: allow pytest.mark.xfail(...) to specify expected exceptions via + an optional "raises=EXC" argument where EXC can be a single exception + or a tuple of exception classes. Thanks David Mohr for the complete + PR. + +- fix integration of pytest with unittest.mock.patch decorator when + it uses the "new" argument. Thanks Nicolas Delaby for test and PR. + +- fix issue with detecting conftest files if the arguments contain + "::" node id specifications (copy pasted from "-v" output) + +- fix issue544 by only removing "@NUM" at the end of "::" separated parts + and if the part has an ".py" extension + +- don't use py.std import helper, rather import things directly. + Thanks Bruno Oliveira. + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.2.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.2.rst new file mode 100644 index 000000000..4efc73a4e --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.2.rst @@ -0,0 +1,52 @@ +pytest-2.6.2: few fixes and cx_freeze support +=========================================================================== + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is drop-in compatible to 2.5.2 and 2.6.X. It also +brings support for including pytest with cx_freeze or similar +freezing tools into your single-file app distribution. For details +see the CHANGELOG below. + +See docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed, among them: + + Floris Bruynooghe + Benjamin Peterson + Bruno Oliveira + +have fun, +holger krekel + +2.6.2 +----------- + +- Added function pytest.freeze_includes(), which makes it easy to embed + pytest into executables using tools like cx_freeze. + See docs for examples and rationale. Thanks Bruno Oliveira. + +- Improve assertion rewriting cache invalidation precision. + +- fixed issue561: adapt autouse fixture example for python3. + +- fixed issue453: assertion rewriting issue with __repr__ containing + "\n{", "\n}" and "\n~". + +- fix issue560: correctly display code if an "else:" or "finally:" is + followed by statements on the same line. + +- Fix example in monkeypatch documentation, thanks t-8ch. + +- fix issue572: correct tmpdir doc example for python3. + +- Do not mark as universal wheel because Python 2.6 is different from + other builds due to the extra argparse dependency. Fixes issue566. + Thanks sontek. + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.3.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.3.rst new file mode 100644 index 000000000..13fae31b8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.6.3.rst @@ -0,0 +1,52 @@ +pytest-2.6.3: fixes and little improvements +=========================================================================== + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is drop-in compatible to 2.5.2 and 2.6.X. +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed, among them: + + Floris Bruynooghe + Oleg Sinyavskiy + Uwe Schmitt + Charles Cloud + Wolfgang Schnerring + +have fun, +holger krekel + +Changes 2.6.3 +====================== + +- fix issue575: xunit-xml was reporting collection errors as failures + instead of errors, thanks Oleg Sinyavskiy. + +- fix issue582: fix setuptools example, thanks Laszlo Papp and Ronny + Pfannschmidt. + +- Fix infinite recursion bug when pickling capture.EncodedFile, thanks + Uwe Schmitt. + +- fix issue589: fix bad interaction with numpy and others when showing + exceptions. Check for precise "maximum recursion depth exceed" exception + instead of presuming any RuntimeError is that one (implemented in py + dep). Thanks Charles Cloud for analysing the issue. + +- fix conftest related fixture visibility issue: when running with a + CWD outside a test package pytest would get fixture discovery wrong. + Thanks to Wolfgang Schnerring for figuring out a reproducable example. + +- Introduce pytest_enter_pdb hook (needed e.g. by pytest_timeout to cancel the + timeout when interactively entering pdb). Thanks Wolfgang Schnerring. + +- check xfail/skip also with non-python function test items. Thanks + Floris Bruynooghe. + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.7.0.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.7.0.rst new file mode 100644 index 000000000..07ae44ca1 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.7.0.rst @@ -0,0 +1,101 @@ +pytest-2.7.0: fixes, features, speed improvements +=========================================================================== + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is supposed to be drop-in compatible to 2.6.X. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed, among them: + + Anatoly Bubenkoff + Floris Bruynooghe + Brianna Laugher + Eric Siegerman + Daniel Hahler + Charles Cloud + Tom Viner + Holger Peters + Ldiary Translations + almarklein + +have fun, +holger krekel + +2.7.0 (compared to 2.6.4) +----------------------------- + +- fix issue435: make reload() work when assert rewriting is active. + Thanks Daniel Hahler. + +- fix issue616: conftest.py files and their contained fixutres are now + properly considered for visibility, independently from the exact + current working directory and test arguments that are used. + Many thanks to Eric Siegerman and his PR235 which contains + systematic tests for conftest visibility and now passes. + This change also introduces the concept of a ``rootdir`` which + is printed as a new pytest header and documented in the pytest + customize web page. + +- change reporting of "diverted" tests, i.e. tests that are collected + in one file but actually come from another (e.g. when tests in a test class + come from a base class in a different file). We now show the nodeid + and indicate via a postfix the other file. + +- add ability to set command line options by environment variable PYTEST_ADDOPTS. + +- added documentation on the new pytest-dev teams on bitbucket and + github. See https://pytest.org/latest/contributing.html . + Thanks to Anatoly for pushing and initial work on this. + +- fix issue650: new option ``--docttest-ignore-import-errors`` which + will turn import errors in doctests into skips. Thanks Charles Cloud + for the complete PR. + +- fix issue655: work around different ways that cause python2/3 + to leak sys.exc_info into fixtures/tests causing failures in 3rd party code + +- fix issue615: assertion re-writing did not correctly escape % signs + when formatting boolean operations, which tripped over mixing + booleans with modulo operators. Thanks to Tom Viner for the report, + triaging and fix. + +- implement issue351: add ability to specify parametrize ids as a callable + to generate custom test ids. Thanks Brianna Laugher for the idea and + implementation. + +- introduce and document new hookwrapper mechanism useful for plugins + which want to wrap the execution of certain hooks for their purposes. + This supersedes the undocumented ``__multicall__`` protocol which + pytest itself and some external plugins use. Note that pytest-2.8 + is scheduled to drop supporting the old ``__multicall__`` + and only support the hookwrapper protocol. + +- majorly speed up invocation of plugin hooks + +- use hookwrapper mechanism in builtin pytest plugins. + +- add a doctest ini option for doctest flags, thanks Holger Peters. + +- add note to docs that if you want to mark a parameter and the + parameter is a callable, you also need to pass in a reason to disambiguate + it from the "decorator" case. Thanks Tom Viner. + +- "python_classes" and "python_functions" options now support glob-patterns + for test discovery, as discussed in issue600. Thanks Ldiary Translations. + +- allow to override parametrized fixtures with non-parametrized ones and vice versa (bubenkoff). + +- fix issue463: raise specific error for 'parameterize' misspelling (pfctdayelise). + +- On failure, the ``sys.last_value``, ``sys.last_type`` and + ``sys.last_traceback`` are set, so that a user can inspect the error + via postmortem debugging (almarklein). + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.7.1.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.7.1.rst new file mode 100644 index 000000000..cd37cad0c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.7.1.rst @@ -0,0 +1,58 @@ +pytest-2.7.1: bug fixes +======================= + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is supposed to be drop-in compatible to 2.7.0. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + Bruno Oliveira + Holger Krekel + Ionel Maries Cristian + Floris Bruynooghe + +Happy testing, +The py.test Development Team + + +2.7.1 (compared to 2.7.0) +------------------------- + +- fix issue731: do not get confused by the braces which may be present + and unbalanced in an object's repr while collapsing False + explanations. Thanks Carl Meyer for the report and test case. + +- fix issue553: properly handling inspect.getsourcelines failures in + FixtureLookupError which would lead to to an internal error, + obfuscating the original problem. Thanks talljosh for initial + diagnose/patch and Bruno Oliveira for final patch. + +- fix issue660: properly report scope-mismatch-access errors + independently from ordering of fixture arguments. Also + avoid the pytest internal traceback which does not provide + information to the user. Thanks Holger Krekel. + +- streamlined and documented release process. Also all versions + (in setup.py and documentation generation) are now read + from _pytest/__init__.py. Thanks Holger Krekel. + +- fixed docs to remove the notion that yield-fixtures are experimental. + They are here to stay :) Thanks Bruno Oliveira. + +- Support building wheels by using environment markers for the + requirements. Thanks Ionel Maries Cristian. + +- fixed regression to 2.6.4 which surfaced e.g. in lost stdout capture printing + when tests raised SystemExit. Thanks Holger Krekel. + +- reintroduced _pytest fixture of the pytester plugin which is used + at least by pytest-xdist. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.7.2.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.7.2.rst new file mode 100644 index 000000000..69130ad62 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.7.2.rst @@ -0,0 +1,58 @@ +pytest-2.7.2: bug fixes +======================= + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is supposed to be drop-in compatible to 2.7.1. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + Bruno Oliveira + Floris Bruynooghe + Punyashloka Biswal + Aron Curzon + Benjamin Peterson + Thomas De Schampheleire + Edison Gustavo Muenz + Holger Krekel + +Happy testing, +The py.test Development Team + + +2.7.2 (compared to 2.7.1) +----------------------------- + +- fix issue767: pytest.raises value attribute does not contain the exception + instance on Python 2.6. Thanks Eric Siegerman for providing the test + case and Bruno Oliveira for PR. + +- Automatically create directory for junitxml and results log. + Thanks Aron Curzon. + +- fix issue713: JUnit XML reports for doctest failures. + Thanks Punyashloka Biswal. + +- fix issue735: assertion failures on debug versions of Python 3.4+ + Thanks Benjamin Peterson. + +- fix issue114: skipif marker reports to internal skipping plugin; + Thanks Floris Bruynooghe for reporting and Bruno Oliveira for the PR. + +- fix issue748: unittest.SkipTest reports to internal pytest unittest plugin. + Thanks Thomas De Schampheleire for reporting and Bruno Oliveira for the PR. + +- fix issue718: failed to create representation of sets containing unsortable + elements in python 2. Thanks Edison Gustavo Muenz + +- fix issue756, fix issue752 (and similar issues): depend on py-1.4.29 + which has a refined algorithm for traceback generation. + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.2.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.2.rst new file mode 100644 index 000000000..d70286161 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.2.rst @@ -0,0 +1,44 @@ +pytest-2.8.2: bug fixes +======================= + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is supposed to be drop-in compatible to 2.8.1. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + Bruno Oliveira + Demian Brecht + Florian Bruhin + Ionel Cristian Mărieș + Raphael Pierzina + Ronny Pfannschmidt + holger krekel + +Happy testing, +The py.test Development Team + + +2.8.2 (compared to 2.7.2) +----------------------------- + +- fix #1085: proper handling of encoding errors when passing encoded byte + strings to pytest.parametrize in Python 2. + Thanks Themanwithoutaplan for the report and Bruno Oliveira for the PR. + +- fix #1087: handling SystemError when passing empty byte strings to + pytest.parametrize in Python 3. + Thanks Paul Kehrer for the report and Bruno Oliveira for the PR. + +- fix #995: fixed internal error when filtering tracebacks where one entry + was generated by an exec() statement. + Thanks Daniel Hahler, Ashley C Straw, Philippe Gauthier and Pavel Savchenko + for contributing and Bruno Oliveira for the PR. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.3.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.3.rst new file mode 100644 index 000000000..d080ac724 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.3.rst @@ -0,0 +1,59 @@ +pytest-2.8.3: bug fixes +======================= + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is supposed to be drop-in compatible to 2.8.2. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + Bruno Oliveira + Florian Bruhin + Gabe Hollombe + Gabriel Reis + Hartmut Goebel + John Vandenberg + Lee Kamentsky + Michael Birtwell + Raphael Pierzina + Ronny Pfannschmidt + William Martin Stewart + +Happy testing, +The py.test Development Team + + +2.8.3 (compared to 2.8.2) +----------------------------- + +- fix #1169: add __name__ attribute to testcases in TestCaseFunction to + support the @unittest.skip decorator on functions and methods. + Thanks Lee Kamentsky for the PR. + +- fix #1035: collecting tests if test module level obj has __getattr__(). + Thanks Suor for the report and Bruno Oliveira / Tom Viner for the PR. + +- fix #331: don't collect tests if their failure cannot be reported correctly + e.g. they are a callable instance of a class. + +- fix #1133: fixed internal error when filtering tracebacks where one entry + belongs to a file which is no longer available. + Thanks Bruno Oliveira for the PR. + +- enhancement made to highlight in red the name of the failing tests so + they stand out in the output. + Thanks Gabriel Reis for the PR. + +- add more talks to the documentation +- extend documentation on the --ignore cli option +- use pytest-runner for setuptools integration +- minor fixes for interaction with OS X El Capitan system integrity protection (thanks Florian) + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.4.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.4.rst new file mode 100644 index 000000000..a09629cef --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.4.rst @@ -0,0 +1,52 @@ +pytest-2.8.4 +============ + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is supposed to be drop-in compatible to 2.8.2. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + Bruno Oliveira + Florian Bruhin + Jeff Widman + Mehdy Khoshnoody + Nicholas Chammas + Ronny Pfannschmidt + Tim Chan + + +Happy testing, +The py.test Development Team + + +2.8.4 (compared to 2.8.3) +----------------------------- + +- fix #1190: ``deprecated_call()`` now works when the deprecated + function has been already called by another test in the same + module. Thanks Mikhail Chernykh for the report and Bruno Oliveira for the + PR. + +- fix #1198: ``--pastebin`` option now works on Python 3. Thanks + Mehdy Khoshnoody for the PR. + +- fix #1219: ``--pastebin`` now works correctly when captured output contains + non-ascii characters. Thanks Bruno Oliveira for the PR. + +- fix #1204: another error when collecting with a nasty __getattr__(). + Thanks Florian Bruhin for the PR. + +- fix the summary printed when no tests did run. + Thanks Florian Bruhin for the PR. + +- a number of documentation modernizations wrt good practices. + Thanks Bruno Oliveira for the PR. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.5.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.5.rst new file mode 100644 index 000000000..7409022a1 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.5.rst @@ -0,0 +1,39 @@ +pytest-2.8.5 +============ + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is supposed to be drop-in compatible to 2.8.4. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + Alex Gaynor + aselus-hub + Bruno Oliveira + Ronny Pfannschmidt + + +Happy testing, +The py.test Development Team + + +2.8.5 (compared to 2.8.4) +------------------------- + +- fix #1243: fixed issue where class attributes injected during collection could break pytest. + PR by Alexei Kozlenok, thanks Ronny Pfannschmidt and Bruno Oliveira for the review and help. + +- fix #1074: precompute junitxml chunks instead of storing the whole tree in objects + Thanks Bruno Oliveira for the report and Ronny Pfannschmidt for the PR + +- fix #1238: fix ``pytest.deprecated_call()`` receiving multiple arguments + (Regression introduced in 2.8.4). Thanks Alex Gaynor for the report and + Bruno Oliveira for the PR. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.6.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.6.rst new file mode 100644 index 000000000..215fae51e --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.6.rst @@ -0,0 +1,67 @@ +pytest-2.8.6 +============ + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is supposed to be drop-in compatible to 2.8.5. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + AMiT Kumar + Bruno Oliveira + Erik M. Bray + Florian Bruhin + Georgy Dyuldin + Jeff Widman + Kartik Singhal + Loïc Estève + Manu Phatak + Peter Demin + Rick van Hattem + Ronny Pfannschmidt + Ulrich Petri + foxx + + +Happy testing, +The py.test Development Team + + +2.8.6 (compared to 2.8.5) +------------------------- + +- fix #1259: allow for double nodeids in junitxml, + this was a regression failing plugins combinations + like pytest-pep8 + pytest-flakes + +- Workaround for exception that occurs in pyreadline when using + ``--pdb`` with standard I/O capture enabled. + Thanks Erik M. Bray for the PR. + +- fix #900: Better error message in case the target of a ``monkeypatch`` call + raises an ``ImportError``. + +- fix #1292: monkeypatch calls (setattr, setenv, etc.) are now O(1). + Thanks David R. MacIver for the report and Bruno Oliveira for the PR. + +- fix #1223: captured stdout and stderr are now properly displayed before + entering pdb when ``--pdb`` is used instead of being thrown away. + Thanks Cal Leeming for the PR. + +- fix #1305: pytest warnings emitted during ``pytest_terminal_summary`` are now + properly displayed. + Thanks Ionel Maries Cristian for the report and Bruno Oliveira for the PR. + +- fix #628: fixed internal UnicodeDecodeError when doctests contain unicode. + Thanks Jason R. Coombs for the report and Bruno Oliveira for the PR. + +- fix #1334: Add captured stdout to jUnit XML report on setup error. + Thanks Georgy Dyuldin for the PR. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.7.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.7.rst new file mode 100644 index 000000000..d98d73106 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.8.7.rst @@ -0,0 +1,31 @@ +pytest-2.8.7 +============ + +This is a hotfix release to solve a regression +in the builtin monkeypatch plugin that got introduced in 2.8.6. + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. +This release is supposed to be drop-in compatible to 2.8.5. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + Ronny Pfannschmidt + + +Happy testing, +The py.test Development Team + + +2.8.7 (compared to 2.8.6) +------------------------- + +- fix #1338: use predictable object resolution for monkeypatch
\ No newline at end of file diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.9.0.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.9.0.rst new file mode 100644 index 000000000..99c1c631f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.9.0.rst @@ -0,0 +1,159 @@ +pytest-2.9.0 +============ + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + Anatoly Bubenkov + Bruno Oliveira + Buck Golemon + David Vierra + Florian Bruhin + Galaczi Endre + Georgy Dyuldin + Lukas Bednar + Luke Murphy + Marcin Biernat + Matt Williams + Michael Aquilina + Raphael Pierzina + Ronny Pfannschmidt + Ryan Wooden + Tiemo Kieft + TomV + holger krekel + jab + + +Happy testing, +The py.test Development Team + + +2.9.0 (compared to 2.8.7) +------------------------- + +**New Features** + +* New ``pytest.mark.skip`` mark, which unconditionally skips marked tests. + Thanks `@MichaelAquilina`_ for the complete PR (`#1040`_). + +* ``--doctest-glob`` may now be passed multiple times in the command-line. + Thanks `@jab`_ and `@nicoddemus`_ for the PR. + +* New ``-rp`` and ``-rP`` reporting options give the summary and full output + of passing tests, respectively. Thanks to `@codewarrior0`_ for the PR. + +* ``pytest.mark.xfail`` now has a ``strict`` option which makes ``XPASS`` + tests to fail the test suite, defaulting to ``False``. There's also a + ``xfail_strict`` ini option that can be used to configure it project-wise. + Thanks `@rabbbit`_ for the request and `@nicoddemus`_ for the PR (`#1355`_). + +* ``Parser.addini`` now supports options of type ``bool``. Thanks + `@nicoddemus`_ for the PR. + +* New ``ALLOW_BYTES`` doctest option strips ``b`` prefixes from byte strings + in doctest output (similar to ``ALLOW_UNICODE``). + Thanks `@jaraco`_ for the request and `@nicoddemus`_ for the PR (`#1287`_). + +* give a hint on KeyboardInterrupt to use the --fulltrace option to show the errors, + this fixes `#1366`_. + Thanks to `@hpk42`_ for the report and `@RonnyPfannschmidt`_ for the PR. + +* catch IndexError exceptions when getting exception source location. This fixes + pytest internal error for dynamically generated code (fixtures and tests) + where source lines are fake by intention + +**Changes** + +* **Important**: `py.code <http://pylib.readthedocs.org/en/latest/code.html>`_ has been + merged into the ``pytest`` repository as ``pytest._code``. This decision + was made because ``py.code`` had very few uses outside ``pytest`` and the + fact that it was in a different repository made it difficult to fix bugs on + its code in a timely manner. The team hopes with this to be able to better + refactor out and improve that code. + This change shouldn't affect users, but it is useful to let users aware + if they encounter any strange behavior. + + Keep in mind that the code for ``pytest._code`` is **private** and + **experimental**, so you definitely should not import it explicitly! + + Please note that the original ``py.code`` is still available in + `pylib <http://pylib.readthedocs.org>`_. + +* ``pytest_enter_pdb`` now optionally receives the pytest config object. + Thanks `@nicoddemus`_ for the PR. + +* Removed code and documentation for Python 2.5 or lower versions, + including removal of the obsolete ``_pytest.assertion.oldinterpret`` module. + Thanks `@nicoddemus`_ for the PR (`#1226`_). + +* Comparisons now always show up in full when ``CI`` or ``BUILD_NUMBER`` is + found in the environment, even when -vv isn't used. + Thanks `@The-Compiler`_ for the PR. + +* ``--lf`` and ``--ff`` now support long names: ``--last-failed`` and + ``--failed-first`` respectively. + Thanks `@MichaelAquilina`_ for the PR. + +* Added expected exceptions to pytest.raises fail message + +* Collection only displays progress ("collecting X items") when in a terminal. + This avoids cluttering the output when using ``--color=yes`` to obtain + colors in CI integrations systems (`#1397`_). + +**Bug Fixes** + +* The ``-s`` and ``-c`` options should now work under ``xdist``; + ``Config.fromdictargs`` now represents its input much more faithfully. + Thanks to `@bukzor`_ for the complete PR (`#680`_). + +* Fix (`#1290`_): support Python 3.5's ``@`` operator in assertion rewriting. + Thanks `@Shinkenjoe`_ for report with test case and `@tomviner`_ for the PR. + +* Fix formatting utf-8 explanation messages (`#1379`_). + Thanks `@biern`_ for the PR. + +* Fix `traceback style docs`_ to describe all of the available options + (auto/long/short/line/native/no), with `auto` being the default since v2.6. + Thanks `@hackebrot`_ for the PR. + +* Fix (`#1422`_): junit record_xml_property doesn't allow multiple records + with same name. + + +.. _`traceback style docs`: https://pytest.org/latest/usage.html#modifying-python-traceback-printing + +.. _#1422: https://github.com/pytest-dev/pytest/issues/1422 +.. _#1379: https://github.com/pytest-dev/pytest/issues/1379 +.. _#1366: https://github.com/pytest-dev/pytest/issues/1366 +.. _#1040: https://github.com/pytest-dev/pytest/pull/1040 +.. _#680: https://github.com/pytest-dev/pytest/issues/680 +.. _#1287: https://github.com/pytest-dev/pytest/pull/1287 +.. _#1226: https://github.com/pytest-dev/pytest/pull/1226 +.. _#1290: https://github.com/pytest-dev/pytest/pull/1290 +.. _#1355: https://github.com/pytest-dev/pytest/pull/1355 +.. _#1397: https://github.com/pytest-dev/pytest/issues/1397 +.. _@biern: https://github.com/biern +.. _@MichaelAquilina: https://github.com/MichaelAquilina +.. _@bukzor: https://github.com/bukzor +.. _@hpk42: https://github.com/hpk42 +.. _@nicoddemus: https://github.com/nicoddemus +.. _@jab: https://github.com/jab +.. _@codewarrior0: https://github.com/codewarrior0 +.. _@jaraco: https://github.com/jaraco +.. _@The-Compiler: https://github.com/The-Compiler +.. _@Shinkenjoe: https://github.com/Shinkenjoe +.. _@tomviner: https://github.com/tomviner +.. _@RonnyPfannschmidt: https://github.com/RonnyPfannschmidt +.. _@rabbbit: https://github.com/rabbbit +.. _@hackebrot: https://github.com/hackebrot
\ No newline at end of file diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.9.1.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.9.1.rst new file mode 100644 index 000000000..05a448430 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/release-2.9.1.rst @@ -0,0 +1,65 @@ +pytest-2.9.1 +============ + +pytest is a mature Python testing tool with more than a 1100 tests +against itself, passing on many different interpreters and platforms. + +See below for the changes and see docs at: + + http://pytest.org + +As usual, you can upgrade from pypi via:: + + pip install -U pytest + +Thanks to all who contributed to this release, among them: + + Bruno Oliveira + Daniel Hahler + Dmitry Malinovsky + Florian Bruhin + Floris Bruynooghe + Matt Bachmann + Ronny Pfannschmidt + TomV + Vladimir Bolshakov + Zearin + palaviv + + +Happy testing, +The py.test Development Team + + +2.9.1 (compared to 2.9.0) +------------------------- + +**Bug Fixes** + +* Improve error message when a plugin fails to load. + Thanks `@nicoddemus`_ for the PR. + +* Fix (`#1178 <https://github.com/pytest-dev/pytest/issues/1178>`_): + ``pytest.fail`` with non-ascii characters raises an internal pytest error. + Thanks `@nicoddemus`_ for the PR. + +* Fix (`#469`_): junit parses report.nodeid incorrectly, when params IDs + contain ``::``. Thanks `@tomviner`_ for the PR (`#1431`_). + +* Fix (`#578 <https://github.com/pytest-dev/pytest/issues/578>`_): SyntaxErrors + containing non-ascii lines at the point of failure generated an internal + py.test error. + Thanks `@asottile`_ for the report and `@nicoddemus`_ for the PR. + +* Fix (`#1437`_): When passing in a bytestring regex pattern to parameterize + attempt to decode it as utf-8 ignoring errors. + +* Fix (`#649`_): parametrized test nodes cannot be specified to run on the command line. + + +.. _#1437: https://github.com/pytest-dev/pytest/issues/1437 +.. _#469: https://github.com/pytest-dev/pytest/issues/469 +.. _#1431: https://github.com/pytest-dev/pytest/pull/1431 +.. _#649: https://github.com/pytest-dev/pytest/issues/649 + +.. _@asottile: https://github.com/asottile diff --git a/testing/web-platform/tests/tools/pytest/doc/en/announce/sprint2016.rst b/testing/web-platform/tests/tools/pytest/doc/en/announce/sprint2016.rst new file mode 100644 index 000000000..e59ccdda7 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/announce/sprint2016.rst @@ -0,0 +1,105 @@ +python testing sprint June 20th-26th 2016 +====================================================== + +.. image:: ../img/freiburg2.jpg + :width: 400 + +The pytest core group is heading towards the biggest sprint +in its history, to take place in the black forest town Freiburg +in Germany. As of February 2016 we have started a `funding +campaign on Indiegogo to cover expenses +<http://igg.me/at/pytest-sprint/x/4034848>`_ The page also mentions +some preliminary topics: + +- improving pytest-xdist test scheduling to take into account + fixture setups and explicit user hints. + +- provide info on fixture dependencies during --collect-only + +- tying pytest-xdist to tox so that you can do "py.test -e py34" + to run tests in a particular tox-managed virtualenv. Also + look into making pytest-xdist use tox environments on + remote ssh-sides so that remote dependency management becomes + easier. + +- refactoring the fixture system so more people understand it :) + +- integrating PyUnit setup methods as autouse fixtures. + possibly adding ways to influence ordering of same-scoped + fixtures (so you can make a choice of which fixtures come + before others) + +- fixing bugs and issues from the tracker, really an endless source :) + + +Participants +-------------- + +Here are preliminary participants who said they are likely to come, +given some expenses funding:: + + Anatoly Bubenkoff, Netherlands + Andreas Pelme, Personalkollen, Sweden + Anthony Wang, Splunk, US + Brianna Laugher, Australia + Bruno Oliveira, Brazil + Danielle Jenkins, Splunk, US + Dave Hunt, UK + Florian Bruhin, Switzerland + Floris Bruynooghe, Cobe.io, UK + Holger Krekel, merlinux, Germany + Oliver Bestwalter, Avira, Germany + Omar Kohl, Germany + Raphael Pierzina, FanDuel, UK + Tom Viner, UK + + <your name here?> + +Other contributors and experienced newcomers are invited to join as well +but please send a mail to the pytest-dev mailing list if you intend to +do so somewhat soon, also how much funding you need if so. And if you +are working for a company and using pytest heavily you are welcome to +join and we encourage your company to provide some funding for the +sprint. They may see it, and rightfully so, as a very cheap and deep +training which brings you together with the experts in the field :) + + +Sprint organisation, schedule +------------------------------- + +tentative schedule: + +- 19/20th arrival in Freiburg +- 20th social get together, initial hacking +- 21/22th full sprint days +- 23rd break day, hiking +- 24/25th full sprint days +- 26th departure + +We might adjust according to weather to make sure that if +we do some hiking or excursion we'll have good weather. +Freiburg is one of the sunniest places in Germany so +it shouldn't be too much of a constraint. + + +Accomodation +---------------- + +We'll see to arrange for renting a flat with multiple +beds/rooms. Hotels are usually below 100 per night. +The earlier we book the better. + +Money / funding +--------------- + +The Indiegogo campaign asks for 11000 USD which should cover +the costs for flights and accomodation, renting a sprint place +and maybe a bit of food as well. + +If your organisation wants to support the sprint but prefers +to give money according to an invoice, get in contact with +holger at http://merlinux.eu who can invoice your organisation +properly. + +If we have excess money we'll use for further sprint/travel +funding for pytest/tox contributors. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/assert.rst b/testing/web-platform/tests/tools/pytest/doc/en/assert.rst new file mode 100644 index 000000000..e7f14e8bd --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/assert.rst @@ -0,0 +1,289 @@ + +The writing and reporting of assertions in tests +================================================== + +.. _`assertfeedback`: +.. _`assert with the assert statement`: +.. _`assert`: + + +Asserting with the ``assert`` statement +--------------------------------------------------------- + +``pytest`` allows you to use the standard python ``assert`` for verifying +expectations and values in Python tests. For example, you can write the +following:: + + # content of test_assert1.py + def f(): + return 3 + + def test_function(): + assert f() == 4 + +to assert that your function returns a certain value. If this assertion fails +you will see the return value of the function call:: + + $ py.test test_assert1.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 1 items + + test_assert1.py F + + ======= FAILURES ======== + _______ test_function ________ + + def test_function(): + > assert f() == 4 + E assert 3 == 4 + E + where 3 = f() + + test_assert1.py:5: AssertionError + ======= 1 failed in 0.12 seconds ======== + +``pytest`` has support for showing the values of the most common subexpressions +including calls, attributes, comparisons, and binary and unary +operators. (See :ref:`tbreportdemo`). This allows you to use the +idiomatic python constructs without boilerplate code while not losing +introspection information. + +However, if you specify a message with the assertion like this:: + + assert a % 2 == 0, "value was odd, should be even" + +then no assertion introspection takes places at all and the message +will be simply shown in the traceback. + +See :ref:`assert-details` for more information on assertion introspection. + +.. _`assertraises`: + +Assertions about expected exceptions +------------------------------------------ + +In order to write assertions about raised exceptions, you can use +``pytest.raises`` as a context manager like this:: + + import pytest + + def test_zero_division(): + with pytest.raises(ZeroDivisionError): + 1 / 0 + +and if you need to have access to the actual exception info you may use:: + + def test_recursion_depth(): + with pytest.raises(RuntimeError) as excinfo: + def f(): + f() + f() + assert 'maximum recursion' in str(excinfo.value) + +``excinfo`` is a ``ExceptionInfo`` instance, which is a wrapper around +the actual exception raised. The main attributes of interest are +``.type``, ``.value`` and ``.traceback``. + +If you want to write test code that works on Python 2.4 as well, +you may also use two other ways to test for an expected exception:: + + pytest.raises(ExpectedException, func, *args, **kwargs) + pytest.raises(ExpectedException, "func(*args, **kwargs)") + +both of which execute the specified function with args and kwargs and +asserts that the given ``ExpectedException`` is raised. The reporter will +provide you with helpful output in case of failures such as *no +exception* or *wrong exception*. + +Note that it is also possible to specify a "raises" argument to +``pytest.mark.xfail``, which checks that the test is failing in a more +specific way than just having any exception raised:: + + @pytest.mark.xfail(raises=IndexError) + def test_f(): + f() + +Using ``pytest.raises`` is likely to be better for cases where you are testing +exceptions your own code is deliberately raising, whereas using +``@pytest.mark.xfail`` with a check function is probably better for something +like documenting unfixed bugs (where the test describes what "should" happen) +or bugs in dependencies. + + +.. _`assertwarns`: + +Assertions about expected warnings +----------------------------------------- + +.. versionadded:: 2.8 + +You can check that code raises a particular warning using +:ref:`pytest.warns <warns>`. + + +.. _newreport: + +Making use of context-sensitive comparisons +------------------------------------------------- + +.. versionadded:: 2.0 + +``pytest`` has rich support for providing context-sensitive information +when it encounters comparisons. For example:: + + # content of test_assert2.py + + def test_set_comparison(): + set1 = set("1308") + set2 = set("8035") + assert set1 == set2 + +if you run this module:: + + $ py.test test_assert2.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 1 items + + test_assert2.py F + + ======= FAILURES ======== + _______ test_set_comparison ________ + + def test_set_comparison(): + set1 = set("1308") + set2 = set("8035") + > assert set1 == set2 + E assert set(['0', '1', '3', '8']) == set(['0', '3', '5', '8']) + E Extra items in the left set: + E '1' + E Extra items in the right set: + E '5' + E Use -v to get the full diff + + test_assert2.py:5: AssertionError + ======= 1 failed in 0.12 seconds ======== + +Special comparisons are done for a number of cases: + +* comparing long strings: a context diff is shown +* comparing long sequences: first failing indices +* comparing dicts: different entries + +See the :ref:`reporting demo <tbreportdemo>` for many more examples. + +Defining your own assertion comparison +---------------------------------------------- + +It is possible to add your own detailed explanations by implementing +the ``pytest_assertrepr_compare`` hook. + +.. autofunction:: _pytest.hookspec.pytest_assertrepr_compare + +As an example consider adding the following hook in a conftest.py which +provides an alternative explanation for ``Foo`` objects:: + + # content of conftest.py + from test_foocompare import Foo + def pytest_assertrepr_compare(op, left, right): + if isinstance(left, Foo) and isinstance(right, Foo) and op == "==": + return ['Comparing Foo instances:', + ' vals: %s != %s' % (left.val, right.val)] + +now, given this test module:: + + # content of test_foocompare.py + class Foo: + def __init__(self, val): + self.val = val + + def __eq__(self, other): + return self.val == other.val + + def test_compare(): + f1 = Foo(1) + f2 = Foo(2) + assert f1 == f2 + +you can run the test module and get the custom output defined in +the conftest file:: + + $ py.test -q test_foocompare.py + F + ======= FAILURES ======== + _______ test_compare ________ + + def test_compare(): + f1 = Foo(1) + f2 = Foo(2) + > assert f1 == f2 + E assert Comparing Foo instances: + E vals: 1 != 2 + + test_foocompare.py:11: AssertionError + 1 failed in 0.12 seconds + +.. _assert-details: +.. _`assert introspection`: + +Advanced assertion introspection +---------------------------------- + +.. versionadded:: 2.1 + + +Reporting details about a failing assertion is achieved either by rewriting +assert statements before they are run or re-evaluating the assert expression and +recording the intermediate values. Which technique is used depends on the +location of the assert, ``pytest`` configuration, and Python version being used +to run ``pytest``. + +By default, ``pytest`` rewrites assert statements in test modules. +Rewritten assert statements put introspection information into the assertion failure message. +``pytest`` only rewrites test modules directly discovered by its test collection process, so +asserts in supporting modules which are not themselves test modules will not be +rewritten. + +.. note:: + + ``pytest`` rewrites test modules on import. It does this by using an import + hook to write a new pyc files. Most of the time this works transparently. + However, if you are messing with import yourself, the import hook may + interfere. If this is the case, simply use ``--assert=reinterp`` or + ``--assert=plain``. Additionally, rewriting will fail silently if it cannot + write new pycs, i.e. in a read-only filesystem or a zipfile. + +If an assert statement has not been rewritten or the Python version is less than +2.6, ``pytest`` falls back on assert reinterpretation. In assert +reinterpretation, ``pytest`` walks the frame of the function containing the +assert statement to discover sub-expression results of the failing assert +statement. You can force ``pytest`` to always use assertion reinterpretation by +passing the ``--assert=reinterp`` option. + +Assert reinterpretation has a caveat not present with assert rewriting: If +evaluating the assert expression has side effects you may get a warning that the +intermediate values could not be determined safely. A common example of this +issue is an assertion which reads from a file:: + + assert f.read() != '...' + +If this assertion fails then the re-evaluation will probably succeed! +This is because ``f.read()`` will return an empty string when it is +called the second time during the re-evaluation. However, it is +easy to rewrite the assertion and avoid any trouble:: + + content = f.read() + assert content != '...' + +All assert introspection can be turned off by passing ``--assert=plain``. + +For further information, Benjamin Peterson wrote up `Behind the scenes of pytest's new assertion rewriting <http://pybites.blogspot.com/2011/07/behind-scenes-of-pytests-new-assertion.html>`_. + +.. versionadded:: 2.1 + Add assert rewriting as an alternate introspection technique. + +.. versionchanged:: 2.1 + Introduce the ``--assert`` option. Deprecate ``--no-assert`` and + ``--nomagic``. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/bash-completion.rst b/testing/web-platform/tests/tools/pytest/doc/en/bash-completion.rst new file mode 100644 index 000000000..b2a52fa63 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/bash-completion.rst @@ -0,0 +1,28 @@ + +.. _bash_completion: + +Setting up bash completion +========================== + +When using bash as your shell, ``pytest`` can use argcomplete +(https://argcomplete.readthedocs.org/) for auto-completion. +For this ``argcomplete`` needs to be installed **and** enabled. + +Install argcomplete using:: + + sudo pip install 'argcomplete>=0.5.7' + +For global activation of all argcomplete enabled python applications run:: + + sudo activate-global-python-argcomplete + +For permanent (but not global) ``pytest`` activation, use:: + + register-python-argcomplete py.test >> ~/.bashrc + +For one-time activation of argcomplete for ``pytest`` only, use:: + + eval "$(register-python-argcomplete py.test)" + + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/builtin.rst b/testing/web-platform/tests/tools/pytest/doc/en/builtin.rst new file mode 100644 index 000000000..b18c3f828 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/builtin.rst @@ -0,0 +1,134 @@ + +.. _`pytest helpers`: + +Pytest API and builtin fixtures +================================================ + +This is a list of ``pytest.*`` API functions and fixtures. + +For information on plugin hooks and objects, see :ref:`plugins`. + +For information on the ``pytest.mark`` mechanism, see :ref:`mark`. + +For the below objects, you can also interactively ask for help, e.g. by +typing on the Python interactive prompt something like:: + + import pytest + help(pytest) + +.. currentmodule:: pytest + +Invoking pytest interactively +--------------------------------------------------- + +.. autofunction:: main + +More examples at :ref:`pytest.main-usage` + + +Helpers for assertions about Exceptions/Warnings +-------------------------------------------------------- + +.. autofunction:: raises + +Examples at :ref:`assertraises`. + +.. autofunction:: deprecated_call + +Raising a specific test outcome +-------------------------------------- + +You can use the following functions in your test, fixture or setup +functions to force a certain test outcome. Note that most often +you can rather use declarative marks, see :ref:`skipping`. + +.. autofunction:: _pytest.runner.fail +.. autofunction:: _pytest.runner.skip +.. autofunction:: _pytest.runner.importorskip +.. autofunction:: _pytest.skipping.xfail +.. autofunction:: _pytest.runner.exit + +fixtures and requests +----------------------------------------------------- + +To mark a fixture function: + +.. autofunction:: _pytest.python.fixture + +Tutorial at :ref:`fixtures`. + +The ``request`` object that can be used from fixture functions. + +.. autoclass:: _pytest.python.FixtureRequest() + :members: + + +.. _builtinfixtures: +.. _builtinfuncargs: + +Builtin fixtures/function arguments +----------------------------------------- + +You can ask for available builtin or project-custom +:ref:`fixtures <fixtures>` by typing:: + + $ py.test -q --fixtures + cache + Return a cache object that can persist state between testing sessions. + + cache.get(key, default) + cache.set(key, value) + + Keys must be a ``/`` separated value, where the first part is usually the + name of your plugin or application to avoid clashes with other cache users. + + Values can be any object handled by the json stdlib module. + capsys + enables capturing of writes to sys.stdout/sys.stderr and makes + captured output available via ``capsys.readouterr()`` method calls + which return a ``(out, err)`` tuple. + capfd + enables capturing of writes to file descriptors 1 and 2 and makes + captured output available via ``capfd.readouterr()`` method calls + which return a ``(out, err)`` tuple. + record_xml_property + Fixture that adds extra xml properties to the tag for the calling test. + The fixture is callable with (name, value), with value being automatically + xml-encoded. + monkeypatch + The returned ``monkeypatch`` funcarg provides these + helper methods to modify objects, dictionaries or os.environ:: + + monkeypatch.setattr(obj, name, value, raising=True) + monkeypatch.delattr(obj, name, raising=True) + monkeypatch.setitem(mapping, name, value) + monkeypatch.delitem(obj, name, raising=True) + monkeypatch.setenv(name, value, prepend=False) + monkeypatch.delenv(name, value, raising=True) + monkeypatch.syspath_prepend(path) + monkeypatch.chdir(path) + + All modifications will be undone after the requesting + test function has finished. The ``raising`` + parameter determines if a KeyError or AttributeError + will be raised if the set/deletion operation has no target. + pytestconfig + the pytest config object with access to command line opts. + recwarn + Return a WarningsRecorder instance that provides these methods: + + * ``pop(category=None)``: return last warning matching the category. + * ``clear()``: clear list of warnings + + See http://docs.python.org/library/warnings.html for information + on warning categories. + tmpdir_factory + Return a TempdirFactory instance for the test session. + tmpdir + return a temporary directory path object + which is unique to each test function invocation, + created as a sub directory of the base temporary + directory. The returned object is a `py.path.local`_ + path object. + + no tests ran in 0.12 seconds diff --git a/testing/web-platform/tests/tools/pytest/doc/en/cache.rst b/testing/web-platform/tests/tools/pytest/doc/en/cache.rst new file mode 100644 index 000000000..52abb52a0 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/cache.rst @@ -0,0 +1,278 @@ +Cache: working with cross-testrun state +======================================= + +.. versionadded:: 2.8 + +.. warning:: + + The functionality of this core plugin was previously distributed + as a third party plugin named ``pytest-cache``. The core plugin + is compatible regarding command line options and API usage except that you + can only store/receive data between test runs that is json-serializable. + + +Usage +--------- + +The plugin provides two command line options to rerun failures from the +last ``py.test`` invocation: + +* ``--lf``, ``--last-failed`` - to only re-run the failures. +* ``--ff``, ``--failed-first`` - to run the failures first and then the rest of + the tests. + +For cleanup (usually not needed), a ``--cache-clear`` option allows to remove +all cross-session cache contents ahead of a test run. + +Other plugins may access the `config.cache`_ object to set/get +**json encodable** values between ``py.test`` invocations. + +.. note:: + + This plugin is enabled by default, but can be disabled if needed: see + :ref:`cmdunregister` (the internal name for this plugin is + ``cacheprovider``). + + +Rerunning only failures or failures first +----------------------------------------------- + +First, let's create 50 test invocation of which only 2 fail:: + + # content of test_50.py + import pytest + + @pytest.mark.parametrize("i", range(50)) + def test_num(i): + if i in (17, 25): + pytest.fail("bad luck") + +If you run this for the first time you will see two failures:: + + $ py.test -q + .................F.......F........................ + ======= FAILURES ======== + _______ test_num[17] ________ + + i = 17 + + @pytest.mark.parametrize("i", range(50)) + def test_num(i): + if i in (17, 25): + > pytest.fail("bad luck") + E Failed: bad luck + + test_50.py:6: Failed + _______ test_num[25] ________ + + i = 25 + + @pytest.mark.parametrize("i", range(50)) + def test_num(i): + if i in (17, 25): + > pytest.fail("bad luck") + E Failed: bad luck + + test_50.py:6: Failed + 2 failed, 48 passed in 0.12 seconds + +If you then run it with ``--lf``:: + + $ py.test --lf + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + run-last-failure: rerun last 2 failures + rootdir: $REGENDOC_TMPDIR, inifile: + collected 50 items + + test_50.py FF + + ======= FAILURES ======== + _______ test_num[17] ________ + + i = 17 + + @pytest.mark.parametrize("i", range(50)) + def test_num(i): + if i in (17, 25): + > pytest.fail("bad luck") + E Failed: bad luck + + test_50.py:6: Failed + _______ test_num[25] ________ + + i = 25 + + @pytest.mark.parametrize("i", range(50)) + def test_num(i): + if i in (17, 25): + > pytest.fail("bad luck") + E Failed: bad luck + + test_50.py:6: Failed + ======= 2 failed, 48 deselected in 0.12 seconds ======== + +You have run only the two failing test from the last run, while 48 tests have +not been run ("deselected"). + +Now, if you run with the ``--ff`` option, all tests will be run but the first +previous failures will be executed first (as can be seen from the series +of ``FF`` and dots):: + + $ py.test --ff + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + run-last-failure: rerun last 2 failures first + rootdir: $REGENDOC_TMPDIR, inifile: + collected 50 items + + test_50.py FF................................................ + + ======= FAILURES ======== + _______ test_num[17] ________ + + i = 17 + + @pytest.mark.parametrize("i", range(50)) + def test_num(i): + if i in (17, 25): + > pytest.fail("bad luck") + E Failed: bad luck + + test_50.py:6: Failed + _______ test_num[25] ________ + + i = 25 + + @pytest.mark.parametrize("i", range(50)) + def test_num(i): + if i in (17, 25): + > pytest.fail("bad luck") + E Failed: bad luck + + test_50.py:6: Failed + ======= 2 failed, 48 passed in 0.12 seconds ======== + +.. _`config.cache`: + +The new config.cache object +-------------------------------- + +.. regendoc:wipe + +Plugins or conftest.py support code can get a cached value using the +pytest ``config`` object. Here is a basic example plugin which +implements a :ref:`fixture` which re-uses previously created state +across py.test invocations:: + + # content of test_caching.py + import pytest + import time + + @pytest.fixture + def mydata(request): + val = request.config.cache.get("example/value", None) + if val is None: + time.sleep(9*0.6) # expensive computation :) + val = 42 + request.config.cache.set("example/value", val) + return val + + def test_function(mydata): + assert mydata == 23 + +If you run this command once, it will take a while because +of the sleep:: + + $ py.test -q + F + ======= FAILURES ======== + _______ test_function ________ + + mydata = 42 + + def test_function(mydata): + > assert mydata == 23 + E assert 42 == 23 + + test_caching.py:14: AssertionError + 1 failed in 0.12 seconds + +If you run it a second time the value will be retrieved from +the cache and this will be quick:: + + $ py.test -q + F + ======= FAILURES ======== + _______ test_function ________ + + mydata = 42 + + def test_function(mydata): + > assert mydata == 23 + E assert 42 == 23 + + test_caching.py:14: AssertionError + 1 failed in 0.12 seconds + +See the `cache-api`_ for more details. + + +Inspecting Cache content +------------------------------- + +You can always peek at the content of the cache using the +``--cache-clear`` command line option:: + + $ py.test --cache-clear + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 1 items + + test_caching.py F + + ======= FAILURES ======== + _______ test_function ________ + + mydata = 42 + + def test_function(mydata): + > assert mydata == 23 + E assert 42 == 23 + + test_caching.py:14: AssertionError + ======= 1 failed in 0.12 seconds ======== + +Clearing Cache content +------------------------------- + +You can instruct pytest to clear all cache files and values +by adding the ``--cache-clear`` option like this:: + + py.test --cache-clear + +This is recommended for invocations from Continous Integration +servers where isolation and correctness is more important +than speed. + + +.. _`cache-api`: + +config.cache API +------------------ + +The ``config.cache`` object allows other plugins, +including ``conftest.py`` files, +to safely and flexibly store and retrieve values across +test runs because the ``config`` object is available +in many places. + +Under the hood, the cache plugin uses the simple +dumps/loads API of the json stdlib module + +.. currentmodule:: _pytest.cacheprovider + +.. automethod:: Cache.get +.. automethod:: Cache.set +.. automethod:: Cache.makedir diff --git a/testing/web-platform/tests/tools/pytest/doc/en/capture.rst b/testing/web-platform/tests/tools/pytest/doc/en/capture.rst new file mode 100644 index 000000000..8892f5be7 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/capture.rst @@ -0,0 +1,118 @@ + +.. _`captures`: + +Capturing of the stdout/stderr output +========================================================= + +Default stdout/stderr/stdin capturing behaviour +--------------------------------------------------------- + +During test execution any output sent to ``stdout`` and ``stderr`` is +captured. If a test or a setup method fails its according captured +output will usually be shown along with the failure traceback. + +In addition, ``stdin`` is set to a "null" object which will +fail on attempts to read from it because it is rarely desired +to wait for interactive input when running automated tests. + +By default capturing is done by intercepting writes to low level +file descriptors. This allows to capture output from simple +print statements as well as output from a subprocess started by +a test. + +Setting capturing methods or disabling capturing +------------------------------------------------- + +There are two ways in which ``pytest`` can perform capturing: + +* file descriptor (FD) level capturing (default): All writes going to the + operating system file descriptors 1 and 2 will be captured. + +* ``sys`` level capturing: Only writes to Python files ``sys.stdout`` + and ``sys.stderr`` will be captured. No capturing of writes to + filedescriptors is performed. + +.. _`disable capturing`: + +You can influence output capturing mechanisms from the command line:: + + py.test -s # disable all capturing + py.test --capture=sys # replace sys.stdout/stderr with in-mem files + py.test --capture=fd # also point filedescriptors 1 and 2 to temp file + +.. _printdebugging: + +Using print statements for debugging +--------------------------------------------------- + +One primary benefit of the default capturing of stdout/stderr output +is that you can use print statements for debugging:: + + # content of test_module.py + + def setup_function(function): + print ("setting up %s" % function) + + def test_func1(): + assert True + + def test_func2(): + assert False + +and running this module will show you precisely the output +of the failing function and hide the other one:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 2 items + + test_module.py .F + + ======= FAILURES ======== + _______ test_func2 ________ + + def test_func2(): + > assert False + E assert False + + test_module.py:9: AssertionError + -------------------------- Captured stdout setup --------------------------- + setting up <function test_func2 at 0xdeadbeef> + ======= 1 failed, 1 passed in 0.12 seconds ======== + +Accessing captured output from a test function +--------------------------------------------------- + +The ``capsys`` and ``capfd`` fixtures allow to access stdout/stderr +output created during test execution. Here is an example test function +that performs some output related checks: + +.. code-block:: python + + def test_myoutput(capsys): # or use "capfd" for fd-level + print ("hello") + sys.stderr.write("world\n") + out, err = capsys.readouterr() + assert out == "hello\n" + assert err == "world\n" + print "next" + out, err = capsys.readouterr() + assert out == "next\n" + +The ``readouterr()`` call snapshots the output so far - +and capturing will be continued. After the test +function finishes the original streams will +be restored. Using ``capsys`` this way frees your +test from having to care about setting/resetting +output streams and also interacts well with pytest's +own per-test capturing. + +If you want to capture on filedescriptor level you can use +the ``capfd`` function argument which offers the exact +same interface but allows to also capture output from +libraries or subprocesses that directly write to operating +system level output streams (FD1 and FD2). + +.. include:: links.inc diff --git a/testing/web-platform/tests/tools/pytest/doc/en/changelog.rst b/testing/web-platform/tests/tools/pytest/doc/en/changelog.rst new file mode 100644 index 000000000..a59b3c7e2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/changelog.rst @@ -0,0 +1,7 @@ + +.. _changelog: + +Changelog history +================================= + +.. include:: ../../CHANGELOG.rst diff --git a/testing/web-platform/tests/tools/pytest/doc/en/check_sphinx.py b/testing/web-platform/tests/tools/pytest/doc/en/check_sphinx.py new file mode 100644 index 000000000..0f536ffa6 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/check_sphinx.py @@ -0,0 +1,17 @@ +import py +import subprocess +def test_build_docs(tmpdir): + doctrees = tmpdir.join("doctrees") + htmldir = tmpdir.join("html") + subprocess.check_call([ + "sphinx-build", "-W", "-bhtml", + "-d", str(doctrees), ".", str(htmldir)]) + +def test_linkcheck(tmpdir): + doctrees = tmpdir.join("doctrees") + htmldir = tmpdir.join("html") + subprocess.check_call( + ["sphinx-build", "-blinkcheck", + "-d", str(doctrees), ".", str(htmldir)]) + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/conf.py b/testing/web-platform/tests/tools/pytest/doc/en/conf.py new file mode 100644 index 000000000..aca0442c5 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/conf.py @@ -0,0 +1,326 @@ +# -*- coding: utf-8 -*- +# +# pytest documentation build configuration file, created by +# sphinx-quickstart on Fri Oct 8 17:54:28 2010. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +# The short X.Y version. + +import os, sys +sys.path.insert(0, os.path.dirname(__file__)) +import _getdoctarget + +version = _getdoctarget.get_minor_version_string() +release = _getdoctarget.get_version_string() + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +autodoc_member_order = "bysource" +todo_include_todos = 1 + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.autosummary', + 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'contents' + +# General information about the project. +project = u'pytest' +copyright = u'2015, holger krekel and pytest-dev team' + + + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['links.inc', '_build', 'naming20.rst', 'test/*', + "old_*", + '*attic*', + '*/attic*', + 'funcargs.rst', + 'setup.rst', + 'example/remoteinterp.rst', + ] + + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = False + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +sys.path.append(os.path.abspath('_themes')) +html_theme_path = ['_themes'] + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'flask' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + 'index_logo': None +} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# "<project> v<release> documentation". +html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +html_short_title = "pytest-%s" % release + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = "img/pytest1.png" + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = "img/pytest1favi.ico" + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} +#html_sidebars = {'index': 'indexsidebar.html'} + +html_sidebars = { + 'index': [ + 'sidebarintro.html', + 'globaltoc.html', + 'links.html', + 'sourcelink.html', + 'searchbox.html' + ], + '**': [ + 'globaltoc.html', + 'relations.html', + 'links.html', + 'sourcelink.html', + 'searchbox.html' + ] +} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} +#html_additional_pages = {'index': 'index.html'} + + +# If false, no module index is generated. +html_domain_indices = True + +# If false, no index is generated. +html_use_index = False + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'pytestdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('contents', 'pytest.tex', u'pytest Documentation', + u'holger krekel, trainer and consultant, http://merlinux.eu', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +latex_logo = 'img/pytest1.png' + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +latex_domain_indices = False + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('usage', 'pytest', u'pytest usage', + [u'holger krekel at merlinux eu'], 1) +] + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'pytest' +epub_author = u'holger krekel at merlinux eu' +epub_publisher = u'holger krekel at merlinux eu' +epub_copyright = u'2013, holger krekel et alii' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True + + +# -- Options for texinfo output ------------------------------------------------ + +texinfo_documents = [ + (master_doc, 'pytest', 'pytest Documentation', + ('Holger Krekel@*Benjamin Peterson@*Ronny Pfannschmidt@*' + 'Floris Bruynooghe@*others'), + 'pytest', + 'simple powerful testing with Pytho', + 'Programming', + 1), +] + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'python': ('http://docs.python.org/', None), +# 'lib': ("http://docs.python.org/2.7library/", None), + } + + +def setup(app): + #from sphinx.ext.autodoc import cut_lines + #app.connect('autodoc-process-docstring', cut_lines(4, what=['module'])) + app.add_description_unit('confval', 'confval', + objname='configuration value', + indextemplate='pair: %s; configuration value') diff --git a/testing/web-platform/tests/tools/pytest/doc/en/conftest.py b/testing/web-platform/tests/tools/pytest/doc/en/conftest.py new file mode 100644 index 000000000..1a62e1b5d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/conftest.py @@ -0,0 +1 @@ +collect_ignore = ["conf.py"] diff --git a/testing/web-platform/tests/tools/pytest/doc/en/contact.rst b/testing/web-platform/tests/tools/pytest/doc/en/contact.rst new file mode 100644 index 000000000..d4a1a03de --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/contact.rst @@ -0,0 +1,51 @@ + +.. _`contact channels`: +.. _`contact`: + +Contact channels +=================================== + +- `pytest issue tracker`_ to report bugs or suggest features (for version + 2.0 and above). + +- `pytest on stackoverflow.com <http://stackoverflow.com/search?q=pytest>`_ + to post questions with the tag ``pytest``. New Questions will usually + be seen by pytest users or developers and answered quickly. + +- `Testing In Python`_: a mailing list for Python testing tools and discussion. + +- `pytest-dev at python.org (mailing list)`_ pytest specific announcements and discussions. + +- `pytest-commit at python.org (mailing list)`_: for commits and new issues + +- :doc:`contribution guide <contributing>` for help on submitting pull + requests to bitbucket (including using git via gitifyhg). + +- #pylib on irc.freenode.net IRC channel for random questions. + +- private mail to Holger.Krekel at gmail com if you want to communicate sensitive issues + + +- `merlinux.eu`_ offers pytest and tox-related professional teaching and + consulting. + +.. _`pytest issue tracker`: https://github.com/pytest-dev/pytest/issues +.. _`old issue tracker`: http://bitbucket.org/hpk42/py-trunk/issues/ + +.. _`merlinux.eu`: http://merlinux.eu + +.. _`get an account`: + +.. _tetamap: http://tetamap.wordpress.com + +.. _`@pylibcommit`: http://twitter.com/pylibcommit + + +.. _`Testing in Python`: http://lists.idyll.org/listinfo/testing-in-python +.. _FOAF: http://en.wikipedia.org/wiki/FOAF +.. _`py-dev`: +.. _`development mailing list`: +.. _`pytest-dev at python.org (mailing list)`: http://mail.python.org/mailman/listinfo/pytest-dev +.. _`py-svn`: +.. _`pytest-commit at python.org (mailing list)`: http://mail.python.org/mailman/listinfo/pytest-commit + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/contents.rst b/testing/web-platform/tests/tools/pytest/doc/en/contents.rst new file mode 100644 index 000000000..48c3471b5 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/contents.rst @@ -0,0 +1,39 @@ +.. _toc: + +Full pytest documentation +=========================== + +`Download latest version as PDF <pytest.pdf>`_ + +.. `Download latest version as EPUB <http://media.readthedocs.org/epub/pytest/latest/pytest.epub>`_ + +.. toctree:: + :maxdepth: 2 + + overview + apiref + example/index + monkeypatch + tmpdir + capture + recwarn + cache + plugins + + contributing + talks + +.. only:: html + + .. toctree:: + + funcarg_compare + announce/index + +.. only:: html + + .. toctree:: + :hidden: + + changelog + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/contributing.rst b/testing/web-platform/tests/tools/pytest/doc/en/contributing.rst new file mode 100644 index 000000000..2b6578f6b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/contributing.rst @@ -0,0 +1,3 @@ +.. _contributing: + +.. include:: ../../CONTRIBUTING.rst diff --git a/testing/web-platform/tests/tools/pytest/doc/en/customize.rst b/testing/web-platform/tests/tools/pytest/doc/en/customize.rst new file mode 100644 index 000000000..34e319c24 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/customize.rst @@ -0,0 +1,228 @@ +Basic test configuration +=================================== + +Command line options and configuration file settings +----------------------------------------------------------------- + +You can get help on command line options and values in INI-style +configurations files by using the general help option:: + + py.test -h # prints options _and_ config file settings + +This will display command line and configuration file settings +which were registered by installed plugins. + +.. _rootdir: +.. _inifiles: + +initialization: determining rootdir and inifile +----------------------------------------------- + +.. versionadded:: 2.7 + +pytest determines a "rootdir" for each test run which depends on +the command line arguments (specified test files, paths) and on +the existence of inifiles. The determined rootdir and ini-file are +printed as part of the pytest header. The rootdir is used for constructing +"nodeids" during collection and may also be used by plugins to store +project/testrun-specific information. + +Here is the algorithm which finds the rootdir from ``args``: + +- determine the common ancestor directory for the specified ``args``. + +- look for ``pytest.ini``, ``tox.ini`` and ``setup.cfg`` files in the + ancestor directory and upwards. If one is matched, it becomes the + ini-file and its directory becomes the rootdir. An existing + ``pytest.ini`` file will always be considered a match whereas + ``tox.ini`` and ``setup.cfg`` will only match if they contain + a ``[pytest]`` section. + +- if no ini-file was found, look for ``setup.py`` upwards from + the common ancestor directory to determine the ``rootdir``. + +- if no ini-file and no ``setup.py`` was found, use the already + determined common ancestor as root directory. This allows to + work with pytest in structures that are not part of a package + and don't have any particular ini-file configuration. + +Note that options from multiple ini-files candidates are never merged, +the first one wins (``pytest.ini`` always wins even if it does not +contain a ``[pytest]`` section). + +The ``config`` object will subsequently carry these attributes: + +- ``config.rootdir``: the determined root directory, guaranteed to exist. + +- ``config.inifile``: the determined ini-file, may be ``None``. + +The rootdir is used a reference directory for constructing test +addresses ("nodeids") and can be used also by plugins for storing +per-testrun information. + +Example:: + + py.test path/to/testdir path/other/ + +will determine the common ancestor as ``path`` and then +check for ini-files as follows:: + + # first look for pytest.ini files + path/pytest.ini + path/setup.cfg # must also contain [pytest] section to match + path/tox.ini # must also contain [pytest] section to match + pytest.ini + ... # all the way down to the root + + # now look for setup.py + path/setup.py + setup.py + ... # all the way down to the root + + +.. _`how to change command line options defaults`: +.. _`adding default options`: + +How to change command line options defaults +------------------------------------------------ + +It can be tedious to type the same series of command line options +every time you use ``pytest``. For example, if you always want to see +detailed info on skipped and xfailed tests, as well as have terser "dot" +progress output, you can write it into a configuration file: + +.. code-block:: ini + + # content of pytest.ini + # (or tox.ini or setup.cfg) + [pytest] + addopts = -rsxX -q + +Alternatively, you can set a PYTEST_ADDOPTS environment variable to add command +line options while the environment is in use:: + + export PYTEST_ADDOPTS="-rsxX -q" + +From now on, running ``pytest`` will add the specified options. + + + +Builtin configuration file options +---------------------------------------------- + +.. confval:: minversion + + Specifies a minimal pytest version required for running tests. + + minversion = 2.1 # will fail if we run with pytest-2.0 + +.. confval:: addopts + + Add the specified ``OPTS`` to the set of command line arguments as if they + had been specified by the user. Example: if you have this ini file content: + + .. code-block:: ini + + [pytest] + addopts = --maxfail=2 -rf # exit after 2 failures, report fail info + + issuing ``py.test test_hello.py`` actually means:: + + py.test --maxfail=2 -rf test_hello.py + + Default is to add no options. + +.. confval:: norecursedirs + + Set the directory basename patterns to avoid when recursing + for test discovery. The individual (fnmatch-style) patterns are + applied to the basename of a directory to decide if to recurse into it. + Pattern matching characters:: + + * matches everything + ? matches any single character + [seq] matches any character in seq + [!seq] matches any char not in seq + + Default patterns are ``'.*', 'CVS', '_darcs', '{arch}', '*.egg'``. + Setting a ``norecursedirs`` replaces the default. Here is an example of + how to avoid certain directories: + + .. code-block:: ini + + # content of setup.cfg + [pytest] + norecursedirs = .svn _build tmp* + + This would tell ``pytest`` to not look into typical subversion or + sphinx-build directories or into any ``tmp`` prefixed directory. + +.. confval:: testpaths + + .. versionadded:: 2.8 + + Sets list of directories that should be searched for tests when + no specific directories, files or test ids are given in the command line when + executing pytest from the :ref:`rootdir <rootdir>` directory. + Useful when all project tests are in a known location to speed up + test collection and to avoid picking up undesired tests by accident. + + .. code-block:: ini + + # content of pytest.ini + [pytest] + testpaths = testing doc + + This tells pytest to only look for tests in ``testing`` and ``doc`` + directories when executing from the root directory. + +.. confval:: python_files + + One or more Glob-style file patterns determining which python files + are considered as test modules. + +.. confval:: python_classes + + One or more name prefixes or glob-style patterns determining which classes + are considered for test collection. Here is an example of how to collect + tests from classes that end in ``Suite``: + + .. code-block:: ini + + # content of pytest.ini + [pytest] + python_classes = *Suite + + Note that ``unittest.TestCase`` derived classes are always collected + regardless of this option, as ``unittest``'s own collection framework is used + to collect those tests. + +.. confval:: python_functions + + One or more name prefixes or glob-patterns determining which test functions + and methods are considered tests. Here is an example of how + to collect test functions and methods that end in ``_test``: + + .. code-block:: ini + + # content of pytest.ini + [pytest] + python_functions = *_test + + Note that this has no effect on methods that live on a ``unittest + .TestCase`` derived class, as ``unittest``'s own collection framework is used + to collect those tests. + + See :ref:`change naming conventions` for more detailed examples. + +.. confval:: doctest_optionflags + + One or more doctest flag names from the standard ``doctest`` module. + :doc:`See how py.test handles doctests <doctest>`. + +.. confval:: confcutdir + + Sets a directory where search upwards for ``conftest.py`` files stops. + By default, pytest will stop searching for ``conftest.py`` files upwards + from ``pytest.ini``/``tox.ini``/``setup.cfg`` of the project if any, + or up to the file-system root. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/doctest.rst b/testing/web-platform/tests/tools/pytest/doc/en/doctest.rst new file mode 100644 index 000000000..db764141e --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/doctest.rst @@ -0,0 +1,105 @@ + +Doctest integration for modules and test files +========================================================= + +By default all files matching the ``test*.txt`` pattern will +be run through the python standard ``doctest`` module. You +can change the pattern by issuing:: + + py.test --doctest-glob='*.rst' + +on the command line. Since version ``2.9``, ``--doctest-glob`` +can be given multiple times in the command-line. + +You can also trigger running of doctests +from docstrings in all python modules (including regular +python test modules):: + + py.test --doctest-modules + +You can make these changes permanent in your project by +putting them into a pytest.ini file like this: + +.. code-block:: ini + + # content of pytest.ini + [pytest] + addopts = --doctest-modules + +If you then have a text file like this:: + + # content of example.rst + + hello this is a doctest + >>> x = 3 + >>> x + 3 + +and another like this:: + + # content of mymodule.py + def something(): + """ a doctest in a docstring + >>> something() + 42 + """ + return 42 + +then you can just invoke ``py.test`` without command line options:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini + collected 1 items + + mymodule.py . + + ======= 1 passed in 0.12 seconds ======== + +It is possible to use fixtures using the ``getfixture`` helper:: + + # content of example.rst + >>> tmp = getfixture('tmpdir') + >>> ... + >>> + +Also, :ref:`usefixtures` and :ref:`autouse` fixtures are supported +when executing text doctest files. + +The standard ``doctest`` module provides some setting flags to configure the +strictness of doctest tests. In py.test You can enable those flags those flags +using the configuration file. To make pytest ignore trailing whitespaces and +ignore lengthy exception stack traces you can just write: + +.. code-block:: ini + + [pytest] + doctest_optionflags= NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL + +py.test also introduces new options to allow doctests to run in Python 2 and +Python 3 unchanged: + +* ``ALLOW_UNICODE``: when enabled, the ``u`` prefix is stripped from unicode + strings in expected doctest output. + +* ``ALLOW_BYTES``: when enabled, the ``b`` prefix is stripped from byte strings + in expected doctest output. + +As with any other option flag, these flags can be enabled in ``pytest.ini`` using +the ``doctest_optionflags`` ini option: + +.. code-block:: ini + + [pytest] + doctest_optionflags = ALLOW_UNICODE ALLOW_BYTES + + +Alternatively, it can be enabled by an inline comment in the doc test +itself:: + + # content of example.rst + >>> get_unicode_greeting() # doctest: +ALLOW_UNICODE + 'Hello' + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/failure_demo.py b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/failure_demo.py new file mode 100644 index 000000000..a4ff758b1 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/failure_demo.py @@ -0,0 +1,238 @@ +from pytest import raises +import _pytest._code +import py + +def otherfunc(a,b): + assert a==b + +def somefunc(x,y): + otherfunc(x,y) + +def otherfunc_multi(a,b): + assert (a == + b) + +def test_generative(param1, param2): + assert param1 * 2 < param2 + +def pytest_generate_tests(metafunc): + if 'param1' in metafunc.fixturenames: + metafunc.addcall(funcargs=dict(param1=3, param2=6)) + +class TestFailing(object): + def test_simple(self): + def f(): + return 42 + def g(): + return 43 + + assert f() == g() + + def test_simple_multiline(self): + otherfunc_multi( + 42, + 6*9) + + def test_not(self): + def f(): + return 42 + assert not f() + +class TestSpecialisedExplanations(object): + def test_eq_text(self): + assert 'spam' == 'eggs' + + def test_eq_similar_text(self): + assert 'foo 1 bar' == 'foo 2 bar' + + def test_eq_multiline_text(self): + assert 'foo\nspam\nbar' == 'foo\neggs\nbar' + + def test_eq_long_text(self): + a = '1'*100 + 'a' + '2'*100 + b = '1'*100 + 'b' + '2'*100 + assert a == b + + def test_eq_long_text_multiline(self): + a = '1\n'*100 + 'a' + '2\n'*100 + b = '1\n'*100 + 'b' + '2\n'*100 + assert a == b + + def test_eq_list(self): + assert [0, 1, 2] == [0, 1, 3] + + def test_eq_list_long(self): + a = [0]*100 + [1] + [3]*100 + b = [0]*100 + [2] + [3]*100 + assert a == b + + def test_eq_dict(self): + assert {'a': 0, 'b': 1, 'c': 0} == {'a': 0, 'b': 2, 'd': 0} + + def test_eq_set(self): + assert set([0, 10, 11, 12]) == set([0, 20, 21]) + + def test_eq_longer_list(self): + assert [1,2] == [1,2,3] + + def test_in_list(self): + assert 1 in [0, 2, 3, 4, 5] + + def test_not_in_text_multiline(self): + text = 'some multiline\ntext\nwhich\nincludes foo\nand a\ntail' + assert 'foo' not in text + + def test_not_in_text_single(self): + text = 'single foo line' + assert 'foo' not in text + + def test_not_in_text_single_long(self): + text = 'head ' * 50 + 'foo ' + 'tail ' * 20 + assert 'foo' not in text + + def test_not_in_text_single_long_term(self): + text = 'head ' * 50 + 'f'*70 + 'tail ' * 20 + assert 'f'*70 not in text + + +def test_attribute(): + class Foo(object): + b = 1 + i = Foo() + assert i.b == 2 + + +def test_attribute_instance(): + class Foo(object): + b = 1 + assert Foo().b == 2 + + +def test_attribute_failure(): + class Foo(object): + def _get_b(self): + raise Exception('Failed to get attrib') + b = property(_get_b) + i = Foo() + assert i.b == 2 + + +def test_attribute_multiple(): + class Foo(object): + b = 1 + class Bar(object): + b = 2 + assert Foo().b == Bar().b + + +def globf(x): + return x+1 + +class TestRaises: + def test_raises(self): + s = 'qwe' + raises(TypeError, "int(s)") + + def test_raises_doesnt(self): + raises(IOError, "int('3')") + + def test_raise(self): + raise ValueError("demo error") + + def test_tupleerror(self): + a,b = [1] + + def test_reinterpret_fails_with_print_for_the_fun_of_it(self): + l = [1,2,3] + print ("l is %r" % l) + a,b = l.pop() + + def test_some_error(self): + if namenotexi: + pass + + def func1(self): + assert 41 == 42 + + +# thanks to Matthew Scott for this test +def test_dynamic_compile_shows_nicely(): + src = 'def foo():\n assert 1 == 0\n' + name = 'abc-123' + module = py.std.imp.new_module(name) + code = _pytest._code.compile(src, name, 'exec') + py.builtin.exec_(code, module.__dict__) + py.std.sys.modules[name] = module + module.foo() + + + +class TestMoreErrors: + def test_complex_error(self): + def f(): + return 44 + def g(): + return 43 + somefunc(f(), g()) + + def test_z1_unpack_error(self): + l = [] + a,b = l + + def test_z2_type_error(self): + l = 3 + a,b = l + + def test_startswith(self): + s = "123" + g = "456" + assert s.startswith(g) + + def test_startswith_nested(self): + def f(): + return "123" + def g(): + return "456" + assert f().startswith(g()) + + def test_global_func(self): + assert isinstance(globf(42), float) + + def test_instance(self): + self.x = 6*7 + assert self.x != 42 + + def test_compare(self): + assert globf(10) < 5 + + def test_try_finally(self): + x = 1 + try: + assert x == 0 + finally: + x = 0 + + +class TestCustomAssertMsg: + + def test_single_line(self): + class A: + a = 1 + b = 2 + assert A.a == b, "A.a appears not to be b" + + def test_multiline(self): + class A: + a = 1 + b = 2 + assert A.a == b, "A.a appears not to be b\n" \ + "or does not appear to be b\none of those" + + def test_custom_repr(self): + class JSON: + a = 1 + def __repr__(self): + return "This is JSON\n{\n 'foo': 'bar'\n}" + a = JSON() + b = 2 + assert a.a == b, a diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/global_testmodule_config/conftest.py b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/global_testmodule_config/conftest.py new file mode 100644 index 000000000..71e8c54be --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/global_testmodule_config/conftest.py @@ -0,0 +1,10 @@ +import pytest, py +mydir = py.path.local(__file__).dirpath() + +def pytest_runtest_setup(item): + if isinstance(item, pytest.Function): + if not item.fspath.relto(mydir): + return + mod = item.getparent(pytest.Module).obj + if hasattr(mod, 'hello'): + print ("mod.hello %r" % (mod.hello,)) diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/global_testmodule_config/test_hello.py b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/global_testmodule_config/test_hello.py new file mode 100644 index 000000000..828e6b9fd --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/global_testmodule_config/test_hello.py @@ -0,0 +1,5 @@ + +hello = "world" + +def test_func(): + pass diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/test_failures.py b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/test_failures.py new file mode 100644 index 000000000..2e5cd20b1 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/test_failures.py @@ -0,0 +1,14 @@ + +import py +failure_demo = py.path.local(__file__).dirpath('failure_demo.py') +pytest_plugins = 'pytester', + +def test_failure_demo_fails_properly(testdir): + target = testdir.tmpdir.join(failure_demo.basename) + failure_demo.copy(target) + failure_demo.copy(testdir.tmpdir.join(failure_demo.basename)) + result = testdir.runpytest(target, syspathinsert=True) + result.stdout.fnmatch_lines([ + "*42 failed*" + ]) + assert result.ret != 0 diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/test_setup_flow_example.py b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/test_setup_flow_example.py new file mode 100644 index 000000000..512330cb4 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/assertion/test_setup_flow_example.py @@ -0,0 +1,42 @@ +def setup_module(module): + module.TestStateFullThing.classcount = 0 + +class TestStateFullThing: + def setup_class(cls): + cls.classcount += 1 + + def teardown_class(cls): + cls.classcount -= 1 + + def setup_method(self, method): + self.id = eval(method.__name__[5:]) + + def test_42(self): + assert self.classcount == 1 + assert self.id == 42 + + def test_23(self): + assert self.classcount == 1 + assert self.id == 23 + +def teardown_module(module): + assert module.TestStateFullThing.classcount == 0 + +""" For this example the control flow happens as follows:: + import test_setup_flow_example + setup_module(test_setup_flow_example) + setup_class(TestStateFullThing) + instance = TestStateFullThing() + setup_method(instance, instance.test_42) + instance.test_42() + setup_method(instance, instance.test_23) + instance.test_23() + teardown_class(TestStateFullThing) + teardown_module(test_setup_flow_example) + +Note that ``setup_class(TestStateFullThing)`` is called and not +``TestStateFullThing.setup_class()`` which would require you +to insert ``setup_class = classmethod(setup_class)`` to make +your setup function callable. +""" + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/attic.rst b/testing/web-platform/tests/tools/pytest/doc/en/example/attic.rst new file mode 100644 index 000000000..1bc32b283 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/attic.rst @@ -0,0 +1,79 @@ + +.. _`accept example`: + +example: specifying and selecting acceptance tests +-------------------------------------------------------------- + +.. sourcecode:: python + + # ./conftest.py + def pytest_option(parser): + group = parser.getgroup("myproject") + group.addoption("-A", dest="acceptance", action="store_true", + help="run (slow) acceptance tests") + + def pytest_funcarg__accept(request): + return AcceptFixture(request) + + class AcceptFixture: + def __init__(self, request): + if not request.config.option.acceptance: + pytest.skip("specify -A to run acceptance tests") + self.tmpdir = request.config.mktemp(request.function.__name__, numbered=True) + + def run(self, cmd): + """ called by test code to execute an acceptance test. """ + self.tmpdir.chdir() + return py.process.cmdexec(cmd) + + +and the actual test function example: + +.. sourcecode:: python + + def test_some_acceptance_aspect(accept): + accept.tmpdir.mkdir("somesub") + result = accept.run("ls -la") + assert "somesub" in result + +If you run this test without specifying a command line option +the test will get skipped with an appropriate message. Otherwise +you can start to add convenience and test support methods +to your AcceptFixture and drive running of tools or +applications and provide ways to do assertions about +the output. + +.. _`decorate a funcarg`: + +example: decorating a funcarg in a test module +-------------------------------------------------------------- + +For larger scale setups it's sometimes useful to decorate +a funcarg just for a particular test module. We can +extend the `accept example`_ by putting this in our test module: + +.. sourcecode:: python + + def pytest_funcarg__accept(request): + # call the next factory (living in our conftest.py) + arg = request.getfuncargvalue("accept") + # create a special layout in our tempdir + arg.tmpdir.mkdir("special") + return arg + + class TestSpecialAcceptance: + def test_sometest(self, accept): + assert accept.tmpdir.join("special").check() + +Our module level factory will be invoked first and it can +ask its request object to call the next factory and then +decorate its result. This mechanism allows us to stay +ignorant of how/where the function argument is provided - +in our example from a `conftest plugin`_. + +sidenote: the temporary directory used here are instances of +the `py.path.local`_ class which provides many of the os.path +methods in a convenient way. + +.. _`py.path.local`: ../path.html#local +.. _`conftest plugin`: customize.html#conftestplugin diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/conftest.py b/testing/web-platform/tests/tools/pytest/doc/en/example/conftest.py new file mode 100644 index 000000000..f905738c4 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/conftest.py @@ -0,0 +1 @@ +collect_ignore = ["nonpython"] diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/conftest.py b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/conftest.py new file mode 100644 index 000000000..d689c11b2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/conftest.py @@ -0,0 +1,18 @@ + +import pytest + +@pytest.fixture("session") +def setup(request): + setup = CostlySetup() + request.addfinalizer(setup.finalize) + return setup + +class CostlySetup: + def __init__(self): + import time + print ("performing costly setup") + time.sleep(5) + self.timecostly = 1 + + def finalize(self): + del self.timecostly diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub1/__init__.py b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub1/__init__.py new file mode 100644 index 000000000..792d60054 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub1/__init__.py @@ -0,0 +1 @@ +# diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub1/test_quick.py b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub1/test_quick.py new file mode 100644 index 000000000..d97657867 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub1/test_quick.py @@ -0,0 +1,3 @@ + +def test_quick(setup): + pass diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub2/__init__.py b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub2/__init__.py new file mode 100644 index 000000000..792d60054 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub2/__init__.py @@ -0,0 +1 @@ +# diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub2/test_two.py b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub2/test_two.py new file mode 100644 index 000000000..6ed6ee4d8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/costlysetup/sub2/test_two.py @@ -0,0 +1,6 @@ +def test_something(setup): + assert setup.timecostly == 1 + +def test_something_more(setup): + assert setup.timecostly == 1 + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/index.rst b/testing/web-platform/tests/tools/pytest/doc/en/example/index.rst new file mode 100644 index 000000000..363de5ab7 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/index.rst @@ -0,0 +1,34 @@ + +.. _examples: + +Usages and Examples +=========================================== + +Here is a (growing) list of examples. :ref:`Contact <contact>` us if you +need more examples or have questions. Also take a look at the +:ref:`comprehensive documentation <toc>` which contains many example +snippets as well. Also, `pytest on stackoverflow.com +<http://stackoverflow.com/search?q=pytest>`_ often comes with example +answers. + +For basic examples, see + +- :doc:`../getting-started` for basic introductory examples +- :ref:`assert` for basic assertion examples +- :ref:`fixtures` for basic fixture/setup examples +- :ref:`parametrize` for basic test function parametrization +- :doc:`../unittest` for basic unittest integration +- :doc:`../nose` for basic nosetests integration + +The following examples aim at various use cases you might encounter. + +.. toctree:: + :maxdepth: 2 + + reportingdemo + simple + parametrize + markers + special + pythoncollection + nonpython diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/layout1/setup.cfg b/testing/web-platform/tests/tools/pytest/doc/en/example/layout1/setup.cfg new file mode 100644 index 000000000..02d3750ee --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/layout1/setup.cfg @@ -0,0 +1,4 @@ +[pytest] +testfilepatterns = + ${topdir}/tests/unit/test_${basename} + ${topdir}/tests/functional/*.py diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/markers.rst b/testing/web-platform/tests/tools/pytest/doc/en/example/markers.rst new file mode 100644 index 000000000..6bdc60347 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/markers.rst @@ -0,0 +1,592 @@ + +.. _`mark examples`: + +Working with custom markers +================================================= + +Here are some example using the :ref:`mark` mechanism. + +Marking test functions and selecting them for a run +---------------------------------------------------- + +You can "mark" a test function with custom metadata like this:: + + # content of test_server.py + + import pytest + @pytest.mark.webtest + def test_send_http(): + pass # perform some webtest test for your app + def test_something_quick(): + pass + def test_another(): + pass + class TestClass: + def test_method(self): + pass + +.. versionadded:: 2.2 + +You can then restrict a test run to only run tests marked with ``webtest``:: + + $ py.test -v -m webtest + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 4 items + + test_server.py::test_send_http PASSED + + ======= 3 tests deselected by "-m 'webtest'" ======== + ======= 1 passed, 3 deselected in 0.12 seconds ======== + +Or the inverse, running all tests except the webtest ones:: + + $ py.test -v -m "not webtest" + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 4 items + + test_server.py::test_something_quick PASSED + test_server.py::test_another PASSED + test_server.py::TestClass::test_method PASSED + + ======= 1 tests deselected by "-m 'not webtest'" ======== + ======= 3 passed, 1 deselected in 0.12 seconds ======== + +Selecting tests based on their node ID +-------------------------------------- + +You can provide one or more :ref:`node IDs <node-id>` as positional +arguments to select only specified tests. This makes it easy to select +tests based on their module, class, method, or function name:: + + $ py.test -v test_server.py::TestClass::test_method + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 5 items + + test_server.py::TestClass::test_method PASSED + + ======= 1 passed in 0.12 seconds ======== + +You can also select on the class:: + + $ py.test -v test_server.py::TestClass + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 4 items + + test_server.py::TestClass::test_method PASSED + + ======= 1 passed in 0.12 seconds ======== + +Or select multiple nodes:: + + $ py.test -v test_server.py::TestClass test_server.py::test_send_http + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 8 items + + test_server.py::TestClass::test_method PASSED + test_server.py::test_send_http PASSED + + ======= 2 passed in 0.12 seconds ======== + +.. _node-id: + +.. note:: + + Node IDs are of the form ``module.py::class::method`` or + ``module.py::function``. Node IDs control which tests are + collected, so ``module.py::class`` will select all test methods + on the class. Nodes are also created for each parameter of a + parametrized fixture or test, so selecting a parametrized test + must include the parameter value, e.g. + ``module.py::function[param]``. + + Node IDs for failing tests are displayed in the test summary info + when running py.test with the ``-rf`` option. You can also + construct Node IDs from the output of ``py.test --collectonly``. + +Using ``-k expr`` to select tests based on their name +------------------------------------------------------- + +.. versionadded: 2.0/2.3.4 + +You can use the ``-k`` command line option to specify an expression +which implements a substring match on the test names instead of the +exact match on markers that ``-m`` provides. This makes it easy to +select tests based on their names:: + + $ py.test -v -k http # running with the above defined example module + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 4 items + + test_server.py::test_send_http PASSED + + ======= 3 tests deselected by '-khttp' ======== + ======= 1 passed, 3 deselected in 0.12 seconds ======== + +And you can also run all tests except the ones that match the keyword:: + + $ py.test -k "not send_http" -v + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 4 items + + test_server.py::test_something_quick PASSED + test_server.py::test_another PASSED + test_server.py::TestClass::test_method PASSED + + ======= 1 tests deselected by '-knot send_http' ======== + ======= 3 passed, 1 deselected in 0.12 seconds ======== + +Or to select "http" and "quick" tests:: + + $ py.test -k "http or quick" -v + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 4 items + + test_server.py::test_send_http PASSED + test_server.py::test_something_quick PASSED + + ======= 2 tests deselected by '-khttp or quick' ======== + ======= 2 passed, 2 deselected in 0.12 seconds ======== + +.. note:: + + If you are using expressions such as "X and Y" then both X and Y + need to be simple non-keyword names. For example, "pass" or "from" + will result in SyntaxErrors because "-k" evaluates the expression. + + However, if the "-k" argument is a simple string, no such restrictions + apply. Also "-k 'not STRING'" has no restrictions. You can also + specify numbers like "-k 1.3" to match tests which are parametrized + with the float "1.3". + +Registering markers +------------------------------------- + +.. versionadded:: 2.2 + +.. ini-syntax for custom markers: + +Registering markers for your test suite is simple:: + + # content of pytest.ini + [pytest] + markers = + webtest: mark a test as a webtest. + +You can ask which markers exist for your test suite - the list includes our just defined ``webtest`` markers:: + + $ py.test --markers + @pytest.mark.webtest: mark a test as a webtest. + + @pytest.mark.skipif(condition): skip the given test function if eval(condition) results in a True value. Evaluation happens within the module global context. Example: skipif('sys.platform == "win32"') skips the test if we are on the win32 platform. see http://pytest.org/latest/skipping.html + + @pytest.mark.xfail(condition, reason=None, run=True, raises=None): mark the the test function as an expected failure if eval(condition) has a True value. Optionally specify a reason for better reporting and run=False if you don't even want to execute the test function. If only specific exception(s) are expected, you can list them in raises, and if the test fails in other ways, it will be reported as a true failure. See http://pytest.org/latest/skipping.html + + @pytest.mark.parametrize(argnames, argvalues): call a test function multiple times passing in different arguments in turn. argvalues generally needs to be a list of values if argnames specifies only one name or a list of tuples of values if argnames specifies multiple names. Example: @parametrize('arg1', [1,2]) would lead to two calls of the decorated test function, one with arg1=1 and another with arg1=2.see http://pytest.org/latest/parametrize.html for more info and examples. + + @pytest.mark.usefixtures(fixturename1, fixturename2, ...): mark tests as needing all of the specified fixtures. see http://pytest.org/latest/fixture.html#usefixtures + + @pytest.mark.tryfirst: mark a hook implementation function such that the plugin machinery will try to call it first/as early as possible. + + @pytest.mark.trylast: mark a hook implementation function such that the plugin machinery will try to call it last/as late as possible. + + +For an example on how to add and work with markers from a plugin, see +:ref:`adding a custom marker from a plugin`. + +.. note:: + + It is recommended to explicitly register markers so that: + + * there is one place in your test suite defining your markers + + * asking for existing markers via ``py.test --markers`` gives good output + + * typos in function markers are treated as an error if you use + the ``--strict`` option. Future versions of ``pytest`` are probably + going to start treating non-registered markers as errors at some point. + +.. _`scoped-marking`: + +Marking whole classes or modules +---------------------------------------------------- + +You may use ``pytest.mark`` decorators with classes to apply markers to all of +its test methods:: + + # content of test_mark_classlevel.py + import pytest + @pytest.mark.webtest + class TestClass: + def test_startup(self): + pass + def test_startup_and_more(self): + pass + +This is equivalent to directly applying the decorator to the +two test functions. + +To remain backward-compatible with Python 2.4 you can also set a +``pytestmark`` attribute on a TestClass like this:: + + import pytest + + class TestClass: + pytestmark = pytest.mark.webtest + +or if you need to use multiple markers you can use a list:: + + import pytest + + class TestClass: + pytestmark = [pytest.mark.webtest, pytest.mark.slowtest] + +You can also set a module level marker:: + + import pytest + pytestmark = pytest.mark.webtest + +in which case it will be applied to all functions and +methods defined in the module. + +.. _`marking individual tests when using parametrize`: + +Marking individual tests when using parametrize +----------------------------------------------- + +When using parametrize, applying a mark will make it apply +to each individual test. However it is also possible to +apply a marker to an individual test instance:: + + import pytest + + @pytest.mark.foo + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + pytest.mark.bar((1, 3)), + (2, 3), + ]) + def test_increment(n, expected): + assert n + 1 == expected + +In this example the mark "foo" will apply to each of the three +tests, whereas the "bar" mark is only applied to the second test. +Skip and xfail marks can also be applied in this way, see :ref:`skip/xfail with parametrize`. + +.. note:: + + If the data you are parametrizing happen to be single callables, you need to be careful + when marking these items. `pytest.mark.xfail(my_func)` won't work because it's also the + signature of a function being decorated. To resolve this ambiguity, you need to pass a + reason argument: + `pytest.mark.xfail(func_bar, reason="Issue#7")`. + + +.. _`adding a custom marker from a plugin`: + +Custom marker and command line option to control test runs +---------------------------------------------------------- + +.. regendoc:wipe + +Plugins can provide custom markers and implement specific behaviour +based on it. This is a self-contained example which adds a command +line option and a parametrized test function marker to run tests +specifies via named environments:: + + # content of conftest.py + + import pytest + def pytest_addoption(parser): + parser.addoption("-E", action="store", metavar="NAME", + help="only run tests matching the environment NAME.") + + def pytest_configure(config): + # register an additional marker + config.addinivalue_line("markers", + "env(name): mark test to run only on named environment") + + def pytest_runtest_setup(item): + envmarker = item.get_marker("env") + if envmarker is not None: + envname = envmarker.args[0] + if envname != item.config.getoption("-E"): + pytest.skip("test requires env %r" % envname) + +A test file using this local plugin:: + + # content of test_someenv.py + + import pytest + @pytest.mark.env("stage1") + def test_basic_db_operation(): + pass + +and an example invocations specifying a different environment than what +the test needs:: + + $ py.test -E stage2 + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 1 items + + test_someenv.py s + + ======= 1 skipped in 0.12 seconds ======== + +and here is one that specifies exactly the environment needed:: + + $ py.test -E stage1 + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 1 items + + test_someenv.py . + + ======= 1 passed in 0.12 seconds ======== + +The ``--markers`` option always gives you a list of available markers:: + + $ py.test --markers + @pytest.mark.env(name): mark test to run only on named environment + + @pytest.mark.skipif(condition): skip the given test function if eval(condition) results in a True value. Evaluation happens within the module global context. Example: skipif('sys.platform == "win32"') skips the test if we are on the win32 platform. see http://pytest.org/latest/skipping.html + + @pytest.mark.xfail(condition, reason=None, run=True, raises=None): mark the the test function as an expected failure if eval(condition) has a True value. Optionally specify a reason for better reporting and run=False if you don't even want to execute the test function. If only specific exception(s) are expected, you can list them in raises, and if the test fails in other ways, it will be reported as a true failure. See http://pytest.org/latest/skipping.html + + @pytest.mark.parametrize(argnames, argvalues): call a test function multiple times passing in different arguments in turn. argvalues generally needs to be a list of values if argnames specifies only one name or a list of tuples of values if argnames specifies multiple names. Example: @parametrize('arg1', [1,2]) would lead to two calls of the decorated test function, one with arg1=1 and another with arg1=2.see http://pytest.org/latest/parametrize.html for more info and examples. + + @pytest.mark.usefixtures(fixturename1, fixturename2, ...): mark tests as needing all of the specified fixtures. see http://pytest.org/latest/fixture.html#usefixtures + + @pytest.mark.tryfirst: mark a hook implementation function such that the plugin machinery will try to call it first/as early as possible. + + @pytest.mark.trylast: mark a hook implementation function such that the plugin machinery will try to call it last/as late as possible. + + +Reading markers which were set from multiple places +---------------------------------------------------- + +.. versionadded: 2.2.2 + +.. regendoc:wipe + +If you are heavily using markers in your test suite you may encounter the case where a marker is applied several times to a test function. From plugin +code you can read over all such settings. Example:: + + # content of test_mark_three_times.py + import pytest + pytestmark = pytest.mark.glob("module", x=1) + + @pytest.mark.glob("class", x=2) + class TestClass: + @pytest.mark.glob("function", x=3) + def test_something(self): + pass + +Here we have the marker "glob" applied three times to the same +test function. From a conftest file we can read it like this:: + + # content of conftest.py + import sys + + def pytest_runtest_setup(item): + g = item.get_marker("glob") + if g is not None: + for info in g: + print ("glob args=%s kwargs=%s" %(info.args, info.kwargs)) + sys.stdout.flush() + +Let's run this without capturing output and see what we get:: + + $ py.test -q -s + glob args=('function',) kwargs={'x': 3} + glob args=('class',) kwargs={'x': 2} + glob args=('module',) kwargs={'x': 1} + . + 1 passed in 0.12 seconds + +marking platform specific tests with pytest +-------------------------------------------------------------- + +.. regendoc:wipe + +Consider you have a test suite which marks tests for particular platforms, +namely ``pytest.mark.darwin``, ``pytest.mark.win32`` etc. and you +also have tests that run on all platforms and have no specific +marker. If you now want to have a way to only run the tests +for your particular platform, you could use the following plugin:: + + # content of conftest.py + # + import sys + import pytest + + ALL = set("darwin linux2 win32".split()) + + def pytest_runtest_setup(item): + if isinstance(item, item.Function): + plat = sys.platform + if not item.get_marker(plat): + if ALL.intersection(item.keywords): + pytest.skip("cannot run on platform %s" %(plat)) + +then tests will be skipped if they were specified for a different platform. +Let's do a little test file to show how this looks like:: + + # content of test_plat.py + + import pytest + + @pytest.mark.darwin + def test_if_apple_is_evil(): + pass + + @pytest.mark.linux2 + def test_if_linux_works(): + pass + + @pytest.mark.win32 + def test_if_win32_crashes(): + pass + + def test_runs_everywhere(): + pass + +then you will see two test skipped and two executed tests as expected:: + + $ py.test -rs # this option reports skip reasons + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 4 items + + test_plat.py sss. + ======= short test summary info ======== + SKIP [3] $REGENDOC_TMPDIR/conftest.py:12: cannot run on platform linux + + ======= 1 passed, 3 skipped in 0.12 seconds ======== + +Note that if you specify a platform via the marker-command line option like this:: + + $ py.test -m linux2 + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 4 items + + test_plat.py s + + ======= 3 tests deselected by "-m 'linux2'" ======== + ======= 1 skipped, 3 deselected in 0.12 seconds ======== + +then the unmarked-tests will not be run. It is thus a way to restrict the run to the specific tests. + +Automatically adding markers based on test names +-------------------------------------------------------- + +.. regendoc:wipe + +If you a test suite where test function names indicate a certain +type of test, you can implement a hook that automatically defines +markers so that you can use the ``-m`` option with it. Let's look +at this test module:: + + # content of test_module.py + + def test_interface_simple(): + assert 0 + + def test_interface_complex(): + assert 0 + + def test_event_simple(): + assert 0 + + def test_something_else(): + assert 0 + +We want to dynamically define two markers and can do it in a +``conftest.py`` plugin:: + + # content of conftest.py + + import pytest + def pytest_collection_modifyitems(items): + for item in items: + if "interface" in item.nodeid: + item.add_marker(pytest.mark.interface) + elif "event" in item.nodeid: + item.add_marker(pytest.mark.event) + +We can now use the ``-m option`` to select one set:: + + $ py.test -m interface --tb=short + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 4 items + + test_module.py FF + + ======= FAILURES ======== + _______ test_interface_simple ________ + test_module.py:3: in test_interface_simple + assert 0 + E assert 0 + _______ test_interface_complex ________ + test_module.py:6: in test_interface_complex + assert 0 + E assert 0 + ======= 2 tests deselected by "-m 'interface'" ======== + ======= 2 failed, 2 deselected in 0.12 seconds ======== + +or to select both "event" and "interface" tests:: + + $ py.test -m "interface or event" --tb=short + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 4 items + + test_module.py FFF + + ======= FAILURES ======== + _______ test_interface_simple ________ + test_module.py:3: in test_interface_simple + assert 0 + E assert 0 + _______ test_interface_complex ________ + test_module.py:6: in test_interface_complex + assert 0 + E assert 0 + _______ test_event_simple ________ + test_module.py:9: in test_event_simple + assert 0 + E assert 0 + ======= 1 tests deselected by "-m 'interface or event'" ======== + ======= 3 failed, 1 deselected in 0.12 seconds ======== diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/multipython.py b/testing/web-platform/tests/tools/pytest/doc/en/example/multipython.py new file mode 100644 index 000000000..66a368a12 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/multipython.py @@ -0,0 +1,52 @@ +""" +module containing a parametrized tests testing cross-python +serialization via the pickle module. +""" +import py +import pytest +import _pytest._code + +pythonlist = ['python2.6', 'python2.7', 'python3.3'] +@pytest.fixture(params=pythonlist) +def python1(request, tmpdir): + picklefile = tmpdir.join("data.pickle") + return Python(request.param, picklefile) + +@pytest.fixture(params=pythonlist) +def python2(request, python1): + return Python(request.param, python1.picklefile) + +class Python: + def __init__(self, version, picklefile): + self.pythonpath = py.path.local.sysfind(version) + if not self.pythonpath: + pytest.skip("%r not found" %(version,)) + self.picklefile = picklefile + def dumps(self, obj): + dumpfile = self.picklefile.dirpath("dump.py") + dumpfile.write(_pytest._code.Source(""" + import pickle + f = open(%r, 'wb') + s = pickle.dump(%r, f, protocol=2) + f.close() + """ % (str(self.picklefile), obj))) + py.process.cmdexec("%s %s" %(self.pythonpath, dumpfile)) + + def load_and_is_true(self, expression): + loadfile = self.picklefile.dirpath("load.py") + loadfile.write(_pytest._code.Source(""" + import pickle + f = open(%r, 'rb') + obj = pickle.load(f) + f.close() + res = eval(%r) + if not res: + raise SystemExit(1) + """ % (str(self.picklefile), expression))) + print (loadfile) + py.process.cmdexec("%s %s" %(self.pythonpath, loadfile)) + +@pytest.mark.parametrize("obj", [42, {}, {1:3},]) +def test_basic_objects(python1, python2, obj): + python1.dumps(obj) + python2.load_and_is_true("obj == %s" % obj) diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython.rst b/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython.rst new file mode 100644 index 000000000..6437e3984 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython.rst @@ -0,0 +1,91 @@ + +.. _`non-python tests`: + +Working with non-python tests +==================================================== + +.. _`yaml plugin`: + +A basic example for specifying tests in Yaml files +-------------------------------------------------------------- + +.. _`pytest-yamlwsgi`: http://bitbucket.org/aafshar/pytest-yamlwsgi/src/tip/pytest_yamlwsgi.py +.. _`PyYAML`: http://pypi.python.org/pypi/PyYAML/ + +Here is an example ``conftest.py`` (extracted from Ali Afshnars special purpose `pytest-yamlwsgi`_ plugin). This ``conftest.py`` will collect ``test*.yml`` files and will execute the yaml-formatted content as custom tests: + +.. include:: nonpython/conftest.py + :literal: + +You can create a simple example file: + +.. include:: nonpython/test_simple.yml + :literal: + +and if you installed `PyYAML`_ or a compatible YAML-parser you can +now execute the test specification:: + + nonpython $ py.test test_simple.yml + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR/nonpython, inifile: + collected 2 items + + test_simple.yml F. + + ======= FAILURES ======== + _______ usecase: hello ________ + usecase execution failed + spec failed: 'some': 'other' + no further details known at this point. + ======= 1 failed, 1 passed in 0.12 seconds ======== + +.. regendoc:wipe + +You get one dot for the passing ``sub1: sub1`` check and one failure. +Obviously in the above ``conftest.py`` you'll want to implement a more +interesting interpretation of the yaml-values. You can easily write +your own domain specific testing language this way. + +.. note:: + + ``repr_failure(excinfo)`` is called for representing test failures. + If you create custom collection nodes you can return an error + representation string of your choice. It + will be reported as a (red) string. + +``reportinfo()`` is used for representing the test location and is also +consulted when reporting in ``verbose`` mode:: + + nonpython $ py.test -v + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR/nonpython, inifile: + collecting ... collected 2 items + + test_simple.yml::hello FAILED + test_simple.yml::ok PASSED + + ======= FAILURES ======== + _______ usecase: hello ________ + usecase execution failed + spec failed: 'some': 'other' + no further details known at this point. + ======= 1 failed, 1 passed in 0.12 seconds ======== + +.. regendoc:wipe + +While developing your custom test collection and execution it's also +interesting to just look at the collection tree:: + + nonpython $ py.test --collect-only + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR/nonpython, inifile: + collected 2 items + <YamlFile 'test_simple.yml'> + <YamlItem 'hello'> + <YamlItem 'ok'> + + ======= no tests ran in 0.12 seconds ======== diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython/__init__.py b/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython/__init__.py new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython/__init__.py diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython/conftest.py b/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython/conftest.py new file mode 100644 index 000000000..2406e8f10 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython/conftest.py @@ -0,0 +1,40 @@ +# content of conftest.py + +import pytest + +def pytest_collect_file(parent, path): + if path.ext == ".yml" and path.basename.startswith("test"): + return YamlFile(path, parent) + +class YamlFile(pytest.File): + def collect(self): + import yaml # we need a yaml parser, e.g. PyYAML + raw = yaml.safe_load(self.fspath.open()) + for name, spec in raw.items(): + yield YamlItem(name, self, spec) + +class YamlItem(pytest.Item): + def __init__(self, name, parent, spec): + super(YamlItem, self).__init__(name, parent) + self.spec = spec + + def runtest(self): + for name, value in self.spec.items(): + # some custom test execution (dumb example follows) + if name != value: + raise YamlException(self, name, value) + + def repr_failure(self, excinfo): + """ called when self.runtest() raises an exception. """ + if isinstance(excinfo.value, YamlException): + return "\n".join([ + "usecase execution failed", + " spec failed: %r: %r" % excinfo.value.args[1:3], + " no further details known at this point." + ]) + + def reportinfo(self): + return self.fspath, 0, "usecase: %s" % self.name + +class YamlException(Exception): + """ custom exception for error reporting. """ diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython/test_simple.yml b/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython/test_simple.yml new file mode 100644 index 000000000..f0d8d11fc --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/nonpython/test_simple.yml @@ -0,0 +1,7 @@ +# test_simple.yml +ok: + sub1: sub1 + +hello: + world: world + some: other diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/parametrize.rst b/testing/web-platform/tests/tools/pytest/doc/en/example/parametrize.rst new file mode 100644 index 000000000..5d637ffcb --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/parametrize.rst @@ -0,0 +1,475 @@ + +.. _paramexamples: + +Parametrizing tests +================================================= + +.. currentmodule:: _pytest.python + +``pytest`` allows to easily parametrize test functions. +For basic docs, see :ref:`parametrize-basics`. + +In the following we provide some examples using +the builtin mechanisms. + +Generating parameters combinations, depending on command line +---------------------------------------------------------------------------- + +.. regendoc:wipe + +Let's say we want to execute a test with different computation +parameters and the parameter range shall be determined by a command +line argument. Let's first write a simple (do-nothing) computation test:: + + # content of test_compute.py + + def test_compute(param1): + assert param1 < 4 + +Now we add a test configuration like this:: + + # content of conftest.py + + def pytest_addoption(parser): + parser.addoption("--all", action="store_true", + help="run all combinations") + + def pytest_generate_tests(metafunc): + if 'param1' in metafunc.fixturenames: + if metafunc.config.option.all: + end = 5 + else: + end = 2 + metafunc.parametrize("param1", range(end)) + +This means that we only run 2 tests if we do not pass ``--all``:: + + $ py.test -q test_compute.py + .. + 2 passed in 0.12 seconds + +We run only two computations, so we see two dots. +let's run the full monty:: + + $ py.test -q --all + ....F + ======= FAILURES ======== + _______ test_compute[4] ________ + + param1 = 4 + + def test_compute(param1): + > assert param1 < 4 + E assert 4 < 4 + + test_compute.py:3: AssertionError + 1 failed, 4 passed in 0.12 seconds + +As expected when running the full range of ``param1`` values +we'll get an error on the last one. + + +Different options for test IDs +------------------------------------ + +pytest will build a string that is the test ID for each set of values in a +parametrized test. These IDs can be used with ``-k`` to select specific cases +to run, and they will also identify the specific case when one is failing. +Running pytest with ``--collect-only`` will show the generated IDs. + +Numbers, strings, booleans and None will have their usual string representation +used in the test ID. For other objects, pytest will make a string based on +the argument name:: + + # content of test_time.py + + import pytest + + from datetime import datetime, timedelta + + testdata = [ + (datetime(2001, 12, 12), datetime(2001, 12, 11), timedelta(1)), + (datetime(2001, 12, 11), datetime(2001, 12, 12), timedelta(-1)), + ] + + + @pytest.mark.parametrize("a,b,expected", testdata) + def test_timedistance_v0(a, b, expected): + diff = a - b + assert diff == expected + + + @pytest.mark.parametrize("a,b,expected", testdata, ids=["forward", "backward"]) + def test_timedistance_v1(a, b, expected): + diff = a - b + assert diff == expected + + + def idfn(val): + if isinstance(val, (datetime,)): + # note this wouldn't show any hours/minutes/seconds + return val.strftime('%Y%m%d') + + + @pytest.mark.parametrize("a,b,expected", testdata, ids=idfn) + def test_timedistance_v2(a, b, expected): + diff = a - b + assert diff == expected + + +In ``test_timedistance_v0``, we let pytest generate the test IDs. + +In ``test_timedistance_v1``, we specified ``ids`` as a list of strings which were +used as the test IDs. These are succinct, but can be a pain to maintain. + +In ``test_timedistance_v2``, we specified ``ids`` as a function that can generate a +string representation to make part of the test ID. So our ``datetime`` values use the +label generated by ``idfn``, but because we didn't generate a label for ``timedelta`` +objects, they are still using the default pytest representation:: + + + $ py.test test_time.py --collect-only + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 6 items + <Module 'test_time.py'> + <Function 'test_timedistance_v0[a0-b0-expected0]'> + <Function 'test_timedistance_v0[a1-b1-expected1]'> + <Function 'test_timedistance_v1[forward]'> + <Function 'test_timedistance_v1[backward]'> + <Function 'test_timedistance_v2[20011212-20011211-expected0]'> + <Function 'test_timedistance_v2[20011211-20011212-expected1]'> + + ======= no tests ran in 0.12 seconds ======== + +A quick port of "testscenarios" +------------------------------------ + +.. _`test scenarios`: http://pypi.python.org/pypi/testscenarios/ + +Here is a quick port to run tests configured with `test scenarios`_, +an add-on from Robert Collins for the standard unittest framework. We +only have to work a bit to construct the correct arguments for pytest's +:py:func:`Metafunc.parametrize`:: + + # content of test_scenarios.py + + def pytest_generate_tests(metafunc): + idlist = [] + argvalues = [] + for scenario in metafunc.cls.scenarios: + idlist.append(scenario[0]) + items = scenario[1].items() + argnames = [x[0] for x in items] + argvalues.append(([x[1] for x in items])) + metafunc.parametrize(argnames, argvalues, ids=idlist, scope="class") + + scenario1 = ('basic', {'attribute': 'value'}) + scenario2 = ('advanced', {'attribute': 'value2'}) + + class TestSampleWithScenarios: + scenarios = [scenario1, scenario2] + + def test_demo1(self, attribute): + assert isinstance(attribute, str) + + def test_demo2(self, attribute): + assert isinstance(attribute, str) + +this is a fully self-contained example which you can run with:: + + $ py.test test_scenarios.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 4 items + + test_scenarios.py .... + + ======= 4 passed in 0.12 seconds ======== + +If you just collect tests you'll also nicely see 'advanced' and 'basic' as variants for the test function:: + + + $ py.test --collect-only test_scenarios.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 4 items + <Module 'test_scenarios.py'> + <Class 'TestSampleWithScenarios'> + <Instance '()'> + <Function 'test_demo1[basic]'> + <Function 'test_demo2[basic]'> + <Function 'test_demo1[advanced]'> + <Function 'test_demo2[advanced]'> + + ======= no tests ran in 0.12 seconds ======== + +Note that we told ``metafunc.parametrize()`` that your scenario values +should be considered class-scoped. With pytest-2.3 this leads to a +resource-based ordering. + +Deferring the setup of parametrized resources +--------------------------------------------------- + +.. regendoc:wipe + +The parametrization of test functions happens at collection +time. It is a good idea to setup expensive resources like DB +connections or subprocess only when the actual test is run. +Here is a simple example how you can achieve that, first +the actual test requiring a ``db`` object:: + + # content of test_backends.py + + import pytest + def test_db_initialized(db): + # a dummy test + if db.__class__.__name__ == "DB2": + pytest.fail("deliberately failing for demo purposes") + +We can now add a test configuration that generates two invocations of +the ``test_db_initialized`` function and also implements a factory that +creates a database object for the actual test invocations:: + + # content of conftest.py + import pytest + + def pytest_generate_tests(metafunc): + if 'db' in metafunc.fixturenames: + metafunc.parametrize("db", ['d1', 'd2'], indirect=True) + + class DB1: + "one database object" + class DB2: + "alternative database object" + + @pytest.fixture + def db(request): + if request.param == "d1": + return DB1() + elif request.param == "d2": + return DB2() + else: + raise ValueError("invalid internal test config") + +Let's first see how it looks like at collection time:: + + $ py.test test_backends.py --collect-only + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 2 items + <Module 'test_backends.py'> + <Function 'test_db_initialized[d1]'> + <Function 'test_db_initialized[d2]'> + + ======= no tests ran in 0.12 seconds ======== + +And then when we run the test:: + + $ py.test -q test_backends.py + .F + ======= FAILURES ======== + _______ test_db_initialized[d2] ________ + + db = <conftest.DB2 object at 0xdeadbeef> + + def test_db_initialized(db): + # a dummy test + if db.__class__.__name__ == "DB2": + > pytest.fail("deliberately failing for demo purposes") + E Failed: deliberately failing for demo purposes + + test_backends.py:6: Failed + 1 failed, 1 passed in 0.12 seconds + +The first invocation with ``db == "DB1"`` passed while the second with ``db == "DB2"`` failed. Our ``db`` fixture function has instantiated each of the DB values during the setup phase while the ``pytest_generate_tests`` generated two according calls to the ``test_db_initialized`` during the collection phase. + +.. regendoc:wipe + +Apply indirect on particular arguments +--------------------------------------------------- + +Very often parametrization uses more than one argument name. There is opportunity to apply ``indirect`` +parameter on particular arguments. It can be done by passing list or tuple of +arguments' names to ``indirect``. In the example below there is a function ``test_indirect`` which uses +two fixtures: ``x`` and ``y``. Here we give to indirect the list, which contains the name of the +fixture ``x``. The indirect parameter will be applied to this argument only, and the value ``a`` +will be passed to respective fixture function:: + + # content of test_indirect_list.py + + import pytest + @pytest.fixture(scope='function') + def x(request): + return request.param * 3 + + @pytest.fixture(scope='function') + def y(request): + return request.param * 2 + + @pytest.mark.parametrize('x, y', [('a', 'b')], indirect=['x']) + def test_indirect(x,y): + assert x == 'aaa' + assert y == 'b' + +The result of this test will be successful:: + + $ py.test test_indirect_list.py --collect-only + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 1 items + <Module 'test_indirect_list.py'> + <Function 'test_indirect[a-b]'> + + ======= no tests ran in 0.12 seconds ======== + +.. regendoc:wipe + +Parametrizing test methods through per-class configuration +-------------------------------------------------------------- + +.. _`unittest parametrizer`: https://github.com/testing-cabal/unittest-ext/blob/master/params.py + + +Here is an example ``pytest_generate_function`` function implementing a +parametrization scheme similar to Michael Foord's `unittest +parametrizer`_ but in a lot less code:: + + # content of ./test_parametrize.py + import pytest + + def pytest_generate_tests(metafunc): + # called once per each test function + funcarglist = metafunc.cls.params[metafunc.function.__name__] + argnames = list(funcarglist[0]) + metafunc.parametrize(argnames, [[funcargs[name] for name in argnames] + for funcargs in funcarglist]) + + class TestClass: + # a map specifying multiple argument sets for a test method + params = { + 'test_equals': [dict(a=1, b=2), dict(a=3, b=3), ], + 'test_zerodivision': [dict(a=1, b=0), ], + } + + def test_equals(self, a, b): + assert a == b + + def test_zerodivision(self, a, b): + pytest.raises(ZeroDivisionError, "a/b") + +Our test generator looks up a class-level definition which specifies which +argument sets to use for each test function. Let's run it:: + + $ py.test -q + F.. + ======= FAILURES ======== + _______ TestClass.test_equals[1-2] ________ + + self = <test_parametrize.TestClass object at 0xdeadbeef>, a = 1, b = 2 + + def test_equals(self, a, b): + > assert a == b + E assert 1 == 2 + + test_parametrize.py:18: AssertionError + 1 failed, 2 passed in 0.12 seconds + +Indirect parametrization with multiple fixtures +-------------------------------------------------------------- + +Here is a stripped down real-life example of using parametrized +testing for testing serialization of objects between different python +interpreters. We define a ``test_basic_objects`` function which +is to be run with different sets of arguments for its three arguments: + +* ``python1``: first python interpreter, run to pickle-dump an object to a file +* ``python2``: second interpreter, run to pickle-load an object from a file +* ``obj``: object to be dumped/loaded + +.. literalinclude:: multipython.py + +Running it results in some skips if we don't have all the python interpreters installed and otherwise runs all combinations (5 interpreters times 5 interpreters times 3 objects to serialize/deserialize):: + + . $ py.test -rs -q multipython.py + ssssssssssss...ssssssssssss + ======= short test summary info ======== + SKIP [12] $REGENDOC_TMPDIR/CWD/multipython.py:23: 'python3.3' not found + SKIP [12] $REGENDOC_TMPDIR/CWD/multipython.py:23: 'python2.6' not found + 3 passed, 24 skipped in 0.12 seconds + +Indirect parametrization of optional implementations/imports +-------------------------------------------------------------------- + +If you want to compare the outcomes of several implementations of a given +API, you can write test functions that receive the already imported implementations +and get skipped in case the implementation is not importable/available. Let's +say we have a "base" implementation and the other (possibly optimized ones) +need to provide similar results:: + + # content of conftest.py + + import pytest + + @pytest.fixture(scope="session") + def basemod(request): + return pytest.importorskip("base") + + @pytest.fixture(scope="session", params=["opt1", "opt2"]) + def optmod(request): + return pytest.importorskip(request.param) + +And then a base implementation of a simple function:: + + # content of base.py + def func1(): + return 1 + +And an optimized version:: + + # content of opt1.py + def func1(): + return 1.0001 + +And finally a little test module:: + + # content of test_module.py + + def test_func1(basemod, optmod): + assert round(basemod.func1(), 3) == round(optmod.func1(), 3) + + +If you run this with reporting for skips enabled:: + + $ py.test -rs test_module.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 2 items + + test_module.py .s + ======= short test summary info ======== + SKIP [1] $REGENDOC_TMPDIR/conftest.py:10: could not import 'opt2' + + ======= 1 passed, 1 skipped in 0.12 seconds ======== + +You'll see that we don't have a ``opt2`` module and thus the second test run +of our ``test_func1`` was skipped. A few notes: + +- the fixture functions in the ``conftest.py`` file are "session-scoped" because we + don't need to import more than once + +- if you have multiple test functions and a skipped import, you will see + the ``[1]`` count increasing in the report + +- you can put :ref:`@pytest.mark.parametrize <@pytest.mark.parametrize>` style + parametrization on the test functions to parametrize input/output + values as well. + + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/py2py3/conftest.py b/testing/web-platform/tests/tools/pytest/doc/en/example/py2py3/conftest.py new file mode 100644 index 000000000..81cd1fb11 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/py2py3/conftest.py @@ -0,0 +1,16 @@ +import sys +import pytest + +py3 = sys.version_info[0] >= 3 + +class DummyCollector(pytest.collect.File): + def collect(self): + return [] + +def pytest_pycollect_makemodule(path, parent): + bn = path.basename + if "py3" in bn and not py3 or ("py2" in bn and py3): + return DummyCollector(path, parent=parent) + + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/py2py3/test_py2.py b/testing/web-platform/tests/tools/pytest/doc/en/example/py2py3/test_py2.py new file mode 100644 index 000000000..e09ed9466 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/py2py3/test_py2.py @@ -0,0 +1,7 @@ + +def test_exception_syntax(): + try: + 0/0 + except ZeroDivisionError, e: + pass + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/py2py3/test_py3.py b/testing/web-platform/tests/tools/pytest/doc/en/example/py2py3/test_py3.py new file mode 100644 index 000000000..a811f2bbc --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/py2py3/test_py3.py @@ -0,0 +1,7 @@ + +def test_exception_syntax(): + try: + 0/0 + except ZeroDivisionError as e: + pass + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/pythoncollection.py b/testing/web-platform/tests/tools/pytest/doc/en/example/pythoncollection.py new file mode 100644 index 000000000..05858eb85 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/pythoncollection.py @@ -0,0 +1,11 @@ + +# run this with $ py.test --collect-only test_collectonly.py +# +def test_function(): + pass + +class TestClass: + def test_method(self): + pass + def test_anothermethod(self): + pass diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/pythoncollection.rst b/testing/web-platform/tests/tools/pytest/doc/en/example/pythoncollection.rst new file mode 100644 index 000000000..5faf4c6c8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/pythoncollection.rst @@ -0,0 +1,192 @@ +Changing standard (Python) test discovery +=============================================== + +Ignore paths during test collection +----------------------------------- + +You can easily ignore certain test directories and modules during collection +by passing the ``--ignore=path`` option on the cli. ``pytest`` allows multiple +``--ignore`` options. Example:: + + tests/ + ├── example + │ ├── test_example_01.py + │ ├── test_example_02.py + │ └── test_example_03.py + ├── foobar + │ ├── test_foobar_01.py + │ ├── test_foobar_02.py + │ └── test_foobar_03.py + └── hello + └── world + ├── test_world_01.py + ├── test_world_02.py + └── test_world_03.py + +Now if you invoke ``pytest`` with ``--ignore=tests/foobar/test_foobar_03.py --ignore=tests/hello/``, +you will see that ``pytest`` only collects test-modules, which do not match the patterns specified:: + + ========= test session starts ========== + platform darwin -- Python 2.7.10, pytest-2.8.2, py-1.4.30, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 5 items + + tests/example/test_example_01.py . + tests/example/test_example_02.py . + tests/example/test_example_03.py . + tests/foobar/test_foobar_01.py . + tests/foobar/test_foobar_02.py . + + ======= 5 passed in 0.02 seconds ======= + + +Changing directory recursion +----------------------------------------------------- + +You can set the :confval:`norecursedirs` option in an ini-file, for example your ``setup.cfg`` in the project root directory:: + + # content of setup.cfg + [pytest] + norecursedirs = .svn _build tmp* + +This would tell ``pytest`` to not recurse into typical subversion or sphinx-build directories or into any ``tmp`` prefixed directory. + +.. _`change naming conventions`: + +Changing naming conventions +----------------------------------------------------- + +You can configure different naming conventions by setting +the :confval:`python_files`, :confval:`python_classes` and +:confval:`python_functions` configuration options. Example:: + + # content of setup.cfg + # can also be defined in in tox.ini or pytest.ini file + [pytest] + python_files=check_*.py + python_classes=Check + python_functions=*_check + +This would make ``pytest`` look for tests in files that match the ``check_* +.py`` glob-pattern, ``Check`` prefixes in classes, and functions and methods +that match ``*_check``. For example, if we have:: + + # content of check_myapp.py + class CheckMyApp: + def simple_check(self): + pass + def complex_check(self): + pass + +then the test collection looks like this:: + + $ py.test --collect-only + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: setup.cfg + collected 2 items + <Module 'check_myapp.py'> + <Class 'CheckMyApp'> + <Instance '()'> + <Function 'simple_check'> + <Function 'complex_check'> + + ======= no tests ran in 0.12 seconds ======== + +.. note:: + + the ``python_functions`` and ``python_classes`` options has no effect + for ``unittest.TestCase`` test discovery because pytest delegates + detection of test case methods to unittest code. + +Interpreting cmdline arguments as Python packages +----------------------------------------------------- + +You can use the ``--pyargs`` option to make ``pytest`` try +interpreting arguments as python package names, deriving +their file system path and then running the test. For +example if you have unittest2 installed you can type:: + + py.test --pyargs unittest2.test.test_skipping -q + +which would run the respective test module. Like with +other options, through an ini-file and the :confval:`addopts` option you +can make this change more permanently:: + + # content of pytest.ini + [pytest] + addopts = --pyargs + +Now a simple invocation of ``py.test NAME`` will check +if NAME exists as an importable package/module and otherwise +treat it as a filesystem path. + +Finding out what is collected +----------------------------------------------- + +You can always peek at the collection tree without running tests like this:: + + . $ py.test --collect-only pythoncollection.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini + collected 3 items + <Module 'CWD/pythoncollection.py'> + <Function 'test_function'> + <Class 'TestClass'> + <Instance '()'> + <Function 'test_method'> + <Function 'test_anothermethod'> + + ======= no tests ran in 0.12 seconds ======== + +customizing test collection to find all .py files +--------------------------------------------------------- + +.. regendoc:wipe + +You can easily instruct ``pytest`` to discover tests from every python file:: + + + # content of pytest.ini + [pytest] + python_files = *.py + +However, many projects will have a ``setup.py`` which they don't want to be imported. Moreover, there may files only importable by a specific python version. +For such cases you can dynamically define files to be ignored by listing +them in a ``conftest.py`` file:: + + # content of conftest.py + import sys + + collect_ignore = ["setup.py"] + if sys.version_info[0] > 2: + collect_ignore.append("pkg/module_py2.py") + +And then if you have a module file like this:: + + # content of pkg/module_py2.py + def test_only_on_python2(): + try: + assert 0 + except Exception, e: + pass + +and a setup.py dummy file like this:: + + # content of setup.py + 0/0 # will raise exception if imported + +then a pytest run on python2 will find the one test when run with a python2 +interpreters and will leave out the setup.py file:: + + $ py.test --collect-only + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: pytest.ini + collected 0 items + + ======= no tests ran in 0.12 seconds ======== + +If you run with a Python3 interpreter the moduled added through the conftest.py file will not be considered for test collection. + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/reportingdemo.rst b/testing/web-platform/tests/tools/pytest/doc/en/example/reportingdemo.rst new file mode 100644 index 000000000..28624aa07 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/reportingdemo.rst @@ -0,0 +1,598 @@ + +.. _`tbreportdemo`: + +Demo of Python failure reports with pytest +================================================== + +Here is a nice run of several tens of failures +and how ``pytest`` presents things (unfortunately +not showing the nice colors here in the HTML that you +get on the terminal - we are working on that): + +.. code-block:: python + + assertion $ py.test failure_demo.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR/assertion, inifile: + collected 42 items + + failure_demo.py FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF + + ======= FAILURES ======== + _______ test_generative[0] ________ + + param1 = 3, param2 = 6 + + def test_generative(param1, param2): + > assert param1 * 2 < param2 + E assert (3 * 2) < 6 + + failure_demo.py:16: AssertionError + _______ TestFailing.test_simple ________ + + self = <failure_demo.TestFailing object at 0xdeadbeef> + + def test_simple(self): + def f(): + return 42 + def g(): + return 43 + + > assert f() == g() + E assert 42 == 43 + E + where 42 = <function TestFailing.test_simple.<locals>.f at 0xdeadbeef>() + E + and 43 = <function TestFailing.test_simple.<locals>.g at 0xdeadbeef>() + + failure_demo.py:29: AssertionError + _______ TestFailing.test_simple_multiline ________ + + self = <failure_demo.TestFailing object at 0xdeadbeef> + + def test_simple_multiline(self): + otherfunc_multi( + 42, + > 6*9) + + failure_demo.py:34: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + a = 42, b = 54 + + def otherfunc_multi(a,b): + > assert (a == + b) + E assert 42 == 54 + + failure_demo.py:12: AssertionError + _______ TestFailing.test_not ________ + + self = <failure_demo.TestFailing object at 0xdeadbeef> + + def test_not(self): + def f(): + return 42 + > assert not f() + E assert not 42 + E + where 42 = <function TestFailing.test_not.<locals>.f at 0xdeadbeef>() + + failure_demo.py:39: AssertionError + _______ TestSpecialisedExplanations.test_eq_text ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_text(self): + > assert 'spam' == 'eggs' + E assert 'spam' == 'eggs' + E - spam + E + eggs + + failure_demo.py:43: AssertionError + _______ TestSpecialisedExplanations.test_eq_similar_text ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_similar_text(self): + > assert 'foo 1 bar' == 'foo 2 bar' + E assert 'foo 1 bar' == 'foo 2 bar' + E - foo 1 bar + E ? ^ + E + foo 2 bar + E ? ^ + + failure_demo.py:46: AssertionError + _______ TestSpecialisedExplanations.test_eq_multiline_text ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_multiline_text(self): + > assert 'foo\nspam\nbar' == 'foo\neggs\nbar' + E assert 'foo\nspam\nbar' == 'foo\neggs\nbar' + E foo + E - spam + E + eggs + E bar + + failure_demo.py:49: AssertionError + _______ TestSpecialisedExplanations.test_eq_long_text ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_long_text(self): + a = '1'*100 + 'a' + '2'*100 + b = '1'*100 + 'b' + '2'*100 + > assert a == b + E assert '111111111111...2222222222222' == '1111111111111...2222222222222' + E Skipping 90 identical leading characters in diff, use -v to show + E Skipping 91 identical trailing characters in diff, use -v to show + E - 1111111111a222222222 + E ? ^ + E + 1111111111b222222222 + E ? ^ + + failure_demo.py:54: AssertionError + _______ TestSpecialisedExplanations.test_eq_long_text_multiline ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_long_text_multiline(self): + a = '1\n'*100 + 'a' + '2\n'*100 + b = '1\n'*100 + 'b' + '2\n'*100 + > assert a == b + E assert '1\n1\n1\n1\n...n2\n2\n2\n2\n' == '1\n1\n1\n1\n1...n2\n2\n2\n2\n' + E Skipping 190 identical leading characters in diff, use -v to show + E Skipping 191 identical trailing characters in diff, use -v to show + E 1 + E 1 + E 1 + E 1 + E 1 + E - a2 + E + b2 + E 2 + E 2 + E 2 + E 2 + + failure_demo.py:59: AssertionError + _______ TestSpecialisedExplanations.test_eq_list ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_list(self): + > assert [0, 1, 2] == [0, 1, 3] + E assert [0, 1, 2] == [0, 1, 3] + E At index 2 diff: 2 != 3 + E Use -v to get the full diff + + failure_demo.py:62: AssertionError + _______ TestSpecialisedExplanations.test_eq_list_long ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_list_long(self): + a = [0]*100 + [1] + [3]*100 + b = [0]*100 + [2] + [3]*100 + > assert a == b + E assert [0, 0, 0, 0, 0, 0, ...] == [0, 0, 0, 0, 0, 0, ...] + E At index 100 diff: 1 != 2 + E Use -v to get the full diff + + failure_demo.py:67: AssertionError + _______ TestSpecialisedExplanations.test_eq_dict ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_dict(self): + > assert {'a': 0, 'b': 1, 'c': 0} == {'a': 0, 'b': 2, 'd': 0} + E assert {'a': 0, 'b': 1, 'c': 0} == {'a': 0, 'b': 2, 'd': 0} + E Omitting 1 identical items, use -v to show + E Differing items: + E {'b': 1} != {'b': 2} + E Left contains more items: + E {'c': 0} + E Right contains more items: + E {'d': 0} + E Use -v to get the full diff + + failure_demo.py:70: AssertionError + _______ TestSpecialisedExplanations.test_eq_set ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_set(self): + > assert set([0, 10, 11, 12]) == set([0, 20, 21]) + E assert set([0, 10, 11, 12]) == set([0, 20, 21]) + E Extra items in the left set: + E 10 + E 11 + E 12 + E Extra items in the right set: + E 20 + E 21 + E Use -v to get the full diff + + failure_demo.py:73: AssertionError + _______ TestSpecialisedExplanations.test_eq_longer_list ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_eq_longer_list(self): + > assert [1,2] == [1,2,3] + E assert [1, 2] == [1, 2, 3] + E Right contains more items, first extra item: 3 + E Use -v to get the full diff + + failure_demo.py:76: AssertionError + _______ TestSpecialisedExplanations.test_in_list ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_in_list(self): + > assert 1 in [0, 2, 3, 4, 5] + E assert 1 in [0, 2, 3, 4, 5] + + failure_demo.py:79: AssertionError + _______ TestSpecialisedExplanations.test_not_in_text_multiline ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_not_in_text_multiline(self): + text = 'some multiline\ntext\nwhich\nincludes foo\nand a\ntail' + > assert 'foo' not in text + E assert 'foo' not in 'some multiline\ntext\nw...ncludes foo\nand a\ntail' + E 'foo' is contained here: + E some multiline + E text + E which + E includes foo + E ? +++ + E and a + E tail + + failure_demo.py:83: AssertionError + _______ TestSpecialisedExplanations.test_not_in_text_single ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_not_in_text_single(self): + text = 'single foo line' + > assert 'foo' not in text + E assert 'foo' not in 'single foo line' + E 'foo' is contained here: + E single foo line + E ? +++ + + failure_demo.py:87: AssertionError + _______ TestSpecialisedExplanations.test_not_in_text_single_long ________ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_not_in_text_single_long(self): + text = 'head ' * 50 + 'foo ' + 'tail ' * 20 + > assert 'foo' not in text + E assert 'foo' not in 'head head head head hea...ail tail tail tail tail ' + E 'foo' is contained here: + E head head foo tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail + E ? +++ + + failure_demo.py:91: AssertionError + ______ TestSpecialisedExplanations.test_not_in_text_single_long_term _______ + + self = <failure_demo.TestSpecialisedExplanations object at 0xdeadbeef> + + def test_not_in_text_single_long_term(self): + text = 'head ' * 50 + 'f'*70 + 'tail ' * 20 + > assert 'f'*70 not in text + E assert 'fffffffffff...ffffffffffff' not in 'head head he...l tail tail ' + E 'ffffffffffffffffff...fffffffffffffffffff' is contained here: + E head head fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffftail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail tail + E ? ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + + failure_demo.py:95: AssertionError + _______ test_attribute ________ + + def test_attribute(): + class Foo(object): + b = 1 + i = Foo() + > assert i.b == 2 + E assert 1 == 2 + E + where 1 = <failure_demo.test_attribute.<locals>.Foo object at 0xdeadbeef>.b + + failure_demo.py:102: AssertionError + _______ test_attribute_instance ________ + + def test_attribute_instance(): + class Foo(object): + b = 1 + > assert Foo().b == 2 + E assert 1 == 2 + E + where 1 = <failure_demo.test_attribute_instance.<locals>.Foo object at 0xdeadbeef>.b + E + where <failure_demo.test_attribute_instance.<locals>.Foo object at 0xdeadbeef> = <class 'failure_demo.test_attribute_instance.<locals>.Foo'>() + + failure_demo.py:108: AssertionError + _______ test_attribute_failure ________ + + def test_attribute_failure(): + class Foo(object): + def _get_b(self): + raise Exception('Failed to get attrib') + b = property(_get_b) + i = Foo() + > assert i.b == 2 + + failure_demo.py:117: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + self = <failure_demo.test_attribute_failure.<locals>.Foo object at 0xdeadbeef> + + def _get_b(self): + > raise Exception('Failed to get attrib') + E Exception: Failed to get attrib + + failure_demo.py:114: Exception + _______ test_attribute_multiple ________ + + def test_attribute_multiple(): + class Foo(object): + b = 1 + class Bar(object): + b = 2 + > assert Foo().b == Bar().b + E assert 1 == 2 + E + where 1 = <failure_demo.test_attribute_multiple.<locals>.Foo object at 0xdeadbeef>.b + E + where <failure_demo.test_attribute_multiple.<locals>.Foo object at 0xdeadbeef> = <class 'failure_demo.test_attribute_multiple.<locals>.Foo'>() + E + and 2 = <failure_demo.test_attribute_multiple.<locals>.Bar object at 0xdeadbeef>.b + E + where <failure_demo.test_attribute_multiple.<locals>.Bar object at 0xdeadbeef> = <class 'failure_demo.test_attribute_multiple.<locals>.Bar'>() + + failure_demo.py:125: AssertionError + _______ TestRaises.test_raises ________ + + self = <failure_demo.TestRaises object at 0xdeadbeef> + + def test_raises(self): + s = 'qwe' + > raises(TypeError, "int(s)") + + failure_demo.py:134: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + > int(s) + E ValueError: invalid literal for int() with base 10: 'qwe' + + <0-codegen $PYTHON_PREFIX/lib/python3.4/site-packages/_pytest/python.py:1302>:1: ValueError + _______ TestRaises.test_raises_doesnt ________ + + self = <failure_demo.TestRaises object at 0xdeadbeef> + + def test_raises_doesnt(self): + > raises(IOError, "int('3')") + E Failed: DID NOT RAISE <class 'OSError'> + + failure_demo.py:137: Failed + _______ TestRaises.test_raise ________ + + self = <failure_demo.TestRaises object at 0xdeadbeef> + + def test_raise(self): + > raise ValueError("demo error") + E ValueError: demo error + + failure_demo.py:140: ValueError + _______ TestRaises.test_tupleerror ________ + + self = <failure_demo.TestRaises object at 0xdeadbeef> + + def test_tupleerror(self): + > a,b = [1] + E ValueError: need more than 1 value to unpack + + failure_demo.py:143: ValueError + ______ TestRaises.test_reinterpret_fails_with_print_for_the_fun_of_it ______ + + self = <failure_demo.TestRaises object at 0xdeadbeef> + + def test_reinterpret_fails_with_print_for_the_fun_of_it(self): + l = [1,2,3] + print ("l is %r" % l) + > a,b = l.pop() + E TypeError: 'int' object is not iterable + + failure_demo.py:148: TypeError + --------------------------- Captured stdout call --------------------------- + l is [1, 2, 3] + _______ TestRaises.test_some_error ________ + + self = <failure_demo.TestRaises object at 0xdeadbeef> + + def test_some_error(self): + > if namenotexi: + E NameError: name 'namenotexi' is not defined + + failure_demo.py:151: NameError + _______ test_dynamic_compile_shows_nicely ________ + + def test_dynamic_compile_shows_nicely(): + src = 'def foo():\n assert 1 == 0\n' + name = 'abc-123' + module = py.std.imp.new_module(name) + code = _pytest._code.compile(src, name, 'exec') + py.builtin.exec_(code, module.__dict__) + py.std.sys.modules[name] = module + > module.foo() + + failure_demo.py:166: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + def foo(): + > assert 1 == 0 + E assert 1 == 0 + + <2-codegen 'abc-123' $REGENDOC_TMPDIR/assertion/failure_demo.py:163>:2: AssertionError + _______ TestMoreErrors.test_complex_error ________ + + self = <failure_demo.TestMoreErrors object at 0xdeadbeef> + + def test_complex_error(self): + def f(): + return 44 + def g(): + return 43 + > somefunc(f(), g()) + + failure_demo.py:176: + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + failure_demo.py:9: in somefunc + otherfunc(x,y) + _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ + + a = 44, b = 43 + + def otherfunc(a,b): + > assert a==b + E assert 44 == 43 + + failure_demo.py:6: AssertionError + _______ TestMoreErrors.test_z1_unpack_error ________ + + self = <failure_demo.TestMoreErrors object at 0xdeadbeef> + + def test_z1_unpack_error(self): + l = [] + > a,b = l + E ValueError: need more than 0 values to unpack + + failure_demo.py:180: ValueError + _______ TestMoreErrors.test_z2_type_error ________ + + self = <failure_demo.TestMoreErrors object at 0xdeadbeef> + + def test_z2_type_error(self): + l = 3 + > a,b = l + E TypeError: 'int' object is not iterable + + failure_demo.py:184: TypeError + _______ TestMoreErrors.test_startswith ________ + + self = <failure_demo.TestMoreErrors object at 0xdeadbeef> + + def test_startswith(self): + s = "123" + g = "456" + > assert s.startswith(g) + E assert <built-in method startswith of str object at 0xdeadbeef>('456') + E + where <built-in method startswith of str object at 0xdeadbeef> = '123'.startswith + + failure_demo.py:189: AssertionError + _______ TestMoreErrors.test_startswith_nested ________ + + self = <failure_demo.TestMoreErrors object at 0xdeadbeef> + + def test_startswith_nested(self): + def f(): + return "123" + def g(): + return "456" + > assert f().startswith(g()) + E assert <built-in method startswith of str object at 0xdeadbeef>('456') + E + where <built-in method startswith of str object at 0xdeadbeef> = '123'.startswith + E + where '123' = <function TestMoreErrors.test_startswith_nested.<locals>.f at 0xdeadbeef>() + E + and '456' = <function TestMoreErrors.test_startswith_nested.<locals>.g at 0xdeadbeef>() + + failure_demo.py:196: AssertionError + _______ TestMoreErrors.test_global_func ________ + + self = <failure_demo.TestMoreErrors object at 0xdeadbeef> + + def test_global_func(self): + > assert isinstance(globf(42), float) + E assert isinstance(43, float) + E + where 43 = globf(42) + + failure_demo.py:199: AssertionError + _______ TestMoreErrors.test_instance ________ + + self = <failure_demo.TestMoreErrors object at 0xdeadbeef> + + def test_instance(self): + self.x = 6*7 + > assert self.x != 42 + E assert 42 != 42 + E + where 42 = <failure_demo.TestMoreErrors object at 0xdeadbeef>.x + + failure_demo.py:203: AssertionError + _______ TestMoreErrors.test_compare ________ + + self = <failure_demo.TestMoreErrors object at 0xdeadbeef> + + def test_compare(self): + > assert globf(10) < 5 + E assert 11 < 5 + E + where 11 = globf(10) + + failure_demo.py:206: AssertionError + _______ TestMoreErrors.test_try_finally ________ + + self = <failure_demo.TestMoreErrors object at 0xdeadbeef> + + def test_try_finally(self): + x = 1 + try: + > assert x == 0 + E assert 1 == 0 + + failure_demo.py:211: AssertionError + _______ TestCustomAssertMsg.test_single_line ________ + + self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef> + + def test_single_line(self): + class A: + a = 1 + b = 2 + > assert A.a == b, "A.a appears not to be b" + E AssertionError: A.a appears not to be b + E assert 1 == 2 + E + where 1 = <class 'failure_demo.TestCustomAssertMsg.test_single_line.<locals>.A'>.a + + failure_demo.py:222: AssertionError + _______ TestCustomAssertMsg.test_multiline ________ + + self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef> + + def test_multiline(self): + class A: + a = 1 + b = 2 + > assert A.a == b, "A.a appears not to be b\n" \ + "or does not appear to be b\none of those" + E AssertionError: A.a appears not to be b + E or does not appear to be b + E one of those + E assert 1 == 2 + E + where 1 = <class 'failure_demo.TestCustomAssertMsg.test_multiline.<locals>.A'>.a + + failure_demo.py:228: AssertionError + _______ TestCustomAssertMsg.test_custom_repr ________ + + self = <failure_demo.TestCustomAssertMsg object at 0xdeadbeef> + + def test_custom_repr(self): + class JSON: + a = 1 + def __repr__(self): + return "This is JSON\n{\n 'foo': 'bar'\n}" + a = JSON() + b = 2 + > assert a.a == b, a + E AssertionError: This is JSON + E { + E 'foo': 'bar' + E } + E assert 1 == 2 + E + where 1 = This is JSON\n{\n 'foo': 'bar'\n}.a + + failure_demo.py:238: AssertionError + ======= 42 failed in 0.12 seconds ======== diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/simple.rst b/testing/web-platform/tests/tools/pytest/doc/en/example/simple.rst new file mode 100644 index 000000000..be12d2afe --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/simple.rst @@ -0,0 +1,751 @@ + +.. highlightlang:: python + +Basic patterns and examples +========================================================== + +Pass different values to a test function, depending on command line options +---------------------------------------------------------------------------- + +.. regendoc:wipe + +Suppose we want to write a test that depends on a command line option. +Here is a basic pattern to achieve this:: + + # content of test_sample.py + def test_answer(cmdopt): + if cmdopt == "type1": + print ("first") + elif cmdopt == "type2": + print ("second") + assert 0 # to see what was printed + + +For this to work we need to add a command line option and +provide the ``cmdopt`` through a :ref:`fixture function <fixture function>`:: + + # content of conftest.py + import pytest + + def pytest_addoption(parser): + parser.addoption("--cmdopt", action="store", default="type1", + help="my option: type1 or type2") + + @pytest.fixture + def cmdopt(request): + return request.config.getoption("--cmdopt") + +Let's run this without supplying our new option:: + + $ py.test -q test_sample.py + F + ======= FAILURES ======== + _______ test_answer ________ + + cmdopt = 'type1' + + def test_answer(cmdopt): + if cmdopt == "type1": + print ("first") + elif cmdopt == "type2": + print ("second") + > assert 0 # to see what was printed + E assert 0 + + test_sample.py:6: AssertionError + --------------------------- Captured stdout call --------------------------- + first + 1 failed in 0.12 seconds + +And now with supplying a command line option:: + + $ py.test -q --cmdopt=type2 + F + ======= FAILURES ======== + _______ test_answer ________ + + cmdopt = 'type2' + + def test_answer(cmdopt): + if cmdopt == "type1": + print ("first") + elif cmdopt == "type2": + print ("second") + > assert 0 # to see what was printed + E assert 0 + + test_sample.py:6: AssertionError + --------------------------- Captured stdout call --------------------------- + second + 1 failed in 0.12 seconds + +You can see that the command line option arrived in our test. This +completes the basic pattern. However, one often rather wants to process +command line options outside of the test and rather pass in different or +more complex objects. + +Dynamically adding command line options +-------------------------------------------------------------- + +.. regendoc:wipe + +Through :confval:`addopts` you can statically add command line +options for your project. You can also dynamically modify +the command line arguments before they get processed:: + + # content of conftest.py + import sys + def pytest_cmdline_preparse(args): + if 'xdist' in sys.modules: # pytest-xdist plugin + import multiprocessing + num = max(multiprocessing.cpu_count() / 2, 1) + args[:] = ["-n", str(num)] + args + +If you have the :ref:`xdist plugin <xdist>` installed +you will now always perform test runs using a number +of subprocesses close to your CPU. Running in an empty +directory with the above conftest.py:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 0 items + + ======= no tests ran in 0.12 seconds ======== + +.. _`excontrolskip`: + +Control skipping of tests according to command line option +-------------------------------------------------------------- + +.. regendoc:wipe + +Here is a ``conftest.py`` file adding a ``--runslow`` command +line option to control skipping of ``slow`` marked tests:: + + # content of conftest.py + + import pytest + def pytest_addoption(parser): + parser.addoption("--runslow", action="store_true", + help="run slow tests") + +We can now write a test module like this:: + + # content of test_module.py + + import pytest + + + slow = pytest.mark.skipif( + not pytest.config.getoption("--runslow"), + reason="need --runslow option to run" + ) + + + def test_func_fast(): + pass + + + @slow + def test_func_slow(): + pass + +and when running it will see a skipped "slow" test:: + + $ py.test -rs # "-rs" means report details on the little 's' + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 2 items + + test_module.py .s + ======= short test summary info ======== + SKIP [1] test_module.py:14: need --runslow option to run + + ======= 1 passed, 1 skipped in 0.12 seconds ======== + +Or run it including the ``slow`` marked test:: + + $ py.test --runslow + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 2 items + + test_module.py .. + + ======= 2 passed in 0.12 seconds ======== + +Writing well integrated assertion helpers +-------------------------------------------------- + +.. regendoc:wipe + +If you have a test helper function called from a test you can +use the ``pytest.fail`` marker to fail a test with a certain message. +The test support function will not show up in the traceback if you +set the ``__tracebackhide__`` option somewhere in the helper function. +Example:: + + # content of test_checkconfig.py + import pytest + def checkconfig(x): + __tracebackhide__ = True + if not hasattr(x, "config"): + pytest.fail("not configured: %s" %(x,)) + + def test_something(): + checkconfig(42) + +The ``__tracebackhide__`` setting influences ``pytest`` showing +of tracebacks: the ``checkconfig`` function will not be shown +unless the ``--fulltrace`` command line option is specified. +Let's run our little function:: + + $ py.test -q test_checkconfig.py + F + ======= FAILURES ======== + _______ test_something ________ + + def test_something(): + > checkconfig(42) + E Failed: not configured: 42 + + test_checkconfig.py:8: Failed + 1 failed in 0.12 seconds + +Detect if running from within a pytest run +-------------------------------------------------------------- + +.. regendoc:wipe + +Usually it is a bad idea to make application code +behave differently if called from a test. But if you +absolutely must find out if your application code is +running from a test you can do something like this:: + + # content of conftest.py + + def pytest_configure(config): + import sys + sys._called_from_test = True + + def pytest_unconfigure(config): + del sys._called_from_test + +and then check for the ``sys._called_from_test`` flag:: + + if hasattr(sys, '_called_from_test'): + # called from within a test run + else: + # called "normally" + +accordingly in your application. It's also a good idea +to use your own application module rather than ``sys`` +for handling flag. + +Adding info to test report header +-------------------------------------------------------------- + +.. regendoc:wipe + +It's easy to present extra information in a ``pytest`` run:: + + # content of conftest.py + + def pytest_report_header(config): + return "project deps: mylib-1.1" + +which will add the string to the test header accordingly:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + project deps: mylib-1.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 0 items + + ======= no tests ran in 0.12 seconds ======== + +.. regendoc:wipe + +You can also return a list of strings which will be considered as several +lines of information. You can of course also make the amount of reporting +information on e.g. the value of ``config.option.verbose`` so that +you present more information appropriately:: + + # content of conftest.py + + def pytest_report_header(config): + if config.option.verbose > 0: + return ["info1: did you know that ...", "did you?"] + +which will add info only when run with "--v":: + + $ py.test -v + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + info1: did you know that ... + did you? + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 0 items + + ======= no tests ran in 0.12 seconds ======== + +and nothing when run plainly:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 0 items + + ======= no tests ran in 0.12 seconds ======== + +profiling test duration +-------------------------- + +.. regendoc:wipe + +.. versionadded: 2.2 + +If you have a slow running large test suite you might want to find +out which tests are the slowest. Let's make an artificial test suite:: + + # content of test_some_are_slow.py + + import time + + def test_funcfast(): + pass + + def test_funcslow1(): + time.sleep(0.1) + + def test_funcslow2(): + time.sleep(0.2) + +Now we can profile which test functions execute the slowest:: + + $ py.test --durations=3 + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 3 items + + test_some_are_slow.py ... + + ======= slowest 3 test durations ======== + 0.20s call test_some_are_slow.py::test_funcslow2 + 0.10s call test_some_are_slow.py::test_funcslow1 + 0.00s setup test_some_are_slow.py::test_funcfast + ======= 3 passed in 0.12 seconds ======== + +incremental testing - test steps +--------------------------------------------------- + +.. regendoc:wipe + +Sometimes you may have a testing situation which consists of a series +of test steps. If one step fails it makes no sense to execute further +steps as they are all expected to fail anyway and their tracebacks +add no insight. Here is a simple ``conftest.py`` file which introduces +an ``incremental`` marker which is to be used on classes:: + + # content of conftest.py + + import pytest + + def pytest_runtest_makereport(item, call): + if "incremental" in item.keywords: + if call.excinfo is not None: + parent = item.parent + parent._previousfailed = item + + def pytest_runtest_setup(item): + if "incremental" in item.keywords: + previousfailed = getattr(item.parent, "_previousfailed", None) + if previousfailed is not None: + pytest.xfail("previous test failed (%s)" %previousfailed.name) + +These two hook implementations work together to abort incremental-marked +tests in a class. Here is a test module example:: + + # content of test_step.py + + import pytest + + @pytest.mark.incremental + class TestUserHandling: + def test_login(self): + pass + def test_modification(self): + assert 0 + def test_deletion(self): + pass + + def test_normal(): + pass + +If we run this:: + + $ py.test -rx + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 4 items + + test_step.py .Fx. + ======= short test summary info ======== + XFAIL test_step.py::TestUserHandling::()::test_deletion + reason: previous test failed (test_modification) + + ======= FAILURES ======== + _______ TestUserHandling.test_modification ________ + + self = <test_step.TestUserHandling object at 0xdeadbeef> + + def test_modification(self): + > assert 0 + E assert 0 + + test_step.py:9: AssertionError + ======= 1 failed, 2 passed, 1 xfailed in 0.12 seconds ======== + +We'll see that ``test_deletion`` was not executed because ``test_modification`` +failed. It is reported as an "expected failure". + + +Package/Directory-level fixtures (setups) +------------------------------------------------------- + +If you have nested test directories, you can have per-directory fixture scopes +by placing fixture functions in a ``conftest.py`` file in that directory +You can use all types of fixtures including :ref:`autouse fixtures +<autouse fixtures>` which are the equivalent of xUnit's setup/teardown +concept. It's however recommended to have explicit fixture references in your +tests or test classes rather than relying on implicitly executing +setup/teardown functions, especially if they are far away from the actual tests. + +Here is a an example for making a ``db`` fixture available in a directory:: + + # content of a/conftest.py + import pytest + + class DB: + pass + + @pytest.fixture(scope="session") + def db(): + return DB() + +and then a test module in that directory:: + + # content of a/test_db.py + def test_a1(db): + assert 0, db # to show value + +another test module:: + + # content of a/test_db2.py + def test_a2(db): + assert 0, db # to show value + +and then a module in a sister directory which will not see +the ``db`` fixture:: + + # content of b/test_error.py + def test_root(db): # no db here, will error out + pass + +We can run this:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 7 items + + test_step.py .Fx. + a/test_db.py F + a/test_db2.py F + b/test_error.py E + + ======= ERRORS ======== + _______ ERROR at setup of test_root ________ + file $REGENDOC_TMPDIR/b/test_error.py, line 1 + def test_root(db): # no db here, will error out + fixture 'db' not found + available fixtures: record_xml_property, recwarn, cache, capsys, pytestconfig, tmpdir_factory, capfd, monkeypatch, tmpdir + use 'py.test --fixtures [testpath]' for help on them. + + $REGENDOC_TMPDIR/b/test_error.py:1 + ======= FAILURES ======== + _______ TestUserHandling.test_modification ________ + + self = <test_step.TestUserHandling object at 0xdeadbeef> + + def test_modification(self): + > assert 0 + E assert 0 + + test_step.py:9: AssertionError + _______ test_a1 ________ + + db = <conftest.DB object at 0xdeadbeef> + + def test_a1(db): + > assert 0, db # to show value + E AssertionError: <conftest.DB object at 0xdeadbeef> + E assert 0 + + a/test_db.py:2: AssertionError + _______ test_a2 ________ + + db = <conftest.DB object at 0xdeadbeef> + + def test_a2(db): + > assert 0, db # to show value + E AssertionError: <conftest.DB object at 0xdeadbeef> + E assert 0 + + a/test_db2.py:2: AssertionError + ======= 3 failed, 2 passed, 1 xfailed, 1 error in 0.12 seconds ======== + +The two test modules in the ``a`` directory see the same ``db`` fixture instance +while the one test in the sister-directory ``b`` doesn't see it. We could of course +also define a ``db`` fixture in that sister directory's ``conftest.py`` file. +Note that each fixture is only instantiated if there is a test actually needing +it (unless you use "autouse" fixture which are always executed ahead of the first test +executing). + + +post-process test reports / failures +--------------------------------------- + +If you want to postprocess test reports and need access to the executing +environment you can implement a hook that gets called when the test +"report" object is about to be created. Here we write out all failing +test calls and also access a fixture (if it was used by the test) in +case you want to query/look at it during your post processing. In our +case we just write some informations out to a ``failures`` file:: + + # content of conftest.py + + import pytest + import os.path + + @pytest.hookimpl(tryfirst=True, hookwrapper=True) + def pytest_runtest_makereport(item, call): + # execute all other hooks to obtain the report object + outcome = yield + rep = outcome.get_result() + + # we only look at actual failing test calls, not setup/teardown + if rep.when == "call" and rep.failed: + mode = "a" if os.path.exists("failures") else "w" + with open("failures", mode) as f: + # let's also access a fixture for the fun of it + if "tmpdir" in item.fixturenames: + extra = " (%s)" % item.funcargs["tmpdir"] + else: + extra = "" + + f.write(rep.nodeid + extra + "\n") + + +if you then have failing tests:: + + # content of test_module.py + def test_fail1(tmpdir): + assert 0 + def test_fail2(): + assert 0 + +and run them:: + + $ py.test test_module.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 2 items + + test_module.py FF + + ======= FAILURES ======== + _______ test_fail1 ________ + + tmpdir = local('PYTEST_TMPDIR/test_fail10') + + def test_fail1(tmpdir): + > assert 0 + E assert 0 + + test_module.py:2: AssertionError + _______ test_fail2 ________ + + def test_fail2(): + > assert 0 + E assert 0 + + test_module.py:4: AssertionError + ======= 2 failed in 0.12 seconds ======== + +you will have a "failures" file which contains the failing test ids:: + + $ cat failures + test_module.py::test_fail1 (PYTEST_TMPDIR/test_fail10) + test_module.py::test_fail2 + +Making test result information available in fixtures +----------------------------------------------------------- + +.. regendoc:wipe + +If you want to make test result reports available in fixture finalizers +here is a little example implemented via a local plugin:: + + # content of conftest.py + + import pytest + + @pytest.hookimpl(tryfirst=True, hookwrapper=True) + def pytest_runtest_makereport(item, call): + # execute all other hooks to obtain the report object + outcome = yield + rep = outcome.get_result() + + # set an report attribute for each phase of a call, which can + # be "setup", "call", "teardown" + + setattr(item, "rep_" + rep.when, rep) + + + @pytest.fixture + def something(request): + def fin(): + # request.node is an "item" because we use the default + # "function" scope + if request.node.rep_setup.failed: + print ("setting up a test failed!", request.node.nodeid) + elif request.node.rep_setup.passed: + if request.node.rep_call.failed: + print ("executing test failed", request.node.nodeid) + request.addfinalizer(fin) + + +if you then have failing tests:: + + # content of test_module.py + + import pytest + + @pytest.fixture + def other(): + assert 0 + + def test_setup_fails(something, other): + pass + + def test_call_fails(something): + assert 0 + + def test_fail2(): + assert 0 + +and run it:: + + $ py.test -s test_module.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 3 items + + test_module.py Esetting up a test failed! test_module.py::test_setup_fails + Fexecuting test failed test_module.py::test_call_fails + F + + ======= ERRORS ======== + _______ ERROR at setup of test_setup_fails ________ + + @pytest.fixture + def other(): + > assert 0 + E assert 0 + + test_module.py:6: AssertionError + ======= FAILURES ======== + _______ test_call_fails ________ + + something = None + + def test_call_fails(something): + > assert 0 + E assert 0 + + test_module.py:12: AssertionError + _______ test_fail2 ________ + + def test_fail2(): + > assert 0 + E assert 0 + + test_module.py:15: AssertionError + ======= 2 failed, 1 error in 0.12 seconds ======== + +You'll see that the fixture finalizers could use the precise reporting +information. + +Integrating pytest runner and cx_freeze +----------------------------------------------------------- + +If you freeze your application using a tool like +`cx_freeze <http://cx-freeze.readthedocs.org>`_ in order to distribute it +to your end-users, it is a good idea to also package your test runner and run +your tests using the frozen application. + +This way packaging errors such as dependencies not being +included into the executable can be detected early while also allowing you to +send test files to users so they can run them in their machines, which can be +invaluable to obtain more information about a hard to reproduce bug. + +Unfortunately ``cx_freeze`` can't discover them +automatically because of ``pytest``'s use of dynamic module loading, so you +must declare them explicitly by using ``pytest.freeze_includes()``:: + + # contents of setup.py + from cx_Freeze import setup, Executable + import pytest + + setup( + name="app_main", + executables=[Executable("app_main.py")], + options={"build_exe": + { + 'includes': pytest.freeze_includes()} + }, + # ... other options + ) + +If you don't want to ship a different executable just in order to run your tests, +you can make your program check for a certain flag and pass control +over to ``pytest`` instead. For example:: + + # contents of app_main.py + import sys + + if len(sys.argv) > 1 and sys.argv[1] == '--pytest': + import pytest + sys.exit(pytest.main(sys.argv[2:])) + else: + # normal application execution: at this point argv can be parsed + # by your argument-parsing library of choice as usual + ... + +This makes it convenient to execute your tests from within your frozen +application, using standard ``py.test`` command-line options:: + + ./app_main --pytest --verbose --tb=long --junitxml=results.xml test-suite/ diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/special.rst b/testing/web-platform/tests/tools/pytest/doc/en/example/special.rst new file mode 100644 index 000000000..58e66d44e --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/special.rst @@ -0,0 +1,72 @@ +A session-fixture which can look at all collected tests +---------------------------------------------------------------- + +A session-scoped fixture effectively has access to all +collected test items. Here is an example of a fixture +function which walks all collected tests and looks +if their test class defines a ``callme`` method and +calls it:: + + # content of conftest.py + + import pytest + + @pytest.fixture(scope="session", autouse=True) + def callattr_ahead_of_alltests(request): + print ("callattr_ahead_of_alltests called") + seen = set([None]) + session = request.node + for item in session.items: + cls = item.getparent(pytest.Class) + if cls not in seen: + if hasattr(cls.obj, "callme"): + cls.obj.callme() + seen.add(cls) + +test classes may now define a ``callme`` method which +will be called ahead of running any tests:: + + # content of test_module.py + + class TestHello: + @classmethod + def callme(cls): + print ("callme called!") + + def test_method1(self): + print ("test_method1 called") + + def test_method2(self): + print ("test_method1 called") + + class TestOther: + @classmethod + def callme(cls): + print ("callme other called") + def test_other(self): + print ("test other") + + # works with unittest as well ... + import unittest + + class SomeTest(unittest.TestCase): + @classmethod + def callme(self): + print ("SomeTest callme called") + + def test_unit1(self): + print ("test_unit1 method called") + +If you run this without output capturing:: + + $ py.test -q -s test_module.py + callattr_ahead_of_alltests called + callme called! + callme other called + SomeTest callme called + test_method1 called + .test_method1 called + .test other + .test_unit1 method called + . + 4 passed in 0.12 seconds diff --git a/testing/web-platform/tests/tools/pytest/doc/en/example/xfail_demo.py b/testing/web-platform/tests/tools/pytest/doc/en/example/xfail_demo.py new file mode 100644 index 000000000..5648575e8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/example/xfail_demo.py @@ -0,0 +1,30 @@ +import pytest +xfail = pytest.mark.xfail + +@xfail +def test_hello(): + assert 0 + +@xfail(run=False) +def test_hello2(): + assert 0 + +@xfail("hasattr(os, 'sep')") +def test_hello3(): + assert 0 + +@xfail(reason="bug 110") +def test_hello4(): + assert 0 + +@xfail('pytest.__version__[0] != "17"') +def test_hello5(): + assert 0 + +def test_hello6(): + pytest.xfail("reason") + +@xfail(raises=IndexError) +def test_hello7(): + x = [] + x[1] = 1 diff --git a/testing/web-platform/tests/tools/pytest/doc/en/faq.rst b/testing/web-platform/tests/tools/pytest/doc/en/faq.rst new file mode 100644 index 000000000..fd7ca35e9 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/faq.rst @@ -0,0 +1,165 @@ +Some Issues and Questions +================================== + +.. note:: + + This FAQ is here only mostly for historic reasons. Checkout + `pytest Q&A at Stackoverflow <http://stackoverflow.com/search?q=pytest>`_ + for many questions and answers related to pytest and/or use + :ref:`contact channels` to get help. + +On naming, nosetests, licensing and magic +------------------------------------------------ + +How does pytest relate to nose and unittest? ++++++++++++++++++++++++++++++++++++++++++++++++++ + +``pytest`` and nose_ share basic philosophy when it comes +to running and writing Python tests. In fact, you can run many tests +written for nose with ``pytest``. nose_ was originally created +as a clone of ``pytest`` when ``pytest`` was in the ``0.8`` release +cycle. Note that starting with pytest-2.0 support for running unittest +test suites is majorly improved. + +how does pytest relate to twisted's trial? +++++++++++++++++++++++++++++++++++++++++++++++ + +Since some time ``pytest`` has builtin support for supporting tests +written using trial. It does not itself start a reactor, however, +and does not handle Deferreds returned from a test in pytest style. +If you are using trial's unittest.TestCase chances are that you can +just run your tests even if you return Deferreds. In addition, +there also is a dedicated `pytest-twisted +<http://pypi.python.org/pypi/pytest-twisted>`_ plugin which allows you to +return deferreds from pytest-style tests, allowing the use of +:ref:`fixtures` and other features. + +how does pytest work with Django? +++++++++++++++++++++++++++++++++++++++++++++++ + +In 2012, some work is going into the `pytest-django plugin <http://pypi.python.org/pypi/pytest-django>`_. It substitutes the usage of Django's +``manage.py test`` and allows the use of all pytest features_ most of which +are not available from Django directly. + +.. _features: features.html + + +What's this "magic" with pytest? (historic notes) +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Around 2007 (version ``0.8``) some people thought that ``pytest`` +was using too much "magic". It had been part of the `pylib`_ which +contains a lot of unrelated python library code. Around 2010 there +was a major cleanup refactoring, which removed unused or deprecated code +and resulted in the new ``pytest`` PyPI package which strictly contains +only test-related code. This release also brought a complete pluginification +such that the core is around 300 lines of code and everything else is +implemented in plugins. Thus ``pytest`` today is a small, universally runnable +and customizable testing framework for Python. Note, however, that +``pytest`` uses metaprogramming techniques and reading its source is +thus likely not something for Python beginners. + +A second "magic" issue was the assert statement debugging feature. +Nowadays, ``pytest`` explicitly rewrites assert statements in test modules +in order to provide more useful :ref:`assert feedback <assertfeedback>`. +This completely avoids previous issues of confusing assertion-reporting. +It also means, that you can use Python's ``-O`` optimization without losing +assertions in test modules. + +``pytest`` contains a second, mostly obsolete, assert debugging technique +invoked via ``--assert=reinterpret``: When an ``assert`` statement fails, ``pytest`` re-interprets +the expression part to show intermediate values. This technique suffers +from a caveat that the rewriting does not: If your expression has side +effects (better to avoid them anyway!) the intermediate values may not +be the same, confusing the reinterpreter and obfuscating the initial +error (this is also explained at the command line if it happens). + +You can also turn off all assertion interaction using the +``--assert=plain`` option. + +.. _`py namespaces`: index.html +.. _`py/__init__.py`: http://bitbucket.org/hpk42/py-trunk/src/trunk/py/__init__.py + + +Why a ``py.test`` instead of a ``pytest`` command? +++++++++++++++++++++++++++++++++++++++++++++++++++ + +Some of the reasons are historic, others are practical. ``pytest`` +used to be part of the ``py`` package which provided several developer +utilities, all starting with ``py.<TAB>``, thus providing nice +TAB-completion. If +you install ``pip install pycmd`` you get these tools from a separate +package. These days the command line tool could be called ``pytest`` +but since many people have gotten used to the old name and there +is another tool named "pytest" we just decided to stick with +``py.test`` for now. + +pytest fixtures, parametrized tests +------------------------------------------------------- + +.. _funcargs: funcargs.html + +Is using pytest fixtures versus xUnit setup a style question? ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +For simple applications and for people experienced with nose_ or +unittest-style test setup using `xUnit style setup`_ probably +feels natural. For larger test suites, parametrized testing +or setup of complex test resources using fixtures_ may feel more natural. +Moreover, fixtures are ideal for writing advanced test support +code (like e.g. the monkeypatch_, the tmpdir_ or capture_ fixtures) +because the support code can register setup/teardown functions +in a managed class/module/function scope. + +.. _monkeypatch: monkeypatch.html +.. _tmpdir: tmpdir.html +.. _capture: capture.html +.. _fixtures: fixture.html + +.. _`why pytest_pyfuncarg__ methods?`: + +.. _`Convention over Configuration`: http://en.wikipedia.org/wiki/Convention_over_Configuration + +Can I yield multiple values from a fixture function? +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +There are two conceptual reasons why yielding from a factory function +is not possible: + +* If multiple factories yielded values there would + be no natural place to determine the combination + policy - in real-world examples some combinations + often should not run. + +* Calling factories for obtaining test function arguments + is part of setting up and running a test. At that + point it is not possible to add new test calls to + the test collection anymore. + +However, with pytest-2.3 you can use the :ref:`@pytest.fixture` decorator +and specify ``params`` so that all tests depending on the factory-created +resource will run multiple times with different parameters. + +You can also use the ``pytest_generate_tests`` hook to +implement the `parametrization scheme of your choice`_. See also +:ref:`paramexamples` for more examples. + +.. _`parametrization scheme of your choice`: http://tetamap.wordpress.com/2009/05/13/parametrizing-python-tests-generalized/ + +pytest interaction with other packages +--------------------------------------------------- + +Issues with pytest, multiprocess and setuptools? ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +On Windows the multiprocess package will instantiate sub processes +by pickling and thus implicitly re-import a lot of local modules. +Unfortunately, setuptools-0.6.11 does not ``if __name__=='__main__'`` +protect its generated command line script. This leads to infinite +recursion when running a test that instantiates Processes. + +As of mid-2013, there shouldn't be a problem anymore when you +use the standard setuptools (note that distribute has been merged +back into setuptools which is now shipped directly with virtualenv). + +.. include:: links.inc diff --git a/testing/web-platform/tests/tools/pytest/doc/en/feedback.rst b/testing/web-platform/tests/tools/pytest/doc/en/feedback.rst new file mode 100644 index 000000000..9c63b7640 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/feedback.rst @@ -0,0 +1,8 @@ + +What users say: + + `py.test is pretty much the best thing ever`_ (Alex Gaynor) + + +.. _`py.test is pretty much the best thing ever`_ (Alex Gaynor) + http://twitter.com/#!/alex_gaynor/status/22389410366 diff --git a/testing/web-platform/tests/tools/pytest/doc/en/fixture.rst b/testing/web-platform/tests/tools/pytest/doc/en/fixture.rst new file mode 100644 index 000000000..f48607ae2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/fixture.rst @@ -0,0 +1,987 @@ +.. _fixture: +.. _fixtures: +.. _`fixture functions`: + +pytest fixtures: explicit, modular, scalable +======================================================== + +.. currentmodule:: _pytest.python + +.. versionadded:: 2.0/2.3/2.4 + +.. _`xUnit`: http://en.wikipedia.org/wiki/XUnit +.. _`purpose of test fixtures`: http://en.wikipedia.org/wiki/Test_fixture#Software +.. _`Dependency injection`: http://en.wikipedia.org/wiki/Dependency_injection#Definition + +The `purpose of test fixtures`_ is to provide a fixed baseline +upon which tests can reliably and repeatedly execute. pytest fixtures +offer dramatic improvements over the classic xUnit style of setup/teardown +functions: + +* fixtures have explicit names and are activated by declaring their use + from test functions, modules, classes or whole projects. + +* fixtures are implemented in a modular manner, as each fixture name + triggers a *fixture function* which can itself use other fixtures. + +* fixture management scales from simple unit to complex + functional testing, allowing to parametrize fixtures and tests according + to configuration and component options, or to re-use fixtures + across class, module or whole test session scopes. + +In addition, pytest continues to support :ref:`xunitsetup`. You can mix +both styles, moving incrementally from classic to new style, as you +prefer. You can also start out from existing :ref:`unittest.TestCase +style <unittest.TestCase>` or :ref:`nose based <nosestyle>` projects. + +.. note:: + + pytest-2.4 introduced an additional experimental + :ref:`yield fixture mechanism <yieldfixture>` for easier context manager + integration and more linear writing of teardown code. + +.. _`funcargs`: +.. _`funcarg mechanism`: +.. _`fixture function`: +.. _`@pytest.fixture`: +.. _`pytest.fixture`: + +Fixtures as Function arguments +----------------------------------------- + +Test functions can receive fixture objects by naming them as an input +argument. For each argument name, a fixture function with that name provides +the fixture object. Fixture functions are registered by marking them with +:py:func:`@pytest.fixture <_pytest.python.fixture>`. Let's look at a simple +self-contained test module containing a fixture and a test function +using it:: + + # content of ./test_smtpsimple.py + import pytest + + @pytest.fixture + def smtp(): + import smtplib + return smtplib.SMTP("smtp.gmail.com") + + def test_ehlo(smtp): + response, msg = smtp.ehlo() + assert response == 250 + assert 0 # for demo purposes + +Here, the ``test_ehlo`` needs the ``smtp`` fixture value. pytest +will discover and call the :py:func:`@pytest.fixture <_pytest.python.fixture>` +marked ``smtp`` fixture function. Running the test looks like this:: + + $ py.test test_smtpsimple.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 1 items + + test_smtpsimple.py F + + ======= FAILURES ======== + _______ test_ehlo ________ + + smtp = <smtplib.SMTP object at 0xdeadbeef> + + def test_ehlo(smtp): + response, msg = smtp.ehlo() + assert response == 250 + > assert 0 # for demo purposes + E assert 0 + + test_smtpsimple.py:11: AssertionError + ======= 1 failed in 0.12 seconds ======== + +In the failure traceback we see that the test function was called with a +``smtp`` argument, the ``smtplib.SMTP()`` instance created by the fixture +function. The test function fails on our deliberate ``assert 0``. Here is +the exact protocol used by ``pytest`` to call the test function this way: + +1. pytest :ref:`finds <test discovery>` the ``test_ehlo`` because + of the ``test_`` prefix. The test function needs a function argument + named ``smtp``. A matching fixture function is discovered by + looking for a fixture-marked function named ``smtp``. + +2. ``smtp()`` is called to create an instance. + +3. ``test_ehlo(<SMTP instance>)`` is called and fails in the last + line of the test function. + +Note that if you misspell a function argument or want +to use one that isn't available, you'll see an error +with a list of available function arguments. + +.. Note:: + + You can always issue:: + + py.test --fixtures test_simplefactory.py + + to see available fixtures. + + In versions prior to 2.3 there was no ``@pytest.fixture`` marker + and you had to use a magic ``pytest_funcarg__NAME`` prefix + for the fixture factory. This remains and will remain supported + but is not anymore advertised as the primary means of declaring fixture + functions. + +"Funcargs" a prime example of dependency injection +--------------------------------------------------- + +When injecting fixtures to test functions, pytest-2.0 introduced the +term "funcargs" or "funcarg mechanism" which continues to be present +also in docs today. It now refers to the specific case of injecting +fixture values as arguments to test functions. With pytest-2.3 there are +more possibilities to use fixtures but "funcargs" remain as the main way +as they allow to directly state the dependencies of a test function. + +As the following examples show in more detail, funcargs allow test +functions to easily receive and work against specific pre-initialized +application objects without having to care about import/setup/cleanup +details. It's a prime example of `dependency injection`_ where fixture +functions take the role of the *injector* and test functions are the +*consumers* of fixture objects. + +.. _smtpshared: + +Sharing a fixture across tests in a module (or class/session) +----------------------------------------------------------------- + +.. regendoc:wipe + +Fixtures requiring network access depend on connectivity and are +usually time-expensive to create. Extending the previous example, we +can add a ``scope='module'`` parameter to the +:py:func:`@pytest.fixture <_pytest.python.fixture>` invocation +to cause the decorated ``smtp`` fixture function to only be invoked once +per test module. Multiple test functions in a test module will thus +each receive the same ``smtp`` fixture instance. The next example puts +the fixture function into a separate ``conftest.py`` file so +that tests from multiple test modules in the directory can +access the fixture function:: + + # content of conftest.py + import pytest + import smtplib + + @pytest.fixture(scope="module") + def smtp(): + return smtplib.SMTP("smtp.gmail.com") + +The name of the fixture again is ``smtp`` and you can access its result by +listing the name ``smtp`` as an input parameter in any test or fixture +function (in or below the directory where ``conftest.py`` is located):: + + # content of test_module.py + + def test_ehlo(smtp): + response, msg = smtp.ehlo() + assert response == 250 + assert b"smtp.gmail.com" in msg + assert 0 # for demo purposes + + def test_noop(smtp): + response, msg = smtp.noop() + assert response == 250 + assert 0 # for demo purposes + +We deliberately insert failing ``assert 0`` statements in order to +inspect what is going on and can now run the tests:: + + $ py.test test_module.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 2 items + + test_module.py FF + + ======= FAILURES ======== + _______ test_ehlo ________ + + smtp = <smtplib.SMTP object at 0xdeadbeef> + + def test_ehlo(smtp): + response, msg = smtp.ehlo() + assert response == 250 + assert b"smtp.gmail.com" in msg + > assert 0 # for demo purposes + E assert 0 + + test_module.py:6: AssertionError + _______ test_noop ________ + + smtp = <smtplib.SMTP object at 0xdeadbeef> + + def test_noop(smtp): + response, msg = smtp.noop() + assert response == 250 + > assert 0 # for demo purposes + E assert 0 + + test_module.py:11: AssertionError + ======= 2 failed in 0.12 seconds ======== + +You see the two ``assert 0`` failing and more importantly you can also see +that the same (module-scoped) ``smtp`` object was passed into the two +test functions because pytest shows the incoming argument values in the +traceback. As a result, the two test functions using ``smtp`` run as +quick as a single one because they reuse the same instance. + +If you decide that you rather want to have a session-scoped ``smtp`` +instance, you can simply declare it: + +.. code-block:: python + + @pytest.fixture(scope="session") + def smtp(...): + # the returned fixture value will be shared for + # all tests needing it + +.. _`finalization`: + +Fixture finalization / executing teardown code +------------------------------------------------------------- + +pytest supports execution of fixture specific finalization code +when the fixture goes out of scope. By accepting a ``request`` object +into your fixture function you can call its ``request.addfinalizer`` one +or multiple times:: + + # content of conftest.py + + import smtplib + import pytest + + @pytest.fixture(scope="module") + def smtp(request): + smtp = smtplib.SMTP("smtp.gmail.com") + def fin(): + print ("teardown smtp") + smtp.close() + request.addfinalizer(fin) + return smtp # provide the fixture value + +The ``fin`` function will execute when the last test using +the fixture in the module has finished execution. + +Let's execute it:: + + $ py.test -s -q --tb=no + FFteardown smtp + + 2 failed in 0.12 seconds + +We see that the ``smtp`` instance is finalized after the two +tests finished execution. Note that if we decorated our fixture +function with ``scope='function'`` then fixture setup and cleanup would +occur around each single test. In either case the test +module itself does not need to change or know about these details +of fixture setup. + + +.. _`request-context`: + +Fixtures can introspect the requesting test context +------------------------------------------------------------- + +Fixture function can accept the :py:class:`request <FixtureRequest>` object +to introspect the "requesting" test function, class or module context. +Further extending the previous ``smtp`` fixture example, let's +read an optional server URL from the test module which uses our fixture:: + + # content of conftest.py + import pytest + import smtplib + + @pytest.fixture(scope="module") + def smtp(request): + server = getattr(request.module, "smtpserver", "smtp.gmail.com") + smtp = smtplib.SMTP(server) + + def fin(): + print ("finalizing %s (%s)" % (smtp, server)) + smtp.close() + request.addfinalizer(fin) + return smtp + +We use the ``request.module`` attribute to optionally obtain an +``smtpserver`` attribute from the test module. If we just execute +again, nothing much has changed:: + + $ py.test -s -q --tb=no + FFfinalizing <smtplib.SMTP object at 0xdeadbeef> (smtp.gmail.com) + + 2 failed in 0.12 seconds + +Let's quickly create another test module that actually sets the +server URL in its module namespace:: + + # content of test_anothersmtp.py + + smtpserver = "mail.python.org" # will be read by smtp fixture + + def test_showhelo(smtp): + assert 0, smtp.helo() + +Running it:: + + $ py.test -qq --tb=short test_anothersmtp.py + F + ======= FAILURES ======== + _______ test_showhelo ________ + test_anothersmtp.py:5: in test_showhelo + assert 0, smtp.helo() + E AssertionError: (250, b'mail.python.org') + E assert 0 + +voila! The ``smtp`` fixture function picked up our mail server name +from the module namespace. + +.. _`fixture-parametrize`: + +Parametrizing a fixture +----------------------------------------------------------------- + +Fixture functions can be parametrized in which case they will be called +multiple times, each time executing the set of dependent tests, i. e. the +tests that depend on this fixture. Test functions do usually not need +to be aware of their re-running. Fixture parametrization helps to +write exhaustive functional tests for components which themselves can be +configured in multiple ways. + +Extending the previous example, we can flag the fixture to create two +``smtp`` fixture instances which will cause all tests using the fixture +to run twice. The fixture function gets access to each parameter +through the special :py:class:`request <FixtureRequest>` object:: + + # content of conftest.py + import pytest + import smtplib + + @pytest.fixture(scope="module", + params=["smtp.gmail.com", "mail.python.org"]) + def smtp(request): + smtp = smtplib.SMTP(request.param) + def fin(): + print ("finalizing %s" % smtp) + smtp.close() + request.addfinalizer(fin) + return smtp + +The main change is the declaration of ``params`` with +:py:func:`@pytest.fixture <_pytest.python.fixture>`, a list of values +for each of which the fixture function will execute and can access +a value via ``request.param``. No test function code needs to change. +So let's just do another run:: + + $ py.test -q test_module.py + FFFF + ======= FAILURES ======== + _______ test_ehlo[smtp.gmail.com] ________ + + smtp = <smtplib.SMTP object at 0xdeadbeef> + + def test_ehlo(smtp): + response, msg = smtp.ehlo() + assert response == 250 + assert b"smtp.gmail.com" in msg + > assert 0 # for demo purposes + E assert 0 + + test_module.py:6: AssertionError + _______ test_noop[smtp.gmail.com] ________ + + smtp = <smtplib.SMTP object at 0xdeadbeef> + + def test_noop(smtp): + response, msg = smtp.noop() + assert response == 250 + > assert 0 # for demo purposes + E assert 0 + + test_module.py:11: AssertionError + _______ test_ehlo[mail.python.org] ________ + + smtp = <smtplib.SMTP object at 0xdeadbeef> + + def test_ehlo(smtp): + response, msg = smtp.ehlo() + assert response == 250 + > assert b"smtp.gmail.com" in msg + E assert b'smtp.gmail.com' in b'mail.python.org\nSIZE 51200000\nETRN\nSTARTTLS\nENHANCEDSTATUSCODES\n8BITMIME\nDSN\nSMTPUTF8' + + test_module.py:5: AssertionError + -------------------------- Captured stdout setup --------------------------- + finalizing <smtplib.SMTP object at 0xdeadbeef> + _______ test_noop[mail.python.org] ________ + + smtp = <smtplib.SMTP object at 0xdeadbeef> + + def test_noop(smtp): + response, msg = smtp.noop() + assert response == 250 + > assert 0 # for demo purposes + E assert 0 + + test_module.py:11: AssertionError + 4 failed in 0.12 seconds + +We see that our two test functions each ran twice, against the different +``smtp`` instances. Note also, that with the ``mail.python.org`` +connection the second test fails in ``test_ehlo`` because a +different server string is expected than what arrived. + +pytest will build a string that is the test ID for each fixture value +in a parametrized fixture, e.g. ``test_ehlo[smtp.gmail.com]`` and +``test_ehlo[mail.python.org]`` in the above examples. These IDs can +be used with ``-k`` to select specific cases to run, and they will +also identify the specific case when one is failing. Running pytest +with ``--collect-only`` will show the generated IDs. + +Numbers, strings, booleans and None will have their usual string +representation used in the test ID. For other objects, pytest will +make a string based on the argument name. It is possible to customise +the string used in a test ID for a certain fixture value by using the +``ids`` keyword argument:: + + # content of test_ids.py + import pytest + + @pytest.fixture(params=[0, 1], ids=["spam", "ham"]) + def a(request): + return request.param + + def test_a(a): + pass + + def idfn(fixture_value): + if fixture_value == 0: + return "eggs" + else: + return None + + @pytest.fixture(params=[0, 1], ids=idfn) + def b(request): + return request.param + + def test_b(b): + pass + +The above shows how ``ids`` can be either a list of strings to use or +a function which will be called with the fixture value and then +has to return a string to use. In the latter case if the function +return ``None`` then pytest's auto-generated ID will be used. + +Running the above tests results in the following test IDs being used:: + + $ py.test --collect-only + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 10 items + <Module 'test_anothersmtp.py'> + <Function 'test_showhelo[smtp.gmail.com]'> + <Function 'test_showhelo[mail.python.org]'> + <Module 'test_ids.py'> + <Function 'test_a[spam]'> + <Function 'test_a[ham]'> + <Function 'test_b[eggs]'> + <Function 'test_b[1]'> + <Module 'test_module.py'> + <Function 'test_ehlo[smtp.gmail.com]'> + <Function 'test_noop[smtp.gmail.com]'> + <Function 'test_ehlo[mail.python.org]'> + <Function 'test_noop[mail.python.org]'> + + ======= no tests ran in 0.12 seconds ======== + +.. _`interdependent fixtures`: + +Modularity: using fixtures from a fixture function +---------------------------------------------------------- + +You can not only use fixtures in test functions but fixture functions +can use other fixtures themselves. This contributes to a modular design +of your fixtures and allows re-use of framework-specific fixtures across +many projects. As a simple example, we can extend the previous example +and instantiate an object ``app`` where we stick the already defined +``smtp`` resource into it:: + + # content of test_appsetup.py + + import pytest + + class App: + def __init__(self, smtp): + self.smtp = smtp + + @pytest.fixture(scope="module") + def app(smtp): + return App(smtp) + + def test_smtp_exists(app): + assert app.smtp + +Here we declare an ``app`` fixture which receives the previously defined +``smtp`` fixture and instantiates an ``App`` object with it. Let's run it:: + + $ py.test -v test_appsetup.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 2 items + + test_appsetup.py::test_smtp_exists[smtp.gmail.com] PASSED + test_appsetup.py::test_smtp_exists[mail.python.org] PASSED + + ======= 2 passed in 0.12 seconds ======== + +Due to the parametrization of ``smtp`` the test will run twice with two +different ``App`` instances and respective smtp servers. There is no +need for the ``app`` fixture to be aware of the ``smtp`` parametrization +as pytest will fully analyse the fixture dependency graph. + +Note, that the ``app`` fixture has a scope of ``module`` and uses a +module-scoped ``smtp`` fixture. The example would still work if ``smtp`` +was cached on a ``session`` scope: it is fine for fixtures to use +"broader" scoped fixtures but not the other way round: +A session-scoped fixture could not use a module-scoped one in a +meaningful way. + + +.. _`automatic per-resource grouping`: + +Automatic grouping of tests by fixture instances +---------------------------------------------------------- + +.. regendoc: wipe + +pytest minimizes the number of active fixtures during test runs. +If you have a parametrized fixture, then all the tests using it will +first execute with one instance and then finalizers are called +before the next fixture instance is created. Among other things, +this eases testing of applications which create and use global state. + +The following example uses two parametrized funcargs, one of which is +scoped on a per-module basis, and all the functions perform ``print`` calls +to show the setup/teardown flow:: + + # content of test_module.py + import pytest + + @pytest.fixture(scope="module", params=["mod1", "mod2"]) + def modarg(request): + param = request.param + print ("create", param) + def fin(): + print ("fin %s" % param) + return param + + @pytest.fixture(scope="function", params=[1,2]) + def otherarg(request): + return request.param + + def test_0(otherarg): + print (" test0", otherarg) + def test_1(modarg): + print (" test1", modarg) + def test_2(otherarg, modarg): + print (" test2", otherarg, modarg) + +Let's run the tests in verbose mode and with looking at the print-output:: + + $ py.test -v -s test_module.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 -- $PYTHON_PREFIX/bin/python3.4 + cachedir: .cache + rootdir: $REGENDOC_TMPDIR, inifile: + collecting ... collected 8 items + + test_module.py::test_0[1] test0 1 + PASSED + test_module.py::test_0[2] test0 2 + PASSED + test_module.py::test_1[mod1] create mod1 + test1 mod1 + PASSED + test_module.py::test_2[1-mod1] test2 1 mod1 + PASSED + test_module.py::test_2[2-mod1] test2 2 mod1 + PASSED + test_module.py::test_1[mod2] create mod2 + test1 mod2 + PASSED + test_module.py::test_2[1-mod2] test2 1 mod2 + PASSED + test_module.py::test_2[2-mod2] test2 2 mod2 + PASSED + + ======= 8 passed in 0.12 seconds ======== + +You can see that the parametrized module-scoped ``modarg`` resource caused +an ordering of test execution that lead to the fewest possible "active" resources. The finalizer for the ``mod1`` parametrized resource was executed +before the ``mod2`` resource was setup. + + +.. _`usefixtures`: + +Using fixtures from classes, modules or projects +---------------------------------------------------------------------- + +.. regendoc:wipe + +Sometimes test functions do not directly need access to a fixture object. +For example, tests may require to operate with an empty directory as the +current working directory but otherwise do not care for the concrete +directory. Here is how you can can use the standard `tempfile +<http://docs.python.org/library/tempfile.html>`_ and pytest fixtures to +achieve it. We separate the creation of the fixture into a conftest.py +file:: + + # content of conftest.py + + import pytest + import tempfile + import os + + @pytest.fixture() + def cleandir(): + newpath = tempfile.mkdtemp() + os.chdir(newpath) + +and declare its use in a test module via a ``usefixtures`` marker:: + + # content of test_setenv.py + import os + import pytest + + @pytest.mark.usefixtures("cleandir") + class TestDirectoryInit: + def test_cwd_starts_empty(self): + assert os.listdir(os.getcwd()) == [] + with open("myfile", "w") as f: + f.write("hello") + + def test_cwd_again_starts_empty(self): + assert os.listdir(os.getcwd()) == [] + +Due to the ``usefixtures`` marker, the ``cleandir`` fixture +will be required for the execution of each test method, just as if +you specified a "cleandir" function argument to each of them. Let's run it +to verify our fixture is activated and the tests pass:: + + $ py.test -q + .. + 2 passed in 0.12 seconds + +You can specify multiple fixtures like this: + +.. code-block:: python + + @pytest.mark.usefixtures("cleandir", "anotherfixture") + +and you may specify fixture usage at the test module level, using +a generic feature of the mark mechanism: + +.. code-block:: python + + pytestmark = pytest.mark.usefixtures("cleandir") + +Note that the assigned variable *must* be called ``pytestmark``, assigning e.g. +``foomark`` will not activate the fixtures. + +Lastly you can put fixtures required by all tests in your project +into an ini-file: + +.. code-block:: ini + + # content of pytest.ini + [pytest] + usefixtures = cleandir + + +.. _`autouse`: +.. _`autouse fixtures`: + +Autouse fixtures (xUnit setup on steroids) +---------------------------------------------------------------------- + +.. regendoc:wipe + +Occasionally, you may want to have fixtures get invoked automatically +without a `usefixtures`_ or `funcargs`_ reference. As a practical +example, suppose we have a database fixture which has a +begin/rollback/commit architecture and we want to automatically surround +each test method by a transaction and a rollback. Here is a dummy +self-contained implementation of this idea:: + + # content of test_db_transact.py + + import pytest + + class DB: + def __init__(self): + self.intransaction = [] + def begin(self, name): + self.intransaction.append(name) + def rollback(self): + self.intransaction.pop() + + @pytest.fixture(scope="module") + def db(): + return DB() + + class TestClass: + @pytest.fixture(autouse=True) + def transact(self, request, db): + db.begin(request.function.__name__) + request.addfinalizer(db.rollback) + + def test_method1(self, db): + assert db.intransaction == ["test_method1"] + + def test_method2(self, db): + assert db.intransaction == ["test_method2"] + +The class-level ``transact`` fixture is marked with *autouse=true* +which implies that all test methods in the class will use this fixture +without a need to state it in the test function signature or with a +class-level ``usefixtures`` decorator. + +If we run it, we get two passing tests:: + + $ py.test -q + .. + 2 passed in 0.12 seconds + +Here is how autouse fixtures work in other scopes: + +- if an autouse fixture is defined in a test module, all its test + functions automatically use it. + +- if an autouse fixture is defined in a conftest.py file then all tests in + all test modules below its directory will invoke the fixture. + +- lastly, and **please use that with care**: if you define an autouse + fixture in a plugin, it will be invoked for all tests in all projects + where the plugin is installed. This can be useful if a fixture only + anyway works in the presence of certain settings e. g. in the ini-file. Such + a global fixture should always quickly determine if it should do + any work and avoid otherwise expensive imports or computation. + +Note that the above ``transact`` fixture may very well be a fixture that +you want to make available in your project without having it generally +active. The canonical way to do that is to put the transact definition +into a conftest.py file **without** using ``autouse``:: + + # content of conftest.py + @pytest.fixture() + def transact(self, request, db): + db.begin() + request.addfinalizer(db.rollback) + +and then e.g. have a TestClass using it by declaring the need:: + + @pytest.mark.usefixtures("transact") + class TestClass: + def test_method1(self): + ... + +All test methods in this TestClass will use the transaction fixture while +other test classes or functions in the module will not use it unless +they also add a ``transact`` reference. + +Shifting (visibility of) fixture functions +---------------------------------------------------- + +If during implementing your tests you realize that you +want to use a fixture function from multiple test files you can move it +to a :ref:`conftest.py <conftest.py>` file or even separately installable +:ref:`plugins <plugins>` without changing test code. The discovery of +fixtures functions starts at test classes, then test modules, then +``conftest.py`` files and finally builtin and third party plugins. + +Overriding fixtures on various levels +------------------------------------- + +In relatively large test suite, you most likely need to ``override`` a ``global`` or ``root`` fixture with a ``locally`` +defined one, keeping the test code readable and maintainable. + +Override a fixture on a folder (conftest) level +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Given the tests file structure is: + +:: + + tests/ + __init__.py + + conftest.py + # content of tests/conftest.py + import pytest + + @pytest.fixture + def username(): + return 'username' + + test_something.py + # content of tests/test_something.py + def test_username(username): + assert username == 'username' + + subfolder/ + __init__.py + + conftest.py + # content of tests/subfolder/conftest.py + import pytest + + @pytest.fixture + def username(username): + return 'overridden-' + username + + test_something.py + # content of tests/subfolder/test_something.py + def test_username(username): + assert username == 'overridden-username' + +As you can see, a fixture with the same name can be overridden for certain test folder level. +Note that the ``base`` or ``super`` fixture can be accessed from the ``overriding`` +fixture easily - used in the example above. + +Override a fixture on a test module level +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Given the tests file structure is: + +:: + + tests/ + __init__.py + + conftest.py + # content of tests/conftest.py + @pytest.fixture + def username(): + return 'username' + + test_something.py + # content of tests/test_something.py + import pytest + + @pytest.fixture + def username(username): + return 'overridden-' + username + + def test_username(username): + assert username == 'overridden-username' + + test_something_else.py + # content of tests/test_something_else.py + import pytest + + @pytest.fixture + def username(username): + return 'overridden-else-' + username + + def test_username(username): + assert username == 'overridden-else-username' + +In the example above, a fixture with the same name can be overridden for certain test module. + + +Override a fixture with direct test parametrization +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Given the tests file structure is: + +:: + + tests/ + __init__.py + + conftest.py + # content of tests/conftest.py + import pytest + + @pytest.fixture + def username(): + return 'username' + + @pytest.fixture + def other_username(username): + return 'other-' + username + + test_something.py + # content of tests/test_something.py + import pytest + + @pytest.mark.parametrize('username', ['directly-overridden-username']) + def test_username(username): + assert username == 'directly-overridden-username' + + @pytest.mark.parametrize('username', ['directly-overridden-username-other']) + def test_username_other(other_username): + assert username == 'other-directly-overridden-username-other' + +In the example above, a fixture value is overridden by the test parameter value. Note that the value of the fixture +can be overridden this way even if the test doesn't use it directly (doesn't mention it in the function prototype). + + +Override a parametrized fixture with non-parametrized one and vice versa +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Given the tests file structure is: + +:: + + tests/ + __init__.py + + conftest.py + # content of tests/conftest.py + import pytest + + @pytest.fixture(params=['one', 'two', 'three']) + def parametrized_username(request): + return request.param + + @pytest.fixture + def non_parametrized_username(request): + return 'username' + + test_something.py + # content of tests/test_something.py + import pytest + + @pytest.fixture + def parametrized_username(): + return 'overridden-username' + + @pytest.fixture(params=['one', 'two', 'three']) + def non_parametrized_username(request): + return request.param + + def test_username(parametrized_username): + assert parametrized_username == 'overridden-username' + + def test_parametrized_username(non_parametrized_username): + assert non_parametrized_username in ['one', 'two', 'three'] + + test_something_else.py + # content of tests/test_something_else.py + def test_username(parametrized_username): + assert parametrized_username in ['one', 'two', 'three'] + + def test_username(non_parametrized_username): + assert non_parametrized_username == 'username' + +In the example above, a parametrized fixture is overridden with a non-parametrized version, and +a non-parametrized fixture is overridden with a parametrized version for certain test module. +The same applies for the test folder level obviously. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/funcarg_compare.rst b/testing/web-platform/tests/tools/pytest/doc/en/funcarg_compare.rst new file mode 100644 index 000000000..832922e18 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/funcarg_compare.rst @@ -0,0 +1,217 @@ + +.. _`funcargcompare`: + +pytest-2.3: reasoning for fixture/funcarg evolution +============================================================= + +**Target audience**: Reading this document requires basic knowledge of +python testing, xUnit setup methods and the (previous) basic pytest +funcarg mechanism, see http://pytest.org/2.2.4/funcargs.html +If you are new to pytest, then you can simply ignore this +section and read the other sections. + +.. currentmodule:: _pytest + +Shortcomings of the previous ``pytest_funcarg__`` mechanism +-------------------------------------------------------------- + +The pre pytest-2.3 funcarg mechanism calls a factory each time a +funcarg for a test function is required. If a factory wants to +re-use a resource across different scopes, it often used +the ``request.cached_setup()`` helper to manage caching of +resources. Here is a basic example how we could implement +a per-session Database object:: + + # content of conftest.py + class Database: + def __init__(self): + print ("database instance created") + def destroy(self): + print ("database instance destroyed") + + def pytest_funcarg__db(request): + return request.cached_setup(setup=DataBase, + teardown=lambda db: db.destroy, + scope="session") + +There are several limitations and difficulties with this approach: + +1. Scoping funcarg resource creation is not straight forward, instead one must + understand the intricate cached_setup() method mechanics. + +2. parametrizing the "db" resource is not straight forward: + you need to apply a "parametrize" decorator or implement a + :py:func:`~hookspec.pytest_generate_tests` hook + calling :py:func:`~python.Metafunc.parametrize` which + performs parametrization at the places where the resource + is used. Moreover, you need to modify the factory to use an + ``extrakey`` parameter containing ``request.param`` to the + :py:func:`~python.Request.cached_setup` call. + +3. Multiple parametrized session-scoped resources will be active + at the same time, making it hard for them to affect global state + of the application under test. + +4. there is no way how you can make use of funcarg factories + in xUnit setup methods. + +5. A non-parametrized fixture function cannot use a parametrized + funcarg resource if it isn't stated in the test function signature. + +All of these limitations are addressed with pytest-2.3 and its +improved :ref:`fixture mechanism <fixture>`. + + +Direct scoping of fixture/funcarg factories +-------------------------------------------------------- + +Instead of calling cached_setup() with a cache scope, you can use the +:ref:`@pytest.fixture <pytest.fixture>` decorator and directly state +the scope:: + + @pytest.fixture(scope="session") + def db(request): + # factory will only be invoked once per session - + db = DataBase() + request.addfinalizer(db.destroy) # destroy when session is finished + return db + +This factory implementation does not need to call ``cached_setup()`` anymore +because it will only be invoked once per session. Moreover, the +``request.addfinalizer()`` registers a finalizer according to the specified +resource scope on which the factory function is operating. + + +Direct parametrization of funcarg resource factories +---------------------------------------------------------- + +Previously, funcarg factories could not directly cause parametrization. +You needed to specify a ``@parametrize`` decorator on your test function +or implement a ``pytest_generate_tests`` hook to perform +parametrization, i.e. calling a test multiple times with different value +sets. pytest-2.3 introduces a decorator for use on the factory itself:: + + @pytest.fixture(params=["mysql", "pg"]) + def db(request): + ... # use request.param + +Here the factory will be invoked twice (with the respective "mysql" +and "pg" values set as ``request.param`` attributes) and and all of +the tests requiring "db" will run twice as well. The "mysql" and +"pg" values will also be used for reporting the test-invocation variants. + +This new way of parametrizing funcarg factories should in many cases +allow to re-use already written factories because effectively +``request.param`` was already used when test functions/classes were +parametrized via +:py:func:`~_pytest.python.Metafunc.parametrize(indirect=True)` calls. + +Of course it's perfectly fine to combine parametrization and scoping:: + + @pytest.fixture(scope="session", params=["mysql", "pg"]) + def db(request): + if request.param == "mysql": + db = MySQL() + elif request.param == "pg": + db = PG() + request.addfinalizer(db.destroy) # destroy when session is finished + return db + +This would execute all tests requiring the per-session "db" resource twice, +receiving the values created by the two respective invocations to the +factory function. + + +No ``pytest_funcarg__`` prefix when using @fixture decorator +------------------------------------------------------------------- + +When using the ``@fixture`` decorator the name of the function +denotes the name under which the resource can be accessed as a function +argument:: + + @pytest.fixture() + def db(request): + ... + +The name under which the funcarg resource can be requested is ``db``. + +You can still use the "old" non-decorator way of specifying funcarg factories +aka:: + + def pytest_funcarg__db(request): + ... + + +But it is then not possible to define scoping and parametrization. +It is thus recommended to use the factory decorator. + + +solving per-session setup / autouse fixtures +-------------------------------------------------------------- + +pytest for a long time offered a pytest_configure and a pytest_sessionstart +hook which are often used to setup global resources. This suffers from +several problems: + +1. in distributed testing the master process would setup test resources + that are never needed because it only co-ordinates the test run + activities of the slave processes. + +2. if you only perform a collection (with "--collect-only") + resource-setup will still be executed. + +3. If a pytest_sessionstart is contained in some subdirectories + conftest.py file, it will not be called. This stems from the + fact that this hook is actually used for reporting, in particular + the test-header with platform/custom information. + +Moreover, it was not easy to define a scoped setup from plugins or +conftest files other than to implement a ``pytest_runtest_setup()`` hook +and caring for scoping/caching yourself. And it's virtually impossible +to do this with parametrization as ``pytest_runtest_setup()`` is called +during test execution and parametrization happens at collection time. + +It follows that pytest_configure/session/runtest_setup are often not +appropriate for implementing common fixture needs. Therefore, +pytest-2.3 introduces :ref:`autouse fixtures` which fully +integrate with the generic :ref:`fixture mechanism <fixture>` +and obsolete many prior uses of pytest hooks. + +funcargs/fixture discovery now happens at collection time +--------------------------------------------------------------------- + +pytest-2.3 takes care to discover fixture/funcarg factories +at collection time. This is more efficient especially for large test suites. +Moreover, a call to "py.test --collect-only" should be able to in the future +show a lot of setup-information and thus presents a nice method to get an +overview of fixture management in your project. + +.. _`compatibility notes`: + +.. _`funcargscompat`: + +Conclusion and compatibility notes +--------------------------------------------------------- + +**funcargs** were originally introduced to pytest-2.0. In pytest-2.3 +the mechanism was extended and refined and is now described as +fixtures: + +* previously funcarg factories were specified with a special + ``pytest_funcarg__NAME`` prefix instead of using the + ``@pytest.fixture`` decorator. + +* Factories received a ``request`` object which managed caching through + ``request.cached_setup()`` calls and allowed using other funcargs via + ``request.getfuncargvalue()`` calls. These intricate APIs made it hard + to do proper parametrization and implement resource caching. The + new :py:func:`pytest.fixture` decorator allows to declare the scope + and let pytest figure things out for you. + +* if you used parametrization and funcarg factories which made use of + ``request.cached_setup()`` it is recommended to invest a few minutes + and simplify your fixture function code to use the :ref:`@pytest.fixture` + decorator instead. This will also allow to take advantage of + the automatic per-resource grouping of tests. + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/funcargs.rst b/testing/web-platform/tests/tools/pytest/doc/en/funcargs.rst new file mode 100644 index 000000000..bc2c04302 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/funcargs.rst @@ -0,0 +1,14 @@ + +======================================================= +funcargs: resource injection and parametrization +======================================================= + +pytest-2.3 introduces major refinements to fixture management +of which the funcarg mechanism introduced with pytest-2.0 remains +a core part. The documentation has been refactored as well +and you can read on here: + +- :ref:`fixtures` +- :ref:`parametrize` +- :ref:`funcargcompare` + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/genapi.py b/testing/web-platform/tests/tools/pytest/doc/en/genapi.py new file mode 100644 index 000000000..f8cdda6cf --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/genapi.py @@ -0,0 +1,41 @@ +import textwrap +import inspect + +class Writer: + def __init__(self, clsname): + self.clsname = clsname + + def __enter__(self): + self.file = open("%s.api" % self.clsname, "w") + return self + + def __exit__(self, *args): + self.file.close() + print "wrote", self.file.name + + def line(self, line): + self.file.write(line+"\n") + + def docmethod(self, method): + doc = " ".join(method.__doc__.split()) + indent = " " + w = textwrap.TextWrapper(initial_indent=indent, + subsequent_indent=indent) + + spec = inspect.getargspec(method) + del spec.args[0] + self.line(".. py:method:: " + method.__name__ + + inspect.formatargspec(*spec)) + self.line("") + self.line(w.fill(doc)) + self.line("") + +def pytest_funcarg__a(request): + with Writer("request") as writer: + writer.docmethod(request.getfuncargvalue) + writer.docmethod(request.cached_setup) + writer.docmethod(request.addfinalizer) + writer.docmethod(request.applymarker) + +def test_hello(a): + pass diff --git a/testing/web-platform/tests/tools/pytest/doc/en/getting-started.rst b/testing/web-platform/tests/tools/pytest/doc/en/getting-started.rst new file mode 100644 index 000000000..4a5b75aea --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/getting-started.rst @@ -0,0 +1,237 @@ +Installation and Getting Started +=================================== + +**Pythons**: Python 2.6,2.7,3.3,3.4,3.5, Jython, PyPy-2.3 + +**Platforms**: Unix/Posix and Windows + +**PyPI package name**: `pytest <http://pypi.python.org/pypi/pytest>`_ + +**dependencies**: `py <http://pypi.python.org/pypi/py>`_, +`colorama (Windows) <http://pypi.python.org/pypi/colorama>`_, +`argparse (py26) <http://pypi.python.org/pypi/argparse>`_. + +**documentation as PDF**: `download latest <http://pytest.org/latest/pytest.pdf>`_ + +.. _`getstarted`: +.. _installation: + +Installation +---------------------------------------- + +Installation options:: + + pip install -U pytest # or + easy_install -U pytest + +To check your installation has installed the correct version:: + + $ py.test --version + This is pytest version 2.9.1, imported from $PYTHON_PREFIX/lib/python3.4/site-packages/pytest.py + +If you get an error checkout :ref:`installation issues`. + +.. _`simpletest`: + +Our first test run +---------------------------------------------------------- + +Let's create a first test file with a simple test function:: + + # content of test_sample.py + def func(x): + return x + 1 + + def test_answer(): + assert func(3) == 5 + +That's it. You can execute the test function now:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 1 items + + test_sample.py F + + ======= FAILURES ======== + _______ test_answer ________ + + def test_answer(): + > assert func(3) == 5 + E assert 4 == 5 + E + where 4 = func(3) + + test_sample.py:5: AssertionError + ======= 1 failed in 0.12 seconds ======== + +We got a failure report because our little ``func(3)`` call did not return ``5``. + +.. note:: + + You can simply use the ``assert`` statement for asserting test + expectations. pytest's :ref:`assert introspection` will intelligently + report intermediate values of the assert expression freeing + you from the need to learn the many names of `JUnit legacy methods`_. + +.. _`JUnit legacy methods`: http://docs.python.org/library/unittest.html#test-cases + +.. _`assert statement`: http://docs.python.org/reference/simple_stmts.html#the-assert-statement + +Running multiple tests +---------------------------------------------------------- + +``pytest`` will run all files in the current directory and its subdirectories of the form test_*.py or \*_test.py. More generally, it follows :ref:`standard test discovery rules <test discovery>`. + + +Asserting that a certain exception is raised +-------------------------------------------------------------- + +If you want to assert that some code raises an exception you can +use the ``raises`` helper:: + + # content of test_sysexit.py + import pytest + def f(): + raise SystemExit(1) + + def test_mytest(): + with pytest.raises(SystemExit): + f() + +Running it with, this time in "quiet" reporting mode:: + + $ py.test -q test_sysexit.py + . + 1 passed in 0.12 seconds + +Grouping multiple tests in a class +-------------------------------------------------------------- + +Once you start to have more than a few tests it often makes sense +to group tests logically, in classes and modules. Let's write a class +containing two tests:: + + # content of test_class.py + class TestClass: + def test_one(self): + x = "this" + assert 'h' in x + + def test_two(self): + x = "hello" + assert hasattr(x, 'check') + +The two tests are found because of the standard :ref:`test discovery`. +There is no need to subclass anything. We can simply +run the module by passing its filename:: + + $ py.test -q test_class.py + .F + ======= FAILURES ======== + _______ TestClass.test_two ________ + + self = <test_class.TestClass object at 0xdeadbeef> + + def test_two(self): + x = "hello" + > assert hasattr(x, 'check') + E assert hasattr('hello', 'check') + + test_class.py:8: AssertionError + 1 failed, 1 passed in 0.12 seconds + +The first test passed, the second failed. Again we can easily see +the intermediate values used in the assertion, helping us to +understand the reason for the failure. + +Going functional: requesting a unique temporary directory +-------------------------------------------------------------- + +For functional tests one often needs to create some files +and pass them to application objects. pytest provides +:ref:`builtinfixtures` which allow to request arbitrary +resources, for example a unique temporary directory:: + + # content of test_tmpdir.py + def test_needsfiles(tmpdir): + print (tmpdir) + assert 0 + +We list the name ``tmpdir`` in the test function signature and +``pytest`` will lookup and call a fixture factory to create the resource +before performing the test function call. Let's just run it:: + + $ py.test -q test_tmpdir.py + F + ======= FAILURES ======== + _______ test_needsfiles ________ + + tmpdir = local('PYTEST_TMPDIR/test_needsfiles0') + + def test_needsfiles(tmpdir): + print (tmpdir) + > assert 0 + E assert 0 + + test_tmpdir.py:3: AssertionError + --------------------------- Captured stdout call --------------------------- + PYTEST_TMPDIR/test_needsfiles0 + 1 failed in 0.12 seconds + +Before the test runs, a unique-per-test-invocation temporary directory +was created. More info at :ref:`tmpdir handling`. + +You can find out what kind of builtin :ref:`fixtures` exist by typing:: + + py.test --fixtures # shows builtin and custom fixtures + +Where to go next +------------------------------------- + +Here are a few suggestions where to go next: + +* :ref:`cmdline` for command line invocation examples +* :ref:`good practices <goodpractices>` for virtualenv, test layout, genscript support +* :ref:`fixtures` for providing a functional baseline to your tests +* :ref:`apiref` for documentation and examples on using ``pytest`` +* :ref:`plugins` managing and writing plugins + +.. _`installation issues`: + +Known Installation issues +------------------------------ + +easy_install or pip not found? +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _`install pip`: http://www.pip-installer.org/en/latest/index.html + +`Install pip`_ for a state of the art python package installer. + +Install `setuptools`_ to get ``easy_install`` which allows to install +``.egg`` binary format packages in addition to source-based ones. + +py.test not found on Windows despite installation? +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. _`Python for Windows`: http://www.imladris.com/Scripts/PythonForWindows.html + +- **Windows**: If "easy_install" or "py.test" are not found + you need to add the Python script path to your ``PATH``, see here: + `Python for Windows`_. You may alternatively use an `ActivePython install`_ + which does this for you automatically. + +.. _`ActivePython install`: http://www.activestate.com/activepython/downloads + +.. _`Jython does not create command line launchers`: http://bugs.jython.org/issue1491 + +- **Jython2.5.1 on Windows XP**: `Jython does not create command line launchers`_ + so ``py.test`` will not work correctly. You may install py.test on + CPython and type ``py.test --genscript=mytest`` and then use + ``jython mytest`` to run your tests with Jython using ``pytest``. + + :ref:`examples` for more complex examples + +.. include:: links.inc diff --git a/testing/web-platform/tests/tools/pytest/doc/en/goodpractices.rst b/testing/web-platform/tests/tools/pytest/doc/en/goodpractices.rst new file mode 100644 index 000000000..2d8050bd9 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/goodpractices.rst @@ -0,0 +1,278 @@ +.. highlightlang:: python +.. _`goodpractices`: + +Good Integration Practices +================================================= + + +.. _`test discovery`: +.. _`Python test discovery`: + +Conventions for Python test discovery +------------------------------------------------- + +``pytest`` implements the following standard test discovery: + +* If no arguments are specified then collection starts from :confval:`testpaths` + (if configured) or the current directory. Alternatively, command line arguments + can be used in any combination of directories, file names or node ids. +* recurse into directories, unless they match :confval:`norecursedirs` +* ``test_*.py`` or ``*_test.py`` files, imported by their `test package name`_. +* ``Test`` prefixed test classes (without an ``__init__`` method) +* ``test_`` prefixed test functions or methods are test items + +For examples of how to customize your test discovery :doc:`example/pythoncollection`. + +Within Python modules, ``pytest`` also discovers tests using the standard +:ref:`unittest.TestCase <unittest.TestCase>` subclassing technique. + + +Choosing a test layout / import rules +------------------------------------------ + +``pytest`` supports two common test layouts: + +* putting tests into an extra directory outside your actual application + code, useful if you have many functional tests or for other reasons + want to keep tests separate from actual application code (often a good + idea):: + + setup.py # your setuptools Python package metadata + mypkg/ + __init__.py + appmodule.py + tests/ + test_app.py + ... + + +* inlining test directories into your application package, useful if you + have direct relation between (unit-)test and application modules and + want to distribute your tests along with your application:: + + setup.py # your setuptools Python package metadata + mypkg/ + __init__.py + appmodule.py + ... + test/ + test_app.py + ... + +Important notes relating to both schemes: + +- **make sure that "mypkg" is importable**, for example by typing once:: + + pip install -e . # install package using setup.py in editable mode + +- **avoid "__init__.py" files in your test directories**. + This way your tests can run easily against an installed version + of ``mypkg``, independently from the installed package if it contains + the tests or not. + +- With inlined tests you might put ``__init__.py`` into test + directories and make them installable as part of your application. + Using the ``py.test --pyargs mypkg`` invocation pytest will + discover where mypkg is installed and collect tests from there. + With the "external" test you can still distribute tests but they + will not be installed or become importable. + +Typically you can run tests by pointing to test directories or modules:: + + py.test tests/test_app.py # for external test dirs + py.test mypkg/test/test_app.py # for inlined test dirs + py.test mypkg # run tests in all below test directories + py.test # run all tests below current dir + ... + +Because of the above ``editable install`` mode you can change your +source code (both tests and the app) and rerun tests at will. +Once you are done with your work, you can `use tox`_ to make sure +that the package is really correct and tests pass in all +required configurations. + +.. note:: + + You can use Python3 namespace packages (PEP420) for your application + but pytest will still perform `test package name`_ discovery based on the + presence of ``__init__.py`` files. If you use one of the + two recommended file system layouts above but leave away the ``__init__.py`` + files from your directories it should just work on Python3.3 and above. From + "inlined tests", however, you will need to use absolute imports for + getting at your application code. + +.. _`test package name`: + +.. note:: + + If ``pytest`` finds a "a/b/test_module.py" test file while + recursing into the filesystem it determines the import name + as follows: + + * determine ``basedir``: this is the first "upward" (towards the root) + directory not containing an ``__init__.py``. If e.g. both ``a`` + and ``b`` contain an ``__init__.py`` file then the parent directory + of ``a`` will become the ``basedir``. + + * perform ``sys.path.insert(0, basedir)`` to make the test module + importable under the fully qualified import name. + + * ``import a.b.test_module`` where the path is determined + by converting path separators ``/`` into "." characters. This means + you must follow the convention of having directory and file + names map directly to the import names. + + The reason for this somewhat evolved importing technique is + that in larger projects multiple test modules might import + from each other and thus deriving a canonical import name helps + to avoid surprises such as a test modules getting imported twice. + + +.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv +.. _`buildout`: http://www.buildout.org/ +.. _pip: http://pypi.python.org/pypi/pip + +.. _`use tox`: + +Tox +------ + +For development, we recommend to use virtualenv_ environments and pip_ +for installing your application and any dependencies +as well as the ``pytest`` package itself. This ensures your code and +dependencies are isolated from the system Python installation. + +If you frequently release code and want to make sure that your actual +package passes all tests you may want to look into `tox`_, the +virtualenv test automation tool and its `pytest support +<http://testrun.org/tox/latest/example/pytest.html>`_. +Tox helps you to setup virtualenv environments with pre-defined +dependencies and then executing a pre-configured test command with +options. It will run tests against the installed package and not +against your source code checkout, helping to detect packaging +glitches. + +Continuous integration services such as Jenkins_ can make use of the +``--junitxml=PATH`` option to create a JUnitXML file and generate reports. + + +Integrating with setuptools / ``python setup.py test`` / ``pytest-runner`` +-------------------------------------------------------------------------- + +You can integrate test runs into your setuptools based project +with the `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`_ plugin. + +Add this to ``setup.py`` file: + +.. code-block:: python + + from setuptools import setup + + setup( + #..., + setup_requires=['pytest-runner', ...], + tests_require=['pytest', ...], + #..., + ) + + +And create an alias into ``setup.cfg`` file: + + +.. code-block:: ini + + [aliases] + test=pytest + +If you now type:: + + python setup.py test + +this will execute your tests using ``pytest-runner``. As this is a +standalone version of ``pytest`` no prior installation whatsoever is +required for calling the test command. You can also pass additional +arguments to py.test such as your test directory or other +options using ``--addopts``. + + +Manual Integration +^^^^^^^^^^^^^^^^^^ + +If for some reason you don't want/can't use ``pytest-runner``, you can write +your own setuptools Test command for invoking pytest. + +.. code-block:: python + + import sys + + from setuptools.command.test import test as TestCommand + + + class PyTest(TestCommand): + user_options = [('pytest-args=', 'a', "Arguments to pass to py.test")] + + def initialize_options(self): + TestCommand.initialize_options(self) + self.pytest_args = [] + + def run_tests(self): + #import here, cause outside the eggs aren't loaded + import pytest + errno = pytest.main(self.pytest_args) + sys.exit(errno) + + + setup( + #..., + tests_require=['pytest'], + cmdclass = {'test': PyTest}, + ) + +Now if you run:: + + python setup.py test + +this will download ``pytest`` if needed and then run your tests +as you would expect it to. You can pass a single string of arguments +using the ``--pytest-args`` or ``-a`` command-line option. For example:: + + python setup.py test -a "--durations=5" + +is equivalent to running ``py.test --durations=5``. + + +.. _standalone: +.. _`genscript method`: + +(deprecated) Create a pytest standalone script +----------------------------------------------- + +.. deprecated:: 2.8 + +.. note:: + + ``genscript`` has been deprecated because: + + * It cannot support plugins, rendering its usefulness extremely limited; + * Tooling has become much better since ``genscript`` was introduced; + * It is possible to build a zipped ``pytest`` application without the + shortcomings above. + + There's no planned version in which this command will be removed + at the moment of this writing, but its use is discouraged for new + applications. + +If you are a maintainer or application developer and want people +who don't deal with python much to easily run tests you may generate +a standalone ``pytest`` script:: + + py.test --genscript=runtests.py + +This generates a ``runtests.py`` script which is a fully functional basic +``pytest`` script, running unchanged under Python2 and Python3. +You can tell people to download the script and then e.g. run it like this:: + + python runtests.py + + +.. include:: links.inc diff --git a/testing/web-platform/tests/tools/pytest/doc/en/img/cramer2.png b/testing/web-platform/tests/tools/pytest/doc/en/img/cramer2.png Binary files differnew file mode 100644 index 000000000..6bf0e92e2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/img/cramer2.png diff --git a/testing/web-platform/tests/tools/pytest/doc/en/img/freiburg2.jpg b/testing/web-platform/tests/tools/pytest/doc/en/img/freiburg2.jpg Binary files differnew file mode 100644 index 000000000..3383d3023 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/img/freiburg2.jpg diff --git a/testing/web-platform/tests/tools/pytest/doc/en/img/gaynor3.png b/testing/web-platform/tests/tools/pytest/doc/en/img/gaynor3.png Binary files differnew file mode 100644 index 000000000..a577c168b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/img/gaynor3.png diff --git a/testing/web-platform/tests/tools/pytest/doc/en/img/keleshev.png b/testing/web-platform/tests/tools/pytest/doc/en/img/keleshev.png Binary files differnew file mode 100644 index 000000000..0d5e571e2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/img/keleshev.png diff --git a/testing/web-platform/tests/tools/pytest/doc/en/img/pullrequest.png b/testing/web-platform/tests/tools/pytest/doc/en/img/pullrequest.png Binary files differnew file mode 100644 index 000000000..4af293b21 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/img/pullrequest.png diff --git a/testing/web-platform/tests/tools/pytest/doc/en/img/pylib.png b/testing/web-platform/tests/tools/pytest/doc/en/img/pylib.png Binary files differnew file mode 100644 index 000000000..2e10d4388 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/img/pylib.png diff --git a/testing/web-platform/tests/tools/pytest/doc/en/img/pytest1.png b/testing/web-platform/tests/tools/pytest/doc/en/img/pytest1.png Binary files differnew file mode 100644 index 000000000..e8064a694 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/img/pytest1.png diff --git a/testing/web-platform/tests/tools/pytest/doc/en/img/pytest1favi.ico b/testing/web-platform/tests/tools/pytest/doc/en/img/pytest1favi.ico Binary files differnew file mode 100644 index 000000000..6a34fe5c9 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/img/pytest1favi.ico diff --git a/testing/web-platform/tests/tools/pytest/doc/en/img/theuni.png b/testing/web-platform/tests/tools/pytest/doc/en/img/theuni.png Binary files differnew file mode 100644 index 000000000..abeb737e7 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/img/theuni.png diff --git a/testing/web-platform/tests/tools/pytest/doc/en/index.rst b/testing/web-platform/tests/tools/pytest/doc/en/index.rst new file mode 100644 index 000000000..04b4512da --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/index.rst @@ -0,0 +1,61 @@ + +.. _features: + +pytest: helps you write better programs +============================================= + +**a mature full-featured Python testing tool** + + - runs on Posix/Windows, Python 2.6-3.5, PyPy and (possibly still) Jython-2.5.1 + - free and open source software, distributed under the terms of the :ref:`MIT license <license>` + - **well tested** with more than a thousand tests against itself + - **strict backward compatibility policy** for safe pytest upgrades + - :ref:`comprehensive online <toc>` and `PDF documentation <pytest.pdf>`_ + - many :ref:`third party plugins <extplugins>` and :ref:`builtin helpers <pytest helpers>`, + - used in :ref:`many small and large projects and organisations <projects>` + - comes with many :ref:`tested examples <examples>` + +**provides easy no-boilerplate testing** + + - makes it :ref:`easy to get started <getstarted>`, + has many :ref:`usage options <usage>` + - :ref:`assert with the assert statement` + - helpful :ref:`traceback and failing assertion reporting <tbreportdemo>` + - :ref:`print debugging <printdebugging>` and :ref:`the + capturing of standard output during test execution <captures>` + +**scales from simple unit to complex functional testing** + + - :ref:`modular parametrizeable fixtures <fixture>` (new in 2.3, + continuously improved) + - :ref:`parametrized test functions <parametrized test functions>` + - :ref:`mark` + - :ref:`skipping` (improved in 2.4) + - :ref:`distribute tests to multiple CPUs <xdistcpu>` through :ref:`xdist plugin <xdist>` + - :ref:`continuously re-run failing tests <looponfailing>` + - :doc:`cache` + - flexible :ref:`Python test discovery` + +**integrates with other testing methods and tools**: + + - multi-paradigm: pytest can run ``nose``, ``unittest`` and + ``doctest`` style test suites, including running testcases made for + Django and trial + - supports :ref:`good integration practices <goodpractices>` + - supports extended :ref:`xUnit style setup <xunitsetup>` + - supports domain-specific :ref:`non-python tests` + - supports generating `test coverage reports + <https://pypi.python.org/pypi/pytest-cov>`_ + - supports :pep:`8` compliant coding styles in tests + +**extensive plugin and customization system**: + + - all collection, reporting, running aspects are delegated to hook functions + - customizations can be per-directory, per-project or per PyPI released plugin + - it is easy to add command line options or customize existing behaviour + - :ref:`easy to write your own plugins <writing-plugins>` + + +.. _`easy`: http://bruynooghe.blogspot.com/2009/12/skipping-slow-test-by-default-in-pytest.html + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/license.rst b/testing/web-platform/tests/tools/pytest/doc/en/license.rst new file mode 100644 index 000000000..3fc1dad52 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/license.rst @@ -0,0 +1,32 @@ +.. _license: + +License +------- + +Distributed under the terms of the `MIT`_ license, pytest is free and open source software. + +:: + + The MIT License (MIT) + + Copyright (c) 2004-2016 Holger Krekel and others + + Permission is hereby granted, free of charge, to any person obtaining a copy of + this software and associated documentation files (the "Software"), to deal in + the Software without restriction, including without limitation the rights to + use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is furnished to do + so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + +.. _`MIT`: https://github.com/pytest-dev/pytest/blob/master/LICENSE diff --git a/testing/web-platform/tests/tools/pytest/doc/en/links.inc b/testing/web-platform/tests/tools/pytest/doc/en/links.inc new file mode 100644 index 000000000..3d7863751 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/links.inc @@ -0,0 +1,21 @@ + +.. _`skipping plugin`: plugin/skipping.html +.. _`funcargs mechanism`: funcargs.html +.. _`doctest.py`: http://docs.python.org/library/doctest.html +.. _`xUnit style setup`: xunit_setup.html +.. _`pytest_nose`: plugin/nose.html +.. _`reStructured Text`: http://docutils.sourceforge.net +.. _`Python debugger`: http://docs.python.org/lib/module-pdb.html +.. _nose: https://nose.readthedocs.org/en/latest/ +.. _pytest: http://pypi.python.org/pypi/pytest +.. _mercurial: http://mercurial.selenic.com/wiki/ +.. _`setuptools`: http://pypi.python.org/pypi/setuptools +.. _`easy_install`: +.. _`distribute docs`: +.. _`distribute`: http://pypi.python.org/pypi/distribute +.. _`pip`: http://pypi.python.org/pypi/pip +.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv +.. _hudson: http://hudson-ci.org/ +.. _jenkins: http://jenkins-ci.org/ +.. _tox: http://testrun.org/tox +.. _pylib: http://py.readthedocs.org/en/latest/ diff --git a/testing/web-platform/tests/tools/pytest/doc/en/mark.rst b/testing/web-platform/tests/tools/pytest/doc/en/mark.rst new file mode 100644 index 000000000..ab9546d31 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/mark.rst @@ -0,0 +1,40 @@ + +.. _mark: + +Marking test functions with attributes +================================================================= + +.. currentmodule:: _pytest.mark + +By using the ``pytest.mark`` helper you can easily set +metadata on your test functions. There are +some builtin markers, for example: + +* :ref:`skipif <skipif>` - skip a test function if a certain condition is met +* :ref:`xfail <xfail>` - produce an "expected failure" outcome if a certain + condition is met +* :ref:`parametrize <parametrizemark>` to perform multiple calls + to the same test function. + +It's easy to create custom markers or to apply markers +to whole test classes or modules. See :ref:`mark examples` for examples +which also serve as documentation. + +.. note:: + + Marks can only be applied to tests, having no effect on + :ref:`fixtures <fixtures>`. + + +API reference for mark related objects +------------------------------------------------ + +.. autoclass:: MarkGenerator + :members: + +.. autoclass:: MarkDecorator + :members: + +.. autoclass:: MarkInfo + :members: + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/monkeypatch.rst b/testing/web-platform/tests/tools/pytest/doc/en/monkeypatch.rst new file mode 100644 index 000000000..4155a3a34 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/monkeypatch.rst @@ -0,0 +1,82 @@ + +Monkeypatching/mocking modules and environments +================================================================ + +.. currentmodule:: _pytest.monkeypatch + +Sometimes tests need to invoke functionality which depends +on global settings or which invokes code which cannot be easily +tested such as network access. The ``monkeypatch`` function argument +helps you to safely set/delete an attribute, dictionary item or +environment variable or to modify ``sys.path`` for importing. +See the `monkeypatch blog post`_ for some introduction material +and a discussion of its motivation. + +.. _`monkeypatch blog post`: http://tetamap.wordpress.com/2009/03/03/monkeypatching-in-unit-tests-done-right/ + +Simple example: monkeypatching functions +--------------------------------------------------- + +If you want to pretend that ``os.expanduser`` returns a certain +directory, you can use the :py:meth:`monkeypatch.setattr` method to +patch this function before calling into a function which uses it:: + + # content of test_module.py + import os.path + def getssh(): # pseudo application code + return os.path.join(os.path.expanduser("~admin"), '.ssh') + + def test_mytest(monkeypatch): + def mockreturn(path): + return '/abc' + monkeypatch.setattr(os.path, 'expanduser', mockreturn) + x = getssh() + assert x == '/abc/.ssh' + +Here our test function monkeypatches ``os.path.expanduser`` and +then calls into an function that calls it. After the test function +finishes the ``os.path.expanduser`` modification will be undone. + +example: preventing "requests" from remote operations +------------------------------------------------------ + +If you want to prevent the "requests" library from performing http +requests in all your tests, you can do:: + + # content of conftest.py + import pytest + @pytest.fixture(autouse=True) + def no_requests(monkeypatch): + monkeypatch.delattr("requests.sessions.Session.request") + +This autouse fixture will be executed for each test function and it +will delete the method ``request.session.Session.request`` +so that any attempts within tests to create http requests will fail. + +example: setting an attribute on some class +------------------------------------------------------ + +If you need to patch out ``os.getcwd()`` to return an artificial +value:: + + def test_some_interaction(monkeypatch): + monkeypatch.setattr("os.getcwd", lambda: "/") + +which is equivalent to the long form:: + + def test_some_interaction(monkeypatch): + import os + monkeypatch.setattr(os, "getcwd", lambda: "/") + + + +Method reference of the monkeypatch function argument +----------------------------------------------------- + +.. autoclass:: monkeypatch + :members: setattr, replace, delattr, setitem, delitem, setenv, delenv, syspath_prepend, chdir, undo + +``monkeypatch.setattr/delattr/delitem/delenv()`` all +by default raise an Exception if the target does not exist. +Pass ``raising=False`` if you want to skip this check. + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/naming20.rst b/testing/web-platform/tests/tools/pytest/doc/en/naming20.rst new file mode 100644 index 000000000..5a81df269 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/naming20.rst @@ -0,0 +1,20 @@ + +.. _naming20: + +New pytest names in 2.0 (flat is better than nested) +---------------------------------------------------- + +If you used older version of the ``py`` distribution (which +included the py.test command line tool and Python name space) +you accessed helpers and possibly collection classes through +the ``py.test`` Python namespaces. The new ``pytest`` +Python module flaty provides the same objects, following +these renaming rules:: + + py.test.XYZ -> pytest.XYZ + py.test.collect.XYZ -> pytest.XYZ + py.test.cmdline.main -> pytest.main + +The old ``py.test.*`` ways to access functionality remain +valid but you are encouraged to do global renaming according +to the above rules in your test code. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/nose.rst b/testing/web-platform/tests/tools/pytest/doc/en/nose.rst new file mode 100644 index 000000000..3b92e04cf --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/nose.rst @@ -0,0 +1,55 @@ +Running tests written for nose +======================================= + +.. include:: links.inc + +``pytest`` has basic support for running tests written for nose_. + +.. _nosestyle: + +Usage +------------- + +After :ref:`installation` type:: + + python setup.py develop # make sure tests can import our package + py.test # instead of 'nosetests' + +and you should be able to run your nose style tests and +make use of pytest's capabilities. + +Supported nose Idioms +---------------------- + +* setup and teardown at module/class/method level +* SkipTest exceptions and markers +* setup/teardown decorators +* yield-based tests and their setup +* ``__test__`` attribute on modules/classes/functions +* general usage of nose utilities + +Unsupported idioms / known issues +---------------------------------- + +- unittest-style ``setUp, tearDown, setUpClass, tearDownClass`` + are recognized only on ``unittest.TestCase`` classes but not + on plain classes. ``nose`` supports these methods also on plain + classes but pytest deliberately does not. As nose and pytest already + both support ``setup_class, teardown_class, setup_method, teardown_method`` + it doesn't seem useful to duplicate the unittest-API like nose does. + If you however rather think pytest should support the unittest-spelling on + plain classes please post `to this issue + <https://github.com/pytest-dev/pytest/issues/377/>`_. + +- nose imports test modules with the same import path (e.g. + ``tests.test_mod``) but different file system paths + (e.g. ``tests/test_mode.py`` and ``other/tests/test_mode.py``) + by extending sys.path/import semantics. pytest does not do that + but there is discussion in `issue268 <https://github.com/pytest-dev/pytest/issues/268>`_ for adding some support. Note that + `nose2 choose to avoid this sys.path/import hackery <https://nose2.readthedocs.org/en/latest/differences.html#test-discovery-and-loading>`_. + +- nose-style doctests are not collected and executed correctly, + also doctest fixtures don't work. + +- no nose-configuration is recognized + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/overview.rst b/testing/web-platform/tests/tools/pytest/doc/en/overview.rst new file mode 100644 index 000000000..eb2619775 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/overview.rst @@ -0,0 +1,13 @@ +================================================== +Getting started basics +================================================== + +.. toctree:: + :maxdepth: 2 + + getting-started + usage + goodpractices + projects + faq + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/parametrize.rst b/testing/web-platform/tests/tools/pytest/doc/en/parametrize.rst new file mode 100644 index 000000000..919ac93d2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/parametrize.rst @@ -0,0 +1,219 @@ + +.. _`test generators`: +.. _`parametrizing-tests`: +.. _`parametrized test functions`: +.. _`parametrize`: + +.. _`parametrize-basics`: + +Parametrizing fixtures and test functions +========================================================================== + +pytest supports test parametrization in several well-integrated ways: + +- :py:func:`pytest.fixture` allows to define :ref:`parametrization + at the level of fixture functions <fixture-parametrize>`. + +* `@pytest.mark.parametrize`_ allows to define parametrization at the + function or class level, provides multiple argument/fixture sets + for a particular test function or class. + +* `pytest_generate_tests`_ enables implementing your own custom + dynamic parametrization scheme or extensions. + +.. _parametrizemark: +.. _`@pytest.mark.parametrize`: + + +``@pytest.mark.parametrize``: parametrizing test functions +--------------------------------------------------------------------- + +.. regendoc: wipe + +.. versionadded:: 2.2 +.. versionchanged:: 2.4 + Several improvements. + +The builtin ``pytest.mark.parametrize`` decorator enables +parametrization of arguments for a test function. Here is a typical example +of a test function that implements checking that a certain input leads +to an expected output:: + + # content of test_expectation.py + import pytest + @pytest.mark.parametrize("test_input,expected", [ + ("3+5", 8), + ("2+4", 6), + ("6*9", 42), + ]) + def test_eval(test_input, expected): + assert eval(test_input) == expected + +Here, the ``@parametrize`` decorator defines three different ``(test_input,expected)`` +tuples so that the ``test_eval`` function will run three times using +them in turn:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 3 items + + test_expectation.py ..F + + ======= FAILURES ======== + _______ test_eval[6*9-42] ________ + + test_input = '6*9', expected = 42 + + @pytest.mark.parametrize("test_input,expected", [ + ("3+5", 8), + ("2+4", 6), + ("6*9", 42), + ]) + def test_eval(test_input, expected): + > assert eval(test_input) == expected + E assert 54 == 42 + E + where 54 = eval('6*9') + + test_expectation.py:8: AssertionError + ======= 1 failed, 2 passed in 0.12 seconds ======== + +As designed in this example, only one pair of input/output values fails +the simple test function. And as usual with test function arguments, +you can see the ``input`` and ``output`` values in the traceback. + +Note that you could also use the parametrize marker on a class or a module +(see :ref:`mark`) which would invoke several functions with the argument sets. + +It is also possible to mark individual test instances within parametrize, +for example with the builtin ``mark.xfail``:: + + # content of test_expectation.py + import pytest + @pytest.mark.parametrize("test_input,expected", [ + ("3+5", 8), + ("2+4", 6), + pytest.mark.xfail(("6*9", 42)), + ]) + def test_eval(test_input, expected): + assert eval(test_input) == expected + +Let's run this:: + + $ py.test + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 3 items + + test_expectation.py ..x + + ======= 2 passed, 1 xfailed in 0.12 seconds ======== + +The one parameter set which caused a failure previously now +shows up as an "xfailed (expected to fail)" test. + +To get all combinations of multiple parametrized arguments you can stack +``parametrize`` decorators:: + + import pytest + @pytest.mark.parametrize("x", [0, 1]) + @pytest.mark.parametrize("y", [2, 3]) + def test_foo(x, y): + pass + +This will run the test with the arguments set to x=0/y=2, x=0/y=3, x=1/y=2 and +x=1/y=3. + +.. note:: + + In versions prior to 2.4 one needed to specify the argument + names as a tuple. This remains valid but the simpler ``"name1,name2,..."`` + comma-separated-string syntax is now advertised first because + it's easier to write and produces less line noise. + +.. _`pytest_generate_tests`: + +Basic ``pytest_generate_tests`` example +--------------------------------------------- + +Sometimes you may want to implement your own parametrization scheme +or implement some dynamism for determining the parameters or scope +of a fixture. For this, you can use the ``pytest_generate_tests`` hook +which is called when collecting a test function. Through the passed in +``metafunc`` object you can inspect the requesting test context and, most +importantly, you can call ``metafunc.parametrize()`` to cause +parametrization. + +For example, let's say we want to run a test taking string inputs which +we want to set via a new ``pytest`` command line option. Let's first write +a simple test accepting a ``stringinput`` fixture function argument:: + + # content of test_strings.py + + def test_valid_string(stringinput): + assert stringinput.isalpha() + +Now we add a ``conftest.py`` file containing the addition of a +command line option and the parametrization of our test function:: + + # content of conftest.py + + def pytest_addoption(parser): + parser.addoption("--stringinput", action="append", default=[], + help="list of stringinputs to pass to test functions") + + def pytest_generate_tests(metafunc): + if 'stringinput' in metafunc.fixturenames: + metafunc.parametrize("stringinput", + metafunc.config.option.stringinput) + +If we now pass two stringinput values, our test will run twice:: + + $ py.test -q --stringinput="hello" --stringinput="world" test_strings.py + .. + 2 passed in 0.12 seconds + +Let's also run with a stringinput that will lead to a failing test:: + + $ py.test -q --stringinput="!" test_strings.py + F + ======= FAILURES ======== + _______ test_valid_string[!] ________ + + stringinput = '!' + + def test_valid_string(stringinput): + > assert stringinput.isalpha() + E assert <built-in method isalpha of str object at 0xdeadbeef>() + E + where <built-in method isalpha of str object at 0xdeadbeef> = '!'.isalpha + + test_strings.py:3: AssertionError + 1 failed in 0.12 seconds + +As expected our test function fails. + +If you don't specify a stringinput it will be skipped because +``metafunc.parametrize()`` will be called with an empty parameter +list:: + + $ py.test -q -rs test_strings.py + s + ======= short test summary info ======== + SKIP [1] $PYTHON_PREFIX/lib/python3.4/site-packages/_pytest/python.py:1419: got empty parameter set, function test_valid_string at $REGENDOC_TMPDIR/test_strings.py:1 + 1 skipped in 0.12 seconds + +For further examples, you might want to look at :ref:`more +parametrization examples <paramexamples>`. + +.. _`metafunc object`: + +The **metafunc** object +------------------------------------------- + +.. currentmodule:: _pytest.python +.. autoclass:: Metafunc + + .. automethod:: Metafunc.parametrize + .. automethod:: Metafunc.addcall(funcargs=None,id=_notexists,param=_notexists) diff --git a/testing/web-platform/tests/tools/pytest/doc/en/plugins.rst b/testing/web-platform/tests/tools/pytest/doc/en/plugins.rst new file mode 100644 index 000000000..e9b3f460c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/plugins.rst @@ -0,0 +1,159 @@ +.. _`external plugins`: +.. _`extplugins`: +.. _`using plugins`: + +Installing and Using plugins +============================ + +This section talks about installing and using third party plugins. +For writing your own plugins, please refer to :ref:`writing-plugins`. + +Installing a third party plugin can be easily done with ``pip``:: + + pip install pytest-NAME + pip uninstall pytest-NAME + +If a plugin is installed, ``pytest`` automatically finds and integrates it, +there is no need to activate it. + +Here is a little annotated list for some popular plugins: + +.. _`django`: https://www.djangoproject.com/ + +* `pytest-django <http://pypi.python.org/pypi/pytest-django>`_: write tests + for `django`_ apps, using pytest integration. + +* `pytest-twisted <http://pypi.python.org/pypi/pytest-twisted>`_: write tests + for `twisted <http://twistedmatrix.com>`_ apps, starting a reactor and + processing deferreds from test functions. + +* `pytest-catchlog <http://pypi.python.org/pypi/pytest-catchlog>`_: + to capture and assert about messages from the logging module + +* `pytest-cov <http://pypi.python.org/pypi/pytest-cov>`_: + coverage reporting, compatible with distributed testing + +* `pytest-xdist <http://pypi.python.org/pypi/pytest-xdist>`_: + to distribute tests to CPUs and remote hosts, to run in boxed + mode which allows to survive segmentation faults, to run in + looponfailing mode, automatically re-running failing tests + on file changes, see also :ref:`xdist` + +* `pytest-instafail <http://pypi.python.org/pypi/pytest-instafail>`_: + to report failures while the test run is happening. + +* `pytest-bdd <http://pypi.python.org/pypi/pytest-bdd>`_ and + `pytest-konira <http://pypi.python.org/pypi/pytest-konira>`_ + to write tests using behaviour-driven testing. + +* `pytest-timeout <http://pypi.python.org/pypi/pytest-timeout>`_: + to timeout tests based on function marks or global definitions. + +* `pytest-pep8 <http://pypi.python.org/pypi/pytest-pep8>`_: + a ``--pep8`` option to enable PEP8 compliance checking. + +* `pytest-flakes <https://pypi.python.org/pypi/pytest-flakes>`_: + check source code with pyflakes. + +* `oejskit <http://pypi.python.org/pypi/oejskit>`_: + a plugin to run javascript unittests in live browsers. + +To see a complete list of all plugins with their latest testing +status against different py.test and Python versions, please visit +`plugincompat <http://plugincompat.herokuapp.com/>`_. + +You may also discover more plugins through a `pytest- pypi.python.org search`_. + +.. _`available installable plugins`: +.. _`pytest- pypi.python.org search`: http://pypi.python.org/pypi?%3Aaction=search&term=pytest-&submit=search + + +Requiring/Loading plugins in a test module or conftest file +----------------------------------------------------------- + +You can require plugins in a test module or a conftest file like this:: + + pytest_plugins = "myapp.testsupport.myplugin", + +When the test module or conftest plugin is loaded the specified plugins +will be loaded as well. + + pytest_plugins = "myapp.testsupport.myplugin" + +which will import the specified module as a ``pytest`` plugin. + +.. _`findpluginname`: + +Finding out which plugins are active +------------------------------------ + +If you want to find out which plugins are active in your +environment you can type:: + + py.test --traceconfig + +and will get an extended test header which shows activated plugins +and their names. It will also print local plugins aka +:ref:`conftest.py <conftest>` files when they are loaded. + +.. _`cmdunregister`: + +Deactivating / unregistering a plugin by name +--------------------------------------------- + +You can prevent plugins from loading or unregister them:: + + py.test -p no:NAME + +This means that any subsequent try to activate/load the named +plugin will not work. + +If you want to unconditionally disable a plugin for a project, you can add +this option to your ``pytest.ini`` file: + +.. code-block:: ini + + [pytest] + addopts = -p no:NAME + +Alternatively to disable it only in certain environments (for example in a +CI server), you can set ``PYTEST_ADDOPTS`` environment variable to +``-p no:name``. + +See :ref:`findpluginname` for how to obtain the name of a plugin. + +.. _`builtin plugins`: + +Pytest default plugin reference +------------------------------- + + +You can find the source code for the following plugins +in the `pytest repository <https://github.com/pytest-dev/pytest>`_. + +.. autosummary:: + + _pytest.assertion + _pytest.cacheprovider + _pytest.capture + _pytest.config + _pytest.doctest + _pytest.genscript + _pytest.helpconfig + _pytest.junitxml + _pytest.mark + _pytest.monkeypatch + _pytest.nose + _pytest.pastebin + _pytest.pdb + _pytest.pytester + _pytest.python + _pytest.recwarn + _pytest.resultlog + _pytest.runner + _pytest.main + _pytest.skipping + _pytest.terminal + _pytest.tmpdir + _pytest.unittest + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/projects.rst b/testing/web-platform/tests/tools/pytest/doc/en/projects.rst new file mode 100644 index 000000000..76d004916 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/projects.rst @@ -0,0 +1,85 @@ +.. _projects: + +.. image:: img/gaynor3.png + :width: 400px + :align: right + +.. image:: img/theuni.png + :width: 400px + :align: right + +.. image:: img/cramer2.png + :width: 400px + :align: right + +.. image:: img/keleshev.png + :width: 400px + :align: right + + +Project examples +========================== + +Here are some examples of projects using ``pytest`` (please send notes via :ref:`contact`): + +* `PyPy <http://pypy.org>`_, Python with a JIT compiler, running over + `21000 tests <http://buildbot.pypy.org/summary?branch=%3Ctrunk%3E>`_ +* the `MoinMoin <http://moinmo.in>`_ Wiki Engine +* `sentry <https://getsentry.com/welcome/>`_, realtime app-maintenance and exception tracking +* `Astropy <http://www.astropy.org/>`_ and `affiliated packages <http://www.astropy.org/affiliated/index.html>`_ +* `tox <http://testrun.org/tox>`_, virtualenv/Hudson integration tool +* `PIDA <http://pida.co.uk>`_ framework for integrated development +* `PyPM <http://code.activestate.com/pypm/>`_ ActiveState's package manager +* `Fom <http://packages.python.org/Fom/>`_ a fluid object mapper for FluidDB +* `applib <https://github.com/ActiveState/applib>`_ cross-platform utilities +* `six <http://pypi.python.org/pypi/six/>`_ Python 2 and 3 compatibility utilities +* `pediapress <http://code.pediapress.com/wiki/wiki>`_ MediaWiki articles +* `mwlib <http://pypi.python.org/pypi/mwlib>`_ mediawiki parser and utility library +* `The Translate Toolkit <http://translate.sourceforge.net/wiki/toolkit/index>`_ for localization and conversion +* `execnet <http://codespeak.net/execnet>`_ rapid multi-Python deployment +* `pylib <http://py.rtfd.org>`_ cross-platform path, IO, dynamic code library +* `Pacha <http://pacha.cafepais.com/>`_ configuration management in five minutes +* `bbfreeze <http://pypi.python.org/pypi/bbfreeze>`_ create standalone executables from Python scripts +* `pdb++ <http://bitbucket.org/antocuni/pdb>`_ a fancier version of PDB +* `py-s3fuse <http://code.google.com/p/py-s3fuse/>`_ Amazon S3 FUSE based filesystem +* `waskr <http://code.google.com/p/waskr/>`_ WSGI Stats Middleware +* `guachi <http://code.google.com/p/guachi/>`_ global persistent configs for Python modules +* `Circuits <http://pypi.python.org/pypi/circuits>`_ lightweight Event Driven Framework +* `pygtk-helpers <http://bitbucket.org/aafshar/pygtkhelpers-main/>`_ easy interaction with PyGTK +* `QuantumCore <http://quantumcore.org/>`_ statusmessage and repoze openid plugin +* `pydataportability <http://pydataportability.net/>`_ libraries for managing the open web +* `XIST <http://www.livinglogic.de/Python/xist/>`_ extensible HTML/XML generator +* `tiddlyweb <http://pypi.python.org/pypi/tiddlyweb>`_ optionally headless, extensible RESTful datastore +* `fancycompleter <http://bitbucket.org/antocuni/fancycompleter/src>`_ for colorful tab-completion +* `Paludis <http://paludis.exherbo.org/>`_ tools for Gentoo Paludis package manager +* `Gerald <http://halfcooked.com/code/gerald/>`_ schema comparison tool +* `abjad <http://code.google.com/p/abjad/>`_ Python API for Formalized Score control +* `bu <http://packages.python.org/bu/>`_ a microscopic build system +* `katcp <https://bitbucket.org/hodgestar/katcp>`_ Telescope communication protocol over Twisted +* `kss plugin timer <http://pypi.python.org/pypi/kss.plugin.timer>`_ +* `pyudev <http://pyudev.readthedocs.org/en/latest/tests/plugins.html>`_ a pure Python binding to the Linux library libudev +* `pytest-localserver <https://bitbucket.org/basti/pytest-localserver/>`_ a plugin for pytest that provides a httpserver and smtpserver +* `pytest-monkeyplus <http://pypi.python.org/pypi/pytest-monkeyplus/>`_ a plugin that extends monkeypatch + +These projects help integrate ``pytest`` into other Python frameworks: + +* `pytest-django <http://pypi.python.org/pypi/pytest-django/>`_ for Django +* `zope.pytest <http://packages.python.org/zope.pytest/>`_ for Zope and Grok +* `pytest_gae <http://pypi.python.org/pypi/pytest_gae/0.2.1>`_ for Google App Engine +* There is `some work <https://github.com/Kotti/Kotti/blob/master/kotti/testing.py>`_ underway for Kotti, a CMS built in Pyramid/Pylons + + +Some organisations using pytest +----------------------------------- + +* `Square Kilometre Array, Cape Town <http://ska.ac.za/>`_ +* `Some Mozilla QA people <http://www.theautomatedtester.co.uk/blog/2011/pytest_and_xdist_plugin.html>`_ use pytest to distribute their Selenium tests +* `Tandberg <http://www.tandberg.com/>`_ +* `Shootq <http://web.shootq.com/>`_ +* `Stups department of Heinrich Heine University Duesseldorf <http://www.stups.uni-duesseldorf.de/projects.php>`_ +* `cellzome <http://www.cellzome.com/>`_ +* `Open End, Gothenborg <http://www.openend.se>`_ +* `Laboratory of Bioinformatics, Warsaw <http://genesilico.pl/>`_ +* `merlinux, Germany <http://merlinux.eu>`_ +* `ESSS, Brazil <http://www.esss.com.br>`_ +* many more ... (please be so kind to send a note via :ref:`contact`) diff --git a/testing/web-platform/tests/tools/pytest/doc/en/pytest.ini b/testing/web-platform/tests/tools/pytest/doc/en/pytest.ini new file mode 100644 index 000000000..760436056 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/pytest.ini @@ -0,0 +1,2 @@ +[pytest] +# just defined to prevent the root level tox.ini from kicking in diff --git a/testing/web-platform/tests/tools/pytest/doc/en/recwarn.rst b/testing/web-platform/tests/tools/pytest/doc/en/recwarn.rst new file mode 100644 index 000000000..3c42bfaaf --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/recwarn.rst @@ -0,0 +1,130 @@ + +Asserting Warnings +===================================================== + +.. _warns: + +Asserting warnings with the warns function +----------------------------------------------- + +.. versionadded:: 2.8 + +You can check that code raises a particular warning using ``pytest.warns``, +which works in a similar manner to :ref:`raises <assertraises>`:: + + import warnings + import pytest + + def test_warning(): + with pytest.warns(UserWarning): + warnings.warn("my warning", UserWarning) + +The test will fail if the warning in question is not raised. + +You can also call ``pytest.warns`` on a function or code string:: + + pytest.warns(expected_warning, func, *args, **kwargs) + pytest.warns(expected_warning, "func(*args, **kwargs)") + +The function also returns a list of all raised warnings (as +``warnings.WarningMessage`` objects), which you can query for +additional information:: + + with pytest.warns(RuntimeWarning) as record: + warnings.warn("another warning", RuntimeWarning) + + # check that only one warning was raised + assert len(record) == 1 + # check that the message matches + assert record[0].message.args[0] == "another warning" + +Alternatively, you can examine raised warnings in detail using the +:ref:`recwarn <recwarn>` fixture (see below). + +.. note:: + ``DeprecationWarning`` and ``PendingDeprecationWarning`` are treated + differently; see :ref:`ensuring_function_triggers`. + +.. _recwarn: + +Recording warnings +------------------------ + +You can record raised warnings either using ``pytest.warns`` or with +the ``recwarn`` fixture. + +To record with ``pytest.warns`` without asserting anything about the warnings, +pass ``None`` as the expected warning type:: + + with pytest.warns(None) as record: + warnings.warn("user", UserWarning) + warnings.warn("runtime", RuntimeWarning) + + assert len(record) == 2 + assert str(record[0].message) == "user" + assert str(record[1].message) == "runtime" + +The ``recwarn`` fixture will record warnings for the whole function:: + + import warnings + + def test_hello(recwarn): + warnings.warn("hello", UserWarning) + assert len(recwarn) == 1 + w = recwarn.pop(UserWarning) + assert issubclass(w.category, UserWarning) + assert str(w.message) == "hello" + assert w.filename + assert w.lineno + +Both ``recwarn`` and ``pytest.warns`` return the same interface for recorded +warnings: a WarningsRecorder instance. To view the recorded warnings, you can +iterate over this instance, call ``len`` on it to get the number of recorded +warnings, or index into it to get a particular recorded warning. It also +provides these methods: + +.. autoclass:: _pytest.recwarn.WarningsRecorder() + :members: + +Each recorded warning has the attributes ``message``, ``category``, +``filename``, ``lineno``, ``file``, and ``line``. The ``category`` is the +class of the warning. The ``message`` is the warning itself; calling +``str(message)`` will return the actual message of the warning. + +.. note:: + ``DeprecationWarning`` and ``PendingDeprecationWarning`` are treated + differently; see :ref:`ensuring_function_triggers`. + +.. _ensuring_function_triggers: + +Ensuring a function triggers a deprecation warning +------------------------------------------------------- + +You can also call a global helper for checking +that a certain function call triggers a ``DeprecationWarning`` or +``PendingDeprecationWarning``:: + + import pytest + + def test_global(): + pytest.deprecated_call(myfunction, 17) + +By default, ``DeprecationWarning`` and ``PendingDeprecationWarning`` will not be +caught when using ``pytest.warns`` or ``recwarn`` because default Python warnings filters hide +them. If you wish to record them in your own code, use the +command ``warnings.simplefilter('always')``:: + + import warnings + import pytest + + def test_deprecation(recwarn): + warnings.simplefilter('always') + warnings.warn("deprecated", DeprecationWarning) + assert len(recwarn) == 1 + assert recwarn.pop(DeprecationWarning) + +You can also use it as a contextmanager:: + + def test_global(): + with pytest.deprecated_call(): + myobject.deprecated_method() diff --git a/testing/web-platform/tests/tools/pytest/doc/en/setup.rst b/testing/web-platform/tests/tools/pytest/doc/en/setup.rst new file mode 100644 index 000000000..fe2353465 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/setup.rst @@ -0,0 +1,10 @@ + +setup: is now an "autouse fixture" +======================================================== + +During development prior to the pytest-2.3 release the name +``pytest.setup`` was used but before the release it was renamed +and moved to become part of the general fixture mechanism, +namely :ref:`autouse fixtures` + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/skipping.rst b/testing/web-platform/tests/tools/pytest/doc/en/skipping.rst new file mode 100644 index 000000000..4282afb77 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/skipping.rst @@ -0,0 +1,373 @@ +.. _`skip and xfail`: + +.. _skipping: + +Skip and xfail: dealing with tests that can not succeed +===================================================================== + +If you have test functions that cannot be run on certain platforms +or that you expect to fail you can mark them accordingly or you +may call helper functions during execution of setup or test functions. + +A *skip* means that you expect your test to pass unless the environment +(e.g. wrong Python interpreter, missing dependency) prevents it to run. +And *xfail* means that your test can run but you expect it to fail +because there is an implementation problem. + +``pytest`` counts and lists *skip* and *xfail* tests separately. Detailed +information about skipped/xfailed tests is not shown by default to avoid +cluttering the output. You can use the ``-r`` option to see details +corresponding to the "short" letters shown in the test progress:: + + py.test -rxs # show extra info on skips and xfails + +(See :ref:`how to change command line options defaults`) + +.. _skipif: +.. _`condition booleans`: + +Marking a test function to be skipped +------------------------------------------- + +.. versionadded:: 2.9 + +The simplest way to skip a test function is to mark it with the ``skip`` decorator +which may be passed an optional ``reason``: + +.. code-block:: python + + @pytest.mark.skip(reason="no way of currently testing this") + def test_the_unknown(): + ... + +``skipif`` +~~~~~~~~~~ + +.. versionadded:: 2.0, 2.4 + +If you wish to skip something conditionally then you can use ``skipif`` instead. +Here is an example of marking a test function to be skipped +when run on a Python3.3 interpreter:: + + import sys + @pytest.mark.skipif(sys.version_info < (3,3), + reason="requires python3.3") + def test_function(): + ... + +During test function setup the condition ("sys.version_info >= (3,3)") is +checked. If it evaluates to True, the test function will be skipped +with the specified reason. Note that pytest enforces specifying a reason +in order to report meaningful "skip reasons" (e.g. when using ``-rs``). +If the condition is a string, it will be evaluated as python expression. + +You can share skipif markers between modules. Consider this test module:: + + # content of test_mymodule.py + + import mymodule + minversion = pytest.mark.skipif(mymodule.__versioninfo__ < (1,1), + reason="at least mymodule-1.1 required") + @minversion + def test_function(): + ... + +You can import it from another test module:: + + # test_myothermodule.py + from test_mymodule import minversion + + @minversion + def test_anotherfunction(): + ... + +For larger test suites it's usually a good idea to have one file +where you define the markers which you then consistently apply +throughout your test suite. + +Alternatively, the pre pytest-2.4 way to specify :ref:`condition strings +<string conditions>` instead of booleans will remain fully supported in future +versions of pytest. It couldn't be easily used for importing markers +between test modules so it's no longer advertised as the primary method. + + +Skip all test functions of a class or module +--------------------------------------------- + +You can use the ``skipif`` decorator (and any other marker) on classes:: + + @pytest.mark.skipif(sys.platform == 'win32', + reason="does not run on windows") + class TestPosixCalls: + + def test_function(self): + "will not be setup or run under 'win32' platform" + +If the condition is true, this marker will produce a skip result for +each of the test methods. + +If you want to skip all test functions of a module, you must use +the ``pytestmark`` name on the global level: + +.. code-block:: python + + # test_module.py + pytestmark = pytest.mark.skipif(...) + +If multiple "skipif" decorators are applied to a test function, it +will be skipped if any of the skip conditions is true. + +.. _`whole class- or module level`: mark.html#scoped-marking + +.. _xfail: + +Mark a test function as expected to fail +------------------------------------------------------- + +You can use the ``xfail`` marker to indicate that you +expect a test to fail:: + + @pytest.mark.xfail + def test_function(): + ... + +This test will be run but no traceback will be reported +when it fails. Instead terminal reporting will list it in the +"expected to fail" (``XFAIL``) or "unexpectedly passing" (``XPASS``) sections. + +``strict`` parameter +~~~~~~~~~~~~~~~~~~~~ + +.. versionadded:: 2.9 + +Both ``XFAIL`` and ``XPASS`` don't fail the test suite, unless the ``strict`` keyword-only +parameter is passed as ``True``: + +.. code-block:: python + + @pytest.mark.xfail(strict=True) + def test_function(): + ... + + +This will make ``XPASS`` ("unexpectedly passing") results from this test to fail the test suite. + +You can change the default value of the ``strict`` parameter using the +``xfail_strict`` ini option: + +.. code-block:: ini + + [pytest] + xfail_strict=true + + +``reason`` parameter +~~~~~~~~~~~~~~~~~~~~ + +As with skipif_ you can also mark your expectation of a failure +on a particular platform:: + + @pytest.mark.xfail(sys.version_info >= (3,3), + reason="python3.3 api changes") + def test_function(): + ... + + +``raises`` parameter +~~~~~~~~~~~~~~~~~~~~ + +If you want to be more specific as to why the test is failing, you can specify +a single exception, or a list of exceptions, in the ``raises`` argument. + +.. code-block:: python + + @pytest.mark.xfail(raises=RuntimeError) + def test_function(): + ... + +Then the test will be reported as a regular failure if it fails with an +exception not mentioned in ``raises``. + +``run`` parameter +~~~~~~~~~~~~~~~~~ + +If a test should be marked as xfail and reported as such but should not be +even executed, use the ``run`` parameter as ``False``: + +.. code-block:: python + + @pytest.mark.xfail(run=False) + def test_function(): + ... + +This is specially useful for marking crashing tests for later inspection. + + +Ignoring xfail marks +~~~~~~~~~~~~~~~~~~~~ + +By specifying on the commandline:: + + pytest --runxfail + +you can force the running and reporting of an ``xfail`` marked test +as if it weren't marked at all. + +Examples +~~~~~~~~ + +Here is a simple test file with the several usages: + +.. literalinclude:: example/xfail_demo.py + +Running it with the report-on-xfail option gives this output:: + + example $ py.test -rx xfail_demo.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR/example, inifile: + collected 7 items + + xfail_demo.py xxxxxxx + ======= short test summary info ======== + XFAIL xfail_demo.py::test_hello + XFAIL xfail_demo.py::test_hello2 + reason: [NOTRUN] + XFAIL xfail_demo.py::test_hello3 + condition: hasattr(os, 'sep') + XFAIL xfail_demo.py::test_hello4 + bug 110 + XFAIL xfail_demo.py::test_hello5 + condition: pytest.__version__[0] != "17" + XFAIL xfail_demo.py::test_hello6 + reason: reason + XFAIL xfail_demo.py::test_hello7 + + ======= 7 xfailed in 0.12 seconds ======== + +xfail signature summary +~~~~~~~~~~~~~~~~~~~~~~~ + +Here's the signature of the ``xfail`` marker, using Python 3 keyword-only +arguments syntax: + +.. code-block:: python + + def xfail(condition=None, *, reason=None, raises=None, run=True, strict=False): + + + +.. _`skip/xfail with parametrize`: + +Skip/xfail with parametrize +--------------------------- + +It is possible to apply markers like skip and xfail to individual +test instances when using parametrize:: + + import pytest + + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + pytest.mark.xfail((1, 0)), + pytest.mark.xfail(reason="some bug")((1, 3)), + (2, 3), + (3, 4), + (4, 5), + pytest.mark.skipif("sys.version_info >= (3,0)")((10, 11)), + ]) + def test_increment(n, expected): + assert n + 1 == expected + + +Imperative xfail from within a test or setup function +------------------------------------------------------ + +If you cannot declare xfail- of skipif conditions at import +time you can also imperatively produce an according outcome +imperatively, in test or setup code:: + + def test_function(): + if not valid_config(): + pytest.xfail("failing configuration (but should work)") + # or + pytest.skip("unsupported configuration") + + +Skipping on a missing import dependency +-------------------------------------------------- + +You can use the following import helper at module level +or within a test or test setup function:: + + docutils = pytest.importorskip("docutils") + +If ``docutils`` cannot be imported here, this will lead to a +skip outcome of the test. You can also skip based on the +version number of a library:: + + docutils = pytest.importorskip("docutils", minversion="0.3") + +The version will be read from the specified +module's ``__version__`` attribute. + + +.. _string conditions: + +specifying conditions as strings versus booleans +---------------------------------------------------------- + +Prior to pytest-2.4 the only way to specify skipif/xfail conditions was +to use strings:: + + import sys + @pytest.mark.skipif("sys.version_info >= (3,3)") + def test_function(): + ... + +During test function setup the skipif condition is evaluated by calling +``eval('sys.version_info >= (3,0)', namespace)``. The namespace contains +all the module globals, and ``os`` and ``sys`` as a minimum. + +Since pytest-2.4 `condition booleans`_ are considered preferable +because markers can then be freely imported between test modules. +With strings you need to import not only the marker but all variables +everything used by the marker, which violates encapsulation. + +The reason for specifying the condition as a string was that ``pytest`` can +report a summary of skip conditions based purely on the condition string. +With conditions as booleans you are required to specify a ``reason`` string. + +Note that string conditions will remain fully supported and you are free +to use them if you have no need for cross-importing markers. + +The evaluation of a condition string in ``pytest.mark.skipif(conditionstring)`` +or ``pytest.mark.xfail(conditionstring)`` takes place in a namespace +dictionary which is constructed as follows: + +* the namespace is initialized by putting the ``sys`` and ``os`` modules + and the pytest ``config`` object into it. + +* updated with the module globals of the test function for which the + expression is applied. + +The pytest ``config`` object allows you to skip based on a test +configuration value which you might have added:: + + @pytest.mark.skipif("not config.getvalue('db')") + def test_function(...): + ... + +The equivalent with "boolean conditions" is:: + + @pytest.mark.skipif(not pytest.config.getvalue("db"), + reason="--db was not specified") + def test_function(...): + pass + +.. note:: + + You cannot use ``pytest.config.getvalue()`` in code + imported before py.test's argument parsing takes place. For example, + ``conftest.py`` files are imported before command line parsing and thus + ``config.getvalue()`` will not execute correctly. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/status.rst b/testing/web-platform/tests/tools/pytest/doc/en/status.rst new file mode 100644 index 000000000..3c7bf70ea --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/status.rst @@ -0,0 +1,5 @@ +pytest development status +================================ + +https://travis-ci.org/pytest-dev/pytest + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/talks.rst b/testing/web-platform/tests/tools/pytest/doc/en/talks.rst new file mode 100644 index 000000000..7a5221845 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/talks.rst @@ -0,0 +1,116 @@ + +Talks and Tutorials +========================== + +.. sidebar:: Next Open Trainings + + `professional testing with pytest and tox <http://www.python-academy.com/courses/specialtopics/python_course_testing.html>`_, 27-29th June 2016, Freiburg, Germany + +.. _`funcargs`: funcargs.html + +Talks and blog postings +--------------------------------------------- + +.. _`tutorial1 repository`: http://bitbucket.org/pytest-dev/pytest-tutorial1/ +.. _`pycon 2010 tutorial PDF`: http://bitbucket.org/pytest-dev/pytest-tutorial1/raw/tip/pytest-basic.pdf + +- `pytest - Rapid Simple Testing, Florian Bruhin, Swiss Python Summit 2016 + <https://www.youtube.com/watch?v=rCBHkQ_LVIs>`_. + +- `Improve your testing with Pytest and Mock, Gabe Hollombe, PyCon SG 2015 + <https://www.youtube.com/watch?v=RcN26hznmk4>`_. + +- `Introduction to pytest, Andreas Pelme, EuroPython 2014 + <https://www.youtube.com/watch?v=LdVJj65ikRY>`_. + +- `Advanced Uses of py.test Fixtures, Floris Bruynooghe, EuroPython + 2014 <https://www.youtube.com/watch?v=IBC_dxr-4ps>`_. + +- `Why i use py.test and maybe you should too, Andy Todd, Pycon AU 2013 + <https://www.youtube.com/watch?v=P-AhpukDIik>`_ + +- `3-part blog series about pytest from @pydanny alias Daniel Greenfeld (January + 2014) <http://pydanny.com/pytest-no-boilerplate-testing.html>`_ + +- `pytest: helps you write better Django apps, Andreas Pelme, DjangoCon + Europe 2014 <https://www.youtube.com/watch?v=aaArYVh6XSM>`_. + +- :ref:`fixtures` + +- `Testing Django Applications with pytest, Andreas Pelme, EuroPython + 2013 <https://www.youtube.com/watch?v=aUf8Fkb7TaY>`_. + +- `Testes pythonics com py.test, Vinicius Belchior Assef Neto, Plone + Conf 2013, Brazil <https://www.youtube.com/watch?v=QUKoq2K7bis>`_. + +- `Introduction to py.test fixtures, FOSDEM 2013, Floris Bruynooghe + <https://www.youtube.com/watch?v=bJhRW4eZMco>`_. + +- `pytest feature and release highlights, Holger Krekel (GERMAN, October 2013) + <http://pyvideo.org/video/2429/pytest-feature-and-new-release-highlights>`_ + +- `pytest introduction from Brian Okken (January 2013) + <http://pythontesting.net/framework/pytest-introduction/>`_ + +- `monkey patching done right`_ (blog post, consult `monkeypatch + plugin`_ for up-to-date API) + +Test parametrization: + +- `generating parametrized tests with funcargs`_ (uses deprecated ``addcall()`` API. +- `test generators and cached setup`_ +- `parametrizing tests, generalized`_ (blog post) +- `putting test-hooks into local or global plugins`_ (blog post) + +Assertion introspection: + +- `(07/2011) Behind the scenes of pytest's new assertion rewriting + <http://pybites.blogspot.com/2011/07/behind-scenes-of-pytests-new-assertion.html>`_ + +Distributed testing: + +- `simultaneously test your code on all platforms`_ (blog entry) + +Plugin specific examples: + +- `skipping slow tests by default in pytest`_ (blog entry) + +- `many examples in the docs for plugins`_ + +.. _`skipping slow tests by default in pytest`: http://bruynooghe.blogspot.com/2009/12/skipping-slow-test-by-default-in-pytest.html +.. _`many examples in the docs for plugins`: plugin/index.html +.. _`monkeypatch plugin`: plugin/monkeypatch.html +.. _`application setup in test functions with funcargs`: funcargs.html#appsetup +.. _`simultaneously test your code on all platforms`: http://tetamap.wordpress.com/2009/03/23/new-simultanously-test-your-code-on-all-platforms/ +.. _`monkey patching done right`: http://tetamap.wordpress.com/2009/03/03/monkeypatching-in-unit-tests-done-right/ +.. _`putting test-hooks into local or global plugins`: http://tetamap.wordpress.com/2009/05/14/putting-test-hooks-into-local-and-global-plugins/ +.. _`parametrizing tests, generalized`: http://tetamap.wordpress.com/2009/05/13/parametrizing-python-tests-generalized/ +.. _`generating parametrized tests with funcargs`: funcargs.html#test-generators +.. _`test generators and cached setup`: http://bruynooghe.blogspot.com/2010/06/pytest-test-generators-and-cached-setup.html + +Older conference talks and tutorials +---------------------------------------- + +- `pycon australia 2012 pytest talk from Brianna Laugher + <http://2012.pycon-au.org/schedule/52/view_talk?day=sunday>`_ (`video <http://www.youtube.com/watch?v=DTNejE9EraI>`_, `slides <http://www.slideshare.net/pfctdayelise/funcargs-other-fun-with-pytest>`_, `code <https://gist.github.com/3386951>`_) +- `pycon 2012 US talk video from Holger Krekel <http://www.youtube.com/watch?v=9LVqBQcFmyw>`_ +- `pycon 2010 tutorial PDF`_ and `tutorial1 repository`_ + +- `ep2009-rapidtesting.pdf`_ tutorial slides (July 2009): + + - testing terminology + - basic pytest usage, file system layout + - test function arguments (funcargs_) and test fixtures + - existing plugins + - distributed testing + +- `ep2009-pytest.pdf`_ 60 minute pytest talk, highlighting unique features and a roadmap (July 2009) + +- `pycon2009-pytest-introduction.zip`_ slides and files, extended version of pytest basic introduction, discusses more options, also introduces old-style xUnit setup, looponfailing and other features. + +- `pycon2009-pytest-advanced.pdf`_ contain a slightly older version of funcargs and distributed testing, compared to the EuroPython 2009 slides. + +.. _`ep2009-rapidtesting.pdf`: http://codespeak.net/download/py/ep2009-rapidtesting.pdf +.. _`ep2009-pytest.pdf`: http://codespeak.net/download/py/ep2009-pytest.pdf +.. _`pycon2009-pytest-introduction.zip`: http://codespeak.net/download/py/pycon2009-pytest-introduction.zip +.. _`pycon2009-pytest-advanced.pdf`: http://codespeak.net/download/py/pycon2009-pytest-advanced.pdf diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/attic.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/attic.rst new file mode 100644 index 000000000..6408c7225 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/attic.rst @@ -0,0 +1,117 @@ +=============================================== +ATTIC documentation +=============================================== + +XXX REVIEW and remove the below XXX + +Customizing the testing process +=============================== + +writing conftest.py files +----------------------------------- + +You may put conftest.py files containing project-specific +configuration in your project's root directory, it's usually +best to put it just into the same directory level as your +topmost ``__init__.py``. In fact, ``pytest`` performs +an "upwards" search starting from the directory that you specify +to be tested and will lookup configuration values right-to-left. +You may have options that reside e.g. in your home directory +but note that project specific settings will be considered +first. There is a flag that helps you debugging your +conftest.py configurations:: + + py.test --traceconfig + + +customizing the collecting and running process +----------------------------------------------- + +To introduce different test items you can create +one or more ``conftest.py`` files in your project. +When the collection process traverses directories +and modules the default collectors will produce +custom Collectors and Items if they are found +in a local ``conftest.py`` file. + + +Customizing the collection process in a module +---------------------------------------------- + +If you have a module where you want to take responsibility for +collecting your own test Items and possibly even for executing +a test then you can provide `generative tests`_ that yield +callables and possibly arguments as a tuple. This is especially +useful for calling application test machinery with different +parameter sets but counting each of the calls as a separate +tests. + +.. _`generative tests`: features.html#generative-tests + +The other extension possibility is about +specifying a custom test ``Item`` class which +is responsible for setting up and executing an underlying +test. Or you can extend the collection process for a whole +directory tree by putting Items in a ``conftest.py`` configuration file. +The collection process dynamically consults the *chain of conftest.py* +modules to determine collectors and items at ``Directory``, ``Module``, +``Class``, ``Function`` or ``Generator`` level respectively. + +Customizing execution of Items and Functions +---------------------------------------------------- + +- ``pytest.Function`` test items control execution + of a test function through its ``function.runtest()`` method. + This method is responsible for performing setup and teardown + ("Test Fixtures") for a test Function. + +- ``Function.execute(target, *args)`` methods are invoked by + the default ``Function.run()`` to actually execute a python + function with the given (usually empty set of) arguments. + +.. _`py-dev mailing list`: http://codespeak.net/mailman/listinfo/py-dev + + +.. _`test generators`: funcargs.html#test-generators + +.. _`generative tests`: + +generative tests: yielding parametrized tests +==================================================== + +Deprecated since 1.0 in favour of `test generators`_. + +*Generative tests* are test methods that are *generator functions* which +``yield`` callables and their arguments. This is useful for running a +test function multiple times against different parameters. Example:: + + def test_generative(): + for x in (42,17,49): + yield check, x + + def check(arg): + assert arg % 7 == 0 # second generated tests fails! + +Note that ``test_generative()`` will cause three tests +to get run, notably ``check(42)``, ``check(17)`` and ``check(49)`` +of which the middle one will obviously fail. + +To make it easier to distinguish the generated tests it is possible to specify an explicit name for them, like for example:: + + def test_generative(): + for x in (42,17,49): + yield "case %d" % x, check, x + + +disabling a test class +---------------------- + +If you want to disable a complete test class you +can set the class-level attribute ``disabled``. +For example, in order to avoid running some tests on Win32:: + + class TestPosixOnly: + disabled = sys.platform == 'win32' + + def test_xxx(self): + ... diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/config.html b/testing/web-platform/tests/tools/pytest/doc/en/test/config.html new file mode 100644 index 000000000..cba5a46f9 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/config.html @@ -0,0 +1,18 @@ +<html> + <head> + <meta http-equiv="refresh" content=" 1 ; URL=customize.html" /> + </head> + + <body> +<script type="text/javascript"> +var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); +document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); +</script> +<script type="text/javascript"> +try { +var pageTracker = _gat._getTracker("UA-7597274-3"); +pageTracker._trackPageview(); +} catch(err) {}</script> +</body> +</html> + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/dist.html b/testing/web-platform/tests/tools/pytest/doc/en/test/dist.html new file mode 100644 index 000000000..e328550a8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/dist.html @@ -0,0 +1,18 @@ +<html> + <head> + <meta http-equiv="refresh" content=" 1 ; URL=plugin/xdist.html" /> + </head> + + <body> +<script type="text/javascript"> +var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); +document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); +</script> +<script type="text/javascript"> +try { +var pageTracker = _gat._getTracker("UA-7597274-3"); +pageTracker._trackPageview(); +} catch(err) {}</script> +</body> +</html> + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/extend.html b/testing/web-platform/tests/tools/pytest/doc/en/test/extend.html new file mode 100644 index 000000000..cba5a46f9 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/extend.html @@ -0,0 +1,18 @@ +<html> + <head> + <meta http-equiv="refresh" content=" 1 ; URL=customize.html" /> + </head> + + <body> +<script type="text/javascript"> +var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); +document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); +</script> +<script type="text/javascript"> +try { +var pageTracker = _gat._getTracker("UA-7597274-3"); +pageTracker._trackPageview(); +} catch(err) {}</script> +</body> +</html> + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/index.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/index.rst new file mode 100644 index 000000000..1a3b5a54d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/index.rst @@ -0,0 +1,35 @@ +======================================= +pytest documentation index +======================================= + + +features_: overview and discussion of features. + +quickstart_: getting started with writing a simple test. + +`talks, tutorials, examples`_: tutorial examples, slides + +funcargs_: powerful parametrized test function setup + +`plugins`_: list of available plugins with usage examples and feature details. + +customize_: configuration, customization, extensions + +changelog_: history of changes covering last releases + +**Continuous Integration of pytest's own tests and plugins with Hudson**: + + `http://hudson.testrun.org/view/pytest`_ + +.. _`http://hudson.testrun.org/view/pytest`: http://hudson.testrun.org/view/pytest/ + + +.. _changelog: ../changelog.html +.. _`plugins`: plugin/index.html +.. _`talks, tutorials, examples`: talks.html +.. _quickstart: quickstart.html +.. _features: features.html +.. _funcargs: funcargs.html +.. _customize: customize.html + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/mission.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/mission.rst new file mode 100644 index 000000000..cda8d9a72 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/mission.rst @@ -0,0 +1,13 @@ + +Mission +==================================== + +``pytest`` strives to make testing a fun and no-boilerplate effort. + +The tool is distributed as a `pytest` package. Its project independent +``py.test`` command line tool helps you to: + +* rapidly collect and run tests +* run unit- or doctests, functional or integration tests +* distribute tests to multiple environments +* use local or global plugins for custom test types and setup diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/cov.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/cov.rst new file mode 100644 index 000000000..355093f25 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/cov.rst @@ -0,0 +1,230 @@ + +produce code coverage reports using the 'coverage' package, including support for distributed testing. +====================================================================================================== + + +.. contents:: + :local: + +This plugin produces coverage reports. It supports centralised testing and distributed testing in +both load and each modes. It also supports coverage of subprocesses. + +All features offered by the coverage package should be available, either through pytest-cov or +through coverage's config file. + + +Installation +------------ + +The `pytest-cov`_ package may be installed with pip or easy_install:: + + pip install pytest-cov + easy_install pytest-cov + +.. _`pytest-cov`: http://pypi.python.org/pypi/pytest-cov/ + + +Uninstallation +-------------- + +Uninstalling packages is supported by pip:: + + pip uninstall pytest-cov + +However easy_install does not provide an uninstall facility. + +.. IMPORTANT:: + + Ensure that you manually delete the init_covmain.pth file in your + site-packages directory. + + This file starts coverage collection of subprocesses if appropriate during + site initialization at python startup. + + +Usage +----- + +Centralised Testing +~~~~~~~~~~~~~~~~~~~ + +Centralised testing will report on the combined coverage of the main process and all of it's +subprocesses. + +Running centralised testing:: + + py.test --cov myproj tests/ + +Shows a terminal report:: + + -------------------- coverage: platform linux2, python 2.6.4-final-0 --------------------- + Name Stmts Miss Cover + ---------------------------------------- + myproj/__init__ 2 0 100% + myproj/myproj 257 13 94% + myproj/feature4286 94 7 92% + ---------------------------------------- + TOTAL 353 20 94% + + +Distributed Testing: Load +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Distributed testing with dist mode set to load will report on the combined coverage of all slaves. +The slaves may be spread out over any number of hosts and each slave may be located anywhere on the +file system. Each slave will have it's subprocesses measured. + +Running distributed testing with dist mode set to load:: + + py.test --cov myproj -n 2 tests/ + +Shows a terminal report:: + + -------------------- coverage: platform linux2, python 2.6.4-final-0 --------------------- + Name Stmts Miss Cover + ---------------------------------------- + myproj/__init__ 2 0 100% + myproj/myproj 257 13 94% + myproj/feature4286 94 7 92% + ---------------------------------------- + TOTAL 353 20 94% + + +Again but spread over different hosts and different directories:: + + py.test --cov myproj --dist load + --tx ssh=memedough@host1//chdir=testenv1 + --tx ssh=memedough@host2//chdir=/tmp/testenv2//python=/tmp/env1/bin/python + --rsyncdir myproj --rsyncdir tests --rsync examples + tests/ + +Shows a terminal report:: + + -------------------- coverage: platform linux2, python 2.6.4-final-0 --------------------- + Name Stmts Miss Cover + ---------------------------------------- + myproj/__init__ 2 0 100% + myproj/myproj 257 13 94% + myproj/feature4286 94 7 92% + ---------------------------------------- + TOTAL 353 20 94% + + +Distributed Testing: Each +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Distributed testing with dist mode set to each will report on the combined coverage of all slaves. +Since each slave is running all tests this allows generating a combined coverage report for multiple +environments. + +Running distributed testing with dist mode set to each:: + + py.test --cov myproj --dist each + --tx popen//chdir=/tmp/testenv3//python=/usr/local/python27/bin/python + --tx ssh=memedough@host2//chdir=/tmp/testenv4//python=/tmp/env2/bin/python + --rsyncdir myproj --rsyncdir tests --rsync examples + tests/ + +Shows a terminal report:: + + ---------------------------------------- coverage ---------------------------------------- + platform linux2, python 2.6.5-final-0 + platform linux2, python 2.7.0-final-0 + Name Stmts Miss Cover + ---------------------------------------- + myproj/__init__ 2 0 100% + myproj/myproj 257 13 94% + myproj/feature4286 94 7 92% + ---------------------------------------- + TOTAL 353 20 94% + + +Reporting +--------- + +It is possible to generate any combination of the reports for a single test run. + +The available reports are terminal (with or without missing line numbers shown), HTML, XML and +annotated source code. + +The terminal report without line numbers (default):: + + py.test --cov-report term --cov myproj tests/ + + -------------------- coverage: platform linux2, python 2.6.4-final-0 --------------------- + Name Stmts Miss Cover + ---------------------------------------- + myproj/__init__ 2 0 100% + myproj/myproj 257 13 94% + myproj/feature4286 94 7 92% + ---------------------------------------- + TOTAL 353 20 94% + + +The terminal report with line numbers:: + + py.test --cov-report term-missing --cov myproj tests/ + + -------------------- coverage: platform linux2, python 2.6.4-final-0 --------------------- + Name Stmts Miss Cover Missing + -------------------------------------------------- + myproj/__init__ 2 0 100% + myproj/myproj 257 13 94% 24-26, 99, 149, 233-236, 297-298, 369-370 + myproj/feature4286 94 7 92% 183-188, 197 + -------------------------------------------------- + TOTAL 353 20 94% + + +The remaining three reports output to files without showing anything on the terminal (useful for +when the output is going to a continuous integration server):: + + py.test --cov-report html --cov-report xml --cov-report annotate --cov myproj tests/ + + +Coverage Data File +------------------ + +The data file is erased at the beginning of testing to ensure clean data for each test run. + +The data file is left at the end of testing so that it is possible to use normal coverage tools to +examine it. + + +Limitations +----------- + +For distributed testing the slaves must have the pytest-cov package installed. This is needed since +the plugin must be registered through setuptools / distribute for pytest to start the plugin on the +slave. + +For subprocess measurement environment variables must make it from the main process to the +subprocess. The python used by the subprocess must have pytest-cov installed. The subprocess must +do normal site initialization so that the environment variables can be detected and coverage +started. + + +Acknowledgments +---------------- + +Holger Krekel for pytest with its distributed testing support. + +Ned Batchelder for coverage and its ability to combine the coverage results of parallel runs. + +Whilst this plugin has been built fresh from the ground up to support distributed testing it has +been influenced by the work done on pytest-coverage (Ross Lawley, James Mills, Holger Krekel) and +nose-cover (Jason Pellerin) which are other coverage plugins for pytest and nose respectively. + +No doubt others have contributed to these tools as well. + +command line options +-------------------- + + +``--cov=path`` + measure coverage for filesystem path (multi-allowed) +``--cov-report=type`` + type of report to generate: term, term-missing, annotate, html, xml (multi-allowed) +``--cov-config=path`` + config file for coverage, default: .coveragerc + +.. include:: links.txt diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/coverage.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/coverage.rst new file mode 100644 index 000000000..965b4a4ee --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/coverage.rst @@ -0,0 +1,51 @@ + +Write and report coverage data with the 'coverage' package. +=========================================================== + + +.. contents:: + :local: + +Note: Original code by Ross Lawley. + +Install +-------------- + +Use pip to (un)install:: + + pip install pytest-coverage + pip uninstall pytest-coverage + +or alternatively use easy_install to install:: + + easy_install pytest-coverage + + +Usage +------------- + +To get full test coverage reports for a particular package type:: + + py.test --cover-report=report + +command line options +-------------------- + + +``--cover=COVERPACKAGES`` + (multi allowed) only include info from specified package. +``--cover-report=REPORT_TYPE`` + html: Directory for html output. + report: Output a text report. + annotate: Annotate your source code for which lines were executed and which were not. + xml: Output an xml report compatible with the cobertura plugin for hudson. +``--cover-directory=DIRECTORY`` + Directory for the reports (html / annotate results) defaults to ./coverage +``--cover-xml-file=XML_FILE`` + File for the xml report defaults to ./coverage.xml +``--cover-show-missing`` + Show missing files +``--cover-ignore-errors=IGNORE_ERRORS`` + Ignore errors of finding source files for code. + +.. include:: links.txt diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/django.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/django.rst new file mode 100644 index 000000000..061497b38 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/django.rst @@ -0,0 +1,7 @@ +pytest_django plugin (EXTERNAL) +========================================== + +pytest_django is a plugin for ``pytest`` that provides a set of useful tools for testing Django applications, checkout Ben Firshman's `pytest_django github page`_. + +.. _`pytest_django github page`: http://github.com/bfirsh/pytest_django/tree/master + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/figleaf.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/figleaf.rst new file mode 100644 index 000000000..86e0da65b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/figleaf.rst @@ -0,0 +1,44 @@ + +report test coverage using the 'figleaf' package. +================================================= + + +.. contents:: + :local: + +Install +--------------- + +To install the plugin issue:: + + easy_install pytest-figleaf # or + pip install pytest-figleaf + +and if you are using pip you can also uninstall:: + + pip uninstall pytest-figleaf + + +Usage +--------------- + +After installation you can simply type:: + + py.test --figleaf [...] + +to enable figleaf coverage in your test run. A default ".figleaf" data file +and "html" directory will be created. You can use command line options +to control where data and html files are created. + +command line options +-------------------- + + +``--figleaf`` + trace python coverage with figleaf and write HTML for files below the current working dir +``--fig-data=dir`` + set tracing file, default: ".figleaf". +``--fig-html=dir`` + set html reporting dir, default "html". + +.. include:: links.txt diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/genscript.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/genscript.rst new file mode 100644 index 000000000..ee80f233f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/genscript.rst @@ -0,0 +1,28 @@ + +(deprecated) generate standalone test script to be distributed along with an application. +============================================================================ + + +.. contents:: + :local: + + + +command line options +-------------------- + + +``--genscript=path`` + create standalone ``pytest`` script at given target path. + +Start improving this plugin in 30 seconds +========================================= + + +1. Download `pytest_genscript.py`_ plugin source code +2. put it somewhere as ``pytest_genscript.py`` into your import path +3. a subsequent ``pytest`` run will use your local version + +Checkout customize_, other plugins_ or `get in contact`_. + +.. include:: links.txt diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/helpconfig.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/helpconfig.rst new file mode 100644 index 000000000..9b5b8cddd --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/helpconfig.rst @@ -0,0 +1,38 @@ + +provide version info, conftest/environment config names. +======================================================== + + +.. contents:: + :local: + + + +command line options +-------------------- + + +``--version`` + display py lib version and import information. +``-p name`` + early-load given plugin (multi-allowed). +``--traceconfig`` + trace considerations of conftest.py files. +``--nomagic`` + don't reinterpret asserts, no traceback cutting. +``--debug`` + generate and show internal debugging information. +``--help-config`` + show available conftest.py and ENV-variable names. + +Start improving this plugin in 30 seconds +========================================= + + +1. Download `pytest_helpconfig.py`_ plugin source code +2. put it somewhere as ``pytest_helpconfig.py`` into your import path +3. a subsequent ``pytest`` run will use your local version + +Checkout customize_, other plugins_ or `get in contact`_. + +.. include:: links.txt diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/index.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/index.rst new file mode 100644 index 000000000..853a4dce6 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/index.rst @@ -0,0 +1,68 @@ + +advanced python testing +======================= + +skipping_ advanced skipping for python test functions, classes or modules. + +mark_ generic mechanism for marking python functions. + +pdb_ interactive debugging with the Python Debugger. + +figleaf_ (external) report test coverage using the 'figleaf' package. + +monkeypatch_ safely patch object attributes, dicts and environment variables. + +coverage_ (external) Write and report coverage data with the 'coverage' package. + +cov_ (external) produce code coverage reports using the 'coverage' package, including support for distributed testing. + +capture_ configurable per-test stdout/stderr capturing mechanisms. + +capturelog_ (external) capture output of logging module. + +recwarn_ helpers for asserting deprecation and other warnings. + +tmpdir_ provide temporary directories to test functions. + + +distributed testing, CI and deployment +====================================== + +xdist_ (external) loop on failing tests, distribute test runs to CPUs and hosts. + +pastebin_ submit failure or test session information to a pastebin service. + +junitxml_ logging of test results in JUnit-XML format, for use with Hudson + +resultlog_ non-xml machine-readable logging of test results. + +genscript_ generate standalone test script to be distributed along with an application. + + +testing domains and conventions codecheckers +============================================ + +oejskit_ (external) run javascript tests in real life browsers + +django_ (external) for testing django applications + +unittest_ automatically discover and run traditional "unittest.py" style tests. + +nose_ nose-compatibility plugin: allow to run nose test suites natively. + +doctest_ collect and execute doctests from modules and test files. + +restdoc_ perform ReST syntax, local and remote reference tests on .rst/.txt files. + + +internal, debugging, help functionality +======================================= + +helpconfig_ provide version info, conftest/environment config names. + +terminal_ Implements terminal reporting of the full testing process. + +hooklog_ log invocations of extension hooks to a file. + + +.. include:: links.txt diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/links.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/links.rst new file mode 100644 index 000000000..aa965e730 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/links.rst @@ -0,0 +1,47 @@ +.. _`helpconfig`: helpconfig.html +.. _`pytest_recwarn.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_recwarn.py +.. _`unittest`: unittest.html +.. _`pytest_monkeypatch.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_monkeypatch.py +.. _`pytest_genscript.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_genscript.py +.. _`pastebin`: pastebin.html +.. _`skipping`: skipping.html +.. _`genscript`: genscript.html +.. _`plugins`: index.html +.. _`mark`: mark.html +.. _`tmpdir`: tmpdir.html +.. _`pytest_doctest.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_doctest.py +.. _`capture`: capture.html +.. _`pytest_nose.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_nose.py +.. _`pytest_restdoc.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_restdoc.py +.. _`restdoc`: restdoc.html +.. _`xdist`: xdist.html +.. _`pytest_pastebin.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_pastebin.py +.. _`pytest_tmpdir.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_tmpdir.py +.. _`terminal`: terminal.html +.. _`pytest_hooklog.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_hooklog.py +.. _`capturelog`: capturelog.html +.. _`junitxml`: junitxml.html +.. _`pytest_skipping.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_skipping.py +.. _`checkout the pytest development version`: ../../install.html#checkout +.. _`pytest_helpconfig.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_helpconfig.py +.. _`oejskit`: oejskit.html +.. _`doctest`: doctest.html +.. _`pytest_mark.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_mark.py +.. _`get in contact`: ../../contact.html +.. _`pytest_capture.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_capture.py +.. _`figleaf`: figleaf.html +.. _`customize`: ../customize.html +.. _`hooklog`: hooklog.html +.. _`pytest_terminal.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_terminal.py +.. _`recwarn`: recwarn.html +.. _`pytest_pdb.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_pdb.py +.. _`monkeypatch`: monkeypatch.html +.. _`coverage`: coverage.html +.. _`resultlog`: resultlog.html +.. _`cov`: cov.html +.. _`pytest_junitxml.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_junitxml.py +.. _`django`: django.html +.. _`pytest_unittest.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_unittest.py +.. _`nose`: nose.html +.. _`pytest_resultlog.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.3.4/py/_plugin/pytest_resultlog.py +.. _`pdb`: pdb.html diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/nose.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/nose.rst new file mode 100644 index 000000000..f3aa7d705 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/nose.rst @@ -0,0 +1,56 @@ + +nose-compatibility plugin: allow to run nose test suites natively. +================================================================== + + +.. contents:: + :local: + +This is an experimental plugin for allowing to run tests written +in 'nosetests' style with ``pytest``. + +Usage +------------- + +type:: + + py.test # instead of 'nosetests' + +and you should be able to run nose style tests and at the same +time can make full use of pytest's capabilities. + +Supported nose Idioms +---------------------- + +* setup and teardown at module/class/method level +* SkipTest exceptions and markers +* setup/teardown decorators +* yield-based tests and their setup +* general usage of nose utilities + +Unsupported idioms / issues +---------------------------------- + +- nose-style doctests are not collected and executed correctly, + also fixtures don't work. + +- no nose-configuration is recognized + +If you find other issues or have suggestions please run:: + + py.test --pastebin=all + +and send the resulting URL to a ``pytest`` contact channel, +at best to the mailing list. + +Start improving this plugin in 30 seconds +========================================= + + +1. Download `pytest_nose.py`_ plugin source code +2. put it somewhere as ``pytest_nose.py`` into your import path +3. a subsequent ``pytest`` run will use your local version + +Checkout customize_, other plugins_ or `get in contact`_. + +.. include:: links.txt diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/oejskit.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/oejskit.rst new file mode 100644 index 000000000..4995aa17c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/oejskit.rst @@ -0,0 +1,12 @@ +pytest_oejskit plugin (EXTERNAL) +========================================== + +The `oejskit`_ offers a ``pytest`` plugin for running Javascript tests in live browsers. Running inside the browsers comes with some speed cost, on the other hand it means for example the code is tested against the real-word DOM implementations. +The approach enables to write integration tests such that the JavaScript code is tested against server-side Python code mocked as necessary. Any server-side framework that can already be exposed through WSGI (or for which a subset of WSGI can be written to accommodate the jskit own needs) can play along. + +For more info and download please visit the `oejskit PyPI`_ page. + +.. _`oejskit`: +.. _`oejskit PyPI`: http://pypi.python.org/pypi/oejskit + +.. source link 'http://bitbucket.org/pedronis/js-infrastructure/src/tip/pytest_jstests.py', diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/terminal.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/terminal.rst new file mode 100644 index 000000000..214c24dfc --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/terminal.rst @@ -0,0 +1,40 @@ + +Implements terminal reporting of the full testing process. +========================================================== + + +.. contents:: + :local: + +This is a good source for looking at the various reporting hooks. + +command line options +-------------------- + + +``-v, --verbose`` + increase verbosity. +``-r chars`` + show extra test summary info as specified by chars (f)ailed, (s)skipped, (x)failed, (X)passed. +``-l, --showlocals`` + show locals in tracebacks (disabled by default). +``--report=opts`` + (deprecated, use -r) +``--tb=style`` + traceback print mode (long/short/line/no). +``--fulltrace`` + don't cut any tracebacks (default is to cut). +``--fixtures`` + show available function arguments, sorted by plugin + +Start improving this plugin in 30 seconds +========================================= + + +1. Download `pytest_terminal.py`_ plugin source code +2. put it somewhere as ``pytest_terminal.py`` into your import path +3. a subsequent ``pytest`` run will use your local version + +Checkout customize_, other plugins_ or `get in contact`_. + +.. include:: links.txt diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/xdist.rst b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/xdist.rst new file mode 100644 index 000000000..7ab6cdc8b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/plugin/xdist.rst @@ -0,0 +1,172 @@ + +loop on failing tests, distribute test runs to CPUs and hosts. +============================================================== + + +.. contents:: + :local: + +The `pytest-xdist`_ plugin extends ``pytest`` with some unique +test execution modes: + +* Looponfail: run your tests repeatedly in a subprocess. After each run + ``pytest`` waits until a file in your project changes and then re-runs the + previously failing tests. This is repeated until all tests pass after which + again a full run is performed. + +* Load-balancing: if you have multiple CPUs or hosts you can use + those for a combined test run. This allows to speed up + development or to use special resources of remote machines. + +* Multi-Platform coverage: you can specify different Python interpreters + or different platforms and run tests in parallel on all of them. + +Before running tests remotely, ``pytest`` efficiently synchronizes your +program source code to the remote place. All test results +are reported back and displayed to your local test session. +You may specify different Python versions and interpreters. + +.. _`pytest-xdist`: http://pypi.python.org/pypi/pytest-xdist + +Usage examples +--------------------- + +Speed up test runs by sending tests to multiple CPUs ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +To send tests to multiple CPUs, type:: + + py.test -n NUM + +Especially for longer running tests or tests requiring +a lot of IO this can lead to considerable speed ups. + + +Running tests in a Python subprocess ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +To instantiate a python2.4 sub process and send tests to it, you may type:: + + py.test -d --tx popen//python=python2.4 + +This will start a subprocess which is run with the "python2.4" +Python interpreter, found in your system binary lookup path. + +If you prefix the --tx option value like this:: + + --tx 3*popen//python=python2.4 + +then three subprocesses would be created and tests +will be load-balanced across these three processes. + + +Sending tests to remote SSH accounts ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Suppose you have a package ``mypkg`` which contains some +tests that you can successfully run locally. And you +have a ssh-reachable machine ``myhost``. Then +you can ad-hoc distribute your tests by typing:: + + py.test -d --tx ssh=myhostpopen --rsyncdir mypkg mypkg + +This will synchronize your ``mypkg`` package directory +to an remote ssh account and then locally collect tests +and send them to remote places for execution. + +You can specify multiple ``--rsyncdir`` directories +to be sent to the remote side. + +**NOTE:** For ``pytest`` to collect and send tests correctly +you not only need to make sure all code and tests +directories are rsynced, but that any test (sub) directory +also has an ``__init__.py`` file because internally +``pytest`` references tests using their fully qualified python +module path. **You will otherwise get strange errors** +during setup of the remote side. + +Sending tests to remote Socket Servers ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Download the single-module `socketserver.py`_ Python program +and run it like this:: + + python socketserver.py + +It will tell you that it starts listening on the default +port. You can now on your home machine specify this +new socket host with something like this:: + + py.test -d --tx socket=192.168.1.102:8888 --rsyncdir mypkg mypkg + + +.. _`atonce`: + +Running tests on many platforms at once ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The basic command to run tests on multiple platforms is:: + + py.test --dist=each --tx=spec1 --tx=spec2 + +If you specify a windows host, an OSX host and a Linux +environment this command will send each tests to all +platforms - and report back failures from all platforms +at once. The specifications strings use the `xspec syntax`_. + +.. _`xspec syntax`: http://codespeak.net/execnet/trunk/basics.html#xspec + +.. _`socketserver.py`: http://codespeak.net/svn/py/dist/py/execnet/script/socketserver.py + +.. _`execnet`: http://codespeak.net/execnet + +Specifying test exec environments in a conftest.py ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Instead of specifying command line options, you can +put options values in a ``conftest.py`` file like this:: + + option_tx = ['ssh=myhost//python=python2.7', 'popen//python=python2.7'] + option_dist = True + +Any commandline ``--tx`` specifications will add to the list of +available execution environments. + +Specifying "rsync" dirs in a conftest.py ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +In your ``mypkg/conftest.py`` you may specify directories to synchronise +or to exclude:: + + rsyncdirs = ['.', '../plugins'] + rsyncignore = ['_cache'] + +These directory specifications are relative to the directory +where the ``conftest.py`` is found. + +command line options +-------------------- + + +``-f, --looponfail`` + run tests in subprocess, wait for modified files and re-run failing test set until all pass. +``-n numprocesses`` + shortcut for '--dist=load --tx=NUM*popen' +``--boxed`` + box each test run in a separate process (unix) +``--dist=distmode`` + set mode for distributing tests to exec environments. + + each: send each test to each available environment. + + load: send each test to one available environment so it is run only once. + + (default) no: run tests inprocess, don't distribute. +``--tx=xspec`` + add a test execution environment. some examples: --tx popen//python=python2.7 --tx socket=192.168.1.102:8888 --tx ssh=user@codespeak.net//chdir=testcache +``-d`` + load-balance tests. shortcut for '--dist=load' +``--rsyncdir=dir1`` + add directory for rsyncing to remote tx nodes. + +.. include:: links.txt diff --git a/testing/web-platform/tests/tools/pytest/doc/en/test/test.html b/testing/web-platform/tests/tools/pytest/doc/en/test/test.html new file mode 100644 index 000000000..7d00f718a --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/test/test.html @@ -0,0 +1,18 @@ +<html> + <head> + <meta http-equiv="refresh" content=" 1 ; URL=index.html" /> + </head> + + <body> +<script type="text/javascript"> +var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); +document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); +</script> +<script type="text/javascript"> +try { +var pageTracker = _gat._getTracker("UA-7597274-3"); +pageTracker._trackPageview(); +} catch(err) {}</script> +</body> +</html> + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/tmpdir.rst b/testing/web-platform/tests/tools/pytest/doc/en/tmpdir.rst new file mode 100644 index 000000000..f8935b8ce --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/tmpdir.rst @@ -0,0 +1,111 @@ + +.. _`tmpdir handling`: +.. _tmpdir: + +Temporary directories and files +================================================ + +The 'tmpdir' fixture +-------------------- + +You can use the ``tmpdir`` fixture which will +provide a temporary directory unique to the test invocation, +created in the `base temporary directory`_. + +``tmpdir`` is a `py.path.local`_ object which offers ``os.path`` methods +and more. Here is an example test usage:: + + # content of test_tmpdir.py + import os + def test_create_file(tmpdir): + p = tmpdir.mkdir("sub").join("hello.txt") + p.write("content") + assert p.read() == "content" + assert len(tmpdir.listdir()) == 1 + assert 0 + +Running this would result in a passed test except for the last +``assert 0`` line which we use to look at values:: + + $ py.test test_tmpdir.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 1 items + + test_tmpdir.py F + + ======= FAILURES ======== + _______ test_create_file ________ + + tmpdir = local('PYTEST_TMPDIR/test_create_file0') + + def test_create_file(tmpdir): + p = tmpdir.mkdir("sub").join("hello.txt") + p.write("content") + assert p.read() == "content" + assert len(tmpdir.listdir()) == 1 + > assert 0 + E assert 0 + + test_tmpdir.py:7: AssertionError + ======= 1 failed in 0.12 seconds ======== + +The 'tmpdir_factory' fixture +---------------------------- + +.. versionadded:: 2.8 + +The ``tmpdir_factory`` is a session-scoped fixture which can be used +to create arbitrary temporary directories from any other fixture or test. + +For example, suppose your test suite needs a large image on disk, which is +generated procedurally. Instead of computing the same image for each test +that uses it into its own ``tmpdir``, you can generate it once per-session +to save time: + +.. code-block:: python + + # contents of conftest.py + import pytest + + @pytest.fixture(scope='session') + def image_file(tmpdir_factory): + img = compute_expensive_image() + fn = tmpdir_factory.mktemp('data').join('img.png') + img.save(str(fn)) + return fn + + # contents of test_image.py + def test_histogram(image_file): + img = load_image(image_file) + # compute and test histogram + +``tmpdir_factory`` instances have the following methods: + +.. currentmodule:: _pytest.tmpdir + +.. automethod:: TempdirFactory.mktemp +.. automethod:: TempdirFactory.getbasetemp + +.. _`base temporary directory`: + +The default base temporary directory +----------------------------------------------- + +Temporary directories are by default created as sub-directories of +the system temporary directory. The base name will be ``pytest-NUM`` where +``NUM`` will be incremented with each test run. Moreover, entries older +than 3 temporary directories will be removed. + +You can override the default temporary directory setting like this:: + + py.test --basetemp=mydir + +When distributing tests on the local machine, ``pytest`` takes care to +configure a basetemp directory for the sub processes such that all temporary +data lands below a single per-test run basetemp directory. + +.. _`py.path.local`: http://py.rtfd.org/en/latest/path.html + + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/unittest.rst b/testing/web-platform/tests/tools/pytest/doc/en/unittest.rst new file mode 100644 index 000000000..ce99bd118 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/unittest.rst @@ -0,0 +1,190 @@ + +.. _`unittest.TestCase`: + +Support for unittest.TestCase / Integration of fixtures +===================================================================== + +.. _`unittest.py style`: http://docs.python.org/library/unittest.html + +``pytest`` has support for running Python `unittest.py style`_ tests. +It's meant for leveraging existing unittest-style projects +to use pytest features. Concretely, pytest will automatically +collect ``unittest.TestCase`` subclasses and their ``test`` methods in +test files. It will invoke typical setup/teardown methods and +generally try to make test suites written to run on unittest, to also +run using ``pytest``. We assume here that you are familiar with writing +``unittest.TestCase`` style tests and rather focus on +integration aspects. + +Usage +------------------------------------------------------------------- + +After :ref:`installation` type:: + + py.test + +and you should be able to run your unittest-style tests if they +are contained in ``test_*`` modules. If that works for you then +you can make use of most :ref:`pytest features <features>`, for example +``--pdb`` debugging in failures, using :ref:`plain assert-statements <assert>`, +:ref:`more informative tracebacks <tbreportdemo>`, stdout-capturing or +distributing tests to multiple CPUs via the ``-nNUM`` option if you +installed the ``pytest-xdist`` plugin. Please refer to +the general ``pytest`` documentation for many more examples. + +Mixing pytest fixtures into unittest.TestCase style tests +----------------------------------------------------------- + +Running your unittest with ``pytest`` allows you to use its +:ref:`fixture mechanism <fixture>` with ``unittest.TestCase`` style +tests. Assuming you have at least skimmed the pytest fixture features, +let's jump-start into an example that integrates a pytest ``db_class`` +fixture, setting up a class-cached database object, and then reference +it from a unittest-style test:: + + # content of conftest.py + + # we define a fixture function below and it will be "used" by + # referencing its name from tests + + import pytest + + @pytest.fixture(scope="class") + def db_class(request): + class DummyDB: + pass + # set a class attribute on the invoking test context + request.cls.db = DummyDB() + +This defines a fixture function ``db_class`` which - if used - is +called once for each test class and which sets the class-level +``db`` attribute to a ``DummyDB`` instance. The fixture function +achieves this by receiving a special ``request`` object which gives +access to :ref:`the requesting test context <request-context>` such +as the ``cls`` attribute, denoting the class from which the fixture +is used. This architecture de-couples fixture writing from actual test +code and allows re-use of the fixture by a minimal reference, the fixture +name. So let's write an actual ``unittest.TestCase`` class using our +fixture definition:: + + # content of test_unittest_db.py + + import unittest + import pytest + + @pytest.mark.usefixtures("db_class") + class MyTest(unittest.TestCase): + def test_method1(self): + assert hasattr(self, "db") + assert 0, self.db # fail for demo purposes + + def test_method2(self): + assert 0, self.db # fail for demo purposes + +The ``@pytest.mark.usefixtures("db_class")`` class-decorator makes sure that +the pytest fixture function ``db_class`` is called once per class. +Due to the deliberately failing assert statements, we can take a look at +the ``self.db`` values in the traceback:: + + $ py.test test_unittest_db.py + ======= test session starts ======== + platform linux -- Python 3.4.0, pytest-2.9.1, py-1.4.31, pluggy-0.3.1 + rootdir: $REGENDOC_TMPDIR, inifile: + collected 2 items + + test_unittest_db.py FF + + ======= FAILURES ======== + _______ MyTest.test_method1 ________ + + self = <test_unittest_db.MyTest testMethod=test_method1> + + def test_method1(self): + assert hasattr(self, "db") + > assert 0, self.db # fail for demo purposes + E AssertionError: <conftest.db_class.<locals>.DummyDB object at 0xdeadbeef> + E assert 0 + + test_unittest_db.py:9: AssertionError + _______ MyTest.test_method2 ________ + + self = <test_unittest_db.MyTest testMethod=test_method2> + + def test_method2(self): + > assert 0, self.db # fail for demo purposes + E AssertionError: <conftest.db_class.<locals>.DummyDB object at 0xdeadbeef> + E assert 0 + + test_unittest_db.py:12: AssertionError + ======= 2 failed in 0.12 seconds ======== + +This default pytest traceback shows that the two test methods +share the same ``self.db`` instance which was our intention +when writing the class-scoped fixture function above. + + +autouse fixtures and accessing other fixtures +------------------------------------------------------------------- + +Although it's usually better to explicitly declare use of fixtures you need +for a given test, you may sometimes want to have fixtures that are +automatically used in a given context. After all, the traditional +style of unittest-setup mandates the use of this implicit fixture writing +and chances are, you are used to it or like it. + +You can flag fixture functions with ``@pytest.fixture(autouse=True)`` +and define the fixture function in the context where you want it used. +Let's look at an ``initdir`` fixture which makes all test methods of a +``TestCase`` class execute in a temporary directory with a +pre-initialized ``samplefile.ini``. Our ``initdir`` fixture itself uses +the pytest builtin :ref:`tmpdir <tmpdir>` fixture to delegate the +creation of a per-test temporary directory:: + + # content of test_unittest_cleandir.py + import pytest + import unittest + + class MyTest(unittest.TestCase): + @pytest.fixture(autouse=True) + def initdir(self, tmpdir): + tmpdir.chdir() # change to pytest-provided temporary directory + tmpdir.join("samplefile.ini").write("# testdata") + + def test_method(self): + s = open("samplefile.ini").read() + assert "testdata" in s + +Due to the ``autouse`` flag the ``initdir`` fixture function will be +used for all methods of the class where it is defined. This is a +shortcut for using a ``@pytest.mark.usefixtures("initdir")`` marker +on the class like in the previous example. + +Running this test module ...:: + + $ py.test -q test_unittest_cleandir.py + . + 1 passed in 0.12 seconds + +... gives us one passed test because the ``initdir`` fixture function +was executed ahead of the ``test_method``. + +.. note:: + + While pytest supports receiving fixtures via :ref:`test function arguments <funcargs>` for non-unittest test methods, ``unittest.TestCase`` methods cannot directly receive fixture + function arguments as implementing that is likely to inflict + on the ability to run general unittest.TestCase test suites. + Maybe optional support would be possible, though. If unittest finally + grows a plugin system that should help as well. In the meanwhile, the + above ``usefixtures`` and ``autouse`` examples should help to mix in + pytest fixtures into unittest suites. And of course you can also start + to selectively leave away the ``unittest.TestCase`` subclassing, use + plain asserts and get the unlimited pytest feature set. + + +Converting from unittest to pytest +--------------------------------------- + +If you want to convert your unittest testcases to pytest, there are +some helpers like `unittest2pytest +<https://pypi.python.org/pypi/unittest2pytest/>`__, which uses lib2to3 +and introspection for the transformation. diff --git a/testing/web-platform/tests/tools/pytest/doc/en/usage.rst b/testing/web-platform/tests/tools/pytest/doc/en/usage.rst new file mode 100644 index 000000000..4b92fd1e1 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/usage.rst @@ -0,0 +1,275 @@ + +.. _usage: + +Usage and Invocations +========================================== + + +.. _cmdline: + +Calling pytest through ``python -m pytest`` +----------------------------------------------------- + +.. versionadded:: 2.0 + +You can invoke testing through the Python interpreter from the command line:: + + python -m pytest [...] + +This is equivalent to invoking the command line script ``py.test [...]`` +directly. + +Getting help on version, option names, environment variables +-------------------------------------------------------------- + +:: + + py.test --version # shows where pytest was imported from + py.test --fixtures # show available builtin function arguments + py.test -h | --help # show help on command line and config file options + + +Stopping after the first (or N) failures +--------------------------------------------------- + +To stop the testing process after the first (N) failures:: + + py.test -x # stop after first failure + py.test --maxfail=2 # stop after two failures + +Specifying tests / selecting tests +--------------------------------------------------- + +Several test run options:: + + py.test test_mod.py # run tests in module + py.test somepath # run all tests below somepath + py.test -k stringexpr # only run tests with names that match the + # "string expression", e.g. "MyClass and not method" + # will select TestMyClass.test_something + # but not TestMyClass.test_method_simple + py.test test_mod.py::test_func # only run tests that match the "node ID", + # e.g "test_mod.py::test_func" will select + # only test_func in test_mod.py + py.test test_mod.py::TestClass::test_method # run a single method in + # a single class + +Import 'pkg' and use its filesystem location to find and run tests:: + + py.test --pyargs pkg # run all tests found below directory of pypkg + +Modifying Python traceback printing +---------------------------------------------- + +Examples for modifying traceback printing:: + + py.test --showlocals # show local variables in tracebacks + py.test -l # show local variables (shortcut) + + py.test --tb=auto # (default) 'long' tracebacks for the first and last + # entry, but 'short' style for the other entries + py.test --tb=long # exhaustive, informative traceback formatting + py.test --tb=short # shorter traceback format + py.test --tb=line # only one line per failure + py.test --tb=native # Python standard library formatting + py.test --tb=no # no traceback at all + +Dropping to PDB_ (Python Debugger) on failures +----------------------------------------------- + +.. _PDB: http://docs.python.org/library/pdb.html + +Python comes with a builtin Python debugger called PDB_. ``pytest`` +allows one to drop into the PDB_ prompt via a command line option:: + + py.test --pdb + +This will invoke the Python debugger on every failure. Often you might +only want to do this for the first failing test to understand a certain +failure situation:: + + py.test -x --pdb # drop to PDB on first failure, then end test session + py.test --pdb --maxfail=3 # drop to PDB for first three failures + +Note that on any failure the exception information is stored on +``sys.last_value``, ``sys.last_type`` and ``sys.last_traceback``. In +interactive use, this allows one to drop into postmortem debugging with +any debug tool. One can also manually access the exception information, +for example:: + + >>> import sys + >>> sys.last_traceback.tb_lineno + 42 + >>> sys.last_value + AssertionError('assert result == "ok"',) + +Setting a breakpoint / aka ``set_trace()`` +---------------------------------------------------- + +If you want to set a breakpoint and enter the ``pdb.set_trace()`` you +can use a helper:: + + import pytest + def test_function(): + ... + pytest.set_trace() # invoke PDB debugger and tracing + +.. versionadded: 2.0.0 + +Prior to pytest version 2.0.0 you could only enter PDB_ tracing if you disabled +capturing on the command line via ``py.test -s``. In later versions, pytest +automatically disables its output capture when you enter PDB_ tracing: + +* Output capture in other tests is not affected. +* Any prior test output that has already been captured and will be processed as + such. +* Any later output produced within the same test will not be captured and will + instead get sent directly to ``sys.stdout``. Note that this holds true even + for test output occurring after you exit the interactive PDB_ tracing session + and continue with the regular test run. + +.. versionadded: 2.4.0 + +Since pytest version 2.4.0 you can also use the native Python +``import pdb;pdb.set_trace()`` call to enter PDB_ tracing without having to use +the ``pytest.set_trace()`` wrapper or explicitly disable pytest's output +capturing via ``py.test -s``. + +.. _durations: + +Profiling test execution duration +------------------------------------- + +.. versionadded: 2.2 + +To get a list of the slowest 10 test durations:: + + py.test --durations=10 + + +Creating JUnitXML format files +---------------------------------------------------- + +To create result files which can be read by Hudson_ or other Continuous +integration servers, use this invocation:: + + py.test --junitxml=path + +to create an XML file at ``path``. + +record_xml_property +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 2.8 + +If you want to log additional information for a test, you can use the +``record_xml_property`` fixture: + +.. code-block:: python + + def test_function(record_xml_property): + record_xml_property("example_key", 1) + assert 0 + +This will add an extra property ``example_key="1"`` to the generated +``testcase`` tag: + +.. code-block:: xml + + <testcase classname="test_function" file="test_function.py" line="0" name="test_function" time="0.0009"> + <properties> + <property name="example_key" value="1" /> + </properties> + </testcase> + +.. warning:: + + This is an experimental feature, and its interface might be replaced + by something more powerful and general in future versions. The + functionality per-se will be kept, however. + + Currently it does not work when used with the ``pytest-xdist`` plugin. + + Also please note that using this feature will break any schema verification. + This might be a problem when used with some CI servers. + +Creating resultlog format files +---------------------------------------------------- + +To create plain-text machine-readable result files you can issue:: + + py.test --resultlog=path + +and look at the content at the ``path`` location. Such files are used e.g. +by the `PyPy-test`_ web page to show test results over several revisions. + +.. _`PyPy-test`: http://buildbot.pypy.org/summary + + +Sending test report to online pastebin service +----------------------------------------------------- + +**Creating a URL for each test failure**:: + + py.test --pastebin=failed + +This will submit test run information to a remote Paste service and +provide a URL for each failure. You may select tests as usual or add +for example ``-x`` if you only want to send one particular failure. + +**Creating a URL for a whole test session log**:: + + py.test --pastebin=all + +Currently only pasting to the http://bpaste.net service is implemented. + +Disabling plugins +----------------- + +To disable loading specific plugins at invocation time, use the ``-p`` option +together with the prefix ``no:``. + +Example: to disable loading the plugin ``doctest``, which is responsible for +executing doctest tests from text files, invoke py.test like this:: + + py.test -p no:doctest + +.. _`pytest.main-usage`: + +Calling pytest from Python code +---------------------------------------------------- + +.. versionadded:: 2.0 + +You can invoke ``pytest`` from Python code directly:: + + pytest.main() + +this acts as if you would call "py.test" from the command line. +It will not raise ``SystemExit`` but return the exitcode instead. +You can pass in options and arguments:: + + pytest.main(['-x', 'mytestdir']) + +or pass in a string:: + + pytest.main("-x mytestdir") + +You can specify additional plugins to ``pytest.main``:: + + # content of myinvoke.py + import pytest + class MyPlugin: + def pytest_sessionfinish(self): + print("*** test run reporting finishing") + + pytest.main("-qq", plugins=[MyPlugin()]) + +Running it will show that ``MyPlugin`` was added and its +hook was invoked:: + + $ python myinvoke.py + *** test run reporting finishing + + +.. include:: links.inc diff --git a/testing/web-platform/tests/tools/pytest/doc/en/writing_plugins.rst b/testing/web-platform/tests/tools/pytest/doc/en/writing_plugins.rst new file mode 100644 index 000000000..cc346aaa8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/writing_plugins.rst @@ -0,0 +1,575 @@ +.. _plugins: +.. _`writing-plugins`: + +Writing plugins +=============== + +It is easy to implement `local conftest plugins`_ for your own project +or `pip-installable plugins`_ that can be used throughout many projects, +including third party projects. Please refer to :ref:`using plugins` if you +only want to use but not write plugins. + +A plugin contains one or multiple hook functions. :ref:`Writing hooks <writinghooks>` +explains the basics and details of how you can write a hook function yourself. +``pytest`` implements all aspects of configuration, collection, running and +reporting by calling `well specified hooks`_ of the following plugins: + +* :ref:`builtin plugins`: loaded from pytest's internal ``_pytest`` directory. + +* :ref:`external plugins <extplugins>`: modules discovered through + `setuptools entry points`_ + +* `conftest.py plugins`_: modules auto-discovered in test directories + +In principle, each hook call is a ``1:N`` Python function call where ``N`` is the +number of registered implementation functions for a given specification. +All specifications and implementations following the ``pytest_`` prefix +naming convention, making them easy to distinguish and find. + +.. _`pluginorder`: + +Plugin discovery order at tool startup +-------------------------------------- + +``pytest`` loads plugin modules at tool startup in the following way: + +* by loading all builtin plugins + +* by loading all plugins registered through `setuptools entry points`_. + +* by pre-scanning the command line for the ``-p name`` option + and loading the specified plugin before actual command line parsing. + +* by loading all :file:`conftest.py` files as inferred by the command line + invocation: + + - if no test paths are specified use current dir as a test path + - if exists, load ``conftest.py`` and ``test*/conftest.py`` relative + to the directory part of the first test path. + + Note that pytest does not find ``conftest.py`` files in deeper nested + sub directories at tool startup. It is usually a good idea to keep + your conftest.py file in the top level test or project root directory. + +* by recursively loading all plugins specified by the + ``pytest_plugins`` variable in ``conftest.py`` files + + +.. _`pytest/plugin`: http://bitbucket.org/pytest-dev/pytest/src/tip/pytest/plugin/ +.. _`conftest.py plugins`: +.. _`conftest.py`: +.. _`localplugin`: +.. _`conftest`: +.. _`local conftest plugins`: + +conftest.py: local per-directory plugins +---------------------------------------- + +Local ``conftest.py`` plugins contain directory-specific hook +implementations. Hook Session and test running activities will +invoke all hooks defined in ``conftest.py`` files closer to the +root of the filesystem. Example of implementing the +``pytest_runtest_setup`` hook so that is called for tests in the ``a`` +sub directory but not for other directories:: + + a/conftest.py: + def pytest_runtest_setup(item): + # called for running each test in 'a' directory + print ("setting up", item) + + a/test_sub.py: + def test_sub(): + pass + + test_flat.py: + def test_flat(): + pass + +Here is how you might run it:: + + py.test test_flat.py # will not show "setting up" + py.test a/test_sub.py # will show "setting up" + +.. Note:: + If you have ``conftest.py`` files which do not reside in a + python package directory (i.e. one containing an ``__init__.py``) then + "import conftest" can be ambiguous because there might be other + ``conftest.py`` files as well on your PYTHONPATH or ``sys.path``. + It is thus good practice for projects to either put ``conftest.py`` + under a package scope or to never import anything from a + conftest.py file. + + +Writing your own plugin +----------------------- + +.. _`setuptools`: http://pypi.python.org/pypi/setuptools + +If you want to write a plugin, there are many real-life examples +you can copy from: + +* a custom collection example plugin: :ref:`yaml plugin` +* around 20 :ref:`builtin plugins` which provide pytest's own functionality +* many `external plugins <http://plugincompat.herokuapp.com>`_ providing additional features + +All of these plugins implement the documented `well specified hooks`_ +to extend and add functionality. + +.. note:: + Make sure to check out the excellent + `cookiecutter-pytest-plugin <https://github.com/pytest-dev/cookiecutter-pytest-plugin>`_ + project, which is a `cookiecutter template <https://github.com/audreyr/cookiecutter>`_ + for authoring plugins. + + The template provides an excellent starting point with a working plugin, + tests running with tox, comprehensive README and + entry-pointy already pre-configured. + +Also consider :ref:`contributing your plugin to pytest-dev<submitplugin>` +once it has some happy users other than yourself. + + +.. _`setuptools entry points`: +.. _`pip-installable plugins`: + +Making your plugin installable by others +---------------------------------------- + +If you want to make your plugin externally available, you +may define a so-called entry point for your distribution so +that ``pytest`` finds your plugin module. Entry points are +a feature that is provided by `setuptools`_. pytest looks up +the ``pytest11`` entrypoint to discover its +plugins and you can thus make your plugin available by defining +it in your setuptools-invocation: + +.. sourcecode:: python + + # sample ./setup.py file + from setuptools import setup + + setup( + name="myproject", + packages = ['myproject'] + + # the following makes a plugin available to pytest + entry_points = { + 'pytest11': [ + 'name_of_plugin = myproject.pluginmodule', + ] + }, + ) + +If a package is installed this way, ``pytest`` will load +``myproject.pluginmodule`` as a plugin which can define +`well specified hooks`_. + + + + +Requiring/Loading plugins in a test module or conftest file +----------------------------------------------------------- + +You can require plugins in a test module or a conftest file like this:: + + pytest_plugins = "name1", "name2", + +When the test module or conftest plugin is loaded the specified plugins +will be loaded as well. You can also use dotted path like this:: + + pytest_plugins = "myapp.testsupport.myplugin" + +which will import the specified module as a ``pytest`` plugin. + + +Accessing another plugin by name +-------------------------------- + +If a plugin wants to collaborate with code from +another plugin it can obtain a reference through +the plugin manager like this: + +.. sourcecode:: python + + plugin = config.pluginmanager.getplugin("name_of_plugin") + +If you want to look at the names of existing plugins, use +the ``--traceconfig`` option. + +Testing plugins +--------------- + +pytest comes with some facilities that you can enable for testing your +plugin. Given that you have an installed plugin you can enable the +:py:class:`testdir <_pytest.pytester.Testdir>` fixture via specifying a +command line option to include the pytester plugin (``-p pytester``) or +by putting ``pytest_plugins = "pytester"`` into your test or +``conftest.py`` file. You then will have a ``testdir`` fixture which you +can use like this:: + + # content of test_myplugin.py + + pytest_plugins = "pytester" # to get testdir fixture + + def test_myplugin(testdir): + testdir.makepyfile(""" + def test_example(): + pass + """) + result = testdir.runpytest("--verbose") + result.fnmatch_lines(""" + test_example* + """) + +Note that by default ``testdir.runpytest()`` will perform a pytest +in-process. You can pass the command line option ``--runpytest=subprocess`` +to have it happen in a subprocess. + +Also see the :py:class:`RunResult <_pytest.pytester.RunResult>` for more +methods of the result object that you get from a call to ``runpytest``. + +.. _`writinghooks`: + +Writing hook functions +====================== + + +.. _validation: + +hook function validation and execution +-------------------------------------- + +pytest calls hook functions from registered plugins for any +given hook specification. Let's look at a typical hook function +for the ``pytest_collection_modifyitems(session, config, +items)`` hook which pytest calls after collection of all test items is +completed. + +When we implement a ``pytest_collection_modifyitems`` function in our plugin +pytest will during registration verify that you use argument +names which match the specification and bail out if not. + +Let's look at a possible implementation: + +.. code-block:: python + + def pytest_collection_modifyitems(config, items): + # called after collection is completed + # you can modify the ``items`` list + +Here, ``pytest`` will pass in ``config`` (the pytest config object) +and ``items`` (the list of collected test items) but will not pass +in the ``session`` argument because we didn't list it in the function +signature. This dynamic "pruning" of arguments allows ``pytest`` to +be "future-compatible": we can introduce new hook named parameters without +breaking the signatures of existing hook implementations. It is one of +the reasons for the general long-lived compatibility of pytest plugins. + +Note that hook functions other than ``pytest_runtest_*`` are not +allowed to raise exceptions. Doing so will break the pytest run. + + + +firstresult: stop at first non-None result +------------------------------------------- + +Most calls to ``pytest`` hooks result in a **list of results** which contains +all non-None results of the called hook functions. + +Some hook specifications use the ``firstresult=True`` option so that the hook +call only executes until the first of N registered functions returns a +non-None result which is then taken as result of the overall hook call. +The remaining hook functions will not be called in this case. + + +hookwrapper: executing around other hooks +------------------------------------------------- + +.. currentmodule:: _pytest.core + +.. versionadded:: 2.7 (experimental) + +pytest plugins can implement hook wrappers which wrap the execution +of other hook implementations. A hook wrapper is a generator function +which yields exactly once. When pytest invokes hooks it first executes +hook wrappers and passes the same arguments as to the regular hooks. + +At the yield point of the hook wrapper pytest will execute the next hook +implementations and return their result to the yield point in the form of +a :py:class:`CallOutcome` instance which encapsulates a result or +exception info. The yield point itself will thus typically not raise +exceptions (unless there are bugs). + +Here is an example definition of a hook wrapper:: + + import pytest + + @pytest.hookimpl(hookwrapper=True) + def pytest_pyfunc_call(pyfuncitem): + # do whatever you want before the next hook executes + + outcome = yield + # outcome.excinfo may be None or a (cls, val, tb) tuple + + res = outcome.get_result() # will raise if outcome was exception + # postprocess result + +Note that hook wrappers don't return results themselves, they merely +perform tracing or other side effects around the actual hook implementations. +If the result of the underlying hook is a mutable object, they may modify +that result but it's probably better to avoid it. + + +Hook function ordering / call example +------------------------------------- + +For any given hook specification there may be more than one +implementation and we thus generally view ``hook`` execution as a +``1:N`` function call where ``N`` is the number of registered functions. +There are ways to influence if a hook implementation comes before or +after others, i.e. the position in the ``N``-sized list of functions: + +.. code-block:: python + + # Plugin 1 + @pytest.hookimpl(tryfirst=True) + def pytest_collection_modifyitems(items): + # will execute as early as possible + + # Plugin 2 + @pytest.hookimpl(trylast=True) + def pytest_collection_modifyitems(items): + # will execute as late as possible + + # Plugin 3 + @pytest.hookimpl(hookwrapper=True) + def pytest_collection_modifyitems(items): + # will execute even before the tryfirst one above! + outcome = yield + # will execute after all non-hookwrappers executed + +Here is the order of execution: + +1. Plugin3's pytest_collection_modifyitems called until the yield point + because it is a hook wrapper. + +2. Plugin1's pytest_collection_modifyitems is called because it is marked + with ``tryfirst=True``. + +3. Plugin2's pytest_collection_modifyitems is called because it is marked + with ``trylast=True`` (but even without this mark it would come after + Plugin1). + +4. Plugin3's pytest_collection_modifyitems then executing the code after the yield + point. The yield receives a :py:class:`CallOutcome` instance which encapsulates + the result from calling the non-wrappers. Wrappers shall not modify the result. + +It's possible to use ``tryfirst`` and ``trylast`` also in conjunction with +``hookwrapper=True`` in which case it will influence the ordering of hookwrappers +among each other. + + +Declaring new hooks +------------------------ + +.. currentmodule:: _pytest.hookspec + +Plugins and ``conftest.py`` files may declare new hooks that can then be +implemented by other plugins in order to alter behaviour or interact with +the new plugin: + +.. autofunction:: pytest_addhooks + +Hooks are usually declared as do-nothing functions that contain only +documentation describing when the hook will be called and what return values +are expected. + +For an example, see `newhooks.py`_ from :ref:`xdist`. + +.. _`newhooks.py`: https://github.com/pytest-dev/pytest-xdist/blob/974bd566c599dc6a9ea291838c6f226197208b46/xdist/newhooks.py + + +Optionally using hooks from 3rd party plugins +--------------------------------------------- + +Using new hooks from plugins as explained above might be a little tricky +because of the standard :ref:`validation mechanism <validation>`: +if you depend on a plugin that is not installed, validation will fail and +the error message will not make much sense to your users. + +One approach is to defer the hook implementation to a new plugin instead of +declaring the hook functions directly in your plugin module, for example:: + + # contents of myplugin.py + + class DeferPlugin(object): + """Simple plugin to defer pytest-xdist hook functions.""" + + def pytest_testnodedown(self, node, error): + """standard xdist hook function. + """ + + def pytest_configure(config): + if config.pluginmanager.hasplugin('xdist'): + config.pluginmanager.register(DeferPlugin()) + +This has the added benefit of allowing you to conditionally install hooks +depending on which plugins are installed. + +.. _`well specified hooks`: + +.. currentmodule:: _pytest.hookspec + +pytest hook reference +===================== + + +Initialization, command line and configuration hooks +---------------------------------------------------- + +.. autofunction:: pytest_load_initial_conftests +.. autofunction:: pytest_cmdline_preparse +.. autofunction:: pytest_cmdline_parse +.. autofunction:: pytest_namespace +.. autofunction:: pytest_addoption +.. autofunction:: pytest_cmdline_main +.. autofunction:: pytest_configure +.. autofunction:: pytest_unconfigure + +Generic "runtest" hooks +----------------------- + +All runtest related hooks receive a :py:class:`pytest.Item` object. + +.. autofunction:: pytest_runtest_protocol +.. autofunction:: pytest_runtest_setup +.. autofunction:: pytest_runtest_call +.. autofunction:: pytest_runtest_teardown +.. autofunction:: pytest_runtest_makereport + +For deeper understanding you may look at the default implementation of +these hooks in :py:mod:`_pytest.runner` and maybe also +in :py:mod:`_pytest.pdb` which interacts with :py:mod:`_pytest.capture` +and its input/output capturing in order to immediately drop +into interactive debugging when a test failure occurs. + +The :py:mod:`_pytest.terminal` reported specifically uses +the reporting hook to print information about a test run. + +Collection hooks +---------------- + +``pytest`` calls the following hooks for collecting files and directories: + +.. autofunction:: pytest_ignore_collect +.. autofunction:: pytest_collect_directory +.. autofunction:: pytest_collect_file + +For influencing the collection of objects in Python modules +you can use the following hook: + +.. autofunction:: pytest_pycollect_makeitem +.. autofunction:: pytest_generate_tests + +After collection is complete, you can modify the order of +items, delete or otherwise amend the test items: + +.. autofunction:: pytest_collection_modifyitems + +Reporting hooks +--------------- + +Session related reporting hooks: + +.. autofunction:: pytest_collectstart +.. autofunction:: pytest_itemcollected +.. autofunction:: pytest_collectreport +.. autofunction:: pytest_deselected +.. autofunction:: pytest_report_header +.. autofunction:: pytest_report_teststatus +.. autofunction:: pytest_terminal_summary + +And here is the central hook for reporting about +test execution: + +.. autofunction:: pytest_runtest_logreport + +You can also use this hook to customize assertion representation for some +types: + +.. autofunction:: pytest_assertrepr_compare + + +Debugging/Interaction hooks +--------------------------- + +There are few hooks which can be used for special +reporting or interaction with exceptions: + +.. autofunction:: pytest_internalerror +.. autofunction:: pytest_keyboard_interrupt +.. autofunction:: pytest_exception_interact +.. autofunction:: pytest_enter_pdb + + +Reference of objects involved in hooks +====================================== + +.. autoclass:: _pytest.config.Config() + :members: + +.. autoclass:: _pytest.config.Parser() + :members: + +.. autoclass:: _pytest.main.Node() + :members: + +.. autoclass:: _pytest.main.Collector() + :members: + :show-inheritance: + +.. autoclass:: _pytest.main.Item() + :members: + :show-inheritance: + +.. autoclass:: _pytest.python.Module() + :members: + :show-inheritance: + +.. autoclass:: _pytest.python.Class() + :members: + :show-inheritance: + +.. autoclass:: _pytest.python.Function() + :members: + :show-inheritance: + +.. autoclass:: _pytest.runner.CallInfo() + :members: + +.. autoclass:: _pytest.runner.TestReport() + :members: + +.. autoclass:: _pytest.vendored_packages.pluggy._CallOutcome() + :members: + +.. autofunction:: _pytest.config.get_plugin_manager() + +.. autoclass:: _pytest.config.PytestPluginManager() + :members: + :undoc-members: + :show-inheritance: + +.. autoclass:: pluggy.PluginManager() + :members: + +.. currentmodule:: _pytest.pytester + +.. autoclass:: Testdir() + :members: runpytest,runpytest_subprocess,runpytest_inprocess,makeconftest,makepyfile + +.. autoclass:: RunResult() + :members: + +.. autoclass:: LineMatcher() + :members: diff --git a/testing/web-platform/tests/tools/pytest/doc/en/xdist.rst b/testing/web-platform/tests/tools/pytest/doc/en/xdist.rst new file mode 100644 index 000000000..ee1bd6032 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/xdist.rst @@ -0,0 +1,197 @@ + +.. _`xdist`: + +xdist: pytest distributed testing plugin +=============================================================== + +The `pytest-xdist`_ plugin extends ``pytest`` with some unique +test execution modes: + +* Looponfail: run your tests repeatedly in a subprocess. After each + run, ``pytest`` waits until a file in your project changes and then + re-runs the previously failing tests. This is repeated until all + tests pass. At this point a full run is again performed. + +* multiprocess Load-balancing: if you have multiple CPUs or hosts you can use + them for a combined test run. This allows to speed up + development or to use special resources of remote machines. + +* Multi-Platform coverage: you can specify different Python interpreters + or different platforms and run tests in parallel on all of them. + +Before running tests remotely, ``pytest`` efficiently "rsyncs" your +program source code to the remote place. All test results +are reported back and displayed to your local terminal. +You may specify different Python versions and interpreters. + + +Installation of xdist plugin +------------------------------ + +Install the plugin with:: + + easy_install pytest-xdist + + # or + + pip install pytest-xdist + +or use the package in develop/in-place mode with +a checkout of the `pytest-xdist repository`_ :: + + python setup.py develop + + +Usage examples +--------------------- + +.. _`xdistcpu`: + +Speed up test runs by sending tests to multiple CPUs ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +To send tests to multiple CPUs, type:: + + py.test -n NUM + +Especially for longer running tests or tests requiring +a lot of I/O this can lead to considerable speed ups. + + +Running tests in a Python subprocess ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +To instantiate a Python-2.7 subprocess and send tests to it, you may type:: + + py.test -d --tx popen//python=python2.7 + +This will start a subprocess which is run with the "python2.7" +Python interpreter, found in your system binary lookup path. + +If you prefix the --tx option value like this:: + + py.test -d --tx 3*popen//python=python2.7 + +then three subprocesses would be created and the tests +will be distributed to three subprocesses and run simultanously. + +.. _looponfailing: + + +Running tests in looponfailing mode ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +For refactoring a project with a medium or large test suite +you can use the looponfailing mode. Simply add the ``--f`` option:: + + py.test -f + +and ``pytest`` will run your tests. Assuming you have failures it will then +wait for file changes and re-run the failing test set. File changes are detected by looking at ``looponfailingroots`` root directories and all of their contents (recursively). If the default for this value does not work for you you +can change it in your project by setting a configuration option:: + + # content of a pytest.ini, setup.cfg or tox.ini file + [pytest] + looponfailroots = mypkg testdir + +This would lead to only looking for file changes in the respective directories, specified relatively to the ini-file's directory. + +Sending tests to remote SSH accounts ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Suppose you have a package ``mypkg`` which contains some +tests that you can successfully run locally. And you also +have a ssh-reachable machine ``myhost``. Then +you can ad-hoc distribute your tests by typing:: + + py.test -d --tx ssh=myhostpopen --rsyncdir mypkg mypkg + +This will synchronize your ``mypkg`` package directory +with a remote ssh account and then collect and run your +tests at the remote side. + +You can specify multiple ``--rsyncdir`` directories +to be sent to the remote side. + +.. XXX CHECK + + **NOTE:** For ``pytest`` to collect and send tests correctly + you not only need to make sure all code and tests + directories are rsynced, but that any test (sub) directory + also has an ``__init__.py`` file because internally + ``pytest`` references tests as a fully qualified python + module path. **You will otherwise get strange errors** + during setup of the remote side. + +Sending tests to remote Socket Servers ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +Download the single-module `socketserver.py`_ Python program +and run it like this:: + + python socketserver.py + +It will tell you that it starts listening on the default +port. You can now on your home machine specify this +new socket host with something like this:: + + py.test -d --tx socket=192.168.1.102:8888 --rsyncdir mypkg mypkg + + +.. _`atonce`: + +Running tests on many platforms at once ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The basic command to run tests on multiple platforms is:: + + py.test --dist=each --tx=spec1 --tx=spec2 + +If you specify a windows host, an OSX host and a Linux +environment this command will send each tests to all +platforms - and report back failures from all platforms +at once. The specifications strings use the `xspec syntax`_. + +.. _`xspec syntax`: http://codespeak.net/execnet/basics.html#xspec + +.. _`socketserver.py`: http://bitbucket.org/hpk42/execnet/raw/2af991418160/execnet/script/socketserver.py + +.. _`execnet`: http://codespeak.net/execnet + +Specifying test exec environments in an ini file ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +pytest (since version 2.0) supports ini-style configuration. +For example, you could make running with three subprocesses your default:: + + [pytest] + addopts = -n3 + +You can also add default environments like this:: + + [pytest] + addopts = --tx ssh=myhost//python=python2.7 --tx ssh=myhost//python=python2.6 + +and then just type:: + + py.test --dist=each + +to run tests in each of the environments. + +Specifying "rsync" dirs in an ini-file ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +In a ``tox.ini`` or ``setup.cfg`` file in your root project directory +you may specify directories to include or to exclude in synchronisation:: + + [pytest] + rsyncdirs = . mypkg helperpkg + rsyncignore = .hg + +These directory specifications are relative to the directory +where the configuration file was found. + +.. _`pytest-xdist`: http://pypi.python.org/pypi/pytest-xdist +.. _`pytest-xdist repository`: http://bitbucket.org/pytest-dev/pytest-xdist +.. _`pytest`: http://pytest.org + diff --git a/testing/web-platform/tests/tools/pytest/doc/en/xunit_setup.rst b/testing/web-platform/tests/tools/pytest/doc/en/xunit_setup.rst new file mode 100644 index 000000000..7a80f1299 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/xunit_setup.rst @@ -0,0 +1,90 @@ + +.. _`classic xunit`: +.. _xunitsetup: + +classic xunit-style setup +======================================== + +This section describes a classic and popular way how you can implement +fixtures (setup and teardown test state) on a per-module/class/function basis. +pytest started supporting these methods around 2005 and subsequently +nose and the standard library introduced them (under slightly different +names). While these setup/teardown methods are and will remain fully +supported you may also use pytest's more powerful :ref:`fixture mechanism +<fixture>` which leverages the concept of dependency injection, allowing +for a more modular and more scalable approach for managing test state, +especially for larger projects and for functional testing. You can +mix both fixture mechanisms in the same file but unittest-based +test methods cannot receive fixture arguments. + +.. note:: + + As of pytest-2.4, teardownX functions are not called if + setupX existed and failed/was skipped. This harmonizes + behaviour across all major python testing tools. + +Module level setup/teardown +-------------------------------------- + +If you have multiple test functions and test classes in a single +module you can optionally implement the following fixture methods +which will usually be called once for all the functions:: + + def setup_module(module): + """ setup any state specific to the execution of the given module.""" + + def teardown_module(module): + """ teardown any state that was previously setup with a setup_module + method. + """ + +Class level setup/teardown +---------------------------------- + +Similarly, the following methods are called at class level before +and after all test methods of the class are called:: + + @classmethod + def setup_class(cls): + """ setup any state specific to the execution of the given class (which + usually contains tests). + """ + + @classmethod + def teardown_class(cls): + """ teardown any state that was previously setup with a call to + setup_class. + """ + +Method and function level setup/teardown +----------------------------------------------- + +Similarly, the following methods are called around each method invocation:: + + def setup_method(self, method): + """ setup any state tied to the execution of the given method in a + class. setup_method is invoked for every test method of a class. + """ + + def teardown_method(self, method): + """ teardown any state that was previously setup with a setup_method + call. + """ + +If you would rather define test functions directly at module level +you can also use the following functions to implement fixtures:: + + def setup_function(function): + """ setup any state tied to the execution of the given function. + Invoked for every test function in the module. + """ + + def teardown_function(function): + """ teardown any state that was previously setup with a setup_function + call. + """ + +Note that it is possible for setup/teardown pairs to be invoked multiple times +per testing process. + +.. _`unittest.py module`: http://docs.python.org/library/unittest.html diff --git a/testing/web-platform/tests/tools/pytest/doc/en/yieldfixture.rst b/testing/web-platform/tests/tools/pytest/doc/en/yieldfixture.rst new file mode 100644 index 000000000..ee88a27df --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/doc/en/yieldfixture.rst @@ -0,0 +1,100 @@ +.. _yieldfixture: + +Fixture functions using "yield" / context manager integration +--------------------------------------------------------------- + +.. versionadded:: 2.4 + +.. regendoc:wipe + +pytest-2.4 allows fixture functions to seamlessly use a ``yield`` instead +of a ``return`` statement to provide a fixture value while otherwise +fully supporting all other fixture features. + +Let's look at a simple standalone-example using the ``yield`` syntax:: + + # content of test_yield.py + + import pytest + + @pytest.yield_fixture + def passwd(): + print ("\nsetup before yield") + f = open("/etc/passwd") + yield f.readlines() + print ("teardown after yield") + f.close() + + def test_has_lines(passwd): + print ("test called") + assert passwd + +In contrast to :ref:`finalization through registering callbacks +<finalization>`, our fixture function used a ``yield`` +statement to provide the lines of the ``/etc/passwd`` file. +The code after the ``yield`` statement serves as the teardown code, +avoiding the indirection of registering a teardown callback function. + +Let's run it with output capturing disabled:: + + $ py.test -q -s test_yield.py + + setup before yield + test called + .teardown after yield + + 1 passed in 0.12 seconds + +We can also seamlessly use the new syntax with ``with`` statements. +Let's simplify the above ``passwd`` fixture:: + + # content of test_yield2.py + + import pytest + + @pytest.yield_fixture + def passwd(): + with open("/etc/passwd") as f: + yield f.readlines() + + def test_has_lines(passwd): + assert len(passwd) >= 1 + +The file ``f`` will be closed after the test finished execution +because the Python ``file`` object supports finalization when +the ``with`` statement ends. + +Note that the yield fixture form supports all other fixture +features such as ``scope``, ``params``, etc., thus changing existing +fixture functions to use ``yield`` is straightforward. + +.. note:: + + While the ``yield`` syntax is similar to what + :py:func:`contextlib.contextmanager` decorated functions + provide, with pytest fixture functions the part after the + "yield" will always be invoked, independently from the + exception status of the test function which uses the fixture. + This behaviour makes sense if you consider that many different + test functions might use a module or session scoped fixture. + + +Discussion and future considerations / feedback +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +There are some topics that are worth mentioning: + +- usually ``yield`` is used for producing multiple values. + But fixture functions can only yield exactly one value. + Yielding a second fixture value will get you an error. + It's possible we can evolve pytest to allow for producing + multiple values as an alternative to current parametrization. + For now, you can just use the normal + :ref:`fixture parametrization <fixture-parametrize>` + mechanisms together with ``yield``-style fixtures. + +- lastly ``yield`` introduces more than one way to write + fixture functions, so what's the obvious way to a newcomer? + +If you want to feedback or participate in discussion of the above +topics, please join our :ref:`contact channels`, you are most welcome. diff --git a/testing/web-platform/tests/tools/pytest/extra/get_issues.py b/testing/web-platform/tests/tools/pytest/extra/get_issues.py new file mode 100644 index 000000000..6437ba4c3 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/extra/get_issues.py @@ -0,0 +1,74 @@ +import json +import py +import textwrap + +issues_url = "http://bitbucket.org/api/1.0/repositories/pytest-dev/pytest/issues" + +import requests + +def get_issues(): + chunksize = 50 + start = 0 + issues = [] + while 1: + post_data = {"accountname": "pytest-dev", + "repo_slug": "pytest", + "start": start, + "limit": chunksize} + print ("getting from", start) + r = requests.get(issues_url, params=post_data) + data = r.json() + issues.extend(data["issues"]) + if start + chunksize >= data["count"]: + return issues + start += chunksize + +kind2num = "bug enhancement task proposal".split() + +status2num = "new open resolved duplicate invalid wontfix".split() + +def main(args): + cachefile = py.path.local(args.cache) + if not cachefile.exists() or args.refresh: + issues = get_issues() + cachefile.write(json.dumps(issues)) + else: + issues = json.loads(cachefile.read()) + + open_issues = [x for x in issues + if x["status"] in ("new", "open")] + + def kind_and_id(x): + kind = x["metadata"]["kind"] + return kind2num.index(kind), len(issues)-int(x["local_id"]) + open_issues.sort(key=kind_and_id) + report(open_issues) + +def report(issues): + for issue in issues: + metadata = issue["metadata"] + priority = issue["priority"] + title = issue["title"] + content = issue["content"] + kind = metadata["kind"] + status = issue["status"] + id = issue["local_id"] + link = "https://bitbucket.org/pytest-dev/pytest/issue/%s/" % id + print("----") + print(status, kind, link) + print(title) + #print() + #lines = content.split("\n") + #print ("\n".join(lines[:3])) + #if len(lines) > 3 or len(content) > 240: + # print ("...") + +if __name__ == "__main__": + import argparse + parser = argparse.ArgumentParser("process bitbucket issues") + parser.add_argument("--refresh", action="store_true", + help="invalidate cache, refresh issues") + parser.add_argument("--cache", action="store", default="issues.json", + help="cache file") + args = parser.parse_args() + main(args) diff --git a/testing/web-platform/tests/tools/pytest/extra/setup-py.test/setup.py b/testing/web-platform/tests/tools/pytest/extra/setup-py.test/setup.py new file mode 100644 index 000000000..d0560ce1f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/extra/setup-py.test/setup.py @@ -0,0 +1,11 @@ +import sys +from distutils.core import setup + +if __name__ == "__main__": + if "sdist" not in sys.argv[1:]: + raise ValueError("please use 'pytest' pypi package instead of 'py.test'") + setup( + name="py.test", + version="0.0", + description="please use 'pytest' for installation", + ) diff --git a/testing/web-platform/tests/tools/pytest/plugin-test.sh b/testing/web-platform/tests/tools/pytest/plugin-test.sh new file mode 100644 index 000000000..9c61b5053 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/plugin-test.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +# this assumes plugins are installed as sister directories + +set -e +cd ../pytest-pep8 +py.test +cd ../pytest-instafail +py.test +cd ../pytest-cache +py.test +cd ../pytest-xprocess +py.test +#cd ../pytest-cov +#py.test +cd ../pytest-capturelog +py.test +cd ../pytest-xdist +py.test + diff --git a/testing/web-platform/tests/tools/pytest/pytest.py b/testing/web-platform/tests/tools/pytest/pytest.py new file mode 100644 index 000000000..e376e417e --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/pytest.py @@ -0,0 +1,28 @@ +# PYTHON_ARGCOMPLETE_OK +""" +pytest: unit and functional testing with Python. +""" +__all__ = [ + 'main', + 'UsageError', + 'cmdline', + 'hookspec', + 'hookimpl', + '__version__', +] + +if __name__ == '__main__': # if run as a script or by 'python -m pytest' + # we trigger the below "else" condition by the following import + import pytest + raise SystemExit(pytest.main()) + +# else we are imported + +from _pytest.config import ( + main, UsageError, _preloadplugins, cmdline, + hookspec, hookimpl +) +from _pytest import __version__ + +_preloadplugins() # to populate pytest.* namespace so help(pytest) works + diff --git a/testing/web-platform/tests/tools/pytest/requirements-docs.txt b/testing/web-platform/tests/tools/pytest/requirements-docs.txt new file mode 100644 index 000000000..be3a232e5 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/requirements-docs.txt @@ -0,0 +1,3 @@ +sphinx==1.2.3 +regendoc +pyyaml diff --git a/testing/web-platform/tests/tools/pytest/runtox.py b/testing/web-platform/tests/tools/pytest/runtox.py new file mode 100644 index 000000000..8c13c53e1 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/runtox.py @@ -0,0 +1,8 @@ +#!/usr/bin/env python + +if __name__ == "__main__": + import subprocess + import sys + subprocess.call([sys.executable, "-m", "tox", + "-i", "ALL=https://devpi.net/hpk/dev/", + "--develop"] + sys.argv[1:]) diff --git a/testing/web-platform/tests/tools/pytest/setup.cfg b/testing/web-platform/tests/tools/pytest/setup.cfg new file mode 100644 index 000000000..1ab4fd059 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/setup.cfg @@ -0,0 +1,13 @@ +[build_sphinx] +source-dir = doc/en/ +build-dir = doc/build +all_files = 1 + +[upload_sphinx] +upload-dir = doc/en/build/html + +[bdist_wheel] +universal = 1 + +[devpi:upload] +formats = sdist.tgz,bdist_wheel diff --git a/testing/web-platform/tests/tools/pytest/setup.py b/testing/web-platform/tests/tools/pytest/setup.py new file mode 100644 index 000000000..6660f2160 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/setup.py @@ -0,0 +1,122 @@ +import os, sys +import setuptools +import pkg_resources +from setuptools import setup, Command + +classifiers = ['Development Status :: 6 - Mature', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: MIT License', + 'Operating System :: POSIX', + 'Operating System :: Microsoft :: Windows', + 'Operating System :: MacOS :: MacOS X', + 'Topic :: Software Development :: Testing', + 'Topic :: Software Development :: Libraries', + 'Topic :: Utilities'] + [ + ('Programming Language :: Python :: %s' % x) for x in + '2 2.6 2.7 3 3.2 3.3 3.4 3.5'.split()] + +with open('README.rst') as fd: + long_description = fd.read() + +def get_version(): + p = os.path.join(os.path.dirname( + os.path.abspath(__file__)), "_pytest", "__init__.py") + with open(p) as f: + for line in f.readlines(): + if "__version__" in line: + return line.strip().split("=")[-1].strip(" '") + raise ValueError("could not read version") + + +def has_environment_marker_support(): + """ + Tests that setuptools has support for PEP-426 environment marker support. + + The first known release to support it is 0.7 (and the earliest on PyPI seems to be 0.7.2 + so we're using that), see: http://pythonhosted.org/setuptools/history.html#id142 + + References: + + * https://wheel.readthedocs.org/en/latest/index.html#defining-conditional-dependencies + * https://www.python.org/dev/peps/pep-0426/#environment-markers + """ + try: + return pkg_resources.parse_version(setuptools.__version__) >= pkg_resources.parse_version('0.7.2') + except Exception as exc: + sys.stderr.write("Could not test setuptool's version: %s\n" % exc) + return False + + +def main(): + install_requires = ['py>=1.4.29'] # pluggy is vendored in _pytest.vendored_packages + extras_require = {} + if has_environment_marker_support(): + extras_require[':python_version=="2.6" or python_version=="3.0" or python_version=="3.1"'] = ['argparse'] + extras_require[':sys_platform=="win32"'] = ['colorama'] + else: + if sys.version_info < (2, 7) or (3,) <= sys.version_info < (3, 2): + install_requires.append('argparse') + if sys.platform == 'win32': + install_requires.append('colorama') + + setup( + name='pytest', + description='pytest: simple powerful testing with Python', + long_description=long_description, + version=get_version(), + url='http://pytest.org', + license='MIT license', + platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'], + author='Holger Krekel, Bruno Oliveira, Ronny Pfannschmidt, Floris Bruynooghe, Brianna Laugher, Florian Bruhin and others', + author_email='holger at merlinux.eu', + entry_points=make_entry_points(), + classifiers=classifiers, + cmdclass={'test': PyTest}, + # the following should be enabled for release + install_requires=install_requires, + extras_require=extras_require, + packages=['_pytest', '_pytest.assertion', '_pytest._code', '_pytest.vendored_packages'], + py_modules=['pytest'], + zip_safe=False, + ) + + +def cmdline_entrypoints(versioninfo, platform, basename): + target = 'pytest:main' + if platform.startswith('java'): + points = {'py.test-jython': target} + else: + if basename.startswith('pypy'): + points = {'py.test-%s' % basename: target} + else: # cpython + points = {'py.test-%s.%s' % versioninfo[:2] : target} + points['py.test'] = target + return points + + +def make_entry_points(): + basename = os.path.basename(sys.executable) + points = cmdline_entrypoints(sys.version_info, sys.platform, basename) + keys = list(points.keys()) + keys.sort() + l = ['%s = %s' % (x, points[x]) for x in keys] + return {'console_scripts': l} + + +class PyTest(Command): + user_options = [] + def initialize_options(self): + pass + def finalize_options(self): + pass + def run(self): + import subprocess + PPATH = [x for x in os.environ.get('PYTHONPATH', '').split(':') if x] + PPATH.insert(0, os.getcwd()) + os.environ['PYTHONPATH'] = ':'.join(PPATH) + errno = subprocess.call([sys.executable, 'pytest.py', '--ignore=doc']) + raise SystemExit(errno) + + +if __name__ == '__main__': + main() diff --git a/testing/web-platform/tests/tools/pytest/testing/acceptance_test.py b/testing/web-platform/tests/tools/pytest/testing/acceptance_test.py new file mode 100644 index 000000000..9bc3a191a --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/acceptance_test.py @@ -0,0 +1,695 @@ +import sys + +import _pytest._code +import py +import pytest +from _pytest.main import EXIT_NOTESTSCOLLECTED, EXIT_USAGEERROR + + +class TestGeneralUsage: + def test_config_error(self, testdir): + testdir.makeconftest(""" + def pytest_configure(config): + import pytest + raise pytest.UsageError("hello") + """) + result = testdir.runpytest(testdir.tmpdir) + assert result.ret != 0 + result.stderr.fnmatch_lines([ + '*ERROR: hello' + ]) + + def test_root_conftest_syntax_error(self, testdir): + testdir.makepyfile(conftest="raise SyntaxError\n") + result = testdir.runpytest() + result.stderr.fnmatch_lines(["*raise SyntaxError*"]) + assert result.ret != 0 + + def test_early_hook_error_issue38_1(self, testdir): + testdir.makeconftest(""" + def pytest_sessionstart(): + 0 / 0 + """) + result = testdir.runpytest(testdir.tmpdir) + assert result.ret != 0 + # tracestyle is native by default for hook failures + result.stdout.fnmatch_lines([ + '*INTERNALERROR*File*conftest.py*line 2*', + '*0 / 0*', + ]) + result = testdir.runpytest(testdir.tmpdir, "--fulltrace") + assert result.ret != 0 + # tracestyle is native by default for hook failures + result.stdout.fnmatch_lines([ + '*INTERNALERROR*def pytest_sessionstart():*', + '*INTERNALERROR*0 / 0*', + ]) + + def test_early_hook_configure_error_issue38(self, testdir): + testdir.makeconftest(""" + def pytest_configure(): + 0 / 0 + """) + result = testdir.runpytest(testdir.tmpdir) + assert result.ret != 0 + # here we get it on stderr + result.stderr.fnmatch_lines([ + '*INTERNALERROR*File*conftest.py*line 2*', + '*0 / 0*', + ]) + + def test_file_not_found(self, testdir): + result = testdir.runpytest("asd") + assert result.ret != 0 + result.stderr.fnmatch_lines(["ERROR: file not found*asd"]) + + def test_file_not_found_unconfigure_issue143(self, testdir): + testdir.makeconftest(""" + def pytest_configure(): + print("---configure") + def pytest_unconfigure(): + print("---unconfigure") + """) + result = testdir.runpytest("-s", "asd") + assert result.ret == 4 # EXIT_USAGEERROR + result.stderr.fnmatch_lines(["ERROR: file not found*asd"]) + result.stdout.fnmatch_lines([ + "*---configure", + "*---unconfigure", + ]) + + + def test_config_preparse_plugin_option(self, testdir): + testdir.makepyfile(pytest_xyz=""" + def pytest_addoption(parser): + parser.addoption("--xyz", dest="xyz", action="store") + """) + testdir.makepyfile(test_one=""" + def test_option(pytestconfig): + assert pytestconfig.option.xyz == "123" + """) + result = testdir.runpytest("-p", "pytest_xyz", "--xyz=123", syspathinsert=True) + assert result.ret == 0 + result.stdout.fnmatch_lines([ + '*1 passed*', + ]) + + def test_assertion_magic(self, testdir): + p = testdir.makepyfile(""" + def test_this(): + x = 0 + assert x + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "> assert x", + "E assert 0", + ]) + assert result.ret == 1 + + def test_nested_import_error(self, testdir): + p = testdir.makepyfile(""" + import import_fails + def test_this(): + assert import_fails.a == 1 + """) + testdir.makepyfile(import_fails="import does_not_work") + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + #XXX on jython this fails: "> import import_fails", + "E ImportError: No module named *does_not_work*", + ]) + assert result.ret == 1 + + def test_not_collectable_arguments(self, testdir): + p1 = testdir.makepyfile("") + p2 = testdir.makefile(".pyc", "123") + result = testdir.runpytest(p1, p2) + assert result.ret + result.stderr.fnmatch_lines([ + "*ERROR: not found:*%s" %(p2.basename,) + ]) + + def test_issue486_better_reporting_on_conftest_load_failure(self, testdir): + testdir.makepyfile("") + testdir.makeconftest("import qwerty") + result = testdir.runpytest("--help") + result.stdout.fnmatch_lines(""" + *--version* + *warning*conftest.py* + """) + result = testdir.runpytest() + result.stderr.fnmatch_lines(""" + *ERROR*could not load*conftest.py* + """) + + + def test_early_skip(self, testdir): + testdir.mkdir("xyz") + testdir.makeconftest(""" + import pytest + def pytest_collect_directory(): + pytest.skip("early") + """) + result = testdir.runpytest() + assert result.ret == EXIT_NOTESTSCOLLECTED + result.stdout.fnmatch_lines([ + "*1 skip*" + ]) + + def test_issue88_initial_file_multinodes(self, testdir): + testdir.makeconftest(""" + import pytest + class MyFile(pytest.File): + def collect(self): + return [MyItem("hello", parent=self)] + def pytest_collect_file(path, parent): + return MyFile(path, parent) + class MyItem(pytest.Item): + pass + """) + p = testdir.makepyfile("def test_hello(): pass") + result = testdir.runpytest(p, "--collect-only") + result.stdout.fnmatch_lines([ + "*MyFile*test_issue88*", + "*Module*test_issue88*", + ]) + + def test_issue93_initialnode_importing_capturing(self, testdir): + testdir.makeconftest(""" + import sys + print ("should not be seen") + sys.stderr.write("stder42\\n") + """) + result = testdir.runpytest() + assert result.ret == EXIT_NOTESTSCOLLECTED + assert "should not be seen" not in result.stdout.str() + assert "stderr42" not in result.stderr.str() + + def test_conftest_printing_shows_if_error(self, testdir): + testdir.makeconftest(""" + print ("should be seen") + assert 0 + """) + result = testdir.runpytest() + assert result.ret != 0 + assert "should be seen" in result.stdout.str() + + @pytest.mark.skipif(not hasattr(py.path.local, 'mksymlinkto'), + reason="symlink not available on this platform") + def test_chdir(self, testdir): + testdir.tmpdir.join("py").mksymlinkto(py._pydir) + p = testdir.tmpdir.join("main.py") + p.write(_pytest._code.Source(""" + import sys, os + sys.path.insert(0, '') + import py + print (py.__file__) + print (py.__path__) + os.chdir(os.path.dirname(os.getcwd())) + print (py.log) + """)) + result = testdir.runpython(p) + assert not result.ret + + def test_issue109_sibling_conftests_not_loaded(self, testdir): + sub1 = testdir.tmpdir.mkdir("sub1") + sub2 = testdir.tmpdir.mkdir("sub2") + sub1.join("conftest.py").write("assert 0") + result = testdir.runpytest(sub2) + assert result.ret == EXIT_NOTESTSCOLLECTED + sub2.ensure("__init__.py") + p = sub2.ensure("test_hello.py") + result = testdir.runpytest(p) + assert result.ret == EXIT_NOTESTSCOLLECTED + result = testdir.runpytest(sub1) + assert result.ret == EXIT_USAGEERROR + + def test_directory_skipped(self, testdir): + testdir.makeconftest(""" + import pytest + def pytest_ignore_collect(): + pytest.skip("intentional") + """) + testdir.makepyfile("def test_hello(): pass") + result = testdir.runpytest() + assert result.ret == EXIT_NOTESTSCOLLECTED + result.stdout.fnmatch_lines([ + "*1 skipped*" + ]) + + def test_multiple_items_per_collector_byid(self, testdir): + c = testdir.makeconftest(""" + import pytest + class MyItem(pytest.Item): + def runtest(self): + pass + class MyCollector(pytest.File): + def collect(self): + return [MyItem(name="xyz", parent=self)] + def pytest_collect_file(path, parent): + if path.basename.startswith("conftest"): + return MyCollector(path, parent) + """) + result = testdir.runpytest(c.basename+"::"+"xyz") + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*1 pass*", + ]) + + def test_skip_on_generated_funcarg_id(self, testdir): + testdir.makeconftest(""" + import pytest + def pytest_generate_tests(metafunc): + metafunc.addcall({'x': 3}, id='hello-123') + def pytest_runtest_setup(item): + print (item.keywords) + if 'hello-123' in item.keywords: + pytest.skip("hello") + assert 0 + """) + p = testdir.makepyfile("""def test_func(x): pass""") + res = testdir.runpytest(p) + assert res.ret == 0 + res.stdout.fnmatch_lines(["*1 skipped*"]) + + def test_direct_addressing_selects(self, testdir): + p = testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.addcall({'i': 1}, id="1") + metafunc.addcall({'i': 2}, id="2") + def test_func(i): + pass + """) + res = testdir.runpytest(p.basename + "::" + "test_func[1]") + assert res.ret == 0 + res.stdout.fnmatch_lines(["*1 passed*"]) + + def test_direct_addressing_notfound(self, testdir): + p = testdir.makepyfile(""" + def test_func(): + pass + """) + res = testdir.runpytest(p.basename + "::" + "test_notfound") + assert res.ret + res.stderr.fnmatch_lines(["*ERROR*not found*"]) + + def test_docstring_on_hookspec(self): + from _pytest import hookspec + for name, value in vars(hookspec).items(): + if name.startswith("pytest_"): + assert value.__doc__, "no docstring for %s" % name + + def test_initialization_error_issue49(self, testdir): + testdir.makeconftest(""" + def pytest_configure(): + x + """) + result = testdir.runpytest() + assert result.ret == 3 # internal error + result.stderr.fnmatch_lines([ + "INTERNAL*pytest_configure*", + "INTERNAL*x*", + ]) + assert 'sessionstarttime' not in result.stderr.str() + + @pytest.mark.parametrize('lookfor', ['test_fun.py', 'test_fun.py::test_a']) + def test_issue134_report_syntaxerror_when_collecting_member(self, testdir, lookfor): + testdir.makepyfile(test_fun=""" + def test_a(): + pass + def""") + result = testdir.runpytest(lookfor) + result.stdout.fnmatch_lines(['*SyntaxError*']) + if '::' in lookfor: + result.stderr.fnmatch_lines([ + '*ERROR*', + ]) + assert result.ret == 4 # usage error only if item not found + + def test_report_all_failed_collections_initargs(self, testdir): + testdir.makepyfile(test_a="def", test_b="def") + result = testdir.runpytest("test_a.py::a", "test_b.py::b") + result.stderr.fnmatch_lines([ + "*ERROR*test_a.py::a*", + "*ERROR*test_b.py::b*", + ]) + + def test_namespace_import_doesnt_confuse_import_hook(self, testdir): + # Ref #383. Python 3.3's namespace package messed with our import hooks + # Importing a module that didn't exist, even if the ImportError was + # gracefully handled, would make our test crash. + testdir.mkdir('not_a_package') + p = testdir.makepyfile(""" + try: + from not_a_package import doesnt_exist + except ImportError: + # We handle the import error gracefully here + pass + + def test_whatever(): + pass + """) + res = testdir.runpytest(p.basename) + assert res.ret == 0 + + def test_unknown_option(self, testdir): + result = testdir.runpytest("--qwlkej") + result.stderr.fnmatch_lines(""" + *unrecognized* + """) + + def test_getsourcelines_error_issue553(self, testdir, monkeypatch): + monkeypatch.setattr("inspect.getsourcelines", None) + p = testdir.makepyfile(""" + def raise_error(obj): + raise IOError('source code not available') + + import inspect + inspect.getsourcelines = raise_error + + def test_foo(invalid_fixture): + pass + """) + res = testdir.runpytest(p) + res.stdout.fnmatch_lines([ + "*source code not available*", + "*fixture 'invalid_fixture' not found", + ]) + + def test_plugins_given_as_strings(self, tmpdir, monkeypatch): + """test that str values passed to main() as `plugins` arg + are interpreted as module names to be imported and registered. + #855. + """ + with pytest.raises(ImportError) as excinfo: + pytest.main([str(tmpdir)], plugins=['invalid.module']) + assert 'invalid' in str(excinfo.value) + + p = tmpdir.join('test_test_plugins_given_as_strings.py') + p.write('def test_foo(): pass') + mod = py.std.types.ModuleType("myplugin") + monkeypatch.setitem(sys.modules, 'myplugin', mod) + assert pytest.main(args=[str(tmpdir)], plugins=['myplugin']) == 0 + + def test_parameterized_with_bytes_regex(self, testdir): + p = testdir.makepyfile(""" + import re + import pytest + @pytest.mark.parametrize('r', [re.compile(b'foo')]) + def test_stuff(r): + pass + """ + ) + res = testdir.runpytest(p) + res.stdout.fnmatch_lines([ + '*1 passed*' + ]) + + +class TestInvocationVariants: + def test_earlyinit(self, testdir): + p = testdir.makepyfile(""" + import pytest + assert hasattr(pytest, 'mark') + """) + result = testdir.runpython(p) + assert result.ret == 0 + + @pytest.mark.xfail("sys.platform.startswith('java')") + def test_pydoc(self, testdir): + for name in ('py.test', 'pytest'): + result = testdir.runpython_c("import %s;help(%s)" % (name, name)) + assert result.ret == 0 + s = result.stdout.str() + assert 'MarkGenerator' in s + + def test_import_star_py_dot_test(self, testdir): + p = testdir.makepyfile(""" + from py.test import * + #collect + #cmdline + #Item + #assert collect.Item is Item + #assert collect.Collector is Collector + main + skip + xfail + """) + result = testdir.runpython(p) + assert result.ret == 0 + + def test_import_star_pytest(self, testdir): + p = testdir.makepyfile(""" + from pytest import * + #Item + #File + main + skip + xfail + """) + result = testdir.runpython(p) + assert result.ret == 0 + + def test_double_pytestcmdline(self, testdir): + p = testdir.makepyfile(run=""" + import pytest + pytest.main() + pytest.main() + """) + testdir.makepyfile(""" + def test_hello(): + pass + """) + result = testdir.runpython(p) + result.stdout.fnmatch_lines([ + "*1 passed*", + "*1 passed*", + ]) + + def test_python_minus_m_invocation_ok(self, testdir): + p1 = testdir.makepyfile("def test_hello(): pass") + res = testdir.run(py.std.sys.executable, "-m", "pytest", str(p1)) + assert res.ret == 0 + + def test_python_minus_m_invocation_fail(self, testdir): + p1 = testdir.makepyfile("def test_fail(): 0/0") + res = testdir.run(py.std.sys.executable, "-m", "pytest", str(p1)) + assert res.ret == 1 + + def test_python_pytest_package(self, testdir): + p1 = testdir.makepyfile("def test_pass(): pass") + res = testdir.run(py.std.sys.executable, "-m", "pytest", str(p1)) + assert res.ret == 0 + res.stdout.fnmatch_lines(["*1 passed*"]) + + def test_equivalence_pytest_pytest(self): + assert pytest.main == py.test.cmdline.main + + def test_invoke_with_string(self, capsys): + retcode = pytest.main("-h") + assert not retcode + out, err = capsys.readouterr() + assert "--help" in out + pytest.raises(ValueError, lambda: pytest.main(0)) + + def test_invoke_with_path(self, tmpdir, capsys): + retcode = pytest.main(tmpdir) + assert retcode == EXIT_NOTESTSCOLLECTED + out, err = capsys.readouterr() + + def test_invoke_plugin_api(self, testdir, capsys): + class MyPlugin: + def pytest_addoption(self, parser): + parser.addoption("--myopt") + + pytest.main(["-h"], plugins=[MyPlugin()]) + out, err = capsys.readouterr() + assert "--myopt" in out + + def test_pyargs_importerror(self, testdir, monkeypatch): + monkeypatch.delenv('PYTHONDONTWRITEBYTECODE', False) + path = testdir.mkpydir("tpkg") + path.join("test_hello.py").write('raise ImportError') + + result = testdir.runpytest("--pyargs", "tpkg.test_hello") + assert result.ret != 0 + # FIXME: It would be more natural to match NOT + # "ERROR*file*or*package*not*found*". + result.stdout.fnmatch_lines([ + "*collected 0 items*" + ]) + + def test_cmdline_python_package(self, testdir, monkeypatch): + monkeypatch.delenv('PYTHONDONTWRITEBYTECODE', False) + path = testdir.mkpydir("tpkg") + path.join("test_hello.py").write("def test_hello(): pass") + path.join("test_world.py").write("def test_world(): pass") + result = testdir.runpytest("--pyargs", "tpkg") + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*2 passed*" + ]) + result = testdir.runpytest("--pyargs", "tpkg.test_hello") + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*1 passed*" + ]) + + def join_pythonpath(what): + cur = py.std.os.environ.get('PYTHONPATH') + if cur: + return str(what) + ':' + cur + return what + empty_package = testdir.mkpydir("empty_package") + monkeypatch.setenv('PYTHONPATH', join_pythonpath(empty_package)) + result = testdir.runpytest("--pyargs", ".") + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*2 passed*" + ]) + + monkeypatch.setenv('PYTHONPATH', join_pythonpath(testdir)) + path.join('test_hello.py').remove() + result = testdir.runpytest("--pyargs", "tpkg.test_hello") + assert result.ret != 0 + result.stderr.fnmatch_lines([ + "*not*found*test_hello*", + ]) + + def test_cmdline_python_package_not_exists(self, testdir): + result = testdir.runpytest("--pyargs", "tpkgwhatv") + assert result.ret + result.stderr.fnmatch_lines([ + "ERROR*file*or*package*not*found*", + ]) + + @pytest.mark.xfail(reason="decide: feature or bug") + def test_noclass_discovery_if_not_testcase(self, testdir): + testpath = testdir.makepyfile(""" + import unittest + class TestHello(object): + def test_hello(self): + assert self.attr + + class RealTest(unittest.TestCase, TestHello): + attr = 42 + """) + reprec = testdir.inline_run(testpath) + reprec.assertoutcome(passed=1) + + def test_doctest_id(self, testdir): + testdir.makefile('.txt', """ + >>> x=3 + >>> x + 4 + """) + result = testdir.runpytest("-rf") + lines = result.stdout.str().splitlines() + for line in lines: + if line.startswith("FAIL "): + testid = line[5:].strip() + break + result = testdir.runpytest(testid, '-rf') + result.stdout.fnmatch_lines([ + line, + "*1 failed*", + ]) + + def test_core_backward_compatibility(self): + """Test backward compatibility for get_plugin_manager function. See #787.""" + import _pytest.config + assert type(_pytest.config.get_plugin_manager()) is _pytest.config.PytestPluginManager + + + def test_has_plugin(self, request): + """Test hasplugin function of the plugin manager (#932).""" + assert request.config.pluginmanager.hasplugin('python') + + +class TestDurations: + source = """ + import time + frag = 0.002 + def test_something(): + pass + def test_2(): + time.sleep(frag*5) + def test_1(): + time.sleep(frag) + def test_3(): + time.sleep(frag*10) + """ + + def test_calls(self, testdir): + testdir.makepyfile(self.source) + result = testdir.runpytest("--durations=10") + assert result.ret == 0 + result.stdout.fnmatch_lines_random([ + "*durations*", + "*call*test_3*", + "*call*test_2*", + "*call*test_1*", + ]) + + def test_calls_show_2(self, testdir): + testdir.makepyfile(self.source) + result = testdir.runpytest("--durations=2") + assert result.ret == 0 + lines = result.stdout.get_lines_after("*slowest*durations*") + assert "4 passed" in lines[2] + + def test_calls_showall(self, testdir): + testdir.makepyfile(self.source) + result = testdir.runpytest("--durations=0") + assert result.ret == 0 + for x in "123": + for y in 'call',: #'setup', 'call', 'teardown': + for line in result.stdout.lines: + if ("test_%s" % x) in line and y in line: + break + else: + raise AssertionError("not found %s %s" % (x,y)) + + def test_with_deselected(self, testdir): + testdir.makepyfile(self.source) + result = testdir.runpytest("--durations=2", "-k test_1") + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*durations*", + "*call*test_1*", + ]) + + def test_with_failing_collection(self, testdir): + testdir.makepyfile(self.source) + testdir.makepyfile(test_collecterror="""xyz""") + result = testdir.runpytest("--durations=2", "-k test_1") + assert result.ret != 0 + result.stdout.fnmatch_lines([ + "*durations*", + "*call*test_1*", + ]) + + +class TestDurationWithFixture: + source = """ + import time + frag = 0.001 + def setup_function(func): + time.sleep(frag * 3) + def test_1(): + time.sleep(frag*2) + def test_2(): + time.sleep(frag) + """ + def test_setup_function(self, testdir): + testdir.makepyfile(self.source) + result = testdir.runpytest("--durations=10") + assert result.ret == 0 + + result.stdout.fnmatch_lines_random(""" + *durations* + * setup *test_1* + * call *test_1* + """) + diff --git a/testing/web-platform/tests/tools/pytest/testing/code/test_code.py b/testing/web-platform/tests/tools/pytest/testing/code/test_code.py new file mode 100644 index 000000000..0db4ad2ab --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/code/test_code.py @@ -0,0 +1,174 @@ +import sys + +import _pytest._code +import py +import pytest + + +def test_ne(): + code1 = _pytest._code.Code(compile('foo = "bar"', '', 'exec')) + assert code1 == code1 + code2 = _pytest._code.Code(compile('foo = "baz"', '', 'exec')) + assert code2 != code1 + +def test_code_gives_back_name_for_not_existing_file(): + name = 'abc-123' + co_code = compile("pass\n", name, 'exec') + assert co_code.co_filename == name + code = _pytest._code.Code(co_code) + assert str(code.path) == name + assert code.fullsource is None + +def test_code_with_class(): + class A: + pass + pytest.raises(TypeError, "_pytest._code.Code(A)") + +if True: + def x(): + pass + +def test_code_fullsource(): + code = _pytest._code.Code(x) + full = code.fullsource + assert 'test_code_fullsource()' in str(full) + +def test_code_source(): + code = _pytest._code.Code(x) + src = code.source() + expected = """def x(): + pass""" + assert str(src) == expected + +def test_frame_getsourcelineno_myself(): + def func(): + return sys._getframe(0) + f = func() + f = _pytest._code.Frame(f) + source, lineno = f.code.fullsource, f.lineno + assert source[lineno].startswith(" return sys._getframe(0)") + +def test_getstatement_empty_fullsource(): + def func(): + return sys._getframe(0) + f = func() + f = _pytest._code.Frame(f) + prop = f.code.__class__.fullsource + try: + f.code.__class__.fullsource = None + assert f.statement == _pytest._code.Source("") + finally: + f.code.__class__.fullsource = prop + +def test_code_from_func(): + co = _pytest._code.Code(test_frame_getsourcelineno_myself) + assert co.firstlineno + assert co.path + + + +def test_builtin_patch_unpatch(monkeypatch): + cpy_builtin = py.builtin.builtins + comp = cpy_builtin.compile + def mycompile(*args, **kwargs): + return comp(*args, **kwargs) + class Sub(AssertionError): + pass + monkeypatch.setattr(cpy_builtin, 'AssertionError', Sub) + monkeypatch.setattr(cpy_builtin, 'compile', mycompile) + _pytest._code.patch_builtins() + assert cpy_builtin.AssertionError != Sub + assert cpy_builtin.compile != mycompile + _pytest._code.unpatch_builtins() + assert cpy_builtin.AssertionError is Sub + assert cpy_builtin.compile == mycompile + + +def test_unicode_handling(): + value = py.builtin._totext('\xc4\x85\xc4\x87\n', 'utf-8').encode('utf8') + def f(): + raise Exception(value) + excinfo = pytest.raises(Exception, f) + str(excinfo) + if sys.version_info[0] < 3: + unicode(excinfo) + + +@pytest.mark.skipif(sys.version_info[0] >= 3, reason='python 2 only issue') +def test_unicode_handling_syntax_error(): + value = py.builtin._totext('\xc4\x85\xc4\x87\n', 'utf-8').encode('utf8') + def f(): + raise SyntaxError('invalid syntax', (None, 1, 3, value)) + excinfo = pytest.raises(Exception, f) + str(excinfo) + if sys.version_info[0] < 3: + unicode(excinfo) + +def test_code_getargs(): + def f1(x): + pass + c1 = _pytest._code.Code(f1) + assert c1.getargs(var=True) == ('x',) + + def f2(x, *y): + pass + c2 = _pytest._code.Code(f2) + assert c2.getargs(var=True) == ('x', 'y') + + def f3(x, **z): + pass + c3 = _pytest._code.Code(f3) + assert c3.getargs(var=True) == ('x', 'z') + + def f4(x, *y, **z): + pass + c4 = _pytest._code.Code(f4) + assert c4.getargs(var=True) == ('x', 'y', 'z') + + +def test_frame_getargs(): + def f1(x): + return sys._getframe(0) + fr1 = _pytest._code.Frame(f1('a')) + assert fr1.getargs(var=True) == [('x', 'a')] + + def f2(x, *y): + return sys._getframe(0) + fr2 = _pytest._code.Frame(f2('a', 'b', 'c')) + assert fr2.getargs(var=True) == [('x', 'a'), ('y', ('b', 'c'))] + + def f3(x, **z): + return sys._getframe(0) + fr3 = _pytest._code.Frame(f3('a', b='c')) + assert fr3.getargs(var=True) == [('x', 'a'), ('z', {'b': 'c'})] + + def f4(x, *y, **z): + return sys._getframe(0) + fr4 = _pytest._code.Frame(f4('a', 'b', c='d')) + assert fr4.getargs(var=True) == [('x', 'a'), ('y', ('b',)), + ('z', {'c': 'd'})] + + +class TestExceptionInfo: + + def test_bad_getsource(self): + try: + if False: pass + else: assert False + except AssertionError: + exci = _pytest._code.ExceptionInfo() + assert exci.getrepr() + + +class TestTracebackEntry: + + def test_getsource(self): + try: + if False: pass + else: assert False + except AssertionError: + exci = _pytest._code.ExceptionInfo() + entry = exci.traceback[0] + source = entry.getsource() + assert len(source) == 4 + assert 'else: assert False' in source[3] diff --git a/testing/web-platform/tests/tools/pytest/testing/code/test_excinfo.py b/testing/web-platform/tests/tools/pytest/testing/code/test_excinfo.py new file mode 100644 index 000000000..2defa3103 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/code/test_excinfo.py @@ -0,0 +1,911 @@ +# -*- coding: utf-8 -*- + +import _pytest +import py +import pytest +from _pytest._code.code import FormattedExcinfo, ReprExceptionInfo + +queue = py.builtin._tryimport('queue', 'Queue') + +failsonjython = pytest.mark.xfail("sys.platform.startswith('java')") +from test_source import astonly + +try: + import importlib +except ImportError: + invalidate_import_caches = None +else: + invalidate_import_caches = getattr(importlib, "invalidate_caches", None) + +import pytest +pytest_version_info = tuple(map(int, pytest.__version__.split(".")[:3])) + +class TWMock: + def __init__(self): + self.lines = [] + def sep(self, sep, line=None): + self.lines.append((sep, line)) + def line(self, line, **kw): + self.lines.append(line) + def markup(self, text, **kw): + return text + + fullwidth = 80 + +def test_excinfo_simple(): + try: + raise ValueError + except ValueError: + info = _pytest._code.ExceptionInfo() + assert info.type == ValueError + +def test_excinfo_getstatement(): + def g(): + raise ValueError + def f(): + g() + try: + f() + except ValueError: + excinfo = _pytest._code.ExceptionInfo() + linenumbers = [_pytest._code.getrawcode(f).co_firstlineno - 1 + 3, + _pytest._code.getrawcode(f).co_firstlineno - 1 + 1, + _pytest._code.getrawcode(g).co_firstlineno - 1 + 1, ] + l = list(excinfo.traceback) + foundlinenumbers = [x.lineno for x in l] + assert foundlinenumbers == linenumbers + #for x in info: + # print "%s:%d %s" %(x.path.relto(root), x.lineno, x.statement) + #xxx + +# testchain for getentries test below +def f(): + # + raise ValueError + # +def g(): + # + __tracebackhide__ = True + f() + # +def h(): + # + g() + # + +class TestTraceback_f_g_h: + def setup_method(self, method): + try: + h() + except ValueError: + self.excinfo = _pytest._code.ExceptionInfo() + + def test_traceback_entries(self): + tb = self.excinfo.traceback + entries = list(tb) + assert len(tb) == 4 # maybe fragile test + assert len(entries) == 4 # maybe fragile test + names = ['f', 'g', 'h'] + for entry in entries: + try: + names.remove(entry.frame.code.name) + except ValueError: + pass + assert not names + + def test_traceback_entry_getsource(self): + tb = self.excinfo.traceback + s = str(tb[-1].getsource() ) + assert s.startswith("def f():") + assert s.endswith("raise ValueError") + + @astonly + @failsonjython + def test_traceback_entry_getsource_in_construct(self): + source = _pytest._code.Source("""\ + def xyz(): + try: + raise ValueError + except somenoname: + pass + xyz() + """) + try: + exec (source.compile()) + except NameError: + tb = _pytest._code.ExceptionInfo().traceback + print (tb[-1].getsource()) + s = str(tb[-1].getsource()) + assert s.startswith("def xyz():\n try:") + assert s.strip().endswith("except somenoname:") + + def test_traceback_cut(self): + co = _pytest._code.Code(f) + path, firstlineno = co.path, co.firstlineno + traceback = self.excinfo.traceback + newtraceback = traceback.cut(path=path, firstlineno=firstlineno) + assert len(newtraceback) == 1 + newtraceback = traceback.cut(path=path, lineno=firstlineno+2) + assert len(newtraceback) == 1 + + def test_traceback_cut_excludepath(self, testdir): + p = testdir.makepyfile("def f(): raise ValueError") + excinfo = pytest.raises(ValueError, "p.pyimport().f()") + basedir = py.path.local(pytest.__file__).dirpath() + newtraceback = excinfo.traceback.cut(excludepath=basedir) + for x in newtraceback: + if hasattr(x, 'path'): + assert not py.path.local(x.path).relto(basedir) + assert newtraceback[-1].frame.code.path == p + + def test_traceback_filter(self): + traceback = self.excinfo.traceback + ntraceback = traceback.filter() + assert len(ntraceback) == len(traceback) - 1 + + def test_traceback_recursion_index(self): + def f(n): + if n < 10: + n += 1 + f(n) + excinfo = pytest.raises(RuntimeError, f, 8) + traceback = excinfo.traceback + recindex = traceback.recursionindex() + assert recindex == 3 + + def test_traceback_only_specific_recursion_errors(self, monkeypatch): + def f(n): + if n == 0: + raise RuntimeError("hello") + f(n-1) + + excinfo = pytest.raises(RuntimeError, f, 100) + monkeypatch.delattr(excinfo.traceback.__class__, "recursionindex") + repr = excinfo.getrepr() + assert "RuntimeError: hello" in str(repr.reprcrash) + + def test_traceback_no_recursion_index(self): + def do_stuff(): + raise RuntimeError + def reraise_me(): + import sys + exc, val, tb = sys.exc_info() + py.builtin._reraise(exc, val, tb) + def f(n): + try: + do_stuff() + except: + reraise_me() + excinfo = pytest.raises(RuntimeError, f, 8) + traceback = excinfo.traceback + recindex = traceback.recursionindex() + assert recindex is None + + def test_traceback_messy_recursion(self): + #XXX: simplified locally testable version + decorator = pytest.importorskip('decorator').decorator + + def log(f, *k, **kw): + print('%s %s' % (k, kw)) + f(*k, **kw) + log = decorator(log) + + def fail(): + raise ValueError('') + + fail = log(log(fail)) + + excinfo = pytest.raises(ValueError, fail) + assert excinfo.traceback.recursionindex() is None + + + + def test_traceback_getcrashentry(self): + def i(): + __tracebackhide__ = True + raise ValueError + def h(): + i() + def g(): + __tracebackhide__ = True + h() + def f(): + g() + + excinfo = pytest.raises(ValueError, f) + tb = excinfo.traceback + entry = tb.getcrashentry() + co = _pytest._code.Code(h) + assert entry.frame.code.path == co.path + assert entry.lineno == co.firstlineno + 1 + assert entry.frame.code.name == 'h' + + def test_traceback_getcrashentry_empty(self): + def g(): + __tracebackhide__ = True + raise ValueError + def f(): + __tracebackhide__ = True + g() + + excinfo = pytest.raises(ValueError, f) + tb = excinfo.traceback + entry = tb.getcrashentry() + co = _pytest._code.Code(g) + assert entry.frame.code.path == co.path + assert entry.lineno == co.firstlineno + 2 + assert entry.frame.code.name == 'g' + +def hello(x): + x + 5 + +def test_tbentry_reinterpret(): + try: + hello("hello") + except TypeError: + excinfo = _pytest._code.ExceptionInfo() + tbentry = excinfo.traceback[-1] + msg = tbentry.reinterpret() + assert msg.startswith("TypeError: ('hello' + 5)") + +def test_excinfo_exconly(): + excinfo = pytest.raises(ValueError, h) + assert excinfo.exconly().startswith('ValueError') + excinfo = pytest.raises(ValueError, + "raise ValueError('hello\\nworld')") + msg = excinfo.exconly(tryshort=True) + assert msg.startswith('ValueError') + assert msg.endswith("world") + +def test_excinfo_repr(): + excinfo = pytest.raises(ValueError, h) + s = repr(excinfo) + assert s == "<ExceptionInfo ValueError tblen=4>" + +def test_excinfo_str(): + excinfo = pytest.raises(ValueError, h) + s = str(excinfo) + assert s.startswith(__file__[:-9]) # pyc file and $py.class + assert s.endswith("ValueError") + assert len(s.split(":")) >= 3 # on windows it's 4 + +def test_excinfo_errisinstance(): + excinfo = pytest.raises(ValueError, h) + assert excinfo.errisinstance(ValueError) + +def test_excinfo_no_sourcecode(): + try: + exec ("raise ValueError()") + except ValueError: + excinfo = _pytest._code.ExceptionInfo() + s = str(excinfo.traceback[-1]) + if py.std.sys.version_info < (2,5): + assert s == " File '<string>':1 in ?\n ???\n" + else: + assert s == " File '<string>':1 in <module>\n ???\n" + +def test_excinfo_no_python_sourcecode(tmpdir): + #XXX: simplified locally testable version + tmpdir.join('test.txt').write("{{ h()}}:") + + jinja2 = pytest.importorskip('jinja2') + loader = jinja2.FileSystemLoader(str(tmpdir)) + env = jinja2.Environment(loader=loader) + template = env.get_template('test.txt') + excinfo = pytest.raises(ValueError, + template.render, h=h) + for item in excinfo.traceback: + print(item) #XXX: for some reason jinja.Template.render is printed in full + item.source # shouldnt fail + if item.path.basename == 'test.txt': + assert str(item.source) == '{{ h()}}:' + + +def test_entrysource_Queue_example(): + try: + queue.Queue().get(timeout=0.001) + except queue.Empty: + excinfo = _pytest._code.ExceptionInfo() + entry = excinfo.traceback[-1] + source = entry.getsource() + assert source is not None + s = str(source).strip() + assert s.startswith("def get") + +def test_codepath_Queue_example(): + try: + queue.Queue().get(timeout=0.001) + except queue.Empty: + excinfo = _pytest._code.ExceptionInfo() + entry = excinfo.traceback[-1] + path = entry.path + assert isinstance(path, py.path.local) + assert path.basename.lower() == "queue.py" + assert path.check() + +class TestFormattedExcinfo: + def pytest_funcarg__importasmod(self, request): + def importasmod(source): + source = _pytest._code.Source(source) + tmpdir = request.getfuncargvalue("tmpdir") + modpath = tmpdir.join("mod.py") + tmpdir.ensure("__init__.py") + modpath.write(source) + if invalidate_import_caches is not None: + invalidate_import_caches() + return modpath.pyimport() + return importasmod + + def excinfo_from_exec(self, source): + source = _pytest._code.Source(source).strip() + try: + exec (source.compile()) + except KeyboardInterrupt: + raise + except: + return _pytest._code.ExceptionInfo() + assert 0, "did not raise" + + def test_repr_source(self): + pr = FormattedExcinfo() + source = _pytest._code.Source(""" + def f(x): + pass + """).strip() + pr.flow_marker = "|" + lines = pr.get_source(source, 0) + assert len(lines) == 2 + assert lines[0] == "| def f(x):" + assert lines[1] == " pass" + + def test_repr_source_excinfo(self): + """ check if indentation is right """ + pr = FormattedExcinfo() + excinfo = self.excinfo_from_exec(""" + def f(): + assert 0 + f() + """) + pr = FormattedExcinfo() + source = pr._getentrysource(excinfo.traceback[-1]) + lines = pr.get_source(source, 1, excinfo) + assert lines == [ + ' def f():', + '> assert 0', + 'E assert 0' + ] + + + def test_repr_source_not_existing(self): + pr = FormattedExcinfo() + co = compile("raise ValueError()", "", "exec") + try: + exec (co) + except ValueError: + excinfo = _pytest._code.ExceptionInfo() + repr = pr.repr_excinfo(excinfo) + assert repr.reprtraceback.reprentries[1].lines[0] == "> ???" + + def test_repr_many_line_source_not_existing(self): + pr = FormattedExcinfo() + co = compile(""" +a = 1 +raise ValueError() +""", "", "exec") + try: + exec (co) + except ValueError: + excinfo = _pytest._code.ExceptionInfo() + repr = pr.repr_excinfo(excinfo) + assert repr.reprtraceback.reprentries[1].lines[0] == "> ???" + + def test_repr_source_failing_fullsource(self): + pr = FormattedExcinfo() + + class FakeCode(object): + class raw: + co_filename = '?' + path = '?' + firstlineno = 5 + + def fullsource(self): + return None + fullsource = property(fullsource) + + class FakeFrame(object): + code = FakeCode() + f_locals = {} + f_globals = {} + + class FakeTracebackEntry(_pytest._code.Traceback.Entry): + def __init__(self, tb): + self.lineno = 5+3 + + @property + def frame(self): + return FakeFrame() + + class Traceback(_pytest._code.Traceback): + Entry = FakeTracebackEntry + + class FakeExcinfo(_pytest._code.ExceptionInfo): + typename = "Foo" + def __init__(self): + pass + + def exconly(self, tryshort): + return "EXC" + def errisinstance(self, cls): + return False + + excinfo = FakeExcinfo() + class FakeRawTB(object): + tb_next = None + tb = FakeRawTB() + excinfo.traceback = Traceback(tb) + + fail = IOError() # noqa + repr = pr.repr_excinfo(excinfo) + assert repr.reprtraceback.reprentries[0].lines[0] == "> ???" + + fail = py.error.ENOENT # noqa + repr = pr.repr_excinfo(excinfo) + assert repr.reprtraceback.reprentries[0].lines[0] == "> ???" + + + def test_repr_local(self): + p = FormattedExcinfo(showlocals=True) + loc = {'y': 5, 'z': 7, 'x': 3, '@x': 2, '__builtins__': {}} + reprlocals = p.repr_locals(loc) + assert reprlocals.lines + assert reprlocals.lines[0] == '__builtins__ = <builtins>' + assert reprlocals.lines[1] == 'x = 3' + assert reprlocals.lines[2] == 'y = 5' + assert reprlocals.lines[3] == 'z = 7' + + def test_repr_tracebackentry_lines(self, importasmod): + mod = importasmod(""" + def func1(): + raise ValueError("hello\\nworld") + """) + excinfo = pytest.raises(ValueError, mod.func1) + excinfo.traceback = excinfo.traceback.filter() + p = FormattedExcinfo() + reprtb = p.repr_traceback_entry(excinfo.traceback[-1]) + + # test as intermittent entry + lines = reprtb.lines + assert lines[0] == ' def func1():' + assert lines[1] == '> raise ValueError("hello\\nworld")' + + # test as last entry + p = FormattedExcinfo(showlocals=True) + repr_entry = p.repr_traceback_entry(excinfo.traceback[-1], excinfo) + lines = repr_entry.lines + assert lines[0] == ' def func1():' + assert lines[1] == '> raise ValueError("hello\\nworld")' + assert lines[2] == 'E ValueError: hello' + assert lines[3] == 'E world' + assert not lines[4:] + + loc = repr_entry.reprlocals is not None + loc = repr_entry.reprfileloc + assert loc.path == mod.__file__ + assert loc.lineno == 3 + #assert loc.message == "ValueError: hello" + + def test_repr_tracebackentry_lines2(self, importasmod): + mod = importasmod(""" + def func1(m, x, y, z): + raise ValueError("hello\\nworld") + """) + excinfo = pytest.raises(ValueError, mod.func1, "m"*90, 5, 13, "z"*120) + excinfo.traceback = excinfo.traceback.filter() + entry = excinfo.traceback[-1] + p = FormattedExcinfo(funcargs=True) + reprfuncargs = p.repr_args(entry) + assert reprfuncargs.args[0] == ('m', repr("m"*90)) + assert reprfuncargs.args[1] == ('x', '5') + assert reprfuncargs.args[2] == ('y', '13') + assert reprfuncargs.args[3] == ('z', repr("z" * 120)) + + p = FormattedExcinfo(funcargs=True) + repr_entry = p.repr_traceback_entry(entry) + assert repr_entry.reprfuncargs.args == reprfuncargs.args + tw = TWMock() + repr_entry.toterminal(tw) + assert tw.lines[0] == "m = " + repr('m' * 90) + assert tw.lines[1] == "x = 5, y = 13" + assert tw.lines[2] == "z = " + repr('z' * 120) + + def test_repr_tracebackentry_lines_var_kw_args(self, importasmod): + mod = importasmod(""" + def func1(x, *y, **z): + raise ValueError("hello\\nworld") + """) + excinfo = pytest.raises(ValueError, mod.func1, 'a', 'b', c='d') + excinfo.traceback = excinfo.traceback.filter() + entry = excinfo.traceback[-1] + p = FormattedExcinfo(funcargs=True) + reprfuncargs = p.repr_args(entry) + assert reprfuncargs.args[0] == ('x', repr('a')) + assert reprfuncargs.args[1] == ('y', repr(('b',))) + assert reprfuncargs.args[2] == ('z', repr({'c': 'd'})) + + p = FormattedExcinfo(funcargs=True) + repr_entry = p.repr_traceback_entry(entry) + assert repr_entry.reprfuncargs.args == reprfuncargs.args + tw = TWMock() + repr_entry.toterminal(tw) + assert tw.lines[0] == "x = 'a', y = ('b',), z = {'c': 'd'}" + + def test_repr_tracebackentry_short(self, importasmod): + mod = importasmod(""" + def func1(): + raise ValueError("hello") + def entry(): + func1() + """) + excinfo = pytest.raises(ValueError, mod.entry) + p = FormattedExcinfo(style="short") + reprtb = p.repr_traceback_entry(excinfo.traceback[-2]) + lines = reprtb.lines + basename = py.path.local(mod.__file__).basename + assert lines[0] == ' func1()' + assert basename in str(reprtb.reprfileloc.path) + assert reprtb.reprfileloc.lineno == 5 + + # test last entry + p = FormattedExcinfo(style="short") + reprtb = p.repr_traceback_entry(excinfo.traceback[-1], excinfo) + lines = reprtb.lines + assert lines[0] == ' raise ValueError("hello")' + assert lines[1] == 'E ValueError: hello' + assert basename in str(reprtb.reprfileloc.path) + assert reprtb.reprfileloc.lineno == 3 + + def test_repr_tracebackentry_no(self, importasmod): + mod = importasmod(""" + def func1(): + raise ValueError("hello") + def entry(): + func1() + """) + excinfo = pytest.raises(ValueError, mod.entry) + p = FormattedExcinfo(style="no") + p.repr_traceback_entry(excinfo.traceback[-2]) + + p = FormattedExcinfo(style="no") + reprentry = p.repr_traceback_entry(excinfo.traceback[-1], excinfo) + lines = reprentry.lines + assert lines[0] == 'E ValueError: hello' + assert not lines[1:] + + def test_repr_traceback_tbfilter(self, importasmod): + mod = importasmod(""" + def f(x): + raise ValueError(x) + def entry(): + f(0) + """) + excinfo = pytest.raises(ValueError, mod.entry) + p = FormattedExcinfo(tbfilter=True) + reprtb = p.repr_traceback(excinfo) + assert len(reprtb.reprentries) == 2 + p = FormattedExcinfo(tbfilter=False) + reprtb = p.repr_traceback(excinfo) + assert len(reprtb.reprentries) == 3 + + def test_traceback_short_no_source(self, importasmod, monkeypatch): + mod = importasmod(""" + def func1(): + raise ValueError("hello") + def entry(): + func1() + """) + excinfo = pytest.raises(ValueError, mod.entry) + from _pytest._code.code import Code + monkeypatch.setattr(Code, 'path', 'bogus') + excinfo.traceback[0].frame.code.path = "bogus" + p = FormattedExcinfo(style="short") + reprtb = p.repr_traceback_entry(excinfo.traceback[-2]) + lines = reprtb.lines + last_p = FormattedExcinfo(style="short") + last_reprtb = last_p.repr_traceback_entry(excinfo.traceback[-1], excinfo) + last_lines = last_reprtb.lines + monkeypatch.undo() + assert lines[0] == ' func1()' + + assert last_lines[0] == ' raise ValueError("hello")' + assert last_lines[1] == 'E ValueError: hello' + + def test_repr_traceback_and_excinfo(self, importasmod): + mod = importasmod(""" + def f(x): + raise ValueError(x) + def entry(): + f(0) + """) + excinfo = pytest.raises(ValueError, mod.entry) + + for style in ("long", "short"): + p = FormattedExcinfo(style=style) + reprtb = p.repr_traceback(excinfo) + assert len(reprtb.reprentries) == 2 + assert reprtb.style == style + assert not reprtb.extraline + repr = p.repr_excinfo(excinfo) + assert repr.reprtraceback + assert len(repr.reprtraceback.reprentries) == len(reprtb.reprentries) + assert repr.reprcrash.path.endswith("mod.py") + assert repr.reprcrash.message == "ValueError: 0" + + def test_repr_traceback_with_invalid_cwd(self, importasmod, monkeypatch): + mod = importasmod(""" + def f(x): + raise ValueError(x) + def entry(): + f(0) + """) + excinfo = pytest.raises(ValueError, mod.entry) + + p = FormattedExcinfo() + def raiseos(): + raise OSError(2) + monkeypatch.setattr(py.std.os, 'getcwd', raiseos) + assert p._makepath(__file__) == __file__ + p.repr_traceback(excinfo) + + def test_repr_excinfo_addouterr(self, importasmod): + mod = importasmod(""" + def entry(): + raise ValueError() + """) + excinfo = pytest.raises(ValueError, mod.entry) + repr = excinfo.getrepr() + repr.addsection("title", "content") + twmock = TWMock() + repr.toterminal(twmock) + assert twmock.lines[-1] == "content" + assert twmock.lines[-2] == ("-", "title") + + def test_repr_excinfo_reprcrash(self, importasmod): + mod = importasmod(""" + def entry(): + raise ValueError() + """) + excinfo = pytest.raises(ValueError, mod.entry) + repr = excinfo.getrepr() + assert repr.reprcrash.path.endswith("mod.py") + assert repr.reprcrash.lineno == 3 + assert repr.reprcrash.message == "ValueError" + assert str(repr.reprcrash).endswith("mod.py:3: ValueError") + + def test_repr_traceback_recursion(self, importasmod): + mod = importasmod(""" + def rec2(x): + return rec1(x+1) + def rec1(x): + return rec2(x-1) + def entry(): + rec1(42) + """) + excinfo = pytest.raises(RuntimeError, mod.entry) + + for style in ("short", "long", "no"): + p = FormattedExcinfo(style="short") + reprtb = p.repr_traceback(excinfo) + assert reprtb.extraline == "!!! Recursion detected (same locals & position)" + assert str(reprtb) + + def test_tb_entry_AssertionError(self, importasmod): + # probably this test is a bit redundant + # as py/magic/testing/test_assertion.py + # already tests correctness of + # assertion-reinterpretation logic + mod = importasmod(""" + def somefunc(): + x = 1 + assert x == 2 + """) + excinfo = pytest.raises(AssertionError, mod.somefunc) + + p = FormattedExcinfo() + reprentry = p.repr_traceback_entry(excinfo.traceback[-1], excinfo) + lines = reprentry.lines + assert lines[-1] == "E assert 1 == 2" + + def test_reprexcinfo_getrepr(self, importasmod): + mod = importasmod(""" + def f(x): + raise ValueError(x) + def entry(): + f(0) + """) + excinfo = pytest.raises(ValueError, mod.entry) + + for style in ("short", "long", "no"): + for showlocals in (True, False): + repr = excinfo.getrepr(style=style, showlocals=showlocals) + assert isinstance(repr, ReprExceptionInfo) + assert repr.reprtraceback.style == style + + def test_reprexcinfo_unicode(self): + from _pytest._code.code import TerminalRepr + class MyRepr(TerminalRepr): + def toterminal(self, tw): + tw.line(py.builtin._totext("я", "utf-8")) + x = py.builtin._totext(MyRepr()) + assert x == py.builtin._totext("я", "utf-8") + + def test_toterminal_long(self, importasmod): + mod = importasmod(""" + def g(x): + raise ValueError(x) + def f(): + g(3) + """) + excinfo = pytest.raises(ValueError, mod.f) + excinfo.traceback = excinfo.traceback.filter() + repr = excinfo.getrepr() + tw = TWMock() + repr.toterminal(tw) + assert tw.lines[0] == "" + tw.lines.pop(0) + assert tw.lines[0] == " def f():" + assert tw.lines[1] == "> g(3)" + assert tw.lines[2] == "" + assert tw.lines[3].endswith("mod.py:5: ") + assert tw.lines[4] == ("_ ", None) + assert tw.lines[5] == "" + assert tw.lines[6] == " def g(x):" + assert tw.lines[7] == "> raise ValueError(x)" + assert tw.lines[8] == "E ValueError: 3" + assert tw.lines[9] == "" + assert tw.lines[10].endswith("mod.py:3: ValueError") + + def test_toterminal_long_missing_source(self, importasmod, tmpdir): + mod = importasmod(""" + def g(x): + raise ValueError(x) + def f(): + g(3) + """) + excinfo = pytest.raises(ValueError, mod.f) + tmpdir.join('mod.py').remove() + excinfo.traceback = excinfo.traceback.filter() + repr = excinfo.getrepr() + tw = TWMock() + repr.toterminal(tw) + assert tw.lines[0] == "" + tw.lines.pop(0) + assert tw.lines[0] == "> ???" + assert tw.lines[1] == "" + assert tw.lines[2].endswith("mod.py:5: ") + assert tw.lines[3] == ("_ ", None) + assert tw.lines[4] == "" + assert tw.lines[5] == "> ???" + assert tw.lines[6] == "E ValueError: 3" + assert tw.lines[7] == "" + assert tw.lines[8].endswith("mod.py:3: ValueError") + + def test_toterminal_long_incomplete_source(self, importasmod, tmpdir): + mod = importasmod(""" + def g(x): + raise ValueError(x) + def f(): + g(3) + """) + excinfo = pytest.raises(ValueError, mod.f) + tmpdir.join('mod.py').write('asdf') + excinfo.traceback = excinfo.traceback.filter() + repr = excinfo.getrepr() + tw = TWMock() + repr.toterminal(tw) + assert tw.lines[0] == "" + tw.lines.pop(0) + assert tw.lines[0] == "> ???" + assert tw.lines[1] == "" + assert tw.lines[2].endswith("mod.py:5: ") + assert tw.lines[3] == ("_ ", None) + assert tw.lines[4] == "" + assert tw.lines[5] == "> ???" + assert tw.lines[6] == "E ValueError: 3" + assert tw.lines[7] == "" + assert tw.lines[8].endswith("mod.py:3: ValueError") + + def test_toterminal_long_filenames(self, importasmod): + mod = importasmod(""" + def f(): + raise ValueError() + """) + excinfo = pytest.raises(ValueError, mod.f) + tw = TWMock() + path = py.path.local(mod.__file__) + old = path.dirpath().chdir() + try: + repr = excinfo.getrepr(abspath=False) + repr.toterminal(tw) + line = tw.lines[-1] + x = py.path.local().bestrelpath(path) + if len(x) < len(str(path)): + assert line == "mod.py:3: ValueError" + + repr = excinfo.getrepr(abspath=True) + repr.toterminal(tw) + line = tw.lines[-1] + assert line == "%s:3: ValueError" %(path,) + finally: + old.chdir() + + @pytest.mark.parametrize('reproptions', [ + {'style': style, 'showlocals': showlocals, + 'funcargs': funcargs, 'tbfilter': tbfilter + } for style in ("long", "short", "no") + for showlocals in (True, False) + for tbfilter in (True, False) + for funcargs in (True, False)]) + def test_format_excinfo(self, importasmod, reproptions): + mod = importasmod(""" + def g(x): + raise ValueError(x) + def f(): + g(3) + """) + excinfo = pytest.raises(ValueError, mod.f) + tw = py.io.TerminalWriter(stringio=True) + repr = excinfo.getrepr(**reproptions) + repr.toterminal(tw) + assert tw.stringio.getvalue() + + + def test_native_style(self): + excinfo = self.excinfo_from_exec(""" + assert 0 + """) + repr = excinfo.getrepr(style='native') + assert "assert 0" in str(repr.reprcrash) + s = str(repr) + assert s.startswith('Traceback (most recent call last):\n File') + assert s.endswith('\nAssertionError: assert 0') + assert 'exec (source.compile())' in s + # python 2.4 fails to get the source line for the assert + if py.std.sys.version_info >= (2, 5): + assert s.count('assert 0') == 2 + + def test_traceback_repr_style(self, importasmod): + mod = importasmod(""" + def f(): + g() + def g(): + h() + def h(): + i() + def i(): + raise ValueError() + """) + excinfo = pytest.raises(ValueError, mod.f) + excinfo.traceback = excinfo.traceback.filter() + excinfo.traceback[1].set_repr_style("short") + excinfo.traceback[2].set_repr_style("short") + r = excinfo.getrepr(style="long") + tw = TWMock() + r.toterminal(tw) + for line in tw.lines: print (line) + assert tw.lines[0] == "" + assert tw.lines[1] == " def f():" + assert tw.lines[2] == "> g()" + assert tw.lines[3] == "" + assert tw.lines[4].endswith("mod.py:3: ") + assert tw.lines[5] == ("_ ", None) + assert tw.lines[6].endswith("in g") + assert tw.lines[7] == " h()" + assert tw.lines[8].endswith("in h") + assert tw.lines[9] == " i()" + assert tw.lines[10] == ("_ ", None) + assert tw.lines[11] == "" + assert tw.lines[12] == " def i():" + assert tw.lines[13] == "> raise ValueError()" + assert tw.lines[14] == "E ValueError" + assert tw.lines[15] == "" + assert tw.lines[16].endswith("mod.py:9: ValueError") diff --git a/testing/web-platform/tests/tools/pytest/testing/code/test_source.py b/testing/web-platform/tests/tools/pytest/testing/code/test_source.py new file mode 100644 index 000000000..007ad1433 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/code/test_source.py @@ -0,0 +1,659 @@ +# flake8: noqa +# disable flake check on this file because some constructs are strange +# or redundant on purpose and can't be disable on a line-by-line basis +import sys + +import _pytest._code +import py +import pytest +from _pytest._code import Source +from _pytest._code.source import _ast + +if _ast is not None: + astonly = pytest.mark.nothing +else: + astonly = pytest.mark.xfail("True", reason="only works with AST-compile") + +failsonjython = pytest.mark.xfail("sys.platform.startswith('java')") + +def test_source_str_function(): + x = Source("3") + assert str(x) == "3" + + x = Source(" 3") + assert str(x) == "3" + + x = Source(""" + 3 + """, rstrip=False) + assert str(x) == "\n3\n " + + x = Source(""" + 3 + """, rstrip=True) + assert str(x) == "\n3" + +def test_unicode(): + try: + unicode + except NameError: + return + x = Source(unicode("4")) + assert str(x) == "4" + co = _pytest._code.compile(unicode('u"\xc3\xa5"', 'utf8'), mode='eval') + val = eval(co) + assert isinstance(val, unicode) + +def test_source_from_function(): + source = _pytest._code.Source(test_source_str_function) + assert str(source).startswith('def test_source_str_function():') + +def test_source_from_method(): + class TestClass: + def test_method(self): + pass + source = _pytest._code.Source(TestClass().test_method) + assert source.lines == ["def test_method(self):", + " pass"] + +def test_source_from_lines(): + lines = ["a \n", "b\n", "c"] + source = _pytest._code.Source(lines) + assert source.lines == ['a ', 'b', 'c'] + +def test_source_from_inner_function(): + def f(): + pass + source = _pytest._code.Source(f, deindent=False) + assert str(source).startswith(' def f():') + source = _pytest._code.Source(f) + assert str(source).startswith('def f():') + +def test_source_putaround_simple(): + source = Source("raise ValueError") + source = source.putaround( + "try:", """\ + except ValueError: + x = 42 + else: + x = 23""") + assert str(source)=="""\ +try: + raise ValueError +except ValueError: + x = 42 +else: + x = 23""" + +def test_source_putaround(): + source = Source() + source = source.putaround(""" + if 1: + x=1 + """) + assert str(source).strip() == "if 1:\n x=1" + +def test_source_strips(): + source = Source("") + assert source == Source() + assert str(source) == '' + assert source.strip() == source + +def test_source_strip_multiline(): + source = Source() + source.lines = ["", " hello", " "] + source2 = source.strip() + assert source2.lines == [" hello"] + +def test_syntaxerror_rerepresentation(): + ex = pytest.raises(SyntaxError, _pytest._code.compile, 'xyz xyz') + assert ex.value.lineno == 1 + assert ex.value.offset in (4,7) # XXX pypy/jython versus cpython? + assert ex.value.text.strip(), 'x x' + +def test_isparseable(): + assert Source("hello").isparseable() + assert Source("if 1:\n pass").isparseable() + assert Source(" \nif 1:\n pass").isparseable() + assert not Source("if 1:\n").isparseable() + assert not Source(" \nif 1:\npass").isparseable() + assert not Source(chr(0)).isparseable() + +class TestAccesses: + source = Source("""\ + def f(x): + pass + def g(x): + pass + """) + def test_getrange(self): + x = self.source[0:2] + assert x.isparseable() + assert len(x.lines) == 2 + assert str(x) == "def f(x):\n pass" + + def test_getline(self): + x = self.source[0] + assert x == "def f(x):" + + def test_len(self): + assert len(self.source) == 4 + + def test_iter(self): + l = [x for x in self.source] + assert len(l) == 4 + +class TestSourceParsingAndCompiling: + source = Source("""\ + def f(x): + assert (x == + 3 + + 4) + """).strip() + + def test_compile(self): + co = _pytest._code.compile("x=3") + d = {} + exec (co, d) + assert d['x'] == 3 + + def test_compile_and_getsource_simple(self): + co = _pytest._code.compile("x=3") + exec (co) + source = _pytest._code.Source(co) + assert str(source) == "x=3" + + def test_compile_and_getsource_through_same_function(self): + def gensource(source): + return _pytest._code.compile(source) + co1 = gensource(""" + def f(): + raise KeyError() + """) + co2 = gensource(""" + def f(): + raise ValueError() + """) + source1 = py.std.inspect.getsource(co1) + assert 'KeyError' in source1 + source2 = py.std.inspect.getsource(co2) + assert 'ValueError' in source2 + + def test_getstatement(self): + #print str(self.source) + ass = str(self.source[1:]) + for i in range(1, 4): + #print "trying start in line %r" % self.source[i] + s = self.source.getstatement(i) + #x = s.deindent() + assert str(s) == ass + + def test_getstatementrange_triple_quoted(self): + #print str(self.source) + source = Source("""hello(''' + ''')""") + s = source.getstatement(0) + assert s == str(source) + s = source.getstatement(1) + assert s == str(source) + + @astonly + def test_getstatementrange_within_constructs(self): + source = Source("""\ + try: + try: + raise ValueError + except SomeThing: + pass + finally: + 42 + """) + assert len(source) == 7 + # check all lineno's that could occur in a traceback + #assert source.getstatementrange(0) == (0, 7) + #assert source.getstatementrange(1) == (1, 5) + assert source.getstatementrange(2) == (2, 3) + assert source.getstatementrange(3) == (3, 4) + assert source.getstatementrange(4) == (4, 5) + #assert source.getstatementrange(5) == (0, 7) + assert source.getstatementrange(6) == (6, 7) + + def test_getstatementrange_bug(self): + source = Source("""\ + try: + x = ( + y + + z) + except: + pass + """) + assert len(source) == 6 + assert source.getstatementrange(2) == (1, 4) + + def test_getstatementrange_bug2(self): + source = Source("""\ + assert ( + 33 + == + [ + X(3, + b=1, c=2 + ), + ] + ) + """) + assert len(source) == 9 + assert source.getstatementrange(5) == (0, 9) + + def test_getstatementrange_ast_issue58(self): + source = Source("""\ + + def test_some(): + for a in [a for a in + CAUSE_ERROR]: pass + + x = 3 + """) + assert getstatement(2, source).lines == source.lines[2:3] + assert getstatement(3, source).lines == source.lines[3:4] + + @pytest.mark.skipif("sys.version_info < (2,6)") + def test_getstatementrange_out_of_bounds_py3(self): + source = Source("if xxx:\n from .collections import something") + r = source.getstatementrange(1) + assert r == (1,2) + + def test_getstatementrange_with_syntaxerror_issue7(self): + source = Source(":") + pytest.raises(SyntaxError, lambda: source.getstatementrange(0)) + + @pytest.mark.skipif("sys.version_info < (2,6)") + def test_compile_to_ast(self): + import ast + source = Source("x = 4") + mod = source.compile(flag=ast.PyCF_ONLY_AST) + assert isinstance(mod, ast.Module) + compile(mod, "<filename>", "exec") + + def test_compile_and_getsource(self): + co = self.source.compile() + py.builtin.exec_(co, globals()) + f(7) + excinfo = pytest.raises(AssertionError, "f(6)") + frame = excinfo.traceback[-1].frame + stmt = frame.code.fullsource.getstatement(frame.lineno) + #print "block", str(block) + assert str(stmt).strip().startswith('assert') + + def test_compilefuncs_and_path_sanity(self): + def check(comp, name): + co = comp(self.source, name) + if not name: + expected = "codegen %s:%d>" %(mypath, mylineno+2+1) + else: + expected = "codegen %r %s:%d>" % (name, mypath, mylineno+2+1) + fn = co.co_filename + assert fn.endswith(expected) + + mycode = _pytest._code.Code(self.test_compilefuncs_and_path_sanity) + mylineno = mycode.firstlineno + mypath = mycode.path + + for comp in _pytest._code.compile, _pytest._code.Source.compile: + for name in '', None, 'my': + yield check, comp, name + + def test_offsetless_synerr(self): + pytest.raises(SyntaxError, _pytest._code.compile, "lambda a,a: 0", mode='eval') + +def test_getstartingblock_singleline(): + class A: + def __init__(self, *args): + frame = sys._getframe(1) + self.source = _pytest._code.Frame(frame).statement + + x = A('x', 'y') + + l = [i for i in x.source.lines if i.strip()] + assert len(l) == 1 + +def test_getstartingblock_multiline(): + class A: + def __init__(self, *args): + frame = sys._getframe(1) + self.source = _pytest._code.Frame(frame).statement + + x = A('x', + 'y' \ + , + 'z') + + l = [i for i in x.source.lines if i.strip()] + assert len(l) == 4 + +def test_getline_finally(): + def c(): pass + excinfo = pytest.raises(TypeError, """ + teardown = None + try: + c(1) + finally: + if teardown: + teardown() + """) + source = excinfo.traceback[-1].statement + assert str(source).strip() == 'c(1)' + +def test_getfuncsource_dynamic(): + source = """ + def f(): + raise ValueError + + def g(): pass + """ + co = _pytest._code.compile(source) + py.builtin.exec_(co, globals()) + assert str(_pytest._code.Source(f)).strip() == 'def f():\n raise ValueError' + assert str(_pytest._code.Source(g)).strip() == 'def g(): pass' + + +def test_getfuncsource_with_multine_string(): + def f(): + c = '''while True: + pass +''' + assert str(_pytest._code.Source(f)).strip() == "def f():\n c = '''while True:\n pass\n'''" + + +def test_deindent(): + from _pytest._code.source import deindent as deindent + assert deindent(['\tfoo', '\tbar', ]) == ['foo', 'bar'] + + def f(): + c = '''while True: + pass +''' + import inspect + lines = deindent(inspect.getsource(f).splitlines()) + assert lines == ["def f():", " c = '''while True:", " pass", "'''"] + + source = """ + def f(): + def g(): + pass + """ + lines = deindent(source.splitlines()) + assert lines == ['', 'def f():', ' def g():', ' pass', ' '] + +@pytest.mark.xfail("sys.version_info[:3] < (2,7,0) or " + "((3,0) <= sys.version_info[:2] < (3,2))") +def test_source_of_class_at_eof_without_newline(tmpdir): + # this test fails because the implicit inspect.getsource(A) below + # does not return the "x = 1" last line. + source = _pytest._code.Source(''' + class A(object): + def method(self): + x = 1 + ''') + path = tmpdir.join("a.py") + path.write(source) + s2 = _pytest._code.Source(tmpdir.join("a.py").pyimport().A) + assert str(source).strip() == str(s2).strip() + +if True: + def x(): + pass + +def test_getsource_fallback(): + from _pytest._code.source import getsource + expected = """def x(): + pass""" + src = getsource(x) + assert src == expected + +def test_idem_compile_and_getsource(): + from _pytest._code.source import getsource + expected = "def x(): pass" + co = _pytest._code.compile(expected) + src = getsource(co) + assert src == expected + +def test_findsource_fallback(): + from _pytest._code.source import findsource + src, lineno = findsource(x) + assert 'test_findsource_simple' in str(src) + assert src[lineno] == ' def x():' + +def test_findsource(): + from _pytest._code.source import findsource + co = _pytest._code.compile("""if 1: + def x(): + pass +""") + + src, lineno = findsource(co) + assert 'if 1:' in str(src) + + d = {} + eval(co, d) + src, lineno = findsource(d['x']) + assert 'if 1:' in str(src) + assert src[lineno] == " def x():" + + +def test_getfslineno(): + from _pytest._code import getfslineno + + def f(x): + pass + + fspath, lineno = getfslineno(f) + + assert fspath.basename == "test_source.py" + assert lineno == _pytest._code.getrawcode(f).co_firstlineno - 1 # see findsource + + class A(object): + pass + + fspath, lineno = getfslineno(A) + + _, A_lineno = py.std.inspect.findsource(A) + assert fspath.basename == "test_source.py" + assert lineno == A_lineno + + assert getfslineno(3) == ("", -1) + class B: + pass + B.__name__ = "B2" + assert getfslineno(B)[1] == -1 + +def test_code_of_object_instance_with_call(): + class A: + pass + pytest.raises(TypeError, lambda: _pytest._code.Source(A())) + class WithCall: + def __call__(self): + pass + + code = _pytest._code.Code(WithCall()) + assert 'pass' in str(code.source()) + + class Hello(object): + def __call__(self): + pass + pytest.raises(TypeError, lambda: _pytest._code.Code(Hello)) + + +def getstatement(lineno, source): + from _pytest._code.source import getstatementrange_ast + source = _pytest._code.Source(source, deindent=False) + ast, start, end = getstatementrange_ast(lineno, source) + return source[start:end] + +def test_oneline(): + source = getstatement(0, "raise ValueError") + assert str(source) == "raise ValueError" + +def test_comment_and_no_newline_at_end(): + from _pytest._code.source import getstatementrange_ast + source = Source(['def test_basic_complex():', + ' assert 1 == 2', + '# vim: filetype=pyopencl:fdm=marker']) + ast, start, end = getstatementrange_ast(1, source) + assert end == 2 + +def test_oneline_and_comment(): + source = getstatement(0, "raise ValueError\n#hello") + assert str(source) == "raise ValueError" + +@pytest.mark.xfail(hasattr(sys, "pypy_version_info"), + reason='does not work on pypy') +def test_comments(): + source = '''def test(): + "comment 1" + x = 1 + # comment 2 + # comment 3 + + assert False + +""" +comment 4 +""" +''' + for line in range(2,6): + assert str(getstatement(line, source)) == ' x = 1' + for line in range(6,10): + assert str(getstatement(line, source)) == ' assert False' + assert str(getstatement(10, source)) == '"""' + +def test_comment_in_statement(): + source = '''test(foo=1, + # comment 1 + bar=2) +''' + for line in range(1,3): + assert str(getstatement(line, source)) == \ + 'test(foo=1,\n # comment 1\n bar=2)' + +def test_single_line_else(): + source = getstatement(1, "if False: 2\nelse: 3") + assert str(source) == "else: 3" + +def test_single_line_finally(): + source = getstatement(1, "try: 1\nfinally: 3") + assert str(source) == "finally: 3" + +def test_issue55(): + source = ('def round_trip(dinp):\n assert 1 == dinp\n' + 'def test_rt():\n round_trip("""\n""")\n') + s = getstatement(3, source) + assert str(s) == ' round_trip("""\n""")' + + +def XXXtest_multiline(): + source = getstatement(0, """\ +raise ValueError( + 23 +) +x = 3 +""") + assert str(source) == "raise ValueError(\n 23\n)" + +class TestTry: + pytestmark = astonly + source = """\ +try: + raise ValueError +except Something: + raise IndexError(1) +else: + raise KeyError() +""" + + def test_body(self): + source = getstatement(1, self.source) + assert str(source) == " raise ValueError" + + def test_except_line(self): + source = getstatement(2, self.source) + assert str(source) == "except Something:" + + def test_except_body(self): + source = getstatement(3, self.source) + assert str(source) == " raise IndexError(1)" + + def test_else(self): + source = getstatement(5, self.source) + assert str(source) == " raise KeyError()" + +class TestTryFinally: + source = """\ +try: + raise ValueError +finally: + raise IndexError(1) +""" + + def test_body(self): + source = getstatement(1, self.source) + assert str(source) == " raise ValueError" + + def test_finally(self): + source = getstatement(3, self.source) + assert str(source) == " raise IndexError(1)" + + + +class TestIf: + pytestmark = astonly + source = """\ +if 1: + y = 3 +elif False: + y = 5 +else: + y = 7 +""" + + def test_body(self): + source = getstatement(1, self.source) + assert str(source) == " y = 3" + + def test_elif_clause(self): + source = getstatement(2, self.source) + assert str(source) == "elif False:" + + def test_elif(self): + source = getstatement(3, self.source) + assert str(source) == " y = 5" + + def test_else(self): + source = getstatement(5, self.source) + assert str(source) == " y = 7" + +def test_semicolon(): + s = """\ +hello ; pytest.skip() +""" + source = getstatement(0, s) + assert str(source) == s.strip() + +def test_def_online(): + s = """\ +def func(): raise ValueError(42) + +def something(): + pass +""" + source = getstatement(0, s) + assert str(source) == "def func(): raise ValueError(42)" + +def XXX_test_expression_multiline(): + source = """\ +something +''' +'''""" + result = getstatement(1, source) + assert str(result) == "'''\n'''" + diff --git a/testing/web-platform/tests/tools/pytest/testing/cx_freeze/install_cx_freeze.py b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/install_cx_freeze.py new file mode 100644 index 000000000..83dce87aa --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/install_cx_freeze.py @@ -0,0 +1,64 @@ +"""
+Installs cx_freeze from source, but first patching
+setup.py as described here:
+
+http://stackoverflow.com/questions/25107697/compiling-cx-freeze-under-ubuntu
+"""
+import glob
+import tarfile
+import os
+import sys
+import platform
+import py
+
+if __name__ == '__main__':
+ if 'ubuntu' not in platform.version().lower():
+
+ print('Not Ubuntu, installing using pip. (platform.version() is %r)' %
+ platform.version())
+ res = os.system('pip install cx_freeze')
+ if res != 0:
+ sys.exit(res)
+ sys.exit(0)
+
+ rootdir = py.path.local.make_numbered_dir(prefix='cx_freeze')
+
+ res = os.system('pip install --download %s --no-use-wheel '
+ 'cx_freeze' % rootdir)
+ if res != 0:
+ sys.exit(res)
+
+ packages = glob.glob('%s/*.tar.gz' % rootdir)
+ assert len(packages) == 1
+ tar_filename = packages[0]
+
+ tar_file = tarfile.open(tar_filename)
+ try:
+ tar_file.extractall(path=str(rootdir))
+ finally:
+ tar_file.close()
+
+ basename = os.path.basename(tar_filename).replace('.tar.gz', '')
+ setup_py_filename = '%s/%s/setup.py' % (rootdir, basename)
+ with open(setup_py_filename) as f:
+ lines = f.readlines()
+
+ line_to_patch = 'if not vars.get("Py_ENABLE_SHARED", 0):'
+ for index, line in enumerate(lines):
+ if line_to_patch in line:
+ indent = line[:line.index(line_to_patch)]
+ lines[index] = indent + 'if True:\n'
+ print('Patched line %d' % (index + 1))
+ break
+ else:
+ sys.exit('Could not find line in setup.py to patch!')
+
+ with open(setup_py_filename, 'w') as f:
+ f.writelines(lines)
+
+ os.chdir('%s/%s' % (rootdir, basename))
+ res = os.system('python setup.py install')
+ if res != 0:
+ sys.exit(res)
+
+ sys.exit(0)
diff --git a/testing/web-platform/tests/tools/pytest/testing/cx_freeze/runtests_script.py b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/runtests_script.py new file mode 100644 index 000000000..f2b032d76 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/runtests_script.py @@ -0,0 +1,9 @@ +"""
+This is the script that is actually frozen into an executable: simply executes
+py.test main().
+"""
+
+if __name__ == '__main__':
+ import sys
+ import pytest
+ sys.exit(pytest.main())
\ No newline at end of file diff --git a/testing/web-platform/tests/tools/pytest/testing/cx_freeze/runtests_setup.py b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/runtests_setup.py new file mode 100644 index 000000000..a2874a655 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/runtests_setup.py @@ -0,0 +1,15 @@ +"""
+Sample setup.py script that generates an executable with pytest runner embedded.
+"""
+if __name__ == '__main__':
+ from cx_Freeze import setup, Executable
+ import pytest
+
+ setup(
+ name="runtests",
+ version="0.1",
+ description="exemple of how embedding py.test into an executable using cx_freeze",
+ executables=[Executable("runtests_script.py")],
+ options={"build_exe": {'includes': pytest.freeze_includes()}},
+ )
+
diff --git a/testing/web-platform/tests/tools/pytest/testing/cx_freeze/tests/test_doctest.txt b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/tests/test_doctest.txt new file mode 100644 index 000000000..e18a4b68c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/tests/test_doctest.txt @@ -0,0 +1,6 @@ + + +Testing doctest:: + + >>> 1 + 1 + 2 diff --git a/testing/web-platform/tests/tools/pytest/testing/cx_freeze/tests/test_trivial.py b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/tests/test_trivial.py new file mode 100644 index 000000000..d8a572baa --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/tests/test_trivial.py @@ -0,0 +1,6 @@ +
+def test_upper():
+ assert 'foo'.upper() == 'FOO'
+
+def test_lower():
+ assert 'FOO'.lower() == 'foo'
\ No newline at end of file diff --git a/testing/web-platform/tests/tools/pytest/testing/cx_freeze/tox_run.py b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/tox_run.py new file mode 100644 index 000000000..e8df2684b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/cx_freeze/tox_run.py @@ -0,0 +1,15 @@ +"""
+Called by tox.ini: uses the generated executable to run the tests in ./tests/
+directory.
+
+.. note:: somehow calling "build/runtests_script" directly from tox doesn't
+ seem to work (at least on Windows).
+"""
+if __name__ == '__main__':
+ import os
+ import sys
+
+ executable = os.path.join(os.getcwd(), 'build', 'runtests_script')
+ if sys.platform.startswith('win'):
+ executable += '.exe'
+ sys.exit(os.system('%s tests' % executable))
\ No newline at end of file diff --git a/testing/web-platform/tests/tools/pytest/testing/python/collect.py b/testing/web-platform/tests/tools/pytest/testing/python/collect.py new file mode 100644 index 000000000..22433da77 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/python/collect.py @@ -0,0 +1,1200 @@ +# -*- coding: utf-8 -*- +import sys +from textwrap import dedent + +import _pytest._code +import py +import pytest +from _pytest.main import EXIT_NOTESTSCOLLECTED + + +class TestModule: + def test_failing_import(self, testdir): + modcol = testdir.getmodulecol("import alksdjalskdjalkjals") + pytest.raises(ImportError, modcol.collect) + pytest.raises(ImportError, modcol.collect) + + def test_import_duplicate(self, testdir): + a = testdir.mkdir("a") + b = testdir.mkdir("b") + p = a.ensure("test_whatever.py") + p.pyimport() + del py.std.sys.modules['test_whatever'] + b.ensure("test_whatever.py") + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*import*mismatch*", + "*imported*test_whatever*", + "*%s*" % a.join("test_whatever.py"), + "*not the same*", + "*%s*" % b.join("test_whatever.py"), + "*HINT*", + ]) + + def test_import_prepend_append(self, testdir, monkeypatch): + syspath = list(sys.path) + monkeypatch.setattr(sys, "path", syspath) + root1 = testdir.mkdir("root1") + root2 = testdir.mkdir("root2") + root1.ensure("x456.py") + root2.ensure("x456.py") + p = root2.join("test_x456.py") + monkeypatch.syspath_prepend(str(root1)) + p.write(dedent("""\ + import x456 + def test(): + assert x456.__file__.startswith(%r) + """ % str(root2))) + with root2.as_cwd(): + reprec = testdir.inline_run("--import-mode=append") + reprec.assertoutcome(passed=0, failed=1) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_syntax_error_in_module(self, testdir): + modcol = testdir.getmodulecol("this is a syntax error") + pytest.raises(modcol.CollectError, modcol.collect) + pytest.raises(modcol.CollectError, modcol.collect) + + def test_module_considers_pluginmanager_at_import(self, testdir): + modcol = testdir.getmodulecol("pytest_plugins='xasdlkj',") + pytest.raises(ImportError, lambda: modcol.obj) + +class TestClass: + def test_class_with_init_warning(self, testdir): + testdir.makepyfile(""" + class TestClass1: + def __init__(self): + pass + """) + result = testdir.runpytest("-rw") + result.stdout.fnmatch_lines_random(""" + WC1*test_class_with_init_warning.py*__init__* + """) + + def test_class_subclassobject(self, testdir): + testdir.getmodulecol(""" + class test(object): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*collected 0*", + ]) + + def test_setup_teardown_class_as_classmethod(self, testdir): + testdir.makepyfile(test_mod1=""" + class TestClassMethod: + @classmethod + def setup_class(cls): + pass + def test_1(self): + pass + @classmethod + def teardown_class(cls): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*1 passed*", + ]) + + def test_issue1035_obj_has_getattr(self, testdir): + modcol = testdir.getmodulecol(""" + class Chameleon(object): + def __getattr__(self, name): + return True + chameleon = Chameleon() + """) + colitems = modcol.collect() + assert len(colitems) == 0 + + +class TestGenerator: + def test_generative_functions(self, testdir): + modcol = testdir.getmodulecol(""" + def func1(arg, arg2): + assert arg == arg2 + + def test_gen(): + yield func1, 17, 3*5 + yield func1, 42, 6*7 + """) + colitems = modcol.collect() + assert len(colitems) == 1 + gencol = colitems[0] + assert isinstance(gencol, pytest.Generator) + gencolitems = gencol.collect() + assert len(gencolitems) == 2 + assert isinstance(gencolitems[0], pytest.Function) + assert isinstance(gencolitems[1], pytest.Function) + assert gencolitems[0].name == '[0]' + assert gencolitems[0].obj.__name__ == 'func1' + + def test_generative_methods(self, testdir): + modcol = testdir.getmodulecol(""" + def func1(arg, arg2): + assert arg == arg2 + class TestGenMethods: + def test_gen(self): + yield func1, 17, 3*5 + yield func1, 42, 6*7 + """) + gencol = modcol.collect()[0].collect()[0].collect()[0] + assert isinstance(gencol, pytest.Generator) + gencolitems = gencol.collect() + assert len(gencolitems) == 2 + assert isinstance(gencolitems[0], pytest.Function) + assert isinstance(gencolitems[1], pytest.Function) + assert gencolitems[0].name == '[0]' + assert gencolitems[0].obj.__name__ == 'func1' + + def test_generative_functions_with_explicit_names(self, testdir): + modcol = testdir.getmodulecol(""" + def func1(arg, arg2): + assert arg == arg2 + + def test_gen(): + yield "seventeen", func1, 17, 3*5 + yield "fortytwo", func1, 42, 6*7 + """) + colitems = modcol.collect() + assert len(colitems) == 1 + gencol = colitems[0] + assert isinstance(gencol, pytest.Generator) + gencolitems = gencol.collect() + assert len(gencolitems) == 2 + assert isinstance(gencolitems[0], pytest.Function) + assert isinstance(gencolitems[1], pytest.Function) + assert gencolitems[0].name == "['seventeen']" + assert gencolitems[0].obj.__name__ == 'func1' + assert gencolitems[1].name == "['fortytwo']" + assert gencolitems[1].obj.__name__ == 'func1' + + def test_generative_functions_unique_explicit_names(self, testdir): + # generative + modcol = testdir.getmodulecol(""" + def func(): pass + def test_gen(): + yield "name", func + yield "name", func + """) + colitems = modcol.collect() + assert len(colitems) == 1 + gencol = colitems[0] + assert isinstance(gencol, pytest.Generator) + pytest.raises(ValueError, "gencol.collect()") + + def test_generative_methods_with_explicit_names(self, testdir): + modcol = testdir.getmodulecol(""" + def func1(arg, arg2): + assert arg == arg2 + class TestGenMethods: + def test_gen(self): + yield "m1", func1, 17, 3*5 + yield "m2", func1, 42, 6*7 + """) + gencol = modcol.collect()[0].collect()[0].collect()[0] + assert isinstance(gencol, pytest.Generator) + gencolitems = gencol.collect() + assert len(gencolitems) == 2 + assert isinstance(gencolitems[0], pytest.Function) + assert isinstance(gencolitems[1], pytest.Function) + assert gencolitems[0].name == "['m1']" + assert gencolitems[0].obj.__name__ == 'func1' + assert gencolitems[1].name == "['m2']" + assert gencolitems[1].obj.__name__ == 'func1' + + def test_order_of_execution_generator_same_codeline(self, testdir, tmpdir): + o = testdir.makepyfile(""" + def test_generative_order_of_execution(): + import py, pytest + test_list = [] + expected_list = list(range(6)) + + def list_append(item): + test_list.append(item) + + def assert_order_of_execution(): + py.builtin.print_('expected order', expected_list) + py.builtin.print_('but got ', test_list) + assert test_list == expected_list + + for i in expected_list: + yield list_append, i + yield assert_order_of_execution + """) + reprec = testdir.inline_run(o) + passed, skipped, failed = reprec.countoutcomes() + assert passed == 7 + assert not skipped and not failed + + def test_order_of_execution_generator_different_codeline(self, testdir): + o = testdir.makepyfile(""" + def test_generative_tests_different_codeline(): + import py, pytest + test_list = [] + expected_list = list(range(3)) + + def list_append_2(): + test_list.append(2) + + def list_append_1(): + test_list.append(1) + + def list_append_0(): + test_list.append(0) + + def assert_order_of_execution(): + py.builtin.print_('expected order', expected_list) + py.builtin.print_('but got ', test_list) + assert test_list == expected_list + + yield list_append_0 + yield list_append_1 + yield list_append_2 + yield assert_order_of_execution + """) + reprec = testdir.inline_run(o) + passed, skipped, failed = reprec.countoutcomes() + assert passed == 4 + assert not skipped and not failed + + def test_setupstate_is_preserved_134(self, testdir): + # yield-based tests are messy wrt to setupstate because + # during collection they already invoke setup functions + # and then again when they are run. For now, we want to make sure + # that the old 1.3.4 behaviour is preserved such that all + # yielded functions all share the same "self" instance that + # has been used during collection. + o = testdir.makepyfile(""" + setuplist = [] + class TestClass: + def setup_method(self, func): + #print "setup_method", self, func + setuplist.append(self) + self.init = 42 + + def teardown_method(self, func): + self.init = None + + def test_func1(self): + pass + + def test_func2(self): + yield self.func2 + yield self.func2 + + def func2(self): + assert self.init + + def test_setuplist(): + # once for test_func2 during collection + # once for test_func1 during test run + # once for test_func2 during test run + #print setuplist + assert len(setuplist) == 3, len(setuplist) + assert setuplist[0] == setuplist[2], setuplist + assert setuplist[1] != setuplist[2], setuplist + """) + reprec = testdir.inline_run(o, '-v') + passed, skipped, failed = reprec.countoutcomes() + assert passed == 4 + assert not skipped and not failed + + +class TestFunction: + def test_getmodulecollector(self, testdir): + item = testdir.getitem("def test_func(): pass") + modcol = item.getparent(pytest.Module) + assert isinstance(modcol, pytest.Module) + assert hasattr(modcol.obj, 'test_func') + + def test_function_as_object_instance_ignored(self, testdir): + testdir.makepyfile(""" + class A: + def __call__(self, tmpdir): + 0/0 + + test_a = A() + """) + reprec = testdir.inline_run() + reprec.assertoutcome() + + def test_function_equality(self, testdir, tmpdir): + from _pytest.python import FixtureManager + config = testdir.parseconfigure() + session = testdir.Session(config) + session._fixturemanager = FixtureManager(session) + def func1(): + pass + def func2(): + pass + f1 = pytest.Function(name="name", parent=session, config=config, + args=(1,), callobj=func1) + assert f1 == f1 + f2 = pytest.Function(name="name",config=config, + callobj=func2, parent=session) + assert f1 != f2 + + def test_issue197_parametrize_emptyset(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize('arg', []) + def test_function(arg): + pass + """) + reprec = testdir.inline_run() + reprec.assertoutcome(skipped=1) + + def test_single_tuple_unwraps_values(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize(('arg',), [(1,)]) + def test_function(arg): + assert arg == 1 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_issue213_parametrize_value_no_equal(self, testdir): + testdir.makepyfile(""" + import pytest + class A: + def __eq__(self, other): + raise ValueError("not possible") + @pytest.mark.parametrize('arg', [A()]) + def test_function(arg): + assert arg.__class__.__name__ == "A" + """) + reprec = testdir.inline_run("--fulltrace") + reprec.assertoutcome(passed=1) + + def test_parametrize_with_non_hashable_values(self, testdir): + """Test parametrization with non-hashable values.""" + testdir.makepyfile(""" + archival_mapping = { + '1.0': {'tag': '1.0'}, + '1.2.2a1': {'tag': 'release-1.2.2a1'}, + } + + import pytest + @pytest.mark.parametrize('key value'.split(), + archival_mapping.items()) + def test_archival_to_version(key, value): + assert key in archival_mapping + assert value == archival_mapping[key] + """) + rec = testdir.inline_run() + rec.assertoutcome(passed=2) + + + def test_parametrize_with_non_hashable_values_indirect(self, testdir): + """Test parametrization with non-hashable values with indirect parametrization.""" + testdir.makepyfile(""" + archival_mapping = { + '1.0': {'tag': '1.0'}, + '1.2.2a1': {'tag': 'release-1.2.2a1'}, + } + + import pytest + + @pytest.fixture + def key(request): + return request.param + + @pytest.fixture + def value(request): + return request.param + + @pytest.mark.parametrize('key value'.split(), + archival_mapping.items(), indirect=True) + def test_archival_to_version(key, value): + assert key in archival_mapping + assert value == archival_mapping[key] + """) + rec = testdir.inline_run() + rec.assertoutcome(passed=2) + + + def test_parametrize_overrides_fixture(self, testdir): + """Test parametrization when parameter overrides existing fixture with same name.""" + testdir.makepyfile(""" + import pytest + + @pytest.fixture + def value(): + return 'value' + + @pytest.mark.parametrize('value', + ['overridden']) + def test_overridden_via_param(value): + assert value == 'overridden' + + @pytest.mark.parametrize('somevalue', ['overridden']) + def test_not_overridden(value, somevalue): + assert value == 'value' + assert somevalue == 'overridden' + + @pytest.mark.parametrize('other,value', [('foo', 'overridden')]) + def test_overridden_via_multiparam(other, value): + assert other == 'foo' + assert value == 'overridden' + """) + rec = testdir.inline_run() + rec.assertoutcome(passed=3) + + + def test_parametrize_overrides_parametrized_fixture(self, testdir): + """Test parametrization when parameter overrides existing parametrized fixture with same name.""" + testdir.makepyfile(""" + import pytest + + @pytest.fixture(params=[1, 2]) + def value(request): + return request.param + + @pytest.mark.parametrize('value', + ['overridden']) + def test_overridden_via_param(value): + assert value == 'overridden' + """) + rec = testdir.inline_run() + rec.assertoutcome(passed=1) + + def test_parametrize_with_mark(selfself, testdir): + items = testdir.getitems(""" + import pytest + @pytest.mark.foo + @pytest.mark.parametrize('arg', [ + 1, + pytest.mark.bar(pytest.mark.baz(2)) + ]) + def test_function(arg): + pass + """) + keywords = [item.keywords for item in items] + assert 'foo' in keywords[0] and 'bar' not in keywords[0] and 'baz' not in keywords[0] + assert 'foo' in keywords[1] and 'bar' in keywords[1] and 'baz' in keywords[1] + + def test_function_equality_with_callspec(self, testdir, tmpdir): + items = testdir.getitems(""" + import pytest + @pytest.mark.parametrize('arg', [1,2]) + def test_function(arg): + pass + """) + assert items[0] != items[1] + assert not (items[0] == items[1]) + + def test_pyfunc_call(self, testdir): + item = testdir.getitem("def test_func(): raise ValueError") + config = item.config + class MyPlugin1: + def pytest_pyfunc_call(self, pyfuncitem): + raise ValueError + class MyPlugin2: + def pytest_pyfunc_call(self, pyfuncitem): + return True + config.pluginmanager.register(MyPlugin1()) + config.pluginmanager.register(MyPlugin2()) + config.hook.pytest_runtest_setup(item=item) + config.hook.pytest_pyfunc_call(pyfuncitem=item) + + def test_multiple_parametrize(self, testdir): + modcol = testdir.getmodulecol(""" + import pytest + @pytest.mark.parametrize('x', [0, 1]) + @pytest.mark.parametrize('y', [2, 3]) + def test1(x, y): + pass + """) + colitems = modcol.collect() + assert colitems[0].name == 'test1[2-0]' + assert colitems[1].name == 'test1[2-1]' + assert colitems[2].name == 'test1[3-0]' + assert colitems[3].name == 'test1[3-1]' + + def test_issue751_multiple_parametrize_with_ids(self, testdir): + modcol = testdir.getmodulecol(""" + import pytest + @pytest.mark.parametrize('x', [0], ids=['c']) + @pytest.mark.parametrize('y', [0, 1], ids=['a', 'b']) + class Test(object): + def test1(self, x, y): + pass + def test2(self, x, y): + pass + """) + colitems = modcol.collect()[0].collect()[0].collect() + assert colitems[0].name == 'test1[a-c]' + assert colitems[1].name == 'test1[b-c]' + assert colitems[2].name == 'test2[a-c]' + assert colitems[3].name == 'test2[b-c]' + + def test_parametrize_skipif(self, testdir): + testdir.makepyfile(""" + import pytest + + m = pytest.mark.skipif('True') + + @pytest.mark.parametrize('x', [0, 1, m(2)]) + def test_skip_if(x): + assert x < 2 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines('* 2 passed, 1 skipped in *') + + def test_parametrize_skip(self, testdir): + testdir.makepyfile(""" + import pytest + + m = pytest.mark.skip('') + + @pytest.mark.parametrize('x', [0, 1, m(2)]) + def test_skip(x): + assert x < 2 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines('* 2 passed, 1 skipped in *') + + def test_parametrize_skipif_no_skip(self, testdir): + testdir.makepyfile(""" + import pytest + + m = pytest.mark.skipif('False') + + @pytest.mark.parametrize('x', [0, 1, m(2)]) + def test_skipif_no_skip(x): + assert x < 2 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines('* 1 failed, 2 passed in *') + + def test_parametrize_xfail(self, testdir): + testdir.makepyfile(""" + import pytest + + m = pytest.mark.xfail('True') + + @pytest.mark.parametrize('x', [0, 1, m(2)]) + def test_xfail(x): + assert x < 2 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines('* 2 passed, 1 xfailed in *') + + def test_parametrize_passed(self, testdir): + testdir.makepyfile(""" + import pytest + + m = pytest.mark.xfail('True') + + @pytest.mark.parametrize('x', [0, 1, m(2)]) + def test_xfail(x): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines('* 2 passed, 1 xpassed in *') + + def test_parametrize_xfail_passed(self, testdir): + testdir.makepyfile(""" + import pytest + + m = pytest.mark.xfail('False') + + @pytest.mark.parametrize('x', [0, 1, m(2)]) + def test_passed(x): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines('* 3 passed in *') + + +class TestSorting: + def test_check_equality(self, testdir): + modcol = testdir.getmodulecol(""" + def test_pass(): pass + def test_fail(): assert 0 + """) + fn1 = testdir.collect_by_name(modcol, "test_pass") + assert isinstance(fn1, pytest.Function) + fn2 = testdir.collect_by_name(modcol, "test_pass") + assert isinstance(fn2, pytest.Function) + + assert fn1 == fn2 + assert fn1 != modcol + if py.std.sys.version_info < (3, 0): + assert cmp(fn1, fn2) == 0 + assert hash(fn1) == hash(fn2) + + fn3 = testdir.collect_by_name(modcol, "test_fail") + assert isinstance(fn3, pytest.Function) + assert not (fn1 == fn3) + assert fn1 != fn3 + + for fn in fn1,fn2,fn3: + assert fn != 3 + assert fn != modcol + assert fn != [1,2,3] + assert [1,2,3] != fn + assert modcol != fn + + def test_allow_sane_sorting_for_decorators(self, testdir): + modcol = testdir.getmodulecol(""" + def dec(f): + g = lambda: f(2) + g.place_as = f + return g + + + def test_b(y): + pass + test_b = dec(test_b) + + def test_a(y): + pass + test_a = dec(test_a) + """) + colitems = modcol.collect() + assert len(colitems) == 2 + assert [item.name for item in colitems] == ['test_b', 'test_a'] + + +class TestConftestCustomization: + def test_pytest_pycollect_module(self, testdir): + testdir.makeconftest(""" + import pytest + class MyModule(pytest.Module): + pass + def pytest_pycollect_makemodule(path, parent): + if path.basename == "test_xyz.py": + return MyModule(path, parent) + """) + testdir.makepyfile("def test_some(): pass") + testdir.makepyfile(test_xyz="def test_func(): pass") + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*<Module*test_pytest*", + "*<MyModule*xyz*", + ]) + + def test_customized_pymakemodule_issue205_subdir(self, testdir): + b = testdir.mkdir("a").mkdir("b") + b.join("conftest.py").write(_pytest._code.Source(""" + def pytest_pycollect_makemodule(__multicall__): + mod = __multicall__.execute() + mod.obj.hello = "world" + return mod + """)) + b.join("test_module.py").write(_pytest._code.Source(""" + def test_hello(): + assert hello == "world" + """)) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_customized_pymakeitem(self, testdir): + b = testdir.mkdir("a").mkdir("b") + b.join("conftest.py").write(_pytest._code.Source(""" + import pytest + @pytest.hookimpl(hookwrapper=True) + def pytest_pycollect_makeitem(): + outcome = yield + if outcome.excinfo is None: + result = outcome.result + if result: + for func in result: + func._some123 = "world" + """)) + b.join("test_module.py").write(_pytest._code.Source(""" + import pytest + + @pytest.fixture() + def obj(request): + return request.node._some123 + def test_hello(obj): + assert obj == "world" + """)) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_pytest_pycollect_makeitem(self, testdir): + testdir.makeconftest(""" + import pytest + class MyFunction(pytest.Function): + pass + def pytest_pycollect_makeitem(collector, name, obj): + if name == "some": + return MyFunction(name, collector) + """) + testdir.makepyfile("def some(): pass") + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*MyFunction*some*", + ]) + + def test_makeitem_non_underscore(self, testdir, monkeypatch): + modcol = testdir.getmodulecol("def _hello(): pass") + l = [] + monkeypatch.setattr(pytest.Module, 'makeitem', + lambda self, name, obj: l.append(name)) + l = modcol.collect() + assert '_hello' not in l + +def test_setup_only_available_in_subdir(testdir): + sub1 = testdir.mkpydir("sub1") + sub2 = testdir.mkpydir("sub2") + sub1.join("conftest.py").write(_pytest._code.Source(""" + import pytest + def pytest_runtest_setup(item): + assert item.fspath.purebasename == "test_in_sub1" + def pytest_runtest_call(item): + assert item.fspath.purebasename == "test_in_sub1" + def pytest_runtest_teardown(item): + assert item.fspath.purebasename == "test_in_sub1" + """)) + sub2.join("conftest.py").write(_pytest._code.Source(""" + import pytest + def pytest_runtest_setup(item): + assert item.fspath.purebasename == "test_in_sub2" + def pytest_runtest_call(item): + assert item.fspath.purebasename == "test_in_sub2" + def pytest_runtest_teardown(item): + assert item.fspath.purebasename == "test_in_sub2" + """)) + sub1.join("test_in_sub1.py").write("def test_1(): pass") + sub2.join("test_in_sub2.py").write("def test_2(): pass") + result = testdir.runpytest("-v", "-s") + result.assert_outcomes(passed=2) + +def test_modulecol_roundtrip(testdir): + modcol = testdir.getmodulecol("pass", withinit=True) + trail = modcol.nodeid + newcol = modcol.session.perform_collect([trail], genitems=0)[0] + assert modcol.name == newcol.name + + +class TestTracebackCutting: + def test_skip_simple(self): + excinfo = pytest.raises(pytest.skip.Exception, 'pytest.skip("xxx")') + assert excinfo.traceback[-1].frame.code.name == "skip" + assert excinfo.traceback[-1].ishidden() + + def test_traceback_argsetup(self, testdir): + testdir.makeconftest(""" + def pytest_funcarg__hello(request): + raise ValueError("xyz") + """) + p = testdir.makepyfile("def test(hello): pass") + result = testdir.runpytest(p) + assert result.ret != 0 + out = result.stdout.str() + assert out.find("xyz") != -1 + assert out.find("conftest.py:2: ValueError") != -1 + numentries = out.count("_ _ _") # separator for traceback entries + assert numentries == 0 + + result = testdir.runpytest("--fulltrace", p) + out = result.stdout.str() + assert out.find("conftest.py:2: ValueError") != -1 + numentries = out.count("_ _ _ _") # separator for traceback entries + assert numentries > 3 + + def test_traceback_error_during_import(self, testdir): + testdir.makepyfile(""" + x = 1 + x = 2 + x = 17 + asd + """) + result = testdir.runpytest() + assert result.ret != 0 + out = result.stdout.str() + assert "x = 1" not in out + assert "x = 2" not in out + result.stdout.fnmatch_lines([ + " *asd*", + "E*NameError*", + ]) + result = testdir.runpytest("--fulltrace") + out = result.stdout.str() + assert "x = 1" in out + assert "x = 2" in out + result.stdout.fnmatch_lines([ + ">*asd*", + "E*NameError*", + ]) + + def test_traceback_filter_error_during_fixture_collection(self, testdir): + """integration test for issue #995. + """ + testdir.makepyfile(""" + import pytest + + def fail_me(func): + ns = {} + exec('def w(): raise ValueError("fail me")', ns) + return ns['w'] + + @pytest.fixture(scope='class') + @fail_me + def fail_fixture(): + pass + + def test_failing_fixture(fail_fixture): + pass + """) + result = testdir.runpytest() + assert result.ret != 0 + out = result.stdout.str() + assert "INTERNALERROR>" not in out + result.stdout.fnmatch_lines([ + "*ValueError: fail me*", + "* 1 error in *", + ]) + + def test_filter_traceback_generated_code(self): + """test that filter_traceback() works with the fact that + py.code.Code.path attribute might return an str object. + In this case, one of the entries on the traceback was produced by + dynamically generated code. + See: https://bitbucket.org/pytest-dev/py/issues/71 + This fixes #995. + """ + from _pytest.python import filter_traceback + try: + ns = {} + exec('def foo(): raise ValueError', ns) + ns['foo']() + except ValueError: + _, _, tb = sys.exc_info() + + tb = _pytest._code.Traceback(tb) + assert isinstance(tb[-1].path, str) + assert not filter_traceback(tb[-1]) + + def test_filter_traceback_path_no_longer_valid(self, testdir): + """test that filter_traceback() works with the fact that + py.code.Code.path attribute might return an str object. + In this case, one of the files in the traceback no longer exists. + This fixes #1133. + """ + from _pytest.python import filter_traceback + testdir.syspathinsert() + testdir.makepyfile(filter_traceback_entry_as_str=''' + def foo(): + raise ValueError + ''') + try: + import filter_traceback_entry_as_str + filter_traceback_entry_as_str.foo() + except ValueError: + _, _, tb = sys.exc_info() + + testdir.tmpdir.join('filter_traceback_entry_as_str.py').remove() + tb = _pytest._code.Traceback(tb) + assert isinstance(tb[-1].path, str) + assert filter_traceback(tb[-1]) + + +class TestReportInfo: + def test_itemreport_reportinfo(self, testdir, linecomp): + testdir.makeconftest(""" + import pytest + class MyFunction(pytest.Function): + def reportinfo(self): + return "ABCDE", 42, "custom" + def pytest_pycollect_makeitem(collector, name, obj): + if name == "test_func": + return MyFunction(name, parent=collector) + """) + item = testdir.getitem("def test_func(): pass") + item.config.pluginmanager.getplugin("runner") + assert item.location == ("ABCDE", 42, "custom") + + def test_func_reportinfo(self, testdir): + item = testdir.getitem("def test_func(): pass") + fspath, lineno, modpath = item.reportinfo() + assert fspath == item.fspath + assert lineno == 0 + assert modpath == "test_func" + + def test_class_reportinfo(self, testdir): + modcol = testdir.getmodulecol(""" + # lineno 0 + class TestClass: + def test_hello(self): pass + """) + classcol = testdir.collect_by_name(modcol, "TestClass") + fspath, lineno, msg = classcol.reportinfo() + assert fspath == modcol.fspath + assert lineno == 1 + assert msg == "TestClass" + + def test_generator_reportinfo(self, testdir): + modcol = testdir.getmodulecol(""" + # lineno 0 + def test_gen(): + def check(x): + assert x + yield check, 3 + """) + gencol = testdir.collect_by_name(modcol, "test_gen") + fspath, lineno, modpath = gencol.reportinfo() + assert fspath == modcol.fspath + assert lineno == 1 + assert modpath == "test_gen" + + genitem = gencol.collect()[0] + fspath, lineno, modpath = genitem.reportinfo() + assert fspath == modcol.fspath + assert lineno == 2 + assert modpath == "test_gen[0]" + """ + def test_func(): + pass + def test_genfunc(): + def check(x): + pass + yield check, 3 + class TestClass: + def test_method(self): + pass + """ + + def test_reportinfo_with_nasty_getattr(self, testdir): + # https://github.com/pytest-dev/pytest/issues/1204 + modcol = testdir.getmodulecol(""" + # lineno 0 + class TestClass: + def __getattr__(self, name): + return "this is not an int" + + def test_foo(self): + pass + """) + classcol = testdir.collect_by_name(modcol, "TestClass") + instance = classcol.collect()[0] + fspath, lineno, msg = instance.reportinfo() + + +def test_customized_python_discovery(testdir): + testdir.makeini(""" + [pytest] + python_files=check_*.py + python_classes=Check + python_functions=check + """) + p = testdir.makepyfile(""" + def check_simple(): + pass + class CheckMyApp: + def check_meth(self): + pass + """) + p2 = p.new(basename=p.basename.replace("test", "check")) + p.move(p2) + result = testdir.runpytest("--collect-only", "-s") + result.stdout.fnmatch_lines([ + "*check_customized*", + "*check_simple*", + "*CheckMyApp*", + "*check_meth*", + ]) + + result = testdir.runpytest() + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*2 passed*", + ]) + + +def test_customized_python_discovery_functions(testdir): + testdir.makeini(""" + [pytest] + python_functions=_test + """) + testdir.makepyfile(""" + def _test_underscore(): + pass + """) + result = testdir.runpytest("--collect-only", "-s") + result.stdout.fnmatch_lines([ + "*_test_underscore*", + ]) + + result = testdir.runpytest() + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*1 passed*", + ]) + + +def test_collector_attributes(testdir): + testdir.makeconftest(""" + import pytest + def pytest_pycollect_makeitem(collector): + assert collector.Function == pytest.Function + assert collector.Class == pytest.Class + assert collector.Instance == pytest.Instance + assert collector.Module == pytest.Module + """) + testdir.makepyfile(""" + def test_hello(): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*1 passed*", + ]) + +def test_customize_through_attributes(testdir): + testdir.makeconftest(""" + import pytest + class MyFunction(pytest.Function): + pass + class MyInstance(pytest.Instance): + Function = MyFunction + class MyClass(pytest.Class): + Instance = MyInstance + + def pytest_pycollect_makeitem(collector, name, obj): + if name.startswith("MyTestClass"): + return MyClass(name, parent=collector) + """) + testdir.makepyfile(""" + class MyTestClass: + def test_hello(self): + pass + """) + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*MyClass*", + "*MyInstance*", + "*MyFunction*test_hello*", + ]) + + +def test_unorderable_types(testdir): + testdir.makepyfile(""" + class TestJoinEmpty: + pass + + def make_test(): + class Test: + pass + Test.__name__ = "TestFoo" + return Test + TestFoo = make_test() + """) + result = testdir.runpytest() + assert "TypeError" not in result.stdout.str() + assert result.ret == EXIT_NOTESTSCOLLECTED + + +def test_collect_functools_partial(testdir): + """ + Test that collection of functools.partial object works, and arguments + to the wrapped functions are dealt correctly (see #811). + """ + testdir.makepyfile(""" + import functools + import pytest + + @pytest.fixture + def fix1(): + return 'fix1' + + @pytest.fixture + def fix2(): + return 'fix2' + + def check1(i, fix1): + assert i == 2 + assert fix1 == 'fix1' + + def check2(fix1, i): + assert i == 2 + assert fix1 == 'fix1' + + def check3(fix1, i, fix2): + assert i == 2 + assert fix1 == 'fix1' + assert fix2 == 'fix2' + + test_ok_1 = functools.partial(check1, i=2) + test_ok_2 = functools.partial(check1, i=2, fix1='fix1') + test_ok_3 = functools.partial(check1, 2) + test_ok_4 = functools.partial(check2, i=2) + test_ok_5 = functools.partial(check3, i=2) + test_ok_6 = functools.partial(check3, i=2, fix1='fix1') + + test_fail_1 = functools.partial(check2, 2) + test_fail_2 = functools.partial(check3, 2) + """) + result = testdir.inline_run() + result.assertoutcome(passed=6, failed=2) + + +def test_dont_collect_non_function_callable(testdir): + """Test for issue https://github.com/pytest-dev/pytest/issues/331 + + In this case an INTERNALERROR occurred trying to report the failure of + a test like this one because py test failed to get the source lines. + """ + testdir.makepyfile(""" + class Oh(object): + def __call__(self): + pass + + test_a = Oh() + + def test_real(): + pass + """) + result = testdir.runpytest('-rw') + result.stdout.fnmatch_lines([ + '*collected 1 item*', + 'WC2 *', + '*1 passed, 1 pytest-warnings in *', + ]) + + +def test_class_injection_does_not_break_collection(testdir): + """Tests whether injection during collection time will terminate testing. + + In this case the error should not occur if the TestClass itself + is modified during collection time, and the original method list + is still used for collection. + """ + testdir.makeconftest(""" + from test_inject import TestClass + def pytest_generate_tests(metafunc): + TestClass.changed_var = {} + """) + testdir.makepyfile(test_inject=''' + class TestClass(object): + def test_injection(self): + """Test being parametrized.""" + pass + ''') + result = testdir.runpytest() + assert "RuntimeError: dictionary changed size during iteration" not in result.stdout.str() + result.stdout.fnmatch_lines(['*1 passed*']) + + +def test_syntax_error_with_non_ascii_chars(testdir): + """Fix decoding issue while formatting SyntaxErrors during collection (#578) + """ + testdir.makepyfile(u""" + # -*- coding: UTF-8 -*- + + ☃ + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + '*ERROR collecting*', + '*SyntaxError*', + '*1 error in*', + ]) diff --git a/testing/web-platform/tests/tools/pytest/testing/python/fixture.py b/testing/web-platform/tests/tools/pytest/testing/python/fixture.py new file mode 100644 index 000000000..506d8426e --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/python/fixture.py @@ -0,0 +1,2693 @@ +from textwrap import dedent + +import _pytest._code +import pytest +import sys +from _pytest import python as funcargs +from _pytest.pytester import get_public_names +from _pytest.python import FixtureLookupError + + +def test_getfuncargnames(): + def f(): pass + assert not funcargs.getfuncargnames(f) + def g(arg): pass + assert funcargs.getfuncargnames(g) == ('arg',) + def h(arg1, arg2="hello"): pass + assert funcargs.getfuncargnames(h) == ('arg1',) + def h(arg1, arg2, arg3="hello"): pass + assert funcargs.getfuncargnames(h) == ('arg1', 'arg2') + class A: + def f(self, arg1, arg2="hello"): + pass + assert funcargs.getfuncargnames(A().f) == ('arg1',) + if sys.version_info < (3,0): + assert funcargs.getfuncargnames(A.f) == ('arg1',) + +class TestFillFixtures: + def test_fillfuncargs_exposed(self): + # used by oejskit, kept for compatibility + assert pytest._fillfuncargs == funcargs.fillfixtures + + def test_funcarg_lookupfails(self, testdir): + testdir.makepyfile(""" + def pytest_funcarg__xyzsomething(request): + return 42 + + def test_func(some): + pass + """) + result = testdir.runpytest() # "--collect-only") + assert result.ret != 0 + result.stdout.fnmatch_lines([ + "*def test_func(some)*", + "*fixture*some*not found*", + "*xyzsomething*", + ]) + + def test_funcarg_basic(self, testdir): + item = testdir.getitem(""" + def pytest_funcarg__some(request): + return request.function.__name__ + def pytest_funcarg__other(request): + return 42 + def test_func(some, other): + pass + """) + funcargs.fillfixtures(item) + del item.funcargs["request"] + assert len(get_public_names(item.funcargs)) == 2 + assert item.funcargs['some'] == "test_func" + assert item.funcargs['other'] == 42 + + def test_funcarg_lookup_modulelevel(self, testdir): + testdir.makepyfile(""" + def pytest_funcarg__something(request): + return request.function.__name__ + + class TestClass: + def test_method(self, something): + assert something == "test_method" + def test_func(something): + assert something == "test_func" + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + + def test_funcarg_lookup_classlevel(self, testdir): + p = testdir.makepyfile(""" + class TestClass: + def pytest_funcarg__something(self, request): + return request.instance + def test_method(self, something): + assert something is self + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*1 passed*" + ]) + + def test_conftest_funcargs_only_available_in_subdir(self, testdir): + sub1 = testdir.mkpydir("sub1") + sub2 = testdir.mkpydir("sub2") + sub1.join("conftest.py").write(_pytest._code.Source(""" + import pytest + def pytest_funcarg__arg1(request): + pytest.raises(Exception, "request.getfuncargvalue('arg2')") + """)) + sub2.join("conftest.py").write(_pytest._code.Source(""" + import pytest + def pytest_funcarg__arg2(request): + pytest.raises(Exception, "request.getfuncargvalue('arg1')") + """)) + + sub1.join("test_in_sub1.py").write("def test_1(arg1): pass") + sub2.join("test_in_sub2.py").write("def test_2(arg2): pass") + result = testdir.runpytest("-v") + result.assert_outcomes(passed=2) + + def test_extend_fixture_module_class(self, testdir): + testfile = testdir.makepyfile(""" + import pytest + + @pytest.fixture + def spam(): + return 'spam' + + class TestSpam: + + @pytest.fixture + def spam(self, spam): + return spam * 2 + + def test_spam(self, spam): + assert spam == 'spamspam' + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(["*1 passed*"]) + result = testdir.runpytest(testfile) + result.stdout.fnmatch_lines(["*1 passed*"]) + + def test_extend_fixture_conftest_module(self, testdir): + testdir.makeconftest(""" + import pytest + + @pytest.fixture + def spam(): + return 'spam' + """) + testfile = testdir.makepyfile(""" + import pytest + + @pytest.fixture + def spam(spam): + return spam * 2 + + def test_spam(spam): + assert spam == 'spamspam' + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(["*1 passed*"]) + result = testdir.runpytest(testfile) + result.stdout.fnmatch_lines(["*1 passed*"]) + + def test_extend_fixture_conftest_conftest(self, testdir): + testdir.makeconftest(""" + import pytest + + @pytest.fixture + def spam(): + return 'spam' + """) + pkg = testdir.mkpydir("pkg") + pkg.join("conftest.py").write(_pytest._code.Source(""" + import pytest + + @pytest.fixture + def spam(spam): + return spam * 2 + """)) + testfile = pkg.join("test_spam.py") + testfile.write(_pytest._code.Source(""" + def test_spam(spam): + assert spam == "spamspam" + """)) + result = testdir.runpytest() + result.stdout.fnmatch_lines(["*1 passed*"]) + result = testdir.runpytest(testfile) + result.stdout.fnmatch_lines(["*1 passed*"]) + + def test_extend_fixture_conftest_plugin(self, testdir): + testdir.makepyfile(testplugin=""" + import pytest + + @pytest.fixture + def foo(): + return 7 + """) + testdir.syspathinsert() + testdir.makeconftest(""" + import pytest + + pytest_plugins = 'testplugin' + + @pytest.fixture + def foo(foo): + return foo + 7 + """) + testdir.makepyfile(""" + def test_foo(foo): + assert foo == 14 + """) + result = testdir.runpytest('-s') + assert result.ret == 0 + + def test_extend_fixture_plugin_plugin(self, testdir): + # Two plugins should extend each order in loading order + testdir.makepyfile(testplugin0=""" + import pytest + + @pytest.fixture + def foo(): + return 7 + """) + testdir.makepyfile(testplugin1=""" + import pytest + + @pytest.fixture + def foo(foo): + return foo + 7 + """) + testdir.syspathinsert() + testdir.makepyfile(""" + pytest_plugins = ['testplugin0', 'testplugin1'] + + def test_foo(foo): + assert foo == 14 + """) + result = testdir.runpytest() + assert result.ret == 0 + + def test_override_parametrized_fixture_conftest_module(self, testdir): + """Test override of the parametrized fixture with non-parametrized one on the test module level.""" + testdir.makeconftest(""" + import pytest + + @pytest.fixture(params=[1, 2, 3]) + def spam(request): + return request.param + """) + testfile = testdir.makepyfile(""" + import pytest + + @pytest.fixture + def spam(): + return 'spam' + + def test_spam(spam): + assert spam == 'spam' + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(["*1 passed*"]) + result = testdir.runpytest(testfile) + result.stdout.fnmatch_lines(["*1 passed*"]) + + def test_override_parametrized_fixture_conftest_conftest(self, testdir): + """Test override of the parametrized fixture with non-parametrized one on the conftest level.""" + testdir.makeconftest(""" + import pytest + + @pytest.fixture(params=[1, 2, 3]) + def spam(request): + return request.param + """) + subdir = testdir.mkpydir('subdir') + subdir.join("conftest.py").write(_pytest._code.Source(""" + import pytest + + @pytest.fixture + def spam(): + return 'spam' + """)) + testfile = subdir.join("test_spam.py") + testfile.write(_pytest._code.Source(""" + def test_spam(spam): + assert spam == "spam" + """)) + result = testdir.runpytest() + result.stdout.fnmatch_lines(["*1 passed*"]) + result = testdir.runpytest(testfile) + result.stdout.fnmatch_lines(["*1 passed*"]) + + def test_override_non_parametrized_fixture_conftest_module(self, testdir): + """Test override of the non-parametrized fixture with parametrized one on the test module level.""" + testdir.makeconftest(""" + import pytest + + @pytest.fixture + def spam(): + return 'spam' + """) + testfile = testdir.makepyfile(""" + import pytest + + @pytest.fixture(params=[1, 2, 3]) + def spam(request): + return request.param + + params = {'spam': 1} + + def test_spam(spam): + assert spam == params['spam'] + params['spam'] += 1 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(["*3 passed*"]) + result = testdir.runpytest(testfile) + result.stdout.fnmatch_lines(["*3 passed*"]) + + def test_override_non_parametrized_fixture_conftest_conftest(self, testdir): + """Test override of the non-parametrized fixture with parametrized one on the conftest level.""" + testdir.makeconftest(""" + import pytest + + @pytest.fixture + def spam(): + return 'spam' + """) + subdir = testdir.mkpydir('subdir') + subdir.join("conftest.py").write(_pytest._code.Source(""" + import pytest + + @pytest.fixture(params=[1, 2, 3]) + def spam(request): + return request.param + """)) + testfile = subdir.join("test_spam.py") + testfile.write(_pytest._code.Source(""" + params = {'spam': 1} + + def test_spam(spam): + assert spam == params['spam'] + params['spam'] += 1 + """)) + result = testdir.runpytest() + result.stdout.fnmatch_lines(["*3 passed*"]) + result = testdir.runpytest(testfile) + result.stdout.fnmatch_lines(["*3 passed*"]) + + def test_autouse_fixture_plugin(self, testdir): + # A fixture from a plugin has no baseid set, which screwed up + # the autouse fixture handling. + testdir.makepyfile(testplugin=""" + import pytest + + @pytest.fixture(autouse=True) + def foo(request): + request.function.foo = 7 + """) + testdir.syspathinsert() + testdir.makepyfile(""" + pytest_plugins = 'testplugin' + + def test_foo(request): + assert request.function.foo == 7 + """) + result = testdir.runpytest() + assert result.ret == 0 + + def test_funcarg_lookup_error(self, testdir): + testdir.makepyfile(""" + def test_lookup_error(unknown): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*ERROR*test_lookup_error*", + "*def test_lookup_error(unknown):*", + "*fixture*unknown*not found*", + "*available fixtures*", + "*1 error*", + ]) + assert "INTERNAL" not in result.stdout.str() + + def test_fixture_excinfo_leak(self, testdir): + # on python2 sys.excinfo would leak into fixture executions + testdir.makepyfile(""" + import sys + import traceback + import pytest + + @pytest.fixture + def leak(): + if sys.exc_info()[0]: # python3 bug :) + traceback.print_exc() + #fails + assert sys.exc_info() == (None, None, None) + + def test_leak(leak): + if sys.exc_info()[0]: # python3 bug :) + traceback.print_exc() + assert sys.exc_info() == (None, None, None) + """) + result = testdir.runpytest() + assert result.ret == 0 + + +class TestRequestBasic: + def test_request_attributes(self, testdir): + item = testdir.getitem(""" + def pytest_funcarg__something(request): pass + def test_func(something): pass + """) + req = funcargs.FixtureRequest(item) + assert req.function == item.obj + assert req.keywords == item.keywords + assert hasattr(req.module, 'test_func') + assert req.cls is None + assert req.function.__name__ == "test_func" + assert req.config == item.config + assert repr(req).find(req.function.__name__) != -1 + + def test_request_attributes_method(self, testdir): + item, = testdir.getitems(""" + class TestB: + def pytest_funcarg__something(self, request): + return 1 + def test_func(self, something): + pass + """) + req = item._request + assert req.cls.__name__ == "TestB" + assert req.instance.__class__ == req.cls + + def XXXtest_request_contains_funcarg_arg2fixturedefs(self, testdir): + modcol = testdir.getmodulecol(""" + def pytest_funcarg__something(request): + pass + class TestClass: + def test_method(self, something): + pass + """) + item1, = testdir.genitems([modcol]) + assert item1.name == "test_method" + arg2fixturedefs = funcargs.FixtureRequest(item1)._arg2fixturedefs + assert len(arg2fixturedefs) == 1 + assert arg2fixturedefs[0].__name__ == "pytest_funcarg__something" + + def test_getfuncargvalue_recursive(self, testdir): + testdir.makeconftest(""" + def pytest_funcarg__something(request): + return 1 + """) + testdir.makepyfile(""" + def pytest_funcarg__something(request): + return request.getfuncargvalue("something") + 1 + def test_func(something): + assert something == 2 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_getfuncargvalue(self, testdir): + item = testdir.getitem(""" + l = [2] + def pytest_funcarg__something(request): return 1 + def pytest_funcarg__other(request): + return l.pop() + def test_func(something): pass + """) + req = item._request + pytest.raises(FixtureLookupError, req.getfuncargvalue, "notexists") + val = req.getfuncargvalue("something") + assert val == 1 + val = req.getfuncargvalue("something") + assert val == 1 + val2 = req.getfuncargvalue("other") + assert val2 == 2 + val2 = req.getfuncargvalue("other") # see about caching + assert val2 == 2 + pytest._fillfuncargs(item) + assert item.funcargs["something"] == 1 + assert len(get_public_names(item.funcargs)) == 2 + assert "request" in item.funcargs + #assert item.funcargs == {'something': 1, "other": 2} + + def test_request_addfinalizer(self, testdir): + item = testdir.getitem(""" + teardownlist = [] + def pytest_funcarg__something(request): + request.addfinalizer(lambda: teardownlist.append(1)) + def test_func(something): pass + """) + item.session._setupstate.prepare(item) + pytest._fillfuncargs(item) + # successively check finalization calls + teardownlist = item.getparent(pytest.Module).obj.teardownlist + ss = item.session._setupstate + assert not teardownlist + ss.teardown_exact(item, None) + print(ss.stack) + assert teardownlist == [1] + + def test_request_addfinalizer_failing_setup(self, testdir): + testdir.makepyfile(""" + import pytest + l = [1] + @pytest.fixture + def myfix(request): + request.addfinalizer(l.pop) + assert 0 + def test_fix(myfix): + pass + def test_finalizer_ran(): + assert not l + """) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(failed=1, passed=1) + + def test_request_addfinalizer_failing_setup_module(self, testdir): + testdir.makepyfile(""" + import pytest + l = [1, 2] + @pytest.fixture(scope="module") + def myfix(request): + request.addfinalizer(l.pop) + request.addfinalizer(l.pop) + assert 0 + def test_fix(myfix): + pass + """) + reprec = testdir.inline_run("-s") + mod = reprec.getcalls("pytest_runtest_setup")[0].item.module + assert not mod.l + + + def test_request_addfinalizer_partial_setup_failure(self, testdir): + p = testdir.makepyfile(""" + l = [] + def pytest_funcarg__something(request): + request.addfinalizer(lambda: l.append(None)) + def test_func(something, missingarg): + pass + def test_second(): + assert len(l) == 1 + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*1 error*" # XXX the whole module collection fails + ]) + + def test_request_getmodulepath(self, testdir): + modcol = testdir.getmodulecol("def test_somefunc(): pass") + item, = testdir.genitems([modcol]) + req = funcargs.FixtureRequest(item) + assert req.fspath == modcol.fspath + + def test_request_fixturenames(self, testdir): + testdir.makepyfile(""" + import pytest + from _pytest.pytester import get_public_names + @pytest.fixture() + def arg1(): + pass + @pytest.fixture() + def farg(arg1): + pass + @pytest.fixture(autouse=True) + def sarg(tmpdir): + pass + def test_function(request, farg): + assert set(get_public_names(request.fixturenames)) == \ + set(["tmpdir", "sarg", "arg1", "request", "farg", + "tmpdir_factory"]) + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_funcargnames_compatattr(self, testdir): + testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + assert metafunc.funcargnames == metafunc.fixturenames + def pytest_funcarg__fn(request): + assert request._pyfuncitem.funcargnames == \ + request._pyfuncitem.fixturenames + return request.funcargnames, request.fixturenames + + def test_hello(fn): + assert fn[0] == fn[1] + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_setupdecorator_and_xunit(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(scope='module', autouse=True) + def setup_module(): + l.append("module") + @pytest.fixture(autouse=True) + def setup_function(): + l.append("function") + + def test_func(): + pass + + class TestClass: + @pytest.fixture(scope="class", autouse=True) + def setup_class(self): + l.append("class") + @pytest.fixture(autouse=True) + def setup_method(self): + l.append("method") + def test_method(self): + pass + def test_all(): + assert l == ["module", "function", "class", + "function", "method", "function"] + """) + reprec = testdir.inline_run("-v") + reprec.assertoutcome(passed=3) + + def test_fixtures_sub_subdir_normalize_sep(self, testdir): + # this tests that normalization of nodeids takes place + b = testdir.mkdir("tests").mkdir("unit") + b.join("conftest.py").write(_pytest._code.Source(""" + def pytest_funcarg__arg1(): + pass + """)) + p = b.join("test_module.py") + p.write("def test_func(arg1): pass") + result = testdir.runpytest(p, "--fixtures") + assert result.ret == 0 + result.stdout.fnmatch_lines(""" + *fixtures defined*conftest* + *arg1* + """) + + def test_show_fixtures_color_yes(self, testdir): + testdir.makepyfile("def test_this(): assert 1") + result = testdir.runpytest('--color=yes', '--fixtures') + assert '\x1b[32mtmpdir' in result.stdout.str() + + def test_newstyle_with_request(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture() + def arg(request): + pass + def test_1(arg): + pass + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_setupcontext_no_param(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(params=[1,2]) + def arg(request): + return request.param + + @pytest.fixture(autouse=True) + def mysetup(request, arg): + assert not hasattr(request, "param") + def test_1(arg): + assert arg in (1,2) + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + +class TestRequestMarking: + def test_applymarker(self, testdir): + item1,item2 = testdir.getitems(""" + def pytest_funcarg__something(request): + pass + class TestClass: + def test_func1(self, something): + pass + def test_func2(self, something): + pass + """) + req1 = funcargs.FixtureRequest(item1) + assert 'xfail' not in item1.keywords + req1.applymarker(pytest.mark.xfail) + assert 'xfail' in item1.keywords + assert 'skipif' not in item1.keywords + req1.applymarker(pytest.mark.skipif) + assert 'skipif' in item1.keywords + pytest.raises(ValueError, "req1.applymarker(42)") + + def test_accesskeywords(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture() + def keywords(request): + return request.keywords + @pytest.mark.XYZ + def test_function(keywords): + assert keywords["XYZ"] + assert "abc" not in keywords + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_accessmarker_dynamic(self, testdir): + testdir.makeconftest(""" + import pytest + @pytest.fixture() + def keywords(request): + return request.keywords + + @pytest.fixture(scope="class", autouse=True) + def marking(request): + request.applymarker(pytest.mark.XYZ("hello")) + """) + testdir.makepyfile(""" + import pytest + def test_fun1(keywords): + assert keywords["XYZ"] is not None + assert "abc" not in keywords + def test_fun2(keywords): + assert keywords["XYZ"] is not None + assert "abc" not in keywords + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + +class TestRequestCachedSetup: + def test_request_cachedsetup_defaultmodule(self, testdir): + reprec = testdir.inline_runsource(""" + mysetup = ["hello",].pop + + def pytest_funcarg__something(request): + return request.cached_setup(mysetup, scope="module") + + def test_func1(something): + assert something == "hello" + class TestClass: + def test_func1a(self, something): + assert something == "hello" + """) + reprec.assertoutcome(passed=2) + + def test_request_cachedsetup_class(self, testdir): + reprec = testdir.inline_runsource(""" + mysetup = ["hello", "hello2", "hello3"].pop + + def pytest_funcarg__something(request): + return request.cached_setup(mysetup, scope="class") + def test_func1(something): + assert something == "hello3" + def test_func2(something): + assert something == "hello2" + class TestClass: + def test_func1a(self, something): + assert something == "hello" + def test_func2b(self, something): + assert something == "hello" + """) + reprec.assertoutcome(passed=4) + + def test_request_cachedsetup_extrakey(self, testdir): + item1 = testdir.getitem("def test_func(): pass") + req1 = funcargs.FixtureRequest(item1) + l = ["hello", "world"] + def setup(): + return l.pop() + ret1 = req1.cached_setup(setup, extrakey=1) + ret2 = req1.cached_setup(setup, extrakey=2) + assert ret2 == "hello" + assert ret1 == "world" + ret1b = req1.cached_setup(setup, extrakey=1) + ret2b = req1.cached_setup(setup, extrakey=2) + assert ret1 == ret1b + assert ret2 == ret2b + + def test_request_cachedsetup_cache_deletion(self, testdir): + item1 = testdir.getitem("def test_func(): pass") + req1 = funcargs.FixtureRequest(item1) + l = [] + def setup(): + l.append("setup") + def teardown(val): + l.append("teardown") + req1.cached_setup(setup, teardown, scope="function") + assert l == ['setup'] + # artificial call of finalizer + setupstate = req1._pyfuncitem.session._setupstate + setupstate._callfinalizers(item1) + assert l == ["setup", "teardown"] + req1.cached_setup(setup, teardown, scope="function") + assert l == ["setup", "teardown", "setup"] + setupstate._callfinalizers(item1) + assert l == ["setup", "teardown", "setup", "teardown"] + + def test_request_cached_setup_two_args(self, testdir): + testdir.makepyfile(""" + def pytest_funcarg__arg1(request): + return request.cached_setup(lambda: 42) + def pytest_funcarg__arg2(request): + return request.cached_setup(lambda: 17) + def test_two_different_setups(arg1, arg2): + assert arg1 != arg2 + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines([ + "*1 passed*" + ]) + + def test_request_cached_setup_getfuncargvalue(self, testdir): + testdir.makepyfile(""" + def pytest_funcarg__arg1(request): + arg1 = request.getfuncargvalue("arg2") + return request.cached_setup(lambda: arg1 + 1) + def pytest_funcarg__arg2(request): + return request.cached_setup(lambda: 10) + def test_two_funcarg(arg1): + assert arg1 == 11 + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines([ + "*1 passed*" + ]) + + def test_request_cached_setup_functional(self, testdir): + testdir.makepyfile(test_0=""" + l = [] + def pytest_funcarg__something(request): + val = request.cached_setup(fsetup, fteardown) + return val + def fsetup(mycache=[1]): + l.append(mycache.pop()) + return l + def fteardown(something): + l.remove(something[0]) + l.append(2) + def test_list_once(something): + assert something == [1] + def test_list_twice(something): + assert something == [1] + """) + testdir.makepyfile(test_1=""" + import test_0 # should have run already + def test_check_test0_has_teardown_correct(): + assert test_0.l == [2] + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines([ + "*3 passed*" + ]) + + def test_issue117_sessionscopeteardown(self, testdir): + testdir.makepyfile(""" + def pytest_funcarg__app(request): + app = request.cached_setup( + scope='session', + setup=lambda: 0, + teardown=lambda x: 3/x) + return app + def test_func(app): + pass + """) + result = testdir.runpytest() + assert result.ret != 0 + result.stdout.fnmatch_lines([ + "*3/x*", + "*ZeroDivisionError*", + ]) + +class TestFixtureUsages: + def test_noargfixturedec(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture + def arg1(): + return 1 + + def test_func(arg1): + assert arg1 == 1 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_receives_funcargs(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture() + def arg1(): + return 1 + + @pytest.fixture() + def arg2(arg1): + return arg1 + 1 + + def test_add(arg2): + assert arg2 == 2 + def test_all(arg1, arg2): + assert arg1 == 1 + assert arg2 == 2 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + + def test_receives_funcargs_scope_mismatch(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope="function") + def arg1(): + return 1 + + @pytest.fixture(scope="module") + def arg2(arg1): + return arg1 + 1 + + def test_add(arg2): + assert arg2 == 2 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*ScopeMismatch*involved factories*", + "* def arg2*", + "* def arg1*", + "*1 error*" + ]) + + def test_receives_funcargs_scope_mismatch_issue660(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope="function") + def arg1(): + return 1 + + @pytest.fixture(scope="module") + def arg2(arg1): + return arg1 + 1 + + def test_add(arg1, arg2): + assert arg2 == 2 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*ScopeMismatch*involved factories*", + "* def arg2*", + "*1 error*" + ]) + + def test_funcarg_parametrized_and_used_twice(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(params=[1,2]) + def arg1(request): + l.append(1) + return request.param + + @pytest.fixture() + def arg2(arg1): + return arg1 + 1 + + def test_add(arg1, arg2): + assert arg2 == arg1 + 1 + assert len(l) == arg1 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*2 passed*" + ]) + + def test_factory_uses_unknown_funcarg_as_dependency_error(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture() + def fail(missing): + return + + @pytest.fixture() + def call_fail(fail): + return + + def test_missing(call_fail): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(""" + *pytest.fixture()* + *def call_fail(fail)* + *pytest.fixture()* + *def fail* + *fixture*'missing'*not found* + """) + + def test_factory_setup_as_classes_fails(self, testdir): + testdir.makepyfile(""" + import pytest + class arg1: + def __init__(self, request): + self.x = 1 + arg1 = pytest.fixture()(arg1) + + """) + reprec = testdir.inline_run() + l = reprec.getfailedcollections() + assert len(l) == 1 + + def test_request_can_be_overridden(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture() + def request(request): + request.a = 1 + return request + def test_request(request): + assert request.a == 1 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_usefixtures_marker(self, testdir): + testdir.makepyfile(""" + import pytest + + l = [] + + @pytest.fixture(scope="class") + def myfix(request): + request.cls.hello = "world" + l.append(1) + + class TestClass: + def test_one(self): + assert self.hello == "world" + assert len(l) == 1 + def test_two(self): + assert self.hello == "world" + assert len(l) == 1 + pytest.mark.usefixtures("myfix")(TestClass) + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + + def test_usefixtures_ini(self, testdir): + testdir.makeini(""" + [pytest] + usefixtures = myfix + """) + testdir.makeconftest(""" + import pytest + + @pytest.fixture(scope="class") + def myfix(request): + request.cls.hello = "world" + + """) + testdir.makepyfile(""" + class TestClass: + def test_one(self): + assert self.hello == "world" + def test_two(self): + assert self.hello == "world" + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + + def test_usefixtures_seen_in_showmarkers(self, testdir): + result = testdir.runpytest("--markers") + result.stdout.fnmatch_lines(""" + *usefixtures(fixturename1*mark tests*fixtures* + """) + + def test_request_instance_issue203(self, testdir): + testdir.makepyfile(""" + import pytest + + class TestClass: + @pytest.fixture + def setup1(self, request): + assert self == request.instance + self.arg1 = 1 + def test_hello(self, setup1): + assert self.arg1 == 1 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_fixture_parametrized_with_iterator(self, testdir): + testdir.makepyfile(""" + import pytest + + l = [] + def f(): + yield 1 + yield 2 + dec = pytest.fixture(scope="module", params=f()) + + @dec + def arg(request): + return request.param + @dec + def arg2(request): + return request.param + + def test_1(arg): + l.append(arg) + def test_2(arg2): + l.append(arg2*10) + """) + reprec = testdir.inline_run("-v") + reprec.assertoutcome(passed=4) + l = reprec.getcalls("pytest_runtest_call")[0].item.module.l + assert l == [1,2, 10,20] + + +class TestFixtureManagerParseFactories: + def pytest_funcarg__testdir(self, request): + testdir = request.getfuncargvalue("testdir") + testdir.makeconftest(""" + def pytest_funcarg__hello(request): + return "conftest" + + def pytest_funcarg__fm(request): + return request._fixturemanager + + def pytest_funcarg__item(request): + return request._pyfuncitem + """) + return testdir + + def test_parsefactories_evil_objects_issue214(self, testdir): + testdir.makepyfile(""" + class A: + def __call__(self): + pass + def __getattr__(self, name): + raise RuntimeError() + a = A() + def test_hello(): + pass + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1, failed=0) + + def test_parsefactories_conftest(self, testdir): + testdir.makepyfile(""" + def test_hello(item, fm): + for name in ("fm", "hello", "item"): + faclist = fm.getfixturedefs(name, item.nodeid) + assert len(faclist) == 1 + fac = faclist[0] + assert fac.func.__name__ == "pytest_funcarg__" + name + """) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(passed=1) + + def test_parsefactories_conftest_and_module_and_class(self, testdir): + testdir.makepyfile(""" + def pytest_funcarg__hello(request): + return "module" + class TestClass: + def pytest_funcarg__hello(self, request): + return "class" + def test_hello(self, item, fm): + faclist = fm.getfixturedefs("hello", item.nodeid) + print (faclist) + assert len(faclist) == 3 + assert faclist[0].func(item._request) == "conftest" + assert faclist[1].func(item._request) == "module" + assert faclist[2].func(item._request) == "class" + """) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(passed=1) + + def test_parsefactories_relative_node_ids(self, testdir): + # example mostly taken from: + # https://mail.python.org/pipermail/pytest-dev/2014-September/002617.html + runner = testdir.mkdir("runner") + package = testdir.mkdir("package") + package.join("conftest.py").write(dedent("""\ + import pytest + @pytest.fixture + def one(): + return 1 + """)) + package.join("test_x.py").write(dedent("""\ + def test_x(one): + assert one == 1 + """)) + sub = package.mkdir("sub") + sub.join("__init__.py").ensure() + sub.join("conftest.py").write(dedent("""\ + import pytest + @pytest.fixture + def one(): + return 2 + """)) + sub.join("test_y.py").write(dedent("""\ + def test_x(one): + assert one == 2 + """)) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + with runner.as_cwd(): + reprec = testdir.inline_run("..") + reprec.assertoutcome(passed=2) + + +class TestAutouseDiscovery: + def pytest_funcarg__testdir(self, testdir): + testdir.makeconftest(""" + import pytest + @pytest.fixture(autouse=True) + def perfunction(request, tmpdir): + pass + + @pytest.fixture() + def arg1(tmpdir): + pass + @pytest.fixture(autouse=True) + def perfunction2(arg1): + pass + + def pytest_funcarg__fm(request): + return request._fixturemanager + + def pytest_funcarg__item(request): + return request._pyfuncitem + """) + return testdir + + def test_parsefactories_conftest(self, testdir): + testdir.makepyfile(""" + from _pytest.pytester import get_public_names + def test_check_setup(item, fm): + autousenames = fm._getautousenames(item.nodeid) + assert len(get_public_names(autousenames)) == 2 + assert "perfunction2" in autousenames + assert "perfunction" in autousenames + """) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(passed=1) + + def test_two_classes_separated_autouse(self, testdir): + testdir.makepyfile(""" + import pytest + class TestA: + l = [] + @pytest.fixture(autouse=True) + def setup1(self): + self.l.append(1) + def test_setup1(self): + assert self.l == [1] + class TestB: + l = [] + @pytest.fixture(autouse=True) + def setup2(self): + self.l.append(1) + def test_setup2(self): + assert self.l == [1] + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + + def test_setup_at_classlevel(self, testdir): + testdir.makepyfile(""" + import pytest + class TestClass: + @pytest.fixture(autouse=True) + def permethod(self, request): + request.instance.funcname = request.function.__name__ + def test_method1(self): + assert self.funcname == "test_method1" + def test_method2(self): + assert self.funcname == "test_method2" + """) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(passed=2) + + @pytest.mark.xfail(reason="'enabled' feature not implemented") + def test_setup_enabled_functionnode(self, testdir): + testdir.makepyfile(""" + import pytest + + def enabled(parentnode, markers): + return "needsdb" in markers + + @pytest.fixture(params=[1,2]) + def db(request): + return request.param + + @pytest.fixture(enabled=enabled, autouse=True) + def createdb(db): + pass + + def test_func1(request): + assert "db" not in request.fixturenames + + @pytest.mark.needsdb + def test_func2(request): + assert "db" in request.fixturenames + """) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(passed=2) + + def test_callables_nocode(self, testdir): + """ + a imported mock.call would break setup/factory discovery + due to it being callable and __code__ not being a code object + """ + testdir.makepyfile(""" + class _call(tuple): + def __call__(self, *k, **kw): + pass + def __getattr__(self, k): + return self + + call = _call() + """) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(failed=0, passed=0) + + def test_autouse_in_conftests(self, testdir): + a = testdir.mkdir("a") + b = testdir.mkdir("a1") + conftest = testdir.makeconftest(""" + import pytest + @pytest.fixture(autouse=True) + def hello(): + xxx + """) + conftest.move(a.join(conftest.basename)) + a.join("test_something.py").write("def test_func(): pass") + b.join("test_otherthing.py").write("def test_func(): pass") + result = testdir.runpytest() + result.stdout.fnmatch_lines(""" + *1 passed*1 error* + """) + + def test_autouse_in_module_and_two_classes(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(autouse=True) + def append1(): + l.append("module") + def test_x(): + assert l == ["module"] + + class TestA: + @pytest.fixture(autouse=True) + def append2(self): + l.append("A") + def test_hello(self): + assert l == ["module", "module", "A"], l + class TestA2: + def test_world(self): + assert l == ["module", "module", "A", "module"], l + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=3) + + +class TestAutouseManagement: + def test_autouse_conftest_mid_directory(self, testdir): + pkgdir = testdir.mkpydir("xyz123") + pkgdir.join("conftest.py").write(_pytest._code.Source(""" + import pytest + @pytest.fixture(autouse=True) + def app(): + import sys + sys._myapp = "hello" + """)) + t = pkgdir.ensure("tests", "test_app.py") + t.write(_pytest._code.Source(""" + import sys + def test_app(): + assert sys._myapp == "hello" + """)) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(passed=1) + + def test_autouse_honored_for_yield(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(autouse=True) + def tst(): + global x + x = 3 + def test_gen(): + def f(hello): + assert x == abs(hello) + yield f, 3 + yield f, -3 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + + + + def test_funcarg_and_setup(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(scope="module") + def arg(): + l.append(1) + return 0 + @pytest.fixture(scope="module", autouse=True) + def something(arg): + l.append(2) + + def test_hello(arg): + assert len(l) == 2 + assert l == [1,2] + assert arg == 0 + + def test_hello2(arg): + assert len(l) == 2 + assert l == [1,2] + assert arg == 0 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + + def test_uses_parametrized_resource(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(params=[1,2]) + def arg(request): + return request.param + + @pytest.fixture(autouse=True) + def something(arg): + l.append(arg) + + def test_hello(): + if len(l) == 1: + assert l == [1] + elif len(l) == 2: + assert l == [1, 2] + else: + 0/0 + + """) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(passed=2) + + def test_session_parametrized_function(self, testdir): + testdir.makepyfile(""" + import pytest + + l = [] + + @pytest.fixture(scope="session", params=[1,2]) + def arg(request): + return request.param + + @pytest.fixture(scope="function", autouse=True) + def append(request, arg): + if request.function.__name__ == "test_some": + l.append(arg) + + def test_some(): + pass + + def test_result(arg): + assert len(l) == arg + assert l[:arg] == [1,2][:arg] + """) + reprec = testdir.inline_run("-v", "-s") + reprec.assertoutcome(passed=4) + + def test_class_function_parametrization_finalization(self, testdir): + p = testdir.makeconftest(""" + import pytest + import pprint + + l = [] + + @pytest.fixture(scope="function", params=[1,2]) + def farg(request): + return request.param + + @pytest.fixture(scope="class", params=list("ab")) + def carg(request): + return request.param + + @pytest.fixture(scope="function", autouse=True) + def append(request, farg, carg): + def fin(): + l.append("fin_%s%s" % (carg, farg)) + request.addfinalizer(fin) + """) + testdir.makepyfile(""" + import pytest + + class TestClass: + def test_1(self): + pass + class TestClass2: + def test_2(self): + pass + """) + reprec = testdir.inline_run("-v","-s") + reprec.assertoutcome(passed=8) + config = reprec.getcalls("pytest_unconfigure")[0].config + l = config.pluginmanager._getconftestmodules(p)[0].l + assert l == ["fin_a1", "fin_a2", "fin_b1", "fin_b2"] * 2 + + def test_scope_ordering(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(scope="function", autouse=True) + def fappend2(): + l.append(2) + @pytest.fixture(scope="class", autouse=True) + def classappend3(): + l.append(3) + @pytest.fixture(scope="module", autouse=True) + def mappend(): + l.append(1) + + class TestHallo: + def test_method(self): + assert l == [1,3,2] + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_parametrization_setup_teardown_ordering(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + def pytest_generate_tests(metafunc): + if metafunc.cls is not None: + metafunc.parametrize("item", [1,2], scope="class") + class TestClass: + @pytest.fixture(scope="class", autouse=True) + def addteardown(self, item, request): + l.append("setup-%d" % item) + request.addfinalizer(lambda: l.append("teardown-%d" % item)) + def test_step1(self, item): + l.append("step1-%d" % item) + def test_step2(self, item): + l.append("step2-%d" % item) + + def test_finish(): + print (l) + assert l == ["setup-1", "step1-1", "step2-1", "teardown-1", + "setup-2", "step1-2", "step2-2", "teardown-2",] + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=5) + + def test_ordering_autouse_before_explicit(self, testdir): + testdir.makepyfile(""" + import pytest + + l = [] + @pytest.fixture(autouse=True) + def fix1(): + l.append(1) + @pytest.fixture() + def arg1(): + l.append(2) + def test_hello(arg1): + assert l == [1,2] + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + @pytest.mark.issue226 + @pytest.mark.parametrize("param1", ["", "params=[1]"], ids=["p00","p01"]) + @pytest.mark.parametrize("param2", ["", "params=[1]"], ids=["p10","p11"]) + def test_ordering_dependencies_torndown_first(self, testdir, param1, param2): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(%(param1)s) + def arg1(request): + request.addfinalizer(lambda: l.append("fin1")) + l.append("new1") + @pytest.fixture(%(param2)s) + def arg2(request, arg1): + request.addfinalizer(lambda: l.append("fin2")) + l.append("new2") + + def test_arg(arg2): + pass + def test_check(): + assert l == ["new1", "new2", "fin2", "fin1"] + """ % locals()) + reprec = testdir.inline_run("-s") + reprec.assertoutcome(passed=2) + + +class TestFixtureMarker: + def test_parametrize(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(params=["a", "b", "c"]) + def arg(request): + return request.param + l = [] + def test_param(arg): + l.append(arg) + def test_result(): + assert l == list("abc") + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=4) + + def test_multiple_parametrization_issue_736(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture(params=[1,2,3]) + def foo(request): + return request.param + + @pytest.mark.parametrize('foobar', [4,5,6]) + def test_issue(foo, foobar): + assert foo in [1,2,3] + assert foobar in [4,5,6] + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=9) + + @pytest.mark.parametrize('param_args', ["'fixt, val'", "'fixt,val'", "['fixt', 'val']", "('fixt', 'val')"]) + def test_override_parametrized_fixture_issue_979(self, testdir, param_args): + """Make sure a parametrized argument can override a parametrized fixture. + + This was a regression introduced in the fix for #736. + """ + testdir.makepyfile(""" + import pytest + + @pytest.fixture(params=[1, 2]) + def fixt(request): + return request.param + + @pytest.mark.parametrize(%s, [(3, 'x'), (4, 'x')]) + def test_foo(fixt, val): + pass + """ % param_args) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + + def test_scope_session(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(scope="module") + def arg(): + l.append(1) + return 1 + + def test_1(arg): + assert arg == 1 + def test_2(arg): + assert arg == 1 + assert len(l) == 1 + class TestClass: + def test3(self, arg): + assert arg == 1 + assert len(l) == 1 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=3) + + def test_scope_session_exc(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(scope="session") + def fix(): + l.append(1) + pytest.skip('skipping') + + def test_1(fix): + pass + def test_2(fix): + pass + def test_last(): + assert l == [1] + """) + reprec = testdir.inline_run() + reprec.assertoutcome(skipped=2, passed=1) + + def test_scope_session_exc_two_fix(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + m = [] + @pytest.fixture(scope="session") + def a(): + l.append(1) + pytest.skip('skipping') + @pytest.fixture(scope="session") + def b(a): + m.append(1) + + def test_1(b): + pass + def test_2(b): + pass + def test_last(): + assert l == [1] + assert m == [] + """) + reprec = testdir.inline_run() + reprec.assertoutcome(skipped=2, passed=1) + + def test_scope_exc(self, testdir): + testdir.makepyfile( + test_foo=""" + def test_foo(fix): + pass + """, + test_bar=""" + def test_bar(fix): + pass + """, + conftest=""" + import pytest + reqs = [] + @pytest.fixture(scope="session") + def fix(request): + reqs.append(1) + pytest.skip() + @pytest.fixture + def req_list(): + return reqs + """, + test_real=""" + def test_last(req_list): + assert req_list == [1] + """ + ) + reprec = testdir.inline_run() + reprec.assertoutcome(skipped=2, passed=1) + + def test_scope_module_uses_session(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(scope="module") + def arg(): + l.append(1) + return 1 + + def test_1(arg): + assert arg == 1 + def test_2(arg): + assert arg == 1 + assert len(l) == 1 + class TestClass: + def test3(self, arg): + assert arg == 1 + assert len(l) == 1 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=3) + + def test_scope_module_and_finalizer(self, testdir): + testdir.makeconftest(""" + import pytest + finalized = [] + created = [] + @pytest.fixture(scope="module") + def arg(request): + created.append(1) + assert request.scope == "module" + request.addfinalizer(lambda: finalized.append(1)) + def pytest_funcarg__created(request): + return len(created) + def pytest_funcarg__finalized(request): + return len(finalized) + """) + testdir.makepyfile( + test_mod1=""" + def test_1(arg, created, finalized): + assert created == 1 + assert finalized == 0 + def test_2(arg, created, finalized): + assert created == 1 + assert finalized == 0""", + test_mod2=""" + def test_3(arg, created, finalized): + assert created == 2 + assert finalized == 1""", + test_mode3=""" + def test_4(arg, created, finalized): + assert created == 3 + assert finalized == 2 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=4) + + @pytest.mark.parametrize("method", [ + 'request.getfuncargvalue("arg")', + 'request.cached_setup(lambda: None, scope="function")', + ], ids=["getfuncargvalue", "cached_setup"]) + def test_scope_mismatch_various(self, testdir, method): + testdir.makeconftest(""" + import pytest + finalized = [] + created = [] + @pytest.fixture(scope="function") + def arg(request): + pass + """) + testdir.makepyfile( + test_mod1=""" + import pytest + @pytest.fixture(scope="session") + def arg(request): + %s + def test_1(arg): + pass + """ % method) + result = testdir.runpytest() + assert result.ret != 0 + result.stdout.fnmatch_lines([ + "*ScopeMismatch*You tried*function*session*request*", + ]) + + def test_register_only_with_mark(self, testdir): + testdir.makeconftest(""" + import pytest + @pytest.fixture() + def arg(): + return 1 + """) + testdir.makepyfile( + test_mod1=""" + import pytest + @pytest.fixture() + def arg(arg): + return arg + 1 + def test_1(arg): + assert arg == 2 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_parametrize_and_scope(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope="module", params=["a", "b", "c"]) + def arg(request): + return request.param + l = [] + def test_param(arg): + l.append(arg) + """) + reprec = testdir.inline_run("-v") + reprec.assertoutcome(passed=3) + l = reprec.getcalls("pytest_runtest_call")[0].item.module.l + assert len(l) == 3 + assert "a" in l + assert "b" in l + assert "c" in l + + def test_scope_mismatch(self, testdir): + testdir.makeconftest(""" + import pytest + @pytest.fixture(scope="function") + def arg(request): + pass + """) + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope="session") + def arg(arg): + pass + def test_mismatch(arg): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*ScopeMismatch*", + "*1 error*", + ]) + + def test_parametrize_separated_order(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture(scope="module", params=[1, 2]) + def arg(request): + return request.param + + l = [] + def test_1(arg): + l.append(arg) + def test_2(arg): + l.append(arg) + """) + reprec = testdir.inline_run("-v") + reprec.assertoutcome(passed=4) + l = reprec.getcalls("pytest_runtest_call")[0].item.module.l + assert l == [1,1,2,2] + + def test_module_parametrized_ordering(self, testdir): + testdir.makeconftest(""" + import pytest + + @pytest.fixture(scope="session", params="s1 s2".split()) + def sarg(): + pass + @pytest.fixture(scope="module", params="m1 m2".split()) + def marg(): + pass + """) + testdir.makepyfile(test_mod1=""" + def test_func(sarg): + pass + def test_func1(marg): + pass + """, test_mod2=""" + def test_func2(sarg): + pass + def test_func3(sarg, marg): + pass + def test_func3b(sarg, marg): + pass + def test_func4(marg): + pass + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines(""" + test_mod1.py::test_func[s1] PASSED + test_mod2.py::test_func2[s1] PASSED + test_mod2.py::test_func3[s1-m1] PASSED + test_mod2.py::test_func3b[s1-m1] PASSED + test_mod2.py::test_func3[s1-m2] PASSED + test_mod2.py::test_func3b[s1-m2] PASSED + test_mod1.py::test_func[s2] PASSED + test_mod2.py::test_func2[s2] PASSED + test_mod2.py::test_func3[s2-m1] PASSED + test_mod2.py::test_func3b[s2-m1] PASSED + test_mod2.py::test_func4[m1] PASSED + test_mod2.py::test_func3[s2-m2] PASSED + test_mod2.py::test_func3b[s2-m2] PASSED + test_mod2.py::test_func4[m2] PASSED + test_mod1.py::test_func1[m1] PASSED + test_mod1.py::test_func1[m2] PASSED + """) + + def test_class_ordering(self, testdir): + testdir.makeconftest(""" + import pytest + + l = [] + + @pytest.fixture(scope="function", params=[1,2]) + def farg(request): + return request.param + + @pytest.fixture(scope="class", params=list("ab")) + def carg(request): + return request.param + + @pytest.fixture(scope="function", autouse=True) + def append(request, farg, carg): + def fin(): + l.append("fin_%s%s" % (carg, farg)) + request.addfinalizer(fin) + """) + testdir.makepyfile(""" + import pytest + + class TestClass2: + def test_1(self): + pass + def test_2(self): + pass + class TestClass: + def test_3(self): + pass + """) + result = testdir.runpytest("-vs") + result.stdout.fnmatch_lines(""" + test_class_ordering.py::TestClass2::test_1[1-a] PASSED + test_class_ordering.py::TestClass2::test_1[2-a] PASSED + test_class_ordering.py::TestClass2::test_2[1-a] PASSED + test_class_ordering.py::TestClass2::test_2[2-a] PASSED + test_class_ordering.py::TestClass2::test_1[1-b] PASSED + test_class_ordering.py::TestClass2::test_1[2-b] PASSED + test_class_ordering.py::TestClass2::test_2[1-b] PASSED + test_class_ordering.py::TestClass2::test_2[2-b] PASSED + test_class_ordering.py::TestClass::test_3[1-a] PASSED + test_class_ordering.py::TestClass::test_3[2-a] PASSED + test_class_ordering.py::TestClass::test_3[1-b] PASSED + test_class_ordering.py::TestClass::test_3[2-b] PASSED + """) + + def test_parametrize_separated_order_higher_scope_first(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture(scope="function", params=[1, 2]) + def arg(request): + param = request.param + request.addfinalizer(lambda: l.append("fin:%s" % param)) + l.append("create:%s" % param) + return request.param + + @pytest.fixture(scope="module", params=["mod1", "mod2"]) + def modarg(request): + param = request.param + request.addfinalizer(lambda: l.append("fin:%s" % param)) + l.append("create:%s" % param) + return request.param + + l = [] + def test_1(arg): + l.append("test1") + def test_2(modarg): + l.append("test2") + def test_3(arg, modarg): + l.append("test3") + def test_4(modarg, arg): + l.append("test4") + """) + reprec = testdir.inline_run("-v") + reprec.assertoutcome(passed=12) + l = reprec.getcalls("pytest_runtest_call")[0].item.module.l + expected = [ + 'create:1', 'test1', 'fin:1', 'create:2', 'test1', + 'fin:2', 'create:mod1', 'test2', 'create:1', 'test3', + 'fin:1', 'create:2', 'test3', 'fin:2', 'create:1', + 'test4', 'fin:1', 'create:2', 'test4', 'fin:2', + 'fin:mod1', 'create:mod2', 'test2', 'create:1', 'test3', + 'fin:1', 'create:2', 'test3', 'fin:2', 'create:1', + 'test4', 'fin:1', 'create:2', 'test4', 'fin:2', + 'fin:mod2'] + import pprint + pprint.pprint(list(zip(l, expected))) + assert l == expected + + def test_parametrized_fixture_teardown_order(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(params=[1,2], scope="class") + def param1(request): + return request.param + + l = [] + + class TestClass: + @classmethod + @pytest.fixture(scope="class", autouse=True) + def setup1(self, request, param1): + l.append(1) + request.addfinalizer(self.teardown1) + @classmethod + def teardown1(self): + assert l.pop() == 1 + @pytest.fixture(scope="class", autouse=True) + def setup2(self, request, param1): + l.append(2) + request.addfinalizer(self.teardown2) + @classmethod + def teardown2(self): + assert l.pop() == 2 + def test(self): + pass + + def test_finish(): + assert not l + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines(""" + *3 passed* + """) + assert "error" not in result.stdout.str() + + def test_fixture_finalizer(self, testdir): + testdir.makeconftest(""" + import pytest + import sys + + @pytest.fixture + def browser(request): + + def finalize(): + sys.stdout.write('Finalized') + request.addfinalizer(finalize) + return {} + """) + b = testdir.mkdir("subdir") + b.join("test_overriden_fixture_finalizer.py").write(dedent(""" + import pytest + @pytest.fixture + def browser(browser): + browser['visited'] = True + return browser + + def test_browser(browser): + assert browser['visited'] is True + """)) + reprec = testdir.runpytest("-s") + for test in ['test_browser']: + reprec.stdout.fnmatch_lines('*Finalized*') + + def test_class_scope_with_normal_tests(self, testdir): + testpath = testdir.makepyfile(""" + import pytest + + class Box: + value = 0 + + @pytest.fixture(scope='class') + def a(request): + Box.value += 1 + return Box.value + + def test_a(a): + assert a == 1 + + class Test1: + def test_b(self, a): + assert a == 2 + + class Test2: + def test_c(self, a): + assert a == 3""") + reprec = testdir.inline_run(testpath) + for test in ['test_a', 'test_b', 'test_c']: + assert reprec.matchreport(test).passed + + def test_request_is_clean(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(params=[1, 2]) + def fix(request): + request.addfinalizer(lambda: l.append(request.param)) + def test_fix(fix): + pass + """) + reprec = testdir.inline_run("-s") + l = reprec.getcalls("pytest_runtest_call")[0].item.module.l + assert l == [1,2] + + def test_parametrize_separated_lifecycle(self, testdir): + testdir.makepyfile(""" + import pytest + + l = [] + @pytest.fixture(scope="module", params=[1, 2]) + def arg(request): + x = request.param + request.addfinalizer(lambda: l.append("fin%s" % x)) + return request.param + def test_1(arg): + l.append(arg) + def test_2(arg): + l.append(arg) + """) + reprec = testdir.inline_run("-vs") + reprec.assertoutcome(passed=4) + l = reprec.getcalls("pytest_runtest_call")[0].item.module.l + import pprint + pprint.pprint(l) + #assert len(l) == 6 + assert l[0] == l[1] == 1 + assert l[2] == "fin1" + assert l[3] == l[4] == 2 + assert l[5] == "fin2" + + def test_parametrize_function_scoped_finalizers_called(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture(scope="function", params=[1, 2]) + def arg(request): + x = request.param + request.addfinalizer(lambda: l.append("fin%s" % x)) + return request.param + + l = [] + def test_1(arg): + l.append(arg) + def test_2(arg): + l.append(arg) + def test_3(): + assert len(l) == 8 + assert l == [1, "fin1", 2, "fin2", 1, "fin1", 2, "fin2"] + """) + reprec = testdir.inline_run("-v") + reprec.assertoutcome(passed=5) + + + @pytest.mark.issue246 + @pytest.mark.parametrize("scope", ["session", "function", "module"]) + def test_finalizer_order_on_parametrization(self, scope, testdir): + testdir.makepyfile(""" + import pytest + l = [] + + @pytest.fixture(scope=%(scope)r, params=["1"]) + def fix1(request): + return request.param + + @pytest.fixture(scope=%(scope)r) + def fix2(request, base): + def cleanup_fix2(): + assert not l, "base should not have been finalized" + request.addfinalizer(cleanup_fix2) + + @pytest.fixture(scope=%(scope)r) + def base(request, fix1): + def cleanup_base(): + l.append("fin_base") + print ("finalizing base") + request.addfinalizer(cleanup_base) + + def test_begin(): + pass + def test_baz(base, fix2): + pass + def test_other(): + pass + """ % {"scope": scope}) + reprec = testdir.inline_run("-lvs") + reprec.assertoutcome(passed=3) + + @pytest.mark.issue396 + def test_class_scope_parametrization_ordering(self, testdir): + testdir.makepyfile(""" + import pytest + l = [] + @pytest.fixture(params=["John", "Doe"], scope="class") + def human(request): + request.addfinalizer(lambda: l.append("fin %s" % request.param)) + return request.param + + class TestGreetings: + def test_hello(self, human): + l.append("test_hello") + + class TestMetrics: + def test_name(self, human): + l.append("test_name") + + def test_population(self, human): + l.append("test_population") + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=6) + l = reprec.getcalls("pytest_runtest_call")[0].item.module.l + assert l == ["test_hello", "fin John", "test_hello", "fin Doe", + "test_name", "test_population", "fin John", + "test_name", "test_population", "fin Doe"] + + def test_parametrize_setup_function(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture(scope="module", params=[1, 2]) + def arg(request): + return request.param + + @pytest.fixture(scope="module", autouse=True) + def mysetup(request, arg): + request.addfinalizer(lambda: l.append("fin%s" % arg)) + l.append("setup%s" % arg) + + l = [] + def test_1(arg): + l.append(arg) + def test_2(arg): + l.append(arg) + def test_3(): + import pprint + pprint.pprint(l) + if arg == 1: + assert l == ["setup1", 1, 1, ] + elif arg == 2: + assert l == ["setup1", 1, 1, "fin1", + "setup2", 2, 2, ] + + """) + reprec = testdir.inline_run("-v") + reprec.assertoutcome(passed=6) + + def test_fixture_marked_function_not_collected_as_test(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture + def test_app(): + return 1 + + def test_something(test_app): + assert test_app == 1 + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_params_and_ids(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture(params=[object(), object()], + ids=['alpha', 'beta']) + def fix(request): + return request.param + + def test_foo(fix): + assert 1 + """) + res = testdir.runpytest('-v') + res.stdout.fnmatch_lines([ + '*test_foo*alpha*', + '*test_foo*beta*']) + + def test_params_and_ids_yieldfixture(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.yield_fixture(params=[object(), object()], + ids=['alpha', 'beta']) + def fix(request): + yield request.param + + def test_foo(fix): + assert 1 + """) + res = testdir.runpytest('-v') + res.stdout.fnmatch_lines([ + '*test_foo*alpha*', + '*test_foo*beta*']) + + +class TestRequestScopeAccess: + pytestmark = pytest.mark.parametrize(("scope", "ok", "error"),[ + ["session", "", "fspath class function module"], + ["module", "module fspath", "cls function"], + ["class", "module fspath cls", "function"], + ["function", "module fspath cls function", ""] + ]) + + def test_setup(self, testdir, scope, ok, error): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope=%r, autouse=True) + def myscoped(request): + for x in %r: + assert hasattr(request, x) + for x in %r: + pytest.raises(AttributeError, lambda: + getattr(request, x)) + assert request.session + assert request.config + def test_func(): + pass + """ %(scope, ok.split(), error.split())) + reprec = testdir.inline_run("-l") + reprec.assertoutcome(passed=1) + + def test_funcarg(self, testdir, scope, ok, error): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope=%r) + def arg(request): + for x in %r: + assert hasattr(request, x) + for x in %r: + pytest.raises(AttributeError, lambda: + getattr(request, x)) + assert request.session + assert request.config + def test_func(arg): + pass + """ %(scope, ok.split(), error.split())) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + +class TestErrors: + def test_subfactory_missing_funcarg(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture() + def gen(qwe123): + return 1 + def test_something(gen): + pass + """) + result = testdir.runpytest() + assert result.ret != 0 + result.stdout.fnmatch_lines([ + "*def gen(qwe123):*", + "*fixture*qwe123*not found*", + "*1 error*", + ]) + + def test_issue498_fixture_finalizer_failing(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture + def fix1(request): + def f(): + raise KeyError + request.addfinalizer(f) + return object() + + l = [] + def test_1(fix1): + l.append(fix1) + def test_2(fix1): + l.append(fix1) + def test_3(): + assert l[0] != l[1] + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(""" + *ERROR*teardown*test_1* + *KeyError* + *ERROR*teardown*test_2* + *KeyError* + *3 pass*2 error* + """) + + + + def test_setupfunc_missing_funcarg(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(autouse=True) + def gen(qwe123): + return 1 + def test_something(): + pass + """) + result = testdir.runpytest() + assert result.ret != 0 + result.stdout.fnmatch_lines([ + "*def gen(qwe123):*", + "*fixture*qwe123*not found*", + "*1 error*", + ]) + +class TestShowFixtures: + def test_funcarg_compat(self, testdir): + config = testdir.parseconfigure("--funcargs") + assert config.option.showfixtures + + def test_show_fixtures(self, testdir): + result = testdir.runpytest("--fixtures") + result.stdout.fnmatch_lines([ + "*tmpdir*", + "*temporary directory*", + ] + ) + + def test_show_fixtures_verbose(self, testdir): + result = testdir.runpytest("--fixtures", "-v") + result.stdout.fnmatch_lines([ + "*tmpdir*--*tmpdir.py*", + "*temporary directory*", + ] + ) + + def test_show_fixtures_testmodule(self, testdir): + p = testdir.makepyfile(''' + import pytest + @pytest.fixture + def _arg0(): + """ hidden """ + @pytest.fixture + def arg1(): + """ hello world """ + ''') + result = testdir.runpytest("--fixtures", p) + result.stdout.fnmatch_lines(""" + *tmpdir + *fixtures defined from* + *arg1* + *hello world* + """) + assert "arg0" not in result.stdout.str() + + @pytest.mark.parametrize("testmod", [True, False]) + def test_show_fixtures_conftest(self, testdir, testmod): + testdir.makeconftest(''' + import pytest + @pytest.fixture + def arg1(): + """ hello world """ + ''') + if testmod: + testdir.makepyfile(""" + def test_hello(): + pass + """) + result = testdir.runpytest("--fixtures") + result.stdout.fnmatch_lines(""" + *tmpdir* + *fixtures defined from*conftest* + *arg1* + *hello world* + """) + + def test_show_fixtures_trimmed_doc(self, testdir): + p = testdir.makepyfile(''' + import pytest + @pytest.fixture + def arg1(): + """ + line1 + line2 + + """ + @pytest.fixture + def arg2(): + """ + line1 + line2 + + """ + ''') + result = testdir.runpytest("--fixtures", p) + result.stdout.fnmatch_lines(""" + * fixtures defined from test_show_fixtures_trimmed_doc * + arg2 + line1 + line2 + arg1 + line1 + line2 + + """) + + + def test_show_fixtures_different_files(self, testdir): + """ + #833: --fixtures only shows fixtures from first file + """ + testdir.makepyfile(test_a=''' + import pytest + + @pytest.fixture + def fix_a(): + """Fixture A""" + pass + + def test_a(fix_a): + pass + ''') + testdir.makepyfile(test_b=''' + import pytest + + @pytest.fixture + def fix_b(): + """Fixture B""" + pass + + def test_b(fix_b): + pass + ''') + result = testdir.runpytest("--fixtures") + result.stdout.fnmatch_lines(""" + * fixtures defined from test_a * + fix_a + Fixture A + + * fixtures defined from test_b * + fix_b + Fixture B + """) + + +class TestContextManagerFixtureFuncs: + def test_simple(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.yield_fixture + def arg1(): + print ("setup") + yield 1 + print ("teardown") + def test_1(arg1): + print ("test1 %s" % arg1) + def test_2(arg1): + print ("test2 %s" % arg1) + assert 0 + """) + result = testdir.runpytest("-s") + result.stdout.fnmatch_lines(""" + *setup* + *test1 1* + *teardown* + *setup* + *test2 1* + *teardown* + """) + + def test_scoped(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.yield_fixture(scope="module") + def arg1(): + print ("setup") + yield 1 + print ("teardown") + def test_1(arg1): + print ("test1 %s" % arg1) + def test_2(arg1): + print ("test2 %s" % arg1) + """) + result = testdir.runpytest("-s") + result.stdout.fnmatch_lines(""" + *setup* + *test1 1* + *test2 1* + *teardown* + """) + + def test_setup_exception(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.yield_fixture(scope="module") + def arg1(): + pytest.fail("setup") + yield 1 + def test_1(arg1): + pass + """) + result = testdir.runpytest("-s") + result.stdout.fnmatch_lines(""" + *pytest.fail*setup* + *1 error* + """) + + def test_teardown_exception(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.yield_fixture(scope="module") + def arg1(): + yield 1 + pytest.fail("teardown") + def test_1(arg1): + pass + """) + result = testdir.runpytest("-s") + result.stdout.fnmatch_lines(""" + *pytest.fail*teardown* + *1 passed*1 error* + """) + + def test_yields_more_than_one(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.yield_fixture(scope="module") + def arg1(): + yield 1 + yield 2 + def test_1(arg1): + pass + """) + result = testdir.runpytest("-s") + result.stdout.fnmatch_lines(""" + *fixture function* + *test_yields*:2* + """) + + + def test_no_yield(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.yield_fixture(scope="module") + def arg1(): + return 1 + def test_1(arg1): + pass + """) + result = testdir.runpytest("-s") + result.stdout.fnmatch_lines(""" + *yield_fixture*requires*yield* + *yield_fixture* + *def arg1* + """) + + def test_yield_not_allowed_in_non_yield(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope="module") + def arg1(): + yield 1 + def test_1(arg1): + pass + """) + result = testdir.runpytest("-s") + result.stdout.fnmatch_lines(""" + *fixture*cannot use*yield* + *def arg1* + """) + diff --git a/testing/web-platform/tests/tools/pytest/testing/python/integration.py b/testing/web-platform/tests/tools/pytest/testing/python/integration.py new file mode 100644 index 000000000..dea86f942 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/python/integration.py @@ -0,0 +1,369 @@ +import pytest +from _pytest import python +from _pytest import runner + + +class TestOEJSKITSpecials: + def test_funcarg_non_pycollectobj(self, testdir): # rough jstests usage + testdir.makeconftest(""" + import pytest + def pytest_pycollect_makeitem(collector, name, obj): + if name == "MyClass": + return MyCollector(name, parent=collector) + class MyCollector(pytest.Collector): + def reportinfo(self): + return self.fspath, 3, "xyz" + """) + modcol = testdir.getmodulecol(""" + def pytest_funcarg__arg1(request): + return 42 + class MyClass: + pass + """) + # this hook finds funcarg factories + rep = runner.collect_one_node(collector=modcol) + clscol = rep.result[0] + clscol.obj = lambda arg1: None + clscol.funcargs = {} + pytest._fillfuncargs(clscol) + assert clscol.funcargs['arg1'] == 42 + + def test_autouse_fixture(self, testdir): # rough jstests usage + testdir.makeconftest(""" + import pytest + def pytest_pycollect_makeitem(collector, name, obj): + if name == "MyClass": + return MyCollector(name, parent=collector) + class MyCollector(pytest.Collector): + def reportinfo(self): + return self.fspath, 3, "xyz" + """) + modcol = testdir.getmodulecol(""" + import pytest + @pytest.fixture(autouse=True) + def hello(): + pass + def pytest_funcarg__arg1(request): + return 42 + class MyClass: + pass + """) + # this hook finds funcarg factories + rep = runner.collect_one_node(modcol) + clscol = rep.result[0] + clscol.obj = lambda: None + clscol.funcargs = {} + pytest._fillfuncargs(clscol) + assert not clscol.funcargs + + +def test_wrapped_getfslineno(): + def func(): + pass + def wrap(f): + func.__wrapped__ = f + func.patchings = ["qwe"] + return func + @wrap + def wrapped_func(x, y, z): + pass + fs, lineno = python.getfslineno(wrapped_func) + fs2, lineno2 = python.getfslineno(wrap) + assert lineno > lineno2, "getfslineno does not unwrap correctly" + +class TestMockDecoration: + def test_wrapped_getfuncargnames(self): + from _pytest.python import getfuncargnames + def wrap(f): + def func(): + pass + func.__wrapped__ = f + return func + @wrap + def f(x): + pass + l = getfuncargnames(f) + assert l == ("x",) + + def test_wrapped_getfuncargnames_patching(self): + from _pytest.python import getfuncargnames + def wrap(f): + def func(): + pass + func.__wrapped__ = f + func.patchings = ["qwe"] + return func + @wrap + def f(x, y, z): + pass + l = getfuncargnames(f) + assert l == ("y", "z") + + def test_unittest_mock(self, testdir): + pytest.importorskip("unittest.mock") + testdir.makepyfile(""" + import unittest.mock + class T(unittest.TestCase): + @unittest.mock.patch("os.path.abspath") + def test_hello(self, abspath): + import os + os.path.abspath("hello") + abspath.assert_any_call("hello") + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_unittest_mock_and_fixture(self, testdir): + pytest.importorskip("unittest.mock") + testdir.makepyfile(""" + import os.path + import unittest.mock + import pytest + + @pytest.fixture + def inject_me(): + pass + + @unittest.mock.patch.object(os.path, "abspath", + new=unittest.mock.MagicMock) + def test_hello(inject_me): + import os + os.path.abspath("hello") + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_mock(self, testdir): + pytest.importorskip("mock", "1.0.1") + testdir.makepyfile(""" + import os + import unittest + import mock + + class T(unittest.TestCase): + @mock.patch("os.path.abspath") + def test_hello(self, abspath): + os.path.abspath("hello") + abspath.assert_any_call("hello") + def mock_basename(path): + return "mock_basename" + @mock.patch("os.path.abspath") + @mock.patch("os.path.normpath") + @mock.patch("os.path.basename", new=mock_basename) + def test_someting(normpath, abspath, tmpdir): + abspath.return_value = "this" + os.path.normpath(os.path.abspath("hello")) + normpath.assert_any_call("this") + assert os.path.basename("123") == "mock_basename" + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + calls = reprec.getcalls("pytest_runtest_logreport") + funcnames = [call.report.location[2] for call in calls + if call.report.when == "call"] + assert funcnames == ["T.test_hello", "test_someting"] + + def test_mock_sorting(self, testdir): + pytest.importorskip("mock", "1.0.1") + testdir.makepyfile(""" + import os + import mock + + @mock.patch("os.path.abspath") + def test_one(abspath): + pass + @mock.patch("os.path.abspath") + def test_two(abspath): + pass + @mock.patch("os.path.abspath") + def test_three(abspath): + pass + """) + reprec = testdir.inline_run() + calls = reprec.getreports("pytest_runtest_logreport") + calls = [x for x in calls if x.when == "call"] + names = [x.nodeid.split("::")[-1] for x in calls] + assert names == ["test_one", "test_two", "test_three"] + + def test_mock_double_patch_issue473(self, testdir): + pytest.importorskip("mock", "1.0.1") + testdir.makepyfile(""" + from mock import patch + from pytest import mark + + @patch('os.getcwd') + @patch('os.path') + @mark.slow + class TestSimple: + def test_simple_thing(self, mock_path, mock_getcwd): + pass + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + +class TestReRunTests: + def test_rerun(self, testdir): + testdir.makeconftest(""" + from _pytest.runner import runtestprotocol + def pytest_runtest_protocol(item, nextitem): + runtestprotocol(item, log=False, nextitem=nextitem) + runtestprotocol(item, log=True, nextitem=nextitem) + """) + testdir.makepyfile(""" + import pytest + count = 0 + req = None + @pytest.fixture + def fix(request): + global count, req + assert request != req + req = request + print ("fix count %s" % count) + count += 1 + def test_fix(fix): + pass + """) + result = testdir.runpytest("-s") + result.stdout.fnmatch_lines(""" + *fix count 0* + *fix count 1* + """) + result.stdout.fnmatch_lines(""" + *2 passed* + """) + +def test_pytestconfig_is_session_scoped(): + from _pytest.python import pytestconfig + assert pytestconfig._pytestfixturefunction.scope == "session" + + +class TestNoselikeTestAttribute: + def test_module_with_global_test(self, testdir): + testdir.makepyfile(""" + __test__ = False + def test_hello(): + pass + """) + reprec = testdir.inline_run() + assert not reprec.getfailedcollections() + calls = reprec.getreports("pytest_runtest_logreport") + assert not calls + + def test_class_and_method(self, testdir): + testdir.makepyfile(""" + __test__ = True + def test_func(): + pass + test_func.__test__ = False + + class TestSome: + __test__ = False + def test_method(self): + pass + """) + reprec = testdir.inline_run() + assert not reprec.getfailedcollections() + calls = reprec.getreports("pytest_runtest_logreport") + assert not calls + + def test_unittest_class(self, testdir): + testdir.makepyfile(""" + import unittest + class TC(unittest.TestCase): + def test_1(self): + pass + class TC2(unittest.TestCase): + __test__ = False + def test_2(self): + pass + """) + reprec = testdir.inline_run() + assert not reprec.getfailedcollections() + call = reprec.getcalls("pytest_collection_modifyitems")[0] + assert len(call.items) == 1 + assert call.items[0].cls.__name__ == "TC" + + def test_class_with_nasty_getattr(self, testdir): + """Make sure we handle classes with a custom nasty __getattr__ right. + + With a custom __getattr__ which e.g. returns a function (like with a + RPC wrapper), we shouldn't assume this meant "__test__ = True". + """ + # https://github.com/pytest-dev/pytest/issues/1204 + testdir.makepyfile(""" + class MetaModel(type): + + def __getattr__(cls, key): + return lambda: None + + + BaseModel = MetaModel('Model', (), {}) + + + class Model(BaseModel): + + __metaclass__ = MetaModel + + def test_blah(self): + pass + """) + reprec = testdir.inline_run() + assert not reprec.getfailedcollections() + call = reprec.getcalls("pytest_collection_modifyitems")[0] + assert not call.items + + +@pytest.mark.issue351 +class TestParameterize: + + def test_idfn_marker(self, testdir): + testdir.makepyfile(""" + import pytest + + def idfn(param): + if param == 0: + return 'spam' + elif param == 1: + return 'ham' + else: + return None + + @pytest.mark.parametrize('a,b', [(0, 2), (1, 2)], ids=idfn) + def test_params(a, b): + pass + """) + res = testdir.runpytest('--collect-only') + res.stdout.fnmatch_lines([ + "*spam-2*", + "*ham-2*", + ]) + + def test_idfn_fixture(self, testdir): + testdir.makepyfile(""" + import pytest + + def idfn(param): + if param == 0: + return 'spam' + elif param == 1: + return 'ham' + else: + return None + + @pytest.fixture(params=[0, 1], ids=idfn) + def a(request): + return request.param + + @pytest.fixture(params=[1, 2], ids=idfn) + def b(request): + return request.param + + def test_params(a, b): + pass + """) + res = testdir.runpytest('--collect-only') + res.stdout.fnmatch_lines([ + "*spam-2*", + "*ham-2*", + ]) diff --git a/testing/web-platform/tests/tools/pytest/testing/python/metafunc.py b/testing/web-platform/tests/tools/pytest/testing/python/metafunc.py new file mode 100644 index 000000000..faa687f40 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/python/metafunc.py @@ -0,0 +1,1094 @@ +# -*- coding: utf-8 -*- +import re + +import _pytest._code +import py +import pytest +from _pytest import python as funcargs + +class TestMetafunc: + def Metafunc(self, func): + # the unit tests of this class check if things work correctly + # on the funcarg level, so we don't need a full blown + # initiliazation + class FixtureInfo: + name2fixturedefs = None + def __init__(self, names): + self.names_closure = names + names = funcargs.getfuncargnames(func) + fixtureinfo = FixtureInfo(names) + return funcargs.Metafunc(func, fixtureinfo, None) + + def test_no_funcargs(self, testdir): + def function(): pass + metafunc = self.Metafunc(function) + assert not metafunc.fixturenames + repr(metafunc._calls) + + def test_function_basic(self): + def func(arg1, arg2="qwe"): pass + metafunc = self.Metafunc(func) + assert len(metafunc.fixturenames) == 1 + assert 'arg1' in metafunc.fixturenames + assert metafunc.function is func + assert metafunc.cls is None + + def test_addcall_no_args(self): + def func(arg1): pass + metafunc = self.Metafunc(func) + metafunc.addcall() + assert len(metafunc._calls) == 1 + call = metafunc._calls[0] + assert call.id == "0" + assert not hasattr(call, 'param') + + def test_addcall_id(self): + def func(arg1): pass + metafunc = self.Metafunc(func) + pytest.raises(ValueError, "metafunc.addcall(id=None)") + + metafunc.addcall(id=1) + pytest.raises(ValueError, "metafunc.addcall(id=1)") + pytest.raises(ValueError, "metafunc.addcall(id='1')") + metafunc.addcall(id=2) + assert len(metafunc._calls) == 2 + assert metafunc._calls[0].id == "1" + assert metafunc._calls[1].id == "2" + + def test_addcall_param(self): + def func(arg1): pass + metafunc = self.Metafunc(func) + class obj: pass + metafunc.addcall(param=obj) + metafunc.addcall(param=obj) + metafunc.addcall(param=1) + assert len(metafunc._calls) == 3 + assert metafunc._calls[0].getparam("arg1") == obj + assert metafunc._calls[1].getparam("arg1") == obj + assert metafunc._calls[2].getparam("arg1") == 1 + + def test_addcall_funcargs(self): + def func(x): pass + metafunc = self.Metafunc(func) + class obj: pass + metafunc.addcall(funcargs={"x": 2}) + metafunc.addcall(funcargs={"x": 3}) + pytest.raises(pytest.fail.Exception, "metafunc.addcall({'xyz': 0})") + assert len(metafunc._calls) == 2 + assert metafunc._calls[0].funcargs == {'x': 2} + assert metafunc._calls[1].funcargs == {'x': 3} + assert not hasattr(metafunc._calls[1], 'param') + + def test_parametrize_error(self): + def func(x, y): pass + metafunc = self.Metafunc(func) + metafunc.parametrize("x", [1,2]) + pytest.raises(ValueError, lambda: metafunc.parametrize("x", [5,6])) + pytest.raises(ValueError, lambda: metafunc.parametrize("x", [5,6])) + metafunc.parametrize("y", [1,2]) + pytest.raises(ValueError, lambda: metafunc.parametrize("y", [5,6])) + pytest.raises(ValueError, lambda: metafunc.parametrize("y", [5,6])) + + def test_parametrize_and_id(self): + def func(x, y): pass + metafunc = self.Metafunc(func) + + metafunc.parametrize("x", [1,2], ids=['basic', 'advanced']) + metafunc.parametrize("y", ["abc", "def"]) + ids = [x.id for x in metafunc._calls] + assert ids == ["basic-abc", "basic-def", "advanced-abc", "advanced-def"] + + def test_parametrize_with_wrong_number_of_ids(self, testdir): + def func(x, y): pass + metafunc = self.Metafunc(func) + + pytest.raises(ValueError, lambda: + metafunc.parametrize("x", [1,2], ids=['basic'])) + + pytest.raises(ValueError, lambda: + metafunc.parametrize(("x","y"), [("abc", "def"), + ("ghi", "jkl")], ids=["one"])) + + def test_parametrize_with_userobjects(self): + def func(x, y): pass + metafunc = self.Metafunc(func) + class A: + pass + metafunc.parametrize("x", [A(), A()]) + metafunc.parametrize("y", list("ab")) + assert metafunc._calls[0].id == "x0-a" + assert metafunc._calls[1].id == "x0-b" + assert metafunc._calls[2].id == "x1-a" + assert metafunc._calls[3].id == "x1-b" + + @pytest.mark.skipif('sys.version_info[0] >= 3') + def test_unicode_idval_python2(self): + """unittest for the expected behavior to obtain ids for parametrized + unicode values in Python 2: if convertible to ascii, they should appear + as ascii values, otherwise fallback to hide the value behind the name + of the parametrized variable name. #1086 + """ + from _pytest.python import _idval + values = [ + (u'', ''), + (u'ascii', 'ascii'), + (u'ação', 'a6'), + (u'josé@blah.com', 'a6'), + (u'δοκ.ιμή@παράδειγμα.δοκιμή', 'a6'), + ] + for val, expected in values: + assert _idval(val, 'a', 6, None) == expected + + def test_bytes_idval(self): + """unittest for the expected behavior to obtain ids for parametrized + bytes values: + - python2: non-ascii strings are considered bytes and formatted using + "binary escape", where any byte < 127 is escaped into its hex form. + - python3: bytes objects are always escaped using "binary escape". + """ + from _pytest.python import _idval + values = [ + (b'', ''), + (b'\xc3\xb4\xff\xe4', '\\xc3\\xb4\\xff\\xe4'), + (b'ascii', 'ascii'), + (u'αρά'.encode('utf-8'), '\\xce\\xb1\\xcf\\x81\\xce\\xac'), + ] + for val, expected in values: + assert _idval(val, 'a', 6, None) == expected + + @pytest.mark.issue250 + def test_idmaker_autoname(self): + from _pytest.python import idmaker + result = idmaker(("a", "b"), [("string", 1.0), + ("st-ring", 2.0)]) + assert result == ["string-1.0", "st-ring-2.0"] + + result = idmaker(("a", "b"), [(object(), 1.0), + (object(), object())]) + assert result == ["a0-1.0", "a1-b1"] + # unicode mixing, issue250 + result = idmaker((py.builtin._totext("a"), "b"), [({}, b'\xc3\xb4')]) + assert result == ['a0-\\xc3\\xb4'] + + def test_idmaker_with_bytes_regex(self): + from _pytest.python import idmaker + result = idmaker(("a"), [(re.compile(b'foo'), 1.0)]) + assert result == ["foo"] + + def test_idmaker_native_strings(self): + from _pytest.python import idmaker + totext = py.builtin._totext + result = idmaker(("a", "b"), [(1.0, -1.1), + (2, -202), + ("three", "three hundred"), + (True, False), + (None, None), + (re.compile('foo'), re.compile('bar')), + (str, int), + (list("six"), [66, 66]), + (set([7]), set("seven")), + (tuple("eight"), (8, -8, 8)), + (b'\xc3\xb4', b"name"), + (b'\xc3\xb4', totext("other")), + ]) + assert result == ["1.0--1.1", + "2--202", + "three-three hundred", + "True-False", + "None-None", + "foo-bar", + "str-int", + "a7-b7", + "a8-b8", + "a9-b9", + "\\xc3\\xb4-name", + "\\xc3\\xb4-other", + ] + + def test_idmaker_enum(self): + from _pytest.python import idmaker + enum = pytest.importorskip("enum") + e = enum.Enum("Foo", "one, two") + result = idmaker(("a", "b"), [(e.one, e.two)]) + assert result == ["Foo.one-Foo.two"] + + @pytest.mark.issue351 + def test_idmaker_idfn(self): + from _pytest.python import idmaker + def ids(val): + if isinstance(val, Exception): + return repr(val) + + result = idmaker(("a", "b"), [(10.0, IndexError()), + (20, KeyError()), + ("three", [1, 2, 3]), + ], idfn=ids) + assert result == ["10.0-IndexError()", + "20-KeyError()", + "three-b2", + ] + + @pytest.mark.issue351 + def test_idmaker_idfn_unique_names(self): + from _pytest.python import idmaker + def ids(val): + return 'a' + + result = idmaker(("a", "b"), [(10.0, IndexError()), + (20, KeyError()), + ("three", [1, 2, 3]), + ], idfn=ids) + assert result == ["0a-a", + "1a-a", + "2a-a", + ] + + @pytest.mark.issue351 + def test_idmaker_idfn_exception(self): + from _pytest.python import idmaker + def ids(val): + raise Exception("bad code") + + result = idmaker(("a", "b"), [(10.0, IndexError()), + (20, KeyError()), + ("three", [1, 2, 3]), + ], idfn=ids) + assert result == ["10.0-b0", + "20-b1", + "three-b2", + ] + + def test_addcall_and_parametrize(self): + def func(x, y): pass + metafunc = self.Metafunc(func) + metafunc.addcall({'x': 1}) + metafunc.parametrize('y', [2,3]) + assert len(metafunc._calls) == 2 + assert metafunc._calls[0].funcargs == {'x': 1, 'y': 2} + assert metafunc._calls[1].funcargs == {'x': 1, 'y': 3} + assert metafunc._calls[0].id == "0-2" + assert metafunc._calls[1].id == "0-3" + + @pytest.mark.issue714 + def test_parametrize_indirect(self): + def func(x, y): pass + metafunc = self.Metafunc(func) + metafunc.parametrize('x', [1], indirect=True) + metafunc.parametrize('y', [2,3], indirect=True) + assert len(metafunc._calls) == 2 + assert metafunc._calls[0].funcargs == {} + assert metafunc._calls[1].funcargs == {} + assert metafunc._calls[0].params == dict(x=1,y=2) + assert metafunc._calls[1].params == dict(x=1,y=3) + + @pytest.mark.issue714 + def test_parametrize_indirect_list(self): + def func(x, y): pass + metafunc = self.Metafunc(func) + metafunc.parametrize('x, y', [('a', 'b')], indirect=['x']) + assert metafunc._calls[0].funcargs == dict(y='b') + assert metafunc._calls[0].params == dict(x='a') + + @pytest.mark.issue714 + def test_parametrize_indirect_list_all(self): + def func(x, y): pass + metafunc = self.Metafunc(func) + metafunc.parametrize('x, y', [('a', 'b')], indirect=['x', 'y']) + assert metafunc._calls[0].funcargs == {} + assert metafunc._calls[0].params == dict(x='a', y='b') + + @pytest.mark.issue714 + def test_parametrize_indirect_list_empty(self): + def func(x, y): pass + metafunc = self.Metafunc(func) + metafunc.parametrize('x, y', [('a', 'b')], indirect=[]) + assert metafunc._calls[0].funcargs == dict(x='a', y='b') + assert metafunc._calls[0].params == {} + + @pytest.mark.issue714 + def test_parametrize_indirect_list_functional(self, testdir): + """ + Test parametrization with 'indirect' parameter applied on + particular arguments. As y is is direct, its value should + be used directly rather than being passed to the fixture + y. + + :param testdir: the instance of Testdir class, a temporary + test directory. + """ + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope='function') + def x(request): + return request.param * 3 + @pytest.fixture(scope='function') + def y(request): + return request.param * 2 + @pytest.mark.parametrize('x, y', [('a', 'b')], indirect=['x']) + def test_simple(x,y): + assert len(x) == 3 + assert len(y) == 1 + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines([ + "*test_simple*a-b*", + "*1 passed*", + ]) + + @pytest.mark.issue714 + def test_parametrize_indirect_list_error(self, testdir): + def func(x, y): pass + metafunc = self.Metafunc(func) + with pytest.raises(ValueError): + metafunc.parametrize('x, y', [('a', 'b')], indirect=['x', 'z']) + + @pytest.mark.issue714 + def test_parametrize_uses_no_fixture_error_indirect_false(self, testdir): + """The 'uses no fixture' error tells the user at collection time + that the parametrize data they've set up doesn't correspond to the + fixtures in their test function, rather than silently ignoring this + and letting the test potentially pass. + """ + testdir.makepyfile(""" + import pytest + + @pytest.mark.parametrize('x, y', [('a', 'b')], indirect=False) + def test_simple(x): + assert len(x) == 3 + """) + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*uses no fixture 'y'*", + ]) + + @pytest.mark.issue714 + def test_parametrize_uses_no_fixture_error_indirect_true(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope='function') + def x(request): + return request.param * 3 + @pytest.fixture(scope='function') + def y(request): + return request.param * 2 + + @pytest.mark.parametrize('x, y', [('a', 'b')], indirect=True) + def test_simple(x): + assert len(x) == 3 + """) + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*uses no fixture 'y'*", + ]) + + @pytest.mark.issue714 + def test_parametrize_indirect_uses_no_fixture_error_indirect_list(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope='function') + def x(request): + return request.param * 3 + + @pytest.mark.parametrize('x, y', [('a', 'b')], indirect=['x']) + def test_simple(x): + assert len(x) == 3 + """) + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*uses no fixture 'y'*", + ]) + + def test_addcalls_and_parametrize_indirect(self): + def func(x, y): pass + metafunc = self.Metafunc(func) + metafunc.addcall(param="123") + metafunc.parametrize('x', [1], indirect=True) + metafunc.parametrize('y', [2,3], indirect=True) + assert len(metafunc._calls) == 2 + assert metafunc._calls[0].funcargs == {} + assert metafunc._calls[1].funcargs == {} + assert metafunc._calls[0].params == dict(x=1,y=2) + assert metafunc._calls[1].params == dict(x=1,y=3) + + def test_parametrize_functional(self, testdir): + testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.parametrize('x', [1,2], indirect=True) + metafunc.parametrize('y', [2]) + def pytest_funcarg__x(request): + return request.param * 10 + #def pytest_funcarg__y(request): + # return request.param + + def test_simple(x,y): + assert x in (10,20) + assert y == 2 + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines([ + "*test_simple*1-2*", + "*test_simple*2-2*", + "*2 passed*", + ]) + + def test_parametrize_onearg(self): + metafunc = self.Metafunc(lambda x: None) + metafunc.parametrize("x", [1,2]) + assert len(metafunc._calls) == 2 + assert metafunc._calls[0].funcargs == dict(x=1) + assert metafunc._calls[0].id == "1" + assert metafunc._calls[1].funcargs == dict(x=2) + assert metafunc._calls[1].id == "2" + + def test_parametrize_onearg_indirect(self): + metafunc = self.Metafunc(lambda x: None) + metafunc.parametrize("x", [1,2], indirect=True) + assert metafunc._calls[0].params == dict(x=1) + assert metafunc._calls[0].id == "1" + assert metafunc._calls[1].params == dict(x=2) + assert metafunc._calls[1].id == "2" + + def test_parametrize_twoargs(self): + metafunc = self.Metafunc(lambda x,y: None) + metafunc.parametrize(("x", "y"), [(1,2), (3,4)]) + assert len(metafunc._calls) == 2 + assert metafunc._calls[0].funcargs == dict(x=1, y=2) + assert metafunc._calls[0].id == "1-2" + assert metafunc._calls[1].funcargs == dict(x=3, y=4) + assert metafunc._calls[1].id == "3-4" + + def test_parametrize_multiple_times(self, testdir): + testdir.makepyfile(""" + import pytest + pytestmark = pytest.mark.parametrize("x", [1,2]) + def test_func(x): + assert 0, x + class TestClass: + pytestmark = pytest.mark.parametrize("y", [3,4]) + def test_meth(self, x, y): + assert 0, x + """) + result = testdir.runpytest() + assert result.ret == 1 + result.assert_outcomes(failed=6) + + def test_parametrize_CSV(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize("x, y,", [(1,2), (2,3)]) + def test_func(x, y): + assert x+1 == y + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) + + def test_parametrize_class_scenarios(self, testdir): + testdir.makepyfile(""" + # same as doc/en/example/parametrize scenario example + def pytest_generate_tests(metafunc): + idlist = [] + argvalues = [] + for scenario in metafunc.cls.scenarios: + idlist.append(scenario[0]) + items = scenario[1].items() + argnames = [x[0] for x in items] + argvalues.append(([x[1] for x in items])) + metafunc.parametrize(argnames, argvalues, ids=idlist, scope="class") + + class Test(object): + scenarios = [['1', {'arg': {1: 2}, "arg2": "value2"}], + ['2', {'arg':'value2', "arg2": "value2"}]] + + def test_1(self, arg, arg2): + pass + + def test_2(self, arg2, arg): + pass + + def test_3(self, arg, arg2): + pass + """) + result = testdir.runpytest("-v") + assert result.ret == 0 + result.stdout.fnmatch_lines(""" + *test_1*1* + *test_2*1* + *test_3*1* + *test_1*2* + *test_2*2* + *test_3*2* + *6 passed* + """) + + def test_format_args(self): + def function1(): pass + assert funcargs._format_args(function1) == '()' + + def function2(arg1): pass + assert funcargs._format_args(function2) == "(arg1)" + + def function3(arg1, arg2="qwe"): pass + assert funcargs._format_args(function3) == "(arg1, arg2='qwe')" + + def function4(arg1, *args, **kwargs): pass + assert funcargs._format_args(function4) == "(arg1, *args, **kwargs)" + + +class TestMetafuncFunctional: + def test_attributes(self, testdir): + p = testdir.makepyfile(""" + # assumes that generate/provide runs in the same process + import py, pytest + def pytest_generate_tests(metafunc): + metafunc.addcall(param=metafunc) + + def pytest_funcarg__metafunc(request): + assert request._pyfuncitem._genid == "0" + return request.param + + def test_function(metafunc, pytestconfig): + assert metafunc.config == pytestconfig + assert metafunc.module.__name__ == __name__ + assert metafunc.function == test_function + assert metafunc.cls is None + + class TestClass: + def test_method(self, metafunc, pytestconfig): + assert metafunc.config == pytestconfig + assert metafunc.module.__name__ == __name__ + if py.std.sys.version_info > (3, 0): + unbound = TestClass.test_method + else: + unbound = TestClass.test_method.im_func + # XXX actually have an unbound test function here? + assert metafunc.function == unbound + assert metafunc.cls == TestClass + """) + result = testdir.runpytest(p, "-v") + result.assert_outcomes(passed=2) + + def test_addcall_with_two_funcargs_generators(self, testdir): + testdir.makeconftest(""" + def pytest_generate_tests(metafunc): + assert "arg1" in metafunc.fixturenames + metafunc.addcall(funcargs=dict(arg1=1, arg2=2)) + """) + p = testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.addcall(funcargs=dict(arg1=1, arg2=1)) + + class TestClass: + def test_myfunc(self, arg1, arg2): + assert arg1 == arg2 + """) + result = testdir.runpytest("-v", p) + result.stdout.fnmatch_lines([ + "*test_myfunc*0*PASS*", + "*test_myfunc*1*FAIL*", + "*1 failed, 1 passed*" + ]) + + def test_two_functions(self, testdir): + p = testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.addcall(param=10) + metafunc.addcall(param=20) + + def pytest_funcarg__arg1(request): + return request.param + + def test_func1(arg1): + assert arg1 == 10 + def test_func2(arg1): + assert arg1 in (10, 20) + """) + result = testdir.runpytest("-v", p) + result.stdout.fnmatch_lines([ + "*test_func1*0*PASS*", + "*test_func1*1*FAIL*", + "*test_func2*PASS*", + "*1 failed, 3 passed*" + ]) + + def test_noself_in_method(self, testdir): + p = testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + assert 'xyz' not in metafunc.fixturenames + + class TestHello: + def test_hello(xyz): + pass + """) + result = testdir.runpytest(p) + result.assert_outcomes(passed=1) + + + def test_generate_plugin_and_module(self, testdir): + testdir.makeconftest(""" + def pytest_generate_tests(metafunc): + assert "arg1" in metafunc.fixturenames + metafunc.addcall(id="world", param=(2,100)) + """) + p = testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.addcall(param=(1,1), id="hello") + + def pytest_funcarg__arg1(request): + return request.param[0] + def pytest_funcarg__arg2(request): + return request.param[1] + + class TestClass: + def test_myfunc(self, arg1, arg2): + assert arg1 == arg2 + """) + result = testdir.runpytest("-v", p) + result.stdout.fnmatch_lines([ + "*test_myfunc*hello*PASS*", + "*test_myfunc*world*FAIL*", + "*1 failed, 1 passed*" + ]) + + def test_generate_tests_in_class(self, testdir): + p = testdir.makepyfile(""" + class TestClass: + def pytest_generate_tests(self, metafunc): + metafunc.addcall(funcargs={'hello': 'world'}, id="hello") + + def test_myfunc(self, hello): + assert hello == "world" + """) + result = testdir.runpytest("-v", p) + result.stdout.fnmatch_lines([ + "*test_myfunc*hello*PASS*", + "*1 passed*" + ]) + + def test_two_functions_not_same_instance(self, testdir): + p = testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.addcall({'arg1': 10}) + metafunc.addcall({'arg1': 20}) + + class TestClass: + def test_func(self, arg1): + assert not hasattr(self, 'x') + self.x = 1 + """) + result = testdir.runpytest("-v", p) + result.stdout.fnmatch_lines([ + "*test_func*0*PASS*", + "*test_func*1*PASS*", + "*2 pass*", + ]) + + def test_issue28_setup_method_in_generate_tests(self, testdir): + p = testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.addcall({'arg1': 1}) + + class TestClass: + def test_method(self, arg1): + assert arg1 == self.val + def setup_method(self, func): + self.val = 1 + """) + result = testdir.runpytest(p) + result.assert_outcomes(passed=1) + + def test_parametrize_functional2(self, testdir): + testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.parametrize("arg1", [1,2]) + metafunc.parametrize("arg2", [4,5]) + def test_hello(arg1, arg2): + assert 0, (arg1, arg2) + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*(1, 4)*", + "*(1, 5)*", + "*(2, 4)*", + "*(2, 5)*", + "*4 failed*", + ]) + + def test_parametrize_and_inner_getfuncargvalue(self, testdir): + p = testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.parametrize("arg1", [1], indirect=True) + metafunc.parametrize("arg2", [10], indirect=True) + + def pytest_funcarg__arg1(request): + x = request.getfuncargvalue("arg2") + return x + request.param + + def pytest_funcarg__arg2(request): + return request.param + + def test_func1(arg1, arg2): + assert arg1 == 11 + """) + result = testdir.runpytest("-v", p) + result.stdout.fnmatch_lines([ + "*test_func1*1*PASS*", + "*1 passed*" + ]) + + def test_parametrize_on_setup_arg(self, testdir): + p = testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + assert "arg1" in metafunc.fixturenames + metafunc.parametrize("arg1", [1], indirect=True) + + def pytest_funcarg__arg1(request): + return request.param + + def pytest_funcarg__arg2(request, arg1): + return 10 * arg1 + + def test_func(arg2): + assert arg2 == 10 + """) + result = testdir.runpytest("-v", p) + result.stdout.fnmatch_lines([ + "*test_func*1*PASS*", + "*1 passed*" + ]) + + def test_parametrize_with_ids(self, testdir): + testdir.makepyfile(""" + import pytest + def pytest_generate_tests(metafunc): + metafunc.parametrize(("a", "b"), [(1,1), (1,2)], + ids=["basic", "advanced"]) + + def test_function(a, b): + assert a == b + """) + result = testdir.runpytest("-v") + assert result.ret == 1 + result.stdout.fnmatch_lines_random([ + "*test_function*basic*PASSED", + "*test_function*advanced*FAILED", + ]) + + def test_parametrize_without_ids(self, testdir): + testdir.makepyfile(""" + import pytest + def pytest_generate_tests(metafunc): + metafunc.parametrize(("a", "b"), + [(1,object()), (1.3,object())]) + + def test_function(a, b): + assert 1 + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines(""" + *test_function*1-b0* + *test_function*1.3-b1* + """) + + @pytest.mark.parametrize(("scope", "length"), + [("module", 2), ("function", 4)]) + def test_parametrize_scope_overrides(self, testdir, scope, length): + testdir.makepyfile(""" + import pytest + l = [] + def pytest_generate_tests(metafunc): + if "arg" in metafunc.funcargnames: + metafunc.parametrize("arg", [1,2], indirect=True, + scope=%r) + def pytest_funcarg__arg(request): + l.append(request.param) + return request.param + def test_hello(arg): + assert arg in (1,2) + def test_world(arg): + assert arg in (1,2) + def test_checklength(): + assert len(l) == %d + """ % (scope, length)) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=5) + + def test_parametrize_issue323(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture(scope='module', params=range(966)) + def foo(request): + return request.param + + def test_it(foo): + pass + def test_it2(foo): + pass + """) + reprec = testdir.inline_run("--collect-only") + assert not reprec.getcalls("pytest_internalerror") + + def test_usefixtures_seen_in_generate_tests(self, testdir): + testdir.makepyfile(""" + import pytest + def pytest_generate_tests(metafunc): + assert "abc" in metafunc.fixturenames + metafunc.parametrize("abc", [1]) + + @pytest.mark.usefixtures("abc") + def test_function(): + pass + """) + reprec = testdir.runpytest() + reprec.assert_outcomes(passed=1) + + def test_generate_tests_only_done_in_subdir(self, testdir): + sub1 = testdir.mkpydir("sub1") + sub2 = testdir.mkpydir("sub2") + sub1.join("conftest.py").write(_pytest._code.Source(""" + def pytest_generate_tests(metafunc): + assert metafunc.function.__name__ == "test_1" + """)) + sub2.join("conftest.py").write(_pytest._code.Source(""" + def pytest_generate_tests(metafunc): + assert metafunc.function.__name__ == "test_2" + """)) + sub1.join("test_in_sub1.py").write("def test_1(): pass") + sub2.join("test_in_sub2.py").write("def test_2(): pass") + result = testdir.runpytest("-v", "-s", sub1, sub2, sub1) + result.assert_outcomes(passed=3) + + def test_generate_same_function_names_issue403(self, testdir): + testdir.makepyfile(""" + import pytest + + def make_tests(): + @pytest.mark.parametrize("x", range(2)) + def test_foo(x): + pass + return test_foo + + test_x = make_tests() + test_y = make_tests() + """) + reprec = testdir.runpytest() + reprec.assert_outcomes(passed=4) + + @pytest.mark.issue463 + @pytest.mark.parametrize('attr', ['parametrise', 'parameterize', + 'parameterise']) + def test_parametrize_misspelling(self, testdir, attr): + testdir.makepyfile(""" + import pytest + + @pytest.mark.{0}("x", range(2)) + def test_foo(x): + pass + """.format(attr)) + reprec = testdir.inline_run('--collectonly') + failures = reprec.getfailures() + assert len(failures) == 1 + expectederror = "MarkerError: test_foo has '{0}', spelling should be 'parametrize'".format(attr) + assert expectederror in failures[0].longrepr.reprcrash.message + + +class TestMarkersWithParametrization: + pytestmark = pytest.mark.issue308 + def test_simple_mark(self, testdir): + s = """ + import pytest + + @pytest.mark.foo + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + pytest.mark.bar((1, 3)), + (2, 3), + ]) + def test_increment(n, expected): + assert n + 1 == expected + """ + items = testdir.getitems(s) + assert len(items) == 3 + for item in items: + assert 'foo' in item.keywords + assert 'bar' not in items[0].keywords + assert 'bar' in items[1].keywords + assert 'bar' not in items[2].keywords + + def test_select_based_on_mark(self, testdir): + s = """ + import pytest + + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + pytest.mark.foo((2, 3)), + (3, 4), + ]) + def test_increment(n, expected): + assert n + 1 == expected + """ + testdir.makepyfile(s) + rec = testdir.inline_run("-m", 'foo') + passed, skipped, fail = rec.listoutcomes() + assert len(passed) == 1 + assert len(skipped) == 0 + assert len(fail) == 0 + + @pytest.mark.xfail(reason="is this important to support??") + def test_nested_marks(self, testdir): + s = """ + import pytest + mastermark = pytest.mark.foo(pytest.mark.bar) + + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + mastermark((1, 3)), + (2, 3), + ]) + def test_increment(n, expected): + assert n + 1 == expected + """ + items = testdir.getitems(s) + assert len(items) == 3 + for mark in ['foo', 'bar']: + assert mark not in items[0].keywords + assert mark in items[1].keywords + assert mark not in items[2].keywords + + def test_simple_xfail(self, testdir): + s = """ + import pytest + + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + pytest.mark.xfail((1, 3)), + (2, 3), + ]) + def test_increment(n, expected): + assert n + 1 == expected + """ + testdir.makepyfile(s) + reprec = testdir.inline_run() + # xfail is skip?? + reprec.assertoutcome(passed=2, skipped=1) + + def test_simple_xfail_single_argname(self, testdir): + s = """ + import pytest + + @pytest.mark.parametrize("n", [ + 2, + pytest.mark.xfail(3), + 4, + ]) + def test_isEven(n): + assert n % 2 == 0 + """ + testdir.makepyfile(s) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2, skipped=1) + + def test_xfail_with_arg(self, testdir): + s = """ + import pytest + + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + pytest.mark.xfail("True")((1, 3)), + (2, 3), + ]) + def test_increment(n, expected): + assert n + 1 == expected + """ + testdir.makepyfile(s) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2, skipped=1) + + def test_xfail_with_kwarg(self, testdir): + s = """ + import pytest + + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + pytest.mark.xfail(reason="some bug")((1, 3)), + (2, 3), + ]) + def test_increment(n, expected): + assert n + 1 == expected + """ + testdir.makepyfile(s) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2, skipped=1) + + def test_xfail_with_arg_and_kwarg(self, testdir): + s = """ + import pytest + + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + pytest.mark.xfail("True", reason="some bug")((1, 3)), + (2, 3), + ]) + def test_increment(n, expected): + assert n + 1 == expected + """ + testdir.makepyfile(s) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2, skipped=1) + + def test_xfail_passing_is_xpass(self, testdir): + s = """ + import pytest + + @pytest.mark.parametrize(("n", "expected"), [ + (1, 2), + pytest.mark.xfail("sys.version > 0", reason="some bug")((2, 3)), + (3, 4), + ]) + def test_increment(n, expected): + assert n + 1 == expected + """ + testdir.makepyfile(s) + reprec = testdir.inline_run() + # xpass is fail, obviously :) + reprec.assertoutcome(passed=2, failed=1) + + def test_parametrize_called_in_generate_tests(self, testdir): + s = """ + import pytest + + + def pytest_generate_tests(metafunc): + passingTestData = [(1, 2), + (2, 3)] + failingTestData = [(1, 3), + (2, 2)] + + testData = passingTestData + [pytest.mark.xfail(d) + for d in failingTestData] + metafunc.parametrize(("n", "expected"), testData) + + + def test_increment(n, expected): + assert n + 1 == expected + """ + testdir.makepyfile(s) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2, skipped=2) + + + @pytest.mark.issue290 + def test_parametrize_ID_generation_string_int_works(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture + def myfixture(): + return 'example' + @pytest.mark.parametrize( + 'limit', (0, '0')) + def test_limit(limit, myfixture): + return + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=2) diff --git a/testing/web-platform/tests/tools/pytest/testing/python/raises.py b/testing/web-platform/tests/tools/pytest/testing/python/raises.py new file mode 100644 index 000000000..0ea7f9bee --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/python/raises.py @@ -0,0 +1,78 @@ +import pytest + +class TestRaises: + def test_raises(self): + source = "int('qwe')" + excinfo = pytest.raises(ValueError, source) + code = excinfo.traceback[-1].frame.code + s = str(code.fullsource) + assert s == source + + def test_raises_exec(self): + pytest.raises(ValueError, "a,x = []") + + def test_raises_syntax_error(self): + pytest.raises(SyntaxError, "qwe qwe qwe") + + def test_raises_function(self): + pytest.raises(ValueError, int, 'hello') + + def test_raises_callable_no_exception(self): + class A: + def __call__(self): + pass + try: + pytest.raises(ValueError, A()) + except pytest.raises.Exception: + pass + + def test_raises_flip_builtin_AssertionError(self): + # we replace AssertionError on python level + # however c code might still raise the builtin one + from _pytest.assertion.util import BuiltinAssertionError # noqa + pytest.raises(AssertionError,""" + raise BuiltinAssertionError + """) + + def test_raises_as_contextmanager(self, testdir): + testdir.makepyfile(""" + from __future__ import with_statement + import py, pytest + import _pytest._code + + def test_simple(): + with pytest.raises(ZeroDivisionError) as excinfo: + assert isinstance(excinfo, _pytest._code.ExceptionInfo) + 1/0 + print (excinfo) + assert excinfo.type == ZeroDivisionError + assert isinstance(excinfo.value, ZeroDivisionError) + + def test_noraise(): + with pytest.raises(pytest.raises.Exception): + with pytest.raises(ValueError): + int() + + def test_raise_wrong_exception_passes_by(): + with pytest.raises(ZeroDivisionError): + with pytest.raises(ValueError): + 1/0 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + '*3 passed*', + ]) + + def test_noclass(self): + with pytest.raises(TypeError): + pytest.raises('wrong', lambda: None) + + def test_tuple(self): + with pytest.raises((KeyError, ValueError)): + raise KeyError('oops') + + def test_no_raise_message(self): + try: + pytest.raises(ValueError, int, '0') + except pytest.raises.Exception as e: + assert e.msg == "DID NOT RAISE {0}".format(repr(ValueError)) diff --git a/testing/web-platform/tests/tools/pytest/testing/test_argcomplete.py b/testing/web-platform/tests/tools/pytest/testing/test_argcomplete.py new file mode 100644 index 000000000..ace7d8ceb --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_argcomplete.py @@ -0,0 +1,90 @@ +from __future__ import with_statement +import py, pytest + +# test for _argcomplete but not specific for any application + +def equal_with_bash(prefix, ffc, fc, out=None): + res = ffc(prefix) + res_bash = set(fc(prefix)) + retval = set(res) == res_bash + if out: + out.write('equal_with_bash %s %s\n' % (retval, res)) + if not retval: + out.write(' python - bash: %s\n' % (set(res) - res_bash)) + out.write(' bash - python: %s\n' % (res_bash - set(res))) + return retval + +# copied from argcomplete.completers as import from there +# also pulls in argcomplete.__init__ which opens filedescriptor 9 +# this gives an IOError at the end of testrun +def _wrapcall(*args, **kargs): + try: + if py.std.sys.version_info > (2,7): + return py.std.subprocess.check_output(*args,**kargs).decode().splitlines() + if 'stdout' in kargs: + raise ValueError('stdout argument not allowed, it will be overridden.') + process = py.std.subprocess.Popen( + stdout=py.std.subprocess.PIPE, *args, **kargs) + output, unused_err = process.communicate() + retcode = process.poll() + if retcode: + cmd = kargs.get("args") + if cmd is None: + cmd = args[0] + raise py.std.subprocess.CalledProcessError(retcode, cmd) + return output.decode().splitlines() + except py.std.subprocess.CalledProcessError: + return [] + +class FilesCompleter(object): + 'File completer class, optionally takes a list of allowed extensions' + def __init__(self,allowednames=(),directories=True): + # Fix if someone passes in a string instead of a list + if type(allowednames) is str: + allowednames = [allowednames] + + self.allowednames = [x.lstrip('*').lstrip('.') for x in allowednames] + self.directories = directories + + def __call__(self, prefix, **kwargs): + completion = [] + if self.allowednames: + if self.directories: + files = _wrapcall(['bash','-c', + "compgen -A directory -- '{p}'".format(p=prefix)]) + completion += [ f + '/' for f in files] + for x in self.allowednames: + completion += _wrapcall(['bash', '-c', + "compgen -A file -X '!*.{0}' -- '{p}'".format(x,p=prefix)]) + else: + completion += _wrapcall(['bash', '-c', + "compgen -A file -- '{p}'".format(p=prefix)]) + + anticomp = _wrapcall(['bash', '-c', + "compgen -A directory -- '{p}'".format(p=prefix)]) + + completion = list( set(completion) - set(anticomp)) + + if self.directories: + completion += [f + '/' for f in anticomp] + return completion + +class TestArgComplete: + @pytest.mark.skipif("sys.platform in ('win32', 'darwin')") + def test_compare_with_compgen(self): + from _pytest._argcomplete import FastFilesCompleter + ffc = FastFilesCompleter() + fc = FilesCompleter() + for x in '/ /d /data qqq'.split(): + assert equal_with_bash(x, ffc, fc, out=py.std.sys.stdout) + + @pytest.mark.skipif("sys.platform in ('win32', 'darwin')") + def test_remove_dir_prefix(self): + """this is not compatible with compgen but it is with bash itself: + ls /usr/<TAB> + """ + from _pytest._argcomplete import FastFilesCompleter + ffc = FastFilesCompleter() + fc = FilesCompleter() + for x in '/usr/'.split(): + assert not equal_with_bash(x, ffc, fc, out=py.std.sys.stdout) diff --git a/testing/web-platform/tests/tools/pytest/testing/test_assertinterpret.py b/testing/web-platform/tests/tools/pytest/testing/test_assertinterpret.py new file mode 100644 index 000000000..67a352ce7 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_assertinterpret.py @@ -0,0 +1,274 @@ +"PYTEST_DONT_REWRITE" +import py +import pytest +from _pytest.assertion import util + + +def exvalue(): + return py.std.sys.exc_info()[1] + +def f(): + return 2 + +def test_not_being_rewritten(): + assert "@py_builtins" not in globals() + +def test_assert(): + try: + assert f() == 3 + except AssertionError: + e = exvalue() + s = str(e) + assert s.startswith('assert 2 == 3\n') + +def test_assert_with_explicit_message(): + try: + assert f() == 3, "hello" + except AssertionError: + e = exvalue() + assert e.msg == 'hello' + +def test_assert_within_finally(): + excinfo = pytest.raises(ZeroDivisionError, """ + try: + 1/0 + finally: + i = 42 + """) + s = excinfo.exconly() + assert py.std.re.search("division.+by zero", s) is not None + + #def g(): + # A.f() + #excinfo = getexcinfo(TypeError, g) + #msg = getmsg(excinfo) + #assert msg.find("must be called with A") != -1 + + +def test_assert_multiline_1(): + try: + assert (f() == + 3) + except AssertionError: + e = exvalue() + s = str(e) + assert s.startswith('assert 2 == 3\n') + +def test_assert_multiline_2(): + try: + assert (f() == (4, + 3)[-1]) + except AssertionError: + e = exvalue() + s = str(e) + assert s.startswith('assert 2 ==') + +def test_in(): + try: + assert "hi" in [1, 2] + except AssertionError: + e = exvalue() + s = str(e) + assert s.startswith("assert 'hi' in") + +def test_is(): + try: + assert 1 is 2 + except AssertionError: + e = exvalue() + s = str(e) + assert s.startswith("assert 1 is 2") + + +def test_attrib(): + class Foo(object): + b = 1 + i = Foo() + try: + assert i.b == 2 + except AssertionError: + e = exvalue() + s = str(e) + assert s.startswith("assert 1 == 2") + +def test_attrib_inst(): + class Foo(object): + b = 1 + try: + assert Foo().b == 2 + except AssertionError: + e = exvalue() + s = str(e) + assert s.startswith("assert 1 == 2") + +def test_len(): + l = list(range(42)) + try: + assert len(l) == 100 + except AssertionError: + e = exvalue() + s = str(e) + assert s.startswith("assert 42 == 100") + assert "where 42 = len([" in s + +def test_assert_non_string_message(): + class A: + def __str__(self): + return "hello" + try: + assert 0 == 1, A() + except AssertionError: + e = exvalue() + assert e.msg == "hello" + +def test_assert_keyword_arg(): + def f(x=3): + return False + try: + assert f(x=5) + except AssertionError: + e = exvalue() + assert "x=5" in e.msg + +def test_private_class_variable(): + class X: + def __init__(self): + self.__v = 41 + def m(self): + assert self.__v == 42 + try: + X().m() + except AssertionError: + e = exvalue() + assert "== 42" in e.msg + +# These tests should both fail, but should fail nicely... +class WeirdRepr: + def __repr__(self): + return '<WeirdRepr\nsecond line>' + +def bug_test_assert_repr(): + v = WeirdRepr() + try: + assert v == 1 + except AssertionError: + e = exvalue() + assert e.msg.find('WeirdRepr') != -1 + assert e.msg.find('second line') != -1 + assert 0 + +def test_assert_non_string(): + try: + assert 0, ['list'] + except AssertionError: + e = exvalue() + assert e.msg.find("list") != -1 + +def test_assert_implicit_multiline(): + try: + x = [1,2,3] + assert x != [1, + 2, 3] + except AssertionError: + e = exvalue() + assert e.msg.find('assert [1, 2, 3] !=') != -1 + + +def test_assert_with_brokenrepr_arg(): + class BrokenRepr: + def __repr__(self): 0 / 0 + e = AssertionError(BrokenRepr()) + if e.msg.find("broken __repr__") == -1: + pytest.fail("broken __repr__ not handle correctly") + +def test_multiple_statements_per_line(): + try: + a = 1; assert a == 2 + except AssertionError: + e = exvalue() + assert "assert 1 == 2" in e.msg + +def test_power(): + try: + assert 2**3 == 7 + except AssertionError: + e = exvalue() + assert "assert (2 ** 3) == 7" in e.msg + + +def test_assert_customizable_reprcompare(monkeypatch): + monkeypatch.setattr(util, '_reprcompare', lambda *args: 'hello') + try: + assert 3 == 4 + except AssertionError: + e = exvalue() + s = str(e) + assert "hello" in s + +def test_assert_long_source_1(): + try: + assert len == [ + (None, ['somet text', 'more text']), + ] + except AssertionError: + e = exvalue() + s = str(e) + assert 're-run' not in s + assert 'somet text' in s + +def test_assert_long_source_2(): + try: + assert(len == [ + (None, ['somet text', 'more text']), + ]) + except AssertionError: + e = exvalue() + s = str(e) + assert 're-run' not in s + assert 'somet text' in s + +def test_assert_raise_alias(testdir): + testdir.makepyfile(""" + "PYTEST_DONT_REWRITE" + import sys + EX = AssertionError + def test_hello(): + raise EX("hello" + "multi" + "line") + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*def test_hello*", + "*raise EX*", + "*1 failed*", + ]) + + +def test_assert_raise_subclass(): + class SomeEx(AssertionError): + def __init__(self, *args): + super(SomeEx, self).__init__() + try: + raise SomeEx("hello") + except AssertionError: + s = str(exvalue()) + assert 're-run' not in s + assert 'could not determine' in s + +def test_assert_raises_in_nonzero_of_object_pytest_issue10(): + class A(object): + def __nonzero__(self): + raise ValueError(42) + def __lt__(self, other): + return A() + def __repr__(self): + return "<MY42 object>" + def myany(x): + return True + try: + assert not(myany(A() < 0)) + except AssertionError: + e = exvalue() + s = str(e) + assert "<MY42 object> < 0" in s diff --git a/testing/web-platform/tests/tools/pytest/testing/test_assertion.py b/testing/web-platform/tests/tools/pytest/testing/test_assertion.py new file mode 100644 index 000000000..347278e19 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_assertion.py @@ -0,0 +1,628 @@ +# -*- coding: utf-8 -*- +import sys +import textwrap + +import _pytest.assertion as plugin +import _pytest._code +import py +import pytest +from _pytest.assertion import reinterpret +from _pytest.assertion import util + +PY3 = sys.version_info >= (3, 0) + + +@pytest.fixture +def mock_config(): + class Config(object): + verbose = False + def getoption(self, name): + if name == 'verbose': + return self.verbose + raise KeyError('Not mocked out: %s' % name) + return Config() + + +def interpret(expr): + return reinterpret.reinterpret(expr, _pytest._code.Frame(sys._getframe(1))) + +class TestBinReprIntegration: + + def test_pytest_assertrepr_compare_called(self, testdir): + testdir.makeconftest(""" + l = [] + def pytest_assertrepr_compare(op, left, right): + l.append((op, left, right)) + def pytest_funcarg__l(request): + return l + """) + testdir.makepyfile(""" + def test_hello(): + assert 0 == 1 + def test_check(l): + assert l == [("==", 0, 1)] + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines([ + "*test_hello*FAIL*", + "*test_check*PASS*", + ]) + +def callequal(left, right, verbose=False): + config = mock_config() + config.verbose = verbose + return plugin.pytest_assertrepr_compare(config, '==', left, right) + + +class TestAssert_reprcompare: + def test_different_types(self): + assert callequal([0, 1], 'foo') is None + + def test_summary(self): + summary = callequal([0, 1], [0, 2])[0] + assert len(summary) < 65 + + def test_text_diff(self): + diff = callequal('spam', 'eggs')[1:] + assert '- spam' in diff + assert '+ eggs' in diff + + def test_text_skipping(self): + lines = callequal('a'*50 + 'spam', 'a'*50 + 'eggs') + assert 'Skipping' in lines[1] + for line in lines: + assert 'a'*50 not in line + + def test_text_skipping_verbose(self): + lines = callequal('a'*50 + 'spam', 'a'*50 + 'eggs', verbose=True) + assert '- ' + 'a'*50 + 'spam' in lines + assert '+ ' + 'a'*50 + 'eggs' in lines + + def test_multiline_text_diff(self): + left = 'foo\nspam\nbar' + right = 'foo\neggs\nbar' + diff = callequal(left, right) + assert '- spam' in diff + assert '+ eggs' in diff + + def test_list(self): + expl = callequal([0, 1], [0, 2]) + assert len(expl) > 1 + + @pytest.mark.parametrize( + ['left', 'right', 'expected'], [ + ([0, 1], [0, 2], """ + Full diff: + - [0, 1] + ? ^ + + [0, 2] + ? ^ + """), + ({0: 1}, {0: 2}, """ + Full diff: + - {0: 1} + ? ^ + + {0: 2} + ? ^ + """), + (set([0, 1]), set([0, 2]), """ + Full diff: + - set([0, 1]) + ? ^ + + set([0, 2]) + ? ^ + """ if not PY3 else """ + Full diff: + - {0, 1} + ? ^ + + {0, 2} + ? ^ + """) + ] + ) + def test_iterable_full_diff(self, left, right, expected): + """Test the full diff assertion failure explanation. + + When verbose is False, then just a -v notice to get the diff is rendered, + when verbose is True, then ndiff of the pprint is returned. + """ + expl = callequal(left, right, verbose=False) + assert expl[-1] == 'Use -v to get the full diff' + expl = '\n'.join(callequal(left, right, verbose=True)) + assert expl.endswith(textwrap.dedent(expected).strip()) + + def test_list_different_lenghts(self): + expl = callequal([0, 1], [0, 1, 2]) + assert len(expl) > 1 + expl = callequal([0, 1, 2], [0, 1]) + assert len(expl) > 1 + + def test_dict(self): + expl = callequal({'a': 0}, {'a': 1}) + assert len(expl) > 1 + + def test_dict_omitting(self): + lines = callequal({'a': 0, 'b': 1}, {'a': 1, 'b': 1}) + assert lines[1].startswith('Omitting 1 identical item') + assert 'Common items' not in lines + for line in lines[1:]: + assert 'b' not in line + + def test_dict_omitting_verbose(self): + lines = callequal({'a': 0, 'b': 1}, {'a': 1, 'b': 1}, verbose=True) + assert lines[1].startswith('Common items:') + assert 'Omitting' not in lines[1] + assert lines[2] == "{'b': 1}" + + def test_set(self): + expl = callequal(set([0, 1]), set([0, 2])) + assert len(expl) > 1 + + def test_frozenzet(self): + expl = callequal(frozenset([0, 1]), set([0, 2])) + assert len(expl) > 1 + + def test_Sequence(self): + col = py.builtin._tryimport( + "collections.abc", + "collections", + "sys") + if not hasattr(col, "MutableSequence"): + pytest.skip("cannot import MutableSequence") + MutableSequence = col.MutableSequence + + class TestSequence(MutableSequence): # works with a Sequence subclass + def __init__(self, iterable): + self.elements = list(iterable) + + def __getitem__(self, item): + return self.elements[item] + + def __len__(self): + return len(self.elements) + + def __setitem__(self, item, value): + pass + + def __delitem__(self, item): + pass + + def insert(self, item, index): + pass + + expl = callequal(TestSequence([0, 1]), list([0, 2])) + assert len(expl) > 1 + + def test_list_tuples(self): + expl = callequal([], [(1,2)]) + assert len(expl) > 1 + expl = callequal([(1,2)], []) + assert len(expl) > 1 + + def test_list_bad_repr(self): + class A: + def __repr__(self): + raise ValueError(42) + expl = callequal([], [A()]) + assert 'ValueError' in "".join(expl) + expl = callequal({}, {'1': A()}) + assert 'faulty' in "".join(expl) + + def test_one_repr_empty(self): + """ + the faulty empty string repr did trigger + a unbound local error in _diff_text + """ + class A(str): + def __repr__(self): + return '' + expl = callequal(A(), '') + assert not expl + + def test_repr_no_exc(self): + expl = ' '.join(callequal('foo', 'bar')) + assert 'raised in repr()' not in expl + + def test_unicode(self): + left = py.builtin._totext('£€', 'utf-8') + right = py.builtin._totext('£', 'utf-8') + expl = callequal(left, right) + assert expl[0] == py.builtin._totext("'£€' == '£'", 'utf-8') + assert expl[1] == py.builtin._totext('- £€', 'utf-8') + assert expl[2] == py.builtin._totext('+ £', 'utf-8') + + def test_nonascii_text(self): + """ + :issue: 877 + non ascii python2 str caused a UnicodeDecodeError + """ + class A(str): + def __repr__(self): + return '\xff' + expl = callequal(A(), '1') + assert expl + + def test_format_nonascii_explanation(self): + assert util.format_explanation('λ') + + def test_mojibake(self): + # issue 429 + left = 'e' + right = '\xc3\xa9' + if not isinstance(left, py.builtin.bytes): + left = py.builtin.bytes(left, 'utf-8') + right = py.builtin.bytes(right, 'utf-8') + expl = callequal(left, right) + for line in expl: + assert isinstance(line, py.builtin.text) + msg = py.builtin._totext('\n').join(expl) + assert msg + + +class TestFormatExplanation: + + def test_special_chars_full(self, testdir): + # Issue 453, for the bug this would raise IndexError + testdir.makepyfile(""" + def test_foo(): + assert '\\n}' == '' + """) + result = testdir.runpytest() + assert result.ret == 1 + result.stdout.fnmatch_lines([ + "*AssertionError*", + ]) + + def test_fmt_simple(self): + expl = 'assert foo' + assert util.format_explanation(expl) == 'assert foo' + + def test_fmt_where(self): + expl = '\n'.join(['assert 1', + '{1 = foo', + '} == 2']) + res = '\n'.join(['assert 1 == 2', + ' + where 1 = foo']) + assert util.format_explanation(expl) == res + + def test_fmt_and(self): + expl = '\n'.join(['assert 1', + '{1 = foo', + '} == 2', + '{2 = bar', + '}']) + res = '\n'.join(['assert 1 == 2', + ' + where 1 = foo', + ' + and 2 = bar']) + assert util.format_explanation(expl) == res + + def test_fmt_where_nested(self): + expl = '\n'.join(['assert 1', + '{1 = foo', + '{foo = bar', + '}', + '} == 2']) + res = '\n'.join(['assert 1 == 2', + ' + where 1 = foo', + ' + where foo = bar']) + assert util.format_explanation(expl) == res + + def test_fmt_newline(self): + expl = '\n'.join(['assert "foo" == "bar"', + '~- foo', + '~+ bar']) + res = '\n'.join(['assert "foo" == "bar"', + ' - foo', + ' + bar']) + assert util.format_explanation(expl) == res + + def test_fmt_newline_escaped(self): + expl = '\n'.join(['assert foo == bar', + 'baz']) + res = 'assert foo == bar\\nbaz' + assert util.format_explanation(expl) == res + + def test_fmt_newline_before_where(self): + expl = '\n'.join(['the assertion message here', + '>assert 1', + '{1 = foo', + '} == 2', + '{2 = bar', + '}']) + res = '\n'.join(['the assertion message here', + 'assert 1 == 2', + ' + where 1 = foo', + ' + and 2 = bar']) + assert util.format_explanation(expl) == res + + def test_fmt_multi_newline_before_where(self): + expl = '\n'.join(['the assertion', + '~message here', + '>assert 1', + '{1 = foo', + '} == 2', + '{2 = bar', + '}']) + res = '\n'.join(['the assertion', + ' message here', + 'assert 1 == 2', + ' + where 1 = foo', + ' + and 2 = bar']) + assert util.format_explanation(expl) == res + + +def test_python25_compile_issue257(testdir): + testdir.makepyfile(""" + def test_rewritten(): + assert 1 == 2 + # some comment + """) + result = testdir.runpytest() + assert result.ret == 1 + result.stdout.fnmatch_lines(""" + *E*assert 1 == 2* + *1 failed* + """) + +def test_rewritten(testdir): + testdir.makepyfile(""" + def test_rewritten(): + assert "@py_builtins" in globals() + """) + assert testdir.runpytest().ret == 0 + +def test_reprcompare_notin(mock_config): + detail = plugin.pytest_assertrepr_compare( + mock_config, 'not in', 'foo', 'aaafoobbb')[1:] + assert detail == ["'foo' is contained here:", ' aaafoobbb', '? +++'] + +def test_pytest_assertrepr_compare_integration(testdir): + testdir.makepyfile(""" + def test_hello(): + x = set(range(100)) + y = x.copy() + y.remove(50) + assert x == y + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*def test_hello():*", + "*assert x == y*", + "*E*Extra items*left*", + "*E*50*", + ]) + +def test_sequence_comparison_uses_repr(testdir): + testdir.makepyfile(""" + def test_hello(): + x = set("hello x") + y = set("hello y") + assert x == y + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*def test_hello():*", + "*assert x == y*", + "*E*Extra items*left*", + "*E*'x'*", + "*E*Extra items*right*", + "*E*'y'*", + ]) + + +def test_assert_compare_truncate_longmessage(monkeypatch, testdir): + testdir.makepyfile(r""" + def test_long(): + a = list(range(200)) + b = a[::2] + a = '\n'.join(map(str, a)) + b = '\n'.join(map(str, b)) + assert a == b + """) + monkeypatch.delenv('CI', raising=False) + + result = testdir.runpytest() + # without -vv, truncate the message showing a few diff lines only + result.stdout.fnmatch_lines([ + "*- 1", + "*- 3", + "*- 5", + "*- 7", + "*truncated (191 more lines)*use*-vv*", + ]) + + + result = testdir.runpytest('-vv') + result.stdout.fnmatch_lines([ + "*- 197", + ]) + + monkeypatch.setenv('CI', '1') + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*- 197", + ]) + + +def test_assertrepr_loaded_per_dir(testdir): + testdir.makepyfile(test_base=['def test_base(): assert 1 == 2']) + a = testdir.mkdir('a') + a_test = a.join('test_a.py') + a_test.write('def test_a(): assert 1 == 2') + a_conftest = a.join('conftest.py') + a_conftest.write('def pytest_assertrepr_compare(): return ["summary a"]') + b = testdir.mkdir('b') + b_test = b.join('test_b.py') + b_test.write('def test_b(): assert 1 == 2') + b_conftest = b.join('conftest.py') + b_conftest.write('def pytest_assertrepr_compare(): return ["summary b"]') + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + '*def test_base():*', + '*E*assert 1 == 2*', + '*def test_a():*', + '*E*assert summary a*', + '*def test_b():*', + '*E*assert summary b*']) + + +def test_assertion_options(testdir): + testdir.makepyfile(""" + def test_hello(): + x = 3 + assert x == 4 + """) + result = testdir.runpytest() + assert "3 == 4" in result.stdout.str() + off_options = (("--no-assert",), + ("--nomagic",), + ("--no-assert", "--nomagic"), + ("--assert=plain",), + ("--assert=plain", "--no-assert"), + ("--assert=plain", "--nomagic"), + ("--assert=plain", "--no-assert", "--nomagic")) + for opt in off_options: + result = testdir.runpytest_subprocess(*opt) + assert "3 == 4" not in result.stdout.str() + +def test_old_assert_mode(testdir): + testdir.makepyfile(""" + def test_in_old_mode(): + assert "@py_builtins" not in globals() + """) + result = testdir.runpytest_subprocess("--assert=reinterp") + assert result.ret == 0 + +def test_triple_quoted_string_issue113(testdir): + testdir.makepyfile(""" + def test_hello(): + assert "" == ''' + '''""") + result = testdir.runpytest("--fulltrace") + result.stdout.fnmatch_lines([ + "*1 failed*", + ]) + assert 'SyntaxError' not in result.stdout.str() + +def test_traceback_failure(testdir): + p1 = testdir.makepyfile(""" + def g(): + return 2 + def f(x): + assert x == g() + def test_onefails(): + f(3) + """) + result = testdir.runpytest(p1, "--tb=long") + result.stdout.fnmatch_lines([ + "*test_traceback_failure.py F", + "====* FAILURES *====", + "____*____", + "", + " def test_onefails():", + "> f(3)", + "", + "*test_*.py:6: ", + "_ _ _ *", + #"", + " def f(x):", + "> assert x == g()", + "E assert 3 == 2", + "E + where 2 = g()", + "", + "*test_traceback_failure.py:4: AssertionError" + ]) + + result = testdir.runpytest(p1) # "auto" + result.stdout.fnmatch_lines([ + "*test_traceback_failure.py F", + "====* FAILURES *====", + "____*____", + "", + " def test_onefails():", + "> f(3)", + "", + "*test_*.py:6: ", + "", + " def f(x):", + "> assert x == g()", + "E assert 3 == 2", + "E + where 2 = g()", + "", + "*test_traceback_failure.py:4: AssertionError" + ]) + +@pytest.mark.skipif("'__pypy__' in sys.builtin_module_names or sys.platform.startswith('java')" ) +def test_warn_missing(testdir): + testdir.makepyfile("") + result = testdir.run(sys.executable, "-OO", "-m", "pytest", "-h") + result.stderr.fnmatch_lines([ + "*WARNING*assert statements are not executed*", + ]) + result = testdir.run(sys.executable, "-OO", "-m", "pytest", "--no-assert") + result.stderr.fnmatch_lines([ + "*WARNING*assert statements are not executed*", + ]) + +def test_recursion_source_decode(testdir): + testdir.makepyfile(""" + def test_something(): + pass + """) + testdir.makeini(""" + [pytest] + python_files = *.py + """) + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines(""" + <Module*> + """) + +def test_AssertionError_message(testdir): + testdir.makepyfile(""" + def test_hello(): + x,y = 1,2 + assert 0, (x,y) + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(""" + *def test_hello* + *assert 0, (x,y)* + *AssertionError: (1, 2)* + """) + +@pytest.mark.skipif(PY3, reason='This bug does not exist on PY3') +def test_set_with_unsortable_elements(): + # issue #718 + class UnsortableKey(object): + def __init__(self, name): + self.name = name + + def __lt__(self, other): + raise RuntimeError() + + def __repr__(self): + return 'repr({0})'.format(self.name) + + def __eq__(self, other): + return self.name == other.name + + def __hash__(self): + return hash(self.name) + + left_set = set(UnsortableKey(str(i)) for i in range(1, 3)) + right_set = set(UnsortableKey(str(i)) for i in range(2, 4)) + expl = callequal(left_set, right_set, verbose=True) + # skip first line because it contains the "construction" of the set, which does not have a guaranteed order + expl = expl[1:] + dedent = textwrap.dedent(""" + Extra items in the left set: + repr(1) + Extra items in the right set: + repr(3) + Full diff (fallback to calling repr on each item): + - repr(1) + repr(2) + + repr(3) + """).strip() + assert '\n'.join(expl) == dedent diff --git a/testing/web-platform/tests/tools/pytest/testing/test_assertrewrite.py b/testing/web-platform/tests/tools/pytest/testing/test_assertrewrite.py new file mode 100644 index 000000000..f43c424ca --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_assertrewrite.py @@ -0,0 +1,716 @@ +import os +import stat +import sys +import zipfile +import py +import pytest + +ast = pytest.importorskip("ast") +if sys.platform.startswith("java"): + # XXX should be xfail + pytest.skip("assert rewrite does currently not work on jython") + +import _pytest._code +from _pytest.assertion import util +from _pytest.assertion.rewrite import rewrite_asserts, PYTEST_TAG +from _pytest.main import EXIT_NOTESTSCOLLECTED + + +def setup_module(mod): + mod._old_reprcompare = util._reprcompare + _pytest._code._reprcompare = None + +def teardown_module(mod): + util._reprcompare = mod._old_reprcompare + del mod._old_reprcompare + + +def rewrite(src): + tree = ast.parse(src) + rewrite_asserts(tree) + return tree + +def getmsg(f, extra_ns=None, must_pass=False): + """Rewrite the assertions in f, run it, and get the failure message.""" + src = '\n'.join(_pytest._code.Code(f).source().lines) + mod = rewrite(src) + code = compile(mod, "<test>", "exec") + ns = {} + if extra_ns is not None: + ns.update(extra_ns) + py.builtin.exec_(code, ns) + func = ns[f.__name__] + try: + func() + except AssertionError: + if must_pass: + pytest.fail("shouldn't have raised") + s = str(sys.exc_info()[1]) + if not s.startswith("assert"): + return "AssertionError: " + s + return s + else: + if not must_pass: + pytest.fail("function didn't raise at all") + + +class TestAssertionRewrite: + + def test_place_initial_imports(self): + s = """'Doc string'\nother = stuff""" + m = rewrite(s) + assert isinstance(m.body[0], ast.Expr) + assert isinstance(m.body[0].value, ast.Str) + for imp in m.body[1:3]: + assert isinstance(imp, ast.Import) + assert imp.lineno == 2 + assert imp.col_offset == 0 + assert isinstance(m.body[3], ast.Assign) + s = """from __future__ import with_statement\nother_stuff""" + m = rewrite(s) + assert isinstance(m.body[0], ast.ImportFrom) + for imp in m.body[1:3]: + assert isinstance(imp, ast.Import) + assert imp.lineno == 2 + assert imp.col_offset == 0 + assert isinstance(m.body[3], ast.Expr) + s = """'doc string'\nfrom __future__ import with_statement\nother""" + m = rewrite(s) + assert isinstance(m.body[0], ast.Expr) + assert isinstance(m.body[0].value, ast.Str) + assert isinstance(m.body[1], ast.ImportFrom) + for imp in m.body[2:4]: + assert isinstance(imp, ast.Import) + assert imp.lineno == 3 + assert imp.col_offset == 0 + assert isinstance(m.body[4], ast.Expr) + s = """from . import relative\nother_stuff""" + m = rewrite(s) + for imp in m.body[0:2]: + assert isinstance(imp, ast.Import) + assert imp.lineno == 1 + assert imp.col_offset == 0 + assert isinstance(m.body[3], ast.Expr) + + def test_dont_rewrite(self): + s = """'PYTEST_DONT_REWRITE'\nassert 14""" + m = rewrite(s) + assert len(m.body) == 2 + assert isinstance(m.body[0].value, ast.Str) + assert isinstance(m.body[1], ast.Assert) + assert m.body[1].msg is None + + def test_name(self): + def f(): + assert False + assert getmsg(f) == "assert False" + def f(): + f = False + assert f + assert getmsg(f) == "assert False" + def f(): + assert a_global # noqa + assert getmsg(f, {"a_global" : False}) == "assert False" + def f(): + assert sys == 42 + assert getmsg(f, {"sys" : sys}) == "assert sys == 42" + def f(): + assert cls == 42 # noqa + class X(object): + pass + assert getmsg(f, {"cls" : X}) == "assert cls == 42" + + def test_assert_already_has_message(self): + def f(): + assert False, "something bad!" + assert getmsg(f) == "AssertionError: something bad!\nassert False" + + def test_assertion_message(self, testdir): + testdir.makepyfile(""" + def test_foo(): + assert 1 == 2, "The failure message" + """) + result = testdir.runpytest() + assert result.ret == 1 + result.stdout.fnmatch_lines([ + "*AssertionError*The failure message*", + "*assert 1 == 2*", + ]) + + def test_assertion_message_multiline(self, testdir): + testdir.makepyfile(""" + def test_foo(): + assert 1 == 2, "A multiline\\nfailure message" + """) + result = testdir.runpytest() + assert result.ret == 1 + result.stdout.fnmatch_lines([ + "*AssertionError*A multiline*", + "*failure message*", + "*assert 1 == 2*", + ]) + + def test_assertion_message_tuple(self, testdir): + testdir.makepyfile(""" + def test_foo(): + assert 1 == 2, (1, 2) + """) + result = testdir.runpytest() + assert result.ret == 1 + result.stdout.fnmatch_lines([ + "*AssertionError*%s*" % repr((1, 2)), + "*assert 1 == 2*", + ]) + + def test_assertion_message_expr(self, testdir): + testdir.makepyfile(""" + def test_foo(): + assert 1 == 2, 1 + 2 + """) + result = testdir.runpytest() + assert result.ret == 1 + result.stdout.fnmatch_lines([ + "*AssertionError*3*", + "*assert 1 == 2*", + ]) + + def test_assertion_message_escape(self, testdir): + testdir.makepyfile(""" + def test_foo(): + assert 1 == 2, 'To be escaped: %' + """) + result = testdir.runpytest() + assert result.ret == 1 + result.stdout.fnmatch_lines([ + "*AssertionError: To be escaped: %", + "*assert 1 == 2", + ]) + + def test_boolop(self): + def f(): + f = g = False + assert f and g + assert getmsg(f) == "assert (False)" + def f(): + f = True + g = False + assert f and g + assert getmsg(f) == "assert (True and False)" + def f(): + f = False + g = True + assert f and g + assert getmsg(f) == "assert (False)" + def f(): + f = g = False + assert f or g + assert getmsg(f) == "assert (False or False)" + def f(): + f = g = False + assert not f and not g + getmsg(f, must_pass=True) + def x(): + return False + def f(): + assert x() and x() + assert getmsg(f, {"x" : x}) == "assert (x())" + def f(): + assert False or x() + assert getmsg(f, {"x" : x}) == "assert (False or x())" + def f(): + assert 1 in {} and 2 in {} + assert getmsg(f) == "assert (1 in {})" + def f(): + x = 1 + y = 2 + assert x in {1 : None} and y in {} + assert getmsg(f) == "assert (1 in {1: None} and 2 in {})" + def f(): + f = True + g = False + assert f or g + getmsg(f, must_pass=True) + def f(): + f = g = h = lambda: True + assert f() and g() and h() + getmsg(f, must_pass=True) + + def test_short_circut_evaluation(self): + def f(): + assert True or explode # noqa + getmsg(f, must_pass=True) + def f(): + x = 1 + assert x == 1 or x == 2 + getmsg(f, must_pass=True) + + def test_unary_op(self): + def f(): + x = True + assert not x + assert getmsg(f) == "assert not True" + def f(): + x = 0 + assert ~x + 1 + assert getmsg(f) == "assert (~0 + 1)" + def f(): + x = 3 + assert -x + x + assert getmsg(f) == "assert (-3 + 3)" + def f(): + x = 0 + assert +x + x + assert getmsg(f) == "assert (+0 + 0)" + + def test_binary_op(self): + def f(): + x = 1 + y = -1 + assert x + y + assert getmsg(f) == "assert (1 + -1)" + def f(): + assert not 5 % 4 + assert getmsg(f) == "assert not (5 % 4)" + + def test_boolop_percent(self): + def f(): + assert 3 % 2 and False + assert getmsg(f) == "assert ((3 % 2) and False)" + def f(): + assert False or 4 % 2 + assert getmsg(f) == "assert (False or (4 % 2))" + + @pytest.mark.skipif("sys.version_info < (3,5)") + def test_at_operator_issue1290(self, testdir): + testdir.makepyfile(""" + class Matrix: + def __init__(self, num): + self.num = num + def __matmul__(self, other): + return self.num * other.num + + def test_multmat_operator(): + assert Matrix(2) @ Matrix(3) == 6""") + testdir.runpytest().assert_outcomes(passed=1) + + def test_call(self): + def g(a=42, *args, **kwargs): + return False + ns = {"g" : g} + def f(): + assert g() + assert getmsg(f, ns) == """assert g()""" + def f(): + assert g(1) + assert getmsg(f, ns) == """assert g(1)""" + def f(): + assert g(1, 2) + assert getmsg(f, ns) == """assert g(1, 2)""" + def f(): + assert g(1, g=42) + assert getmsg(f, ns) == """assert g(1, g=42)""" + def f(): + assert g(1, 3, g=23) + assert getmsg(f, ns) == """assert g(1, 3, g=23)""" + def f(): + seq = [1, 2, 3] + assert g(*seq) + assert getmsg(f, ns) == """assert g(*[1, 2, 3])""" + def f(): + x = "a" + assert g(**{x : 2}) + assert getmsg(f, ns) == """assert g(**{'a': 2})""" + + def test_attribute(self): + class X(object): + g = 3 + ns = {"x" : X} + def f(): + assert not x.g # noqa + assert getmsg(f, ns) == """assert not 3 + + where 3 = x.g""" + def f(): + x.a = False # noqa + assert x.a # noqa + assert getmsg(f, ns) == """assert x.a""" + + def test_comparisons(self): + def f(): + a, b = range(2) + assert b < a + assert getmsg(f) == """assert 1 < 0""" + def f(): + a, b, c = range(3) + assert a > b > c + assert getmsg(f) == """assert 0 > 1""" + def f(): + a, b, c = range(3) + assert a < b > c + assert getmsg(f) == """assert 1 > 2""" + def f(): + a, b, c = range(3) + assert a < b <= c + getmsg(f, must_pass=True) + def f(): + a, b, c = range(3) + assert a < b + assert b < c + getmsg(f, must_pass=True) + + def test_len(self): + def f(): + l = list(range(10)) + assert len(l) == 11 + assert getmsg(f).startswith("""assert 10 == 11 + + where 10 = len([""") + + def test_custom_reprcompare(self, monkeypatch): + def my_reprcompare(op, left, right): + return "42" + monkeypatch.setattr(util, "_reprcompare", my_reprcompare) + def f(): + assert 42 < 3 + assert getmsg(f) == "assert 42" + def my_reprcompare(op, left, right): + return "%s %s %s" % (left, op, right) + monkeypatch.setattr(util, "_reprcompare", my_reprcompare) + def f(): + assert 1 < 3 < 5 <= 4 < 7 + assert getmsg(f) == "assert 5 <= 4" + + def test_assert_raising_nonzero_in_comparison(self): + def f(): + class A(object): + def __nonzero__(self): + raise ValueError(42) + def __lt__(self, other): + return A() + def __repr__(self): + return "<MY42 object>" + def myany(x): + return False + assert myany(A() < 0) + assert "<MY42 object> < 0" in getmsg(f) + + def test_formatchar(self): + def f(): + assert "%test" == "test" + assert getmsg(f).startswith("assert '%test' == 'test'") + + def test_custom_repr(self): + def f(): + class Foo(object): + a = 1 + + def __repr__(self): + return "\n{ \n~ \n}" + f = Foo() + assert 0 == f.a + assert r"where 1 = \n{ \n~ \n}.a" in util._format_lines([getmsg(f)])[0] + + +class TestRewriteOnImport: + + def test_pycache_is_a_file(self, testdir): + testdir.tmpdir.join("__pycache__").write("Hello") + testdir.makepyfile(""" + def test_rewritten(): + assert "@py_builtins" in globals()""") + assert testdir.runpytest().ret == 0 + + def test_pycache_is_readonly(self, testdir): + cache = testdir.tmpdir.mkdir("__pycache__") + old_mode = cache.stat().mode + cache.chmod(old_mode ^ stat.S_IWRITE) + testdir.makepyfile(""" + def test_rewritten(): + assert "@py_builtins" in globals()""") + try: + assert testdir.runpytest().ret == 0 + finally: + cache.chmod(old_mode) + + def test_zipfile(self, testdir): + z = testdir.tmpdir.join("myzip.zip") + z_fn = str(z) + f = zipfile.ZipFile(z_fn, "w") + try: + f.writestr("test_gum/__init__.py", "") + f.writestr("test_gum/test_lizard.py", "") + finally: + f.close() + z.chmod(256) + testdir.makepyfile(""" + import sys + sys.path.append(%r) + import test_gum.test_lizard""" % (z_fn,)) + assert testdir.runpytest().ret == EXIT_NOTESTSCOLLECTED + + def test_readonly(self, testdir): + sub = testdir.mkdir("testing") + sub.join("test_readonly.py").write( + py.builtin._totext(""" +def test_rewritten(): + assert "@py_builtins" in globals() + """).encode("utf-8"), "wb") + old_mode = sub.stat().mode + sub.chmod(320) + try: + assert testdir.runpytest().ret == 0 + finally: + sub.chmod(old_mode) + + def test_dont_write_bytecode(self, testdir, monkeypatch): + testdir.makepyfile(""" + import os + def test_no_bytecode(): + assert "__pycache__" in __cached__ + assert not os.path.exists(__cached__) + assert not os.path.exists(os.path.dirname(__cached__))""") + monkeypatch.setenv("PYTHONDONTWRITEBYTECODE", "1") + assert testdir.runpytest_subprocess().ret == 0 + + @pytest.mark.skipif('"__pypy__" in sys.modules') + def test_pyc_vs_pyo(self, testdir, monkeypatch): + testdir.makepyfile(""" + import pytest + def test_optimized(): + "hello" + assert test_optimized.__doc__ is None""" + ) + p = py.path.local.make_numbered_dir(prefix="runpytest-", keep=None, + rootdir=testdir.tmpdir) + tmp = "--basetemp=%s" % p + monkeypatch.setenv("PYTHONOPTIMIZE", "2") + monkeypatch.delenv("PYTHONDONTWRITEBYTECODE", raising=False) + assert testdir.runpytest_subprocess(tmp).ret == 0 + tagged = "test_pyc_vs_pyo." + PYTEST_TAG + assert tagged + ".pyo" in os.listdir("__pycache__") + monkeypatch.undo() + monkeypatch.delenv("PYTHONDONTWRITEBYTECODE", raising=False) + assert testdir.runpytest_subprocess(tmp).ret == 1 + assert tagged + ".pyc" in os.listdir("__pycache__") + + def test_package(self, testdir): + pkg = testdir.tmpdir.join("pkg") + pkg.mkdir() + pkg.join("__init__.py").ensure() + pkg.join("test_blah.py").write(""" +def test_rewritten(): + assert "@py_builtins" in globals()""") + assert testdir.runpytest().ret == 0 + + def test_translate_newlines(self, testdir): + content = "def test_rewritten():\r\n assert '@py_builtins' in globals()" + b = content.encode("utf-8") + testdir.tmpdir.join("test_newlines.py").write(b, "wb") + assert testdir.runpytest().ret == 0 + + @pytest.mark.skipif(sys.version_info < (3,3), + reason='packages without __init__.py not supported on python 2') + def test_package_without__init__py(self, testdir): + pkg = testdir.mkdir('a_package_without_init_py') + pkg.join('module.py').ensure() + testdir.makepyfile("import a_package_without_init_py.module") + assert testdir.runpytest().ret == EXIT_NOTESTSCOLLECTED + +class TestAssertionRewriteHookDetails(object): + def test_loader_is_package_false_for_module(self, testdir): + testdir.makepyfile(test_fun=""" + def test_loader(): + assert not __loader__.is_package(__name__) + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "* 1 passed*", + ]) + + def test_loader_is_package_true_for_package(self, testdir): + testdir.makepyfile(test_fun=""" + def test_loader(): + assert not __loader__.is_package(__name__) + + def test_fun(): + assert __loader__.is_package('fun') + + def test_missing(): + assert not __loader__.is_package('pytest_not_there') + """) + testdir.mkpydir('fun') + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + '* 3 passed*', + ]) + + @pytest.mark.skipif("sys.version_info[0] >= 3") + @pytest.mark.xfail("hasattr(sys, 'pypy_translation_info')") + def test_assume_ascii(self, testdir): + content = "u'\xe2\x99\xa5\x01\xfe'" + testdir.tmpdir.join("test_encoding.py").write(content, "wb") + res = testdir.runpytest() + assert res.ret != 0 + assert "SyntaxError: Non-ASCII character" in res.stdout.str() + + @pytest.mark.skipif("sys.version_info[0] >= 3") + def test_detect_coding_cookie(self, testdir): + testdir.makepyfile(test_cookie=""" + # -*- coding: utf-8 -*- + u"St\xc3\xa4d" + def test_rewritten(): + assert "@py_builtins" in globals()""") + assert testdir.runpytest().ret == 0 + + @pytest.mark.skipif("sys.version_info[0] >= 3") + def test_detect_coding_cookie_second_line(self, testdir): + testdir.makepyfile(test_cookie=""" + # -*- coding: utf-8 -*- + u"St\xc3\xa4d" + def test_rewritten(): + assert "@py_builtins" in globals()""") + assert testdir.runpytest().ret == 0 + + @pytest.mark.skipif("sys.version_info[0] >= 3") + def test_detect_coding_cookie_crlf(self, testdir): + testdir.makepyfile(test_cookie=""" + # -*- coding: utf-8 -*- + u"St\xc3\xa4d" + def test_rewritten(): + assert "@py_builtins" in globals()""") + assert testdir.runpytest().ret == 0 + + def test_sys_meta_path_munged(self, testdir): + testdir.makepyfile(""" + def test_meta_path(): + import sys; sys.meta_path = []""") + assert testdir.runpytest().ret == 0 + + def test_write_pyc(self, testdir, tmpdir, monkeypatch): + from _pytest.assertion.rewrite import _write_pyc + from _pytest.assertion import AssertionState + try: + import __builtin__ as b + except ImportError: + import builtins as b + config = testdir.parseconfig([]) + state = AssertionState(config, "rewrite") + source_path = tmpdir.ensure("source.py") + pycpath = tmpdir.join("pyc").strpath + assert _write_pyc(state, [1], source_path.stat(), pycpath) + def open(*args): + e = IOError() + e.errno = 10 + raise e + monkeypatch.setattr(b, "open", open) + assert not _write_pyc(state, [1], source_path.stat(), pycpath) + + def test_resources_provider_for_loader(self, testdir): + """ + Attempts to load resources from a package should succeed normally, + even when the AssertionRewriteHook is used to load the modules. + + See #366 for details. + """ + pytest.importorskip("pkg_resources") + + testdir.mkpydir('testpkg') + contents = { + 'testpkg/test_pkg': """ + import pkg_resources + + import pytest + from _pytest.assertion.rewrite import AssertionRewritingHook + + def test_load_resource(): + assert isinstance(__loader__, AssertionRewritingHook) + res = pkg_resources.resource_string(__name__, 'resource.txt') + res = res.decode('ascii') + assert res == 'Load me please.' + """, + } + testdir.makepyfile(**contents) + testdir.maketxtfile(**{'testpkg/resource': "Load me please."}) + + result = testdir.runpytest_subprocess() + result.assert_outcomes(passed=1) + + def test_read_pyc(self, tmpdir): + """ + Ensure that the `_read_pyc` can properly deal with corrupted pyc files. + In those circumstances it should just give up instead of generating + an exception that is propagated to the caller. + """ + import py_compile + from _pytest.assertion.rewrite import _read_pyc + + source = tmpdir.join('source.py') + pyc = source + 'c' + + source.write('def test(): pass') + py_compile.compile(str(source), str(pyc)) + + contents = pyc.read(mode='rb') + strip_bytes = 20 # header is around 8 bytes, strip a little more + assert len(contents) > strip_bytes + pyc.write(contents[:strip_bytes], mode='wb') + + assert _read_pyc(source, str(pyc)) is None # no error + + def test_reload_is_same(self, testdir): + # A file that will be picked up during collecting. + testdir.tmpdir.join("file.py").ensure() + testdir.tmpdir.join("pytest.ini").write(py.std.textwrap.dedent(""" + [pytest] + python_files = *.py + """)) + + testdir.makepyfile(test_fun=""" + import sys + try: + from imp import reload + except ImportError: + pass + + def test_loader(): + import file + assert sys.modules["file"] is reload(file) + """) + result = testdir.runpytest('-s') + result.stdout.fnmatch_lines([ + "* 1 passed*", + ]) + + def test_get_data_support(self, testdir): + """Implement optional PEP302 api (#808). + """ + path = testdir.mkpydir("foo") + path.join("test_foo.py").write(_pytest._code.Source(""" + class Test: + def test_foo(self): + import pkgutil + data = pkgutil.get_data('foo.test_foo', 'data.txt') + assert data == b'Hey' + """)) + path.join('data.txt').write('Hey') + result = testdir.runpytest() + result.stdout.fnmatch_lines('*1 passed*') + + +def test_issue731(testdir): + testdir.makepyfile(""" + class LongReprWithBraces(object): + def __repr__(self): + return 'LongReprWithBraces({' + ('a' * 80) + '}' + ('a' * 120) + ')' + + def some_method(self): + return False + + def test_long_repr(): + obj = LongReprWithBraces() + assert obj.some_method() + """) + result = testdir.runpytest() + assert 'unbalanced braces' not in result.stdout.str() + + +def test_collapse_false_unbalanced_braces(): + util._collapse_false('some text{ False\n{False = some more text\n}') diff --git a/testing/web-platform/tests/tools/pytest/testing/test_cache.py b/testing/web-platform/tests/tools/pytest/testing/test_cache.py new file mode 100755 index 000000000..98053f869 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_cache.py @@ -0,0 +1,386 @@ +import sys + +import _pytest +import pytest +import os +import shutil + +pytest_plugins = "pytester", + +class TestNewAPI: + def test_config_cache_makedir(self, testdir): + testdir.makeini("[pytest]") + config = testdir.parseconfigure() + with pytest.raises(ValueError): + config.cache.makedir("key/name") + + p = config.cache.makedir("name") + assert p.check() + + def test_config_cache_dataerror(self, testdir): + testdir.makeini("[pytest]") + config = testdir.parseconfigure() + cache = config.cache + pytest.raises(TypeError, lambda: cache.set("key/name", cache)) + config.cache.set("key/name", 0) + config.cache._getvaluepath("key/name").write("123invalid") + val = config.cache.get("key/name", -2) + assert val == -2 + + def test_cache_writefail_cachfile_silent(self, testdir): + testdir.makeini("[pytest]") + testdir.tmpdir.join('.cache').write('gone wrong') + config = testdir.parseconfigure() + cache = config.cache + cache.set('test/broken', []) + + @pytest.mark.skipif(sys.platform.startswith('win'), reason='no chmod on windows') + def test_cache_writefail_permissions(self, testdir): + testdir.makeini("[pytest]") + testdir.tmpdir.ensure_dir('.cache').chmod(0) + config = testdir.parseconfigure() + cache = config.cache + cache.set('test/broken', []) + + @pytest.mark.skipif(sys.platform.startswith('win'), reason='no chmod on windows') + def test_cache_failure_warns(self, testdir): + testdir.tmpdir.ensure_dir('.cache').chmod(0) + testdir.makepyfile(""" + def test_error(): + raise Exception + + """) + result = testdir.runpytest('-rw') + assert result.ret == 1 + result.stdout.fnmatch_lines([ + "*could not create cache path*", + "*1 pytest-warnings*", + ]) + + def test_config_cache(self, testdir): + testdir.makeconftest(""" + def pytest_configure(config): + # see that we get cache information early on + assert hasattr(config, "cache") + """) + testdir.makepyfile(""" + def test_session(pytestconfig): + assert hasattr(pytestconfig, "cache") + """) + result = testdir.runpytest() + assert result.ret == 0 + result.stdout.fnmatch_lines(["*1 passed*"]) + + def test_cachefuncarg(self, testdir): + testdir.makepyfile(""" + import pytest + def test_cachefuncarg(cache): + val = cache.get("some/thing", None) + assert val is None + cache.set("some/thing", [1]) + pytest.raises(TypeError, lambda: cache.get("some/thing")) + val = cache.get("some/thing", []) + assert val == [1] + """) + result = testdir.runpytest() + assert result.ret == 0 + result.stdout.fnmatch_lines(["*1 passed*"]) + + + +def test_cache_reportheader(testdir): + testdir.makepyfile(""" + def test_hello(): + pass + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines([ + "cachedir: .cache" + ]) + + +def test_cache_show(testdir): + result = testdir.runpytest("--cache-show") + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*cache is empty*" + ]) + testdir.makeconftest(""" + def pytest_configure(config): + config.cache.set("my/name", [1,2,3]) + config.cache.set("other/some", {1:2}) + dp = config.cache.makedir("mydb") + dp.ensure("hello") + dp.ensure("world") + """) + result = testdir.runpytest() + assert result.ret == 5 # no tests executed + result = testdir.runpytest("--cache-show") + result.stdout.fnmatch_lines_random([ + "*cachedir:*", + "-*cache values*-", + "*my/name contains:", + " [1, 2, 3]", + "*other/some contains*", + " {*1*: 2}", + "-*cache directories*-", + "*mydb/hello*length 0*", + "*mydb/world*length 0*", + ]) + + +class TestLastFailed: + + def test_lastfailed_usecase(self, testdir, monkeypatch): + monkeypatch.setenv("PYTHONDONTWRITEBYTECODE", 1) + p = testdir.makepyfile(""" + def test_1(): + assert 0 + def test_2(): + assert 0 + def test_3(): + assert 1 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*2 failed*", + ]) + p.write(_pytest._code.Source(""" + def test_1(): + assert 1 + + def test_2(): + assert 1 + + def test_3(): + assert 0 + """)) + result = testdir.runpytest("--lf") + result.stdout.fnmatch_lines([ + "*2 passed*1 desel*", + ]) + result = testdir.runpytest("--lf") + result.stdout.fnmatch_lines([ + "*1 failed*2 passed*", + ]) + result = testdir.runpytest("--lf", "--cache-clear") + result.stdout.fnmatch_lines([ + "*1 failed*2 passed*", + ]) + + # Run this again to make sure clear-cache is robust + if os.path.isdir('.cache'): + shutil.rmtree('.cache') + result = testdir.runpytest("--lf", "--cache-clear") + result.stdout.fnmatch_lines([ + "*1 failed*2 passed*", + ]) + + def test_failedfirst_order(self, testdir): + testdir.tmpdir.join('test_a.py').write(_pytest._code.Source(""" + def test_always_passes(): + assert 1 + """)) + testdir.tmpdir.join('test_b.py').write(_pytest._code.Source(""" + def test_always_fails(): + assert 0 + """)) + result = testdir.runpytest() + # Test order will be collection order; alphabetical + result.stdout.fnmatch_lines([ + "test_a.py*", + "test_b.py*", + ]) + result = testdir.runpytest("--lf", "--ff") + # Test order will be failing tests firs + result.stdout.fnmatch_lines([ + "test_b.py*", + "test_a.py*", + ]) + + def test_lastfailed_difference_invocations(self, testdir, monkeypatch): + monkeypatch.setenv("PYTHONDONTWRITEBYTECODE", 1) + testdir.makepyfile(test_a=""" + def test_a1(): + assert 0 + def test_a2(): + assert 1 + """, test_b=""" + def test_b1(): + assert 0 + """) + p = testdir.tmpdir.join("test_a.py") + p2 = testdir.tmpdir.join("test_b.py") + + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*2 failed*", + ]) + result = testdir.runpytest("--lf", p2) + result.stdout.fnmatch_lines([ + "*1 failed*", + ]) + p2.write(_pytest._code.Source(""" + def test_b1(): + assert 1 + """)) + result = testdir.runpytest("--lf", p2) + result.stdout.fnmatch_lines([ + "*1 passed*", + ]) + result = testdir.runpytest("--lf", p) + result.stdout.fnmatch_lines([ + "*1 failed*1 desel*", + ]) + + def test_lastfailed_usecase_splice(self, testdir, monkeypatch): + monkeypatch.setenv("PYTHONDONTWRITEBYTECODE", 1) + testdir.makepyfile(""" + def test_1(): + assert 0 + """) + p2 = testdir.tmpdir.join("test_something.py") + p2.write(_pytest._code.Source(""" + def test_2(): + assert 0 + """)) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*2 failed*", + ]) + result = testdir.runpytest("--lf", p2) + result.stdout.fnmatch_lines([ + "*1 failed*", + ]) + result = testdir.runpytest("--lf") + result.stdout.fnmatch_lines([ + "*2 failed*", + ]) + + def test_lastfailed_xpass(self, testdir): + testdir.inline_runsource(""" + import pytest + @pytest.mark.xfail + def test_hello(): + assert 1 + """) + config = testdir.parseconfigure() + lastfailed = config.cache.get("cache/lastfailed", -1) + assert lastfailed == -1 + + def test_non_serializable_parametrize(self, testdir): + """Test that failed parametrized tests with unmarshable parameters + don't break pytest-cache. + """ + testdir.makepyfile(r""" + import pytest + + @pytest.mark.parametrize('val', [ + b'\xac\x10\x02G', + ]) + def test_fail(val): + assert False + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines('*1 failed in*') + + def test_lastfailed_collectfailure(self, testdir, monkeypatch): + + testdir.makepyfile(test_maybe=""" + import py + env = py.std.os.environ + if '1' == env['FAILIMPORT']: + raise ImportError('fail') + def test_hello(): + assert '0' == env['FAILTEST'] + """) + + def rlf(fail_import, fail_run): + monkeypatch.setenv('FAILIMPORT', fail_import) + monkeypatch.setenv('FAILTEST', fail_run) + + testdir.runpytest('-q') + config = testdir.parseconfigure() + lastfailed = config.cache.get("cache/lastfailed", -1) + return lastfailed + + lastfailed = rlf(fail_import=0, fail_run=0) + assert lastfailed == -1 + + lastfailed = rlf(fail_import=1, fail_run=0) + assert list(lastfailed) == ['test_maybe.py'] + + lastfailed = rlf(fail_import=0, fail_run=1) + assert list(lastfailed) == ['test_maybe.py::test_hello'] + + + def test_lastfailed_failure_subset(self, testdir, monkeypatch): + + testdir.makepyfile(test_maybe=""" + import py + env = py.std.os.environ + if '1' == env['FAILIMPORT']: + raise ImportError('fail') + def test_hello(): + assert '0' == env['FAILTEST'] + """) + + testdir.makepyfile(test_maybe2=""" + import py + env = py.std.os.environ + if '1' == env['FAILIMPORT']: + raise ImportError('fail') + def test_hello(): + assert '0' == env['FAILTEST'] + + def test_pass(): + pass + """) + + def rlf(fail_import, fail_run, args=()): + monkeypatch.setenv('FAILIMPORT', fail_import) + monkeypatch.setenv('FAILTEST', fail_run) + + result = testdir.runpytest('-q', '--lf', *args) + config = testdir.parseconfigure() + lastfailed = config.cache.get("cache/lastfailed", -1) + return result, lastfailed + + result, lastfailed = rlf(fail_import=0, fail_run=0) + assert lastfailed == -1 + result.stdout.fnmatch_lines([ + '*3 passed*', + ]) + + result, lastfailed = rlf(fail_import=1, fail_run=0) + assert sorted(list(lastfailed)) == ['test_maybe.py', 'test_maybe2.py'] + + + result, lastfailed = rlf(fail_import=0, fail_run=0, + args=('test_maybe2.py',)) + assert list(lastfailed) == ['test_maybe.py'] + + + # edge case of test selection - even if we remember failures + # from other tests we still need to run all tests if no test + # matches the failures + result, lastfailed = rlf(fail_import=0, fail_run=0, + args=('test_maybe2.py',)) + assert list(lastfailed) == ['test_maybe.py'] + result.stdout.fnmatch_lines([ + '*2 passed*', + ]) + + def test_lastfailed_creates_cache_when_needed(self, testdir): + # Issue #1342 + testdir.makepyfile(test_empty='') + testdir.runpytest('-q', '--lf') + assert not os.path.exists('.cache') + + testdir.makepyfile(test_successful='def test_success():\n assert True') + testdir.runpytest('-q', '--lf') + assert not os.path.exists('.cache') + + testdir.makepyfile(test_errored='def test_error():\n assert False') + testdir.runpytest('-q', '--lf') + assert os.path.exists('.cache') diff --git a/testing/web-platform/tests/tools/pytest/testing/test_capture.py b/testing/web-platform/tests/tools/pytest/testing/test_capture.py new file mode 100644 index 000000000..73660692b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_capture.py @@ -0,0 +1,1068 @@ +# note: py.io capture tests where copied from +# pylib 1.4.20.dev2 (rev 13d9af95547e) +from __future__ import with_statement +import pickle +import os +import sys + +import _pytest._code +import py +import pytest +import contextlib + +from _pytest import capture +from _pytest.capture import CaptureManager +from _pytest.main import EXIT_NOTESTSCOLLECTED +from py.builtin import print_ + +needsosdup = pytest.mark.xfail("not hasattr(os, 'dup')") + +if sys.version_info >= (3, 0): + def tobytes(obj): + if isinstance(obj, str): + obj = obj.encode('UTF-8') + assert isinstance(obj, bytes) + return obj + + def totext(obj): + if isinstance(obj, bytes): + obj = str(obj, 'UTF-8') + assert isinstance(obj, str) + return obj +else: + def tobytes(obj): + if isinstance(obj, unicode): + obj = obj.encode('UTF-8') + assert isinstance(obj, str) + return obj + + def totext(obj): + if isinstance(obj, str): + obj = unicode(obj, 'UTF-8') + assert isinstance(obj, unicode) + return obj + + +def oswritebytes(fd, obj): + os.write(fd, tobytes(obj)) + + + +def StdCaptureFD(out=True, err=True, in_=True): + return capture.MultiCapture(out, err, in_, Capture=capture.FDCapture) + +def StdCapture(out=True, err=True, in_=True): + return capture.MultiCapture(out, err, in_, Capture=capture.SysCapture) + + +class TestCaptureManager: + def test_getmethod_default_no_fd(self, monkeypatch): + from _pytest.capture import pytest_addoption + from _pytest.config import Parser + parser = Parser() + pytest_addoption(parser) + default = parser._groups[0].options[0].default + assert default == "fd" if hasattr(os, "dup") else "sys" + parser = Parser() + monkeypatch.delattr(os, 'dup', raising=False) + pytest_addoption(parser) + assert parser._groups[0].options[0].default == "sys" + + @needsosdup + @pytest.mark.parametrize("method", + ['no', 'sys', pytest.mark.skipif('not hasattr(os, "dup")', 'fd')]) + def test_capturing_basic_api(self, method): + capouter = StdCaptureFD() + old = sys.stdout, sys.stderr, sys.stdin + try: + capman = CaptureManager(method) + capman.init_capturings() + outerr = capman.suspendcapture() + assert outerr == ("", "") + outerr = capman.suspendcapture() + assert outerr == ("", "") + print ("hello") + out, err = capman.suspendcapture() + if method == "no": + assert old == (sys.stdout, sys.stderr, sys.stdin) + else: + assert not out + capman.resumecapture() + print ("hello") + out, err = capman.suspendcapture() + if method != "no": + assert out == "hello\n" + capman.reset_capturings() + finally: + capouter.stop_capturing() + + @needsosdup + def test_init_capturing(self): + capouter = StdCaptureFD() + try: + capman = CaptureManager("fd") + capman.init_capturings() + pytest.raises(AssertionError, "capman.init_capturings()") + capman.reset_capturings() + finally: + capouter.stop_capturing() + + +@pytest.mark.parametrize("method", ['fd', 'sys']) +def test_capturing_unicode(testdir, method): + if hasattr(sys, "pypy_version_info") and sys.pypy_version_info < (2,2): + pytest.xfail("does not work on pypy < 2.2") + if sys.version_info >= (3, 0): + obj = "'b\u00f6y'" + else: + obj = "u'\u00f6y'" + testdir.makepyfile(""" + # coding=utf8 + # taken from issue 227 from nosetests + def test_unicode(): + import sys + print (sys.stdout) + print (%s) + """ % obj) + result = testdir.runpytest("--capture=%s" % method) + result.stdout.fnmatch_lines([ + "*1 passed*" + ]) + + +@pytest.mark.parametrize("method", ['fd', 'sys']) +def test_capturing_bytes_in_utf8_encoding(testdir, method): + testdir.makepyfile(""" + def test_unicode(): + print ('b\\u00f6y') + """) + result = testdir.runpytest("--capture=%s" % method) + result.stdout.fnmatch_lines([ + "*1 passed*" + ]) + + +def test_collect_capturing(testdir): + p = testdir.makepyfile(""" + print ("collect %s failure" % 13) + import xyz42123 + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*Captured stdout*", + "*collect 13 failure*", + ]) + + +class TestPerTestCapturing: + def test_capture_and_fixtures(self, testdir): + p = testdir.makepyfile(""" + def setup_module(mod): + print ("setup module") + def setup_function(function): + print ("setup " + function.__name__) + def test_func1(): + print ("in func1") + assert 0 + def test_func2(): + print ("in func2") + assert 0 + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "setup module*", + "setup test_func1*", + "in func1*", + "setup test_func2*", + "in func2*", + ]) + + @pytest.mark.xfail(reason="unimplemented feature") + def test_capture_scope_cache(self, testdir): + p = testdir.makepyfile(""" + import sys + def setup_module(func): + print ("module-setup") + def setup_function(func): + print ("function-setup") + def test_func(): + print ("in function") + assert 0 + def teardown_function(func): + print ("in teardown") + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*test_func():*", + "*Captured stdout during setup*", + "module-setup*", + "function-setup*", + "*Captured stdout*", + "in teardown*", + ]) + + def test_no_carry_over(self, testdir): + p = testdir.makepyfile(""" + def test_func1(): + print ("in func1") + def test_func2(): + print ("in func2") + assert 0 + """) + result = testdir.runpytest(p) + s = result.stdout.str() + assert "in func1" not in s + assert "in func2" in s + + def test_teardown_capturing(self, testdir): + p = testdir.makepyfile(""" + def setup_function(function): + print ("setup func1") + def teardown_function(function): + print ("teardown func1") + assert 0 + def test_func1(): + print ("in func1") + pass + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + '*teardown_function*', + '*Captured stdout*', + "setup func1*", + "in func1*", + "teardown func1*", + #"*1 fixture failure*" + ]) + + def test_teardown_capturing_final(self, testdir): + p = testdir.makepyfile(""" + def teardown_module(mod): + print ("teardown module") + assert 0 + def test_func(): + pass + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*def teardown_module(mod):*", + "*Captured stdout*", + "*teardown module*", + "*1 error*", + ]) + + def test_capturing_outerr(self, testdir): + p1 = testdir.makepyfile(""" + import sys + def test_capturing(): + print (42) + sys.stderr.write(str(23)) + def test_capturing_error(): + print (1) + sys.stderr.write(str(2)) + raise ValueError + """) + result = testdir.runpytest(p1) + result.stdout.fnmatch_lines([ + "*test_capturing_outerr.py .F", + "====* FAILURES *====", + "____*____", + "*test_capturing_outerr.py:8: ValueError", + "*--- Captured stdout *call*", + "1", + "*--- Captured stderr *call*", + "2", + ]) + + +class TestLoggingInteraction: + def test_logging_stream_ownership(self, testdir): + p = testdir.makepyfile(""" + def test_logging(): + import logging + import pytest + stream = capture.TextIO() + logging.basicConfig(stream=stream) + stream.close() # to free memory/release resources + """) + result = testdir.runpytest_subprocess(p) + result.stderr.str().find("atexit") == -1 + + def test_logging_and_immediate_setupteardown(self, testdir): + p = testdir.makepyfile(""" + import logging + def setup_function(function): + logging.warn("hello1") + + def test_logging(): + logging.warn("hello2") + assert 0 + + def teardown_function(function): + logging.warn("hello3") + assert 0 + """) + for optargs in (('--capture=sys',), ('--capture=fd',)): + print (optargs) + result = testdir.runpytest_subprocess(p, *optargs) + s = result.stdout.str() + result.stdout.fnmatch_lines([ + "*WARN*hello3", # errors show first! + "*WARN*hello1", + "*WARN*hello2", + ]) + # verify proper termination + assert "closed" not in s + + def test_logging_and_crossscope_fixtures(self, testdir): + p = testdir.makepyfile(""" + import logging + def setup_module(function): + logging.warn("hello1") + + def test_logging(): + logging.warn("hello2") + assert 0 + + def teardown_module(function): + logging.warn("hello3") + assert 0 + """) + for optargs in (('--capture=sys',), ('--capture=fd',)): + print (optargs) + result = testdir.runpytest_subprocess(p, *optargs) + s = result.stdout.str() + result.stdout.fnmatch_lines([ + "*WARN*hello3", # errors come first + "*WARN*hello1", + "*WARN*hello2", + ]) + # verify proper termination + assert "closed" not in s + + def test_logging_initialized_in_test(self, testdir): + p = testdir.makepyfile(""" + import sys + def test_something(): + # pytest does not import logging + assert 'logging' not in sys.modules + import logging + logging.basicConfig() + logging.warn("hello432") + assert 0 + """) + result = testdir.runpytest_subprocess( + p, "--traceconfig", + "-p", "no:capturelog") + assert result.ret != 0 + result.stdout.fnmatch_lines([ + "*hello432*", + ]) + assert 'operation on closed file' not in result.stderr.str() + + def test_conftestlogging_is_shown(self, testdir): + testdir.makeconftest(""" + import logging + logging.basicConfig() + logging.warn("hello435") + """) + # make sure that logging is still captured in tests + result = testdir.runpytest_subprocess("-s", "-p", "no:capturelog") + assert result.ret == EXIT_NOTESTSCOLLECTED + result.stderr.fnmatch_lines([ + "WARNING*hello435*", + ]) + assert 'operation on closed file' not in result.stderr.str() + + def test_conftestlogging_and_test_logging(self, testdir): + testdir.makeconftest(""" + import logging + logging.basicConfig() + """) + # make sure that logging is still captured in tests + p = testdir.makepyfile(""" + def test_hello(): + import logging + logging.warn("hello433") + assert 0 + """) + result = testdir.runpytest_subprocess(p, "-p", "no:capturelog") + assert result.ret != 0 + result.stdout.fnmatch_lines([ + "WARNING*hello433*", + ]) + assert 'something' not in result.stderr.str() + assert 'operation on closed file' not in result.stderr.str() + + +class TestCaptureFixture: + @pytest.mark.parametrize("opt", [[], ["-s"]]) + def test_std_functional(self, testdir, opt): + reprec = testdir.inline_runsource(""" + def test_hello(capsys): + print (42) + out, err = capsys.readouterr() + assert out.startswith("42") + """, *opt) + reprec.assertoutcome(passed=1) + + def test_capsyscapfd(self, testdir): + p = testdir.makepyfile(""" + def test_one(capsys, capfd): + pass + def test_two(capfd, capsys): + pass + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*ERROR*setup*test_one*", + "*capsys*capfd*same*time*", + "*ERROR*setup*test_two*", + "*capsys*capfd*same*time*", + "*2 error*"]) + + @pytest.mark.parametrize("method", ["sys", "fd"]) + def test_capture_is_represented_on_failure_issue128(self, testdir, method): + p = testdir.makepyfile(""" + def test_hello(cap%s): + print ("xxx42xxx") + assert 0 + """ % method) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "xxx42xxx", + ]) + + @needsosdup + def test_stdfd_functional(self, testdir): + reprec = testdir.inline_runsource(""" + def test_hello(capfd): + import os + os.write(1, "42".encode('ascii')) + out, err = capfd.readouterr() + assert out.startswith("42") + capfd.close() + """) + reprec.assertoutcome(passed=1) + + def test_partial_setup_failure(self, testdir): + p = testdir.makepyfile(""" + def test_hello(capsys, missingarg): + pass + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*test_partial_setup_failure*", + "*1 error*", + ]) + + @needsosdup + def test_keyboardinterrupt_disables_capturing(self, testdir): + p = testdir.makepyfile(""" + def test_hello(capfd): + import os + os.write(1, str(42).encode('ascii')) + raise KeyboardInterrupt() + """) + result = testdir.runpytest_subprocess(p) + result.stdout.fnmatch_lines([ + "*KeyboardInterrupt*" + ]) + assert result.ret == 2 + + @pytest.mark.issue14 + def test_capture_and_logging(self, testdir): + p = testdir.makepyfile(""" + import logging + def test_log(capsys): + logging.error('x') + """) + result = testdir.runpytest_subprocess(p) + assert 'closed' not in result.stderr.str() + + +def test_setup_failure_does_not_kill_capturing(testdir): + sub1 = testdir.mkpydir("sub1") + sub1.join("conftest.py").write(_pytest._code.Source(""" + def pytest_runtest_setup(item): + raise ValueError(42) + """)) + sub1.join("test_mod.py").write("def test_func1(): pass") + result = testdir.runpytest(testdir.tmpdir, '--traceconfig') + result.stdout.fnmatch_lines([ + "*ValueError(42)*", + "*1 error*" + ]) + + +def test_fdfuncarg_skips_on_no_osdup(testdir): + testdir.makepyfile(""" + import os + if hasattr(os, 'dup'): + del os.dup + def test_hello(capfd): + pass + """) + result = testdir.runpytest_subprocess("--capture=no") + result.stdout.fnmatch_lines([ + "*1 skipped*" + ]) + + +def test_capture_conftest_runtest_setup(testdir): + testdir.makeconftest(""" + def pytest_runtest_setup(): + print ("hello19") + """) + testdir.makepyfile("def test_func(): pass") + result = testdir.runpytest() + assert result.ret == 0 + assert 'hello19' not in result.stdout.str() + + +def test_capture_badoutput_issue412(testdir): + testdir.makepyfile(""" + import os + + def test_func(): + omg = bytearray([1,129,1]) + os.write(1, omg) + assert 0 + """) + result = testdir.runpytest('--cap=fd') + result.stdout.fnmatch_lines(''' + *def test_func* + *assert 0* + *Captured* + *1 failed* + ''') + + +def test_capture_early_option_parsing(testdir): + testdir.makeconftest(""" + def pytest_runtest_setup(): + print ("hello19") + """) + testdir.makepyfile("def test_func(): pass") + result = testdir.runpytest("-vs") + assert result.ret == 0 + assert 'hello19' in result.stdout.str() + + +def test_capture_binary_output(testdir): + testdir.makepyfile(r""" + import pytest + + def test_a(): + import sys + import subprocess + subprocess.call([sys.executable, __file__]) + + def test_foo(): + import os;os.write(1, b'\xc3') + + if __name__ == '__main__': + test_foo() + """) + result = testdir.runpytest('--assert=plain') + result.assert_outcomes(passed=2) + + +def test_error_during_readouterr(testdir): + """Make sure we suspend capturing if errors occurr during readouterr""" + testdir.makepyfile(pytest_xyz=""" + from _pytest.capture import FDCapture + def bad_snap(self): + raise Exception('boom') + assert FDCapture.snap + FDCapture.snap = bad_snap + """) + result = testdir.runpytest_subprocess( + "-p", "pytest_xyz", "--version", syspathinsert=True + ) + result.stderr.fnmatch_lines([ + "*in bad_snap", + " raise Exception('boom')", + "Exception: boom", + ]) + + +class TestTextIO: + def test_text(self): + f = capture.TextIO() + f.write("hello") + s = f.getvalue() + assert s == "hello" + f.close() + + def test_unicode_and_str_mixture(self): + f = capture.TextIO() + if sys.version_info >= (3, 0): + f.write("\u00f6") + pytest.raises(TypeError, "f.write(bytes('hello', 'UTF-8'))") + else: + f.write(unicode("\u00f6", 'UTF-8')) + f.write("hello") # bytes + s = f.getvalue() + f.close() + assert isinstance(s, unicode) + + +def test_bytes_io(): + f = py.io.BytesIO() + f.write(tobytes("hello")) + pytest.raises(TypeError, "f.write(totext('hello'))") + s = f.getvalue() + assert s == tobytes("hello") + + +def test_dontreadfrominput(): + from _pytest.capture import DontReadFromInput + f = DontReadFromInput() + assert not f.isatty() + pytest.raises(IOError, f.read) + pytest.raises(IOError, f.readlines) + pytest.raises(IOError, iter, f) + pytest.raises(ValueError, f.fileno) + f.close() # just for completeness + + +@pytest.yield_fixture +def tmpfile(testdir): + f = testdir.makepyfile("").open('wb+') + yield f + if not f.closed: + f.close() + +@needsosdup +def test_dupfile(tmpfile): + flist = [] + for i in range(5): + nf = capture.safe_text_dupfile(tmpfile, "wb") + assert nf != tmpfile + assert nf.fileno() != tmpfile.fileno() + assert nf not in flist + print_(i, end="", file=nf) + flist.append(nf) + for i in range(5): + f = flist[i] + f.close() + tmpfile.seek(0) + s = tmpfile.read() + assert "01234" in repr(s) + tmpfile.close() + +def test_dupfile_on_bytesio(): + io = py.io.BytesIO() + f = capture.safe_text_dupfile(io, "wb") + f.write("hello") + assert io.getvalue() == b"hello" + +def test_dupfile_on_textio(): + io = py.io.TextIO() + f = capture.safe_text_dupfile(io, "wb") + f.write("hello") + assert io.getvalue() == "hello" + + +@contextlib.contextmanager +def lsof_check(): + pid = os.getpid() + try: + out = py.process.cmdexec("lsof -p %d" % pid) + except (py.process.cmdexec.Error, UnicodeDecodeError): + # about UnicodeDecodeError, see note on pytester + pytest.skip("could not run 'lsof'") + yield + out2 = py.process.cmdexec("lsof -p %d" % pid) + len1 = len([x for x in out.split("\n") if "REG" in x]) + len2 = len([x for x in out2.split("\n") if "REG" in x]) + assert len2 < len1 + 3, out2 + + +class TestFDCapture: + pytestmark = needsosdup + + def test_simple(self, tmpfile): + fd = tmpfile.fileno() + cap = capture.FDCapture(fd) + data = tobytes("hello") + os.write(fd, data) + s = cap.snap() + cap.done() + assert not s + cap = capture.FDCapture(fd) + cap.start() + os.write(fd, data) + s = cap.snap() + cap.done() + assert s == "hello" + + def test_simple_many(self, tmpfile): + for i in range(10): + self.test_simple(tmpfile) + + def test_simple_many_check_open_files(self, testdir): + with lsof_check(): + with testdir.makepyfile("").open('wb+') as tmpfile: + self.test_simple_many(tmpfile) + + def test_simple_fail_second_start(self, tmpfile): + fd = tmpfile.fileno() + cap = capture.FDCapture(fd) + cap.done() + pytest.raises(ValueError, cap.start) + + def test_stderr(self): + cap = capture.FDCapture(2) + cap.start() + print_("hello", file=sys.stderr) + s = cap.snap() + cap.done() + assert s == "hello\n" + + def test_stdin(self, tmpfile): + cap = capture.FDCapture(0) + cap.start() + x = os.read(0, 100).strip() + cap.done() + assert x == tobytes('') + + def test_writeorg(self, tmpfile): + data1, data2 = tobytes("foo"), tobytes("bar") + cap = capture.FDCapture(tmpfile.fileno()) + cap.start() + tmpfile.write(data1) + tmpfile.flush() + cap.writeorg(data2) + scap = cap.snap() + cap.done() + assert scap == totext(data1) + with open(tmpfile.name, 'rb') as stmp_file: + stmp = stmp_file.read() + assert stmp == data2 + + def test_simple_resume_suspend(self, tmpfile): + with saved_fd(1): + cap = capture.FDCapture(1) + cap.start() + data = tobytes("hello") + os.write(1, data) + sys.stdout.write("whatever") + s = cap.snap() + assert s == "hellowhatever" + cap.suspend() + os.write(1, tobytes("world")) + sys.stdout.write("qlwkej") + assert not cap.snap() + cap.resume() + os.write(1, tobytes("but now")) + sys.stdout.write(" yes\n") + s = cap.snap() + assert s == "but now yes\n" + cap.suspend() + cap.done() + pytest.raises(AttributeError, cap.suspend) + + +@contextlib.contextmanager +def saved_fd(fd): + new_fd = os.dup(fd) + try: + yield + finally: + os.dup2(new_fd, fd) + os.close(new_fd) + + +class TestStdCapture: + captureclass = staticmethod(StdCapture) + + @contextlib.contextmanager + def getcapture(self, **kw): + cap = self.__class__.captureclass(**kw) + cap.start_capturing() + try: + yield cap + finally: + cap.stop_capturing() + + def test_capturing_done_simple(self): + with self.getcapture() as cap: + sys.stdout.write("hello") + sys.stderr.write("world") + out, err = cap.readouterr() + assert out == "hello" + assert err == "world" + + def test_capturing_reset_simple(self): + with self.getcapture() as cap: + print("hello world") + sys.stderr.write("hello error\n") + out, err = cap.readouterr() + assert out == "hello world\n" + assert err == "hello error\n" + + def test_capturing_readouterr(self): + with self.getcapture() as cap: + print ("hello world") + sys.stderr.write("hello error\n") + out, err = cap.readouterr() + assert out == "hello world\n" + assert err == "hello error\n" + sys.stderr.write("error2") + out, err = cap.readouterr() + assert err == "error2" + + def test_capturing_readouterr_unicode(self): + with self.getcapture() as cap: + print ("hx\xc4\x85\xc4\x87") + out, err = cap.readouterr() + assert out == py.builtin._totext("hx\xc4\x85\xc4\x87\n", "utf8") + + @pytest.mark.skipif('sys.version_info >= (3,)', + reason='text output different for bytes on python3') + def test_capturing_readouterr_decode_error_handling(self): + with self.getcapture() as cap: + # triggered a internal error in pytest + print('\xa6') + out, err = cap.readouterr() + assert out == py.builtin._totext('\ufffd\n', 'unicode-escape') + + def test_reset_twice_error(self): + with self.getcapture() as cap: + print ("hello") + out, err = cap.readouterr() + pytest.raises(ValueError, cap.stop_capturing) + assert out == "hello\n" + assert not err + + def test_capturing_modify_sysouterr_in_between(self): + oldout = sys.stdout + olderr = sys.stderr + with self.getcapture() as cap: + sys.stdout.write("hello") + sys.stderr.write("world") + sys.stdout = capture.TextIO() + sys.stderr = capture.TextIO() + print ("not seen") + sys.stderr.write("not seen\n") + out, err = cap.readouterr() + assert out == "hello" + assert err == "world" + assert sys.stdout == oldout + assert sys.stderr == olderr + + def test_capturing_error_recursive(self): + with self.getcapture() as cap1: + print ("cap1") + with self.getcapture() as cap2: + print ("cap2") + out2, err2 = cap2.readouterr() + out1, err1 = cap1.readouterr() + assert out1 == "cap1\n" + assert out2 == "cap2\n" + + def test_just_out_capture(self): + with self.getcapture(out=True, err=False) as cap: + sys.stdout.write("hello") + sys.stderr.write("world") + out, err = cap.readouterr() + assert out == "hello" + assert not err + + def test_just_err_capture(self): + with self.getcapture(out=False, err=True) as cap: + sys.stdout.write("hello") + sys.stderr.write("world") + out, err = cap.readouterr() + assert err == "world" + assert not out + + def test_stdin_restored(self): + old = sys.stdin + with self.getcapture(in_=True): + newstdin = sys.stdin + assert newstdin != sys.stdin + assert sys.stdin is old + + def test_stdin_nulled_by_default(self): + print ("XXX this test may well hang instead of crashing") + print ("XXX which indicates an error in the underlying capturing") + print ("XXX mechanisms") + with self.getcapture(): + pytest.raises(IOError, "sys.stdin.read()") + + +class TestStdCaptureFD(TestStdCapture): + pytestmark = needsosdup + captureclass = staticmethod(StdCaptureFD) + + def test_simple_only_fd(self, testdir): + testdir.makepyfile(""" + import os + def test_x(): + os.write(1, "hello\\n".encode("ascii")) + assert 0 + """) + result = testdir.runpytest_subprocess() + result.stdout.fnmatch_lines(""" + *test_x* + *assert 0* + *Captured stdout* + """) + + def test_intermingling(self): + with self.getcapture() as cap: + oswritebytes(1, "1") + sys.stdout.write(str(2)) + sys.stdout.flush() + oswritebytes(1, "3") + oswritebytes(2, "a") + sys.stderr.write("b") + sys.stderr.flush() + oswritebytes(2, "c") + out, err = cap.readouterr() + assert out == "123" + assert err == "abc" + + def test_many(self, capfd): + with lsof_check(): + for i in range(10): + cap = StdCaptureFD() + cap.stop_capturing() + + +class TestStdCaptureFDinvalidFD: + pytestmark = needsosdup + + def test_stdcapture_fd_invalid_fd(self, testdir): + testdir.makepyfile(""" + import os + from _pytest import capture + def StdCaptureFD(out=True, err=True, in_=True): + return capture.MultiCapture(out, err, in_, + Capture=capture.FDCapture) + def test_stdout(): + os.close(1) + cap = StdCaptureFD(out=True, err=False, in_=False) + cap.stop_capturing() + def test_stderr(): + os.close(2) + cap = StdCaptureFD(out=False, err=True, in_=False) + cap.stop_capturing() + def test_stdin(): + os.close(0) + cap = StdCaptureFD(out=False, err=False, in_=True) + cap.stop_capturing() + """) + result = testdir.runpytest_subprocess("--capture=fd") + assert result.ret == 0 + assert result.parseoutcomes()['passed'] == 3 + + +def test_capture_not_started_but_reset(): + capsys = StdCapture() + capsys.stop_capturing() + + +@needsosdup +@pytest.mark.parametrize('use', [True, False]) +def test_fdcapture_tmpfile_remains_the_same(tmpfile, use): + if not use: + tmpfile = True + cap = StdCaptureFD(out=False, err=tmpfile) + try: + cap.start_capturing() + capfile = cap.err.tmpfile + cap.readouterr() + finally: + cap.stop_capturing() + capfile2 = cap.err.tmpfile + assert capfile2 == capfile + +@needsosdup +def test_close_and_capture_again(testdir): + testdir.makepyfile(""" + import os + def test_close(): + os.close(1) + def test_capture_again(): + os.write(1, b"hello\\n") + assert 0 + """) + result = testdir.runpytest_subprocess() + result.stdout.fnmatch_lines(""" + *test_capture_again* + *assert 0* + *stdout* + *hello* + """) + + + +@pytest.mark.parametrize('method', ['SysCapture', 'FDCapture']) +def test_capturing_and_logging_fundamentals(testdir, method): + if method == "StdCaptureFD" and not hasattr(os, 'dup'): + pytest.skip("need os.dup") + # here we check a fundamental feature + p = testdir.makepyfile(""" + import sys, os + import py, logging + from _pytest import capture + cap = capture.MultiCapture(out=False, in_=False, + Capture=capture.%s) + cap.start_capturing() + + logging.warn("hello1") + outerr = cap.readouterr() + print ("suspend, captured %%s" %%(outerr,)) + logging.warn("hello2") + + cap.pop_outerr_to_orig() + logging.warn("hello3") + + outerr = cap.readouterr() + print ("suspend2, captured %%s" %% (outerr,)) + """ % (method,)) + result = testdir.runpython(p) + result.stdout.fnmatch_lines(""" + suspend, captured*hello1* + suspend2, captured*WARNING:root:hello3* + """) + result.stderr.fnmatch_lines(""" + WARNING:root:hello2 + """) + assert "atexit" not in result.stderr.str() + + +def test_error_attribute_issue555(testdir): + testdir.makepyfile(""" + import sys + def test_capattr(): + assert sys.stdout.errors == "strict" + assert sys.stderr.errors == "strict" + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + +def test_dontreadfrominput_has_encoding(testdir): + testdir.makepyfile(""" + import sys + def test_capattr(): + # should not raise AttributeError + assert sys.stdout.encoding + assert sys.stderr.encoding + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + +def test_pickling_and_unpickling_enocded_file(): + # See https://bitbucket.org/pytest-dev/pytest/pull-request/194 + # pickle.loads() raises infinite recursion if + # EncodedFile.__getattr__ is not implemented properly + ef = capture.EncodedFile(None, None) + ef_as_str = pickle.dumps(ef) + pickle.loads(ef_as_str) diff --git a/testing/web-platform/tests/tools/pytest/testing/test_collection.py b/testing/web-platform/tests/tools/pytest/testing/test_collection.py new file mode 100644 index 000000000..749c5b7ce --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_collection.py @@ -0,0 +1,641 @@ +import pytest, py + +from _pytest.main import Session, EXIT_NOTESTSCOLLECTED + +class TestCollector: + def test_collect_versus_item(self): + from pytest import Collector, Item + assert not issubclass(Collector, Item) + assert not issubclass(Item, Collector) + + def test_compat_attributes(self, testdir, recwarn): + modcol = testdir.getmodulecol(""" + def test_pass(): pass + def test_fail(): assert 0 + """) + recwarn.clear() + assert modcol.Module == pytest.Module + assert modcol.Class == pytest.Class + assert modcol.Item == pytest.Item + assert modcol.File == pytest.File + assert modcol.Function == pytest.Function + + def test_check_equality(self, testdir): + modcol = testdir.getmodulecol(""" + def test_pass(): pass + def test_fail(): assert 0 + """) + fn1 = testdir.collect_by_name(modcol, "test_pass") + assert isinstance(fn1, pytest.Function) + fn2 = testdir.collect_by_name(modcol, "test_pass") + assert isinstance(fn2, pytest.Function) + + assert fn1 == fn2 + assert fn1 != modcol + if py.std.sys.version_info < (3, 0): + assert cmp(fn1, fn2) == 0 + assert hash(fn1) == hash(fn2) + + fn3 = testdir.collect_by_name(modcol, "test_fail") + assert isinstance(fn3, pytest.Function) + assert not (fn1 == fn3) + assert fn1 != fn3 + + for fn in fn1,fn2,fn3: + assert fn != 3 + assert fn != modcol + assert fn != [1,2,3] + assert [1,2,3] != fn + assert modcol != fn + + def test_getparent(self, testdir): + modcol = testdir.getmodulecol(""" + class TestClass: + def test_foo(): + pass + """) + cls = testdir.collect_by_name(modcol, "TestClass") + fn = testdir.collect_by_name( + testdir.collect_by_name(cls, "()"), "test_foo") + + parent = fn.getparent(pytest.Module) + assert parent is modcol + + parent = fn.getparent(pytest.Function) + assert parent is fn + + parent = fn.getparent(pytest.Class) + assert parent is cls + + + def test_getcustomfile_roundtrip(self, testdir): + hello = testdir.makefile(".xxx", hello="world") + testdir.makepyfile(conftest=""" + import pytest + class CustomFile(pytest.File): + pass + def pytest_collect_file(path, parent): + if path.ext == ".xxx": + return CustomFile(path, parent=parent) + """) + node = testdir.getpathnode(hello) + assert isinstance(node, pytest.File) + assert node.name == "hello.xxx" + nodes = node.session.perform_collect([node.nodeid], genitems=False) + assert len(nodes) == 1 + assert isinstance(nodes[0], pytest.File) + +class TestCollectFS: + def test_ignored_certain_directories(self, testdir): + tmpdir = testdir.tmpdir + tmpdir.ensure("_darcs", 'test_notfound.py') + tmpdir.ensure("CVS", 'test_notfound.py') + tmpdir.ensure("{arch}", 'test_notfound.py') + tmpdir.ensure(".whatever", 'test_notfound.py') + tmpdir.ensure(".bzr", 'test_notfound.py') + tmpdir.ensure("normal", 'test_found.py') + for x in tmpdir.visit("test_*.py"): + x.write("def test_hello(): pass") + + result = testdir.runpytest("--collect-only") + s = result.stdout.str() + assert "test_notfound" not in s + assert "test_found" in s + + def test_custom_norecursedirs(self, testdir): + testdir.makeini(""" + [pytest] + norecursedirs = mydir xyz* + """) + tmpdir = testdir.tmpdir + tmpdir.ensure("mydir", "test_hello.py").write("def test_1(): pass") + tmpdir.ensure("xyz123", "test_2.py").write("def test_2(): 0/0") + tmpdir.ensure("xy", "test_ok.py").write("def test_3(): pass") + rec = testdir.inline_run() + rec.assertoutcome(passed=1) + rec = testdir.inline_run("xyz123/test_2.py") + rec.assertoutcome(failed=1) + + def test_testpaths_ini(self, testdir, monkeypatch): + testdir.makeini(""" + [pytest] + testpaths = gui uts + """) + tmpdir = testdir.tmpdir + tmpdir.ensure("env", "test_1.py").write("def test_env(): pass") + tmpdir.ensure("gui", "test_2.py").write("def test_gui(): pass") + tmpdir.ensure("uts", "test_3.py").write("def test_uts(): pass") + + # executing from rootdir only tests from `testpaths` directories + # are collected + items, reprec = testdir.inline_genitems('-v') + assert [x.name for x in items] == ['test_gui', 'test_uts'] + + # check that explicitly passing directories in the command-line + # collects the tests + for dirname in ('env', 'gui', 'uts'): + items, reprec = testdir.inline_genitems(tmpdir.join(dirname)) + assert [x.name for x in items] == ['test_%s' % dirname] + + # changing cwd to each subdirectory and running pytest without + # arguments collects the tests in that directory normally + for dirname in ('env', 'gui', 'uts'): + monkeypatch.chdir(testdir.tmpdir.join(dirname)) + items, reprec = testdir.inline_genitems() + assert [x.name for x in items] == ['test_%s' % dirname] + + +class TestCollectPluginHookRelay: + def test_pytest_collect_file(self, testdir): + wascalled = [] + class Plugin: + def pytest_collect_file(self, path, parent): + wascalled.append(path) + testdir.makefile(".abc", "xyz") + pytest.main([testdir.tmpdir], plugins=[Plugin()]) + assert len(wascalled) == 1 + assert wascalled[0].ext == '.abc' + + def test_pytest_collect_directory(self, testdir): + wascalled = [] + class Plugin: + def pytest_collect_directory(self, path, parent): + wascalled.append(path.basename) + testdir.mkdir("hello") + testdir.mkdir("world") + pytest.main(testdir.tmpdir, plugins=[Plugin()]) + assert "hello" in wascalled + assert "world" in wascalled + +class TestPrunetraceback: + def test_collection_error(self, testdir): + p = testdir.makepyfile(""" + import not_exists + """) + result = testdir.runpytest(p) + assert "__import__" not in result.stdout.str(), "too long traceback" + result.stdout.fnmatch_lines([ + "*ERROR collecting*", + "*mport*not_exists*" + ]) + + def test_custom_repr_failure(self, testdir): + p = testdir.makepyfile(""" + import not_exists + """) + testdir.makeconftest(""" + import pytest + def pytest_collect_file(path, parent): + return MyFile(path, parent) + class MyError(Exception): + pass + class MyFile(pytest.File): + def collect(self): + raise MyError() + def repr_failure(self, excinfo): + if excinfo.errisinstance(MyError): + return "hello world" + return pytest.File.repr_failure(self, excinfo) + """) + + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*ERROR collecting*", + "*hello world*", + ]) + + @pytest.mark.xfail(reason="other mechanism for adding to reporting needed") + def test_collect_report_postprocessing(self, testdir): + p = testdir.makepyfile(""" + import not_exists + """) + testdir.makeconftest(""" + import pytest + def pytest_make_collect_report(__multicall__): + rep = __multicall__.execute() + rep.headerlines += ["header1"] + return rep + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*ERROR collecting*", + "*header1*", + ]) + + +class TestCustomConftests: + def test_ignore_collect_path(self, testdir): + testdir.makeconftest(""" + def pytest_ignore_collect(path, config): + return path.basename.startswith("x") or \ + path.basename == "test_one.py" + """) + sub = testdir.mkdir("xy123") + sub.ensure("test_hello.py").write("syntax error") + sub.join("conftest.py").write("syntax error") + testdir.makepyfile("def test_hello(): pass") + testdir.makepyfile(test_one="syntax error") + result = testdir.runpytest("--fulltrace") + assert result.ret == 0 + result.stdout.fnmatch_lines(["*1 passed*"]) + + def test_ignore_collect_not_called_on_argument(self, testdir): + testdir.makeconftest(""" + def pytest_ignore_collect(path, config): + return True + """) + p = testdir.makepyfile("def test_hello(): pass") + result = testdir.runpytest(p) + assert result.ret == 0 + result.stdout.fnmatch_lines("*1 passed*") + result = testdir.runpytest() + assert result.ret == EXIT_NOTESTSCOLLECTED + result.stdout.fnmatch_lines("*collected 0 items*") + + def test_collectignore_exclude_on_option(self, testdir): + testdir.makeconftest(""" + collect_ignore = ['hello', 'test_world.py'] + def pytest_addoption(parser): + parser.addoption("--XX", action="store_true", default=False) + def pytest_configure(config): + if config.getvalue("XX"): + collect_ignore[:] = [] + """) + testdir.mkdir("hello") + testdir.makepyfile(test_world="def test_hello(): pass") + result = testdir.runpytest() + assert result.ret == EXIT_NOTESTSCOLLECTED + assert "passed" not in result.stdout.str() + result = testdir.runpytest("--XX") + assert result.ret == 0 + assert "passed" in result.stdout.str() + + def test_pytest_fs_collect_hooks_are_seen(self, testdir): + testdir.makeconftest(""" + import pytest + class MyModule(pytest.Module): + pass + def pytest_collect_file(path, parent): + if path.ext == ".py": + return MyModule(path, parent) + """) + testdir.mkdir("sub") + testdir.makepyfile("def test_x(): pass") + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*MyModule*", + "*test_x*" + ]) + + def test_pytest_collect_file_from_sister_dir(self, testdir): + sub1 = testdir.mkpydir("sub1") + sub2 = testdir.mkpydir("sub2") + conf1 = testdir.makeconftest(""" + import pytest + class MyModule1(pytest.Module): + pass + def pytest_collect_file(path, parent): + if path.ext == ".py": + return MyModule1(path, parent) + """) + conf1.move(sub1.join(conf1.basename)) + conf2 = testdir.makeconftest(""" + import pytest + class MyModule2(pytest.Module): + pass + def pytest_collect_file(path, parent): + if path.ext == ".py": + return MyModule2(path, parent) + """) + conf2.move(sub2.join(conf2.basename)) + p = testdir.makepyfile("def test_x(): pass") + p.copy(sub1.join(p.basename)) + p.copy(sub2.join(p.basename)) + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*MyModule1*", + "*MyModule2*", + "*test_x*" + ]) + +class TestSession: + def test_parsearg(self, testdir): + p = testdir.makepyfile("def test_func(): pass") + subdir = testdir.mkdir("sub") + subdir.ensure("__init__.py") + target = subdir.join(p.basename) + p.move(target) + subdir.chdir() + config = testdir.parseconfig(p.basename) + rcol = Session(config=config) + assert rcol.fspath == subdir + parts = rcol._parsearg(p.basename) + + assert parts[0] == target + assert len(parts) == 1 + parts = rcol._parsearg(p.basename + "::test_func") + assert parts[0] == target + assert parts[1] == "test_func" + assert len(parts) == 2 + + def test_collect_topdir(self, testdir): + p = testdir.makepyfile("def test_func(): pass") + id = "::".join([p.basename, "test_func"]) + # XXX migrate to collectonly? (see below) + config = testdir.parseconfig(id) + topdir = testdir.tmpdir + rcol = Session(config) + assert topdir == rcol.fspath + #rootid = rcol.nodeid + #root2 = rcol.perform_collect([rcol.nodeid], genitems=False)[0] + #assert root2 == rcol, rootid + colitems = rcol.perform_collect([rcol.nodeid], genitems=False) + assert len(colitems) == 1 + assert colitems[0].fspath == p + + + def test_collect_protocol_single_function(self, testdir): + p = testdir.makepyfile("def test_func(): pass") + id = "::".join([p.basename, "test_func"]) + items, hookrec = testdir.inline_genitems(id) + item, = items + assert item.name == "test_func" + newid = item.nodeid + assert newid == id + py.std.pprint.pprint(hookrec.calls) + topdir = testdir.tmpdir # noqa + hookrec.assert_contains([ + ("pytest_collectstart", "collector.fspath == topdir"), + ("pytest_make_collect_report", "collector.fspath == topdir"), + ("pytest_collectstart", "collector.fspath == p"), + ("pytest_make_collect_report", "collector.fspath == p"), + ("pytest_pycollect_makeitem", "name == 'test_func'"), + ("pytest_collectreport", "report.nodeid.startswith(p.basename)"), + ("pytest_collectreport", "report.nodeid == ''") + ]) + + def test_collect_protocol_method(self, testdir): + p = testdir.makepyfile(""" + class TestClass: + def test_method(self): + pass + """) + normid = p.basename + "::TestClass::()::test_method" + for id in [p.basename, + p.basename + "::TestClass", + p.basename + "::TestClass::()", + normid, + ]: + items, hookrec = testdir.inline_genitems(id) + assert len(items) == 1 + assert items[0].name == "test_method" + newid = items[0].nodeid + assert newid == normid + + def test_collect_custom_nodes_multi_id(self, testdir): + p = testdir.makepyfile("def test_func(): pass") + testdir.makeconftest(""" + import pytest + class SpecialItem(pytest.Item): + def runtest(self): + return # ok + class SpecialFile(pytest.File): + def collect(self): + return [SpecialItem(name="check", parent=self)] + def pytest_collect_file(path, parent): + if path.basename == %r: + return SpecialFile(fspath=path, parent=parent) + """ % p.basename) + id = p.basename + + items, hookrec = testdir.inline_genitems(id) + py.std.pprint.pprint(hookrec.calls) + assert len(items) == 2 + hookrec.assert_contains([ + ("pytest_collectstart", + "collector.fspath == collector.session.fspath"), + ("pytest_collectstart", + "collector.__class__.__name__ == 'SpecialFile'"), + ("pytest_collectstart", + "collector.__class__.__name__ == 'Module'"), + ("pytest_pycollect_makeitem", "name == 'test_func'"), + ("pytest_collectreport", "report.nodeid.startswith(p.basename)"), + #("pytest_collectreport", + # "report.fspath == %r" % str(rcol.fspath)), + ]) + + def test_collect_subdir_event_ordering(self, testdir): + p = testdir.makepyfile("def test_func(): pass") + aaa = testdir.mkpydir("aaa") + test_aaa = aaa.join("test_aaa.py") + p.move(test_aaa) + + items, hookrec = testdir.inline_genitems() + assert len(items) == 1 + py.std.pprint.pprint(hookrec.calls) + hookrec.assert_contains([ + ("pytest_collectstart", "collector.fspath == test_aaa"), + ("pytest_pycollect_makeitem", "name == 'test_func'"), + ("pytest_collectreport", + "report.nodeid.startswith('aaa/test_aaa.py')"), + ]) + + def test_collect_two_commandline_args(self, testdir): + p = testdir.makepyfile("def test_func(): pass") + aaa = testdir.mkpydir("aaa") + bbb = testdir.mkpydir("bbb") + test_aaa = aaa.join("test_aaa.py") + p.copy(test_aaa) + test_bbb = bbb.join("test_bbb.py") + p.move(test_bbb) + + id = "." + + items, hookrec = testdir.inline_genitems(id) + assert len(items) == 2 + py.std.pprint.pprint(hookrec.calls) + hookrec.assert_contains([ + ("pytest_collectstart", "collector.fspath == test_aaa"), + ("pytest_pycollect_makeitem", "name == 'test_func'"), + ("pytest_collectreport", "report.nodeid == 'aaa/test_aaa.py'"), + ("pytest_collectstart", "collector.fspath == test_bbb"), + ("pytest_pycollect_makeitem", "name == 'test_func'"), + ("pytest_collectreport", "report.nodeid == 'bbb/test_bbb.py'"), + ]) + + def test_serialization_byid(self, testdir): + testdir.makepyfile("def test_func(): pass") + items, hookrec = testdir.inline_genitems() + assert len(items) == 1 + item, = items + items2, hookrec = testdir.inline_genitems(item.nodeid) + item2, = items2 + assert item2.name == item.name + assert item2.fspath == item.fspath + + def test_find_byid_without_instance_parents(self, testdir): + p = testdir.makepyfile(""" + class TestClass: + def test_method(self): + pass + """) + arg = p.basename + ("::TestClass::test_method") + items, hookrec = testdir.inline_genitems(arg) + assert len(items) == 1 + item, = items + assert item.nodeid.endswith("TestClass::()::test_method") + +class Test_getinitialnodes: + def test_global_file(self, testdir, tmpdir): + x = tmpdir.ensure("x.py") + config = testdir.parseconfigure(x) + col = testdir.getnode(config, x) + assert isinstance(col, pytest.Module) + assert col.name == 'x.py' + assert col.parent.name == testdir.tmpdir.basename + assert col.parent.parent is None + for col in col.listchain(): + assert col.config is config + + def test_pkgfile(self, testdir): + tmpdir = testdir.tmpdir + subdir = tmpdir.join("subdir") + x = subdir.ensure("x.py") + subdir.ensure("__init__.py") + config = testdir.parseconfigure(x) + col = testdir.getnode(config, x) + assert isinstance(col, pytest.Module) + assert col.name == 'x.py' + assert col.parent.parent is None + for col in col.listchain(): + assert col.config is config + +class Test_genitems: + def test_check_collect_hashes(self, testdir): + p = testdir.makepyfile(""" + def test_1(): + pass + + def test_2(): + pass + """) + p.copy(p.dirpath(p.purebasename + "2" + ".py")) + items, reprec = testdir.inline_genitems(p.dirpath()) + assert len(items) == 4 + for numi, i in enumerate(items): + for numj, j in enumerate(items): + if numj != numi: + assert hash(i) != hash(j) + assert i != j + + def test_example_items1(self, testdir): + p = testdir.makepyfile(''' + def testone(): + pass + + class TestX: + def testmethod_one(self): + pass + + class TestY(TestX): + pass + ''') + items, reprec = testdir.inline_genitems(p) + assert len(items) == 3 + assert items[0].name == 'testone' + assert items[1].name == 'testmethod_one' + assert items[2].name == 'testmethod_one' + + # let's also test getmodpath here + assert items[0].getmodpath() == "testone" + assert items[1].getmodpath() == "TestX.testmethod_one" + assert items[2].getmodpath() == "TestY.testmethod_one" + + s = items[0].getmodpath(stopatmodule=False) + assert s.endswith("test_example_items1.testone") + print(s) + + def test_class_and_functions_discovery_using_glob(self, testdir): + """ + tests that python_classes and python_functions config options work + as prefixes and glob-like patterns (issue #600). + """ + testdir.makeini(""" + [pytest] + python_classes = *Suite Test + python_functions = *_test test + """) + p = testdir.makepyfile(''' + class MyTestSuite: + def x_test(self): + pass + + class TestCase: + def test_y(self): + pass + ''') + items, reprec = testdir.inline_genitems(p) + ids = [x.getmodpath() for x in items] + assert ids == ['MyTestSuite.x_test', 'TestCase.test_y'] + + +def test_matchnodes_two_collections_same_file(testdir): + testdir.makeconftest(""" + import pytest + def pytest_configure(config): + config.pluginmanager.register(Plugin2()) + + class Plugin2: + def pytest_collect_file(self, path, parent): + if path.ext == ".abc": + return MyFile2(path, parent) + + def pytest_collect_file(path, parent): + if path.ext == ".abc": + return MyFile1(path, parent) + + class MyFile1(pytest.Item, pytest.File): + def runtest(self): + pass + class MyFile2(pytest.File): + def collect(self): + return [Item2("hello", parent=self)] + + class Item2(pytest.Item): + def runtest(self): + pass + """) + p = testdir.makefile(".abc", "") + result = testdir.runpytest() + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*2 passed*", + ]) + res = testdir.runpytest("%s::hello" % p.basename) + res.stdout.fnmatch_lines([ + "*1 passed*", + ]) + + +class TestNodekeywords: + def test_no_under(self, testdir): + modcol = testdir.getmodulecol(""" + def test_pass(): pass + def test_fail(): assert 0 + """) + l = list(modcol.keywords) + assert modcol.name in l + for x in l: + assert not x.startswith("_") + assert modcol.name in repr(modcol.keywords) + + def test_issue345(self, testdir): + testdir.makepyfile(""" + def test_should_not_be_selected(): + assert False, 'I should not have been selected to run' + + def test___repr__(): + pass + """) + reprec = testdir.inline_run("-k repr") + reprec.assertoutcome(passed=1, failed=0) diff --git a/testing/web-platform/tests/tools/pytest/testing/test_config.py b/testing/web-platform/tests/tools/pytest/testing/test_config.py new file mode 100644 index 000000000..92c9bdb8b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_config.py @@ -0,0 +1,570 @@ +import py, pytest + +import _pytest._code +from _pytest.config import getcfg, get_common_ancestor, determine_setup +from _pytest.main import EXIT_NOTESTSCOLLECTED + +class TestParseIni: + def test_getcfg_and_config(self, testdir, tmpdir): + sub = tmpdir.mkdir("sub") + sub.chdir() + tmpdir.join("setup.cfg").write(_pytest._code.Source(""" + [pytest] + name = value + """)) + rootdir, inifile, cfg = getcfg([sub], ["setup.cfg"]) + assert cfg['name'] == "value" + config = testdir.parseconfigure(sub) + assert config.inicfg['name'] == 'value' + + def test_getcfg_empty_path(self, tmpdir): + getcfg([''], ['setup.cfg']) #happens on py.test "" + + def test_append_parse_args(self, testdir, tmpdir, monkeypatch): + monkeypatch.setenv('PYTEST_ADDOPTS', '--color no -rs --tb="short"') + tmpdir.join("setup.cfg").write(_pytest._code.Source(""" + [pytest] + addopts = --verbose + """)) + config = testdir.parseconfig(tmpdir) + assert config.option.color == 'no' + assert config.option.reportchars == 's' + assert config.option.tbstyle == 'short' + assert config.option.verbose + #config = testdir.Config() + #args = [tmpdir,] + #config._preparse(args, addopts=False) + #assert len(args) == 1 + + def test_tox_ini_wrong_version(self, testdir): + testdir.makefile('.ini', tox=""" + [pytest] + minversion=9.0 + """) + result = testdir.runpytest() + assert result.ret != 0 + result.stderr.fnmatch_lines([ + "*tox.ini:2*requires*9.0*actual*" + ]) + + @pytest.mark.parametrize("name", "setup.cfg tox.ini pytest.ini".split()) + def test_ini_names(self, testdir, name): + testdir.tmpdir.join(name).write(py.std.textwrap.dedent(""" + [pytest] + minversion = 1.0 + """)) + config = testdir.parseconfig() + assert config.getini("minversion") == "1.0" + + def test_toxini_before_lower_pytestini(self, testdir): + sub = testdir.tmpdir.mkdir("sub") + sub.join("tox.ini").write(py.std.textwrap.dedent(""" + [pytest] + minversion = 2.0 + """)) + testdir.tmpdir.join("pytest.ini").write(py.std.textwrap.dedent(""" + [pytest] + minversion = 1.5 + """)) + config = testdir.parseconfigure(sub) + assert config.getini("minversion") == "2.0" + + @pytest.mark.xfail(reason="probably not needed") + def test_confcutdir(self, testdir): + sub = testdir.mkdir("sub") + sub.chdir() + testdir.makeini(""" + [pytest] + addopts = --qwe + """) + result = testdir.inline_run("--confcutdir=.") + assert result.ret == 0 + +class TestConfigCmdlineParsing: + def test_parsing_again_fails(self, testdir): + config = testdir.parseconfig() + pytest.raises(AssertionError, lambda: config.parse([])) + + def test_explicitly_specified_config_file_is_loaded(self, testdir): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addini("custom", "") + """) + testdir.makeini(""" + [pytest] + custom = 0 + """) + testdir.makefile(".cfg", custom = """ + [pytest] + custom = 1 + """) + config = testdir.parseconfig("-c", "custom.cfg") + assert config.getini("custom") == "1" + +class TestConfigAPI: + def test_config_trace(self, testdir): + config = testdir.parseconfig() + l = [] + config.trace.root.setwriter(l.append) + config.trace("hello") + assert len(l) == 1 + assert l[0] == "hello [config]\n" + + def test_config_getoption(self, testdir): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addoption("--hello", "-X", dest="hello") + """) + config = testdir.parseconfig("--hello=this") + for x in ("hello", "--hello", "-X"): + assert config.getoption(x) == "this" + pytest.raises(ValueError, "config.getoption('qweqwe')") + + @pytest.mark.skipif('sys.version_info[:2] not in [(2, 6), (2, 7)]') + def test_config_getoption_unicode(self, testdir): + testdir.makeconftest(""" + from __future__ import unicode_literals + + def pytest_addoption(parser): + parser.addoption('--hello', type='string') + """) + config = testdir.parseconfig('--hello=this') + assert config.getoption('hello') == 'this' + + def test_config_getvalueorskip(self, testdir): + config = testdir.parseconfig() + pytest.raises(pytest.skip.Exception, + "config.getvalueorskip('hello')") + verbose = config.getvalueorskip("verbose") + assert verbose == config.option.verbose + + def test_config_getvalueorskip_None(self, testdir): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addoption("--hello") + """) + config = testdir.parseconfig() + with pytest.raises(pytest.skip.Exception): + config.getvalueorskip('hello') + + def test_getoption(self, testdir): + config = testdir.parseconfig() + with pytest.raises(ValueError): + config.getvalue('x') + assert config.getoption("x", 1) == 1 + + def test_getconftest_pathlist(self, testdir, tmpdir): + somepath = tmpdir.join("x", "y", "z") + p = tmpdir.join("conftest.py") + p.write("pathlist = ['.', %r]" % str(somepath)) + config = testdir.parseconfigure(p) + assert config._getconftest_pathlist('notexist', path=tmpdir) is None + pl = config._getconftest_pathlist('pathlist', path=tmpdir) + print(pl) + assert len(pl) == 2 + assert pl[0] == tmpdir + assert pl[1] == somepath + + def test_addini(self, testdir): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addini("myname", "my new ini value") + """) + testdir.makeini(""" + [pytest] + myname=hello + """) + config = testdir.parseconfig() + val = config.getini("myname") + assert val == "hello" + pytest.raises(ValueError, config.getini, 'other') + + def test_addini_pathlist(self, testdir): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addini("paths", "my new ini value", type="pathlist") + parser.addini("abc", "abc value") + """) + p = testdir.makeini(""" + [pytest] + paths=hello world/sub.py + """) + config = testdir.parseconfig() + l = config.getini("paths") + assert len(l) == 2 + assert l[0] == p.dirpath('hello') + assert l[1] == p.dirpath('world/sub.py') + pytest.raises(ValueError, config.getini, 'other') + + def test_addini_args(self, testdir): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addini("args", "new args", type="args") + parser.addini("a2", "", "args", default="1 2 3".split()) + """) + testdir.makeini(""" + [pytest] + args=123 "123 hello" "this" + """) + config = testdir.parseconfig() + l = config.getini("args") + assert len(l) == 3 + assert l == ["123", "123 hello", "this"] + l = config.getini("a2") + assert l == list("123") + + def test_addini_linelist(self, testdir): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addini("xy", "", type="linelist") + parser.addini("a2", "", "linelist") + """) + testdir.makeini(""" + [pytest] + xy= 123 345 + second line + """) + config = testdir.parseconfig() + l = config.getini("xy") + assert len(l) == 2 + assert l == ["123 345", "second line"] + l = config.getini("a2") + assert l == [] + + @pytest.mark.parametrize('str_val, bool_val', + [('True', True), ('no', False), ('no-ini', True)]) + def test_addini_bool(self, testdir, str_val, bool_val): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addini("strip", "", type="bool", default=True) + """) + if str_val != 'no-ini': + testdir.makeini(""" + [pytest] + strip=%s + """ % str_val) + config = testdir.parseconfig() + assert config.getini("strip") is bool_val + + def test_addinivalue_line_existing(self, testdir): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addini("xy", "", type="linelist") + """) + testdir.makeini(""" + [pytest] + xy= 123 + """) + config = testdir.parseconfig() + l = config.getini("xy") + assert len(l) == 1 + assert l == ["123"] + config.addinivalue_line("xy", "456") + l = config.getini("xy") + assert len(l) == 2 + assert l == ["123", "456"] + + def test_addinivalue_line_new(self, testdir): + testdir.makeconftest(""" + def pytest_addoption(parser): + parser.addini("xy", "", type="linelist") + """) + config = testdir.parseconfig() + assert not config.getini("xy") + config.addinivalue_line("xy", "456") + l = config.getini("xy") + assert len(l) == 1 + assert l == ["456"] + config.addinivalue_line("xy", "123") + l = config.getini("xy") + assert len(l) == 2 + assert l == ["456", "123"] + + +class TestConfigFromdictargs: + def test_basic_behavior(self): + from _pytest.config import Config + option_dict = { + 'verbose': 444, + 'foo': 'bar', + 'capture': 'no', + } + args = ['a', 'b'] + + config = Config.fromdictargs(option_dict, args) + with pytest.raises(AssertionError): + config.parse(['should refuse to parse again']) + assert config.option.verbose == 444 + assert config.option.foo == 'bar' + assert config.option.capture == 'no' + assert config.args == args + + def test_origargs(self): + """Show that fromdictargs can handle args in their "orig" format""" + from _pytest.config import Config + option_dict = {} + args = ['-vvvv', '-s', 'a', 'b'] + + config = Config.fromdictargs(option_dict, args) + assert config.args == ['a', 'b'] + assert config._origargs == args + assert config.option.verbose == 4 + assert config.option.capture == 'no' + + def test_inifilename(self, tmpdir): + tmpdir.join("foo/bar.ini").ensure().write(_pytest._code.Source(""" + [pytest] + name = value + """)) + + from _pytest.config import Config + inifile = '../../foo/bar.ini' + option_dict = { + 'inifilename': inifile, + 'capture': 'no', + } + + cwd = tmpdir.join('a/b') + cwd.join('pytest.ini').ensure().write(_pytest._code.Source(""" + [pytest] + name = wrong-value + should_not_be_set = true + """)) + with cwd.ensure(dir=True).as_cwd(): + config = Config.fromdictargs(option_dict, ()) + + assert config.args == [str(cwd)] + assert config.option.inifilename == inifile + assert config.option.capture == 'no' + + # this indicates this is the file used for getting configuration values + assert config.inifile == inifile + assert config.inicfg.get('name') == 'value' + assert config.inicfg.get('should_not_be_set') is None + + +def test_options_on_small_file_do_not_blow_up(testdir): + def runfiletest(opts): + reprec = testdir.inline_run(*opts) + passed, skipped, failed = reprec.countoutcomes() + assert failed == 2 + assert skipped == passed == 0 + path = testdir.makepyfile(""" + def test_f1(): assert 0 + def test_f2(): assert 0 + """) + + for opts in ([], ['-l'], ['-s'], ['--tb=no'], ['--tb=short'], + ['--tb=long'], ['--fulltrace'], ['--nomagic'], + ['--traceconfig'], ['-v'], ['-v', '-v']): + runfiletest(opts + [path]) + +def test_preparse_ordering_with_setuptools(testdir, monkeypatch): + pkg_resources = pytest.importorskip("pkg_resources") + def my_iter(name): + assert name == "pytest11" + class EntryPoint: + name = "mytestplugin" + class dist: + pass + def load(self): + class PseudoPlugin: + x = 42 + return PseudoPlugin() + return iter([EntryPoint()]) + monkeypatch.setattr(pkg_resources, 'iter_entry_points', my_iter) + testdir.makeconftest(""" + pytest_plugins = "mytestplugin", + """) + monkeypatch.setenv("PYTEST_PLUGINS", "mytestplugin") + config = testdir.parseconfig() + plugin = config.pluginmanager.getplugin("mytestplugin") + assert plugin.x == 42 + +def test_plugin_preparse_prevents_setuptools_loading(testdir, monkeypatch): + pkg_resources = pytest.importorskip("pkg_resources") + def my_iter(name): + assert name == "pytest11" + class EntryPoint: + name = "mytestplugin" + def load(self): + assert 0, "should not arrive here" + return iter([EntryPoint()]) + monkeypatch.setattr(pkg_resources, 'iter_entry_points', my_iter) + config = testdir.parseconfig("-p", "no:mytestplugin") + plugin = config.pluginmanager.getplugin("mytestplugin") + assert plugin is None + +def test_cmdline_processargs_simple(testdir): + testdir.makeconftest(""" + def pytest_cmdline_preparse(args): + args.append("-h") + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*pytest*", + "*-h*", + ]) + +def test_invalid_options_show_extra_information(testdir): + """display extra information when pytest exits due to unrecognized + options in the command-line""" + testdir.makeini(""" + [pytest] + addopts = --invalid-option + """) + result = testdir.runpytest() + result.stderr.fnmatch_lines([ + "*error: unrecognized arguments: --invalid-option*", + "* inifile: %s*" % testdir.tmpdir.join('tox.ini'), + "* rootdir: %s*" % testdir.tmpdir, + ]) + + +@pytest.mark.parametrize('args', [ + ['dir1', 'dir2', '-v'], + ['dir1', '-v', 'dir2'], + ['dir2', '-v', 'dir1'], + ['-v', 'dir2', 'dir1'], +]) +def test_consider_args_after_options_for_rootdir_and_inifile(testdir, args): + """ + Consider all arguments in the command-line for rootdir and inifile + discovery, even if they happen to occur after an option. #949 + """ + # replace "dir1" and "dir2" from "args" into their real directory + root = testdir.tmpdir.mkdir('myroot') + d1 = root.mkdir('dir1') + d2 = root.mkdir('dir2') + for i, arg in enumerate(args): + if arg == 'dir1': + args[i] = d1 + elif arg == 'dir2': + args[i] = d2 + result = testdir.runpytest(*args) + result.stdout.fnmatch_lines(['*rootdir: *myroot, inifile: ']) + + +@pytest.mark.skipif("sys.platform == 'win32'") +def test_toolongargs_issue224(testdir): + result = testdir.runpytest("-m", "hello" * 500) + assert result.ret == EXIT_NOTESTSCOLLECTED + +def test_notify_exception(testdir, capfd): + config = testdir.parseconfig() + excinfo = pytest.raises(ValueError, "raise ValueError(1)") + config.notify_exception(excinfo) + out, err = capfd.readouterr() + assert "ValueError" in err + class A: + def pytest_internalerror(self, excrepr): + return True + config.pluginmanager.register(A()) + config.notify_exception(excinfo) + out, err = capfd.readouterr() + assert not err + + +def test_load_initial_conftest_last_ordering(testdir): + from _pytest.config import get_config + pm = get_config().pluginmanager + class My: + def pytest_load_initial_conftests(self): + pass + m = My() + pm.register(m) + hc = pm.hook.pytest_load_initial_conftests + l = hc._nonwrappers + hc._wrappers + assert l[-1].function.__module__ == "_pytest.capture" + assert l[-2].function == m.pytest_load_initial_conftests + assert l[-3].function.__module__ == "_pytest.config" + +class TestWarning: + def test_warn_config(self, testdir): + testdir.makeconftest(""" + l = [] + def pytest_configure(config): + config.warn("C1", "hello") + def pytest_logwarning(code, message): + if message == "hello" and code == "C1": + l.append(1) + """) + testdir.makepyfile(""" + def test_proper(pytestconfig): + import conftest + assert conftest.l == [1] + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_warn_on_test_item_from_request(self, testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture + def fix(request): + request.node.warn("T1", "hello") + def test_hello(fix): + pass + """) + result = testdir.runpytest() + assert result.parseoutcomes()["pytest-warnings"] > 0 + assert "hello" not in result.stdout.str() + + result = testdir.runpytest("-rw") + result.stdout.fnmatch_lines(""" + ===*pytest-warning summary*=== + *WT1*test_warn_on_test_item*:5*hello* + """) + +class TestRootdir: + def test_simple_noini(self, tmpdir): + assert get_common_ancestor([tmpdir]) == tmpdir + assert get_common_ancestor([tmpdir.mkdir("a"), tmpdir]) == tmpdir + assert get_common_ancestor([tmpdir, tmpdir.join("a")]) == tmpdir + with tmpdir.as_cwd(): + assert get_common_ancestor([]) == tmpdir + + @pytest.mark.parametrize("name", "setup.cfg tox.ini pytest.ini".split()) + def test_with_ini(self, tmpdir, name): + inifile = tmpdir.join(name) + inifile.write("[pytest]\n") + + a = tmpdir.mkdir("a") + b = a.mkdir("b") + for args in ([tmpdir], [a], [b]): + rootdir, inifile, inicfg = determine_setup(None, args) + assert rootdir == tmpdir + assert inifile == inifile + rootdir, inifile, inicfg = determine_setup(None, [b,a]) + assert rootdir == tmpdir + assert inifile == inifile + + @pytest.mark.parametrize("name", "setup.cfg tox.ini".split()) + def test_pytestini_overides_empty_other(self, tmpdir, name): + inifile = tmpdir.ensure("pytest.ini") + a = tmpdir.mkdir("a") + a.ensure(name) + rootdir, inifile, inicfg = determine_setup(None, [a]) + assert rootdir == tmpdir + assert inifile == inifile + + def test_setuppy_fallback(self, tmpdir): + a = tmpdir.mkdir("a") + a.ensure("setup.cfg") + tmpdir.ensure("setup.py") + rootdir, inifile, inicfg = determine_setup(None, [a]) + assert rootdir == tmpdir + assert inifile is None + assert inicfg == {} + + def test_nothing(self, tmpdir): + rootdir, inifile, inicfg = determine_setup(None, [tmpdir]) + assert rootdir == tmpdir + assert inifile is None + assert inicfg == {} + + def test_with_specific_inifile(self, tmpdir): + inifile = tmpdir.ensure("pytest.ini") + rootdir, inifile, inicfg = determine_setup(inifile, [tmpdir]) + assert rootdir == tmpdir diff --git a/testing/web-platform/tests/tools/pytest/testing/test_conftest.py b/testing/web-platform/tests/tools/pytest/testing/test_conftest.py new file mode 100644 index 000000000..6f5e77f6d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_conftest.py @@ -0,0 +1,409 @@ +from textwrap import dedent + +import _pytest._code +import py +import pytest +from _pytest.config import PytestPluginManager +from _pytest.main import EXIT_NOTESTSCOLLECTED, EXIT_USAGEERROR + + +@pytest.fixture(scope="module", params=["global", "inpackage"]) +def basedir(request, tmpdir_factory): + from _pytest.tmpdir import tmpdir + tmpdir = tmpdir(request, tmpdir_factory) + tmpdir.ensure("adir/conftest.py").write("a=1 ; Directory = 3") + tmpdir.ensure("adir/b/conftest.py").write("b=2 ; a = 1.5") + if request.param == "inpackage": + tmpdir.ensure("adir/__init__.py") + tmpdir.ensure("adir/b/__init__.py") + return tmpdir + +def ConftestWithSetinitial(path): + conftest = PytestPluginManager() + conftest_setinitial(conftest, [path]) + return conftest + +def conftest_setinitial(conftest, args, confcutdir=None): + class Namespace: + def __init__(self): + self.file_or_dir = args + self.confcutdir = str(confcutdir) + self.noconftest = False + conftest._set_initial_conftests(Namespace()) + +class TestConftestValueAccessGlobal: + def test_basic_init(self, basedir): + conftest = PytestPluginManager() + p = basedir.join("adir") + assert conftest._rget_with_confmod("a", p)[1] == 1 + + def test_immediate_initialiation_and_incremental_are_the_same(self, basedir): + conftest = PytestPluginManager() + len(conftest._path2confmods) + conftest._getconftestmodules(basedir) + snap1 = len(conftest._path2confmods) + #assert len(conftest._path2confmods) == snap1 + 1 + conftest._getconftestmodules(basedir.join('adir')) + assert len(conftest._path2confmods) == snap1 + 1 + conftest._getconftestmodules(basedir.join('b')) + assert len(conftest._path2confmods) == snap1 + 2 + + def test_value_access_not_existing(self, basedir): + conftest = ConftestWithSetinitial(basedir) + with pytest.raises(KeyError): + conftest._rget_with_confmod('a', basedir) + + def test_value_access_by_path(self, basedir): + conftest = ConftestWithSetinitial(basedir) + adir = basedir.join("adir") + assert conftest._rget_with_confmod("a", adir)[1] == 1 + assert conftest._rget_with_confmod("a", adir.join("b"))[1] == 1.5 + + def test_value_access_with_confmod(self, basedir): + startdir = basedir.join("adir", "b") + startdir.ensure("xx", dir=True) + conftest = ConftestWithSetinitial(startdir) + mod, value = conftest._rget_with_confmod("a", startdir) + assert value == 1.5 + path = py.path.local(mod.__file__) + assert path.dirpath() == basedir.join("adir", "b") + assert path.purebasename.startswith("conftest") + +def test_conftest_in_nonpkg_with_init(tmpdir): + tmpdir.ensure("adir-1.0/conftest.py").write("a=1 ; Directory = 3") + tmpdir.ensure("adir-1.0/b/conftest.py").write("b=2 ; a = 1.5") + tmpdir.ensure("adir-1.0/b/__init__.py") + tmpdir.ensure("adir-1.0/__init__.py") + ConftestWithSetinitial(tmpdir.join("adir-1.0", "b")) + +def test_doubledash_considered(testdir): + conf = testdir.mkdir("--option") + conf.join("conftest.py").ensure() + conftest = PytestPluginManager() + conftest_setinitial(conftest, [conf.basename, conf.basename]) + l = conftest._getconftestmodules(conf) + assert len(l) == 1 + +def test_issue151_load_all_conftests(testdir): + names = "code proj src".split() + for name in names: + p = testdir.mkdir(name) + p.ensure("conftest.py") + + conftest = PytestPluginManager() + conftest_setinitial(conftest, names) + d = list(conftest._conftestpath2mod.values()) + assert len(d) == len(names) + +def test_conftest_global_import(testdir): + testdir.makeconftest("x=3") + p = testdir.makepyfile(""" + import py, pytest + from _pytest.config import PytestPluginManager + conf = PytestPluginManager() + mod = conf._importconftest(py.path.local("conftest.py")) + assert mod.x == 3 + import conftest + assert conftest is mod, (conftest, mod) + subconf = py.path.local().ensure("sub", "conftest.py") + subconf.write("y=4") + mod2 = conf._importconftest(subconf) + assert mod != mod2 + assert mod2.y == 4 + import conftest + assert conftest is mod2, (conftest, mod) + """) + res = testdir.runpython(p) + assert res.ret == 0 + +def test_conftestcutdir(testdir): + conf = testdir.makeconftest("") + p = testdir.mkdir("x") + conftest = PytestPluginManager() + conftest_setinitial(conftest, [testdir.tmpdir], confcutdir=p) + l = conftest._getconftestmodules(p) + assert len(l) == 0 + l = conftest._getconftestmodules(conf.dirpath()) + assert len(l) == 0 + assert conf not in conftest._conftestpath2mod + # but we can still import a conftest directly + conftest._importconftest(conf) + l = conftest._getconftestmodules(conf.dirpath()) + assert l[0].__file__.startswith(str(conf)) + # and all sub paths get updated properly + l = conftest._getconftestmodules(p) + assert len(l) == 1 + assert l[0].__file__.startswith(str(conf)) + +def test_conftestcutdir_inplace_considered(testdir): + conf = testdir.makeconftest("") + conftest = PytestPluginManager() + conftest_setinitial(conftest, [conf.dirpath()], confcutdir=conf.dirpath()) + l = conftest._getconftestmodules(conf.dirpath()) + assert len(l) == 1 + assert l[0].__file__.startswith(str(conf)) + +@pytest.mark.parametrize("name", 'test tests whatever .dotdir'.split()) +def test_setinitial_conftest_subdirs(testdir, name): + sub = testdir.mkdir(name) + subconftest = sub.ensure("conftest.py") + conftest = PytestPluginManager() + conftest_setinitial(conftest, [sub.dirpath()], confcutdir=testdir.tmpdir) + if name not in ('whatever', '.dotdir'): + assert subconftest in conftest._conftestpath2mod + assert len(conftest._conftestpath2mod) == 1 + else: + assert subconftest not in conftest._conftestpath2mod + assert len(conftest._conftestpath2mod) == 0 + +def test_conftest_confcutdir(testdir): + testdir.makeconftest("assert 0") + x = testdir.mkdir("x") + x.join("conftest.py").write(_pytest._code.Source(""" + def pytest_addoption(parser): + parser.addoption("--xyz", action="store_true") + """)) + result = testdir.runpytest("-h", "--confcutdir=%s" % x, x) + result.stdout.fnmatch_lines(["*--xyz*"]) + assert 'warning: could not load initial' not in result.stdout.str() + +def test_no_conftest(testdir): + testdir.makeconftest("assert 0") + result = testdir.runpytest("--noconftest") + assert result.ret == EXIT_NOTESTSCOLLECTED + + result = testdir.runpytest() + assert result.ret == EXIT_USAGEERROR + +def test_conftest_existing_resultlog(testdir): + x = testdir.mkdir("tests") + x.join("conftest.py").write(_pytest._code.Source(""" + def pytest_addoption(parser): + parser.addoption("--xyz", action="store_true") + """)) + testdir.makefile(ext=".log", result="") # Writes result.log + result = testdir.runpytest("-h", "--resultlog", "result.log") + result.stdout.fnmatch_lines(["*--xyz*"]) + +def test_conftest_existing_junitxml(testdir): + x = testdir.mkdir("tests") + x.join("conftest.py").write(_pytest._code.Source(""" + def pytest_addoption(parser): + parser.addoption("--xyz", action="store_true") + """)) + testdir.makefile(ext=".xml", junit="") # Writes junit.xml + result = testdir.runpytest("-h", "--junitxml", "junit.xml") + result.stdout.fnmatch_lines(["*--xyz*"]) + +def test_conftest_import_order(testdir, monkeypatch): + ct1 = testdir.makeconftest("") + sub = testdir.mkdir("sub") + ct2 = sub.join("conftest.py") + ct2.write("") + def impct(p): + return p + conftest = PytestPluginManager() + monkeypatch.setattr(conftest, '_importconftest', impct) + assert conftest._getconftestmodules(sub) == [ct1, ct2] + + +def test_fixture_dependency(testdir, monkeypatch): + ct1 = testdir.makeconftest("") + ct1 = testdir.makepyfile("__init__.py") + ct1.write("") + sub = testdir.mkdir("sub") + sub.join("__init__.py").write("") + sub.join("conftest.py").write(py.std.textwrap.dedent(""" + import pytest + + @pytest.fixture + def not_needed(): + assert False, "Should not be called!" + + @pytest.fixture + def foo(): + assert False, "Should not be called!" + + @pytest.fixture + def bar(foo): + return 'bar' + """)) + subsub = sub.mkdir("subsub") + subsub.join("__init__.py").write("") + subsub.join("test_bar.py").write(py.std.textwrap.dedent(""" + import pytest + + @pytest.fixture + def bar(): + return 'sub bar' + + def test_event_fixture(bar): + assert bar == 'sub bar' + """)) + result = testdir.runpytest("sub") + result.stdout.fnmatch_lines(["*1 passed*"]) + + +def test_conftest_found_with_double_dash(testdir): + sub = testdir.mkdir("sub") + sub.join("conftest.py").write(py.std.textwrap.dedent(""" + def pytest_addoption(parser): + parser.addoption("--hello-world", action="store_true") + """)) + p = sub.join("test_hello.py") + p.write(py.std.textwrap.dedent(""" + import pytest + def test_hello(found): + assert found == 1 + """)) + result = testdir.runpytest(str(p) + "::test_hello", "-h") + result.stdout.fnmatch_lines(""" + *--hello-world* + """) + + +class TestConftestVisibility: + def _setup_tree(self, testdir): # for issue616 + # example mostly taken from: + # https://mail.python.org/pipermail/pytest-dev/2014-September/002617.html + runner = testdir.mkdir("empty") + package = testdir.mkdir("package") + + package.join("conftest.py").write(dedent("""\ + import pytest + @pytest.fixture + def fxtr(): + return "from-package" + """)) + package.join("test_pkgroot.py").write(dedent("""\ + def test_pkgroot(fxtr): + assert fxtr == "from-package" + """)) + + swc = package.mkdir("swc") + swc.join("__init__.py").ensure() + swc.join("conftest.py").write(dedent("""\ + import pytest + @pytest.fixture + def fxtr(): + return "from-swc" + """)) + swc.join("test_with_conftest.py").write(dedent("""\ + def test_with_conftest(fxtr): + assert fxtr == "from-swc" + + """)) + + snc = package.mkdir("snc") + snc.join("__init__.py").ensure() + snc.join("test_no_conftest.py").write(dedent("""\ + def test_no_conftest(fxtr): + assert fxtr == "from-package" # No local conftest.py, so should + # use value from parent dir's + + """)) + print ("created directory structure:") + for x in testdir.tmpdir.visit(): + print (" " + x.relto(testdir.tmpdir)) + + return { + "runner": runner, + "package": package, + "swc": swc, + "snc": snc} + + # N.B.: "swc" stands for "subdir with conftest.py" + # "snc" stands for "subdir no [i.e. without] conftest.py" + @pytest.mark.parametrize("chdir,testarg,expect_ntests_passed", [ + # Effective target: package/.. + ("runner", "..", 3), + ("package", "..", 3), + ("swc", "../..", 3), + ("snc", "../..", 3), + + # Effective target: package + ("runner", "../package", 3), + ("package", ".", 3), + ("swc", "..", 3), + ("snc", "..", 3), + + # Effective target: package/swc + ("runner", "../package/swc", 1), + ("package", "./swc", 1), + ("swc", ".", 1), + ("snc", "../swc", 1), + + # Effective target: package/snc + ("runner", "../package/snc", 1), + ("package", "./snc", 1), + ("swc", "../snc", 1), + ("snc", ".", 1), + ]) + @pytest.mark.issue616 + def test_parsefactories_relative_node_ids( + self, testdir, chdir,testarg, expect_ntests_passed): + dirs = self._setup_tree(testdir) + print("pytest run in cwd: %s" %( + dirs[chdir].relto(testdir.tmpdir))) + print("pytestarg : %s" %(testarg)) + print("expected pass : %s" %(expect_ntests_passed)) + with dirs[chdir].as_cwd(): + reprec = testdir.inline_run(testarg, "-q", "--traceconfig") + reprec.assertoutcome(passed=expect_ntests_passed) + + +@pytest.mark.parametrize('confcutdir,passed,error', [ + ('.', 2, 0), + ('src', 1, 1), + (None, 1, 1), +]) +def test_search_conftest_up_to_inifile(testdir, confcutdir, passed, error): + """Test that conftest files are detected only up to a ini file, unless + an explicit --confcutdir option is given. + """ + root = testdir.tmpdir + src = root.join('src').ensure(dir=1) + src.join('pytest.ini').write('[pytest]') + src.join('conftest.py').write(_pytest._code.Source(""" + import pytest + @pytest.fixture + def fix1(): pass + """)) + src.join('test_foo.py').write(_pytest._code.Source(""" + def test_1(fix1): + pass + def test_2(out_of_reach): + pass + """)) + root.join('conftest.py').write(_pytest._code.Source(""" + import pytest + @pytest.fixture + def out_of_reach(): pass + """)) + + args = [str(src)] + if confcutdir: + args = ['--confcutdir=%s' % root.join(confcutdir)] + result = testdir.runpytest(*args) + match = '' + if passed: + match += '*%d passed*' % passed + if error: + match += '*%d error*' % error + result.stdout.fnmatch_lines(match) + + +def test_issue1073_conftest_special_objects(testdir): + testdir.makeconftest(""" + class DontTouchMe: + def __getattr__(self, x): + raise Exception('cant touch me') + + x = DontTouchMe() + """) + testdir.makepyfile(""" + def test_some(): + pass + """) + res = testdir.runpytest() + assert res.ret == 0 diff --git a/testing/web-platform/tests/tools/pytest/testing/test_doctest.py b/testing/web-platform/tests/tools/pytest/testing/test_doctest.py new file mode 100644 index 000000000..a4821ee4c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_doctest.py @@ -0,0 +1,715 @@ +# encoding: utf-8 +import sys +import _pytest._code +from _pytest.doctest import DoctestItem, DoctestModule, DoctestTextfile +import pytest + +class TestDoctests: + + def test_collect_testtextfile(self, testdir): + w = testdir.maketxtfile(whatever="") + checkfile = testdir.maketxtfile(test_something=""" + alskdjalsdk + >>> i = 5 + >>> i-1 + 4 + """) + for x in (testdir.tmpdir, checkfile): + #print "checking that %s returns custom items" % (x,) + items, reprec = testdir.inline_genitems(x) + assert len(items) == 1 + assert isinstance(items[0], DoctestTextfile) + items, reprec = testdir.inline_genitems(w) + assert len(items) == 1 + + def test_collect_module_empty(self, testdir): + path = testdir.makepyfile(whatever="#") + for p in (path, testdir.tmpdir): + items, reprec = testdir.inline_genitems(p, + '--doctest-modules') + assert len(items) == 0 + + def test_collect_module_single_modulelevel_doctest(self, testdir): + path = testdir.makepyfile(whatever='""">>> pass"""') + for p in (path, testdir.tmpdir): + items, reprec = testdir.inline_genitems(p, + '--doctest-modules') + assert len(items) == 1 + assert isinstance(items[0], DoctestItem) + assert isinstance(items[0].parent, DoctestModule) + + def test_collect_module_two_doctest_one_modulelevel(self, testdir): + path = testdir.makepyfile(whatever=""" + '>>> x = None' + def my_func(): + ">>> magic = 42 " + """) + for p in (path, testdir.tmpdir): + items, reprec = testdir.inline_genitems(p, + '--doctest-modules') + assert len(items) == 2 + assert isinstance(items[0], DoctestItem) + assert isinstance(items[1], DoctestItem) + assert isinstance(items[0].parent, DoctestModule) + assert items[0].parent is items[1].parent + + def test_collect_module_two_doctest_no_modulelevel(self, testdir): + path = testdir.makepyfile(whatever=""" + '# Empty' + def my_func(): + ">>> magic = 42 " + def unuseful(): + ''' + # This is a function + # >>> # it doesn't have any doctest + ''' + def another(): + ''' + # This is another function + >>> import os # this one does have a doctest + ''' + """) + for p in (path, testdir.tmpdir): + items, reprec = testdir.inline_genitems(p, + '--doctest-modules') + assert len(items) == 2 + assert isinstance(items[0], DoctestItem) + assert isinstance(items[1], DoctestItem) + assert isinstance(items[0].parent, DoctestModule) + assert items[0].parent is items[1].parent + + def test_simple_doctestfile(self, testdir): + p = testdir.maketxtfile(test_doc=""" + >>> x = 1 + >>> x == 1 + False + """) + reprec = testdir.inline_run(p, ) + reprec.assertoutcome(failed=1) + + def test_new_pattern(self, testdir): + p = testdir.maketxtfile(xdoc=""" + >>> x = 1 + >>> x == 1 + False + """) + reprec = testdir.inline_run(p, "--doctest-glob=x*.txt") + reprec.assertoutcome(failed=1) + + def test_multiple_patterns(self, testdir): + """Test support for multiple --doctest-glob arguments (#1255). + """ + testdir.maketxtfile(xdoc=""" + >>> 1 + 1 + """) + testdir.makefile('.foo', test=""" + >>> 1 + 1 + """) + testdir.maketxtfile(test_normal=""" + >>> 1 + 1 + """) + expected = set(['xdoc.txt', 'test.foo', 'test_normal.txt']) + assert set(x.basename for x in testdir.tmpdir.listdir()) == expected + args = ["--doctest-glob=xdoc*.txt", "--doctest-glob=*.foo"] + result = testdir.runpytest(*args) + result.stdout.fnmatch_lines([ + '*test.foo *', + '*xdoc.txt *', + '*2 passed*', + ]) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + '*test_normal.txt *', + '*1 passed*', + ]) + + def test_doctest_unexpected_exception(self, testdir): + testdir.maketxtfile(""" + >>> i = 0 + >>> 0 / i + 2 + """) + result = testdir.runpytest("--doctest-modules") + result.stdout.fnmatch_lines([ + "*unexpected_exception*", + "*>>> i = 0*", + "*>>> 0 / i*", + "*UNEXPECTED*ZeroDivision*", + ]) + + def test_docstring_context_around_error(self, testdir): + """Test that we show some context before the actual line of a failing + doctest. + """ + testdir.makepyfile(''' + def foo(): + """ + text-line-1 + text-line-2 + text-line-3 + text-line-4 + text-line-5 + text-line-6 + text-line-7 + text-line-8 + text-line-9 + text-line-10 + text-line-11 + >>> 1 + 1 + 3 + + text-line-after + """ + ''') + result = testdir.runpytest('--doctest-modules') + result.stdout.fnmatch_lines([ + '*docstring_context_around_error*', + '005*text-line-3', + '006*text-line-4', + '013*text-line-11', + '014*>>> 1 + 1', + 'Expected:', + ' 3', + 'Got:', + ' 2', + ]) + # lines below should be trimmed out + assert 'text-line-2' not in result.stdout.str() + assert 'text-line-after' not in result.stdout.str() + + def test_doctest_linedata_missing(self, testdir): + testdir.tmpdir.join('hello.py').write(_pytest._code.Source(""" + class Fun(object): + @property + def test(self): + ''' + >>> a = 1 + >>> 1/0 + ''' + """)) + result = testdir.runpytest("--doctest-modules") + result.stdout.fnmatch_lines([ + "*hello*", + "*EXAMPLE LOCATION UNKNOWN, not showing all tests of that example*", + "*1/0*", + "*UNEXPECTED*ZeroDivision*", + "*1 failed*", + ]) + + + def test_doctest_unex_importerror(self, testdir): + testdir.tmpdir.join("hello.py").write(_pytest._code.Source(""" + import asdalsdkjaslkdjasd + """)) + testdir.maketxtfile(""" + >>> import hello + >>> + """) + result = testdir.runpytest("--doctest-modules") + result.stdout.fnmatch_lines([ + "*>>> import hello", + "*UNEXPECTED*ImportError*", + "*import asdals*", + ]) + + def test_doctestmodule(self, testdir): + p = testdir.makepyfile(""" + ''' + >>> x = 1 + >>> x == 1 + False + + ''' + """) + reprec = testdir.inline_run(p, "--doctest-modules") + reprec.assertoutcome(failed=1) + + def test_doctestmodule_external_and_issue116(self, testdir): + p = testdir.mkpydir("hello") + p.join("__init__.py").write(_pytest._code.Source(""" + def somefunc(): + ''' + >>> i = 0 + >>> i + 1 + 2 + ''' + """)) + result = testdir.runpytest(p, "--doctest-modules") + result.stdout.fnmatch_lines([ + '004 *>>> i = 0', + '005 *>>> i + 1', + '*Expected:', + "* 2", + "*Got:", + "* 1", + "*:5: DocTestFailure" + ]) + + + def test_txtfile_failing(self, testdir): + p = testdir.maketxtfile(""" + >>> i = 0 + >>> i + 1 + 2 + """) + result = testdir.runpytest(p, "-s") + result.stdout.fnmatch_lines([ + '001 >>> i = 0', + '002 >>> i + 1', + 'Expected:', + " 2", + "Got:", + " 1", + "*test_txtfile_failing.txt:2: DocTestFailure" + ]) + + def test_txtfile_with_fixtures(self, testdir): + p = testdir.maketxtfile(""" + >>> dir = getfixture('tmpdir') + >>> type(dir).__name__ + 'LocalPath' + """) + reprec = testdir.inline_run(p, ) + reprec.assertoutcome(passed=1) + + def test_txtfile_with_usefixtures_in_ini(self, testdir): + testdir.makeini(""" + [pytest] + usefixtures = myfixture + """) + testdir.makeconftest(""" + import pytest + @pytest.fixture + def myfixture(monkeypatch): + monkeypatch.setenv("HELLO", "WORLD") + """) + + p = testdir.maketxtfile(""" + >>> import os + >>> os.environ["HELLO"] + 'WORLD' + """) + reprec = testdir.inline_run(p, ) + reprec.assertoutcome(passed=1) + + def test_doctestmodule_with_fixtures(self, testdir): + p = testdir.makepyfile(""" + ''' + >>> dir = getfixture('tmpdir') + >>> type(dir).__name__ + 'LocalPath' + ''' + """) + reprec = testdir.inline_run(p, "--doctest-modules") + reprec.assertoutcome(passed=1) + + def test_doctestmodule_three_tests(self, testdir): + p = testdir.makepyfile(""" + ''' + >>> dir = getfixture('tmpdir') + >>> type(dir).__name__ + 'LocalPath' + ''' + def my_func(): + ''' + >>> magic = 42 + >>> magic - 42 + 0 + ''' + def unuseful(): + pass + def another(): + ''' + >>> import os + >>> os is os + True + ''' + """) + reprec = testdir.inline_run(p, "--doctest-modules") + reprec.assertoutcome(passed=3) + + def test_doctestmodule_two_tests_one_fail(self, testdir): + p = testdir.makepyfile(""" + class MyClass: + def bad_meth(self): + ''' + >>> magic = 42 + >>> magic + 0 + ''' + def nice_meth(self): + ''' + >>> magic = 42 + >>> magic - 42 + 0 + ''' + """) + reprec = testdir.inline_run(p, "--doctest-modules") + reprec.assertoutcome(failed=1, passed=1) + + def test_ignored_whitespace(self, testdir): + testdir.makeini(""" + [pytest] + doctest_optionflags = ELLIPSIS NORMALIZE_WHITESPACE + """) + p = testdir.makepyfile(""" + class MyClass: + ''' + >>> a = "foo " + >>> print(a) + foo + ''' + pass + """) + reprec = testdir.inline_run(p, "--doctest-modules") + reprec.assertoutcome(passed=1) + + def test_non_ignored_whitespace(self, testdir): + testdir.makeini(""" + [pytest] + doctest_optionflags = ELLIPSIS + """) + p = testdir.makepyfile(""" + class MyClass: + ''' + >>> a = "foo " + >>> print(a) + foo + ''' + pass + """) + reprec = testdir.inline_run(p, "--doctest-modules") + reprec.assertoutcome(failed=1, passed=0) + + def test_ignored_whitespace_glob(self, testdir): + testdir.makeini(""" + [pytest] + doctest_optionflags = ELLIPSIS NORMALIZE_WHITESPACE + """) + p = testdir.maketxtfile(xdoc=""" + >>> a = "foo " + >>> print(a) + foo + """) + reprec = testdir.inline_run(p, "--doctest-glob=x*.txt") + reprec.assertoutcome(passed=1) + + def test_non_ignored_whitespace_glob(self, testdir): + testdir.makeini(""" + [pytest] + doctest_optionflags = ELLIPSIS + """) + p = testdir.maketxtfile(xdoc=""" + >>> a = "foo " + >>> print(a) + foo + """) + reprec = testdir.inline_run(p, "--doctest-glob=x*.txt") + reprec.assertoutcome(failed=1, passed=0) + + def test_contains_unicode(self, testdir): + """Fix internal error with docstrings containing non-ascii characters. + """ + testdir.makepyfile(u''' + # encoding: utf-8 + def foo(): + """ + >>> name = 'с' # not letter 'c' but instead Cyrillic 's'. + 'anything' + """ + ''') + result = testdir.runpytest('--doctest-modules') + result.stdout.fnmatch_lines([ + 'Got nothing', + '* 1 failed in*', + ]) + + def test_ignore_import_errors_on_doctest(self, testdir): + p = testdir.makepyfile(""" + import asdf + + def add_one(x): + ''' + >>> add_one(1) + 2 + ''' + return x + 1 + """) + + reprec = testdir.inline_run(p, "--doctest-modules", + "--doctest-ignore-import-errors") + reprec.assertoutcome(skipped=1, failed=1, passed=0) + + def test_junit_report_for_doctest(self, testdir): + """ + #713: Fix --junit-xml option when used with --doctest-modules. + """ + p = testdir.makepyfile(""" + def foo(): + ''' + >>> 1 + 1 + 3 + ''' + pass + """) + reprec = testdir.inline_run(p, "--doctest-modules", + "--junit-xml=junit.xml") + reprec.assertoutcome(failed=1) + + +class TestLiterals: + + @pytest.mark.parametrize('config_mode', ['ini', 'comment']) + def test_allow_unicode(self, testdir, config_mode): + """Test that doctests which output unicode work in all python versions + tested by pytest when the ALLOW_UNICODE option is used (either in + the ini file or by an inline comment). + """ + if config_mode == 'ini': + testdir.makeini(''' + [pytest] + doctest_optionflags = ALLOW_UNICODE + ''') + comment = '' + else: + comment = '#doctest: +ALLOW_UNICODE' + + testdir.maketxtfile(test_doc=""" + >>> b'12'.decode('ascii') {comment} + '12' + """.format(comment=comment)) + testdir.makepyfile(foo=""" + def foo(): + ''' + >>> b'12'.decode('ascii') {comment} + '12' + ''' + """.format(comment=comment)) + reprec = testdir.inline_run("--doctest-modules") + reprec.assertoutcome(passed=2) + + @pytest.mark.parametrize('config_mode', ['ini', 'comment']) + def test_allow_bytes(self, testdir, config_mode): + """Test that doctests which output bytes work in all python versions + tested by pytest when the ALLOW_BYTES option is used (either in + the ini file or by an inline comment)(#1287). + """ + if config_mode == 'ini': + testdir.makeini(''' + [pytest] + doctest_optionflags = ALLOW_BYTES + ''') + comment = '' + else: + comment = '#doctest: +ALLOW_BYTES' + + testdir.maketxtfile(test_doc=""" + >>> b'foo' {comment} + 'foo' + """.format(comment=comment)) + testdir.makepyfile(foo=""" + def foo(): + ''' + >>> b'foo' {comment} + 'foo' + ''' + """.format(comment=comment)) + reprec = testdir.inline_run("--doctest-modules") + reprec.assertoutcome(passed=2) + + def test_unicode_string(self, testdir): + """Test that doctests which output unicode fail in Python 2 when + the ALLOW_UNICODE option is not used. The same test should pass + in Python 3. + """ + testdir.maketxtfile(test_doc=""" + >>> b'12'.decode('ascii') + '12' + """) + reprec = testdir.inline_run() + passed = int(sys.version_info[0] >= 3) + reprec.assertoutcome(passed=passed, failed=int(not passed)) + + def test_bytes_literal(self, testdir): + """Test that doctests which output bytes fail in Python 3 when + the ALLOW_BYTES option is not used. The same test should pass + in Python 2 (#1287). + """ + testdir.maketxtfile(test_doc=""" + >>> b'foo' + 'foo' + """) + reprec = testdir.inline_run() + passed = int(sys.version_info[0] == 2) + reprec.assertoutcome(passed=passed, failed=int(not passed)) + + +class TestDoctestSkips: + """ + If all examples in a doctest are skipped due to the SKIP option, then + the tests should be SKIPPED rather than PASSED. (#957) + """ + + @pytest.fixture(params=['text', 'module']) + def makedoctest(self, testdir, request): + def makeit(doctest): + mode = request.param + if mode == 'text': + testdir.maketxtfile(doctest) + else: + assert mode == 'module' + testdir.makepyfile('"""\n%s"""' % doctest) + + return makeit + + def test_one_skipped(self, testdir, makedoctest): + makedoctest(""" + >>> 1 + 1 # doctest: +SKIP + 2 + >>> 2 + 2 + 4 + """) + reprec = testdir.inline_run("--doctest-modules") + reprec.assertoutcome(passed=1) + + def test_one_skipped_failed(self, testdir, makedoctest): + makedoctest(""" + >>> 1 + 1 # doctest: +SKIP + 2 + >>> 2 + 2 + 200 + """) + reprec = testdir.inline_run("--doctest-modules") + reprec.assertoutcome(failed=1) + + def test_all_skipped(self, testdir, makedoctest): + makedoctest(""" + >>> 1 + 1 # doctest: +SKIP + 2 + >>> 2 + 2 # doctest: +SKIP + 200 + """) + reprec = testdir.inline_run("--doctest-modules") + reprec.assertoutcome(skipped=1) + + +class TestDoctestAutoUseFixtures: + + SCOPES = ['module', 'session', 'class', 'function'] + + def test_doctest_module_session_fixture(self, testdir): + """Test that session fixtures are initialized for doctest modules (#768) + """ + # session fixture which changes some global data, which will + # be accessed by doctests in a module + testdir.makeconftest(""" + import pytest + import sys + + @pytest.yield_fixture(autouse=True, scope='session') + def myfixture(): + assert not hasattr(sys, 'pytest_session_data') + sys.pytest_session_data = 1 + yield + del sys.pytest_session_data + """) + testdir.makepyfile(foo=""" + import sys + + def foo(): + ''' + >>> assert sys.pytest_session_data == 1 + ''' + + def bar(): + ''' + >>> assert sys.pytest_session_data == 1 + ''' + """) + result = testdir.runpytest("--doctest-modules") + result.stdout.fnmatch_lines('*2 passed*') + + @pytest.mark.parametrize('scope', SCOPES) + @pytest.mark.parametrize('enable_doctest', [True, False]) + def test_fixture_scopes(self, testdir, scope, enable_doctest): + """Test that auto-use fixtures work properly with doctest modules. + See #1057 and #1100. + """ + testdir.makeconftest(''' + import pytest + + @pytest.fixture(autouse=True, scope="{scope}") + def auto(request): + return 99 + '''.format(scope=scope)) + testdir.makepyfile(test_1=''' + def test_foo(): + """ + >>> getfixture('auto') + 1 + 100 + """ + def test_bar(): + assert 1 + ''') + params = ('--doctest-modules',) if enable_doctest else () + passes = 3 if enable_doctest else 2 + result = testdir.runpytest(*params) + result.stdout.fnmatch_lines(['*=== %d passed in *' % passes]) + + @pytest.mark.parametrize('scope', SCOPES) + @pytest.mark.parametrize('autouse', [True, False]) + @pytest.mark.parametrize('use_fixture_in_doctest', [True, False]) + def test_fixture_module_doctest_scopes(self, testdir, scope, autouse, + use_fixture_in_doctest): + """Test that auto-use fixtures work properly with doctest files. + See #1057 and #1100. + """ + testdir.makeconftest(''' + import pytest + + @pytest.fixture(autouse={autouse}, scope="{scope}") + def auto(request): + return 99 + '''.format(scope=scope, autouse=autouse)) + if use_fixture_in_doctest: + testdir.maketxtfile(test_doc=""" + >>> getfixture('auto') + 99 + """) + else: + testdir.maketxtfile(test_doc=""" + >>> 1 + 1 + 2 + """) + result = testdir.runpytest('--doctest-modules') + assert 'FAILURES' not in str(result.stdout.str()) + result.stdout.fnmatch_lines(['*=== 1 passed in *']) + + @pytest.mark.parametrize('scope', SCOPES) + def test_auto_use_request_attributes(self, testdir, scope): + """Check that all attributes of a request in an autouse fixture + behave as expected when requested for a doctest item. + """ + testdir.makeconftest(''' + import pytest + + @pytest.fixture(autouse=True, scope="{scope}") + def auto(request): + if "{scope}" == 'module': + assert request.module is None + if "{scope}" == 'class': + assert request.cls is None + if "{scope}" == 'function': + assert request.function is None + return 99 + '''.format(scope=scope)) + testdir.maketxtfile(test_doc=""" + >>> 1 + 1 + 2 + """) + result = testdir.runpytest('--doctest-modules') + assert 'FAILURES' not in str(result.stdout.str()) + result.stdout.fnmatch_lines(['*=== 1 passed in *']) diff --git a/testing/web-platform/tests/tools/pytest/testing/test_genscript.py b/testing/web-platform/tests/tools/pytest/testing/test_genscript.py new file mode 100644 index 000000000..1260a5a6b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_genscript.py @@ -0,0 +1,51 @@ +import pytest +import sys + + +@pytest.fixture(scope="module") +def standalone(request): + return Standalone(request) + +class Standalone: + def __init__(self, request): + self.testdir = request.getfuncargvalue("testdir") + script = "mypytest" + result = self.testdir.runpytest("--genscript=%s" % script) + assert result.ret == 0 + self.script = self.testdir.tmpdir.join(script) + assert self.script.check() + + def run(self, anypython, testdir, *args): + return testdir._run(anypython, self.script, *args) + +def test_gen(testdir, anypython, standalone): + if sys.version_info >= (2,7): + result = testdir._run(anypython, "-c", + "import sys;print (sys.version_info >=(2,7))") + assert result.ret == 0 + if result.stdout.str() == "False": + pytest.skip("genscript called from python2.7 cannot work " + "earlier python versions") + result = standalone.run(anypython, testdir, '--version') + if result.ret == 2: + result.stderr.fnmatch_lines(["*ERROR: setuptools not installed*"]) + elif result.ret == 0: + result.stderr.fnmatch_lines([ + "*imported from*mypytest*" + ]) + p = testdir.makepyfile("def test_func(): assert 0") + result = standalone.run(anypython, testdir, p) + assert result.ret != 0 + else: + pytest.fail("Unexpected return code") + + +def test_freeze_includes(): + """ + Smoke test for freeze_includes(), to ensure that it works across all + supported python versions. + """ + includes = pytest.freeze_includes() + assert len(includes) > 1 + assert '_pytest.genscript' in includes + diff --git a/testing/web-platform/tests/tools/pytest/testing/test_helpconfig.py b/testing/web-platform/tests/tools/pytest/testing/test_helpconfig.py new file mode 100644 index 000000000..9f8d87b7c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_helpconfig.py @@ -0,0 +1,69 @@ +from _pytest.main import EXIT_NOTESTSCOLLECTED +import pytest + +def test_version(testdir, pytestconfig): + result = testdir.runpytest("--version") + assert result.ret == 0 + #p = py.path.local(py.__file__).dirpath() + result.stderr.fnmatch_lines([ + '*pytest*%s*imported from*' % (pytest.__version__, ) + ]) + if pytestconfig.pluginmanager.list_plugin_distinfo(): + result.stderr.fnmatch_lines([ + "*setuptools registered plugins:", + "*at*", + ]) + +def test_help(testdir): + result = testdir.runpytest("--help") + assert result.ret == 0 + result.stdout.fnmatch_lines(""" + *-v*verbose* + *setup.cfg* + *minversion* + *to see*markers*py.test --markers* + *to see*fixtures*py.test --fixtures* + """) + +def test_hookvalidation_unknown(testdir): + testdir.makeconftest(""" + def pytest_hello(xyz): + pass + """) + result = testdir.runpytest() + assert result.ret != 0 + result.stderr.fnmatch_lines([ + '*unknown hook*pytest_hello*' + ]) + +def test_hookvalidation_optional(testdir): + testdir.makeconftest(""" + import pytest + @pytest.hookimpl(optionalhook=True) + def pytest_hello(xyz): + pass + """) + result = testdir.runpytest() + assert result.ret == EXIT_NOTESTSCOLLECTED + +def test_traceconfig(testdir): + result = testdir.runpytest("--traceconfig") + result.stdout.fnmatch_lines([ + "*using*pytest*py*", + "*active plugins*", + ]) + +def test_debug(testdir, monkeypatch): + result = testdir.runpytest_subprocess("--debug") + assert result.ret == EXIT_NOTESTSCOLLECTED + p = testdir.tmpdir.join("pytestdebug.log") + assert "pytest_sessionstart" in p.read() + +def test_PYTEST_DEBUG(testdir, monkeypatch): + monkeypatch.setenv("PYTEST_DEBUG", "1") + result = testdir.runpytest_subprocess() + assert result.ret == EXIT_NOTESTSCOLLECTED + result.stderr.fnmatch_lines([ + "*pytest_plugin_registered*", + "*manager*PluginManager*" + ]) diff --git a/testing/web-platform/tests/tools/pytest/testing/test_junitxml.py b/testing/web-platform/tests/tools/pytest/testing/test_junitxml.py new file mode 100644 index 000000000..5960f8825 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_junitxml.py @@ -0,0 +1,816 @@ +# -*- coding: utf-8 -*- + +from xml.dom import minidom +from _pytest.main import EXIT_NOTESTSCOLLECTED +import py +import sys +import os +from _pytest.junitxml import LogXML +import pytest + + +def runandparse(testdir, *args): + resultpath = testdir.tmpdir.join("junit.xml") + result = testdir.runpytest("--junitxml=%s" % resultpath, *args) + xmldoc = minidom.parse(str(resultpath)) + return result, DomNode(xmldoc) + + +def assert_attr(node, **kwargs): + __tracebackhide__ = True + + def nodeval(node, name): + anode = node.getAttributeNode(name) + if anode is not None: + return anode.value + + expected = dict((name, str(value)) for name, value in kwargs.items()) + on_node = dict((name, nodeval(node, name)) for name in expected) + assert on_node == expected + + +class DomNode(object): + def __init__(self, dom): + self.__node = dom + + def __repr__(self): + return self.__node.toxml() + + def find_first_by_tag(self, tag): + return self.find_nth_by_tag(tag, 0) + + def _by_tag(self, tag): + return self.__node.getElementsByTagName(tag) + + def find_nth_by_tag(self, tag, n): + items = self._by_tag(tag) + try: + nth = items[n] + except IndexError: + pass + else: + return type(self)(nth) + + def find_by_tag(self, tag): + t = type(self) + return [t(x) for x in self.__node.getElementsByTagName(tag)] + + def __getitem__(self, key): + node = self.__node.getAttributeNode(key) + if node is not None: + return node.value + + def assert_attr(self, **kwargs): + __tracebackhide__ = True + return assert_attr(self.__node, **kwargs) + + def toxml(self): + return self.__node.toxml() + + @property + def text(self): + return self.__node.childNodes[0].wholeText + + @property + def tag(self): + return self.__node.tagName + + @property + def next_siebling(self): + return type(self)(self.__node.nextSibling) + + +class TestPython: + def test_summing_simple(self, testdir): + testdir.makepyfile(""" + import pytest + def test_pass(): + pass + def test_fail(): + assert 0 + def test_skip(): + pytest.skip("") + @pytest.mark.xfail + def test_xfail(): + assert 0 + @pytest.mark.xfail + def test_xpass(): + assert 1 + """) + result, dom = runandparse(testdir) + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(name="pytest", errors=0, failures=1, skips=3, tests=2) + + def test_timing_function(self, testdir): + testdir.makepyfile(""" + import time, pytest + def setup_module(): + time.sleep(0.01) + def teardown_module(): + time.sleep(0.01) + def test_sleep(): + time.sleep(0.01) + """) + result, dom = runandparse(testdir) + node = dom.find_first_by_tag("testsuite") + tnode = node.find_first_by_tag("testcase") + val = tnode["time"] + assert round(float(val), 2) >= 0.03 + + def test_setup_error(self, testdir): + testdir.makepyfile(""" + def pytest_funcarg__arg(request): + raise ValueError() + def test_function(arg): + pass + """) + result, dom = runandparse(testdir) + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(errors=1, tests=0) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file="test_setup_error.py", + line="2", + classname="test_setup_error", + name="test_function") + fnode = tnode.find_first_by_tag("error") + fnode.assert_attr(message="test setup failure") + assert "ValueError" in fnode.toxml() + + def test_skip_contains_name_reason(self, testdir): + testdir.makepyfile(""" + import pytest + def test_skip(): + pytest.skip("hello23") + """) + result, dom = runandparse(testdir) + assert result.ret == 0 + node = dom.find_first_by_tag("testsuite") + node.assert_attr(skips=1) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file="test_skip_contains_name_reason.py", + line="1", + classname="test_skip_contains_name_reason", + name="test_skip") + snode = tnode.find_first_by_tag("skipped") + snode.assert_attr(type="pytest.skip", message="hello23", ) + + def test_classname_instance(self, testdir): + testdir.makepyfile(""" + class TestClass: + def test_method(self): + assert 0 + """) + result, dom = runandparse(testdir) + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(failures=1) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file="test_classname_instance.py", + line="1", + classname="test_classname_instance.TestClass", + name="test_method") + + def test_classname_nested_dir(self, testdir): + p = testdir.tmpdir.ensure("sub", "test_hello.py") + p.write("def test_func(): 0/0") + result, dom = runandparse(testdir) + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(failures=1) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file=os.path.join("sub", "test_hello.py"), + line="0", + classname="sub.test_hello", + name="test_func") + + def test_internal_error(self, testdir): + testdir.makeconftest("def pytest_runtest_protocol(): 0 / 0") + testdir.makepyfile("def test_function(): pass") + result, dom = runandparse(testdir) + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(errors=1, tests=0) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr(classname="pytest", name="internal") + fnode = tnode.find_first_by_tag("error") + fnode.assert_attr(message="internal error") + assert "Division" in fnode.toxml() + + def test_failure_function(self, testdir): + testdir.makepyfile(""" + import sys + def test_fail(): + print ("hello-stdout") + sys.stderr.write("hello-stderr\\n") + raise ValueError(42) + """) + + result, dom = runandparse(testdir) + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(failures=1, tests=1) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file="test_failure_function.py", + line="1", + classname="test_failure_function", + name="test_fail") + fnode = tnode.find_first_by_tag("failure") + fnode.assert_attr(message="ValueError: 42") + assert "ValueError" in fnode.toxml() + systemout = fnode.next_siebling + assert systemout.tag == "system-out" + assert "hello-stdout" in systemout.toxml() + systemerr = systemout.next_siebling + assert systemerr.tag == "system-err" + assert "hello-stderr" in systemerr.toxml() + + def test_failure_verbose_message(self, testdir): + testdir.makepyfile(""" + import sys + def test_fail(): + assert 0, "An error" + """) + + result, dom = runandparse(testdir) + node = dom.find_first_by_tag("testsuite") + tnode = node.find_first_by_tag("testcase") + fnode = tnode.find_first_by_tag("failure") + fnode.assert_attr(message="AssertionError: An error assert 0") + + def test_failure_escape(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize('arg1', "<&'", ids="<&'") + def test_func(arg1): + print(arg1) + assert 0 + """) + result, dom = runandparse(testdir) + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(failures=3, tests=3) + + for index, char in enumerate("<&'"): + + tnode = node.find_nth_by_tag("testcase", index) + tnode.assert_attr( + file="test_failure_escape.py", + line="1", + classname="test_failure_escape", + name="test_func[%s]" % char) + sysout = tnode.find_first_by_tag('system-out') + text = sysout.text + assert text == '%s\n' % char + + def test_junit_prefixing(self, testdir): + testdir.makepyfile(""" + def test_func(): + assert 0 + class TestHello: + def test_hello(self): + pass + """) + result, dom = runandparse(testdir, "--junitprefix=xyz") + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(failures=1, tests=2) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file="test_junit_prefixing.py", + line="0", + classname="xyz.test_junit_prefixing", + name="test_func") + tnode = node.find_nth_by_tag("testcase", 1) + tnode.assert_attr( + file="test_junit_prefixing.py", + line="3", + classname="xyz.test_junit_prefixing." + "TestHello", + name="test_hello") + + def test_xfailure_function(self, testdir): + testdir.makepyfile(""" + import pytest + def test_xfail(): + pytest.xfail("42") + """) + result, dom = runandparse(testdir) + assert not result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(skips=1, tests=0) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file="test_xfailure_function.py", + line="1", + classname="test_xfailure_function", + name="test_xfail") + fnode = tnode.find_first_by_tag("skipped") + fnode.assert_attr(message="expected test failure") + # assert "ValueError" in fnode.toxml() + + def test_xfailure_xpass(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.xfail + def test_xpass(): + pass + """) + result, dom = runandparse(testdir) + # assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(skips=1, tests=0) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file="test_xfailure_xpass.py", + line="1", + classname="test_xfailure_xpass", + name="test_xpass") + fnode = tnode.find_first_by_tag("skipped") + fnode.assert_attr(message="xfail-marked test passes unexpectedly") + # assert "ValueError" in fnode.toxml() + + def test_collect_error(self, testdir): + testdir.makepyfile("syntax error") + result, dom = runandparse(testdir) + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(errors=1, tests=0) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file="test_collect_error.py", + name="test_collect_error") + assert tnode["line"] is None + fnode = tnode.find_first_by_tag("error") + fnode.assert_attr(message="collection failure") + assert "SyntaxError" in fnode.toxml() + + def test_collect_skipped(self, testdir): + testdir.makepyfile("import pytest; pytest.skip('xyz')") + result, dom = runandparse(testdir) + assert result.ret == EXIT_NOTESTSCOLLECTED + node = dom.find_first_by_tag("testsuite") + node.assert_attr(skips=1, tests=0) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr( + file="test_collect_skipped.py", + name="test_collect_skipped") + + # py.test doesn't give us a line here. + assert tnode["line"] is None + + fnode = tnode.find_first_by_tag("skipped") + fnode.assert_attr(message="collection skipped") + + def test_unicode(self, testdir): + value = 'hx\xc4\x85\xc4\x87\n' + testdir.makepyfile(""" + # coding: latin1 + def test_hello(): + print (%r) + assert 0 + """ % value) + result, dom = runandparse(testdir) + assert result.ret == 1 + tnode = dom.find_first_by_tag("testcase") + fnode = tnode.find_first_by_tag("failure") + if not sys.platform.startswith("java"): + assert "hx" in fnode.toxml() + + def test_assertion_binchars(self, testdir): + """this test did fail when the escaping wasnt strict""" + testdir.makepyfile(""" + + M1 = '\x01\x02\x03\x04' + M2 = '\x01\x02\x03\x05' + + def test_str_compare(): + assert M1 == M2 + """) + result, dom = runandparse(testdir) + print(dom.toxml()) + + def test_pass_captures_stdout(self, testdir): + testdir.makepyfile(""" + def test_pass(): + print('hello-stdout') + """) + result, dom = runandparse(testdir) + node = dom.find_first_by_tag("testsuite") + pnode = node.find_first_by_tag("testcase") + systemout = pnode.find_first_by_tag("system-out") + assert "hello-stdout" in systemout.toxml() + + def test_pass_captures_stderr(self, testdir): + testdir.makepyfile(""" + import sys + def test_pass(): + sys.stderr.write('hello-stderr') + """) + result, dom = runandparse(testdir) + node = dom.find_first_by_tag("testsuite") + pnode = node.find_first_by_tag("testcase") + systemout = pnode.find_first_by_tag("system-err") + assert "hello-stderr" in systemout.toxml() + + def test_setup_error_captures_stdout(self, testdir): + testdir.makepyfile(""" + def pytest_funcarg__arg(request): + print('hello-stdout') + raise ValueError() + def test_function(arg): + pass + """) + result, dom = runandparse(testdir) + node = dom.find_first_by_tag("testsuite") + pnode = node.find_first_by_tag("testcase") + systemout = pnode.find_first_by_tag("system-out") + assert "hello-stdout" in systemout.toxml() + + def test_setup_error_captures_stderr(self, testdir): + testdir.makepyfile(""" + import sys + def pytest_funcarg__arg(request): + sys.stderr.write('hello-stderr') + raise ValueError() + def test_function(arg): + pass + """) + result, dom = runandparse(testdir) + node = dom.find_first_by_tag("testsuite") + pnode = node.find_first_by_tag("testcase") + systemout = pnode.find_first_by_tag("system-err") + assert "hello-stderr" in systemout.toxml() + + +def test_mangle_test_address(): + from _pytest.junitxml import mangle_test_address + address = '::'.join( + ["a/my.py.thing.py", "Class", "()", "method", "[a-1-::]"]) + newnames = mangle_test_address(address) + assert newnames == ["a.my.py.thing", "Class", "method", "[a-1-::]"] + + +def test_dont_configure_on_slaves(tmpdir): + gotten = [] + + class FakeConfig: + def __init__(self): + self.pluginmanager = self + self.option = self + + junitprefix = None + # XXX: shouldnt need tmpdir ? + xmlpath = str(tmpdir.join('junix.xml')) + register = gotten.append + + fake_config = FakeConfig() + from _pytest import junitxml + junitxml.pytest_configure(fake_config) + assert len(gotten) == 1 + FakeConfig.slaveinput = None + junitxml.pytest_configure(fake_config) + assert len(gotten) == 1 + + +class TestNonPython: + def test_summing_simple(self, testdir): + testdir.makeconftest(""" + import pytest + def pytest_collect_file(path, parent): + if path.ext == ".xyz": + return MyItem(path, parent) + class MyItem(pytest.Item): + def __init__(self, path, parent): + super(MyItem, self).__init__(path.basename, parent) + self.fspath = path + def runtest(self): + raise ValueError(42) + def repr_failure(self, excinfo): + return "custom item runtest failed" + """) + testdir.tmpdir.join("myfile.xyz").write("hello") + result, dom = runandparse(testdir) + assert result.ret + node = dom.find_first_by_tag("testsuite") + node.assert_attr(errors=0, failures=1, skips=0, tests=1) + tnode = node.find_first_by_tag("testcase") + tnode.assert_attr(name="myfile.xyz") + fnode = tnode.find_first_by_tag("failure") + fnode.assert_attr(message="custom item runtest failed") + assert "custom item runtest failed" in fnode.toxml() + + +def test_nullbyte(testdir): + # A null byte can not occur in XML (see section 2.2 of the spec) + testdir.makepyfile(""" + import sys + def test_print_nullbyte(): + sys.stdout.write('Here the null -->' + chr(0) + '<--') + sys.stdout.write('In repr form -->' + repr(chr(0)) + '<--') + assert False + """) + xmlf = testdir.tmpdir.join('junit.xml') + testdir.runpytest('--junitxml=%s' % xmlf) + text = xmlf.read() + assert '\x00' not in text + assert '#x00' in text + + +def test_nullbyte_replace(testdir): + # Check if the null byte gets replaced + testdir.makepyfile(""" + import sys + def test_print_nullbyte(): + sys.stdout.write('Here the null -->' + chr(0) + '<--') + sys.stdout.write('In repr form -->' + repr(chr(0)) + '<--') + assert False + """) + xmlf = testdir.tmpdir.join('junit.xml') + testdir.runpytest('--junitxml=%s' % xmlf) + text = xmlf.read() + assert '#x0' in text + + +def test_invalid_xml_escape(): + # Test some more invalid xml chars, the full range should be + # tested really but let's just thest the edges of the ranges + # intead. + # XXX This only tests low unicode character points for now as + # there are some issues with the testing infrastructure for + # the higher ones. + # XXX Testing 0xD (\r) is tricky as it overwrites the just written + # line in the output, so we skip it too. + global unichr + try: + unichr(65) + except NameError: + unichr = chr + invalid = (0x00, 0x1, 0xB, 0xC, 0xE, 0x19, 27, # issue #126 + 0xD800, 0xDFFF, 0xFFFE, 0x0FFFF) # , 0x110000) + valid = (0x9, 0xA, 0x20, ) + # 0xD, 0xD7FF, 0xE000, 0xFFFD, 0x10000, 0x10FFFF) + + from _pytest.junitxml import bin_xml_escape + + for i in invalid: + got = bin_xml_escape(unichr(i)).uniobj + if i <= 0xFF: + expected = '#x%02X' % i + else: + expected = '#x%04X' % i + assert got == expected + for i in valid: + assert chr(i) == bin_xml_escape(unichr(i)).uniobj + + +def test_logxml_path_expansion(tmpdir, monkeypatch): + home_tilde = py.path.local(os.path.expanduser('~')).join('test.xml') + + xml_tilde = LogXML('~%stest.xml' % tmpdir.sep, None) + assert xml_tilde.logfile == home_tilde + + # this is here for when $HOME is not set correct + monkeypatch.setenv("HOME", tmpdir) + home_var = os.path.normpath(os.path.expandvars('$HOME/test.xml')) + + xml_var = LogXML('$HOME%stest.xml' % tmpdir.sep, None) + assert xml_var.logfile == home_var + + +def test_logxml_changingdir(testdir): + testdir.makepyfile(""" + def test_func(): + import os + os.chdir("a") + """) + testdir.tmpdir.mkdir("a") + result = testdir.runpytest("--junitxml=a/x.xml") + assert result.ret == 0 + assert testdir.tmpdir.join("a/x.xml").check() + + +def test_logxml_makedir(testdir): + """--junitxml should automatically create directories for the xml file""" + testdir.makepyfile(""" + def test_pass(): + pass + """) + result = testdir.runpytest("--junitxml=path/to/results.xml") + assert result.ret == 0 + assert testdir.tmpdir.join("path/to/results.xml").check() + + +def test_escaped_parametrized_names_xml(testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize('char', ["\\x00"]) + def test_func(char): + assert char + """) + result, dom = runandparse(testdir) + assert result.ret == 0 + node = dom.find_first_by_tag("testcase") + node.assert_attr(name="test_func[#x00]") + + +def test_double_colon_split_function_issue469(testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize('param', ["double::colon"]) + def test_func(param): + pass + """) + result, dom = runandparse(testdir) + assert result.ret == 0 + node = dom.find_first_by_tag("testcase") + node.assert_attr(classname="test_double_colon_split_function_issue469") + node.assert_attr(name='test_func[double::colon]') + + +def test_double_colon_split_method_issue469(testdir): + testdir.makepyfile(""" + import pytest + class TestClass: + @pytest.mark.parametrize('param', ["double::colon"]) + def test_func(self, param): + pass + """) + result, dom = runandparse(testdir) + assert result.ret == 0 + node = dom.find_first_by_tag("testcase") + node.assert_attr( + classname="test_double_colon_split_method_issue469.TestClass") + node.assert_attr(name='test_func[double::colon]') + + +def test_unicode_issue368(testdir): + path = testdir.tmpdir.join("test.xml") + log = LogXML(str(path), None) + ustr = py.builtin._totext("ВНИ!", "utf-8") + from _pytest.runner import BaseReport + + class Report(BaseReport): + longrepr = ustr + sections = [] + nodeid = "something" + location = 'tests/filename.py', 42, 'TestClass.method' + + test_report = Report() + + # hopefully this is not too brittle ... + log.pytest_sessionstart() + node_reporter = log._opentestcase(test_report) + node_reporter.append_failure(test_report) + node_reporter.append_collect_error(test_report) + node_reporter.append_collect_skipped(test_report) + node_reporter.append_error(test_report) + test_report.longrepr = "filename", 1, ustr + node_reporter.append_skipped(test_report) + test_report.longrepr = "filename", 1, "Skipped: 卡嘣嘣" + node_reporter.append_skipped(test_report) + test_report.wasxfail = ustr + node_reporter.append_skipped(test_report) + log.pytest_sessionfinish() + + +def test_record_property(testdir): + testdir.makepyfile(""" + import pytest + + @pytest.fixture + def other(record_xml_property): + record_xml_property("bar", 1) + def test_record(record_xml_property, other): + record_xml_property("foo", "<1"); + """) + result, dom = runandparse(testdir, '-rw') + node = dom.find_first_by_tag("testsuite") + tnode = node.find_first_by_tag("testcase") + psnode = tnode.find_first_by_tag('properties') + pnodes = psnode.find_by_tag('property') + pnodes[0].assert_attr(name="bar", value="1") + pnodes[1].assert_attr(name="foo", value="<1") + result.stdout.fnmatch_lines('*C3*test_record_property.py*experimental*') + + +def test_record_property_same_name(testdir): + testdir.makepyfile(""" + def test_record_with_same_name(record_xml_property): + record_xml_property("foo", "bar") + record_xml_property("foo", "baz") + """) + result, dom = runandparse(testdir, '-rw') + node = dom.find_first_by_tag("testsuite") + tnode = node.find_first_by_tag("testcase") + psnode = tnode.find_first_by_tag('properties') + pnodes = psnode.find_by_tag('property') + pnodes[0].assert_attr(name="foo", value="bar") + pnodes[1].assert_attr(name="foo", value="baz") + + +def test_random_report_log_xdist(testdir): + """xdist calls pytest_runtest_logreport as they are executed by the slaves, + with nodes from several nodes overlapping, so junitxml must cope with that + to produce correct reports. #1064 + """ + pytest.importorskip('xdist') + testdir.makepyfile(""" + import pytest, time + @pytest.mark.parametrize('i', list(range(30))) + def test_x(i): + assert i != 22 + """) + _, dom = runandparse(testdir, '-n2') + suite_node = dom.find_first_by_tag("testsuite") + failed = [] + for case_node in suite_node.find_by_tag("testcase"): + if case_node.find_first_by_tag('failure'): + failed.append(case_node['name']) + + assert failed == ['test_x[22]'] + + +def test_runs_twice(testdir): + f = testdir.makepyfile(''' + def test_pass(): + pass + ''') + + result, dom = runandparse(testdir, f, f) + assert 'INTERNALERROR' not in result.stdout.str() + first, second = [x['classname'] for x in dom.find_by_tag("testcase")] + assert first == second + + +@pytest.mark.xfail(reason='hangs', run=False) +def test_runs_twice_xdist(testdir): + pytest.importorskip('xdist') + f = testdir.makepyfile(''' + def test_pass(): + pass + ''') + + result, dom = runandparse( + testdir, f, + '--dist', 'each', '--tx', '2*popen',) + assert 'INTERNALERROR' not in result.stdout.str() + first, second = [x['classname'] for x in dom.find_by_tag("testcase")] + assert first == second + + +def test_fancy_items_regression(testdir): + # issue 1259 + testdir.makeconftest(""" + import pytest + class FunItem(pytest.Item): + def runtest(self): + pass + class NoFunItem(pytest.Item): + def runtest(self): + pass + + class FunCollector(pytest.File): + def collect(self): + return [ + FunItem('a', self), + NoFunItem('a', self), + NoFunItem('b', self), + ] + + def pytest_collect_file(path, parent): + if path.check(ext='.py'): + return FunCollector(path, parent) + """) + + testdir.makepyfile(''' + def test_pass(): + pass + ''') + + result, dom = runandparse(testdir) + + assert 'INTERNALERROR' not in result.stdout.str() + + items = sorted( + '%(classname)s %(name)s %(file)s' % x + + for x in dom.find_by_tag("testcase")) + import pprint + pprint.pprint(items) + assert items == [ + u'conftest a conftest.py', + u'conftest a conftest.py', + u'conftest b conftest.py', + u'test_fancy_items_regression a test_fancy_items_regression.py', + u'test_fancy_items_regression a test_fancy_items_regression.py', + u'test_fancy_items_regression b test_fancy_items_regression.py', + u'test_fancy_items_regression test_pass' + u' test_fancy_items_regression.py', + ] diff --git a/testing/web-platform/tests/tools/pytest/testing/test_mark.py b/testing/web-platform/tests/tools/pytest/testing/test_mark.py new file mode 100644 index 000000000..aa1be6f7c --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_mark.py @@ -0,0 +1,672 @@ +import os + +import py, pytest +from _pytest.mark import MarkGenerator as Mark + +class TestMark: + def test_markinfo_repr(self): + from _pytest.mark import MarkInfo + m = MarkInfo("hello", (1,2), {}) + repr(m) + + def test_pytest_exists_in_namespace_all(self): + assert 'mark' in py.test.__all__ + assert 'mark' in pytest.__all__ + + def test_pytest_mark_notcallable(self): + mark = Mark() + pytest.raises((AttributeError, TypeError), mark) + + def test_pytest_mark_name_starts_with_underscore(self): + mark = Mark() + pytest.raises(AttributeError, getattr, mark, '_some_name') + + def test_pytest_mark_bare(self): + mark = Mark() + def f(): + pass + mark.hello(f) + assert f.hello + + def test_pytest_mark_keywords(self): + mark = Mark() + def f(): + pass + mark.world(x=3, y=4)(f) + assert f.world + assert f.world.kwargs['x'] == 3 + assert f.world.kwargs['y'] == 4 + + def test_apply_multiple_and_merge(self): + mark = Mark() + def f(): + pass + mark.world + mark.world(x=3)(f) + assert f.world.kwargs['x'] == 3 + mark.world(y=4)(f) + assert f.world.kwargs['x'] == 3 + assert f.world.kwargs['y'] == 4 + mark.world(y=1)(f) + assert f.world.kwargs['y'] == 1 + assert len(f.world.args) == 0 + + def test_pytest_mark_positional(self): + mark = Mark() + def f(): + pass + mark.world("hello")(f) + assert f.world.args[0] == "hello" + mark.world("world")(f) + + def test_pytest_mark_positional_func_and_keyword(self): + mark = Mark() + def f(): + raise Exception + m = mark.world(f, omega="hello") + def g(): + pass + assert m(g) == g + assert g.world.args[0] is f + assert g.world.kwargs["omega"] == "hello" + + def test_pytest_mark_reuse(self): + mark = Mark() + def f(): + pass + w = mark.some + w("hello", reason="123")(f) + assert f.some.args[0] == "hello" + assert f.some.kwargs['reason'] == "123" + def g(): + pass + w("world", reason2="456")(g) + assert g.some.args[0] == "world" + assert 'reason' not in g.some.kwargs + assert g.some.kwargs['reason2'] == "456" + + +def test_marked_class_run_twice(testdir, request): + """Test fails file is run twice that contains marked class. + See issue#683. + """ + py_file = testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize('abc', [1, 2, 3]) + class Test1(object): + def test_1(self, abc): + assert abc in [1, 2, 3] + """) + file_name = os.path.basename(py_file.strpath) + rec = testdir.inline_run(file_name, file_name) + rec.assertoutcome(passed=6) + + +def test_ini_markers(testdir): + testdir.makeini(""" + [pytest] + markers = + a1: this is a webtest marker + a2: this is a smoke marker + """) + testdir.makepyfile(""" + def test_markers(pytestconfig): + markers = pytestconfig.getini("markers") + print (markers) + assert len(markers) >= 2 + assert markers[0].startswith("a1:") + assert markers[1].startswith("a2:") + """) + rec = testdir.inline_run() + rec.assertoutcome(passed=1) + +def test_markers_option(testdir): + testdir.makeini(""" + [pytest] + markers = + a1: this is a webtest marker + a1some: another marker + """) + result = testdir.runpytest("--markers", ) + result.stdout.fnmatch_lines([ + "*a1*this is a webtest*", + "*a1some*another marker", + ]) + +def test_markers_option_with_plugin_in_current_dir(testdir): + testdir.makeconftest('pytest_plugins = "flip_flop"') + testdir.makepyfile(flip_flop="""\ + def pytest_configure(config): + config.addinivalue_line("markers", "flip:flop") + + def pytest_generate_tests(metafunc): + try: + mark = metafunc.function.flipper + except AttributeError: + return + metafunc.parametrize("x", (10, 20))""") + testdir.makepyfile("""\ + import pytest + @pytest.mark.flipper + def test_example(x): + assert x""") + + result = testdir.runpytest("--markers") + result.stdout.fnmatch_lines(["*flip*flop*"]) + + +def test_mark_on_pseudo_function(testdir): + testdir.makepyfile(""" + import pytest + + @pytest.mark.r(lambda x: 0/0) + def test_hello(): + pass + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + +def test_strict_prohibits_unregistered_markers(testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.unregisteredmark + def test_hello(): + pass + """) + result = testdir.runpytest("--strict") + assert result.ret != 0 + result.stdout.fnmatch_lines([ + "*unregisteredmark*not*registered*", + ]) + +@pytest.mark.parametrize("spec", [ + ("xyz", ("test_one",)), + ("xyz and xyz2", ()), + ("xyz2", ("test_two",)), + ("xyz or xyz2", ("test_one", "test_two"),) +]) +def test_mark_option(spec, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.xyz + def test_one(): + pass + @pytest.mark.xyz2 + def test_two(): + pass + """) + opt, passed_result = spec + rec = testdir.inline_run("-m", opt) + passed, skipped, fail = rec.listoutcomes() + passed = [x.nodeid.split("::")[-1] for x in passed] + assert len(passed) == len(passed_result) + assert list(passed) == list(passed_result) + +@pytest.mark.parametrize("spec", [ + ("interface", ("test_interface",)), + ("not interface", ("test_nointer",)), +]) +def test_mark_option_custom(spec, testdir): + testdir.makeconftest(""" + import pytest + def pytest_collection_modifyitems(items): + for item in items: + if "interface" in item.nodeid: + item.keywords["interface"] = pytest.mark.interface + """) + testdir.makepyfile(""" + def test_interface(): + pass + def test_nointer(): + pass + """) + opt, passed_result = spec + rec = testdir.inline_run("-m", opt) + passed, skipped, fail = rec.listoutcomes() + passed = [x.nodeid.split("::")[-1] for x in passed] + assert len(passed) == len(passed_result) + assert list(passed) == list(passed_result) + +@pytest.mark.parametrize("spec", [ + ("interface", ("test_interface",)), + ("not interface", ("test_nointer", "test_pass")), + ("pass", ("test_pass",)), + ("not pass", ("test_interface", "test_nointer")), +]) +def test_keyword_option_custom(spec, testdir): + testdir.makepyfile(""" + def test_interface(): + pass + def test_nointer(): + pass + def test_pass(): + pass + """) + opt, passed_result = spec + rec = testdir.inline_run("-k", opt) + passed, skipped, fail = rec.listoutcomes() + passed = [x.nodeid.split("::")[-1] for x in passed] + assert len(passed) == len(passed_result) + assert list(passed) == list(passed_result) + + +@pytest.mark.parametrize("spec", [ + ("None", ("test_func[None]",)), + ("1.3", ("test_func[1.3]",)), + ("2-3", ("test_func[2-3]",)) +]) +def test_keyword_option_parametrize(spec, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize("arg", [None, 1.3, "2-3"]) + def test_func(arg): + pass + """) + opt, passed_result = spec + rec = testdir.inline_run("-k", opt) + passed, skipped, fail = rec.listoutcomes() + passed = [x.nodeid.split("::")[-1] for x in passed] + assert len(passed) == len(passed_result) + assert list(passed) == list(passed_result) + + +def test_parametrized_collected_from_command_line(testdir): + """Parametrized test not collected if test named specified + in command line issue#649. + """ + py_file = testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize("arg", [None, 1.3, "2-3"]) + def test_func(arg): + pass + """) + file_name = os.path.basename(py_file.strpath) + rec = testdir.inline_run(file_name + "::" + "test_func") + rec.assertoutcome(passed=3) + + +class TestFunctional: + + def test_mark_per_function(self, testdir): + p = testdir.makepyfile(""" + import pytest + @pytest.mark.hello + def test_hello(): + assert hasattr(test_hello, 'hello') + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines(["*1 passed*"]) + + def test_mark_per_module(self, testdir): + item = testdir.getitem(""" + import pytest + pytestmark = pytest.mark.hello + def test_func(): + pass + """) + keywords = item.keywords + assert 'hello' in keywords + + def test_marklist_per_class(self, testdir): + item = testdir.getitem(""" + import pytest + class TestClass: + pytestmark = [pytest.mark.hello, pytest.mark.world] + def test_func(self): + assert TestClass.test_func.hello + assert TestClass.test_func.world + """) + keywords = item.keywords + assert 'hello' in keywords + + def test_marklist_per_module(self, testdir): + item = testdir.getitem(""" + import pytest + pytestmark = [pytest.mark.hello, pytest.mark.world] + class TestClass: + def test_func(self): + assert TestClass.test_func.hello + assert TestClass.test_func.world + """) + keywords = item.keywords + assert 'hello' in keywords + assert 'world' in keywords + + def test_mark_per_class_decorator(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.hello + class TestClass: + def test_func(self): + assert TestClass.test_func.hello + """) + keywords = item.keywords + assert 'hello' in keywords + + def test_mark_per_class_decorator_plus_existing_dec(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.hello + class TestClass: + pytestmark = pytest.mark.world + def test_func(self): + assert TestClass.test_func.hello + assert TestClass.test_func.world + """) + keywords = item.keywords + assert 'hello' in keywords + assert 'world' in keywords + + def test_merging_markers(self, testdir): + p = testdir.makepyfile(""" + import pytest + pytestmark = pytest.mark.hello("pos1", x=1, y=2) + class TestClass: + # classlevel overrides module level + pytestmark = pytest.mark.hello(x=3) + @pytest.mark.hello("pos0", z=4) + def test_func(self): + pass + """) + items, rec = testdir.inline_genitems(p) + item, = items + keywords = item.keywords + marker = keywords['hello'] + assert marker.args == ("pos0", "pos1") + assert marker.kwargs == {'x': 1, 'y': 2, 'z': 4} + + # test the new __iter__ interface + l = list(marker) + assert len(l) == 3 + assert l[0].args == ("pos0",) + assert l[1].args == () + assert l[2].args == ("pos1", ) + + @pytest.mark.xfail(reason='unfixed') + def test_merging_markers_deep(self, testdir): + # issue 199 - propagate markers into nested classes + p = testdir.makepyfile(""" + import pytest + class TestA: + pytestmark = pytest.mark.a + def test_b(self): + assert True + class TestC: + # this one didnt get marked + def test_d(self): + assert True + """) + items, rec = testdir.inline_genitems(p) + for item in items: + print (item, item.keywords) + assert 'a' in item.keywords + + def test_mark_decorator_subclass_does_not_propagate_to_base(self, testdir): + p = testdir.makepyfile(""" + import pytest + + @pytest.mark.a + class Base: pass + + @pytest.mark.b + class Test1(Base): + def test_foo(self): pass + + class Test2(Base): + def test_bar(self): pass + """) + items, rec = testdir.inline_genitems(p) + self.assert_markers(items, test_foo=('a', 'b'), test_bar=('a',)) + + def test_mark_decorator_baseclasses_merged(self, testdir): + p = testdir.makepyfile(""" + import pytest + + @pytest.mark.a + class Base: pass + + @pytest.mark.b + class Base2(Base): pass + + @pytest.mark.c + class Test1(Base2): + def test_foo(self): pass + + class Test2(Base2): + @pytest.mark.d + def test_bar(self): pass + """) + items, rec = testdir.inline_genitems(p) + self.assert_markers(items, test_foo=('a', 'b', 'c'), + test_bar=('a', 'b', 'd')) + + def test_mark_with_wrong_marker(self, testdir): + reprec = testdir.inline_runsource(""" + import pytest + class pytestmark: + pass + def test_func(): + pass + """) + l = reprec.getfailedcollections() + assert len(l) == 1 + assert "TypeError" in str(l[0].longrepr) + + def test_mark_dynamically_in_funcarg(self, testdir): + testdir.makeconftest(""" + import pytest + def pytest_funcarg__arg(request): + request.applymarker(pytest.mark.hello) + def pytest_terminal_summary(terminalreporter): + l = terminalreporter.stats['passed'] + terminalreporter.writer.line("keyword: %s" % l[0].keywords) + """) + testdir.makepyfile(""" + def test_func(arg): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "keyword: *hello*" + ]) + + def test_merging_markers_two_functions(self, testdir): + p = testdir.makepyfile(""" + import pytest + @pytest.mark.hello("pos1", z=4) + @pytest.mark.hello("pos0", z=3) + def test_func(): + pass + """) + items, rec = testdir.inline_genitems(p) + item, = items + keywords = item.keywords + marker = keywords['hello'] + l = list(marker) + assert len(l) == 2 + assert l[0].args == ("pos0",) + assert l[1].args == ("pos1",) + + def test_no_marker_match_on_unmarked_names(self, testdir): + p = testdir.makepyfile(""" + import pytest + @pytest.mark.shouldmatch + def test_marked(): + assert 1 + + def test_unmarked(): + assert 1 + """) + reprec = testdir.inline_run("-m", "test_unmarked", p) + passed, skipped, failed = reprec.listoutcomes() + assert len(passed) + len(skipped) + len(failed) == 0 + dlist = reprec.getcalls("pytest_deselected") + deselected_tests = dlist[0].items + assert len(deselected_tests) == 2 + + def test_keywords_at_node_level(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope="session", autouse=True) + def some(request): + request.keywords["hello"] = 42 + assert "world" not in request.keywords + + @pytest.fixture(scope="function", autouse=True) + def funcsetup(request): + assert "world" in request.keywords + assert "hello" in request.keywords + + @pytest.mark.world + def test_function(): + pass + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_keyword_added_for_session(self, testdir): + testdir.makeconftest(""" + import pytest + def pytest_collection_modifyitems(session): + session.add_marker("mark1") + session.add_marker(pytest.mark.mark2) + session.add_marker(pytest.mark.mark3) + pytest.raises(ValueError, lambda: + session.add_marker(10)) + """) + testdir.makepyfile(""" + def test_some(request): + assert "mark1" in request.keywords + assert "mark2" in request.keywords + assert "mark3" in request.keywords + assert 10 not in request.keywords + marker = request.node.get_marker("mark1") + assert marker.name == "mark1" + assert marker.args == () + assert marker.kwargs == {} + """) + reprec = testdir.inline_run("-m", "mark1") + reprec.assertoutcome(passed=1) + + def assert_markers(self, items, **expected): + """assert that given items have expected marker names applied to them. + expected should be a dict of (item name -> seq of expected marker names) + + .. note:: this could be moved to ``testdir`` if proven to be useful + to other modules. + """ + from _pytest.mark import MarkInfo + items = dict((x.name, x) for x in items) + for name, expected_markers in expected.items(): + markers = items[name].keywords._markers + marker_names = set([name for (name, v) in markers.items() + if isinstance(v, MarkInfo)]) + assert marker_names == set(expected_markers) + + +class TestKeywordSelection: + def test_select_simple(self, testdir): + file_test = testdir.makepyfile(""" + def test_one(): + assert 0 + class TestClass(object): + def test_method_one(self): + assert 42 == 43 + """) + def check(keyword, name): + reprec = testdir.inline_run("-s", "-k", keyword, file_test) + passed, skipped, failed = reprec.listoutcomes() + assert len(failed) == 1 + assert failed[0].nodeid.split("::")[-1] == name + assert len(reprec.getcalls('pytest_deselected')) == 1 + + for keyword in ['test_one', 'est_on']: + check(keyword, 'test_one') + check('TestClass and test', 'test_method_one') + + @pytest.mark.parametrize("keyword", [ + 'xxx', 'xxx and test_2', 'TestClass', 'xxx and not test_1', + 'TestClass and test_2', 'xxx and TestClass and test_2']) + def test_select_extra_keywords(self, testdir, keyword): + p = testdir.makepyfile(test_select=""" + def test_1(): + pass + class TestClass: + def test_2(self): + pass + """) + testdir.makepyfile(conftest=""" + import pytest + @pytest.hookimpl(hookwrapper=True) + def pytest_pycollect_makeitem(name): + outcome = yield + if name == "TestClass": + item = outcome.get_result() + item.extra_keyword_matches.add("xxx") + """) + reprec = testdir.inline_run(p.dirpath(), '-s', '-k', keyword) + py.builtin.print_("keyword", repr(keyword)) + passed, skipped, failed = reprec.listoutcomes() + assert len(passed) == 1 + assert passed[0].nodeid.endswith("test_2") + dlist = reprec.getcalls("pytest_deselected") + assert len(dlist) == 1 + assert dlist[0].items[0].name == 'test_1' + + def test_select_starton(self, testdir): + threepass = testdir.makepyfile(test_threepass=""" + def test_one(): assert 1 + def test_two(): assert 1 + def test_three(): assert 1 + """) + reprec = testdir.inline_run("-k", "test_two:", threepass) + passed, skipped, failed = reprec.listoutcomes() + assert len(passed) == 2 + assert not failed + dlist = reprec.getcalls("pytest_deselected") + assert len(dlist) == 1 + item = dlist[0].items[0] + assert item.name == "test_one" + + def test_keyword_extra(self, testdir): + p = testdir.makepyfile(""" + def test_one(): + assert 0 + test_one.mykeyword = True + """) + reprec = testdir.inline_run("-k", "mykeyword", p) + passed, skipped, failed = reprec.countoutcomes() + assert failed == 1 + + @pytest.mark.xfail + def test_keyword_extra_dash(self, testdir): + p = testdir.makepyfile(""" + def test_one(): + assert 0 + test_one.mykeyword = True + """) + # with argparse the argument to an option cannot + # start with '-' + reprec = testdir.inline_run("-k", "-mykeyword", p) + passed, skipped, failed = reprec.countoutcomes() + assert passed + skipped + failed == 0 + + def test_no_magic_values(self, testdir): + """Make sure the tests do not match on magic values, + no double underscored values, like '__dict__', + and no instance values, like '()'. + """ + p = testdir.makepyfile(""" + def test_one(): assert 1 + """) + def assert_test_is_not_selected(keyword): + reprec = testdir.inline_run("-k", keyword, p) + passed, skipped, failed = reprec.countoutcomes() + dlist = reprec.getcalls("pytest_deselected") + assert passed + skipped + failed == 0 + deselected_tests = dlist[0].items + assert len(deselected_tests) == 1 + + assert_test_is_not_selected("__") + assert_test_is_not_selected("()") + diff --git a/testing/web-platform/tests/tools/pytest/testing/test_monkeypatch.py b/testing/web-platform/tests/tools/pytest/testing/test_monkeypatch.py new file mode 100644 index 000000000..048c942c8 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_monkeypatch.py @@ -0,0 +1,330 @@ +import os +import sys +import textwrap + +import pytest +from _pytest.monkeypatch import monkeypatch as MonkeyPatch + + +def pytest_funcarg__mp(request): + cwd = os.getcwd() + sys_path = list(sys.path) + + def cleanup(): + sys.path[:] = sys_path + os.chdir(cwd) + + request.addfinalizer(cleanup) + return MonkeyPatch() + + +def test_setattr(): + class A: + x = 1 + + monkeypatch = MonkeyPatch() + pytest.raises(AttributeError, "monkeypatch.setattr(A, 'notexists', 2)") + monkeypatch.setattr(A, 'y', 2, raising=False) + assert A.y == 2 + monkeypatch.undo() + assert not hasattr(A, 'y') + + monkeypatch = MonkeyPatch() + monkeypatch.setattr(A, 'x', 2) + assert A.x == 2 + monkeypatch.setattr(A, 'x', 3) + assert A.x == 3 + monkeypatch.undo() + assert A.x == 1 + + A.x = 5 + monkeypatch.undo() # double-undo makes no modification + assert A.x == 5 + + +class TestSetattrWithImportPath: + def test_string_expression(self, monkeypatch): + monkeypatch.setattr("os.path.abspath", lambda x: "hello2") + assert os.path.abspath("123") == "hello2" + + def test_string_expression_class(self, monkeypatch): + monkeypatch.setattr("_pytest.config.Config", 42) + import _pytest + assert _pytest.config.Config == 42 + + def test_unicode_string(self, monkeypatch): + monkeypatch.setattr("_pytest.config.Config", 42) + import _pytest + assert _pytest.config.Config == 42 + monkeypatch.delattr("_pytest.config.Config") + + def test_wrong_target(self, monkeypatch): + pytest.raises(TypeError, lambda: monkeypatch.setattr(None, None)) + + def test_unknown_import(self, monkeypatch): + pytest.raises(ImportError, + lambda: monkeypatch.setattr("unkn123.classx", None)) + + def test_unknown_attr(self, monkeypatch): + pytest.raises(AttributeError, + lambda: monkeypatch.setattr("os.path.qweqwe", None)) + + def test_unknown_attr_non_raising(self, monkeypatch): + # https://github.com/pytest-dev/pytest/issues/746 + monkeypatch.setattr('os.path.qweqwe', 42, raising=False) + assert os.path.qweqwe == 42 + + def test_delattr(self, monkeypatch): + monkeypatch.delattr("os.path.abspath") + assert not hasattr(os.path, "abspath") + monkeypatch.undo() + assert os.path.abspath + + +def test_delattr(): + class A: + x = 1 + + monkeypatch = MonkeyPatch() + monkeypatch.delattr(A, 'x') + assert not hasattr(A, 'x') + monkeypatch.undo() + assert A.x == 1 + + monkeypatch = MonkeyPatch() + monkeypatch.delattr(A, 'x') + pytest.raises(AttributeError, "monkeypatch.delattr(A, 'y')") + monkeypatch.delattr(A, 'y', raising=False) + monkeypatch.setattr(A, 'x', 5, raising=False) + assert A.x == 5 + monkeypatch.undo() + assert A.x == 1 + + +def test_setitem(): + d = {'x': 1} + monkeypatch = MonkeyPatch() + monkeypatch.setitem(d, 'x', 2) + monkeypatch.setitem(d, 'y', 1700) + monkeypatch.setitem(d, 'y', 1700) + assert d['x'] == 2 + assert d['y'] == 1700 + monkeypatch.setitem(d, 'x', 3) + assert d['x'] == 3 + monkeypatch.undo() + assert d['x'] == 1 + assert 'y' not in d + d['x'] = 5 + monkeypatch.undo() + assert d['x'] == 5 + + +def test_setitem_deleted_meanwhile(): + d = {} + monkeypatch = MonkeyPatch() + monkeypatch.setitem(d, 'x', 2) + del d['x'] + monkeypatch.undo() + assert not d + + +@pytest.mark.parametrize("before", [True, False]) +def test_setenv_deleted_meanwhile(before): + key = "qwpeoip123" + if before: + os.environ[key] = "world" + monkeypatch = MonkeyPatch() + monkeypatch.setenv(key, 'hello') + del os.environ[key] + monkeypatch.undo() + if before: + assert os.environ[key] == "world" + del os.environ[key] + else: + assert key not in os.environ + + +def test_delitem(): + d = {'x': 1} + monkeypatch = MonkeyPatch() + monkeypatch.delitem(d, 'x') + assert 'x' not in d + monkeypatch.delitem(d, 'y', raising=False) + pytest.raises(KeyError, "monkeypatch.delitem(d, 'y')") + assert not d + monkeypatch.setitem(d, 'y', 1700) + assert d['y'] == 1700 + d['hello'] = 'world' + monkeypatch.setitem(d, 'x', 1500) + assert d['x'] == 1500 + monkeypatch.undo() + assert d == {'hello': 'world', 'x': 1} + + +def test_setenv(): + monkeypatch = MonkeyPatch() + monkeypatch.setenv('XYZ123', 2) + import os + assert os.environ['XYZ123'] == "2" + monkeypatch.undo() + assert 'XYZ123' not in os.environ + + +def test_delenv(): + name = 'xyz1234' + assert name not in os.environ + monkeypatch = MonkeyPatch() + pytest.raises(KeyError, "monkeypatch.delenv(%r, raising=True)" % name) + monkeypatch.delenv(name, raising=False) + monkeypatch.undo() + os.environ[name] = "1" + try: + monkeypatch = MonkeyPatch() + monkeypatch.delenv(name) + assert name not in os.environ + monkeypatch.setenv(name, "3") + assert os.environ[name] == "3" + monkeypatch.undo() + assert os.environ[name] == "1" + finally: + if name in os.environ: + del os.environ[name] + + +def test_setenv_prepend(): + import os + monkeypatch = MonkeyPatch() + monkeypatch.setenv('XYZ123', 2, prepend="-") + assert os.environ['XYZ123'] == "2" + monkeypatch.setenv('XYZ123', 3, prepend="-") + assert os.environ['XYZ123'] == "3-2" + monkeypatch.undo() + assert 'XYZ123' not in os.environ + + +def test_monkeypatch_plugin(testdir): + reprec = testdir.inline_runsource(""" + def test_method(monkeypatch): + assert monkeypatch.__class__.__name__ == "monkeypatch" + """) + res = reprec.countoutcomes() + assert tuple(res) == (1, 0, 0), res + + +def test_syspath_prepend(mp): + old = list(sys.path) + mp.syspath_prepend('world') + mp.syspath_prepend('hello') + assert sys.path[0] == "hello" + assert sys.path[1] == "world" + mp.undo() + assert sys.path == old + mp.undo() + assert sys.path == old + + +def test_syspath_prepend_double_undo(mp): + mp.syspath_prepend('hello world') + mp.undo() + sys.path.append('more hello world') + mp.undo() + assert sys.path[-1] == 'more hello world' + + +def test_chdir_with_path_local(mp, tmpdir): + mp.chdir(tmpdir) + assert os.getcwd() == tmpdir.strpath + + +def test_chdir_with_str(mp, tmpdir): + mp.chdir(tmpdir.strpath) + assert os.getcwd() == tmpdir.strpath + + +def test_chdir_undo(mp, tmpdir): + cwd = os.getcwd() + mp.chdir(tmpdir) + mp.undo() + assert os.getcwd() == cwd + + +def test_chdir_double_undo(mp, tmpdir): + mp.chdir(tmpdir.strpath) + mp.undo() + tmpdir.chdir() + mp.undo() + assert os.getcwd() == tmpdir.strpath + + +def test_issue185_time_breaks(testdir): + testdir.makepyfile(""" + import time + def test_m(monkeypatch): + def f(): + raise Exception + monkeypatch.setattr(time, "time", f) + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(""" + *1 passed* + """) + + +def test_importerror(testdir): + p = testdir.mkpydir("package") + p.join("a.py").write(textwrap.dedent("""\ + import doesnotexist + + x = 1 + """)) + testdir.tmpdir.join("test_importerror.py").write(textwrap.dedent("""\ + def test_importerror(monkeypatch): + monkeypatch.setattr('package.a.x', 2) + """)) + result = testdir.runpytest() + result.stdout.fnmatch_lines(""" + *import error in package.a: No module named {0}doesnotexist{0}* + """.format("'" if sys.version_info > (3, 0) else "")) + + +class SampleNew(object): + @staticmethod + def hello(): + return True + + +class SampleNewInherit(SampleNew): + pass + + +class SampleOld: + # oldstyle on python2 + @staticmethod + def hello(): + return True + + +class SampleOldInherit(SampleOld): + pass + + +@pytest.mark.parametrize('Sample', [ + SampleNew, SampleNewInherit, + SampleOld, SampleOldInherit, +], ids=['new', 'new-inherit', 'old', 'old-inherit']) +def test_issue156_undo_staticmethod(Sample): + monkeypatch = MonkeyPatch() + + monkeypatch.setattr(Sample, 'hello', None) + assert Sample.hello is None + + monkeypatch.undo() + assert Sample.hello() + +def test_issue1338_name_resolving(): + pytest.importorskip('requests') + monkeypatch = MonkeyPatch() + try: + monkeypatch.delattr('requests.sessions.Session.request') + finally: + monkeypatch.undo()
\ No newline at end of file diff --git a/testing/web-platform/tests/tools/pytest/testing/test_nose.py b/testing/web-platform/tests/tools/pytest/testing/test_nose.py new file mode 100644 index 000000000..a5162381e --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_nose.py @@ -0,0 +1,394 @@ +import pytest + +def setup_module(mod): + mod.nose = pytest.importorskip("nose") + +def test_nose_setup(testdir): + p = testdir.makepyfile(""" + l = [] + from nose.tools import with_setup + + @with_setup(lambda: l.append(1), lambda: l.append(2)) + def test_hello(): + assert l == [1] + + def test_world(): + assert l == [1,2] + + test_hello.setup = lambda: l.append(1) + test_hello.teardown = lambda: l.append(2) + """) + result = testdir.runpytest(p, '-p', 'nose') + result.assert_outcomes(passed=2) + + +def test_setup_func_with_setup_decorator(): + from _pytest.nose import call_optional + l = [] + class A: + @pytest.fixture(autouse=True) + def f(self): + l.append(1) + call_optional(A(), "f") + assert not l + + +def test_setup_func_not_callable(): + from _pytest.nose import call_optional + class A: + f = 1 + call_optional(A(), "f") + +def test_nose_setup_func(testdir): + p = testdir.makepyfile(""" + from nose.tools import with_setup + + l = [] + + def my_setup(): + a = 1 + l.append(a) + + def my_teardown(): + b = 2 + l.append(b) + + @with_setup(my_setup, my_teardown) + def test_hello(): + print (l) + assert l == [1] + + def test_world(): + print (l) + assert l == [1,2] + + """) + result = testdir.runpytest(p, '-p', 'nose') + result.assert_outcomes(passed=2) + + +def test_nose_setup_func_failure(testdir): + p = testdir.makepyfile(""" + from nose.tools import with_setup + + l = [] + my_setup = lambda x: 1 + my_teardown = lambda x: 2 + + @with_setup(my_setup, my_teardown) + def test_hello(): + print (l) + assert l == [1] + + def test_world(): + print (l) + assert l == [1,2] + + """) + result = testdir.runpytest(p, '-p', 'nose') + result.stdout.fnmatch_lines([ + "*TypeError: <lambda>()*" + ]) + + +def test_nose_setup_func_failure_2(testdir): + testdir.makepyfile(""" + l = [] + + my_setup = 1 + my_teardown = 2 + + def test_hello(): + assert l == [] + + test_hello.setup = my_setup + test_hello.teardown = my_teardown + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + +def test_nose_setup_partial(testdir): + pytest.importorskip("functools") + p = testdir.makepyfile(""" + from functools import partial + + l = [] + + def my_setup(x): + a = x + l.append(a) + + def my_teardown(x): + b = x + l.append(b) + + my_setup_partial = partial(my_setup, 1) + my_teardown_partial = partial(my_teardown, 2) + + def test_hello(): + print (l) + assert l == [1] + + def test_world(): + print (l) + assert l == [1,2] + + test_hello.setup = my_setup_partial + test_hello.teardown = my_teardown_partial + """) + result = testdir.runpytest(p, '-p', 'nose') + result.stdout.fnmatch_lines([ + "*2 passed*" + ]) + + +def test_nose_test_generator_fixtures(testdir): + p = testdir.makepyfile(""" + # taken from nose-0.11.1 unit_tests/test_generator_fixtures.py + from nose.tools import eq_ + called = [] + + def outer_setup(): + called.append('outer_setup') + + def outer_teardown(): + called.append('outer_teardown') + + def inner_setup(): + called.append('inner_setup') + + def inner_teardown(): + called.append('inner_teardown') + + def test_gen(): + called[:] = [] + for i in range(0, 5): + yield check, i + + def check(i): + expect = ['outer_setup'] + for x in range(0, i): + expect.append('inner_setup') + expect.append('inner_teardown') + expect.append('inner_setup') + eq_(called, expect) + + + test_gen.setup = outer_setup + test_gen.teardown = outer_teardown + check.setup = inner_setup + check.teardown = inner_teardown + + class TestClass(object): + def setup(self): + print ("setup called in %s" % self) + self.called = ['setup'] + + def teardown(self): + print ("teardown called in %s" % self) + eq_(self.called, ['setup']) + self.called.append('teardown') + + def test(self): + print ("test called in %s" % self) + for i in range(0, 5): + yield self.check, i + + def check(self, i): + print ("check called in %s" % self) + expect = ['setup'] + #for x in range(0, i): + # expect.append('setup') + # expect.append('teardown') + #expect.append('setup') + eq_(self.called, expect) + """) + result = testdir.runpytest(p, '-p', 'nose') + result.stdout.fnmatch_lines([ + "*10 passed*" + ]) + + +def test_module_level_setup(testdir): + testdir.makepyfile(""" + from nose.tools import with_setup + items = {} + + def setup(): + items[1]=1 + + def teardown(): + del items[1] + + def setup2(): + items[2] = 2 + + def teardown2(): + del items[2] + + def test_setup_module_setup(): + assert items[1] == 1 + + @with_setup(setup2, teardown2) + def test_local_setup(): + assert items[2] == 2 + assert 1 not in items + """) + result = testdir.runpytest('-p', 'nose') + result.stdout.fnmatch_lines([ + "*2 passed*", + ]) + + +def test_nose_style_setup_teardown(testdir): + testdir.makepyfile(""" + l = [] + + def setup_module(): + l.append(1) + + def teardown_module(): + del l[0] + + def test_hello(): + assert l == [1] + + def test_world(): + assert l == [1] + """) + result = testdir.runpytest('-p', 'nose') + result.stdout.fnmatch_lines([ + "*2 passed*", + ]) + +def test_nose_setup_ordering(testdir): + testdir.makepyfile(""" + def setup_module(mod): + mod.visited = True + + class TestClass: + def setup(self): + assert visited + def test_first(self): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*1 passed*", + ]) + + +def test_apiwrapper_problem_issue260(testdir): + # this would end up trying a call a optional teardown on the class + # for plain unittests we dont want nose behaviour + testdir.makepyfile(""" + import unittest + class TestCase(unittest.TestCase): + def setup(self): + #should not be called in unittest testcases + assert 0, 'setup' + def teardown(self): + #should not be called in unittest testcases + assert 0, 'teardown' + def setUp(self): + print('setup') + def tearDown(self): + print('teardown') + def test_fun(self): + pass + """) + result = testdir.runpytest() + result.assert_outcomes(passed=1) + +def test_setup_teardown_linking_issue265(testdir): + # we accidentally didnt integrate nose setupstate with normal setupstate + # this test ensures that won't happen again + testdir.makepyfile(''' + import pytest + + class TestGeneric(object): + def test_nothing(self): + """Tests the API of the implementation (for generic and specialized).""" + + @pytest.mark.skipif("True", reason= + "Skip tests to check if teardown is skipped as well.") + class TestSkipTeardown(TestGeneric): + + def setup(self): + """Sets up my specialized implementation for $COOL_PLATFORM.""" + raise Exception("should not call setup for skipped tests") + + def teardown(self): + """Undoes the setup.""" + raise Exception("should not call teardown for skipped tests") + ''') + reprec = testdir.runpytest() + reprec.assert_outcomes(passed=1, skipped=1) + + +def test_SkipTest_during_collection(testdir): + p = testdir.makepyfile(""" + import nose + raise nose.SkipTest("during collection") + def test_failing(): + assert False + """) + result = testdir.runpytest(p) + result.assert_outcomes(skipped=1) + + +def test_SkipTest_in_test(testdir): + testdir.makepyfile(""" + import nose + + def test_skipping(): + raise nose.SkipTest("in test") + """) + reprec = testdir.inline_run() + reprec.assertoutcome(skipped=1) + +def test_istest_function_decorator(testdir): + p = testdir.makepyfile(""" + import nose.tools + @nose.tools.istest + def not_test_prefix(): + pass + """) + result = testdir.runpytest(p) + result.assert_outcomes(passed=1) + +def test_nottest_function_decorator(testdir): + testdir.makepyfile(""" + import nose.tools + @nose.tools.nottest + def test_prefix(): + pass + """) + reprec = testdir.inline_run() + assert not reprec.getfailedcollections() + calls = reprec.getreports("pytest_runtest_logreport") + assert not calls + +def test_istest_class_decorator(testdir): + p = testdir.makepyfile(""" + import nose.tools + @nose.tools.istest + class NotTestPrefix: + def test_method(self): + pass + """) + result = testdir.runpytest(p) + result.assert_outcomes(passed=1) + +def test_nottest_class_decorator(testdir): + testdir.makepyfile(""" + import nose.tools + @nose.tools.nottest + class TestPrefix: + def test_method(self): + pass + """) + reprec = testdir.inline_run() + assert not reprec.getfailedcollections() + calls = reprec.getreports("pytest_runtest_logreport") + assert not calls diff --git a/testing/web-platform/tests/tools/pytest/testing/test_parseopt.py b/testing/web-platform/tests/tools/pytest/testing/test_parseopt.py new file mode 100644 index 000000000..e45ee2854 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_parseopt.py @@ -0,0 +1,287 @@ +from __future__ import with_statement +import sys +import os +import py, pytest +from _pytest import config as parseopt + +@pytest.fixture +def parser(): + return parseopt.Parser() + +class TestParser: + def test_no_help_by_default(self, capsys): + parser = parseopt.Parser(usage="xyz") + pytest.raises(SystemExit, lambda: parser.parse(["-h"])) + out, err = capsys.readouterr() + assert err.find("error: unrecognized arguments") != -1 + + def test_argument(self): + with pytest.raises(parseopt.ArgumentError): + # need a short or long option + argument = parseopt.Argument() + argument = parseopt.Argument('-t') + assert argument._short_opts == ['-t'] + assert argument._long_opts == [] + assert argument.dest == 't' + argument = parseopt.Argument('-t', '--test') + assert argument._short_opts == ['-t'] + assert argument._long_opts == ['--test'] + assert argument.dest == 'test' + argument = parseopt.Argument('-t', '--test', dest='abc') + assert argument.dest == 'abc' + + def test_argument_type(self): + argument = parseopt.Argument('-t', dest='abc', type='int') + assert argument.type is int + argument = parseopt.Argument('-t', dest='abc', type='string') + assert argument.type is str + argument = parseopt.Argument('-t', dest='abc', type=float) + assert argument.type is float + with pytest.raises(KeyError): + argument = parseopt.Argument('-t', dest='abc', type='choice') + argument = parseopt.Argument('-t', dest='abc', type='choice', + choices=['red', 'blue']) + assert argument.type is str + + def test_argument_processopt(self): + argument = parseopt.Argument('-t', type=int) + argument.default = 42 + argument.dest = 'abc' + res = argument.attrs() + assert res['default'] == 42 + assert res['dest'] == 'abc' + + def test_group_add_and_get(self, parser): + group = parser.getgroup("hello", description="desc") + assert group.name == "hello" + assert group.description == "desc" + + def test_getgroup_simple(self, parser): + group = parser.getgroup("hello", description="desc") + assert group.name == "hello" + assert group.description == "desc" + group2 = parser.getgroup("hello") + assert group2 is group + + def test_group_ordering(self, parser): + parser.getgroup("1") + parser.getgroup("2") + parser.getgroup("3", after="1") + groups = parser._groups + groups_names = [x.name for x in groups] + assert groups_names == list("132") + + def test_group_addoption(self): + group = parseopt.OptionGroup("hello") + group.addoption("--option1", action="store_true") + assert len(group.options) == 1 + assert isinstance(group.options[0], parseopt.Argument) + + def test_group_shortopt_lowercase(self, parser): + group = parser.getgroup("hello") + pytest.raises(ValueError, """ + group.addoption("-x", action="store_true") + """) + assert len(group.options) == 0 + group._addoption("-x", action="store_true") + assert len(group.options) == 1 + + def test_parser_addoption(self, parser): + group = parser.getgroup("custom options") + assert len(group.options) == 0 + group.addoption("--option1", action="store_true") + assert len(group.options) == 1 + + def test_parse(self, parser): + parser.addoption("--hello", dest="hello", action="store") + args = parser.parse(['--hello', 'world']) + assert args.hello == "world" + assert not getattr(args, parseopt.FILE_OR_DIR) + + def test_parse2(self, parser): + args = parser.parse([py.path.local()]) + assert getattr(args, parseopt.FILE_OR_DIR)[0] == py.path.local() + + def test_parse_known_args(self, parser): + parser.parse_known_args([py.path.local()]) + parser.addoption("--hello", action="store_true") + ns = parser.parse_known_args(["x", "--y", "--hello", "this"]) + assert ns.hello + assert ns.file_or_dir == ['x'] + + def test_parse_known_and_unknown_args(self, parser): + parser.addoption("--hello", action="store_true") + ns, unknown = parser.parse_known_and_unknown_args(["x", "--y", + "--hello", "this"]) + assert ns.hello + assert ns.file_or_dir == ['x'] + assert unknown == ['--y', 'this'] + + def test_parse_will_set_default(self, parser): + parser.addoption("--hello", dest="hello", default="x", action="store") + option = parser.parse([]) + assert option.hello == "x" + del option.hello + parser.parse_setoption([], option) + assert option.hello == "x" + + def test_parse_setoption(self, parser): + parser.addoption("--hello", dest="hello", action="store") + parser.addoption("--world", dest="world", default=42) + class A: pass + option = A() + args = parser.parse_setoption(['--hello', 'world'], option) + assert option.hello == "world" + assert option.world == 42 + assert not args + + def test_parse_special_destination(self, parser): + parser.addoption("--ultimate-answer", type=int) + args = parser.parse(['--ultimate-answer', '42']) + assert args.ultimate_answer == 42 + + def test_parse_split_positional_arguments(self, parser): + parser.addoption("-R", action='store_true') + parser.addoption("-S", action='store_false') + args = parser.parse(['-R', '4', '2', '-S']) + assert getattr(args, parseopt.FILE_OR_DIR) == ['4', '2'] + args = parser.parse(['-R', '-S', '4', '2', '-R']) + assert getattr(args, parseopt.FILE_OR_DIR) == ['4', '2'] + assert args.R == True + assert args.S == False + args = parser.parse(['-R', '4', '-S', '2']) + assert getattr(args, parseopt.FILE_OR_DIR) == ['4', '2'] + assert args.R == True + assert args.S == False + + def test_parse_defaultgetter(self): + def defaultget(option): + if not hasattr(option, 'type'): + return + if option.type is int: + option.default = 42 + elif option.type is str: + option.default = "world" + parser = parseopt.Parser(processopt=defaultget) + parser.addoption("--this", dest="this", type="int", action="store") + parser.addoption("--hello", dest="hello", type="string", action="store") + parser.addoption("--no", dest="no", action="store_true") + option = parser.parse([]) + assert option.hello == "world" + assert option.this == 42 + assert option.no is False + + def test_drop_short_helper(self): + parser = py.std.argparse.ArgumentParser(formatter_class=parseopt.DropShorterLongHelpFormatter) + parser.add_argument('-t', '--twoword', '--duo', '--two-word', '--two', + help='foo').map_long_option = {'two': 'two-word'} + # throws error on --deux only! + parser.add_argument('-d', '--deuxmots', '--deux-mots', + action='store_true', help='foo').map_long_option = {'deux': 'deux-mots'} + parser.add_argument('-s', action='store_true', help='single short') + parser.add_argument('--abc', '-a', + action='store_true', help='bar') + parser.add_argument('--klm', '-k', '--kl-m', + action='store_true', help='bar') + parser.add_argument('-P', '--pq-r', '-p', '--pqr', + action='store_true', help='bar') + parser.add_argument('--zwei-wort', '--zweiwort', '--zweiwort', + action='store_true', help='bar') + parser.add_argument('-x', '--exit-on-first', '--exitfirst', + action='store_true', help='spam').map_long_option = {'exitfirst': 'exit-on-first'} + parser.add_argument('files_and_dirs', nargs='*') + args = parser.parse_args(['-k', '--duo', 'hallo', '--exitfirst']) + assert args.twoword == 'hallo' + assert args.klm is True + assert args.zwei_wort is False + assert args.exit_on_first is True + assert args.s is False + args = parser.parse_args(['--deux-mots']) + with pytest.raises(AttributeError): + assert args.deux_mots is True + assert args.deuxmots is True + args = parser.parse_args(['file', 'dir']) + assert '|'.join(args.files_and_dirs) == 'file|dir' + + def test_drop_short_0(self, parser): + parser.addoption('--funcarg', '--func-arg', action='store_true') + parser.addoption('--abc-def', '--abc-def', action='store_true') + parser.addoption('--klm-hij', action='store_true') + args = parser.parse(['--funcarg', '--k']) + assert args.funcarg is True + assert args.abc_def is False + assert args.klm_hij is True + + def test_drop_short_2(self, parser): + parser.addoption('--func-arg', '--doit', action='store_true') + args = parser.parse(['--doit']) + assert args.func_arg is True + + def test_drop_short_3(self, parser): + parser.addoption('--func-arg', '--funcarg', '--doit', action='store_true') + args = parser.parse(['abcd']) + assert args.func_arg is False + assert args.file_or_dir == ['abcd'] + + def test_drop_short_help0(self, parser, capsys): + parser.addoption('--func-args', '--doit', help = 'foo', + action='store_true') + parser.parse([]) + help = parser.optparser.format_help() + assert '--func-args, --doit foo' in help + + # testing would be more helpful with all help generated + def test_drop_short_help1(self, parser, capsys): + group = parser.getgroup("general") + group.addoption('--doit', '--func-args', action='store_true', help='foo') + group._addoption("-h", "--help", action="store_true", dest="help", + help="show help message and configuration info") + parser.parse(['-h']) + help = parser.optparser.format_help() + assert '-doit, --func-args foo' in help + + +def test_argcomplete(testdir, monkeypatch): + if not py.path.local.sysfind('bash'): + pytest.skip("bash not available") + script = str(testdir.tmpdir.join("test_argcomplete")) + pytest_bin = sys.argv[0] + if "py.test" not in os.path.basename(pytest_bin): + pytest.skip("need to be run with py.test executable, not %s" %(pytest_bin,)) + + with open(str(script), 'w') as fp: + # redirect output from argcomplete to stdin and stderr is not trivial + # http://stackoverflow.com/q/12589419/1307905 + # so we use bash + fp.write('COMP_WORDBREAKS="$COMP_WORDBREAKS" %s 8>&1 9>&2' % pytest_bin) + # alternative would be exteneded Testdir.{run(),_run(),popen()} to be able + # to handle a keyword argument env that replaces os.environ in popen or + # extends the copy, advantage: could not forget to restore + monkeypatch.setenv('_ARGCOMPLETE', "1") + monkeypatch.setenv('_ARGCOMPLETE_IFS',"\x0b") + monkeypatch.setenv('COMP_WORDBREAKS', ' \\t\\n"\\\'><=;|&(:') + + arg = '--fu' + monkeypatch.setenv('COMP_LINE', "py.test " + arg) + monkeypatch.setenv('COMP_POINT', str(len("py.test " + arg))) + result = testdir.run('bash', str(script), arg) + if result.ret == 255: + # argcomplete not found + pytest.skip("argcomplete not available") + elif not result.stdout.str(): + pytest.skip("bash provided no output, argcomplete not available?") + else: + if py.std.sys.version_info < (2,7): + result.stdout.lines = result.stdout.lines[0].split('\x0b') + result.stdout.fnmatch_lines(["--funcargs", "--fulltrace"]) + else: + result.stdout.fnmatch_lines(["--funcargs", "--fulltrace"]) + if py.std.sys.version_info < (2,7): + return + os.mkdir('test_argcomplete.d') + arg = 'test_argc' + monkeypatch.setenv('COMP_LINE', "py.test " + arg) + monkeypatch.setenv('COMP_POINT', str(len('py.test ' + arg))) + result = testdir.run('bash', str(script), arg) + result.stdout.fnmatch_lines(["test_argcomplete", "test_argcomplete.d/"]) + diff --git a/testing/web-platform/tests/tools/pytest/testing/test_pastebin.py b/testing/web-platform/tests/tools/pytest/testing/test_pastebin.py new file mode 100644 index 000000000..03570a5c7 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_pastebin.py @@ -0,0 +1,115 @@ +# encoding: utf-8 +import sys +import pytest + +class TestPasteCapture: + + @pytest.fixture + def pastebinlist(self, monkeypatch, request): + pastebinlist = [] + plugin = request.config.pluginmanager.getplugin('pastebin') + monkeypatch.setattr(plugin, 'create_new_paste', pastebinlist.append) + return pastebinlist + + def test_failed(self, testdir, pastebinlist): + testpath = testdir.makepyfile(""" + import pytest + def test_pass(): + pass + def test_fail(): + assert 0 + def test_skip(): + pytest.skip("") + """) + reprec = testdir.inline_run(testpath, "--paste=failed") + assert len(pastebinlist) == 1 + s = pastebinlist[0] + assert s.find("def test_fail") != -1 + assert reprec.countoutcomes() == [1,1,1] + + def test_all(self, testdir, pastebinlist): + from _pytest.pytester import LineMatcher + testpath = testdir.makepyfile(""" + import pytest + def test_pass(): + pass + def test_fail(): + assert 0 + def test_skip(): + pytest.skip("") + """) + reprec = testdir.inline_run(testpath, "--pastebin=all", '-v') + assert reprec.countoutcomes() == [1,1,1] + assert len(pastebinlist) == 1 + contents = pastebinlist[0].decode('utf-8') + matcher = LineMatcher(contents.splitlines()) + matcher.fnmatch_lines([ + '*test_pass PASSED*', + '*test_fail FAILED*', + '*test_skip SKIPPED*', + '*== 1 failed, 1 passed, 1 skipped in *' + ]) + + def test_non_ascii_paste_text(self, testdir): + """Make sure that text which contains non-ascii characters is pasted + correctly. See #1219. + """ + testdir.makepyfile(test_unicode=""" + # encoding: utf-8 + def test(): + assert '☺' == 1 + """) + result = testdir.runpytest('--pastebin=all') + if sys.version_info[0] == 3: + expected_msg = "*assert '☺' == 1*" + else: + expected_msg = "*assert '\\xe2\\x98\\xba' == 1*" + result.stdout.fnmatch_lines([ + expected_msg, + "*== 1 failed in *", + '*Sending information to Paste Service*', + ]) + + +class TestPaste: + + @pytest.fixture + def pastebin(self, request): + return request.config.pluginmanager.getplugin('pastebin') + + @pytest.fixture + def mocked_urlopen(self, monkeypatch): + """ + monkeypatch the actual urlopen calls done by the internal plugin + function that connects to bpaste service. + """ + calls = [] + def mocked(url, data): + calls.append((url, data)) + class DummyFile: + def read(self): + # part of html of a normal response + return b'View <a href="/raw/3c0c6750bd">raw</a>.' + return DummyFile() + + if sys.version_info < (3, 0): + import urllib + monkeypatch.setattr(urllib, 'urlopen', mocked) + else: + import urllib.request + monkeypatch.setattr(urllib.request, 'urlopen', mocked) + return calls + + def test_create_new_paste(self, pastebin, mocked_urlopen): + result = pastebin.create_new_paste(b'full-paste-contents') + assert result == 'https://bpaste.net/show/3c0c6750bd' + assert len(mocked_urlopen) == 1 + url, data = mocked_urlopen[0] + assert type(data) is bytes + lexer = 'python3' if sys.version_info[0] == 3 else 'python' + assert url == 'https://bpaste.net' + assert 'lexer=%s' % lexer in data.decode() + assert 'code=full-paste-contents' in data.decode() + assert 'expiry=1week' in data.decode() + + diff --git a/testing/web-platform/tests/tools/pytest/testing/test_pdb.py b/testing/web-platform/tests/tools/pytest/testing/test_pdb.py new file mode 100644 index 000000000..eeddcf0ae --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_pdb.py @@ -0,0 +1,313 @@ +import sys + +import _pytest._code + + +def runpdb_and_get_report(testdir, source): + p = testdir.makepyfile(source) + result = testdir.runpytest_inprocess("--pdb", p) + reports = result.reprec.getreports("pytest_runtest_logreport") + assert len(reports) == 3, reports # setup/call/teardown + return reports[1] + + +class TestPDB: + def pytest_funcarg__pdblist(self, request): + monkeypatch = request.getfuncargvalue("monkeypatch") + pdblist = [] + def mypdb(*args): + pdblist.append(args) + plugin = request.config.pluginmanager.getplugin('pdb') + monkeypatch.setattr(plugin, 'post_mortem', mypdb) + return pdblist + + def test_pdb_on_fail(self, testdir, pdblist): + rep = runpdb_and_get_report(testdir, """ + def test_func(): + assert 0 + """) + assert rep.failed + assert len(pdblist) == 1 + tb = _pytest._code.Traceback(pdblist[0][0]) + assert tb[-1].name == "test_func" + + def test_pdb_on_xfail(self, testdir, pdblist): + rep = runpdb_and_get_report(testdir, """ + import pytest + @pytest.mark.xfail + def test_func(): + assert 0 + """) + assert "xfail" in rep.keywords + assert not pdblist + + def test_pdb_on_skip(self, testdir, pdblist): + rep = runpdb_and_get_report(testdir, """ + import pytest + def test_func(): + pytest.skip("hello") + """) + assert rep.skipped + assert len(pdblist) == 0 + + def test_pdb_on_BdbQuit(self, testdir, pdblist): + rep = runpdb_and_get_report(testdir, """ + import bdb + def test_func(): + raise bdb.BdbQuit + """) + assert rep.failed + assert len(pdblist) == 0 + + def test_pdb_interaction(self, testdir): + p1 = testdir.makepyfile(""" + def test_1(): + i = 0 + assert i == 1 + """) + child = testdir.spawn_pytest("--pdb %s" % p1) + child.expect(".*def test_1") + child.expect(".*i = 0") + child.expect("(Pdb)") + child.sendeof() + rest = child.read().decode("utf8") + assert "1 failed" in rest + assert "def test_1" not in rest + if child.isalive(): + child.wait() + + def test_pdb_interaction_capture(self, testdir): + p1 = testdir.makepyfile(""" + def test_1(): + print("getrekt") + assert False + """) + child = testdir.spawn_pytest("--pdb %s" % p1) + child.expect("getrekt") + child.expect("(Pdb)") + child.sendeof() + rest = child.read().decode("utf8") + assert "1 failed" in rest + assert "getrekt" not in rest + if child.isalive(): + child.wait() + + def test_pdb_interaction_exception(self, testdir): + p1 = testdir.makepyfile(""" + import pytest + def globalfunc(): + pass + def test_1(): + pytest.raises(ValueError, globalfunc) + """) + child = testdir.spawn_pytest("--pdb %s" % p1) + child.expect(".*def test_1") + child.expect(".*pytest.raises.*globalfunc") + child.expect("(Pdb)") + child.sendline("globalfunc") + child.expect(".*function") + child.sendeof() + child.expect("1 failed") + if child.isalive(): + child.wait() + + def test_pdb_interaction_on_collection_issue181(self, testdir): + p1 = testdir.makepyfile(""" + import pytest + xxx + """) + child = testdir.spawn_pytest("--pdb %s" % p1) + #child.expect(".*import pytest.*") + child.expect("(Pdb)") + child.sendeof() + child.expect("1 error") + if child.isalive(): + child.wait() + + def test_pdb_interaction_on_internal_error(self, testdir): + testdir.makeconftest(""" + def pytest_runtest_protocol(): + 0/0 + """) + p1 = testdir.makepyfile("def test_func(): pass") + child = testdir.spawn_pytest("--pdb %s" % p1) + #child.expect(".*import pytest.*") + child.expect("(Pdb)") + child.sendeof() + if child.isalive(): + child.wait() + + def test_pdb_interaction_capturing_simple(self, testdir): + p1 = testdir.makepyfile(""" + import pytest + def test_1(): + i = 0 + print ("hello17") + pytest.set_trace() + x = 3 + """) + child = testdir.spawn_pytest(str(p1)) + child.expect("test_1") + child.expect("x = 3") + child.expect("(Pdb)") + child.sendeof() + rest = child.read().decode("utf-8") + assert "1 failed" in rest + assert "def test_1" in rest + assert "hello17" in rest # out is captured + if child.isalive(): + child.wait() + + def test_pdb_set_trace_interception(self, testdir): + p1 = testdir.makepyfile(""" + import pdb + def test_1(): + pdb.set_trace() + """) + child = testdir.spawn_pytest(str(p1)) + child.expect("test_1") + child.expect("(Pdb)") + child.sendeof() + rest = child.read().decode("utf8") + assert "1 failed" in rest + assert "reading from stdin while output" not in rest + if child.isalive(): + child.wait() + + def test_pdb_and_capsys(self, testdir): + p1 = testdir.makepyfile(""" + import pytest + def test_1(capsys): + print ("hello1") + pytest.set_trace() + """) + child = testdir.spawn_pytest(str(p1)) + child.expect("test_1") + child.send("capsys.readouterr()\n") + child.expect("hello1") + child.sendeof() + child.read() + if child.isalive(): + child.wait() + + def test_set_trace_capturing_afterwards(self, testdir): + p1 = testdir.makepyfile(""" + import pdb + def test_1(): + pdb.set_trace() + def test_2(): + print ("hello") + assert 0 + """) + child = testdir.spawn_pytest(str(p1)) + child.expect("test_1") + child.send("c\n") + child.expect("test_2") + child.expect("Captured") + child.expect("hello") + child.sendeof() + child.read() + if child.isalive(): + child.wait() + + def test_pdb_interaction_doctest(self, testdir): + p1 = testdir.makepyfile(""" + import pytest + def function_1(): + ''' + >>> i = 0 + >>> assert i == 1 + ''' + """) + child = testdir.spawn_pytest("--doctest-modules --pdb %s" % p1) + child.expect("(Pdb)") + child.sendline('i') + child.expect("0") + child.expect("(Pdb)") + child.sendeof() + rest = child.read().decode("utf8") + assert "1 failed" in rest + if child.isalive(): + child.wait() + + def test_pdb_interaction_capturing_twice(self, testdir): + p1 = testdir.makepyfile(""" + import pytest + def test_1(): + i = 0 + print ("hello17") + pytest.set_trace() + x = 3 + print ("hello18") + pytest.set_trace() + x = 4 + """) + child = testdir.spawn_pytest(str(p1)) + child.expect("test_1") + child.expect("x = 3") + child.expect("(Pdb)") + child.sendline('c') + child.expect("x = 4") + child.sendeof() + rest = child.read().decode("utf8") + assert "1 failed" in rest + assert "def test_1" in rest + assert "hello17" in rest # out is captured + assert "hello18" in rest # out is captured + if child.isalive(): + child.wait() + + def test_pdb_used_outside_test(self, testdir): + p1 = testdir.makepyfile(""" + import pytest + pytest.set_trace() + x = 5 + """) + child = testdir.spawn("%s %s" %(sys.executable, p1)) + child.expect("x = 5") + child.sendeof() + child.wait() + + def test_pdb_used_in_generate_tests(self, testdir): + p1 = testdir.makepyfile(""" + import pytest + def pytest_generate_tests(metafunc): + pytest.set_trace() + x = 5 + def test_foo(a): + pass + """) + child = testdir.spawn_pytest(str(p1)) + child.expect("x = 5") + child.sendeof() + child.wait() + + def test_pdb_collection_failure_is_shown(self, testdir): + p1 = testdir.makepyfile("""xxx """) + result = testdir.runpytest_subprocess("--pdb", p1) + result.stdout.fnmatch_lines([ + "*NameError*xxx*", + "*1 error*", + ]) + + def test_enter_pdb_hook_is_called(self, testdir): + testdir.makeconftest(""" + def pytest_enter_pdb(config): + assert config.testing_verification == 'configured' + print 'enter_pdb_hook' + + def pytest_configure(config): + config.testing_verification = 'configured' + """) + p1 = testdir.makepyfile(""" + import pytest + + def test_foo(): + pytest.set_trace() + """) + child = testdir.spawn_pytest(str(p1)) + child.expect("enter_pdb_hook") + child.send('c\n') + child.sendeof() + if child.isalive(): + child.wait() diff --git a/testing/web-platform/tests/tools/pytest/testing/test_pluginmanager.py b/testing/web-platform/tests/tools/pytest/testing/test_pluginmanager.py new file mode 100644 index 000000000..36847638d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_pluginmanager.py @@ -0,0 +1,340 @@ +import pytest +import py +import os + +from _pytest.config import get_config, PytestPluginManager +from _pytest.main import EXIT_NOTESTSCOLLECTED + +@pytest.fixture +def pytestpm(): + return PytestPluginManager() + +class TestPytestPluginInteractions: + def test_addhooks_conftestplugin(self, testdir): + testdir.makepyfile(newhooks=""" + def pytest_myhook(xyz): + "new hook" + """) + conf = testdir.makeconftest(""" + import sys ; sys.path.insert(0, '.') + import newhooks + def pytest_addhooks(pluginmanager): + pluginmanager.addhooks(newhooks) + def pytest_myhook(xyz): + return xyz + 1 + """) + config = get_config() + pm = config.pluginmanager + pm.hook.pytest_addhooks.call_historic( + kwargs=dict(pluginmanager=config.pluginmanager)) + config.pluginmanager._importconftest(conf) + #print(config.pluginmanager.get_plugins()) + res = config.hook.pytest_myhook(xyz=10) + assert res == [11] + + def test_addhooks_nohooks(self, testdir): + testdir.makeconftest(""" + import sys + def pytest_addhooks(pluginmanager): + pluginmanager.addhooks(sys) + """) + res = testdir.runpytest() + assert res.ret != 0 + res.stderr.fnmatch_lines([ + "*did not find*sys*" + ]) + + def test_namespace_early_from_import(self, testdir): + p = testdir.makepyfile(""" + from pytest import Item + from pytest import Item as Item2 + assert Item is Item2 + """) + result = testdir.runpython(p) + assert result.ret == 0 + + def test_do_ext_namespace(self, testdir): + testdir.makeconftest(""" + def pytest_namespace(): + return {'hello': 'world'} + """) + p = testdir.makepyfile(""" + from pytest import hello + import pytest + def test_hello(): + assert hello == "world" + assert 'hello' in pytest.__all__ + """) + reprec = testdir.inline_run(p) + reprec.assertoutcome(passed=1) + + def test_do_option_postinitialize(self, testdir): + config = testdir.parseconfigure() + assert not hasattr(config.option, 'test123') + p = testdir.makepyfile(""" + def pytest_addoption(parser): + parser.addoption('--test123', action="store_true", + default=True) + """) + config.pluginmanager._importconftest(p) + assert config.option.test123 + + def test_configure(self, testdir): + config = testdir.parseconfig() + l = [] + class A: + def pytest_configure(self, config): + l.append(self) + + config.pluginmanager.register(A()) + assert len(l) == 0 + config._do_configure() + assert len(l) == 1 + config.pluginmanager.register(A()) # leads to a configured() plugin + assert len(l) == 2 + assert l[0] != l[1] + + config._ensure_unconfigure() + config.pluginmanager.register(A()) + assert len(l) == 2 + + def test_hook_tracing(self): + pytestpm = get_config().pluginmanager # fully initialized with plugins + saveindent = [] + class api1: + def pytest_plugin_registered(self): + saveindent.append(pytestpm.trace.root.indent) + class api2: + def pytest_plugin_registered(self): + saveindent.append(pytestpm.trace.root.indent) + raise ValueError() + l = [] + pytestpm.trace.root.setwriter(l.append) + undo = pytestpm.enable_tracing() + try: + indent = pytestpm.trace.root.indent + p = api1() + pytestpm.register(p) + assert pytestpm.trace.root.indent == indent + assert len(l) >= 2 + assert 'pytest_plugin_registered' in l[0] + assert 'finish' in l[1] + + l[:] = [] + with pytest.raises(ValueError): + pytestpm.register(api2()) + assert pytestpm.trace.root.indent == indent + assert saveindent[0] > indent + finally: + undo() + + def test_warn_on_deprecated_multicall(self, pytestpm): + warnings = [] + + class get_warnings: + def pytest_logwarning(self, message): + warnings.append(message) + + class Plugin: + def pytest_configure(self, __multicall__): + pass + + pytestpm.register(get_warnings()) + before = list(warnings) + pytestpm.register(Plugin()) + assert len(warnings) == len(before) + 1 + assert "deprecated" in warnings[-1] + + def test_warn_on_deprecated_addhooks(self, pytestpm): + warnings = [] + + class get_warnings: + def pytest_logwarning(self, code, fslocation, message, nodeid): + warnings.append(message) + + class Plugin: + def pytest_testhook(): + pass + + pytestpm.register(get_warnings()) + before = list(warnings) + pytestpm.addhooks(Plugin()) + assert len(warnings) == len(before) + 1 + assert "deprecated" in warnings[-1] + + +def test_namespace_has_default_and_env_plugins(testdir): + p = testdir.makepyfile(""" + import pytest + pytest.mark + """) + result = testdir.runpython(p) + assert result.ret == 0 + +def test_default_markers(testdir): + result = testdir.runpytest("--markers") + result.stdout.fnmatch_lines([ + "*tryfirst*first*", + "*trylast*last*", + ]) + + +def test_importplugin_issue375(testdir, pytestpm): + """Don't hide import errors when importing plugins and provide + an easy to debug message. + """ + testdir.syspathinsert(testdir.tmpdir) + testdir.makepyfile(qwe="import aaaa") + with pytest.raises(ImportError) as excinfo: + pytestpm.import_plugin("qwe") + expected = '.*Error importing plugin "qwe": No module named \'?aaaa\'?' + assert py.std.re.match(expected, str(excinfo.value)) + + +class TestPytestPluginManager: + def test_register_imported_modules(self): + pm = PytestPluginManager() + mod = py.std.types.ModuleType("x.y.pytest_hello") + pm.register(mod) + assert pm.is_registered(mod) + l = pm.get_plugins() + assert mod in l + pytest.raises(ValueError, "pm.register(mod)") + pytest.raises(ValueError, lambda: pm.register(mod)) + #assert not pm.is_registered(mod2) + assert pm.get_plugins() == l + + def test_canonical_import(self, monkeypatch): + mod = py.std.types.ModuleType("pytest_xyz") + monkeypatch.setitem(py.std.sys.modules, 'pytest_xyz', mod) + pm = PytestPluginManager() + pm.import_plugin('pytest_xyz') + assert pm.get_plugin('pytest_xyz') == mod + assert pm.is_registered(mod) + + def test_consider_module(self, testdir, pytestpm): + testdir.syspathinsert() + testdir.makepyfile(pytest_p1="#") + testdir.makepyfile(pytest_p2="#") + mod = py.std.types.ModuleType("temp") + mod.pytest_plugins = ["pytest_p1", "pytest_p2"] + pytestpm.consider_module(mod) + assert pytestpm.get_plugin("pytest_p1").__name__ == "pytest_p1" + assert pytestpm.get_plugin("pytest_p2").__name__ == "pytest_p2" + + def test_consider_module_import_module(self, testdir): + pytestpm = get_config().pluginmanager + mod = py.std.types.ModuleType("x") + mod.pytest_plugins = "pytest_a" + aplugin = testdir.makepyfile(pytest_a="#") + reprec = testdir.make_hook_recorder(pytestpm) + #syspath.prepend(aplugin.dirpath()) + py.std.sys.path.insert(0, str(aplugin.dirpath())) + pytestpm.consider_module(mod) + call = reprec.getcall(pytestpm.hook.pytest_plugin_registered.name) + assert call.plugin.__name__ == "pytest_a" + + # check that it is not registered twice + pytestpm.consider_module(mod) + l = reprec.getcalls("pytest_plugin_registered") + assert len(l) == 1 + + def test_consider_env_fails_to_import(self, monkeypatch, pytestpm): + monkeypatch.setenv('PYTEST_PLUGINS', 'nonexisting', prepend=",") + with pytest.raises(ImportError): + pytestpm.consider_env() + + def test_plugin_skip(self, testdir, monkeypatch): + p = testdir.makepyfile(skipping1=""" + import pytest + pytest.skip("hello") + """) + p.copy(p.dirpath("skipping2.py")) + monkeypatch.setenv("PYTEST_PLUGINS", "skipping2") + result = testdir.runpytest("-rw", "-p", "skipping1", syspathinsert=True) + assert result.ret == EXIT_NOTESTSCOLLECTED + result.stdout.fnmatch_lines([ + "WI1*skipped plugin*skipping1*hello*", + "WI1*skipped plugin*skipping2*hello*", + ]) + + def test_consider_env_plugin_instantiation(self, testdir, monkeypatch, pytestpm): + testdir.syspathinsert() + testdir.makepyfile(xy123="#") + monkeypatch.setitem(os.environ, 'PYTEST_PLUGINS', 'xy123') + l1 = len(pytestpm.get_plugins()) + pytestpm.consider_env() + l2 = len(pytestpm.get_plugins()) + assert l2 == l1 + 1 + assert pytestpm.get_plugin('xy123') + pytestpm.consider_env() + l3 = len(pytestpm.get_plugins()) + assert l2 == l3 + + def test_pluginmanager_ENV_startup(self, testdir, monkeypatch): + testdir.makepyfile(pytest_x500="#") + p = testdir.makepyfile(""" + import pytest + def test_hello(pytestconfig): + plugin = pytestconfig.pluginmanager.get_plugin('pytest_x500') + assert plugin is not None + """) + monkeypatch.setenv('PYTEST_PLUGINS', 'pytest_x500', prepend=",") + result = testdir.runpytest(p, syspathinsert=True) + assert result.ret == 0 + result.stdout.fnmatch_lines(["*1 passed*"]) + + def test_import_plugin_importname(self, testdir, pytestpm): + pytest.raises(ImportError, 'pytestpm.import_plugin("qweqwex.y")') + pytest.raises(ImportError, 'pytestpm.import_plugin("pytest_qweqwx.y")') + + testdir.syspathinsert() + pluginname = "pytest_hello" + testdir.makepyfile(**{pluginname: ""}) + pytestpm.import_plugin("pytest_hello") + len1 = len(pytestpm.get_plugins()) + pytestpm.import_plugin("pytest_hello") + len2 = len(pytestpm.get_plugins()) + assert len1 == len2 + plugin1 = pytestpm.get_plugin("pytest_hello") + assert plugin1.__name__.endswith('pytest_hello') + plugin2 = pytestpm.get_plugin("pytest_hello") + assert plugin2 is plugin1 + + def test_import_plugin_dotted_name(self, testdir, pytestpm): + pytest.raises(ImportError, 'pytestpm.import_plugin("qweqwex.y")') + pytest.raises(ImportError, 'pytestpm.import_plugin("pytest_qweqwex.y")') + + testdir.syspathinsert() + testdir.mkpydir("pkg").join("plug.py").write("x=3") + pluginname = "pkg.plug" + pytestpm.import_plugin(pluginname) + mod = pytestpm.get_plugin("pkg.plug") + assert mod.x == 3 + + def test_consider_conftest_deps(self, testdir, pytestpm): + mod = testdir.makepyfile("pytest_plugins='xyz'").pyimport() + with pytest.raises(ImportError): + pytestpm.consider_conftest(mod) + + +class TestPytestPluginManagerBootstrapming: + def test_preparse_args(self, pytestpm): + pytest.raises(ImportError, lambda: + pytestpm.consider_preparse(["xyz", "-p", "hello123"])) + + def test_plugin_prevent_register(self, pytestpm): + pytestpm.consider_preparse(["xyz", "-p", "no:abc"]) + l1 = pytestpm.get_plugins() + pytestpm.register(42, name="abc") + l2 = pytestpm.get_plugins() + assert len(l2) == len(l1) + assert 42 not in l2 + + def test_plugin_prevent_register_unregistered_alredy_registered(self, pytestpm): + pytestpm.register(42, name="abc") + l1 = pytestpm.get_plugins() + assert 42 in l1 + pytestpm.consider_preparse(["xyz", "-p", "no:abc"]) + l2 = pytestpm.get_plugins() + assert 42 not in l2 diff --git a/testing/web-platform/tests/tools/pytest/testing/test_pytester.py b/testing/web-platform/tests/tools/pytest/testing/test_pytester.py new file mode 100644 index 000000000..65660afdf --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_pytester.py @@ -0,0 +1,122 @@ +import pytest +import os +from _pytest.pytester import HookRecorder +from _pytest.config import PytestPluginManager +from _pytest.main import EXIT_OK, EXIT_TESTSFAILED + + +def test_make_hook_recorder(testdir): + item = testdir.getitem("def test_func(): pass") + recorder = testdir.make_hook_recorder(item.config.pluginmanager) + assert not recorder.getfailures() + + pytest.xfail("internal reportrecorder tests need refactoring") + class rep: + excinfo = None + passed = False + failed = True + skipped = False + when = "call" + + recorder.hook.pytest_runtest_logreport(report=rep) + failures = recorder.getfailures() + assert failures == [rep] + failures = recorder.getfailures() + assert failures == [rep] + + class rep: + excinfo = None + passed = False + failed = False + skipped = True + when = "call" + rep.passed = False + rep.skipped = True + recorder.hook.pytest_runtest_logreport(report=rep) + + modcol = testdir.getmodulecol("") + rep = modcol.config.hook.pytest_make_collect_report(collector=modcol) + rep.passed = False + rep.failed = True + rep.skipped = False + recorder.hook.pytest_collectreport(report=rep) + + passed, skipped, failed = recorder.listoutcomes() + assert not passed and skipped and failed + + numpassed, numskipped, numfailed = recorder.countoutcomes() + assert numpassed == 0 + assert numskipped == 1 + assert numfailed == 1 + assert len(recorder.getfailedcollections()) == 1 + + recorder.unregister() + recorder.clear() + recorder.hook.pytest_runtest_logreport(report=rep) + pytest.raises(ValueError, "recorder.getfailures()") + + +def test_parseconfig(testdir): + config1 = testdir.parseconfig() + config2 = testdir.parseconfig() + assert config2 != config1 + assert config1 != pytest.config + +def test_testdir_runs_with_plugin(testdir): + testdir.makepyfile(""" + pytest_plugins = "pytester" + def test_hello(testdir): + assert 1 + """) + result = testdir.runpytest() + result.assert_outcomes(passed=1) + + +def make_holder(): + class apiclass: + def pytest_xyz(self, arg): + "x" + def pytest_xyz_noarg(self): + "x" + + apimod = type(os)('api') + def pytest_xyz(arg): + "x" + def pytest_xyz_noarg(): + "x" + apimod.pytest_xyz = pytest_xyz + apimod.pytest_xyz_noarg = pytest_xyz_noarg + return apiclass, apimod + + +@pytest.mark.parametrize("holder", make_holder()) +def test_hookrecorder_basic(holder): + pm = PytestPluginManager() + pm.addhooks(holder) + rec = HookRecorder(pm) + pm.hook.pytest_xyz(arg=123) + call = rec.popcall("pytest_xyz") + assert call.arg == 123 + assert call._name == "pytest_xyz" + pytest.raises(pytest.fail.Exception, "rec.popcall('abc')") + pm.hook.pytest_xyz_noarg() + call = rec.popcall("pytest_xyz_noarg") + assert call._name == "pytest_xyz_noarg" + + +def test_makepyfile_unicode(testdir): + global unichr + try: + unichr(65) + except NameError: + unichr = chr + testdir.makepyfile(unichr(0xfffd)) + +def test_inline_run_clean_modules(testdir): + test_mod = testdir.makepyfile("def test_foo(): assert True") + result = testdir.inline_run(str(test_mod)) + assert result.ret == EXIT_OK + # rewrite module, now test should fail if module was re-imported + test_mod.write("def test_foo(): assert False") + result2 = testdir.inline_run(str(test_mod)) + assert result2.ret == EXIT_TESTSFAILED diff --git a/testing/web-platform/tests/tools/pytest/testing/test_recwarn.py b/testing/web-platform/tests/tools/pytest/testing/test_recwarn.py new file mode 100644 index 000000000..87e5846c2 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_recwarn.py @@ -0,0 +1,227 @@ +import warnings +import py +import pytest +from _pytest.recwarn import WarningsRecorder + + +def test_recwarn_functional(testdir): + reprec = testdir.inline_runsource(""" + import warnings + oldwarn = warnings.showwarning + def test_method(recwarn): + assert warnings.showwarning != oldwarn + warnings.warn("hello") + warn = recwarn.pop() + assert isinstance(warn.message, UserWarning) + def test_finalized(): + assert warnings.showwarning == oldwarn + """) + res = reprec.countoutcomes() + assert tuple(res) == (2, 0, 0), res + + +class TestWarningsRecorderChecker(object): + def test_recording(self, recwarn): + showwarning = py.std.warnings.showwarning + rec = WarningsRecorder() + with rec: + assert py.std.warnings.showwarning != showwarning + assert not rec.list + py.std.warnings.warn_explicit("hello", UserWarning, "xyz", 13) + assert len(rec.list) == 1 + py.std.warnings.warn(DeprecationWarning("hello")) + assert len(rec.list) == 2 + warn = rec.pop() + assert str(warn.message) == "hello" + l = rec.list + rec.clear() + assert len(rec.list) == 0 + assert l is rec.list + pytest.raises(AssertionError, "rec.pop()") + + assert showwarning == py.std.warnings.showwarning + + def test_typechecking(self): + from _pytest.recwarn import WarningsChecker + with pytest.raises(TypeError): + WarningsChecker(5) + with pytest.raises(TypeError): + WarningsChecker(('hi', RuntimeWarning)) + with pytest.raises(TypeError): + WarningsChecker([DeprecationWarning, RuntimeWarning]) + + def test_invalid_enter_exit(self): + # wrap this test in WarningsRecorder to ensure warning state gets reset + with WarningsRecorder(): + with pytest.raises(RuntimeError): + rec = WarningsRecorder() + rec.__exit__(None, None, None) # can't exit before entering + + with pytest.raises(RuntimeError): + rec = WarningsRecorder() + with rec: + with rec: + pass # can't enter twice + + +class TestDeprecatedCall(object): + """test pytest.deprecated_call()""" + + def dep(self, i, j=None): + if i == 0: + py.std.warnings.warn("is deprecated", DeprecationWarning, + stacklevel=1) + return 42 + + def dep_explicit(self, i): + if i == 0: + py.std.warnings.warn_explicit("dep_explicit", category=DeprecationWarning, + filename="hello", lineno=3) + + def test_deprecated_call_raises(self): + with pytest.raises(AssertionError) as excinfo: + pytest.deprecated_call(self.dep, 3, 5) + assert str(excinfo).find("did not produce") != -1 + + def test_deprecated_call(self): + pytest.deprecated_call(self.dep, 0, 5) + + def test_deprecated_call_ret(self): + ret = pytest.deprecated_call(self.dep, 0) + assert ret == 42 + + def test_deprecated_call_preserves(self): + onceregistry = py.std.warnings.onceregistry.copy() + filters = py.std.warnings.filters[:] + warn = py.std.warnings.warn + warn_explicit = py.std.warnings.warn_explicit + self.test_deprecated_call_raises() + self.test_deprecated_call() + assert onceregistry == py.std.warnings.onceregistry + assert filters == py.std.warnings.filters + assert warn is py.std.warnings.warn + assert warn_explicit is py.std.warnings.warn_explicit + + def test_deprecated_explicit_call_raises(self): + with pytest.raises(AssertionError): + pytest.deprecated_call(self.dep_explicit, 3) + + def test_deprecated_explicit_call(self): + pytest.deprecated_call(self.dep_explicit, 0) + pytest.deprecated_call(self.dep_explicit, 0) + + def test_deprecated_call_as_context_manager_no_warning(self): + with pytest.raises(pytest.fail.Exception) as ex: + with pytest.deprecated_call(): + self.dep(1) + assert str(ex.value) == "DID NOT WARN" + + def test_deprecated_call_as_context_manager(self): + with pytest.deprecated_call(): + self.dep(0) + + def test_deprecated_call_pending(self): + def f(): + py.std.warnings.warn(PendingDeprecationWarning("hi")) + pytest.deprecated_call(f) + + def test_deprecated_call_specificity(self): + other_warnings = [Warning, UserWarning, SyntaxWarning, RuntimeWarning, + FutureWarning, ImportWarning, UnicodeWarning] + for warning in other_warnings: + def f(): + py.std.warnings.warn(warning("hi")) + with pytest.raises(AssertionError): + pytest.deprecated_call(f) + + def test_deprecated_function_already_called(self, testdir): + """deprecated_call should be able to catch a call to a deprecated + function even if that function has already been called in the same + module. See #1190. + """ + testdir.makepyfile(""" + import warnings + import pytest + + def deprecated_function(): + warnings.warn("deprecated", DeprecationWarning) + + def test_one(): + deprecated_function() + + def test_two(): + pytest.deprecated_call(deprecated_function) + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines('*=== 2 passed in *===') + + +class TestWarns(object): + def test_strings(self): + # different messages, b/c Python suppresses multiple identical warnings + source1 = "warnings.warn('w1', RuntimeWarning)" + source2 = "warnings.warn('w2', RuntimeWarning)" + source3 = "warnings.warn('w3', RuntimeWarning)" + pytest.warns(RuntimeWarning, source1) + pytest.raises(pytest.fail.Exception, + lambda: pytest.warns(UserWarning, source2)) + pytest.warns(RuntimeWarning, source3) + + def test_function(self): + pytest.warns(SyntaxWarning, + lambda msg: warnings.warn(msg, SyntaxWarning), "syntax") + + def test_warning_tuple(self): + pytest.warns((RuntimeWarning, SyntaxWarning), + lambda: warnings.warn('w1', RuntimeWarning)) + pytest.warns((RuntimeWarning, SyntaxWarning), + lambda: warnings.warn('w2', SyntaxWarning)) + pytest.raises(pytest.fail.Exception, + lambda: pytest.warns( + (RuntimeWarning, SyntaxWarning), + lambda: warnings.warn('w3', UserWarning))) + + def test_as_contextmanager(self): + with pytest.warns(RuntimeWarning): + warnings.warn("runtime", RuntimeWarning) + + with pytest.raises(pytest.fail.Exception): + with pytest.warns(RuntimeWarning): + warnings.warn("user", UserWarning) + + with pytest.raises(pytest.fail.Exception): + with pytest.warns(UserWarning): + warnings.warn("runtime", RuntimeWarning) + + with pytest.warns(UserWarning): + warnings.warn("user", UserWarning) + + def test_record(self): + with pytest.warns(UserWarning) as record: + warnings.warn("user", UserWarning) + + assert len(record) == 1 + assert str(record[0].message) == "user" + + def test_record_only(self): + with pytest.warns(None) as record: + warnings.warn("user", UserWarning) + warnings.warn("runtime", RuntimeWarning) + + assert len(record) == 2 + assert str(record[0].message) == "user" + assert str(record[1].message) == "runtime" + + def test_double_test(self, testdir): + """If a test is run again, the warning should still be raised""" + testdir.makepyfile(''' + import pytest + import warnings + + @pytest.mark.parametrize('run', [1, 2]) + def test(run): + with pytest.warns(RuntimeWarning): + warnings.warn("runtime", RuntimeWarning) + ''') + result = testdir.runpytest() + result.stdout.fnmatch_lines(['*2 passed in*']) diff --git a/testing/web-platform/tests/tools/pytest/testing/test_resultlog.py b/testing/web-platform/tests/tools/pytest/testing/test_resultlog.py new file mode 100644 index 000000000..74d13f643 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_resultlog.py @@ -0,0 +1,236 @@ +import os + +import _pytest._code +import py +import pytest +from _pytest.main import Node, Item, FSCollector +from _pytest.resultlog import generic_path, ResultLog, \ + pytest_configure, pytest_unconfigure + + +def test_generic_path(testdir): + from _pytest.main import Session + config = testdir.parseconfig() + session = Session(config) + p1 = Node('a', config=config, session=session) + #assert p1.fspath is None + p2 = Node('B', parent=p1) + p3 = Node('()', parent = p2) + item = Item('c', parent = p3) + + res = generic_path(item) + assert res == 'a.B().c' + + p0 = FSCollector('proj/test', config=config, session=session) + p1 = FSCollector('proj/test/a', parent=p0) + p2 = Node('B', parent=p1) + p3 = Node('()', parent = p2) + p4 = Node('c', parent=p3) + item = Item('[1]', parent = p4) + + res = generic_path(item) + assert res == 'test/a:B().c[1]' + +def test_write_log_entry(): + reslog = ResultLog(None, None) + reslog.logfile = py.io.TextIO() + reslog.write_log_entry('name', '.', '') + entry = reslog.logfile.getvalue() + assert entry[-1] == '\n' + entry_lines = entry.splitlines() + assert len(entry_lines) == 1 + assert entry_lines[0] == '. name' + + reslog.logfile = py.io.TextIO() + reslog.write_log_entry('name', 's', 'Skipped') + entry = reslog.logfile.getvalue() + assert entry[-1] == '\n' + entry_lines = entry.splitlines() + assert len(entry_lines) == 2 + assert entry_lines[0] == 's name' + assert entry_lines[1] == ' Skipped' + + reslog.logfile = py.io.TextIO() + reslog.write_log_entry('name', 's', 'Skipped\n') + entry = reslog.logfile.getvalue() + assert entry[-1] == '\n' + entry_lines = entry.splitlines() + assert len(entry_lines) == 2 + assert entry_lines[0] == 's name' + assert entry_lines[1] == ' Skipped' + + reslog.logfile = py.io.TextIO() + longrepr = ' tb1\n tb 2\nE tb3\nSome Error' + reslog.write_log_entry('name', 'F', longrepr) + entry = reslog.logfile.getvalue() + assert entry[-1] == '\n' + entry_lines = entry.splitlines() + assert len(entry_lines) == 5 + assert entry_lines[0] == 'F name' + assert entry_lines[1:] == [' '+line for line in longrepr.splitlines()] + + +class TestWithFunctionIntegration: + # XXX (hpk) i think that the resultlog plugin should + # provide a Parser object so that one can remain + # ignorant regarding formatting details. + def getresultlog(self, testdir, arg): + resultlog = testdir.tmpdir.join("resultlog") + testdir.plugins.append("resultlog") + args = ["--resultlog=%s" % resultlog] + [arg] + testdir.runpytest(*args) + return [x for x in resultlog.readlines(cr=0) if x] + + def test_collection_report(self, testdir): + ok = testdir.makepyfile(test_collection_ok="") + skip = testdir.makepyfile(test_collection_skip= + "import pytest ; pytest.skip('hello')") + fail = testdir.makepyfile(test_collection_fail="XXX") + lines = self.getresultlog(testdir, ok) + assert not lines + + lines = self.getresultlog(testdir, skip) + assert len(lines) == 2 + assert lines[0].startswith("S ") + assert lines[0].endswith("test_collection_skip.py") + assert lines[1].startswith(" ") + assert lines[1].endswith("test_collection_skip.py:1: Skipped: hello") + + lines = self.getresultlog(testdir, fail) + assert lines + assert lines[0].startswith("F ") + assert lines[0].endswith("test_collection_fail.py"), lines[0] + for x in lines[1:]: + assert x.startswith(" ") + assert "XXX" in "".join(lines[1:]) + + def test_log_test_outcomes(self, testdir): + mod = testdir.makepyfile(test_mod=""" + import pytest + def test_pass(): pass + def test_skip(): pytest.skip("hello") + def test_fail(): raise ValueError("FAIL") + + @pytest.mark.xfail + def test_xfail(): raise ValueError("XFAIL") + @pytest.mark.xfail + def test_xpass(): pass + + """) + lines = self.getresultlog(testdir, mod) + assert len(lines) >= 3 + assert lines[0].startswith(". ") + assert lines[0].endswith("test_pass") + assert lines[1].startswith("s "), lines[1] + assert lines[1].endswith("test_skip") + assert lines[2].find("hello") != -1 + + assert lines[3].startswith("F ") + assert lines[3].endswith("test_fail") + tb = "".join(lines[4:8]) + assert tb.find('raise ValueError("FAIL")') != -1 + + assert lines[8].startswith('x ') + tb = "".join(lines[8:14]) + assert tb.find('raise ValueError("XFAIL")') != -1 + + assert lines[14].startswith('X ') + assert len(lines) == 15 + + @pytest.mark.parametrize("style", ("native", "long", "short")) + def test_internal_exception(self, style): + # they are produced for example by a teardown failing + # at the end of the run or a failing hook invocation + try: + raise ValueError + except ValueError: + excinfo = _pytest._code.ExceptionInfo() + reslog = ResultLog(None, py.io.TextIO()) + reslog.pytest_internalerror(excinfo.getrepr(style=style)) + entry = reslog.logfile.getvalue() + entry_lines = entry.splitlines() + + assert entry_lines[0].startswith('! ') + if style != "native": + assert os.path.basename(__file__)[:-9] in entry_lines[0] #.pyc/class + assert entry_lines[-1][0] == ' ' + assert 'ValueError' in entry + + +def test_generic(testdir, LineMatcher): + testdir.plugins.append("resultlog") + testdir.makepyfile(""" + import pytest + def test_pass(): + pass + def test_fail(): + assert 0 + def test_skip(): + pytest.skip("") + @pytest.mark.xfail + def test_xfail(): + assert 0 + @pytest.mark.xfail(run=False) + def test_xfail_norun(): + assert 0 + """) + testdir.runpytest("--resultlog=result.log") + lines = testdir.tmpdir.join("result.log").readlines(cr=0) + LineMatcher(lines).fnmatch_lines([ + ". *:test_pass", + "F *:test_fail", + "s *:test_skip", + "x *:test_xfail", + "x *:test_xfail_norun", + ]) + +def test_makedir_for_resultlog(testdir, LineMatcher): + """--resultlog should automatically create directories for the log file""" + testdir.plugins.append("resultlog") + testdir.makepyfile(""" + import pytest + def test_pass(): + pass + """) + testdir.runpytest("--resultlog=path/to/result.log") + lines = testdir.tmpdir.join("path/to/result.log").readlines(cr=0) + LineMatcher(lines).fnmatch_lines([ + ". *:test_pass", + ]) + + +def test_no_resultlog_on_slaves(testdir): + config = testdir.parseconfig("-p", "resultlog", "--resultlog=resultlog") + + assert not hasattr(config, '_resultlog') + pytest_configure(config) + assert hasattr(config, '_resultlog') + pytest_unconfigure(config) + assert not hasattr(config, '_resultlog') + + config.slaveinput = {} + pytest_configure(config) + assert not hasattr(config, '_resultlog') + pytest_unconfigure(config) + assert not hasattr(config, '_resultlog') + + +def test_failure_issue380(testdir): + testdir.makeconftest(""" + import pytest + class MyCollector(pytest.File): + def collect(self): + raise ValueError() + def repr_failure(self, excinfo): + return "somestring" + def pytest_collect_file(path, parent): + return MyCollector(parent=parent, fspath=path) + """) + testdir.makepyfile(""" + def test_func(): + pass + """) + result = testdir.runpytest("--resultlog=log") + assert result.ret == 1 + + diff --git a/testing/web-platform/tests/tools/pytest/testing/test_runner.py b/testing/web-platform/tests/tools/pytest/testing/test_runner.py new file mode 100644 index 000000000..4421c5d0d --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_runner.py @@ -0,0 +1,634 @@ +# -*- coding: utf-8 -*- +from __future__ import with_statement + +import _pytest._code +import os +import py +import pytest +import sys +from _pytest import runner, main + +class TestSetupState: + def test_setup(self, testdir): + ss = runner.SetupState() + item = testdir.getitem("def test_func(): pass") + l = [1] + ss.prepare(item) + ss.addfinalizer(l.pop, colitem=item) + assert l + ss._pop_and_teardown() + assert not l + + def test_teardown_exact_stack_empty(self, testdir): + item = testdir.getitem("def test_func(): pass") + ss = runner.SetupState() + ss.teardown_exact(item, None) + ss.teardown_exact(item, None) + ss.teardown_exact(item, None) + + def test_setup_fails_and_failure_is_cached(self, testdir): + item = testdir.getitem(""" + def setup_module(mod): + raise ValueError(42) + def test_func(): pass + """) # noqa + ss = runner.SetupState() + pytest.raises(ValueError, lambda: ss.prepare(item)) + pytest.raises(ValueError, lambda: ss.prepare(item)) + + def test_teardown_multiple_one_fails(self, testdir): + r = [] + def fin1(): r.append('fin1') + def fin2(): raise Exception('oops') + def fin3(): r.append('fin3') + item = testdir.getitem("def test_func(): pass") + ss = runner.SetupState() + ss.addfinalizer(fin1, item) + ss.addfinalizer(fin2, item) + ss.addfinalizer(fin3, item) + with pytest.raises(Exception) as err: + ss._callfinalizers(item) + assert err.value.args == ('oops',) + assert r == ['fin3', 'fin1'] + + def test_teardown_multiple_fail(self, testdir): + # Ensure the first exception is the one which is re-raised. + # Ideally both would be reported however. + def fin1(): raise Exception('oops1') + def fin2(): raise Exception('oops2') + item = testdir.getitem("def test_func(): pass") + ss = runner.SetupState() + ss.addfinalizer(fin1, item) + ss.addfinalizer(fin2, item) + with pytest.raises(Exception) as err: + ss._callfinalizers(item) + assert err.value.args == ('oops2',) + + +class BaseFunctionalTests: + def test_passfunction(self, testdir): + reports = testdir.runitem(""" + def test_func(): + pass + """) + rep = reports[1] + assert rep.passed + assert not rep.failed + assert rep.outcome == "passed" + assert not rep.longrepr + + def test_failfunction(self, testdir): + reports = testdir.runitem(""" + def test_func(): + assert 0 + """) + rep = reports[1] + assert not rep.passed + assert not rep.skipped + assert rep.failed + assert rep.when == "call" + assert rep.outcome == "failed" + #assert isinstance(rep.longrepr, ReprExceptionInfo) + + def test_skipfunction(self, testdir): + reports = testdir.runitem(""" + import pytest + def test_func(): + pytest.skip("hello") + """) + rep = reports[1] + assert not rep.failed + assert not rep.passed + assert rep.skipped + assert rep.outcome == "skipped" + #assert rep.skipped.when == "call" + #assert rep.skipped.when == "call" + #assert rep.skipped == "%sreason == "hello" + #assert rep.skipped.location.lineno == 3 + #assert rep.skipped.location.path + #assert not rep.skipped.failurerepr + + def test_skip_in_setup_function(self, testdir): + reports = testdir.runitem(""" + import pytest + def setup_function(func): + pytest.skip("hello") + def test_func(): + pass + """) + print(reports) + rep = reports[0] + assert not rep.failed + assert not rep.passed + assert rep.skipped + #assert rep.skipped.reason == "hello" + #assert rep.skipped.location.lineno == 3 + #assert rep.skipped.location.lineno == 3 + assert len(reports) == 2 + assert reports[1].passed # teardown + + def test_failure_in_setup_function(self, testdir): + reports = testdir.runitem(""" + import pytest + def setup_function(func): + raise ValueError(42) + def test_func(): + pass + """) + rep = reports[0] + assert not rep.skipped + assert not rep.passed + assert rep.failed + assert rep.when == "setup" + assert len(reports) == 2 + + def test_failure_in_teardown_function(self, testdir): + reports = testdir.runitem(""" + import pytest + def teardown_function(func): + raise ValueError(42) + def test_func(): + pass + """) + print(reports) + assert len(reports) == 3 + rep = reports[2] + assert not rep.skipped + assert not rep.passed + assert rep.failed + assert rep.when == "teardown" + #assert rep.longrepr.reprcrash.lineno == 3 + #assert rep.longrepr.reprtraceback.reprentries + + def test_custom_failure_repr(self, testdir): + testdir.makepyfile(conftest=""" + import pytest + class Function(pytest.Function): + def repr_failure(self, excinfo): + return "hello" + """) + reports = testdir.runitem(""" + import pytest + def test_func(): + assert 0 + """) + rep = reports[1] + assert not rep.skipped + assert not rep.passed + assert rep.failed + #assert rep.outcome.when == "call" + #assert rep.failed.where.lineno == 3 + #assert rep.failed.where.path.basename == "test_func.py" + #assert rep.failed.failurerepr == "hello" + + def test_teardown_final_returncode(self, testdir): + rec = testdir.inline_runsource(""" + def test_func(): + pass + def teardown_function(func): + raise ValueError(42) + """) + assert rec.ret == 1 + + def test_exact_teardown_issue90(self, testdir): + rec = testdir.inline_runsource(""" + import pytest + + class TestClass: + def test_method(self): + pass + def teardown_class(cls): + raise Exception() + + def test_func(): + import sys + # on python2 exc_info is keept till a function exits + # so we would end up calling test functions while + # sys.exc_info would return the indexerror + # from guessing the lastitem + excinfo = sys.exc_info() + import traceback + assert excinfo[0] is None, \ + traceback.format_exception(*excinfo) + def teardown_function(func): + raise ValueError(42) + """) + reps = rec.getreports("pytest_runtest_logreport") + print (reps) + for i in range(2): + assert reps[i].nodeid.endswith("test_method") + assert reps[i].passed + assert reps[2].when == "teardown" + assert reps[2].failed + assert len(reps) == 6 + for i in range(3,5): + assert reps[i].nodeid.endswith("test_func") + assert reps[i].passed + assert reps[5].when == "teardown" + assert reps[5].nodeid.endswith("test_func") + assert reps[5].failed + + def test_failure_in_setup_function_ignores_custom_repr(self, testdir): + testdir.makepyfile(conftest=""" + import pytest + class Function(pytest.Function): + def repr_failure(self, excinfo): + assert 0 + """) + reports = testdir.runitem(""" + def setup_function(func): + raise ValueError(42) + def test_func(): + pass + """) + assert len(reports) == 2 + rep = reports[0] + print(rep) + assert not rep.skipped + assert not rep.passed + assert rep.failed + #assert rep.outcome.when == "setup" + #assert rep.outcome.where.lineno == 3 + #assert rep.outcome.where.path.basename == "test_func.py" + #assert instanace(rep.failed.failurerepr, PythonFailureRepr) + + def test_systemexit_does_not_bail_out(self, testdir): + try: + reports = testdir.runitem(""" + def test_func(): + raise SystemExit(42) + """) + except SystemExit: + pytest.fail("runner did not catch SystemExit") + rep = reports[1] + assert rep.failed + assert rep.when == "call" + + def test_exit_propagates(self, testdir): + try: + testdir.runitem(""" + import pytest + def test_func(): + raise pytest.exit.Exception() + """) + except pytest.exit.Exception: + pass + else: + pytest.fail("did not raise") + +class TestExecutionNonForked(BaseFunctionalTests): + def getrunner(self): + def f(item): + return runner.runtestprotocol(item, log=False) + return f + + def test_keyboardinterrupt_propagates(self, testdir): + try: + testdir.runitem(""" + def test_func(): + raise KeyboardInterrupt("fake") + """) + except KeyboardInterrupt: + pass + else: + pytest.fail("did not raise") + +class TestExecutionForked(BaseFunctionalTests): + pytestmark = pytest.mark.skipif("not hasattr(os, 'fork')") + + def getrunner(self): + # XXX re-arrange this test to live in pytest-xdist + boxed = pytest.importorskip("xdist.boxed") + return boxed.forked_run_report + + def test_suicide(self, testdir): + reports = testdir.runitem(""" + def test_func(): + import os + os.kill(os.getpid(), 15) + """) + rep = reports[0] + assert rep.failed + assert rep.when == "???" + +class TestSessionReports: + def test_collect_result(self, testdir): + col = testdir.getmodulecol(""" + def test_func1(): + pass + class TestClass: + pass + """) + rep = runner.collect_one_node(col) + assert not rep.failed + assert not rep.skipped + assert rep.passed + locinfo = rep.location + assert locinfo[0] == col.fspath.basename + assert not locinfo[1] + assert locinfo[2] == col.fspath.basename + res = rep.result + assert len(res) == 2 + assert res[0].name == "test_func1" + assert res[1].name == "TestClass" + + def test_skip_at_module_scope(self, testdir): + col = testdir.getmodulecol(""" + import pytest + pytest.skip("hello") + def test_func(): + pass + """) + rep = main.collect_one_node(col) + assert not rep.failed + assert not rep.passed + assert rep.skipped + + +reporttypes = [ + runner.BaseReport, + runner.TestReport, + runner.TeardownErrorReport, + runner.CollectReport, +] + +@pytest.mark.parametrize('reporttype', reporttypes, ids=[x.__name__ for x in reporttypes]) +def test_report_extra_parameters(reporttype): + if hasattr(py.std.inspect, 'signature'): + args = list(py.std.inspect.signature(reporttype.__init__).parameters.keys())[1:] + else: + args = py.std.inspect.getargspec(reporttype.__init__)[0][1:] + basekw = dict.fromkeys(args, []) + report = reporttype(newthing=1, **basekw) + assert report.newthing == 1 + +def test_callinfo(): + ci = runner.CallInfo(lambda: 0, '123') + assert ci.when == "123" + assert ci.result == 0 + assert "result" in repr(ci) + ci = runner.CallInfo(lambda: 0/0, '123') + assert ci.when == "123" + assert not hasattr(ci, 'result') + assert ci.excinfo + assert "exc" in repr(ci) + +# design question: do we want general hooks in python files? +# then something like the following functional tests makes sense +@pytest.mark.xfail +def test_runtest_in_module_ordering(testdir): + p1 = testdir.makepyfile(""" + def pytest_runtest_setup(item): # runs after class-level! + item.function.mylist.append("module") + class TestClass: + def pytest_runtest_setup(self, item): + assert not hasattr(item.function, 'mylist') + item.function.mylist = ['class'] + def pytest_funcarg__mylist(self, request): + return request.function.mylist + def pytest_runtest_call(self, item, __multicall__): + try: + __multicall__.execute() + except ValueError: + pass + def test_hello1(self, mylist): + assert mylist == ['class', 'module'], mylist + raise ValueError() + def test_hello2(self, mylist): + assert mylist == ['class', 'module'], mylist + def pytest_runtest_teardown(item): + del item.function.mylist + """) + result = testdir.runpytest(p1) + result.stdout.fnmatch_lines([ + "*2 passed*" + ]) + + +def test_outcomeexception_exceptionattributes(): + outcome = runner.OutcomeException('test') + assert outcome.args[0] == outcome.msg + +def test_pytest_exit(): + try: + pytest.exit("hello") + except pytest.exit.Exception: + excinfo = _pytest._code.ExceptionInfo() + assert excinfo.errisinstance(KeyboardInterrupt) + +def test_pytest_fail(): + try: + pytest.fail("hello") + except pytest.fail.Exception: + excinfo = _pytest._code.ExceptionInfo() + s = excinfo.exconly(tryshort=True) + assert s.startswith("Failed") + +def test_pytest_fail_notrace(testdir): + testdir.makepyfile(""" + import pytest + def test_hello(): + pytest.fail("hello", pytrace=False) + def teardown_function(function): + pytest.fail("world", pytrace=False) + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "world", + "hello", + ]) + assert 'def teardown_function' not in result.stdout.str() + + +@pytest.mark.parametrize('str_prefix', ['u', '']) +def test_pytest_fail_notrace_non_ascii(testdir, str_prefix): + """Fix pytest.fail with pytrace=False with non-ascii characters (#1178). + + This tests with native and unicode strings containing non-ascii chars. + """ + testdir.makepyfile(u""" + # coding: utf-8 + import pytest + + def test_hello(): + pytest.fail(%s'oh oh: ☺', pytrace=False) + """ % str_prefix) + result = testdir.runpytest() + if sys.version_info[0] >= 3: + result.stdout.fnmatch_lines(['*test_hello*', "oh oh: ☺"]) + else: + result.stdout.fnmatch_lines(['*test_hello*', "oh oh: *"]) + assert 'def test_hello' not in result.stdout.str() + + +def test_pytest_no_tests_collected_exit_status(testdir): + result = testdir.runpytest() + result.stdout.fnmatch_lines('*collected 0 items*') + assert result.ret == main.EXIT_NOTESTSCOLLECTED + + testdir.makepyfile(test_foo=""" + def test_foo(): + assert 1 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines('*collected 1 items*') + result.stdout.fnmatch_lines('*1 passed*') + assert result.ret == main.EXIT_OK + + result = testdir.runpytest('-k nonmatch') + result.stdout.fnmatch_lines('*collected 1 items*') + result.stdout.fnmatch_lines('*1 deselected*') + assert result.ret == main.EXIT_NOTESTSCOLLECTED + + +def test_exception_printing_skip(): + try: + pytest.skip("hello") + except pytest.skip.Exception: + excinfo = _pytest._code.ExceptionInfo() + s = excinfo.exconly(tryshort=True) + assert s.startswith("Skipped") + +def test_importorskip(monkeypatch): + importorskip = pytest.importorskip + def f(): + importorskip("asdlkj") + try: + sys = importorskip("sys") # noqa + assert sys == py.std.sys + #path = pytest.importorskip("os.path") + #assert path == py.std.os.path + excinfo = pytest.raises(pytest.skip.Exception, f) + path = py.path.local(excinfo.getrepr().reprcrash.path) + # check that importorskip reports the actual call + # in this test the test_runner.py file + assert path.purebasename == "test_runner" + pytest.raises(SyntaxError, "pytest.importorskip('x y z')") + pytest.raises(SyntaxError, "pytest.importorskip('x=y')") + mod = py.std.types.ModuleType("hello123") + mod.__version__ = "1.3" + monkeypatch.setitem(sys.modules, "hello123", mod) + pytest.raises(pytest.skip.Exception, """ + pytest.importorskip("hello123", minversion="1.3.1") + """) + mod2 = pytest.importorskip("hello123", minversion="1.3") + assert mod2 == mod + except pytest.skip.Exception: + print(_pytest._code.ExceptionInfo()) + pytest.fail("spurious skip") + +def test_importorskip_imports_last_module_part(): + ospath = pytest.importorskip("os.path") + assert os.path == ospath + +def test_importorskip_dev_module(monkeypatch): + try: + mod = py.std.types.ModuleType("mockmodule") + mod.__version__ = '0.13.0.dev-43290' + monkeypatch.setitem(sys.modules, 'mockmodule', mod) + mod2 = pytest.importorskip('mockmodule', minversion='0.12.0') + assert mod2 == mod + pytest.raises(pytest.skip.Exception, """ + pytest.importorskip('mockmodule1', minversion='0.14.0')""") + except pytest.skip.Exception: + print(_pytest._code.ExceptionInfo()) + pytest.fail("spurious skip") + + +def test_pytest_cmdline_main(testdir): + p = testdir.makepyfile(""" + import pytest + def test_hello(): + assert 1 + if __name__ == '__main__': + pytest.cmdline.main([__file__]) + """) + import subprocess + popen = subprocess.Popen([sys.executable, str(p)], stdout=subprocess.PIPE) + popen.communicate() + ret = popen.wait() + assert ret == 0 + + +def test_unicode_in_longrepr(testdir): + testdir.makeconftest(""" + import py + def pytest_runtest_makereport(__multicall__): + rep = __multicall__.execute() + if rep.when == "call": + rep.longrepr = py.builtin._totext("\\xc3\\xa4", "utf8") + return rep + """) + testdir.makepyfile(""" + def test_out(): + assert 0 + """) + result = testdir.runpytest() + assert result.ret == 1 + assert "UnicodeEncodeError" not in result.stderr.str() + + +def test_failure_in_setup(testdir): + testdir.makepyfile(""" + def setup_module(): + 0/0 + def test_func(): + pass + """) + result = testdir.runpytest("--tb=line") + assert "def setup_module" not in result.stdout.str() + + +def test_makereport_getsource(testdir): + testdir.makepyfile(""" + def test_foo(): + if False: pass + else: assert False + """) + result = testdir.runpytest() + assert 'INTERNALERROR' not in result.stdout.str() + result.stdout.fnmatch_lines(['*else: assert False*']) + + +def test_makereport_getsource_dynamic_code(testdir, monkeypatch): + """Test that exception in dynamically generated code doesn't break getting the source line.""" + import inspect + original_findsource = inspect.findsource + def findsource(obj, *args, **kwargs): + # Can be triggered by dynamically created functions + if obj.__name__ == 'foo': + raise IndexError() + return original_findsource(obj, *args, **kwargs) + monkeypatch.setattr(inspect, 'findsource', findsource) + + testdir.makepyfile(""" + import pytest + + @pytest.fixture + def foo(missing): + pass + + def test_fix(foo): + assert False + """) + result = testdir.runpytest('-vv') + assert 'INTERNALERROR' not in result.stdout.str() + result.stdout.fnmatch_lines(["*test_fix*", "*fixture*'missing'*not found*"]) + + +def test_store_except_info_on_eror(): + """ Test that upon test failure, the exception info is stored on + sys.last_traceback and friends. + """ + # Simulate item that raises a specific exception + class ItemThatRaises: + def runtest(self): + raise IndexError('TEST') + try: + runner.pytest_runtest_call(ItemThatRaises()) + except IndexError: + pass + # Check that exception info is stored on sys + assert sys.last_type is IndexError + assert sys.last_value.args[0] == 'TEST' + assert sys.last_traceback diff --git a/testing/web-platform/tests/tools/pytest/testing/test_runner_xunit.py b/testing/web-platform/tests/tools/pytest/testing/test_runner_xunit.py new file mode 100644 index 000000000..f32a1311b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_runner_xunit.py @@ -0,0 +1,252 @@ +# +# test correct setup/teardowns at +# module, class, and instance level + +def test_module_and_function_setup(testdir): + reprec = testdir.inline_runsource(""" + modlevel = [] + def setup_module(module): + assert not modlevel + module.modlevel.append(42) + + def teardown_module(module): + modlevel.pop() + + def setup_function(function): + function.answer = 17 + + def teardown_function(function): + del function.answer + + def test_modlevel(): + assert modlevel[0] == 42 + assert test_modlevel.answer == 17 + + class TestFromClass: + def test_module(self): + assert modlevel[0] == 42 + assert not hasattr(test_modlevel, 'answer') + """) + rep = reprec.matchreport("test_modlevel") + assert rep.passed + rep = reprec.matchreport("test_module") + assert rep.passed + +def test_module_setup_failure_no_teardown(testdir): + reprec = testdir.inline_runsource(""" + l = [] + def setup_module(module): + l.append(1) + 0/0 + + def test_nothing(): + pass + + def teardown_module(module): + l.append(2) + """) + reprec.assertoutcome(failed=1) + calls = reprec.getcalls("pytest_runtest_setup") + assert calls[0].item.module.l == [1] + +def test_setup_function_failure_no_teardown(testdir): + reprec = testdir.inline_runsource(""" + modlevel = [] + def setup_function(function): + modlevel.append(1) + 0/0 + + def teardown_function(module): + modlevel.append(2) + + def test_func(): + pass + """) + calls = reprec.getcalls("pytest_runtest_setup") + assert calls[0].item.module.modlevel == [1] + +def test_class_setup(testdir): + reprec = testdir.inline_runsource(""" + class TestSimpleClassSetup: + clslevel = [] + def setup_class(cls): + cls.clslevel.append(23) + + def teardown_class(cls): + cls.clslevel.pop() + + def test_classlevel(self): + assert self.clslevel[0] == 23 + + class TestInheritedClassSetupStillWorks(TestSimpleClassSetup): + def test_classlevel_anothertime(self): + assert self.clslevel == [23] + + def test_cleanup(): + assert not TestSimpleClassSetup.clslevel + assert not TestInheritedClassSetupStillWorks.clslevel + """) + reprec.assertoutcome(passed=1+2+1) + +def test_class_setup_failure_no_teardown(testdir): + reprec = testdir.inline_runsource(""" + class TestSimpleClassSetup: + clslevel = [] + def setup_class(cls): + 0/0 + + def teardown_class(cls): + cls.clslevel.append(1) + + def test_classlevel(self): + pass + + def test_cleanup(): + assert not TestSimpleClassSetup.clslevel + """) + reprec.assertoutcome(failed=1, passed=1) + +def test_method_setup(testdir): + reprec = testdir.inline_runsource(""" + class TestSetupMethod: + def setup_method(self, meth): + self.methsetup = meth + def teardown_method(self, meth): + del self.methsetup + + def test_some(self): + assert self.methsetup == self.test_some + + def test_other(self): + assert self.methsetup == self.test_other + """) + reprec.assertoutcome(passed=2) + +def test_method_setup_failure_no_teardown(testdir): + reprec = testdir.inline_runsource(""" + class TestMethodSetup: + clslevel = [] + def setup_method(self, method): + self.clslevel.append(1) + 0/0 + + def teardown_method(self, method): + self.clslevel.append(2) + + def test_method(self): + pass + + def test_cleanup(): + assert TestMethodSetup.clslevel == [1] + """) + reprec.assertoutcome(failed=1, passed=1) + +def test_method_generator_setup(testdir): + reprec = testdir.inline_runsource(""" + class TestSetupTeardownOnInstance: + def setup_class(cls): + cls.classsetup = True + + def setup_method(self, method): + self.methsetup = method + + def test_generate(self): + assert self.classsetup + assert self.methsetup == self.test_generate + yield self.generated, 5 + yield self.generated, 2 + + def generated(self, value): + assert self.classsetup + assert self.methsetup == self.test_generate + assert value == 5 + """) + reprec.assertoutcome(passed=1, failed=1) + +def test_func_generator_setup(testdir): + reprec = testdir.inline_runsource(""" + import sys + + def setup_module(mod): + print ("setup_module") + mod.x = [] + + def setup_function(fun): + print ("setup_function") + x.append(1) + + def teardown_function(fun): + print ("teardown_function") + x.pop() + + def test_one(): + assert x == [1] + def check(): + print ("check") + sys.stderr.write("e\\n") + assert x == [1] + yield check + assert x == [1] + """) + rep = reprec.matchreport("test_one", names="pytest_runtest_logreport") + assert rep.passed + +def test_method_setup_uses_fresh_instances(testdir): + reprec = testdir.inline_runsource(""" + class TestSelfState1: + memory = [] + def test_hello(self): + self.memory.append(self) + + def test_afterhello(self): + assert self != self.memory[0] + """) + reprec.assertoutcome(passed=2, failed=0) + +def test_setup_that_skips_calledagain(testdir): + p = testdir.makepyfile(""" + import pytest + def setup_module(mod): + pytest.skip("x") + def test_function1(): + pass + def test_function2(): + pass + """) + reprec = testdir.inline_run(p) + reprec.assertoutcome(skipped=2) + +def test_setup_fails_again_on_all_tests(testdir): + p = testdir.makepyfile(""" + import pytest + def setup_module(mod): + raise ValueError(42) + def test_function1(): + pass + def test_function2(): + pass + """) + reprec = testdir.inline_run(p) + reprec.assertoutcome(failed=2) + +def test_setup_funcarg_setup_when_outer_scope_fails(testdir): + p = testdir.makepyfile(""" + import pytest + def setup_module(mod): + raise ValueError(42) + def pytest_funcarg__hello(request): + raise ValueError("xyz43") + def test_function1(hello): + pass + def test_function2(hello): + pass + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*function1*", + "*ValueError*42*", + "*function2*", + "*ValueError*42*", + "*2 error*" + ]) + assert "xyz43" not in result.stdout.str() diff --git a/testing/web-platform/tests/tools/pytest/testing/test_session.py b/testing/web-platform/tests/tools/pytest/testing/test_session.py new file mode 100644 index 000000000..76f804b4f --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_session.py @@ -0,0 +1,244 @@ +import pytest + +from _pytest.main import EXIT_NOTESTSCOLLECTED + +class SessionTests: + def test_basic_testitem_events(self, testdir): + tfile = testdir.makepyfile(""" + def test_one(): + pass + def test_one_one(): + assert 0 + def test_other(): + raise ValueError(23) + class TestClass: + def test_two(self, someargs): + pass + """) + reprec = testdir.inline_run(tfile) + passed, skipped, failed = reprec.listoutcomes() + assert len(skipped) == 0 + assert len(passed) == 1 + assert len(failed) == 3 + end = lambda x: x.nodeid.split("::")[-1] + assert end(failed[0]) == "test_one_one" + assert end(failed[1]) == "test_other" + itemstarted = reprec.getcalls("pytest_itemcollected") + assert len(itemstarted) == 4 + # XXX check for failing funcarg setup + #colreports = reprec.getcalls("pytest_collectreport") + #assert len(colreports) == 4 + #assert colreports[1].report.failed + + def test_nested_import_error(self, testdir): + tfile = testdir.makepyfile(""" + import import_fails + def test_this(): + assert import_fails.a == 1 + """, import_fails=""" + import does_not_work + a = 1 + """) + reprec = testdir.inline_run(tfile) + l = reprec.getfailedcollections() + assert len(l) == 1 + out = l[0].longrepr.reprcrash.message + assert out.find('does_not_work') != -1 + + def test_raises_output(self, testdir): + reprec = testdir.inline_runsource(""" + import pytest + def test_raises_doesnt(): + pytest.raises(ValueError, int, "3") + """) + passed, skipped, failed = reprec.listoutcomes() + assert len(failed) == 1 + out = failed[0].longrepr.reprcrash.message + if not out.find("DID NOT RAISE") != -1: + print(out) + pytest.fail("incorrect raises() output") + + def test_generator_yields_None(self, testdir): + reprec = testdir.inline_runsource(""" + def test_1(): + yield None + """) + failures = reprec.getfailedcollections() + out = failures[0].longrepr.reprcrash.message + i = out.find('TypeError') + assert i != -1 + + def test_syntax_error_module(self, testdir): + reprec = testdir.inline_runsource("this is really not python") + l = reprec.getfailedcollections() + assert len(l) == 1 + out = str(l[0].longrepr) + assert out.find(str('not python')) != -1 + + def test_exit_first_problem(self, testdir): + reprec = testdir.inline_runsource(""" + def test_one(): assert 0 + def test_two(): assert 0 + """, '--exitfirst') + passed, skipped, failed = reprec.countoutcomes() + assert failed == 1 + assert passed == skipped == 0 + + def test_maxfail(self, testdir): + reprec = testdir.inline_runsource(""" + def test_one(): assert 0 + def test_two(): assert 0 + def test_three(): assert 0 + """, '--maxfail=2') + passed, skipped, failed = reprec.countoutcomes() + assert failed == 2 + assert passed == skipped == 0 + + def test_broken_repr(self, testdir): + p = testdir.makepyfile(""" + import pytest + class BrokenRepr1: + foo=0 + def __repr__(self): + raise Exception("Ha Ha fooled you, I'm a broken repr().") + + class TestBrokenClass: + def test_explicit_bad_repr(self): + t = BrokenRepr1() + pytest.raises(Exception, 'repr(t)') + + def test_implicit_bad_repr1(self): + t = BrokenRepr1() + assert t.foo == 1 + + """) + reprec = testdir.inline_run(p) + passed, skipped, failed = reprec.listoutcomes() + assert len(failed) == 1 + out = failed[0].longrepr.reprcrash.message + assert out.find("""[Exception("Ha Ha fooled you, I'm a broken repr().") raised in repr()]""") != -1 #' + + def test_skip_file_by_conftest(self, testdir): + testdir.makepyfile(conftest=""" + import pytest + def pytest_collect_file(): + pytest.skip("intentional") + """, test_file=""" + def test_one(): pass + """) + try: + reprec = testdir.inline_run(testdir.tmpdir) + except pytest.skip.Exception: + pytest.fail("wrong skipped caught") + reports = reprec.getreports("pytest_collectreport") + assert len(reports) == 1 + assert reports[0].skipped + +class TestNewSession(SessionTests): + + def test_order_of_execution(self, testdir): + reprec = testdir.inline_runsource(""" + l = [] + def test_1(): + l.append(1) + def test_2(): + l.append(2) + def test_3(): + assert l == [1,2] + class Testmygroup: + reslist = l + def test_1(self): + self.reslist.append(1) + def test_2(self): + self.reslist.append(2) + def test_3(self): + self.reslist.append(3) + def test_4(self): + assert self.reslist == [1,2,1,2,3] + """) + passed, skipped, failed = reprec.countoutcomes() + assert failed == skipped == 0 + assert passed == 7 + # also test listnames() here ... + + def test_collect_only_with_various_situations(self, testdir): + p = testdir.makepyfile( + test_one=""" + def test_one(): + raise ValueError() + + class TestX: + def test_method_one(self): + pass + + class TestY(TestX): + pass + """, + test_two=""" + import pytest + pytest.skip('xxx') + """, + test_three="xxxdsadsadsadsa", + __init__="" + ) + reprec = testdir.inline_run('--collect-only', p.dirpath()) + + itemstarted = reprec.getcalls("pytest_itemcollected") + assert len(itemstarted) == 3 + assert not reprec.getreports("pytest_runtest_logreport") + started = reprec.getcalls("pytest_collectstart") + finished = reprec.getreports("pytest_collectreport") + assert len(started) == len(finished) + assert len(started) == 8 # XXX extra TopCollector + colfail = [x for x in finished if x.failed] + colskipped = [x for x in finished if x.skipped] + assert len(colfail) == 1 + assert len(colskipped) == 1 + + def test_minus_x_import_error(self, testdir): + testdir.makepyfile(__init__="") + testdir.makepyfile(test_one="xxxx", test_two="yyyy") + reprec = testdir.inline_run("-x", testdir.tmpdir) + finished = reprec.getreports("pytest_collectreport") + colfail = [x for x in finished if x.failed] + assert len(colfail) == 1 + + +def test_plugin_specify(testdir): + pytest.raises(ImportError, """ + testdir.parseconfig("-p", "nqweotexistent") + """) + #pytest.raises(ImportError, + # "config.do_configure(config)" + #) + +def test_plugin_already_exists(testdir): + config = testdir.parseconfig("-p", "terminal") + assert config.option.plugins == ['terminal'] + config._do_configure() + config._ensure_unconfigure() + +def test_exclude(testdir): + hellodir = testdir.mkdir("hello") + hellodir.join("test_hello.py").write("x y syntaxerror") + hello2dir = testdir.mkdir("hello2") + hello2dir.join("test_hello2.py").write("x y syntaxerror") + testdir.makepyfile(test_ok="def test_pass(): pass") + result = testdir.runpytest("--ignore=hello", "--ignore=hello2") + assert result.ret == 0 + result.stdout.fnmatch_lines(["*1 passed*"]) + +def test_sessionfinish_with_start(testdir): + testdir.makeconftest(""" + import os + l = [] + def pytest_sessionstart(): + l.append(os.getcwd()) + os.chdir("..") + + def pytest_sessionfinish(): + assert l[0] == os.getcwd() + + """) + res = testdir.runpytest("--collect-only") + assert res.ret == EXIT_NOTESTSCOLLECTED diff --git a/testing/web-platform/tests/tools/pytest/testing/test_skipping.py b/testing/web-platform/tests/tools/pytest/testing/test_skipping.py new file mode 100644 index 000000000..3464974e0 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_skipping.py @@ -0,0 +1,917 @@ +import pytest +import sys + +from _pytest.skipping import MarkEvaluator, folded_skips, pytest_runtest_setup +from _pytest.runner import runtestprotocol + + +class TestEvaluator: + def test_no_marker(self, testdir): + item = testdir.getitem("def test_func(): pass") + evalskipif = MarkEvaluator(item, 'skipif') + assert not evalskipif + assert not evalskipif.istrue() + + def test_marked_no_args(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.xyz + def test_func(): + pass + """) + ev = MarkEvaluator(item, 'xyz') + assert ev + assert ev.istrue() + expl = ev.getexplanation() + assert expl == "" + assert not ev.get("run", False) + + def test_marked_one_arg(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.xyz("hasattr(os, 'sep')") + def test_func(): + pass + """) + ev = MarkEvaluator(item, 'xyz') + assert ev + assert ev.istrue() + expl = ev.getexplanation() + assert expl == "condition: hasattr(os, 'sep')" + + @pytest.mark.skipif('sys.version_info[0] >= 3') + def test_marked_one_arg_unicode(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.xyz(u"hasattr(os, 'sep')") + def test_func(): + pass + """) + ev = MarkEvaluator(item, 'xyz') + assert ev + assert ev.istrue() + expl = ev.getexplanation() + assert expl == "condition: hasattr(os, 'sep')" + + def test_marked_one_arg_with_reason(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.xyz("hasattr(os, 'sep')", attr=2, reason="hello world") + def test_func(): + pass + """) + ev = MarkEvaluator(item, 'xyz') + assert ev + assert ev.istrue() + expl = ev.getexplanation() + assert expl == "hello world" + assert ev.get("attr") == 2 + + def test_marked_one_arg_twice(self, testdir): + lines = [ + '''@pytest.mark.skipif("not hasattr(os, 'murks')")''', + '''@pytest.mark.skipif("hasattr(os, 'murks')")''' + ] + for i in range(0, 2): + item = testdir.getitem(""" + import pytest + %s + %s + def test_func(): + pass + """ % (lines[i], lines[(i+1) %2])) + ev = MarkEvaluator(item, 'skipif') + assert ev + assert ev.istrue() + expl = ev.getexplanation() + assert expl == "condition: not hasattr(os, 'murks')" + + def test_marked_one_arg_twice2(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.skipif("hasattr(os, 'murks')") + @pytest.mark.skipif("not hasattr(os, 'murks')") + def test_func(): + pass + """) + ev = MarkEvaluator(item, 'skipif') + assert ev + assert ev.istrue() + expl = ev.getexplanation() + assert expl == "condition: not hasattr(os, 'murks')" + + def test_marked_skip_with_not_string(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.skipif(False) + def test_func(): + pass + """) + ev = MarkEvaluator(item, 'skipif') + exc = pytest.raises(pytest.fail.Exception, ev.istrue) + assert """Failed: you need to specify reason=STRING when using booleans as conditions.""" in exc.value.msg + + def test_skipif_class(self, testdir): + item, = testdir.getitems(""" + import pytest + class TestClass: + pytestmark = pytest.mark.skipif("config._hackxyz") + def test_func(self): + pass + """) + item.config._hackxyz = 3 + ev = MarkEvaluator(item, 'skipif') + assert ev.istrue() + expl = ev.getexplanation() + assert expl == "condition: config._hackxyz" + + +class TestXFail: + + @pytest.mark.parametrize('strict', [True, False]) + def test_xfail_simple(self, testdir, strict): + item = testdir.getitem(""" + import pytest + @pytest.mark.xfail(strict=%s) + def test_func(): + assert 0 + """ % strict) + reports = runtestprotocol(item, log=False) + assert len(reports) == 3 + callreport = reports[1] + assert callreport.skipped + assert callreport.wasxfail == "" + + def test_xfail_xpassed(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.xfail + def test_func(): + assert 1 + """) + reports = runtestprotocol(item, log=False) + assert len(reports) == 3 + callreport = reports[1] + assert callreport.failed + assert callreport.wasxfail == "" + + def test_xfail_run_anyway(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.xfail + def test_func(): + assert 0 + def test_func2(): + pytest.xfail("hello") + """) + result = testdir.runpytest("--runxfail") + result.stdout.fnmatch_lines([ + "*def test_func():*", + "*assert 0*", + "*1 failed*1 pass*", + ]) + + def test_xfail_evalfalse_but_fails(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.xfail('False') + def test_func(): + assert 0 + """) + reports = runtestprotocol(item, log=False) + callreport = reports[1] + assert callreport.failed + assert not hasattr(callreport, "wasxfail") + assert 'xfail' in callreport.keywords + + def test_xfail_not_report_default(self, testdir): + p = testdir.makepyfile(test_one=""" + import pytest + @pytest.mark.xfail + def test_this(): + assert 0 + """) + testdir.runpytest(p, '-v') + #result.stdout.fnmatch_lines([ + # "*HINT*use*-r*" + #]) + + def test_xfail_not_run_xfail_reporting(self, testdir): + p = testdir.makepyfile(test_one=""" + import pytest + @pytest.mark.xfail(run=False, reason="noway") + def test_this(): + assert 0 + @pytest.mark.xfail("True", run=False) + def test_this_true(): + assert 0 + @pytest.mark.xfail("False", run=False, reason="huh") + def test_this_false(): + assert 1 + """) + result = testdir.runpytest(p, '--report=xfailed', ) + result.stdout.fnmatch_lines([ + "*test_one*test_this*", + "*NOTRUN*noway", + "*test_one*test_this_true*", + "*NOTRUN*condition:*True*", + "*1 passed*", + ]) + + def test_xfail_not_run_no_setup_run(self, testdir): + p = testdir.makepyfile(test_one=""" + import pytest + @pytest.mark.xfail(run=False, reason="hello") + def test_this(): + assert 0 + def setup_module(mod): + raise ValueError(42) + """) + result = testdir.runpytest(p, '--report=xfailed', ) + result.stdout.fnmatch_lines([ + "*test_one*test_this*", + "*NOTRUN*hello", + "*1 xfailed*", + ]) + + def test_xfail_xpass(self, testdir): + p = testdir.makepyfile(test_one=""" + import pytest + @pytest.mark.xfail + def test_that(): + assert 1 + """) + result = testdir.runpytest(p, '-rX') + result.stdout.fnmatch_lines([ + "*XPASS*test_that*", + "*1 xpassed*" + ]) + assert result.ret == 0 + + def test_xfail_imperative(self, testdir): + p = testdir.makepyfile(""" + import pytest + def test_this(): + pytest.xfail("hello") + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*1 xfailed*", + ]) + result = testdir.runpytest(p, "-rx") + result.stdout.fnmatch_lines([ + "*XFAIL*test_this*", + "*reason:*hello*", + ]) + result = testdir.runpytest(p, "--runxfail") + result.stdout.fnmatch_lines("*1 pass*") + + def test_xfail_imperative_in_setup_function(self, testdir): + p = testdir.makepyfile(""" + import pytest + def setup_function(function): + pytest.xfail("hello") + + def test_this(): + assert 0 + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*1 xfailed*", + ]) + result = testdir.runpytest(p, "-rx") + result.stdout.fnmatch_lines([ + "*XFAIL*test_this*", + "*reason:*hello*", + ]) + result = testdir.runpytest(p, "--runxfail") + result.stdout.fnmatch_lines(""" + *def test_this* + *1 fail* + """) + + def xtest_dynamic_xfail_set_during_setup(self, testdir): + p = testdir.makepyfile(""" + import pytest + def setup_function(function): + pytest.mark.xfail(function) + def test_this(): + assert 0 + def test_that(): + assert 1 + """) + result = testdir.runpytest(p, '-rxX') + result.stdout.fnmatch_lines([ + "*XFAIL*test_this*", + "*XPASS*test_that*", + ]) + + def test_dynamic_xfail_no_run(self, testdir): + p = testdir.makepyfile(""" + import pytest + def pytest_funcarg__arg(request): + request.applymarker(pytest.mark.xfail(run=False)) + def test_this(arg): + assert 0 + """) + result = testdir.runpytest(p, '-rxX') + result.stdout.fnmatch_lines([ + "*XFAIL*test_this*", + "*NOTRUN*", + ]) + + def test_dynamic_xfail_set_during_funcarg_setup(self, testdir): + p = testdir.makepyfile(""" + import pytest + def pytest_funcarg__arg(request): + request.applymarker(pytest.mark.xfail) + def test_this2(arg): + assert 0 + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*1 xfailed*", + ]) + + + @pytest.mark.parametrize('expected, actual, matchline', + [('TypeError', 'TypeError', "*1 xfailed*"), + ('(AttributeError, TypeError)', 'TypeError', "*1 xfailed*"), + ('TypeError', 'IndexError', "*1 failed*"), + ('(AttributeError, TypeError)', 'IndexError', "*1 failed*"), + ]) + def test_xfail_raises(self, expected, actual, matchline, testdir): + p = testdir.makepyfile(""" + import pytest + @pytest.mark.xfail(raises=%s) + def test_raises(): + raise %s() + """ % (expected, actual)) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + matchline, + ]) + + def test_strict_sanity(self, testdir): + """sanity check for xfail(strict=True): a failing test should behave + exactly like a normal xfail. + """ + p = testdir.makepyfile(""" + import pytest + @pytest.mark.xfail(reason='unsupported feature', strict=True) + def test_foo(): + assert 0 + """) + result = testdir.runpytest(p, '-rxX') + result.stdout.fnmatch_lines([ + '*XFAIL*', + '*unsupported feature*', + ]) + assert result.ret == 0 + + @pytest.mark.parametrize('strict', [True, False]) + def test_strict_xfail(self, testdir, strict): + p = testdir.makepyfile(""" + import pytest + + @pytest.mark.xfail(reason='unsupported feature', strict=%s) + def test_foo(): + with open('foo_executed', 'w'): pass # make sure test executes + """ % strict) + result = testdir.runpytest(p, '-rxX') + if strict: + result.stdout.fnmatch_lines([ + '*test_foo*', + '*XPASS(strict)*unsupported feature*', + ]) + else: + result.stdout.fnmatch_lines([ + '*test_strict_xfail*', + 'XPASS test_strict_xfail.py::test_foo unsupported feature', + ]) + assert result.ret == (1 if strict else 0) + assert testdir.tmpdir.join('foo_executed').isfile() + + @pytest.mark.parametrize('strict', [True, False]) + def test_strict_xfail_condition(self, testdir, strict): + p = testdir.makepyfile(""" + import pytest + + @pytest.mark.xfail(False, reason='unsupported feature', strict=%s) + def test_foo(): + pass + """ % strict) + result = testdir.runpytest(p, '-rxX') + result.stdout.fnmatch_lines('*1 passed*') + assert result.ret == 0 + + @pytest.mark.parametrize('strict_val', ['true', 'false']) + def test_strict_xfail_default_from_file(self, testdir, strict_val): + testdir.makeini(''' + [pytest] + xfail_strict = %s + ''' % strict_val) + p = testdir.makepyfile(""" + import pytest + @pytest.mark.xfail(reason='unsupported feature') + def test_foo(): + pass + """) + result = testdir.runpytest(p, '-rxX') + strict = strict_val == 'true' + result.stdout.fnmatch_lines('*1 failed*' if strict else '*1 xpassed*') + assert result.ret == (1 if strict else 0) + + +class TestXFailwithSetupTeardown: + def test_failing_setup_issue9(self, testdir): + testdir.makepyfile(""" + import pytest + def setup_function(func): + assert 0 + + @pytest.mark.xfail + def test_func(): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*1 xfail*", + ]) + + def test_failing_teardown_issue9(self, testdir): + testdir.makepyfile(""" + import pytest + def teardown_function(func): + assert 0 + + @pytest.mark.xfail + def test_func(): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*1 xfail*", + ]) + + +class TestSkip: + def test_skip_class(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skip + class TestSomething(object): + def test_foo(self): + pass + def test_bar(self): + pass + + def test_baz(): + pass + """) + rec = testdir.inline_run() + rec.assertoutcome(skipped=2, passed=1) + + def test_skips_on_false_string(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skip('False') + def test_foo(): + pass + """) + rec = testdir.inline_run() + rec.assertoutcome(skipped=1) + + def test_arg_as_reason(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skip('testing stuff') + def test_bar(): + pass + """) + result = testdir.runpytest('-rs') + result.stdout.fnmatch_lines([ + "*testing stuff*", + "*1 skipped*", + ]) + + def test_skip_no_reason(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skip + def test_foo(): + pass + """) + result = testdir.runpytest('-rs') + result.stdout.fnmatch_lines([ + "*unconditional skip*", + "*1 skipped*", + ]) + + def test_skip_with_reason(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skip(reason="for lolz") + def test_bar(): + pass + """) + result = testdir.runpytest('-rs') + result.stdout.fnmatch_lines([ + "*for lolz*", + "*1 skipped*", + ]) + + def test_only_skips_marked_test(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skip + def test_foo(): + pass + @pytest.mark.skip(reason="nothing in particular") + def test_bar(): + pass + def test_baz(): + assert True + """) + result = testdir.runpytest('-rs') + result.stdout.fnmatch_lines([ + "*nothing in particular*", + "*1 passed*2 skipped*", + ]) + +class TestSkipif: + def test_skipif_conditional(self, testdir): + item = testdir.getitem(""" + import pytest + @pytest.mark.skipif("hasattr(os, 'sep')") + def test_func(): + pass + """) # noqa + x = pytest.raises(pytest.skip.Exception, lambda: + pytest_runtest_setup(item)) + assert x.value.msg == "condition: hasattr(os, 'sep')" + + @pytest.mark.parametrize('params', [ + '"hasattr(sys, \'platform\')"', + 'True, reason="invalid platform"', + ]) + def test_skipif_reporting(self, testdir, params): + p = testdir.makepyfile(test_foo=""" + import pytest + @pytest.mark.skipif(%(params)s) + def test_that(): + assert 0 + """ % dict(params=params)) + result = testdir.runpytest(p, '-s', '-rs') + result.stdout.fnmatch_lines([ + "*SKIP*1*test_foo.py*platform*", + "*1 skipped*" + ]) + assert result.ret == 0 + + @pytest.mark.parametrize('marker, msg1, msg2', [ + ('skipif', 'SKIP', 'skipped'), + ('xfail', 'XPASS', 'xpassed'), + ]) + def test_skipif_reporting_multiple(self, testdir, marker, msg1, msg2): + testdir.makepyfile(test_foo=""" + import pytest + @pytest.mark.{marker}(False, reason='first_condition') + @pytest.mark.{marker}(True, reason='second_condition') + def test_foobar(): + assert 1 + """.format(marker=marker)) + result = testdir.runpytest('-s', '-rsxX') + result.stdout.fnmatch_lines([ + "*{msg1}*test_foo.py*second_condition*".format(msg1=msg1), + "*1 {msg2}*".format(msg2=msg2), + ]) + assert result.ret == 0 + + +def test_skip_not_report_default(testdir): + p = testdir.makepyfile(test_one=""" + import pytest + def test_this(): + pytest.skip("hello") + """) + result = testdir.runpytest(p, '-v') + result.stdout.fnmatch_lines([ + #"*HINT*use*-r*", + "*1 skipped*", + ]) + + +def test_skipif_class(testdir): + p = testdir.makepyfile(""" + import pytest + + class TestClass: + pytestmark = pytest.mark.skipif("True") + def test_that(self): + assert 0 + def test_though(self): + assert 0 + """) + result = testdir.runpytest(p) + result.stdout.fnmatch_lines([ + "*2 skipped*" + ]) + + +def test_skip_reasons_folding(): + path = 'xyz' + lineno = 3 + message = "justso" + longrepr = (path, lineno, message) + + class X: + pass + ev1 = X() + ev1.when = "execute" + ev1.skipped = True + ev1.longrepr = longrepr + + ev2 = X() + ev2.longrepr = longrepr + ev2.skipped = True + + l = folded_skips([ev1, ev2]) + assert len(l) == 1 + num, fspath, lineno, reason = l[0] + assert num == 2 + assert fspath == path + assert lineno == lineno + assert reason == message + +def test_skipped_reasons_functional(testdir): + testdir.makepyfile( + test_one=""" + from conftest import doskip + def setup_function(func): + doskip() + def test_func(): + pass + class TestClass: + def test_method(self): + doskip() + """, + test_two = """ + from conftest import doskip + doskip() + """, + conftest = """ + import pytest + def doskip(): + pytest.skip('test') + """ + ) + result = testdir.runpytest('--report=skipped') + result.stdout.fnmatch_lines([ + "*SKIP*3*conftest.py:3: test", + ]) + assert result.ret == 0 + +def test_reportchars(testdir): + testdir.makepyfile(""" + import pytest + def test_1(): + assert 0 + @pytest.mark.xfail + def test_2(): + assert 0 + @pytest.mark.xfail + def test_3(): + pass + def test_4(): + pytest.skip("four") + """) + result = testdir.runpytest("-rfxXs") + result.stdout.fnmatch_lines([ + "FAIL*test_1*", + "XFAIL*test_2*", + "XPASS*test_3*", + "SKIP*four*", + ]) + +def test_reportchars_error(testdir): + testdir.makepyfile( + conftest=""" + def pytest_runtest_teardown(): + assert 0 + """, + test_simple=""" + def test_foo(): + pass + """) + result = testdir.runpytest('-rE') + result.stdout.fnmatch_lines([ + 'ERROR*test_foo*', + ]) + +def test_reportchars_all(testdir): + testdir.makepyfile(""" + import pytest + def test_1(): + assert 0 + @pytest.mark.xfail + def test_2(): + assert 0 + @pytest.mark.xfail + def test_3(): + pass + def test_4(): + pytest.skip("four") + """) + result = testdir.runpytest("-ra") + result.stdout.fnmatch_lines([ + "FAIL*test_1*", + "SKIP*four*", + "XFAIL*test_2*", + "XPASS*test_3*", + ]) + +def test_reportchars_all_error(testdir): + testdir.makepyfile( + conftest=""" + def pytest_runtest_teardown(): + assert 0 + """, + test_simple=""" + def test_foo(): + pass + """) + result = testdir.runpytest('-ra') + result.stdout.fnmatch_lines([ + 'ERROR*test_foo*', + ]) + +@pytest.mark.xfail("hasattr(sys, 'pypy_version_info')") +def test_errors_in_xfail_skip_expressions(testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skipif("asd") + def test_nameerror(): + pass + @pytest.mark.xfail("syntax error") + def test_syntax(): + pass + + def test_func(): + pass + """) + result = testdir.runpytest() + markline = " ^" + if sys.platform.startswith("java"): + # XXX report this to java + markline = "*" + markline[8:] + result.stdout.fnmatch_lines([ + "*ERROR*test_nameerror*", + "*evaluating*skipif*expression*", + "*asd*", + "*ERROR*test_syntax*", + "*evaluating*xfail*expression*", + " syntax error", + markline, + "SyntaxError: invalid syntax", + "*1 pass*2 error*", + ]) + +def test_xfail_skipif_with_globals(testdir): + testdir.makepyfile(""" + import pytest + x = 3 + @pytest.mark.skipif("x == 3") + def test_skip1(): + pass + @pytest.mark.xfail("x == 3") + def test_boolean(): + assert 0 + """) + result = testdir.runpytest("-rsx") + result.stdout.fnmatch_lines([ + "*SKIP*x == 3*", + "*XFAIL*test_boolean*", + "*x == 3*", + ]) + +def test_direct_gives_error(testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skipif(True) + def test_skip1(): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*1 error*", + ]) + + +def test_default_markers(testdir): + result = testdir.runpytest("--markers") + result.stdout.fnmatch_lines([ + "*skipif(*condition)*skip*", + "*xfail(*condition, reason=None, run=True, raises=None)*expected failure*", + ]) + +def test_xfail_test_setup_exception(testdir): + testdir.makeconftest(""" + def pytest_runtest_setup(): + 0 / 0 + """) + p = testdir.makepyfile(""" + import pytest + @pytest.mark.xfail + def test_func(): + assert 0 + """) + result = testdir.runpytest(p) + assert result.ret == 0 + assert 'xfailed' in result.stdout.str() + assert 'xpassed' not in result.stdout.str() + +def test_imperativeskip_on_xfail_test(testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.xfail + def test_that_fails(): + assert 0 + + @pytest.mark.skipif("True") + def test_hello(): + pass + """) + testdir.makeconftest(""" + import pytest + def pytest_runtest_setup(item): + pytest.skip("abc") + """) + result = testdir.runpytest("-rsxX") + result.stdout.fnmatch_lines_random(""" + *SKIP*abc* + *SKIP*condition: True* + *2 skipped* + """) + +class TestBooleanCondition: + def test_skipif(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skipif(True, reason="True123") + def test_func1(): + pass + @pytest.mark.skipif(False, reason="True123") + def test_func2(): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(""" + *1 passed*1 skipped* + """) + + def test_skipif_noreason(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.skipif(True) + def test_func(): + pass + """) + result = testdir.runpytest("-rs") + result.stdout.fnmatch_lines(""" + *1 error* + """) + + def test_xfail(self, testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.xfail(True, reason="True123") + def test_func(): + assert 0 + """) + result = testdir.runpytest("-rxs") + result.stdout.fnmatch_lines(""" + *XFAIL* + *True123* + *1 xfail* + """) + + +def test_xfail_item(testdir): + # Ensure pytest.xfail works with non-Python Item + testdir.makeconftest(""" + import pytest + + class MyItem(pytest.Item): + nodeid = 'foo' + def runtest(self): + pytest.xfail("Expected Failure") + + def pytest_collect_file(path, parent): + return MyItem("foo", parent) + """) + result = testdir.inline_run() + passed, skipped, failed = result.listoutcomes() + assert not failed + xfailed = [r for r in skipped if hasattr(r, 'wasxfail')] + assert xfailed diff --git a/testing/web-platform/tests/tools/pytest/testing/test_terminal.py b/testing/web-platform/tests/tools/pytest/testing/test_terminal.py new file mode 100644 index 000000000..b43d6b379 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_terminal.py @@ -0,0 +1,880 @@ +""" +terminal reporting of the full testing process. +""" +import collections +import sys + +import _pytest._pluggy as pluggy +import _pytest._code +import py +import pytest +from _pytest import runner +from _pytest.main import EXIT_NOTESTSCOLLECTED +from _pytest.terminal import TerminalReporter, repr_pythonversion, getreportopt +from _pytest.terminal import build_summary_stats_line, _plugin_nameversions + + +def basic_run_report(item): + runner.call_and_report(item, "setup", log=False) + return runner.call_and_report(item, "call", log=False) + +DistInfo = collections.namedtuple('DistInfo', ['project_name', 'version']) + + +class Option: + def __init__(self, verbose=False, fulltrace=False): + self.verbose = verbose + self.fulltrace = fulltrace + + @property + def args(self): + l = [] + if self.verbose: + l.append('-v') + if self.fulltrace: + l.append('--fulltrace') + return l + +def pytest_generate_tests(metafunc): + if "option" in metafunc.fixturenames: + metafunc.addcall(id="default", + funcargs={'option': Option(verbose=False)}) + metafunc.addcall(id="verbose", + funcargs={'option': Option(verbose=True)}) + metafunc.addcall(id="quiet", + funcargs={'option': Option(verbose= -1)}) + metafunc.addcall(id="fulltrace", + funcargs={'option': Option(fulltrace=True)}) + + +@pytest.mark.parametrize('input,expected', [ + ([DistInfo(project_name='test', version=1)], ['test-1']), + ([DistInfo(project_name='pytest-test', version=1)], ['test-1']), + ([ + DistInfo(project_name='test', version=1), + DistInfo(project_name='test', version=1) + ], ['test-1']), +], ids=['normal', 'prefix-strip', 'deduplicate']) +def test_plugin_nameversion(input, expected): + pluginlist = [(None, x) for x in input] + result = _plugin_nameversions(pluginlist) + assert result == expected + + +class TestTerminal: + def test_pass_skip_fail(self, testdir, option): + testdir.makepyfile(""" + import pytest + def test_ok(): + pass + def test_skip(): + pytest.skip("xx") + def test_func(): + assert 0 + """) + result = testdir.runpytest(*option.args) + if option.verbose: + result.stdout.fnmatch_lines([ + "*test_pass_skip_fail.py::test_ok PASS*", + "*test_pass_skip_fail.py::test_skip SKIP*", + "*test_pass_skip_fail.py::test_func FAIL*", + ]) + else: + result.stdout.fnmatch_lines([ + "*test_pass_skip_fail.py .sF" + ]) + result.stdout.fnmatch_lines([ + " def test_func():", + "> assert 0", + "E assert 0", + ]) + + def test_internalerror(self, testdir, linecomp): + modcol = testdir.getmodulecol("def test_one(): pass") + rep = TerminalReporter(modcol.config, file=linecomp.stringio) + excinfo = pytest.raises(ValueError, "raise ValueError('hello')") + rep.pytest_internalerror(excinfo.getrepr()) + linecomp.assert_contains_lines([ + "INTERNALERROR> *ValueError*hello*" + ]) + + def test_writeline(self, testdir, linecomp): + modcol = testdir.getmodulecol("def test_one(): pass") + rep = TerminalReporter(modcol.config, file=linecomp.stringio) + rep.write_fspath_result(modcol.nodeid, ".") + rep.write_line("hello world") + lines = linecomp.stringio.getvalue().split('\n') + assert not lines[0] + assert lines[1].endswith(modcol.name + " .") + assert lines[2] == "hello world" + + def test_show_runtest_logstart(self, testdir, linecomp): + item = testdir.getitem("def test_func(): pass") + tr = TerminalReporter(item.config, file=linecomp.stringio) + item.config.pluginmanager.register(tr) + location = item.reportinfo() + tr.config.hook.pytest_runtest_logstart(nodeid=item.nodeid, + location=location, fspath=str(item.fspath)) + linecomp.assert_contains_lines([ + "*test_show_runtest_logstart.py*" + ]) + + def test_runtest_location_shown_before_test_starts(self, testdir): + testdir.makepyfile(""" + def test_1(): + import time + time.sleep(20) + """) + child = testdir.spawn_pytest("") + child.expect(".*test_runtest_location.*py") + child.sendeof() + child.kill(15) + + def test_itemreport_subclasses_show_subclassed_file(self, testdir): + testdir.makepyfile(test_p1=""" + class BaseTests: + def test_p1(self): + pass + class TestClass(BaseTests): + pass + """) + p2 = testdir.makepyfile(test_p2=""" + from test_p1 import BaseTests + class TestMore(BaseTests): + pass + """) + result = testdir.runpytest(p2) + result.stdout.fnmatch_lines([ + "*test_p2.py .", + "*1 passed*", + ]) + result = testdir.runpytest("-v", p2) + result.stdout.fnmatch_lines([ + "*test_p2.py::TestMore::test_p1* <- *test_p1.py*PASSED", + ]) + + def test_itemreport_directclasses_not_shown_as_subclasses(self, testdir): + a = testdir.mkpydir("a123") + a.join("test_hello123.py").write(_pytest._code.Source(""" + class TestClass: + def test_method(self): + pass + """)) + result = testdir.runpytest("-v") + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*a123/test_hello123.py*PASS*", + ]) + assert " <- " not in result.stdout.str() + + def test_keyboard_interrupt(self, testdir, option): + testdir.makepyfile(""" + def test_foobar(): + assert 0 + def test_spamegg(): + import py; pytest.skip('skip me please!') + def test_interrupt_me(): + raise KeyboardInterrupt # simulating the user + """) + + result = testdir.runpytest(*option.args, no_reraise_ctrlc=True) + result.stdout.fnmatch_lines([ + " def test_foobar():", + "> assert 0", + "E assert 0", + "*_keyboard_interrupt.py:6: KeyboardInterrupt*", + ]) + if option.fulltrace: + result.stdout.fnmatch_lines([ + "*raise KeyboardInterrupt # simulating the user*", + ]) + else: + result.stdout.fnmatch_lines([ + "to show a full traceback on KeyboardInterrupt use --fulltrace" + ]) + result.stdout.fnmatch_lines(['*KeyboardInterrupt*']) + + def test_keyboard_in_sessionstart(self, testdir): + testdir.makeconftest(""" + def pytest_sessionstart(): + raise KeyboardInterrupt + """) + testdir.makepyfile(""" + def test_foobar(): + pass + """) + + result = testdir.runpytest(no_reraise_ctrlc=True) + assert result.ret == 2 + result.stdout.fnmatch_lines(['*KeyboardInterrupt*']) + + +class TestCollectonly: + def test_collectonly_basic(self, testdir): + testdir.makepyfile(""" + def test_func(): + pass + """) + result = testdir.runpytest("--collect-only",) + result.stdout.fnmatch_lines([ + "<Module 'test_collectonly_basic.py'>", + " <Function 'test_func'>", + ]) + + def test_collectonly_skipped_module(self, testdir): + testdir.makepyfile(""" + import pytest + pytest.skip("hello") + """) + result = testdir.runpytest("--collect-only", "-rs") + result.stdout.fnmatch_lines([ + "SKIP*hello*", + "*1 skip*", + ]) + + def test_collectonly_failed_module(self, testdir): + testdir.makepyfile("""raise ValueError(0)""") + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*raise ValueError*", + "*1 error*", + ]) + + def test_collectonly_fatal(self, testdir): + testdir.makeconftest(""" + def pytest_collectstart(collector): + assert 0, "urgs" + """) + result = testdir.runpytest("--collect-only") + result.stdout.fnmatch_lines([ + "*INTERNAL*args*" + ]) + assert result.ret == 3 + + def test_collectonly_simple(self, testdir): + p = testdir.makepyfile(""" + def test_func1(): + pass + class TestClass: + def test_method(self): + pass + """) + result = testdir.runpytest("--collect-only", p) + #assert stderr.startswith("inserting into sys.path") + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*<Module '*.py'>", + "* <Function 'test_func1'*>", + "* <Class 'TestClass'>", + #"* <Instance '()'>", + "* <Function 'test_method'*>", + ]) + + def test_collectonly_error(self, testdir): + p = testdir.makepyfile("import Errlkjqweqwe") + result = testdir.runpytest("--collect-only", p) + assert result.ret == 1 + result.stdout.fnmatch_lines(_pytest._code.Source(""" + *ERROR* + *import Errlk* + *ImportError* + *1 error* + """).strip()) + + def test_collectonly_missing_path(self, testdir): + """this checks issue 115, + failure in parseargs will cause session + not to have the items attribute + """ + result = testdir.runpytest("--collect-only", "uhm_missing_path") + assert result.ret == 4 + result.stderr.fnmatch_lines([ + '*ERROR: file not found*', + ]) + + def test_collectonly_quiet(self, testdir): + testdir.makepyfile("def test_foo(): pass") + result = testdir.runpytest("--collect-only", "-q") + result.stdout.fnmatch_lines([ + '*test_foo*', + ]) + + def test_collectonly_more_quiet(self, testdir): + testdir.makepyfile(test_fun="def test_foo(): pass") + result = testdir.runpytest("--collect-only", "-qq") + result.stdout.fnmatch_lines([ + '*test_fun.py: 1*', + ]) + + +def test_repr_python_version(monkeypatch): + try: + monkeypatch.setattr(sys, 'version_info', (2, 5, 1, 'final', 0)) + assert repr_pythonversion() == "2.5.1-final-0" + py.std.sys.version_info = x = (2, 3) + assert repr_pythonversion() == str(x) + finally: + monkeypatch.undo() # do this early as pytest can get confused + +class TestFixtureReporting: + def test_setup_fixture_error(self, testdir): + testdir.makepyfile(""" + def setup_function(function): + print ("setup func") + assert 0 + def test_nada(): + pass + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*ERROR at setup of test_nada*", + "*setup_function(function):*", + "*setup func*", + "*assert 0*", + "*1 error*", + ]) + assert result.ret != 0 + + def test_teardown_fixture_error(self, testdir): + testdir.makepyfile(""" + def test_nada(): + pass + def teardown_function(function): + print ("teardown func") + assert 0 + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*ERROR at teardown*", + "*teardown_function(function):*", + "*assert 0*", + "*Captured stdout*", + "*teardown func*", + "*1 passed*1 error*", + ]) + + def test_teardown_fixture_error_and_test_failure(self, testdir): + testdir.makepyfile(""" + def test_fail(): + assert 0, "failingfunc" + + def teardown_function(function): + print ("teardown func") + assert False + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*ERROR at teardown of test_fail*", + "*teardown_function(function):*", + "*assert False*", + "*Captured stdout*", + "*teardown func*", + + "*test_fail*", + "*def test_fail():", + "*failingfunc*", + "*1 failed*1 error*", + ]) + +class TestTerminalFunctional: + def test_deselected(self, testdir): + testpath = testdir.makepyfile(""" + def test_one(): + pass + def test_two(): + pass + def test_three(): + pass + """ + ) + result = testdir.runpytest("-k", "test_two:", testpath) + result.stdout.fnmatch_lines([ + "*test_deselected.py ..", + "=* 1 test*deselected by*test_two:*=", + ]) + assert result.ret == 0 + + def test_no_skip_summary_if_failure(self, testdir): + testdir.makepyfile(""" + import pytest + def test_ok(): + pass + def test_fail(): + assert 0 + def test_skip(): + pytest.skip("dontshow") + """) + result = testdir.runpytest() + assert result.stdout.str().find("skip test summary") == -1 + assert result.ret == 1 + + def test_passes(self, testdir): + p1 = testdir.makepyfile(""" + def test_passes(): + pass + class TestClass: + def test_method(self): + pass + """) + old = p1.dirpath().chdir() + try: + result = testdir.runpytest() + finally: + old.chdir() + result.stdout.fnmatch_lines([ + "test_passes.py ..", + "* 2 pass*", + ]) + assert result.ret == 0 + + def test_header_trailer_info(self, testdir): + testdir.makepyfile(""" + def test_passes(): + pass + """) + result = testdir.runpytest() + verinfo = ".".join(map(str, py.std.sys.version_info[:3])) + result.stdout.fnmatch_lines([ + "*===== test session starts ====*", + "platform %s -- Python %s*pytest-%s*py-%s*pluggy-%s" % ( + py.std.sys.platform, verinfo, + pytest.__version__, py.__version__, pluggy.__version__), + "*test_header_trailer_info.py .", + "=* 1 passed*in *.[0-9][0-9] seconds *=", + ]) + if pytest.config.pluginmanager.list_plugin_distinfo(): + result.stdout.fnmatch_lines([ + "plugins: *", + ]) + + def test_showlocals(self, testdir): + p1 = testdir.makepyfile(""" + def test_showlocals(): + x = 3 + y = "x" * 5000 + assert 0 + """) + result = testdir.runpytest(p1, '-l') + result.stdout.fnmatch_lines([ + #"_ _ * Locals *", + "x* = 3", + "y* = 'xxxxxx*" + ]) + + def test_verbose_reporting(self, testdir, pytestconfig): + p1 = testdir.makepyfile(""" + import pytest + def test_fail(): + raise ValueError() + def test_pass(): + pass + class TestClass: + def test_skip(self): + pytest.skip("hello") + def test_gen(): + def check(x): + assert x == 1 + yield check, 0 + """) + result = testdir.runpytest(p1, '-v') + result.stdout.fnmatch_lines([ + "*test_verbose_reporting.py::test_fail *FAIL*", + "*test_verbose_reporting.py::test_pass *PASS*", + "*test_verbose_reporting.py::TestClass::test_skip *SKIP*", + "*test_verbose_reporting.py::test_gen*0* *FAIL*", + ]) + assert result.ret == 1 + + if not pytestconfig.pluginmanager.get_plugin("xdist"): + pytest.skip("xdist plugin not installed") + + result = testdir.runpytest(p1, '-v', '-n 1') + result.stdout.fnmatch_lines([ + "*FAIL*test_verbose_reporting.py::test_fail*", + ]) + assert result.ret == 1 + + def test_quiet_reporting(self, testdir): + p1 = testdir.makepyfile("def test_pass(): pass") + result = testdir.runpytest(p1, '-q') + s = result.stdout.str() + assert 'test session starts' not in s + assert p1.basename not in s + assert "===" not in s + assert "passed" in s + + def test_more_quiet_reporting(self, testdir): + p1 = testdir.makepyfile("def test_pass(): pass") + result = testdir.runpytest(p1, '-qq') + s = result.stdout.str() + assert 'test session starts' not in s + assert p1.basename not in s + assert "===" not in s + assert "passed" not in s + + +def test_fail_extra_reporting(testdir): + testdir.makepyfile("def test_this(): assert 0") + result = testdir.runpytest() + assert 'short test summary' not in result.stdout.str() + result = testdir.runpytest('-rf') + result.stdout.fnmatch_lines([ + "*test summary*", + "FAIL*test_fail_extra_reporting*", + ]) + +def test_fail_reporting_on_pass(testdir): + testdir.makepyfile("def test_this(): assert 1") + result = testdir.runpytest('-rf') + assert 'short test summary' not in result.stdout.str() + +def test_pass_extra_reporting(testdir): + testdir.makepyfile("def test_this(): assert 1") + result = testdir.runpytest() + assert 'short test summary' not in result.stdout.str() + result = testdir.runpytest('-rp') + result.stdout.fnmatch_lines([ + "*test summary*", + "PASS*test_pass_extra_reporting*", + ]) + +def test_pass_reporting_on_fail(testdir): + testdir.makepyfile("def test_this(): assert 0") + result = testdir.runpytest('-rp') + assert 'short test summary' not in result.stdout.str() + +def test_pass_output_reporting(testdir): + testdir.makepyfile(""" + def test_pass_output(): + print("Four score and seven years ago...") + """) + result = testdir.runpytest() + assert 'Four score and seven years ago...' not in result.stdout.str() + result = testdir.runpytest('-rP') + result.stdout.fnmatch_lines([ + "Four score and seven years ago...", + ]) + +def test_color_yes(testdir): + testdir.makepyfile("def test_this(): assert 1") + result = testdir.runpytest('--color=yes') + assert 'test session starts' in result.stdout.str() + assert '\x1b[1m' in result.stdout.str() + + +def test_color_no(testdir): + testdir.makepyfile("def test_this(): assert 1") + result = testdir.runpytest('--color=no') + assert 'test session starts' in result.stdout.str() + assert '\x1b[1m' not in result.stdout.str() + + +@pytest.mark.parametrize('verbose', [True, False]) +def test_color_yes_collection_on_non_atty(testdir, verbose): + """skip collect progress report when working on non-terminals. + #1397 + """ + testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize('i', range(10)) + def test_this(i): + assert 1 + """) + args = ['--color=yes'] + if verbose: + args.append('-vv') + result = testdir.runpytest(*args) + assert 'test session starts' in result.stdout.str() + assert '\x1b[1m' in result.stdout.str() + assert 'collecting 10 items' not in result.stdout.str() + if verbose: + assert 'collecting ...' in result.stdout.str() + assert 'collected 10 items' in result.stdout.str() + + +def test_getreportopt(): + class config: + class option: + reportchars = "" + config.option.report = "xfailed" + assert getreportopt(config) == "x" + + config.option.report = "xfailed,skipped" + assert getreportopt(config) == "xs" + + config.option.report = "skipped,xfailed" + assert getreportopt(config) == "sx" + + config.option.report = "skipped" + config.option.reportchars = "sf" + assert getreportopt(config) == "sf" + + config.option.reportchars = "sfx" + assert getreportopt(config) == "sfx" + +def test_terminalreporter_reportopt_addopts(testdir): + testdir.makeini("[pytest]\naddopts=-rs") + testdir.makepyfile(""" + def pytest_funcarg__tr(request): + tr = request.config.pluginmanager.getplugin("terminalreporter") + return tr + def test_opt(tr): + assert tr.hasopt('skipped') + assert not tr.hasopt('qwe') + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*1 passed*" + ]) + +def test_tbstyle_short(testdir): + p = testdir.makepyfile(""" + def pytest_funcarg__arg(request): + return 42 + def test_opt(arg): + x = 0 + assert x + """) + result = testdir.runpytest("--tb=short") + s = result.stdout.str() + assert 'arg = 42' not in s + assert 'x = 0' not in s + result.stdout.fnmatch_lines([ + "*%s:5*" % p.basename, + " assert x", + "E assert*", + ]) + result = testdir.runpytest() + s = result.stdout.str() + assert 'x = 0' in s + assert 'assert x' in s + +def test_traceconfig(testdir, monkeypatch): + result = testdir.runpytest("--traceconfig") + result.stdout.fnmatch_lines([ + "*active plugins*" + ]) + assert result.ret == EXIT_NOTESTSCOLLECTED + + +class TestGenericReporting: + """ this test class can be subclassed with a different option + provider to run e.g. distributed tests. + """ + def test_collect_fail(self, testdir, option): + testdir.makepyfile("import xyz\n") + result = testdir.runpytest(*option.args) + result.stdout.fnmatch_lines([ + "? import xyz", + "E ImportError: No module named *xyz*", + "*1 error*", + ]) + + def test_maxfailures(self, testdir, option): + testdir.makepyfile(""" + def test_1(): + assert 0 + def test_2(): + assert 0 + def test_3(): + assert 0 + """) + result = testdir.runpytest("--maxfail=2", *option.args) + result.stdout.fnmatch_lines([ + "*def test_1():*", + "*def test_2():*", + "*!! Interrupted: stopping after 2 failures*!!*", + "*2 failed*", + ]) + + + def test_tb_option(self, testdir, option): + testdir.makepyfile(""" + import pytest + def g(): + raise IndexError + def test_func(): + print (6*7) + g() # --calling-- + """) + for tbopt in ["long", "short", "no"]: + print('testing --tb=%s...' % tbopt) + result = testdir.runpytest('--tb=%s' % tbopt) + s = result.stdout.str() + if tbopt == "long": + assert 'print (6*7)' in s + else: + assert 'print (6*7)' not in s + if tbopt != "no": + assert '--calling--' in s + assert 'IndexError' in s + else: + assert 'FAILURES' not in s + assert '--calling--' not in s + assert 'IndexError' not in s + + def test_tb_crashline(self, testdir, option): + p = testdir.makepyfile(""" + import pytest + def g(): + raise IndexError + def test_func1(): + print (6*7) + g() # --calling-- + def test_func2(): + assert 0, "hello" + """) + result = testdir.runpytest("--tb=line") + bn = p.basename + result.stdout.fnmatch_lines([ + "*%s:3: IndexError*" % bn, + "*%s:8: AssertionError: hello*" % bn, + ]) + s = result.stdout.str() + assert "def test_func2" not in s + + def test_pytest_report_header(self, testdir, option): + testdir.makeconftest(""" + def pytest_sessionstart(session): + session.config._somevalue = 42 + def pytest_report_header(config): + return "hello: %s" % config._somevalue + """) + testdir.mkdir("a").join("conftest.py").write(""" +def pytest_report_header(config, startdir): + return ["line1", str(startdir)] +""") + result = testdir.runpytest("a") + result.stdout.fnmatch_lines([ + "*hello: 42*", + "line1", + str(testdir.tmpdir), + ]) + +@pytest.mark.xfail("not hasattr(os, 'dup')") +def test_fdopen_kept_alive_issue124(testdir): + testdir.makepyfile(""" + import os, sys + k = [] + def test_open_file_and_keep_alive(capfd): + stdout = os.fdopen(1, 'w', 1) + k.append(stdout) + + def test_close_kept_alive_file(): + stdout = k.pop() + stdout.close() + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*2 passed*" + ]) + +def test_tbstyle_native_setup_error(testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture + def setup_error_fixture(): + raise Exception("error in exception") + + def test_error_fixture(setup_error_fixture): + pass + """) + result = testdir.runpytest("--tb=native") + result.stdout.fnmatch_lines([ + '*File *test_tbstyle_native_setup_error.py", line *, in setup_error_fixture*' + ]) + +def test_terminal_summary(testdir): + testdir.makeconftest(""" + def pytest_terminal_summary(terminalreporter): + w = terminalreporter + w.section("hello") + w.line("world") + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines(""" + *==== hello ====* + world + """) + + +def test_terminal_summary_warnings_are_displayed(testdir): + """Test that warnings emitted during pytest_terminal_summary are displayed. + (#1305). + """ + testdir.makeconftest(""" + def pytest_terminal_summary(terminalreporter): + config = terminalreporter.config + config.warn('C1', 'internal warning') + """) + result = testdir.runpytest('-rw') + result.stdout.fnmatch_lines([ + '*C1*internal warning', + '*== 1 pytest-warnings in *', + ]) + + +@pytest.mark.parametrize("exp_color, exp_line, stats_arg", [ + # The method under test only cares about the length of each + # dict value, not the actual contents, so tuples of anything + # suffice + + # Important statuses -- the highest priority of these always wins + ("red", "1 failed", {"failed": (1,)}), + ("red", "1 failed, 1 passed", {"failed": (1,), "passed": (1,)}), + + ("red", "1 error", {"error": (1,)}), + ("red", "1 passed, 1 error", {"error": (1,), "passed": (1,)}), + + # (a status that's not known to the code) + ("yellow", "1 weird", {"weird": (1,)}), + ("yellow", "1 passed, 1 weird", {"weird": (1,), "passed": (1,)}), + + ("yellow", "1 pytest-warnings", {"warnings": (1,)}), + ("yellow", "1 passed, 1 pytest-warnings", {"warnings": (1,), + "passed": (1,)}), + + ("green", "5 passed", {"passed": (1,2,3,4,5)}), + + + # "Boring" statuses. These have no effect on the color of the summary + # line. Thus, if *every* test has a boring status, the summary line stays + # at its default color, i.e. yellow, to warn the user that the test run + # produced no useful information + ("yellow", "1 skipped", {"skipped": (1,)}), + ("green", "1 passed, 1 skipped", {"skipped": (1,), "passed": (1,)}), + + ("yellow", "1 deselected", {"deselected": (1,)}), + ("green", "1 passed, 1 deselected", {"deselected": (1,), "passed": (1,)}), + + ("yellow", "1 xfailed", {"xfailed": (1,)}), + ("green", "1 passed, 1 xfailed", {"xfailed": (1,), "passed": (1,)}), + + ("yellow", "1 xpassed", {"xpassed": (1,)}), + ("green", "1 passed, 1 xpassed", {"xpassed": (1,), "passed": (1,)}), + + # Likewise if no tests were found at all + ("yellow", "no tests ran", {}), + + # Test the empty-key special case + ("yellow", "no tests ran", {"": (1,)}), + ("green", "1 passed", {"": (1,), "passed": (1,)}), + + + # A couple more complex combinations + ("red", "1 failed, 2 passed, 3 xfailed", + {"passed": (1,2), "failed": (1,), "xfailed": (1,2,3)}), + + ("green", "1 passed, 2 skipped, 3 deselected, 2 xfailed", + {"passed": (1,), + "skipped": (1,2), + "deselected": (1,2,3), + "xfailed": (1,2)}), +]) +def test_summary_stats(exp_line, exp_color, stats_arg): + print("Based on stats: %s" % stats_arg) + print("Expect summary: \"%s\"; with color \"%s\"" % (exp_line, exp_color)) + (line, color) = build_summary_stats_line(stats_arg) + print("Actually got: \"%s\"; with color \"%s\"" % (line, color)) + assert line == exp_line + assert color == exp_color diff --git a/testing/web-platform/tests/tools/pytest/testing/test_tmpdir.py b/testing/web-platform/tests/tools/pytest/testing/test_tmpdir.py new file mode 100644 index 000000000..d514e722e --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_tmpdir.py @@ -0,0 +1,183 @@ +import sys +import py +import pytest + +from _pytest.tmpdir import tmpdir + +def test_funcarg(testdir): + testdir.makepyfile(""" + def pytest_generate_tests(metafunc): + metafunc.addcall(id='a') + metafunc.addcall(id='b') + def test_func(tmpdir): pass + """) + from _pytest.tmpdir import TempdirFactory + reprec = testdir.inline_run() + calls = reprec.getcalls("pytest_runtest_setup") + item = calls[0].item + config = item.config + tmpdirhandler = TempdirFactory(config) + item._initrequest() + p = tmpdir(item._request, tmpdirhandler) + assert p.check() + bn = p.basename.strip("0123456789") + assert bn.endswith("test_func_a_") + item.name = "qwe/\\abc" + p = tmpdir(item._request, tmpdirhandler) + assert p.check() + bn = p.basename.strip("0123456789") + assert bn == "qwe__abc" + +def test_ensuretemp(recwarn): + #pytest.deprecated_call(pytest.ensuretemp, 'hello') + d1 = pytest.ensuretemp('hello') + d2 = pytest.ensuretemp('hello') + assert d1 == d2 + assert d1.check(dir=1) + +class TestTempdirHandler: + def test_mktemp(self, testdir): + from _pytest.tmpdir import TempdirFactory + config = testdir.parseconfig() + config.option.basetemp = testdir.mkdir("hello") + t = TempdirFactory(config) + tmp = t.mktemp("world") + assert tmp.relto(t.getbasetemp()) == "world0" + tmp = t.mktemp("this") + assert tmp.relto(t.getbasetemp()).startswith("this") + tmp2 = t.mktemp("this") + assert tmp2.relto(t.getbasetemp()).startswith("this") + assert tmp2 != tmp + +class TestConfigTmpdir: + def test_getbasetemp_custom_removes_old(self, testdir): + mytemp = testdir.tmpdir.join("xyz") + p = testdir.makepyfile(""" + def test_1(tmpdir): + pass + """) + testdir.runpytest(p, '--basetemp=%s' % mytemp) + mytemp.check() + mytemp.ensure("hello") + + testdir.runpytest(p, '--basetemp=%s' % mytemp) + mytemp.check() + assert not mytemp.join("hello").check() + + +def test_basetemp(testdir): + mytemp = testdir.tmpdir.mkdir("mytemp") + p = testdir.makepyfile(""" + import pytest + def test_1(): + pytest.ensuretemp("hello") + """) + result = testdir.runpytest(p, '--basetemp=%s' % mytemp) + assert result.ret == 0 + assert mytemp.join('hello').check() + +@pytest.mark.skipif(not hasattr(py.path.local, 'mksymlinkto'), + reason="symlink not available on this platform") +def test_tmpdir_always_is_realpath(testdir): + # the reason why tmpdir should be a realpath is that + # when you cd to it and do "os.getcwd()" you will anyway + # get the realpath. Using the symlinked path can thus + # easily result in path-inequality + # XXX if that proves to be a problem, consider using + # os.environ["PWD"] + realtemp = testdir.tmpdir.mkdir("myrealtemp") + linktemp = testdir.tmpdir.join("symlinktemp") + linktemp.mksymlinkto(realtemp) + p = testdir.makepyfile(""" + def test_1(tmpdir): + import os + assert os.path.realpath(str(tmpdir)) == str(tmpdir) + """) + result = testdir.runpytest("-s", p, '--basetemp=%s/bt' % linktemp) + assert not result.ret + + +def test_tmpdir_too_long_on_parametrization(testdir): + testdir.makepyfile(""" + import pytest + @pytest.mark.parametrize("arg", ["1"*1000]) + def test_some(arg, tmpdir): + tmpdir.ensure("hello") + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + +def test_tmpdir_factory(testdir): + testdir.makepyfile(""" + import pytest + @pytest.fixture(scope='session') + def session_dir(tmpdir_factory): + return tmpdir_factory.mktemp('data', numbered=False) + def test_some(session_dir): + session_dir.isdir() + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + +def test_tmpdir_fallback_tox_env(testdir, monkeypatch): + """Test that tmpdir works even if environment variables required by getpass + module are missing (#1010). + """ + monkeypatch.delenv('USER', raising=False) + monkeypatch.delenv('USERNAME', raising=False) + testdir.makepyfile(""" + import pytest + def test_some(tmpdir): + assert tmpdir.isdir() + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + +@pytest.fixture +def break_getuser(monkeypatch): + monkeypatch.setattr('os.getuid', lambda: -1) + # taken from python 2.7/3.4 + for envvar in ('LOGNAME', 'USER', 'LNAME', 'USERNAME'): + monkeypatch.delenv(envvar, raising=False) + + +@pytest.mark.usefixtures("break_getuser") +@pytest.mark.skipif(sys.platform.startswith('win'), reason='no os.getuid on windows') +def test_tmpdir_fallback_uid_not_found(testdir): + """Test that tmpdir works even if the current process's user id does not + correspond to a valid user. + """ + + testdir.makepyfile(""" + import pytest + def test_some(tmpdir): + assert tmpdir.isdir() + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + +@pytest.mark.usefixtures("break_getuser") +@pytest.mark.skipif(sys.platform.startswith('win'), reason='no os.getuid on windows') +def test_get_user_uid_not_found(): + """Test that get_user() function works even if the current process's + user id does not correspond to a valid user (e.g. running pytest in a + Docker container with 'docker run -u'. + """ + from _pytest.tmpdir import get_user + assert get_user() is None + + +@pytest.mark.skipif(not sys.platform.startswith('win'), reason='win only') +def test_get_user(monkeypatch): + """Test that get_user() function works even if environment variables + required by getpass module are missing from the environment on Windows + (#1010). + """ + from _pytest.tmpdir import get_user + monkeypatch.delenv('USER', raising=False) + monkeypatch.delenv('USERNAME', raising=False) + assert get_user() is None diff --git a/testing/web-platform/tests/tools/pytest/testing/test_unittest.py b/testing/web-platform/tests/tools/pytest/testing/test_unittest.py new file mode 100644 index 000000000..144aad79b --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/testing/test_unittest.py @@ -0,0 +1,737 @@ +from _pytest.main import EXIT_NOTESTSCOLLECTED +import pytest + +def test_simple_unittest(testdir): + testpath = testdir.makepyfile(""" + import unittest + class MyTestCase(unittest.TestCase): + def testpassing(self): + self.assertEquals('foo', 'foo') + def test_failing(self): + self.assertEquals('foo', 'bar') + """) + reprec = testdir.inline_run(testpath) + assert reprec.matchreport("testpassing").passed + assert reprec.matchreport("test_failing").failed + +def test_runTest_method(testdir): + testdir.makepyfile(""" + import unittest + class MyTestCaseWithRunTest(unittest.TestCase): + def runTest(self): + self.assertEquals('foo', 'foo') + class MyTestCaseWithoutRunTest(unittest.TestCase): + def runTest(self): + self.assertEquals('foo', 'foo') + def test_something(self): + pass + """) + result = testdir.runpytest("-v") + result.stdout.fnmatch_lines(""" + *MyTestCaseWithRunTest::runTest* + *MyTestCaseWithoutRunTest::test_something* + *2 passed* + """) + +def test_isclasscheck_issue53(testdir): + testpath = testdir.makepyfile(""" + import unittest + class _E(object): + def __getattr__(self, tag): + pass + E = _E() + """) + result = testdir.runpytest(testpath) + assert result.ret == EXIT_NOTESTSCOLLECTED + +def test_setup(testdir): + testpath = testdir.makepyfile(""" + import unittest + class MyTestCase(unittest.TestCase): + def setUp(self): + self.foo = 1 + def setup_method(self, method): + self.foo2 = 1 + def test_both(self): + self.assertEquals(1, self.foo) + assert self.foo2 == 1 + def teardown_method(self, method): + assert 0, "42" + + """) + reprec = testdir.inline_run("-s", testpath) + assert reprec.matchreport("test_both", when="call").passed + rep = reprec.matchreport("test_both", when="teardown") + assert rep.failed and '42' in str(rep.longrepr) + +def test_setUpModule(testdir): + testpath = testdir.makepyfile(""" + l = [] + + def setUpModule(): + l.append(1) + + def tearDownModule(): + del l[0] + + def test_hello(): + assert l == [1] + + def test_world(): + assert l == [1] + """) + result = testdir.runpytest(testpath) + result.stdout.fnmatch_lines([ + "*2 passed*", + ]) + +def test_setUpModule_failing_no_teardown(testdir): + testpath = testdir.makepyfile(""" + l = [] + + def setUpModule(): + 0/0 + + def tearDownModule(): + l.append(1) + + def test_hello(): + pass + """) + reprec = testdir.inline_run(testpath) + reprec.assertoutcome(passed=0, failed=1) + call = reprec.getcalls("pytest_runtest_setup")[0] + assert not call.item.module.l + +def test_new_instances(testdir): + testpath = testdir.makepyfile(""" + import unittest + class MyTestCase(unittest.TestCase): + def test_func1(self): + self.x = 2 + def test_func2(self): + assert not hasattr(self, 'x') + """) + reprec = testdir.inline_run(testpath) + reprec.assertoutcome(passed=2) + +def test_teardown(testdir): + testpath = testdir.makepyfile(""" + import unittest + class MyTestCase(unittest.TestCase): + l = [] + def test_one(self): + pass + def tearDown(self): + self.l.append(None) + class Second(unittest.TestCase): + def test_check(self): + self.assertEquals(MyTestCase.l, [None]) + """) + reprec = testdir.inline_run(testpath) + passed, skipped, failed = reprec.countoutcomes() + assert failed == 0, failed + assert passed == 2 + assert passed + skipped + failed == 2 + +@pytest.mark.skipif("sys.version_info < (2,7)") +def test_unittest_skip_issue148(testdir): + testpath = testdir.makepyfile(""" + import unittest + + @unittest.skip("hello") + class MyTestCase(unittest.TestCase): + @classmethod + def setUpClass(self): + xxx + def test_one(self): + pass + @classmethod + def tearDownClass(self): + xxx + """) + reprec = testdir.inline_run(testpath) + reprec.assertoutcome(skipped=1) + +def test_method_and_teardown_failing_reporting(testdir): + testdir.makepyfile(""" + import unittest, pytest + class TC(unittest.TestCase): + def tearDown(self): + assert 0, "down1" + def test_method(self): + assert False, "down2" + """) + result = testdir.runpytest("-s") + assert result.ret == 1 + result.stdout.fnmatch_lines([ + "*tearDown*", + "*assert 0*", + "*test_method*", + "*assert False*", + "*1 failed*1 error*", + ]) + +def test_setup_failure_is_shown(testdir): + testdir.makepyfile(""" + import unittest + import pytest + class TC(unittest.TestCase): + def setUp(self): + assert 0, "down1" + def test_method(self): + print ("never42") + xyz + """) + result = testdir.runpytest("-s") + assert result.ret == 1 + result.stdout.fnmatch_lines([ + "*setUp*", + "*assert 0*down1*", + "*1 failed*", + ]) + assert 'never42' not in result.stdout.str() + +def test_setup_setUpClass(testdir): + testpath = testdir.makepyfile(""" + import unittest + import pytest + class MyTestCase(unittest.TestCase): + x = 0 + @classmethod + def setUpClass(cls): + cls.x += 1 + def test_func1(self): + assert self.x == 1 + def test_func2(self): + assert self.x == 1 + @classmethod + def tearDownClass(cls): + cls.x -= 1 + def test_teareddown(): + assert MyTestCase.x == 0 + """) + reprec = testdir.inline_run(testpath) + reprec.assertoutcome(passed=3) + +def test_setup_class(testdir): + testpath = testdir.makepyfile(""" + import unittest + import pytest + class MyTestCase(unittest.TestCase): + x = 0 + def setup_class(cls): + cls.x += 1 + def test_func1(self): + assert self.x == 1 + def test_func2(self): + assert self.x == 1 + def teardown_class(cls): + cls.x -= 1 + def test_teareddown(): + assert MyTestCase.x == 0 + """) + reprec = testdir.inline_run(testpath) + reprec.assertoutcome(passed=3) + + +@pytest.mark.parametrize("type", ['Error', 'Failure']) +def test_testcase_adderrorandfailure_defers(testdir, type): + testdir.makepyfile(""" + from unittest import TestCase + import pytest + class MyTestCase(TestCase): + def run(self, result): + excinfo = pytest.raises(ZeroDivisionError, lambda: 0/0) + try: + result.add%s(self, excinfo._excinfo) + except KeyboardInterrupt: + raise + except: + pytest.fail("add%s should not raise") + def test_hello(self): + pass + """ % (type, type)) + result = testdir.runpytest() + assert 'should not raise' not in result.stdout.str() + +@pytest.mark.parametrize("type", ['Error', 'Failure']) +def test_testcase_custom_exception_info(testdir, type): + testdir.makepyfile(""" + from unittest import TestCase + import py, pytest + import _pytest._code + class MyTestCase(TestCase): + def run(self, result): + excinfo = pytest.raises(ZeroDivisionError, lambda: 0/0) + # we fake an incompatible exception info + from _pytest.monkeypatch import monkeypatch + mp = monkeypatch() + def t(*args): + mp.undo() + raise TypeError() + mp.setattr(_pytest._code, 'ExceptionInfo', t) + try: + excinfo = excinfo._excinfo + result.add%(type)s(self, excinfo) + finally: + mp.undo() + def test_hello(self): + pass + """ % locals()) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "NOTE: Incompatible Exception Representation*", + "*ZeroDivisionError*", + "*1 failed*", + ]) + +def test_testcase_totally_incompatible_exception_info(testdir): + item, = testdir.getitems(""" + from unittest import TestCase + class MyTestCase(TestCase): + def test_hello(self): + pass + """) + item.addError(None, 42) + excinfo = item._excinfo.pop(0) + assert 'ERROR: Unknown Incompatible' in str(excinfo.getrepr()) + +def test_module_level_pytestmark(testdir): + testpath = testdir.makepyfile(""" + import unittest + import pytest + pytestmark = pytest.mark.xfail + class MyTestCase(unittest.TestCase): + def test_func1(self): + assert 0 + """) + reprec = testdir.inline_run(testpath, "-s") + reprec.assertoutcome(skipped=1) + + +def test_trial_testcase_skip_property(testdir): + pytest.importorskip('twisted.trial.unittest') + testpath = testdir.makepyfile(""" + from twisted.trial import unittest + class MyTestCase(unittest.TestCase): + skip = 'dont run' + def test_func(self): + pass + """) + reprec = testdir.inline_run(testpath, "-s") + reprec.assertoutcome(skipped=1) + + +def test_trial_testfunction_skip_property(testdir): + pytest.importorskip('twisted.trial.unittest') + testpath = testdir.makepyfile(""" + from twisted.trial import unittest + class MyTestCase(unittest.TestCase): + def test_func(self): + pass + test_func.skip = 'dont run' + """) + reprec = testdir.inline_run(testpath, "-s") + reprec.assertoutcome(skipped=1) + + +def test_trial_testcase_todo_property(testdir): + pytest.importorskip('twisted.trial.unittest') + testpath = testdir.makepyfile(""" + from twisted.trial import unittest + class MyTestCase(unittest.TestCase): + todo = 'dont run' + def test_func(self): + assert 0 + """) + reprec = testdir.inline_run(testpath, "-s") + reprec.assertoutcome(skipped=1) + + +def test_trial_testfunction_todo_property(testdir): + pytest.importorskip('twisted.trial.unittest') + testpath = testdir.makepyfile(""" + from twisted.trial import unittest + class MyTestCase(unittest.TestCase): + def test_func(self): + assert 0 + test_func.todo = 'dont run' + """) + reprec = testdir.inline_run(testpath, "-s") + reprec.assertoutcome(skipped=1) + + +class TestTrialUnittest: + def setup_class(cls): + cls.ut = pytest.importorskip("twisted.trial.unittest") + + def test_trial_testcase_runtest_not_collected(self, testdir): + testdir.makepyfile(""" + from twisted.trial.unittest import TestCase + + class TC(TestCase): + def test_hello(self): + pass + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + testdir.makepyfile(""" + from twisted.trial.unittest import TestCase + + class TC(TestCase): + def runTest(self): + pass + """) + reprec = testdir.inline_run() + reprec.assertoutcome(passed=1) + + def test_trial_exceptions_with_skips(self, testdir): + testdir.makepyfile(""" + from twisted.trial import unittest + import pytest + class TC(unittest.TestCase): + def test_hello(self): + pytest.skip("skip_in_method") + @pytest.mark.skipif("sys.version_info != 1") + def test_hello2(self): + pass + @pytest.mark.xfail(reason="iwanto") + def test_hello3(self): + assert 0 + def test_hello4(self): + pytest.xfail("i2wanto") + def test_trial_skip(self): + pass + test_trial_skip.skip = "trialselfskip" + + def test_trial_todo(self): + assert 0 + test_trial_todo.todo = "mytodo" + + def test_trial_todo_success(self): + pass + test_trial_todo_success.todo = "mytodo" + + class TC2(unittest.TestCase): + def setup_class(cls): + pytest.skip("skip_in_setup_class") + def test_method(self): + pass + """) + result = testdir.runpytest("-rxs") + assert result.ret == 0 + result.stdout.fnmatch_lines_random([ + "*XFAIL*test_trial_todo*", + "*trialselfskip*", + "*skip_in_setup_class*", + "*iwanto*", + "*i2wanto*", + "*sys.version_info*", + "*skip_in_method*", + "*4 skipped*3 xfail*1 xpass*", + ]) + + def test_trial_error(self, testdir): + testdir.makepyfile(""" + from twisted.trial.unittest import TestCase + from twisted.internet.defer import Deferred + from twisted.internet import reactor + + class TC(TestCase): + def test_one(self): + crash + + def test_two(self): + def f(_): + crash + + d = Deferred() + d.addCallback(f) + reactor.callLater(0.3, d.callback, None) + return d + + def test_three(self): + def f(): + pass # will never get called + reactor.callLater(0.3, f) + # will crash at teardown + + def test_four(self): + def f(_): + reactor.callLater(0.3, f) + crash + + d = Deferred() + d.addCallback(f) + reactor.callLater(0.3, d.callback, None) + return d + # will crash both at test time and at teardown + """) + result = testdir.runpytest() + result.stdout.fnmatch_lines([ + "*ERRORS*", + "*DelayedCalls*", + "*test_four*", + "*NameError*crash*", + "*test_one*", + "*NameError*crash*", + "*test_three*", + "*DelayedCalls*", + "*test_two*", + "*crash*", + ]) + + def test_trial_pdb(self, testdir): + p = testdir.makepyfile(""" + from twisted.trial import unittest + import pytest + class TC(unittest.TestCase): + def test_hello(self): + assert 0, "hellopdb" + """) + child = testdir.spawn_pytest(p) + child.expect("hellopdb") + child.sendeof() + +def test_djangolike_testcase(testdir): + # contributed from Morten Breekevold + testdir.makepyfile(""" + from unittest import TestCase, main + + class DjangoLikeTestCase(TestCase): + + def setUp(self): + print ("setUp()") + + def test_presetup_has_been_run(self): + print ("test_thing()") + self.assertTrue(hasattr(self, 'was_presetup')) + + def tearDown(self): + print ("tearDown()") + + def __call__(self, result=None): + try: + self._pre_setup() + except (KeyboardInterrupt, SystemExit): + raise + except Exception: + import sys + result.addError(self, sys.exc_info()) + return + super(DjangoLikeTestCase, self).__call__(result) + try: + self._post_teardown() + except (KeyboardInterrupt, SystemExit): + raise + except Exception: + import sys + result.addError(self, sys.exc_info()) + return + + def _pre_setup(self): + print ("_pre_setup()") + self.was_presetup = True + + def _post_teardown(self): + print ("_post_teardown()") + """) + result = testdir.runpytest("-s") + assert result.ret == 0 + result.stdout.fnmatch_lines([ + "*_pre_setup()*", + "*setUp()*", + "*test_thing()*", + "*tearDown()*", + "*_post_teardown()*", + ]) + + +def test_unittest_not_shown_in_traceback(testdir): + testdir.makepyfile(""" + import unittest + class t(unittest.TestCase): + def test_hello(self): + x = 3 + self.assertEquals(x, 4) + """) + res = testdir.runpytest() + assert "failUnlessEqual" not in res.stdout.str() + +def test_unorderable_types(testdir): + testdir.makepyfile(""" + import unittest + class TestJoinEmpty(unittest.TestCase): + pass + + def make_test(): + class Test(unittest.TestCase): + pass + Test.__name__ = "TestFoo" + return Test + TestFoo = make_test() + """) + result = testdir.runpytest() + assert "TypeError" not in result.stdout.str() + assert result.ret == EXIT_NOTESTSCOLLECTED + +def test_unittest_typerror_traceback(testdir): + testdir.makepyfile(""" + import unittest + class TestJoinEmpty(unittest.TestCase): + def test_hello(self, arg1): + pass + """) + result = testdir.runpytest() + assert "TypeError" in result.stdout.str() + assert result.ret == 1 + +@pytest.mark.skipif("sys.version_info < (2,7)") +def test_unittest_unexpected_failure(testdir): + testdir.makepyfile(""" + import unittest + class MyTestCase(unittest.TestCase): + @unittest.expectedFailure + def test_func1(self): + assert 0 + @unittest.expectedFailure + def test_func2(self): + assert 1 + """) + result = testdir.runpytest("-rxX") + result.stdout.fnmatch_lines([ + "*XFAIL*MyTestCase*test_func1*", + "*XPASS*MyTestCase*test_func2*", + "*1 xfailed*1 xpass*", + ]) + + +@pytest.mark.parametrize('fix_type, stmt', [ + ('fixture', 'return'), + ('yield_fixture', 'yield'), +]) +def test_unittest_setup_interaction(testdir, fix_type, stmt): + testdir.makepyfile(""" + import unittest + import pytest + class MyTestCase(unittest.TestCase): + @pytest.{fix_type}(scope="class", autouse=True) + def perclass(self, request): + request.cls.hello = "world" + {stmt} + @pytest.{fix_type}(scope="function", autouse=True) + def perfunction(self, request): + request.instance.funcname = request.function.__name__ + {stmt} + + def test_method1(self): + assert self.funcname == "test_method1" + assert self.hello == "world" + + def test_method2(self): + assert self.funcname == "test_method2" + + def test_classattr(self): + assert self.__class__.hello == "world" + """.format(fix_type=fix_type, stmt=stmt)) + result = testdir.runpytest() + result.stdout.fnmatch_lines("*3 passed*") + + +def test_non_unittest_no_setupclass_support(testdir): + testpath = testdir.makepyfile(""" + class TestFoo: + x = 0 + + @classmethod + def setUpClass(cls): + cls.x = 1 + + def test_method1(self): + assert self.x == 0 + + @classmethod + def tearDownClass(cls): + cls.x = 1 + + def test_not_teareddown(): + assert TestFoo.x == 0 + + """) + reprec = testdir.inline_run(testpath) + reprec.assertoutcome(passed=2) + + +def test_no_teardown_if_setupclass_failed(testdir): + testpath = testdir.makepyfile(""" + import unittest + + class MyTestCase(unittest.TestCase): + x = 0 + + @classmethod + def setUpClass(cls): + cls.x = 1 + assert False + + def test_func1(self): + cls.x = 10 + + @classmethod + def tearDownClass(cls): + cls.x = 100 + + def test_notTornDown(): + assert MyTestCase.x == 1 + """) + reprec = testdir.inline_run(testpath) + reprec.assertoutcome(passed=1, failed=1) + + +def test_issue333_result_clearing(testdir): + testdir.makeconftest(""" + def pytest_runtest_call(__multicall__, item): + __multicall__.execute() + assert 0 + """) + testdir.makepyfile(""" + import unittest + class TestIt(unittest.TestCase): + def test_func(self): + 0/0 + """) + + reprec = testdir.inline_run() + reprec.assertoutcome(failed=1) + +@pytest.mark.skipif("sys.version_info < (2,7)") +def test_unittest_raise_skip_issue748(testdir): + testdir.makepyfile(test_foo=""" + import unittest + + class MyTestCase(unittest.TestCase): + def test_one(self): + raise unittest.SkipTest('skipping due to reasons') + """) + result = testdir.runpytest("-v", '-rs') + result.stdout.fnmatch_lines(""" + *SKIP*[1]*test_foo.py*skipping due to reasons* + *1 skipped* + """) + +@pytest.mark.skipif("sys.version_info < (2,7)") +def test_unittest_skip_issue1169(testdir): + testdir.makepyfile(test_foo=""" + import unittest + + class MyTestCase(unittest.TestCase): + @unittest.skip("skipping due to reasons") + def test_skip(self): + self.fail() + """) + result = testdir.runpytest("-v", '-rs') + result.stdout.fnmatch_lines(""" + *SKIP*[1]*skipping due to reasons* + *1 skipped* + """) diff --git a/testing/web-platform/tests/tools/pytest/tox.ini b/testing/web-platform/tests/tools/pytest/tox.ini new file mode 100644 index 000000000..5f65446e4 --- /dev/null +++ b/testing/web-platform/tests/tools/pytest/tox.ini @@ -0,0 +1,160 @@ +[tox] +minversion=2.0 +distshare={homedir}/.tox/distshare +envlist= + linting,py26,py27,py33,py34,py35,pypy, + {py27,py35}-{pexpect,xdist,trial}, + py27-nobyte,doctesting,py27-cxfreeze + +[testenv] +commands= py.test --lsof -rfsxX {posargs:testing} +passenv = USER USERNAME +deps= + nose + mock + requests + +[testenv:py26] +commands= py.test --lsof -rfsxX {posargs:testing} +deps= + nose + mock<1.1 # last supported version for py26 + +[testenv:py27-subprocess] +changedir=. +basepython=python2.7 +deps=pytest-xdist>=1.13 + mock + nose +commands= + py.test -n3 -rfsxX --runpytest=subprocess {posargs:testing} + +[testenv:genscript] +commands= py.test --genscript=pytest1 + +[testenv:linting] +basepython = python2.7 +deps = flake8 + restructuredtext_lint +commands = flake8 pytest.py _pytest testing + rst-lint CHANGELOG.rst + +[testenv:py27-xdist] +deps=pytest-xdist>=1.13 + mock + nose +commands= + py.test -n1 -rfsxX {posargs:testing} + +[testenv:py35-xdist] +deps={[testenv:py27-xdist]deps} +commands= + py.test -n3 -rfsxX {posargs:testing} + +[testenv:py27-pexpect] +changedir=testing +platform=linux|darwin +deps=pexpect +commands= + py.test -rfsxX test_pdb.py test_terminal.py test_unittest.py + +[testenv:py35-pexpect] +changedir=testing +platform=linux|darwin +deps={[testenv:py27-pexpect]deps} +commands= + py.test -rfsxX test_pdb.py test_terminal.py test_unittest.py + +[testenv:py27-nobyte] +deps=pytest-xdist>=1.13 +distribute=true +setenv= + PYTHONDONTWRITEBYTECODE=1 +commands= + py.test -n3 -rfsxX {posargs:testing} + +[testenv:py27-trial] +deps=twisted +commands= + py.test -rsxf {posargs:testing/test_unittest.py} + +[testenv:py35-trial] +platform=linux|darwin +deps={[testenv:py27-trial]deps} +commands= + py.test -rsxf {posargs:testing/test_unittest.py} + +[testenv:doctest] +commands=py.test --doctest-modules _pytest +deps= + +[testenv:doc] +basepython=python +changedir=doc/en +deps=sphinx + PyYAML + +commands= + make clean + make html + +[testenv:doctesting] +basepython = python3.4 +changedir=doc/en +deps=PyYAML +commands= py.test -rfsxX {posargs} + +[testenv:regen] +changedir=doc/en +basepython = python3.4 +deps=sphinx + PyYAML + regendoc>=0.6.1 +whitelist_externals= + rm + make +commands= + rm -rf /tmp/doc-exec* + make regen + +[testenv:jython] +changedir=testing +commands= + {envpython} {envbindir}/py.test-jython -rfsxX {posargs} + +[testenv:py27-cxfreeze] +changedir=testing/cx_freeze +platform=linux|darwin +commands= + {envpython} install_cx_freeze.py + {envpython} runtests_setup.py build --build-exe build + {envpython} tox_run.py + + +[testenv:coveralls] +passenv = TRAVIS TRAVIS_JOB_ID TRAVIS_BRANCH COVERALLS_REPO_TOKEN +usedevelop=True +basepython=python3.4 +changedir=. +deps = + {[testenv]deps} + coveralls +commands= + coverage run --source=_pytest -m pytest testing + coverage report -m + coveralls + +[pytest] +minversion=2.0 +plugins=pytester +#--pyargs --doctest-modules --ignore=.tox +addopts= -rxsX -p pytester --ignore=testing/cx_freeze +rsyncdirs=tox.ini pytest.py _pytest testing +python_files=test_*.py *_test.py testing/*/*.py +python_classes=Test Acceptance +python_functions=test +norecursedirs = .tox ja .hg cx_freeze_source + + +[flake8] +ignore =E401,E225,E261,E128,E124,E301,E302,E121,E303,W391,E501,E231,E126,E701,E265,E241,E251,E226,E101,W191,E131,E203,E122,E123,E271,E712,E222,E127,E125,E221,W292,E111,E113,E293,E262,W293,E129,E702,E201,E272,E202,E704,E731,E402 |