Fix test execution on Bookworm (#3041)

saiarcot895 · lguohan · commit 0ab3ab91e20c · 2023-11-22T12:45:23.000-08:00
* Fix test execution on Bookworm

Running tests with `python3 -m pytest` instead of `python setup.py test`
causes some breakages on Bookworm. Some of this has to do with what
module searc paths get added, while others appear to be related to
changes in the `mock` module between Python 3.9 and Python 3.11.

Fix this and make sure it works on both Bullseye and Bookworm.

* Fix mclag_test.py having different results for some test cases

The test_mclag_add_mclag_member_to_nonexisting_domain test case passes
when run on Bullseye, but fails on Bookworm. This is because some test
cases modify the value of `mclag.ADHOC_VALIDATION`, but this value may
persist for other test cases as well, and if test cases happen to run in
a different order, then it may unexpectedly fail.

For now, fix `test_mclag_add_mclag_member_to_nonexisting_domain` by
setting the value there.

* Add check_output parameter to the setup function due to the patch

Since there is a patched function specified as an attribute, newer
versions of mock expect that the object can be passed in as a parameter
to the function. However, the `setup` functions didn't accept it as a
parameter.

Modify the `setup` functions to accept a parameter for this object.

Signed-off-by: Saikrishna Arcot &lt;sarcot@microsoft.com&gt;

---------

Signed-off-by: Saikrishna Arcot &lt;sarcot@microsoft.com&gt;
diff --git a/pytest.ini b/pytest.ini
@@ -1,2 +1,3 @@
 [pytest]
 addopts = --cov-config=.coveragerc --cov --cov-report html --cov-report term --cov-report xml --junitxml=test-results.xml -vv
+pythonpath = .
diff --git a/tests/chassis_modules_test.py b/tests/chassis_modules_test.py
@@ -2,10 +2,6 @@
 import os
 from click.testing import CliRunner
 
-test_path = os.path.dirname(os.path.abspath(__file__))
-modules_path = os.path.dirname(test_path)
-sys.path.insert(0, modules_path)
-
 import show.main as show
 import config.main as config
 import tests.mock_tables.dbconnector
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -60,6 +60,13 @@
     'snmp.timer',
     'telemetry.timer']
 
+@pytest.fixture(autouse=True)
+def setup_env():
+    # This is needed because we call scripts from this module as a separate
+    # process when running tests, and so the PYTHONPATH needs to be set
+    # correctly for those scripts to run.
+    if "PYTHONPATH" not in os.environ:
+        os.environ["PYTHONPATH"] = os.getcwd()
 
 @pytest.fixture
 def get_cmd_module():
diff --git a/tests/debug_test.py b/tests/debug_test.py
@@ -6,7 +6,7 @@
 
 class TestDebugFrr(object):
     @patch('subprocess.check_output', MagicMock(return_value='FRRouting'))
-    def setup(self):
+    def setup(self, check_output = None):
         print('SETUP')
         import debug.main as debug
         import undebug.main as undebug
@@ -379,7 +379,7 @@ def test_undebug_zebra_vxlan(self, run_command):
 
 class TestDebugQuagga(object):
     @patch('subprocess.check_output', MagicMock(return_value='quagga'))
-    def setup(self):
+    def setup(self, check_output = None):
         print('SETUP')
         import debug.main as debug
         import undebug.main as undebug
diff --git a/tests/decode_syseeprom_test.py b/tests/decode_syseeprom_test.py
@@ -17,7 +17,7 @@
 
 
 decode_syseeprom_path = os.path.join(scripts_path, 'decode-syseeprom')
-decode_syseeprom = load_module_from_source('decode-syseeprom', decode_syseeprom_path)
+decode_syseeprom = load_module_from_source('decode_syseeprom', decode_syseeprom_path)
 
 # Replace swsscommon objects with mocked objects
 decode_syseeprom.SonicV2Connector = dbconnector.SonicV2Connector
@@ -195,8 +195,9 @@ def test_print_model(self, capsys):
 
     @mock.patch('os.geteuid', lambda: 0)
     @mock.patch('sonic_py_common.device_info.get_platform', lambda: 'arista')
-    @mock.patch('decode-syseeprom.read_and_print_eeprom')
-    @mock.patch('decode-syseeprom.read_eeprom_from_db')
+    @mock.patch.object(sys, 'argv', ["decode-syseeprom"])
+    @mock.patch('decode_syseeprom.read_and_print_eeprom')
+    @mock.patch('decode_syseeprom.read_eeprom_from_db')
     def test_support_platforms_not_db_based(self, mockDbBased, mockNotDbBased):
         decode_syseeprom.main()
         assert mockNotDbBased.called
diff --git a/tests/mclag_test.py b/tests/mclag_test.py
@@ -360,6 +360,8 @@ def test_mclag_session_timeout(self):
 
 
     def test_mclag_add_mclag_member_to_nonexisting_domain(self):
+        # This is required for the add command to fail; otherwise, it incorrectly passes
+        mclag.ADHOC_VALIDATION = True
         runner = CliRunner()
         db = Db()
         obj = {'db':db.cfgdb}
diff --git a/tests/muxcable_test.py b/tests/muxcable_test.py

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`[pytest]`
`2`	`2`	`addopts = --cov-config=.coveragerc --cov --cov-report html --cov-report term --cov-report xml --junitxml=test-results.xml -vv`
	`3`	`+pythonpath = .`