From be62b173d382129dd5eb395f3c886116b935efda Mon Sep 17 00:00:00 2001 From: Sven Heidemann Date: Sun, 22 Nov 2020 20:17:57 +0100 Subject: [PATCH] Added logger and improved service provider --- src/sh_edraft/configuration/__init__.py | 3 +- .../configuration/application_host.py | 35 ++++ .../model/configuration_model_base.py | 3 - src/sh_edraft/logging/base/__init__.py | 25 +++ src/sh_edraft/logging/base/logger_base.py | 31 ++++ src/sh_edraft/logging/logger.py | 171 ++++++++++++++++++ src/sh_edraft/logging/model/__init__.py | 25 +++ src/sh_edraft/logging/model/log_level.py | 12 ++ src/sh_edraft/logging/model/log_settings.py | 60 ++++++ .../logging/model/log_settings_name.py | 10 + src/sh_edraft/publish/base/publisher_base.py | 9 +- src/sh_edraft/publish/publisher.py | 6 +- src/sh_edraft/service/base/__init__.py | 2 +- ...vider_base.py => service_provider_base.py} | 7 +- src/sh_edraft/service/service_provider.py | 25 +-- src/sh_edraft/time/__init__.py | 25 +++ src/sh_edraft/time/model/__init__.py | 25 +++ .../time/model/time_format_settings.py | 59 ++++++ .../time/model/time_format_settings_names.py | 10 + src/sh_edraft/utils/__init__.py | 25 +++ src/sh_edraft/utils/console.py | 11 ++ src/tests/logger.py | 50 +++++ src/tests/publisher.py | 7 +- src/tests/service_provider.py | 16 +- src/tests/{test.py => tester.py} | 45 +++-- 25 files changed, 643 insertions(+), 54 deletions(-) create mode 100644 src/sh_edraft/configuration/application_host.py create mode 100644 src/sh_edraft/logging/base/__init__.py create mode 100644 src/sh_edraft/logging/base/logger_base.py create mode 100644 src/sh_edraft/logging/logger.py create mode 100644 src/sh_edraft/logging/model/__init__.py create mode 100644 src/sh_edraft/logging/model/log_level.py create mode 100644 src/sh_edraft/logging/model/log_settings.py create mode 100644 src/sh_edraft/logging/model/log_settings_name.py rename src/sh_edraft/service/base/{provider_base.py => service_provider_base.py} (79%) create mode 100644 src/sh_edraft/time/__init__.py create mode 100644 src/sh_edraft/time/model/__init__.py create mode 100644 src/sh_edraft/time/model/time_format_settings.py create mode 100644 src/sh_edraft/time/model/time_format_settings_names.py create mode 100644 src/sh_edraft/utils/__init__.py create mode 100644 src/sh_edraft/utils/console.py create mode 100644 src/tests/logger.py rename src/tests/{test.py => tester.py} (56%) diff --git a/src/sh_edraft/configuration/__init__.py b/src/sh_edraft/configuration/__init__.py index f4d4c98a..e08dcd42 100644 --- a/src/sh_edraft/configuration/__init__.py +++ b/src/sh_edraft/configuration/__init__.py @@ -19,7 +19,8 @@ __version__ = '2020.12.0.1' from collections import namedtuple - +# imports: +from sh_edraft.configuration.application_host import ApplicationHost VersionInfo = namedtuple('VersionInfo', 'major minor micro') version_info = VersionInfo(major=2020, minor=12, micro=0.1) diff --git a/src/sh_edraft/configuration/application_host.py b/src/sh_edraft/configuration/application_host.py new file mode 100644 index 00000000..770d9b81 --- /dev/null +++ b/src/sh_edraft/configuration/application_host.py @@ -0,0 +1,35 @@ +from datetime import datetime + +from sh_edraft.service import ServiceProvider + + +class ApplicationHost: + + def __init__(self): + self._services = ServiceProvider() + self._end_time: datetime = datetime.now() + self._start_time: datetime = datetime.now() + + @property + def services(self): + return self._services + + @property + def end_time(self) -> datetime: + return self._end_time + + @end_time.setter + def end_time(self, end_time: datetime) -> None: + self._end_time = end_time + + @property + def start_time(self) -> datetime: + return self._start_time + + @start_time.setter + def start_time(self, start_time: datetime) -> None: + self._start_time = start_time + + @property + def date_time_now(self) -> datetime: + return datetime.now() diff --git a/src/sh_edraft/configuration/model/configuration_model_base.py b/src/sh_edraft/configuration/model/configuration_model_base.py index 4483a3d3..06b65ba5 100644 --- a/src/sh_edraft/configuration/model/configuration_model_base.py +++ b/src/sh_edraft/configuration/model/configuration_model_base.py @@ -5,6 +5,3 @@ class ConfigurationModelBase(ABC): @abstractmethod def from_dict(self, settings: dict): pass - - @abstractmethod - def to_dict(self) -> dict: pass diff --git a/src/sh_edraft/logging/base/__init__.py b/src/sh_edraft/logging/base/__init__.py new file mode 100644 index 00000000..662b7253 --- /dev/null +++ b/src/sh_edraft/logging/base/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_edraft.logging.base +~~~~~~~~~~~~~~~~~~~ + + + +:copyright: (c) 2020 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'sh_edraft.logging.base' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 sh-edraft.de' +__version__ = '2020.12.0.1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major=2020, minor=12, micro=0.1) diff --git a/src/sh_edraft/logging/base/logger_base.py b/src/sh_edraft/logging/base/logger_base.py new file mode 100644 index 00000000..d9579484 --- /dev/null +++ b/src/sh_edraft/logging/base/logger_base.py @@ -0,0 +1,31 @@ +from abc import abstractmethod + +from sh_edraft.service.base import ServiceBase + + +class LoggerBase(ServiceBase): + + @abstractmethod + def __init__(self): + ServiceBase.__init__(self) + + @abstractmethod + def header(self, string: str): pass + + @abstractmethod + def trace(self, name: str, message: str): pass + + @abstractmethod + def debug(self, name: str, message: str): pass + + @abstractmethod + def info(self, name: str, message: str): pass + + @abstractmethod + def warn(self, name: str, message: str): pass + + @abstractmethod + def error(self, name: str, message: str, ex: Exception = None): pass + + @abstractmethod + def fatal(self, name: str, message: str, ex: Exception = None): pass diff --git a/src/sh_edraft/logging/logger.py b/src/sh_edraft/logging/logger.py new file mode 100644 index 00000000..b616b8b0 --- /dev/null +++ b/src/sh_edraft/logging/logger.py @@ -0,0 +1,171 @@ +import datetime +import os +import traceback +from string import Template +from typing import Optional + +from termcolor import colored + +from sh_edraft.configuration.application_host import ApplicationHost +from sh_edraft.logging.base.logger_base import LoggerBase +from sh_edraft.logging.model.log_level import LoggingLevel +from sh_edraft.logging.model.log_settings import LoggingSettings +from sh_edraft.time.model.time_format_settings import TimeFormatSettings +from sh_edraft.utils.console import Console + + +class Logger(LoggerBase): + + def __init__(self): + LoggerBase.__init__(self) + + self._log_settings: Optional[LoggingSettings] = None + self._time_format_settings: Optional[TimeFormatSettings] = None + self._app_host: Optional[ApplicationHost] = None + + self._log: Optional[str] = None + self._path: Optional[str] = None + self._level: Optional[LoggingLevel] = None + self._console: Optional[LoggingLevel] = None + + def init(self, args: tuple): + self._log_settings = args[0] + self._time_format_settings = args[1] + self._app_host = args[2] + + self._log = Template(self._log_settings.filename).substitute( + date_time_now=self._app_host.date_time_now.strftime(self._time_format_settings.date_time_format), + start_time=self._app_host.start_time.strftime(self._time_format_settings.date_time_log_format) + ) + self._path = self._log_settings.path + self._level = self._log_settings.level + self._console = self._log_settings.console + + def _get_datetime_now(self) -> str: + try: + return datetime.datetime.now().strftime(self._time_format_settings.date_time_format) + except Exception as e: + self.error(__name__, 'Cannot get time', ex=e) + + def _get_date(self) -> str: + try: + return datetime.datetime.now().strftime(self._time_format_settings.date_format) + except Exception as e: + self.error(__name__, 'Cannot get date', ex=e) + + def create(self) -> None: + """ path """ + try: + # check if log file path exists + if not os.path.exists(self._path): + os.mkdir(self._path) + except Exception as e: + self.fatal(__name__, 'Cannot create log dir', ex=e) + + """ create new log file """ + try: + # open log file, create if not exists + path = f'{self._path}{self._log}' + f = open(path, "w+") + Console.write_line(f'[{__name__}]: Using log file: {path}') + f.close() + except Exception as e: + self.fatal(__name__, 'Cannot open log file', ex=e) + + def _append_log(self, string): + try: + # open log file and append always + with open(self._path + self._log, "a+", encoding="utf-8") as f: + f.write(string + '\n') + f.close() + except Exception as e: + self.error(__name__, f'Cannot append log file, message: {string}', ex=e) + + def _get_string(self, name: str, level: LoggingLevel, message: str) -> str: + log_level = level.name + return f'<{self._get_datetime_now()}> [ {log_level} ] [ {name} ]: {message}' + + def header(self, string: str): + # append log and print message + self._append_log(string) + Console.write_line(string, 'white') + + def trace(self, name: str, message: str): + output = self._get_string(name, LoggingLevel.TRACE, message) + + # check if message can be written to log + if self._level.value >= LoggingLevel.TRACE.value: + self._append_log(output) + + # check if message can be shown in console + if self._console.value >= LoggingLevel.TRACE.value: + Console.write_line(output, 'green') + + def debug(self, name: str, message: str): + output = self._get_string(name, LoggingLevel.DEBUG, message) + + # check if message can be written to log + if self._level.value >= LoggingLevel.DEBUG.value: + self._append_log(output) + + # check if message can be shown in console + if self._console.value >= LoggingLevel.DEBUG.value: + Console.write_line(output, 'green') + + def info(self, name: str, message: str): + output = self._get_string(name, LoggingLevel.INFO, message) + + # check if message can be written to log + if self._level.value >= LoggingLevel.INFO.value: + self._append_log(output) + + # check if message can be shown in console + if self._console.value >= LoggingLevel.INFO.value: + Console.write_line(output, 'green') + + def warn(self, name: str, message: str): + output = self._get_string(name, LoggingLevel.WARN, message) + + # check if message can be written to log + if self._level.value >= LoggingLevel.WARN.value: + self._append_log(output) + + # check if message can be shown in console + if self._console.value >= LoggingLevel.WARN.value: + Console.write_line(output, 'yellow') + + def error(self, name: str, message: str, ex: Exception = None): + output = '' + if ex is not None: + tb = traceback.format_exc() + self.error(name, message) + output = self._get_string(name, LoggingLevel.ERROR, f'{ex} -> {tb}') + else: + output = self._get_string(name, LoggingLevel.ERROR, message) + + # check if message can be written to log + if self._level.value >= LoggingLevel.ERROR.value: + self._append_log(output) + + # check if message can be shown in console + if self._console.value >= LoggingLevel.ERROR.value: + Console.write_line(output, 'red') + + def fatal(self, name: str, message: str, ex: Exception = None): + output = '' + if ex is not None: + tb = traceback.format_exc() + self.error(name, message) + output = self._get_string(name, LoggingLevel.ERROR, f'{ex} -> {tb}') + else: + output = self._get_string(name, LoggingLevel.ERROR, message) + + # check if message can be written to log + if self._level.value >= LoggingLevel.FATAL.value: + self._append_log(output) + + # check if message can be shown in console + if self._console.value >= LoggingLevel.FATAL.value: + Console.write_line(output, 'red') + + exit() diff --git a/src/sh_edraft/logging/model/__init__.py b/src/sh_edraft/logging/model/__init__.py new file mode 100644 index 00000000..e9d22762 --- /dev/null +++ b/src/sh_edraft/logging/model/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_edraft.logging.model +~~~~~~~~~~~~~~~~~~~ + + + +:copyright: (c) 2020 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'sh_edraft.logging.model' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 sh-edraft.de' +__version__ = '2020.12.0.1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major=2020, minor=12, micro=0.1) diff --git a/src/sh_edraft/logging/model/log_level.py b/src/sh_edraft/logging/model/log_level.py new file mode 100644 index 00000000..ceb7b4c7 --- /dev/null +++ b/src/sh_edraft/logging/model/log_level.py @@ -0,0 +1,12 @@ +from enum import Enum + + +class LoggingLevel(Enum): + + OFF = 0 # Nothing + FATAL = 1 # Error that cause exit + ERROR = 2 # Non fatal error + WARN = 3 # Error that can later be fatal + INFO = 4 # Normal information's + DEBUG = 5 # Detailed app state + TRACE = 6 # Detailed app information's diff --git a/src/sh_edraft/logging/model/log_settings.py b/src/sh_edraft/logging/model/log_settings.py new file mode 100644 index 00000000..1de23396 --- /dev/null +++ b/src/sh_edraft/logging/model/log_settings.py @@ -0,0 +1,60 @@ +import traceback +from typing import Optional + +from sh_edraft.configuration.model.configuration_model_base import ConfigurationModelBase +from sh_edraft.logging.model.log_settings_name import LogSettingsName +from sh_edraft.utils.console import Console +from sh_edraft.logging.model.log_level import LoggingLevel + + +class LoggingSettings(ConfigurationModelBase): + + def __init__(self): + ConfigurationModelBase.__init__(self) + + self._path: Optional[str] = None + self._filename: Optional[str] = None + self._console: Optional[LoggingLevel] = None + self._level: Optional[LoggingLevel] = None + + @property + def path(self) -> str: + return self._path + + @path.setter + def path(self, path: str) -> None: + self._path = path + + @property + def filename(self) -> str: + return self._filename + + @filename.setter + def filename(self, filename: str) -> None: + self._filename = filename + + @property + def console(self) -> LoggingLevel: + return self._console + + @console.setter + def console(self, console: LoggingLevel) -> None: + self._console = console + + @property + def level(self) -> LoggingLevel: + return self._level + + @level.setter + def level(self, level: LoggingLevel) -> None: + self._level = level + + def from_dict(self, settings: dict): + try: + self._path = settings[LogSettingsName.path.value] + self._filename = settings[LogSettingsName.filename.value] + self._console = LoggingLevel[settings[LogSettingsName.console_level.value]] + self._level = LoggingLevel[settings[LogSettingsName.file_level.value]] + except Exception as e: + Console.write_line(f'[ ERROR ] [ {__name__} ]: Reading error in {LogSettingsName.log.value} settings', 'red') + Console.write_line(f'[ EXCEPTION ] [ {__name__} ]: {e} -> {traceback.format_exc()}', 'red') diff --git a/src/sh_edraft/logging/model/log_settings_name.py b/src/sh_edraft/logging/model/log_settings_name.py new file mode 100644 index 00000000..3bd90037 --- /dev/null +++ b/src/sh_edraft/logging/model/log_settings_name.py @@ -0,0 +1,10 @@ +from enum import Enum + + +class LogSettingsName(Enum): + + log = 'Log' + path = 'Path' + filename = 'Filename' + console_level = 'ConsoleLogLevel' + file_level = 'FileLogLevel' diff --git a/src/sh_edraft/publish/base/publisher_base.py b/src/sh_edraft/publish/base/publisher_base.py index d8d3fdc2..51c3d086 100644 --- a/src/sh_edraft/publish/base/publisher_base.py +++ b/src/sh_edraft/publish/base/publisher_base.py @@ -1,10 +1,13 @@ -from abc import ABC, abstractmethod +from abc import abstractmethod + +from sh_edraft.service.base import ServiceBase -class PublisherBase(ABC): +class PublisherBase(ServiceBase): @abstractmethod - def __init__(self): pass + def __init__(self): + ServiceBase.__init__(self) @property @abstractmethod diff --git a/src/sh_edraft/publish/publisher.py b/src/sh_edraft/publish/publisher.py index 6241d614..e776d906 100644 --- a/src/sh_edraft/publish/publisher.py +++ b/src/sh_edraft/publish/publisher.py @@ -5,14 +5,12 @@ from typing import Optional from sh_edraft.publish.base.publisher_base import PublisherBase from sh_edraft.publish.model.template import Template -from sh_edraft.service.base import ServiceBase -class Publisher(ServiceBase, PublisherBase): +class Publisher(PublisherBase): def __init__(self): - ServiceBase.__init__(self) - PublisherBase.__init__(self) + super().__init__() self._logger: Optional[None] = None self._source_path: Optional[str] = None diff --git a/src/sh_edraft/service/base/__init__.py b/src/sh_edraft/service/base/__init__.py index 3af2fd19..80cbcb9b 100644 --- a/src/sh_edraft/service/base/__init__.py +++ b/src/sh_edraft/service/base/__init__.py @@ -21,7 +21,7 @@ from collections import namedtuple # imports: from sh_edraft.service.base.service_base import ServiceBase -from sh_edraft.service.base.provider_base import ProviderBase +from sh_edraft.service.base.service_provider_base import ServiceProviderBase VersionInfo = namedtuple('VersionInfo', 'major minor micro') version_info = VersionInfo(major=2020, minor=12, micro=0.1) diff --git a/src/sh_edraft/service/base/provider_base.py b/src/sh_edraft/service/base/service_provider_base.py similarity index 79% rename from src/sh_edraft/service/base/provider_base.py rename to src/sh_edraft/service/base/service_provider_base.py index 55451908..ee1f319a 100644 --- a/src/sh_edraft/service/base/provider_base.py +++ b/src/sh_edraft/service/base/service_provider_base.py @@ -1,4 +1,4 @@ -from abc import ABC, abstractmethod +from abc import abstractmethod from collections import Callable from typing import Type @@ -6,10 +6,11 @@ from sh_edraft.service.base.service_base import ServiceBase from sh_edraft.service.model.provide_state import ProvideState -class ProviderBase(ABC): +class ServiceProviderBase(ServiceBase): @abstractmethod def __init__(self): + ServiceBase.__init__(self) self._transient_services: list[ProvideState] = [] self._scoped_services: list[ProvideState] = [] self._singleton_services: list[ServiceBase] = [] @@ -24,7 +25,7 @@ class ProviderBase(ABC): def add_singleton(self, service: Type[ServiceBase], *args): pass @abstractmethod - def get_service(self, instance_type: type) -> Callable[ServiceBase]: pass + def get_service(self, instance_type: Type[ServiceBase]) -> Callable[ServiceBase]: pass @abstractmethod def remove_service(self, instance_type: type): pass diff --git a/src/sh_edraft/service/service_provider.py b/src/sh_edraft/service/service_provider.py index b827f83d..fdc93c36 100644 --- a/src/sh_edraft/service/service_provider.py +++ b/src/sh_edraft/service/service_provider.py @@ -3,18 +3,19 @@ from typing import Type from termcolor import colored -from sh_edraft.service.base.provider_base import ProviderBase +from sh_edraft.service.base.service_provider_base import ServiceProviderBase from sh_edraft.service.base.service_base import ServiceBase from sh_edraft.service.model.provide_state import ProvideState -class ServiceProvider(ProviderBase): +class ServiceProvider(ServiceProviderBase): def __init__(self): - ProviderBase.__init__(self) + super().__init__() - def create(self): - pass + def init(self, args: tuple): pass + + def create(self): pass @staticmethod def _create_instance(service: type[ServiceBase], args: tuple) -> ServiceBase: @@ -38,31 +39,31 @@ class ServiceProvider(ProviderBase): self._singleton_services.append(self._create_instance(service, args)) - def get_service(self, instance_type: type) -> Callable[ServiceBase]: + def get_service(self, instance_type: Type[ServiceBase]) -> Callable[ServiceBase]: for state in self._transient_services: - if state.service == instance_type: + if isinstance(state.service, type(instance_type)): return self._create_instance(state.service, state.args) for state in self._scoped_services: - if type(state.service) == instance_type: + if isinstance(state.service, type(instance_type)): return self._create_instance(state.service, state.args) for service in self._singleton_services: - if type(service) == instance_type: + if isinstance(service, instance_type): return service def remove_service(self, instance_type: type): for state in self._transient_services: - if state.service == instance_type: + if isinstance(state.service, type(instance_type)): self._transient_services.remove(state) return for state in self._scoped_services: - if type(state.service) == instance_type: + if isinstance(state.service, type(instance_type)): self._scoped_services.remove(state) return for service in self._singleton_services: - if type(service) == instance_type: + if isinstance(service, instance_type): self._singleton_services.remove(service) return diff --git a/src/sh_edraft/time/__init__.py b/src/sh_edraft/time/__init__.py new file mode 100644 index 00000000..28f6ff53 --- /dev/null +++ b/src/sh_edraft/time/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_edraft.time +~~~~~~~~~~~~~~~~~~~ + + + +:copyright: (c) 2020 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'sh_edraft.time' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 sh-edraft.de' +__version__ = '2020.12.0.1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major=2020, minor=12, micro=0.1) diff --git a/src/sh_edraft/time/model/__init__.py b/src/sh_edraft/time/model/__init__.py new file mode 100644 index 00000000..3950ec94 --- /dev/null +++ b/src/sh_edraft/time/model/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_edraft.time.model +~~~~~~~~~~~~~~~~~~~ + + + +:copyright: (c) 2020 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'sh_edraft.time.model' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 sh-edraft.de' +__version__ = '2020.12.0.1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major=2020, minor=12, micro=0.1) diff --git a/src/sh_edraft/time/model/time_format_settings.py b/src/sh_edraft/time/model/time_format_settings.py new file mode 100644 index 00000000..9c6b33ce --- /dev/null +++ b/src/sh_edraft/time/model/time_format_settings.py @@ -0,0 +1,59 @@ +import traceback +from typing import Optional + +from sh_edraft.configuration.model import ConfigurationModelBase +from sh_edraft.time.model.time_format_settings_names import TimeFormatSettingsNames +from sh_edraft.utils.console import Console + + +class TimeFormatSettings(ConfigurationModelBase): + + def __init__(self): + self._date_format: Optional[str] = None + self._time_format: Optional[str] = None + self._date_time_format: Optional[str] = None + self._date_time_log_format: Optional[str] = None + self._os_name: Optional[str] = None + self._hostname: Optional[str] = None + + @property + def date_format(self) -> str: + return self._date_format + + @date_format.setter + def date_format(self, date_format: str) -> None: + self._date_format = date_format + + @property + def time_format(self) -> str: + return self._time_format + + @time_format.setter + def time_format(self, time_format: str): + self._time_format = time_format + + @property + def date_time_format(self) -> str: + return self._date_time_format + + @date_time_format.setter + def date_time_format(self, date_time_format: str) -> None: + self._date_time_format = date_time_format + + @property + def date_time_log_format(self): + return self._date_time_log_format + + @date_time_log_format.setter + def date_time_log_format(self, date_time_now_format: str) -> None: + self._date_time_log_format = date_time_now_format + + def from_dict(self, settings: dict): + try: + self._date_format = settings[TimeFormatSettingsNames.date_format.value] + self._time_format = settings[TimeFormatSettingsNames.time_format.value] + self._date_time_format = settings[TimeFormatSettingsNames.date_time_format.value] + self._date_time_log_format = settings[TimeFormatSettingsNames.date_time_log_format.value] + except Exception as e: + Console.write_line(f'[ ERROR ] [ {__name__} ]: Reading error in {TimeFormatSettingsNames.formats.value} settings') + Console.write_line(f'[ EXCEPTION ] [ {__name__} ]: {e} -> {traceback.format_exc()}', 'red') diff --git a/src/sh_edraft/time/model/time_format_settings_names.py b/src/sh_edraft/time/model/time_format_settings_names.py new file mode 100644 index 00000000..4afc21cd --- /dev/null +++ b/src/sh_edraft/time/model/time_format_settings_names.py @@ -0,0 +1,10 @@ +from enum import Enum + + +class TimeFormatSettingsNames(Enum): + + formats = 'TimeFormats' + date_format = 'DateFormat' + time_format = 'TimeFormat' + date_time_format = 'DateTimeFormat' + date_time_log_format = 'DateTimeLogFormat' diff --git a/src/sh_edraft/utils/__init__.py b/src/sh_edraft/utils/__init__.py new file mode 100644 index 00000000..f6849df3 --- /dev/null +++ b/src/sh_edraft/utils/__init__.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- + +""" +sh_edraft.utils +~~~~~~~~~~~~~~~~~~~ + + + +:copyright: (c) 2020 sh-edraft.de +:license: MIT, see LICENSE for more details. + +""" + +__title__ = 'sh_edraft.utils' +__author__ = 'Sven Heidemann' +__license__ = 'MIT' +__copyright__ = 'Copyright (c) 2020 sh-edraft.de' +__version__ = '2020.12.0.1' + +from collections import namedtuple + +# imports: + +VersionInfo = namedtuple('VersionInfo', 'major minor micro') +version_info = VersionInfo(major=2020, minor=12, micro=0.1) diff --git a/src/sh_edraft/utils/console.py b/src/sh_edraft/utils/console.py new file mode 100644 index 00000000..1d014a9c --- /dev/null +++ b/src/sh_edraft/utils/console.py @@ -0,0 +1,11 @@ +from termcolor import colored + + +class Console: + + @staticmethod + def write_line(string: str, color: str = None): + if color is not None: + print(colored(string, color)) + else: + print(string) diff --git a/src/tests/logger.py b/src/tests/logger.py new file mode 100644 index 00000000..47b5e3ab --- /dev/null +++ b/src/tests/logger.py @@ -0,0 +1,50 @@ +import os +from string import Template + +from sh_edraft.configuration import ApplicationHost +from sh_edraft.logging.base.logger_base import LoggerBase +from sh_edraft.logging.logger import Logger +from sh_edraft.logging.model.log_settings import LoggingSettings +from sh_edraft.time.model.time_format_settings import TimeFormatSettings + + +class LoggerTest: + + @staticmethod + def start(app_host: ApplicationHost): + services = app_host.services + + log_settings = LoggingSettings() + log_settings.from_dict({ + "Path": "logs/", + "Filename": "log_$start_time.log", + "ConsoleLogLevel": "TRACE", + "FileLogLevel": "TRACE" + }) + + time_format_settings = TimeFormatSettings() + time_format_settings.from_dict({ + "DateFormat": "%Y-%m-%d", + "TimeFormat": "%H:%M:%S", + "DateTimeFormat": "%Y-%m-%d %H:%M:%S.%f", + "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S" + }) + + services.add_singleton(Logger, log_settings, time_format_settings, app_host) + logger: Logger = services.get_service(LoggerBase) + + if logger is None: + raise Exception(f'{__name__}: Service is None') + + logger.create() + logger.info(__name__, 'test') + + if not os.path.isdir(log_settings.path): + raise Exception(f'{__name__}: Log path was not created') + + log_file = Template(log_settings.filename).substitute( + date_time_now=app_host.date_time_now.strftime(time_format_settings.date_time_format), + start_time=app_host.start_time.strftime(time_format_settings.date_time_log_format) + ) + if not os.path.isfile(log_settings.path + log_file): + raise Exception(f'{__name__}: Log file was not created') diff --git a/src/tests/publisher.py b/src/tests/publisher.py index 43d350c4..3e100328 100644 --- a/src/tests/publisher.py +++ b/src/tests/publisher.py @@ -1,6 +1,7 @@ import os -from sh_edraft.service import ServiceProvider +from sh_edraft.publish.base import PublisherBase +from sh_edraft.service.base import ServiceProviderBase from sh_edraft.source_code.model import Version from sh_edraft.publish import Publisher from sh_edraft.publish.model import Template @@ -9,7 +10,7 @@ from sh_edraft.publish.model import Template class PublisherTest: @staticmethod - def start(services: ServiceProvider): + def start(services: ServiceProviderBase): templates = [ Template( '../../publish_templates/*_template.txt', @@ -43,7 +44,7 @@ class PublisherTest: dist = '../../dist' services.add_singleton(Publisher, None, source, dist, templates) - publisher: Publisher = services.get_service(Publisher) + publisher: Publisher = services.get_service(PublisherBase) publisher.exclude('../tests/') publisher.include('../../LICENSE') diff --git a/src/tests/service_provider.py b/src/tests/service_provider.py index 06317e85..d5808d05 100644 --- a/src/tests/service_provider.py +++ b/src/tests/service_provider.py @@ -1,23 +1,21 @@ from sh_edraft.publish import Publisher -from sh_edraft.service import ServiceProvider +from sh_edraft.publish.base import PublisherBase +from sh_edraft.service.base import ServiceProviderBase class ServiceProviderTest: @staticmethod - def start() -> ServiceProvider: - provider = ServiceProvider() + def start(provider: ServiceProviderBase): provider.create() provider.add_transient(Publisher, None, '../', '../../dist', []) - publisher: Publisher = provider.get_service(Publisher) + publisher: Publisher = provider.get_service(PublisherBase) - if publisher.source_path != '../' or publisher.dist_path != '../../dist': + if publisher is None or publisher.source_path != '../' or publisher.dist_path != '../../dist': raise Exception(f'{__name__}: Invalid value in {Publisher.__name__}') - provider.remove_service(Publisher) - if provider.get_service(Publisher) is not None: + provider.remove_service(PublisherBase) + if provider.get_service(PublisherBase) is not None: raise Exception(f'{__name__}: Service {Publisher.__name__} was not removed') - - return provider diff --git a/src/tests/test.py b/src/tests/tester.py similarity index 56% rename from src/tests/test.py rename to src/tests/tester.py index 91b9bb4f..64fa121e 100644 --- a/src/tests/test.py +++ b/src/tests/tester.py @@ -1,28 +1,27 @@ import os import sys +import traceback from typing import Optional from termcolor import colored +from sh_edraft.configuration import ApplicationHost from sh_edraft.service import ServiceProvider +from tests.logger import LoggerTest from tests.publisher import PublisherTest from tests.service_provider import ServiceProviderTest -class Test: +class Tester: def __init__(self): + self._app_host = ApplicationHost() self._services: Optional[ServiceProvider] = None - self._tests = [ - ServiceProviderTest, - PublisherTest - ] - self._error: bool = False @staticmethod - def block_print(): + def disable_print(): sys.stdout = open(os.devnull, 'w') @staticmethod @@ -32,36 +31,52 @@ class Test: def success(self, message: str): self.enable_print() print(colored(message, 'green')) - self.block_print() + self.disable_print() def failed(self, message: str): self.enable_print() print(colored(message, 'red')) - self.block_print() + self.disable_print() + + def exception(self): + self.enable_print() + print(colored(traceback.format_exc(), 'red')) + self.disable_print() def create(self): pass def start(self): - self.block_print() + self.disable_print() if not self._error: try: - self._services = ServiceProviderTest.start() + ServiceProviderTest.start(self._app_host.services) self.success(f'{ServiceProviderTest.__name__} test succeeded.') except Exception as e: self._error = True self.failed(f'{ServiceProviderTest.__name__} test failed!\n{e}') + self.exception() if not self._error: try: - PublisherTest.start(self._services) + LoggerTest.start(self._app_host) + self.success(f'{LoggerTest.__name__} test succeeded.') + except Exception as e: + self._error = True + self.failed(f'{LoggerTest.__name__} test failed!\n{e}') + self.exception() + + if not self._error: + try: + PublisherTest.start(self._app_host.services) self.success(f'{PublisherTest.__name__} test succeeded.') except Exception as e: self._error = True self.failed(f'{PublisherTest.__name__} test failed!\n{e}') + self.exception() if __name__ == '__main__': - test = Test() - test.create() - test.start() + tester = Tester() + tester.create() + tester.start()