view test/session_common.py @ 8423:94eed885e958

feat: add support for using dictConfig to configure logging. Basic logging config (one level and one output file non-rotating) was always possible from config.ini. However the LOGGING_CONFIG setting could be used to load an ini fileConfig style file to set various channels (e.g. roundup.hyperdb) (also called qualname or tags) with their own logging level, destination (rotating file, socket, /dev/null) and log format. This is now a deprecated method in newer logging modules. The dictConfig format is preferred and allows disabiling other loggers as well as invoking new loggers in local code. This commit adds support for it reading the dict from a .json file. It also implements a comment convention so you can document the dictConfig. configuration.py: new code test_config.py: test added for the new code. admin_guide.txt, upgrading.txt CHANGES.txt: docs added upgrading references the section in admin_guid.
author John Rouillard <rouilj@ieee.org>
date Tue, 19 Aug 2025 22:32:46 -0400
parents 9347c4a0ecd6
children
line wrap: on
line source

import os, shutil, time, unittest

from .db_test_base import config

"""
here are three different impementations for these. I am trying to fix
them so they all act the same.

set with invalid timestamp:

   session_dbm/memorydb - sets to invalid timestamp if new or existing item.
   session_rdbms - sets to time.time if new item, keeps original
                   if item exists. (note that the timestamp is
                   a separate column, the timestamp embedded in the
                   value object in the db has the bad __timestamp.
   reconciled: set to time.time for new item, keeps original time
               of existing item.

Also updateTimestamp does not update the marshalled values idea of
   __timestamp. So get(item, '__timestamp') will not work as expected
   for rdbms backends, need a sql query to get the timestamp column.

FIXME need to add getTimestamp method to sessions_rdbms.py and
sessions_dbm.py.

"""

import pytest, sys

_py3 = sys.version_info[0] > 2
if _py3:
    skip_py2 = lambda func, *args, **kwargs: func
else:
    from .pytest_patcher import mark_class
    skip_py2 = mark_class(pytest.mark.skip(
        reason="Skipping log test, test doesn't work on python2"))


