Add support for SHA384 hash in files.download() (#1247)

Co-authored-by: simonhammes <simonhammes@users.noreply.github.com>

Author: simonhammes

pyinfra/facts/files.py

@@ -276,6 +276,12 @@ class Sha256File(HashFileFactBase, digits=64, cmds=["sha256sum", "shasum -a 256"
     """
 
 
+class Sha384File(HashFileFactBase, digits=96, cmds=["sha384sum", "shasum -a 384", "sha384"]):
+    """
+    Returns a SHA384 hash of a file, or ``None`` if the file does not exist.
+    """
+
+
 class Md5File(HashFileFactBase, digits=32, cmds=["md5sum", "md5"]):
     """
     Returns an MD5 hash of a file, or ``None`` if the file does not exist.

pyinfra/operations/files.py

@@ -51,6 +51,7 @@
     Md5File,
     Sha1File,
     Sha256File,
+    Sha384File,
 )
 from pyinfra.facts.server import Date, Which
 
@@ -67,6 +68,7 @@ def download(
     mode: str | None = None,
     cache_time: int | None = None,
     force=False,
+    sha384sum: str | None = None,
     sha256sum: str | None = None,
     sha1sum: str | None = None,
     md5sum: str | None = None,
@@ -84,6 +86,7 @@ def download(
     + mode: permissions of the files
     + cache_time: if the file exists already, re-download after this time (in seconds)
     + force: always download the file, even if it already exists
+    + sha384sum: sha384 hash to checksum the downloaded file against
     + sha256sum: sha256 hash to checksum the downloaded file against
     + sha1sum: sha1 hash to checksum the downloaded file against
     + md5sum: md5 hash to checksum the downloaded file against
@@ -135,6 +138,10 @@ def download(
             if sha256sum != host.get_fact(Sha256File, path=dest):
                 download = True
 
+        if sha384sum:
+            if sha384sum != host.get_fact(Sha384File, path=dest):
+                download = True
+
         if md5sum:
             if md5sum != host.get_fact(Md5File, path=dest):
                 download = True
@@ -211,6 +218,17 @@ def download(
                 QuoteString("SHA256 did not match!"),
             )
 
+        if sha384sum:
+            yield make_formatted_string_command(
+                (
+                    "(( sha384sum {0} 2> /dev/null || shasum -a 384 {0} ) "
+                    "| grep {1}) || ( echo {2} && exit 1 )"
+                ),
+                QuoteString(dest),
+                sha384sum,
+                QuoteString("SHA384 did not match!"),
+            )
+
         if md5sum:
             yield make_formatted_string_command(
                 (

tests/facts/files.Sha384File/file.json

@@ -0,0 +1,8 @@
+{
+    "arg": "myfile",
+    "command": "test -e myfile && ( sha384sum myfile 2> /dev/null || shasum -a 384 myfile 2> /dev/null || sha384 myfile 2> /dev/null ) || true",
+    "output": [
+        "1dd2e448df7c4dc19848a37fdf25c86660b19d06a4cd6987ca2c4071f80e9dd3061e4b01ddb982dc56ed7a2ed2294699 myfile"
+    ],
+    "fact": "1dd2e448df7c4dc19848a37fdf25c86660b19d06a4cd6987ca2c4071f80e9dd3061e4b01ddb982dc56ed7a2ed2294699"
+}

tests/facts/files.Sha384File/file_bsd_style.json

@@ -0,0 +1,8 @@
+{
+    "arg": "myfile",
+    "command": "test -e myfile && ( sha384sum myfile 2> /dev/null || shasum -a 384 myfile 2> /dev/null || sha384 myfile 2> /dev/null ) || true",
+    "output": [
+        "SHA384 (myfile) = 1dd2e448df7c4dc19848a37fdf25c86660b19d06a4cd6987ca2c4071f80e9dd3061e4b01ddb982dc56ed7a2ed2294699"
+    ],
+    "fact": "1dd2e448df7c4dc19848a37fdf25c86660b19d06a4cd6987ca2c4071f80e9dd3061e4b01ddb982dc56ed7a2ed2294699"
+}

tests/facts/files.Sha384File/file_needs_quotes.json

@@ -0,0 +1,8 @@
+{
+    "arg": "my () file && special_chars.txt",
+    "command": "test -e 'my () file && special_chars.txt' && ( sha384sum 'my () file && special_chars.txt' 2> /dev/null || shasum -a 384 'my () file && special_chars.txt' 2> /dev/null || sha384 'my () file && special_chars.txt' 2> /dev/null ) || true",
+    "output": [
+        "1dd2e448df7c4dc19848a37fdf25c86660b19d06a4cd6987ca2c4071f80e9dd3061e4b01ddb982dc56ed7a2ed2294699 my () file && special_chars.txt"
+    ],
+    "fact": "1dd2e448df7c4dc19848a37fdf25c86660b19d06a4cd6987ca2c4071f80e9dd3061e4b01ddb982dc56ed7a2ed2294699"
+}