[PMSH] Delete Measurement Group API

API to delete MG when admin status allows

Issue-ID: DCAEGEN2-2921

Signed-off-by: egernug <gerard.nugent@est.tech>
Change-Id: I4116d0096baf2f803e965385eaeac11da97ac65e

3 files changed, 96 insertions, 0 deletions

diff --git a/components/pm-subscription-handler/pmsh_service/mod/api/controller.py b/components/pm-subscription-handler/pmsh_service/mod/api/controller.py
index 96fb1b79..7f4f28f5 100755
--- a/components/pm-subscription-handler/pmsh_service/mod/api/controller.py
+++ b/components/pm-subscription-handler/pmsh_service/mod/api/controller.py
@@ -22,6 +22,7 @@ from mod.api.services import subscription_service, measurement_group_service
 from connexion import NoContent
 from mod.api.custom_exception import InvalidDataException, DuplicateDataException, \
     DataConflictException
+from mod.subscription import AdministrativeState
 
 
 def status():
@@ -150,6 +151,43 @@ def get_meas_group_with_nfs(subscription_name, measurement_group_name):
                          f'{exception}'}, HTTPStatus.INTERNAL_SERVER_ERROR.value
 
 
+def delete_meas_group_by_name(subscription_name, measurement_group_name):
+    """Deletes the measurement group by name
+
+    Args:
+        subscription_name (String): Name of the subscription
+        measurement_group_name (String): Name of measurement group
+
+    Returns:
+          NoneType, HTTPStatus: None, 204
+          dict, HTTPStatus: measurement group not defined, 404
+          dict, HTTPStatus: Reason for not deleting measurement group, 409
+          dict, HTTPStatus: Exception details of failure, 500
+    """
+    logger.info(f'API call received to delete measurement group: {measurement_group_name}')
+    try:
+        measurement_group_administrative_status = \
+            measurement_group_service.query_get_meas_group_admin_status(subscription_name, measurement_group_name)
+        if measurement_group_administrative_status == AdministrativeState.LOCKED.value:
+            if measurement_group_service.query_to_delete_meas_group(subscription_name, measurement_group_name) == 1:
+                return None, HTTPStatus.NO_CONTENT
+            else:
+                logger.error(f'Measurement Group not found with name {measurement_group_name}')
+                return {'error': f'Measurement Group not found with name {measurement_group_name}'}, \
+                    HTTPStatus.NOT_FOUND.value
+        else:
+            logger.error('Measurement Group was not deleted because the Administrative State '
+                         f'was {measurement_group_administrative_status}')
+            return {'error': 'Measurement Group was not deleted because the Administrative State '
+                             'was {measurement_group_administrative_status}'}, \
+                HTTPStatus.CONFLICT.value
+    except Exception as e:
+        logger.error(f'Try again, measurement group {measurement_group_name} was not'
+                     f'deleted due to exception: {e}')
+        return {'error': f'Try again, measurement group {measurement_group_name} was not '
+                         f'deleted due to exception: {e}'}, HTTPStatus.INTERNAL_SERVER_ERROR.value
+
+
 def delete_subscription_by_name(subscription_name):
     """ Deletes the subscription by name
 
diff --git a/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml b/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
index 1c4c7927..274e0ebb 100644
--- a/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
+++ b/components/pm-subscription-handler/pmsh_service/mod/api/pmsh_swagger.yml
@@ -160,6 +160,32 @@ paths:
         500:
           description: Exception occurred while querying database
 
+    delete:
+      description: Delete a measurement group
+      operationId: mod.api.controller.delete_meas_group
+      tags:
+        - "measurement group"
+      parameters:
+        - name : subscription_name
+          in: path
+          required: true
+          description: Name of the subscription
+          type: string
+        - name: measurement_group_name
+          in: path
+          required: true
+          description: Name of the measurement group name
+          type: string
+      responses:
+        204:
+          description: Successfully deleted the measurement group and returns NO Content
+        404:
+          description: Measurement group with the specified name not found
+        409:
+          description: Measurement group not deleted because state UNLOCKED OR state change to LOCKED was under process
+        500:
+          description: Exception occurred on the server
+
   /subscription/{subscription_name}/measurementGroups/{measurement_group_name}/adminState:
     put:
       description: Update the admin status of the Measurement Group by using sub name and measurement group name
diff --git a/components/pm-subscription-handler/pmsh_service/mod/api/services/measurement_group_service.py b/components/pm-subscription-handler/pmsh_service/mod/api/services/measurement_group_service.py
index a1c141f8..998c0b19 100644
--- a/components/pm-subscription-handler/pmsh_service/mod/api/services/measurement_group_service.py
+++ b/components/pm-subscription-handler/pmsh_service/mod/api/services/measurement_group_service.py
@@ -158,6 +158,38 @@ def query_meas_group_by_name(subscription_name, measurement_group_name):
     return meas_group
 
 
+def query_to_delete_meas_group(subscription_name, measurement_group_name):
+    """
+    Deletes a measurement group by name
+
+    Args:
+        subscription_name (String): Name of the Subscription
+        measurement_group_name (String): Name of MG
+
+    Returns:
+        int: Returns '1' if subscription exists and deleted successfully else '0'
+    """
+    affected_rows = db.session.query(MeasurementGroupModel) \
+        .filter_by(subscription_name=subscription_name, measurement_group_name=measurement_group_name).delete()
+    db.session.commit()
+    return affected_rows
+
+
+def query_get_meas_group_admin_status(subscription_name, measurement_group_name):
+    """
+    Queries the administrative state by using subscription name and measurement group name
+
+    Args:
+        subscription_name (String): Name of the subscription.
+        measurement_group_name (String): Name of the measurement group
+
+    Returns:
+        administrative_state (String): Admin State (LOCKED, UNLOCKED, LOCKING)
+    """
+    meas_group = query_meas_group_by_name(subscription_name, measurement_group_name)
+    return meas_group.administrative_state
+
+
 def lock_nf_to_meas_grp(nf_name, measurement_group_name, status):
     """ Deletes a particular nf related to a measurement group name and
         if no more relations of nf exist to measurement group then delete nf from PMSH