tests: replace pycodestyle with black

Drop pycodestyle for code style checking in favor of black. Black is
much faster, stable PEP8 compliant code style checker offering also
automatic formatting. It aims to be very stable and produce smallest
diffs. It's used by many small and big projects.

Running checkstyle with black takes a few seconds with a terse output.
Thus, test-checkstyle-diff is no longer necessary.

Expand scope of checkstyle to all python files in the repo, replacing
test-checkstyle with checkstyle-python.

Also, fixstyle-python is now available for automatic style formatting.

Note: python virtualenv has been consolidated in test/Makefile,
test/requirements*.txt which will eventually be moved to a central
location.  This is required to simply the automated generation of
docker executor images in the CI.

Type: improvement
Change-Id: I022a326603485f58585e879ac0f697fceefbc9c8
Signed-off-by: Klement Sekera <klement.sekera@gmail.com>
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>

1 files changed, 154 insertions, 132 deletions

diff --git a/test/test_vtr.py b/test/test_vtr.py
index c3704f1e7b6..b33dcb66541 100644
--- a/test/test_vtr.py
+++ b/test/test_vtr.py
@@ -12,13 +12,13 @@ from framework import VppTestCase, VppTestRunner
 from vpp_sub_interface import L2_VTR_OP, VppDot1QSubint, VppDot1ADSubint
 from collections import namedtuple
 
-Tag = namedtuple('Tag', ['dot1', 'vlan'])
+Tag = namedtuple("Tag", ["dot1", "vlan"])
 DOT1AD = 0x88A8
 DOT1Q = 0x8100
 
 
 class TestVtr(VppTestCase):
-    """ VTR Test Case """
+    """VTR Test Case"""
 
     @classmethod
     def setUpClass(cls):
@@ -36,9 +36,9 @@ class TestVtr(VppTestCase):
             cls.create_pg_interfaces(ifs)
 
             cls.sub_interfaces = [
-                VppDot1ADSubint(cls, cls.pg1, cls.dot1ad_sub_id,
-                                cls.Btag, cls.Atag),
-                VppDot1QSubint(cls, cls.pg2, cls.Btag)]
+                VppDot1ADSubint(cls, cls.pg1, cls.dot1ad_sub_id, cls.Btag, cls.Atag),
+                VppDot1QSubint(cls, cls.pg2, cls.Btag),
+            ]
 
             interfaces = list(cls.pg_interfaces)
             interfaces.extend(cls.sub_interfaces)
@@ -46,10 +46,14 @@ class TestVtr(VppTestCase):
             # Create BD with MAC learning enabled and put interfaces and
             #  sub-interfaces to this BD
             for pg_if in cls.pg_interfaces:
-                sw_if_index = pg_if.sub_if.sw_if_index \
-                    if hasattr(pg_if, 'sub_if') else pg_if.sw_if_index
-                cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=sw_if_index,
-                                                    bd_id=cls.bd_id)
+                sw_if_index = (
+                    pg_if.sub_if.sw_if_index
+                    if hasattr(pg_if, "sub_if")
+                    else pg_if.sw_if_index
+                )
+                cls.vapi.sw_interface_set_l2_bridge(
+                    rx_sw_if_index=sw_if_index, bd_id=cls.bd_id
+                )
 
             # setup all interfaces
             for i in interfaces:
@@ -86,8 +90,7 @@ class TestVtr(VppTestCase):
 
     def show_commands_at_teardown(self):
         self.logger.info(self.vapi.ppcli("show l2fib verbose"))
-        self.logger.info(self.vapi.ppcli("show bridge-domain %s detail" %
-                                         self.bd_id))
+        self.logger.info(self.vapi.ppcli("show bridge-domain %s detail" % self.bd_id))
 
     @classmethod
     def create_hosts_and_learn(cls, count):
@@ -98,10 +101,11 @@ class TestVtr(VppTestCase):
             for j in range(1, count + 1):
                 host = Host(
                     "00:00:00:ff:%02x:%02x" % (pg_if.sw_if_index, j),
-                    "172.17.1%02x.%u" % (pg_if.sw_if_index, j))
-                packet = (Ether(dst="ff:ff:ff:ff:ff:ff", src=host.mac))
+                    "172.17.1%02x.%u" % (pg_if.sw_if_index, j),
+                )
+                packet = Ether(dst="ff:ff:ff:ff:ff:ff", src=host.mac)
                 hosts.append(host)
