Bump version to 1.27.0

Author: angelonakos

CHANGELOG

@@ -1,6 +1,14 @@
                               CHANGELOG
                               `````````
 
+Version 1.27.0 -- 2022-08-03
+----------------------------
+- Modify behavior of acquire-html-dir command
+  If a build has finished, then a lock will not be acquired (and
+  consequently the path to the HTML directory will not be
+  printed to stdout) until the report has finished rendering.
+
+
 Version 1.26.0 -- 2022-05-18
 ----------------------------
 

lib/litani.py

@@ -33,7 +33,7 @@
 TIME_FORMAT_W = "%Y-%m-%dT%H:%M:%SZ"
 TIME_FORMAT_MS = "%Y-%m-%dT%H:%M:%S.%fZ"
 VERSION_MAJOR = 1
-VERSION_MINOR = 26
+VERSION_MINOR = 27
 VERSION_PATCH = 0
 RC = False
 
@@ -58,6 +58,22 @@ def is_expired(self):
 
 
 
+class ReportRendering:
+    """This class is to mark the completion of the report rendering process"""
+
+    def __init__(self):
+        self._touchfile = get_cache_dir().resolve() / ".litani-completed"
+
+
+    def complete(self):
+        self._touchfile.touch()
+
+
+    def has_completed(self):
+        return self._touchfile.exists()
+
+
+
 class AcquisitionFailed(Exception):
     pass
 

lib/litani_report.py

@@ -448,16 +448,22 @@ async def acquire_html_dir(args):
         end = datetime.datetime.now() + datetime.timedelta(seconds=args.timeout)
     else:
         end = datetime.datetime.max
-    while True:
+    while datetime.datetime.now() <= end:
         html_dir = lib.litani.get_report_dir().resolve()
         lockable_dir = lib.litani.LockableDirectory(html_dir)
-        if lockable_dir.acquire():
-            print(html_dir)
-            sys.exit(0)
-        if datetime.datetime.now() > end:
-            sys.exit(1)
-        await asyncio.sleep(1)
-
+        if not lockable_dir.acquire():
+            await asyncio.sleep(1)
+            continue
+        with open(html_dir / "run.json") as handle:
+            run = json.load(handle)
+            is_completed_run = run["status"] != "in_progress"
+        if is_completed_run and not litani.ReportRendering().has_completed():
+            lockable_dir.release()
+            await asyncio.sleep(1)
+            continue
+        print(html_dir)
+        sys.exit(0)
+    sys.exit(1)
 
 async def print_html_dir(_):
     html_dir = lib.litani.get_report_dir()

lib/run_build.py

@@ -213,6 +213,9 @@ async def run_build(args):
         with litani.atomic_write(args.out_file) as handle:
             print(json.dumps(run, indent=2), file=handle)
 
+    report_rendering = litani.ReportRendering()
+    report_rendering.complete()
+
     # Print the path to the complete report at the end of 'litani run-build'.
     # The same path was printed at the start of 'litani init'.
     if 'latest_symlink' in run_info: