pyproject.toml

[tool.poetry]
name = "infrahub"
version = "1.0.0-dev0"
description = "Infrahub is taking a new approach to Infrastructure Management by providing a new generation of datastore to organize and control all the data that defines how an infrastructure should run."
authors = ["OpsMill <info@opsmill.com>"]
readme = "README.md"
license = "AGPL-3.0-only"
homepage = "https://opsmill.com"
repository = "https://github.com/opsmill/infrahub"
documentation = "https://docs.infrahub.app/"
classifiers = [
    "Intended Audience :: Developers",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
]

packages = [{ include = "infrahub", from = "backend" }]


[tool.poetry.group.test-scale]
optional = true

[tool.poetry.dependencies]
python = "^3.10, < 3.13"
neo4j = "~5.24"
neo4j-rust-ext = "^5.24.0.0"
infrahub-sdk = { path = "python_sdk", extras = [
    "ctl",
    "tests",
], develop = true }
pydantic = "2.7.2"
pydantic-settings = "~2.2"
pytest = "~7.4"
aio-pika = "~9.4"
structlog = "24.1.0"
boto3 = "1.34.129"
email-validator = "~2.1"
redis = { version = "^5.0.0", extras = ["hiredis"] }
typer = "0.12.3"
prefect = "3.0.1"

# Dependencies specific to the API Server
fastapi = "~0.112"
fastapi-storages = "~0.3"
graphene = "~3.3"
gunicorn = "^22.0.0"
lunr = "^0.7.0.post1"
starlette-exporter = "~0.23"
python-multipart = "0.0.9"                             # Required by FastAPI to upload large files
asgi-correlation-id = "4.2.0"                          # Middleware for FastAPI to generate ID per request
bcrypt = "~4.1"                                        # Used to hash and validate password
pyjwt = "~2.8"                                         # Used to manage JWT tokens
uvicorn = { version = "~0.30", extras = ["standard"] }
opentelemetry-instrumentation-aio-pika = "^0.45b0"
opentelemetry-instrumentation-fastapi = "^0.45b0"
opentelemetry-exporter-otlp-proto-grpc = "^1.24.0"
opentelemetry-exporter-otlp-proto-http = "^1.24.0"
nats-py = "^2.7.2"
netaddr = "1.3.0"

[tool.poetry.group.dev.dependencies]
yamllint = "*"
pylint = "~3.1"
mypy = "*"
ipython = "~8"
pytest-asyncio = "^0.21.1"
pytest-httpx = [
    { version = "~0.21", python = "<3.9" },
    { version = ">=0.30", python = ">=3.9" },
]
pytest-clarity = "~1.0"
pytest-cov = "~4.1"
pytest-xdist = "~3.4"
types-python-slugify = "^8.0.0.3"
pre-commit = "^2.20.0"
types-toml = "*"
types-ujson = "*"
types-pyyaml = "*"
ruff = "0.6.6"
invoke = "2.2.0"
pytest-benchmark = "^4.0.0"
pytest-codspeed = "^2.2.0"
deepdiff = "^6.2"
polyfactory = "^2.16.2"
towncrier = "^24.8"
pytest-env = "^1.1.3"

[tool.poetry.group.test-scale.dependencies]
locust = "^2.20.1"
docker = "^7.0.0"
matplotlib = "^3.8"
pandas = "^2.2"

[tool.poetry.scripts]
infrahub = "infrahub.cli:app"
infrahub-git-credential = "infrahub.git_credential.helper:app"
infrahub-git-askpass = "infrahub.git_credential.askpass:app"

[tool.poetry.plugins."prefect.collections"]
"infrahubasync" = "infrahub.workers.infrahub_async"

[tool.coverage.run]
branch = true

[tool.coverage.report]
exclude_lines = ["if TYPE_CHECKING:", "raise NotImplementedError()"]

[tool.pylint.general]
extension-pkg-whitelist = ["pydantic", "ujson"]

