daktari 0.0.330__tar.gz → 0.0.332__tar.gz

{daktari-0.0.330/daktari.egg-info → daktari-0.0.332}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: daktari
-Version: 0.0.330
+Version: 0.0.332
 Summary: Assist in setting up and maintaining developer environments
 Author-email: Matt Russell <matthew.russell@sonocent.com>
 License: Copyright 2021 Sonocent Ltd
@@ -45,7 +45,7 @@ In the root of the project repository, create a `.daktari.py` configuration file
 ```python
 from daktari.checks.git import *
 
-version = "0.0.330"
+version = "0.0.332"
 title = "My Project"
 
 checks = [

{daktari-0.0.330 → daktari-0.0.332}/README.md

@@ -7,7 +7,7 @@ In the root of the project repository, create a `.daktari.py` configuration file
 ```python
 from daktari.checks.git import *
 
-version = "0.0.330"
+version = "0.0.332"
 title = "My Project"
 
 checks = [

daktari-0.0.332/daktari/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.332"

{daktari-0.0.330 → daktari-0.0.332}/daktari/checks/git.py

@@ -133,7 +133,8 @@ class PreCommitGitHooksInstalled(Check):
     }
 
     def check(self) -> CheckResult:
-        git_hooks_installed = file_contains_text(".git/hooks/pre-commit", "pre-commit.com")
+        hook_path = get_stdout("git rev-parse --git-path hooks/pre-commit")
+        git_hooks_installed = hook_path is not None and file_contains_text(hook_path, "pre-commit.com")
         return self.verify(git_hooks_installed, "pre-commit Git hooks are <not/> installed")
 
 

{daktari-0.0.330 → daktari-0.0.332}/daktari/checks/misc.py

@@ -1,6 +1,6 @@
 import logging
 from os.path import expanduser
-from typing import Dict, Optional
+from typing import Dict, Optional, Set
 
 from python_hosts import Hosts
 
@@ -189,9 +189,10 @@ class Md5SumInstalled(Check):
 class HostAliasesConfigured(Check):
     name = "hostAliases.configured"
 
-    def __init__(self, required_aliases: Dict[str, str]):
+    def __init__(self, required_aliases: Dict[str, str], hosts_path: Optional[str] = None):
         self.required_aliases = required_aliases
-        hosts_path = Hosts.determine_hosts_path()
+        self.hosts_path = hosts_path
+        hosts_path = hosts_path or Hosts.determine_hosts_path()
 
         aliases_by_addr: Dict[str, list[str]] = {}
 
@@ -209,15 +210,18 @@ class HostAliasesConfigured(Check):
         self.suggestions = {OS.GENERIC: suggestion_text}
 
     def check(self) -> CheckResult:
-        hosts = Hosts()
+        hosts = Hosts(path=self.hosts_path)
         entries = [e for e in hosts.entries if e.entry_type in ("ipv4", "ipv6")]
-        entries_dict = {}
+        # A hostname can legitimately map to several addresses (e.g. dual-stack
+        # localhost -> both 127.0.0.1 and ::1), so collect all addresses per name
+        # rather than letting the last entry in file order win.
+        entries_dict: Dict[str, Set[str]] = {}
         for entry in entries:
             for name in entry.names:
-                entries_dict[name] = entry.address
+                entries_dict.setdefault(name, set()).add(entry.address)
         logging.debug(f"Hosts file entries: {entries_dict}")
         for name, address in self.required_aliases.items():
-            if entries_dict.get(name) != address:
+            if address not in entries_dict.get(name, set()):
                 return self.failed(f"{hosts.path} alias {name} -> {address} not present")
 
         return self.passed(f"{hosts.path} aliases present")

daktari-0.0.332/daktari/checks/test_misc.py

