tasks.py

from invoke import Collection, task

PACKAGE_DIR = "pyadr"


#################################################################
# setting up dev env
#################################################################


@task
def setup_dev_host(context):
    """
    Setup host dev requirements
    """
    context.run("./scripts/install_pyenv.sh")
    context.run("./scripts/install_poetry.sh")
    print(
        "Host setup correctly. "
        "Restart your shell or source your shell config file to be up and running :)"
    )


@task
def setup_pre_commit_hooks(context):
    """
    Setup pre-commit hooks
    """
    context.run("pre-commit install --hook-type pre-commit")


@task
def setup_release_tools(context):
    """
    Setup release tools (semantic-release)
    """
    context.run('npm install -g semantic-release@"^17.0.4"')
    context.run('npm install -g @semantic-release/changelog@"^5.0.1"')
    context.run('npm install -g @semantic-release/exec@"^5.0.0"')
    context.run('npm install -g @semantic-release/git@"^9.0.0"')
    context.run('npm install -g @semantic-release/github@"^7.0.5"')


#################################################################
# setting up ci-cd env
#################################################################


@task
def setup_cicd_common(context):
    context.run("pip install --upgrade pip")


@task(setup_cicd_common)
def setup_cicd_test_stage(context):
    context.run("git config --global user.name 'Foo Bar'")
    context.run("git config --global user.email 'foo@bar.com'")


@task(setup_cicd_common)
def setup_cicd_release_stage(context):
    pass


@task(setup_cicd_common)
def setup_cicd_publish_stage(context):
    pass


#################################################################
# cleaning
#################################################################


@task
def clean_build(context):
    """
    Remove build artifacts
    """
    context.run("rm -fr build/")
    context.run("rm -fr dist/")
    context.run("rm -fr .eggs/")
    context.run("find . -name '*.egg-info' -exec rm -fr {} +")
    context.run("find . -name '*.egg' -exec rm -f {} +")


@task
def clean_pyc(context):
    """
    Remove Python artifacts
    """
    context.run("find . -name '*.pyc' -exec rm -f {} +")
    context.run("find . -name '*.pyo' -exec rm -f {} +")
    context.run("find . -name '*~' -exec rm -f {} +")
    context.run("find . -name '__pycache__' -exec rm -fr {} +")
    context.run("find . -name '.pytest_cache' -exec rm -fr {} +")


@task
def clean_test(context):
    """
    Remove test and coverage artifacts
    """
    context.run("rm -fr .tox/")
    context.run("rm -f .coverage")
    context.run("rm -fr htmlcov/")


@task(clean_build, clean_pyc, clean_test)
def clean(context):
    """
    Remove all build, test, coverage and Python artifacts
    """
    pass


@task
def clean_venv(context):
    """
    Remove virtual environment
    """
    # poetry env remove might not to work if `virtualenvs.in-project = true`
    # (see https://github.com/python-poetry/poetry/issues/2124)
    # so if not, remove whole `.venv` directory using https://unix.stackexchange.com/questions/153763  # noqa
    context.run(
        "poetry env remove $$(poetry env info -p)/bin/python && ([ $$? -eq 0 ]) "
        "|| rm -rf $$(poetry env info -p)"
    )


#################################################################
# all tests and checks
#################################################################


@task
def tox(context):
    """
    Run tox default targets, usually all tests and BDD tests (see tox.ini)
    """
    context.run("poetry run tox")


@task()
def tox_p(context):
    """
    Same as 'tox', but with parallel runs
    """
    context.run("poetry run tox -p auto")


#################################################################
# repl
#################################################################


@task
def repl(context):
    """
    Run the repl tool (bpython in our case)
    """
    context.run("poetry run bpython")


#################################################################
# linting
#################################################################


@task
def lint(context):
    """
    Check style with flake8
    """
    context.run(f"poetry run flake8 {PACKAGE_DIR} tests features")


#################################################################
# formatting
#################################################################


@task
def isort(context):
    context.run(f"poetry run isort --profile black {PACKAGE_DIR} tests features")


@task
def black(context):
    context.run(f"poetry run black {PACKAGE_DIR} tests features")


@task(isort, black)
def format(context):
    """
    Enforce correct format with isort and black
    """
    pass


@task
def format_check(context):
    """
    Check format for compliance with black and isort
    """
    context.run(f"poetry run isort -c --profile black {PACKAGE_DIR} tests features")
    context.run(f"poetry run black --check {PACKAGE_DIR} tests features")


#################################################################
# typing
#################################################################


@task
def type(context):
    context.run(f"poetry run mypy -p {PACKAGE_DIR} -p tests")


#################################################################
# unit testing
#################################################################


@task
def test(context):
    """
    Run unit tests
    """
    context.run(
        "poetry run pytest "
        f"--cov={PACKAGE_DIR} "
        "--cov-report=html "
        "--cov-report=term tests"
    )


@task(aliases=["tox-test-default-version", "tox-py"])
def tox_test(context):
    """
    Run unit tests with the default Python
    """
    context.run("poetry run tox -e py")


@task(aliases=["tox-py311"])
def tox_test_py311(context):
    """
    Run unit tests with Python 3.11
    """
    context.run("poetry run tox -e py311")


@task(aliases=["tox-py310"])
def tox_test_py310(context):
    """
    Run unit tests with Python 3.10
    """
    context.run("poetry run tox -e py310")


@task(aliases=["tox-py39"])
def tox_test_py39(context):
    """
    Run unit tests with Python 3.9
    """
    context.run("poetry run tox -e py39")


@task(aliases=["tox-py38"])
def tox_test_py38(context):
    """
    Run unit tests with Python 3.8
    """
    context.run("poetry run tox -e py38")


