Merge pull request #308 from opsmill/infrahub-develop

Release 1.8.0

Author: lykinsbd

.github/workflows/ci.yml

@@ -76,7 +76,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
-        run: "pip install ruff==0.8.6"
+        run: "pip install ruff==0.11.0"
       - name: "Linting: ruff check"
         run: "ruff check ."
       - name: "Linting: ruff format"
@@ -212,6 +212,7 @@ jobs:
           - "3.10"
           - "3.11"
           - "3.12"
+          - "3.13"
     if: |
       always() && !cancelled() &&
       !contains(needs.*.result, 'failure') &&
@@ -299,77 +300,79 @@ jobs:
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-  integration-tests-local-infrahub:
-    if: |
-      always() && !cancelled() &&
-      !contains(needs.*.result, 'failure') &&
-      !contains(needs.*.result, 'cancelled') &&
-      needs.files-changed.outputs.python == 'true' &&
-      (github.base_ref == 'stable' || github.base_ref == 'develop')
-    needs: ["files-changed", "yaml-lint", "python-lint"]
-    runs-on:
-      group: "huge-runners"
-    timeout-minutes: 30
-    steps:
-      - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+  # NOTE: Disabling this test for now because it's expected that we can't start the latest version of infrahub
+  # with the current shipping version of infrahub-testcontainers
+  # integration-tests-local-infrahub:
+  #   if: |
+  #     always() && !cancelled() &&
+  #     !contains(needs.*.result, 'failure') &&
+  #     !contains(needs.*.result, 'cancelled') &&
+  #     needs.files-changed.outputs.python == 'true' &&
+  #     (github.base_ref == 'stable' || github.base_ref == 'develop')
+  #   needs: ["files-changed", "yaml-lint", "python-lint"]
+  #   runs-on:
+  #     group: "huge-runners"
+  #   timeout-minutes: 30
+  #   steps:
+  #     - name: "Check out repository code"
+  #       uses: "actions/checkout@v4"
 
-      - name: "Extract target branch name"
-        id: extract_branch
-        run: echo "TARGET_BRANCH=${{ github.base_ref }}" >> $GITHUB_ENV
+  #     - name: "Extract target branch name"
+  #       id: extract_branch
+  #       run: echo "TARGET_BRANCH=${{ github.base_ref }}" >> $GITHUB_ENV
 
-      - name: "Checkout infrahub repository"
-        uses: "actions/checkout@v4"
-        with:
-          repository: "opsmill/infrahub"
-          path: "infrahub-server"
-          ref: ${{ github.base_ref }}
-          submodules: true
+  #     - name: "Checkout infrahub repository"
+  #       uses: "actions/checkout@v4"
+  #       with:
+  #         repository: "opsmill/infrahub"
+  #         path: "infrahub-server"
+  #         ref: ${{ github.base_ref }}
+  #         submodules: true
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
+  #     - name: Set up Python
+  #       uses: actions/setup-python@v5
+  #       with:
+  #         python-version: "3.12"
 
-      - name: "Setup git credentials prior dev.build"
-        run: |
-          cd infrahub-server
-          git config --global user.name 'Infrahub'
-          git config --global user.email '[email protected]'
-          git config --global --add safe.directory '*'
-          git config --global credential.usehttppath true
-          git config --global credential.helper /usr/local/bin/infrahub-git-credential
+  #     - name: "Setup git credentials prior dev.build"
+  #       run: |
+  #         cd infrahub-server
+  #         git config --global user.name 'Infrahub'
+  #         git config --global user.email '[email protected]'
+  #         git config --global --add safe.directory '*'
+  #         git config --global credential.usehttppath true
+  #         git config --global credential.helper /usr/local/bin/infrahub-git-credential
 
