cherrypy-foundation 1.0.0__py3-none-any.whl → 1.0.0a1__py3-none-any.whl

cherrypy_foundation/plugins/tests/test_scheduler.py

@@ -1,5 +1,5 @@
 # Scheduler plugins for Cherrypy
-# Copyright (C) 2026 IKUS Software
+# Copyright (C) 2022-2025 IKUS Software
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -14,87 +14,79 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-from datetime import datetime, timezone
-from threading import Event
+"""
+Created on Oct 17, 2015
+
+@author: Patrik Dufresne <patrik@ikus-soft.com>
+"""
+import importlib.util
+import unittest
+from time import sleep
 
 import cherrypy
 from cherrypy.test import helper
 
-from .. import scheduler  # noqa
-
-done = Event()
+HAS_APSCHEDULER = importlib.util.find_spec("apscheduler") is not None
 
-
-def a_task(*args, **kwargs):
-    done.set()
+if HAS_APSCHEDULER:
+    from .. import scheduler  # noqa
 
 
+@unittest.skipUnless(HAS_APSCHEDULER, "apscheduler not installed")
 class SchedulerPluginTest(helper.CPWebCase):
     def setUp(self) -> None:
-        done.clear()
-        cherrypy.scheduler.remove_all_jobs()
+        self.called = False
         return super().setUp()
 
-    def tearDown(self):
-        return super().tearDown()
-
     @classmethod
     def setup_server(cls):
         pass
 
-    def test_add_job(self):
-        # Given a scheduled job
-        scheduled = cherrypy.engine.publish(
-            'scheduler:add_job',
-            a_task,
-            name='custom_name',
-            args=(1, 2, 3),
-            kwargs={'foo': 'bar'},
-            next_run_time=datetime.now(timezone.utc),
-            misfire_grace_time=None,
-        )
-        self.assertTrue(scheduled)
-        self.assertEqual('custom_name', scheduled[0].name)
-        # When waiting for all jobs
-        cherrypy.scheduler.wait_for_jobs()
-        # Then the job is done
-        self.assertTrue(done.is_set())
-
-    def test_add_job_daily(self):
+    def test_schedule_job(self):
         # Given a scheduler with a specific number of jobs
-        count = len(cherrypy.scheduler.get_jobs())
-        # When scheduling a daily job.
-        scheduled = cherrypy.engine.publish('scheduler:add_job_daily', '23:00', a_task, 1, 2, 3, foo=1, bar=2)
-        # Then the job is scheduled
+        count = len(cherrypy.scheduler.list_jobs())
+
+        # Given a job schedule every seconds
+        def a_job(*args, **kwargs):
+            self.called = True
+
+        scheduled = cherrypy.engine.publish('schedule_job', '23:00', a_job, 1, 2, 3, foo=1, bar=2)
         self.assertTrue(scheduled)
-        self.assertEqual('a_task', scheduled[0].name)
-        # Then the number of jobs increase.
-        self.assertEqual(count + 1, len(cherrypy.scheduler.get_jobs()))
+        self.assertEqual(count + 1, len(cherrypy.scheduler.list_jobs()))
 
-    def test_add_job_now(self):
+    def test_scheduler_task(self):
         # Given a task
+
+        def a_task(*args, **kwargs):
+            self.called = True
+
         # When scheduling that task
-        scheduled = cherrypy.engine.publish('scheduler:add_job_now', a_task, 1, 2, 3, foo=1, bar=2)
+        scheduled = cherrypy.engine.publish('schedule_task', a_task, 1, 2, 3, foo=1, bar=2)
         self.assertTrue(scheduled)
-        # When waiting for all tasks
-        cherrypy.scheduler.wait_for_jobs()
+        sleep(1)
+        while len(cherrypy.scheduler.list_tasks()) >= 1:
+            sleep(1)
         # Then the task get called
-        self.assertTrue(done.is_set())
+        self.assertTrue(self.called)
 
