Create argument to display timestamps

The --timestamps option will display the date and time to the beginning of each line of output.

Author: Dhwaniartefact

docs/fixity.1

@@ -35,6 +35,10 @@ Request the Storage Service performs a local fixity check, instead of using the
 \fB\-\-debug\fR
 Print extra debugging output\.
 .
+.TP
+\fB\-\-timestamps\fR
+Add a timestamp to the beginning of each line of output\.
+.
 .SH "COMMANDS"
 .
 .TP

docs/fixity.1.html

@@ -35,6 +35,9 @@ running; see the section on _ENVIRONMENT VARIABLES_ for information.
 * `--debug`:
     Print extra debugging output.
 
+* `--timestamps`:
+    It adds a timestamp to the beginning of each line of output.
+
 ## COMMANDS
 
 * `scan <UUID>`:

docs/fixity.1.md

@@ -40,6 +40,11 @@ def parse_arguments():
         action="store_true",
         help="Force a local fixity check on the Storage Service.",
     )
+    parser.add_argument(
+        "--timestamps",
+        action="store_true",
+        help="Add a timestamp to the beginning of each line of output.",
+    )
     args = parser.parse_args()
 
     validate_arguments(args)
@@ -99,6 +104,7 @@ def scan(
     report_auth=(),
     session_id=None,
     force_local=False,
+    timestamps=False,
 ):
     """
     Instruct the storage service to scan a single AIP.
@@ -114,7 +120,8 @@ def scan(
     :param str report_url: The base URL to a server to which the report will be POSTed after the scan completes. If absent, the report will not be     transmitted.
     :param report_auth: Authentication for the report_url. Tupel of (user, password) for HTTP auth.
     :param session_id: Identifier for this session, allowing every scan from one run to be identified.
-    :param bool force_local: If True, will will request the Storage Service to perform a local fixity check, instead of using the Space's fixity (if available).
+    :param bool force_local: If True, will request the Storage Service to perform a local fixity check, instead of using the Space's fixity (if available).
+    :param bool timestamps: If True, will add a timestamp to the beginning of each line of output.
     """
 
     # Ensure the storage service knows about this AIP first;
@@ -135,7 +142,9 @@ def scan(
                 session_id=session_id,
             )
     except reporting.ReportServiceException:
-        utils.pyprint(f"Unable to POST pre-scan report to {report_url}")
+        utils.pyprint(
+            f"Unable to POST pre-scan report to {report_url}", timestamps=timestamps
+        )
 
     try:
         status, report = storage_service.scan_aip(
@@ -148,9 +157,11 @@ def scan(
             force_local=force_local,
         )
         report_data = json.loads(report.report)
-        utils.pyprint(scan_message(aip, status, report_data["message"]))
+        utils.pyprint(
+            scan_message(aip, status, report_data["message"]), timestamps=timestamps
+        )
     except Exception as e:
-        utils.pyprint(str(e))
+        utils.pyprint(str(e), timestamps=timestamps)
         status = None
         if hasattr(e, "report") and e.report:
             report = e.report
@@ -179,7 +190,10 @@ def scan(
                 aip, report, report_url, report_auth=report_auth, session_id=session_id
             )
         except reporting.ReportServiceException:
-            utils.pyprint(f"Unable to POST report for AIP {aip} to remote service")
+            utils.pyprint(
+                f"Unable to POST report for AIP {aip} to remote service",
+                timestamps=timestamps,
+            )
 
     if report:
         session.add(report)
@@ -196,6 +210,7 @@ def scanall(
     report_auth=(),
     throttle_time=0,
     force_local=False,
+    timestamps=False,
 ):
     """
     Run a fixity scan on every AIP in a storage service instance.
@@ -206,7 +221,8 @@ def scanall(
     :param str report_url: The base URL to a server to which the report will be POSTed after the scan completes. If absent, the report will not be transmitted.
     :param report_auth: Authentication for the report_url. Tupel of (user, password) for HTTP auth.
     :param int throttle_time: Time to wait between scans.
-    :param bool force_local: If True, will will request the Storage Service to perform a local fixity check, instead of using the Space's fixity (if available).
+    :param bool force_local: If True, will request the Storage Service to perform a local fixity check, instead of using the Space's fixity (if available).
+    :param bool timestamps: If True, will add a timestamp to the beginning of each line of output.
     """
     success = True
 
@@ -231,19 +247,21 @@ def scanall(
                 report_auth=report_auth,
                 session_id=session_id,
                 force_local=force_local,
+                timestamps=timestamps,
             )
             if not scan_success:
                 success = False
         except Exception as e:
             utils.pyprint(
                 f"Internal error encountered while scanning AIP {aip['uuid']} ({type(e).__name__})",
                 file=sys.stdout,
+                timestamps=timestamps,
             )
         if throttle_time:
             sleep(throttle_time)
 
     if count > 0:
-        utils.pyprint(f"Successfully scanned {count} AIPs")
+        utils.pyprint(f"Successfully scanned {count} AIPs", timestamps=timestamps)
 
     return success
 
@@ -283,6 +301,7 @@ def main():
                 report_auth=auth,
                 throttle_time=args.throttle,
                 force_local=args.force_local,
+                timestamps=args.timestamps,
             )
         elif args.command == "scan":
             session_id = str(uuid4())
