c1e29e90ca
+ Added SUPPORTED_LANGUAGES, a global constant dictionary of language => display pairs for languages we support. + Add Translator.get_translator, a function used to retrieve a translator after initializing it (if needed). Use `fallback=True` while creating languages, in case we setup a language that we don't have a translation for, it will noop the translation. This is particularly useful for "en," since we do not translate it, but doing this will allow us to go through our normal translation flow in any case. + Added typing. + Added get_request_language, a function that grabs the language for a request session, defaulting to aurweb.config [options] default_lang. + Added get_raw_translator_for_request, a function that retrieves the concrete translation object for a given language. + Added tr, a jinja2 contextfilter that can be used to inline translate strings in jinja2 templates. + Added `python-jinja` dep to .gitlab-ci.yml. This needs to be included in documentation before this set is merged in. + Introduce pytest units (test_l10n.py) in `test` along with __init__.py, which marks `test` as a test package. + Additionally, fix up notify.py to use the global translator. Also reduce its source width to <= 80 by newlining some code. + Additionally, prepare locale in .gitlab-ci.yml and add aurweb.config [options] localedir to config.dev with YOUR_AUR_ROOT like others. Signed-off-by: Kevin Morris <kevr@0cost.org> Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org> |
||
|---|---|---|
| .. | ||
| scripts | ||
| __init__.py | ||
| Makefile | ||
| README.md | ||
| setup.sh | ||
| sharness.sh | ||
| t1100-git-auth.t | ||
| t1200-git-serve.t | ||
| t1300-git-update.t | ||
| t2100-mkpkglists.t | ||
| t2200-tuvotereminder.t | ||
| t2300-pkgmaint.t | ||
| t2400-aurblup.t | ||
| t2500-notify.t | ||
| t2600-rendercomment.t | ||
| t2700-usermaint.t | ||
| test_exceptions.py | ||
| test_l10n.py | ||
| test_popupdate.py | ||
Running tests
To run all tests, you may run make check under test/ (alternative targets:
make pytest, make sh).
For more control, you may use the prove or pytest command, which receives a
directory or a list of files to run, and produces a report.
Each test script is standalone, so you may run them individually. Some tests may receive command-line options to help debugging. See for example sharness's documentation for shell test scripts: https://github.com/chriscool/sharness/blob/master/README.git
Dependencies
For all the test to run, the following Arch packages should be installed:
- pyalpm
- python-alembic
- python-bleach
- python-markdown
- python-pygit2
- python-sqlalchemy
- python-srcinfo
- python-coverage
- python-pytest
- python-pytest-cov
- python-pytest-asyncio
Running tests
Recommended method of running tests: make check.
First, setup the test configuration:
$ sed -r 's;YOUR_AUR_ROOT;$(pwd);g' conf/config.dev > conf/config
With those installed, one can run Python tests manually with any AUR config
specified by AUR_CONFIG:
$ AUR_CONFIG=conf/config coverage run --append /usr/bin/pytest test/
After tests are run (particularly, with coverage run included), one can
produce coverage reports.
# Print out a CLI coverage report.
$ coverage report
# Produce an HTML-based coverage report.
$ coverage html
When running make -C test, all tests ran will produce coverage data via
coverage run --append. After running make -C test, one can continue with
coverage reporting steps above. Running tests through make will test and
cover code ran by both aurweb scripts and our pytest collection.
Writing tests
Shell test scripts must follow the Test Anything Protocol specification: http://testanything.org/tap-specification.html
Python tests must be compatible with pytest and included in pytest test/
execution after setting up a configuration.
Tests must support being run from any directory. They may use $0 to determine their location. Python scripts should expect aurweb to be installed and importable without toying with os.path or PYTHONPATH.
Tests written in shell should use sharness. In general, new tests should be consistent with existing tests unless they have a good reason not to.
Debugging tests
By default, make -C test is quiet and does not print out verbose information
about tests being run. If a test is failing, one can look into verbose details
of sharness tests by executing them with the --verbose flag. Example:
./t1100_git_auth.t --verbose. This is particularly useful when tests happen
to fail in a remote continuous integration environment, where the reader does
not have complete access to the runner.