[tool.pylint.format]
disable = "logging-fstring-interpolation"

[tool.pylint.basic]
# No docstrings required for private methods (Pylint default), or for test_ functions.
no-docstring-rgx = "^(_|test_)"

[tool.pylint.messages_control]
# Line length is enforced by Black, so pylint doesn't need to check it.
# Pylint and Black disagree about how to format multi-line arrays; Black wins.
# assigning-non-slot,no-member,unsupported-membership-test,unsubscriptable-object,unsupported-assignment-operation,not-an-iterable
# are disabled because of our move to pydantic 2, pylint does not seem to respect the type hint for pydantic 2 model fields.
disable = """,
    line-too-long,
    missing-module-docstring,
    missing-function-docstring,
    missing-class-docstring,
    consider-using-from-import,
    invalid-name,
    too-many-arguments,
    too-many-locals,
    keyword-arg-before-vararg,
    too-few-public-methods,
    too-many-instance-attributes,
    fixme,
    consider-using-f-string,
    protected-access,
    import-self,
    wrong-import-order,
    assigning-non-slot,
    no-member,
    unsupported-membership-test,
    unsubscriptable-object,
    unsupported-assignment-operation,
    not-an-iterable,
    too-many-return-statements,
    unnecessary-comprehension,
    multiple-statements,
    """

[tool.pylint.miscellaneous]
notes = """,
    FIXME,
    XXX,
    """

[tool.pylint.similarities]
min-similarity-lines = 20

[tool.pytest.ini_options]
asyncio_mode = "auto"
testpaths = ["tests"]
filterwarnings = [
    "ignore:Module already imported so cannot be rewritten",
    "ignore:Deprecated call to",
    "ignore:pkg_resources is deprecated as an API",          # Remove on https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2181 has been fixed
]
addopts = "-vs --cov-report term-missing --cov-report xml --dist loadscope --junitxml=pytest-junit.xml"
junit_duration_report = "call"

[tool.pytest_env]
PREFECT_LOGGING_LEVEL="CRITICAL"
INFRAHUB_LOG_LEVEL="CRITICAL"

[tool.mypy]
pretty = true
ignore_missing_imports = true
disallow_untyped_defs = true
disable_error_code = ["type-abstract"]
exclude = ["^backend/tests/scale", "^backend/tests/unit"]

[[tool.mypy.overrides]]
module = "infrahub.*"
disallow_untyped_defs = true

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

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

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

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

[[tool.mypy.overrides]]
module = "infrahub.api.diff.diff"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.attribute"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.manager"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.node"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.node.base"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.node.standard"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.query"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.query.attribute"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.query.diff"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.query.ipam"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.query.node"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.query.relationship"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.query.standard_node"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.query.subquery"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.schema.basenode_schema"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.schema_manager"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.core.utils"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.database"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.git.base"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.git.repository"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.git_credential.askpass"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.mutations.attribute"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.mutations.ipam"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.mutations.main"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.mutations.proposed_change"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.mutations.relationship"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.mutations.repository"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.mutations.schema"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.resolver"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.schema"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.subscription"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.types.standard_node"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.graphql.utils"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.lock"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations.check.artifact"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations.check.generator"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations.check.repository"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations.refresh.webhook"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations.requests.artifact"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations.requests.graphql_query_group"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations.requests.repository"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations.schema.migration"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.message_bus.operations.schema.validator"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.test_data.dataset03"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.test_data.dataset04"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.test_data.gen_connected_nodes"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.test_data.gen_isolated_node"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.test_data.gen_node_profile_node"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.test_data.shared"
ignore_errors = true

[[tool.mypy.overrides]]
module = "infrahub.trace"
ignore_errors = true

[tool.ruff]
line-length = 120

exclude = [
    ".git",
    ".tox",
    ".venv",
    "env",
    "_build",
    "build",
    "dist",
    "examples",
]


[tool.ruff.lint]
preview = true

