Mercurial > p > roundup > code
comparison roundup/backends/sessions_common.py @ 6823:fe0091279f50
Refactor session db logging and key generation for sessions/otks
While I was working on the redis sessiondb stuff, I noticed that
log_wanrning, get_logger ... was duplicated. Also there was code to
generate a unique key for otks that was duplicated.
Changes:
creating new sessions_common.py and SessionsCommon class to provide
methods:
log_warning, log_info, log_debug, get_logger, getUniqueKey
getUniqueKey method is closer to the method used to make
session keys in client.py.
sessions_common.py now report when random_.py chooses a weak
random number generator. Removed same from rest.py.
get_logger reconciles all logging under
roundup.hyperdb.backends.<name of BasicDatabase class>
some backends used to log to root logger.
have BasicDatabase in other sessions_*.py modules inherit from
SessionCommon.
change logging to use log_* methods.
In addition:
remove unused imports reported by flake8 and other formatting
changes
modify actions.py, rest.py, templating.py to use getUniqueKey
method.
add tests for new methods
test_redis_session.py
swap out ModuleNotFoundError for ImportError to prevent crash in
python2 when redis is not present.
allow injection of username:password or just password into redis
connection URL. set pytest_redis_pw envirnment variable to password
or user:password when running test.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 07 Aug 2022 01:51:11 -0400 |
| parents | |
| children | b04e44db7d8d |
comparison
equal
deleted
inserted
replaced
| 6822:5053ee6c846b | 6823:fe0091279f50 |
|---|---|
| 1 import base64, logging | |
| 2 | |
| 3 import roundup.anypy.random_ as random_ | |
| 4 from roundup.anypy.strings import b2s | |
| 5 | |
| 6 logger = logging.getLogger('roundup.hyperdb.backend.sessions') | |
| 7 if not random_.is_weak: | |
| 8 logger.debug("Importing good random generator") | |
| 9 else: | |
| 10 logger.warning("**SystemRandom not available. Using poor random generator") | |
| 11 | |
| 12 | |
| 13 class SessionCommon: | |
| 14 | |
| 15 def log_debug(self, msg, *args, **kwargs): | |
| 16 """Log a message with level DEBUG.""" | |
| 17 | |
| 18 logger = self.get_logger() | |
| 19 logger.debug(msg, *args, **kwargs) | |
| 20 | |
| 21 def log_info(self, msg, *args, **kwargs): | |
| 22 """Log a message with level INFO.""" | |
| 23 | |
| 24 logger = self.get_logger() | |
| 25 logger.info(msg, *args, **kwargs) | |
| 26 | |
| 27 def log_warning(self, msg, *args, **kwargs): | |
| 28 """Log a message with level INFO.""" | |
| 29 logger = self.get_logger() | |
| 30 logger.warning(msg, *args, **kwargs) | |
| 31 | |
| 32 def get_logger(self): | |
| 33 """Return the logger for this database.""" | |
| 34 | |
| 35 # Because getting a logger requires acquiring a lock, we want | |
| 36 # to do it only once. | |
| 37 if not hasattr(self, '__logger'): | |
| 38 self.__logger = logging.getLogger('roundup.hyperdb.backends.%s' % | |
| 39 self.name or "basicdb" ) | |
| 40 | |
| 41 return self.__logger | |
| 42 | |
| 43 def getUniqueKey(self, length=40): | |
| 44 otk = b2s(base64.b64encode( | |
| 45 random_.token_bytes(length))).rstrip('=') | |
| 46 while self.exists(otk): | |
| 47 otk = b2s(base64.b64encode( | |
| 48 random_.token_bytes(length))).rstrip('=') | |
| 49 | |
| 50 return otk |