fix #82

Author: arthurgregorio

src/main/kotlin/br/com/webbudget/domain/entities/registration/MovementClass.kt

@@ -30,6 +30,10 @@ class MovementClass(
     var description: String? = null,
 ) : PersistentEntity<Long>() {
 
+    fun isForExpense() = type == Type.EXPENSE
+
+    fun isForIncome() = type == Type.INCOME
+
     enum class Type {
         INCOME, EXPENSE
     }

src/main/kotlin/br/com/webbudget/domain/projections/registration/BudgetAllocated.kt

@@ -0,0 +1,7 @@
+package br.com.webbudget.domain.projections.registration
+
+import java.math.BigDecimal
+
+interface BudgetAllocated {
+    val total: BigDecimal
+}

src/main/kotlin/br/com/webbudget/domain/validators/registration/BudgetLimitValidator.kt

@@ -0,0 +1,81 @@
+package br.com.webbudget.domain.validators.registration
+
+import br.com.webbudget.domain.entities.registration.MovementClass
+import br.com.webbudget.domain.entities.registration.MovementClass.Type
+import br.com.webbudget.domain.exceptions.BusinessException
+import br.com.webbudget.domain.validators.OnCreateValidation
+import br.com.webbudget.domain.validators.OnUpdateValidation
+import br.com.webbudget.infrastructure.repository.registration.MovementClassRepository
+import org.springframework.stereotype.Component
+import java.math.BigDecimal
+
+@Component
+@OnUpdateValidation
+@OnCreateValidation
+class BudgetLimitValidator(
+    private val movementClassRepository: MovementClassRepository
+) : MovementClassValidator {
+
+    override fun validate(value: MovementClass) {
+
+        // no budget limit, so the movement class is valid
+        if (value.budget == null) {
+            return
+        }
+
+        val costCenter = value.costCenter
+
+        // expenses have no budget limit, so the movement class is valid
+        if (value.isForExpense() && costCenter.expenseBudget == null) {
+            return
+        }
+
+        // incomes have no budget limit, so the movement class is valid
+        if (value.isForIncome() && costCenter.incomeBudget == null) {
+            return
+        }
+
+        // get the cost center budget based on the movement class type
+        val costCenterBudget = if (value.isForIncome()) {
+            costCenter.incomeBudget!!
+        } else {
+            costCenter.expenseBudget!!
+        }
+
+        if (value.isSaved()) {
+            this.validateSaved(value, costCenterBudget)
+        } else {
+            this.validateNotSaved(value, costCenterBudget)
+        }
+    }
+
+    private fun validateSaved(value: MovementClass, costCenterBudget: BigDecimal) {
+
+        val currentMovementClass = movementClassRepository.findByExternalId(value.externalId!!)
+            ?: error("Can't find movement class with external id [${value.externalId}]")
+
+        val allocatedBudget = movementClassRepository.findBudgetAllocatedByCostCenter(value.costCenter, value.type)
+
+        // before checking, remove the current movement class budget from the total allocated budget
+        val remainingBudget = costCenterBudget.subtract(allocatedBudget.total.subtract(currentMovementClass.budget!!))
+
+        check(value.budget!!, remainingBudget, value.type)
+    }
+
+    private fun validateNotSaved(value: MovementClass, costCenterBudget: BigDecimal) {
+
+        val allocatedBudget = movementClassRepository.findBudgetAllocatedByCostCenter(value.costCenter, value.type)
+        val remainingBudget = costCenterBudget.subtract(allocatedBudget.total)
+
+        check(value.budget!!, remainingBudget, value.type)
+    }
+
+    private fun check(budget: BigDecimal, remainingBudget: BigDecimal, type: Type) {
+        if (budget > remainingBudget) {
+            throw BusinessException(
+                "movement-class.errors.budget-limit-exceeded",
+                "Only [$remainingBudget] of income budget is available for [$type]"
+            )
+        }
+    }
+}

src/main/kotlin/br/com/webbudget/infrastructure/repository/registration/MovementClassRepository.kt

@@ -1,9 +1,13 @@
 package br.com.webbudget.infrastructure.repository.registration
 
+import br.com.webbudget.domain.entities.registration.CostCenter
 import br.com.webbudget.domain.entities.registration.MovementClass
+import br.com.webbudget.domain.entities.registration.MovementClass.Type
+import br.com.webbudget.domain.projections.registration.BudgetAllocated
 import br.com.webbudget.infrastructure.repository.BaseRepository
 import br.com.webbudget.infrastructure.repository.SpecificationHelpers
 import org.springframework.data.jpa.domain.Specification
+import org.springframework.data.jpa.repository.Query
 import org.springframework.stereotype.Repository
 import java.util.UUID
 
@@ -14,6 +18,16 @@ interface MovementClassRepository : BaseRepository<MovementClass> {
 
     fun findByNameIgnoreCaseAndExternalIdNot(name: String, externalId: UUID): MovementClass?
 
+    @Query(
+        """
+        select coalesce(sum(mc.budget), 0.0) as total 
+        from MovementClass mc 
+        where mc.costCenter = :costCenter
+        and mc.type = :type
+    """
+    )
+    fun findBudgetAllocatedByCostCenter(costCenter: CostCenter, type: Type): BudgetAllocated
+
     object Specifications : SpecificationHelpers {
 
         fun byName(name: String?) = Specification<MovementClass> { root, _, builder ->

src/test/kotlin/br/com/webbudget/services/registration/MovementClassServiceITest.kt

@@ -1,6 +1,8 @@
 package br.com.webbudget.services.registration
 
 import br.com.webbudget.BaseIntegrationTest
+import br.com.webbudget.domain.entities.registration.MovementClass
+import br.com.webbudget.domain.exceptions.BusinessException
 import br.com.webbudget.domain.exceptions.ConflictingPropertyException
 import br.com.webbudget.domain.services.registration.MovementClassService
 import br.com.webbudget.infrastructure.repository.registration.CostCenterRepository
@@ -11,10 +13,14 @@ import org.assertj.core.api.Assertions.assertThatThrownBy
 import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.fail
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.Arguments
+import org.junit.jupiter.params.provider.MethodSource
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.test.context.jdbc.Sql
 import java.math.BigDecimal
 import java.util.UUID
+import java.util.stream.Stream
 
 class MovementClassServiceITest : BaseIntegrationTest() {
 
@@ -148,4 +154,68 @@ class MovementClassServiceITest : BaseIntegrationTest() {
     fun `should fail to delete when in use`() {
         // TODO this should be done after the movement feature is created
     }
+
+    @Sql(
+        "/sql/registration/clear-tables.sql",
+        "/sql/registration/create-cost-centers.sql"
+    )
+    @ParameterizedTest
+    @MethodSource("movementClassesToCreate")
+    fun `should validate cost center budget limit on create`(toCreate: MovementClass) {
+
+        val costCenter = costCenterRepository.findByExternalId(UUID.fromString("3cb5732d-2551-4eb9-8b41-f5d312ba7aac"))
+            ?: fail { OBJECT_NOT_FOUND_ERROR }
+
+        toCreate.costCenter = costCenter
+
+        assertThatThrownBy { movementClassService.create(toCreate) }
+            .isInstanceOf(BusinessException::class.java)
+    }
+
+    @Sql(
+        "/sql/registration/clear-tables.sql",
+        "/sql/registration/create-cost-centers.sql",
+        "/sql/registration/create-movement-classes.sql"
+    )
+    @ParameterizedTest
+    @MethodSource("movementClassesToUpdate")
+    fun `should validate cost center budget limit on update`(externalId: UUID) {
+
+        val toUpdate = movementClassRepository.findByExternalId(externalId)
+            ?: fail { OBJECT_NOT_FOUND_ERROR }
+
+        toUpdate.apply {
+            this.budget = BigDecimal.valueOf(1001)
+        }
+
+        assertThatThrownBy { movementClassService.update(toUpdate) }
+            .isInstanceOf(BusinessException::class.java)
+    }
+
+    companion object {
+
+        @JvmStatic
+        fun movementClassesToCreate(): Stream<Arguments> = Stream.of(
+            Arguments.of(
+                createMovementClass(
+                    name = "Impostos",
+                    type = MovementClass.Type.EXPENSE,
+                    budget = BigDecimal.valueOf(1001),
+                )
+            ),
+            Arguments.of(
+                createMovementClass(
+                    name = "Trabalho como uber",
+                    type = MovementClass.Type.INCOME,
+                    budget = BigDecimal.valueOf(1001),
+                )
+            )
+        )
+
+        @JvmStatic
+        fun movementClassesToUpdate(): Stream<Arguments> = Stream.of(
+            Arguments.of(UUID.fromString("86158792-f34e-4cdf-bce6-44394d645d0d")),
+            Arguments.of(UUID.fromString("067e62d5-725f-44c6-bfdf-79f9cf19fff8"))
+        )
+    }
 }

src/test/resources/config/application-test.yml

@@ -18,3 +18,5 @@ logging:
   level:
     br.com.webbudget: debug
     org.springframework.web: trace
+    org.hibernate.SQL: debug
+    org.hibernate.type.descriptor.sql.BasicBinder: trace

src/test/resources/sql/registration/create-cost-centers.sql

@@ -1,3 +1,4 @@
 INSERT INTO registration.cost_centers (id, external_id, version, created_on, last_update, name, description, active)
-VALUES (999, '52e3456b-1b0d-42c5-8be0-07ddaecce441', 0, current_timestamp, current_timestamp, 'Outros',
-        'Centro de custo geral', true);
+VALUES (999, '52e3456b-1b0d-42c5-8be0-07ddaecce441', 0, current_timestamp, current_timestamp, 'Outros','Centro de custo geral', true);
+INSERT INTO registration.cost_centers (id, external_id, version, created_on, last_update, active, name, expense_budget, income_budget)
+VALUES(888, '3cb5732d-2551-4eb9-8b41-f5d312ba7aac', 0, current_timestamp, current_timestamp, true, 'Carro', 1000, 1000);

src/test/resources/sql/registration/create-movement-classes.sql

@@ -1,15 +1,14 @@
-INSERT INTO registration.movement_classes (external_id, version, created_on, last_update, active, name, type,
-                                           description, budget, id_cost_center)
-VALUES ('f21d94d2-d28e-4aa3-b12d-8a520023edd9', 0, current_timestamp, current_timestamp, true, 'Mercado', 'EXPENSE',
-        'Despesas no mercado', 2000.00, 999);
-
-INSERT INTO registration.movement_classes (external_id, version, created_on, last_update, active, name, type,
-                                           description, budget, id_cost_center)
-VALUES ('686f3fa3-6a08-4a5a-8587-d27b94a64097', 0, current_timestamp, current_timestamp, true, 'Conta de Luz',
-        'EXPENSE',
-        'Despesas com casa, conta de luz', 500, 999);
-
-INSERT INTO registration.movement_classes (external_id, version, created_on, last_update, active, name, type,
-                                           description, budget, id_cost_center)
-VALUES ('98cb4961-5cde-46fb-abfd-8461be7d628b', 0, current_timestamp, current_timestamp, true, 'Vendas', 'INCOME',
-        'Receita com vendas', 3500, 999);
+INSERT INTO registration.movement_classes (external_id, version, created_on, last_update, active, name, type,description, budget, id_cost_center)
+VALUES ('f21d94d2-d28e-4aa3-b12d-8a520023edd9', 0, current_timestamp, current_timestamp, true, 'Mercado', 'EXPENSE','Despesas no mercado', 2000.00, 999);
+
+INSERT INTO registration.movement_classes (external_id, version, created_on, last_update, active, name, type,description, budget, id_cost_center)
+VALUES ('686f3fa3-6a08-4a5a-8587-d27b94a64097', 0, current_timestamp, current_timestamp, true, 'Conta de Luz','EXPENSE','Despesas com casa, conta de luz', 500, 999);
+
+INSERT INTO registration.movement_classes (external_id, version, created_on, last_update, active, name, type,description, budget, id_cost_center)
+VALUES ('98cb4961-5cde-46fb-abfd-8461be7d628b', 0, current_timestamp, current_timestamp, true, 'Vendas', 'INCOME','Receita com vendas', 3500, 999);
+
+INSERT INTO registration.movement_classes (external_id, version, created_on, last_update, active, name, type, budget,id_cost_center)
+VALUES ('86158792-f34e-4cdf-bce6-44394d645d0d', 0, current_timestamp, current_timestamp, true, 'Manutenção', 'EXPENSE',500, 888);
+
+INSERT INTO registration.movement_classes (external_id, version, created_on, last_update, active, name, type, budget,id_cost_center)
+VALUES ('067e62d5-725f-44c6-bfdf-79f9cf19fff8', 0, current_timestamp, current_timestamp, true, 'Aluguel','INCOME', 500, 888);