-      - name: "Set environment variables prior dev.build"
-        run: |
-          echo "INFRAHUB_BUILD_NAME=infrahub-${{ runner.name }}" >> $GITHUB_ENV
-          RUNNER_NAME=$(echo "${{ runner.name }}" | grep -o 'ghrunner[0-9]\+' | sed 's/ghrunner\([0-9]\+\)/ghrunner_\1/')
-          echo "PYTEST_DEBUG_TEMPROOT=/var/lib/github/${RUNNER_NAME}/_temp" >> $GITHUB_ENV
-          echo "INFRAHUB_IMAGE_VER=local-${{ runner.name }}-${{ github.sha }}" >> $GITHUB_ENV
-          echo "INFRAHUB_TESTING_IMAGE_VER=local-${{ runner.name }}-${{ github.sha }}" >> $GITHUB_ENV
-          echo "INFRAHUB_TESTING_DOCKER_IMAGE=opsmill/infrahub" >> $GITHUB_ENV
+  #     - name: "Set environment variables prior dev.build"
+  #       run: |
+  #         echo "INFRAHUB_BUILD_NAME=infrahub-${{ runner.name }}" >> $GITHUB_ENV
+  #         RUNNER_NAME=$(echo "${{ runner.name }}" | grep -o 'ghrunner[0-9]\+' | sed 's/ghrunner\([0-9]\+\)/ghrunner_\1/')
+  #         echo "PYTEST_DEBUG_TEMPROOT=/var/lib/github/${RUNNER_NAME}/_temp" >> $GITHUB_ENV
+  #         echo "INFRAHUB_IMAGE_VER=local-${{ runner.name }}-${{ github.sha }}" >> $GITHUB_ENV
+  #         echo "INFRAHUB_TESTING_IMAGE_VER=local-${{ runner.name }}-${{ github.sha }}" >> $GITHUB_ENV
+  #         echo "INFRAHUB_TESTING_DOCKER_IMAGE=opsmill/infrahub" >> $GITHUB_ENV
 
-      - name: "Build container"
-        run: |
-          cd infrahub-server
-          inv dev.build
+  #     - name: "Build container"
+  #       run: |
+  #         cd infrahub-server
+  #         inv dev.build
 
-      - name: "Setup environment"
-        run: |
-          pipx install poetry==1.8.5
-          poetry config virtualenvs.create true --local
-          pip install invoke toml codecov
+  #     - name: "Setup environment"
+  #       run: |
+  #         pipx install poetry==1.8.5
+  #         poetry config virtualenvs.create true --local
+  #         pip install invoke toml codecov
 
-      - name: "Install Package"
-        run: "poetry install --all-extras"
+  #     - name: "Install Package"
+  #       run: "poetry install --all-extras"
 
-      - name: "Integration Tests"
-        run: |
-          echo "Running tests for version: $INFRAHUB_TESTING_IMAGE_VER"
-          poetry run pytest --cov infrahub_sdk tests/integration/
+  #     - name: "Integration Tests"
+  #       run: |
+  #         echo "Running tests for version: $INFRAHUB_TESTING_IMAGE_VER"
+  #         poetry run pytest --cov infrahub_sdk tests/integration/
 
-      - name: "Upload coverage to Codecov"
-        run: |
-          codecov --flags integration-tests
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+  #     - name: "Upload coverage to Codecov"
+  #       run: |
+  #         codecov --flags integration-tests
+  #       env:
+  #         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

CHANGELOG.md

@@ -11,6 +11,21 @@ This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the chang
 
 <!-- towncrier release notes start -->
 
