Recover default acl rules if necessary in module `crm/test_crm.py`. by yutongzhang-microsoft · Pull Request #9199 · sonic-net/sonic-mgmt

yutongzhang-microsoft · 2023-08-01T05:53:42Z

Description of PR

In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist.

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?

In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist.

How did you do it?

Add a fixture to record the original data plan acl rules and recover them if exist.

How did you verify/test it?

05:46:38 conftest.core_dump_and_config_check      L1767 INFO   | Collecting running config after test on str2-7050qx-32s-acs-02

Any platform specific information?

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

Documentation

mssonicbld · 2023-08-01T05:54:41Z

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.................................................Passed fix end of files.........................................................Failed - hook id: end-of-file-fixer - exit code: 1 - files were modified by this hook Fixing tests/crm/templates/acl.json 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/crm/test_crm.py:862:1: E302 expected 2 blank lines, found 1 tests/crm/test_crm.py:866:5: F841 local variable 'asic_collector' is assigned to but never used tests/crm/test_crm.py:884:121: E501 line too long (121 > 120 characters) tests/crm/test_crm.py:902:1: E302 expected 2 blank lines, found 1 tests/crm/test_crm.py:902:121: E501 line too long (135 > 120 characters) ... [truncated extra lines, please run pre-commit locally to view full check results]

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

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.
Ensure that the pre-commit package is installed:

sudo pip install pre-commit

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

pre-commit install

Use pre-commit to check staged file:

pre-commit

Alternatively, you can check committed files using:

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

…onic-net#9199) Description of PR In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist. What is the motivation for this PR? In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist. How did you do it? Add a fixture to record the original data plan acl rules and recover them if exist. How did you verify/test it? 05:46:38 conftest.core_dump_and_config_check L1767 INFO | Collecting running config after test on str2-7050qx-32s-acs-02 Signed-off-by: Yutong Zhang <[email protected]>

mssonicbld · 2023-08-02T02:52:33Z

@yutongzhang-microsoft PR conflicts with 202012 branch

…onic-net#9199) Description of PR In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist. What is the motivation for this PR? In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist. How did you do it? Add a fixture to record the original data plan acl rules and recover them if exist. How did you verify/test it? 05:46:38 conftest.core_dump_and_config_check L1767 INFO | Collecting running config after test on str2-7050qx-32s-acs-02 Signed-off-by: Yutong Zhang <[email protected]>

mssonicbld · 2023-08-02T02:52:34Z

Cherry-pick PR to 202305: #9225

mssonicbld · 2023-08-02T02:52:35Z

Cherry-pick PR to 202205: #9226

…9199) Description of PR In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist. What is the motivation for this PR? In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist. How did you do it? Add a fixture to record the original data plan acl rules and recover them if exist. How did you verify/test it? 05:46:38 conftest.core_dump_and_config_check L1767 INFO | Collecting running config after test on str2-7050qx-32s-acs-02 Signed-off-by: Yutong Zhang <[email protected]>

