| 1 |
|
# -*- coding: utf-8 -*- |
| 2 |
|
|
| 3 |
|
# Copyright 2018 Telefonica S.A. |
| 4 |
|
# |
| 5 |
|
# Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 |
|
# you may not use this file except in compliance with the License. |
| 7 |
|
# You may obtain a copy of the License at |
| 8 |
|
# |
| 9 |
|
# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 |
|
# |
| 11 |
|
# Unless required by applicable law or agreed to in writing, software |
| 12 |
|
# distributed under the License is distributed on an "AS IS" BASIS, |
| 13 |
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
| 14 |
|
# implied. |
| 15 |
|
# See the License for the specific language governing permissions and |
| 16 |
|
# limitations under the License. |
| 17 |
|
|
| 18 |
1 |
import asyncio |
| 19 |
1 |
from http import HTTPStatus |
| 20 |
1 |
import logging |
| 21 |
1 |
import os |
| 22 |
1 |
from time import sleep |
| 23 |
|
|
| 24 |
1 |
from osm_common.msgbase import MsgBase, MsgException |
| 25 |
1 |
import yaml |
| 26 |
|
|
| 27 |
1 |
__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>" |
| 28 |
1 |
""" |
| 29 |
|
This emulated kafka bus by just using a shared file system. Useful for testing or devops. |
| 30 |
|
One file is used per topic. Only one producer and one consumer is allowed per topic. Both consumer and producer |
| 31 |
|
access to the same file. e.g. same volume if running with docker. |
| 32 |
|
One text line per message is used in yaml format. |
| 33 |
|
""" |
| 34 |
|
|
| 35 |
|
|
| 36 |
1 |
class MsgLocal(MsgBase): |
| 37 |
1 |
def __init__(self, logger_name="msg", lock=False): |
| 38 |
1 |
super().__init__(logger_name, lock) |
| 39 |
1 |
self.path = None |
| 40 |
|
# create a different file for each topic |
| 41 |
1 |
self.files_read = {} |
| 42 |
1 |
self.files_write = {} |
| 43 |
1 |
self.buffer = {} |
| 44 |
|
|
| 45 |
1 |
def connect(self, config): |
| 46 |
0 |
try: |
| 47 |
0 |
if "logger_name" in config: |
| 48 |
0 |
self.logger = logging.getLogger(config["logger_name"]) |
| 49 |
0 |
self.path = config["path"] |
| 50 |
0 |
if not self.path.endswith("/"): |
| 51 |
0 |
self.path += "/" |
| 52 |
0 |
if not os.path.exists(self.path): |
| 53 |
0 |
os.mkdir(self.path) |
| 54 |
|
|
| 55 |
0 |
except MsgException: |
| 56 |
0 |
raise |
| 57 |
0 |
except Exception as e: # TODO refine |
| 58 |
0 |
raise MsgException(str(e), http_code=HTTPStatus.INTERNAL_SERVER_ERROR) |
| 59 |
|
|
| 60 |
1 |
def disconnect(self): |
| 61 |
0 |
for topic, f in self.files_read.items(): |
| 62 |
0 |
try: |
| 63 |
0 |
f.close() |
| 64 |
0 |
self.files_read[topic] = None |
| 65 |
0 |
except Exception as read_topic_error: |
| 66 |
0 |
if isinstance(read_topic_error, (IOError, FileNotFoundError)): |
| 67 |
0 |
self.logger.exception( |
| 68 |
|
f"{read_topic_error} occured while closing read topic files." |
| 69 |
|
) |
| 70 |
0 |
elif isinstance(read_topic_error, KeyError): |
| 71 |
0 |
self.logger.exception( |
| 72 |
|
f"{read_topic_error} occured while reading from files_read dictionary." |
| 73 |
|
) |
| 74 |
|
else: |
| 75 |
0 |
self.logger.exception( |
| 76 |
|
f"{read_topic_error} occured while closing read topics." |
| 77 |
|
) |
| 78 |
|
|
| 79 |
0 |
for topic, f in self.files_write.items(): |
| 80 |
0 |
try: |
| 81 |
0 |
f.close() |
| 82 |
0 |
self.files_write[topic] = None |
| 83 |
0 |
except Exception as write_topic_error: |
| 84 |
0 |
if isinstance(write_topic_error, (IOError, FileNotFoundError)): |
| 85 |
0 |
self.logger.exception( |
| 86 |
|
f"{write_topic_error} occured while closing write topic files." |
| 87 |
|
) |
| 88 |
0 |
elif isinstance(write_topic_error, KeyError): |
| 89 |
0 |
self.logger.exception( |
| 90 |
|
f"{write_topic_error} occured while reading from files_write dictionary." |
| 91 |
|
) |
| 92 |
|
else: |
| 93 |
0 |
self.logger.exception( |
| 94 |
|
f"{write_topic_error} occured while closing write topics." |
| 95 |
|
) |
| 96 |
|
|
| 97 |
1 |
def write(self, topic, key, msg): |
| 98 |
|
""" |
| 99 |
|
Insert a message into topic |
| 100 |
|
:param topic: topic |
| 101 |
|
:param key: key text to be inserted |
| 102 |
|
:param msg: value object to be inserted, can be str, object ... |
| 103 |
|
:return: None or raises and exception |
| 104 |
|
""" |
| 105 |
0 |
try: |
| 106 |
0 |
with self.lock: |
| 107 |
0 |
if topic not in self.files_write: |
| 108 |
0 |
self.files_write[topic] = open(self.path + topic, "a+") |
| 109 |
0 |
yaml.safe_dump( |
| 110 |
|
{key: msg}, |
| 111 |
|
self.files_write[topic], |
| 112 |
|
default_flow_style=True, |
| 113 |
|
width=20000, |
| 114 |
|
) |
| 115 |
0 |
self.files_write[topic].flush() |
| 116 |
0 |
except Exception as e: # TODO refine |
| 117 |
0 |
raise MsgException(str(e), HTTPStatus.INTERNAL_SERVER_ERROR) |
| 118 |
|
|
| 119 |
1 |
def read(self, topic, blocks=True): |
| 120 |
|
""" |
| 121 |
|
Read from one or several topics. it is non blocking returning None if nothing is available |
| 122 |
|
:param topic: can be str: single topic; or str list: several topics |
| 123 |
|
:param blocks: indicates if it should wait and block until a message is present or returns None |
| 124 |
|
:return: topic, key, message; or None if blocks==True |
| 125 |
|
""" |
| 126 |
0 |
try: |
| 127 |
0 |
if isinstance(topic, (list, tuple)): |
| 128 |
0 |
topic_list = topic |
| 129 |
|
else: |
| 130 |
0 |
topic_list = (topic,) |
| 131 |
0 |
while True: |
| 132 |
0 |
for single_topic in topic_list: |
| 133 |
0 |
with self.lock: |
| 134 |
0 |
if single_topic not in self.files_read: |
| 135 |
0 |
self.files_read[single_topic] = open( |
| 136 |
|
self.path + single_topic, "a+" |
| 137 |
|
) |
| 138 |
0 |
self.buffer[single_topic] = "" |
| 139 |
0 |
self.buffer[single_topic] += self.files_read[ |
| 140 |
|
single_topic |
| 141 |
|
].readline() |
| 142 |
0 |
if not self.buffer[single_topic].endswith("\n"): |
| 143 |
0 |
continue |
| 144 |
0 |
msg_dict = yaml.safe_load(self.buffer[single_topic]) |
| 145 |
0 |
self.buffer[single_topic] = "" |
| 146 |
0 |
if len(msg_dict) != 1: |
| 147 |
0 |
raise ValueError( |
| 148 |
|
"Length of message dictionary is not equal to 1" |
| 149 |
|
) |
| 150 |
0 |
for k, v in msg_dict.items(): |
| 151 |
0 |
return single_topic, k, v |
| 152 |
0 |
if not blocks: |
| 153 |
0 |
return None |
| 154 |
0 |
sleep(2) |
| 155 |
0 |
except Exception as e: # TODO refine |
| 156 |
0 |
raise MsgException(str(e), HTTPStatus.INTERNAL_SERVER_ERROR) |
| 157 |
|
|
| 158 |
1 |
async def aioread( |
| 159 |
|
self, topic, callback=None, aiocallback=None, group_id=None, **kwargs |
| 160 |
|
): |
| 161 |
|
""" |
| 162 |
|
Asyncio read from one or several topics. It blocks |
| 163 |
|
:param topic: can be str: single topic; or str list: several topics |
| 164 |
|
:param callback: synchronous callback function that will handle the message |
| 165 |
|
:param aiocallback: async callback function that will handle the message |
| 166 |
|
:param group_id: group_id to use for load balancing. Can be False (set group_id to None), None (use general |
| 167 |
|
group_id provided at connect inside config), or a group_id string |
| 168 |
|
:param kwargs: optional keyword arguments for callback function |
| 169 |
|
:return: If no callback defined, it returns (topic, key, message) |
| 170 |
|
""" |
| 171 |
0 |
try: |
| 172 |
0 |
while True: |
| 173 |
0 |
msg = self.read(topic, blocks=False) |
| 174 |
0 |
if msg: |
| 175 |
0 |
if callback: |
| 176 |
0 |
callback(*msg, **kwargs) |
| 177 |
0 |
elif aiocallback: |
| 178 |
0 |
await aiocallback(*msg, **kwargs) |
| 179 |
|
else: |
| 180 |
0 |
return msg |
| 181 |
0 |
await asyncio.sleep(2) |
| 182 |
0 |
except MsgException: |
| 183 |
0 |
raise |
| 184 |
0 |
except Exception as e: # TODO refine |
| 185 |
0 |
raise MsgException(str(e), HTTPStatus.INTERNAL_SERVER_ERROR) |
| 186 |
|
|
| 187 |
1 |
async def aiowrite(self, topic, key, msg): |
| 188 |
|
""" |
| 189 |
|
Asyncio write. It blocks |
| 190 |
|
:param topic: str |
| 191 |
|
:param key: str |
| 192 |
|
:param msg: message, can be str or yaml |
| 193 |
|
:return: nothing if ok or raises an exception |
| 194 |
|
""" |
| 195 |
0 |
return self.write(topic, key, msg) |
![[Jenkins]](/jenkins/static/c06f6c43/images/jenkins-header-logo-v2.svg){kind=logo}
