Chris@1494: # Redmine - project management software
Chris@1494: # Copyright (C) 2006-2014  Jean-Philippe Lang
Chris@1494: #
Chris@1494: # This program is free software; you can redistribute it and/or
Chris@1494: # modify it under the terms of the GNU General Public License
Chris@1494: # as published by the Free Software Foundation; either version 2
Chris@1494: # of the License, or (at your option) any later version.
Chris@1494: #
Chris@1494: # This program is distributed in the hope that it will be useful,
Chris@1494: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1494: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1494: # GNU General Public License for more details.
Chris@1494: #
Chris@1494: # You should have received a copy of the GNU General Public License
Chris@1494: # along with this program; if not, write to the Free Software
Chris@1494: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1494: 
Chris@1494: require File.expand_path('../../../../test_helper', __FILE__)
Chris@1494: 
Chris@1494: class Redmine::Hook::ManagerTest < ActionView::TestCase
Chris@1494:   fixtures :projects, :users, :members, :member_roles, :roles,
Chris@1494:            :groups_users,
Chris@1494:            :trackers, :projects_trackers,
Chris@1494:            :enabled_modules,
Chris@1494:            :versions,
Chris@1494:            :issue_statuses, :issue_categories, :issue_relations,
Chris@1494:            :enumerations,
Chris@1494:            :issues
Chris@1494: 
Chris@1494:   # Some hooks that are manually registered in these tests
Chris@1494:   class TestHook < Redmine::Hook::ViewListener; end
Chris@1494: 
Chris@1494:   class TestHook1 < TestHook
Chris@1494:     def view_layouts_base_html_head(context)
Chris@1494:       'Test hook 1 listener.'
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   class TestHook2 < TestHook
Chris@1494:     def view_layouts_base_html_head(context)
Chris@1494:       'Test hook 2 listener.'
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   class TestHook3 < TestHook
Chris@1494:     def view_layouts_base_html_head(context)
Chris@1494:       "Context keys: #{context.keys.collect(&:to_s).sort.join(', ')}."
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   class TestLinkToHook < TestHook
Chris@1494:     def view_layouts_base_html_head(context)
Chris@1494:       link_to('Issues', :controller => 'issues')
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   class TestHookHelperController < ActionController::Base
Chris@1494:     include Redmine::Hook::Helper
Chris@1494:   end
Chris@1494: 
Chris@1494:   class TestHookHelperView < ActionView::Base
Chris@1494:     include Redmine::Hook::Helper
Chris@1494:   end
Chris@1494: 
Chris@1494:   Redmine::Hook.clear_listeners
Chris@1494: 
Chris@1494:   def setup
Chris@1494:     @hook_module = Redmine::Hook
Chris@1494:   end
Chris@1494: 
Chris@1494:   def teardown
Chris@1494:     @hook_module.clear_listeners
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_clear_listeners
Chris@1494:     assert_equal 0, @hook_module.hook_listeners(:view_layouts_base_html_head).size
Chris@1494:     @hook_module.add_listener(TestHook1)
Chris@1494:     @hook_module.add_listener(TestHook2)
Chris@1494:     assert_equal 2, @hook_module.hook_listeners(:view_layouts_base_html_head).size
Chris@1494: 
Chris@1494:     @hook_module.clear_listeners
Chris@1494:     assert_equal 0, @hook_module.hook_listeners(:view_layouts_base_html_head).size
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_add_listener
Chris@1494:     assert_equal 0, @hook_module.hook_listeners(:view_layouts_base_html_head).size
Chris@1494:     @hook_module.add_listener(TestHook1)
Chris@1494:     assert_equal 1, @hook_module.hook_listeners(:view_layouts_base_html_head).size
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook
Chris@1494:     @hook_module.add_listener(TestHook1)
Chris@1494:     assert_equal ['Test hook 1 listener.'], hook_helper.call_hook(:view_layouts_base_html_head)
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook_with_context
Chris@1494:     @hook_module.add_listener(TestHook3)
Chris@1494:     assert_equal ['Context keys: bar, controller, foo, hook_caller, project, request.'],
Chris@1494:                  hook_helper.call_hook(:view_layouts_base_html_head, :foo => 1, :bar => 'a')
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook_with_multiple_listeners
Chris@1494:     @hook_module.add_listener(TestHook1)
Chris@1494:     @hook_module.add_listener(TestHook2)
Chris@1494:     assert_equal ['Test hook 1 listener.', 'Test hook 2 listener.'], hook_helper.call_hook(:view_layouts_base_html_head)
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Context: Redmine::Hook::Helper.call_hook default_url
Chris@1494:   def test_call_hook_default_url_options
Chris@1494:     @hook_module.add_listener(TestLinkToHook)
Chris@1494: 
Chris@1494:     assert_equal ['<a href="/issues">Issues</a>'], hook_helper.call_hook(:view_layouts_base_html_head)
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Context: Redmine::Hook::Helper.call_hook
Chris@1494:   def test_call_hook_with_project_added_to_context
Chris@1494:     @hook_module.add_listener(TestHook3)
Chris@1494:     assert_match /project/i, hook_helper.call_hook(:view_layouts_base_html_head)[0]
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook_from_controller_with_controller_added_to_context
Chris@1494:     @hook_module.add_listener(TestHook3)
Chris@1494:     assert_match /controller/i, hook_helper.call_hook(:view_layouts_base_html_head)[0]
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook_from_controller_with_request_added_to_context
Chris@1494:     @hook_module.add_listener(TestHook3)
Chris@1494:     assert_match /request/i, hook_helper.call_hook(:view_layouts_base_html_head)[0]
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook_from_view_with_project_added_to_context
Chris@1494:     @hook_module.add_listener(TestHook3)
Chris@1494:     assert_match /project/i, view_hook_helper.call_hook(:view_layouts_base_html_head)
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook_from_view_with_controller_added_to_context
Chris@1494:     @hook_module.add_listener(TestHook3)
Chris@1494:     assert_match /controller/i, view_hook_helper.call_hook(:view_layouts_base_html_head)
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook_from_view_with_request_added_to_context
Chris@1494:     @hook_module.add_listener(TestHook3)
Chris@1494:     assert_match /request/i, view_hook_helper.call_hook(:view_layouts_base_html_head)
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook_from_view_should_join_responses_with_a_space
Chris@1494:     @hook_module.add_listener(TestHook1)
Chris@1494:     @hook_module.add_listener(TestHook2)
Chris@1494:     assert_equal 'Test hook 1 listener. Test hook 2 listener.',
Chris@1494:                  view_hook_helper.call_hook(:view_layouts_base_html_head)
Chris@1494:   end
Chris@1494: 
Chris@1494:   def test_call_hook_should_not_change_the_default_url_for_email_notifications
Chris@1494:     issue = Issue.find(1)
Chris@1494: 
Chris@1494:     ActionMailer::Base.deliveries.clear
Chris@1494:     Mailer.deliver_issue_add(issue)
Chris@1494:     mail = ActionMailer::Base.deliveries.last
Chris@1494: 
Chris@1494:     @hook_module.add_listener(TestLinkToHook)
Chris@1494:     hook_helper.call_hook(:view_layouts_base_html_head)
Chris@1494: 
Chris@1494:     ActionMailer::Base.deliveries.clear
Chris@1494:     Mailer.deliver_issue_add(issue)
Chris@1494:     mail2 = ActionMailer::Base.deliveries.last
Chris@1494: 
Chris@1494:     assert_equal mail_body(mail), mail_body(mail2)
Chris@1494:   end
Chris@1494: 
Chris@1494:   def hook_helper
Chris@1494:     @hook_helper ||= TestHookHelperController.new
Chris@1494:   end
Chris@1494: 
Chris@1494:   def view_hook_helper
Chris@1494:     @view_hook_helper ||= TestHookHelperView.new(Rails.root.to_s + '/app/views')
Chris@1494:   end
Chris@1494: end
Chris@1494: