fix(cmd-modules): exit code when --mode init

[aciba90]

Proposed Commit Message

fix(cmd-modules): exit code when --mode init

Co-authored-by: Chad Smith <chad.smith@canonical.com>

Additional Context

Supersedes #4939
Execute cloud-init modules --mode init on any instance.

Test Steps

Checklist

• My code follows the process laid out in the documentation
• I have updated or added any unit tests accordingly
• I have updated or added any documentation accordingly

Merge type

• Squash merge using "Proposed Commit Message"
• Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

[blackboxsw]

Beyond using class_client, l let's also add a failure test as well.

--- a/tests/integration_tests/modules/test_cli.py
+++ b/tests/integration_tests/modules/test_cli.py
@@ -20,6 +20,12 @@ runcmd:
   - echo 'hi' > /var/tmp/test
 """
 
+FAILING_USER_DATA_RUNCMD = """\
+#cloud-config
+runcmd:
+    - exit 1
+"""
+
 # The '-' in 'hashed-password' fails schema validation
 INVALID_USER_DATA_SCHEMA = """\
 #cloud-config
@@ -37,25 +43,25 @@ users:
 
 @pytest.mark.user_data(VALID_USER_DATA)
 class TestValidUserData:
-    def test_schema_status(self, client: IntegrationInstance):
+    def test_schema_status(self, class_client: IntegrationInstance):
         """Test `cloud-init schema` with valid userdata.
 
         PR #575
         """
-        result = client.execute("cloud-init schema --system")
+        result = class_client.execute("cloud-init schema --system")
         assert result.ok
         assert "Valid schema user-data" in result.stdout.strip()
-        result = client.execute("cloud-init status --long")
+        result = class_client.execute("cloud-init status --long")
         assert 0 == result.return_code, (
             f"Unexpected exit {result.return_code} from cloud-init status:"
             f" {result}"
         )
 
-    @pytest.mark.parametrize("mode", ["init", "config", "final"])
-    def test_modules_init(self, mode, client: IntegrationInstance):
-        result = client.execute(f"cloud-init modules --mode {mode}")
-        assert result.ok
-        assert f"'modules:{mode}'" in result.stdout.strip()
+    def test_modules_init(self, class_client: IntegrationInstance):
+        for mode in ("init", "config", "final"):
+            result = class_client.execute(f"cloud-init modules --mode {mode}")
+            assert result.ok
+            assert f"'modules:{mode}'" in result.stdout.strip()
 
 
 @pytest.mark.skipif(
@@ -105,3 +111,12 @@ def test_invalid_userdata_schema(client: IntegrationInstance):
     )
     assert warning in log
     assert "asdfasdf" not in log
+
+
+@pytest.mark.user_data(FAILING_USER_DATA_RUNCMD)
+def test_failing_userdata_exit_codes(client: IntegrationInstance):
+    """Test failing in modules representd in exit status"""
+    for mode in ("init", "config", "final"):
+        result = client.execute(f"cloud-init modules --mode {mode}")
+        assert result.failed if mode == "init" else result.ok
+        assert f"'modules:{mode}'" in result.stdout.strip()

[blackboxsw]

Approved for landing once we minimally have class_client and your decision on the failure test.

[aciba90]

Approved for landing once we minimally have class_client and your decision on the failure test.

The sole intention of making those test belong to the same class was to use class_client, but I forgot to sed it xD, thanks for catching that up.

I have included your failure test with a small modification: to make cloud-init modules -m init fail, I added a failing bootcmd config stanza, as runcmd does not run as part of init config modules.

Thanks for the review and suggestions!

[blackboxsw]

LGTM