Mercurial > kallithea
view conftest.py @ 8769:d35d14b05b82
diff: handle some escaped characters in Git diffs
There are some odd characters (like \r and \n) that the Kallithea UI doesn't
allow in filenames in repos. Kallithea (through the routes module) will fail to
generate URLs when browsing Files. That is a known limitation with minimal
real-world impact, non-trivial to work around or fix.
There are very few relevant use cases for tracking files with odd filenames. \t
is valid but is hard to render in a meaningful way in the UI. And ASCII
characters like \ and " are not usable on Windows and should just be avoided.
Kallithea would parse Git diffs with odd characers incorrectly or fail, even
before hitting the known limitation. With this change, Kallithea will parse
diffs with odd filenames correctly (and then hit the limitation).
Git will quote odd filenames and escape the odd characters when emitting diffs.
(Mercurial does by design not allow \r and \n , and Mercurial will thus never
have to quote file names in diffs.)
Quotes are already handled (and ignored). With this change, Kallithea will
handle \ unescaping of \\ and \", the usual letters like \r and \n and \t, and
octal numbers like \033 (for ESC) .
Filenames with \ and " will work perfectly (when not on Windows).
Filenames with \t and ESC will work fine, but without helpful display in the
UI.
Filenames with \r and \n will still make the UI fail when trying to generate
URLs.
Thanks to stypr of Flatt Security for raising this.
author | Mads Kiilerich <mads@kiilerich.com> |
---|---|
date | Sat, 14 Nov 2020 15:41:39 +0100 |
parents | 9948ed9916c4 |
children |
line wrap: on
line source
import os import mock import pytest import tg here = os.path.dirname(__file__) # HACK: def pytest_configure(): # Register global dummy tg.context to avoid "TypeError: No object (name: context) has been registered for this thread" tg.request_local.context._push_object(tg.util.bunch.Bunch()) # could be removed again after use with # tg.request_local.context._pop_object ... but we keep it around forever as # a reasonable sentinel def pytest_ignore_collect(path): # ignore all files outside the 'kallithea' directory if not str(path).startswith(os.path.join(here, 'kallithea')): return True # during doctest verification, normally all python files will be imported. # Thus, files that cannot be imported normally should be ignored. # Files that generate ImportErrors are ignored via # '--doctest-ignore-import-errors' (pytest.ini) kallithea_ignore_paths = ( # AttributeError: 'module' object has no attribute 'config' '/kallithea/alembic/env.py', # collection of the following file messes up the rest of test execution '/kallithea/tests/scripts/manual_test_concurrency.py', ) if str(path).endswith(kallithea_ignore_paths): return True @pytest.fixture() def doctest_mock_ugettext(request): """Mock ugettext ('_') in the module using this fixture. Intended to be used for doctests. In a doctest, enable this fixture using: >>> getfixture('doctest_mock_ugettext') """ m = __import__(request.module.__name__, globals(), locals(), [None], 0) with mock.patch.object(m, '_', lambda s: s): yield if getattr(pytest, 'register_assert_rewrite', None): # make sure that all asserts under kallithea/tests benefit from advanced # assert reporting with pytest-3.0.0+, including api/api_base.py, # models/common.py etc. # See also: https://docs.pytest.org/en/latest/assert.html#advanced-assertion-introspection pytest.register_assert_rewrite('kallithea.tests')