infrahub-server 1.6.0b0__py3-none-any.whl → 1.6.2__py3-none-any.whl

infrahub_sdk/ctl/branch.py

@@ -1,15 +1,24 @@
 import logging
+import sys
+from datetime import datetime, timezone
+from typing import TYPE_CHECKING
 
 import typer
 from rich.console import Console
 from rich.table import Table
 
 from ..async_typer import AsyncTyper
-from ..utils import calculate_time_diff
+from ..branch import BranchData
+from ..diff import DiffTreeData
+from ..protocols import CoreProposedChange
+from ..utils import calculate_time_diff, decode_json
 from .client import initialize_client
 from .parameters import CONFIG_PARAM
 from .utils import catch_exception
 
+if TYPE_CHECKING:
+    from ..client import InfrahubClient
+
 app = AsyncTyper()
 console = Console()
 
@@ -18,6 +27,108 @@ DEFAULT_CONFIG_FILE = "infrahubctl.toml"
 ENVVAR_CONFIG_FILE = "INFRAHUBCTL_CONFIG"
 
 
+def format_timestamp(timestamp: str) -> str:
+    """Format ISO timestamp to 'YYYY-MM-DD HH:MM:SS'.
+    Args:
+        timestamp (str): ISO fromatted timestamp
+
+    Returns:
+        (str): the datetime as string formatted as 'YYYY-MM-DD HH:MM:SS'
+
+    Raises:
+        Any execptions returned from formatting the timestamp are propogated to the caller
+    """
+    dt = datetime.fromisoformat(timestamp.replace("Z", "+00:00"))
+    return dt.strftime("%Y-%m-%d %H:%M:%S")
+
+
+async def check_git_files_changed(client: "InfrahubClient", branch: str) -> bool:
+    """Check if there are any Git file changes in a branch.
+
+    Args:
+        client: Infrahub client instance
+        branch: Branch name to check
+
+    Returns:
+        True if files have changed, False otherwise
+
+    Raises:
+        Any exceptions from the API call are propagated to the caller
+    """
+    url = f"{client.address}/api/diff/files?branch={branch}"
+    resp = await client._get(url=url, timeout=client.default_timeout)
+    resp.raise_for_status()
+    data = decode_json(response=resp)
+
+    # Check if any repository has files
+    if branch in data:
+        for repo_data in data[branch].values():
+            if isinstance(repo_data, dict) and "files" in repo_data and len(repo_data["files"]) > 0:
+                return True
+
+    return False
+
+
+def generate_branch_report_table(
+    branch: BranchData, diff_tree: DiffTreeData | None, git_files_changed: bool | None
+) -> Table:
+    branch_table = Table(show_header=False, box=None)
+    branch_table.add_column(justify="left")
+    branch_table.add_column(justify="right")
+
+    branch_table.add_row("Created at", format_timestamp(branch.branched_from))
+
+    status_value = branch.status.value if hasattr(branch.status, "value") else str(branch.status)
+    branch_table.add_row("Status", status_value)
+
+    branch_table.add_row("Synced with Git", "Yes" if branch.sync_with_git else "No")
+
+    if git_files_changed is not None:
+        branch_table.add_row("Git files changed", "Yes" if git_files_changed else "No")
+    else:
+        branch_table.add_row("Git files changed", "N/A")
+
+    branch_table.add_row("Has schema changes", "Yes" if branch.has_schema_changes else "No")
+
+    if diff_tree:
+        branch_table.add_row("Diff last updated", format_timestamp(diff_tree["to_time"]))
+        branch_table.add_row("Amount of additions", str(diff_tree["num_added"]))
+        branch_table.add_row("Amount of deletions", str(diff_tree["num_removed"]))
+        branch_table.add_row("Amount of updates", str(diff_tree["num_updated"]))
+        branch_table.add_row("Amount of conflicts", str(diff_tree["num_conflicts"]))
+    else:
+        branch_table.add_row("Diff last updated", "No diff available")
+        branch_table.add_row("Amount of additions", "-")
+        branch_table.add_row("Amount of deletions", "-")
+        branch_table.add_row("Amount of updates", "-")
+        branch_table.add_row("Amount of conflicts", "-")
+
+    return branch_table
+
+
+def generate_proposed_change_tables(proposed_changes: list[CoreProposedChange]) -> list[Table]:
+    proposed_change_tables: list[Table] = []
+
+    for pc in proposed_changes:
+        # Create proposal table
+        proposed_change_table = Table(show_header=False, box=None)
+        proposed_change_table.add_column(justify="left")
+        proposed_change_table.add_column(justify="right")
+
+        # Extract data from node
+        proposed_change_table.add_row("Name", pc.name.value)
+        proposed_change_table.add_row("State", str(pc.state.value))
+        proposed_change_table.add_row("Is draft", "Yes" if pc.is_draft.value else "No")
+        proposed_change_table.add_row("Created by", pc.created_by.peer.name.value)  # type: ignore[union-attr]
+        proposed_change_table.add_row("Created at", format_timestamp(str(pc.created_by.updated_at)))
+        proposed_change_table.add_row("Approvals", str(len(pc.approved_by.peers)))
+        proposed_change_table.add_row("Rejections", str(len(pc.rejected_by.peers)))
+
+        proposed_change_tables.append(proposed_change_table)
+
+    return proposed_change_tables
+
+
 @app.callback()
 def callback() -> None:
     """
@@ -143,3 +254,66 @@ async def validate(branch_name: str, _: str = CONFIG_PARAM) -> None:
     client = initialize_client()
     await client.branch.validate(branch_name=branch_name)
     console.print(f"Branch '{branch_name}' is valid.")
+
+
+@app.command()
+@catch_exception(console=console)
+async def report(
+    branch_name: str = typer.Argument(..., help="Branch name to generate report for"),
+    update_diff: bool = typer.Option(False, "--update-diff", help="Update diff before generating report"),
+    _: str = CONFIG_PARAM,
+) -> None:
+    """Generate branch cleanup status report."""
+
+    client = initialize_client()
+
+    # Fetch branch metadata first (needed for diff creation)
+    branch = await client.branch.get(branch_name=branch_name)
+
+    if branch.is_default:
+        console.print("[red]Cannot create a report for the default branch!")
+        sys.exit(1)
+
+    # Update diff if requested
+    if update_diff:
+        console.print("Updating diff...")
+        # Create diff from branch creation to now
+        from_time = datetime.fromisoformat(branch.branched_from.replace("Z", "+00:00"))
+        to_time = datetime.now(timezone.utc)
+        await client.create_diff(
+            branch=branch_name,
+            name=f"report-{branch_name}",
+            from_time=from_time,
+            to_time=to_time,
+        )
+        console.print("Diff updated\n")
+
+    diff_tree = await client.get_diff_tree(branch=branch_name)
+
+    git_files_changed = await check_git_files_changed(client, branch=branch_name)
+
+    proposed_changes = await client.filters(
+        kind=CoreProposedChange,  # type: ignore[type-abstract]
+        source_branch__value=branch_name,
+        include=["created_by"],
+        prefetch_relationships=True,
+        property=True,
+    )
+
+    branch_table = generate_branch_report_table(branch=branch, diff_tree=diff_tree, git_files_changed=git_files_changed)
+    proposed_change_tables = generate_proposed_change_tables(proposed_changes=proposed_changes)
+
+    console.print()
+    console.print(f"[bold]Branch: {branch_name}[/bold]")
+
+    console.print(branch_table)
+    console.print()
+
+    if not proposed_changes:
+        console.print("No proposed changes for this branch")
+        console.print()
+
+    for proposed_change, proposed_change_table in zip(proposed_changes, proposed_change_tables, strict=True):
+        console.print(f"Proposed change: {proposed_change.name.value}")
+        console.print(proposed_change_table)
+        console.print()

infrahub_sdk/ctl/check.py

@@ -5,7 +5,7 @@ import sys
 from asyncio import run as aiorun
 from dataclasses import dataclass
 from pathlib import Path
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING
 
 import typer
 from rich.console import Console
@@ -49,8 +49,8 @@ def run(
     format_json: bool,
     list_available: bool,
     variables: dict[str, str],
-    name: Optional[str] = None,
-    branch: Optional[str] = None,
+    name: str | None = None,
+    branch: str | None = None,
 ) -> None:
     """Locate and execute all checks under the defined path."""
 

infrahub_sdk/ctl/cli_commands.py

@@ -8,7 +8,7 @@ import platform
 import sys
 from collections.abc import Callable
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Optional
+from typing import TYPE_CHECKING, Any
 
 import typer
 import ujson
@@ -78,13 +78,13 @@ console = Console()
 @catch_exception(console=console)
 def check(
     check_name: str = typer.Argument(default="", help="Name of the Python check"),
-    branch: Optional[str] = None,
+    branch: str | None = None,
     path: str = typer.Option(".", help="Root directory"),
     debug: bool = False,
     format_json: bool = False,
     _: str = CONFIG_PARAM,
     list_available: bool = typer.Option(False, "--list", help="Show available Python checks"),
-    variables: Optional[list[str]] = typer.Argument(
+    variables: list[str] | None = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
 ) -> None:
@@ -106,12 +106,12 @@ def check(
 @catch_exception(console=console)
 async def generator(
     generator_name: str = typer.Argument(default="", help="Name of the Generator"),
-    branch: Optional[str] = None,
+    branch: str | None = None,
     path: str = typer.Option(".", help="Root directory"),
     debug: bool = False,
     _: str = CONFIG_PARAM,
     list_available: bool = typer.Option(False, "--list", help="Show available Generators"),
-    variables: Optional[list[str]] = typer.Argument(
+    variables: list[str] | None = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
 ) -> None:
@@ -134,13 +134,13 @@ async def run(
     debug: bool = False,
     _: str = CONFIG_PARAM,
     branch: str = typer.Option(None, help="Branch on which to run the script."),
-    concurrent: Optional[int] = typer.Option(
+    concurrent: int | None = typer.Option(
         None,
         help="Maximum number of requests to execute at the same time.",
         envvar="INFRAHUB_MAX_CONCURRENT_EXECUTION",
     ),
     timeout: int = typer.Option(60, help="Timeout in sec", envvar="INFRAHUB_TIMEOUT"),
-    variables: Optional[list[str]] = typer.Argument(
+    variables: list[str] | None = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
 ) -> None:
@@ -251,7 +251,7 @@ async def _run_transform(
 @catch_exception(console=console)
 async def render(
     transform_name: str = typer.Argument(default="", help="Name of the Python transformation", show_default=False),
-    variables: Optional[list[str]] = typer.Argument(
+    variables: list[str] | None = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
     branch: str = typer.Option(None, help="Branch on which to render the transform."),
@@ -301,7 +301,7 @@ async def render(
 @catch_exception(console=console)
 def transform(
     transform_name: str = typer.Argument(default="", help="Name of the Python transformation", show_default=False),
-    variables: Optional[list[str]] = typer.Argument(
+    variables: list[str] | None = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
     branch: str = typer.Option(None, help="Branch on which to run the transformation"),

infrahub_sdk/ctl/generator.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING
 
 import typer
 from rich.console import Console
@@ -22,7 +22,7 @@ async def run(
     debug: bool,
     list_available: bool,
     branch: str | None = None,
-    variables: Optional[list[str]] = None,
+    variables: list[str] | None = None,
 ) -> None:
     init_logging(debug=debug)
     repository_config = get_repository_config(find_repository_config_file())

infrahub_sdk/ctl/graphql.py

@@ -3,7 +3,6 @@ from __future__ import annotations
 import ast
 from collections import defaultdict
 from pathlib import Path
-from typing import Optional
 
 import typer
 from ariadne_codegen.client_generators.package import PackageGenerator, get_package_generator
@@ -115,7 +114,7 @@ async def export_schema(
 @app.command()
 @catch_exception(console=console)
 async def generate_return_types(
-    query: Optional[Path] = typer.Argument(
+    query: Path | None = typer.Argument(
         None, help="Location of the GraphQL query file(s). Defaults to current directory if not specified."
     ),
     schema: Path = typer.Option("schema.graphql", help="Path to the GraphQL schema file."),

infrahub_sdk/ctl/importer.py

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 from asyncio import run as aiorun
 from pathlib import Path
-from typing import Optional
 
 import typer
 from rich.console import Console
@@ -27,7 +26,7 @@ def load(
     quiet: bool = typer.Option(False, help="No console output"),
     _: str = CONFIG_PARAM,
     branch: str = typer.Option(None, help="Branch from which to export"),
-    concurrent: Optional[int] = typer.Option(
+    concurrent: int | None = typer.Option(
         None,
         help="Maximum number of requests to execute at the same time.",
         envvar="INFRAHUB_MAX_CONCURRENT_EXECUTION",

infrahub_sdk/ctl/repository.py

@@ -1,12 +1,9 @@
 from __future__ import annotations
 
-import asyncio
 from pathlib import Path
-from typing import Optional
 
 import typer
 import yaml
-from copier import run_copy
 from pydantic import ValidationError
 from rich.console import Console
 from rich.table import Table
@@ -109,7 +106,7 @@ async def add(
     name: str,
     location: str,
     description: str = "",
-    username: Optional[str] = None,
+    username: str | None = None,
     password: str = "",
     ref: str = "",
     read_only: bool = False,
@@ -155,7 +152,7 @@ async def add(
 
 @app.command()
 async def list(
-    branch: Optional[str] = typer.Option(None, help="Branch on which to list repositories."),
+    branch: str | None = typer.Option(None, help="Branch on which to list repositories."),
     debug: bool = False,
     _: str = CONFIG_PARAM,
 ) -> None:
@@ -208,49 +205,9 @@ async def list(
 
 
 @app.command()
-async def init(
-    directory: Path = typer.Argument(help="Directory path for the new project."),
-    template: str = typer.Option(
-        default="https://github.com/opsmill/infrahub-template.git",
-        help="Template to use for the new repository. Can be a local path or a git repository URL.",
-    ),
-    data: Optional[Path] = typer.Option(default=None, help="Path to YAML file containing answers to CLI prompt."),
-    vcs_ref: Optional[str] = typer.Option(
-        default="HEAD",
-        help="VCS reference to use for the template. Defaults to HEAD.",
-    ),
-    trust: Optional[bool] = typer.Option(
-        default=False,
-        help="Trust the template repository. If set, the template will be cloned without verification.",
-    ),
-    _: str = CONFIG_PARAM,
-) -> None:
+async def init() -> None:
     """Initialize a new Infrahub repository."""
 
-    config_data = None
-    if data:
-        try:
-            with Path.open(data, encoding="utf-8") as file:
-                config_data = yaml.safe_load(file)
-            typer.echo(f"Loaded config: {config_data}")
-        except Exception as exc:
-            typer.echo(f"Error loading YAML file: {exc}", err=True)
-            raise typer.Exit(code=1)
-
-    # Allow template to be a local path or a URL
-    template_source = template or ""
-    if template and Path(template).exists():
-        template_source = str(Path(template).resolve())
-
-    try:
-        await asyncio.to_thread(
-            run_copy,
-            template_source,
-            str(directory),
-            data=config_data,
-            vcs_ref=vcs_ref,
-            unsafe=trust,
-        )
-    except Exception as e:
-        typer.echo(f"Error running copier: {e}", err=True)
-        raise typer.Exit(code=1)
+    console.print("The copier tool is not included in the Infrahub SDK CLI due to license restrictions,")
+    console.print("please run the following command to create a new Infrahub repository project:\n")
+    console.print("uv tool run --from 'copier' copier copy https://github.com/opsmill/infrahub-template <project-name>")

infrahub_sdk/ctl/task.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-from typing import Optional
-
 import typer
 from rich.console import Console
 from rich.table import Table
@@ -75,8 +73,8 @@ async def list_tasks(
     state: list[str] = typer.Option(
         None, "--state", "-s", help="Filter by task state. Can be provided multiple times."
     ),
-    limit: Optional[int] = typer.Option(None, help="Maximum number of tasks to retrieve."),
-    offset: Optional[int] = typer.Option(None, help="Offset for pagination."),
+    limit: int | None = typer.Option(None, help="Maximum number of tasks to retrieve."),
+    offset: int | None = typer.Option(None, help="Offset for pagination."),
     include_related_nodes: bool = typer.Option(False, help="Include related nodes in the output."),
     include_logs: bool = typer.Option(False, help="Include task logs in the output."),
     json_output: bool = typer.Option(False, "--json", help="Output the result as JSON."),

infrahub_sdk/ctl/utils.py

@@ -6,7 +6,7 @@ import traceback
 from collections.abc import Callable, Coroutine
 from functools import wraps
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, NoReturn, Optional, TypeVar
+from typing import TYPE_CHECKING, Any, NoReturn, TypeVar
 
 import typer
 from click.exceptions import Exit
@@ -149,7 +149,7 @@ def print_graphql_errors(console: Console, errors: list) -> None:
             console.print(f"[red]{escape(str(error))}")
 
 
-def parse_cli_vars(variables: Optional[list[str]]) -> dict[str, str]:
+def parse_cli_vars(variables: list[str] | None) -> dict[str, str]:
     if not variables:
         return {}
 

infrahub_sdk/ctl/validate.py

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 import sys
 from pathlib import Path
-from typing import Optional
 
 import typer
 import ujson
@@ -58,7 +57,7 @@ async def validate_schema(schema: Path, _: str = CONFIG_PARAM) -> None:
 @catch_exception(console=console)
 def validate_graphql(
     query: str,
-    variables: Optional[list[str]] = typer.Argument(
+    variables: list[str] | None = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
     debug: bool = typer.Option(False, help="Display more troubleshooting information."),

infrahub_sdk/diff.py

@@ -1,11 +1,12 @@
 from __future__ import annotations
 
-from typing import (
-    Any,
-)
+from datetime import datetime
+from typing import Any
 
 from typing_extensions import NotRequired, TypedDict
 
+from infrahub_sdk.graphql.query import Query
+
 
 class NodeDiff(TypedDict):
     branch: str
@@ -35,6 +36,19 @@ class NodeDiffPeer(TypedDict):
     summary: NodeDiffSummary
 
 
+class DiffTreeData(TypedDict):
+    num_added: int
+    num_updated: int
+    num_removed: int
+    num_conflicts: int
+    to_time: str
+    from_time: str
+    base_branch: str
+    diff_branch: str
+    name: NotRequired[str | None]
+    nodes: list[NodeDiff]
+
+
 def get_diff_summary_query() -> str:
     return """
         query GetDiffTree($branch_name: String!, $name: String, $from_time: DateTime, $to_time: DateTime) {
@@ -125,3 +139,66 @@ def diff_tree_node_to_node_diff(node_dict: dict[str, Any], branch_name: str) ->
         display_label=str(node_dict.get("label")),
         elements=element_diffs,
     )
