feat: modify field name notifications -> notification

Signed-off-by: ImMin5 <[email protected]>

Author: ImMin5

src/spaceone/cost_analysis/error/budget.py

@@ -30,23 +30,21 @@ class ERROR_DATE_IS_WRONG(ERROR_INVALID_ARGUMENT):
 
 
 class ERROR_UNIT_IS_REQUIRED(ERROR_INVALID_ARGUMENT):
-    _message = (
-        "Unit is required for notifications (key = notifications, value = {value})"
-    )
+    _message = "Unit is required for notification (key = notification, value = {value})"
 
 
 class ERROR_NOTIFICATION_TYPE_IS_REQUIRED(ERROR_INVALID_ARGUMENT):
-    _message = "Notification type is required for notifications (key = notifications, value = {value})"
+    _message = "Notification type is required for notification (key = notification, value = {value})"
 
 
 class ERROR_THRESHOLD_IS_WRONG(ERROR_INVALID_ARGUMENT):
     _message = (
-        "Threshold must be greater than zero. (key = notifications, value = {value})"
+        "Threshold must be greater than zero. (key = notification, value = {value})"
     )
 
 
 class ERROR_THRESHOLD_IS_WRONG_IN_PERCENT_TYPE(ERROR_INVALID_ARGUMENT):
-    _message = "In percentage type, the threshold must be less than 100. (key = notifications, value = {value})"
+    _message = "In percentage type, the threshold must be less than 100. (key = notification, value = {value})"
 
 
 class ERROR_PROVIDER_FILTER_IS_EMPTY(ERROR_INVALID_ARGUMENT):

src/spaceone/cost_analysis/manager/budget_usage_manager.py

@@ -114,12 +114,12 @@ def notify_budget_usage(self, budget_vo: Budget) -> None:
         current_month = datetime.now(timezone.utc).strftime("%Y-%m")
         updated_plans = []
         is_changed = False
-        notifications = budget_vo.notifications
+        notification = budget_vo.notification
 
-        plans = notifications.plans or []
+        plans = notification.plans or []
 
         for plan in plans:
-            if current_month not in plan.notified_months:
+            if current_month not in budget_vo.notified_months:
                 unit = plan.unit
                 threshold = plan.threshold
                 is_notify = False
@@ -206,8 +206,14 @@ def notify_budget_usage(self, budget_vo: Budget) -> None:
                 updated_plans.append(plan.to_dict())
 
         if is_changed:
