Skip to content

Add integration tests for metadata #861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ogenstad wants to merge 1 commit into
base: stable
Choose a base branch
from
Open

Add integration tests for metadata #861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions tests/integration/test_infrahub_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
from infrahub_sdk.constants import InfrahubClientMode
from infrahub_sdk.exceptions import BranchNotFoundError, URLNotFoundError
from infrahub_sdk.node import InfrahubNode
from infrahub_sdk.node.metadata import NodeMetadata, RelationshipMetadata
from infrahub_sdk.playback import JSONPlayback
from infrahub_sdk.recorder import JSONRecorder
from infrahub_sdk.schema import GenericSchema, NodeSchema, ProfileSchemaAPI
Expand Down Expand Up @@ -328,6 +329,98 @@ async def create_person_with_tags(clt: InfrahubClient, nbr_tags: int) -> None:
)
assert len(group.members.peers) == 2

async def test_node_metadata_not_fetched_by_default(
self, client: InfrahubClient, base_dataset: None, cat_luna: InfrahubNode
) -> None:
node = await client.get(kind=TESTING_CAT, id=cat_luna.id)
assert node.get_node_metadata() is None

async def test_node_metadata_with_get(
self, client: InfrahubClient, base_dataset: None, cat_luna: InfrahubNode
) -> None:
node = await client.get(kind=TESTING_CAT, id=cat_luna.id, include_metadata=True)

metadata = node.get_node_metadata()
assert isinstance(metadata, NodeMetadata)
assert metadata.created_at is not None
assert metadata.updated_at is not None
assert metadata.created_by.display_label == "Admin"

async def test_node_metadata_with_all(self, client: InfrahubClient, base_dataset: None) -> None:
nodes = await client.all(kind=TESTING_CAT, include_metadata=True)
assert nodes

for node in nodes:
metadata = node.get_node_metadata()
assert isinstance(metadata, NodeMetadata)
assert metadata.created_at is not None
assert metadata.updated_at is not None
assert metadata.created_by.display_label == "Admin"

async def test_attribute_metadata(
self, client: InfrahubClient, base_dataset: None, person_ethan: InfrahubNode
) -> None:
disposable = await client.create(
kind=TESTING_CAT, name="MetadataTestCat", breed="Siamese", color="#FFFFFF", owner=person_ethan
)
await disposable.save()

node = await client.get(kind=TESTING_CAT, id=disposable.id, include_metadata=True)

assert node.name.updated_by.display_label == "Admin"
assert node.breed.updated_by.display_label == "Admin"
original_name_updated_at = node.name.updated_at
original_breed_updated_at = node.breed.updated_at

node.name.value = "MetadataTestCat Updated"
await node.save()

assert original_name_updated_at is not None

node_after = await client.get(kind=TESTING_CAT, id=disposable.id, include_metadata=True)
assert node_after.name.value == "MetadataTestCat Updated"
assert node_after.name.updated_by.display_label == "Admin"
assert node_after.name.updated_at is not None
assert node_after.name.updated_at > original_name_updated_at
assert node_after.breed.updated_at == original_breed_updated_at
Comment on lines +372 to +385
Copy link

@coderabbitai coderabbitai bot Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

The immediate updated_at ordering assertion is prone to flakiness.