-                if hasattr(pg_if, 'sub_if'):
+                if hasattr(pg_if, "sub_if"):
                     packet = pg_if.sub_if.add_dot1_layer(packet)
                 packets.append(packet)
             pg_if.add_stream(packets)
@@ -115,12 +119,14 @@ class TestVtr(VppTestCase):
         src_host = random.choice(self.hosts_by_pg_idx[src_if.sw_if_index])
         pkt_info = self.create_packet_info(src_if, dst_if)
         payload = self.info_to_payload(pkt_info)
-        p = (Ether(dst=dst_host.mac, src=src_host.mac) /
-             IP(src=src_host.ip4, dst=dst_host.ip4) /
-             UDP(sport=1234, dport=1234) /
-             Raw(payload))
+        p = (
+            Ether(dst=dst_host.mac, src=src_host.mac)
+            / IP(src=src_host.ip4, dst=dst_host.ip4)
+            / UDP(sport=1234, dport=1234)
+            / Raw(payload)
+        )
         pkt_info.data = p.copy()
-        if do_dot1 and hasattr(src_if, 'sub_if'):
+        if do_dot1 and hasattr(src_if, "sub_if"):
             p = src_if.sub_if.add_dot1_layer(p)
         size = random.choice(packet_sizes)
         self.extend_packet(p, size)
@@ -172,8 +178,9 @@ class TestVtr(VppTestCase):
             return
 
         i = VppDot1QSubint(self, self.pg0, tags[0].vlan)
-        self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=i.sw_if_index,
-                                             bd_id=self.bd_id, enable=1)
+        self.vapi.sw_interface_set_l2_bridge(
+            rx_sw_if_index=i.sw_if_index, bd_id=self.bd_id, enable=1
+        )
         i.admin_up()
 
         p = self.create_packet(self.pg0, swif, do_dot1=False)
@@ -185,202 +192,217 @@ class TestVtr(VppTestCase):
         swif.sub_if.remove_dot1_layer(rx[0])
         self.assertTrue(Dot1Q not in rx[0])
 
-        self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=i.sw_if_index,
-                                             bd_id=self.bd_id, enable=0)
+        self.vapi.sw_interface_set_l2_bridge(
+            rx_sw_if_index=i.sw_if_index, bd_id=self.bd_id, enable=0
+        )
         i.remove_vpp_config()
 
     def test_1ad_vtr_pop_1(self):
-        """ 1AD VTR pop 1 test
-        """
+        """1AD VTR pop 1 test"""
         self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_POP_1)
         self.vtr_test(self.pg1, [Tag(dot1=DOT1Q, vlan=100)])
 
     def test_1ad_vtr_pop_2(self):
-        """ 1AD VTR pop 2 test
-        """
+        """1AD VTR pop 2 test"""
         self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_POP_2)
         self.vtr_test(self.pg1, [])
 
     def test_1ad_vtr_push_1ad(self):
-        """ 1AD VTR push 1 1AD test
-        """
+        """1AD VTR push 1 1AD test"""
         self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_PUSH_1, tag=300)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1AD, vlan=300),
-                                 Tag(dot1=DOT1AD, vlan=200),
-                                 Tag(dot1=DOT1Q, vlan=100)])
+        self.vtr_test(
+            self.pg1,
+            [
+                Tag(dot1=DOT1AD, vlan=300),
+                Tag(dot1=DOT1AD, vlan=200),
+                Tag(dot1=DOT1Q, vlan=100),
+            ],
+        )
 
     def test_1ad_vtr_push_2ad(self):
-        """ 1AD VTR push 2 1AD test
-        """
+        """1AD VTR push 2 1AD test"""
         self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_PUSH_2, outer=400, inner=300)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1AD, vlan=400),
-                                 Tag(dot1=DOT1Q, vlan=300),
-                                 Tag(dot1=DOT1AD, vlan=200),
-                                 Tag(dot1=DOT1Q, vlan=100)])
+        self.vtr_test(
+            self.pg1,
+            [
+                Tag(dot1=DOT1AD, vlan=400),
+                Tag(dot1=DOT1Q, vlan=300),
+                Tag(dot1=DOT1AD, vlan=200),
+                Tag(dot1=DOT1Q, vlan=100),
+            ],
+        )
 
     def test_1ad_vtr_push_1q(self):
-        """ 1AD VTR push 1 1Q test
-        """
+        """1AD VTR push 1 1Q test"""
         self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_PUSH_1, tag=300, push1q=1)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1Q, vlan=300),
