mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Added redis_data module (#3230)
* Added redis_set module Added redis_set module and unit tests for the new module. Applied suggested changes and removed redis_del in favor of state option. Also added redis utility class that handles connection. * Typos, added version and BOTMETA * Fixed import error checking * Fixed Unit tests * Docfix and return consistency * Added Check Mode * Update plugins/modules/database/misc/redis_data.py Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Andreas Botzner
GitHub
parent
2ad7ed4f83
commit
424af85929
4 changed files with 529 additions and 0 deletions
2
.github/BOTMETA.yml
vendored
2
.github/BOTMETA.yml
vendored
|
|
@ -467,6 +467,8 @@ files:
|
|||
maintainers: levonet
|
||||
$modules/database/misc/redis_data_info.py:
|
||||
maintainers: paginabianca
|
||||
$modules/database/misc/redis_data.py:
|
||||
maintainers: paginabianca
|
||||
$modules/database/misc/riak.py:
|
||||
maintainers: drewkerrigan jsmartin
|
||||
$modules/database/mssql/mssql_db.py:
|
||||
|
|
|
|||
249
plugins/modules/database/misc/redis_data.py
Normal file
249
plugins/modules/database/misc/redis_data.py
Normal file
|
|
@ -0,0 +1,249 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2021, Andreas Botzner <andreas at botzner dot com>
|
||||
# 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
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: redis_data
|
||||
short_description: Set key value pairs in Redis
|
||||
version_added: 3.7.0
|
||||
description:
|
||||
- Set key value pairs in Redis database.
|
||||
author: "Andreas Botzner (@paginabianca)"
|
||||
options:
|
||||
key:
|
||||
description:
|
||||
- Database key.
|
||||
required: true
|
||||
type: str
|
||||
value:
|
||||
description:
|
||||
- Value that key should be set to.
|
||||
required: false
|
||||
type: str
|
||||
expiration:
|
||||
description:
|
||||
- Expiration time in milliseconds.
|
||||
Setting this flag will always result in a change in the database.
|
||||
required: false
|
||||
type: int
|
||||
non_existing:
|
||||
description:
|
||||
- Only set key if it does not already exist.
|
||||
required: false
|
||||
type: bool
|
||||
existing:
|
||||
description:
|
||||
- Only set key if it already exists.
|
||||
required: false
|
||||
type: bool
|
||||
keep_ttl:
|
||||
description:
|
||||
- Retain the time to live associated with the key.
|
||||
required: false
|
||||
type: bool
|
||||
state:
|
||||
description:
|
||||
- State of the key.
|
||||
default: present
|
||||
type: str
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.redis.documentation
|
||||
|
||||
seealso:
|
||||
- module: community.general.redis_data_info
|
||||
- module: community.general.redis
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Set key foo=bar on localhost with no username
|
||||
community.general.redis_data:
|
||||
login_host: localhost
|
||||
login_password: supersecret
|
||||
key: foo
|
||||
value: bar
|
||||
state: present
|
||||
|
||||
- name: Set key foo=bar if non existing with expiration of 30s
|
||||
community.general.redis_data:
|
||||
login_host: localhost
|
||||
login_password: supersecret
|
||||
key: foo
|
||||
value: bar
|
||||
non_existing: true
|
||||
expiration: 30000
|
||||
state: present
|
||||
|
||||
- name: Set key foo=bar if existing and keep current TTL
|
||||
community.general.redis_data:
|
||||
login_host: localhost
|
||||
login_password: supersecret
|
||||
key: foo
|
||||
value: bar
|
||||
existing: true
|
||||
keep_ttl: true
|
||||
|
||||
- name: Set key foo=bar on redishost with custom ca-cert file
|
||||
community.general.redis_data:
|
||||
login_host: redishost
|
||||
login_password: supersecret
|
||||
login_user: someuser
|
||||
validate_certs: true
|
||||
ssl_ca_certs: /path/to/ca/certs
|
||||
key: foo
|
||||
value: bar
|
||||
|
||||
- name: Delete key foo on localhost with no username
|
||||
community.general.redis_data:
|
||||
login_host: localhost
|
||||
login_password: supersecret
|
||||
key: foo
|
||||
state: absent
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
old_value:
|
||||
description: Value of key before setting.
|
||||
returned: on_success if state is C(present) and key exists in database.
|
||||
type: str
|
||||
sample: 'old_value_of_key'
|
||||
value:
|
||||
description: Value key was set to.
|
||||
returned: on success if state is C(present).
|
||||
type: str
|
||||
sample: 'new_value_of_key'
|
||||
msg:
|
||||
description: A short message.
|
||||
returned: always
|
||||
type: str
|
||||
sample: 'Set key: foo to bar'
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.community.general.plugins.module_utils.redis import (
|
||||
fail_imports, redis_auth_argument_spec, RedisAnsible)
|
||||
|
||||
|
||||
def main():
|
||||
redis_auth_args = redis_auth_argument_spec()
|
||||
module_args = dict(
|
||||
key=dict(type='str', required=True, no_log=False),
|
||||
value=dict(type='str', required=False),
|
||||
expiration=dict(type='int', required=False),
|
||||
non_existing=dict(type='bool', required=False),
|
||||
existing=dict(type='bool', required=False),
|
||||
keep_ttl=dict(type='bool', required=False),
|
||||
state=dict(type='str', default='present',
|
||||
choices=['present', 'absent']),
|
||||
)
|
||||
module_args.update(redis_auth_args)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=module_args,
|
||||
supports_check_mode=True,
|
||||
required_if=[('state', 'present', ('value',))],
|
||||
mutually_exclusive=[['non_existing', 'existing'],
|
||||
['keep_ttl', 'expiration']],)
|
||||
fail_imports(module)
|
||||
|
||||
redis = RedisAnsible(module)
|
||||
|
||||
key = module.params['key']
|
||||
value = module.params['value']
|
||||
px = module.params['expiration']
|
||||
nx = module.params['non_existing']
|
||||
xx = module.params['existing']
|
||||
keepttl = module.params['keep_ttl']
|
||||
state = module.params['state']
|
||||
set_args = {'name': key, 'value': value, 'px': px,
|
||||
'nx': nx, 'xx': xx, 'keepttl': keepttl}
|
||||
|
||||
result = {'changed': False}
|
||||
|
||||
old_value = None
|
||||
try:
|
||||
old_value = redis.connection.get(key)
|
||||
except Exception as e:
|
||||
msg = 'Failed to get value of key: {0} with exception: {1}'.format(
|
||||
key, str(e))
|
||||
result['msg'] = msg
|
||||
module.fail_json(**result)
|
||||
|
||||
if state == 'absent':
|
||||
if module.check_mode:
|
||||
if old_value is None:
|
||||
msg = 'Key: {0} not present'.format(key)
|
||||
result['msg'] = msg
|
||||
module.exit_json(**result)
|
||||
else:
|
||||
msg = 'Deleted key: {0}'.format(key)
|
||||
result['msg'] = msg
|
||||
module.exit_json(**result)
|
||||
try:
|
||||
ret = redis.connection.delete(key)
|
||||
if ret == 0:
|
||||
msg = 'Key: {0} not present'.format(key)
|
||||
result['msg'] = msg
|
||||
module.exit_json(**result)
|
||||
else:
|
||||
msg = 'Deleted key: {0}'.format(key)
|
||||
result['msg'] = msg
|
||||
result['changed'] = True
|
||||
module.exit_json(**result)
|
||||
except Exception as e:
|
||||
msg = 'Failed to delete key: {0} with exception: {1}'.format(
|
||||
key, str(e))
|
||||
result['msg'] = msg
|
||||
module.fail_json(**result)
|
||||
|
||||
old_value = None
|
||||
try:
|
||||
old_value = redis.connection.get(key)
|
||||
except Exception as e:
|
||||
msg = 'Failed to get value of key: {0} with exception: {1}'.format(
|
||||
key, str(e))
|
||||
result['msg'] = msg
|
||||
module.fail_json(**result)
|
||||
|
||||
result['old_value'] = old_value
|
||||
if old_value == value and keepttl is not False and px is None:
|
||||
msg = 'Key {0} already has desired value'.format(key)
|
||||
result['msg'] = msg
|
||||
result['value'] = value
|
||||
module.exit_json(**result)
|
||||
if module.check_mode:
|
||||
result['msg'] = 'Set key: {0}'.format(key)
|
||||
result['value'] = value
|
||||
module.exit_json(**result)
|
||||
try:
|
||||
ret = redis.connection.set(**set_args)
|
||||
if ret is None:
|
||||
if nx:
|
||||
msg = 'Could not set key: {0}. Key already present.'.format(
|
||||
key)
|
||||
else:
|
||||
msg = 'Could not set key: {0}. Key not present.'.format(key)
|
||||
result['msg'] = msg
|
||||
module.fail_json(**result)
|
||||
msg = 'Set key: {0}'.format(key)
|
||||
result['msg'] = msg
|
||||
result['changed'] = True
|
||||
result['value'] = value
|
||||
module.exit_json(**result)
|
||||
except Exception as e:
|
||||
msg = 'Failed to set key: {0} with exception: {2}'.format(key, str(e))
|
||||
result['msg'] = msg
|
||||
module.fail_json(**result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
1
plugins/modules/redis_data.py
Symbolic link
1
plugins/modules/redis_data.py
Symbolic link
|
|
@ -0,0 +1 @@
|
|||
./database/misc/redis_data.py
|
||||
277
tests/unit/plugins/modules/database/misc/test_redis_data.py
Normal file
277
tests/unit/plugins/modules/database/misc/test_redis_data.py
Normal file
|
|
@ -0,0 +1,277 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright: (c) 2021, Andreas Botzner <andreas at botzner dot com>
|
||||
# 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
|
||||
|
||||
|
||||
import pytest
|
||||
import json
|
||||
from redis import __version__
|
||||
|
||||
from ansible_collections.community.general.plugins.modules.database.misc import redis_data
|
||||
from ansible_collections.community.general.tests.unit.plugins.modules.utils import set_module_args
|
||||
|
||||
HAS_REDIS_USERNAME_OPTION = True
|
||||
if tuple(map(int, __version__.split('.'))) < (3, 4, 0):
|
||||
HAS_REDIS_USERNAME_OPTION = False
|
||||
|
||||
|
||||
def test_redis_data_without_arguments(capfd):
|
||||
set_module_args({})
|
||||
with pytest.raises(SystemExit) as results:
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
assert not err
|
||||
assert json.loads(out)['failed']
|
||||
|
||||
|
||||
@pytest.mark.skipif(not HAS_REDIS_USERNAME_OPTION, reason="Redis version < 3.4.0")
|
||||
def test_redis_data_key(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_user': 'root',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'value': 'baz',
|
||||
'_ansible_check_mode': False})
|
||||
mocker.patch('redis.Redis.get', return_value='bar')
|
||||
mocker.patch('redis.Redis.set', return_value=True)
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['old_value'] == 'bar'
|
||||
assert json.loads(out)['value'] == 'baz'
|
||||
assert json.loads(out)['msg'] == 'Set key: foo'
|
||||
assert json.loads(out)['changed'] is True
|
||||
|
||||
|
||||
@pytest.mark.skipif(not HAS_REDIS_USERNAME_OPTION, reason="Redis version < 3.4.0")
|
||||
def test_redis_data_existing_key_nx(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_user': 'root',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'value': 'baz',
|
||||
'non_existing': True,
|
||||
'_ansible_check_mode': False})
|
||||
mocker.patch('redis.Redis.get', return_value='bar')
|
||||
mocker.patch('redis.Redis.set', return_value=None)
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['old_value'] == 'bar'
|
||||
assert 'value' not in json.loads(out)
|
||||
assert json.loads(
|
||||
out)['msg'] == 'Could not set key: foo. Key already present.'
|
||||
assert json.loads(out)['changed'] is False
|
||||
assert json.loads(out)['failed'] is True
|
||||
|
||||
|
||||
@pytest.mark.skipif(not HAS_REDIS_USERNAME_OPTION, reason="Redis version < 3.4.0")
|
||||
def test_redis_data_non_existing_key_xx(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_user': 'root',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'value': 'baz',
|
||||
'existing': True,
|
||||
'_ansible_check_mode': False})
|
||||
mocker.patch('redis.Redis.get', return_value=None)
|
||||
mocker.patch('redis.Redis.set', return_value=None)
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['old_value'] is None
|
||||
assert 'value' not in json.loads(out)
|
||||
assert json.loads(
|
||||
out)['msg'] == 'Could not set key: foo. Key not present.'
|
||||
assert json.loads(out)['changed'] is False
|
||||
assert json.loads(out)['failed'] is True
|
||||
|
||||
|
||||
@pytest.mark.skipif(not HAS_REDIS_USERNAME_OPTION, reason="Redis version < 3.4.0")
|
||||
def test_redis_data_delete_present_key(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_user': 'root',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'state': 'absent'})
|
||||
mocker.patch('redis.Redis.get', return_value='bar')
|
||||
mocker.patch('redis.Redis.delete', return_value=1)
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['msg'] == 'Deleted key: foo'
|
||||
assert json.loads(out)['changed'] is True
|
||||
|
||||
|
||||
@pytest.mark.skipif(not HAS_REDIS_USERNAME_OPTION, reason="Redis version < 3.4.0")
|
||||
def test_redis_data_delete_absent_key(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_user': 'root',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'state': 'absent'})
|
||||
mocker.patch('redis.Redis.delete', return_value=0)
|
||||
mocker.patch('redis.Redis.get', return_value=None)
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['msg'] == 'Key: foo not present'
|
||||
assert json.loads(out)['changed'] is False
|
||||
|
||||
|
||||
@pytest.mark.skipif(HAS_REDIS_USERNAME_OPTION, reason="Redis version > 3.4.0")
|
||||
def test_redis_data_fail_username(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_user': 'root',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'value': 'baz',
|
||||
'_ansible_check_mode': False})
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['failed']
|
||||
assert json.loads(
|
||||
out)['msg'] == 'The option `username` in only supported with redis >= 3.4.0.'
|
||||
|
||||
|
||||
def test_redis_data_key_no_username(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'value': 'baz',
|
||||
'_ansible_check_mode': False})
|
||||
mocker.patch('redis.Redis.get', return_value='bar')
|
||||
mocker.patch('redis.Redis.set', return_value=True)
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['old_value'] == 'bar'
|
||||
assert json.loads(out)['value'] == 'baz'
|
||||
assert json.loads(out)['msg'] == 'Set key: foo'
|
||||
assert json.loads(out)['changed'] is True
|
||||
|
||||
|
||||
def test_redis_delete_key_no_username(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'state': 'absent',
|
||||
'_ansible_check_mode': False})
|
||||
mocker.patch('redis.Redis.get', return_value='bar')
|
||||
mocker.patch('redis.Redis.delete', return_value=1)
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['msg'] == 'Deleted key: foo'
|
||||
assert json.loads(out)['changed'] is True
|
||||
|
||||
|
||||
def test_redis_delete_key_non_existent_key(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'state': 'absent',
|
||||
'_ansible_check_mode': False})
|
||||
mocker.patch('redis.Redis.get', return_value=None)
|
||||
mocker.patch('redis.Redis.delete', return_value=0)
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['msg'] == 'Key: foo not present'
|
||||
assert json.loads(out)['changed'] is False
|
||||
|
||||
|
||||
def test_redis_set_key_check_mode_nochange(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'state': 'present',
|
||||
'value': 'bar',
|
||||
'_ansible_check_mode': True})
|
||||
mocker.patch('redis.Redis.get', return_value='bar')
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['msg'] == 'Key foo already has desired value'
|
||||
assert json.loads(out)['value'] == 'bar'
|
||||
assert not json.loads(out)['changed']
|
||||
assert json.loads(out)['old_value'] == 'bar'
|
||||
|
||||
|
||||
def test_redis_set_key_check_mode_delete_nx(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'state': 'present',
|
||||
'value': 'baz',
|
||||
'_ansible_check_mode': True})
|
||||
mocker.patch('redis.Redis.get', return_value=None)
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['msg'] == 'Set key: foo'
|
||||
assert json.loads(out)['value'] == 'baz'
|
||||
assert json.loads(out)['old_value'] is None
|
||||
|
||||
|
||||
def test_redis_set_key_check_mode_delete(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'state': 'present',
|
||||
'value': 'baz',
|
||||
'_ansible_check_mode': True})
|
||||
mocker.patch('redis.Redis.get', return_value='bar')
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['msg'] == 'Set key: foo'
|
||||
assert json.loads(out)['value'] == 'baz'
|
||||
assert json.loads(out)['old_value'] == 'bar'
|
||||
|
||||
|
||||
def test_redis_set_key_check_mode(capfd, mocker):
|
||||
set_module_args({'login_host': 'localhost',
|
||||
'login_password': 'secret',
|
||||
'key': 'foo',
|
||||
'state': 'present',
|
||||
'value': 'baz',
|
||||
'_ansible_check_mode': True})
|
||||
mocker.patch('redis.Redis.get', return_value='bar')
|
||||
with pytest.raises(SystemExit):
|
||||
redis_data.main()
|
||||
out, err = capfd.readouterr()
|
||||
print(out)
|
||||
assert not err
|
||||
assert json.loads(out)['msg'] == 'Set key: foo'
|
||||
assert json.loads(out)['value'] == 'baz'
|
||||
assert json.loads(out)['old_value'] == 'bar'
|
||||
Loading…
Reference in a new issue