-            notifications.plans = updated_plans
-            budget_vo.update({"notifications": notifications.to_dict()})
+            notification.plans = updated_plans
+            budget_vo.update({"notifications": notification.to_dict()})
+
+    def delete_budget_usage_by_budget_vo(self, budget_vo: Budget) -> None:
+        budget_usage_vos = self.filter_budget_usages(
+            budget_id=budget_vo.budget_id, domain_id=budget_vo.domain_id
+        )
+        budget_usage_vos.delete()
 
     def _notify_message(
         self,
@@ -246,7 +252,7 @@ def _notify_message(
             budget_vo.domain_id,
             budget_vo.workspace_id,
             budget_vo.project_id,
-            budget_vo.notifications.recipients.to_dict(),
+            budget_vo.notification.recipients.to_dict(),
             service_account_id=budget_vo.service_account_id,
         )
 

src/spaceone/cost_analysis/model/budget/database.py

@@ -11,18 +11,13 @@ class PlannedLimit(EmbeddedDocument):
 class Plan(EmbeddedDocument):
     threshold = FloatField(required=True)
     unit = StringField(max_length=20, required=True, choices=["PERCENT", "ACTUAL_COST"])
-    notified_months = ListField(StringField(max_length=10))
 
     def to_dict(self):
         return dict(self.to_mongo())
 
 
 class Recipients(EmbeddedDocument):
     users = ListField(StringField(), default=[])
-    role_types = ListField(StringField(), default=[])
-    service_account_manager = StringField(
-        max_length=40, choices=["ENABLED", "DISABLED"], null=True, default=None
-    )
 
     def to_dict(self):
         return dict(self.to_mongo())
@@ -46,7 +41,9 @@ class Budget(MongoModel):
     time_unit = StringField(max_length=20, choices=["TOTAL", "MONTHLY"])
     start = StringField(required=True, max_length=7)
     end = StringField(required=True, max_length=7)
-    notifications = EmbeddedDocumentField(Notification)
+    notification = EmbeddedDocumentField(Notification)
+    notified_months = ListField(StringField(max_length=10))
+    utilization_rate = FloatField(null=True, default=0)
     tags = DictField(default={})
     resource_group = StringField(
         max_length=40, choices=["WORKSPACE", "PROJECT"]
@@ -65,7 +62,11 @@ class Budget(MongoModel):
             "name",
             "limit",
             "planned_limits",
-            "notifications",
+            "start",
+            "end",
+            "notification",
+            "notified_month",
+            "utilization_rate",
             "tags",
         ],
         "minimal_fields": [

src/spaceone/cost_analysis/model/budget/request.py

@@ -14,7 +14,7 @@ class BudgetCreateRequest(BaseModel):
     time_unit: TimeUnit
     start: str
     end: str
-    notifications: Union[dict, None] = None
+    notification: Union[dict, None] = None
     tags: Union[dict, None] = None
     resource_group: ResourceGroup
     service_account_id: Union[str, None] = None
@@ -28,14 +28,16 @@ class BudgetUpdateRequest(BaseModel):
     name: Union[str, None] = None
     limit: Union[float, None] = None
     planned_limits: Union[list, None] = None
+    start: Union[str, None] = None
+    end: Union[str, None] = None
     tags: Union[dict, None] = None
     workspace_id: str
     domain_id: str
 
 
 class BudgetSetNotificationRequest(BaseModel):
     budget_id: str
-    notifications: dict
+    notification: dict
     project_id: Union[str, None] = None
     workspace_id: str
     domain_id: str

src/spaceone/cost_analysis/model/budget/response.py

@@ -32,7 +32,8 @@ class BudgetResponse(BaseModel):
     time_unit: Union[str, None] = None
     start: Union[str, None] = None
     end: Union[str, None] = None
-    notifications: Union[Notification, dict] = None
+    notification: Union[Notification, dict] = None
+    utilization_rate: Union[float, None] = None
     tags: Union[dict, None] = None
     resource_group: Union[ResourceGroup, None] = None
     service_account_id: Union[str, None] = None

src/spaceone/cost_analysis/model/budget_usage/request.py

@@ -6,31 +6,6 @@
 ResourceGroup = Literal["WORKSPACE", "PROJECT"]
 
 
-class BudgetCreateRequest(BaseModel):
-    data_source_id: str
-    name: str
-    limit: Union[float, None] = None
-    planned_limits: Union[list, None] = None
-    currency: Union[str, None] = None
-    time_unit: TimeUnit
-    start: str
-    end: str
-    notifications: Union[dict, None] = None
-    tags: Union[dict, None] = None
-    resource_group: ResourceGroup
-    service_account_id: Union[str, None] = None
-    project_id: Union[str, None] = None
-    workspace_id: Union[str, None] = None
-    domain_id: str
-
-
-class BudgetDeleteRequest(BaseModel):
-    budget_id: str
-    workspace_id: str
-    domain_id: str
-    user_projects: Union[str, None] = None
-
-
 class BudgetUsageSearchQueryRequest(BaseModel):
     query: dict
     workspace_id: Union[str, None] = None

src/spaceone/cost_analysis/service/budget_service.py

@@ -43,7 +43,7 @@ def create(self, params: BudgetCreateRequest) -> Union[BudgetResponse, dict]:
                 'time_unit': 'str',         # required
                 'start': 'str',             # required
                 'end': 'str',               # required
-                'notifications': 'dict',
+                'notification': 'dict',
                 'tags': 'dict',
                 'resource_group': 'str',    # required
                 'project_id': 'str',
@@ -65,14 +65,14 @@ def create(self, params: BudgetCreateRequest) -> Union[BudgetResponse, dict]:
         start = params.start
         end = params.end
 
-        notifications = params.notifications or {}
+        notification = params.notification or {}
         resource_group = params.resource_group
 
-        self._check_time_period(start, end)
-
         if resource_group != "PROJECT":
             raise ERROR_NOT_IMPLEMENTED()
 
+        self._check_time_period(start, end)
+
         identity_mgr: IdentityManager = self.locator.get_manager("IdentityManager")
         identity_mgr.check_workspace(workspace_id, domain_id)
         identity_mgr.get_project(project_id, domain_id)
@@ -101,8 +101,8 @@ def create(self, params: BudgetCreateRequest) -> Union[BudgetResponse, dict]:
             for planned_limit in planned_limits:
                 params.limit += planned_limit.get("limit", 0)
 
-        # Check Notifications
-        self._check_notifications(notifications, domain_id, workspace_id)
+        # Check Notification
+        self._check_notification(notification, domain_id, workspace_id)
 
         # Check Duplicated Budget
         budget_vos = self.budget_mgr.filter_budgets(
@@ -144,6 +144,8 @@ def update(self, params: BudgetUpdateRequest) -> Union[BudgetResponse, dict]:
                 'name': 'str',
                 'limit': 'float',
                 'planned_limits': 'list',
+                'start': 'str',
+                'end': 'str',
                 'tags': 'dict'
                 'workspace_id', 'str',      # injected from auth (optional)
                 'domain_id': 'str'          # injected from auth
@@ -164,12 +166,28 @@ def update(self, params: BudgetUpdateRequest) -> Union[BudgetResponse, dict]:
             budget_id, domain_id, workspace_id
         )
 
+        start = budget_vo.start
+        end = budget_vo.end
+
+        if params.start or params.end:
+            start = params.start or start
+            end = params.end or end
+            self._check_time_period(start, end)
+            planned_limits = planned_limits or budget_vo.planned_limits
+
         # Check limit and Planned Limits
+        if planned_limits:
+            self._check_planned_limits(start, end, budget_vo.time_unit, planned_limits)
+
         budget_vo = self.budget_mgr.update_budget_by_vo(
             params.dict(exclude_unset=True), budget_vo
         )
 
-        if "name" in params:
+        # Update Budget Usages
+        if planned_limits:
+            budget_usage_mgr.delete_budget_usage_by_budget_vo(budget_vo)
+            budget_usage_mgr.create_budget_usages(budget_vo)
+        elif "name" in params:
             budget_usage_vos = budget_usage_mgr.filter_budget_usages(
                 budget_id=budget_id,
                 domain_id=domain_id,
@@ -197,7 +215,7 @@ def set_notification(
         Args:
             params (dict): {
                 'budget_id': 'str',
-                'notifications': 'dict',
+                'notification': 'dict',
                 'workspace_id': 'str',
                 'domain_id': 'str'
                 'user_projects': 'list'
@@ -210,15 +228,15 @@ def set_notification(
         project_id = params.project_id
         workspace_id = params.workspace_id
         domain_id = params.domain_id
-        notifications = params.notifications or {}
+        notification = params.notification or {}
 
         budget_vo: Budget = self.budget_mgr.get_budget(
             budget_id, domain_id, workspace_id, project_id
         )
 
-        # Check Notifications
-        self._check_notifications(notifications, domain_id, workspace_id)
-        params.notifications = notifications
+        # Check notification
+        self._check_notification(notification, domain_id, workspace_id)
+        params.notification = notification
 
         budget_vo = self.budget_mgr.update_budget_by_vo(
             params.dict(exclude_unset=True), budget_vo
@@ -356,7 +374,14 @@ def _check_time_period(start, end):
         if start >= end:
             raise ERROR_INVALID_TIME_RANGE(start=start, end=end)
 
-    def _check_planned_limits(self, start, end, time_unit, planned_limits):
+    def _check_planned_limits(
+        self, start: str, end: str, time_unit: str, planned_limits: list
+    ):
+        if time_unit == "TOTAL":
+            raise ERROR_INVALID_PARAMETER(
+                key="time_unit", value=f"Only MONTHLY time_unit is allowed"
+            )
+
         planned_limits_dict = self._convert_planned_limits_data_type(planned_limits)
         date_format = "%Y-%m"
 
@@ -381,7 +406,7 @@ def _check_planned_limits(self, start, end, time_unit, planned_limits):
             raise ERROR_DATE_IS_WRONG(date=list(planned_limits_dict.keys()))
 
     @staticmethod
-    def _convert_planned_limits_data_type(planned_limits):
+    def _convert_planned_limits_data_type(planned_limits: list) -> dict:
         planned_limits_dict = {}
 
         for planned_limit in planned_limits:
@@ -398,12 +423,12 @@ def _convert_planned_limits_data_type(planned_limits):
         return planned_limits_dict
 
     @staticmethod
-    def _check_notifications(
-        notifications: dict,
+    def _check_notification(
+        notification: dict,
         domain_id: str,
         workspace_id: str,
     ) -> dict:
-        plans = notifications.get("plans", [])
+        plans = notification.get("plans", [])
 
         for plan in plans:
             unit = plan["unit"]
@@ -420,7 +445,7 @@ def _check_notifications(
                     raise ERROR_THRESHOLD_IS_WRONG_IN_PERCENT_TYPE(value=plan)
 
         # check recipients
-        recipients = notifications.get("recipients", {})
+        recipients = notification.get("recipients", {})
         users = list(set(recipients.get("users", [])))
         role_types = list(set(recipients.get("role_types", [])))
 
@@ -449,8 +474,8 @@ def _check_notifications(
                     raise ERROR_NOT_FOUND(key="user_id", value=user_id)
             recipients["users"] = users
 
-        notifications["recipients"] = recipients
-        return notifications
+        notification["recipients"] = recipients
+        return notification
 
     @staticmethod
     def _set_user_project_or_project_group_filter(params: dict) -> dict:

src/spaceone/cost_analysis/service/budget_usage_service.py

@@ -19,9 +19,7 @@ class BudgetUsageService(BaseService):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.budget_usage_mgr: BudgetUsageManager = self.locator.get_manager(
-            "BudgetUsageManager"
-        )
+        self.budget_usage_mgr = BudgetUsageManager()
 
     @transaction(
         permission="cost-analysis:BudgetUsage.read",