Version 1.3.0

1.3.0 - 2024-12-30

Added

Testing library (Alpha)

A new collection of tools and utilities to help with testing is available under infrahub_sdk.testing.

The first component available is a TestInfrahubDockerClient, a pytest Class designed to help creating integration tests based on Infrahub. See a simple example below to help you get started.

the installation of infrahub-testcontainers is required

import pytest

from infrahub_sdk import InfrahubClient
from infrahub_sdk.testing.docker import TestInfrahubDockerClient

class TestInfrahubNode(TestInfrahubDockerClient):

    @pytest.fixture(scope="class")
    def infrahub_version(self) -> str:
        """Required (for now) to define the version of infrahub to use."""
        return "1.0.10"

    @pytest.fixture(scope="class")
    async def test_create_tag(self, default_branch: str, client: InfrahubClient) -> None:
        obj = await client.create(kind="BuiltinTag", name="Blue")
        await obj.save()
        assert obj.id

Changed

• The Pydantic models for the schema have been split into multiple versions to align better with the different phase of the lifecycle of the schema.
  • User input: includes only the options available for a user to define (NodeSchema, AttributeSchema, RelationshipSchema, GenericSchema)
  • API: Format of the schema as exposed by the API in infrahub with some read only settings (NodeSchemaAPI, AttributeSchemaAPI, RelationshipSchemaAPI, GenericSchemaAPI)

Fixed