@task(aliases=["tox-test-all-versions"])
def tox_test_all(context):
    """
    Run unit tests on each Python version declared
    """
    context.run("poetry run tox -e py311,py310,py39,py38,py37")


#################################################################
# acceptance testing / bdd
#################################################################


@task
def bdd(context):
    """
    Run bdd tests
    """
    context.run("poetry run behave features  --format=pretty --tags=~wip --tags=~skip")


@task(aliases=["tox_bdd_default-version"])
def tox_bdd(context):
    """
    Run bdd tests with the default Python
    """
    context.run("poetry run tox -e bdd")


@task
def tox_bdd_py311(context):
    """
    Run bdd tests with Python 3.11
    """
    context.run("poetry run tox -e bdd-py311")


@task
def tox_bdd_py310(context):
    """
    Run bdd tests with Python 3.10
    """
    context.run("poetry run tox -e bdd-py310")


@task
def tox_bdd_py39(context):
    """
    Run bdd tests with Python 3.9
    """
    context.run("poetry run tox -e bdd-py39")


@task
def tox_bdd_py38(context):
    """
    Run bdd tests with Python 3.8
    """
    context.run("poetry run tox -e bdd-py38")


@task(aliases=["tox-bdd-all-versions"])
def tox_bdd_all(context):
    """
    Run bdd tests on every Python version declared
    """
    context.run("poetry run tox -e bdd-py311,bdd-py310,bdd-py39,bdd-py38")


#################################################################
# releasing (full cycle)
#################################################################


@task
def cicd_release(context):
    """
    Launch the release process and release a new version if required
    """
    context.run("npx semantic-release")


@task(clean)
def publish(context):
    context.run("poetry run python scripts/verify_pypi_env_variables.py")
    context.run(
        '[ -z $$PYPI_REPOSITORY_NAME ] || repo_arg="-r $$PYPI_REPOSITORY_NAME" '
        "&& poetry publish --build $$repo_arg"
    )


#################################################################
# git targets
#################################################################


@task
def prune_branches(context):
    """
    Prune obsolete local tracking branches and local branches
    """
    context.run("git remote prune origin")
    context.run(
        "git branch -vv | "
        "grep ': gone]'| "
        "grep -v '\\*' | "
        "awk '{ print $1; }' | "
        "xargs git branch -d"
    )


@task(aliases=["pbf"])
def prune_branches_force(context):
    """
    Same as prune-branches but force delete local branches
    """
    context.run("git remote prune origin")
    context.run(
        "git branch -vv | "
        "grep ': gone]'| "
        "grep -v '\\*' | "
        "awk '{ print $1; }' | "
        "xargs git branch -D"
    )


@task(post=[prune_branches_force], aliases=["pms"])
def post_pr_merge_sync(context):
    """
    Switch to main, pull and run prune-branches-force task
    """
    context.run("git switch main")
    context.run("git pull")


#################################################################
# Run all local tests and checks
#################################################################


@task(format, lint)
def all_checks(context):
    """
    Run all checks
    """
    pass


@task(test, bdd, all_checks)
def all_locals(context):
    """
    Run all local tests and checks
    """
    pass


#################################################################
# Tasks organization in namespaces
#################################################################


namespace = Collection()

namespace_dev_env_setup = Collection("dev_env_setup")
namespace_dev_env_setup.add_task(setup_dev_host)
namespace_dev_env_setup.add_task(setup_pre_commit_hooks)
namespace_dev_env_setup.add_task(setup_release_tools)

namespace_cicd_setup = Collection("cicd_setup")
namespace_cicd_setup.add_task(setup_cicd_test_stage, "setup_test_stage")
namespace_cicd_setup.add_task(setup_cicd_release_stage, "setup_release_stage")
namespace_cicd_setup.add_task(setup_cicd_publish_stage, "setup_publish_stage")

namespace_tox = Collection("tox_")
namespace_tox.add_task(tox_test, name="test")
namespace_tox.add_task(tox_test_all, name="test_all")
namespace_tox.add_task(tox_test_py311, name="test_py311")
namespace_tox.add_task(tox_test_py310, name="test_py310")
namespace_tox.add_task(tox_test_py39, name="test_py39")
namespace_tox.add_task(tox_test_py38, name="test_py38")
namespace_tox.add_task(tox_bdd, name="bdd")
namespace_tox.add_task(tox_bdd_all, name="bdd_all")
namespace_tox.add_task(tox_bdd_py311, name="bdd_py311")
namespace_tox.add_task(tox_bdd_py310, name="bdd_py310")
namespace_tox.add_task(tox_bdd_py39, name="bdd_py39")
namespace_tox.add_task(tox_bdd_py38, name="bdd_py38")

namespace_cicd = Collection("cicd")
namespace_cicd.add_task(cicd_release, name="release")

namespace_git = Collection("git")
namespace_git.add_task(prune_branches)
namespace_git.add_task(prune_branches_force)
namespace_git.add_task(post_pr_merge_sync)

namespace.add_collection(namespace_dev_env_setup)
namespace.add_collection(namespace_cicd_setup)
namespace.add_collection(namespace_cicd)
namespace.add_collection(namespace_tox)
namespace.add_collection(namespace_git)

namespace.add_task(clean)
namespace.add_task(clean_venv)
namespace.add_task(all_checks)
namespace.add_task(all_locals)
namespace.add_task(test)
namespace.add_task(bdd)
namespace.add_task(isort)
namespace.add_task(black)
namespace.add_task(format)
namespace.add_task(format_check)
namespace.add_task(lint)
namespace.add_task(type)
namespace.add_task(repl)
namespace.add_task(tox)
namespace.add_task(tox_p)