Merge pull request #4885 from smoors/download-bar

fix download progress bar

Author: boegel

easybuild/framework/easyblock.py

@@ -44,6 +44,7 @@
 """
 import concurrent
 import copy
+import functools
 import glob
 import inspect
 import json
@@ -128,9 +129,26 @@
 # Directory name in which to store reproducibility files
 REPROD = 'reprod'
 
+CHECKSUMS_JSON = 'checksums.json'
+
 _log = fancylogger.getLogger('easyblock')
 
 
+def _obtain_file_update_progress_bar_on_return(func):
+    """Decorator for obtain_file() to update the progress bar upon return"""
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        result = func(*args, **kwargs)
+        filename = args[1]
+
+        # We don't account for the checksums file in the progress bar
+        if filename != CHECKSUMS_JSON:
+            update_progress_bar(PROGRESS_BAR_DOWNLOAD_ALL)
+
+        return result
+    return wrapper
+
+
 class EasyBlock:
     """Generic support for building and installing software, base class for actual easyblocks."""
 
@@ -452,7 +470,7 @@ def get_checksums_from_json(self, always_read=False):
         :param always_read: always read the checksums.json file, even if it has been read before
         """
         if always_read or self.json_checksums is None:
-            path = self.obtain_file("checksums.json", no_download=True, warning_only=True)
+            path = self.obtain_file(CHECKSUMS_JSON, no_download=True, warning_only=True)
             if path is not None:
                 self.log.info("Loading checksums from file %s", path)
                 json_txt = read_file(path)
@@ -789,6 +807,7 @@ def collect_exts_file_info(self, fetch_files=True, verify_checksums=True):
 
         return exts_sources
 
+    @_obtain_file_update_progress_bar_on_return
     def obtain_file(self, filename, extension=False, urls=None, download_filename=None, force_download=False,
                     git_config=None, no_download=False, download_instructions=None, alt_location=None,
                     warning_only=False):
@@ -812,8 +831,8 @@ def obtain_file(self, filename, extension=False, urls=None, download_filename=No
             srcpaths = source_paths()
 
         # We don't account for the checksums file in the progress bar
-        if filename != 'checksum.json':
-            update_progress_bar(PROGRESS_BAR_DOWNLOAD_ALL, label=filename)
+        if filename != CHECKSUMS_JSON:
+            update_progress_bar(PROGRESS_BAR_DOWNLOAD_ALL, progress_size=0, label=filename)
 
         if alt_location is None:
             location = self.name
@@ -5051,7 +5070,7 @@ def inject_checksums_to_json(ecs, checksum_type):
                     raise EasyBuildError("Found existing checksum for %s, use --force to overwrite them" % filename)
 
         # actually write the checksums
-        with open(os.path.join(ec_dir, 'checksums.json'), 'w') as outfile:
+        with open(os.path.join(ec_dir, CHECKSUMS_JSON), 'w') as outfile:
             json.dump(existing_checksums, outfile, indent=2, sort_keys=True)