A create and update performed back-to-back can legitimately share the same timestamp resolution in the containerized test environment. Poll until the timestamp changes, or avoid asserting strict monotonicity here.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@tests/integration/test_infrahub_client.py` around lines 372 - 385, The test's
strict assertion that node_after.name.updated_at > original_name_updated_at is
flaky because create+update can produce identical timestamps; change the test to
poll/retry fetching with client.get(kind=TESTING_CAT, id=disposable.id,
include_metadata=True) until node_after.name.updated_at !=
original_name_updated_at (or until a short timeout) and then assert the
timestamp changed, or alternatively remove the strict ordering and assert only
that updated_at is not None; update references to node.save(),
original_name_updated_at, node_after.name.updated_at, and
node_after.name.updated_by.display_label accordingly.


await node_after.delete()

async def test_relationship_metadata_cardinality_one(
self, client: InfrahubClient, base_dataset: None, cat_luna: InfrahubNode
) -> None:
node = await client.get(kind=TESTING_CAT, id=cat_luna.id, include_metadata=True)

rel_metadata = node.owner.get_relationship_metadata()
assert isinstance(rel_metadata, RelationshipMetadata)
assert rel_metadata.updated_at is not None
assert rel_metadata.updated_by.display_label == "Admin"

async def test_relationship_metadata_cardinality_many(
self, client: InfrahubClient, base_dataset: None, person_ethan: InfrahubNode
) -> None:
# Use include=["animals"] rather than prefetch_relationships=True.
# prefetch_relationships=True recursively fetches each animal's peer relationships,
# which in turn include person_ethan's null favorite_animal cardinality-one relationship.
# The server GraphQL schema marks NestedEdgedTestingAnimal.node_metadata as non-nullable,
# so requesting include_metadata=True on that null edge causes the server to silently
# return empty edges. include=["animals"] fetches only the animals relationship shallowly.
# Also exclude favorite_animal (null cardinality-one inbound) for the same reason.
node = await client.get(
kind=TESTING_PERSON,
id=person_ethan.id,
include_metadata=True,
include=["animals"],
exclude=["favorite_animal"],
)

assert node.animals.peers
for peer in node.animals.peers:
rel_metadata = peer.get_relationship_metadata()
assert isinstance(rel_metadata, RelationshipMetadata)
assert rel_metadata.updated_at is not None
assert rel_metadata.updated_by.display_label == "Admin"

@pytest.mark.xfail(reason="https://github.com/opsmill/infrahub-sdk-python/issues/733")
async def test_recorder_with_playback_rewrite_host(
self, base_dataset: None, tmp_path: Path, infrahub_port: int
Expand Down
76 changes: 76 additions & 0 deletions tests/integration/test_infrahub_client_sync.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
from infrahub_sdk.constants import InfrahubClientMode
from infrahub_sdk.exceptions import BranchNotFoundError, URLNotFoundError
from infrahub_sdk.node import InfrahubNodeSync
from infrahub_sdk.node.metadata import NodeMetadata, RelationshipMetadata
from infrahub_sdk.playback import JSONPlayback
from infrahub_sdk.recorder import JSONRecorder
from infrahub_sdk.schema import GenericSchema, NodeSchema, ProfileSchemaAPI
Expand Down Expand Up @@ -330,6 +331,81 @@ def create_person_with_tags(clt: InfrahubClientSync, nbr_tags: int) -> None:
)
assert len(group.members.peers) == 2

def test_node_metadata_not_fetched_by_default(
self, client_sync: InfrahubClientSync, base_dataset: None, cat_luna: InfrahubNode
) -> None:
node = client_sync.get(kind=TESTING_CAT, id=cat_luna.id)
assert node.get_node_metadata() is None

def test_node_metadata_with_get(
self, client_sync: InfrahubClientSync, base_dataset: None, cat_luna: InfrahubNode
) -> None:
node = client_sync.get(kind=TESTING_CAT, id=cat_luna.id, include_metadata=True)

metadata = node.get_node_metadata()
assert isinstance(metadata, NodeMetadata)
assert metadata.created_at is not None
assert metadata.updated_at is not None
assert metadata.created_by.display_label == "Admin"

def test_attribute_metadata(
self, client_sync: InfrahubClientSync, base_dataset: None, person_ethan: InfrahubNode
) -> None:
disposable = client_sync.create(
kind=TESTING_CAT, name="MetadataTestCat", breed="Siamese", color="#FFFFFF", owner=person_ethan
)
disposable.save()

node = client_sync.get(kind=TESTING_CAT, id=disposable.id, include_metadata=True)

assert node.name.updated_by.display_label == "Admin"
assert node.breed.updated_by.display_label == "Admin"
original_name_updated_at = node.name.updated_at
original_breed_updated_at = node.breed.updated_at
assert original_name_updated_at is not None

node.name.value = "MetadataTestCat Updated"
node.save()

node_after = client_sync.get(kind=TESTING_CAT, id=disposable.id, include_metadata=True)
assert node_after.name.value == "MetadataTestCat Updated"
assert node_after.name.updated_by.display_label == "Admin"
assert node_after.name.updated_at is not None
assert node_after.name.updated_at > original_name_updated_at
assert node_after.breed.updated_at == original_breed_updated_at
Comment on lines +363 to +375
Copy link

@coderabbitai coderabbitai bot Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

The strict updated_at > original_name_updated_at check can be flaky.

This update happens immediately after creation, so both values can land in the same timestamp bucket on fast containers. Consider polling until the timestamp changes, or assert on a non-time-based signal instead.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@tests/integration/test_infrahub_client_sync.py` around lines 363 - 375, The
strict timestamp assertion is flaky; replace the direct assert
node_after.name.updated_at > original_name_updated_at with a short polling loop
that calls client_sync.get(kind=TESTING_CAT, id=disposable.id,
include_metadata=True) until node_after.name.updated_at is different from
original_name_updated_at or a small timeout (e.g., 1–2s) elapses, then assert
the timestamp changed (or fail after timeout); keep the existing checks for
node_after.name.value and node_after.name.updated_by.display_label and reference
the existing node.save() call and original_name_updated_at variable when
implementing the poll.


node_after.delete()

def test_relationship_metadata_cardinality_one(
self, client_sync: InfrahubClientSync, base_dataset: None, cat_luna: InfrahubNode
) -> None:
node = client_sync.get(kind=TESTING_CAT, id=cat_luna.id, include_metadata=True)

rel_metadata = node.owner.get_relationship_metadata()
assert isinstance(rel_metadata, RelationshipMetadata)
assert rel_metadata.updated_at is not None
assert rel_metadata.updated_by.display_label == "Admin"

def test_relationship_metadata_cardinality_many(
self, client_sync: InfrahubClientSync, base_dataset: None, person_ethan: InfrahubNode
) -> None:
# Use include=["animals"] rather than prefetch_relationships=True — see async counterpart
# in test_infrahub_client.py for full explanation.
node = client_sync.get(
kind=TESTING_PERSON,
id=person_ethan.id,
include_metadata=True,
include=["animals"],
exclude=["favorite_animal"],
)

assert node.animals.peers
for peer in node.animals.peers:
rel_metadata = peer.get_relationship_metadata()
assert isinstance(rel_metadata, RelationshipMetadata)
assert rel_metadata.updated_at is not None
assert rel_metadata.updated_by.display_label == "Admin"

@pytest.mark.xfail(reason="https://github.com/opsmill/infrahub-sdk-python/issues/733")
def test_recorder_with_playback_rewrite_host(self, base_dataset: None, tmp_path: Path, infrahub_port: int) -> None:
# Create a fresh client for recording to ensure clean state (no cached schema)
Expand Down
Loading