ansible/test/units/modules/network/nxos/test_nxos_vlans.py
Chris Van Heuveln 3252665a94 nxos_vlans: fix rmb behaviors and tests (#63650)
* nxos_vlans: fix rmb behaviors and tests

* whitespace fixes

* whitespace fixes 2

* review comments addressed

* TBD for legacy support

* additional tests to hit code coverage misses

* whitespace
2019-11-19 14:24:52 +05:30

210 lines
8.3 KiB
Python

# (c) 2019 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
from textwrap import dedent
from units.compat.mock import patch
from units.modules.utils import AnsibleFailJson
from ansible.modules.network.nxos import nxos_vlans
from ansible.module_utils.network.nxos.config.vlans.vlans import Vlans
from .nxos_module import TestNxosModule, load_fixture, set_module_args
ignore_provider_arg = True
class TestNxosVlansModule(TestNxosModule):
module = nxos_vlans
def setUp(self):
super(TestNxosVlansModule, self).setUp()
self.mock_FACT_LEGACY_SUBSETS = patch('ansible.module_utils.network.nxos.facts.facts.FACT_LEGACY_SUBSETS')
self.FACT_LEGACY_SUBSETS = self.mock_FACT_LEGACY_SUBSETS.start()
self.mock_get_resource_connection_config = patch('ansible.module_utils.network.common.cfg.base.get_resource_connection')
self.get_resource_connection_config = self.mock_get_resource_connection_config.start()
self.mock_get_resource_connection_facts = patch('ansible.module_utils.network.common.facts.facts.get_resource_connection')
self.get_resource_connection_facts = self.mock_get_resource_connection_facts.start()
self.mock_edit_config = patch('ansible.module_utils.network.nxos.config.vlans.vlans.Vlans.edit_config')
self.edit_config = self.mock_edit_config.start()
self.mock_get_device_data = patch('ansible.module_utils.network.nxos.facts.vlans.vlans.VlansFacts.get_device_data')
self.get_device_data = self.mock_get_device_data.start()
def tearDown(self):
super(TestNxosVlansModule, self).tearDown()
self.mock_FACT_LEGACY_SUBSETS.stop()
self.mock_get_resource_connection_config.stop()
self.mock_get_resource_connection_facts.stop()
self.mock_edit_config.stop()
def load_fixtures(self, commands=None, device=''):
self.mock_FACT_LEGACY_SUBSETS.return_value = dict()
self.edit_config.return_value = None
def load_from_file(*args, **kwargs):
cmd = args[1]
filename = str(cmd).split(' | ')[0].replace(' ', '_')
return load_fixture('nxos_vlans', filename)
def load_from_file_no_facts(*args, **kwargs):
cmd = args[1]
filename = str(cmd).split(' | ')[0].replace(' ', '_')
filename += '_no_facts'
return load_fixture('nxos_vlans', filename)
def load_from_file_vlan_1(*args, **kwargs):
cmd = args[1]
filename = str(cmd).split(' | ')[0].replace(' ', '_')
filename += '_vlan_1'
return load_fixture('nxos_vlans', filename)
if device == '':
self.get_device_data.side_effect = load_from_file
elif device == '_no_facts':
self.get_device_data.side_effect = load_from_file_no_facts
elif device == '_vlan_1':
self.get_device_data.side_effect = load_from_file_vlan_1
def test_1(self):
'''
**NOTE** This config is for reference only! See fixtures files for real data.
vlan 1,3-5,8
vlan 3
name test-vlan3
!Note:vlan 4 is present with default settings
vlan 5
shutdown
name test-changeme
mode fabricpath
state suspend
vn-segment 942
!Note:vlan 7 is not present
vlan 8
shutdown
name test-changeme-not
state suspend
'''
playbook = dict(config=[
dict(vlan_id=4),
dict(vlan_id=5, mapped_vni=555, mode='ce'),
dict(vlan_id=7, mapped_vni=777, name='test-vlan7', enabled=False),
dict(vlan_id='8', state='active', name='test-changeme-not')
# vlan 3 is not present in playbook.
])
merged = [
# Update existing device states with any differences in the playbook.
'vlan 5', 'vn-segment 555', 'mode ce',
'vlan 7', 'vn-segment 777', 'name test-vlan7', 'shutdown',
'vlan 8', 'state active'
]
playbook['state'] = 'merged'
set_module_args(playbook, ignore_provider_arg)
self.execute_module(changed=True, commands=merged)
deleted = [
# Reset existing device state to default values. Scope is limited to
# objects in the play when the 'config' key is specified. For vlans
# this means deleting each vlan listed in the playbook and ignoring
# any play attrs other than 'vlan_id'.
'no vlan 4',
'no vlan 5',
'no vlan 8'
]
playbook['state'] = 'deleted'
set_module_args(playbook, ignore_provider_arg)
self.execute_module(changed=True, commands=deleted)
overridden = [
# The play is the source of truth. Similar to replaced but the scope
# includes all objects on the device; i.e. it will also reset state
# on objects not found in the play.
'no vlan 3',
'vlan 5', 'mode ce', 'vn-segment 555', 'no state', 'no shutdown', 'no name',
'vlan 8', 'no shutdown', 'state active',
'vlan 7', 'name test-vlan7', 'shutdown', 'vn-segment 777'
]
playbook['state'] = 'overridden'
set_module_args(playbook, ignore_provider_arg)
self.execute_module(changed=True, commands=overridden)
replaced = [
# Scope is limited to objects in the play.
# replaced should ignore existing vlan 3.
'vlan 5', 'mode ce', 'vn-segment 555', 'no state', 'no shutdown', 'no name',
'vlan 7', 'shutdown', 'name test-vlan7', 'vn-segment 777',
'vlan 8', 'no shutdown', 'state active'
]
playbook['state'] = 'replaced'
set_module_args(playbook, ignore_provider_arg)
self.execute_module(changed=True, commands=replaced)
def test_2(self):
# vlan 1 in playbook should raise
playbook = dict(config=[dict(vlan_id=1)], state='merged')
set_module_args(playbook, ignore_provider_arg)
self.execute_module(failed=True)
def test_3(self):
# Test when no 'config' key is used in playbook.
deleted = [
# Reset existing device state for all vlans found on device other than vlan 1.
'no vlan 3',
'no vlan 4',
'no vlan 5',
'no vlan 8'
]
playbook = dict(state='deleted')
set_module_args(playbook, ignore_provider_arg)
self.execute_module(changed=True, commands=deleted)
for test_state in ['merged', 'replaced', 'overridden']:
set_module_args(dict(state=test_state), ignore_provider_arg)
self.execute_module(failed=True)
def test_4(self):
# Test only vlan 1 found
playbook = dict(state='deleted')
set_module_args(playbook, ignore_provider_arg)
self.execute_module(device='_vlan_1', changed=False)
def test_5(self):
# Test no facts returned
playbook = dict(state='deleted')
set_module_args(playbook, ignore_provider_arg)
self.execute_module(device='_no_facts', changed=False)
def test_6(self):
# Misc tests to hit codepaths highlighted by code coverage tool as missed.
playbook = dict(config=[
dict(vlan_id=8, enabled=True)
])
replaced = [
# Update existing device states with any differences in the playbook.
'vlan 8', 'no shutdown', 'no state', 'no name'
]
playbook['state'] = 'replaced'
playbook['_ansible_check_mode'] = True
set_module_args(playbook, ignore_provider_arg)
self.execute_module(changed=True, commands=replaced)