Added process_wait_limit variable to gam.cfg

src/GamUpdate.txt

@@ -4,6 +4,9 @@ Merged GAM-Team version
 
 6.63.01
 
+Added `process_wait_limit` variable to `gam.cfg` that controls how long (in seconds) GAM should wait for all batch|csv processes to complete
+after all have been started. If the limit is reached, GAM terminates any remaining processes. The default is 0 which specifies no limit.
+
 Following Jay's lead, added option `alwaysevict` to `gam create|update user` that is used to specify GAM's
 behavior when `verifynotinvitable` is not specified and there is a conflict with an unmanaged account.
 

src/gam/__init__.py

@@ -9457,7 +9457,8 @@ def MultiprocessGAMCommands(items, showCmds):
       if item[0] == Cmd.COMMIT_BATCH_CMD:
         batchWriteStderr(Msg.COMMIT_BATCH_WAIT_N_PROCESSES.format(currentISOformatTimeStamp(),
                                                                   numItems, poolProcessResults[0],
-                                                                  PROCESS_PLURAL_SINGULAR[poolProcessResults[0] == 1]))
+                                                                  PROCESS_PLURAL_SINGULAR[poolProcessResults[0] == 1]
+                                                                  ''))
         while poolProcessResults[0] > 0:
           time.sleep(1)
           completedProcesses = []
@@ -9512,10 +9513,16 @@ def MultiprocessGAMCommands(items, showCmds):
               del poolProcessResults[p]
             break
           time.sleep(1)
+    processWaitStart = time.time()
+    if GC.Values[GC.PROCESS_WAIT_LIMIT] > 0:
+      waitRemaining = GC.Values[GC.PROCESS_WAIT_LIMIT]
+    else:
+      waitRemaining = 'unlimited'
     while poolProcessResults[0] > 0:
       batchWriteStderr(Msg.BATCH_CSV_WAIT_N_PROCESSES.format(currentISOformatTimeStamp(),
                                                              numItems, poolProcessResults[0],
-                                                             PROCESS_PLURAL_SINGULAR[poolProcessResults[0] == 1]))
+                                                             PROCESS_PLURAL_SINGULAR[poolProcessResults[0] == 1],
+                                                             Msg.BATCH_CSV_WAIT_LIMIT.format(waitRemaining)))
       completedProcesses = []
       for p, result in iter(poolProcessResults.items()):
         if p != 0 and result.ready():
@@ -9525,8 +9532,20 @@ def MultiprocessGAMCommands(items, showCmds):
         del poolProcessResults[p]
       if poolProcessResults[0] > 0:
         time.sleep(5)
+        if GC.Values[GC.PROCESS_WAIT_LIMIT] > 0:
+          delta = int(time.time()-processWaitStart)
+          if delta >= GC.Values[GC.PROCESS_WAIT_LIMIT]:
+            batchWriteStderr(Msg.BATCH_CSV_TERMINATE_N_PROCESSES.format(currentISOformatTimeStamp(),
+                                                                        numItems, poolProcessResults[0],
+                                                                        PROCESS_PLURAL_SINGULAR[poolProcessResults[0] == 1]))
+            pool.terminate()
+            break
+          waitRemaining = GC.Values[GC.PROCESS_WAIT_LIMIT] - delta
   except KeyboardInterrupt:
     setSysExitRC(KEYBOARD_INTERRUPT_RC)
+    batchWriteStderr(Msg.BATCH_CSV_TERMINATE_N_PROCESSES.format(currentISOformatTimeStamp(),
+                                                                numItems, poolProcessResults[0],
+                                                                PROCESS_PLURAL_SINGULAR[poolProcessResults[0] == 1]))
     pool.terminate()
   else:
     pool.close()

src/gam/gamlib/glcfg.py

@@ -198,6 +198,8 @@ OUTPUT_DATEFORMAT = 'output_dateformat'
 OUTPUT_TIMEFORMAT = 'output_timeformat'
 # When retrieving lists of people from API, how many should be retrieved in each chunk
 PEOPLE_MAX_RESULTS = 'people_max_results'
+# Number of seconds to wait for batch/csv processes to complete
+PROCESS_WAIT_LIMIT = 'process_wait_limit'
 # Use quick method to move Chromebooks to OU
 QUICK_CROS_MOVE = 'quick_cros_move'
 # Quick info user: nogroups nolicenses noschemas
@@ -361,6 +363,7 @@ Defaults = {
   OUTPUT_DATEFORMAT: '',
   OUTPUT_TIMEFORMAT: '',
   PEOPLE_MAX_RESULTS: '100',
+  PROCESS_WAIT_LIMIT: '0',
   QUICK_CROS_MOVE: FALSE,
   QUICK_INFO_USER: FALSE,
   RESELLER_ID: '',
@@ -508,6 +511,7 @@ VAR_INFO = {
   OUTPUT_DATEFORMAT: {VAR_TYPE: TYPE_STRING, VAR_LIMITS: (0, None)},
   OUTPUT_TIMEFORMAT: {VAR_TYPE: TYPE_STRING, VAR_LIMITS: (0, None)},
   PEOPLE_MAX_RESULTS: {VAR_TYPE: TYPE_INTEGER, VAR_LIMITS: (0, 1000)},
+  PROCESS_WAIT_LIMIT: {VAR_TYPE: TYPE_INTEGER, VAR_LIMITS: (0, None)},
   QUICK_CROS_MOVE: {VAR_TYPE: TYPE_BOOLEAN},
   QUICK_INFO_USER: {VAR_TYPE: TYPE_BOOLEAN},
   RESELLER_ID: {VAR_TYPE: TYPE_STRING, VAR_LIMITS: (0, None)},

src/gam/gamlib/glmsgs.py

@@ -162,8 +162,10 @@ BAD_ENTITIES_IN_SOURCE = '{0} {1} {2} in source marked >>> <<< above'
 BAD_REQUEST = 'Bad Request'
 BATCH = 'Batch'
 BATCH_CSV_LOOP_DASH_DEBUG_INCOMPATIBLE = '"gam {0} - ..." is not compatible with debugging. Disable debugging by setting debug_level = 0 in gam.cfg'
-BATCH_CSV_WAIT_N_PROCESSES = '{0},0/{1},Waiting for {2} running {3} to finish before terminating\n'
 BATCH_CSV_PROCESSING_COMPLETE = '{0},0/{1},Processing complete\n'
+BATCH_CSV_TERMINATE_N_PROCESSES = '{0},0/{1},Terminating {2} running {3}\n'
+BATCH_CSV_WAIT_LIMIT = ', wait limit {0} seconds'
+BATCH_CSV_WAIT_N_PROCESSES = '{0},0/{1},Waiting for {2} running {3} to finish before terminating{4}\n'
 BATCH_NOT_PROCESSED_ERRORS = '{0}batch file: {1}, not processed, {2} {3}\n'
 CALLING_GCLOUD_FOR_REAUTH = 'Calling gcloud for reauth credentials..."\n'
 CAN_NOT_DELETE_USER_WITH_VAULT_HOLD = '{0}: The user may be (or have recently been) on Google Vault Hold and thus not eligible for deletion. You can check holds with "gam user {1} show vaultholds".'