+
+
+def get_diff_tree_query() -> Query:
+    node_structure = {
+        "uuid": None,
+        "kind": None,
+        "status": None,
+        "label": None,
+        "num_added": None,
+        "num_updated": None,
+        "num_removed": None,
+        "attributes": {
+            "name": None,
+            "status": None,
+            "num_added": None,
+            "num_updated": None,
+            "num_removed": None,
+        },
+        "relationships": {
+            "name": None,
+            "status": None,
+            "cardinality": None,
+            "num_added": None,
+            "num_updated": None,
+            "num_removed": None,
+            "elements": {
+                "status": None,
+                "num_added": None,
+                "num_updated": None,
+                "num_removed": None,
+            },
+        },
+    }
+
+    return Query(
+        name="GetDiffTree",
+        query={
+            "DiffTree": {
+                "@filters": {
+                    "branch": "$branch_name",
+                    "name": "$name",
+                    "from_time": "$from_time",
+                    "to_time": "$to_time",
+                },
+                "name": None,
+                "to_time": None,
+                "from_time": None,
+                "base_branch": None,
+                "diff_branch": None,
+                "num_added": None,
+                "num_updated": None,
+                "num_removed": None,
+                "num_conflicts": None,
+                "nodes": node_structure,
+            },
+        },
+        variables={
+            "branch_name": str,
+            "name": str | None,
+            "from_time": datetime | None,
+            "to_time": datetime | None,
+        },
+    )

