openproject/spec_legacy/unit/project_spec.rb

#-- encoding: UTF-8

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2020 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-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_relative '../legacy_spec_helper'

describe Project, type: :model do
  fixtures :all

  before do
    @ecookbook = Project.find(1)
    @ecookbook_sub1 = Project.find(3)
    User.current = nil
  end

  it { is_expected.to validate_presence_of :name }
  it { is_expected.to validate_presence_of :identifier }

  it { is_expected.to validate_uniqueness_of :identifier }

  context 'associations' do
    it { is_expected.to have_many :members                                       }
    it { is_expected.to have_many(:users).through(:members)                      }
    it { is_expected.to have_many :member_principals                             }
    it { is_expected.to have_many(:principals).through(:member_principals)       }
    it { is_expected.to have_many :enabled_modules                               }
    it { is_expected.to have_many :work_packages                                 }
    it { is_expected.to have_many(:work_package_changes).through(:work_packages) }
    it { is_expected.to have_many :versions                                      }
    it { is_expected.to have_many :time_entries                                  }
    it { is_expected.to have_many :queries                                       }
    it { is_expected.to have_many :news                                          }
    it { is_expected.to have_many :categories                                    }
    it { is_expected.to have_many :forums                                        }
    it { is_expected.to have_many(:changesets).through(:repository)              }

    it { is_expected.to have_one :repository                                     }
    it { is_expected.to have_one :wiki                                           }

    it { is_expected.to have_and_belong_to_many :types                           }
    it { is_expected.to have_and_belong_to_many :work_package_custom_fields      }
  end

  it 'should truth' do
    assert_kind_of Project, @ecookbook
    assert_equal 'eCookbook', @ecookbook.name
  end

  it 'should update' do
    assert_equal 'eCookbook', @ecookbook.name
    @ecookbook.name = 'eCook'
    assert @ecookbook.save, @ecookbook.errors.full_messages.join('; ')
    @ecookbook.reload
    assert_equal 'eCook', @ecookbook.name
  end

  it 'should validate identifier' do
    to_test = { 'abc' => true,
                'ab12' => true,
                'ab-12' => true,
                'ab_12' => true,
                '12' => false,
                'new' => false }

    to_test.each do |identifier, valid|
      p = Project.new
      p.identifier = identifier
      p.valid?
      assert_equal valid, p.errors['identifier'].empty?
    end
  end

  it 'should members should be active users' do
    Project.all.each do |project|
      assert_nil project.members.detect { |m| !(m.principal.is_a?(User) && m.principal.active?) }
    end
  end

  it 'should users should be active users' do
    Project.all.each do |project|
      assert_nil project.users.detect { |u| !(u.is_a?(User) && u.active?) }
    end
  end

  it 'should parent' do
    p = Project.find(6).parent
    assert p.is_a?(Project)
    assert_equal 5, p.id
  end

  it 'should ancestors' do
    a = Project.find(6).ancestors
    assert a.first.is_a?(Project)
    assert_equal [1, 5], a.map(&:id).sort
  end

  it 'should root' do
    r = Project.find(6).root
    assert r.is_a?(Project)
    assert_equal 1, r.id
  end

  it 'should children' do
    c = Project.find(1).children
    assert c.first.is_a?(Project)
    # ignore ordering, since it depends on database collation configuration
    # and may order lowercase/uppercase chars in a different order
    assert_equal [3, 4, 5], c.map(&:id).sort!
  end

  it 'should descendants' do
    d = Project.find(1).descendants.pluck(:id)
    assert_equal [3,4,5,6], d.sort
  end

  it 'should users by role' do
    users_by_role = Project.find(1).users_by_role
    assert_kind_of Hash, users_by_role
    role = Role.find(1)
    assert_kind_of Array, users_by_role[role]
    assert users_by_role[role].include?(User.find(2))
  end

  it 'should rolled up types' do
    parent = Project.find(1)
    parent.types = ::Type.find([1, 2])
    child = parent.children.find(3)

    assert_equal [1, 2], parent.type_ids
    assert_equal [2, 3], child.types.map(&:id)

    assert_kind_of ::Type, parent.rolled_up_types.first

    assert_equal [999, 1, 2, 3], parent.rolled_up_types.map(&:id)
    assert_equal [2, 3], child.rolled_up_types.map(&:id)
  end

  it 'should rolled up types should ignore archived subprojects' do
    parent = Project.find(1)
    parent.types = ::Type.find([1, 2])
    child = parent.children.find(3)
    child.types = ::Type.find([1, 3])
    parent.children.each do |child|
      child.update(active: false)
      child.children.each do |grand_child|
        grand_child.update(active: false)
      end
    end

    assert_equal [1, 2], parent.rolled_up_types.map(&:id)
  end

  it 'should shared versions none sharing' do
    p = Project.find(5)
    v = Version.create!(name: 'none_sharing', project: p, sharing: 'none')
    assert p.shared_versions.include?(v)
    assert !p.children.first.shared_versions.include?(v)
    assert !p.root.shared_versions.include?(v)
    assert !p.siblings.first.shared_versions.include?(v)
    assert !p.root.siblings.first.shared_versions.include?(v)
  end

  it 'should shared versions descendants sharing' do
    p = Project.find(5)
    v = Version.create!(name: 'descendants_sharing', project: p, sharing: 'descendants')
    assert p.shared_versions.include?(v)
    assert p.children.first.shared_versions.include?(v)
    assert !p.root.shared_versions.include?(v)
    assert !p.siblings.first.shared_versions.include?(v)
    assert !p.root.siblings.first.shared_versions.include?(v)
  end

  it 'should shared versions hierarchy sharing' do
    p = Project.find(5)
    v = Version.create!(name: 'hierarchy_sharing', project: p, sharing: 'hierarchy')
    assert p.shared_versions.include?(v)
    assert p.children.first.shared_versions.include?(v)
    assert p.root.shared_versions.include?(v)
    assert !p.siblings.first.shared_versions.include?(v)
    assert !p.root.siblings.first.shared_versions.include?(v)
  end

  it 'should shared versions tree sharing' do
    p = Project.find(5)
    v = Version.create!(name: 'tree_sharing', project: p, sharing: 'tree')
    assert p.shared_versions.include?(v)
    assert p.children.first.shared_versions.include?(v)
    assert p.root.shared_versions.include?(v)
    assert p.siblings.first.shared_versions.include?(v)
    assert !p.root.siblings.first.shared_versions.include?(v)
  end

  it 'should shared versions system sharing' do
    p = Project.find(5)
    v = Version.create!(name: 'system_sharing', project: p, sharing: 'system')
    assert p.shared_versions.include?(v)
    assert p.children.first.shared_versions.include?(v)
    assert p.root.shared_versions.include?(v)
    assert p.siblings.first.shared_versions.include?(v)
    assert p.root.siblings.first.shared_versions.include?(v)
  end

  it 'should shared versions' do
    parent = Project.find(1)
    child = parent.children.find(3)
    private_child = parent.children.find(5)

    assert_equal [1, 2, 3], parent.version_ids.sort
    assert_equal [4], child.version_ids
    assert_equal [6], private_child.version_ids
    assert_equal [7], Version.where(sharing: 'system').map(&:id)

    assert_equal 6, parent.shared_versions.size
    parent.shared_versions.each do |version|
      assert_kind_of Version, version
    end

    assert_equal [1, 2, 3, 4, 6, 7], parent.shared_versions.map(&:id).sort
  end

  it 'should shared versions should ignore archived subprojects' do
    parent = Project.find(1)
    child = parent.children.find(3)
    child.update(active: false)
    parent.reload

    assert_equal [1, 2, 3], parent.version_ids.sort
    assert_equal [4], child.version_ids
    assert !parent.shared_versions.map(&:id).include?(4)
  end

  it 'should shared versions visible to user' do
    user = User.find(3)
    parent = Project.find(1)
    child = parent.children.find(5)

    assert_equal [1, 2, 3], parent.version_ids.sort
    assert_equal [6], child.version_ids

    versions = parent.shared_versions.visible(user)

    assert_equal 4, versions.size
    versions.each do |version|
      assert_kind_of Version, version
    end

    assert !versions.map(&:id).include?(6)
  end

  it 'should next identifier' do
    ProjectCustomField.delete_all
    Project.create!(name: 'last', identifier: 'p2008040')
    assert_equal 'p2008041', Project.next_identifier
  end

  it 'should next identifier first project' do
    Project.delete_all
    assert_nil Project.next_identifier
  end

  context 'with modules',
          with_settings: { default_projects_modules: ['work_package_tracking', 'repository'] } do
    it 'should enabled module names' do
      project = Project.new

      project.enabled_module_names = %w(work_package_tracking news)
      assert_equal %w(news work_package_tracking), project.enabled_module_names.sort
    end
  end

  it 'should enabled module names should not recreate enabled modules' do
    project = Project.find(1)
    # Remove one module
    modules = project.enabled_modules.to_a.slice(0..-2)
    assert modules.any?
    assert_difference 'EnabledModule.count', -1 do
      project.enabled_module_names = modules.map(&:name)
    end
    project.reload
    # Ids should be preserved
    assert_equal project.enabled_module_ids.sort, modules.map(&:id).sort
  end

  it 'should copy from existing project' do
    source_project = Project.find(1)
    copied_project = Project.copy(1)

    assert copied_project
    # Cleared attributes
    assert copied_project.id.blank?
    assert copied_project.name.blank?
    assert copied_project.identifier.blank?

    # Duplicated attributes
    assert_equal source_project.description, copied_project.description
    assert_equal (source_project.enabled_module_names.sort - %w[repository]), copied_project.enabled_module_names.sort
    assert_equal source_project.types, copied_project.types

    # Default attributes
    assert copied_project.active
  end

  it 'should close completed versions' do
    Version.update_all("status = 'open'")
    project = Project.find(1)
    refute_nil project.versions.detect { |v| v.completed? && v.status == 'open' }
    refute_nil project.versions.detect { |v| !v.completed? && v.status == 'open' }
    project.close_completed_versions
    project.reload
    assert_nil project.versions.detect { |v| v.completed? && v.status != 'closed' }
    refute_nil project.versions.detect { |v| !v.completed? && v.status == 'open' }
  end

  it 'should export work packages is allowed' do
    project = Project.find(1)
    assert project.allows_to?(:export_work_packages)
  end

  context 'Project#copy' do
    before do
      ProjectCustomField.destroy_all # Custom values are a mess to isolate in tests
      Project.where(identifier: 'copy-test').destroy_all
      @source_project = Project.find(2)
      @project = Project.new(name: 'Copy Test', identifier: 'copy-test')
      @project.types = @source_project.types
      @project.enabled_module_names = @source_project.enabled_modules.map(&:name)
    end

    it 'should copy work units' do
      work_package = FactoryBot.create(:work_package,
                                       status: Status.find_by_name('Closed'),
                                       subject: 'copy issue status',
                                       type_id: 1,
                                       assigned_to_id: 2,
                                       project_id: @source_project.id)

      @source_project.work_packages << work_package
      assert @project.valid?
      assert @project.work_packages.empty?
      assert @project.copy(@source_project)

      assert_equal @source_project.work_packages.size, @project.work_packages.size
      @project.work_packages.each do |issue|
        assert issue.valid?
        assert !issue.assigned_to.blank?
        assert_equal @project, issue.project
      end

      copied_issue = @project.work_packages.find_by(subject: 'copy issue status')
      assert copied_issue
      assert copied_issue.status
      assert_equal 'Closed', copied_issue.status.name
    end

    it 'should change the new issues to use the copied version' do
      User.current = User.find(1)
      assigned_version = FactoryBot.create(:version, name: 'Assigned Issues', status: 'open')
      @source_project.versions << assigned_version
      assert_equal 3, @source_project.versions.size
      FactoryBot.create(:work_package, project: @source_project,
                                        version_id: assigned_version.id,
                                        subject: 'change the new issues to use the copied version',
                                        type_id: 1,
                                        project_id: @source_project.id)

      assert @project.copy(@source_project)
      @project.reload
      copied_issue = @project.work_packages.find_by(subject: 'change the new issues to use the copied version')

      assert copied_issue
      assert copied_issue.version
      assert_equal 'Assigned Issues', copied_issue.version.name # Same name
      refute_equal assigned_version.id, copied_issue.version.id # Different record
    end

    it 'should change the new issues to use the copied closed version' do
      User.current = User.find(1)
      assigned_version = FactoryBot.create(:version, name: 'Assigned Issues', status: 'open')
      @source_project.versions << assigned_version
      assert_equal 3, @source_project.versions.size
      FactoryBot.create(:work_package, project: @source_project,
                                        version_id: assigned_version.id,
                                        subject: 'change the new issues to use the copied version',
                                        type_id: 1,
                                        project_id: @source_project.id)
      assigned_version.update_attribute(:status, 'closed')

      assert @project.copy(@source_project)
      @project.reload
      copied_issue = @project.work_packages.find_by(subject: 'change the new issues to use the copied version')

      assert copied_issue
      assert copied_issue.version
      assert_equal 'Assigned Issues', copied_issue.version.name # Same name
      refute_equal assigned_version.id, copied_issue.version.id # Different record
    end

    it 'should copy issue relations' do
      Setting.cross_project_work_package_relations = '1'

      second_issue = FactoryBot.create(:work_package, status_id: 5,
                                        subject: 'copy issue relation',
                                        type_id: 1,
                                        assigned_to_id: 2,
                                        project_id: @source_project.id)
      source_relation = FactoryBot.create(:relation, from: WorkPackage.find(4),
                                           to: second_issue,
                                           relation_type: 'relates')
      source_relation_cross_project = FactoryBot.create(:relation, from: WorkPackage.find(1),
                                                         to: second_issue,
                                                         relation_type: 'duplicates')

      assert @project.copy(@source_project)
      assert_equal @source_project.work_packages.count, @project.work_packages.count
      copied_issue = @project.work_packages.find_by(subject: 'Issue on project 2') # Was #4
      copied_second_issue = @project.work_packages.find_by(subject: 'copy issue relation')

      # First issue with a relation on project
      # copied relation + reflexive relation
      assert_equal 2, copied_issue.relations.size, 'Relation not copied'
      copied_relation = copied_issue.relations.direct.first
      assert_equal 'relates', copied_relation.relation_type
      assert_equal copied_second_issue.id, copied_relation.to_id
      refute_equal source_relation.id, copied_relation.id

      # Second issue with a cross project relation
      # copied relation + reflexive relation
      assert_equal 3, copied_second_issue.relations.size, 'Relation not copied'
      copied_relation = copied_second_issue.relations.direct.find { |r| r.relation_type == 'duplicates' }
      assert_equal 'duplicates', copied_relation.relation_type
      assert_equal 1, copied_relation.from_id, 'Cross project relation not kept'
      refute_equal source_relation_cross_project.id, copied_relation.id
    end

    it 'should copy memberships' do
      assert @project.valid?
      assert @project.members.empty?
      assert @project.copy(@source_project)

      assert_equal @source_project.memberships.size, @project.memberships.size
      @project.memberships.each do |membership|
        assert membership
        assert_equal @project, membership.project
      end
    end

    it 'should copy memberships with groups and additional roles' do
      group = Group.create!(lastname: 'Copy group')
      user = User.find(7)

      group.users << user

      # group role
      (Member.new.tap do |m|
        m.attributes = { project_id: @source_project.id,
                         principal: group,
                         role_ids: [2] }
      end).save!

      member = Member.find_by(user_id: user.id, project_id: @source_project.id)
      # additional role
      member.role_ids = [1]

      assert @project.copy(@source_project)
      member = Member.find_by(user_id: user.id, project_id: @project.id)
      refute_nil member
      assert_equal [1, 2], member.roles.all.map(&:id).sort
    end

    it 'should copy project specific queries' do
      assert @project.valid?
      assert @project.queries.empty?
      assert @project.copy(@source_project)

      assert_equal @source_project.queries.size, @project.queries.size
      @project.queries.each do |query|
        assert query
        assert_equal @project, query.project
      end
    end

    it 'should copy versions' do
      @source_project.versions << FactoryBot.create(:version)
      @source_project.versions << FactoryBot.create(:version)

      assert @project.versions.empty?
      assert @project.copy(@source_project)

      assert_equal @source_project.versions.size, @project.versions.size
      @project.versions.each do |version|
        assert version
        assert_equal @project, version.project
      end
    end

    it 'should copy wiki' do
      assert_difference 'Wiki.count' do
        assert @project.copy(@source_project)
      end

      assert @project.wiki
      refute_equal @source_project.wiki, @project.wiki
      assert_equal 'Start page', @project.wiki.start_page
    end

    it 'should copy wiki pages and content with hierarchy' do
      assert_difference 'WikiPage.count', @source_project.wiki.pages.size do
        assert @project.copy(@source_project)
      end

      assert @project.wiki
      assert_equal @source_project.wiki.pages.size, @project.wiki.pages.size

      @project.wiki.pages.each do |wiki_page|
        assert wiki_page.content
        assert !@source_project.wiki.pages.include?(wiki_page)
      end

      parent = @project.wiki.find_page('Parent page')
      child1 = @project.wiki.find_page('Child page 1')
      child2 = @project.wiki.find_page('Child page 2')
      assert_equal parent, child1.parent
      assert_equal parent, child2.parent
    end

    it 'should copy issue categories' do
      assert @project.copy(@source_project)

      assert_equal 2, @project.categories.size
      @project.categories.each do |category|
        assert !@source_project.categories.include?(category)
      end
    end

    it 'should copy forums' do
      assert @project.copy(@source_project)

      assert_equal 1, @project.forums.size
      @project.forums.each do |forum|
        assert !@source_project.forums.include?(forum)
      end
    end

    it 'should change the new issues to use the copied issue categories' do
      issue = WorkPackage.find(4)
      issue.update_attribute(:category_id, 3)

      assert @project.copy(@source_project)

      @project.work_packages.each do |issue|
        assert issue.category
        assert_equal 'Stock management', issue.category.name # Same name
        refute_equal Category.find(3), issue.category # Different record
      end
    end

    it 'should limit copy with :only option' do
      assert @project.members.empty?
      assert @project.categories.empty?
      assert @source_project.work_packages.any?

      assert @project.copy(@source_project, only: ['members', 'categories'])

      assert @project.members.any?
      assert @project.categories.any?
      assert @project.work_packages.empty?
    end
  end
end