pyinfra 3.1__py2.py3-none-any.whl → 3.2__py2.py3-none-any.whl

pyinfra_cli/prints.py

@@ -281,6 +281,8 @@ def print_results(state: "State"):
         (logger.info, ["Operation", "Hosts", "Success", "Error", "No Change"]),
     ]
 
+    totals = {"hosts": 0, "success": 0, "error": 0, "no_change": 0}
+
     for op_hash in state.get_op_order():
         hosts_in_op = 0
         hosts_in_op_success: list[str] = []
@@ -306,19 +308,32 @@ def print_results(state: "State"):
             str(hosts_in_op),
         ]
 
+        totals["hosts"] += hosts_in_op
+
         if hosts_in_op_success:
-            row.append(f"{len(hosts_in_op_success)}")
+            num_hosts_in_op_success = len(hosts_in_op_success)
+            row.append(str(num_hosts_in_op_success))
+            totals["success"] += num_hosts_in_op_success
         else:
             row.append("-")
+
         if hosts_in_op_error:
-            row.append(f"{len(hosts_in_op_error)}")
+            num_hosts_in_op_error = len(hosts_in_op_error)
+            row.append(str(num_hosts_in_op_error))
+            totals["error"] += num_hosts_in_op_error
         else:
             row.append("-")
+
         if hosts_in_op_no_change:
-            row.append(f"{len(hosts_in_op_no_change)}")
+            num_hosts_in_op_no_change = len(hosts_in_op_no_change)
+            row.append(str(num_hosts_in_op_no_change))
+            totals["no_change"] += num_hosts_in_op_no_change
         else:
             row.append("-")
 
         rows.append((logger.info, row))
 
+    totals_row = ["Grand total"] + [str(i) if i else "-" for i in totals.values()]
+    rows.append((logger.info, totals_row))
+
     print_rows(rows)

pyinfra_cli/util.py

@@ -124,6 +124,9 @@ def json_encode(obj):
     if isinstance(obj, bytes):
         return obj.decode()
 
+    if hasattr(obj, "to_json"):
+        return obj.to_json()
+
     raise TypeError("Cannot serialize: {0} ({1})".format(type(obj), obj))
 
 
@@ -180,13 +183,13 @@ def try_import_module_attribute(path, prefix=None, raise_for_none=True):
 
     if module is None:
         if raise_for_none:
-            raise CliError(f"No such module: {possible_modules[-1]}")
+            raise CliError(f"No such module: {possible_modules[0]}")
         return
 
     attr = getattr(module, attr_name, None)
     if attr is None:
         if raise_for_none:
-            raise CliError(f"No such attribute in module {possible_modules[-1]}: {attr_name}")
+            raise CliError(f"No such attribute in module {possible_modules[0]}: {attr_name}")
         return
 
     return attr

tests/test_cli/test_cli_deploy.py

@@ -43,26 +43,28 @@ class TestCliDeployState(PatchSSHTestCase):
                     assert executed is False
 
     def test_deploy(self):
