From 5bd8a8f49151da9301af2aaece413585e04a70b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Claes=20N=C3=A4st=C3=A9n?= Date: Fri, 22 Dec 2017 17:56:50 +0100 Subject: [PATCH] Add nso_query module to query Cisco NSO using XPath (#34188) --- lib/ansible/module_utils/network/nso/nso.py | 11 ++ lib/ansible/modules/network/nso/nso_query.py | 126 ++++++++++++++++++ .../modules/network/nso/test_nso_query.py | 53 ++++++++ 3 files changed, 190 insertions(+) create mode 100644 lib/ansible/modules/network/nso/nso_query.py create mode 100644 test/units/modules/network/nso/test_nso_query.py diff --git a/lib/ansible/module_utils/network/nso/nso.py b/lib/ansible/module_utils/network/nso/nso.py index 9af1977429..ab13f2ea02 100644 --- a/lib/ansible/module_utils/network/nso/nso.py +++ b/lib/ansible/module_utils/network/nso/nso.py @@ -170,6 +170,17 @@ class JsonRpc(object): resp, resp_json = self._read_call(payload) return resp_json['result'] + def query(self, xpath, fields): + payload = { + 'method': 'query', + 'params': { + 'xpath_expr': xpath, + 'selection': fields + } + } + resp, resp_json = self._read_call(payload) + return resp_json['result']['results'] + def run_action(self, th, path, params=None): if params is None: params = {} diff --git a/lib/ansible/modules/network/nso/nso_query.py b/lib/ansible/modules/network/nso/nso_query.py new file mode 100644 index 0000000000..d735f7e856 --- /dev/null +++ b/lib/ansible/modules/network/nso/nso_query.py @@ -0,0 +1,126 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# Copyright (c) 2017 Cisco and/or its affiliates. +# +# 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 . +# + +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +ANSIBLE_METADATA = { + 'metadata_version': '1.1', + 'status': ['preview'], + 'supported_by': 'community' +} + +DOCUMENTATION = ''' +--- +module: nso_query +extends_documentation_fragment: nso +short_description: Query data from Cisco NSO. +description: + - This module provides support for querying data from Cisco NSO using XPath. +requirements: + - Cisco NSO version 3.4 or higher. +author: "Claes Nästén (@cnasten)" +options: + xpath: + description: XPath selection relative to the root. + required: true + fields: + description: > + List of fields to select from matching nodes. + required: true +version_added: "2.5" +''' + +EXAMPLES = ''' +- name: Select device name and description + nso_query: + url: http://localhost:8080/jsonrpc + username: username + password: password + xpath: /ncs:devices/device + fields: + - name + - description +''' + +RETURN = ''' +output: + description: Value of matching nodes + returned: success + type: list +''' + +from ansible.module_utils.network.nso.nso import connect, verify_version, nso_argument_spec +from ansible.module_utils.network.nso.nso import ModuleFailException, NsoException +from ansible.module_utils.basic import AnsibleModule + + +class NsoQuery(object): + REQUIRED_VERSIONS = [ + (3, 4) + ] + + def __init__(self, check_mode, client, xpath, fields): + self._check_mode = check_mode + self._client = client + self._xpath = xpath + self._fields = fields + + def main(self): + if self._check_mode: + return [] + else: + return self._client.query(self._xpath, self._fields) + + +def main(): + argument_spec = dict( + xpath=dict(required=True, type='str'), + fields=dict(required=True, type='list') + ) + argument_spec.update(nso_argument_spec) + + module = AnsibleModule( + argument_spec=argument_spec, + supports_check_mode=True + ) + p = module.params + + client = connect(p) + nso_query = NsoQuery( + module.check_mode, client, + p['xpath'], p['fields']) + try: + verify_version(client, NsoQuery.REQUIRED_VERSIONS) + + output = nso_query.main() + client.logout() + module.exit_json(changed=False, output=output) + except NsoException as ex: + client.logout() + module.fail_json(msg=ex.message) + except ModuleFailException as ex: + client.logout() + module.fail_json(msg=ex.message) + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/nso/test_nso_query.py b/test/units/modules/network/nso/test_nso_query.py new file mode 100644 index 0000000000..234a0cb76d --- /dev/null +++ b/test/units/modules/network/nso/test_nso_query.py @@ -0,0 +1,53 @@ +# +# Copyright (c) 2017 Cisco and/or its affiliates. +# +# 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 . + +from __future__ import (absolute_import, division, print_function) + +from ansible.compat.tests.mock import patch +from ansible.modules.network.nso import nso_query +from . import nso_module +from .nso_module import MockResponse + + +class TestNsoQuery(nso_module.TestNsoModule): + module = nso_query + + @patch('ansible.module_utils.network.nso.nso.open_url') + def test_nso_query(self, open_url_mock): + xpath = '/packages/package' + fields = ['name', 'package-version'] + calls = [ + MockResponse('login', {}, 200, '{}', {'set-cookie': 'id'}), + MockResponse('get_system_setting', {'operation': 'version'}, 200, '{"result": "4.5"}'), + MockResponse('new_trans', {'mode': 'read'}, 200, '{"result": {"th": 1}}'), + MockResponse('query', + {'xpath_expr': xpath, 'selection': fields}, 200, + '{"result": {"results": [["test", "1.0"]]}}'), + MockResponse('logout', {}, 200, '{"result": {}}'), + ] + open_url_mock.side_effect = lambda *args, **kwargs: nso_module.mock_call(calls, *args, **kwargs) + + nso_module.set_module_args({ + 'username': 'user', 'password': 'password', + 'url': 'http://localhost:8080/jsonrpc', + 'xpath': xpath, + 'fields': fields + }) + self.execute_module(changed=False, output=[["test", "1.0"]]) + + self.assertEqual(0, len(calls))