@@ -0,0 +1,53 @@
+import os
+import tempfile
+import unittest
+
+from daktari.check import CheckStatus
+from daktari.checks.misc import HostAliasesConfigured
+
+# Stock macOS /etc/hosts maps "localhost" to both 127.0.0.1 and ::1, with the
+# ::1 line appearing last. The check must treat the IPv4 alias as satisfied
+# regardless of the order the two lines appear in (see HostAliasesConfigured).
+DUAL_STACK_IPV6_LAST = "127.0.0.1 localhost\n255.255.255.255 broadcasthost\n::1 localhost\n"
+DUAL_STACK_IPV4_LAST = "::1 localhost\n255.255.255.255 broadcasthost\n127.0.0.1 localhost\n"
+
+
+class TestHostAliasesConfigured(unittest.TestCase):
+    def _hosts_fixture(self, content):
+        f = tempfile.NamedTemporaryFile("w", suffix=".hosts", delete=False)
+        f.write(content)
+        f.close()
+        self.addCleanup(os.unlink, f.name)
+        return f.name
+
+    def test_checking_hosts_does_not_blow_up_on_success(self):
+        result = HostAliasesConfigured({}).check()
+        self.assertEqual(result.status, CheckStatus.PASS)
+
+    def test_checking_hosts_does_not_blow_up_on_failure(self):
+        result = HostAliasesConfigured({"host": "no.such.entry.surely"}).check()
+        self.assertEqual(result.status, CheckStatus.FAIL)
+
+    def test_dual_stack_alias_passes_with_ipv6_entry_last(self):
+        path = self._hosts_fixture(DUAL_STACK_IPV6_LAST)
+        result = HostAliasesConfigured({"localhost": "127.0.0.1"}, hosts_path=path).check()
+        self.assertEqual(result.status, CheckStatus.PASS)
+
+    def test_dual_stack_alias_passes_with_ipv4_entry_last(self):
+        path = self._hosts_fixture(DUAL_STACK_IPV4_LAST)
+        result = HostAliasesConfigured({"localhost": "127.0.0.1"}, hosts_path=path).check()
+        self.assertEqual(result.status, CheckStatus.PASS)
+
+    def test_dual_stack_ipv6_alias_also_satisfied(self):
+        path = self._hosts_fixture(DUAL_STACK_IPV6_LAST)
+        result = HostAliasesConfigured({"localhost": "::1"}, hosts_path=path).check()
+        self.assertEqual(result.status, CheckStatus.PASS)
+
+    def test_missing_alias_still_fails(self):
+        path = self._hosts_fixture(DUAL_STACK_IPV6_LAST)
+        result = HostAliasesConfigured({"localhost": "10.0.0.1"}, hosts_path=path).check()
+        self.assertEqual(result.status, CheckStatus.FAIL)
+
+
+if __name__ == "__main__":
+    unittest.main()

daktari-0.0.332/daktari/test_git.py

