From 08ea458d205232c57da4b4c4eaeb014d8cb69614 Mon Sep 17 00:00:00 2001
From: "Alicia A. Evans" <108547992+aliciaaevans@users.noreply.github.com>
Date: Fri, 13 Dec 2024 15:29:14 -0500
Subject: [PATCH] feat: report resource usage before and after builds (#1023)

To diagnose out of disk and out of memory errors, log free disk space
and available memory before and after each recipe is built and each
mulled test.
---
 bioconda_utils/bioconda_utils-requirements.txt |  3 +++
 bioconda_utils/build.py                        | 15 +++++++++++++++
 bioconda_utils/utils.py                        | 11 +++++++++++
 3 files changed, 29 insertions(+)

diff --git a/bioconda_utils/bioconda_utils-requirements.txt b/bioconda_utils/bioconda_utils-requirements.txt
index d0c6377efd..6dc986ddad 100644
--- a/bioconda_utils/bioconda_utils-requirements.txt
+++ b/bioconda_utils/bioconda_utils-requirements.txt
@@ -68,3 +68,6 @@ platformdirs=4.*              #
 
 # build failure output
 tabulate=0.9.*                #
+
+# resource reporting for builds
+psutil                        #
diff --git a/bioconda_utils/build.py b/bioconda_utils/build.py
index bbdd0c426a..b4612fafdb 100644
--- a/bioconda_utils/build.py
+++ b/bioconda_utils/build.py
@@ -135,6 +135,7 @@ def build(recipe: str, pkg_paths: List[str] = None,
         build_failure_record.remove()
 
     try:
+        report_resources(f"Starting build for {recipe}", docker_builder is not None)
         if docker_builder is not None:
             docker_builder.build_recipe(recipe_dir=os.path.abspath(recipe),
                                         build_args=' '.join(args),
@@ -182,18 +183,23 @@ def build(recipe: str, pkg_paths: List[str] = None,
         if raise_error:
             raise exc
         return BuildResult(False, None)
+    finally:
+        report_resources(f"Finished build for {recipe}", docker_builder is not None)
 
     if mulled_test:
         logger.info('TEST START via mulled-build %s', recipe)
         mulled_images = []
         for pkg_path in pkg_paths:
             try:
+                report_resources(f"Starting mulled build for {pkg_path}")
                 pkg_test.test_package(pkg_path, base_image=base_image,
                                       conda_image=mulled_conda_image,
                                       live_logs=live_logs)
             except sp.CalledProcessError:
                 logger.error('TEST FAILED: %s', recipe)
                 return BuildResult(False, None)
+            finally:
+                report_resources(f"Finished mulled build for {pkg_path}")
             logger.info("TEST SUCCESS %s", recipe)
             mulled_images.append(pkg_test.get_image_name(pkg_path))
         return BuildResult(True, mulled_images)
@@ -511,3 +517,12 @@ def build_recipes(recipe_folder: str, config_path: str, recipes: List[str],
     logger.info("BUILD SUMMARY: successfully built %s of %s recipes",
                 len(built_recipes), len(recipes))
     return True
+
+def report_resources(message, show_docker=True):
+    free_space_mb = utils.get_free_space()
+    free_mem_mb = utils.get_free_memory_mb()
+    free_mem_percent = utils.get_free_memory_percent()
+    logger.info("{0} Free disk space: {1:.2f} MB. Free memory: {2:.2f} MB ({3:.2f}%)".format(message, free_space_mb, free_mem_mb, free_mem_percent))
+    if show_docker:
+        cmd = ['docker', 'system', 'df']
+        utils.run(cmd, mask=False, live=True)
\ No newline at end of file
diff --git a/bioconda_utils/utils.py b/bioconda_utils/utils.py
index 3591faabec..e297916948 100644
--- a/bioconda_utils/utils.py
+++ b/bioconda_utils/utils.py
@@ -19,6 +19,7 @@
 import json
 import queue
 import warnings
+import psutil
 
 from threading import Event, Thread
 from pathlib import PurePath
@@ -361,6 +362,16 @@ def get_free_space():
     return s.f_frsize * s.f_bavail / (1024 ** 2)
 
 
+def get_free_memory_percent():
+    """Return free memory as a percentage of total memory"""
+    return psutil.virtual_memory().available * 100 / psutil.virtual_memory().total
+
+
+def get_free_memory_mb():
+    """Return free memory as megabytes"""
+    return psutil.virtual_memory().available / (1024 ** 2)
+
+
 def allowed_env_var(s, docker=False):
     for pattern in ENV_VAR_WHITELIST:
         if fnmatch.fnmatch(s, pattern):