summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChad Smith <chad.smith@canonical.com>2022-01-18 20:46:14 -0700
committerGitHub <noreply@github.com>2022-01-18 20:46:14 -0700
commit20bd192db661e519b860a0799de04c663ceae0c6 (patch)
tree1f23a6d2f970a27b10013b7cce0819d5d4157f9b
parentc2c2a663edccd9fcb74f3bed24a6daad09c45d2a (diff)
downloadvyos-cloud-init-20bd192db661e519b860a0799de04c663ceae0c6.tar.gz
vyos-cloud-init-20bd192db661e519b860a0799de04c663ceae0c6.zip
cmd: status and cloud-id avoid change in behavior for 'not run' (#1197)
snapd currrently looks for 'not run' from cloud-init status[1]. Avoid changing this behavior and revert "not-run" value to "not run". This avoids having to get snapd to change implementation and release updates as far back as Bionic to handle a hyphenated not-run string. [1]: https://github.com/snapcore/snapd/blob/master/sysconfig/\ cloudinit.go#L802
-rwxr-xr-xcloudinit/cmd/cloud_id.py2
-rw-r--r--cloudinit/cmd/status.py2
-rw-r--r--doc/man/cloud-id.12
-rw-r--r--tests/unittests/cmd/test_status.py4
4 files changed, 5 insertions, 5 deletions
diff --git a/cloudinit/cmd/cloud_id.py b/cloudinit/cmd/cloud_id.py
index b71c19de..b9c30fb4 100755
--- a/cloudinit/cmd/cloud_id.py
+++ b/cloudinit/cmd/cloud_id.py
@@ -63,7 +63,7 @@ def handle_args(name, args):
Print the canonical cloud-id on which the instance is running.
- @return: 0 on success, 1 on error, 2 on disabled, 3 on cloud-init not-run.
+ @return: 0 on success, 1 on error, 2 on disabled, 3 on cloud-init not run.
"""
status, _status_details, _time = get_status_details()
if status == UXAppStatus.DISABLED:
diff --git a/cloudinit/cmd/status.py b/cloudinit/cmd/status.py
index 597e5bfb..5176549d 100644
--- a/cloudinit/cmd/status.py
+++ b/cloudinit/cmd/status.py
@@ -22,7 +22,7 @@ CLOUDINIT_DISABLED_FILE = "/etc/cloud/cloud-init.disabled"
class UXAppStatus(enum.Enum):
"""Enum representing user-visible cloud-init application status."""
- NOT_RUN = "not-run"
+ NOT_RUN = "not run"
RUNNING = "running"
DONE = "done"
ERROR = "error"
diff --git a/doc/man/cloud-id.1 b/doc/man/cloud-id.1
index c56587c8..cb500189 100644
--- a/doc/man/cloud-id.1
+++ b/doc/man/cloud-id.1
@@ -9,7 +9,7 @@ cloud-id \- Report the canonical cloud-id for this instance
.SH DESCRIPTION
cloud-id is the lowercase name of the cloud datasource discovered.
-The cloud-id will be 'not-run' when systemd generator has not run yet.
+The cloud-id will be 'not run' when systemd generator has not run yet.
The cloud-id will be 'disabled' when cloud-init is disabled or when
ds-identify did not find a valid datasource.
diff --git a/tests/unittests/cmd/test_status.py b/tests/unittests/cmd/test_status.py
index 17d27597..c5f424da 100644
--- a/tests/unittests/cmd/test_status.py
+++ b/tests/unittests/cmd/test_status.py
@@ -137,7 +137,7 @@ class TestStatus(CiTestCase):
)
def test_status_returns_not_run(self):
- """When status.json does not exist yet, return 'not-run'."""
+ """When status.json does not exist yet, return 'not run'."""
self.assertFalse(
os.path.exists(self.status_file), "Unexpected status.json found"
)
@@ -154,7 +154,7 @@ class TestStatus(CiTestCase):
cmdargs,
)
self.assertEqual(0, retcode)
- self.assertEqual("status: not-run\n", m_stdout.getvalue())
+ self.assertEqual("status: not run\n", m_stdout.getvalue())
def test_status_returns_disabled_long_on_presence_of_disable_file(self):
"""When cloudinit is disabled, return disabled reason."""