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

cherrypy_foundation/plugins/smtp.py

@@ -100,6 +100,26 @@ def _formataddr(value):
     return ', '.join(map(_formataddr, value))
 
 
+def _send_message(server, encryption, username, password, msg):
+    """
+    Send message using SMTP.
+    """
+    host, unused, port = server.partition(':')
+    if encryption == 'ssl':
+        conn = smtplib.SMTP_SSL(host, port or 465)
+    else:
+        conn = smtplib.SMTP(host, port or 25)
+    try:
+        if encryption == 'starttls':
+            conn.starttls()
+        # Authenticate if required.
+        if username:
+            conn.login(username, password)
+        conn.send_message(msg)
+    finally:
+        conn.quit()
+
+
 class SmtpPlugin(SimplePlugin):
 
     server = None
@@ -108,6 +128,32 @@ class SmtpPlugin(SimplePlugin):
     encryption = None
     email_from = None
 
+    def _create_msg(self, subject: str, message: str, to=None, cc=None, bcc=None, reply_to=None, headers={}):
+        assert subject
+        assert message
+        assert to or bcc
+
+        # Record the MIME types of both parts - text/plain and text/html.
+        msg = MIMEMultipart('alternative')
+        msg['Subject'] = str(subject)
+        msg['From'] = _formataddr(self.email_from)
+        if to:
+            msg['To'] = _formataddr(to)
+        if cc:
+            msg['Cc'] = _formataddr(cc)
+        if bcc:
+            msg['Bcc'] = _formataddr(bcc)
+        if reply_to:
+            msg['Reply-To'] = _formataddr(reply_to)
+        msg['Message-ID'] = email.utils.make_msgid()
+        if headers:
+            for key, value in headers.items():
+                msg[key] = value
+        text = _html2plaintext(message)
+        msg.attach(MIMEText(text, 'plain', 'utf8'))
+        msg.attach(MIMEText(message, 'html', 'utf8'))
+        return msg
+
     def start(self):
         self.bus.log('Start SMTP plugin')
         self.bus.subscribe("send_mail", self.send_mail)
@@ -118,70 +164,50 @@ class SmtpPlugin(SimplePlugin):
         self.bus.unsubscribe("send_mail", self.send_mail)
         self.bus.unsubscribe("queue_mail", self.queue_mail)
 
+    def graceful(self):
+        """Reload of subscribers."""
+        self.stop()
+        self.start()
+
     def queue_mail(self, *args, **kwargs):
         """
         Queue mail to be sent.
         """
         # Skip sending email if smtp server is not configured.
         if not self.server:
-            self.bus.log('cannot send email because SMTP Server is not configured')
+            cherrypy.log('cannot send email because SMTP Server is not configured', context='SMTP')
             return
         if not self.email_from:
-            self.bus.log('cannot send email because SMTP From is not configured')
+            cherrypy.log('cannot send email because SMTP From is not configured', context='SMTP')
             return
-        self.bus.publish('schedule_task', self.send_mail, *args, **kwargs)
-
-    def send_mail(self, subject: str, message: str, to=None, cc=None, bcc=None, reply_to=None, headers={}):
+        msg = self._create_msg(*args, **kwargs)
+        self.bus.publish(
+            'scheduler:add_job_now',
+            _send_message,
+            server=self.server,
+            encryption=self.encryption,
+            username=self.username,
+            password=self.password,
+            msg=msg,
+        )
+
+    def send_mail(self, *args, **kwargs):
         """
         Reusable method to be called to send email to the user user.
         `user` user object where to send the email.
         """
-        assert subject
-        assert message
-        assert to or bcc
-
         # Skip sending email if smtp server is not configured.
         if not self.server:
-            self.bus.log('cannot send email because SMTP Server is not configured')
+            cherrypy.log('cannot send email because SMTP Server is not configured', context='SMTP')
             return
         if not self.email_from:
-            self.bus.log('cannot send email because SMTP From is not configured')
+            cherrypy.log('cannot send email because SMTP From is not configured', context='SMTP')
             return
 
