[PATCH 0/3] IpsecEspAeadRecipe enablement

From: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;

This short patchset fixes issues with the IpsecEspAeadRecipe,
reformats the code and adds documentation needed for the onboarding
of the LNST next recipe. 

Jozef Urbanovsky (3):
  Recipes.ENRT.IpsecEspAeadRecipe: reformating code to be PEP8 compliant
  Recipes.ENRT.IpsecEspAeadRecipe: add missing PerfFlow attributes,
    extend description of test
  Recipes.ENRT.IpsecEspAeadRecipe: add documentation

 lnst/Recipes/ENRT/IpsecEspAeadRecipe.py | 131 ++++++++++++++++++------
 1 file changed, 98 insertions(+), 33 deletions(-)

-- 
2.25.4

[PATCH 1/3] Recipes.ENRT.IpsecEspAeadRecipe: reformating code to be PEP8 compliant

From: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;

Signed-off-by: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;
---
 lnst/Recipes/ENRT/IpsecEspAeadRecipe.py | 57 +++++++++++++------------
 1 file changed, 29 insertions(+), 28 deletions(-)

diff --git a/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
b/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
index b2a6a74..2f39527 100644
--- a/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
+++ b/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
@@ -12,14 +12,15 @@ from lnst.Recipes.ENRT.ConfigMixins.BaseSubConfigMixin import (
 from lnst.Recipes.ENRT.ConfigMixins.CommonHWSubConfigMixin import (
     CommonHWSubConfigMixin)
 from lnst.RecipeCommon.PacketAssert import (PacketAssertConf,
-    PacketAssertTestAndEvaluate)
+                                            PacketAssertTestAndEvaluate)
 from lnst.RecipeCommon.Perf.Measurements import Flow as PerfFlow
 from lnst.RecipeCommon.Ping.Recipe import PingConf
 from lnst.Recipes.ENRT.XfrmTools import (configure_ipsec_esp_aead,
-    generate_key)
+                                         generate_key)
+
 
 class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
-    PacketAssertTestAndEvaluate):
+                         PacketAssertTestAndEvaluate):
     host1 = HostReq()
     host1.eth0 = DeviceReq(label="to_switch",
driver=RecipeParam("driver"))
 
@@ -40,21 +41,21 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
         net_addr6 = "fc00:"
         for i, host in enumerate([host1, host2]):
             host.eth0.down()
-            host.eth0.ip_add(ipaddress(net_addr + str(i+99) + ".1/24"))
-            host.eth0.ip_add(ipaddress(net_addr6 + str(i+1) + "::1/64"))
+            host.eth0.ip_add(ipaddress(net_addr + str(i + 99) + ".1/24"))
+            host.eth0.ip_add(ipaddress(net_addr6 + str(i + 1) + "::1/64"))
             host.eth0.up()
 
         self.wait_tentative_ips(configuration.test_wide_devices)
 
         if self.params.ping_parallel or self.params.ping_bidirect:
             logging.debug("Parallelism in pings is not supported for this "
-                "recipe, ping_parallel/ping_bidirect will be ignored.")
+                          "recipe, ping_parallel/ping_bidirect will be
ignored.")
 
         for host, dst in [(host1, host2), (host2, host1)]:
             for family in [AF_INET, AF_INET6]:
                 host.run("ip route add %s dev %s" %
-                    (dst.eth0.ips_filter(family=family)[0],
-                        host.eth0.name))
+                         (dst.eth0.ips_filter(family=family)[0],
+                          host.eth0.name))
 
         configuration.endpoint1 = host1.eth0
         configuration.endpoint2 = host2.eth0
@@ -97,7 +98,7 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
                     new_config = copy.copy(subconf)
                     new_config.ips = (ip1, ip2)
                     new_config.ipsec_settings = (algo, g_key, icv_len,
-                        ipsec_mode, spi_values)
+                                                 ipsec_mode, spi_values)
                     yield new_config
 
     def apply_sub_configuration(self, config):
@@ -120,12 +121,12 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
         count = self.params.ping_count
         interval = self.params.ping_interval
         size = self.params.ping_psize
