Prep release 1.0.0

.github/file-filters.yml

@@ -3,6 +3,9 @@ ci_config: &ci_config
   - ".github/workflows/ci.yml"
   - ".github/file-filters.yml"
 
+coverage_config: &coverage_config
+  - "codecov.yml"
+
 github_workflows: &github_workflows
   - ".github/workflows/*.yml"
 
@@ -20,6 +23,8 @@ doc_files: &doc_files
 python_all: &python_all
   - "**/*.py"
   - *poetry_files
+  - *ci_config
+  - *coverage_config
 
 yaml_all: &yaml_all
   - "**/*.{yml,yaml}"

.github/workflows/ci.yml

@@ -75,7 +75,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
       - name: "Setup environment"
-        run: "pip install ruff==0.5.0"
+        run: "pip install ruff==0.7.1"
       - name: "Linting: ruff check"
         run: "ruff check ."
       - name: "Linting: ruff format"
@@ -142,12 +142,31 @@ jobs:
         run: |
           pipx install poetry
           poetry config virtualenvs.prefer-active-python true
-          pip install invoke toml
+          pip install invoke toml codecov
       - name: "Install Package"
         run: "poetry install --all-extras"
       - name: "Mypy Tests"
         run: "poetry run mypy --show-error-codes infrahub_sdk/"
       # - name: "Pylint Tests"
       #   run: "poetry run pylint infrahub_sdk/"
       - name: "Unit Tests"
-        run: "poetry run pytest tests/unit/"
+        run: "poetry run pytest --cov infrahub_sdk tests/unit/"
+      - name: "Upload coverage to Codecov"
+        run: |
+          codecov --flags python-${{ matrix.python-version }}
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+      # The pytest-cov plugin doesn't quite work with content that is
+      # auto-imported by our own infrahub pytest plugin, this workaround
+      # reports the missing lines
+      - name: "Report coverage for pytest-plugin"
+        if: matrix.python-version == '3.12'
+        run: |
+          source $(poetry env info --path)/bin/activate
+          coverage run --source=infrahub_sdk -m pytest tests/unit/pytest_plugin
+          coverage report -m
+          coverage xml
+          codecov --flags python-filler-${{ matrix.python-version }}
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.yamllint.yml

@@ -4,6 +4,7 @@ extends: default
 ignore: |
   /.venv
   /examples
+  tests/unit/sdk/test_data/schema_encoding_error.yml
 
 rules:
   new-lines: disable

changelog/+8dff6891.removed.md

@@ -0,0 +1 @@
+Breaking change: Removed all exports from infrahub_sdk/__init__.py except InfrahubClient, InfrahubClientSync and Config. If you previously imported other classes such as InfrahubNode from the root level these need to change to instead be an absolute path.

changelog/+connection-timeout.fixed.md

@@ -0,0 +1 @@
+Changed the default connection timeout in the SDK to 60s.

changelog/+infrahubctl-menu.added.md

@@ -0,0 +1 @@
+Added `infrahubctl menu` command to load menu definitions into Infrahub

changelog/+urlencode-url-parameters.fixed.md

@@ -0,0 +1 @@
+Fixes an issue where InfrahubClient was not properly URL encoding URL parameters.

changelog/102.fixed.md

@@ -0,0 +1 @@
+CTL: Return friendly error on encoding violations when reading files.

changelog/25.added.md

@@ -0,0 +1 @@
+Add support for specific timeout per request on InfrahubClient and InfrahubNode function calls.

changelog/64.fixed.md

@@ -0,0 +1 @@
+Fix SDK playback hash generation to read the correct filename

codecov.yml

@@ -0,0 +1,17 @@
+---
+coverage:
+  status:
+    project:
+      default:
+        target: 0%
+        # Set the threshold to allow a decrease of up to 5% without failing the PR
+        threshold: 5%
+    patch:
+      default:
+        target: 0%
+        # Set the threshold to allow a decrease of up to 5% in patch coverage without failing the PR
+        threshold: 5%
+
+comment:
+  layout: "header, diff, flags, files"
+  behavior: default

infrahub_sdk/__init__.py

@@ -2,76 +2,16 @@
 
 import importlib.metadata
 