…crm/test_crm.py in 202012 (#9249) Description of PR Cherry pick conflict #9199 What is the motivation for this PR? Cherry pick conflict #9199 Signed-off-by: Yutong Zhang <[email protected]>

Description of PR PR #9199 modified the template acl.json under folder tests/crm/templates and added a key input_interface in this template. Only backend topo supports this key, so it will generate an error log in non-backend topo. In this PR, I revert the change to this template. And for recovery, we have another template in PR #9312 . What is the motivation for this PR? PR #9199 modified the template acl.json under folder tests/crm/templates and added a key input_interface in this template. Only backend topo supports this key, so it will generate an error log in non-backend topo. In this PR, I revert the change to this template. And for recovery, we have another template in PR #9312 How did you do it? Revert the change to template acl json. Signed-off-by: Yutong Zhang <[email protected]>

Description of PR PR sonic-net#9199 modified the template acl.json under folder tests/crm/templates and added a key input_interface in this template. Only backend topo supports this key, so it will generate an error log in non-backend topo. In this PR, I revert the change to this template. And for recovery, we have another template in PR sonic-net#9312 . What is the motivation for this PR? PR sonic-net#9199 modified the template acl.json under folder tests/crm/templates and added a key input_interface in this template. Only backend topo supports this key, so it will generate an error log in non-backend topo. In this PR, I revert the change to this template. And for recovery, we have another template in PR sonic-net#9312 How did you do it? Revert the change to template acl json. Signed-off-by: Yutong Zhang <[email protected]>

…st_cacl_function.py`. (#9312) Description of PR In module cacl/test_cacl_function.py, it will use command acl-loader delete to delete all acl rules, no matter if the testbed has DATAACL rules before test or not. If this testbed has DATAACL rules before, this deletion will cause inconsistent between previous running config and current running config, and will cause unnecessary config reload. In PR #9199 , we have a fixture recover_acl_rule to recovery acl rules. So in this PR, I refactor this fixture and use this fixture to recover acl rules in module cacl/test_cacl_function.py. What is the motivation for this PR? In module cacl/test_cacl_function.py, it will use command acl-loader delete to delete all acl rules, no matter if the testbed has DATAACL rules before test or not. If this testbed has DATAACL rules before, this deletion will cause inconsistent between previous running config and current running config, and will cause unnecessary config reload. In PR #9199 , we have a fixture recover_acl_rule to recovery acl rules. So in this PR, I refactor this fixture and use this fixture to recover acl rules in module cacl/test_cacl_function.py. How did you do it? Move fixture recover_acl_rule to tests/conftest.py and use this fixture to recover acl rules in module cacl/test_cacl_function.py. How did you verify/test it? ``` 07:34:42 conftest.core_dump_and_config_check L1893 INFO | Core dump and config check passed for cacl/test_cacl_function.py ``` Signed-off-by: Yutong Zhang <[email protected]>

Description of PR PR #9199 modified the template acl.json under folder tests/crm/templates and added a key input_interface in this template. Only backend topo supports this key, so it will generate an error log in non-backend topo. In this PR, I revert the change to this template. And for recovery, we have another template in PR #9312 . What is the motivation for this PR? PR #9199 modified the template acl.json under folder tests/crm/templates and added a key input_interface in this template. Only backend topo supports this key, so it will generate an error log in non-backend topo. In this PR, I revert the change to this template. And for recovery, we have another template in PR #9312 How did you do it? Revert the change to template acl json. Signed-off-by: Yutong Zhang <[email protected]>

…st_cacl_function.py`. (sonic-net#9312) Description of PR In module cacl/test_cacl_function.py, it will use command acl-loader delete to delete all acl rules, no matter if the testbed has DATAACL rules before test or not. If this testbed has DATAACL rules before, this deletion will cause inconsistent between previous running config and current running config, and will cause unnecessary config reload. In PR sonic-net#9199 , we have a fixture recover_acl_rule to recovery acl rules. So in this PR, I refactor this fixture and use this fixture to recover acl rules in module cacl/test_cacl_function.py. What is the motivation for this PR? In module cacl/test_cacl_function.py, it will use command acl-loader delete to delete all acl rules, no matter if the testbed has DATAACL rules before test or not. If this testbed has DATAACL rules before, this deletion will cause inconsistent between previous running config and current running config, and will cause unnecessary config reload. In PR sonic-net#9199 , we have a fixture recover_acl_rule to recovery acl rules. So in this PR, I refactor this fixture and use this fixture to recover acl rules in module cacl/test_cacl_function.py. How did you do it? Move fixture recover_acl_rule to tests/conftest.py and use this fixture to recover acl rules in module cacl/test_cacl_function.py. How did you verify/test it? ``` 07:34:42 conftest.core_dump_and_config_check L1893 INFO | Core dump and config check passed for cacl/test_cacl_function.py ``` Signed-off-by: Yutong Zhang <[email protected]>

…st_cacl_function.py`. (#9312) Description of PR In module cacl/test_cacl_function.py, it will use command acl-loader delete to delete all acl rules, no matter if the testbed has DATAACL rules before test or not. If this testbed has DATAACL rules before, this deletion will cause inconsistent between previous running config and current running config, and will cause unnecessary config reload. In PR #9199 , we have a fixture recover_acl_rule to recovery acl rules. So in this PR, I refactor this fixture and use this fixture to recover acl rules in module cacl/test_cacl_function.py. What is the motivation for this PR? In module cacl/test_cacl_function.py, it will use command acl-loader delete to delete all acl rules, no matter if the testbed has DATAACL rules before test or not. If this testbed has DATAACL rules before, this deletion will cause inconsistent between previous running config and current running config, and will cause unnecessary config reload. In PR #9199 , we have a fixture recover_acl_rule to recovery acl rules. So in this PR, I refactor this fixture and use this fixture to recover acl rules in module cacl/test_cacl_function.py. How did you do it? Move fixture recover_acl_rule to tests/conftest.py and use this fixture to recover acl rules in module cacl/test_cacl_function.py. How did you verify/test it? ``` 07:34:42 conftest.core_dump_and_config_check L1893 INFO | Core dump and config check passed for cacl/test_cacl_function.py ``` Signed-off-by: Yutong Zhang <[email protected]>

…onic-net#9199) Description of PR In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist. What is the motivation for this PR? In module crm/test_crm.py, it will delete all acl rules after test running. But of DUT has original data plan acl rules, they are also deleted, and will cause inconsistent between previous running config and current running config. In this PR, we will recover original acl rules if exist. How did you do it? Add a fixture to record the original data plan acl rules and recover them if exist. How did you verify/test it? 05:46:38 conftest.core_dump_and_config_check L1767 INFO | Collecting running config after test on str2-7050qx-32s-acs-02 Signed-off-by: Yutong Zhang <[email protected]>

Description of PR PR sonic-net#9199 modified the template acl.json under folder tests/crm/templates and added a key input_interface in this template. Only backend topo supports this key, so it will generate an error log in non-backend topo. In this PR, I revert the change to this template. And for recovery, we have another template in PR sonic-net#9312 . What is the motivation for this PR? PR sonic-net#9199 modified the template acl.json under folder tests/crm/templates and added a key input_interface in this template. Only backend topo supports this key, so it will generate an error log in non-backend topo. In this PR, I revert the change to this template. And for recovery, we have another template in PR sonic-net#9312 How did you do it? Revert the change to template acl json. Signed-off-by: Yutong Zhang <[email protected]>

…st_cacl_function.py`. (sonic-net#9312) Description of PR In module cacl/test_cacl_function.py, it will use command acl-loader delete to delete all acl rules, no matter if the testbed has DATAACL rules before test or not. If this testbed has DATAACL rules before, this deletion will cause inconsistent between previous running config and current running config, and will cause unnecessary config reload. In PR sonic-net#9199 , we have a fixture recover_acl_rule to recovery acl rules. So in this PR, I refactor this fixture and use this fixture to recover acl rules in module cacl/test_cacl_function.py. What is the motivation for this PR? In module cacl/test_cacl_function.py, it will use command acl-loader delete to delete all acl rules, no matter if the testbed has DATAACL rules before test or not. If this testbed has DATAACL rules before, this deletion will cause inconsistent between previous running config and current running config, and will cause unnecessary config reload. In PR sonic-net#9199 , we have a fixture recover_acl_rule to recovery acl rules. So in this PR, I refactor this fixture and use this fixture to recover acl rules in module cacl/test_cacl_function.py. How did you do it? Move fixture recover_acl_rule to tests/conftest.py and use this fixture to recover acl rules in module cacl/test_cacl_function.py. How did you verify/test it? ``` 07:34:42 conftest.core_dump_and_config_check L1893 INFO | Core dump and config check passed for cacl/test_cacl_function.py ``` Signed-off-by: Yutong Zhang <[email protected]>

Recover default acl rules

6d6b8ba

yutongzhang-microsoft added Request for 202012 branch Request for 202205 branch labels Aug 1, 2023

wangxin previously approved these changes Aug 1, 2023

View reviewed changes

pre-commit

ea8d111

yutongzhang-microsoft dismissed wangxin’s stale review via ea8d111 August 1, 2023 06:02

wangxin approved these changes Aug 1, 2023

View reviewed changes

yutongzhang-microsoft merged commit e26ca23 into sonic-net:master Aug 1, 2023

yutongzhang-microsoft deleted the yutongzhang/test_crm branch August 1, 2023 08:02

wangxin added Request for 202305 branch Approved for 202012 Branch Approved for 202205 branch Approved for 202305 branch labels Aug 2, 2023

mssonicbld added the Cherry Pick Conflict_202012 label Aug 2, 2023

mssonicbld added the Created PR to 202305 branch label Aug 2, 2023

mssonicbld added the Created PR to 202205 branch label Aug 2, 2023

This was referenced Aug 2, 2023

[action] [PR:9199] Recover default acl rules if necessary in module crm/test_crm.py. #9225

Merged

[action] [PR:9199] Recover default acl rules if necessary in module crm/test_crm.py. #9226

Merged

mssonicbld added Included in 202205 branch and removed Created PR to 202205 branch labels Aug 2, 2023

mssonicbld added Included in 202305 branch and removed Created PR to 202305 branch labels Aug 2, 2023

yutongzhang-microsoft added a commit to yutongzhang-microsoft/sonic-mgmt that referenced this pull request Aug 3, 2023

cherry pick conflict sonic-net#9199

4b51a23

yutongzhang-microsoft mentioned this pull request Aug 3, 2023

[cherry pick] #9199 Recover default acl rules if necessary in module crm/test_crm.py in 202012 #9249

Merged

6 tasks

wangxin added the Included in 202012 branch label Aug 4, 2023

yutongzhang-microsoft removed the Cherry Pick Conflict_202012 label Aug 7, 2023

This was referenced Aug 7, 2023

Refactor fixture recover_acl_rule and and use it in module cacl/test_cacl_function.py. #9312

Merged

Revert the change to template acl.json. #9346

Merged

ysmanman mentioned this pull request Aug 9, 2023

crm test failed because of 'Unknown or invalid rule attribute 'IN_PORTS:' #9368

Closed

This was referenced Aug 10, 2023

[action] [PR:9346] Revert the change to template acl.json. #9382

Merged

[action] [PR:9346] Revert the change to template acl.json. #9381

Merged

mssonicbld mentioned this pull request Aug 10, 2023

[action] [PR:9346] Revert the change to template acl.json. #9383

Merged

6 tasks

mssonicbld mentioned this pull request Aug 17, 2023

[action] [PR:9312] Refactor fixture recover_acl_rule and and use it in module cacl/test_cacl_function.py. #9524

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Recover default acl rules if necessary in module `crm/test_crm.py`. #9199

Recover default acl rules if necessary in module `crm/test_crm.py`. #9199
yutongzhang-microsoft merged 2 commits intosonic-net:masterfrom
yutongzhang-microsoft:yutongzhang/test_crm

yutongzhang-microsoft commented Aug 1, 2023

Uh oh!

mssonicbld commented Aug 1, 2023

Uh oh!

mssonicbld commented Aug 2, 2023

Uh oh!

mssonicbld commented Aug 2, 2023

Uh oh!

mssonicbld commented Aug 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

yutongzhang-microsoft commented Aug 1, 2023

Description of PR

Type of change

Back port request

Approach

What is the motivation for this PR?

How did you do it?

How did you verify/test it?

Any platform specific information?

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

Documentation

Uh oh!

mssonicbld commented Aug 1, 2023

Uh oh!

mssonicbld commented Aug 2, 2023

Uh oh!

mssonicbld commented Aug 2, 2023

Uh oh!

mssonicbld commented Aug 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants