Devel ios vrf submode #41659

clementtrebuchet · 2018-06-18T17:06:04Z

SUMMARY

This PR include 3 changes:

Add the submode configuration feature for the issue The module ios_vrf push only the vrf configuration in global mode. #41191.
Fix the indepotence of the module, the parameters both_ * were not idempotent, in what is read in the configuration we have a list with 2 entries (import, export) while the input parameter has only one parameter which will be applied twice. We should be able to mix the parameters for the routes targets , while remaining imdepotent. During the first implementation we did not take this into account, which did not correspond to the reality of the needs in production (to be able to use each parameter indifferently together)
Add a try/except to avoid the behavior describe in the issue ios_vrf python error when vrf is already removed and state: absent #41581 when a VRF is already removed and state: absent

Fixes:

ISSUE TYPE

Feature Pull Request
Bugfix Pull Request

COMPONENT NAME

ios_vrf

ANSIBLE VERSION

(venv) [clement@clemo ansible]$ ansible --version
ansible 2.7.0.dev0 (devel_ios_vrf_submode bae025818a) last updated 2018/06/18 18:44:35 (GMT +200)
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/clement/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/clement/Documents/PROJECTS/ansible_env_setup/ansible/lib/ansible
  executable location = /home/clement/Documents/PROJECTS/ansible_env_setup/ansible/bin/ansible
  python version = 3.6.5 (default, Mar 29 2018, 18:20:46) [GCC 8.0.1 20180317 (Red Hat 8.0.1-0.19)]
(venv) [clement@clemo ansible]$

ADDITIONAL INFORMATION

It is now possible to configure the VRF in submode if needed.

GEEK CONSULTING INC.

clementroutertest>
clementroutertest>en
clementroutertest>enable 
Password: 
clementroutertest#sh run
clementroutertest#sh running-config | s vrf
vrf definition management
 !
 address-family ipv4
 exit-address-family
 !
 address-family ipv6
 exit-address-family
vrf definition test_13
 rd 2:100
 !
 address-family ipv4
 exit-address-family
 !
 address-family ipv6
  route-target export 168.0.0.15:100
  route-target export 4:100
  route-target export 2:100
  route-target export 168.0.0.13:100
  route-target import 168.0.0.14:100
  route-target import 2:100
  route-target import 168.0.0.13:100
 exit-address-family
vrf definition test_20
 rd 10:700
 route-target export 2:102
 route-target export 2:103
 route-target export 2:100
 route-target export 2:101
 route-target import 2:104
 route-target import 2:105
 route-target import 2:100
 route-target import 2:101
!        
 address-family ipv4
  route-target export 2:102
  route-target export 2:103
  route-target export 2:100
  route-target export 2:101
  route-target import 2:104
  route-target import 2:105
  route-target import 2:100
  route-target import 2:101
 exit-address-family
 !
 address-family ipv6
  route-target export 2:102
  route-target export 2:103
  route-target export 2:100
  route-target export 2:101
  route-target import 2:104
  route-target import 2:105
  route-target import 2:100
  route-target import 2:101
 exit-address-family
vrf definition test_9
 rd 168.0.0.9:100
 !        
 address-family ipv4
  route-target export 168.0.0.10:100
  route-target export 168.0.0.9:100
  route-target export 3:100
  route-target import 168.0.0.9:100
  route-target import 3:100
  route-target import 168.0.0.10:600
 exit-address-family
 !        
 address-family ipv6
 exit-address-family

---
- name: Set the test_9 vrf route_both_ipv4 with route_export_ipv4 and route_import_ipv4
  ios_vrf:
    name: test_9
    rd: 168.0.0.9:100
    route_import_ipv4:
      - "168.0.0.10:600"
    route_export_ipv4:
      - "168.0.0.10:100"
    route_both_ipv4:
      - "168.0.0.9:100"
      - "3:100"
    state: present

- name: Test idempotence of the VRF module in a loop context
  ios_vrf:
    name: test_bug
    rd: 65004:100
    route_both_ipv4:
      -  65003:100
    route_export_ipv4:
      - "{{ item }}"
    state: present
  loop: "{{ ipv4_import_rd }}"

- name: Set the test_20 vrf route_both, route_export, route_import, route_both_ipv4/v6, route_export_ipv4v6, route_import_ipv4v6.
  ios_vrf:
    name: test_20
    rd: 10:700
    route_both:
      - 2:100
      - 2:101
    route_export:
      - 2:102
      - 2:103
    route_import:
      - 2:104
      - 2:105
    route_both_ipv4:
      - 2:100
      - 2:101
    route_export_ipv4:
      - 2:102
      - 2:103
    route_import_ipv4:
      - 2:104
      - 2:105
    route_both_ipv6:
      - 2:100
      - 2:101
    route_export_ipv6:
      - 2:102
      - 2:103
    route_import_ipv6:
      - 2:104
      - 2:105
    state: present

