Skip to content

HACKING.rst: add pytest.param pytest gotcha #481

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

Merged
OddBloke merged 4 commits into from
Jul 13, 2020
Merged

HACKING.rst: add pytest.param pytest gotcha #481

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
21245a8
HACKING.rst: add pytest.param pytest gotcha
OddBloke Jul 6, 2020
bdcfc04
HACKING.rst: apply falcojr's suggested improvement
OddBloke Jul 8, 2020
8289fe0
Add another possible pytest.param workaround
OddBloke Jul 8, 2020
df0b372
Merge branch 'master' into doc
OddBloke Jul 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions HACKING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,14 @@ The following guidelines should be followed:
``util.write_file(tmpdir.join("some_file"), ...)``, you should
write ``util.write_file(tmpdir.join("some_file").strpath, ...)``.

* The `pytest.param`_ function cannot be used. It was introduced in
pytest 3.1, which means it is not available on xenial. The more
limited mechanism it replaced was removed in pytest 4.0, so is not
available in focal or later. The only available alternatives are
to write mark-requiring test instances as completely separate
tests, without utilising parameterisation, or to apply the mark to
the entire parameterized test (and therefore every test instance).

* Variables/parameter names for ``Mock`` or ``MagicMock`` instances
should start with ``m_`` to clearly distinguish them from non-mock
variables
Expand Down Expand Up @@ -302,6 +310,7 @@ The following guidelines should be followed:
.. _TestPrependBaseCommands: https://github.com/canonical/cloud-init/blob/master/cloudinit/tests/test_subp.py#L9
.. _assertion introspection: https://docs.pytest.org/en/latest/assert.html
.. _pytest 3.0: https://docs.pytest.org/en/latest/changelog.html#id1093
.. _pytest.param: https://docs.pytest.org/en/latest/reference.html#pytest-param
.. _autospecced: https://docs.python.org/3.8/library/unittest.mock.html#autospeccing

Type Annotations
Expand Down