task-tags = ["FIXME", "TODO", "XXX"]

select = [
    "ANN",   # flake8-annotations
    "ASYNC", # flake8-async
    "B",     # flake8-bugbear
    "C4",    # flake8-comprehensions
    "C90",   # mccabe complexity
    "DJ",    # flake8-django
    "DTZ",   # flake8-datetimez
    "E",     # pycodestyle errors
    "EXE",   # flake8-executable
    "F",     # pyflakes
    "FURB",  # refurb
    "I",     # isort-like checks
    "ICN",   # flake8-import-conventions
    "INP",   # flake8-no-pep420
    "N",     # pep8-naming
    "PERF",  # Perflint
    "PIE",   # flake8-pie
    "PL",    # pylint
    "PTH",   # flake8-use-pathlib
    "PYI",   # flake8-pyi
    "Q",     # flake8-quotes
    "RET",   # flake8-return
    "RUF",   # Ruff specific rules
    "S",     # flake8-bandit
    "SIM",   # flake8-simplify
    "TCH",   # flake8-type-checking
    "T10",   # flake8-debugger
    "UP",    # pyupgrade
    "W",     # pycodestyle warnings
    "YTT",   # flake8-2020
]

ignore = [

    ##################################################################################################
    # The ignored rules below should be removed once the code has been updated, they are included    #
    # like this so that we can reactivate them one by one. Alternatively ignored after further       #
    # investigation if they are deemed to not make sense.                                            #
    ##################################################################################################
    "ASYNC110", # Use `anyio.Event` instead of awaiting `anyio.sleep` in a `while` loop
    "ASYNC230", # Async functions should not open files with blocking methods like `open`
    "ASYNC251", # Async functions should not call `time.sleep`
    "B007",     # Loop control variable not used within loop body
    "B008",     # Do not perform function call `Depends` in argument defaults;
    "B009",     # [*] Do not call `getattr` with a constant attribute value. It is not any safer than normal property access.
    "B010",     # [*] Do not call `setattr` with a constant attribute value. It is not any safer than normal property access.
    "B904",     # Within an `except` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling
    "C403",     # Unnecessary `list` comprehension (rewrite as a `set` comprehension)
    "C409",     # Unnecessary `list` literal passed to `tuple()` (rewrite as a `tuple` literal)
    "C414",     # Unnecessary `list` call within `sorted()`
    "C420",     # Unnecessary dict comprehension for iterable; use `dict.fromkeys` instead
    "E721",     # Use `is` and `is not` for type comparisons, or `isinstance()` for isinstance checks
    "FURB110",  # Replace ternary `if` expression with `or` operator
    "FURB113",  # Use `networks.extend(...)` instead of repeatedly calling `networks.append()`
    "FURB116",  # Replace `bin` call with f-string
    "FURB118",  # Use `operator.itemgetter(1)` instead of defining a lambda
    "FURB140",  # Use `itertools.starmap` instead of the generator
    "FURB171",  # Membership test against single-item container
    "FURB192",  # Prefer `min` over `sorted()` to compute the minimum value in a sequence
    "N801",     # Class name should use CapWords convention
    "N802",     # Function name should be lowercase
    "N805",     # First argument of a method should be named self
    "N806",     # Variable in function should be lowercase
    "N812",     # Lowercase imported as non-lowercase
    "PERF203",  # `try`-`except` within a loop incurs performance overhead
    "PERF401",  # Use a list comprehension to create a transformed list
    "PERF402",  # Use `list` or `list.copy` to create a copy of a list
    "PERF403",  # Use a dictionary comprehension instead of a for-loop
    "PLC0415",  # `import` should be at the top-level of a file
    "PLC2701",  # Private name import from external module
    "PLR0904",  # Too many public methods
    "PLR0912",  # Too many branches
    "PLR0913",  # Too many arguments in function definition
    "PLR0914",  # Too many local variables
    "PLR0915",  # Too many statements
    "PLR0916",  # Too many Boolean expressions
    "PLR0917",  # Too many positional arguments
    "PLR1702",  # Too many nested blocks
    "PLR2004",  # Magic value used in comparison this could possibly be fine in the tests folders
    "PLR6201",  # Use a `set` literal when testing for membership
    "PLR6301",  # Method could be a function, class method, or static method
    "PLW0603",  # Using the global statement to update `SETTINGS` is discouraged
    "PLW1508",  # Invalid type for environment variable default; expected `str` or `None`
    "PLW3201",  # Bad or misspelled dunder method name `__init_subclass_with_meta__`
    "PTH100",   # `os.path.abspath()` should be replaced by `Path.resolve()`
    "PTH102",   # `os.mkdir()` should be replaced by `Path.mkdir()`
    "PTH103",   # `os.makedirs()` should be replaced by `Path.mkdir(parents=True)`
    "PTH107",   # `os.remove()` should be replaced by `Path.unlink()`
    "PTH108",   # `os.unlink()` should be replaced by `Path.unlink()`
    "PTH109",   # `os.getcwd()` should be replaced by `Path.cwd()`
    "PTH110",   # `os.path.exists()` should be replaced by `Path.exists()`
    "PTH112",   # `os.path.isdir()` should be replaced by `Path.is_dir()`
    "PTH113",   # `os.path.isfile()` should be replaced by `Path.is_file()`
    "PTH117",   # `os.path.isabs()` should be replaced by `Path.is_absolute()`
    "PTH118",   # `os.path.join()` should be replaced by `Path` with `/` operator
    "RET503",   # Missing explicit `return` at the end of function able to return non-`None` value
    "RET504",   # Unnecessary assignment before `return` statement
    "RUF005",   # Consider `[*list(peers.values()), rfc5735]` instead of concatenation
    "RUF006",   # Store a reference to the return value of `asyncio.create_task`
    "RUF010",   # Use explicit conversion flag
    "RUF012",   # Mutable class attributes should be annotated with `typing.ClassVar`
    "RUF013",   # PEP 484 prohibits implicit `Optional`
    "RUF015",   # Prefer `next(...)` over single element slice
    "RUF019",   # Unnecessary key check before dictionary access
    "RUF021",   # Parenthesize `a and b` expressions when chaining `and` and `or` together, to make the precedence clear
    "RUF027",   # Possible f-string without an `f` prefix
    "RUF029",   # Function is declared `async`, but doesn't `await` or use `async` features.
    "RUF031",   # [*] Avoid parentheses for tuples in subscripts.
    "S101",     # Use of `assert` detected
    "S105",     # Possible hardcoded password assigned to: "REGEX_PASSWORD"
    "S108",     # Probable insecure usage of temporary file or directory
    "S202",     # Uses of `tarfile.extractall()`
    "S311",     # Standard pseudo-random generators are not suitable for cryptographic purposes
    "S701",     # By default, jinja2 sets `autoescape` to `False`. Consider using `autoescape=True`
    "SIM108",   # Use ternary operator `markexpr = "not neo4j" if not markexpr else f"not neo4j and ({markexpr})"` instead of `if`-`else`-block
    "SIM102",   # Use a single `if` statement instead of nested `if` statements
    "SIM103",   # Return the condition `identifier in self.sub_by_id.keys()` directly
    "SIM105",   # Use `contextlib.suppress(SchemaNotFoundError)` instead of `try`-`except`-`pass`
    "SIM110",   # Use `return any(worktree.identifier == identifier for worktree in worktrees)` instead of `for` loop
    "SIM114",   # Combine `if` branches using logical `or` operator
    "SIM115",   # Use a context manager for opening files
    "SIM117",   # Use a single `with` statement with multiple contexts instead of nested `with` statements
    "SIM118",   # Use `key in dict` instead of `key in dict.keys()`
    "SIM201",   # Use `backup_path.suffix != ".backup"` instead of `not backup_path.suffix == ".backup"`
    "SIM210",   # Remove unnecessary `True if ... else False`
    "SIM300",   # Yoda condition detected
    "SIM401",   # Use `property["items"].get("format", None)` instead of an `if` block
    "SIM910",   #  Use `data.get("identifier")` instead of `data.get("identifier", None)`
    "UP007",    # Use X | Y for type annotations
    "UP012",    # Unnecessary call to encode as UTF-8
    "UP018",    # Unnecessary {literal_type} call (rewrite as a literal)
    "UP031",    # Use format specifiers instead of percent format
]

