pyproject.toml

# Copyright 2024 Canonical Ltd.
# See LICENSE file for licensing details.

[tool.bandit]
exclude_dirs = ["/venv/"]
[tool.bandit.assert_used]
skips = ["*/*test.py", "*/test_*.py", "*tests/*.py"]

# Testing tools configuration
[tool.coverage.run]
branch = true
omit = [
    # These are covered by `tests/integration/test_runner_manager_openstack.py`.
    "src/openstack_cloud/openstack_cloud.py",
    "src/openstack_cloud/openstack_runner_manager.py",
    # Contains interface for calling LXD. Tested in integration tests and end to end tests.
    "src/lxd.py",
    # Contains interface for calling repo policy compliance service. Tested in integration test
    # and end to end tests.
    "src/repo_policy_compliance_client.py",
    # TODO: 2024-04-17: These files are pending a major refactor. The refactor includes a RunnerManager
    # interface class which will include a complete re-organization of the code in these files.
    "src/runner.py",
    "src/runner_manager.py",
]

[tool.coverage.report]
fail_under = 83
show_missing = true

[tool.pytest.ini_options]
minversion = "6.0"
log_cli_level = "INFO"
markers = [
    "openstack: mark a test as applicable for openstack cloud",
]

[tool.pylint.'MESSAGES CONTROL']
# see https://github.com/pydantic/pydantic/issues/1961#issuecomment-759522422
extension-pkg-whitelist = "pydantic"
# Ignore W0511 TODO comments because the functions are subject to refactor.
disable = "W0511"

# Formatting tools configuration
[tool.black]
line-length = 99
target-version = ["py310"]

[tool.isort]
line_length = 99
profile = "black"

# Linting tools configuration
[tool.flake8]
max-line-length = 99
max-doc-length = 99
max-complexity = 10
exclude = [".git", "__pycache__", ".tox", "build", "dist", "*.egg_info", "venv"]
select = ["E", "W", "F", "C", "N", "R", "D", "H"]
# Ignore W503, E501, E203 because using black creates errors with this
# Ignore D107 Missing docstring in __init__
ignore = ["W503", "E501", "D107", "E203"]
# D100, D101, D102, D103, D104: Ignore docstring style issues in tests
# temporary disable E402 for the fix in charm.py for lp:2058335
per-file-ignores = ["src/charm.py:E402", "tests/*:D100,D101,D102,D103,D104,D205,D212"]
docstring-convention = "google"
# Check for properly formatted copyright header in each file
copyright-check = "True"
copyright-author = "Canonical Ltd."
copyright-regexp = "Copyright\\s\\d{4}([-,]\\d{4})*\\s+%(author)s"

[tool.mypy]
check_untyped_defs = true
disallow_untyped_defs = true
explicit_package_bases = true
ignore_missing_imports = true
namespace_packages = true

[[tool.mypy.overrides]]
module = "tests.*"
disallow_untyped_defs = false