Merge pull request ansible-network#78 from trishnaguha/vlan_filter_pl…

…ugin

Add vlan_expand, vlan_compress filter plugins

README.md

@@ -64,6 +64,13 @@ The following is a list of plugins that are provided by this role.
 * `json_template` [[source]](https://github.com/ansible-network/network-engine/blob/devel/lookup_plugins/json_template.py)
 * `network_template` [[source]](https://github.com/ansible-network/network-engine/blob/devel/lookup_plugins/network_template.py)
 
+### Filter
+
+* `interface_split` [[source]](https://github.com/ansible-network/network-engine/blob/devel/filter_plugins/network_engine.py)
+* `interface_range` [[source]](https://github.com/ansible-network/network-engine/blob/devel/filter_plugins/network_engine.py)
+* `vlan_expand` [[source]](https://github.com/ansible-network/network-engine/blob/devel/filter_plugins/network_engine.py)
+* `vlan_compress` [[source]](https://github.com/ansible-network/network-engine/blob/devel/filter_plugins/network_engine.py)
+
 ## Dependencies
 
 The following is the list of dependencies on other roles this role requires.

changelogs/fragments/v252-filter-plugins.yaml

@@ -0,0 +1,5 @@
+new_filter_plugins:
+- New filter plugin ``interface_range``
+- New filter plugin ``interface_split``
+- New filter plugin ``vlan_compress``
+- New filter plugin ``vlan_expand``

changelogs/fragments/v252-lookup-plugins.yaml

@@ -0,0 +1,3 @@
+new_lookup_plugins:
+- New lookup plugin ``json_template``
+- New lookup plugin ``network_template``

filter_plugins/network_engine.py

@@ -54,11 +54,60 @@ def interface_range(interface):
     return ['%s%s' % (prefix, index) for index in indicies]
 
 
+def _gen_ranges(vlan):
+    s = e = None
+    for i in sorted(vlan):
+        if s is None:
+            s = e = i
+        elif i == e or i == e + 1:
+            e = i
+        else:
+            yield (s, e)
+            s = e = i
+    if s is not None:
+        yield (s, e)
+
+
+def vlan_compress(vlan):
+    if not isinstance(vlan, list):
+        raise AnsibleFilterError('value must be of type list, got %s' % type(vlan))
+
+    return (','.join(['%d' % s if s == e else '%d-%d' % (s, e) for (s, e) in _gen_ranges(vlan)]))
+
+
+def vlan_expand(vlan):
+    if not isinstance(vlan, string_types):
+        raise AnsibleFilterError('value must be of type string, got %s' % type(vlan))
+
+    match = re.match(r'([A-Za-z]*)(.+)', vlan)
+    if not match:
+        raise AnsibleFilterError('unable to parse vlan %s' % vlan)
+
+    index = match.group(2)
+    indices = list()
+
+    for item in index.split(','):
+        tokens = item.split('-')
+
+        if len(tokens) == 1:
+            indices.append(int(tokens[0]))
+
+        elif len(tokens) == 2:
+            start, end = tokens
+            for i in range(int(start), int(end) + 1):
+                indices.append(i)
+                i += 1
+
+    return ['%d' % int(index) for index in indices]
+
+
 class FilterModule(object):
     ''' Network interface filter '''
 
     def filters(self):
         return {
             'interface_split': interface_split,
-            'interface_range': interface_range
+            'interface_range': interface_range,
+            'vlan_compress': vlan_compress,
+            'vlan_expand': vlan_expand
         }

tests/test.yml

@@ -6,3 +6,5 @@
 - import_playbook: command_parser/test.yml
 - import_playbook: textfsm_parser/test.yml
 - import_playbook: json_template/test.yml
+- import_playbook: vlan_compress/test.yml
+- import_playbook: vlan_expand/test.yml

tests/vlan_compress/test.yml

@@ -0,0 +1,4 @@
+- hosts: localhost
+  connection: local
+  roles:
+    - vlan_compress

tests/vlan_compress/vlan_compress/meta/main.yaml

@@ -0,0 +1,3 @@
+---
+dependencies:
+  - ../../../network-engine

tests/vlan_compress/vlan_compress/tasks/main.yaml

@@ -0,0 +1,3 @@
+---
+- name: vlan_compress test
+  import_tasks: vlan_compress.yaml

tests/vlan_compress/vlan_compress/tasks/vlan_compress.yaml

@@ -0,0 +1,35 @@
+- name: vlan_compress single vlan
+  debug:
+    msg: "{{ [1] | vlan_compress }}"
+  register: result
+
+- assert:
+    that:
+      - "'1' in result.msg"
+
+- name: vlan_compress list of vlans1
+  debug:
+    msg: "{{ [1,2,3,4,5] | vlan_compress }}"
+  register: result
+
+- assert:
+    that:
+      - "'1-5' in result.msg"
+
+- name: vlan_compress list of vlans2
+  debug:
+    msg: "{{ [1,2,3,5] | vlan_compress }}"
+  register: result
+
+- assert:
+    that:
+      - "'1-3,5' in result.msg"
+
+- name: vlan_compress list of vlans3
+  debug:
+    msg: "{{ [1,2,4,5,6] | vlan_compress }}"
+  register: result
+
+- assert:
+    that:
+      - "'1-2,4-6' in result.msg"

tests/vlan_expand/test.yml

@@ -0,0 +1,4 @@
+- hosts: localhost
+  connection: local
+  roles:
+    - vlan_expand

tests/vlan_expand/vlan_expand/meta/main.yaml

@@ -0,0 +1,3 @@
+---
+dependencies:
+  - ../../../network-engine

tests/vlan_expand/vlan_expand/tasks/main.yaml

@@ -0,0 +1,3 @@
+---
+- name: vlan_expand test
+  import_tasks: vlan_expand.yaml

tests/vlan_expand/vlan_expand/tasks/vlan_expand.yaml

@@ -0,0 +1,34 @@
+- name: vlan_expand single vlan
+  debug:
+    msg: "{{ 'vlan1' | vlan_expand }}"
+  register: result
+
+- assert:
+    that:
+      - "'1' in result.msg"
+
+- name: vlan_expand range of vlans1
+  debug:
+    msg: "{{ 'vlan1-5' | vlan_expand }}"
+  register: result
+
+- assert:
+    that:
+      - "'1' in result.msg"
+      - "'2' in result.msg"
+      - "'3' in result.msg"
+      - "'4' in result.msg"
+      - "'5' in result.msg"
+
+- name: vlan_expand range of vlans2
+  debug:
+    msg: "{{ 'vlan1,3-5,7' | vlan_expand }}"
+  register: result
+
+- assert:
+    that:
+      - "'1' in result.msg"
+      - "'3' in result.msg"
+      - "'4' in result.msg"
+      - "'5' in result.msg"
+      - "'7' in result.msg"