+## [1.8.0](https://github.com/opsmill/infrahub-sdk-python/tree/v1.8.0) - 2025-03-19
+
+### Deprecated
+
+- Timestamp: Direct access to `obj` and `add_delta` have been deprecated and will be removed in a future version. ([#255](https://github.com/opsmill/infrahub-sdk-python/issues/255))
+
+### Added
+
+- Added support for Enum in GraphQL query and mutation. ([#18](https://github.com/opsmill/infrahub-sdk-python/issues/18))
+
+### Fixed
+
+- Refactored Timestamp to use `whenever` instead of `pendulum` and extend Timestamp with `add()`, `subtract()`, and `to_datetime()`. ([#255](https://github.com/opsmill/infrahub-sdk-python/issues/255))
+- Fixed support for Python 3.13 as it's no longer required to have Rust installed on the system.
+
 ## [1.7.2](https://github.com/opsmill/infrahub-sdk-python/tree/v1.7.2) - 2025-03-07
 
 ### Added
@@ -26,6 +41,14 @@ This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the chang
 ### Fixed
 
 - `protocols` CTL command properly gets default branch setting from environment variable. ([#104](https://github.com/opsmill/infrahub-sdk-python/issues/104))
+- Fix typing for Python 3.9 ([#251](https://github.com/opsmill/infrahub-sdk-python/issues/251))
+- Refactor Timestamp to use `whenever` instead of `pendulum` and extend Timestamp with add(), subtract(), and to_datetime(). ([#255](https://github.com/opsmill/infrahub-sdk-python/issues/255))
+- Remove default value "main" for branch parameter from all Infrahub CTL commands. ([#264](https://github.com/opsmill/infrahub-sdk-python/issues/264))
+- Fixed support for Python 3.13, it's no longer required to have Rust installed on the system.
+
+### Housekeeping
+
+- Move the function `read_file` from the ctl module to the SDK.
 - Fixed typing for Python 3.9 and removed support for Python 3.13. ([#251](https://github.com/opsmill/infrahub-sdk-python/issues/251))
 - Removed default value "main" for branch parameter from all Infrahub CTL commands. ([#264](https://github.com/opsmill/infrahub-sdk-python/issues/264))
 

infrahub_sdk/client.py

@@ -52,13 +52,16 @@
 from .query_groups import InfrahubGroupContext, InfrahubGroupContextSync
 from .schema import InfrahubSchema, InfrahubSchemaSync, NodeSchemaAPI
 from .store import NodeStore, NodeStoreSync
+from .task.manager import InfrahubTaskManager, InfrahubTaskManagerSync
 from .timestamp import Timestamp
 from .types import AsyncRequester, HTTPMethod, Order, SyncRequester
 from .utils import decode_json, get_user_permissions, is_valid_uuid
 
 if TYPE_CHECKING:
     from types import TracebackType
 
+    from .context import RequestContext
+
 
 SchemaType = TypeVar("SchemaType", bound=CoreNode)
 SchemaTypeSync = TypeVar("SchemaTypeSync", bound=CoreNodeSync)
@@ -140,6 +143,7 @@ def __init__(
         self.identifier = self.config.identifier
         self.group_context: InfrahubGroupContext | InfrahubGroupContextSync
         self._initialize()
+        self._request_context: RequestContext | None = None
 
     def _initialize(self) -> None:
         """Sets the properties for each version of the client"""
@@ -154,6 +158,14 @@ def _echo(self, url: str, query: str, variables: dict | None = None) -> None:
             if variables:
                 print(f"VARIABLES:\n{ujson.dumps(variables, indent=4)}\n")
 
+    @property
+    def request_context(self) -> RequestContext | None:
+        return self._request_context
+
+    @request_context.setter
+    def request_context(self, request_context: RequestContext) -> None:
+        self._request_context = request_context
+
     def start_tracking(
         self,
         identifier: str | None = None,
@@ -270,6 +282,7 @@ def _initialize(self) -> None:
         self.branch = InfrahubBranchManager(self)
         self.object_store = ObjectStore(self)
         self.store = NodeStore()
+        self.task = InfrahubTaskManager(self)
         self.concurrent_execution_limit = asyncio.Semaphore(self.max_concurrent_execution)
         self._request_method: AsyncRequester = self.config.requester or self._default_request_method
         self.group_context = InfrahubGroupContext(self)
@@ -1505,13 +1518,19 @@ async def __aexit__(
 
 
 class InfrahubClientSync(BaseClient):
+    schema: InfrahubSchemaSync
+    branch: InfrahubBranchManagerSync
+    object_store: ObjectStoreSync
+    store: NodeStoreSync
+    task: InfrahubTaskManagerSync
     group_context: InfrahubGroupContextSync
 
     def _initialize(self) -> None:
         self.schema = InfrahubSchemaSync(self)
         self.branch = InfrahubBranchManagerSync(self)
         self.object_store = ObjectStoreSync(self)
         self.store = NodeStoreSync()
+        self.task = InfrahubTaskManagerSync(self)
         self._request_method: SyncRequester = self.config.sync_requester or self._default_request_method
         self.group_context = InfrahubGroupContextSync(self)
 

infrahub_sdk/context.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, Field
+
+
+class ContextAccount(BaseModel):
+    id: str = Field(..., description="The ID of the account")
+
+
+class RequestContext(BaseModel):
+    """The context can be used to override settings such as the account within mutations."""
+
+    account: ContextAccount | None = Field(default=None, description="Account tied to the context")

infrahub_sdk/ctl/branch.py

@@ -5,9 +5,10 @@
 from rich.table import Table
 
 from ..async_typer import AsyncTyper
-from ..ctl.client import initialize_client
-from ..ctl.utils import calculate_time_diff, catch_exception
+from ..utils import calculate_time_diff
+from .client import initialize_client
 from .parameters import CONFIG_PARAM
+from .utils import catch_exception
 
 app = AsyncTyper()
 console = Console()

infrahub_sdk/ctl/utils.py

@@ -8,11 +8,9 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Callable, NoReturn, Optional, TypeVar
 
-import pendulum
 import typer
 from click.exceptions import Exit
 from httpx import HTTPError
-from pendulum.datetime import DateTime
 from rich.console import Console
 from rich.logging import RichHandler
 from rich.markup import escape
@@ -152,20 +150,6 @@ def parse_cli_vars(variables: Optional[list[str]]) -> dict[str, str]:
     return {var.split("=")[0]: var.split("=")[1] for var in variables if "=" in var}
 
 
-def calculate_time_diff(value: str) -> str | None:
-    """Calculate the time in human format between a timedate in string format and now."""
-    try:
-        time_value = pendulum.parse(value)
-    except pendulum.parsing.exceptions.ParserError:
-        return None
-
-    if not isinstance(time_value, DateTime):
-        return None
-
-    pendulum.set_locale("en")
-    return time_value.diff_for_humans(other=pendulum.now(), absolute=True)
-
-
 def find_graphql_query(name: str, directory: str | Path = ".") -> str:
     if isinstance(directory, str):
         directory = Path(directory)

infrahub_sdk/exceptions.py

@@ -143,3 +143,9 @@ class FileNotValidError(Error):
     def __init__(self, name: str, message: str = ""):
         self.message = message or f"Cannot parse '{name}' content."
         super().__init__(self.message)
+
+
+class TimestampFormatError(Error):
+    def __init__(self, message: str | None = None):
+        self.message = message or "Invalid timestamp format"
+        super().__init__(self.message)

infrahub_sdk/generator.py

@@ -11,6 +11,7 @@
 
 if TYPE_CHECKING:
     from .client import InfrahubClient
+    from .context import RequestContext
     from .node import InfrahubNode
     from .store import NodeStore
 
@@ -29,6 +30,7 @@ def __init__(
         params: dict | None = None,
         convert_query_response: bool = False,
         logger: logging.Logger | None = None,
+        request_context: RequestContext | None = None,
     ) -> None:
         self.query = query
         self.branch = branch
@@ -44,6 +46,7 @@ def __init__(
         self.infrahub_node = infrahub_node
         self.convert_query_response = convert_query_response
         self.logger = logger if logger else logging.getLogger("infrahub.tasks")
+        self.request_context = request_context
 
     @property
     def store(self) -> NodeStore: