Fix cloud-init status --wait when no datasource found

[TheRealFalcon]

Proposed Commit Message

Fix cloud-init status --wait when no datasource found

In 0de7acb1, we modified status checks to wait until we get an "enabled"
or "disabled" file from our generator. It never outputs a
"disabled" file, so "status --wait" will wait indefinitely if no
datasource is found.

LP: #1966085

Additional Context

See: #1162

Test Steps

Run tests/integration_tests/cmd/test_status.py

I also manually checked the generator script to verify that enabled and disabled files get created as expected and are mutually exclusive.

[holmanb]

Looks good!

[blackboxsw]

LGTM. minor suggestion integration test explicit test. I'm running this patch through now on Jammy and impish to validate

[blackboxsw]

Minor change suggestion just to make sure our status is reporting the correct reason for the disable

diff --git a/tests/integration_tests/cmd/test_status.py b/tests/integration_tests/cmd/test_status.py
index 085680154..53bab5fd6 100644
--- a/tests/integration_tests/cmd/test_status.py
+++ b/tests/integration_tests/cmd/test_status.py
@@ -13,7 +13,7 @@ def _wait_for_cloud_init(client: IntegrationInstance):
     last_exception = None
     for _ in range(30):
         try:
-            result = client.execute("cloud-init status")
+            result = client.execute("cloud-init status --long")
             if result and result.ok:
                 return result
         except Exception as e:
@@ -59,6 +59,7 @@ def test_wait_when_no_datasource(session_cloud: IntegrationCloud, setup_image):
             "impish",
         ]:
             _remove_nocloud_dir_and_reboot(client)
-        status = _wait_for_cloud_init(client)
-        assert status.stdout.strip() == "status: disabled"
+        status_out = _wait_for_cloud_init(client).stdout.strip()
+        assert "status: disabled" in status_out
+        assert "Cloud-init disabled by cloud-init-generator" in status_out
         assert client.execute("cloud-init status --wait").ok

[blackboxsw]

Confirmed success with a deb from this PR on impish and jammy runs with the above integration test patch. See expected failure using CLOUD_INIT_CLOUD_INIT_SOURCE=ppa:cloud-init-dev/proposed deb without your fix.

[TheRealFalcon]

Good idea, thanks. Applied your patch.

[blackboxsw]

+1 will await CI run on this

[blackboxsw]

@valentindavid just FYI this fix is SRU'd to Bionic, Focal and Impish -updates pocket as version 22.1-14-g2e17a0d6-0ubuntu1~20.04.3 so daily cloudimages should have this fix you need.