openproject/spec/models/role_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"

RSpec.describe Role do
  let(:permissions) { %i[permission1 permission2] }
  let(:build_role) { build(:project_role, permissions:) }
  let(:created_role) { create(:project_role, permissions:) }

  it { is_expected.to validate_presence_of :name }
  it { is_expected.to validate_uniqueness_of(:name).case_insensitive }
  it { is_expected.to validate_length_of(:name).is_at_most(256) }

  describe ".create" do
    it "is prevented for type Role" do
      build_role.type = described_class.name

      expect(build_role.save).to be_falsey
    end
  end

  describe ".givable" do
    let!(:project_role) { create(:project_role) }
    let!(:non_member_role) { create(:non_member) }
    let!(:anonymous_role) { create(:anonymous_role) }
    let!(:work_package_role) { create(:work_package_role) }
    let!(:global_role) { create(:global_role) }

    it { expect(described_class.givable.to_a).to eql [project_role, work_package_role, global_role] }
  end

  describe "#by_permission" do
    it "returns roles with given permission" do
      created_role

      expect(Role.by_permission(permissions[0])).to include created_role
      expect(Role.by_permission(:some_other)).not_to include created_role
    end
  end

  describe "#permissions" do
    shared_examples_for "writing and reading" do
      it "returns the values written before" do
        perms = permissions + [:permission3]

        role.permissions = perms

        expect(role.permissions).to match_array(perms)
      end

      it "removes empty permissions" do
        perms = permissions + [""]

        role.permissions = perms

        expect(role.permissions).to match_array(permissions)
      end

      it "does not readd permissions" do
        perms = permissions + permissions.map(&:to_s)

        role.permissions = perms

        expect(role.permissions).to match_array(permissions)
      end

      it "allows clearing the permissions" do
        role.permissions = []

        expect(role.permissions).to be_empty
      end
    end

    context "for a non persisted role" do
      let(:role) { build_role }

      it_behaves_like "writing and reading"
    end

    context "for a persisted role" do
      let(:role) { created_role }

      it_behaves_like "writing and reading"
    end
  end

  describe "#remove_permission!" do
    shared_examples_for "removing" do
      it "removes the specified permission" do
        perm = permissions.first

        role.remove_permission!(perm)

        expect(role.role_permissions.map(&:permission)).not_to include perm.to_s
      end
    end

    context "for a non persisted role" do
      let(:role) { build_role }

      it_behaves_like "removing"
    end

    context "for a persisted role" do
      let(:role) { created_role }

      it_behaves_like "removing"
    end
  end

  describe "#add_permission!" do
    shared_examples_for "adding" do
      it "adds the specified permission" do
        role.add_permission!(:permission3)

        expect(role.role_permissions.map(&:permission)).to include "permission3"
      end
    end

    context "for a non persisted role" do
      let(:role) { build_role }

      it_behaves_like "adding"
    end

    context "for a persisted role" do
      let(:role) { created_role }

      it_behaves_like "adding"
    end
  end

  describe ".workflows.copy_from_role" do
    before do
      allow(Workflow)
        .to receive(:copy)
    end

    it "calls Workflow.copy" do
      build_role.workflows.copy_from_role(created_role)

      expect(Workflow)
        .to have_received(:copy)
              .with(nil, created_role, nil, build_role)
    end
  end
end