# -*- coding: utf-8 -*- # (c) 2012-2014, Michael DeHaan # (c) 2017, Ansible Project # 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 sys import json import syslog from itertools import product import pytest import ansible.module_utils.basic from ansible.module_utils.six import PY3 try: # Python 3.4+ from importlib import reload except ImportError: # Python 2 has reload as a builtin # Ignoring python3.0-3.3 (those have imp.reload if we decide we care) pass class TestAnsibleModuleLogSmokeTest: DATA = [u'Text string', u'Toshio くらとみ non-ascii test'] DATA = DATA + [d.encode('utf-8') for d in DATA] DATA += [b'non-utf8 :\xff: test'] # pylint bug: https://github.com/PyCQA/pylint/issues/511 @pytest.mark.parametrize('msg, stdin', ((m, {}) for m in DATA), indirect=['stdin']) # pylint: disable=undefined-variable def test_smoketest_syslog(self, am, mocker, msg): # These talk to the live daemons on the system. Need to do this to # show that what we send doesn't cause an issue once it gets to the # daemon. These are just smoketests to test that we don't fail. mocker.patch('ansible.module_utils.basic.has_journal', False) am.log(u'Text string') am.log(u'Toshio くらとみ non-ascii test') am.log(b'Byte string') am.log(u'Toshio くらとみ non-ascii test'.encode('utf-8')) am.log(b'non-utf8 :\xff: test') @pytest.mark.skipif(not ansible.module_utils.basic.has_journal, reason='python systemd bindings not installed') # pylint bug: https://github.com/PyCQA/pylint/issues/511 @pytest.mark.parametrize('msg, stdin', ((m, {}) for m in DATA), indirect=['stdin']) # pylint: disable=undefined-variable def test_smoketest_journal(self, am, mocker, msg): # These talk to the live daemons on the system. Need to do this to # show that what we send doesn't cause an issue once it gets to the # daemon. These are just smoketests to test that we don't fail. mocker.patch('ansible.module_utils.basic.has_journal', True) am.log(u'Text string') am.log(u'Toshio くらとみ non-ascii test') am.log(b'Byte string') am.log(u'Toshio くらとみ non-ascii test'.encode('utf-8')) am.log(b'non-utf8 :\xff: test') class TestAnsibleModuleLogSyslog: """Test the AnsibleModule Log Method""" PY2_OUTPUT_DATA = { u'Text string': b'Text string', u'Toshio くらとみ non-ascii test': u'Toshio くらとみ non-ascii test'.encode('utf-8'), b'Byte string': b'Byte string', u'Toshio くらとみ non-ascii test'.encode('utf-8'): u'Toshio くらとみ non-ascii test'.encode('utf-8'), b'non-utf8 :\xff: test': b'non-utf8 :\xff: test'.decode('utf-8', 'replace').encode('utf-8'), } PY3_OUTPUT_DATA = { u'Text string': u'Text string', u'Toshio くらとみ non-ascii test': u'Toshio くらとみ non-ascii test', b'Byte string': u'Byte string', u'Toshio くらとみ non-ascii test'.encode('utf-8'): u'Toshio くらとみ non-ascii test', b'non-utf8 :\xff: test': b'non-utf8 :\xff: test'.decode('utf-8', 'replace') } @pytest.mark.parametrize('no_log, stdin', (product((True, False), [{}])), indirect=['stdin']) def test_no_log(self, am, mocker, no_log): """Test that when no_log is set, logging does not occur""" mock_syslog = mocker.patch('syslog.syslog', autospec=True) mocker.patch('ansible.module_utils.basic.has_journal', False) am.no_log = no_log am.log('unittest no_log') if no_log: assert not mock_syslog.called else: mock_syslog.assert_called_once_with(syslog.LOG_INFO, 'unittest no_log') # pylint bug: https://github.com/PyCQA/pylint/issues/511 @pytest.mark.parametrize('msg, param, stdin', ((m, p, {}) for m, p in (PY3_OUTPUT_DATA.items() if PY3 else PY2_OUTPUT_DATA.items())), # pylint: disable=undefined-variable indirect=['stdin']) def test_output_matches(self, am, mocker, msg, param): """Check that log messages are sent correctly""" mocker.patch('ansible.module_utils.basic.has_journal', False) mock_syslog = mocker.patch('syslog.syslog', autospec=True) am.log(msg) mock_syslog.assert_called_once_with(syslog.LOG_INFO, param) @pytest.mark.skipif(not ansible.module_utils.basic.has_journal, reason='python systemd bindings not installed') class TestAnsibleModuleLogJournal: """Test the AnsibleModule Log Method""" OUTPUT_DATA = { u'Text string': u'Text string', u'Toshio くらとみ non-ascii test': u'Toshio くらとみ non-ascii test', b'Byte string': u'Byte string', u'Toshio くらとみ non-ascii test'.encode('utf-8'): u'Toshio くらとみ non-ascii test', b'non-utf8 :\xff: test': b'non-utf8 :\xff: test'.decode('utf-8', 'replace') } @pytest.mark.parametrize('no_log, stdin', (product((True, False), [{}])), indirect=['stdin']) def test_no_log(self, am, mocker, no_log): journal_send = mocker.patch('systemd.journal.send') am.no_log = no_log am.log('unittest no_log') if no_log: assert not journal_send.called else: assert journal_send.called == 1 # Message # call_args is a 2-tuple of (arg_list, kwarg_dict) assert journal_send.call_args[0][0].endswith('unittest no_log'), 'Message was not sent to log' # log adds this journal field assert 'MODULE' in journal_send.call_args[1] assert 'basic.py' in journal_send.call_args[1]['MODULE'] # pylint bug: https://github.com/PyCQA/pylint/issues/511 @pytest.mark.parametrize('msg, param, stdin', ((m, p, {}) for m, p in OUTPUT_DATA.items()), # pylint: disable=undefined-variable indirect=['stdin']) def test_output_matches(self, am, mocker, msg, param): journal_send = mocker.patch('systemd.journal.send') am.log(msg) assert journal_send.call_count == 1, 'journal.send not called exactly once' assert journal_send.call_args[0][0].endswith(param) @pytest.mark.parametrize('stdin', ({},), indirect=['stdin']) def test_log_args(self, am, mocker): journal_send = mocker.patch('systemd.journal.send') am.log('unittest log_args', log_args=dict(TEST='log unittest')) assert journal_send.called == 1 assert journal_send.call_args[0][0].endswith('unittest log_args'), 'Message was not sent to log' # log adds this journal field assert 'MODULE' in journal_send.call_args[1] assert 'basic.py' in journal_send.call_args[1]['MODULE'] # We added this journal field assert 'TEST' in journal_send.call_args[1] assert 'log unittest' in journal_send.call_args[1]['TEST']