Lenovo cnos static route (#53736)

* Adding new module to Ansible viz. cnos_static_route.

test/integration/targets/cnos_static_route/aliases

@@ -0,0 +1,2 @@
+# No Lenovo Switch simulator yet, so not enabled
+unsupported

test/integration/targets/cnos_static_route/cnos_static_route_sample_hosts

@@ -0,0 +1,14 @@
+# You have to paste this dummy information  in /etc/ansible/hosts
+#    Notes:
+#    - Comments begin with the '#' character
+#    - Blank lines are ignored
+#    - Groups of hosts are delimited by [header] elements
+#    - You can enter hostnames or ip Addresses
+#    - A hostname/ip can be a member of multiple groups
+#
+# In the /etc/ansible/hosts file u have to enter [cnos_static_route_sample] tag
+# Following you should specify IP Addresses details 
+# Please change <username> and <password> with appropriate value for your switch.
+
+[cnos_static_route_sample]
+10.241.107.39   ansible_network_os=cnos ansible_ssh_user=<username> ansible_ssh_pass=<password> 

test/integration/targets/cnos_static_route/defaults/main.yaml

@@ -0,0 +1,2 @@
+---
+testcase: "*"

test/integration/targets/cnos_static_route/tasks/cli.yaml

@@ -0,0 +1,22 @@
+---
+- name: collect all cli test cases
+  find:
+    paths: "{{ role_path }}/tests/cli"
+    patterns: "{{ testcase }}.yaml"
+  register: test_cases
+  delegate_to: localhost
+
+- name: set test_items
+  set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}"
+
+- name: run test cases (connection=network_cli)
+  include: "{{ test_case_to_run }}"
+  with_items: "{{ test_items }}"
+  loop_control:
+    loop_var: test_case_to_run
+
+- name: run test case (connection=local)
+  include: "{{ test_case_to_run }} ansible_connection=local"
+  with_first_found: "{{ test_items }}"
+  loop_control:
+    loop_var: test_case_to_run

test/integration/targets/cnos_static_route/tasks/main.yaml

@@ -0,0 +1,2 @@
+---
+- { include: cli.yaml, tags: ['cli'] }

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

@@ -0,0 +1,136 @@
+---
+#- debug: msg="START cnos cli/cnos_static_route.yaml on connection={{ ansible_connection }}"
+
+- name: Clear all static routes
+  cnos_static_route: &delete_all
+    aggregate:
+      - { prefix: 10.241.107.0 }
+      - { prefix: 10.241.106.0 }
+      - { prefix: 10.241.105.0 }
+      - { prefix: 10.241.108.0 }
+    mask: 255.255.255.0
+    next_hop: 10.241.100.100
+    state: absent
+
+- name: create static route
+  cnos_static_route:
+    prefix: 10.241.107.0
+    mask: 255.255.255.0
+    next_hop: 10.241.100.100
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - 'result.commands == ["ip route 10.241.107.0 255.255.255.0 10.241.100.100 1"]'
+
+- name: Verify idempotence with default admin_distance
+  cnos_static_route:
+    prefix: 10.241.107.0
+    mask: 255.255.255.0
+    next_hop: 10.241.100.100
+    admin_distance: 1
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+
+- name: modify admin distance of static route
+  cnos_static_route: &admin2
+    prefix: 10.241.107.0
+    mask: 255.255.255.0
+    next_hop: 10.241.100.100
+    admin_distance: 2
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - 'result.commands == ["ip route 10.241.107.0 255.255.255.0 10.241.100.100 2"]'
+
+- name: modify admin distance of static route again (idempotent)
+  cnos_static_route: *admin2
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+
+- name: Verify idempotence with unspecified admin_distance
+  cnos_static_route:
+    prefix: 10.241.107.0
+    mask: 255.255.255.0
+    next_hop: 10.241.100.100
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+
+- name: delete static route
+  cnos_static_route: &delete
+    prefix: 10.241.107.0
+    mask: 255.255.255.0
+    next_hop: 10.241.100.100
+    state: absent
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - 'result.commands == ["no ip route 10.241.107.0 255.255.255.0 10.241.100.100 1"]'
+
+- name: delete static route again (idempotent)
+  cnos_static_route: *delete
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+
+- name: Add static route aggregates
+  cnos_static_route:
+    aggregate:
+      - { prefix: 10.241.106.0 }
+      - { prefix: 10.241.105.0 }
+    mask: 255.255.255.0
+    next_hop: 10.241.100.100
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - 'result.commands == ["ip route 10.241.106.0 255.255.255.0 10.241.100.100 1", "ip route 10.241.105.0 255.255.255.0 10.241.100.100 1"]'
+
+- name: Add and remove static route aggregates with overrides
+  cnos_static_route:
+    aggregate:
+      - { prefix: 10.241.106.0 }
+      - { prefix: 10.241.105.0, state: absent }
+      - { prefix: 10.241.108.0 }
+    mask: 255.255.255.0
+    next_hop: 10.241.100.100
+    state: present
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - 'result.commands == ["ip route 10.241.106.0 255.255.255.0 10.241.100.100 1", "no ip route 10.241.105.0 255.255.255.0 10.241.100.100 1", "ip route 10.241.108.0 255.255.255.0 10.241.100.100 1"]'
+
+- name: Remove static route aggregates
+  cnos_static_route: *delete_all
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - 'result.commands == ["no ip route 10.241.107.0 255.255.255.0 10.241.100.100 1","no ip route 10.241.106.0 255.255.255.0 10.241.100.100 1","no ip route 10.241.105.0 255.255.255.0 10.241.100.100 1" ,"no ip route 10.241.108.0 255.255.255.0 10.241.100.100 1"]'
+
+#- debug: msg="END cnos cli/cnos_static_route.yaml on connection={{ ansible_connection }}"