infrahub_sdk/graphql/constants.py

@@ -1 +1,14 @@
-VARIABLE_TYPE_MAPPING = ((str, "String!"), (int, "Int!"), (float, "Float!"), (bool, "Boolean!"))
+from datetime import datetime
+
+VARIABLE_TYPE_MAPPING = (
+    (str, "String!"),
+    (str | None, "String"),
+    (int, "Int!"),
+    (int | None, "Int"),
+    (float, "Float!"),
+    (float | None, "Float"),
+    (bool, "Boolean!"),
+    (bool | None, "Boolean"),
+    (datetime, "DateTime!"),
+    (datetime | None, "DateTime"),
+)

infrahub_sdk/graphql/renderers.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import json
+from datetime import datetime
 from enum import Enum
 from typing import Any
 
@@ -66,7 +67,10 @@ def convert_to_graphql_as_string(value: Any, convert_enum: bool = False) -> str:
     return str(value)
 
 
-def render_variables_to_string(data: dict[str, type[str | int | float | bool]]) -> str:
+GRAPHQL_VARIABLE_TYPES = type[str | int | float | bool | datetime | None]
+
+
+def render_variables_to_string(data: dict[str, GRAPHQL_VARIABLE_TYPES]) -> str:
     """Render a dict into a variable string that will be used in a GraphQL Query.
 
     The $ sign will be automatically added to the name of the query.

infrahub_sdk/node/attribute.py

@@ -53,7 +53,6 @@ class Attribute:
         self.is_inherited: bool | None = data.get("is_inherited")
         self.updated_at: str | None = data.get("updated_at")
 
-        self.is_visible: bool | None = data.get("is_visible")
         self.is_protected: bool | None = data.get("is_protected")
 
         self.source: NodeProperty | None = None

infrahub_sdk/node/constants.py

@@ -1,7 +1,7 @@
 import ipaddress
 import re
 
-PROPERTIES_FLAG = ["is_visible", "is_protected"]
+PROPERTIES_FLAG = ["is_protected", "updated_at"]
 PROPERTIES_OBJECT = ["source", "owner"]
 SAFE_VALUE = re.compile(r"(^[\. /:a-zA-Z0-9_-]+$)|(^$)")
 
@@ -17,4 +17,6 @@ ARTIFACT_DEFINITION_GENERATE_FEATURE_NOT_SUPPORTED_MESSAGE = (
     "calling generate is only supported for CoreArtifactDefinition nodes"
 )
 
+HIERARCHY_FETCH_FEATURE_NOT_SUPPORTED_MESSAGE = "Hierarchical fields are not supported for this node."
+
 HFID_STR_SEPARATOR = "__"