feature(delete device): admin user can delete device (#439)

- enable deletion of a device by admin
  - add migrations file for adding state column to devices table
  - add tests
[finishes #166540045]

Author: koitoror

alembic/versions/af8e4f84b552_add_state_column_to_devices_table.py

@@ -0,0 +1,28 @@
+"""add state column to devices table
+
+Revision ID: af8e4f84b552
+Revises: 1f5e47273894
+Create Date: 2019-06-21 12:01:57.913494
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'af8e4f84b552'
+down_revision = '1f5e47273894'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('devices', sa.Column('state', sa.Enum('active', 'archived', 'deleted', name='statetype'), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('devices', 'state')
+    # ### end Alembic commands ###

api/devices/models.py

@@ -1,10 +1,10 @@
-from sqlalchemy import (Column, String, Integer, DateTime, ForeignKey)
+from sqlalchemy import (Column, String, Integer, DateTime, ForeignKey, Enum)
 from sqlalchemy.schema import Sequence
 from sqlalchemy.orm import relationship
 
 from helpers.database import Base
 from utilities.validations import validate_empty_fields
-from utilities.utility import Utility
+from utilities.utility import Utility, StateType
 
 
 class Devices(Base, Utility):
@@ -17,6 +17,7 @@ class Devices(Base, Utility):
     location = Column(String, nullable=False)
     room_id = Column(Integer, ForeignKey('rooms.id', ondelete="CASCADE"))
     room = relationship('Room')
+    state = Column(Enum(StateType), default="active")
 
     def __init__(self, **kwargs):
         validate_empty_fields(**kwargs)

api/devices/schema.py

@@ -84,6 +84,30 @@ def mutate(self, info, device_id, **kwargs):
         return UpdateDevice(device=exact_device)
 
 
+class DeleteDevice(graphene.Mutation):
+    """
+         Returns device payload on deleting a device
+    """
+    class Arguments:
+        device_id = graphene.Int(required=True)
+        state = graphene.String()
+
+    device = graphene.Field(Devices)
+
+    @Auth.user_roles('Admin')
+    def mutate(self, info, device_id, **kwargs):
+        query_device = Devices.get_query(info)
+        result = query_device.filter(DevicesModel.state == "active")
+        exact_device = result.filter(
+            DevicesModel.id == device_id
+        ).first()
+        if not exact_device:
+            raise GraphQLError("Device not found")
+        update_entity_fields(exact_device, state="archived", **kwargs)
+        exact_device.save()
+        return DeleteDevice(device=exact_device)
+
+
 class Query(graphene.ObjectType):
     """
         Query to get list of all devices
@@ -167,3 +191,8 @@ class Mutation(graphene.ObjectType):
             \n- location: The location of the device\
             \n- room_id: Unique identifier of a room where the device is found\
             [required]")
+    delete_device = DeleteDevice.Field(
+        description="Deletes a given device given the arguments to delete\
+            \n- device_id: Unique identifier of the tag\
+            [required]"
+    )

fixtures/devices/devices_fixtures.py

@@ -203,7 +203,6 @@
     }
 }
 
-
 query_with_non_existant_id = '''
             mutation{
             updateDevice(
@@ -222,6 +221,28 @@
             }
 '''
 
+delete_device_mutation = '''
+            mutation{
+            deleteDevice(
+                deviceId:1
+            ){
+                device{
+                id
+                }
+            }
+            }
+'''
+
+delete_device_response = {
+  "data": {
+    "deleteDevice": {
+      "device": {
+        "id": "1"
+      }
+    }
+  }
+}
+
 create_device_query_invalid_room = '''
             mutation{
             createDevice(
@@ -240,7 +261,6 @@
 
 non_existant_id_response = "DeviceId not found"
 devices_query = '/mrm?query='+create_devices_query
-devices_query_response = b'{"data":{"createDevice":{"device":{"name":"Apple tablet","location":"Kenya","deviceType":"External Display"}}}}'  # noqaE501
 
 search_device_by_name = '''
     query{

tests/test_devices/test_delete_device.py

@@ -0,0 +1,14 @@
+from tests.base import BaseTestCase, CommonTestCases
+from fixtures.devices.devices_fixtures import (
+    delete_device_mutation,
+    delete_device_response
+)
+
+
+class TestDeleteDevices(BaseTestCase):
+    def test_delete_device(self):
+        CommonTestCases.admin_token_assert_equal(
+            self,
+            delete_device_mutation,
+            delete_device_response
+        )