-    def test_remove_job(self):
+    def test_unschedule_job(self):
         # Given a scheduler with a specific number of jobs
-        count = len(cherrypy.scheduler.get_jobs())
+        count = len(cherrypy.scheduler.list_jobs())
+
         # Given a job schedule every seconds
-        cherrypy.engine.publish('scheduler:add_job_daily', '23:00', a_task, 1, 2, 3, foo=1, bar=2)
-        # Then number of job increase
-        self.assertEqual(count + 1, len(cherrypy.scheduler.get_jobs()))
-        # When the job is unscheduled.
-        cherrypy.engine.publish('scheduler:remove_job', a_task)
-        # Then the number of job decrease.
-        self.assertEqual(count, len(cherrypy.scheduler.get_jobs()))
-
-    def test_remove_job_with_invalid_job(self):
+        def a_job(*args, **kwargs):
+            self.called = True
+
+        cherrypy.engine.publish('schedule_job', '23:00', a_job, 1, 2, 3, foo=1, bar=2)
+        self.assertEqual(count + 1, len(cherrypy.scheduler.list_jobs()))
+        cherrypy.engine.publish('unschedule_job', a_job)
+        self.assertEqual(count, len(cherrypy.scheduler.list_jobs()))
+
+    def test_unschedule_job_with_invalid_job(self):
         # Given an unschedule job
+        def a_job(*args, **kwargs):
+            self.called = True
+
         # When unscheduling an invalid job
-        cherrypy.engine.publish('scheduler:remove_job', a_task)
-        # Then an error is not raised.
+        cherrypy.engine.publish('unschedule_job', a_job)
+        # Then no error are raised

cherrypy_foundation/plugins/tests/test_smtp.py

@@ -1,5 +1,5 @@
 # SMTP Plugins for cherrypy
-# Copyright (C) 2022-2026 IKUS Software
+# Copyright (C) 2022-2025 IKUS Software
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -18,7 +18,6 @@ from unittest import mock, skipUnless
 
 import cherrypy
 from cherrypy.test import helper
-from parameterized import parameterized
 
 from .. import smtp  # noqa
 
@@ -64,15 +63,12 @@ class SmtpPluginTest(helper.CPWebCase):
 
     @skipUnless(hasattr(cherrypy, 'scheduler'), reason='Required scheduler')
     def test_queue_mail(self):