@@ -296,6 +315,7 @@ def main():
                 report_auth=auth,
                 session_id=session_id,
                 force_local=args.force_local,
+                timestamps=args.timestamps,
             )
         else:
             return Exception(f'Error: "{args.command}" is not a valid command.')

fixity/fixity.py

@@ -36,5 +36,11 @@ def utcnow():
     return datetime.now(timezone.utc)
 
 
+def format_timestamp(t):
+    return t.strftime("%Y-%m-%d %H:%M:%S %Z")
+
+
 def pyprint(message, **kwargs):
+    if kwargs.get("timestamps"):
+        message = f"[{format_timestamp(utcnow())}] {message}"
     print(message, file=kwargs.get("file", sys.stderr))

fixity/utils.py

@@ -74,6 +74,43 @@ def test_scan(_get, mock_check_fixity):
     ]
 
 
+@mock.patch("fixity.utils.utcnow")
+@mock.patch("requests.get")
+def test_scan_if_timestamps_argument_is_passed(_get, utcnow, mock_check_fixity, capsys):
+    _get.side_effect = mock_check_fixity
+    aip_id = uuid.uuid4()
+    timestamp = 1514775600
+    utcnow.return_value = datetime.fromtimestamp(timestamp, timezone.utc)
+
+    response = fixity.scan(
+        aip=str(aip_id),
+        ss_url=STORAGE_SERVICE_URL,
+        ss_user=STORAGE_SERVICE_USER,
+        ss_key=STORAGE_SERVICE_KEY,
+        session=SESSION,
+        timestamps=True,
+    )
+
+    assert response is True
+
+    captured = capsys.readouterr()
+    assert captured.out == ""
+    assert (
+        captured.err.strip()
+        == f"[2018-01-01 03:00:00 UTC] Fixity scan succeeded for AIP: {aip_id}"
+    )
+    assert _get.mock_calls == [
+        mock.call(
+            f"{STORAGE_SERVICE_URL}api/v2/file/{aip_id}/",
+            params={"username": STORAGE_SERVICE_USER, "api_key": STORAGE_SERVICE_KEY},
+        ),
+        mock.call(
+            f"{STORAGE_SERVICE_URL}api/v2/file/{aip_id}/check_fixity/",
+            params={"username": STORAGE_SERVICE_USER, "api_key": STORAGE_SERVICE_KEY},
+        ),
+    ]
+
+
 @mock.patch("fixity.utils.utcnow")
 @mock.patch("requests.get")
 @mock.patch(