Vyos interface desc fix28 (#57228)

* vyos interfacefix and  test cases

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>
(cherry picked from commit be1820d3af)

* backport 28

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

changelogs/fragments/vyos_interface_fixbackport.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- vyos_interface fix <https://github.com/ansible/ansible/pull/57169>

lib/ansible/modules/network/vyos/vyos_interface.py

@@ -204,6 +204,8 @@ def map_obj_to_commands(updates):
                     value = w.get(item)
 
                     if value and value != obj_in_have.get(item):
+                        if item == 'description':
+                            value = "\'" + str(value) + "\'"
                         commands.append(set_interface + ' ' + item + ' ' + str(value))
 
                 if disable and not obj_in_have.get('disable', False):
@@ -215,6 +217,8 @@ def map_obj_to_commands(updates):
                 for item in params:
                     value = w.get(item)
                     if value:
+                        if item == 'description':
+                            value = "\'" + str(value) + "\'"
                         commands.append(set_interface + ' ' + item + ' ' + str(value))
 
                 if disable:
@@ -244,7 +248,7 @@ def map_config_to_obj(module):
                 if match:
                     param = match.group(1)
                     if param == 'description':
-                        match = re.search(r'description (\S+)', line, re.M)
+                        match = re.search(r'description (.+)', line, re.M)
                         description = match.group(1).strip("'")
                         interface['description'] = description
                     elif param == 'speed':

test/integration/targets/vyos_interface/tests/cli/basic.yaml

@@ -23,7 +23,7 @@
     that:
       - 'result.changed == true'
       - '"set interfaces ethernet eth1" in result.commands'
-      - '"set interfaces ethernet eth1 description test-interface" in result.commands'
+      - '"set interfaces ethernet eth1 description ''test-interface''" in result.commands'
 
 - name: Configure interface params
   vyos_interface:
@@ -39,7 +39,7 @@
 - assert:
     that:
       - 'result.changed == true'
-      - '"set interfaces ethernet eth1 description test-interface-1" in result.commands'
+      - '"set interfaces ethernet eth1 description ''test-interface-1''" in result.commands'
       - '"set interfaces ethernet eth1 speed 100" in result.commands'
       - '"set interfaces ethernet eth1 duplex half" in result.commands'
       - '"set interfaces ethernet eth1 mtu 256" in result.commands'
@@ -75,7 +75,7 @@
 - assert:
     that:
       - 'result.changed == true'
-      - '"set interfaces ethernet eth1 description test-interface-2" in result.commands'
+      - '"set interfaces ethernet eth1 description ''test-interface-2''" in result.commands'
       - '"set interfaces ethernet eth1 speed 1000" in result.commands'
       - '"set interfaces ethernet eth1 duplex full" in result.commands'
       - '"set interfaces ethernet eth1 mtu 512" in result.commands'
@@ -141,11 +141,11 @@
 - assert:
     that:
       - 'result.changed == true'
-      - '"set interfaces ethernet eth1 description test-interface-1" in result.commands'
+      - '"set interfaces ethernet eth1 description ''test-interface-1''" in result.commands'
       - '"set interfaces ethernet eth1 speed 100" in result.commands'
       - '"set interfaces ethernet eth1 duplex half" in result.commands'
       - '"set interfaces ethernet eth1 mtu 512" in result.commands'
-      - '"set interfaces ethernet eth2 description test-interface-2" in result.commands'
+      - '"set interfaces ethernet eth2 description ''test-interface-2''" in result.commands'
       - '"set interfaces ethernet eth2 speed 1000" in result.commands'
       - '"set interfaces ethernet eth2 duplex full" in result.commands'
       - '"set interfaces ethernet eth2 mtu 256" in result.commands'

test/integration/targets/vyos_interface/tests/cli/net_interface.yaml

@@ -26,7 +26,7 @@
     that:
       - 'result.changed == true'
       - '"set interfaces ethernet eth1" in result.commands'
-      - '"set interfaces ethernet eth1 description test-interface" in result.commands'
+      - '"set interfaces ethernet eth1 description ''test-interface''" in result.commands'
 
 - name: Configure interface params using platform agnostic module
   net_interface:
@@ -42,7 +42,7 @@
 - assert:
     that:
       - 'result.changed == true'
-      - '"set interfaces ethernet eth1 description test-interface-1" in result.commands'
+      - '"set interfaces ethernet eth1 description ''test-interface-1''" in result.commands'
       - '"set interfaces ethernet eth1 speed 100" in result.commands'
       - '"set interfaces ethernet eth1 duplex half" in result.commands'
       - '"set interfaces ethernet eth1 mtu 256" in result.commands'