[Fix]: Allow empty object lists in high-frequency-telemetry YANG model by Pterosaur · Pull Request #23917 · sonic-net/sonic-buildimage

Pterosaur · 2025-09-06T08:36:14Z

Why I did it

We must have a dummy HFT table to support dynamically configuring HFT. This Yang model change is to support the dummy table.

Work item tracking

Microsoft ADO (number only):

How I did it

Remove mandatory constraint for object_names list
Add test cases for empty lists and validation scenarios
Include high-frequency telemetry model

How to verify it

Check Azp status. This PR includes its test.

Which release branch to backport (provide reason below if selected)

202412

Tested branch (Please provide the tested image version)

master

- Remove mandatory constraint for object_names list - Add test cases for empty lists and validation scenarios - Include high-frequency telemetry model Signed-off-by: Ze Gan <[email protected]>

mssonicbld · 2025-09-06T08:36:22Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-06T08:36:33Z

Azure Pipelines successfully started running 1 pipeline(s).

wen587 · 2025-09-06T10:11:15Z

src/sonic-yang-models/setup.py

    'sonic-smart-switch.yang',
    'sonic-spanning-tree.yang',
    'sonic-srv6.yang',
+    'sonic-high-frequency-telemetry.yang',


let's put by alphabet order

wen587 · 2025-09-06T10:17:20Z

src/sonic-yang-models/tests/yang_model_tests/tests_config/high_frequency_telemetry.json

