diff test/test_redis_session.py @ 6814:3f60a71b0812

Summary: Support selecion session/otk data store. Add redis as data store. Allow admin to select the backend data store. Compatibility matrix: main\/ session>| anydbm | sqlite | redis | mysql | postgresql | anydbm | D | | X | | | sqlite | X | D | X | | | mysql | | | | D | | postgresql | | | | | D | --------------------------------------------------------------+ D - default if unconfigured, X - compatible choice DETAILS roundup/configuration.py: add config.ini section sessiondb with settings: backend and redis_url. CHANGES.txt, doc/admin_guide.txt, doc/installation.txt, doc/upgrading.txt: doc on config of session db and redis. Plus some other fixes: admin - clarified why we do not drop __words and __testids table in native-fts conversion. TYpo fix. upgrading - doc how you can keep using anydbm for session data with sqlite. Fix dupe sentence in an upgrading config.ini section. roundup/backends/back_anydbm.py, roundup/backends/back_sqlite.py: code to support redis, redis/anydbm backends respectively. roundup/backends/sessions_redis.py new storage backend for redis. roundup/rest.py, roundup/cgi/actions.py, roundup/cgi/templating.py redis uses a different way of calculating lifetime/timestamp. Since expiration of an item occurred if its timestamp was more than 1 week old, code would calculate: now - 1 week + lifetime. But this results in faster expiration in redis if used for lifetime/timestamp. Convert code to use the lifetime() method in BasicDatabase that generates the right timestamp for each backend. test/session_common.py: added tests for more cases, get without default, getall non-existing key etc. timestamp test changed to use new self.get_ts which is overridden in other tests. Test that datatypes survive storage. test/test_redis_session.py: test redis session store with sqlite and anydbm primary databases test/test_anydbm.py, test/test_sqlite.py add test to make sure the databases are properly set up sqlite - add test cases where anydbm is used as datastore anydbm - remove updateTimestamp override add get_ts(). test/test_config.py tests on redis_url and compatibility on choice of sessiondb backend .travis.yml: add redis db and redis-py
author John Rouillard <rouilj@ieee.org>
date Thu, 04 Aug 2022 14:41:58 -0400
parents
children 35f0952f4bc5
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/test_redis_session.py	Thu Aug 04 14:41:58 2022 -0400
@@ -0,0 +1,110 @@
+#
+# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
+# This module is free software, and you may redistribute it and/or modify
+# under the same terms as Python, so long as this copyright message and
+# disclaimer are retained in their original form.
+#
+# IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+# DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
+# OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
+# BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
+# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
+# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+
+import unittest, os, shutil, time
+from roundup.anypy import strings
+
+import pytest
+
+try:
+    from roundup.backends.sessions_redis import Sessions, OneTimeKeys
+    skip_redis = lambda func, *args, **kwargs: func
+except ModuleNotFoundError as e:
+    from .pytest_patcher import mark_class
+    skip_redis = mark_class(pytest.mark.skip(
+        reason='Skipping redis tests: redis module not available'))
+
+from .test_sqlite import sqliteOpener
+from .test_anydbm import anydbmOpener
+
+from .session_common import SessionTest
+
+class RedisSessionTest(SessionTest):
+    def setUp(self):
+        SessionTest.setUp(self)
+
+        # redefine the session db's as redis.
+        self.db.config.SESSIONDB_BACKEND = "redis"
+        self.db.config.SESSIONDB_REDIS_URL = 'redis://:roundupSysadmin@localhost:6379/15?health_check_interval=2'
+        self.db.Session = None
+        self.db.Otk = None
+        self.sessions = self.db.getSessionManager()
+        self.otks = self.db.getOTKManager()
+
+        # database should be empty. Verify so we don't clobber
+        # somebody's working database.
+        self.assertEqual(self.sessions.redis.keys(), [],
+            "Tests will not run on a db with keys. "
+            "Run flushdb in 'redis-cli -n 15 -p 6379 -h localhost' "
+            "to empty db first")
+        self.assertEqual(self.otks.redis.keys(), [],
+            "Tests will not run on a db with keys. "
+            "Run flushdb in 'redis-cli -n 15 -p 6379 -h localhost' "
+            "to empty db first")
+
+    def tearDown(self):
+        self.sessions.clear()
+        self.otks.clear()
+
+        SessionTest.tearDown(self)
+
+        # reset to default session backend
+        self.db.config.SESSIONDB_BACKEND = ""
+        self.db.Session = None
+        self.db.Otk = None
+        self.sessions = self.db.getSessionManager()
+        self.otks = self.db.getOTKManager()
+
+
+    def get_ts(self, key="random_session"):
+        db_tstamp = self.db.Session.redis.ttl(
+            self.db.Session.makekey(key)) + \
+            time.time()
+        print(db_tstamp)
+        return (db_tstamp,)
+
+@skip_redis
+class redis_sqliteSessionTest(sqliteOpener, RedisSessionTest, unittest.TestCase):
+    s2b = lambda x,y : y
+
+    def testLifetime(self):
+        ts = self.sessions.lifetime(300)
+        print(ts)
+        now = time.time()
+        print(now)
+        self.assertGreater(now + 302, ts)
+        self.assertLess(now + 298, ts)
+
+    def testDbType(self):
+        self.assertIn("roundlite", repr(self.db))
+        self.assertIn("roundup.backends.sessions_redis.Sessions", repr(self.db.Session))
+
+@skip_redis
+class redis_anydbmSessionTest(anydbmOpener, RedisSessionTest, unittest.TestCase):
+    s2b = lambda x,y: strings.s2b(y)
+
+    def testLifetime(self):
+        ts = self.sessions.lifetime(300)
+        print(ts)
+        now = time.time()
+        print(now)
+        self.assertGreater(now + 302, ts)
+        self.assertLess(now + 298, ts)
+
+    def testDbType(self):
+        self.assertIn("back_anydbm", repr(self.db))
+        self.assertIn("roundup.backends.sessions_redis.Sessions", repr(self.db.Session))

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