[pre-commit] Use correct comment format # noqa: not # noqa in tests common files (sonic-net#17652)

What is the motivation for this PR?
In pre-commit, we were using # noqa to ignore failures/errors/warnings in our code, but once we use # noqa, it will ignore all pre-commit errors in this line, the correct solution is using # noqa: so only specific failures/errors/warnings would be ignored.

How did you do it?
Replace # noqa with # noqa: in tests common files

How did you verify/test it?

Author: xwjiang-ms

tests/common/cache/facts_cache.py

@@ -202,7 +202,7 @@ def _get_default_zone(function, func_args, func_kargs):
         Add the namespace to the default zone.
     """
     hostname = None
-    unicode_type = str if sys.version_info.major >= 3 else unicode      # noqa F821
+    unicode_type = str if sys.version_info.major >= 3 else unicode      # noqa: F821
     if func_args:
         hostname = getattr(func_args[0], "hostname", None)
     if not hostname or type(hostname) not in [str, unicode_type]:

tests/common/devices/duthosts.py

@@ -171,7 +171,7 @@ def __getitem__(self, index):
         Returns:
             [MultiAsicSonicHost]: Returns the specified duthost in duthosts. It is an instance of MultiAsicSonicHost.
         """
-        unicode_type = str if sys.version_info.major >= 3 else unicode      # noqa F821
+        unicode_type = str if sys.version_info.major >= 3 else unicode      # noqa: F821
         if type(index) == int:
             return self.nodes[index]
         elif type(index) in [str, unicode_type]:

tests/common/devices/sonic.py

@@ -1666,11 +1666,11 @@ def show_and_parse(self, show_cmd, header_len=1, **kwargs):
         For example, part of the output of command 'show interface status':
 
         admin@str-msn2700-02:~$ show interface status
-              Interface            Lanes    Speed    MTU    FEC    Alias             Vlan    Oper    Admin             Type    Asym PFC     # noqa E501
-        ---------------  ---------------  -------  -----  -----  -------  ---------------  ------  -------  ---------------  ----------     # noqa E501
-              Ethernet0          0,1,2,3      40G   9100    N/A     etp1  PortChannel0002      up       up   QSFP+ or later         off     # noqa E501
-              Ethernet4          4,5,6,7      40G   9100    N/A     etp2  PortChannel0002      up       up   QSFP+ or later         off     # noqa E501
-              Ethernet8        8,9,10,11      40G   9100    N/A     etp3  PortChannel0005      up       up   QSFP+ or later         off     # noqa E501
+              Interface            Lanes    Speed    MTU    FEC    Alias             Vlan    Oper    Admin             Type    Asym PFC     # noqa: E501
+        ---------------  ---------------  -------  -----  -----  -------  ---------------  ------  -------  ---------------  ----------     # noqa: E501
+              Ethernet0          0,1,2,3      40G   9100    N/A     etp1  PortChannel0002      up       up   QSFP+ or later         off     # noqa: E501
+              Ethernet4          4,5,6,7      40G   9100    N/A     etp2  PortChannel0002      up       up   QSFP+ or later         off     # noqa: E501
+              Ethernet8        8,9,10,11      40G   9100    N/A     etp3  PortChannel0005      up       up   QSFP+ or later         off     # noqa: E501
         ...
 
         The parsed example will be like:

tests/common/dualtor/__init__.py

@@ -1,4 +1,4 @@
-from tests.common.dualtor.dual_tor_utils import *               # noqa F401
-from tests.common.dualtor.mux_simulator_control import *        # noqa F401
-from tests.common.dualtor.nic_simulator_control import *        # noqa F401
-from tests.common.dualtor.dual_tor_common import *              # noqa F401
+from tests.common.dualtor.dual_tor_utils import *               # noqa: F401 F403
+from tests.common.dualtor.mux_simulator_control import *        # noqa: F401 F403
+from tests.common.dualtor.nic_simulator_control import *        # noqa: F401 F403
+from tests.common.dualtor.dual_tor_common import *              # noqa: F401 F403

tests/common/dualtor/data_plane_utils.py

@@ -6,9 +6,9 @@
 import random
 import shutil
 