+                ]
+            }
+        },
+        "sonic-high-frequency-telemetry:sonic-high-frequency-telemetry": {


could you add a test for empty object list? I don't think current YANG allowed empty list becasue there are still constraints here if group_name is PORT:
leaf-list object_names {
type string;
must "( ../group_name = 'PORT' and current() = /port:sonic-port/port:PORT/port:PORT_LIST/port:name )"
+ " or ( ../group_name = 'BUFFER_POOL' and current() = /bpl:sonic-buffer-pool/bpl:BUFFER_POOL/bpl:BUFFER_POOL_LIST/bpl:name )"
+ " or ( ../group_name = 'INGRESS_PRIORITY_GROUP' and substring-before(current(), '|') = /bpg:sonic-buffer-pg/bpg:BUFFER_PG/bpg:BUFFER_PG_LIST/bpg:port and re-match(substring-after(current(), '|'), '[0-9]+') )"
+ " or ( ../group_name = 'QUEUE' and substring-before(current(), '|') = /bql:sonic-buffer-queue/bql:BUFFER_QUEUE/bql:BUFFER_QUEUE_LIST/bql:port and re-match(substring-after(current(), '|'), '[0-9]+') )";
}

https://github.com/sonic-net/sonic-buildimage/pull/23917/files#diff-e4744a17a9c8acd94344ef9dfdec05bee6b87ce5506dd69e790fba84e7b46eb5R145-R148

This test is for empty object list.

The test in the link still have elements in object_names

"profile_name": "partial_objects", "group_name": "PORT", "object_names": [ "Ethernet0" ],

I mean empty object_names what ndm will generates. such as:

"profile_name": "partial_objects", "group_name": "PORT", "object_names": [],

or

"profile_name": "partial_objects", "group_name": "PORT", "object_names": "",

It seems that our SONiC YANG parser doesn't support the structure like:

"object_names": [],

It will raise an error from Yang parser.

libyang[0]: Invalid JSON data (unexpected value). (path: /sonic-high-frequency-telemetry:sonic-high-frequency-telemetry/HIGH_FREQUENCY_TELEMETRY_GROUP/HIGH_FREQUENCY_TELEMETRY_GROUP_LIST[profile_name='dummy_profile'][group_name='PORT']/object_names) Exception >Invalid JSON data (unexpected value). in not empty< in /sonic/src/sonic-yang-models/tests/yang_model_tests/test_yang_model.py:278

IMHO, its schema is defined by us, so we can define we only support a json without these fields.

Hi @Pterosaur , right. That's what i am concerned. e.g. if NDM liquid provides "" for object_names and object_counters. Such config will still fail yang validation after we remove must "count(object_names) > 0"; .

liquid is using "" for field value:
https://msazure.visualstudio.com/One/_git/Networking-Metadata?path=/src/data/Network/DeviceConfigTemplates/Sonic_HIGH_FREQUENCY_TELEMETRY_GROUP_Template.liquid&version=GBmaster&_a=contents

To support such field for NDM, should we remove the constraints? such as

leaf-list object_names { type string; must "( ../group_name = 'PORT' and current() = /port:sonic-port/port:PORT/port:PORT_LIST/port:name )"

I am not sure if "" applies to leaf-list. or we should pick [] instead for NDM

Gotch, I add two negative test cases, please check it. We need to update the NDM code later.

wen587 · 2025-09-06T10:18:36Z

src/sonic-yang-models/yang-models/sonic-high-frequency-telemetry.yang


-                must "count(object_names) > 0";
-
                leaf-list object_counters {


please also include such config in sample_config_db.json

mssonicbld · 2025-09-06T11:41:03Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-06T11:41:16Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Ze Gan <[email protected]>

mssonicbld · 2025-09-06T23:46:00Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-06T23:46:13Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Ze Gan <[email protected]>

mssonicbld · 2025-09-08T13:11:00Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-08T13:11:13Z

Azure Pipelines successfully started running 1 pipeline(s).

ganglyu · 2025-09-09T02:47:05Z

src/sonic-yang-models/yang-models/sonic-high-frequency-telemetry.yang

                        + " or ( ../group_name = 'QUEUE' and substring-before(current(), '|') = /bql:sonic-buffer-queue/bql:BUFFER_QUEUE/bql:BUFFER_QUEUE_LIST/bql:port and re-match(substring-after(current(), '|'), '[0-9]+') )";
                }

-                must "count(object_names) > 0";


https://github.com/sonic-net/sonic-buildimage/blob/master/src/sonic-yang-models/yang-models/sonic-pbh.yang#L119

Can we use min-elements?

Use min-elements for what? I removed this condition because I want to support no explicate fields in HFT_GROUP object. such as:

"dummy_table|PORT": {}

#1593) Origin PR: sonic-net/sonic-buildimage#23917 #### Why I did it We must have a dummy HFT table to support dynamically configuring HFT. This Yang model change is to support the dummy table. ##### Work item tracking - Microsoft ADO **(number only)**: #### How I did it - Remove mandatory constraint for object_names list - Add test cases for empty lists and validation scenarios - Include high-frequency telemetry model - #### How to verify it Check Azp status. This PR includes its test. #### Which release branch to backport (provide reason below if selected) - [x] 202412 #### Tested branch (Please provide the tested image version) master

sonic-net#23917) Why I did it We must have a dummy HFT table to support dynamically configuring HFT. This Yang model change is to support the dummy table. How I did it Remove mandatory constraint for object_names list Add test cases for empty lists and validation scenarios Include high-frequency telemetry model How to verify it Check Azp status. This PR includes its test. Signed-off-by: Feng Pan <[email protected]>

fix: Allow empty object lists in high-frequency telemetry YANG model

33c38ca

- Remove mandatory constraint for object_names list - Add test cases for empty lists and validation scenarios - Include high-frequency telemetry model Signed-off-by: Ze Gan <[email protected]>

Pterosaur requested a review from qiluo-msft as a code owner September 6, 2025 08:36

Pterosaur added the Request for msft-202412 Branch label Sep 6, 2025

mssonicbld added the Cherry Pick Conflict_msft-202412 label Sep 6, 2025

wen587 reviewed Sep 6, 2025

View reviewed changes

Fix comments

424d147

Signed-off-by: Ze Gan <[email protected]>

Pterosaur force-pushed the fix_hft_yang branch from 6333f53 to 424d147 Compare September 6, 2025 23:45

Pterosaur requested a review from wen587 September 7, 2025 12:08

Add negative case

b3b3c68

Signed-off-by: Ze Gan <[email protected]>

wen587 approved these changes Sep 9, 2025

View reviewed changes

wen587 requested a review from ganglyu September 9, 2025 02:16

ganglyu reviewed Sep 9, 2025

View reviewed changes

ganglyu approved these changes Sep 9, 2025

View reviewed changes

qiluo-msft approved these changes Sep 9, 2025

View reviewed changes

qiluo-msft merged commit 67d24be into sonic-net:master Sep 9, 2025
20 checks passed

Pterosaur mentioned this pull request Sep 10, 2025

[Fix]: Allow empty object lists in high-frequency-telemetry YANG model Azure/sonic-buildimage-msft#1593

Merged

1 task

Pterosaur added Approved for msft-202412 Branch Included in msft-202412 Branch and removed Cherry Pick Conflict_msft-202412 labels Sep 10, 2025

mssonicbld added the Cherry Pick Conflict_msft-202412 label Sep 10, 2025

Pterosaur removed the Cherry Pick Conflict_msft-202412 label Sep 10, 2025

Conversation

Pterosaur commented Sep 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why I did it

Work item tracking

How I did it

How to verify it

Which release branch to backport (provide reason below if selected)

Tested branch (Please provide the tested image version)

Uh oh!

mssonicbld commented Sep 6, 2025

Uh oh!

azure-pipelines bot commented Sep 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wen587 Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wen587 Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pterosaur Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Sep 6, 2025

Uh oh!

azure-pipelines bot commented Sep 6, 2025

Uh oh!

mssonicbld commented Sep 6, 2025

Uh oh!

azure-pipelines bot commented Sep 6, 2025

Uh oh!

mssonicbld commented Sep 8, 2025

Uh oh!

azure-pipelines bot commented Sep 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Pterosaur commented Sep 6, 2025 •

edited

Loading

wen587 Sep 8, 2025 •

edited

Loading

wen587 Sep 8, 2025 •

edited

Loading

Pterosaur Sep 8, 2025 •

edited

Loading