implement memory utilization fixture

[lipxu]

Description of PR

Summary:
Fixes # (issue)
27216861

Type of change

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

Back port request

• 202012
• 202205
• 202305
• 202311
• 202405

Approach

What is the motivation for this PR?

Test gap for memory leak

How did you do it?

Introduced a new fixture to collect the memory information before and after the test case.
Then compare the memory information to confirm that it has not exceeded the high memory usage threshold and that no memory leaks have occurred.

How did you verify/test it?

Run case locally.
Set a fake threshold, check the result.
Run nightly pipeline.

Any platform specific information?

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

Documentation

[wsycqyz]

/azp run

[azure-pipelines]

Commenter does not have sufficient privileges for PR 13698 in repo sonic-net/sonic-mgmt

[StormLiangMS]

@lipxu could we have an example to give when this check passed / failed?

[lipxu]

@lipxu could we have an example to give when this check passed / failed?

Sure, added the examples for supported memory items.

[mssonicbld]

The pre-commit check detected issues in the files touched by this pull request.
The pre-commit check is a mandatory check, please fix detected issues.

Detailed pre-commit check results:
trim trailing whitespace.................................................Failed
- hook id: trailing-whitespace
- exit code: 1
- files were modified by this hook

Fixing tests/common/plugins/memory_utilization/README.md

fix end of files.........................................................Failed
- hook id: end-of-file-fixer
- exit code: 1
- files were modified by this hook

Fixing tests/common/plugins/memory_utilization/README.md

check yaml...........................................(no files to check)Skipped
check for added large files..............................................Passed
check python ast.........................................................Passed
flake8...................................................................Passed
flake8...............................................(no files to check)Skipped
check conditional mark sort..........................(no files to check)Skipped

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

3. Go to repository root folder
4. Install the pre-commit hooks:

pre-commit install

5. Use pre-commit to check staged file:

pre-commit

6. Alternatively, you can check committed files using:

pre-commit run --from-ref <commit_id> --to-ref <commit_id>

[StormLiangMS]

/azp run Azure.sonic-mgmt

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[StormLiangMS]

/azp run Azure.sonic-mgmt

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[lipxu]

/azp run Azure.sonic-mgmt

[azure-pipelines]

Commenter does not have sufficient privileges for PR 13698 in repo sonic-net/sonic-mgmt

[StormLiangMS]

hi @lipxu should we consider when this fixture can kick in? if it is after teardown, it may not work as expected since all process could be already reloaded without memory leak evidence.

[lipxu]

hi @lipxu should we consider when this fixture can kick in? if it is after teardown, it may not work as expected since all process could be already reloaded without memory leak evidence.

I've updated the branch by adding the following two functions and adjusted the setup to use "trylast" and teardown to use "tryfirst". This will allow memory utilization to collect the memory information before and after the test case. ensuring accurate capture memory usage of the test case.

@pytest.hookimpl(trylast=True)
def pytest_runtest_setup(item):

@pytest.hookimpl(tryfirst=True)
def pytest_runtest_teardown(item, nextitem):

[StormLiangMS]

LGTM

[StormLiangMS]

hi @lipxu LGTM, could you work with other reviewers to close the comment before we get this merged?