-from tests.common.dualtor.dual_tor_common import active_active_ports        # noqa F401
-from tests.common.dualtor.dual_tor_common import active_standby_ports       # noqa F401
-from tests.common.dualtor.dual_tor_common import cable_type     # noqa F401
+from tests.common.dualtor.dual_tor_common import active_active_ports        # noqa: F401
+from tests.common.dualtor.dual_tor_common import active_standby_ports       # noqa: F401
+from tests.common.dualtor.dual_tor_common import cable_type     # noqa: F401
 from tests.common.dualtor.dual_tor_common import CableType
 from tests.common.dualtor.dual_tor_io import DualTorIO
 from tests.common.helpers.assertions import pytest_assert
@@ -161,7 +161,7 @@ def verify_and_report(tor_IO, verify, delay, allowed_disruption,
 def run_test(
     duthosts, activehost, ptfhost, ptfadapter, vmhost, action,
     tbinfo, tor_vlan_port, send_interval, traffic_direction,
-    stop_after, cable_type=CableType.active_standby, random_dst=None     # noqa F811
+    stop_after, cable_type=CableType.active_standby, random_dst=None     # noqa: F811
 ):
     io_ready = threading.Event()
 
@@ -245,7 +245,7 @@ def save_pcap(request, pytestconfig):
 
 @pytest.fixture
 def send_t1_to_server_with_action(duthosts, ptfhost, ptfadapter, tbinfo,
-                                  cable_type, vmhost, save_pcap):       # noqa F811
+                                  cable_type, vmhost, save_pcap):       # noqa: F811
     """
     Starts IO test from T1 router to server.
     As part of IO test the background thread sends and sniffs packets.
@@ -311,7 +311,7 @@ def t1_to_server_io_test(activehost, tor_vlan_port=None,
 
 @pytest.fixture
 def send_server_to_t1_with_action(duthosts, ptfhost, ptfadapter, tbinfo,
-                                  cable_type, vmhost, save_pcap):   # noqa F811
+                                  cable_type, vmhost, save_pcap):   # noqa: F811
     """
     Starts IO test from server to T1 router.
     As part of IO test the background thread sends and sniffs packets.
@@ -381,7 +381,7 @@ def server_to_t1_io_test(activehost, tor_vlan_port=None,
 
 @pytest.fixture
 def send_soc_to_t1_with_action(duthosts, ptfhost, ptfadapter, tbinfo,
-                               cable_type, vmhost, save_pcap):      # noqa F811
+                               cable_type, vmhost, save_pcap):      # noqa: F811
 
     arp_setup(ptfhost)
 
@@ -410,7 +410,7 @@ def soc_to_t1_io_test(activehost, tor_vlan_port=None,
 
 @pytest.fixture
 def send_t1_to_soc_with_action(duthosts, ptfhost, ptfadapter, tbinfo,
-                               cable_type, vmhost, save_pcap):      # noqa F811
+                               cable_type, vmhost, save_pcap):      # noqa: F811
 
     arp_setup(ptfhost)
 
@@ -440,10 +440,10 @@ def t1_to_soc_io_test(activehost, tor_vlan_port=None,
 
 
 @pytest.fixture
-def select_test_mux_ports(active_active_ports, active_standby_ports):                               # noqa F811
+def select_test_mux_ports(active_active_ports, active_standby_ports):                               # noqa: F811
     """Return helper function to select test mux ports based on cable_type"""
 
-    def _select_test_mux_ports(cable_type, count):                                                  # noqa F811
+    def _select_test_mux_ports(cable_type, count):                                                  # noqa: F811
         if cable_type == CableType.active_active:
             test_mux_ports = random.sample(active_active_ports, count)
         elif cable_type == CableType.active_standby:
@@ -457,7 +457,7 @@ def _select_test_mux_ports(cable_type, count):
 
 @pytest.fixture
 def send_server_to_server_with_action(duthosts, ptfhost, ptfadapter, tbinfo,
-                                      cable_type, vmhost, save_pcap):   # noqa F811
+                                      cable_type, vmhost, save_pcap):   # noqa: F811
 
     arp_setup(ptfhost)
 

tests/common/dualtor/dual_tor_mock.py

@@ -8,7 +8,7 @@
 from ipaddress import ip_interface, IPv4Interface, IPv6Interface, \
                       ip_address, IPv4Address
 from tests.common import config_reload
-from tests.common.dualtor.dual_tor_utils import tor_mux_intfs       # noqa F401
+from tests.common.dualtor.dual_tor_utils import tor_mux_intfs       # noqa: F401
 from tests.common.helpers.assertions import pytest_assert
 from tests.common.platform.processes_utils import wait_critical_processes
 from tests.common.utilities import wait_until
@@ -64,7 +64,7 @@ def _apply_config_to_swss(dut, swss_config_str, swss_filename='swss_config_file'
     dut.shell('docker exec swss sh -c "swssconfig {}"'.format(swss_filename))
 
 
-def set_dual_tor_state_to_orchagent(dut, state, tor_mux_intfs):         # noqa F811
+def set_dual_tor_state_to_orchagent(dut, state, tor_mux_intfs):         # noqa: F811
     """
     Helper function for setting active/standby state to orchagent
     """
@@ -104,7 +104,7 @@ def check_config_applied(num_tor_mux_intfs):
     wait_until(120, 5, 5, check_config_applied, len(tor_mux_intfs))
 
 
-def del_dual_tor_state_from_orchagent(dut, state, tor_mux_intfs):       # noqa F811
+def del_dual_tor_state_from_orchagent(dut, state, tor_mux_intfs):       # noqa: F811
     """
     Helper function for deleting active/standby state to orchagent
     """
@@ -127,7 +127,7 @@ def del_dual_tor_state_from_orchagent(dut, state, tor_mux_intfs):       # noqa F
     _apply_config_to_swss(dut, swss_config_str, swss_filename)
 
 
-def _apply_dual_tor_state_to_orchagent(dut, state, tor_mux_intfs):      # noqa F811
+def _apply_dual_tor_state_to_orchagent(dut, state, tor_mux_intfs):      # noqa: F811
     '''
     Helper function to configure active/standby state in orchagent
 
@@ -158,15 +158,15 @@ def set_mux_state(dut, tbinfo, state, itfs, toggle_all_simulator_ports):
 
 
 @pytest.fixture(scope='module')
-def apply_active_state_to_orchagent(rand_selected_dut, tor_mux_intfs):      # noqa F811
+def apply_active_state_to_orchagent(rand_selected_dut, tor_mux_intfs):      # noqa: F811
     dut = rand_selected_dut
 
     for func in _apply_dual_tor_state_to_orchagent(dut, 'active', tor_mux_intfs):
         yield func
 
 
 @pytest.fixture(scope='module')
-def apply_standby_state_to_orchagent(rand_selected_dut, tor_mux_intfs):     # noqa F811
+def apply_standby_state_to_orchagent(rand_selected_dut, tor_mux_intfs):     # noqa: F811
     dut = rand_selected_dut
 
     for func in _apply_dual_tor_state_to_orchagent(dut, 'standby', tor_mux_intfs):
@@ -230,7 +230,7 @@ def mock_server_base_ip_addr(rand_selected_dut, tbinfo):
 
 @pytest.fixture(scope='module')
 def mock_server_ip_mac_map(rand_selected_dut, tbinfo, ptfadapter,
-                           mock_server_base_ip_addr, tor_mux_intfs):     # noqa F811
+                           mock_server_base_ip_addr, tor_mux_intfs):     # noqa: F811
     dut = rand_selected_dut
 
     server_ipv4_base_addr, _ = mock_server_base_ip_addr
@@ -257,7 +257,7 @@ def mock_server_ip_mac_map(rand_selected_dut, tbinfo, ptfadapter,
 
 @pytest.fixture(scope='module')
 def mock_server_ipv6_mac_map(rand_selected_dut, tbinfo, ptfadapter,
-                             mock_server_base_ip_addr, tor_mux_intfs):      # noqa F811
+                             mock_server_base_ip_addr, tor_mux_intfs):      # noqa: F811
     dut = rand_selected_dut
     _, server_ipv6_base_addr = mock_server_base_ip_addr
     server_ipv6_mac_map = {}
@@ -415,7 +415,7 @@ def check_config_applied(tunnel_params):
 
 @pytest.fixture(scope='module')
 def apply_mux_cable_table_to_dut(cleanup_mocked_configs, rand_selected_dut,
-                                 mock_server_base_ip_addr, tor_mux_intfs):      # noqa F811
+                                 mock_server_base_ip_addr, tor_mux_intfs):      # noqa: F811
     '''
     Adds the MUX_CABLE table to config DB
     '''