PyPI - cherrypy-foundation - Versions diffs - 1.0.0__py3-none-any.whl - Mend

cherrypy-foundation 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (136) hide show

cherrypy_foundation/plugins/tests/test_smtp.py ADDED Viewed

@@ -0,0 +1,140 @@
+# SMTP Plugins for cherrypy
+# Copyright (C) 2022-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/>.
+from unittest import mock, skipUnless
+import cherrypy
+from cherrypy.test import helper
+from parameterized import parameterized
+from .. import smtp  # noqa
+class SmtpPluginTest(helper.CPWebCase):
+    @classmethod
+    def setup_server(cls):
+        cherrypy.config.update(
+            {
+                'smtp.server': '__default__',
+                'smtp.username': 'username',
+                'smtp.password': 'password',
+                'smtp.email_from': 'Test <email_from@test.com>',
+            }
+        )
+    def test_send_mail(self):
+        # Given a valid smtp server
+        with mock.patch(smtp.__name__ + '.smtplib') as smtplib:
+            # When publishing a send_mail
+            cherrypy.engine.publish('send_mail', to='target@test.com', subject='subjet', message='body')
+            # 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_send_mail_with_to_tuple(self):
+        # Given a valid smtp server
+        with mock.patch(smtp.__name__ + '.smtplib') as smtplib:
+            # When publishing a send_mail
+            cherrypy.engine.publish(
+                'send_mail',
+                to=('A name', 'target@test.com'),
+                subject='subjet',
+                message='body',
+                bcc=('A bcc name', 'bcc@test.com'),
+                reply_to=('A Reply Name', 'replyto@test.com'),
+            )
+            # 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()
+    @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()
+    def test_html2plaintext(self):
+        """
+        Check if this convertion is working fine.
+        """
+        html = """<html>
+  <head>
+    <style type="text/css">
+      body { font-family:Helvetica; }
+    </style>
+  </head>
+  <body>
+    <h1>Hi!</h1>
+    <p id="test"
+        class="mb-2 text-center">
+      How are you?<br/>
+      Here&#160;is the <a href="https://www.python.org">link</a> you wanted.
+    </p>
+  </body>
+</html>
+"""
+        expected = """**Hi!**
+How are you?
+Here is the link [1] you wanted.
+[1] https://www.python.org"""
+        self.assertEqual(expected, smtp._html2plaintext(html))
+    def test_formataddr(self):
+        self.assertEqual('test@test.com', smtp._formataddr('test@test.com'))
+        self.assertEqual('TEST <test@test.com>', smtp._formataddr(('TEST', 'test@test.com')))
+        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/sessions.py ADDED Viewed

@@ -0,0 +1,93 @@
+# Cherrypy-foundation
+# Copyright (C) 2025-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 logging
+import os
+import time
+from contextlib import contextmanager
+import cherrypy
+import zc.lockfile
+from cherrypy.lib import locking
+from cherrypy.lib.sessions import FileSession as CPFileSession
+class FileSession(CPFileSession):
+    """
+    Override implementation of cherrpy file session to improve file locking.
+    """
+    def acquire_lock(self, path=None):
+        """Acquire an exclusive lock on the currently-loaded session data."""
+        # See Issue https://github.com/cherrypy/cherrypy/issues/2065
+        if path is None:
+            path = self._get_file_path()
+        path += self.LOCK_SUFFIX
+        checker = locking.LockChecker(self.id, self.lock_timeout)
+        while not checker.expired():
+            try:
+                self.lock = zc.lockfile.LockFile(path)
+            except zc.lockfile.LockError:
+                # Sleep for 1ms only.
+                time.sleep(0.001)
+            else:
+                break
+        self.locked = True
+        if self.debug:
+            cherrypy.log('Lock acquired.', 'TOOLS.SESSIONS')
+    def clean_up(self):
+        """Also clean-up left over lock files."""
+        # See Issue https://github.com/cherrypy/cherrypy/issues/1855
+        # Clean-up session files.
+        CPFileSession.clean_up(self)
+        # Then clean-up any orphane lock files.
+        suffix_len = len(self.LOCK_SUFFIX)
+        files = os.listdir(self.storage_path)
+        lock_files = [
+            fname for fname in files if fname.startswith(self.SESSION_PREFIX) and fname.endswith(self.LOCK_SUFFIX)
+        ]
+        for fname in lock_files:
+            session_file = fname[:-suffix_len]
+            if session_file not in files:
+                filepath = os.path.join(self.storage_path, fname)
+                try:
+                    os.unlink(filepath)
+                except Exception as e:
+                    cherrypy.log(f'Error deleting {filepath}: {e}', 'TOOLS.SESSIONS', severity=logging.WARNING)
+@contextmanager
+def session_lock():
+    """
+    Acquire session lock as required. Support re-intrant lock.
+    """
+    s = cherrypy.serving.session
+    if s.locking == 'explicit' and not s.locked:
+        s.acquire_lock()
+        try:
+            yield s
+        finally:
+            # When explicit, we want to save the session (with also release the lock.)
+            if s.locking == 'explicit':
+                s.save()
+                cherrypy.serving.request._sessionsaved = True
+    else:
+        yield s

cherrypy_foundation/tests/__init__.py ADDED Viewed

@@ -0,0 +1,72 @@
+# 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/templates/test_flash.html ADDED Viewed

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <title>test-flash</title>
+    </head>
+    <body>
+        <Flash messages={{ get_flashed_messages() }} class="mb-2" style="min-height:100px"/>
+    </body>
+</html>

cherrypy_foundation/tests/templates/test_form.html ADDED Viewed

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <title>test-form</title>
+    </head>
+    <body>
+        {% if form.error_message %}
+        <p>
+            {{ form.error_message }}
+        </p>
+        {% endif %}
+        <form method="post" action="/">
+            <Fields form={{ form }} />
+        </form>
+    </body>
+</html>

cherrypy_foundation/tests/templates/test_url.html ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <title>test-url</title>
+    </head>
+    <body>
+        Empty: {{ url_for("", **kwargs) }}<br/>
+        Dot: {{ url_for(".", **kwargs) }}<br/>
+        Dot page: {{ url_for(".", "my-page", **kwargs) }}<br/>
+        Slash: {{ url_for("/", **kwargs) }}<br/>
+        Page: {{ url_for("my-page", **kwargs) }}<br/>
+        Slash page: {{ url_for("/my-page", **kwargs) }}<br/>
+        Query: {{ url_for("my-page", foo='1', bar='test with space', **kwargs) }}<br/>
+    </body>
+</html>

cherrypy_foundation/tests/test_error_page.py ADDED Viewed

@@ -0,0 +1,78 @@
+# CherryPy
+# 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 cherrypy
+from cherrypy.test import helper
+from parameterized import parameterized
+from ..error_page import error_page
+class Root:
+    @cherrypy.expose
+    def index(self):
+        return "OK"
+    @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
+    def html_error(self):
+        raise cherrypy.HTTPError(400, message='My error message')
+    @cherrypy.expose
+    @cherrypy.tools.json_out()
+    def json_error(self):
+        raise cherrypy.HTTPError(400, message='json error message')
+    @cherrypy.expose
+    @cherrypy.tools.response_headers(headers=[('Content-Type', 'text/plain')])
+    def text_error(self):
+        raise cherrypy.HTTPError(400, message='text error message')
+class ErrorPageTest(helper.CPWebCase):
+    interactive = False
+    @classmethod
+    def setup_server(cls):
+        cherrypy.config.update(
+            {
+                'error_page.default': error_page,
+            }
+        )
+        cherrypy.tree.mount(Root(), '/')
+    @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'),
+        ]
+    )
+    def test_error_page(self, page, expect_body):
+        # When query return an error
+        self.getPage(page)
+        # then error page adjust the content
+        self.assertInBody(expect_body)

cherrypy_foundation/tests/test_flash.py ADDED Viewed

@@ -0,0 +1,61 @@
+# 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 importlib
+from unittest import skipUnless
+import cherrypy
+from cherrypy.test import helper
+import cherrypy_foundation.tools.jinja2  # noqa
+from cherrypy_foundation.flash import flash, get_flashed_messages
+HAS_JINJAX = importlib.util.find_spec("jinjax") is not None
+env = cherrypy.tools.jinja2.create_env(
+    package_name=__package__,
+    globals={'get_flashed_messages': get_flashed_messages},
+)
+@cherrypy.tools.sessions(locking='explicit')
+@cherrypy.tools.jinja2(env=env)
+class Root:
+    @cherrypy.expose
+    @cherrypy.tools.jinja2(template='test_flash.html')
+    def index(self):
+        flash('default flash message', level='info')
+        return {}
+@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_flash(self):
+        # Given a page returning a flash message
+        # When querying the page that include this form
+        self.getPage("/")
+        self.assertStatus(200)
+        # Then page display the message.
+        self.assertInBody('test-flash')
+        self.assertInBody('<div class="alert alert-info alert-dismissible fade show"')
+        self.assertInBody('default flash message')

cherrypy_foundation/tests/test_form.py ADDED Viewed

@@ -0,0 +1,148 @@
+# 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 importlib
+from unittest import skipUnless
+from urllib.parse import urlencode
+import cherrypy
+from cherrypy.test import helper
+from parameterized import parameterized
+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__,
+)
+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.sessions()
+@cherrypy.tools.jinja2(env=env)
+class Root:
+    @cherrypy.expose
+    def index(self, **kwargs):
+        if 'login' not in cherrypy.session:
+            raise cherrypy.HTTPRedirect('/login')
+        return 'OK'
+    @cherrypy.expose
+    @cherrypy.tools.jinja2(template='test_form.html')
+    def login(self, **kwargs):
+        form = LoginForm()
+        if form.validate_on_submit():
+            # login user with cherrypy.tools.auth
+            cherrypy.session['login'] = True
+            raise cherrypy.HTTPRedirect('/')
+        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("/login")
+        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 (regex matches because class could have different order with jinjax<=0.57)
+        self.assertInBody('<div  attr="BAR"')
+        self.assertMatchesBody(
+            '<input class="(btn-primary ?|float-end ?|btn ?){3}" container-attr="BAR" container-class="col-sm-6" id="submit" name="submit" type="submit" value="Login">'
+        )
+    @parameterized.expand(
+        [
+            ('myuser', 'mypassword', 0, 303, False),
+            ('myuser', '', 0, 200, 'Password: This field is required.'),
+            ('', 'mypassword', 0, 200, 'User: This field is required.'),
+        ]
+    )
+    def test_post_form(self, login, password, persistent, expect_status, expect_error):
+        # Given a page with a form.
+        # When data is sent to the form.
+        self.getPage(
+            "/login", method='POST', body=urlencode({'login': login, 'password': password, 'persistent': persistent})
+        )
+        # Then page return a status
+        self.assertStatus(expect_status)
+        # Then page may return an error
+        if expect_error:
+            self.assertInBody(expect_error)