Incremental changes in resource_validation.py

Author: Kurt Biery

src/integrationtest/resource_validation.py

@@ -18,10 +18,10 @@
 # resval = resource_validation.ResourceValidator()
 # resval.require_cpu_count(64)
 # resval.require_free_memory_gb(28)
-# # set other minimum values, if needed
+# # set other minimum values, if desired
 # resval_debug_string = resval.get_debug_string()
 # print(f"{resval_debug_string}")
-# # skip to one of the pytest "tests"
+# # then, in one of the pytest "tests"
 # if not resval.this_computer_has_sufficient_resources:
 #     resval_full_report = resval.get_insufficient_resources_report()
 #     print(f"{resval_full_report}")
@@ -35,25 +35,24 @@
 class ResourceValidator:
     def __init__(self):
         self.this_computer_has_sufficient_resources = True
-        self.debug_string = ""
-        self.report_string = ""
+
         hostname = os.uname().nodename
         self.report_header = f"This computer ({hostname}) does not have enough resources to run this test."
+        self.report_indentation = " *"
 
-    def get_report_header(self):
-        return self.report_header
+        self.debug_string = ""
+        self.report_string = ""
 
-    def get_report_indentation(self):
-        return "    *"
+        self.free_disk_space_gb = -1
 
     def require_cpu_count(self, minimum_cpu_count):
         cpu_count = os.cpu_count()
         self.debug_string += f"\nDEBUG: CPU count is {cpu_count}, minimum required number is {minimum_cpu_count}."
         if cpu_count < minimum_cpu_count:
             self.this_computer_has_sufficient_resources = False
             if len(self.report_string) == 0:
-                self.report_string = self.get_report_header()
-            self.report_string += f"\n{self.get_report_indentation()} CPU count is {cpu_count}, Minimum CPU count is {minimum_cpu_count}."
+                self.report_string = self.report_header
+            self.report_string += f"\n{self.report_indentation} CPU count is {cpu_count}, minimum CPU count is {minimum_cpu_count}."
 
     def require_free_memory_gb(self, minimum_free_memory):
         mem_obj = psutil.virtual_memory()
@@ -62,8 +61,8 @@ def require_free_memory_gb(self, minimum_free_memory):
         if free_mem < minimum_free_memory:
             self.this_computer_has_sufficient_resources = False
             if len(self.report_string) == 0:
-                self.report_string = self.get_report_header()
-            self.report_string += f"\n{self.get_report_indentation()} Free memory is {free_mem} GB, minimum amount is {minimum_free_memory}."
+                self.report_string = self.report_header
+            self.report_string += f"\n{self.report_indentation} Free memory is {free_mem} GB, minimum amount is {minimum_free_memory}."
 
     def require_total_memory_gb(self, minimum_total_memory):
         mem_obj = psutil.virtual_memory()
@@ -72,28 +71,28 @@ def require_total_memory_gb(self, minimum_total_memory):
         if total_mem < minimum_total_memory:
             self.this_computer_has_sufficient_resources = False
             if len(self.report_string) == 0:
-                self.report_string = self.get_report_header()
-            self.report_string += f"\n{self.get_report_indentation()} Total memory is {total_mem} GB, minimum amount is {minimum_total_memory}."
+                self.report_string = self.report_header
+            self.report_string += f"\n{self.report_indentation} Total memory is {total_mem} GB, minimum amount is {minimum_total_memory}."
 
     def require_free_disk_space_gb(self, path_of_interest, minimum_free_disk_space):
         disk_space = shutil.disk_usage(path_of_interest)
-        free_disk_space = disk_space.free / (1024 * 1024 * 1024)
-        self.debug_string += f"\nDEBUG: Free disk space is {free_disk_space} GB, minimum required amount is {minimum_free_disk_space}."
-        if free_disk_space < minimum_free_disk_space:
+        self.free_disk_space_gb = disk_space.free / (1024 * 1024 * 1024)
+        self.debug_string += f"\nDEBUG: Free disk space on \"{path_of_interest}\" is {self.free_disk_space_gb} GB, minimum required amount is {minimum_free_disk_space}."
+        if self.free_disk_space_gb < minimum_free_disk_space:
             self.this_computer_has_sufficient_resources = False
             if len(self.report_string) == 0:
-                self.report_string = self.get_report_header()
-            self.report_string += f"\n{self.get_report_indentation()} Free disk space is {free_disk_space} GB, minimum amount is {minimum_free_disk_space}."
+                self.report_string = self.report_header
+            self.report_string += f"\n{self.report_indentation} Free disk space on \"{path_of_interest}\" is {self.free_disk_space_gb} GB, minimum amount is {minimum_free_disk_space}."
 
     def require_total_disk_space_gb(self, path_of_interest, minimum_total_disk_space):
         disk_space = shutil.disk_usage(path_of_interest)
         total_disk_space = disk_space.total / (1024 * 1024 * 1024)
-        self.debug_string += f"\nDEBUG: Total disk space is {total_disk_space} GB, minimum required amount is {minimum_total_disk_space}."
+        self.debug_string += f"\nDEBUG: Total disk space on \"{path_of_interest}\" is {total_disk_space} GB, minimum required amount is {minimum_total_disk_space}."
         if total_disk_space < minimum_total_disk_space:
             self.this_computer_has_sufficient_resources = False
             if len(self.report_string) == 0:
-                self.report_string = self.get_report_header()
-            self.report_string += f"\n{self.get_report_indentation()} Total disk space is {total_disk_space} GB, minimum amount is {minimum_total_disk_space}."
+                self.report_string = self.report_header
+            self.report_string += f"\n{self.report_indentation} Total disk space on \"{path_of_interest}\" is {total_disk_space} GB, minimum amount is {minimum_total_disk_space}."
 
     def get_debug_string(self):
         return self.debug_string
@@ -102,4 +101,4 @@ def get_insufficient_resources_report(self):
         return self.report_string
 
     def get_insufficient_resources_summary(self):
-        return self.get_report_header()
+        return self.report_header