openstack/monasca-agent
Code Issues Proposed changes

Use unittest.mock instead of mock

Browse Source 
The mock third party library was needed for mock support in py2
runtimes. Since we now only support py36 and later, we can use the
standard lib unittest.mock module instead.

Change-Id: Ia3f2c8abc87cf5551d3469d616790e8e9d567bce
This commit is contained in:
Martin Chacon Piza 2020-08-10 13:41:08 +02:00
parent 3d0f3e2435
commit d3cc8c1e7d
5 changed files with 63 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
tests/detection/test_cert_check.py
View File

@ -14,8 +14,6 @@
import logging
import unittest
from mock import patch
from monasca_setup.detection.plugins.cert_check import CertificateCheck
LOG = logging.getLogger('monasca_setup.detection.plugins.cert_check')
@ -25,21 +23,21 @@ class TestCertCheck(unittest.TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
with patch.object(CertificateCheck, '_detect') as mock_detect:
with unittest.mock.patch.object(CertificateCheck, '_detect') as mock_detect:
self.cert_obj = CertificateCheck('temp_dir')
self.assertTrue(mock_detect.called)
self.cert_obj.args = {'urls': 'http://fake-cert.com'}
def test_detect(self):
self.cert_obj.available = False
with patch.object(self.cert_obj, '_check_required_args',
with unittest.mock.patch.object(self.cert_obj, '_check_required_args',
return_value=True) as mock_check_required_args:
self.cert_obj._detect()
self.assertTrue(self.cert_obj.available)
self.assertTrue(mock_check_required_args.called)
def _build_config(self):
with patch.object(self.cert_obj, '_build_instance',
with unittest.mock.patch.object(self.cert_obj, '_build_instance',
return_value={}) as mock_build_instance:
result = self.cert_obj.build_config()
self.assertTrue(mock_build_instance.called)
@ -80,7 +78,7 @@ class TestCertCheck(unittest.TestCase):
'ciphers': 'fake-cipher',
'timeout': 0.0,
'collect_period': 1200})
with patch.object(LOG, 'error') as mock_log:
with unittest.mock.patch.object(LOG, 'error') as mock_log:
result = self._build_config()
self.assertEqual(result['cert_check']['init_config']['ca_certs'],
'/tmp/ssl/certs/ca-certificates.crt')

8
tests/detection/test_cert_file_check.py
View File

@ -15,8 +15,6 @@
import logging
import unittest
from mock import patch
from monasca_setup.detection.plugins.cert_file_check import CertificateFileCheck
LOG = logging.getLogger('monasca_setup.detection.plugins.cert_check')
@ -26,21 +24,21 @@ class TestCertFileCheck(unittest.TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
with patch.object(CertificateFileCheck, '_detect') as mock_detect:
with unittest.mock.patch.object(CertificateFileCheck, '_detect') as mock_detect:
self.cert_obj = CertificateFileCheck('temp_dir')
self.assertTrue(mock_detect.called)
self.cert_obj.args = {'cert_files': '/etc/myservice/myserver.pem'}
def test_detect(self):
self.cert_obj.available = False
with patch.object(self.cert_obj, '_check_required_args',
with unittest.mock.patch.object(self.cert_obj, '_check_required_args',
return_value=True) as mock_check_required_args:
self.cert_obj._detect()
self.assertTrue(self.cert_obj.available)
self.assertTrue(mock_check_required_args.called)
def _build_config(self):
with patch.object(self.cert_obj, '_build_instance',
with unittest.mock.patch.object(self.cert_obj, '_build_instance',
return_value={}) as mock_build_instance:
result = self.cert_obj.build_config()
self.assertTrue(mock_build_instance.called)

100
tests/detection/test_ovs.py
View File

@ -15,12 +15,10 @@ import logging
import os
import psutil
import re
import unittest
from unittest import mock
from unittest import TestCase
from oslo_config import cfg
from mock import patch
from mock.mock import MagicMock
from six.moves import configparser
from monasca_setup.detection import utils
@ -45,15 +43,15 @@ class ps_util_get_proc:
return ['/opt/fake.txt']
class TestOvs(unittest.TestCase):
class TestOvs(TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
with patch.object(Ovs, '_detect') as mock_detect:
TestCase.setUp(self)
with mock.patch.object(Ovs, '_detect') as mock_detect:
self.ovs_obj = Ovs('temp_dir')
self.has_option = [True, False, True, False, False, True]
self.get_value = [MagicMock(), MagicMock(), MagicMock(),
MagicMock(), MagicMock(), 'http://10.10.10.10',
self.get_value = [mock.MagicMock(), mock.MagicMock(), mock.MagicMock(),
mock.MagicMock(), mock.MagicMock(), 'http://10.10.10.10',
'region1']
self.assertTrue(mock_detect.called)
@ -61,34 +59,34 @@ class TestOvs(unittest.TestCase):
ovs_obj.neutron_conf = None
ovs_obj.available = False
with patch.object(cfg, 'CONF') as mock_conf, \
patch.object(psutil, 'process_iter',
return_value=[ps_util_get_proc()]) \
with mock.patch.object(cfg, 'CONF') as mock_conf, \
mock.patch.object(psutil, 'process_iter',
return_value=[ps_util_get_proc()]) \
as mock_process_iter, \
patch.object(os.path, 'isfile', return_value=True) \
mock.patch.object(os.path, 'isfile', return_value=True) \
as mock_isfile,\
patch.object(ovs_obj, 'dependencies_installed', return_value=True) \
mock.patch.object(ovs_obj, 'dependencies_installed', return_value=True) \
as dependencies,\
patch.object(ovs_obj, '_is_neutron_conf_valid',
return_value=file_config_valid) as _:
mock.patch.object(ovs_obj, '_is_neutron_conf_valid',
return_value=file_config_valid) as _:
ovs_obj._detect()
self.assertTrue(mock_process_iter.called)
if not ps_util_get_proc.cmdLine:
self.assertFalse(mock_isfile.called)
def _build_config(self, ovs_obj, dependencies_installed=True):
ovs_obj.conf = MagicMock()
ovs_obj.conf = mock.MagicMock()
ovs_obj.conf.default_config_files = ovs_obj.neutron_conf
ovs_obj.conf.default_config_dirs = os.path.abspath(os.path.join(ovs_obj.neutron_conf, os.pardir))
with patch.object(configparser, 'SafeConfigParser') as mock_config_parser:
with mock.patch.object(configparser, 'SafeConfigParser') as mock_config_parser:
config_parser_obj = mock_config_parser.return_value
with patch.object(cfg, 'CONF') as mock_conf, \
patch.object(LOG, 'info') as mock_log_info,\
patch.object(ovs_obj, 'has_option',
side_effect=self.has_option) as mock_has_option, \
patch.object(ovs_obj, 'get_option',
side_effect=self.get_value) as mock_get:
with mock.patch.object(cfg, 'CONF') as mock_conf, \
mock.patch.object(LOG, 'info') as mock_log_info, \
mock.patch.object(ovs_obj, 'has_option',
side_effect=self.has_option) as mock_has_option, \
mock.patch.object(ovs_obj, 'get_option',
side_effect=self.get_value) as mock_get:
result = ovs_obj.build_config()
if dependencies_installed:
self.assertTrue(mock_log_info.called)
@ -108,11 +106,11 @@ class TestOvs(unittest.TestCase):
13000)
self.assertFalse(result['ovs']['init_config']['network_use_bits'])
self.assertIsInstance(result['ovs']['init_config']['username'],
MagicMock)
mock.MagicMock)
self.assertIsInstance(result['ovs']['init_config']['password'],
MagicMock)
mock.MagicMock)
self.assertIsInstance(result['ovs']['init_config']['project_name'],
MagicMock)
mock.MagicMock)
self.assertEqual(result['ovs']['init_config']['auth_url'],
'http://10.10.10.10')
self.assertEqual(result['ovs']['init_config']['region_name'],
@ -138,18 +136,18 @@ class TestOvs(unittest.TestCase):
self.assertEqual(result['ovs']['init_config']['included_interface_re'],
'qg.*|vhu.*|sg.*')
self.assertIsInstance(result['ovs']['init_config']['username'],
MagicMock)
mock.MagicMock)
self.assertIsInstance(result['ovs']['init_config']['password'],
MagicMock)
mock.MagicMock)
self.assertIsInstance(result['ovs']['init_config']['project_name'],
MagicMock)
mock.MagicMock)
self.assertTrue(result['ovs']['init_config']['use_absolute_metrics'])
self.assertTrue(result['ovs']['init_config']['use_rate_metrics'])
self.assertTrue(result['ovs']['init_config']['use_health_metrics'])
return result
def test_detect(self):
with patch.object(utils, 'load_oslo_configuration'):
with mock.patch.object(utils, 'load_oslo_configuration'):
self._detect(self.ovs_obj)
self.assertTrue(self.ovs_obj.available)
self.assertEqual(self.ovs_obj.neutron_conf,
@ -162,13 +160,13 @@ class TestOvs(unittest.TestCase):
def test_detect_devstack(self):
ps_util_get_proc.cmdLine = ['--config-file=/opt/stack/neutron.conf']
with patch.object(utils, 'load_oslo_configuration'):
with mock.patch.object(utils, 'load_oslo_configuration'):
self._detect(self.ovs_obj)
self.assertTrue(self.ovs_obj.available)
self.assertEqual(self.ovs_obj.neutron_conf, '/opt/stack/neutron.conf')
def test_detect_info(self):
with patch.object(LOG, 'info') as mock_log_warn:
with mock.patch.object(LOG, 'info') as mock_log_warn:
ps_util_get_proc.detect_warning = True
self._detect(self.ovs_obj)
self.assertFalse(self.ovs_obj.available)
@ -179,14 +177,14 @@ class TestOvs(unittest.TestCase):
self.ovs_obj.neutron_conf = None
self.ovs_obj.args = {'conf_file_path': '/opt/stack/neutron.conf'}
with patch.object(utils, 'load_oslo_configuration') as mock_conf, \
patch.object(psutil, 'process_iter',
return_value=[ps_util_get_proc()]) as mock_process_iter, \
patch.object(os.path, 'isfile', return_value=True) as mock_isfile, \
patch.object(self.ovs_obj, 'dependencies_installed',
return_value=True) as dependencies, \
patch.object(self.ovs_obj, '_is_neutron_conf_valid',
return_value=True) as _:
with mock.patch.object(utils, 'load_oslo_configuration') as mock_conf, \
mock.patch.object(psutil, 'process_iter',
return_value=[ps_util_get_proc()]) as mock_process_iter, \
mock.patch.object(os.path, 'isfile', return_value=True) as mock_isfile, \
mock.patch.object(self.ovs_obj, 'dependencies_installed',
return_value=True) as dependencies, \
mock.patch.object(self.ovs_obj, '_is_neutron_conf_valid',
return_value=True) as _:
self.ovs_obj._detect()
self.assertTrue(mock_isfile.called)
self.assertTrue(self.ovs_obj.available)
@ -198,7 +196,7 @@ class TestOvs(unittest.TestCase):
self._build_config_without_args(self.ovs_obj)
def test_build_config_with_args(self):
with patch.object(LOG, 'warn') as mock_log_warn:
with mock.patch.object(LOG, 'warn') as mock_log_warn:
self.ovs_obj.neutron_conf = 'neutron-conf'
self.ovs_obj.args = {'username': 'admin',
'password': 'password',
@ -218,7 +216,7 @@ class TestOvs(unittest.TestCase):
self.assertEqual(result, False)
def test_build_config_invalid_arg_warning(self):
with patch.object(LOG, 'warn') as mock_log_warn:
with mock.patch.object(LOG, 'warn') as mock_log_warn:
self.ovs_obj.neutron_conf = 'neutron-conf'
self.ovs_obj.args = {'username': 'admin',
'password': 'password',
@ -239,8 +237,8 @@ class TestOvs(unittest.TestCase):
def test_build_config_if_auth_version(self):
self.ovs_obj.neutron_conf = 'neutron-conf'
self.has_option = [True, False, True, False, True, True]
self.get_value = [MagicMock(), MagicMock(), MagicMock(), MagicMock(),
MagicMock(), 'http://10.10.10.10',
self.get_value = [mock.MagicMock(), mock.MagicMock(), mock.MagicMock(), mock.MagicMock(),
mock.MagicMock(), 'http://10.10.10.10',
'http://10.10.10.10', 'region1']
result = self._build_config_without_args(self.ovs_obj)
self.assertEqual(result['ovs']['init_config']['auth_url'],
@ -249,8 +247,8 @@ class TestOvs(unittest.TestCase):
def test_build_config_if_auth_url_has_version(self):
self.ovs_obj.neutron_conf = 'neutron-conf'
self.has_option = [True, False, True, False, True, True]
self.get_value = [MagicMock(), MagicMock(), MagicMock(), MagicMock(),
MagicMock(), 'http://10.10.10.10/v1',
self.get_value = [mock.MagicMock(), mock.MagicMock(), mock.MagicMock(), mock.MagicMock(),
mock.MagicMock(), 'http://10.10.10.10/v1',
'http://10.10.10.10/v1', 'region1']
result = self._build_config_without_args(self.ovs_obj)
self.assertEqual(result['ovs']['init_config']['auth_url'],
@ -259,8 +257,8 @@ class TestOvs(unittest.TestCase):
def test_build_config_region_name_from_nova(self):
self.ovs_obj.neutron_conf = 'neutron-conf'
self.has_option = [True, False, True, False, False, False]
self.get_value = [MagicMock(), MagicMock(), MagicMock(), MagicMock(),
MagicMock(), 'http://10.10.10.10', 'region2']
self.get_value = [mock.MagicMock(), mock.MagicMock(), mock.MagicMock(), mock.MagicMock(),
mock.MagicMock(), 'http://10.10.10.10', 'region2']
result = self._build_config_without_args(self.ovs_obj)
self.assertEqual(result['ovs']['init_config']['auth_url'],
'http://10.10.10.10')
@ -281,8 +279,8 @@ class TestOvs(unittest.TestCase):
self.ovs_obj.args = {'included_interface_re': '[',
'neutron_refresh': 13000}
with patch.object(re, 'compile', side_effect=re.error('error')) as mock_re_error, \
patch.object(LOG, 'exception') as mock_log:
with mock.patch.object(re, 'compile', side_effect=re.error('error')) as mock_re_error, \
mock.patch.object(LOG, 'exception') as mock_log:
self.assertRaises(Exception, self._build_config_with_arg, self.ovs_obj)
self.assertTrue(mock_re_error.called)
self.assertTrue(mock_log.called)

10
tests/detection/test_process_check.py
View File

@ -17,8 +17,6 @@ import psutil
import tempfile
import unittest
from mock import patch
from monasca_setup.detection.plugins.process import ProcessCheck
LOG = logging.getLogger('monasca_setup.detection.plugins.process')
@ -39,7 +37,7 @@ class TestProcessCheck(unittest.TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
with patch.object(ProcessCheck, '_detect') as mock_detect:
with unittest.mock.patch.object(ProcessCheck, '_detect') as mock_detect:
self.proc_plugin = ProcessCheck('temp_dir')
self.assertTrue(mock_detect.called)
@ -50,9 +48,9 @@ class TestProcessCheck(unittest.TestCase):
proc_plugin.available = False
psutil_mock = PSUtilGetProc()
process_iter_patch = patch.object(psutil, 'process_iter',
return_value=[psutil_mock])
isfile_patch = patch.object(os.path, 'isfile',
process_iter_patch = unittest.mock.patch.object(psutil, 'process_iter',
return_value=[psutil_mock])
isfile_patch = unittest.mock.patch.object(os.path, 'isfile',
return_value=config_is_file)
with process_iter_patch as mock_process_iter, \

6
tests/test_remove_config.py
View File

@ -12,8 +12,8 @@
# under the License.
import collections
import mock
import unittest
from unittest import mock
from unittest import TestCase
import monasca_setup
import monasca_setup.agent_config
@ -160,7 +160,7 @@ INPUT_ARGS_WITH_DIMENSIONS = collections.namedtuple(
"template_dir", "dimensions"])
class TestRemoveConfig(unittest.TestCase):
class TestRemoveConfig(TestCase):
""" Unit tests for removing_config function in monasca_setup/main.py
More details are documented in:
monasca-agent/docs/DeveloperDocs/agent_internals.md