-        task_file_path = path.join("tasks", "a_task.py")
+        a_task_file_path = path.join("tasks", "a_task.py")
+        b_task_file_path = path.join("tasks", "b_task.py")
         nested_task_path = path.join("tasks", "another_task.py")
         correct_op_name_and_host_names = [
             ("First main operation", True),  # true for all hosts
             ("Second main operation", ("somehost",)),
-            ("{0} | First task operation".format(task_file_path), ("anotherhost",)),
-            ("{0} | Task order loop 1".format(task_file_path), ("anotherhost",)),
-            ("{0} | 2nd Task order loop 1".format(task_file_path), ("anotherhost",)),
-            ("{0} | Task order loop 2".format(task_file_path), ("anotherhost",)),
-            ("{0} | 2nd Task order loop 2".format(task_file_path), ("anotherhost",)),
+            ("{0} | First task operation".format(a_task_file_path), ("anotherhost",)),
+            ("{0} | Task order loop 1".format(a_task_file_path), ("anotherhost",)),
+            ("{0} | 2nd Task order loop 1".format(a_task_file_path), ("anotherhost",)),
+            ("{0} | Task order loop 2".format(a_task_file_path), ("anotherhost",)),
+            ("{0} | 2nd Task order loop 2".format(a_task_file_path), ("anotherhost",)),
             (
-                "{0} | {1} | Second task operation".format(task_file_path, nested_task_path),
+                "{0} | {1} | Second task operation".format(a_task_file_path, nested_task_path),
                 ("anotherhost",),
             ),
-            ("{0} | First task operation".format(task_file_path), True),
-            ("{0} | Task order loop 1".format(task_file_path), True),
-            ("{0} | 2nd Task order loop 1".format(task_file_path), True),
-            ("{0} | Task order loop 2".format(task_file_path), True),
-            ("{0} | 2nd Task order loop 2".format(task_file_path), True),
-            ("{0} | {1} | Second task operation".format(task_file_path, nested_task_path), True),
+            ("{0} | First task operation".format(a_task_file_path), True),
+            ("{0} | Task order loop 1".format(a_task_file_path), True),
+            ("{0} | 2nd Task order loop 1".format(a_task_file_path), True),
+            ("{0} | Task order loop 2".format(a_task_file_path), True),
+            ("{0} | 2nd Task order loop 2".format(a_task_file_path), True),
+            ("{0} | {1} | Second task operation".format(a_task_file_path, nested_task_path), True),
+            ("{0} | Important task operation".format(b_task_file_path), True),
             ("My deploy | First deploy operation", True),
             ("My deploy | My nested deploy | First nested deploy operation", True),
             ("My deploy | Second deploy operation", True),

tests/test_cli/test_cli_exceptions.py

@@ -38,13 +38,13 @@ class TestCliExceptions(TestCase):
     def test_no_fact_module(self):
         self.assert_cli_exception(
             ["my-server.net", "fact", "not_a_module.SomeFact"],
-            "No such module: pyinfra.facts.not_a_module",
+            "No such module: not_a_module",
         )
 
     def test_no_fact_cls(self):
         self.assert_cli_exception(
             ["my-server.net", "fact", "server.NotAFact"],
-            "No such attribute in module pyinfra.facts.server: NotAFact",
+            "No such attribute in module server: NotAFact",
         )
 
 

tests/test_cli/test_cli_inventory.py

@@ -64,3 +64,56 @@ class TestCliInventory(PatchSSHTestCase):
         assert "leftover_data" in inventory.group_data
         assert inventory.group_data["leftover_data"].get("still_parsed") == "never_used"
         assert inventory.group_data["leftover_data"].get("_global_arg") == "gets_parsed"
+
+    def test_ignores_variables_with_leading_underscore(self):
+        ctx_state.reset()
+        ctx_inventory.reset()
+
+        result = run_cli(
+            path.join("tests", "test_cli", "inventories", "invalid.py"),
+            "exec",
+            "--debug",
+            "--",
+            "echo hi",
+        )
+
+        assert result.exit_code == 0, result.stdout
+        assert (
+            'Ignoring variable "_hosts" in inventory file since it starts with a leading underscore'
+            in result.stdout
+        )
+        assert inventory.hosts == {}
+
+    def test_only_supports_list_and_tuples(self):
+        ctx_state.reset()
+        ctx_inventory.reset()
+
+        result = run_cli(
+            path.join("tests", "test_cli", "inventories", "invalid.py"),
+            "exec",
+            "--debug",
+            "--",
+            "echo hi",
+        )
+
+        assert result.exit_code == 0, result.stdout
+        assert 'Ignoring variable "dict_hosts" in inventory file' in result.stdout, result.stdout
+        assert (
+            'Ignoring variable "generator_hosts" in inventory file' in result.stdout
+        ), result.stdout
+        assert inventory.hosts == {}
+
+    def test_host_groups_may_only_contain_strings_or_tuples(self):
+        ctx_state.reset()
+        ctx_inventory.reset()
+
+        result = run_cli(
+            path.join("tests", "test_cli", "inventories", "invalid.py"),
+            "exec",
+            "--",
+            "echo hi",
+        )
+
+        assert result.exit_code == 0, result.stdout
+        assert 'Ignoring host group "issue_662"' in result.stdout, result.stdout
+        assert inventory.hosts == {}

tests/test_cli/test_cli_util.py

@@ -30,15 +30,13 @@ class TestCliUtil(TestCase):
     def test_setup_no_module(self):
         with self.assertRaises(CliError) as context:
             get_func_and_args(("no.op",))
-        assert context.exception.message == "No such module: pyinfra.operations.no"
+        assert context.exception.message == "No such module: no"
 
     def test_setup_no_op(self):
         with self.assertRaises(CliError) as context:
             get_func_and_args(("server.no",))
 
-        assert (
-            context.exception.message == "No such attribute in module pyinfra.operations.server: no"
-        )
+        assert context.exception.message == "No such attribute in module server: no"
 
     def test_setup_op_and_args(self):
         commands = ("pyinfra.operations.server.user", "one", "two", "hello=world")

tests/test_connectors/test_sshuserclient.py

@@ -1,7 +1,8 @@
+from base64 import b64decode
 from unittest import TestCase
 from unittest.mock import mock_open, patch
 
-from paramiko import ProxyCommand
+from paramiko import PKey, ProxyCommand, SSHException
 
 from pyinfra.connectors.sshuserclient import SSHClient
 from pyinfra.connectors.sshuserclient.client import AskPolicy, get_ssh_config
@@ -41,6 +42,30 @@ LOOPING_SSH_CONFIG_DATA = """
 Include other_file
 """
 
+# To ensure that we don't remove things from users hostfiles
+# we should test that all modifications only append to the
+# hostfile, and don't delete any data or comments.
+EXAMPLE_KEY_1 = (
+    "AAAAB3NzaC1yc2EAAAADAQABAAABgQCj7ndNxQowgcQnjshcLrqPEiiphnt+"
+    "VTTvDP6mHBL9j1aNUkY4Ue1gvwnGLVlOhGeYrnZaMgRK6+PKCUXaDbC7qtbW8gIkhL7aGCsOr/"
+    "C56SJMy/BCZfxd1nWzAOxSDPgVsmerOBYfNqltV9/hWCqBywINIR+5dIg6JTJ72pcEpEjcYgXk"
+    "E2YEFXV1JHnsKgbLWNlhScqb2UmyRkQyytRLtL+38TGxkxCflmO+5Z8CSSNY7GidjMIZ7Q4zMj"
+    "A2n1nGrlTDkzwDCsw+wqFPGQA179cnfGWOWRVruj16z6XyvxvjJwbz0wQZ75XK5tKSb7FNyeIE"
+    "s4TT4jk+S4dhPeAUC5y+bDYirYgM4GC7uEnztnZyaVWQ7B381AK4Qdrwt51ZqExKbQpTUNn+Ej"
+    "qoTwvqNj4kqx5QUCI0ThS/YkOxJCXmPUWZbhjpCg56i+2aB6CmK2JGhn57K5mj0MNdBXA4/Wnw"
+    "H6XoPWJzK5Nyu2zB3nAZp+S5hpQs+p1vN1/wsjk="
+)
+
+KNOWN_HOSTS_EXAMPLE_DATA = f"""
+# this is an important comment
+
+# another comment after the newline
+
+@cert-authority example-domain.lan ssh-rsa {EXAMPLE_KEY_1}
+
+192.168.1.222 ssh-rsa {EXAMPLE_KEY_1}
+"""
+
 
 class TestSSHUserConfigMissing(TestCase):
     def setUp(self):
@@ -199,3 +224,45 @@ class TestSSHUserConfig(TestCase):
             port=22,
             test="kwarg",
         )