-                                 Tag(dot1=DOT1AD, vlan=200),
-                                 Tag(dot1=DOT1Q, vlan=100)])
+        self.vtr_test(
+            self.pg1,
+            [
+                Tag(dot1=DOT1Q, vlan=300),
+                Tag(dot1=DOT1AD, vlan=200),
+                Tag(dot1=DOT1Q, vlan=100),
+            ],
+        )
 
     def test_1ad_vtr_push_2q(self):
-        """ 1AD VTR push 2 1Q test
-        """
-        self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_PUSH_2,
-                                outer=400, inner=300, push1q=1)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1Q, vlan=400),
-                                 Tag(dot1=DOT1Q, vlan=300),
-                                 Tag(dot1=DOT1AD, vlan=200),
-                                 Tag(dot1=DOT1Q, vlan=100)])
+        """1AD VTR push 2 1Q test"""
+        self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_PUSH_2, outer=400, inner=300, push1q=1)
+        self.vtr_test(
+            self.pg1,
+            [
+                Tag(dot1=DOT1Q, vlan=400),
+                Tag(dot1=DOT1Q, vlan=300),
+                Tag(dot1=DOT1AD, vlan=200),
+                Tag(dot1=DOT1Q, vlan=100),
+            ],
+        )
 
     def test_1ad_vtr_translate_1_1ad(self):
-        """ 1AD VTR translate 1 -> 1 1AD test
-        """
+        """1AD VTR translate 1 -> 1 1AD test"""
         self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_TRANSLATE_1_1, tag=300)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1AD, vlan=300),
-                                 Tag(dot1=DOT1Q, vlan=100)])
+        self.vtr_test(self.pg1, [Tag(dot1=DOT1AD, vlan=300), Tag(dot1=DOT1Q, vlan=100)])
 
     def test_1ad_vtr_translate_1_2ad(self):
-        """ 1AD VTR translate 1 -> 2 1AD test
-        """
-        self.pg1.sub_if.set_vtr(
-            L2_VTR_OP.L2_TRANSLATE_1_2, inner=300, outer=400)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1AD, vlan=400),
-                                 Tag(dot1=DOT1Q, vlan=300),
-                                 Tag(dot1=DOT1Q, vlan=100)])
+        """1AD VTR translate 1 -> 2 1AD test"""
+        self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_TRANSLATE_1_2, inner=300, outer=400)
+        self.vtr_test(
+            self.pg1,
+            [
+                Tag(dot1=DOT1AD, vlan=400),
+                Tag(dot1=DOT1Q, vlan=300),
+                Tag(dot1=DOT1Q, vlan=100),
+            ],
+        )
 
     def test_1ad_vtr_translate_2_1ad(self):
-        """ 1AD VTR translate 2 -> 1 1AD test
-        """
+        """1AD VTR translate 2 -> 1 1AD test"""
         self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_TRANSLATE_2_1, tag=300)
         self.vtr_test(self.pg1, [Tag(dot1=DOT1AD, vlan=300)])
 
     def test_1ad_vtr_translate_2_2ad(self):
-        """ 1AD VTR translate 2 -> 2 1AD test
-        """
-        self.pg1.sub_if.set_vtr(
-            L2_VTR_OP.L2_TRANSLATE_2_2, inner=300, outer=400)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1AD, vlan=400),
-                                 Tag(dot1=DOT1Q, vlan=300)])
+        """1AD VTR translate 2 -> 2 1AD test"""
+        self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_TRANSLATE_2_2, inner=300, outer=400)
+        self.vtr_test(self.pg1, [Tag(dot1=DOT1AD, vlan=400), Tag(dot1=DOT1Q, vlan=300)])
 
     def test_1ad_vtr_translate_1_1q(self):
-        """ 1AD VTR translate 1 -> 1 1Q test
-        """
+        """1AD VTR translate 1 -> 1 1Q test"""
         self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_TRANSLATE_1_1, tag=300, push1q=1)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1Q, vlan=300),
-                                 Tag(dot1=DOT1Q, vlan=100)])
+        self.vtr_test(self.pg1, [Tag(dot1=DOT1Q, vlan=300), Tag(dot1=DOT1Q, vlan=100)])
 
     def test_1ad_vtr_translate_1_2q(self):
