tox.ini

[tox]
minversion = 3.21
# relies on the correct version of Python installed
envlist = ruff,tests-core,tests-all,mypy-core,mypy-misc
# NOTE: we don't run end2end by default since it requires elaborate setup
# https://github.com/tox-dev/tox/issues/20#issuecomment-247788333
# hack to prevent .tox from crapping to the project directory
toxworkdir = {env:TOXWORKDIR_BASE:}{toxinidir}/.tox

[testenv]
# TODO how to get package name from setuptools?
package_name = "promnesia"
passenv =
# useful for tests to know they are running under ci
    CI
    CI_*
# respect user's cache dirs to prevent tox from crapping into project dir
    PYTHONPYCACHEPREFIX
    MYPY_CACHE_DIR
    RUFF_CACHE_DIR
#
    MY_CONFIG
    # by default we don't run browser tests to avoid confusing people when they run locally
    # but we want them on CI, so we allow to pass through the variable when we do want to run them
    WITH_BROWSER_TESTS
    # todo ugh this is all so confusing... need to simplify
usedevelop = true  # for some reason tox seems to ignore "-e ." in deps section??
uv_seed = true  # seems necessary so uv creates separate venvs per tox env?
setenv =
    HPI_MODULE_INSTALL_USE_UV=true


[testenv:ruff]
dependency_groups = testing
commands =
    {envpython} -m ruff check src/


# just the very core tests with minimal dependencies
[testenv:tests-core]
dependency_groups = testing
deps =
    -e .[markdown]
    # NOTE: markdown is only used for test_cli... might be nice to decouple
commands =
    # posargs allow test filtering, e.g. tox ... -- -k test_name
    {envpython} -m pytest \
        --pyargs {[testenv]package_name}     \
        # note: sources are tested in tests-all
        --ignore src/promnesia/sources       \
        --ignore src/promnesia/tests/sources \
        {posargs}


[testenv:tests-all]
dependency_groups = testing
deps =
    -e .[all,HPI,org]
    beautifulsoup4<4.13.0  # FIXME temporary hack until https://github.com/purarue/google_takeout_parser/pull/81 is merged
    uv  # for hpi module install
commands =
    # used in some tests
    {envpython} -m my.core module install \
        my.google.takeout.parser \
        my.hypothesis
    {envpython} -m pytest \
        --pyargs {[testenv]package_name}     \
        {posargs}


[testenv:end2end]
setenv =
    WITH_BROWSER_TESTS=true
    PYTEST_TIMEOUT=120
dependency_groups =
    testing
    testing-end2end
deps =
    -e .[HPI]
    uv  # for hpi module install
commands =
    {envpython} -m my.core module install my.hypothesis
    {envpython} -m pytest     \
        # TODO noconftest is hack due to end2end tests being in a separate dir
        # ideally need to just move it inside the package as well
        --noconftest          \
        tests/end2end_test.py \
        {posargs}


[testenv:mypy-core]
dependency_groups = testing
commands =
    {envpython} -m mypy --no-install-types \
        # note: sources are tested separately, below
        -p {[testenv]package_name} --exclude 'sources/*' \
        # txt report is a bit more convenient to view on CI
        --txt-report  .coverage.mypy-core  \
        --html-report .coverage.mypy-core  \
        {posargs}


[testenv:mypy-misc]
dependency_groups = testing
deps =
    -e .[HPI,org,markdown]  # todo install from HPI[all] or something?
    beautifulsoup4<4.13.0  # FIXME temporary hack until https://github.com/purarue/google_takeout_parser/pull/81 is merged
    uv  # for hpi module install
commands =
    {envpython} -m my.core module install \
        my.github.ghexport                \
        my.hypothesis                     \
        my.instapaper                     \
        my.pocket                         \
        my.reddit                         \
        my.fbmessenger                    \
        my.google.takeout.parser          \
        my.browser.export

    {envpython} -m mypy --no-install-types \
        -p {[testenv]package_name}.sources \
        # txt report is a bit more convenient to view on CI
        --txt-report  .coverage.mypy-misc \
        --html-report .coverage.mypy-misc \
        {posargs}

    # ugh. a bit crap to run it separately
    # but first will need to move tests inside the package if we want otherwise?
    # and I recall it was problematic at times..
    {envpython} -m mypy --no-install-types \
                   tests --exclude 'testdata/*' \
                   {posargs}