openproject/modules/costs/spec/features/budgets/update_budget_spec.rb

#-- 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 File.expand_path(File.dirname(__FILE__) + '/../../spec_helper.rb')

describe 'updating a budget', type: :feature, js: true do
  let(:project) { FactoryBot.create :project_with_types, enabled_module_names: %i[costs_module] }
  let(:user) { FactoryBot.create :admin }
  let(:budget) { FactoryBot.create :cost_object, author: user, project: project }

  before do
    login_as(user)
  end

  describe 'with new cost items' do
    let(:cost_type) do
      FactoryBot.create :cost_type, name: 'Post-war', unit: 'cap', unit_plural: 'caps'
    end

    let(:budget_page) { Pages::EditBudget.new budget.id }

    before do
      project.add_member! user, FactoryBot.create(:role)

      FactoryBot.create :cost_rate, cost_type: cost_type, rate: 50.0
      FactoryBot.create :default_hourly_rate, user: user, rate: 25.0
    end

    it 'creates the cost items' do
      budget_page.visit!
      click_on 'Update'

      budget_page.add_unit_costs! 3, comment: 'Stimpak'
      budget_page.add_labor_costs! 5, user_name: user.name, comment: 'treatment'

      click_on 'Submit'
      expect(budget_page).to have_content('Successful update')

      budget_page.toggle_unit_costs!
      expect(page).to have_selector('tbody td.currency', text: '150.00 EUR')
      expect(budget_page.overall_unit_costs).to have_content '150.00 EUR'

      budget_page.toggle_labor_costs!
      expect(page).to have_selector('tbody td.currency', text: '125.00 EUR')
      expect(budget_page.labor_costs_at(1)).to have_content '125.00 EUR'
      expect(budget_page.overall_labor_costs).to have_content '125.00 EUR'
    end
  end

  describe 'with existing cost items' do
    let(:cost_type) do
      FactoryBot.create :cost_type, name: 'Post-war', unit: 'cap', unit_plural: 'caps'
    end

    let(:material_budget_item) do
      FactoryBot.create :material_budget_item, units: 3,
                        cost_type: cost_type,
                        cost_object: budget
    end

    let(:labor_budget_item) do
      FactoryBot.create :labor_budget_item, hours: 5,
                        user: user,
                        cost_object: budget
    end

    let(:budget_page) { Pages::EditBudget.new budget.id }

    before do
      project.add_member! user, FactoryBot.create(:role)

      FactoryBot.create :cost_rate, cost_type: cost_type, rate: 50.0
      FactoryBot.create :default_hourly_rate, user: user, rate: 25.0

      # trigger creation
      material_budget_item
      labor_budget_item
    end

    it 'updates the cost items' do
      budget_page.visit!
      click_on 'Update'

      budget_page.expect_planned_costs! type: :material, row: 1, expected: '150.00 EUR'
      budget_page.expect_planned_costs! type: :labor, row: 1, expected: '125.00 EUR'

      budget_page.edit_unit_costs! material_budget_item.id, units: 5,
                                   comment: 'updated num stimpaks'
      budget_page.edit_labor_costs! labor_budget_item.id, hours: 3,
                                    user_name: user.name,
                                    comment: 'updated treatment duration'

      # Test for updated planned costs (Regression #31247)
      budget_page.expect_planned_costs! type: :material, row: 1, expected: '250.00 EUR'
      budget_page.expect_planned_costs! type: :labor, row: 1, expected: '75.00 EUR'

      click_on 'Submit'
      expect(budget_page).to have_content('Successful update')

      budget_page.toggle_unit_costs!
      expect(page).to have_selector('tbody td.currency', text: '250.00 EUR')
      expect(budget_page.unit_costs_at(1)).to have_content '250.00 EUR'
      expect(budget_page.overall_unit_costs).to have_content '250.00 EUR'

      budget_page.toggle_labor_costs!
      expect(page).to have_selector('tbody td.currency', text: '75.00 EUR')
      expect(budget_page.labor_costs_at(1)).to have_content '75.00 EUR'
      expect(budget_page.overall_labor_costs).to have_content '75.00 EUR'
    end

    context 'with german locale' do
      let(:user) { FactoryBot.create :admin, language: :de }

      it 'retains the overridden budget when opening, but not editing (Regression #32822)' do
        budget_page.visit!
        click_on 'Bearbeiten'

        budget_page.expect_planned_costs! type: :material, row: 1, expected: '150,00 EUR'
        budget_page.expect_planned_costs! type: :labor, row: 1, expected: '125,00 EUR'

        # Open first item
        budget_page.open_edit_planned_costs! material_budget_item.id, type: :material
        expect(page).to have_field("cost_object_existing_material_budget_item_attributes_#{material_budget_item.id}_costs_edit")

        click_on 'OK'
        expect(budget_page).to have_content("Erfolgreich aktualisiert.")

        expect(page).to have_selector('tbody td.currency', text: '150,00 EUR')
        expect(page).to have_selector('tbody td.currency', text: '125,00 EUR')
      end
    end

    context 'with two material budget items' do
      let!(:material_budget_item_2) do
        FactoryBot.create :material_budget_item, units: 5,
                          cost_type: cost_type,
                          cost_object: budget
      end

      it 'keeps previous planned material costs (Regression test #27692)' do
        budget_page.visit!
        click_on 'Update'

        # Update first element
        budget_page.edit_planned_costs! material_budget_item.id, type: :material, costs: 123
        expect(budget_page).to have_content('Successful update')
        expect(page).to have_selector('tbody td.currency', text: '123.00 EUR')

        click_on 'Update'

        # Update second element
        budget_page.edit_planned_costs! material_budget_item_2.id, type: :material, costs: 543
        expect(budget_page).to have_content('Successful update')
        expect(page).to have_selector('tbody td.currency', text: '123.00 EUR')
        expect(page).to have_selector('tbody td.currency', text: '543.00 EUR')

        # Expect overridden costs on both
        material_budget_item.reload
        material_budget_item_2.reload

        # Expect budget == costs
        expect(material_budget_item.budget).to eq(123.0)
        expect(material_budget_item.overridden_budget?).to be_truthy
        expect(material_budget_item.costs).to eq(123.0)
        expect(material_budget_item_2.budget).to eq(543.0)
        expect(material_budget_item_2.overridden_budget?).to be_truthy
        expect(material_budget_item_2.costs).to eq(543.0)
      end

      context 'with a reversed currency format' do

        before do
          allow(Setting)
            .to receive(:plugin_openproject_costs)
            .and_return({costs_currency_format: '%u %n', costs_currency: 'USD'}.with_indifferent_access)
        end

        it 'can still update budgets (Regression test #32664)' do
          budget_page.visit!
          click_on 'Update'

          # Update first element
          budget_page.edit_planned_costs! material_budget_item.id, type: :material, costs: 123
          expect(budget_page).to have_content('Successful update')
          expect(page).to have_selector('tbody td.currency', text: 'USD 123.00')

          click_on 'Update'

          # Update second element
          budget_page.edit_planned_costs! material_budget_item_2.id, type: :material, costs: 543
          expect(budget_page).to have_content('Successful update')
          expect(page).to have_selector('tbody td.currency', text: 'USD 123.00')
          expect(page).to have_selector('tbody td.currency', text: 'USD 543.00')

          # Expect overridden costs on both
          material_budget_item.reload
          material_budget_item_2.reload

          # Expect budget == costs
          expect(material_budget_item.budget).to eq(123.0)
          expect(material_budget_item.overridden_budget?).to be_truthy
          expect(material_budget_item.costs).to eq(123.0)
          expect(material_budget_item_2.budget).to eq(543.0)
          expect(material_budget_item_2.overridden_budget?).to be_truthy
          expect(material_budget_item_2.costs).to eq(543.0)
        end
      end
    end

    context 'with two labor budget items' do
      let!(:labor_budget_item_2) do
        FactoryBot.create :labor_budget_item, hours: 5,
                          user: user,
                          cost_object: budget
      end

      it 'keeps previous planned labor costs (Regression test #27692)' do
        budget_page.visit!
        click_on 'Update'

        # Update first element
        budget_page.edit_planned_costs! labor_budget_item.id, type: :labor, costs: 456
        expect(budget_page).to have_content('Successful update')
        expect(page).to have_selector('tbody td.currency', text: '456.00 EUR')

        click_on 'Update'

        # Update second element
        budget_page.edit_planned_costs! labor_budget_item_2.id, type: :labor, costs: 987
        expect(budget_page).to have_content('Successful update')
        expect(page).to have_selector('tbody td.currency', text: '456.00 EUR')
        expect(page).to have_selector('tbody td.currency', text: '987.00 EUR')

        # Expect overridden costs on both
        labor_budget_item.reload
        labor_budget_item_2.reload

        # Expect budget == costs
        expect(labor_budget_item.budget).to eq(456.0)
        expect(labor_budget_item.overridden_budget?).to be_truthy
        expect(labor_budget_item.costs).to eq(456.0)
        expect(labor_budget_item_2.budget).to eq(987.0)
        expect(labor_budget_item_2.overridden_budget?).to be_truthy
        expect(labor_budget_item_2.costs).to eq(987.0)
      end

      context 'with a reversed currency format' do

        before do
          allow(Setting)
            .to receive(:plugin_openproject_costs)
            .and_return({costs_currency_format: '%u %n', costs_currency: 'USD'}.with_indifferent_access)
        end

        it 'can still update budgets (Regression test #32664)' do
          budget_page.visit!
          click_on 'Update'

          # Update first element
          budget_page.edit_planned_costs! labor_budget_item.id, type: :labor, costs: 456
          expect(budget_page).to have_content('Successful update')
          expect(page).to have_selector('tbody td.currency', text: 'USD 456.00')

          click_on 'Update'

          # Update second element
          budget_page.edit_planned_costs! labor_budget_item_2.id, type: :labor, costs: 987
          expect(budget_page).to have_content('Successful update')
          expect(page).to have_selector('tbody td.currency', text: 'USD 456.00')
          expect(page).to have_selector('tbody td.currency', text: 'USD 987.00')

          # Expect overridden costs on both
          labor_budget_item.reload
          labor_budget_item_2.reload

          # Expect budget == costs
          expect(labor_budget_item.budget).to eq(456.0)
          expect(labor_budget_item.overridden_budget?).to be_truthy
          expect(labor_budget_item.costs).to eq(456.0)
          expect(labor_budget_item_2.budget).to eq(987.0)
          expect(labor_budget_item_2.overridden_budget?).to be_truthy
          expect(labor_budget_item_2.costs).to eq(987.0)
        end
      end
    end

    it 'removes existing cost items' do
      budget_page.visit!

      click_on 'Update'

      page.find("#cost_object_existing_labor_budget_item_attributes_#{labor_budget_item.id} a.delete-budget-item").click
      click_on 'Submit'

      expect(budget_page.labor_costs_at(1)).not_to have_content '125.00 EUR'
    end
  end
end