Always sleep while restarting

The /services/server/control/restart endpoint does not stop the API
immediately. As a result, a login() call may still succeed just before
the restart takes effect. This change introduces an additional sleep
to prevent a burst of requests from reaching the server while it is
in the process of restarting.

Author: mateusz834

splunklib/client.py

@@ -618,7 +618,15 @@ def restart(self, timeout=None):
         while datetime.now() - start < diff:
             try:
                 self.login()
-                if not self.restart_required:
+                if self.restart_required:
+                    # Prevent a burst of requests from bombarding Splunk.
+                    # Splunk does not stop the API immediately when /services/server/control/restart
+                    # responds, thus the login call (above) will still succeed until the server
+                    # is actually stopped. Based on the presence of restart_required required message,
+                    # that we have added before calling restart, we know that the server did not stop yet.
+                    sleep(1)
+                    continue
+                else:
                     return result
             except Exception as e:
                 sleep(1)