Chris@1517: # Redmine - project management software
Chris@1517: # Copyright (C) 2006-2014  Jean-Philippe Lang
Chris@1517: #
Chris@1517: # This program is free software; you can redistribute it and/or
Chris@1517: # modify it under the terms of the GNU General Public License
Chris@1517: # as published by the Free Software Foundation; either version 2
Chris@1517: # of the License, or (at your option) any later version.
Chris@1517: #
Chris@1517: # This program is distributed in the hope that it will be useful,
Chris@1517: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1517: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1517: # GNU General Public License for more details.
Chris@1517: #
Chris@1517: # You should have received a copy of the GNU General Public License
Chris@1517: # along with this program; if not, write to the Free Software
Chris@1517: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1517: 
Chris@1517: require File.expand_path('../../test_helper', __FILE__)
Chris@1517: 
Chris@1517: class IssuesCustomFieldsVisibilityTest < ActionController::TestCase
Chris@1517:   tests IssuesController
Chris@1517:   fixtures :projects,
Chris@1517:            :users,
Chris@1517:            :roles,
Chris@1517:            :members,
Chris@1517:            :member_roles,
Chris@1517:            :issue_statuses,
Chris@1517:            :trackers,
Chris@1517:            :projects_trackers,
Chris@1517:            :enabled_modules,
Chris@1517:            :enumerations,
Chris@1517:            :workflows
Chris@1517: 
Chris@1517:   def setup
Chris@1517:     CustomField.delete_all
Chris@1517:     Issue.delete_all
Chris@1517:     field_attributes = {:field_format => 'string', :is_for_all => true, :is_filter => true, :trackers => Tracker.all}
Chris@1517:     @fields = []
Chris@1517:     @fields << (@field1 = IssueCustomField.create!(field_attributes.merge(:name => 'Field 1', :visible => true)))
Chris@1517:     @fields << (@field2 = IssueCustomField.create!(field_attributes.merge(:name => 'Field 2', :visible => false, :role_ids => [1, 2])))
Chris@1517:     @fields << (@field3 = IssueCustomField.create!(field_attributes.merge(:name => 'Field 3', :visible => false, :role_ids => [1, 3])))
Chris@1517:     @issue = Issue.generate!(
Chris@1517:       :author_id => 1,
Chris@1517:       :project_id => 1,
Chris@1517:       :tracker_id => 1,
Chris@1517:       :custom_field_values => {@field1.id => 'Value0', @field2.id => 'Value1', @field3.id => 'Value2'}
Chris@1517:     )
Chris@1517: 
Chris@1517:     @user_with_role_on_other_project = User.generate!
Chris@1517:     User.add_to_project(@user_with_role_on_other_project, Project.find(2), Role.find(3))
Chris@1517: 
Chris@1517:     @users_to_test = {
Chris@1517:       User.find(1) => [@field1, @field2, @field3],
Chris@1517:       User.find(3) => [@field1, @field2],
Chris@1517:       @user_with_role_on_other_project => [@field1], # should see field1 only on Project 1
Chris@1517:       User.generate! => [@field1],
Chris@1517:       User.anonymous => [@field1]
Chris@1517:     }
Chris@1517: 
Chris@1517:     Member.where(:project_id => 1).each do |member|
Chris@1517:       member.destroy unless @users_to_test.keys.include?(member.principal)
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_show_should_show_visible_custom_fields_only
Chris@1517:     @users_to_test.each do |user, fields|
Chris@1517:       @request.session[:user_id] = user.id
Chris@1517:       get :show, :id => @issue.id
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_select 'td', {:text => "Value#{i}", :count => 1}, "User #{user.id} was not able to view #{field.name}"
Chris@1517:         else
Chris@1517:           assert_select 'td', {:text => "Value#{i}", :count => 0}, "User #{user.id} was able to view #{field.name}"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_show_should_show_visible_custom_fields_only_in_api
Chris@1517:     @users_to_test.each do |user, fields|
Chris@1517:       with_settings :rest_api_enabled => '1' do
Chris@1517:         get :show, :id => @issue.id, :format => 'xml', :include => 'custom_fields', :key => user.api_key
Chris@1517:       end
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_select "custom_field[id=#{field.id}] value", {:text => "Value#{i}", :count => 1}, "User #{user.id} was not able to view #{field.name} in API"
Chris@1517:         else
Chris@1517:           assert_select "custom_field[id=#{field.id}] value", {:text => "Value#{i}", :count => 0}, "User #{user.id} was not able to view #{field.name} in API"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_show_should_show_visible_custom_fields_only_in_history
Chris@1517:     @issue.init_journal(User.find(1))
Chris@1517:     @issue.custom_field_values = {@field1.id => 'NewValue0', @field2.id => 'NewValue1', @field3.id => 'NewValue2'}
Chris@1517:     @issue.save!
Chris@1517: 
Chris@1517:     @users_to_test.each do |user, fields|
Chris@1517:       @request.session[:user_id] = user.id
Chris@1517:       get :show, :id => @issue.id
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_select 'ul.details i', {:text => "Value#{i}", :count => 1}, "User #{user.id} was not able to view #{field.name} change"
Chris@1517:         else
Chris@1517:           assert_select 'ul.details i', {:text => "Value#{i}", :count => 0}, "User #{user.id} was able to view #{field.name} change"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_show_should_show_visible_custom_fields_only_in_history_api
Chris@1517:     @issue.init_journal(User.find(1))
Chris@1517:     @issue.custom_field_values = {@field1.id => 'NewValue0', @field2.id => 'NewValue1', @field3.id => 'NewValue2'}
Chris@1517:     @issue.save!
Chris@1517: 
Chris@1517:     @users_to_test.each do |user, fields|
Chris@1517:       with_settings :rest_api_enabled => '1' do
Chris@1517:         get :show, :id => @issue.id, :format => 'xml', :include => 'journals', :key => user.api_key
Chris@1517:       end
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_select 'details old_value', {:text => "Value#{i}", :count => 1}, "User #{user.id} was not able to view #{field.name} change in API"
Chris@1517:         else
Chris@1517:           assert_select 'details old_value', {:text => "Value#{i}", :count => 0}, "User #{user.id} was able to view #{field.name} change in API"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_edit_should_show_visible_custom_fields_only
Chris@1517:     Role.anonymous.add_permission! :edit_issues
Chris@1517: 
Chris@1517:     @users_to_test.each do |user, fields|
Chris@1517:       @request.session[:user_id] = user.id
Chris@1517:       get :edit, :id => @issue.id
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_select 'input[value=?]', "Value#{i}", 1, "User #{user.id} was not able to edit #{field.name}"
Chris@1517:         else
Chris@1517:           assert_select 'input[value=?]', "Value#{i}", 0, "User #{user.id} was able to edit #{field.name}"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_update_should_update_visible_custom_fields_only
Chris@1517:     Role.anonymous.add_permission! :edit_issues
Chris@1517: 
Chris@1517:     @users_to_test.each do |user, fields|
Chris@1517:       @request.session[:user_id] = user.id
Chris@1517:       put :update, :id => @issue.id,
Chris@1517:         :issue => {:custom_field_values => {
Chris@1517:           @field1.id.to_s => "User#{user.id}Value0",
Chris@1517:           @field2.id.to_s => "User#{user.id}Value1",
Chris@1517:           @field3.id.to_s => "User#{user.id}Value2",
Chris@1517:         }}
Chris@1517:       @issue.reload
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_equal "User#{user.id}Value#{i}", @issue.custom_field_value(field), "User #{user.id} was not able to update #{field.name}"
Chris@1517:         else
Chris@1517:           assert_not_equal "User#{user.id}Value#{i}", @issue.custom_field_value(field), "User #{user.id} was able to update #{field.name}"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_index_should_show_visible_custom_fields_only
Chris@1517:     @users_to_test.each do |user, fields|
Chris@1517:       @request.session[:user_id] = user.id
Chris@1517:       get :index, :c => (["subject"] + @fields.map{|f| "cf_#{f.id}"})
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_select 'td', {:text => "Value#{i}", :count => 1}, "User #{user.id} was not able to view #{field.name}"
Chris@1517:         else
Chris@1517:           assert_select 'td', {:text => "Value#{i}", :count => 0}, "User #{user.id} was able to view #{field.name}"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_index_as_csv_should_show_visible_custom_fields_only
Chris@1517:     @users_to_test.each do |user, fields|
Chris@1517:       @request.session[:user_id] = user.id
Chris@1517:       get :index, :c => (["subject"] + @fields.map{|f| "cf_#{f.id}"}), :format => 'csv'
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_include "Value#{i}", response.body, "User #{user.id} was not able to view #{field.name} in CSV"
Chris@1517:         else
Chris@1517:           assert_not_include "Value#{i}", response.body, "User #{user.id} was able to view #{field.name} in CSV"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_index_with_partial_custom_field_visibility
Chris@1517:     Issue.delete_all
Chris@1517:     p1 = Project.generate!
Chris@1517:     p2 = Project.generate!
Chris@1517:     user = User.generate!
Chris@1517:     User.add_to_project(user, p1, Role.where(:id => [1, 3]).all)
Chris@1517:     User.add_to_project(user, p2, Role.where(:id => 3).all)
Chris@1517:     Issue.generate!(:project => p1, :tracker_id => 1, :custom_field_values => {@field2.id => 'ValueA'})
Chris@1517:     Issue.generate!(:project => p2, :tracker_id => 1, :custom_field_values => {@field2.id => 'ValueB'})
Chris@1517:     Issue.generate!(:project => p1, :tracker_id => 1, :custom_field_values => {@field2.id => 'ValueC'})
Chris@1517: 
Chris@1517:     @request.session[:user_id] = user.id
Chris@1517:     get :index, :c => ["subject", "cf_#{@field2.id}"]
Chris@1517:     assert_select 'td', :text => 'ValueA'
Chris@1517:     assert_select 'td', :text => 'ValueB', :count => 0
Chris@1517:     assert_select 'td', :text => 'ValueC'
Chris@1517: 
Chris@1517:     get :index, :sort => "cf_#{@field2.id}"
Chris@1517:     # ValueB is not visible to user and ignored while sorting
Chris@1517:     assert_equal %w(ValueB ValueA ValueC), assigns(:issues).map{|i| i.custom_field_value(@field2)}
Chris@1517: 
Chris@1517:     get :index, :set_filter => '1', "cf_#{@field2.id}" => '*'
Chris@1517:     assert_equal %w(ValueA ValueC), assigns(:issues).map{|i| i.custom_field_value(@field2)}
Chris@1517: 
Chris@1517:     CustomField.update_all(:field_format => 'list')
Chris@1517:     get :index, :group => "cf_#{@field2.id}"
Chris@1517:     assert_equal %w(ValueA ValueC), assigns(:issues).map{|i| i.custom_field_value(@field2)}
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_create_should_send_notifications_according_custom_fields_visibility
Chris@1517:     # anonymous user is never notified
Chris@1517:     users_to_test = @users_to_test.reject {|k,v| k.anonymous?}
Chris@1517: 
Chris@1517:     ActionMailer::Base.deliveries.clear
Chris@1517:     @request.session[:user_id] = 1
Chris@1517:     with_settings :bcc_recipients => '1' do
Chris@1517:       assert_difference 'Issue.count' do
Chris@1517:         post :create,
Chris@1517:           :project_id => 1,
Chris@1517:           :issue => {
Chris@1517:             :tracker_id => 1,
Chris@1517:             :status_id => 1,
Chris@1517:             :subject => 'New issue',
Chris@1517:             :priority_id => 5,
Chris@1517:             :custom_field_values => {@field1.id.to_s => 'Value0', @field2.id.to_s => 'Value1', @field3.id.to_s => 'Value2'},
Chris@1517:             :watcher_user_ids => users_to_test.keys.map(&:id)
Chris@1517:           }
Chris@1517:         assert_response 302
Chris@1517:       end
Chris@1517:     end
Chris@1517:     assert_equal users_to_test.values.uniq.size, ActionMailer::Base.deliveries.size
Chris@1517:     # tests that each user receives 1 email with the custom fields he is allowed to see only
Chris@1517:     users_to_test.each do |user, fields|
Chris@1517:       mails = ActionMailer::Base.deliveries.select {|m| m.bcc.include? user.mail}
Chris@1517:       assert_equal 1, mails.size
Chris@1517:       mail = mails.first
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_mail_body_match "Value#{i}", mail, "User #{user.id} was not able to view #{field.name} in notification"
Chris@1517:         else
Chris@1517:           assert_mail_body_no_match "Value#{i}", mail, "User #{user.id} was able to view #{field.name} in notification"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_update_should_send_notifications_according_custom_fields_visibility
Chris@1517:     # anonymous user is never notified
Chris@1517:     users_to_test = @users_to_test.reject {|k,v| k.anonymous?}
Chris@1517: 
Chris@1517:     users_to_test.keys.each do |user|
Chris@1517:       Watcher.create!(:user => user, :watchable => @issue)
Chris@1517:     end
Chris@1517:     ActionMailer::Base.deliveries.clear
Chris@1517:     @request.session[:user_id] = 1
Chris@1517:     with_settings :bcc_recipients => '1' do
Chris@1517:       put :update,
Chris@1517:         :id => @issue.id,
Chris@1517:         :issue => {
Chris@1517:           :custom_field_values => {@field1.id.to_s => 'NewValue0', @field2.id.to_s => 'NewValue1', @field3.id.to_s => 'NewValue2'}
Chris@1517:         }
Chris@1517:       assert_response 302
Chris@1517:     end
Chris@1517:     assert_equal users_to_test.values.uniq.size, ActionMailer::Base.deliveries.size
Chris@1517:     # tests that each user receives 1 email with the custom fields he is allowed to see only
Chris@1517:     users_to_test.each do |user, fields|
Chris@1517:       mails = ActionMailer::Base.deliveries.select {|m| m.bcc.include? user.mail}
Chris@1517:       assert_equal 1, mails.size
Chris@1517:       mail = mails.first
Chris@1517:       @fields.each_with_index do |field, i|
Chris@1517:         if fields.include?(field)
Chris@1517:           assert_mail_body_match "Value#{i}", mail, "User #{user.id} was not able to view #{field.name} in notification"
Chris@1517:         else
Chris@1517:           assert_mail_body_no_match "Value#{i}", mail, "User #{user.id} was able to view #{field.name} in notification"
Chris@1517:         end
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: 
Chris@1517:   def test_updating_hidden_custom_fields_only_should_not_notifiy_user
Chris@1517:     # anonymous user is never notified
Chris@1517:     users_to_test = @users_to_test.reject {|k,v| k.anonymous?}
Chris@1517: 
Chris@1517:     users_to_test.keys.each do |user|
Chris@1517:       Watcher.create!(:user => user, :watchable => @issue)
Chris@1517:     end
Chris@1517:     ActionMailer::Base.deliveries.clear
Chris@1517:     @request.session[:user_id] = 1
Chris@1517:     with_settings :bcc_recipients => '1' do
Chris@1517:       put :update,
Chris@1517:         :id => @issue.id,
Chris@1517:         :issue => {
Chris@1517:           :custom_field_values => {@field2.id.to_s => 'NewValue1', @field3.id.to_s => 'NewValue2'}
Chris@1517:         }
Chris@1517:       assert_response 302
Chris@1517:     end
Chris@1517:     users_to_test.each do |user, fields|
Chris@1517:       mails = ActionMailer::Base.deliveries.select {|m| m.bcc.include? user.mail}
Chris@1517:       if (fields & [@field2, @field3]).any?
Chris@1517:         assert_equal 1, mails.size, "User #{user.id} was not notified"
Chris@1517:       else
Chris@1517:         assert_equal 0, mails.size, "User #{user.id} was notified"
Chris@1517:       end
Chris@1517:     end
Chris@1517:   end
Chris@1517: end