-        common_args = {'count' : count, 'interval' : interval,
-            'size' : size}
-        ping_conf = PingConf(client = ns1,
-                             client_bind = ip1,
-                             destination = ns2,
-                             destination_address = ip2,
+        common_args = {'count': count, 'interval': interval,
+                       'size': size}
+        ping_conf = PingConf(client=ns1,
+                             client_bind=ip1,
+                             destination=ns2,
+                             destination_address=ip2,
                              **common_args)
         yield [ping_conf]
 
@@ -135,28 +136,28 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
         for perf_test in self.params.perf_tests:
             for size in self.params.perf_msg_sizes:
                 flow = PerfFlow(
-                    type = perf_test,
-                    generator = ns1,
-                    generator_bind = ip1,
-                    receiver = ns2,
-                    receiver_bind = ip2,
-                    msg_size = size,
-                    duration = self.params.perf_duration,
-                    parallel_streams = self.params.perf_parallel_streams,
-                    cpupin = self.params.perf_tool_cpu if (
-                        "perf_tool_cpu" in self.params) else None
-                    )
+                    type=perf_test,
+                    generator=ns1,
+                    generator_bind=ip1,
+                    receiver=ns2,
+                    receiver_bind=ip2,
+                    msg_size=size,
+                    duration=self.params.perf_duration,
+                    parallel_streams=self.params.perf_parallel_streams,
+                    cpupin=self.params.perf_tool_cpu if (
+                            "perf_tool_cpu" in self.params) else None
+                )
                 yield [flow]
 
                 if ("perf_reverse" in self.params and
-                    self.params.perf_reverse):
+                        self.params.perf_reverse):
                     reverse_flow = self._create_reverse_flow(flow)
                     yield [reverse_flow]
 
     def ping_test(self, ping_configs):
         m1, m2 = ping_configs[0].client, ping_configs[0].destination
         ip1, ip2 = (ping_configs[0].client_bind,
-            ping_configs[0].destination_address)
+                    ping_configs[0].destination_address)
         if1_name = self.get_dev_by_ip(m1, ip1).name
         if2 = self.get_dev_by_ip(m2, ip2)
 
-- 
2.25.4

[PATCH 2/3] Recipes.ENRT.IpsecEspAeadRecipe: add missing PerfFlow attributes, extend description of test

From: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;

PerfFlow object created in generate_flow_combinations was missing NIC
attributes after being extended by previous patches.

test_wide_description now uses fstring notation and provides user
with basic information about parameters of IPsec tunnel configured.

Signed-off-by: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;
---
 lnst/Recipes/ENRT/IpsecEspAeadRecipe.py | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
b/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
index 2f39527..66bdc31 100644
--- a/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
+++ b/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
@@ -63,15 +63,15 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
         return configuration
 
     def generate_test_wide_description(self, config):
-        host1, host2 = self.matched.host1, self.matched.host2
         desc = super().generate_test_wide_description(config)
         desc += [
             "\n".join([
-                "Configured {}.{}.ips = {}".format(
-                    dev.host.hostid, dev.name, dev.ips
-                )
+                f"Configured {dev.host.hostid}.{dev.name}.ips = {dev.ips}"
                 for dev in config.test_wide_devices
-            ])
+            ]).join([f"Configured IPsec {self.params.ipsec_mode} mode with {algo}
algorithm "
+                     f"using key length of {key_len} and icv length of
{icv_len}"
+                     for algo, key_len, icv_len in self.algorithm])
+
         ]
         return desc
 
@@ -131,6 +131,7 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
         yield [ping_conf]
 
     def generate_flow_combinations(self, config):
+        nic1, nic2 = config.endpoint1, config.endpoint2
         ns1, ns2 = config.endpoint1.netns, config.endpoint2.netns
         ip1, ip2 = config.ips
         for perf_test in self.params.perf_tests:
@@ -139,8 +140,10 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
                     type=perf_test,
                     generator=ns1,
                     generator_bind=ip1,
+                    generator_nic=nic1,
                     receiver=ns2,
                     receiver_bind=ip2,
+                    receiver_nic=nic2,
                     msg_size=size,
                     duration=self.params.perf_duration,
                     parallel_streams=self.params.perf_parallel_streams,
-- 
2.25.4

[PATCH 3/3] Recipes.ENRT.IpsecEspAeadRecipe: add documentation

From: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;

Signed-off-by: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;
---
 lnst/Recipes/ENRT/IpsecEspAeadRecipe.py | 61 +++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
b/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
index 66bdc31..015db74 100644
--- a/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
+++ b/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
@@ -21,6 +21,30 @@ from lnst.Recipes.ENRT.XfrmTools import (configure_ipsec_esp_aead,
 
 class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
                          PacketAssertTestAndEvaluate):
+    """
+    This recipe implements Enrt testing for a simple IPsec scenario that looks
+    as follows
+
+    .. code-block:: none
+
+                    +--------+
+             +------+ switch +-----+
+             |      +--------+     |
+          +--+-+                 +-+--+
+        +-|eth0|-+             +-|eth0|-+
+        | +----+ |             | +----+ |
+        | host1  |             | host2  |
+        +--------+             +--------+
+
+    The recipe provides additional recipe parameter to configure IPsec tunel.
+
+        :param ipsec_mode:
+            mode of the ipsec tunnel
+
+    All sub configurations are included via Mixin classes.
+
+    The actual test machinery is implemented in the :any:`BaseEnrtRecipe` class.
+    """
     host1 = HostReq()
     host1.eth0 = DeviceReq(label="to_switch",
driver=RecipeParam("driver"))
 
@@ -32,6 +56,14 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
     ipsec_mode = StrParam(default="transport")
 
     def test_wide_configuration(self):
+        """
+        Test wide configuration for this recipe involves just adding an IPv4 and
+        IPv6 address to the matched eth0 nics on both hosts and route between them.
+
+        host1.eth0 = 192.168.101.1/24 and fc00::1/64
+
+        host2.eth0 = 192.168.101.2/24 and fc00::2/64
+        """
         host1, host2 = self.matched.host1, self.matched.host2
 
         configuration = super().test_wide_configuration()
@@ -63,6 +95,10 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
         return configuration
 
     def generate_test_wide_description(self, config):
+        """
+        Test wide description is extended with the configured IP addresses,
+        specified IPsec algorithm, key length and integrity check value length.
+        """
         desc = super().generate_test_wide_description(config)
         desc += [
             "\n".join([
@@ -81,6 +117,10 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
         super().test_wide_deconfiguration(config)
 
     def generate_sub_configurations(self, config):
+        """
+        Test wide configuration is extended with subconfiguration containing
+        IPsec tunnel with predefined parameters for both IP versions.
+        """
         ipsec_mode = self.params.ipsec_mode
         spi_values = self.spi_values
         for subconf in ConfMixin.generate_sub_configurations(self, config):
@@ -102,6 +142,10 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
                     yield new_config
 
     def apply_sub_configuration(self, config):
+        """
+        Subconfiguration containing IPsec tunnel is applied through
+        XfrmTools class.
+        """
         super().apply_sub_configuration(config)
         ns1, ns2 = config.endpoint1.netns, config.endpoint2.netns
         ip1, ip2 = config.ips
@@ -116,6 +160,10 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
         super().remove_sub_configuration(config)
 
     def generate_ping_configurations(self, config):
+        """
+        The ping endpoints for this recipe are the configured endpoints of
+        the IPsec tunnel on both hosts.
+        """
         ns1, ns2 = config.endpoint1.netns, config.endpoint2.netns
         ip1, ip2 = config.ips
         count = self.params.ping_count
@@ -131,6 +179,10 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
         yield [ping_conf]
 
     def generate_flow_combinations(self, config):
+        """
+        Flow combinations are generated based on the tunnel endpoints
+        and test parameters.
+        """
         nic1, nic2 = config.endpoint1, config.endpoint2
         ns1, ns2 = config.endpoint1.netns, config.endpoint2.netns
         ip1, ip2 = config.ips
@@ -158,6 +210,15 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
                     yield [reverse_flow]
 
     def ping_test(self, ping_configs):
+        """
+        Ping test is utilizing PacketAssert class to search
+        for the appropriate ESP IP packet. Result of ping
+        test is handed to the super class' method.
+
+        Returned as::
+
+            (ping_result, pa_config, pa_result)
+        """
         m1, m2 = ping_configs[0].client, ping_configs[0].destination
         ip1, ip2 = (ping_configs[0].client_bind,
                     ping_configs[0].destination_address)
-- 
2.25.4

[Ondrej Lichtner]

On Wed, Sep 02, 2020 at 02:14:18PM +0200, jurbanov(a)redhat.com wrote:
>  From: Jozef Urbanovsky <jurbanov(a)redhat.com&gt;
>  
>  This short patchset fixes issues with the IpsecEspAeadRecipe,
>  reformats the code and adds documentation needed for the onboarding
>  of the LNST next recipe. 
>  
>  Jozef Urbanovsky (3):
>    Recipes.ENRT.IpsecEspAeadRecipe: reformating code to be PEP8 compliant
>    Recipes.ENRT.IpsecEspAeadRecipe: add missing PerfFlow attributes,
>      extend description of test
>    Recipes.ENRT.IpsecEspAeadRecipe: add documentation
>  
>   lnst/Recipes/ENRT/IpsecEspAeadRecipe.py | 131 ++++++++++++++++++------
>   1 file changed, 98 insertions(+), 33 deletions(-)
>  
>  -- 
>  2.25.4
>  _______________________________________________
>  LNST-developers mailing list -- lnst-developers(a)lists.fedorahosted.org
>  To unsubscribe send an email to lnst-developers-leave(a)lists.fedorahosted.org
>  Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
>  List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
>  List Archives:
> https://lists.fedorahosted.org/archives/list/[e-mail]...
looks good, pushed.

Thanks,
-Ondrej