rename argument from wait_for_status to status

Author: sed-i

juju/model.py

@@ -2229,7 +2229,7 @@ async def _get_source_api(self, url, controller_name=None):
 
     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_status=None):
+                            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.
@@ -2262,12 +2262,12 @@ 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.
+        :param 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"
+            warnings.warn("wait_for_active is deprecated; use status", DeprecationWarning)
+            status = "active"
 
         timeout = timedelta(seconds=timeout) if timeout is not None else None
         idle_period = timedelta(seconds=idle_period)
@@ -2320,7 +2320,7 @@ def _raise_for_status(entities, status):
                     if raise_on_blocked and unit.workload_status == "blocked":
                         blocks.setdefault("Unit", []).append(unit.name)
                         continue
-                    waiting_for_status = wait_for_status and unit.workload_status != wait_for_status
+                    waiting_for_status = status and unit.workload_status != status
                     if not waiting_for_status and unit.agent_status == "idle":
                         now = datetime.now()
                         idle_start = idle_times.setdefault(unit.name, now)

tests/integration/test_application.py

@@ -151,10 +151,10 @@ async def test_upgrade_local_charm(event_loop):
         tests_dir = Path(__file__).absolute().parent
         charm_path = tests_dir / 'upgrade-charm'
         app = await model.deploy('ubuntu', series='focal')
-        await model.wait_for_idle(wait_for_status="active")
+        await model.wait_for_idle(status="active")
         assert app.data['charm-url'].startswith('cs:ubuntu')
         await app.upgrade_charm(path=charm_path)
-        await model.wait_for_idle(wait_for_status="waiting")
+        await model.wait_for_idle(status="waiting")
         assert app.data['charm-url'] == 'local:focal/ubuntu-0'
 
 

tests/integration/test_model.py

@@ -97,7 +97,7 @@ async def test_deploy_local_charm(event_loop):
     async with base.CleanModel() as model:
         await model.deploy(str(charm_path))
         assert 'charm' in model.applications
-        await model.wait_for_idle(wait_for_status="active")
+        await model.wait_for_idle(status="active")
         assert model.units['charm/0'].workload_status == 'active'
 
 
@@ -113,7 +113,7 @@ async def test_wait_local_charm_blocked(event_loop):
         assert 'charm' in model.applications
         await model.wait_for_idle()
         with pytest.raises(JujuUnitError):
-            await model.wait_for_idle(wait_for_status="active",
+            await model.wait_for_idle(status="active",
                                       raise_on_blocked=True,
                                       timeout=30)
 
@@ -130,7 +130,7 @@ async def test_wait_local_charm_waiting_timeout(event_loop):
         assert 'charm' in model.applications
         await model.wait_for_idle()
         with pytest.raises(asyncio.TimeoutError):
-            await model.wait_for_idle(wait_for_status="active", timeout=30)
+            await model.wait_for_idle(status="active", timeout=30)
 
 
 @base.bootstrapped

tests/unit/test_model.py

@@ -298,14 +298,14 @@ async def test_wait_for_active_status(self):
             mock_apps.return_value = apps
             m = Model()
 
-            # pass "active" via `wait_for_status` (str)
-            await m.wait_for_idle(apps=["dummy_app"], wait_for_status="active", timeout=5, idle_period=0)
+            # pass "active" via `status` (str)
+            await m.wait_for_idle(apps=["dummy_app"], status="active", timeout=5, idle_period=0)
 
             # pass "active" via `wait_for_active` (bool; deprecated)
             await m.wait_for_idle(apps=["dummy_app"], wait_for_active=True, timeout=5, idle_period=0)
 
-            # use both `wait_for_status` and `wait_for_active` - `wait_for_active` takes precedence
-            await m.wait_for_idle(apps=["dummy_app"], wait_for_active=True, wait_for_status="doesn't matter", timeout=5,
+            # use both `status` and `wait_for_active` - `wait_for_active` takes precedence
+            await m.wait_for_idle(apps=["dummy_app"], wait_for_active=True, status="doesn't matter", timeout=5,
                                   idle_period=0)
 
         mock_apps.assert_called()