- name: Set the test_13 vrf route_both_ipv6 and route_import_ipv6 and route_export_ipv6
  ios_vrf:
    name: test_13
    rd: 2:100
    route_import_ipv6:
      - "168.0.0.14:100"
    route_both_ipv6:
      - 2:100
      - "168.0.0.13:100"
    route_export_ipv6:
      - "168.0.0.15:100"
      - 4:100
    state: present

ansibot · 2018-06-18T17:09:16Z

cc @Qalthos @ganeshrn @gdpak @gundalow @privateip @rcarrillocruz @trishnaguha
click here for bot help

ansibot · 2018-06-18T17:29:45Z

The test ansible-test sanity --test pylint [explain] failed with 1 error:

test/units/modules/network/ios/test_ios_vrf.py:191:0: missing-final-newline Final newline missing

The test ansible-test sanity --test pep8 [explain] failed with 11 errors:

lib/ansible/modules/network/ios/ios_vrf.py:184:1: W293 blank line contains whitespace
lib/ansible/modules/network/ios/ios_vrf.py:208:1: W293 blank line contains whitespace
lib/ansible/modules/network/ios/ios_vrf.py:224:1: W293 blank line contains whitespace
lib/ansible/modules/network/ios/ios_vrf.py:690:67: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:158:57: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:164:57: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:168:100: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:174:46: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:180:48: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:186:57: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:191:41: W292 no newline at end of file

click here for bot help

ansibot · 2018-06-18T18:00:06Z

The test ansible-test sanity --test pylint [explain] failed with 1 error:

test/units/modules/network/ios/test_ios_vrf.py:191:0: missing-final-newline Final newline missing

The test ansible-test sanity --test pep8 [explain] failed with 11 errors:

lib/ansible/modules/network/ios/ios_vrf.py:184:1: W293 blank line contains whitespace
lib/ansible/modules/network/ios/ios_vrf.py:208:1: W293 blank line contains whitespace
lib/ansible/modules/network/ios/ios_vrf.py:224:1: W293 blank line contains whitespace
lib/ansible/modules/network/ios/ios_vrf.py:702:67: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:158:57: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:164:57: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:168:100: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:174:46: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:180:48: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:186:57: E231 missing whitespace after ','
test/units/modules/network/ios/test_ios_vrf.py:191:41: W292 no newline at end of file

click here for bot help

ansibot · 2018-06-18T19:41:03Z

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/network/ios/ios_vrf.py:224:1: W293 blank line contains whitespace

click here for bot help

ansibot · 2018-06-19T08:46:29Z

The test ansible-test sanity --test import --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/network/ios/ios_vrf.py:262:0: ImportError: cannot import name OrderedDict

click here for bot help

ganeshrn

Looks good

justjais · 2018-06-30T06:50:45Z

lib/ansible/modules/network/ios/ios_vrf.py

+        subcfg = '\n'.join(subcfg.children)
+        matches = re.findall(r'route-target\s+export\s+(.+)', subcfg, re.M)
+        return matches
+    except KeyError:


In case of KeyError, why are you returning empty list. If nothing specific, can you please use pass as used in other Ansible modules as well.

Hello @justjais

OK done, I was testing the len() of the export_match and the import_match this is why I returned a list. However I changed this and used pass like you asked me.
Thanks for your support.

justjais · 2018-06-30T06:51:26Z

lib/ansible/modules/network/ios/ios_vrf.py

+        matches = re.findall(r'route-target\s+import\s+(.+)', subcfg, re.M)
+        return matches
+    except KeyError:
+        return []


Same as above: In case of KeyError, empty list returned.

Hello @justjais

OK done, I was testing the len() of the export_match and the import_match this is why I returned a list. However I changed this and used pass like you asked me.
Thanks for your support.

justjais · 2018-06-30T06:51:33Z

lib/ansible/modules/network/ios/ios_vrf.py

+        subcfg = '\n'.join(subcfg.children)
+        matches = re.findall(r'route-target\s+export\s+(.+)', subcfg, re.M)
+        return matches
+    except KeyError:


Same as above: In case of KeyError, empty list returned.

Hello @justjais

OK done, I was testing the len() of the export_match and the import_match this is why I returned a list. However I changed this and used pass like you asked me.
Thanks for your support.

justjais · 2018-06-30T06:57:19Z

test/units/modules/network/ios/test_ios_vrf.py

        set_module_args(dict(name='test_8', rd='5:100', route_both=['3:100', '4:100'], route_export=['3:100', '4:100']))
-        self.execute_module(failed=True)


Can you please let me know of the context for this change.