-        with mock.patch(smtp.__name__ + '.smtplib') as smtplib:
-            # Given a mail being queued.
-            cherrypy.engine.publish('queue_mail', to='target@test.com', subject='subjet', message='body')
-            # When waiting for all task to be processed
-            cherrypy.scheduler.wait_for_jobs()
-            # Then smtplib is called to send the mail.
-            smtplib.SMTP.assert_called_once_with('__default__', 25)
-            smtplib.SMTP.return_value.send_message.assert_called_once_with(mock.ANY)
-            smtplib.SMTP.return_value.quit.assert_called_once_with()
+        # Given a paused scheduler plugin
+        cherrypy.scheduler._scheduler.pause()
+        # When queueing a email
+        cherrypy.engine.publish('queue_mail', to='target@test.com', subject='subjet', message='body')
+        # Then a new job get schedule
+        self.assertEqual(1, len(cherrypy.scheduler.list_tasks()))
 
     def test_html2plaintext(self):
         """
@@ -109,32 +105,3 @@ Here is the link [1] you wanted.
         self.assertEqual(
             'test2@test.com, TEST3 <test3@test.com>', smtp._formataddr(['test2@test.com', ('TEST3', 'test3@test.com')])
         )
-
-    @parameterized.expand(
-        [
-            (None, None, None),
-            (None, 'test2@test.com', 'test2@test.com'),
-            ('test2@test.com', None, 'test2@test.com'),
-            ('test1@test.com', 'test2@test.com', 'test1@test.com, test2@test.com'),
-        ]
-    )
-    def test_with_bcc(self, smtp_bcc, bcc, expected_bcc):
-        # Given a valid smtp server
-        with mock.patch(smtp.__name__ + '.smtplib') as smtplib:
-            # Given bcc is defined at plugin level.
-            cherrypy.smtp.bcc = smtp_bcc
-            # When publishing a send_mail with Bcc
-            cherrypy.engine.publish(
-                'send_mail',
-                to=('A name', 'target@test.com'),
-                subject='subjet',
-                message='body',
-                bcc=bcc,
-            )
-            # Then message is sent
-            smtplib.SMTP.assert_called_once_with('__default__', 25)
-            smtplib.SMTP.return_value.send_message.assert_called_once_with(mock.ANY)
-            msg = smtplib.SMTP.return_value.send_message.call_args.args[0]
-            smtplib.SMTP.return_value.quit.assert_called_once_with()
-            # Message include our expected Bcc
-            self.assertEqual(expected_bcc, msg['Bcc'])

cherrypy_foundation/tests/__init__.py

@@ -1,72 +0,0 @@
-# Cherrypy-foundation
-# Copyright (C) 2026 IKUS Software
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-import os
-import tempfile
-import unittest
-from contextlib import contextmanager
-
-from selenium import webdriver
-
-
-class SeleniumUnitTest:
-
-    @property
-    def _session_id(self):
-        if hasattr(self, 'cookies') and self.cookies:
-            for unused, value in self.cookies:
-                for part in value.split(';'):
-                    key, unused, value = part.partition('=')
-                    if key == 'session_id':
-                        return value
-
-    @contextmanager
-    def selenium(self, headless=True, implicitly_wait=3):
-        """
-        Decorator to load selenium for a test.
-        """
-        # Skip selenium test is display is not available.
-        if not os.environ.get('DISPLAY', False):
-            raise unittest.SkipTest("selenium require a display")
-        # Start selenium driver
-        options = webdriver.ChromeOptions()
-        if headless:
-            options.add_argument('--headless')
-        options.add_argument('--disable-gpu')
-        options.add_argument('--window-size=1280,800')
-        options.add_argument('--no-sandbox')
-        options.add_argument('--disable-dev-shm-usage')
-        options.add_argument('--lang=en-US')
-        driver = webdriver.Chrome(options=options)
-        try:
-            # If logged in, reuse the same session id.
-            if self._session_id:
-                driver.get(f'{self.baseurl}/login/')
-                driver.add_cookie({"name": "session_id", "value": self.session_id})
-            # Configure download folder
-            download = os.path.join(os.path.expanduser('~'), 'Downloads')
-            os.makedirs(download, exist_ok=True)
-            self._selenium_download_dir = tempfile.mkdtemp(dir=download, prefix='selenium-download-')
-            driver.execute_cdp_cmd(
-                'Page.setDownloadBehavior', {'behavior': 'allow', 'downloadPath': self._selenium_download_dir}
-            )
-            # Set default wait.
-            driver.implicitly_wait(implicitly_wait)
-            yield driver
-        finally:
-            # Code to release resource, e.g.:
-            driver.close()
-            driver = None

cherrypy_foundation/tests/test_error_page.py

@@ -1,5 +1,5 @@
 # CherryPy
-# Copyright (C) 2026 IKUS Software
+# Copyright (C) 2025 IKUS Software
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -29,10 +29,6 @@ class Root:
 
     @cherrypy.expose
     def not_found(self):
-        raise cherrypy.NotFound()
-
-    @cherrypy.expose
-    def not_found_custom(self):
         raise cherrypy.HTTPError(404, message='My error message')
 
     @cherrypy.expose
@@ -64,8 +60,6 @@ class ErrorPageTest(helper.CPWebCase):
 
     @parameterized.expand(
         [
-            ('/not_found', '<p>Nothing matches the given URI</p>'),
-            ('/not_found_custom', '<p>My error message</p>'),
             ('/html_error', '<p>My error message</p>'),
             ('/json_error', '{"message": "json error message", "status": "400 Bad Request"}'),
             ('/text_error', 'text error message'),

cherrypy_foundation/tests/test_passwd.py

@@ -1,5 +1,5 @@
-# Cherrypy-foundation
-# Copyright (C) 2026 IKUS Software
+# CherryPy Foundation
+# Copyright (C) 2025 IKUS Software inc.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

cherrypy_foundation/tools/auth.py

@@ -1,5 +1,5 @@
 # Authentication tools for cherrypy
-# Copyright (C) 2026 IKUS Software
+# Copyright (C) 2025 IKUS Software
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -20,8 +20,6 @@ import urllib.parse
 
 import cherrypy
 
-from cherrypy_foundation.sessions import session_lock
-
 AUTH_LAST_PASSWORD_AT = '_auth_last_password_at'
 AUTH_METHOD = '_auth_method'
 AUTH_ORIGINAL_URL = '_auth_original_url'
@@ -31,6 +29,9 @@ AUTH_DEFAULT_SESSION_KEY = "_auth_session_key"
 AUTH_DEFAULT_REAUTH_TIMEOUT = 60  # minutes
 
 
+logger = logging.getLogger(__name__)
+
+
 class AuthManager(cherrypy.Tool):
     """
     CherryPy tool handling authentication.
