add wait_for_status instead of wait_for_active

Author: sed-i

juju/model.py

@@ -8,6 +8,7 @@
 import re
 import stat
 import tempfile
+import warnings
 import weakref
 import zipfile
 from concurrent.futures import CancelledError
@@ -2227,7 +2228,8 @@ async def _get_source_api(self, url, controller_name=None):
         return controller
 
     async def wait_for_idle(self, apps=None, raise_on_error=True, raise_on_blocked=False,
-                            wait_for_active=False, timeout=10 * 60, idle_period=15, check_freq=0.5):
+                            wait_for_active=False, timeout=10 * 60, idle_period=15, check_freq=0.5,
+                            wait_for_status=None):
         """Wait for applications in the model to settle into an idle state.
 
         :param apps (list[str]): Optional list of specific app names to wait on.
@@ -2259,7 +2261,14 @@ async def wait_for_idle(self, apps=None, raise_on_error=True, raise_on_blocked=F
 
         :param check_freq (float): How frequently, in seconds, to check the model.
             The default is every half-second.
+
+        :param wait_for_status (str): The status to wait for. If None, not waiting.
+            The default is None (not waiting for any status).
         """
+        if wait_for_active:
+            warnings.warn("wait_for_active is deprecated; use wait_for_status", DeprecationWarning)
+            wait_for_status = "active"
+
         timeout = timedelta(seconds=timeout) if timeout is not None else None
         idle_period = timedelta(seconds=idle_period)
         start_time = datetime.now()
@@ -2311,8 +2320,8 @@ def _raise_for_status(entities, status):
                     if raise_on_blocked and unit.workload_status == "blocked":
                         blocks.setdefault("Unit", []).append(unit.name)
                         continue
-                    waiting_for_active = wait_for_active and unit.workload_status != "active"
-                    if not waiting_for_active and unit.agent_status == "idle":
+                    waiting_for_status = wait_for_status and unit.workload_status != wait_for_status
+                    if not waiting_for_status and unit.agent_status == "idle":
                         now = datetime.now()
                         idle_start = idle_times.setdefault(unit.name, now)
                         if now - idle_start < idle_period: