Files
2026-01-26 21:46:12 +08:00

106 lines
4.4 KiB
Python

# Copyright 2016-2017 LasLabs Inc.
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
import time
from contextlib import contextmanager
from unittest import mock
from odoo.tests.common import TransactionCase
from odoo.tools.misc import mute_logger
class EndTestException(Exception):
"""It stops tests from continuing"""
class TestResUsers(TransactionCase):
def setUp(self):
super().setUp()
self.ResUsers = self.env["res.users"]
@contextmanager
def _mock_assets(self, assets=None):
"""It provides mocked imports from res_users.py
:param assets: (list) Name of imports to mock. Mocks `http` if None
:return: (dict) Dictionary of mocks, keyed by module name
"""
if assets is None:
assets = ["http"]
patches = {name: mock.DEFAULT for name in assets}
with mock.patch.multiple(
"odoo.addons.auth_session_timeout.models.res_users", **patches
) as mocks:
yield mocks
def _auth_timeout_check(self, http_mock):
"""It wraps ``_auth_timeout_check`` for easier calling"""
self.db = mock.MagicMock()
self.uid = mock.MagicMock()
self.passwd = mock.MagicMock()
self.path = "/this/is/a/test/path"
get_filename = http_mock.root.session_store.get_session_filename
get_filename.return_value = self.path
return self.ResUsers._auth_timeout_check()
def test_session_validity_no_request(self):
"""It should return immediately if no request"""
with self._mock_assets() as assets:
assets["http"].request = False
res = self._auth_timeout_check(assets["http"])
self.assertFalse(res)
def test_session_validity_gets_session_file(self):
"""It should call get the session file for the session id"""
with self._mock_assets() as assets:
get_params = assets["http"].request.env[""].get_session_parameters
get_params.return_value = 0, []
store = assets["http"].root.session_store
store.get_session_filename.side_effect = EndTestException
with self.assertRaises(EndTestException):
self._auth_timeout_check(assets["http"])
store.get_session_filename.assert_called_once_with(
assets["http"].request.session.sid,
)
def test_session_validity_logout(self):
"""It should log out of session if past deadline"""
with self._mock_assets(["http", "getmtime", "utime"]) as assets:
get_params = assets["http"].request.env[""].get_session_parameters
get_params.return_value = -9999, []
assets["getmtime"].return_value = 0
self._auth_timeout_check(assets["http"])
assets["http"].request.session.logout.assert_called_once_with(
keep_db=True,
)
def test_session_validity_updates_utime(self):
"""It should update utime of session file if not expired"""
with self._mock_assets(["http", "getmtime", "utime"]) as assets:
get_params = assets["http"].request.env[""].get_session_parameters
get_params.return_value = 9999, []
assets["getmtime"].return_value = time.time()
self._auth_timeout_check(assets["http"])
assets["utime"].assert_called_once_with(
assets["http"].root.session_store.get_session_filename(),
None,
)
@mute_logger("odoo.addons.auth_session_timeout.models.res_users")
def test_session_validity_os_error_guard(self):
"""It should properly guard from OSError & return"""
with self._mock_assets(["http", "utime", "getmtime"]) as assets:
get_params = assets["http"].request.env[""].get_session_parameters
get_params.return_value = 0, []
assets["getmtime"].side_effect = OSError
self._auth_timeout_check(assets["http"])
def test_on_timeout_session_loggedout(self):
with self._mock_assets(["http", "getmtime"]) as assets:
assets["getmtime"].return_value = 0
assets["http"].request.session.uid = self.env.uid
assets["http"].request.session.dbname = self.env.cr.dbname
assets["http"].request.session.sid = 123
assets["http"].request.session.logout = mock.Mock()
self.ResUsers._auth_timeout_check()
self.assertTrue(assets["http"].request.session.logout.called)