Change hooks control (deny_all_hooks_but / allow_all_hooks_but) to be more predictable
Prior to this, if one execute code like:
with cnx.hooks.deny_all_hooks_but('metadata'):
with cnx.hooks.deny_all_hooks_but():
# mycode
'metadata' hooks will be activated anyway in the inner block, which is rather
unexpected (of course in real life you only see the latest hooks control
statement, the former being higher in the call stack). This is due to the
underlying usage of old `enable_hook_categories` / `disable_hook_categories`
methods, which were introduced much before the now official context manager
based API (with `cnx.[deny|all]_all_hooks_but(...)`).
To move on, this patch drop the two legacy methods, rename and privatize related
internal state on the connection (`hooks_mode` becomes `_hooks_mode`,
`disabled_hook_cats` and `enabled_hook_cats` become `_hooks_categories`) and
reimplement the `_hooks_control` context manager to simply update them.
See the added unit test for details.
# copyright 2017 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of CubicWeb.
#
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
# CubicWeb 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 Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>.
from cubicweb.devtools.testlib import CubicWebTC
from cubicweb.server import session
class HooksControlTC(CubicWebTC):
def test_hooks_control(self):
with self.admin_access.repo_cnx() as cnx:
self.assertEqual(cnx._hooks_mode, session.HOOKS_ALLOW_ALL)
self.assertEqual(cnx._hooks_categories, set())
with cnx.deny_all_hooks_but('metadata'):
self.assertEqual(cnx._hooks_mode, session.HOOKS_DENY_ALL)
self.assertEqual(cnx._hooks_categories, set(['metadata']))
with cnx.deny_all_hooks_but():
self.assertEqual(cnx._hooks_categories, set())
self.assertEqual(cnx._hooks_categories, set(['metadata']))
with cnx.deny_all_hooks_but('integrity'):
self.assertEqual(cnx._hooks_categories, set(['integrity']))
self.assertEqual(cnx._hooks_categories, set(['metadata']))
with cnx.allow_all_hooks_but('integrity'):
self.assertEqual(cnx._hooks_mode, session.HOOKS_ALLOW_ALL)
self.assertEqual(cnx._hooks_categories, set(['integrity']))
self.assertEqual(cnx._hooks_mode, session.HOOKS_DENY_ALL)
self.assertEqual(cnx._hooks_categories, set(['metadata']))
self.assertEqual(cnx._hooks_mode, session.HOOKS_ALLOW_ALL)
self.assertEqual(cnx._hooks_categories, set())
if __name__ == '__main__':
import unittest
unittest.main()