diff --git a/bin-for-dist/makepluginlist.py b/bin-for-dist/makepluginlist.py index 4abab13cc..33012c4f9 100644 --- a/bin-for-dist/makepluginlist.py +++ b/bin-for-dist/makepluginlist.py @@ -187,7 +187,8 @@ class PluginDoc(RestWriter): self.emit_funcargs(plugin) self.emit_options(plugin) - self.emit_source(plugin, config.hg_changeset) + if name not in externals: + self.emit_source(plugin, config.hg_changeset) #self.sourcelink = (purename, # "http://bitbucket.org/hpk42/py-trunk/src/tip/py/test/plugin/" + # purename + ".py") diff --git a/doc/confrest.py b/doc/confrest.py index b228dfd36..8bc6fa5f3 100644 --- a/doc/confrest.py +++ b/doc/confrest.py @@ -66,10 +66,11 @@ pageTracker._trackPageview(); self.a_docref("Index", "test/index.html"), self.a_docref("Quickstart", "test/quickstart.html"), self.a_docref("Features", "test/features.html"), - self.a_docref("Plugins", "test/plugin/index.html"), self.a_docref("Funcargs", "test/funcargs.html"), + self.a_docref("Plugins", "test/plugin/index.html"), self.a_docref("Customize", "test/customize.html"), self.a_docref("Tutorials", "test/talks.html"), + self.a_href("hudson-tests", "http://hudson.testrun.org") ), html.div( html.h3("supporting APIs:"), diff --git a/doc/test/funcargs.txt b/doc/test/funcargs.txt index b6a561165..c3bb2975a 100644 --- a/doc/test/funcargs.txt +++ b/doc/test/funcargs.txt @@ -1,5 +1,5 @@ ============================================================== -**funcargs**: advanced test parametrization +**funcargs**: advanced test fixtures and parametrization ============================================================== .. contents:: @@ -77,9 +77,15 @@ calls 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. +with a list of available function arguments. You can +also issue:: -factory functions receive a `request object`_ + py.test --funcargs test_simplefactory.py + +to see available function arguments (which you can also +think of as "resources"). + +Factory functions receive a `request object`_ which they can use to register setup/teardown functions or access meta data about a test. diff --git a/doc/test/index.txt b/doc/test/index.txt index 11b665914..b17f7fe9e 100644 --- a/doc/test/index.txt +++ b/doc/test/index.txt @@ -17,6 +17,13 @@ customize_: configuration, customization, extensions changelog_: history of changes covering last releases +**Continous Integration of py.test'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 diff --git a/doc/test/plugin/figleaf.txt b/doc/test/plugin/figleaf.txt index 31f6e791e..86e0da65b 100644 --- a/doc/test/plugin/figleaf.txt +++ b/doc/test/plugin/figleaf.txt @@ -6,16 +6,29 @@ 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 pip or easy_install mediated installation of ``pytest-figleaf`` you can type:: +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 ``--fig-data`` -and ``fig-html`` to modify the paths. +and "html" directory will be created. You can use command line options +to control where data and html files are created. command line options -------------------- @@ -28,14 +41,4 @@ command line options ``--fig-html=dir`` set html reporting dir, default "html". -Start improving this plugin in 30 seconds -========================================= - - -1. Download `pytest_figleaf.py`_ plugin source code -2. put it somewhere as ``pytest_figleaf.py`` into your import path -3. a subsequent ``py.test`` run will use your local version - -Checkout customize_, other plugins_ or `get in contact`_. - .. include:: links.txt diff --git a/doc/test/plugin/links.txt b/doc/test/plugin/links.txt index 7b17cc44e..f627219c5 100644 --- a/doc/test/plugin/links.txt +++ b/doc/test/plugin/links.txt @@ -1,47 +1,45 @@ .. _`helpconfig`: helpconfig.html -.. _`terminal`: terminal.html -.. _`pytest_recwarn.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_recwarn.py +.. _`pytest_recwarn.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_recwarn.py .. _`unittest`: unittest.html -.. _`pytest_monkeypatch.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_monkeypatch.py -.. _`pytest_genscript.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_genscript.py +.. _`pytest_monkeypatch.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_monkeypatch.py +.. _`pytest_genscript.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/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.2.0/py/_plugin/pytest_doctest.py +.. _`pytest_doctest.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_doctest.py .. _`capture`: capture.html -.. _`pytest_nose.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_nose.py -.. _`pytest_restdoc.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_restdoc.py +.. _`pytest_nose.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_nose.py +.. _`pytest_restdoc.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_restdoc.py .. _`restdoc`: restdoc.html .. _`xdist`: xdist.html -.. _`pytest_pastebin.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_pastebin.py -.. _`pytest_tmpdir.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_tmpdir.py -.. _`pytest_figleaf.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_figleaf.py -.. _`pytest_hooklog.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_hooklog.py +.. _`pytest_pastebin.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_pastebin.py +.. _`pytest_tmpdir.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_tmpdir.py +.. _`terminal`: terminal.html +.. _`pytest_hooklog.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_hooklog.py .. _`junitxml`: junitxml.html -.. _`plugin.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/plugin.py -.. _`pytest_skipping.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_skipping.py +.. _`pytest_skipping.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_skipping.py .. _`checkout the py.test development version`: ../../install.html#checkout -.. _`pytest_helpconfig.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_helpconfig.py +.. _`pytest_helpconfig.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_helpconfig.py .. _`oejskit`: oejskit.html .. _`doctest`: doctest.html -.. _`pytest_mark.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_mark.py +.. _`pytest_mark.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_mark.py .. _`get in contact`: ../../contact.html -.. _`pytest_capture.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_capture.py +.. _`pytest_capture.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/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.2.0/py/_plugin/pytest_terminal.py +.. _`pytest_terminal.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_terminal.py .. _`recwarn`: recwarn.html -.. _`pytest_pdb.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_pdb.py +.. _`pytest_pdb.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_pdb.py .. _`monkeypatch`: monkeypatch.html .. _`coverage`: coverage.html .. _`resultlog`: resultlog.html -.. _`pytest_junitxml.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_junitxml.py +.. _`pytest_junitxml.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_junitxml.py .. _`django`: django.html -.. _`pytest_unittest.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_unittest.py +.. _`pytest_unittest.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_unittest.py .. _`nose`: nose.html -.. _`pytest_resultlog.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.0/py/_plugin/pytest_resultlog.py +.. _`pytest_resultlog.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.2.1/py/_plugin/pytest_resultlog.py .. _`pdb`: pdb.html diff --git a/doc/test/plugin/monkeypatch.txt b/doc/test/plugin/monkeypatch.txt index 009c2a974..b5455a7a3 100644 --- a/doc/test/plugin/monkeypatch.txt +++ b/doc/test/plugin/monkeypatch.txt @@ -75,10 +75,9 @@ helper methods to modify objects, dictionaries or os.environ:: monkeypatch.syspath_prepend(path) All modifications will be undone when the requesting -test function finished its execution. For the ``del`` -methods the ``raising`` parameter determines if a -KeyError or AttributeError will be raised if the -deletion has no target. +test function finished its execution. The ``raising`` +parameter determines if a KeyError or AttributeError +will be raised if the set/deletion operation has no target. Start improving this plugin in 30 seconds ========================================= diff --git a/doc/test/plugin/terminal.txt b/doc/test/plugin/terminal.txt index 65b23a925..fa9f46aae 100644 --- a/doc/test/plugin/terminal.txt +++ b/doc/test/plugin/terminal.txt @@ -19,9 +19,11 @@ command line options ``--report=opts`` show more info, valid: skipped,xfailed ``--tb=style`` - traceback verboseness (long/short/no). + traceback print mode (long/short/line/no). ``--fulltrace`` don't cut any tracebacks (default is to cut). +``--funcargs`` + show available function arguments, sorted by plugin Start improving this plugin in 30 seconds ========================================= diff --git a/doc/test/plugin/xdist.txt b/doc/test/plugin/xdist.txt index cb4fee920..faeaa9816 100644 --- a/doc/test/plugin/xdist.txt +++ b/doc/test/plugin/xdist.txt @@ -28,6 +28,18 @@ You may specify different Python versions and interpreters. .. _`pytest-xdist`: http://pypi.python.org/pypi/pytest-xdist +Install / Uninstall +--------------------- + +To install the xdist plugin simply type:: + + easy_install pytest-xdist # or + pip install pytest-xdist + +and to uninstall:: + + pip uninstall pytest-xdist + Usage examples --------------------- @@ -169,14 +181,4 @@ command line options ``--rsyncdir=dir1`` add directory for rsyncing to remote tx nodes. -Start improving this plugin in 30 seconds -========================================= - - -1. Download `plugin.py`_ plugin source code -2. put it somewhere as ``plugin.py`` into your import path -3. a subsequent ``py.test`` run will use your local version - -Checkout customize_, other plugins_ or `get in contact`_. - .. include:: links.txt