cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add a new module to create isis instance. (#63716)

Browse source 
* add a new

* update to add futuer.

* update

* update shippable

* update docs.

* update

* add unittest.

* add integration test.

* update for shippable.

* syntax error

* syntax error

* syntax error

* update for review.

* update for review.

* add notes.
This commit is contained in:
Xu Yuandong 2019-11-26 19:23:05 +08:00 committed by John R Barker
parent 8c88ee3b9f
commit 76e904e44f
9 changed files with 532 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

331
lib/ansible/modules/network/cloudengine/ce_is_is_instance.py Normal file
View file

@ -0,0 +1,331 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright 2019 Red Hat
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = r'''
---
module: ce_is_is_instance
version_added: "2.10"
author: xuxiaowei0512 (@CloudEngine-Ansible)
short_description: Manages isis process id configuration on HUAWEI CloudEngine devices.
description:
- Manages isis process id, creates a isis instance id or deletes a process id on HUAWEI CloudEngine devices.
notes:
- This module requires the netconf system service be enabled on the remote device being managed.
- This module works with connection C(netconf).
options:
instance_id:
description:
- Specifies the id of a isis process.The value is a number of 1 to 4294967295.
required: true
type: int
vpn_name:
description:
- VPN Instance, associate the VPN instance with the corresponding IS-IS process.
type: str
state:
description:
- Determines whether the config should be present or not on the device.
default: present
type: str
choices: ['present', 'absent']
'''
EXAMPLES = r'''
- name: Set isis process
ce_is_is_instance:
instance_id: 3
state: present
- name: Unset isis process
ce_is_is_instance:
instance_id: 3
state: absent
- name: check isis process
ce_is_is_instance:
instance_id: 4294967296
state: present
- name: Set vpn name
ce_is_is_instance:
instance_id: 22
vpn_name: vpn1
state: present
- name: check vpn name
ce_is_is_instance:
instance_id: 22
vpn_name: vpn1234567896321452212221556asdasdasdasdsadvdv
state: present
'''
RETURN = r'''
proposed:
description: k/v pairs of parameters passed into module
returned: always
type: dict
sample: {
"instance_id": 1,
"vpn_name": null
}
existing:
description: k/v pairs of existing configuration
returned: always
type: dict
sample: {
"session": {}
}
end_state:
description: k/v pairs of configuration after module execution
returned: always
type: dict
sample: {
"session": {
"instance_id": 1,
"vpn_name": null
}
}
updates:
description: commands sent to the device
returned: always
type: list
sample: [
"isis 1"
]
changed:
description: check to see if a change was made on the device
returned: always
type: bool
sample: true
'''
from xml.etree import ElementTree
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.network.cloudengine.ce import get_nc_config, set_nc_config
CE_NC_GET_ISIS = """
<filter type="subtree">
<isiscomm xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
%s
</isiscomm>
</filter>
"""
CE_NC_GET_ISIS_INSTANCE = """
<isSites>
<isSite>
<instanceId>%s</instanceId>
<vpnName></vpnName>
</isSite>
</isSites>
"""
def is_valid_ip_vpn(vpname):
"""check ip vpn"""
if not vpname:
return False
if vpname == "_public_":
return False
if len(vpname) < 1 or len(vpname) > 31:
return False
return True
class ISIS_Instance(object):
"""Manages ISIS Instance"""
def __init__(self, argument_spec):
self.spec = argument_spec
self.module = None
self.__init_module__()
# module input info
self.instance_id = self.module.params['instance_id']
self.vpn_name = self.module.params['vpn_name']
self.state = self.module.params['state']
# state
self.changed = False
self.isis_dict = dict()
self.updates_cmd = list()
self.commands = list()
self.results = dict()
self.proposed = dict()
self.existing = dict()
self.end_state = dict()
def __init_module__(self):
"""init module"""
self.module = AnsibleModule(
argument_spec=self.spec, supports_check_mode=True)
def get_isis_dict(self):
"""isis config dict"""
isis_dict = dict()
isis_dict["instance"] = dict()
conf_str = CE_NC_GET_ISIS % (
(CE_NC_GET_ISIS_INSTANCE % self.instance_id))
xml_str = get_nc_config(self.module, conf_str)
if "<data/>" in xml_str:
return isis_dict
xml_str = xml_str.replace('\r', '').replace('\n', '').\
replace('xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"', "").\
replace('xmlns="http://www.huawei.com/netconf/vrp"', "")
root = ElementTree.fromstring(xml_str)
# get isis info
glb = root.find("isiscomm/isSites/isSite")
if glb:
for attr in glb:
isis_dict["instance"][attr.tag] = attr.text
return isis_dict
def config_session(self):
"""configures isis"""
xml_str = ""
instance = self.isis_dict["instance"]
if not self.instance_id:
return xml_str
if self.state == "present":
xml_str = "<instanceId>%s</instanceId>" % self.instance_id
self.updates_cmd.append("isis %s" % self.instance_id)
if self.vpn_name:
xml_str += "<vpnName>%s</vpnName>" % self.vpn_name
self.updates_cmd.append("vpn-instance %s" % self.vpn_name)
else:
# absent
if self.instance_id and str(self.instance_id) == instance.get("instanceId"):
xml_str = "<instanceId>%s</instanceId>" % self.instance_id
self.updates_cmd.append("undo isis %s" % self.instance_id)
if self.state == "present":
return '<isSites><isSite operation="merge">' + xml_str + '</isSite></isSites>'
else:
if xml_str:
return '<isSites><isSite operation="delete">' + xml_str + '</isSite></isSites>'
def netconf_load_config(self, xml_str):
"""load isis config by netconf"""
if not xml_str:
return
xml_cfg = """
<config>
<isiscomm xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
%s
</isiscomm>
</config>""" % xml_str
set_nc_config(self.module, xml_cfg)
self.changed = True
def check_params(self):
"""Check all input params"""
# check instance id
if not self.instance_id:
self.module.fail_json(msg="Error: Missing required arguments: instance_id.")
if self.instance_id:
if self.instance_id < 1 or self.instance_id > 4294967295:
self.module.fail_json(msg="Error: Instance id is not ranges from 1 to 4294967295.")
# check vpn_name
if self.vpn_name:
if not is_valid_ip_vpn(self.vpn_name):
self.module.fail_json(msg="Error: Session vpn_name is invalid.")
def get_proposed(self):
"""get proposed info"""
# base config
self.proposed["instance_id"] = self.instance_id
self.proposed["vpn_name"] = self.vpn_name
self.proposed["state"] = self.state
def get_existing(self):
"""get existing info"""
if not self.isis_dict:
self.existing["instance"] = None
self.existing["instance"] = self.isis_dict.get("instance")
def get_end_state(self):
"""get end state info"""
isis_dict = self.get_isis_dict()
if not isis_dict:
self.end_state["instance"] = None
self.end_state["instance"] = isis_dict.get("instance")
if self.end_state == self.existing:
self.changed = False
def work(self):
"""worker"""
self.check_params()
self.isis_dict = self.get_isis_dict()
self.get_existing()
self.get_proposed()
# deal present or absent
xml_str = ''
if self.instance_id:
cfg_str = self.config_session()
if cfg_str:
xml_str += cfg_str
# update to device
if xml_str:
self.netconf_load_config(xml_str)
self.changed = True
self.get_end_state()
self.results['changed'] = self.changed
self.results['proposed'] = self.proposed
self.results['existing'] = self.existing
self.results['end_state'] = self.end_state
if self.changed:
self.results['updates'] = self.updates_cmd
else:
self.results['updates'] = list()
self.module.exit_json(**self.results)
def main():
"""Module main"""
argument_spec = dict(
instance_id=dict(required=True, type='int'),
vpn_name=dict(required=False, type='str'),
state=dict(required=False, default='present', choices=['present', 'absent'])
)
module = ISIS_Instance(argument_spec)
module.work()
if __name__ == '__main__':
main()

3
test/integration/targets/ce_is_is_instance/defaults/main.yaml Normal file
View file

@ -0,0 +1,3 @@
---
testcase: "[^_].*"
test_items: []

1
test/integration/targets/ce_is_is_instance/meta/main.yml Normal file
View file

@ -0,0 +1 @@

2
test/integration/targets/ce_is_is_instance/tasks/main.yaml Normal file
View file

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

17
test/integration/targets/ce_is_is_instance/tasks/netconf.yaml Normal file
View file

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

85
test/integration/targets/ce_is_is_instance/tests/netconf/ce_is_is_instance.yaml Normal file
View file

@ -0,0 +1,85 @@
---
- debug:
msg: "START ce_is_is_instance merged integration tests on connection={{ ansible_connection }}"
- block:
- name: berfore merged, there should be no isis 100.
ce_is_is_instance: &delete
instance_id: 100
state: absent
- name: Merge the provided configuration with the exisiting running configuration
ce_is_is_instance: &merged
instance_id: 100
vpn_name: '__public__'
register: result
- name: change ansible_connection to network_cli
ce_netconf:
rpc: get
cfg_xml: "<filter type=\"subtree\">
<isiscomm xmlns=\"http://www.huawei.com/netconf/vrp\" content-version=\"1.0\" format-version=\"1.0\">
<isSites>
<isSite>
<instanceId></instanceId>
<vpnName></vpnName>
</isSite>
</isSites>
</isiscomm>
</filter>"
register: result_xml
- name: Assert the configuration is reflected on host
assert:
that:
- "result['changed'] == true"
- "'<instanceId>100</instanceId>' in result_xml.end_state.result"
- "'<vpnName>__public__</vpnName>' in result_xml.end_state.result"
- name: Merge the provided configuration with the existing running configuration (IDEMPOTENT)
ce_is_is_instance: *merged
register: result
- name: Assert that the previous task was idempotent
assert:
that:
- "result['changed'] == false"
- name: delete the provided configuration with the exisiting running configuration
ce_is_is_instance: *delete
register: result
- name: change ansible_connection to network_cli
ce_netconf:
rpc: get
cfg_xml: "<filter type=\"subtree\">
<isiscomm xmlns=\"http://www.huawei.com/netconf/vrp\" content-version=\"1.0\" format-version=\"1.0\">
<isSites>
<isSite>
<instanceId></instanceId>
<vpnName></vpnName>
</isSite>
</isSites>
</isiscomm>
</filter>"
register: result_xml
- name: Assert the configuration is reflected on host
assert:
that:
- "result['changed'] == true"
- "'<instanceId>100</instanceId>' not in result_xml.end_state.result"
- "'<vpnName>__public__</vpnName>' not in result_xml.end_state.result"
- name: delete the provided configuration with the existing running configuration (IDEMPOTENT)
ce_is_is_instance: *delete
register: result
- name: Assert that the previous task was idempotent
assert:
that:
- "result['changed'] == false"
- debug:
msg: "END ce_is_is_instance merged integration tests on connection={{ ansible_connection }}"

11
test/units/modules/network/cloudengine/fixtures/ce_is_is_instance/after.txt Normal file
View file

@ -0,0 +1,11 @@
<data>
<isiscomm xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
<isSites>
<isSite>
<instanceId>100</instanceId>
<vpnName>_public_</vpnName>
<description>ISIS</description>
</isSite>
</isSites>
</isiscomm>
</data>

11
test/units/modules/network/cloudengine/fixtures/ce_is_is_instance/before.txt Normal file
View file

@ -0,0 +1,11 @@
<data>
<isiscomm xmlns="http://www.huawei.com/netconf/vrp" content-version="1.0" format-version="1.0">
<isSites>
<isSite>
<instanceId></instanceId>
<vpnName></vpnName>
<description></description>
</isSite>
</isSites>
</isiscomm>
</data>

71
test/units/modules/network/cloudengine/test_ce_is_is_instance.py Normal file
View file

@ -0,0 +1,71 @@
# (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 units.compat.mock import patch
from ansible.modules.network.cloudengine import ce_is_is_instance
from units.modules.network.cloudengine.ce_module import TestCloudEngineModule, load_fixture
from units.modules.utils import set_module_args
class TestCloudEngineLacpModule(TestCloudEngineModule):
module = ce_is_is_instance
def setUp(self):
super(TestCloudEngineLacpModule, self).setUp()
self.mock_get_config = patch('ansible.modules.network.cloudengine.ce_is_is_instance.get_nc_config')
self.get_nc_config = self.mock_get_config.start()
self.mock_set_config = patch('ansible.modules.network.cloudengine.ce_is_is_instance.set_nc_config')
self.set_nc_config = self.mock_set_config.start()
self.set_nc_config.return_value = None
def tearDown(self):
super(TestCloudEngineLacpModule, self).tearDown()
self.mock_set_config.stop()
self.mock_get_config.stop()
def test_isis_instance_present(self):
xml_existing = load_fixture('ce_is_is_instance', 'before.txt')
xml_end_state = load_fixture('ce_is_is_instance', 'after.txt')
update = ['isis 100', 'vpn-instance __public__']
self.get_nc_config.side_effect = (xml_existing, xml_end_state)
config = dict(
instance_id=100,
vpn_name='__public__',
state='present')
set_module_args(config)
result = self.execute_module(changed=True)
self.assertEquals(sorted(result['updates']), sorted(update))
def test_isis_instance_present(self):
xml_existing = load_fixture('ce_is_is_instance', 'after.txt')
xml_end_state = load_fixture('ce_is_is_instance', 'before.txt')
update = ['undo isis 100']
self.get_nc_config.side_effect = (xml_existing, xml_end_state)
config = dict(
instance_id=100,
vpn_name='__public__',
state='absent')
set_module_args(config)
result = self.execute_module(changed=True)
self.assertEquals(sorted(result['updates']), sorted(update))