From 1deac2e210040acf0999d76615276a96d7af5a38 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Tue, 1 Aug 2017 20:49:07 -0300 Subject: [PATCH 1/2] Properly escape test names when setting PYTEST_CURRENT_TEST environment variable Fix #2644 --- _pytest/pytester.py | 12 ++++++++---- _pytest/runner.py | 7 ++++++- changelog/2644.bugfix | 1 + testing/acceptance_test.py | 15 ++++++++++++++- 4 files changed, 29 insertions(+), 6 deletions(-) create mode 100644 changelog/2644.bugfix diff --git a/_pytest/pytester.py b/_pytest/pytester.py index 674adca949f..263f29e88ef 100644 --- a/_pytest/pytester.py +++ b/_pytest/pytester.py @@ -381,13 +381,17 @@ def parseoutcomes(self): return d raise ValueError("Pytest terminal report not found") - def assert_outcomes(self, passed=0, skipped=0, failed=0): + def assert_outcomes(self, passed=0, skipped=0, failed=0, error=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) + obtained = { + 'passed': d.get('passed', 0), + 'skipped': d.get('skipped', 0), + 'failed': d.get('failed', 0), + 'error': d.get('error', 0), + } + assert obtained == dict(passed=passed, skipped=skipped, failed=failed, error=error) class Testdir: diff --git a/_pytest/runner.py b/_pytest/runner.py index a1daa976122..d200d1052dd 100644 --- a/_pytest/runner.py +++ b/_pytest/runner.py @@ -7,6 +7,7 @@ from time import time import py +from _pytest.compat import _ascii_escaped, _PY2 from _pytest._code.code import TerminalRepr, ExceptionInfo from _pytest.outcomes import skip, Skipped, TEST_OUTCOME @@ -134,7 +135,11 @@ def _update_current_test_var(item, when): """ var_name = 'PYTEST_CURRENT_TEST' if when: - os.environ[var_name] = '{0} ({1})'.format(item.nodeid, when) + value = _ascii_escaped('{0} ({1})'.format(item.nodeid, when)) + if _PY2: + # python 2 doesn't like null bytes on environment variables (see #2644) + value = value.replace('\x00', '(null)') + os.environ[var_name] = value else: os.environ.pop(var_name) diff --git a/changelog/2644.bugfix b/changelog/2644.bugfix new file mode 100644 index 00000000000..f70e7ec1bf8 --- /dev/null +++ b/changelog/2644.bugfix @@ -0,0 +1 @@ +Properly escape test names when setting ``PYTEST_CURRENT_TEST`` environment variable. diff --git a/testing/acceptance_test.py b/testing/acceptance_test.py index 9a75a43e5f8..71277690641 100644 --- a/testing/acceptance_test.py +++ b/testing/acceptance_test.py @@ -400,7 +400,7 @@ def test_plugins_given_as_strings(self, tmpdir, monkeypatch): monkeypatch.setitem(sys.modules, 'myplugin', mod) assert pytest.main(args=[str(tmpdir)], plugins=['myplugin']) == 0 - def test_parameterized_with_bytes_regex(self, testdir): + def test_parametrized_with_bytes_regex(self, testdir): p = testdir.makepyfile(""" import re import pytest @@ -414,6 +414,19 @@ def test_stuff(r): '*1 passed*' ]) + def test_parametrized_with_null_bytes(self, testdir): + """Test parametrization with values that contain null bytes and unicode characters (#2644)""" + p = testdir.makepyfile(u""" + # encoding: UTF-8 + import pytest + + @pytest.mark.parametrize("data", ["\\x00", u'ação']) + def test_foo(data): + assert data + """) + res = testdir.runpytest(p) + res.assert_outcomes(passed=2) + class TestInvocationVariants(object): def test_earlyinit(self, testdir): From 7703dc921ccdafb65cd32bc4b9ec4d266e2538da Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Wed, 2 Aug 2017 10:27:45 -0300 Subject: [PATCH 2/2] Only skip null bytes before setting the environment variable As discussed, node ids have already been "ascii" sanitized by the parametrization process --- _pytest/runner.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_pytest/runner.py b/_pytest/runner.py index d200d1052dd..ed58aceecf0 100644 --- a/_pytest/runner.py +++ b/_pytest/runner.py @@ -7,7 +7,7 @@ from time import time import py -from _pytest.compat import _ascii_escaped, _PY2 +from _pytest.compat import _PY2 from _pytest._code.code import TerminalRepr, ExceptionInfo from _pytest.outcomes import skip, Skipped, TEST_OUTCOME @@ -135,7 +135,7 @@ def _update_current_test_var(item, when): """ var_name = 'PYTEST_CURRENT_TEST' if when: - value = _ascii_escaped('{0} ({1})'.format(item.nodeid, when)) + value = '{0} ({1})'.format(item.nodeid, when) if _PY2: # python 2 doesn't like null bytes on environment variables (see #2644) value = value.replace('\x00', '(null)')