Update tests

Use of regex to avoid having to update the cli tests each time the operations and facts used in them are modified

Author: maisim

tests/test_cli/test_cli_exceptions.py

@@ -1,3 +1,4 @@
+import re
 import sys
 from os import path
 from unittest import TestCase
@@ -21,7 +22,24 @@ def setUpClass(cls):
     def assert_cli_exception(self, args, message):
         result = self.runner.invoke(cli, args, standalone_mode=False)
         self.assertIsInstance(result.exception, CliError)
-        assert getattr(result.exception, "message") == message
+
+        if isinstance(message, str):
+            message = [message]
+
+        for part in message:
+
+            # Test if the string is a regex
+            is_regex = False
+            try:
+                re.compile(part)
+                is_regex = True
+            except re.error:
+                pass
+
+            if is_regex:
+                assert re.search(part, result.exception.message, re.MULTILINE)
+            else:
+                assert part == result.exception.message
 
     def test_bad_deploy_file(self):
         self.assert_cli_exception(
@@ -44,13 +62,12 @@ def test_no_fact_module(self):
     def test_no_fact_cls(self):
         self.assert_cli_exception(
             ["my-server.net", "fact", "server.NotAFact"],
-            (
-                "No such attribute in module server: NotAFact\n"
-                "Available facts in module are: User, Home, Path, TmpDir, Hostname, Kernel, "
-                "KernelVersion, Os, OsVersion, Arch, Command, Which, Date, MacosVersion, Mounts, "
-                "KernelModules, LsbRelease, OsRelease, Sysctl, Groups, Users, LinuxDistribution, "
-                "Selinux, LinuxGui, Locales, SecurityLimits"
-            ),
+            [
+                r"^No such attribute in module server: NotAFact.*",
+                r".*Available facts are: .*",
+                r".* User,.*",
+                r".* Os,",
+            ],
         )
 
 

tests/test_cli/test_cli_util.py

@@ -1,4 +1,5 @@
 import os
+import re
 import sys
 from datetime import datetime
 from io import StringIO
@@ -36,12 +37,13 @@ def test_setup_not_exists_op(self):
         with self.assertRaises(CliError) as context:
             get_func_and_args(("server.not_exists",))
 
-        assert context.exception.message == (
-            "No such attribute in module server: not_exists\n"
-            "Available operations are: reboot, wait, shell, script, script_template, "
-            "modprobe, mount, hostname, sysctl, service, packages, crontab, group, "
-            "user_authorized_keys, user, locale, security_limit"
-        )
+        for part in [
+            r"^No such attribute in module server: not_exists$",
+            r"Available operations are: .*",
+            r".* modprobe, .*",
+            r".* mount, .*",
+        ]:
+            assert re.search(part, context.exception.message, re.MULTILINE)
 
     def test_setup_op_and_args(self):
         commands = ("pyinfra.operations.server.user", "one", "two", "hello=world")