lodel2_mirror/tests/plugin/tests_hooks.py

# 
# This file is part of Lodel 2 (https://github.com/OpenEdition)
#
# Copyright (C) 2015-2017 Cléo UMS-3287
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#


import unittest
from unittest.mock import MagicMock

from lodel.plugin.plugins import Plugin, PluginError
from lodel.plugin.hooks import LodelHook

testhook = 'are_we_sure_that_this_name_is_uniq'

class HookTestCase(unittest.TestCase):

    def setUp(self):
        LodelHook.__reset__()

    def test_registration(self):
        """ Testing hook registration using decorator (checking using hook_list() """
        hook_list = LodelHook.hook_list(testhook)
        self.assertEqual({}, hook_list)
        #hook_registration
        @LodelHook(testhook,42)
        def funny_fun_test_hook(hook_name, caller, payload):
            pass
        hook_list = LodelHook.hook_list(testhook)
        self.assertEqual({testhook: [(funny_fun_test_hook, 42)]}, hook_list)

    def test_call(self):
        """ Testing LodelHook.call_hook() """
        #manual registration using a mock
        mmock = MagicMock(return_value = '4242')
        mmock.__name__ = 'mmock'
        hooking = LodelHook(testhook, 1337)
        hooking(mmock)
        res = LodelHook.call_hook(testhook, 'Caller', 'payload')
        #Check returned value
        self.assertEqual(
            res,
            '4242',
            'Expected value was "4242" but found %s' % res)
        #Checks call
        mmock.assert_called_once_with(testhook, 'Caller', 'payload')

    def test_priority_call(self):
        """ Testing priority to ensure a call order """
        @LodelHook(testhook, 1)
        def stage_1_hook(name, caller, payload):
            return '4'+payload

        @LodelHook(testhook, 10)
        def stage_1_hook(name, caller, payload):
            return '3'+payload

        @LodelHook(testhook, 20)
        def stage_1_hook(name, caller, payload):
            return '1'+payload

        @LodelHook(testhook, 15)
        def stage_1_hook(name, caller, payload):
            return '2'+payload

        result = LodelHook.call_hook(testhook, 'me', 'WootWoot')
        self.assertEqual(result, '1234WootWoot')