Skip to content
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.

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

Fix portstat parser to accommodate new reminder message in portstat output #7537

Merged
merged 1 commit into from
Feb 22, 2023

Conversation

SuvarnaMeenakshi
Copy link
Contributor

Description of PR

Summary:
Fixes # (issue)

Type of change

  • Bug fix
  • Testbed and Framework(new/improvement)
  • Test case(new/improvement)

Back port request

  • 201911
  • 202012
  • 202205

Approach

What is the motivation for this PR?

portstat/test_portstat.py::test_portstat_clear fails with error:

tmp_ok_cnt = before_portstat[intf]['rx_ok'].replace(',','')
>           rx_ok_before = int(0 if tmp_ok_cnt == 'N/A' else tmp_ok_cnt)
E           ValueError: invalid literal for int() with base 10: ''

How did you do it?

With the recent change in portstat cli sonic-net/sonic-utilities#2466, the output of portstat shows a reminder in multi-asic platforms.
This is causing additional lines to be parsed in portstat output.
This change is to avoid parsing the reminder line or empty line in the portstat output.

How did you verify/test it?

Test case passes on multi-asic Linecard after this fix.

Any platform specific information?

Supported testbed topology if it's a new test case?

Documentation

Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>
@wangxin
Copy link
Collaborator

wangxin commented Feb 22, 2023

The pre-commit check detected issues in the files touched by this pull request.
The detected issues may be old or new. For new issues, please try to fix them.

For old issues, it is not mandatory to fix them because they were not caused by this change. It is unfair to blame
author of this pull request. But if you can take extra effort to fix the old issues as well, that would be great!

Detailed pre-commit check results:
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check yaml...........................................(no files to check)Skipped
check for added large files..............................................Passed
check python ast.........................................................Passed
flake8...................................................................Failed
- hook id: flake8
- exit code: 1

tests/common/portstat_utilities.py:69:25: E261 at least two spaces before inline comment

To run the pre-commit checks locally, you can follow below steps:

  1. Ensure that default python is python3. In sonic-mgmt docker container, default python is python2. You can run
    the check by activating the python3 virtual environment in sonic-mgmt docker container or outside of sonic-mgmt
    docker container.
  2. Ensure that the pre-commit package is installed:
sudo pip install pre-commit
  1. Go to repository root folder
  2. Install the pre-commit hooks:
pre-commit install
  1. Use pre-commit to check staged file:
pre-commit
  1. Alternatively, you can check committed files using:
pre-commit run --from-ref <commit_id> --to-ref <commit_id>

@SuvarnaMeenakshi SuvarnaMeenakshi changed the title Fix portstat parser to accommodate new reminder message portstat output Fix portstat parser to accommodate new reminder message in portstat output Feb 22, 2023
@@ -63,7 +65,9 @@ def parse_portstat(content_lines):
return {}

results = {}
for line in content_lines[separation_line_number+1:]:
for line in content_lines[separation_line_number+1:reminder_line_number]:
Copy link
Contributor

Choose a reason for hiding this comment

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

can we change this to:
for line in content_lines[separation_line_number+1:reminder_line_number-1]: ?

there are 3 lines I added to the print, 1st and 3rd are 2 empty lines, 2ns line is the Reminder print, the original error failed at the 1st empty line. In this case we don't need line 69-70 then

Copy link
Contributor

Choose a reason for hiding this comment

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

(Pdb) content_lines[separation_line_number+1:reminder_line_number]
...
u'Ethernet280 X 0 0.00 B/s 0.00% 0 0 0 0 0.00 B/s 0.00% 0 0 0', u'']

the last empty line will be ignored

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I intentionally did not do "[separation_line_number+1:reminder_line_number-1]" to keep it generic for future.
In future release if a Reminder is added without an additional empty line, then "[separation_line_number+1:reminder_line_number-1]" will miss the last line.
Or in case someone adds an additional empty line also.
So I thought we could parse the output from first line after header till line before "Reminder" and skip any empty EOF lines seen in between

Copy link
Contributor

Choose a reason for hiding this comment

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

ok, that makes sense to me

@wenyiz2021
Copy link
Contributor

thanks @SuvarnaMeenakshi for this fix, just added a minor comment

Copy link
Contributor

@wenyiz2021 wenyiz2021 left a comment

Choose a reason for hiding this comment

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

LGTM

@wenyiz2021 wenyiz2021 merged commit 4dfa115 into sonic-net:master Feb 22, 2023
wangxin pushed a commit that referenced this pull request Feb 23, 2023
#7537)

Signed-off-by: Suvarna Meenakshi <sumeenak@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants