openproject/spec/requests/api/v3/activities_api_spec.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 the OpenProject GmbH
#
# 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 docs/COPYRIGHT.rdoc for more details.
#++

require 'spec_helper'
require 'rack/test'

describe API::V3::Activities::ActivitiesAPI, type: :request, content_type: :json do
  include Rack::Test::Methods
  include API::V3::Utilities::PathHelper

  let(:current_user) do
    FactoryBot.create(:user,
                      member_in_project: project,
                      member_with_permissions: permissions)
  end
  let(:project) { FactoryBot.create(:project, public: false) }
  let(:work_package) do
    FactoryBot.create(:work_package, author: current_user, project: project)
  end
  let(:permissions) { %i[view_work_packages edit_work_package_notes] }
  let(:activity) { work_package.journals.first }
  let(:comment) { 'This is a new test comment!' }

  shared_examples_for 'valid activity request' do |type|
    subject { last_response }

    it 'returns an activity of the correct type' do
      expect(subject.body).to be_json_eql(type.to_json).at_path('_type')
      expect(subject.body).to be_json_eql(activity.id.to_json).at_path('id')
    end

    it 'responds 200 OK' do
      expect(subject.status).to eq(200)
    end
  end

  shared_examples_for 'valid activity patch request' do
    it 'updates the activity comment' do
      expect(last_response.body).to be_json_eql(comment.to_json).at_path('comment/raw')
    end

    it 'changes the comment' do
      expect(activity.reload.notes).to eql comment
    end
  end

  describe 'PATCH /api/v3/activities/:activityId' do
    let(:params) { { comment: comment } }
    before do
      login_as(current_user)
      patch api_v3_paths.activity(activity.id), params.to_json
    end

    it_behaves_like 'valid activity request', 'Activity::Comment'

    it_behaves_like 'valid activity patch request'

    it_behaves_like 'invalid activity request', 'Version is invalid' do
      let(:errors) do
        ActiveModel::Errors.new(work_package.journals.first).tap do |e|
          e.add(:version)
        end
      end
      let(:activity) do
        allow_any_instance_of(Journal).to receive(:save).and_return(false)
        allow_any_instance_of(Journal).to receive(:errors).and_return(errors)

        work_package.journals.first
      end

      it_behaves_like 'constraint violation' do
        let(:message) { 'Version is invalid' }
      end
    end

    context 'for an activity created by a different user' do
      let(:activity) do
        work_package.journals.first.tap do |journal|
          # it does not matter that the user does not exist
          journal.update_column(:user_id, 0)
        end
      end

      context 'when having the necessary permission' do
        it_behaves_like 'valid activity request', 'Activity::Comment'

        it_behaves_like 'valid activity patch request'
      end

      context 'when having only the edit own permission' do
        let(:permissions) { %i[view_work_packages edit_own_work_package_notes] }

        it_behaves_like 'unauthorized access'
      end
    end

    context 'when having only the edit own permission' do
      let(:permissions) { %i[view_work_packages edit_own_work_package_notes] }

      it_behaves_like 'valid activity request', 'Activity::Comment'

      it_behaves_like 'valid activity patch request'
    end

    context 'without sufficient permissions to edit' do
      let(:permissions) { [:view_work_packages] }

      it_behaves_like 'unauthorized access'
    end

    context 'without sufficient permissions to see' do
      let(:permissions) { [] }

      it_behaves_like 'not found'
    end
  end

  describe '#get api' do
    let(:get_path) { api_v3_paths.activity activity.id }

    before do
      login_as(current_user)
    end

    context 'logged in user' do
      before do
        get get_path
      end

      context 'for a journal without a comment' do
        it_behaves_like 'valid activity request', 'Activity'
      end

      context 'for a journal with a comment' do
        let(:activity) do
          work_package.journals.first.tap do |journal|
            journal.update_column(:notes, comment)
          end
        end

        it_behaves_like 'valid activity request', 'Activity::Comment'
      end

      context 'for an aggregated journal when requesting by the notes_id (which is not the aggregated journal`s id)`' do
        let(:activity) do
          work_package.journals.first.tap do |journal|
            journal.update_column(:notes, comment)

            work_package.subject = 'A new subject'
            work_package.save!
          end
        end

        it_behaves_like 'valid activity request', 'Activity::Comment'
      end

      context 'requesting nonexistent activity' do
        let(:get_path) { api_v3_paths.activity 9999 }

        it_behaves_like 'not found' do
          let(:id) { 9999 }
          let(:type) { 'Journal' }
        end
      end

      context 'without sufficient permissions' do
        let(:permissions) { [] }

        it_behaves_like 'not found'
      end
    end

    context 'anonymous user' do
      it_behaves_like 'handling anonymous user' do
        let(:project) { FactoryBot.create(:project, public: true) }
        let(:path) { get_path }
      end
    end
  end
end