openproject/spec/controllers/work_packages/auto_completes_controller_spec.rb

#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2018 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-2017 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'

describe WorkPackages::AutoCompletesController, type: :controller do
  let(:user) { FactoryBot.create(:user) }
  let(:project) { FactoryBot.create(:project) }
  let(:role) {
    FactoryBot.create(:role,
                       permissions: [:view_work_packages])
  }
  let(:member) {
    FactoryBot.create(:member,
                       project: project,
                       principal: user,
                       roles: [role])
  }
  let(:work_package_1) do
    FactoryBot.create(:work_package, subject: "Can't print recipes",
                                      project: project)
  end

  let(:work_package_2) do
    FactoryBot.create(:work_package, subject: 'Error when updating a recipe',
                                      project: project)
  end

  let(:work_package_3) do
    FactoryBot.create(:work_package, subject: 'Lorem ipsum',
                                      project: project)
  end

  before do
    member

    allow(User).to receive(:current).and_return user

    work_package_1
    work_package_2
    work_package_3
  end

  shared_examples_for 'successful response' do
    subject { response }

    it { is_expected.to be_success }
  end

  shared_examples_for 'contains expected values' do
    subject { assigns(:work_packages) }

    it { is_expected.to include(*expected_values) }
  end

  describe '#work_packages' do
    describe 'search is case insensitive' do
      let(:expected_values) { [work_package_1, work_package_2] }

      before do
        get :index,
            params: {
              project_id: project.id,
              q: 'ReCiPe'
            }
      end

      it_behaves_like 'successful response'

      it_behaves_like 'contains expected values'
    end

    describe 'returns work package for given id' do
      let(:expected_values) { work_package_1 }

      before do
        get :index,
            params: {
              project_id: project.id,
              q: work_package_1.id
            }
      end

      it_behaves_like 'successful response'

      it_behaves_like 'contains expected values'
    end

    describe 'returns work package for given id' do
      # this relies on all expected work packages to have ids that contain the given string
      # we do not want to have work_package_3 so we take it's id + 1 to create a string
      # we are sure to not be part of work_package_3's id.
      let(:ids) do
        taken_ids = WorkPackage.pluck(:id).map(&:to_s)

        id = work_package_3.id + 1

        while taken_ids.include?(id.to_s) || work_package_3.id.to_s.include?(id.to_s)
          id = id + 1
        end

        id.to_s
      end

      let!(:expected_values) do
        expected = [work_package_1, work_package_2]

        WorkPackage.pluck(:id)

        expected_return = []
        expected.each do |wp|
          new_id = wp.id.to_s + ids
          WorkPackage.where(id: wp.id).update_all(id: new_id)
          expected_return << WorkPackage.find(new_id)
        end

        expected_return
      end

      before do
        get :index,
            params: {
              project_id: project.id,
              q: ids
            }
      end

      it_behaves_like 'successful response'

      it_behaves_like 'contains expected values'

      context 'uniq' do
        let(:assigned) { assigns(:work_packages) }

        subject { assigned.size }

        it { is_expected.to eq(assigned.uniq.size) }
      end
    end

    describe 'returns work package for given id' do
      render_views
      let(:work_package_4) {
        FactoryBot.create(:work_package,
                           subject: "<script>alert('danger!');</script>",
                           project: project)
      }
      let(:expected_values) { work_package_4 }

      before do
        get :index,
            params: {
              project_id: project.id,
              q: work_package_4.id
            },
            format: :json
      end

      it_behaves_like 'successful response'
      it_behaves_like 'contains expected values'

      it 'should escape html' do
        expect(response.body).not_to include '<script>'
      end
    end

    describe 'in different projects' do
      let(:project_2) {
        FactoryBot.create(:project,
                           parent: project)
      }
      let(:member_2) {
        FactoryBot.create(:member,
                           project: project_2,
                           principal: user,
                           roles: [role])
      }
      let(:work_package_4) do
        FactoryBot.create(:work_package, subject: 'Foo Bar Baz',
                                          project: project_2)
      end

      before do
        member_2

        work_package_4
      end

      context 'with cross project relations' do
        let(:project_id) { project.id }

        before do
          allow(Setting).to receive(:cross_project_work_package_relations?).and_return(true)

          get :index,
              params: {
                project_id: project_id,
                q: work_package_4.id,
                scope: scope
              }
        end

        context 'with scope "relatable"' do
          let(:scope) { 'relatable' }
          let(:expected_values) { work_package_4 }

          it_behaves_like 'successful response'

          it_behaves_like 'contains expected values'

          context 'without project_id' do
            let(:project_id) { nil }

            it 'returns HTTP Not Found' do
              expect(response.status).to eql(404)
            end
          end
        end

        context 'with scope "all"' do
          let(:scope) { 'all' }
          let(:expected_values) { work_package_4 }

          it_behaves_like 'successful response'

          it_behaves_like 'contains expected values'
        end
      end

      context 'without cross project relations' do
        before do
          allow(Setting).to receive(:cross_project_work_package_relations?).and_return(false)

          get :index,
              params: {
                project_id: project.id,
                q: work_package_4.id,
                scope: scope
              }
        end

        context 'with scope "relatable"' do
          let(:scope) { 'relatable' }
          let(:expected_values) { work_package_4 }

          it_behaves_like 'successful response'

          subject { assigns(:work_packages) }

          it { is_expected.to eq([]) }
        end

        context 'with scope "all"' do
          let(:scope) { 'all' }
          let(:expected_values) { work_package_4 }

          it_behaves_like 'successful response'

          it_behaves_like 'contains expected values'
        end
      end
    end
  end
end