-        """ 1AD VTR translate 1 -> 2 1Q test
-        """
+        """1AD VTR translate 1 -> 2 1Q test"""
         self.pg1.sub_if.set_vtr(
-            L2_VTR_OP.L2_TRANSLATE_1_2, inner=300, outer=400, push1q=1)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1Q, vlan=400),
-                                 Tag(dot1=DOT1Q, vlan=300),
-                                 Tag(dot1=DOT1Q, vlan=100)])
+            L2_VTR_OP.L2_TRANSLATE_1_2, inner=300, outer=400, push1q=1
+        )
+        self.vtr_test(
+            self.pg1,
+            [
+                Tag(dot1=DOT1Q, vlan=400),
+                Tag(dot1=DOT1Q, vlan=300),
+                Tag(dot1=DOT1Q, vlan=100),
+            ],
+        )
 
     def test_1ad_vtr_translate_2_1q(self):
-        """ 1AD VTR translate 2 -> 1 1Q test
-        """
+        """1AD VTR translate 2 -> 1 1Q test"""
         self.pg1.sub_if.set_vtr(L2_VTR_OP.L2_TRANSLATE_2_1, tag=300, push1q=1)
         self.vtr_test(self.pg1, [Tag(dot1=DOT1Q, vlan=300)])
 
     def test_1ad_vtr_translate_2_2q(self):
-        """ 1AD VTR translate 2 -> 2 1Q test
-        """
+        """1AD VTR translate 2 -> 2 1Q test"""
         self.pg1.sub_if.set_vtr(
-            L2_VTR_OP.L2_TRANSLATE_2_2, inner=300, outer=400, push1q=1)
-        self.vtr_test(self.pg1, [Tag(dot1=DOT1Q, vlan=400),
-                                 Tag(dot1=DOT1Q, vlan=300)])
+            L2_VTR_OP.L2_TRANSLATE_2_2, inner=300, outer=400, push1q=1
+        )
+        self.vtr_test(self.pg1, [Tag(dot1=DOT1Q, vlan=400), Tag(dot1=DOT1Q, vlan=300)])
 
     def test_1q_vtr_pop_1(self):
-        """ 1Q VTR pop 1 test
-        """
+        """1Q VTR pop 1 test"""
         self.pg2.sub_if.set_vtr(L2_VTR_OP.L2_POP_1)
         self.vtr_test(self.pg2, [])
 
     def test_1q_vtr_push_1(self):
-        """ 1Q VTR push 1 test
-        """
+        """1Q VTR push 1 test"""
         self.pg2.sub_if.set_vtr(L2_VTR_OP.L2_PUSH_1, tag=300)
-        self.vtr_test(self.pg2, [Tag(dot1=DOT1AD, vlan=300),
-                                 Tag(dot1=DOT1Q, vlan=200)])
+        self.vtr_test(self.pg2, [Tag(dot1=DOT1AD, vlan=300), Tag(dot1=DOT1Q, vlan=200)])
 
     def test_1q_vtr_push_2(self):
-        """ 1Q VTR push 2 test
-        """
+        """1Q VTR push 2 test"""
         self.pg2.sub_if.set_vtr(L2_VTR_OP.L2_PUSH_2, outer=400, inner=300)
-        self.vtr_test(self.pg2, [Tag(dot1=DOT1AD, vlan=400),
-                                 Tag(dot1=DOT1Q, vlan=300),
-                                 Tag(dot1=DOT1Q, vlan=200)])
+        self.vtr_test(
+            self.pg2,
+            [
+                Tag(dot1=DOT1AD, vlan=400),
+                Tag(dot1=DOT1Q, vlan=300),
+                Tag(dot1=DOT1Q, vlan=200),
+            ],
+        )
 
     def test_1q_vtr_translate_1_1(self):
-        """ 1Q VTR translate 1 -> 1 test
-        """
+        """1Q VTR translate 1 -> 1 test"""
         self.pg2.sub_if.set_vtr(L2_VTR_OP.L2_TRANSLATE_1_1, tag=300)
         self.vtr_test(self.pg2, [Tag(dot1=DOT1AD, vlan=300)])
 
     def test_1q_vtr_translate_1_2(self):
-        """ 1Q VTR translate 1 -> 2 test
-        """
-        self.pg2.sub_if.set_vtr(
-            L2_VTR_OP.L2_TRANSLATE_1_2, inner=300, outer=400)
-        self.vtr_test(self.pg2, [Tag(dot1=DOT1AD, vlan=400),
-                                 Tag(dot1=DOT1Q, vlan=300)])
+        """1Q VTR translate 1 -> 2 test"""
+        self.pg2.sub_if.set_vtr(L2_VTR_OP.L2_TRANSLATE_1_2, inner=300, outer=400)
+        self.vtr_test(self.pg2, [Tag(dot1=DOT1AD, vlan=400), Tag(dot1=DOT1Q, vlan=300)])
 
     def test_if_vtr_disable(self):
