test(client): pin 1.7.0 backend_metrics shape with deterministic structural assertions by Muawiya-contact · Pull Request #342 · apache/hugegraph-ai

Muawiya-contact · 2026-05-22T07:37:26Z

test(client): pin 1.7.0 backend_metrics shape with deterministic structural assertions

Closes #326

What does this PR do?

Replaces the loose assertGreater(len(...), 1) check in test_metric.py with deterministic structural assertions based on the actual /metrics/backend response captured from a real HugeGraph server.

The problem

The old assertion only checked length — shape drift in the API response would pass silently without any test failure.

# Before — too loose
self.assertGreater(len(backend_metrics["hugegraph"]), 1)

The fix

# After — deterministic structural assertion
missing_keys = EXPECTED_BACKEND_SERVER_KEYS - set(server_entry.keys())
self.assertFalse(missing_keys, f"Missing expected keys: {missing_keys}")

What was verified

Captured the actual /metrics/backend response from a real HugeGraph server
Pinned EXPECTED_BACKEND_SERVER_KEYS from that real response
Asserts backend, nodes, cluster_id, servers fields exist with correct types
Asserts all expected rocksdb metric keys are present in the server entry

Test results

Server version	Result
HugeGraph 1.7.0 (Docker)	✅ PASSED
HugeGraph latest (Docker)	✅ PASSED

Both versions return identical shapes — one assertion covers both.

Files changed

Only one file touched: hugegraph-python-client/src/tests/api/test_metric.py

…ctural assertions

Muawiya-contact · 2026-05-22T09:27:06Z

@imbajin, any feedback please?

Copilot

Pull request overview

This PR tightens the python-client integration test for GET /metrics/backend by replacing a loose length-only assertion with deterministic structural assertions that pin the expected HugeGraph 1.7.0 backend_metrics response shape (and intended to remain compatible with newer versions).

Changes:

Introduces a pinned set of expected metric keys (EXPECTED_BACKEND_SERVER_KEYS) for each backend server entry.
Replaces the old conditional/len-based assertion with explicit structural checks for graph entry fields (backend, nodes, cluster_id, servers) and expected RocksDB metrics.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Replace strict single-graph check with assertGreaterEqual(>=1) to support multi-graph environments - Add assertIsInstance for cluster_id to enforce documented str type - Loop over all servers dict entries instead of checking only the first, ensuring every server entry is fully validated against expected RocksDB metric keys No functional change; test coverage and portability improved. Verified: ruff check + ruff format clean. Live backend test pending CI. Signed-off-by: Muawiya-contact <contactmuawia@gmail.com>

Signed-off-by: Muawiya-contact <contactmuawia@gmail.com>

Muawiya-contact · 2026-05-31T14:45:43Z

Hey @imbajin — all 13 CI checks are green and Copilot's review looks good too. Would love to get your eyes on this when you have a moment. Thanks!

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

…tion and sorted missing keys

Muawiya-contact · 2026-06-01T16:13:55Z

@imbajin, Done ✅

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

…ction

Muawiya-contact · 2026-06-02T03:30:41Z

@imbajin I have added now...

imbajin · 2026-06-02T07:29:46Z

Note we refact the test frame in #357

Muawiya-contact · 2026-06-02T10:42:38Z

Thanks for the heads-up @imbajin.

I checked #357 and understand the test framework has been refactored there. My intention in #342 was specifically to restore deterministic structural assertions for backend_metrics.

If there are any adjustments needed to align this PR with the new test framework in #357, I'd be happy to update it. Thanks for reviewing.

imbajin · 2026-06-02T12:40:05Z

just resolve the conflicts 🔢

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

imbajin

One remaining portability issue: the test now pins RocksDB-specific backend metric fields in a python-client integration test. The graph-key concern is already covered by existing Copilot comments.

… key selection

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

test(client): pin 1.7.0 backend_metrics shape with deterministic stru…

54bf799

…ctural assertions

dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label May 22, 2026

github-actions Bot added the python-client label May 22, 2026

style: apply ruff formatting to test_metric.py

9c895ca

imbajin requested a review from Copilot May 30, 2026 13:36

Copilot started reviewing on behalf of imbajin May 30, 2026 13:36 View session

Copilot AI reviewed May 30, 2026

View reviewed changes

Muawiya-contact added 2 commits May 31, 2026 19:35

style: fix ruff format in test_metric.py assertGreaterEqual call

80441d8

Signed-off-by: Muawiya-contact <contactmuawia@gmail.com>

imbajin requested a review from Copilot June 1, 2026 10:56

Copilot started reviewing on behalf of imbajin June 1, 2026 10:56 View session

Copilot AI reviewed Jun 1, 2026

View reviewed changes

Comment thread hugegraph-python-client/src/tests/api/test_metric.py Outdated

Comment thread hugegraph-python-client/src/tests/api/test_metric.py Outdated

Comment thread hugegraph-python-client/src/tests/api/test_metric.py Outdated

test(metrics): address Copilot review — deterministic graph key selec…

3eb9304

…tion and sorted missing keys

imbajin requested a review from Copilot June 1, 2026 21:54

Copilot started reviewing on behalf of imbajin June 1, 2026 21:55 View session

Copilot AI reviewed Jun 1, 2026

View reviewed changes

Comment thread hugegraph-python-client/src/tests/api/test_metric.py

test(metrics): use ClientUtils.GRAPH for deterministic graph key sele…

e1b96e7

…ction

Muawiya-contact added 2 commits June 3, 2026 08:54

Merge branch 'main' into fix/backend-metrics-strict-assertion

d4bf39d

style: apply ruff formatting after conflict resolution

02601ff

imbajin requested a review from Copilot June 3, 2026 04:39

Copilot started reviewing on behalf of imbajin June 3, 2026 04:39 View session

Copilot AI reviewed Jun 3, 2026

View reviewed changes

Comment thread hugegraph-python-client/src/tests/api/test_metric.py

imbajin reviewed Jun 3, 2026

View reviewed changes

Comment thread hugegraph-python-client/src/tests/api/test_metric.py Outdated

test(metrics): branch server assertions by backend type and fix graph…

4507424

… key selection

imbajin requested a review from Copilot June 3, 2026 15:18

Copilot started reviewing on behalf of imbajin June 3, 2026 15:18 View session

Copilot AI reviewed Jun 3, 2026

View reviewed changes

Conversation

Muawiya-contact commented May 22, 2026

test(client): pin 1.7.0 backend_metrics shape with deterministic structural assertions

What does this PR do?

The problem

The fix

What was verified

Test results

Files changed

Uh oh!

Muawiya-contact commented May 22, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Muawiya-contact commented May 31, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Muawiya-contact commented Jun 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Muawiya-contact commented Jun 2, 2026

Uh oh!

imbajin commented Jun 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Muawiya-contact commented Jun 2, 2026

Uh oh!

imbajin commented Jun 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

imbajin commented Jun 2, 2026 •

edited

Loading