Skip to content

Commit

Permalink
Fix customMsg from unexpected fanity failure (#14792)
Browse files Browse the repository at this point in the history
New feature delivered recently, add customMsg for sanity check failures, was causing unexpected sanity_check results. This was due to premature cache key reset of pre_sanity_check_failed and post_sanity_check_failed. Removed those two keys from getting reset before sessionfinish to resolve the issue

Important cache keys, used to determine session exit status:
pre_sanity_check_failed & post_sanity_check_failed => These combination of keys will return exit status 10, 11, 12
10 = PRE_SANITY_CHECK_FAILED_RC
11 = POST_SANITY_CHECK_FAILED_RC
12 = SANITY_CHECK_FAILED_RC

duthosts_fixture_failed => If this is true, we return exit status code 15
15 = DUTHOSTS_FIXTURE_FAILED_RC

Description of PR
Summary:
New feature delivered recently, add customMsg for sanity check failures, was causing unexpected sanity_check results. This was due to premature cache key reset of pre_sanity_check_failed and post_sanity_check_failed. Removed those two keys from getting reset before sessionfinish to resolve the issue

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?
How did you do it?
Remove premature cache reset of pre_sanity_check_failed and post_sanity_check_failed, before it reaches sessionfinish

How did you verify/test it?
Manually tested, simulating pre_sanity_checked_failed and post_sanity_check_failed, to observe expected exit satus codes from 10,11, and 12.
Exit status code can be retrieved and displayed, using 'echo $?'
eg:
image

co-authorized by: [email protected]
  • Loading branch information
augusdn authored and mssonicbld committed Sep 30, 2024
1 parent fbfef99 commit 3412a8c
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions tests/common/plugins/sanity_check/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,9 @@
SUPPORTED_CHECKS = checks.CHECK_ITEMS
DUT_CHEK_LIST = ['core_dump_check_pass', 'config_db_check_pass']
CACHE_LIST = ['core_dump_check_pass', 'config_db_check_pass',
'pre_sanity_check_failed', 'post_sanity_check_failed',
'pre_sanity_recovered', 'post_sanity_recovered']


def reset_cache_list(request):
for item in CACHE_LIST:
request.config.cache.set(item, None)


def pytest_sessionfinish(session, exitstatus):

pre_sanity_failed = session.config.cache.get("pre_sanity_check_failed", None)
Expand Down Expand Up @@ -170,8 +164,6 @@ def log_custom_msg(request):
logger.debug("customMsgDict: {}".format(customMsgDict))
item.user_properties.append(('CustomMsg', json.dumps(customMsgDict)))

reset_cache_list(request)


@pytest.fixture(scope="module")
def sanity_check_full(localhost, duthosts, request, fanouthosts, nbrhosts, tbinfo):
Expand Down

0 comments on commit 3412a8c

Please sign in to comment.