-        """ Disable VTR on non-sub-interfaces
-        """
+        """Disable VTR on non-sub-interfaces"""
         # First set the VTR fields to junk
         self.vapi.l2_interface_vlan_tag_rewrite(
-            sw_if_index=self.pg0.sw_if_index, vtr_op=L2_VTR_OP.L2_PUSH_2,
-            push_dot1q=1, tag1=19, tag2=630)
-
-        if_state = self.vapi.sw_interface_dump(
-            sw_if_index=self.pg0.sw_if_index)
+            sw_if_index=self.pg0.sw_if_index,
+            vtr_op=L2_VTR_OP.L2_PUSH_2,
+            push_dot1q=1,
+            tag1=19,
+            tag2=630,
+        )
+
+        if_state = self.vapi.sw_interface_dump(sw_if_index=self.pg0.sw_if_index)
         self.assertEqual(if_state[0].sw_if_index, self.pg0.sw_if_index)
         self.assertNotEqual(if_state[0].vtr_op, L2_VTR_OP.L2_DISABLED)
 
         # Then ensure that a request to disable VTR is honored.
         self.vapi.l2_interface_vlan_tag_rewrite(
-            sw_if_index=self.pg0.sw_if_index, vtr_op=L2_VTR_OP.L2_DISABLED)
+            sw_if_index=self.pg0.sw_if_index, vtr_op=L2_VTR_OP.L2_DISABLED
+        )
 
-        if_state = self.vapi.sw_interface_dump(
-            sw_if_index=self.pg0.sw_if_index)
+        if_state = self.vapi.sw_interface_dump(sw_if_index=self.pg0.sw_if_index)
         self.assertEqual(if_state[0].sw_if_index, self.pg0.sw_if_index)
         self.assertEqual(if_state[0].vtr_op, L2_VTR_OP.L2_DISABLED)
 
     def test_if_vtr_push_1q(self):
-        """ 1Q VTR push 1 on non-sub-interfaces
-        """
+        """1Q VTR push 1 on non-sub-interfaces"""
         self.vapi.l2_interface_vlan_tag_rewrite(
-            sw_if_index=self.pg0.sw_if_index, vtr_op=L2_VTR_OP.L2_PUSH_1,
-            push_dot1q=1, tag1=150)
+            sw_if_index=self.pg0.sw_if_index,
+            vtr_op=L2_VTR_OP.L2_PUSH_1,
+            push_dot1q=1,
+            tag1=150,
+        )
 
-        if_state = self.vapi.sw_interface_dump(
-            sw_if_index=self.pg0.sw_if_index)
+        if_state = self.vapi.sw_interface_dump(sw_if_index=self.pg0.sw_if_index)
         self.assertEqual(if_state[0].sw_if_index, self.pg0.sw_if_index)
         self.assertEqual(if_state[0].vtr_op, L2_VTR_OP.L2_PUSH_1)
         self.assertEqual(if_state[0].vtr_tag1, 150)
         self.assertNotEqual(if_state[0].vtr_push_dot1q, 0)
 
     def test_if_vtr_push_2ad(self):
-        """ 1AD VTR push 2 on non-sub-interfaces
-        """
+        """1AD VTR push 2 on non-sub-interfaces"""
         self.vapi.l2_interface_vlan_tag_rewrite(
-            sw_if_index=self.pg0.sw_if_index, vtr_op=L2_VTR_OP.L2_PUSH_2,
-            push_dot1q=0, tag1=450, tag2=350)
-
-        if_state = self.vapi.sw_interface_dump(
-            sw_if_index=self.pg0.sw_if_index)
+            sw_if_index=self.pg0.sw_if_index,
+            vtr_op=L2_VTR_OP.L2_PUSH_2,
+            push_dot1q=0,
+            tag1=450,
+            tag2=350,
+        )
+
+        if_state = self.vapi.sw_interface_dump(sw_if_index=self.pg0.sw_if_index)
         self.assertEqual(if_state[0].sw_if_index, self.pg0.sw_if_index)
         self.assertEqual(if_state[0].vtr_op, L2_VTR_OP.L2_PUSH_2)
-        self.assertEqual(if_state[0].vtr_tag1, 450)         # outer
-        self.assertEqual(if_state[0].vtr_tag2, 350)         # inner
+        self.assertEqual(if_state[0].vtr_tag1, 450)  # outer
+        self.assertEqual(if_state[0].vtr_tag2, 350)  # inner
         self.assertEqual(if_state[0].vtr_push_dot1q, 0)
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     unittest.main(testRunner=VppTestRunner)