openproject/test/unit/version_test.rb

#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2015 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-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 doc/COPYRIGHT.rdoc for more details.
#++
require File.expand_path('../../test_helper', __FILE__)

class VersionTest < ActiveSupport::TestCase
  fixtures :all

  def test_create
    (v = Version.new.tap do |v|
      v.force_attributes = { project: Project.find(1), name: '1.1', effective_date: '2011-03-25' }
    end)
    assert v.save
    assert_equal 'open', v.status
  end

  def test_invalid_effective_date_validation
    (v = Version.new.tap do |v|
      v.force_attributes = { project: Project.find(1), name: '1.1', effective_date: '99999-01-01' }
    end)
    assert !v.save
    assert_include v.errors[:effective_date], I18n.translate('activerecord.errors.messages.not_a_date')
  end

  context '#start_date' do
    context 'with no value saved' do
      should 'be the date of the earlist issue' do
        project = Project.find(1)
        (v = Version.new.tap do |v|
          v.force_attributes = { project: project, name: 'Progress' }
        end).save!
        add_work_package(v, estimated_hours: 10, start_date: '2010-03-01')
        FactoryGirl.create(:work_package, project: project, subject: 'not assigned', start_date: '2010-01-01')

        assert_equal '2010-03-01', v.start_date.to_s
      end
    end

    context 'with a value saved' do
      should 'be the value' do
        project = Project.find(1)
        (v = Version.new.tap do |v|
          v.force_attributes = { project: project, name: 'Progress', start_date: '2010-01-05' }
        end).save!

        add_work_package(v, estimated_hours: 10, start_date: '2010-03-01')

        assert_equal '2010-01-05', v.start_date.to_s
      end
    end
  end

  def test_progress_should_be_0_with_no_assigned_issues
    project = Project.find(1)
    (v = Version.new.tap do |v|
      v.force_attributes = { project: project, name: 'Progress' }
    end).save!
    assert_equal 0, v.completed_percent
    assert_equal 0, v.closed_percent
  end

  def test_progress_should_be_0_with_unbegun_assigned_issues
    project = Project.find(1)
    (v = Version.new.tap do |v|
      v.force_attributes = { project: project, name: 'Progress' }
    end).save!
    add_work_package(v)
    add_work_package(v, done_ratio: 0)
    assert_progress_equal 0, v.completed_percent
    assert_progress_equal 0, v.closed_percent
  end

  def test_progress_should_be_100_with_closed_assigned_issues
    project = Project.find(1)
    status = Status.find(:first, conditions: { is_closed: true })
    (v = Version.new.tap do |v|
      v.force_attributes = { project: project, name: 'Progress' }
    end).save!
    add_work_package(v, status: status)
    add_work_package(v, status: status, done_ratio: 20)
    add_work_package(v, status: status, done_ratio: 70, estimated_hours: 25)
    add_work_package(v, status: status, estimated_hours: 15)
    assert_progress_equal 100.0, v.completed_percent
    assert_progress_equal 100.0, v.closed_percent
  end

  def test_progress_should_consider_done_ratio_of_open_assigned_issues
    project = Project.find(1)
    (v = Version.new.tap do |v|
      v.force_attributes = { project: project, name: 'Progress' }
    end).save!
    add_work_package(v)
    add_work_package(v, done_ratio: 20)
    add_work_package(v, done_ratio: 70)
    assert_progress_equal (0.0 + 20.0 + 70.0) / 3, v.completed_percent
    assert_progress_equal 0, v.closed_percent
  end

  def test_progress_should_consider_closed_issues_as_completed
    project = Project.find(1)
    (v = Version.new.tap do |v|
      v.force_attributes = { project: project, name: 'Progress' }
    end).save!
    add_work_package(v)
    add_work_package(v, done_ratio: 20)
    add_work_package(v, status: Status.find(:first, conditions: { is_closed: true }))
    assert_progress_equal (0.0 + 20.0 + 100.0) / 3, v.completed_percent
    assert_progress_equal (100.0) / 3, v.closed_percent
  end

  def test_progress_should_consider_estimated_hours_to_weigth_issues
    project = Project.find(1)
    (v = Version.new.tap do |v|
      v.force_attributes = { project: project, name: 'Progress' }
    end).save!
    add_work_package(v, estimated_hours: 10)
    add_work_package(v, estimated_hours: 20, done_ratio: 30)
    add_work_package(v, estimated_hours: 40, done_ratio: 10)
    add_work_package(v, estimated_hours: 25, status: Status.find(:first, conditions: { is_closed: true }))
    assert_progress_equal (10.0 * 0 + 20.0 * 0.3 + 40 * 0.1 + 25.0 * 1) / 95.0 * 100, v.completed_percent
    assert_progress_equal 25.0 / 95.0 * 100, v.closed_percent
  end

  def test_progress_should_consider_average_estimated_hours_to_weigth_unestimated_issues
    project = Project.find(1)
    (v = Version.new.tap do |v|
      v.force_attributes = { project: project, name: 'Progress' }
    end).save!
    add_work_package(v, done_ratio: 20)
    add_work_package(v, status: Status.find(:first, conditions: { is_closed: true }))
    add_work_package(v, estimated_hours: 10, done_ratio: 30)
    add_work_package(v, estimated_hours: 40, done_ratio: 10)
    assert_progress_equal (25.0 * 0.2 + 25.0 * 1 + 10.0 * 0.3 + 40.0 * 0.1) / 100.0 * 100, v.completed_percent
    assert_progress_equal 25.0 / 100.0 * 100, v.closed_percent
  end

  context '#behind_schedule?' do
    setup do
      ProjectCustomField.destroy_all # Custom values are a mess to isolate in tests
      @project = Project.generate!(identifier: 'test0')
      @project.types << Type.generate!

      (@version = Version.new.tap do |v|
        v.force_attributes = { project: @project, effective_date: nil, name: 'test' }
      end).save!
    end

    should 'be false if there are no issues assigned' do
      @version.update_attribute(:effective_date, Date.yesterday)
      assert_equal false, @version.behind_schedule?
    end

    should 'be false if there is no effective_date' do
      assert_equal false, @version.behind_schedule?
    end

    should 'be false if all of the issues are ahead of schedule' do
      @version.update_attribute(:effective_date, 7.days.from_now.to_date)
      @version.fixed_issues = [
        FactoryGirl.create(:work_package, project: @project, start_date: 7.days.ago, done_ratio: 60), # 14 day span, 60% done, 50% time left
        FactoryGirl.create(:work_package, project: @project, start_date: 7.days.ago, done_ratio: 60) # 14 day span, 60% done, 50% time left
      ]
      assert_equal 60, @version.completed_percent
      assert_equal false, @version.behind_schedule?
    end

    should 'be true if any of the issues are behind schedule' do
      @version.update_attribute(:effective_date, 7.days.from_now.to_date)
      @version.fixed_issues = [
        FactoryGirl.create(:work_package, project: @project, start_date: 7.days.ago, done_ratio: 60), # 14 day span, 60% done, 50% time left
        FactoryGirl.create(:work_package, project: @project, start_date: 7.days.ago, done_ratio: 20) # 14 day span, 20% done, 50% time left
      ]
      assert_equal 40, @version.completed_percent
      assert_equal true, @version.behind_schedule?
    end

    should 'be false if all of the issues are complete' do
      @version.update_attribute(:effective_date, 7.days.from_now.to_date)
      @version.fixed_issues = [
        FactoryGirl.create(:work_package, project: @project, start_date: 14.days.ago, done_ratio: 100, status: Status.find(5)), # 7 day span
        FactoryGirl.create(:work_package, project: @project, start_date: 14.days.ago, done_ratio: 100, status: Status.find(5)) # 7 day span
      ]
      assert_equal 100, @version.completed_percent
      assert_equal false, @version.behind_schedule?
    end
  end

  context '#estimated_hours' do
    setup do
      (@version = Version.new.tap do |v|
        v.force_attributes = { project_id: 1, name: '#estimated_hours' }
      end).save!
    end

    should 'return 0 with no assigned issues' do
      assert_equal 0, @version.estimated_hours
    end

    should 'return 0 with no estimated hours' do
      add_work_package(@version)
      assert_equal 0, @version.estimated_hours
    end

    should 'return the sum of estimated hours' do
      add_work_package(@version, estimated_hours: 2.5)
      add_work_package(@version, estimated_hours: 5)
      assert_equal 7.5, @version.estimated_hours
    end

    should 'return the sum of leaves estimated hours' do
      parent = add_work_package(@version)
      add_work_package(@version, estimated_hours: 2.5, parent_id: parent.id)
      add_work_package(@version, estimated_hours: 5, parent_id: parent.id)
      assert_equal 7.5, @version.estimated_hours
    end
  end

  test "should update all issue's fixed_version associations in case the hierarchy changed XXX" do
    User.current = User.find(1) # Need the admin's permissions

    @version = Version.find(7)
    # Separate hierarchy
    project_1_issue = WorkPackage.find(1)
    project_1_issue.fixed_version = @version
    assert project_1_issue.save, project_1_issue.errors.full_messages.to_s

    project_5_issue = WorkPackage.find(6)
    project_5_issue.fixed_version = @version
    assert project_5_issue.save

    # Project
    project_2_issue = WorkPackage.find(4)
    project_2_issue.fixed_version = @version
    assert project_2_issue.save

    # Update the sharing
    @version.sharing = 'none'
    assert @version.save

    # Project 1 now out of the shared scope
    project_1_issue.reload
    assert_equal nil, project_1_issue.fixed_version, "Fixed version is still set after changing the Version's sharing"

    # Project 5 now out of the shared scope
    project_5_issue.reload
    assert_equal nil, project_5_issue.fixed_version, "Fixed version is still set after changing the Version's sharing"

    # Project 2 issue remains
    project_2_issue.reload
    assert_equal @version, project_2_issue.fixed_version
  end

  private

  def add_work_package(version, attributes = {})
    (v = WorkPackage.new.tap do |v|
      v.force_attributes = { project: version.project,
                             fixed_version: version,
                             subject: 'Test',
                             author: User.first,
                             type: version.project.types.first }.merge(attributes)
    end).save!

    v
  end

  def assert_progress_equal(expected_float, actual_float, _message = '')
    assert_in_delta(expected_float, actual_float, 0.000001, message = '')
  end
end