Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

testing_pytest_docs #2099

Merged
merged 10 commits into from Feb 18, 2020
Merged

testing_pytest_docs #2099

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c48ae83
Update testing instructions to use pytest directly
will-moore Jan 22, 2020
bd1a036
Update omero/developers/testing.rst
will-moore Jan 22, 2020
7addc14
Update omero/developers/testing.rst
will-moore Jan 23, 2020
28bf554
Mention venv, cd OmeroPy, fix setup.py -> pytest
will-moore Jan 23, 2020
a91746b
Mention OmeroWeb tests
will-moore Jan 23, 2020
05b8f36
Fix OmeroWeb typo
will-moore Jan 24, 2020
2c2dfad
Remove outdated -t flag
will-moore Feb 14, 2020
27adfe7
Mention omero-web and pytables deps
will-moore Feb 14, 2020
f582c04
Mention setting of OMERODIR
will-moore Feb 14, 2020
2317a37
the installation of
will-moore Feb 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
76 changes: 33 additions & 43 deletions omero/developers/testing.rst
View file
Open in desktop
Expand Up @@ -275,89 +275,79 @@ Running tests directly
""""""""""""""""""""""

When writing tests it can be more convenient, flexible and powerful to run the
tests from :sourcedir:`components/tools/OmeroPy` using
:program:`setup.py test`.
tests from :sourcedir:`components/tools/OmeroPy` or
:sourcedir:`components/tools/OmeroWeb` using :program:`pytest`.
Since Python is interpreted, tests can be written and then run without having
will-moore marked this conversation as resolved.
Show resolved Hide resolved
to rebuild or restart the server. A few basic options are shown below.

.. program:: setup.py test
First create a python virtual environment
as described on the :doc:`OMERO Python </developers/Python>` page,
including ``omero-py`` and ``omero-web`` if you want to run OmeroWeb tests.
Some tests also require the installation of PyTables.

will-moore marked this conversation as resolved.
Show resolved Hide resolved
.. option:: -t <test_path>, --test-path <test_path>
Then install some additional test dependencies::

This option specifies the test suite to run. For instance to run a single
test file::
$ pip install pytest mox3 pyyaml tables

cd components/tools/OmeroPy
./setup.py test -t test/integration/test_admin.py
# for Omeroweb tests
$ pip install pytest-django

Or to run all tests under a given folder::
Run tests directly with pytest, setting the :envvar:`ICE_CONFIG` as described above.
Also set :envvar:`OMERODIR` to point to the OMERO.server::

cd components/tools/OmeroPy
./setup.py test -t test/integration/clitest
export ICE_CONFIG=/path/to/openmicroscopy/etc/ice.config
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something's gone wrong with the formatting, this doesn't appear as a code block:

Screen Shot 2020-01-23 at 11 24 25

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also there's another ice.config under OmeroPy? I thought the tests automatically use this without needing to set ICE_CONFIG?

etc/ice.config
components/tools/OmeroPy/ice.config

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may have been lost from the migration away from omero_setup.py. If so, we can add it back in, but it should be in the most pytest-y way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tried to run a test without setting the Ice_CONFIG
the ice.config under OmeroPy did not get picked up.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Formatting looks OK to me at https://merge-ci.openmicroscopy.org/jenkins/job/OMERO-docs/lastSuccessfulBuild/artifact/omero/_build/html/developers/testing.html#running-tests-directly and it seems we do need to set ICE_CONFIG so I'll leave it as it is.

export OMERODIR=/path/to/OMERO.server-x.x.x-ice36-bxx

cd components/tools/OmeroPy

# OR for OmeroWeb tests:
cd components/tools/OmeroWeb

pytest test/integration/test_admin.py
will-moore marked this conversation as resolved.
Show resolved Hide resolved

.. program:: pytest

.. option:: -k <string>

This option will run all integration tests containing the given string in
their names. For example, to run all the tests under
:file:`test/integration` with `permissions` in their names::

./setup.py test -t test/integration -k permissions
pytest test/integration -k permissions

This option can also be used to run a named test within a test module::

./setup.py test -t test/integration/test_admin.py -k testGetGroup
pytest test/integration/test_admin.py -k testGetGroup

.. option:: -m <marker>

This option will run integration tests depending on the markers they are
decorated with. Available markers can be listed using the
:option:`setup.py test --markers` option.
:option:`pytest --markers` option.
For example, to run all integration tests excluding those decorated with
the marker `broken`::

./setup.py test -t test/integration -m "not broken"
pytest test/integration -m "not broken"

.. option:: --markers

This option lists available markers for decorating tests::

./setup.py test --markers
pytest --markers

.. option:: -s

This option allows the standard output to be shown on the console::

./setup.py test -t test/integration/test_admin.py -s
pytest test/integration/test_admin.py -s

.. option:: -h, --help

This option displays the full list of available options::

./setup.py test -h

To make use of the more advanced options available in `pytest` that are not
accessible using :program:`setup.py test`, the :program:`py.test` script can
be used directly. To use this :envvar:`PYTHONPATH` must contain the path to
the OMERO Python libraries, see |BlitzGateway| as well as the path to the
:py_sourcedir:`OMERO Python test library <src/omero/testlib>`.
Alternatively, the `pytest` plugin :pypi:`pytest-pythonpath` can be used to
add paths to :envvar:`PYTHONPATH` specifically for `pytest`.

.. program:: py.test

.. option:: --repeat <number>

This option allows to repeat tests for *number* occurences::

py.test --repeat 20 test/unit/fstest

.. option:: -h, --help

This option displays the full list of options::

py.test --help
pytest -h

and `<https://pytest.org/en/latest/usage.html>`_ for more help in
See `<https://pytest.org/en/latest/usage.html>`_ for more help in
running tests.

Failing tests
Expand Down Expand Up @@ -488,8 +478,8 @@ markers can be simply defined as they are used. However, to centralize the use
of custom markers they should be defined in
:sourcedir:`components/tools/pytest.ini`.

To view all available markers the :option:`setup.py test --markers` option can
be used with :program:`setup.py test` or :program:`py.test` as detailed in
To view all available markers the :option:`pytest --markers` option can
be used with :program:`pytest` or :program:`py.test` as detailed in
:ref:`running-python-tests-directly`.

There is one custom marker defined:
Expand Down