test/units/modules/network/cnos/fixtures/cnos_static_route.cfg

@@ -0,0 +1,3 @@
+ip route 1.2.3.4/32 1.2.34.5
+ip route 10.241.106.0/24 Ethernet1/13 10.241.107.1 113 tag 1013 description anil
+ip route 10.8.0.0/14 15.16.17.18

test/units/modules/network/cnos/test_cnos_static_route.py

@@ -0,0 +1,74 @@
+# (c) 2016 Red Hat Inc.
+# Copyright (C) 2017 Lenovo.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from units.compat.mock import patch
+from ansible.modules.network.cnos import cnos_static_route
+from .cnos_module import TestCnosModule, load_fixture
+from units.modules.utils import set_module_args
+
+
+class TestCnosStaticRouteModule(TestCnosModule):
+
+    module = cnos_static_route
+
+    def setUp(self):
+        super(TestCnosStaticRouteModule, self).setUp()
+
+        self.mock_exec_command = patch('ansible.modules.network.cnos.cnos_banner.exec_command')
+        self.exec_command = self.mock_exec_command.start()
+
+        self.mock_load_config = patch('ansible.modules.network.cnos.cnos_static_route.load_config')
+        self.load_config = self.mock_load_config.start()
+
+        self.mock_get_config = patch('ansible.modules.network.cnos.cnos_static_route.get_config')
+        self.get_config = self.mock_get_config.start()
+
+    def tearDown(self):
+        super(TestCnosStaticRouteModule, self).tearDown()
+        self.mock_exec_command.stop()
+        self.mock_load_config.stop()
+        self.mock_get_config.stop()
+
+    def load_fixtures(self, commands=None):
+        self.exec_command.return_value = (0, load_fixture('cnos_static_route.cfg').strip(), None)
+        self.load_config.return_value = dict(diff=None, session='session')
+
+    def test_cnos_static_route_present(self):
+        set_module_args(dict(prefix='10.241.107.20', mask='255.255.255.0', next_hop='10.241.106.1'))
+        self.execute_module(changed=True, commands=['ip route 10.241.107.20 255.255.255.0 10.241.106.1 1'])
+
+    def test_cnos_static_route_present_no_defaults(self):
+        set_module_args(dict(prefix='10.241.106.4', mask='255.255.255.0', next_hop='1.2.3.5',
+                             description='testing', admin_distance=100))
+        self.execute_module(changed=True,
+                            commands=['ip route 10.241.106.4 255.255.255.0 1.2.3.5 100 description testing'])
+
+    def test_cnos_static_route_change(self):
+        set_module_args(dict(prefix='10.10.30.64', mask='255.255.255.0', next_hop='1.2.4.8'))
+        self.execute_module(changed=True,
+                            commands=['ip route 10.10.30.64 255.255.255.0 1.2.4.8 1'])
+
+    def test_cnos_static_route_absent(self):
+        set_module_args(dict(prefix='10.10.30.12',
+                             mask='255.255.255.0', next_hop='1.2.4.8', state='absent'))
+        self.execute_module(changed=True,
+                            commands=['no ip route 10.10.30.12 255.255.255.0 1.2.4.8 1'])