Add ios_user implementation module (#25413)

* Add ios_user module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Integration test for ios_user

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add unit test for ios_user

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

test/integration/ios.yaml

@@ -14,3 +14,4 @@
     - { role: ios_facts, when: "limit_to in ['*', 'ios_facts']" }
     - { role: ios_template, when: "limit_to in ['*', 'ios_template']" }
     - { role: ios_system, when: "limit_to in ['*', 'ios_system']" }
+    - { role: ios_user, when: "limit_to in ['*', 'ios_user']" }

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

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

test/integration/targets/ios_user/meta/main.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - prepare_ios_tests

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

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

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

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

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

@@ -0,0 +1,43 @@
+---
+- name: Create user
+  ios_user:
+    name: netend
+    privilege: 15
+    role: network-operator
+    state: present
+    authorize: yes
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - 'result.commands == ["username netend view network-operator", "username netend privilege 15"]'
+
+- name: Collection of users
+  ios_user:
+    users:
+      - name: test1
+      - name: test2
+    authorize: yes
+    state: present
+    view: network-admin
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - 'result.commands == ["username test1 view network-admin", "username test2 view network-admin"]'
+
+- name: tearDown
+  ios_user:
+    purge: yes
+    authorize: yes
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - 'result.changed == true'
+      - 'result.commands == ["no username netend", "no username test1", "no username test2"]'

test/units/modules/network/ios/fixtures/ios_user_config.cfg

@@ -0,0 +1,2 @@
+username admin view network-admin secret 5 $1$mdQIUxjg$3t3lzBpfKfITKvFm1uEIY.
+username ansible view network-admin secret 5 $1$3yWSXiIi$VdzV59ChiurrNdGxlDeAW/

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

@@ -0,0 +1,94 @@
+# (c) 2016 Red Hat Inc.
+#
+# 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
+
+import json
+
+from ansible.compat.tests.mock import patch
+from ansible.modules.network.ios import ios_user
+from .ios_module import TestIosModule, load_fixture, set_module_args
+
+
+class TestIosUserModule(TestIosModule):
+
+    module = ios_user
+
+    def setUp(self):
+        self.mock_get_config = patch('ansible.modules.network.ios.ios_user.get_config')
+        self.get_config = self.mock_get_config.start()
+
+        self.mock_load_config = patch('ansible.modules.network.ios.ios_user.load_config')
+        self.load_config = self.mock_load_config.start()
+
+    def tearDown(self):
+        self.mock_get_config.stop()
+        self.mock_load_config.stop()
+
+    def load_fixtures(self, commands=None, transport='cli'):
+        self.get_config.return_value = load_fixture('ios_user_config.cfg')
+        self.load_config.return_value = dict(diff=None, session='session')
+
+    def test_ios_user_create(self):
+        set_module_args(dict(name='test', nopassword=True))
+        result = self.execute_module(changed=True)
+        self.assertEqual(result['commands'], ['username test nopassword'])
+
+    def test_ios_user_delete(self):
+        set_module_args(dict(name='ansible', state='absent'))
+        result = self.execute_module(changed=True)
+        self.assertEqual(result['commands'], ['no username ansible'])
+
+    def test_ios_user_password(self):
+        set_module_args(dict(name='ansible', password='test'))
+        result = self.execute_module(changed=True)
+        self.assertEqual(result['commands'], ['username ansible secret test'])
+
+    def test_ios_user_privilege(self):
+        set_module_args(dict(name='ansible', privilege=15))
+        result = self.execute_module(changed=True)
+        self.assertEqual(result['commands'], ['username ansible privilege 15'])
+
+    def test_ios_user_privilege_invalid(self):
+        set_module_args(dict(name='ansible', privilege=25))
+        self.execute_module(failed=True)
+
+    def test_ios_user_purge(self):
+        set_module_args(dict(purge=True))
+        result = self.execute_module(changed=True)
+        self.assertEqual(result['commands'], ['no username ansible'])
+
+    def test_ios_user_view(self):
+        set_module_args(dict(name='ansible', view='test'))
+        result = self.execute_module(changed=True)
+        self.assertEqual(result['commands'], ['username ansible view test'])
+
+    def test_ios_user_update_password_changed(self):
+        set_module_args(dict(name='test', password='test', update_password='on_create'))
+        result = self.execute_module(changed=True)
+        self.assertEqual(result['commands'], ['username test secret test'])
+
+    def test_ios_user_update_password_on_create_ok(self):
+        set_module_args(dict(name='ansible', password='test', update_password='on_create'))
+        self.execute_module()
+
+    def test_ios_user_update_password_always(self):
+        set_module_args(dict(name='ansible', password='test', update_password='always'))
+        result = self.execute_module(changed=True)
+        self.assertEqual(result['commands'], ['username ansible secret test'])