mirror of
https://github.com/ansible-collections/community.routeros.git
synced 2025-06-22 09:53:32 +02:00
update community.routeros.api query functionality (#63)
* update query to accept multiple librouteros ADN parameters * update query for new yml strucutre * add extended_query as separate function:(code in progress) * extended_query main code is ready for review * add changelog #63 * small fix for code indentation * fix pep * clear all pep issues * extended_query ready for review (new yml structure) * small doc fix for std query * Update changelogs/fragments/63-add-extended_query.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/63-add-extended_query.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update argument spec. * Other suggestions. * Fix syntax errors ('is' and 'or' are keywords). * Make everything work again. * Add docs, simplify code. * Add some first tests. * Do not add fake message when there is no search result. * Improve tests. * Fix tests. * update extened query docs and ros api module examples * fix pep plugins/modules/api.py:154:1: W293: blank line contains whitespace * fix extended query example intend * Update plugins/modules/api.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/api.py Co-authored-by: Felix Fontein <felix@fontein.de> * fix example docs Co-authored-by: dako <dako@syslin.sof.dachev.lan> Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Nikolay Dachev
GitHub
parent
109e534976
commit
d57de117f5
4 changed files with 405 additions and 152 deletions
|
|
@ -21,7 +21,7 @@ import json
|
|||
import pytest
|
||||
|
||||
from ansible_collections.community.routeros.tests.unit.compat.mock import patch, MagicMock
|
||||
from ansible_collections.community.routeros.tests.unit.plugins.modules.fake_api import FakeLibRouterosError, Key, fake_ros_api
|
||||
from ansible_collections.community.routeros.tests.unit.plugins.modules.fake_api import FakeLibRouterosError, Key, Or, fake_ros_api
|
||||
from ansible_collections.community.routeros.tests.unit.plugins.modules.utils import set_module_args, AnsibleExitJson, AnsibleFailJson, ModuleTestCase
|
||||
from ansible_collections.community.routeros.plugins.modules import api
|
||||
|
||||
|
|
@ -37,6 +37,7 @@ class TestRouterosApiModule(ModuleTestCase):
|
|||
self.patch_create_api = patch('ansible_collections.community.routeros.plugins.modules.api.create_api', MagicMock(new=fake_ros_api))
|
||||
self.patch_create_api.start()
|
||||
self.module.Key = MagicMock(new=Key)
|
||||
self.module.Or = MagicMock(new=Or)
|
||||
self.config_module_args = {"username": "admin",
|
||||
"password": "pаss",
|
||||
"hostname": "127.0.0.1",
|
||||
|
|
@ -164,6 +165,11 @@ class TestRouterosApiModule(ModuleTestCase):
|
|||
|
||||
result = exc.exception.args[0]
|
||||
self.assertEqual(result['changed'], False)
|
||||
self.assertEqual(result['msg'], [
|
||||
{'.id': '*A1', 'name': 'dummy_bridge_A1'},
|
||||
{'.id': '*A2', 'name': 'dummy_bridge_A2'},
|
||||
{'.id': '*A3', 'name': 'dummy_bridge_A3'},
|
||||
])
|
||||
|
||||
@patch('ansible_collections.community.routeros.plugins.modules.api.ROS_api_module.api_add_path', new=fake_ros_api)
|
||||
def test_api_query_missing_key(self):
|
||||
|
|
@ -175,6 +181,7 @@ class TestRouterosApiModule(ModuleTestCase):
|
|||
|
||||
result = exc.exception.args[0]
|
||||
self.assertEqual(result['changed'], False)
|
||||
self.assertEqual(result['msg'], ["no results for 'interface bridge 'query' .id other"])
|
||||
|
||||
@patch('ansible_collections.community.routeros.plugins.modules.api.ROS_api_module.api_add_path', new=fake_ros_api.select_where)
|
||||
def test_api_query_and_WHERE(self):
|
||||
|
|
@ -186,6 +193,9 @@ class TestRouterosApiModule(ModuleTestCase):
|
|||
|
||||
result = exc.exception.args[0]
|
||||
self.assertEqual(result['changed'], False)
|
||||
self.assertEqual(result['msg'], [
|
||||
{'.id': '*A1', 'name': 'dummy_bridge_A1'},
|
||||
])
|
||||
|
||||
@patch('ansible_collections.community.routeros.plugins.modules.api.ROS_api_module.api_add_path', new=fake_ros_api.select_where)
|
||||
def test_api_query_and_WHERE_no_cond(self):
|
||||
|
|
@ -197,3 +207,116 @@ class TestRouterosApiModule(ModuleTestCase):
|
|||
|
||||
result = exc.exception.args[0]
|
||||
self.assertEqual(result['changed'], False)
|
||||
self.assertEqual(result['msg'], [
|
||||
{'.id': '*A1', 'name': 'dummy_bridge_A1'},
|
||||
])
|
||||
|
||||
@patch('ansible_collections.community.routeros.plugins.modules.api.ROS_api_module.api_add_path', new=fake_ros_api)
|
||||
def test_api_extended_query(self):
|
||||
with self.assertRaises(AnsibleExitJson) as exc:
|
||||
module_args = self.config_module_args.copy()
|
||||
module_args['extended_query'] = {
|
||||
'attributes': ['.id', 'name'],
|
||||
}
|
||||
set_module_args(module_args)
|
||||
self.module.main()
|
||||
|
||||
result = exc.exception.args[0]
|
||||
self.assertEqual(result['changed'], False)
|
||||
self.assertEqual(result['msg'], [
|
||||
{'.id': '*A1', 'name': 'dummy_bridge_A1'},
|
||||
{'.id': '*A2', 'name': 'dummy_bridge_A2'},
|
||||
{'.id': '*A3', 'name': 'dummy_bridge_A3'},
|
||||
])
|
||||
|
||||
@patch('ansible_collections.community.routeros.plugins.modules.api.ROS_api_module.api_add_path', new=fake_ros_api)
|
||||
def test_api_extended_query_missing_key(self):
|
||||
with self.assertRaises(AnsibleExitJson) as exc:
|
||||
module_args = self.config_module_args.copy()
|
||||
module_args['extended_query'] = {
|
||||
'attributes': ['.id', 'other'],
|
||||
}
|
||||
set_module_args(module_args)
|
||||
self.module.main()
|
||||
|
||||
result = exc.exception.args[0]
|
||||
self.assertEqual(result['changed'], False)
|
||||
self.assertEqual(result['msg'], [])
|
||||
|
||||
@patch('ansible_collections.community.routeros.plugins.modules.api.ROS_api_module.api_add_path', new=fake_ros_api.select_where)
|
||||
def test_api_extended_query_and_WHERE(self):
|
||||
with self.assertRaises(AnsibleExitJson) as exc:
|
||||
module_args = self.config_module_args.copy()
|
||||
module_args['extended_query'] = {
|
||||
'attributes': ['.id', 'name'],
|
||||
'where': [
|
||||
{
|
||||
'attribute': 'name',
|
||||
'is': '==',
|
||||
'value': 'dummy_bridge_A2',
|
||||
},
|
||||
],
|
||||
}
|
||||
set_module_args(module_args)
|
||||
self.module.main()
|
||||
|
||||
result = exc.exception.args[0]
|
||||
self.assertEqual(result['changed'], False)
|
||||
self.assertEqual(result['msg'], [
|
||||
{'.id': '*A1', 'name': 'dummy_bridge_A1'},
|
||||
])
|
||||
|
||||
@patch('ansible_collections.community.routeros.plugins.modules.api.ROS_api_module.api_add_path', new=fake_ros_api.select_where)
|
||||
def test_api_extended_query_and_WHERE_no_cond(self):
|
||||
with self.assertRaises(AnsibleExitJson) as exc:
|
||||
module_args = self.config_module_args.copy()
|
||||
module_args['extended_query'] = {
|
||||
'attributes': ['.id', 'name'],
|
||||
'where': [
|
||||
{
|
||||
'attribute': 'name',
|
||||
'is': 'not',
|
||||
'value': 'dummy_bridge_A2',
|
||||
},
|
||||
],
|
||||
}
|
||||
set_module_args(module_args)
|
||||
self.module.main()
|
||||
|
||||
result = exc.exception.args[0]
|
||||
self.assertEqual(result['changed'], False)
|
||||
self.assertEqual(result['msg'], [
|
||||
{'.id': '*A1', 'name': 'dummy_bridge_A1'},
|
||||
])
|
||||
|
||||
@patch('ansible_collections.community.routeros.plugins.modules.api.ROS_api_module.api_add_path', new=fake_ros_api.select_where)
|
||||
def test_api_extended_query_and_WHERE_or(self):
|
||||
with self.assertRaises(AnsibleExitJson) as exc:
|
||||
module_args = self.config_module_args.copy()
|
||||
module_args['extended_query'] = {
|
||||
'attributes': ['.id', 'name'],
|
||||
'where': [
|
||||
{
|
||||
'or': [
|
||||
{
|
||||
'attribute': 'name',
|
||||
'is': 'in',
|
||||
'value': [1, 2],
|
||||
},
|
||||
{
|
||||
'attribute': 'name',
|
||||
'is': '!=',
|
||||
'value': 5,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}
|
||||
set_module_args(module_args)
|
||||
self.module.main()
|
||||
|
||||
result = exc.exception.args[0]
|
||||
self.assertEqual(result['changed'], False)
|
||||
self.assertEqual(result['msg'], [
|
||||
{'.id': '*A1', 'name': 'dummy_bridge_A1'},
|
||||
])
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue