deb-murano/murano/engine/system/logger.py
Stan Lagun 9e8cec8910 Support for Unicode strings in MuranoPL was fixed
There were several issues with Unicode support in MuranoPL
after switch to yaql 1.0. Each of those issues caused any deploy
to fail if it used to do anything with non-ASCII strings

Fixed issues are:
* Unicode strings should not be encoded to str types anymore.
yaql 1.0 has native support for the Unicode and fails when non-
ASCII chars encounter in str expressions. Also tests for Unicode
support are now part of the yaql

* Traces of execution were logged not as Unicode strings.  Because
those traces contain parameter values ant function return value
logging failed when any of above contained non-ASCII chars

* Stack trace logging failed when frame expression contained
non-ASCII chars

* Exception messages could not contain non-ASCII chars

Also Logging API was not Unicode ready

Change-Id: Ief0b45f15669c5f8ee74fd6ff41fa5bc39c9500b
Closes-Bug: #1494275
2015-09-15 02:21:54 +03:00

112 lines
4.3 KiB
Python

# Copyright (c) 2015 Mirantis Inc.
#
# 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.
import exceptions
from oslo_log import log as logging
from yaql.language import specs
from yaql.language import yaqltypes
from murano.dsl import dsl
NAME_TEMPLATE = u'applications.{0}'
inject_format = specs.inject(
'_Logger__yaql_format_function',
yaqltypes.Delegate('format'))
@dsl.name('io.murano.system.Logger')
class Logger(object):
"""Logger object for MuranoPL.
Instance of this object returned by 'logger' YAQL function
and should not be instantiated directly
"""
def __init__(self, logger_name):
self._underlying_logger = logging.getLogger(
NAME_TEMPLATE.format(logger_name))
@specs.parameter('_Logger__message', yaqltypes.String())
@inject_format
def trace(__self, __yaql_format_function, __message, *args, **kwargs):
__self._log(__self._underlying_logger.trace,
__yaql_format_function, __message, args, kwargs)
@specs.parameter('_Logger__message', yaqltypes.String())
@inject_format
def debug(__self, __yaql_format_function, __message, *args, **kwargs):
__self._log(__self._underlying_logger.debug,
__yaql_format_function, __message, args, kwargs)
@specs.parameter('_Logger__message', yaqltypes.String())
@inject_format
def info(__self, __yaql_format_function, __message, *args, **kwargs):
__self._log(__self._underlying_logger.info,
__yaql_format_function, __message, args, kwargs)
@specs.parameter('_Logger__message', yaqltypes.String())
@inject_format
def warning(__self, __yaql_format_function, __message, *args, **kwargs):
__self._log(__self._underlying_logger.warning,
__yaql_format_function, __message, args, kwargs)
@specs.parameter('_Logger__message', yaqltypes.String())
@inject_format
def error(__self, __yaql_format_function, __message, *args, **kwargs):
__self._log(__self._underlying_logger.error,
__yaql_format_function, __message, args, kwargs)
@specs.parameter('_Logger__message', yaqltypes.String())
@inject_format
def critical(__self, __yaql_format_function,
__message, *args, **kwargs):
__self._log(__self._underlying_logger.critical,
__yaql_format_function, __message, args, kwargs)
@specs.parameter('_Logger__message', yaqltypes.String())
@inject_format
def exception(__self, __yaql_format_function,
__exc, __message, *args, **kwargs):
"""Print error message and stacktrace"""
stack_trace_message = u'\n'.join([
__self._format_without_exceptions(
__yaql_format_function, __message, args, kwargs),
__exc['stackTrace']().toString()
])
__self._underlying_logger.error(stack_trace_message)
def _format_without_exceptions(self, format_function,
message, args, kwargs):
"""Wrap YAQL function "format" to suppress exceptions
whose may be raised when message cannot be formatted
due to invalid parameters provided
We do not want to break program workflow
even formatting parameters are incorrect
"""
try:
message = format_function(message, *args, **kwargs)
except (exceptions.IndexError, exceptions.KeyError):
# NOTE(akhivin): we do not want break program workflow
# even formatting parameters are incorrect
self._underlying_logger.warning(
u'Can not format string: {0}'.format(message))
return message
def _log(self, log_function, yaql_format_function, message, args, kwargs):
log_function(
self._format_without_exceptions(
yaql_format_function, message, args, kwargs))