Merge pull request #37 from edanalytics/feature/more-explicit-delete

Feature: notify user of endpoints to be deleted

Author: tomreitz

lightbeam/delete.py

@@ -17,11 +17,6 @@ def __init__(self, lightbeam=None):
 
     # Deletes data matching payloads in config.data_dir for selected endpoints
     def delete(self):
-        # prompt to confirm this destructive operation
-        if not self.lightbeam.config.get("force_delete", False):
-            if input('Type "yes" to confirm you want to delete payloads for the selected endpoints? ')!="yes":
-                exit('You did not type "yes" - exiting.')
-        
         # load swagger docs, so we can find natural keys for each resource and query the API for existing records to delete
         self.lightbeam.api.load_swagger_docs()
 
@@ -37,6 +32,9 @@ def delete(self):
         endpoints = copy.deepcopy(endpoints)
         endpoints.reverse()
 
+        # prompt to confirm this destructive operation
+        self.lightbeam.confirm_delete(endpoints)
+
         for endpoint in endpoints:
             # it doesn't seem possible to delete students once you've sent them
             # (I think because other entities may have referenced them in the meantime)

lightbeam/lightbeam.py

@@ -141,7 +141,21 @@ def meets_process_criteria(self, tuple):
                     or (self.newer_than and tuple[0]>self.newer_than)
                     or (len(self.resend_status_codes)>0 and tuple[1] in self.resend_status_codes)
                 )
+    
+    def _confirm_delete_op(self, endpoints, verbiage):
+        if self.config.get("force_delete", False):
+            return
+
+        endpoint_list = "\n\t - ".join(endpoints)
+        print(f'Preparing to delete the following endpoints:\n\t • {endpoint_list}')
+        if input(f'Type "yes" to confirm you want to {verbiage} payloads for the selected endpoints? ')!="yes":
+            exit('You did not type "yes" - exiting.')
+
+    def confirm_delete(self, endpoints):
+        self._confirm_delete_op(endpoints, "delete")
 
+    def confirm_truncate(self, endpoints):
+        self._confirm_delete_op(endpoints, "TRUNCATE ALL DATA")
 
     ################### Data discovery and loading methods ####################
 

lightbeam/truncate.py

@@ -17,18 +17,16 @@ def __init__(self, lightbeam=None):
 
     # Deletes all data in the Ed-Fi API for selected endpoints
     def truncate(self):
-        # prompt to confirm this destructive operation
-        if not self.lightbeam.config.get("force_delete", False):
-            if input('Type "yes" to confirm you want to TRUNCATE ALL DATA payloads for the selected endpoints? ')!="yes":
-                exit('You did not type "yes" - exiting.')
-        
         # get token with which to send requests
         self.lightbeam.api.do_oauth()
 
         # process endpoints in reverse-dependency order, so we don't get dependency errors
         endpoints = self.lightbeam.endpoints
         endpoints.reverse()
 
+        # prompt to confirm this destructive operation
+        self.lightbeam.confirm_truncate(endpoints)
+
         for endpoint in endpoints:
             # it doesn't seem possible to delete students once you've sent them
             # (I think because other entities may have referenced them in the meantime)