• Fix behaviour of attribute value coming from resource pools for async client (#66)
• Convert import_root to a string if it was submitted as a Path object to ensure that anything added to sys.path is a string
• Fix relative imports for the pytest plugin, note that the relative imports can't be at the top level of the repository alongside .infrahub.yml. They have to be located within a subfolder. (#166)

Version 1.2.0

1.2.0 - 2024-12-19

Added

• Add batch feature, that uses threading, to sync client (#168)
• Added InfrahubClient.schema.in_sync method to indicate if a specific branch is in sync across all worker types
• Added Python 3.13 to the list of supported versions

Fixed

• Fix an issue with with infrahubctl menu load that would fail while loading the menu

Version 1.1.0

1.1.0 - 2024-11-28

Added

• Added InfrahubClient.schema.wait_until_converged() which allows you to wait until the schema has converged across all Infrahub workers before proceeding with an operation. The InfrahubClient.schema.load() method has also been updated with a new parameter "wait_until_converged".

Fixed

• CTL: schema load return a proper error message when authentication is missing or when the user doesn't have the permission to update the schema. (#127)
• CTL: List available transforms and generators if no name is provided (#140)

Version 1.1.0rc0

1.1.0rc0 - 2024-11-26

This is a Release Candidate/Preview release for Version 1.1.0.

Fixed

• CTL: schema load return a proper error message when authentication is missing or when the user doesn't have the permission to update the schema. (#127)
• CTL: List available transforms and generators if no name is provided (#140)

Version 1.0.1

1.0.1 - 2024-11-12

Removed

• Removed previously deprecated InfrahubTransform.init() method

Deprecated

• Marked InfrahubCheck.init() as deprecated and scheduled to be removed in Infrahub SDK 2.0.0

Added

• Adds groups.group_add_subscriber function to add a subscriber to a group.
• Adds order_weight property to AttributeSchema and RelationSchema classes.

Fixed

• Fix generated GraphQL query when having a relationship to a pool node (#27)
• CTL: Fix support for relative imports for transforms and generators (#81)
• Fixes issues where InfrahubClient was not properly configured for a branch when running the infrahubctl transform, infrahubctl check and infrhubctl generator commands. (#133)
• Fixes an issue where a generator would not return any output if there are no members in the generator's target group.

Detailed Changelog

• stable to develop mergeback by @lykinsbd in #119
• bump version for next release by @lykinsbd in #120
• Rework ignore rules for mypy by @ogenstad in #121
• When using only the values of a dict use the values() method by @ogenstad in #122
• Move test from integration -> unit by @ogenstad in #123
• Add return type to generator run() by @ogenstad in #124
• Fix setting value of relationship of type pool by @gmazoyer in #118
• Add groups.group_add_subscriber by @LucasG0 in #125
• Fix relative module imports by @ogenstad in #128
• Change ctl check to not use InfrahubCheck.init() by @ogenstad in #126
• Fix relative imports for Python checks by @ogenstad in #131
• Make infrahubctl generator more verbose by @gmazoyer in #116
• Add order_weight by @ogenstad in #132
• sets branch on InfrahubClient when running infrahubctl transform infahubctl check and infrahubctl generator by @wvandeun in #134

Full Changelog: v1.0.0...v1.0.1

Version 1.0.0

1.0.0 - 2024-10-31

Removed

• 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.

Added

• Add support for specific timeout per request on InfrahubClient and InfrahubNode function calls. (#25)
• Added infrahubctl menu command to load menu definitions into Infrahub

Fixed

• Fix SDK playback hash generation to read the correct filename (#64)
• CTL: Return friendly error on encoding violations when reading files. (#102)
• Changed the default connection timeout in the SDK to 60s.
• Fixes an issue where InfrahubClient was not properly URL encoding URL parameters.

Detailed Changelog

• Remove filters from the schemas in the fixtures directory by @dgarros in #53
• Update Protocols with CoreMenu & CoreMenuItem by @dgarros in #62
• stable mergeback by @ajtmccarty in #63
• Upload coverage reports to codecov by @ogenstad in #67
• Add config file for codecov by @ogenstad in #70
• Change the default connection timeout to 60s by @wvandeun in #69
• Set codecov target for PRs and changes by @ogenstad in #74
• Run python tests after changes to codecov.yml by @ogenstad in #75
• Fix broken SDK playback by @ogenstad in #72
• Add infrahubctl menu load command to load menu items from a file by @dgarros in #73
• Support code to be integrated into infrahub-server by @dgarros in #78
• Run coverage separately by @ogenstad in #79
• Activate rule for B018 for useless attribute access by @ogenstad in #87
• Fix Ruff B007 fix Loop control variable not used within loop body by @ogenstad in #85
• Fix Yoda condition (SIM300) by @ogenstad in #86
• Limit coverage run to --source=infrahub_sdk by @ogenstad in #83
• Cleanup ignored type annotations by @ogenstad in #84
• Merge back stable into develop with resolved conflicts by @ogenstad in #88
• Convert import paths to use relative Package name by @dgarros in #80
• Fix typehints and remove type ignores for ctl.importer & ctl.exporter by @ogenstad in #91
• Fix typing on ctl.utils by @ogenstad in #92
• Fix linting issues by @ogenstad in #95
• Fix typing for CLI commands by @ogenstad in #94
• Remove exports from infrahub_sdk.__init__.py by @ogenstad in #93
• Fix deprecation warning by @ogenstad in #97
• stable to develop mergeback by @lykinsbd in #101
• Ignore specific RUF rules instead of ignoring everything by @ogenstad in #103
• Add specific timeouts per request per #25 by @PhillSimonds in #96
• Correct autofixable ruff violations by @ogenstad in #106
• Update protocols to match latest core schema by @dgarros in #107
• Upgrade ruff to 0.7.1 by @ogenstad in #108
• Add ability to initialize a Check with a client by @ogenstad in #115
• Return friendly errors on file encoding violations by @ogenstad in #114
• fix: urlencode query params by @fatih-acar in #60
• Prep release 1.0.0 by @wvandeun in #117

Full Changelog: v0.14.1...v1.0.0

Version 0.14.1

0.14.1 - 2024-10-22

Fixed

• Make infrahubctl transform command set up the InfrahubTransform class with an InfrahubClient instance (#8)
• Command infrahubctl protocols now supports every kind of schema attribute. (#57)

Version 0.14.0

0.14.0 - 2024-10-04

Removed

• Removed depreceted methods InfrahubClient.init and InfrahubClientSync.init (#33)

Changed

• Query filters are not validated locally anymore, the validation will be done on the server side instead. (#9)

• Method client.get() can now return None instead of raising an exception when raise_when_missing is set to False

  response = await clients.get(
      kind="CoreRepository", name__value="infrahub-demo", raise_when_missing=False
  )
  ``` ([#11](https://github.com/opsmill/infrahub-sdk-python/issues/11))

Fixed

• prefix and address attribute filters are now available in the Python SDK (#10)
• Queries using isnull as a filter are now supported by the Python SDK (#30)
• execute_graphql method for InfrahubClient(Sync) now properly considers the default_branch setting (#46)

Version 0.13.1

0.13.1 - 2024-09-24

Added

• Allow id filters to be combined when executing a query (#3)

Fixed

• Add ability to construct HFIDs from payload for upsert mutations (#45)
• Fix pytest plugin integration tests unable to run because we were not properly setting the api_token configuration setting for the SDK.