openproject/spec/contracts/roles/shared_contract_examples.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"

RSpec.shared_examples_for "roles contract" do
  let(:current_user) do
    build_stubbed(:admin)
  end
  let(:role_instance) { Role.new }
  let(:role_name) { "A role name" }
  let(:role_permissions) { [:view_work_packages] }

  def expect_valid(valid, symbols = {})
    expect(contract.validate).to eq(valid)

    symbols.each do |key, arr|
      expect(contract.errors.symbols_for(key)).to match_array arr
    end
  end

  shared_examples "is valid" do
    it "is valid" do
      expect_valid(true)
    end
  end

  describe "validation" do
    it_behaves_like "is valid"

    context "if the name is nil" do
      let(:role_name) { nil }

      it "is invalid" do
        expect_valid(false, name: %i(blank))
      end
    end

    context "if the permissions do not include their dependency" do
      let(:role_permissions) { [:manage_members] }

      it "is invalid" do
        expect_valid(false, permissions: %i(dependency_missing))
      end

      context "when the dependency is hidden" do
        before do
          dependency_permission = OpenProject::AccessControl.permission(:view_members)
          allow(dependency_permission).to receive(:hidden?).and_return(true)
        end

        it "is valid" do
          expect_valid(true)
        end
      end
    end
  end

  describe "#assignable_permissions" do
    def permission(name:, public:, visible: true)
      OpenProject::AccessControl::Permission.new(name, {}, permissible_on: :dummy, public:, visible:)
    end
    let(:permission1) { permission(name: :perm1, public: false, visible: true) }
    let(:permission2) { permission(name: :perm2, public: true, visible: true) }
    let(:permission3) { permission(name: :perm3, public: false, visible: true) }
    let(:permission4) { permission(name: :perm4, public: false, visible: false) }

    let(:all_permissions) { [permission1, permission2, permission3, permission4] }
    let(:public_permissions) { [permission2] }
    let(:hidden_permissions) { [permission4] }

    context "for a project role" do
      before do
        allow(OpenProject::AccessControl).to receive_messages(project_permissions: all_permissions, public_permissions:)
      end

      it "is all project permissions" do
        expect(contract.assignable_permissions).to match_array(all_permissions - public_permissions - hidden_permissions)
      end
    end

    context "for a work package role" do
      let(:role) { work_package_role }

      before do
        allow(OpenProject::AccessControl).to receive(:work_package_permissions).and_return(all_permissions)
      end

      it "is all work package permissions" do
        expect(contract.assignable_permissions).to match_array(all_permissions - public_permissions - hidden_permissions)
      end
    end

    context "for a global role" do
      let(:role) { global_role }

      before do
        allow(OpenProject::AccessControl).to receive(:global_permissions).and_return(all_permissions)
      end

      it "is all the global permissions" do
        expect(contract.assignable_permissions).to match_array(all_permissions - public_permissions - hidden_permissions)
      end
    end
  end
end