+
+    def test_missing_hostkey(self):
+        client = SSHClient()
+        policy = AskPolicy()
+        example_hostname = "new_host"
+        example_keytype = "ecdsa-sha2-nistp256"
+        example_key = (
+            "AAAAE2VjZHNhLXNoYTItbmlzdHAyNT"
+            "YAAAAIbmlzdHAyNTYAAABBBHNp1NM"
+            "ZjxPBuuKwIPfkVJqWaH3oUtW137kIW"
+            "P4PlCyACt8zVIIimFhIpwRUidcf7jw"
+            "VWPAJvfBjEPqewDApnZQ="
+        )
+
+        key = PKey.from_type_string(
+            example_keytype,
+            b64decode(example_key),
+        )
+
+        # Check if AskPolicy respects not importing and properly raises SSHException
+        with self.subTest("Check user 'no'"):
+            with patch("builtins.input", return_value="n"):
+                self.assertRaises(
+                    SSHException, lambda: policy.missing_host_key(client, example_hostname, key)
+                )
+
+        # Check if AskPolicy properly appends to hostfile
+        with self.subTest("Check user 'yes'"):
+            mock_data = mock_open(read_data=KNOWN_HOSTS_EXAMPLE_DATA)
+            # Read mock hostfile
+            with patch("pyinfra.connectors.sshuserclient.client.open", mock_data):
+                with patch("paramiko.hostkeys.open", mock_data):
+                    with patch("builtins.input", return_value="y"):
+                        policy.missing_host_key(client, "new_host", key)
+
+            # Assert that we appended correctly to the file
+            write_call_args = mock_data.return_value.write.call_args
+            # Ensure we only wrote once and then closed the handle.
+            assert len(write_call_args) == 2
+            # Ensure we wrote the correct content
+            correct_output = f"{example_hostname} {example_keytype} {example_key}\n"
+            assert write_call_args[0][0] == correct_output