mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 01:18:58 +00:00
3184168365
This PR is part of what will be an ongoing effort to use explicit unicode strings in Salt. Because Python 3 does not suport Python 2's raw unicode string syntax (i.e. `ur'\d+'`), we must use `salt.utils.locales.sdecode()` to ensure that the raw string is unicode. However, because of how `salt/utils/__init__.py` has evolved into the hulking monstrosity it is today, this means importing a large module in places where it is not needed, which could negatively impact performance. For this reason, this PR also breaks out some of the functions from `salt/utils/__init__.py` into new/existing modules under `salt/utils/`. The long term goal will be that the modules within this directory do not depend on importing `salt.utils`. A summary of the changes in this PR is as follows: * Moves the following functions from `salt.utils` to new locations (including a deprecation warning if invoked from `salt.utils`): `to_bytes`, `to_str`, `to_unicode`, `str_to_num`, `is_quoted`, `dequote`, `is_hex`, `is_bin_str`, `rand_string`, `contains_whitespace`, `clean_kwargs`, `invalid_kwargs`, `which`, `which_bin`, `path_join`, `shlex_split`, `rand_str`, `is_windows`, `is_proxy`, `is_linux`, `is_darwin`, `is_sunos`, `is_smartos`, `is_smartos_globalzone`, `is_smartos_zone`, `is_freebsd`, `is_netbsd`, `is_openbsd`, `is_aix` * Moves the functions already deprecated by @rallytime to the bottom of `salt/utils/__init__.py` for better organization, so we can keep the deprecated ones separate from the ones yet to be deprecated as we continue to break up `salt.utils` * Updates `salt/*.py` and all files under `salt/client/` to use explicit unicode string literals. * Gets rid of implicit imports of `salt.utils` (e.g. `from salt.utils import foo` becomes `import salt.utils.foo as foo`). * Renames the `test.rand_str` function to `test.random_hash` to more accurately reflect what it does * Modifies `salt.utils.stringutils.random()` (née `salt.utils.rand_string()`) such that it returns a string matching the passed size. Previously this function would get `size` bytes from `os.urandom()`, base64-encode it, and return the result, which would in most cases not be equal to the passed size.
107 lines
3.2 KiB
Python
107 lines
3.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
'''
|
|
:codeauthor: :email:`Pedro Algarvio (pedro@algarvio.me)`
|
|
:copyright: Copyright 2016 by the SaltStack Team, see AUTHORS for more details.
|
|
:license: Apache 2.0, see LICENSE for more details.
|
|
|
|
|
|
pytestsalt.salt.log_handlers.pytest_log_handler
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Salt External Logging Handler
|
|
'''
|
|
|
|
# Import python libs
|
|
from __future__ import absolute_import
|
|
import errno
|
|
import socket
|
|
import logging
|
|
import threading
|
|
from multiprocessing import Queue
|
|
|
|
# Import 3rd-party libs
|
|
import msgpack
|
|
|
|
# Import Salt libs
|
|
from salt.ext import six
|
|
import salt.log.setup
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
__virtualname__ = 'runtests_log_handler'
|
|
|
|
|
|
def __virtual__():
|
|
if 'runtests_log_port' not in __opts__:
|
|
return False, "'runtests_log_port' not in options"
|
|
if six.PY3:
|
|
return False, "runtests external logging handler is temporarily disabled for Python 3 tests"
|
|
return True
|
|
|
|
|
|
def setup_handlers():
|
|
port = __opts__['runtests_log_port']
|
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
try:
|
|
sock.connect(('localhost', port))
|
|
except socket.error as exc:
|
|
if exc.errno == errno.ECONNREFUSED:
|
|
log.warning('Failed to connect to log server')
|
|
return
|
|
finally:
|
|
try:
|
|
sock.shutdown(socket.SHUT_RDWR)
|
|
except OSError:
|
|
pass
|
|
sock.close()
|
|
|
|
queue = Queue()
|
|
handler = salt.log.setup.QueueHandler(queue)
|
|
handler.setLevel(1)
|
|
process_queue_thread = threading.Thread(target=process_queue, args=(port, queue))
|
|
process_queue_thread.daemon = True
|
|
process_queue_thread.start()
|
|
return handler
|
|
|
|
|
|
def process_queue(port, queue):
|
|
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
try:
|
|
sock.connect(('localhost', port))
|
|
except socket.error as exc:
|
|
if exc.errno == errno.ECONNREFUSED:
|
|
sock.shutdown(socket.SHUT_RDWR)
|
|
sock.close()
|
|
log.warning('Failed to connect to log server')
|
|
return
|
|
|
|
while True:
|
|
try:
|
|
record = queue.get()
|
|
if record is None:
|
|
# A sentinel to stop processing the queue
|
|
break
|
|
# Just log everything, filtering will happen on the main process
|
|
# logging handlers
|
|
sock.sendall(msgpack.dumps(record.__dict__, encoding='utf-8'))
|
|
except (IOError, EOFError, KeyboardInterrupt, SystemExit):
|
|
sock.shutdown(socket.SHUT_RDWR)
|
|
sock.close()
|
|
break
|
|
except socket.error as exc:
|
|
if exc.errno == errno.EPIPE:
|
|
# Broken pipe
|
|
sock.shutdown(socket.SHUT_RDWR)
|
|
sock.close()
|
|
break
|
|
log.exception(exc)
|
|
except Exception as exc: # pylint: disable=broad-except
|
|
log.warning(
|
|
'An exception occurred in the pytest salt logging '
|
|
'queue thread: %s',
|
|
exc,
|
|
exc_info_on_loglevel=logging.DEBUG
|
|
)
|