openproject/spec/contracts/work_packages/create_contract_spec.rb

# frozen_string_literal: true

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 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 COPYRIGHT and LICENSE files for more details.
#++

require "spec_helper"
require "contracts/work_packages/shared_contract_examples"

RSpec.describe WorkPackages::CreateContract do
  include_context "work package contract"

  let(:work_package) do
    WorkPackage.new(project: persisted_project,
                    subject: "Some subject",
                    type: persisted_type,
                    priority: persisted_priority,
                    status: persisted_status) do |wp|
      wp.extend(OpenProject::ChangedBySystem)

      wp.change_by_system do
        wp.author = user
      end
    end
  end
  let(:other_project) { build_stubbed(:project) }
  let(:user) { persisted_user }
  let(:permissions) { %i[add_work_packages assign_versions] }

  subject(:contract) { described_class.new(work_package, user) }

  describe "validations" do
    context "when user allowed in project and project specified" do
      it_behaves_like "contract is valid"
    end

    context "when user not allowed in project and project specified" do
      let(:permissions) { [] }

      it_behaves_like "contract is invalid", base: :error_unauthorized
    end

    context "when user not allowed in any project and no project specified" do
      before do
        work_package.project = nil
      end

      # But no error_unauthorized
      it_behaves_like "contract is invalid", project: :blank
    end

    context "when user not allowed in any projects and no project specified" do
      let(:permissions) { [] }

      before do
        work_package.project = nil
      end

      it_behaves_like "contract is invalid", base: :error_unauthorized
    end
  end

  describe "writing read-only attributes" do
    let(:validated_contract) do
      contract = subject
      contract.validate
      contract
    end

    shared_examples "can write" do |attribute, value|
      it "can write #{attribute}", :aggregate_failures do
        expect(contract.writable_attributes).to include(attribute.to_s)

        work_package.send(:"#{attribute}=", value)
        expect(validated_contract.errors[attribute]).to be_empty
      end
    end

    shared_examples "can not write" do |attribute, value|
      it "can not write #{attribute}", :aggregate_failures do
        expect(contract.writable_attributes).not_to include(attribute.to_s)

        work_package.send(:"#{attribute}=", value)
        expect(validated_contract).not_to be_valid
        expect(validated_contract.errors[attribute]).to include "was attempted to be written but is not writable."
      end
    end

    context "when enabled for admin", with_settings: { apiv3_write_readonly_attributes: true } do
      let(:user) { build_stubbed(:admin) }

      it_behaves_like "can write", :created_at, 1.day.ago
      it_behaves_like "can not write", :updated_at, 1.day.ago
      it_behaves_like "can write", :author_id, 1234
    end

    context "when disabled for admin", with_settings: { apiv3_write_readonly_attributes: false } do
      let(:user) { build_stubbed(:admin) }

      it_behaves_like "can not write", :created_at, 1.day.ago
      it_behaves_like "can not write", :updated_at, 1.day.ago
      it_behaves_like "can not write", :author_id, 1234
    end

    context "when enabled for regular user", with_settings: { apiv3_write_readonly_attributes: true } do
      it_behaves_like "can not write", :created_at, 1.day.ago
      it_behaves_like "can not write", :updated_at, 1.day.ago
      it_behaves_like "can not write", :author_id, 1234
    end

    context "when disabled for regular user", with_settings: { apiv3_write_readonly_attributes: false } do
      it_behaves_like "can not write", :created_at, 1.day.ago
      it_behaves_like "can not write", :updated_at, 1.day.ago
      it_behaves_like "can not write", :author_id, 1234
    end
  end

  describe "#assignable_assignees" do
    context "with a project set" do
      it "returns the users assignable" do
        expect(subject.assignable_assignees)
          .to contain_exactly(persisted_possible_assignee)
      end
    end

    context "without a project set" do
      before do
        work_package.project = nil
      end

      it "returns no users" do
        expect(subject.assignable_assignees)
          .to be_empty
      end
    end
  end

  describe "#assignable_responsibles" do
    context "with a project set" do
      it "returns the users assignable" do
        expect(subject.assignable_responsibles)
          .to contain_exactly(persisted_possible_assignee)
      end
    end

    context "without a project set" do
      before do
        work_package.project = nil
      end

      it "returns no users" do
        expect(subject.assignable_responsibles)
          .to be_empty
      end
    end
  end
end