From: Jozef Urbanovsky <jurbanov(a)redhat.com>
Signed-off-by: Jozef Urbanovsky <jurbanov(a)redhat.com>
---
lnst/Recipes/ENRT/IpsecEspAeadRecipe.py | 23 ++++++++++++++++-------
1 file changed, 16 insertions(+), 7 deletions(-)
diff --git a/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
b/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
index 015db74..30da2fb 100644
--- a/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
+++ b/lnst/Recipes/ENRT/IpsecEspAeadRecipe.py
@@ -57,8 +57,9 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
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.
+ Test wide configuration for this recipe involves adding an IPv4 and
+ IPv6 address to the matched eth0 nics on both hosts and creating a route
+ between them.
host1.eth0 = 192.168.101.1/24 and fc00::1/64
@@ -120,6 +121,11 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
"""
Test wide configuration is extended with subconfiguration containing
IPsec tunnel with predefined parameters for both IP versions.
+ Required variables for the configuration of IPsec tunnel are generated
+ and yieled for later application of subconfiguration.
+
+ Yielded as::
+ (new_config)
"""
ipsec_mode = self.params.ipsec_mode
spi_values = self.spi_values
@@ -144,7 +150,7 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
def apply_sub_configuration(self, config):
"""
Subconfiguration containing IPsec tunnel is applied through
- XfrmTools class.
+ :any:`XfrmTools` class' methods using the previously generated
configuration.
"""
super().apply_sub_configuration(config)
ns1, ns2 = config.endpoint1.netns, config.endpoint2.netns
@@ -162,7 +168,7 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
def generate_ping_configurations(self, config):
"""
The ping endpoints for this recipe are the configured endpoints of
- the IPsec tunnel on both hosts.
+ the IPsec on both hosts.
"""
ns1, ns2 = config.endpoint1.netns, config.endpoint2.netns
ip1, ip2 = config.ips
@@ -180,8 +186,9 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
def generate_flow_combinations(self, config):
"""
- Flow combinations are generated based on the tunnel endpoints
- and test parameters.
+ Flow combinations are generated based on the IPsec endpoints
+ and test parameters specified. All combinations are looped over
+ and each flow is yielded.
"""
nic1, nic2 = config.endpoint1, config.endpoint2
ns1, ns2 = config.endpoint1.netns, config.endpoint2.netns
@@ -211,7 +218,9 @@ class IpsecEspAeadRecipe(CommonHWSubConfigMixin, BaseEnrtRecipe,
def ping_test(self, ping_configs):
"""
- Ping test is utilizing PacketAssert class to search
+ Ping test method overrides method of class :any:`PingTestAndEvaluate`.
+ Method executes ping test according to the ping configuration through
+ the IPsec with the use of :any:`PacketAssert` class to search
for the appropriate ESP IP packet. Result of ping
test is handed to the super class' method.
--
2.25.4