class SessionTest(object):
    def setUp(self):
        # remove previous test, ignore errors
        if os.path.exists(config.DATABASE):
            shutil.rmtree(config.DATABASE)
        os.makedirs(config.DATABASE + '/files')
        self.db = self.module.Database(config, 'admin')
        self.sessions = self.db.getSessionManager()
        self.otks = self.db.getOTKManager()

    def tearDown(self):
        if hasattr(self, 'sessions'):
            if not hasattr(self.sessions, 'conn'):
                # only do this for file based databases that do not
                # have a conn(ection). If they have a connection
                # mysql throws an error when closing self.db.
                self.sessions.close()
        if hasattr(self, 'otks'):
            if not hasattr(self.otks, 'conn'):
                # only do this for file based databases that do not
                # have a conn(ection). If they have a connection
                # mysql throws an error when closing self.db.
                self.otks.close()
        if hasattr(self, 'db'):
            self.db.close()
        if os.path.exists(config.DATABASE):
            shutil.rmtree(config.DATABASE)

    def testList(self):
        '''Under dbm/memory sessions store, keys are returned as
           byte strings. self.s2b converts string to byte under those
           backends but is a no-op for rdbms based backends.

           Unknown why keys can be strings not bytes for get/set
           and work correctly.
        '''
        self.sessions.list()
        self.sessions.set('random_key', text='hello, world!')
        self.sessions.set('random_key2', text='hello, world!')
        self.assertEqual(self.sessions.list().sort(),
                [self.s2b('random_key'), self.s2b('random_key2')].sort())

    def testGetGetAllMissingKey(self):
        self.assertEqual(self.sessions.get('badc_key',
                                          'text', 'default_val'),
                         'default_val')

        with self.assertRaises(KeyError) as e:
            self.sessions.get('badc_key', 'text')

        with self.assertRaises(KeyError) as e:
            self.sessions.getall('badc_key')

    def testGetAll(self):
        self.sessions.set('random_key', text='hello, world!', otherval='bar')
        self.assertEqual(self.sessions.getall('random_key'),
            {'text': 'hello, world!', 'otherval': 'bar'})

    def testDestroy(self):
        self.sessions.set('random_key', text='hello, world!')
        self.assertEqual(self.sessions.getall('random_key'),
            {'text': 'hello, world!'})
        self.sessions.destroy('random_key')
        self.assertRaises(KeyError, self.sessions.getall, 'random_key')

    def testClear(self):
        self.sessions.set('random_key', text='hello, world!')
        self.sessions.set('random_key2', text='hello, world!')
        self.sessions.set('random_key3', text='hello, world!')
        self.assertEqual(self.sessions.getall('random_key3'),
            {'text': 'hello, world!'})
        self.assertEqual(len(self.sessions.list()), 3)
        self.sessions.clear()
        self.assertEqual(len(self.sessions.list()), 0)

    def testSetSession(self):
        self.sessions.set('random_key', text='hello, world!', otherval='bar')
        self.assertEqual(self.sessions.get('random_key', 'text'),
            'hello, world!')
        self.assertEqual(self.sessions.get('random_key', 'otherval'),
            'bar')

    def testUpdateSession(self):
        self.sessions.set('random_key', text='hello, world!')
        self.assertEqual(self.sessions.get('random_key', 'text'),
            'hello, world!')
        self.sessions.set('random_key', text='nope')
        self.assertEqual(self.sessions.get('random_key', 'text'), 'nope')

    def testBadTimestamp(self):
        self.sessions.set('random_key',
                          text='hello, world!',
                          __timestamp='not a timestamp')
        ts = self.sessions.get('random_key', '__timestamp')
        self.assertNotEqual(ts, 'not a timestamp')
        # use {1,7} because db's don't pad the fraction to 7 digits.
        ts_re=r'^[0-9]{10,16}\.[0-9]{1,7}$'
        try:
            self.assertRegex(str(ts), ts_re)
        except AttributeError:   # 2.7 version
            import warnings
            with warnings.catch_warnings():
                warnings.filterwarnings("ignore",category=DeprecationWarning)
                self.assertRegexpMatches(str(ts), ts_re)

        # now update with a bad timestamp, original timestamp should
        # be kept.
        self.sessions.set('random_key',
                          text='hello, world2!',
                          __timestamp='not a timestamp')
        item = self.sessions.get('random_key', "text")
        item_ts = self.sessions.get('random_key', "__timestamp")
        self.assertEqual(item, 'hello, world2!')
        self.assertAlmostEqual(ts, item_ts, 2)

    # overridden in test_memory
    def testUpdateTimestamp(self):
        # make sure timestamp is older than one minute so update
        # will apply
        timestamp = time.time() - 62
        self.sessions.set('random_session', text='hello, world!',
                          __timestamp=timestamp)

        self.sessions.updateTimestamp('random_session')
        # this doesn't work as the rdbms backends have a
        # session_time, otk_time column and the timestamp in the
        # session marshalled payload isn't updated. The dbm
        # backend does update the __timestamp value so it works
        # for dbm.
        #self.assertNotEqual (self.sessions.get('random_session',
        #                                       '__timestamp'),
        #                     timestamp)

        # use 61 to allow a 1 second delay in test
        self.assertGreater(self.get_ts()[0] - timestamp, 61)

    # overridden in test_anydbm
    def get_ts(self, key="random_session"):
        sql = '''select %(name)s_time from %(name)ss
        where %(name)s_key = '%(session)s';'''% \
            {'name': self.sessions.name,
             'session': key}

        self.sessions.cursor.execute(sql)
        db_tstamp = self.sessions.cursor.fetchone()
        return db_tstamp

    def testDataTypes(self):
        """make sure all data survives a round trip through the
           session database including data types.

           Found this was a problem when trying to store the
           data using a redis hash that has no native data types
           for booleans and numbers get returned by redis module
           as strings.
        """
        in_data = {"text": 'hello, world!',
                   "integer": 56, 
                   "float": 3.1425,
                   "list": [ 1, "Two", 3.0, "Four" ],
                   "boolean": True,
                   "tuple": ("f", 4),
                   }

        self.sessions.set('random_data', **in_data)
        out_data = self.sessions.getall('random_data')
        self.assertEqual(in_data, out_data)

    def testLifetime(self):
        ts = self.sessions.lifetime(300)
        week_ago =  time.time() - 60*60*24*7
        self.assertGreater(week_ago + 302, ts)
        self.assertLess(week_ago + 298, ts)

    def testGetUniqueKey(self):
        # 40 bytes of randomness gets larger when encoded
        key = self.sessions.getUniqueKey()
        self.assertEqual(len(key), 54)

        # length is bytes of randomness
        key = self.sessions.getUniqueKey(length=23)
        self.assertEqual(len(key), 31)

        key = self.sessions.getUniqueKey(length=200)
        self.assertEqual(len(key), 267)

    def testget_logger(self):
        logger = self.sessions.get_logger()
        # why do rdbms session use session/otk as the table name
        # while dbm uses sessions/otks? In any case check both.
        self.assertIn(logger.name, ["roundup.hyperdb.backends.sessions",
                                    "roundup.hyperdb.backends.session"])

        logger = self.otks.get_logger()
        self.assertIn(logger.name, ["roundup.hyperdb.backends.otks",
                                    "roundup.hyperdb.backends.otk"])

    def testget_logger_name_test(self):
        self.sessions.name="otks"
        logger = self.sessions.get_logger()
        self.assertEqual(logger.name, "roundup.hyperdb.backends.otks")

    @skip_py2
    def test_log_warning(self):
        """Only python3 pytest has the right context handler for this,
           so skip this on python2.
        """

        self.sessions.name = "newdb"

        with self.assertLogs(logger="roundup.hyperdb.backends.newdb") as logs:
            self.sessions.log_warning("hello world")

        self.assertEqual(len(logs.records), 1)
        self.assertEqual(logs.records[0].levelname, "WARNING")

    @skip_py2
    def test_log_info(self):
        """Only python3 pytest has the right context handler for this,
           so skip this on python2.
        """

        self.sessions.name = "newdb"

        with self.assertLogs(logger="roundup.hyperdb.backends.newdb") as logs:
            self.sessions.log_info("hello world")

        self.assertEqual(len(logs.records), 1)
        self.assertEqual(logs.records[0].levelname, "INFO")

    @skip_py2
    def test_log_debug(self):
        """Only python3 pytest has the right context handler for this,
           so skip this on python2.
        """

        self.sessions.name = "newdb"

        with self.assertLogs(logger="roundup.hyperdb.backends.newdb",
                             level='DEBUG') as logs:
            self.sessions.log_debug("hello world")

        self.assertEqual(len(logs.records), 1)
        self.assertEqual(logs.records[0].levelname, "DEBUG")
        

Roundup Issue Tracker: http://roundup-tracker.org/