X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osm_common%2Ftests%2Ftest_msglocal.py;h=41f6eb8d0d4c6ebcaec4dfff00855837809d50e0;hb=c5297e4f2313738e2c8df4902339d647f9ada75f;hp=aef6fd631bedd8deb1713f774f4d164ea354581b;hpb=a7f8a6d95a622459d1cbfb06463d17deaef71aa2;p=osm%2Fcommon.git diff --git a/osm_common/tests/test_msglocal.py b/osm_common/tests/test_msglocal.py index aef6fd6..41f6eb8 100644 --- a/osm_common/tests/test_msglocal.py +++ b/osm_common/tests/test_msglocal.py @@ -1,3 +1,22 @@ +# Copyright 2018 Whitestack, LLC +# Copyright 2018 Telefonica S.A. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# +# For those usages not covered by the Apache License, Version 2.0 please +# contact: esousa@whitestack.com or alfonso.tiernosepulveda@telefonica.com +## + import http import logging import pytest @@ -15,38 +34,41 @@ from osm_common.msglocal import MsgLocal __author__ = "Eduardo Sousa " + def valid_path(): return tempfile.gettempdir() + '/' + def invalid_path(): return '/#tweeter/' -@pytest.fixture -def msg_local(): - msg = MsgLocal() +@pytest.fixture(scope="function", params=[True, False]) +def msg_local(request): + msg = MsgLocal(lock=request.param) yield msg + msg.disconnect() if msg.path and msg.path != invalid_path() and msg.path != valid_path(): - msg.disconnect() shutil.rmtree(msg.path) -@pytest.fixture -def msg_local_config(): - msg = MsgLocal() + +@pytest.fixture(scope="function", params=[True, False]) +def msg_local_config(request): + msg = MsgLocal(lock=request.param) msg.connect({"path": valid_path() + str(uuid.uuid4())}) - yield msg - + msg.disconnect() if msg.path != invalid_path(): shutil.rmtree(msg.path) -@pytest.fixture -def msg_local_with_data(): - msg = MsgLocal() + +@pytest.fixture(scope="function", params=[True, False]) +def msg_local_with_data(request): + msg = MsgLocal(lock=request.param) msg.connect({"path": valid_path() + str(uuid.uuid4())}) - + msg.write("topic1", "key1", "msg1") msg.write("topic1", "key2", "msg1") msg.write("topic2", "key1", "msg1") @@ -55,36 +77,36 @@ def msg_local_with_data(): msg.write("topic1", "key2", "msg2") msg.write("topic2", "key1", "msg2") msg.write("topic2", "key2", "msg2") - yield msg - + msg.disconnect() if msg.path != invalid_path(): shutil.rmtree(msg.path) + def empty_exception_message(): return "messaging exception " + def test_constructor(): msg = MsgLocal() - assert msg.logger == logging.getLogger('msg') - assert msg.path == None + assert msg.path is None assert len(msg.files_read) == 0 assert len(msg.files_write) == 0 assert len(msg.buffer) == 0 + def test_constructor_with_logger(): logger_name = 'msg_local' - msg = MsgLocal(logger_name=logger_name) - assert msg.logger == logging.getLogger(logger_name) - assert msg.path == None + assert msg.path is None assert len(msg.files_read) == 0 assert len(msg.files_write) == 0 assert len(msg.buffer) == 0 + @pytest.mark.parametrize("config, logger_name, path", [ ({"logger_name": "msg_local", "path": valid_path()}, "msg_local", valid_path()), ({"logger_name": "msg_local", "path": valid_path()[:-1]}, "msg_local", valid_path()), @@ -96,13 +118,13 @@ def test_constructor_with_logger(): ({"path": valid_path() + "test_it"}, "msg", valid_path() + "test_it/")]) def test_connect(msg_local, config, logger_name, path): msg_local.connect(config) - assert msg_local.logger == logging.getLogger(logger_name) assert msg_local.path == path assert len(msg_local.files_read) == 0 assert len(msg_local.files_write) == 0 assert len(msg_local.buffer) == 0 + @pytest.mark.parametrize("config", [ ({"logger_name": "msg_local", "path": invalid_path()}), ({"path": invalid_path()})]) @@ -112,48 +134,54 @@ def test_connect_with_exception(msg_local, config): assert str(excinfo.value).startswith(empty_exception_message()) assert excinfo.value.http_code == http.HTTPStatus.INTERNAL_SERVER_ERROR + def test_disconnect(msg_local_config): + files_read = msg_local_config.files_read.copy() + files_write = msg_local_config.files_write.copy() msg_local_config.disconnect() - - for f in msg_local_config.files_read.values(): + for f in files_read.values(): assert f.closed - - for f in msg_local_config.files_write.values(): + for f in files_write.values(): assert f.closed + def test_disconnect_with_read(msg_local_config): msg_local_config.read('topic1', blocks=False) msg_local_config.read('topic2', blocks=False) - + files_read = msg_local_config.files_read.copy() + files_write = msg_local_config.files_write.copy() msg_local_config.disconnect() - - for f in msg_local_config.files_read.values(): + for f in files_read.values(): assert f.closed - - for f in msg_local_config.files_write.values(): + for f in files_write.values(): assert f.closed + def test_disconnect_with_write(msg_local_with_data): + files_read = msg_local_with_data.files_read.copy() + files_write = msg_local_with_data.files_write.copy() msg_local_with_data.disconnect() - for f in msg_local_with_data.files_read.values(): + for f in files_read.values(): assert f.closed - for f in msg_local_with_data.files_write.values(): + for f in files_write.values(): assert f.closed + def test_disconnect_with_read_and_write(msg_local_with_data): msg_local_with_data.read('topic1', blocks=False) msg_local_with_data.read('topic2', blocks=False) - - msg_local_with_data.disconnect() + files_read = msg_local_with_data.files_read.copy() + files_write = msg_local_with_data.files_write.copy() - for f in msg_local_with_data.files_read.values(): + msg_local_with_data.disconnect() + for f in files_read.values(): assert f.closed - - for f in msg_local_with_data.files_write.values(): + for f in files_write.values(): assert f.closed + @pytest.mark.parametrize("topic, key, msg", [ ("test_topic", "test_key", "test_msg"), ("test", "test_key", "test_msg"), @@ -168,13 +196,12 @@ def test_disconnect_with_read_and_write(msg_local_with_data): ("test_topic", "test_none", None)]) def test_write(msg_local_config, topic, key, msg): file_path = msg_local_config.path + topic - msg_local_config.write(topic, key, msg) - assert os.path.exists(file_path) with open(file_path, 'r') as stream: - assert yaml.load(stream) == {key: msg if not isinstance(msg, tuple) else list(msg)} + assert yaml.safe_load(stream) == {key: msg if not isinstance(msg, tuple) else list(msg)} + @pytest.mark.parametrize("topic, key, msg, times", [ ("test_topic", "test_key", "test_msg", 2), @@ -193,13 +220,13 @@ def test_write_with_multiple_calls(msg_local_config, topic, key, msg, times): for _ in range(times): msg_local_config.write(topic, key, msg) - assert os.path.exists(file_path) with open(file_path, 'r') as stream: for _ in range(times): data = stream.readline() - assert yaml.load(data) == {key: msg if not isinstance(msg, tuple) else list(msg)} + assert yaml.safe_load(data) == {key: msg if not isinstance(msg, tuple) else list(msg)} + def test_write_exception(msg_local_config): msg_local_config.files_write = MagicMock() @@ -210,6 +237,7 @@ def test_write_exception(msg_local_config): assert str(excinfo.value).startswith(empty_exception_message()) assert excinfo.value.http_code == http.HTTPStatus.INTERNAL_SERVER_ERROR + @pytest.mark.parametrize("topics, datas", [ (["topic"], [{"key": "value"}]), (["topic1"], [{"key": "value"}]), @@ -246,16 +274,14 @@ def test_read(msg_local_with_data, topics, datas): for topic in topics: for data in datas: recv_topic, recv_key, recv_msg = msg_local_with_data.read(topic) - key = list(data.keys())[0] val = data[key] - assert recv_topic == topic assert recv_key == key assert recv_msg == val - t.join() + @pytest.mark.parametrize("topics, datas", [ (["topic"], [{"key": "value"}]), (["topic1"], [{"key": "value"}]), @@ -291,14 +317,13 @@ def test_read_non_block(msg_local_with_data, topics, datas): for topic in topics: for data in datas: recv_topic, recv_key, recv_msg = msg_local_with_data.read(topic, blocks=False) - key = list(data.keys())[0] val = data[key] - assert recv_topic == topic assert recv_key == key assert recv_msg == val + @pytest.mark.parametrize("topics, datas", [ (["topic"], [{"key": "value"}]), (["topic1"], [{"key": "value"}]), @@ -322,22 +347,19 @@ def test_read_non_block_none(msg_local_with_data, topics, datas): with open(msg_local_with_data.path + topic, "a+") as fp: yaml.safe_dump(data, fp, default_flow_style=True, width=20000) fp.flush() - # If file is not opened first, the messages written won't be seen for topic in topics: if topic not in msg_local_with_data.files_read: msg_local_with_data.read(topic, blocks=False) - t = threading.Thread(target=write_to_topic, args=(topics, datas)) t.start() for topic in topics: recv_data = msg_local_with_data.read(topic, blocks=False) - - assert recv_data == None - + assert recv_data is None t.join() + @pytest.mark.parametrize("blocks", [ (True), (False)]) @@ -350,6 +372,7 @@ def test_read_exception(msg_local_with_data, blocks): assert str(excinfo.value).startswith(empty_exception_message()) assert excinfo.value.http_code == http.HTTPStatus.INTERNAL_SERVER_ERROR + @pytest.mark.parametrize("topics, datas", [ (["topic"], [{"key": "value"}]), (["topic1"], [{"key": "value"}]), @@ -373,7 +396,6 @@ def test_aioread(msg_local_with_data, event_loop, topics, datas): with open(msg_local_with_data.path + topic, "a+") as fp: yaml.safe_dump(data, fp, default_flow_style=True, width=20000) fp.flush() - # If file is not opened first, the messages written won't be seen for topic in topics: if topic not in msg_local_with_data.files_read: @@ -381,21 +403,18 @@ def test_aioread(msg_local_with_data, event_loop, topics, datas): t = threading.Thread(target=write_to_topic, args=(topics, datas)) t.start() - for topic in topics: for data in datas: recv = event_loop.run_until_complete(msg_local_with_data.aioread(topic, event_loop)) recv_topic, recv_key, recv_msg = recv - key = list(data.keys())[0] val = data[key] - assert recv_topic == topic assert recv_key == key assert recv_msg == val - t.join() + def test_aioread_exception(msg_local_with_data, event_loop): msg_local_with_data.files_read = MagicMock() msg_local_with_data.files_read.__contains__.side_effect = Exception() @@ -405,6 +424,7 @@ def test_aioread_exception(msg_local_with_data, event_loop): assert str(excinfo.value).startswith(empty_exception_message()) assert excinfo.value.http_code == http.HTTPStatus.INTERNAL_SERVER_ERROR + def test_aioread_general_exception(msg_local_with_data, event_loop): msg_local_with_data.read = MagicMock() msg_local_with_data.read.side_effect = Exception() @@ -414,6 +434,7 @@ def test_aioread_general_exception(msg_local_with_data, event_loop): assert str(excinfo.value).startswith(empty_exception_message()) assert excinfo.value.http_code == http.HTTPStatus.INTERNAL_SERVER_ERROR + @pytest.mark.parametrize("topic, key, msg", [ ("test_topic", "test_key", "test_msg"), ("test", "test_key", "test_msg"), @@ -428,13 +449,12 @@ def test_aioread_general_exception(msg_local_with_data, event_loop): ("test_topic", "test_none", None)]) def test_aiowrite(msg_local_config, event_loop, topic, key, msg): file_path = msg_local_config.path + topic - event_loop.run_until_complete(msg_local_config.aiowrite(topic, key, msg)) - assert os.path.exists(file_path) with open(file_path, 'r') as stream: - assert yaml.load(stream) == {key: msg if not isinstance(msg, tuple) else list(msg)} + assert yaml.safe_load(stream) == {key: msg if not isinstance(msg, tuple) else list(msg)} + @pytest.mark.parametrize("topic, key, msg, times", [ ("test_topic", "test_key", "test_msg", 2), @@ -450,16 +470,15 @@ def test_aiowrite(msg_local_config, event_loop, topic, key, msg): ("test_topic", "test_none", None, 3)]) def test_aiowrite_with_multiple_calls(msg_local_config, event_loop, topic, key, msg, times): file_path = msg_local_config.path + topic - for _ in range(times): event_loop.run_until_complete(msg_local_config.aiowrite(topic, key, msg)) - assert os.path.exists(file_path) with open(file_path, 'r') as stream: for _ in range(times): data = stream.readline() - assert yaml.load(data) == {key: msg if not isinstance(msg, tuple) else list(msg)} + assert yaml.safe_load(data) == {key: msg if not isinstance(msg, tuple) else list(msg)} + def test_aiowrite_exception(msg_local_config, event_loop): msg_local_config.files_write = MagicMock()