Hello @justjais

you can use all the options [export *, import *, both *] in the same task. There is no more option that is exclusive. This is the way you can configure a router in BGP mode.

…nfiguration we have a list with 2 entries (import, export) while the input parameter has only one parameter which will be applied twice

…e remaining imdepotent. During the first implementation we did not take this into account, which did not correspond to the reality of the needs in production (to be able to use each parameter indifemently together)

ganeshrn · 2018-07-12T14:57:02Z

@clementtrebuchet Thank you!

ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Jun 18, 2018

clementtrebuchet force-pushed the devel_ios_vrf_submode branch from 3e3626a to a944249 Compare June 18, 2018 19:16

clementtrebuchet force-pushed the devel_ios_vrf_submode branch from 5c7452a to 101beed Compare June 19, 2018 08:31

ganeshrn reviewed Jul 6, 2018

View reviewed changes

justjais reviewed Jul 6, 2018

View reviewed changes

ganeshrn approved these changes Jul 6, 2018

View reviewed changes

clementtrebuchet added 20 commits July 6, 2018 09:54

add submode features ipv4/ipv6

38e8191

add tests for submode

adf7d05

the parameters both_ * were not idempotent, in what is read in the co…

989e946

…nfiguration we have a list with 2 entries (import, export) while the input parameter has only one parameter which will be applied twice

add docstring to the ios_vrf module + provide a fix for: ansible#41581

3079e02

complete tests

641816d

add missing description

cbcef5a

fix KeyError for address-family ipv*

69a56d9

fix both_* tests

bdf6d5d

fix E231, W292, W293

ff3a283

fix W293

3d97c37

remove set has it doesn't preserve order of routes

3b94e17

fix E106

cc59e98

remove ImportError: cannot import name OrderedDict

0428531

remove epdb reference

a3480c2

FIX E111, E106

eae918a

FIX E302

5c9a69c

using loop produce a result who was not imdepotent

2c053f1

FIX E241

7517154

fix: used pass intead of list

42766cd

justjais approved these changes Jul 6, 2018

View reviewed changes

clementtrebuchet force-pushed the devel_ios_vrf_submode branch from ae533b4 to 42766cd Compare July 6, 2018 07:56

ganeshrn merged commit 7c97bb5 into ansible:devel Jul 12, 2018

dagwieers added ios Cisco IOS community cisco Cisco technologies labels Feb 27, 2019

ansible locked and limited conversation to collaborators Jul 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Devel ios vrf submode #41659

Devel ios vrf submode #41659

clementtrebuchet commented Jun 18, 2018 •

edited

ansibot commented Jun 18, 2018

ansibot commented Jun 18, 2018

ansibot commented Jun 18, 2018

ansibot commented Jun 18, 2018

ansibot commented Jun 19, 2018

ganeshrn left a comment •

edited

justjais Jun 30, 2018 •

edited

clementtrebuchet Jul 6, 2018

justjais Jun 30, 2018 •

edited

clementtrebuchet Jul 6, 2018

justjais Jun 30, 2018 •

edited

clementtrebuchet Jul 6, 2018

justjais Jun 30, 2018

clementtrebuchet Jul 6, 2018

ganeshrn commented Jul 12, 2018

		set_module_args(dict(name='test_8', rd='5:100', route_both=['3:100', '4:100'], route_export=['3:100', '4:100']))
		self.execute_module(failed=True)

Devel ios vrf submode #41659

Devel ios vrf submode #41659

Conversation

clementtrebuchet commented Jun 18, 2018 • edited

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ADDITIONAL INFORMATION

ansibot commented Jun 18, 2018

ansibot commented Jun 18, 2018

ansibot commented Jun 18, 2018

ansibot commented Jun 18, 2018

ansibot commented Jun 19, 2018

ganeshrn left a comment • edited

Choose a reason for hiding this comment

justjais Jun 30, 2018 • edited

Choose a reason for hiding this comment

clementtrebuchet Jul 6, 2018

Choose a reason for hiding this comment

justjais Jun 30, 2018 • edited

Choose a reason for hiding this comment

clementtrebuchet Jul 6, 2018

Choose a reason for hiding this comment

justjais Jun 30, 2018 • edited

Choose a reason for hiding this comment

clementtrebuchet Jul 6, 2018

Choose a reason for hiding this comment

justjais Jun 30, 2018

Choose a reason for hiding this comment

clementtrebuchet Jul 6, 2018

Choose a reason for hiding this comment

ganeshrn commented Jul 12, 2018

clementtrebuchet commented Jun 18, 2018 •

edited

ganeshrn left a comment •

edited

justjais Jun 30, 2018 •

edited

justjais Jun 30, 2018 •

edited

justjais Jun 30, 2018 •

edited