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/requests/api/v3/work_package_resource_spec.rb

973 lines
30 KiB

#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2015 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 'spec_helper'
require 'rack/test'
describe 'API v3 Work package resource', type: :request do
include Rack::Test::Methods
include Capybara::RSpecMatchers
include API::V3::Utilities::PathHelper
let(:closed_status) { FactoryGirl.create(:closed_status) }
let!(:timeline) { FactoryGirl.create(:timeline, project_id: project.id) }
let!(:other_wp) {
FactoryGirl.create(:work_package, project_id: project.id,
status: closed_status)
}
let(:work_package) {
FactoryGirl.create(:work_package, project_id: project.id,
description: description
)
}
let(:description) {
%{
{{>toc}}
h1. OpenProject Masterplan for 2015
h2. three point plan
# One ###{other_wp.id}
# Two
# Three
h3. random thoughts
h4. things we like
* Pointed
* Relaxed
* Debonaire
{{timeline(#{timeline.id})}}
}}
let(:project) do
FactoryGirl.create(:project, identifier: 'test_project', is_public: false)
end
let(:role) { FactoryGirl.create(:role, permissions: permissions) }
let(:permissions) { [:view_work_packages, :view_timelines, :edit_work_packages] }
let(:current_user) do
user = FactoryGirl.create(:user, member_in_project: project, member_through_role: role)
FactoryGirl.create(:user_preference, user: user, others: { no_self_notified: false })
user
end
let(:watcher) do
FactoryGirl
.create(:user, member_in_project: project, member_through_role: role)
.tap do |user|
work_package.add_watcher(user)
end
end
let(:unauthorize_user) { FactoryGirl.create(:user) }
let(:type) { FactoryGirl.create(:type) }
before do
allow(User).to receive(:current).and_return current_user
# some way some of these specs rely on this setting being disabled
# so we set it excplicitly as a precondition
Setting.cross_project_work_package_relations = 0
end
describe '#get list' do
subject { last_response }
before(:each) do
get api_v3_paths.work_packages
end
it 'succeeds' do
expect(subject.status).to eql 200
end
it 'returns visible work packages' do
FactoryGirl.create(:work_package, project: project)
expect(subject.body).to be_json_eql(1.to_json).at_path('total')
end
context 'user not seeing any work packages' do
let(:current_user) { FactoryGirl.create(:user) }
let(:non_member_permissions) { [:view_work_packages] }
around do |example|
non_member = Role.non_member
previous_permissions = non_member.permissions
non_member.update_attribute(:permissions, non_member_permissions)
example.run
non_member.update_attribute(:permissions, previous_permissions)
end
it 'succeeds' do
expect(subject.status).to eql 200
end
it 'returns no work packages' do
FactoryGirl.create(:work_package, project: project)
expect(subject.body).to be_json_eql(0.to_json).at_path('total')
end
context 'because he is not allowed to see work packages in general' do
let(:non_member_permissions) { [] }
it_behaves_like 'unauthorized access'
end
end
end
describe '#get' do
let(:get_path) { api_v3_paths.work_package work_package.id }
context 'when acting as a user with permission to view work package' do
before(:each) do
allow(User).to receive(:current).and_return current_user
get get_path
end
it 'should respond with 200' do
expect(last_response.status).to eq(200)
end
describe 'response body' do
subject(:parsed_response) { JSON.parse(last_response.body) }
it 'should respond with work package in HAL+JSON format' do
expect(parsed_response['id']).to eq(work_package.id)
end
describe "['description']" do
subject { super()['description'] }
it { is_expected.to have_selector('h1') }
end
describe "['description']" do
subject { super()['description'] }
it { is_expected.to have_selector('h2') }
end
it 'should resolve links' do
expect(parsed_response['description']['html'])
.to have_selector("a[href='/work_packages/#{other_wp.id}']")
end
it 'should resolve simple macros' do
expect(parsed_response['description']).to have_text('Table of Contents')
end
it 'should not resolve/show complex macros' do
expect(parsed_response['description'])
.to have_text('Macro timeline cannot be displayed.')
end
end
context 'requesting nonexistent work package' do
let(:get_path) { api_v3_paths.work_package 909090 }
it_behaves_like 'not found'
end
end
context 'when acting as an user without permission to view work package' do
before(:each) do
allow(User).to receive(:current).and_return unauthorize_user
get get_path
end
it_behaves_like 'not found'
end
context 'when acting as an anonymous user' do
before(:each) do
allow(User).to receive(:current).and_return User.anonymous
get get_path
end
it_behaves_like 'not found'
end
end
describe '#patch' do
let(:patch_path) { api_v3_paths.work_package work_package.id }
let(:valid_params) do
{
_type: 'WorkPackage',
lockVersion: work_package.lock_version
}
end
subject(:response) { last_response }
shared_context 'patch request' do
before(:each) do
allow(User).to receive(:current).and_return current_user
patch patch_path, params.to_json, 'CONTENT_TYPE' => 'application/json'
end
end
context 'user without needed permissions' do
context 'no permission to see the work package' do
let(:work_package) { FactoryGirl.create(:work_package) }
let(:current_user) { FactoryGirl.create :user }
let(:params) { valid_params }
include_context 'patch request'
it_behaves_like 'not found'
end
context 'no permission to edit the work package' do
let(:role) { FactoryGirl.create(:role, permissions: [:view_work_packages]) }
let(:current_user) {
FactoryGirl.create(:user,
member_in_project: work_package.project,
member_through_role: role)
}
let(:params) { valid_params }
include_context 'patch request'
it_behaves_like 'unauthorized access'
end
end
context 'user with needed permissions' do
shared_examples_for 'lock version updated' do
it {
expect(subject.body).to be_json_eql(work_package.reload.lock_version)
.at_path('lockVersion')
}
end
describe 'notification' do
let(:update_params) { valid_params.merge(subject: 'Updated subject') }
before(:each) do
allow(User).to receive(:current).and_return current_user
work_package
ActionMailer::Base.deliveries.clear # throw away mails due to work package creation
end
include_context 'patch request'
subject { ActionMailer::Base.deliveries }
context 'not set' do
let(:params) { update_params }
it { expect(subject.count).to eq(1) }
end
context 'disabled' do
let(:patch_path) { "#{api_v3_paths.work_package work_package.id}?notify=false" }
let(:params) { update_params }
it { expect(subject).to be_empty }
end
context 'enabled' do
let(:patch_path) { "#{api_v3_paths.work_package work_package.id}?notify=Something" }
let(:params) { update_params }
it { expect(subject.count).to eq(1) }
end
end
context 'parent id' do
let(:parent) { FactoryGirl.create(:work_package, project: work_package.project) }
let(:params) { valid_params.merge(parentId: parent.id) }
before do
allow(Setting).to receive(:cross_project_work_package_relations?).and_return(true)
end
context 'w/o permission' do
include_context 'patch request'
it { expect(response.status).to eq(403) }
end
context 'with permission' do
before do role.add_permission!(:manage_subtasks) end
include_context 'patch request'
context 'invalid parent' do
let(:params) { valid_params.merge(parentId: '-123') }
it { expect(WorkPackage.visible(current_user).exists?('-123')).to be_falsey }
it { expect(response.status).to eq(422) }
end
context 'empty id' do
let(:params) { valid_params.merge(parentId: nil) }
it { expect(response.status).to eq(200) }
it { expect(subject.body).not_to have_json_path('parentId') }
it_behaves_like 'lock version updated'
end
context 'valid id' do
let(:params) { valid_params.merge(parentId: parent.id) }
it { expect(response.status).to eq(200) }
it { expect(subject.body).to be_json_eql(parent.id.to_json).at_path('parentId') }
it_behaves_like 'lock version updated'
end
end
end
context 'subject' do
let(:params) { valid_params.merge(subject: 'Updated subject') }
include_context 'patch request'
it { expect(response.status).to eq(200) }
it 'should respond with updated work package subject' do
expect(subject.body).to be_json_eql('Updated subject'.to_json).at_path('subject')
end
it_behaves_like 'lock version updated'
end
context 'description' do
shared_examples_for 'description updated' do
it_behaves_like 'API V3 formattable', 'description' do
let(:format) { 'textile' }
subject { response.body }
end
it_behaves_like 'lock version updated'
end
context 'w/o value (empty)' do
let(:raw) { nil }
let(:html) { '' }
let(:params) { valid_params.merge(description: { raw: nil }) }
include_context 'patch request'
it { expect(response.status).to eq(200) }
it_behaves_like 'description updated'
end
context 'with value' do
let(:raw) { '*Some text* _describing_ *something*...' }
let(:html) {
'<p><strong>Some text</strong> <em>describing</em> <strong>something</strong>...</p>'
}
let(:params) { valid_params.merge(description: { raw: raw }) }
include_context 'patch request'
it { expect(response.status).to eq(200) }
it_behaves_like 'description updated'
end
end
context 'start date' do
let(:dateString) { Date.today.to_date.iso8601 }
let(:params) { valid_params.merge(startDate: dateString) }
include_context 'patch request'
it { expect(response.status).to eq(200) }
it 'should respond with updated start date' do
expect(subject.body).to be_json_eql(dateString.to_json).at_path('startDate')
end
it_behaves_like 'lock version updated'
end
context 'due date' do
let(:dateString) { Date.today.to_date.iso8601 }
let(:params) { valid_params.merge(dueDate: dateString) }
include_context 'patch request'
it { expect(response.status).to eq(200) }
it 'should respond with updated due date' do
expect(subject.body).to be_json_eql(dateString.to_json).at_path('dueDate')
end
it_behaves_like 'lock version updated'
end
context 'status' do
let(:target_status) { FactoryGirl.create(:status) }
let(:status_link) { api_v3_paths.status target_status.id }
let(:status_parameter) { { _links: { status: { href: status_link } } } }
let(:params) { valid_params.merge(status_parameter) }
before do allow(User).to receive(:current).and_return current_user end
context 'valid status' do
let!(:workflow) {
FactoryGirl.create(:workflow,
type_id: work_package.type.id,
old_status: work_package.status,
new_status: target_status,
role: current_user.memberships[0].roles[0])
}
include_context 'patch request'
it { expect(response.status).to eq(200) }
it 'should respond with updated work package status' do
expect(subject.body).to be_json_eql(target_status.name.to_json)
.at_path('_embedded/status/name')
end
it_behaves_like 'lock version updated'
end
context 'invalid status' do
include_context 'patch request'
it_behaves_like 'constraint violation' do
let(:message) {
'Status ' + I18n.t('activerecord.errors.models.' \
'work_package.attributes.status_id.status_transition_invalid')
}
end
end
context 'wrong resource' do
let(:status_link) { api_v3_paths.user current_user.id }
include_context 'patch request'
it_behaves_like 'invalid resource link' do
let(:message) {
I18n.t('api_v3.errors.invalid_resource',
property: 'status',
expected: '/api/v3/statuses/:id',
actual: status_link)
}
end
end
end
context 'type' do
let(:target_type) { FactoryGirl.create(:type) }
let(:type_link) { api_v3_paths.type target_type.id }
let(:type_parameter) { { _links: { type: { href: type_link } } } }
let(:params) { valid_params.merge(type_parameter) }
before do allow(User).to receive(:current).and_return current_user end
context 'valid type' do
before do
project.types << target_type
end
include_context 'patch request'
it { expect(response.status).to eq(200) }
it 'should respond with updated work package type' do
expect(subject.body).to be_json_eql(target_type.name.to_json)
.at_path('_embedded/type/name')
end
it_behaves_like 'lock version updated'
end
context 'valid type changing custom fields' do
let(:custom_field) { FactoryGirl.create(:work_package_custom_field) }
before do
project.types << target_type
project.work_package_custom_fields << custom_field
target_type.custom_fields << custom_field
end
include_context 'patch request'
it 'responds with the new custom field added' do
expect(subject.body).to have_json_path("customField#{custom_field.id}")
end
end
context 'invalid type' do
include_context 'patch request'
it_behaves_like 'constraint violation' do
let(:message) { "Type #{I18n.t('activerecord.errors.messages.inclusion')}" }
end
end
context 'wrong resource' do
let(:type_link) { api_v3_paths.user current_user.id }
include_context 'patch request'
it_behaves_like 'invalid resource link' do
let(:message) {
I18n.t('api_v3.errors.invalid_resource',
property: 'type',
expected: '/api/v3/types/:id',
actual: type_link)
}
end
end
end
context 'assignee and responsible' do
let(:user) { FactoryGirl.create(:user, member_in_project: project) }
let(:params) { valid_params.merge(user_parameter) }
let(:work_package) {
FactoryGirl.create(:work_package,
project: project,
assigned_to: current_user,
responsible: current_user)
}
before do allow(User).to receive(:current).and_return current_user end
shared_context 'setup group membership' do |group_assignment|
let(:group) { FactoryGirl.create(:group) }
let(:group_role) { FactoryGirl.create(:role) }
let(:group_member) {
FactoryGirl.create(:member,
principal: group,
project: project,
roles: [group_role])
}
before do
allow(Setting).to receive(:work_package_group_assignment?).and_return(group_assignment)
group_member
end
end
shared_examples_for 'handling people' do |property|
let(:user_parameter) { { _links: { property => { href: user_href } } } }
let(:href_path) { "_links/#{property}/href" }
describe 'nil' do
let(:user_href) { nil }
include_context 'patch request'
it { expect(response.status).to eq(200) }
it { expect(response.body).to be_json_eql(nil.to_json).at_path(href_path) }
it_behaves_like 'lock version updated'
end
describe 'valid' do
shared_examples_for 'valid user assignment' do
let(:title) { "#{assigned_user.name}".to_json }
it { expect(response.status).to eq(200) }
it {
expect(response.body).to be_json_eql(title)
.at_path("_links/#{property}/title")
}
it_behaves_like 'lock version updated'
end
context 'user' do
let(:user_href) { api_v3_paths.user user.id }
include_context 'patch request'
it_behaves_like 'valid user assignment' do
let(:assigned_user) { user }
end
end
context 'group' do
let(:user_href) { api_v3_paths.user group.id }
include_context 'setup group membership', true
include_context 'patch request'
it_behaves_like 'valid user assignment' do
let(:assigned_user) { group }
end
end
end
describe 'invalid' do
include_context 'patch request'
context 'user doesn\'t exist' do
let(:user_href) { api_v3_paths.user 909090 }
it_behaves_like 'constraint violation' do
let(:message) {
I18n.t('api_v3.errors.validation.' \
'invalid_user_assigned_to_work_package',
property: property.capitalize)
}
end
end
context 'user is not visible' do
let(:invalid_user) { FactoryGirl.create(:user) }
let(:user_href) { api_v3_paths.user invalid_user.id }
it_behaves_like 'constraint violation' do
let(:message) {
I18n.t('api_v3.errors.validation.invalid_user_assigned_to_work_package',
property: property.capitalize)
}
end
end
context 'wrong resource' do
let(:user_href) { api_v3_paths.status work_package.status.id }
include_context 'patch request'
it_behaves_like 'invalid resource link' do
let(:message) {
I18n.t('api_v3.errors.invalid_resource',
property: property,
expected: '/api/v3/users/:id',
actual: user_href)
}
end
end
context 'group assignment disabled' do
let(:user_href) { api_v3_paths.user group.id }
include_context 'setup group membership', false
include_context 'patch request'
it_behaves_like 'constraint violation' do
let(:message) {
I18n.t('api_v3.errors.validation.invalid_user_assigned_to_work_package',
property: "#{property.capitalize}")
}
end
end
end
end
context 'assingee' do
it_behaves_like 'handling people', 'assignee'
end
context 'responsible' do
it_behaves_like 'handling people', 'responsible'
end
end
context 'version' do
let(:target_version) { FactoryGirl.create(:version, project: project) }
let(:version_link) { api_v3_paths.version target_version.id }
let(:version_parameter) { { _links: { version: { href: version_link } } } }
let(:params) { valid_params.merge(version_parameter) }
before do allow(User).to receive(:current).and_return current_user end
context 'valid' do
include_context 'patch request'
it { expect(response.status).to eq(200) }
it 'should respond with the work package assigned to the version' do
expect(subject.body).to be_json_eql(target_version.name.to_json)
.at_path('_embedded/version/name')
end
it_behaves_like 'lock version updated'
end
end
context 'category' do
let(:target_category) { FactoryGirl.create(:category, project: project) }
let(:category_link) { api_v3_paths.category target_category.id }
let(:category_parameter) { { _links: { category: { href: category_link } } } }
let(:params) { valid_params.merge(category_parameter) }
before do allow(User).to receive(:current).and_return current_user end
context 'valid' do
include_context 'patch request'
it { expect(response.status).to eq(200) }
it 'should respond with the work package assigned to the category' do
expect(subject.body).to be_json_eql(target_category.name.to_json)
.at_path('_embedded/category/name')
end
it_behaves_like 'lock version updated'
end
end
context 'priority' do
let(:target_priority) { FactoryGirl.create(:priority) }
let(:priority_link) { api_v3_paths.priority target_priority.id }
let(:priority_parameter) { { _links: { priority: { href: priority_link } } } }
let(:params) { valid_params.merge(priority_parameter) }
before do allow(User).to receive(:current).and_return current_user end
context 'valid' do
include_context 'patch request'
it { expect(response.status).to eq(200) }
it 'should respond with the work package assigned to the priority' do
expect(subject.body).to be_json_eql(target_priority.name.to_json)
.at_path('_embedded/priority/name')
end
it_behaves_like 'lock version updated'
end
end
context 'list custom field' do
let(:custom_field) {
FactoryGirl.create(:work_package_custom_field,
field_format: 'list',
is_required: false,
possible_values: target_value)
}
let(:target_value) { 'Low No. of specialc#aracters!' }
let(:value_link) { api_v3_paths.string_object target_value }
let(:value_parameter) {
{ _links: { custom_field.accessor_name.camelize(:lower) => { href: value_link } } }
}
let(:params) { valid_params.merge(value_parameter) }
before do
allow(User).to receive(:current).and_return current_user
work_package.project.work_package_custom_fields << custom_field
work_package.type.custom_fields << custom_field
end
context 'valid' do
include_context 'patch request'
it { expect(response.status).to eq(200) }
it 'should respond with the work package assigned to the new value' do
expect(subject.body).to be_json_eql(value_link.to_json)
.at_path("_links/#{custom_field.accessor_name.camelize(:lower)}/href")
end
it_behaves_like 'lock version updated'
end
end
describe 'update with read-only attributes' do
describe 'single read-only violation' do
context 'created and updated' do
let(:tomorrow) { (DateTime.now + 1.day).utc.iso8601 }
include_context 'patch request'
context 'created_at' do
let(:params) { valid_params.merge(createdAt: tomorrow) }
it_behaves_like 'read-only violation', 'createdAt'
end
context 'updated_at' do
let(:params) { valid_params.merge(updatedAt: tomorrow) }
it_behaves_like 'read-only violation', 'updatedAt'
end
end
end
context 'multiple read-only attributes' do
let(:params) do
valid_params.merge(createdAt: Date.today.iso8601, updatedAt: Date.today.iso8601)
end
include_context 'patch request'
it_behaves_like 'multiple errors', 422
it_behaves_like 'multiple errors of the same type', 2, 'PropertyIsReadOnly'
it_behaves_like 'multiple errors of the same type with details',
'attribute',
'attribute' => ['createdAt', 'updatedAt']
end
end
context 'invalid update' do
context 'single invalid attribute' do
let(:params) { valid_params.tap { |h| h[:subject] = '' } }
include_context 'patch request'
it_behaves_like 'constraint violation' do
let(:message) { "Subject can't be blank" }
end
end
context 'multiple invalid attributes' do
let(:params) do
valid_params.tap { |h| h[:subject] = '' }
.merge(parentId: '-123')
end
before do role.add_permission!(:manage_subtasks) end
include_context 'patch request'
it_behaves_like 'multiple errors', 422
it_behaves_like 'multiple errors of the same type', 2, 'PropertyConstraintViolation'
it_behaves_like 'multiple errors of the same type with messages' do
let(:message) { ['Subject can\'t be blank.', 'Parent does not exist.'] }
end
end
context 'missing lock version' do
let(:params) { valid_params.except(:lockVersion) }
include_context 'patch request'
it_behaves_like 'update conflict'
end
context 'stale object' do
let(:params) { valid_params.merge(subject: 'Updated subject') }
before do
params
work_package.subject = 'I am the first!'
work_package.save!
expect(valid_params[:lockVersion]).not_to eq(work_package.lock_version)
end
include_context 'patch request'
it_behaves_like 'update conflict'
end
context 'invalid work package children' do
let(:params) { valid_params.merge(lockVersion: work_package.reload.lock_version) }
let!(:child_1) { FactoryGirl.create(:work_package) }
let!(:child_2) { FactoryGirl.create(:work_package) }
before do
[child_1, child_2].each do |c|
c.parent = work_package
c.save!(validate: false)
end
end
include_context 'patch request'
it_behaves_like 'multiple errors', 422, 'Multiple fields violated their constraints.'
it_behaves_like 'multiple errors of the same type', 2, 'PropertyConstraintViolation'
it_behaves_like 'multiple errors of the same type with messages' do
let(:message) {
[child_1.id, child_2.id].map { |id|
"Child element ##{id}: Parent cannot be in another project."
}
}
end
end
end
end
end
describe '#delete' do
let(:path) { api_v3_paths.work_package work_package.id }
before do
delete path
end
subject { last_response }
context 'with required permissions' do
let(:permissions) { [:view_work_packages, :delete_work_packages] }
it 'responds with HTTP No Content' do
expect(subject.status).to eq 204
end
it 'deletes the work package' do
expect(WorkPackage.exists?(work_package.id)).to be_falsey
end
context 'for a non-existent work package' do
let(:path) { api_v3_paths.work_package 1337 }
it_behaves_like 'not found' do
let(:id) { 1337 }
let(:type) { 'WorkPackage' }
end
end
end
context 'without permission to see work packages' do
let(:permissions) { [] }
it_behaves_like 'not found'
end
context 'without permission to delete work packages' do
let(:permissions) { [:view_work_packages] }
it_behaves_like 'unauthorized access'
it 'does not delete the work package' do
expect(WorkPackage.exists?(work_package.id)).to be_truthy
end
end
end
end