test_ok2/doc/en/example/nonpython.txt

.. _`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 linux2 -- Python 2.7.3 -- pytest-2.3.0.dev20
    collected 0 items / 1 errors
    
    ================================== ERRORS ==================================
    _____________________ ERROR collecting test_simple.yml _____________________
    conftest.py:11: in collect
    >       import yaml # we need a yaml parser, e.g. PyYAML
    E       ImportError: No module named yaml
    ========================= 1 error in 0.00 seconds ==========================

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 linux2 -- Python 2.7.3 -- pytest-2.3.0.dev20 -- /home/hpk/p/pytest/.tox/regen/bin/python
    collecting ... collected 0 items / 1 errors
    
    ================================== ERRORS ==================================
    _____________________ ERROR collecting test_simple.yml _____________________
    conftest.py:11: in collect
    >       import yaml # we need a yaml parser, e.g. PyYAML
    E       ImportError: No module named yaml
    ========================= 1 error in 0.01 seconds ==========================

While developing your custom test collection and execution it's also
interesting to just look at the collection tree::

    nonpython $ py.test --collectonly
    =========================== test session starts ============================
    platform linux2 -- Python 2.7.3 -- pytest-2.3.0.dev20
    collected 0 items / 1 errors
    
    ================================== ERRORS ==================================
    _____________________ ERROR collecting test_simple.yml _____________________
    conftest.py:11: in collect
    >       import yaml # we need a yaml parser, e.g. PyYAML
    E       ImportError: No module named yaml
    ========================= 1 error in 0.01 seconds ==========================