OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
openproject/spec/models/permitted_params_spec.rb

920 lines
27 KiB

#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2014 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See doc/COPYRIGHT.rdoc for more details.
#++
require File.expand_path('../../spec_helper', __FILE__)
describe PermittedParams, type: :model do
let(:user) { FactoryGirl.build(:user) }
let(:admin) { FactoryGirl.build(:admin) }
describe :permit do
it 'adds an attribute to be permitted later' do
# just taking project_type here as an example, could be anything
# taking the originally whitelisted params to be restored later
original_whitelisted = PermittedParams.instance_variable_get(:@whitelisted_params)
params = ActionController::Parameters.new(project_type: { 'blubs1' => 'blubs' })
expect(PermittedParams.new(params, user).project_type).to eq({})
PermittedParams.permit(:project_type, :blubs1)
expect(PermittedParams.new(params, user).project_type).to eq('blubs1' => 'blubs')
PermittedParams.instance_variable_set(:@whitelisted_params, original_whitelisted)
end
it 'raises an argument error if key does not exist' do
expect { PermittedParams.permit(:bogus_key) }.to raise_error ArgumentError
end
end
describe :project_type do
it 'should return name' do
params = ActionController::Parameters.new(project_type: { 'name' => 'blubs' })
expect(PermittedParams.new(params, user).project_type).to eq('name' => 'blubs')
end
it 'should return allows_association' do
params = ActionController::Parameters.new(project_type: { 'allows_association' => '1' })
expect(PermittedParams.new(params, user).project_type).to eq('allows_association' => '1')
end
it 'should return reported_project_status_ids' do
params = ActionController::Parameters.new(project_type: { 'reported_project_status_ids' => ['1'] })
expect(PermittedParams.new(params, user).project_type).to eq('reported_project_status_ids' => ['1'])
end
end
describe :project_type_move do
it 'should permit move_to' do
params = ActionController::Parameters.new(project_type: { 'move_to' => '1' })
expect(PermittedParams.new(params, user).project_type_move).to eq('move_to' => '1')
end
end
describe :color do
it 'should permit name' do
params = ActionController::Parameters.new(color: { 'name' => 'blubs' })
expect(PermittedParams.new(params, user).color).to eq('name' => 'blubs')
end
it 'should permit hexcode' do
params = ActionController::Parameters.new(color: { 'hexcode' => '#fff' })
expect(PermittedParams.new(params, user).color).to eq('hexcode' => '#fff')
end
end
describe :color_move do
it 'should permit move_to' do
params = ActionController::Parameters.new(color: { 'move_to' => '1' })
expect(PermittedParams.new(params, user).color_move).to eq('move_to' => '1')
end
end
describe :custom_field do
it 'should permit move_to' do
params = ActionController::Parameters.new(custom_field: { 'editable' => '0', 'visible' => '0', 'filtered' => 42 })
expect(PermittedParams.new(params, user).custom_field).to eq('editable' => '0', 'visible' => '0')
end
end
describe :planning_element_type do
it 'should permit move_to' do
hash = { 'name' => 'blubs' }
params = ActionController::Parameters.new(planning_element_type: hash)
expect(PermittedParams.new(params, user).planning_element_type).to eq(hash)
end
it 'should permit in_aggregation' do
hash = { 'in_aggregation' => '1' }
params = ActionController::Parameters.new(planning_element_type: hash)
expect(PermittedParams.new(params, user).planning_element_type).to eq(hash)
end
it 'should permit is_milestone' do
hash = { 'is_milestone' => '1' }
params = ActionController::Parameters.new(planning_element_type: hash)
expect(PermittedParams.new(params, user).planning_element_type).to eq(hash)
end
it 'should permit is_default' do
hash = { 'is_default' => '1' }
params = ActionController::Parameters.new(planning_element_type: hash)
expect(PermittedParams.new(params, user).planning_element_type).to eq(hash)
end
it 'should permit color_id' do
hash = { 'color_id' => '1' }
params = ActionController::Parameters.new(planning_element_type: hash)
expect(PermittedParams.new(params, user).planning_element_type).to eq(hash)
end
end
describe :planning_element_type_move do
it 'should permit move_to' do
hash = { 'move_to' => '1' }
params = ActionController::Parameters.new(planning_element_type: hash)
expect(PermittedParams.new(params, user).planning_element_type_move).to eq(hash)
end
end
describe :new_work_package do
it 'should permit subject' do
hash = { 'subject' => 'blubs' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit description' do
hash = { 'description' => 'blubs' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit start_date' do
hash = { 'start_date' => '2013-07-08' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit due_date' do
hash = { 'due_date' => '2013-07-08' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit assigned_to_id' do
hash = { 'assigned_to_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit responsible_id' do
hash = { 'responsible_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit type_id' do
hash = { 'type_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit priority_id' do
hash = { 'priority_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit parent_id' do
hash = { 'parent_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit parent_id' do
hash = { 'parent_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit fixed_version_id' do
hash = { 'fixed_version_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit estimated_hours' do
hash = { 'estimated_hours' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit done_ratio' do
hash = { 'done_ratio' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit status_id' do
hash = { 'status_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit category_id' do
hash = { 'category_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it 'should permit watcher_user_ids when the user is allowed to add watchers' do
project = double('project')
allow(user).to receive(:allowed_to?).with(:add_work_package_watchers, project).and_return(true)
hash = { 'watcher_user_ids' => ['1', '2'] }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package(project: project)).to eq(hash)
end
it 'should not return watcher_user_ids when the user is not allowed to add watchers' do
project = double('project')
allow(user).to receive(:allowed_to?).with(:add_work_package_watchers, project).and_return(false)
hash = { 'watcher_user_ids' => ['1', '2'] }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package(project: project)).to eq({})
end
it 'should permit custom field values' do
hash = { 'custom_field_values' => { '1' => '5' } }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it "should remove custom field values that do not follow the schema 'id as string' => 'value as string'" do
hash = { 'custom_field_values' => { 'blubs' => '5', '5' => { '1' => '2' } } }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq({})
end
end
describe :update_work_package do
it 'should permit subject' do
hash = { 'subject' => 'blubs' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit description' do
hash = { 'description' => 'blubs' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit start_date' do
hash = { 'start_date' => '2013-07-08' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit due_date' do
hash = { 'due_date' => '2013-07-08' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit assigned_to_id' do
hash = { 'assigned_to_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit responsible_id' do
hash = { 'responsible_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit type_id' do
hash = { 'type_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit priority_id' do
hash = { 'priority_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit parent_id' do
hash = { 'parent_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit parent_id' do
hash = { 'parent_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit fixed_version_id' do
hash = { 'fixed_version_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit estimated_hours' do
hash = { 'estimated_hours' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit done_ratio' do
hash = { 'done_ratio' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit lock_version' do
hash = { 'lock_version' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit status_id' do
hash = { 'status_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit category_id' do
hash = { 'category_id' => '1' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit notes' do
hash = { 'notes' => 'blubs' }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit attachments' do
hash = { 'attachments' => [{ 'file' => 'djskfj', 'description' => 'desc' }] }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package).to eq(hash)
end
it 'should permit time_entry if the user has the log_time permission' do
hash = { 'time_entry' => { 'hours' => '5', 'activity_id' => '1', 'comments' => 'lorem' } }
project = double('project')
allow(user).to receive(:allowed_to?).with(:log_time, project).and_return(true)
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package(project: project)).to eq(hash)
end
it 'should not permit time_entry if the user lacks the log_time permission' do
hash = { 'time_entry' => { 'hours' => '5', 'activity_id' => '1', 'comments' => 'lorem' } }
project = double('project')
allow(user).to receive(:allowed_to?).with(:log_time, project).and_return(false)
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).update_work_package(project: project)).to eq({})
end
it 'should permit custom field values' do
hash = { 'custom_field_values' => { '1' => '5' } }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq(hash)
end
it "should remove custom field values that do not follow the schema 'id as string' => 'value as string'" do
hash = { 'custom_field_values' => { 'blubs' => '5', '5' => { '1' => '2' } } }
params = ActionController::Parameters.new(work_package: hash)
expect(PermittedParams.new(params, user).new_work_package).to eq({})
end
end
describe :user do
admin_permissions = ['admin',
'login',
'firstname',
'lastname',
'mail',
'mail_notification',
'language',
'custom_fields',
'auth_source_id',
'force_password_change']
[:user_update_as_admin, :user_create_as_admin].each do |method|
describe method do
it 'should permit nothing for a non-admin user' do
# Hash with {'key' => 'key'} for all admin_permissions
field_sample = { user: Hash[admin_permissions.zip(admin_permissions)] }
params = ActionController::Parameters.new(field_sample)
expect(PermittedParams.new(params, user).method(method).call(false, true)).to eq({})
end
admin_permissions.each do |field|
it "should permit #{field}" do
hash = { field => 'test' }
params = ActionController::Parameters.new(user: hash)
result = PermittedParams.new(params, admin).method(method).call(false, true)
expect(result).to eq(field => 'test')
end
end
context 'with no password change allowed' do
it 'should not permit force_password_change' do
hash = { 'force_password_change' => 'true' }
params = ActionController::Parameters.new(user: hash)
result = PermittedParams.new(params, admin).method(method).call(false, false)
expect(result).to eq({})
end
end
context 'with external authentication' do
it 'should not permit auth_source_id' do
hash = { 'auth_source_id' => 'true' }
params = ActionController::Parameters.new(user: hash)
result = PermittedParams.new(params, admin).method(method).call(true, true)
expect(result).to eq({})
end
end
it 'should permit custom field values' do
hash = { 'custom_field_values' => { '1' => '5' } }
params = ActionController::Parameters.new(user: hash)
result = PermittedParams.new(params, admin).method(method).call(false, true)
expect(result).to eq(hash)
end
it "should remove custom field values that do not follow the schema 'id as string' => 'value as string'" do
hash = { 'custom_field_values' => { 'blubs' => '5', '5' => { '1' => '2' } } }
params = ActionController::Parameters.new(user: hash)
result = PermittedParams.new(params, admin).method(method).call(false, true)
expect(result).to eq({})
end
end
end
describe :user_update_as_admin do
it 'should permit a group_ids list' do
hash = { 'group_ids' => ['1', '2'] }
params = ActionController::Parameters.new(user: hash)
expect(PermittedParams.new(params, admin).user_update_as_admin(false, false)).to eq(hash)
end
end
describe :user_create_as_admin do
it 'should not permit a group_ids list' do
hash = { 'group_ids' => ['1', '2'] }
params = ActionController::Parameters.new(user: hash)
expect(PermittedParams.new(params, admin).user_create_as_admin(false, false)).to eq({})
end
end
user_permissions = [
'firstname',
'lastname',
'mail',
'mail_notification',
'language',
'custom_fields',
]
describe :user do
user_permissions.each do |field|
it "should permit #{field}" do
hash = { field => 'test' }
params = ActionController::Parameters.new(user: hash)
expect(PermittedParams.new(params, admin).user).to eq(
field => 'test'
)
end
end
(admin_permissions - user_permissions).each do |field|
it "should not permit #{field} (admin-only)" do
hash = { field => 'test' }
params = ActionController::Parameters.new(user: hash)
expect(PermittedParams.new(params, admin).user).to eq({})
end
end
it 'should permit custom field values' do
hash = { 'custom_field_values' => { '1' => '5' } }
params = ActionController::Parameters.new(user: hash)
expect(PermittedParams.new(params, admin).user).to eq(hash)
end
it "should remove custom field values that do not follow the schema 'id as string' => 'value as string'" do
hash = { 'custom_field_values' => { 'blubs' => '5', '5' => { '1' => '2' } } }
params = ActionController::Parameters.new(user: hash)
expect(PermittedParams.new(params, admin).user).to eq({})
end
it 'should not allow identity_url' do
hash = { 'identity_url' => 'test_identity_url' }
params = ActionController::Parameters.new(user: hash)
expect(PermittedParams.new(params, admin).user).to eq({})
end
end
end
describe '#user_register_via_omniauth' do
user_permissions = %w(login firstname lastname mail language)
user_permissions.each do |field|
it "should permit #{field}" do
hash = { field => 'test' }
params = ActionController::Parameters.new(user: hash)
expect(PermittedParams.new(params, admin).user_register_via_omniauth).to eq(
field => 'test')
end
end
it 'should not allow identity_url' do
hash = { 'identity_url' => 'test_identity_url' }
params = ActionController::Parameters.new(user: hash)
expect(PermittedParams.new(params, admin).user_register_via_omniauth).to eq({})
end
end
shared_context 'prepare params comparison' do
let(:params_key) { (defined? hash_key) ? hash_key : attribute }
let(:params) { ActionController::Parameters.new(params_key => hash) }
subject { PermittedParams.new(params, user).send(attribute) }
end
shared_examples_for 'allows params' do
include_context 'prepare params comparison'
it { expect(subject).to eq(hash) }
end
shared_examples_for 'forbids params' do
include_context 'prepare params comparison'
it { expect(subject).not_to eq(hash) }
end
shared_examples_for 'allows move params' do
let(:hash) { { 'move_to' => 'lower' } }
it_behaves_like 'allows params'
end
shared_examples_for 'allows custom fields' do
describe 'valid custom fields' do
let(:hash) { { 'custom_field_values' => { '1' => '5' } } }
it_behaves_like 'allows params'
end
describe 'invalid custom fields' do
let(:hash) { { 'custom_field_values' => { 'blubs' => '5', '5' => { '1' => '2' } } } }
it_behaves_like 'forbids params'
end
end
describe :status do
let (:attribute) { :status }
describe 'name' do
let(:hash) { { 'name' => 'blubs' } }
it_behaves_like 'allows params'
end
describe 'default_done_ratio' do
let(:hash) { { 'default_done_ratio' => '10' } }
it_behaves_like 'allows params'
end
describe 'is_closed' do
let(:hash) { { 'is_closed' => 'true' } }
it_behaves_like 'allows params'
end
describe 'is_default' do
let(:hash) { { 'is_default' => 'true' } }
it_behaves_like 'allows params'
end
describe 'move_to' do
it_behaves_like 'allows move params'
end
end
describe :enumerations do
let (:attribute) { :enumeration }
describe 'name' do
let(:hash) { { 'name' => 'blubs' } }
it_behaves_like 'allows params'
end
describe 'active' do
let(:hash) { { 'active' => 'true' } }
it_behaves_like 'allows params'
end
describe 'is_default' do
let(:hash) { { 'is_default' => 'true' } }
it_behaves_like 'allows params'
end
describe 'reassign_to_id' do
let(:hash) { { 'reassign_to_id' => '1' } }
it_behaves_like 'allows params'
end
describe 'move_to' do
it_behaves_like 'allows move params'
end
describe 'custom fields' do
it_behaves_like 'allows custom fields'
end
end
describe :wiki_page do
let (:hash_key) { :page }
let (:attribute) { :wiki_page }
describe 'title' do
let(:hash) { { 'title' => 'blubs' } }
it_behaves_like 'allows params'
end
describe 'parent_id' do
let(:hash) { { 'parent_id' => '1' } }
it_behaves_like 'allows params'
end
describe 'redirect_existing_links' do
let(:hash) { { 'redirect_existing_links' => '1' } }
it_behaves_like 'allows params'
end
end
describe :wiki_content do
let (:hash_key) { :content }
let (:attribute) { :wiki_content }
describe 'title' do
let(:hash) { { 'comments' => 'blubs' } }
it_behaves_like 'allows params'
end
describe 'text' do
let(:hash) { { 'text' => 'blubs' } }
it_behaves_like 'allows params'
end
describe 'lock_version' do
let(:hash) { { 'lock_version' => '1' } }
it_behaves_like 'allows params'
end
end
describe 'member' do
let (:attribute) { :member }
describe 'role_ids' do
let(:hash) { { 'role_ids' => [] } }
it_behaves_like 'allows params'
end
describe 'user_id' do
let(:hash) { { 'user_id' => 'blubs' } }
it_behaves_like 'forbids params'
end
describe 'project_id' do
let(:hash) { { 'user_id' => 'blubs' } }
it_behaves_like 'forbids params'
end
describe 'created_on' do
let(:hash) { { 'created_on' => 'blubs' } }
it_behaves_like 'forbids params'
end
describe 'mail_notification' do
let(:hash) { { 'mail_notification' => 'blubs' } }
it_behaves_like 'forbids params'
end
end
describe '.add_permitted_attributes' do
before do
@original_permitted_attributes = PermittedParams.permitted_attributes.clone
end
after do
# Class variable is not accessible within class_eval
original_permitted_attributes = @original_permitted_attributes
PermittedParams.class_eval do
@whitelisted_params = original_permitted_attributes
end
end
describe 'with a known key' do
let(:attribute) { :user }
before do
PermittedParams.send(:add_permitted_attributes, user: [:a_test_field])
end
context 'with an allowed parameter' do
let(:hash) { { 'a_test_field' => 'a test value' } }
it_behaves_like 'allows params'
end
context 'with a disallowed parameter' do
let(:hash) { { 'a_not_allowed_field' => 'a test value' } }
it_behaves_like 'forbids params'
end
end
describe 'with an unknown key' do
let(:attribute) { :unknown_key }
let(:hash) { { 'a_test_field' => 'a test value' } }
before do
expect(Rails.logger).to receive(:warn)
PermittedParams.send(:add_permitted_attributes, unknown_key: [:a_test_field])
end
it 'permitted attributes should not include the key and the rails logger should receive a warning' do
expect(PermittedParams.permitted_attributes.keys).to_not include(:unknown_key)
end
end
end
end