Make PFC commands use a class #3057

bktsim-arista · 2023-11-30T17:51:10Z

What I did

This change puts contents originally in pfc/main.py into a class, to support the usage of the multi-asic helper in a future change. This change is required, as multi-asic helper being used expects members self.config_db and self.db to exist when a function with the decorator run_on_multi_asic is called. The multi-asic class helper will be used to add multi-asic support to pfc commands in a following pull request.

This is a part of the set of changes being pushed for sonic-net/sonic-buildimage#15148

How I did it

Moved contents of PFC commands into a class. There are no functional changes.

arista-nwolfe · 2024-01-16T21:52:12Z

/azpw run Azure.sonic-utilities

wenyiz2021 · 2024-01-16T22:43:52Z

/azpw run

arlakshm · 2024-01-17T18:27:33Z

/azpw run Azure.sonic-utilities

arlakshm · 2024-01-17T18:27:56Z

/azp run Azure.sonic-utilities

azure-pipelines · 2024-01-17T18:28:07Z

Azure Pipelines successfully started running 1 pipeline(s).

vmittal-msft · 2024-03-25T20:36:04Z

/azp run

azure-pipelines · 2024-03-25T20:36:14Z

Azure Pipelines successfully started running 1 pipeline(s).

arlakshm · 2024-03-25T20:28:00Z

pfc/main.py

@@ -1,160 +1,182 @@
 #!/usr/bin/env python3
-
+import os


please sort imports

arlakshm · 2024-03-25T20:37:53Z

tests/pfc_test.py

+
+class TestPfc(TestPfcBase):
+    @classmethod
+    def setup_class(cls):


teardown needs to be called for TestPfc to set the UTILITIES_UNIT_TESTING to zero

teardown_class is defined in the base class TestPfcBase, it should inherit that method.

In the latest revision, I removed the need for the environment variable UTILITIES_UNIT_TESTING.

arlakshm · 2024-03-25T21:27:12Z

pfc/main.py

-    PFC handler to display asymmetric PFC information.
-    """
-    header = ('Interface', 'Asymmetric')
+        if "UTILITIES_UNIT_TESTING" in os.environ and os.environ["UTILITIES_UNIT_TESTING"] == "2":


why do need this change?

I don't think we need it, it looks like it was just to make writing the test easier but we can just as easily call the config command followed by the show command in the test.

Removed this and changed the way we validate the test case. Please see latest posted change.

arlakshm · 2024-03-25T21:28:08Z

tests/pfc_test.py

+
+    def test_pfc_config_priority(self):
+        self.executor(pfc.cli, ['config', 'priority', 'on', 'Ethernet0', '5'],
+                      expected_output=pfc_config_priority_on)


add test for showPfcPrio ?

It looks like there already is one for showPfcPrio see test_pfc_show_priority_all, test_pfc_show_priority_intf and test_pfc_show_asymmetric_intf_fake

vmittal-msft · 2024-05-16T18:50:08Z

tests/pfc_test.py

+                      expected_output=pfc_config_asymmetric)
+
+    def test_pfc_config_priority(self):
+        self.executor(pfc.cli, ['config', 'priority', 'on', 'Ethernet0', '5'],


@bktsim-arista Can we add "show pfc counter" test as well ? Also, Could we test this change on pizza box as well as chassis ?

@vmittal-msft Adding a test for show pfc counter is out of scope for this PR as show pfc counter is implemented in the pfcstat script. See

sonic-utilities/show/main.py

Lines 637 to 644 in d5287d4

def counters(namespace, display, verbose):

"""Show pfc counters"""

cmd = ['pfcstat', '-s', str(display)]

if namespace is not None:

cmd += ['-n', str(namespace)]

run_command(cmd, display_cmd=verbose)

.

Also, Could we test this change on pizza box as well as chassis ?

This can be done. Though this PR is about refactoring main.py to implement the config/show methods in a class. New unit tests are added as there were no tests prior to this PR.

I confirmed on a T0 switch that the config/show commands in pfc/main.py work as expected. This is not surprising as there is no functional product change in this PR. This PR encapsulates globals methods into a class and adds missing UTs.

This change puts contents originally in pfc/main.py into a class, to support the usage of the multi-asic helper in a future change. This change is required, as multi-asic helper relies on certain members of the class to exist. The multi-asic class helper will be used to add multi-asic support to pfc commands.

kenneth-arista · 2024-05-28T06:04:41Z

Because of the conversion of global methods to class methods, there are lots of white space changes. The best way to review this PR is to ignore whitespace.

Removed the use of the environment variable to test `config asymmetric on`. Instead replaced the validation method with a direct check for the expected CONFIG_DB entry. Also removed the unnecessary classmethods in TestPfcBase.

What I did This change puts contents originally in pfc/main.py into a class, to support the usage of the multi-asic helper in a future change. This change is required, as multi-asic helper being used expects members self.config_db and self.db to exist when a function with the decorator run_on_multi_asic is called. The multi-asic class helper will be used to add multi-asic support to pfc commands in a following pull request. This is a part of the set of changes being pushed for sonic-net/sonic-buildimage#15148 How I did it Moved contents of PFC commands into a class. There are no functional changes. Co-authored-by: rdjeric <[email protected]> Co-authored-by: Kenneth Cheung <[email protected]>

bingwang-ms · 2024-09-06T21:39:44Z

@bktsim-arista Please file a direct PR to 202405 branch to address the conflict.

kenneth-arista · 2024-09-09T03:15:50Z

@bktsim-arista Please file a direct PR to 202405 branch to address the conflict.

There's no need to cherry-pick this PR into 202405 because commit 6447308 is already included. 😄 Can you change the label to already included in 202405?

vmittal-msft requested review from qiluo-msft and vmittal-msft December 13, 2023 01:07

bktsim-arista force-pushed the multi-asic-pfc branch from 001c9c9 to 3f80da0 Compare December 22, 2023 18:43

arlakshm requested a review from deepak-singhal0408 January 10, 2024 20:23

rlhui assigned bktsim-arista Jan 11, 2024

vmittal-msft previously approved these changes Mar 22, 2024

View reviewed changes

arlakshm reviewed Mar 26, 2024

View reviewed changes

arista-nwolfe dismissed vmittal-msft’s stale review via 49590ab May 13, 2024 21:10

arista-nwolfe force-pushed the multi-asic-pfc branch from 3f80da0 to 49590ab Compare May 13, 2024 21:10

vmittal-msft reviewed May 16, 2024

View reviewed changes

rdjeric-arista mentioned this pull request May 17, 2024

Support SONIC cli commands for QoS/MMU configuration/stats for multi-asic sonic-net/sonic-buildimage#15148

Closed

bktsim-arista and others added 9 commits May 28, 2024 02:40

add tests

0aacc29

Fixes to use consistent configdb during testing

666ca91

Miscellaneous linter fixes

29c1681

More miscellaneous linter fixes

15c1bae

Even more linter spacing fixes

5e96eea

Add new test output for asym no-interface test case

4e7731f

Add new test result import

ff4f399

Sorted imports

8566ef7

kenneth-arista force-pushed the multi-asic-pfc branch from 335772e to 8566ef7 Compare May 28, 2024 05:58

Minor tweaks to be more pythonic

735bccd

kenneth-arista force-pushed the multi-asic-pfc branch 3 times, most recently from 28dc1d5 to bad2beb Compare May 29, 2024 03:37

Removed UTILITIES_UNIT_TESTING

cc424b4

Removed the use of the environment variable to test `config asymmetric on`. Instead replaced the validation method with a direct check for the expected CONFIG_DB entry. Also removed the unnecessary classmethods in TestPfcBase.

kenneth-arista force-pushed the multi-asic-pfc branch from bad2beb to cc424b4 Compare May 29, 2024 03:42

arlakshm approved these changes May 31, 2024

View reviewed changes

arlakshm merged commit 6447308 into sonic-net:master May 31, 2024
7 checks passed

kenneth-arista deleted the multi-asic-pfc branch June 2, 2024 02:58

This was referenced Sep 4, 2024

Fix multi-asic behaviour for PFC #3520

Closed

Fix multi-asic support to PFC config/show #3521

Merged

wenyiz2021 added the Request for 202405 Branch label Sep 5, 2024

mssonicbld added the Cherry Pick Conflict_202405 label Sep 5, 2024

bingwang-ms added Included in 202405 Branch and removed Request for 202405 Branch Cherry Pick Conflict_202405 labels Sep 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make PFC commands use a class #3057

Make PFC commands use a class #3057

bktsim-arista commented Nov 30, 2023 •

edited

Loading

arista-nwolfe commented Jan 16, 2024

wenyiz2021 commented Jan 16, 2024

arlakshm commented Jan 17, 2024

arlakshm commented Jan 17, 2024

azure-pipelines bot commented Jan 17, 2024

vmittal-msft commented Mar 25, 2024

azure-pipelines bot commented Mar 25, 2024

arlakshm Mar 25, 2024

rdjeric-arista May 16, 2024

arlakshm Mar 25, 2024

arista-nwolfe Apr 11, 2024

kenneth-arista May 28, 2024

arlakshm Mar 25, 2024

arista-nwolfe Apr 11, 2024

kenneth-arista May 28, 2024

arlakshm Mar 25, 2024

arista-nwolfe Apr 11, 2024

vmittal-msft May 16, 2024

kenneth-arista May 28, 2024 •

edited

Loading

kenneth-arista May 29, 2024

kenneth-arista commented May 28, 2024

bingwang-ms commented Sep 6, 2024

kenneth-arista commented Sep 9, 2024

	def counters(namespace, display, verbose):
	"""Show pfc counters"""

	cmd = ['pfcstat', '-s', str(display)]
	if namespace is not None:
	cmd += ['-n', str(namespace)]

	run_command(cmd, display_cmd=verbose)

Make PFC commands use a class #3057

Make PFC commands use a class #3057

Conversation

bktsim-arista commented Nov 30, 2023 • edited Loading

What I did

How I did it

arista-nwolfe commented Jan 16, 2024

wenyiz2021 commented Jan 16, 2024

arlakshm commented Jan 17, 2024

arlakshm commented Jan 17, 2024

azure-pipelines bot commented Jan 17, 2024

vmittal-msft commented Mar 25, 2024

azure-pipelines bot commented Mar 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kenneth-arista May 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kenneth-arista commented May 28, 2024

bingwang-ms commented Sep 6, 2024

kenneth-arista commented Sep 9, 2024

bktsim-arista commented Nov 30, 2023 •

edited

Loading

kenneth-arista May 28, 2024 •

edited

Loading