-        # Record the MIME types of both parts - text/plain and text/html.
-        msg = MIMEMultipart('alternative')
-        msg['Subject'] = str(subject)
-        msg['From'] = _formataddr(self.email_from)
-        if to:
-            msg['To'] = _formataddr(to)
-        if cc:
-            msg['Cc'] = _formataddr(cc)
-        if bcc:
-            msg['Bcc'] = _formataddr(bcc)
-        if reply_to:
-            msg['Reply-To'] = _formataddr(reply_to)
-        msg['Message-ID'] = email.utils.make_msgid()
-        if headers:
-            for key, value in headers.items():
-                msg[key] = value
-        text = _html2plaintext(message)
-        msg.attach(MIMEText(text, 'plain', 'utf8'))
-        msg.attach(MIMEText(message, 'html', 'utf8'))
-
-        host, unused, port = self.server.partition(':')
-        if self.encryption == 'ssl':
-            conn = smtplib.SMTP_SSL(host, port or 465)
-        else:
-            conn = smtplib.SMTP(host, port or 25)
-        try:
-            if self.encryption == 'starttls':
-                conn.starttls()
-            # Authenticate if required.
-            if self.username:
-                conn.login(self.username, self.password)
-            conn.send_message(msg)
-        finally:
-            conn.quit()
+        msg = self._create_msg(*args, **kwargs)
+        _send_message(
+            server=self.server, encryption=self.encryption, username=self.username, password=self.password, msg=msg
+        )
 
 
 # Register SMTP plugin

cherrypy_foundation/plugins/tests/test_db.py

@@ -93,7 +93,7 @@ else:
             # Given an empty database
             self.assertEqual(0, User.query.count())
             # When calling "/add/" to create a user
-            self.getPage('/add', method='POST', body=urlencode([('username', 'myuser')]))
+            self.getPage('/add', method='POST', body=urlencode({'username': 'myuser'}))
             self.assertStatus(200)
             self.assertInBody('OK')
             # Then user get added to database
@@ -103,7 +103,7 @@ else:
             # Given a database with a users
             User(username='user1').add().commit()
             # When trying to add another user
-            self.getPage('/add', method='POST', body=urlencode([('username', 'user1')]))
+            self.getPage('/add', method='POST', body=urlencode({'username': 'user1'}))
             # Then an error get raised
             self.assertStatus(200)
             self.assertInBody('user_username_unique_ix')

cherrypy_foundation/plugins/tests/test_scheduler.py

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

cherrypy_foundation/plugins/tests/test_smtp.py

@@ -63,12 +63,15 @@ class SmtpPluginTest(helper.CPWebCase):
 
     @skipUnless(hasattr(cherrypy, 'scheduler'), reason='Required scheduler')
     def test_queue_mail(self):
-        # 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()))
+        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()
 
     def test_html2plaintext(self):
         """

cherrypy_foundation/tests/templates/test_form.html

@@ -0,0 +1,10 @@
+<html>
+    <head>
+        <title>test-form</title>
+    </head>
+    <body>
+        <form method="post" action="/">
+            <Fields form={{ form }} />
+        </form>
+    </body>
+</html>

cherrypy_foundation/tests/test_form.py

@@ -0,0 +1,119 @@
+# CherryPy Foundation
+# 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
+# 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 importlib
+from unittest import skipUnless
+
+import cherrypy
+from cherrypy.test import helper
+from wtforms.fields import BooleanField, PasswordField, StringField, SubmitField
+from wtforms.validators import InputRequired, Length
+
+import cherrypy_foundation.tools.jinja2  # noqa
+from cherrypy_foundation.form import CherryForm
+from cherrypy_foundation.tools.i18n import gettext_lazy as _
+
+HAS_JINJAX = importlib.util.find_spec("jinjax") is not None
+
+env = cherrypy.tools.jinja2.create_env(
+    package_name=__package__,
+    globals={
+        'const1': 'STATIC VALUE',
+    },
+)
+
+
+class LoginForm(CherryForm):
+    login = StringField(
+        _('User'),
+        validators=[
+            InputRequired(),
+            Length(max=256, message=_('User too long.')),
+        ],
+        render_kw={
+            "placeholder": _('User'),
+            "autocorrect": "off",
+            "autocapitalize": "none",
+            "autocomplete": "off",
+            "autofocus": "autofocus",
+        },
+    )
+    password = PasswordField(
+        _('Password'),
+        validators=[
+            InputRequired(),
+            Length(max=256, message=_('Password too long.')),
+        ],
+        render_kw={"placeholder": _("Password")},
+    )
+    persistent = BooleanField(
+        _('Remember me'),
+        # All `label-*` are assigned to the label tag.
+        render_kw={'container_class': 'col-sm-6', 'label-attr': 'FOO'},
+    )
+    submit = SubmitField(
+        _('Login'),
+        # All `container-*` are assigned to the container tag.
+        render_kw={"class": "btn-primary float-end", 'container_class': 'col-sm-6', 'container-attr': 'BAR'},
+    )
+
+
+@cherrypy.tools.jinja2(env=env)
+class Root:
+
+    @cherrypy.expose
+    @cherrypy.tools.jinja2(template='test_form.html')
+    def index(self):
+        form = LoginForm()
+        return {'form': form}
+
+
+@skipUnless(HAS_JINJAX, reason='Required jinjax')
+class FormTest(helper.CPWebCase):
+    default_lang = None
+    interactive = False
+
+    @classmethod
+    def setup_server(cls):
+        cherrypy.tree.mount(Root(), '/')
+
+    def test_get_form(self):
+        # Given a form
+        # When querying the page that include this form
+        self.getPage("/")
+        self.assertStatus(200)
+        # Then each field is render properly.
+        # 1. Check title
+        self.assertInBody('test-form')
+        # 2. Check user field
+        self.assertInBody('<label class="form-label" for="login">User</label>')
+        self.assertInBody(
+            '<input autocapitalize="none" autocomplete="off" autocorrect="off" autofocus="autofocus" class="form-control" id="login" maxlength="256" name="login" placeholder="User" required type="text" value="">'
+        )
+        # 3. Check password
+        self.assertInBody('<label class="form-label" for="password">Password</label>')
+        self.assertInBody(
+            '<input class="form-control" id="password" maxlength="256" name="password" placeholder="Password" required type="password" value="">'
+        )
+        # 4 Check remember me
+        self.assertInBody(
+            '<input class="form-check-input" container-class="col-sm-6" id="persistent" label-attr="FOO" name="persistent" type="checkbox" value="y">'
+        )
+        self.assertInBody('<label attr="FOO" class="form-check-label" for="persistent">Remember me</label>')
+        # 5. check submit button
+        self.assertInBody('<div  attr="BAR" class="mb-2 form-field col-sm-6">')
+        self.assertInBody(
+            '<input class="btn-primary float-end btn" container-attr="BAR" container-class="col-sm-6" id="submit" name="submit" type="submit" value="Login">'
+        )

cherrypy_foundation/tools/auth.py

@@ -29,9 +29,6 @@ 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.
@@ -102,7 +99,12 @@ class AuthManager(cherrypy.Tool):
             try:
                 currentuser = user_from_key_func(user_key)
             except Exception:
-                logger.exception('error while resolving user from key')
+                cherrypy.log(
+                    f'unexpected error searching for user_key={user_key}',
+                    context='AUTH',
+                    severity=logging.ERROR,
+                    traceback=True,
+                )
                 currentuser = None
 
             if currentuser:
@@ -122,7 +124,7 @@ class AuthManager(cherrypy.Tool):
         Validate credentials with configured checkers; on success, call login_with_result.
         """
         if not login or not password:
-            logger.warning('empty login or password provided')
+            cherrypy.log('authentication failed reason=empty_credentials', context='AUTH', severity=logging.WARNING)
             return None
         # Validate credentials using checkpassword function(s).
         conf = self._merged_args()
@@ -143,15 +145,23 @@ 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 as e:
-                logger.exception(
-                    'unexpected error during authentication for [%s] with [%s]: %s', login, func.__qualname__, e
+            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,
                 )
         # If we reach here, authentication failed
         if hasattr(cherrypy.serving, 'session'):
             cherrypy.serving.session.regenerate()  # Prevent session analysis
 
-        logger.warning('Failed login attempt for user=%s from ip=%s', login, cherrypy.serving.request.remote.ip)
+        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,
+        )
 
         return None
 