@@ -0,0 +1,55 @@
+import unittest
+from unittest.mock import patch
+
+from daktari.check import CheckStatus
+from daktari.checks.git import PreCommitGitHooksInstalled
+
+# The path git resolves the pre-commit hook to. In a worktree this is *not*
+# ".git/hooks/pre-commit" (there ".git" is a file, not a directory), and when
+# core.hooksPath is set it points outside the per-worktree gitdir entirely.
+RESOLVED_HOOK_PATH = "/main/.git/hooks/pre-commit"
+LITERAL_HOOK_PATH = ".git/hooks/pre-commit"
+
+
+def fake_hook_contents(path: str, text: str) -> bool:
+    """Model a worktree: only the git-resolved hook path exists and is installed.
+
+    The literal ".git/hooks/pre-commit" path is absent (in a worktree ".git" is a
+    file), so reading it directly always misses.
+    """
+    return path == RESOLVED_HOOK_PATH and text == "pre-commit.com"
+
+
+class TestPreCommitGitHooksInstalled(unittest.TestCase):
+    @patch("daktari.checks.git.file_contains_text", side_effect=fake_hook_contents)
+    @patch("daktari.checks.git.get_stdout", return_value=RESOLVED_HOOK_PATH)
+    def test_passes_in_worktree_when_hook_resolves_via_git(self, mock_get_stdout, mock_contains):
+        result = PreCommitGitHooksInstalled().check()
+        self.assertEqual(
+            result.status,
+            CheckStatus.PASS,
+            "Hooks are installed (resolved via git), so the check should pass even in a worktree",
+        )
+        mock_get_stdout.assert_called_once_with("git rev-parse --git-path hooks/pre-commit")
+
+    @patch("daktari.checks.git.file_contains_text", side_effect=fake_hook_contents)
+    @patch("daktari.checks.git.get_stdout", return_value=RESOLVED_HOOK_PATH)
+    def test_resolved_path_is_checked_not_literal(self, mock_get_stdout, mock_contains):
+        PreCommitGitHooksInstalled().check()
+        mock_contains.assert_called_once_with(RESOLVED_HOOK_PATH, "pre-commit.com")
+
+    @patch("daktari.checks.git.file_contains_text", return_value=False)
+    @patch("daktari.checks.git.get_stdout", return_value=RESOLVED_HOOK_PATH)
+    def test_fails_when_hook_not_installed(self, mock_get_stdout, mock_contains):
+        result = PreCommitGitHooksInstalled().check()
+        self.assertEqual(result.status, CheckStatus.FAIL)
+
+    @patch("daktari.checks.git.file_contains_text", return_value=False)
+    @patch("daktari.checks.git.get_stdout", return_value=None)
+    def test_fails_gracefully_when_git_cannot_resolve_path(self, mock_get_stdout, mock_contains):
+        result = PreCommitGitHooksInstalled().check()
+        self.assertEqual(result.status, CheckStatus.FAIL)
+
+
+if __name__ == "__main__":
+    unittest.main()

{daktari-0.0.330 → daktari-0.0.332/daktari.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: daktari
-Version: 0.0.330
+Version: 0.0.332
 Summary: Assist in setting up and maintaining developer environments
 Author-email: Matt Russell <matthew.russell@sonocent.com>
 License: Copyright 2021 Sonocent Ltd
@@ -45,7 +45,7 @@ In the root of the project repository, create a `.daktari.py` configuration file
 ```python
 from daktari.checks.git import *
 
-version = "0.0.330"
+version = "0.0.332"
 title = "My Project"
 
 checks = [

{daktari-0.0.330 → daktari-0.0.332}/daktari.egg-info/SOURCES.txt

@@ -26,6 +26,7 @@ daktari/test_check_sorter.py
 daktari/test_check_utils.py
 daktari/test_collection_utils.py
 daktari/test_config.py
+daktari/test_git.py
 daktari/test_result_printer.py
 daktari/test_version_utils.py
 daktari/version_utils.py

{daktari-0.0.330 → daktari-0.0.332}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "daktari"
-version = "0.0.330"
+version = "0.0.332"
 description = "Assist in setting up and maintaining developer environments"
 readme = "README.md"
 license = { file = "LICENSE.txt" }

daktari-0.0.330/daktari/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.0.330"

daktari-0.0.330/daktari/checks/test_misc.py

@@ -1,18 +0,0 @@
-import unittest
-
-from daktari.check import CheckStatus
-from daktari.checks.misc import HostAliasesConfigured
-
-
-class TestHostAliasesConfigured(unittest.TestCase):
-    def test_checking_hosts_does_not_blow_up_on_success(self):
-        result = HostAliasesConfigured({}).check()
-        self.assertEqual(result.status, CheckStatus.PASS)
-
-    def test_checking_hosts_does_not_blow_up_on_failure(self):
-        result = HostAliasesConfigured({"host": "no.such.entry.surely"}).check()
-        self.assertEqual(result.status, CheckStatus.FAIL)
-
-
-if __name__ == "__main__":
-    unittest.main()