@@ -73,17 +74,17 @@ class AuthManager(cherrypy.Tool):
         if not hasattr(cherrypy.serving, 'session'):
             return
         # Check if a user_key is stored in session.
-        with session_lock() as session:
-            user_key = session.get(self._session_user_key())
-            if not user_key:
-                return
+        session = cherrypy.serving.session
+        user_key = session.get(self._session_user_key())
+        if not user_key:
+            return
 
-            last = session.get(AUTH_LAST_PASSWORD_AT)
-            if last is None:
-                return  # never had a password login in this session
-            timeout = self._reauth_timeout_minutes()
-            if (last + datetime.timedelta(minutes=timeout)) < session.now():
-                return
+        last = session.get(AUTH_LAST_PASSWORD_AT)
+        if last is None:
+            return  # never had a password login in this session
+        timeout = self._reauth_timeout_minutes()
+        if (last + datetime.timedelta(minutes=timeout)) < session.now():
+            return
 
         # Mark request as authenticated by key; user object will be resolved later.
         cherrypy.serving.request.login = user_key
@@ -101,12 +102,7 @@ class AuthManager(cherrypy.Tool):
             try:
                 currentuser = user_from_key_func(user_key)
             except Exception:
-                cherrypy.log(
-                    f'unexpected error searching for user_key={user_key}',
-                    context='AUTH',
-                    severity=logging.ERROR,
-                    traceback=True,
-                )
+                logger.exception('error while resolving user from key')
                 currentuser = None
 
             if currentuser:
@@ -126,7 +122,7 @@ class AuthManager(cherrypy.Tool):
         Validate credentials with configured checkers; on success, call login_with_result.
         """
         if not login or not password:
-            cherrypy.log('authentication failed reason=empty_credentials', context='AUTH', severity=logging.WARNING)
+            logger.warning('empty login or password provided')
             return None
         # Validate credentials using checkpassword function(s).
         conf = self._merged_args()
@@ -147,24 +143,15 @@ class AuthManager(cherrypy.Tool):
                     login, user_info = login, None
                 # If authentication is successful, initiate login process.
                 return self.login_with_result(login=login, user_info=user_info)
-            except Exception:
-                cherrypy.log(
-                    f'unexpected error checking password login={login} checkpassword={func.__qualname__} - continue with next function',
-                    context='AUTH',
-                    severity=logging.ERROR,
-                    traceback=True,
+            except Exception as e:
+                logger.exception(
+                    'unexpected error during authentication for [%s] with [%s]: %s', login, func.__qualname__, e
                 )
         # If we reach here, authentication failed
         if hasattr(cherrypy.serving, 'session'):
-            with session_lock() as session:
-                session.regenerate()  # Prevent session analysis
+            cherrypy.serving.session.regenerate()  # Prevent session analysis
 
-        remote_ip = cherrypy.serving.request.remote.ip
-        cherrypy.log(
-            f'authentication failed login={login} ip={remote_ip} reason=wrong_credentials',
-            context='AUTH',
-            severity=logging.WARNING,
-        )
+        logger.warning('Failed login attempt for user=%s from ip=%s', login, cherrypy.serving.request.remote.ip)
 
         return None
 
@@ -179,18 +166,11 @@ class AuthManager(cherrypy.Tool):
         try:
             user_key, userobj = user_lookup_func(login=login, user_info=user_info or {})
         except Exception:
-            cherrypy.log(
-                f"unexpected error searching user login={login} user_info={user_info}",
-                context='AUTH',
-                severity=logging.ERROR,
-                traceback=True,
-            )
+            logger.exception('failed to lookup user object for login=%s', login)
             return None
 
         if not userobj:
-            cherrypy.log(
-                f"authentication failed login={login} reason=not_found", context='AUTH', severity=logging.WARNING
-            )
+            logger.warning('failed to lookup user object for login=%s', login)
             return None
 
         # Notify plugins about user login
@@ -198,13 +178,13 @@ class AuthManager(cherrypy.Tool):
 
         # Store in session
         if hasattr(cherrypy.serving, 'session'):
-            with session_lock() as session:
-                session_user_key = self._session_user_key()
-                session[session_user_key] = user_key
-                session[AUTH_METHOD] = auth_method
-                session[AUTH_LAST_PASSWORD_AT] = session.now()
-                # Generate a new session id
-                session.regenerate()
+            session = cherrypy.serving.session
+            session_user_key = self._session_user_key()
+            session[session_user_key] = user_key
+            session[AUTH_METHOD] = auth_method
+            session[AUTH_LAST_PASSWORD_AT] = session.now()
+            # Generate a new session id
+            session.regenerate()
 
         # When authenticated, store user_key in request.
         cherrypy.serving.request.login = user_key
@@ -216,9 +196,9 @@ class AuthManager(cherrypy.Tool):
         """
         Clear session data and generate a new session id.
         """
-        with session_lock() as session:
-            session.clear()
-            session.regenerate()
+        session = cherrypy.serving.session
+        session.clear()
+        session.regenerate()
 
     def get_original_url(self):
         """
@@ -226,16 +206,15 @@ class AuthManager(cherrypy.Tool):
         """
         if not hasattr(cherrypy.serving, 'session'):
             return None
-        with session_lock() as session:
-            return session.get(AUTH_ORIGINAL_URL)
+        return cherrypy.serving.session.get(AUTH_ORIGINAL_URL)
 
     def get_user_key(self):
         """Return the last username."""
         if not hasattr(cherrypy.serving, 'session'):
             return False
+        session = cherrypy.serving.session
         session_user_key = self._session_user_key()
-        with session_lock() as session:
-            return session.get(session_user_key)
+        return session.get(session_user_key)
 
     def redirect_to_original_url(self):
         # Redirect user to original URL
@@ -256,8 +235,8 @@ class AuthManager(cherrypy.Tool):
         query_string = request.query_string
 
         # Store value in session
-        with session_lock() as session:
-            session[AUTH_ORIGINAL_URL] = cherrypy.url(original_url, qs=query_string, base='')
+        session = cherrypy.serving.session
+        session[AUTH_ORIGINAL_URL] = cherrypy.url(original_url, qs=query_string, base='')
 
 
 cherrypy.tools.auth = AuthManager()