@@ -166,11 +176,18 @@ class AuthManager(cherrypy.Tool):
         try:
             user_key, userobj = user_lookup_func(login=login, user_info=user_info or {})
         except Exception:
-            logger.exception('failed to lookup user object for login=%s', login)
+            cherrypy.log(
+                f"unexpected error searching user login={login} user_info={user_info}",
+                context='AUTH',
+                severity=logging.ERROR,
+                traceback=True,
+            )
             return None
 
         if not userobj:
-            logger.warning('failed to lookup user object for login=%s', login)
+            cherrypy.log(
+                f"authentication failed login={login} reason=not_found", context='AUTH', severity=logging.WARNING
+            )
             return None
 
         # Notify plugins about user login

cherrypy_foundation/tools/auth_mfa.py

@@ -23,14 +23,12 @@ import cherrypy
 
 from ..passwd import check_password, hash_password
 
-logger = logging.getLogger(__name__)
-
 MFA_CODE = '_auth_mfa_code'
 MFA_CODE_TIME = '_auth_mfa_code_time'
 MFA_CODE_ATTEMPT = '_auth_mfa_code_attempt'
 MFA_REDIRECT_URL = '_auth_mfa_redirect_url'
 MFA_TRUSTED_IP_LIST = '_auth_mfa_trusted_ip_list'
-MFA_USERNAME = '_auth_mfa_username'
+MFA_USER_KEY = '_auth_mfa_user_key'
 MFA_VERIFICATION_TIME = '_auth_mfa_time'
 
 MFA_DEFAULT_CODE_TIMEOUT = 10  # minutes
@@ -86,7 +84,7 @@ class CheckAuthMfa(cherrypy.Tool):
         length = self._code_length()
         code = ''.join(secrets.choice(string.digits) for _ in range(length))
         session = cherrypy.serving.session
-        session[MFA_USERNAME] = cherrypy.request.login
+        session[MFA_USER_KEY] = cherrypy.request.login
         session[MFA_CODE] = hash_password(code)
         session[MFA_CODE_TIME] = session.now()
         session[MFA_CODE_ATTEMPT] = 0
@@ -99,7 +97,7 @@ class CheckAuthMfa(cherrypy.Tool):
 
         # Check if our username match current login user.
         session = cherrypy.serving.session
-        if session.get(MFA_USERNAME) != cherrypy.request.login:
+        if session.get(MFA_USER_KEY) != cherrypy.request.login:
             return False
 
         # Check if the current IP is trusted
@@ -128,7 +126,7 @@ class CheckAuthMfa(cherrypy.Tool):
             return True
 
         session = cherrypy.serving.session
-        if session.get(MFA_USERNAME) != cherrypy.request.login:
+        if session.get(MFA_USER_KEY) != cherrypy.request.login:
             return True
 
         # Check if code is defined.
@@ -208,11 +206,10 @@ class CheckAuthMfa(cherrypy.Tool):
         if is_expired or not code_valid:
             if not is_expired:  # Only increment if not expired
                 session[MFA_CODE_ATTEMPT] = attempts = int(session.get(MFA_CODE_ATTEMPT, 0)) + 1
-            logger.warning(
-                'MFA code verification failed for user=%s from ip=%s, attempt=%d',
-                cherrypy.request.login,
-                cherrypy.request.remote.ip,
-                attempts,
+            cherrypy.log(
+                f'verification failed user={cherrypy.request.login} ip={cherrypy.request.remote.ip} attempts={attempts}',
+                context='MFA',
+                severity=logging.WARNING,
             )
             return False
 
@@ -239,8 +236,8 @@ class CheckAuthMfa(cherrypy.Tool):
 
         # Rotate session id to prevent fixation
         session.regenerate()
-        logger.info(
-            'Successful MFA verification for user=%s from ip=%s', cherrypy.request.login, cherrypy.request.remote.ip
+        cherrypy.log(
+            f'verification successful user={cherrypy.request.login} ip={cherrypy.request.remote.ip}', context='MFA'
         )
         return True
 

cherrypy_foundation/tools/errors.py

@@ -1,4 +1,4 @@
-# udb, A web interface to manage IT network
+# Cherrypy Foundation
 # Copyright (C) 2025 IKUS Software inc.
 #
 # This program is free software: you can redistribute it and/or modify