-from infrahub_sdk.analyzer import GraphQLOperation, GraphQLQueryAnalyzer, GraphQLQueryVariable
-from infrahub_sdk.batch import InfrahubBatch
-from infrahub_sdk.branch import InfrahubBranchManager, InfrahubBranchManagerSync
-from infrahub_sdk.client import InfrahubClient, InfrahubClientSync
-from infrahub_sdk.config import Config
-from infrahub_sdk.exceptions import (
-    AuthenticationError,
-    Error,
-    GraphQLError,
-    NodeNotFoundError,
-    ServerNotReachableError,
-    ServerNotResponsiveError,
-    ValidationError,
-)
-from infrahub_sdk.graphql import Mutation, Query
-from infrahub_sdk.node import InfrahubNode, InfrahubNodeSync
-from infrahub_sdk.schema import (
-    AttributeSchema,
-    GenericSchema,
-    InfrahubRepositoryConfig,
-    InfrahubSchema,
-    MainSchemaTypes,
-    NodeSchema,
-    ProfileSchema,
-    RelationshipCardinality,
-    RelationshipKind,
-    RelationshipSchema,
-    SchemaRoot,
-)
-from infrahub_sdk.store import NodeStore, NodeStoreSync
-from infrahub_sdk.timestamp import Timestamp
-from infrahub_sdk.uuidt import UUIDT, generate_uuid
+from .client import InfrahubClient, InfrahubClientSync
+from .config import Config
 
 __all__ = [
-    "AttributeSchema",
-    "AuthenticationError",
     "Config",
-    "Error",
-    "InfrahubBatch",
-    "InfrahubBranchManager",
-    "InfrahubBranchManagerSync",
     "InfrahubClient",
     "InfrahubClientSync",
-    "InfrahubNode",
-    "InfrahubNodeSync",
-    "InfrahubRepositoryConfig",
-    "InfrahubSchema",
-    "generate_uuid",
-    "GenericSchema",
-    "GraphQLQueryAnalyzer",
-    "GraphQLQueryVariable",
-    "GraphQLError",
-    "GraphQLOperation",
-    "MainSchemaTypes",
-    "NodeNotFoundError",
-    "NodeSchema",
-    "Mutation",
-    "NodeStore",
-    "NodeStoreSync",
-    "ProfileSchema",
-    "Query",
-    "RelationshipSchema",
-    "RelationshipCardinality",
-    "RelationshipKind",
-    "SchemaRoot",
-    "ServerNotReachableError",
-    "ServerNotResponsiveError",
-    "Timestamp",
-    "UUIDT",
-    "ValidationError",
 ]
 
-__version__ = importlib.metadata.version("infrahub-sdk")
+try:
+    __version__ = importlib.metadata.version("infrahub-sdk")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = importlib.metadata.version("infrahub-server")

infrahub_sdk/_importer.py

@@ -4,7 +4,7 @@
 import sys
 from typing import TYPE_CHECKING, Optional
 
-from infrahub_sdk.exceptions import ModuleImportError
+from .exceptions import ModuleImportError
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -27,7 +27,7 @@
     try:
         module = importlib.import_module(module_name)
     except ModuleNotFoundError as exc:
-        raise ModuleImportError(message=f"{str(exc)} ({module_path})") from exc
+        raise ModuleImportError(message=f"{exc!s} ({module_path})") from exc
     except SyntaxError as exc:
         raise ModuleImportError(message=str(exc)) from exc
 

infrahub_sdk/analyzer.py

@@ -12,7 +12,7 @@
 )
 from pydantic import BaseModel
 
-from infrahub_sdk.utils import calculate_dict_depth, calculate_dict_height, extract_fields
+from .utils import calculate_dict_depth, calculate_dict_height, extract_fields
 
 
 class GraphQLQueryVariable(BaseModel):

infrahub_sdk/batch.py

@@ -2,7 +2,7 @@
 from dataclasses import dataclass
 from typing import Any, AsyncGenerator, Awaitable, Callable, Optional
 
-from infrahub_sdk.node import InfrahubNode
+from .node import InfrahubNode
 
 
 @dataclass

infrahub_sdk/branch.py

@@ -4,12 +4,12 @@
 
 from pydantic import BaseModel
 
-from infrahub_sdk.exceptions import BranchNotFoundError
-from infrahub_sdk.graphql import Mutation, Query
-from infrahub_sdk.utils import decode_json
+from .exceptions import BranchNotFoundError
+from .graphql import Mutation, Query
+from .utils import decode_json
 
 if TYPE_CHECKING:
-    from infrahub_sdk.client import InfrahubClient, InfrahubClientSync
+    from .client import InfrahubClient, InfrahubClientSync
 
 
 class BranchData(BaseModel):

infrahub_sdk/checks.py

@@ -10,13 +10,13 @@
 from git.repo import Repo
 from pydantic import BaseModel, Field
 
-from infrahub_sdk import InfrahubClient
-from infrahub_sdk.exceptions import InfrahubCheckNotFoundError
+from . import InfrahubClient
+from .exceptions import InfrahubCheckNotFoundError, UninitializedError
 
 if TYPE_CHECKING:
     from pathlib import Path
 
-    from infrahub_sdk.schema import InfrahubCheckDefinitionConfig
+    from .schema import InfrahubCheckDefinitionConfig
 
 INFRAHUB_CHECK_VARIABLE_TO_IMPORT = "INFRAHUB_CHECKS"
 
@@ -41,6 +41,7 @@
         output: Optional[str] = None,
         initializer: Optional[InfrahubCheckInitializer] = None,
         params: Optional[dict] = None,
+        client: Optional[InfrahubClient] = None,
     ):
         self.git: Optional[Repo] = None
         self.initializer = initializer or InfrahubCheckInitializer()
@@ -55,7 +56,7 @@
 
         self.root_directory = root_directory or os.getcwd()
 
-        self.client: InfrahubClient
+        self._client = client
 
         if not self.name:
             self.name = self.__class__.__name__
@@ -66,6 +67,17 @@
     def __str__(self) -> str:
         return self.__class__.__name__
 
+    @property
+    def client(self) -> InfrahubClient:
+        if self._client:
+            return self._client
+
+        raise UninitializedError(message="This check has not been initialized with a client")
+
+    @client.setter
+    def client(self, value: InfrahubClient) -> None:
+        self._client = value
+
     @classmethod
     async def init(cls, client: Optional[InfrahubClient] = None, *args: Any, **kwargs: Any) -> InfrahubCheck:
         """Async init method, If an existing InfrahubClient client hasn't been provided, one will be created automatically."""