Add info command to redis module (#286)

* Add info command to redis module

* Fix sanity test

* Create a separate redis_info module

* Type of arguments in documentation was determined

* Add redis_info test

* Fix sanity test

* Add integration test

* Add integration platforms (centos7/8,fedora30/31,opensuse15+py2,ubuntu1604/1804)

* Add centos6 support

* Fix suggestions

* Add contact email

tests/integration/targets/redis_info/aliases

@@ -0,0 +1,5 @@
+destructive
+shippable/posix/group1
+skip/aix
+skip/osx
+skip/rhel

tests/integration/targets/redis_info/defaults/main.yml

@@ -0,0 +1,4 @@
+---
+redis_password: PASS
+master_port: 6379
+slave_port: 6380

tests/integration/targets/redis_info/meta/main.yml

@@ -0,0 +1,2 @@
+dependencies:
+- setup_redis_replication

tests/integration/targets/redis_info/tasks/main.yml

@@ -0,0 +1,42 @@
+# Copyright: (c) 2020, Pavlo Bashynskyi (@levonet) <levonet@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+- name: redis_info - connect to master with default host/port
+  community.general.redis_info:
+    login_password: "{{ redis_password }}"
+  register: result
+
+- assert:
+    that:
+    - result is not changed
+    - result.info is defined
+    - result.info.tcp_port == master_port
+    - result.info.role == 'master'
+
+- name: redis_info - connect to master (check)
+  community.general.redis_info:
+    login_host: 127.0.0.1
+    login_port: "{{ master_port }}"
+    login_password: "{{ redis_password }}"
+  check_mode: yes
+  register: result
+
+- assert:
+    that:
+    - result is not changed
+    - result.info is defined
+    - result.info.tcp_port == master_port
+    - result.info.role == 'master'
+
+- name: redis_info - connect to slave
+  community.general.redis_info:
+    login_port: "{{ slave_port }}"
+    login_password: "{{ redis_password }}"
+  register: result
+
+- assert:
+    that:
+    - result is not changed
+    - result.info is defined
+    - result.info.tcp_port == slave_port
+    - result.info.role == 'slave'

tests/integration/targets/setup_redis_replication/defaults/main.yml

@@ -0,0 +1,35 @@
+# General
+redis_packages:
+  Ubuntu:
+  - redis-server
+  openSUSE Leap:
+  - redis
+  Fedora:
+  - redis
+  CentOS:
+  - redis
+  FreeBSD:
+  - redis
+
+redis_bin:
+  Ubuntu: /usr/bin/redis-server
+  openSUSE Leap: /usr/sbin/redis-server
+  Fedora: /usr/bin/redis-server
+  CentOS: /usr/bin/redis-server
+  FreeBSD: /usr/local/bin/redis-server
+
+redis_module: "{{ (ansible_python_version is version('2.7', '>=')) | ternary('redis', 'redis==2.10.6') }}"
+
+redis_password: PASS
+
+# Master
+master_port: 6379
+master_conf: /etc/redis-master.conf
+master_datadir: /var/lib/redis-master
+master_logdir: /var/log/redis-master
+
+# Slave
+slave_port: 6380
+slave_conf: /etc/redis-slave.conf
+slave_datadir: /var/lib/redis-slave
+slave_logdir: /var/log/redis-slave

tests/integration/targets/setup_redis_replication/handlers/main.yml

@@ -0,0 +1,34 @@
+- name: stop redis services
+  shell: |
+    kill -TERM $(cat /var/run/redis_{{ master_port }}.pid)
+    kill -TERM $(cat /var/run/redis_{{ slave_port }}.pid)
+  listen: cleanup redis
+
+- name: remove redis packages
+  action: "{{ ansible_facts.pkg_mgr }}"
+  args:
+    name: "{{ item }}"
+    state: absent
+  loop: "{{ redis_packages[ansible_distribution] }}"
+  listen: cleanup redis
+
+- name: remove pip packages
+  pip:
+    name: redis
+    state: absent
+  listen: cleanup redis
+
+- name: remove redis data
+  file:
+    path: "{{ item }}"
+    state: absent
+  loop:
+  - "{{ master_conf }}"
+  - "{{ master_datadir }}"
+  - "{{ master_logdir }}"
+  - /var/run/redis_{{ master_port }}.pid
+  - "{{ slave_conf }}"
+  - "{{ slave_datadir }}"
+  - "{{ slave_logdir }}"
+  - /var/run/redis_{{ slave_port }}.pid
+  listen: cleanup redis

tests/integration/targets/setup_redis_replication/meta/main.yml

@@ -0,0 +1,2 @@
+dependencies:
+- setup_pkg_mgr

tests/integration/targets/setup_redis_replication/tasks/main.yml

@@ -0,0 +1,6 @@
+# Copyright: (c) 2020, Pavlo Bashynskyi (@levonet) <levonet@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+- import_tasks: setup_redis_cluster.yml
+  when:
+  - ansible_distribution in ['CentOS', 'Fedora', 'FreeBSD', 'openSUSE Leap', 'Ubuntu']

tests/integration/targets/setup_redis_replication/tasks/setup_redis_cluster.yml

@@ -0,0 +1,105 @@
+# We run two servers listening different ports
+# to be able to check replication (one server for master, another for slave).
+
+- name: Install redis server apt dependencies
+  apt:
+    name: "{{ redis_packages[ansible_distribution] }}"
+    state: latest
+    policy_rc_d: 101
+  when:
+  - ansible_facts.pkg_mgr == 'apt'
+  notify: cleanup redis
+
+- name: Install redis server rpm dependencies
+  yum:
+    name: "{{ redis_packages[ansible_distribution] }}"
+    state: latest
+  when:
+  - ansible_facts.pkg_mgr == 'yum'
+  notify: cleanup redis
+
+- name: Install redis rpm dependencies
+  dnf:
+    name: "{{ redis_packages[ansible_distribution] }}"
+    state: latest
+  when: ansible_facts.pkg_mgr == 'dnf'
+  notify: cleanup redis
+
+- name: Install redis server zypper dependencies
+  zypper:
+    name: "{{ redis_packages[ansible_distribution] }}"
+    state: latest
+  when:
+  - ansible_facts.pkg_mgr == 'community.general.zypper'
+  notify: cleanup redis
+
+- name: Install redis FreeBSD dependencies
+  community.general.pkgng:
+    name: "{{ redis_packages[ansible_distribution] }}"
+    state: latest
+  when:
+  - ansible_facts.pkg_mgr == 'community.general.pkgng'
+  notify: cleanup redis
+
+- name: Install redis module
+  pip:
+    name: "{{ redis_module }}"
+    state: present
+  notify: cleanup redis
+
+- name: Create redis directories
+  file:                                                                                                                                                                                                 
+    path: "{{ item }}"
+    state: directory                                                                                                                                                                                    
+    owner: redis
+    group: redis
+  loop:
+  - "{{ master_datadir }}"
+  - "{{ master_logdir }}"
+  - "{{ slave_datadir }}"
+  - "{{ slave_logdir }}"
+
+- name: Create redis configs
+  copy:
+    dest: "{{ item.file }}"
+    content: |
+      daemonize yes
+      port {{ item.port }}
+      pidfile /var/run/redis_{{ item.port }}.pid
+      logfile {{ item.logdir }}/redis.log
+      dir {{ item.datadir }}
+      requirepass {{ redis_password }}
+      masterauth {{ redis_password }}
+  loop:
+  - file: "{{ master_conf }}"
+    port: "{{ master_port }}"
+    logdir: "{{ master_logdir }}"
+    datadir: "{{ master_datadir }}"
+  - file: "{{ slave_conf }}"
+    port: "{{ slave_port }}"
+    logdir: "{{ slave_logdir }}"
+    datadir: "{{ slave_datadir }}"
+
+- name: Start redis master
+  shell: "{{ redis_bin[ansible_distribution] }} {{ master_conf }}"
+
+- name: Start redis slave
+  shell: "{{ redis_bin[ansible_distribution] }} {{ slave_conf }} --slaveof 127.0.0.1 {{ master_port }}"
+
+- name: Wait for redis master to be started
+  wait_for:
+    host: 127.0.0.1
+    port: "{{ master_port }}"
+    state: started
+    delay: 1
+    connect_timeout: 5
+    timeout: 30
+
+- name: Wait for redis slave to be started
+  wait_for:
+    host: 127.0.0.1
+    port: "{{ slave_port }}"
+    state: started
+    delay: 1
+    connect_timeout: 5
+    timeout: 30

tests/unit/plugins/modules/database/misc/test_redis_info.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2020, Pavlo Bashynskyi (@levonet) <levonet@gmail.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
+
+from ansible_collections.community.general.tests.unit.compat.mock import patch, MagicMock
+from ansible_collections.community.general.plugins.modules.database.misc import redis_info
+from ansible_collections.community.general.tests.unit.plugins.modules.utils import AnsibleExitJson, AnsibleFailJson, ModuleTestCase, set_module_args
+
+
+class FakeRedisClient(MagicMock):
+
+    def ping(self):
+        pass
+
+    def info(self):
+        return {'redis_version': '999.999.999'}
+
+
+class FakeRedisClientFail(MagicMock):
+
+    def ping(self):
+        raise Exception('Test Error')
+
+    def info(self):
+        pass
+
+
+class TestRedisInfoModule(ModuleTestCase):
+
+    def setUp(self):
+        super(TestRedisInfoModule, self).setUp()
+        redis_info.HAS_REDIS_PACKAGE = True
+        self.module = redis_info
+
+    def tearDown(self):
+        super(TestRedisInfoModule, self).tearDown()
+
+    def patch_redis_client(self, **kwds):
+        return patch('ansible_collections.community.general.plugins.modules.database.misc.redis_info.redis_client', autospec=True, **kwds)
+
+    def test_without_parameters(self):
+        """Test without parameters"""
+        with self.patch_redis_client(side_effect=FakeRedisClient) as redis_client:
+            with self.assertRaises(AnsibleExitJson) as result:
+                set_module_args({})
+                self.module.main()
+            self.assertEqual(redis_client.call_count, 1)
+            self.assertEqual(redis_client.call_args, ({'host': 'localhost', 'port': 6379, 'password': None},))
+            self.assertEqual(result.exception.args[0]['info']['redis_version'], '999.999.999')
+
+    def test_with_parameters(self):
+        """Test with all parameters"""
+        with self.patch_redis_client(side_effect=FakeRedisClient) as redis_client:
+            with self.assertRaises(AnsibleExitJson) as result:
+                set_module_args({
+                    'login_host': 'test',
+                    'login_port': 1234,
+                    'login_password': 'PASS'
+                })
+                self.module.main()
+            self.assertEqual(redis_client.call_count, 1)
+            self.assertEqual(redis_client.call_args, ({'host': 'test', 'port': 1234, 'password': 'PASS'},))
+            self.assertEqual(result.exception.args[0]['info']['redis_version'], '999.999.999')
+
+    def test_with_fail_client(self):
+        """Test failure message"""
+        with self.patch_redis_client(side_effect=FakeRedisClientFail) as redis_client:
+            with self.assertRaises(AnsibleFailJson) as result:
+                set_module_args({})
+                self.module.main()
+            self.assertEqual(redis_client.call_count, 1)
+            self.assertEqual(result.exception.args[0]['msg'], 'unable to connect to database: Test Error')