tox.ini

[tox]
min_version = 4
envlist = trainingdata, py, bandit, ruff_reformat, ruff_check, inference_CI, inference_multi_CI #, mypy, ruff_checkformat, prospector
skip_missing_interpreters = true


[testenv]; This is called py in envlist
description = Run pytest, coverage.
deps =
    coverage
    pytest
    anemoi-datasets @ git+https://github.com/metno/anemoi-datasets.git@13397aa
    anemoi-models @ git+https://github.com/metno/anemoi-models.git@80c9fbf
allowlist_externals =
    ln
commands_pre =
    # Link training data
    ln -sf {toxworkdir}/bris_random_data.zarr {envtmpdir}/
commands =
    coverage run --source=bris -m pytest
    coverage report --omit='.tox/*'
parallel_show_output = true


[testenv:trainingdata]
description = Download synthetic data for use in other tests. Will download 80 MB from github. Result is placed in .tox/bris_random_data.zarr
; override default:
deps =
skip_install = true
change_dir = {envtmpdir}
allowlist_externals =
    cp
    wget
    unzip
; override default:
commands_pre =
commands =
    # Copy already downloaded data to the temp directory, if they exist.
    - cp {toxworkdir}/main.zip {envtmpdir}/
    # Download the data from github, if needed.
    wget --no-clobber https://github.com/metno/bris-test-data/archive/refs/heads/main.zip
    # Store downloaded data, so we don't have to download it again next run.
    cp -af {envtmpdir}/main.zip {toxworkdir}/main.zip
    # Unpack and move data to correct location.
    unzip -qq {envtmpdir}/main.zip -d {envtmpdir}/
    cp -af {envtmpdir}/bris-test-data-main/bris_random_data.zarr {toxworkdir}/


[testenv:bandit]
description = Check for security issues (ignoring asserts for now).
deps =
    bandit[toml]
skip_install = true
; override default:
commands_pre =

commands = bandit --recursive --configfile pyproject.toml --exclude data bris

[testenv:ruff_checkformat]
description = Run ruff format and complain, without changing anything.
deps = ruff
skip_install = true
; override default:
commands_pre =
commands = ruff format --config pyproject.toml --check --diff
parallel_show_output = true


[testenv:ruff_reformat]
description = Reformat code with ruff format (similar to black).
deps = ruff
skip_install = true
; override default:
commands_pre =
commands = ruff format --config pyproject.toml


[testenv:ruff_check]
description = Run ruff check, a linter. Auto-fix only isort, see pyproject.toml.
deps = ruff
skip_install = true
; override default:
commands_pre =
commands = ruff check --config pyproject.toml --fix --exit-non-zero-on-fix


[testenv:inference]
description = Run inference on data from "trainingdata". Requires 'tox -e trainingdata' to have run successfully. Result end up in .tox/inference/tmp/. No usable data is generated.
; override default:
deps =
    anemoi-datasets @ git+https://github.com/metno/anemoi-datasets.git@13397aa
    anemoi-models @ git+https://github.com/metno/anemoi-models.git@80c9fbf
depends =
    trainingdata
    training
change_dir = {envtmpdir}
allowlist_externals =
    cp
    ln
    find
commands_pre =
    # Copy config file to temp directory.
    cp -vf {toxinidir}/config/tox_test_inference.yaml {envtmpdir}/
    # Find and copy checkpont from training to temp directory. There may be more than one, but that won't matter.
    find {envtmpdir}/../../training/tmp/training-output/checkpoint -name inference-last.ckpt -exec cp -vf '{}' {envtmpdir}/ \;
    # Link data from other tox environment.
    ln -sf {toxworkdir}/bris_random_data.zarr {envtmpdir}/
commands = bris --config tox_test_inference.yaml
; Make sure output was created
commands_post =
    find ./tox_test_inference.nc

[testenv:inference_CI]
description = Run inference using checkpoint from "trainingdata". Only for CI testing.
; override default:
deps =
depends = trainingdata
change_dir = {envtmpdir}
allowlist_externals =
    cp
    ln
    find
commands_pre =
    # Copy config file to temp directory.
    cp -vf {toxinidir}/config/tox_test_inference.yaml {envtmpdir}/

    # Copy checkpont from tests directory.
    cp -vf ../../../tests/files/checkpoint.ckpt {envtmpdir}/inference-last.ckpt

    # Link data from other tox environment.
    ln -sf {toxworkdir}/bris_random_data.zarr {envtmpdir}/
    pip install anemoi-models==0.4.2 # Override anemoi-models to match train environment
commands = bris --config tox_test_inference.yaml
commands_post =
    ; Make sure output was created, and delete it.
    find ./tox_test_inference.nc -delete


[testenv:inference_multi_CI]
description = Run inference with MultiEncDecPredictor. Only for CI testing.
deps =
    anemoi-datasets @ git+https://github.com/metno/anemoi-datasets.git@13397aa
    anemoi-models @ git+https://github.com/metno/anemoi-models.git@80c9fbf
; @ git+https://github.com/metno/anemoi-models.git
depends = trainingdata
change_dir = {envtmpdir}
allowlist_externals =
    cp
    ln
    find
commands_pre =
    # Copy config file to temp directory.
    cp -vf {toxinidir}/config/tox_test_inference_multi.yaml {envtmpdir}/

    # Copy checkpont from tests directory.
    cp ../../../tests/files/multiencdec.ckpt {envtmpdir}/inference-multi.ckpt

    # Link data from other tox environment.
    ln -sf {toxworkdir}/bris_random_data.zarr {envtmpdir}/
commands = bris --config tox_test_inference_multi.yaml
commands_post =
    ; Make sure output was created, and delete it.
    find ./tox_test_inference.nc ./tox_test_inference_dec1.nc -delete


[testenv:prospector]
description = Run static analysis using prospector, dont fail on errors.
ignore_outcome = true
deps = prospector
; override default:
commands_pre =
commands = prospector --no-autodetect \
            --test-warnings \
            --die-on-tool-error \
            {toxinidir}/bris


[testenv:mypy]
description = Check typing with mypy, dont fail on errors.
ignore_outcome = true
deps =
    mypy
    types-PyYAML
skip_install = false # Otherwise mypy will check outdated code
; override default:
commands_pre =
commands = mypy --config-file pyproject.toml bris


[testenv:training]
description = Run a test training on synthetic data. Slow! Will take about 5 minutes. Result end up in .tox/training/tmp/training-output.
depends = trainingdata
deps =
    anemoi-training==0.3.3
    anemoi-graphs==0.4.4
    anemoi-models==0.4.1
skip_install = true
set_env = ANEMOI_BASE_SEED=1234
change_dir = {envtmpdir}
allowlist_externals =
    cp
    ln
commands_pre =
    # Copy config file to the temp directory.
    cp -vf {toxinidir}/config/tox_test_train.yaml {envtmpdir}/
    # Link training data
    ln -sf {toxworkdir}/bris_random_data.zarr {envtmpdir}/
commands = anemoi-training train --config-name tox_test_train