#https://docs.astral.sh/ruff/formatter/black/
[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"

[tool.ruff.lint.isort]
known-first-party = ["infrahub"]

[tool.ruff.lint.pycodestyle]
max-line-length = 150

[tool.ruff.lint.mccabe]
# Target max-complexity=10
max-complexity = 33

[tool.ruff.lint.per-file-ignores]

"backend/infrahub/**.py" = [
    ##################################################################################################
    # Review and change the below later                                                              #
    ##################################################################################################
    "ANN001", # Missing type annotation for function argument
    "ANN003", # Missing type annotation for `**kwargs`
    "ANN204", # Missing return type annotation for special method
    "ANN401", # Dynamically typed expressions (typing.Any) are disallowed
]

"backend/infrahub/graphql/mutations/**.py" = [
    ##################################################################################################
    # Review and change the below later                                                              #
    ##################################################################################################
    "ANN206", # Missing return type annotation for classmethod
]

"backend/infrahub/graphql/schema.py" = [
    ##################################################################################################
    # Review and change the below later                                                              #
    ##################################################################################################
    "ANN201", # Missing return type annotation for public function
]

"backend/tests/**.py" = [
    "S101", # Use of assert detected
    "S105", #  Possible hardcoded password assigned to variable
    "S106", #  Possible hardcoded password assigned to argument
    ##################################################################################################
    # Review and change the below later                                                              #
    ##################################################################################################
    "ANN001", # Missing type annotation for function argument
    "ANN002", # Missing type annotation for `*args`
    "ANN003", # Missing type annotation for `**kwargs`
    "ANN201", # Missing return type annotation for public function
    "ANN202", # Missing return type annotation for private function
    "ANN401", # Dynamically typed expressions (typing.Any) are disallowed

]

"models/infrastructure_edge.py" = [
    "S106", # Hardcoded password
    ##################################################################################################
    # The ignored rules below should be removed once the code has been updated, they are included    #
    # like this so that we can reactivate them one by one. Alternatively ignored after further       #
    # investigation if they are deemed to not make sense.                                            #
    ##################################################################################################
    "C901", # `generate_site` is too complex (34 > 33)"
    "E501", # Line too long
]

"utilities/**.py" = [
    ##################################################################################################
    # Review and change the below later                                                              #
    ##################################################################################################
    "ANN401", # Dynamically typed expressions (typing.Any) are disallowed
]

[tool.towncrier]

package = "infrahub"
directory = "changelog"
filename = "CHANGELOG.md"
start_string = "<!-- towncrier release notes start -->\n"
underlines = ["", "", ""]
title_format = "## [{version}](https://github.com/opsmill/infrahub/tree/v{version}) - {project_date}"
issue_format = "[#{issue}](https://github.com/opsmill/infrahub/issues/{issue})"
orphan_prefix = "+"

[[tool.towncrier.type]]
directory = "security"
name = "Security"
showcontent = true

[[tool.towncrier.type]]
directory = "removed"
name = "Removed"
showcontent = true

[[tool.towncrier.type]]
directory = "deprecated"
name = "Deprecated"
showcontent = true

[[tool.towncrier.type]]
directory = "added"
name = "Added"
showcontent = true

[[tool.towncrier.type]]
directory = "changed"
name = "Changed"
showcontent = true

[[tool.towncrier.type]]
directory = "fixed"
name = "Fixed"
showcontent = true

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"