Refactor iosxr_command to make use of network_connection plugin (#20772)

This commit is contained in:
Ricardo Carrillo Cruz 2017-01-30 17:52:19 +01:00 committed by GitHub
parent bbaab6ee5b
commit e70bc06ea1
3 changed files with 300 additions and 76 deletions

View file

@ -0,0 +1,84 @@
Cisco IOS XR Software, Version 6.0.0[Default]
Copyright (c) 2015 by Cisco Systems, Inc.
ROM: GRUB, Version 1.99(0), DEV RELEASE
iosxr01 uptime is 11 weeks, 2 days, 5 hours, 48 minutes
System image file is "bootflash:disk0/xrvr-os-mbi-6.0.0/mbixrvr-rp.vm"
cisco IOS XRv Series (Pentium Celeron Stepping 3) processor with 3169911K bytes of memory.
Pentium Celeron Stepping 3 processor at 3836MHz, Revision 2.174
IOS XRv Chassis
1 Management Ethernet
6 GigabitEthernet
97070k bytes of non-volatile configuration memory.
866M bytes of hard disk.
2321392k bytes of disk0: (Sector size 512 bytes).
Configuration register on node 0/0/CPU0 is 0x2102
Boot device on node 0/0/CPU0 is disk0:
Package active on node 0/0/CPU0:
iosxr-infra, V 6.0.0[Default], Cisco Systems, at disk0:iosxr-infra-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
iosxr-fwding, V 6.0.0[Default], Cisco Systems, at disk0:iosxr-fwding-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
iosxr-routing, V 6.0.0[Default], Cisco Systems, at disk0:iosxr-routing-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
iosxr-ce, V 6.0.0[Default], Cisco Systems, at disk0:iosxr-ce-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
xrvr-os-mbi, V 6.0.0[Default], Cisco Systems, at disk0:xrvr-os-mbi-6.0.0
Built on Thu Dec 24 08:54:41 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
xrvr-base, V 6.0.0[Default], Cisco Systems, at disk0:xrvr-base-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
xrvr-fwding, V 6.0.0[Default], Cisco Systems, at disk0:xrvr-fwding-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
xrvr-mgbl-x, V 6.0.0[Default], Cisco Systems, at disk0:xrvr-mgbl-x-6.0.0
Built on Thu Dec 24 08:53:57 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
iosxr-mpls, V 6.0.0[Default], Cisco Systems, at disk0:iosxr-mpls-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
iosxr-mgbl, V 6.0.0[Default], Cisco Systems, at disk0:iosxr-mgbl-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
iosxr-mcast, V 6.0.0[Default], Cisco Systems, at disk0:iosxr-mcast-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
xrvr-mcast-supp, V 6.0.0[Default], Cisco Systems, at disk0:xrvr-mcast-supp-6.0.0
Built on Thu Dec 24 08:53:49 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
iosxr-bng, V 6.0.0[Default], Cisco Systems, at disk0:iosxr-bng-6.0.0
Built on Thu Dec 24 08:53:47 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
xrvr-bng-supp, V 6.0.0[Default], Cisco Systems, at disk0:xrvr-bng-supp-6.0.0
Built on Thu Dec 24 08:53:47 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
iosxr-security, V 6.0.0[Default], Cisco Systems, at disk0:iosxr-security-6.0.0
Built on Thu Dec 24 08:53:41 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie
xrvr-fullk9-x, V 6.0.0[Default], Cisco Systems, at disk0:xrvr-fullk9-x-6.0.0
Built on Thu Dec 24 08:55:12 UTC 2015
By iox-lnx-010 in /auto/srcarchive16/production/6.0.0/xrvr/workspace for pie

View file

@ -0,0 +1,143 @@
# (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 os
import json
from ansible.compat.tests import unittest
from ansible.compat.tests.mock import patch, MagicMock
from ansible.errors import AnsibleModuleExit
from ansible.modules.network.iosxr import iosxr_command
from ansible.module_utils import basic
from ansible.module_utils._text import to_bytes
def set_module_args(args):
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
basic._ANSIBLE_ARGS = to_bytes(args)
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
fixture_data = {}
def load_fixture(name):
path = os.path.join(fixture_path, name)
if path in fixture_data:
return fixture_data[path]
with open(path) as f:
data = f.read()
try:
data = json.loads(data)
except:
pass
fixture_data[path] = data
return data
class TestIosxrCommandModule(unittest.TestCase):
def setUp(self):
self.mock_run_commands = patch('ansible.modules.network.iosxr.iosxr_command.run_commands')
self.run_commands = self.mock_run_commands.start()
def tearDown(self):
self.mock_run_commands.stop()
def execute_module(self, failed=False, changed=False):
def load_from_file(*args, **kwargs):
module, commands = args
output = list()
for item in commands:
try:
obj = json.loads(item)
command = obj['command']
except ValueError:
command = item
filename = str(command).replace(' ', '_')
output.append(load_fixture(filename))
return output
self.run_commands.side_effect = load_from_file
with self.assertRaises(AnsibleModuleExit) as exc:
iosxr_command.main()
result = exc.exception.result
if failed:
self.assertTrue(result.get('failed'))
else:
self.assertEqual(result.get('changed'), changed, result)
return result
def test_iosxr_command_simple(self):
set_module_args(dict(commands=['show version']))
result = self.execute_module()
self.assertEqual(len(result['stdout']), 1)
self.assertTrue(result['stdout'][0].startswith('Cisco IOS XR Software'))
def test_iosxr_command_multiple(self):
set_module_args(dict(commands=['show version', 'show version']))
result = self.execute_module()
self.assertEqual(len(result['stdout']), 2)
self.assertTrue(result['stdout'][0].startswith('Cisco IOS XR Software'))
def test_iosxr_command_wait_for(self):
wait_for = 'result[0] contains "Cisco IOS"'
set_module_args(dict(commands=['show version'], wait_for=wait_for))
self.execute_module()
def test_iosxr_command_wait_for_fails(self):
wait_for = 'result[0] contains "test string"'
set_module_args(dict(commands=['show version'], wait_for=wait_for))
self.execute_module(failed=True)
self.assertEqual(self.run_commands.call_count, 10)
def test_iosxr_command_retries(self):
wait_for = 'result[0] contains "test string"'
set_module_args(dict(commands=['show version'], wait_for=wait_for, retries=2))
self.execute_module(failed=True)
self.assertEqual(self.run_commands.call_count, 2)
def test_iosxr_command_match_any(self):
wait_for = ['result[0] contains "Cisco IOS"',
'result[0] contains "test string"']
set_module_args(dict(commands=['show version'], wait_for=wait_for, match='any'))
self.execute_module()
def test_iosxr_command_match_all(self):
wait_for = ['result[0] contains "Cisco IOS"',
'result[0] contains "XR Software"']
set_module_args(dict(commands=['show version'], wait_for=wait_for, match='all'))
self.execute_module()
def test_iosxr_command_match_all_failure(self):
wait_for = ['result[0] contains "Cisco IOS"',
'result[0] contains "test string"']
commands = ['show version', 'show version']
set_module_args(dict(commands=commands, wait_for=wait_for, match='all'))
self.execute_module(failed=True)